gnh1201/mastodon
1
0
Fork 0
mirror of https://github.com/mastodon/mastodon.git synced 2025-07-15 08:48:15 +00:00
Code Issues Actions 15 Packages Projects Releases Wiki Activity

Add example file, document private section of messages

Browse Source
This commit is contained in:
June Rhodes 2016-11-23 23:05:19 +11:00
parent df98964946
commit 455ff2fcfc
2 changed files with 112 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
ref/private-messaging/2016.1/README.md
View File

@ -50,6 +50,70 @@ inclusion would be:
</feed>
```
The linked public key file should be represented in PEM format.
The linked public key file should be represented in PEM format. For example, here's a 2048-bit RSA public key generated with `openssl` in PEM format:
```
-----BEGIN PUBLIC KEY-----
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsdxyyeZHWJqLwj5zqm5s
wxKzKSrUlqsSw9s7tSCNZ2VptOmJYsELLyTt7xsXzfh14QiO9sYQ7oG6AxV2MEEO
vedTngHTeGSLXr+Hq0PpkUg74yyH5AJihPbtsOyQo1HMrKmPyoTLypSU8ahPKtLQ
oLFqCytYtf5vvFaLd+II2WWJphG/K9KLndOk38Ff+DqCvUxo7mOqn0I+o4EjjB6r
Fk3NQE/w0EiVehkv5KeW5WrOlF+z4xcrVN3z3+UoUZD+4j7uvUtXbHamTDTYpm/x
YY0Znamfxwefnj8vVy/UrUZbd41euMs+7z+pveYU0h4cCwJAXkdxUdpw10B6/3J+
cQIDAQAB
-----END PUBLIC KEY-----
```
### private
This block is expected to appear within a post. As an example within an Atom feed:
```xml
<entry>
<id>tag:mastodon.social,2016-11-23:objectId=166685:objectType=Status</id>
<published>2016-11-23T11:09:10Z</published>
<updated>2016-11-23T11:09:10Z</updated>
<title>This is a private message</title>
<content type="html">This is a private message</content>
<activity:verb>http://activitystrea.ms/schema/1.0/post</activity:verb>
<link rel="self" type="application/atom+xml" href="https://mastodon.social/users/hq/updates/148372.atom"/>
<link rel="alternate" type="text/html" href="https://mastodon.social/users/hq/updates/148372"/>
<activity:object-type>http://activitystrea.ms/schema/1.0/comment</activity:object-type>
<thr:in-reply-to ref="tag:mastodon.social,2016-11-23:objectId=166554:objectType=Status" href="https://mastodon.social/users/maize/updates/148167" type="text/html"/>
<pm:private>
<pm:encryptedContentBase64 encoding="utf-8">
<!--
the content is encrypted with a symmetric key (a new symmetric key is generated for each private message). the symmetric key is
then encrypted for each recipient using their public key
-->
dGhlIGNvbnRlbnQgaXMgZW5jcnlwdGVkIHdpdGggYSBzeW1tZXRyaWMga2V5IChhIG5ldyBzeW1tZXRyaWMga2V5IGlzIGdlbmVyYXRlZCBmb3IgZWFjaCBwcml2YXRlIG1lc3NhZ2UpLiAgdGhlIHN5bW1ldHJpYyBrZXkgaXMgdGhlbiBlbmNyeXB0ZWQgZm9yIGVhY2ggcmVjaXBpZW50IHVzaW5nIHRoZWlyIHB1YmxpYyBrZXk=
</pm:encryptedContentBase64>
<pm:recipient>
<pm:canonicalUri>https://mastodon.social/users/user1.atom</pm:canonicalUri>
<pm:publicKeyUri>https://mastodon.social/users/user1.pem</pm:publicKeyUri>
<pm:encryptedSymmetricKey encoding="utf-8">
<!--
the symmetric key used to encrypt the actual content would be encrypted with the user's public key, and then included here in a base-64 format
-->
dGhlIHN5bW1ldHJpYyBrZXkgdXNlZCB0byBlbmNyeXB0IHRoZSBhY3R1YWwgY29udGVudCB3b3VsZCBiZSBlbmNyeXB0ZWQgd2l0aCB0aGUgdXNlcidzIHB1YmxpYyBrZXksIGFuZCB0aGVuIGluY2x1ZGVkIGhlcmUgaW4gYSBiYXNlLTY0IGZvcm1hdA==
</pm:encryptedSymmetricKey>
</pm:recipient>
<pm:recipient>
<pm:canonicalUri>https://mastodon.social/users/user2.atom</pm:canonicalUri>
<pm:publicKeyUri>https://mastodon.social/users/user2.pem</pm:publicKeyUri>
<pm:encryptedSymmetricKey encoding="utf-8">
<!--
the symmetric key used to encrypt the actual content would be encrypted with the user's public key, and then included here in a base-64 format
-->
dGhlIHN5bW1ldHJpYyBrZXkgdXNlZCB0byBlbmNyeXB0IHRoZSBhY3R1YWwgY29udGVudCB3b3VsZCBiZSBlbmNyeXB0ZWQgd2l0aCB0aGUgdXNlcidzIHB1YmxpYyBrZXksIGFuZCB0aGVuIGluY2x1ZGVkIGhlcmUgaW4gYSBiYXNlLTY0IGZvcm1hdA==
</pm:encryptedSymmetricKey>
</pm:recipient>
</pm:private>
</entry>
```
As a convention, the unencrypted fields `content` and `title` should be replaced with `This is a private message`, but implementors may replace either
content with anything. Implementors should ensure they do not add `<link>` tags (such as mentions) or any other data to the entry that reveals any part of the contents
of the private message.
** TODO** This is a work in progress.

47
ref/private-messaging/2016.1/example.xml Normal file
View File

@ -0,0 +1,47 @@
<?xml version="1.0" encoding="utf-8"?>
<root
xmlns:pm="https://raw.githubusercontent.com/Gargron/mastodon/master/ref/private-messaging/2016.1/schema.xsd"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://raw.githubusercontent.com/Gargron/mastodon/master/ref/private-messaging/2016.1/schema.xsd schema.xsd">
<!--
Example for an element within a Person Activity Stream object.
-->
<pm:publicKeyUri>https://mastodon.social/users/hq.pem</pm:publicKeyUri>
<!--
Example for tags to extend an <entry> object.
-->
<entry>
<pm:private>
<pm:encryptedContentBase64 encoding="utf-8">
<!--
the content is encrypted with a symmetric key (a new symmetric key is generated for each private message). the symmetric key is
then encrypted for each recipient using their public key
-->
dGhlIGNvbnRlbnQgaXMgZW5jcnlwdGVkIHdpdGggYSBzeW1tZXRyaWMga2V5IChhIG5ldyBzeW1tZXRyaWMga2V5IGlzIGdlbmVyYXRlZCBmb3IgZWFjaCBwcml2YXRlIG1lc3NhZ2UpLiAgdGhlIHN5bW1ldHJpYyBrZXkgaXMgdGhlbiBlbmNyeXB0ZWQgZm9yIGVhY2ggcmVjaXBpZW50IHVzaW5nIHRoZWlyIHB1YmxpYyBrZXk=
</pm:encryptedContentBase64>
<pm:recipient>
<pm:canonicalUri>https://mastodon.social/users/user1.atom</pm:canonicalUri>
<pm:publicKeyUri>https://mastodon.social/users/user1.pem</pm:publicKeyUri>
<pm:encryptedSymmetricKey encoding="utf-8">
<!--
the symmetric key used to encrypt the actual content would be encrypted with the user's public key, and then included here in a base-64 format
-->
dGhlIHN5bW1ldHJpYyBrZXkgdXNlZCB0byBlbmNyeXB0IHRoZSBhY3R1YWwgY29udGVudCB3b3VsZCBiZSBlbmNyeXB0ZWQgd2l0aCB0aGUgdXNlcidzIHB1YmxpYyBrZXksIGFuZCB0aGVuIGluY2x1ZGVkIGhlcmUgaW4gYSBiYXNlLTY0IGZvcm1hdA==
</pm:encryptedSymmetricKey>
</pm:recipient>
<pm:recipient>
<pm:canonicalUri>https://mastodon.social/users/user2.atom</pm:canonicalUri>
<pm:publicKeyUri>https://mastodon.social/users/user2.pem</pm:publicKeyUri>
<pm:encryptedSymmetricKey encoding="utf-8">
<!--
the symmetric key used to encrypt the actual content would be encrypted with the user's public key, and then included here in a base-64 format
-->
dGhlIHN5bW1ldHJpYyBrZXkgdXNlZCB0byBlbmNyeXB0IHRoZSBhY3R1YWwgY29udGVudCB3b3VsZCBiZSBlbmNyeXB0ZWQgd2l0aCB0aGUgdXNlcidzIHB1YmxpYyBrZXksIGFuZCB0aGVuIGluY2x1ZGVkIGhlcmUgaW4gYSBiYXNlLTY0IGZvcm1hdA==
</pm:encryptedSymmetricKey>
</pm:recipient>
</pm:private>
</entry>
</root>