https://github.com/udibo/oauth2_server
A standards compliant implementation of an OAuth 2.0 authorization server with PKCE support.
https://github.com/udibo/oauth2_server
deno javascript oak oauth2 oauth2-server typescript
Last synced: about 2 months ago
JSON representation
A standards compliant implementation of an OAuth 2.0 authorization server with PKCE support.
- Host: GitHub
- URL: https://github.com/udibo/oauth2_server
- Owner: udibo
- License: mit
- Created: 2021-03-01T02:29:56.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-04-04T00:00:17.000Z (about 3 years ago)
- Last Synced: 2025-04-04T18:55:03.982Z (about 2 months ago)
- Topics: deno, javascript, oak, oauth2, oauth2-server, typescript
- Language: TypeScript
- Homepage:
- Size: 557 KB
- Stars: 21
- Watchers: 2
- Forks: 4
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OAuth2 Server
[](https://deno.land/x/[email protected])
[](https://doc.deno.land/https/deno.land/x/[email protected]/authorization_server.ts)
[](https://github.com/udibo/oauth2_server/actions?query=workflow%3ACI)
[](https://codecov.io/gh/udibo/oauth2_server)
[](https://github.com/udibo/oauth2_server/blob/master/LICENSE)
A standards compliant implementation of an OAuth 2.0 authorization server with
PKCE support.
This module was inspired by
[node-oauth2-server](https://github.com/oauthjs/node-oauth2-server).
## Features
- The OAuth 2.0 Authorization Framework
[RFC 6749](https://datatracker.ietf.org/doc/html/rfc6749) compliant
- The OAuth 2.0 Authorization Framework: Bearer Token Usage
[RFC 6750](https://datatracker.ietf.org/doc/html/rfc6750) compliant
- Proof Key for Code Exchange by OAuth Public Clients
[RFC 7636](https://datatracker.ietf.org/doc/html/rfc7636) compliant
- Follows best security practices from
[RFC 6819](https://datatracker.ietf.org/doc/html/rfc6819) and
[OAuth 2.0 Security Best Current
Practice](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics)
- Framework agnostic with officially supported adapter for
[Oak](https://deno.land/x/oak)
## Installation
To include this module in a Deno project, you can import directly from the TS
files. This module is available in Deno's third part module registry but can
also be imported directly from GitHub using raw content URLs.
There are 2 different main entry points for this module.
- [authorization_server.ts](authorization_server.ts)
- [resource_server.ts](resource_server.ts)
The ResourceServer provides methods for authenticating requests and verifying
the request has proper authorization. You should use this if your server is not
also acting as an authorization server.
```ts
// Import from Deno's third party module registry
import { ResourceServer } from "https://deno.land/x/[email protected]/resource_server.ts";
// Import from GitHub
import { ResourceServer } from "https://raw.githubusercontent.com/udibo/oauth2_server/0.12.0/resource_server.ts";
```
The AuthorizationServer is an extension of the ResourceServer, adding methods
used by the authorize and token endpoints.
```ts
// Import from Deno's third party module registry
import { AuthorizationServer } from "https://deno.land/x/[email protected]/authorization_server.ts";
// Import from GitHub
import { AuthorizationServer } from "https://raw.githubusercontent.com/udibo/oauth2_server/0.12.0/authorization_server.ts";
```
## Usage
An example of how to use this module can be found
[here](examples/oak-localstorage). I wouldn't recommend using the example as is
but it should give you an idea of how to use this module.
See
[deno docs](https://doc.deno.land/https/deno.land/x/[email protected]/authorization_server.ts)
for more information.
### Grants
This module comes with the authorization code, client credentials, and refresh
token grant types. The authorization code grant supports PKCE but does not
require it.
An implementation of the resource owner password credentials grant can be found
[here](grants/password.ts) but is not included in mod.ts because the grant type
insecurely exposes the credentials of the resource owner to the client. See
[OAuth 2.0 Security Best Current
Practice](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#section-2.4)
for more information.
The implicit grant was not implemented because it is vulnerable to access token
leakage and access token replay. You should use the authorization code grant
instead. See
[OAuth 2.0 Security Best Current
Practice](https://datatracker.ietf.org/doc/html/draft-ietf-oauth-security-topics#section-2.1.2)
for more information.
#### Extension Grants
When implemented, extension grants will be added to the same folder as the other
grant types and added to this readme.
### Models
The [models folder](models) contains interfaces for objects used by this module.
You can extend the models how you want.
### Services
The [services folder](services) contains abstract classes and interfaces for
objects used by this module to get and store models.
The [oak-localstorage](examples/oak-localstorage) example shows how to use
localStorage for your services. The example includes some functions that are not
required by this module. Some of the functions in the example don't need to be
async since localStorage is syncronous but were made asyncronous to make it easy
to replace localStorage with something else that is asyncronous.
### Adapters
This module is framework agnostic. Adapters can be created to make this
compatible with any framework. It comes with an adapter for
[Oak](https://deno.land/x/oak).
If you would like to use this module with other frameworks, look at the oak
adapter for an example of how to implement an adapter.
The oak adapter can be found [here](adapters/oak). A working example showing how
to use this module with the adapter can be found
[here](examples/oak-localstorage).