@chttp/auth 0.0.0-stage → 0.2.0
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/LICENSE +202 -0
- package/README.md +91 -2
- package/dist/esm/cookie.d.ts +18 -0
- package/dist/esm/cookie.js +88 -0
- package/dist/esm/csrf.d.ts +3 -0
- package/dist/esm/csrf.js +36 -0
- package/dist/esm/encoding.d.ts +5 -0
- package/dist/esm/encoding.js +71 -0
- package/dist/esm/errors.d.ts +1 -0
- package/dist/esm/errors.js +7 -0
- package/dist/esm/index.d.ts +19 -0
- package/dist/esm/index.js +16 -0
- package/dist/esm/jwt.d.ts +21 -0
- package/dist/esm/jwt.js +160 -0
- package/dist/esm/memory-store.d.ts +16 -0
- package/dist/esm/memory-store.js +59 -0
- package/dist/esm/oauth.d.ts +42 -0
- package/dist/esm/oauth.js +184 -0
- package/dist/esm/password.d.ts +7 -0
- package/dist/esm/password.js +103 -0
- package/dist/esm/providers.d.ts +4 -0
- package/dist/esm/providers.js +27 -0
- package/dist/esm/session.d.ts +29 -0
- package/dist/esm/session.js +94 -0
- package/dist/esm/totp.d.ts +13 -0
- package/dist/esm/totp.js +106 -0
- package/dist/esm/types.d.ts +34 -0
- package/dist/esm/types.js +35 -0
- package/package.json +57 -3
- package/src/cookie.ts +111 -0
- package/src/csrf.ts +46 -0
- package/src/encoding.ts +78 -0
- package/src/errors.ts +8 -0
- package/src/index.ts +61 -0
- package/src/jwt.ts +200 -0
- package/src/memory-store.ts +75 -0
- package/src/oauth.ts +238 -0
- package/src/password.ts +116 -0
- package/src/providers.ts +32 -0
- package/src/session.ts +154 -0
- package/src/totp.ts +132 -0
- package/src/types.ts +80 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright 2026 Joaquin Terrasa & contributors
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,92 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @chttp/auth
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Auth primitives for chttp apps — sessions (Lucia pattern), cookies, scrypt passwords, double-submit CSRF, HS256 JWT, OAuth2 authorization-code + PKCE, and TOTP — as plain async functions over `node:crypto`, authored in the scriptc-compilable subset. The same source builds to a JS package with `tsc` and lowers into a native ELF with `scriptc build`. Zero runtime dependencies.
|
|
4
|
+
|
|
5
|
+
Every function is string-in/string-out or boolean-out; none of them touches a request object — compose them inside `@chttp/router` handlers yourself.
|
|
6
|
+
|
|
7
|
+
## Quickstart
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
import {
|
|
11
|
+
MemorySessionStore,
|
|
12
|
+
buildSessionCookie,
|
|
13
|
+
createSession,
|
|
14
|
+
generateSessionToken,
|
|
15
|
+
readCookie,
|
|
16
|
+
validateSessionToken,
|
|
17
|
+
} from "@chttp/auth";
|
|
18
|
+
|
|
19
|
+
const store = new MemorySessionStore(); // dev/test only — see below
|
|
20
|
+
|
|
21
|
+
app.post("/login", async (c) => {
|
|
22
|
+
const token = generateSessionToken();
|
|
23
|
+
await createSession(store, token, "user-1", { role: "admin" });
|
|
24
|
+
c.header("set-cookie", buildSessionCookie(token, { secure: false }));
|
|
25
|
+
return c.status(201).text("ok");
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
app.get("/me", async (c) => {
|
|
29
|
+
const tok = readCookie(c.req.header("cookie"), "session");
|
|
30
|
+
const rec = tok === null ? null : await validateSessionToken(store, tok);
|
|
31
|
+
if (rec === null) return c.status(401).text("unauthorized");
|
|
32
|
+
return c.text("user:" + rec.userId);
|
|
33
|
+
});
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## What it does
|
|
37
|
+
|
|
38
|
+
- **Sessions** — `generateSessionToken` (384-bit `id.secret` bearer token), `hashToken` (SHA-256 store key — the only thing persisted), `createSession`, `validateSessionToken` (sliding expiry: extends past `extensionThresholdSeconds`, deletes on expiry), `invalidateSession`, `invalidateAllUserSessions`. The `SessionStore` contract is sync-or-async: stores may return values or Promises; auth `await`s either way. `MemorySessionStore` ships for dev/test — **NOT for production** (process memory loses sessions on restart and shares nothing across replicas).
|
|
39
|
+
- **Cookies** — `serializeCookie`/`readCookie` plus prebuilt `buildSessionCookie` (HttpOnly, SameSite=Lax, Secure, Max-Age bound to TTL), `buildExpiredSessionCookie` (logout), `buildCsrfCookie` (deliberately not HttpOnly — double-submit needs a JS read).
|
|
40
|
+
- **Passwords** — `hashPassword`/`verifyPassword`, self-describing `scrypt:N:r:p:salt:hash` format, OWASP defaults (N=2^17, r=8, p=1, 64-byte key). Verify is timing-safe and dummy-hashes on malformed rows.
|
|
41
|
+
- **CSRF** — `generateCsrfToken`, `verifyCsrfToken` (constant-time double-submit compare), `verifyRequestOrigin` (Origin allowlist).
|
|
42
|
+
- **JWT** — `signJwt`/`verifyJwt`/`verifyJwtWith`, JWS compact only, HS256. Verify is null-on-invalid for every failure: bad format, wrong alg (`none` hard-rejected), bad signature, expired/nbf, issuer/audience mismatch. `verifyJwtWith` parses claims through any Standard Schema validator (`@chttp/val`, valibot, zod).
|
|
43
|
+
- **OAuth2 + PKCE** — `generateState`, `generateCodeVerifier`, `codeChallenge` (S256), `createAuthorizationURL`, `exchangeCodeForTokens` (form POST + basic auth, JSON or urlencoded responses), `fetchUserInfo`/`fetchUserInfoWith`. `googleProvider`, `githubProvider`, `discordProvider` presets are plain records — a new provider is a 15-LoC record in your code.
|
|
44
|
+
- **TOTP** — `generateTotpSecret` (base32), `totpAuthUri` (otpauth:// enrollment URI), `verifyTotp` (HMAC-SHA1, 6 digits, 30 s step, ±1 window, constant-time compare).
|
|
45
|
+
|
|
46
|
+
## Recipe: API keys
|
|
47
|
+
|
|
48
|
+
No dedicated module is needed — an API key is a session token whose record carries scopes and a far-future expiry. Only the SHA-256 hash is ever stored, so a database leak doesn't leak usable keys.
|
|
49
|
+
|
|
50
|
+
```ts
|
|
51
|
+
import {
|
|
52
|
+
createSession,
|
|
53
|
+
generateSessionToken,
|
|
54
|
+
hashToken,
|
|
55
|
+
invalidateSession,
|
|
56
|
+
validateSessionToken,
|
|
57
|
+
} from "@chttp/auth";
|
|
58
|
+
|
|
59
|
+
// Provisioning: show `apiKey` to the caller exactly once.
|
|
60
|
+
const TEN_YEARS = 10 * 365 * 24 * 60 * 60;
|
|
61
|
+
const apiKey = generateSessionToken(); // id.secret bearer token (~64 chars)
|
|
62
|
+
await createSession(store, apiKey, ownerUserId, { scopes: ["read", "deploy"] }, {
|
|
63
|
+
ttlSeconds: TEN_YEARS,
|
|
64
|
+
});
|
|
65
|
+
|
|
66
|
+
// Per request: "Authorization: Bearer <apiKey>". extensionThresholdSeconds: 0
|
|
67
|
+
// keeps the record's expiry fixed — API keys shouldn't slide on every call.
|
|
68
|
+
const key = bearer(c.req.header("authorization"));
|
|
69
|
+
const rec =
|
|
70
|
+
key === null
|
|
71
|
+
? null
|
|
72
|
+
: await validateSessionToken(store, key, { extensionThresholdSeconds: 0 });
|
|
73
|
+
if (rec === null) return c.status(401).text("unauthorized");
|
|
74
|
+
const scopes = rec.attributes.scopes as string[];
|
|
75
|
+
if (scopes.indexOf("deploy") < 0) return c.status(403).text("forbidden");
|
|
76
|
+
|
|
77
|
+
// Revocation is the same as sessions:
|
|
78
|
+
await invalidateSession(store, leakedKey);
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Use `store.get(hashToken(key))` directly instead of `validateSessionToken` when you want to skip the expiry check entirely and manage revocation/rotation yourself; stamp `lastUsedAt` into `rec.attributes` on a throttle if you need audit fields.
|
|
82
|
+
|
|
83
|
+
## Notes
|
|
84
|
+
|
|
85
|
+
- **ES256 is not available in this build.** scriptc 0.3.3's static `node:crypto` slice covers hashing, randomness and secret KeyObjects — `createSign`/`createVerify` have no lowering, so `signJwt({ alg: "ES256" })` throws `E_BAD_ALG` and `verifyJwt` rejects ES256 tokens with null. The `string | KeyObject` signature is kept so the feature slots in upstream without a breaking change.
|
|
86
|
+
- **Verify paths never throw** — `null`/`false` on any invalid input (attacker-controlled). Sign and exchange throw `E_*` code strings only on caller bugs (missing key, bad alg, non-positive TTL).
|
|
87
|
+
- **`validateSessionToken` costs one microtask on sync stores** — the await-everything seam keeps postgres/redis adapters possible without forking the API; the SHA-256 dominates the cost anyway.
|
|
88
|
+
- **Refresh-token storage/rotation is app logic.** `exchangeCodeForTokens` returns the `TokenSet`; persist it alongside the session (and re-exchange when `expires_in` elapses) in your own store.
|
|
89
|
+
|
|
90
|
+
## Docs
|
|
91
|
+
|
|
92
|
+
Package page: [`docs/auth.md`](https://github.com/sigilco/cutils/tree/main/docs/auth.md) on the docs site. Contributor/subset notes: [`AGENTS.md`](./AGENTS.md) (subset bans + the release security checklist).
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
export interface CookieAttrs {
|
|
2
|
+
maxAge?: number;
|
|
3
|
+
path?: string;
|
|
4
|
+
secure?: boolean;
|
|
5
|
+
httpOnly?: boolean;
|
|
6
|
+
sameSite?: "lax" | "strict" | "none";
|
|
7
|
+
}
|
|
8
|
+
export declare const SESSION_COOKIE_NAME = "session";
|
|
9
|
+
export declare const CSRF_COOKIE_NAME = "csrf";
|
|
10
|
+
export declare function serializeCookie(name: string, value: string, attrs: CookieAttrs): string;
|
|
11
|
+
export declare function readCookie(cookieHeader: string | null, name: string): string | null;
|
|
12
|
+
export interface SessionCookieOpts {
|
|
13
|
+
secure?: boolean;
|
|
14
|
+
ttlSeconds?: number;
|
|
15
|
+
}
|
|
16
|
+
export declare function buildSessionCookie(token: string, opts?: SessionCookieOpts): string;
|
|
17
|
+
export declare function buildExpiredSessionCookie(opts?: SessionCookieOpts): string;
|
|
18
|
+
export declare function buildCsrfCookie(token: string, opts?: SessionCookieOpts): string;
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
// Set-Cookie serialization + minimal Cookie-header read. Three cookies are
|
|
2
|
+
// set (session, expired-session, csrf) and one is read (session) — 80 LoC
|
|
3
|
+
// beats a jar dependency.
|
|
4
|
+
export const SESSION_COOKIE_NAME = "session";
|
|
5
|
+
export const CSRF_COOKIE_NAME = "csrf";
|
|
6
|
+
function sameSiteAttr(v) {
|
|
7
|
+
if (v === "strict") {
|
|
8
|
+
return "Strict";
|
|
9
|
+
}
|
|
10
|
+
if (v === "none") {
|
|
11
|
+
return "None";
|
|
12
|
+
}
|
|
13
|
+
return "Lax";
|
|
14
|
+
}
|
|
15
|
+
// Full Set-Cookie header value.
|
|
16
|
+
export function serializeCookie(name, value, attrs) {
|
|
17
|
+
let out = name + "=" + value;
|
|
18
|
+
const path = attrs.path === undefined ? "/" : attrs.path;
|
|
19
|
+
out += "; Path=" + path;
|
|
20
|
+
if (attrs.maxAge !== undefined) {
|
|
21
|
+
out += "; Max-Age=" + Math.floor(attrs.maxAge);
|
|
22
|
+
}
|
|
23
|
+
if (attrs.httpOnly === true) {
|
|
24
|
+
out += "; HttpOnly";
|
|
25
|
+
}
|
|
26
|
+
if (attrs.secure === true) {
|
|
27
|
+
out += "; Secure";
|
|
28
|
+
}
|
|
29
|
+
if (attrs.sameSite !== undefined) {
|
|
30
|
+
out += "; SameSite=" + sameSiteAttr(attrs.sameSite);
|
|
31
|
+
}
|
|
32
|
+
return out;
|
|
33
|
+
}
|
|
34
|
+
// Minimal read of the Cookie request header: returns the raw value for
|
|
35
|
+
// `name`, or null. First match wins; values are returned undecoded (the
|
|
36
|
+
// session/csrf tokens this package sets are base64url, which needs none).
|
|
37
|
+
export function readCookie(cookieHeader, name) {
|
|
38
|
+
if (cookieHeader === null) {
|
|
39
|
+
return null;
|
|
40
|
+
}
|
|
41
|
+
const prefix = name + "=";
|
|
42
|
+
const parts = cookieHeader.split(";");
|
|
43
|
+
for (let i = 0; i < parts.length; i++) {
|
|
44
|
+
const p = parts[i].trim();
|
|
45
|
+
if (p.startsWith(prefix)) {
|
|
46
|
+
return p.slice(prefix.length);
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
return null;
|
|
50
|
+
}
|
|
51
|
+
const DEFAULT_COOKIE_TTL = 30 * 24 * 60 * 60;
|
|
52
|
+
// Prebuilt session cookie: HttpOnly, SameSite=Lax, Path=/, Secure=true
|
|
53
|
+
// (override for localhost), Max-Age bound to the session TTL.
|
|
54
|
+
export function buildSessionCookie(token, opts) {
|
|
55
|
+
const secure = opts === undefined || opts.secure === undefined ? true : opts.secure;
|
|
56
|
+
const ttl = opts === undefined || opts.ttlSeconds === undefined ? DEFAULT_COOKIE_TTL : opts.ttlSeconds;
|
|
57
|
+
return serializeCookie(SESSION_COOKIE_NAME, token, {
|
|
58
|
+
maxAge: ttl,
|
|
59
|
+
path: "/",
|
|
60
|
+
secure: secure,
|
|
61
|
+
httpOnly: true,
|
|
62
|
+
sameSite: "lax",
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
// Logout: same name, empty value, already expired.
|
|
66
|
+
export function buildExpiredSessionCookie(opts) {
|
|
67
|
+
const secure = opts === undefined || opts.secure === undefined ? true : opts.secure;
|
|
68
|
+
return serializeCookie(SESSION_COOKIE_NAME, "", {
|
|
69
|
+
maxAge: 0,
|
|
70
|
+
path: "/",
|
|
71
|
+
secure: secure,
|
|
72
|
+
httpOnly: true,
|
|
73
|
+
sameSite: "lax",
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
// CSRF double-submit cookie: deliberately NOT HttpOnly — the pattern needs
|
|
77
|
+
// JS (or the page itself) to read the token into a form field/header.
|
|
78
|
+
export function buildCsrfCookie(token, opts) {
|
|
79
|
+
const secure = opts === undefined || opts.secure === undefined ? true : opts.secure;
|
|
80
|
+
const ttl = opts === undefined || opts.ttlSeconds === undefined ? DEFAULT_COOKIE_TTL : opts.ttlSeconds;
|
|
81
|
+
return serializeCookie(CSRF_COOKIE_NAME, token, {
|
|
82
|
+
maxAge: ttl,
|
|
83
|
+
path: "/",
|
|
84
|
+
secure: secure,
|
|
85
|
+
httpOnly: false,
|
|
86
|
+
sameSite: "lax",
|
|
87
|
+
});
|
|
88
|
+
}
|
package/dist/esm/csrf.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
// CSRF: double-submit cookie + Origin allowlist — the two halves of the
|
|
2
|
+
// pattern. The token compare is constant-time (length pre-check, then
|
|
3
|
+
// timingSafeEqual); the origin allowlist is a plain string match — Origin
|
|
4
|
+
// is not secret material.
|
|
5
|
+
import { randomBytes, timingSafeEqual } from "node:crypto";
|
|
6
|
+
// base64url(32 random bytes).
|
|
7
|
+
export function generateCsrfToken() {
|
|
8
|
+
return randomBytes(32).toString("base64url");
|
|
9
|
+
}
|
|
10
|
+
// Double-submit: the cookie token and the submitted (form field / header)
|
|
11
|
+
// token must match byte-for-byte under a constant-time compare.
|
|
12
|
+
export function verifyCsrfToken(cookieToken, submittedToken) {
|
|
13
|
+
if (cookieToken === null || submittedToken === null) {
|
|
14
|
+
return false;
|
|
15
|
+
}
|
|
16
|
+
const a = Buffer.from(cookieToken, "utf8");
|
|
17
|
+
const b = Buffer.from(submittedToken, "utf8");
|
|
18
|
+
// timingSafeEqual throws on length mismatch — length pre-check.
|
|
19
|
+
if (a.length !== b.length) {
|
|
20
|
+
return false;
|
|
21
|
+
}
|
|
22
|
+
return timingSafeEqual(a, b);
|
|
23
|
+
}
|
|
24
|
+
// Origin check for state-changing requests (the other CSRF half): the
|
|
25
|
+
// request's Origin header must appear verbatim in the allowlist.
|
|
26
|
+
export function verifyRequestOrigin(originHeader, allowedOrigins) {
|
|
27
|
+
if (originHeader === null) {
|
|
28
|
+
return false;
|
|
29
|
+
}
|
|
30
|
+
for (let i = 0; i < allowedOrigins.length; i++) {
|
|
31
|
+
if (allowedOrigins[i] === originHeader) {
|
|
32
|
+
return true;
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
return false;
|
|
36
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
export declare function toHex(bytes: Uint8Array): string;
|
|
2
|
+
export declare function b64urlEncode(bytes: Uint8Array): string;
|
|
3
|
+
export declare function b64urlDecode(text: string): Buffer;
|
|
4
|
+
export declare function base32Encode(bytes: Uint8Array): string;
|
|
5
|
+
export declare function base32Decode(text: string): Uint8Array | null;
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
// Byte <-> text helpers shared across the auth primitives.
|
|
2
|
+
//
|
|
3
|
+
// - Hex goes through a lookup table: `number.toString(16)` is SC2012-fenced
|
|
4
|
+
// under scriptc (probe finding from the hono/jwt attempt), and
|
|
5
|
+
// `Buffer.toString("hex")` on variable digests is avoided for the same
|
|
6
|
+
// class of reason — the table is deterministic.
|
|
7
|
+
// - base64url goes through Buffer (`Buffer.from(bytes).toString("base64url")`
|
|
8
|
+
// — probe-verified static in scriptc 0.3.3). Output is unpadded, which is
|
|
9
|
+
// what session tokens, PKCE challenges and JWS all require.
|
|
10
|
+
// - base32 is a 40-LoC RFC 4648 hand-roll (standard alphabet, no padding on
|
|
11
|
+
// encode, padding/lowercase tolerated on decode). It exists only for TOTP.
|
|
12
|
+
const HEX_DIGITS = "0123456789abcdef";
|
|
13
|
+
export function toHex(bytes) {
|
|
14
|
+
let out = "";
|
|
15
|
+
for (let i = 0; i < bytes.length; i++) {
|
|
16
|
+
const b = bytes[i];
|
|
17
|
+
out += HEX_DIGITS[b >>> 4] + HEX_DIGITS[b & 15];
|
|
18
|
+
}
|
|
19
|
+
return out;
|
|
20
|
+
}
|
|
21
|
+
export function b64urlEncode(bytes) {
|
|
22
|
+
return Buffer.from(bytes).toString("base64url");
|
|
23
|
+
}
|
|
24
|
+
export function b64urlDecode(text) {
|
|
25
|
+
return Buffer.from(text, "base64url");
|
|
26
|
+
}
|
|
27
|
+
const B32_ALPHABET = "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567";
|
|
28
|
+
// RFC 4648 base32, no padding emitted (otpauth secrets are unpadded).
|
|
29
|
+
export function base32Encode(bytes) {
|
|
30
|
+
let out = "";
|
|
31
|
+
let bits = 0;
|
|
32
|
+
let value = 0;
|
|
33
|
+
for (let i = 0; i < bytes.length; i++) {
|
|
34
|
+
value = (value << 8) | bytes[i];
|
|
35
|
+
bits += 8;
|
|
36
|
+
while (bits >= 5) {
|
|
37
|
+
out += B32_ALPHABET[(value >>> (bits - 5)) & 31];
|
|
38
|
+
bits -= 5;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
if (bits > 0) {
|
|
42
|
+
out += B32_ALPHABET[(value << (5 - bits)) & 31];
|
|
43
|
+
}
|
|
44
|
+
return out;
|
|
45
|
+
}
|
|
46
|
+
// Tolerates `=` padding and lowercase input; returns null on any character
|
|
47
|
+
// outside the RFC 4648 alphabet (null-on-invalid — this is attacker input
|
|
48
|
+
// when it comes from a stored secret or a user-typed key).
|
|
49
|
+
export function base32Decode(text) {
|
|
50
|
+
const upper = text.toUpperCase();
|
|
51
|
+
let bits = 0;
|
|
52
|
+
let value = 0;
|
|
53
|
+
const out = [];
|
|
54
|
+
for (let i = 0; i < upper.length; i++) {
|
|
55
|
+
const ch = upper[i];
|
|
56
|
+
if (ch === "=") {
|
|
57
|
+
break;
|
|
58
|
+
}
|
|
59
|
+
const idx = B32_ALPHABET.indexOf(ch);
|
|
60
|
+
if (idx < 0) {
|
|
61
|
+
return null;
|
|
62
|
+
}
|
|
63
|
+
value = (value << 5) | idx;
|
|
64
|
+
bits += 5;
|
|
65
|
+
if (bits >= 8) {
|
|
66
|
+
out.push((value >>> (bits - 8)) & 255);
|
|
67
|
+
bits -= 8;
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
return new Uint8Array(out);
|
|
71
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function authError(code: string, detail: string): Error;
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
// Code-string errors for caller bugs on the sign/exchange paths. Verify
|
|
2
|
+
// paths never throw — they return null/false — so these codes only fire for
|
|
3
|
+
// programmer error: missing key material, an alg the package does not sign,
|
|
4
|
+
// or malformed parameters.
|
|
5
|
+
export function authError(code, detail) {
|
|
6
|
+
return new Error(code + ": " + detail);
|
|
7
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
export { generateSessionToken, hashToken, createSession, validateSessionToken, invalidateSession, invalidateAllUserSessions, } from "./session.ts";
|
|
2
|
+
export type { SessionRecord, SessionRecordData, SessionStore, SessionStoreCore, SessionOpts, } from "./session.ts";
|
|
3
|
+
export { MemorySessionStore, MemorySessionStoreCore } from "./memory-store.ts";
|
|
4
|
+
export { serializeCookie, readCookie, buildSessionCookie, buildExpiredSessionCookie, buildCsrfCookie, SESSION_COOKIE_NAME, CSRF_COOKIE_NAME, } from "./cookie.ts";
|
|
5
|
+
export type { CookieAttrs, SessionCookieOpts } from "./cookie.ts";
|
|
6
|
+
export { hashPassword, verifyPassword } from "./password.ts";
|
|
7
|
+
export type { PasswordOpts } from "./password.ts";
|
|
8
|
+
export { generateCsrfToken, verifyCsrfToken, verifyRequestOrigin } from "./csrf.ts";
|
|
9
|
+
export { signJwt, verifyJwt, verifyJwtWith } from "./jwt.ts";
|
|
10
|
+
export type { SignJwtOpts, VerifyJwtOpts } from "./jwt.ts";
|
|
11
|
+
export { generateState, generateCodeVerifier, codeChallenge, createAuthorizationURL, exchangeCodeForTokens, fetchUserInfo, fetchUserInfoWith, } from "./oauth.ts";
|
|
12
|
+
export type { OAuthProvider, TokenSet, AuthorizeParams, ExchangeParams } from "./oauth.ts";
|
|
13
|
+
export { googleProvider, githubProvider, discordProvider } from "./providers.ts";
|
|
14
|
+
export { generateTotpSecret, totpAuthUri, verifyTotp } from "./totp.ts";
|
|
15
|
+
export type { TotpUriOpts, VerifyTotpOpts } from "./totp.ts";
|
|
16
|
+
export { base32Encode, base32Decode, toHex, b64urlEncode, b64urlDecode } from "./encoding.ts";
|
|
17
|
+
export { authError } from "./errors.ts";
|
|
18
|
+
export { runSchema } from "./types.ts";
|
|
19
|
+
export type { StandardSchemaV1, InferOutput } from "./types.ts";
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// @chttp/auth — public surface. Plain async functions over node:crypto:
|
|
2
|
+
// sessions (Lucia pattern), cookies, scrypt passwords, double-submit CSRF,
|
|
3
|
+
// HS256/ES256 JWT, OAuth2 authorization-code + PKCE, TOTP. Zero runtime
|
|
4
|
+
// dependencies; the schema seam is a local StandardSchemaV1 twin.
|
|
5
|
+
export { generateSessionToken, hashToken, createSession, validateSessionToken, invalidateSession, invalidateAllUserSessions, } from "./session.js";
|
|
6
|
+
export { MemorySessionStore, MemorySessionStoreCore } from "./memory-store.js";
|
|
7
|
+
export { serializeCookie, readCookie, buildSessionCookie, buildExpiredSessionCookie, buildCsrfCookie, SESSION_COOKIE_NAME, CSRF_COOKIE_NAME, } from "./cookie.js";
|
|
8
|
+
export { hashPassword, verifyPassword } from "./password.js";
|
|
9
|
+
export { generateCsrfToken, verifyCsrfToken, verifyRequestOrigin } from "./csrf.js";
|
|
10
|
+
export { signJwt, verifyJwt, verifyJwtWith } from "./jwt.js";
|
|
11
|
+
export { generateState, generateCodeVerifier, codeChallenge, createAuthorizationURL, exchangeCodeForTokens, fetchUserInfo, fetchUserInfoWith, } from "./oauth.js";
|
|
12
|
+
export { googleProvider, githubProvider, discordProvider } from "./providers.js";
|
|
13
|
+
export { generateTotpSecret, totpAuthUri, verifyTotp } from "./totp.js";
|
|
14
|
+
export { base32Encode, base32Decode, toHex, b64urlEncode, b64urlDecode } from "./encoding.js";
|
|
15
|
+
export { authError } from "./errors.js";
|
|
16
|
+
export { runSchema } from "./types.js";
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import type { KeyObject } from "node:crypto";
|
|
2
|
+
import type { StandardSchemaV1 } from "./types.ts";
|
|
3
|
+
export interface SignJwtOpts {
|
|
4
|
+
alg?: "HS256" | "ES256";
|
|
5
|
+
expiresInSeconds?: number;
|
|
6
|
+
issuer?: string;
|
|
7
|
+
audience?: string;
|
|
8
|
+
}
|
|
9
|
+
export interface VerifyJwtOpts {
|
|
10
|
+
alg?: "HS256" | "ES256";
|
|
11
|
+
issuer?: string;
|
|
12
|
+
audience?: string;
|
|
13
|
+
clockToleranceSeconds?: number;
|
|
14
|
+
}
|
|
15
|
+
export declare function signJwt(payload: {
|
|
16
|
+
[k: string]: unknown;
|
|
17
|
+
}, key: string | KeyObject, opts?: SignJwtOpts): string;
|
|
18
|
+
export declare function verifyJwt(token: string, key: string | KeyObject, opts?: VerifyJwtOpts): {
|
|
19
|
+
[k: string]: unknown;
|
|
20
|
+
} | null;
|
|
21
|
+
export declare function verifyJwtWith<Schema extends StandardSchemaV1>(token: string, key: string | KeyObject, schema: Schema, opts?: VerifyJwtOpts): Promise<StandardSchemaV1.InferOutput<Schema> | null>;
|