feat: support Authentication and Authorization for the proxy#41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jiashengguo merged 9 commits into from
Jun 20, 2026
Merged

feat: support Authentication and Authorization for the proxy #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
649f9b4
feat: add public API key support and request signature verification
jiashengguo May 30, 2026
febf960
feat: add signature verification middleware and related options
jiashengguo Jun 16, 2026
1c63ae5
feat: update version to 0.5.0 and rename publicAPIKey to studioAuthKey
jiashengguo Jun 16, 2026
4f26d58
fix: update pnpm-lock.yaml
jiashengguo Jun 16, 2026
7466fea
Update package.json
jiashengguo Jun 16, 2026
d7fcb3c
feat: update authentication key in README to studioAuthKey and adjust…
jiashengguo Jun 16, 2026
30ad1a6
feat: add test step to build workflow and remove obsolete signature v…
jiashengguo Jun 18, 2026
b903a43
fix: update test script to target specific test files
jiashengguo Jun 18, 2026
4dea042
fix: improve policy enforcement handling for anonymous users in resol…
jiashengguo Jun 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/build-test.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -57,3 +57,6 @@ jobs:
run: |
pnpm run build
pnpm tsx scripts/post-build.ts

- name: Test
run: pnpm test
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,9 @@ zenstack-proxy [options]
- `-p, --port <number>` Port number for the server (default: `8008`)
- `-s, --schema <path>` - Path to ZModel schema file (default: "schema.zmodel")
- `-d, --datasource-url <url>` Datasource URL (overrides schema configuration)
- `--studioAuthKey <key>` Authentication key from ZenStack Studio. When set, the proxy will only accept requests signed by your Studio project.
- `-l, --log <level...>` Query log levels (e.g., query, info, warn, error)
- `--signature-tolerance-secs <number>` Time tolerance in seconds for signed requests (default: `60`)

### Examples

Expand All@@ -46,6 +48,20 @@ zenstack-proxy -s ./schema/schema.zmodel -z ./generated/zenstack
zenstack-proxy -p 8888
```

#### Enable signed requests

```bash
zenstack-proxy --studioAuthKey "MCowBQYDK2VwAyEAFSJV7wjdFuDz2CqYX7hGnITQvcmJYy7OJQq2Cy2Eiqs="
```

When `--studioAuthKey` is provided, every incoming request must include an `X-ZenStack-Signature` header in the format `t=<unix timestamp>,v1=<base64url signature>`.
The signed message format matches ZenStack Studio: `payload + timestamp [+ authorizationToken]`.

- For `GET` and `DELETE` requests, `payload` is the raw query string without the leading `?`.
- For body-based requests, `payload` is the exact JSON request body string.
- For requests without query params or a request body, `payload` is an empty string.
- If an `Authorization: Bearer <token>` header is present, append `<token>` to the signed message.

## Server Endpoints

The server provides the following endpoints:
Expand Down
7 changes: 5 additions & 2 deletions package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "@zenstackhq/proxy",
"version": "0.4.2",
"version": "0.5.0",
"description": "A CLI tool to run an Express server that proxies CRUD requests to a ZenStack backend",
"main": "index.js",
"publishConfig": {
Expand All@@ -18,7 +18,8 @@
},
"scripts": {
"clean": "rimraf dist",
"build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build"
"build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build",
"test": "node --require tsx/cjs --test test/*.test.ts "
},
"keywords": [
"zenstack",
Expand DownExpand Up@@ -49,8 +50,10 @@
"@types/express": "^5.0.0",
"@types/node": "^20.0.0",
"@types/semver": "^7.7.1",
"@types/supertest": "^6.0.2",
"copyfiles": "^2.4.1",
"rimraf": "^4.0.0",
"supertest": "^7.0.0",
"typescript": "^5.0.0"
Comment thread
coderabbitai[bot] marked this conversation as resolved.
},
"exports": {
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat: support Authentication and Authorization for the proxy#41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jiashengguo
merged 9 commits into

from

Jun 20, 2026
 Merged


feat: support Authentication and Authorization for the proxy
#41
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
649f9b4

feat: add public API key support and request signature verification


jiashengguo May 30, 2026
febf960

feat: add signature verification middleware and related options


jiashengguo Jun 16, 2026
1c63ae5

feat: update version to 0.5.0 and rename publicAPIKey to studioAuthKey


jiashengguo Jun 16, 2026
4f26d58

fix: update pnpm-lock.yaml


jiashengguo Jun 16, 2026
7466fea

Update package.json


jiashengguo Jun 16, 2026
d7fcb3c

feat: update authentication key in README to studioAuthKey and adjust…


jiashengguo Jun 16, 2026
30ad1a6

feat: add test step to build workflow and remove obsolete signature v…


jiashengguo Jun 18, 2026
b903a43

fix: update test script to target specific test files


jiashengguo Jun 18, 2026
4dea042

fix: improve policy enforcement handling for anonymous users in resol…


jiashengguo Jun 20, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
.github/workflows/build-test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,3 +57,6 @@ jobs:
 run: |
 pnpm run build
 pnpm tsx scripts/post-build.ts

 - name: Test
 run: pnpm test

16 changes: 16 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,9 @@ zenstack-proxy [options]
- `-p, --port <number>` Port number for the server (default: `8008`)
- `-s, --schema <path>` - Path to ZModel schema file (default: "schema.zmodel")
- `-d, --datasource-url <url>` Datasource URL (overrides schema configuration)
- `--studioAuthKey <key>` Authentication key from ZenStack Studio. When set, the proxy will only accept requests signed by your Studio project.
- `-l, --log <level...>` Query log levels (e.g., query, info, warn, error)
- `--signature-tolerance-secs <number>` Time tolerance in seconds for signed requests (default: `60`)

### Examples

Expand All@@ -46,6 +48,20 @@ zenstack-proxy -s ./schema/schema.zmodel -z ./generated/zenstack
zenstack-proxy -p 8888
```

