GH-65056: Improve the IP address' is_global/is_private documentation #113186

jstasiak · 2023-12-15T17:35:45Z

It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed).

I opted to fully replace the docstrings with the content from the documentation to save myself some work.

Issue: ipaddress "is_private" and "is_global" are insufficiently documented and is_global probably has a bug #65056

📚 Documentation preview 📚: https://cpython-previews--113186.org.readthedocs.build/

…ation It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed). I opted to fully replace the docstrings with the content from the documentation to save myself some work.

jstasiak · 2023-12-15T17:38:34Z

I think the news entry can be safely skipped here.

Note that the documentation is accurate assuming that #113179 gets merged and the 100.64.0.0/10 range handling is left unchanged.

I'll adapt the documentation as needed.

encukou

LGTM, but I'd prefer saying shared address space rather than (or in addition to) the numbers -- at least in the public docs.

Doc/library/ipaddress.rst

Lib/ipaddress.py

Co-authored-by: Petr Viktorin <[email protected]>

jstasiak · 2024-03-13T23:02:29Z

That's more than fair, all suggestions applied.

…ation (pythonGH-113186) * pythonGH-65056: Improve the IP address' is_global/is_private documentation It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed). Co-authored-by: Petr Viktorin <[email protected]>

bedevere-app · 2024-04-23T12:07:35Z

GH-118177 is a backport of this pull request to the 3.12 branch.

…ges (GH-113179) (GH-113186) (GH-118177) * GH-113171: Fix "private" (non-global) IP address ranges (GH-113179) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] #61602 * GH-65056: Improve the IP address' is_global/is_private documentation (GH-113186) It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed). (cherry picked from commit 2a4cbf1) (cherry picked from commit 40d75c2) --------- Co-authored-by: Jakub Stasiak <[email protected]>

…s ranges (pythonGH-113179) (pythonGH-113186) (pythonGH-118177) * pythonGH-113171: Fix "private" (non-global) IP address ranges (pythonGH-113179) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] python#61602 * pythonGH-65056: Improve the IP address' is_global/is_private documentation (pythonGH-113186) It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed). (cherry picked from commit 2a4cbf1) (cherry picked from commit 40d75c2) --------- (cherry picked from commit f86b17a) Co-authored-by: Jakub Stasiak <[email protected]>

…ges (GH-113179) (GH-113186) (GH-118177) (#118227)

…s ranges (pythonGH-113179) (pythonGH-113186) (pythonGH-118177) * pythonGH-113171: Fix "private" (non-global) IP address ranges (pythonGH-113179) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] python#61602 * pythonGH-65056: Improve the IP address' is_global/is_private documentation (pythonGH-113186) It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed). (cherry picked from commit 2a4cbf1) (cherry picked from commit 40d75c2) --------- (cherry picked from commit f86b17a) Co-authored-by: Jakub Stasiak <[email protected]>

…ges (GH-113179) (GH-113186) (GH-118177) (GH-118229) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] #61602 In 3.10 and below, is_private checks whether the network and broadcast address are both private. In later versions (where the test wss backported from), it checks whether they both are in the same private network. For 0.0.0.0/0, both 0.0.0.0 and 255.225.255.255 are private, but one is in 0.0.0.0/8 ("This network") and the other in 255.255.255.255/32 ("Limited broadcast"). --------- Co-authored-by: Jakub Stasiak <[email protected]>

…es (GH-113179) (GH-113186) (GH-118177) (GH-118472) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] #61602 In 3.10 and below, is_private checks whether the network and broadcast address are both private. In later versions (where the test wss backported from), it checks whether they both are in the same private network. For 0.0.0.0/0, both 0.0.0.0 and 255.225.255.255 are private, but one is in 0.0.0.0/8 ("This network") and the other in 255.255.255.255/32 ("Limited broadcast"). --------- Co-authored-by: Jakub Stasiak <[email protected]>

