2017-08-17 11:54:27 -04:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# Copyright 2015, 2016 OpenMarket Ltd
|
|
|
|
# Copyright 2017 New Vector 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.
|
|
|
|
|
2021-12-02 10:18:40 -05:00
|
|
|
|
|
|
|
"""
|
|
|
|
Script for signing and sending federation requests.
|
|
|
|
|
|
|
|
Some tips on doing the join dance with this:
|
|
|
|
|
|
|
|
room_id=...
|
|
|
|
user_id=...
|
|
|
|
|
|
|
|
# make_join
|
|
|
|
federation_client.py "/_matrix/federation/v1/make_join/$room_id/$user_id?ver=5" > make_join.json
|
|
|
|
|
|
|
|
# sign
|
|
|
|
jq -M .event make_join.json | sign_json --sign-event-room-version=$(jq -r .room_version make_join.json) -o signed-join.json
|
|
|
|
|
|
|
|
# send_join
|
|
|
|
federation_client.py -X PUT "/_matrix/federation/v2/send_join/$room_id/x" --body $(<signed-join.json) > send_join.json
|
|
|
|
"""
|
|
|
|
|
2017-08-17 11:54:27 -04:00
|
|
|
import argparse
|
2018-10-19 20:16:55 -04:00
|
|
|
import base64
|
|
|
|
import json
|
|
|
|
import sys
|
2020-08-26 09:11:38 -04:00
|
|
|
from typing import Any, Optional
|
2020-06-16 08:51:47 -04:00
|
|
|
from urllib import parse as urlparse
|
2018-06-07 13:14:08 -04:00
|
|
|
|
2015-05-06 06:46:02 -04:00
|
|
|
import requests
|
2021-03-18 17:12:07 -04:00
|
|
|
import signedjson.key
|
2020-08-26 09:11:38 -04:00
|
|
|
import signedjson.types
|
2015-05-06 06:46:02 -04:00
|
|
|
import srvlookup
|
2017-08-17 11:54:27 -04:00
|
|
|
import yaml
|
2018-10-19 20:16:55 -04:00
|
|
|
from requests.adapters import HTTPAdapter
|
2015-05-06 06:46:02 -04:00
|
|
|
|
2018-06-07 13:14:08 -04:00
|
|
|
# uncomment the following to enable debug logging of http requests
|
2018-10-19 20:16:55 -04:00
|
|
|
# from httplib import HTTPConnection
|
|
|
|
# HTTPConnection.debuglevel = 1
|
|
|
|
|
2018-06-07 13:14:08 -04:00
|
|
|
|
2015-05-06 06:46:02 -04:00
|
|
|
def encode_base64(input_bytes):
|
|
|
|
"""Encode bytes as a base64 string without any padding."""
|
|
|
|
|
|
|
|
input_len = len(input_bytes)
|
|
|
|
output_len = 4 * ((input_len + 2) // 3) + (input_len + 2) % 3 - 2
|
|
|
|
output_bytes = base64.b64encode(input_bytes)
|
|
|
|
output_string = output_bytes[:output_len].decode("ascii")
|
|
|
|
return output_string
|
|
|
|
|
|
|
|
|
|
|
|
def encode_canonical_json(value):
|
|
|
|
return json.dumps(
|
2018-10-19 20:16:55 -04:00
|
|
|
value,
|
|
|
|
# Encode code-points outside of ASCII as UTF-8 rather than \u escapes
|
|
|
|
ensure_ascii=False,
|
|
|
|
# Remove unecessary white space.
|
2019-06-20 05:32:02 -04:00
|
|
|
separators=(",", ":"),
|
2018-10-19 20:16:55 -04:00
|
|
|
# Sort the keys of dictionaries.
|
|
|
|
sort_keys=True,
|
|
|
|
# Encode the resulting unicode as UTF-8 bytes.
|
|
|
|
).encode("UTF-8")
|
2015-05-06 06:46:02 -04:00
|
|
|
|
|
|
|
|
2020-08-26 09:11:38 -04:00
|
|
|
def sign_json(
|
|
|
|
json_object: Any, signing_key: signedjson.types.SigningKey, signing_name: str
|
|
|
|
) -> Any:
|
2015-05-06 06:46:02 -04:00
|
|
|
signatures = json_object.pop("signatures", {})
|
|
|
|
unsigned = json_object.pop("unsigned", None)
|
|
|
|
|
|
|
|
signed = signing_key.sign(encode_canonical_json(json_object))
|
|
|
|
signature_base64 = encode_base64(signed.signature)
|
|
|
|
|
|
|
|
key_id = "%s:%s" % (signing_key.alg, signing_key.version)
|
|
|
|
signatures.setdefault(signing_name, {})[key_id] = signature_base64
|
|
|
|
|
|
|
|
json_object["signatures"] = signatures
|
|
|
|
if unsigned is not None:
|
|
|
|
json_object["unsigned"] = unsigned
|
|
|
|
|
|
|
|
return json_object
|
|
|
|
|
|
|
|
|
2020-08-26 09:11:38 -04:00
|
|
|
def request(
|
|
|
|
method: Optional[str],
|
|
|
|
origin_name: str,
|
|
|
|
origin_key: signedjson.types.SigningKey,
|
|
|
|
destination: str,
|
|
|
|
path: str,
|
|
|
|
content: Optional[str],
|
|
|
|
) -> requests.Response:
|
2017-11-27 05:06:59 -05:00
|
|
|
if method is None:
|
|
|
|
if content is None:
|
|
|
|
method = "GET"
|
|
|
|
else:
|
|
|
|
method = "POST"
|
|
|
|
|
|
|
|
json_to_sign = {
|
|
|
|
"method": method,
|
2015-05-06 06:46:02 -04:00
|
|
|
"uri": path,
|
|
|
|
"origin": origin_name,
|
|
|
|
"destination": destination,
|
|
|
|
}
|
|
|
|
|
2017-11-27 05:06:59 -05:00
|
|
|
if content is not None:
|
|
|
|
json_to_sign["content"] = json.loads(content)
|
|
|
|
|
|
|
|
signed_json = sign_json(json_to_sign, origin_key, origin_name)
|
2015-05-06 06:46:02 -04:00
|
|
|
|
|
|
|
authorization_headers = []
|
|
|
|
|
|
|
|
for key, sig in signed_json["signatures"][origin_name].items():
|
2019-06-20 05:32:02 -04:00
|
|
|
header = 'X-Matrix origin=%s,key="%s",sig="%s"' % (origin_name, key, sig)
|
2019-06-13 09:49:25 -04:00
|
|
|
authorization_headers.append(header.encode("ascii"))
|
2018-10-19 20:16:55 -04:00
|
|
|
print("Authorization: %s" % header, file=sys.stderr)
|
2017-08-17 11:54:27 -04:00
|
|
|
|
2018-06-07 13:14:08 -04:00
|
|
|
dest = "matrix://%s%s" % (destination, path)
|
2018-10-19 20:16:55 -04:00
|
|
|
print("Requesting %s" % dest, file=sys.stderr)
|
2015-05-06 06:46:02 -04:00
|
|
|
|
2018-06-07 13:14:08 -04:00
|
|
|
s = requests.Session()
|
|
|
|
s.mount("matrix://", MatrixConnectionAdapter())
|
|
|
|
|
2018-11-09 05:41:34 -05:00
|
|
|
headers = {"Host": destination, "Authorization": authorization_headers[0]}
|
|
|
|
|
|
|
|
if method == "POST":
|
|
|
|
headers["Content-Type"] = "application/json"
|
|
|
|
|
2020-08-26 09:11:38 -04:00
|
|
|
return s.request(
|
|
|
|
method=method,
|
|
|
|
url=dest,
|
|
|
|
headers=headers,
|
|
|
|
verify=False,
|
|
|
|
data=content,
|
|
|
|
stream=True,
|
2015-05-06 06:46:02 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
|
|
def main():
|
2017-08-17 11:54:27 -04:00
|
|
|
parser = argparse.ArgumentParser(
|
2018-10-19 20:16:55 -04:00
|
|
|
description="Signs and sends a federation request to a matrix homeserver"
|
2017-08-17 11:54:27 -04:00
|
|
|
)
|
|
|
|
|
2017-08-22 06:19:30 -04:00
|
|
|
parser.add_argument(
|
2018-10-19 20:16:55 -04:00
|
|
|
"-N",
|
|
|
|
"--server-name",
|
2017-08-22 06:19:30 -04:00
|
|
|
help="Name to give as the local homeserver. If unspecified, will be "
|
2018-10-19 20:16:55 -04:00
|
|
|
"read from the config file.",
|
2017-08-22 06:19:30 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
parser.add_argument(
|
2018-10-19 20:16:55 -04:00
|
|
|
"-k",
|
|
|
|
"--signing-key-path",
|
2017-08-22 06:19:30 -04:00
|
|
|
help="Path to the file containing the private ed25519 key to sign the "
|
2018-10-19 20:16:55 -04:00
|
|
|
"request with.",
|
2017-08-22 06:19:30 -04:00
|
|
|
)
|
|
|
|
|
2017-08-17 11:54:27 -04:00
|
|
|
parser.add_argument(
|
2018-10-19 20:16:55 -04:00
|
|
|
"-c",
|
|
|
|
"--config",
|
2017-08-17 11:54:27 -04:00
|
|
|
default="homeserver.yaml",
|
2017-08-22 06:19:30 -04:00
|
|
|
help="Path to server config file. Ignored if --server-name and "
|
2018-10-19 20:16:55 -04:00
|
|
|
"--signing-key-path are both given.",
|
2017-08-17 11:54:27 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
parser.add_argument(
|
2018-10-19 20:16:55 -04:00
|
|
|
"-d",
|
|
|
|
"--destination",
|
2017-08-17 11:54:27 -04:00
|
|
|
default="matrix.org",
|
|
|
|
help="name of the remote homeserver. We will do SRV lookups and "
|
2018-10-19 20:16:55 -04:00
|
|
|
"connect appropriately.",
|
2017-08-17 11:54:27 -04:00
|
|
|
)
|
|
|
|
|
2017-11-27 05:06:59 -05:00
|
|
|
parser.add_argument(
|
2018-10-19 20:16:55 -04:00
|
|
|
"-X",
|
|
|
|
"--method",
|
2018-11-09 05:41:34 -05:00
|
|
|
help="HTTP method to use for the request. Defaults to GET if --body is"
|
2018-10-19 20:16:55 -04:00
|
|
|
"unspecified, POST if it is.",
|
2017-11-27 05:06:59 -05:00
|
|
|
)
|
|
|
|
|
2018-10-19 20:16:55 -04:00
|
|
|
parser.add_argument("--body", help="Data to send as the body of the HTTP request")
|
2017-11-27 05:06:59 -05:00
|
|
|
|
2017-08-17 11:54:27 -04:00
|
|
|
parser.add_argument(
|
2021-03-18 16:31:47 -04:00
|
|
|
"path", help="request path, including the '/_matrix/federation/...' prefix."
|
2017-08-17 11:54:27 -04:00
|
|
|
)
|
|
|
|
|
|
|
|
args = parser.parse_args()
|
|
|
|
|
2021-03-18 17:12:07 -04:00
|
|
|
args.signing_key = None
|
|
|
|
if args.signing_key_path:
|
|
|
|
with open(args.signing_key_path) as f:
|
|
|
|
args.signing_key = f.readline()
|
|
|
|
|
|
|
|
if not args.server_name or not args.signing_key:
|
2017-08-22 06:19:30 -04:00
|
|
|
read_args_from_config(args)
|
2015-05-06 06:46:02 -04:00
|
|
|
|
2021-03-18 17:12:07 -04:00
|
|
|
algorithm, version, key_base64 = args.signing_key.split()
|
|
|
|
key = signedjson.key.decode_signing_key_base64(algorithm, version, key_base64)
|
2015-05-06 06:46:02 -04:00
|
|
|
|
2020-08-26 09:11:38 -04:00
|
|
|
result = request(
|
2017-11-27 05:06:59 -05:00
|
|
|
args.method,
|
2018-10-19 20:16:55 -04:00
|
|
|
args.server_name,
|
|
|
|
key,
|
|
|
|
args.destination,
|
2021-03-18 16:31:47 -04:00
|
|
|
args.path,
|
2017-11-27 05:06:59 -05:00
|
|
|
content=args.body,
|
2015-05-06 06:46:02 -04:00
|
|
|
)
|
|
|
|
|
2020-08-26 09:11:38 -04:00
|
|
|
sys.stderr.write("Status Code: %d\n" % (result.status_code,))
|
|
|
|
|
|
|
|
for chunk in result.iter_content():
|
|
|
|
# we write raw utf8 to stdout.
|
|
|
|
sys.stdout.buffer.write(chunk)
|
|
|
|
|
2018-10-19 20:16:55 -04:00
|
|
|
print("")
|
2015-05-06 06:46:02 -04:00
|
|
|
|
2017-08-22 06:19:30 -04:00
|
|
|
|
|
|
|
def read_args_from_config(args):
|
2019-06-20 05:32:02 -04:00
|
|
|
with open(args.config, "r") as fh:
|
2017-08-22 06:19:30 -04:00
|
|
|
config = yaml.safe_load(fh)
|
2021-03-18 17:12:07 -04:00
|
|
|
|
2017-08-22 06:19:30 -04:00
|
|
|
if not args.server_name:
|
2019-06-20 05:32:02 -04:00
|
|
|
args.server_name = config["server_name"]
|
2021-03-18 17:12:07 -04:00
|
|
|
|
|
|
|
if not args.signing_key:
|
|
|
|
if "signing_key" in config:
|
|
|
|
args.signing_key = config["signing_key"]
|
|
|
|
else:
|
|
|
|
with open(config["signing_key_path"]) as f:
|
|
|
|
args.signing_key = f.readline()
|
2017-08-22 06:19:30 -04:00
|
|
|
|
|
|
|
|
2018-06-07 13:14:08 -04:00
|
|
|
class MatrixConnectionAdapter(HTTPAdapter):
|
|
|
|
@staticmethod
|
2019-06-13 09:49:25 -04:00
|
|
|
def lookup(s, skip_well_known=False):
|
2019-06-20 05:32:02 -04:00
|
|
|
if s[-1] == "]":
|
2018-06-07 13:14:08 -04:00
|
|
|
# ipv6 literal (with no port)
|
|
|
|
return s, 8448
|
|
|
|
|
|
|
|
if ":" in s:
|
2018-10-19 20:16:55 -04:00
|
|
|
out = s.rsplit(":", 1)
|
2018-06-07 13:14:08 -04:00
|
|
|
try:
|
|
|
|
port = int(out[1])
|
|
|
|
except ValueError:
|
|
|
|
raise ValueError("Invalid host:port '%s'" % s)
|
|
|
|
return out[0], port
|
|
|
|
|
2019-06-13 09:49:25 -04:00
|
|
|
# try a .well-known lookup
|
|
|
|
if not skip_well_known:
|
|
|
|
well_known = MatrixConnectionAdapter.get_well_known(s)
|
|
|
|
if well_known:
|
2019-06-20 05:32:02 -04:00
|
|
|
return MatrixConnectionAdapter.lookup(well_known, skip_well_known=True)
|
2019-06-13 09:49:25 -04:00
|
|
|
|
2018-06-07 13:14:08 -04:00
|
|
|
try:
|
|
|
|
srv = srvlookup.lookup("matrix", "tcp", s)[0]
|
|
|
|
return srv.host, srv.port
|
2018-10-19 20:16:55 -04:00
|
|
|
except Exception:
|
2018-06-07 13:14:08 -04:00
|
|
|
return s, 8448
|
|
|
|
|
2019-06-13 09:49:25 -04:00
|
|
|
@staticmethod
|
|
|
|
def get_well_known(server_name):
|
2019-06-20 05:32:02 -04:00
|
|
|
uri = "https://%s/.well-known/matrix/server" % (server_name,)
|
|
|
|
print("fetching %s" % (uri,), file=sys.stderr)
|
2019-06-13 09:49:25 -04:00
|
|
|
|
|
|
|
try:
|
|
|
|
resp = requests.get(uri)
|
|
|
|
if resp.status_code != 200:
|
|
|
|
print("%s gave %i" % (uri, resp.status_code), file=sys.stderr)
|
|
|
|
return None
|
|
|
|
|
|
|
|
parsed_well_known = resp.json()
|
|
|
|
if not isinstance(parsed_well_known, dict):
|
|
|
|
raise Exception("not a dict")
|
|
|
|
if "m.server" not in parsed_well_known:
|
|
|
|
raise Exception("Missing key 'm.server'")
|
2019-06-20 05:32:02 -04:00
|
|
|
new_name = parsed_well_known["m.server"]
|
|
|
|
print("well-known lookup gave %s" % (new_name,), file=sys.stderr)
|
2019-06-13 09:49:25 -04:00
|
|
|
return new_name
|
|
|
|
|
|
|
|
except Exception as e:
|
2019-06-20 05:32:02 -04:00
|
|
|
print("Invalid response from %s: %s" % (uri, e), file=sys.stderr)
|
2019-06-13 09:49:25 -04:00
|
|
|
return None
|
|
|
|
|
2018-06-07 13:14:08 -04:00
|
|
|
def get_connection(self, url, proxies=None):
|
2019-06-13 09:49:25 -04:00
|
|
|
parsed = urlparse.urlparse(url)
|
2018-06-07 13:14:08 -04:00
|
|
|
|
|
|
|
(host, port) = self.lookup(parsed.netloc)
|
|
|
|
netloc = "%s:%d" % (host, port)
|
|
|
|
print("Connecting to %s" % (netloc,), file=sys.stderr)
|
2019-06-13 09:49:25 -04:00
|
|
|
url = urlparse.urlunparse(
|
2018-10-19 20:16:55 -04:00
|
|
|
("https", netloc, parsed.path, parsed.params, parsed.query, parsed.fragment)
|
|
|
|
)
|
2020-09-18 09:56:44 -04:00
|
|
|
return super().get_connection(url, proxies)
|
2018-06-07 13:14:08 -04:00
|
|
|
|
|
|
|
|
2015-05-06 06:46:02 -04:00
|
|
|
if __name__ == "__main__":
|
|
|
|
main()
|