Skip to content

Latest commit

 

History

History
3228 lines (1867 loc) · 93.5 KB

modules.md

File metadata and controls

3228 lines (1867 loc) · 93.5 KB
Raw

@pashoo2/crypto-utilities / Exports

@pashoo2/crypto-utilities

Table of contents

Enumerations

Type aliases

Variables

Functions

Type aliases

TCryptoUtilDecryptDataTypes

Ƭ TCryptoUtilDecryptDataTypes: string | TTypedArrays

Defined in

encryption-utils/crypto-utils.types.ts:55

TCryptoUtilDecryptDataTypesNative

Ƭ TCryptoUtilDecryptDataTypesNative: TTypedArrays

Defined in

encryption-utils/crypto-utils.types.ts:53

TCryptoUtilDecryptKeyTypes

Ƭ TCryptoUtilDecryptKeyTypes: CryptoKey | CryptoKeyPair | string | TCryptoUtilKeypairExportFormatType | TCryptoUtilKeypairImportFormatType

Defined in

encryption-utils/crypto-utils.types.ts:46

TCryptoUtilEncryptDataTypes

Ƭ TCryptoUtilEncryptDataTypes: object | string | number | TCryptoUtilEncryptDataTypesNative

Defined in

encryption-utils/crypto-utils.types.ts:33

TCryptoUtilEncryptDataTypesNative

Ƭ TCryptoUtilEncryptDataTypesNative: TTypedArrays

Defined in

encryption-utils/crypto-utils.types.ts:31

TCryptoUtilEncryptKeyTypes

Ƭ TCryptoUtilEncryptKeyTypes: CryptoKey | CryptoKeyPair | string | TCryptoUtilKeypairExportFormatType | TCryptoUtilKeypairImportFormatType

Defined in

encryption-utils/crypto-utils.types.ts:39

TCryptoUtilImportKeyTypes

Ƭ TCryptoUtilImportKeyTypes: TTypedArrays | ArrayBuffer

Defined in

encryption-utils/crypto-utils.types.ts:9

TCryptoUtilKeyExportFormatType

Ƭ TCryptoUtilKeyExportFormatType: Object

Defined in

encryption-utils/crypto-utils.types.ts:11

TCryptoUtilKeypairExportFormatType

Ƭ TCryptoUtilKeypairExportFormatType: Object

Type declaration

Name Type
privateKey string | TCryptoUtilImportKeyTypes
publicKey TCryptoUtilImportKeyTypes
salt? string | TCryptoUtilImportKeyTypes

Defined in

encryption-utils/crypto-utils.types.ts:13

TCryptoUtilKeypairImportFormatType

Ƭ TCryptoUtilKeypairImportFormatType: Object

Type declaration

Name Type
privateKey? CryptoKey
publicKey CryptoKey
salt? string

Defined in

encryption-utils/crypto-utils.types.ts:25

TCryptoUtilKeypairPreImportFormatType

Ƭ TCryptoUtilKeypairPreImportFormatType: Object

Type declaration

Name Type
privateKey TCryptoUtilImportKeyTypes
publicKey TCryptoUtilImportKeyTypes
salt? TCryptoUtilImportKeyTypes

Defined in

encryption-utils/crypto-utils.types.ts:19

TCryptoUtilsDataWithInitializationVector

Ƭ TCryptoUtilsDataWithInitializationVector: Object

Type declaration

Name Type
data ArrayBuffer
iv ArrayBuffer

Defined in

encryption-utils/crypto-utils.types.ts:66

TCryptoUtilsDecryptDataKeyConfig

Ƭ TCryptoUtilsDecryptDataKeyConfig: string | RsaOaepParams | AesCtrParams | AesCbcParams | AesCmacParams | AesGcmParams | AesCfbParams

Defined in

encryption-utils/crypto-utils.types.ts:71

TCryptoUtilsEncryptDataKeyConfig

Ƭ TCryptoUtilsEncryptDataKeyConfig: string | RsaOaepParams | AesCtrParams | AesCbcParams | AesCmacParams | AesGcmParams | AesCfbParams

Defined in

encryption-utils/crypto-utils.types.ts:57

TDataSignUtilImportKeyTypes

Ƭ TDataSignUtilImportKeyTypes: JsonWebKey | Int8Array | Int16Array | Int32Array | Uint8Array | Uint16Array | Uint32Array | Uint8ClampedArray | Float32Array | Float64Array | DataView | ArrayBuffer

Defined in

data-sign-utils/data-sign-utils.types.ts:37

TDataSignUtilKeyExportFormatType

Ƭ TDataSignUtilKeyExportFormatType: JsonWebKey

Defined in

data-sign-utils/data-sign-utils.types.ts:8

TDataSignUtilKeypairExportFormatType

Ƭ TDataSignUtilKeypairExportFormatType: Object

Type declaration

Name Type
privateKey? string | TDataSignUtilImportKeyTypes
publicKey TDataSignUtilImportKeyTypes
salt? string | TDataSignUtilImportKeyTypes

Defined in

data-sign-utils/data-sign-utils.types.ts:59

TDataSignUtilKeypairImportFormatType

Ƭ TDataSignUtilKeypairImportFormatType: Object

Type declaration

Name Type
privateKey? CryptoKey
publicKey CryptoKey

Defined in

data-sign-utils/data-sign-utils.types.ts:10

TDataSignUtilKeypairImportType

Ƭ TDataSignUtilKeypairImportType: Object

Type declaration

Name Type
privateKey? TDataSignUtilImportKeyTypes
publicKey TDataSignUtilImportKeyTypes
salt? TDataSignUtilImportKeyTypes

Defined in

data-sign-utils/data-sign-utils.types.ts:69

TDataSignUtilSignDataTypes

Ƭ TDataSignUtilSignDataTypes: object | string | number | TDataSignUtilSignDataTypesNative

Defined in

data-sign-utils/data-sign-utils.types.ts:17

TDataSignUtilSignDataTypesNative

Ƭ TDataSignUtilSignDataTypesNative: TTypedArrays

Defined in

data-sign-utils/data-sign-utils.types.ts:15

TDataSignUtilSignKeyTypes

Ƭ TDataSignUtilSignKeyTypes: CryptoKey | CryptoKeyPair | string | TDataSignUtilKeypairExportFormatType | TDataSignUtilKeypairImportFormatType

Defined in

data-sign-utils/data-sign-utils.types.ts:23

TDataSignUtilVerifyDataTypes

Ƭ TDataSignUtilVerifyDataTypes: string | TTypedArrays

Defined in