…es (GH-113179) (GH-113186) (GH-118177) (GH-118479) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] #61602 In 3.10 and below, is_private checks whether the network and broadcast address are both private. In later versions (where the test wss backported from), it checks whether they both are in the same private network. For 0.0.0.0/0, both 0.0.0.0 and 255.225.255.255 are private, but one is in 0.0.0.0/8 ("This network") and the other in 255.255.255.255/32 ("Limited broadcast"). --------- Co-authored-by: Jakub Stasiak <[email protected]>

jstasiak · 2024-05-30T22:44:56Z

For visibility: I created GH-119812 to handle the Shared Address Space (100.64.0.0/10) exception documented here.

…113179) (pythonGH-113186) (pythonGH-118177) (cherry picked from commit f86b17a) Co-authored-by: Jakub Stasiak <[email protected]> (cherry picked from commit 05a1467) pythongh-113171: pythongh-65056: Fix "private" (non-global) IP address ranges (pythonGH-113179) (pythonGH-113186) (pythonGH-118177) * pythonGH-113171: Fix "private" (non-global) IP address ranges (pythonGH-113179) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] python#61602 * pythonGH-65056: Improve the IP address' is_global/is_private documentation (pythonGH-113186) It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed). (cherry picked from commit 2a4cbf1) (cherry picked from commit 40d75c2) --------- (cherry picked from commit f86b17a) Co-authored-by: Jakub Stasiak <[email protected]> (cherry picked from commit 05a1467) Add IPv6 addresses to suspignore.csv That's a lot of semicolons! (cherry picked from commit e366724) Add notable changes

…113179) (pythonGH-113186) (pythonGH-118177) * Fix "private" (non-global) IP address ranges (pythonGH-113179) (pythonGH-113186) (pythonGH-118177) (cherry picked from commit f86b17a) Co-authored-by: Jakub Stasiak <[email protected]> (cherry picked from commit 05a1467) pythongh-113171: pythongh-65056: Fix "private" (non-global) IP address ranges (pythonGH-113179) (pythonGH-113186) (pythonGH-118177) * pythonGH-113171: Fix "private" (non-global) IP address ranges (pythonGH-113179) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] python#61602 * pythonGH-65056: Improve the IP address' is_global/is_private documentation (pythonGH-113186) It wasn't clear what the semantics of is_global/is_private are and, when one gets to the bottom of it, it's not quite so simple (hence the exceptions listed). (cherry picked from commit 2a4cbf1) (cherry picked from commit 40d75c2) --------- (cherry picked from commit f86b17a) Co-authored-by: Jakub Stasiak <[email protected]> (cherry picked from commit 05a1467) Add IPv6 addresses to suspignore.csv That's a lot of semicolons! (cherry picked from commit e366724)

… address ranges (pythonGH-113179) (pythonGH-113186) (pythonGH-118177) (pythonGH-118472) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] python#61602 In 3.10 and below, is_private checks whether the network and broadcast address are both private. In later versions (where the test wss backported from), it checks whether they both are in the same private network. For 0.0.0.0/0, both 0.0.0.0 and 255.225.255.255 are private, but one is in 0.0.0.0/8 ("This network") and the other in 255.255.255.255/32 ("Limited broadcast"). --------- Co-authored-by: Jakub Stasiak <[email protected]>

… address ranges (pythonGH-113179) (pythonGH-113186) (pythonGH-118177) (pythonGH-118472) The _private_networks variables, used by various is_private implementations, were missing some ranges and at the same time had overly strict ranges (where there are more specific ranges considered globally reachable by the IANA registries). This patch updates the ranges with what was missing or otherwise incorrect. 100.64.0.0/10 is left alone, for now, as it's been made special in [1]. The _address_exclude_many() call returns 8 networks for IPv4, 121 networks for IPv6. [1] python#61602 In 3.10 and below, is_private checks whether the network and broadcast address are both private. In later versions (where the test wss backported from), it checks whether they both are in the same private network. For 0.0.0.0/0, both 0.0.0.0 and 255.225.255.255 are private, but one is in 0.0.0.0/8 ("This network") and the other in 255.255.255.255/32 ("Limited broadcast").

bedevere-app bot added the awaiting review label Dec 15, 2023

bedevere-app bot mentioned this pull request Dec 15, 2023

