From fa07aa588d8c0b5932bab2b056e07ed9c11dd7eb Mon Sep 17 00:00:00 2001 From: Arthur de Jong Date: Sun, 11 Sep 2016 16:28:55 +0200 Subject: Clarify encryption.setup_*() documentation This tries to make it clearer that the setup_preshared_key() and setup_pbkdf2() functions are meant to be used when writing out PSKC files. --- pskc/encryption.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'pskc/encryption.py') diff --git a/pskc/encryption.py b/pskc/encryption.py index 4ca2042..16cc565 100644 --- a/pskc/encryption.py +++ b/pskc/encryption.py @@ -320,7 +320,7 @@ class Encryption(object): self.pskc.mac.setup() def setup_preshared_key(self, **kwargs): - """Configure pre-shared key encryption. + """Configure pre-shared key encryption when writing the file. The following arguments may be supplied: key: the encryption key to use @@ -342,7 +342,7 @@ class Encryption(object): 'key_length', self.algorithm_key_lengths[-1])) def setup_pbkdf2(self, password, **kwargs): - """Configure password-based PSKC encryption. + """Configure password-based PSKC encryption when writing the file. The following arguments may be supplied: password: the password to use (required) -- cgit v1.2.3