Merge lp:~shanemhansen/pyopenssl/dump_publickey into lp:~exarkun/pyopenssl/trunk

[Shane Hansen]

This change implements the crypto.dump_publickey API. There are tests for ASN1 and PEM formatting.
There seem to be a number of api's for dumping public keys but I was able to match the PEM and ASN1 output with the openssl pkey tool which uses the PEM_write_bio_PUBKEY and i2d_PUBKEY_bio apis.

This is my first attempt at submitting something like this, so let me know on #pyopenssl if there's anything I can add. Thanks!

[Jean-Paul Calderone (exarkun)]

Thanks. Some observations:

  1. The switch in crypto_dump_publickey has a default case that raises an exception with a message talking about FILETYPE_TEXT being a valid input, but there is no FILETYPE_TEXT case in the switch statement.
  2. There's a `print` statement left in test_dump_publickey_valid_filetype
  3. I'd like to see test_dump_publickey_valid_filetype split into two tests, one for FILETYPE_ASN1 and one for FILETYPE_PEM.
  4. There's a bit of trailing whitespace after test_dump_publickey_valid_filetype which should be deleted.
  5. All APIs should be documented in doc/api/ as well.

Otherwise this looks good. Thanks!

review: Needs Fixing

[Shane Hansen (shanemhansen)]

Thanks for the feedback, I've made the requested changes and repushed.
Let me know if there are any steps I've missed.

On Sat, Oct 20, 2012 at 6:25 PM, Jean-Paul Calderone <
<email address hidden>> wrote:

> The proposal to merge lp:~shanemhansen/pyopenssl/dump_publickey into
> lp:pyopenssl has been updated.
>
> Status: Needs review => Work in progress
>
> For more details, see:
>
> https://code.launchpad.net/~shanemhansen/pyopenssl/dump_publickey/+merge/125370
> --
>
> https://code.launchpad.net/~shanemhansen/pyopenssl/dump_publickey/+merge/125370
> You are the owner of lp:~shanemhansen/pyopenssl/dump_publickey.
>

Unmerged revisions

170. By Shane Hansen on 2012-10-21

Remove spurious print statement, incorrect exception statement,
and split up tests for dump_publickey.

169. By Space Monkey on 2012-09-19

Implement crypto.dump_publickey API (with tests)

=== modified file 'OpenSSL/crypto/crypto.c'
--- OpenSSL/crypto/crypto.c	2009-12-22 16:02:04 +0000
+++ OpenSSL/crypto/crypto.c	2012-10-21 20:06:21 +0000
@@ -171,6 +171,60 @@
     return (PyObject *)crypto_PKey_New(pkey, 1);
 }
 
+static char crypto_dump_publickey_doc[] = "\n\
+Dump a public key to a buffer\n\
+\n\
+:param type: The file type (one of FILETYPE_PEM, FILETYPE_ASN1)\n\
+:param pkey: The PKey to dump\n\
+:return: The buffer with the dumped key in\n\
+:rtype: :py:data:`str`\n\
+";
+
+static PyObject *
+crypto_dump_publickey(PyObject *spam, PyObject *args)
+{
+    int type, ret, buf_len;
+    char *temp;
+    PyObject *buffer;
+    BIO *bio;
+    crypto_PKeyObj *pkey;
+
+    if (!PyArg_ParseTuple(args, "iO!:dump_publickey", &type,
+                          &crypto_PKey_Type, &pkey)) {
+        return NULL;
+    }
+    bio = BIO_new(BIO_s_mem());
+    if (bio == NULL) {
+        exception_from_error_queue(crypto_Error);
+        return NULL;
+    }
+    switch (type) {
+        case X509_FILETYPE_PEM:
+            ret = PEM_write_bio_PUBKEY(bio, pkey->pkey);
+            break;
+
+        case X509_FILETYPE_ASN1:
+            ret = i2d_PUBKEY_bio(bio, pkey->pkey);
+            break;
+
+        default:
+            PyErr_SetString(PyExc_ValueError, "type argument must be FILETYPE_PEM, FILETYPE_ASN1");
+            BIO_free(bio);
+            return NULL;
+    }
+
+    if (ret == 0) {
+        BIO_free(bio);
+        return raise_current_error();
+    }
+
+    buf_len = BIO_get_mem_data(bio, &temp);
+    buffer = PyBytes_FromStringAndSize(temp, buf_len);
+    BIO_free(bio);
+
+    return buffer;
+}
+
 static char crypto_dump_privatekey_doc[] = "\n\
 Dump a private key to a buffer\n\
 \n\
@@ -185,6 +239,7 @@
 :rtype: :py:data:`str`\n\
 ";
 
