@keycardai/oauth 0.26.6 → 0.27.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.
Files changed (100) hide show
  1. package/README.md +66 -1
  2. package/dist/cjs/basicAuthorization.d.ts +11 -0
  3. package/dist/cjs/basicAuthorization.d.ts.map +1 -0
  4. package/dist/cjs/basicAuthorization.js +16 -0
  5. package/dist/cjs/basicAuthorization.js.map +1 -0
  6. package/dist/cjs/clientCredentials.d.ts.map +1 -1
  7. package/dist/cjs/clientCredentials.js +2 -2
  8. package/dist/cjs/clientCredentials.js.map +1 -1
  9. package/dist/cjs/credentials.d.ts +35 -0
  10. package/dist/cjs/credentials.d.ts.map +1 -1
  11. package/dist/cjs/credentials.js +19 -0
  12. package/dist/cjs/credentials.js.map +1 -1
  13. package/dist/cjs/deviceAuthorization.d.ts +166 -0
  14. package/dist/cjs/deviceAuthorization.d.ts.map +1 -0
  15. package/dist/cjs/deviceAuthorization.js +440 -0
  16. package/dist/cjs/deviceAuthorization.js.map +1 -0
  17. package/dist/cjs/discovery.d.ts +1 -0
  18. package/dist/cjs/discovery.d.ts.map +1 -1
  19. package/dist/cjs/discovery.js +5 -1
  20. package/dist/cjs/discovery.js.map +1 -1
  21. package/dist/cjs/errors.d.ts +61 -3
  22. package/dist/cjs/errors.d.ts.map +1 -1
  23. package/dist/cjs/errors.js +75 -4
  24. package/dist/cjs/errors.js.map +1 -1
  25. package/dist/cjs/index.d.ts +6 -3
  26. package/dist/cjs/index.d.ts.map +1 -1
  27. package/dist/cjs/index.js +13 -1
  28. package/dist/cjs/index.js.map +1 -1
  29. package/dist/cjs/pkce.d.ts.map +1 -1
  30. package/dist/cjs/pkce.js +6 -2
  31. package/dist/cjs/pkce.js.map +1 -1
  32. package/dist/cjs/server/clientSecret.d.ts +7 -1
  33. package/dist/cjs/server/clientSecret.d.ts.map +1 -1
  34. package/dist/cjs/server/clientSecret.js +17 -0
  35. package/dist/cjs/server/clientSecret.js.map +1 -1
  36. package/dist/cjs/server/webIdentity.d.ts +11 -1
  37. package/dist/cjs/server/webIdentity.d.ts.map +1 -1
  38. package/dist/cjs/server/webIdentity.js +35 -2
  39. package/dist/cjs/server/webIdentity.js.map +1 -1
  40. package/dist/cjs/server/workloadIdentity.d.ts +8 -1
  41. package/dist/cjs/server/workloadIdentity.d.ts.map +1 -1
  42. package/dist/cjs/server/workloadIdentity.js +15 -0
  43. package/dist/cjs/server/workloadIdentity.js.map +1 -1
  44. package/dist/cjs/tokenExchange.d.ts.map +1 -1
  45. package/dist/cjs/tokenExchange.js +2 -2
  46. package/dist/cjs/tokenExchange.js.map +1 -1
  47. package/dist/cjs/webApp.d.ts +35 -15
  48. package/dist/cjs/webApp.d.ts.map +1 -1
  49. package/dist/cjs/webApp.js +39 -11
  50. package/dist/cjs/webApp.js.map +1 -1
  51. package/dist/esm/basicAuthorization.d.ts +11 -0
  52. package/dist/esm/basicAuthorization.d.ts.map +1 -0
  53. package/dist/esm/basicAuthorization.js +13 -0
  54. package/dist/esm/basicAuthorization.js.map +1 -0
  55. package/dist/esm/clientCredentials.d.ts.map +1 -1
  56. package/dist/esm/clientCredentials.js +2 -2
  57. package/dist/esm/clientCredentials.js.map +1 -1
  58. package/dist/esm/credentials.d.ts +35 -0
  59. package/dist/esm/credentials.d.ts.map +1 -1
  60. package/dist/esm/credentials.js +17 -1
  61. package/dist/esm/credentials.js.map +1 -1
  62. package/dist/esm/deviceAuthorization.d.ts +166 -0
  63. package/dist/esm/deviceAuthorization.d.ts.map +1 -0
  64. package/dist/esm/deviceAuthorization.js +434 -0
  65. package/dist/esm/deviceAuthorization.js.map +1 -0
  66. package/dist/esm/discovery.d.ts +1 -0
  67. package/dist/esm/discovery.d.ts.map +1 -1
  68. package/dist/esm/discovery.js +5 -1
  69. package/dist/esm/discovery.js.map +1 -1
  70. package/dist/esm/errors.d.ts +61 -3
  71. package/dist/esm/errors.d.ts.map +1 -1
  72. package/dist/esm/errors.js +71 -3
  73. package/dist/esm/errors.js.map +1 -1
  74. package/dist/esm/index.d.ts +6 -3
  75. package/dist/esm/index.d.ts.map +1 -1
  76. package/dist/esm/index.js +3 -1
  77. package/dist/esm/index.js.map +1 -1
  78. package/dist/esm/pkce.d.ts.map +1 -1
  79. package/dist/esm/pkce.js +6 -2
  80. package/dist/esm/pkce.js.map +1 -1
  81. package/dist/esm/server/clientSecret.d.ts +7 -1
  82. package/dist/esm/server/clientSecret.d.ts.map +1 -1
  83. package/dist/esm/server/clientSecret.js +17 -0
  84. package/dist/esm/server/clientSecret.js.map +1 -1
  85. package/dist/esm/server/webIdentity.d.ts +11 -1
  86. package/dist/esm/server/webIdentity.d.ts.map +1 -1
  87. package/dist/esm/server/webIdentity.js +35 -2
  88. package/dist/esm/server/webIdentity.js.map +1 -1
  89. package/dist/esm/server/workloadIdentity.d.ts +8 -1
  90. package/dist/esm/server/workloadIdentity.d.ts.map +1 -1
  91. package/dist/esm/server/workloadIdentity.js +15 -0
  92. package/dist/esm/server/workloadIdentity.js.map +1 -1
  93. package/dist/esm/tokenExchange.d.ts.map +1 -1
  94. package/dist/esm/tokenExchange.js +2 -2
  95. package/dist/esm/tokenExchange.js.map +1 -1
  96. package/dist/esm/webApp.d.ts +35 -15
  97. package/dist/esm/webApp.d.ts.map +1 -1
  98. package/dist/esm/webApp.js +39 -11
  99. package/dist/esm/webApp.js.map +1 -1
  100. package/package.json +6 -1
