From 35fe4f1a1ec248f84af02efc552d6b0b2e8ccb31 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dominik=20Pant=C5=AF=C4=8Dek?= Date: Mon, 21 Oct 2024 12:04:54 +0200 Subject: [PATCH] Brief explanation of the add_recipient transformation in documentation. --- docs/index.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/index.md b/docs/index.md index 0fb94d5..cfe9891 100644 --- a/docs/index.md +++ b/docs/index.md @@ -111,6 +111,14 @@ writer.write() ### Adding Recipients for Serialization +For granting access to the encrypted container contents a filtering +wrapper is implemented which accepts underlying Crypt4GH container as +its source and allows for arbitrary transformations +on-the-fly. Currently only the `add_recipient` transformation is +available, which adds given public key as a new recipient to the +container by encrypting every readable packet for this recipient and +adding the newly encrypted version of given packet to the output. + ```python from oarepo_c4gh import Crypt4GHFilter