@cubist-labs/cubesigner-sdk-secretsmanager-storage 0.4.97-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 +8 -0
- package/dist/index.d.ts +55 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +125 -0
- package/package.json +34 -0
- package/src/index.ts +149 -0
- package/tsconfig.json +13 -0
package/README.md
ADDED
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# CubeSigner SDK session manager backed by AWS Secrets Manager
|
|
2
|
+
|
|
3
|
+
This package provides an AWS Secrets Manager-backed implementation of the
|
|
4
|
+
`SessionManager` interface from the CubeSigner SDK.
|
|
5
|
+
|
|
6
|
+
For more information, check out the
|
|
7
|
+
[@cubist-labs/cubesigner-sdk](https://www.npmjs.com/package/@cubist-labs/cubesigner-sdk)
|
|
8
|
+
NPM package.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { type SessionData, type SessionManager, type SessionMetadata } from "@cubist-labs/cubesigner-sdk";
|
|
2
|
+
/** Options for AWS Secrets Manager-backed session manager */
|
|
3
|
+
interface AwsSecretSessionManagerOpts {
|
|
4
|
+
/**
|
|
5
|
+
* Limit the cache lifetime by the scheduled rotation of the secret (default: true)
|
|
6
|
+
*/
|
|
7
|
+
checkScheduledRotation?: boolean;
|
|
8
|
+
/**
|
|
9
|
+
* Maximum amount of time that session data will be cached (default: use auth token lifetime to
|
|
10
|
+
* determine cache lifetime). This option is useful if the session is refreshed at some known
|
|
11
|
+
* interval (e.g., due to a secret rotation schedule).
|
|
12
|
+
*/
|
|
13
|
+
maxCacheLifetime?: number;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* A session manager that reads a token from a secret stored in AWS Secrets Manager.
|
|
17
|
+
*/
|
|
18
|
+
export declare class AwsSecretSessionManager implements SessionManager {
|
|
19
|
+
#private;
|
|
20
|
+
/**
|
|
21
|
+
* Constructor.
|
|
22
|
+
*
|
|
23
|
+
* @param secretId The name of the secret holding the token
|
|
24
|
+
* @param opts Options for the session manager
|
|
25
|
+
*/
|
|
26
|
+
constructor(secretId: string, opts?: AwsSecretSessionManagerOpts);
|
|
27
|
+
/** @inheritdoc */
|
|
28
|
+
onInvalidToken(): Promise<void>;
|
|
29
|
+
/** @inheritdoc */
|
|
30
|
+
metadata(): Promise<SessionMetadata>;
|
|
31
|
+
/** @inheritdoc */
|
|
32
|
+
token(): Promise<string>;
|
|
33
|
+
}
|
|
34
|
+
/** Manages session data stored in a secret in AWS Secrets Maanger */
|
|
35
|
+
export declare class AwsSecretManager {
|
|
36
|
+
#private;
|
|
37
|
+
/**
|
|
38
|
+
* Writes session data to the secret.
|
|
39
|
+
*
|
|
40
|
+
* @param session The session data to write
|
|
41
|
+
*/
|
|
42
|
+
update(session: SessionData): Promise<void>;
|
|
43
|
+
/**
|
|
44
|
+
* Refreshes the session and writes the new session to AWS Secrets Manager.
|
|
45
|
+
*/
|
|
46
|
+
refresh(): Promise<void>;
|
|
47
|
+
/**
|
|
48
|
+
* Constructor.
|
|
49
|
+
*
|
|
50
|
+
* @param secretId The name of the secret holding the token
|
|
51
|
+
*/
|
|
52
|
+
constructor(secretId: string);
|
|
53
|
+
}
|
|
54
|
+
export {};
|
|
55
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,WAAW,EAChB,KAAK,cAAc,EAEnB,KAAK,eAAe,EAIrB,MAAM,6BAA6B,CAAC;AAErC,6DAA6D;AAC7D,UAAU,2BAA2B;IACnC;;OAEG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,qBAAa,uBAAwB,YAAW,cAAc;;IAkB5D;;;;;OAKG;gBACS,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,2BAA2B;IAOhE,kBAAkB;IACZ,cAAc;IAIpB,kBAAkB;IACZ,QAAQ,IAAI,OAAO,CAAC,eAAe,CAAC;IAK1C,kBAAkB;IACZ,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC;CAsC/B;AAED,qEAAqE;AACrE,qBAAa,gBAAgB;;IAM3B;;;;OAIG;IACG,MAAM,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjD;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAM9B;;;;OAIG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
|
|
3
|
+
if (kind === "m") throw new TypeError("Private method is not writable");
|
|
4
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
|
|
5
|
+
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");
|
|
6
|
+
return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
|
|
7
|
+
};
|
|
8
|
+
var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
|
|
9
|
+
if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
|
|
10
|
+
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");
|
|
11
|
+
return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
|
|
12
|
+
};
|
|
13
|
+
var _AwsSecretSessionManager_instances, _AwsSecretSessionManager_opts, _AwsSecretSessionManager_sm, _AwsSecretSessionManager_secretArn, _AwsSecretSessionManager_cache, _AwsSecretSessionManager_getSessionData, _AwsSecretManager_sm, _AwsSecretManager_secretArn;
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.AwsSecretManager = exports.AwsSecretSessionManager = void 0;
|
|
16
|
+
const client_secrets_manager_1 = require("@aws-sdk/client-secrets-manager");
|
|
17
|
+
const cubesigner_sdk_1 = require("@cubist-labs/cubesigner-sdk");
|
|
18
|
+
/**
|
|
19
|
+
* A session manager that reads a token from a secret stored in AWS Secrets Manager.
|
|
20
|
+
*/
|
|
21
|
+
class AwsSecretSessionManager {
|
|
22
|
+
/**
|
|
23
|
+
* Constructor.
|
|
24
|
+
*
|
|
25
|
+
* @param secretId The name of the secret holding the token
|
|
26
|
+
* @param opts Options for the session manager
|
|
27
|
+
*/
|
|
28
|
+
constructor(secretId, opts) {
|
|
29
|
+
_AwsSecretSessionManager_instances.add(this);
|
|
30
|
+
_AwsSecretSessionManager_opts.set(this, void 0);
|
|
31
|
+
/** Client for AWS Secrets Manager */
|
|
32
|
+
_AwsSecretSessionManager_sm.set(this, void 0);
|
|
33
|
+
/** ID of the secret */
|
|
34
|
+
_AwsSecretSessionManager_secretArn.set(this, void 0);
|
|
35
|
+
/** Cache for the session data */
|
|
36
|
+
_AwsSecretSessionManager_cache.set(this, void 0);
|
|
37
|
+
__classPrivateFieldSet(this, _AwsSecretSessionManager_sm, new client_secrets_manager_1.SecretsManager(), "f");
|
|
38
|
+
__classPrivateFieldSet(this, _AwsSecretSessionManager_secretArn, secretId, "f");
|
|
39
|
+
__classPrivateFieldSet(this, _AwsSecretSessionManager_cache, undefined, "f");
|
|
40
|
+
__classPrivateFieldSet(this, _AwsSecretSessionManager_opts, opts, "f");
|
|
41
|
+
}
|
|
42
|
+
/** @inheritdoc */
|
|
43
|
+
async onInvalidToken() {
|
|
44
|
+
__classPrivateFieldSet(this, _AwsSecretSessionManager_cache, undefined, "f");
|
|
45
|
+
}
|
|
46
|
+
/** @inheritdoc */
|
|
47
|
+
async metadata() {
|
|
48
|
+
const data = await __classPrivateFieldGet(this, _AwsSecretSessionManager_instances, "m", _AwsSecretSessionManager_getSessionData).call(this);
|
|
49
|
+
return (0, cubesigner_sdk_1.metadata)(data);
|
|
50
|
+
}
|
|
51
|
+
/** @inheritdoc */
|
|
52
|
+
async token() {
|
|
53
|
+
const data = await __classPrivateFieldGet(this, _AwsSecretSessionManager_instances, "m", _AwsSecretSessionManager_getSessionData).call(this);
|
|
54
|
+
return data.token;
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
exports.AwsSecretSessionManager = AwsSecretSessionManager;
|
|
58
|
+
_AwsSecretSessionManager_opts = new WeakMap(), _AwsSecretSessionManager_sm = new WeakMap(), _AwsSecretSessionManager_secretArn = new WeakMap(), _AwsSecretSessionManager_cache = new WeakMap(), _AwsSecretSessionManager_instances = new WeakSet(), _AwsSecretSessionManager_getSessionData =
|
|
59
|
+
/**
|
|
60
|
+
* Get the session data either from cache or from AWS Secrets Manager if no unexpired cached
|
|
61
|
+
* information is available.
|
|
62
|
+
*
|
|
63
|
+
* @returns The session data
|
|
64
|
+
*/
|
|
65
|
+
async function _AwsSecretSessionManager_getSessionData() {
|
|
66
|
+
if (__classPrivateFieldGet(this, _AwsSecretSessionManager_cache, "f") !== undefined && __classPrivateFieldGet(this, _AwsSecretSessionManager_cache, "f").exp > Date.now() / 1000) {
|
|
67
|
+
return __classPrivateFieldGet(this, _AwsSecretSessionManager_cache, "f").sessionData;
|
|
68
|
+
}
|
|
69
|
+
const res = await __classPrivateFieldGet(this, _AwsSecretSessionManager_sm, "f").getSecretValue({ SecretId: __classPrivateFieldGet(this, _AwsSecretSessionManager_secretArn, "f") });
|
|
70
|
+
const sessionData = (0, cubesigner_sdk_1.parseBase64SessionData)(res.SecretString);
|
|
71
|
+
const maxCacheLifetime = __classPrivateFieldGet(this, _AwsSecretSessionManager_opts, "f")?.maxCacheLifetime;
|
|
72
|
+
let exp = maxCacheLifetime !== undefined
|
|
73
|
+
? Math.min(Date.now() / 1000 + maxCacheLifetime, sessionData.session_info.auth_token_exp)
|
|
74
|
+
: sessionData.session_info.auth_token_exp;
|
|
75
|
+
// Limit cache lifetime by the next scheduled rotation if the user requested it
|
|
76
|
+
if (__classPrivateFieldGet(this, _AwsSecretSessionManager_opts, "f")?.checkScheduledRotation ?? true) {
|
|
77
|
+
const desc = await __classPrivateFieldGet(this, _AwsSecretSessionManager_sm, "f").describeSecret({ SecretId: __classPrivateFieldGet(this, _AwsSecretSessionManager_secretArn, "f") });
|
|
78
|
+
if (desc.NextRotationDate !== undefined) {
|
|
79
|
+
exp = Math.min(exp, desc.NextRotationDate.getTime() / 1000);
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
__classPrivateFieldSet(this, _AwsSecretSessionManager_cache, {
|
|
83
|
+
sessionData,
|
|
84
|
+
exp,
|
|
85
|
+
}, "f");
|
|
86
|
+
return __classPrivateFieldGet(this, _AwsSecretSessionManager_cache, "f").sessionData;
|
|
87
|
+
};
|
|
88
|
+
/** Manages session data stored in a secret in AWS Secrets Maanger */
|
|
89
|
+
class AwsSecretManager {
|
|
90
|
+
/**
|
|
91
|
+
* Writes session data to the secret.
|
|
92
|
+
*
|
|
93
|
+
* @param session The session data to write
|
|
94
|
+
*/
|
|
95
|
+
async update(session) {
|
|
96
|
+
await __classPrivateFieldGet(this, _AwsSecretManager_sm, "f").updateSecret({
|
|
97
|
+
SecretId: __classPrivateFieldGet(this, _AwsSecretManager_secretArn, "f"),
|
|
98
|
+
SecretString: (0, cubesigner_sdk_1.serializeBase64SessionData)(session),
|
|
99
|
+
});
|
|
100
|
+
}
|
|
101
|
+
/**
|
|
102
|
+
* Refreshes the session and writes the new session to AWS Secrets Manager.
|
|
103
|
+
*/
|
|
104
|
+
async refresh() {
|
|
105
|
+
const res = await __classPrivateFieldGet(this, _AwsSecretManager_sm, "f").getSecretValue({ SecretId: __classPrivateFieldGet(this, _AwsSecretManager_secretArn, "f") });
|
|
106
|
+
const newSessionData = await (0, cubesigner_sdk_1.refresh)((0, cubesigner_sdk_1.parseBase64SessionData)(res.SecretString));
|
|
107
|
+
await this.update(newSessionData);
|
|
108
|
+
}
|
|
109
|
+
/**
|
|
110
|
+
* Constructor.
|
|
111
|
+
*
|
|
112
|
+
* @param secretId The name of the secret holding the token
|
|
113
|
+
*/
|
|
114
|
+
constructor(secretId) {
|
|
115
|
+
/** Client for AWS Secrets Manager */
|
|
116
|
+
_AwsSecretManager_sm.set(this, void 0);
|
|
117
|
+
/** ID of the secret */
|
|
118
|
+
_AwsSecretManager_secretArn.set(this, void 0);
|
|
119
|
+
__classPrivateFieldSet(this, _AwsSecretManager_sm, new client_secrets_manager_1.SecretsManager(), "f");
|
|
120
|
+
__classPrivateFieldSet(this, _AwsSecretManager_secretArn, secretId, "f");
|
|
121
|
+
}
|
|
122
|
+
}
|
|
123
|
+
exports.AwsSecretManager = AwsSecretManager;
|
|
124
|
+
_AwsSecretManager_sm = new WeakMap(), _AwsSecretManager_secretArn = new WeakMap();
|
|
125
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,4EAAiE;AACjE,gEAQqC;AAgBrC;;GAEG;AACH,MAAa,uBAAuB;IAkBlC;;;;;OAKG;IACH,YAAY,QAAgB,EAAE,IAAkC;;QAvBhE,gDAA+C;QAC/C,qCAAqC;QACrC,8CAAoB;QACpB,uBAAuB;QACvB,qDAAmB;QACnB,iCAAiC;QACjC,iDASc;QASZ,uBAAA,IAAI,+BAAO,IAAI,uCAAc,EAAE,MAAA,CAAC;QAChC,uBAAA,IAAI,sCAAc,QAAQ,MAAA,CAAC;QAC3B,uBAAA,IAAI,kCAAU,SAAS,MAAA,CAAC;QACxB,uBAAA,IAAI,iCAAS,IAAI,MAAA,CAAC;IACpB,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,cAAc;QAClB,uBAAA,IAAI,kCAAU,SAAS,MAAA,CAAC;IAC1B,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,QAAQ;QACZ,MAAM,IAAI,GAAG,MAAM,uBAAA,IAAI,mFAAgB,MAApB,IAAI,CAAkB,CAAC;QAC1C,OAAO,IAAA,yBAAQ,EAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,KAAK;QACT,MAAM,IAAI,GAAG,MAAM,uBAAA,IAAI,mFAAgB,MAApB,IAAI,CAAkB,CAAC;QAC1C,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CAmCF;AAjFD,0DAiFC;;AAjCC;;;;;GAKG;AACH,KAAK;IACH,IAAI,uBAAA,IAAI,sCAAO,KAAK,SAAS,IAAI,uBAAA,IAAI,sCAAO,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;QACrE,OAAO,uBAAA,IAAI,sCAAO,CAAC,WAAW,CAAC;IACjC,CAAC;IAED,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,mCAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,uBAAA,IAAI,0CAAW,EAAE,CAAC,CAAC;IACzE,MAAM,WAAW,GAAG,IAAA,uCAAsB,EAAC,GAAG,CAAC,YAAa,CAAC,CAAC;IAC9D,MAAM,gBAAgB,GAAG,uBAAA,IAAI,qCAAM,EAAE,gBAAgB,CAAC;IACtD,IAAI,GAAG,GACL,gBAAgB,KAAK,SAAS;QAC5B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,gBAAgB,EAAE,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC;QACzF,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,cAAc,CAAC;IAE9C,+EAA+E;IAC/E,IAAI,uBAAA,IAAI,qCAAM,EAAE,sBAAsB,IAAI,IAAI,EAAE,CAAC;QAC/C,MAAM,IAAI,GAAG,MAAM,uBAAA,IAAI,mCAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,uBAAA,IAAI,0CAAW,EAAE,CAAC,CAAC;QAC1E,IAAI,IAAI,CAAC,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACxC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;QAC9D,CAAC;IACH,CAAC;IAED,uBAAA,IAAI,kCAAU;QACZ,WAAW;QACX,GAAG;KACJ,MAAA,CAAC;IACF,OAAO,uBAAA,IAAI,sCAAO,CAAC,WAAW,CAAC;AACjC,CAAC;AAGH,qEAAqE;AACrE,MAAa,gBAAgB;IAM3B;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,OAAoB;QAC/B,MAAM,uBAAA,IAAI,4BAAI,CAAC,YAAY,CAAC;YAC1B,QAAQ,EAAE,uBAAA,IAAI,mCAAW;YACzB,YAAY,EAAE,IAAA,2CAA0B,EAAC,OAAO,CAAC;SAClD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO;QACX,MAAM,GAAG,GAAG,MAAM,uBAAA,IAAI,4BAAI,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,uBAAA,IAAI,mCAAW,EAAE,CAAC,CAAC;QACzE,MAAM,cAAc,GAAG,MAAM,IAAA,wBAAO,EAAC,IAAA,uCAAsB,EAAC,GAAG,CAAC,YAAa,CAAC,CAAC,CAAC;QAChF,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;IACpC,CAAC;IAED;;;;OAIG;IACH,YAAY,QAAgB;QA/B5B,qCAAqC;QACrC,uCAAoB;QACpB,uBAAuB;QACvB,8CAAmB;QA6BjB,uBAAA,IAAI,wBAAO,IAAI,uCAAc,EAAE,MAAA,CAAC;QAChC,uBAAA,IAAI,+BAAc,QAAQ,MAAA,CAAC;IAC7B,CAAC;CACF;AApCD,4CAoCC","sourcesContent":["import { SecretsManager } from \"@aws-sdk/client-secrets-manager\";\nimport {\n  type SessionData,\n  type SessionManager,\n  metadata,\n  type SessionMetadata,\n  refresh,\n  parseBase64SessionData,\n  serializeBase64SessionData,\n} from \"@cubist-labs/cubesigner-sdk\";\n\n/** Options for AWS Secrets Manager-backed session manager */\ninterface AwsSecretSessionManagerOpts {\n  /**\n   * Limit the cache lifetime by the scheduled rotation of the secret (default: true)\n   */\n  checkScheduledRotation?: boolean;\n  /**\n   * Maximum amount of time that session data will be cached (default: use auth token lifetime to\n   * determine cache lifetime). This option is useful if the session is refreshed at some known\n   * interval (e.g., due to a secret rotation schedule).\n   */\n  maxCacheLifetime?: number;\n}\n\n/**\n * A session manager that reads a token from a secret stored in AWS Secrets Manager.\n */\nexport class AwsSecretSessionManager implements SessionManager {\n  #opts: AwsSecretSessionManagerOpts | undefined;\n  /** Client for AWS Secrets Manager */\n  #sm: SecretsManager;\n  /** ID of the secret */\n  #secretArn: string;\n  /** Cache for the session data */\n  #cache:\n    | {\n        /** The session data */\n        sessionData: SessionData;\n        /**\n         * The expiration of the cache (may be different from the expiration time of the token itself)\n         */\n        exp: number;\n      }\n    | undefined;\n\n  /**\n   * Constructor.\n   *\n   * @param secretId The name of the secret holding the token\n   * @param opts Options for the session manager\n   */\n  constructor(secretId: string, opts?: AwsSecretSessionManagerOpts) {\n    this.#sm = new SecretsManager();\n    this.#secretArn = secretId;\n    this.#cache = undefined;\n    this.#opts = opts;\n  }\n\n  /** @inheritdoc */\n  async onInvalidToken() {\n    this.#cache = undefined;\n  }\n\n  /** @inheritdoc */\n  async metadata(): Promise<SessionMetadata> {\n    const data = await this.#getSessionData();\n    return metadata(data);\n  }\n\n  /** @inheritdoc */\n  async token(): Promise<string> {\n    const data = await this.#getSessionData();\n    return data.token;\n  }\n\n  /**\n   * Get the session data either from cache or from AWS Secrets Manager if no unexpired cached\n   * information is available.\n   *\n   * @returns The session data\n   */\n  async #getSessionData(): Promise<SessionData> {\n    if (this.#cache !== undefined && this.#cache.exp > Date.now() / 1000) {\n      return this.#cache.sessionData;\n    }\n\n    const res = await this.#sm.getSecretValue({ SecretId: this.#secretArn });\n    const sessionData = parseBase64SessionData(res.SecretString!);\n    const maxCacheLifetime = this.#opts?.maxCacheLifetime;\n    let exp =\n      maxCacheLifetime !== undefined\n        ? Math.min(Date.now() / 1000 + maxCacheLifetime, sessionData.session_info.auth_token_exp)\n        : sessionData.session_info.auth_token_exp;\n\n    // Limit cache lifetime by the next scheduled rotation if the user requested it\n    if (this.#opts?.checkScheduledRotation ?? true) {\n      const desc = await this.#sm.describeSecret({ SecretId: this.#secretArn });\n      if (desc.NextRotationDate !== undefined) {\n        exp = Math.min(exp, desc.NextRotationDate.getTime() / 1000);\n      }\n    }\n\n    this.#cache = {\n      sessionData,\n      exp,\n    };\n    return this.#cache.sessionData;\n  }\n}\n\n/** Manages session data stored in a secret in AWS Secrets Maanger */\nexport class AwsSecretManager {\n  /** Client for AWS Secrets Manager */\n  #sm: SecretsManager;\n  /** ID of the secret */\n  #secretArn: string;\n\n  /**\n   * Writes session data to the secret.\n   *\n   * @param session The session data to write\n   */\n  async update(session: SessionData): Promise<void> {\n    await this.#sm.updateSecret({\n      SecretId: this.#secretArn,\n      SecretString: serializeBase64SessionData(session),\n    });\n  }\n\n  /**\n   * Refreshes the session and writes the new session to AWS Secrets Manager.\n   */\n  async refresh(): Promise<void> {\n    const res = await this.#sm.getSecretValue({ SecretId: this.#secretArn });\n    const newSessionData = await refresh(parseBase64SessionData(res.SecretString!));\n    await this.update(newSessionData);\n  }\n\n  /**\n   * Constructor.\n   *\n   * @param secretId The name of the secret holding the token\n   */\n  constructor(secretId: string) {\n    this.#sm = new SecretsManager();\n    this.#secretArn = secretId;\n  }\n}\n"]}
|
package/package.json
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@cubist-labs/cubesigner-sdk-secretsmanager-storage",
|
|
3
|
+
"version": "0.4.97-0",
|
|
4
|
+
"description": "CubeSigner SDK session manager backed by AWS Secrets Manager",
|
|
5
|
+
"license": "MIT OR Apache-2.0",
|
|
6
|
+
"author": "Cubist, Inc.",
|
|
7
|
+
"main": "dist/index.js",
|
|
8
|
+
"types": "dist/index.d.ts",
|
|
9
|
+
"files": [
|
|
10
|
+
"tsconfig.json",
|
|
11
|
+
"src/**",
|
|
12
|
+
"dist/**",
|
|
13
|
+
"../../NOTICE",
|
|
14
|
+
"../../LICENSE-APACHE",
|
|
15
|
+
"../../LICENSE-MIT"
|
|
16
|
+
],
|
|
17
|
+
"scripts": {
|
|
18
|
+
"build": "tsc",
|
|
19
|
+
"prepack": "tsc",
|
|
20
|
+
"test": "npx --node-options='--experimental-vm-modules' jest --maxWorkers=1"
|
|
21
|
+
},
|
|
22
|
+
"peerDependencies": {
|
|
23
|
+
"@cubist-labs/cubesigner-sdk": "^0.4.97-0"
|
|
24
|
+
},
|
|
25
|
+
"directories": {
|
|
26
|
+
"test": "test"
|
|
27
|
+
},
|
|
28
|
+
"dependencies": {
|
|
29
|
+
"@aws-sdk/client-secrets-manager": "^3.682.0"
|
|
30
|
+
},
|
|
31
|
+
"devDependencies": {
|
|
32
|
+
"aws-sdk-client-mock": "^4.1.0"
|
|
33
|
+
}
|
|
34
|
+
}
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
import { SecretsManager } from "@aws-sdk/client-secrets-manager";
|
|
2
|
+
import {
|
|
3
|
+
type SessionData,
|
|
4
|
+
type SessionManager,
|
|
5
|
+
metadata,
|
|
6
|
+
type SessionMetadata,
|
|
7
|
+
refresh,
|
|
8
|
+
parseBase64SessionData,
|
|
9
|
+
serializeBase64SessionData,
|
|
10
|
+
} from "@cubist-labs/cubesigner-sdk";
|
|
11
|
+
|
|
12
|
+
/** Options for AWS Secrets Manager-backed session manager */
|
|
13
|
+
interface AwsSecretSessionManagerOpts {
|
|
14
|
+
/**
|
|
15
|
+
* Limit the cache lifetime by the scheduled rotation of the secret (default: true)
|
|
16
|
+
*/
|
|
17
|
+
checkScheduledRotation?: boolean;
|
|
18
|
+
/**
|
|
19
|
+
* Maximum amount of time that session data will be cached (default: use auth token lifetime to
|
|
20
|
+
* determine cache lifetime). This option is useful if the session is refreshed at some known
|
|
21
|
+
* interval (e.g., due to a secret rotation schedule).
|
|
22
|
+
*/
|
|
23
|
+
maxCacheLifetime?: number;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
/**
|
|
27
|
+
* A session manager that reads a token from a secret stored in AWS Secrets Manager.
|
|
28
|
+
*/
|
|
29
|
+
export class AwsSecretSessionManager implements SessionManager {
|
|
30
|
+
#opts: AwsSecretSessionManagerOpts | undefined;
|
|
31
|
+
/** Client for AWS Secrets Manager */
|
|
32
|
+
#sm: SecretsManager;
|
|
33
|
+
/** ID of the secret */
|
|
34
|
+
#secretArn: string;
|
|
35
|
+
/** Cache for the session data */
|
|
36
|
+
#cache:
|
|
37
|
+
| {
|
|
38
|
+
/** The session data */
|
|
39
|
+
sessionData: SessionData;
|
|
40
|
+
/**
|
|
41
|
+
* The expiration of the cache (may be different from the expiration time of the token itself)
|
|
42
|
+
*/
|
|
43
|
+
exp: number;
|
|
44
|
+
}
|
|
45
|
+
| undefined;
|
|
46
|
+
|
|
47
|
+
/**
|
|
48
|
+
* Constructor.
|
|
49
|
+
*
|
|
50
|
+
* @param secretId The name of the secret holding the token
|
|
51
|
+
* @param opts Options for the session manager
|
|
52
|
+
*/
|
|
53
|
+
constructor(secretId: string, opts?: AwsSecretSessionManagerOpts) {
|
|
54
|
+
this.#sm = new SecretsManager();
|
|
55
|
+
this.#secretArn = secretId;
|
|
56
|
+
this.#cache = undefined;
|
|
57
|
+
this.#opts = opts;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/** @inheritdoc */
|
|
61
|
+
async onInvalidToken() {
|
|
62
|
+
this.#cache = undefined;
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/** @inheritdoc */
|
|
66
|
+
async metadata(): Promise<SessionMetadata> {
|
|
67
|
+
const data = await this.#getSessionData();
|
|
68
|
+
return metadata(data);
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
/** @inheritdoc */
|
|
72
|
+
async token(): Promise<string> {
|
|
73
|
+
const data = await this.#getSessionData();
|
|
74
|
+
return data.token;
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* Get the session data either from cache or from AWS Secrets Manager if no unexpired cached
|
|
79
|
+
* information is available.
|
|
80
|
+
*
|
|
81
|
+
* @returns The session data
|
|
82
|
+
*/
|
|
83
|
+
async #getSessionData(): Promise<SessionData> {
|
|
84
|
+
if (this.#cache !== undefined && this.#cache.exp > Date.now() / 1000) {
|
|
85
|
+
return this.#cache.sessionData;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
const res = await this.#sm.getSecretValue({ SecretId: this.#secretArn });
|
|
89
|
+
const sessionData = parseBase64SessionData(res.SecretString!);
|
|
90
|
+
const maxCacheLifetime = this.#opts?.maxCacheLifetime;
|
|
91
|
+
let exp =
|
|
92
|
+
maxCacheLifetime !== undefined
|
|
93
|
+
? Math.min(Date.now() / 1000 + maxCacheLifetime, sessionData.session_info.auth_token_exp)
|
|
94
|
+
: sessionData.session_info.auth_token_exp;
|
|
95
|
+
|
|
96
|
+
// Limit cache lifetime by the next scheduled rotation if the user requested it
|
|
97
|
+
if (this.#opts?.checkScheduledRotation ?? true) {
|
|
98
|
+
const desc = await this.#sm.describeSecret({ SecretId: this.#secretArn });
|
|
99
|
+
if (desc.NextRotationDate !== undefined) {
|
|
100
|
+
exp = Math.min(exp, desc.NextRotationDate.getTime() / 1000);
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
this.#cache = {
|
|
105
|
+
sessionData,
|
|
106
|
+
exp,
|
|
107
|
+
};
|
|
108
|
+
return this.#cache.sessionData;
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
/** Manages session data stored in a secret in AWS Secrets Maanger */
|
|
113
|
+
export class AwsSecretManager {
|
|
114
|
+
/** Client for AWS Secrets Manager */
|
|
115
|
+
#sm: SecretsManager;
|
|
116
|
+
/** ID of the secret */
|
|
117
|
+
#secretArn: string;
|
|
118
|
+
|
|
119
|
+
/**
|
|
120
|
+
* Writes session data to the secret.
|
|
121
|
+
*
|
|
122
|
+
* @param session The session data to write
|
|
123
|
+
*/
|
|
124
|
+
async update(session: SessionData): Promise<void> {
|
|
125
|
+
await this.#sm.updateSecret({
|
|
126
|
+
SecretId: this.#secretArn,
|
|
127
|
+
SecretString: serializeBase64SessionData(session),
|
|
128
|
+
});
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
/**
|
|
132
|
+
* Refreshes the session and writes the new session to AWS Secrets Manager.
|
|
133
|
+
*/
|
|
134
|
+
async refresh(): Promise<void> {
|
|
135
|
+
const res = await this.#sm.getSecretValue({ SecretId: this.#secretArn });
|
|
136
|
+
const newSessionData = await refresh(parseBase64SessionData(res.SecretString!));
|
|
137
|
+
await this.update(newSessionData);
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* Constructor.
|
|
142
|
+
*
|
|
143
|
+
* @param secretId The name of the secret holding the token
|
|
144
|
+
*/
|
|
145
|
+
constructor(secretId: string) {
|
|
146
|
+
this.#sm = new SecretsManager();
|
|
147
|
+
this.#secretArn = secretId;
|
|
148
|
+
}
|
|
149
|
+
}
|
package/tsconfig.json
ADDED