Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

server

package

Go to main page

Versions in this module

v0

v0.3.8

Aug 14, 2026

v0.3.7

Aug 13, 2026

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

v0.3.1

Aug 4, 2026

v0.3.0

Aug 4, 2026

v0.2.5

Aug 4, 2026

Changes in this version

+ const APIKeyPermissionCall

+ const APIKeyPermissionMultiDevice

+ const APIKeyPermissionWebClient

+ const APIKeyStatusAwaitingPaymentGrace

+ const APIKeyStatusAwaitingPaymentOnHold

+ const APIKeyStatusExpired

+ const APIKeyStatusFreeTrial

+ const APIKeyStatusFreeTrialExpired

+ const APIKeyStatusLicensesExhausted

+ const APIKeyStatusOpenBeta

+ const APIKeyStatusUnknown

+ const APIKeyStatusValid

type Client

+ func (c *Client) AuthenticateWithStatus(serverURL string, owned *engine.OwnedCryptoIdentity, rnd prng.PRNG) (token []byte, sub SubscriptionInfo, err error)

+ func (c *Client) OwnedDeviceList(serverURL string, owned *engine.OwnedCryptoIdentity) (status Status, devices []OwnedDeviceInfo, multiDevice *bool, err error)

+ type OwnedDeviceInfo struct

+ DeviceUID []byte

+ Expiration int64

+ LastRegistration int64

+ type SubscriptionInfo struct

+ APIKeyStatus int64

+ Expiration int64

+ Permissions int64

+ func (s SubscriptionInfo) MultiDevice() bool

v0.2.4

Aug 2, 2026

Changes in this version

+ func SPKIFingerprint(cert *x509.Certificate) [32]byte

+ type CertObserver func(host string, leaf *x509.Certificate) error

type Option

+ func WithCertObserver(obs CertObserver) Option

v0.2.3

Aug 2, 2026

v0.2.2

Aug 2, 2026

v0.2.1

Aug 2, 2026

v0.2.0

Aug 2, 2026

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 APIVersion

+ const DeviceMgmtDeactivate

+ const DeviceMgmtRename

+ const DeviceMgmtSetNonExpiring

+ const PushTypeAndroidFCM

+ const PushTypeDaemon

+ const PushTypeIOSWithExt

+ const PushTypeLinux

+ const PushTypeWebSocketAndroid

+ const PushTypeWindows

+ const StatusCallPermissionDenied

+ const StatusConnectionError

+ const StatusDeletedFromServer

+ const StatusDeviceNotRegistered

+ const StatusExtendedContentNotFound

+ const StatusGroupLocked

+ const StatusGroupNotLocked

+ const StatusGroupUIDAlreadyUsed

+ const StatusInvalidSession

+ const StatusInvalidSignature

+ const StatusListTruncated

+ const StatusOK

+ const StatusPayloadTooLarge

+ const TransferServerURL

+ const UserAgentAndroid

+ const UserAgentIOS

+ const WSActionDeleteReturnReceipt

+ const WSActionKeycloak

+ const WSActionMessage

+ const WSActionOwnedDevices

+ const WSActionPushTopic

+ const WSActionRegister

+ const WSActionReturnReceipt

+ const WSErrInvalidToken

+ const WSErrUnknown

+ func DecodeRequest(body []byte) ([][]byte, error)

+ func DescribeAttachmentDescriptor(encoded []byte) string

+ func EncodeResponse(status byte, outputs ...[]byte) []byte

+ type AttachmentDownloadInfo struct

+ ChunkLength int64

+ DownloadURLs []string

+ EncryptedLength int64

+ Number int64

+ func ParseAttachmentDownloadInfo(encoded []byte) (*AttachmentDownloadInfo, error)

+ type AttachmentUploadInfo struct

+ ChunkLength int64

+ EncryptedLength int64

+ type Client struct

+ AllowInsecureAttachmentURLs bool

+ HTTP *http.Client

+ UserAgent string

+ func New(opts ...Option) *Client

+ func (c *Client) Authenticate(serverURL string, owned *engine.OwnedCryptoIdentity, rnd prng.PRNG) (token []byte, err error)

+ func (c *Client) Call(serverURL, path string, inputs [][]byte) (status Status, outputs [][]byte, err error)

+ func (c *Client) CreateGroupBlob(serverURL string, ...) (status Status, err error)

+ func (c *Client) DeactivateDevice(serverURL string, identity, token, deviceUID []byte) (Status, error)

+ func (c *Client) DeleteGroupBlob(serverURL string, groupUID, signature []byte) (status Status, err error)

+ func (c *Client) DeleteMessages(serverURL string, identity, token, deviceUID []byte, uids []UIDToDelete) (status Status, err error)

+ func (c *Client) DeviceDiscovery(serverURL string, identity []byte) (status Status, devices []DiscoveredDevice, serverTimestamp int64, ...)

+ func (c *Client) DialTransfer(wsURL string) (*TransferClient, error)

+ func (c *Client) DialWebSocket(wsURL string) (*WebSocket, error)

+ func (c *Client) DownloadExtendedPayload(serverURL string, identity, token, messageUID []byte) (status Status, encrypted []byte, err error)

+ func (c *Client) DownloadMessages(serverURL string, identity, token, deviceUID []byte, listStartTimestamp int64) (status Status, serverTimestamp int64, msgs []DownloadedMessage, err error)

+ func (c *Client) GetAttachmentChunk(signedURL string) ([]byte, error)

+ func (c *Client) GetGroupBlob(serverURL string, groupUID []byte) (status Status, blob *GroupBlobDownload, err error)

+ func (c *Client) GetToken(serverURL string, identity, response, nonce []byte) (status Status, token []byte, apiKeyStatus int64, err error)

+ func (c *Client) GetTurnCredentials(serverURL string, identity, token []byte, username1, username2 string) (status Status, creds *TurnCredentials, err error)

+ func (c *Client) LockGroupBlob(serverURL string, groupUID, lockNonce, signature []byte) (status Status, blob *GroupBlobDownload, err error)

+ func (c *Client) OwnedDeviceDiscovery(serverURL string, owned *engine.OwnedCryptoIdentity) (status Status, encodedDict []byte, err error)

+ func (c *Client) OwnedDevices(serverURL string, owned *engine.OwnedCryptoIdentity) (status Status, deviceUIDs [][]byte, serverTimestamp int64, err error)

+ func (c *Client) PutAttachmentChunk(signedURL string, encryptedChunk []byte) error

+ func (c *Client) PutGroupLog(serverURL string, groupUID, signature []byte) (status Status, err error)

+ func (c *Client) RegisterPushNotification(serverURL string, identity, token, deviceUID []byte, reg PushRegistration) (status Status, err error)

+ func (c *Client) RenameDevice(serverURL string, identity, token, deviceUID, encryptedName []byte) (Status, error)

+ func (c *Client) RequestChallenge(serverURL string, identity, nonce []byte) (status Status, challenge, serverNonce []byte, err error)

+ func (c *Client) SetNonExpiringDevice(serverURL string, identity, token, deviceUID []byte) (Status, error)

+ func (c *Client) UpdateGroupBlob(serverURL string, ...) (status Status, err error)

+ func (c *Client) UploadMessage(serverURL string, headers []Header, encryptedPayload, extendedPayload []byte, ...) (status Status, res *UploadResult, err error)

+ func (c *Client) UploadMessageWithAttachments(serverURL string, headers []Header, encryptedPayload, extendedPayload []byte, ...) (status Status, res *UploadResult, uploadURLs [][]string, err error)

+ func (c *Client) UploadPreKey(serverURL string, identity, token, deviceUID, encodedSignedPreKey []byte) (status Status, err error)

+ func (c *Client) UploadReturnReceipts(serverURL string, receipts []ReturnReceiptToUpload) (status Status, err error)

+ func (c *Client) WellKnown(serverURL string) (*WellKnown, error)

+ func (c *Client) WithContext(ctx context.Context) *Client

+ type DiscoveredDevice struct

+ DeviceUID []byte

+ SignedPreKey []byte

+ type DownloadedMessage struct

+ Attachments [][]byte

+ EncryptedPayload []byte

+ HasExtended bool

+ HeaderPayload []byte

+ MessageUID []byte

+ Timestamp int64

+ type GroupBlobDownload struct

+ AdminPublicKey []byte

+ EncryptedBlob []byte

+ LogItems [][]byte

+ UpdateTimestamp int64

+ type Header struct

+ DeviceUID []byte

+ RecipientIdentity []byte

+ WrappedKey []byte

+ type Option func(*Client)

+ func WithHTTPClient(h *http.Client) Option

+ func WithTimeout(d time.Duration) Option

+ func WithUserAgent(ua string) Option

+ type PushRegistration struct

+ DeviceUIDToReplace []byte

+ EncryptedDeviceName []byte

+ ExtraInfo [][]byte

+ KeycloakTopics []string

+ PushType byte

+ Reactivate bool

+ type ReturnReceipt struct

+ EncryptedPayload []byte

+ Nonce []byte

+ ServerUID []byte

+ Timestamp int64

+ type ReturnReceiptToUpload struct

+ DeviceUIDs [][]byte

+ EncryptedPayload []byte

+ Nonce []byte

+ RecipientIdentity []byte

+ type Status int

+ func (s Status) String() string

+ type TransferClient struct

+ func (t *TransferClient) Close() error

+ func (t *TransferClient) JoinTarget(sessionNumber string, firstPayload []byte) error

+ func (t *TransferClient) OpenSource() (sessionNumber string, connID string, err error)

+ func (t *TransferClient) Recv() (otherConnID string, payload []byte, err error)

+ func (t *TransferClient) Relay(otherConnID string, payload []byte, noResponseExpected bool) error

+ type TurnCredentials struct

+ Password1 string

+ Password2 string

+ Username1 string

+ Username2 string

+ type UIDToDelete struct

+ MarkAsListed bool

+ UID []byte

+ type UploadResult struct

+ MessageUID []byte

+ Nonce []byte

+ SignedURLs [][]byte

+ Timestamp int64

+ type WSEvent struct

+ Action string

+ Err int

+ HasErr bool

+ Identity []byte

+ Message []byte

+ ReturnReceipt *ReturnReceipt

+ Topic string

+ type WebSocket struct

+ func (w *WebSocket) Close() error

+ func (w *WebSocket) DeleteReturnReceipt(serverUID []byte) error

+ func (w *WebSocket) Read() (*WSEvent, error)

+ func (w *WebSocket) Register(identity, token, deviceUID []byte) error

+ type WellKnown struct

+ AddressServer string

+ AltTurnServers []string

+ OSMServer string

+ TurnServers []string

+ WSServer string