import "github.com/katzenpost/catshadow"
client.go constants.go contact.go disk.go events.go message.go operations.go queue.go worker.go
const (
// DoubleRatchetPayloadLength is the length of the payload encrypted by the ratchet.
DoubleRatchetPayloadLength = common.SpoolPayloadLength - ratchet.DoubleRatchetOverhead
// MessageExpirationDuration is the duration of time after which messages will be removed.
MessageExpirationDuration = 168 * time.Hour
// MessageIDLen is the length of our message IDs which are used the keys in a map
// to reference individual messages of a conversation.
MessageIDLen = 4
// GarbageCollectionInterval is the time interval between garbage collecting
// old messages.
GarbageCollectionInterval = 120 * time.Minute
)const MaxQueueSize = 20const ReadInboxLambdaPDivisor = 42ReadInboxLambdaPDivisor is used to divide our LambdaP parameter to determine our new lambda parameter for our poisson process which is used in selecting time intervals between attempting to retreive messages from our remote Provider.
ErrQueueEmpty is the error issued when the queue is empty.
ErrQueueFull is the error issued when the queue is full.
func LoadStateWriter(log *logging.Logger, stateFile string, passphrase []byte) (*StateWriter, *State, error)
LoadStateWriter decrypts the given stateFile and returns the State as well as a new StateWriter.
func NewContactExchangeBytes(spoolWriteDescriptor *memspoolClient.SpoolWriteDescriptor, signedKeyExchange *ratchet.SignedKeyExchange) ([]byte, error)
NewContactExchangeBytes returns serialized contact exchange information.
type Client struct {
worker.Worker
EventSink chan interface{}
// contains filtered or unexported fields
}Client is the mixnet client which interacts with other clients and services on the network.
func New(logBackend *log.Backend, mixnetClient *client.Client, stateWorker *StateWriter, state *State) (*Client, error)
New creates a new Client instance given a mixnetClient, stateWorker and state. This constructor is used to load the previously saved state of a Client.
func NewClientAndRemoteSpool(logBackend *log.Backend, mixnetClient *client.Client, stateWorker *StateWriter, user string, linkKey *ecdh.PrivateKey) (*Client, error)
NewClientAndRemoteSpool creates a new Client and creates a new remote spool for collecting messages destined to this Client. The Client is associated with this remote spool and this state is preserved in the encrypted statefile, of course. This constructor of Client is used when creating a new Client as opposed to loading the previously saved state for an existing Client.
CreateRemoteSpool creates a remote spool for collecting messages destined to this Client. This method blocks until the reply from the remote spool service is received or the round trip timeout is reached.
XXX do we even need this method?
NewContact adds a new contact to the Client's state. This starts the PANDA protocol instance for this contact where intermediate states will be preserved in the encrypted statefile such that progress on the PANDA key exchange can be continued at a later time after program shutdown or restart.
RemoveContact removes a contact from the Client's state.
SendMessage sends a message to the Client contact with the given nickname.
Shutdown shuts down the client.
Start starts the client worker goroutine and the read-inbox worker goroutine.
type Contact struct {
// Nickname is also unique locally.
Nickname string
// IsPending is true if the key exchange has not been completed.
IsPending bool
// contains filtered or unexported fields
}Contact is a communications contact that we have bidirectional communication with.
func NewContact(nickname string, id uint64, spoolReadDescriptor *memspoolClient.SpoolReadDescriptor, session *client.Session) (*Contact, error)
NewContact creates a new Contact or returns an error.
ID returns the Contact ID.
MarshalBinary does what you expect and returns a serialized Contact.
UnmarshalBinary does what you expect and initializes the given Contact with deserialized Contact fields from the given binary blob.
type KeyExchangeCompletedEvent struct {
// Nickname is the nickname of the contact with whom our key
// exchange has been completed.
Nickname string
// Err is a key exchange error or is set to nil on success.
Err error
}KeyExchangeCompletedEvent is an event signaling the completion of a key exchange or failure if Err is non-nil.
Message encapsulates message that is sent or received.
type MessageDeliveredEvent struct {
// Nickname is the nickname of the recipient of our delivered message.
Nickname string
// MessageID is the key in the conversation map referencing a specific message.
MessageID MessageID
}MessageDeliveredEvent is an event signaling that the message has been delivered to the remote spool.
type MessageID [MessageIDLen]byte
type MessageNotSentEvent struct {
// Nickname is the nickname of the recipient of our delivered message.
Nickname string
// MessageID is the key in the conversation map referencing a specific message.
MessageID MessageID
}MessageNotSentEvent is an event signalling that the message was not sent.
type MessageReceivedEvent struct {
// Nickname is the nickname from whom we received a message.
Nickname string
// Message is the message content which was received.
Message []byte
// Timestamp is the time the message was received.
Timestamp time.Time
}MessageReceivedEvent is the event signaling that a message was received.
type MessageSentEvent struct {
// Nickname is the nickname of the recipient of our delivered message.
Nickname string
// MessageID is the key in the conversation map referencing a specific message.
MessageID MessageID
}MessageSentEvent is an event signaling that the message was sent.
Queue is our in-memory queue implementation used as our egress FIFO queue for messages sent by the client.
Peek returns the next message ref from the queue without modifying the queue.
Pop pops the next message ref off the queue and returns nil upon success, otherwise an error is returned.
Push pushes the given message ref onto the queue and returns nil on success, otherwise an error is returned.
type SentMessageDescriptor struct {
// Nickname is the contact nickname to whom a message was sent.
Nickname string
// MessageID is the key in the conversation map referencing a specific message.
MessageID MessageID
}type State struct {
SpoolReadDescriptor *client.SpoolReadDescriptor
Contacts []*Contact
User string
Provider string
LinkKey *ecdh.PrivateKey
Conversations map[string]map[MessageID]*Message
}State is the struct type representing the Client's state which is encrypted and persisted to disk.
StateWriter takes ownership of the Client's encrypted statefile and has a worker goroutine which writes updates to disk.
func NewStateWriter(log *logging.Logger, stateFile string, passphrase []byte) (*StateWriter, error)
NewStateWriter is a constructor for StateWriter which is to be used when creating the statefile for the first time.
func (w *StateWriter) Start()
Start starts the StateWriter's worker goroutine.
| Path | Synopsis |
|---|---|
| config | Package config implements the configuration for catshadow. |
Package catshadow imports 27 packages (graph). Updated 2020-10-25. Refresh now. Tools for package owners.