data-sign-utils/data-sign-utils.types.ts:53

TDataSignUtilVerifyDataTypesExtended

Ƭ TDataSignUtilVerifyDataTypesExtended: TDataSignUtilVerifyDataTypes | {}

Defined in

data-sign-utils/data-sign-utils.types.ts:55

TDataSignUtilVerifyDataTypesNative

Ƭ TDataSignUtilVerifyDataTypesNative: TTypedArrays

Defined in

data-sign-utils/data-sign-utils.types.ts:51

TDataSignUtilVerifyKeyTypes

Ƭ TDataSignUtilVerifyKeyTypes: CryptoKey | CryptoKeyPair | string | TDataSignUtilKeypairExportFormatType | TDataSignUtilKeypairImportFormatType

Defined in

data-sign-utils/data-sign-utils.types.ts:30

TEncryptionKeyStoreFormatType

Ƭ TEncryptionKeyStoreFormatType: string | ArrayBuffer | JsonWebKey | TTypedArrays

Defined in

types.ts:3

TPasswordEncryptionKeyImportNativeSupportedTypes

Ƭ TPasswordEncryptionKeyImportNativeSupportedTypes: TPasswordEnryptionUtilsKeyDerivedTargetKeyExportFormat

Defined in

password-utils/password-utils.types.ts:13

TPasswordEncryptionSupportedPasswordNativeTypes

Ƭ TPasswordEncryptionSupportedPasswordNativeTypes: TTypedArrays | ArrayBuffer

Defined in

password-utils/password-utils.types.ts:3

TPasswordEncryptionSupportesSaltNativeTypes

Ƭ TPasswordEncryptionSupportesSaltNativeTypes: TTypedArrays | ArrayBuffer

Defined in

password-utils/password-utils.types.ts:7

TPasswordEnryptionUtilsKeyDerivedTargetKeyExportFormat

Ƭ TPasswordEnryptionUtilsKeyDerivedTargetKeyExportFormat: JsonWebKey

Defined in

password-utils/password-utils.types.ts:11

TSaltUtilsSaltType

Ƭ TSaltUtilsSaltType: string | TTypedArraysNative | ArrayBuffer

Defined in

encryption-utils/salt-utils.types.ts:3

Variables

CRYPTO_UTIL_DATA_SIGN_PRIVATE_KEY_USAGE

• Const CRYPTO_UTIL_DATA_SIGN_PRIVATE_KEY_USAGE: sign

Defined in

encryption-utils/crypto-utils.const.ts:37

CRYPTO_UTIL_DATA_SIGN_PUBLIC_KEY_USAGE

• Const CRYPTO_UTIL_DATA_SIGN_PUBLIC_KEY_USAGE: verify

Defined in

encryption-utils/crypto-utils.const.ts:34

CRYPTO_UTIL_DESCRIPTION_KEY_TYPE

• Const CRYPTO_UTIL_DESCRIPTION_KEY_TYPE: private

Defined in

encryption-utils/crypto-utils.const.ts:42

CRYPTO_UTIL_ENCRYPTION_KEY_TYPE

• Const CRYPTO_UTIL_ENCRYPTION_KEY_TYPE: public

Defined in

encryption-utils/crypto-utils.const.ts:40

CRYPTO_UTIL_GENERATE_KEYPAIR_OPTIONS

• Const CRYPTO_UTIL_GENERATE_KEYPAIR_OPTIONS: Object

Type declaration

Name Type
hash Object
hash.name HASH_CALCULATION_UTILS_HASH_ALGORITHM
modulusLength number
name string
publicExponent Uint8Array

Defined in

encryption-utils/crypto-utils.const.ts:50

CRYPTO_UTIL_KEYPAIR_EXPORT_FORMAT

• Const CRYPTO_UTIL_KEYPAIR_EXPORT_FORMAT: "jwk"

Defined in

encryption-utils/crypto-utils.const.ts:56

CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME

• Const CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME: "privateKey"

Defined in

encryption-utils/crypto-utils.const.ts:60

CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME

• Const CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME: "publicKey"

Defined in

encryption-utils/crypto-utils.const.ts:58

CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME

• Const CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME: "salt"

Defined in

encryption-utils/crypto-utils.const.ts:62

CRYPTO_UTIL_KEYPAIR_USAGES

• Const CRYPTO_UTIL_KEYPAIR_USAGES: eCRYPTO_UTILS_KEYS_USAGES[]

Defined in

encryption-utils/crypto-utils.const.ts:45

CRYPTO_UTIL_KEYS_EXTRACTABLE

• Const CRYPTO_UTIL_KEYS_EXTRACTABLE: true

Defined in

encryption-utils/crypto-utils.const.ts:3

CRYPTO_UTIL_KEY_ALGORITHM

• Const CRYPTO_UTIL_KEY_ALGORITHM: "RSA-OAEP"

Defined in

encryption-utils/crypto-utils.const.ts:5

CRYPTO_UTIL_KEY_DESC

• Const CRYPTO_UTIL_KEY_DESC: Object

Type declaration

Name Type
hash Object
hash.name HASH_CALCULATION_UTILS_HASH_ALGORITHM
name string

Defined in

encryption-utils/crypto-utils.const.ts:7

CRYPTO_UTIL_PRIVATE_KEY_USAGE

• Const CRYPTO_UTIL_PRIVATE_KEY_USAGE: decrypt

Defined in

encryption-utils/crypto-utils.const.ts:32

CRYPTO_UTIL_PUBLIC_KEY_USAGE

• Const CRYPTO_UTIL_PUBLIC_KEY_USAGE: encrypt

Defined in

encryption-utils/crypto-utils.const.ts:30

DATA_SIGN_CRYPTO_UTIL_DATA_SIGN_AND_VERIFY_PARAMS

• Const DATA_SIGN_CRYPTO_UTIL_DATA_SIGN_AND_VERIFY_PARAMS: Object

Type declaration

Name Type
hash Object
hash.name HASH_CALCULATION_UTILS_HASH_ALGORITHM
name string

Defined in

data-sign-utils/data-sign-utils.const.ts:42

DATA_SIGN_CRYPTO_UTIL_GENERATE_KEYPAIR_OPTIONS

• Const DATA_SIGN_CRYPTO_UTIL_GENERATE_KEYPAIR_OPTIONS: Object

Type declaration

Name Type
name string
namedCurve string

Defined in

data-sign-utils/data-sign-utils.const.ts:30

DATA_SIGN_CRYPTO_UTIL_HASH_ALGORITHM

