Support for serializing/deserializing public keys #382

Lukasa · 2015-10-27T08:00:40Z

This is needed for HPKP in urllib3, to avoid using lots of cryptography private functions. It also adds symmetry to the equivalent private key functions.

reaperhulk · 2015-10-27T08:03:31Z

This needs a changelog entry :)

codecov-io · 2015-10-27T08:17:09Z

Current coverage is `87.73%`

Merging #382 into master will increase coverage by +0.14% as of 4e3c3d1

@@            master    #382   diff @@
======================================
  Files            7       7       
  Stmts         2024    2047    +23
  Branches       371     377     +6
  Methods          0       0       
======================================
+ Hit           1773    1796    +23
  Partial        121     121       
  Missed         130     130

Review entire Coverage Diff as of 4e3c3d1

Powered by Codecov. Updated on successful CI builds.

Lukasa · 2015-10-27T08:40:49Z

@hynek Thoughts on how to hit that last line of the diff? It's going to be tricky to feed something that will cause write_bio to fail. @reaperhulk has some opinions he'd like to share.

reaperhulk · 2015-10-27T08:44:10Z

Covering these failure conditionals is hard and we should really do it with a function like openssl_assert in cryptography :)

hynek · 2015-10-27T08:50:45Z

You can put a pragma no cover on it for now. Also please get rid of those dreadful :py: prefixes. :)

Lukasa · 2015-10-28T00:13:41Z

Hooray, all green! \o/

Lukasa · 2015-10-28T01:12:15Z

@hynek Done.

hynek · 2015-10-28T05:36:16Z

Cory, what was the very first review comment by Paul? ;)

Lukasa · 2015-10-28T05:40:31Z

@hynek I don't read Paul's comments. ;)

hynek · 2015-10-28T05:43:28Z

src/OpenSSL/crypto.py

+    """
+    Dump a public key to a buffer.
+
+    :param type: The file type (one of :py:data:`FILETYPE_PEM` or


Lukasa · 2015-10-28T07:44:45Z

Updated.

hynek · 2015-10-28T08:34:11Z

src/OpenSSL/crypto.py

+
+    :param type: The file type (one of :data:`FILETYPE_PEM`,
+        :data:`FILETYPE_ASN1`).
+    :param buffer: The buffer the key is stored in. Must be a Python string


This si what we have :type buffer: for fine sir :)

hynek · 2015-10-28T10:26:45Z

please move the changelog entries to the top (within the changes section!) :D you can also make it one entry for all I care.
you forgot to add the autofunction directives to crypto.rst :) (we don't do automodule)

hynek · 2015-10-28T10:59:12Z

src/OpenSSL/crypto.py

+    :param type: The file type (one of :data:`FILETYPE_PEM` or
+        :data:`FILETYPE_ASN1`).
+    :param pkey: The PKey to dump.
+    :type pkey: :class:`PKey`


How about :param PKey pkey: The public key to dump?

:class: is definitely not necessary if you write type markup (and it's only the one type).

Lukasa · 2015-10-28T13:20:14Z

And updated again. =D

Support for serializing/deserializing public keys

Changes: 16.0.0 (2016-03-19) ------------------- This is the first release under full stewardship of PyCA. We have made *many* changes to make local development more pleasing. The test suite now passes both on Linux and OS X with OpenSSL 0.9.8, 1.0.1, and 1.0.2. It has been moved to `py.test <https://pytest.org/>`_, all CI test runs are part of `tox <https://testrun.org/tox/>`_ and the source code has been made fully `flake8 <https://flake8.readthedocs.org/>`_ compliant. We hope to have lowered the barrier for contributions significantly but are open to hear about any remaining frustrations. Backward-incompatible changes: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Python 3.2 support has been dropped. It never had significant real world usage and has been dropped by our main dependency ``cryptography``. Affected users should upgrade to Python 3.3 or later. Deprecations: ^^^^^^^^^^^^^ - The support for EGD has been removed. The only affected function ``OpenSSL.rand.egd()`` now uses ``os.urandom()`` to seed the internal PRNG instead. Please see `pyca/cryptography#1636 <https://github.com/pyca/cryptography/pull/1636>`_ for more background information on this decision. In accordance with our backward compatibility policy ``OpenSSL.rand.egd()`` will be *removed* no sooner than a year from the release of 16.0.0. Please note that you should `use urandom <http://sockpuppet.org/blog/2014/02/25/safely-generate-random-numbers/>`_ for all your secure random number needs. - Python 2.6 support has been deprecated. Our main dependency ``cryptography`` deprecated 2.6 in version 0.9 (2015-05-14) with no time table for actually dropping it. pyOpenSSL will drop Python 2.6 support once ``cryptography`` does. Changes: ^^^^^^^^ - Fixed ``OpenSSL.SSL.Context.set_session_id``, ``OpenSSL.SSL.Connection.renegotiate``, ``OpenSSL.SSL.Connection.renegotiate_pending``, and ``OpenSSL.SSL.Context.load_client_ca``. They were lacking an implementation since 0.14. `#422 <https://github.com/pyca/pyopenssl/pull/422>`_ - Fixed segmentation fault when using keys larger than 4096-bit to sign data. `#428 <https://github.com/pyca/pyopenssl/pull/428>`_ - Fixed ``AttributeError`` when ``OpenSSL.SSL.Connection.get_app_data()`` was called before setting any app data. `#304 <https://github.com/pyca/pyopenssl/pull/304>`_ - Added ``OpenSSL.crypto.dump_publickey()`` to dump ``OpenSSL.crypto.PKey`` objects that represent public keys, and ``OpenSSL.crypto.load_publickey()`` to load such objects from serialized representations. `#382 <https://github.com/pyca/pyopenssl/pull/382>`_ - Added ``OpenSSL.crypto.dump_crl()`` to dump a certificate revocation list out to a string buffer. `#368 <https://github.com/pyca/pyopenssl/pull/368>`_ - Added ``OpenSSL.SSL.Connection.get_state_string()`` using the OpenSSL binding ``state_string_long``. `#358 <https://github.com/pyca/pyopenssl/pull/358>`_ - Added support for the ``socket.MSG_PEEK`` flag to ``OpenSSL.SSL.Connection.recv()`` and ``OpenSSL.SSL.Connection.recv_into()``. `#294 <https://github.com/pyca/pyopenssl/pull/294>`_ - Added ``OpenSSL.SSL.Connection.get_protocol_version()`` and ``OpenSSL.SSL.Connection.get_protocol_version_name()``. `#244 <https://github.com/pyca/pyopenssl/pull/244>`_ - Switched to ``utf8string`` mask by default. OpenSSL formerly defaulted to a ``T61String`` if there were UTF-8 characters present. This was changed to default to ``UTF8String`` in the config around 2005, but the actual code didn't change it until late last year. This will default us to the setting that actually works. To revert this you can call ``OpenSSL.crypto._lib.ASN1_STRING_set_default_mask_asc(b"default")``. `#234 <https://github.com/pyca/pyopenssl/pull/234>`_

Support for serializing/deserializing public keys

6492f7c

Lukasa added 3 commits October 27, 2015 17:23

Cleanup docstrings.

11c1019

Switch to py.test assertions.

d86f1d8

Further testing for load/dump_publickey

e02c7d8

Lukasa added 2 commits October 28, 2015 08:57

Remove :py: prefixes

e813cec

No coverage on this branch

1e9c7ab

Lukasa mentioned this pull request Oct 28, 2015

[RFC] HPKP urllib3/urllib3#607

Closed

Add changelog for pyca#382

858b0a5

hynek reviewed Oct 28, 2015
View reviewed changes

src/OpenSSL/crypto.py

"""

