diff --git a/chacha20poly1305/docs/classes/Chacha20Poly1305.html b/chacha20poly1305/docs/classes/Chacha20Poly1305.html index eb70cc28c..3709047ce 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

  • AeadInterface

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/core/docs/classes/Aes128Gcm.html b/core/docs/classes/Aes128Gcm.html index 86836802f..c6aec6b33 100644 --- a/core/docs/classes/Aes128Gcm.html +++ b/core/docs/classes/Aes128Gcm.html @@ -4,17 +4,17 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "http://deno.land/x/hpke/core/mod.ts";

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 578dc1d88..7566e8014 100644 --- a/core/docs/classes/Aes256Gcm.html +++ b/core/docs/classes/Aes256Gcm.html @@ -5,17 +5,17 @@

Example

import {
  Aes256Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "http://deno.land/x/hpke/core/mod.ts";

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

Readonlyid

id: AeadId = AeadId.Aes256Gcm

AeadId.Aes256Gcm (0x0002)

-

ReadonlykeySize

keySize: number = 32

32

-

ReadonlynonceSize

nonceSize: number = 12

12

-

ReadonlytagSize

tagSize: number = 16

16

-

Methods

createEncryptionContext

ReadonlykeySize

keySize: number = 32

32

+

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/BaseError.html b/core/docs/classes/BaseError.html index 97f6caf1f..77e63960a 100644 --- a/core/docs/classes/BaseError.html +++ b/core/docs/classes/BaseError.html @@ -1,7 +1,7 @@ BaseError | @hpke/core

Class BaseError

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/CipherSuite.html b/core/docs/classes/CipherSuite.html index 98de86615..5d7d850ec 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 "http://deno.land/x/hpke/core/mod.ts";
import { DhkemX25519HkdfSha256 } from "https://deno.land/x/hpke/x/dhkem-x25519/mod.ts";
const suite = new CipherSuite({
  kem: new DhkemX25519HkdfSha256(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

  • CipherSuiteNative
    • CipherSuite

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

  • _setup(): Promise<void>

  • Returns Promise<void>

createRecipientContext

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_kem

_kem: KemInterface

Accessors

aead

kdf

kem

Methods

Protected_setup

  • _setup(): Promise<void>

  • Returns Promise<void>

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 fd0ad8236..bb3a8d798 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 67ac2d957..14591e11a 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 327aa5c5c..2996f15c1 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 fbe522b6f..c04edcda2 100644 --- a/core/docs/classes/DhkemP256HkdfSha256.html +++ b/core/docs/classes/DhkemP256HkdfSha256.html @@ -5,7 +5,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "http://deno.land/x/hpke/core/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • DhkemP256HkdfSha256Native
    • DhkemP256HkdfSha256

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

ReadonlyencSize

encSize: number = 65

Readonlyid

id: KemId = KemId.DhkemP256HkdfSha256

ReadonlyprivateKeySize

privateKeySize: number = 32

ReadonlypublicKeySize

publicKeySize: number = 65

ReadonlysecretSize

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

ReadonlyencSize

encSize: number = 65

Readonlyid

id: KemId = KemId.DhkemP256HkdfSha256

ReadonlyprivateKeySize

privateKeySize: number = 32

ReadonlypublicKeySize

publicKeySize: number = 65

ReadonlysecretSize

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 a6945a10f..368fe61ca 100644 --- a/core/docs/classes/DhkemP384HkdfSha384.html +++ b/core/docs/classes/DhkemP384HkdfSha384.html @@ -5,7 +5,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP384HkdfSha384,
  HkdfSha384,
} from "http://deno.land/x/hpke/core/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • DhkemP384HkdfSha384Native
    • DhkemP384HkdfSha384

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

ReadonlyencSize

encSize: number = 97

Readonlyid

id: KemId = KemId.DhkemP384HkdfSha384

ReadonlyprivateKeySize

privateKeySize: number = 48

ReadonlypublicKeySize

publicKeySize: number = 97

ReadonlysecretSize

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

ReadonlyencSize

encSize: number = 97

Readonlyid

id: KemId = KemId.DhkemP384HkdfSha384

ReadonlyprivateKeySize

privateKeySize: number = 48

ReadonlypublicKeySize

publicKeySize: number = 97

ReadonlysecretSize

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 8652d8a0f..028086dd7 100644 --- a/core/docs/classes/DhkemP521HkdfSha512.html +++ b/core/docs/classes/DhkemP521HkdfSha512.html @@ -5,7 +5,7 @@

Example

import {
  Aes256Gcm,
  CipherSuite,
  DhkemP521HkdfSha512,
  HkdfSha512,
} from "http://deno.land/x/hpke/core/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • DhkemP521HkdfSha512Native
    • DhkemP521HkdfSha512

Constructors

constructor

Properties

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

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

ReadonlyencSize

encSize: number = 133

Readonlyid

id: KemId = KemId.DhkemP521HkdfSha512

ReadonlyprivateKeySize

privateKeySize: number = 64

ReadonlypublicKeySize

publicKeySize: number = 133

ReadonlysecretSize

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

ReadonlyencSize

encSize: number = 133

Readonlyid

id: KemId = KemId.DhkemP521HkdfSha512

ReadonlyprivateKeySize

privateKeySize: number = 64

ReadonlypublicKeySize

publicKeySize: number = 133

ReadonlysecretSize

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/EncapError.html b/core/docs/classes/EncapError.html index 7d9602a96..2d7ea7717 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 a38be230b..c66994c8c 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 8addc5a8a..c170469c7 100644 --- a/core/docs/classes/ExportOnly.html +++ b/core/docs/classes/ExportOnly.html @@ -5,16 +5,16 @@

Example

import {
  CipherSuite,
  DhkemP256HkdfSha256,
  ExportOnly,
  HkdfSha256,
} from "http://deno.land/x/hpke/core/mod.ts";

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 41c30b279..59782acc8 100644 --- a/core/docs/classes/HkdfSha256.html +++ b/core/docs/classes/HkdfSha256.html @@ -7,7 +7,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP256HkdfSha256,
  HkdfSha256,
} from "http://deno.land/x/hpke/core/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • HkdfSha256Native
    • HkdfSha256

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

Protected ReadonlyalgHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

ReadonlyhashSize

hashSize: number = 32

32

-

Readonlyid

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

Protected ReadonlyalgHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

ReadonlyhashSize

hashSize: number = 32

32

+

Readonlyid

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

  • 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 13c1ec308..a13e42429 100644 --- a/core/docs/classes/HkdfSha384.html +++ b/core/docs/classes/HkdfSha384.html @@ -7,7 +7,7 @@

Example

import {
  Aes128Gcm,
  CipherSuite,
  DhkemP384HkdfSha384,
  HkdfSha384,
} from "http://deno.land/x/hpke/core/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • HkdfSha384Native
    • HkdfSha384

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

Protected ReadonlyalgHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

ReadonlyhashSize

hashSize: number = 48

48

-

Readonlyid

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

Protected ReadonlyalgHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

ReadonlyhashSize

hashSize: number = 48

48

+

Readonlyid

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

  • 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 28165fbf7..aec33819e 100644 --- a/core/docs/classes/HkdfSha512.html +++ b/core/docs/classes/HkdfSha512.html @@ -7,7 +7,7 @@

Example

import {
  Aes256Gcm,
  CipherSuite,
  DhkemP521HkdfSha512,
  HkdfSha512,
} from "http://deno.land/x/hpke/core/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • HkdfSha512Native
    • HkdfSha512

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

Protected ReadonlyalgHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

-

ReadonlyhashSize

hashSize: number = 64

64

-

Readonlyid

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

Protected ReadonlyalgHash

algHash: HmacKeyGenParams = ...

The parameters for Web Cryptography API

+

ReadonlyhashSize

hashSize: number = 64

64

+

Readonlyid

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

  • 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 fd3a027f7..56400e94d 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 28f0bdc55..f8d3cc474 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 dad71d024..7adfd7229 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 670c30140..872fefe33 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 3e606efdc..1abed9eae 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 176ab4c15..8b301d56a 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 6e94b1a83..5ccb358ae 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 bef9719c5..cf0f2c15d 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 3b3f91519..ef416be89 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 9bda736c4..561bbced9 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 c47875b9b..2fe0d9eb6 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 c965d0585..4a3e3b57b 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 4f92ef4d5..d28181ce6 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

  • 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

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

  • Encrypts data.

    If the error occurred, throws SealError | MessageLimitReachedError.

    Parameters

    • data: ArrayBuffer

      A plain text as bytes to be encrypted.

    • Optionalaad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A cipher text as bytes.

    Throws

    MessageLimitReachedError, SealError

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/core/docs/interfaces/KdfInterface.html b/core/docs/interfaces/KdfInterface.html index 29afa0aaa..58a469d8e 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(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/core/docs/interfaces/KemInterface.html b/core/docs/interfaces/KemInterface.html index ba54426db..e1057b1bc 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

deserializePrivateKey

deserializePrivateKey

deserializePublicKey

deserializePublicKey

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

  • 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.

    @@ -61,14 +61,14 @@
  • OptionalisPublic: boolean

    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

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 995b1fa0d..a4e1e559e 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 e42575de9..2a209d8f8 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 4a02e0b4a..e5b34f963 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

  • 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

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 602682408..060a97a3c 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 c401243a7..cf0fb5d92 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 6d40c1f72..6c9821cb8 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 ddc51de03..7effcc92b 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 c7854032d..6327b941d 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 8ebfd4895..cdb58f129 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;
} = Aead

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 6b4fdea00..2aeadaae5 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;
} = Kdf

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 f68c56a20..9e66d1b84 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;
    NotAssigned: 0;
} = Kem

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 ce41c1bd3..ad29356f3 100644 --- a/dhkem-secp256k1/docs/classes/DhkemSecp256k1HkdfSha256.html +++ b/dhkem-secp256k1/docs/classes/DhkemSecp256k1HkdfSha256.html @@ -13,7 +13,7 @@

