mirror of
https://github.com/matrix-org/dendrite
synced 2024-09-08 04:05:42 +02:00
* Rename serverkeyapi to signingkeyserver We use "api" for public facing stuff and "server" for internal stuff. As the server key API is internal only, we call it 'signing key server', which also clarifies the type of key (as opposed to TLS keys, E2E keys, etc) * Convert docker/scripts to use signing-key-server * Rename missed bits
212 lines
7.1 KiB
Go
212 lines
7.1 KiB
Go
// 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 test
|
|
|
|
import (
|
|
"crypto/rand"
|
|
"crypto/rsa"
|
|
"crypto/x509"
|
|
"encoding/base64"
|
|
"encoding/pem"
|
|
"fmt"
|
|
"io/ioutil"
|
|
"math/big"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/matrix-org/dendrite/internal/config"
|
|
"github.com/matrix-org/gomatrixserverlib"
|
|
"gopkg.in/yaml.v2"
|
|
)
|
|
|
|
const (
|
|
// ConfigFile is the name of the config file for a server.
|
|
ConfigFile = "dendrite.yaml"
|
|
// ServerKeyFile is the name of the file holding the matrix server private key.
|
|
ServerKeyFile = "server_key.pem"
|
|
// TLSCertFile is the name of the file holding the TLS certificate used for federation.
|
|
TLSCertFile = "tls_cert.pem"
|
|
// TLSKeyFile is the name of the file holding the TLS key used for federation.
|
|
TLSKeyFile = "tls_key.pem"
|
|
// MediaDir is the name of the directory used to store media.
|
|
MediaDir = "media"
|
|
)
|
|
|
|
// MakeConfig makes a config suitable for running integration tests.
|
|
// Generates new matrix and TLS keys for the server.
|
|
func MakeConfig(configDir, kafkaURI, database, host string, startPort int) (*config.Dendrite, int, error) {
|
|
var cfg config.Dendrite
|
|
cfg.Defaults()
|
|
|
|
port := startPort
|
|
assignAddress := func() config.HTTPAddress {
|
|
result := config.HTTPAddress(fmt.Sprintf("http://%s:%d", host, port))
|
|
port++
|
|
return result
|
|
}
|
|
|
|
serverKeyPath := filepath.Join(configDir, ServerKeyFile)
|
|
tlsCertPath := filepath.Join(configDir, TLSKeyFile)
|
|
tlsKeyPath := filepath.Join(configDir, TLSCertFile)
|
|
mediaBasePath := filepath.Join(configDir, MediaDir)
|
|
|
|
if err := NewMatrixKey(serverKeyPath); err != nil {
|
|
return nil, 0, err
|
|
}
|
|
|
|
if err := NewTLSKey(tlsKeyPath, tlsCertPath); err != nil {
|
|
return nil, 0, err
|
|
}
|
|
|
|
cfg.Version = config.Version
|
|
|
|
cfg.Global.ServerName = gomatrixserverlib.ServerName(assignAddress())
|
|
cfg.Global.PrivateKeyPath = config.Path(serverKeyPath)
|
|
|
|
cfg.FederationAPI.FederationCertificatePaths = []config.Path{config.Path(tlsCertPath)}
|
|
|
|
cfg.MediaAPI.BasePath = config.Path(mediaBasePath)
|
|
|
|
cfg.Global.Kafka.Addresses = []string{kafkaURI}
|
|
|
|
// TODO: Use different databases for the different schemas.
|
|
// Using the same database for every schema currently works because
|
|
// the table names are globally unique. But we might not want to
|
|
// rely on that in the future.
|
|
cfg.AppServiceAPI.Database.ConnectionString = config.DataSource(database)
|
|
cfg.FederationSender.Database.ConnectionString = config.DataSource(database)
|
|
cfg.KeyServer.Database.ConnectionString = config.DataSource(database)
|
|
cfg.MediaAPI.Database.ConnectionString = config.DataSource(database)
|
|
cfg.RoomServer.Database.ConnectionString = config.DataSource(database)
|
|
cfg.SigningKeyServer.Database.ConnectionString = config.DataSource(database)
|
|
cfg.SyncAPI.Database.ConnectionString = config.DataSource(database)
|
|
cfg.UserAPI.AccountDatabase.ConnectionString = config.DataSource(database)
|
|
cfg.UserAPI.DeviceDatabase.ConnectionString = config.DataSource(database)
|
|
|
|
cfg.AppServiceAPI.InternalAPI.Listen = assignAddress()
|
|
cfg.EDUServer.InternalAPI.Listen = assignAddress()
|
|
cfg.FederationAPI.InternalAPI.Listen = assignAddress()
|
|
cfg.FederationSender.InternalAPI.Listen = assignAddress()
|
|
cfg.KeyServer.InternalAPI.Listen = assignAddress()
|
|
cfg.MediaAPI.InternalAPI.Listen = assignAddress()
|
|
cfg.RoomServer.InternalAPI.Listen = assignAddress()
|
|
cfg.SigningKeyServer.InternalAPI.Listen = assignAddress()
|
|
cfg.SyncAPI.InternalAPI.Listen = assignAddress()
|
|
cfg.UserAPI.InternalAPI.Listen = assignAddress()
|
|
|
|
cfg.AppServiceAPI.InternalAPI.Connect = cfg.AppServiceAPI.InternalAPI.Listen
|
|
cfg.EDUServer.InternalAPI.Connect = cfg.EDUServer.InternalAPI.Listen
|
|
cfg.FederationAPI.InternalAPI.Connect = cfg.FederationAPI.InternalAPI.Listen
|
|
cfg.FederationSender.InternalAPI.Connect = cfg.FederationSender.InternalAPI.Listen
|
|
cfg.KeyServer.InternalAPI.Connect = cfg.KeyServer.InternalAPI.Listen
|
|
cfg.MediaAPI.InternalAPI.Connect = cfg.MediaAPI.InternalAPI.Listen
|
|
cfg.RoomServer.InternalAPI.Connect = cfg.RoomServer.InternalAPI.Listen
|
|
cfg.SigningKeyServer.InternalAPI.Connect = cfg.SigningKeyServer.InternalAPI.Listen
|
|
cfg.SyncAPI.InternalAPI.Connect = cfg.SyncAPI.InternalAPI.Listen
|
|
cfg.UserAPI.InternalAPI.Connect = cfg.UserAPI.InternalAPI.Listen
|
|
|
|
return &cfg, port, nil
|
|
}
|
|
|
|
// WriteConfig writes the config file to the directory.
|
|
func WriteConfig(cfg *config.Dendrite, configDir string) error {
|
|
data, err := yaml.Marshal(cfg)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return ioutil.WriteFile(filepath.Join(configDir, ConfigFile), data, 0666)
|
|
}
|
|
|
|
// NewMatrixKey generates a new ed25519 matrix server key and writes it to a file.
|
|
func NewMatrixKey(matrixKeyPath string) (err error) {
|
|
var data [35]byte
|
|
_, err = rand.Read(data[:])
|
|
if err != nil {
|
|
return err
|
|
}
|
|
keyOut, err := os.OpenFile(matrixKeyPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
defer (func() {
|
|
err = keyOut.Close()
|
|
})()
|
|
|
|
keyID := base64.RawURLEncoding.EncodeToString(data[:])
|
|
keyID = strings.ReplaceAll(keyID, "-", "")
|
|
keyID = strings.ReplaceAll(keyID, "_", "")
|
|
|
|
err = pem.Encode(keyOut, &pem.Block{
|
|
Type: "MATRIX PRIVATE KEY",
|
|
Headers: map[string]string{
|
|
"Key-ID": fmt.Sprintf("ed25519:%s", keyID[:6]),
|
|
},
|
|
Bytes: data[3:],
|
|
})
|
|
return err
|
|
}
|
|
|
|
const certificateDuration = time.Hour * 24 * 365 * 10
|
|
|
|
// NewTLSKey generates a new RSA TLS key and certificate and writes it to a file.
|
|
func NewTLSKey(tlsKeyPath, tlsCertPath string) error {
|
|
priv, err := rsa.GenerateKey(rand.Reader, 4096)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
notBefore := time.Now()
|
|
notAfter := notBefore.Add(certificateDuration)
|
|
serialNumberLimit := new(big.Int).Lsh(big.NewInt(1), 128)
|
|
serialNumber, err := rand.Int(rand.Reader, serialNumberLimit)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
template := x509.Certificate{
|
|
SerialNumber: serialNumber,
|
|
NotBefore: notBefore,
|
|
NotAfter: notAfter,
|
|
KeyUsage: x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature,
|
|
ExtKeyUsage: []x509.ExtKeyUsage{x509.ExtKeyUsageServerAuth},
|
|
BasicConstraintsValid: true,
|
|
}
|
|
derBytes, err := x509.CreateCertificate(rand.Reader, &template, &template, &priv.PublicKey, priv)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
certOut, err := os.Create(tlsCertPath)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer certOut.Close() // nolint: errcheck
|
|
if err = pem.Encode(certOut, &pem.Block{Type: "CERTIFICATE", Bytes: derBytes}); err != nil {
|
|
return err
|
|
}
|
|
|
|
keyOut, err := os.OpenFile(tlsKeyPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer keyOut.Close() // nolint: errcheck
|
|
err = pem.Encode(keyOut, &pem.Block{
|
|
Type: "RSA PRIVATE KEY",
|
|
Bytes: x509.MarshalPKCS1PrivateKey(priv),
|
|
})
|
|
return err
|
|
}
|