Dump a public key to a buffer.

:param type: The file type (one of :py:data:`FILETYPE_PEM` or

Copy link

Contributor

hynek Oct 28, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still :py:

Further docstring cleanups.

9c590b9

hynek reviewed Oct 28, 2015
View reviewed changes

Lukasa added 2 commits October 28, 2015 17:39

Cleanup types in docstrings.

c9c30a2

Prettify the changelog.

0820ac2

hynek reviewed Oct 28, 2015
View reviewed changes

Document new publickey methods.

25338c5

Lukasa added 2 commits October 28, 2015 22:19

Further clarify dump_publickey argument types.

2b6bb80

Move publickey methods to top of changelog.

666b8c1

hynek added a commit that referenced this pull request Oct 28, 2015

Merge pull request #382 from Lukasa/dump_pubkey

3ca2eee

Support for serializing/deserializing public keys

hynek merged commit 3ca2eee into pyca:master Oct 28, 2015

github-actions bot locked as resolved and limited conversation to collaborators Aug 21, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for serializing/deserializing public keys #382

Support for serializing/deserializing public keys #382

Lukasa commented Oct 27, 2015

reaperhulk commented Oct 27, 2015

codecov-io commented Oct 27, 2015

Lukasa commented Oct 27, 2015

reaperhulk commented Oct 27, 2015

hynek commented Oct 27, 2015

Lukasa commented Oct 28, 2015

Lukasa commented Oct 28, 2015

hynek commented Oct 28, 2015

Lukasa commented Oct 28, 2015

hynek Oct 28, 2015

Lukasa commented Oct 28, 2015

hynek Oct 28, 2015

hynek commented Oct 28, 2015

hynek Oct 28, 2015

Lukasa commented Oct 28, 2015

Support for serializing/deserializing public keys #382

Support for serializing/deserializing public keys #382

Conversation

Lukasa commented Oct 27, 2015

reaperhulk commented Oct 27, 2015

codecov-io commented Oct 27, 2015

Current coverage is 87.73%

Lukasa commented Oct 27, 2015

reaperhulk commented Oct 27, 2015

hynek commented Oct 27, 2015

Lukasa commented Oct 28, 2015

Lukasa commented Oct 28, 2015

hynek commented Oct 28, 2015

Lukasa commented Oct 28, 2015

hynek Oct 28, 2015

Choose a reason for hiding this comment

Lukasa commented Oct 28, 2015

hynek Oct 28, 2015

Choose a reason for hiding this comment

hynek commented Oct 28, 2015

hynek Oct 28, 2015

Choose a reason for hiding this comment

Lukasa commented Oct 28, 2015

Current coverage is `87.73%`