William/Reticulum
1
0
Fork 0
mirror of https://github.com/markqvist/Reticulum.git synced 2024-11-26 15:30:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated Destination docstring

Browse Source
This commit is contained in:
Mark Qvist 2021-05-16 21:57:49 +02:00
parent eecfbed3e4
commit e7f7d91276
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
RNS/Destination.py
View File

@ -24,7 +24,7 @@ class Destination:
presence on the network, which will also distribute necessary keys for presence on the network, which will also distribute necessary keys for
encrypted communication with it. encrypted communication with it.
:param identity: An instance of :ref:`RNS.Identity<Identity>`. Can hold only public keys for an outgoing destination, or holding private keys for an ingoing. :param identity: An instance of :ref:`RNS.Identity<api-identity>`. Can hold only public keys for an outgoing destination, or holding private keys for an ingoing.
:param direction: ``RNS.Destination.IN`` or ``RNS.Destination.OUT`` :param direction: ``RNS.Destination.IN`` or ``RNS.Destination.OUT``
:param type: ``RNS.Destination.SINGLE``, ``RNS.Destination.GROUP`` or ``RNS.Destination.PLAIN``. :param type: ``RNS.Destination.SINGLE``, ``RNS.Destination.GROUP`` or ``RNS.Destination.PLAIN``.
:param app_name: A string specifying the app name. :param app_name: A string specifying the app name.
@ -275,7 +275,7 @@ class Destination:
""" """
Decrypts information for ``RNS.Destination.SINGLE`` or ``RNS.Destination.GROUP`` type destination. Decrypts information for ``RNS.Destination.SINGLE`` or ``RNS.Destination.GROUP`` type destination.
:param ciphertext: A *bytes-like* containing the ciphertext to be decrypted. :param ciphertext: *Bytes* containing the ciphertext to be decrypted.
:raises: ``ValueError`` if destination does not hold a necessary key for decryption. :raises: ``ValueError`` if destination does not hold a necessary key for decryption.
""" """
if self.type == Destination.PLAIN: if self.type == Destination.PLAIN:
@ -299,7 +299,7 @@ class Destination:
""" """
Signs information for ``RNS.Destination.SINGLE`` type destination. Signs information for ``RNS.Destination.SINGLE`` type destination.
:param message: A *bytes-like* containing the message to be signed. :param message: *Bytes* containing the message to be signed.
:returns: A *bytes-like* containing the message signature, or *None* if the destination could not sign the message. :returns: A *bytes-like* containing the message signature, or *None* if the destination could not sign the message.
""" """
if self.type == Destination.SINGLE and self.identity != None: if self.type == Destination.SINGLE and self.identity != None:
@ -329,7 +329,7 @@ class Destination:
all interfaces. Application specific data can be added to the announce. all interfaces. Application specific data can be added to the announce.
:param app_data: *bytes* containing the app_data. :param app_data: *bytes* containing the app_data.
:param path_response: Internal flag used by :ref:`RNS.Transport<Transport>`. Ignore. :param path_response: Internal flag used by :ref:`RNS.Transport<api-transport>`. Ignore.
""" """
destination_hash = self.hash destination_hash = self.hash
random_hash = RNS.Identity.get_random_hash() random_hash = RNS.Identity.get_random_hash()