package/README.md CHANGED
@@ -222,6 +222,56 @@ code at authorize time, so completion sends no `resource` parameter. A callback
222
222
  carrying `error` throws `AuthorizationDeniedError` and a missing or non-matching
223
223
  `state` throws `StateMismatchError`, both before any token request.
224
224
 
225
+ ### Device Authorization Grant (RFC 8628)
226
+
227
+ For a process with no browser and no redirect URI, such as a headless agent
228
+ host. The device asks the zone for a user code, shows it to a person, and polls
229
+ until the person approves or denies.
230
+
231
+ ```typescript
232
+ import { fetchAuthorizationServerMetadata } from "@keycardai/oauth/discovery";
233
+ import { requestDeviceAuthorization, waitForDeviceToken } from "@keycardai/oauth/deviceAuthorization";
234
+ import { DevicePollError } from "@keycardai/oauth/errors";
235
+ import { WorkloadIdentity, FileTokenSource } from "@keycardai/oauth/server";
236
+ import type { TokenResponse } from "@keycardai/oauth/tokenExchange";
237
+
238
+ const issuer = "https://your-zone.keycard.cloud";
239
+ const credential = new WorkloadIdentity(new FileTokenSource(), { clientId: "my-client" });
240
+ const metadata = await fetchAuthorizationServerMetadata(issuer);
241
+
242
+ const authorization = await requestDeviceAuthorization(issuer, {
243
+ credential, // or `clientId` for a public client
244
+ metadata,
245
+ scopes: ["openid"],
246
+ resources: ["https://api.example.com"],
247
+ });
248
+ console.log(`Visit ${authorization.verificationUriComplete ?? authorization.verificationUri}`);
249
+ console.log(`and confirm the code ${authorization.userCode}`);
250
+
251
+ let tokens: TokenResponse | undefined;
252
+ let interval: number | undefined;
253
+ while (!tokens) {
254
+ try {
255
+ tokens = await waitForDeviceToken(issuer, { credential, metadata, authorization, interval });
256
+ } catch (error) {
257
+ if (!(error instanceof DevicePollError)) throw error;
258
+ interval = error.interval;
259
+ }
260
+ }
261
+ ```
262
+
263
+ The doc comment on `waitForDeviceToken` lists the poll loop rules and when it
264
+ throws `DevicePollError`. The loop above resumes it after that error.
265
+ `DeviceAuthorization` is a plain value, so you can persist it and poll from
266
+ another process that authenticates as the same client. `pollDeviceToken` polls
267
+ once. Pass `metadata` so it does not discover on every poll. If you call it in
268
+ your own loop, wait longer after a timeout or other network error
269
+ (RFC 8628 §3.5).
270
+
271
+ When the request names more than one resource, the token is not for any one of
272
+ them. To get a token for one resource, call `refreshAuthorization` with
273
+ `resources` set to it and the same `credential`.
274
+
225
275
  ### UserInfo (OIDC Core 1.0 §5.3)
226
276
 
