https://github.com/yosriady/serverless-auth
Serverless Authorization example with JWT and AWS Custom Authorizers
https://github.com/yosriady/serverless-auth
serverless serverless-framework
Last synced: 9 months ago
JSON representation
Serverless Authorization example with JWT and AWS Custom Authorizers
- Host: GitHub
- URL: https://github.com/yosriady/serverless-auth
- Owner: yosriady
- Created: 2017-07-07T03:15:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-07-14T05:43:25.000Z (over 5 years ago)
- Last Synced: 2025-05-12T19:43:29.978Z (11 months ago)
- Topics: serverless, serverless-framework
- Language: JavaScript
- Homepage: https://www.goingserverless.co
- Size: 108 KB
- Stars: 80
- Watchers: 9
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Serverless Auth
> Pangolins are a protected species!
This is a serverless authorization example using JSON Web Tokens (JWTs.)
It has three endpoints:
- `GET /cats` is a public endpoint anyone can access.
- `GET /pangolins` is a private endpoint, protected by an AWS Custom Authorizer.
- `POST /sessions` is a login endpoint. Pass a valid username and password in a JSON request body to get a JWT (see `/lib/users.js` for valid combinations.) For example:
```
{
"username": "Cthon98",
"password": "hunter2"
}
```
In order to pass the *authentication* check, you will need to supply a valid JWT in your `Authorization` request header when making calls to a protected endpoint.
In order to pass the *authorization* check, you will need a JWT belonging to a user with valid permissions. For this example, the user `Cthon98` is authorized to access `GET /pangolins`; `AzureDiamond` is not.
## Setup
### Prerequisites
- Node.js & NPM
- Yarn
- [The Serverless Framework](https://serverless.com/framework/)
### Install dependencies
```
yarn
```
### Running Tests
```
yarn test
```
### Get Test coverage
```
yarn test:coverage
```
### Lint
```
yarn eslint
```
### Running locally
```
serverless offline start
```
### Deploy
```
serverless deploy
```