diff --git a/synapse/config/homeserver.py b/synapse/config/homeserver.py
index 3edfadb98b..967a0f45d6 100644
--- a/synapse/config/homeserver.py
+++ b/synapse/config/homeserver.py
@@ -25,12 +25,13 @@ from .voip import VoipConfig
from .registration import RegistrationConfig
from .metrics import MetricsConfig
from .appservice import AppServiceConfig
+from .key import KeyConfig
class HomeServerConfig(TlsConfig, ServerConfig, DatabaseConfig, LoggingConfig,
RatelimitConfig, ContentRepositoryConfig, CaptchaConfig,
EmailConfig, VoipConfig, RegistrationConfig,
- MetricsConfig, AppServiceConfig,):
+ MetricsConfig, AppServiceConfig, KeyConfig,):
pass
diff --git a/synapse/config/key.py b/synapse/config/key.py
new file mode 100644
index 0000000000..327105732a
--- /dev/null
+++ b/synapse/config/key.py
@@ -0,0 +1,110 @@
+# -*- coding: utf-8 -*-
+# Copyright 2015 OpenMarket 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.
+
+import os
+from ._base import Config, ConfigError
+import syutil.crypto.signing_key
+
+
+class KeyConfig(Config):
+
+ def __init__(self, args):
+ super(KeyConfig, self).__init__(args)
+ self.signing_key = self.read_signing_key(args.signing_key_path)
+ self.old_signing_keys = self.read_old_signing_keys(
+ args.old_signing_key_path
+ )
+ self.key_refresh_interval = args.key_refresh_interval
+
+ @classmethod
+ def add_arguments(cls, parser):
+ super(KeyConfig, cls).add_arguments(parser)
+ key_group = parser.add_argument_group("keys")
+ key_group.add_argument("--signing-key-path",
+ help="The signing key to sign messages with")
+ key_group.add_argument("--old-signing-key-path",
+ help="The keys that the server used to sign"
+ " sign messages with but won't use"
+ " to sign new messages. E.g. it has"
+ " lost its private key")
+ key_group.add_argument("--key-refresh-interval",
+ default=24 * 60 * 60 * 1000, # 1 Day
+ help="How long a key response is valid for."
+ " Used to set the exipiry in /key/v2/."
+ " Controls how frequently servers will"
+ " query what keys are still valid")
+
+ def read_signing_key(self, signing_key_path):
+ signing_keys = self.read_file(signing_key_path, "signing_key")
+ try:
+ return syutil.crypto.signing_key.read_signing_keys(
+ signing_keys.splitlines(True)
+ )
+ except Exception:
+ raise ConfigError(
+ "Error reading signing_key."
+ " Try running again with --generate-config"
+ )
+
+ def read_old_signing_keys(self, old_signing_key_path):
+ old_signing_keys = self.read_file(
+ old_signing_key_path, "old_signing_key"
+ )
+ try:
+ return syutil.crypto.signing_key.read_old_signing_keys(
+ old_signing_keys.splitlines(True)
+ )
+ except Exception:
+ raise ConfigError(
+ "Error reading old signing keys."
+ )
+
+ @classmethod
+ def generate_config(cls, args, config_dir_path):
+ super(KeyConfig, cls).generate_config(args, config_dir_path)
+ base_key_name = os.path.join(config_dir_path, args.server_name)
+
+ args.pid_file = os.path.abspath(args.pid_file)
+
+ if not args.signing_key_path:
+ args.signing_key_path = base_key_name + ".signing.key"
+
+ if not os.path.exists(args.signing_key_path):
+ with open(args.signing_key_path, "w") as signing_key_file:
+ syutil.crypto.signing_key.write_signing_keys(
+ signing_key_file,
+ (syutil.crypto.signing_key.generate_signing_key("auto"),),
+ )
+ else:
+ signing_keys = cls.read_file(args.signing_key_path, "signing_key")
+ if len(signing_keys.split("\n")[0].split()) == 1:
+ # handle keys in the old format.
+ key = syutil.crypto.signing_key.decode_signing_key_base64(
+ syutil.crypto.signing_key.NACL_ED25519,
+ "auto",
+ signing_keys.split("\n")[0]
+ )
+ with open(args.signing_key_path, "w") as signing_key_file:
+ syutil.crypto.signing_key.write_signing_keys(
+ signing_key_file,
+ (key,),
+ )
+
+ if not args.old_signing_key_path:
+ args.old_signing_key_path = base_key_name + ".old.signing.keys"
+
+ if not os.path.exists(args.old_signing_key_path):
+ with open(args.old_signing_key_path, "w"):
+ pass
diff --git a/synapse/config/server.py b/synapse/config/server.py
index 3ce3ed584f..c25feb4c58 100644
--- a/synapse/config/server.py
+++ b/synapse/config/server.py
@@ -13,19 +13,13 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-import os
-from ._base import Config, ConfigError
-import syutil.crypto.signing_key
+from ._base import Config
class ServerConfig(Config):
def __init__(self, args):
super(ServerConfig, self).__init__(args)
self.server_name = args.server_name
- self.signing_key = self.read_signing_key(args.signing_key_path)
- self.old_signing_keys = self.read_old_signing_keys(
- args.old_signing_key_path
- )
self.bind_port = args.bind_port
self.bind_host = args.bind_host
self.unsecure_port = args.unsecure_port
@@ -34,7 +28,6 @@ class ServerConfig(Config):
self.web_client = args.web_client
self.manhole = args.manhole
self.soft_file_limit = args.soft_file_limit
- self.key_refresh_interval = args.key_refresh_interval
if not args.content_addr:
host = args.server_name
@@ -57,19 +50,6 @@ class ServerConfig(Config):
"This is used by remote servers to connect to this server, "
"e.g. matrix.org, localhost:8080, etc."
)
- server_group.add_argument("--signing-key-path",
- help="The signing key to sign messages with")
- server_group.add_argument("--old-signing-key-path",
- help="The keys that the server used to sign"
- " sign messages with but won't use"
- " to sign new messages. E.g. it has"
- " lost its private key")
- server_group.add_argument("--key-refresh-interval",
- default=24 * 60 * 60 * 1000, # 1 Day
- help="How long a key response is valid for."
- " Used to set the exipiry in /key/v2/."
- " Controls how frequently servers will"
- " query what keys are still valid")
server_group.add_argument("-p", "--bind-port", metavar="PORT",
type=int, help="https port to listen on",
default=8448)
@@ -98,66 +78,3 @@ class ServerConfig(Config):
"Zero is used to indicate synapse "
"should set the soft limit to the hard"
"limit.")
-
- def read_signing_key(self, signing_key_path):
- signing_keys = self.read_file(signing_key_path, "signing_key")
- try:
- return syutil.crypto.signing_key.read_signing_keys(
- signing_keys.splitlines(True)
- )
- except Exception:
- raise ConfigError(
- "Error reading signing_key."
- " Try running again with --generate-config"
- )
-
- def read_old_signing_keys(self, old_signing_key_path):
- old_signing_keys = self.read_file(
- old_signing_key_path, "old_signing_key"
- )
- try:
- return syutil.crypto.signing_key.read_old_signing_keys(
- old_signing_keys.splitlines(True)
- )
- except Exception:
- raise ConfigError(
- "Error reading old signing keys."
- )
-
- @classmethod
- def generate_config(cls, args, config_dir_path):
- super(ServerConfig, cls).generate_config(args, config_dir_path)
- base_key_name = os.path.join(config_dir_path, args.server_name)
-
- args.pid_file = os.path.abspath(args.pid_file)
-
- if not args.signing_key_path:
- args.signing_key_path = base_key_name + ".signing.key"
-
- if not os.path.exists(args.signing_key_path):
- with open(args.signing_key_path, "w") as signing_key_file:
- syutil.crypto.signing_key.write_signing_keys(
- signing_key_file,
- (syutil.crypto.signing_key.generate_signing_key("auto"),),
- )
- else:
- signing_keys = cls.read_file(args.signing_key_path, "signing_key")
- if len(signing_keys.split("\n")[0].split()) == 1:
- # handle keys in the old format.
- key = syutil.crypto.signing_key.decode_signing_key_base64(
- syutil.crypto.signing_key.NACL_ED25519,
- "auto",
- signing_keys.split("\n")[0]
- )
- with open(args.signing_key_path, "w") as signing_key_file:
- syutil.crypto.signing_key.write_signing_keys(
- signing_key_file,
- (key,),
- )
-
- if not args.old_signing_key_path:
- args.old_signing_key_path = base_key_name + ".old.signing.keys"
-
- if not os.path.exists(args.old_signing_key_path):
- with open(args.old_signing_key_path, "w"):
- pass
|
