Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dekz/awsm-users
AWSM Module for Authentication
https://github.com/dekz/awsm-users
Last synced: about 1 month ago
JSON representation
AWSM Module for Authentication
- Host: GitHub
- URL: https://github.com/dekz/awsm-users
- Owner: dekz
- Created: 2015-09-21T22:29:04.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-10-22T23:41:46.000Z (over 9 years ago)
- Last Synced: 2024-12-19T11:09:02.687Z (about 1 month ago)
- Language: JavaScript
- Homepage:
- Size: 188 KB
- Stars: 23
- Watchers: 4
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Awsm Users
AWSM Users is an example [awsm](https://github.com/awsm-org/awsm) module around the lifecycle of authentication.
## Requirements
Jaws 1.3+
### What does this project demonstatrate?
* Custom API endpoint request templates.
* Additional Cloudformation Resources (DynamoDB) and IAM roles
* Shared library code in `lib`
* [JWT](http://jwt.io/)
* Other HTTP Api endpoint methods
## Usage
In your JAWS project root directory, run:
```
npm install --save awsm-users
npm install
jaws postinstall awsm-users npm
jaws deploy resources
jaws dash
# Create a User with a POST to /users/create
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"email": "[email protected]",
"password": "password"
}' '/users/create'
# Authenticate a User with a POST to /users/authenticate. This returns a JWT token
curl -X POST -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"email": "[email protected]",
"password": "password"
}' '/users/authenticate'
# Hit the List endpoint which is behind an authentication wall
curl -H "Authorization: " "/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
* [x] Create Users
* [x] List Users
* [x] 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](https://github.com/dekz/awsm-users/blob/master/awsm/list/awsm.json#L33)
```json
"RequestTemplates": {
"application/json": "{\"Authorization\":\"$input.params('Authorization')\"}"
}
```
Verify before doing any work in your Lambda, See [list lambda](https://github.com/dekz/awsm-users/blob/master/awsm/list/index.js#L5) as an example.
```javascript
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);
});
};
```