ipaddress "is_private" and "is_global" are insufficiently documented and is_global probably has a bug #65056

Closed

encukou added the skip news label Mar 13, 2024

encukou reviewed Mar 13, 2024

View reviewed changes

Doc/library/ipaddress.rst Outdated Show resolved Hide resolved

Doc/library/ipaddress.rst Outdated Show resolved Hide resolved

Doc/library/ipaddress.rst Outdated Show resolved Hide resolved

Lib/ipaddress.py Outdated Show resolved Hide resolved

Lib/ipaddress.py Outdated Show resolved Hide resolved

encukou mentioned this pull request Mar 13, 2024

GH-113171: Fix "private" (non-global) IP address ranges #113179

Merged

jstasiak and others added 5 commits March 14, 2024 00:00

Update Doc/library/ipaddress.rst

497eaf9

Co-authored-by: Petr Viktorin <[email protected]>

Update Doc/library/ipaddress.rst

deb8b19

Co-authored-by: Petr Viktorin <[email protected]>

Update Doc/library/ipaddress.rst

d115f17

Co-authored-by: Petr Viktorin <[email protected]>

Update Lib/ipaddress.py

3c6775f

Co-authored-by: Petr Viktorin <[email protected]>

Update Lib/ipaddress.py

c43f0da

Co-authored-by: Petr Viktorin <[email protected]>

encukou merged commit 2a4cbf1 into python:main Mar 18, 2024
32 checks passed

bedevere-app bot removed the awaiting review label Mar 18, 2024

encukou mentioned this pull request Apr 23, 2024

[3.12] gh-113171: gh-65056: Fix "private" (non-global) IP address ranges (GH-113179) (GH-113186) #118177

Merged

encukou mentioned this pull request Apr 23, 2024

ipaddress considers some not globally reachable addresses global and vice versa #113171

Closed

encukou mentioned this pull request Apr 24, 2024

[3.11] gh-113171: gh-65056: Fix "private" (non-global) IP address ranges (GH-113179) (GH-113186) (GH-118177) #118227

Merged

encukou mentioned this pull request Apr 24, 2024

[3.10] gh-113171: gh-65056: Fix "private" (non-global) IP address ranges (GH-113179) (GH-113186) (GH-118177) #118229

Merged

pablogsal pushed a commit that referenced this pull request Apr 25, 2024

[3.11] gh-113171: gh-65056: Fix "private" (non-global) IP address ran…

ba43157

…ges (GH-113179) (GH-113186) (GH-118177) (#118227)

encukou mentioned this pull request May 1, 2024

[3.9] gh-113171: gh-65056: Fix "private" (non-global) IP address ranges (GH-113179) (GH-113186) (GH-118177) #118472

Merged

encukou mentioned this pull request May 1, 2024

[3.8] gh-113171: gh-65056: Fix "private" (non-global) IP address ranges (GH-113179) (GH-113186) (GH-118177) #118479

Merged

jstasiak deleted the improve-ipaddress-docs branch May 30, 2024 22:43

rickprice mentioned this pull request Jul 3, 2024

CVE-2024-4032 Fix "private" (non-global) IP address ranges (GH-113179… ActiveState/cpython#57

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GH-65056: Improve the IP address' is_global/is_private documentation #113186

GH-65056: Improve the IP address' is_global/is_private documentation #113186

jstasiak commented Dec 15, 2023 •

edited by github-actions bot

Loading

jstasiak commented Dec 15, 2023

encukou left a comment

jstasiak commented Mar 13, 2024

bedevere-app bot commented Apr 23, 2024

jstasiak commented May 30, 2024

GH-65056: Improve the IP address' is_global/is_private documentation #113186

GH-65056: Improve the IP address' is_global/is_private documentation #113186

Conversation

jstasiak commented Dec 15, 2023 • edited by github-actions bot Loading

jstasiak commented Dec 15, 2023

encukou left a comment

Choose a reason for hiding this comment

jstasiak commented Mar 13, 2024

bedevere-app bot commented Apr 23, 2024

jstasiak commented May 30, 2024

jstasiak commented Dec 15, 2023 •

edited by github-actions bot

Loading