View a markdown version of this page

Validate an Amazon Cognito access token with a network call in a CloudFront Functions viewer request event - Amazon CloudFront

Validate an Amazon Cognito access token with a network call in a CloudFront Functions viewer request event

The following code example shows how to validate a bearer token with the Amazon Cognito GetUser API through cf.fetch and forward the user's identity headers, or deny the request.

JavaScript
JavaScript runtime 2.0 for CloudFront Functions
Note

There's more on GitHub. Find the complete example and learn how to set up and run in the CloudFront Functions examples repository.

import cf from 'cloudfront'; // Viewer request function. // Validates the viewer's Amazon Cognito access token with one network call to the Cognito // GetUser API (no SigV4: the access token is the credential), then forwards the request // with x-user-sub and x-user-name set. Anything else is denied before the origin: // no Bearer token -> 401 missing_token, no call // token Cognito rejects -> 401 invalid_token // Cognito cannot be asked -> 503 auth_unavailable (fail closed) // The origin id (the origin's Name in the console) of the regional Cognito endpoint, // cognito-idp.<Region>.amazonaws.com, on this distribution. const COGNITO_ORIGIN_ID = 'cognito'; const GET_USER_TARGET = 'AWSCognitoIdentityProviderService.GetUser'; const BEARER_PREFIX = 'bearer '; // Every header this function sets starts with this prefix; viewer-supplied ones are deleted. const IDENTITY_HEADER_PREFIX = 'x-user-'; const USER_SUB_HEADER = 'x-user-sub'; const USER_NAME_HEADER = 'x-user-name'; const ERROR_HEADER = 'x-cognito-auth-error'; const STATUS_TEXT = { 401: 'Unauthorized', 503: 'Service Unavailable' }; function describeError(error) { return error.name + ': ' + error.message; } // Never trust identity headers coming from the viewer. function stripIdentityHeaders(headers) { for (const name in headers) { if (name.indexOf(IDENTITY_HEADER_PREFIX) === 0) { delete headers[name]; } } } // The token after "Bearer ", or null when the viewer sent no Bearer credential at all. function readBearerToken(headers) { const authorization = headers.authorization ? headers.authorization.value : ''; if (authorization.slice(0, BEARER_PREFIX.length).toLowerCase() !== BEARER_PREFIX) { return null; } return authorization.slice(BEARER_PREFIX.length).trim(); } // The one network call. Resolves to the Cognito user, or null for a token Cognito rejects; // throws when Cognito cannot be asked. async function getCognitoUser(token) { const cognitoResponse = await cf.fetch('/', { originId: COGNITO_ORIGIN_ID, method: 'POST', headers: { 'content-type': 'application/x-amz-json-1.1', 'x-amz-target': GET_USER_TARGET, }, // plain strings, not { value } objects body: JSON.stringify({ AccessToken: token }), includeBody: true, // default false; the user is in the body }); // Cognito answers 400 NotAuthorizedException for a bad or expired token. if (!cognitoResponse.ok) { return null; } const text = await cognitoResponse.text(); // assign first: no await inside call arguments return JSON.parse(text); } // The value of a Cognito user attribute, '' when the user has none. function userAttribute(user, name) { const attributes = user.UserAttributes || []; for (let i = 0; i < attributes.length; i++) { if (attributes[i].Name === name) { return attributes[i].Value; } } return ''; } function deny(status, code, error) { const headers = { 'content-type': { value: 'application/json' }, 'cache-control': { value: 'no-store' }, }; if (status === 401) { headers['www-authenticate'] = { value: 'Bearer' }; } if (error) { headers[ERROR_HEADER] = { value: error }; } return { statusCode: status, statusDescription: STATUS_TEXT[status], headers: headers, body: JSON.stringify({ error: code }), }; } async function handler(event) { const request = event.request; const headers = request.headers; stripIdentityHeaders(headers); const token = readBearerToken(headers); if (token === null) { return deny(401, 'missing_token'); } let user; try { user = await getCognitoUser(token); } catch (error) { // Fail closed: TypeError, TimeoutError, InternalError, or a body that is not JSON. return deny(503, 'auth_unavailable', describeError(error)); } const sub = user ? userAttribute(user, 'sub') : ''; if (!sub) { return deny(401, 'invalid_token'); } headers[USER_SUB_HEADER] = { value: sub }; headers[USER_NAME_HEADER] = { value: String(user.Username) }; return request; }

For a complete list of AWS SDK developer guides and code examples, see Using CloudFront with an AWS SDK. This topic also includes information about getting started and details about previous SDK versions.