@rapharacing/auth-utils v0.0.3

Rapha Auth Utilities

Auth Utils

Installation

yarn add @rapharacing/auth-utils

How to use

import * as utils from "@rapharacing/auth-utils";

import { getHeaders } from "@rapharacing/auth-utils";

License

Design tokens are freely distributable under the terms of the MIT license.

API

Table of Contents

• buildIAMPolicy
  • Parameters
• getUserTokens
  • Parameters
• setUserToken
  • Parameters
• updateUserToken
  • Parameters
• decodeJWT
  • Parameters
• verifyJWT
  • Parameters
• formatAuthorizationToken
  • Parameters
• getHeaders
  • Parameters
• authorizeUser
  • Parameters

buildIAMPolicy

Returns an IAM policy document for a given user and resource.

Parameters

• username String username
• effect String allow / deny
• resource String resource ARN
• context Object response context

Returns Object policyDocument

getUserTokens

Returns tokens from key value store

Parameters

• db DynamoDB db
• table String table
• uid String uid
• client String client

Returns Object tokens

setUserToken

Sets tokens in key value store by uid and client

Parameters

• db DynamoDB db
• table String table
• uid String uid
• client String client
• data Object data to set as the value in the store

updateUserToken

Updates a users tokens in the key value store

Parameters

• db DynamoDB db
• table String table
• uid String uid
• client String client
• data Object data to set as the value in the store

decodeJWT

Returns decoded user data from JWT

Parameters

• token String jwt token
• secret String jwt secret depending on env

Returns Object token

verifyJWT

Returns verified user data from JWT

Parameters

• token String jwt token
• secret String jwt secret depending on env

Returns Object token

formatAuthorizationToken

Formats the Authorization Token

Parameters

• token String jwt token

Returns String token

getHeaders

Get common headers depending on environment

Parameters

• headers Object headers to merge
• env String current environment

Returns Object headers

authorizeUser

Returns a boolean whether or not a user is allowed to call a particular method

Parameters

• userScopes Array array of user scopes
• methodArn String methodArn

Returns Boolean