@azure/keyvault-keys

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

EncryptionAlgorithm

EncryptionAlgorithm: "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5"

Defines values for EncryptionAlgorithm. Possible values include: 'RSA-OAEP', 'RSA-OAEP-256', 'RSA1_5'

readonly

KeyCurveName

KeyCurveName: "P-256" | "P-384" | "P-521" | "P-256K"

Defines values for KeyCurveName. Possible values include: 'P-256', 'P-384', 'P-521', 'P-256K'

readonly

KeyOperation

Defines values for KeyOperation. Possible values include: 'encrypt', 'decrypt', 'sign', 'verify', 'wrapKey', 'unwrapKey', 'import'

readonly

KeyType

KeyType: "EC" | "EC-HSM" | "RSA" | "RSA-HSM" | "oct"

Defines values for KeyType. Possible values include: 'EC', 'EC-HSM', 'RSA', 'RSA-HSM', 'oct'

readonly

KeyWrapAlgorithm

KeyWrapAlgorithm: "RSA-OAEP" | "RSA-OAEP-256" | "RSA1_5"

Supported algorithms for key wrapping/unwrapping

LocalCryptographyOperationFunction

LocalCryptographyOperationFunction: (keyPEM: string, data: Buffer) => Promise<Buffer>

Abstract representation of a Local Cryptography Operation function.

param: The string representation of a PEM key.
param: The data used on the cryptography operation, in Buffer type.

Type declaration

- (keyPEM: string, data: Buffer): Promise<Buffer>
- Parameters
  - keyPEM: string
  - data: Buffer
  Returns Promise<Buffer>

LocalCryptographyOperationFunctionWithSignature

LocalCryptographyOperationFunctionWithSignature: (keyPEM: string, data: Buffer, signature: Buffer) => Promise<boolean>

Abstract representation of a Local Cryptography Operation function, this time with an additional signature buffer.

param: The string representation of a PEM key.
param: The data used on the cryptography operation, in Buffer type.
param: The signature used on the cryptography operation, in Buffer type.

Type declaration

- (keyPEM: string, data: Buffer, signature: Buffer): Promise<boolean>
- Parameters
  - keyPEM: string
  - data: Buffer
  - signature: Buffer
  Returns Promise<boolean>

LocalCryptographyOperationName

LocalCryptographyOperationName: "encrypt" | "wrapKey" | "createHash" | "verify"

Union type representing the names of the supported local cryptography operations.

LocalCryptographyOperations

LocalCryptographyOperations: Record<LocalCryptographyOperationName, LocalCryptographyOperationFunction | LocalCryptographyOperationFunctionWithSignature>

Key-value map of local cryptography operations.

LocalSupportedAlgorithmName

LocalSupportedAlgorithmName: "RSA1_5" | "RSA-OAEP" | "PS256" | "RS256" | "PS384" | "RS384" | "PS512" | "RS512"

A union type representing the names of all of the locally supported algorithms.

LocalSupportedAlgorithmsRecord

LocalSupportedAlgorithmsRecord: Record<LocalSupportedAlgorithmName, LocalSupportedAlgorithm>

A Record containing all of the locally supported algorithms.

ParsedWWWAuthenticate

ParsedWWWAuthenticate: {}

Type declaration

RequireAtLeastOne

RequireAtLeastOne<T>: {}[keyof T]

TypeScript fancy for making plain objects require at least one key-value pair of another set of key-values.

Type parameters

SignAlgorithmName

SignAlgorithmName: "SHA256" | "SHA384" | "SHA512"

A union type representing the names of all of the locally supported sign algorithms.

SignatureAlgorithm

SignatureAlgorithm: "PS256" | "PS384" | "PS512" | "RS256" | "RS384" | "RS512" | "ES256" | "ES384" | "ES512" | "ES256K"

Defines values for SignatureAlgorithm.

readonly

ValidParsedWWWAuthenticateProperties

ValidParsedWWWAuthenticateProperties: "authorization" | "resource" | "scope"

Variables

Const LATEST_API_VERSION

LATEST_API_VERSION: "7.1" = "7.1"

The latest supported Key Vault service API version

Const logger

logger: any = createClientLogger("keyvault-keys")

The @azure/logger configuration for this package.

Functions

cancel

cancel(this: DeleteKeyPollOperation): Promise<DeleteKeyPollOperation>

- Defined in keyvault-keys/src/lro/delete/operation.ts:83
summary

Reaches to the service and cancels the key's operation, also updating the key's poll operation

Parameters
- this: DeleteKeyPollOperation
Returns Promise<DeleteKeyPollOperation>

challengeBasedAuthenticationPolicy

challengeBasedAuthenticationPolicy(credential: TokenCredential): RequestPolicyFactory

- Defined in keyvault-common/src/challengeBasedAuthenticationPolicy.ts:67
Creates a new ChallengeBasedAuthenticationPolicy factory.

Parameters
- credential: TokenCredential
  
  The TokenCredential implementation that can supply the challenge token.
Returns RequestPolicyFactory

checkKeyValidity

checkKeyValidity(keyId?: undefined | string, keyBundle?: KeyBundle): void

