Revize 18588728

Re #8472 - Small changes in the documentation

proj/services/cryptography.py

@@ -72 +72 @@
         Creates a private key with the option to encrypt it using a passphrase.
         :param passphrase: A passphrase to be used when encrypting the key (if none is passed then the key is not
         encrypted at all). Empty passphrase ("") also results in a key that is not encrypted.
-        :return: A text representation of the generated private key.
+        :return: string containing the generated private key in PEM format
         """
         if passphrase is None or len(passphrase) == 0:
             return self._run_for_output(["genrsa", "2048"]).decode()
@@ -80 +80 @@
             return self._run_for_output(
                 ["genrsa", PRIVATE_KEY_ENCRYPTION_METHOD, "-passout", f"pass:{passphrase}", "2048"]).decode()
 
-    def create_sscrt(self, key, subject, config="", extensions="", key_passphrase=None):
+    def create_sscrt(self, key, subject, config="", extensions="", key_pass=None):
         """
         Creates a root CA
 
@@ -88 +88 @@
         :param subject: an instance of <Subject> representing the subject to be added to the certificate
         :param config: string containing the configuration to be used
         :param extensions: name of the section in the configuration representing extensions
-        :param key_passphrase: passphrase of the private key
+        :param key_pass: passphrase of the private key
 
-        :return: byte array containing the generated certificate
+        :return: string containing the generated certificate in PEM format
         """
         assert key is not None
         assert subject is not None
@@ -111 +111 @@
 
             #  add the passphrase even when None is passed. Otherwise when running tests with pytest some tests freeze
             # waiting for the passphrase to be typed in
-            args.extend(["-passin", f"pass:{key_passphrase}"])
+            args.extend(["-passin", f"pass:{key_pass}"])
 
             return self._run_for_output(args, proc_input=bytes(key, encoding="utf-8")).decode()
 
@@ -122 +122 @@
         :param subject: an instance of <Subject> representing the subject to be added to the CSR
         :param subject_key: the private key of the subject to be used to generate the CSR
         :param subject_key_pass: passphrase of the subject's private key
-        :return: byte array containing the generated certificate signing request
+        :return: string containing the generated certificate signing request in PEM format
         """
 
         subj_param = self.subject_to_param_format(subject)
@@ -167 +167 @@
 
             return self._run_for_output(params, proc_input=(bytes(proc_input, encoding="utf-8"))).decode()
 
-    def create_crt(self, subject, key, issuer_pem, issuer_key, key_pass=None, issuer_key_pass=None, config="",
+    def create_crt(self, subject, subject_key, issuer_pem, issuer_key, subject_key_pass=None, issuer_key_pass=None,
+                   config="",
                    extensions=""):
         """
         Signs the given CSR by the given issuer CA
         :param subject: subject to be added to the created certificate
-        :param key: string containing the private key to be used when creating the certificate in PEM format
+        :param subject_key: string containing the private key to be used when creating the certificate in PEM format
         :param issuer_key: string containing the private key of the issuer's certificate in PEM format
         :param issuer_pem: string containing the certificate of the issuer that will sign this CSR in PEM format
         :param issuer_key: string containing the private key of the issuer's certificate in PEM format
-        :param key_pass: string containing the passphrase of the private key used when creating the certificate in PEM
+        :param subject_key_pass: string containing the passphrase of the private key used when creating the certificate in PEM
         format
         :param issuer_key_pass: string containing the passphrase of the private key of the issuer's certificate in PEM
         format
         :param config: TODO NOT USED
         :param extensions: extensions to be applied when creating the certificate
-        :return: string containing the generated in PEM format
+        :return: string containing the generated certificate in PEM format
         """
-        csr = self.make_csr(subject, key, subject_key_pass=key_pass)
+        csr = self.make_csr(subject, subject_key, subject_key_pass=subject_key_pass)
         return self.sign_csr(csr, issuer_pem, issuer_key, issuer_key_pass=issuer_key_pass, extensions=extensions)