byok-relay 1.0.0

package/.env.example

@@ -0,0 +1,14 @@
+# Required: encryption key for API keys at rest (generate with: openssl rand -hex 32)
+ENCRYPTION_SECRET=change-me-to-a-random-secret-at-least-32-chars
+
+# Port to listen on (default: 3000)
+PORT=3000
+
+# Comma-separated list of allowed CORS origins
+# Production: restrict to your app's domain(s)
+# Example: https://myfreetimeinaweek.in,https://anotherapp.example.com
+# Development: add localhost ports as needed
+ALLOWED_ORIGINS=https://yourapp.example.com,http://localhost:3000,http://localhost:19006
+
+# Path to SQLite database file (default: ./data/relay.db)
+# DB_PATH=./data/relay.db

package/.github/workflows/deploy.yml

@@ -0,0 +1,28 @@
+name: Deploy to OCI
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  deploy:
+    name: SSH deploy to OCI instance
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Deploy via SSH
+        uses: appleboy/ssh-action@v1.0.3
+        with:
+          host: ${{ secrets.OCI_HOST }}
+          username: ubuntu
+          key: ${{ secrets.SSH_PRIVATE_KEY }}
+          script: |
+            set -e
+            export PATH="$HOME/.nvm/versions/node/v20.20.2/bin:$PATH"
+            cd ~/byok-relay
+            git pull origin main
+            npm ci --omit=dev
+            sudo systemctl restart byok-relay
+            sleep 3
+            curl -sf http://localhost:3000/health || (echo "Health check failed" && exit 1)
+            echo "Deployed successfully"

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,234 @@
+# byok-relay
+
+**Website:** [byokrelay.com](https://byokrelay.com) | **Hosted relay:** [relay.byokrelay.com](https://relay.byokrelay.com)
+
+[![skills.sh](https://skills.sh/b/avikalpg/byok-relay)](https://skills.sh/avikalpg/byok-relay)
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Favikalpg%2Fbyok-relay&env=ENCRYPTION_SECRET,ALLOWED_ORIGINS&envDescription=ENCRYPTION_SECRET%3A%20generate%20with%20%60openssl%20rand%20-hex%2032%60.%20ALLOWED_ORIGINS%3A%20your%20frontend%20domain%20(e.g.%20https%3A%2F%2Fmy-app.vercel.app)&envLink=https%3A%2F%2Fgithub.com%2Favikalpg%2Fbyok-relay%23setup&project-name=byok-relay&repository-name=byok-relay)
+
+A self-hosted (or managed) relay that lets your app's users bring their own AI API keys — no CORS, no exposed keys, no inference bill for the developer.
+
+## Managed relay
+
+**Don't want to self-host?** Use ours — no setup needed:
+
+```
+https://relay.byokrelay.com
+```
+
+Free to use. Open CORS (any origin). [Health check →](https://relay.byokrelay.com/health)
+
+## For AI coding agents
+
+If you're using a coding agent (Cursor, Claude Code, Copilot, Codex, etc.), install the skill and let it handle the integration:
+
+```bash
+npx skills add avikalpg/byok-relay
+```
+
+Or point your agent directly at the skill file:
+
+```
+https://byokrelay.com/skill
+```
+
+> Prompt: *"Read the byok-relay skill at https://byokrelay.com/skill and integrate byok-relay into this project using the hosted relay at https://relay.byokrelay.com"*
+
+## The problem
+
+Browser apps can't call AI APIs directly:
+- `api.anthropic.com`, `api.openai.com`, and most AI providers **block browser requests via CORS**
+- Putting API keys in frontend code exposes them to every user
+
+The common workaround — a backend proxy — means the *app developer* holds the keys. That's a trust problem. Users have to trust you not to misuse or leak their keys.
+
+**byok-relay solves this differently:** users bring their own keys, the relay stores them encrypted on *your* server, and proxies requests without ever returning the key. The user's key travels over the wire exactly once — when they register it.
+
+## How it works
+
+```
+Browser                  byok-relay              AI Provider
+  │                           │                       │
+  ├─ POST /users ────────────►│                       │
+  │◄─ { token } ─────────────┤                       │
+  │                           │                       │
+  ├─ POST /keys/anthropic ───►│                       │
+  │  { key: "sk-ant-..." }    │ (stored encrypted)    │
+  │◄─ { ok: true } ──────────┤                       │
+  │                           │                       │
+  ├─ POST /relay/anthropic ──►│                       │
+  │  x-relay-token: <token>   ├─ (real key injected) ►│
+  │  { model, messages... }   │                       │
+  │◄─ streamed response ──────┤◄─ streamed response ──┤
+```
+
+The `token` (not the API key) is stored in the browser. The API key stays server-side, encrypted at rest with AES-256-GCM.
+
+## Supported providers
+
+| Provider | Name | Notes |
+|---|---|---|
+| Anthropic | `anthropic` | Claude models, SSE streaming |
+| OpenAI | `openai` | GPT models, SSE streaming |
+| Google | `google` | Gemini API (key in query param) |
+| Groq | `groq` | Fast inference, OpenAI-compatible |
+| OpenRouter | `openrouter` | 200+ models via one API |
+| Mistral | `mistral` | Mistral models |
+| Any OpenAI-compatible | `openai-compatible` | Pass `x-relay-base-url` header — covers LiteLLM, Ollama, Perplexity, Together AI, and any other OpenAI-compatible endpoint |
+
+Adding a new built-in provider is ~5 lines in `src/providers.js`.
+
+## API
+
+### Register a user
+```http
+POST /users
+Content-Type: application/json
+
+{ "app_id": "my-app" }
+```
+→ `{ "token": "<relay-token>" }` — store in browser localStorage
+
+### Store an API key
+```http
+POST /keys/anthropic
+x-relay-token: <token>
+Content-Type: application/json
+
+{ "key": "sk-ant-..." }
+```
+
+### List stored providers (key values never returned)
+```http
+GET /keys
+x-relay-token: <token>
+```
+
+### Delete a key
+```http
+DELETE /keys/anthropic
+x-relay-token: <token>
+```
+
+### Relay a request
+```http
+POST /relay/anthropic/v1/messages
+x-relay-token: <token>
+Content-Type: application/json
+anthropic-version: 2023-06-01
+
+{ "model": "claude-3-5-haiku-20241022", "max_tokens": 1024, "messages": [...], "stream": true }
+```
+Full streaming (SSE) is supported — the response is piped directly from the provider to the browser.
+
+### Generic OpenAI-compatible relay
+```http
+POST /relay/openai-compatible/v1/chat/completions
+x-relay-token: <token>
+x-relay-base-url: https://openrouter.ai
+Content-Type: application/json
+
+{ "model": "...", "messages": [...] }
+```
+
+## Deploy in one click
+
+The fastest way to get byok-relay running is via Vercel:
+
+[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Favikalpg%2Fbyok-relay&env=ENCRYPTION_SECRET,ALLOWED_ORIGINS&envDescription=ENCRYPTION_SECRET%3A%20generate%20with%20%60openssl%20rand%20-hex%2032%60.%20ALLOWED_ORIGINS%3A%20your%20frontend%20domain%20(e.g.%20https%3A%2F%2Fmy-app.vercel.app)&envLink=https%3A%2F%2Fgithub.com%2Favikalpg%2Fbyok-relay%23setup&project-name=byok-relay&repository-name=byok-relay)
+
+1. Click the button above
+2. Set `ENCRYPTION_SECRET` (generate: `openssl rand -hex 32`) and `ALLOWED_ORIGINS` (your frontend domain)
+3. Deploy — your relay is live at `https://byok-relay-<hash>.vercel.app`
+
+> **Note:** Vercel's serverless environment has an ephemeral filesystem, so SQLite state resets between cold starts. This is fine for demos and prototyping. For production with persistent key storage, deploy to a long-running server (see [Production setup](#production-ubuntu--systemd) below, or use Railway/Render).
+
+## Quickstart (60 seconds)
+
+```bash
+# 1. Clone and install
+git clone https://github.com/avikalpg/byok-relay.git && cd byok-relay && npm install
+
+# 2. Configure
+echo "ENCRYPTION_SECRET=$(openssl rand -hex 32)" > .env
+echo "ALLOWED_ORIGINS=http://localhost:3000" >> .env
+
+# 3. Start
+npm start &
+
+# 4. Register a user and get a token
+TOKEN=$(curl -s -X POST http://localhost:3000/users \
+  -H "Content-Type: application/json" \
+  -d '{"app_id":"test"}' | python3 -c "import sys,json; print(json.load(sys.stdin)['token'])")
+
+# 5. Store your Anthropic key
+curl -X POST http://localhost:3000/keys/anthropic \
+  -H "Content-Type: application/json" \
+  -H "x-relay-token: $TOKEN" \
+  -d '{"key":"sk-ant-YOUR-KEY-HERE"}'
+
+# 6. Relay a request (streaming)
+curl -X POST http://localhost:3000/relay/anthropic/v1/messages \
+  -H "Content-Type: application/json" \
+  -H "anthropic-version: 2023-06-01" \
+  -H "x-relay-token: $TOKEN" \
+  -d '{"model":"claude-3-5-haiku-20241022","max_tokens":256,"stream":true,"messages":[{"role":"user","content":"Hello!"}]}'
+```
+
+## Setup
+
+### 1. Install
+```bash
+git clone https://github.com/avikalpg/byok-relay.git
+cd byok-relay
+npm install
+```
+
+### 2. Configure
+```bash
+cp .env.example .env
+# Set ENCRYPTION_SECRET (generate: openssl rand -hex 32)
+# Set ALLOWED_ORIGINS to your app's domain(s)
+```
+
+### 3. Run
+```bash
+npm start
+```
+
+### Production (Ubuntu + systemd)
+```bash
+# Copy service file
+sudo cp deploy/byok-relay.service /etc/systemd/system/
+sudo systemctl enable --now byok-relay
+
+# HTTPS with nginx + Let's Encrypt
+sudo apt install nginx
+sudo snap install --classic certbot
+sudo certbot --nginx -d relay.yourdomain.com
+```
+
+## Security
+
+- **AES-256-GCM encryption** — keys are encrypted at rest; the `ENCRYPTION_SECRET` lives only in your server environment
+- **Keys never returned** — the API after initial POST
+- **Rate limiting** — 100 req/min global, 20 AI req/min per token, 10 registrations/hour per IP
+- **Startup validation** — server refuses to start without a valid `ENCRYPTION_SECRET`
+- **CORS** — restrict `ALLOWED_ORIGINS` to your app's domain in production
+- **HTTPS required** in production (mixed-content browsers block HTTP endpoints called from HTTPS pages)
+
+## Trade-offs
+
+- **You hold the encrypted keys** — users trust your server. If your server is compromised and the `ENCRYPTION_SECRET` leaks, all keys could be decrypted. For higher assurance, replace SQLite with a cloud KMS-backed store.
+- **No user accounts** — the relay token is the only credential. Anyone who steals a user's localStorage token can use their stored key. Mitigate by scoping tokens to IP or adding optional auth.
+- **Self-hosted** — you're responsible for uptime, security updates, and backups.
+
+## Find us on
+
+- [There's An AI For That](https://theresanaiforthat.com) — *submission in review*
+- [skills.sh](https://skills.sh/avikalpg/byok-relay) — AI coding agent skill registry
+- [Awesome LLMOps](https://github.com/tensorchord/Awesome-LLMOps) — *PR in review*
+- [Awesome ChatGPT API](https://github.com/reorx/awesome-chatgpt-api) — *PR in review*
+
+## License
+
+Apache 2.0

package/deploy/byok-relay.service

@@ -0,0 +1,21 @@
+[Unit]
+Description=BYOK Relay Server
+After=network.target
+
+[Service]
+Type=simple
+User=ubuntu
+WorkingDirectory=/home/ubuntu/byok-relay
+ExecStart=/usr/bin/node src/index.js
+Restart=on-failure
+RestartSec=10
+StandardOutput=journal
+StandardError=journal
+SyslogIdentifier=byok-relay
+
+# Environment — copy .env.example to .env and fill in values
+# The EnvironmentFile directive loads .env automatically
+EnvironmentFile=/home/ubuntu/byok-relay/.env
+
+[Install]
+WantedBy=multi-user.target