security.rst 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. Security
  2. ========
  3. We take the security of ``cryptography`` seriously. The following are a set of
  4. policies we have adopted to ensure that security issues are addressed in a
  5. timely fashion.
  6. Reporting a security issue
  7. --------------------------
  8. We ask that you do not report security issues to our normal GitHub issue
  9. tracker.
  10. If you believe you've identified a security issue with ``cryptography``, please
  11. report it to ``alex.gaynor@gmail.com``. Messages may be optionally encrypted
  12. with PGP using key fingerprint
  13. ``E27D 4AA0 1651 72CB C5D2 AF2B 125F 5C67 DFE9 4084`` (this public key is
  14. available from most commonly-used key servers).
  15. Once you've submitted an issue via email, you should receive an acknowledgment
  16. within 48 hours, and depending on the action to be taken, you may receive
  17. further follow-up emails.
  18. Supported Versions
  19. ------------------
  20. At any given time, we will provide security support for the `master`_ branch
  21. as well as the 2 most recent releases.
  22. New releases for OpenSSL updates
  23. --------------------------------
  24. As of version 0.5, ``cryptography`` statically links OpenSSL on Windows, and as
  25. of version 1.0.1 on OS X, to ease installation. Due to this, ``cryptography``
  26. will release a new version whenever OpenSSL has a security or bug fix release to
  27. avoid shipping insecure software.
  28. Like all our other releases, this will be announced on the mailing list and we
  29. strongly recommend that you upgrade as soon as possible.
  30. Disclosure Process
  31. ------------------
  32. Our process for taking a security issue from private discussion to public
  33. disclosure involves multiple steps.
  34. Approximately one week before full public disclosure, we will send advance
  35. notification of the issue to a list of people and organizations, primarily
  36. composed of operating-system vendors and other distributors of
  37. ``cryptography``. This notification will consist of an email message
  38. containing:
  39. * A full description of the issue and the affected versions of
  40. ``cryptography``.
  41. * The steps we will be taking to remedy the issue.
  42. * The patches, if any, that will be applied to ``cryptography``.
  43. * The date on which the ``cryptography`` team will apply these patches, issue
  44. new releases, and publicly disclose the issue.
  45. Simultaneously, the reporter of the issue will receive notification of the date
  46. on which we plan to take the issue public.
  47. On the day of disclosure, we will take the following steps:
  48. * Apply the relevant patches to the ``cryptography`` repository. The commit
  49. messages for these patches will indicate that they are for security issues,
  50. but will not describe the issue in any detail; instead, they will warn of
  51. upcoming disclosure.
  52. * Issue the relevant releases.
  53. * Post a notice to the cryptography mailing list that describes the issue in
  54. detail, point to the new release and crediting the reporter of the issue.
  55. If a reported issue is believed to be particularly time-sensitive – due to a
  56. known exploit in the wild, for example – the time between advance notification
  57. and public disclosure may be shortened considerably.
  58. The list of people and organizations who receives advanced notification of
  59. security issues is not and will not be made public. This list generally
  60. consists of high profile downstream distributors and is entirely at the
  61. discretion of the ``cryptography`` team.
  62. .. _`master`: https://github.com/pyca/cryptography