Class RemoteServerKeys

Other servers' signing keys: fetched from each server's /_matrix/key/v2/server, else from the TrustedKeyServers, and kept in the database until their valid_until_ts, at most a week.

Inheritance

object

RemoteServerKeys

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Server.Federation

Assembly: Uniform.Matrix.Server.dll

Syntax

public sealed class RemoteServerKeys

Remarks

An answer counts only when every key it lists has signed it, and an answer from a key server also needs that server's signature. Old keys (old_verify_keys) are accepted too, as events signed with them stay valid. When a server and the key servers cannot be reached, its last kept answer is used even after it expired, as refusing every event of a server that is down helps no one; such a server is not asked again for a few minutes, and each server is asked once at a time.

Constructors

RemoteServerKeys(FederationClient, ServerKeys, IDbContextFactory<ServerDbContext>, IOptionsMonitor<ServerOptions>, IOptionsMonitor<FederationOptions>, TimeProvider, ILogger<RemoteServerKeys>)

Create the cache.

Declaration

public RemoteServerKeys(FederationClient federation, ServerKeys ownKeys, IDbContextFactory<ServerDbContext> contexts, IOptionsMonitor<ServerOptions> server, IOptionsMonitor<FederationOptions> options, TimeProvider time, ILogger<RemoteServerKeys> logger)

Parameters

Type	Name	Description
FederationClient	federation
ServerKeys	ownKeys
IDbContextFactory<ServerDbContext>	contexts
IOptionsMonitor<ServerOptions>	server
IOptionsMonitor<FederationOptions>	options
TimeProvider	time
ILogger<RemoteServerKeys>	logger

Methods

GetResponseAsync(string, CancellationToken)

Return the kept, validated key answer of serverName, fetching it when there is none or it expired; null when none can be had. Used to answer /_matrix/key/v2/query as a key server.

Declaration

public Task<JsonObject?> GetResponseAsync(string serverName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	serverName
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonObject>

GetVerifyKeyAsync(string, string, CancellationToken)

Return the public key keyId of serverName, fetching the server's keys when not known or expired; null when the server does not have it or no answer can be had.

Declaration

public Task<string?> GetVerifyKeyAsync(string serverName, string keyId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	serverName
string	keyId
CancellationToken	cancellationToken

Returns

Type	Description
Task<string>

PrefetchAsync(IEnumerable<string>, CancellationToken)

Fetch the keys of serverNames that are not kept or have expired, e.g. before checking the many events of a joined room: from the TrustedKeyServers in batches first, then from each remaining server, several at a time.

Declaration

public Task PrefetchAsync(IEnumerable<string> serverNames, CancellationToken cancellationToken)

Parameters

Type	Name	Description
IEnumerable<string>	serverNames
CancellationToken	cancellationToken

Returns

Type	Description
Task