engine

package

Go to main page

Versions in this module

v0

v0.3.8

Aug 14, 2026

v0.3.7

Aug 13, 2026

Changes in this version

+ func IsSASPropagatedCommitment(m *ProtocolMessage) bool

+ func IsSASPropagatedConfirmation(m *ProtocolMessage) bool

+ func IsSASPropagatedEnteredSAS(m *ProtocolMessage) bool

+ func IsSASPropagatedInvitation(m *ProtocolMessage) bool

+ func NewSASFromPropagatedCommitment(owned *OwnedCryptoIdentity, ownDeviceUIDs [][]byte, ownDetails string, ...) (party *SASParty, peer *CryptoIdentity, err error)

+ func NewSASFromPropagatedInvitation(owned *OwnedCryptoIdentity, ownDeviceUIDs [][]byte, ownDetails string, ...) (party *SASParty, peer *CryptoIdentity, displayName string, err error)

+ func SASMessageFromOwnDevice(messageID int) bool

+ func SASPropagatedCommitmentPeer(m *ProtocolMessage) ([]byte, error)

+ func SASPropagatedInvitationPeer(m *ProtocolMessage) ([]byte, error)

type SASParty

+ func (p *SASParty) BuildPropagateCommitment() *ProtocolMessage

+ func (p *SASParty) BuildPropagateConfirmation(accepted bool) *ProtocolMessage

+ func (p *SASParty) BuildPropagateEnteredSAS() *ProtocolMessage

+ func (p *SASParty) BuildPropagateInvitation(contactDisplayName string) *ProtocolMessage

v0.3.6

Aug 13, 2026

v0.3.5

Aug 7, 2026

v0.3.4

Aug 7, 2026

v0.3.3

Aug 5, 2026

v0.3.2

Aug 5, 2026

Changes in this version

type AuthEncKey

+ func DecodeReturnReceiptKey(encodedKey []byte) (*AuthEncKey, error)

type TransferSnapshot

+ OwnedPublishedDetails string

v0.3.1

Aug 4, 2026

v0.3.0

Aug 4, 2026

Changes in this version

+ const CapMsgOwnToContact

+ const CapMsgOwnToSelf

+ const CapabilityGroupsV2

+ const CapabilityOneToOneContacts

+ const CapabilityWebRTCContinuousICE

+ const ContactMgmtMsgDeletionNotification

+ const ContactMgmtMsgDowngradeNotification

+ const ContactMgmtMsgPerformDeviceDiscovery

+ const ContactMgmtMsgPropagateDeletion

+ const ContactMgmtMsgPropagateDowngrade

+ const OwnedIdentityDeletionMsgContactDeleted

+ const ProtocolContactManagement

+ const ProtocolDeviceCapabilitiesDiscovery

+ const ProtocolOwnedIdentityDeletion

+ func CurrentCapabilities() []string

+ func DecryptDeviceName(owned *OwnedCryptoIdentity, encrypted []byte) (string, error)

+ func DeserializeCapabilities(blob []byte) []string

+ func EncryptDeviceName(owned *OwnedCryptoIdentity, name string, rnd prng.PRNG) ([]byte, error)

+ func IntersectCapabilities(deviceSets [][]string) []string

+ func ParseCapabilitiesMessage(pm *ProtocolMessage) (rawCaps []string, isResponse, toSelf bool, err error)

+ func ParseContactMgmtPropagatedIdentity(pm *ProtocolMessage) ([]byte, error)

+ func ParseOwnedIdentityDeletedMessage(pm *ProtocolMessage) (deletedIdentity, signature []byte, err error)

+ func SerializeCapabilities(caps []string) []byte

+ func SignOwnedIdentityDeletion(recipientIdentity []byte, deleter *OwnedCryptoIdentity, rnd prng.PRNG) ([]byte, error)

+ func VerifyOwnedIdentityDeletion(recipientIdentity, signature []byte, deleterAuth *PublicKeyOverEC) bool

type ProtocolMessage

+ func BuildCapabilitiesMessage(rawCaps []string, isResponse, toSelf bool, rnd prng.PRNG) (*ProtocolMessage, error)

+ func BuildContactDeletionNotification(rnd prng.PRNG) (*ProtocolMessage, error)

+ func BuildContactDowngradeNotification(rnd prng.PRNG) (*ProtocolMessage, error)

+ func BuildOwnedIdentityDeletedMessage(deletedIdentity, signature []byte, rnd prng.PRNG) (*ProtocolMessage, error)

+ func BuildPerformContactDeviceDiscovery(rnd prng.PRNG) (*ProtocolMessage, error)

+ func BuildPropagateContactDeletion(contactIdentity []byte, rnd prng.PRNG) (*ProtocolMessage, error)

+ func BuildPropagateContactDowngrade(contactIdentity []byte, rnd prng.PRNG) (*ProtocolMessage, error)

v0.2.5

Aug 4, 2026

Changes in this version

+ const GroupV2MsgInvitationRejectedBroadcast

type GroupIdentifier

+ func ParseGroupLeftBroadcast(m *ProtocolMessage) (gid GroupIdentifier, err error)

type SASParty

+ func (p *SASParty) Cancelled() bool

+ func (p *SASParty) InstanceUID() [32]byte

+ func (p *SASParty) ReceiveParsed(m *ProtocolMessage) ([]OutgoingMessage, error)

v0.2.4

Aug 2, 2026

v0.2.3

Aug 2, 2026

v0.2.2

Aug 2, 2026

Changes in this version

type DeviceTransferParty

+ func (p *DeviceTransferParty) CommitmentConnID() string

