Rapha Auth Utilities

Auth Utils

Installation

yarn add @rapharacing/auth-utils

How to use

``js
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.

[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat

[license-url]: https://github.com/moment/moment/blob/develop/LICENSE

API

#### Table of Contents

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

$3

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

$3

Returns tokens from key value store

#### Parameters

- db DynamoDB db
- table String table
- uid String uid
- client String client

Returns Object tokens

$3

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

$3

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

$3

Returns decoded user data from JWT

#### Parameters

- token String jwt token
- secret String jwt secret depending on env

Returns Object token

$3

Returns verified user data from JWT

#### Parameters

- token String jwt token
- secret String jwt secret depending on env

Returns Object token

$3

Formats the Authorization Token

#### Parameters

- token String jwt token

Returns String token

$3

Get common headers depending on environment

#### Parameters

- headers Object headers to merge
- env String current environment

Returns Object headers

$3

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