@cubist-labs/cubesigner-sdk 0.1.26 → 0.1.77
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 +94 -33
- package/dist/src/ethers/index.d.ts +25 -5
- package/dist/src/ethers/index.js +58 -16
- package/dist/src/fido.d.ts +76 -0
- package/dist/src/fido.js +148 -0
- package/dist/src/index.d.ts +148 -35
- package/dist/src/index.js +320 -53
- package/dist/src/key.d.ts +64 -8
- package/dist/src/key.js +91 -19
- package/dist/src/org.d.ts +98 -9
- package/dist/src/org.js +144 -29
- package/dist/src/paginator.d.ts +76 -0
- package/dist/src/paginator.js +99 -0
- package/dist/src/role.d.ts +20 -8
- package/dist/src/role.js +7 -5
- package/dist/src/schema.d.ts +2395 -393
- package/dist/src/schema.js +1 -1
- package/dist/src/session/cognito_manager.d.ts +59 -0
- package/dist/src/session/cognito_manager.js +111 -0
- package/dist/src/session/session_manager.d.ts +15 -0
- package/dist/src/session/session_manager.js +21 -2
- package/dist/src/session/session_storage.js +1 -1
- package/dist/src/session/signer_session_manager.d.ts +24 -12
- package/dist/src/session/signer_session_manager.js +45 -20
- package/dist/src/signer_session.d.ts +136 -38
- package/dist/src/signer_session.js +187 -80
- package/dist/src/util.d.ts +20 -0
- package/dist/src/util.js +31 -2
- package/package.json +12 -7
- package/src/ethers/index.ts +88 -16
- package/src/fido.ts +166 -0
- package/src/index.ts +366 -77
- package/src/key.ts +112 -16
- package/src/org.ts +200 -37
- package/src/paginator.ts +122 -0
- package/src/role.ts +24 -11
- package/src/schema.ts +2458 -449
- package/src/session/{management_session_manager.ts → cognito_manager.ts} +13 -15
- package/src/session/session_manager.ts +25 -1
- package/src/session/session_storage.ts +1 -1
- package/src/session/signer_session_manager.ts +57 -27
- package/src/signer_session.ts +266 -89
- package/src/util.ts +41 -0
- package/src/session/oidc_session_manager.ts +0 -193
package/dist/src/fido.js
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* eslint-disable @typescript-eslint/no-explicit-any */
|
|
3
|
+
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
|
4
|
+
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
5
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
6
|
+
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
|
|
7
|
+
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
|
8
|
+
};
|
|
9
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
10
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
11
|
+
if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
|
|
12
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
13
|
+
};
|
|
14
|
+
var _AddFidoChallenge_cs, _MfaFidoChallenge_ss;
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.MfaFidoChallenge = exports.AddFidoChallenge = void 0;
|
|
17
|
+
const util_1 = require("./util");
|
|
18
|
+
/**
|
|
19
|
+
* Returned after creating a request to add a new FIDO device.
|
|
20
|
+
* Provides some helper methods for answering this challenge.
|
|
21
|
+
*/
|
|
22
|
+
class AddFidoChallenge {
|
|
23
|
+
/**
|
|
24
|
+
* Constructor
|
|
25
|
+
* @param {CubeSigner} cs CubeSigner instance used to request to add a FIDO device
|
|
26
|
+
* @param {ApiAddFidoChallenge} challenge The challenge returned by the remote end.
|
|
27
|
+
*/
|
|
28
|
+
constructor(cs, challenge) {
|
|
29
|
+
_AddFidoChallenge_cs.set(this, void 0);
|
|
30
|
+
__classPrivateFieldSet(this, _AddFidoChallenge_cs, cs, "f");
|
|
31
|
+
this.challengeId = challenge.challenge_id;
|
|
32
|
+
// fix options returned from the server: rename fields and decode base64 fields to uint8[]
|
|
33
|
+
this.options = {
|
|
34
|
+
...challenge.options,
|
|
35
|
+
challenge: (0, util_1.decodeBase64Url)(challenge.options.challenge),
|
|
36
|
+
};
|
|
37
|
+
this.options.pubKeyCredParams ??= challenge.options.pub_key_cred_params;
|
|
38
|
+
this.options.excludeCredentials ??= challenge.options.exclude_credentials;
|
|
39
|
+
this.options.authenticatorSelection ??= challenge.options.authenticator_selection;
|
|
40
|
+
delete this.options.pub_key_cred_params;
|
|
41
|
+
delete this.options.exclude_credentials;
|
|
42
|
+
delete this.options.authenticator_selection;
|
|
43
|
+
if (challenge.options.user) {
|
|
44
|
+
this.options.user.id = (0, util_1.decodeBase64Url)(challenge.options.user.id);
|
|
45
|
+
}
|
|
46
|
+
for (const credential of this.options.excludeCredentials ?? []) {
|
|
47
|
+
credential.id = (0, util_1.decodeBase64Url)(credential.id);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Answers this challenge by using the `CredentialsContainer` API to create a credential
|
|
52
|
+
* based on the the public key credential creation options from this challenge.
|
|
53
|
+
*/
|
|
54
|
+
async createCredentialAndAnswer() {
|
|
55
|
+
const cred = await navigator.credentials.create({ publicKey: this.options });
|
|
56
|
+
await this.answer(cred);
|
|
57
|
+
}
|
|
58
|
+
/**
|
|
59
|
+
* Answers this challenge using a given credential `cred`;
|
|
60
|
+
* the credential should be obtained by calling
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
* const cred = await navigator.credentials.create({ publicKey: this.options });
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param {any} cred Credential created by calling the `CredentialContainer`'s `create` method
|
|
67
|
+
* based on the public key creation options from this challenge.
|
|
68
|
+
*/
|
|
69
|
+
async answer(cred) {
|
|
70
|
+
const answer = {
|
|
71
|
+
id: cred.id,
|
|
72
|
+
response: {
|
|
73
|
+
clientDataJSON: (0, util_1.encodeToBase64Url)(cred.response.clientDataJSON),
|
|
74
|
+
attestationObject: (0, util_1.encodeToBase64Url)(cred.response.attestationObject),
|
|
75
|
+
},
|
|
76
|
+
};
|
|
77
|
+
await __classPrivateFieldGet(this, _AddFidoChallenge_cs, "f").addFidoComplete(this.challengeId, answer);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
exports.AddFidoChallenge = AddFidoChallenge;
|
|
81
|
+
_AddFidoChallenge_cs = new WeakMap();
|
|
82
|
+
/**
|
|
83
|
+
* Returned after initiating MFA approval using FIDO.
|
|
84
|
+
* Provides some helper methods for answering this challenge.
|
|
85
|
+
*/
|
|
86
|
+
class MfaFidoChallenge {
|
|
87
|
+
/**
|
|
88
|
+
* @param {SignerSession} ss The session used to initiate MFA approval using FIDO
|
|
89
|
+
* @param {string} mfaId The MFA request id.
|
|
90
|
+
* @param {ApiMfaFidoChallenge} challenge The challenge returned by the remote end
|
|
91
|
+
*/
|
|
92
|
+
constructor(ss, mfaId, challenge) {
|
|
93
|
+
_MfaFidoChallenge_ss.set(this, void 0);
|
|
94
|
+
__classPrivateFieldSet(this, _MfaFidoChallenge_ss, ss, "f");
|
|
95
|
+
this.mfaId = mfaId;
|
|
96
|
+
this.challengeId = challenge.challenge_id;
|
|
97
|
+
// fix options returned from the server: rename fields and decode base64 fields into uint8[]
|
|
98
|
+
this.options = {
|
|
99
|
+
...challenge.options,
|
|
100
|
+
challenge: (0, util_1.decodeBase64Url)(challenge.options.challenge),
|
|
101
|
+
};
|
|
102
|
+
this.options.rpId ??= challenge.options.rp_id;
|
|
103
|
+
this.options.allowCredentials ??= challenge.options.allow_credentials;
|
|
104
|
+
this.options.userVerification ??= challenge.options.user_verification;
|
|
105
|
+
delete this.options.rp_id;
|
|
106
|
+
delete this.options.allow_credentials;
|
|
107
|
+
delete this.options.user_verification;
|
|
108
|
+
for (const credential of this.options.allowCredentials ?? []) {
|
|
109
|
+
credential.id = (0, util_1.decodeBase64Url)(credential.id);
|
|
110
|
+
if (credential.transports === null) {
|
|
111
|
+
delete credential.transports;
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
}
|
|
115
|
+
/**
|
|
116
|
+
* Answers this challenge by using the `CredentialsContainer` API to get a credential
|
|
117
|
+
* based on the the public key credential request options from this challenge.
|
|
118
|
+
*/
|
|
119
|
+
async createCredentialAndAnswer() {
|
|
120
|
+
const cred = await navigator.credentials.get({ publicKey: this.options });
|
|
121
|
+
return await this.answer(cred);
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
* Answers this challenge using a given credential `cred`.
|
|
125
|
+
* To obtain this credential, for example, call
|
|
126
|
+
*
|
|
127
|
+
* ```
|
|
128
|
+
* const cred = await navigator.credentials.get({ publicKey: this.options });
|
|
129
|
+
* ```
|
|
130
|
+
*
|
|
131
|
+
* @param {any} cred Credential created by calling the `CredentialContainer`'s `get` method
|
|
132
|
+
* based on the public key credential request options from this challenge.
|
|
133
|
+
*/
|
|
134
|
+
async answer(cred) {
|
|
135
|
+
const answer = {
|
|
136
|
+
id: cred.id,
|
|
137
|
+
response: {
|
|
138
|
+
clientDataJSON: (0, util_1.encodeToBase64Url)(cred.response.clientDataJSON),
|
|
139
|
+
authenticatorData: (0, util_1.encodeToBase64Url)(cred.response.authenticatorData),
|
|
140
|
+
signature: (0, util_1.encodeToBase64Url)(cred.response.signature),
|
|
141
|
+
},
|
|
142
|
+
};
|
|
143
|
+
return await __classPrivateFieldGet(this, _MfaFidoChallenge_ss, "f").fidoApproveComplete(this.mfaId, this.challengeId, answer);
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
exports.MfaFidoChallenge = MfaFidoChallenge;
|
|
147
|
+
_MfaFidoChallenge_ss = new WeakMap();
|
|
148
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"fido.js","sourceRoot":"","sources":["../../src/fido.ts"],"names":[],"mappings":";AAAA,uDAAuD;;;;;;;;;;;;;;;AAIvD,iCAA4D;AAmB5D;;;GAGG;AACH,MAAa,gBAAgB;IAK3B;;;;OAIG;IACH,YAAY,EAAc,EAAE,SAA8B;QATjD,uCAAgB;QAUvB,uBAAA,IAAI,wBAAO,EAAE,MAAA,CAAC;QACd,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,YAAY,CAAC;QAE1C,0FAA0F;QAC1F,IAAI,CAAC,OAAO,GAAG;YACb,GAAG,SAAS,CAAC,OAAO;YACpB,SAAS,EAAE,IAAA,sBAAe,EAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC;SACxD,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,SAAS,CAAC,OAAO,CAAC,mBAAmB,CAAC;QACxE,IAAI,CAAC,OAAO,CAAC,kBAAkB,KAAK,SAAS,CAAC,OAAO,CAAC,mBAAmB,CAAC;QAC1E,IAAI,CAAC,OAAO,CAAC,sBAAsB,KAAK,SAAS,CAAC,OAAO,CAAC,uBAAuB,CAAC;QAClF,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC;QACxC,OAAO,IAAI,CAAC,OAAO,CAAC,uBAAuB,CAAC;QAE5C,IAAI,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE;YAC1B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,IAAA,sBAAe,EAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnE;QAED,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,kBAAkB,IAAI,EAAE,EAAE;YAC9D,UAAU,CAAC,EAAE,GAAG,IAAA,sBAAe,EAAC,UAAU,CAAC,EAAE,CAAC,CAAC;SAChD;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,yBAAyB;QAC7B,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7E,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,IAAS;QACpB,MAAM,MAAM,GAAwB;YAClC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,QAAQ,EAAE;gBACR,cAAc,EAAE,IAAA,wBAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;gBAC/D,iBAAiB,EAAE,IAAA,wBAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;aACtE;SACF,CAAC;QACF,MAAM,uBAAA,IAAI,4BAAI,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAC3D,CAAC;CACF;AAjED,4CAiEC;;AAED;;;GAGG;AACH,MAAa,gBAAgB;IAM3B;;;;OAIG;IACH,YAAY,EAAiB,EAAE,KAAa,EAAE,SAA8B;QAVnE,uCAAmB;QAW1B,uBAAA,IAAI,wBAAO,EAAE,MAAA,CAAC;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC,YAAY,CAAC;QAE1C,4FAA4F;QAC5F,IAAI,CAAC,OAAO,GAAG;YACb,GAAG,SAAS,CAAC,OAAO;YACpB,SAAS,EAAE,IAAA,sBAAe,EAAC,SAAS,CAAC,OAAO,CAAC,SAAS,CAAC;SACxD,CAAC;QACF,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,CAAC,OAAO,CAAC,KAAK,CAAC;QAC9C,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,SAAS,CAAC,OAAO,CAAC,iBAAiB,CAAC;QACtE,IAAI,CAAC,OAAO,CAAC,gBAAgB,KAAK,SAAS,CAAC,OAAO,CAAC,iBAAiB,CAAC;QACtE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;QAC1B,OAAO,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;QACtC,OAAO,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC;QAEtC,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,IAAI,EAAE,EAAE;YAC5D,UAAU,CAAC,EAAE,GAAG,IAAA,sBAAe,EAAC,UAAU,CAAC,EAAE,CAAC,CAAC;YAC/C,IAAI,UAAU,CAAC,UAAU,KAAK,IAAI,EAAE;gBAClC,OAAO,UAAU,CAAC,UAAU,CAAC;aAC9B;SACF;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,yBAAyB;QAC7B,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1E,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACjC,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,MAAM,CAAC,IAAS;QACpB,MAAM,MAAM,GAAwB;YAClC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,QAAQ,EAAE;gBACR,cAAc,EAAE,IAAA,wBAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,cAAc,CAAC;gBAC/D,iBAAiB,EAAE,IAAA,wBAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC;gBACrE,SAAS,EAAE,IAAA,wBAAiB,EAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;aACtD;SACF,CAAC;QACF,OAAO,MAAM,uBAAA,IAAI,4BAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;IAClF,CAAC;CACF;AAnED,4CAmEC","sourcesContent":["/* eslint-disable @typescript-eslint/no-explicit-any */\n\nimport { CubeSigner, MfaRequestInfo, SignerSession } from \".\";\nimport { components } from \"./schema\";\nimport { decodeBase64Url, encodeToBase64Url } from \"./util\";\n\nexport type ApiAddFidoChallenge =\n  components[\"responses\"][\"FidoCreateChallengeResponse\"][\"content\"][\"application/json\"];\n\nexport type ApiMfaFidoChallenge =\n  components[\"responses\"][\"FidoAssertChallenge\"][\"content\"][\"application/json\"];\n\nexport type PublicKeyCredentialCreationOptions =\n  components[\"schemas\"][\"PublicKeyCredentialCreationOptions\"];\nexport type PublicKeyCredentialRequestOptions =\n  components[\"schemas\"][\"PublicKeyCredentialRequestOptions\"];\nexport type PublicKeyCredentialParameters = components[\"schemas\"][\"PublicKeyCredentialParameters\"];\nexport type PublicKeyCredentialDescriptor = components[\"schemas\"][\"PublicKeyCredentialDescriptor\"];\nexport type AuthenticatorSelectionCriteria =\n  components[\"schemas\"][\"AuthenticatorSelectionCriteria\"];\nexport type PublicKeyCredentialUserEntity = components[\"schemas\"][\"PublicKeyCredentialUserEntity\"];\nexport type PublicKeyCredential = components[\"schemas\"][\"PublicKeyCredential\"];\n\n/**\n * Returned after creating a request to add a new FIDO device.\n * Provides some helper methods for answering this challenge.\n */\nexport class AddFidoChallenge {\n  readonly #cs: CubeSigner;\n  readonly challengeId: string;\n  readonly options: any;\n\n  /**\n   * Constructor\n   * @param {CubeSigner} cs CubeSigner instance used to request to add a FIDO device\n   * @param {ApiAddFidoChallenge} challenge The challenge returned by the remote end.\n   */\n  constructor(cs: CubeSigner, challenge: ApiAddFidoChallenge) {\n    this.#cs = cs;\n    this.challengeId = challenge.challenge_id;\n\n    // fix options returned from the server: rename fields and decode base64 fields to uint8[]\n    this.options = {\n      ...challenge.options,\n      challenge: decodeBase64Url(challenge.options.challenge),\n    };\n    this.options.pubKeyCredParams ??= challenge.options.pub_key_cred_params;\n    this.options.excludeCredentials ??= challenge.options.exclude_credentials;\n    this.options.authenticatorSelection ??= challenge.options.authenticator_selection;\n    delete this.options.pub_key_cred_params;\n    delete this.options.exclude_credentials;\n    delete this.options.authenticator_selection;\n\n    if (challenge.options.user) {\n      this.options.user.id = decodeBase64Url(challenge.options.user.id);\n    }\n\n    for (const credential of this.options.excludeCredentials ?? []) {\n      credential.id = decodeBase64Url(credential.id);\n    }\n  }\n\n  /**\n   * Answers this challenge by using the `CredentialsContainer` API to create a credential\n   * based on the the public key credential creation options from this challenge.\n   */\n  async createCredentialAndAnswer() {\n    const cred = await navigator.credentials.create({ publicKey: this.options });\n    await this.answer(cred);\n  }\n\n  /**\n   * Answers this challenge using a given credential `cred`;\n   * the credential should be obtained by calling\n   *\n   * ```\n   * const cred = await navigator.credentials.create({ publicKey: this.options });\n   * ```\n   *\n   * @param {any} cred Credential created by calling the `CredentialContainer`'s `create` method\n   *                   based on the public key creation options from this challenge.\n   */\n  async answer(cred: any) {\n    const answer = <PublicKeyCredential>{\n      id: cred.id,\n      response: {\n        clientDataJSON: encodeToBase64Url(cred.response.clientDataJSON),\n        attestationObject: encodeToBase64Url(cred.response.attestationObject),\n      },\n    };\n    await this.#cs.addFidoComplete(this.challengeId, answer);\n  }\n}\n\n/**\n * Returned after initiating MFA approval using FIDO.\n * Provides some helper methods for answering this challenge.\n */\nexport class MfaFidoChallenge {\n  readonly #ss: SignerSession;\n  readonly mfaId: string;\n  readonly challengeId: string;\n  readonly options: any;\n\n  /**\n   * @param {SignerSession} ss The session used to initiate MFA approval using FIDO\n   * @param {string} mfaId The MFA request id.\n   * @param {ApiMfaFidoChallenge} challenge The challenge returned by the remote end\n   */\n  constructor(ss: SignerSession, mfaId: string, challenge: ApiMfaFidoChallenge) {\n    this.#ss = ss;\n    this.mfaId = mfaId;\n    this.challengeId = challenge.challenge_id;\n\n    // fix options returned from the server: rename fields and decode base64 fields into uint8[]\n    this.options = {\n      ...challenge.options,\n      challenge: decodeBase64Url(challenge.options.challenge),\n    };\n    this.options.rpId ??= challenge.options.rp_id;\n    this.options.allowCredentials ??= challenge.options.allow_credentials;\n    this.options.userVerification ??= challenge.options.user_verification;\n    delete this.options.rp_id;\n    delete this.options.allow_credentials;\n    delete this.options.user_verification;\n\n    for (const credential of this.options.allowCredentials ?? []) {\n      credential.id = decodeBase64Url(credential.id);\n      if (credential.transports === null) {\n        delete credential.transports;\n      }\n    }\n  }\n\n  /**\n   * Answers this challenge by using the `CredentialsContainer` API to get a credential\n   * based on the the public key credential request options from this challenge.\n   */\n  async createCredentialAndAnswer(): Promise<MfaRequestInfo> {\n    const cred = await navigator.credentials.get({ publicKey: this.options });\n    return await this.answer(cred);\n  }\n\n  /**\n   * Answers this challenge using a given credential `cred`.\n   * To obtain this credential, for example, call\n   *\n   * ```\n   * const cred = await navigator.credentials.get({ publicKey: this.options });\n   * ```\n   *\n   * @param {any} cred Credential created by calling the `CredentialContainer`'s `get` method\n   *                   based on the public key credential request options from this challenge.\n   */\n  async answer(cred: any): Promise<MfaRequestInfo> {\n    const answer = <PublicKeyCredential>{\n      id: cred.id,\n      response: {\n        clientDataJSON: encodeToBase64Url(cred.response.clientDataJSON),\n        authenticatorData: encodeToBase64Url(cred.response.authenticatorData),\n        signature: encodeToBase64Url(cred.response.signature),\n      },\n    };\n    return await this.#ss.fidoApproveComplete(this.mfaId, this.challengeId, answer);\n  }\n}\n"]}
|
package/dist/src/index.d.ts
CHANGED
|
@@ -1,34 +1,63 @@
|
|
|
1
1
|
import { EnvInterface } from "./env";
|
|
2
|
-
import { components, Client } from "./client";
|
|
2
|
+
import { components, Client, paths } from "./client";
|
|
3
3
|
import { Org } from "./org";
|
|
4
|
-
import { SignerSessionStorage } from "./session/signer_session_manager";
|
|
5
|
-
import { SignerSession } from "./signer_session";
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
4
|
+
import { SignerSessionStorage, SignerSessionManager } from "./session/signer_session_manager";
|
|
5
|
+
import { MfaRequestInfo, SignResponse, SignerSession } from "./signer_session";
|
|
6
|
+
import { CognitoSessionManager, CognitoSessionStorage } from "./session/cognito_manager";
|
|
7
|
+
import { AddFidoChallenge, PublicKeyCredential } from "./fido";
|
|
8
8
|
/** CubeSigner constructor options */
|
|
9
9
|
export interface CubeSignerOptions {
|
|
10
10
|
/** The environment to use */
|
|
11
11
|
env?: EnvInterface;
|
|
12
12
|
/** The management authorization token */
|
|
13
|
-
sessionMgr?:
|
|
13
|
+
sessionMgr?: CognitoSessionManager | SignerSessionManager;
|
|
14
|
+
/** Optional organization id */
|
|
15
|
+
orgId?: string;
|
|
14
16
|
}
|
|
15
17
|
export type UserInfo = components["schemas"]["UserInfo"];
|
|
16
18
|
export type TotpInfo = components["responses"]["TotpInfo"]["content"]["application/json"];
|
|
17
19
|
export type ConfiguredMfa = components["schemas"]["ConfiguredMfa"];
|
|
20
|
+
export type RatchetConfig = components["schemas"]["RatchetConfig"];
|
|
21
|
+
export type IdentityProof = components["schemas"]["IdentityProof"];
|
|
22
|
+
type OidcAuthResponse = paths["/v0/org/{org_id}/oidc"]["post"]["responses"]["200"]["content"]["application/json"];
|
|
23
|
+
/** TOTP challenge that must be answered before user's TOTP is updated */
|
|
24
|
+
export declare class TotpChallenge {
|
|
25
|
+
#private;
|
|
26
|
+
/** The id of the challenge */
|
|
27
|
+
get totpId(): string;
|
|
28
|
+
/** The new TOTP configuration */
|
|
29
|
+
get totpUrl(): string;
|
|
30
|
+
/**
|
|
31
|
+
* @param {CubeSigner} cs Used when answering the challenge.
|
|
32
|
+
* @param {TotpInfo} totpInfo TOTP challenge information.
|
|
33
|
+
*/
|
|
34
|
+
constructor(cs: CubeSigner, totpInfo: TotpInfo);
|
|
35
|
+
/**
|
|
36
|
+
* Answer the challenge with the code that corresponds to this `this.totpUrl`.
|
|
37
|
+
* @param {string} code 6-digit code that corresponds to this `this.totpUrl`.
|
|
38
|
+
*/
|
|
39
|
+
answer(code: string): Promise<void>;
|
|
40
|
+
}
|
|
18
41
|
/** CubeSigner client */
|
|
19
42
|
export declare class CubeSigner {
|
|
20
43
|
#private;
|
|
21
|
-
readonly sessionMgr?:
|
|
44
|
+
readonly sessionMgr?: CognitoSessionManager | SignerSessionManager;
|
|
22
45
|
/** @return {EnvInterface} The CubeSigner environment of this client */
|
|
23
46
|
get env(): EnvInterface;
|
|
47
|
+
/**
|
|
48
|
+
* Set the organization ID
|
|
49
|
+
* @param {string} orgId The new organization id.
|
|
50
|
+
*/
|
|
51
|
+
setOrgId(orgId: string): void;
|
|
24
52
|
/**
|
|
25
53
|
* Loads an existing management session and creates a CubeSigner instance.
|
|
26
|
-
*
|
|
54
|
+
*
|
|
55
|
+
* @param {CognitoSessionStorage} storage Optional session storage to load
|
|
27
56
|
* the session from. If not specified, the management session from the config
|
|
28
57
|
* directory will be loaded.
|
|
29
58
|
* @return {Promise<CubeSigner>} New CubeSigner instance
|
|
30
59
|
*/
|
|
31
|
-
static loadManagementSession(storage?:
|
|
60
|
+
static loadManagementSession(storage?: CognitoSessionStorage): Promise<CubeSigner>;
|
|
32
61
|
/**
|
|
33
62
|
* Loads a signer session from a session storage (e.g., session file).
|
|
34
63
|
* @param {SignerSessionStorage} storage Optional session storage to load
|
|
@@ -37,42 +66,77 @@ export declare class CubeSigner {
|
|
|
37
66
|
* @return {Promise<SignerSession>} New signer session
|
|
38
67
|
*/
|
|
39
68
|
static loadSignerSession(storage?: SignerSessionStorage): Promise<SignerSession>;
|
|
40
|
-
/**
|
|
41
|
-
* Loads a signer session from OIDC storage
|
|
42
|
-
* @param {OidcSessionStorage} storage The storage to load from
|
|
43
|
-
* @return {Promise<SignerSession>} New signer session
|
|
44
|
-
*/
|
|
45
|
-
static loadOidcSession(storage: OidcSessionStorage): Promise<SignerSession>;
|
|
46
69
|
/**
|
|
47
70
|
* Create a new CubeSigner instance.
|
|
48
|
-
* @param {CubeSignerOptions} options The options for the CubeSigner instance.
|
|
71
|
+
* @param {CubeSignerOptions} options The optional configuraiton options for the CubeSigner instance.
|
|
49
72
|
*/
|
|
50
|
-
constructor(options
|
|
73
|
+
constructor(options?: CubeSignerOptions);
|
|
51
74
|
/**
|
|
52
|
-
* Authenticate an OIDC user and create a new
|
|
75
|
+
* Authenticate an OIDC user and create a new session manager for them.
|
|
53
76
|
* @param {string} oidcToken The OIDC token
|
|
54
77
|
* @param {string} orgId The id of the organization that the user is in
|
|
55
78
|
* @param {List<string>} scopes The scopes of the resulting session
|
|
56
|
-
* @param {
|
|
57
|
-
* @
|
|
79
|
+
* @param {RatchetConfig} lifetimes Lifetimes of the new session.
|
|
80
|
+
* @param {SignerSessionStorage?} storage Optional signer session storage (defaults to in-memory storage)
|
|
81
|
+
* @return {Promise<SignerSessionManager>} The signer session manager
|
|
58
82
|
*/
|
|
59
|
-
|
|
83
|
+
oidcAuth(oidcToken: string, orgId: string, scopes: Array<string>, lifetimes?: RatchetConfig, storage?: SignerSessionStorage): Promise<SignerSessionManager>;
|
|
60
84
|
/**
|
|
61
|
-
*
|
|
62
|
-
*
|
|
63
|
-
* @
|
|
64
|
-
* @param {List<string>} scopes The scopes of the resulting session
|
|
65
|
-
* @param {OidcSessionStorage} storage The signer session storage
|
|
66
|
-
* @return {Promise<SignerSession>} The signer session
|
|
85
|
+
* Retrieves information about the current user.
|
|
86
|
+
*
|
|
87
|
+
* @return {Promise<UserInfo>} User information.
|
|
67
88
|
*/
|
|
68
|
-
createOidcSession(oidcToken: string, orgId: string, scopes: Array<string>, storage?: OidcSessionStorage): Promise<SignerSession>;
|
|
69
|
-
/** Retrieves information about the current user. */
|
|
70
89
|
aboutMe(): Promise<UserInfo>;
|
|
71
90
|
/**
|
|
72
|
-
*
|
|
73
|
-
*
|
|
91
|
+
* Retrieves existing MFA request.
|
|
92
|
+
*
|
|
93
|
+
* @param {string} orgId Organization ID
|
|
94
|
+
* @param {string} mfaId MFA request ID
|
|
95
|
+
* @return {Promise<MfaRequestInfo>} MFA request information
|
|
96
|
+
*/
|
|
97
|
+
mfaGet(orgId: string, mfaId: string): Promise<MfaRequestInfo>;
|
|
98
|
+
/**
|
|
99
|
+
* List pending MFA requests accessible to the current user.
|
|
100
|
+
* @param {string} orgId Organization ID
|
|
101
|
+
* @return {Promise<MfaRequestInfo[]>} The MFA requests.
|
|
102
|
+
*/
|
|
103
|
+
mfaList(orgId: string): Promise<MfaRequestInfo[]>;
|
|
104
|
+
/**
|
|
105
|
+
* Approve a pending MFA request.
|
|
106
|
+
*
|
|
107
|
+
* @param {string} orgId The org id of the MFA request
|
|
108
|
+
* @param {string} mfaId The id of the MFA request
|
|
109
|
+
* @return {Promise<MfaRequestInfo>} The result of the MFA request
|
|
110
|
+
*/
|
|
111
|
+
mfaApprove(orgId: string, mfaId: string): Promise<MfaRequestInfo>;
|
|
112
|
+
/**
|
|
113
|
+
* Initiate adding a new FIDO device. MFA may be required.
|
|
114
|
+
* @param {string} name The name of the new device.
|
|
115
|
+
* @param {MfaReceipt} mfaReceipt Optional MFA receipt to include in HTTP headers
|
|
116
|
+
* @return {Promise<SignResponse<AddFidoChallenge>>} A challenge that must be answered in order to complete FIDO registration.
|
|
117
|
+
*/
|
|
118
|
+
addFidoStart(name: string, mfaReceipt?: MfaReceipt): Promise<SignResponse<AddFidoChallenge>>;
|
|
119
|
+
/**
|
|
120
|
+
* Complete a previously initiated request to add a new FIDO device.
|
|
121
|
+
* @param {string} challengeId The ID of the challenge returned by the remote end.
|
|
122
|
+
* @param {PublicKeyCredential} credential The answer to the challenge.
|
|
74
123
|
*/
|
|
75
|
-
|
|
124
|
+
addFidoComplete(challengeId: string, credential: PublicKeyCredential): Promise<void>;
|
|
125
|
+
/**
|
|
126
|
+
* Creates a request to change user's TOTP. This request returns a new TOTP challenge
|
|
127
|
+
* that must be answered by calling `resetTotpComplete`
|
|
128
|
+
*
|
|
129
|
+
* @param {MfaReceipt} mfaReceipt MFA receipt to include in HTTP headers
|
|
130
|
+
*/
|
|
131
|
+
resetTotpStart(mfaReceipt?: MfaReceipt): Promise<SignResponse<TotpChallenge>>;
|
|
132
|
+
/**
|
|
133
|
+
* Answer the TOTP challenge issued by `resetTotpStart`. If successful, user's
|
|
134
|
+
* TOTP configuration will be updated to that of the TOTP challenge.
|
|
135
|
+
*
|
|
136
|
+
* @param {string} totpId - The ID of the TOTP challenge
|
|
137
|
+
* @param {string} code - The TOTP code that should verify against the TOTP configuration from the challenge.
|
|
138
|
+
*/
|
|
139
|
+
resetTotpComplete(totpId: string, code: string): Promise<void>;
|
|
76
140
|
/**
|
|
77
141
|
* Verifies a given TOTP code against the current user's TOTP configuration.
|
|
78
142
|
* Throws an error if the verification fails.
|
|
@@ -84,11 +148,58 @@ export declare class CubeSigner {
|
|
|
84
148
|
* @return {Org} The organization.
|
|
85
149
|
* */
|
|
86
150
|
getOrg(orgId: string): Promise<Org>;
|
|
151
|
+
/**
|
|
152
|
+
* Deletes a given key.
|
|
153
|
+
* @param {string} orgId - Organization id
|
|
154
|
+
* @param {string} keyId - Key id
|
|
155
|
+
*/
|
|
156
|
+
deleteKey(orgId: string, keyId: string): Promise<void>;
|
|
87
157
|
/** Get the management client.
|
|
88
158
|
* @return {Client} The client.
|
|
89
159
|
* @internal
|
|
90
160
|
* */
|
|
91
161
|
management(): Promise<Client>;
|
|
162
|
+
/**
|
|
163
|
+
* Obtain a proof of authentication.
|
|
164
|
+
*
|
|
165
|
+
* @param {string} orgId The id of the organization that the user is in
|
|
166
|
+
* @return {Promise<IdentityProof>} Proof of authentication
|
|
167
|
+
*/
|
|
168
|
+
proveIdentity(orgId: string): Promise<IdentityProof>;
|
|
169
|
+
/**
|
|
170
|
+
* Exchange an OIDC token for a proof of authentication.
|
|
171
|
+
*
|
|
172
|
+
* @param {string} oidcToken The OIDC token
|
|
173
|
+
* @param {string} orgId The id of the organization that the user is in
|
|
174
|
+
* @return {Promise<IdentityProof>} Proof of authentication
|
|
175
|
+
*/
|
|
176
|
+
oidcProveIdentity(oidcToken: string, orgId: string): Promise<IdentityProof>;
|
|
177
|
+
/**
|
|
178
|
+
* Checks if a given identity proof is valid.
|
|
179
|
+
*
|
|
180
|
+
* @param {string} orgId The id of the organization that the user is in.
|
|
181
|
+
* @param {IdentityProof} identityProof The proof of authentication.
|
|
182
|
+
*/
|
|
183
|
+
verifyIdentity(orgId: string, identityProof: IdentityProof): Promise<void>;
|
|
184
|
+
/**
|
|
185
|
+
* Exchange an OIDC token for a CubeSigner session token.
|
|
186
|
+
* @param {string} oidcToken The OIDC token
|
|
187
|
+
* @param {string} orgId The id of the organization that the user is in
|
|
188
|
+
* @param {List<string>} scopes The scopes of the resulting session
|
|
189
|
+
* @param {RatchetConfig} lifetimes Lifetimes of the new session.
|
|
190
|
+
* @param {MfaReceipt} mfaReceipt Optional MFA receipt (id + confirmation code)
|
|
191
|
+
* @return {Promise<SignResponse<OidcAuthResponse>>} The session data.
|
|
192
|
+
*/
|
|
193
|
+
oidcLogin(oidcToken: string, orgId: string, scopes: Array<string>, lifetimes?: RatchetConfig, mfaReceipt?: MfaReceipt): Promise<SignResponse<OidcAuthResponse>>;
|
|
194
|
+
}
|
|
195
|
+
/** MFA receipt */
|
|
196
|
+
export interface MfaReceipt {
|
|
197
|
+
/** MFA request ID */
|
|
198
|
+
mfaId: string;
|
|
199
|
+
/** Corresponding org ID */
|
|
200
|
+
mfaOrgId: string;
|
|
201
|
+
/** MFA confirmation code */
|
|
202
|
+
mfaConf: string;
|
|
92
203
|
}
|
|
93
204
|
/** Organizations */
|
|
94
205
|
export * from "./org";
|
|
@@ -98,6 +209,10 @@ export * from "./key";
|
|
|
98
209
|
export * from "./role";
|
|
99
210
|
/** Env */
|
|
100
211
|
export * from "./env";
|
|
212
|
+
/** Fido */
|
|
213
|
+
export * from "./fido";
|
|
214
|
+
/** Pagination */
|
|
215
|
+
export * from "./paginator";
|
|
101
216
|
/** Sessions */
|
|
102
217
|
export * from "./signer_session";
|
|
103
218
|
/** Session storage */
|
|
@@ -105,9 +220,7 @@ export * from "./session/session_storage";
|
|
|
105
220
|
/** Session manager */
|
|
106
221
|
export * from "./session/session_manager";
|
|
107
222
|
/** Management session manager */
|
|
108
|
-
export * from "./session/
|
|
109
|
-
/** OIDC session manager */
|
|
110
|
-
export * from "./session/oidc_session_manager";
|
|
223
|
+
export * from "./session/cognito_manager";
|
|
111
224
|
/** Signer session manager */
|
|
112
225
|
export * from "./session/signer_session_manager";
|
|
113
226
|
/** Export ethers.js Signer */
|