v0.2.1

Aug 2, 2026

Changes in this version

+ func ParseOwnedDeviceChannelCreationPing(pm *ProtocolMessage) (senderDevice []byte, err error)

type ChannelCreationParty

+ func (p *ChannelCreationParty) IsOwnedDevice() bool

v0.2.0

Aug 2, 2026

Changes in this version

type ChannelCreationParty

+ func (p *ChannelCreationParty) NascentChannel() *ObliviousChannel

+ func (p *ChannelCreationParty) ReceiveParsed(m *ProtocolMessage) ([]OutgoingMessage, error)

v0.1.4

Aug 1, 2026

v0.1.3

Aug 1, 2026

v0.1.2

Aug 1, 2026

v0.1.1

Aug 1, 2026

v0.1.0

Aug 1, 2026

Changes in this version

+ const BackupJSONVersion

+ const BackupSeedLength

+ const ErrCrypt

+ const GroupCategoryKeycloak

+ const GroupCategoryServer

+ const GroupInvitationNonceLength

+ const GroupLockNonceLength

+ const GroupPermissionAdmin

+ const GroupPermissionChangeSettings

+ const GroupPermissionEditOrRemoteDeleteOwn

+ const GroupPermissionRemoteDeleteAnything

+ const GroupPermissionSendMessage

+ const GroupV2MsgInvitationOrMembersUpdate

+ const GroupV2MsgInvitationOrMembersUpdateBroadcast

+ const GroupV2MsgInvitationOrMembersUpdatePropagated

+ const GroupV2MsgKick

+ const GroupV2MsgPing

+ const IdentityDetailsMsgInitial

+ const IdentityDetailsMsgPropagateOwn

+ const IdentityDetailsMsgSendDetails

+ const IdentityDetailsMsgServerPutPhoto

+ const IntroMsgAck

+ const IntroMsgDialogAccept

+ const IntroMsgInitial

+ const IntroMsgMediatorInvitation

+ const IntroMsgNotifyAccepted

+ const IntroMsgPropagateConfirm

+ const IntroMsgPropagateNotify

+ const IntroMsgTrustLevelIncrease

+ const MessageTypeApplication

+ const MessageTypeProtocol

+ const ProtocolChannelCreation

+ const ProtocolChannelCreationWithOwned

+ const ProtocolContactMutual

+ const ProtocolContactPictureDownloadChild

+ const ProtocolDeviceDiscovery

+ const ProtocolDeviceDiscoveryChild

+ const ProtocolFullRatchet

+ const ProtocolGroupInvitation

+ const ProtocolGroupManagement

+ const ProtocolGroupPictureDownloadChild

+ const ProtocolGroupsV2

+ const ProtocolIdentityDetailPublication

+ const ProtocolObliviousChannelManagement

+ const ProtocolOwnedDeviceDiscovery

+ const ProtocolSynchronization

+ const ProtocolTrustEstablishmentMutualScan

+ const ProtocolTrustEstablishmentSAS

+ const ReturnReceiptStatusDelivered

+ const ReturnReceiptStatusRead

+ const SettingAutoJoinGroups

+ const SettingSendReadReceipt

+ const SettingUnarchiveOnNotification

+ const SnapshotTagSettings

+ const SyncArchivedDiscussionsChange

+ const SyncBookmarkedMessageChange

+ const SyncContactCustomHueChange

+ const SyncContactNicknameChange

+ const SyncContactPersonalNoteChange

+ const SyncContactSendReadReceiptChange

+ const SyncDiscussionsMuteChange

+ const SyncGroupV1NicknameChange

+ const SyncGroupV1PersonalNoteChange

+ const SyncGroupV1SendReadReceiptChange

+ const SyncGroupV2NicknameChange

+ const SyncGroupV2PersonalNoteChange

+ const SyncGroupV2SendReadReceiptChange

+ const SyncMsgInitiateSingleItem

+ const SyncMsgSingleItem

+ const SyncMsgSnapshot

+ const SyncOwnProfileNicknameChange

+ const SyncPinnedDiscussionsChange

+ const SyncSettingAutoJoinGroups

+ const SyncSettingDefaultSendReadReceipts

+ const SyncSettingLastRating

+ const SyncSettingUnarchiveOnNotification

+ const SyncTrustContactDetails

+ const SyncTrustGroupV1Details

+ const SyncTrustGroupV2Details

+ var DefaultGroupAdminPermissions = []string

+ var DefaultGroupMemberPermissions = []string

+ func AttachmentSHA256(plaintext []byte) []byte

+ func AttachmentSizing(plaintextLen int64, dataChunkSize int) (numChunks int, fullChunkCipherLen, totalCipherLen int64)

+ func AuthenticationCheck(response, challenge, prefix []byte, pk *PublicKeyOverEC) bool

+ func AuthenticationSolve(sk *PrivateKeyOverEC, challenge, prefix []byte, pk *PublicKeyOverEC, ...) (response []byte, err error)

+ func ComputeChannelSeed(k1, k2 *AuthEncKey) ([]byte, error)

+ func ComputeDoubleSAS(seedAlice, seedBob, identity []byte, numberOfDigits int) ([]byte, error)

+ func ComputeFullRatchetInstanceUID(aliceIdentity, bobIdentity, aliceDeviceUID, bobDeviceUID []byte) ([32]byte, error)

+ func DecryptAttachment(key *AuthEncKey, chunks [][]byte) ([]byte, error)

+ func DecryptAttachmentChunk(key *AuthEncKey, encryptedChunk []byte) (chunkNumber int64, data []byte, err error)

