Skip to main content

tuwunel_service/server_keys/
sign.rs

1//! Local signing and event-ID generation helpers.
2//!
3//! Events are content-hashed and signed with the server's active Ed25519 key.
4//! Event-ID placement follows the selected room version's event format.
5
6use ruma::{CanonicalJsonObject, CanonicalJsonValue, OwnedEventId, RoomVersionId};
7use tuwunel_core::{Result, err, implement};
8use tuwunel_matrix::{event::gen_event_id, room_version};
9
10/// Generates an event ID, content hash, and local signature in place.
11///
12/// Any existing `event_id` is removed first. Legacy room versions generate and
13/// insert the ID before signing; newer versions derive it after signing and then
14/// insert it into the returned object.
15#[implement(super::Service)]
16pub fn gen_id_hash_and_sign_event(
17	&self,
18	object: &mut CanonicalJsonObject,
19	room_version_id: &RoomVersionId,
20) -> Result<OwnedEventId> {
21	object.remove("event_id");
22
23	if room_version::rules(room_version_id)?
24		.event_format
25		.require_event_id
26	{
27		self.gen_id_hash_and_sign_event_v1(object, room_version_id)
28	} else {
29		self.gen_id_hash_and_sign_event_v3(object, room_version_id)
30	}
31}
32
33/// Generates and inserts an event ID before signing a legacy-format event.
34///
35/// The explicit ID participates in the content hash and signature for room
36/// versions whose event format requires it.
37#[implement(super::Service)]
38fn gen_id_hash_and_sign_event_v1(
39	&self,
40	object: &mut CanonicalJsonObject,
41	room_version_id: &RoomVersionId,
42) -> Result<OwnedEventId> {
43	let event_id = gen_event_id(object, room_version_id)?;
44
45	object.insert("event_id".into(), CanonicalJsonValue::String(event_id.clone().into()));
46
47	self.services
48		.server_keys
49		.hash_and_sign_event(object, room_version_id)?;
50
51	Ok(event_id)
52}
53
54/// Signs a modern-format event before deriving and inserting its event ID.
55///
56/// The derived ID therefore reflects the signed event representation used by
57/// room versions that omit an explicit ID during signing.
58#[implement(super::Service)]
59fn gen_id_hash_and_sign_event_v3(
60	&self,
61	object: &mut CanonicalJsonObject,
62	room_version_id: &RoomVersionId,
63) -> Result<OwnedEventId> {
64	self.services
65		.server_keys
66		.hash_and_sign_event(object, room_version_id)?;
67
68	let event_id = gen_event_id(object, room_version_id)?;
69
70	object.insert("event_id".into(), CanonicalJsonValue::String(event_id.clone().into()));
71
72	Ok(event_id)
73}
74
75/// Adds a content hash and local server signature to an event object.
76///
77/// Signing uses the room version's redaction rules. Oversized PDUs are mapped to
78/// a request-too-large error and other signing failures to an unknown request
79/// error.
80#[implement(super::Service)]
81pub fn hash_and_sign_event(
82	&self,
83	object: &mut CanonicalJsonObject,
84	room_version_id: &RoomVersionId,
85) -> Result {
86	use ruma::signatures::{add_content_hash_to_event, sign_event};
87
88	let server_name = &self.services.server.name;
89	let room_version_rules = room_version::rules(room_version_id)?;
90
91	let map_err = |e: ruma::signatures::JsonError| {
92		use ruma::signatures::JsonError::PduTooLarge;
93		match e {
94			| PduTooLarge => {
95				err!(Request(TooLarge("PDU exceeds 65535 bytes")))
96			},
97			| _ => err!(Request(Unknown(warn!("Signing event failed: {e}")))),
98		}
99	};
100
101	add_content_hash_to_event(object).map_err(map_err)?;
102	sign_event(server_name.as_str(), self.keypair(), object, &room_version_rules.redaction)
103		.map_err(map_err)
104}
105
106/// Signs an arbitrary canonical JSON object with the local server key.
107///
108/// The signature is inserted under the configured local server name without
109/// adding an event content hash.
110#[implement(super::Service)]
111pub fn sign_json(&self, object: &mut CanonicalJsonObject) -> Result {
112	use ruma::signatures::sign_json;
113
114	let server_name = self.services.globals.server_name().as_str();
115
116	sign_json(server_name, self.keypair(), object).map_err(Into::into)
117}