@eggjs/ip

IP address utilities for node.js

Security fix fork, merge https://github.com/indutny/node-ip/pull/144

Installation

npm

1npm install @eggjs/ip

Usage

Get your ip address, compare ip addresses, validate ip addresses, etc.

1var ip = require('@eggjs/ip');
2
3ip.address() // my ip address
4ip.isEqual('::1', '::0:1'); // true
5ip.toBuffer('127.0.0.1') // Buffer([127, 0, 0, 1])
6ip.toString(new Buffer([127, 0, 0, 1])) // 127.0.0.1
7ip.fromPrefixLen(24) // 255.255.255.0
8ip.mask('192.168.1.134', '255.255.255.0') // 192.168.1.0
9ip.cidr('192.168.1.134/26') // 192.168.1.128
10ip.not('255.255.255.0') // 0.0.0.255
11ip.or('192.168.1.134', '0.0.0.255') // 192.168.1.255
12ip.isPrivate('127.0.0.1') // true
13ip.isV4Format('127.0.0.1'); // true
14ip.isV6Format('::ffff:127.0.0.1'); // true
15ip.isValid('127.0.0.1'); // true
16
17// operate on buffers in-place
18var buf = new Buffer(128);
19var offset = 64;
20ip.toBuffer('127.0.0.1', buf, offset);  // [127, 0, 0, 1] at offset 64
21ip.toString(buf, offset, 4);            // '127.0.0.1'
22
23// subnet information
24ip.subnet('192.168.1.134', '255.255.255.192')
25// { networkAddress: '192.168.1.128',
26//   firstAddress: '192.168.1.129',
27//   lastAddress: '192.168.1.190',
28//   broadcastAddress: '192.168.1.191',
29//   subnetMask: '255.255.255.192',
30//   subnetMaskLength: 26,
31//   numHosts: 62,
32//   length: 64,
33//   contains: function(addr){...} }
34ip.cidrSubnet('192.168.1.134/26')
35// Same as previous.
36
37// range checking
38ip.cidrSubnet('192.168.1.134/26').contains('192.168.1.190') // true
39
40// ipv4 long conversion
41ip.toLong('127.0.0.1'); // 2130706433
42ip.fromLong(2130706433); // '127.0.0.1'
43
44// malformed addresses and normalization
45ip.normalizeStrict('0::01'); // '::1'
46ip.isPrivate('0x7f.1'); // throw error
47ip.isValidAndPrivate('0x7f.1'); // false
48ip.normalizeStrict('0x7f.1'); // throw error
49var normalized = ip.normalizeLax('0x7f.1'); // 127.0.0.1
50ip.isPrivate(normalized); // true

Contributors

Made with contributors-img.

License

1This software is licensed under the MIT License.
2
3Copyright (c) 2024-present eggjs and other contributors.
4Copyright Fedor Indutny, 2012.
5
6Permission is hereby granted, free of charge, to any person obtaining a
7copy of this software and associated documentation files (the
8"Software"), to deal in the Software without restriction, including
9without limitation the rights to use, copy, modify, merge, publish,
10distribute, sublicense, and/or sell copies of the Software, and to permit
11persons to whom the Software is furnished to do so, subject to the
12following conditions:
13
14The above copyright notice and this permission notice shall be included
15in all copies or substantial portions of the Software.
16
17THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
20NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
21DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
22OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
23USE OR OTHER DEALINGS IN THE SOFTWARE.