classification
Title: Dead link in SSLContext.set_ciphers documentation
Type: Stage: resolved
Components: Documentation Versions: Python 3.7, Python 3.6, Python 2.7
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: Mariatta, christian.heimes, docs@python, fov, pitrou
Priority: normal Keywords: patch

Created on 2017-09-20 15:43 by fov, last changed 2017-09-20 20:24 by Mariatta. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 3674 merged python-dev, 2017-09-20 18:05
PR 3675 merged python-dev, 2017-09-20 18:20
PR 3676 merged christian.heimes, 2017-09-20 18:24
Messages (12)
msg302629 - (view) Author: Felipe (fov) * Date: 2017-09-20 15:43
The link to the `OpenSSL cipher list format` 404s. I don't know if it's where the original meant to point, but the same information is available at https://wiki.openssl.org/index.php/Manual:Ciphers(1)#CIPHER_LIST_FORMAT
msg302632 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-09-20 16:11
Where in the docs is this `OpenSSL cipher list format` link located?
msg302634 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2017-09-20 16:51
Mariatta, that would be in the documentation for the `SSLContext.set_ciphers` method (in `Doc/library/ssl.rst`).
msg302635 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-09-20 16:56
Thanks Antoine. So is this a matter of replacing the url to https://wiki.openssl.org/index.php/Manual:Ciphers(1)#CIPHER_LIST_FORMAT?
Or is there a better url that will not go out of date in the future...
msg302636 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2017-09-20 16:57
I don't think OpenSSL are promising anything about their URLs (the old one having gone 404 is proof of that :-)). So Felipe's suggestion is as good as any, IMHO.
msg302638 - (view) Author: Felipe (fov) * Date: 2017-09-20 17:00
Woops. Apologies -- I somehow deleted that part from the report. Thanks Antoine for jumping in. If you are using the wiki url, make sure not to include the question mark at the end :-)
msg302639 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-09-20 17:16
Cool! I'm tagging this as an easy issue, suitable for first timers or new contributors. 

Felipe, are you up for preparing the PR?
msg302644 - (view) Author: Felipe (fov) * Date: 2017-09-20 17:58
Sure, will do!
msg302648 - (view) Author: Christian Heimes (christian.heimes) * (Python committer) Date: 2017-09-20 18:20
New changeset 19e4d9346db7fb65845b98a9cb9caacaaac8a81a by Christian Heimes (Felipe) in branch 'master':
bpo-31533: fix broken link to OpenSSL docs (#3674)
https://github.com/python/cpython/commit/19e4d9346db7fb65845b98a9cb9caacaaac8a81a
msg302656 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-09-20 20:22
New changeset 6b44ad1abdb9b3aaf27e2ba1fc4b69b9a0f50c25 by Mariatta (Miss Islington (bot)) in branch '3.6':
bpo-31533: fix broken link to OpenSSL docs (GH-3674) (GH-3675)
https://github.com/python/cpython/commit/6b44ad1abdb9b3aaf27e2ba1fc4b69b9a0f50c25
msg302657 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-09-20 20:23
New changeset 5b6452d412b5be45f265093e75563fcf6d05dc3e by Mariatta (Christian Heimes) in branch '2.7':
bpo-31533: fix broken link to OpenSSL docs (GH-3674) (GH-3676)
https://github.com/python/cpython/commit/5b6452d412b5be45f265093e75563fcf6d05dc3e
msg302658 - (view) Author: Mariatta (Mariatta) * (Python committer) Date: 2017-09-20 20:24
Fixed and backported.
Thanks everyone!
History
Date User Action Args
2017-09-20 20:24:08Mariattasetstatus: open -> closed
resolution: fixed
messages: + msg302658

stage: patch review -> resolved
2017-09-20 20:23:11Mariattasetmessages: + msg302657
2017-09-20 20:22:59Mariattasetmessages: + msg302656
2017-09-20 18:24:53christian.heimessetpull_requests: + pull_request3665
2017-09-20 18:20:33python-devsetpull_requests: + pull_request3664
2017-09-20 18:20:20christian.heimessetmessages: + msg302648
2017-09-20 18:05:35python-devsetkeywords: + patch
stage: needs patch -> patch review
pull_requests: + pull_request3663
2017-09-20 17:58:23fovsetmessages: + msg302644
2017-09-20 17:16:04Mariattasetmessages: + msg302639
2017-09-20 17:00:40fovsetmessages: + msg302638
2017-09-20 16:57:27pitrousetnosy: + christian.heimes
messages: + msg302636
2017-09-20 16:56:35Mariattasetstage: needs patch
messages: + msg302635
versions: + Python 2.7, - Python 3.4, Python 3.5
2017-09-20 16:51:43pitrousetnosy: + pitrou
messages: + msg302634
2017-09-20 16:11:09Mariattasetnosy: + Mariatta
messages: + msg302632
2017-09-20 15:43:21fovcreate