Crate ockam[−][src]
Expand description
Ockam is a library for building devices that communicate securely, privately and trustfully with cloud services and other devices.
Re-exports
pub extern crate hex;Modules
Macros
Creates a CredentialAttribute vector containing the arguments.
Creates a CredentialSchema containing the arguments.
Creates a list of revealed attributes containing the arguments.
Creates a Route containing the arguments.
Structs
A generic component address
A passthrough marker message type
A credential that can be presented
A BLS public key
The secret key is field element 0 < x < r
where r is the curve order. See Section 4.3 in
https://eprint.iacr.org/2016/663.pdf
A BLS public key
The secret key is field element 0 < x < r
where r is the curve order. See Section 4.3 in
https://eprint.iacr.org/2016/663.pdf
A message wraper type that allows users to cancel message receival
Profile changes with a given event identifier
Contact is an abstraction responsible for storing user’s public data (mainly - public keys).
It is designed to share users’ public keys in cryptographically verifiable way.
Public keys together with metadata are organised into verifiable events chain exactly like crate::Profile.
There are two ways to get Contact:
Context contains Node state and references to the runtime.
Key change creation
Key change data creation
An attribute describes a statement that the issuer of a credential is signing about the subject of the credential.
The information needed to convert a CredentialFragment2 to a Credential
A partial credential that will be completed by the holder
A credential offer is how an issuer informs a potential holder that a credential is available to them
Indicates how to present a credential
Serializable wrapper around a proof.
Serializable wrapper around a credential public key.
A request for a credential generated from a credential offer
A credential and fragment 1 pair
A schema describes the data format of a credential.
Send a delayed event to a worker
An identifier of a Profile.
The type of errors returned by Ockam functions.
Unique crate::ProfileChangeEvent identifier, computed as SHA256 of the event data
Ockam node and worker executor
Temporary: Externalized form of BlindSignatureContext - working around Serialize issues
External representation of a Commitment. G1Projective Serialization is interfering with BARE
Externalization of PoK
Attributes that are used to identify key
A lease for managing secrets
Entity SecureChannel LocalInfo used for LocalMessage
A mailbox for encoded messages
A minimal worker implementation that does nothing
A list of the accepted schemas, public keys, and required to be revealed attributes from a verifier
Individual change applied to profile. ProfileChangeEvent consists of one or more such changes
crate::Profiles are modified using change events mechanism. One event may have 1 or more ProfileChanges
Proof is used to check whether this event comes from a party authorized to perform such updated
Individual changes may include additional proofs, if needed
Pre-defined keys in ProfileEventAttributes map
Profile implementation
A user-defined protocol identifier
An extensible protocol parser abstraction
A protocol payload wrapper for pre-parsing
This Worker is responsible for registering on Ockam Hub and forwarding messages to local Worker
Information about a remotely forwarded worker.
RotateKeyChange
RotateKeyChangeData
A full route to a peer
A message wrapper that stores message route information
Secure Channel
Signature, its type and data
Vault implementation that stores secrets in memory and uses software crypto.
High level management interface for TCP transports
A generic transport message
Vault allows to start Vault Worker.
Vault sync wrapper
Represents an XX NewKeyExchanger
Enums
The attribute data that is signed by
The data type of an attribute’s value.
The error types that can occur when creating or verifying a credential.
Meta-Attributes about a key
Failure states from a router command
Messages sent from the Node to the Executor
Successful return values from a router command
Variants of proofs that are allowed on a crate::Profile change
Possible types of crate::Profile changes
A command message for router implementations
Types of proof signatures.
Constants
A default timeout in seconds
Entity SecureChannel LocalInfo unique Identifier
TCP address type constant
Traits
Credential Holder
Credential Issuer
Credential Verifier
Holder API
Identity
Issuer API
A user defined message that can be serialised and deserialised
A creator of both initiator and responder peers of a key exchange.
A parser for a protocol fragment
Traits required for a Vault implementation suitable for use in a Profile
Base ockam worker trait.
Functions
Type Definitions
Contacts Database
Alias of the type used for encoded data.
The reply/result of a Node
Alias for an array of Nonce::BYTES length.
Alias for an array of 32 bytes.
Profile event attributes
Alias for an array of 48 bytes.
Alias for an array of Nonce::BYTES length.
The type returned by Ockam functions.
Alias for an array of 32 bytes.
Alias for an array of 96 bytes.