awsm-users

0.0.3 • Public • Published

Awsm Users

AWSM Users is an example awsm module around the lifecycle of authentication.

What does this project demonstatrate?

  • Custom API endpoint request templates.
  • Additional Cloudformation Resources (DynamoDB) and IAM roles
  • Shared library code in lib
  • JWT
  • Other HTTP Api endpoint methods

Usage

Asciicast

asciicast

In your JAWS project root directory, run:

jaws module install https://github.com/jaws-framework/jaws-core-js
jaws module install https://github.com/dekz/awsm-users
jaws deploy resources
jaws dash

# Create a User with a POST to <endpoint>/users/create
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
    "email": "jacob@jaws.com",
    "password": "password"
}' '<endpoint>/users/create'
# Authenticate a User with a POST to <endpoint>/users/authenticate. This returns a JWT token
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
    "email": "jacob@jaws.com",
    "password": "password"
}' '<endpoint>/users/authenticate'
# Hit the List endpoint which is behind an authentication wall
curl -H "Authorization: <jwt token>" "<your endpoint>/users/list" 

This will install the awsm modules into your project and save the resource creations into your cloudformation.

Environment Variables

You will need to populate the environment variables provided by the jaws env list command, here is an example:

~/t/j/myproject ❯❯❯ jaws env list dev us-east-1
JAWS: Getting ENV file from S3 bucket: jaws-project in us-east-1
JAWS: ENV vars for stage dev:
JAWS: ------------------------------
JAWS: us-east-1
JAWS: ------------------------------
JAWS_STAGE=dev
JAWS_DATA_MODEL_STAGE=dev
USERS_TABLE=jaws-users
JWT_SECRET=abcd
JWT_ISSUER=jacob


JAWS: awsm.json:lambda.envVars and regions where they are used (red means NOT defined in region):
JAWS: ------------------------------
JAWS: USERS_TABLE
JAWS: ------------------------------
JAWS: aws mods using: users/create/awsm.json,users/authenticate/awsm.json,users/list/awsm.json
JAWS: regions: us-east-1

JAWS: ------------------------------
JAWS: JWT_SECRET
JAWS: ------------------------------
JAWS: aws mods using: users/authenticate/awsm.json
JAWS: regions: us-east-1

JAWS: ------------------------------
JAWS: JWT_ISSUER
JAWS: ------------------------------
JAWS: aws mods using: users/authenticate/awsm.json
JAWS: regions: us-east-1

USERS_TABLE must be set to: jaws-users (for now)

Can I use this project in Production

No

TODO

  • Create Users
  • List Users
  • Authenticate Users
  • Delete Users

Putting a lambda behind an authentication wall

Your API endpoint must pull out the Autheorization parameter and pass that through. Here is an example of a Request Template which pulls out the Auth token and sets it onto the event. See list awsm.json

      "RequestTemplates"{
        "application/json": "{\"Authorization\":\"$input.params('Authorization')\"}"
      }

Verify before doing any work in your Lambda, See list lambda as an example.

module.exports.run = function(event, context, cb) {
  return verify(event.Authorization)
    .then(action)
    .then(function(result) {
      cb(null, result);
    })
    .error(function(error) {
      debug('List Users Failed: %s', JSON.stringify(error));
      cb(error, null);
    });
};
 

Readme

Keywords

Package Sidebar

Install

npm i awsm-users

Weekly Downloads

0

Version

0.0.3

License

MIT

Last publish

Collaborators

  • dekz