Update _generate_keypair* documented side effects

Document as a side effect the overwriting of existing keys
with the same filepath.

Signed-off-by: Teodora Sechkova <[email protected]>

Author: sechkova

securesystemslib/interface.py

@@ -213,6 +213,7 @@ def _generate_and_write_rsa_keypair(filepath=None, bits=DEFAULT_RSA_KEY_BITS,
   Side Effects:
     Prompts user for a password if 'prompt' is True.
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -280,6 +281,7 @@ def generate_and_write_rsa_keypair(password, filepath=None,
 
   Side Effects:
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -316,6 +318,7 @@ def generate_and_write_rsa_keypair_with_prompt(filepath=None,
   Side Effects:
     Prompts user for a password.
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -348,6 +351,7 @@ def generate_and_write_unencrypted_rsa_keypair(filepath=None,
 
   Side Effects:
     Writes unencrypted key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -481,6 +485,7 @@ def _generate_and_write_ed25519_keypair(filepath=None, password=None,
   Side Effects:
     Prompts user for a password if 'prompt' is True.
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -549,6 +554,7 @@ def generate_and_write_ed25519_keypair(password, filepath=None):
 
   Side Effects:
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -581,6 +587,7 @@ def generate_and_write_ed25519_keypair_with_prompt(filepath=None):
   Side Effects:
     Prompts user for a password.
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -608,6 +615,7 @@ def generate_and_write_unencrypted_ed25519_keypair(filepath=None):
 
   Side Effects:
     Writes unencrypted key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -727,6 +735,7 @@ def _generate_and_write_ecdsa_keypair(filepath=None, password=None,
   Side Effects:
     Prompts user for a password if 'prompt' is True.
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -795,6 +804,7 @@ def generate_and_write_ecdsa_keypair(password, filepath=None):
 
   Side Effects:
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -827,6 +837,7 @@ def generate_and_write_ecdsa_keypair_with_prompt(filepath=None):
   Side Effects:
     Prompts user for a password.
     Writes key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.
@@ -854,6 +865,7 @@ def generate_and_write_unencrypted_ecdsa_keypair(filepath=None):
 
   Side Effects:
     Writes unencrypted key files to disk.
+    Overwrites filepath if already exists.
 
   Returns:
     The private key filepath.