Class RemoteDevices

End-to-end encryption with other servers' users: their device and one-time keys from their servers, and to-device messages to them, such as room keys, as m.direct_to_device EDUs.

Inheritance
object
RemoteDevices
Inherited Members
Namespace: Uniform.Matrix.Server.Federation
Assembly: Uniform.Matrix.Server.dll
Syntax
public sealed class RemoteDevices
Remarks

Keys of remote users are asked for on each query and not cached. A server that cannot be reached is listed in failures, as the spec says.

Constructors

| Edit this page View Source

RemoteDevices(DeviceKeyService, FederationClient, FederationQueue, IDbContextFactory<ServerDbContext>, ServerStream, IOptionsMonitor<ServerOptions>, IOptionsMonitor<FederationOptions>, TimeProvider, ILogger<RemoteDevices>)

Create the service.

Declaration
public RemoteDevices(DeviceKeyService keys, FederationClient federation, FederationQueue queue, IDbContextFactory<ServerDbContext> contexts, ServerStream stream, IOptionsMonitor<ServerOptions> server, IOptionsMonitor<FederationOptions> options, TimeProvider time, ILogger<RemoteDevices> logger)
Parameters
Type Name Description
DeviceKeyService keys
FederationClient federation
FederationQueue queue
IDbContextFactory<ServerDbContext> contexts
ServerStream stream
IOptionsMonitor<ServerOptions> server
IOptionsMonitor<FederationOptions> options
TimeProvider time
ILogger<RemoteDevices> logger

Methods

| Edit this page View Source

ClaimAsync(JsonObject, CancellationToken)

Claim one-time keys, local ones here and others from their servers, as /keys/claim answers.

Declaration
public Task<JsonObject> ClaimAsync(JsonObject request, CancellationToken cancellationToken)
Parameters
Type Name Description
JsonObject request
CancellationToken cancellationToken
Returns
Type Description
Task<JsonObject>
| Edit this page View Source

GetUserDevicesAsync(string, CancellationToken)

Return the devices of a local user as /_matrix/federation/v1/user/devices answers, for other servers that resync after a change.

Declaration
public Task<JsonObject> GetUserDevicesAsync(string userId, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
CancellationToken cancellationToken
Returns
Type Description
Task<JsonObject>
| Edit this page View Source

QueryAsync(string, JsonObject, CancellationToken)

Return the keys of the queried users, local ones from here and others from their servers, as /keys/query answers.

Declaration
public Task<JsonObject> QueryAsync(string requesterId, JsonObject query, CancellationToken cancellationToken)
Parameters
Type Name Description
string requesterId
JsonObject query
CancellationToken cancellationToken
Returns
Type Description
Task<JsonObject>
| Edit this page View Source

ReceiveDeviceListUpdateAsync(string, JsonObject, CancellationToken)

Note an m.device_list_update EDU: the remote user's devices changed, so local users sharing a room with them are told in sync.

Declaration
public Task ReceiveDeviceListUpdateAsync(string origin, JsonObject content, CancellationToken cancellationToken)
Parameters
Type Name Description
string origin
JsonObject content
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

ReceiveToDeviceAsync(string, JsonObject, CancellationToken)

Queue the to-device messages of an m.direct_to_device EDU from origin for local devices.

Declaration
public Task ReceiveToDeviceAsync(string origin, JsonObject content, CancellationToken cancellationToken)
Parameters
Type Name Description
string origin
JsonObject content
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SendToDeviceAsync(string, string, string, JsonObject, CancellationToken)

Queue the remote users' part of a to-device request for their servers, one EDU per server.

Declaration
public Task SendToDeviceAsync(string sender, string type, string messageId, JsonObject messages, CancellationToken cancellationToken)
Parameters
Type Name Description
string sender
string type
string messageId
JsonObject messages
CancellationToken cancellationToken
Returns
Type Description
Task