From 47f79205f1c03339e20f89753fe428264f917a1f Mon Sep 17 00:00:00 2001 From: Jason Robinson Date: Mon, 12 Feb 2018 23:23:38 +0200 Subject: [PATCH] Changelog entries for last commits --- CHANGELOG.md | 23 ++++++++++++++++++----- docs/usage.rst | 1 + 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 192d2d7..b789df7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,10 +2,27 @@ ## [unreleased] +### Added + +* Enable generating encrypted JSON payloads with the Diaspora protocol which adds private message support. ([related issue](https://github.com/jaywink/federation/issues/82)) + + JSON encrypted payload encryption and decryption is handled by the Diaspora `EncryptedPayload` class. + ### Changed -* Send outbound Diaspora payloads in new format. Remove possibility to generate legacy MagicEnvelope payloads. ([related issue](https://github.com/jaywink/federation/issues/82)) +* Send outbound Diaspora payloads in new format. Remove possibility to generate legacy MagicEnvelope payloads. ([related issue](https://github.com/jaywink/federation/issues/82)) +* **Backwards incompatible**. Refactor `handle_send` function + + Now handle_send high level outbound helper function also allows delivering private payloads using the Diaspora protocol. ([related issue](https://github.com/jaywink/federation/issues/82)) + + The signature has changed. Parameter `recipients` should now be a list of recipients to delivery to. Each recipient should either be an `id` or a tuple of `(id, public key)`. If public key is provided, Diaspora protocol delivery will be made as an encrypted private delivery. + +* **Backwards incompatible**. Change `handle_create_payload` function signature. + + Parameter `to_user` is now `to_user_key` and thus instead of an object containing the `key` attribute it should now be an RSA public key object instance. This simplifies things since we only need the key from the user, nothing else. + + ## [0.15.0] - 2018-02-12 ### Added @@ -35,10 +52,6 @@ * Support fetching new style Diaspora protocol Webfinger (RFC 3033) ([related issue](https://github.com/jaywink/federation/issues/108)) The legaxy Webfinger is still used as fallback if the new Webfinger is not found. - -* Enable generating encrypted JSON payloads with the Diaspora protocol which adds private message support. ([related issue](https://github.com/jaywink/federation/issues/82)) - - JSON encrypted payload encryption and decryption is handled by the Diaspora `EncryptedPayload` class. ### Changed * Refactoring for Diaspora `MagicEnvelope` class. diff --git a/docs/usage.rst b/docs/usage.rst index d599c11..415cf1f 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -109,6 +109,7 @@ Diaspora .. autofunction:: federation.utils.diaspora.fetch_public_key .. autofunction:: federation.utils.diaspora.get_fetch_content_endpoint .. autofunction:: federation.utils.diaspora.get_public_endpoint +.. autofunction:: federation.utils.diaspora.get_private_endpoint .. autofunction:: federation.utils.diaspora.parse_diaspora_uri .. autofunction:: federation.utils.diaspora.parse_profile_from_hcard .. autofunction:: federation.utils.diaspora.retrieve_and_parse_content