#### Enable signed requests

```bash
zenstack-proxy --studioAuthKey "MCowBQYDK2VwAyEAFSJV7wjdFuDz2CqYX7hGnITQvcmJYy7OJQq2Cy2Eiqs="
```

When `--studioAuthKey` is provided, every incoming request must include an `X-ZenStack-Signature` header in the format `t=<unix timestamp>,v1=<base64url signature>`.
The signed message format matches ZenStack Studio: `payload + timestamp [+ authorizationToken]`.

- For `GET` and `DELETE` requests, `payload` is the raw query string without the leading `?`.
- For body-based requests, `payload` is the exact JSON request body string.
- For requests without query params or a request body, `payload` is an empty string.
- If an `Authorization: Bearer <token>` header is present, append `<token>` to the signed message.

## Server Endpoints

The server provides the following endpoints:
Expand Down

7 changes: 5 additions & 2 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "@zenstackhq/proxy",
 "version": "0.4.2",
 "version": "0.5.0",
 "description": "A CLI tool to run an Express server that proxies CRUD requests to a ZenStack backend",
 "main": "index.js",
 "publishConfig": {
Expand All@@ -18,7 +18,8 @@
 },
 "scripts": {
 "clean": "rimraf dist",
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build"
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build",
 "test": "node --require tsx/cjs --test test/*.test.ts "
 },
 "keywords": [
 "zenstack",
Expand DownExpand Up@@ -49,8 +50,10 @@
 "@types/express": "^5.0.0",
 "@types/node": "^20.0.0",
 "@types/semver": "^7.7.1",
 "@types/supertest": "^6.0.2",
 "copyfiles": "^2.4.1",
 "rimraf": "^4.0.0",
 "supertest": "^7.0.0",
 "typescript": "^5.0.0"
Comment thread
coderabbitai[bot] marked this conversation as resolved.

 },
 "exports": {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: support Authentication and Authorization for the proxy#41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jiashengguo
merged 9 commits into

from

Jun 20, 2026
 Merged


feat: support Authentication and Authorization for the proxy
#41
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
649f9b4

feat: add public API key support and request signature verification


jiashengguo May 30, 2026
febf960

feat: add signature verification middleware and related options


jiashengguo Jun 16, 2026
1c63ae5

feat: update version to 0.5.0 and rename publicAPIKey to studioAuthKey


jiashengguo Jun 16, 2026
4f26d58

fix: update pnpm-lock.yaml


jiashengguo Jun 16, 2026
7466fea

Update package.json


jiashengguo Jun 16, 2026
d7fcb3c

feat: update authentication key in README to studioAuthKey and adjust…


jiashengguo Jun 16, 2026
30ad1a6

feat: add test step to build workflow and remove obsolete signature v…


jiashengguo Jun 18, 2026
b903a43

fix: update test script to target specific test files


jiashengguo Jun 18, 2026
4dea042

fix: improve policy enforcement handling for anonymous users in resol…


jiashengguo Jun 20, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
.github/workflows/build-test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,3 +57,6 @@ jobs:
 run: |
 pnpm run build
 pnpm tsx scripts/post-build.ts

 - name: Test
 run: pnpm test

16 changes: 16 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,9 @@ zenstack-proxy [options]
- `-p, --port <number>` Port number for the server (default: `8008`)
- `-s, --schema <path>` - Path to ZModel schema file (default: "schema.zmodel")
- `-d, --datasource-url <url>` Datasource URL (overrides schema configuration)
- `--studioAuthKey <key>` Authentication key from ZenStack Studio. When set, the proxy will only accept requests signed by your Studio project.
- `-l, --log <level...>` Query log levels (e.g., query, info, warn, error)
- `--signature-tolerance-secs <number>` Time tolerance in seconds for signed requests (default: `60`)

### Examples

Expand All@@ -46,6 +48,20 @@ zenstack-proxy -s ./schema/schema.zmodel -z ./generated/zenstack
zenstack-proxy -p 8888
```

#### Enable signed requests

```bash
zenstack-proxy --studioAuthKey "MCowBQYDK2VwAyEAFSJV7wjdFuDz2CqYX7hGnITQvcmJYy7OJQq2Cy2Eiqs="
```

When `--studioAuthKey` is provided, every incoming request must include an `X-ZenStack-Signature` header in the format `t=<unix timestamp>,v1=<base64url signature>`.
The signed message format matches ZenStack Studio: `payload + timestamp [+ authorizationToken]`.

- For `GET` and `DELETE` requests, `payload` is the raw query string without the leading `?`.
- For body-based requests, `payload` is the exact JSON request body string.
- For requests without query params or a request body, `payload` is an empty string.
- If an `Authorization: Bearer <token>` header is present, append `<token>` to the signed message.

## Server Endpoints

The server provides the following endpoints:
Expand Down

7 changes: 5 additions & 2 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "@zenstackhq/proxy",
 "version": "0.4.2",
 "version": "0.5.0",
 "description": "A CLI tool to run an Express server that proxies CRUD requests to a ZenStack backend",
 "main": "index.js",
 "publishConfig": {
Expand All@@ -18,7 +18,8 @@
 },
 "scripts": {
 "clean": "rimraf dist",
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build"
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build",
 "test": "node --require tsx/cjs --test test/*.test.ts "
 },
 "keywords": [
 "zenstack",
Expand DownExpand Up@@ -49,8 +50,10 @@
 "@types/express": "^5.0.0",
 "@types/node": "^20.0.0",
 "@types/semver": "^7.7.1",
 "@types/supertest": "^6.0.2",
 "copyfiles": "^2.4.1",
 "rimraf": "^4.0.0",
 "supertest": "^7.0.0",
 "typescript": "^5.0.0"
Comment thread
coderabbitai[bot] marked this conversation as resolved.

 },
 "exports": {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: support Authentication and Authorization for the proxy#41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jiashengguo
merged 9 commits into

from

Jun 20, 2026
 Merged


feat: support Authentication and Authorization for the proxy
#41
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
649f9b4

feat: add public API key support and request signature verification


jiashengguo May 30, 2026
febf960

feat: add signature verification middleware and related options


jiashengguo Jun 16, 2026
1c63ae5

feat: update version to 0.5.0 and rename publicAPIKey to studioAuthKey


jiashengguo Jun 16, 2026
4f26d58

fix: update pnpm-lock.yaml


jiashengguo Jun 16, 2026
7466fea

Update package.json


jiashengguo Jun 16, 2026
d7fcb3c

feat: update authentication key in README to studioAuthKey and adjust…


jiashengguo Jun 16, 2026
30ad1a6

feat: add test step to build workflow and remove obsolete signature v…


jiashengguo Jun 18, 2026
b903a43

fix: update test script to target specific test files


jiashengguo Jun 18, 2026
4dea042

fix: improve policy enforcement handling for anonymous users in resol…


jiashengguo Jun 20, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
.github/workflows/build-test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,3 +57,6 @@ jobs:
 run: |
 pnpm run build
 pnpm tsx scripts/post-build.ts

 - name: Test
 run: pnpm test

16 changes: 16 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,9 @@ zenstack-proxy [options]
- `-p, --port <number>` Port number for the server (default: `8008`)
- `-s, --schema <path>` - Path to ZModel schema file (default: "schema.zmodel")
- `-d, --datasource-url <url>` Datasource URL (overrides schema configuration)
- `--studioAuthKey <key>` Authentication key from ZenStack Studio. When set, the proxy will only accept requests signed by your Studio project.
- `-l, --log <level...>` Query log levels (e.g., query, info, warn, error)
- `--signature-tolerance-secs <number>` Time tolerance in seconds for signed requests (default: `60`)

### Examples

Expand All@@ -46,6 +48,20 @@ zenstack-proxy -s ./schema/schema.zmodel -z ./generated/zenstack
zenstack-proxy -p 8888
```

#### Enable signed requests

```bash
zenstack-proxy --studioAuthKey "MCowBQYDK2VwAyEAFSJV7wjdFuDz2CqYX7hGnITQvcmJYy7OJQq2Cy2Eiqs="
```

When `--studioAuthKey` is provided, every incoming request must include an `X-ZenStack-Signature` header in the format `t=<unix timestamp>,v1=<base64url signature>`.
The signed message format matches ZenStack Studio: `payload + timestamp [+ authorizationToken]`.

- For `GET` and `DELETE` requests, `payload` is the raw query string without the leading `?`.
- For body-based requests, `payload` is the exact JSON request body string.
- For requests without query params or a request body, `payload` is an empty string.
- If an `Authorization: Bearer <token>` header is present, append `<token>` to the signed message.

## Server Endpoints

The server provides the following endpoints:
Expand Down

7 changes: 5 additions & 2 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "@zenstackhq/proxy",
 "version": "0.4.2",
 "version": "0.5.0",
 "description": "A CLI tool to run an Express server that proxies CRUD requests to a ZenStack backend",
 "main": "index.js",
 "publishConfig": {
Expand All@@ -18,7 +18,8 @@
 },
 "scripts": {
 "clean": "rimraf dist",
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build"
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build",
 "test": "node --require tsx/cjs --test test/*.test.ts "
 },
 "keywords": [
 "zenstack",
Expand DownExpand Up@@ -49,8 +50,10 @@
 "@types/express": "^5.0.0",
 "@types/node": "^20.0.0",
 "@types/semver": "^7.7.1",
 "@types/supertest": "^6.0.2",
 "copyfiles": "^2.4.1",
 "rimraf": "^4.0.0",
 "supertest": "^7.0.0",
 "typescript": "^5.0.0"
Comment thread
coderabbitai[bot] marked this conversation as resolved.

 },
 "exports": {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat: support Authentication and Authorization for the proxy#41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jiashengguo
merged 9 commits into

from

Jun 20, 2026
 Merged


feat: support Authentication and Authorization for the proxy
#41
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
649f9b4

feat: add public API key support and request signature verification


jiashengguo May 30, 2026
febf960

feat: add signature verification middleware and related options


jiashengguo Jun 16, 2026
1c63ae5

feat: update version to 0.5.0 and rename publicAPIKey to studioAuthKey


jiashengguo Jun 16, 2026
4f26d58

fix: update pnpm-lock.yaml


jiashengguo Jun 16, 2026
7466fea

Update package.json


jiashengguo Jun 16, 2026
d7fcb3c

feat: update authentication key in README to studioAuthKey and adjust…


jiashengguo Jun 16, 2026
30ad1a6

feat: add test step to build workflow and remove obsolete signature v…


jiashengguo Jun 18, 2026
b903a43

fix: update test script to target specific test files


jiashengguo Jun 18, 2026
4dea042

fix: improve policy enforcement handling for anonymous users in resol…


jiashengguo Jun 20, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
.github/workflows/build-test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,3 +57,6 @@ jobs:
 run: |
 pnpm run build
 pnpm tsx scripts/post-build.ts

 - name: Test
 run: pnpm test

16 changes: 16 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,9 @@ zenstack-proxy [options]
- `-p, --port <number>` Port number for the server (default: `8008`)
- `-s, --schema <path>` - Path to ZModel schema file (default: "schema.zmodel")
- `-d, --datasource-url <url>` Datasource URL (overrides schema configuration)
- `--studioAuthKey <key>` Authentication key from ZenStack Studio. When set, the proxy will only accept requests signed by your Studio project.
- `-l, --log <level...>` Query log levels (e.g., query, info, warn, error)
- `--signature-tolerance-secs <number>` Time tolerance in seconds for signed requests (default: `60`)

### Examples

Expand All@@ -46,6 +48,20 @@ zenstack-proxy -s ./schema/schema.zmodel -z ./generated/zenstack
zenstack-proxy -p 8888
```

#### Enable signed requests

```bash
zenstack-proxy --studioAuthKey "MCowBQYDK2VwAyEAFSJV7wjdFuDz2CqYX7hGnITQvcmJYy7OJQq2Cy2Eiqs="
```

When `--studioAuthKey` is provided, every incoming request must include an `X-ZenStack-Signature` header in the format `t=<unix timestamp>,v1=<base64url signature>`.
The signed message format matches ZenStack Studio: `payload + timestamp [+ authorizationToken]`.

- For `GET` and `DELETE` requests, `payload` is the raw query string without the leading `?`.
- For body-based requests, `payload` is the exact JSON request body string.
- For requests without query params or a request body, `payload` is an empty string.
- If an `Authorization: Bearer <token>` header is present, append `<token>` to the signed message.

## Server Endpoints

The server provides the following endpoints:
Expand Down

7 changes: 5 additions & 2 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "@zenstackhq/proxy",
 "version": "0.4.2",
 "version": "0.5.0",
 "description": "A CLI tool to run an Express server that proxies CRUD requests to a ZenStack backend",
 "main": "index.js",
 "publishConfig": {
Expand All@@ -18,7 +18,8 @@
 },
 "scripts": {
 "clean": "rimraf dist",
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build"
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build",
 "test": "node --require tsx/cjs --test test/*.test.ts "
 },
 "keywords": [
 "zenstack",
Expand DownExpand Up@@ -49,8 +50,10 @@
 "@types/express": "^5.0.0",
 "@types/node": "^20.0.0",
 "@types/semver": "^7.7.1",
 "@types/supertest": "^6.0.2",
 "copyfiles": "^2.4.1",
 "rimraf": "^4.0.0",
 "supertest": "^7.0.0",
 "typescript": "^5.0.0"
Comment thread
coderabbitai[bot] marked this conversation as resolved.

 },
 "exports": {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: support Authentication and Authorization for the proxy#41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jiashengguo
merged 9 commits into

from

Jun 20, 2026
 Merged


feat: support Authentication and Authorization for the proxy
#41
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
649f9b4

feat: add public API key support and request signature verification


jiashengguo May 30, 2026
febf960

feat: add signature verification middleware and related options


jiashengguo Jun 16, 2026
1c63ae5

feat: update version to 0.5.0 and rename publicAPIKey to studioAuthKey


jiashengguo Jun 16, 2026
4f26d58

fix: update pnpm-lock.yaml


jiashengguo Jun 16, 2026
7466fea

Update package.json


jiashengguo Jun 16, 2026
d7fcb3c

feat: update authentication key in README to studioAuthKey and adjust…


jiashengguo Jun 16, 2026
30ad1a6

feat: add test step to build workflow and remove obsolete signature v…


jiashengguo Jun 18, 2026
b903a43

fix: update test script to target specific test files


jiashengguo Jun 18, 2026
4dea042

fix: improve policy enforcement handling for anonymous users in resol…


jiashengguo Jun 20, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
.github/workflows/build-test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,3 +57,6 @@ jobs:
 run: |
 pnpm run build
 pnpm tsx scripts/post-build.ts

 - name: Test
 run: pnpm test

16 changes: 16 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,9 @@ zenstack-proxy [options]
- `-p, --port <number>` Port number for the server (default: `8008`)
- `-s, --schema <path>` - Path to ZModel schema file (default: "schema.zmodel")
- `-d, --datasource-url <url>` Datasource URL (overrides schema configuration)
- `--studioAuthKey <key>` Authentication key from ZenStack Studio. When set, the proxy will only accept requests signed by your Studio project.
- `-l, --log <level...>` Query log levels (e.g., query, info, warn, error)
- `--signature-tolerance-secs <number>` Time tolerance in seconds for signed requests (default: `60`)

### Examples

Expand All@@ -46,6 +48,20 @@ zenstack-proxy -s ./schema/schema.zmodel -z ./generated/zenstack
zenstack-proxy -p 8888
```

#### Enable signed requests

```bash
zenstack-proxy --studioAuthKey "MCowBQYDK2VwAyEAFSJV7wjdFuDz2CqYX7hGnITQvcmJYy7OJQq2Cy2Eiqs="
```

When `--studioAuthKey` is provided, every incoming request must include an `X-ZenStack-Signature` header in the format `t=<unix timestamp>,v1=<base64url signature>`.
The signed message format matches ZenStack Studio: `payload + timestamp [+ authorizationToken]`.

- For `GET` and `DELETE` requests, `payload` is the raw query string without the leading `?`.
- For body-based requests, `payload` is the exact JSON request body string.
- For requests without query params or a request body, `payload` is an empty string.
- If an `Authorization: Bearer <token>` header is present, append `<token>` to the signed message.

## Server Endpoints

The server provides the following endpoints:
Expand Down

7 changes: 5 additions & 2 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "@zenstackhq/proxy",
 "version": "0.4.2",
 "version": "0.5.0",
 "description": "A CLI tool to run an Express server that proxies CRUD requests to a ZenStack backend",
 "main": "index.js",
 "publishConfig": {
Expand All@@ -18,7 +18,8 @@
 },
 "scripts": {
 "clean": "rimraf dist",
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build"
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build",
 "test": "node --require tsx/cjs --test test/*.test.ts "
 },
 "keywords": [
 "zenstack",
Expand DownExpand Up@@ -49,8 +50,10 @@
 "@types/express": "^5.0.0",
 "@types/node": "^20.0.0",
 "@types/semver": "^7.7.1",
 "@types/supertest": "^6.0.2",
 "copyfiles": "^2.4.1",
 "rimraf": "^4.0.0",
 "supertest": "^7.0.0",
 "typescript": "^5.0.0"
Comment thread
coderabbitai[bot] marked this conversation as resolved.

 },
 "exports": {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat: support Authentication and Authorization for the proxy#41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jiashengguo
merged 9 commits into

from

Jun 20, 2026
 Merged


feat: support Authentication and Authorization for the proxy
#41
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
649f9b4

feat: add public API key support and request signature verification


jiashengguo May 30, 2026
febf960

feat: add signature verification middleware and related options


jiashengguo Jun 16, 2026
1c63ae5

feat: update version to 0.5.0 and rename publicAPIKey to studioAuthKey


jiashengguo Jun 16, 2026
4f26d58

fix: update pnpm-lock.yaml


jiashengguo Jun 16, 2026
7466fea

Update package.json


jiashengguo Jun 16, 2026
d7fcb3c

feat: update authentication key in README to studioAuthKey and adjust…


jiashengguo Jun 16, 2026
30ad1a6

feat: add test step to build workflow and remove obsolete signature v…


jiashengguo Jun 18, 2026
b903a43

fix: update test script to target specific test files


jiashengguo Jun 18, 2026
4dea042

fix: improve policy enforcement handling for anonymous users in resol…


jiashengguo Jun 20, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
.github/workflows/build-test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,3 +57,6 @@ jobs:
 run: |
 pnpm run build
 pnpm tsx scripts/post-build.ts

 - name: Test
 run: pnpm test

16 changes: 16 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,9 @@ zenstack-proxy [options]
- `-p, --port <number>` Port number for the server (default: `8008`)
- `-s, --schema <path>` - Path to ZModel schema file (default: "schema.zmodel")
- `-d, --datasource-url <url>` Datasource URL (overrides schema configuration)
- `--studioAuthKey <key>` Authentication key from ZenStack Studio. When set, the proxy will only accept requests signed by your Studio project.
- `-l, --log <level...>` Query log levels (e.g., query, info, warn, error)
- `--signature-tolerance-secs <number>` Time tolerance in seconds for signed requests (default: `60`)

### Examples

Expand All@@ -46,6 +48,20 @@ zenstack-proxy -s ./schema/schema.zmodel -z ./generated/zenstack
zenstack-proxy -p 8888
```

#### Enable signed requests

```bash
zenstack-proxy --studioAuthKey "MCowBQYDK2VwAyEAFSJV7wjdFuDz2CqYX7hGnITQvcmJYy7OJQq2Cy2Eiqs="
```

When `--studioAuthKey` is provided, every incoming request must include an `X-ZenStack-Signature` header in the format `t=<unix timestamp>,v1=<base64url signature>`.
The signed message format matches ZenStack Studio: `payload + timestamp [+ authorizationToken]`.

- For `GET` and `DELETE` requests, `payload` is the raw query string without the leading `?`.
- For body-based requests, `payload` is the exact JSON request body string.
- For requests without query params or a request body, `payload` is an empty string.
- If an `Authorization: Bearer <token>` header is present, append `<token>` to the signed message.

## Server Endpoints

The server provides the following endpoints:
Expand Down

7 changes: 5 additions & 2 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "@zenstackhq/proxy",
 "version": "0.4.2",
 "version": "0.5.0",
 "description": "A CLI tool to run an Express server that proxies CRUD requests to a ZenStack backend",
 "main": "index.js",
 "publishConfig": {
Expand All@@ -18,7 +18,8 @@
 },
 "scripts": {
 "clean": "rimraf dist",
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build"
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build",
 "test": "node --require tsx/cjs --test test/*.test.ts "
 },
 "keywords": [
 "zenstack",
Expand DownExpand Up@@ -49,8 +50,10 @@
 "@types/express": "^5.0.0",
 "@types/node": "^20.0.0",
 "@types/semver": "^7.7.1",
 "@types/supertest": "^6.0.2",
 "copyfiles": "^2.4.1",
 "rimraf": "^4.0.0",
 "supertest": "^7.0.0",
 "typescript": "^5.0.0"
Comment thread
coderabbitai[bot] marked this conversation as resolved.

 },
 "exports": {
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat: support Authentication and Authorization for the proxy#41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

jiashengguo
merged 9 commits into

from

Jun 20, 2026
 Merged


feat: support Authentication and Authorization for the proxy
#41
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


9 commits


Select commit
Hold shift + click to select a range
649f9b4

feat: add public API key support and request signature verification


jiashengguo May 30, 2026
febf960

feat: add signature verification middleware and related options


jiashengguo Jun 16, 2026
1c63ae5

feat: update version to 0.5.0 and rename publicAPIKey to studioAuthKey


jiashengguo Jun 16, 2026
4f26d58

fix: update pnpm-lock.yaml


jiashengguo Jun 16, 2026
7466fea

Update package.json


jiashengguo Jun 16, 2026
d7fcb3c

feat: update authentication key in README to studioAuthKey and adjust…


jiashengguo Jun 16, 2026
30ad1a6

feat: add test step to build workflow and remove obsolete signature v…


jiashengguo Jun 18, 2026
b903a43

fix: update test script to target specific test files


jiashengguo Jun 18, 2026
4dea042

fix: improve policy enforcement handling for anonymous users in resol…


jiashengguo Jun 20, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


3 changes: 3 additions & 0 deletions
.github/workflows/build-test.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -57,3 +57,6 @@ jobs:
 run: |
 pnpm run build
 pnpm tsx scripts/post-build.ts

 - name: Test
 run: pnpm test

16 changes: 16 additions & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -22,7 +22,9 @@ zenstack-proxy [options]
- `-p, --port <number>` Port number for the server (default: `8008`)
- `-s, --schema <path>` - Path to ZModel schema file (default: "schema.zmodel")
- `-d, --datasource-url <url>` Datasource URL (overrides schema configuration)
- `--studioAuthKey <key>` Authentication key from ZenStack Studio. When set, the proxy will only accept requests signed by your Studio project.
- `-l, --log <level...>` Query log levels (e.g., query, info, warn, error)
- `--signature-tolerance-secs <number>` Time tolerance in seconds for signed requests (default: `60`)

### Examples

Expand All@@ -46,6 +48,20 @@ zenstack-proxy -s ./schema/schema.zmodel -z ./generated/zenstack
zenstack-proxy -p 8888
```

#### Enable signed requests

```bash
zenstack-proxy --studioAuthKey "MCowBQYDK2VwAyEAFSJV7wjdFuDz2CqYX7hGnITQvcmJYy7OJQq2Cy2Eiqs="
```

When `--studioAuthKey` is provided, every incoming request must include an `X-ZenStack-Signature` header in the format `t=<unix timestamp>,v1=<base64url signature>`.
The signed message format matches ZenStack Studio: `payload + timestamp [+ authorizationToken]`.

- For `GET` and `DELETE` requests, `payload` is the raw query string without the leading `?`.
- For body-based requests, `payload` is the exact JSON request body string.
- For requests without query params or a request body, `payload` is an empty string.
- If an `Authorization: Bearer <token>` header is present, append `<token>` to the signed message.

## Server Endpoints

The server provides the following endpoints:
Expand Down

7 changes: 5 additions & 2 deletions
package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "@zenstackhq/proxy",
 "version": "0.4.2",
 "version": "0.5.0",
 "description": "A CLI tool to run an Express server that proxies CRUD requests to a ZenStack backend",
 "main": "index.js",
 "publishConfig": {
Expand All@@ -18,7 +18,8 @@
 },
 "scripts": {
 "clean": "rimraf dist",
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build"
 "build": "pnpm clean && tsc && copyfiles -F \"bin/*\" dist && copyfiles ./README.md ./LICENSE ./package.json dist && pnpm pack dist --pack-destination ../build",
 "test": "node --require tsx/cjs --test test/*.test.ts "
 },
 "keywords": [
 "zenstack",
Expand DownExpand Up@@ -49,8 +50,10 @@
 "@types/express": "^5.0.0",
 "@types/node": "^20.0.0",
 "@types/semver": "^7.7.1",
 "@types/supertest": "^6.0.2",
 "copyfiles": "^2.4.1",
 "rimraf": "^4.0.0",
 "supertest": "^7.0.0",
 "typescript": "^5.0.0"
Comment thread
coderabbitai[bot] marked this conversation as resolved.

 },
 "exports": {
Expand Down
Loading
Loading