Module: types

class x3dh.types.Bundle(identity_key, signed_pre_key, signed_pre_key_sig, pre_keys)

Bases: NamedTuple

The bundle is a collection of public keys and signatures used by the X3DH protocol to achieve asynchronous key agreements while providing forward secrecy and cryptographic deniability. Parties that want to be available for X3DH key agreements have to publish their bundle somehow. Other parties can then use that bundle to perform a key agreement.

Parameters:

• identity_key (bytes)

• signed_pre_key (bytes)

• signed_pre_key_sig (bytes)

• pre_keys (FrozenSet[bytes])

identity_key: bytes

Alias for field number 0

signed_pre_key: bytes

Alias for field number 1

signed_pre_key_sig: bytes

Alias for field number 2

pre_keys: FrozenSet[bytes]

Alias for field number 3

class x3dh.types.IdentityKeyFormat(*values)

Bases: Enum

The two supported public key formats for the identity key:

• Curve25519 public keys: 32 bytes, the little-endian encoding of the u coordinate as per RFC 7748, section 5 “The X25519 and X448 Functions”.

• Ed25519 public keys: 32 bytes, the little-endian encoding of the y coordinate with the sign bit of the x coordinate stored in the most significant bit as per RFC 8032, section 3.2 “Keys”.

CURVE_25519 = 'CURVE_25519'

ED_25519 = 'ED_25519'

class x3dh.types.Header(identity_key, ephemeral_key, signed_pre_key, pre_key)

Bases: NamedTuple

The header generated by the active party as part of the key agreement, and consumed by the passive party to derive the same shared secret.

Parameters:

• identity_key (bytes)

• ephemeral_key (bytes)

• signed_pre_key (bytes)

• pre_key (bytes | None)

identity_key: bytes

Alias for field number 0

ephemeral_key: bytes

Alias for field number 1

signed_pre_key: bytes

Alias for field number 2

pre_key: bytes | None

Alias for field number 3

class x3dh.types.SecretType(*values)

Bases: Enum

The two types of secrets that an IdentityKeyPair can use internally: a seed or a private key.

SEED = 'SEED'

PRIV = 'PRIV'

Type Aliases

x3dh.types.JSONType

alias of Mapping[str, JSONType] | List[JSONType] | str | int | float | bool | None

x3dh.types.JSONObject

alias of Mapping[str, JSONType]