- Defined in keyvault-keys/src/cryptographyClient.ts:58
Checks whether a key can be used at that specific moment, by comparing the current date with the bundle's notBefore and expires values.

Parameters
- Optional keyId: undefined | string
- Optional keyBundle: KeyBundle
Returns void

formatBase64Sequence

formatBase64Sequence(base64Sequence: string): string

- Defined in keyvault-keys/src/localCryptography/conversions.ts:77
Fill in the PEM with 64 character lines as per RFC:

"To represent the encapsulated text of a PEM message, the encoding function's output is delimited into text lines (using local conventions), with each line except the last containing exactly 64 printable characters and the final line containing 64 or fewer printable characters."

Parameters
- base64Sequence: string
Returns string

isLocallySupported

isLocallySupported(algorithm: string): boolean

- Defined in keyvault-keys/src/localCryptography/algorithms.ts:241
Checks whether a given algorithm name is supported or not.

Parameters
- algorithm: string
  
  string name of the algorithm
Returns boolean

makeDeleteKeyPollOperation

makeDeleteKeyPollOperation(state: DeleteKeyPollOperationState): DeleteKeyPollOperation

- Defined in keyvault-keys/src/lro/delete/operation.ts:100
summary

Builds a create key's poll operation

Parameters
- state: DeleteKeyPollOperationState
Returns DeleteKeyPollOperation

makeRecoverDeletedKeyPollOperation

makeRecoverDeletedKeyPollOperation(state: RecoverDeletedKeyPollOperationState): RecoverDeletedKeyPollOperation

- Defined in keyvault-keys/src/lro/recover/operation.ts:106
summary

Builds a create key's poll operation

Parameters
- state: RecoverDeletedKeyPollOperationState
Returns RecoverDeletedKeyPollOperation

makeSequence

makeSequence(encodedParts: Uint8Array[]): string

- Defined in keyvault-keys/src/localCryptography/conversions.ts:55
Parameters
- encodedParts: Uint8Array[]
Returns string

Const makeSigner

makeSigner(signAlgorithm: SignAlgorithmName): LocalSupportedAlgorithm

- Defined in keyvault-keys/src/localCryptography/algorithms.ts:197
Since sign algorithms behave almost the same, we're making a generator to save up code. We receive the sign algorithm, from the list of names in SignAlgorithmName, then we generate a LocalSupportedAlgorithm that only create hashes and verifies signatures.

Parameters
- signAlgorithm: SignAlgorithmName
Returns LocalSupportedAlgorithm

parseKeyVaultKeyId

parseKeyVaultKeyId(id: string): KeyVaultKeyId

- Defined in keyvault-keys/src/identifier.ts:50
Parses the given Key Vault Key Id. An example is:

https://.vault.azure.net/keys//

On parsing the above Id, this function returns:

{ sourceId: "https://.vault.azure.net/keys//", vaultUrl: "https://.vault.azure.net", version: "", name: "" }

Parameters
- id: string
  
  The Id of the Key Vault Key.
Returns KeyVaultKeyId

parseWWWAuthenticate

parseWWWAuthenticate(wwwAuthenticate: string): ParsedWWWAuthenticate

- Defined in keyvault-common/src/challengeBasedAuthenticationPolicy.ts:93
Parses an WWW-Authenticate response. This transforms a string value like: Bearer authorization="some_authorization", resource="https://some.url" into an object like: { authorization: "some_authorization", resource: "https://some.url" }

Parameters
- wwwAuthenticate: string
  
  string value in the WWW-Authenticate header
Returns ParsedWWWAuthenticate

Const pipeAssertions

pipeAssertions(...assertions: LocalAssertion[]): LocalAssertion

- Defined in keyvault-keys/src/localCryptography/algorithms.ts:77
pipeAssertions allows us to execute a sequence of assertions.

Parameters
- Rest ...assertions: LocalAssertion[]
  
  One or more LocalAssertions
Returns LocalAssertion

runOperation

runOperation(key: JsonWebKey, operationName: LocalCryptographyOperationName, algorithmName: LocalSupportedAlgorithmName, data: Buffer, signature?: Buffer): Promise<Buffer | boolean>

- Defined in keyvault-keys/src/localCryptography/runOperation.ts:14
Parameters
- key: JsonWebKey
- operationName: LocalCryptographyOperationName
- algorithmName: LocalSupportedAlgorithmName
- data: Buffer
- Optional signature: Buffer
Returns Promise<Buffer | boolean>

toString

toString(this: DeleteKeyPollOperation): string

- Defined in keyvault-keys/src/lro/delete/operation.ts:90
summary

Serializes the create key's poll operation

Parameters
- this: DeleteKeyPollOperation
Returns string

update

update(this: DeleteKeyPollOperation, options?: { abortSignal?: AbortSignalLike; fireProgress?: undefined | ((state: DeleteKeyPollOperationState) => void) }): Promise<DeleteKeyPollOperation>

- Defined in keyvault-keys/src/lro/delete/operation.ts:37
summary

Reaches to the service and updates the delete key's poll operation.