• Const DATA_SIGN_CRYPTO_UTIL_HASH_ALGORITHM: SHA256

Defined in

data-sign-utils/data-sign-utils.const.ts:7

DATA_SIGN_CRYPTO_UTIL_KEYPAIR_EXPORT_FORMAT

• Const DATA_SIGN_CRYPTO_UTIL_KEYPAIR_EXPORT_FORMAT: "jwk"

Defined in

data-sign-utils/data-sign-utils.const.ts:34

DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME

• Const DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PRIVATE_KEY_NAME: "privateKey"

Defined in

data-sign-utils/data-sign-utils.const.ts:38

DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME

• Const DATA_SIGN_CRYPTO_UTIL_KEYPAIR_PUBLIC_KEY_NAME: "publicKey"

Defined in

data-sign-utils/data-sign-utils.const.ts:36

DATA_SIGN_CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME

• Const DATA_SIGN_CRYPTO_UTIL_KEYPAIR_SALT_KEY_NAME: "salt"

Defined in

data-sign-utils/data-sign-utils.const.ts:40

DATA_SIGN_CRYPTO_UTIL_KEYPAIR_USAGES

• Const DATA_SIGN_CRYPTO_UTIL_KEYPAIR_USAGES: eCRYPTO_UTILS_KEYS_USAGES[]

Defined in

data-sign-utils/data-sign-utils.const.ts:25

DATA_SIGN_CRYPTO_UTIL_KEYS_EXTRACTABLE

• Const DATA_SIGN_CRYPTO_UTIL_KEYS_EXTRACTABLE: true

Defined in

data-sign-utils/data-sign-utils.const.ts:3

DATA_SIGN_CRYPTO_UTIL_KEY_ALGORITHM

• Const DATA_SIGN_CRYPTO_UTIL_KEY_ALGORITHM: "ECDSA"

Defined in

data-sign-utils/data-sign-utils.const.ts:5

DATA_SIGN_CRYPTO_UTIL_KEY_DESC

• Const DATA_SIGN_CRYPTO_UTIL_KEY_DESC: Object

Type declaration

Name Type
name string
namedCurve string

Defined in

data-sign-utils/data-sign-utils.const.ts:10

DATA_SIGN_CRYPTO_UTIL_PRIVATE_KEY_USAGE

• Const DATA_SIGN_CRYPTO_UTIL_PRIVATE_KEY_USAGE: sign

Defined in

data-sign-utils/data-sign-utils.const.ts:18

DATA_SIGN_CRYPTO_UTIL_PUBLIC_KEY_USAGE

• Const DATA_SIGN_CRYPTO_UTIL_PUBLIC_KEY_USAGE: verify

Defined in

data-sign-utils/data-sign-utils.const.ts:15

DATA_SIGN_CRYPTO_UTIL_SIGN_KEY_TYPE

• Const DATA_SIGN_CRYPTO_UTIL_SIGN_KEY_TYPE: "private"

Defined in

data-sign-utils/data-sign-utils.const.ts:23

DATA_SIGN_CRYPTO_UTIL_VERIFY_KEY_TYPE

• Const DATA_SIGN_CRYPTO_UTIL_VERIFY_KEY_TYPE: "public"

Defined in

data-sign-utils/data-sign-utils.const.ts:21

ENCRYPTIONS_KEYS_UTILS_JWK_FORMAT_OBJECT_KEYS

• Const ENCRYPTIONS_KEYS_UTILS_JWK_FORMAT_OBJECT_KEYS: string[]

Defined in

encryption-keys-utils/encryption-keys-utils.const.ts:1

HASH_CALCULATION_UTILS_DEFAULT_HASH_ALGORITHM

• Const HASH_CALCULATION_UTILS_DEFAULT_HASH_ALGORITHM: SHA256

Defined in

const.ts:15

HASH_CALCULATION_UTILS_HASH_ALGORITHM_OUTPUT_STRING_LENGTH

• Const HASH_CALCULATION_UTILS_HASH_ALGORITHM_OUTPUT_STRING_LENGTH: { [key in HASH_CALCULATION_UTILS_HASH_ALGORITHM]: number}

Defined in

const.ts:7

INITIALIZATION_VECTOR_DEFAULT_LENGTH

• Const INITIALIZATION_VECTOR_DEFAULT_LENGTH: 12

Defined in

encryption-utils/crypto-utils.const.ts:64

KEY_NOT_FOUND_ERROR_MESSAGE

• Const KEY_NOT_FOUND_ERROR_MESSAGE: "A key of the required type was not found"

Defined in

data-sign-utils/data-sign-utils.const.ts:47

MIN_JWK_PROPS_COUNT

• Const MIN_JWK_PROPS_COUNT: 3

Defined in

encryption-keys-utils/encryption-keys-utils.const.ts:23

MIN_JWK_STRING_LENGTH

• Const MIN_JWK_STRING_LENGTH: 40

Defined in

encryption-keys-utils/encryption-keys-utils.const.ts:21

PASSWORD_ENCRYPTION_UTILS_DECRYPTION_PARAMS

• Const PASSWORD_ENCRYPTION_UTILS_DECRYPTION_PARAMS: Object

Type declaration

Name Type
iv null
name string

Defined in

password-utils/password-utils.const.ts:60

PASSWORD_ENCRYPTION_UTILS_ENCRYPTION_INITIALIZATION_VECTOR_LENGTH

• Const PASSWORD_ENCRYPTION_UTILS_ENCRYPTION_INITIALIZATION_VECTOR_LENGTH: 15

Defined in

password-utils/password-utils.const.ts:53

PASSWORD_ENCRYPTION_UTILS_ENCRYPTION_PARAMS

• Const PASSWORD_ENCRYPTION_UTILS_ENCRYPTION_PARAMS: Object

Type declaration

Name Type
iv null
name string

Defined in

password-utils/password-utils.const.ts:55

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_BASE_KEY_CONFIG

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_BASE_KEY_CONFIG: Object

Type declaration

Name Type
hash HASH_CALCULATION_UTILS_HASH_ALGORITHM
iterations number
name string
salt null

Defined in

password-utils/password-utils.const.ts:22

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_BITS_ITERATIONS

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_BITS_ITERATIONS: 100000

Defined in

password-utils/password-utils.const.ts:18

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_BITS_KEY_LENGTH_BYTES

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_BITS_KEY_LENGTH_BYTES: 16

Defined in

password-utils/password-utils.const.ts:20

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_ALGORITHM

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_ALGORITHM: "AES-GCM"

Defined in

