diff options
author | Ruben Pollan <meskio@sindominio.net> | 2016-07-06 15:35:24 +0200 |
---|---|---|
committer | Ruben Pollan <meskio@sindominio.net> | 2016-07-06 15:35:24 +0200 |
commit | 2bf3ef57a1f2841116268010cd80984208725f45 (patch) | |
tree | 27384afc7f1094124169114f58c1960be396bdcd /memoryhole/openpgp.py | |
parent | 7396398e81fda41d4cb2ea7ffbdfa8f02746cad8 (diff) |
[doc] document public methods
Diffstat (limited to 'memoryhole/openpgp.py')
-rw-r--r-- | memoryhole/openpgp.py | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/memoryhole/openpgp.py b/memoryhole/openpgp.py index 5f94861..ac5cb6e 100644 --- a/memoryhole/openpgp.py +++ b/memoryhole/openpgp.py @@ -3,10 +3,44 @@ from zope.interface import Interface class OpenPGP(Interface): def encrypt(data, encraddr, singaddr): + """ + Encrypt and sign data. + + :param data: data to be encrypted + :type data: str + :param encraddr: list of email addresses to encrypt to + :type encraddr: [str] + :param singaddr: email address to sign with + :type singaddr: str + + :return: encrypted and signed data + :rtype: str + """ pass def decrypt(data): + """ + Decrypt and verify data. + + :param data: data to be decrypted + :type data: str + + :return: decrypted data + :rtype: str + """ + # What about verification??? pass def verify(data, signature): + """ + Verify a signature. + + :param data: data to be virified + :type data: str + :param signature: detached signature + :type signature: str + + :return: is signature valid + :rtype: bool + """ pass |