-
Notifications
You must be signed in to change notification settings - Fork 14
CI Update #78
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
CI Update #78
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| ### YamlMime:TSType | ||
| name: CryptoProvider | ||
| uid: '@azure/msal-node.CryptoProvider' | ||
| package: '@azure/msal-node' | ||
| summary: >- | ||
| This class implements MSAL node's crypto interface, which allows it to perform | ||
| base64 encoding and decoding, generating cryptographically random GUIDs and | ||
|
|
||
| implementing Proof Key for Code Exchange specs for the OAuth Authorization | ||
| Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636). | ||
| fullName: CryptoProvider | ||
| remarks: '' | ||
| isDeprecated: false | ||
| type: class | ||
| methods: | ||
| - name: base64Decode(string) | ||
| uid: '@azure/msal-node.CryptoProvider.base64Decode' | ||
| package: '@azure/msal-node' | ||
| summary: Decodes input string from base64. | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function base64Decode(input: string): string' | ||
| parameters: | ||
| - id: input | ||
| type: string | ||
| description: string to be decoded | ||
| return: | ||
| description: '' | ||
| type: string | ||
| - name: base64Encode(string) | ||
| uid: '@azure/msal-node.CryptoProvider.base64Encode' | ||
| package: '@azure/msal-node' | ||
| summary: Encodes input string to base64. | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function base64Encode(input: string): string' | ||
| parameters: | ||
| - id: input | ||
| type: string | ||
| description: string to be encoded | ||
| return: | ||
| description: '' | ||
| type: string | ||
| - name: base64UrlEncode() | ||
| uid: '@azure/msal-node.CryptoProvider.base64UrlEncode' | ||
| package: '@azure/msal-node' | ||
| summary: base64 URL safe encoded string | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function base64UrlEncode(): string' | ||
| return: | ||
| description: '' | ||
| type: string | ||
|
Comment on lines
+46
to
+56
|
||
| - name: clearKeystore() | ||
| uid: '@azure/msal-node.CryptoProvider.clearKeystore' | ||
| package: '@azure/msal-node' | ||
| summary: Removes all cryptographic keys from Keystore | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function clearKeystore(): Promise<boolean>' | ||
| return: | ||
| description: '' | ||
| type: Promise<boolean> | ||
| - name: createNewGuid() | ||
| uid: '@azure/msal-node.CryptoProvider.createNewGuid' | ||
| package: '@azure/msal-node' | ||
| summary: Creates a new random GUID - used to populate state and nonce. | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function createNewGuid(): string' | ||
| return: | ||
| description: string (GUID) | ||
| type: string | ||
| - name: encodeKid() | ||
| uid: '@azure/msal-node.CryptoProvider.encodeKid' | ||
| package: '@azure/msal-node' | ||
| summary: Stringifies and base64Url encodes input public key | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function encodeKid(): string' | ||
| return: | ||
| description: Base64Url encoded public key | ||
| type: string | ||
|
Comment on lines
+79
to
+89
|
||
| - name: generatePkceCodes() | ||
| uid: '@azure/msal-node.CryptoProvider.generatePkceCodes' | ||
| package: '@azure/msal-node' | ||
| summary: Generates PKCE codes used in Authorization Code Flow. | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function generatePkceCodes(): Promise<PkceCodes>' | ||
| return: | ||
| description: '' | ||
| type: Promise<<xref uid="@azure/msal-common.PkceCodes" />> | ||
| - name: getPublicKeyThumbprint() | ||
| uid: '@azure/msal-node.CryptoProvider.getPublicKeyThumbprint' | ||
| package: '@azure/msal-node' | ||
| summary: >- | ||
| Generates a keypair, stores it and returns a thumbprint - not yet | ||
| implemented for node | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function getPublicKeyThumbprint(): Promise<string>' | ||
| return: | ||
| description: '' | ||
| type: Promise<string> | ||
| - name: hashString(string) | ||
| uid: '@azure/msal-node.CryptoProvider.hashString' | ||
| package: '@azure/msal-node' | ||
| summary: Returns the SHA-256 hash of an input string | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function hashString(plainText: string): Promise<string>' | ||
| parameters: | ||
| - id: plainText | ||
| type: string | ||
| description: '' | ||
| return: | ||
| description: '' | ||
| type: Promise<string> | ||
| - name: removeTokenBindingKey() | ||
| uid: '@azure/msal-node.CryptoProvider.removeTokenBindingKey' | ||
| package: '@azure/msal-node' | ||
| summary: Removes cryptographic keypair from key store matching the keyId passed in | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function removeTokenBindingKey(): Promise<void>' | ||
| return: | ||
| description: '' | ||
| type: Promise<void> | ||
|
Comment on lines
+129
to
+139
|
||
| - name: signJwt() | ||
| uid: '@azure/msal-node.CryptoProvider.signJwt' | ||
| package: '@azure/msal-node' | ||
| summary: >- | ||
| Signs the given object as a jwt payload with private key retrieved by | ||
| given kid - currently not implemented for node | ||
| remarks: '' | ||
| isDeprecated: false | ||
| syntax: | ||
| content: 'function signJwt(): Promise<string>' | ||
| return: | ||
| description: '' | ||
| type: Promise<string> | ||
|
Comment on lines
+140
to
+152
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The newly added
correlationIdparameter is undocumented (empty description). Add a short description explaining what the ID represents (e.g., request/operation correlation used for telemetry/tracing) and any expectations about its format.