+ func DecryptBackup(blob []byte, keys *BackupDerivedKeys) ([]byte, error)

+ func DecryptMessageAsOwner(header, ciphertext []byte, owned *OwnedCryptoIdentity) (encodedPayload []byte, err error)

+ func DecryptReturnReceipt(key *AuthEncKey, encryptedPayload []byte) (readerIdentity []byte, status int64, err error)

+ func DecryptServerBlob(ciphertext, mainSeed, versionSeed, expectedGroupUID []byte) (blob *ServerBlob, signer *CryptoIdentity, err error)

+ func DisplayNameFromSerializedDetails(s string) string

+ func EncodeAttachmentDescriptor(key *AuthEncKey, metadataJSON []byte) []byte

+ func EncodeGroupAdminPublicKey(pk *PublicKeyOverEC) []byte

+ func EncryptAdminChain(chain *AdministratorsChain, mainSeed []byte, rnd prng.PRNG) ([]byte, error)

+ func EncryptAttachment(key *AuthEncKey, plaintext []byte, dataChunkSize int, rnd prng.PRNG) ([][]byte, error)

+ func EncryptAttachmentChunk(key *AuthEncKey, chunkNumber int, data []byte, rnd prng.PRNG) ([]byte, error)

+ func EncryptAttachmentStream(key *AuthEncKey, r io.Reader, dataChunkSize int, rnd prng.PRNG, ...) (int, error)

+ func EncryptBackup(payload []byte, keys *BackupDerivedKeys, rnd prng.PRNG) ([]byte, error)

+ func EncryptMessageForIdentity(encodedPayload []byte, recipient *CryptoIdentity, rnd prng.PRNG) (header, ciphertext []byte, err error)

+ func EncryptMessageForIdentityWithExtended(encodedPayload, extendedPayload []byte, recipient *CryptoIdentity, ...) (header, ciphertext, encryptedExtended []byte, err error)

+ func EncryptReturnReceipt(key *AuthEncKey, senderIdentity []byte, status int64, rnd prng.PRNG) ([]byte, error)

+ func EncryptReturnReceiptWithKey(encodedKey, senderIdentity []byte, status int64, rnd prng.PRNG) ([]byte, error)

+ func EncryptServerBlob(blob *ServerBlob, signer *OwnedCryptoIdentity, mainSeed, versionSeed []byte, ...) ([]byte, error)

+ func GenerateAuthenticationKeyPair(rnd prng.PRNG, curve *ec.Curve) (pk *PublicKeyOverEC, sk *PrivateKeyOverEC, err error)

+ func GenerateGroupAdminKeyPair(rnd prng.PRNG) (pk *PublicKeyOverEC, sk *PrivateKeyOverEC, err error)

+ func GenerateKEMKeyPair(rnd prng.PRNG, curve *ec.Curve) (pk *PublicKeyOverEC, sk *PrivateKeyOverEC, err error)

+ func GeneratePreKey(owned *OwnedCryptoIdentity, deviceUID []byte, expiration int64, ...) (signedPreKey []byte, private *PrivateKeyOverEC, pk *PreKey, err error)

+ func GenerateSignatureKeyPair(rnd prng.PRNG, curve *ec.Curve) (pk *PublicKeyOverEC, sk *PrivateKeyOverEC, err error)

+ func IsGroupInvitationMessage(pm *ProtocolMessage) bool

+ func IsIntroductionAck(pm *ProtocolMessage) bool

+ func IsSASCommitment(m *ProtocolMessage) bool

+ func KEMDecrypt(sk *PrivateKeyOverEC, c []byte, keyLen uint32) (key []byte, err error)

+ func KEMEncrypt(pk *PublicKeyOverEC, rnd prng.PRNG, keyLen uint32) (c, key []byte, err error)

+ func MarshalInteropBackup(owned []OwnedIdentityBackup, timestampMillis int64) ([]byte, error)

+ func NewSASResponderFromCommitment(owned *OwnedCryptoIdentity, ownDeviceUIDs [][]byte, ownDetails string, ...) (party *SASParty, peer *CryptoIdentity, peerDeviceUIDs [][]byte, ...)

+ func ParseContactChannelCreationPing(pm *ProtocolMessage) (senderIdentity, senderDevice []byte, err error)

+ func ParseGroupInvitationMessage(m *ProtocolMessage) (gid GroupIdentifier, version int64, keys *BlobKeys, deviceUIDs [][]byte, ...)

+ func ParseIdentityDetailsMessage(pm *ProtocolMessage) (string, error)

+ func ParseMediatorInvitationMessage(pm *ProtocolMessage) (contactIdentity []byte, serializedDetails string, err error)

+ func ParseNotifyAcceptedMessage(pm *ProtocolMessage) (deviceUIDs [][]byte, signature []byte, err error)

+ func ParseReturnReceiptPayload(decrypted []byte) (senderIdentity []byte, status int64, attachmentNumber int64, ...)

+ func PublicKeyDecrypt(sk *PrivateKeyOverEC, ct []byte) (plaintext []byte, err error)

+ func PublicKeyEncrypt(pk *PublicKeyOverEC, plaintext []byte, rnd prng.PRNG) (ct []byte, err error)

+ func RunChannelCreation(alice, bob *ChannelCreationParty) error

+ func RunFullRatchet(initiator, responder *FullRatchetParty) error

+ func RunTrustEstablishmentSAS(alice, bob *SASParty) error

+ func SASCommitmentPeerIdentity(m *ProtocolMessage) ([]byte, error)

+ func SerializeDisplayName(name string) string

+ func SerializeIdentityDetails(d SerializedIdentityDetails) string

+ func SerializeIdentityDetailsWithVersion(details SerializedIdentityDetails, version int) string

+ func SignChannelCreationPing(sender *OwnedCryptoIdentity, senderDeviceUID []byte, recipient *CryptoIdentity, ...) ([]byte, error)

+ func SignGroupDelete(adminPk *PublicKeyOverEC, adminSk *PrivateKeyOverEC, rnd prng.PRNG) ([]byte, error)

+ func SignGroupJoinPing(gid GroupIdentifier, ownNonce []byte, recipient *CryptoIdentity, ...) ([]byte, error)

+ func SignGroupKick(encryptedChain, kickedNonce []byte, signer *OwnedCryptoIdentity, rnd prng.PRNG) ([]byte, error)

+ func SignGroupLeaveLog(gid GroupIdentifier, invitationNonce []byte, leaver *OwnedCryptoIdentity, ...) ([]byte, error)

+ func SignGroupLock(nonce []byte, adminPk *PublicKeyOverEC, adminSk *PrivateKeyOverEC, ...) ([]byte, error)

+ func SignGroupUpdate(nonce, encryptedBlob, encodedNewAdminPublicKey []byte, ...) ([]byte, error)

+ func SignMutualIntroduction(signer *OwnedCryptoIdentity, id0, id1, id2 []byte, rnd prng.PRNG) ([]byte, error)

+ func SignatureSign(sk *PrivateKeyOverEC, m []byte, pk *PublicKeyOverEC, rnd prng.PRNG) (sigma []byte, err error)

+ func SignatureVerify(pk *PublicKeyOverEC, m, sigma []byte) bool

+ func VerifyChannelCreationPing(signature []byte, self *CryptoIdentity, selfDeviceUID []byte, ...) bool

+ func VerifyGroupJoinPing(gid GroupIdentifier, senderNonce []byte, self *CryptoIdentity, ...) bool

+ func VerifyGroupKick(encryptedChain, ownNonce []byte, signerAuth *PublicKeyOverEC, sig []byte) bool

+ func VerifyGroupLeaveLog(gid GroupIdentifier, member *GroupMember, logItem []byte) bool

+ func VerifyJWS(compact string, jwk *JSONWebKey) ([]byte, error)

+ func VerifyMessageKey(ae *AuthEncKey, paddedPlaintext []byte) bool

+ func VerifyMutualIntroduction(signerAuth *PublicKeyOverEC, id0, id1, id2, sig []byte) bool

+ type AES256CtrKey types.SymmetricKey

+ func NewAES256Ctr(key []byte) (*AES256CtrKey, error)

+ func (aesk *AES256CtrKey) CtLen(l uint32) (lo uint32)

+ func (aesk *AES256CtrKey) Decrypt(ct []byte) (pt []byte, err error)

+ func (aesk *AES256CtrKey) Encrypt(iv, pt []byte) (ct []byte, err error)

+ func (aesk *AES256CtrKey) PtLen(l uint32) (lo uint32, err error)

+ type AdminChainBlock struct

+ type AdministratorsChain struct

+ Blocks []*AdminChainBlock

+ GroupUID []byte

+ func DecodeAdministratorsChain(b []byte) (*AdministratorsChain, error)

+ func DecryptAdminChain(ciphertext, mainSeed []byte) (*AdministratorsChain, error)

+ func StartNewAdminChain(owner *OwnedCryptoIdentity, otherAdmins []*CryptoIdentity, rnd prng.PRNG) (*AdministratorsChain, error)

+ func (c *AdministratorsChain) Admins() []*CryptoIdentity

+ func (c *AdministratorsChain) AppendBlock(owner *OwnedCryptoIdentity, otherAdmins []*CryptoIdentity, rnd prng.PRNG) (*AdministratorsChain, error)

+ func (c *AdministratorsChain) CheckIntegrity(expectedGroupUID []byte) error

+ func (c *AdministratorsChain) CheckIntegrityWithPrefix(expectedGroupUID []byte, trustedPrefix *AdministratorsChain) error

+ func (c *AdministratorsChain) IsPrefixedBy(prefix *AdministratorsChain) bool

+ type AttachmentMetadata struct

+ FileName string

+ SHA256 []byte

+ Type string

+ func ParseAttachmentMetadata(b []byte) (*AttachmentMetadata, error)

+ func (m *AttachmentMetadata) Marshal() ([]byte, error)

+ type AuthEnc interface

+ CtLen func(ptlen uint32) (ctlen uint32)

+ Decrypt func(ct []byte) (pt []byte, err error)

+ Encrypt func(pt []byte, rnd prng.PRNG) (ct []byte, err error)

+ PtLen func(ctlen uint32) (ptlen uint32, err error)

+ type AuthEncKey struct

+ func DecodeAttachmentDescriptor(b []byte) (key *AuthEncKey, metadataJSON []byte, err error)

+ func DeriveExtendedPayloadKey(msgKey *AuthEncKey) (*AuthEncKey, error)

+ func ExtendedPayloadKeyForOwner(header []byte, owned *OwnedCryptoIdentity) (*AuthEncKey, error)

+ func GenerateAttachmentKey(rnd prng.PRNG) (*AuthEncKey, error)

+ func GenerateMessageKey(rnd prng.PRNG, paddedPlaintext []byte) (*AuthEncKey, error)

+ func GroupBlobEncryptionKey(mainSeed, versionSeed []byte) (*AuthEncKey, error)

+ func NewAES256CtrHmacSha256KeyFromBytes(b []byte) (ae *AuthEncKey, err error)

+ func NewAES256CtrHmacSha256KeyFromDict(dict types.Dict) (ae *AuthEncKey, err error)

+ func NewAES256CtrHmacSha256KeyFromSeed(seed []byte) (ae *AuthEncKey, err error)

+ func NewReturnReceiptKey(rnd prng.PRNG) (nonce, encodedKey []byte, key *AuthEncKey, err error)

+ func (ae *AuthEncKey) CtLen(ptlen uint32) (ctlen uint32)

+ func (ae *AuthEncKey) Decrypt(ct []byte) (pt []byte, err error)

+ func (ae *AuthEncKey) Encrypt(pt []byte, rnd prng.PRNG) (ct []byte, err error)

+ func (ae *AuthEncKey) PtLen(ctlen uint32) (ptlen uint32, err error)

+ func (ae *AuthEncKey) Wipe()

+ type BackupDerivedKeys struct

+ EncPriv *PrivateKeyOverEC

+ EncPub *PublicKeyOverEC

+ KeyUID []byte

+ MacKey []byte

+ type BackupEngine struct

+ IdentityManager []OwnedIdentityBackup

+ type BackupFormat int

+ const BackupFormatLibrary

+ const BackupFormatOlvidInterop

+ func BackupFormatOf(plaintext []byte) (BackupFormat, error)

+ func (f BackupFormat) String() string

+ type BackupJSON struct

+ BackupJSONVersion int

+ BackupTimestamp int64

+ Engine BackupEngine

+ func ParseInteropBackup(jsonBytes []byte) (*BackupJSON, error)

+ type BackupSeed []byte

+ func GenerateBackupSeed(rnd prng.PRNG) (BackupSeed, error)

+ func ParseBackupSeed(s string) (BackupSeed, error)

+ func (s BackupSeed) DeriveKeys() (*BackupDerivedKeys, error)

+ func (s BackupSeed) String() string

+ type BlobKeys struct

+ BlobMainSeed []byte

+ BlobVersionSeed []byte

+ GroupAdminPrivateKey *PrivateKeyOverEC

+ func DecodeBlobKeys(b []byte) (*BlobKeys, error)

+ func (k *BlobKeys) Encode() []byte

+ type ChannelCreationParty struct

+ Channel *ObliviousChannel

+ Confirmed bool

+ func NewChannelCreationParty(owned *OwnedCryptoIdentity, deviceUID []byte, contact *CryptoIdentity, ...) *ChannelCreationParty

+ func NewOwnedDeviceChannelCreationParty(owned *OwnedCryptoIdentity, deviceUID, otherDeviceUID []byte, ...) *ChannelCreationParty

+ func (p *ChannelCreationParty) Begin() ([]OutgoingMessage, error)

+ func (p *ChannelCreationParty) Contact() *CryptoIdentity

+ func (p *ChannelCreationParty) ContactDeviceUID() []byte

+ func (p *ChannelCreationParty) Receive(header, ciphertext []byte) ([]OutgoingMessage, error)

+ func (p *ChannelCreationParty) Start() ([]ccpOutgoing, error)

+ type Committer struct

+ func NewCommitter(fn hashFunc, rnd prng.PRNG) (c *Committer, err error)

+ func (c *Committer) Commit(tag, val []byte) (com, token []byte, err error)

+ func (c *Committer) Open(com, tag, token []byte) (val []byte, err error)

+ type ContactGroupBackup struct

+ GroupMembersVersion int

+ GroupUID []byte

+ LatestDetails *GroupDetailsBackup

+ Members []GroupMemberBackup

+ PendingMembers []PendingGroupMemberBackup

+ PublishedDetails GroupDetailsBackup

+ TrustedDetails *GroupDetailsBackup

+ type ContactIdentityBackup struct

+ ContactGroups []ContactGroupBackup

+ ContactIdentity []byte

+ ForcefullyTrusted bool

+ OneToOne bool

+ PublishedDetails IdentityDetailsBackup

+ Revoked bool

+ TrustLevel string

+ TrustOrigins []ContactTrustOrigin

+ TrustedDetails IdentityDetailsBackup

+ type ContactTrustOrigin struct

+ IdentityServer string

+ MediatorOrGroupOwnerIdentity []byte

+ MediatorOrGroupOwnerTrustLevelMajor int

+ Timestamp int64

+ TrustType int

+ type CryptoIdentity struct

+ Auth *PublicKeyOverEC

+ KEM *PublicKeyOverEC

+ ServerURL []byte

+ func CryptoIdentityFromBytes(identity []byte) (*CryptoIdentity, error)

+ func NewCryptoIdentity(serverURL []byte, auth, kem *PublicKeyOverEC) *CryptoIdentity

+ func (id *CryptoIdentity) GetIdentity() []byte

+ type DeviceTransferParty struct

+ func NewDeviceTransferSource(owned *OwnedCryptoIdentity, snapshot []byte, connID string, rnd prng.PRNG) *DeviceTransferParty

+ func NewDeviceTransferTarget(deviceName string, serverURL []byte, rnd prng.PRNG) (*DeviceTransferParty, error)

+ func (p *DeviceTransferParty) CheckSAS(entered []byte) bool

+ func (p *DeviceTransferParty) CommitmentPayload() ([]byte, error)

+ func (p *DeviceTransferParty) DecommitmentPayload() ([]byte, error)

+ func (p *DeviceTransferParty) DeviceName() string

+ func (p *DeviceTransferParty) EphemeralIdentityPayload() []byte

+ func (p *DeviceTransferParty) KeepActiveDevice() []byte

+ func (p *DeviceTransferParty) ReceiveCommitment(payload []byte) error

+ func (p *DeviceTransferParty) ReceiveDecommitment(payload []byte) error

+ func (p *DeviceTransferParty) ReceiveEphemeralIdentity(payload []byte) error

+ func (p *DeviceTransferParty) ReceiveSeed(payload []byte) error

+ func (p *DeviceTransferParty) ReceiveSnapshot(payload []byte) ([]byte, error)

+ func (p *DeviceTransferParty) SAS() []byte

+ func (p *DeviceTransferParty) SeedPayload() ([]byte, error)

+ func (p *DeviceTransferParty) SnapshotPayload(deviceUIDToKeepActive []byte) ([]byte, error)

+ type Error string

+ func (e Error) Error() string

+ type FullRatchetParty struct

+ Done bool

+ func NewFullRatchetParty(owned *OwnedCryptoIdentity, deviceUID []byte, contact *CryptoIdentity, ...) *FullRatchetParty

+ func (p *FullRatchetParty) Begin() ([]OutgoingMessage, error)

+ func (p *FullRatchetParty) Cancelled() bool

+ func (p *FullRatchetParty) ContactDeviceUID() []byte

+ func (p *FullRatchetParty) InstanceUID() [32]byte

+ func (p *FullRatchetParty) IsDone() bool

+ func (p *FullRatchetParty) ReceiveDecoded(m *ProtocolMessage) ([]OutgoingMessage, error)

+ func (p *FullRatchetParty) Restart() ([]ccpOutgoing, error)

+ func (p *FullRatchetParty) RestartOutgoing() ([]OutgoingMessage, error)

+ func (p *FullRatchetParty) SetNow(nowMs int64)

+ func (p *FullRatchetParty) Start() ([]ccpOutgoing, error)

+ type GroupDetailsBackup struct

+ PhotoServerKey []byte

+ PhotoServerLabel []byte

+ SerializedDetails string

+ Version int

+ type GroupIdentifier struct

+ Category int64

+ GroupUID []byte

+ ServerURL string

+ func DecodeGroupIdentifier(b []byte) (GroupIdentifier, error)

+ func ParseKickMessage(m *ProtocolMessage) (gid GroupIdentifier, encryptedChain, signature []byte, err error)

+ func ParsePingMessage(m *ProtocolMessage) (gid GroupIdentifier, invitationNonce, signature []byte, isResponse bool, ...)

+ func (g GroupIdentifier) Bytes() []byte

+ func (g GroupIdentifier) Encode() []byte

+ func (g GroupIdentifier) ProtocolInstanceUID() ([32]byte, error)

+ type GroupMember struct

+ GroupInvitationNonce []byte

+ Identity *CryptoIdentity

+ Permissions []string

+ SerializedDetails string

+ func (m *GroupMember) IsAdmin() bool

+ type GroupMemberBackup struct

+ ContactIdentity []byte

+ type GroupV2Backup struct

+ Category int64

+ Details GroupDetailsBackup

+ EncodedAdminKey []byte

+ GroupUID []byte

+ InvitationNonce []byte

+ MainSeed []byte

+ Members []GroupV2MemberBackup

+ PendingMembers []GroupV2PendingMemberBackup

+ Permissions []string

+ SerializedGroupType string

+ SerializedSharedSettings string

+ ServerURL string

+ TrustedDetails *GroupDetailsBackup

+ VerifiedAdminChain []byte

+ Version int64

+ VersionSeed []byte

+ func GroupV2BackupFrom(gid GroupIdentifier, keys *BlobKeys, blob *ServerBlob, ownNonce []byte, ...) GroupV2Backup

+ type GroupV2MemberBackup struct

+ ContactIdentity []byte

+ InvitationNonce []byte

+ Permissions []string

+ type GroupV2PendingMemberBackup struct

+ ContactIdentity []byte

+ InvitationNonce []byte

+ Permissions []string

+ SerializedDetails string

+ type IdentityDetailsBackup struct

+ PhotoServerKey []byte

+ PhotoServerLabel []byte

+ SerializedDetails string

+ Version int

+ type IdentityDetailsWithVersion struct

+ Details SerializedIdentityDetails

+ Version int

+ type JSONWebKey struct

+ Crv string

+ E string

+ Kty string

+ N string

+ X string

+ Y string

+ type KDF struct

+ func NewKDFFromPRNGWithHMACWithSHA256() (kdf *KDF)

+ func (kdf *KDF) Compute(seed []byte, length uint32) (b []byte, err error)

+ type MAC interface

+ Len func() (l uint32)

+ Sum func(m []byte) (out []byte)

+ type MacKey struct

+ func NewHmacSha256KeyFromBytes(b []byte) (mk *MacKey, err error)

+ func NewHmacSha256KeyFromKDF(seed []byte) (mk *MacKey, err error)

+ func NewHmacSha256KeyFromPRNG(rnd prng.PRNG) (mk *MacKey, err error)

+ func (mk *MacKey) Len() (l uint32)

+ func (mk *MacKey) Sum(m []byte) (out []byte)

+ type ObliviousChannel struct

+ LookAhead int

+ func DecodeObliviousChannel(b []byte) (*ObliviousChannel, error)

+ func EstablishObliviousChannelPair(k1, k2 *AuthEncKey, aliceDeviceUID, bobDeviceUID []byte) (alice, bob *ObliviousChannel, err error)

+ func NewObliviousChannel(seed, selfDeviceUID, remoteDeviceUID []byte) (*ObliviousChannel, error)

+ func (c *ObliviousChannel) DecryptMessage(header, ciphertext []byte) (encodedPayload []byte, err error)

+ func (c *ObliviousChannel) Encode() []byte

+ func (c *ObliviousChannel) EncryptMessage(encodedPayload []byte, rnd prng.PRNG) (header, ciphertext []byte, err error)

+ func (c *ObliviousChannel) FullRatchetInProgress() bool

+ func (c *ObliviousChannel) MaybeTriggerFullRatchet(nowMs int64) bool

+ func (c *ObliviousChannel) RatchetReceiveSeed(newSeed, remoteDeviceUID []byte, nowMs int64) error

+ func (c *ObliviousChannel) RatchetSendSeed(newSeed, selfDeviceUID []byte, nowMs int64) error

+ type ObvURLIdentity struct

+ DisplayName string

+ Identity *CryptoIdentity

+ func ParseInvitationLink(link string) (*ObvURLIdentity, error)

+ func (u *ObvURLIdentity) InvitationLink() string

+ type OutgoingMessage struct

+ Ciphertext []byte

+ Header []byte

+ ViaOblivious bool

+ type OwnedCryptoIdentity struct

+ AuthPrivateKey *PrivateKeyOverEC

+ AuthPublicKey *PublicKeyOverEC

+ KEMPrivateKey *PrivateKeyOverEC

+ KEMPublicKey *PublicKeyOverEC

+ SecretMACKey *MacKey

+ ServerURL []byte

+ func DecodeOwnedCryptoIdentity(b []byte) (*OwnedCryptoIdentity, error)

+ func GenerateOwnedCryptoIdentity(serverURL []byte, rnd prng.PRNG) (*OwnedCryptoIdentity, error)

+ func ReconstructOwnedIdentity(identityBytes, authPrivEnc, kemPrivEnc, macKeyEnc []byte) (*OwnedCryptoIdentity, error)

+ func (o *OwnedCryptoIdentity) Encode() []byte

+ func (o *OwnedCryptoIdentity) GetCryptoIdentity() *CryptoIdentity

+ func (o *OwnedCryptoIdentity) InvitationLink(displayName string) string

+ type OwnedIdentityBackup struct

+ APIKey string

+ Active *bool

+ ContactIdentities []ContactIdentityBackup

+ GroupsV2 []GroupV2Backup

+ LatestDetails IdentityDetailsBackup

+ OwnedGroups []ContactGroupBackup

+ OwnedIdentity []byte

+ PrivateIdentity PrivateIdentityBackup

+ PublishedDetails IdentityDetailsBackup

+ func OwnedIdentityBackupFromIdentity(o *OwnedCryptoIdentity, published, latest IdentityDetailsBackup, apiKey string) OwnedIdentityBackup

+ type PendingGroupMemberBackup struct

+ ContactIdentity []byte

+ Declined bool

+ SerializedDetails string

+ type PreKey struct

+ Capabilities []string

+ DeviceUID []byte

+ EncryptionKey *PublicKeyOverEC

+ Expiration int64

+ KeyID []byte

+ func ParseSignedPreKey(signedPreKey []byte, ownerAuth *PublicKeyOverEC, serverTimestamp int64) (*PreKey, error)

+ func (pk *PreKey) Sign(owned *OwnedCryptoIdentity, rnd prng.PRNG) ([]byte, error)

+ type PrivateIdentityBackup struct

+ EncryptionPrivateKey []byte

+ MacKey []byte

+ ServerAuthenticationPrivateKey []byte

+ type PrivateKeyOverEC struct

+ Curve *ec.Curve

+ Scalar *big.Int

+ func DecodePrivateKeyOverEC(b []byte) (*PrivateKeyOverEC, error)

+ func (sk *PrivateKeyOverEC) Encode() []byte

+ type ProtocolMessage struct

+ Inputs [][]byte

+ InstanceUID [32]byte

+ MessageID uint32

+ ProtocolID uint32

+ func BuildGroupInvitationBroadcast(gid GroupIdentifier, version int64, keys *BlobKeys) (*ProtocolMessage, error)

+ func BuildGroupInvitationMessage(gid GroupIdentifier, version int64, keys *BlobKeys, ...) (*ProtocolMessage, error)

+ func BuildGroupInvitationPropagated(gid GroupIdentifier, version int64, keys *BlobKeys, inviter *CryptoIdentity) (*ProtocolMessage, error)

+ func BuildKickMessage(gid GroupIdentifier, encryptedChain, signature []byte) (*ProtocolMessage, error)

+ func BuildPingMessage(gid GroupIdentifier, invitationNonce, signature []byte, isResponse bool) (*ProtocolMessage, error)

+ func BuildSingleItemSyncMessage(atom *SyncAtom) (*ProtocolMessage, error)

+ func BuildSnapshotSyncMessage(snapshot *Snapshot) *ProtocolMessage

+ func DecodeProtocolEnvelope(b []byte) (*ProtocolMessage, error)

+ func NewIntroductionAckMessage(instanceUID [32]byte) *ProtocolMessage

+ func NewMediatorInvitationMessage(instanceUID [32]byte, contactIdentity []byte, serializedDetails string) *ProtocolMessage

+ func NewNotifyAcceptedMessage(instanceUID [32]byte, deviceUIDs [][]byte, signature []byte) *ProtocolMessage

+ func NewPropagateOwnDetailsMessage(instanceUID [32]byte, jsonDetailsWithVersion string) *ProtocolMessage

+ func NewSendDetailsMessage(instanceUID [32]byte, jsonDetailsWithVersion string) *ProtocolMessage