Copy

Note that it is experimental and not standardized.

-

Hierarchy

  • Dhkem
    • DhkemSecp256k1HkdfSha256

Constructors

constructor +

Hierarchy

  • Dhkem
    • DhkemSecp256k1HkdfSha256

Constructors

constructor

Properties

_kdf _prim encSize @@ -30,43 +30,43 @@

importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected Experimental_kdf

_kdf: KdfInterface

Protected Experimental_prim

_prim: DhkemPrimitives

Readonly ExperimentalencSize

encSize: number = 33

33

-

Readonly Experimentalid

id: KemId = KemId.DhkemSecp256k1HkdfSha256

KemId.DhkemSecp256k1HkdfSha256 (0x0013) EXPERIMENTAL

-

Readonly ExperimentalprivateKeySize

privateKeySize: number = 32

32

-

Readonly ExperimentalpublicKeySize

publicKeySize: number = 33

33

-

Readonly 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

Readonly ExperimentalencSize

encSize: number = 33

33

+

Readonly Experimentalid

id: KemId = KemId.DhkemSecp256k1HkdfSha256

KemId.DhkemSecp256k1HkdfSha256 (0x0013) EXPERIMENTAL

+

Readonly ExperimentalprivateKeySize

privateKeySize: number = 32

32

+

