3 /fC#@sdZdZddlZdZdZGdddeZGdd d eZd d Zd=d dZ ddZ ddZ ddZ ddZ ddZddZddZddZdd Zd!d"ZGd#d$d$ZejGd%d&d&eZejGd'd(d(eZGd)d*d*ZGd+d,d,eeZGd-d.d.eZGd/d0d0eeZGd1d2d2Zee_Gd3d4d4ZGd5d6d6eeZGd7d8d8eZ Gd9d:d:eeZ!Gd;d<d<Z"e"e_dS)>zA fast, lightweight IPv4/IPv6 manipulation library in Python. This library is used to create/poke/manipulate IPv4 and IPv6 addresses and networks. z1.0N c@seZdZdZdS)AddressValueErrorz%A Value Error related to the address.N)__name__ __module__ __qualname____doc__r r !/usr/lib64/python3.6/ipaddress.pyrsrc@seZdZdZdS)NetmaskValueErrorz%A Value Error related to the netmask.N)rrrrr r r r r sr cCsTyt|Sttfk r YnXyt|Sttfk rBYnXtd|dS)aTake an IP string/int and return an object of the correct type. Args: address: A string or integer, the IP address. Either IPv4 or IPv6 addresses may be supplied; integers less than 2**32 will be considered to be IPv4 by default. Returns: An IPv4Address or IPv6Address object. Raises: ValueError: if the *address* passed isn't either a v4 or a v6 address z0%r does not appear to be an IPv4 or IPv6 addressN) IPv4Addressrr IPv6Address ValueError)addressr r r ip_addresssrTcCsXy t||Sttfk r"YnXy t||Sttfk rFYnXtd|dS)aTake an IP string/int and return an object of the correct type. Args: address: A string or integer, the IP network. Either IPv4 or IPv6 networks may be supplied; integers less than 2**32 will be considered to be IPv4 by default. Returns: An IPv4Network or IPv6Network object. Raises: ValueError: if the string passed isn't either a v4 or a v6 address. Or if the network has host bits set. z0%r does not appear to be an IPv4 or IPv6 networkN) IPv4Networkrr IPv6Networkr)rstrictr r r ip_network9s  rcCsTyt|Sttfk r YnXyt|Sttfk rBYnXtd|dS)agTake an IP string/int and return an object of the correct type. Args: address: A string or integer, the IP address. Either IPv4 or IPv6 addresses may be supplied; integers less than 2**32 will be considered to be IPv4 by default. Returns: An IPv4Interface or IPv6Interface object. Raises: ValueError: if the string passed isn't either a v4 or a v6 address. Notes: The IPv?Interface classes describe an Address on a particular Network, so they're basically a combination of both the Address and Network classes. z2%r does not appear to be an IPv4 or IPv6 interfaceN) IPv4Interfacerr IPv6Interfacer)rr r r ip_interfaceWsrc Cs.y |jddStk r(tdYnXdS)a`Represent an address as 4 packed bytes in network (big-endian) order. Args: address: An integer representation of an IPv4 IP address. Returns: The integer address packed as 4 bytes in network (big-endian) order. Raises: ValueError: If the integer is negative or too large to be an IPv4 IP address. bigz&Address negative or too large for IPv4N)to_bytes OverflowErrorr)rr r r v4_int_to_packedzs rc Cs.y |jddStk r(tdYnXdS)zRepresent an address as 16 packed bytes in network (big-endian) order. Args: address: An integer representation of an IPv6 IP address. Returns: The integer address packed as 16 bytes in network (big-endian) order. rz&Address negative or too large for IPv6N)rrr)rr r r v6_int_to_packeds  rcCs*t|jd}t|dkr&td||S)zAHelper to split the netmask and raise AddressValueError if needed/zOnly one '/' permitted in %r)strsplitlenr)raddrr r r _split_optional_netmasks  r%ccsRt|}t|}}x.|D]&}|j|jdkr<||fV|}|}qW||fVdS)zFind a sequence of sorted deduplicated IPv#Address. Args: addresses: a list of IPv#Address objects. Yields: A tuple containing the first and last IP addresses in the sequence. N)iternext_ip) addressesitfirstlastipr r r _find_address_ranges    r/cCs$|dkr |St|||d@jS)zCount the number of zero bits on the right hand side. Args: number: an integer. bits: maximum number of bits to count. Returns: The number of zero bits on the right hand side of the number. rr&)min bit_length)Znumberbitsr r r _count_righthand_zero_bitss r3ccst|tot|tstd|j|jkr8td||f||krHtd|jdkrXt}n|jdkrht}ntd|j}|j}|j}x^||krt t ||||dj d}||||f}|V|d|>7}|d|j krPqWdS) aSummarize a network range given the first and last IP addresses. Example: >>> list(summarize_address_range(IPv4Address('192.0.2.0'), ... IPv4Address('192.0.2.130'))) ... #doctest: +NORMALIZE_WHITESPACE [IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/31'), IPv4Network('192.0.2.130/32')] Args: first: the first IPv4Address or IPv6Address in the range. last: the last IPv4Address or IPv6Address in the range. Returns: An iterator of the summarized IPv(4|6) network objects. Raise: TypeError: If the first and last objects are not IP addresses. If the first and last objects are not the same version. ValueError: If the last object is not greater than the first. If the version of the first address is not 4 or 6. z1first and last must be IP addresses, not networksz%%s and %s are not of the same versionz*last IP address must be greater than firstrzunknown IP versionr&N) isinstance _BaseAddress TypeErrorversionrrr_max_prefixlenr)r0r3r1 _ALL_ONES)r,r-r.Zip_bitsZ first_intZlast_intZnbitsnetr r r summarize_address_ranges0         r<ccst|}i}xL|rX|j}|j}|j|}|dkr>|||<q||kr||=|j|qWd}x4t|jD]$}|dk r|j|jkrql|V|}qlWdS)auLoops through the addresses, collapsing concurrent netblocks. Example: ip1 = IPv4Network('192.0.2.0/26') ip2 = IPv4Network('192.0.2.64/26') ip3 = IPv4Network('192.0.2.128/26') ip4 = IPv4Network('192.0.2.192/26') _collapse_addresses_internal([ip1, ip2, ip3, ip4]) -> [IPv4Network('192.0.2.0/24')] This shouldn't be called directly; it is called via collapse_addresses([]). Args: addresses: A list of IPv4Network's or IPv6Network's Returns: A list of IPv4Network's or IPv6Network's depending on what we were passed. N)listpopsupernetgetappendsortedvaluesbroadcast_address)r*Zto_mergesubnetsr;r?Zexistingr-r r r _collapse_addresses_internals$   rFc Cs8g}g}g}x|D]}t|trT|rH|dj|jkrHtd||df|j|q|j|jkr|r|dj|jkrtd||dfy|j|jWqtk r|j|j YqXq|r|dj|jkrtd||df|j|qWt t |}|r,x&t |D]\}}|j t||qWt||S) aCollapse a list of IP objects. Example: collapse_addresses([IPv4Network('192.0.2.0/25'), IPv4Network('192.0.2.128/25')]) -> [IPv4Network('192.0.2.0/24')] Args: addresses: An iterator of IPv4Network or IPv6Network objects. Returns: An iterator of the collapsed IPv(4|6)Network objects. Raises: TypeError: If passed a list of mixed version objects. r&z%%s and %s are not of the same versionrGrGrGrGrG)r5r6_versionr7rA _prefixlenr9r.AttributeErrornetwork_addressrBsetr/extendr<rF)r*ZaddrsZipsZnetsr.r,r-r r r collapse_addresses2s4     rNcCs(t|tr|jSt|tr$|jStS)a2Return a key suitable for sorting between networks and addresses. Address and Network objects are not sortable by default; they're fundamentally different so the expression IPv4Address('192.0.2.0') <= IPv4Network('192.0.2.0/24') doesn't make any sense. There are some times however, where you may wish to have ipaddress sort these for you anyway. If you need to do this, you can use this function as the key= argument to sorted(). Args: obj: either a Network or Address object. Returns: appropriate key. )r5 _BaseNetwork_get_networks_keyr6_get_address_keyNotImplemented)objr r r get_mixed_type_keyhs   rTc@seZdZdZfZeddZeddZeddZedd Z d d Z d d Z e ddZ e ddZe ddZe ddZe ddZddZdS)_IPAddressBasezThe mother class.cCs|jS)z:Return the longhand version of the IP address as a string.)_explode_shorthand_ip_string)selfr r r explodedsz_IPAddressBase.explodedcCst|S)z;Return the shorthand version of the IP address as a string.)r!)rWr r r compressedsz_IPAddressBase.compressedcCs|jS)aIThe name of the reverse DNS pointer for the IP address, e.g.: >>> ipaddress.ip_address("127.0.0.1").reverse_pointer '1.0.0.127.in-addr.arpa' >>> ipaddress.ip_address("2001:db8::1").reverse_pointer '1.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa' )_reverse_pointer)rWr r r reverse_pointers z_IPAddressBase.reverse_pointercCsdt|f}t|dS)Nz%200s has no version specified)typeNotImplementedError)rWmsgr r r r8sz_IPAddressBase.versioncCsF|dkrd}t|||jf||jkrBd}t|||j|jfdS)Nrz-%d (< 0) is not permitted as an IPv%d addressz2%d (>= 2**%d) is not permitted as an IPv%d address)rrHr:r9)rWrr^r r r _check_int_addresss  z!_IPAddressBase._check_int_addresscCs.t|}||kr*d}t|||||jfdS)Nz6%r (len %d != %d) is not permitted as an IPv%d address)r#rrH)rWrZ expected_lenZ address_lenr^r r r _check_packed_addresss z$_IPAddressBase._check_packed_addresscCs|j|j|?AS)zTurn the prefix length into a bitwise netmask Args: prefixlen: An integer, the prefix length. Returns: An integer. )r:)cls prefixlenr r r _ip_int_from_prefixs z"_IPAddressBase._ip_int_from_prefixc Cs\t||j}|j|}||?}d|>d}||krX|jd}|j|d}d}t|||S)aReturn prefix length from the bitwise netmask. Args: ip_int: An integer, the netmask in expanded bitwise format Returns: An integer, the prefix length. Raises: ValueError: If the input intermingles zeroes & ones r&rz&Netmask pattern %r mixes zeroes & ones)r3r9rr) raip_intZtrailing_zeroesrbZ leading_onesZall_onesZbyteslenZdetailsr^r r r _prefix_from_ip_ints      z"_IPAddressBase._prefix_from_ip_intcCsd|}t|ddS)Nz%r is not a valid netmask)r )raZ netmask_strr^r r r _report_invalid_netmasksz&_IPAddressBase._report_invalid_netmaskc Csjtjj|s|j|y t|}Wntk r@|j|YnXd|koV|jknsf|j||S)a Return prefix length from a numeric string Args: prefixlen_str: The string to be converted Returns: An integer, the prefix length. Raises: NetmaskValueError: If the input is not a valid netmask r)_BaseV4_DECIMAL_DIGITS issupersetrgintrr9)raZ prefixlen_strrbr r r _prefix_from_prefix_strings    z)_IPAddressBase._prefix_from_prefix_stringcCsy|j|}Wntk r,|j|YnXy |j|Stk rLYnX||jN}y |j|Stk r|j|YnXdS)aTurn a netmask/hostmask string into a prefix length Args: ip_str: The netmask/hostmask to be converted Returns: An integer, the prefix length. Raises: NetmaskValueError: If the input is not a valid netmask/hostmask N)_ip_int_from_stringrrgrfrr:)raip_strrer r r _prefix_from_ip_strings   z%_IPAddressBase._prefix_from_ip_stringcCs|jt|ffS)N) __class__r!)rWr r r __reduce__sz_IPAddressBase.__reduce__N)rrrr __slots__propertyrXrYr[r8r_r` classmethodrcrfrgrlrorqr r r r rUs        "rUc@sdeZdZdZfZddZddZddZdd Zd d Z d d Z ddZ ddZ ddZ ddZdS)r6zA generic IP object. This IP class contains the version independent methods which are used by single IP addresses. cCs|jS)N)r))rWr r r __int__&sz_BaseAddress.__int__c Cs2y|j|jko|j|jkStk r,tSXdS)N)r)rHrJrR)rWotherr r r __eq__)s   z_BaseAddress.__eq__cCsFt|tstS|j|jkr*td||f|j|jkrB|j|jkSdS)Nz%%s and %s are not of the same versionF)r5r6rRrHr7r))rWrvr r r __lt__0s     z_BaseAddress.__lt__cCs t|tstS|jt||S)N)r5rkrRrp)rWrvr r r __add__<s z_BaseAddress.__add__cCs t|tstS|jt||S)N)r5rkrRrp)rWrvr r r __sub__As z_BaseAddress.__sub__cCsd|jjt|fS)Nz%s(%r))rprr!)rWr r r __repr__Fsz_BaseAddress.__repr__cCst|j|jS)N)r!_string_from_ip_intr))rWr r r __str__Isz_BaseAddress.__str__cCsttt|jS)N)hashhexrkr))rWr r r __hash__Lsz_BaseAddress.__hash__cCs |j|fS)N)rH)rWr r r rQOsz_BaseAddress._get_address_keycCs|j|jffS)N)rpr))rWr r r rqRsz_BaseAddress.__reduce__N)rrrrrrrurwrxryrzr{r}rrQrqr r r r r6s r6c@sHeZdZdZddZddZddZdd Zd d Zd d Z ddZ ddZ ddZ ddZ ddZeddZeddZeddZeddZed d!Zed"d#Zed$d%Zed&d'Zd(d)Zd*d+Zd,d-ZdBd0d1ZdCd2d3Zed4d5Zed6d7Zed8d9Zed:d;Z edd?Z"ed@dAZ#d/S)DrOz~A generic IP network object. This IP class contains the version independent methods which are used by networks. cCs i|_dS)N)_cache)rWrr r r __init___sz_BaseNetwork.__init__cCsd|jjt|fS)Nz%s(%r))rprr!)rWr r r r{bsz_BaseNetwork.__repr__cCsd|j|jfS)Nz%s/%d)rKrb)rWr r r r}esz_BaseNetwork.__str__ccs<t|j}t|j}x"t|d|D]}|j|Vq$WdS)zGenerate Iterator over usable hosts in a network. This is like __iter__ except it doesn't return the network or broadcast addresses. r&N)rkrKrDrange_address_class)rWnetwork broadcastxr r r hostshs  z_BaseNetwork.hostsccs<t|j}t|j}x"t||dD]}|j|Vq$WdS)Nr&)rkrKrDrr)rWrrrr r r __iter__ts  z_BaseNetwork.__iter__cCslt|j}t|j}|dkr>|||kr0td|j||S|d7}|||krZtd|j||SdS)Nrzaddress out of ranger&)rkrKrD IndexErrorr)rWnrrr r r __getitem__zs    z_BaseNetwork.__getitem__cCs^t|tstS|j|jkr*td||f|j|jkrB|j|jkS|j|jkrZ|j|jkSdS)Nz%%s and %s are not of the same versionF)r5rOrRrHr7rKnetmask)rWrvr r r rxs       z_BaseNetwork.__lt__c CsFy,|j|jko,|j|jko,t|jt|jkStk r@tSXdS)N)rHrKrkrrJrR)rWrvr r r rws   z_BaseNetwork.__eq__cCstt|jt|jAS)N)r~rkrKr)rWr r r rsz_BaseNetwork.__hash__cCsL|j|jkrdSt|trdSt|jt|jkoBt|jkSSdS)NF)rHr5rOrkrKr)rD)rWrvr r r __contains__s   z_BaseNetwork.__contains__cCs(|j|kp&|j|kp&|j|kp&|j|kS)z*Tell if self is partly contained in other.)rKrD)rWrvr r r overlapss   z_BaseNetwork.overlapscCs<|jjd}|dkr8|jt|jt|jB}||jd<|S)NrD)rr@rrkrKhostmask)rWrr r r rDs    z_BaseNetwork.broadcast_addresscCs8|jjd}|dkr4|jt|j|jA}||jd<|S)Nr)rr@rrkrr:)rWrr r r rs   z_BaseNetwork.hostmaskcCsd|j|jfS)Nz%s/%d)rKrI)rWr r r with_prefixlensz_BaseNetwork.with_prefixlencCsd|j|jfS)Nz%s/%s)rKr)rWr r r with_netmasksz_BaseNetwork.with_netmaskcCsd|j|jfS)Nz%s/%s)rKr)rWr r r with_hostmasksz_BaseNetwork.with_hostmaskcCst|jt|jdS)z&Number of hosts in the current subnet.r&)rkrDrK)rWr r r num_addressessz_BaseNetwork.num_addressescCsdt|f}t|dS)Nz%%200s has no associated address class)r\r])rWr^r r r rsz_BaseNetwork._address_classcCs|jS)N)rI)rWr r r rbsz_BaseNetwork.prefixlenccsD|j|jkstd||ft|ts2td||j|jkoH|j|jksZtd||f||krfdS|jd|j|jf}|j \}}x||ko||kr|j|jkr|j|jkr|V|j \}}q|j|jkr|j|jkr|V|j \}}qt d|||fqW||kr|Vn$||kr.|Vnt d|||fdS)aRemove an address from a larger block. For example: addr1 = ip_network('192.0.2.0/28') addr2 = ip_network('192.0.2.1/32') list(addr1.address_exclude(addr2)) = [IPv4Network('192.0.2.0/32'), IPv4Network('192.0.2.2/31'), IPv4Network('192.0.2.4/30'), IPv4Network('192.0.2.8/29')] or IPv6: addr1 = ip_network('2001:db8::1/32') addr2 = ip_network('2001:db8::1/128') list(addr1.address_exclude(addr2)) = [ip_network('2001:db8::1/128'), ip_network('2001:db8::2/127'), ip_network('2001:db8::4/126'), ip_network('2001:db8::8/125'), ... ip_network('2001:db8:8000::/33')] Args: other: An IPv4Network or IPv6Network object of the same type. Returns: An iterator of the IPv(4|6)Network objects which is self minus other. Raises: TypeError: If self and other are of differing address versions, or if other is not a network object. ValueError: If other is not completely contained by self. z%%s and %s are not of the same versionz%s is not a network objectz%s not contained in %sNz%s/%sz3Error performing exclusion: s1: %s s2: %s other: %s) rHr7r5rOrKrDrrprbrEAssertionError)rWrvs1s2r r r address_excludes<$               z_BaseNetwork.address_excludecCs`|j|jkrtd||f|j|jkr,dS|j|jkr other eg: IPv4Network('192.0.2.128/25') > IPv4Network('192.0.2.0/25') IPv6Network('2001:db8::2000/124') > IPv6Network('2001:db8::1000/124') Raises: TypeError if the IP versions are different. z"%s and %s are not of the same typer&rrGrG)rHr7rKr)rWrvr r r compare_networks.s!      z_BaseNetwork.compare_networkscCs|j|j|jfS)zNetwork-only key function. Returns an object that identifies this address' network and netmask. This function is a suitable "key" argument for sorted() and list.sort(). )rHrKr)rWr r r rP^sz_BaseNetwork._get_networks_keyr&Nc cs|j|jkr|VdS|dk rJ||jkr0td|dkr@td||j}|dkrZtd|j|}||jkr~td||ft|j}t|jd}t|jd|?}x(t|||D]}|j||f}|VqWdS)aThe subnets which join to make the current subnet. In the case that self contains only one IP (self._prefixlen == 32 for IPv4 or self._prefixlen == 128 for IPv6), yield an iterator with just ourself. Args: prefixlen_diff: An integer, the amount the prefix length should be increased by. This should not be set if new_prefix is also set. new_prefix: The desired new prefix length. This must be a larger number (smaller prefix) than the existing prefix. This should not be set if prefixlen_diff is also set. Returns: An iterator of IPv(4|6) objects. Raises: ValueError: The prefixlen_diff is too small or too large. OR prefixlen_diff and new_prefix are both set or new_prefix is a smaller number than the current prefix (smaller number means a larger network) Nznew prefix must be longerr&z(cannot set prefixlen_diff and new_prefixrzprefix length diff must be > 0z0prefix length diff %d is invalid for netblock %s) rIr9rrkrKrDrrrp) rWprefixlen_diff new_prefix new_prefixlenstartendstepZnew_addrZcurrentr r r rEhs,       z_BaseNetwork.subnetscCs|jdkr|S|dk rB||jkr(td|dkr8td|j|}|j|}|dkrftd|j|f|jt|jt|j|>@|fS)aThe supernet containing the current network. Args: prefixlen_diff: An integer, the amount the prefix length of the network should be decreased by. For example, given a /24 network and a prefixlen_diff of 3, a supernet with a /21 netmask is returned. Returns: An IPv4 network object. Raises: ValueError: If self.prefixlen - prefixlen_diff < 0. I.e., you have a negative prefix length. OR If prefixlen_diff and new_prefix are both set or new_prefix is a larger number than the current prefix (larger number means a smaller network) rNznew prefix must be shorterr&z(cannot set prefixlen_diff and new_prefixz;current prefixlen is %d, cannot have a prefixlen_diff of %d)rIrrbrprkrKr)rWrrrr r r r?s     z_BaseNetwork.supernetcCs|jjo|jjS)zTest if the address is reserved for multicast use. Returns: A boolean, True if the address is a multicast address. See RFC 2373 2.7 for details. )rK is_multicastrD)rWr r r rs z_BaseNetwork.is_multicastcCs|jjo|jjS)zTest if the address is otherwise IETF reserved. Returns: A boolean, True if the address is within one of the reserved IPv6 Network ranges. )rK is_reservedrD)rWr r r rs z_BaseNetwork.is_reservedcCs|jjo|jjS)zTest if the address is reserved for link-local. Returns: A boolean, True if the address is reserved per RFC 4291. )rK is_link_localrD)rWr r r rsz_BaseNetwork.is_link_localcCs|jjo|jjS)zTest if this address is allocated for private networks. Returns: A boolean, True if the address is reserved per iana-ipv4-special-registry or iana-ipv6-special-registry. )rK is_privaterD)rWr r r rs z_BaseNetwork.is_privatecCs|j S)zTest if this address is allocated for public networks. Returns: A boolean, True if the address is not reserved per iana-ipv4-special-registry or iana-ipv6-special-registry. )r)rWr r r is_globals z_BaseNetwork.is_globalcCs|jjo|jjS)zTest if the address is unspecified. Returns: A boolean, True if this is the unspecified address as defined in RFC 2373 2.5.2. )rKis_unspecifiedrD)rWr r r rs z_BaseNetwork.is_unspecifiedcCs|jjo|jjS)zTest if the address is a loopback address. Returns: A boolean, True if the address is a loopback address as defined in RFC 2373 2.5.3. )rK is_loopbackrD)rWr r r r s z_BaseNetwork.is_loopback)r&N)r&N)$rrrrrr{r}rrrrxrwrrrrsrDrrrrrrrbrrrPrEr?rrrrrrrr r r r rOVs@           N0 5 ) rOc @seZdZdZfZdZdedZedZ edddd d d d d dh Z eZ iZ ddZ eddZeddZeddZeddZddZddZddZedd Zed!d"Zd#S)$rhzyBase IPv4 object. The following methods are used by IPv4 objects in both single IP addresses and networks. rr r& 0123456789rrcCst|S)N)r!)rWr r r rV0sz$_BaseV4._explode_shorthand_ip_stringc Csn||jkrdt|tr|}n.y|j|}Wntk rF|j|}YnXt|j|}||f|j|<|j|S)aMake a (netmask, prefix_len) tuple from the given argument. Argument can be: - an integer (the prefix length) - a string representing the prefix length (e.g. "24") - a string representing the prefix netmask (e.g. "255.255.255.0") )_netmask_cacher5rkrlr ror rc)raargrbrr r r _make_netmask3s  z_BaseV4._make_netmaskcCs||s td|jd}t|dkr.td|ytjt|j|dStk rv}ztd||fdWYdd}~XnXdS)aTurn the given IP string into an integer for comparison. Args: ip_str: A string, the IP ip_str. Returns: The IP ip_str as an integer. Raises: AddressValueError: if ip_str isn't a valid IPv4 Address. zAddress cannot be empty.rzExpected 4 octets in %rrz%s in %rN)rr"r#rk from_bytesmap _parse_octetr)rarnZoctetsexcr r r rmKs   z_BaseV4._ip_int_from_stringcCs|s td|jj|s(d}t||t|dkrDd}t||t|d}|dkrr|ddkrrd }t|||d krtd ||S) a Convert a decimal octet into an integer. Args: octet_str: A string, the number to parse. Returns: The octet as an integer. Raises: ValueError: if the octet isn't strictly a decimal from [0..255]. zEmpty octet not permittedz#Only decimal digits permitted in %rz$At most 3 characters permitted in %r r0z3Ambiguous (octal/decimal) value in %r not permittedrzOctet %d (> 255) not permitted)rrirjr#rk)raZ octet_strr^Z octet_intr r r res       z_BaseV4._parse_octetcCsdjtt|jddS)zTurns a 32-bit integer into dotted decimal notation. Args: ip_int: An integer, the IP address. Returns: The IP address as a string in dotted decimal notation. rrr)joinrr!r)rarer r r r|s z_BaseV4._string_from_ip_intcCs|jd}t|dkry$x|D]}t||jkrdSqWWntk rNdSXx0t|D]$\}}|dkrZ|||dkrZdSqZWdSy t|}Wntk rdSXd|ko|jkSS)zVerify that the netmask is valid. Args: netmask: A string, either a prefix or dotted decimal netmask. Returns: A boolean, True if the prefix represents a valid IPv4 netmask. rrFrr&T)r"r#rk_valid_mask_octetsr enumerater9)rWrmaskridxyr r r _is_valid_netmasks"     z_BaseV4._is_valid_netmaskc sh|jd}yfddtt|D}Wntk r:dSXt|t|krPdS|d|dkrddSdS) zTest if the IP string is a hostmask (rather than a netmask). Args: ip_str: A string, the potential hostmask. Returns: A boolean, True if the IP string is a hostmask. rcsg|]}|jkr|qSr )r).0r)rWr r sz(_BaseV4._is_hostmask..Frr&TrG)r"rrkrr#)rWrnr2partsr )rWr _is_hostmasks z_BaseV4._is_hostmaskcCs&t|jdddd}dj|dS)zReturn the reverse DNS pointer name for the IPv4 address. This implements the method described in RFC1035 3.5. rNr&z .in-addr.arparG)r!r"r)rWZreverse_octetsr r r rZsz_BaseV4._reverse_pointercCs|jS)N)r9)rWr r r max_prefixlensz_BaseV4.max_prefixlencCs|jS)N)rH)rWr r r r8sz_BaseV4.versionN)rrrrrrrH IPV4LENGTHr: frozensetrirr9rrVrtrrmrr|rrrZrsrr8r r r r rhs$    %  rhc@seZdZdZdZddZeddZedd Zee j d d Z ee j d d Z eddZ eddZeddZeddZdS)r z/Represent and manipulate single IPv4 Addresses.r) __weakref__cCsrt|tr|j|||_dSt|trF|j|dtj|d|_dSt|}d|krbtd||j ||_dS)a Args: address: A string or integer representing the IP Additionally, an integer can be passed, so IPv4Address('192.0.2.1') == IPv4Address(3221225985). or, more generally IPv4Address(int(IPv4Address('192.0.2.1'))) == IPv4Address('192.0.2.1') Raises: AddressValueError: If ipaddress isn't a valid IPv4 address. NrrrzUnexpected '/' in %r) r5rkr_r)bytesr`rr!rrm)rWraddr_strr r r rs     zIPv4Address.__init__cCs t|jS)z*The binary representation of this address.)rr))rWr r r packedszIPv4Address.packedcCs ||jjkS)zTest if the address is otherwise IETF reserved. Returns: A boolean, True if the address is within the reserved IPv4 Network range. ) _constants_reserved_network)rWr r r r s zIPv4Address.is_reservedcstfddjjDS)zTest if this address is allocated for private networks. Returns: A boolean, True if the address is reserved per iana-ipv4-special-registry. c3s|]}|kVqdS)Nr )rr;)rWr r sz)IPv4Address.is_private..)anyr_private_networks)rWr )rWr rs zIPv4Address.is_privatecCs||jjko|j S)N)r_public_networkr)rWr r r r"szIPv4Address.is_globalcCs ||jjkS)zTest if the address is reserved for multicast use. Returns: A boolean, True if the address is multicast. See RFC 3171 for details. )r_multicast_network)rWr r r r's zIPv4Address.is_multicastcCs ||jjkS)zTest if the address is unspecified. Returns: A boolean, True if this is the unspecified address as defined in RFC 5735 3. )r_unspecified_address)rWr r r r2s zIPv4Address.is_unspecifiedcCs ||jjkS)zTest if the address is a loopback address. Returns: A boolean, True if the address is a loopback per RFC 3330. )r_loopback_network)rWr r r r=szIPv4Address.is_loopbackcCs ||jjkS)zTest if the address is reserved for link-local. Returns: A boolean, True if the address is link-local per RFC 3927. )r_linklocal_network)rWr r r rGszIPv4Address.is_link_localN)r)r)rrrrrrrrsrr functools lru_cacherrrrrrr r r r r s#    r c@sjeZdZddZddZddZddZd d Zej Z e d d Z e d dZ e ddZ e ddZdS)rcCst|ttfr2tj||t|j|_|j|_ dSt|t rtj||dt |dkrht|d|_ n|j|_ t|dd|_|jj |_ |jj |_ dSt|}tj||dt|dd|_|jj |_ |jj |_ |jj |_ dS)Nrr&F)r)r5rrkr rrr)rr9rItupler#rrr%)rWrr$r r r rTs(        zIPv4Interface.__init__cCsd|j|j|jjfS)Nz%s/%d)r|r)rrb)rWr r r r}ps zIPv4Interface.__str__c CsDtj||}| s|tkr|Sy |j|jkStk r>dSXdS)NF)r rwrRrrJ)rWrv address_equalr r r rwts  zIPv4Interface.__eq__c CsNtj||}|tkrtSy|j|jkp4|j|jko4|Stk rHdSXdS)NF)r rxrRrrJ)rWrv address_lessr r r rxs  zIPv4Interface.__lt__cCst|j|jt|jjfS)N)r~r)rIrkrrK)rWr r r rszIPv4Interface.__hash__cCs t|jS)N)r r))rWr r r r.szIPv4Interface.ipcCsd|j|j|jfS)Nz%s/%s)r|r)rI)rWr r r rs zIPv4Interface.with_prefixlencCsd|j|j|jfS)Nz%s/%s)r|r)r)rWr r r rs zIPv4Interface.with_netmaskcCsd|j|j|jfS)Nz%s/%s)r|r)r)rWr r r rs zIPv4Interface.with_hostmaskN)rrrrr}rwrxrrUrqrsr.rrrr r r r rRs     rc@s2eZdZdZeZdddZeej ddZ dS) raeThis class represents and manipulates 32-bit IPv4 network + addresses.. Attributes: [examples for IPv4Network('192.0.2.0/27')] .network_address: IPv4Address('192.0.2.0') .hostmask: IPv4Address('0.0.0.31') .broadcast_address: IPv4Address('192.0.2.32') .netmask: IPv4Address('255.255.255.224') .prefixlen: 27 TcCstj||t|ttfr&|}|j}n^t|trT|d}t|dkrL|dn|j}n0t|}|j |d}t|dkr~|dn|j}t ||_ |j |\|_ |_t|j }|t|j @|kr|rtd|nt |t|j @|_ |j|jdkr|j|_dS)aInstantiate a new IPv4 network object. Args: address: A string or integer representing the IP [& network]. '192.0.2.0/24' '192.0.2.0/255.255.255.0' '192.0.0.2/0.0.0.255' are all functionally the same in IPv4. Similarly, '192.0.2.1' '192.0.2.1/255.255.255.255' '192.0.2.1/32' are also functionally equivalent. That is to say, failing to provide a subnetmask will create an object with a mask of /32. If the mask (portion after the / in the argument) is given in dotted quad form, it is treated as a netmask if it starts with a non-zero field (e.g. /255.0.0.0 == /8) and as a hostmask if it starts with a zero field (e.g. 0.255.255.255 == /8), with the single exception of an all-zero mask which is treated as a netmask == /0. If no mask is given, a default of /32 is used. Additionally, an integer can be passed, so IPv4Network('192.0.2.1') == IPv4Network(3221225985) or, more generally IPv4Interface(int(IPv4Interface('192.0.2.1'))) == IPv4Interface('192.0.2.1') Raises: AddressValueError: If ipaddress isn't a valid IPv4 address. NetmaskValueError: If the netmask isn't valid for an IPv4 address. ValueError: If strict is True and a network address is not supplied. rr&r z%s has host bits setN)rOrr5rkrr9rr#r%rmr rKrrrIrrr)rWrrr$rargsrr r r rs(%    zIPv4Network.__init__cCs&|jtdko|jtdk o$|j S)zTest if this address is allocated for public networks. Returns: A boolean, True if the address is not reserved per iana-ipv4-special-registry. z 100.64.0.0/10)rKrrDr)rWr r r rs zIPv4Network.is_globalN)T) rrrrr rrrsrrrr r r r rs   Crc@seZdZedZedZedZedZededededededed ed ed ed ed edededgZedZ e dZ dS)_IPv4Constantsz169.254.0.0/16z 127.0.0.0/8z 224.0.0.0/4z 100.64.0.0/10z 0.0.0.0/8z 10.0.0.0/8z 172.16.0.0/12z 192.0.0.0/29z192.0.0.170/31z 192.0.2.0/24z192.168.0.0/16z 198.18.0.0/15z198.51.100.0/24z203.0.113.0/24z 240.0.0.0/4z255.255.255.255/32z0.0.0.0N) rrrrrrrrrrr rr r r r rs( rc@seZdZdZfZdZdedZdZe dZ eZ iZ e ddZe d d Ze d d Ze d dZe dddZddZddZeddZeddZdS)_BaseV6zyBase IPv6 object. The following methods are used by IPv6 objects in both single IP addresses and networks. r4r r&rdZ0123456789ABCDEFabcdefcCsJ||jkr@t|tr|}n |j|}t|j|}||f|j|<|j|S)aMake a (netmask, prefix_len) tuple from the given argument. Argument can be: - an integer (the prefix length) - a string representing the prefix length (e.g. "24") - a string representing the prefix netmask (e.g. "255.255.255.0") )rr5rkrlr rc)rarrbrr r r r<s   z_BaseV6._make_netmaskcCs|s td|jd}d}t||kr:d||f}t|d|dkryt|jj}Wn4tk r}ztd||fdWYdd}~XnX|jd |d ?d @|jd |d @|jd}t||krd |d|f}t|d}xDtdt|dD].} || s|dk r$d |}t|| }qW|dk r|} t||d} |dst| d8} | rtd}t|||ds| d8} | rd}t|||j| | } | dkr:d}t||jd|fnjt||jkrd}t||j|f|dsd}t|||ds*d}t||t|} d} d} ytd} x,t| D] } | d K} | |j || O} qJW| d | K} x0t| dD] } | d K} | |j || O} qW| St k r}ztd||fdWYdd}~XnXdS)zTurn an IPv6 ip_str into an integer. Args: ip_str: A string, the IPv6 ip_str. Returns: An int, the IPv6 address Raises: AddressValueError: if ip_str isn't a valid IPv6 Address. zAddress cannot be empty:rz At least %d parts expected in %rrr&z%s in %rNz%xriz!At most %d colons permitted in %rz At most one '::' permitted in %rrz0Leading ':' only permitted as part of '::' in %rz1Trailing ':' only permitted as part of '::' in %rz/Expected at most %d other parts with '::' in %rz,Exactly %d parts expected without '::' in %rrGrGrG) rr"r#r r>r)rA _HEXTET_COUNTr _parse_hextetr)rarnrZ _min_partsr^Zipv4_intrZ _max_partsZ skip_indexiZparts_hiZparts_loZ parts_skippedrer r r rmNs    $                z_BaseV6._ip_int_from_stringcCs>|jj|std|t|dkr4d}t||t|dS)a&Convert an IPv6 hextet string into an integer. Args: hextet_str: A string, the number to parse. Returns: The hextet as an integer. Raises: ValueError: if the input isn't strictly a hex number from [0..FFFF]. zOnly hex digits permitted in %rrz$At most 4 characters permitted in %rr) _HEX_DIGITSrjrr#rk)raZ hextet_strr^r r r rs     z_BaseV6._parse_hextetc Csd}d}d}d}xJt|D]>\}}|dkrP|d7}|dkr>|}||krX|}|}qd}d}qW|dkr||}|t|kr|dg7}dg|||<|dkrdg|}|S) aCompresses a list of hextets. Compresses a list of strings, replacing the longest continuous sequence of "0" in the list with "" and adding empty strings at the beginning or at the end of the string such that subsequently calling ":".join(hextets) will produce the compressed version of the IPv6 address. Args: hextets: A list of strings, the hextets to compress. Returns: A list of strings. r&rrrGrGrGrG)rr#) rahextetsZbest_doublecolon_startZbest_doublecolon_lenZdoublecolon_startZdoublecolon_lenindexZhextetZbest_doublecolon_endr r r _compress_hextetss.   z_BaseV6._compress_hextetsNcsZ|dkrt|j}||jkr$tdd|fddtdddD}|j|}d j|S) a,Turns a 128-bit integer into hexadecimal notation. Args: ip_int: An integer, the IP address. Returns: A string, the hexadecimal representation of the address. Raises: ValueError: The address is bigger than 128 bits of all ones. NzIPv6 address is too largez%032xcs&g|]}dt||ddqS)z%xrr)rk)rr)hex_strr r rsz/_BaseV6._string_from_ip_int..rrrr)rkr)r:rrrr)rarerr )rr r|s   z_BaseV6._string_from_ip_intcst|trt|j}nt|tr,t|j}nt|}|j|}d|fddtdddD}t|ttfrddj ||j fSdj |S) zExpand a shortened IPv6 address. Args: ip_str: A string, the IPv6 address. Returns: A string, the expanded IPv6 address. z%032xcsg|]}||dqS)rr )rr)rr r r-sz8_BaseV6._explode_shorthand_ip_string..rrrz%s/%dr) r5rr!rKrr.rmrrOrrI)rWrnrerr )rr rVs     z$_BaseV6._explode_shorthand_ip_stringcCs&|jdddjdd}dj|dS)zReturn the reverse DNS pointer name for the IPv6 address. This implements the method described in RFC3596 2.5. Nr&rrrz .ip6.arparG)rXreplacer)rWZ reverse_charsr r r rZ2sz_BaseV6._reverse_pointercCs|jS)N)r9)rWr r r r;sz_BaseV6.max_prefixlencCs|jS)N)rH)rWr r r r8?sz_BaseV6.version)N)rrrrrrrH IPV6LENGTHr:rrrr9rrtrrmrrr|rVrZrsrr8r r r r r(s$   h  0  rc@seZdZdZdZddZeddZedd Zed d Z ed d Z eddZ ee j ddZeddZeddZeddZeddZeddZeddZdS) r z/Represent and manipulate single IPv6 Addresses.r)rcCsrt|tr|j|||_dSt|trF|j|dtj|d|_dSt|}d|krbtd||j ||_dS)aInstantiate a new IPv6 address object. Args: address: A string or integer representing the IP Additionally, an integer can be passed, so IPv6Address('2001:db8::') == IPv6Address(42540766411282592856903984951653826560) or, more generally IPv6Address(int(IPv6Address('2001:db8::'))) == IPv6Address('2001:db8::') Raises: AddressValueError: If address isn't a valid IPv6 address. NrrrzUnexpected '/' in %r) r5rkr_r)rr`rr!rrm)rWrrr r r rJs     zIPv6Address.__init__cCs t|jS)z*The binary representation of this address.)rr))rWr r r rnszIPv6Address.packedcCs ||jjkS)zTest if the address is reserved for multicast use. Returns: A boolean, True if the address is a multicast address. See RFC 2373 2.7 for details. )rr)rWr r r rss zIPv6Address.is_multicastcstfddjjDS)zTest if the address is otherwise IETF reserved. Returns: A boolean, True if the address is within one of the reserved IPv6 Network ranges. c3s|]}|kVqdS)Nr )rr)rWr r rsz*IPv6Address.is_reserved..)rr_reserved_networks)rWr )rWr r~s zIPv6Address.is_reservedcCs ||jjkS)zTest if the address is reserved for link-local. Returns: A boolean, True if the address is reserved per RFC 4291. )rr)rWr r r rszIPv6Address.is_link_localcCs ||jjkS)a`Test if the address is reserved for site-local. Note that the site-local address space has been deprecated by RFC 3879. Use is_private to test if this address is in the space of unique local addresses as defined by RFC 4193. Returns: A boolean, True if the address is reserved per RFC 3513 2.5.6. )r_sitelocal_network)rWr r r is_site_locals zIPv6Address.is_site_localcstfddjjDS)zTest if this address is allocated for private networks. Returns: A boolean, True if the address is reserved per iana-ipv6-special-registry. c3s|]}|kVqdS)Nr )rr;)rWr r rsz)IPv6Address.is_private..)rrr)rWr )rWr rs zIPv6Address.is_privatecCs|j S)zTest if this address is allocated for public networks. Returns: A boolean, true if the address is not reserved per iana-ipv6-special-registry. )r)rWr r r rs zIPv6Address.is_globalcCs |jdkS)zTest if the address is unspecified. Returns: A boolean, True if this is the unspecified address as defined in RFC 2373 2.5.2. r)r))rWr r r rs zIPv6Address.is_unspecifiedcCs |jdkS)zTest if the address is a loopback address. Returns: A boolean, True if the address is a loopback address as defined in RFC 2373 2.5.3. r&)r))rWr r r rs zIPv6Address.is_loopbackcCs |jd?dkrdSt|jd@S)zReturn the IPv4 mapped address. Returns: If the IPv6 address is a v4 mapped address, return the IPv4 mapped address. Return None otherwise. riNl)r)r )rWr r r ipv4_mappeds zIPv6Address.ipv4_mappedcCs4|jd?dkrdSt|jd?d@t|jd@fS)zTuple of embedded teredo IPs. Returns: Tuple of the (server, client) IPs or None if the address doesn't appear to be a teredo address (doesn't start with 2001::/32) `i N@l)r)r )rWr r r teredos zIPv6Address.teredocCs$|jd?dkrdSt|jd?d@S)zReturn the IPv4 6to4 embedded address. Returns: The IPv4 6to4-embedded address if present or None if the address doesn't appear to contain a 6to4 embedded address. pi NPl)r)r )rWr r r sixtofours zIPv6Address.sixtofourN)r)r)rrrrrrrrsrrrrrrrrrrrrrrr r r r r Ds $   r c@seZdZddZddZddZddZd d Zej Z e d d Z e d dZ e ddZ e ddZe ddZe ddZdS)rcCst|ttfr2tj||t|j|_|j|_ dSt|t rtj||dt |dkrht|d|_ n|j|_ t|dd|_|jj |_ |jj |_ dSt|}tj||dt|dd|_|jj |_ |jj |_ |jj |_ dS)Nrr&F)r)r5rrkr rrr)rr9rIrr#rrr%)rWrr$r r r rs(        zIPv6Interface.__init__cCsd|j|j|jjfS)Nz%s/%d)r|r)rrb)rWr r r r}s zIPv6Interface.__str__c CsDtj||}| s|tkr|Sy |j|jkStk r>dSXdS)NF)r rwrRrrJ)rWrvrr r r rws  zIPv6Interface.__eq__c CsNtj||}|tkrtSy|j|jkp4|j|jko4|Stk rHdSXdS)NF)r rxrRrrJ)rWrvrr r r rx"s  zIPv6Interface.__lt__cCst|j|jt|jjfS)N)r~r)rIrkrrK)rWr r r r.szIPv6Interface.__hash__cCs t|jS)N)r r))rWr r r r.3szIPv6Interface.ipcCsd|j|j|jfS)Nz%s/%s)r|r)rI)rWr r r r7s zIPv6Interface.with_prefixlencCsd|j|j|jfS)Nz%s/%s)r|r)r)rWr r r r<s zIPv6Interface.with_netmaskcCsd|j|j|jfS)Nz%s/%s)r|r)r)rWr r r rAs zIPv6Interface.with_hostmaskcCs|jdko|jjS)Nr)r)rr)rWr r r rFszIPv6Interface.is_unspecifiedcCs|jdko|jjS)Nr&)r)rr)rWr r r rJszIPv6Interface.is_loopbackN)rrrrr}rwrxrrUrqrsr.rrrrrr r r r rs       rc@s2eZdZdZeZd ddZddZeddZ d S) ravThis class represents and manipulates 128-bit IPv6 networks. Attributes: [examples for IPv6('2001:db8::1000/124')] .network_address: IPv6Address('2001:db8::1000') .hostmask: IPv6Address('::f') .broadcast_address: IPv6Address('2001:db8::100f') .netmask: IPv6Address('ffff:ffff:ffff:ffff:ffff:ffff:ffff:fff0') .prefixlen: 124 TcCstj||t|ttfr&|}|j}n^t|trT|d}t|dkrL|dn|j}n0t|}|j |d}t|dkr~|dn|j}t ||_ |j |\|_ |_t|j }|t|j @|kr|rtd|nt |t|j @|_ |j|jdkr|j|_dS)aInstantiate a new IPv6 Network object. Args: address: A string or integer representing the IPv6 network or the IP and prefix/netmask. '2001:db8::/128' '2001:db8:0000:0000:0000:0000:0000:0000/128' '2001:db8::' are all functionally the same in IPv6. That is to say, failing to provide a subnetmask will create an object with a mask of /128. Additionally, an integer can be passed, so IPv6Network('2001:db8::') == IPv6Network(42540766411282592856903984951653826560) or, more generally IPv6Network(int(IPv6Network('2001:db8::'))) == IPv6Network('2001:db8::') strict: A boolean. If true, ensure that we have been passed A true network address, eg, 2001:db8::1000/124 and not an IP address on a network, eg, 2001:db8::1/124. Raises: AddressValueError: If address isn't a valid IPv6 address. NetmaskValueError: If the netmask isn't valid for an IPv6 address. ValueError: If strict was True and a network address was not supplied. rr&r z%s has host bits setN)rOrr5rkrr9rr#r%rmr rKrrrIrrr)rWrrr$rrrr r r r_s(    zIPv6Network.__init__ccs@t|j}t|j}x&t|d|dD]}|j|Vq(WdS)zGenerate Iterator over usable hosts in a network. This is like __iter__ except it doesn't return the Subnet-Router anycast address. r&N)rkrKrDrr)rWrrrr r r rs  zIPv6Network.hostscCs|jjo|jjS)a`Test if the address is reserved for site-local. Note that the site-local address space has been deprecated by RFC 3879. Use is_private to test if this address is in the space of unique local addresses as defined by RFC 4193. Returns: A boolean, True if the address is reserved per RFC 3513 2.5.6. )rKrrD)rWr r r rs zIPv6Network.is_site_localN)T) rrrrr rrrrsrr r r r rOs   > rc@seZdZedZedZededededededed ed ed edg Zed ed edededededededededededededgZedZdS)_IPv6Constantsz fe80::/10zff00::/8z::1/128z::/128z ::ffff:0:0/96z100::/64z 2001::/23z 2001:2::/48z 2001:db8::/32z 2001:10::/28zfc00::/7z::/8z100::/8z200::/7z400::/6z800::/5z1000::/4z4000::/3z6000::/3z8000::/3zA000::/3zC000::/3zE000::/4zF000::/5zF800::/6zFE00::/9z fec0::/10N) rrrrrrrrrr r r r rs*         r)T)#r __version__rrrrrr rrrrrr%r/r3r<rFrNrTrUtotal_orderingr6rOrhr rrrrrr rrrr r r r  sV #716:EEuSa5Wj!