+
 static PyObject *
 crypto_dump_privatekey(PyObject *spam, PyObject *args)
 {
@@ -733,6 +788,7 @@
     /* Module functions */
     { "load_privatekey",  (PyCFunction)crypto_load_privatekey,  METH_VARARGS, crypto_load_privatekey_doc },
     { "dump_privatekey",  (PyCFunction)crypto_dump_privatekey,  METH_VARARGS, crypto_dump_privatekey_doc },
+    { "dump_publickey",  (PyCFunction)crypto_dump_publickey,  METH_VARARGS, crypto_dump_publickey_doc },
     { "load_certificate", (PyCFunction)crypto_load_certificate, METH_VARARGS, crypto_load_certificate_doc },
     { "dump_certificate", (PyCFunction)crypto_dump_certificate, METH_VARARGS, crypto_dump_certificate_doc },
     { "load_certificate_request", (PyCFunction)crypto_load_certificate_request, METH_VARARGS, crypto_load_certificate_request_doc },

=== modified file 'OpenSSL/test/test_crypto.py'
--- OpenSSL/test/test_crypto.py	2012-03-09 22:58:00 +0000
+++ OpenSSL/test/test_crypto.py	2012-10-21 20:06:21 +0000
@@ -18,7 +18,8 @@
 from OpenSSL.crypto import load_certificate, load_privatekey
 from OpenSSL.crypto import FILETYPE_PEM, FILETYPE_ASN1, FILETYPE_TEXT
 from OpenSSL.crypto import dump_certificate, load_certificate_request
-from OpenSSL.crypto import dump_certificate_request, dump_privatekey
+from OpenSSL.crypto import dump_certificate_request, dump_privatekey, dump_publickey
+from OpenSSL.crypto import dump_publickey
 from OpenSSL.crypto import PKCS7Type, load_pkcs7_data
 from OpenSSL.crypto import PKCS12, PKCS12Type, load_pkcs12
 from OpenSSL.crypto import CRL, Revoked, load_crl
@@ -71,6 +72,24 @@
 -----END RSA PRIVATE KEY-----
 """)
 
+#Generated from `openssl pkey -pubout` on root_key_pem
+root_public_key_pem = b("""-----BEGIN PUBLIC KEY-----
+MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQD5mkLpi7q6ROdu7khB3S9aanA0
+Zls7vvfGOmB80/yeylhGpsjAjWen0VtSQke/NlEPGtO38tsV7CsuFnSmschvAnGr
+cJl76b0UOOHUgDTIoRxC6QDU3claegwsrBA+sJEBbqx5RdXbIRGicPG/8qQ4Zm1S
+KOgotcbwiaor2yxZ2wIDAQAB
+-----END PUBLIC KEY-----
+""")
+#Generated from `openssl pkey -pubout -outform DER` on root_key_pem
+root_public_key_asn1 = b("""0\x81\x9f0\r\x06\t*\x86H\x86\xf7\r\x01\
+\x01\x01\x05\x00\x03\x81\x8d\x000\x81\x89\x02\x81\x81\x00\xf9\x9aB\
+\xe9\x8b\xba\xbaD\xe7n\xeeHA\xdd/Zjp4f[;\xbe\xf7\xc6:`|\xd3\xfc\x9e\
+\xcaXF\xa6\xc8\xc0\x8dg\xa7\xd1[RBG\xbf6Q\x0f\x1a\xd3\xb7\xf2\xdb\
+\x15\xec+.\x16t\xa6\xb1\xc8o\x02q\xabp\x99{\xe9\xbd\x148\xe1\xd4\
+\x804\xc8\xa1\x1cB\xe9\x00\xd4\xdd\xc9Zz\x0c,\xac\x10>\xb0\x91\x01n\
+\xacyE\xd5\xdb!\x11\xa2p\xf1\xbf\xf2\xa48fmR(\xe8(\xb5\xc6\xf0\x89\
+\xaa+\xdb,Y\xdb\x02\x03\x01\x00\x01""")
+
 server_cert_pem = b("""-----BEGIN CERTIFICATE-----
 MIICKDCCAZGgAwIBAgIJAJn/HpR21r/8MA0GCSqGSIb3DQEBBQUAMFgxCzAJBgNV
 BAYTAlVTMQswCQYDVQQIEwJJTDEQMA4GA1UEBxMHQ2hpY2FnbzEQMA4GA1UEChMH
@@ -2069,6 +2088,40 @@
             load_privatekey,
             FILETYPE_PEM, encryptedPrivateKeyPEM, lambda *args: 3)
 
+    def test_dump_publickey_wrong_args(self):
+        """
+        :py:obj:`dump_publickey` raises :py:obj:`TypeError` if called with the wrong number
+        of arguments.
+        """
+        self.assertRaises(TypeError, dump_publickey)
+
+    def test_dump_publickey_invalid_filetype(self):
+        """
+        :py:obj:`dump_publickey` raises :py:obj:`ValueError` if called with an unrecognized
+        filetype.
+        """
+        key = PKey()
+        key.generate_key(TYPE_RSA, 512)
+        self.assertRaises(ValueError, dump_publickey, 100, key)
+
+    def test_dump_publickey_valid_filetype_asn1(self):
+        """
+        :py:obj:`dump_publickey` can successfully dump an RSA public key
+        in ASN1 format
+        """
+        key = load_privatekey(FILETYPE_PEM, root_key_pem)
+        buf = dump_publickey(FILETYPE_ASN1, key)
+        self.assertEqual(buf, root_public_key_asn1,
+                         "Public key matches that from openssl DER")
+
+    def test_dump_publickey_valid_filetype_PEM(self):
+        """
+        :py:obj:`dump_publickey` can successfully dump an RSA public key.
+        """
+        key = load_privatekey(FILETYPE_PEM, root_key_pem)
+        buf = dump_publickey(FILETYPE_PEM, key)
+        self.assertEqual(buf, root_public_key_pem,
+                         "Public key matches that from openssl PEM")
 
     def test_dump_privatekey_wrong_args(self):
         """

=== modified file 'doc/api/crypto.rst'
--- doc/api/crypto.rst	2012-09-12 14:49:07 +0000
+++ doc/api/crypto.rst	2012-10-21 20:06:21 +0000
@@ -141,6 +141,15 @@
     pass phrase.
 
 
+.. py:function:: dump_publickey(type, pkey)
+
+    Dump the publickey key *pkey* into a buffer string encoded with the type
+    *type*.
+
+    *type* is one of (:py:const:`FILETYPE_PEM`, :py:const:`FILETYPE_ASN1`).
+    *pkey* is a :py:class:`PKey` instance.
+
+
 .. py:function:: load_certificate(type, buffer)
 
     Load a certificate (X509) from the string *buffer* encoded with the