diff --git a/chacha20poly1305/docs/classes/Chacha20Poly1305.html b/chacha20poly1305/docs/classes/Chacha20Poly1305.html index 52d10f118..06dd485a5 100644 --- a/chacha20poly1305/docs/classes/Chacha20Poly1305.html +++ b/chacha20poly1305/docs/classes/Chacha20Poly1305.html @@ -7,17 +7,17 @@

This class is implemented using @noble/ciphers.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

id keySize nonceSize tagSize

Methods

createEncryptionContext

Constructors

constructor

Properties

Readonlyid

id: AeadId = AeadId.Chacha20Poly1305

AeadId.Chacha20Poly1305 (0x0003)

-

ReadonlykeySize

keySize: number = 32

32

-

ReadonlynonceSize

nonceSize: number = 12

12

-

ReadonlytagSize

tagSize: number = 16

16

-

Methods

createEncryptionContext

  • createEncryptionContext(key): AeadEncryptionContext

  • Creates an AEAD encryption context which has seal/open operation.

    +

ReadonlykeySize

keySize: number = 32

32

+

ReadonlynonceSize

nonceSize: number = 12

12

+

ReadonlytagSize

tagSize: number = 16

16

+

Methods

createEncryptionContext

  • createEncryptionContext(key): AeadEncryptionContext

  • Creates an AEAD encryption context which has seal/open operation.

    Parameters

    • key: ArrayBuffer

      A byte string of the raw key.

    Returns AeadEncryptionContext

    An AEAD encryption context.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/common/docs/classes/DecapError.html b/common/docs/classes/DecapError.html index b0bbfdcae..261c5986d 100644 --- a/common/docs/classes/DecapError.html +++ b/common/docs/classes/DecapError.html @@ -1,7 +1,7 @@ DecapError | @hpke/common

Class DecapError

decap() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/DeriveKeyPairError.html b/common/docs/classes/DeriveKeyPairError.html index 9726aa0cd..8bda01de3 100644 --- a/common/docs/classes/DeriveKeyPairError.html +++ b/common/docs/classes/DeriveKeyPairError.html @@ -1,7 +1,7 @@ DeriveKeyPairError | @hpke/common

Class DeriveKeyPairError

Key pair derivation failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/DeserializeError.html b/common/docs/classes/DeserializeError.html index a6d164803..eaea6b304 100644 --- a/common/docs/classes/DeserializeError.html +++ b/common/docs/classes/DeserializeError.html @@ -1,7 +1,7 @@ DeserializeError | @hpke/common

Class DeserializeError

Public or private key deserialization failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/Dhkem.html b/common/docs/classes/Dhkem.html index 2b21e87fb..b739eba4b 100644 --- a/common/docs/classes/Dhkem.html +++ b/common/docs/classes/Dhkem.html @@ -1,5 +1,5 @@ Dhkem | @hpke/common

Class Dhkem

The KEM interface.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_kdf _prim encSize @@ -16,43 +16,43 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

ReadonlyencSize

encSize: number = 0

The length in bytes of an encapsulated key produced by this KEM (Nenc).

-

Readonlyid

id: KemId

The KEM identifier.

-

ReadonlyprivateKeySize

privateKeySize: number = 0

The length in bytes of an encoded private key for this KEM (Nsk).

-

ReadonlypublicKeySize

publicKeySize: number = 0

The length in bytes of an encoded public key for this KEM (Npk).

-

ReadonlysecretSize

secretSize: number = 0

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

-

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

ReadonlyencSize

encSize: number = 0

The length in bytes of an encapsulated key produced by this KEM (Nenc).

+

Readonlyid

id: KemId

The KEM identifier.

+

ReadonlyprivateKeySize

privateKeySize: number = 0

The length in bytes of an encoded private key for this KEM (Nsk).

+

ReadonlypublicKeySize

publicKeySize: number = 0

The length in bytes of an encoded public key for this KEM (Npk).

+

ReadonlysecretSize

secretSize: number = 0

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

+

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

deserializePrivateKey

deserializePrivateKey

deserializePublicKey

deserializePublicKey

encap

encap

generateKeyPair

generateKeyPair

importKey

importKey

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

serializePrivateKey

serializePublicKey

serializePublicKey

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/common/docs/classes/Ec.html b/common/docs/classes/Ec.html index a75ccacf4..91c5a34a5 100644 --- a/common/docs/classes/Ec.html +++ b/common/docs/classes/Ec.html @@ -1,4 +1,4 @@ -Ec | @hpke/common

Class Ec

Hierarchy (view full)

Implements

Constructors

constructor +Ec | @hpke/common

Class Ec

Hierarchy (view full)

Implements

Constructors

constructor

Properties

_api

Methods

_setup deriveKeyPair @@ -10,4 +10,4 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Methods

Protected_setup

deriveKeyPair

derivePublicKey

deserializePrivateKey

deserializePublicKey

dh

generateKeyPair

importKey

serializePrivateKey

serializePublicKey

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Methods

Protected_setup

deriveKeyPair

derivePublicKey

deserializePrivateKey

deserializePublicKey

dh

generateKeyPair

importKey

serializePrivateKey

serializePublicKey

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/common/docs/classes/EncapError.html b/common/docs/classes/EncapError.html index 633466db8..1073178c6 100644 --- a/common/docs/classes/EncapError.html +++ b/common/docs/classes/EncapError.html @@ -1,7 +1,7 @@ EncapError | @hpke/common

Class EncapError

encap() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/ExportError.html b/common/docs/classes/ExportError.html index eb61a8e02..94084b291 100644 --- a/common/docs/classes/ExportError.html +++ b/common/docs/classes/ExportError.html @@ -1,7 +1,7 @@ ExportError | @hpke/common

Class ExportError

Secret export failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/HkdfSha256Native.html b/common/docs/classes/HkdfSha256Native.html index d2f6277e7..ccccec0f0 100644 --- a/common/docs/classes/HkdfSha256Native.html +++ b/common/docs/classes/HkdfSha256Native.html @@ -1,4 +1,4 @@ -HkdfSha256Native | @hpke/common

Class HkdfSha256Native

Hierarchy

  • HkdfNative
    • HkdfSha256Native

Constructors

constructor +HkdfSha256Native | @hpke/common

Class HkdfSha256Native

Hierarchy

  • HkdfNative
    • HkdfSha256Native

Constructors

constructor

Properties

_api _suiteId algHash @@ -14,43 +14,43 @@ init labeledExpand labeledExtract -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

hashSize

hashSize: number = 32

32

-

id

id: KdfId = KdfId.HkdfSha256

KdfId.HkdfSha256 (0x0001)

-

Methods

Protected_checkInit

Protected_setup

  • _setup(): Promise<void>

  • Returns Promise<void>

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    +

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

hashSize

hashSize: number = 32

32

+

id

id: KdfId = KdfId.HkdfSha256

KdfId.HkdfSha256 (0x0001)

+

Methods

Protected_checkInit

Protected_setup

  • _setup(): Promise<void>

  • Returns Promise<void>

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    +

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    +

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    +

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    +

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

labeledExtract

labeledExtract

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/common/docs/classes/HkdfSha384Native.html b/common/docs/classes/HkdfSha384Native.html index 6513d9898..dd3b1a89f 100644 --- a/common/docs/classes/HkdfSha384Native.html +++ b/common/docs/classes/HkdfSha384Native.html @@ -1,4 +1,4 @@ -HkdfSha384Native | @hpke/common

Class HkdfSha384Native

Hierarchy

  • HkdfNative
    • HkdfSha384Native

Constructors

constructor +HkdfSha384Native | @hpke/common

Class HkdfSha384Native

Hierarchy

  • HkdfNative
    • HkdfSha384Native

Constructors

constructor

Properties

_api _suiteId algHash @@ -14,43 +14,43 @@ init labeledExpand labeledExtract -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

hashSize

hashSize: number = 48

48

-

id

id: KdfId = KdfId.HkdfSha384

KdfId.HkdfSha384 (0x0002)

-

Methods

Protected_checkInit

Protected_setup

  • _setup(): Promise<void>

  • Returns Promise<void>

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    +

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

hashSize

hashSize: number = 48

48

+

id

id: KdfId = KdfId.HkdfSha384

KdfId.HkdfSha384 (0x0002)

+

Methods

Protected_checkInit

Protected_setup

  • _setup(): Promise<void>

  • Returns Promise<void>

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    +

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    +

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    +

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    +

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

labeledExtract

labeledExtract

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/common/docs/classes/HkdfSha512Native.html b/common/docs/classes/HkdfSha512Native.html index bb4ba14f3..f8d884c25 100644 --- a/common/docs/classes/HkdfSha512Native.html +++ b/common/docs/classes/HkdfSha512Native.html @@ -1,4 +1,4 @@ -HkdfSha512Native | @hpke/common

Class HkdfSha512Native

Hierarchy

  • HkdfNative
    • HkdfSha512Native

Constructors

constructor +HkdfSha512Native | @hpke/common

Class HkdfSha512Native

Hierarchy

  • HkdfNative
    • HkdfSha512Native

Constructors

constructor

Properties

_api _suiteId algHash @@ -14,43 +14,43 @@ init labeledExpand labeledExtract -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

hashSize

hashSize: number = 64

64

-

id

id: KdfId = KdfId.HkdfSha512

KdfId.HkdfSha512 (0x0003)

-

Methods

Protected_checkInit

Protected_setup

  • _setup(): Promise<void>

  • Returns Promise<void>

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    +

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

hashSize

hashSize: number = 64

64

+

id

id: KdfId = KdfId.HkdfSha512

KdfId.HkdfSha512 (0x0003)

+

Methods

Protected_checkInit

Protected_setup

  • _setup(): Promise<void>

  • Returns Promise<void>

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    +

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    +

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    +

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    +

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

labeledExtract

labeledExtract

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/common/docs/classes/HpkeError.html b/common/docs/classes/HpkeError.html index 00fed986d..a0c2fcc25 100644 --- a/common/docs/classes/HpkeError.html +++ b/common/docs/classes/HpkeError.html @@ -1,7 +1,7 @@ HpkeError | @hpke/common

Class HpkeError

The base error class of hpke-js.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/Hybridkem.html b/common/docs/classes/Hybridkem.html index b17c98c61..6c0eaf7fa 100644 --- a/common/docs/classes/Hybridkem.html +++ b/common/docs/classes/Hybridkem.html @@ -1,5 +1,5 @@ Hybridkem | @hpke/common

Class Hybridkem

The KEM interface.

-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_a _b _kdf @@ -18,43 +18,43 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_a

_a: DhkemInterface

Protected_b

_b: KemInterface

Protected_kdf

_kdf: KdfInterface

ReadonlyencSize

encSize: number = 0

The length in bytes of an encapsulated key produced by this KEM (Nenc).

-

Readonlyid

id: KemId = KemId.NotAssigned

The KEM identifier.

-

Readonlyname

name: string = ""

ReadonlyprivateKeySize

privateKeySize: number = 0

The length in bytes of an encoded private key for this KEM (Nsk).

-

ReadonlypublicKeySize

publicKeySize: number = 0

The length in bytes of an encoded public key for this KEM (Npk).

-

ReadonlysecretSize

secretSize: number = 0

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

-

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_a

_a: DhkemInterface

Protected_b

_b: KemInterface

Protected_kdf

_kdf: KdfInterface

ReadonlyencSize

encSize: number = 0

The length in bytes of an encapsulated key produced by this KEM (Nenc).

+

Readonlyid

id: KemId = KemId.NotAssigned

The KEM identifier.

+

Readonlyname

name: string = ""

ReadonlyprivateKeySize

privateKeySize: number = 0

The length in bytes of an encoded private key for this KEM (Nsk).

+

ReadonlypublicKeySize

publicKeySize: number = 0

The length in bytes of an encoded public key for this KEM (Npk).

+

ReadonlysecretSize

secretSize: number = 0

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

+

Methods

decap

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

deserializePrivateKey

deserializePrivateKey

deserializePublicKey

deserializePublicKey

encap

encap

generateKeyPair

generateKeyPair

importKey

importKey

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

serializePrivateKey

serializePublicKey

serializePublicKey

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/common/docs/classes/InvalidParamError.html b/common/docs/classes/InvalidParamError.html index 5160f867c..cb4b0fc6d 100644 --- a/common/docs/classes/InvalidParamError.html +++ b/common/docs/classes/InvalidParamError.html @@ -1,7 +1,7 @@ InvalidParamError | @hpke/common

Class InvalidParamError

Invalid parameter.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/MessageLimitReachedError.html b/common/docs/classes/MessageLimitReachedError.html index cd7494d32..9289f5bff 100644 --- a/common/docs/classes/MessageLimitReachedError.html +++ b/common/docs/classes/MessageLimitReachedError.html @@ -1,7 +1,7 @@ MessageLimitReachedError | @hpke/common

Class MessageLimitReachedError

Sequence number overflow on the encryption context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/NativeAlgorithm.html b/common/docs/classes/NativeAlgorithm.html index df212981e..f328e3fa5 100644 --- a/common/docs/classes/NativeAlgorithm.html +++ b/common/docs/classes/NativeAlgorithm.html @@ -1,4 +1,4 @@ -NativeAlgorithm | @hpke/common

Class NativeAlgorithm

Hierarchy (view full)

  • NativeAlgorithm

Constructors

constructor +NativeAlgorithm | @hpke/common

Class NativeAlgorithm

Hierarchy (view full)

  • NativeAlgorithm

Constructors

constructor

Properties

_api

Methods

_setup -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Methods

Protected_setup

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Methods

Protected_setup

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/common/docs/classes/NotSupportedError.html b/common/docs/classes/NotSupportedError.html index 1a09d6c74..28ceec5e8 100644 --- a/common/docs/classes/NotSupportedError.html +++ b/common/docs/classes/NotSupportedError.html @@ -1,7 +1,7 @@ NotSupportedError | @hpke/common

Class NotSupportedError

Not supported failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/OpenError.html b/common/docs/classes/OpenError.html index 6ae24609e..d27942dc0 100644 --- a/common/docs/classes/OpenError.html +++ b/common/docs/classes/OpenError.html @@ -1,7 +1,7 @@ OpenError | @hpke/common

Class OpenError

open() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/SealError.html b/common/docs/classes/SealError.html index 7bbb13239..8a848e6df 100644 --- a/common/docs/classes/SealError.html +++ b/common/docs/classes/SealError.html @@ -1,7 +1,7 @@ SealError | @hpke/common

Class SealError

seal() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/SerializeError.html b/common/docs/classes/SerializeError.html index 626610776..729cd4ed3 100644 --- a/common/docs/classes/SerializeError.html +++ b/common/docs/classes/SerializeError.html @@ -1,7 +1,7 @@ SerializeError | @hpke/common

Class SerializeError

Public or private key serialization failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/ValidationError.html b/common/docs/classes/ValidationError.html index 833a9a6b6..9e1a3a8d3 100644 --- a/common/docs/classes/ValidationError.html +++ b/common/docs/classes/ValidationError.html @@ -1,7 +1,7 @@ ValidationError | @hpke/common

Class ValidationError

KEM input or output validation failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/classes/XCryptoKey.html b/common/docs/classes/XCryptoKey.html index d48d1600e..0f6b1fc93 100644 --- a/common/docs/classes/XCryptoKey.html +++ b/common/docs/classes/XCryptoKey.html @@ -1,11 +1,11 @@ -XCryptoKey | @hpke/common

Class XCryptoKey

Implements

  • CryptoKey

Constructors

constructor +XCryptoKey | @hpke/common

Class XCryptoKey

Implements

  • CryptoKey

Constructors

constructor

Properties

algorithm extractable key type usages -

Constructors

constructor

Properties

Readonlyalgorithm

algorithm: KeyAlgorithm

MDN Reference

-

Readonlyextractable

extractable: boolean = true

MDN Reference

-

Readonlykey

key: Uint8Array

Readonlytype

type: "private" | "public"

MDN Reference

-

Readonlyusages

usages: KeyUsage[]

MDN Reference

-

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlyalgorithm

algorithm: KeyAlgorithm

MDN Reference

+

Readonlyextractable

extractable: boolean = true

MDN Reference

+

Readonlykey

key: Uint8Array

Readonlytype

type: "private" | "public"

MDN Reference

+

Readonlyusages

usages: KeyUsage[]

MDN Reference

+

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/common/docs/functions/base64UrlToBytes.html b/common/docs/functions/base64UrlToBytes.html index 32c27e1e5..858bd6173 100644 --- a/common/docs/functions/base64UrlToBytes.html +++ b/common/docs/functions/base64UrlToBytes.html @@ -1,4 +1,4 @@ base64UrlToBytes | @hpke/common

Function base64UrlToBytes

  • base64UrlToBytes(v): Uint8Array

  • Decodes Base64Url-encoded data.

    Parameters

    • v: string

      Base64Url-encoded string

    Returns Uint8Array

    Uint8Array

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/functions/concat.html b/common/docs/functions/concat.html index 07c3e3484..d71200f82 100644 --- a/common/docs/functions/concat.html +++ b/common/docs/functions/concat.html @@ -2,4 +2,4 @@

Parameters

Returns Uint8Array

Concatenated Uint8Array

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/functions/hexToBytes.html b/common/docs/functions/hexToBytes.html index e60053d34..859828243 100644 --- a/common/docs/functions/hexToBytes.html +++ b/common/docs/functions/hexToBytes.html @@ -2,4 +2,4 @@

Parameters

Returns Uint8Array

Uint8Array

Throws

Error if the input is not a hex string.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/functions/i2Osp.html b/common/docs/functions/i2Osp.html index e22631c9e..1b3b60a58 100644 --- a/common/docs/functions/i2Osp.html +++ b/common/docs/functions/i2Osp.html @@ -1,2 +1,2 @@ i2Osp | @hpke/common

Function i2Osp

  • i2Osp(n, w): Uint8Array

  • Converts integer to octet string. I2OSP implementation.

    -

    Parameters

    • n: number
    • w: number

    Returns Uint8Array

Settings

Member Visibility
+

Parameters

Returns Uint8Array

Settings

Member Visibility
diff --git a/common/docs/functions/isCryptoKeyPair.html b/common/docs/functions/isCryptoKeyPair.html index 2d15af24e..1884d0cc8 100644 --- a/common/docs/functions/isCryptoKeyPair.html +++ b/common/docs/functions/isCryptoKeyPair.html @@ -1,2 +1,2 @@ isCryptoKeyPair | @hpke/common

