From 3656eb4740afd245028f34b0b56cb684a00269b5 Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Mon, 29 Sep 2014 16:39:08 +0100 Subject: Add m.room.redacted in events list --- docs/specification.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'docs/specification.rst') diff --git a/docs/specification.rst b/docs/specification.rst index 370e238e00..a44c7c4882 100644 --- a/docs/specification.rst +++ b/docs/specification.rst @@ -968,6 +968,22 @@ prefixed with ``m.`` ``read`` (sent when the event has been observed by the end-user). The ``target_event_id`` should reference the ``m.room.message`` event being acknowledged. +``m.room.redaction`` + Summary: + Indicates a previous event has been redacted. + Type: + Non-state event + JSON format: + ``{ "reason": "string" }`` + Description: + Events can be redacted by either room or server admins. Redacting an event means that + all keys not required by the protocol are stripped off, allowing admins to remove + offensive or illegal content that may have been attached to any event. This cannot be + undone, allowing server owners to physically delete the offending data. + There is also a concept of a moderator hiding a non-state event, which can be undone, + but cannot be applied to state events. + The event that has been redacted is specified in the ``redacts`` event level key. + m.room.message msgtypes ----------------------- Each ``m.room.message`` MUST have a ``msgtype`` key which identifies the type of -- cgit 1.4.1 From 389285585d71711ba9124f64db18ad8e97e14f1a Mon Sep 17 00:00:00 2001 From: Erik Johnston Date: Mon, 29 Sep 2014 17:19:45 +0100 Subject: Add a 'Redactions' section. --- docs/specification.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) (limited to 'docs/specification.rst') diff --git a/docs/specification.rst b/docs/specification.rst index a44c7c4882..23e385688e 100644 --- a/docs/specification.rst +++ b/docs/specification.rst @@ -778,6 +778,23 @@ There are several APIs provided to ``GET`` events for a room: Example: TODO +Redactions +---------- +Since events are extensible it is possible for malicious users and/or servers to add +keys that are, for example offensive or illegal. Since some events cannot be simply +deleted, e.g. membership events, we instead 'redact' events. This involves removing +all keys from an event that are not required by the protocol. This stripped down +event is thereafter returned anytime a client or remote server requests it. + +Events that have been redacted include a ``redacted_because`` key whose value is the +event that caused it to be redacted, which may include a reason. + +Redacting an event cannot be undone, allowing server owners to delete the offending +content from the databases. + +Currently, only room admins can redact events by sending a ``m.room.redacted`` event, +but server admins also need to be able to redact events by a similar mechanism. + Room Events =========== -- cgit 1.4.1