password-utils/password-utils.const.ts:29

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_CONFIG

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_CONFIG: Object

Type declaration

Name Type
length number
name string

Defined in

password-utils/password-utils.const.ts:34

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_EXPORT_FORMAT

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_EXPORT_FORMAT: "jwk"

Defined in

password-utils/password-utils.const.ts:47

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_IMPORT_FORMAT

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_IMPORT_FORMAT: "jwk"

Defined in

password-utils/password-utils.const.ts:50

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_IS_EXPORTED

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_IS_EXPORTED: true

Defined in

password-utils/password-utils.const.ts:39

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_LENGTH

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_LENGTH: 128

Defined in

password-utils/password-utils.const.ts:32

PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_USAGES

• Const PASSWORD_ENCRYPTION_UTILS_KEY_DERIVED_TARGET_KEY_USAGES: string[]

Defined in

password-utils/password-utils.const.ts:42

PASSWORD_ENCRYPTION_UTILS_KEY_GENERATION_ALGORITHM

• Const PASSWORD_ENCRYPTION_UTILS_KEY_GENERATION_ALGORITHM: "PBKDF2"

Defined in

password-utils/password-utils.const.ts:8

PASSWORD_ENCRYPTION_UTILS_KEY_GENERATION_IS_KEY_EXTRACTABLE

• Const PASSWORD_ENCRYPTION_UTILS_KEY_GENERATION_IS_KEY_EXTRACTABLE: false

Defined in

password-utils/password-utils.const.ts:10

PASSWORD_ENCRYPTION_UTILS_KEY_GENERATION_KEY_IMPORTED_FORMAT

• Const PASSWORD_ENCRYPTION_UTILS_KEY_GENERATION_KEY_IMPORTED_FORMAT: "raw"

Defined in

password-utils/password-utils.const.ts:3

PASSWORD_ENCRYPTION_UTILS_KEY_GENERATION_KEY_SALT_GENERATED_LENGTH

• Const PASSWORD_ENCRYPTION_UTILS_KEY_GENERATION_KEY_SALT_GENERATED_LENGTH: 12

Defined in

password-utils/password-utils.const.ts:6

PASSWORD_ENCRYPTION_UTILS_KEY_HASH_ALGORITHM

• Const PASSWORD_ENCRYPTION_UTILS_KEY_HASH_ALGORITHM: SHA256

Defined in

password-utils/password-utils.const.ts:15

PASSWORD_ENCRYPTION_UTILS_KEY_USAGES

• Const PASSWORD_ENCRYPTION_UTILS_KEY_USAGES: string[]

Defined in

password-utils/password-utils.const.ts:13

SALT_GENERATION_UTILS_SALT_LENGTH_BYTES

• Const SALT_GENERATION_UTILS_SALT_LENGTH_BYTES: 32

Defined in

encryption-utils/salt-utils.const.ts:1

SALT_GENERATION_UTILS_SALT_MAX_LENGTH_BYTES

• Const SALT_GENERATION_UTILS_SALT_MAX_LENGTH_BYTES: 64

Defined in

encryption-utils/salt-utils.const.ts:5

SALT_GENERATION_UTILS_SALT_MIN_LENGTH_BYTES

• Const SALT_GENERATION_UTILS_SALT_MIN_LENGTH_BYTES: 4

Defined in

encryption-utils/salt-utils.const.ts:3

Functions

calcCryptoKeyHash

▸ Const calcCryptoKeyHash(key, alg?): Promise<string | Error>

calculates hash string of the crypto key

Parameters

Name Type
key CryptoKey
alg HASH_CALCULATION_UTILS_HASH_ALGORITHM

Returns

Promise<string | Error>

Defined in

encryption-keys-utils/encryption-keys-utils.ts:158

calcCryptoKeyPairHash

▸ Const calcCryptoKeyPairHash(cryptoPair): Promise<string | Error>

Parameters

Name Type
cryptoPair CryptoKeyPair

Returns

Promise<string | Error>

Defined in

encryption-keys-utils/encryption-keys-utils.ts:201

calculateHash

▸ Const calculateHash(data, alg?): Promise<string | Error>

Parameters

Name Type
data TSerializableDataTypes
alg HASH_CALCULATION_UTILS_HASH_ALGORITHM

Returns

Promise<string | Error>

Defined in

hash-calculation-utils/hash-calculation-utils.ts:29

calculateHashNative

▸ Const calculateHashNative(data, alg): Promise<ArrayBuffer | Error>

Parameters

Name Type
data TTypedArrays
alg HASH_CALCULATION_UTILS_HASH_ALGORITHM

Returns

Promise<ArrayBuffer | Error>

Defined in

hash-calculation-utils/hash-calculation-utils.ts:16

checkIfStringIsKeyPair

▸ Const checkIfStringIsKeyPair(keyString): boolean

Parameters

Name Type
keyString string

Returns

boolean

Defined in

encryption-utils/keys.encryption-utils.ts:305

concatDataWithInitializationVector

▸ Const concatDataWithInitializationVector(options): ArrayBuffer | Error

Parameters

Name Type
options TCryptoUtilsDataWithInitializationVector

Returns

ArrayBuffer | Error

Defined in

encryption-utils/encrypt-data.encryption-utils.ts:53

dataSignCheckIfStringIsKeyPair

▸ Const dataSignCheckIfStringIsKeyPair(keyString): boolean

Parameters

Name Type
keyString string

Returns

boolean

Defined in

data-sign-utils/keys.data-sign-utils.ts:358

dataSignConvertAndExportKeyAsString

▸ Const dataSignConvertAndExportKeyAsString(key): Promise<string | Error>

import an encryption key from a supported format of an exported key and returns a crypto key as a string

Parameters

Name Type
key TEncryptionKeyStoreFormatType

Returns

Promise<string | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:433

dataSignExportKey

▸ Const dataSignExportKey(key): Promise<JsonWebKey | Error>

Parameters

Name Type
key CryptoKey

Returns

Promise<JsonWebKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:54

dataSignExportKeyAsString

▸ Const dataSignExportKeyAsString(key): Promise<string | Error>

Parameters

Name Type
key CryptoKey

Returns

Promise<string | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:67

dataSignExportKeyPair

▸ Const dataSignExportKeyPair(keyPair, password?): Promise<TDataSignUtilKeypairExportFormatType | Error>

Parameters

Name Type
keyPair CryptoKeyPair
password? string

Returns

Promise<TDataSignUtilKeypairExportFormatType | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:106

dataSignExportKeyPairAsString

▸ Const dataSignExportKeyPairAsString(keyPair, password?): Promise<string | Error>

