Deno KV OAuth

Minimal OAuth powered by Deno KV.

Note: this project is in beta. API design and functionality are subject to change.

Features

Uses Deno KV for storage of session data.
Automatically refreshes access tokens
Uses authorization code flow with Proof Key for Code Exchange (PKCE).
A suite of pre-configured OAuth 2.0 clients for popular providers.
Straightforward API which aims to require minimal input.
Works locally, in the cloud and on Deno Deploy.

Live Demo

You can also check out a live demo at https://kv-oauth.deno.dev, which uses Github as the OAuth2 provider. Source code is located in demo.ts.

Usage

Getting Started

Download demo.ts.
Define your client object using one of the pre-configured OAuth 2.0 clients or a custom OAuth 2.0 client.
Run the script with the appropriate environment variables and permission flags defined. E.g. for GitHub:
```
GITHUB_CLIENT_ID=xxx GITHUB_CLIENT_SECRET=xxx deno run --unstable --allow-env --allow-net demo.ts
```

Pre-configured OAuth2 Clients

This module comes with a suite of pre-configured OAuth2 clients for the following providers:

Each function is typed so that their respective platform's requirements are met.

If there's a pre-configured OAuth 2.0 client for a provider you'd like added, please submit a pull request or create a new issue.

Custom OAuth2 Client

If you require custom OAuth2 configuration, you must define your client using new OAuth2Client() from the oauth2_client module. E.g.:

import { OAuth2Client } from "https://deno.land/x/oauth2_client/mod.ts";

const client = new OAuth2Client({
  clientId: Deno.env.get("CUSTOM_CLIENT_ID")!,
  clientSecret: Deno.env.get("CUSTOM_CLIENT_SECRET")!,
  authorizationEndpointUri: "https://custom.com/oauth/authorize",
  tokenUri: "https://custom.com/oauth/token",
  redirectUri: "https://my-site.com",
});

Contributing

Before submitting a pull request, please run deno task ok and ensure all checks pass. This checks formatting, linting, types and runs tests.

In the Wild

Check out these projects powered by Deno KV OAuth:

Deno SaaSKit / Deno Hunt - A modern SaaS template built on Fresh.
KV SketchBook - Dead simple sketchbook app.

Do you have a project powered by Deno KV OAuth that you'd like to share? Please submit a pull request adding that project to this list.