skip to navigation
skip to content

Not Logged In

pem 0.2.0

Parse and split PEM files painlessly.

Latest Version: 0.3.0

pem: Easy PEM file parsing

pem is an MIT-licensed Python module for parsing and splitting of PEM files, i.e. Base64 encoded DER keys and certificates.

It runs on Python 2.6, 2.7, 3.3, and PyPy 2.0+, has no dependencies and does not attempt to interpret the certificate data in any way. pem is intended to ease the handling of PEM files in combination with PyOpenSSL and – by extension – Twisted.

It’s born from my personal need because of the inconsistent handling of chain certificates by various servers: some servers (like Apache) expect them to be a separate file while others (like nginx) expect them concatenated to the server certificate. Since I want my Python software to be universal and to be able to cope with both, pem was born.

The core API call is the function parse():

import pem

with open('cert.pem', 'rb') as f:
   certs = pem.parse(f.read())

The function returns a list of valid PEM objects found in the string supplied. Currently possible types are Certificate and RSAPrivateKey. Both can be transformed using str() into plain strings for other APIs. They don’t offer any other public API at the moment.

Convenience

Since pem is mostly a convenience module, there are several helper functions.

Files

parse_file(file_name) reads the file file_name and parses its contents. So the following example is equivalent with the first one:

import pem

certs = pem.parse_file('cert.pem')

Twisted

A typical use case in Twisted with the APIs above would be:

import pem

from twisted.internet import ssl

key = pem.parse_file('key.pem')
cert, chain = pem.parse_file('cert_and_chain.pem')
cert = ssl.PrivateCertificate.loadPEM(str(key) + str(cert))
chainCert = ssl.Certificate.loadPEM(str(chain))

ctxFactory = ssl.CertificateOptions(
      privateKey=cert.privateKey.original,
      certificate=cert.original,
      extraCertChain=[chainCert.original],
)

Turns out, this is the major use case for me. Therefore it can be simplified to:

import pem

ctxFactory = pem.certificateOptionsFromFiles(
   'key.pem', 'cert_and_chain.pem',
)

The first certificate found will be used as the server certificate, the rest is passed as the chain. You can pass as many PEM files as you like. Therefore you can distribute your key, certificate, and chain certificates over a arbitrary number of files. A ValueError is raised if more than one key, no key, or no certificate are found. Any further keyword arguments will be passed to CertificateOptions.

Ephemeral Diffie-Hellman support

Starting with version 14.0.0, Twisted will support ephemeral Diffie-Hellman ciphersuites; you can pass an instance of twisted.internet.ssl.DiffieHellmanParameters as the dhParameters keyword argument to CertificateOptions. Since pem just passes keyword arguments to CertificateOptions verbatim, that will just work.

However, pem is also forward compatible. Twisted 14.0.0 is not released yet, but pem lets you use the API described above anyway. You can just use pem.DiffieHellmanParameters: if your version of Twisted comes with that class, you just get the Twisted version; if it doesn’t, you get a version from pem.

Just pass instances of that class as dhParameters to certificateOptionsFromFiles, and pem will make it magically work:

import pem

from twisted.python.filepath import FilePath

path = FilePath("/path/to/the/dh/params")
ctxFactory = pem.certificateOptionsFromFiles(
   'key.pem', 'cert_and_chain.pem',
   dhParameters=pem.DiffieHellmanParameters.fromFile(path)
)

Future

pem currently only supports the PyOpenSSL/Twisted combo because that’s what I’m using. I’d be more than happy to merge support for additional frameworks though!

History

0.2.0 (2014-03-13)

  • Add forward-compatible support for DHE.

0.1.0 (2013-07-18)

  • Initial release.

Credits

“pem” is written and maintained by Hynek Schlawack.

Contributors

The following wonderful people contributed directly or indirectly to this project:

lvh <_@lvh.io>

Please add yourself here alphabetically when you submit your first pull request.

 
File Type Py Version Uploaded on Size
pem-0.2.0-py2.py3-none-any.whl (md5, pgp) Python Wheel py2.py3 2014-03-13 10KB
pem-0.2.0.tar.gz (md5, pgp) Source 2014-03-13 9KB
  • Downloads (All Versions):
  • 6 downloads in the last day
  • 113 downloads in the last week
  • 493 downloads in the last month