From 063da2dc5681b7e672d53cd859e5854825cd9d1b Mon Sep 17 00:00:00 2001 From: Mark Haines Date: Mon, 12 Jun 2017 16:39:53 +0100 Subject: [PATCH] Move all the dendrite config in to a single place --- .../dendrite/common/config/config.go | 335 ++++++++++++++++++ 1 file changed, 335 insertions(+) create mode 100644 src/github.com/matrix-org/dendrite/common/config/config.go diff --git a/src/github.com/matrix-org/dendrite/common/config/config.go b/src/github.com/matrix-org/dendrite/common/config/config.go new file mode 100644 index 000000000..8a52dd52e --- /dev/null +++ b/src/github.com/matrix-org/dendrite/common/config/config.go @@ -0,0 +1,335 @@ +// Copyright 2017 Vector Creations Ltd +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package config + +import ( + "bytes" + "crypto/sha256" + "encoding/base64" + "encoding/pem" + "fmt" + "github.com/matrix-org/gomatrixserverlib" + "golang.org/x/crypto/ed25519" + "gopkg.in/yaml.v2" + "io" + "io/ioutil" + "path/filepath" + "strings" + "time" +) + +// Version is the current version of the config format. +// This will change whenever we make breaking changes to the config format. +const Version = "0" + +// Dendrite contains all the config used by a dendrite process. +type Dendrite struct { + // The version of the configuration file. + Version string `yaml:"version"` + + // The configuration required for a matrix server. + Matrix struct { + // The name of the server. This is usually the domain name, e.g 'matrix.org', 'localhost'. + ServerName gomatrixserverlib.ServerName `yaml:"server_name"` + // Path to the private key which will be used to sign requests and events. + // The path may be relative or absolute. + // Relative paths are resolved relative to the directory containing the config file. + PrivateKeyPath Path `yaml:"private_key"` + // 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. + // The path may be relative or absolute. + // Relative paths are resolved relative to the directory containing the config file. + FederationCertificatePaths []Path `yaml:"federation_certificates"` + // The private key which will be used to sign requests and events. + PrivateKey ed25519.PrivateKey `yaml:"-"` + // An arbitrary string used to uniquely identify the PrivateKey. Must start with the + // prefix "ed25519:". + KeyID gomatrixserverlib.KeyID `yaml:"-"` + // A list of SHA256 TLS fingerprints for the X509 certificates used by the + // federation listener for this server. + TLSFingerPrints []gomatrixserverlib.TLSFingerprint `yaml:"-"` + // How long a remote server can cache our server key for before requesting it again. + // Increasing this number will reduce the number of requests made by remote servers + // for our key, but increases the period a compromised key will be considered valid + // by remote servers. + KeyValidityPeriod time.Duration `yaml:"key_validity_period"` + } `yaml:"matrix"` + + // The configuration specific to the media repostitory. + Media struct { + // The base path to where the media files will be stored. May be relative or absolute. + // Relative paths are resolved relative to the directory containing the config file. + BasePath Path `yaml:"base_path"` + // The absolute base path to where media files will be stored. + AbsBasePath Path `yaml:"-"` + // The maximum file size in bytes that is allowed to be stored on this server. + // Note: if max_file_size_bytes is set to 0, the size is unlimited. + // Note: if max_file_size_bytes is not set, it will default to 10485760 (10MB) + MaxFileSizeBytes *FileSizeBytes `yaml:"max_file_size_bytes,omitempty"` + // Whether to dynamically generate thumbnails on-the-fly if the requested resolution is not already generated + DynamicThumbnails bool `yaml:"dynamic_thumbnails"` + // The maximum number of simultaneous thumbnail generators. default: 10 + MaxThumbnailGenerators int `yaml:"max_thumbnail_generators"` + // A list of thumbnail sizes to be pre-generated for downloaded remote / uploaded content + ThumbnailSizes []ThumbnailSize `yaml:"thumbnail_sizes"` + } `yaml:"media"` + + // The configuration for talking to kafka. + Kafka struct { + // A list of kafka addresses to connect to. + Addresses []Address `yaml:"addresses"` + // The names of the topics to use when reading and writing from kafka. + Topics struct { + // Topic for roomserver/api.InputRoomEvent events. + InputRoomEvent Topic `yaml:"input_room_event"` + // Topic for roomserver/api.OutputRoomEvent events. + OuputRoomEvent Topic `yaml:"output_room_event"` + } + } `yaml:"kafka"` + + // Postgres Config + Database struct { + Media DataSource `yaml:"media"` + Account DataSource `yaml:"account"` + ServerKeys DataSource `yaml:"server_keys"` + Sync DataSource `yaml:"sync"` + Roomserver DataSource `yaml:"roomserver"` + } `yaml:"database"` + + // The internal addresses the components will listen on. + // These should not be exposed externally as they expose metrics and debugging APIs. + Listen struct { + MediaAPI Address `yaml:"media_api"` + ClientAPI Address `yaml:"client_api"` + FederationAPI Address `yaml:"federation_api"` + SyncAPI Address `yaml:"sync_api"` + Roomserver Address `yaml:"roomserver"` + } `yaml:"listen"` +} + +// A Path on the filesystem. +type Path string + +// A DataSource for opening a postgresql database using lib/pq. +type DataSource string + +// A Topic in kafka. +type Topic string + +// An Address to listen on. +type Address string + +// FileSizeBytes is a file size in bytes +type FileSizeBytes int64 + +// ThumbnailSize contains a single thumbnail size configuration +type ThumbnailSize struct { + // Maximum width of the thumbnail image + Width int `yaml:"width"` + // Maximum height of the thumbnail image + Height int `yaml:"height"` + // ResizeMethod is one of crop or scale. + // crop scales to fill the requested dimensions and crops the excess. + // scale scales to fit the requested dimensions and one dimension may be smaller than requested. + ResizeMethod string `yaml:"method,omitempty"` +} + +// Load a yaml config file +func Load(configPath string) (*Dendrite, error) { + configData, err := ioutil.ReadFile(configPath) + if err != nil { + return nil, err + } + configDirPath, err := filepath.Abs(filepath.Dir(configPath)) + if err != nil { + return nil, err + } + return loadConfig(configDirPath, configData, ioutil.ReadFile) +} + +// An Error indicates a problem parsing the config. +type Error struct { + // List of problems encountered parsing the config. + Problems []string +} + +func loadConfig( + configDirPath string, + configData []byte, + readFile func(string) ([]byte, error), +) (*Dendrite, error) { + var config Dendrite + var err error + if err = yaml.Unmarshal(configData, &config); err != nil { + return nil, err + } + + if err = config.check(); err != nil { + return nil, err + } + + privateKeyPath := absPath(configDirPath, config.Matrix.PrivateKeyPath) + privateKeyData, err := readFile(privateKeyPath) + if err != nil { + return nil, err + } + + if config.Matrix.KeyID, config.Matrix.PrivateKey, err = readKey(string(privateKeyData)); err != nil { + return nil, err + } + + for _, certPath := range config.Matrix.FederationCertificatePaths { + pemData, err := readFile(absPath(configDirPath, certPath)) + if err != nil { + return nil, err + } + fingerprint := fingerprintPEM(pemData) + if fingerprint == nil { + return nil, fmt.Errorf("no certificate PEM data in %q", certPath) + } + config.Matrix.TLSFingerPrints = append(config.Matrix.TLSFingerPrints, *fingerprint) + } + + config.Media.AbsBasePath = Path(absPath(configDirPath, config.Media.BasePath)) + + return &config, nil +} + +func (config *Dendrite) setDefaults() { + if config.Matrix.KeyValidityPeriod == 0 { + config.Matrix.KeyValidityPeriod = 24 * time.Hour + } + + if config.Media.MaxThumbnailGenerators == 0 { + config.Media.MaxThumbnailGenerators = 10 + } + + if config.Media.MaxFileSizeBytes == nil { + defaultMaxFileSizeBytes := FileSizeBytes(10485760) + config.Media.MaxFileSizeBytes = &defaultMaxFileSizeBytes + } +} + +func (e Error) Error() string { + if len(e.Problems) == 1 { + return e.Problems[0] + } + return fmt.Sprintf( + "%s (and %d other problems)", e.Problems[0], len(e.Problems)-1, + ) +} + +func (config *Dendrite) check() error { + var problems []string + + if config.Version != Version { + return Error{[]string{fmt.Sprintf( + "unknown config version %q, expected %q", config.Version, Version, + )}} + } + + checkNotEmpty := func(key string, value string) { + if value == "" { + problems = append(problems, fmt.Sprintf("missing config key %q", key)) + } + } + + checkNotZero := func(key string, value int) { + if value == 0 { + problems = append(problems, fmt.Sprintf("missing config key %q", key)) + } + } + + checkNotEmpty("matrix.server_name", string(config.Matrix.ServerName)) + checkNotEmpty("matrix.private_key", string(config.Matrix.PrivateKeyPath)) + checkNotZero("matrix.federation_certificates", len(config.Matrix.FederationCertificatePaths)) + checkNotEmpty("media.base_path", string(config.Media.BasePath)) + checkNotEmpty("kafka.topics.input_room_event", string(config.Kafka.Topics.InputRoomEvent)) + checkNotEmpty("kafka.topics.output_room_event", string(config.Kafka.Topics.InputRoomEvent)) + checkNotEmpty("database.media", string(config.Database.Media)) + checkNotEmpty("database.account", string(config.Database.Account)) + checkNotEmpty("database.server_keys", string(config.Database.ServerKeys)) + checkNotEmpty("database.sync", string(config.Database.Sync)) + checkNotEmpty("database.roomserver", string(config.Database.Roomserver)) + checkNotEmpty("listen.media_api", string(config.Listen.MediaAPI)) + checkNotEmpty("listen.client_api", string(config.Listen.ClientAPI)) + checkNotEmpty("listen.federation_api", string(config.Listen.FederationAPI)) + checkNotEmpty("listen.sync_api", string(config.Listen.SyncAPI)) + checkNotEmpty("listen.roomserver", string(config.Listen.Roomserver)) + + if problems != nil { + return Error{problems} + } + + return nil +} + +func absPath(dir string, path Path) string { + if filepath.IsAbs(string(path)) { + return filepath.Clean(string(path)) + } + return filepath.Join(dir, string(path)) +} + +func loadPrivateKey(path string) (gomatrixserverlib.KeyID, ed25519.PrivateKey, error) { + keyData, err := ioutil.ReadFile(path) + if err != nil { + return "", nil, err + } + return readKey(string(keyData)) +} + +// readKey reads a server's private ed25519 key. +// Otherwise the key is the key ID and the base64 encoded private key +// separated by a single space character. +// E.g "ed25519:abcd ABCDEFGHIJKLMNOPabcdefghijklmnop01234567890" +func readKey(key string) (gomatrixserverlib.KeyID, ed25519.PrivateKey, error) { + var keyID gomatrixserverlib.KeyID + var seed io.Reader + // TODO: We should be reading this from a PEM formatted file instead of + // our own custom format. + parts := strings.SplitN(strings.TrimRight(key, "\n"), " ", 2) + keyID = gomatrixserverlib.KeyID(parts[0]) + if len(parts) != 2 { + return "", nil, fmt.Errorf("Invalid server key: %q", key) + } + seedBytes, err := base64.RawStdEncoding.DecodeString(parts[1]) + if err != nil { + return "", nil, err + } + seed = bytes.NewReader(seedBytes) + _, privKey, err := ed25519.GenerateKey(seed) + if err != nil { + return "", nil, err + } + return keyID, privKey, nil +} + +func fingerprintPEM(data []byte) *gomatrixserverlib.TLSFingerprint { + for { + var certDERBlock *pem.Block + certDERBlock, data = pem.Decode(data) + if data == nil { + return nil + } + if certDERBlock.Type == "CERTIFICATE" { + digest := sha256.Sum256(certDERBlock.Bytes) + return &gomatrixserverlib.TLSFingerprint{digest[:]} + } + } +}