Parameters

Name Type
keyPair CryptoKeyPair
password? string

Returns

Promise<string | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:180

dataSignExportPublicKey

▸ Const dataSignExportPublicKey(keyPair): Promise<JsonWebKey | Error>

Parameters

Name Type
keyPair CryptoKeyPair

Returns

Promise<JsonWebKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:82

dataSignExportPublicKeyAsString

▸ Const dataSignExportPublicKeyAsString(keyPair): Promise<string | Error>

Parameters

Name Type
keyPair CryptoKeyPair

Returns

Promise<string | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:91

dataSignGenerateKeyPair

▸ Const dataSignGenerateKeyPair(): PromiseLike<CryptoKeyPair>

Returns

PromiseLike<CryptoKeyPair>

Defined in

data-sign-utils/keys.data-sign-utils.ts:47

dataSignGetKeyOfType

▸ Const dataSignGetKeyOfType(key, type): Promise<CryptoKey | Error>

Parameters

Name Type
key TDataSignUtilSignKeyTypes
type KeyType

Returns

Promise<CryptoKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:365

dataSignImportEncryptionKey

▸ Const dataSignImportEncryptionKey(key): Promise<CryptoKey | Error>

import an encryption key from a supported format of an exported key and returns a crypto key in native format

Parameters

Name Type
key TEncryptionKeyStoreFormatType

Returns

Promise<CryptoKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:410

dataSignImportKey

▸ Const dataSignImportKey(key, isPublic?): Promise<CryptoKey | Error>

Parameters

Name Type Default value
key TDataSignUtilImportKeyTypes undefined
isPublic boolean true

Returns

Promise<CryptoKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:199

dataSignImportKeyFromString

▸ Const dataSignImportKeyFromString(keyString, isPublic?): Error | PromiseLike<CryptoKey | Error>

Parameters

Name Type Default value
keyString string undefined
isPublic boolean true

Returns

Error | PromiseLike<CryptoKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:331

dataSignImportKeyPair

▸ Const dataSignImportKeyPair(keyPair, checkPrivateKey?): Promise<TDataSignUtilKeypairImportFormatType | Error>

Parameters

Name Type Default value
keyPair TDataSignUtilKeypairImportType undefined
checkPrivateKey boolean true

Returns

Promise<TDataSignUtilKeypairImportFormatType | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:236

dataSignImportKeyPairFromString

▸ Const dataSignImportKeyPairFromString(keyPairString, password?): Promise<TDataSignUtilKeypairImportFormatType | Error>

Parameters

Name Type
keyPairString string
password? string

Returns

Promise<TDataSignUtilKeypairImportFormatType | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:278

dataSignImportPrivateKey

▸ Const dataSignImportPrivateKey(key): PromiseLike<CryptoKey | Error>

Parameters

Name Type
key TDataSignUtilImportKeyTypes

Returns

PromiseLike<CryptoKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:232

dataSignImportPrivateKeyFromString

▸ Const dataSignImportPrivateKeyFromString(key): Error | PromiseLike<CryptoKey | Error>

Parameters

Name Type
key string

Returns

Error | PromiseLike<CryptoKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:353

dataSignImportPublicKey

▸ Const dataSignImportPublicKey(key): PromiseLike<CryptoKey | Error>

Parameters

Name Type
key TDataSignUtilImportKeyTypes

Returns

PromiseLike<CryptoKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:228

dataSignImportPublicKeyFromString

▸ Const dataSignImportPublicKeyFromString(key): Error | PromiseLike<CryptoKey | Error>

Parameters

Name Type
key string

Returns

Error | PromiseLike<CryptoKey | Error>

Defined in

data-sign-utils/keys.data-sign-utils.ts:348

dataSignIsCryptoKeyPairImported

▸ Const dataSignIsCryptoKeyPairImported(key, checkPrivateKey?): key is TDataSignUtilKeypairExportFormatType

Parameters

Name Type Default value
key any undefined
checkPrivateKey boolean true

Returns

key is TDataSignUtilKeypairExportFormatType

Defined in

data-sign-utils/keys.data-sign-utils.ts:36

decryptData

▸ Const decryptData(key, data, decryptKeyParams?): Promise<string | Error>

Parameters

Name Type
key TCryptoUtilDecryptKeyTypes
data TCryptoUtilDecryptDataTypes
decryptKeyParams? TCryptoUtilsDecryptDataKeyConfig

Returns

Promise<string | Error>

Defined in

encryption-utils/decrypt-data.encryption-utils.ts:77

decryptDataArrayOrStringWithKeyToUInt8Array

▸ Const decryptDataArrayOrStringWithKeyToUInt8Array(key, dataWithIv): Promise<Uint8Array | Error>

Parameters

Name Type
key string | CryptoKey
dataWithIv string | Uint8Array

Returns

Promise<Uint8Array | Error>

Defined in

password-utils/decrypt.password-utils.ts:80

decryptDataByPassword

▸ Const decryptDataByPassword(password, salt, dataWithIv): Promise<string | Error>

Parameters

Name Type
password string
salt TSaltUtilsSaltType
dataWithIv string

Returns

Promise<string | Error>

Defined in

password-utils/decrypt.password-utils.ts:105

decryptDataFromString

▸ Const decryptDataFromString(key, data, decryptKeyParams?): Promise<ArrayBuffer | Error>

Parameters

Name Type
key TCryptoUtilDecryptKeyTypes
data object | TCryptoUtilDecryptDataTypes
decryptKeyParams? TCryptoUtilsDecryptDataKeyConfig

Returns

Promise<ArrayBuffer | Error>

Defined in

encryption-utils/decrypt-data.encryption-utils.ts:39

decryptDataWithKey

▸ Const decryptDataWithKey(key, dataWithIv): Promise<string | Error>

Parameters

Name Type
key string | CryptoKey
dataWithIv string

Returns

Promise<string | Error>

Defined in

password-utils/decrypt.password-utils.ts:45

decryptDataWithKeyFromUint8Array

▸ Const decryptDataWithKeyFromUint8Array(key, dataWithIv): Promise<string | Error>

Parameters

Name Type
key string | CryptoKey
dataWithIv Uint8Array

Returns

Promise<string | Error>

Defined in

password-utils/decrypt.password-utils.ts:67

decryptDataWithKeyNative

▸ Const decryptDataWithKeyNative(key, dataWithIv): Promise<ArrayBuffer | Error>

Parameters

Name Type
key string | CryptoKey
dataWithIv ArrayBuffer

Returns

Promise<ArrayBuffer | Error>

