Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/halvardssm/oak-middleware-jwt
Oak middleware for JWT
https://github.com/halvardssm/oak-middleware-jwt
deno middleware oak oakland
Last synced: 3 months ago
JSON representation
Oak middleware for JWT
- Host: GitHub
- URL: https://github.com/halvardssm/oak-middleware-jwt
- Owner: halvardssm
- License: mit
- Created: 2020-05-25T13:40:33.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-25T08:28:40.000Z (over 1 year ago)
- Last Synced: 2024-10-03T12:38:27.332Z (4 months ago)
- Topics: deno, middleware, oak, oakland
- Language: TypeScript
- Homepage:
- Size: 62.5 KB
- Stars: 35
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Oak Middleware JWT
[](https://github.com/halvardssm/oak-middleware-jwt)
[](https://github.com/halvardssm/oak-middleware-jwt/actions?query=branch%3Amaster+workflow%3ACI)
[](https://deno.land)
[](https://github.com/oakserver/oak)
[](https://github.com/timonson/djwt)
[](https://doc.deno.land/https/raw.githubusercontent.com/halvardssm/oak-middleware-jwt/master/mod.ts)
[](https://nest.land/package/oak-middleware-jwt)
Oak middleware for JWT using Djwt
## Usage
- As an application middleware
```ts
import { jwtMiddleware } from "https://raw.githubusercontent.com/halvardssm/oak-middleware-jwt/master/mod.ts";
import { Middleware } from "https://deno.land/x/oak/mod.ts";
const app = new Application();
app.use(jwtMiddleware({ key: "foo" }));
await app.listen(appOptions);
```
- As a router middleware
```ts
import { jwtMiddleware, OnSuccessHandler } from "https://raw.githubusercontent.com/halvardssm/oak-middleware-jwt/master/mod.ts"
import { RouterMiddleware } from "https://deno.land/x/oak/mod.ts";
interface ApplicationState {
userId: string
}
const router = new Router();
const app = new Application();
const onSuccess: OnSuccessHandler = (ctx, jwtPayload) => {
ctx.state.userId = jwtPayload.userId
}
router
.get("/bar", jwtMiddleware({ key:"foo", onSuccess }), async (ctx) => {
const callerId = ctx.state.userId
...
})
app.use(router.routes());
await app.listen(appOptions);
```
- With ignore patterns
```ts
import {
IgnorePattern,
jwtMiddleware,
OnSuccessHandler,
} from "https://raw.githubusercontent.com/halvardssm/oak-middleware-jwt/master/mod.ts";
import { RouterMiddleware } from "https://deno.land/x/oak/mod.ts";
const app = new Application();
const ignorePatterns: IgnorePattern[] = ["/baz", /buz/, {
path: "/biz",
methods: ["GET"],
}];
app.use(jwtMiddleware({ key: "foo", ignorePatterns }));
await app.listen(appOptions);
```
## Options
- key: string; // See the djwt module for Validation options
- algorithm: AlgorithmInput ; // See the djwt module for Validation options
- customMessages?: ErrorMessages; // Custom error messages
- ignorePatterns?: Array; // Pattern to ignore e.g.
`/authenticate`, can be a RegExp, Pattern object or string. When passing a
string, the string will be matched with the path `===`
- onSuccess?: OnSuccessHandler; // Optional callback for successfull validation,
passes the Context and the Payload object from djwt module
- onFailure?: OnFailureHandler; // Optional callback for unsuccessfull
validation, passes the Context and the Error encountered while validating the
jwt
## Error Handling
All errors originating from this middleware is of class `JWTMiddlewareError`
which is exported. To handle `JWTMiddlewareError`s you can do such:
```ts
...
} catch(e){
if(e instanceof JWTMiddlewareError){
//do something
}
}
```
## Migrating from v1.0.0
- Change the previous `algorithm` parameter's type from `Algorithm` to
`AlgorithmInput`
```ts
import { AlgorithmInput } from "https://raw.githubusercontent.com/halvardssm/oak-middleware-jwt/master/mod.ts";
const algorithm: AlgorithmInput = "HS512";
app.use(jwtMiddleware({ key: "foo", algorithm }));
```
- Change the onFailure and onSuccess callbacks.
- `onSuccess` gets an object of type `Payload` as a second argument (check
https://github.com/timonson/djwt#decode)
- `onFailure` gets an object of type `Error` as a second argument, should
return `true` if the error should be thrown instead of returning as a
response.
```ts
const onFailure = (ctx, error: Error) => {
console.log(error.message);
};
const onSuccess = (ctx, payload: Payload) => {
console.log(payload.userId);
};
```
- The expired token bug was fixed. This module will now throw an error (and call
`onFailure` callback) if the token sent is expired. Can cause problems in
implementations that weren't expecting that
## Contributing
All contributions are welcome, make sure to read the
[contributing guidelines](./.github/CONTRIBUTING.md).
## Uses
- [Oak](https://deno.land/x/oak/)
- [djwt](https://deno.land/x/djwt)