comparison doc/conf.py @ 3975:c4418949aa37

doc (encryption, cli): document Pubsub Targeted Encryption: a small section has been added to `encryption` to explain the difference with OXPS, and the `--encrypt-for` arguments are explained. fix 382
author Goffi <goffi@goffi.org>
date Mon, 31 Oct 2022 13:50:12 +0100
parents 9f85369294f3
children 3b72743b92db
comparison
equal deleted inserted replaced
3974:5e3b983ab2c6 3975:c4418949aa37
45 rst_prolog = """ 45 rst_prolog = """
46 .. |e2e_arg| replace:: 46 .. |e2e_arg| replace::
47 To publish an end-to-end encrypted item, you can use the ``-e, --encrypt`` flag, and 47 To publish an end-to-end encrypted item, you can use the ``-e, --encrypt`` flag, and
48 share secrets with :ref:`libervia-cli_pubsub_secret`. Please read 48 share secrets with :ref:`libervia-cli_pubsub_secret`. Please read
49 :ref:`pubsub-encryption` for more details. 49 :ref:`pubsub-encryption` for more details.
50
51 .. |pte_arg| replace::
52 You can encrypt a single item to targeted entities with the ``--encrypt-for`` flag (not
53 to be confused with ``--encrypt`` which is used when a whole node is encrypted). Please
54 read :ref:`pubsub-encryption` for more details.
50 55
51 .. |sign_arg| replace:: 56 .. |sign_arg| replace::
52 To cryptographically sign an item, you can use the ``-X, --sign`` flag (a mnemonic way 57 To cryptographically sign an item, you can use the ``-X, --sign`` flag (a mnemonic way
53 to remember the short option is to think of a cross made as a signature on a document). 58 to remember the short option is to think of a cross made as a signature on a document).
54 Signature can then be checked with :ref:`libervia-cli_pubsub_signature`. Please read 59 Signature can then be checked with :ref:`libervia-cli_pubsub_signature`. Please read