authfn 0.3.0 → 0.4.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/README.md +20 -0
- package/dist/core/api-keys.d.ts +2 -1
- package/dist/core/api-keys.d.ts.map +1 -1
- package/dist/core/api-keys.js +11 -8
- package/dist/core/api-keys.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,6 +10,26 @@ npm install authfn
|
|
|
10
10
|
|
|
11
11
|
Install only the plugin packages you use (`@authfn/password`, `@authfn/email-otp`, `@authfn/social-oauth`, `@authfn/api-keys`, `@authfn/two-factor`, `@authfn/multi-region`, `@authfn/native-handoff`) plus `@authfn/client` for browsers.
|
|
12
12
|
|
|
13
|
+
## 0.4.0 release
|
|
14
|
+
|
|
15
|
+
The core API key helper accepts `userId: null` to create an unowned key for a trusted service principal. Existing user-owned keys remain supported.
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { createApiKey } from 'authfn/core/api-keys';
|
|
19
|
+
|
|
20
|
+
const key = await createApiKey(
|
|
21
|
+
{ database, namespace: 'authfn' },
|
|
22
|
+
{
|
|
23
|
+
userId: null,
|
|
24
|
+
name: 'service-worker',
|
|
25
|
+
scopes: ['skills:read'],
|
|
26
|
+
metadata: { servicePrincipalId: 'service:worker' }
|
|
27
|
+
}
|
|
28
|
+
);
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Call this helper only from trusted server-side provisioning code. Cookie-session API key management remains user-owned; it does not list or revoke unowned service keys. Core-only publication does not update the existing `@authfn/*` packages' dependency pins.
|
|
32
|
+
|
|
13
33
|
## Two-stage API
|
|
14
34
|
|
|
15
35
|
Declare a side-effect-free app, then inject runtime dependencies:
|
package/dist/core/api-keys.d.ts
CHANGED
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import type { AuthFnApiKeyRecord, AuthFnRuntimeConfig, AuthFnSession } from '../types.js';
|
|
2
2
|
export interface CreateApiKeyInput {
|
|
3
|
-
|
|
3
|
+
/** Explicit null creates an unowned key for a trusted service principal. */
|
|
4
|
+
userId: string | null;
|
|
4
5
|
name: string;
|
|
5
6
|
scopes?: string[];
|
|
6
7
|
metadata?: Record<string, unknown>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../../src/core/api-keys.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAU1F,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"api-keys.d.ts","sourceRoot":"","sources":["../../src/core/api-keys.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAU1F,MAAM,WAAW,iBAAiB;IAChC,4EAA4E;IAC5E,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,kBAAkB,CAAC;CAC5B;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,UAAU,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;CACjB;AAED,wBAAsB,YAAY,CAChC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,WAAW,CAAC,EAC3D,KAAK,EAAE,iBAAiB,EACxB,OAAO,CAAC,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC;IAAC,YAAY,CAAC,EAAE,MAAM,CAAA;CAAE,GACpD,OAAO,CAAC,aAAa,CAAC,CAiDxB;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,WAAW,CAAC,EAC3D,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,EAAE,CAAC,CAY5B;AAED,wBAAsB,cAAc,CAClC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,WAAW,CAAC,EAC3D,KAAK,EAAE,MAAM,GACZ,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAMpC;AAED,wBAAsB,gBAAgB,CACpC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,WAAW,CAAC,EAC3D,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAA;CAAE,GAC9C,OAAO,CAAC,kBAAkB,CAAC,CAoB7B;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,UAAU,GAAG,WAAW,CAAC,EAC3D,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE;IAAE,GAAG,CAAC,EAAE,MAAM,IAAI,CAAA;CAAE,GAC7B,OAAO,CAAC,aAAa,GAAG,IAAI,CAAC,CAkD/B;AAED,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,kBAAkB,GAAG,eAAe,CAahF"}
|
package/dist/core/api-keys.js
CHANGED
|
@@ -6,14 +6,17 @@ import { findUserById } from './users.js';
|
|
|
6
6
|
export async function createApiKey(config, input, options) {
|
|
7
7
|
assertValidApiKeyName(input.name);
|
|
8
8
|
assertValidApiKeyExpiry(input.expiresAt);
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
9
|
+
let userId = input.userId;
|
|
10
|
+
if (userId !== null) {
|
|
11
|
+
const userIdLength = Array.from(userId).length;
|
|
12
|
+
assertAuthFnDatabaseKeyLength(userId, 'userId', AUTHFN_LEGACY_USER_REFERENCE_MAX_LENGTH);
|
|
13
|
+
const legacyUser = userIdLength > AUTHFN_DATABASE_KEY_MAX_LENGTH
|
|
14
|
+
? await findUserById(config, userId)
|
|
15
|
+
: null;
|
|
16
|
+
userId = legacyUser
|
|
17
|
+
? assertAuthFnDatabaseKeyLength(userId, 'userId', AUTHFN_LEGACY_USER_REFERENCE_MAX_LENGTH)
|
|
18
|
+
: assertAuthFnDatabaseKeyLength(userId, 'userId');
|
|
19
|
+
}
|
|
17
20
|
const now = options?.now?.() ?? new Date();
|
|
18
21
|
const secret = createApiKeySecret(options?.secretPrefix);
|
|
19
22
|
const record = {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api-keys.js","sourceRoot":"","sources":["../../src/core/api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACnG,OAAO,EACL,8BAA8B,EAC9B,uCAAuC,EACvC,6BAA6B,EAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"api-keys.js","sourceRoot":"","sources":["../../src/core/api-keys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAE1C,OAAO,EAAE,wBAAwB,EAAE,mBAAmB,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAC;AACnG,OAAO,EACL,8BAA8B,EAC9B,uCAAuC,EACvC,6BAA6B,EAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AA8B1C,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,MAA2D,EAC3D,KAAwB,EACxB,OAAqD;IAErD,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAClC,uBAAuB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IACzC,IAAI,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;IAC1B,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;QACpB,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC;QAC/C,6BAA6B,CAC3B,MAAM,EACN,QAAQ,EACR,uCAAuC,CACxC,CAAC;QACF,MAAM,UAAU,GAAG,YAAY,GAAG,8BAA8B;YAC9D,CAAC,CAAC,MAAM,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC;YACpC,CAAC,CAAC,IAAI,CAAC;QACT,MAAM,GAAG,UAAU;YACjB,CAAC,CAAC,6BAA6B,CAC3B,MAAM,EACN,QAAQ,EACR,uCAAuC,CACxC;YACH,CAAC,CAAC,6BAA6B,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,EAAE,GAAG,EAAE,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;IAC3C,MAAM,MAAM,GAAG,kBAAkB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACzD,MAAM,MAAM,GAAuB;QACjC,EAAE,EAAE,gBAAgB,CAAC,KAAK,CAAC;QAC3B,MAAM;QACN,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,UAAU,EAAE,UAAU,CAAC,MAAM,CAAC;QAC9B,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,QAAQ,EAAE,KAAK,CAAC,QAAQ;QACxB,SAAS,EAAE,KAAK,CAAC,SAAS,IAAI,IAAI;QAClC,SAAS,EAAE,IAAI;QACf,UAAU,EAAE,IAAI;QAChB,SAAS,EAAE,GAAG;QACd,SAAS,EAAE,GAAG;KACf,CAAC;IAEF,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAqB;QAC/C,KAAK,EAAE,UAAU;QACjB,IAAI,EAAE,MAAM;QACZ,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;IAEH,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,EAAE;QAChB,MAAM;QACN,MAAM;KACP,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAA2D,EAC3D,MAAc;IAEd,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAqB;QACjE,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAC3D,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,KAAK,EAAE;YACxC,EAAE,KAAK,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;SAClC;QACD,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;IAEH,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,MAA2D,EAC3D,KAAa;IAEb,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAqB;QACjD,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QACtD,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,MAA2D,EAC3D,KAAa,EACb,OAA+C;IAE/C,MAAM,MAAM,GAAG,MAAM,cAAc,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACnD,IAAI,CAAC,MAAM,IAAI,CAAC,OAAO,EAAE,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACrE,MAAM,IAAI,mBAAmB,CAAC,mBAAmB,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAChE,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,SAAS,GAAG,OAAO,EAAE,GAAG,EAAE,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;IACjD,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAqB;QAChD,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;QACtD,IAAI,EAAE;YACJ,SAAS;YACT,SAAS,EAAE,SAAS;SACrB;QACD,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,kBAAkB,CACtC,MAA2D,EAC3D,MAAc,EACd,OAA8B;IAE9B,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAqB;QAC/D,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3E,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;IAEH,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,MAAM,IAAI,wBAAwB,CAAC,0BAA0B,EAAE;YAC7D,KAAK,EAAE,MAAM,CAAC,EAAE;SACjB,CAAC,CAAC;IACL,CAAC;IAED,MAAM,GAAG,GAAG,OAAO,EAAE,GAAG,EAAE,EAAE,IAAI,IAAI,IAAI,EAAE,CAAC;IAC3C,IAAI,MAAM,CAAC,SAAS,IAAI,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,IAAI,GAAG,CAAC,OAAO,EAAE,EAAE,CAAC;QACpE,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAqB;QACrE,KAAK,EAAE,UAAU;QACjB,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC;QAC1D,IAAI,EAAE;YACJ,UAAU,EAAE,GAAG;YACf,SAAS,EAAE,GAAG;SACf;QACD,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC;KAC7B,CAAC,CAAC;IAEH,OAAO;QACL,EAAE,EAAE,aAAa,CAAC,EAAE;QACpB,IAAI,EAAE,SAAS;QACf,OAAO,EAAE;YACP,OAAO,EAAE,aAAa,CAAC,EAAE;YACzB,SAAS,EAAE,SAAS;SACrB;QACD,SAAS,EAAE,SAAS;QACpB,OAAO,EAAE,aAAa,CAAC,EAAE;QACzB,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,CAAC,SAAS,CAAC;QACpB,SAAS,EAAE,aAAa,CAAC,SAAS,IAAI,SAAS;QAC/C,QAAQ,EAAE;YACR,GAAG,CAAC,aAAa,CAAC,QAAQ,IAAI,EAAE,CAAC;YACjC,WAAW,EAAE,aAAa,CAAC,MAAM,IAAI,SAAS;YAC9C,MAAM,EAAE,aAAa,CAAC,MAAM,IAAI,EAAE;SACnC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,MAA0B;IAC7D,OAAO;QACL,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI;QACnC,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,IAAI;QACnC,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,IAAI;QACrC,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,SAAS,EAAE,MAAM,CAAC,SAAS;KAC5B,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,SAAiB,IAAI;IAC/C,OAAO,GAAG,MAAM,IAAI,WAAW,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE,CAAC;AAC9D,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAc;IACtC,OAAO,GAAG,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;AACvD,CAAC;AAED,SAAS,SAAS,CAAC,MAA8C;IAC/D,OAAO,MAAM,CAAC,SAAS,IAAI,QAAQ,CAAC;AACtC,CAAC;AAED,SAAS,qBAAqB,CAAC,IAAY;IACzC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,qBAAqB,CAAC,0BAA0B,EAAE;YAC1D,KAAK,EAAE,MAAM;SACd,CAAC,CAAC;IACL,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC9C,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QAChB,MAAM,IAAI,qBAAqB,CAAC,+CAA+C,EAAE;YAC/E,KAAK,EAAE,MAAM;YACb,QAAQ,EAAE,GAAG;YACb,aAAa,EAAE,KAAK;SACrB,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,SAA2B;IAC1D,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;IACT,CAAC;IAED,IAAI,CAAC,CAAC,SAAS,YAAY,IAAI,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,EAAE,CAAC;QACtE,MAAM,IAAI,qBAAqB,CAAC,qCAAqC,EAAE;YACrE,KAAK,EAAE,WAAW;SACnB,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}
|