Defined in

password-utils/decrypt.password-utils.ts:16

decryptNative

▸ Const decryptNative(key, data, decryptKeyParams?): Promise<ArrayBuffer | Error>

Parameters

Name Type
key CryptoKey
data TTypedArrays
decryptKeyParams TCryptoUtilsDecryptDataKeyConfig

Returns

Promise<ArrayBuffer | Error>

Defined in

encryption-utils/decrypt-data.encryption-utils.ts:22

encryptDataToArrayBuffer

▸ Const encryptDataToArrayBuffer(key, data): Promise<ArrayBuffer | Error>

Parameters

Name Type
key string | CryptoKey
data TCryptoUtilEncryptDataTypes

Returns

Promise<ArrayBuffer | Error>

Defined in

password-utils/encrypt.password-utils.ts:17

encryptDataToString

▸ Const encryptDataToString(key, data): Promise<string | Error>

Parameters

Name Type
key string | CryptoKey
data TCryptoUtilEncryptDataTypes

Returns

Promise<string | Error>

Defined in

password-utils/encrypt.password-utils.ts:53

encryptDataToUInt8Array

▸ Const encryptDataToUInt8Array(key, data): Promise<Uint8Array | Error>

Parameters

Name Type
key string | CryptoKey
data TCryptoUtilEncryptDataTypes

Returns

Promise<Uint8Array | Error>

Defined in

password-utils/encrypt.password-utils.ts:65

encryptDataWithPassword

▸ Const encryptDataWithPassword(password, salt, data): Promise<string | Error>

Parameters

Name Type
password string
salt TSaltUtilsSaltType
data TCryptoUtilEncryptDataTypes

Returns

Promise<string | Error>

Defined in

password-utils/encrypt.password-utils.ts:77

encryptDataWithPasswordToArrayBuffer

▸ Const encryptDataWithPasswordToArrayBuffer(password, salt, data): Promise<ArrayBuffer | Error>

Parameters

Name Type
password string
salt TSaltUtilsSaltType
data TCryptoUtilEncryptDataTypes

Returns

Promise<ArrayBuffer | Error>

Defined in

password-utils/encrypt.password-utils.ts:92

encryptNative

▸ Const encryptNative(key, data, cryptoKeyConfig?): Promise<ArrayBuffer | Error>

Parameters

Name Type
key CryptoKey
data TTypedArrays
cryptoKeyConfig TCryptoUtilsEncryptDataKeyConfig

Returns

Promise<ArrayBuffer | Error>

Defined in

encryption-utils/encrypt-data.encryption-utils.ts:100

encryptToString

▸ Const encryptToString(key, data, cryptoKeyConfig?): Promise<string | Error>

Parameters

Name Type
key TCryptoUtilEncryptKeyTypes
data TCryptoUtilEncryptDataTypes
cryptoKeyConfig? TCryptoUtilsEncryptDataKeyConfig

Returns

Promise<string | Error>

Defined in

encryption-utils/encrypt-data.encryption-utils.ts:145

encryptToTypedArray

▸ Const encryptToTypedArray(key, data, cryptoKeyConfig?): Promise<ArrayBuffer | Error>

Parameters

Name Type
key TCryptoUtilEncryptKeyTypes
data TCryptoUtilEncryptDataTypes
cryptoKeyConfig? TCryptoUtilsEncryptDataKeyConfig

Returns

Promise<ArrayBuffer | Error>

Defined in

encryption-utils/encrypt-data.encryption-utils.ts:117

exportCryptoKeyInFormat

▸ Const exportCryptoKeyInFormat(key, format): Promise<ArrayBuffer | JsonWebKey | Error>

Parameters

Name Type
key CryptoKey
format CONST_CRYPTO_KEYS_TYPES_EXPORT_FORMATS

Returns

Promise<ArrayBuffer | JsonWebKey | Error>

Defined in

encryption-keys-utils/encryption-keys-utils.ts:132

exportKey

▸ Const exportKey(key): PromiseLike<Object | Error>

Parameters

Name Type
key CryptoKey

Returns

PromiseLike<Object | Error>

Defined in

encryption-utils/keys.encryption-utils.ts:51

exportKeyAsString

▸ Const exportKeyAsString(key): Promise<string | Error>

Parameters

Name Type
key CryptoKey

Returns

Promise<string | Error>

Defined in

encryption-utils/keys.encryption-utils.ts:65

exportKeyPair

▸ Const exportKeyPair(keyPair, password?): Promise<Error | TCryptoUtilKeypairExportFormatType>

Parameters

Name Type
keyPair CryptoKeyPair
password? string

Returns

Promise<Error | TCryptoUtilKeypairExportFormatType>

Defined in

encryption-utils/keys.encryption-utils.ts:84

exportKeyPairAsString

▸ Const exportKeyPairAsString(keyPair, password?): Promise<string | Error>

Parameters

Name Type
keyPair CryptoKeyPair
password? string

Returns

Promise<string | Error>

Defined in

encryption-utils/keys.encryption-utils.ts:151

exportPasswordKey

▸ Const exportPasswordKey(passwordKey): Error | PromiseLike<JsonWebKey>

Parameters

Name Type
passwordKey CryptoKey

Returns

Error | PromiseLike<JsonWebKey>

Defined in

password-utils/derive-key.password-utils.ts:103

exportPasswordKeyAsString

▸ Const exportPasswordKeyAsString(passwordKey): Promise<string | Error>

Parameters

Name Type
passwordKey CryptoKey

Returns

Promise<string | Error>

Defined in

password-utils/derive-key.password-utils.ts:119

exportPublicKey

▸ Const exportPublicKey(keyPair): Promise<Object | Error>

Parameters

Name Type
keyPair CryptoKeyPair

Returns

Promise<Object | Error>

Defined in

encryption-utils/keys.encryption-utils.ts:71

exportPublicKeyAsString

▸ Const exportPublicKeyAsString(keyPair): Promise<string | Error>

Parameters

Name Type
keyPair CryptoKeyPair

Returns

Promise<string | Error>

Defined in

encryption-utils/keys.encryption-utils.ts:75

generateInitializationVectorNative

▸ Const generateInitializationVectorNative(vectorLength?): Uint8Array | Error

return a random vector, used e.g. for aes-gcm encryption

Parameters

Name Type Description
vectorLength number length of the vector generated

Returns

Uint8Array | Error

Defined in

encryption-utils/encrypt-data.encryption-utils.ts:32

generateInitializationVectorNativeArrayBuffer

