mirror of
https://github.com/matrix-org/dendrite
synced 2024-12-21 03:23:46 +01:00
107 lines
3.8 KiB
Go
107 lines
3.8 KiB
Go
package config
|
|
|
|
import "github.com/matrix-org/gomatrixserverlib"
|
|
|
|
type FederationAPI struct {
|
|
Matrix *Global `yaml:"-"`
|
|
|
|
InternalAPI InternalAPIOptions `yaml:"internal_api"`
|
|
ExternalAPI ExternalAPIOptions `yaml:"external_api"`
|
|
|
|
// The database stores information used by the federation destination queues to
|
|
// send transactions to remote servers.
|
|
Database DatabaseOptions `yaml:"database"`
|
|
|
|
// List of paths to X509 certificates used by the external federation listeners.
|
|
// These are used to calculate the TLS fingerprints to publish for this server.
|
|
// Other matrix servers talking to this server will expect the x509 certificate
|
|
// to match one of these certificates.
|
|
// The certificates should be in PEM format.
|
|
FederationCertificatePaths []Path `yaml:"federation_certificates"`
|
|
|
|
// Federation failure threshold. How many consecutive failures that we should
|
|
// tolerate when sending federation requests to a specific server. The backoff
|
|
// is 2**x seconds, so 1 = 2 seconds, 2 = 4 seconds, 3 = 8 seconds, etc.
|
|
// The default value is 16 if not specified, which is circa 18 hours.
|
|
FederationMaxRetries uint32 `yaml:"send_max_retries"`
|
|
|
|
// FederationDisableTLSValidation disables the validation of X.509 TLS certs
|
|
// on remote federation endpoints. This is not recommended in production!
|
|
DisableTLSValidation bool `yaml:"disable_tls_validation"`
|
|
|
|
Proxy Proxy `yaml:"proxy_outbound"`
|
|
|
|
// Perspective keyservers, to use as a backup when direct key fetch
|
|
// requests don't succeed
|
|
KeyPerspectives KeyPerspectives `yaml:"key_perspectives"`
|
|
|
|
// Should we prefer direct key fetches over perspective ones?
|
|
PreferDirectFetch bool `yaml:"prefer_direct_fetch"`
|
|
}
|
|
|
|
func (c *FederationAPI) Defaults(generate bool) {
|
|
c.InternalAPI.Listen = "http://localhost:7772"
|
|
c.InternalAPI.Connect = "http://localhost:7772"
|
|
c.ExternalAPI.Listen = "http://[::]:8072"
|
|
c.Database.Defaults(10)
|
|
if generate {
|
|
c.Database.ConnectionString = "file:federationapi.db"
|
|
}
|
|
|
|
c.FederationMaxRetries = 16
|
|
c.DisableTLSValidation = false
|
|
|
|
c.Proxy.Defaults()
|
|
}
|
|
|
|
func (c *FederationAPI) Verify(configErrs *ConfigErrors, isMonolith bool) {
|
|
checkURL(configErrs, "federation_api.internal_api.listen", string(c.InternalAPI.Listen))
|
|
checkURL(configErrs, "federation_api.internal_api.connect", string(c.InternalAPI.Connect))
|
|
if !isMonolith {
|
|
checkURL(configErrs, "federation_api.external_api.listen", string(c.ExternalAPI.Listen))
|
|
}
|
|
checkNotEmpty(configErrs, "federation_api.database.connection_string", string(c.Database.ConnectionString))
|
|
// TODO: not applicable always, e.g. in demos
|
|
//checkNotZero(configErrs, "federation_api.federation_certificates", int64(len(c.FederationCertificatePaths)))
|
|
}
|
|
|
|
// The config for setting a proxy to use for server->server requests
|
|
type Proxy struct {
|
|
// Is the proxy enabled?
|
|
Enabled bool `yaml:"enabled"`
|
|
// The protocol for the proxy (http / https / socks5)
|
|
Protocol string `yaml:"protocol"`
|
|
// The host where the proxy is listening
|
|
Host string `yaml:"host"`
|
|
// The port on which the proxy is listening
|
|
Port uint16 `yaml:"port"`
|
|
}
|
|
|
|
func (c *Proxy) Defaults() {
|
|
c.Enabled = false
|
|
c.Protocol = "http"
|
|
c.Host = "localhost"
|
|
c.Port = 8080
|
|
}
|
|
|
|
func (c *Proxy) Verify(configErrs *ConfigErrors) {
|
|
}
|
|
|
|
// KeyPerspectives are used to configure perspective key servers for
|
|
// retrieving server keys.
|
|
type KeyPerspectives []KeyPerspective
|
|
|
|
type KeyPerspective struct {
|
|
// The server name of the perspective key server
|
|
ServerName gomatrixserverlib.ServerName `yaml:"server_name"`
|
|
// Server keys for the perspective user, used to verify the
|
|
// keys have been signed by the perspective server
|
|
Keys []KeyPerspectiveTrustKey `yaml:"keys"`
|
|
}
|
|
|
|
type KeyPerspectiveTrustKey struct {
|
|
// The key ID, e.g. ed25519:auto
|
|
KeyID gomatrixserverlib.KeyID `yaml:"key_id"`
|
|
// The public key in base64 unpadded format
|
|
PublicKey string `yaml:"public_key"`
|
|
}
|