Class PrivateKeyBase

PrivateKeyBase - Root cryptographic material for deterministic key derivation.

This is the foundation from which signing keys and agreement keys can be deterministically derived using HKDF.

Implements

CborTaggedEncodable
CborTaggedDecodable<PrivateKeyBase>
UREncodable

Methods

`Static`new

new(): PrivateKeyBase
Create a new random PrivateKeyBase.

Returns PrivateKeyBase
- Defined in components/src/private-key-base.ts:79

`Static`newUsing

newUsing(rng: RandomNumberGenerator): PrivateKeyBase
Create a new random PrivateKeyBase using the provided RNG.
Parameters
- rng: RandomNumberGenerator
Returns PrivateKeyBase
- Defined in components/src/private-key-base.ts:87

`Static`fromData

fromData(data: Uint8Array): PrivateKeyBase
Create a PrivateKeyBase from raw bytes.
Parameters
- data: Uint8Array
  32 bytes of key material
Returns PrivateKeyBase
- Defined in components/src/private-key-base.ts:97

asBytes

asBytes(): Uint8Array
Returns the raw key material.

Returns Uint8Array
- Defined in components/src/private-key-base.ts:108

data

data(): Uint8Array
Returns a copy of the raw key material.

Returns Uint8Array
- Defined in components/src/private-key-base.ts:115

ed25519SigningPrivateKey

ed25519SigningPrivateKey(): SigningPrivateKey
Derive an Ed25519 signing private key.

Uses HKDF with info string "signing-ed25519".

Returns SigningPrivateKey
- Defined in components/src/private-key-base.ts:128

x25519PrivateKey

x25519PrivateKey(): X25519PrivateKey
Derive an X25519 agreement private key.

Uses HKDF with info string "agreement-x25519".

Returns X25519PrivateKey
- Defined in components/src/private-key-base.ts:139

encapsulationPrivateKey

encapsulationPrivateKey(): EncapsulationPrivateKey
Get EncapsulationPrivateKey for decryption.

Returns the derived X25519 private key wrapped as EncapsulationPrivateKey.

Returns EncapsulationPrivateKey
- Defined in components/src/private-key-base.ts:149

ed25519PrivateKeys

ed25519PrivateKeys(): PrivateKeys
Derive a PrivateKeys container with Ed25519 signing and X25519 agreement keys.

Returns PrivateKeys
PrivateKeys containing the derived signing and encapsulation keys
- Defined in components/src/private-key-base.ts:158

ed25519PublicKeys

ed25519PublicKeys(): PublicKeys
Derive a PublicKeys container from the derived keys.

Returns PublicKeys
PublicKeys containing the derived public keys
- Defined in components/src/private-key-base.ts:167

equals

equals(other: PrivateKeyBase): boolean
Compare with another PrivateKeyBase.
Parameters
- other: PrivateKeyBase
Returns boolean
- Defined in components/src/private-key-base.ts:189

toString

toString(): string
Get string representation (truncated for security).

Returns string
- Defined in components/src/private-key-base.ts:200

cborTags

cborTags(): Tag[]
Returns the CBOR tags associated with PrivateKeyBase.

Returns Tag[]
Implementation of CborTaggedEncodable.cborTags
- Defined in components/src/private-key-base.ts:212

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.untaggedCbor
- Defined in components/src/private-key-base.ts:219

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.taggedCbor
- Defined in components/src/private-key-base.ts:226

taggedCborData

taggedCborData(): Uint8Array
Returns the tagged value in CBOR binary representation.

Returns Uint8Array
Implementation of CborTaggedEncodable.taggedCborData
- Defined in components/src/private-key-base.ts:233

fromUntaggedCbor

fromUntaggedCbor(cborValue: Cbor): PrivateKeyBase
Creates a PrivateKeyBase by decoding it from untagged CBOR.
Parameters
- cborValue: Cbor
Returns PrivateKeyBase
Implementation of CborTaggedDecodable.fromUntaggedCbor
- Defined in components/src/private-key-base.ts:244

fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): PrivateKeyBase
Creates a PrivateKeyBase by decoding it from tagged CBOR.
Parameters
- cborValue: Cbor
Returns PrivateKeyBase
Implementation of CborTaggedDecodable.fromTaggedCbor
- Defined in components/src/private-key-base.ts:252

`Static`fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): PrivateKeyBase
Static method to decode from tagged CBOR.
Parameters
- cborValue: Cbor
Returns PrivateKeyBase
- Defined in components/src/private-key-base.ts:261

`Static`fromTaggedCborData

fromTaggedCborData(data: Uint8Array): PrivateKeyBase
Static method to decode from tagged CBOR binary data.
Parameters
- data: Uint8Array
Returns PrivateKeyBase
- Defined in components/src/private-key-base.ts:269

`Static`fromUntaggedCborData

fromUntaggedCborData(data: Uint8Array): PrivateKeyBase
Static method to decode from untagged CBOR binary data.
Parameters
- data: Uint8Array
Returns PrivateKeyBase
- Defined in components/src/private-key-base.ts:277

ur

ur(): UR
Returns the UR representation.

Returns UR
Implementation of UREncodable.ur
- Defined in components/src/private-key-base.ts:290

urString

urString(): string
Returns the UR string representation.

Returns string
Implementation of UREncodable.urString
- Defined in components/src/private-key-base.ts:301

`Static`fromUR

fromUR(ur: UR): PrivateKeyBase
Creates a PrivateKeyBase from a UR.
Parameters
- ur: UR
Returns PrivateKeyBase
- Defined in components/src/private-key-base.ts:308

`Static`fromURString

fromURString(urString: string): PrivateKeyBase
Creates a PrivateKeyBase from a UR string.
Parameters
- urString: string
Returns PrivateKeyBase
- Defined in components/src/private-key-base.ts:319