Function isCryptoKeyPair

Checks whetehr the type of input is CryptoKeyPair or not.

-
  • isCryptoKeyPair(x): x is CryptoKeyPair

  • Parameters

    • x: unknown

    Returns x is CryptoKeyPair

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/functions/isDeno.html b/common/docs/functions/isDeno.html index c0ad73fdb..2724ae67f 100644 --- a/common/docs/functions/isDeno.html +++ b/common/docs/functions/isDeno.html @@ -1,3 +1,3 @@ isDeno | @hpke/common

Function isDeno

  • isDeno(): boolean

  • Checks whether the runtime is Deno or not (Node.js).

    Returns boolean

    boolean - true if the runtime is Deno, false Node.js.

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/functions/isDenoV1.html b/common/docs/functions/isDenoV1.html index 0641d34be..aa80d3a1f 100644 --- a/common/docs/functions/isDenoV1.html +++ b/common/docs/functions/isDenoV1.html @@ -1 +1 @@ -isDenoV1 | @hpke/common

Function isDenoV1

Settings

Member Visibility
+isDenoV1 | @hpke/common

Function isDenoV1

Settings

Member Visibility
diff --git a/common/docs/functions/kemToKeyGenAlgorithm.html b/common/docs/functions/kemToKeyGenAlgorithm.html index 8bfef38c0..b00695163 100644 --- a/common/docs/functions/kemToKeyGenAlgorithm.html +++ b/common/docs/functions/kemToKeyGenAlgorithm.html @@ -1,4 +1,4 @@ kemToKeyGenAlgorithm | @hpke/common

Function kemToKeyGenAlgorithm

  • kemToKeyGenAlgorithm(kem): KeyAlgorithm

  • Converts KemId to KeyAlgorithm.

    Parameters

    Returns KeyAlgorithm

    KeyAlgorithm

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/functions/loadCrypto.html b/common/docs/functions/loadCrypto.html index c8165d394..10583c935 100644 --- a/common/docs/functions/loadCrypto.html +++ b/common/docs/functions/loadCrypto.html @@ -1 +1 @@ -loadCrypto | @hpke/common

Function loadCrypto

Settings

Member Visibility
+loadCrypto | @hpke/common

Function loadCrypto

Settings

Member Visibility
diff --git a/common/docs/functions/loadSubtleCrypto.html b/common/docs/functions/loadSubtleCrypto.html index 64781fe8b..312f4ccab 100644 --- a/common/docs/functions/loadSubtleCrypto.html +++ b/common/docs/functions/loadSubtleCrypto.html @@ -1 +1 @@ -loadSubtleCrypto | @hpke/common

Function loadSubtleCrypto

Settings

Member Visibility
+loadSubtleCrypto | @hpke/common

Function loadSubtleCrypto

Settings

Member Visibility
diff --git a/common/docs/functions/xor.html b/common/docs/functions/xor.html index 0c6802565..189b62239 100644 --- a/common/docs/functions/xor.html +++ b/common/docs/functions/xor.html @@ -1,2 +1,2 @@ xor | @hpke/common

Function xor

  • xor(a, b): Uint8Array

  • XOR for Uint8Array.

    -

    Parameters

    • a: Uint8Array
    • b: Uint8Array

    Returns Uint8Array

Settings

Member Visibility
+

Parameters

Returns Uint8Array

Settings

Member Visibility
diff --git a/common/docs/interfaces/AeadEncryptionContext.html b/common/docs/interfaces/AeadEncryptionContext.html index 4c1a49cb2..7245ad21e 100644 --- a/common/docs/interfaces/AeadEncryptionContext.html +++ b/common/docs/interfaces/AeadEncryptionContext.html @@ -1,14 +1,14 @@ AeadEncryptionContext | @hpke/common

Interface AeadEncryptionContext

The AEAD encryption context interface.

