Class CryptoProvider

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).

Hierarchy

CryptoProvider

Implements

ICrypto

Index

Constructors

Methods

base64Decode base64Encode base64UrlEncode clearKeystore createNewGuid encodeKid generatePkceCodes getPublicKeyThumbprint hashString removeTokenBindingKey signJwt

Constructors

constructor

new CryptoProvider(): CryptoProvider
Returns CryptoProvider
- Defined in msal-node/src/crypto/CryptoProvider.ts:22

Methods

base64Decode

base64Decode(input): string
Decodes input string from base64.
Parameters
- input: string
  
  string to be decoded
Returns string
Implementation of ICrypto.base64Decode
- Defined in msal-node/src/crypto/CryptoProvider.ts:64

base64Encode

base64Encode(input): string
Encodes input string to base64.
Parameters
- input: string
  
  string to be encoded
Returns string
Implementation of ICrypto.base64Encode
- Defined in msal-node/src/crypto/CryptoProvider.ts:56

base64UrlEncode

base64UrlEncode(): string
base64 URL safe encoded string

Returns string
Implementation of ICrypto.base64UrlEncode
- Defined in msal-node/src/crypto/CryptoProvider.ts:32

clearKeystore

clearKeystore(): Promise<boolean>
Removes all cryptographic keys from Keystore

Returns Promise<boolean>
Implementation of ICrypto.clearKeystore
- Defined in msal-node/src/crypto/CryptoProvider.ts:93

createNewGuid

createNewGuid(): string
Creates a new random GUID - used to populate state and nonce.

Returns string
string (GUID)
Implementation of ICrypto.createNewGuid
- Defined in msal-node/src/crypto/CryptoProvider.ts:48

encodeKid

encodeKid(): string
Stringifies and base64Url encodes input public key

Returns string
Base64Url encoded public key
Implementation of ICrypto.encodeKid
- Defined in msal-node/src/crypto/CryptoProvider.ts:40

generatePkceCodes

generatePkceCodes(): Promise<PkceCodes>
Generates PKCE codes used in Authorization Code Flow.

Returns Promise<PkceCodes>
- Defined in msal-node/src/crypto/CryptoProvider.ts:71

getPublicKeyThumbprint

getPublicKeyThumbprint(): Promise<string>
Generates a keypair, stores it and returns a thumbprint - not yet implemented for node

Returns Promise<string>
Implementation of ICrypto.getPublicKeyThumbprint
- Defined in msal-node/src/crypto/CryptoProvider.ts:78

hashString

hashString(plainText): Promise<string>
Returns the SHA-256 hash of an input string
Parameters
- plainText: string
Returns Promise<string>
Implementation of ICrypto.hashString
- Defined in msal-node/src/crypto/CryptoProvider.ts:107

removeTokenBindingKey

removeTokenBindingKey(): Promise<boolean>
Removes cryptographic keypair from key store matching the keyId passed in

Returns Promise<boolean>
Implementation of ICrypto.removeTokenBindingKey
- Defined in msal-node/src/crypto/CryptoProvider.ts:86

signJwt

signJwt(): Promise<string>
Signs the given object as a jwt payload with private key retrieved by given kid - currently not implemented for node

Returns Promise<string>
Implementation of ICrypto.signJwt
- Defined in msal-node/src/crypto/CryptoProvider.ts:100

Generated using TypeDoc