diff options
| author | André Almeida <andrefalmeida@protonmail.com> | 2018-12-08 23:53:10 -0200 |
|---|---|---|
| committer | Alex Gaynor <alex.gaynor@gmail.com> | 2018-12-08 20:53:10 -0500 |
| commit | 5bc3bf7d36d872af5ab79c7531c80a7793c76307 (patch) | |
| tree | 5cfba43d52f0b874d18fa75a25844a5db3226b10 /docs | |
| parent | bddcd52eadba275770bbc2070799314c1b5b179b (diff) | |
| download | cryptography-5bc3bf7d36d872af5ab79c7531c80a7793c76307.tar.gz cryptography-5bc3bf7d36d872af5ab79c7531c80a7793c76307.tar.bz2 cryptography-5bc3bf7d36d872af5ab79c7531c80a7793c76307.zip | |
Adds a more descriptive error msg for wrong wrapping (#4504)
* PoC code for check PEM wrap
* Remove PoC check wrap code
* Add PEM file info to FAQ
* Add FAQ/PEM link in exception message
* Fix flake8 style issues
* refactor, update language
* it's really amazing how bad the spell checker is
* review feedback
* change to etc
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/faq.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/faq.rst b/docs/faq.rst index dce94b73..6d876610 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -111,6 +111,38 @@ not yet possible you can also install ``cryptography`` with dependency. This workaround will be available until the feature is fully removed. +Why can't I import my PEM file? +------------------------------- + +PEM is a format (defined by several RFCs, but originally :rfc:`1421`) for +encoding keys, certificates and others cryptographic data into a regular form. +The data is encoded as base64 and wrapped with a header and footer. + +If you are having trouble importing PEM files, make sure your file fits +the following rules: + +* has a one-line header like this: ``-----BEGIN [FILE TYPE]-----`` + (where ``[FILE TYPE]`` is ``CERTIFICATE``, ``PUBLIC KEY``, ``PRIVATE KEY``, + etc.) + +* has a one-line footer like this: ``-----END [FILE TYPE]-----`` + +* all lines, except for the final one, must consist of exactly 64 + characters. + +For example, this is a PEM file for a RSA Public Key: :: + + -----BEGIN PUBLIC KEY----- + MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA7CsKFSzq20NLb2VQDXma + 9DsDXtKADv0ziI5hT1KG6Bex5seE9pUoEcUxNv4uXo2jzAUgyRweRl/DLU8SoN8+ + WWd6YWik4GZvNv7j0z28h9Q5jRySxy4dmElFtIRHGiKhqd1Z06z4AzrmKEzgxkOk + LJjY9cvwD+iXjpK2oJwNNyavvjb5YZq6V60RhpyNtKpMh2+zRLgIk9sROEPQeYfK + 22zj2CnGBMg5Gm2uPOsGDltl/I/Fdh1aO3X4i1GXwCuPf1kSAg6lPJD0batftkSG + v0X0heUaV0j1HSNlBWamT4IR9+iJfKJHekOqvHQBcaCu7Ja4kXzx6GZ3M2j/Ja3A + 2QIDAQAB + -----END PUBLIC KEY----- + + .. _`NaCl`: https://nacl.cr.yp.to/ .. _`PyNaCl`: https://pynacl.readthedocs.io .. _`WSGIApplicationGroup`: https://modwsgi.readthedocs.io/en/develop/configuration-directives/WSGIApplicationGroup.html |