@harperfast/oauth 1.2.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,219 @@
+# Harper OAuth Plugin
+
+OAuth 2.0 and OpenID Connect authentication for Harper applications. Supports GitHub, Google, Azure AD, Auth0, and custom OIDC providers with automatic token refresh and lifecycle hooks for user provisioning.
+
+## Features
+
+- **Multi-provider support** - GitHub, Google, Azure AD, Auth0, and custom OIDC providers
+- **Automatic token refresh** - Proactive token renewal on every request
+- **Lifecycle hooks** - Extensible hooks for user provisioning and custom logic
+- **CSRF protection** - Distributed token storage for cluster support
+- **ID token verification** - Full OIDC support with signature validation
+- **Zero configuration** - Works with Harper's session system automatically
+
+## Installation
+
+```bash
+npm install @harperfast/oauth
+```
+
+## Quick Start
+
+### 1. Configure OAuth Plugin
+
+Add to your `config.yaml`:
+
+```yaml
+'@harperfast/oauth':
+  package: '@harperfast/oauth'
+  providers:
+    github:
+      clientId: ${OAUTH_GITHUB_CLIENT_ID}
+      clientSecret: ${OAUTH_GITHUB_CLIENT_SECRET}
+```
+
+### 2. Set Environment Variables
+
+```bash
+export OAUTH_GITHUB_CLIENT_ID="your-client-id"
+export OAUTH_GITHUB_CLIENT_SECRET="your-client-secret"
+```
+
+### 3. Configure OAuth Callback
+
+Set your OAuth callback URL in your provider settings:
+
+```
+https://your-domain/oauth/github/callback
+```
+
+### 4. (Optional) Register Lifecycle Hooks
+
+Create or update users when they log in:
+
+```typescript
+// resources.ts
+import { registerHooks } from '@harperfast/oauth';
+
+registerHooks({
+	onLogin: async (oauthUser, tokenResponse, session, request, provider) => {
+		const { User } = tables;
+
+		// Find or create user
+		let user;
+		for await (const existing of User.search({ email: oauthUser.email })) {
+			user = existing;
+			break;
+		}
+
+		if (!user) {
+			user = await User.create({
+				email: oauthUser.email,
+				name: oauthUser.name,
+				provider: provider,
+			});
+		}
+
+		return { user: String(user.id) };
+	},
+});
+
+// Export your resources...
+```
+
+### 5. Test Authentication
+
+Navigate to:
+
+```
+http://localhost:9926/oauth/github/login
+```
+
+## Usage
+
+Access authenticated user in your resources:
+
+```typescript
+export class MyResource extends tables.Resource {
+	async get(target, request) {
+		if (!request.session?.user) {
+			throw new ClientError('Not authenticated', 401);
+		}
+
+		return {
+			userId: request.session.user,
+			email: request.session.oauthUser.email,
+		};
+	}
+}
+```
+
+## Supported Providers
+
+Built-in provider templates (not active until configured):
+
+- **GitHub** - OAuth 2.0
+- **Google** - OpenID Connect
+- **Azure AD** - OpenID Connect
+- **Auth0** - OpenID Connect
+- **Okta** - OpenID Connect (with multi-tenant support)
+- **Custom OIDC** - Any compliant provider
+
+> **Note:** Built-in providers are templates that require configuration. None are active until you provide OAuth credentials (`clientId`, `clientSecret`, etc.). Having provider code in the plugin does not enable authentication or create security exposure.
+
+## How It Works
+
+The plugin automatically handles:
+
+1. **OAuth Flow** - Redirects to provider, handles callback, exchanges code for tokens
+2. **Token Management** - Validates and refreshes tokens on every HTTP request
+3. **Session Integration** - Stores OAuth data in Harper sessions
+4. **CSRF Protection** - Validates state parameter using distributed token storage
+5. **Auto-logout** - Clears session when tokens expire and can't be refreshed
+
+## Documentation
+
+Complete documentation is available in the [docs](./docs) directory:
+
+- **[Getting Started](./docs/getting-started.md)** - Installation and quick start guide
+- **[Configuration](./docs/configuration.md)** - Complete configuration reference
+- **[OAuth Providers](./docs/providers.md)** - Provider setup guides
+- **[Lifecycle Hooks](./docs/lifecycle-hooks.md)** - User provisioning and custom logic
+- **[API Reference](./docs/api-reference.md)** - Endpoints and programmatic API
+
+## Development
+
+### Build
+
+```bash
+npm install
+npm run build
+```
+
+### Test
+
+```bash
+npm test
+npm run test:coverage
+```
+
+### Lint & Format
+
+```bash
+npm run lint
+npm run format:check
+npm run format:write
+```
+
+## Database Schema
+
+The plugin creates a `csrf_tokens` table for CSRF protection:
+
+```graphql
+type CSRFToken @table {
+	token: string @key
+	sessionId: string
+	provider: string
+	originalUrl: string
+	createdAt: number
+	expiresAt: number @index
+}
+```
+
+Tokens automatically expire after 10 minutes.
+
+## Security Considerations
+
+- **HTTPS required** - OAuth requires HTTPS in production
+- **CSRF protection** - Automatic via state parameter validation
+- **ID token verification** - OIDC providers verify token signatures
+- **Secure sessions** - Use Harper's secure session configuration
+- **Token storage** - Tokens stored in session (configure secure cookies)
+
+## Debug Mode
+
+Enable debug endpoints for testing:
+
+```yaml
+'@harperfast/oauth':
+  debug: true
+  providers:
+    github:
+      clientId: ${OAUTH_GITHUB_CLIENT_ID}
+      clientSecret: ${OAUTH_GITHUB_CLIENT_SECRET}
+```
+
+Debug endpoints:
+
+- `GET /oauth/` - List configured providers
+- `GET /oauth/test` - Interactive test page
+- `GET /oauth/{provider}/user` - View current session
+- `GET /oauth/{provider}/refresh` - Trigger token refresh
+
+**Warning:** Never enable debug mode in production.
+
+## License
+
+This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.
+
+Copyright 2025 HarperDB, Inc.