@typespec/ts-http-runtime 1.0.0-alpha.20231023.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +159 -0
- package/dist/index.js +3509 -0
- package/dist/index.js.map +1 -0
- package/dist-esm/src/abort-controller/AbortError.js +27 -0
- package/dist-esm/src/abort-controller/AbortError.js.map +1 -0
- package/dist-esm/src/abort-controller/AbortSignalLike.js +4 -0
- package/dist-esm/src/abort-controller/AbortSignalLike.js.map +1 -0
- package/dist-esm/src/accessTokenCache.js +32 -0
- package/dist-esm/src/accessTokenCache.js.map +1 -0
- package/dist-esm/src/auth/keyCredential.js +4 -0
- package/dist-esm/src/auth/keyCredential.js.map +1 -0
- package/dist-esm/src/auth/tokenCredential.js +19 -0
- package/dist-esm/src/auth/tokenCredential.js.map +1 -0
- package/dist-esm/src/client/apiVersionPolicy.js +23 -0
- package/dist-esm/src/client/apiVersionPolicy.js.map +1 -0
- package/dist-esm/src/client/clientHelpers.js +52 -0
- package/dist-esm/src/client/clientHelpers.js.map +1 -0
- package/dist-esm/src/client/common.js +4 -0
- package/dist-esm/src/client/common.js.map +1 -0
- package/dist-esm/src/client/getClient.js +86 -0
- package/dist-esm/src/client/getClient.js.map +1 -0
- package/dist-esm/src/client/helpers/getBinaryBody.js +13 -0
- package/dist-esm/src/client/helpers/getBinaryBody.js.map +1 -0
- package/dist-esm/src/client/helpers/isReadableStream.browser.js +12 -0
- package/dist-esm/src/client/helpers/isReadableStream.browser.js.map +1 -0
- package/dist-esm/src/client/helpers/isReadableStream.js +10 -0
- package/dist-esm/src/client/helpers/isReadableStream.js.map +1 -0
- package/dist-esm/src/client/keyCredentialAuthenticationPolicy.js +16 -0
- package/dist-esm/src/client/keyCredentialAuthenticationPolicy.js.map +1 -0
- package/dist-esm/src/client/operationOptionHelpers.js +22 -0
- package/dist-esm/src/client/operationOptionHelpers.js.map +1 -0
- package/dist-esm/src/client/restError.js +27 -0
- package/dist-esm/src/client/restError.js.map +1 -0
- package/dist-esm/src/client/sendRequest.js +195 -0
- package/dist-esm/src/client/sendRequest.js.map +1 -0
- package/dist-esm/src/client/urlHelpers.js +100 -0
- package/dist-esm/src/client/urlHelpers.js.map +1 -0
- package/dist-esm/src/constants.js +5 -0
- package/dist-esm/src/constants.js.map +1 -0
- package/dist-esm/src/createPipelineFromOptions.js +39 -0
- package/dist-esm/src/createPipelineFromOptions.js.map +1 -0
- package/dist-esm/src/defaultHttpClient.browser.js +10 -0
- package/dist-esm/src/defaultHttpClient.browser.js.map +1 -0
- package/dist-esm/src/defaultHttpClient.js +10 -0
- package/dist-esm/src/defaultHttpClient.js.map +1 -0
- package/dist-esm/src/defaultHttpClient.native.js +10 -0
- package/dist-esm/src/defaultHttpClient.native.js.map +1 -0
- package/dist-esm/src/fetchHttpClient.js +268 -0
- package/dist-esm/src/fetchHttpClient.js.map +1 -0
- package/dist-esm/src/httpHeaders.js +89 -0
- package/dist-esm/src/httpHeaders.js.map +1 -0
- package/dist-esm/src/index.js +41 -0
- package/dist-esm/src/index.js.map +1 -0
- package/dist-esm/src/interfaces.js +4 -0
- package/dist-esm/src/interfaces.js.map +1 -0
- package/dist-esm/src/log.js +5 -0
- package/dist-esm/src/log.js.map +1 -0
- package/dist-esm/src/logger/debug.js +93 -0
- package/dist-esm/src/logger/debug.js.map +1 -0
- package/dist-esm/src/logger/log.browser.js +23 -0
- package/dist-esm/src/logger/log.browser.js.map +1 -0
- package/dist-esm/src/logger/log.js +8 -0
- package/dist-esm/src/logger/log.js.map +1 -0
- package/dist-esm/src/logger/logger.js +99 -0
- package/dist-esm/src/logger/logger.js.map +1 -0
- package/dist-esm/src/nodeHttpClient.js +332 -0
- package/dist-esm/src/nodeHttpClient.js.map +1 -0
- package/dist-esm/src/pipeline.js +262 -0
- package/dist-esm/src/pipeline.js.map +1 -0
- package/dist-esm/src/pipelineRequest.js +35 -0
- package/dist-esm/src/pipelineRequest.js.map +1 -0
- package/dist-esm/src/policies/bearerTokenAuthenticationPolicy.js +108 -0
- package/dist-esm/src/policies/bearerTokenAuthenticationPolicy.js.map +1 -0
- package/dist-esm/src/policies/decompressResponsePolicy.browser.js +14 -0
- package/dist-esm/src/policies/decompressResponsePolicy.browser.js.map +1 -0
- package/dist-esm/src/policies/decompressResponsePolicy.js +23 -0
- package/dist-esm/src/policies/decompressResponsePolicy.js.map +1 -0
- package/dist-esm/src/policies/defaultRetryPolicy.js +26 -0
- package/dist-esm/src/policies/defaultRetryPolicy.js.map +1 -0
- package/dist-esm/src/policies/exponentialRetryPolicy.js +22 -0
- package/dist-esm/src/policies/exponentialRetryPolicy.js.map +1 -0
- package/dist-esm/src/policies/formDataPolicy.browser.js +43 -0
- package/dist-esm/src/policies/formDataPolicy.browser.js.map +1 -0
- package/dist-esm/src/policies/formDataPolicy.js +79 -0
- package/dist-esm/src/policies/formDataPolicy.js.map +1 -0
- package/dist-esm/src/policies/logPolicy.js +34 -0
- package/dist-esm/src/policies/logPolicy.js.map +1 -0
- package/dist-esm/src/policies/proxyPolicy.browser.js +27 -0
- package/dist-esm/src/policies/proxyPolicy.browser.js.map +1 -0
- package/dist-esm/src/policies/proxyPolicy.js +190 -0
- package/dist-esm/src/policies/proxyPolicy.js.map +1 -0
- package/dist-esm/src/policies/redirectPolicy.js +52 -0
- package/dist-esm/src/policies/redirectPolicy.js.map +1 -0
- package/dist-esm/src/policies/retryPolicy.js +106 -0
- package/dist-esm/src/policies/retryPolicy.js.map +1 -0
- package/dist-esm/src/policies/systemErrorRetryPolicy.js +27 -0
- package/dist-esm/src/policies/systemErrorRetryPolicy.js.map +1 -0
- package/dist-esm/src/policies/throttlingRetryPolicy.js +29 -0
- package/dist-esm/src/policies/throttlingRetryPolicy.js.map +1 -0
- package/dist-esm/src/policies/tlsPolicy.js +22 -0
- package/dist-esm/src/policies/tlsPolicy.js.map +1 -0
- package/dist-esm/src/policies/tracingPolicy.js +120 -0
- package/dist-esm/src/policies/tracingPolicy.js.map +1 -0
- package/dist-esm/src/policies/userAgentPolicy.js +26 -0
- package/dist-esm/src/policies/userAgentPolicy.js.map +1 -0
- package/dist-esm/src/restError.js +48 -0
- package/dist-esm/src/restError.js.map +1 -0
- package/dist-esm/src/retryStrategies/exponentialRetryStrategy.js +70 -0
- package/dist-esm/src/retryStrategies/exponentialRetryStrategy.js.map +1 -0
- package/dist-esm/src/retryStrategies/retryStrategy.js +4 -0
- package/dist-esm/src/retryStrategies/retryStrategy.js.map +1 -0
- package/dist-esm/src/retryStrategies/throttlingRetryStrategy.js +74 -0
- package/dist-esm/src/retryStrategies/throttlingRetryStrategy.js.map +1 -0
- package/dist-esm/src/tracing/instrumenter.js +61 -0
- package/dist-esm/src/tracing/instrumenter.js.map +1 -0
- package/dist-esm/src/tracing/interfaces.js +4 -0
- package/dist-esm/src/tracing/interfaces.js.map +1 -0
- package/dist-esm/src/tracing/tracingClient.js +74 -0
- package/dist-esm/src/tracing/tracingClient.js.map +1 -0
- package/dist-esm/src/tracing/tracingContext.js +47 -0
- package/dist-esm/src/tracing/tracingContext.js.map +1 -0
- package/dist-esm/src/util/aborterUtils.js +21 -0
- package/dist-esm/src/util/aborterUtils.js.map +1 -0
- package/dist-esm/src/util/base64.browser.js +35 -0
- package/dist-esm/src/util/base64.browser.js.map +1 -0
- package/dist-esm/src/util/bytesEncoding.browser.js +82 -0
- package/dist-esm/src/util/bytesEncoding.browser.js.map +1 -0
- package/dist-esm/src/util/bytesEncoding.js +77 -0
- package/dist-esm/src/util/bytesEncoding.js.map +1 -0
- package/dist-esm/src/util/checkEnvironment.js +36 -0
- package/dist-esm/src/util/checkEnvironment.js.map +1 -0
- package/dist-esm/src/util/createAbortablePromise.js +42 -0
- package/dist-esm/src/util/createAbortablePromise.js.map +1 -0
- package/dist-esm/src/util/delay.js +22 -0
- package/dist-esm/src/util/delay.js.map +1 -0
- package/dist-esm/src/util/error.js +42 -0
- package/dist-esm/src/util/error.js.map +1 -0
- package/dist-esm/src/util/helpers.js +58 -0
- package/dist-esm/src/util/helpers.js.map +1 -0
- package/dist-esm/src/util/hex.js +21 -0
- package/dist-esm/src/util/hex.js.map +1 -0
- package/dist-esm/src/util/inspect.browser.js +4 -0
- package/dist-esm/src/util/inspect.browser.js.map +1 -0
- package/dist-esm/src/util/inspect.js +5 -0
- package/dist-esm/src/util/inspect.js.map +1 -0
- package/dist-esm/src/util/object.js +14 -0
- package/dist-esm/src/util/object.js.map +1 -0
- package/dist-esm/src/util/random.js +21 -0
- package/dist-esm/src/util/random.js.map +1 -0
- package/dist-esm/src/util/sanitizer.js +139 -0
- package/dist-esm/src/util/sanitizer.js.map +1 -0
- package/dist-esm/src/util/sha256.browser.js +61 -0
- package/dist-esm/src/util/sha256.browser.js.map +1 -0
- package/dist-esm/src/util/sha256.js +22 -0
- package/dist-esm/src/util/sha256.js.map +1 -0
- package/dist-esm/src/util/tokenCycler.js +149 -0
- package/dist-esm/src/util/tokenCycler.js.map +1 -0
- package/dist-esm/src/util/typeGuards.js +34 -0
- package/dist-esm/src/util/typeGuards.js.map +1 -0
- package/dist-esm/src/util/userAgent.js +30 -0
- package/dist-esm/src/util/userAgent.js.map +1 -0
- package/dist-esm/src/util/userAgentPlatform.browser.js +20 -0
- package/dist-esm/src/util/userAgentPlatform.browser.js.map +1 -0
- package/dist-esm/src/util/userAgentPlatform.js +17 -0
- package/dist-esm/src/util/userAgentPlatform.js.map +1 -0
- package/dist-esm/src/util/userAgentPlatform.native.js +24 -0
- package/dist-esm/src/util/userAgentPlatform.native.js.map +1 -0
- package/dist-esm/src/util/utf8.browser.js +26 -0
- package/dist-esm/src/util/utf8.browser.js.map +1 -0
- package/dist-esm/src/util/uuidUtils.browser.js +17 -0
- package/dist-esm/src/util/uuidUtils.browser.js.map +1 -0
- package/dist-esm/src/util/uuidUtils.js +22 -0
- package/dist-esm/src/util/uuidUtils.js.map +1 -0
- package/dist-esm/src/util/uuidUtils.native.js +43 -0
- package/dist-esm/src/util/uuidUtils.native.js.map +1 -0
- package/dist-esm/src/xhrHttpClient.js +177 -0
- package/dist-esm/src/xhrHttpClient.js.map +1 -0
- package/package.json +134 -0
- package/ts-http-runtime.shims.d.ts +12 -0
- package/types/ts-http-runtime.d.ts +2062 -0
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../../src/util/helpers.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAI5D,MAAM,oBAAoB,GAAG,4BAA4B,CAAC;AAE1D;;;;;;;;GAQG;AACH,MAAM,UAAU,KAAK,CACnB,SAAiB,EACjB,KAAS,EACT,OAGC;IAED,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,IAAI,KAAK,GAA8C,SAAS,CAAC;QACjE,IAAI,SAAS,GAA6B,SAAS,CAAC;QAEpD,MAAM,aAAa,GAAG,GAAS,EAAE;YAC/B,OAAO,MAAM,CACX,IAAI,UAAU,CAAC,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa,EAAC,CAAC,CAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,aAAa,CAAC,CAAC,CAAC,oBAAoB,CAAC,CACvF,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,eAAe,GAAG,GAAS,EAAE;YACjC,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,KAAI,SAAS,EAAE;gBACrC,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;aAC7D;QACH,CAAC,CAAC;QAEF,SAAS,GAAG,GAAS,EAAE;YACrB,IAAI,KAAK,EAAE;gBACT,YAAY,CAAC,KAAK,CAAC,CAAC;aACrB;YACD,eAAe,EAAE,CAAC;YAClB,OAAO,aAAa,EAAE,CAAC;QACzB,CAAC,CAAC;QAEF,IAAI,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,KAAI,OAAO,CAAC,WAAW,CAAC,OAAO,EAAE;YACvD,OAAO,aAAa,EAAE,CAAC;SACxB;QAED,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;YACtB,eAAe,EAAE,CAAC;YAClB,OAAO,CAAC,KAAK,CAAC,CAAC;QACjB,CAAC,EAAE,SAAS,CAAC,CAAC;QAEd,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,WAAW,EAAE;YACxB,OAAO,CAAC,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;SAC1D;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CACtC,QAA0B,EAC1B,UAAkB;IAElB,MAAM,KAAK,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;IAC/C,IAAI,CAAC,KAAK;QAAE,OAAO;IACnB,MAAM,UAAU,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;QAAE,OAAO;IACrC,OAAO,UAAU,CAAC;AACpB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AbortError } from \"../abort-controller/AbortError\";\nimport { AbortSignalLike } from \"../abort-controller/AbortSignalLike\";\nimport { PipelineResponse } from \"../interfaces\";\n\nconst StandardAbortMessage = \"The operation was aborted.\";\n\n/**\n * A wrapper for setTimeout that resolves a promise after delayInMs milliseconds.\n * @param delayInMs - The number of milliseconds to be delayed.\n * @param value - The value to be resolved with after a timeout of t milliseconds.\n * @param options - The options for delay - currently abort options\n * - abortSignal - The abortSignal associated with containing operation.\n * - abortErrorMsg - The abort error message associated with containing operation.\n * @returns Resolved promise\n */\nexport function delay<T>(\n delayInMs: number,\n value?: T,\n options?: {\n abortSignal?: AbortSignalLike;\n abortErrorMsg?: string;\n }\n): Promise<T | void> {\n return new Promise((resolve, reject) => {\n let timer: ReturnType<typeof setTimeout> | undefined = undefined;\n let onAborted: (() => void) | undefined = undefined;\n\n const rejectOnAbort = (): void => {\n return reject(\n new AbortError(options?.abortErrorMsg ? options?.abortErrorMsg : StandardAbortMessage)\n );\n };\n\n const removeListeners = (): void => {\n if (options?.abortSignal && onAborted) {\n options.abortSignal.removeEventListener(\"abort\", onAborted);\n }\n };\n\n onAborted = (): void => {\n if (timer) {\n clearTimeout(timer);\n }\n removeListeners();\n return rejectOnAbort();\n };\n\n if (options?.abortSignal && options.abortSignal.aborted) {\n return rejectOnAbort();\n }\n\n timer = setTimeout(() => {\n removeListeners();\n resolve(value);\n }, delayInMs);\n\n if (options?.abortSignal) {\n options.abortSignal.addEventListener(\"abort\", onAborted);\n }\n });\n}\n\n/**\n * @internal\n * @returns the parsed value or undefined if the parsed value is invalid.\n */\nexport function parseHeaderValueAsNumber(\n response: PipelineResponse,\n headerName: string\n): number | undefined {\n const value = response.headers.get(headerName);\n if (!value) return;\n const valueAsNum = Number(value);\n if (Number.isNaN(valueAsNum)) return;\n return valueAsNum;\n}\n"]}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
/**
|
|
4
|
+
* Converts an ArrayBuffer to a hexadecimal string.
|
|
5
|
+
* @param buffer - Raw binary data.
|
|
6
|
+
* @internal
|
|
7
|
+
*/
|
|
8
|
+
export function bufferToHex(buffer) {
|
|
9
|
+
const bytes = new Uint8Array(buffer);
|
|
10
|
+
return Array.prototype.map.call(bytes, byteToHex).join("");
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Converts a byte to a hexadecimal string.
|
|
14
|
+
* @param byte - An integer representation of a byte.
|
|
15
|
+
* @internal
|
|
16
|
+
*/
|
|
17
|
+
function byteToHex(byte) {
|
|
18
|
+
const hex = byte.toString(16);
|
|
19
|
+
return hex.length === 2 ? hex : `0${hex}`;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=hex.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"hex.js","sourceRoot":"","sources":["../../../src/util/hex.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,MAAmB;IAC7C,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;IACrC,OAAO,KAAK,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC7D,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,IAAY;IAC7B,MAAM,GAAG,GAAG,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;IAC9B,OAAO,GAAG,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,CAAC;AAC5C,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Converts an ArrayBuffer to a hexadecimal string.\n * @param buffer - Raw binary data.\n * @internal\n */\nexport function bufferToHex(buffer: ArrayBuffer): string {\n const bytes = new Uint8Array(buffer);\n return Array.prototype.map.call(bytes, byteToHex).join(\"\");\n}\n\n/**\n * Converts a byte to a hexadecimal string.\n * @param byte - An integer representation of a byte.\n * @internal\n */\nfunction byteToHex(byte: number): string {\n const hex = byte.toString(16);\n return hex.length === 2 ? hex : `0${hex}`;\n}\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"inspect.browser.js","sourceRoot":"","sources":["../../../src/util/inspect.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,CAAC,MAAM,MAAM,GAAG,EAAE,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const custom = {};\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"inspect.js","sourceRoot":"","sources":["../../../src/util/inspect.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,MAAM,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { inspect } from \"util\";\n\nexport const custom = inspect.custom;\n"]}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
/**
|
|
4
|
+
* Helper to determine when an input is a generic JS object.
|
|
5
|
+
* @returns true when input is an object type that is not null, Array, RegExp, or Date.
|
|
6
|
+
*/
|
|
7
|
+
export function isObject(input) {
|
|
8
|
+
return (typeof input === "object" &&
|
|
9
|
+
input !== null &&
|
|
10
|
+
!Array.isArray(input) &&
|
|
11
|
+
!(input instanceof RegExp) &&
|
|
12
|
+
!(input instanceof Date));
|
|
13
|
+
}
|
|
14
|
+
//# sourceMappingURL=object.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"object.js","sourceRoot":"","sources":["../../../src/util/object.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAOlC;;;GAGG;AACH,MAAM,UAAU,QAAQ,CAAC,KAAc;IACrC,OAAO,CACL,OAAO,KAAK,KAAK,QAAQ;QACzB,KAAK,KAAK,IAAI;QACd,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;QACrB,CAAC,CAAC,KAAK,YAAY,MAAM,CAAC;QAC1B,CAAC,CAAC,KAAK,YAAY,IAAI,CAAC,CACzB,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * A generic shape for a plain JS object.\n */\nexport type UnknownObject = { [s: string]: unknown };\n\n/**\n * Helper to determine when an input is a generic JS object.\n * @returns true when input is an object type that is not null, Array, RegExp, or Date.\n */\nexport function isObject(input: unknown): input is UnknownObject {\n return (\n typeof input === \"object\" &&\n input !== null &&\n !Array.isArray(input) &&\n !(input instanceof RegExp) &&\n !(input instanceof Date)\n );\n}\n"]}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
/**
|
|
4
|
+
* Returns a random integer value between a lower and upper bound,
|
|
5
|
+
* inclusive of both bounds.
|
|
6
|
+
* Note that this uses Math.random and isn't secure. If you need to use
|
|
7
|
+
* this for any kind of security purpose, find a better source of random.
|
|
8
|
+
* @param min - The smallest integer value allowed.
|
|
9
|
+
* @param max - The largest integer value allowed.
|
|
10
|
+
*/
|
|
11
|
+
export function getRandomIntegerInclusive(min, max) {
|
|
12
|
+
// Make sure inputs are integers.
|
|
13
|
+
min = Math.ceil(min);
|
|
14
|
+
max = Math.floor(max);
|
|
15
|
+
// Pick a random offset from zero to the size of the range.
|
|
16
|
+
// Since Math.random() can never return 1, we have to make the range one larger
|
|
17
|
+
// in order to be inclusive of the maximum value after we take the floor.
|
|
18
|
+
const offset = Math.floor(Math.random() * (max - min + 1));
|
|
19
|
+
return offset + min;
|
|
20
|
+
}
|
|
21
|
+
//# sourceMappingURL=random.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"random.js","sourceRoot":"","sources":["../../../src/util/random.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;;;;;GAOG;AACH,MAAM,UAAU,yBAAyB,CAAC,GAAW,EAAE,GAAW;IAChE,iCAAiC;IACjC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtB,2DAA2D;IAC3D,+EAA+E;IAC/E,yEAAyE;IACzE,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC;IAC3D,OAAO,MAAM,GAAG,GAAG,CAAC;AACtB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Returns a random integer value between a lower and upper bound,\n * inclusive of both bounds.\n * Note that this uses Math.random and isn't secure. If you need to use\n * this for any kind of security purpose, find a better source of random.\n * @param min - The smallest integer value allowed.\n * @param max - The largest integer value allowed.\n */\nexport function getRandomIntegerInclusive(min: number, max: number): number {\n // Make sure inputs are integers.\n min = Math.ceil(min);\n max = Math.floor(max);\n // Pick a random offset from zero to the size of the range.\n // Since Math.random() can never return 1, we have to make the range one larger\n // in order to be inclusive of the maximum value after we take the floor.\n const offset = Math.floor(Math.random() * (max - min + 1));\n return offset + min;\n}\n"]}
|
|
@@ -0,0 +1,139 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { isObject } from "./object";
|
|
4
|
+
const RedactedString = "REDACTED";
|
|
5
|
+
// Make sure this list is up-to-date with the one under core/logger/Readme#Keyconcepts
|
|
6
|
+
const defaultAllowedHeaderNames = [
|
|
7
|
+
"x-ms-client-request-id",
|
|
8
|
+
"x-ms-return-client-request-id",
|
|
9
|
+
"x-ms-useragent",
|
|
10
|
+
"x-ms-correlation-request-id",
|
|
11
|
+
"x-ms-request-id",
|
|
12
|
+
"client-request-id",
|
|
13
|
+
"ms-cv",
|
|
14
|
+
"return-client-request-id",
|
|
15
|
+
"traceparent",
|
|
16
|
+
"Access-Control-Allow-Credentials",
|
|
17
|
+
"Access-Control-Allow-Headers",
|
|
18
|
+
"Access-Control-Allow-Methods",
|
|
19
|
+
"Access-Control-Allow-Origin",
|
|
20
|
+
"Access-Control-Expose-Headers",
|
|
21
|
+
"Access-Control-Max-Age",
|
|
22
|
+
"Access-Control-Request-Headers",
|
|
23
|
+
"Access-Control-Request-Method",
|
|
24
|
+
"Origin",
|
|
25
|
+
"Accept",
|
|
26
|
+
"Accept-Encoding",
|
|
27
|
+
"Cache-Control",
|
|
28
|
+
"Connection",
|
|
29
|
+
"Content-Length",
|
|
30
|
+
"Content-Type",
|
|
31
|
+
"Date",
|
|
32
|
+
"ETag",
|
|
33
|
+
"Expires",
|
|
34
|
+
"If-Match",
|
|
35
|
+
"If-Modified-Since",
|
|
36
|
+
"If-None-Match",
|
|
37
|
+
"If-Unmodified-Since",
|
|
38
|
+
"Last-Modified",
|
|
39
|
+
"Pragma",
|
|
40
|
+
"Request-Id",
|
|
41
|
+
"Retry-After",
|
|
42
|
+
"Server",
|
|
43
|
+
"Transfer-Encoding",
|
|
44
|
+
"User-Agent",
|
|
45
|
+
"WWW-Authenticate",
|
|
46
|
+
];
|
|
47
|
+
const defaultAllowedQueryParameters = ["api-version"];
|
|
48
|
+
/**
|
|
49
|
+
* @internal
|
|
50
|
+
*/
|
|
51
|
+
export class Sanitizer {
|
|
52
|
+
constructor({ additionalAllowedHeaderNames: allowedHeaderNames = [], additionalAllowedQueryParameters: allowedQueryParameters = [], } = {}) {
|
|
53
|
+
allowedHeaderNames = defaultAllowedHeaderNames.concat(allowedHeaderNames);
|
|
54
|
+
allowedQueryParameters = defaultAllowedQueryParameters.concat(allowedQueryParameters);
|
|
55
|
+
this.allowedHeaderNames = new Set(allowedHeaderNames.map((n) => n.toLowerCase()));
|
|
56
|
+
this.allowedQueryParameters = new Set(allowedQueryParameters.map((p) => p.toLowerCase()));
|
|
57
|
+
}
|
|
58
|
+
sanitize(obj) {
|
|
59
|
+
const seen = new Set();
|
|
60
|
+
return JSON.stringify(obj, (key, value) => {
|
|
61
|
+
// Ensure Errors include their interesting non-enumerable members
|
|
62
|
+
if (value instanceof Error) {
|
|
63
|
+
return Object.assign(Object.assign({}, value), { name: value.name, message: value.message });
|
|
64
|
+
}
|
|
65
|
+
if (key === "headers") {
|
|
66
|
+
return this.sanitizeHeaders(value);
|
|
67
|
+
}
|
|
68
|
+
else if (key === "url") {
|
|
69
|
+
return this.sanitizeUrl(value);
|
|
70
|
+
}
|
|
71
|
+
else if (key === "query") {
|
|
72
|
+
return this.sanitizeQuery(value);
|
|
73
|
+
}
|
|
74
|
+
else if (key === "body") {
|
|
75
|
+
// Don't log the request body
|
|
76
|
+
return undefined;
|
|
77
|
+
}
|
|
78
|
+
else if (key === "response") {
|
|
79
|
+
// Don't log response again
|
|
80
|
+
return undefined;
|
|
81
|
+
}
|
|
82
|
+
else if (key === "operationSpec") {
|
|
83
|
+
// When using sendOperationRequest, the request carries a massive
|
|
84
|
+
// field with the autorest spec. No need to log it.
|
|
85
|
+
return undefined;
|
|
86
|
+
}
|
|
87
|
+
else if (Array.isArray(value) || isObject(value)) {
|
|
88
|
+
if (seen.has(value)) {
|
|
89
|
+
return "[Circular]";
|
|
90
|
+
}
|
|
91
|
+
seen.add(value);
|
|
92
|
+
}
|
|
93
|
+
return value;
|
|
94
|
+
}, 2);
|
|
95
|
+
}
|
|
96
|
+
sanitizeHeaders(obj) {
|
|
97
|
+
const sanitized = {};
|
|
98
|
+
for (const key of Object.keys(obj)) {
|
|
99
|
+
if (this.allowedHeaderNames.has(key.toLowerCase())) {
|
|
100
|
+
sanitized[key] = obj[key];
|
|
101
|
+
}
|
|
102
|
+
else {
|
|
103
|
+
sanitized[key] = RedactedString;
|
|
104
|
+
}
|
|
105
|
+
}
|
|
106
|
+
return sanitized;
|
|
107
|
+
}
|
|
108
|
+
sanitizeQuery(value) {
|
|
109
|
+
if (typeof value !== "object" || value === null) {
|
|
110
|
+
return value;
|
|
111
|
+
}
|
|
112
|
+
const sanitized = {};
|
|
113
|
+
for (const k of Object.keys(value)) {
|
|
114
|
+
if (this.allowedQueryParameters.has(k.toLowerCase())) {
|
|
115
|
+
sanitized[k] = value[k];
|
|
116
|
+
}
|
|
117
|
+
else {
|
|
118
|
+
sanitized[k] = RedactedString;
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
return sanitized;
|
|
122
|
+
}
|
|
123
|
+
sanitizeUrl(value) {
|
|
124
|
+
if (typeof value !== "string" || value === null) {
|
|
125
|
+
return value;
|
|
126
|
+
}
|
|
127
|
+
const url = new URL(value);
|
|
128
|
+
if (!url.search) {
|
|
129
|
+
return value;
|
|
130
|
+
}
|
|
131
|
+
for (const [key] of url.searchParams) {
|
|
132
|
+
if (!this.allowedQueryParameters.has(key.toLowerCase())) {
|
|
133
|
+
url.searchParams.set(key, RedactedString);
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
return url.toString();
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
//# sourceMappingURL=sanitizer.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sanitizer.js","sourceRoot":"","sources":["../../../src/util/sanitizer.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAiB,QAAQ,EAAE,MAAM,UAAU,CAAC;AAqBnD,MAAM,cAAc,GAAG,UAAU,CAAC;AAElC,sFAAsF;AACtF,MAAM,yBAAyB,GAAG;IAChC,wBAAwB;IACxB,+BAA+B;IAC/B,gBAAgB;IAChB,6BAA6B;IAC7B,iBAAiB;IACjB,mBAAmB;IACnB,OAAO;IACP,0BAA0B;IAC1B,aAAa;IAEb,kCAAkC;IAClC,8BAA8B;IAC9B,8BAA8B;IAC9B,6BAA6B;IAC7B,+BAA+B;IAC/B,wBAAwB;IACxB,gCAAgC;IAChC,+BAA+B;IAC/B,QAAQ;IAER,QAAQ;IACR,iBAAiB;IACjB,eAAe;IACf,YAAY;IACZ,gBAAgB;IAChB,cAAc;IACd,MAAM;IACN,MAAM;IACN,SAAS;IACT,UAAU;IACV,mBAAmB;IACnB,eAAe;IACf,qBAAqB;IACrB,eAAe;IACf,QAAQ;IACR,YAAY;IACZ,aAAa;IACb,QAAQ;IACR,mBAAmB;IACnB,YAAY;IACZ,kBAAkB;CACnB,CAAC;AAEF,MAAM,6BAA6B,GAAa,CAAC,aAAa,CAAC,CAAC;AAEhE;;GAEG;AACH,MAAM,OAAO,SAAS;IAIpB,YAAY,EACV,4BAA4B,EAAE,kBAAkB,GAAG,EAAE,EACrD,gCAAgC,EAAE,sBAAsB,GAAG,EAAE,MACzC,EAAE;QACtB,kBAAkB,GAAG,yBAAyB,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QAC1E,sBAAsB,GAAG,6BAA6B,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;QAEtF,IAAI,CAAC,kBAAkB,GAAG,IAAI,GAAG,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAClF,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAC5F,CAAC;IAEM,QAAQ,CAAC,GAAY;QAC1B,MAAM,IAAI,GAAG,IAAI,GAAG,EAAW,CAAC;QAChC,OAAO,IAAI,CAAC,SAAS,CACnB,GAAG,EACH,CAAC,GAAW,EAAE,KAAc,EAAE,EAAE;YAC9B,iEAAiE;YACjE,IAAI,KAAK,YAAY,KAAK,EAAE;gBAC1B,uCACK,KAAK,KACR,IAAI,EAAE,KAAK,CAAC,IAAI,EAChB,OAAO,EAAE,KAAK,CAAC,OAAO,IACtB;aACH;YAED,IAAI,GAAG,KAAK,SAAS,EAAE;gBACrB,OAAO,IAAI,CAAC,eAAe,CAAC,KAAsB,CAAC,CAAC;aACrD;iBAAM,IAAI,GAAG,KAAK,KAAK,EAAE;gBACxB,OAAO,IAAI,CAAC,WAAW,CAAC,KAAe,CAAC,CAAC;aAC1C;iBAAM,IAAI,GAAG,KAAK,OAAO,EAAE;gBAC1B,OAAO,IAAI,CAAC,aAAa,CAAC,KAAsB,CAAC,CAAC;aACnD;iBAAM,IAAI,GAAG,KAAK,MAAM,EAAE;gBACzB,6BAA6B;gBAC7B,OAAO,SAAS,CAAC;aAClB;iBAAM,IAAI,GAAG,KAAK,UAAU,EAAE;gBAC7B,2BAA2B;gBAC3B,OAAO,SAAS,CAAC;aAClB;iBAAM,IAAI,GAAG,KAAK,eAAe,EAAE;gBAClC,iEAAiE;gBACjE,mDAAmD;gBACnD,OAAO,SAAS,CAAC;aAClB;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAClD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE;oBACnB,OAAO,YAAY,CAAC;iBACrB;gBACD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;aACjB;YAED,OAAO,KAAK,CAAC;QACf,CAAC,EACD,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,eAAe,CAAC,GAAkB;QACxC,MAAM,SAAS,GAAkB,EAAE,CAAC;QACpC,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAClC,IAAI,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE;gBAClD,SAAS,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;aAC3B;iBAAM;gBACL,SAAS,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC;aACjC;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,aAAa,CAAC,KAAoB;QACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;YAC/C,OAAO,KAAK,CAAC;SACd;QAED,MAAM,SAAS,GAAkB,EAAE,CAAC;QAEpC,KAAK,MAAM,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YAClC,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC,EAAE;gBACpD,SAAS,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;aACzB;iBAAM;gBACL,SAAS,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC;aAC/B;SACF;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAEO,WAAW,CAAC,KAAa;QAC/B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;YAC/C,OAAO,KAAK,CAAC;SACd;QAED,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAE3B,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE;YACf,OAAO,KAAK,CAAC;SACd;QAED,KAAK,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,YAAY,EAAE;YACpC,IAAI,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,EAAE;gBACvD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;aAC3C;SACF;QAED,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC;IACxB,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { UnknownObject, isObject } from \"./object\";\n\n/**\n * @internal\n */\nexport interface SanitizerOptions {\n /**\n * Header names whose values will be logged when logging is enabled.\n * Defaults include a list of well-known safe headers. Any headers\n * specified in this field will be added to that list. Any other values will\n * be written to logs as \"REDACTED\".\n */\n additionalAllowedHeaderNames?: string[];\n\n /**\n * Query string names whose values will be logged when logging is enabled. By default no\n * query string values are logged.\n */\n additionalAllowedQueryParameters?: string[];\n}\n\nconst RedactedString = \"REDACTED\";\n\n// Make sure this list is up-to-date with the one under core/logger/Readme#Keyconcepts\nconst defaultAllowedHeaderNames = [\n \"x-ms-client-request-id\",\n \"x-ms-return-client-request-id\",\n \"x-ms-useragent\",\n \"x-ms-correlation-request-id\",\n \"x-ms-request-id\",\n \"client-request-id\",\n \"ms-cv\",\n \"return-client-request-id\",\n \"traceparent\",\n\n \"Access-Control-Allow-Credentials\",\n \"Access-Control-Allow-Headers\",\n \"Access-Control-Allow-Methods\",\n \"Access-Control-Allow-Origin\",\n \"Access-Control-Expose-Headers\",\n \"Access-Control-Max-Age\",\n \"Access-Control-Request-Headers\",\n \"Access-Control-Request-Method\",\n \"Origin\",\n\n \"Accept\",\n \"Accept-Encoding\",\n \"Cache-Control\",\n \"Connection\",\n \"Content-Length\",\n \"Content-Type\",\n \"Date\",\n \"ETag\",\n \"Expires\",\n \"If-Match\",\n \"If-Modified-Since\",\n \"If-None-Match\",\n \"If-Unmodified-Since\",\n \"Last-Modified\",\n \"Pragma\",\n \"Request-Id\",\n \"Retry-After\",\n \"Server\",\n \"Transfer-Encoding\",\n \"User-Agent\",\n \"WWW-Authenticate\",\n];\n\nconst defaultAllowedQueryParameters: string[] = [\"api-version\"];\n\n/**\n * @internal\n */\nexport class Sanitizer {\n private allowedHeaderNames: Set<string>;\n private allowedQueryParameters: Set<string>;\n\n constructor({\n additionalAllowedHeaderNames: allowedHeaderNames = [],\n additionalAllowedQueryParameters: allowedQueryParameters = [],\n }: SanitizerOptions = {}) {\n allowedHeaderNames = defaultAllowedHeaderNames.concat(allowedHeaderNames);\n allowedQueryParameters = defaultAllowedQueryParameters.concat(allowedQueryParameters);\n\n this.allowedHeaderNames = new Set(allowedHeaderNames.map((n) => n.toLowerCase()));\n this.allowedQueryParameters = new Set(allowedQueryParameters.map((p) => p.toLowerCase()));\n }\n\n public sanitize(obj: unknown): string {\n const seen = new Set<unknown>();\n return JSON.stringify(\n obj,\n (key: string, value: unknown) => {\n // Ensure Errors include their interesting non-enumerable members\n if (value instanceof Error) {\n return {\n ...value,\n name: value.name,\n message: value.message,\n };\n }\n\n if (key === \"headers\") {\n return this.sanitizeHeaders(value as UnknownObject);\n } else if (key === \"url\") {\n return this.sanitizeUrl(value as string);\n } else if (key === \"query\") {\n return this.sanitizeQuery(value as UnknownObject);\n } else if (key === \"body\") {\n // Don't log the request body\n return undefined;\n } else if (key === \"response\") {\n // Don't log response again\n return undefined;\n } else if (key === \"operationSpec\") {\n // When using sendOperationRequest, the request carries a massive\n // field with the autorest spec. No need to log it.\n return undefined;\n } else if (Array.isArray(value) || isObject(value)) {\n if (seen.has(value)) {\n return \"[Circular]\";\n }\n seen.add(value);\n }\n\n return value;\n },\n 2\n );\n }\n\n private sanitizeHeaders(obj: UnknownObject): UnknownObject {\n const sanitized: UnknownObject = {};\n for (const key of Object.keys(obj)) {\n if (this.allowedHeaderNames.has(key.toLowerCase())) {\n sanitized[key] = obj[key];\n } else {\n sanitized[key] = RedactedString;\n }\n }\n return sanitized;\n }\n\n private sanitizeQuery(value: UnknownObject): UnknownObject {\n if (typeof value !== \"object\" || value === null) {\n return value;\n }\n\n const sanitized: UnknownObject = {};\n\n for (const k of Object.keys(value)) {\n if (this.allowedQueryParameters.has(k.toLowerCase())) {\n sanitized[k] = value[k];\n } else {\n sanitized[k] = RedactedString;\n }\n }\n\n return sanitized;\n }\n\n private sanitizeUrl(value: string): string {\n if (typeof value !== \"string\" || value === null) {\n return value;\n }\n\n const url = new URL(value);\n\n if (!url.search) {\n return value;\n }\n\n for (const [key] of url.searchParams) {\n if (!this.allowedQueryParameters.has(key.toLowerCase())) {\n url.searchParams.set(key, RedactedString);\n }\n }\n\n return url.toString();\n }\n}\n"]}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { base64ToBytes, bufferToBase64 } from "./base64.browser";
|
|
4
|
+
import { bufferToHex } from "./hex";
|
|
5
|
+
import { utf8ToBytes } from "./utf8.browser";
|
|
6
|
+
let subtleCrypto;
|
|
7
|
+
/**
|
|
8
|
+
* Returns a cached reference to the Web API crypto.subtle object.
|
|
9
|
+
* @internal
|
|
10
|
+
*/
|
|
11
|
+
function getCrypto() {
|
|
12
|
+
if (subtleCrypto) {
|
|
13
|
+
return subtleCrypto;
|
|
14
|
+
}
|
|
15
|
+
if (!self.crypto || !self.crypto.subtle) {
|
|
16
|
+
throw new Error("Your browser environment does not support cryptography functions.");
|
|
17
|
+
}
|
|
18
|
+
subtleCrypto = self.crypto.subtle;
|
|
19
|
+
return subtleCrypto;
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* Generates a SHA-256 HMAC signature.
|
|
23
|
+
* @param key - The HMAC key represented as a base64 string, used to generate the cryptographic HMAC hash.
|
|
24
|
+
* @param stringToSign - The data to be signed.
|
|
25
|
+
* @param encoding - The textual encoding to use for the returned HMAC digest.
|
|
26
|
+
*/
|
|
27
|
+
export async function computeSha256Hmac(key, stringToSign, encoding) {
|
|
28
|
+
const crypto = getCrypto();
|
|
29
|
+
const keyBytes = base64ToBytes(key);
|
|
30
|
+
const stringToSignBytes = utf8ToBytes(stringToSign);
|
|
31
|
+
const cryptoKey = await crypto.importKey("raw", keyBytes, {
|
|
32
|
+
name: "HMAC",
|
|
33
|
+
hash: { name: "SHA-256" },
|
|
34
|
+
}, false, ["sign"]);
|
|
35
|
+
const signature = await crypto.sign({
|
|
36
|
+
name: "HMAC",
|
|
37
|
+
hash: { name: "SHA-256" },
|
|
38
|
+
}, cryptoKey, stringToSignBytes);
|
|
39
|
+
switch (encoding) {
|
|
40
|
+
case "base64":
|
|
41
|
+
return bufferToBase64(signature);
|
|
42
|
+
case "hex":
|
|
43
|
+
return bufferToHex(signature);
|
|
44
|
+
}
|
|
45
|
+
}
|
|
46
|
+
/**
|
|
47
|
+
* Generates a SHA-256 hash.
|
|
48
|
+
* @param content - The data to be included in the hash.
|
|
49
|
+
* @param encoding - The textual encoding to use for the returned hash.
|
|
50
|
+
*/
|
|
51
|
+
export async function computeSha256Hash(content, encoding) {
|
|
52
|
+
const contentBytes = utf8ToBytes(content);
|
|
53
|
+
const digest = await getCrypto().digest({ name: "SHA-256" }, contentBytes);
|
|
54
|
+
switch (encoding) {
|
|
55
|
+
case "base64":
|
|
56
|
+
return bufferToBase64(digest);
|
|
57
|
+
case "hex":
|
|
58
|
+
return bufferToHex(digest);
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
//# sourceMappingURL=sha256.browser.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sha256.browser.js","sourceRoot":"","sources":["../../../src/util/sha256.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AACpC,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AA6C7C,IAAI,YAAsC,CAAC;AAE3C;;;GAGG;AACH,SAAS,SAAS;IAChB,IAAI,YAAY,EAAE;QAChB,OAAO,YAAY,CAAC;KACrB;IAED,IAAI,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;QACvC,MAAM,IAAI,KAAK,CAAC,mEAAmE,CAAC,CAAC;KACtF;IAED,YAAY,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAClC,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,GAAW,EACX,YAAoB,EACpB,QAA0B;IAE1B,MAAM,MAAM,GAAG,SAAS,EAAE,CAAC;IAC3B,MAAM,QAAQ,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC;IACpC,MAAM,iBAAiB,GAAG,WAAW,CAAC,YAAY,CAAC,CAAC;IAEpD,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,SAAS,CACtC,KAAK,EACL,QAAQ,EACR;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;KAC1B,EACD,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;IACF,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,IAAI,CACjC;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;KAC1B,EACD,SAAS,EACT,iBAAiB,CAClB,CAAC;IAEF,QAAQ,QAAQ,EAAE;QAChB,KAAK,QAAQ;YACX,OAAO,cAAc,CAAC,SAAS,CAAC,CAAC;QACnC,KAAK,KAAK;YACR,OAAO,WAAW,CAAC,SAAS,CAAC,CAAC;KACjC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAe,EACf,QAA0B;IAE1B,MAAM,YAAY,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,YAAY,CAAC,CAAC;IAE3E,QAAQ,QAAQ,EAAE;QAChB,KAAK,QAAQ;YACX,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;QAChC,KAAK,KAAK;YACR,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;KAC9B;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { base64ToBytes, bufferToBase64 } from \"./base64.browser\";\nimport { bufferToHex } from \"./hex\";\nimport { utf8ToBytes } from \"./utf8.browser\";\n\n// stubs for browser self.crypto\ninterface JsonWebKey {}\ninterface CryptoKey {}\ntype KeyUsage =\n | \"decrypt\"\n | \"deriveBits\"\n | \"deriveKey\"\n | \"encrypt\"\n | \"sign\"\n | \"unwrapKey\"\n | \"verify\"\n | \"wrapKey\";\ninterface Algorithm {\n name: string;\n}\ninterface SubtleCrypto {\n importKey(\n format: string,\n keyData: JsonWebKey,\n algorithm: HmacImportParams,\n extractable: boolean,\n usage: KeyUsage[]\n ): Promise<CryptoKey>;\n sign(\n algorithm: HmacImportParams,\n key: CryptoKey,\n data: ArrayBufferView | ArrayBuffer\n ): Promise<ArrayBuffer>;\n digest(algorithm: Algorithm, data: ArrayBufferView | ArrayBuffer): Promise<ArrayBuffer>;\n}\ninterface Crypto {\n readonly subtle: SubtleCrypto;\n getRandomValues<T extends ArrayBufferView | null>(array: T): T;\n}\ndeclare const self: {\n crypto: Crypto;\n};\ninterface HmacImportParams {\n name: string;\n hash: Algorithm;\n length?: number;\n}\n\nlet subtleCrypto: SubtleCrypto | undefined;\n\n/**\n * Returns a cached reference to the Web API crypto.subtle object.\n * @internal\n */\nfunction getCrypto(): SubtleCrypto {\n if (subtleCrypto) {\n return subtleCrypto;\n }\n\n if (!self.crypto || !self.crypto.subtle) {\n throw new Error(\"Your browser environment does not support cryptography functions.\");\n }\n\n subtleCrypto = self.crypto.subtle;\n return subtleCrypto;\n}\n\n/**\n * Generates a SHA-256 HMAC signature.\n * @param key - The HMAC key represented as a base64 string, used to generate the cryptographic HMAC hash.\n * @param stringToSign - The data to be signed.\n * @param encoding - The textual encoding to use for the returned HMAC digest.\n */\nexport async function computeSha256Hmac(\n key: string,\n stringToSign: string,\n encoding: \"base64\" | \"hex\"\n): Promise<string> {\n const crypto = getCrypto();\n const keyBytes = base64ToBytes(key);\n const stringToSignBytes = utf8ToBytes(stringToSign);\n\n const cryptoKey = await crypto.importKey(\n \"raw\",\n keyBytes,\n {\n name: \"HMAC\",\n hash: { name: \"SHA-256\" },\n },\n false,\n [\"sign\"]\n );\n const signature = await crypto.sign(\n {\n name: \"HMAC\",\n hash: { name: \"SHA-256\" },\n },\n cryptoKey,\n stringToSignBytes\n );\n\n switch (encoding) {\n case \"base64\":\n return bufferToBase64(signature);\n case \"hex\":\n return bufferToHex(signature);\n }\n}\n\n/**\n * Generates a SHA-256 hash.\n * @param content - The data to be included in the hash.\n * @param encoding - The textual encoding to use for the returned hash.\n */\nexport async function computeSha256Hash(\n content: string,\n encoding: \"base64\" | \"hex\"\n): Promise<string> {\n const contentBytes = utf8ToBytes(content);\n const digest = await getCrypto().digest({ name: \"SHA-256\" }, contentBytes);\n\n switch (encoding) {\n case \"base64\":\n return bufferToBase64(digest);\n case \"hex\":\n return bufferToHex(digest);\n }\n}\n"]}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { createHash, createHmac } from "crypto";
|
|
4
|
+
/**
|
|
5
|
+
* Generates a SHA-256 HMAC signature.
|
|
6
|
+
* @param key - The HMAC key represented as a base64 string, used to generate the cryptographic HMAC hash.
|
|
7
|
+
* @param stringToSign - The data to be signed.
|
|
8
|
+
* @param encoding - The textual encoding to use for the returned HMAC digest.
|
|
9
|
+
*/
|
|
10
|
+
export async function computeSha256Hmac(key, stringToSign, encoding) {
|
|
11
|
+
const decodedKey = Buffer.from(key, "base64");
|
|
12
|
+
return createHmac("sha256", decodedKey).update(stringToSign).digest(encoding);
|
|
13
|
+
}
|
|
14
|
+
/**
|
|
15
|
+
* Generates a SHA-256 hash.
|
|
16
|
+
* @param content - The data to be included in the hash.
|
|
17
|
+
* @param encoding - The textual encoding to use for the returned hash.
|
|
18
|
+
*/
|
|
19
|
+
export async function computeSha256Hash(content, encoding) {
|
|
20
|
+
return createHash("sha256").update(content).digest(encoding);
|
|
21
|
+
}
|
|
22
|
+
//# sourceMappingURL=sha256.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"sha256.js","sourceRoot":"","sources":["../../../src/util/sha256.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,GAAW,EACX,YAAoB,EACpB,QAA0B;IAE1B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAE9C,OAAO,UAAU,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAChF,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,OAAe,EACf,QAA0B;IAE1B,OAAO,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;AAC/D,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createHash, createHmac } from \"crypto\";\n\n/**\n * Generates a SHA-256 HMAC signature.\n * @param key - The HMAC key represented as a base64 string, used to generate the cryptographic HMAC hash.\n * @param stringToSign - The data to be signed.\n * @param encoding - The textual encoding to use for the returned HMAC digest.\n */\nexport async function computeSha256Hmac(\n key: string,\n stringToSign: string,\n encoding: \"base64\" | \"hex\"\n): Promise<string> {\n const decodedKey = Buffer.from(key, \"base64\");\n\n return createHmac(\"sha256\", decodedKey).update(stringToSign).digest(encoding);\n}\n\n/**\n * Generates a SHA-256 hash.\n * @param content - The data to be included in the hash.\n * @param encoding - The textual encoding to use for the returned hash.\n */\nexport async function computeSha256Hash(\n content: string,\n encoding: \"base64\" | \"hex\"\n): Promise<string> {\n return createHash(\"sha256\").update(content).digest(encoding);\n}\n"]}
|
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { delay } from "./helpers";
|
|
4
|
+
// Default options for the cycler if none are provided
|
|
5
|
+
export const DEFAULT_CYCLER_OPTIONS = {
|
|
6
|
+
forcedRefreshWindowInMs: 1000,
|
|
7
|
+
retryIntervalInMs: 3000,
|
|
8
|
+
refreshWindowInMs: 1000 * 60 * 2, // Start refreshing 2m before expiry
|
|
9
|
+
};
|
|
10
|
+
/**
|
|
11
|
+
* Converts an an unreliable access token getter (which may resolve with null)
|
|
12
|
+
* into an AccessTokenGetter by retrying the unreliable getter in a regular
|
|
13
|
+
* interval.
|
|
14
|
+
*
|
|
15
|
+
* @param getAccessToken - A function that produces a promise of an access token that may fail by returning null.
|
|
16
|
+
* @param retryIntervalInMs - The time (in milliseconds) to wait between retry attempts.
|
|
17
|
+
* @param refreshTimeout - The timestamp after which the refresh attempt will fail, throwing an exception.
|
|
18
|
+
* @returns - A promise that, if it resolves, will resolve with an access token.
|
|
19
|
+
*/
|
|
20
|
+
async function beginRefresh(getAccessToken, retryIntervalInMs, refreshTimeout) {
|
|
21
|
+
// This wrapper handles exceptions gracefully as long as we haven't exceeded
|
|
22
|
+
// the timeout.
|
|
23
|
+
async function tryGetAccessToken() {
|
|
24
|
+
if (Date.now() < refreshTimeout) {
|
|
25
|
+
try {
|
|
26
|
+
return await getAccessToken();
|
|
27
|
+
}
|
|
28
|
+
catch (_a) {
|
|
29
|
+
return null;
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
else {
|
|
33
|
+
const finalToken = await getAccessToken();
|
|
34
|
+
// Timeout is up, so throw if it's still null
|
|
35
|
+
if (finalToken === null) {
|
|
36
|
+
throw new Error("Failed to refresh access token.");
|
|
37
|
+
}
|
|
38
|
+
return finalToken;
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
let token = await tryGetAccessToken();
|
|
42
|
+
while (token === null) {
|
|
43
|
+
await delay(retryIntervalInMs);
|
|
44
|
+
token = await tryGetAccessToken();
|
|
45
|
+
}
|
|
46
|
+
return token;
|
|
47
|
+
}
|
|
48
|
+
/**
|
|
49
|
+
* Creates a token cycler from a credential, scopes, and optional settings.
|
|
50
|
+
*
|
|
51
|
+
* A token cycler represents a way to reliably retrieve a valid access token
|
|
52
|
+
* from a TokenCredential. It will handle initializing the token, refreshing it
|
|
53
|
+
* when it nears expiration, and synchronizes refresh attempts to avoid
|
|
54
|
+
* concurrency hazards.
|
|
55
|
+
*
|
|
56
|
+
* @param credential - the underlying TokenCredential that provides the access
|
|
57
|
+
* token
|
|
58
|
+
* @param tokenCyclerOptions - optionally override default settings for the cycler
|
|
59
|
+
*
|
|
60
|
+
* @returns - a function that reliably produces a valid access token
|
|
61
|
+
*/
|
|
62
|
+
export function createTokenCycler(credential, tokenCyclerOptions) {
|
|
63
|
+
let refreshWorker = null;
|
|
64
|
+
let token = null;
|
|
65
|
+
let tenantId;
|
|
66
|
+
const options = Object.assign(Object.assign({}, DEFAULT_CYCLER_OPTIONS), tokenCyclerOptions);
|
|
67
|
+
/**
|
|
68
|
+
* This little holder defines several predicates that we use to construct
|
|
69
|
+
* the rules of refreshing the token.
|
|
70
|
+
*/
|
|
71
|
+
const cycler = {
|
|
72
|
+
/**
|
|
73
|
+
* Produces true if a refresh job is currently in progress.
|
|
74
|
+
*/
|
|
75
|
+
get isRefreshing() {
|
|
76
|
+
return refreshWorker !== null;
|
|
77
|
+
},
|
|
78
|
+
/**
|
|
79
|
+
* Produces true if the cycler SHOULD refresh (we are within the refresh
|
|
80
|
+
* window and not already refreshing)
|
|
81
|
+
*/
|
|
82
|
+
get shouldRefresh() {
|
|
83
|
+
var _a;
|
|
84
|
+
return (!cycler.isRefreshing &&
|
|
85
|
+
((_a = token === null || token === void 0 ? void 0 : token.expiresOnTimestamp) !== null && _a !== void 0 ? _a : 0) - options.refreshWindowInMs < Date.now());
|
|
86
|
+
},
|
|
87
|
+
/**
|
|
88
|
+
* Produces true if the cycler MUST refresh (null or nearly-expired
|
|
89
|
+
* token).
|
|
90
|
+
*/
|
|
91
|
+
get mustRefresh() {
|
|
92
|
+
return (token === null || token.expiresOnTimestamp - options.forcedRefreshWindowInMs < Date.now());
|
|
93
|
+
},
|
|
94
|
+
};
|
|
95
|
+
/**
|
|
96
|
+
* Starts a refresh job or returns the existing job if one is already
|
|
97
|
+
* running.
|
|
98
|
+
*/
|
|
99
|
+
function refresh(scopes, getTokenOptions) {
|
|
100
|
+
var _a;
|
|
101
|
+
if (!cycler.isRefreshing) {
|
|
102
|
+
// We bind `scopes` here to avoid passing it around a lot
|
|
103
|
+
const tryGetAccessToken = () => credential.getToken(scopes, getTokenOptions);
|
|
104
|
+
// Take advantage of promise chaining to insert an assignment to `token`
|
|
105
|
+
// before the refresh can be considered done.
|
|
106
|
+
refreshWorker = beginRefresh(tryGetAccessToken, options.retryIntervalInMs,
|
|
107
|
+
// If we don't have a token, then we should timeout immediately
|
|
108
|
+
(_a = token === null || token === void 0 ? void 0 : token.expiresOnTimestamp) !== null && _a !== void 0 ? _a : Date.now())
|
|
109
|
+
.then((_token) => {
|
|
110
|
+
refreshWorker = null;
|
|
111
|
+
token = _token;
|
|
112
|
+
tenantId = getTokenOptions.tenantId;
|
|
113
|
+
return token;
|
|
114
|
+
})
|
|
115
|
+
.catch((reason) => {
|
|
116
|
+
// We also should reset the refresher if we enter a failed state. All
|
|
117
|
+
// existing awaiters will throw, but subsequent requests will start a
|
|
118
|
+
// new retry chain.
|
|
119
|
+
refreshWorker = null;
|
|
120
|
+
token = null;
|
|
121
|
+
tenantId = undefined;
|
|
122
|
+
throw reason;
|
|
123
|
+
});
|
|
124
|
+
}
|
|
125
|
+
return refreshWorker;
|
|
126
|
+
}
|
|
127
|
+
return async (scopes, tokenOptions) => {
|
|
128
|
+
//
|
|
129
|
+
// Simple rules:
|
|
130
|
+
// - If we MUST refresh, then return the refresh task, blocking
|
|
131
|
+
// the pipeline until a token is available.
|
|
132
|
+
// - If we SHOULD refresh, then run refresh but don't return it
|
|
133
|
+
// (we can still use the cached token).
|
|
134
|
+
// - Return the token, since it's fine if we didn't return in
|
|
135
|
+
// step 1.
|
|
136
|
+
//
|
|
137
|
+
// If the tenantId passed in token options is different to the one we have
|
|
138
|
+
// Or if we are in claim challenge and the token was rejected and a new access token need to be issued, we need to
|
|
139
|
+
// refresh the token with the new tenantId or token.
|
|
140
|
+
const mustRefresh = tenantId !== tokenOptions.tenantId || Boolean(tokenOptions.claims) || cycler.mustRefresh;
|
|
141
|
+
if (mustRefresh)
|
|
142
|
+
return refresh(scopes, tokenOptions);
|
|
143
|
+
if (cycler.shouldRefresh) {
|
|
144
|
+
refresh(scopes, tokenOptions);
|
|
145
|
+
}
|
|
146
|
+
return token;
|
|
147
|
+
};
|
|
148
|
+
}
|
|
149
|
+
//# sourceMappingURL=tokenCycler.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"tokenCycler.js","sourceRoot":"","sources":["../../../src/util/tokenCycler.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAC;AAkClC,sDAAsD;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAuB;IACxD,uBAAuB,EAAE,IAAI;IAC7B,iBAAiB,EAAE,IAAI;IACvB,iBAAiB,EAAE,IAAI,GAAG,EAAE,GAAG,CAAC,EAAE,oCAAoC;CACvE,CAAC;AAEF;;;;;;;;;GASG;AACH,KAAK,UAAU,YAAY,CACzB,cAAiD,EACjD,iBAAyB,EACzB,cAAsB;IAEtB,4EAA4E;IAC5E,eAAe;IACf,KAAK,UAAU,iBAAiB;QAC9B,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,EAAE;YAC/B,IAAI;gBACF,OAAO,MAAM,cAAc,EAAE,CAAC;aAC/B;YAAC,WAAM;gBACN,OAAO,IAAI,CAAC;aACb;SACF;aAAM;YACL,MAAM,UAAU,GAAG,MAAM,cAAc,EAAE,CAAC;YAE1C,6CAA6C;YAC7C,IAAI,UAAU,KAAK,IAAI,EAAE;gBACvB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;aACpD;YAED,OAAO,UAAU,CAAC;SACnB;IACH,CAAC;IAED,IAAI,KAAK,GAAuB,MAAM,iBAAiB,EAAE,CAAC;IAE1D,OAAO,KAAK,KAAK,IAAI,EAAE;QACrB,MAAM,KAAK,CAAC,iBAAiB,CAAC,CAAC;QAE/B,KAAK,GAAG,MAAM,iBAAiB,EAAE,CAAC;KACnC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAC/B,UAA2B,EAC3B,kBAAgD;IAEhD,IAAI,aAAa,GAAgC,IAAI,CAAC;IACtD,IAAI,KAAK,GAAuB,IAAI,CAAC;IACrC,IAAI,QAA4B,CAAC;IAEjC,MAAM,OAAO,mCACR,sBAAsB,GACtB,kBAAkB,CACtB,CAAC;IAEF;;;OAGG;IACH,MAAM,MAAM,GAAG;QACb;;WAEG;QACH,IAAI,YAAY;YACd,OAAO,aAAa,KAAK,IAAI,CAAC;QAChC,CAAC;QACD;;;WAGG;QACH,IAAI,aAAa;;YACf,OAAO,CACL,CAAC,MAAM,CAAC,YAAY;gBACpB,CAAC,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,kBAAkB,mCAAI,CAAC,CAAC,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAC1E,CAAC;QACJ,CAAC;QACD;;;WAGG;QACH,IAAI,WAAW;YACb,OAAO,CACL,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,kBAAkB,GAAG,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC,GAAG,EAAE,CAC1F,CAAC;QACJ,CAAC;KACF,CAAC;IAEF;;;OAGG;IACH,SAAS,OAAO,CACd,MAAyB,EACzB,eAAgC;;QAEhC,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE;YACxB,yDAAyD;YACzD,MAAM,iBAAiB,GAAG,GAAgC,EAAE,CAC1D,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;YAE/C,wEAAwE;YACxE,6CAA6C;YAC7C,aAAa,GAAG,YAAY,CAC1B,iBAAiB,EACjB,OAAO,CAAC,iBAAiB;YACzB,+DAA+D;YAC/D,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,kBAAkB,mCAAI,IAAI,CAAC,GAAG,EAAE,CACxC;iBACE,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBACf,aAAa,GAAG,IAAI,CAAC;gBACrB,KAAK,GAAG,MAAM,CAAC;gBACf,QAAQ,GAAG,eAAe,CAAC,QAAQ,CAAC;gBACpC,OAAO,KAAK,CAAC;YACf,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE;gBAChB,sEAAsE;gBACtE,qEAAqE;gBACrE,mBAAmB;gBACnB,aAAa,GAAG,IAAI,CAAC;gBACrB,KAAK,GAAG,IAAI,CAAC;gBACb,QAAQ,GAAG,SAAS,CAAC;gBACrB,MAAM,MAAM,CAAC;YACf,CAAC,CAAC,CAAC;SACN;QAED,OAAO,aAAqC,CAAC;IAC/C,CAAC;IAED,OAAO,KAAK,EAAE,MAAyB,EAAE,YAA6B,EAAwB,EAAE;QAC9F,EAAE;QACF,gBAAgB;QAChB,+DAA+D;QAC/D,6CAA6C;QAC7C,+DAA+D;QAC/D,yCAAyC;QACzC,6DAA6D;QAC7D,YAAY;QACZ,EAAE;QAEF,0EAA0E;QAC1E,kHAAkH;QAClH,oDAAoD;QACpD,MAAM,WAAW,GACf,QAAQ,KAAK,YAAY,CAAC,QAAQ,IAAI,OAAO,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,WAAW,CAAC;QAE3F,IAAI,WAAW;YAAE,OAAO,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;QAEtD,IAAI,MAAM,CAAC,aAAa,EAAE;YACxB,OAAO,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;SAC/B;QAED,OAAO,KAAoB,CAAC;IAC9B,CAAC,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { AccessToken, GetTokenOptions, TokenCredential } from \"../auth/tokenCredential\";\nimport { delay } from \"./helpers\";\n\n/**\n * A function that gets a promise of an access token and allows providing\n * options.\n *\n * @param options - the options to pass to the underlying token provider\n */\nexport type AccessTokenGetter = (\n scopes: string | string[],\n options: GetTokenOptions\n) => Promise<AccessToken>;\n\nexport interface TokenCyclerOptions {\n /**\n * The window of time before token expiration during which the token will be\n * considered unusable due to risk of the token expiring before sending the\n * request.\n *\n * This will only become meaningful if the refresh fails for over\n * (refreshWindow - forcedRefreshWindow) milliseconds.\n */\n forcedRefreshWindowInMs: number;\n /**\n * Interval in milliseconds to retry failed token refreshes.\n */\n retryIntervalInMs: number;\n /**\n * The window of time before token expiration during which\n * we will attempt to refresh the token.\n */\n refreshWindowInMs: number;\n}\n\n// Default options for the cycler if none are provided\nexport const DEFAULT_CYCLER_OPTIONS: TokenCyclerOptions = {\n forcedRefreshWindowInMs: 1000, // Force waiting for a refresh 1s before the token expires\n retryIntervalInMs: 3000, // Allow refresh attempts every 3s\n refreshWindowInMs: 1000 * 60 * 2, // Start refreshing 2m before expiry\n};\n\n/**\n * Converts an an unreliable access token getter (which may resolve with null)\n * into an AccessTokenGetter by retrying the unreliable getter in a regular\n * interval.\n *\n * @param getAccessToken - A function that produces a promise of an access token that may fail by returning null.\n * @param retryIntervalInMs - The time (in milliseconds) to wait between retry attempts.\n * @param refreshTimeout - The timestamp after which the refresh attempt will fail, throwing an exception.\n * @returns - A promise that, if it resolves, will resolve with an access token.\n */\nasync function beginRefresh(\n getAccessToken: () => Promise<AccessToken | null>,\n retryIntervalInMs: number,\n refreshTimeout: number\n): Promise<AccessToken> {\n // This wrapper handles exceptions gracefully as long as we haven't exceeded\n // the timeout.\n async function tryGetAccessToken(): Promise<AccessToken | null> {\n if (Date.now() < refreshTimeout) {\n try {\n return await getAccessToken();\n } catch {\n return null;\n }\n } else {\n const finalToken = await getAccessToken();\n\n // Timeout is up, so throw if it's still null\n if (finalToken === null) {\n throw new Error(\"Failed to refresh access token.\");\n }\n\n return finalToken;\n }\n }\n\n let token: AccessToken | null = await tryGetAccessToken();\n\n while (token === null) {\n await delay(retryIntervalInMs);\n\n token = await tryGetAccessToken();\n }\n\n return token;\n}\n\n/**\n * Creates a token cycler from a credential, scopes, and optional settings.\n *\n * A token cycler represents a way to reliably retrieve a valid access token\n * from a TokenCredential. It will handle initializing the token, refreshing it\n * when it nears expiration, and synchronizes refresh attempts to avoid\n * concurrency hazards.\n *\n * @param credential - the underlying TokenCredential that provides the access\n * token\n * @param tokenCyclerOptions - optionally override default settings for the cycler\n *\n * @returns - a function that reliably produces a valid access token\n */\nexport function createTokenCycler(\n credential: TokenCredential,\n tokenCyclerOptions?: Partial<TokenCyclerOptions>\n): AccessTokenGetter {\n let refreshWorker: Promise<AccessToken> | null = null;\n let token: AccessToken | null = null;\n let tenantId: string | undefined;\n\n const options = {\n ...DEFAULT_CYCLER_OPTIONS,\n ...tokenCyclerOptions,\n };\n\n /**\n * This little holder defines several predicates that we use to construct\n * the rules of refreshing the token.\n */\n const cycler = {\n /**\n * Produces true if a refresh job is currently in progress.\n */\n get isRefreshing(): boolean {\n return refreshWorker !== null;\n },\n /**\n * Produces true if the cycler SHOULD refresh (we are within the refresh\n * window and not already refreshing)\n */\n get shouldRefresh(): boolean {\n return (\n !cycler.isRefreshing &&\n (token?.expiresOnTimestamp ?? 0) - options.refreshWindowInMs < Date.now()\n );\n },\n /**\n * Produces true if the cycler MUST refresh (null or nearly-expired\n * token).\n */\n get mustRefresh(): boolean {\n return (\n token === null || token.expiresOnTimestamp - options.forcedRefreshWindowInMs < Date.now()\n );\n },\n };\n\n /**\n * Starts a refresh job or returns the existing job if one is already\n * running.\n */\n function refresh(\n scopes: string | string[],\n getTokenOptions: GetTokenOptions\n ): Promise<AccessToken> {\n if (!cycler.isRefreshing) {\n // We bind `scopes` here to avoid passing it around a lot\n const tryGetAccessToken = (): Promise<AccessToken | null> =>\n credential.getToken(scopes, getTokenOptions);\n\n // Take advantage of promise chaining to insert an assignment to `token`\n // before the refresh can be considered done.\n refreshWorker = beginRefresh(\n tryGetAccessToken,\n options.retryIntervalInMs,\n // If we don't have a token, then we should timeout immediately\n token?.expiresOnTimestamp ?? Date.now()\n )\n .then((_token) => {\n refreshWorker = null;\n token = _token;\n tenantId = getTokenOptions.tenantId;\n return token;\n })\n .catch((reason) => {\n // We also should reset the refresher if we enter a failed state. All\n // existing awaiters will throw, but subsequent requests will start a\n // new retry chain.\n refreshWorker = null;\n token = null;\n tenantId = undefined;\n throw reason;\n });\n }\n\n return refreshWorker as Promise<AccessToken>;\n }\n\n return async (scopes: string | string[], tokenOptions: GetTokenOptions): Promise<AccessToken> => {\n //\n // Simple rules:\n // - If we MUST refresh, then return the refresh task, blocking\n // the pipeline until a token is available.\n // - If we SHOULD refresh, then run refresh but don't return it\n // (we can still use the cached token).\n // - Return the token, since it's fine if we didn't return in\n // step 1.\n //\n\n // If the tenantId passed in token options is different to the one we have\n // Or if we are in claim challenge and the token was rejected and a new access token need to be issued, we need to\n // refresh the token with the new tenantId or token.\n const mustRefresh =\n tenantId !== tokenOptions.tenantId || Boolean(tokenOptions.claims) || cycler.mustRefresh;\n\n if (mustRefresh) return refresh(scopes, tokenOptions);\n\n if (cycler.shouldRefresh) {\n refresh(scopes, tokenOptions);\n }\n\n return token as AccessToken;\n };\n}\n"]}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
/**
|
|
4
|
+
* Helper TypeGuard that checks if something is defined or not.
|
|
5
|
+
* @param thing - Anything
|
|
6
|
+
*/
|
|
7
|
+
export function isDefined(thing) {
|
|
8
|
+
return typeof thing !== "undefined" && thing !== null;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Helper TypeGuard that checks if the input is an object with the specified properties.
|
|
12
|
+
* @param thing - Anything.
|
|
13
|
+
* @param properties - The name of the properties that should appear in the object.
|
|
14
|
+
*/
|
|
15
|
+
export function isObjectWithProperties(thing, properties) {
|
|
16
|
+
if (!isDefined(thing) || typeof thing !== "object") {
|
|
17
|
+
return false;
|
|
18
|
+
}
|
|
19
|
+
for (const property of properties) {
|
|
20
|
+
if (!objectHasProperty(thing, property)) {
|
|
21
|
+
return false;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
return true;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Helper TypeGuard that checks if the input is an object with the specified property.
|
|
28
|
+
* @param thing - Any object.
|
|
29
|
+
* @param property - The name of the property that should appear in the object.
|
|
30
|
+
*/
|
|
31
|
+
export function objectHasProperty(thing, property) {
|
|
32
|
+
return (isDefined(thing) && typeof thing === "object" && property in thing);
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=typeGuards.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"typeGuards.js","sourceRoot":"","sources":["../../../src/util/typeGuards.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,UAAU,SAAS,CAAI,KAA2B;IACtD,OAAO,OAAO,KAAK,KAAK,WAAW,IAAI,KAAK,KAAK,IAAI,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACpC,KAAY,EACZ,UAA0B;IAE1B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;QAClD,OAAO,KAAK,CAAC;KACd;IAED,KAAK,MAAM,QAAQ,IAAI,UAAU,EAAE;QACjC,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,QAAQ,CAAC,EAAE;YACvC,OAAO,KAAK,CAAC;SACd;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAY,EACZ,QAAsB;IAEtB,OAAO,CACL,SAAS,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,QAAQ,IAAK,KAAiC,CAChG,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\n/**\n * Helper TypeGuard that checks if something is defined or not.\n * @param thing - Anything\n */\nexport function isDefined<T>(thing: T | undefined | null): thing is T {\n return typeof thing !== \"undefined\" && thing !== null;\n}\n\n/**\n * Helper TypeGuard that checks if the input is an object with the specified properties.\n * @param thing - Anything.\n * @param properties - The name of the properties that should appear in the object.\n */\nexport function isObjectWithProperties<Thing, PropertyName extends string>(\n thing: Thing,\n properties: PropertyName[]\n): thing is Thing & Record<PropertyName, unknown> {\n if (!isDefined(thing) || typeof thing !== \"object\") {\n return false;\n }\n\n for (const property of properties) {\n if (!objectHasProperty(thing, property)) {\n return false;\n }\n }\n\n return true;\n}\n\n/**\n * Helper TypeGuard that checks if the input is an object with the specified property.\n * @param thing - Any object.\n * @param property - The name of the property that should appear in the object.\n */\nexport function objectHasProperty<Thing, PropertyName extends string>(\n thing: Thing,\n property: PropertyName\n): thing is Thing & Record<PropertyName, unknown> {\n return (\n isDefined(thing) && typeof thing === \"object\" && property in (thing as Record<string, unknown>)\n );\n}\n"]}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
// Copyright (c) Microsoft Corporation.
|
|
2
|
+
// Licensed under the MIT license.
|
|
3
|
+
import { getHeaderName, setPlatformSpecificData } from "./userAgentPlatform";
|
|
4
|
+
import { SDK_VERSION } from "../constants";
|
|
5
|
+
function getUserAgentString(telemetryInfo) {
|
|
6
|
+
const parts = [];
|
|
7
|
+
for (const [key, value] of telemetryInfo) {
|
|
8
|
+
const token = value ? `${key}/${value}` : key;
|
|
9
|
+
parts.push(token);
|
|
10
|
+
}
|
|
11
|
+
return parts.join(" ");
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
export function getUserAgentHeaderName() {
|
|
17
|
+
return getHeaderName();
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* @internal
|
|
21
|
+
*/
|
|
22
|
+
export function getUserAgentValue(prefix) {
|
|
23
|
+
const runtimeInfo = new Map();
|
|
24
|
+
runtimeInfo.set("ts-http-runtime", SDK_VERSION);
|
|
25
|
+
setPlatformSpecificData(runtimeInfo);
|
|
26
|
+
const defaultAgent = getUserAgentString(runtimeInfo);
|
|
27
|
+
const userAgentValue = prefix ? `${prefix} ${defaultAgent}` : defaultAgent;
|
|
28
|
+
return userAgentValue;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=userAgent.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"userAgent.js","sourceRoot":"","sources":["../../../src/util/userAgent.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C,SAAS,kBAAkB,CAAC,aAAkC;IAC5D,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,aAAa,EAAE;QACxC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;KACnB;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB;IACpC,OAAO,aAAa,EAAE,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,MAAe;IAC/C,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC9C,WAAW,CAAC,GAAG,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IAChD,uBAAuB,CAAC,WAAW,CAAC,CAAC;IACrC,MAAM,YAAY,GAAG,kBAAkB,CAAC,WAAW,CAAC,CAAC;IACrD,MAAM,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,YAAY,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC;IAC3E,OAAO,cAAc,CAAC;AACxB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { getHeaderName, setPlatformSpecificData } from \"./userAgentPlatform\";\nimport { SDK_VERSION } from \"../constants\";\n\nfunction getUserAgentString(telemetryInfo: Map<string, string>): string {\n const parts: string[] = [];\n for (const [key, value] of telemetryInfo) {\n const token = value ? `${key}/${value}` : key;\n parts.push(token);\n }\n return parts.join(\" \");\n}\n\n/**\n * @internal\n */\nexport function getUserAgentHeaderName(): string {\n return getHeaderName();\n}\n\n/**\n * @internal\n */\nexport function getUserAgentValue(prefix?: string): string {\n const runtimeInfo = new Map<string, string>();\n runtimeInfo.set(\"ts-http-runtime\", SDK_VERSION);\n setPlatformSpecificData(runtimeInfo);\n const defaultAgent = getUserAgentString(runtimeInfo);\n const userAgentValue = prefix ? `${prefix} ${defaultAgent}` : defaultAgent;\n return userAgentValue;\n}\n"]}
|