@carlos-tzin/tzin 0.1.7 → 0.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/auth.d.ts +76 -0
- package/dist/auth.js +177 -0
- package/package.json +5 -1
package/dist/auth.d.ts
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
import type { Middleware } from './middleware.js';
|
|
2
|
+
export interface AuthUser {
|
|
3
|
+
id: string;
|
|
4
|
+
[key: string]: unknown;
|
|
5
|
+
}
|
|
6
|
+
export interface AuthConfig {
|
|
7
|
+
/** Secret key for JWT signing/verification */
|
|
8
|
+
secret: string;
|
|
9
|
+
/** Token issuer (optional) */
|
|
10
|
+
issuer?: string;
|
|
11
|
+
/** Token audience (optional) */
|
|
12
|
+
audience?: string;
|
|
13
|
+
/** Token expiration (default: '1h') */
|
|
14
|
+
expiresIn?: string;
|
|
15
|
+
/** Custom token extractor (default: Bearer header) */
|
|
16
|
+
extractToken?: (req: Request) => string | null;
|
|
17
|
+
/** Called when auth fails */
|
|
18
|
+
onUnauthorized?: (req: Request, reason: string) => Response | Promise<Response>;
|
|
19
|
+
}
|
|
20
|
+
export interface JwtPayload {
|
|
21
|
+
sub: string;
|
|
22
|
+
iat: number;
|
|
23
|
+
exp: number;
|
|
24
|
+
iss?: string;
|
|
25
|
+
aud?: string;
|
|
26
|
+
[key: string]: unknown;
|
|
27
|
+
}
|
|
28
|
+
/** Typed key for the authenticated user */
|
|
29
|
+
export declare const AUTH_USER: import("./context.js").ContextKey<AuthUser>;
|
|
30
|
+
/**
|
|
31
|
+
* Sign a JWT token.
|
|
32
|
+
*/
|
|
33
|
+
export declare function signJwt(payload: Record<string, unknown>, secret: string, options?: {
|
|
34
|
+
expiresIn?: string;
|
|
35
|
+
issuer?: string;
|
|
36
|
+
audience?: string;
|
|
37
|
+
}): string;
|
|
38
|
+
/**
|
|
39
|
+
* Verify a JWT token.
|
|
40
|
+
*/
|
|
41
|
+
export declare function verifyJwt(token: string, secret: string, options?: {
|
|
42
|
+
issuer?: string;
|
|
43
|
+
audience?: string;
|
|
44
|
+
}): JwtPayload;
|
|
45
|
+
/**
|
|
46
|
+
* Bearer token authentication middleware.
|
|
47
|
+
*
|
|
48
|
+
* Validates the Authorization: Bearer <token> header and attaches
|
|
49
|
+
* the decoded user to ctx.set(AUTH_USER, user).
|
|
50
|
+
*
|
|
51
|
+
* @example
|
|
52
|
+
* ```ts
|
|
53
|
+
* import { bearerAuth, AUTH_USER } from '@carlos-tzin/tzin/auth'
|
|
54
|
+
*
|
|
55
|
+
* const app = createApp(routes, {
|
|
56
|
+
* middleware: [bearerAuth({ secret: process.env.JWT_SECRET! })],
|
|
57
|
+
* })
|
|
58
|
+
*
|
|
59
|
+
* // In handler:
|
|
60
|
+
* const user = ctx.require(AUTH_USER)
|
|
61
|
+
* ```
|
|
62
|
+
*/
|
|
63
|
+
export declare function bearerAuth(config: AuthConfig): Middleware;
|
|
64
|
+
/**
|
|
65
|
+
* Optional auth middleware - doesn't fail if no token,
|
|
66
|
+
* but validates if present.
|
|
67
|
+
*/
|
|
68
|
+
export declare function optionalAuth(config: AuthConfig): Middleware;
|
|
69
|
+
/**
|
|
70
|
+
* API key authentication middleware.
|
|
71
|
+
* Checks for a header like X-API-Key.
|
|
72
|
+
*/
|
|
73
|
+
export declare function apiKeyAuth(config: {
|
|
74
|
+
key: string;
|
|
75
|
+
header?: string;
|
|
76
|
+
}): Middleware;
|
package/dist/auth.js
ADDED
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
import { defineContext } from './context.js';
|
|
2
|
+
// ── Context Key ──────────────────────────────────────────────────────
|
|
3
|
+
/** Typed key for the authenticated user */
|
|
4
|
+
export const AUTH_USER = defineContext('auth_user');
|
|
5
|
+
// ── JWT Utilities (minimal, no dependencies) ────────────────────────
|
|
6
|
+
function base64UrlEncode(data) {
|
|
7
|
+
return Buffer.from(data).toString('base64url');
|
|
8
|
+
}
|
|
9
|
+
function base64UrlDecode(data) {
|
|
10
|
+
return Buffer.from(data, 'base64url').toString();
|
|
11
|
+
}
|
|
12
|
+
function hmacSign(data, secret) {
|
|
13
|
+
const { createHmac } = require('node:crypto');
|
|
14
|
+
return createHmac('sha256', secret).update(data).digest('base64url');
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Sign a JWT token.
|
|
18
|
+
*/
|
|
19
|
+
export function signJwt(payload, secret, options) {
|
|
20
|
+
const header = { alg: 'HS256', typ: 'JWT' };
|
|
21
|
+
const now = Math.floor(Date.now() / 1000);
|
|
22
|
+
const exp = options?.expiresIn ? parseDuration(options.expiresIn) : 3600;
|
|
23
|
+
const fullPayload = {
|
|
24
|
+
...payload,
|
|
25
|
+
iat: now,
|
|
26
|
+
exp: now + exp,
|
|
27
|
+
...(options?.issuer && { iss: options.issuer }),
|
|
28
|
+
...(options?.audience && { aud: options.audience }),
|
|
29
|
+
};
|
|
30
|
+
const headerEncoded = base64UrlEncode(JSON.stringify(header));
|
|
31
|
+
const payloadEncoded = base64UrlEncode(JSON.stringify(fullPayload));
|
|
32
|
+
const signature = hmacSign(`${headerEncoded}.${payloadEncoded}`, secret);
|
|
33
|
+
return `${headerEncoded}.${payloadEncoded}.${signature}`;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Verify a JWT token.
|
|
37
|
+
*/
|
|
38
|
+
export function verifyJwt(token, secret, options) {
|
|
39
|
+
const parts = token.split('.');
|
|
40
|
+
if (parts.length !== 3)
|
|
41
|
+
throw new Error('Invalid JWT format');
|
|
42
|
+
const [headerEncoded, payloadEncoded, signature] = parts;
|
|
43
|
+
const expectedSig = hmacSign(`${headerEncoded}.${payloadEncoded}`, secret);
|
|
44
|
+
if (signature !== expectedSig)
|
|
45
|
+
throw new Error('Invalid JWT signature');
|
|
46
|
+
const payload = JSON.parse(base64UrlDecode(payloadEncoded));
|
|
47
|
+
if (payload.exp && payload.exp < Math.floor(Date.now() / 1000)) {
|
|
48
|
+
throw new Error('Token expired');
|
|
49
|
+
}
|
|
50
|
+
if (options?.issuer && payload.iss !== options.issuer) {
|
|
51
|
+
throw new Error('Invalid issuer');
|
|
52
|
+
}
|
|
53
|
+
if (options?.audience && payload.aud !== options.audience) {
|
|
54
|
+
throw new Error('Invalid audience');
|
|
55
|
+
}
|
|
56
|
+
return payload;
|
|
57
|
+
}
|
|
58
|
+
function parseDuration(str) {
|
|
59
|
+
const match = str.match(/^(\d+)([smhd])$/);
|
|
60
|
+
if (!match)
|
|
61
|
+
return 3600;
|
|
62
|
+
const [, num, unit] = match;
|
|
63
|
+
const n = parseInt(num, 10);
|
|
64
|
+
switch (unit) {
|
|
65
|
+
case 's': return n;
|
|
66
|
+
case 'm': return n * 60;
|
|
67
|
+
case 'h': return n * 3600;
|
|
68
|
+
case 'd': return n * 86400;
|
|
69
|
+
default: return 3600;
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
// ── Middleware ────────────────────────────────────────────────────────
|
|
73
|
+
/**
|
|
74
|
+
* Bearer token authentication middleware.
|
|
75
|
+
*
|
|
76
|
+
* Validates the Authorization: Bearer <token> header and attaches
|
|
77
|
+
* the decoded user to ctx.set(AUTH_USER, user).
|
|
78
|
+
*
|
|
79
|
+
* @example
|
|
80
|
+
* ```ts
|
|
81
|
+
* import { bearerAuth, AUTH_USER } from '@carlos-tzin/tzin/auth'
|
|
82
|
+
*
|
|
83
|
+
* const app = createApp(routes, {
|
|
84
|
+
* middleware: [bearerAuth({ secret: process.env.JWT_SECRET! })],
|
|
85
|
+
* })
|
|
86
|
+
*
|
|
87
|
+
* // In handler:
|
|
88
|
+
* const user = ctx.require(AUTH_USER)
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
export function bearerAuth(config) {
|
|
92
|
+
const extract = config.extractToken ?? defaultExtractToken;
|
|
93
|
+
const onUnauthorized = config.onUnauthorized ?? defaultUnauthorized;
|
|
94
|
+
return async ({ req, ctx, next }) => {
|
|
95
|
+
const token = extract(req);
|
|
96
|
+
if (!token) {
|
|
97
|
+
return onUnauthorized(req, 'Missing token');
|
|
98
|
+
}
|
|
99
|
+
try {
|
|
100
|
+
const payload = verifyJwt(token, config.secret, {
|
|
101
|
+
issuer: config.issuer,
|
|
102
|
+
audience: config.audience,
|
|
103
|
+
});
|
|
104
|
+
const user = {
|
|
105
|
+
id: payload.sub,
|
|
106
|
+
...payload,
|
|
107
|
+
};
|
|
108
|
+
ctx.set(AUTH_USER, user);
|
|
109
|
+
return next();
|
|
110
|
+
}
|
|
111
|
+
catch (err) {
|
|
112
|
+
const reason = err instanceof Error ? err.message : 'Invalid token';
|
|
113
|
+
return onUnauthorized(req, reason);
|
|
114
|
+
}
|
|
115
|
+
};
|
|
116
|
+
}
|
|
117
|
+
/**
|
|
118
|
+
* Optional auth middleware - doesn't fail if no token,
|
|
119
|
+
* but validates if present.
|
|
120
|
+
*/
|
|
121
|
+
export function optionalAuth(config) {
|
|
122
|
+
const extract = config.extractToken ?? defaultExtractToken;
|
|
123
|
+
return async ({ req, ctx, next }) => {
|
|
124
|
+
const token = extract(req);
|
|
125
|
+
if (!token) {
|
|
126
|
+
return next();
|
|
127
|
+
}
|
|
128
|
+
try {
|
|
129
|
+
const payload = verifyJwt(token, config.secret, {
|
|
130
|
+
issuer: config.issuer,
|
|
131
|
+
audience: config.audience,
|
|
132
|
+
});
|
|
133
|
+
const user = {
|
|
134
|
+
id: payload.sub,
|
|
135
|
+
...payload,
|
|
136
|
+
};
|
|
137
|
+
ctx.set(AUTH_USER, user);
|
|
138
|
+
}
|
|
139
|
+
catch {
|
|
140
|
+
// Ignore invalid tokens in optional mode
|
|
141
|
+
}
|
|
142
|
+
return next();
|
|
143
|
+
};
|
|
144
|
+
}
|
|
145
|
+
/**
|
|
146
|
+
* API key authentication middleware.
|
|
147
|
+
* Checks for a header like X-API-Key.
|
|
148
|
+
*/
|
|
149
|
+
export function apiKeyAuth(config) {
|
|
150
|
+
const headerName = config.header ?? 'x-api-key';
|
|
151
|
+
return async ({ req, next }) => {
|
|
152
|
+
const apiKey = req.headers.get(headerName);
|
|
153
|
+
if (!apiKey || apiKey !== config.key) {
|
|
154
|
+
return new Response(JSON.stringify({ error: 'Invalid API key' }), {
|
|
155
|
+
status: 401,
|
|
156
|
+
headers: { 'content-type': 'application/json' },
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
return next();
|
|
160
|
+
};
|
|
161
|
+
}
|
|
162
|
+
// ── Helpers ──────────────────────────────────────────────────────────
|
|
163
|
+
function defaultExtractToken(req) {
|
|
164
|
+
const auth = req.headers.get('authorization');
|
|
165
|
+
if (!auth)
|
|
166
|
+
return null;
|
|
167
|
+
const parts = auth.split(' ');
|
|
168
|
+
if (parts.length !== 2 || parts[0] !== 'Bearer')
|
|
169
|
+
return null;
|
|
170
|
+
return parts[1];
|
|
171
|
+
}
|
|
172
|
+
function defaultUnauthorized(_req, reason) {
|
|
173
|
+
return new Response(JSON.stringify({ error: reason }), {
|
|
174
|
+
status: 401,
|
|
175
|
+
headers: { 'content-type': 'application/json' },
|
|
176
|
+
});
|
|
177
|
+
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@carlos-tzin/tzin",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.8",
|
|
4
4
|
"description": "Contract-first TypeScript framework. Types that scale, realtime channels with presence, and an MCP server for every API.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "The tzin authors",
|
|
@@ -50,6 +50,10 @@
|
|
|
50
50
|
"./db": {
|
|
51
51
|
"types": "./dist/db.d.ts",
|
|
52
52
|
"default": "./dist/db.js"
|
|
53
|
+
},
|
|
54
|
+
"./auth": {
|
|
55
|
+
"types": "./dist/auth.d.ts",
|
|
56
|
+
"default": "./dist/auth.js"
|
|
53
57
|
}
|
|
54
58
|
},
|
|
55
59
|
"files": [
|