Class X25519PrivateKey

Static ReadonlyKEY_SIZE

Staticnew

• new(): X25519PrivateKey

  Generate a new random X25519PrivateKey.

  Returns X25519PrivateKey

Staticrandom

• random(): X25519PrivateKey

  Generate a new random X25519PrivateKey.

  Returns X25519PrivateKey

StaticnewUsing

• newUsing(rng: RandomNumberGenerator): X25519PrivateKey

  Generate a new random X25519PrivateKey using provided RNG.

  Parameters

  • rng: RandomNumberGenerator

  Returns X25519PrivateKey

Statickeypair

• keypair(): [X25519PrivateKey, X25519PublicKey]

  Generate a new random X25519PrivateKey and corresponding X25519PublicKey.

  Returns [X25519PrivateKey, X25519PublicKey]

StatickeypairUsing

• keypairUsing(rng: RandomNumberGenerator): [X25519PrivateKey, X25519PublicKey]

  Generate a new random X25519PrivateKey and corresponding X25519PublicKey using the given random number generator.

  Parameters

  • rng: RandomNumberGenerator

  Returns [X25519PrivateKey, X25519PublicKey]

StaticderiveFromKeyMaterial

• deriveFromKeyMaterial(keyMaterial: Uint8Array): X25519PrivateKey

  Derive an X25519PrivateKey from the given key material.

  Parameters

  • keyMaterial: Uint8Array

    The key material to derive from

  Returns X25519PrivateKey

  A new X25519PrivateKey derived from the key material

StaticfromData

• fromData(data: Uint8Array): X25519PrivateKey

  Restore an X25519PrivateKey from a fixed-size array of bytes.

  Parameters

  • data: Uint8Array

  Returns X25519PrivateKey

StaticfromDataRef

• fromDataRef(data: Uint8Array): X25519PrivateKey

  Restore an X25519PrivateKey from a reference to an array of bytes. Validates the length.

  Parameters

  • data: Uint8Array

  Returns X25519PrivateKey

Staticfrom

• from(data: Uint8Array): X25519PrivateKey

  Create an X25519PrivateKey from raw bytes (legacy alias).

  Parameters

  • data: Uint8Array

  Returns X25519PrivateKey

StaticfromHex

• fromHex(hex: string): X25519PrivateKey

  Restore an X25519PrivateKey from a hex string.

  Parameters

  • hex: string

  Returns X25519PrivateKey

data

• data(): Uint8Array

  Get a reference to the fixed-size array of bytes.

  Returns Uint8Array

toData

• toData(): Uint8Array

  Get the raw private key bytes (copy).

  Returns Uint8Array

hex

• hex(): string

  Get hex string representation.

  Returns string

toHex

• toHex(): string

  Get hex string representation (alias for hex()).

  Returns string

toBase64

• toBase64(): string

  Get base64 representation.

  Returns string

publicKey

• publicKey(): X25519PublicKey

  Get the X25519PublicKey corresponding to this X25519PrivateKey.

  Returns X25519PublicKey

sharedKeyWith

• sharedKeyWith(publicKey: X25519PublicKey): SymmetricKey

  Derive a shared symmetric key from this X25519PrivateKey and the given X25519PublicKey.

  Parameters

  • publicKey: X25519PublicKey

    The other party's public key

  Returns SymmetricKey

  A SymmetricKey derived from the shared secret

sharedSecret

• sharedSecret(publicKey: X25519PublicKey): Uint8Array

  Perform ECDH key agreement with a public key (legacy method).

  Parameters

  • publicKey: X25519PublicKey

  Returns Uint8Array

  Deprecated

  Use sharedKeyWith() instead which returns a SymmetricKey

equals

• equals(other: X25519PrivateKey): boolean

  Compare with another X25519PrivateKey.

  Parameters

  • other: X25519PrivateKey

  Returns boolean

toString

• toString(): string

  Get string representation.

  Returns string

cborTags

• cborTags(): Tag[]

  Returns the CBOR tags associated with X25519PrivateKey.

  Returns Tag[]

untaggedCbor

• untaggedCbor(): Cbor

  Returns the untagged CBOR encoding (as a byte string).

  Returns Cbor

taggedCbor

• taggedCbor(): Cbor

  Returns the tagged CBOR encoding.

  Returns Cbor

taggedCborData

• taggedCborData(): Uint8Array

  Returns the tagged value in CBOR binary representation.

  Returns Uint8Array

fromUntaggedCbor

• fromUntaggedCbor(cbor: Cbor): X25519PrivateKey

  Creates an X25519PrivateKey by decoding it from untagged CBOR.

  Parameters

  • cbor: Cbor

  Returns X25519PrivateKey

fromTaggedCbor

• fromTaggedCbor(cbor: Cbor): X25519PrivateKey

  Creates an X25519PrivateKey by decoding it from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns X25519PrivateKey

StaticfromTaggedCbor

• fromTaggedCbor(cbor: Cbor): X25519PrivateKey

  Static method to decode from tagged CBOR.

  Parameters

  • cbor: Cbor

  Returns X25519PrivateKey

StaticfromTaggedCborData

• fromTaggedCborData(data: Uint8Array): X25519PrivateKey

  Static method to decode from tagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns X25519PrivateKey

StaticfromUntaggedCborData

• fromUntaggedCborData(data: Uint8Array): X25519PrivateKey

  Static method to decode from untagged CBOR binary data.

  Parameters

  • data: Uint8Array

  Returns X25519PrivateKey

ur

• ur(): UR

  Returns the UR representation of the X25519PrivateKey. Note: URs use untagged CBOR since the type is conveyed by the UR type itself.

  Returns UR

urString

• urString(): string

  Returns the UR string representation.

  Returns string

StaticfromUR

• fromUR(ur: UR): X25519PrivateKey

  Creates an X25519PrivateKey from a UR.

  Parameters

  • ur: UR

  Returns X25519PrivateKey

StaticfromURString

• fromURString(urString: string): X25519PrivateKey

  Creates an X25519PrivateKey from a UR string.

  Parameters

  • urString: string

  Returns X25519PrivateKey