Readonly ExperimentalpublicKeySize

publicKeySize: number = 33

33

+

Readonly 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

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 77c4f5c2c..ec835e095 100644 --- a/dhkem-x25519/docs/classes/DhkemX25519HkdfSha256.html +++ b/dhkem-x25519/docs/classes/DhkemX25519HkdfSha256.html @@ -11,7 +11,7 @@

Example

import { AeadId, CipherSuite, KdfId, KemId } from "https://deno.land/x/hpke/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • Dhkem
    • DhkemX25519HkdfSha256

Constructors

constructor

Properties

_kdf _prim encSize @@ -28,43 +28,43 @@

ExampleimportKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

ReadonlyencSize

encSize: number = 32

32

-

Readonlyid

id: KemId = KemId.DhkemX25519HkdfSha256

KemId.DhkemX25519HkdfSha256 (0x0020)

-

ReadonlyprivateKeySize

privateKeySize: number = 32

32

-

ReadonlypublicKeySize

publicKeySize: number = 32

32

-

ReadonlysecretSize

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

ReadonlyencSize

encSize: number = 32

32

+

Readonlyid

id: KemId = KemId.DhkemX25519HkdfSha256

KemId.DhkemX25519HkdfSha256 (0x0020)

+

ReadonlyprivateKeySize

privateKeySize: number = 32

32

+

ReadonlypublicKeySize

publicKeySize: number = 32

32

+

ReadonlysecretSize

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(): Promise<CryptoKeyPair>

  • Generates a key pair.

    +

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

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/DhkemX448HkdfSha512.html b/dhkem-x448/docs/classes/DhkemX448HkdfSha512.html index db68c1d3f..12888efa1 100644 --- a/dhkem-x448/docs/classes/DhkemX448HkdfSha512.html +++ b/dhkem-x448/docs/classes/DhkemX448HkdfSha512.html @@ -9,7 +9,7 @@

Example: Use with `@hpke/core` (`https://deno.land/x/hpke/core/mod.ts`).

