DOC: Arg interactions for import_rsa_privatekey_from_file

Clarify behavior if prompt is True and password is provided anyway (raises error). Also corrects a typo. Signed-off-by: Sebastien Awwad <[email protected]>
secure-systems-lab · Apr 3, 2018 · 0c04885 · 0c04885
1 parent 8560add
commit 0c04885
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/securesystemslib/interface.py b/securesystemslib/interface.py
@@ -14,7 +14,7 @@
   See LICENSE for licensing information.
 
 <Purpose>
-  Provide an interface to the cryptography funtions available in
+  Provide an interface to the cryptography functions available in
   securesystemslib.  The interface can be used with the Python interpreter in
   interactive mode, or imported directly into a Python module.  See
   'securesystemslib/README' for the complete guide to using 'interface.py'.
@@ -246,8 +246,7 @@ def import_rsa_privatekey_from_file(filepath, password=None,
     If prompt is True use entered password for decryption.
     If no password is passed or entered, or if the entered password is an empty
     string, omit decryption.
-
-    Passing and prompting for a password is not possible.
+    If password is passed and prompt is True, an error is raised. (See below.)
 
     The returned key is an object in the
     'securesystemslib.formats.RSAKEY_SCHEMA' format.