▸ Const generateInitializationVectorNativeArrayBuffer(vectorLength?): ArrayBuffer | Error

Parameters

Name Type
vectorLength? number

Returns

ArrayBuffer | Error

Defined in

encryption-utils/encrypt-data.encryption-utils.ts:42

generateKeyPair

▸ Const generateKeyPair(): PromiseLike<CryptoKeyPair>

Returns

PromiseLike<CryptoKeyPair>

Defined in

encryption-utils/keys.encryption-utils.ts:44

generatePasswordKey

▸ Const generatePasswordKey(password): Promise<CryptoKey | Error>

Parameters

Name Type
password TPasswordEncryptionSupportedPasswordNativeTypes

Returns

Promise<CryptoKey | Error>

Defined in

password-utils/derive-key.password-utils.ts:28

generatePasswordKeyAsString

▸ Const generatePasswordKeyAsString(passwordString, salt): Promise<string | Error>

Parameters

Name Type
passwordString string
salt TSaltUtilsSaltType

Returns

Promise<string | Error>

Defined in

password-utils/derive-key.password-utils.ts:154

generatePasswordKeyByPasswordString

▸ Const generatePasswordKeyByPasswordString(passwordString, saltValue): Promise<CryptoKey | Error>

Parameters

Name Type
passwordString string
saltValue TSaltUtilsSaltType

Returns

Promise<CryptoKey | Error>

Defined in

password-utils/derive-key.password-utils.ts:79

generatePasswordKeyInExportFormat

▸ Const generatePasswordKeyInExportFormat(passwordString, salt): Promise<JsonWebKey | Error>

Parameters

Name Type
passwordString string
salt TSaltUtilsSaltType

Returns

Promise<JsonWebKey | Error>

Defined in

password-utils/derive-key.password-utils.ts:138

generateSalt

▸ Const generateSalt(saltLength?): Uint8Array | Error

Parameters

Name Type
saltLength number

Returns

Uint8Array | Error

Defined in

encryption-utils/salt-utils.ts:24

generateSaltNative

▸ Const generateSaltNative(saltLength): Uint8Array | Error

Parameters

Name Type
saltLength number

Returns

Uint8Array | Error

Defined in

encryption-utils/salt-utils.ts:16

generateSaltString

▸ Const generateSaltString(saltLength?): string | Error

Parameters

Name Type
saltLength? number

Returns

string | Error

Defined in

encryption-utils/salt-utils.ts:40

getDerivationNative

▸ Const getDerivationNative(passwordKey, saltValue): Promise<CryptoKey | Error>

Parameters

Name Type
passwordKey CryptoKey
saltValue Uint8Array

Returns

Promise<CryptoKey | Error>

Defined in

password-utils/derive-key.password-utils.ts:47

getInitializationVectorFromData

▸ Const getInitializationVectorFromData(arrayBuffer, ivLengthBytes?): Error | TCryptoUtilsDataWithInitializationVector

Parameters

Name Type
arrayBuffer ArrayBuffer
ivLengthBytes number

Returns

Error | TCryptoUtilsDataWithInitializationVector

Defined in

encryption-utils/encrypt-data.encryption-utils.ts:63

getInitializationVectorFromDataString

▸ Const getInitializationVectorFromDataString(data, ivLengthBytes?): Error | TCryptoUtilsDataWithInitializationVector

Parameters

Name Type
data string
ivLengthBytes? number

Returns

Error | TCryptoUtilsDataWithInitializationVector

Defined in

encryption-utils/encrypt-data.encryption-utils.ts:88

getJWK

▸ Const getJWK(key, isReturnError?): boolean | JsonWebKey | Error

Parameters

Name Type Default value
key any undefined
isReturnError boolean false

Returns

boolean | JsonWebKey | Error

Defined in

encryption-keys-utils/encryption-keys-utils.ts:102

getJWKOrBool

▸ Const getJWKOrBool(key): boolean | JsonWebKey

Parameters

Name Type
key any

Returns

boolean | JsonWebKey

Defined in

encryption-keys-utils/encryption-keys-utils.ts:129

getJWKOrError

▸ Const getJWKOrError(key): JsonWebKey | Error

Parameters

Name Type
key any

Returns

JsonWebKey | Error

Defined in

encryption-keys-utils/encryption-keys-utils.ts:126

getKeyOfType

▸ Const getKeyOfType(key, type): Promise<CryptoKey | Error>

Parameters

Name Type
key TCryptoUtilEncryptKeyTypes
type KeyType

Returns

Promise<CryptoKey | Error>

Defined in

encryption-utils/keys.encryption-utils.ts:314

hashCalculator

▸ Const hashCalculator(algorithm, data): Promise<ArrayBuffer>

Parameters

Name Type
algorithm AlgorithmIdentifier
data ArrayBuffer | Int8Array | Uint8Array | Uint8ClampedArray | Int16Array | Uint16Array | Int32Array | Uint32Array | Float32Array | Float64Array | DataView

Returns

Promise<ArrayBuffer>

Defined in

hash-calculation-utils/hash-calculation-utils.ts:14

importKey

▸ Const importKey(key, isPublic?): PromiseLike<CryptoKey>

Parameters

Name Type Default value
key object undefined
isPublic boolean true

Returns

PromiseLike<CryptoKey>

Defined in

encryption-utils/keys.encryption-utils.ts:170

importKeyFromString

▸ Const importKeyFromString(keyString, isPublic?): Error | PromiseLike<CryptoKey>

Parameters

Name Type Default value
keyString string undefined
isPublic boolean true

Returns

Error | PromiseLike<CryptoKey>

Defined in

encryption-utils/keys.encryption-utils.ts:286

importKeyPair

▸ Const importKeyPair(keyPair, checkPrivateKey?): Promise<Error | TCryptoUtilKeypairImportFormatType>

Parameters

Name Type Default value
keyPair TCryptoUtilKeypairPreImportFormatType undefined
checkPrivateKey boolean true

Returns

Promise<Error | TCryptoUtilKeypairImportFormatType>

Defined in

encryption-utils/keys.encryption-utils.ts:189

importKeyPairFromString

▸ Const importKeyPairFromString(keyPairString, password?): Promise<Error | TCryptoUtilKeypairImportFormatType>

Parameters

Name Type
keyPairString string
password? string

Returns

Promise<Error | TCryptoUtilKeypairImportFormatType>

Defined in

encryption-utils/keys.encryption-utils.ts:243

importPasswordKey

▸ Const importPasswordKey(passwordKey): Promise<CryptoKey | Error>

Parameters

Name Type
passwordKey JsonWebKey