import {
  Aes256Gcm,
  CipherSuite,
  HkdfSha512,
} from "https://deno.land/x/hpke/core/mod.ts";
import { DhkemX448HkdfSha512 } from "https://deno.land/x/hpke/x/dhkem-x448/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • Dhkem
    • DhkemX448HkdfSha512

Constructors

constructor

Properties

_kdf _prim encSize @@ -26,43 +26,43 @@

importKey serializePrivateKey serializePublicKey -

Constructors

constructor

Properties

Protected_kdf

_kdf: KdfInterface

Protected_prim

_prim: DhkemPrimitives

ReadonlyencSize

encSize: number = 56

56

-

Readonlyid

id: KemId = KemId.DhkemX448HkdfSha512

KemId.DhkemX448HkdfSha512 (0x0021)

-

ReadonlyprivateKeySize

privateKeySize: number = 56

56

-

ReadonlypublicKeySize

publicKeySize: number = 56

56

-

ReadonlysecretSize

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

ReadonlyencSize

encSize: number = 56

56

+

Readonlyid

id: KemId = KemId.DhkemX448HkdfSha512

KemId.DhkemX448HkdfSha512 (0x0021)

+

ReadonlyprivateKeySize

privateKeySize: number = 56

56

+

ReadonlypublicKeySize

publicKeySize: number = 56

56

+

ReadonlysecretSize

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(): Promise<CryptoKeyPair>

  • Generates a key pair.

    +

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

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/docs/classes/BaseError.html b/docs/classes/BaseError.html index 8d3b35d93..dccc70dd0 100644 --- a/docs/classes/BaseError.html +++ b/docs/classes/BaseError.html @@ -1,7 +1,7 @@ BaseError | hpke-js

Class BaseError

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/CipherSuite.html b/docs/classes/CipherSuite.html index 1d8a3b776..b9a32f10e 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 "http://deno.land/x/hpke/mod.ts";
// Use an extension module.
import {
  HybridkemX25519Kyber768,
} from "https://deno.land/x/hpke/x/hybridkem-x25519-kyber768/mod.ts";

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

Hierarchy

Constructors

constructor +

Hierarchy

  • CipherSuiteNative
    • CipherSuite

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

  • _setup(): Promise<void>

  • Returns Promise<void>

createRecipientContext

Properties

Protected_api

_api: SubtleCrypto = undefined

Protected_kem

_kem: KemInterface

Accessors

aead

kdf

kem

Methods

Protected_setup

  • _setup(): Promise<void>

  • Returns Promise<void>

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 @@

    Throws

Returns Promise<CryptoKey>

A public or private CryptoKey.

Deprecated

Use KemInterface.generateKeyPair instead.

Throws

DeserializeError

-

open

