Class KmsRsaPssProviderAbstract

Hierarchy

  • RsaPssProvider
    • KmsRsaPssProvider

Constructors

constructor

Properties

hashAlgorithms name usages

Methods

checkAlgorithmName checkAlgorithmParams checkCryptoKey checkDecrypt checkDeriveBits checkDerivedKeyParams checkDigest checkEncrypt checkExportKey checkGenerateKey checkGenerateKeyParams checkHashAlgorithm checkImportKey checkImportParams checkKeyData checkKeyFormat checkKeyUsages checkRequiredProperty checkSign checkVerify close decrypt deriveBits destroyKey digest encrypt exportKey generateKey importKey onDecrypt onDeriveBits onDigest onEncrypt onExportKey onGenerateKey onImportKey onSign onVerify sign verify

Constructors

constructor

Properties

hashAlgorithms

hashAlgorithms: string[]

Readonlyname

name: "RSA-PSS" = "RSA-PSS"

Name of the algorithm

usages

usages: ProviderKeyUsages

Key usages for secret key or key pair

Methods

checkAlgorithmName

  • checkAlgorithmName(algorithm): void

  • Parameters

    • algorithm: Algorithm

    Returns void

checkAlgorithmParams

  • checkAlgorithmParams(algorithm): void

  • Parameters

    • algorithm: RsaPssParams

    Returns void

checkCryptoKey

  • checkCryptoKey(key, keyUsage?): void

  • Parameters

    • key: CryptoKey
    • OptionalkeyUsage: KeyUsage

    Returns void

checkDecrypt

  • checkDecrypt(algorithm, key, _data, options?, ..._args): void

  • Parameters

    • algorithm: Algorithm
    • key: CryptoKey
    • _data: ArrayBuffer
    • Optionaloptions: IProviderCheckOptions
    • Rest..._args: any[]

    Returns void

checkDeriveBits

  • checkDeriveBits(algorithm, baseKey, length, options?, ..._args): void

  • Parameters

    • algorithm: Algorithm
    • baseKey: CryptoKey
    • length: number
    • Optionaloptions: IProviderCheckOptions
    • Rest..._args: any[]

    Returns void

checkDerivedKeyParams

  • checkDerivedKeyParams(_algorithm): void

  • Parameters

    • _algorithm: Algorithm

    Returns void

checkDigest

  • checkDigest(algorithm, _data): void

  • Parameters

    • algorithm: Algorithm
    • _data: ArrayBuffer

    Returns void

checkEncrypt

  • checkEncrypt(algorithm, key, _data, options?, ..._args): void

  • Parameters

    • algorithm: Algorithm
    • key: CryptoKey
    • _data: ArrayBuffer
    • Optionaloptions: IProviderCheckOptions
    • Rest..._args: any[]

    Returns void

checkExportKey

  • checkExportKey(format, key, ..._args): void

  • Parameters

    • format: KeyFormat
    • key: CryptoKey
    • Rest..._args: any[]

    Returns void

checkGenerateKey

  • checkGenerateKey(algorithm, _extractable, keyUsages, ..._args): void

  • Parameters

    • algorithm: Algorithm
    • _extractable: boolean
    • keyUsages: KeyUsage[]
    • Rest..._args: any[]

    Returns void

checkGenerateKeyParams

  • checkGenerateKeyParams(algorithm): void

  • Parameters

    • algorithm: RsaHashedKeyGenParams

    Returns void

checkHashAlgorithm

  • checkHashAlgorithm(algorithm, hashAlgorithms): void

  • Parameters

    • algorithm: Algorithm
    • hashAlgorithms: string[]

    Returns void

checkImportKey

  • checkImportKey(format, keyData, algorithm, _extractable, keyUsages, ..._args): void

  • Parameters

    • format: KeyFormat
    • keyData: ArrayBuffer | JsonWebKey
    • algorithm: Algorithm
    • _extractable: boolean
    • keyUsages: KeyUsage[]
    • Rest..._args: any[]

    Returns void

