IPAddr provides a set of methods to manipulate an IP address. Both IPv4 and IPv6 are supported.
Constants
| IN4MASK | = | 0xffffffff |
| IN6MASK | = | 0xffffffffffffffffffffffffffffffff |
| IN6FORMAT | = | (["%.4x"] * 8).join(':') |
Attributes
| family | [R] | Returns the address family of this IP address. |
Public Class methods
Creates a new ipaddr containing the given human readable form of an IP address. It also accepts `address/prefixlen’ and `address/mask’. When prefixlen or mask is specified, it returns a masked ipaddr. IPv6 address may beenclosed with `[’ and `]’.
Although an address family is determined automatically from a specified address, you can specify an address family explicitly by the optional second argument.
# File ipaddr.rb, line 403
403: def initialize(addr = '::', family = Socket::AF_UNSPEC)
404: if !addr.kind_of?(String)
405: if family != Socket::AF_INET6 && family != Socket::AF_INET
406: raise ArgumentError, "unsupported address family"
407: end
408: set(addr, family)
409: @mask_addr = (family == Socket::AF_INET) ? IN4MASK : IN6MASK
410: return
411: end
412: prefix, prefixlen = addr.split('/')
413: if prefix =~ /^\[(.*)\]$/i
414: prefix = $1
415: family = Socket::AF_INET6
416: end
417: # It seems AI_NUMERICHOST doesn't do the job.
418: #Socket.getaddrinfo(left, nil, Socket::AF_INET6, Socket::SOCK_STREAM, nil,
419: # Socket::AI_NUMERICHOST)
420: begin
421: IPSocket.getaddress(prefix) # test if address is vaild
422: rescue
423: raise ArgumentError, "invalid address"
424: end
425: @addr = @family = nil
426: if family == Socket::AF_UNSPEC || family == Socket::AF_INET
427: @addr = in_addr(prefix)
428: if @addr
429: @family = Socket::AF_INET
430: end
431: end
432: if !@addr && (family == Socket::AF_UNSPEC || family == Socket::AF_INET6)
433: @addr = in6_addr(prefix)
434: @family = Socket::AF_INET6
435: end
436: if family != Socket::AF_UNSPEC && @family != family
437: raise ArgumentError, "address family unmatch"
438: end
439: if prefixlen
440: mask!(prefixlen)
441: else
442: @mask_addr = (family == Socket::AF_INET) ? IN4MASK : IN6MASK
443: end
444: end
Creates a new ipaddr containing the given network byte ordered string form of an IP address.
# File ipaddr.rb, line 91
91: def IPAddr::new_ntoh(addr)
92: return IPAddr.new(IPAddr::ntop(addr))
93: end
Convert a network byte ordered string form of an IP address into human readable form.
# File ipaddr.rb, line 97
97: def IPAddr::ntop(addr)
98: case addr.size
99: when 4
100: s = addr.unpack('C4').join('.')
101: when 16
102: s = IN6FORMAT % addr.unpack('n8')
103: else
104: raise ArgumentError, "unsupported address family"
105: end
106: return s
107: end
Public Instance methods
Returns a new ipaddr built by bitwise AND.
# File ipaddr.rb, line 110
110: def &(other)
111: return self.clone.set(@addr & other.to_i)
112: end
Returns a new ipaddr built by bitwise left shift.
# File ipaddr.rb, line 125
125: def <<(num)
126: return self.clone.set(addr_mask(@addr << num))
127: end
Returns true if two ipaddr are equal.
# File ipaddr.rb, line 135
135: def ==(other)
136: if other.kind_of?(IPAddr) && @family != other.family
137: return false
138: end
139: return (@addr == other.to_i)
140: end
Returns a new ipaddr built by bitwise right-shift.
# File ipaddr.rb, line 120
120: def >>(num)
121: return self.clone.set(@addr >> num)
122: end
Returns a network byte ordered string form of the IP address.
# File ipaddr.rb, line 226
226: def hton
227: case @family
228: when Socket::AF_INET
229: return [@addr].pack('N')
230: when Socket::AF_INET6
231: return (0..7).map { |i|
232: (@addr >> (112 - 16 * i)) & 0xffff
233: }.pack('n8')
234: else
235: raise "unsupported address family"
236: end
237: end
Returns true if the given ipaddr is in the range.
e.g.:
require 'ipaddr'
net1 = IPAddr.new("192.168.2.0/24")
p net1.include?(IPAddr.new("192.168.2.0")) #=> true
p net1.include?(IPAddr.new("192.168.2.255")) #=> true
p net1.include?(IPAddr.new("192.168.3.0")) #=> false
# File ipaddr.rb, line 156
156: def include?(other)
157: if ipv4_mapped?
158: if (@mask_addr >> 32) != 0xffffffffffffffffffffffff
159: return false
160: end
161: mask_addr = (@mask_addr & IN4MASK)
162: addr = (@addr & IN4MASK)
163: family = Socket::AF_INET
164: else
165: mask_addr = @mask_addr
166: addr = @addr
167: family = @family
168: end
169: if other.kind_of?(IPAddr)
170: if other.ipv4_mapped?
171: other_addr = (other.to_i & IN4MASK)
172: other_family = Socket::AF_INET
173: else
174: other_addr = other.to_i
175: other_family = other.family
176: end
177: else # Not IPAddr - assume integer in same family as us
178: other_addr = other.to_i
179: other_family = family
180: end
181:
182: if family != other_family
183: return false
184: end
185: return ((addr & mask_addr) == (other_addr & mask_addr))
186: end
Returns a string containing a human-readable representation of the ipaddr. ("#<IPAddr: family:address/mask>")
# File ipaddr.rb, line 322
322: def inspect
323: case @family
324: when Socket::AF_INET
325: af = "IPv4"
326: when Socket::AF_INET6
327: af = "IPv6"
328: else
329: raise "unsupported address family"
330: end
331: return sprintf("#<%s: %s:%s/%s>", self.class.name,
332: af, _to_string(@addr), _to_string(@mask_addr))
333: end
Returns a string for DNS reverse lookup compatible with RFC3172.
# File ipaddr.rb, line 305
305: def ip6_arpa
306: if !ipv6?
307: raise ArgumentError, "not an IPv6 address"
308: end
309: return _reverse + ".ip6.arpa"
310: end
Returns a string for DNS reverse lookup compatible with RFC1886.
# File ipaddr.rb, line 313
313: def ip6_int
314: if !ipv6?
315: raise ArgumentError, "not an IPv6 address"
316: end
317: return _reverse + ".ip6.int"
318: end
Returns true if the ipaddr is an IPv4 address.
# File ipaddr.rb, line 240
240: def ipv4?
241: return @family == Socket::AF_INET
242: end
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-compatible IPv6 address.
# File ipaddr.rb, line 274
274: def ipv4_compat
275: if !ipv4?
276: raise ArgumentError, "not an IPv4 address"
277: end
278: return self.clone.set(@addr, Socket::AF_INET6)
279: end
Returns true if the ipaddr is an IPv4-compatible IPv6 address.
# File ipaddr.rb, line 255
255: def ipv4_compat?
256: if !ipv6? || (@addr >> 32) != 0
257: return false
258: end
259: a = (@addr & IN4MASK)
260: return a != 0 && a != 1
261: end
Returns a new ipaddr built by converting the native IPv4 address into an IPv4-mapped IPv6 address.
# File ipaddr.rb, line 265
265: def ipv4_mapped
266: if !ipv4?
267: raise ArgumentError, "not an IPv4 address"
268: end
269: return self.clone.set(@addr | 0xffff00000000, Socket::AF_INET6)
270: end
Returns true if the ipaddr is an IPv4-mapped IPv6 address.
# File ipaddr.rb, line 250
250: def ipv4_mapped?
251: return ipv6? && (@addr >> 32) == 0xffff
252: end
Returns true if the ipaddr is an IPv6 address.
# File ipaddr.rb, line 245
245: def ipv6?
246: return @family == Socket::AF_INET6
247: end
Returns a new ipaddr built by masking IP address with the given prefixlen/netmask. (e.g. 8, 64, "255.255.255.0", etc.)
# File ipaddr.rb, line 144
144: def mask(prefixlen)
145: return self.clone.mask!(prefixlen)
146: end
Returns a new ipaddr built by converting the IPv6 address into a native IPv4 address. If the IP address is not an IPv4-mapped or IPv4-compatible IPv6 address, returns self.
# File ipaddr.rb, line 284
284: def native
285: if !ipv4_mapped? && !ipv4_compat?
286: return self
287: end
288: return self.clone.set(@addr & IN4MASK, Socket::AF_INET)
289: end
Returns a string for DNS reverse lookup. It returns a string in RFC3172 form for an IPv6 address.
# File ipaddr.rb, line 293
293: def reverse
294: case @family
295: when Socket::AF_INET
296: return _reverse + ".in-addr.arpa"
297: when Socket::AF_INET6
298: return ip6_arpa
299: else
300: raise "unsupported address family"
301: end
302: end
Returns the integer representation of the ipaddr.
# File ipaddr.rb, line 190
190: def to_i
191: return @addr
192: end
Returns a string containing the IP address representation.
# File ipaddr.rb, line 195
195: def to_s
196: str = to_string
197: return str if ipv4?
198:
199: str.gsub!(/\b0{1,3}([\da-f]+)\b/i, '\1')
200: loop do
201: break if str.sub!(/\A0:0:0:0:0:0:0:0\Z/, '::')
202: break if str.sub!(/\b0:0:0:0:0:0:0\b/, ':')
203: break if str.sub!(/\b0:0:0:0:0:0\b/, ':')
204: break if str.sub!(/\b0:0:0:0:0\b/, ':')
205: break if str.sub!(/\b0:0:0:0\b/, ':')
206: break if str.sub!(/\b0:0:0\b/, ':')
207: break if str.sub!(/\b0:0\b/, ':')
208: break
209: end
210: str.sub!(/:{3,}/, '::')
211:
212: if /\A::(ffff:)?([\da-f]{1,4}):([\da-f]{1,4})\Z/i =~ str
213: str = sprintf('::%s%d.%d.%d.%d', $1, $2.hex / 256, $2.hex % 256, $3.hex / 256, $3.hex % 256)
214: end
215:
216: str
217: end
Returns a string containing the IP address representation in canonical form.
# File ipaddr.rb, line 221
221: def to_string
222: return _to_string(@addr)
223: end
Returns a new ipaddr built by bitwise OR.
# File ipaddr.rb, line 115
115: def |(other)
116: return self.clone.set(@addr | other.to_i)
117: end
Returns a new ipaddr built by bitwise negation.
# File ipaddr.rb, line 130
130: def ~
131: return self.clone.set(addr_mask(~@addr))
132: end
Protected Instance methods
# File ipaddr.rb, line 357
357: def mask!(mask)
358: if mask.kind_of?(String)
359: if mask =~ /^\d+$/
360: prefixlen = mask.to_i
361: else
362: m = IPAddr.new(mask)
363: if m.family != @family
364: raise ArgumentError, "address family is not same"
365: end
366: @mask_addr = m.to_i
367: @addr &= @mask_addr
368: return self
369: end
370: else
371: prefixlen = mask
372: end
373: case @family
374: when Socket::AF_INET
375: if prefixlen < 0 || prefixlen > 32
376: raise ArgumentError, "invalid length"
377: end
378: masklen = 32 - prefixlen
379: @mask_addr = ((IN4MASK >> masklen) << masklen)
380: when Socket::AF_INET6
381: if prefixlen < 0 || prefixlen > 128
382: raise ArgumentError, "invalid length"
383: end
384: masklen = 128 - prefixlen
385: @mask_addr = ((IN6MASK >> masklen) << masklen)
386: else
387: raise "unsupported address family"
388: end
389: @addr = ((@addr >> masklen) << masklen)
390: return self
391: end
# File ipaddr.rb, line 337
337: def set(addr, *family)
338: case family[0] ? family[0] : @family
339: when Socket::AF_INET
340: if addr < 0 || addr > IN4MASK
341: raise ArgumentError, "invalid address"
342: end
343: when Socket::AF_INET6
344: if addr < 0 || addr > IN6MASK
345: raise ArgumentError, "invalid address"
346: end
347: else
348: raise ArgumentError, "unsupported address family"
349: end
350: @addr = addr
351: if family[0]
352: @family = family[0]
353: end
354: return self
355: end