aboutsummaryrefslogtreecommitdiff
path: root/src/mailman_pgp/pgp/inline.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/mailman_pgp/pgp/inline.py')
-rw-r--r--src/mailman_pgp/pgp/inline.py12
1 files changed, 9 insertions, 3 deletions
diff --git a/src/mailman_pgp/pgp/inline.py b/src/mailman_pgp/pgp/inline.py
index ccc8176..372204a 100644
--- a/src/mailman_pgp/pgp/inline.py
+++ b/src/mailman_pgp/pgp/inline.py
@@ -258,12 +258,18 @@ class InlineWrapper:
def sign_encrypt(self, key, *keys, hash=None,
cipher=SymmetricKeyAlgorithm.AES256):
"""
+ Sign and encrypt the message, in one go.
- :param key:
- :param keys:
+ :param key: The key to sign with.
+ :type key: pgpy.PGPKey
+ :param keys: The key/s to encrypt with.
+ :type keys: pgpy.PGPKey
:param hash:
+ :type hash: pgpy.constants.HashAlgorithm
:param cipher:
- :return:
+ :type cipher: pgpy.constants.SymmetricKeyAlgorithm
+ :return: The signed + encrypted message.
+ :rtype: mailman.email.message.Message
"""
if len(keys) == 0:
raise ValueError('At least one key necessary.')