Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Kontrol akses ke API HTTP dengan otorisasi JWT di API Gateway
Anda dapat menggunakan JSON Web Tokens (JWT) sebagai bagian dari kerangka kerja OpenID Connect (OIDC)
Jika Anda mengonfigurasi otorisasi JWT untuk rute API Anda, API Gateway memvalidasi JWT yang dikirimkan klien dengan permintaan API. API Gateway memungkinkan atau menolak permintaan berdasarkan validasi token, dan secara opsional, cakupan dalam token. Jika Anda mengonfigurasi cakupan untuk rute, token harus menyertakan setidaknya satu cakupan rute.
Anda dapat mengonfigurasi otorisasi yang berbeda untuk setiap rute API, atau menggunakan otorizer yang sama untuk beberapa rute.
catatan
Tidak ada mekanisme standar untuk membedakan token akses JWT dari jenis JWT lainnya, seperti token OpenID Connect ID. Kecuali Anda memerlukan token ID untuk otorisasi API, kami sarankan Anda mengonfigurasi rute agar memerlukan cakupan otorisasi. Anda juga dapat mengonfigurasi otorisasi JWT untuk mewajibkan penerbit atau audiens yang hanya digunakan penyedia identitas Anda saat mengeluarkan token akses JWT.
Mengotorisasi permintaan API dengan otorizer JWT
API Gateway menggunakan alur kerja umum berikut untuk mengotorisasi permintaan ke rute yang dikonfigurasi untuk menggunakan otorizer JWT.
-
Periksa
identitySourceuntuk token. HanyaidentitySourcedapat menyertakan token, atau token yang diawali denganBearer. -
Dekode token.
-
Periksa algoritma dan tanda tangan token dengan menggunakan kunci publik yang diambil dari penerbit.
jwks_uriSaat ini, hanya RSA-based algoritma yang didukung. API Gateway menyimpan kunci publik hingga dua jam dengan upaya terbaik. Jika cache hilang, API Gateway mengambil kunci publik dari penerbit melalui jaringan, yang menambahkan latensi pada permintaan yang memicunya. API dengan tingkat permintaan rendah atau intermiten lebih cenderung mengalami pengambilan ini. Karena kunci publik dapat tetap di-cache hingga dua jam, izinkan masa tenggang saat Anda memutar kunci, di mana kunci lama dan baru valid. -
Validasi klaim. API Gateway mengevaluasi klaim token berikut:
-
kid— Token harus memiliki klaim header yang cocok dengan kunci jwks_uriyang menandatangani token. -
iss— Harus cocok dengan issueryang dikonfigurasi untuk otorizer. -
audatau client_id— Harus cocok dengan salah satuaudienceentri yang dikonfigurasi untuk otorizer. API Gatewayclient_idhanya memvalidasi jika tidakaudada. Ketika keduanyaauddanclient_idhadir, API Gateway mengevaluasiaud. -
exp— Harus setelah waktu saat ini di UTC. -
nbf— Harus sebelum waktu saat ini di UTC. -
iat— Harus sebelum waktu saat ini di UTC. -
scopeatau scp— Token harus menyertakan setidaknya satu cakupan dalam ruteauthorizationScopes.
-
Jika salah satu langkah ini gagal, API Gateway menolak permintaan API.
Setelah memvalidasi JWT, API Gateway meneruskan klaim dalam token ke integrasi rute API. Sumber daya backend, seperti fungsi Lambda, dapat mengakses klaim JWT. Misalnya, jika JWT menyertakan klaim identitasemailID, itu tersedia untuk integrasi Lambda di. $event.requestContext.authorizer.jwt.claims.emailID Untuk informasi selengkapnya tentang payload yang dikirim API Gateway ke integrasi Lambda, lihat. Buat integrasi AWS Lambda proxy untuk HTTP APIs di API Gateway
Buat otorisasi JWT
Sebelum Anda membuat otorisasi JWT, Anda harus mendaftarkan aplikasi klien dengan penyedia identitas. Anda juga harus membuat API HTTP. Untuk contoh membuat API HTTP, lihatBuat API HTTP.
Buat otorisasi JWT menggunakan konsol
Langkah-langkah berikut menunjukkan cara membuat otorisasi JWT menggunakan konsol.
Untuk membuat otorisasi JWT menggunakan konsol
Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway
. Pilih API HTTP.
Di panel navigasi utama, pilih Otor isasi.
Pilih tab Kelola otorisasi.
Pilih Buat.
Untuk jenis Authorizer, pilih J WT.
Konfigurasikan otorisasi JWT Anda, dan tentukan sumber Identi tas yang mendefinisikan sumber token.
Pilih Buat.
Buat otorisasi JWT menggunakan AWS CLI
Perintah create-authorizer berikut membuat otorizer JWT. Untukjwt-configuration, tentukan Audience dan Issuer untuk penyedia identitas Anda. Jika Anda menggunakan Amazon Cognito sebagai penyedia identitas, itu IssuerUrl adalahhttps://cognito-idp..us-east-2.amazonaws.com/userPoolID
aws apigatewayv2 create-authorizer \ --nameauthorizer-name\ --api-idapi-id\ --authorizer-type JWT \ --identity-source '$request.header.Authorization' \ --jwt-configuration Audience=audience,Issuer=IssuerUrl
Buat otorisasi JWT menggunakan AWS CloudFormation
CloudFormation Template berikut membuat API HTTP dengan otorizer JWT yang menggunakan Amazon Cognito sebagai penyedia identitas.
Output dari CloudFormation template adalah URL untuk UI yang dihosting Amazon Cognito di mana klien dapat mendaftar dan masuk untuk menerima JWT. Setelah klien masuk, klien dialihkan ke API HTTP Anda dengan token akses di URL. Untuk memanggil API dengan token akses, ubah URL # di a ? untuk menggunakan token sebagai parameter string kueri.
AWSTemplateFormatVersion: '2010-09-09' Description: | Example HTTP API with a JWT authorizer. This template includes an Amazon Cognito user pool as the issuer for the JWT authorizer and an Amazon Cognito app client as the audience for the authorizer. The outputs include a URL for an Amazon Cognito hosted UI where clients can sign up and sign in to receive a JWT. After a client signs in, the client is redirected to your HTTP API with an access token in the URL. To invoke the API with the access token, change the '#' in the URL to a '?' to use the token as a query string parameter. Resources: MyAPI: Type: AWS::ApiGatewayV2::Api Properties: Description: Example HTTP API Name: api-with-auth ProtocolType: HTTP Target: !GetAtt MyLambdaFunction.Arn DefaultRouteOverrides: Type: AWS::ApiGatewayV2::ApiGatewayManagedOverrides Properties: ApiId: !Ref MyAPI Route: AuthorizationType: JWT AuthorizerId: !Ref JWTAuthorizer JWTAuthorizer: Type: AWS::ApiGatewayV2::Authorizer Properties: ApiId: !Ref MyAPI AuthorizerType: JWT IdentitySource: - '$request.querystring.access_token' JwtConfiguration: Audience: - !Ref AppClient Issuer: !Sub https://cognito-idp.${AWS::Region}.amazonaws.com/${UserPool} Name: test-jwt-authorizer MyLambdaFunction: Type: AWS::Lambda::Function Properties: Runtime: nodejs18.x Role: !GetAtt FunctionExecutionRole.Arn Handler: index.handler Code: ZipFile: | exports.handler = async (event) => { const response = { statusCode: 200, body: JSON.stringify('Hello from the ' + event.routeKey + ' route!'), }; return response; }; APIInvokeLambdaPermission: Type: AWS::Lambda::Permission Properties: FunctionName: !Ref MyLambdaFunction Action: lambda:InvokeFunction Principal: apigateway.amazonaws.com SourceArn: !Sub arn:${AWS::Partition}:execute-api:${AWS::Region}:${AWS::AccountId}:${MyAPI}/$default/$default FunctionExecutionRole: Type: AWS::IAM::Role Properties: AssumeRolePolicyDocument: Version: '2012-10-17' Statement: - Effect: Allow Principal: Service: - lambda.amazonaws.com Action: - 'sts:AssumeRole' ManagedPolicyArns: - arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole UserPool: Type: AWS::Cognito::UserPool Properties: UserPoolName: http-api-user-pool AutoVerifiedAttributes: - email Schema: - Name: name AttributeDataType: String Mutable: true Required: true - Name: email AttributeDataType: String Mutable: false Required: true AppClient: Type: AWS::Cognito::UserPoolClient Properties: AllowedOAuthFlows: - implicit AllowedOAuthScopes: - aws.cognito.signin.user.admin - email - openid - profile AllowedOAuthFlowsUserPoolClient: true ClientName: api-app-client CallbackURLs: - !Sub https://${MyAPI}.execute-api.${AWS::Region}.amazonaws.com ExplicitAuthFlows: - ALLOW_USER_PASSWORD_AUTH - ALLOW_REFRESH_TOKEN_AUTH UserPoolId: !Ref UserPool SupportedIdentityProviders: - COGNITO HostedUI: Type: AWS::Cognito::UserPoolDomain Properties: Domain: !Join - '-' - - !Ref MyAPI - !Ref AppClient UserPoolId: !Ref UserPool Outputs: SignupURL: Value: !Sub https://${HostedUI}.auth.${AWS::Region}.amazoncognito.com/login?client_id=${AppClient}&response_type=token&scope=email+profile&redirect_uri=https://${MyAPI}.execute-api.${AWS::Region}.amazonaws.com
Perbarui rute untuk menggunakan otorizer JWT
Anda dapat menggunakan konsol, AWS CLI, atau AWS SDK untuk memperbarui rute untuk menggunakan otorizer JWT.
Perbarui rute untuk menggunakan otorizer JWT dengan menggunakan konsol
Langkah-langkah berikut menunjukkan cara memperbarui rute untuk menggunakan otorisasi JWT menggunakan konsol.
Untuk membuat otorisasi JWT menggunakan konsol
Masuk ke konsol API Gateway di https://console.aws.amazon.com/apigateway
. Pilih API HTTP.
Di panel navigasi utama, pilih Otor isasi.
-
Pilih metode, lalu pilih otorisasi Anda dari menu tarik-turun, lalu pilih Lamp irkan otorisasi.
Perbarui rute untuk menggunakan otorizer JWT dengan menggunakan AWS CLI
Perintah update-route berikut memperbarui rute untuk menggunakan otorizer JWT:
aws apigatewayv2 update-route \ --api-idapi-id\ --route-idroute-id\ --authorization-type JWT \ --authorizer-idauthorizer-id\ --authorization-scopesuser.email