Module holochain::prelude::dependencies::kitsune_p2p_types::dependencies::lair_keystore_api::prelude

Re-export module of types generally used with lair.

Structs

• BinData
  Wrapper newtype for serde encoding / decoding binary data.
• BinDataSized
  Wrapper newtype for serde encoding / decoding sized binary data.
• CertInfo
  Public information associated with a given tls certificate.
• DeepLockPassphrase
  Instructions for how to argon2id pwhash a passphrase for use in deep locking a seed.
• LairApiReqCryptoBoxXSalsaByPubKey
  Request “crypto_box” encryption.
• LairApiReqCryptoBoxXSalsaOpenByPubKey
  Request “crypto_box_open” decryption.
• LairApiReqDeriveSeed
  Derive a new lair seed from an existing seed.
• LairApiReqExportSeedByTag
  Request “crypto_box” encryption.
• LairApiReqGetEntry
  Get entry_info for an entry by tag from lair.
• LairApiReqGetWkaTlsCertPrivKey
  Request the private key associated with a tagged wka tls cert.
• LairApiReqHello
  Initiate communication with the target lair instance.
• LairApiReqImportSeed
  Request “crypto_box_open” decryption.
• LairApiReqListEntries
  Request a list of entries from lair.
• LairApiReqNewSeed
  Instruct lair to generate a new seed from cryptographically secure random data with given tag.
• LairApiReqNewWkaTlsCert
  Instruct lair to generate a new wka tls certificate from cryptographically secure random data with given tag.
• LairApiReqSecretBoxXSalsaByTag
  Request “crypto_box” encryption.
• LairApiReqSecretBoxXSalsaOpenByTag
  Request “crypto_box” encryption.
• LairApiReqSignByPubKey
  Request a signature.
• LairApiReqUnlock
  Unlock the keystore – this verifies the client to the keystore.
• LairApiResCryptoBoxXSalsaByPubKey
  A “crypto_box” encryption response.
• LairApiResCryptoBoxXSalsaOpenByPubKey
  A “crypto_box_open” decryption response.
• LairApiResDeriveSeed
  Response to a ReqDeriveSeed request.
• LairApiResError
  An error response from the remote instance.
• LairApiResExportSeedByTag
  A “crypto_box” encryption response.
• LairApiResGetEntry
  Response to a GetEntry request.
• LairApiResGetWkaTlsCertPrivKey
  Returns the private key associated with a tagged wka tls cert.
• LairApiResHello
  The hello response from the target lair instance. This data allows us to verify we are speaking to our expected target.
• LairApiResImportSeed
  A “crypto_box_open” decryption response.
• LairApiResListEntries
  Respond to a list entries request.
• LairApiResNewSeed
  On new seed generation, lair will respond with info about that seed.
• LairApiResNewWkaTlsCert
  On new cert generation, lair will respond with info about that cert.
• LairApiResSecretBoxXSalsaByTag
  A “crypto_box” encryption response.
• LairApiResSecretBoxXSalsaOpenByTag
  A “crypto_box” encryption response.
• LairApiResSignByPubKey
  A signature response.
• LairApiResUnlock
  Sucess / Failure of the unlock request.
• LairClient
  A lair keystore client handle. Use this to make requests of the keystore.
• LairServer
  A lair keystore server handle. Use this to handle incoming client connections.
• LairServerConfigInner
  Inner config type used by lair servers. This will be wrapped in an Arc in the typedef LairServerConfig.
• LairStore
  A handle to a running lair keystore backend persistance instance. Allows storing, listing, and retrieving keystore secrets.
• LairStoreFactory
  A factory abstraction allowing connecting to a lair keystore persistance backend with an unlock secret (generally derived from a user passphrase).
• SecretData
  Secret data. Encrypted with sodium secretstream. The key used to encrypt / decrypt is context dependent.
• SecretDataSized
  Sized secret data. Encrypted with sodium secretstream. The key used to encrypt / decrypt is context dependent.
• SeedInfo
  Public information associated with a given seed.

Enums

• LairApiEnum
  Lair api enum.
• LairEntryInfo
  The type and tag of this lair entry.
• LairEntryInner
  The raw lair entry inner types that can be stored. This is generally wrapped by an Arc. See the typedef LairEntry.
• LairServerSignatureFallback
  Enum for configuring signature fallback handling.
• PwHashLimits
  Enum to specify limits (difficulty) for argon2id pwhashing algorithm.

Functions

• get_connection_path
  Get the connection “path”. This could have different meanings depending on if we are a unix domain socket or named pipe, etc.
• get_server_pub_key_from_connection_url
  Helper utility for extracting a server_pub_key from a connection_url.
• spawn_lair_server_task
  Spawn a tokio task managing a lair server with given store factory.

Type Aliases

• CertDigest
  The 32 byte blake2b digest of the der encoded tls certificate.
• DeepLockPassphraseBytes
  The secret bytes of the passphrase
• Ed25519PubKey
  Ed25519 signature public key derived from this seed.
• Ed25519Signature
  Ed25519 signature bytes.
• LairEntry
  An actual LairEntry. Unlike LairEntryInfo, this type contains the actual secrets associated with the keystore entry.
• LairResult
  Lair result type.
• LairServerConfig
  Configuration for running a lair-keystore server instance.
• Seed
  Data type for secret seed
• X25519PubKey
  X25519 encryption public key derived from this seed.