Documentation ¶
Index ¶
- Constants
- type Account
- type AccountType
- type AppserviceUserAPI
- type ClientKeyAPI
- type ClientUserAPI
- type Conflict
- type CrossSigningKeyUpdate
- type Device
- type DeviceKeys
- type DeviceMessage
- type DeviceMessageType
- type ErrorConflict
- type ErrorForbidden
- type FederationKeyAPI
- type FederationUserAPI
- type InputAccountDataRequest
- type InputAccountDataResponse
- type InternalKeyBackupSession
- type KeyBackupAPI
- type KeyBackupSession
- type KeyError
- type LoginTokenData
- type LoginTokenInternalAPI
- type LoginTokenMetadata
- type MediaUserAPI
- type Notification
- type OneTimeKeys
- type OneTimeKeysCount
- type OpenIDToken
- type OpenIDTokenAttributes
- type OutputCrossSigningKeyUpdate
- type PerformAccountCreationRequest
- type PerformAccountCreationResponse
- type PerformAccountDeactivationRequest
- type PerformAccountDeactivationResponse
- type PerformClaimKeysRequest
- type PerformClaimKeysResponse
- type PerformDeleteKeysRequest
- type PerformDeleteKeysResponse
- type PerformDeviceCreationRequest
- type PerformDeviceCreationResponse
- type PerformDeviceDeletionRequest
- type PerformDeviceDeletionResponse
- type PerformDeviceUpdateRequest
- type PerformDeviceUpdateResponse
- type PerformForgetThreePIDRequest
- type PerformKeyBackupRequest
- type PerformKeyBackupResponse
- type PerformLastSeenUpdateRequest
- type PerformLastSeenUpdateResponse
- type PerformLoginTokenCreationRequest
- type PerformLoginTokenCreationResponse
- type PerformLoginTokenDeletionRequest
- type PerformLoginTokenDeletionResponse
- type PerformMarkAsStaleRequest
- type PerformOpenIDTokenCreationRequest
- type PerformOpenIDTokenCreationResponse
- type PerformPasswordUpdateRequest
- type PerformPasswordUpdateResponse
- type PerformPusherDeletionRequest
- type PerformPusherSetRequest
- type PerformSaveThreePIDAssociationRequest
- type PerformUploadDeviceKeysRequest
- type PerformUploadDeviceKeysResponse
- type PerformUploadDeviceSignaturesRequest
- type PerformUploadDeviceSignaturesResponse
- type PerformUploadKeysRequest
- type PerformUploadKeysResponse
- type ProfileAPI
- type Pusher
- type PusherKind
- type QueryAcccessTokenAPI
- type QueryAccessTokenRequest
- type QueryAccessTokenResponse
- type QueryAccountAvailabilityRequest
- type QueryAccountAvailabilityResponse
- type QueryAccountByLocalpartRequest
- type QueryAccountByLocalpartResponse
- type QueryAccountByPasswordRequest
- type QueryAccountByPasswordResponse
- type QueryAccountDataRequest
- type QueryAccountDataResponse
- type QueryDeviceInfosRequest
- type QueryDeviceInfosResponse
- type QueryDeviceMessagesRequest
- type QueryDeviceMessagesResponse
- type QueryDevicesRequest
- type QueryDevicesResponse
- type QueryKeyBackupRequest
- type QueryKeyBackupResponse
- type QueryKeyChangesRequest
- type QueryKeyChangesResponse
- type QueryKeysRequest
- type QueryKeysResponse
- type QueryLocalpartForThreePIDRequest
- type QueryLocalpartForThreePIDResponse
- type QueryLoginTokenRequest
- type QueryLoginTokenResponse
- type QueryNotificationsRequest
- type QueryNotificationsResponse
- type QueryNumericLocalpartRequest
- type QueryNumericLocalpartResponse
- type QueryOneTimeKeysRequest
- type QueryOneTimeKeysResponse
- type QueryOpenIDTokenRequest
- type QueryOpenIDTokenResponse
- type QueryPushersRequest
- type QueryPushersResponse
- type QuerySearchProfilesAPI
- type QuerySearchProfilesRequest
- type QuerySearchProfilesResponse
- type QuerySignaturesRequest
- type QuerySignaturesResponse
- type QueryThreePIDsForLocalpartRequest
- type QueryThreePIDsForLocalpartResponse
- type RoomserverUserAPI
- type SyncKeyAPI
- type SyncUserAPI
- type UploadDeviceKeysAPI
- type UserInfo
- type UserInternalAPI
- type UserLoginAPI
Constants ¶
const ( // ConflictUpdate will update matching records returning no error ConflictUpdate Conflict = 1 // ConflictAbort will reject the request with ErrorConflict ConflictAbort Conflict = 2 // AccountTypeUser indicates this is a user account AccountTypeUser AccountType = 1 // AccountTypeGuest indicates this is a guest account AccountTypeGuest AccountType = 2 // AccountTypeAdmin indicates this is an admin account AccountTypeAdmin AccountType = 3 // AccountTypeAppService indicates this is an appservice account AccountTypeAppService AccountType = 4 )
const DefaultLoginTokenLifetime = 2 * time.Minute
DefaultLoginTokenLifetime determines how old a valid token may be.
NOTSPEC: The current spec says "SHOULD be limited to around five seconds". Since TCP retries are on the order of 3 s, 5 s sounds very low. Synapse uses 2 min (https://github.com/matrix-org/synapse/blob/78d5f91de1a9baf4dbb0a794cb49a799f29f7a38/synapse/handlers/auth.py#L1323-L1325).
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Account ¶
type Account struct { UserID string Localpart string ServerName spec.ServerName AppServiceID string AccountType AccountType }
Account represents a Matrix account on this home server.
type AppserviceUserAPI ¶ added in v0.8.3
type AppserviceUserAPI interface { PerformAccountCreation(ctx context.Context, req *PerformAccountCreationRequest, res *PerformAccountCreationResponse) error PerformDeviceCreation(ctx context.Context, req *PerformDeviceCreationRequest, res *PerformDeviceCreationResponse) error }
api functions required by the appservice api
type ClientKeyAPI ¶ added in v0.12.0
type ClientKeyAPI interface { UploadDeviceKeysAPI QueryKeys(ctx context.Context, req *QueryKeysRequest, res *QueryKeysResponse) PerformUploadKeys(ctx context.Context, req *PerformUploadKeysRequest, res *PerformUploadKeysResponse) error PerformUploadDeviceSignatures(ctx context.Context, req *PerformUploadDeviceSignaturesRequest, res *PerformUploadDeviceSignaturesResponse) // PerformClaimKeys claims one-time keys for use in pre-key messages PerformClaimKeys(ctx context.Context, req *PerformClaimKeysRequest, res *PerformClaimKeysResponse) PerformMarkAsStaleIfNeeded(ctx context.Context, req *PerformMarkAsStaleRequest, res *struct{}) error }
API functions required by the clientapi
type ClientUserAPI ¶ added in v0.8.3
type ClientUserAPI interface { QueryAcccessTokenAPI LoginTokenInternalAPI UserLoginAPI ClientKeyAPI ProfileAPI KeyBackupAPI QueryNumericLocalpart(ctx context.Context, req *QueryNumericLocalpartRequest, res *QueryNumericLocalpartResponse) error QueryDevices(ctx context.Context, req *QueryDevicesRequest, res *QueryDevicesResponse) error QueryAccountData(ctx context.Context, req *QueryAccountDataRequest, res *QueryAccountDataResponse) error QueryPushers(ctx context.Context, req *QueryPushersRequest, res *QueryPushersResponse) error QueryPushRules(ctx context.Context, userID string) (*pushrules.AccountRuleSets, error) QueryAccountAvailability(ctx context.Context, req *QueryAccountAvailabilityRequest, res *QueryAccountAvailabilityResponse) error PerformAdminCreateRegistrationToken(ctx context.Context, registrationToken *clientapi.RegistrationToken) (bool, error) PerformAdminListRegistrationTokens(ctx context.Context, returnAll bool, valid bool) ([]clientapi.RegistrationToken, error) PerformAdminGetRegistrationToken(ctx context.Context, tokenString string) (*clientapi.RegistrationToken, error) PerformAdminDeleteRegistrationToken(ctx context.Context, tokenString string) error PerformAdminUpdateRegistrationToken(ctx context.Context, tokenString string, newAttributes map[string]interface{}) (*clientapi.RegistrationToken, error) PerformAccountCreation(ctx context.Context, req *PerformAccountCreationRequest, res *PerformAccountCreationResponse) error PerformDeviceCreation(ctx context.Context, req *PerformDeviceCreationRequest, res *PerformDeviceCreationResponse) error PerformDeviceUpdate(ctx context.Context, req *PerformDeviceUpdateRequest, res *PerformDeviceUpdateResponse) error PerformDeviceDeletion(ctx context.Context, req *PerformDeviceDeletionRequest, res *PerformDeviceDeletionResponse) error PerformPasswordUpdate(ctx context.Context, req *PerformPasswordUpdateRequest, res *PerformPasswordUpdateResponse) error PerformPusherDeletion(ctx context.Context, req *PerformPusherDeletionRequest, res *struct{}) error PerformPusherSet(ctx context.Context, req *PerformPusherSetRequest, res *struct{}) error PerformPushRulesPut(ctx context.Context, userID string, ruleSets *pushrules.AccountRuleSets) error PerformAccountDeactivation(ctx context.Context, req *PerformAccountDeactivationRequest, res *PerformAccountDeactivationResponse) error PerformOpenIDTokenCreation(ctx context.Context, req *PerformOpenIDTokenCreationRequest, res *PerformOpenIDTokenCreationResponse) error QueryNotifications(ctx context.Context, req *QueryNotificationsRequest, res *QueryNotificationsResponse) error InputAccountData(ctx context.Context, req *InputAccountDataRequest, res *InputAccountDataResponse) error QueryThreePIDsForLocalpart(ctx context.Context, req *QueryThreePIDsForLocalpartRequest, res *QueryThreePIDsForLocalpartResponse) error QueryLocalpartForThreePID(ctx context.Context, req *QueryLocalpartForThreePIDRequest, res *QueryLocalpartForThreePIDResponse) error PerformForgetThreePID(ctx context.Context, req *PerformForgetThreePIDRequest, res *struct{}) error PerformSaveThreePIDAssociation(ctx context.Context, req *PerformSaveThreePIDAssociationRequest, res *struct{}) error }
api functions required by the client api
type Conflict ¶
type Conflict int
Conflict is an enum representing what to do when encountering conflicting when creating profiles/devices
type CrossSigningKeyUpdate ¶ added in v0.12.0
type CrossSigningKeyUpdate struct { MasterKey *fclient.CrossSigningKey `json:"master_key,omitempty"` SelfSigningKey *fclient.CrossSigningKey `json:"self_signing_key,omitempty"` UserID string `json:"user_id"` }
type Device ¶
type Device struct { ID string UserID string // The access_token granted to this device. // This uniquely identifies the device from all other devices and clients. AccessToken string // The unique ID of the session identified by the access token. // Can be used as a secure substitution in places where data needs to be // associated with access tokens. SessionID int64 DisplayName string LastSeenTS int64 LastSeenIP string UserAgent string // If the device is for an appservice user, // this is the appservice ID. AppserviceID string AccountType AccountType }
Device represents a client's device (mobile, web, etc)
func (*Device) UserDomain ¶ added in v0.10.5
func (d *Device) UserDomain() spec.ServerName
type DeviceKeys ¶ added in v0.12.0
type DeviceKeys struct { // The user who owns this device UserID string // The device ID of this device DeviceID string // The device display name DisplayName string // The raw device key JSON KeyJSON []byte }
DeviceKeys represents a set of device keys for a single device https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-keys-upload
func (*DeviceKeys) WithStreamID ¶ added in v0.12.0
func (k *DeviceKeys) WithStreamID(streamID int64) DeviceMessage
WithStreamID returns a copy of this device message with the given stream ID
type DeviceMessage ¶ added in v0.12.0
type DeviceMessage struct { Type DeviceMessageType `json:"Type,omitempty"` *DeviceKeys `json:"DeviceKeys,omitempty"` *OutputCrossSigningKeyUpdate `json:"CrossSigningKeyUpdate,omitempty"` // A monotonically increasing number which represents device changes for this user. StreamID int64 DeviceChangeID int64 }
DeviceMessage represents the message produced into Kafka by the key server.
func (*DeviceMessage) DeviceKeysEqual ¶ added in v0.12.0
func (m1 *DeviceMessage) DeviceKeysEqual(m2 *DeviceMessage) bool
DeviceKeysEqual returns true if the device keys updates contain the same display name and key JSON. This will return false if either of the updates is not a device keys update, or if the user ID/device ID differ between the two.
type DeviceMessageType ¶ added in v0.12.0
type DeviceMessageType int
const ( TypeDeviceKeyUpdate DeviceMessageType = iota TypeCrossSigningUpdate )
type ErrorConflict ¶
type ErrorConflict struct {
Message string
}
ErrorConflict is an error indicating that there was a conflict which resulted in the request being aborted.
func (*ErrorConflict) Error ¶
func (e *ErrorConflict) Error() string
type ErrorForbidden ¶
type ErrorForbidden struct {
Message string
}
ErrorForbidden is an error indicating that the supplied access token is forbidden
func (*ErrorForbidden) Error ¶
func (e *ErrorForbidden) Error() string
type FederationKeyAPI ¶ added in v0.12.0
type FederationKeyAPI interface { UploadDeviceKeysAPI QueryKeys(ctx context.Context, req *QueryKeysRequest, res *QueryKeysResponse) QuerySignatures(ctx context.Context, req *QuerySignaturesRequest, res *QuerySignaturesResponse) QueryDeviceMessages(ctx context.Context, req *QueryDeviceMessagesRequest, res *QueryDeviceMessagesResponse) error PerformClaimKeys(ctx context.Context, req *PerformClaimKeysRequest, res *PerformClaimKeysResponse) }
type FederationUserAPI ¶ added in v0.8.3
type FederationUserAPI interface { UploadDeviceKeysAPI QueryOpenIDToken(ctx context.Context, req *QueryOpenIDTokenRequest, res *QueryOpenIDTokenResponse) error QueryProfile(ctx context.Context, userID string) (*authtypes.Profile, error) QueryDevices(ctx context.Context, req *QueryDevicesRequest, res *QueryDevicesResponse) error QueryKeys(ctx context.Context, req *QueryKeysRequest, res *QueryKeysResponse) QuerySignatures(ctx context.Context, req *QuerySignaturesRequest, res *QuerySignaturesResponse) QueryDeviceMessages(ctx context.Context, req *QueryDeviceMessagesRequest, res *QueryDeviceMessagesResponse) error PerformClaimKeys(ctx context.Context, req *PerformClaimKeysRequest, res *PerformClaimKeysResponse) }
api functions required by the federation api
type InputAccountDataRequest ¶
type InputAccountDataRequest struct { UserID string // required: the user to set account data for RoomID string // optional: the room to associate the account data with DataType string // required: the data type of the data AccountData json.RawMessage // required: the message content }
InputAccountDataRequest is the request for InputAccountData
type InputAccountDataResponse ¶
type InputAccountDataResponse struct { }
InputAccountDataResponse is the response for InputAccountData
type InternalKeyBackupSession ¶ added in v0.5.0
type InternalKeyBackupSession struct { KeyBackupSession RoomID string SessionID string }
Internal KeyBackupData for passing to/from the storage layer
type KeyBackupAPI ¶ added in v0.13.0
type KeyBackupAPI interface { DeleteKeyBackup(ctx context.Context, userID, version string) (bool, error) PerformKeyBackup(ctx context.Context, req *PerformKeyBackupRequest) (string, error) QueryKeyBackup(ctx context.Context, req *QueryKeyBackupRequest) (*QueryKeyBackupResponse, error) UpdateBackupKeyAuthData(ctx context.Context, req *PerformKeyBackupRequest) (*PerformKeyBackupResponse, error) }
type KeyBackupSession ¶ added in v0.5.0
type KeyBackupSession struct { FirstMessageIndex int `json:"first_message_index"` ForwardedCount int `json:"forwarded_count"` IsVerified bool `json:"is_verified"` SessionData json.RawMessage `json:"session_data"` }
KeyBackupData in https://spec.matrix.org/unstable/client-server-api/#get_matrixclientr0room_keyskeysroomidsessionid
func (*KeyBackupSession) ShouldReplaceRoomKey ¶ added in v0.5.0
func (a *KeyBackupSession) ShouldReplaceRoomKey(newKey *KeyBackupSession) bool
type KeyError ¶ added in v0.12.0
type KeyError struct { Err string `json:"error"` IsInvalidSignature bool `json:"is_invalid_signature,omitempty"` // M_INVALID_SIGNATURE IsMissingParam bool `json:"is_missing_param,omitempty"` // M_MISSING_PARAM IsInvalidParam bool `json:"is_invalid_param,omitempty"` // M_INVALID_PARAM }
KeyError is returned if there was a problem performing/querying the server
type LoginTokenData ¶ added in v0.6.3
type LoginTokenData struct { // UserID is the full mxid of the user. UserID string }
LoginTokenData is the data that can be retrieved given a login token. This is provided by the calling code.
type LoginTokenInternalAPI ¶ added in v0.6.3
type LoginTokenInternalAPI interface { // PerformLoginTokenCreation creates a new login token and associates it with the provided data. PerformLoginTokenCreation(ctx context.Context, req *PerformLoginTokenCreationRequest, res *PerformLoginTokenCreationResponse) error // PerformLoginTokenDeletion ensures the token doesn't exist. Success // is returned even if the token didn't exist, or was already deleted. PerformLoginTokenDeletion(ctx context.Context, req *PerformLoginTokenDeletionRequest, res *PerformLoginTokenDeletionResponse) error // QueryLoginToken returns the data associated with a login token. If // the token is not valid, success is returned, but res.Data == nil. QueryLoginToken(ctx context.Context, req *QueryLoginTokenRequest, res *QueryLoginTokenResponse) error }
type LoginTokenMetadata ¶ added in v0.6.3
LoginTokenMetadata contains metadata created and maintained by the User API.
type MediaUserAPI ¶ added in v0.8.3
type MediaUserAPI interface { QueryAcccessTokenAPI }
api functions required by the media api
type Notification ¶ added in v0.6.5
type Notification struct { Actions []*pushrules.Action `json:"actions"` // Required. Event synctypes.ClientEvent `json:"event"` // Required. ProfileTag string `json:"profile_tag"` // Required by Sytest, but actually optional. Read bool `json:"read"` // Required. RoomID string `json:"room_id"` // Required. TS spec.Timestamp `json:"ts"` // Required. }
type OneTimeKeys ¶ added in v0.12.0
type OneTimeKeys struct { // The user who owns this device UserID string // The device ID of this device DeviceID string // A map of algorithm:key_id => key JSON KeyJSON map[string]json.RawMessage }
OneTimeKeys represents a set of one-time keys for a single device https://matrix.org/docs/spec/client_server/r0.6.1#post-matrix-client-r0-keys-upload
type OneTimeKeysCount ¶ added in v0.12.0
type OneTimeKeysCount struct { // The user who owns this device UserID string // The device ID of this device DeviceID string // algorithm to count e.g: // { // "curve25519": 10, // "signed_curve25519": 20 // } KeyCount map[string]int }
OneTimeKeysCount represents the counts of one-time keys for a single device
type OpenIDToken ¶ added in v0.4.0
OpenIDToken represents an OpenID token
type OpenIDTokenAttributes ¶ added in v0.4.0
OpenIDTokenInfo represents the attributes associated with an issued OpenID token
type OutputCrossSigningKeyUpdate ¶ added in v0.12.0
type OutputCrossSigningKeyUpdate struct {
CrossSigningKeyUpdate `json:"signing_keys"`
}
OutputCrossSigningKeyUpdate is an entry in the signing key update output kafka log
type PerformAccountCreationRequest ¶
type PerformAccountCreationRequest struct { AccountType AccountType // Required: whether this is a guest or user account Localpart string // Required: The localpart for this account. Ignored if account type is guest. ServerName spec.ServerName // optional: if not specified, default server name used instead AppServiceID string // optional: the application service ID (not user ID) creating this account, if any. Password string // optional: if missing then this account will be a passwordless account OnConflict Conflict }
PerformAccountCreationRequest is the request for PerformAccountCreation
type PerformAccountCreationResponse ¶
PerformAccountCreationResponse is the response for PerformAccountCreation
type PerformAccountDeactivationRequest ¶
type PerformAccountDeactivationRequest struct { Localpart string ServerName spec.ServerName // optional: if blank, default server name used }
PerformAccountDeactivationRequest is the request for PerformAccountDeactivation
type PerformAccountDeactivationResponse ¶
type PerformAccountDeactivationResponse struct {
AccountDeactivated bool
}
PerformAccountDeactivationResponse is the response for PerformAccountDeactivation
type PerformClaimKeysRequest ¶ added in v0.12.0
type PerformClaimKeysResponse ¶ added in v0.12.0
type PerformClaimKeysResponse struct { // Map of user_id to device_id to algorithm:key_id to key JSON OneTimeKeys map[string]map[string]map[string]json.RawMessage // Map of remote server domain to error JSON Failures map[string]interface{} // Set if there was a fatal error processing this action Error *KeyError }
type PerformDeleteKeysRequest ¶ added in v0.12.0
type PerformDeleteKeysRequest struct { UserID string KeyIDs []gomatrixserverlib.KeyID }
PerformDeleteKeysRequest asks the keyserver to forget about certain keys, and signatures related to those keys.
type PerformDeleteKeysResponse ¶ added in v0.12.0
type PerformDeleteKeysResponse struct {
Error *KeyError
}
PerformDeleteKeysResponse is the response to PerformDeleteKeysRequest.
type PerformDeviceCreationRequest ¶
type PerformDeviceCreationRequest struct { Localpart string ServerName spec.ServerName // optional: if blank, default server name used AccessToken string // optional: if blank one will be made on your behalf // optional: if nil an ID is generated for you. If set, replaces any existing device session, // which will generate a new access token and invalidate the old one. DeviceID *string // optional: if nil no display name will be associated with this device. DeviceDisplayName *string // IP address of this device IPAddr string // Useragent for this device UserAgent string // NoDeviceListUpdate determines whether we should avoid sending a device list // update for this account. Generally the only reason to do this is if the account // is an appservice account. NoDeviceListUpdate bool // FromRegistration determines if this request comes from registering a new account // and is in most cases false. FromRegistration bool }
PerformDeviceCreationRequest is the request for PerformDeviceCreation
type PerformDeviceCreationResponse ¶
PerformDeviceCreationResponse is the response for PerformDeviceCreation
type PerformDeviceDeletionRequest ¶
type PerformDeviceDeletionRequest struct { UserID string // The devices to delete. An empty slice means delete all devices. DeviceIDs []string // The requesting device ID to exclude from deletion. This is needed // so that a password change doesn't cause that client to be logged // out. Only specify when DeviceIDs is empty. ExceptDeviceID string }
type PerformDeviceDeletionResponse ¶
type PerformDeviceDeletionResponse struct { }
type PerformDeviceUpdateResponse ¶
type PerformDeviceUpdateResponse struct {
DeviceExists bool
}
type PerformForgetThreePIDRequest ¶ added in v0.7.0
type PerformForgetThreePIDRequest QueryLocalpartForThreePIDRequest
type PerformKeyBackupRequest ¶ added in v0.5.0
type PerformKeyBackupRequest struct { UserID string Version string // optional if modifying a key backup AuthData json.RawMessage Algorithm string // The keys to upload, if any. If blank, creates/updates/deletes key version metadata only. Keys struct { Rooms map[string]struct { Sessions map[string]KeyBackupSession `json:"sessions"` } `json:"rooms"` } }
type PerformKeyBackupResponse ¶ added in v0.5.0
type PerformLastSeenUpdateRequest ¶ added in v0.3.1
type PerformLastSeenUpdateRequest struct { UserID string DeviceID string RemoteAddr string UserAgent string }
PerformLastSeenUpdateRequest is the request for PerformLastSeenUpdate.
type PerformLastSeenUpdateResponse ¶ added in v0.3.1
type PerformLastSeenUpdateResponse struct { }
PerformLastSeenUpdateResponse is the response for PerformLastSeenUpdate.
type PerformLoginTokenCreationRequest ¶ added in v0.6.3
type PerformLoginTokenCreationRequest struct {
Data LoginTokenData
}
type PerformLoginTokenCreationResponse ¶ added in v0.6.3
type PerformLoginTokenCreationResponse struct {
Metadata LoginTokenMetadata
}
type PerformLoginTokenDeletionRequest ¶ added in v0.6.3
type PerformLoginTokenDeletionRequest struct {
Token string
}
type PerformLoginTokenDeletionResponse ¶ added in v0.6.3
type PerformLoginTokenDeletionResponse struct{}
type PerformMarkAsStaleRequest ¶ added in v0.12.0
type PerformMarkAsStaleRequest struct { UserID string Domain spec.ServerName DeviceID string }
type PerformOpenIDTokenCreationRequest ¶ added in v0.4.0
type PerformOpenIDTokenCreationRequest struct {
UserID string
}
PerformOpenIDTokenCreationRequest is the request for PerformOpenIDTokenCreation
type PerformOpenIDTokenCreationResponse ¶ added in v0.4.0
type PerformOpenIDTokenCreationResponse struct {
Token OpenIDToken
}
PerformOpenIDTokenCreationResponse is the response for PerformOpenIDTokenCreation
type PerformPasswordUpdateRequest ¶
type PerformPasswordUpdateRequest struct { Localpart string // Required: The localpart for this account. ServerName spec.ServerName // Required: The domain for this account. Password string // Required: The new password to set. LogoutDevices bool // Optional: Whether to log out all user devices. }
PerformAccountCreationRequest is the request for PerformAccountCreation
type PerformPasswordUpdateResponse ¶
PerformAccountCreationResponse is the response for PerformAccountCreation
type PerformPusherDeletionRequest ¶ added in v0.6.5
type PerformPusherDeletionRequest struct { Localpart string ServerName spec.ServerName SessionID int64 }
type PerformPusherSetRequest ¶ added in v0.6.5
type PerformPusherSetRequest struct { Pusher // Anonymous field because that's how clientapi unmarshals it. Localpart string ServerName spec.ServerName Append bool `json:"append"` }
type PerformSaveThreePIDAssociationRequest ¶ added in v0.7.0
type PerformSaveThreePIDAssociationRequest struct { ThreePID string Localpart string ServerName spec.ServerName Medium string }
type PerformUploadDeviceKeysRequest ¶ added in v0.12.0
type PerformUploadDeviceKeysRequest struct { fclient.CrossSigningKeys // The user that uploaded the key, should be populated by the clientapi. UserID string }
type PerformUploadDeviceKeysResponse ¶ added in v0.12.0
type PerformUploadDeviceKeysResponse struct {
Error *KeyError
}
type PerformUploadDeviceSignaturesRequest ¶ added in v0.12.0
type PerformUploadDeviceSignaturesRequest struct { Signatures map[string]map[gomatrixserverlib.KeyID]fclient.CrossSigningForKeyOrDevice // The user that uploaded the sig, should be populated by the clientapi. UserID string }
type PerformUploadDeviceSignaturesResponse ¶ added in v0.12.0
type PerformUploadDeviceSignaturesResponse struct {
Error *KeyError
}
type PerformUploadKeysRequest ¶ added in v0.12.0
type PerformUploadKeysRequest struct { UserID string // Required - User performing the request DeviceID string // Optional - Device performing the request, for fetching OTK count DeviceKeys []DeviceKeys OneTimeKeys []OneTimeKeys // OnlyDisplayNameUpdates should be `true` if ALL the DeviceKeys are present to update // the display name for their respective device, and NOT to modify the keys. The key // itself doesn't change but it's easier to pretend upload new keys and reuse the same code paths. // Without this flag, requests to modify device display names would delete device keys. OnlyDisplayNameUpdates bool // FromRegistration is set if this key upload comes right after creating an account // and determines if we need to inform downstream components. FromRegistration bool }
PerformUploadKeysRequest is the request to PerformUploadKeys
type PerformUploadKeysResponse ¶ added in v0.12.0
type PerformUploadKeysResponse struct { // A fatal error when processing e.g database failures Error *KeyError // A map of user_id -> device_id -> Error for tracking failures. KeyErrors map[string]map[string]*KeyError OneTimeKeyCounts []OneTimeKeysCount }
PerformUploadKeysResponse is the response to PerformUploadKeys
func (*PerformUploadKeysResponse) KeyError ¶ added in v0.12.0
func (r *PerformUploadKeysResponse) KeyError(userID, deviceID string, err *KeyError)
KeyError sets a key error field on KeyErrors
type ProfileAPI ¶ added in v0.13.0
type ProfileAPI interface { QueryProfile(ctx context.Context, userID string) (*authtypes.Profile, error) SetAvatarURL(ctx context.Context, localpart string, serverName spec.ServerName, avatarURL string) (*authtypes.Profile, bool, error) SetDisplayName(ctx context.Context, localpart string, serverName spec.ServerName, displayName string) (*authtypes.Profile, bool, error) }
type Pusher ¶ added in v0.6.5
type Pusher struct { SessionID int64 `json:"session_id,omitempty"` PushKey string `json:"pushkey"` PushKeyTS int64 `json:"pushkey_ts,omitempty"` Kind PusherKind `json:"kind"` AppID string `json:"app_id"` AppDisplayName string `json:"app_display_name"` DeviceDisplayName string `json:"device_display_name"` ProfileTag string `json:"profile_tag"` Language string `json:"lang"` Data map[string]interface{} `json:"data"` }
Pusher represents a push notification subscriber
type PusherKind ¶ added in v0.6.5
type PusherKind string
const ( EmailKind PusherKind = "email" HTTPKind PusherKind = "http" )
type QueryAcccessTokenAPI ¶ added in v0.8.3
type QueryAcccessTokenAPI interface {
QueryAccessToken(ctx context.Context, req *QueryAccessTokenRequest, res *QueryAccessTokenResponse) error
}
common function for creating authenticated endpoints (used in client/media/sync api)
type QueryAccessTokenRequest ¶
type QueryAccessTokenRequest struct { AccessToken string // optional user ID, valid only if the token is an appservice. // https://matrix.org/docs/spec/application_service/r0.1.2#using-sync-and-events AppServiceUserID string }
QueryAccessTokenRequest is the request for QueryAccessToken
type QueryAccessTokenResponse ¶
QueryAccessTokenResponse is the response for QueryAccessToken
type QueryAccountAvailabilityRequest ¶ added in v0.7.0
type QueryAccountAvailabilityRequest struct { Localpart string ServerName spec.ServerName }
type QueryAccountAvailabilityResponse ¶ added in v0.7.0
type QueryAccountAvailabilityResponse struct {
Available bool
}
type QueryAccountByLocalpartRequest ¶ added in v0.10.9
type QueryAccountByLocalpartRequest struct { Localpart string ServerName spec.ServerName }
type QueryAccountByLocalpartResponse ¶ added in v0.10.9
type QueryAccountByLocalpartResponse struct {
Account *Account
}
type QueryAccountByPasswordRequest ¶ added in v0.7.0
type QueryAccountByPasswordRequest struct { Localpart string ServerName spec.ServerName PlaintextPassword string }
type QueryAccountByPasswordResponse ¶ added in v0.7.0
type QueryAccountDataRequest ¶
type QueryAccountDataRequest struct { UserID string // required: the user to get account data for. RoomID string // optional: the room ID, or global account data if not specified. DataType string // optional: the data type, or all types if not specified. }
QueryAccountDataRequest is the request for QueryAccountData
type QueryAccountDataResponse ¶
type QueryAccountDataResponse struct { GlobalAccountData map[string]json.RawMessage // type -> data RoomAccountData map[string]map[string]json.RawMessage // room -> type -> data }
QueryAccountDataResponse is the response for QueryAccountData
type QueryDeviceInfosRequest ¶
type QueryDeviceInfosRequest struct {
DeviceIDs []string
}
QueryDeviceInfosRequest is the request to QueryDeviceInfos
type QueryDeviceInfosResponse ¶
type QueryDeviceInfosResponse struct { DeviceInfo map[string]struct { DisplayName string UserID string } }
QueryDeviceInfosResponse is the response to QueryDeviceInfos
type QueryDeviceMessagesRequest ¶ added in v0.12.0
type QueryDeviceMessagesRequest struct {
UserID string
}
type QueryDeviceMessagesResponse ¶ added in v0.12.0
type QueryDeviceMessagesResponse struct { // The latest stream ID StreamID int64 Devices []DeviceMessage Error *KeyError }
type QueryDevicesRequest ¶
type QueryDevicesRequest struct {
UserID string
}
QueryDevicesRequest is the request for QueryDevices
type QueryDevicesResponse ¶
QueryDevicesResponse is the response for QueryDevices
type QueryKeyBackupRequest ¶ added in v0.5.0
type QueryKeyBackupRequest struct { UserID string Version string // the version to query, if blank it means the latest ReturnKeys bool // whether to return keys in the backup response or just the metadata KeysForRoomID string // optional string to return keys which belong to this room KeysForSessionID string // optional string to return keys which belong to this (room, session) }
type QueryKeyBackupResponse ¶ added in v0.5.0
type QueryKeyBackupResponse struct { Exists bool Algorithm string `json:"algorithm"` AuthData json.RawMessage `json:"auth_data"` Count int64 `json:"count"` ETag string `json:"etag"` Version string `json:"version"` Keys map[string]map[string]KeyBackupSession // the keys if ReturnKeys=true }
type QueryKeyChangesRequest ¶ added in v0.12.0
type QueryKeyChangesRequest struct { // The offset of the last received key event, or sarama.OffsetOldest if this is from the beginning Offset int64 // The inclusive offset where to track key changes up to. Messages with this offset are included in the response. // Use types.OffsetNewest if the offset is unknown (then check the response Offset to avoid racing). ToOffset int64 }
type QueryKeyChangesResponse ¶ added in v0.12.0
type QueryKeysRequest ¶ added in v0.12.0
type QueryKeysResponse ¶ added in v0.12.0
type QueryKeysResponse struct { // Map of remote server domain to error JSON Failures map[string]interface{} // Map of user_id to device_id to device_key DeviceKeys map[string]map[string]json.RawMessage // Maps of user_id to cross signing key MasterKeys map[string]fclient.CrossSigningKey SelfSigningKeys map[string]fclient.CrossSigningKey UserSigningKeys map[string]fclient.CrossSigningKey // Set if there was a fatal error processing this query Error *KeyError }
type QueryLocalpartForThreePIDRequest ¶ added in v0.7.0
type QueryLocalpartForThreePIDRequest struct {
ThreePID, Medium string
}
type QueryLocalpartForThreePIDResponse ¶ added in v0.7.0
type QueryLocalpartForThreePIDResponse struct { Localpart string ServerName spec.ServerName }
type QueryLoginTokenRequest ¶ added in v0.6.3
type QueryLoginTokenRequest struct {
Token string
}
type QueryLoginTokenResponse ¶ added in v0.6.3
type QueryLoginTokenResponse struct { // Data is nil if the token was invalid. Data *LoginTokenData }
type QueryNotificationsRequest ¶ added in v0.6.5
type QueryNotificationsResponse ¶ added in v0.6.5
type QueryNotificationsResponse struct { NextToken string `json:"next_token"` Notifications []*Notification `json:"notifications"` // Required. }
type QueryNumericLocalpartRequest ¶ added in v0.10.8
type QueryNumericLocalpartRequest struct {
ServerName spec.ServerName
}
type QueryNumericLocalpartResponse ¶ added in v0.7.0
type QueryNumericLocalpartResponse struct {
ID int64
}
type QueryOneTimeKeysRequest ¶ added in v0.12.0
type QueryOneTimeKeysResponse ¶ added in v0.12.0
type QueryOneTimeKeysResponse struct { // OTK key counts, in the extended /sync form described by https://matrix.org/docs/spec/client_server/r0.6.1#id84 Count OneTimeKeysCount Error *KeyError }
type QueryOpenIDTokenRequest ¶ added in v0.4.0
type QueryOpenIDTokenRequest struct {
Token string
}
QueryOpenIDTokenRequest is the request for QueryOpenIDToken
type QueryOpenIDTokenResponse ¶ added in v0.4.0
type QueryOpenIDTokenResponse struct { Sub string // The Matrix User ID that generated the token ExpiresAtMS int64 }
QueryOpenIDTokenResponse is the response for QueryOpenIDToken
type QueryPushersRequest ¶ added in v0.6.5
type QueryPushersRequest struct { Localpart string ServerName spec.ServerName }
type QueryPushersResponse ¶ added in v0.6.5
type QueryPushersResponse struct {
Pushers []Pusher `json:"pushers"`
}
type QuerySearchProfilesAPI ¶ added in v0.8.3
type QuerySearchProfilesAPI interface {
QuerySearchProfiles(ctx context.Context, req *QuerySearchProfilesRequest, res *QuerySearchProfilesResponse) error
}
custom api functions required by pinecone / p2p demos
type QuerySearchProfilesRequest ¶
type QuerySearchProfilesRequest struct { // The search string to match SearchString string // How many results to return Limit int }
QuerySearchProfilesRequest is the request for QueryProfile
type QuerySearchProfilesResponse ¶
type QuerySearchProfilesResponse struct { // Profiles matching the search Profiles []authtypes.Profile }
QuerySearchProfilesResponse is the response for QuerySearchProfilesRequest
type QuerySignaturesRequest ¶ added in v0.12.0
type QuerySignaturesRequest struct { // A map of target user ID -> target key/device IDs to retrieve signatures for TargetIDs map[string][]gomatrixserverlib.KeyID `json:"target_ids"` }
type QuerySignaturesResponse ¶ added in v0.12.0
type QuerySignaturesResponse struct { // A map of target user ID -> target key/device ID -> origin user ID -> origin key/device ID -> signatures Signatures map[string]map[gomatrixserverlib.KeyID]types.CrossSigningSigMap // A map of target user ID -> cross-signing master key MasterKeys map[string]fclient.CrossSigningKey // A map of target user ID -> cross-signing self-signing key SelfSigningKeys map[string]fclient.CrossSigningKey // A map of target user ID -> cross-signing user-signing key UserSigningKeys map[string]fclient.CrossSigningKey // The request error, if any Error *KeyError }
type QueryThreePIDsForLocalpartRequest ¶ added in v0.7.0
type QueryThreePIDsForLocalpartRequest struct { Localpart string ServerName spec.ServerName }
type QueryThreePIDsForLocalpartResponse ¶ added in v0.7.0
type RoomserverUserAPI ¶ added in v0.8.3
type RoomserverUserAPI interface { QueryAccountData(ctx context.Context, req *QueryAccountDataRequest, res *QueryAccountDataResponse) error QueryAccountByLocalpart(ctx context.Context, req *QueryAccountByLocalpartRequest, res *QueryAccountByLocalpartResponse) (err error) }
type SyncKeyAPI ¶ added in v0.12.0
type SyncKeyAPI interface { QueryKeyChanges(ctx context.Context, req *QueryKeyChangesRequest, res *QueryKeyChangesResponse) error QueryOneTimeKeys(ctx context.Context, req *QueryOneTimeKeysRequest, res *QueryOneTimeKeysResponse) error PerformMarkAsStaleIfNeeded(ctx context.Context, req *PerformMarkAsStaleRequest, res *struct{}) error }
API functions required by the syncapi
type SyncUserAPI ¶ added in v0.8.3
type SyncUserAPI interface { QueryAcccessTokenAPI SyncKeyAPI QueryAccountData(ctx context.Context, req *QueryAccountDataRequest, res *QueryAccountDataResponse) error PerformLastSeenUpdate(ctx context.Context, req *PerformLastSeenUpdateRequest, res *PerformLastSeenUpdateResponse) error PerformDeviceUpdate(ctx context.Context, req *PerformDeviceUpdateRequest, res *PerformDeviceUpdateResponse) error QueryDevices(ctx context.Context, req *QueryDevicesRequest, res *QueryDevicesResponse) error QueryDeviceInfos(ctx context.Context, req *QueryDeviceInfosRequest, res *QueryDeviceInfosResponse) error }
api functions required by the sync api
type UploadDeviceKeysAPI ¶ added in v0.12.0
type UploadDeviceKeysAPI interface {
PerformUploadDeviceKeys(ctx context.Context, req *PerformUploadDeviceKeysRequest, res *PerformUploadDeviceKeysResponse)
}
type UserInfo ¶ added in v0.4.0
type UserInfo struct {
Sub string // The Matrix user's ID who generated the token
}
UserInfo is for returning information about the user an OpenID token was issued for
type UserInternalAPI ¶
type UserInternalAPI interface { SyncUserAPI ClientUserAPI FederationUserAPI QuerySearchProfilesAPI // used by p2p demos QueryAccountByLocalpart(ctx context.Context, req *QueryAccountByLocalpartRequest, res *QueryAccountByLocalpartResponse) (err error) }
UserInternalAPI is the internal API for information about users and devices.
type UserLoginAPI ¶ added in v0.8.3
type UserLoginAPI interface {
QueryAccountByPassword(ctx context.Context, req *QueryAccountByPasswordRequest, res *QueryAccountByPasswordResponse) error
}