python-x3dh - A Python implementation of the Extended Triple Diffie-Hellman key agreement protocol.

• Installation
• Getting Started
• Serialization and Migration
  • Migration from pre-stable
• API Documentation
  • Module: base_state
    • KeyAgreementException
    • BaseState
      • BaseState.create()
      • BaseState._encode_public_key()
      • BaseState.model
      • BaseState.json
      • BaseState.from_model()
      • BaseState.from_json()
      • BaseState.old_signed_pre_key
      • BaseState.signed_pre_key_age()
      • BaseState.rotate_signed_pre_key()
      • BaseState.hidden_pre_keys
      • BaseState.hide_pre_key()
      • BaseState.delete_pre_key()
      • BaseState.delete_hidden_pre_keys()
      • BaseState.get_num_visible_pre_keys()
      • BaseState.generate_pre_keys()
      • BaseState.bundle
      • BaseState.get_shared_secret_active()
      • BaseState.get_shared_secret_passive()
  • Module: identity_key_pair
    • IdentityKeyPair
      • IdentityKeyPair.model
      • IdentityKeyPair.json
      • IdentityKeyPair.from_model()
      • IdentityKeyPair.from_json()
      • IdentityKeyPair.secret_type
      • IdentityKeyPair.secret
      • IdentityKeyPair.as_priv()
      • IdentityKeyPair.__annotations__
    • IdentityKeyPairPriv
      • IdentityKeyPairPriv.__init__()
      • IdentityKeyPairPriv.secret_type
      • IdentityKeyPairPriv.secret
      • IdentityKeyPairPriv.as_priv()
      • IdentityKeyPairPriv.priv
      • IdentityKeyPairPriv.__annotations__
    • IdentityKeyPairSeed
      • IdentityKeyPairSeed.__init__()
      • IdentityKeyPairSeed.secret_type
      • IdentityKeyPairSeed.secret
      • IdentityKeyPairSeed.as_priv()
      • IdentityKeyPairSeed.seed
      • IdentityKeyPairSeed.__annotations__
  • Module: migrations
    • parse_identity_key_pair_model()
    • parse_signed_pre_key_pair_model()
    • parse_base_state_model()
  • Module: models
    • BaseStateModel
      • BaseStateModel.version
      • BaseStateModel.identity_key
      • BaseStateModel.signed_pre_key
      • BaseStateModel.old_signed_pre_key
      • BaseStateModel.pre_keys
      • BaseStateModel.Config
        • BaseStateModel.Config.json_encoders
    • IdentityKeyPairModel
      • IdentityKeyPairModel.version
      • IdentityKeyPairModel.secret
      • IdentityKeyPairModel.secret_type
      • IdentityKeyPairModel.Config
        • IdentityKeyPairModel.Config.json_encoders
    • SignedPreKeyPairModel
      • SignedPreKeyPairModel.version
      • SignedPreKeyPairModel.priv
      • SignedPreKeyPairModel.sig
      • SignedPreKeyPairModel.timestamp
      • SignedPreKeyPairModel.Config
        • SignedPreKeyPairModel.Config.json_encoders
  • Module: pre_key_pair
    • PreKeyPair
      • PreKeyPair.priv
      • PreKeyPair.pub
  • Module: signed_pre_key_pair
    • SignedPreKeyPair
      • SignedPreKeyPair.priv
      • SignedPreKeyPair.sig
      • SignedPreKeyPair.timestamp
      • SignedPreKeyPair.pub
      • SignedPreKeyPair.model
      • SignedPreKeyPair.json
      • SignedPreKeyPair.from_model()
      • SignedPreKeyPair.from_json()
  • Module: state
    • State
      • State.create()
      • State._publish_bundle()
      • State.from_model()
      • State.from_json()
      • State.rotate_signed_pre_key()
      • State.get_shared_secret_passive()
      • State.__annotations__
  • Module: types
    • Bundle
      • Bundle.identity_key
      • Bundle.signed_pre_key
      • Bundle.signed_pre_key_sig
      • Bundle.pre_keys
    • IdentityKeyFormat
      • IdentityKeyFormat.CURVE_25519
      • IdentityKeyFormat.ED_25519
    • Header
      • Header.identity_key
      • Header.ephemeral_key
      • Header.signed_pre_key
      • Header.pre_key
    • SecretType
      • SecretType.SEED
      • SecretType.PRIV