-
interface AeadEncryptionContext {
    open(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
    seal(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
}

Methods

open +
interface AeadEncryptionContext {
    open(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
    seal(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
}

Methods

open seal

Methods

open

  • open(iv, data, aad): Promise<ArrayBuffer>

  • Decrypts data with an initialization vector and additional authenticated data.

    Parameters

    • iv: ArrayBuffer

      An initialization vector.

    • data: ArrayBuffer

      A plain text as bytes to be encrypted.

    • aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    -

seal

seal

  • seal(iv, data, aad): Promise<ArrayBuffer>

  • Encrypts data with an initialization vector and additional authenticated data.

    Parameters

    • iv: ArrayBuffer

      An initialization vector.

    • data: ArrayBuffer

      A plain text as bytes to be encrypted.

    • aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A cipher text as bytes.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/common/docs/interfaces/AeadInterface.html b/common/docs/interfaces/AeadInterface.html index 5af920f61..dda424511 100644 --- a/common/docs/interfaces/AeadInterface.html +++ b/common/docs/interfaces/AeadInterface.html @@ -1,14 +1,14 @@ AeadInterface | @hpke/common

Interface AeadInterface

The AEAD interface.

-
interface AeadInterface {
    id: AeadId;
    keySize: number;
    nonceSize: number;
    tagSize: number;
    createEncryptionContext(key: ArrayBuffer): AeadEncryptionContext;
}

Properties

id +
interface AeadInterface {
    id: AeadId;
    keySize: number;
    nonceSize: number;
    tagSize: number;
    createEncryptionContext(key: ArrayBuffer): AeadEncryptionContext;
}

Properties

id keySize nonceSize tagSize

Methods

createEncryptionContext

Properties

Readonlyid

id: AeadId

The KDF identifier.

-

ReadonlykeySize

keySize: number

The length in bytes of an AEAD key (Nk).

-

ReadonlynonceSize

nonceSize: number

The length in bytes of an AEAD nonce (Nn).

-

ReadonlytagSize

tagSize: number

The length in bytes of an AEAD authentication tag (Nt).

-

Methods

createEncryptionContext

ReadonlykeySize

keySize: number

The length in bytes of an AEAD key (Nk).

+

ReadonlynonceSize

nonceSize: number

The length in bytes of an AEAD nonce (Nn).

+

ReadonlytagSize

tagSize: number

The length in bytes of an AEAD authentication tag (Nt).

+

Methods

createEncryptionContext

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/common/docs/interfaces/DhkemInterface.html b/common/docs/interfaces/DhkemInterface.html index c06b31214..9aed1ce74 100644 --- a/common/docs/interfaces/DhkemInterface.html +++ b/common/docs/interfaces/DhkemInterface.html @@ -1,5 +1,5 @@ DhkemInterface | @hpke/common

Interface DhkemInterface

The DHKEM interface.

-
interface DhkemInterface {
    encSize: number;
    id: KemId;
    kdf: KdfInterface;
    privateKeySize: number;
    publicKeySize: number;
    secretSize: number;
    decap(params: RecipientContextParams): Promise<ArrayBuffer>;
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    encap(params: SenderContextParams): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic?: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Properties

encSize +
interface DhkemInterface {
    encSize: number;
    id: KemId;
    kdf: KdfInterface;
    privateKeySize: number;
    publicKeySize: number;
    secretSize: number;
    decap(params: RecipientContextParams): Promise<ArrayBuffer>;
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    encap(params: SenderContextParams): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic?: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Properties

encSize id kdf privateKeySize @@ -15,42 +15,42 @@ serializePrivateKey serializePublicKey

Properties

ReadonlyencSize

encSize: number

The length in bytes of an encapsulated key produced by this KEM (Nenc).

-

Readonlyid

id: KemId

The KEM identifier.

-

Readonlykdf

kdf: KdfInterface

ReadonlyprivateKeySize

privateKeySize: number

The length in bytes of an encoded private key for this KEM (Nsk).

-

ReadonlypublicKeySize

publicKeySize: number

The length in bytes of an encoded public key for this KEM (Npk).

-

ReadonlysecretSize

secretSize: number

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

-

Methods

decap

Readonlyid

id: KemId

The KEM identifier.

+

Readonlykdf

kdf: KdfInterface

ReadonlyprivateKeySize

privateKeySize: number

The length in bytes of an encoded private key for this KEM (Nsk).

+

ReadonlypublicKeySize

publicKeySize: number

The length in bytes of an encoded public key for this KEM (Npk).

+

ReadonlysecretSize

secretSize: number

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

+

Methods

decap

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

deserializePublicKey

deserializePublicKey

encap

encap

generateKeyPair

generateKeyPair

importKey

importKey

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

serializePrivateKey

serializePublicKey

serializePublicKey

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/common/docs/interfaces/DhkemPrimitives.html b/common/docs/interfaces/DhkemPrimitives.html index 89a171bd8..5b7f134f1 100644 --- a/common/docs/interfaces/DhkemPrimitives.html +++ b/common/docs/interfaces/DhkemPrimitives.html @@ -1,4 +1,4 @@ -DhkemPrimitives | @hpke/common

Interface DhkemPrimitives

interface DhkemPrimitives {
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    derivePublicKey(key: CryptoKey): Promise<CryptoKey>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    dh(sk: CryptoKey, pk: CryptoKey): Promise<ArrayBuffer>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Implemented by

Methods

deriveKeyPair +DhkemPrimitives | @hpke/common

Interface DhkemPrimitives

interface DhkemPrimitives {
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    derivePublicKey(key: CryptoKey): Promise<CryptoKey>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    dh(sk: CryptoKey, pk: CryptoKey): Promise<ArrayBuffer>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Implemented by

Methods

deriveKeyPair derivePublicKey deserializePrivateKey deserializePublicKey @@ -7,4 +7,4 @@ importKey serializePrivateKey serializePublicKey -

Methods

deriveKeyPair

derivePublicKey

deserializePrivateKey

deserializePublicKey

dh

generateKeyPair

importKey

  • importKey(format, key, isPublic): Promise<CryptoKey>

  • Parameters

    • format: "raw" | "jwk"
    • key: ArrayBuffer | JsonWebKey
    • isPublic: boolean

    Returns Promise<CryptoKey>

serializePrivateKey

serializePublicKey

Settings

Member Visibility

On This Page

Methods
+

Methods

deriveKeyPair

derivePublicKey

deserializePrivateKey

deserializePublicKey

dh

generateKeyPair

importKey

  • importKey(format, key, isPublic): Promise<CryptoKey>

  • Parameters

    • format: "raw" | "jwk"
    • key: ArrayBuffer | JsonWebKey
    • isPublic: boolean

    Returns Promise<CryptoKey>

serializePrivateKey

serializePublicKey

Settings

Member Visibility

On This Page

Methods
diff --git a/common/docs/interfaces/JsonWebKeyExtended.html b/common/docs/interfaces/JsonWebKeyExtended.html index 505de2f08..135e309ee 100644 --- a/common/docs/interfaces/JsonWebKeyExtended.html +++ b/common/docs/interfaces/JsonWebKeyExtended.html @@ -2,7 +2,7 @@ which are not supported by the current JsonWebKey. Both of them are defined for the newly defined JSON WWb Key type AKP (Algorithm Key Pair), which is used to express Public and Private Keys for use with Algorithms.

-
interface JsonWebKeyExtended {
    alg?: string;
    crv?: string;
    d?: string;
    dp?: string;
    dq?: string;
    e?: string;
    ext?: boolean;
    k?: string;
    key_ops?: string[];
    kty?: string;
    n?: string;
    oth?: RsaOtherPrimesInfo[];
    p?: string;
    priv?: string;
    pub?: string;
    q?: string;
    qi?: string;
    use?: string;
    x?: string;
    y?: string;
}

Hierarchy

Properties

alg? +
interface JsonWebKeyExtended {
    alg?: string;
    crv?: string;
    d?: string;
    dp?: string;
    dq?: string;
    e?: string;
    ext?: boolean;
    k?: string;
    key_ops?: string[];
    kty?: string;
    n?: string;
    oth?: RsaOtherPrimesInfo[];
    p?: string;
    priv?: string;
    pub?: string;
    q?: string;
    qi?: string;
    use?: string;
    x?: string;
    y?: string;
}

Hierarchy

  • JsonWebKey
    • JsonWebKeyExtended

Properties

alg? crv? d? dp? @@ -23,5 +23,5 @@ x? y?

Properties

Optionalalg

alg?: string

Optionalcrv

crv?: string

Optionald

d?: string

Optionaldp

dp?: string

Optionaldq

dq?: string

Optionale

e?: string

Optionalext

ext?: boolean

Optionalk

k?: string

Optionalkey_ops

key_ops?: string[]

Optionalkty

kty?: string

Optionaln

n?: string

Optionaloth

oth?: RsaOtherPrimesInfo[]

Optionalp

p?: string

Optionalpriv

priv?: string

The private key in base64url encoding, which is used with the 'AKP' key type.

-

Optionalpub

pub?: string

The public key in base64url encoding, which is used with the 'AKP' key type.

-

Optionalq

q?: string

Optionalqi

qi?: string

Optionaluse

use?: string

Optionalx

x?: string

Optionaly

y?: string

Settings

Member Visibility

On This Page

Properties
+

Optionalpub

pub?: string

The public key in base64url encoding, which is used with the 'AKP' key type.

+

Optionalq

q?: string

Optionalqi

qi?: string

Optionaluse

use?: string

Optionalx

x?: string

Optionaly

y?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/common/docs/interfaces/KdfInterface.html b/common/docs/interfaces/KdfInterface.html index e07bad999..d926579de 100644 --- a/common/docs/interfaces/KdfInterface.html +++ b/common/docs/interfaces/KdfInterface.html @@ -1,5 +1,5 @@ KdfInterface | @hpke/common

Interface KdfInterface

The KDF interface.

-
interface KdfInterface {
    hashSize: number;
    id: KdfId;
    buildLabeledIkm(label: Uint8Array, ikm: Uint8Array): Uint8Array;
    buildLabeledInfo(label: Uint8Array, info: Uint8Array, len: number): Uint8Array;
    expand(prk: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    extract(salt: ArrayBuffer, ikm: ArrayBuffer): Promise<ArrayBuffer>;
    extractAndExpand(salt: ArrayBuffer, ikm: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    init(suiteId: Uint8Array): void;
    labeledExpand(prk: ArrayBuffer, label: Uint8Array, info: Uint8Array, len: number): Promise<ArrayBuffer>;
    labeledExtract(salt: ArrayBuffer, label: Uint8Array, ikm: Uint8Array): Promise<ArrayBuffer>;
}

Properties

hashSize +
interface KdfInterface {
    hashSize: number;
    id: KdfId;
    buildLabeledIkm(label: Uint8Array, ikm: Uint8Array): Uint8Array;
    buildLabeledInfo(label: Uint8Array, info: Uint8Array, len: number): Uint8Array;
    expand(prk: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    extract(salt: ArrayBuffer, ikm: ArrayBuffer): Promise<ArrayBuffer>;
    extractAndExpand(salt: ArrayBuffer, ikm: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    init(suiteId: Uint8Array): void;
    labeledExpand(prk: ArrayBuffer, label: Uint8Array, info: Uint8Array, len: number): Promise<ArrayBuffer>;
    labeledExtract(salt: ArrayBuffer, label: Uint8Array, ikm: Uint8Array): Promise<ArrayBuffer>;
}

Properties

hashSize id

Methods

buildLabeledIkm buildLabeledInfo @@ -10,41 +10,41 @@ labeledExpand labeledExtract

Properties

ReadonlyhashSize

hashSize: number

The output size of the extract() function in bytes (Nh).

-

Readonlyid

id: KdfId

The KDF identifier.

-

Methods

buildLabeledIkm

Readonlyid

id: KdfId

The KDF identifier.

+

Methods

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

labeledExtract

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/common/docs/interfaces/KemInterface.html b/common/docs/interfaces/KemInterface.html index 367c556cd..5bac97f2d 100644 --- a/common/docs/interfaces/KemInterface.html +++ b/common/docs/interfaces/KemInterface.html @@ -1,5 +1,5 @@ KemInterface | @hpke/common

Interface KemInterface

The KEM interface.

-
interface KemInterface {
    encSize: number;
    id: KemId;
    privateKeySize: number;
    publicKeySize: number;
    secretSize: number;
    decap(params: RecipientContextParams): Promise<ArrayBuffer>;
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    encap(params: SenderContextParams): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic?: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Implemented by

Properties

encSize +
interface KemInterface {
    encSize: number;
    id: KemId;
    privateKeySize: number;
    publicKeySize: number;
    secretSize: number;
    decap(params: RecipientContextParams): Promise<ArrayBuffer>;
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    encap(params: SenderContextParams): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic?: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Implemented by

Properties

encSize id privateKeySize publicKeySize @@ -14,42 +14,42 @@ serializePrivateKey serializePublicKey

Properties

ReadonlyencSize

encSize: number

The length in bytes of an encapsulated key produced by this KEM (Nenc).

-

Readonlyid

id: KemId

The KEM identifier.

-

ReadonlyprivateKeySize

privateKeySize: number

The length in bytes of an encoded private key for this KEM (Nsk).

-

ReadonlypublicKeySize

publicKeySize: number

The length in bytes of an encoded public key for this KEM (Npk).

-

ReadonlysecretSize

secretSize: number

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

-

Methods

decap

Readonlyid

id: KemId

The KEM identifier.

+

ReadonlyprivateKeySize

privateKeySize: number

The length in bytes of an encoded private key for this KEM (Nsk).

+

ReadonlypublicKeySize

publicKeySize: number

The length in bytes of an encoded public key for this KEM (Npk).

+

ReadonlysecretSize

secretSize: number

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

+

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

deserializePublicKey

deserializePublicKey

encap

encap

generateKeyPair

generateKeyPair

importKey

importKey

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

serializePrivateKey

serializePublicKey

serializePublicKey

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/common/docs/interfaces/KeyScheduleParams.html b/common/docs/interfaces/KeyScheduleParams.html index ee2a1ff3b..281e08cc4 100644 --- a/common/docs/interfaces/KeyScheduleParams.html +++ b/common/docs/interfaces/KeyScheduleParams.html @@ -1,7 +1,7 @@ KeyScheduleParams | @hpke/common

Interface KeyScheduleParams

The common parameters used to setup the EncryptionContext.

-
interface KeyScheduleParams {
    info?: ArrayBuffer;
    psk?: PreSharedKey;
}

Hierarchy (view full)

Properties

info? +
interface KeyScheduleParams {
    info?: ArrayBuffer;
    psk?: PreSharedKey;
}

Hierarchy (view full)

Properties

info? psk?

Properties

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

-

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. +

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/common/docs/interfaces/PreSharedKey.html b/common/docs/interfaces/PreSharedKey.html index 8476d92f9..a6a2e5727 100644 --- a/common/docs/interfaces/PreSharedKey.html +++ b/common/docs/interfaces/PreSharedKey.html @@ -1,6 +1,6 @@ PreSharedKey | @hpke/common

Interface PreSharedKey

The pre-shared key interface.

-
interface PreSharedKey {
    id: ArrayBuffer;
    key: ArrayBuffer;
}

Properties

id +
interface PreSharedKey {
    id: ArrayBuffer;
    key: ArrayBuffer;
}

Properties

id key

Properties

id

id: ArrayBuffer

The key identifier.

-

key

key: ArrayBuffer

The body of the pre-shared key.

-

Settings

Member Visibility

On This Page

Properties
+

key

key: ArrayBuffer

The body of the pre-shared key.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/common/docs/interfaces/RecipientContextParams.html b/common/docs/interfaces/RecipientContextParams.html index df277a114..c445a1165 100644 --- a/common/docs/interfaces/RecipientContextParams.html +++ b/common/docs/interfaces/RecipientContextParams.html @@ -1,13 +1,13 @@ RecipientContextParams | @hpke/common

Interface RecipientContextParams

The parameters used to setup the RecipientContext.

-
interface RecipientContextParams {
    enc: ArrayBuffer;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientKey: CryptoKeyPair | CryptoKey;
    senderPublicKey?: CryptoKey;
}

Hierarchy (view full)

Properties

enc +
interface RecipientContextParams {
    enc: ArrayBuffer;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientKey: CryptoKeyPair | CryptoKey;
    senderPublicKey?: CryptoKey;
}

Hierarchy (view full)

Properties

enc info? psk? recipientKey senderPublicKey?

Properties

enc

enc: ArrayBuffer

A byte string of the encapsulated key received from a sender.

-

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

-

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. +

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

+

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

-

recipientKey

recipientKey: CryptoKeyPair | CryptoKey

A recipient private key or a key pair.

-

OptionalsenderPublicKey

senderPublicKey?: CryptoKey

A sender public key for Auth mode.

-

Settings

Member Visibility

On This Page

Properties
+

recipientKey

recipientKey: CryptoKeyPair | CryptoKey

A recipient private key or a key pair.

+

OptionalsenderPublicKey

senderPublicKey?: CryptoKey

A sender public key for Auth mode.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/common/docs/interfaces/SenderContextParams.html b/common/docs/interfaces/SenderContextParams.html index 4e3429946..e449746e6 100644 --- a/common/docs/interfaces/SenderContextParams.html +++ b/common/docs/interfaces/SenderContextParams.html @@ -1,13 +1,13 @@ SenderContextParams | @hpke/common

Interface SenderContextParams

The parameters used to setup the SenderContext.

-
interface SenderContextParams {
    ekm?: ArrayBuffer | CryptoKeyPair;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientPublicKey: CryptoKey;
    senderKey?: CryptoKeyPair | CryptoKey;
}

Hierarchy (view full)

Properties

ekm? +
interface SenderContextParams {
    ekm?: ArrayBuffer | CryptoKeyPair;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientPublicKey: CryptoKey;
    senderKey?: CryptoKeyPair | CryptoKey;
}

Hierarchy (view full)

Properties

ekm? info? psk? recipientPublicKey senderKey?

Properties

Optionalekm

ekm?: ArrayBuffer | CryptoKeyPair

DO NOT USE. FOR DEBUGGING/TESTING PURPOSES ONLY.

-

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

-

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. +

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

+

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

-

recipientPublicKey

recipientPublicKey: CryptoKey

A recipient public key.

-

OptionalsenderKey

senderKey?: CryptoKeyPair | CryptoKey

A sender private key or a key pair for Auth mode.

-

Settings

Member Visibility

On This Page

Properties
+

recipientPublicKey

recipientPublicKey: CryptoKey

A recipient public key.

+

OptionalsenderKey

senderKey?: CryptoKeyPair | CryptoKey

A sender private key or a key pair for Auth mode.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/common/docs/types/AeadId.html b/common/docs/types/AeadId.html index f5205ef4d..6dd591703 100644 --- a/common/docs/types/AeadId.html +++ b/common/docs/types/AeadId.html @@ -1,2 +1,2 @@ AeadId | @hpke/common

Type Alias AeadId

AeadId: typeof AeadId[keyof typeof AeadId]

The type alias of the supported AEAD identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/types/KdfId.html b/common/docs/types/KdfId.html index a972bfe8b..8f0b37fde 100644 --- a/common/docs/types/KdfId.html +++ b/common/docs/types/KdfId.html @@ -1,2 +1,2 @@ KdfId | @hpke/common

Type Alias KdfId

KdfId: typeof KdfId[keyof typeof KdfId]

The type alias of the supported KDF identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/types/KemId.html b/common/docs/types/KemId.html index b70518a67..01d43561b 100644 --- a/common/docs/types/KemId.html +++ b/common/docs/types/KemId.html @@ -1,2 +1,2 @@ KemId | @hpke/common

Type Alias KemId

KemId: typeof KemId[keyof typeof KemId]

The type alias of the supported KEM identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/types/Mode.html b/common/docs/types/Mode.html index 715a3a629..4c84b0923 100644 --- a/common/docs/types/Mode.html +++ b/common/docs/types/Mode.html @@ -1,2 +1,2 @@ Mode | @hpke/common

Type Alias Mode

Mode: typeof Mode[keyof typeof Mode]

The type alias of the supported HPKE modes.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/variables/AEAD_USAGES.html b/common/docs/variables/AEAD_USAGES.html index 0659e7d0a..cfbca1f94 100644 --- a/common/docs/variables/AEAD_USAGES.html +++ b/common/docs/variables/AEAD_USAGES.html @@ -1 +1 @@ -AEAD_USAGES | @hpke/common

Variable AEAD_USAGESConst

AEAD_USAGES: KeyUsage[] = ...

Settings

Member Visibility
+AEAD_USAGES | @hpke/common

Variable AEAD_USAGESConst

AEAD_USAGES: KeyUsage[] = ...

Settings

Member Visibility
diff --git a/common/docs/variables/AeadId-1.html b/common/docs/variables/AeadId-1.html index 03a41b0e6..ff2e5865c 100644 --- a/common/docs/variables/AeadId-1.html +++ b/common/docs/variables/AeadId-1.html @@ -1,2 +1,2 @@ AeadId | @hpke/common

Variable AeadIdConst

AeadId: {
    Aes128Gcm: 1;
    Aes256Gcm: 2;
    Chacha20Poly1305: 3;
    ExportOnly: 65535;
} = ...

The supported Authenticated Encryption with Associated Data (AEAD) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/variables/EMPTY.html b/common/docs/variables/EMPTY.html index e8825c8f0..c8431fab8 100644 --- a/common/docs/variables/EMPTY.html +++ b/common/docs/variables/EMPTY.html @@ -1 +1 @@ -EMPTY | @hpke/common

Variable EMPTYConst

EMPTY: Uint8Array = ...

Settings

Member Visibility
+EMPTY | @hpke/common

Variable EMPTYConst

EMPTY: Uint8Array = ...

Settings

Member Visibility
diff --git a/common/docs/variables/INPUT_LENGTH_LIMIT.html b/common/docs/variables/INPUT_LENGTH_LIMIT.html index b21a34f35..1995f5b29 100644 --- a/common/docs/variables/INPUT_LENGTH_LIMIT.html +++ b/common/docs/variables/INPUT_LENGTH_LIMIT.html @@ -1 +1 @@ -INPUT_LENGTH_LIMIT | @hpke/common

Variable INPUT_LENGTH_LIMITConst

INPUT_LENGTH_LIMIT = 8192

Settings

Member Visibility
+INPUT_LENGTH_LIMIT | @hpke/common

Variable INPUT_LENGTH_LIMITConst

INPUT_LENGTH_LIMIT = 8192

Settings

Member Visibility
diff --git a/common/docs/variables/KEM_USAGES.html b/common/docs/variables/KEM_USAGES.html index 9d1271ac6..cd5b1c14b 100644 --- a/common/docs/variables/KEM_USAGES.html +++ b/common/docs/variables/KEM_USAGES.html @@ -1 +1 @@ -KEM_USAGES | @hpke/common

Variable KEM_USAGESConst

KEM_USAGES: KeyUsage[] = ...

Settings

Member Visibility
+KEM_USAGES | @hpke/common

Variable KEM_USAGESConst

KEM_USAGES: KeyUsage[] = ...

Settings

Member Visibility
diff --git a/common/docs/variables/KdfId-1.html b/common/docs/variables/KdfId-1.html index bc60ea021..56be99f1d 100644 --- a/common/docs/variables/KdfId-1.html +++ b/common/docs/variables/KdfId-1.html @@ -1,2 +1,2 @@ KdfId | @hpke/common

Variable KdfIdConst

KdfId: {
    HkdfSha256: 1;
    HkdfSha384: 2;
    HkdfSha512: 3;
} = ...

The supported Key Derivation Function (KDF) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/variables/KemId-1.html b/common/docs/variables/KemId-1.html index 3bf4e7011..a81461848 100644 --- a/common/docs/variables/KemId-1.html +++ b/common/docs/variables/KemId-1.html @@ -1,2 +1,2 @@ KemId | @hpke/common

Variable KemIdConst

KemId: {
    DhkemP256HkdfSha256: 16;
    DhkemP384HkdfSha384: 17;
    DhkemP521HkdfSha512: 18;
    DhkemSecp256k1HkdfSha256: 19;
    DhkemX25519HkdfSha256: 32;
    DhkemX448HkdfSha512: 33;
    HybridkemX25519Kyber768: 48;
    MlKem1024: 66;
    MlKem512: 64;
    MlKem768: 65;
    NotAssigned: 0;
    XWing: 25722;
} = ...

The supported Key Encapsulation Mechanism (KEM) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/variables/LABEL_DKP_PRK.html b/common/docs/variables/LABEL_DKP_PRK.html index d88150daf..c2e28934a 100644 --- a/common/docs/variables/LABEL_DKP_PRK.html +++ b/common/docs/variables/LABEL_DKP_PRK.html @@ -1 +1 @@ -LABEL_DKP_PRK | @hpke/common

Variable LABEL_DKP_PRKConst

LABEL_DKP_PRK: Uint8Array = ...

Settings

Member Visibility
+LABEL_DKP_PRK | @hpke/common

Variable LABEL_DKP_PRKConst

LABEL_DKP_PRK: Uint8Array = ...

Settings

Member Visibility
diff --git a/common/docs/variables/LABEL_SK.html b/common/docs/variables/LABEL_SK.html index e7594978a..1bc75eefa 100644 --- a/common/docs/variables/LABEL_SK.html +++ b/common/docs/variables/LABEL_SK.html @@ -1 +1 @@ -LABEL_SK | @hpke/common

Variable LABEL_SKConst

LABEL_SK: Uint8Array = ...

Settings

Member Visibility
+LABEL_SK | @hpke/common

Variable LABEL_SKConst

LABEL_SK: Uint8Array = ...

Settings

Member Visibility
diff --git a/common/docs/variables/MINIMUM_PSK_LENGTH.html b/common/docs/variables/MINIMUM_PSK_LENGTH.html index 5f1fb7f4d..8d37a02e8 100644 --- a/common/docs/variables/MINIMUM_PSK_LENGTH.html +++ b/common/docs/variables/MINIMUM_PSK_LENGTH.html @@ -1 +1 @@ -MINIMUM_PSK_LENGTH | @hpke/common

Variable MINIMUM_PSK_LENGTHConst

MINIMUM_PSK_LENGTH = 32

Settings

Member Visibility
+MINIMUM_PSK_LENGTH | @hpke/common

Variable MINIMUM_PSK_LENGTHConst

MINIMUM_PSK_LENGTH = 32

Settings

Member Visibility
diff --git a/common/docs/variables/Mode-1.html b/common/docs/variables/Mode-1.html index 671788804..0ecfb8550 100644 --- a/common/docs/variables/Mode-1.html +++ b/common/docs/variables/Mode-1.html @@ -1,2 +1,2 @@ Mode | @hpke/common

Variable ModeConst

Mode: {
    Auth: 2;
    AuthPsk: 3;
    Base: 0;
    Psk: 1;
} = ...

The supported HPKE modes.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/common/docs/variables/SUITE_ID_HEADER_KEM.html b/common/docs/variables/SUITE_ID_HEADER_KEM.html index 2ce17eabd..ac16dcb44 100644 --- a/common/docs/variables/SUITE_ID_HEADER_KEM.html +++ b/common/docs/variables/SUITE_ID_HEADER_KEM.html @@ -1 +1 @@ -SUITE_ID_HEADER_KEM | @hpke/common

Variable SUITE_ID_HEADER_KEMConst

SUITE_ID_HEADER_KEM: Uint8Array = ...

Settings

Member Visibility
+SUITE_ID_HEADER_KEM | @hpke/common

Variable SUITE_ID_HEADER_KEMConst

SUITE_ID_HEADER_KEM: Uint8Array = ...

Settings

Member Visibility
diff --git a/core/docs/classes/Aes128Gcm.html b/core/docs/classes/Aes128Gcm.html index 72bbad955..bb0f9201e 100644 --- a/core/docs/classes/Aes128Gcm.html +++ b/core/docs/classes/Aes128Gcm.html @@ -4,17 +4,17 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP256HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy (view full)

Implements

Constructors

constructor +

Hierarchy (view full)

Implements

Constructors

constructor

Properties

id keySize nonceSize tagSize

Methods

createEncryptionContext

Constructors

constructor

Properties

Readonlyid

id: AeadId = AeadId.Aes128Gcm

AeadId.Aes128Gcm (0x0001)

-

ReadonlykeySize

keySize: number = 16

16

-

ReadonlynonceSize

nonceSize: number = 12

12

-

ReadonlytagSize

tagSize: number = 16

16

-

Methods

createEncryptionContext

ReadonlykeySize

keySize: number = 16

16

+

ReadonlynonceSize

nonceSize: number = 12

12

+

ReadonlytagSize

tagSize: number = 16

16

+

Methods

createEncryptionContext

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/Aes256Gcm.html b/core/docs/classes/Aes256Gcm.html index f40bbff40..5cbd3a8f3 100644 --- a/core/docs/classes/Aes256Gcm.html +++ b/core/docs/classes/Aes256Gcm.html @@ -5,17 +5,17 @@

Example

import {
  Aes256Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP256HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes256Gcm(),
});
-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

id keySize nonceSize tagSize

Methods

createEncryptionContext

Constructors

constructor

Properties

id

id: AeadId = AeadId.Aes256Gcm

AeadId.Aes256Gcm (0x0002)

-

keySize

keySize: number = 32

32

-

nonceSize

nonceSize: number = 12

12

-

tagSize

tagSize: number = 16

16

-

Methods

createEncryptionContext

keySize

keySize: number = 32

32

+

nonceSize

nonceSize: number = 12

12

+

tagSize

tagSize: number = 16

16

+

Methods

createEncryptionContext

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/CipherSuite.html b/core/docs/classes/CipherSuite.html index 9ac627077..e0aedf15a 100644 --- a/core/docs/classes/CipherSuite.html +++ b/core/docs/classes/CipherSuite.html @@ -39,7 +39,7 @@

Example: Use a ciphersuite which is currently not supported by Web Cryptography API.

import { Aes128Gcm, HkdfSha256, CipherSuite } from "@hpke/core";
import { DhkemX25519HkdfSha256 } from "@hpke/dhkem-x25519";
const suite = new CipherSuite({
  kem: new DhkemX25519HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_api _kem

Accessors

aead @@ -53,32 +53,32 @@

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_kem

_kem: KemInterface

Accessors

aead

kdf

kem

Methods

Protected_setup

createRecipientContext

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_kem

_kem: KemInterface

Accessors

aead

kdf

kem

Methods

Protected_setup

createRecipientContext

createSenderContext

createSenderContext

open

  • open(params, ct, aad?): Promise<ArrayBuffer>

  • Decrypts a message from a sender.

    +

open

  • open(params, ct, aad?): Promise<ArrayBuffer>

  • Decrypts a message from a sender.

    If the error occurred, throws DecapError | DeserializeError | OpenError | ValidationError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for building a recipient encryption context.

    • ct: ArrayBuffer

      An encrypted text as bytes to be decrypted.

    • aad: ArrayBuffer = EMPTY

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    Throws

    DecapError, DeserializeError, OpenError, ValidationError

    -

seal

seal

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/core/docs/classes/DecapError.html b/core/docs/classes/DecapError.html index 53aa92ad6..d6a99bee8 100644 --- a/core/docs/classes/DecapError.html +++ b/core/docs/classes/DecapError.html @@ -1,7 +1,7 @@ DecapError | @hpke/core

Class DecapError

decap() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/DeriveKeyPairError.html b/core/docs/classes/DeriveKeyPairError.html index 54258dcef..a3fb65686 100644 --- a/core/docs/classes/DeriveKeyPairError.html +++ b/core/docs/classes/DeriveKeyPairError.html @@ -1,7 +1,7 @@ DeriveKeyPairError | @hpke/core

Class DeriveKeyPairError

Key pair derivation failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/DeserializeError.html b/core/docs/classes/DeserializeError.html index a80e26984..6fd114e61 100644 --- a/core/docs/classes/DeserializeError.html +++ b/core/docs/classes/DeserializeError.html @@ -1,7 +1,7 @@ DeserializeError | @hpke/core

Class DeserializeError

Public or private key deserialization failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/DhkemP256HkdfSha256.html b/core/docs/classes/DhkemP256HkdfSha256.html index 5e0beaa27..26b1741d1 100644 --- a/core/docs/classes/DhkemP256HkdfSha256.html +++ b/core/docs/classes/DhkemP256HkdfSha256.html @@ -5,7 +5,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP256HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_kdf _prim encSize @@ -22,38 +22,38 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 65

id

id: KemId = KemId.DhkemP256HkdfSha256

privateKeySize

privateKeySize: number = 32

publicKeySize

publicKeySize: number = 65

secretSize

secretSize: number = 32

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 65

id

id: KemId = KemId.DhkemP256HkdfSha256

privateKeySize

privateKeySize: number = 32

publicKeySize

publicKeySize: number = 65

secretSize

secretSize: number = 32

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair.

    +

generateKeyPair

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -65,14 +65,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/DhkemP384HkdfSha384.html b/core/docs/classes/DhkemP384HkdfSha384.html index 6ee9262ab..3f8ea2c70 100644 --- a/core/docs/classes/DhkemP384HkdfSha384.html +++ b/core/docs/classes/DhkemP384HkdfSha384.html @@ -5,7 +5,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP384HkdfSha384,
  HkdfSha384,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP384HkdfSha384(),
  kdf: new HkdfSha384(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_kdf _prim encSize @@ -22,38 +22,38 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 97

id

id: KemId = KemId.DhkemP384HkdfSha384

privateKeySize

privateKeySize: number = 48

publicKeySize

publicKeySize: number = 97

secretSize

secretSize: number = 48

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 97

id

id: KemId = KemId.DhkemP384HkdfSha384

privateKeySize

privateKeySize: number = 48

publicKeySize

publicKeySize: number = 97

secretSize

secretSize: number = 48

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair.

    +

generateKeyPair

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -65,14 +65,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/DhkemP521HkdfSha512.html b/core/docs/classes/DhkemP521HkdfSha512.html index c68823915..48f3f49cc 100644 --- a/core/docs/classes/DhkemP521HkdfSha512.html +++ b/core/docs/classes/DhkemP521HkdfSha512.html @@ -5,7 +5,7 @@

Example

import {
  Aes256Gcm,
  CipherSuite,
  DhkemP521HkdfSha512,
  HkdfSha512,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP521HkdfSha512(),
  kdf: new HkdfSha512(),
  aead: new Aes256Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_kdf _prim encSize @@ -22,38 +22,38 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 133

id

id: KemId = KemId.DhkemP521HkdfSha512

privateKeySize

privateKeySize: number = 64

publicKeySize

publicKeySize: number = 133

secretSize

secretSize: number = 64

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 133

id

id: KemId = KemId.DhkemP521HkdfSha512

privateKeySize

privateKeySize: number = 64

publicKeySize

publicKeySize: number = 133

secretSize

secretSize: number = 64

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair.

    +

generateKeyPair

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -65,14 +65,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/DhkemX25519HkdfSha256.html b/core/docs/classes/DhkemX25519HkdfSha256.html index 3ff5af725..983a296be 100644 --- a/core/docs/classes/DhkemX25519HkdfSha256.html +++ b/core/docs/classes/DhkemX25519HkdfSha256.html @@ -4,7 +4,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  HkdfSha256,
  DhkemX25519HkdfSha256,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemX25519HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_kdf _prim encSize @@ -21,43 +21,43 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 32

32

-

id

id: KemId = KemId.DhkemX25519HkdfSha256

KemId.DhkemX25519HkdfSha256 (0x0020)

-

privateKeySize

privateKeySize: number = 32

32

-

publicKeySize

publicKeySize: number = 32

32

-

secretSize

secretSize: number = 32

32

-

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 32

32

+

id

id: KemId = KemId.DhkemX25519HkdfSha256

KemId.DhkemX25519HkdfSha256 (0x0020)

+

privateKeySize

privateKeySize: number = 32

32

+

publicKeySize

publicKeySize: number = 32

32

+

secretSize

secretSize: number = 32

32

+

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

generateKeyPair

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -69,14 +69,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/DhkemX448HkdfSha512.html b/core/docs/classes/DhkemX448HkdfSha512.html index ce9fed10a..75502a67b 100644 --- a/core/docs/classes/DhkemX448HkdfSha512.html +++ b/core/docs/classes/DhkemX448HkdfSha512.html @@ -4,7 +4,7 @@

Example

import {
  Aes256Gcm,
  CipherSuite,
  HkdfSha512,
  DhkemX448HkdfSha512,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemX448HkdfSha512(),
  kdf: new HkdfSha512(),
  aead: new Aes256Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_kdf _prim encSize @@ -21,43 +21,43 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 56

56

-

id

id: KemId = KemId.DhkemX448HkdfSha512

KemId.DhkemX448HkdfSha512 (0x0021)

-

privateKeySize

privateKeySize: number = 56

56

-

publicKeySize

publicKeySize: number = 56

56

-

secretSize

secretSize: number = 64

64

-

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 56

56

+

id

id: KemId = KemId.DhkemX448HkdfSha512

KemId.DhkemX448HkdfSha512 (0x0021)

+

privateKeySize

privateKeySize: number = 56

56

+

publicKeySize

publicKeySize: number = 56

56

+

secretSize

secretSize: number = 64

64

+

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

generateKeyPair

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -69,14 +69,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/EncapError.html b/core/docs/classes/EncapError.html index e77d4c055..65d63c21d 100644 --- a/core/docs/classes/EncapError.html +++ b/core/docs/classes/EncapError.html @@ -1,7 +1,7 @@ EncapError | @hpke/core

Class EncapError

encap() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/ExportError.html b/core/docs/classes/ExportError.html index 364325eb3..a300091c9 100644 --- a/core/docs/classes/ExportError.html +++ b/core/docs/classes/ExportError.html @@ -1,7 +1,7 @@ ExportError | @hpke/core

Class ExportError

Secret export failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/ExportOnly.html b/core/docs/classes/ExportOnly.html index e2c0404ed..b8273030f 100644 --- a/core/docs/classes/ExportOnly.html +++ b/core/docs/classes/ExportOnly.html @@ -5,16 +5,16 @@

Example

import {
  CipherSuite,
  DhkemP256HkdfSha256,
  ExportOnly,
  HkdfSha256,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP256HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new ExportOnly(),
});
-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

id keySize nonceSize tagSize

Methods

createEncryptionContext

Constructors

constructor

Properties

Readonlyid

id: AeadId = AeadId.ExportOnly

The KDF identifier.

-

ReadonlykeySize

keySize: number = 0

The length in bytes of an AEAD key (Nk).

-

ReadonlynonceSize

nonceSize: number = 0

The length in bytes of an AEAD nonce (Nn).

-

ReadonlytagSize

tagSize: number = 0

The length in bytes of an AEAD authentication tag (Nt).

-

Methods

createEncryptionContext

ReadonlykeySize

keySize: number = 0

The length in bytes of an AEAD key (Nk).

+

ReadonlynonceSize

nonceSize: number = 0

The length in bytes of an AEAD nonce (Nn).

+

ReadonlytagSize

tagSize: number = 0

The length in bytes of an AEAD authentication tag (Nt).

+

Methods

createEncryptionContext

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/HkdfSha256.html b/core/docs/classes/HkdfSha256.html index aaf0e6eb2..d77f626c8 100644 --- a/core/docs/classes/HkdfSha256.html +++ b/core/docs/classes/HkdfSha256.html @@ -7,7 +7,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP256HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_api _suiteId algHash @@ -23,43 +23,43 @@ init labeledExpand labeledExtract -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

hashSize

hashSize: number = 32

32

-

id

id: KdfId = KdfId.HkdfSha256

KdfId.HkdfSha256 (0x0001)

-

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    +

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

hashSize

hashSize: number = 32

32

+

id

id: KdfId = KdfId.HkdfSha256

KdfId.HkdfSha256 (0x0001)

+

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    +

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    +

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    +

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    +

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/HkdfSha384.html b/core/docs/classes/HkdfSha384.html index 1b4685acd..030ffe84a 100644 --- a/core/docs/classes/HkdfSha384.html +++ b/core/docs/classes/HkdfSha384.html @@ -7,7 +7,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP384HkdfSha384,
  HkdfSha384,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP384HkdfSha384(),
  kdf: new HkdfSha384(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_api _suiteId algHash @@ -23,43 +23,43 @@ init labeledExpand labeledExtract -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

hashSize

hashSize: number = 48

48

-

id

id: KdfId = KdfId.HkdfSha384

KdfId.HkdfSha384 (0x0002)

-

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    +

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

hashSize

hashSize: number = 48

48

+

id

id: KdfId = KdfId.HkdfSha384

KdfId.HkdfSha384 (0x0002)

+

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    +

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    +

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    +

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    +

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/HkdfSha512.html b/core/docs/classes/HkdfSha512.html index 5cd3f200e..4bde8eb5f 100644 --- a/core/docs/classes/HkdfSha512.html +++ b/core/docs/classes/HkdfSha512.html @@ -7,7 +7,7 @@

Example

import {
  Aes256Gcm,
  CipherSuite,
  DhkemP521HkdfSha512,
  HkdfSha512,
} from "@hpke/core";

const suite = new CipherSuite({
  kem: new DhkemP521HkdfSha512(),
  kdf: new HkdfSha512(),
  aead: new Aes256Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_api _suiteId algHash @@ -23,43 +23,43 @@ init labeledExpand labeledExtract -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

hashSize

hashSize: number = 64

64

-

id

id: KdfId = KdfId.HkdfSha512

KdfId.HkdfSha512 (0x0003)

-

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    +

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

hashSize

hashSize: number = 64

64

+

id

id: KdfId = KdfId.HkdfSha512

KdfId.HkdfSha512 (0x0003)

+

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    +

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    +

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    +

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    +

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/core/docs/classes/HpkeError.html b/core/docs/classes/HpkeError.html index a1c5eb468..505c001b2 100644 --- a/core/docs/classes/HpkeError.html +++ b/core/docs/classes/HpkeError.html @@ -1,7 +1,7 @@ HpkeError | @hpke/core

Class HpkeError

The base error class of hpke-js.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/InvalidParamError.html b/core/docs/classes/InvalidParamError.html index 90f09ebdc..3bdf7d023 100644 --- a/core/docs/classes/InvalidParamError.html +++ b/core/docs/classes/InvalidParamError.html @@ -1,7 +1,7 @@ InvalidParamError | @hpke/core

Class InvalidParamError

Invalid parameter.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/MessageLimitReachedError.html b/core/docs/classes/MessageLimitReachedError.html index 6de5e7b6d..bf2a9e8b6 100644 --- a/core/docs/classes/MessageLimitReachedError.html +++ b/core/docs/classes/MessageLimitReachedError.html @@ -1,7 +1,7 @@ MessageLimitReachedError | @hpke/core

Class MessageLimitReachedError

Sequence number overflow on the encryption context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/NotSupportedError.html b/core/docs/classes/NotSupportedError.html index b37f6b032..edd7aea16 100644 --- a/core/docs/classes/NotSupportedError.html +++ b/core/docs/classes/NotSupportedError.html @@ -1,7 +1,7 @@ NotSupportedError | @hpke/core

Class NotSupportedError

Not supported failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/OpenError.html b/core/docs/classes/OpenError.html index 68a99ee5f..c1b352e57 100644 --- a/core/docs/classes/OpenError.html +++ b/core/docs/classes/OpenError.html @@ -1,7 +1,7 @@ OpenError | @hpke/core

Class OpenError

open() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/SealError.html b/core/docs/classes/SealError.html index 7b927288e..5655fdcbd 100644 --- a/core/docs/classes/SealError.html +++ b/core/docs/classes/SealError.html @@ -1,7 +1,7 @@ SealError | @hpke/core

Class SealError

seal() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/SerializeError.html b/core/docs/classes/SerializeError.html index f451d0780..f2cd81e9b 100644 --- a/core/docs/classes/SerializeError.html +++ b/core/docs/classes/SerializeError.html @@ -1,7 +1,7 @@ SerializeError | @hpke/core

Class SerializeError

Public or private key serialization failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/classes/ValidationError.html b/core/docs/classes/ValidationError.html index a519122a1..b30dfcd85 100644 --- a/core/docs/classes/ValidationError.html +++ b/core/docs/classes/ValidationError.html @@ -1,7 +1,7 @@ ValidationError | @hpke/core

Class ValidationError

KEM input or output validation failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/core/docs/interfaces/AeadEncryptionContext.html b/core/docs/interfaces/AeadEncryptionContext.html index ddd6697bf..433408db2 100644 --- a/core/docs/interfaces/AeadEncryptionContext.html +++ b/core/docs/interfaces/AeadEncryptionContext.html @@ -1,14 +1,14 @@ AeadEncryptionContext | @hpke/core

Interface AeadEncryptionContext

The AEAD encryption context interface.

-
interface AeadEncryptionContext {
    open(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
    seal(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
}

Methods

open +
interface AeadEncryptionContext {
    open(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
    seal(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
}

Methods

open seal

Methods

open

  • open(iv, data, aad): Promise<ArrayBuffer>

  • Decrypts data with an initialization vector and additional authenticated data.

    Parameters

    • iv: ArrayBuffer

      An initialization vector.

    • data: ArrayBuffer

      A plain text as bytes to be encrypted.

    • aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    -

seal

seal

  • seal(iv, data, aad): Promise<ArrayBuffer>

  • Encrypts data with an initialization vector and additional authenticated data.

    Parameters

    • iv: ArrayBuffer

      An initialization vector.

    • data: ArrayBuffer

      A plain text as bytes to be encrypted.

    • aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A cipher text as bytes.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/core/docs/interfaces/AeadInterface.html b/core/docs/interfaces/AeadInterface.html index f2d13c9c9..2784b1266 100644 --- a/core/docs/interfaces/AeadInterface.html +++ b/core/docs/interfaces/AeadInterface.html @@ -1,14 +1,14 @@ AeadInterface | @hpke/core

Interface AeadInterface

The AEAD interface.

-
interface AeadInterface {
    id: AeadId;
    keySize: number;
    nonceSize: number;
    tagSize: number;
    createEncryptionContext(key: ArrayBuffer): AeadEncryptionContext;
}

Implemented by

Properties

id +
interface AeadInterface {
    id: AeadId;
    keySize: number;
    nonceSize: number;
    tagSize: number;
    createEncryptionContext(key: ArrayBuffer): AeadEncryptionContext;
}

Implemented by

Properties

id keySize nonceSize tagSize

Methods

createEncryptionContext

Properties

Readonlyid

id: AeadId

The KDF identifier.

-

ReadonlykeySize

keySize: number

The length in bytes of an AEAD key (Nk).

-

ReadonlynonceSize

nonceSize: number

The length in bytes of an AEAD nonce (Nn).

-

ReadonlytagSize

tagSize: number

The length in bytes of an AEAD authentication tag (Nt).

-

Methods

createEncryptionContext

ReadonlykeySize

keySize: number

The length in bytes of an AEAD key (Nk).

+

ReadonlynonceSize

nonceSize: number

The length in bytes of an AEAD nonce (Nn).

+

ReadonlytagSize

tagSize: number

The length in bytes of an AEAD authentication tag (Nt).

+

Methods

createEncryptionContext

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/core/docs/interfaces/CipherSuiteParams.html b/core/docs/interfaces/CipherSuiteParams.html index a91656dd0..8a68c5324 100644 --- a/core/docs/interfaces/CipherSuiteParams.html +++ b/core/docs/interfaces/CipherSuiteParams.html @@ -1,8 +1,8 @@ CipherSuiteParams | @hpke/core

Interface CipherSuiteParams

The parameters used to configure the CipherSuite.

-
interface CipherSuiteParams {
    aead: AeadId | AeadInterface;
    kdf: KdfId | KdfInterface;
    kem: KemId | KemInterface;
}

Properties

aead +
interface CipherSuiteParams {
    aead: AeadId | AeadInterface;
    kdf: KdfId | KdfInterface;
    kem: KemId | KemInterface;
}

Properties

aead kdf kem

Properties

aead

aead: AeadId | AeadInterface

The AEAD (Authenticated Encryption with Addtional Data) identifier or the AEAD object.

-

kdf

kdf: KdfId | KdfInterface

The KDF (Key Derivation Function) identifier or the KDF object.

-

kem

kem: KemId | KemInterface

The KEM (Key Encapsulation Mechanism) identifier or the KEM object.

-

Settings

Member Visibility

On This Page

Properties
+

kdf

kdf: KdfId | KdfInterface

The KDF (Key Derivation Function) identifier or the KDF object.

+

kem

kem: KemId | KemInterface

The KEM (Key Encapsulation Mechanism) identifier or the KEM object.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/core/docs/interfaces/CipherSuiteSealResponse.html b/core/docs/interfaces/CipherSuiteSealResponse.html index c6f2d1915..c4737a7e4 100644 --- a/core/docs/interfaces/CipherSuiteSealResponse.html +++ b/core/docs/interfaces/CipherSuiteSealResponse.html @@ -1,6 +1,6 @@ CipherSuiteSealResponse | @hpke/core

Interface CipherSuiteSealResponse

The response of the single-shot seal API.

-
interface CipherSuiteSealResponse {
    ct: ArrayBuffer;
    enc: ArrayBuffer;
}

Properties

ct +
interface CipherSuiteSealResponse {
    ct: ArrayBuffer;
    enc: ArrayBuffer;
}

Properties

ct enc

Properties

ct

ct: ArrayBuffer

The ciphertext as bytes.

-

enc

enc: ArrayBuffer

The encapsulated key.

-

Settings

Member Visibility

On This Page

Properties
+

enc

enc: ArrayBuffer

The encapsulated key.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/core/docs/interfaces/EncryptionContext.html b/core/docs/interfaces/EncryptionContext.html index b698b1b34..9b5ebb33b 100644 --- a/core/docs/interfaces/EncryptionContext.html +++ b/core/docs/interfaces/EncryptionContext.html @@ -1,5 +1,5 @@ EncryptionContext | @hpke/core

Interface EncryptionContext

The encryption context interface for a recipient and a sender.

-
interface EncryptionContext {
    export(exporterContext: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    open(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
    seal(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Methods

export +
interface EncryptionContext {
    export(exporterContext: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    open(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
    seal(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Methods

export open seal

Methods

export

  • export(exporterContext, len): Promise<ArrayBuffer>

  • Exports a secret using a variable-length pseudorandom function.

    @@ -8,16 +8,16 @@
  • len: number

    A desired length in bytes of the output secret.

Returns Promise<ArrayBuffer>

A secret string as bytes.

Throws

ExportError

-

open

  • open(data, aad?): Promise<ArrayBuffer>

  • Decrypts data.

    +

open

seal

seal

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/core/docs/interfaces/JsonWebKeyExtended.html b/core/docs/interfaces/JsonWebKeyExtended.html index aa924625e..86fed1b33 100644 --- a/core/docs/interfaces/JsonWebKeyExtended.html +++ b/core/docs/interfaces/JsonWebKeyExtended.html @@ -2,7 +2,7 @@ which are not supported by the current JsonWebKey. Both of them are defined for the newly defined JSON WWb Key type AKP (Algorithm Key Pair), which is used to express Public and Private Keys for use with Algorithms.

-
interface JsonWebKeyExtended {
    alg?: string;
    crv?: string;
    d?: string;
    dp?: string;
    dq?: string;
    e?: string;
    ext?: boolean;
    k?: string;
    key_ops?: string[];
    kty?: string;
    n?: string;
    oth?: RsaOtherPrimesInfo[];
    p?: string;
    priv?: string;
    pub?: string;
    q?: string;
    qi?: string;
    use?: string;
    x?: string;
    y?: string;
}

Hierarchy

Properties

alg? +
interface JsonWebKeyExtended {
    alg?: string;
    crv?: string;
    d?: string;
    dp?: string;
    dq?: string;
    e?: string;
    ext?: boolean;
    k?: string;
    key_ops?: string[];
    kty?: string;
    n?: string;
    oth?: RsaOtherPrimesInfo[];
    p?: string;
    priv?: string;
    pub?: string;
    q?: string;
    qi?: string;
    use?: string;
    x?: string;
    y?: string;
}

Hierarchy

  • JsonWebKey
    • JsonWebKeyExtended

Properties

alg? crv? d? dp? @@ -23,5 +23,5 @@ x? y?

Properties

Optionalalg

alg?: string

Optionalcrv

crv?: string

Optionald

d?: string

Optionaldp

dp?: string

Optionaldq

dq?: string

Optionale

e?: string

Optionalext

ext?: boolean

Optionalk

k?: string

Optionalkey_ops

key_ops?: string[]

Optionalkty

kty?: string

Optionaln

n?: string

Optionaloth

oth?: RsaOtherPrimesInfo[]

Optionalp

p?: string

Optionalpriv

priv?: string

The private key in base64url encoding, which is used with the 'AKP' key type.

-

Optionalpub

pub?: string

The public key in base64url encoding, which is used with the 'AKP' key type.

-

Optionalq

q?: string

Optionalqi

qi?: string

Optionaluse

use?: string

Optionalx

x?: string

Optionaly

y?: string

Settings

Member Visibility

On This Page

Properties
+

Optionalpub

pub?: string

The public key in base64url encoding, which is used with the 'AKP' key type.

+

Optionalq

q?: string

Optionalqi

qi?: string

Optionaluse

use?: string

Optionalx

x?: string

Optionaly

y?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/core/docs/interfaces/KdfInterface.html b/core/docs/interfaces/KdfInterface.html index 49ecc93ff..ed5c41ace 100644 --- a/core/docs/interfaces/KdfInterface.html +++ b/core/docs/interfaces/KdfInterface.html @@ -1,5 +1,5 @@ KdfInterface | @hpke/core

Interface KdfInterface

The KDF interface.

-
interface KdfInterface {
    hashSize: number;
    id: KdfId;
    buildLabeledIkm(label: Uint8Array, ikm: Uint8Array): Uint8Array;
    buildLabeledInfo(label: Uint8Array, info: Uint8Array, len: number): Uint8Array;
    expand(prk: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    extract(salt: ArrayBuffer, ikm: ArrayBuffer): Promise<ArrayBuffer>;
    extractAndExpand(salt: ArrayBuffer, ikm: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    init(suiteId: Uint8Array): void;
    labeledExpand(prk: ArrayBuffer, label: Uint8Array, info: Uint8Array, len: number): Promise<ArrayBuffer>;
    labeledExtract(salt: ArrayBuffer, label: Uint8Array, ikm: Uint8Array): Promise<ArrayBuffer>;
}

Properties

hashSize +
interface KdfInterface {
    hashSize: number;
    id: KdfId;
    buildLabeledIkm(label: Uint8Array, ikm: Uint8Array): Uint8Array;
    buildLabeledInfo(label: Uint8Array, info: Uint8Array, len: number): Uint8Array;
    expand(prk: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    extract(salt: ArrayBuffer, ikm: ArrayBuffer): Promise<ArrayBuffer>;
    extractAndExpand(salt: ArrayBuffer, ikm: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    init(suiteId: Uint8Array): void;
    labeledExpand(prk: ArrayBuffer, label: Uint8Array, info: Uint8Array, len: number): Promise<ArrayBuffer>;
    labeledExtract(salt: ArrayBuffer, label: Uint8Array, ikm: Uint8Array): Promise<ArrayBuffer>;
}

Properties

hashSize id

Methods

buildLabeledIkm buildLabeledInfo @@ -10,41 +10,41 @@ labeledExpand labeledExtract

Properties

ReadonlyhashSize

hashSize: number

The output size of the extract() function in bytes (Nh).

-

Readonlyid

id: KdfId

The KDF identifier.

-

Methods

buildLabeledIkm

Readonlyid

id: KdfId

The KDF identifier.

+

Methods

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

init

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

labeledExtract

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/core/docs/interfaces/KemInterface.html b/core/docs/interfaces/KemInterface.html index 279444764..247f50b2b 100644 --- a/core/docs/interfaces/KemInterface.html +++ b/core/docs/interfaces/KemInterface.html @@ -1,5 +1,5 @@ KemInterface | @hpke/core

Interface KemInterface

The KEM interface.

-
interface KemInterface {
    encSize: number;
    id: KemId;
    privateKeySize: number;
    publicKeySize: number;
    secretSize: number;
    decap(params: RecipientContextParams): Promise<ArrayBuffer>;
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    encap(params: SenderContextParams): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic?: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Properties

encSize +
interface KemInterface {
    encSize: number;
    id: KemId;
    privateKeySize: number;
    publicKeySize: number;
    secretSize: number;
    decap(params: RecipientContextParams): Promise<ArrayBuffer>;
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    encap(params: SenderContextParams): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic?: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Properties

encSize id privateKeySize publicKeySize @@ -14,42 +14,42 @@ serializePrivateKey serializePublicKey

Properties

ReadonlyencSize

encSize: number

The length in bytes of an encapsulated key produced by this KEM (Nenc).

-

Readonlyid

id: KemId

The KEM identifier.

-

ReadonlyprivateKeySize

privateKeySize: number

The length in bytes of an encoded private key for this KEM (Nsk).

-

ReadonlypublicKeySize

publicKeySize: number

The length in bytes of an encoded public key for this KEM (Npk).

-

ReadonlysecretSize

secretSize: number

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

-

Methods

decap

Readonlyid

id: KemId

The KEM identifier.

+

ReadonlyprivateKeySize

privateKeySize: number

The length in bytes of an encoded private key for this KEM (Nsk).

+

ReadonlypublicKeySize

publicKeySize: number

The length in bytes of an encoded public key for this KEM (Npk).

+

ReadonlysecretSize

secretSize: number

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

+

Methods

decap

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

deserializePublicKey

deserializePublicKey

encap

encap

generateKeyPair

generateKeyPair

importKey

importKey

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

serializePrivateKey

serializePublicKey

serializePublicKey

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/core/docs/interfaces/PreSharedKey.html b/core/docs/interfaces/PreSharedKey.html index 358ac739c..ed48b7285 100644 --- a/core/docs/interfaces/PreSharedKey.html +++ b/core/docs/interfaces/PreSharedKey.html @@ -1,6 +1,6 @@ PreSharedKey | @hpke/core

Interface PreSharedKey

The pre-shared key interface.

-
interface PreSharedKey {
    id: ArrayBuffer;
    key: ArrayBuffer;
}

Properties

id +
interface PreSharedKey {
    id: ArrayBuffer;
    key: ArrayBuffer;
}

Properties

id key

Properties

id

id: ArrayBuffer

The key identifier.

-

key

key: ArrayBuffer

The body of the pre-shared key.

-

Settings

Member Visibility

On This Page

Properties
+

key

key: ArrayBuffer

The body of the pre-shared key.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/core/docs/interfaces/RecipientContextParams.html b/core/docs/interfaces/RecipientContextParams.html index f394c2d4d..695d219f9 100644 --- a/core/docs/interfaces/RecipientContextParams.html +++ b/core/docs/interfaces/RecipientContextParams.html @@ -1,13 +1,13 @@ RecipientContextParams | @hpke/core

Interface RecipientContextParams

The parameters used to setup the RecipientContext.

-
interface RecipientContextParams {
    enc: ArrayBuffer;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientKey: CryptoKeyPair | CryptoKey;
    senderPublicKey?: CryptoKey;
}

Hierarchy

  • KeyScheduleParams
    • RecipientContextParams

Properties

enc +
interface RecipientContextParams {
    enc: ArrayBuffer;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientKey: CryptoKeyPair | CryptoKey;
    senderPublicKey?: CryptoKey;
}

Hierarchy

  • KeyScheduleParams
    • RecipientContextParams

Properties

enc info? psk? recipientKey senderPublicKey?

Properties

enc

enc: ArrayBuffer

A byte string of the encapsulated key received from a sender.

-

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

-

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. +

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

+

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

-

recipientKey

recipientKey: CryptoKeyPair | CryptoKey

A recipient private key or a key pair.

-

OptionalsenderPublicKey

senderPublicKey?: CryptoKey

A sender public key for Auth mode.

-

Settings

Member Visibility

On This Page

Properties
+

recipientKey

recipientKey: CryptoKeyPair | CryptoKey

A recipient private key or a key pair.

+

OptionalsenderPublicKey

senderPublicKey?: CryptoKey

A sender public key for Auth mode.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/core/docs/interfaces/SenderContext.html b/core/docs/interfaces/SenderContext.html index b87332036..0c3e81e9c 100644 --- a/core/docs/interfaces/SenderContext.html +++ b/core/docs/interfaces/SenderContext.html @@ -1,25 +1,25 @@ SenderContext | @hpke/core

Interface SenderContext

The sender encryption context.

-
interface SenderContext {
    enc: ArrayBuffer;
    export(exporterContext: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    open(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
    seal(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Properties

enc +
interface SenderContext {
    enc: ArrayBuffer;
    export(exporterContext: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    open(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
    seal(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Properties

enc

Methods

export open seal

Properties

enc

enc: ArrayBuffer

The encapsulated key generated by the sender.

-

Methods

export

Methods

export

  • export(exporterContext, len): Promise<ArrayBuffer>

  • Exports a secret using a variable-length pseudorandom function.

    If the error occurred, throws ExportError.

    Parameters

    • exporterContext: ArrayBuffer

      An exporter context string as bytes. The maximum length is 128 bytes.

    • len: number

      A desired length in bytes of the output secret.

    Returns Promise<ArrayBuffer>

    A secret string as bytes.

    Throws

    ExportError

    -

open

  • open(data, aad?): Promise<ArrayBuffer>

  • Decrypts data.

    +

open

  • open(data, aad?): Promise<ArrayBuffer>

  • Decrypts data.

    If the error occurred, throws OpenError.

    Parameters

    • data: ArrayBuffer

      An encrypted text as bytes to be decrypted.

    • Optionalaad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    Throws

    OpenError

    -

seal

  • seal(data, aad?): Promise<ArrayBuffer>

  • Encrypts data.

    +

seal

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/core/docs/interfaces/SenderContextParams.html b/core/docs/interfaces/SenderContextParams.html index 8f644bf7e..689c7be6d 100644 --- a/core/docs/interfaces/SenderContextParams.html +++ b/core/docs/interfaces/SenderContextParams.html @@ -1,13 +1,13 @@ SenderContextParams | @hpke/core

Interface SenderContextParams

The parameters used to setup the SenderContext.

-
interface SenderContextParams {
    ekm?: ArrayBuffer | CryptoKeyPair;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientPublicKey: CryptoKey;
    senderKey?: CryptoKeyPair | CryptoKey;
}

Hierarchy

  • KeyScheduleParams
    • SenderContextParams

Properties

ekm? +
interface SenderContextParams {
    ekm?: ArrayBuffer | CryptoKeyPair;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientPublicKey: CryptoKey;
    senderKey?: CryptoKeyPair | CryptoKey;
}

Hierarchy

  • KeyScheduleParams
    • SenderContextParams

Properties

ekm? info? psk? recipientPublicKey senderKey?

Properties

Optionalekm

ekm?: ArrayBuffer | CryptoKeyPair

DO NOT USE. FOR DEBUGGING/TESTING PURPOSES ONLY.

-

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

-

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. +

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

+

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

-

recipientPublicKey

recipientPublicKey: CryptoKey

A recipient public key.

-

OptionalsenderKey

senderKey?: CryptoKeyPair | CryptoKey

A sender private key or a key pair for Auth mode.

-

Settings

Member Visibility

On This Page

Properties
+

recipientPublicKey

recipientPublicKey: CryptoKey

A recipient public key.

+

OptionalsenderKey

senderKey?: CryptoKeyPair | CryptoKey

A sender private key or a key pair for Auth mode.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/core/docs/types/AeadId.html b/core/docs/types/AeadId.html index c7f1b8475..1c46216c4 100644 --- a/core/docs/types/AeadId.html +++ b/core/docs/types/AeadId.html @@ -1,2 +1,2 @@ AeadId | @hpke/core

Type Alias AeadId

AeadId: typeof AeadId[keyof typeof AeadId]

The type alias of the supported AEAD identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/core/docs/types/KdfId.html b/core/docs/types/KdfId.html index 3b21b02a7..5db72ee90 100644 --- a/core/docs/types/KdfId.html +++ b/core/docs/types/KdfId.html @@ -1,2 +1,2 @@ KdfId | @hpke/core

Type Alias KdfId

KdfId: typeof KdfId[keyof typeof KdfId]

The type alias of the supported KDF identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/core/docs/types/KemId.html b/core/docs/types/KemId.html index 7a4ccaa92..9069d5917 100644 --- a/core/docs/types/KemId.html +++ b/core/docs/types/KemId.html @@ -1,2 +1,2 @@ KemId | @hpke/core

Type Alias KemId

KemId: typeof KemId[keyof typeof KemId]

The type alias of the supported KEM identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/core/docs/types/RecipientContext.html b/core/docs/types/RecipientContext.html index 542bc9583..ead81a307 100644 --- a/core/docs/types/RecipientContext.html +++ b/core/docs/types/RecipientContext.html @@ -1,2 +1,2 @@ RecipientContext | @hpke/core

Type Alias RecipientContext

RecipientContext: EncryptionContext

The recipient encryption context.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/core/docs/variables/AeadId-1.html b/core/docs/variables/AeadId-1.html index 532512a52..0391267b7 100644 --- a/core/docs/variables/AeadId-1.html +++ b/core/docs/variables/AeadId-1.html @@ -1,2 +1,2 @@ AeadId | @hpke/core

Variable AeadIdConst

AeadId: {
    Aes128Gcm: 1;
    Aes256Gcm: 2;
    Chacha20Poly1305: 3;
    ExportOnly: 65535;
} = ...

The supported Authenticated Encryption with Associated Data (AEAD) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/core/docs/variables/KdfId-1.html b/core/docs/variables/KdfId-1.html index b09f2f2b8..377e3c02e 100644 --- a/core/docs/variables/KdfId-1.html +++ b/core/docs/variables/KdfId-1.html @@ -1,2 +1,2 @@ KdfId | @hpke/core

Variable KdfIdConst

KdfId: {
    HkdfSha256: 1;
    HkdfSha384: 2;
    HkdfSha512: 3;
} = ...

The supported Key Derivation Function (KDF) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/core/docs/variables/KemId-1.html b/core/docs/variables/KemId-1.html index b241ca789..62069ca9b 100644 --- a/core/docs/variables/KemId-1.html +++ b/core/docs/variables/KemId-1.html @@ -1,2 +1,2 @@ KemId | @hpke/core

Variable KemIdConst

KemId: {
    DhkemP256HkdfSha256: 16;
    DhkemP384HkdfSha384: 17;
    DhkemP521HkdfSha512: 18;
    DhkemSecp256k1HkdfSha256: 19;
    DhkemX25519HkdfSha256: 32;
    DhkemX448HkdfSha512: 33;
    HybridkemX25519Kyber768: 48;
    MlKem1024: 66;
    MlKem512: 64;
    MlKem768: 65;
    NotAssigned: 0;
    XWing: 25722;
} = ...

The supported Key Encapsulation Mechanism (KEM) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/dhkem-secp256k1/docs/classes/DhkemSecp256k1HkdfSha256.html b/dhkem-secp256k1/docs/classes/DhkemSecp256k1HkdfSha256.html index 72baf5e3b..2242b2746 100644 --- a/dhkem-secp256k1/docs/classes/DhkemSecp256k1HkdfSha256.html +++ b/dhkem-secp256k1/docs/classes/DhkemSecp256k1HkdfSha256.html @@ -8,7 +8,7 @@

Note that it is experimental and not standardized.

-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_kdf _prim encSize @@ -25,43 +25,43 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected Experimental_kdf

_kdf: KdfInterface

Protected Experimental_prim

_prim: DhkemPrimitives

ExperimentalencSize

encSize: number = 33

33

-

Experimentalid

id: KemId = KemId.DhkemSecp256k1HkdfSha256

KemId.DhkemSecp256k1HkdfSha256 (0x0013) EXPERIMENTAL

-

ExperimentalprivateKeySize

privateKeySize: number = 32

32

-

ExperimentalpublicKeySize

publicKeySize: number = 33

33

-

ExperimentalsecretSize

secretSize: number = 32

32

-

Methods

decap

  • decap(params): Promise<ArrayBuffer>
  • Experimental

    Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected Experimental_kdf

_kdf: KdfInterface

Protected Experimental_prim

_prim: DhkemPrimitives

ExperimentalencSize

encSize: number = 33

33

+

Experimentalid

id: KemId = KemId.DhkemSecp256k1HkdfSha256

KemId.DhkemSecp256k1HkdfSha256 (0x0013) EXPERIMENTAL

+

ExperimentalprivateKeySize

privateKeySize: number = 32

32

+

ExperimentalpublicKeySize

publicKeySize: number = 33

33

+

ExperimentalsecretSize

secretSize: number = 32

32

+

Methods

decap

  • decap(params): Promise<ArrayBuffer>
  • Experimental

    Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for the recipient context.

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>
  • Experimental

    Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>
  • Experimental

    Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>
  • Experimental

    Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>
  • Experimental

    Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>
  • Experimental

    Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>
  • Experimental

    Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>
  • Experimental

    Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>
  • Experimental

    Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    • params: SenderContextParams

      A set of parameters for the sender context.

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>
  • Experimental

    Generates a key pair.

    +

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>
  • Experimental

    Generates a key pair.

    If the error occurred, throws NotSupportedError.

    Returns Promise<CryptoKeyPair>

    A key pair generated.

    Throws

    NotSupportedError

    -

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>
  • Experimental

    Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>
  • Experimental

    Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -73,14 +73,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>
  • Experimental

    Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>
  • Experimental

    Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>
  • Experimental

    Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>
  • Experimental

    Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/dhkem-x25519/docs/classes/DhkemX25519HkdfSha256.html b/dhkem-x25519/docs/classes/DhkemX25519HkdfSha256.html index 83316587f..decfc5087 100644 --- a/dhkem-x25519/docs/classes/DhkemX25519HkdfSha256.html +++ b/dhkem-x25519/docs/classes/DhkemX25519HkdfSha256.html @@ -6,7 +6,7 @@

Example: Use with `@hpke/core`:

import {
  Aes128Gcm,
  CipherSuite,
  HkdfSha256,
} from "@hpke/core";
import { DhkemX25519HkdfSha256 } from "@hpke/dhkem-x25519";

const suite = new CipherSuite({
  kem: new DhkemX25519HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_kdf _prim encSize @@ -23,43 +23,43 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 32

32

-

id

id: KemId = KemId.DhkemX25519HkdfSha256

KemId.DhkemX25519HkdfSha256 (0x0020)

-

privateKeySize

privateKeySize: number = 32

32

-

publicKeySize

publicKeySize: number = 32

32

-

secretSize

secretSize: number = 32

32

-

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 32

32

+

id

id: KemId = KemId.DhkemX25519HkdfSha256

KemId.DhkemX25519HkdfSha256 (0x0020)

+

privateKeySize

privateKeySize: number = 32

32

+

publicKeySize

publicKeySize: number = 32

32

+

secretSize

secretSize: number = 32

32

+

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for the recipient context.

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    • params: SenderContextParams

      A set of parameters for the sender context.

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair.

    If the error occurred, throws NotSupportedError.

    Returns Promise<CryptoKeyPair>

    A key pair generated.

    Throws

    NotSupportedError

    -

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -71,14 +71,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/dhkem-x25519/docs/classes/HkdfSha256.html b/dhkem-x25519/docs/classes/HkdfSha256.html index e5fefa57e..cab4a5d21 100644 --- a/dhkem-x25519/docs/classes/HkdfSha256.html +++ b/dhkem-x25519/docs/classes/HkdfSha256.html @@ -1,4 +1,4 @@ -HkdfSha256 | @hpke/dhkem-x25519

Class HkdfSha256

Hierarchy

  • HkdfSha256Native
    • HkdfSha256

Constructors

constructor +HkdfSha256 | @hpke/dhkem-x25519

Class HkdfSha256

Hierarchy

  • HkdfSha256Native
    • HkdfSha256

Constructors

constructor

Properties

_api _suiteId algHash @@ -14,39 +14,39 @@ init labeledExpand labeledExtract -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

hashSize

hashSize: number = 32

32

-

id

id: KdfId = KdfId.HkdfSha256

KdfId.HkdfSha256 (0x0001)

-

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    +

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

hashSize

hashSize: number = 32

32

+

id

id: KdfId = KdfId.HkdfSha256

KdfId.HkdfSha256 (0x0001)

+

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    +

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    +

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Parameters

    • salt: ArrayBuffer
    • ikm: ArrayBuffer

    Returns Promise<ArrayBuffer>

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Parameters

    • salt: ArrayBuffer
    • ikm: ArrayBuffer

    Returns Promise<ArrayBuffer>

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    +

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

labeledExtract

labeledExtract

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/dhkem-x25519/docs/classes/X25519.html b/dhkem-x25519/docs/classes/X25519.html index d0c7df47b..62181f070 100644 --- a/dhkem-x25519/docs/classes/X25519.html +++ b/dhkem-x25519/docs/classes/X25519.html @@ -1,4 +1,4 @@ -X25519 | @hpke/dhkem-x25519

Class X25519

Implements

  • DhkemPrimitives

Constructors

constructor +X25519 | @hpke/dhkem-x25519

Class X25519

Implements

  • DhkemPrimitives

Constructors

constructor

Methods

derive deriveKeyPair derivePublicKey @@ -9,4 +9,4 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Methods

derive

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Parameters

    • ikm: ArrayBuffer

    Returns Promise<CryptoKeyPair>

derivePublicKey

  • derivePublicKey(key): Promise<CryptoKey>

  • Parameters

    • key: CryptoKey

    Returns Promise<CryptoKey>

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Parameters

    • key: ArrayBuffer

    Returns Promise<CryptoKey>

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Parameters

    • key: ArrayBuffer

    Returns Promise<CryptoKey>

dh

  • dh(sk, pk): Promise<ArrayBuffer>

  • Parameters

    • sk: CryptoKey
    • pk: CryptoKey

    Returns Promise<ArrayBuffer>

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Returns Promise<CryptoKeyPair>

importKey

  • importKey(format, key, isPublic): Promise<CryptoKey>

  • Parameters

    • format: "raw" | "jwk"
    • key: ArrayBuffer | JsonWebKey
    • isPublic: boolean

    Returns Promise<CryptoKey>

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Parameters

    • key: CryptoKey

    Returns Promise<ArrayBuffer>

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Parameters

    • key: CryptoKey

    Returns Promise<ArrayBuffer>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

derive

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Parameters

    • ikm: ArrayBuffer

    Returns Promise<CryptoKeyPair>

derivePublicKey

  • derivePublicKey(key): Promise<CryptoKey>

  • Parameters

    • key: CryptoKey

    Returns Promise<CryptoKey>

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Parameters

    • key: ArrayBuffer

    Returns Promise<CryptoKey>

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Parameters

    • key: ArrayBuffer

    Returns Promise<CryptoKey>

dh

  • dh(sk, pk): Promise<ArrayBuffer>

  • Parameters

    • sk: CryptoKey
    • pk: CryptoKey

    Returns Promise<ArrayBuffer>

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Returns Promise<CryptoKeyPair>

importKey

  • importKey(format, key, isPublic): Promise<CryptoKey>

  • Parameters

    • format: "raw" | "jwk"
    • key: ArrayBuffer | JsonWebKey
    • isPublic: boolean

    Returns Promise<CryptoKey>

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Parameters

    • key: CryptoKey

    Returns Promise<ArrayBuffer>

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Parameters

    • key: CryptoKey

    Returns Promise<ArrayBuffer>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/dhkem-x448/docs/classes/DhkemX448HkdfSha512.html b/dhkem-x448/docs/classes/DhkemX448HkdfSha512.html index 25f250268..5cd4908a4 100644 --- a/dhkem-x448/docs/classes/DhkemX448HkdfSha512.html +++ b/dhkem-x448/docs/classes/DhkemX448HkdfSha512.html @@ -6,7 +6,7 @@

Example: Use with `@hpke/core`:

import {
  Aes256Gcm,
  CipherSuite,
  HkdfSha512,
} from "@hpke/core";
import { DhkemX448HkdfSha512 } from "@hpke/dhkem-x448";

const suite = new CipherSuite({
  kem: new DhkemX448HkdfSha512(),
  kdf: new HkdfSha512(),
  aead: new Aes256Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_kdf _prim encSize @@ -23,43 +23,43 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 56

56

-

id

id: KemId = KemId.DhkemX448HkdfSha512

KemId.DhkemX448HkdfSha512 (0x0021)

-

privateKeySize

privateKeySize: number = 56

56

-

publicKeySize

publicKeySize: number = 56

56

-

secretSize

secretSize: number = 64

64

-

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

encSize

encSize: number = 56

56

+

id

id: KemId = KemId.DhkemX448HkdfSha512

KemId.DhkemX448HkdfSha512 (0x0021)

+

privateKeySize

privateKeySize: number = 56

56

+

publicKeySize

publicKeySize: number = 56

56

+

secretSize

secretSize: number = 64

64

+

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for the recipient context.

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    • params: SenderContextParams

      A set of parameters for the sender context.

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair.

    If the error occurred, throws NotSupportedError.

    Returns Promise<CryptoKeyPair>

    A key pair generated.

    Throws

    NotSupportedError

    -

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -71,14 +71,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/dhkem-x448/docs/classes/HkdfSha512.html b/dhkem-x448/docs/classes/HkdfSha512.html index 1c338307b..20800355e 100644 --- a/dhkem-x448/docs/classes/HkdfSha512.html +++ b/dhkem-x448/docs/classes/HkdfSha512.html @@ -1,4 +1,4 @@ -HkdfSha512 | @hpke/dhkem-x448

Class HkdfSha512

Hierarchy

  • HkdfSha512Native
    • HkdfSha512

Constructors

constructor +HkdfSha512 | @hpke/dhkem-x448

Class HkdfSha512

Hierarchy

  • HkdfSha512Native
    • HkdfSha512

Constructors

constructor

Properties

_api _suiteId algHash @@ -14,39 +14,39 @@ init labeledExpand labeledExtract -

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

hashSize

hashSize: number = 64

64

-

id

id: KdfId = KdfId.HkdfSha512

KdfId.HkdfSha512 (0x0003)

-

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    +

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_suiteId

_suiteId: Uint8Array = EMPTY

algHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

hashSize

hashSize: number = 64

64

+

id

id: KdfId = KdfId.HkdfSha512

KdfId.HkdfSha512 (0x0003)

+

Methods

Protected_checkInit

Protected_setup

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    +

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    +

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Parameters

    • salt: ArrayBuffer
    • ikm: ArrayBuffer

    Returns Promise<ArrayBuffer>

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    +

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Parameters

    • salt: ArrayBuffer
    • ikm: ArrayBuffer

    Returns Promise<ArrayBuffer>

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    +

init

  • init(suiteId): void

  • Initializes the instance by setting a suite_id defined in RFC9180.

    Parameters

    • suiteId: Uint8Array

      A suite_id defined in RFC9180.

      -

    Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

labeledExtract

labeledExtract

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/dhkem-x448/docs/classes/X448.html b/dhkem-x448/docs/classes/X448.html index 365954dc3..a4860a0c4 100644 --- a/dhkem-x448/docs/classes/X448.html +++ b/dhkem-x448/docs/classes/X448.html @@ -1,4 +1,4 @@ -X448 | @hpke/dhkem-x448

Class X448

Implements

  • DhkemPrimitives

Constructors

constructor +X448 | @hpke/dhkem-x448

Class X448

Implements

  • DhkemPrimitives

Constructors

constructor

Methods

deriveKeyPair derivePublicKey deserializePrivateKey @@ -8,4 +8,4 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Methods

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Parameters

    • ikm: ArrayBuffer

    Returns Promise<CryptoKeyPair>

derivePublicKey

  • derivePublicKey(key): Promise<CryptoKey>

  • Parameters

    • key: CryptoKey

    Returns Promise<CryptoKey>

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Parameters

    • key: ArrayBuffer

    Returns Promise<CryptoKey>

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Parameters

    • key: ArrayBuffer

    Returns Promise<CryptoKey>

dh

  • dh(sk, pk): Promise<ArrayBuffer>

  • Parameters

    • sk: CryptoKey
    • pk: CryptoKey

    Returns Promise<ArrayBuffer>

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Returns Promise<CryptoKeyPair>

importKey

  • importKey(format, key, isPublic): Promise<CryptoKey>

  • Parameters

    • format: "raw" | "jwk"
    • key: ArrayBuffer | JsonWebKey
    • isPublic: boolean

    Returns Promise<CryptoKey>

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Parameters

    • key: CryptoKey

    Returns Promise<ArrayBuffer>

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Parameters

    • key: CryptoKey

    Returns Promise<ArrayBuffer>

Settings

Member Visibility

On This Page

Constructors
Methods
+

Constructors

constructor

Methods

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Parameters

    • ikm: ArrayBuffer

    Returns Promise<CryptoKeyPair>

derivePublicKey

  • derivePublicKey(key): Promise<CryptoKey>

  • Parameters

    • key: CryptoKey

    Returns Promise<CryptoKey>

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Parameters

    • key: ArrayBuffer

    Returns Promise<CryptoKey>

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Parameters

    • key: ArrayBuffer

    Returns Promise<CryptoKey>

dh

  • dh(sk, pk): Promise<ArrayBuffer>

  • Parameters

    • sk: CryptoKey
    • pk: CryptoKey

    Returns Promise<ArrayBuffer>

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Returns Promise<CryptoKeyPair>

importKey

  • importKey(format, key, isPublic): Promise<CryptoKey>

  • Parameters

    • format: "raw" | "jwk"
    • key: ArrayBuffer | JsonWebKey
    • isPublic: boolean

    Returns Promise<CryptoKey>

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Parameters

    • key: CryptoKey

    Returns Promise<ArrayBuffer>

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Parameters

    • key: CryptoKey

    Returns Promise<ArrayBuffer>

Settings

Member Visibility

On This Page

Constructors
Methods
diff --git a/docs/classes/CipherSuite.html b/docs/classes/CipherSuite.html index 856d0b4cd..e759e54b2 100644 --- a/docs/classes/CipherSuite.html +++ b/docs/classes/CipherSuite.html @@ -31,7 +31,7 @@

Example: Use a ciphersuite consisting of an external module.

import { AeadId, CipherSuite, KdfId } from "@hpke/hpke-js";
// Use an extension module.
import {
  HybridkemX25519Kyber768,
} from "@hpke/hybridkem-x25519-kyber768";

const suite = new CipherSuite({
  kem: new HybridkemX25519Kyber768(),
  kdf: KdfId.HkdfSha256,
  aead: AeadId.Aes128Gcm,
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_api _kem

Accessors

aead @@ -47,33 +47,33 @@ seal

Constructors

constructor

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_kem

_kem: KemInterface

Accessors

aead

kdf

kem

Methods

Protected_setup

createRecipientContext

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_kem

_kem: KemInterface

Accessors

aead

kdf

kem

Methods

Protected_setup

createRecipientContext

createSenderContext

createSenderContext

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair for the cipher suite in the manner +

deriveKeyPair

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair for the cipher suite.

    +

generateKeyPair

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -86,18 +86,18 @@

Returns Promise<CryptoKey>

A public or private CryptoKey.

Deprecated

Use KemInterface.generateKeyPair instead.

Throws

DeserializeError

-

open

  • open(params, ct, aad?): Promise<ArrayBuffer>

  • Decrypts a message from a sender.

    +

open

  • open(params, ct, aad?): Promise<ArrayBuffer>

  • Decrypts a message from a sender.

    If the error occurred, throws DecapError | DeserializeError | OpenError | ValidationError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for building a recipient encryption context.

    • ct: ArrayBuffer

      An encrypted text as bytes to be decrypted.

    • aad: ArrayBuffer = EMPTY

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    Throws

    DecapError, DeserializeError, OpenError, ValidationError

    -

seal

seal

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/classes/DecapError.html b/docs/classes/DecapError.html index dde8292f5..a426a534d 100644 --- a/docs/classes/DecapError.html +++ b/docs/classes/DecapError.html @@ -1,7 +1,7 @@ DecapError | @hpke/hpke-js

Class DecapError

decap() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/DeriveKeyPairError.html b/docs/classes/DeriveKeyPairError.html index 4bc3fb78c..a9810fdcf 100644 --- a/docs/classes/DeriveKeyPairError.html +++ b/docs/classes/DeriveKeyPairError.html @@ -1,7 +1,7 @@ DeriveKeyPairError | @hpke/hpke-js

Class DeriveKeyPairError

Key pair derivation failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/DeserializeError.html b/docs/classes/DeserializeError.html index e940f1fdc..4432b2bf5 100644 --- a/docs/classes/DeserializeError.html +++ b/docs/classes/DeserializeError.html @@ -1,7 +1,7 @@ DeserializeError | @hpke/hpke-js

Class DeserializeError

Public or private key deserialization failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/EncapError.html b/docs/classes/EncapError.html index 0f668facd..e610682ab 100644 --- a/docs/classes/EncapError.html +++ b/docs/classes/EncapError.html @@ -1,7 +1,7 @@ EncapError | @hpke/hpke-js

Class EncapError

encap() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/ExportError.html b/docs/classes/ExportError.html index 8964c81e7..a41e9b2e7 100644 --- a/docs/classes/ExportError.html +++ b/docs/classes/ExportError.html @@ -1,7 +1,7 @@ ExportError | @hpke/hpke-js

Class ExportError

Secret export failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/HpkeError.html b/docs/classes/HpkeError.html index da4c01086..1b423b78c 100644 --- a/docs/classes/HpkeError.html +++ b/docs/classes/HpkeError.html @@ -1,7 +1,7 @@ HpkeError | @hpke/hpke-js

Class HpkeError

The base error class of hpke-js.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/InvalidParamError.html b/docs/classes/InvalidParamError.html index d700dbf96..447035a5f 100644 --- a/docs/classes/InvalidParamError.html +++ b/docs/classes/InvalidParamError.html @@ -1,7 +1,7 @@ InvalidParamError | @hpke/hpke-js

Class InvalidParamError

Invalid parameter.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/MessageLimitReachedError.html b/docs/classes/MessageLimitReachedError.html index 844457f5c..2b8db25fb 100644 --- a/docs/classes/MessageLimitReachedError.html +++ b/docs/classes/MessageLimitReachedError.html @@ -1,7 +1,7 @@ MessageLimitReachedError | @hpke/hpke-js

Class MessageLimitReachedError

Sequence number overflow on the encryption context.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/NotSupportedError.html b/docs/classes/NotSupportedError.html index 68c2c5aa0..3823f8573 100644 --- a/docs/classes/NotSupportedError.html +++ b/docs/classes/NotSupportedError.html @@ -1,7 +1,7 @@ NotSupportedError | @hpke/hpke-js

Class NotSupportedError

Not supported failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/OpenError.html b/docs/classes/OpenError.html index 678e0b4f9..b59919eb9 100644 --- a/docs/classes/OpenError.html +++ b/docs/classes/OpenError.html @@ -1,7 +1,7 @@ OpenError | @hpke/hpke-js

Class OpenError

open() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/SealError.html b/docs/classes/SealError.html index aa05a4ace..c1ed38e6c 100644 --- a/docs/classes/SealError.html +++ b/docs/classes/SealError.html @@ -1,7 +1,7 @@ SealError | @hpke/hpke-js

Class SealError

seal() failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/SerializeError.html b/docs/classes/SerializeError.html index 06620a161..535bcf18c 100644 --- a/docs/classes/SerializeError.html +++ b/docs/classes/SerializeError.html @@ -1,7 +1,7 @@ SerializeError | @hpke/hpke-js

Class SerializeError

Public or private key serialization failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/classes/ValidationError.html b/docs/classes/ValidationError.html index 9cb606aa0..66fe75c9a 100644 --- a/docs/classes/ValidationError.html +++ b/docs/classes/ValidationError.html @@ -1,7 +1,7 @@ ValidationError | @hpke/hpke-js

Class ValidationError

KEM input or output validation failure.

-

Hierarchy (view full)

Constructors

constructor +

Hierarchy (view full)

Constructors

constructor

Properties

cause? message name stack? -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/interfaces/AeadEncryptionContext.html b/docs/interfaces/AeadEncryptionContext.html index 42fd02efb..241ebacee 100644 --- a/docs/interfaces/AeadEncryptionContext.html +++ b/docs/interfaces/AeadEncryptionContext.html @@ -1,14 +1,14 @@ AeadEncryptionContext | @hpke/hpke-js

Interface AeadEncryptionContext

The AEAD encryption context interface.

-
interface AeadEncryptionContext {
    open(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
    seal(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
}

Methods

open +
interface AeadEncryptionContext {
    open(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
    seal(iv: ArrayBuffer, data: ArrayBuffer, aad: ArrayBuffer): Promise<ArrayBuffer>;
}

Methods

open seal

Methods

open

  • open(iv, data, aad): Promise<ArrayBuffer>

  • Decrypts data with an initialization vector and additional authenticated data.

    Parameters

    • iv: ArrayBuffer

      An initialization vector.

    • data: ArrayBuffer

      A plain text as bytes to be encrypted.

    • aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    -

seal

seal

  • seal(iv, data, aad): Promise<ArrayBuffer>

  • Encrypts data with an initialization vector and additional authenticated data.

    Parameters

    • iv: ArrayBuffer

      An initialization vector.

    • data: ArrayBuffer

      A plain text as bytes to be encrypted.

    • aad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A cipher text as bytes.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/AeadInterface.html b/docs/interfaces/AeadInterface.html index a934af7f7..9b4ef2d5e 100644 --- a/docs/interfaces/AeadInterface.html +++ b/docs/interfaces/AeadInterface.html @@ -1,14 +1,14 @@ AeadInterface | @hpke/hpke-js

Interface AeadInterface

The AEAD interface.

-
interface AeadInterface {
    id: AeadId;
    keySize: number;
    nonceSize: number;
    tagSize: number;
    createEncryptionContext(key: ArrayBuffer): AeadEncryptionContext;
}

Properties

id +
interface AeadInterface {
    id: AeadId;
    keySize: number;
    nonceSize: number;
    tagSize: number;
    createEncryptionContext(key: ArrayBuffer): AeadEncryptionContext;
}

Properties

id keySize nonceSize tagSize

Methods

createEncryptionContext

Properties

Readonlyid

id: AeadId

The KDF identifier.

-

ReadonlykeySize

keySize: number

The length in bytes of an AEAD key (Nk).

-

ReadonlynonceSize

nonceSize: number

The length in bytes of an AEAD nonce (Nn).

-

ReadonlytagSize

tagSize: number

The length in bytes of an AEAD authentication tag (Nt).

-

Methods

createEncryptionContext

ReadonlykeySize

keySize: number

The length in bytes of an AEAD key (Nk).

+

ReadonlynonceSize

nonceSize: number

The length in bytes of an AEAD nonce (Nn).

+

ReadonlytagSize

tagSize: number

The length in bytes of an AEAD authentication tag (Nt).

+

Methods

createEncryptionContext

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/CipherSuiteParams.html b/docs/interfaces/CipherSuiteParams.html index 777d39a6c..24c6d4de1 100644 --- a/docs/interfaces/CipherSuiteParams.html +++ b/docs/interfaces/CipherSuiteParams.html @@ -1,8 +1,8 @@ CipherSuiteParams | @hpke/hpke-js

Interface CipherSuiteParams

The parameters used to configure the CipherSuite.

-
interface CipherSuiteParams {
    aead: AeadId | AeadInterface;
    kdf: KdfId | KdfInterface;
    kem: KemId | KemInterface;
}

Properties

aead +
interface CipherSuiteParams {
    aead: AeadId | AeadInterface;
    kdf: KdfId | KdfInterface;
    kem: KemId | KemInterface;
}

Properties

aead kdf kem

Properties

aead

aead: AeadId | AeadInterface

The AEAD (Authenticated Encryption with Addtional Data) identifier or the AEAD object.

-

kdf

kdf: KdfId | KdfInterface

The KDF (Key Derivation Function) identifier or the KDF object.

-

kem

kem: KemId | KemInterface

The KEM (Key Encapsulation Mechanism) identifier or the KEM object.

-

Settings

Member Visibility

On This Page

Properties
+

kdf

kdf: KdfId | KdfInterface

The KDF (Key Derivation Function) identifier or the KDF object.

+

kem

kem: KemId | KemInterface

The KEM (Key Encapsulation Mechanism) identifier or the KEM object.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CipherSuiteSealResponse.html b/docs/interfaces/CipherSuiteSealResponse.html index a71653591..1272e9a1d 100644 --- a/docs/interfaces/CipherSuiteSealResponse.html +++ b/docs/interfaces/CipherSuiteSealResponse.html @@ -1,6 +1,6 @@ CipherSuiteSealResponse | @hpke/hpke-js

Interface CipherSuiteSealResponse

The response of the single-shot seal API.

-
interface CipherSuiteSealResponse {
    ct: ArrayBuffer;
    enc: ArrayBuffer;
}

Properties

ct +
interface CipherSuiteSealResponse {
    ct: ArrayBuffer;
    enc: ArrayBuffer;
}

Properties

ct enc

Properties

ct

ct: ArrayBuffer

The ciphertext as bytes.

-

enc

enc: ArrayBuffer

The encapsulated key.

-

Settings

Member Visibility

On This Page

Properties
+

enc

enc: ArrayBuffer

The encapsulated key.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/EncryptionContext.html b/docs/interfaces/EncryptionContext.html index b1e303155..be9a90153 100644 --- a/docs/interfaces/EncryptionContext.html +++ b/docs/interfaces/EncryptionContext.html @@ -1,5 +1,5 @@ EncryptionContext | @hpke/hpke-js

Interface EncryptionContext

The encryption context interface for a recipient and a sender.

-
interface EncryptionContext {
    export(exporterContext: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    open(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
    seal(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Methods

export +
interface EncryptionContext {
    export(exporterContext: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    open(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
    seal(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Methods

export open seal

Methods

export

  • export(exporterContext, len): Promise<ArrayBuffer>

  • Exports a secret using a variable-length pseudorandom function.

    @@ -8,16 +8,16 @@
  • len: number

    A desired length in bytes of the output secret.

Returns Promise<ArrayBuffer>

A secret string as bytes.

Throws

ExportError

-

open

  • open(data, aad?): Promise<ArrayBuffer>

  • Decrypts data.

    +

open

seal

seal

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/interfaces/KdfInterface.html b/docs/interfaces/KdfInterface.html index 17d69ed2c..b6a9e77d8 100644 --- a/docs/interfaces/KdfInterface.html +++ b/docs/interfaces/KdfInterface.html @@ -1,5 +1,5 @@ KdfInterface | @hpke/hpke-js

Interface KdfInterface

The KDF interface.

-
interface KdfInterface {
    hashSize: number;
    id: KdfId;
    buildLabeledIkm(label: Uint8Array, ikm: Uint8Array): Uint8Array;
    buildLabeledInfo(label: Uint8Array, info: Uint8Array, len: number): Uint8Array;
    expand(prk: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    extract(salt: ArrayBuffer, ikm: ArrayBuffer): Promise<ArrayBuffer>;
    extractAndExpand(salt: ArrayBuffer, ikm: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    init(suiteId: Uint8Array): void;
    labeledExpand(prk: ArrayBuffer, label: Uint8Array, info: Uint8Array, len: number): Promise<ArrayBuffer>;
    labeledExtract(salt: ArrayBuffer, label: Uint8Array, ikm: Uint8Array): Promise<ArrayBuffer>;
}

Properties

hashSize +
interface KdfInterface {
    hashSize: number;
    id: KdfId;
    buildLabeledIkm(label: Uint8Array, ikm: Uint8Array): Uint8Array;
    buildLabeledInfo(label: Uint8Array, info: Uint8Array, len: number): Uint8Array;
    expand(prk: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    extract(salt: ArrayBuffer, ikm: ArrayBuffer): Promise<ArrayBuffer>;
    extractAndExpand(salt: ArrayBuffer, ikm: ArrayBuffer, info: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    init(suiteId: Uint8Array): void;
    labeledExpand(prk: ArrayBuffer, label: Uint8Array, info: Uint8Array, len: number): Promise<ArrayBuffer>;
    labeledExtract(salt: ArrayBuffer, label: Uint8Array, ikm: Uint8Array): Promise<ArrayBuffer>;
}

Properties

hashSize id

Methods

buildLabeledIkm buildLabeledInfo @@ -10,41 +10,41 @@ labeledExpand labeledExtract

Properties

ReadonlyhashSize

hashSize: number

The output size of the extract() function in bytes (Nh).

-

Readonlyid

id: KdfId

The KDF identifier.

-

Methods

buildLabeledIkm

Readonlyid

id: KdfId

The KDF identifier.

+

Methods

buildLabeledIkm

  • buildLabeledIkm(label, ikm): Uint8Array

  • Builds a labeled input keying material.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

    Returns Uint8Array

    An input keying material as bytes.

    -

buildLabeledInfo

buildLabeledInfo

  • buildLabeledInfo(label, info, len): Uint8Array

  • Builds a labeled info string.

    Parameters

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length of the output byte string.

    Returns Uint8Array

    An info string as bytes.

    -

expand

expand

  • expand(prk, info, len): Promise<ArrayBuffer>

  • Expands a pseudorandom key prk.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

extract

extract

  • extract(salt, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key of fixed length (Nh) bytes.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

extractAndExpand

extractAndExpand

  • extractAndExpand(salt, ikm, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key and expand it to a specified length keying material.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • ikm: ArrayBuffer

      An input keying material

    • info: ArrayBuffer

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

init

init

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    +

Returns void

labeledExpand

  • labeledExpand(prk, label, info, len): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • prk: ArrayBuffer

      A pseudorandom key.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • info: Uint8Array

      An additional byte string.

    • len: number

      The length in bytes of the output keying material.

    Returns Promise<ArrayBuffer>

    An output keying material as bytes.

    -

labeledExtract

labeledExtract

  • labeledExtract(salt, label, ikm): Promise<ArrayBuffer>

  • Extracts a pseudorandom key with label.

    Parameters

    • salt: ArrayBuffer

      An additional random byte string.

    • label: Uint8Array

      A byte string indicating the cryptographic context/operation.

    • ikm: Uint8Array

      An input keying material

    Returns Promise<ArrayBuffer>

    A pseudorandom key as bytes.

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/KemInterface.html b/docs/interfaces/KemInterface.html index 6f756e3d4..1bd31be00 100644 --- a/docs/interfaces/KemInterface.html +++ b/docs/interfaces/KemInterface.html @@ -1,5 +1,5 @@ KemInterface | @hpke/hpke-js

Interface KemInterface

The KEM interface.

-
interface KemInterface {
    encSize: number;
    id: KemId;
    privateKeySize: number;
    publicKeySize: number;
    secretSize: number;
    decap(params: RecipientContextParams): Promise<ArrayBuffer>;
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    encap(params: SenderContextParams): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic?: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Properties

encSize +
interface KemInterface {
    encSize: number;
    id: KemId;
    privateKeySize: number;
    publicKeySize: number;
    secretSize: number;
    decap(params: RecipientContextParams): Promise<ArrayBuffer>;
    deriveKeyPair(ikm: ArrayBuffer): Promise<CryptoKeyPair>;
    deserializePrivateKey(key: ArrayBuffer): Promise<CryptoKey>;
    deserializePublicKey(key: ArrayBuffer): Promise<CryptoKey>;
    encap(params: SenderContextParams): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>;
    generateKeyPair(): Promise<CryptoKeyPair>;
    importKey(format: "raw" | "jwk", key: ArrayBuffer | JsonWebKey, isPublic?: boolean): Promise<CryptoKey>;
    serializePrivateKey(key: CryptoKey): Promise<ArrayBuffer>;
    serializePublicKey(key: CryptoKey): Promise<ArrayBuffer>;
}

Properties

encSize id privateKeySize publicKeySize @@ -14,42 +14,42 @@ serializePrivateKey serializePublicKey

Properties

ReadonlyencSize

encSize: number

The length in bytes of an encapsulated key produced by this KEM (Nenc).

-

Readonlyid

id: KemId

The KEM identifier.

-

ReadonlyprivateKeySize

privateKeySize: number

The length in bytes of an encoded private key for this KEM (Nsk).

-

ReadonlypublicKeySize

publicKeySize: number

The length in bytes of an encoded public key for this KEM (Npk).

-

ReadonlysecretSize

secretSize: number

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

-

Methods

decap

Readonlyid

id: KemId

The KEM identifier.

+

ReadonlyprivateKeySize

privateKeySize: number

The length in bytes of an encoded private key for this KEM (Nsk).

+

ReadonlypublicKeySize

publicKeySize: number

The length in bytes of an encoded public key for this KEM (Npk).

+

ReadonlysecretSize

secretSize: number

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

+

Methods

decap

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

deserializePublicKey

deserializePublicKey

encap

encap

generateKeyPair

generateKeyPair

importKey

importKey

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

serializePrivateKey

serializePublicKey

serializePublicKey

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/PreSharedKey.html b/docs/interfaces/PreSharedKey.html index 3fb1e4710..fac84d92e 100644 --- a/docs/interfaces/PreSharedKey.html +++ b/docs/interfaces/PreSharedKey.html @@ -1,6 +1,6 @@ PreSharedKey | @hpke/hpke-js

Interface PreSharedKey

The pre-shared key interface.

-
interface PreSharedKey {
    id: ArrayBuffer;
    key: ArrayBuffer;
}

Properties

id +
interface PreSharedKey {
    id: ArrayBuffer;
    key: ArrayBuffer;
}

Properties

id key

Properties

id

id: ArrayBuffer

The key identifier.

-

key

key: ArrayBuffer

The body of the pre-shared key.

-

Settings

Member Visibility

On This Page

Properties
+

key

key: ArrayBuffer

The body of the pre-shared key.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/RecipientContextParams.html b/docs/interfaces/RecipientContextParams.html index 7123ddd54..2817a65fa 100644 --- a/docs/interfaces/RecipientContextParams.html +++ b/docs/interfaces/RecipientContextParams.html @@ -1,13 +1,13 @@ RecipientContextParams | @hpke/hpke-js

Interface RecipientContextParams

The parameters used to setup the RecipientContext.

-
interface RecipientContextParams {
    enc: ArrayBuffer;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientKey: CryptoKeyPair | CryptoKey;
    senderPublicKey?: CryptoKey;
}

Hierarchy

  • KeyScheduleParams
    • RecipientContextParams

Properties

enc +
interface RecipientContextParams {
    enc: ArrayBuffer;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientKey: CryptoKeyPair | CryptoKey;
    senderPublicKey?: CryptoKey;
}

Hierarchy

  • KeyScheduleParams
    • RecipientContextParams

Properties

enc info? psk? recipientKey senderPublicKey?

Properties

enc

enc: ArrayBuffer

A byte string of the encapsulated key received from a sender.

-

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

-

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. +

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

+

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

-

recipientKey

recipientKey: CryptoKeyPair | CryptoKey

A recipient private key or a key pair.

-

OptionalsenderPublicKey

senderPublicKey?: CryptoKey

A sender public key for Auth mode.

-

Settings

Member Visibility

On This Page

Properties
+

recipientKey

recipientKey: CryptoKeyPair | CryptoKey

A recipient private key or a key pair.

+

OptionalsenderPublicKey

senderPublicKey?: CryptoKey

A sender public key for Auth mode.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/SenderContext.html b/docs/interfaces/SenderContext.html index f4b1ba8cf..9b1bf3d4b 100644 --- a/docs/interfaces/SenderContext.html +++ b/docs/interfaces/SenderContext.html @@ -1,25 +1,25 @@ SenderContext | @hpke/hpke-js

Interface SenderContext

The sender encryption context.

-
interface SenderContext {
    enc: ArrayBuffer;
    export(exporterContext: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    open(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
    seal(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Properties

enc +
interface SenderContext {
    enc: ArrayBuffer;
    export(exporterContext: ArrayBuffer, len: number): Promise<ArrayBuffer>;
    open(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
    seal(data: ArrayBuffer, aad?: ArrayBuffer): Promise<ArrayBuffer>;
}

Hierarchy (view full)

Properties

enc

Methods

export open seal

Properties

enc

enc: ArrayBuffer

The encapsulated key generated by the sender.

-

Methods

export

Methods

export

  • export(exporterContext, len): Promise<ArrayBuffer>

  • Exports a secret using a variable-length pseudorandom function.

    If the error occurred, throws ExportError.

    Parameters

    • exporterContext: ArrayBuffer

      An exporter context string as bytes. The maximum length is 128 bytes.

    • len: number

      A desired length in bytes of the output secret.

    Returns Promise<ArrayBuffer>

    A secret string as bytes.

    Throws

    ExportError

    -

open

  • open(data, aad?): Promise<ArrayBuffer>

  • Decrypts data.

    +

open

  • open(data, aad?): Promise<ArrayBuffer>

  • Decrypts data.

    If the error occurred, throws OpenError.

    Parameters

    • data: ArrayBuffer

      An encrypted text as bytes to be decrypted.

    • Optionalaad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A decrypted plain text as bytes.

    Throws

    OpenError

    -

seal

  • seal(data, aad?): Promise<ArrayBuffer>

  • Encrypts data.

    +

seal

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/SenderContextParams.html b/docs/interfaces/SenderContextParams.html index e300b9aa2..f700dbbcc 100644 --- a/docs/interfaces/SenderContextParams.html +++ b/docs/interfaces/SenderContextParams.html @@ -1,13 +1,13 @@ SenderContextParams | @hpke/hpke-js

Interface SenderContextParams

The parameters used to setup the SenderContext.

-
interface SenderContextParams {
    ekm?: ArrayBuffer | CryptoKeyPair;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientPublicKey: CryptoKey;
    senderKey?: CryptoKeyPair | CryptoKey;
}

Hierarchy

  • KeyScheduleParams
    • SenderContextParams

Properties

ekm? +
interface SenderContextParams {
    ekm?: ArrayBuffer | CryptoKeyPair;
    info?: ArrayBuffer;
    psk?: PreSharedKey;
    recipientPublicKey: CryptoKey;
    senderKey?: CryptoKeyPair | CryptoKey;
}

Hierarchy

  • KeyScheduleParams
    • SenderContextParams

Properties

ekm? info? psk? recipientPublicKey senderKey?

Properties

Optionalekm

ekm?: ArrayBuffer | CryptoKeyPair

DO NOT USE. FOR DEBUGGING/TESTING PURPOSES ONLY.

-

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

-

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. +

Optionalinfo

info?: ArrayBuffer

Application supplied information. The maximum length is 128 bytes.

+

Optionalpsk

psk?: PreSharedKey

A pre-shared key (PSK) held by both the sender and recipient. The PSK should have at least 32 bytes :and the maxmum length of the PSK is 128 bytes.

-

recipientPublicKey

recipientPublicKey: CryptoKey

A recipient public key.

-

OptionalsenderKey

senderKey?: CryptoKeyPair | CryptoKey

A sender private key or a key pair for Auth mode.

-

Settings

Member Visibility

On This Page

Properties
+

recipientPublicKey

recipientPublicKey: CryptoKey

A recipient public key.

+

OptionalsenderKey

senderKey?: CryptoKeyPair | CryptoKey

A sender private key or a key pair for Auth mode.

+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/types/Aead.html b/docs/types/Aead.html index 6a26e36f9..058c31e95 100644 --- a/docs/types/Aead.html +++ b/docs/types/Aead.html @@ -1,3 +1,3 @@ Aead | @hpke/hpke-js

Type Alias Aead

Aead: typeof Aead[keyof typeof Aead]

The type alias of the supported AEAD identifiers.

Deprecated

Use AeadId instead.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/AeadId.html b/docs/types/AeadId.html index 58bd23ebc..df72fb16b 100644 --- a/docs/types/AeadId.html +++ b/docs/types/AeadId.html @@ -1,2 +1,2 @@ AeadId | @hpke/hpke-js

Type Alias AeadId

AeadId: typeof AeadId[keyof typeof AeadId]

The type alias of the supported AEAD identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/Kdf.html b/docs/types/Kdf.html index 5c1c18857..50dadf959 100644 --- a/docs/types/Kdf.html +++ b/docs/types/Kdf.html @@ -1,3 +1,3 @@ Kdf | @hpke/hpke-js

Type Alias Kdf

Kdf: typeof Kdf[keyof typeof Kdf]

The type alias of the supported KDF identifiers.

Deprecated

Use KdfId instead.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/KdfId.html b/docs/types/KdfId.html index a32735198..04a838e79 100644 --- a/docs/types/KdfId.html +++ b/docs/types/KdfId.html @@ -1,2 +1,2 @@ KdfId | @hpke/hpke-js

Type Alias KdfId

KdfId: typeof KdfId[keyof typeof KdfId]

The type alias of the supported KDF identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/Kem.html b/docs/types/Kem.html index 1533e4015..7e509676f 100644 --- a/docs/types/Kem.html +++ b/docs/types/Kem.html @@ -1,3 +1,3 @@ Kem | @hpke/hpke-js

Type Alias Kem

Kem: typeof Kem[keyof typeof Kem]

The type alias of the supported KEM identifiers.

Deprecated

Use KdfId instead.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/KemId.html b/docs/types/KemId.html index e820bdabf..78d709784 100644 --- a/docs/types/KemId.html +++ b/docs/types/KemId.html @@ -1,2 +1,2 @@ KemId | @hpke/hpke-js

Type Alias KemId

KemId: typeof KemId[keyof typeof KemId]

The type alias of the supported KEM identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/types/RecipientContext.html b/docs/types/RecipientContext.html index 0f6191866..8cdf84a74 100644 --- a/docs/types/RecipientContext.html +++ b/docs/types/RecipientContext.html @@ -1,2 +1,2 @@ RecipientContext | @hpke/hpke-js

Type Alias RecipientContext

RecipientContext: EncryptionContext

The recipient encryption context.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/Aead-1.html b/docs/variables/Aead-1.html index 19c194689..79348a4c4 100644 --- a/docs/variables/Aead-1.html +++ b/docs/variables/Aead-1.html @@ -1,3 +1,3 @@ Aead | @hpke/hpke-js

Variable AeadConst

Aead: {
    Aes128Gcm: 1;
    Aes256Gcm: 2;
    Chacha20Poly1305: 3;
    ExportOnly: 65535;
} = ...

The supported Authenticated Encryption with Associated Data (AEAD) identifiers.

Deprecated

Use AeadId instead.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/AeadId-1.html b/docs/variables/AeadId-1.html index 31e7e3aa2..ec4664ca5 100644 --- a/docs/variables/AeadId-1.html +++ b/docs/variables/AeadId-1.html @@ -1,2 +1,2 @@ AeadId | @hpke/hpke-js

Variable AeadIdConst

AeadId: {
    Aes128Gcm: 1;
    Aes256Gcm: 2;
    Chacha20Poly1305: 3;
    ExportOnly: 65535;
} = ...

The supported Authenticated Encryption with Associated Data (AEAD) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/Kdf-1.html b/docs/variables/Kdf-1.html index 689a75af3..24f59d481 100644 --- a/docs/variables/Kdf-1.html +++ b/docs/variables/Kdf-1.html @@ -1,3 +1,3 @@ Kdf | @hpke/hpke-js

Variable KdfConst

Kdf: {
    HkdfSha256: 1;
    HkdfSha384: 2;
    HkdfSha512: 3;
} = ...

The supported Key Derivation Function (KDF) identifiers.

Deprecated

Use KdfId instead.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/KdfId-1.html b/docs/variables/KdfId-1.html index 16e223a28..93bf1ce03 100644 --- a/docs/variables/KdfId-1.html +++ b/docs/variables/KdfId-1.html @@ -1,2 +1,2 @@ KdfId | @hpke/hpke-js

Variable KdfIdConst

KdfId: {
    HkdfSha256: 1;
    HkdfSha384: 2;
    HkdfSha512: 3;
} = ...

The supported Key Derivation Function (KDF) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/Kem-1.html b/docs/variables/Kem-1.html index dc3c84ff1..ac39eb8e2 100644 --- a/docs/variables/Kem-1.html +++ b/docs/variables/Kem-1.html @@ -1,3 +1,3 @@ Kem | @hpke/hpke-js

Variable KemConst

Kem: {
    DhkemP256HkdfSha256: 16;
    DhkemP384HkdfSha384: 17;
    DhkemP521HkdfSha512: 18;
    DhkemSecp256k1HkdfSha256: 19;
    DhkemX25519HkdfSha256: 32;
    DhkemX448HkdfSha512: 33;
    HybridkemX25519Kyber768: 48;
    NotAssigned: 0;
} = ...

The supported Key Encapsulation Mechanism (KEM) identifiers.

Deprecated

Use KdfId instead.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/variables/KemId-1.html b/docs/variables/KemId-1.html index 5642522b3..6e5af0b60 100644 --- a/docs/variables/KemId-1.html +++ b/docs/variables/KemId-1.html @@ -1,2 +1,2 @@ KemId | @hpke/hpke-js

Variable KemIdConst

KemId: {
    DhkemP256HkdfSha256: 16;
    DhkemP384HkdfSha384: 17;
    DhkemP521HkdfSha512: 18;
    DhkemSecp256k1HkdfSha256: 19;
    DhkemX25519HkdfSha256: 32;
    DhkemX448HkdfSha512: 33;
    HybridkemX25519Kyber768: 48;
    MlKem1024: 66;
    MlKem512: 64;
    MlKem768: 65;
    NotAssigned: 0;
    XWing: 25722;
} = ...

The supported Key Encapsulation Mechanism (KEM) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/hybridkem-x-wing/docs/classes/XWing.html b/hybridkem-x-wing/docs/classes/XWing.html index 3e2bda4c1..7dcf09cfa 100644 --- a/hybridkem-x-wing/docs/classes/XWing.html +++ b/hybridkem-x-wing/docs/classes/XWing.html @@ -6,7 +6,7 @@

Example: Use with `@hpke/core`:

import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { XWing } from "@hpke/hybridkem-x-wing";
const suite = new CipherSuite({
  kem: new XWing(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Implements

Constructors

constructor +

Implements

Constructors

constructor

Properties

_m _x25519 auth @@ -26,55 +26,55 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_m

_m: MlKem768

Protected_x25519

_x25519: X25519

Readonlyauth

auth: boolean = false

ReadonlyencSize

encSize: number = 1120

The length in bytes of an encapsulated key produced by this KEM (Nenc).

-

Readonlyid

id: KemId = KemId.XWing

The KEM identifier.

-

Readonlyname

name: string = ALG_NAME

ReadonlyprivateKeySize

privateKeySize: number = 32

The length in bytes of an encoded private key for this KEM (Nsk).

-

ReadonlypublicKeySize

publicKeySize: number = 1216

The length in bytes of an encoded public key for this KEM (Npk).

-

ReadonlysecretSize

secretSize: number = 32

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

-

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Decapsulates the ss (shared secret) from the enc and the recipient's private key. +

Constructors

constructor

Properties

Protected_m

_m: MlKem768

Protected_x25519

_x25519: X25519

Readonlyauth

auth: boolean = false

ReadonlyencSize

encSize: number = 1120

The length in bytes of an encapsulated key produced by this KEM (Nenc).

+

Readonlyid

id: KemId = KemId.XWing

The KEM identifier.

+

Readonlyname

name: string = ALG_NAME

ReadonlyprivateKeySize

privateKeySize: number = 32

The length in bytes of an encoded private key for this KEM (Nsk).

+

ReadonlypublicKeySize

publicKeySize: number = 1216

The length in bytes of an encoded public key for this KEM (Npk).

+

ReadonlysecretSize

secretSize: number = 32

The length in bytes of a KEM shared secret produced by this KEM (Nsecret).

+

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Decapsulates the ss (shared secret) from the enc and the recipient's private key. The enc is the same as the ct (ciphertext) resulting from X-Wing::Encapsulate(), which is executed under the encap(). @param params The parameters for decapsulation. @returns {Promise<ArrayBuffer>} A promise that resolves with the shared secret. @throws {InvalidParamError} Thrown if the length of the enc` is not 1120 bytes.

    Parameters

    • params: RecipientContextParams

    Returns Promise<ArrayBuffer>

    Throws

    Thrown if the shared secret cannot be decapsulated.

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the input keying material.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the input keying material.

    Parameters

    • ikm: ArrayBuffer

      The input keying material.

    Returns Promise<CryptoKeyPair>

    A promise that resolves with a new key pair.

    Throws

    Thrown if the key pair cannot be derived.

    Throws

    Thrown if the length of the IKM is not 32 bytes.

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Encapsulates the shared secret and the ct (ciphertext) as enc.

    +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Encapsulates the shared secret and the ct (ciphertext) as enc.

    Parameters

    • params: SenderContextParams

      The parameters for encapsulation.

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A promise that resolves with the ss (shared secret) as sharedSecret and the ct (ciphertext) as enc.

    Throws

    Thrown if the length of the ekm is not 64 bytes.

    Throws

    Thrown if the shared secret cannot be encapsulated.

    -

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a new key pair.

    +

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a new key pair.

    Returns Promise<CryptoKeyPair>

    A promise that resolves with a new key pair.

    -

generateKeyPairDerand

  • generateKeyPairDerand(sk): Promise<CryptoKeyPair>

  • Generates a key pair from the secret key.

    +

generateKeyPairDerand

  • generateKeyPairDerand(sk): Promise<CryptoKeyPair>

  • Generates a key pair from the secret key.

    Parameters

    • sk: Uint8Array

      The secret key.

    Returns Promise<CryptoKeyPair>

    A promise that resolves with a new key pair.

    Throws

    Thrown if the length of the secret key is not 32 bytes.

    Throws

    Thrown if the key pair cannot be derived.

    -

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a key from the input.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a key from the input.

    Parameters

    • format: "raw" | "jwk"

      The format of the key. "raw" or "jwk" can be specified.

    • key: ArrayBuffer | JsonWebKeyExtended

      The key to import. If the format is "raw", the key must be an ArrayBuffer. If the format is "jwk", the key must be a JsonWebKey.

    • isPublic: boolean = true

      A boolean indicating whether the key is public or not. The default is true.

    Returns Promise<CryptoKey>

    A promise that resolves with the imported key.

    Throws

    Thrown if the key cannot be imported.

    -

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/hybridkem-x25519-kyber768/docs/classes/HybridkemX25519Kyber768.html b/hybridkem-x25519-kyber768/docs/classes/HybridkemX25519Kyber768.html index 5c1ab6a98..116882626 100644 --- a/hybridkem-x25519-kyber768/docs/classes/HybridkemX25519Kyber768.html +++ b/hybridkem-x25519-kyber768/docs/classes/HybridkemX25519Kyber768.html @@ -6,7 +6,7 @@

Example: Use with `@hpke/core`:

import { Aes128Gcm, CipherSuite, HkdfSha256 } from "@hpke/core";
import { HybridkemX25519Kyber768 } from "@hpke/hybridkem-x25519-kyber768";
const suite = new CipherSuite({
  kem: new HybridkemX25519Kyber768(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

Constructors

constructor

Properties

_a _b _kdf @@ -26,38 +26,38 @@ importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_a

_a: DhkemInterface

Protected_b

_b: KemInterface

Protected_kdf

_kdf: KdfInterface

Readonlyauth

auth: boolean = false

encSize

encSize: number = 1120

id

id: KemId = KemId.HybridkemX25519Kyber768

name

name: string = "X25519Kyber25519"

privateKeySize

privateKeySize: number = 2432

publicKeySize

publicKeySize: number = 1216

secretSize

secretSize: number = 64

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    +

Constructors

constructor

Properties

Protected_a

_a: DhkemInterface

Protected_b

_b: KemInterface

Protected_kdf

_kdf: KdfInterface

Readonlyauth

auth: boolean = false

encSize

encSize: number = 1120

id

id: KemId = KemId.HybridkemX25519Kyber768

name

name: string = "X25519Kyber25519"

privateKeySize

privateKeySize: number = 2432

publicKeySize

publicKeySize: number = 1216

secretSize

secretSize: number = 64

Methods

decap

  • decap(params): Promise<ArrayBuffer>

  • Recovers the ephemeral symmetric key from its encapsulated representation enc.

    If the error occurred, throws DecapError.

    Parameters

    • params: RecipientContextParams

      A set of parameters for the recipient context.

    Returns Promise<ArrayBuffer>

    A shared secret as the output of the decapsulation step.

    Throws

    DecapError

    -

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    +

deriveKeyPair

  • deriveKeyPair(ikm): Promise<CryptoKeyPair>

  • Derives a key pair from the byte string ikm.

    If the error occurred, throws DeriveKeyPairError.

    Parameters

    • ikm: ArrayBuffer

      An input keying material.

    Returns Promise<CryptoKeyPair>

    A key pair derived.

    Throws

    DeriveKeyPairError

    -

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    +

deserializePrivateKey

  • deserializePrivateKey(key): Promise<CryptoKey>

  • Deserializes a private key as a byte string of length Nsk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    +

deserializePublicKey

  • deserializePublicKey(key): Promise<CryptoKey>

  • Deserializes a public key as a byte string of length Npk to CryptoKey.

    If the error occurred, throws DeserializeError.

    Parameters

    • key: ArrayBuffer

      A key as bytes.

    Returns Promise<CryptoKey>

    A CryptoKey.

    Throws

    DeserializeError

    -

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and +

encap

  • encap(params): Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

  • Generates an ephemeral, fixed-length symmetric key and a fixed-length encapsulation of the key that can be decapsulated by the holder of the private key corresponding to pkR.

    If the error occurred, throws EncapError.

    Parameters

    • params: SenderContextParams

      A set of parameters for the sender context.

    Returns Promise<{
        enc: ArrayBuffer;
        sharedSecret: ArrayBuffer;
    }>

    A shared secret and an encapsulated key as the output of the encapsulation step.

    Throws

    EncapError

    -

generateKeyPair

generateKeyPair

  • generateKeyPair(): Promise<CryptoKeyPair>

  • Generates a key pair.

    If the error occurred, throws NotSupportedError.

    Returns Promise<CryptoKeyPair>

    A key pair generated.

    Throws

    NotSupportedError

    -

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    +

importKey

  • importKey(format, key, isPublic?): Promise<CryptoKey>

  • Imports a public or private key and converts to a CryptoKey.

    Since key parameters for createSenderContext or createRecipientContext are CryptoKey format, you have to use this function to convert provided keys to CryptoKey.

    @@ -69,14 +69,14 @@
  • isPublic: boolean = true

    The indicator whether the provided key is a public key or not, which is used only for 'raw' format.

Returns Promise<CryptoKey>

A public or private CryptoKey.

Throws

DeserializeError

-

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    +

serializePrivateKey

  • serializePrivateKey(key): Promise<ArrayBuffer>

  • Serializes a private key as CryptoKey to a byte string of length Nsk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    +

serializePublicKey

  • serializePublicKey(key): Promise<ArrayBuffer>

  • Serializes a public key as CryptoKey to a byte string of length Npk.

    If the error occurred, throws SerializeError.

    Parameters

    • key: CryptoKey

      A CryptoKey.

    Returns Promise<ArrayBuffer>

    A key as bytes.

    Throws

    SerializeError

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods