Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decentraland/decentraland-crypto-middleware
A multi framework middleware to authenticate request signed with @decentraland/SignedFetch
https://github.com/decentraland/decentraland-crypto-middleware
decentraland express koa passportjs well-known-components
Last synced: 2 months ago
JSON representation
A multi framework middleware to authenticate request signed with @decentraland/SignedFetch
- Host: GitHub
- URL: https://github.com/decentraland/decentraland-crypto-middleware
- Owner: decentraland
- License: other
- Created: 2021-10-05T14:54:48.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-07T13:55:46.000Z (7 months ago)
- Last Synced: 2024-04-01T11:49:24.593Z (3 months ago)
- Topics: decentraland, express, koa, passportjs, well-known-components
- Language: TypeScript
- Homepage: https://docs.decentraland.org/development-guide/SDK-101/
- Size: 493 KB
- Stars: 5
- Watchers: 10
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- Awesome-Repository - Authentication Middleware
README
# Decentraland Authentication Middleware
[](https://coveralls.io/github/decentraland/decentraland-crypto-middleware?branch=main)
A multi framework middleware to authenticate request signed with `@decentraland/SignedFetch`
## Index
- [Install](#install)
- [Use with Express](#use-with-express)
- [Use with Koa](#use-with-koa)
- [Use with Well Known Components](#use-with-well-known-components)
- [Use with PassportJS](#use-with-passportjs)
- [Options](#options)
- [Auth Chain Generator](#auth-chain-generator)
- [Develop](#develop)
## Install
```bash
npm install -s decentraland-crypto-middleware
```
## Use with [Express](https://expressjs.com/)
```typescript
import { Request } from 'express'
import * as dcl from 'decentraland-crypto-middleware'
app.get(
'/user/required',
dcl.express(),
(req: Request & dcl.DecentralandSignatureData) => {
const address: string = req.auth
const metadata: Record = req.authMetadata
}
)
app.get(
'/user/optional',
dcl.express({ optional: true }),
(req: Request & dcl.DecentralandSignatureData) => {
const address: string | undefined = req.auth
const metadata: Record | undefined = req.authMetadata
}
)
```
## Use with [Koa](https://koajs.com/)
```typescript
import { Context } from 'koa'
import * as dcl from 'decentraland-crypto-middleware'
app.get(
'/user/required',
dcl.koa(),
(ctx: Context & dcl.DecentralandSignatureData) => {
const address: string = ctx.auth
const metadata: Record = ctx.authMetadata
}
)
app.get(
'/user/optional',
dcl.koa({ optional: true }),
(ctx: Context & dcl.DecentralandSignatureData) => {
const address: string | undefined = ctx.auth
const metadata: Record | undefined = ctx.authMetadata
}
)
```
## Use with [Well Known Components](https://github.com/well-known-components)
```typescript
import type { IHttpServerComponent } from '@well-known-components/interfaces'
import * as dcl from 'decentraland-crypto-middleware'
app.use('/user/required', dcl.wellKnownComponents())
app.get('/user/required', (ctx: dcl.DecentralandSignatureRequiredContext) => {
const address: string = ctx.verification.auth
const metadata: Record = ctx.verification.authMetadata
})
app.use('/user/optional', dcl.wellKnownComponents({ optional: true })
app.get('/user/optional', (ctx: dcl.DecentralandSignatureContext<{}>) => {
const address: string | undefined= ctx.verification?.auth
const metadata: Record | undefined = ctx.verification?.authMetadata
})
```
## Use with [PassportJS](http://www.passportjs.org/)
```typescript
import { Context } from 'koa'
import * as dcl from 'decentraland-crypto-middleware'
passport.use(dcl.passport())
app.get(
'/user/required',
passport.authenticate('decentraland'),
(req: Request & dcl.DecentralandSignatureData) => {
const address: string = req.auth
const metadata: Record = req.authMetadata
}
)
app.get(
'/user/required',
passport.authenticate('decentraland', { optional: true }),
(req: Request & dcl.DecentralandSignatureData) => {
const address: string | undefined = req.auth
const metadata: Record | undefined = req.authMetadata
}
)
```
## Options
| `name` | `type` | `description` |
| ------------ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `optional` | `boolean` | if `false` request will fail if there is no signature or if is invalid (default: `false`) |
| `expiration` | `number` | time in milliseconds where a signature is considered valid (default: `60_000`) |
| `catalyst` | `string` | catalyst url to validate contract wallet signatures (default: `https://peer-lb.decentraland.org/`) |
| `onError` | `(err: Error & { statusCode: number }) => any` | formats the response body when an error occurred (default: `(err) => ({ ok: false, message: err.message })`) |
### Auth Chain Generator
If you want to simulate signed headers you can use the [`Auth Chain Generator`](https://git.io/Jimns)
## Develop
If you want to contribute make you will need to setup `husky` otherwise your commit may fail because is not following the format standard
```bash
npm run husky-setup
```