Returns

Promise<CryptoKey | Error>

Defined in

password-utils/derive-key.password-utils.ts:170

importPasswordKeyFromString

▸ Const importPasswordKeyFromString(passwordKey): Promise<CryptoKey | Error>

Parameters

Name Type
passwordKey string

Returns

Promise<CryptoKey | Error>

Defined in

password-utils/derive-key.password-utils.ts:188

importPrivateKey

▸ Const importPrivateKey(key): PromiseLike<CryptoKey>

Parameters

Name Type
key object

Returns

PromiseLike<CryptoKey>

Defined in

encryption-utils/keys.encryption-utils.ts:186

importPrivateKeyFromString

▸ Const importPrivateKeyFromString(key): Error | PromiseLike<CryptoKey>

Parameters

Name Type
key string

Returns

Error | PromiseLike<CryptoKey>

Defined in

encryption-utils/keys.encryption-utils.ts:301

importPublicKey

▸ Const importPublicKey(key): PromiseLike<CryptoKey>

Parameters

Name Type
key object

Returns

PromiseLike<CryptoKey>

Defined in

encryption-utils/keys.encryption-utils.ts:183

importPublicKeyFromString

▸ Const importPublicKeyFromString(key): Error | PromiseLike<CryptoKey>

Parameters

Name Type
key string

Returns

Error | PromiseLike<CryptoKey>

Defined in

encryption-utils/keys.encryption-utils.ts:297

importSalt

▸ Const importSalt(salt): Uint8Array | Error

Parameters

Name Type
salt TSaltUtilsSaltType

Returns

Uint8Array | Error

Defined in

encryption-utils/salt-utils.ts:103

isCryptoKey

▸ Const isCryptoKey(v): v is CryptoKey

Parameters

Name Type
v any

Returns

v is CryptoKey

Defined in

encryption-keys-utils/encryption-keys-utils.ts:23

isCryptoKeyDataDecryption

▸ Const isCryptoKeyDataDecryption(cryptoKey): cryptoKey is CryptoKey

Parameters

Name Type
cryptoKey any

Returns

cryptoKey is CryptoKey

Defined in

encryption-keys-utils/encryption-keys-utils.ts:64

isCryptoKeyDataEncryption

▸ Const isCryptoKeyDataEncryption(cryptoKey): cryptoKey is CryptoKey

Parameters

Name Type
cryptoKey any

Returns

cryptoKey is CryptoKey

Defined in

encryption-keys-utils/encryption-keys-utils.ts:58

isCryptoKeyDataSign

▸ Const isCryptoKeyDataSign(cryptoKey): cryptoKey is CryptoKey

Parameters

Name Type
cryptoKey any

Returns

cryptoKey is CryptoKey

Defined in

encryption-keys-utils/encryption-keys-utils.ts:50

isCryptoKeyDataVerify

▸ Const isCryptoKeyDataVerify(cryptoKey): cryptoKey is CryptoKey

Parameters

Name Type
cryptoKey any

Returns

cryptoKey is CryptoKey

Defined in

encryption-keys-utils/encryption-keys-utils.ts:54

isCryptoKeyIncludesUsages

▸ Const isCryptoKeyIncludesUsages(cryptoKey, expectedUsages): boolean

Parameters

Name Type
cryptoKey CryptoKey
expectedUsages eCRYPTO_UTILS_KEYS_USAGES | eCRYPTO_UTILS_KEYS_USAGES[]

Returns

boolean

Defined in

encryption-keys-utils/encryption-keys-utils.ts:38

isCryptoKeyPair

▸ Const isCryptoKeyPair(keyPair, checkPrivateKeys?): keyPair is CryptoKeyPair

Parameters

Name Type Default value
keyPair any undefined
checkPrivateKeys boolean true

Returns

keyPair is CryptoKeyPair

Defined in

encryption-keys-utils/encryption-keys-utils.ts:27

isCryptoKeyPairExportedAsString

▸ Const isCryptoKeyPairExportedAsString(keyPair): boolean

Parameters

Name Type
keyPair any

Returns

boolean

Defined in

encryption-keys-utils/encryption-keys-utils.ts:70

isCryptoKeyPairImported

▸ Const isCryptoKeyPairImported(key, checkPrivateKey?): key is TCryptoUtilKeypairExportFormatType

Parameters

Name Type Default value
key any undefined
checkPrivateKey boolean true

Returns

key is TCryptoUtilKeypairExportFormatType

Defined in

encryption-utils/keys.encryption-utils.ts:33

isJWK

▸ Const isJWK(keyObject, isReturnError?): boolean | Error

Parameters

Name Type Default value
keyObject object undefined
isReturnError boolean false

Returns

boolean | Error

Defined in

encryption-keys-utils/encryption-keys-utils.ts:74

isValidSalt

▸ Const isValidSalt(salt): salt is TSaltUtilsSaltType

Parameters

Name Type
salt any

Returns

salt is TSaltUtilsSaltType

Defined in

encryption-utils/salt-utils.ts:50

signNative

▸ Const signNative(key, data): Promise<ArrayBuffer | Error>

Parameters

Name Type
key CryptoKey
data TTypedArrays

Returns

Promise<ArrayBuffer | Error>

Defined in

data-sign-utils/sign-data.encryption-utils.ts:19

signToString

▸ Const signToString(key, data): Promise<string | Error>

Parameters

Name Type
key TDataSignUtilSignKeyTypes
data TDataSignUtilSignDataTypes

Returns

Promise<string | Error>

Defined in

data-sign-utils/sign-data.encryption-utils.ts:65

signToTypedArray

▸ Const signToTypedArray(key, data): Promise<ArrayBuffer | Error>

Parameters

Name Type
key TDataSignUtilSignKeyTypes
data TDataSignUtilSignDataTypes

Returns

Promise<ArrayBuffer | Error>

Defined in

data-sign-utils/sign-data.encryption-utils.ts:41

verifyData

▸ Const verifyData(key, data, signature): Promise<true | Error>

Parameters

Name Type
key TDataSignUtilVerifyKeyTypes
data TDataSignUtilVerifyDataTypesExtended
signature TDataSignUtilVerifyDataTypes

Returns

Promise<true | Error>

Defined in

data-sign-utils/verify-data.encryption-utils.ts:46

verifyNative

▸ Const verifyNative(key, data, signature): Promise<true | Error>

Parameters

Name Type
key CryptoKey
data TTypedArrays
signature TTypedArrays

Returns

Promise<true | Error>

Defined in

data-sign-utils/verify-data.encryption-utils.ts:17