checkImportParams

  • checkImportParams(algorithm): void

  • Parameters

    • algorithm: RsaHashedImportParams

    Returns void

checkKeyData

  • checkKeyData(format, keyData): void

  • Parameters

    • format: KeyFormat
    • keyData: any

    Returns void

checkKeyFormat

  • checkKeyFormat(format): void

  • Parameters

    • format: any

    Returns void

checkKeyUsages

  • checkKeyUsages(usages, allowed): void

  • Parameters

    • usages: KeyUsages
    • allowed: KeyUsages

    Returns void

checkRequiredProperty

  • checkRequiredProperty(data, propName): void

  • Parameters

    • data: object
    • propName: string

    Returns void

checkSign

  • checkSign(algorithm, key, _data, ..._args): void

  • Parameters

    • algorithm: Algorithm
    • key: CryptoKey
    • _data: ArrayBuffer
    • Rest..._args: any[]

    Returns void

checkVerify

  • checkVerify(algorithm, key, _signature, _data, ..._args): void

  • Parameters

    • algorithm: Algorithm
    • key: CryptoKey
    • _signature: ArrayBuffer
    • _data: ArrayBuffer
    • Rest..._args: any[]

    Returns void

Abstractclose

decrypt

  • decrypt(algorithm, key, data, options?, ...args): Promise<ArrayBuffer>

  • Parameters

    • algorithm: Algorithm
    • key: CryptoKey
    • data: ArrayBuffer
    • Optionaloptions: IProviderCheckOptions
    • Rest...args: any[]

    Returns Promise<ArrayBuffer>

deriveBits

  • deriveBits(algorithm, baseKey, length, options?, ...args): Promise<ArrayBuffer>

  • Parameters

    • algorithm: Algorithm
    • baseKey: CryptoKey
    • length: number
    • Optionaloptions: IProviderCheckOptions
    • Rest...args: any[]

    Returns Promise<ArrayBuffer>

AbstractdestroyKey

digest

  • digest(algorithm, data, ...args): Promise<ArrayBuffer>

  • Parameters

    • algorithm: Algorithm
    • data: ArrayBuffer
    • Rest...args: any[]

    Returns Promise<ArrayBuffer>

encrypt

  • encrypt(algorithm, key, data, options?, ...args): Promise<ArrayBuffer>

  • Parameters

    • algorithm: Algorithm
    • key: CryptoKey
    • data: ArrayBuffer
    • Optionaloptions: IProviderCheckOptions
    • Rest...args: any[]

    Returns Promise<ArrayBuffer>

exportKey

  • exportKey(format, key, ...args): Promise<ArrayBuffer | JsonWebKey>

  • Parameters

    • format: KeyFormat
    • key: CryptoKey
    • Rest...args: any[]

    Returns Promise<ArrayBuffer | JsonWebKey>

generateKey

  • generateKey(algorithm, extractable, keyUsages): Promise<CryptoKeyPair>

  • Parameters

    • algorithm: "Ed25519"
    • extractable: boolean
    • keyUsages: readonly ("sign" | "verify")[]

    Returns Promise<CryptoKeyPair>

  • generateKey(algorithm, extractable, keyUsages): Promise<CryptoKeyPair>

  • Parameters

    • algorithm: RsaHashedKeyGenParams | EcKeyGenParams
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<CryptoKeyPair>

  • generateKey(algorithm, extractable, keyUsages): Promise<CryptoKey>

  • Parameters

    • algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<CryptoKey>

  • generateKey(algorithm, extractable, keyUsages, ...args): Promise<CryptoKey | CryptoKeyPair>

  • Parameters

    • algorithm: Algorithm
    • extractable: boolean
    • keyUsages: KeyUsage[]
    • Rest...args: any[]

    Returns Promise<CryptoKey | CryptoKeyPair>

importKey

  • importKey(format, keyData, algorithm, extractable, keyUsages, ...args): Promise<CryptoKey>

  • Parameters

    • format: KeyFormat
    • keyData: ArrayBuffer | JsonWebKey
    • algorithm: Algorithm
    • extractable: boolean
    • keyUsages: KeyUsage[]
    • Rest...args: any[]

    Returns Promise<CryptoKey>

onDecrypt

  • onDecrypt(_algorithm, _key, _data, ..._args): Promise<ArrayBuffer>

  • Parameters

    • _algorithm: Algorithm
    • _key: CryptoKey
    • _data: ArrayBuffer
    • Rest..._args: any[]

    Returns Promise<ArrayBuffer>

onDeriveBits

  • onDeriveBits(_algorithm, _baseKey, _length, ..._args): Promise<ArrayBuffer>

  • Parameters

    • _algorithm: Algorithm
    • _baseKey: CryptoKey
    • _length: number
    • Rest..._args: any[]

    Returns Promise<ArrayBuffer>

onDigest

  • onDigest(_algorithm, _data): Promise<ArrayBuffer>

  • Parameters

    • _algorithm: Algorithm
    • _data: ArrayBuffer

    Returns Promise<ArrayBuffer>

onEncrypt

  • onEncrypt(_algorithm, _key, _data, ..._args): Promise<ArrayBuffer>

  • Parameters

    • _algorithm: Algorithm
    • _key: CryptoKey
    • _data: ArrayBuffer
    • Rest..._args: any[]

    Returns Promise<ArrayBuffer>

AbstractonExportKey

  • onExportKey(format, key, ...args): Promise<ArrayBuffer | JsonWebKey>

  • Parameters

    • format: KeyFormat
    • key: CryptoKey$1
    • Rest...args: any[]

    Returns Promise<ArrayBuffer | JsonWebKey>

AbstractonGenerateKey

  • onGenerateKey(algorithm, extractable, keyUsages, ...args): Promise<CryptoKeyPair>

  • Parameters

    • algorithm: RsaHashedKeyGenParams
    • extractable: boolean
    • keyUsages: KeyUsage[]
    • Rest...args: any[]

    Returns Promise<CryptoKeyPair>

AbstractonImportKey

  • onImportKey(format, keyData, algorithm, extractable, keyUsages, ...args): Promise<CryptoKey$1>

  • Parameters

    • format: KeyFormat
    • keyData: ArrayBuffer | JsonWebKey
    • algorithm: RsaHashedImportParams
    • extractable: boolean
    • keyUsages: KeyUsage[]
    • Rest...args: any[]

    Returns Promise<CryptoKey$1>

AbstractonSign

  • onSign(algorithm, key, data, ...args): Promise<ArrayBuffer>

  • Parameters

    • algorithm: RsaPssParams
    • key: CryptoKey
    • data: ArrayBuffer
    • Rest...args: any[]

    Returns Promise<ArrayBuffer>

AbstractonVerify

  • onVerify(algorithm, key, signature, data, ...args): Promise<boolean>

  • Parameters

    • algorithm: RsaPssParams
    • key: CryptoKey
    • signature: ArrayBuffer
    • data: ArrayBuffer
    • Rest...args: any[]

    Returns Promise<boolean>

sign

  • sign(algorithm, key, data, ...args): Promise<ArrayBuffer>

  • Parameters

    • algorithm: Algorithm
    • key: CryptoKey
    • data: ArrayBuffer
    • Rest...args: any[]

    Returns Promise<ArrayBuffer>

verify

  • verify(algorithm, key, signature, data, ...args): Promise<boolean>

  • Parameters

    • algorithm: Algorithm
    • key: CryptoKey
    • signature: ArrayBuffer
    • data: ArrayBuffer
    • Rest...args: any[]

    Returns Promise<boolean>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods