proton

package module
v0.4.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 13, 2023 License: MIT Imports: 45 Imported by: 0

README

Go Proton API

CI Status GoDoc Go Report Card License

This repository holds Go Proton API, a Go library implementing a client and development server for (a subset of) the Proton REST API.

The license can be found in the LICENSE file.

For the contribution policy, see CONTRIBUTING.

Environment variables

Most of the integration tests run locally. The ones that interact with Proton servers require the following environment variables set:

  • GO_PROTON_API_TEST_USERNAME
  • GO_PROTON_API_TEST_PASSWORD

Contribution

The library is maintained by Proton AG, and is not actively looking for contributors.

Documentation

Overview

Package proton implements types for accessing the Proton API.

Index

Examples

Constants

View Source 
const (
	FieldPMScheme   = "X-PM-SCHEME"
	FieldPMSign     = "X-PM-SIGN"
	FieldPMEncrypt  = "X-PM-ENCRYPT"
	FieldPMMIMEType = "X-PM-MIMETYPE"
)
View Source 
const (
	InboxLabel        = "0"
	AllDraftsLabel    = "1"
	AllSentLabel      = "2"
	TrashLabel        = "3"
	SpamLabel         = "4"
	AllMailLabel      = "5"
	ArchiveLabel      = "6"
	SentLabel         = "7"
	DraftsLabel       = "8"
	OutboxLabel       = "9"
	StarredLabel      = "10"
	AllScheduledLabel = "12"
)
View Source 
const (
	// DefaultHostURL is the default host of the API.
	DefaultHostURL = "https://mail.proton.me/api"

	// DefaultAppVersion is the default app version used to communicate with the API.
	// This must be changed (using the WithAppVersion option) for production use.
	DefaultAppVersion = "go-proton-api"
)

Variables

View Source 
var CharsetReader func(charset string, input io.Reader) (io.Reader, error)

CharsetReader returns a charset decoder for the given charset. If set, it will be used to decode non-utf8 encoded messages.

View Source 
var ErrBadHeader = errors.New("bad header")
View Source 
var ErrImportEncrypt = errors.New("failed to encrypt message")
View Source 
var ErrImportSizeExceeded = errors.New("message exceeds maximum import size of 30MB")
View Source 
var ErrInvalidProof = errors.New("unexpected server proof")
View Source 
var ErrJobCancelled = errors.New("job cancelled by surrounding context")

ErrJobCancelled indicates the job was cancelled.

View Source 
var ErrNoSuchLabel = errors.New("no such label")
View Source 
var ErrUndoTokenExpired = errors.New("undo token expired")

Functions

func BuildRFC822 

func BuildRFC822(kr *crypto.KeyRing, msg Message, attData map[string][]byte) ([]byte, error)

func ChunkSized 

func ChunkSized[T any](vals []T, maxLen, maxSize int, getSize func(T) int) [][]T

ChunkSized splits a slice into chunks of maximum size and length. It is assumed that the size of each element is less than the maximum size.

func ClientIDFromContext 

func ClientIDFromContext(ctx context.Context) (uint64, bool)

ClientIDFromContext returns true if this context was marked as originating from a client.

func DecodeKeyPacket 

func DecodeKeyPacket(packet string) []byte

func EncryptRFC822 

func EncryptRFC822(kr *crypto.KeyRing, literal []byte) ([]byte, error)

EncryptRFC822 encrypts the given message literal as a PGP attachment.

func InsecureTransport 

func InsecureTransport() *http.Transport

InsecureTransport returns an http.Transport with InsecureSkipVerify set to true.

func NewDropConn 

func NewDropConn(c net.Conn, l *Listener) net.Conn

func NewHangConn 

func NewHangConn(c net.Conn, l *Listener) net.Conn

func Unlock 

func Unlock(user User, addresses []Address, saltedKeyPass []byte, panicHandler async.PanicHandler) (*crypto.KeyRing, map[string]*crypto.KeyRing, error)

func WithClient 

func WithClient(parent context.Context, clientID uint64) context.Context

WithClient marks this context as originating from the client with the given ID.

Types

type APIBool 

type APIBool int

APIBool is the boolean type used by the API (0 or 1). 

const (
	APIFalse APIBool = iota
	APITrue
)

type APIError 

type APIError struct {
	// Status is the HTTP status code of the response that caused the error.
	Status int

	// Code is the error code returned by the API.
	Code Code

	// Message is the error message returned by the API.
	Message string `json:"Error"`

	// Details contains optional error details which are specific to each request.
	Details any
}

APIError represents an error returned by the API.

func (APIError) DetailsToString 

func (err APIError) DetailsToString() string

func (APIError) Error 

func (err APIError) Error() string

type Address 

type Address struct {
	ID    string
	Email string

	Send    Bool
	Receive Bool
	Status  AddressStatus
	Type    AddressType

	Order       int
	DisplayName string

	Keys Keys
}

type AddressEvent 

type AddressEvent struct {
	EventItem

	Address Address
}

type AddressStatus 

type AddressStatus int
const (
	AddressStatusDisabled AddressStatus = iota
	AddressStatusEnabled
	AddressStatusDeleting
)

type AddressType 

type AddressType int
const (
	AddressTypeOriginal AddressType = iota + 1
	AddressTypeAlias
	AddressTypeCustom
	AddressTypePremium
	AddressTypeExternal
)

type Attachment 

type Attachment struct {
	ID string

	Name        string
	Size        int64
	MIMEType    rfc822.MIMEType
	Disposition Disposition
	Headers     Headers

	KeyPackets string
	Signature  string
}

type AttachmentAllocator 

type AttachmentAllocator interface {
	// NewBuffer should return a new byte buffer for use. Note that this function may be called from multiple go-routines.
	NewBuffer() *bytes.Buffer
}

AttachmentAllocator abstract the attachment download buffer creation.

type Auth 

type Auth struct {
	UserID string

	UID          string
	AccessToken  string
	RefreshToken string
	ServerProof  string

	Scope        string
	TwoFA        TwoFAInfo `json:"2FA"`
	PasswordMode PasswordMode
}

type Auth2FAReq 

type Auth2FAReq struct {
	TwoFactorCode string   `json:",omitempty"`
	FIDO2         FIDO2Req `json:",omitempty"`
}

type AuthHandler 

type AuthHandler func(Auth)

AuthHandler is given any new auths that are returned from the API due to an unexpected auth refresh.

type AuthInfo 

type AuthInfo struct {
	Version         int
	Modulus         string
	ServerEphemeral string
	Salt            string
	SRPSession      string
	TwoFA           TwoFAInfo `json:"2FA"`
}

type AuthInfoReq 

type AuthInfoReq struct {
	Username string
}

type AuthModulus 

type AuthModulus struct {
	Modulus   string
	ModulusID string
}

type AuthRefreshReq 

type AuthRefreshReq struct {
	UID          string
	RefreshToken string
	ResponseType string
	GrantType    string
	RedirectURI  string
	State        string
}

type AuthReq 

type AuthReq struct {
	Auth2FAReq `json:",omitempty"`

	Username        string
	ClientEphemeral string
	ClientProof     string
	SRPSession      string
}

type AuthSession 

type AuthSession struct {
	UID        string
	CreateTime int64

	ClientID  string
	MemberID  string
	Revocable Bool

	LocalizedClientName string
}

type AuthVerifier 

type AuthVerifier struct {
	Version   int
	ModulusID string
	Salt      string
	Verifier  string
}

type Block 

type Block struct {
	Index int

	BareURL string // URL to the block
	Token   string // Token for download URL

	Hash           string // Encrypted block's sha256 hash, in base64
	EncSignature   string // Encrypted signature of the block
	SignatureEmail string // Email used to sign the block
}

Block is a block of file contents. They are split in 4MB blocks although this number may change in the future. Each block is its own data packet separated from the key packet which is held by the node, which means the sessionKey is the same for every block.

type BlockToken 

type BlockToken struct {
	Index int
	Token string
}

type BlockUploadInfo 

type BlockUploadInfo struct {
	Index        int
	Size         int64
	EncSignature string
	Hash         string
}
type BlockUploadLink struct {
	Token   string
	BareURL string
}

type BlockUploadReq 

type BlockUploadReq struct {
	AddressID  string
	ShareID    string
	LinkID     string
	RevisionID string

	BlockList []BlockUploadInfo
}

type Bool 

type Bool bool

Bool is a convenience type for boolean values; it converts from APIBool to Go's builtin bool type.

func (Bool) FormatURL 

func (b Bool) FormatURL() string

func (Bool) MarshalJSON 

func (b Bool) MarshalJSON() ([]byte, error)

func (Bool) String 

func (b Bool) String() string

func (*Bool) UnmarshalJSON 

func (b *Bool) UnmarshalJSON(data []byte) error

type Calendar 

type Calendar struct {
	ID          string
	Name        string
	Description string
	Color       string
	Display     Bool

	Type  CalendarType
	Flags CalendarFlag
}

type CalendarAttendee 

type CalendarAttendee struct {
	ID          string
	Token       string
	Status      CalendarAttendeeStatus
	Permissions CalendarPermissions
}

type CalendarAttendeeStatus 

type CalendarAttendeeStatus int

TODO: What is this? 

const (
	CalendarAttendeeStatusPending CalendarAttendeeStatus = iota
	CalendarAttendeeStatusMaybe
	CalendarAttendeeStatusNo
	CalendarAttendeeStatusYes
)

type CalendarEvent 

type CalendarEvent struct {
	ID            string
	UID           string
	CalendarID    string
	SharedEventID string

	CreateTime    int64
	LastEditTime  int64
	StartTime     int64
	StartTimezone string
	EndTime       int64
	EndTimezone   string
	FullDay       Bool

	Author      string
	Permissions CalendarPermissions
	Attendees   []CalendarAttendee

	SharedKeyPacket   string
	CalendarKeyPacket string

	SharedEvents    []CalendarEventPart
	CalendarEvents  []CalendarEventPart
	AttendeesEvents []CalendarEventPart
	PersonalEvents  []CalendarEventPart
}

type CalendarEventPart 

type CalendarEventPart struct {
	MemberID string

	Type      CalendarEventType
	Data      string
	Signature string
	Author    string
}

TODO: Only personal events have MemberID; should we have a different type for that?

func (CalendarEventPart) Decode 

func (part CalendarEventPart) Decode(calKR *crypto.KeyRing, addrKR *crypto.KeyRing, kp []byte) error

type CalendarEventType 

type CalendarEventType int
const (
	CalendarEventTypeClear CalendarEventType = iota
	CalendarEventTypeEncrypted
	CalendarEventTypeSigned
)

type CalendarFlag 

type CalendarFlag int64
const (
	CalendarFlagActive CalendarFlag = 1 << iota
	CalendarFlagUpdatePassphrase
	CalendarFlagResetNeeded
	CalendarFlagIncompleteSetup
	CalendarFlagLostAccess
)

type CalendarKey 

type CalendarKey struct {
	ID           string
	CalendarID   string
	PassphraseID string
	PrivateKey   string
	Flags        CalendarKeyFlag
}

func (CalendarKey) Unlock 

func (key CalendarKey) Unlock(passphrase []byte) (*crypto.Key, error)

type CalendarKeyFlag 

type CalendarKeyFlag int64

TODO: What is this? 

const (
	CalendarKeyFlagActive CalendarKeyFlag = 1 << iota
	CalendarKeyFlagPrimary
)

type CalendarKeys 

type CalendarKeys []CalendarKey

func (CalendarKeys) Unlock 

func (keys CalendarKeys) Unlock(passphrase []byte) (*crypto.KeyRing, error)

type CalendarMember 

type CalendarMember struct {
	ID          string
	Permissions CalendarPermissions
	Email       string
	Color       string
	Display     Bool
	CalendarID  string
}

type CalendarPassphrase 

type CalendarPassphrase struct {
	ID                string
	Flags             CalendarPassphraseFlag
	MemberPassphrases []MemberPassphrase
}

TODO: Support invitations.

func (CalendarPassphrase) Decrypt 

func (passphrase CalendarPassphrase) Decrypt(memberID string, addrKR *crypto.KeyRing) ([]byte, error)

type CalendarPassphraseFlag 

type CalendarPassphraseFlag int64

TODO: What is this?

type CalendarPermissions 

type CalendarPermissions int

TODO: What is this?

type CalendarType 

type CalendarType int
const (
	CalendarTypeNormal CalendarType = iota
	CalendarTypeSubscribed
)

type Card 

type Card struct {
	Type      CardType
	Data      string
	Signature string
}

func NewCard 

func NewCard(kr *crypto.KeyRing, cardType CardType) (*Card, error)

func (*Card) ChangeType 

func (c *Card) ChangeType(kr *crypto.KeyRing, cardType CardType) error

func (*Card) DeleteGroup 

func (c *Card) DeleteGroup(kr *crypto.KeyRing, groupKey, groupValue string) error

DeleteGroup removes all values in the group defined by the given key/value pair.

func (Card) Get 

func (c Card) Get(kr *crypto.KeyRing, key string) ([]*vcard.Field, error)

func (Card) GetGroup 

func (c Card) GetGroup(kr *crypto.KeyRing, groupKey, groupValue string) (CardGroup, error)

GetGroup returns a type to manipulate the group defined by the given key/value pair.

func (*Card) Set 

func (c *Card) Set(kr *crypto.KeyRing, key, value string) error

type CardGroup 

type CardGroup struct {
	Card
	// contains filtered or unexported fields
}

func (*CardGroup) Add 

func (g *CardGroup) Add(key, value string, params vcard.Params) error

Add adds a value to the group.

func (CardGroup) Get 

func (g CardGroup) Get(key string) ([]string, error)

Get returns the values in the group with the given key.

func (*CardGroup) Remove 

func (g *CardGroup) Remove(key, value string) error

Remove removes the value in the group with the given key/value.

func (*CardGroup) RemoveAll 

func (g *CardGroup) RemoveAll(key string) error

RemoveAll removes all values in the group with the given key.

func (*CardGroup) Set 

func (g *CardGroup) Set(key, value string, params vcard.Params) error

Set sets the value in the group.

type CardType 

type CardType int
const (
	CardTypeClear CardType = iota
	CardTypeEncrypted
	CardTypeSigned
)

type Cards 

type Cards []*Card

func (*Cards) Get 

func (c *Cards) Get(cardType CardType) (*Card, bool)

func (*Cards) Merge 

func (c *Cards) Merge(kr *crypto.KeyRing) (vcard.Card, error)

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client is the proton client.

func (*Client) AddAuthHandler 

func (c *Client) AddAuthHandler(handler AuthHandler)
Example 
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

// Create a new manager.
m := proton.New()

// Create a new client.
c := m.NewClient("...uid...", "...acc...", "...ref...")
defer c.Close()

// Register an auth handler with the client.
// This could be used for example to save the auth to keychain.
c.AddAuthHandler(func(auth proton.Auth) {
	// Do something with auth.
})

if _, err := c.GetUser(ctx); err != nil {
	panic(err)
}

Output:

func (*Client) AddDeauthHandler 

func (c *Client) AddDeauthHandler(handler Handler)

func (*Client) AddPostRequestHook 

func (c *Client) AddPostRequestHook(hook resty.ResponseMiddleware)

func (*Client) AddPreRequestHook 

func (c *Client) AddPreRequestHook(hook resty.RequestMiddleware)

func (*Client) Auth2FA 

func (c *Client) Auth2FA(ctx context.Context, req Auth2FAReq) error

func (*Client) AuthDelete 

func (c *Client) AuthDelete(ctx context.Context) error

func (*Client) AuthRevoke 

func (c *Client) AuthRevoke(ctx context.Context, authUID string) error

func (*Client) AuthRevokeAll 

func (c *Client) AuthRevokeAll(ctx context.Context) error

func (*Client) AuthSessions 

func (c *Client) AuthSessions(ctx context.Context) ([]AuthSession, error)

func (*Client) Close 

func (c *Client) Close()

func (*Client) CountCalendarEvents 

func (c *Client) CountCalendarEvents(ctx context.Context, calendarID string) (int, error)

func (*Client) CountContactEmails 

func (c *Client) CountContactEmails(ctx context.Context, email string) (int, error)

func (*Client) CountContacts 

func (c *Client) CountContacts(ctx context.Context) (int, error)

func (*Client) CountMessages 

func (c *Client) CountMessages(ctx context.Context) (int, error)

func (*Client) CreateAddressKey 

func (c *Client) CreateAddressKey(ctx context.Context, req CreateAddressKeyReq) (Key, error)

func (*Client) CreateContacts 

func (c *Client) CreateContacts(ctx context.Context, req CreateContactsReq) ([]CreateContactsRes, error)

func (*Client) CreateDraft 

func (c *Client) CreateDraft(ctx context.Context, addrKR *crypto.KeyRing, req CreateDraftReq) (Message, error)

func (*Client) CreateFile 

func (c *Client) CreateFile(ctx context.Context, shareID string, req CreateFileReq) (CreateFileRes, error)

func (*Client) CreateFolder 

func (c *Client) CreateFolder(ctx context.Context, shareID string, req CreateFolderReq) (CreateFolderRes, error)

func (*Client) CreateLabel 

func (c *Client) CreateLabel(ctx context.Context, req CreateLabelReq) (Label, error)

func (*Client) CreateLegacyAddressKey 

func (c *Client) CreateLegacyAddressKey(ctx context.Context, req CreateAddressKeyReq) (Key, error)

func (*Client) DeleteAddress 

func (c *Client) DeleteAddress(ctx context.Context, addressID string) error

func (*Client) DeleteAddressKey 

func (c *Client) DeleteAddressKey(ctx context.Context, keyID string, keyList KeyList) error

func (*Client) DeleteChildren 

func (c *Client) DeleteChildren(ctx context.Context, shareID, linkID string, childIDs ...string) error

func (*Client) DeleteContacts 

func (c *Client) DeleteContacts(ctx context.Context, req DeleteContactsReq) error

func (*Client) DeleteLabel 

func (c *Client) DeleteLabel(ctx context.Context, labelID string) error

func (*Client) DeleteMessage 

func (c *Client) DeleteMessage(ctx context.Context, messageIDs ...string) error

func (*Client) DeleteUser 

func (c *Client) DeleteUser(ctx context.Context, password []byte, req DeleteUserReq) error

func (*Client) DisableAddress 

func (c *Client) DisableAddress(ctx context.Context, addressID string) error

func (*Client) EnableAddress 

func (c *Client) EnableAddress(ctx context.Context, addressID string) error

func (*Client) GetAddress 

func (c *Client) GetAddress(ctx context.Context, addressID string) (Address, error)

func (*Client) GetAddresses 

func (c *Client) GetAddresses(ctx context.Context) ([]Address, error)

func (*Client) GetAllCalendarEvents 

func (c *Client) GetAllCalendarEvents(ctx context.Context, calendarID string, filter url.Values) ([]CalendarEvent, error)

func (*Client) GetAllContactEmails 

func (c *Client) GetAllContactEmails(ctx context.Context, email string) ([]ContactEmail, error)

func (*Client) GetAllContacts 

func (c *Client) GetAllContacts(ctx context.Context) ([]Contact, error)

func (*Client) GetAllMessageIDs 

func (c *Client) GetAllMessageIDs(ctx context.Context, afterID string) ([]string, error)

func (*Client) GetAttachment 

func (c *Client) GetAttachment(ctx context.Context, attachmentID string) ([]byte, error)

func (*Client) GetAttachmentInto 

func (c *Client) GetAttachmentInto(ctx context.Context, attachmentID string, reader io.ReaderFrom) error

func (*Client) GetBlock 

func (c *Client) GetBlock(ctx context.Context, bareURL, token string) (io.ReadCloser, error)

func (*Client) GetCalendar 

func (c *Client) GetCalendar(ctx context.Context, calendarID string) (Calendar, error)

func (*Client) GetCalendarEvent 

func (c *Client) GetCalendarEvent(ctx context.Context, calendarID, eventID string) (CalendarEvent, error)

func (*Client) GetCalendarEvents 

func (c *Client) GetCalendarEvents(ctx context.Context, calendarID string, page, pageSize int, filter url.Values) ([]CalendarEvent, error)

TODO: For now, the query params are partially constant -- should they be configurable?

func (*Client) GetCalendarKeys 

func (c *Client) GetCalendarKeys(ctx context.Context, calendarID string) (CalendarKeys, error)

func (*Client) GetCalendarMembers 

func (c *Client) GetCalendarMembers(ctx context.Context, calendarID string) ([]CalendarMember, error)

func (*Client) GetCalendarPassphrase 

func (c *Client) GetCalendarPassphrase(ctx context.Context, calendarID string) (CalendarPassphrase, error)

func (*Client) GetCalendars 

func (c *Client) GetCalendars(ctx context.Context) ([]Calendar, error)

func (*Client) GetContact 

func (c *Client) GetContact(ctx context.Context, contactID string) (Contact, error)

func (*Client) GetContactEmails 

func (c *Client) GetContactEmails(ctx context.Context, email string, page, pageSize int) ([]ContactEmail, error)

func (*Client) GetContacts 

func (c *Client) GetContacts(ctx context.Context, page, pageSize int) ([]Contact, error)

func (*Client) GetEvent 

func (c *Client) GetEvent(ctx context.Context, eventID string) ([]Event, bool, error)

func (*Client) GetFullMessage 

func (c *Client) GetFullMessage(ctx context.Context, messageID string, scheduler Scheduler, storageProvider AttachmentAllocator) (FullMessage, error)

func (*Client) GetGroupedMessageCount 

func (c *Client) GetGroupedMessageCount(ctx context.Context) ([]MessageGroupCount, error)

func (*Client) GetLabel 

func (c *Client) GetLabel(ctx context.Context, labelID string, labelTypes ...LabelType) (Label, error)

func (*Client) GetLabels 

func (c *Client) GetLabels(ctx context.Context, labelTypes ...LabelType) ([]Label, error)

func (*Client) GetLatestEventID 

func (c *Client) GetLatestEventID(ctx context.Context) (string, error)

func (*Client) GetLatestShareEventID 

func (c *Client) GetLatestShareEventID(ctx context.Context, shareID string) (string, error)

func (*Client) GetLatestVolumeEventID 

func (c *Client) GetLatestVolumeEventID(ctx context.Context, volumeID string) (string, error)
func (c *Client) GetLink(ctx context.Context, shareID, linkID string) (Link, error)

func (*Client) GetMailSettings 

func (c *Client) GetMailSettings(ctx context.Context) (MailSettings, error)

func (*Client) GetMessage 

func (c *Client) GetMessage(ctx context.Context, messageID string) (Message, error)

func (*Client) GetMessageIDs 

func (c *Client) GetMessageIDs(ctx context.Context, afterID string, limit int) ([]string, error)

func (*Client) GetMessageMetadata 

func (c *Client) GetMessageMetadata(ctx context.Context, filter MessageFilter) ([]MessageMetadata, error)

func (*Client) GetMessageMetadataPage 

func (c *Client) GetMessageMetadataPage(ctx context.Context, page, pageSize int, filter MessageFilter) ([]MessageMetadata, error)

func (*Client) GetPublicKeys 

func (c *Client) GetPublicKeys(ctx context.Context, address string) (PublicKeys, RecipientType, error)

func (*Client) GetRevision 

func (c *Client) GetRevision(ctx context.Context, shareID, linkID, revisionID string, fromBlock, pageSize int) (Revision, error)

func (*Client) GetSalts 

func (c *Client) GetSalts(ctx context.Context) (Salts, error)

func (*Client) GetShare 

func (c *Client) GetShare(ctx context.Context, shareID string) (Share, error)

func (*Client) GetShareEvent 

func (c *Client) GetShareEvent(ctx context.Context, shareID, eventID string) (DriveEvent, error)

func (*Client) GetUser 

func (c *Client) GetUser(ctx context.Context) (User, error)

func (*Client) GetUserSettings 

func (c *Client) GetUserSettings(ctx context.Context) (UserSettings, error)

func (*Client) GetVolume 

func (c *Client) GetVolume(ctx context.Context, volumeID string) (Volume, error)

func (*Client) GetVolumeEvent 

func (c *Client) GetVolumeEvent(ctx context.Context, volumeID, eventID string) (DriveEvent, error)

func (*Client) ImportMessages 

func (c *Client) ImportMessages(ctx context.Context, addrKR *crypto.KeyRing, workers, buffer int, req ...ImportReq) (stream.Stream[ImportRes], error)

func (*Client) LabelMessages 

func (c *Client) LabelMessages(ctx context.Context, messageIDs []string, labelID string) error

func (*Client) ListChildren 

func (c *Client) ListChildren(ctx context.Context, shareID, linkID string, showAll bool) ([]Link, error)

func (*Client) ListRevisions 

func (c *Client) ListRevisions(ctx context.Context, shareID, linkID string) ([]RevisionMetadata, error)

func (*Client) ListShares 

func (c *Client) ListShares(ctx context.Context, all bool) ([]ShareMetadata, error)

func (*Client) ListVolumes 

func (c *Client) ListVolumes(ctx context.Context) ([]Volume, error)

func (*Client) MakeAddressKeyPrimary 

func (c *Client) MakeAddressKeyPrimary(ctx context.Context, keyID string, keyList KeyList) error

func (*Client) MarkMessagesRead 

func (c *Client) MarkMessagesRead(ctx context.Context, messageIDs ...string) error

func (*Client) MarkMessagesUnread 

func (c *Client) MarkMessagesUnread(ctx context.Context, messageIDs ...string) error

func (*Client) NewEventStream 

func (c *Client) NewEventStream(ctx context.Context, period, jitter time.Duration, lastEventID string) <-chan Event

NewEventStreamer returns a new event stream. It polls the API for new events at random intervals between `period` and `period+jitter`.

Example 
m := proton.New()

ctx, cancel := context.WithCancel(context.Background())
defer cancel()

c, _, err := m.NewClientWithLogin(ctx, "...user...", []byte("...pass..."))
if err != nil {
	panic(err)
}
defer c.Close()

// Get the latest event ID.
fromEventID, err := c.GetLatestEventID(context.Background())
if err != nil {
	panic(err)
}

// Create a new event streamer.
for event := range c.NewEventStream(ctx, 20*time.Second, 20*time.Second, fromEventID) {
	fmt.Println(event.EventID)
}

Output:

func (*Client) OrderAddresses 

func (c *Client) OrderAddresses(ctx context.Context, req OrderAddressesReq) error

func (*Client) RemoveExpirationTime 

func (c *Client) RemoveExpirationTime(ctx context.Context, messageID string) error

func (*Client) RequestBlockUpload 

func (c *Client) RequestBlockUpload(ctx context.Context, req BlockUploadReq) ([]BlockUploadLink, error)

func (*Client) SendDataEvent 

func (c *Client) SendDataEvent(ctx context.Context, req SendStatsReq) error

func (*Client) SendDataEventMultiple 

func (c *Client) SendDataEventMultiple(ctx context.Context, req SendStatsMultiReq) error

func (*Client) SendDraft 

func (c *Client) SendDraft(ctx context.Context, draftID string, req SendDraftReq) (Message, error)

func (*Client) SetAttachPublicKey 

func (c *Client) SetAttachPublicKey(ctx context.Context, req SetAttachPublicKeyReq) (MailSettings, error)

func (*Client) SetDefaultPGPScheme 

func (c *Client) SetDefaultPGPScheme(ctx context.Context, req SetDefaultPGPSchemeReq) (MailSettings, error)

func (*Client) SetDisplayName 

func (c *Client) SetDisplayName(ctx context.Context, req SetDisplayNameReq) (MailSettings, error)

func (*Client) SetDraftMIMEType 

func (c *Client) SetDraftMIMEType(ctx context.Context, req SetDraftMIMETypeReq) (MailSettings, error)

func (*Client) SetSignExternalMessages 

func (c *Client) SetSignExternalMessages(ctx context.Context, req SetSignExternalMessagesReq) (MailSettings, error)

func (*Client) SetSignature 

func (c *Client) SetSignature(ctx context.Context, req SetSignatureReq) (MailSettings, error)

func (*Client) SetUserSettingsCrashReports 

func (c *Client) SetUserSettingsCrashReports(ctx context.Context, req SetCrashReportReq) (UserSettings, error)

func (*Client) SetUserSettingsTelemetry 

func (c *Client) SetUserSettingsTelemetry(ctx context.Context, req SetTelemetryReq) (UserSettings, error)

func (*Client) TrashChildren 

func (c *Client) TrashChildren(ctx context.Context, shareID, linkID string, childIDs ...string) error

func (*Client) UndoActions 

func (c *Client) UndoActions(ctx context.Context, tokens ...UndoToken) ([]UndoRes, error)

func (*Client) UnlabelMessages 

func (c *Client) UnlabelMessages(ctx context.Context, messageIDs []string, labelID string) error

func (*Client) UpdateContact 

func (c *Client) UpdateContact(ctx context.Context, contactID string, req UpdateContactReq) (Contact, error)

func (*Client) UpdateDraft 

func (c *Client) UpdateDraft(ctx context.Context, draftID string, addrKR *crypto.KeyRing, req UpdateDraftReq) (Message, error)

func (*Client) UpdateLabel 

func (c *Client) UpdateLabel(ctx context.Context, labelID string, req UpdateLabelReq) (Label, error)

func (*Client) UpdateRevision 

func (c *Client) UpdateRevision(ctx context.Context, shareID, linkID, revisionID string, req UpdateRevisionReq) error

func (*Client) UploadAttachment 

func (c *Client) UploadAttachment(ctx context.Context, addrKR *crypto.KeyRing, req CreateAttachmentReq) (Attachment, error)

func (*Client) UploadBlock 

func (c *Client) UploadBlock(ctx context.Context, bareURL, token string, block io.Reader) error

type ClientType 

type ClientType int
const (
	ClientTypeEmail ClientType = iota + 1
	ClientTypeVPN
	ClientTypeCalendar
	ClientTypeDrive
)

type Code 

type Code int
const (
	SuccessCode               Code = 1000
	MultiCode                 Code = 1001
	InvalidValue              Code = 2001
	AppVersionMissingCode     Code = 5001
	AppVersionBadCode         Code = 5003
	UsernameInvalid           Code = 6003 // Deprecated, but still used.
	PasswordWrong             Code = 8002
	HumanVerificationRequired Code = 9001
	PaidPlanRequired          Code = 10004
	AuthRefreshTokenInvalid   Code = 10013
)

type Contact 

type Contact struct {
	ContactMetadata
	ContactCards
}

func (*Contact) GetSettings 

func (c *Contact) GetSettings(kr *crypto.KeyRing, email string) (ContactSettings, error)

type ContactCards 

type ContactCards struct {
	Cards Cards
}

type ContactEmail 

type ContactEmail struct {
	ID        string
	Name      string
	Email     string
	Type      []string
	ContactID string
	LabelIDs  []string
}

type ContactMetadata 

type ContactMetadata struct {
	ID            string
	Name          string
	UID           string
	Size          int64
	CreateTime    int64
	ModifyTime    int64
	ContactEmails []ContactEmail
	LabelIDs      []string
}

type ContactSettings 

type ContactSettings struct {
	MIMEType *rfc822.MIMEType
	Scheme   *EncryptionScheme
	Sign     *bool
	Encrypt  *bool
	Keys     []*crypto.Key
}

type CreateAddressKeyReq 

type CreateAddressKeyReq struct {
	AddressID     string
	PrivateKey    string
	Primary       Bool
	SignedKeyList KeyList

	// The following are only used in "migrated accounts"
	Token     string `json:",omitempty"`
	Signature string `json:",omitempty"`
}

type CreateAttachmentReq 

type CreateAttachmentReq struct {
	MessageID string

	Filename    string
	MIMEType    rfc822.MIMEType
	Disposition Disposition
	ContentID   string

	Body []byte
}

type CreateContactsReq 

type CreateContactsReq struct {
	Contacts  []ContactCards
	Overwrite int
	Labels    int
}

type CreateContactsRes 

type CreateContactsRes struct {
	Index int

	Response struct {
		APIError
		Contact Contact
	}
}

type CreateDraftAction 

type CreateDraftAction int
const (
	ReplyAction CreateDraftAction = iota
	ReplyAllAction
	ForwardAction
	AutoResponseAction
	ReadReceiptAction
)

type CreateDraftReq 

type CreateDraftReq struct {
	Message              DraftTemplate
	AttachmentKeyPackets []string

	ParentID string `json:",omitempty"`
	Action   CreateDraftAction
}

type CreateFileReq 

type CreateFileReq struct {
	ParentLinkID string

	Name     string // Encrypted File Name
	Hash     string // Encrypted content hash
	MIMEType string // MIME Type

	ContentKeyPacket          string // The block's key packet, encrypted with the node key.
	ContentKeyPacketSignature string // Unencrypted signature of the content session key, signed with the NodeKey

	NodeKey                 string // The private NodeKey, used to decrypt any file/folder content.
	NodePassphrase          string // The passphrase used to unlock the NodeKey, encrypted by the owning Link/Share keyring.
	NodePassphraseSignature string // The signature of the NodePassphrase

	SignatureAddress string // Signature email address used to sign passphrase and name
}

type CreateFileRes 

type CreateFileRes struct {
	ID         string // Encrypted Link ID
	RevisionID string // Encrypted Revision ID
}

type CreateFolderReq 

type CreateFolderReq struct {
	ParentLinkID string

	Name string
	Hash string

	NodeKey     string
	NodeHashKey string

	NodePassphrase          string
	NodePassphraseSignature string

	SignatureAddress string
}

type CreateFolderRes 

type CreateFolderRes struct {
	ID string // Encrypted Link ID
}

type CreateLabelReq 

type CreateLabelReq struct {
	Name  string
	Color string
	Type  LabelType

	ParentID string `json:",omitempty"`
}

type CreateUserReq 

type CreateUserReq struct {
	Type     UserType
	Username string
	Domain   string
	Auth     AuthVerifier
}

type DefaultAttachmentAllocator 

type DefaultAttachmentAllocator struct{}

func NewDefaultAttachmentAllocator 

func NewDefaultAttachmentAllocator() *DefaultAttachmentAllocator

func (DefaultAttachmentAllocator) NewBuffer 

func (DefaultAttachmentAllocator) NewBuffer() *bytes.Buffer

type DeleteContactsReq 

type DeleteContactsReq struct {
	IDs []string
}

type DeleteUserReq 

type DeleteUserReq struct {
	Reason   string
	Feedback string
	Email    string
}

type Disposition 

type Disposition string
const (
	InlineDisposition     Disposition = "inline"
	AttachmentDisposition Disposition = "attachment"
)

type DraftTemplate 

type DraftTemplate struct {
	Subject  string
	Sender   *mail.Address
	ToList   []*mail.Address
	CCList   []*mail.Address
	BCCList  []*mail.Address
	Body     string
	MIMEType rfc822.MIMEType
	Unread   Bool

	ExternalID string `json:",omitempty"`
}

type DriveEvent 

type DriveEvent struct {
	EventID string

	Events []LinkEvent

	Refresh Bool
}

type EncryptionScheme 

type EncryptionScheme int
const (
	InternalScheme EncryptionScheme = 1 << iota
	EncryptedOutsideScheme
	ClearScheme
	PGPInlineScheme
	PGPMIMEScheme
	ClearMIMEScheme
)

type Event 

type Event struct {
	EventID string

	Refresh RefreshFlag

	User *User

	UserSettings *UserSettings

	MailSettings *MailSettings

	Messages []MessageEvent

	Labels []LabelEvent

	Addresses []AddressEvent

	UsedSpace *int
}

func (Event) String 

func (event Event) String() string

type EventAction 

type EventAction int
const (
	EventDelete EventAction = iota
	EventCreate
	EventUpdate
	EventUpdateFlags
)

type EventItem 

type EventItem struct {
	ID     string
	Action EventAction
}

type FIDO2Info 

type FIDO2Info struct {
	AuthenticationOptions any
	RegisteredKeys        []RegisteredKey
}

type FIDO2Req 

type FIDO2Req struct {
	AuthenticationOptions any
	ClientData            string
	AuthenticatorData     string
	Signature             string
	CredentialID          string
}

type FileProperties 

type FileProperties struct {
	ContentKeyPacket          string           // The block's key packet, encrypted with the node key.
	ContentKeyPacketSignature string           // Signature of the content key packet. Signature of the session key, signed with the NodeKey.
	ActiveRevision            RevisionMetadata // The active revision of the file.
}

type FolderProperties 

type FolderProperties struct {
	NodeHashKey string // HMAC key used to hash the folder's children names.
}

type FullMessage 

type FullMessage struct {
	Message

	AttData [][]byte
}

type Future 

type Future[T any] struct {
	// contains filtered or unexported fields
}

func NewFuture 

func NewFuture[T any](panicHandler async.PanicHandler, fn func() (T, error)) *Future[T]

func (*Future[T]) Get 

func (job *Future[T]) Get() (T, error)

func (*Future[T]) Then 

func (job *Future[T]) Then(fn func(T, error))

type Group 

type Group[T any] struct {
	// contains filtered or unexported fields
}

func NewGroup 

func NewGroup[T any](panicHandler async.PanicHandler) *Group[T]

func (*Group[T]) Add 

func (group *Group[T]) Add(fn func() (T, error))

func (*Group[T]) ForEach 

func (group *Group[T]) ForEach(fn func(T) error) error

func (*Group[T]) Result 

func (group *Group[T]) Result() ([]T, error)

type Handler 

type Handler func()

Handler is a generic function that can be registered for a certain event (e.g. deauth, API code).

type Headers 

type Headers map[string][]string

func (*Headers) UnmarshalJSON 

func (h *Headers) UnmarshalJSON(b []byte) error

type ImportMetadata 

type ImportMetadata struct {
	AddressID string
	LabelIDs  []string
	Unread    Bool
	Flags     MessageFlag
}

type ImportReq 

type ImportReq struct {
	Metadata ImportMetadata
	Message  []byte
}

type ImportRes 

type ImportRes struct {
	APIError
	MessageID string
}

type Key 

type Key struct {
	ID         string
	PrivateKey []byte
	Token      string
	Signature  string
	Primary    Bool
	Active     Bool
	Flags      KeyState
}

func (Key) MarshalJSON 

func (key Key) MarshalJSON() ([]byte, error)

func (Key) Unlock 

func (key Key) Unlock(passphrase []byte, userKR *crypto.KeyRing) (*crypto.Key, error)

func (*Key) UnmarshalJSON 

func (key *Key) UnmarshalJSON(data []byte) error

type KeyList 

type KeyList struct {
	Data      string
	Signature string
}

func NewKeyList 

func NewKeyList(signer *crypto.KeyRing, entries []KeyListEntry) (KeyList, error)

type KeyListEntry 

type KeyListEntry struct {
	Fingerprint        string
	SHA256Fingerprints []string
	Flags              KeyState
	Primary            Bool
}

type KeyState 

type KeyState int
const (
	KeyStateTrusted KeyState = 1 << iota // 2^0 = 1 means the key is not compromised (i.e. if we can trust signatures coming from it)
	KeyStateActive                       // 2^1 = 2 means the key is still in use (i.e. not obsolete, we can encrypt messages to it)
)

type Keys 

type Keys []Key

func (Keys) ByID 

func (keys Keys) ByID(keyID string) Key

func (Keys) Primary 

func (keys Keys) Primary() Key

func (Keys) TryUnlock 

func (keys Keys) TryUnlock(passphrase []byte, userKR *crypto.KeyRing) *crypto.KeyRing

func (Keys) Unlock 

func (keys Keys) Unlock(passphrase []byte, userKR *crypto.KeyRing) (*crypto.KeyRing, error)

type Label 

type Label struct {
	ID       string
	ParentID string

	Name  string
	Path  []string
	Color string
	Type  LabelType
}

func (Label) MarshalJSON 

func (label Label) MarshalJSON() ([]byte, error)

func (*Label) UnmarshalJSON 

func (label *Label) UnmarshalJSON(data []byte) error

type LabelEvent 

type LabelEvent struct {
	EventItem

	Label Label
}

type LabelMessageRes 

type LabelMessageRes struct {
	ID       string
	Response APIError
}

type LabelMessagesReq 

type LabelMessagesReq struct {
	LabelID string
	IDs     []string
}

type LabelMessagesRes 

type LabelMessagesRes struct {
	Responses []LabelMessageRes
	UndoToken UndoToken
}

type LabelType 

type LabelType int
const (
	LabelTypeLabel LabelType = iota + 1
	LabelTypeContactGroup
	LabelTypeFolder
	LabelTypeSystem
)
type Link struct {
	LinkID       string // Encrypted file/folder ID
	ParentLinkID string // Encrypted parent folder ID (LinkID). Root link has null ParentLinkID.

	Type     LinkType
	Name     string // Encrypted file name
	Hash     string // HMAC of name encrypted with parent hash key
	Size     int64
	State    LinkState
	MIMEType string

	CreateTime     int64 // Link creation time
	ModifyTime     int64 // Link modification time (on API, real modify date is stored in XAttr)
	ExpirationTime int64 // Link expiration time

	NodeKey                 string // The private NodeKey, used to decrypt any file/folder content.
	NodePassphrase          string // The passphrase used to unlock the NodeKey, encrypted by the owning Link/Share keyring.
	NodePassphraseSignature string

	FileProperties   *FileProperties
	FolderProperties *FolderProperties
}

Link holds the tree structure, for the clients, they represent the files and folders of a given volume. They have a ParentLinkID that points to parent folders. Links also hold the file name (encrypted) and a hash of the name for name collisions. Link data is encrypted with its owning Share keyring.

func (Link) GetHashKey 

func (l Link) GetHashKey(nodeKR *crypto.KeyRing) ([]byte, error)

func (Link) GetKeyRing 

func (l Link) GetKeyRing(parentNodeKR, addrKR *crypto.KeyRing) (*crypto.KeyRing, error)

func (Link) GetName 

func (l Link) GetName(parentNodeKR, addrKR *crypto.KeyRing) (string, error)

func (Link) GetSessionKey 

func (l Link) GetSessionKey(nodeKR *crypto.KeyRing) (*crypto.SessionKey, error)

type LinkEvent 

type LinkEvent struct {
	EventID string

	EventType LinkEventType

	CreateTime int

	Link Link

	Data any
}

type LinkEventType 

type LinkEventType int
const (
	LinkEventDelete LinkEventType = iota
	LinkEventCreate
	LinkEventUpdate
	LinkEventUpdateMetadata
)

type LinkState 

type LinkState int
const (
	LinkStateDraft LinkState = iota
	LinkStateActive
	LinkStateTrashed
	LinkStateDeleted
	LinkStateRestoring
)

type LinkType 

type LinkType int
const (
	LinkTypeFolder LinkType = iota + 1
	LinkTypeFile
)

type LinkWalkFunc 

type LinkWalkFunc func([]string, Link, *crypto.KeyRing) error

type Listener 

type Listener struct {
	net.Listener
	// contains filtered or unexported fields
}

Listener wraps a net.Listener. It can be configured to spawn connections that drop all reads or writes.

func NewListener 

func NewListener(l net.Listener, newConn func(net.Conn, *Listener) net.Conn) *Listener

NewListener returns a new DropListener.

func (*Listener) Accept 

func (l *Listener) Accept() (net.Conn, error)

func (*Listener) Close 

func (l *Listener) Close() error

Close closes the listener.

func (*Listener) Done 

func (l *Listener) Done() <-chan struct{}

Done returns a channel that is closed when the listener is closed.

func (*Listener) DropAll 

func (l *Listener) DropAll()

DropAll closes all connections spawned by this listener.

func (*Listener) SetCanRead 

func (l *Listener) SetCanRead(canRead bool)

SetCanRead sets whether the connections spawned by this listener can read.

func (*Listener) SetCanWrite 

func (l *Listener) SetCanWrite(canWrite bool)

SetCanWrite sets whether the connections spawned by this listener can write.

type MailSettings 

type MailSettings struct {
	DisplayName     string
	Signature       string
	DraftMIMEType   rfc822.MIMEType
	AttachPublicKey Bool
	Sign            SignExternalMessages
	PGPScheme       EncryptionScheme
}

type MakeAddressKeyPrimaryReq 

type MakeAddressKeyPrimaryReq struct {
	SignedKeyList KeyList
}

type Manager 

type Manager struct {
	// contains filtered or unexported fields
}

func New 

func New(opts ...Option) *Manager

func (*Manager) AddErrorHandler 

func (m *Manager) AddErrorHandler(code Code, handler Handler)

func (*Manager) AddPostRequestHook 

func (m *Manager) AddPostRequestHook(hook resty.ResponseMiddleware)

func (*Manager) AddPreRequestHook 

func (m *Manager) AddPreRequestHook(hook resty.RequestMiddleware)

func (*Manager) AddStatusObserver 

func (m *Manager) AddStatusObserver(observer StatusObserver)

func (*Manager) AuthInfo 

func (m *Manager) AuthInfo(ctx context.Context, req AuthInfoReq) (AuthInfo, error)

func (*Manager) AuthModulus 

func (m *Manager) AuthModulus(ctx context.Context) (AuthModulus, error)

func (*Manager) Close 

func (m *Manager) Close()

func (*Manager) CreateUser 

func (m *Manager) CreateUser(ctx context.Context, req CreateUserReq) (User, error)

func (*Manager) DownloadAndVerify 

func (m *Manager) DownloadAndVerify(ctx context.Context, kr *crypto.KeyRing, url, sig string) ([]byte, error)

func (*Manager) GetCaptcha 

func (m *Manager) GetCaptcha(ctx context.Context, token string) ([]byte, error)

func (*Manager) GetDomains 

func (m *Manager) GetDomains(ctx context.Context) ([]string, error)

func (*Manager) GetUsernameAvailable 

func (m *Manager) GetUsernameAvailable(ctx context.Context, username string) error

func (*Manager) NewClient 

func (m *Manager) NewClient(uid, acc, ref string) *Client
Example 
// Create a new manager.
m := proton.New()

// If auth information is already known, it can be used to create a client straight away.
c := m.NewClient("...uid...", "...acc...", "...ref...")
defer c.Close()

// All API operations must be run within a context.
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

// Do something with the client.
if _, err := c.GetUser(ctx); err != nil {
	panic(err)
}

Output:

func (*Manager) NewClientWithLogin 

func (m *Manager) NewClientWithLogin(ctx context.Context, username string, password []byte) (*Client, Auth, error)
Example 
// Create a new manager.
m := proton.New()

// All API operations must be run within a context.
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

// Clients are created via username/password if auth information isn't already known.
c, auth, err := m.NewClientWithLogin(ctx, "...user...", []byte("...pass..."))
if err != nil {
	panic(err)
}
defer c.Close()

// If 2FA is necessary, an additional request is required.
if auth.TwoFA.Enabled&proton.HasTOTP != 0 {
	if err := c.Auth2FA(ctx, proton.Auth2FAReq{TwoFactorCode: "...TOTP..."}); err != nil {
		panic(err)
	}
}

// Do something with the client.
if _, err := c.GetUser(ctx); err != nil {
	panic(err)
}

Output:

func (*Manager) NewClientWithRefresh 

func (m *Manager) NewClientWithRefresh(ctx context.Context, uid, ref string) (*Client, Auth, error)
Example 
// Create a new manager.
m := proton.New()

// All API operations must be run within a context.
ctx, cancel := context.WithCancel(context.Background())
defer cancel()

// If UID/RefreshToken is already known, it can be used to create a new client straight away.
c, _, err := m.NewClientWithRefresh(ctx, "...uid...", "...ref...")
if err != nil {
	panic(err)
}
defer c.Close()

// Do something with the client.
if _, err := c.GetUser(ctx); err != nil {
	panic(err)
}

Output:

func (*Manager) Ping 

func (m *Manager) Ping(ctx context.Context) error

func (*Manager) Quark 

func (m *Manager) Quark(ctx context.Context, command string, args ...string) error

Quark runs a quark command.

func (*Manager) QuarkRes 

func (m *Manager) QuarkRes(ctx context.Context, command string, args ...string) ([]byte, error)

QuarkRes is the same as Quark, but returns the content extracted from the response body.

func (*Manager) ReportBug 

func (m *Manager) ReportBug(ctx context.Context, req ReportBugReq, atts ...ReportBugAttachment) error

func (*Manager) SendVerificationCode 

func (m *Manager) SendVerificationCode(ctx context.Context, req SendVerificationCodeReq) error

type MemberPassphrase 

type MemberPassphrase struct {
	MemberID   string
	Passphrase string
	Signature  string
}

type Message 

type Message struct {
	MessageMetadata

	Header        string
	ParsedHeaders Headers
	Body          string
	MIMEType      rfc822.MIMEType
	Attachments   []Attachment
}

func (Message) Decrypt 

func (m Message) Decrypt(kr *crypto.KeyRing) ([]byte, error)

func (Message) DecryptInto 

func (m Message) DecryptInto(kr *crypto.KeyRing, buffer io.ReaderFrom) error

type MessageActionReq 

type MessageActionReq struct {
	IDs []string
}

type MessageEvent 

type MessageEvent struct {
	EventItem

	Message MessageMetadata
}

type MessageExpireActionReq 

type MessageExpireActionReq struct {
	IDs            []string
	ExpirationTime *int64
}

type MessageFilter 

type MessageFilter struct {
	ID []string `json:",omitempty"`

	Subject    string `json:",omitempty"`
	AddressID  string `json:",omitempty"`
	ExternalID string `json:",omitempty"`
	LabelID    string `json:",omitempty"`
	EndID      string `json:",omitempty"`
	Desc       Bool
}

type MessageFlag 

type MessageFlag int64
const (
	MessageFlagReceived    MessageFlag = 1 << 0
	MessageFlagSent        MessageFlag = 1 << 1
	MessageFlagInternal    MessageFlag = 1 << 2
	MessageFlagE2E         MessageFlag = 1 << 3
	MessageFlagAuto        MessageFlag = 1 << 4
	MessageFlagReplied     MessageFlag = 1 << 5
	MessageFlagRepliedAll  MessageFlag = 1 << 6
	MessageFlagForwarded   MessageFlag = 1 << 7
	MessageFlagAutoReplied MessageFlag = 1 << 8
	MessageFlagImported    MessageFlag = 1 << 9
	MessageFlagOpened      MessageFlag = 1 << 10
	MessageFlagReceiptSent MessageFlag = 1 << 11
	MessageFlagNotified    MessageFlag = 1 << 12
	MessageFlagTouched     MessageFlag = 1 << 13
	MessageFlagReceipt     MessageFlag = 1 << 14

	MessageFlagReceiptRequest MessageFlag = 1 << 16
	MessageFlagPublicKey      MessageFlag = 1 << 17
	MessageFlagSign           MessageFlag = 1 << 18
	MessageFlagUnsubscribed   MessageFlag = 1 << 19
	MessageFlagScheduledSend  MessageFlag = 1 << 20
	MessageFlagAlias          MessageFlag = 1 << 21

	MessageFlagDMARCPass      MessageFlag = 1 << 23
	MessageFlagSPFFail        MessageFlag = 1 << 24
	MessageFlagDKIMFail       MessageFlag = 1 << 25
	MessageFlagDMARCFail      MessageFlag = 1 << 26
	MessageFlagHamManual      MessageFlag = 1 << 27
	MessageFlagSpamAuto       MessageFlag = 1 << 28
	MessageFlagSpamManual     MessageFlag = 1 << 29
	MessageFlagPhishingAuto   MessageFlag = 1 << 30
	MessageFlagPhishingManual MessageFlag = 1 << 31
)

func (MessageFlag) Add 

func (f MessageFlag) Add(flag MessageFlag) MessageFlag

func (MessageFlag) Has 

func (f MessageFlag) Has(flag MessageFlag) bool

func (MessageFlag) HasAll 

func (f MessageFlag) HasAll(flags ...MessageFlag) bool

func (MessageFlag) HasAny 

func (f MessageFlag) HasAny(flags ...MessageFlag) bool

func (MessageFlag) Matches 

func (f MessageFlag) Matches(flag MessageFlag) bool

func (MessageFlag) Remove 

func (f MessageFlag) Remove(flag MessageFlag) MessageFlag

func (MessageFlag) Toggle 

func (f MessageFlag) Toggle(flag MessageFlag) MessageFlag

type MessageGroupCount 

type MessageGroupCount struct {
	LabelID string
	Total   int
	Unread  int
}

type MessageMetadata 

type MessageMetadata struct {
	ID         string
	AddressID  string
	LabelIDs   []string
	ExternalID string

	Subject  string
	Sender   *mail.Address
	ToList   []*mail.Address
	CCList   []*mail.Address
	BCCList  []*mail.Address
	ReplyTos []*mail.Address

	Flags          MessageFlag
	Time           int64
	ExpirationTime *int64
	Size           int
	Unread         Bool
	IsReplied      Bool
	IsRepliedAll   Bool
	IsForwarded    Bool

	NumAttachments int
}

func (MessageMetadata) IsDraft 

func (meta MessageMetadata) IsDraft() bool

func (MessageMetadata) Seen 

func (meta MessageMetadata) Seen() bool

func (MessageMetadata) Starred 

func (meta MessageMetadata) Starred() bool

type MessagePackage 

type MessagePackage struct {
	Addresses map[string]*MessageRecipient
	MIMEType  rfc822.MIMEType
	Type      EncryptionScheme
	Body      string

	BodyKey        *SessionKey            `json:",omitempty"`
	AttachmentKeys map[string]*SessionKey `json:",omitempty"`
}

type MessageRecipient 

type MessageRecipient struct {
	Type      EncryptionScheme
	Signature SignatureType

	BodyKeyPacket        string            `json:",omitempty"`
	AttachmentKeyPackets map[string]string `json:",omitempty"`
}

type NetCtl 

type NetCtl struct {
	// contains filtered or unexported fields
}

ctl can be used to control whether a dialer can dial, and whether the resulting connection can read or write.

func NewNetCtl 

func NewNetCtl() *NetCtl

NewNetCtl returns a new ctl with all fields set to true.

func (*NetCtl) Disable 

func (c *NetCtl) Disable()

Disable is equivalent to disallowing dial, read and write.

func (*NetCtl) Enable 

func (c *NetCtl) Enable()

Enable is equivalent to allowing dial, read and write.

func (*NetCtl) NewRoundTripper 

func (c *NetCtl) NewRoundTripper(tlsConfig *tls.Config) http.RoundTripper

NewDialer returns a new dialer controlled by the ctl.

func (*NetCtl) OnDial 

func (c *NetCtl) OnDial(f func(net.Conn))

OnDial adds a callback that is called with the created connection when a dial is successful.

func (*NetCtl) OnRead 

func (c *NetCtl) OnRead(fn func([]byte))

OnRead adds a callback that is called with the read bytes when a read is successful.

func (*NetCtl) OnWrite 

func (c *NetCtl) OnWrite(fn func([]byte))

OnWrite adds a callback that is called with the written bytes when a write is successful.

func (*NetCtl) SetCanDial 

func (c *NetCtl) SetCanDial(canDial bool)

SetCanDial sets whether the dialer can dial.

func (*NetCtl) SetCanRead 

func (c *NetCtl) SetCanRead(canRead bool)

SetCanRead sets whether the connection can read.

func (*NetCtl) SetCanWrite 

func (c *NetCtl) SetCanWrite(canWrite bool)

SetCanWrite sets whether the connection can write.

func (*NetCtl) SetDialLimit 

func (c *NetCtl) SetDialLimit(limit uint64)

SetDialLimit sets the maximum number of times dialers using this controller can dial.

func (*NetCtl) SetReadLimit 

func (c *NetCtl) SetReadLimit(limit uint64)

SetReadLimit sets the maximum number of bytes that can be read.

func (*NetCtl) SetReadSpeed 

func (c *NetCtl) SetReadSpeed(speed int)

SetReadSpeed sets the maximum number of bytes that can be read per second.

func (*NetCtl) SetWriteLimit 

func (c *NetCtl) SetWriteLimit(limit uint64)

SetWriteLimit sets the maximum number of bytes that can be written.

func (*NetCtl) SetWriteSpeed 

func (c *NetCtl) SetWriteSpeed(speed int)

SetWriteSpeed sets the maximum number of bytes that can be written per second.

type NetError 

type NetError struct {
	// Cause is the underlying error that caused the network error.
	Cause error

	// Message is an additional message that describes the network error.
	Message string
}

NetError represents a network error. It is returned when the API is unreachable.

func (*NetError) Error 

func (err *NetError) Error() string

func (*NetError) Is 

func (err *NetError) Is(target error) bool

func (*NetError) Unwrap 

func (err *NetError) Unwrap() error

type Option 

type Option interface {
	// contains filtered or unexported methods
}

Option represents a type that can be used to configure the manager.

func WithAppVersion 

func WithAppVersion(appVersion string) Option

func WithCookieJar 

func WithCookieJar(jar http.CookieJar) Option

func WithDebug 

func WithDebug(debug bool) Option

func WithHostURL 

func WithHostURL(hostURL string) Option

func WithLogger 

func WithLogger(logger resty.Logger) Option

func WithPanicHandler 

func WithPanicHandler(panicHandler async.PanicHandler) Option

func WithRetryCount 

func WithRetryCount(retryCount int) Option

func WithSkipVerifyProofs 

func WithSkipVerifyProofs() Option

func WithTransport 

func WithTransport(transport http.RoundTripper) Option

type OrderAddressesReq 

type OrderAddressesReq struct {
	AddressIDs []string
}

type ParallelScheduler 

type ParallelScheduler struct {
	// contains filtered or unexported fields
}

func NewParallelScheduler 

func NewParallelScheduler(workers int, panicHandler async.PanicHandler) *ParallelScheduler

func (ParallelScheduler) Schedule 

func (p ParallelScheduler) Schedule(ctx context.Context, attachmentIDs []string, storageProvider AttachmentAllocator, downloader func(context.Context, string, *bytes.Buffer) error) ([]*bytes.Buffer, error)

type PasswordMode 

type PasswordMode int
const (
	OnePasswordMode PasswordMode = iota + 1
	TwoPasswordMode
)

type Pool 

type Pool[In comparable, Out any] struct {
	// contains filtered or unexported fields
}

Pool is a worker pool that handles input of type In and returns results of type Out.

func NewPool 

func NewPool[In comparable, Out any](size int, panicHandler async.PanicHandler, work func(context.Context, In) (Out, error)) *Pool[In, Out]

New returns a new pool.

func (*Pool[In, Out]) Done 

func (pool *Pool[In, Out]) Done()

func (*Pool[In, Out]) NewJob 

func (pool *Pool[In, Out]) NewJob(ctx context.Context, req In) (*job[In, Out], doneFunc, error)

NewJob submits a job to the pool. It returns a job handle and a DoneFunc. The job handle allows the job result to be obtained. The DoneFunc is used to mark the job as done, which frees up the worker in the pool for reuse.

func (*Pool[In, Out]) Process 

func (pool *Pool[In, Out]) Process(ctx context.Context, reqs []In, fn func(int, In, Out, error) error) error

Process submits jobs to the pool. The callback provides access to the result, or an error if one occurred.

func (*Pool[In, Out]) ProcessAll 

func (pool *Pool[In, Out]) ProcessAll(ctx context.Context, reqs []In) ([]Out, error)

ProcessAll submits jobs to the pool. All results are returned once available.

func (*Pool[In, Out]) ProcessOne 

func (pool *Pool[In, Out]) ProcessOne(ctx context.Context, req In) (Out, error)

ProcessOne submits one job to the pool and returns the result.

type PublicKey 

type PublicKey struct {
	Flags     KeyState
	PublicKey string
}

type PublicKeys 

type PublicKeys []PublicKey

func (PublicKeys) GetKeyRing 

func (keys PublicKeys) GetKeyRing() (*crypto.KeyRing, error)

type RecipientType 

type RecipientType int
const (
	RecipientTypeInternal RecipientType = iota + 1
	RecipientTypeExternal
)

type RefreshFlag 

type RefreshFlag uint8
const (
	RefreshMail RefreshFlag = 1 << iota // 1<<0 = 1

	RefreshAll RefreshFlag = 1<<iota - 1 // 1<<8 - 1 = 255
)

type RegisteredKey 

type RegisteredKey struct {
	AttestationFormat string
	CredentialID      []int
	Name              string
}

type ReportBugAttachment 

type ReportBugAttachment struct {
	Name     string
	Filename string
	MIMEType rfc822.MIMEType
	Body     []byte
}

type ReportBugReq 

type ReportBugReq struct {
	OS        string
	OSVersion string

	Browser           string
	BrowserVersion    string
	BrowserExtensions string

	Resolution  string
	DisplayMode string

	Client        string
	ClientVersion string
	ClientType    ClientType

	Title       string
	Description string

	Username string
	Email    string

	Country string
	ISP     string
}

type Revision 

type Revision struct {
	RevisionMetadata

	Blocks []Block
}

Revisions are only for files, they represent “versions” of files. Each file can have 1 active revision and n obsolete revisions.

type RevisionMetadata 

type RevisionMetadata struct {
	ID                string        // Encrypted Revision ID
	CreateTime        int64         // Unix timestamp of the revision creation time
	Size              int64         // Size of the revision in bytes
	ManifestSignature string        // Signature of the revision manifest, signed with user's address key of the share.
	SignatureEmail    string        // Email of the user that signed the revision.
	State             RevisionState // State of revision
	Thumbnail         Bool          // Whether the revision has a thumbnail
	ThumbnailHash     string        // Hash of the thumbnail
}

type RevisionState 

type RevisionState int
const (
	RevisionStateDraft RevisionState = iota
	RevisionStateActive
	RevisionStateObsolete
	RevisionStateDeleted
)

type Salt 

type Salt struct {
	ID, KeySalt string
}

type Salts 

type Salts []Salt

func (Salts) SaltForKey 

func (salts Salts) SaltForKey(keyPass []byte, keyID string) ([]byte, error)

type Scheduler 

type Scheduler interface {
	Schedule(ctx context.Context, attachmentIDs []string, storageProvider AttachmentAllocator, downloader func(context.Context, string, *bytes.Buffer) error) ([]*bytes.Buffer, error)
}

Scheduler allows the user to specify how the attachment data for the message should be downloaded.

type SendDraftReq 

type SendDraftReq struct {
	Packages []*MessagePackage
}

func (*SendDraftReq) AddMIMEPackage 

func (req *SendDraftReq) AddMIMEPackage(
	kr *crypto.KeyRing,
	mimeBody string,
	prefs map[string]SendPreferences,
) error

func (*SendDraftReq) AddTextPackage 

func (req *SendDraftReq) AddTextPackage(
	kr *crypto.KeyRing,
	body string,
	mimeType rfc822.MIMEType,
	prefs map[string]SendPreferences,
	attKeys map[string]*crypto.SessionKey,
) error

type SendPreferences 