+ func (m *ProtocolMessage) Encode() []byte

+ func (m *ProtocolMessage) EncodeEnvelope() []byte

+ type PublicKeyOverEC struct

+ Curve *ec.Curve

+ Point *ec.Point

+ func DecodeGroupAdminPublicKey(b []byte) (*PublicKeyOverEC, error)

+ func (pk *PublicKeyOverEC) Encode() []byte

+ func (pk *PublicKeyOverEC) GetCompactKey() []byte

+ type SASParty struct

+ SASToDisplay []byte

+ Trusted bool

+ func NewSASParty(owned *OwnedCryptoIdentity, contact *CryptoIdentity, instanceUID [32]byte, ...) *SASParty

+ func (p *SASParty) AwaitingSAS() bool

+ func (p *SASParty) Begin() ([]OutgoingMessage, error)

+ func (p *SASParty) CheckSAS(enteredFromContact []byte) ([]OutgoingMessage, bool, error)

+ func (p *SASParty) MutualTrustConfirmed() bool

+ func (p *SASParty) PeerDetails() string

+ func (p *SASParty) PeerDeviceUIDs() [][]byte

+ func (p *SASParty) Receive(header, ciphertext []byte) ([]OutgoingMessage, error)

+ func (p *SASParty) Start() ([]ccpOutgoing, error)

+ func (p *SASParty) StateName() string

+ type SerializedIdentityDetails struct

+ Company string

+ FirstName string

+ LastName string

+ Position string

+ func ParseIdentityDetailsWithVersion(s string) (SerializedIdentityDetails, int, error)

+ type ServerBlob struct

+ Chain *AdministratorsChain

+ Members []*GroupMember

+ SerializedGroupDetails string

+ SerializedGroupType string

+ Version int64

+ func DecodeServerBlob(b []byte) (*ServerBlob, error)

+ func (b *ServerBlob) ConsolidateLeaveLogs(gid GroupIdentifier, logItems [][]byte) []*CryptoIdentity

+ func (b *ServerBlob) EncodePlain() []byte

+ type SettingsNode struct

+ AutoJoinGroups *string

+ Domain []string

+ SendReadReceipt *bool

+ UnarchiveOnNotification *bool

+ func (n *SettingsNode) ContentsEqual(o SnapshotNode) bool

+ func (n *SettingsNode) Diff(o SnapshotNode) ([]SyncDiff, error)

+ func (n *SettingsNode) Encode() []byte

+ func (n *SettingsNode) Tag() string

+ type Snapshot struct

+ func DecodeSnapshot(b []byte, decoders SnapshotDecoders) (*Snapshot, error)

+ func DecodeSnapshotDict(d types.Dict, decoders SnapshotDecoders) (*Snapshot, error)

+ func NewSnapshot(nodes ...SnapshotNode) *Snapshot

+ func ParseSnapshotSyncMessage(m *ProtocolMessage, decoders SnapshotDecoders) (*Snapshot, error)

+ func (s *Snapshot) Add(n SnapshotNode)

+ func (s *Snapshot) ContentsEqual(other *Snapshot) bool

+ func (s *Snapshot) Diff(other *Snapshot) ([]SyncDiff, error)

+ func (s *Snapshot) Encode() []byte

+ func (s *Snapshot) EncodeDict() types.Dict

+ func (s *Snapshot) Get(tag string) SnapshotNode

+ func (s *Snapshot) Tags() []string

+ type SnapshotDecoders map[string]func([]byte) (SnapshotNode, error)

+ type SnapshotNode interface

+ ContentsEqual func(other SnapshotNode) bool

+ Diff func(other SnapshotNode) ([]SyncDiff, error)

+ Encode func() []byte

+ Tag func() string

+ func DecodeSettingsNode(b []byte) (SnapshotNode, error)

+ type SymEnc interface

+ CtLen func(ptlen uint32) (ctlen uint32)

+ Decrypt func(ct []byte) (pt []byte, err error)

+ Encrypt func(iv, pt []byte) (ct []byte, err error)

+ PtLen func(ctlen uint32) (ptlen uint32, err error)

+ type SyncAtom struct

+ BoolValue *bool

+ ContactIdentity []byte

+ GroupOwnerAndUID []byte

+ GroupV2ID []byte

+ IntValue *int64

+ StringValue *string

+ Type int

+ func ParseSingleItemSyncMessage(m *ProtocolMessage) (*SyncAtom, error)

+ func ParseSyncAtom(b []byte) (*SyncAtom, error)

+ func (a *SyncAtom) Encode() ([]byte, error)

+ func (a *SyncAtom) IsAppSyncItem() bool

+ type SyncDiff struct

+ Field string

+ Local string

+ NodeTag string

+ Other string

+ type TransferContact struct

+ ForcefullyTrusted bool

+ Identity []byte

+ OneToOne bool

+ PublishedDetails string

+ Revoked bool

+ TrustLevel string

+ TrustedDetails string

+ type TransferGroupV2 struct

+ EncodedAdminKey []byte

+ Identifier []byte

+ InvitationNonce []byte

+ MainSeed []byte

+ VersionSeed []byte

+ type TransferSnapshot struct

+ AuthPrivEnc []byte

+ BackupSeed []byte

+ Contacts []TransferContact

+ Groups []TransferGroupV2

+ KEMPrivEnc []byte

+ MacKeyEnc []byte

+ OwnedIdentity []byte

+ func ParseTransferSnapshot(dictBlock []byte) (*TransferSnapshot, error)

+ func (ts *TransferSnapshot) OwnedIdentityCrypto() (*OwnedCryptoIdentity, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL