From 925c034c8cb61003a835a36ba9f8b123245e8f16 Mon Sep 17 00:00:00 2001 From: nealfennimore Date: Fri, 23 Aug 2024 19:58:38 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20nealfenn?= =?UTF-8?q?imore/webcrypto-ts@671f7c773fe9f6c673abedb19946c6676495e345=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- enums/aes_shared.Alg.Mode.html | 2 +- enums/ec_shared.Alg.Curve.html | 2 +- enums/ec_shared.Alg.Variant.html | 2 +- enums/hmac.Alg.Code.html | 2 +- enums/kdf_shared.Alg.Variant.html | 2 +- enums/key_usages.KeyFormats.html | 2 +- enums/key_usages.KeyUsages.html | 2 +- enums/rsa_shared.Alg.Variant.html | 2 +- enums/sha_shared.Alg.Variant.html | 2 +- index.html | 4 ++-- interfaces/aes_shared.AesCbcCryptoKey.html | 2 +- .../aes_shared.AesCbcProxiedCryptoKey.html | 2 +- interfaces/aes_shared.AesCtrCryptoKey.html | 2 +- .../aes_shared.AesCtrProxiedCryptoKey.html | 2 +- interfaces/aes_shared.AesGcmCryptoKey.html | 2 +- .../aes_shared.AesGcmProxiedCryptoKey.html | 2 +- interfaces/aes_shared.AesKwCryptoKey.html | 2 +- .../aes_shared.AesKwProxiedCryptoKey.html | 2 +- interfaces/ec_shared.EcdhCryptoKeyPair.html | 2 +- interfaces/ec_shared.EcdhPrivCryptoKey.html | 2 +- .../ec_shared.EcdhProxiedCryptoKeyPair.html | 2 +- .../ec_shared.EcdhProxiedPrivCryptoKey.html | 2 +- .../ec_shared.EcdhProxiedPubCryptoKey.html | 2 +- interfaces/ec_shared.EcdhPubCryptoKey.html | 2 +- interfaces/ec_shared.EcdsaCryptoKeyPair.html | 2 +- interfaces/ec_shared.EcdsaPrivCryptoKey.html | 2 +- .../ec_shared.EcdsaProxiedCryptoKeyPair.html | 2 +- .../ec_shared.EcdsaProxiedPrivCryptoKey.html | 2 +- .../ec_shared.EcdsaProxiedPubCryptoKey.html | 2 +- interfaces/ec_shared.EcdsaPubCryptoKey.html | 2 +- interfaces/hmac.HmacCryptoKey.html | 2 +- interfaces/hmac.HmacProxiedCryptoKey.html | 2 +- interfaces/kdf_shared.HkdfKeyMaterial.html | 2 +- .../kdf_shared.HkdfProxiedKeyMaterial.html | 2 +- interfaces/kdf_shared.Pbkdf2KeyMaterial.html | 2 +- .../kdf_shared.Pbkdf2ProxiedKeyMaterial.html | 2 +- interfaces/params.AesCbcKeyAlgorithm.html | 2 +- interfaces/params.AesCtrKeyAlgorithm.html | 2 +- interfaces/params.AesGcmKeyAlgorithm.html | 2 +- interfaces/params.AesKwKeyAlgorithm.html | 2 +- interfaces/params.EnforcedAesCbcParams.html | 2 +- interfaces/params.EnforcedAesCtrParams.html | 2 +- interfaces/params.EnforcedAesGcmParams.html | 2 +- interfaces/params.EnforcedAesKeyGenParams.html | 2 +- interfaces/params.EnforcedAesKwParams.html | 2 +- interfaces/params.EnforcedEcKeyGenParams.html | 2 +- .../params.EnforcedEcKeyImportParams.html | 2 +- .../params.EnforcedEcdhKeyDeriveParams.html | 2 +- interfaces/params.EnforcedEcdsaParams.html | 2 +- interfaces/params.EnforcedHkdfParams.html | 2 +- .../params.EnforcedHmacImportParams.html | 2 +- .../params.EnforcedHmacKeyGenParams.html | 2 +- interfaces/params.EnforcedPbkdf2Params.html | 2 +- .../params.EnforcedRsaHashedImportParams.html | 2 +- .../params.EnforcedRsaHashedKeyGenParams.html | 2 +- interfaces/params.EnforcedRsaOaepParams.html | 2 +- interfaces/params.EnforcedRsaPssParams.html | 2 +- .../params.EnforcedRsassaPkcs1v15Params.html | 2 +- interfaces/params.HmacKeyAlgorithm.html | 2 +- interfaces/proxy.ProxiedCryptoKey.html | 2 +- interfaces/proxy.ProxiedCryptoKeyPair.html | 2 +- interfaces/proxy.ProxyKeyPairHandlers.html | 2 +- .../rsa_shared.RsaOaepCryptoKeyPair.html | 2 +- .../rsa_shared.RsaOaepPrivCryptoKey.html | 2 +- ...rsa_shared.RsaOaepProxiedCryptoKeyPair.html | 2 +- ...rsa_shared.RsaOaepProxiedPrivCryptoKey.html | 2 +- .../rsa_shared.RsaOaepProxiedPubCryptoKey.html | 2 +- interfaces/rsa_shared.RsaOaepPubCryptoKey.html | 2 +- interfaces/rsa_shared.RsaPssCryptoKeyPair.html | 2 +- interfaces/rsa_shared.RsaPssPrivCryptoKey.html | 2 +- .../rsa_shared.RsaPssProxiedCryptoKeyPair.html | 2 +- .../rsa_shared.RsaPssProxiedPrivCryptoKey.html | 2 +- .../rsa_shared.RsaPssProxiedPubCryptoKey.html | 2 +- interfaces/rsa_shared.RsaPssPubCryptoKey.html | 2 +- ...rsa_shared.RsassaPkcs1V15CryptoKeyPair.html | 2 +- ...rsa_shared.RsassaPkcs1V15PrivCryptoKey.html | 2 +- ...red.RsassaPkcs1V15ProxiedCryptoKeyPair.html | 2 +- ...red.RsassaPkcs1V15ProxiedPrivCryptoKey.html | 2 +- ...ared.RsassaPkcs1V15ProxiedPubCryptoKey.html | 2 +- .../rsa_shared.RsassaPkcs1V15PubCryptoKey.html | 2 +- interfaces/sha_shared.Sha1ArrayBuffer.html | 2 +- interfaces/sha_shared.Sha256ArrayBuffer.html | 2 +- interfaces/sha_shared.Sha384ArrayBuffer.html | 2 +- interfaces/sha_shared.Sha512ArrayBuffer.html | 2 +- modules.html | 2 +- modules/aes.html | 4 ++-- modules/aes_aes_cbc.html | 16 ++++++++-------- modules/aes_aes_ctr.html | 18 +++++++++--------- modules/aes_aes_gcm.html | 16 ++++++++-------- modules/aes_aes_kw.html | 12 ++++++------ modules/aes_shared.AesShared.html | 2 +- modules/aes_shared.Alg.html | 2 +- modules/aes_shared.html | 4 ++-- modules/ec.html | 4 ++-- modules/ec_ecdh.html | 14 +++++++------- modules/ec_ecdsa.html | 14 +++++++------- modules/ec_shared.Alg.html | 2 +- modules/ec_shared.EcShared.html | 2 +- modules/ec_shared.html | 4 ++-- modules/hmac.Alg.html | 2 +- modules/hmac.html | 12 ++++++------ modules/index.html | 4 ++-- modules/kdf.html | 4 ++-- modules/kdf_hkdf.html | 8 ++++---- modules/kdf_pbkdf.html | 8 ++++---- modules/kdf_shared.Alg.html | 2 +- modules/kdf_shared.KdfShared.html | 2 +- modules/kdf_shared.html | 2 +- modules/key_usages.html | 4 ++-- modules/params.html | 4 ++-- modules/proxy.html | 4 ++-- modules/random.IV.html | 4 ++-- modules/random.Salt.html | 4 ++-- modules/random.UUID.html | 4 ++-- modules/random.html | 4 ++-- modules/rsa.html | 4 ++-- modules/rsa_rsa_oaep.html | 18 +++++++++--------- modules/rsa_rsa_pss.html | 14 +++++++------- modules/rsa_rsassa_pkcs1_v1_5.html | 14 +++++++------- modules/rsa_shared.Alg.html | 2 +- modules/rsa_shared.RsaShared.html | 2 +- modules/rsa_shared.html | 4 ++-- modules/sha.html | 4 ++-- modules/sha_sha_1.html | 6 +++--- modules/sha_sha_256.html | 6 +++--- modules/sha_sha_384.html | 6 +++--- modules/sha_sha_512.html | 6 +++--- modules/sha_shared.Alg.html | 2 +- modules/sha_shared.ShaShared.html | 2 +- modules/sha_shared.html | 4 ++-- modules/webcrypto.html | 6 +++--- 131 files changed, 229 insertions(+), 229 deletions(-) diff --git a/enums/aes_shared.Alg.Mode.html b/enums/aes_shared.Alg.Mode.html index eef91e7..d6980b3 100644 --- a/enums/aes_shared.Alg.Mode.html +++ b/enums/aes_shared.Alg.Mode.html @@ -1 +1 @@ -Mode | @nfen/webcrypto-ts

Enumeration aes/shared.Alg.Mode

source · [−]

Enumeration Members

\ No newline at end of file +Mode | @nfen/webcrypto-ts

Enumeration aes/shared.Alg.Mode

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/enums/ec_shared.Alg.Curve.html b/enums/ec_shared.Alg.Curve.html index a6c1826..b00c800 100644 --- a/enums/ec_shared.Alg.Curve.html +++ b/enums/ec_shared.Alg.Curve.html @@ -1 +1 @@ -Curve | @nfen/webcrypto-ts

Enumeration ec/shared.Alg.Curve

source · [−]

Enumeration Members

\ No newline at end of file +Curve | @nfen/webcrypto-ts

Enumeration ec/shared.Alg.Curve

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/enums/ec_shared.Alg.Variant.html b/enums/ec_shared.Alg.Variant.html index f3d84a8..1c9289e 100644 --- a/enums/ec_shared.Alg.Variant.html +++ b/enums/ec_shared.Alg.Variant.html @@ -1 +1 @@ -Variant | @nfen/webcrypto-ts

Enumeration ec/shared.Alg.Variant

source · [−]

Enumeration Members

\ No newline at end of file +Variant | @nfen/webcrypto-ts

Enumeration ec/shared.Alg.Variant

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/enums/hmac.Alg.Code.html b/enums/hmac.Alg.Code.html index 62c4c39..913810c 100644 --- a/enums/hmac.Alg.Code.html +++ b/enums/hmac.Alg.Code.html @@ -1 +1 @@ -Code | @nfen/webcrypto-ts

Enumeration hmac.Alg.Code

source · [−]

Enumeration Members

\ No newline at end of file +Code | @nfen/webcrypto-ts

Enumeration hmac.Alg.Code

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/enums/kdf_shared.Alg.Variant.html b/enums/kdf_shared.Alg.Variant.html index e409a50..44079cc 100644 --- a/enums/kdf_shared.Alg.Variant.html +++ b/enums/kdf_shared.Alg.Variant.html @@ -1 +1 @@ -Variant | @nfen/webcrypto-ts

Enumeration kdf/shared.Alg.Variant

source · [−]

Enumeration Members

\ No newline at end of file +Variant | @nfen/webcrypto-ts

Enumeration kdf/shared.Alg.Variant

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/enums/key_usages.KeyFormats.html b/enums/key_usages.KeyFormats.html index 9af6d08..fa53f71 100644 --- a/enums/key_usages.KeyFormats.html +++ b/enums/key_usages.KeyFormats.html @@ -1 +1 @@ -KeyFormats | @nfen/webcrypto-ts

Enumeration key_usages.KeyFormats

source · [−]

Enumeration Members

\ No newline at end of file +KeyFormats | @nfen/webcrypto-ts

Enumeration key_usages.KeyFormats

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/enums/key_usages.KeyUsages.html b/enums/key_usages.KeyUsages.html index e245ab5..4ff5270 100644 --- a/enums/key_usages.KeyUsages.html +++ b/enums/key_usages.KeyUsages.html @@ -1 +1 @@ -KeyUsages | @nfen/webcrypto-ts

Enumeration key_usages.KeyUsages

source · [−]

Enumeration Members

\ No newline at end of file +KeyUsages | @nfen/webcrypto-ts

Enumeration key_usages.KeyUsages

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/enums/rsa_shared.Alg.Variant.html b/enums/rsa_shared.Alg.Variant.html index 8fd9a80..a6784eb 100644 --- a/enums/rsa_shared.Alg.Variant.html +++ b/enums/rsa_shared.Alg.Variant.html @@ -1 +1 @@ -Variant | @nfen/webcrypto-ts

Enumeration rsa/shared.Alg.Variant

source · [−]

Enumeration Members

\ No newline at end of file +Variant | @nfen/webcrypto-ts

Enumeration rsa/shared.Alg.Variant

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/enums/sha_shared.Alg.Variant.html b/enums/sha_shared.Alg.Variant.html index 155715b..7ab1904 100644 --- a/enums/sha_shared.Alg.Variant.html +++ b/enums/sha_shared.Alg.Variant.html @@ -1 +1 @@ -Variant | @nfen/webcrypto-ts

Enumeration sha/shared.Alg.Variant

source · [−]

Enumeration Members

\ No newline at end of file +Variant | @nfen/webcrypto-ts

Enumeration sha/shared.Alg.Variant

source · [−]

Enumeration Members

\ No newline at end of file diff --git a/index.html b/index.html index 205f3af..eb292ff 100644 --- a/index.html +++ b/index.html @@ -1,4 +1,4 @@ -@nfen/webcrypto-ts

@nfen/webcrypto-ts

[−]
Expand description
+@nfen/webcrypto-ts

@nfen/webcrypto-ts

[−]
Expand description

Webcrypto TS

Test codecov

A minimal ESM based, no dependency, typescript wrapper for the Web Crypto API. Supports both nodejs and browser Web Crypto.

@@ -16,7 +16,7 @@

Install

Proxied Keys and Methods

All generated keys are wrapped in a Proxy object, which allows for executing methods specific to each key within a small wrapper.

For example, we can generate an ECDSA keypair and sign directly off the privateKey.

-
import * as ECDSA from "@nfen/webcrypto-ts/lib/ec/ecdsa";
const keyPair = await ECDSA.generateKeyPair();
const message = new TextEncoder().encode("a message");
const signature = await keyPair.privateKey.sign({ hash: "SHA-512" });
+
import * as ECDSA from "@nfen/webcrypto-ts/lib/ec/ecdsa";
const keyPair = await ECDSA.generateKeyPair();
const message = new TextEncoder().encode("a message");
const signature = await keyPair.privateKey.sign({ hash: "SHA-512" }, message);
 

 
We can still use the WebCrypto based API too. Access any CryptoKey or CryptoKeyPair by using self on the key.

 
const signature = await ECDSA.sign(keyPair.privateKey.self, { hash: "SHA-512" }, message);
diff --git a/interfaces/aes_shared.AesCbcCryptoKey.html b/interfaces/aes_shared.AesCbcCryptoKey.html
index f387700..4cc9bdc 100644
--- a/interfaces/aes_shared.AesCbcCryptoKey.html
+++ b/interfaces/aes_shared.AesCbcCryptoKey.html
@@ -1 +1 @@
-AesCbcCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesCbcCryptoKey
source · [−]
Properties
source
_aesCbcKeyBrand
source
_aesCbcKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+AesCbcCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesCbcCryptoKey
source · [−]
Properties
source
_aesCbcKeyBrand
source
_aesCbcKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/aes_shared.AesCbcProxiedCryptoKey.html b/interfaces/aes_shared.AesCbcProxiedCryptoKey.html
index 2f4ecfa..4284139 100644
--- a/interfaces/aes_shared.AesCbcProxiedCryptoKey.html
+++ b/interfaces/aes_shared.AesCbcProxiedCryptoKey.html
@@ -1 +1 @@
-AesCbcProxiedCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesCbcProxiedCryptoKey
source · [−]
Properties
Methods
decrypt
source
(algorithm: Omit<EnforcedAesCbcParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
encrypt
source
(algorithm: Omit<EnforcedAesCbcParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
unwrapKey
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKeyAlgorithm: Omit<EnforcedAesCbcParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
Parameters
Returns Promise<CryptoKey>
wrapKey
source
(format: KeyFormat, key: CryptoKey, wrapAlgorithm: Omit<EnforcedAesCbcParams, "name">): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
+AesCbcProxiedCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesCbcProxiedCryptoKey
source · [−]
Properties
Methods
decrypt
source
(algorithm: Omit<EnforcedAesCbcParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
encrypt
source
(algorithm: Omit<EnforcedAesCbcParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
unwrapKey
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKeyAlgorithm: Omit<EnforcedAesCbcParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
Parameters
Returns Promise<CryptoKey>
wrapKey
source
(format: KeyFormat, key: CryptoKey, wrapAlgorithm: Omit<EnforcedAesCbcParams, "name">): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/aes_shared.AesCtrCryptoKey.html b/interfaces/aes_shared.AesCtrCryptoKey.html
index a3eb338..5afc5c6 100644
--- a/interfaces/aes_shared.AesCtrCryptoKey.html
+++ b/interfaces/aes_shared.AesCtrCryptoKey.html
@@ -1 +1 @@
-AesCtrCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesCtrCryptoKey
source · [−]
Properties
source
_aesCtrKeyBrand
source
_aesCtrKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+AesCtrCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesCtrCryptoKey
source · [−]
Properties
source
_aesCtrKeyBrand
source
_aesCtrKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/aes_shared.AesCtrProxiedCryptoKey.html b/interfaces/aes_shared.AesCtrProxiedCryptoKey.html
index 8dcccab..648b8fa 100644
--- a/interfaces/aes_shared.AesCtrProxiedCryptoKey.html
+++ b/interfaces/aes_shared.AesCtrProxiedCryptoKey.html
@@ -1 +1 @@
-AesCtrProxiedCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesCtrProxiedCryptoKey
source · [−]
Properties
Methods
decrypt
source
(algorithm: Omit<EnforcedAesCtrParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
encrypt
source
(algorithm: Omit<EnforcedAesCtrParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
unwrapKey
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKeyAlgorithm: Omit<EnforcedAesCtrParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
Parameters
Returns Promise<CryptoKey>
wrapKey
source
(format: KeyFormat, key: CryptoKey, wrapAlgorithm: Omit<EnforcedAesCtrParams, "name">): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
+AesCtrProxiedCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesCtrProxiedCryptoKey
source · [−]
Properties
Methods
decrypt
source
(algorithm: Omit<EnforcedAesCtrParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
encrypt
source
(algorithm: Omit<EnforcedAesCtrParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
unwrapKey
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKeyAlgorithm: Omit<EnforcedAesCtrParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
Parameters
Returns Promise<CryptoKey>
wrapKey
source
(format: KeyFormat, key: CryptoKey, wrapAlgorithm: Omit<EnforcedAesCtrParams, "name">): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/aes_shared.AesGcmCryptoKey.html b/interfaces/aes_shared.AesGcmCryptoKey.html
index ea1bc3c..ba2783b 100644
--- a/interfaces/aes_shared.AesGcmCryptoKey.html
+++ b/interfaces/aes_shared.AesGcmCryptoKey.html
@@ -1 +1 @@
-AesGcmCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesGcmCryptoKey
source · [−]
Properties
source
_aesGcmKeyBrand
source
_aesGcmKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+AesGcmCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesGcmCryptoKey
source · [−]
Properties
source
_aesGcmKeyBrand
source
_aesGcmKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/aes_shared.AesGcmProxiedCryptoKey.html b/interfaces/aes_shared.AesGcmProxiedCryptoKey.html
index a16df64..530d71e 100644
--- a/interfaces/aes_shared.AesGcmProxiedCryptoKey.html
+++ b/interfaces/aes_shared.AesGcmProxiedCryptoKey.html
@@ -1 +1 @@
-AesGcmProxiedCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesGcmProxiedCryptoKey
source · [−]
Properties
Methods
decrypt
source
(algorithm: Omit<EnforcedAesGcmParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
encrypt
source
(algorithm: Omit<EnforcedAesGcmParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
unwrapKey
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKeyAlgorithm: Omit<EnforcedAesGcmParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
Parameters
Returns Promise<CryptoKey>
wrapKey
source
(format: KeyFormat, key: CryptoKey, wrapAlgorithm: Omit<EnforcedAesGcmParams, "name">): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
+AesGcmProxiedCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesGcmProxiedCryptoKey
source · [−]
Properties
Methods
decrypt
source
(algorithm: Omit<EnforcedAesGcmParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
encrypt
source
(algorithm: Omit<EnforcedAesGcmParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
unwrapKey
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKeyAlgorithm: Omit<EnforcedAesGcmParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
Parameters
Returns Promise<CryptoKey>
wrapKey
source
(format: KeyFormat, key: CryptoKey, wrapAlgorithm: Omit<EnforcedAesGcmParams, "name">): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/aes_shared.AesKwCryptoKey.html b/interfaces/aes_shared.AesKwCryptoKey.html
index 4cb4366..62bb0a4 100644
--- a/interfaces/aes_shared.AesKwCryptoKey.html
+++ b/interfaces/aes_shared.AesKwCryptoKey.html
@@ -1 +1 @@
-AesKwCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesKwCryptoKey
source · [−]
Properties
source
_aesKwKeyBrand
source
_aesKwKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+AesKwCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesKwCryptoKey
source · [−]
Properties
source
_aesKwKeyBrand
source
_aesKwKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/aes_shared.AesKwProxiedCryptoKey.html b/interfaces/aes_shared.AesKwProxiedCryptoKey.html
index 1e2c595..4c1724a 100644
--- a/interfaces/aes_shared.AesKwProxiedCryptoKey.html
+++ b/interfaces/aes_shared.AesKwProxiedCryptoKey.html
@@ -1 +1 @@
-AesKwProxiedCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesKwProxiedCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
unwrapKey
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
Parameters
  • format: KeyFormat
  • wrappedKey: BufferSource
  • wrappedKeyAlgorithm: EnforcedImportParams
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
wrapKey
source
(format: KeyFormat, key: CryptoKey): Promise<ArrayBuffer>
Parameters
  • format: KeyFormat
  • key: CryptoKey
Returns Promise<ArrayBuffer>

\ No newline at end of file
+AesKwProxiedCryptoKey | @nfen/webcrypto-ts
Interface aes/shared.AesKwProxiedCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
unwrapKey
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
Parameters
  • format: KeyFormat
  • wrappedKey: BufferSource
  • wrappedKeyAlgorithm: EnforcedImportParams
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]
Returns Promise<CryptoKey>
wrapKey
source
(format: KeyFormat, key: CryptoKey): Promise<ArrayBuffer>
Parameters
  • format: KeyFormat
  • key: CryptoKey
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdhCryptoKeyPair.html b/interfaces/ec_shared.EcdhCryptoKeyPair.html
index 1017329..53a95ee 100644
--- a/interfaces/ec_shared.EcdhCryptoKeyPair.html
+++ b/interfaces/ec_shared.EcdhCryptoKeyPair.html
@@ -1 +1 @@
-EcdhCryptoKeyPair | @nfen/webcrypto-ts
Interface ec/shared.EcdhCryptoKeyPair
source · [−]
Properties
source
_ecdhCryptoKeyPairBrand
source
_ecdhCryptoKeyPairBrand: any

\ No newline at end of file
+EcdhCryptoKeyPair | @nfen/webcrypto-ts
Interface ec/shared.EcdhCryptoKeyPair
source · [−]
Properties
source
_ecdhCryptoKeyPairBrand
source
_ecdhCryptoKeyPairBrand: any

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdhPrivCryptoKey.html b/interfaces/ec_shared.EcdhPrivCryptoKey.html
index 1d0dc76..583c523 100644
--- a/interfaces/ec_shared.EcdhPrivCryptoKey.html
+++ b/interfaces/ec_shared.EcdhPrivCryptoKey.html
@@ -1 +1 @@
-EcdhPrivCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdhPrivCryptoKey
source · [−]
Properties
source
_ecdhPrivCryptoKeyBrand
source
_ecdhPrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+EcdhPrivCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdhPrivCryptoKey
source · [−]
Properties
source
_ecdhPrivCryptoKeyBrand
source
_ecdhPrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdhProxiedCryptoKeyPair.html b/interfaces/ec_shared.EcdhProxiedCryptoKeyPair.html
index 9657cbb..8a5f814 100644
--- a/interfaces/ec_shared.EcdhProxiedCryptoKeyPair.html
+++ b/interfaces/ec_shared.EcdhProxiedCryptoKeyPair.html
@@ -1 +1 @@
-EcdhProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface ec/shared.EcdhProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
+EcdhProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface ec/shared.EcdhProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdhProxiedPrivCryptoKey.html b/interfaces/ec_shared.EcdhProxiedPrivCryptoKey.html
index b7aff38..455a526 100644
--- a/interfaces/ec_shared.EcdhProxiedPrivCryptoKey.html
+++ b/interfaces/ec_shared.EcdhProxiedPrivCryptoKey.html
@@ -1 +1 @@
-EcdhProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdhProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(algorithm: Omit<EnforcedEcdhKeyDeriveParams, "name">, length: number): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(algorithm: Omit<EnforcedEcdhKeyDeriveParams, "name">, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>
Parameters
Returns Promise<HmacCryptoKey | AesCryptoKeys>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>

\ No newline at end of file
+EcdhProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdhProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(algorithm: Omit<EnforcedEcdhKeyDeriveParams, "name">, length: number): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(algorithm: Omit<EnforcedEcdhKeyDeriveParams, "name">, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>
Parameters
Returns Promise<HmacCryptoKey | AesCryptoKeys>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdhProxiedPubCryptoKey.html b/interfaces/ec_shared.EcdhProxiedPubCryptoKey.html
index 21f2896..0e846af 100644
--- a/interfaces/ec_shared.EcdhProxiedPubCryptoKey.html
+++ b/interfaces/ec_shared.EcdhProxiedPubCryptoKey.html
@@ -1 +1 @@
-EcdhProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdhProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>

\ No newline at end of file
+EcdhProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdhProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdhPubCryptoKey.html b/interfaces/ec_shared.EcdhPubCryptoKey.html
index 9e3fb75..8516ceb 100644
--- a/interfaces/ec_shared.EcdhPubCryptoKey.html
+++ b/interfaces/ec_shared.EcdhPubCryptoKey.html
@@ -1 +1 @@
-EcdhPubCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdhPubCryptoKey
source · [−]
Properties
source
_ecdhPubCryptoKeyBrand
source
_ecdhPubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+EcdhPubCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdhPubCryptoKey
source · [−]
Properties
source
_ecdhPubCryptoKeyBrand
source
_ecdhPubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdsaCryptoKeyPair.html b/interfaces/ec_shared.EcdsaCryptoKeyPair.html
index 41477ac..c9ed702 100644
--- a/interfaces/ec_shared.EcdsaCryptoKeyPair.html
+++ b/interfaces/ec_shared.EcdsaCryptoKeyPair.html
@@ -1 +1 @@
-EcdsaCryptoKeyPair | @nfen/webcrypto-ts
Interface ec/shared.EcdsaCryptoKeyPair
source · [−]
Properties
source
_ecdsaCryptoKeyPairBrand
source
_ecdsaCryptoKeyPairBrand: any

\ No newline at end of file
+EcdsaCryptoKeyPair | @nfen/webcrypto-ts
Interface ec/shared.EcdsaCryptoKeyPair
source · [−]
Properties
source
_ecdsaCryptoKeyPairBrand
source
_ecdsaCryptoKeyPairBrand: any

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdsaPrivCryptoKey.html b/interfaces/ec_shared.EcdsaPrivCryptoKey.html
index 3d78acd..88aba8b 100644
--- a/interfaces/ec_shared.EcdsaPrivCryptoKey.html
+++ b/interfaces/ec_shared.EcdsaPrivCryptoKey.html
@@ -1 +1 @@
-EcdsaPrivCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdsaPrivCryptoKey
source · [−]
Properties
source
_ecdsaPrivCryptoKeyBrand
source
_ecdsaPrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+EcdsaPrivCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdsaPrivCryptoKey
source · [−]
Properties
source
_ecdsaPrivCryptoKeyBrand
source
_ecdsaPrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdsaProxiedCryptoKeyPair.html b/interfaces/ec_shared.EcdsaProxiedCryptoKeyPair.html
index a2088b2..a87cc28 100644
--- a/interfaces/ec_shared.EcdsaProxiedCryptoKeyPair.html
+++ b/interfaces/ec_shared.EcdsaProxiedCryptoKeyPair.html
@@ -1 +1 @@
-EcdsaProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface ec/shared.EcdsaProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
+EcdsaProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface ec/shared.EcdsaProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdsaProxiedPrivCryptoKey.html b/interfaces/ec_shared.EcdsaProxiedPrivCryptoKey.html
index 64a1f2b..f8848ad 100644
--- a/interfaces/ec_shared.EcdsaProxiedPrivCryptoKey.html
+++ b/interfaces/ec_shared.EcdsaProxiedPrivCryptoKey.html
@@ -1 +1 @@
-EcdsaProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdsaProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(algorithm: Omit<EnforcedEcdsaParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
+EcdsaProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdsaProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(algorithm: Omit<EnforcedEcdsaParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdsaProxiedPubCryptoKey.html b/interfaces/ec_shared.EcdsaProxiedPubCryptoKey.html
index 825196f..b60d23b 100644
--- a/interfaces/ec_shared.EcdsaProxiedPubCryptoKey.html
+++ b/interfaces/ec_shared.EcdsaProxiedPubCryptoKey.html
@@ -1 +1 @@
-EcdsaProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdsaProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(algorithm: Omit<EnforcedEcdsaParams, "name">, signature: BufferSource, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
+EcdsaProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdsaProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(algorithm: Omit<EnforcedEcdsaParams, "name">, signature: BufferSource, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/ec_shared.EcdsaPubCryptoKey.html b/interfaces/ec_shared.EcdsaPubCryptoKey.html
index 43ce3d0..fc9f33c 100644
--- a/interfaces/ec_shared.EcdsaPubCryptoKey.html
+++ b/interfaces/ec_shared.EcdsaPubCryptoKey.html
@@ -1 +1 @@
-EcdsaPubCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdsaPubCryptoKey
source · [−]
Properties
source
_ecdsaPubCryptoKeyBrand
source
_ecdsaPubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+EcdsaPubCryptoKey | @nfen/webcrypto-ts
Interface ec/shared.EcdsaPubCryptoKey
source · [−]
Properties
source
_ecdsaPubCryptoKeyBrand
source
_ecdsaPubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/hmac.HmacCryptoKey.html b/interfaces/hmac.HmacCryptoKey.html
index 9b8ed64..bc5268f 100644
--- a/interfaces/hmac.HmacCryptoKey.html
+++ b/interfaces/hmac.HmacCryptoKey.html
@@ -1 +1 @@
-HmacCryptoKey | @nfen/webcrypto-ts
Interface hmac.HmacCryptoKey
source · [−]
Properties
source
_hmacKeyBrand
source
_hmacKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+HmacCryptoKey | @nfen/webcrypto-ts
Interface hmac.HmacCryptoKey
source · [−]
Properties
source
_hmacKeyBrand
source
_hmacKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/hmac.HmacProxiedCryptoKey.html b/interfaces/hmac.HmacProxiedCryptoKey.html
index 12caf68..1f7bad0 100644
--- a/interfaces/hmac.HmacProxiedCryptoKey.html
+++ b/interfaces/hmac.HmacProxiedCryptoKey.html
@@ -1 +1 @@
-HmacProxiedCryptoKey | @nfen/webcrypto-ts
Interface hmac.HmacProxiedCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(data: BufferSource): Promise<ArrayBuffer>
Parameters
  • data: BufferSource
Returns Promise<ArrayBuffer>
source
(signature: BufferSource, data: BufferSource): Promise<boolean>
Parameters
  • signature: BufferSource
  • data: BufferSource
Returns Promise<boolean>

\ No newline at end of file
+HmacProxiedCryptoKey | @nfen/webcrypto-ts
Interface hmac.HmacProxiedCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(data: BufferSource): Promise<ArrayBuffer>
Parameters
  • data: BufferSource
Returns Promise<ArrayBuffer>
source
(signature: BufferSource, data: BufferSource): Promise<boolean>
Parameters
  • signature: BufferSource
  • data: BufferSource
Returns Promise<boolean>

\ No newline at end of file
diff --git a/interfaces/kdf_shared.HkdfKeyMaterial.html b/interfaces/kdf_shared.HkdfKeyMaterial.html
index 59b42c0..e670a66 100644
--- a/interfaces/kdf_shared.HkdfKeyMaterial.html
+++ b/interfaces/kdf_shared.HkdfKeyMaterial.html
@@ -1 +1 @@
-HkdfKeyMaterial | @nfen/webcrypto-ts
Interface kdf/shared.HkdfKeyMaterial
source · [−]
Properties
source
_kkdfKeyMaterialBrand
source
_kkdfKeyMaterialBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+HkdfKeyMaterial | @nfen/webcrypto-ts
Interface kdf/shared.HkdfKeyMaterial
source · [−]
Properties
source
_kkdfKeyMaterialBrand
source
_kkdfKeyMaterialBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/kdf_shared.HkdfProxiedKeyMaterial.html b/interfaces/kdf_shared.HkdfProxiedKeyMaterial.html
index 2e880fc..9e80a5b 100644
--- a/interfaces/kdf_shared.HkdfProxiedKeyMaterial.html
+++ b/interfaces/kdf_shared.HkdfProxiedKeyMaterial.html
@@ -1 +1 @@
-HkdfProxiedKeyMaterial | @nfen/webcrypto-ts
Interface kdf/shared.HkdfProxiedKeyMaterial
source · [−]
Properties
Methods
deriveBits
source
(algorithm: Omit<EnforcedHkdfParams, "name">, length: number): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
deriveKey
source
(algorithm: Omit<EnforcedHkdfParams, "name">, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>
Parameters
Returns Promise<HmacCryptoKey | AesCryptoKeys>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>

\ No newline at end of file
+HkdfProxiedKeyMaterial | @nfen/webcrypto-ts
Interface kdf/shared.HkdfProxiedKeyMaterial
source · [−]
Properties
Methods
deriveBits
source
(algorithm: Omit<EnforcedHkdfParams, "name">, length: number): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
deriveKey
source
(algorithm: Omit<EnforcedHkdfParams, "name">, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>
Parameters
Returns Promise<HmacCryptoKey | AesCryptoKeys>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>

\ No newline at end of file
diff --git a/interfaces/kdf_shared.Pbkdf2KeyMaterial.html b/interfaces/kdf_shared.Pbkdf2KeyMaterial.html
index f88503b..8bd235c 100644
--- a/interfaces/kdf_shared.Pbkdf2KeyMaterial.html
+++ b/interfaces/kdf_shared.Pbkdf2KeyMaterial.html
@@ -1 +1 @@
-Pbkdf2KeyMaterial | @nfen/webcrypto-ts
Interface kdf/shared.Pbkdf2KeyMaterial
source · [−]
Properties
source
_pbkdf2KeyMaterialBrand
source
_pbkdf2KeyMaterialBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+Pbkdf2KeyMaterial | @nfen/webcrypto-ts
Interface kdf/shared.Pbkdf2KeyMaterial
source · [−]
Properties
source
_pbkdf2KeyMaterialBrand
source
_pbkdf2KeyMaterialBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/kdf_shared.Pbkdf2ProxiedKeyMaterial.html b/interfaces/kdf_shared.Pbkdf2ProxiedKeyMaterial.html
index cf8747e..3e0370c 100644
--- a/interfaces/kdf_shared.Pbkdf2ProxiedKeyMaterial.html
+++ b/interfaces/kdf_shared.Pbkdf2ProxiedKeyMaterial.html
@@ -1 +1 @@
-Pbkdf2ProxiedKeyMaterial | @nfen/webcrypto-ts
Interface kdf/shared.Pbkdf2ProxiedKeyMaterial
source · [−]
Properties
Methods
deriveBits
source
(algorithm: Omit<EnforcedPbkdf2Params, "iterations" | "name">, length: number): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
deriveKey
source
(algorithm: Omit<EnforcedPbkdf2Params, "iterations" | "name">, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>
Parameters
Returns Promise<HmacCryptoKey | AesCryptoKeys>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>

\ No newline at end of file
+Pbkdf2ProxiedKeyMaterial | @nfen/webcrypto-ts
Interface kdf/shared.Pbkdf2ProxiedKeyMaterial
source · [−]
Properties
Methods
deriveBits
source
(algorithm: Omit<EnforcedPbkdf2Params, "iterations" | "name">, length: number): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
deriveKey
source
(algorithm: Omit<EnforcedPbkdf2Params, "iterations" | "name">, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>
Parameters
Returns Promise<HmacCryptoKey | AesCryptoKeys>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>

\ No newline at end of file
diff --git a/interfaces/params.AesCbcKeyAlgorithm.html b/interfaces/params.AesCbcKeyAlgorithm.html
index 66cf8ef..02bce35 100644
--- a/interfaces/params.AesCbcKeyAlgorithm.html
+++ b/interfaces/params.AesCbcKeyAlgorithm.html
@@ -1 +1 @@
-AesCbcKeyAlgorithm | @nfen/webcrypto-ts
Interface params.AesCbcKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
+AesCbcKeyAlgorithm | @nfen/webcrypto-ts
Interface params.AesCbcKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.AesCtrKeyAlgorithm.html b/interfaces/params.AesCtrKeyAlgorithm.html
index 0ac56e9..22158a9 100644
--- a/interfaces/params.AesCtrKeyAlgorithm.html
+++ b/interfaces/params.AesCtrKeyAlgorithm.html
@@ -1 +1 @@
-AesCtrKeyAlgorithm | @nfen/webcrypto-ts
Interface params.AesCtrKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
+AesCtrKeyAlgorithm | @nfen/webcrypto-ts
Interface params.AesCtrKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.AesGcmKeyAlgorithm.html b/interfaces/params.AesGcmKeyAlgorithm.html
index bb6acba..10e8204 100644
--- a/interfaces/params.AesGcmKeyAlgorithm.html
+++ b/interfaces/params.AesGcmKeyAlgorithm.html
@@ -1 +1 @@
-AesGcmKeyAlgorithm | @nfen/webcrypto-ts
Interface params.AesGcmKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
+AesGcmKeyAlgorithm | @nfen/webcrypto-ts
Interface params.AesGcmKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.AesKwKeyAlgorithm.html b/interfaces/params.AesKwKeyAlgorithm.html
index 6bd82a0..d8cd4da 100644
--- a/interfaces/params.AesKwKeyAlgorithm.html
+++ b/interfaces/params.AesKwKeyAlgorithm.html
@@ -1 +1 @@
-AesKwKeyAlgorithm | @nfen/webcrypto-ts
Interface params.AesKwKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
+AesKwKeyAlgorithm | @nfen/webcrypto-ts
Interface params.AesKwKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedAesCbcParams.html b/interfaces/params.EnforcedAesCbcParams.html
index 96d9c87..6aa2dbf 100644
--- a/interfaces/params.EnforcedAesCbcParams.html
+++ b/interfaces/params.EnforcedAesCbcParams.html
@@ -1 +1 @@
-EnforcedAesCbcParams | @nfen/webcrypto-ts
Interface params.EnforcedAesCbcParams
source · [−]
Properties
iv
iv: BufferSource

\ No newline at end of file
+EnforcedAesCbcParams | @nfen/webcrypto-ts
Interface params.EnforcedAesCbcParams
source · [−]
Properties
iv
iv: BufferSource

\ No newline at end of file
diff --git a/interfaces/params.EnforcedAesCtrParams.html b/interfaces/params.EnforcedAesCtrParams.html
index be66010..aa93a60 100644
--- a/interfaces/params.EnforcedAesCtrParams.html
+++ b/interfaces/params.EnforcedAesCtrParams.html
@@ -1 +1 @@
-EnforcedAesCtrParams | @nfen/webcrypto-ts
Interface params.EnforcedAesCtrParams
source · [−]
Properties
counter
counter: BufferSource
length
length: number

\ No newline at end of file
+EnforcedAesCtrParams | @nfen/webcrypto-ts
Interface params.EnforcedAesCtrParams
source · [−]
Properties
counter
counter: BufferSource
length
length: number

\ No newline at end of file
diff --git a/interfaces/params.EnforcedAesGcmParams.html b/interfaces/params.EnforcedAesGcmParams.html
index 44bb2f9..d159714 100644
--- a/interfaces/params.EnforcedAesGcmParams.html
+++ b/interfaces/params.EnforcedAesGcmParams.html
@@ -1 +1 @@
-EnforcedAesGcmParams | @nfen/webcrypto-ts
Interface params.EnforcedAesGcmParams
source · [−]
Properties
additionalData
additionalData?: BufferSource
iv
iv: BufferSource
name
name: string

\ No newline at end of file
+EnforcedAesGcmParams | @nfen/webcrypto-ts
Interface params.EnforcedAesGcmParams
source · [−]
Properties
additionalData
additionalData?: BufferSource
iv
iv: BufferSource
name
name: string

\ No newline at end of file
diff --git a/interfaces/params.EnforcedAesKeyGenParams.html b/interfaces/params.EnforcedAesKeyGenParams.html
index d77d3e4..4762fbd 100644
--- a/interfaces/params.EnforcedAesKeyGenParams.html
+++ b/interfaces/params.EnforcedAesKeyGenParams.html
@@ -1 +1 @@
-EnforcedAesKeyGenParams | @nfen/webcrypto-ts
Interface params.EnforcedAesKeyGenParams
source · [−]
Properties

\ No newline at end of file
+EnforcedAesKeyGenParams | @nfen/webcrypto-ts
Interface params.EnforcedAesKeyGenParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedAesKwParams.html b/interfaces/params.EnforcedAesKwParams.html
index 28b10b6..1f6d77a 100644
--- a/interfaces/params.EnforcedAesKwParams.html
+++ b/interfaces/params.EnforcedAesKwParams.html
@@ -1 +1 @@
-EnforcedAesKwParams | @nfen/webcrypto-ts
Interface params.EnforcedAesKwParams
source · [−]
Properties

\ No newline at end of file
+EnforcedAesKwParams | @nfen/webcrypto-ts
Interface params.EnforcedAesKwParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedEcKeyGenParams.html b/interfaces/params.EnforcedEcKeyGenParams.html
index 9de52c8..cb85020 100644
--- a/interfaces/params.EnforcedEcKeyGenParams.html
+++ b/interfaces/params.EnforcedEcKeyGenParams.html
@@ -1 +1 @@
-EnforcedEcKeyGenParams | @nfen/webcrypto-ts
Interface params.EnforcedEcKeyGenParams
source · [−]
Properties

\ No newline at end of file
+EnforcedEcKeyGenParams | @nfen/webcrypto-ts
Interface params.EnforcedEcKeyGenParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedEcKeyImportParams.html b/interfaces/params.EnforcedEcKeyImportParams.html
index 8e27679..17be9a7 100644
--- a/interfaces/params.EnforcedEcKeyImportParams.html
+++ b/interfaces/params.EnforcedEcKeyImportParams.html
@@ -1 +1 @@
-EnforcedEcKeyImportParams | @nfen/webcrypto-ts
Interface params.EnforcedEcKeyImportParams
source · [−]
Properties

\ No newline at end of file
+EnforcedEcKeyImportParams | @nfen/webcrypto-ts
Interface params.EnforcedEcKeyImportParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedEcdhKeyDeriveParams.html b/interfaces/params.EnforcedEcdhKeyDeriveParams.html
index 85f9c6c..1f68a11 100644
--- a/interfaces/params.EnforcedEcdhKeyDeriveParams.html
+++ b/interfaces/params.EnforcedEcdhKeyDeriveParams.html
@@ -1 +1 @@
-EnforcedEcdhKeyDeriveParams | @nfen/webcrypto-ts
Interface params.EnforcedEcdhKeyDeriveParams
source · [−]
Properties

\ No newline at end of file
+EnforcedEcdhKeyDeriveParams | @nfen/webcrypto-ts
Interface params.EnforcedEcdhKeyDeriveParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedEcdsaParams.html b/interfaces/params.EnforcedEcdsaParams.html
index 8314ef3..8a57b30 100644
--- a/interfaces/params.EnforcedEcdsaParams.html
+++ b/interfaces/params.EnforcedEcdsaParams.html
@@ -1 +1 @@
-EnforcedEcdsaParams | @nfen/webcrypto-ts
Interface params.EnforcedEcdsaParams
source · [−]
Properties

\ No newline at end of file
+EnforcedEcdsaParams | @nfen/webcrypto-ts
Interface params.EnforcedEcdsaParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedHkdfParams.html b/interfaces/params.EnforcedHkdfParams.html
index f5019d1..81da729 100644
--- a/interfaces/params.EnforcedHkdfParams.html
+++ b/interfaces/params.EnforcedHkdfParams.html
@@ -1 +1 @@
-EnforcedHkdfParams | @nfen/webcrypto-ts
Interface params.EnforcedHkdfParams
source · [−]
Properties
info
info: BufferSource
salt
salt: BufferSource

\ No newline at end of file
+EnforcedHkdfParams | @nfen/webcrypto-ts
Interface params.EnforcedHkdfParams
source · [−]
Properties
info
info: BufferSource
salt
salt: BufferSource

\ No newline at end of file
diff --git a/interfaces/params.EnforcedHmacImportParams.html b/interfaces/params.EnforcedHmacImportParams.html
index 1161a60..4a4b549 100644
--- a/interfaces/params.EnforcedHmacImportParams.html
+++ b/interfaces/params.EnforcedHmacImportParams.html
@@ -1 +1 @@
-EnforcedHmacImportParams | @nfen/webcrypto-ts
Interface params.EnforcedHmacImportParams
source · [−]
Properties

\ No newline at end of file
+EnforcedHmacImportParams | @nfen/webcrypto-ts
Interface params.EnforcedHmacImportParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedHmacKeyGenParams.html b/interfaces/params.EnforcedHmacKeyGenParams.html
index 935f47a..e415673 100644
--- a/interfaces/params.EnforcedHmacKeyGenParams.html
+++ b/interfaces/params.EnforcedHmacKeyGenParams.html
@@ -1 +1 @@
-EnforcedHmacKeyGenParams | @nfen/webcrypto-ts
Interface params.EnforcedHmacKeyGenParams
source · [−]
Properties

\ No newline at end of file
+EnforcedHmacKeyGenParams | @nfen/webcrypto-ts
Interface params.EnforcedHmacKeyGenParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedPbkdf2Params.html b/interfaces/params.EnforcedPbkdf2Params.html
index c1b6127..6b023fd 100644
--- a/interfaces/params.EnforcedPbkdf2Params.html
+++ b/interfaces/params.EnforcedPbkdf2Params.html
@@ -1 +1 @@
-EnforcedPbkdf2Params | @nfen/webcrypto-ts
Interface params.EnforcedPbkdf2Params
source · [−]
Properties
salt
salt: BufferSource

\ No newline at end of file
+EnforcedPbkdf2Params | @nfen/webcrypto-ts
Interface params.EnforcedPbkdf2Params
source · [−]
Properties
salt
salt: BufferSource

\ No newline at end of file
diff --git a/interfaces/params.EnforcedRsaHashedImportParams.html b/interfaces/params.EnforcedRsaHashedImportParams.html
index 8252ddd..dbd78e3 100644
--- a/interfaces/params.EnforcedRsaHashedImportParams.html
+++ b/interfaces/params.EnforcedRsaHashedImportParams.html
@@ -1 +1 @@
-EnforcedRsaHashedImportParams | @nfen/webcrypto-ts
Interface params.EnforcedRsaHashedImportParams
source · [−]
Properties

\ No newline at end of file
+EnforcedRsaHashedImportParams | @nfen/webcrypto-ts
Interface params.EnforcedRsaHashedImportParams
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.EnforcedRsaHashedKeyGenParams.html b/interfaces/params.EnforcedRsaHashedKeyGenParams.html
index d55ad2d..91dd5ed 100644
--- a/interfaces/params.EnforcedRsaHashedKeyGenParams.html
+++ b/interfaces/params.EnforcedRsaHashedKeyGenParams.html
@@ -1 +1 @@
-EnforcedRsaHashedKeyGenParams | @nfen/webcrypto-ts
Interface params.EnforcedRsaHashedKeyGenParams
source · [−]
Properties
publicExponent
publicExponent: Uint8Array

\ No newline at end of file
+EnforcedRsaHashedKeyGenParams | @nfen/webcrypto-ts
Interface params.EnforcedRsaHashedKeyGenParams
source · [−]
Properties
publicExponent
publicExponent: Uint8Array

\ No newline at end of file
diff --git a/interfaces/params.EnforcedRsaOaepParams.html b/interfaces/params.EnforcedRsaOaepParams.html
index f0649ce..98c8240 100644
--- a/interfaces/params.EnforcedRsaOaepParams.html
+++ b/interfaces/params.EnforcedRsaOaepParams.html
@@ -1 +1 @@
-EnforcedRsaOaepParams | @nfen/webcrypto-ts
Interface params.EnforcedRsaOaepParams
source · [−]
Properties
label
label?: BufferSource

\ No newline at end of file
+EnforcedRsaOaepParams | @nfen/webcrypto-ts
Interface params.EnforcedRsaOaepParams
source · [−]
Properties
label
label?: BufferSource

\ No newline at end of file
diff --git a/interfaces/params.EnforcedRsaPssParams.html b/interfaces/params.EnforcedRsaPssParams.html
index 438bb59..ec9a08a 100644
--- a/interfaces/params.EnforcedRsaPssParams.html
+++ b/interfaces/params.EnforcedRsaPssParams.html
@@ -1 +1 @@
-EnforcedRsaPssParams | @nfen/webcrypto-ts
Interface params.EnforcedRsaPssParams
source · [−]
Properties
saltLength
saltLength: number

\ No newline at end of file
+EnforcedRsaPssParams | @nfen/webcrypto-ts
Interface params.EnforcedRsaPssParams
source · [−]
Properties
saltLength
saltLength: number

\ No newline at end of file
diff --git a/interfaces/params.EnforcedRsassaPkcs1v15Params.html b/interfaces/params.EnforcedRsassaPkcs1v15Params.html
index 5b2e234..03b8550 100644
--- a/interfaces/params.EnforcedRsassaPkcs1v15Params.html
+++ b/interfaces/params.EnforcedRsassaPkcs1v15Params.html
@@ -1 +1 @@
-EnforcedRsassaPkcs1v15Params | @nfen/webcrypto-ts
Interface params.EnforcedRsassaPkcs1v15Params
source · [−]
Properties

\ No newline at end of file
+EnforcedRsassaPkcs1v15Params | @nfen/webcrypto-ts
Interface params.EnforcedRsassaPkcs1v15Params
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/params.HmacKeyAlgorithm.html b/interfaces/params.HmacKeyAlgorithm.html
index c4d7bfa..ac2ddc7 100644
--- a/interfaces/params.HmacKeyAlgorithm.html
+++ b/interfaces/params.HmacKeyAlgorithm.html
@@ -1 +1 @@
-HmacKeyAlgorithm | @nfen/webcrypto-ts
Interface params.HmacKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
+HmacKeyAlgorithm | @nfen/webcrypto-ts
Interface params.HmacKeyAlgorithm
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/proxy.ProxiedCryptoKey.html b/interfaces/proxy.ProxiedCryptoKey.html
index 79779b5..e8c8cef 100644
--- a/interfaces/proxy.ProxiedCryptoKey.html
+++ b/interfaces/proxy.ProxiedCryptoKey.html
@@ -1 +1 @@
-ProxiedCryptoKey | @nfen/webcrypto-ts
Interface proxy.ProxiedCryptoKey
source · [−]
Properties

\ No newline at end of file
+ProxiedCryptoKey | @nfen/webcrypto-ts
Interface proxy.ProxiedCryptoKey
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/proxy.ProxiedCryptoKeyPair.html b/interfaces/proxy.ProxiedCryptoKeyPair.html
index 701448c..79b4d1f 100644
--- a/interfaces/proxy.ProxiedCryptoKeyPair.html
+++ b/interfaces/proxy.ProxiedCryptoKeyPair.html
@@ -1 +1 @@
-ProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface proxy.ProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
+ProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface proxy.ProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/proxy.ProxyKeyPairHandlers.html b/interfaces/proxy.ProxyKeyPairHandlers.html
index ace619a..fec565a 100644
--- a/interfaces/proxy.ProxyKeyPairHandlers.html
+++ b/interfaces/proxy.ProxyKeyPairHandlers.html
@@ -1 +1 @@
-ProxyKeyPairHandlers | @nfen/webcrypto-ts
Interface proxy.ProxyKeyPairHandlers
source · [−]
Properties

\ No newline at end of file
+ProxyKeyPairHandlers | @nfen/webcrypto-ts
Interface proxy.ProxyKeyPairHandlers
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaOaepCryptoKeyPair.html b/interfaces/rsa_shared.RsaOaepCryptoKeyPair.html
index 85ece34..2431d00 100644
--- a/interfaces/rsa_shared.RsaOaepCryptoKeyPair.html
+++ b/interfaces/rsa_shared.RsaOaepCryptoKeyPair.html
@@ -1 +1 @@
-RsaOaepCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepCryptoKeyPair
source · [−]
Properties
source
_rsaOaepCryptoKeyPairBrand
source
_rsaOaepCryptoKeyPairBrand: any

\ No newline at end of file
+RsaOaepCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepCryptoKeyPair
source · [−]
Properties
source
_rsaOaepCryptoKeyPairBrand
source
_rsaOaepCryptoKeyPairBrand: any

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaOaepPrivCryptoKey.html b/interfaces/rsa_shared.RsaOaepPrivCryptoKey.html
index eb21514..7bb9a50 100644
--- a/interfaces/rsa_shared.RsaOaepPrivCryptoKey.html
+++ b/interfaces/rsa_shared.RsaOaepPrivCryptoKey.html
@@ -1 +1 @@
-RsaOaepPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepPrivCryptoKey
source · [−]
Properties
source
_rsaOaepPrivCryptoKeyBrand
source
_rsaOaepPrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+RsaOaepPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepPrivCryptoKey
source · [−]
Properties
source
_rsaOaepPrivCryptoKeyBrand
source
_rsaOaepPrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaOaepProxiedCryptoKeyPair.html b/interfaces/rsa_shared.RsaOaepProxiedCryptoKeyPair.html
index 93f51a2..40fba3e 100644
--- a/interfaces/rsa_shared.RsaOaepProxiedCryptoKeyPair.html
+++ b/interfaces/rsa_shared.RsaOaepProxiedCryptoKeyPair.html
@@ -1 +1 @@
-RsaOaepProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
+RsaOaepProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaOaepProxiedPrivCryptoKey.html b/interfaces/rsa_shared.RsaOaepProxiedPrivCryptoKey.html
index 214e80b..ad43873 100644
--- a/interfaces/rsa_shared.RsaOaepProxiedPrivCryptoKey.html
+++ b/interfaces/rsa_shared.RsaOaepProxiedPrivCryptoKey.html
@@ -1 +1 @@
-RsaOaepProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(algorithm: Omit<EnforcedRsaOaepParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKeyAlgorithm: Omit<EnforcedRsaOaepParams, "name">, extractable?: boolean, keyUsages?: KeyUsagePairs): Promise<CryptoKey>
Parameters
Returns Promise<CryptoKey>

\ No newline at end of file
+RsaOaepProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(algorithm: Omit<EnforcedRsaOaepParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKeyAlgorithm: Omit<EnforcedRsaOaepParams, "name">, extractable?: boolean, keyUsages?: KeyUsagePairs): Promise<CryptoKey>
Parameters
Returns Promise<CryptoKey>

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaOaepProxiedPubCryptoKey.html b/interfaces/rsa_shared.RsaOaepProxiedPubCryptoKey.html
index f5a13b6..32ca297 100644
--- a/interfaces/rsa_shared.RsaOaepProxiedPubCryptoKey.html
+++ b/interfaces/rsa_shared.RsaOaepProxiedPubCryptoKey.html
@@ -1 +1 @@
-RsaOaepProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(algorithm: Omit<EnforcedRsaOaepParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(format: KeyFormat, key: CryptoKey, wrapAlgorithm?: Omit<EnforcedRsaOaepParams, "name">): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
+RsaOaepProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(algorithm: Omit<EnforcedRsaOaepParams, "name">, data: BufferSource): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(format: KeyFormat, key: CryptoKey, wrapAlgorithm?: Omit<EnforcedRsaOaepParams, "name">): Promise<ArrayBuffer>
Parameters
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaOaepPubCryptoKey.html b/interfaces/rsa_shared.RsaOaepPubCryptoKey.html
index ae2ed68..1a4707c 100644
--- a/interfaces/rsa_shared.RsaOaepPubCryptoKey.html
+++ b/interfaces/rsa_shared.RsaOaepPubCryptoKey.html
@@ -1 +1 @@
-RsaOaepPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepPubCryptoKey
source · [−]
Properties
source
_rsaOaepPubCryptoKeyBrand
source
_rsaOaepPubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+RsaOaepPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaOaepPubCryptoKey
source · [−]
Properties
source
_rsaOaepPubCryptoKeyBrand
source
_rsaOaepPubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaPssCryptoKeyPair.html b/interfaces/rsa_shared.RsaPssCryptoKeyPair.html
index ac011ae..f8ea4b5 100644
--- a/interfaces/rsa_shared.RsaPssCryptoKeyPair.html
+++ b/interfaces/rsa_shared.RsaPssCryptoKeyPair.html
@@ -1 +1 @@
-RsaPssCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssCryptoKeyPair
source · [−]
Properties
source
_rsaPssCryptoKeyPairBrand
source
_rsaPssCryptoKeyPairBrand: any

\ No newline at end of file
+RsaPssCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssCryptoKeyPair
source · [−]
Properties
source
_rsaPssCryptoKeyPairBrand
source
_rsaPssCryptoKeyPairBrand: any

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaPssPrivCryptoKey.html b/interfaces/rsa_shared.RsaPssPrivCryptoKey.html
index 8abd769..dc15f44 100644
--- a/interfaces/rsa_shared.RsaPssPrivCryptoKey.html
+++ b/interfaces/rsa_shared.RsaPssPrivCryptoKey.html
@@ -1 +1 @@
-RsaPssPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssPrivCryptoKey
source · [−]
Properties
source
_rsaPssPrivCryptoKeyBrand
source
_rsaPssPrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+RsaPssPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssPrivCryptoKey
source · [−]
Properties
source
_rsaPssPrivCryptoKeyBrand
source
_rsaPssPrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaPssProxiedCryptoKeyPair.html b/interfaces/rsa_shared.RsaPssProxiedCryptoKeyPair.html
index f5e15b4..7edf336 100644
--- a/interfaces/rsa_shared.RsaPssProxiedCryptoKeyPair.html
+++ b/interfaces/rsa_shared.RsaPssProxiedCryptoKeyPair.html
@@ -1 +1 @@
-RsaPssProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
+RsaPssProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaPssProxiedPrivCryptoKey.html b/interfaces/rsa_shared.RsaPssProxiedPrivCryptoKey.html
index 12076dd..e807bcd 100644
--- a/interfaces/rsa_shared.RsaPssProxiedPrivCryptoKey.html
+++ b/interfaces/rsa_shared.RsaPssProxiedPrivCryptoKey.html
@@ -1 +1 @@
-RsaPssProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(saltLength: number, data: BufferSource): Promise<ArrayBuffer>
Parameters
  • saltLength: number
  • data: BufferSource
Returns Promise<ArrayBuffer>

\ No newline at end of file
+RsaPssProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(saltLength: number, data: BufferSource): Promise<ArrayBuffer>
Parameters
  • saltLength: number
  • data: BufferSource
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaPssProxiedPubCryptoKey.html b/interfaces/rsa_shared.RsaPssProxiedPubCryptoKey.html
index 58ca913..cbcb4d9 100644
--- a/interfaces/rsa_shared.RsaPssProxiedPubCryptoKey.html
+++ b/interfaces/rsa_shared.RsaPssProxiedPubCryptoKey.html
@@ -1 +1 @@
-RsaPssProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(saltLength: number, signature: BufferSource, data: BufferSource): Promise<boolean>
Parameters
  • saltLength: number
  • signature: BufferSource
  • data: BufferSource
Returns Promise<boolean>

\ No newline at end of file
+RsaPssProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(saltLength: number, signature: BufferSource, data: BufferSource): Promise<boolean>
Parameters
  • saltLength: number
  • signature: BufferSource
  • data: BufferSource
Returns Promise<boolean>

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsaPssPubCryptoKey.html b/interfaces/rsa_shared.RsaPssPubCryptoKey.html
index 05fe449..d51a139 100644
--- a/interfaces/rsa_shared.RsaPssPubCryptoKey.html
+++ b/interfaces/rsa_shared.RsaPssPubCryptoKey.html
@@ -1 +1 @@
-RsaPssPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssPubCryptoKey
source · [−]
Properties
source
_rsaPssPubCryptoKeyBrand
source
_rsaPssPubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+RsaPssPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsaPssPubCryptoKey
source · [−]
Properties
source
_rsaPssPubCryptoKeyBrand
source
_rsaPssPubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsassaPkcs1V15CryptoKeyPair.html b/interfaces/rsa_shared.RsassaPkcs1V15CryptoKeyPair.html
index 535345d..f48bed8 100644
--- a/interfaces/rsa_shared.RsassaPkcs1V15CryptoKeyPair.html
+++ b/interfaces/rsa_shared.RsassaPkcs1V15CryptoKeyPair.html
@@ -1 +1 @@
-RsassaPkcs1V15CryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15CryptoKeyPair
source · [−]
Properties
source
_rsassaPkcs1V15CryptoKeyBrand
source
_rsassaPkcs1V15CryptoKeyBrand: any

\ No newline at end of file
+RsassaPkcs1V15CryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15CryptoKeyPair
source · [−]
Properties
source
_rsassaPkcs1V15CryptoKeyBrand
source
_rsassaPkcs1V15CryptoKeyBrand: any

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsassaPkcs1V15PrivCryptoKey.html b/interfaces/rsa_shared.RsassaPkcs1V15PrivCryptoKey.html
index 15bcf14..5f0db0d 100644
--- a/interfaces/rsa_shared.RsassaPkcs1V15PrivCryptoKey.html
+++ b/interfaces/rsa_shared.RsassaPkcs1V15PrivCryptoKey.html
@@ -1 +1 @@
-RsassaPkcs1V15PrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15PrivCryptoKey
source · [−]
Properties
source
_rsassaPkcs1V15PrivCryptoKeyBrand
source
_rsassaPkcs1V15PrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+RsassaPkcs1V15PrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15PrivCryptoKey
source · [−]
Properties
source
_rsassaPkcs1V15PrivCryptoKeyBrand
source
_rsassaPkcs1V15PrivCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsassaPkcs1V15ProxiedCryptoKeyPair.html b/interfaces/rsa_shared.RsassaPkcs1V15ProxiedCryptoKeyPair.html
index 7e773a8..1befb70 100644
--- a/interfaces/rsa_shared.RsassaPkcs1V15ProxiedCryptoKeyPair.html
+++ b/interfaces/rsa_shared.RsassaPkcs1V15ProxiedCryptoKeyPair.html
@@ -1 +1 @@
-RsassaPkcs1V15ProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15ProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
+RsassaPkcs1V15ProxiedCryptoKeyPair | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15ProxiedCryptoKeyPair
source · [−]
Properties

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsassaPkcs1V15ProxiedPrivCryptoKey.html b/interfaces/rsa_shared.RsassaPkcs1V15ProxiedPrivCryptoKey.html
index a9a76d2..a8fe8a6 100644
--- a/interfaces/rsa_shared.RsassaPkcs1V15ProxiedPrivCryptoKey.html
+++ b/interfaces/rsa_shared.RsassaPkcs1V15ProxiedPrivCryptoKey.html
@@ -1 +1 @@
-RsassaPkcs1V15ProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15ProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(data: BufferSource): Promise<ArrayBuffer>
Parameters
  • data: BufferSource
Returns Promise<ArrayBuffer>

\ No newline at end of file
+RsassaPkcs1V15ProxiedPrivCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15ProxiedPrivCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(data: BufferSource): Promise<ArrayBuffer>
Parameters
  • data: BufferSource
Returns Promise<ArrayBuffer>

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsassaPkcs1V15ProxiedPubCryptoKey.html b/interfaces/rsa_shared.RsassaPkcs1V15ProxiedPubCryptoKey.html
index fefcacc..6bd05bd 100644
--- a/interfaces/rsa_shared.RsassaPkcs1V15ProxiedPubCryptoKey.html
+++ b/interfaces/rsa_shared.RsassaPkcs1V15ProxiedPubCryptoKey.html
@@ -1 +1 @@
-RsassaPkcs1V15ProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15ProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(signature: BufferSource, data: BufferSource): Promise<boolean>
Parameters
  • signature: BufferSource
  • data: BufferSource
Returns Promise<boolean>

\ No newline at end of file
+RsassaPkcs1V15ProxiedPubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15ProxiedPubCryptoKey
source · [−]
Properties
Methods
source
(format: KeyFormat): Promise<ArrayBuffer | JsonWebKey>
Parameters
  • format: KeyFormat
Returns Promise<ArrayBuffer | JsonWebKey>
source
(signature: BufferSource, data: BufferSource): Promise<boolean>
Parameters
  • signature: BufferSource
  • data: BufferSource
Returns Promise<boolean>

\ No newline at end of file
diff --git a/interfaces/rsa_shared.RsassaPkcs1V15PubCryptoKey.html b/interfaces/rsa_shared.RsassaPkcs1V15PubCryptoKey.html
index 897913c..59a2c33 100644
--- a/interfaces/rsa_shared.RsassaPkcs1V15PubCryptoKey.html
+++ b/interfaces/rsa_shared.RsassaPkcs1V15PubCryptoKey.html
@@ -1 +1 @@
-RsassaPkcs1V15PubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15PubCryptoKey
source · [−]
Properties
source
_rsassaPkcs1V15PubCryptoKeyBrand
source
_rsassaPkcs1V15PubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
+RsassaPkcs1V15PubCryptoKey | @nfen/webcrypto-ts
Interface rsa/shared.RsassaPkcs1V15PubCryptoKey
source · [−]
Properties
source
_rsassaPkcs1V15PubCryptoKeyBrand
source
_rsassaPkcs1V15PubCryptoKeyBrand: any
algorithm
algorithm: KeyAlgorithm
extractable
extractable: boolean
type
type: KeyType
usages
usages: KeyUsage[]

\ No newline at end of file
diff --git a/interfaces/sha_shared.Sha1ArrayBuffer.html b/interfaces/sha_shared.Sha1ArrayBuffer.html
index adf5b3d..3d291a1 100644
--- a/interfaces/sha_shared.Sha1ArrayBuffer.html
+++ b/interfaces/sha_shared.Sha1ArrayBuffer.html
@@ -1,4 +1,4 @@
-Sha1ArrayBuffer | @nfen/webcrypto-ts
Interface sha/shared.Sha1ArrayBuffer
source · [−]
Properties
[toStringTag]
[toStringTag]: string
source
_sha1ArrayBufferBrand
source
_sha1ArrayBufferBrand: any
byteLength
byteLength: number

+Sha1ArrayBuffer | @nfen/webcrypto-ts
Interface sha/shared.Sha1ArrayBuffer
source · [−]
Properties
[toStringTag]
[toStringTag]: string
source
_sha1ArrayBufferBrand
source
_sha1ArrayBufferBrand: any
byteLength
byteLength: number

 
Read-only. The length of the ArrayBuffer (in bytes).

 
Methods
slice
(begin: number, end?: number): ArrayBuffer

 
Returns a section of an ArrayBuffer.

diff --git a/interfaces/sha_shared.Sha256ArrayBuffer.html b/interfaces/sha_shared.Sha256ArrayBuffer.html
index f8f733e..947a9fb 100644
--- a/interfaces/sha_shared.Sha256ArrayBuffer.html
+++ b/interfaces/sha_shared.Sha256ArrayBuffer.html
@@ -1,4 +1,4 @@
-Sha256ArrayBuffer | @nfen/webcrypto-ts
Interface sha/shared.Sha256ArrayBuffer
source · [−]
Properties
[toStringTag]
[toStringTag]: string
source
_sha256ArrayBufferBrand
source
_sha256ArrayBufferBrand: any
byteLength
byteLength: number

+Sha256ArrayBuffer | @nfen/webcrypto-ts
Interface sha/shared.Sha256ArrayBuffer
source · [−]
Properties
[toStringTag]
[toStringTag]: string
source
_sha256ArrayBufferBrand
source
_sha256ArrayBufferBrand: any
byteLength
byteLength: number

 
Read-only. The length of the ArrayBuffer (in bytes).

 
Methods
slice
(begin: number, end?: number): ArrayBuffer

 
Returns a section of an ArrayBuffer.

diff --git a/interfaces/sha_shared.Sha384ArrayBuffer.html b/interfaces/sha_shared.Sha384ArrayBuffer.html
index b2d98aa..ad9bab8 100644
--- a/interfaces/sha_shared.Sha384ArrayBuffer.html
+++ b/interfaces/sha_shared.Sha384ArrayBuffer.html
@@ -1,4 +1,4 @@
-Sha384ArrayBuffer | @nfen/webcrypto-ts
Interface sha/shared.Sha384ArrayBuffer
source · [−]
Properties
[toStringTag]
[toStringTag]: string
source
_sha384ArrayBufferBrand
source
_sha384ArrayBufferBrand: any
byteLength
byteLength: number

+Sha384ArrayBuffer | @nfen/webcrypto-ts
Interface sha/shared.Sha384ArrayBuffer
source · [−]
Properties
[toStringTag]
[toStringTag]: string
source
_sha384ArrayBufferBrand
source
_sha384ArrayBufferBrand: any
byteLength
byteLength: number

 
Read-only. The length of the ArrayBuffer (in bytes).

 
Methods
slice
(begin: number, end?: number): ArrayBuffer

 
Returns a section of an ArrayBuffer.

diff --git a/interfaces/sha_shared.Sha512ArrayBuffer.html b/interfaces/sha_shared.Sha512ArrayBuffer.html
index dbd436a..44d1070 100644
--- a/interfaces/sha_shared.Sha512ArrayBuffer.html
+++ b/interfaces/sha_shared.Sha512ArrayBuffer.html
@@ -1,4 +1,4 @@
-Sha512ArrayBuffer | @nfen/webcrypto-ts
Interface sha/shared.Sha512ArrayBuffer
source · [−]
Properties
[toStringTag]
[toStringTag]: string
source
_sha512ArrayBufferBrand
source
_sha512ArrayBufferBrand: any
byteLength
byteLength: number

+Sha512ArrayBuffer | @nfen/webcrypto-ts
Interface sha/shared.Sha512ArrayBuffer
source · [−]
Properties
[toStringTag]
[toStringTag]: string
source
_sha512ArrayBufferBrand
source
_sha512ArrayBufferBrand: any
byteLength
byteLength: number

 
Read-only. The length of the ArrayBuffer (in bytes).

 
Methods
slice
(begin: number, end?: number): ArrayBuffer

 
Returns a section of an ArrayBuffer.

diff --git a/modules.html b/modules.html
index e7af111..e161da3 100644
--- a/modules.html
+++ b/modules.html
@@ -1,4 +1,4 @@
-@nfen/webcrypto-ts
 @nfen/webcrypto-ts
[−]
Modules
aes
All AES related modes and functions

+@nfen/webcrypto-ts
 @nfen/webcrypto-ts
[−]
Modules
aes
All AES related modes and functions

 
aes/aes_cbc
Code related to AES_CBC mode

 
aes/aes_ctr
Code related to AES_CTR mode

 
aes/aes_gcm
Code related to AES_GCM mode

diff --git a/modules/aes.html b/modules/aes.html
index 95b5fcd..2e19c5a 100644
--- a/modules/aes.html
+++ b/modules/aes.html
@@ -1,3 +1,3 @@
-aes | @nfen/webcrypto-ts
Module aes
source · [−]
Expand description

+aes | @nfen/webcrypto-ts
Module aes
source · [−]
Expand description

 
All AES related modes and functions

-
References
Renames and re-exports aes/aes_cbc
Renames and re-exports aes/aes_ctr
Renames and re-exports aes/aes_gcm
Renames and re-exports aes/aes_kw
Re-exports AesCbcCryptoKey
Re-exports AesCbcProxiedCryptoKey
Re-exports AesCryptoKeys
Re-exports AesCtrCryptoKey
Re-exports AesCtrProxiedCryptoKey
Re-exports AesGcmCryptoKey
Re-exports AesGcmProxiedCryptoKey
Re-exports AesKwCryptoKey
Re-exports AesKwProxiedCryptoKey
Re-exports Alg

\ No newline at end of file
+
References
Renames and re-exports aes/aes_cbc
Renames and re-exports aes/aes_ctr
Renames and re-exports aes/aes_gcm
Renames and re-exports aes/aes_kw
Re-exports AesCbcCryptoKey
Re-exports AesCbcProxiedCryptoKey
Re-exports AesCryptoKeys
Re-exports AesCtrCryptoKey
Re-exports AesCtrProxiedCryptoKey
Re-exports AesGcmCryptoKey
Re-exports AesGcmProxiedCryptoKey
Re-exports AesKwCryptoKey
Re-exports AesKwProxiedCryptoKey
Re-exports Alg

\ No newline at end of file
diff --git a/modules/aes_aes_cbc.html b/modules/aes_aes_cbc.html
index e3d21b6..c4a8cb4 100644
--- a/modules/aes_aes_cbc.html
+++ b/modules/aes_aes_cbc.html
@@ -1,40 +1,40 @@
-aes/aes_cbc | @nfen/webcrypto-ts
Module aes/aes_cbc
source · [−]
Expand description

+aes/aes_cbc | @nfen/webcrypto-ts
Module aes/aes_cbc
source · [−]
Expand description

 
Code related to AES_CBC mode

-
Functions
source
(algorithm: Omit<EnforcedAesCbcParams, "name">, key: AesCbcCryptoKey, data: BufferSource): Promise<ArrayBuffer>

+
Functions
source
(algorithm: Omit<EnforcedAesCbcParams, "name">, key: AesCbcCryptoKey, data: BufferSource): Promise<ArrayBuffer>

 
Decrypt data with an AES_CBC key

 
example
const plaintextBytes = await AES_CBC.decrypt(
   { iv },
   key.self,
   ciphertextBytes
);
 

 
example
const plaintextBytes = await key.decrypt(
   { iv },
   ciphertextBytes
);
 

-
Parameters
Returns Promise<ArrayBuffer>
source
(algorithm: Omit<EnforcedAesCbcParams, "name">, key: AesCbcCryptoKey, data: BufferSource): Promise<ArrayBuffer>

+
Parameters
Returns Promise<ArrayBuffer>
source
(algorithm: Omit<EnforcedAesCbcParams, "name">, key: AesCbcCryptoKey, data: BufferSource): Promise<ArrayBuffer>

 
Encrypt payload with an AES_CBC key

 
example
const key = await AES_CBC.generateKey();
const iv = await IV.generate();
const ciphertextBytes = await AES_CBC.encrypt(
    { iv },
   key.self,
   new TextEncoder().encode('message')
);
 

 
example
const key = await AES_CBC.generateKey();
const iv = await IV.generate();
const ciphertextBytes = await key.encrypt(
    { iv },
   new TextEncoder().encode('message')
);
 

-
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat, key: AesCbcCryptoKey): Promise<ArrayBuffer | JsonWebKey>

+
Parameters
Returns Promise<ArrayBuffer>
source
(format: KeyFormat, key: AesCbcCryptoKey): Promise<ArrayBuffer | JsonWebKey>

 
Export an AES_CBC key

 
example
const key = await AES_CBC.generateKey();
const jwk = await AES_CBC.exportKey("jwk", key.self);
 

 
example
const key = await AES_CBC.generateKey();
const jwk = await key.exportKey("jwk");
 

-
Parameters
Returns Promise<ArrayBuffer | JsonWebKey>
source
(algorithm?: Omit<EnforcedAesKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCbcProxiedCryptoKey>

+
Parameters
Returns Promise<ArrayBuffer | JsonWebKey>
source
(algorithm?: Omit<EnforcedAesKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCbcProxiedCryptoKey>

 
Generate a new AES_CBC key

 
example
const key = await AES_CBC.generateKey();
 

 
Parameters
  • algorithm: Omit<EnforcedAesKeyGenParams, "name"> = {
     length: 256,
-}
  • extractable: boolean = true
  • Optional keyUsages: KeyUsage[]
Returns Promise<AesCbcProxiedCryptoKey>
source
(format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<AesCbcKeyAlgorithm, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCbcProxiedCryptoKey>

+}
  • extractable: boolean = true
  • Optional keyUsages: KeyUsage[]
    • Returns Promise<AesCbcProxiedCryptoKey>
    source
    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<AesCbcKeyAlgorithm, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCbcProxiedCryptoKey>
    
 
    Import an AES_CBC key
    
 
    example
    const jwk = await AES_CBC.importKey("jwk", jwk, {
        length: 256,
    });
 
    
-
    Parameters
    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<AesCbcKeyAlgorithm, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]
    Returns Promise<AesCbcProxiedCryptoKey>
    source
    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: AesCbcCryptoKey, unwrappingKeyAlgorithm: Omit<EnforcedAesCbcParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
    
+
    Parameters
    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<AesCbcKeyAlgorithm, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]
    Returns Promise<AesCbcProxiedCryptoKey>
    source
    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: AesCbcCryptoKey, unwrappingKeyAlgorithm: Omit<EnforcedAesCbcParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
    
 
    Unwrap a wrapped key using the key encryption key
    
 
    example
    const wrappedKey = await AES_CBC.wrapKey("raw", dek.self, kek.self, {
        iv,
    });
    const unwrappedKey = await AES_CBC.unwrapKey(
       "raw",
       wrappedKey,
       { name: Alg.Mode.AES_CBC },
       kek.self,
       { iv }
    );
 
    
 
    example
    const wrappedKey = await AES_CBC.wrapKey("raw", dek.self, kek.self, {
        iv,
    });
    const unwrappedKey = await kek.unwrapKey(
       "raw",
       wrappedKey,
       { name: Alg.Mode.AES_CBC },
       { iv }
    );
 
    
-
    Parameters
    Returns Promise<CryptoKey>
    source
    (format: KeyFormat, key: CryptoKey, wrappingkey: AesCbcCryptoKey, wrapAlgorithm: Omit<EnforcedAesCbcParams, "name">): Promise<ArrayBuffer>
    
+
    Parameters
    Returns Promise<CryptoKey>
    source
    (format: KeyFormat, key: CryptoKey, wrappingkey: AesCbcCryptoKey, wrapAlgorithm: Omit<EnforcedAesCbcParams, "name">): Promise<ArrayBuffer>
    
 
    Wrap another key with an AES_CBC key
    
 
    example
    const kek = await AES_CBC.generateKey({ length: 256 }, true, [
       "wrapKey",
       "unwrapKey",
    ]);
    const dek: AesCbcCryptoKey = await AES_CBC.generateKey({
       length: 256,
    });
    const iv = await IV.generate();
    const wrappedKey = await AES_CBC.wrapKey("raw", dek, kek, {
        iv,
    });
 
    
diff --git a/modules/aes_aes_ctr.html b/modules/aes_aes_ctr.html
index 2b4311f..d488255 100644
--- a/modules/aes_aes_ctr.html
+++ b/modules/aes_aes_ctr.html
@@ -1,45 +1,45 @@
-aes/aes_ctr | @nfen/webcrypto-ts
    Module aes/aes_ctr
    source · [−]
    Expand description
    
+aes/aes_ctr | @nfen/webcrypto-ts
    Module aes/aes_ctr
    source · [−]
    Expand description
    
 
    Code related to AES_CTR mode
    
-
    Functions
    source
    (algorithm: Omit<EnforcedAesCtrParams, "name">, key: AesCtrCryptoKey, data: BufferSource): Promise<ArrayBuffer>
    
+
    Functions
    source
    (algorithm: Omit<EnforcedAesCtrParams, "name">, key: AesCtrCryptoKey, data: BufferSource): Promise<ArrayBuffer>
    
 
    Decrypt with an AES_CTR key
    
 
    example
    const data = await AES_CTR.decrypt({length, counter}, key.self, data);
 
    
 
    example
    const data = await key.decrypt({length, counter}, data);
 
    
-
    Parameters
    Returns Promise<ArrayBuffer>
    source
    (algorithm: Omit<EnforcedAesCtrParams, "name">, key: AesCtrCryptoKey, data: BufferSource): Promise<ArrayBuffer>
    
+
    Parameters
    Returns Promise<ArrayBuffer>
    source
    (algorithm: Omit<EnforcedAesCtrParams, "name">, key: AesCtrCryptoKey, data: BufferSource): Promise<ArrayBuffer>
    
 
    Encrypt with an AES_CTR key
    
 
    example
    const key = await AES_CTR.generateKey();
    const message = new TextEncoder().encode("a message");
    const length = 8;
    const counter = await AES_CTR.generateCounter(length);
    const data = await AES_CTR.encrypt({length, counter}, key.self, message);
 
    
 
    example
    const key = await AES_CTR.generateKey();
    const message = new TextEncoder().encode("a message");
    const length = 8;
    const counter = await AES_CTR.generateCounter(length);
    const data = await key.encrypt({length, counter}, message);
 
    
-
    Parameters
    Returns Promise<ArrayBuffer>
    source
    (format: KeyFormat, key: AesCtrCryptoKey): Promise<ArrayBuffer | JsonWebKey>
    
+
    Parameters
    Returns Promise<ArrayBuffer>
    source
    (format: KeyFormat, key: AesCtrCryptoKey): Promise<ArrayBuffer | JsonWebKey>
    
 
    Export an AES_CTR key into the specified format
    
 
    example
    const key = await AES_CTR.generateKey();
    const jwk = await AES_CTR.exportKey("jwk", key.self);
 
    
 
    example
    const key = await AES_CTR.generateKey();
    const jwk = await key.exportKey("jwk");
 
    
-
    Parameters
    Returns Promise<ArrayBuffer | JsonWebKey>
    source
    (counterLength?: number): Promise<Uint8Array>
    
+
    Parameters
    Returns Promise<ArrayBuffer | JsonWebKey>
    source
    (counterLength?: number): Promise<Uint8Array>
    
 
    Generates a counter, with the given length, starting from the count of 1. The nonce is randomized.
    
 
    see
    https://developer.mozilla.org/en-US/docs/Web/API/AesCtrParams
    
 
    example
    const counter = await AES_CTR.generateCounter();
 
    
-
    Parameters
    • counterLength: number = 8
    Returns Promise<Uint8Array>
    source
    (algorithm?: Omit<EnforcedAesKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCtrProxiedCryptoKey>
    
+
    Parameters
    • counterLength: number = 8
    Returns Promise<Uint8Array>
    source
    (algorithm?: Omit<EnforcedAesKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCtrProxiedCryptoKey>
    
 
    Generate a new AES_CTR key
    
 
    example
    const key = await AES_CTR.generateKey();
 
    
 
    Parameters
    • algorithm: Omit<EnforcedAesKeyGenParams, "name"> = {
     length: 256,
-}
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]
    Returns Promise<AesCtrProxiedCryptoKey>
    source
    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<AesCtrKeyAlgorithm, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCtrProxiedCryptoKey>
    
+}
  • extractable: boolean = true
  • Optional keyUsages: KeyUsage[]
    • Returns Promise<AesCtrProxiedCryptoKey>
    source
    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<AesCtrKeyAlgorithm, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCtrProxiedCryptoKey>
    
 
    Import an AES_CTR key from the specified format
    
 
    example
    const key = await AES_CTR.importKey("jwk", jwk, { length: 256 });
 
    
-
    Parameters
    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<AesCtrKeyAlgorithm, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]
    Returns Promise<AesCtrProxiedCryptoKey>
    source
    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: AesCtrCryptoKey, unwrappingKeyAlgorithm: Omit<EnforcedAesCtrParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
    
+
    Parameters
    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<AesCtrKeyAlgorithm, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]
    Returns Promise<AesCtrProxiedCryptoKey>
    source
    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: AesCtrCryptoKey, unwrappingKeyAlgorithm: Omit<EnforcedAesCtrParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>
    
 
    Unwrap a wrapped key using the key encryption key
    
 
    example
    const dek = await AES_CTR.unwrapKey("raw", wrappedKey, {name: "AES_CTR"}, kek.self, {length, counter});
 
    
 
    example
    const dek = await kek.unwrapKey("raw", wrappedKey, {name: "AES_CTR"}, {length, counter});
 
    
-
    Parameters
    Returns Promise<CryptoKey>
    source
    (format: KeyFormat, key: CryptoKey, wrappingkey: AesCtrCryptoKey, wrapAlgorithm: Omit<EnforcedAesCtrParams, "name">): Promise<ArrayBuffer>
    
+
    Parameters
    Returns Promise<CryptoKey>
    source
    (format: KeyFormat, key: CryptoKey, wrappingkey: AesCtrCryptoKey, wrapAlgorithm: Omit<EnforcedAesCtrParams, "name">): Promise<ArrayBuffer>
    
 
    Wrap another key with an AES_CTR key
    
 
    example
    const kek = await AES_CTR.generateKey({length: 256}, true, ['wrapKey', 'unwrapKey']);
    const dek = await AES_CTR.generateKey();
    const length = 8;
    const counter = await AES_CTR.generateCounter(length);
    const wrappedKey = await AES_CTR.wrapKey("raw", dek.self, kek.self, {length, counter});
 
    
diff --git a/modules/aes_aes_gcm.html b/modules/aes_aes_gcm.html
index f79ddc4..8a72746 100644
--- a/modules/aes_aes_gcm.html
+++ b/modules/aes_aes_gcm.html
@@ -1,40 +1,40 @@
-aes/aes_gcm | @nfen/webcrypto-ts
    Module aes/aes_gcm
    source · [−]
    Expand description
    
+aes/aes_gcm | @nfen/webcrypto-ts
    Module aes/aes_gcm
    source · [−]
    Expand description
    
 
    Code related to AES_GCM mode
    
-
    Functions
    source
    (algorithm: Omit<EnforcedAesGcmParams, "name">, key: AesGcmCryptoKey, data: BufferSource): Promise<ArrayBuffer>
    
+
    Functions
    source
    (algorithm: Omit<EnforcedAesGcmParams, "name">, key: AesGcmCryptoKey, data: BufferSource): Promise<ArrayBuffer>
    
 
    Decrypt with an AES_GCM key
    
 
    example
    const key = await AES_GCM.generateKey();
    const data = await AES_GCM.decrypt({iv}, key.self, data);
 
    
 
    example
    const key = await AES_GCM.generateKey();
    const data = await key.decrypt({iv}, data);
 
    
-
    Parameters
    Returns Promise<ArrayBuffer>
    source
    (algorithm: Omit<EnforcedAesGcmParams, "name">, key: AesGcmCryptoKey, data: BufferSource): Promise<ArrayBuffer>
    
+
    Parameters
    Returns Promise<ArrayBuffer>
    source
    (algorithm: Omit<EnforcedAesGcmParams, "name">, key: AesGcmCryptoKey, data: BufferSource): Promise<ArrayBuffer>
    
 
    Encrypt with an AES_GCM key
    
 
    example
    const iv = await Random.IV.generate();
    const key = await AES_GCM.generateKey();
    const message = new TextEncoder().encode("a message");
    const data = await AES_GCM.encrypt({iv}, key.self, message);
 
    
 
    example
    const iv = await Random.IV.generate();
    const key = await AES_GCM.generateKey();
    const message = new TextEncoder().encode("a message");
    const data = await key.encrypt({iv}, message);
 
    
-
    Parameters
    Returns Promise<ArrayBuffer>
    source
    (format: KeyFormat, key: AesGcmCryptoKey): Promise<ArrayBuffer | JsonWebKey>
    
+
    Parameters
    Returns Promise<ArrayBuffer>
    source
    (format: KeyFormat, key: AesGcmCryptoKey): Promise<ArrayBuffer | JsonWebKey>
    
 
    Export an AES_GCM key into the specified format
    
 
    example
    const key = await AES_GCM.generateKey();
    const jwk = await AES_GCM.exportKey("jwk", key.self);
 
    
 
    example
    const key = await AES_GCM.generateKey();
    const jwk = await key.exportKey("jwk");
 
    
-
    Parameters
    Returns Promise<ArrayBuffer | JsonWebKey>
    source
    (algorithm?: Omit<EnforcedAesKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesGcmProxiedCryptoKey>
    
+
    Parameters
    Returns Promise<ArrayBuffer | JsonWebKey>
    source

    (algorithm?: Omit<EnforcedAesKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesGcmProxiedCryptoKey>

    Generate a new AES_GCM key

    example
    const key = await AES_GCM.generateKey();

    Parameters

    • algorithm: Omit<EnforcedAesKeyGenParams, "name"> = { length: 256, -}
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<AesGcmProxiedCryptoKey>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<AesGcmKeyAlgorithm, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesGcmProxiedCryptoKey>

    +}
  • extractable: boolean = true
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<AesGcmProxiedCryptoKey>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<AesGcmKeyAlgorithm, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesGcmProxiedCryptoKey>

    Import an AES_GCM key from the specified format

    example
    const key = await AES_GCM.importKey("jwk", jwk, { length: 256 });
    -

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<AesGcmKeyAlgorithm, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<AesGcmProxiedCryptoKey>

    source

    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: AesGcmCryptoKey, unwrappingKeyAlgorithm: Omit<EnforcedAesGcmParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>

    +

    Parameters

    Returns Promise<AesGcmProxiedCryptoKey>

    source

    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: AesGcmCryptoKey, unwrappingKeyAlgorithm: Omit<EnforcedAesGcmParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>

    Unwrap a wrapped key using the key encryption key

    example
    const dek = await AES_GCM.unwrapKey("raw", wrappedKey, {name: "AES_GCM"}, kek, {iv});
    example
    const dek = await kek.unwrapKey("raw", wrappedKey, {name: "AES_GCM"}, {iv});
    -

    Parameters

    Returns Promise<CryptoKey>

    source

    (format: KeyFormat, key: CryptoKey, wrappingkey: AesGcmCryptoKey, wrapAlgorithm: Omit<EnforcedAesGcmParams, "name">): Promise<ArrayBuffer>

    +

    Parameters

    Returns Promise<CryptoKey>

    source

    (format: KeyFormat, key: CryptoKey, wrappingkey: AesGcmCryptoKey, wrapAlgorithm: Omit<EnforcedAesGcmParams, "name">): Promise<ArrayBuffer>

    Wrap another key with an AES_GCM key

    example
    const iv = await Random.IV.generate();
    const kek = await AES_GCM.generateKey({length: 256}, true, ['wrapKey', 'unwrapKey']);
    const dek = await AES_GCM.generateKey();
    const wrappedKey = await AES_GCM.wrapKey("raw", dek.self, kek.self, {iv});
    diff --git a/modules/aes_aes_kw.html b/modules/aes_aes_kw.html index 5c081b3..f92fe4e 100644 --- a/modules/aes_aes_kw.html +++ b/modules/aes_aes_kw.html @@ -1,28 +1,28 @@ -aes/aes_kw | @nfen/webcrypto-ts

    Module aes/aes_kw

    source · [−]
    Expand description
    +aes/aes_kw | @nfen/webcrypto-ts

    Module aes/aes_kw

    source · [−]
    Expand description

    Code related to AES_KW mode

    -

    Functions

    source

    (format: KeyFormat, key: AesKwCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    +

    Functions

    source

    (format: KeyFormat, key: AesKwCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    Export an AES_KW key into the specified format

    example
    const jwk = await AES_KW.exportKey("jwk", key.self);
    example
    const jwk = await key.exportKey("jwk");
    -

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedAesKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesKwProxiedCryptoKey>

    +

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedAesKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesKwProxiedCryptoKey>

    Generate a new AES_KW key

    example
    const key = await AES_KW.generateKey();

    Parameters

    • algorithm: Omit<EnforcedAesKeyGenParams, "name"> = { length: 256, -}
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<AesKwProxiedCryptoKey>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesKwProxiedCryptoKey>

    +}
  • extractable: boolean = true
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<AesKwProxiedCryptoKey>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesKwProxiedCryptoKey>

    Import an AES_KW key from the specified format

    example
    const key = await AES_KW.importKey("jwk", jwk);
    -

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<AesKwProxiedCryptoKey>

    source

    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: AesKwCryptoKey, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>

    +

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<AesKwProxiedCryptoKey>

    source

    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: AesKwCryptoKey, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>

    Unwrap a wrapped key using the key encryption key

    example
    const dek = await AES_KW.unwrapKey("raw", wrappedKey, {name: "AES_GCM"}, kek.self);
    example
    const dek = await kek.unwrapKey("raw", wrappedKey, {name: "AES_GCM"});
    -

    Parameters

    Returns Promise<CryptoKey>

    source

    (format: KeyFormat, key: CryptoKey, wrappingkey: AesKwCryptoKey): Promise<ArrayBuffer>

    +

    Parameters

    Returns Promise<CryptoKey>

    source

    (format: KeyFormat, key: CryptoKey, wrappingkey: AesKwCryptoKey): Promise<ArrayBuffer>

    Wrap another key with an AES_KW key

    example
    const kek = await AES_KW.generateKey({length: 256}, true, ['wrapKey', 'unwrapKey']);
    const dek = await AES_GCM.generateKey();
    const wrappedKey = await AES_KW.wrapKey("raw", dek.self, kek.self);
    diff --git a/modules/aes_shared.AesShared.html b/modules/aes_shared.AesShared.html index 2fa873b..94e4d6d 100644 --- a/modules/aes_shared.AesShared.html +++ b/modules/aes_shared.AesShared.html @@ -1 +1 @@ -AesShared | @nfen/webcrypto-ts

    Namespace aes/shared.AesShared

    source · [−]

    Functions

    source

    <T>(algorithm: EnforcedAesGcmParams | EnforcedAesCtrParams | EnforcedAesCbcParams, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    Returns Promise<ArrayBuffer>

    source

    <T>(algorithm: EnforcedAesGcmParams | EnforcedAesCtrParams | EnforcedAesCbcParams, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    Returns Promise<ArrayBuffer>

    source

    <T>(format: KeyFormat, key: T): Promise<JsonWebKey | ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: KeyFormat
    • key: T

    Returns Promise<JsonWebKey | ArrayBuffer>

    source

    <T>(algorithm: EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    Parameters

    Returns Promise<T>

    source

    <T>(format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: EnforcedAesKeyAlgorithms, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: EnforcedAesKeyAlgorithms
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T>(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: T, unwrappingKeyAlgorithm: EnforcedAesParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: KeyFormat
    • wrappedKey: BufferSource
    • wrappedKeyAlgorithm: EnforcedImportParams
    • unwrappingKey: T
    • unwrappingKeyAlgorithm: EnforcedAesParams
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<CryptoKey>

    source

    <T>(format: KeyFormat, key: CryptoKey, wrappingkey: T, wrapAlgorithm: EnforcedAesParams): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    Returns Promise<ArrayBuffer>

    \ No newline at end of file +AesShared | @nfen/webcrypto-ts

    Namespace aes/shared.AesShared

    source · [−]

    Functions

    source

    <T>(algorithm: EnforcedAesGcmParams | EnforcedAesCtrParams | EnforcedAesCbcParams, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    Returns Promise<ArrayBuffer>

    source

    <T>(algorithm: EnforcedAesGcmParams | EnforcedAesCtrParams | EnforcedAesCbcParams, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    Returns Promise<ArrayBuffer>

    source

    <T>(format: KeyFormat, key: T): Promise<JsonWebKey | ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: KeyFormat
    • key: T

    Returns Promise<JsonWebKey | ArrayBuffer>

    source

    <T>(algorithm: EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    Parameters

    Returns Promise<T>

    source

    <T>(format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: EnforcedAesKeyAlgorithms, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: EnforcedAesKeyAlgorithms
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T>(format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: T, unwrappingKeyAlgorithm: EnforcedAesParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<CryptoKey>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: KeyFormat
    • wrappedKey: BufferSource
    • wrappedKeyAlgorithm: EnforcedImportParams
    • unwrappingKey: T
    • unwrappingKeyAlgorithm: EnforcedAesParams
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<CryptoKey>

    source

    <T>(format: KeyFormat, key: CryptoKey, wrappingkey: T, wrapAlgorithm: EnforcedAesParams): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    Returns Promise<ArrayBuffer>

    \ No newline at end of file diff --git a/modules/aes_shared.Alg.html b/modules/aes_shared.Alg.html index 3cf9b87..70b23d4 100644 --- a/modules/aes_shared.Alg.html +++ b/modules/aes_shared.Alg.html @@ -1 +1 @@ -Alg | @nfen/webcrypto-ts

    Namespace aes/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Mode
    \ No newline at end of file +Alg | @nfen/webcrypto-ts

    Namespace aes/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Mode
    \ No newline at end of file diff --git a/modules/aes_shared.html b/modules/aes_shared.html index c5d991e..9def394 100644 --- a/modules/aes_shared.html +++ b/modules/aes_shared.html @@ -1,3 +1,3 @@ -aes/shared | @nfen/webcrypto-ts

    Module aes/shared

    source · [−]
    Expand description
    +aes/shared | @nfen/webcrypto-ts

    Module aes/shared

    source · [−]
    Expand description

    Shared code for AES

    -

    Type Aliases

    Namespaces

    AesShared
    Alg

    Interfaces

    AesCbcCryptoKey
    AesCbcProxiedCryptoKey
    AesCtrCryptoKey
    AesCtrProxiedCryptoKey
    AesGcmCryptoKey
    AesGcmProxiedCryptoKey
    AesKwCryptoKey
    AesKwProxiedCryptoKey
    \ No newline at end of file +

    Type Aliases

    Namespaces

    AesShared
    Alg

    Interfaces

    AesCbcCryptoKey
    AesCbcProxiedCryptoKey
    AesCtrCryptoKey
    AesCtrProxiedCryptoKey
    AesGcmCryptoKey
    AesGcmProxiedCryptoKey
    AesKwCryptoKey
    AesKwProxiedCryptoKey
    \ No newline at end of file diff --git a/modules/ec.html b/modules/ec.html index 9b551ef..27fa511 100644 --- a/modules/ec.html +++ b/modules/ec.html @@ -1,3 +1,3 @@ -ec | @nfen/webcrypto-ts

    Module ec

    source · [−]
    Expand description
    +ec | @nfen/webcrypto-ts

    Module ec

    source · [−]
    Expand description

    All elliptic curve algorithms

    -

    References

    Re-exports Alg
    Renames and re-exports ec/ecdh
    Renames and re-exports ec/ecdsa
    Re-exports EcCryptoKeyPairs
    Re-exports EcCryptoKeys
    Re-exports EcdhPrivCryptoKey
    Re-exports EcdhProxiedCryptoKeyPair
    Re-exports EcdhProxiedPrivCryptoKey
    Re-exports EcdhProxiedPubCryptoKey
    Re-exports EcdhPubCryptoKey
    Re-exports EcdsaPrivCryptoKey
    Re-exports EcdsaProxiedCryptoKeyPair
    Re-exports EcdsaProxiedPrivCryptoKey
    Re-exports EcdsaProxiedPubCryptoKey
    Re-exports EcdsaPubCryptoKey
    \ No newline at end of file +

    References

    Re-exports Alg
    Renames and re-exports ec/ecdh
    Renames and re-exports ec/ecdsa
    Re-exports EcCryptoKeyPairs
    Re-exports EcCryptoKeys
    Re-exports EcdhPrivCryptoKey
    Re-exports EcdhProxiedCryptoKeyPair
    Re-exports EcdhProxiedPrivCryptoKey
    Re-exports EcdhProxiedPubCryptoKey
    Re-exports EcdhPubCryptoKey
    Re-exports EcdsaPrivCryptoKey
    Re-exports EcdsaProxiedCryptoKeyPair
    Re-exports EcdsaProxiedPrivCryptoKey
    Re-exports EcdsaProxiedPubCryptoKey
    Re-exports EcdsaPubCryptoKey
    \ No newline at end of file diff --git a/modules/ec_ecdh.html b/modules/ec_ecdh.html index 939a69b..42deb95 100644 --- a/modules/ec_ecdh.html +++ b/modules/ec_ecdh.html @@ -1,18 +1,18 @@ -ec/ecdh | @nfen/webcrypto-ts

    Module ec/ecdh

    source · [−]
    Expand description
    +ec/ecdh | @nfen/webcrypto-ts

    Module ec/ecdh

    source · [−]
    Expand description

    Code related to ECDH

    -

    Functions

    source

    (algorithm: Omit<EnforcedEcdhKeyDeriveParams, "name">, baseKey: EcdhPrivCryptoKey, length: number): Promise<ArrayBuffer>

    +

    Functions

    source

    (algorithm: Omit<EnforcedEcdhKeyDeriveParams, "name">, baseKey: EcdhPrivCryptoKey, length: number): Promise<ArrayBuffer>

    Derive a shared bits between two ECDH key pairs

    example
    const keyPair = await ECDH.generateKey();
    const otherKeyPair = await ECDH.generateKey();
    const bits = await ECDH.deriveBits(
         { public: otherKeyPair.publicKey.self },
         keyPair.privateKey.self,
         128
    );
    example
    const keyPair = await ECDH.generateKey();
    const otherKeyPair = await ECDH.generateKey();
    const bits = await keyPair.privateKey.deriveBits(
         { public: otherKeyPair.publicKey.self },
         128
    );
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: Omit<EnforcedEcdhKeyDeriveParams, "name">, baseKey: EcdhPrivCryptoKey, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: Omit<EnforcedEcdhKeyDeriveParams, "name">, baseKey: EcdhPrivCryptoKey, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>

    Derive a shared key between two ECDH key pairs

    example
    const keyPair = await ECDH.generateKey();
    const otherKeyPair = await ECDH.generateKey();
    const hmacParams: params.EnforcedHmacKeyGenParams = {
         name: Authentication.Alg.Code.HMAC,
         hash: SHA.Alg.Variant.SHA_512,
         length: 512,
    };
    let key = await ECDH.deriveKey(
         { public: otherKeyPair.publicKey.self },
         keyPair.privateKey.self,
         hmacParams
    );
    example
    const keyPair = await ECDH.generateKey();
    const otherKeyPair = await ECDH.generateKey();
    const hmacParams: params.EnforcedHmacKeyGenParams = {
         name: Authentication.Alg.Code.HMAC,
         hash: SHA.Alg.Variant.SHA_512,
         length: 512,
    };
    let key = await keyPair.privateKey.deriveKey(
         { public: otherKeyPair.publicKey.self },
         hmacParams
    );
    -

    Parameters

    Returns Promise<HmacCryptoKey | AesCryptoKeys>

    source

    (format: KeyFormat, key: EcdhPubCryptoKey | EcdhPrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    +

    Parameters

    Returns Promise<HmacCryptoKey | AesCryptoKeys>

    source

    (format: KeyFormat, key: EcdhPubCryptoKey | EcdhPrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    Export an ECDH public or private key

    example
    const pubKeyJwk = await ECDH.exportKey("jwk", keyPair.publicKey.self);
    @@ -22,7 +22,7 @@
    example
    const privKeyJwk = await keyPair.privateKey.exportKey("jwk");
    -

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedEcKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdhProxiedCryptoKeyPair>

    +

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedEcKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdhProxiedCryptoKeyPair>

    Generate a new ECDH keypair

    example
    const keyPair = await ECDH.generateKey();
    @@ -32,7 +32,7 @@

    Parameters

    • algorithm: Omit<EnforcedEcKeyGenParams, "name"> = { namedCurve: Alg.Curve.P_521, -}
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<EcdhProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedEcKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdhProxiedCryptoKeyPair>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<EcdhProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedEcKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdhProxiedCryptoKeyPair>

    Generate a new ECDH keypair

    alias

    generateKey

    example
    const keyPair = await ECDH.generateKeyPair();
@@ -43,7 +43,7 @@

    Parameters

    • algorithm: Omit<EnforcedEcKeyGenParams, "name"> = { namedCurve: Alg.Curve.P_521, -}
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<EcdhProxiedCryptoKeyPair>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm?: Omit<EnforcedEcKeyImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdhProxiedPubCryptoKey | EcdhProxiedPrivCryptoKey>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<EcdhProxiedCryptoKeyPair>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm?: Omit<EnforcedEcKeyImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdhProxiedPubCryptoKey | EcdhProxiedPrivCryptoKey>

    Import an ECDH public or private key

    example
    const pubKey = await ECDH.importKey("jwk", pubKeyJwk, { namedCurve: "P-521" }, true, []);
    diff --git a/modules/ec_ecdsa.html b/modules/ec_ecdsa.html index a6bea2c..e655c2d 100644 --- a/modules/ec_ecdsa.html +++ b/modules/ec_ecdsa.html @@ -1,6 +1,6 @@ -ec/ecdsa | @nfen/webcrypto-ts

    Module ec/ecdsa

    source · [−]
    Expand description
    +ec/ecdsa | @nfen/webcrypto-ts

    Module ec/ecdsa

    source · [−]
    Expand description

    Code related to ECDSA

    -

    Functions

    source

    (format: KeyFormat, key: EcdsaPubCryptoKey | EcdsaPrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    +

    Functions

    source

    (format: KeyFormat, key: EcdsaPubCryptoKey | EcdsaPrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    Export an ECDSA public or private key

    example
    const pubKeyJwk = await ECDSA.exportKey("jwk", keyPair.publicKey.self);
    @@ -10,7 +10,7 @@
    example
    const privKeyJwk = await keyPair.privateKey.exportKey("jwk");
    -

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedEcKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdsaProxiedCryptoKeyPair>

    +

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedEcKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdsaProxiedCryptoKeyPair>

    Generate a new ECDSA keypair

    example
    const keyPair = await ECDSA.generateKey();
    @@ -20,7 +20,7 @@

    Parameters

    • algorithm: Omit<EnforcedEcKeyGenParams, "name"> = { namedCurve: Alg.Curve.P_521, -}
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<EcdsaProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedEcKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdsaProxiedCryptoKeyPair>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<EcdsaProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedEcKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdsaProxiedCryptoKeyPair>

    Generate a new ECDSA keypair

    alias

    generateKey

    example
    const keyPair = await ECDSA.generateKeyPair();
@@ -31,7 +31,7 @@

    Parameters

    • algorithm: Omit<EnforcedEcKeyGenParams, "name"> = { namedCurve: Alg.Curve.P_521, -}
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<EcdsaProxiedCryptoKeyPair>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm?: Omit<EnforcedEcKeyImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdsaProxiedPubCryptoKey | EcdsaProxiedPrivCryptoKey>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<EcdsaProxiedCryptoKeyPair>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm?: Omit<EnforcedEcKeyImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<EcdsaProxiedPubCryptoKey | EcdsaProxiedPrivCryptoKey>

    Import an ECDSA public or private key

    example
    const pubKey = await ECDSA.importKey("jwk", pubKeyJwk, { namedCurve: "P-521" }, true, ['verify']);
    @@ -39,13 +39,13 @@

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedEcKeyImportParams, "name"> = { namedCurve: Alg.Curve.P_521, -}
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<EcdsaProxiedPubCryptoKey | EcdsaProxiedPrivCryptoKey>

    source

    (algorithm: Omit<EnforcedEcdsaParams, "name">, key: EcdsaPrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<EcdsaProxiedPubCryptoKey | EcdsaProxiedPrivCryptoKey>

    source

    (algorithm: Omit<EnforcedEcdsaParams, "name">, key: EcdsaPrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    Sign a given payload

    example
    const message = new TextEncoder().encode("a message");
    const signature = await ECDSA.sign({hash: "SHA-512"}, keyPair.privateKey.self, message);
    example
    const message = new TextEncoder().encode("a message");
    const signature = await keyPair.privateKey.sign({hash: "SHA-512"}, message);
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: Omit<EnforcedEcdsaParams, "name">, key: EcdsaPubCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: Omit<EnforcedEcdsaParams, "name">, key: EcdsaPubCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    Verify a given signature

    example
    const message = new TextEncoder().encode("a message");
    const isVerified = await ECDSA.verify({hash: "SHA-512"}, keyPair.publicKey.self, signature, message);
    diff --git a/modules/ec_shared.Alg.html b/modules/ec_shared.Alg.html index 4527fd4..5381b9d 100644 --- a/modules/ec_shared.Alg.html +++ b/modules/ec_shared.Alg.html @@ -1 +1 @@ -Alg | @nfen/webcrypto-ts

    Namespace ec/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Curve
    Variant
    \ No newline at end of file +Alg | @nfen/webcrypto-ts

    Namespace ec/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Curve
    Variant
    \ No newline at end of file diff --git a/modules/ec_shared.EcShared.html b/modules/ec_shared.EcShared.html index 2b7cf27..ab9b83b 100644 --- a/modules/ec_shared.EcShared.html +++ b/modules/ec_shared.EcShared.html @@ -1 +1 @@ -EcShared | @nfen/webcrypto-ts

    Namespace ec/shared.EcShared

    source · [−]

    Functions

    source

    (format: KeyFormat, key: EcCryptoKeys): Promise<JsonWebKey | ArrayBuffer>

    Parameters

    Returns Promise<JsonWebKey | ArrayBuffer>

    source

    <T>(algorithm: EnforcedEcKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    Parameters

    Returns Promise<T>

    source

    <T>(format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: EnforcedEcKeyImportParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: EnforcedEcKeyImportParams
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<T>

    \ No newline at end of file +EcShared | @nfen/webcrypto-ts

    Namespace ec/shared.EcShared

    source · [−]

    Functions

    source

    (format: KeyFormat, key: EcCryptoKeys): Promise<JsonWebKey | ArrayBuffer>

    Parameters

    Returns Promise<JsonWebKey | ArrayBuffer>

    source

    <T>(algorithm: EnforcedEcKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    Parameters

    Returns Promise<T>

    source

    <T>(format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: EnforcedEcKeyImportParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: EnforcedEcKeyImportParams
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<T>

    \ No newline at end of file diff --git a/modules/ec_shared.html b/modules/ec_shared.html index fdfe4aa..c9bf7d9 100644 --- a/modules/ec_shared.html +++ b/modules/ec_shared.html @@ -1,3 +1,3 @@ -ec/shared | @nfen/webcrypto-ts

    Module ec/shared

    source · [−]
    Expand description
    +ec/shared | @nfen/webcrypto-ts

    Module ec/shared

    source · [−]
    Expand description

    Shared code for EC

    -

    Type Aliases

    Namespaces

    Alg
    EcShared

    Interfaces

    EcdhCryptoKeyPair
    EcdhPrivCryptoKey
    EcdhProxiedCryptoKeyPair
    EcdhProxiedPrivCryptoKey
    EcdhProxiedPubCryptoKey
    EcdhPubCryptoKey
    EcdsaCryptoKeyPair
    EcdsaPrivCryptoKey
    EcdsaProxiedCryptoKeyPair
    EcdsaProxiedPrivCryptoKey
    EcdsaProxiedPubCryptoKey
    EcdsaPubCryptoKey
    \ No newline at end of file +

    Type Aliases

    Namespaces

    Alg
    EcShared

    Interfaces

    EcdhCryptoKeyPair
    EcdhPrivCryptoKey
    EcdhProxiedCryptoKeyPair
    EcdhProxiedPrivCryptoKey
    EcdhProxiedPubCryptoKey
    EcdhPubCryptoKey
    EcdsaCryptoKeyPair
    EcdsaPrivCryptoKey
    EcdsaProxiedCryptoKeyPair
    EcdsaProxiedPrivCryptoKey
    EcdsaProxiedPubCryptoKey
    EcdsaPubCryptoKey
    \ No newline at end of file diff --git a/modules/hmac.Alg.html b/modules/hmac.Alg.html index 69ac3db..ad91117 100644 --- a/modules/hmac.Alg.html +++ b/modules/hmac.Alg.html @@ -1 +1 @@ -Alg | @nfen/webcrypto-ts

    Namespace hmac.Alg

    source · [−]

    Type Aliases

    Enumerations

    Code
    \ No newline at end of file +Alg | @nfen/webcrypto-ts

    Namespace hmac.Alg

    source · [−]

    Type Aliases

    Enumerations

    Code
    \ No newline at end of file diff --git a/modules/hmac.html b/modules/hmac.html index b24f5ee..f7e8812 100644 --- a/modules/hmac.html +++ b/modules/hmac.html @@ -1,28 +1,28 @@ -hmac | @nfen/webcrypto-ts

    Module hmac

    source · [−]
    Expand description
    +hmac | @nfen/webcrypto-ts

    Module hmac

    source · [−]
    Expand description

    Code related to HMAC

    -

    Functions

    source

    (format: KeyFormat, key: HmacCryptoKey): Promise<JsonWebKey | ArrayBuffer>

    +

    Functions

    source

    (format: KeyFormat, key: HmacCryptoKey): Promise<JsonWebKey | ArrayBuffer>

    Export an HMAC key into the specified format

    example
    const jwk = await HMAC.exportKey("jwk", key.self);
    example
    const jwk = await key.exportKey("jwk");
    -

    Parameters

    Returns Promise<JsonWebKey | ArrayBuffer>

    source

    (algorithm?: Omit<EnforcedHmacKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacProxiedCryptoKey>

    +

    Parameters

    Returns Promise<JsonWebKey | ArrayBuffer>

    source

    (algorithm?: Omit<EnforcedHmacKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacProxiedCryptoKey>

    Generate a new HMAC key

    example
    const key = await HMAC.generateKey();

    Parameters

    • algorithm: Omit<EnforcedHmacKeyGenParams, "name"> = { hash: SHA.Variant.SHA_512, -}
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<HmacProxiedCryptoKey>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<EnforcedHmacImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacProxiedCryptoKey>

    +}
  • extractable: boolean = true
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<HmacProxiedCryptoKey>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<EnforcedHmacImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacProxiedCryptoKey>

    Import an HMAC key from the specified format

    example
    const key = await HMAC.importKey("jwk", jwk, {hash: "SHA-512"});
    -

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedHmacImportParams, "name">
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<HmacProxiedCryptoKey>

    source

    (key: HmacCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    +

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedHmacImportParams, "name">
    • extractable: boolean = true
    • Optional keyUsages: KeyUsage[]

    Returns Promise<HmacProxiedCryptoKey>

    source

    (key: HmacCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    Sign a given payload

    example
    const message = new TextEncoder().encode("a message");
    const signature = await HMAC.sign(key.self, message);
 
    const message = new TextEncoder().encode("a message");
    const signature = await key.sign(message);
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (key: HmacCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (key: HmacCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    Verify a given signature

    example
    const isVerified = await HMAC.verify(key, signature, message);
    diff --git a/modules/index.html b/modules/index.html index 5b5b637..731437e 100644 --- a/modules/index.html +++ b/modules/index.html @@ -1,5 +1,5 @@ -index | @nfen/webcrypto-ts

    Module index

    source · [−]
    Expand description
    +index | @nfen/webcrypto-ts

    Module index

    source · [−]
    Expand description

    webcrypto-ts main entry point

    example
    import * as WebCrypto from "@nfen/webcrypto-ts";
    import {AES, EC, HMAC, KDF, Random, RSA, SHA} from "@nfen/webcrypto-ts";
    -

    References

    Renames and re-exports aes
    Renames and re-exports ec
    Renames and re-exports hmac
    Renames and re-exports kdf
    Renames and re-exports rsa
    Renames and re-exports random
    Renames and re-exports sha
    \ No newline at end of file +

    References

    Renames and re-exports aes
    Renames and re-exports ec
    Renames and re-exports hmac
    Renames and re-exports kdf
    Renames and re-exports rsa
    Renames and re-exports random
    Renames and re-exports sha
    \ No newline at end of file diff --git a/modules/kdf.html b/modules/kdf.html index 10b6438..240b157 100644 --- a/modules/kdf.html +++ b/modules/kdf.html @@ -1,3 +1,3 @@ -kdf | @nfen/webcrypto-ts

    Module kdf

    source · [−]
    Expand description
    +kdf | @nfen/webcrypto-ts

    Module kdf

    source · [−]
    Expand description

    All key derivation functions

    -

    References

    Re-exports Alg
    Renames and re-exports kdf/hkdf
    Re-exports HkdfKeyMaterial
    Re-exports HkdfProxiedKeyMaterial
    Renames and re-exports kdf/pbkdf
    Re-exports Pbkdf2KeyMaterial
    Re-exports Pbkdf2ProxiedKeyMaterial
    \ No newline at end of file +

    References

    Re-exports Alg
    Renames and re-exports kdf/hkdf
    Re-exports HkdfKeyMaterial
    Re-exports HkdfProxiedKeyMaterial
    Renames and re-exports kdf/pbkdf
    Re-exports Pbkdf2KeyMaterial
    Re-exports Pbkdf2ProxiedKeyMaterial
    \ No newline at end of file diff --git a/modules/kdf_hkdf.html b/modules/kdf_hkdf.html index 3939557..4bedbfe 100644 --- a/modules/kdf_hkdf.html +++ b/modules/kdf_hkdf.html @@ -1,18 +1,18 @@ -kdf/hkdf | @nfen/webcrypto-ts

    Module kdf/hkdf

    source · [−]
    Expand description
    +kdf/hkdf | @nfen/webcrypto-ts

    Module kdf/hkdf

    source · [−]
    Expand description

    Code related to HKDF

    -

    Functions

    source

    (algorithm: Omit<EnforcedHkdfParams, "name">, baseKey: HkdfKeyMaterial, length: number): Promise<ArrayBuffer>

    +

    Functions

    source

    (algorithm: Omit<EnforcedHkdfParams, "name">, baseKey: HkdfKeyMaterial, length: number): Promise<ArrayBuffer>

    Derive a number bits with a given key material

    example
    const salt = await Random.Salt.generate();
    const info = await Random.getValues(6);
    const bits = await HKDF.deriveBits(
         { salt, info, hash: "SHA-512" },
         keyMaterial,
         128
    );
    example
    const salt = await Random.Salt.generate();
    const info = await Random.getValues(6);
    const bits = await keyMaterial.deriveBits(
         { salt, info, hash: "SHA-512" },
         128
    );
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: Omit<EnforcedHkdfParams, "name">, baseKey: HkdfKeyMaterial, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: Omit<EnforcedHkdfParams, "name">, baseKey: HkdfKeyMaterial, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>

    Derive a shared key from HKDF key material

    example
    const hmacParams: params.EnforcedHmacKeyGenParams = {
         name: Authentication.Alg.Code.HMAC,
         hash: SHA.Alg.Variant.SHA_512,
         length: 512,
    };
    const salt = await Random.Salt.generate();
    const info = await Random.getValues(6);
    let key = await HKDF.deriveKey(
         { salt, info, hash: "SHA-512" },
         keyMaterial,
         hmacParams
    );
    example
    const hmacParams: params.EnforcedHmacKeyGenParams = {
         name: Authentication.Alg.Code.HMAC,
         hash: SHA.Alg.Variant.SHA_512,
         length: 512,
    };
    const salt = await Random.Salt.generate();
    const info = await Random.getValues(6);
    let key = await keyMaterial.deriveKey(
         { salt, info, hash: "SHA-512" },
         hmacParams
    );
    -

    Parameters

    Returns Promise<HmacCryptoKey | AesCryptoKeys>

    source

    (format: KeyFormat, key: BufferSource, extractable?: boolean): Promise<HkdfProxiedKeyMaterial>

    +

    Parameters

    Returns Promise<HmacCryptoKey | AesCryptoKeys>

    source

    (format: KeyFormat, key: BufferSource, extractable?: boolean): Promise<HkdfProxiedKeyMaterial>

    Generate key material for deriving

    example
    const keyMaterial = await HKDF.generateKeyMaterial("raw", new TextEncoder().encode("lots_of_entropy"));
    diff --git a/modules/kdf_pbkdf.html b/modules/kdf_pbkdf.html index b8fbede..90210f4 100644 --- a/modules/kdf_pbkdf.html +++ b/modules/kdf_pbkdf.html @@ -1,18 +1,18 @@ -kdf/pbkdf | @nfen/webcrypto-ts

    Module kdf/pbkdf

    source · [−]
    Expand description
    +kdf/pbkdf | @nfen/webcrypto-ts

    Module kdf/pbkdf

    source · [−]
    Expand description

    Code related to PBKDF2

    -

    Functions

    source

    (algorithm: Omit<EnforcedPbkdf2Params, "iterations" | "name">, baseKey: Pbkdf2KeyMaterial, length: number): Promise<ArrayBuffer>

    +

    Functions

    source

    (algorithm: Omit<EnforcedPbkdf2Params, "iterations" | "name">, baseKey: Pbkdf2KeyMaterial, length: number): Promise<ArrayBuffer>

    Derive a number bits with a given key material

    example
    const bits = await PBKDF2.deriveBits(
         { hash: "SHA-512" },
         keyMaterial,
         128
    );
    example
    const bits = await keyMaterial.deriveBits(
         { hash: "SHA-512" },
         128
    );
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: Omit<EnforcedPbkdf2Params, "iterations" | "name">, baseKey: Pbkdf2KeyMaterial, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: Omit<EnforcedPbkdf2Params, "iterations" | "name">, baseKey: Pbkdf2KeyMaterial, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<HmacCryptoKey | AesCryptoKeys>

    Derive a shared key from PBKDF2 key material

    example
    const hmacParams: params.EnforcedHmacKeyGenParams = {
         name: Authentication.Alg.Code.HMAC,
         hash: SHA.Alg.Variant.SHA_512,
         length: 512,
    };
    let key = await PBKDF2.deriveKey(
         { hash: "SHA512" },
         keyMaterial,
         hmacParams
    );
    example
    const hmacParams: params.EnforcedHmacKeyGenParams = {
         name: Authentication.Alg.Code.HMAC,
         hash: SHA.Alg.Variant.SHA_512,
         length: 512,
    };
    let key = await keyMaterial.deriveKey(
         { hash: "SHA512" },
         hmacParams
    );
    -

    Parameters

    Returns Promise<HmacCryptoKey | AesCryptoKeys>

    source

    (format: KeyFormat, key: BufferSource, extractable?: boolean): Promise<Pbkdf2ProxiedKeyMaterial>

    +

    Parameters

    Returns Promise<HmacCryptoKey | AesCryptoKeys>

    source

    (format: KeyFormat, key: BufferSource, extractable?: boolean): Promise<Pbkdf2ProxiedKeyMaterial>

    Generate key material for deriving

    example
    const keyMaterial = await PBKDF2.generateKeyMaterial("raw", new TextEncoder().encode("could_be_a_little_entropy"));
    diff --git a/modules/kdf_shared.Alg.html b/modules/kdf_shared.Alg.html index efeb49e..87643f4 100644 --- a/modules/kdf_shared.Alg.html +++ b/modules/kdf_shared.Alg.html @@ -1 +1 @@ -Alg | @nfen/webcrypto-ts

    Namespace kdf/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Variant
    \ No newline at end of file +Alg | @nfen/webcrypto-ts

    Namespace kdf/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Variant
    \ No newline at end of file diff --git a/modules/kdf_shared.KdfShared.html b/modules/kdf_shared.KdfShared.html index 590eb3b..d66977e 100644 --- a/modules/kdf_shared.KdfShared.html +++ b/modules/kdf_shared.KdfShared.html @@ -1 +1 @@ -KdfShared | @nfen/webcrypto-ts

    Namespace kdf/shared.KdfShared

    source · [−]

    Functions

    source

    (algorithm: EnforcedPbkdf2Params | EnforcedHkdfParams, baseKey: Pbkdf2KeyMaterial | HkdfKeyMaterial, length: number): Promise<ArrayBuffer>

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: EnforcedPbkdf2Params | EnforcedHkdfParams, baseKey: Pbkdf2KeyMaterial | HkdfKeyMaterial, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCryptoKeys | HmacCryptoKey>

    Parameters

    Returns Promise<AesCryptoKeys | HmacCryptoKey>

    source

    <K>(format: KeyFormat, key: BufferSource, algorithm: "PBKDF2" | "HKDF", extractable?: boolean): Promise<K>

    Type Parameters

    • K extends CryptoKey

    Parameters

    • format: KeyFormat
    • key: BufferSource
    • algorithm: "PBKDF2" | "HKDF"
    • extractable: boolean = false

    Returns Promise<K>

    \ No newline at end of file +KdfShared | @nfen/webcrypto-ts

    Namespace kdf/shared.KdfShared

    source · [−]

    Functions

    source

    (algorithm: EnforcedPbkdf2Params | EnforcedHkdfParams, baseKey: Pbkdf2KeyMaterial | HkdfKeyMaterial, length: number): Promise<ArrayBuffer>

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: EnforcedPbkdf2Params | EnforcedHkdfParams, baseKey: Pbkdf2KeyMaterial | HkdfKeyMaterial, derivedKeyType: EnforcedHmacKeyGenParams | EnforcedAesKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<AesCryptoKeys | HmacCryptoKey>

    Parameters

    Returns Promise<AesCryptoKeys | HmacCryptoKey>

    source

    <K>(format: KeyFormat, key: BufferSource, algorithm: "PBKDF2" | "HKDF", extractable?: boolean): Promise<K>

    Type Parameters

    • K extends CryptoKey

    Parameters

    • format: KeyFormat
    • key: BufferSource
    • algorithm: "PBKDF2" | "HKDF"
    • extractable: boolean = false

    Returns Promise<K>

    \ No newline at end of file diff --git a/modules/kdf_shared.html b/modules/kdf_shared.html index 4f83638..4aee3c5 100644 --- a/modules/kdf_shared.html +++ b/modules/kdf_shared.html @@ -1,3 +1,3 @@ -kdf/shared | @nfen/webcrypto-ts

    Module kdf/shared

    source · [−]
    Expand description
    +kdf/shared | @nfen/webcrypto-ts

    Module kdf/shared

    source · [−]
    Expand description

    Shared code for KDF

    Namespaces

    Alg
    KdfShared

    Interfaces

    HkdfKeyMaterial
    HkdfProxiedKeyMaterial
    Pbkdf2KeyMaterial
    Pbkdf2ProxiedKeyMaterial
    \ No newline at end of file diff --git a/modules/key_usages.html b/modules/key_usages.html index 9921998..da17bf4 100644 --- a/modules/key_usages.html +++ b/modules/key_usages.html @@ -1,5 +1,5 @@ -key_usages | @nfen/webcrypto-ts

    Module key_usages

    source · [−]
    Expand description
    +key_usages | @nfen/webcrypto-ts

    Module key_usages

    source · [−]
    Expand description

    Key usages and allowed formats

    -

    Type Aliases

    Variables

    Functions

    source

    (alg: string): KeyUsagePair

    +

    Type Aliases

    Variables

    Functions

    source

    (alg: string): KeyUsagePair

    Given a algorithm, return the most likely key usage pair.

    Parameters

    • alg: string

    Returns KeyUsagePair

    Enumerations

    KeyFormats
    KeyUsages
    \ No newline at end of file diff --git a/modules/params.html b/modules/params.html index a437d36..05dbcdb 100644 --- a/modules/params.html +++ b/modules/params.html @@ -1,3 +1,3 @@ -params | @nfen/webcrypto-ts

    Module params

    source · [−]
    Expand description
    +params | @nfen/webcrypto-ts

    Module params

    source · [−]
    Expand description

    Enforced parameters for algorithms

    -

    Type Aliases

    Interfaces

    AesCbcKeyAlgorithm
    AesCtrKeyAlgorithm
    AesGcmKeyAlgorithm
    AesKwKeyAlgorithm
    EnforcedAesCbcParams
    EnforcedAesCtrParams
    EnforcedAesGcmParams
    EnforcedAesKeyGenParams
    EnforcedAesKwParams
    EnforcedEcKeyGenParams
    EnforcedEcKeyImportParams
    EnforcedEcdhKeyDeriveParams
    EnforcedEcdsaParams
    EnforcedHkdfParams
    EnforcedHmacImportParams
    EnforcedHmacKeyGenParams
    EnforcedPbkdf2Params
    EnforcedRsaHashedImportParams
    EnforcedRsaHashedKeyGenParams
    EnforcedRsaOaepParams
    EnforcedRsaPssParams
    EnforcedRsassaPkcs1v15Params
    HmacKeyAlgorithm
    \ No newline at end of file +

    Type Aliases

    Interfaces

    AesCbcKeyAlgorithm
    AesCtrKeyAlgorithm
    AesGcmKeyAlgorithm
    AesKwKeyAlgorithm
    EnforcedAesCbcParams
    EnforcedAesCtrParams
    EnforcedAesGcmParams
    EnforcedAesKeyGenParams
    EnforcedAesKwParams
    EnforcedEcKeyGenParams
    EnforcedEcKeyImportParams
    EnforcedEcdhKeyDeriveParams
    EnforcedEcdsaParams
    EnforcedHkdfParams
    EnforcedHmacImportParams
    EnforcedHmacKeyGenParams
    EnforcedPbkdf2Params
    EnforcedRsaHashedImportParams
    EnforcedRsaHashedKeyGenParams
    EnforcedRsaOaepParams
    EnforcedRsaPssParams
    EnforcedRsassaPkcs1v15Params
    HmacKeyAlgorithm
    \ No newline at end of file diff --git a/modules/proxy.html b/modules/proxy.html index 023a1ef..063f6cc 100644 --- a/modules/proxy.html +++ b/modules/proxy.html @@ -1,3 +1,3 @@ -proxy | @nfen/webcrypto-ts

    Module proxy

    source · [−]
    Expand description
    +proxy | @nfen/webcrypto-ts

    Module proxy

    source · [−]
    Expand description

    Code related to proxying CryptoKey and CryptoKeyPair

    -

    Functions

    source

    <TKey, TProxKey>(handler: ProxyHandler<TKey>): ((key: TKey) => TProxKey)

    Type Parameters

    Parameters

    • handler: ProxyHandler<TKey>

    Returns ((key: TKey) => TProxKey)

      • (key: TKey): TProxKey

      • Parameters

        • key: TKey

        Returns TProxKey

    source

    <TKeyPair, TPrivKey, TProxPrivKey, TPubKey, TProxPubKey>(__namedParameters: ProxyKeyPairHandlers<TPrivKey, TPubKey>): ((keyPair: TKeyPair) => ProxiedCryptoKeyPair<TKeyPair, TPrivKey, TProxPrivKey, TPubKey, TProxPubKey>)

    Type Parameters

    • TKeyPair extends CryptoKeyPair

    • TPrivKey extends CryptoKey

    • TProxPrivKey extends ProxiedCryptoKey<TPrivKey, TProxPrivKey>

    • TPubKey extends CryptoKey

    • TProxPubKey extends ProxiedCryptoKey<TPubKey, TProxPubKey>

    Parameters

    Returns ((keyPair: TKeyPair) => ProxiedCryptoKeyPair<TKeyPair, TPrivKey, TProxPrivKey, TPubKey, TProxPubKey>)

      • Parameters

        • keyPair: TKeyPair

        Returns ProxiedCryptoKeyPair<TKeyPair, TPrivKey, TProxPrivKey, TPubKey, TProxPubKey>

    Interfaces

    ProxiedCryptoKey
    ProxiedCryptoKeyPair
    ProxyKeyPairHandlers
    \ No newline at end of file +

    Functions

    source

    <TKey, TProxKey>(handler: ProxyHandler<TKey>): ((key: TKey) => TProxKey)

    Type Parameters

    Parameters

    • handler: ProxyHandler<TKey>

    Returns ((key: TKey) => TProxKey)

      • (key: TKey): TProxKey

      • Parameters

        • key: TKey

        Returns TProxKey

    source

    <TKeyPair, TPrivKey, TProxPrivKey, TPubKey, TProxPubKey>(__namedParameters: ProxyKeyPairHandlers<TPrivKey, TPubKey>): ((keyPair: TKeyPair) => ProxiedCryptoKeyPair<TKeyPair, TPrivKey, TProxPrivKey, TPubKey, TProxPubKey>)

    Type Parameters

    • TKeyPair extends CryptoKeyPair

    • TPrivKey extends CryptoKey

    • TProxPrivKey extends ProxiedCryptoKey<TPrivKey, TProxPrivKey>

    • TPubKey extends CryptoKey

    • TProxPubKey extends ProxiedCryptoKey<TPubKey, TProxPubKey>

    Parameters

    Returns ((keyPair: TKeyPair) => ProxiedCryptoKeyPair<TKeyPair, TPrivKey, TProxPrivKey, TPubKey, TProxPubKey>)

      • Parameters

        • keyPair: TKeyPair

        Returns ProxiedCryptoKeyPair<TKeyPair, TPrivKey, TProxPrivKey, TPubKey, TProxPubKey>

    Interfaces

    ProxiedCryptoKey
    ProxiedCryptoKeyPair
    ProxyKeyPairHandlers
    \ No newline at end of file diff --git a/modules/random.IV.html b/modules/random.IV.html index 57f2d47..540a74b 100644 --- a/modules/random.IV.html +++ b/modules/random.IV.html @@ -1,6 +1,6 @@ -IV | @nfen/webcrypto-ts

    Namespace random.IV

    source · [−]
    Expand description
    +IV | @nfen/webcrypto-ts

    Namespace random.IV

    source · [−]
    Expand description

    Initialization Vectors

    -

    Functions

    source

    (length?: number): Promise<Uint8Array>

    +

    Functions

    source

    (length?: number): Promise<Uint8Array>

    Generate an initialization vector. Defaults to 16 bytes.

    example
    const iv = await Random.IV.generate();
    diff --git a/modules/random.Salt.html b/modules/random.Salt.html index 66b652b..fb3fa90 100644 --- a/modules/random.Salt.html +++ b/modules/random.Salt.html @@ -1,6 +1,6 @@ -Salt | @nfen/webcrypto-ts

    Namespace random.Salt

    source · [−]
    Expand description
    +Salt | @nfen/webcrypto-ts

    Namespace random.Salt

    source · [−]
    Expand description

    Salts

    -

    Functions

    source

    (length?: number): Promise<Uint8Array>

    +

    Functions

    source

    (length?: number): Promise<Uint8Array>

    Generate a salt. Defaults to 16 bytes.

    example
    const salt = await Random.Salt.generate();
    diff --git a/modules/random.UUID.html b/modules/random.UUID.html index cfe3abf..a2f08e5 100644 --- a/modules/random.UUID.html +++ b/modules/random.UUID.html @@ -1,6 +1,6 @@ -UUID | @nfen/webcrypto-ts

    Namespace random.UUID

    source · [−]
    Expand description
    +UUID | @nfen/webcrypto-ts

    Namespace random.UUID

    source · [−]
    Expand description

    UUID

    -

    Functions

    source

    (): Promise<string>

    +

    Functions

    source

    (): Promise<string>

    Generate a UUID.

    example
    const uuid = await Random.UUID.generate();
    diff --git a/modules/random.html b/modules/random.html index 711e122..312ec84 100644 --- a/modules/random.html +++ b/modules/random.html @@ -1,6 +1,6 @@ -random | @nfen/webcrypto-ts

    Module random

    source · [−]
    Expand description
    +random | @nfen/webcrypto-ts

    Module random

    source · [−]
    Expand description

    Cryptographically strong random values.

    -

    Functions

    source

    (length: number): Promise<Uint8Array>

    +

    Functions

    source

    (length: number): Promise<Uint8Array>

    Generate random values

    example
    const values = await Random.getValues(16);
    diff --git a/modules/rsa.html b/modules/rsa.html index 94bdd7b..dd01391 100644 --- a/modules/rsa.html +++ b/modules/rsa.html @@ -1,3 +1,3 @@ -rsa | @nfen/webcrypto-ts

    Module rsa

    source · [−]
    Expand description
    +rsa | @nfen/webcrypto-ts

    Module rsa

    source · [−]
    Expand description

    All RSA algorithms

    -

    References

    Re-exports Alg
    Renames and re-exports rsa/rsassa_pkcs1_v1_5
    Renames and re-exports rsa/rsa_oaep
    Renames and re-exports rsa/rsa_pss
    Re-exports RsaCryptoKeyPairs
    Re-exports RsaCryptoKeys
    Re-exports RsaOaepCryptoKeyPair
    Re-exports RsaOaepPrivCryptoKey
    Re-exports RsaOaepProxiedCryptoKeyPair
    Re-exports RsaOaepProxiedPrivCryptoKey
    Re-exports RsaOaepProxiedPubCryptoKey
    Re-exports RsaOaepPubCryptoKey
    Re-exports RsaPssCryptoKeyPair
    Re-exports RsaPssPrivCryptoKey
    Re-exports RsaPssProxiedCryptoKeyPair
    Re-exports RsaPssProxiedPrivCryptoKey
    Re-exports RsaPssProxiedPubCryptoKey
    Re-exports RsaPssPubCryptoKey
    Re-exports RsassaPkcs1V15CryptoKeyPair
    Re-exports RsassaPkcs1V15PrivCryptoKey
    Re-exports RsassaPkcs1V15ProxiedCryptoKeyPair
    Re-exports RsassaPkcs1V15ProxiedPrivCryptoKey
    Re-exports RsassaPkcs1V15ProxiedPubCryptoKey
    Re-exports RsassaPkcs1V15PubCryptoKey
    \ No newline at end of file +

    References

    Re-exports Alg
    Renames and re-exports rsa/rsassa_pkcs1_v1_5
    Renames and re-exports rsa/rsa_oaep
    Renames and re-exports rsa/rsa_pss
    Re-exports RsaCryptoKeyPairs
    Re-exports RsaCryptoKeys
    Re-exports RsaOaepCryptoKeyPair
    Re-exports RsaOaepPrivCryptoKey
    Re-exports RsaOaepProxiedCryptoKeyPair
    Re-exports RsaOaepProxiedPrivCryptoKey
    Re-exports RsaOaepProxiedPubCryptoKey
    Re-exports RsaOaepPubCryptoKey
    Re-exports RsaPssCryptoKeyPair
    Re-exports RsaPssPrivCryptoKey
    Re-exports RsaPssProxiedCryptoKeyPair
    Re-exports RsaPssProxiedPrivCryptoKey
    Re-exports RsaPssProxiedPubCryptoKey
    Re-exports RsaPssPubCryptoKey
    Re-exports RsassaPkcs1V15CryptoKeyPair
    Re-exports RsassaPkcs1V15PrivCryptoKey
    Re-exports RsassaPkcs1V15ProxiedCryptoKeyPair
    Re-exports RsassaPkcs1V15ProxiedPrivCryptoKey
    Re-exports RsassaPkcs1V15ProxiedPubCryptoKey
    Re-exports RsassaPkcs1V15PubCryptoKey
    \ No newline at end of file diff --git a/modules/rsa_rsa_oaep.html b/modules/rsa_rsa_oaep.html index 979c496..5dbe08a 100644 --- a/modules/rsa_rsa_oaep.html +++ b/modules/rsa_rsa_oaep.html @@ -1,24 +1,24 @@ -rsa/rsa_oaep | @nfen/webcrypto-ts

    Module rsa/rsa_oaep

    source · [−]
    Expand description
    +rsa/rsa_oaep | @nfen/webcrypto-ts

    Module rsa/rsa_oaep

    source · [−]
    Expand description

    Code related to RSA_OAEP

    -

    Functions

    source

    (algorithm?: Omit<EnforcedRsaOaepParams, "name">, key: RsaOaepPrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    +

    Functions

    source

    (algorithm?: Omit<EnforcedRsaOaepParams, "name">, key: RsaOaepPrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    Decrypt with an RSA_OAEP private key

    example
    const data = await RSA_OAEP.decrypt({label}, keyPair.privateKey.self, data);
    example
    const data = await keyPair.privateKey.decrypt({label}, data);
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm?: Omit<EnforcedRsaOaepParams, "name">, key: RsaOaepPubCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm?: Omit<EnforcedRsaOaepParams, "name">, key: RsaOaepPubCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    Encrypt with an RSA_OAEP public key

    example
    const message = new TextEncoder().encode("a message");
    const data = await RSA_OAEP.encrypt({label}, keyPair.publicKey.self, message);
    example
    const message = new TextEncoder().encode("a message");
    const data = await keyPair.publicKey.encrypt({label}, message);
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (format: KeyFormat, key: RsaOaepPubCryptoKey | RsaOaepPrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (format: KeyFormat, key: RsaOaepPubCryptoKey | RsaOaepPrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    Export an RSA_OAEP public or private key

    example
    const pubKeyJwk = await RSA_OAEP.exportKey("jwk", keyPair.publicKey.self);
    example
    const pubKeyJwk = await keyPair.publicKey.exportKey("jwk");
    const privKeyJwk = await keyPair.privateKey.exportKey("jwk");
    -

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaOaepProxiedCryptoKeyPair>

    +

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaOaepProxiedCryptoKeyPair>

    Generate a new RSA_OAEP keypair

    example
    const keyPair = await RSA_OAEP.generateKey();
    @@ -26,7 +26,7 @@ hash: SHA.Variant.SHA_512, modulusLength: 4096, publicExponent: new Uint8Array([0x01, 0x00, 0x01]), -}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsaOaepProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaOaepProxiedCryptoKeyPair>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsaOaepProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaOaepProxiedCryptoKeyPair>

    Generate a new RSA_OAEP keypair

    alias

    generateKey

    example
    const keyPair = await RSA_OAEP.generateKeyPair();
@@ -35,17 +35,17 @@
     hash: SHA.Variant.SHA_512,
     modulusLength: 4096,
     publicExponent: new Uint8Array([0x01, 0x00, 0x01]),
-}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]
    • Returns Promise<RsaOaepProxiedCryptoKeyPair>
    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<EnforcedRsaHashedImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaOaepProxiedPubCryptoKey | RsaOaepProxiedPrivCryptoKey>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsaOaepProxiedCryptoKeyPair>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<EnforcedRsaHashedImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaOaepProxiedPubCryptoKey | RsaOaepProxiedPrivCryptoKey>

    Import an RSA_OAEP public or private key

    example
    const key = await RSA_OAEP.importKey("jwk", pubKey, { hash: "SHA-512" }, true, ['encrypt']);
    -

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedRsaHashedImportParams, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<RsaOaepProxiedPubCryptoKey | RsaOaepProxiedPrivCryptoKey>

    source

    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: RsaOaepPrivCryptoKey, unwrappingKeyAlgorithm: Omit<EnforcedRsaOaepParams, "name">, extractable?: boolean, keyUsages?: KeyUsagePairs): Promise<CryptoKey>

    +

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedRsaHashedImportParams, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<RsaOaepProxiedPubCryptoKey | RsaOaepProxiedPrivCryptoKey>

    source

    (format: KeyFormat, wrappedKey: BufferSource, wrappedKeyAlgorithm: EnforcedImportParams, unwrappingKey: RsaOaepPrivCryptoKey, unwrappingKeyAlgorithm: Omit<EnforcedRsaOaepParams, "name">, extractable?: boolean, keyUsages?: KeyUsagePairs): Promise<CryptoKey>

    Unwrap a wrapped key using the key encryption key

    example
    const wrappedKey = await RSA_OAEP.wrapKey("raw", dek.self, kek.self);
    const unwrappedKey = await RSA_OAEP.unwrapKey(
       "raw",
       wrappedKey,
       { name: Alg.Mode.RSA_OAEP },
       kek.self,
    );
 
    const wrappedKey = await kek.wrapKey("raw", dek.self);
    const unwrappedKey = await kek.unwrapKey(
       "raw",
       wrappedKey,
       { name: Alg.Mode.RSA_OAEP },
    );
    -

    Parameters

    Returns Promise<CryptoKey>

    source

    (format: KeyFormat, key: CryptoKey, wrappingkey: RsaOaepPubCryptoKey, wrapAlgorithm?: Omit<EnforcedRsaOaepParams, "name">): Promise<ArrayBuffer>

    +

    Parameters

    Returns Promise<CryptoKey>

    source

    (format: KeyFormat, key: CryptoKey, wrappingkey: RsaOaepPubCryptoKey, wrapAlgorithm?: Omit<EnforcedRsaOaepParams, "name">): Promise<ArrayBuffer>

    Wrap another key with an RSA_OAEP public key

    example
    const kek = await RSA_OAEP.generateKey(undefined, true, ['wrapKey', 'unwrapKey']);
    const dek = await RSA_OAEP.generateKey();
    const label = await Random.getValues(8);
    const wrappedKey = await RSA_OAEP.wrapKey("raw", dek.self, kek.self, {label});
    diff --git a/modules/rsa_rsa_pss.html b/modules/rsa_rsa_pss.html index bf75ed0..ac2d530 100644 --- a/modules/rsa_rsa_pss.html +++ b/modules/rsa_rsa_pss.html @@ -1,12 +1,12 @@ -rsa/rsa_pss | @nfen/webcrypto-ts

    Module rsa/rsa_pss

    source · [−]
    Expand description
    +rsa/rsa_pss | @nfen/webcrypto-ts

    Module rsa/rsa_pss

    source · [−]
    Expand description

    Code related to RSA_PSS

    -

    Functions

    source

    (format: KeyFormat, key: RsaPssPubCryptoKey | RsaPssPrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    +

    Functions

    source

    (format: KeyFormat, key: RsaPssPubCryptoKey | RsaPssPrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    Export an RSA_PSS public or private key

    example
    const pubKeyJwk = await RSA_PSS.importKey("jwk", keyPair.publicKey.self);
    example
    const pubKeyJwk = await keyPair.publicKey.importKey("jwk");
    -

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaPssProxiedCryptoKeyPair>

    +

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaPssProxiedCryptoKeyPair>

    Generate a new RSA_PSS keypair

    example
    const keyPair = await RSA_PSS.generateKey();
    @@ -14,7 +14,7 @@ hash: SHA.Variant.SHA_512, modulusLength: 4096, publicExponent: new Uint8Array([0x01, 0x00, 0x01]), -}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsaPssProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaPssProxiedCryptoKeyPair>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsaPssProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaPssProxiedCryptoKeyPair>

    Generate a new RSA_PSS keypair

    alias

    generateKey

    example
    const keyPair = await RSA_PSS.generateKeyPair();
@@ -23,17 +23,17 @@
     hash: SHA.Variant.SHA_512,
     modulusLength: 4096,
     publicExponent: new Uint8Array([0x01, 0x00, 0x01]),
-}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]
    • Returns Promise<RsaPssProxiedCryptoKeyPair>
    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<EnforcedRsaHashedImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaPssProxiedPubCryptoKey | RsaPssProxiedPrivCryptoKey>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsaPssProxiedCryptoKeyPair>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<EnforcedRsaHashedImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaPssProxiedPubCryptoKey | RsaPssProxiedPrivCryptoKey>

    Import an RSA_PSS public or private key

    example
    const key = await RSA_PSS.importKey("jwk", pubKey, { hash: "SHA-512" }, true, ['verify']);
    -

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedRsaHashedImportParams, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<RsaPssProxiedPubCryptoKey | RsaPssProxiedPrivCryptoKey>

    source

    (saltLength: number, key: RsaPssPrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    +

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedRsaHashedImportParams, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<RsaPssProxiedPubCryptoKey | RsaPssProxiedPrivCryptoKey>

    source

    (saltLength: number, key: RsaPssPrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    Sign a given payload

    example
    const message = new TextEncoder().encode("a message");
    const signature = await RSA_PSS.sign(128, keyPair.privateKey.self, message);
    example
    const message = new TextEncoder().encode("a message");
    const signature = await keyPair.privateKey.sign(128, message);
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (saltLength: number, key: RsaPssPubCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (saltLength: number, key: RsaPssPubCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    Verify a given signature

    example
    const message = new TextEncoder().encode("a message");
    const isVerified = await ECDSA.verify(128, keyPair.publicKey.self, signature, message);
    diff --git a/modules/rsa_rsassa_pkcs1_v1_5.html b/modules/rsa_rsassa_pkcs1_v1_5.html index e612b54..419b674 100644 --- a/modules/rsa_rsassa_pkcs1_v1_5.html +++ b/modules/rsa_rsassa_pkcs1_v1_5.html @@ -1,12 +1,12 @@ -rsa/rsassa_pkcs1_v1_5 | @nfen/webcrypto-ts

    Module rsa/rsassa_pkcs1_v1_5

    source · [−]
    Expand description
    +rsa/rsassa_pkcs1_v1_5 | @nfen/webcrypto-ts

    Module rsa/rsassa_pkcs1_v1_5

    source · [−]
    Expand description

    Code related to RSASSA_PKCS1_v1_5

    -

    Functions

    source

    (format: KeyFormat, key: RsassaPkcs1V15PubCryptoKey | RsassaPkcs1V15PrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    +

    Functions

    source

    (format: KeyFormat, key: RsassaPkcs1V15PubCryptoKey | RsassaPkcs1V15PrivCryptoKey): Promise<ArrayBuffer | JsonWebKey>

    Export an RSASSA_PKCS1_v1_5 public or private key

    example
    const pubKeyJwk = await RSASSA_PKCS1_v1_5.importKey("jwk", keyPair.publicKey.self);
    example
    const pubKeyJwk = await keyPair.publicKey.importKey("jwk");
    -

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsassaPkcs1V15ProxiedCryptoKeyPair>

    +

    Parameters

    Returns Promise<ArrayBuffer | JsonWebKey>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsassaPkcs1V15ProxiedCryptoKeyPair>

    Generate a new RSASSA_PKCS1_v1_5 keypair

    example
    const keyPair = await RSASSA_PKCS1_v1_5.generateKey();
    @@ -14,7 +14,7 @@ hash: SHA.Variant.SHA_512, modulusLength: 4096, publicExponent: new Uint8Array([0x01, 0x00, 0x01]), -}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsassaPkcs1V15ProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsassaPkcs1V15ProxiedCryptoKeyPair>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsassaPkcs1V15ProxiedCryptoKeyPair>

    source

    (algorithm?: Omit<EnforcedRsaHashedKeyGenParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsassaPkcs1V15ProxiedCryptoKeyPair>

    Generate a new RSASSA_PKCS1_v1_5 keypair

    alias

    generateKey

    example
    const keyPair = await RSASSA_PKCS1_v1_5.generateKeyPair();
@@ -23,17 +23,17 @@
     hash: SHA.Variant.SHA_512,
     modulusLength: 4096,
     publicExponent: new Uint8Array([0x01, 0x00, 0x01]),
-}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]
    • Returns Promise<RsassaPkcs1V15ProxiedCryptoKeyPair>
    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<EnforcedRsaHashedImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsassaPkcs1V15ProxiedPubCryptoKey | RsassaPkcs1V15ProxiedPrivCryptoKey>

    +}
  • Optional extractable: boolean
  • Optional keyUsages: KeyUsage[]

    • Returns Promise<RsassaPkcs1V15ProxiedCryptoKeyPair>

    source

    (format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: Omit<EnforcedRsaHashedImportParams, "name">, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsassaPkcs1V15ProxiedPubCryptoKey | RsassaPkcs1V15ProxiedPrivCryptoKey>

    Import an RSASSA_PKCS1_v1_5 public or private key

    example
    const key = await RSASSA_PKCS1_v1_5.importKey("jwk", pubKey, { hash: "SHA-512" }, true, ['verify']);
    -

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedRsaHashedImportParams, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<RsassaPkcs1V15ProxiedPubCryptoKey | RsassaPkcs1V15ProxiedPrivCryptoKey>

    source

    (key: RsassaPkcs1V15PrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    +

    Parameters

    • format: KeyFormat
    • key: BufferSource | JsonWebKey
    • algorithm: Omit<EnforcedRsaHashedImportParams, "name">
    • Optional extractable: boolean
    • Optional keyUsages: KeyUsage[]

    Returns Promise<RsassaPkcs1V15ProxiedPubCryptoKey | RsassaPkcs1V15ProxiedPrivCryptoKey>

    source

    (key: RsassaPkcs1V15PrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    Sign a given payload

    example
    const message = new TextEncoder().encode("a message");
    const signature = await RSASSA_PKCS1_v1_5.sign(keyPair.privateKey.self, message);
    example
    const message = new TextEncoder().encode("a message");
    const signature = await keyPair.privateKey.sign(message);
    -

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (key: RsassaPkcs1V15PubCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    +

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (key: RsassaPkcs1V15PubCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    Verify a given signature

    example
    const message = new TextEncoder().encode("a message");
    const isVerified = await RSASSA_PKCS1_v1_5.verify(keyPair.publicKey.self, signature, message);
    diff --git a/modules/rsa_shared.Alg.html b/modules/rsa_shared.Alg.html index 2dca9fe..d122d57 100644 --- a/modules/rsa_shared.Alg.html +++ b/modules/rsa_shared.Alg.html @@ -1 +1 @@ -Alg | @nfen/webcrypto-ts

    Namespace rsa/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Variant
    \ No newline at end of file +Alg | @nfen/webcrypto-ts

    Namespace rsa/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Variant
    \ No newline at end of file diff --git a/modules/rsa_shared.RsaShared.html b/modules/rsa_shared.RsaShared.html index 19ad02c..d67a0e0 100644 --- a/modules/rsa_shared.RsaShared.html +++ b/modules/rsa_shared.RsaShared.html @@ -1 +1 @@ -RsaShared | @nfen/webcrypto-ts

    Namespace rsa/shared.RsaShared

    source · [−]

    Functions

    source

    <T>(format: KeyFormat, key: T): Promise<JsonWebKey | ArrayBuffer>

    Type Parameters

    Parameters

    • format: KeyFormat
    • key: T

    Returns Promise<JsonWebKey | ArrayBuffer>

    source

    (algorithm: EnforcedRsaHashedKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaCryptoKeys | RsaCryptoKeyPairs>

    Parameters

    Returns Promise<RsaCryptoKeys | RsaCryptoKeyPairs>

    source

    <T>(format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: EnforcedRsaHashedImportParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    Parameters

    Returns Promise<T>

    source

    (algorithm: EnforcedRsaPssParams | EnforcedRsassaPkcs1v15Params, key: RsaPssPrivCryptoKey | RsassaPkcs1V15PrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: EnforcedRsaPssParams | EnforcedRsassaPkcs1v15Params, key: RsaPssPubCryptoKey | RsassaPkcs1V15PubCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    Parameters

    Returns Promise<boolean>

    \ No newline at end of file +RsaShared | @nfen/webcrypto-ts

    Namespace rsa/shared.RsaShared

    source · [−]

    Functions

    source

    <T>(format: KeyFormat, key: T): Promise<JsonWebKey | ArrayBuffer>

    Type Parameters

    Parameters

    • format: KeyFormat
    • key: T

    Returns Promise<JsonWebKey | ArrayBuffer>

    source

    (algorithm: EnforcedRsaHashedKeyGenParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<RsaCryptoKeys | RsaCryptoKeyPairs>

    Parameters

    Returns Promise<RsaCryptoKeys | RsaCryptoKeyPairs>

    source

    <T>(format: KeyFormat, key: BufferSource | JsonWebKey, algorithm: EnforcedRsaHashedImportParams, extractable?: boolean, keyUsages?: KeyUsage[]): Promise<T>

    Type Parameters

    Parameters

    Returns Promise<T>

    source

    (algorithm: EnforcedRsaPssParams | EnforcedRsassaPkcs1v15Params, key: RsaPssPrivCryptoKey | RsassaPkcs1V15PrivCryptoKey, data: BufferSource): Promise<ArrayBuffer>

    Parameters

    Returns Promise<ArrayBuffer>

    source

    (algorithm: EnforcedRsaPssParams | EnforcedRsassaPkcs1v15Params, key: RsaPssPubCryptoKey | RsassaPkcs1V15PubCryptoKey, signature: BufferSource, data: BufferSource): Promise<boolean>

    Parameters

    Returns Promise<boolean>

    \ No newline at end of file diff --git a/modules/rsa_shared.html b/modules/rsa_shared.html index 1fc03c7..3b027f4 100644 --- a/modules/rsa_shared.html +++ b/modules/rsa_shared.html @@ -1,3 +1,3 @@ -rsa/shared | @nfen/webcrypto-ts

    Module rsa/shared

    source · [−]
    Expand description
    +rsa/shared | @nfen/webcrypto-ts

    Module rsa/shared

    source · [−]
    Expand description

    Shared code for RSA

    -

    Type Aliases

    Namespaces

    Alg
    RsaShared

    Interfaces

    RsaOaepCryptoKeyPair
    RsaOaepPrivCryptoKey
    RsaOaepProxiedCryptoKeyPair
    RsaOaepProxiedPrivCryptoKey
    RsaOaepProxiedPubCryptoKey
    RsaOaepPubCryptoKey
    RsaPssCryptoKeyPair
    RsaPssPrivCryptoKey
    RsaPssProxiedCryptoKeyPair
    RsaPssProxiedPrivCryptoKey
    RsaPssProxiedPubCryptoKey
    RsaPssPubCryptoKey
    RsassaPkcs1V15CryptoKeyPair
    RsassaPkcs1V15PrivCryptoKey
    RsassaPkcs1V15ProxiedCryptoKeyPair
    RsassaPkcs1V15ProxiedPrivCryptoKey
    RsassaPkcs1V15ProxiedPubCryptoKey
    RsassaPkcs1V15PubCryptoKey
    \ No newline at end of file +

    Type Aliases

    Namespaces

    Alg
    RsaShared

    Interfaces

    RsaOaepCryptoKeyPair
    RsaOaepPrivCryptoKey
    RsaOaepProxiedCryptoKeyPair
    RsaOaepProxiedPrivCryptoKey
    RsaOaepProxiedPubCryptoKey
    RsaOaepPubCryptoKey
    RsaPssCryptoKeyPair
    RsaPssPrivCryptoKey
    RsaPssProxiedCryptoKeyPair
    RsaPssProxiedPrivCryptoKey
    RsaPssProxiedPubCryptoKey
    RsaPssPubCryptoKey
    RsassaPkcs1V15CryptoKeyPair
    RsassaPkcs1V15PrivCryptoKey
    RsassaPkcs1V15ProxiedCryptoKeyPair
    RsassaPkcs1V15ProxiedPrivCryptoKey
    RsassaPkcs1V15ProxiedPubCryptoKey
    RsassaPkcs1V15PubCryptoKey
    \ No newline at end of file diff --git a/modules/sha.html b/modules/sha.html index 9c35f7f..3a16c63 100644 --- a/modules/sha.html +++ b/modules/sha.html @@ -1,3 +1,3 @@ -sha | @nfen/webcrypto-ts

    Module sha

    source · [−]
    Expand description
    +sha | @nfen/webcrypto-ts

    Module sha

    source · [−]
    Expand description

    All SHA algorithms

    -

    References

    Re-exports Alg
    Renames and re-exports sha/sha_1
    Renames and re-exports sha/sha_256
    Renames and re-exports sha/sha_384
    Renames and re-exports sha/sha_512
    \ No newline at end of file +

    References

    Re-exports Alg
    Renames and re-exports sha/sha_1
    Renames and re-exports sha/sha_256
    Renames and re-exports sha/sha_384
    Renames and re-exports sha/sha_512
    \ No newline at end of file diff --git a/modules/sha_sha_1.html b/modules/sha_sha_1.html index f79daef..84c9227 100644 --- a/modules/sha_sha_1.html +++ b/modules/sha_sha_1.html @@ -1,10 +1,10 @@ -sha/sha_1 | @nfen/webcrypto-ts

    Module sha/sha_1

    source · [−]
    Expand description
    +sha/sha_1 | @nfen/webcrypto-ts

    Module sha/sha_1

    source · [−]
    Expand description

    Code related to SHA_1

    -

    Functions

    source

    (data: BufferSource): Promise<Sha1ArrayBuffer>

    +

    Functions

    source

    (data: BufferSource): Promise<Sha1ArrayBuffer>

    Get the digest of the buffer

    example
    const buffer = new TextEncoder().encode("a file");
    const digest = SHA_1.digest(buffer);
    -

    Parameters

    • data: BufferSource

    Returns Promise<Sha1ArrayBuffer>

    source

    (digest: Sha1ArrayBuffer): string

    +

    Parameters

    • data: BufferSource

    Returns Promise<Sha1ArrayBuffer>

    source

    (digest: Sha1ArrayBuffer): string

    Get the hex string of the digest

    example
    const hash = SHA_1.hexify(digest);
    diff --git a/modules/sha_sha_256.html b/modules/sha_sha_256.html index 5ecf1cc..2d9e9a2 100644 --- a/modules/sha_sha_256.html +++ b/modules/sha_sha_256.html @@ -1,10 +1,10 @@ -sha/sha_256 | @nfen/webcrypto-ts

    Module sha/sha_256

    source · [−]
    Expand description
    +sha/sha_256 | @nfen/webcrypto-ts

    Module sha/sha_256

    source · [−]
    Expand description

    Code related to SHA_256

    -

    Functions

    source

    (data: BufferSource): Promise<Sha256ArrayBuffer>

    +

    Functions

    source

    (data: BufferSource): Promise<Sha256ArrayBuffer>

    Get the digest of the buffer

    example
    const buffer = new TextEncoder().encode("a file");
    const digest = SHA_256.digest(buffer);
    -

    Parameters

    • data: BufferSource

    Returns Promise<Sha256ArrayBuffer>

    source

    (digest: Sha256ArrayBuffer): string

    +

    Parameters

    • data: BufferSource

    Returns Promise<Sha256ArrayBuffer>

    source

    (digest: Sha256ArrayBuffer): string

    Get the hex string of the digest

    example
    const hash = SHA_256.hexify(digest);
    diff --git a/modules/sha_sha_384.html b/modules/sha_sha_384.html index e0a6ceb..b6010c7 100644 --- a/modules/sha_sha_384.html +++ b/modules/sha_sha_384.html @@ -1,10 +1,10 @@ -sha/sha_384 | @nfen/webcrypto-ts

    Module sha/sha_384

    source · [−]
    Expand description
    +sha/sha_384 | @nfen/webcrypto-ts

    Module sha/sha_384

    source · [−]
    Expand description

    Code related to SHA_384

    -

    Functions

    source

    (data: BufferSource): Promise<Sha384ArrayBuffer>

    +

    Functions

    source

    (data: BufferSource): Promise<Sha384ArrayBuffer>

    Get the digest of the buffer

    example
    const buffer = new TextEncoder().encode("a file");
    const digest = SHA_384.digest(buffer);
    -

    Parameters

    • data: BufferSource

    Returns Promise<Sha384ArrayBuffer>

    source

    (digest: Sha384ArrayBuffer): string

    +

    Parameters

    • data: BufferSource

    Returns Promise<Sha384ArrayBuffer>

    source

    (digest: Sha384ArrayBuffer): string

    Get the hex string of the digest

    example
    const hash = SHA_384.hexify(digest);
    diff --git a/modules/sha_sha_512.html b/modules/sha_sha_512.html index 68552be..2e08314 100644 --- a/modules/sha_sha_512.html +++ b/modules/sha_sha_512.html @@ -1,10 +1,10 @@ -sha/sha_512 | @nfen/webcrypto-ts

    Module sha/sha_512

    source · [−]
    Expand description
    +sha/sha_512 | @nfen/webcrypto-ts

    Module sha/sha_512

    source · [−]
    Expand description

    Code related to SHA_512

    -

    Functions

    source

    (data: BufferSource): Promise<Sha512ArrayBuffer>

    +

    Functions

    source

    (data: BufferSource): Promise<Sha512ArrayBuffer>

    Get the digest of the buffer

    example
    const buffer = new TextEncoder().encode("a file");
    const digest = SHA_512.digest(buffer);
    -

    Parameters

    • data: BufferSource

    Returns Promise<Sha512ArrayBuffer>

    source

    (digest: Sha512ArrayBuffer): string

    +

    Parameters

    • data: BufferSource

    Returns Promise<Sha512ArrayBuffer>

    source

    (digest: Sha512ArrayBuffer): string

    Get the hex string of the digest

    example
    const hash = SHA_512.hexify(digest);
    diff --git a/modules/sha_shared.Alg.html b/modules/sha_shared.Alg.html index d9e6fe3..38254a3 100644 --- a/modules/sha_shared.Alg.html +++ b/modules/sha_shared.Alg.html @@ -1 +1 @@ -Alg | @nfen/webcrypto-ts

    Namespace sha/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Variant
    \ No newline at end of file +Alg | @nfen/webcrypto-ts

    Namespace sha/shared.Alg

    source · [−]

    Type Aliases

    Enumerations

    Variant
    \ No newline at end of file diff --git a/modules/sha_shared.ShaShared.html b/modules/sha_shared.ShaShared.html index 9a0918f..874ebd9 100644 --- a/modules/sha_shared.ShaShared.html +++ b/modules/sha_shared.ShaShared.html @@ -1 +1 @@ -ShaShared | @nfen/webcrypto-ts

    Namespace sha/shared.ShaShared

    source · [−]

    Functions

    source

    (digest: ShaArrayBuffers): string

    Parameters

    Returns string

    \ No newline at end of file +ShaShared | @nfen/webcrypto-ts

    Namespace sha/shared.ShaShared

    source · [−]

    Functions

    source

    (digest: ShaArrayBuffers): string

    Parameters

    Returns string

    \ No newline at end of file diff --git a/modules/sha_shared.html b/modules/sha_shared.html index 609c78d..3aff28b 100644 --- a/modules/sha_shared.html +++ b/modules/sha_shared.html @@ -1,3 +1,3 @@ -sha/shared | @nfen/webcrypto-ts

    Module sha/shared

    source · [−]
    Expand description
    +sha/shared | @nfen/webcrypto-ts

    Module sha/shared

    source · [−]
    Expand description

    Shared code for SHA

    -

    Type Aliases

    Namespaces

    Alg
    ShaShared

    Interfaces

    Sha1ArrayBuffer
    Sha256ArrayBuffer
    Sha384ArrayBuffer
    Sha512ArrayBuffer
    \ No newline at end of file +

    Type Aliases

    Namespaces

    Alg
    ShaShared

    Interfaces

    Sha1ArrayBuffer
    Sha256ArrayBuffer
    Sha384ArrayBuffer
    Sha512ArrayBuffer
    \ No newline at end of file diff --git a/modules/webcrypto.html b/modules/webcrypto.html index 64b7028..5f29f61 100644 --- a/modules/webcrypto.html +++ b/modules/webcrypto.html @@ -1,5 +1,5 @@ -webcrypto | @nfen/webcrypto-ts

    Module webcrypto

    source · [−]
    Expand description
    +webcrypto | @nfen/webcrypto-ts

    Module webcrypto

    source · [−]
    Expand description

    Wrapper for node/browser webcrypto

    -

    Variables

    source

    _crypto

    source

    const _crypto: Promise<Crypto> = ...

    +

    Variables

    source

    _crypto

    source

    const _crypto: Promise<Crypto> = ...

    Crypto loader which loads native webcrypto depending on environment

    -

    Functions

    source

    <T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

    Parameters

    • algorithm: U
    • key: T
    • data: BufferSource

    Returns Promise<ArrayBuffer>

    source

    <T, U>(algorithm: U, baseKey: T, length: number): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params

    Parameters

    • algorithm: U
    • baseKey: T
    • length: number

    Returns Promise<ArrayBuffer>

    source

    <T, U>(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, key: CryptoKey, derivedKeyType: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | HkdfParams | Pbkdf2Params | AesDerivedKeyParams | HmacImportParams

    Parameters

    • algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params
    • key: CryptoKey
    • derivedKeyType: U
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T>(algorithm: "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512", data: BufferSource): Promise<T>

    Type Parameters

    • T extends ArrayBuffer

    Parameters

    • algorithm: "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512"
    • data: BufferSource

    Returns Promise<T>

    source

    <T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

    Parameters

    • algorithm: U
    • key: T
    • data: BufferSource

    Returns Promise<ArrayBuffer>

    source

    <T>(format: "jwk", key: T): Promise<JsonWebKey>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: "jwk"
    • key: T

    Returns Promise<JsonWebKey>

    source

    <T>(format: "pkcs8" | "raw" | "spki", key: T): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: "pkcs8" | "raw" | "spki"
    • key: T

    Returns Promise<ArrayBuffer>

    source

    <T, U>(algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey | CryptoKeyPair

    • U extends AlgorithmIdentifier | Pbkdf2Params | RsaHashedKeyGenParams | EcKeyGenParams | AesKeyGenParams | HmacKeyGenParams

    Parameters

    • algorithm: U
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T, U>(format: "jwk", key: JsonWebKey, algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

    Parameters

    • format: "jwk"
    • key: JsonWebKey
    • algorithm: U
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T, U>(format: "pkcs8" | "raw" | "spki", key: BufferSource, algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

    Parameters

    • format: "pkcs8" | "raw" | "spki"
    • key: BufferSource
    • algorithm: U
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaPssParams | EcdsaParams

    Parameters

    • algorithm: U
    • key: T
    • data: BufferSource

    Returns Promise<ArrayBuffer>

    source

    <T, U, V>(format: KeyFormat, wrappedKey: BufferSource, unwrappingKey: T, unwrapAlgorithm: U, unwrappedKeyAlgorithm: V, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

    • V extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

    Parameters

    • format: KeyFormat
    • wrappedKey: BufferSource
    • unwrappingKey: T
    • unwrapAlgorithm: U
    • unwrappedKeyAlgorithm: V
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<CryptoKey>

    source

    <T, U>(algorithm: U, key: T, signature: BufferSource, data: BufferSource): Promise<boolean>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaPssParams | EcdsaParams

    Parameters

    • algorithm: U
    • key: T
    • signature: BufferSource
    • data: BufferSource

    Returns Promise<boolean>

    source

    <T, U>(format: KeyFormat, key: CryptoKey, wrappingKey: T, wrapAlgorithm: U): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

    Parameters

    • format: KeyFormat
    • key: CryptoKey
    • wrappingKey: T
    • wrapAlgorithm: U

    Returns Promise<ArrayBuffer>

    \ No newline at end of file +

    Functions

    source

    <T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

    Parameters

    • algorithm: U
    • key: T
    • data: BufferSource

    Returns Promise<ArrayBuffer>

    source

    <T, U>(algorithm: U, baseKey: T, length: number): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params

    Parameters

    • algorithm: U
    • baseKey: T
    • length: number

    Returns Promise<ArrayBuffer>

    source

    <T, U>(algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params, key: CryptoKey, derivedKeyType: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | HkdfParams | Pbkdf2Params | AesDerivedKeyParams | HmacImportParams

    Parameters

    • algorithm: AlgorithmIdentifier | EcdhKeyDeriveParams | HkdfParams | Pbkdf2Params
    • key: CryptoKey
    • derivedKeyType: U
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T>(algorithm: "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512", data: BufferSource): Promise<T>

    Type Parameters

    • T extends ArrayBuffer

    Parameters

    • algorithm: "SHA-1" | "SHA-256" | "SHA-384" | "SHA-512"
    • data: BufferSource

    Returns Promise<T>

    source

    <T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

    Parameters

    • algorithm: U
    • key: T
    • data: BufferSource

    Returns Promise<ArrayBuffer>

    source

    <T>(format: "jwk", key: T): Promise<JsonWebKey>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: "jwk"
    • key: T

    Returns Promise<JsonWebKey>

    source

    <T>(format: "pkcs8" | "raw" | "spki", key: T): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    Parameters

    • format: "pkcs8" | "raw" | "spki"
    • key: T

    Returns Promise<ArrayBuffer>

    source

    <T, U>(algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey | CryptoKeyPair

    • U extends AlgorithmIdentifier | Pbkdf2Params | RsaHashedKeyGenParams | EcKeyGenParams | AesKeyGenParams | HmacKeyGenParams

    Parameters

    • algorithm: U
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T, U>(format: "jwk", key: JsonWebKey, algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

    Parameters

    • format: "jwk"
    • key: JsonWebKey
    • algorithm: U
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T, U>(format: "pkcs8" | "raw" | "spki", key: BufferSource, algorithm: U, extractable: boolean, keyUsages: KeyUsage[]): Promise<T>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

    Parameters

    • format: "pkcs8" | "raw" | "spki"
    • key: BufferSource
    • algorithm: U
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<T>

    source

    <T, U>(algorithm: U, key: T, data: BufferSource): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaPssParams | EcdsaParams

    Parameters

    • algorithm: U
    • key: T
    • data: BufferSource

    Returns Promise<ArrayBuffer>

    source

    <T, U, V>(format: KeyFormat, wrappedKey: BufferSource, unwrappingKey: T, unwrapAlgorithm: U, unwrappedKeyAlgorithm: V, extractable: boolean, keyUsages: KeyUsage[]): Promise<CryptoKey>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

    • V extends AlgorithmIdentifier | HmacImportParams | RsaHashedImportParams | EcKeyImportParams | AesKeyAlgorithm

    Parameters

    • format: KeyFormat
    • wrappedKey: BufferSource
    • unwrappingKey: T
    • unwrapAlgorithm: U
    • unwrappedKeyAlgorithm: V
    • extractable: boolean
    • keyUsages: KeyUsage[]

    Returns Promise<CryptoKey>

    source

    <T, U>(algorithm: U, key: T, signature: BufferSource, data: BufferSource): Promise<boolean>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaPssParams | EcdsaParams

    Parameters

    • algorithm: U
    • key: T
    • signature: BufferSource
    • data: BufferSource

    Returns Promise<boolean>

    source

    <T, U>(format: KeyFormat, key: CryptoKey, wrappingKey: T, wrapAlgorithm: U): Promise<ArrayBuffer>

    Type Parameters

    • T extends CryptoKey

    • U extends AlgorithmIdentifier | RsaOaepParams | AesCtrParams | AesCbcParams | AesGcmParams

    Parameters

    • format: KeyFormat
    • key: CryptoKey
    • wrappingKey: T
    • wrapAlgorithm: U

    Returns Promise<ArrayBuffer>

    \ No newline at end of file