type SendPreferences struct {
	// Encrypt indicates whether the email should be encrypted or not.
	// If it's encrypted, we need to know which public key to use.
	Encrypt bool

	// PubKey contains an OpenPGP key that can be used for encryption.
	PubKey *crypto.KeyRing

	// SignatureType indicates how the email should be signed.
	SignatureType SignatureType

	// EncryptionScheme indicates if we should encrypt body and attachments separately and
	// what MIME format to give the final encrypted email. The two standard PGP
	// schemes are PGP/MIME and PGP/Inline. However we use a custom scheme for
	// internal emails (including the so-called encrypted-to-outside emails,
	// which even though meant for external users, they don't really get out of
	// our platform). If the email is sent unencrypted, no PGP scheme is needed.
	EncryptionScheme EncryptionScheme

	// MIMEType is the MIME type to use for formatting the body of the email
	// (before encryption/after decryption). The standard possibilities are the
	// enriched HTML format, text/html, and plain text, text/plain. But it's
	// also possible to have a multipart/mixed format, which is typically used
	// for PGP/MIME encrypted emails, where attachments go into the body too.
	// Because of this, this option is sometimes called MIME format.
	MIMEType rfc822.MIMEType
}

type SendStatsMultiReq 

type SendStatsMultiReq struct {
	EventInfo []SendStatsReq
}

type SendStatsReq 

type SendStatsReq struct {
	MeasurementGroup string
	Event            string
	Values           map[string]any
	Dimensions       map[string]any
}

type SendVerificationCodeReq 

type SendVerificationCodeReq struct {
	Username    string
	Type        TokenType
	Destination TokenDestination
}

type SequentialScheduler 

type SequentialScheduler struct{}

SequentialScheduler downloads the attachments one by one.

func NewSequentialScheduler 

func NewSequentialScheduler() *SequentialScheduler

func (SequentialScheduler) Schedule 

func (SequentialScheduler) Schedule(ctx context.Context, attachmentIDs []string, storageProvider AttachmentAllocator, downloader func(context.Context, string, *bytes.Buffer) error) ([]*bytes.Buffer, error)

type SessionKey 

type SessionKey struct {
	Key       string
	Algorithm string
}

type SetAttachPublicKeyReq 

type SetAttachPublicKeyReq struct {
	AttachPublicKey Bool
}

type SetCrashReportReq 

type SetCrashReportReq struct {
	CrashReports SettingsBool
}

type SetDefaultPGPSchemeReq 

type SetDefaultPGPSchemeReq struct {
	PGPScheme EncryptionScheme
}

type SetDisplayNameReq 

type SetDisplayNameReq struct {
	DisplayName string
}

type SetDraftMIMETypeReq 

type SetDraftMIMETypeReq struct {
	MIMEType rfc822.MIMEType
}

type SetSignExternalMessagesReq 

type SetSignExternalMessagesReq struct {
	Sign SignExternalMessages
}

type SetSignatureReq 

type SetSignatureReq struct {
	Signature string
}

type SetTelemetryReq 

type SetTelemetryReq struct {
	Telemetry SettingsBool
}

type SettingsBool 

type SettingsBool int
const (
	SettingDisabled SettingsBool = iota
	SettingEnabled
)

type Share 

type Share struct {
	ShareMetadata

	AddressID    string // Encrypted address ID
	AddressKeyID string // Encrypted address key ID

	Key                 string // The private ShareKey, encrypted with a passphrase
	Passphrase          string // The encrypted passphrase
	PassphraseSignature string // The signature of the passphrase
}

Share is an entry point to a location in the file structure (Volume). It points to a file or folder anywhere in the tree and holds a key called the ShareKey. To access a file or folder in Drive, a user must be a member of a share. The membership information is tied to a specific address, and key. This key then allows the user to decrypt the share key, giving access to the file system rooted at that share.

func (Share) GetKeyRing 

func (s Share) GetKeyRing(addrKR *crypto.KeyRing) (*crypto.KeyRing, error)

type ShareFlags 

type ShareFlags int
const (
	NoFlags ShareFlags = iota
	PrimaryShare
)

type ShareMetadata 

type ShareMetadata struct {
	ShareID  string // Encrypted share ID
	LinkID   string // Encrypted link ID to which the share points (root of share).
	VolumeID string // Encrypted volume ID on which the share is mounted

	Type  ShareType  // Type of share
	State ShareState // The state of the share (active, deleted)

	CreationTime int64 // Creation time of the share in Unix time
	ModifyTime   int64 // Last modification time of the share in Unix time

	Creator           string     // Creator email address
	Flags             ShareFlags // The flag bitmap
	Locked            bool       // Whether the share is locked
	VolumeSoftDeleted bool       // Was the volume soft deleted
}

type ShareState 

type ShareState int
const (
	ShareStateActive  ShareState = 1
	ShareStateDeleted ShareState = 2
)

type ShareType 

type ShareType int
const (
	ShareTypeMain     ShareType = 1
	ShareTypeStandard ShareType = 2
	ShareTypeDevice   ShareType = 3
)

type SignExternalMessages 

type SignExternalMessages int
const (
	SignExternalMessagesDisabled SignExternalMessages = iota
	SignExternalMessagesEnabled
)

type Signature 

type Signature struct {
	Hash string
	Data *crypto.PGPSignature
}

func ExtractSignatures 

func ExtractSignatures(kr *crypto.KeyRing, arm string) ([]Signature, error)

type SignatureType 

type SignatureType int
const (
	NoSignature SignatureType = iota
	DetachedSignature
	AttachedSignature
)

type Status 

type Status int
const (
	StatusUp Status = iota
	StatusDown
)

func (Status) String 

func (s Status) String() string

type StatusObserver 

type StatusObserver func(Status)

type Ticker 

type Ticker struct {
	C chan time.Time
	// contains filtered or unexported fields
}

func NewTicker 

func NewTicker(period, jitter time.Duration, panicHandler async.PanicHandler) *Ticker

NewTicker returns a new ticker that ticks at a random time between period and period+jitter. It can be stopped by closing calling Stop().

func (*Ticker) Stop 

func (t *Ticker) Stop()

type TokenDestination 

type TokenDestination struct {
	Address string
	Phone   string
}

type TokenType 

type TokenType string
const (
	EmailTokenType TokenType = "email"
	SMSTokenType   TokenType = "sms"
)

type TwoFAInfo 

type TwoFAInfo struct {
	Enabled TwoFAStatus
	FIDO2   FIDO2Info
}

type TwoFAStatus 

type TwoFAStatus int
const (
	HasTOTP TwoFAStatus = 1 << iota
	HasFIDO2
)

type UndoRes 

type UndoRes struct {
	Messages []Message
}

type UndoToken 

type UndoToken struct {
	Token      string
	ValidUntil int64
}

type UpdateContactReq 

type UpdateContactReq struct {
	Cards Cards
}

type UpdateDraftReq 

type UpdateDraftReq struct {
	Message              DraftTemplate
	AttachmentKeyPackets []string
}

type UpdateLabelReq 

type UpdateLabelReq struct {
	Name  string
	Color string

	ParentID string `json:",omitempty"`
}

type UpdateRevisionReq 

type UpdateRevisionReq struct {
	BlockList         []BlockToken
	State             RevisionState
	ManifestSignature string
	SignatureAddress  string
}

type User 

type User struct {
	ID          string
	Name        string
	DisplayName string
	Email       string
	Keys        Keys

	UsedSpace int
	MaxSpace  int
	MaxUpload int

	Credit   int
	Currency string
}

type UserSettings 

type UserSettings struct {
	Telemetry    SettingsBool
	CrashReports SettingsBool
}

type UserType 

type UserType int
const (
	MailUserType UserType = iota + 1
	VPNUserType
)

type Volume 

type Volume struct {
	VolumeID string // Encrypted volume ID

	CreationTime    int64  // Creation time of the volume in Unix time
	ModifyTime      int64  // Last modification time of the volume in Unix time
	MaxSpace        *int64 // Space limit for the volume in bytes, null if unlimited.
	UsedSpace       int64  // Space used by files in the volume in bytes
	DownloadedBytes int64  // The amount of downloaded data since last reset
	UploadedBytes   int64  // The amount of uploaded data since the last reset

	State         VolumeState          // The state of the volume (active, locked, maybe more in the future)
	Share         VolumeShare          // The main share of the volume
	RestoreStatus *VolumeRestoreStatus // The status of the restore task. Null if not applicable
}

Volume is a Proton Drive volume.

type VolumeRestoreStatus 

type VolumeRestoreStatus int

VolumeRestoreStatus is the status of the restore task. 

const (
	RestoreStatusDone       VolumeRestoreStatus = 0
	RestoreStatusInProgress VolumeRestoreStatus = 1
	RestoreStatusFailed     VolumeRestoreStatus = -1
)

type VolumeShare 

type VolumeShare struct {
	ShareID string // Encrypted share ID
	LinkID  string // Encrypted link ID
}

VolumeShare is the main share of a volume.

type VolumeState 

type VolumeState int

VolumeState is the state of a volume. 

const (
	VolumeStateActive VolumeState = 1
	VolumeStateLocked VolumeState = 3
)

Source Files

View all Source files

Directories

Path Synopsis
backend
cmd/client
cmd/server
proto

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.