Class CryptoEngine

Default cryptographic engine for Web Cryptography API

Hierarchy

AbstractCryptoEngine
- CryptoEngine

Constructors

constructor

new CryptoEngine(parameters: CryptoEngineParameters): CryptoEngine
Constructor for CryptoEngine class
Parameters
- parameters: CryptoEngineParameters
Returns CryptoEngine
Inherited from AbstractCryptoEngine.constructor
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:18

Properties

crypto

crypto: Crypto

name

name: string

subtle

subtle: SubtleCrypto

Methods

convert

convert(inputFormat: KeyFormat, outputFormat: KeyFormat, keyData: ArrayBuffer | JsonWebKey, algorithm: Algorithm, extractable: boolean, keyUsages: KeyUsage[]): Promise<ArrayBuffer | JsonWebKey>
Convert WebCrypto keys between different export formats
Parameters
- inputFormat: KeyFormat
- outputFormat: KeyFormat
- keyData: ArrayBuffer | JsonWebKey
- algorithm: Algorithm
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<ArrayBuffer | JsonWebKey>
- Defined in src/CryptoEngine/CryptoEngine.ts:638

decrypt

decrypt(algorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>
Parameters
- algorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams
- key: CryptoKey
- data: BufferSource
Returns Promise<ArrayBuffer>
Inherited from AbstractCryptoEngine.decrypt
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:45

decryptEncryptedContentInfo

decryptEncryptedContentInfo(parameters: CryptoEngineDecryptParams): Promise<ArrayBuffer>
Decrypt data stored in "EncryptedContentInfo" object using parameters
Parameters
- parameters: CryptoEngineDecryptParams
Returns Promise<ArrayBuffer>
Overrides AbstractCryptoEngine.decryptEncryptedContentInfo
- Defined in src/CryptoEngine/CryptoEngine.ts:1653

deriveBits

deriveBits(algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, length: number): Promise<ArrayBuffer>
Parameters
- algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params
- baseKey: CryptoKey
- length: number
Returns Promise<ArrayBuffer>
Inherited from AbstractCryptoEngine.deriveBits
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:78

deriveKey

deriveKey(algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, derivedKeyType: AesDerivedKeyParams | AlgorithmIdentifier | HkdfParams | HmacImportParams | Pbkdf2Params, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>
Parameters
- algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params
- baseKey: CryptoKey
- derivedKeyType: AesDerivedKeyParams | AlgorithmIdentifier | HkdfParams | HmacImportParams | Pbkdf2Params
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
Inherited from AbstractCryptoEngine.deriveKey
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:72
deriveKey(algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params, baseKey: CryptoKey, derivedKeyType: AesDerivedKeyParams | AlgorithmIdentifier | HkdfParams | HmacImportParams | Pbkdf2Params, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKey>
Parameters
- algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params
- baseKey: CryptoKey
- derivedKeyType: AesDerivedKeyParams | AlgorithmIdentifier | HkdfParams | HmacImportParams | Pbkdf2Params
- extractable: boolean
- keyUsages: Iterable<KeyUsage>
Returns Promise<CryptoKey>
Inherited from AbstractCryptoEngine.deriveKey
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:73

digest

digest(algorithm: AlgorithmIdentifier, data: BufferSource): Promise<ArrayBuffer>
Parameters
- algorithm: AlgorithmIdentifier
- data: BufferSource
Returns Promise<ArrayBuffer>
Inherited from AbstractCryptoEngine.digest
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:60

encrypt

encrypt(algorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>
Parameters
- algorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams
- key: CryptoKey
- data: BufferSource
Returns Promise<ArrayBuffer>
Inherited from AbstractCryptoEngine.encrypt
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:40

encryptEncryptedContentInfo

encryptEncryptedContentInfo(parameters: CryptoEngineEncryptParams): Promise<EncryptedContentInfo>
Specialized function encrypting "EncryptedContentInfo" object using parameters
Parameters
- parameters: CryptoEngineEncryptParams
Returns Promise<EncryptedContentInfo>
Overrides AbstractCryptoEngine.encryptEncryptedContentInfo
- Defined in src/CryptoEngine/CryptoEngine.ts:1547

exportKey

exportKey(format: "jwk", key: CryptoKey): Promise<JsonWebKey>
Export WebCrypto keys to different formats
Parameters
- format: "jwk"
- key: CryptoKey
Returns Promise<JsonWebKey>
Overrides AbstractCryptoEngine.exportKey
- Defined in src/CryptoEngine/CryptoEngine.ts:580
exportKey(format: "raw" | "pkcs8" | "spki", key: CryptoKey): Promise<ArrayBuffer>
Parameters
- format: "raw" | "pkcs8" | "spki"
- key: CryptoKey
Returns Promise<ArrayBuffer>
Overrides AbstractCryptoEngine.exportKey
- Defined in src/CryptoEngine/CryptoEngine.ts:581
exportKey(format: string, key: CryptoKey): Promise<ArrayBuffer | JsonWebKey>
Parameters
- format: string
- key: CryptoKey
Returns Promise<ArrayBuffer | JsonWebKey>
Overrides AbstractCryptoEngine.exportKey
- Defined in src/CryptoEngine/CryptoEngine.ts:582

fillPublicKeyParameters

fillPublicKeyParameters(publicKeyInfo: PublicKeyInfo, signatureAlgorithm: AlgorithmIdentifier): CryptoEnginePublicKeyParams
Parameters
- publicKeyInfo: PublicKeyInfo
- signatureAlgorithm: AlgorithmIdentifier
Returns CryptoEnginePublicKeyParams
- Defined in src/CryptoEngine/CryptoEngine.ts:1941

generateKey

generateKey(algorithm: EcKeyGenParams | RsaHashedKeyGenParams, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKeyPair>
Parameters
- algorithm: EcKeyGenParams | RsaHashedKeyGenParams
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKeyPair>
Inherited from AbstractCryptoEngine.generateKey
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:65
generateKey(algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>
Parameters
- algorithm: AesKeyGenParams | HmacKeyGenParams | Pbkdf2Params
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
Inherited from AbstractCryptoEngine.generateKey
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:66
generateKey(algorithm: AlgorithmIdentifier, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKeyPair | CryptoKey>
Parameters
- algorithm: AlgorithmIdentifier
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKeyPair | CryptoKey>
Inherited from AbstractCryptoEngine.generateKey
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:67

getAlgorithmByOID

getAlgorithmByOID<T>(oid: string, safety?: boolean, target?: string): object | T
Gets WebCrypto algorithm by wel-known OID

Returns
Returns WebCrypto algorithm or an empty object
Type Parameters
- T extends Algorithm = Algorithm
Parameters
- oid: string
  
  algorithm identifier
- Optional safety: boolean
  
  if true throws exception on unknown algorithm identifier
- Optional target: string
  
  name of the target
Returns object | T
Overrides AbstractCryptoEngine.getAlgorithmByOID
- Defined in src/CryptoEngine/CryptoEngine.ts:654
getAlgorithmByOID<T>(oid: string, safety: true, target?: string): T
Gets WebCrypto algorithm by wel-known OID

Returns
Returns WebCrypto algorithm

Throws
Throws Error exception if unknown algorithm identifier
Type Parameters
- T extends Algorithm = Algorithm
Parameters
- oid: string
  
  algorithm identifier
- safety: true
  
  if true throws exception on unknown algorithm identifier
- Optional target: string
  
  name of the target
Returns T
Overrides AbstractCryptoEngine.getAlgorithmByOID
- Defined in src/CryptoEngine/CryptoEngine.ts:663

getAlgorithmParameters

getAlgorithmParameters(algorithmName: string, operation: CryptoEngineAlgorithmOperation): CryptoEngineAlgorithmParams
Get default algorithm parameters for each kind of operation
Parameters
- algorithmName: string
  
  Algorithm name to get common parameters for
- operation: CryptoEngineAlgorithmOperation
  
  Kind of operation: "sign", "encrypt", "generateKey", "importKey", "exportKey", "verify"
Returns CryptoEngineAlgorithmParams
Overrides AbstractCryptoEngine.getAlgorithmParameters
- Defined in src/CryptoEngine/CryptoEngine.ts:1076

getHashAlgorithm

getHashAlgorithm(signatureAlgorithm: AlgorithmIdentifier): string
Getting hash algorithm by signature algorithm
Parameters
- signatureAlgorithm: AlgorithmIdentifier
  
  Signature algorithm
Returns string
Overrides AbstractCryptoEngine.getHashAlgorithm
- Defined in src/CryptoEngine/CryptoEngine.ts:1500

getOIDByAlgorithm

getOIDByAlgorithm(algorithm: Algorithm, safety?: boolean, target?: string): string
Get OID for each specific algorithm

Throws
Throws Error exception if unknown WebCrypto algorithm
Parameters
- algorithm: Algorithm
  
  WebCrypto Algorithm
- safety: boolean = false
  
  If true throws exception on unknown algorithm. Default is false
- Optional target: string
  
  Name of the target
Returns string
Overrides AbstractCryptoEngine.getOIDByAlgorithm
- Defined in src/CryptoEngine/CryptoEngine.ts:891

getPublicKey

getPublicKey(publicKeyInfo: PublicKeyInfo, signatureAlgorithm: AlgorithmIdentifier, parameters?: CryptoEnginePublicKeyParams): Promise<CryptoKey>
Parameters
- publicKeyInfo: PublicKeyInfo
- signatureAlgorithm: AlgorithmIdentifier
- Optional parameters: CryptoEnginePublicKeyParams
Returns Promise<CryptoKey>
Overrides AbstractCryptoEngine.getPublicKey
- Defined in src/CryptoEngine/CryptoEngine.ts:1988

getRandomValues

getRandomValues<T>(array: T): T
Type Parameters
- T extends null | ArrayBufferView
Parameters
- array: T
Returns T
Inherited from AbstractCryptoEngine.getRandomValues
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:107

getSignatureParameters

getSignatureParameters(privateKey: CryptoKey, hashAlgorithm?: string): Promise<CryptoEngineSignatureParams>
Get signature parameters by analyzing private key algorithm
Parameters
- privateKey: CryptoKey
  
  The private key user would like to use
- hashAlgorithm: string = "SHA-1"
  
  Hash algorithm user would like to use. Default is SHA-1
Returns Promise<CryptoEngineSignatureParams>
Overrides AbstractCryptoEngine.getSignatureParameters
- Defined in src/CryptoEngine/CryptoEngine.ts:1848

importKey

importKey(format: KeyFormat, keyData: BufferSource | JsonWebKey, algorithm: AlgorithmIdentifier, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>
Parameters
- format: KeyFormat
- keyData: BufferSource | JsonWebKey
- algorithm: AlgorithmIdentifier
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
Overrides AbstractCryptoEngine.importKey
- Defined in src/CryptoEngine/CryptoEngine.ts:223

sign

sign(algorithm: EcdsaParams | AlgorithmIdentifier | RsaPssParams, key: CryptoKey, data: BufferSource): Promise<ArrayBuffer>
Parameters
- algorithm: EcdsaParams | AlgorithmIdentifier | RsaPssParams
- key: CryptoKey
- data: BufferSource
Returns Promise<ArrayBuffer>
Inherited from AbstractCryptoEngine.sign
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:50

signWithPrivateKey

signWithPrivateKey(data: BufferSource, privateKey: CryptoKey, parameters: CryptoEngineSignWithPrivateKeyParams): Promise<ArrayBuffer>
Sign data with pre-defined private key
Parameters
- data: BufferSource
  
  Data to be signed
- privateKey: CryptoKey
  
  Private key to use
- parameters: CryptoEngineSignWithPrivateKeyParams
  
  Parameters for used algorithm
Returns Promise<ArrayBuffer>
Overrides AbstractCryptoEngine.signWithPrivateKey
- Defined in src/CryptoEngine/CryptoEngine.ts:1927

stampDataWithPassword

stampDataWithPassword(parameters: CryptoEngineStampDataWithPasswordParams): Promise<ArrayBuffer>
Stamping (signing) data using algorithm similar to HMAC
Parameters
- parameters: CryptoEngineStampDataWithPasswordParams
Returns Promise<ArrayBuffer>
Overrides AbstractCryptoEngine.stampDataWithPassword
- Defined in src/CryptoEngine/CryptoEngine.ts:1736

unwrapKey

unwrapKey(format: KeyFormat, wrappedKey: BufferSource, unwrappingKey: CryptoKey, unwrapAlgorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams, unwrappedKeyAlgorithm: AesKeyAlgorithm | EcKeyImportParams | AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>
Parameters
- format: KeyFormat
- wrappedKey: BufferSource
- unwrappingKey: CryptoKey
- unwrapAlgorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams
- unwrappedKeyAlgorithm: AesKeyAlgorithm | EcKeyImportParams | AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams
- extractable: boolean
- keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
Inherited from AbstractCryptoEngine.unwrapKey
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:88
unwrapKey(format: KeyFormat, wrappedKey: BufferSource, unwrappingKey: CryptoKey, unwrapAlgorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams, unwrappedKeyAlgorithm: AesKeyAlgorithm | EcKeyImportParams | AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams, extractable: boolean, keyUsages: Iterable<KeyUsage>): Promise<CryptoKey>
Parameters
- format: KeyFormat
- wrappedKey: BufferSource
- unwrappingKey: CryptoKey
- unwrapAlgorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams
- unwrappedKeyAlgorithm: AesKeyAlgorithm | EcKeyImportParams | AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams
- extractable: boolean
- keyUsages: Iterable<KeyUsage>
Returns Promise<CryptoKey>
Inherited from AbstractCryptoEngine.unwrapKey
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:89

verify

verify(algorithm: EcdsaParams | AlgorithmIdentifier | RsaPssParams, key: CryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>
Parameters
- algorithm: EcdsaParams | AlgorithmIdentifier | RsaPssParams
- key: CryptoKey
- signature: BufferSource
- data: BufferSource
Returns Promise<boolean>
Inherited from AbstractCryptoEngine.verify
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:55

verifyDataStampedWithPassword

verifyDataStampedWithPassword(parameters: CryptoEngineVerifyDataStampedWithPasswordParams): Promise<boolean>
Parameters
- parameters: CryptoEngineVerifyDataStampedWithPasswordParams
Returns Promise<boolean>
Overrides AbstractCryptoEngine.verifyDataStampedWithPassword
- Defined in src/CryptoEngine/CryptoEngine.ts:1793

verifyWithPublicKey

verifyWithPublicKey(data: BufferSource, signature: OctetString | BitString, publicKeyInfo: PublicKeyInfo, signatureAlgorithm: AlgorithmIdentifier, shaAlgorithm?: string): Promise<boolean>
Verify data with the public key
Parameters
- data: BufferSource
  
  Data to be verified
- signature: OctetString | BitString
  
  Signature value
- publicKeyInfo: PublicKeyInfo
  
  Public key information
- signatureAlgorithm: AlgorithmIdentifier
  
  Signature algorithm
- Optional shaAlgorithm: string
  
  Hash algorithm
Returns Promise<boolean>
Overrides AbstractCryptoEngine.verifyWithPublicKey
- Defined in src/CryptoEngine/CryptoEngine.ts:2003

wrapKey

wrapKey(format: KeyFormat, key: CryptoKey, wrappingKey: CryptoKey, wrapAlgorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams): Promise<ArrayBuffer>
Parameters
- format: KeyFormat
- key: CryptoKey
- wrappingKey: CryptoKey
- wrapAlgorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams
Returns Promise<ArrayBuffer>
Inherited from AbstractCryptoEngine.wrapKey
- Defined in src/CryptoEngine/AbstractCryptoEngine.ts:83

Class CryptoEngine

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

parameters: CryptoEngineParameters

Returns CryptoEngine

Properties

crypto

name

subtle

Methods

convert

Parameters

inputFormat: KeyFormat

outputFormat: KeyFormat

keyData: ArrayBuffer | JsonWebKey

algorithm: Algorithm

extractable: boolean

keyUsages: KeyUsage[]

Returns Promise<ArrayBuffer | JsonWebKey>

decrypt

Parameters

algorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams

key: CryptoKey

data: BufferSource

Returns Promise<ArrayBuffer>

decryptEncryptedContentInfo

Parameters

parameters: CryptoEngineDecryptParams

Returns Promise<ArrayBuffer>

deriveBits

Parameters

algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params

baseKey: CryptoKey

length: number

Returns Promise<ArrayBuffer>

deriveKey

Parameters

algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params

baseKey: CryptoKey

derivedKeyType: AesDerivedKeyParams | AlgorithmIdentifier | HkdfParams | HmacImportParams | Pbkdf2Params

extractable: boolean

keyUsages: KeyUsage[]

Returns Promise<CryptoKey>

Parameters

algorithm: EcdhKeyDeriveParams | AlgorithmIdentifier | HkdfParams | Pbkdf2Params

baseKey: CryptoKey

derivedKeyType: AesDerivedKeyParams | AlgorithmIdentifier | HkdfParams | HmacImportParams | Pbkdf2Params

extractable: boolean

keyUsages: Iterable<KeyUsage>

Returns Promise<CryptoKey>

digest

Parameters

algorithm: AlgorithmIdentifier

data: BufferSource

Returns Promise<ArrayBuffer>

encrypt

Parameters

algorithm: AesCbcParams | AesCtrParams | AesGcmParams | AlgorithmIdentifier | RsaOaepParams

key: CryptoKey

data: BufferSource

Returns Promise<ArrayBuffer>

encryptEncryptedContentInfo

Parameters

parameters: CryptoEngineEncryptParams

Returns Promise<EncryptedContentInfo>

exportKey

Parameters

format: "jwk"

key: CryptoKey

Returns Promise<JsonWebKey>

Parameters

format: "raw" | "pkcs8" | "spki"

key: CryptoKey

Returns Promise<ArrayBuffer>

`Optional` safety: boolean

`Optional` target: string

`Optional` target: string

`Optional` target: string

`Optional` parameters: CryptoEnginePublicKeyParams