diff options
| author | Arthur de Jong <arthur@arthurdejong.org> | 2016-09-11 16:28:55 +0200 |
|---|---|---|
| committer | Arthur de Jong <arthur@arthurdejong.org> | 2016-09-11 23:42:45 +0200 |
| commit | fa07aa588d8c0b5932bab2b056e07ed9c11dd7eb (patch) | |
| tree | 5904fd9763968cf3ec56f293fd71de259e3370df /pskc/encryption.py | |
| parent | a444f78959cc8f160f9a1b0c1c630e42c42ae407 (diff) | |
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.
Diffstat (limited to 'pskc/encryption.py')
| -rw-r--r-- | pskc/encryption.py | 4 |
1 files changed, 2 insertions, 2 deletions
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) |