https://github.com/ap-1/elysia-oauth2-resource-server
OAuth2 Resource Server middleware for Elysia
https://github.com/ap-1/elysia-oauth2-resource-server
authorization elysia jwks jwt oauth2 resource-server
Last synced: 2 months ago
JSON representation
OAuth2 Resource Server middleware for Elysia
- Host: GitHub
- URL: https://github.com/ap-1/elysia-oauth2-resource-server
- Owner: ap-1
- License: apache-2.0
- Created: 2025-04-28T02:18:14.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-04-28T02:34:31.000Z (5 months ago)
- Last Synced: 2025-07-02T11:10:10.848Z (3 months ago)
- Topics: authorization, elysia, jwks, jwt, oauth2, resource-server
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/elysia-oauth2-resource-server
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# elysia-oauth2-resource-server
OAuth2 Resource Server middleware for Elysia, providing local JWT validation against JWKS endpoints. Inspired by the [`tower-oauth2-resource-server`](https://crates.io/crates/tower-oauth2-resource-server) crate for Rust.
[](https://www.npmjs.com/package/elysia-oauth2-resource-server)
[](https://github.com/ap-1/elysia-oauth2-resource-server/blob/main/LICENSE)
## Features
- Validates JWT tokens from OAuth2/OIDC providers
- JWKS-based signature validation
- Verifies issuer and audience claims
- Validates token scopes for authorization
## Installation
```bash
bun add elysia-oauth2-resource-server
```
## Quick Start
```ts
import { Elysia } from "elysia";
import { oauth2ResourceServer } from "elysia-oauth2-resource-server"
const app = new Elysia()
.use(oauth2ResourceServer({
jwksUri: 'https://auth.example.com/.well-known/jwks.json',
issuer: 'https://auth.example.com',
audience: 'my-api',
requiredScopes: ['read:users']
}))
.get('/users', ({ auth }) => {
// auth contains the validated JWT payload
return { userId: auth.sub }
})
.listen(3000);
console.log("Server is listening at http://localhost:3000");
```
## API Reference
### `oauth2ResourceServer(options)`
Creates an OAuth2 Resource Server middleware that validates JWTs against a JWKS endpoint.
#### Options
| Option | Type | Required | Description |
|--------|------|----------|-------------|
| `jwksUri` | `string` | Yes | The URL to the JWKS endpoint (typically ends with `/.well-known/jwks.json`) |
| `issuer` | `string` | Yes | The expected issuer claim value (must match the JWT's `iss` claim) |
| `audience` | `string \| string[]` | No | Expected audience(s) (must be included in the JWT's `aud` claim) |
| `requiredScopes` | `string[]` | No | List of scopes that must be present in the token |
| `jwksOptions` | `object` | No | Options for JWKS retrieval and caching |
| `jwksOptions.cacheMaxAge` | `number` | No | Max age of cached JWKS in milliseconds |
| `jwksOptions.timeoutDuration` | `number` | No | Timeout for JWKS request in milliseconds |
#### Returns
Adds an `auth` property to the request context, which contains the validated JWT payload.