class IPAddr
IPAddr bietet eine Reihe von Methoden zur Manipulation einer IP-Adresse. Sowohl IPv4 als auch IPv6 werden unterstützt.
Beispiel
require 'ipaddr' ipaddr1 = IPAddr.new "3ffe:505:2::1" p ipaddr1 #=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff> p ipaddr1.to_s #=> "3ffe:505:2::1" ipaddr2 = ipaddr1.mask(48) #=> #<IPAddr: IPv6:3ffe:0505:0002:0000:0000:0000:0000:0000/ffff:ffff:ffff:0000:0000:0000:0000:0000> p ipaddr2.to_s #=> "3ffe:505:2::" ipaddr3 = IPAddr.new "192.168.2.0/24" p ipaddr3 #=> #<IPAddr: IPv4:192.168.2.0/255.255.255.0>
Constants
- IN4MASK
-
32-Bit-Maske für IPv4
- IN6FORMAT
-
Formatierungszeichenkette für IPv6
- IN6MASK
-
128-Bit-Maske für IPv6
- RE_IPV4ADDRLIKE
-
Regexpwird *intern* zum Parsen von IPv4-Adressen verwendet. - RE_IPV6ADDRLIKE_COMPRESSED
-
Regexpwird *intern* zum Parsen von IPv6-Adressen verwendet. - RE_IPV6ADDRLIKE_FULL
-
Regexpwird *intern* zum Parsen von IPv6-Adressen verwendet. - VERSION
-
Die Versionszeichenfolge
Attribute
Gibt die Adressfamilie dieser IP-Adresse zurück.
Öffentliche Klassenmethoden
Source
# File lib/ipaddr.rb, line 658 def initialize(addr = '::', family = Socket::AF_UNSPEC) @mask_addr = nil if !addr.kind_of?(String) case family when Socket::AF_INET, Socket::AF_INET6 set(addr.to_i, family) @mask_addr = (family == Socket::AF_INET) ? IN4MASK : IN6MASK return when Socket::AF_UNSPEC raise AddressFamilyError, "address family must be specified" else raise AddressFamilyError, "unsupported address family: #{family}" end end prefix, prefixlen = addr.split('/', 2) if prefix =~ /\A\[(.*)\]\z/i prefix = $1 family = Socket::AF_INET6 end if prefix =~ /\A(.*)(%\w+)\z/ prefix = $1 zone_id = $2 family = Socket::AF_INET6 end # It seems AI_NUMERICHOST doesn't do the job. #Socket.getaddrinfo(left, nil, Socket::AF_INET6, Socket::SOCK_STREAM, nil, # Socket::AI_NUMERICHOST) @addr = @family = nil if family == Socket::AF_UNSPEC || family == Socket::AF_INET @addr = in_addr(prefix) if @addr @family = Socket::AF_INET end end if !@addr && (family == Socket::AF_UNSPEC || family == Socket::AF_INET6) @addr = in6_addr(prefix) @family = Socket::AF_INET6 end @zone_id = zone_id if family != Socket::AF_UNSPEC && @family != family raise AddressFamilyError, "address family mismatch" end if prefixlen mask!(prefixlen) else @mask_addr = (@family == Socket::AF_INET) ? IN4MASK : IN6MASK end end
Erstellt ein neues ipaddr-Objekt entweder aus einer menschenlesbaren IP-Adressendarstellung als Zeichenkette oder aus einem gepackten in_addr-Wert gefolgt von einer Adressfamilie.
Im ersten Fall sind die folgenden Formate gültig: "adresse", "adresse/präfixlänge" und "adresse/maske", wobei IPv6-Adressen in eckige Klammern ('[' und ']') eingeschlossen sein können. Wenn eine Präfixlänge oder eine Maske angegeben wird, wird eine maskierte IP-Adresse zurückgegeben. Obwohl die Adressfamilie automatisch aus der angegebenen Zeichenkette ermittelt wird, können Sie sie optional durch das zweite Argument explizit angeben.
Andernfalls wird eine IP-Adresse aus einem gepackten in_addr-Wert und einer Adressfamilie generiert.
Die Klasse IPAddr definiert viele Methoden und Operatoren, und einige davon, wie &, |, include? und ==, akzeptieren eine Zeichenkette oder einen gepackten in_addr-Wert anstelle eines IPAddr-Objekts.
Source
# File lib/ipaddr.rb, line 108 def self.new_ntoh(addr) return new(ntop(addr)) end
Erstellt eine neue ipaddr, die die gegebene Netzwerk-Byte-Reihenfolge-Zeichenkette einer IP-Adresse enthält.
Source
# File lib/ipaddr.rb, line 115 def self.ntop(addr) if addr.is_a?(String) && addr.encoding != Encoding::BINARY raise InvalidAddressError, "invalid encoding (given #{addr.encoding}, expected BINARY)" end case addr.bytesize when 4 addr.unpack('C4').join('.') when 16 IN6FORMAT % addr.unpack('n8') else raise AddressFamilyError, "unsupported address family" end end
Konvertiert eine IP-Adresse in Netzwerk-Byte-Reihenfolge in eine menschenlesbare Form. Es wird erwartet, dass die Zeichenkette in Encoding::ASCII_8BIT (BINARY) kodiert ist.
Öffentliche Instanzmethoden
Source
# File lib/ipaddr.rb, line 131 def &(other) return self.clone.set(@addr & coerce_other(other).to_i) end
Gibt eine neue ipaddr zurück, die durch bitweises AND erstellt wurde.
Source
# File lib/ipaddr.rb, line 156 def +(offset) self.clone.set(@addr + offset, @family) end
Gibt eine neue ipaddr zurück, die um den angegebenen Offset größer ist als die ursprüngliche Adresse.
Source
# File lib/ipaddr.rb, line 161 def -(offset) self.clone.set(@addr - offset, @family) end
Gibt eine neue ipaddr zurück, die um den angegebenen Offset kleiner ist als die ursprüngliche Adresse.
Source
# File lib/ipaddr.rb, line 146 def <<(num) return self.clone.set(addr_mask(@addr << num)) end
Gibt eine neue ipaddr zurück, die durch bitweises Linksverschieben erstellt wurde.
Source
# File lib/ipaddr.rb, line 435 def <=>(other) other = coerce_other(other) rescue nil else @addr <=> other.to_i if other.family == @family end
Vergleicht die ipaddr mit einer anderen.
Source
# File lib/ipaddr.rb, line 166 def ==(other) other = coerce_other(other) rescue false else @family == other.family && @addr == other.to_i end
Gibt true zurück, wenn zwei ipaddrs gleich sind.
Source
# File lib/ipaddr.rb, line 141 def >>(num) return self.clone.set(@addr >> num) end
Gibt eine neue ipaddr zurück, die durch bitweises Rechtsschieben erstellt wurde.
Source
# File lib/ipaddr.rb, line 136 def |(other) return self.clone.set(@addr | coerce_other(other).to_i) end
Gibt eine neue ipaddr zurück, die durch bitweises OR erstellt wurde.
Source
# File lib/ipaddr.rb, line 151 def ~ return self.clone.set(addr_mask(~@addr)) end
Gibt eine neue ipaddr zurück, die durch bitweise Negation erstellt wurde.
Source
# File lib/ipaddr.rb, line 242 def as_json(*) if ipv4? && prefix == 32 to_s elsif ipv6? && prefix == 128 to_s else cidr end end
Gibt eine Zeichenkette zurück, die die IP-Adressendarstellung mit Präfix enthält.
Source
# File lib/ipaddr.rb, line 259 def cidr "#{to_s}/#{prefix}" end
Gibt eine Zeichenkette zurück, die die IP-Adressendarstellung in CIDR-Notation enthält.
Source
# File lib/ipaddr.rb, line 445 def eql?(other) return self.class == other.class && self.hash == other.hash && self == other end
Prüft auf Gleichheit, die von Hash verwendet wird.
Source
# File lib/ipaddr.rb, line 450 def hash return ([@addr, @mask_addr, @zone_id].hash << 1) | (ipv4? ? 0 : 1) end
Source
# File lib/ipaddr.rb, line 264 def hton case @family when Socket::AF_INET return [@addr].pack('N') when Socket::AF_INET6 return (0..7).map { |i| (@addr >> (112 - 16 * i)) & 0xffff }.pack('n8') else raise AddressFamilyError, "unsupported address family" end end
Gibt eine Netzwerk-Byte-Reihenfolge-Zeichenkette der IP-Adresse zurück.
Source
# File lib/ipaddr.rb, line 192 def include?(other) other = coerce_other(other) return false unless other.family == family begin_addr <= other.begin_addr && end_addr >= other.end_addr end
Gibt true zurück, wenn die angegebene ipaddr im Bereich liegt.
z.B.
require 'ipaddr' net1 = IPAddr.new("192.168.2.0/24") net2 = IPAddr.new("192.168.2.100") net3 = IPAddr.new("192.168.3.0") net4 = IPAddr.new("192.168.2.0/16") p net1.include?(net2) #=> true p net1.include?(net3) #=> false p net1.include?(net4) #=> false p net4.include?(net1) #=> true
Source
# File lib/ipaddr.rb, line 490 def inspect case @family when Socket::AF_INET af = "IPv4" when Socket::AF_INET6 af = "IPv6" zone_id = @zone_id.to_s else raise AddressFamilyError, "unsupported address family" end return sprintf("#<%s: %s:%s%s/%s>", self.class.name, af, _to_string(@addr), zone_id, _to_string(@mask_addr)) end
Gibt eine Zeichenkette zurück, die eine menschenlesbare Darstellung der ipaddr enthält ("#<IPAddr: family:address/mask>").
Source
# File lib/ipaddr.rb, line 414 def ip6_arpa if !ipv6? raise InvalidAddressError, "not an IPv6 address: #{@addr}" end return _reverse + ".ip6.arpa" end
Gibt eine Zeichenkette für die DNS-Rückwärtssuche zurück, die mit RFC3172 kompatibel ist.
Source
# File lib/ipaddr.rb, line 422 def ip6_int if !ipv6? raise InvalidAddressError, "not an IPv6 address: #{@addr}" end return _reverse + ".ip6.int" end
Gibt eine Zeichenkette für die DNS-Rückwärtssuche zurück, die mit RFC1886 kompatibel ist.
Source
# File lib/ipaddr.rb, line 278 def ipv4? return @family == Socket::AF_INET end
Gibt true zurück, wenn die ipaddr eine IPv4-Adresse ist.
Source
# File lib/ipaddr.rb, line 380 def ipv4_compat warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE if !ipv4? raise InvalidAddressError, "not an IPv4 address: #{@addr}" end clone = self.clone.set(@addr, Socket::AF_INET6) clone.instance_variable_set(:@mask_addr, @mask_addr | 0xffffffffffffffffffffffff00000000) clone end
Gibt eine neue ipaddr zurück, die durch Umwandlung der nativen IPv4-Adresse in eine IPv4-kompatible IPv6-Adresse erstellt wurde.
Source
# File lib/ipaddr.rb, line 352 def ipv4_compat? warn "IPAddr\##{__callee__} is obsolete", uplevel: 1 if $VERBOSE _ipv4_compat? end
Gibt true zurück, wenn die ipaddr eine IPv4-kompatible IPv6-Adresse ist.
Source
# File lib/ipaddr.rb, line 369 def ipv4_mapped if !ipv4? raise InvalidAddressError, "not an IPv4 address: #{@addr}" end clone = self.clone.set(@addr | 0xffff00000000, Socket::AF_INET6) clone.instance_variable_set(:@mask_addr, @mask_addr | 0xffffffffffffffffffffffff00000000) clone end
Gibt eine neue ipaddr zurück, die durch Umwandlung der nativen IPv4-Adresse in eine IPv4-abgebildete IPv6-Adresse erstellt wurde.
Source
# File lib/ipaddr.rb, line 347 def ipv4_mapped? return ipv6? && (@addr >> 32) == 0xffff end
Gibt true zurück, wenn die ipaddr eine IPv4-abgebildete IPv6-Adresse ist.
Source
# File lib/ipaddr.rb, line 283 def ipv6? return @family == Socket::AF_INET6 end
Gibt true zurück, wenn die ipaddr eine IPv6-Adresse ist.
Source
# File lib/ipaddr.rb, line 332 def link_local? case @family when Socket::AF_INET @addr & 0xffff0000 == 0xa9fe0000 # 169.254.0.0/16 when Socket::AF_INET6 @addr & 0xffc0_0000_0000_0000_0000_0000_0000_0000 == 0xfe80_0000_0000_0000_0000_0000_0000_0000 || # fe80::/10 (@addr & 0xffff_0000_0000 == 0xffff_0000_0000 && ( @addr & 0xffff0000 == 0xa9fe0000 # ::ffff:169.254.0.0/16 )) else raise AddressFamilyError, "unsupported address family" end end
Gibt true zurück, wenn die ipaddr eine Link-Local-Adresse ist. IPv4-Adressen im Bereich 169.254.0.0/16, reserviert durch RFC 3927, und Link-Local-IPv6-Unicast-Adressen im Bereich fe80::/10, reserviert durch RFC 4291, gelten als Link-Local. Link-Local-IPv4-Adressen im Bereich der IPv4-abgebildeten IPv6-Adressen gelten ebenfalls als Link-Local.
Source
# File lib/ipaddr.rb, line 290 def loopback? case @family when Socket::AF_INET @addr & 0xff000000 == 0x7f000000 # 127.0.0.1/8 when Socket::AF_INET6 @addr == 1 || # ::1 (@addr & 0xffff_0000_0000 == 0xffff_0000_0000 && ( @addr & 0xff000000 == 0x7f000000 # ::ffff:127.0.0.1/8 )) else raise AddressFamilyError, "unsupported address family" end end
Gibt true zurück, wenn die ipaddr eine Loopback-Adresse ist. Loopback-IPv4-Adressen im Bereich der IPv4-abgebildeten IPv6-Adressen gelten ebenfalls als Loopback-Adressen.
Source
# File lib/ipaddr.rb, line 176 def mask(prefixlen) return self.clone.mask!(prefixlen) end
Gibt eine neue ipaddr zurück, die durch Maskierung der IP-Adresse mit der angegebenen Präfixlänge/Netzmaske erstellt wurde (z.B. 8, 64, "255.255.255.0" usw.).
Source
# File lib/ipaddr.rb, line 393 def native if !ipv4_mapped? && !_ipv4_compat? return self end return self.clone.set(@addr & IN4MASK, Socket::AF_INET) end
Gibt eine neue ipaddr zurück, die durch Umwandlung der IPv6-Adresse in eine native IPv4-Adresse erstellt wurde. Wenn die IP-Adresse keine IPv4-abgebildete oder IPv4-kompatible IPv6-Adresse ist, wird self zurückgegeben.
Source
# File lib/ipaddr.rb, line 505 def netmask _to_string(@mask_addr) end
Gibt die Netzmaske im Zeichenkettenformat zurück, z.B. 255.255.0.0.
Source
# File lib/ipaddr.rb, line 460 def prefix case @family when Socket::AF_INET n = IN4MASK ^ @mask_addr i = 32 when Socket::AF_INET6 n = IN6MASK ^ @mask_addr i = 128 else raise AddressFamilyError, "unsupported address family" end while n.positive? n >>= 1 i -= 1 end i end
Gibt die Präfixlänge in Bits für die ipaddr zurück.
Source
# File lib/ipaddr.rb, line 479 def prefix=(prefix) case prefix when Integer mask!(prefix) else raise InvalidPrefixError, "prefix must be an integer" end end
Setzt die Präfixlänge in Bits.
Source
# File lib/ipaddr.rb, line 309 def private? case @family when Socket::AF_INET @addr & 0xff000000 == 0x0a000000 || # 10.0.0.0/8 @addr & 0xfff00000 == 0xac100000 || # 172.16.0.0/12 @addr & 0xffff0000 == 0xc0a80000 # 192.168.0.0/16 when Socket::AF_INET6 @addr & 0xfe00_0000_0000_0000_0000_0000_0000_0000 == 0xfc00_0000_0000_0000_0000_0000_0000_0000 || (@addr & 0xffff_0000_0000 == 0xffff_0000_0000 && ( @addr & 0xff000000 == 0x0a000000 || # ::ffff:10.0.0.0/8 @addr & 0xfff00000 == 0xac100000 || # ::ffff::172.16.0.0/12 @addr & 0xffff0000 == 0xc0a80000 # ::ffff::192.168.0.0/16 )) else raise AddressFamilyError, "unsupported address family" end end
Gibt true zurück, wenn die ipaddr eine private Adresse ist. IPv4-Adressen in 10.0.0.0/8, 172.16.0.0/12 und 192.168.0.0/16, wie in RFC 1918 definiert, und IPv6 Unique Local Addresses in fc00::/7, wie in RFC 4193 definiert, gelten als privat. Private IPv4-Adressen im Bereich der IPv4-abgebildeten IPv6-Adressen gelten ebenfalls als privat.
Source
# File lib/ipaddr.rb, line 402 def reverse case @family when Socket::AF_INET return _reverse + ".in-addr.arpa" when Socket::AF_INET6 return ip6_arpa else raise AddressFamilyError, "unsupported address family" end end
Gibt eine Zeichenkette für die DNS-Rückwärtssuche zurück. Für eine IPv6-Adresse wird eine Zeichenkette im RFC3172-Format zurückgegeben.
Source
# File lib/ipaddr.rb, line 430 def succ return self.clone.set(@addr + 1, @family) end
Gibt den Nachfolger der ipaddr zurück.
Source
# File lib/ipaddr.rb, line 200 def to_i return @addr end
Gibt die Integer-Darstellung der ipaddr zurück.
Source
# File lib/ipaddr.rb, line 253 def to_json(*a) %Q{"#{as_json(*a)}"} end
Gibt eine JSON-Zeichenkette zurück, die die IP-Adressendarstellung enthält.
Source
# File lib/ipaddr.rb, line 455 def to_range self.class.new(begin_addr, @family)..self.class.new(end_addr, @family) end
Erstellt ein Range-Objekt für die Netzwerkadresse.
Source
# File lib/ipaddr.rb, line 205 def to_s str = to_string return str if ipv4? str.gsub!(/\b0{1,3}([\da-f]+)\b/i, '\1') loop do break if str.sub!(/\A0:0:0:0:0:0:0:0\z/, '::') break if str.sub!(/\b0:0:0:0:0:0:0\b/, ':') break if str.sub!(/\b0:0:0:0:0:0\b/, ':') break if str.sub!(/\b0:0:0:0:0\b/, ':') break if str.sub!(/\b0:0:0:0\b/, ':') break if str.sub!(/\b0:0:0\b/, ':') break if str.sub!(/\b0:0\b/, ':') break end str.sub!(/:{3,}/, '::') if /\A::(ffff:)?([\da-f]{1,4}):([\da-f]{1,4})\z/i =~ str str = sprintf('::%s%d.%d.%d.%d', $1, $2.hex / 256, $2.hex % 256, $3.hex / 256, $3.hex % 256) end str end
Gibt eine Zeichenkette zurück, die die IP-Adressendarstellung enthält.
Source
# File lib/ipaddr.rb, line 231 def to_string str = _to_string(@addr) if @family == Socket::AF_INET6 str << zone_id.to_s end return str end
Gibt eine Zeichenkette zurück, die die IP-Adressendarstellung in kanonischer Form enthält.
Source
# File lib/ipaddr.rb, line 510 def wildcard_mask case @family when Socket::AF_INET mask = IN4MASK ^ @mask_addr when Socket::AF_INET6 mask = IN6MASK ^ @mask_addr else raise AddressFamilyError, "unsupported address family" end _to_string(mask) end
Gibt die Wildcard-Maske im Zeichenkettenformat zurück, z.B. 0.0.255.255.
Source
# File lib/ipaddr.rb, line 525 def zone_id if @family == Socket::AF_INET6 @zone_id else raise InvalidAddressError, "not an IPv6 address" end end
Gibt die IPv6-Zonenkennung zurück, falls vorhanden. Löst InvalidAddressError aus, wenn es sich nicht um eine IPv6-Adresse handelt.
Source
# File lib/ipaddr.rb, line 535 def zone_id=(zid) if @family == Socket::AF_INET6 case zid when nil, /\A%(\w+)\z/ @zone_id = zid else raise InvalidAddressError, "invalid zone identifier for address" end else raise InvalidAddressError, "not an IPv6 address" end end
Gibt die IPv6-Zonenkennung zurück, falls vorhanden. Löst InvalidAddressError aus, wenn es sich nicht um eine IPv6-Adresse handelt.
Geschützte Instanzmethoden
Source
# File lib/ipaddr.rb, line 594 def mask!(mask) case mask when String case mask when /\A(0|[1-9]+\d*)\z/ prefixlen = mask.to_i when /\A\d+\z/ raise InvalidPrefixError, "leading zeros in prefix" else m = IPAddr.new(mask) if m.family != @family raise InvalidPrefixError, "address family is not same" end @mask_addr = m.to_i n = @mask_addr ^ m.instance_variable_get(:@mask_addr) unless ((n + 1) & n).zero? raise InvalidPrefixError, "invalid mask #{mask}" end @addr &= @mask_addr return self end else prefixlen = mask end case @family when Socket::AF_INET if prefixlen < 0 || prefixlen > 32 raise InvalidPrefixError, "invalid length" end masklen = 32 - prefixlen @mask_addr = ((IN4MASK >> masklen) << masklen) when Socket::AF_INET6 if prefixlen < 0 || prefixlen > 128 raise InvalidPrefixError, "invalid length" end masklen = 128 - prefixlen @mask_addr = ((IN6MASK >> masklen) << masklen) else raise AddressFamilyError, "unsupported address family" end @addr = ((@addr >> masklen) << masklen) return self end
Setzt die aktuelle Netzmaske auf die angegebene Maske.
Source
# File lib/ipaddr.rb, line 570 def set(addr, *family) case family[0] ? family[0] : @family when Socket::AF_INET if addr < 0 || addr > IN4MASK raise InvalidAddressError, "invalid address: #{addr}" end when Socket::AF_INET6 if addr < 0 || addr > IN6MASK raise InvalidAddressError, "invalid address: #{addr}" end else raise AddressFamilyError, "unsupported address family" end @addr = addr if family[0] @family = family[0] if @family == Socket::AF_INET @mask_addr &= IN4MASK end end return self end
Setzt +@addr+, die intern gespeicherte IP-Adresse, auf die angegebene addr. Der Parameter addr wird mit dem ersten family-Element validiert, das Socket::AF_INET oder Socket::AF_INET6 ist.