Parameters
- this: DeleteKeyPollOperation
- Default value options: { abortSignal?: AbortSignalLike; fireProgress?: undefined | ((state: DeleteKeyPollOperationState) => void) } = {}
  - Optional abortSignal?: AbortSignalLike
  - Optional fireProgress?: undefined | ((state: DeleteKeyPollOperationState) => void)
Returns Promise<DeleteKeyPollOperation>

Object literals

Const RSA1_5

RSA1_5: object

Local support of the RSA1_5 algorithm. We currently only support encrypting and wrapping keys with it.

validate

validate: (key?: JsonWebKey, operationName?: LocalCryptographyOperationName) => void = pipeAssertions(assertions.keyOps, assertions.rsa, assertions.nodeOnly)

Type declaration

- (key?: JsonWebKey, operationName?: LocalCryptographyOperationName): void
- Parameters
  - Optional key: JsonWebKey
  - Optional operationName: LocalCryptographyOperationName
  Returns void

operations

operations: object

encrypt

encrypt(keyPEM: string, data: Buffer): Promise<Buffer>

- Defined in keyvault-keys/src/localCryptography/algorithms.ts:161
Parameters
- keyPEM: string
- data: Buffer
Returns Promise<Buffer>

wrapKey

wrapKey(keyPEM: string, data: Buffer): Promise<Buffer>

- Defined in keyvault-keys/src/localCryptography/algorithms.ts:164
Parameters
- keyPEM: string
- data: Buffer
Returns Promise<Buffer>

Const RSA_OAEP

RSA_OAEP: object

Local support of the RSA-OAEP algorithm. We currently only support encrypting and wrapping keys with it.

validate

validate: (key?: JsonWebKey, operationName?: LocalCryptographyOperationName) => void = pipeAssertions(assertions.keyOps, assertions.rsa, assertions.nodeOnly)

Type declaration

- (key?: JsonWebKey, operationName?: LocalCryptographyOperationName): void
- Parameters
  - Optional key: JsonWebKey
  - Optional operationName: LocalCryptographyOperationName
  Returns void

operations

operations: object

encrypt

encrypt(keyPEM: string, data: Buffer): Promise<Buffer>

- Defined in keyvault-keys/src/localCryptography/algorithms.ts:177
Parameters
- keyPEM: string
- data: Buffer
Returns Promise<Buffer>

wrapKey

wrapKey(keyPEM: string, data: Buffer): Promise<Buffer>

- Defined in keyvault-keys/src/localCryptography/algorithms.ts:180
Parameters
- keyPEM: string
- data: Buffer
Returns Promise<Buffer>

Const localSupportedAlgorithms

localSupportedAlgorithms: object

A plain object containing all of the locally supported algorithms.

PS256

PS256: LocalSupportedAlgorithm = makeSigner("SHA256")

PS384

PS384: LocalSupportedAlgorithm = makeSigner("SHA384")

PS512

PS512: LocalSupportedAlgorithm = makeSigner("SHA512")

RS256

RS256: LocalSupportedAlgorithm = makeSigner("SHA256")

RS384

RS384: LocalSupportedAlgorithm = makeSigner("SHA384")

RS512

RS512: LocalSupportedAlgorithm = makeSigner("SHA512")

RSA-OAEP

RSA-OAEP: LocalSupportedAlgorithm = RSA_OAEP

RSA1_5

RSA1_5: LocalSupportedAlgorithm

Index

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

EncryptionAlgorithm

KeyCurveName

KeyOperation

KeyType

KeyWrapAlgorithm

LocalCryptographyOperationFunction

Type declaration

Parameters

keyPEM: string

data: Buffer

Returns Promise<Buffer>

LocalCryptographyOperationFunctionWithSignature

Type declaration

Parameters

keyPEM: string

data: Buffer

signature: Buffer

Returns Promise<boolean>

LocalCryptographyOperationName

LocalCryptographyOperations

LocalSupportedAlgorithmName

LocalSupportedAlgorithmsRecord

ParsedWWWAuthenticate

Type declaration

RequireAtLeastOne

Type parameters

T

SignAlgorithmName

SignatureAlgorithm

ValidParsedWWWAuthenticateProperties

Variables

Const LATEST_API_VERSION

Const logger

Functions

cancel

Parameters

this: DeleteKeyPollOperation

Returns Promise<DeleteKeyPollOperation>

challengeBasedAuthenticationPolicy

Parameters

credential: TokenCredential

Returns RequestPolicyFactory

checkKeyValidity

Parameters

Optional keyId: undefined | string

Optional keyBundle: KeyBundle

Returns void

formatBase64Sequence

Parameters

base64Sequence: string

Returns string

isLocallySupported

Parameters

algorithm: string

Returns boolean

makeDeleteKeyPollOperation

Parameters

state: DeleteKeyPollOperationState

Returns DeleteKeyPollOperation

makeRecoverDeletedKeyPollOperation

Parameters

state: RecoverDeletedKeyPollOperationState

Returns RecoverDeletedKeyPollOperation

makeSequence

Parameters

encodedParts: Uint8Array[]

Returns string

Const makeSigner

Parameters

signAlgorithm: SignAlgorithmName

Returns LocalSupportedAlgorithm

parseKeyVaultKeyId