227
277
  ```typescript
@@ -276,6 +326,17 @@ issuer's `userinfo_endpoint`. Pass `{ metadata }` to skip discovery.
276
326
  | `beginAuthorization` | `@keycardai/oauth/webApp` | Web-app flow: builds the authorize URL and returns `{ url, state, codeVerifier, resources }` |
277
327
  | `completeAuthorization` | `@keycardai/oauth/webApp` | Web-app flow: validates the callback and exchanges the code |
278
328
  | `AuthorizationRedirect` (type) | `@keycardai/oauth/webApp` | Begin-step result the application stores until the callback |
329
+ | `refreshAuthorization` | `@keycardai/oauth/webApp` | Renews a grant with its `refresh_token`, as a public client, with a client secret, or with a `credential` |
330
+
331
+ ### Device Authorization Grant (RFC 8628)
332
+
333
+ | Export | Import Path | Description |
334
+ |---|---|---|
335
+ | `requestDeviceAuthorization` | `@keycardai/oauth/deviceAuthorization` | Asks the zone for a device code and a user code |
336
+ | `pollDeviceToken` | `@keycardai/oauth/deviceAuthorization` | Polls the token endpoint once |
337
+ | `waitForDeviceToken` | `@keycardai/oauth/deviceAuthorization` | Polls until the person approves or denies, per RFC 8628 §3.5 |
338
+ | `DeviceAuthorization` (type) | `@keycardai/oauth/deviceAuthorization` | The device authorization response, with `expiresAt` computed from the clock |
339
+ | `Clock` (type), `systemClock` | `@keycardai/oauth/deviceAuthorization` | Time source and timer; inject a fake in tests |
279
340
 
280
341
  ### UserInfo (OIDC Core 1.0)
281
342
 
@@ -297,7 +358,8 @@ issuer's `userinfo_endpoint`. Pass `{ metadata }` to skip discovery.
297
358
  | `GCPMetadataTokenSource` | `@keycardai/oauth/server` | Token source for the GCP metadata server (GKE, GCE, Cloud Run) |
298
359
  | `FlyTokenSource` | `@keycardai/oauth/server` | Token source for the Fly.io Machines API Unix socket. **Node.js only** |
299
360
  | `EKSWorkloadIdentity` | `@keycardai/oauth/server` | Deprecated: `WorkloadIdentity` with a `FileTokenSource` limited to EKS env discovery |
300
- | `ApplicationCredential` (type) | `@keycardai/oauth/credentials` | Interface for credential providers |
361
+ | `ApplicationCredential` (type) | `@keycardai/oauth/credentials` | Interface for credential providers. The optional `clientAuthentication(issuer, endpoint)` returns the headers and form fields that authenticate one request. The optional `checkClientAuthentication()` throws `ConfigurationError` before any request when the credential cannot do so |
362
+ | `providesClientAuthentication` | `@keycardai/oauth/credentials` | Reports whether a credential provides `clientAuthentication` |
301
363
 
302
364
  ### Errors
303
365
 
@@ -313,6 +375,9 @@ issuer's `userinfo_endpoint`. Pass `{ metadata }` to skip discovery.
313
375
  | `AuthProviderConfigurationError` | `@keycardai/oauth/errors` | Configuration guard for auth providers |
314
376
  | `AuthorizationDeniedError` | `@keycardai/oauth/errors` | Web-app callback carried an OAuth `error` (e.g. `access_denied`) |
315
377
  | `StateMismatchError` | `@keycardai/oauth/errors` | Web-app callback `state` is absent or does not match the stored value |
378
+ | `DeviceGrantError` | `@keycardai/oauth/errors` | Device grant failure, with `errorCode`, `errorDescription`, `status`, and `retryable` |
379
+ | `DevicePollError` | `@keycardai/oauth/errors` | `waitForDeviceToken` stopped on a network error, 5xx, or 429; has `interval` and the original failure as `cause` |
380
+ | `PERMANENT_ERROR_CODES`, `isPermanentErrorCode` | `@keycardai/oauth/errors` | OAuth error codes that are not retryable, except on HTTP 429 or 5xx; classifies a bare error code |
316
381
 
317
382
  ### Utilities
318
383
 
@@ -0,0 +1,11 @@
1
+ /**
2
+ * The HTTP Basic `Authorization` header value that authenticates a client
3
+ * (RFC 6749 §2.3.1). The client ID and secret are each encoded with
4
+ * `encodeURIComponent` before base64. Letters, digits and `-_.!~*'()` are
5
+ * kept. Every other byte of the UTF-8 encoding becomes `%HH`, and a space
6
+ * becomes `%20`. Each half decodes to the original value with an RFC 6749
7
+ * Appendix B form decoder, and with the `decodeURIComponent` that Keycard
8
+ * zones use.
9
+ */
10
+ export declare function basicAuthorization(clientId: string, clientSecret: string): string;
11
+ //# sourceMappingURL=basicAuthorization.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"basicAuthorization.d.ts","sourceRoot":"","sources":["../../src/basicAuthorization.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAEjF"}
@@ -0,0 +1,16 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.basicAuthorization = basicAuthorization;
4
+ /**
5
+ * The HTTP Basic `Authorization` header value that authenticates a client
6
+ * (RFC 6749 §2.3.1). The client ID and secret are each encoded with
7
+ * `encodeURIComponent` before base64. Letters, digits and `-_.!~*'()` are
8
+ * kept. Every other byte of the UTF-8 encoding becomes `%HH`, and a space
9
+ * becomes `%20`. Each half decodes to the original value with an RFC 6749
10
+ * Appendix B form decoder, and with the `decodeURIComponent` that Keycard
11
+ * zones use.
12
+ */
13
+ function basicAuthorization(clientId, clientSecret) {
14
+ return `Basic ${btoa(`${encodeURIComponent(clientId)}:${encodeURIComponent(clientSecret)}`)}`;
15
+ }
16
+ //# sourceMappingURL=basicAuthorization.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"basicAuthorization.js","sourceRoot":"","sources":["../../src/basicAuthorization.ts"],"names":[],"mappings":";;AASA,gDAEC;AAXD;;;;;;;;GAQG;AACH,SAAgB,kBAAkB,CAAC,QAAgB,EAAE,YAAoB;IACvE,OAAO,SAAS,IAAI,CAAC,GAAG,kBAAkB,CAAC,QAAQ,CAAC,IAAI,kBAAkB,CAAC,YAAY,CAAC,EAAE,CAAC,EAAE,CAAC;AAChG,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"clientCredentials.d.ts","sourceRoot":"","sources":["../../src/clientCredentials.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAmD,KAAK,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AACrH,OAAO,EAA4B,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAMlF,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,8BAA+B,SAAQ,yBAAyB;IAC/E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAwBD,qBAAa,uBAAuB;;gBAQtB,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,8BAA8B;IAS9D,YAAY,CAChB,OAAO,CAAC,EAAE,wBAAwB,EAClC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,aAAa,CAAC;IA4DzB;;;;;OAKG;IACG,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;CAG1C"}
1
+ {"version":3,"file":"clientCredentials.d.ts","sourceRoot":"","sources":["../../src/clientCredentials.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,EAAmD,KAAK,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AACrH,OAAO,EAA4B,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAMlF,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,8BAA+B,SAAQ,yBAAyB;IAC/E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC;IACnC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,mBAAmB;IAClC,2DAA2D;IAC3D,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAwBD,qBAAa,uBAAuB;;gBAQtB,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,8BAA8B;IAS9D,YAAY,CAChB,OAAO,CAAC,EAAE,wBAAwB,EAClC,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,aAAa,CAAC;IA2DzB;;;;;OAKG;IACG,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;CAG1C"}
@@ -14,6 +14,7 @@ var _ClientCredentialsClient_instances, _ClientCredentialsClient_issuer, _Client
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
15
  exports.ClientCredentialsClient = void 0;
16
16
  const errors_js_1 = require("./errors.js");
17
+ const basicAuthorization_js_1 = require("./basicAuthorization.js");
17
18
  const tokenEndpoint_js_1 = require("./tokenEndpoint.js");
18
19
  const tokenExchange_js_1 = require("./tokenExchange.js");
19
20
  // =============================================================================
@@ -61,8 +62,7 @@ class ClientCredentialsClient {
61
62
  };
62
63
  const basicAuth = __classPrivateFieldGet(this, _ClientCredentialsClient_instances, "m", _ClientCredentialsClient_resolveBasicAuth).call(this, options?.issuer);
63
64
  if (basicAuth) {
64
- const credentials = btoa(`${basicAuth.clientId}:${basicAuth.clientSecret}`);
65
- headers["Authorization"] = `Basic ${credentials}`;
65
+ headers["Authorization"] = (0, basicAuthorization_js_1.basicAuthorization)(basicAuth.clientId, basicAuth.clientSecret);
66
66
  }
67
67
  const response = await fetch(tokenEndpoint, {
68
68
  method: "POST",
@@ -1 +1 @@
1
- {"version":3,"file":"clientCredentials.js","sourceRoot":"","sources":["../../src/clientCredentials.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAyC;AAEzC,yDAAqH;AACrH,yDAAkF;AAyClF,gFAAgF;AAChF,iEAAiE;AACjE,gFAAgF;AAEhF,SAAS,gBAAgB,CAAC,OAAiC;IACzD,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IAErC,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;IAE/C,IAAI,OAAO,CAAC,QAAQ;QAAE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC/D,IAAI,OAAO,CAAC,KAAK;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,OAAO,CAAC,eAAe;QAAE,MAAM,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IACrF,IAAI,OAAO,CAAC,mBAAmB;QAAE,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAClG,IAAI,OAAO,CAAC,QAAQ;QAAE,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEhE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,gFAAgF;AAChF,4BAA4B;AAC5B,gFAAgF;AAEhF,MAAa,uBAAuB;IAQlC,YAAY,MAAc,EAAE,OAAwC;;QAPpE,kDAAgB;QAChB,oDAAmB;QACnB,wDAAuB;QACvB,sDAAoC;QACpC,yDAAsC;QACtC,0DAAwB;QAGtB,uBAAA,IAAI,mCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,qCAAa,OAAO,EAAE,QAAQ,MAAA,CAAC;QACnC,uBAAA,IAAI,yCAAiB,OAAO,EAAE,YAAY,MAAA,CAAC;QAC3C,uBAAA,IAAI,uCAAe,OAAO,EAAE,UAAU,MAAA,CAAC;QACvC,uBAAA,IAAI,2CAAmB,OAAO,EAAE,cAAc,IAAI,2CAAwB,MAAA,CAAC;QAC3E,uBAAA,IAAI,0CAAkB,IAAI,wCAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,MAAA,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,OAAkC,EAClC,OAA6B;QAE7B,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,8CAAe,CAAC,OAAO,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QAE7C,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,mCAAmC;SACpD,CAAC;QAEF,MAAM,SAAS,GAAG,uBAAA,IAAI,qFAAkB,MAAtB,IAAI,EAAmB,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,SAAS,CAAC,QAAQ,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC,CAAC;YAC5E,OAAO,CAAC,eAAe,CAAC,GAAG,SAAS,WAAW,EAAE,CAAC;QACpD,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,aAAa,EAAE;YAC1C,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;YACrB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,uBAAA,IAAI,+CAAgB,CAAC;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA6B,CAAC;gBACnE,IAAI,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACxC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC;oBAClC,MAAM,WAAW,GAAG,OAAO,SAAS,CAAC,iBAAiB,KAAK,QAAQ;wBACjE,CAAC,CAAC,SAAS,CAAC,iBAAiB;wBAC7B,CAAC,CAAC,SAAS,CAAC;oBACd,MAAM,QAAQ,GAAG,OAAO,SAAS,CAAC,SAAS,KAAK,QAAQ;wBACtD,CAAC,CAAC,SAAS,CAAC,SAAS;wBACrB,CAAC,CAAC,SAAS,CAAC;oBACd,MAAM,IAAI,sBAAU,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;gBACzD,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,YAAY,sBAAU;oBAAE,MAAM,CAAC,CAAC;gBACrC,2CAA2C;YAC7C,CAAC;YACD,MAAM,IAAI,sBAAU,CAClB,kBAAkB,EAClB,2CAA2C,QAAQ,CAAC,MAAM,GAAG,CAC9D,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA6B,CAAC;QAC9D,OAAO,IAAA,2CAAwB,EAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAcD;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,uBAAA,IAAI,8CAAe,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;CACF;AAzFD,0DAyFC;odApBG,MAA0B;IAE1B,IAAI,uBAAA,IAAI,2CAAY,EAAE,CAAC;QACrB,OAAO,uBAAA,IAAI,2CAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IACD,IAAI,uBAAA,IAAI,yCAAU,IAAI,uBAAA,IAAI,6CAAc,EAAE,CAAC;QACzC,OAAO,EAAE,QAAQ,EAAE,uBAAA,IAAI,yCAAU,EAAE,YAAY,EAAE,uBAAA,IAAI,6CAAc,EAAE,CAAC;IACxE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
1
+ {"version":3,"file":"clientCredentials.js","sourceRoot":"","sources":["../../src/clientCredentials.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,2CAAyC;AAEzC,mEAA6D;AAC7D,yDAAqH;AACrH,yDAAkF;AAyClF,gFAAgF;AAChF,iEAAiE;AACjE,gFAAgF;AAEhF,SAAS,gBAAgB,CAAC,OAAiC;IACzD,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;IAErC,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,oBAAoB,CAAC,CAAC;IAE/C,IAAI,OAAO,CAAC,QAAQ;QAAE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC/D,IAAI,OAAO,CAAC,KAAK;QAAE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACtD,IAAI,OAAO,CAAC,eAAe;QAAE,MAAM,CAAC,GAAG,CAAC,kBAAkB,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;IACrF,IAAI,OAAO,CAAC,mBAAmB;QAAE,MAAM,CAAC,GAAG,CAAC,uBAAuB,EAAE,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAClG,IAAI,OAAO,CAAC,QAAQ;QAAE,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEhE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,gFAAgF;AAChF,4BAA4B;AAC5B,gFAAgF;AAEhF,MAAa,uBAAuB;IAQlC,YAAY,MAAc,EAAE,OAAwC;;QAPpE,kDAAgB;QAChB,oDAAmB;QACnB,wDAAuB;QACvB,sDAAoC;QACpC,yDAAsC;QACtC,0DAAwB;QAGtB,uBAAA,IAAI,mCAAW,MAAM,MAAA,CAAC;QACtB,uBAAA,IAAI,qCAAa,OAAO,EAAE,QAAQ,MAAA,CAAC;QACnC,uBAAA,IAAI,yCAAiB,OAAO,EAAE,YAAY,MAAA,CAAC;QAC3C,uBAAA,IAAI,uCAAe,OAAO,EAAE,UAAU,MAAA,CAAC;QACvC,uBAAA,IAAI,2CAAmB,OAAO,EAAE,cAAc,IAAI,2CAAwB,MAAA,CAAC;QAC3E,uBAAA,IAAI,0CAAkB,IAAI,wCAAqB,CAAC,MAAM,EAAE,OAAO,CAAC,MAAA,CAAC;IACnE,CAAC;IAED,KAAK,CAAC,YAAY,CAChB,OAAkC,EAClC,OAA6B;QAE7B,MAAM,aAAa,GAAG,MAAM,uBAAA,IAAI,8CAAe,CAAC,OAAO,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAG,gBAAgB,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC;QAE7C,MAAM,OAAO,GAA2B;YACtC,cAAc,EAAE,mCAAmC;SACpD,CAAC;QAEF,MAAM,SAAS,GAAG,uBAAA,IAAI,qFAAkB,MAAtB,IAAI,EAAmB,OAAO,EAAE,MAAM,CAAC,CAAC;QAC1D,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,CAAC,eAAe,CAAC,GAAG,IAAA,0CAAkB,EAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,CAAC,YAAY,CAAC,CAAC;QAC5F,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,aAAa,EAAE;YAC1C,MAAM,EAAE,MAAM;YACd,OAAO;YACP,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE;YACrB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,uBAAA,IAAI,+CAAgB,CAAC;SAClD,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,CAAC;gBACH,MAAM,SAAS,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA6B,CAAC;gBACnE,IAAI,OAAO,SAAS,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;oBACxC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC;oBAClC,MAAM,WAAW,GAAG,OAAO,SAAS,CAAC,iBAAiB,KAAK,QAAQ;wBACjE,CAAC,CAAC,SAAS,CAAC,iBAAiB;wBAC7B,CAAC,CAAC,SAAS,CAAC;oBACd,MAAM,QAAQ,GAAG,OAAO,SAAS,CAAC,SAAS,KAAK,QAAQ;wBACtD,CAAC,CAAC,SAAS,CAAC,SAAS;wBACrB,CAAC,CAAC,SAAS,CAAC;oBACd,MAAM,IAAI,sBAAU,CAAC,SAAS,EAAE,WAAW,EAAE,QAAQ,CAAC,CAAC;gBACzD,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,IAAI,CAAC,YAAY,sBAAU;oBAAE,MAAM,CAAC,CAAC;gBACrC,2CAA2C;YAC7C,CAAC;YACD,MAAM,IAAI,sBAAU,CAClB,kBAAkB,EAClB,2CAA2C,QAAQ,CAAC,MAAM,GAAG,CAC9D,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAA6B,CAAC;QAC9D,OAAO,IAAA,2CAAwB,EAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IAcD;;;;;OAKG;IACH,KAAK,CAAC,gBAAgB;QACpB,OAAO,uBAAA,IAAI,8CAAe,CAAC,OAAO,EAAE,CAAC;IACvC,CAAC;CACF;AAxFD,0DAwFC;odApBG,MAA0B;IAE1B,IAAI,uBAAA,IAAI,2CAAY,EAAE,CAAC;QACrB,OAAO,uBAAA,IAAI,2CAAY,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IACD,IAAI,uBAAA,IAAI,yCAAU,IAAI,uBAAA,IAAI,6CAAc,EAAE,CAAC;QACzC,OAAO,EAAE,QAAQ,EAAE,uBAAA,IAAI,yCAAU,EAAE,YAAY,EAAE,uBAAA,IAAI,6CAAc,EAAE,CAAC;IACxE,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC"}
@@ -1,4 +1,15 @@
1
1
  import type { TokenExchangeRequest } from "./tokenExchange.js";
2
+ /**
3
+ * The headers and form fields that authenticate the client on one request to
4
+ * the authorization server. Keys are wire names, such as `Authorization` or
5
+ * `client_assertion`. It never includes a grant parameter such as
6
+ * `grant_type` or `subject_token_type`. The caller merges it into its own
7
+ * request.
8
+ */
9
+ export interface ClientAuthentication {
10
+ headers: Record<string, string>;
11
+ form: Record<string, string>;
12
+ }
2
13
  /**
3
14
  * Common interface for application-level credentials used in token exchange.
4
15
  *
@@ -19,5 +30,29 @@ export interface ApplicationCredential {
19
30
  authInfo?: Record<string, string>;
20
31
  issuer?: string;
21
32
  }): Promise<TokenExchangeRequest>;
33
+ /**
34
+ * Returns the client authentication for one request to `endpoint` on the
35
+ * zone `issuer`. Optional. Operations that need it throw
36
+ * `ConfigurationError` before any request when it is missing. Call it once
37
+ * per request: assertion-based credentials sign or fetch a new assertion on
38
+ * every call.
39
+ */
40
+ clientAuthentication?(issuer: string, endpoint: string): Promise<ClientAuthentication>;
41
+ /**
42
+ * Throws `ConfigurationError` when the credential's configuration does not
43
+ * allow `clientAuthentication`, such as a `WebIdentity` without `clientId`.
44
+ * Optional.
45
+ */
46
+ checkClientAuthentication?(): void;
22
47
  }
48
+ /** An `ApplicationCredential` that provides `clientAuthentication`. */
49
+ export type ClientAuthenticator = ApplicationCredential & Required<Pick<ApplicationCredential, "clientAuthentication">>;
50
+ /** Reports whether `credential` provides `clientAuthentication`. */
51
+ export declare function providesClientAuthentication(credential: ApplicationCredential): credential is ClientAuthenticator;
52
+ /**
53
+ * Returns `credential` when it provides `clientAuthentication` and its
54
+ * `checkClientAuthentication` passes. Throws `ConfigurationError` otherwise.
55
+ * Call it before sending any request, including discovery.
56
+ */
57
+ export declare function requireClientAuthentication(credential: ApplicationCredential, operation: string): ClientAuthenticator;
23
58
  //# sourceMappingURL=credentials.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../../src/credentials.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE/D;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC5E,2BAA2B,CACzB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GACvF,OAAO,CAAC,oBAAoB,CAAC,CAAC;CAClC"}
1
+ {"version":3,"file":"credentials.d.ts","sourceRoot":"","sources":["../../src/credentials.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAE/D;;;;;;GAMG;AACH,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC9B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IACpC,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI,CAAC;IAC5E,2BAA2B,CACzB,YAAY,EAAE,MAAM,EACpB,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GACvF,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACjC;;;;;;OAMG;IACH,oBAAoB,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IACvF;;;;OAIG;IACH,yBAAyB,CAAC,IAAI,IAAI,CAAC;CACpC;AAED,uEAAuE;AACvE,MAAM,MAAM,mBAAmB,GAAG,qBAAqB,GACrD,QAAQ,CAAC,IAAI,CAAC,qBAAqB,EAAE,sBAAsB,CAAC,CAAC,CAAC;AAEhE,oEAAoE;AACpE,wBAAgB,4BAA4B,CAC1C,UAAU,EAAE,qBAAqB,GAChC,UAAU,IAAI,mBAAmB,CAEnC;AAED;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,qBAAqB,EACjC,SAAS,EAAE,MAAM,GAChB,mBAAmB,CAQrB"}
@@ -1,3 +1,22 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.providesClientAuthentication = providesClientAuthentication;
4
+ exports.requireClientAuthentication = requireClientAuthentication;
5
+ const errors_js_1 = require("./errors.js");
6
+ /** Reports whether `credential` provides `clientAuthentication`. */
7
+ function providesClientAuthentication(credential) {
8
+ return typeof credential.clientAuthentication === "function";
9
+ }
10
+ /**
11
+ * Returns `credential` when it provides `clientAuthentication` and its
12
+ * `checkClientAuthentication` passes. Throws `ConfigurationError` otherwise.
13
+ * Call it before sending any request, including discovery.
14
+ */
15
+ function requireClientAuthentication(credential, operation) {
16
+ if (!providesClientAuthentication(credential)) {
17
+ throw new errors_js_1.ConfigurationError(`${operation} requires a credential that provides clientAuthentication`);
18
+ }
19
+ credential.checkClientAuthentication?.();
20
+ return credential;
21
+ }
3
22
  //# sourceMappingURL=credentials.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../src/credentials.ts"],"names":[],"mappings":""}
1
+ {"version":3,"file":"credentials.js","sourceRoot":"","sources":["../../src/credentials.ts"],"names":[],"mappings":";;AAqDA,oEAIC;AAOD,kEAWC;AA3ED,2CAAiD;AAoDjD,oEAAoE;AACpE,SAAgB,4BAA4B,CAC1C,UAAiC;IAEjC,OAAO,OAAO,UAAU,CAAC,oBAAoB,KAAK,UAAU,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,SAAgB,2BAA2B,CACzC,UAAiC,EACjC,SAAiB;IAEjB,IAAI,CAAC,4BAA4B,CAAC,UAAU,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,8BAAkB,CAC1B,GAAG,SAAS,2DAA2D,CACxE,CAAC;IACJ,CAAC;IACD,UAAU,CAAC,yBAAyB,EAAE,EAAE,CAAC;IACzC,OAAO,UAAU,CAAC;AACpB,CAAC"}
@@ -0,0 +1,166 @@
1
+ import { type ApplicationCredential } from "./credentials.js";
2
+ import { type OAuthAuthorizationServerMetadata } from "./discovery.js";
3
+ import { type TokenResponse } from "./tokenExchange.js";
4
+ /**
5
+ * The time source and timer for the device grant. Inject a fake in tests so
6
+ * that `expiresAt` and the waits between polls do not depend on real time.
7
+ */
8
+ export interface Clock {
9
+ /** The current time in milliseconds since the Unix epoch. */
10
+ now(): number;
11
+ /** Resolves after `ms` milliseconds. Rejects with `signal.reason` when `signal` aborts. */
12
+ sleep(ms: number, signal?: AbortSignal): Promise<void>;
13
+ }
14
+ /** The real clock: `Date.now` and `setTimeout`. */
15
+ export declare const systemClock: Clock;
16
+ /**
17
+ * Options every device grant operation shares. Set exactly one of
18
+ * `credential` and `clientId`, and use the same one for every operation in
19
+ * a flow: the zone binds the device code to the client and how it
20
+ * authenticated.
21
+ */
22
+ export type DeviceClientOptions = ({
23
+ /**
24
+ * Authenticates each request with the credential's
25
+ * `clientAuthentication`, called once per request with the URL of the
26
+ * endpoint the request goes to.
27
+ */
28
+ credential: ApplicationCredential;
29
+ clientId?: never;
30
+ } | {
31
+ /** Public client. Sent as `client_id` in the body, with no other authentication. */
32
+ clientId: string;
33
+ credential?: never;
34
+ }) & {
35
+ /** Pre-discovered metadata. When set, no discovery request is made. */
36
+ metadata?: OAuthAuthorizationServerMetadata;
37
+ /** Aborting it rejects with `signal.reason`. No request is sent after the abort. */
38
+ signal?: AbortSignal;
39
+ /** Timeout in milliseconds for each request to the authorization server (default 10 seconds; 0 disables). */
40
+ timeoutMs?: number;
41
+ };
42
+ export type RequestDeviceAuthorizationOptions = DeviceClientOptions & {
43
+ /** Sent as one space-joined `scope` parameter. */
44
+ scopes?: readonly string[];
45
+ /** RFC 8707 resource indicators, sent as one `resource` parameter each. */
46
+ resources?: readonly string[];
47
+ /** Sets `expiresAt`. Default: `systemClock`. */
48
+ clock?: Clock;
49
+ };
50
+ /**
51
+ * The device authorization response (RFC 8628 §3.2). A plain value: the
52
+ * caller may persist it and poll from another process that authenticates as
53
+ * the same client.
54
+ */
55
+ export interface DeviceAuthorization {
56
+ /** The code the device polls with. NEVER show it to the person. */
57
+ deviceCode: string;
58
+ /** The code the person confirms. Always show it, so the person can compare it with the confirmation page. */
59
+ userCode: string;
60
+ /** Where the person enters `userCode`. */
61
+ verificationUri: string;
62
+ /** `verificationUri` with `userCode` filled in. Show it in place of `verificationUri` when it is set. */
63
+ verificationUriComplete?: string;
64
+ /** Lifetime of `deviceCode` and `userCode`, in seconds. */
65
+ expiresIn: number;
66
+ /** Minimum wait between polls, in seconds. 5 when the response omits it. */
67
+ interval: number;
68
+ /** The time the response was received plus `expiresIn`, in milliseconds since the Unix epoch, read from the clock. */
69
+ expiresAt: number;
70
+ }
71
+ export type PollDeviceTokenOptions = DeviceClientOptions & {
72
+ /** The response from `requestDeviceAuthorization`. `pollDeviceToken` reads only `deviceCode`. */
73
+ authorization: DeviceAuthorization;
74
+ };
75
+ export type WaitForDeviceTokenOptions = DeviceClientOptions & {
76
+ /** The response from `requestDeviceAuthorization`, or a copy persisted from it. */
77
+ authorization: DeviceAuthorization;
78
+ /**
79
+ * The wait in seconds before the first poll, and the starting interval.
80
+ * Default: `authorization.interval`. A value that is not a positive integer,
81
+ * or is below `authorization.interval`, throws `ConfigurationError`.
82
+ */
83
+ interval?: number;
84
+ /** Reads the time for the expiry check and waits between polls. Default: `systemClock`. */
85
+ clock?: Clock;
86
+ };
87
+ /**
88
+ * Ask the zone for a device code and a user code (RFC 8628 §3.1).
89
+ *
90
+ * The SDK does not deliver the user code. Show the person
91
+ * `verificationUriComplete` when it is set, and `verificationUri`
92
+ * otherwise, together with `userCode`.
93
+ *
94
+ * Throws `ConfigurationError` before any request when the client options
95
+ * are not exactly one of `credential` and `clientId`, when the credential
96
+ * has no `clientAuthentication`, or when `metadata` is not set and `issuer`
97
+ * is not an http or https URL. Throws `ConfigurationError` before the
98
+ * device authorization request when the metadata has no
99
+ * `device_authorization_endpoint` or it is not an http or https URL. An error
100
+ * from the credential's `clientAuthentication` is thrown as is. Every other
101
+ * failure throws `DeviceGrantError`, including a failed discovery request.
102
+ * A response that is missing a required
103
+ * field, or has an `interval` that is not a positive integer, throws
104
+ * `DeviceGrantError` `invalid_response`.
105
+ */
106
+ export declare function requestDeviceAuthorization(issuer: string, options: RequestDeviceAuthorizationOptions): Promise<DeviceAuthorization>;
107
+ /**
108
+ * Poll the token endpoint once (RFC 8628 §3.4) with
109
+ * `authorization.deviceCode`. Returns the token once the person approves.
110
+ *
111
+ * Without `metadata`, each call discovers it first. If you call it in your
112
+ * own loop, fetch the metadata once with `fetchAuthorizationServerMetadata`
113
+ * and pass it to every poll. Also wait longer after a timeout or other
114
+ * network error (RFC 8628 §3.5).
115
+ *
116
+ * Throws `ConfigurationError` before any request when the client options
117
+ * are not exactly one of `credential` and `clientId`, when `authorization`
118
+ * has no `deviceCode`, or when `metadata` is not set and `issuer` is not an
119
+ * http or https URL. Throws `ConfigurationError` before the poll when the
120
+ * metadata has no `token_endpoint` or it is not an http or https URL. An
121
+ * error from the credential's `clientAuthentication` is thrown as is. Every
122
+ * other failure throws `DeviceGrantError`, including a failed discovery
123
+ * request, `authorization_pending`, and `slow_down`.
124
+ */
125
+ export declare function pollDeviceToken(issuer: string, options: PollDeviceTokenOptions): Promise<TokenResponse>;
126
+ /**
127
+ * Poll until the person approves or denies the request, following
128
+ * RFC 8628 §3.5.
129
+ *
130
+ * - It waits the interval before each poll, including the first.
131
+ * - On `authorization_pending` it polls again.
132
+ * - On `slow_down` it adds 5 seconds to the interval for this poll and every later one.
133
+ * - On a network error, a timeout, an HTTP 5xx, or an HTTP 429 it stops and
134
+ * throws `DevicePollError`, also when the 5xx or 429 has an OAuth error
135
+ * body. It does not poll again. After a network error or a timeout, the
136
+ * error's `interval` is double the current interval.
137
+ * - On any other failure it stops and throws that error as is: a
138
+ * `DeviceGrantError` for any other OAuth error or HTTP error, or the error
139
+ * from the credential's `clientAuthentication`.
140
+ * - If the next poll would start after `authorization.expiresAt`, it stops
141
+ * without waiting or polling and throws `DeviceGrantError` with code
142
+ * `expired_token`.
143
+ *
144
+ * To resume after a `DevicePollError`, call it again before `expiresAt` with
145
+ * the same `authorization` and `interval` set to the error's `interval`.
146
+ *
147
+ * Polling again on `authorization_pending` and `slow_down` follows
148
+ * RFC 8628 §3.5 and is not a retry. `timeoutMs` bounds each request. It does
149
+ * not bound the waits or the whole loop, and it applies even when `signal`
150
+ * has a longer deadline.
151
+ *
152
+ * Throws `ConfigurationError` before any request when the client options
153
+ * are not exactly one of `credential` and `clientId`, when `authorization`
154
+ * has no `deviceCode`, no `expiresAt`, or an `interval` that is not a
155
+ * positive integer, when `interval` is not a positive integer or is below
156
+ * `authorization.interval`, or
157
+ * when `metadata` is not set and `issuer` is not an http or https URL. A
158
+ * failed discovery request throws `DeviceGrantError` before the first wait.
159
+ *
160
+ * When the device authorization request named more than one resource, the
161
+ * token is not for any one of them. NEVER store it as the token for one
162
+ * resource. To get a token for one resource, call `refreshAuthorization`
163
+ * with `resources` set to it.
164
+ */
165
+ export declare function waitForDeviceToken(issuer: string, options: WaitForDeviceTokenOptions): Promise<TokenResponse>;
166
+ //# sourceMappingURL=deviceAuthorization.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"deviceAuthorization.d.ts","sourceRoot":"","sources":["../../src/deviceAuthorization.ts"],"names":[],"mappings":"AACA,OAAO,EAA+B,KAAK,qBAAqB,EAA4B,MAAM,kBAAkB,CAAC;AACrH,OAAO,EAAoC,KAAK,gCAAgC,EAAE,MAAM,gBAAgB,CAAC;AAEzG,OAAO,EAA4B,KAAK,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAUlF;;;GAGG;AACH,MAAM,WAAW,KAAK;IACpB,6DAA6D;IAC7D,GAAG,IAAI,MAAM,CAAC;IACd,2FAA2F;IAC3F,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACxD;AAED,mDAAmD;AACnD,eAAO,MAAM,WAAW,EAAE,KAkBzB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAC9B;IACE;;;;OAIG;IACH,UAAU,EAAE,qBAAqB,CAAC;IAClC,QAAQ,CAAC,EAAE,KAAK,CAAC;CAClB,GACD;IACE,oFAAoF;IACpF,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB,CACJ,GAAG;IACF,uEAAuE;IACvE,QAAQ,CAAC,EAAE,gCAAgC,CAAC;IAC5C,oFAAoF;IACpF,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,6GAA6G;IAC7G,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,iCAAiC,GAAG,mBAAmB,GAAG;IACpE,kDAAkD;IAClD,MAAM,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC3B,2EAA2E;IAC3E,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B,gDAAgD;IAChD,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,mEAAmE;IACnE,UAAU,EAAE,MAAM,CAAC;IACnB,6GAA6G;IAC7G,QAAQ,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,eAAe,EAAE,MAAM,CAAC;IACxB,yGAAyG;IACzG,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,2DAA2D;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAC;IACjB,sHAAsH;IACtH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,GAAG;IACzD,iGAAiG;IACjG,aAAa,EAAE,mBAAmB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,mBAAmB,GAAG;IAC5D,mFAAmF;IACnF,aAAa,EAAE,mBAAmB,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,2FAA2F;IAC3F,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAsB,0BAA0B,CAC9C,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,iCAAiC,GACzC,OAAO,CAAC,mBAAmB,CAAC,CAsB9B;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,eAAe,CACnC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,sBAAsB,GAC9B,OAAO,CAAC,aAAa,CAAC,CAQxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,yBAAyB,GACjC,OAAO,CAAC,aAAa,CAAC,CA2DxB"}