open

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 cf0636992..e15c6c7c2 100644 --- a/docs/classes/DecapError.html +++ b/docs/classes/DecapError.html @@ -1,7 +1,7 @@ DecapError | 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 9971845ec..c33f448bb 100644 --- a/docs/classes/DeriveKeyPairError.html +++ b/docs/classes/DeriveKeyPairError.html @@ -1,7 +1,7 @@ DeriveKeyPairError | 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 865e12172..92dd606c9 100644 --- a/docs/classes/DeserializeError.html +++ b/docs/classes/DeserializeError.html @@ -1,7 +1,7 @@ DeserializeError | 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 1ad1051e6..4beb72e93 100644 --- a/docs/classes/EncapError.html +++ b/docs/classes/EncapError.html @@ -1,7 +1,7 @@ EncapError | 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 007b3522b..03c4dafbc 100644 --- a/docs/classes/ExportError.html +++ b/docs/classes/ExportError.html @@ -1,7 +1,7 @@ ExportError | 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 222578b87..b6b94ed2c 100644 --- a/docs/classes/HpkeError.html +++ b/docs/classes/HpkeError.html @@ -1,7 +1,7 @@ HpkeError | 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 aaffbca03..d06ff2dee 100644 --- a/docs/classes/InvalidParamError.html +++ b/docs/classes/InvalidParamError.html @@ -1,7 +1,7 @@ InvalidParamError | 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 2a3acaadc..1e43298ed 100644 --- a/docs/classes/MessageLimitReachedError.html +++ b/docs/classes/MessageLimitReachedError.html @@ -1,7 +1,7 @@ MessageLimitReachedError | 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 f013895b9..1c3e34c59 100644 --- a/docs/classes/NotSupportedError.html +++ b/docs/classes/NotSupportedError.html @@ -1,7 +1,7 @@ NotSupportedError | 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 931a48157..6606cb7bf 100644 --- a/docs/classes/OpenError.html +++ b/docs/classes/OpenError.html @@ -1,7 +1,7 @@ OpenError | 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 d0a813cf5..54083e719 100644 --- a/docs/classes/SealError.html +++ b/docs/classes/SealError.html @@ -1,7 +1,7 @@ SealError | 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 bdf6e1b60..21ebb78d9 100644 --- a/docs/classes/SerializeError.html +++ b/docs/classes/SerializeError.html @@ -1,7 +1,7 @@ SerializeError | 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 6bc7b7dd8..8bb11557f 100644 --- a/docs/classes/ValidationError.html +++ b/docs/classes/ValidationError.html @@ -1,7 +1,7 @@ ValidationError | 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 45628bc43..3928fdd57 100644 --- a/docs/interfaces/AeadEncryptionContext.html +++ b/docs/interfaces/AeadEncryptionContext.html @@ -1,14 +1,14 @@ AeadEncryptionContext | 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 7efd9be35..eeefa34f9 100644 --- a/docs/interfaces/AeadInterface.html +++ b/docs/interfaces/AeadInterface.html @@ -1,14 +1,14 @@ AeadInterface | 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 abe6f147f..44fc6e002 100644 --- a/docs/interfaces/CipherSuiteParams.html +++ b/docs/interfaces/CipherSuiteParams.html @@ -1,8 +1,8 @@ CipherSuiteParams | 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 005c62372..624d1ddb2 100644 --- a/docs/interfaces/CipherSuiteSealResponse.html +++ b/docs/interfaces/CipherSuiteSealResponse.html @@ -1,6 +1,6 @@ CipherSuiteSealResponse | 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 298db1edd..2c66db7ad 100644 --- a/docs/interfaces/EncryptionContext.html +++ b/docs/interfaces/EncryptionContext.html @@ -1,5 +1,5 @@ EncryptionContext | 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

  • 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

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

  • Encrypts data.

    If the error occurred, throws SealError | MessageLimitReachedError.

    Parameters

    • data: ArrayBuffer

      A plain text as bytes to be encrypted.

    • Optionalaad: ArrayBuffer

      Additional authenticated data as bytes fed by an application.

    Returns Promise<ArrayBuffer>

    A cipher text as bytes.

    Throws

    MessageLimitReachedError, SealError

    -

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 1806b7128..2c2538502 100644 --- a/docs/interfaces/KdfInterface.html +++ b/docs/interfaces/KdfInterface.html @@ -1,5 +1,5 @@ KdfInterface | 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(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/docs/interfaces/KemInterface.html b/docs/interfaces/KemInterface.html index 1037e71dd..abbdf30c1 100644 --- a/docs/interfaces/KemInterface.html +++ b/docs/interfaces/KemInterface.html @@ -1,5 +1,5 @@ KemInterface | 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

  • 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

deserializePrivateKey

deserializePrivateKey

deserializePublicKey

deserializePublicKey

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

  • 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.

    @@ -61,14 +61,14 @@
  • OptionalisPublic: boolean

    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

  • 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

  • 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

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/interfaces/PreSharedKey.html b/docs/interfaces/PreSharedKey.html index 863567fae..d79e68654 100644 --- a/docs/interfaces/PreSharedKey.html +++ b/docs/interfaces/PreSharedKey.html @@ -1,6 +1,6 @@ PreSharedKey | 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 985fbe64c..e6ac01c3f 100644 --- a/docs/interfaces/RecipientContextParams.html +++ b/docs/interfaces/RecipientContextParams.html @@ -1,13 +1,13 @@ RecipientContextParams | 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 3604163a2..5fcf7b197 100644 --- a/docs/interfaces/SenderContext.html +++ b/docs/interfaces/SenderContext.html @@ -1,25 +1,25 @@ SenderContext | 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

  • 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

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 23937fc40..d4ab6d71c 100644 --- a/docs/interfaces/SenderContextParams.html +++ b/docs/interfaces/SenderContextParams.html @@ -1,13 +1,13 @@ SenderContextParams | 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 5d4b6abe3..fe57f1a94 100644 --- a/docs/types/Aead.html +++ b/docs/types/Aead.html @@ -1,3 +1,3 @@ Aead | 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 4c3a7a5a2..cb3b1511c 100644 --- a/docs/types/AeadId.html +++ b/docs/types/AeadId.html @@ -1,2 +1,2 @@ AeadId | 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 b196bc8c5..dfa7a97bd 100644 --- a/docs/types/Kdf.html +++ b/docs/types/Kdf.html @@ -1,3 +1,3 @@ Kdf | 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 ef5a58e85..3ce5822c6 100644 --- a/docs/types/KdfId.html +++ b/docs/types/KdfId.html @@ -1,2 +1,2 @@ KdfId | 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 b8306cb61..721b01525 100644 --- a/docs/types/Kem.html +++ b/docs/types/Kem.html @@ -1,3 +1,3 @@ Kem | 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 cf1ea0f18..99b5f39c8 100644 --- a/docs/types/KemId.html +++ b/docs/types/KemId.html @@ -1,2 +1,2 @@ KemId | 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 5997cfc92..8cf698546 100644 --- a/docs/types/RecipientContext.html +++ b/docs/types/RecipientContext.html @@ -1,2 +1,2 @@ RecipientContext | 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 0cd462b6c..14cc3c001 100644 --- a/docs/variables/Aead-1.html +++ b/docs/variables/Aead-1.html @@ -1,3 +1,3 @@ Aead | 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 26e4a727d..1bacec532 100644 --- a/docs/variables/AeadId-1.html +++ b/docs/variables/AeadId-1.html @@ -1,2 +1,2 @@ AeadId | hpke-js

Variable AeadIdConst

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

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 25dee659a..3a51be866 100644 --- a/docs/variables/Kdf-1.html +++ b/docs/variables/Kdf-1.html @@ -1,3 +1,3 @@ Kdf | 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 c0523076e..f9e7a8e93 100644 --- a/docs/variables/KdfId-1.html +++ b/docs/variables/KdfId-1.html @@ -1,2 +1,2 @@ KdfId | hpke-js

Variable KdfIdConst

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

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 5d992eff0..6fedae277 100644 --- a/docs/variables/Kem-1.html +++ b/docs/variables/Kem-1.html @@ -1,3 +1,3 @@ Kem | 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 c1ec7bf0a..ba4ce6665 100644 --- a/docs/variables/KemId-1.html +++ b/docs/variables/KemId-1.html @@ -1,2 +1,2 @@ KemId | hpke-js

Variable KemIdConst

KemId: {
    DhkemP256HkdfSha256: 16;
    DhkemP384HkdfSha384: 17;
    DhkemP521HkdfSha512: 18;
    DhkemSecp256k1HkdfSha256: 19;
    DhkemX25519HkdfSha256: 32;
    DhkemX448HkdfSha512: 33;
    HybridkemX25519Kyber768: 48;
    NotAssigned: 0;
} = Kem

The supported Key Encapsulation Mechanism (KEM) identifiers.

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/hybridkem-x25519-kyber768/docs/classes/HybridkemX25519Kyber768.html b/hybridkem-x25519-kyber768/docs/classes/HybridkemX25519Kyber768.html index 523a8a876..4af6c08c7 100644 --- a/hybridkem-x25519-kyber768/docs/classes/HybridkemX25519Kyber768.html +++ b/hybridkem-x25519-kyber768/docs/classes/HybridkemX25519Kyber768.html @@ -6,7 +6,7 @@

Example

import { Aes128Gcm, CipherSuite, HkdfSha256 } from "http://deno.land/x/hpke/core/mod.ts";
import { HybridkemX25519Kyber768 } from "https://deno.land/x/hpke/x/hybridkem-x25519-kyber768/mod.ts";
const suite = new CipherSuite({
  kem: new HybridkemX25519Kyber768(),
  kdf: new HkdfSha256(),
  aead: new Aes128Gcm(),
});
-

Hierarchy

Constructors

constructor +

Hierarchy

  • Hybridkem
    • HybridkemX25519Kyber768

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

ReadonlyencSize

encSize: number = 1120

Readonlyid

id: KemId = KemId.HybridkemX25519Kyber768

Readonlyname

name: string = "X25519Kyber25519"

ReadonlyprivateKeySize

privateKeySize: number = 2432

ReadonlypublicKeySize

publicKeySize: number = 1216

ReadonlysecretSize

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

ReadonlyencSize

encSize: number = 1120

Readonlyid

id: KemId = KemId.HybridkemX25519Kyber768

Readonlyname

name: string = "X25519Kyber25519"

ReadonlyprivateKeySize

privateKeySize: number = 2432

ReadonlypublicKeySize

publicKeySize: number = 1216

ReadonlysecretSize

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(): Promise<CryptoKeyPair>

  • Generates a key pair.

    +

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