# The ipv6calc Homepage

Peter Bieringer

    pb at bieringer dot de

2.0
2007-06-01
PB

## General

ipv6calc is a small utility written in programming languate C to manipulate (not only) IPv6 addresses. Intentions were convering a given IPv6 address into compressed format, convering a given IPv6 address into the same format like shown in /proc/net/if_inet6 and (because it was not difficulty) migrating the Perl program ip6_int into. Now only one utiltity is needed to do a lot.

This utility is also used to extend features on network-functions-ipv6 library, used by initscripts-ipv6.

Note: this tool got also its freshmeat / ipv6calc page (not maintained by the author)

Hint: take also a look at the Advanced Network Management Laboratory / IPv6 Address Oracle if you want to learn more about IPv6 addresses.

## License

The program is published under the GNU GPL version 2.

## Author

The author of ipv6calc is

- Dr. Peter Bieringer with some minor contribution by others

## Where to get sources or binaries

### Latest version of sources:

- Via CVS at DeepSpace6: DeepSpace6 / CVS instructions

- Via web interface to CVS at DeepSpace6: DeepSpace6 / CVS web interface

- Via FTP at DeepSpace6: DeepSpace6 / anonymous FTP

- Via FTP at ftp://ftp.bieringer.de/pub/linux/IPv6/ipv6calc/

### Available formats:

#### tar.gz

A SPEC file is included, so you can build a RPM from source tarball using

    $ rpmbuild -ta path/to/ipv6calc-$version.tar.gz

#### as RPM

Currently only on rpmfind / ipv6calc, but there are plans to publish at least source RPMS on DeepSpace6 some day.

### Ready to use packages for several operating systems:

#### Fedora

Fedora Core 6 is the current developing platform, so use given hints above to create a RPM. Fedora 7 includes this package by default.

#### Red Hat Enterprise Linux and clones

It's tested by the developer that creation of the RPM is working fine on RHEL4. RHEL5 includes this package by default.

#### Mandrake:

Linux Mandrake is very similar to Red Hat Linux, therefore a rebuild should work, too.

#### PLD:

See rpmfind / ipv6calc.

#### Debian GNU/Linux

Package is maintained, more information can be found at http://packages.debian.org/ipv6calc

#### NetBSD:

See here for more: http://www.netbsd.org/packages/net/ipv6calc/

#### FreeBSD:

See here for more: http://www.freebsd.org/cgi/cvsweb.cgi/ports/net/ipv6calc/ (http://www.freebsd.org/cgi/query-pr.cgi?pr=34441), http://www.freshports.org/net-mgmt/ipv6calc/

#### OpenBSD:

See here for more: http://www.openbsd.org/cgi-bin/cvsweb/ports/net/ipv6calc/

## Mailling Lists

### ipv6calc-announce

Reason:

  sending announcements of new versions

Traffic:

  very low

Postings:

  only moderators are allowed to post

Information:

  DeepSpace6 / maillist ipv6calc-announce

### ipv6calc

Reason:

  discussions

Traffic:

  low

Postings:

  subscribers

Information:

  DeepSpace6 / maillist ipv6calc

## Bug Reports

You can send bug reports to the author himself or subscribe to maillist “ipv6calc” and send it to the list.

## Features of ipv6calc

### Description

The main program named “ipv6calc” is able to recognice many (not only) IPv6 address formats and depending on a selectable action (not required) a selectable output format can be specified. Also it has the capability to show detailed information of an IPv4/IPv6 address or anonymize it.

### Examples

#### Conversion

A simple example is the conversion of an IPv6 address to a DNS PTR query string:

     ./ipv6calc --out revnibbles.arpa 2001:db8::1
    No input type specified, try autodetection...found type: ipv6addr
    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.

Like you see, input format was autodetected. And the given example can be extended because ipv6calc also understands netmask / prefix length values:

    $ ./ipv6calc -q --out revnibbles.arpa 2001:db8::1/64
    0.0.0.0.0.0.0.0.8.b.d.0.1.0.0.2.ip6.arpa.

Also you've also learnt now that switch '-q' (quiet) suppresses informational messages. You can use this now to start a DNS PTR query using:

    $ dig PTR `./ipv6calc -q --out revnibbles.arpa 2001:db8::1/64`

But ipv6calc can do many more for you! Next example shows you the extraction of the IPv4 address contained in a 6to4 IPv6 address:

    $ ./ipv6calc -q --action conv6to4 --in ipv6 2002:c0a8:fb61::1 --out ipv4
    192.168.251.97

This also works vice-versa:

    $ ./ipv6calc -q --action conv6to4 --in ipv4 192.168.251.97 --out ipv6
    2002:c0a8:fb61::

There are many more features already implemented, if you miss one, send a note.

#### Information

Information about a simple IPv6 address:

    $ ./ipv6calc -q -i 3ffe:ffff::210:a4ff:fe01:2345
    Address type: unicast, 6bone, global-unicast, productive
    Address type has SLA: 0000
    Registry for address: reserved
    Interface identifier: 0210:a4ff:fe01:2345
    EUI-48/MAC address: 00:10:a4:01:23:45
    MAC is a global unique one
    MAC is an unicast one
    OUI is: XIRCOM

Information about a Teredo IPv6 address:

    $ ./ipv6calc -q -i 3ffe:831f:ce49:7601:8000:efff:af4a:86BF
    Address type: unicast, 6bone, global-unicast, productive, teredo
    IPv4 address: 80.181.121.64
    IPv4 registry[80.181.121.64]: RIPENCC
    IPv4 address: 206.73.118.1
    IPv4 registry[206.73.118.1]: ARIN
    Address type is Teredo and included IPv4 server address is: 80.181.121.64 and client port: 4096
    IPv4 registry for Teredo server address: ARIN
    Registry for address: reserved

There exists also a machine readable output (e.g. used by 'ipv6calcweb.cgi') - in addition, here IP2Location and/or GeoIP information can be displayed, if databases are specified. Note that GeoIP currently still supports IPv4 only.

    $ ./ipv6calc -q -i -m --db-ip2location-ipv4 /usr/share/IP2Location/IP-COUNTRY-SAMPLE.BIN --db-ip2location-ipv6 /var/local/share/IP2Location/IPV6-COUNTRY.BIN --db-geoip /usr/share/GeoIP/GeoIP.dat  3ffe:831f:ce49:7601:8000:efff:af4a:86BF
    IPV6=3ffe:831f:ce49:7601:8000:efff:af4a:86bf
    TYPE=unicast,6bone,global-unicast,productive,teredo
    IPV4_SOURCE[80.181.121.64]=TEREDO-CLIENT
    IPV4[80.181.121.64]=80.181.121.64
    IPV4_REGISTRY[80.181.121.64]=RIPENCC
    IP2LOCATION_DATABASE_INFO_IPV4=url=http://www.ip2location.com date=2005-06-17 entries=20470 apiversion=2.1.3
    IP2LOCATION_COUNTRY_SHORT[80.181.121.64]=IT
    IP2LOCATION_COUNTRY_LONG[80.181.121.64]=ITALY
    IP2LOCATION_REGION[80.181.121.64]=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_CITY[80.181.121.64]=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_ISP[80.181.121.64]=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_LATITUDE[80.181.121.64]=0.000000
    IP2LOCATION_LONGITUDE[80.181.121.64]=0.000000
    IP2LOCATION_DOMAIN[80.181.121.64]=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_ZIPCODE[80.181.121.64]=This parameter is unavailable for selected data file. Please upgrade the data file.
    GEOIP_COUNTRY_SHORT[80.181.121.64]=IT
    GEOIP_COUNTRY_LONG[80.181.121.64]=Italy
    GEOIP_DATABASE_INFO=GEO-106FREE 20070201 Build 1 Copyright (c) 2007 MaxMind LLC All Rights Reserved apiversion=system
    IPV4_SOURCE[206.73.118.1]=TEREDO-SERVER
    IPV4[206.73.118.1]=206.73.118.1
    IPV4_REGISTRY[206.73.118.1]=ARIN
    IP2LOCATION_COUNTRY_SHORT[206.73.118.1]=??
    IP2LOCATION_COUNTRY_LONG[206.73.118.1]=This record is unavailable in demo version. Please subscribe.
    IP2LOCATION_REGION[206.73.118.1]=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_CITY[206.73.118.1]=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_ISP[206.73.118.1]=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_LATITUDE[206.73.118.1]=0.000000
    IP2LOCATION_LONGITUDE[206.73.118.1]=0.000000
    IP2LOCATION_DOMAIN[206.73.118.1]=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_ZIPCODE[206.73.118.1]=This parameter is unavailable for selected data file. Please upgrade the data file.
    GEOIP_COUNTRY_SHORT[206.73.118.1]=US
    GEOIP_COUNTRY_LONG[206.73.118.1]=United States
    TEREDO_PORT_CLIENT=4096
    IPV6_REGISTRY=reserved
    IP2LOCATION_DATABASE_INFO_IPV6=url=http://www.ip2location.com date=2007-05-26 entries=7495 apiversion=2.1.3
    IP2LOCATION_COUNTRY_SHORT=-
    IP2LOCATION_COUNTRY_LONG=-
    IP2LOCATION_REGION=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_CITY=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_ISP=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_LATITUDE=0.000000
    IP2LOCATION_LONGITUDE=0.000000
    IP2LOCATION_DOMAIN=This parameter is unavailable for selected data file. Please upgrade the data file.
    IP2LOCATION_ZIPCODE=This parameter is unavailable for selected data file. Please upgrade the data file.
    IPV6CALC_NAME=ipv6calc
    IPV6CALC_VERSION=0.70.1
    IPV6CALC_COPYRIGHT="(P) & (C) 2001-2007 by Peter Bieringer <pb (at) bieringer.de>"
    IPV6CALC_OUTPUT_VERSION=4

### Option style

Since version 0.40 new-style option handling was introduced, using

- --in <inputtype>

- --out <outputtype>

- --action <actiontype>

and many more conversions were added. A built-in check matrix should prevent misconversions.

Up to version 0.39, only old-style options (which perhaps - but it's not planned at the moment - are going obsolete sometimes the future) were available. They are one-in-all options, specifying input/action/output in one token. Internally this options will be converted into new-style options.

### Online help

Online help always shows the currently implemented features.

#### Main online help:

    $ ./ipv6calc -?
    ipv6calc: version 0.70.1
    (P) & (C) 2001-2007 by Peter Bieringer <pb (at) bieringer.de>

     General:
      [-d|--debug <debug value>] : debug value (bitwise like)
      [-q|--quiet]               : be more quiet

     Usage with new style options:
      [--in|-I <input type>]   : specify input  type
                                 (default: autodetect)
      [--out|-O <output type>] : specify output type
                                 (sometimes: autodetect)
      [--action|-A <action>]   : specify action
                                 (default: format conversion, sometimes: autodetect)
      [<format option> ...] : specify format options
      <input data> [...]    : input data

      Available input  types:  --in     -?|-h|--help
      Available output types:  --out    -?|-h|--help
      Available action types:  --action -?|-h|--help

     Other usage:
      --showinfo|-i [--machine_readable|-m] : show information about input data
      --showinfo|-i --show_types            : show available types on '-m'

      [--db-ip2location-ipv4 <file>] : IP2Location IPv4 database file (optional)
      [--db-ip2location-ipv6 <file>] : IP2Location IPv6 database file (optional)
      [--db-geoip <file>]            : GeoIP database file (optional)

     To see old-style option use: --printoldoptions

Input-type options

    ]$ ./ipv6calc --in -?
    ipv6calc: version 0.70.1
    (P) & (C) 2001-2007 by Peter Bieringer <pb (at) bieringer.de>

     Available input types:
      auto           : automatic detection
      revnibbles.int : dot separated nibbles reverse, ending with ip6.int.
      revnibbles.arpa: dot separated nibbles reverse, ending with ip6.arpa.
      bitstring      : bitstring labes, ending with ip6.arpa.
      ipv6addr       : IPv6 address
      ipv4addr       : IPv4 address
      ipv4hex        : IPv4 in hexdecimal format
      ipv4revhex     : IPv4 in byte-reversed hexdecimal format
      mac            : MAC address (48 bits)
      base85         : Base-85 string
      ifinet6        : Like line in /proc/net/if_inet6
      iid+token      : Interface identifier and token
      ipv6logconv    : ipv6logconv (currently not supported)
      prefix+mac     : IPv6 prefix and a MAC address

Output-type options:

    $ ./ipv6calc --out -?
    ipv6calc: version 0.70.1
    (P) & (C) 2001-2007 by Peter Bieringer <pb (at) bieringer.de>

     Available output types:
      revnibbles.int : dot separated nibbles reverse, ending with ip6.int.
      revnibbles.arpa: dot separated nibbles reverse, ending with ip6.arpa.
      bitstring      : bitstring labes, ending with ip6.arpa.
      ipv6addr       : IPv6 address
      ipv4addr       : IPv4 address
      mac            : MAC address (48 bits)
      eui64          : EUI-64 identifier (64 bits)
      base85         : Base-85 string
      ifinet6        : Like line in /proc/net/if_inet6
      iid            : Interface identifier
      iid+token      : Interface identifier and token
      addrtype       : Address type
      ouitype        : OUI (IEEE) type
      ipv6addrtype   : IPv6 address type
      any            : any type (currently not supported)
      revipv4        : reverse IPv4, ending with in-addr.arpa
      ipv4hex        : IPv4 in hexdecimal format
      octal          : IP address in escaped octal format
     For examples and available format options use:
        --out <type> --examples

Action-type options:

    $ ./ipv6calc --action -?
    ipv6calc: version 0.70.1

    (P) & (C) 2001-2007 by Peter Bieringer <pb (at) bieringer.de>
     Available action types:
      auto          : Automatic selection of action (default)
      geneui64      : Converts a MAC address to an EUI-64 address
      conv6to4      : Converts IPv4 address <-> 6to4 IPv6 address (prefix)
      genprivacyiid : Generates a privacy interface ID out of a given one and a token
      anonymize     : Anonymize IPv4/IPv6 address without loosing much information
      prefixmac2ipv6: Generates an IPv6 address out of a prefix and a MAC address

Because of historical issues, there exists also a support of the old-styled options:

    $ ./ipv6calc --printoldoptions
    ipv6calc: version 0.70.1
    (P) & (C) 2001-2007 by Peter Bieringer <pb (at) bieringer.de>

     Usage with old style (shortcut) options (going obsolete):
      <shortcut option> [<format option> ...] <input data> [...]
      --addr2ip6_int
      --addr_to_ip6int
      --addr2ip6_arpa
      --addr_to_ip6arpa
      --addr_to_bitstring
      --addr2compaddr
      --addr_to_compressed
      --addr2uncompaddr
      --addr_to_uncompressed
      --addr_to_base85
      --base85_to_addr
      --mac_to_eui64
      --addr2fulluncompaddr
      --addr_to_fulluncompressed
      --addr2if_inet6
      --addr_to_ifinet6
      --if_inet62addr
      --ifinet6_to_compressed
      --eui64_to_privacy
      --ipv4_to_6to4addr

## Webserver log conversion helper program "ipv6logconv"

This program parses address tokens of a given webserver logfile and converts them to special strings, useful for statistics (e.g. created by using "analog").

### Examples

A demonstration about which kind of statistics are possible to produce is shown at http://www.ipv6.bieringer.de/ (IPv6 only).

## Webserver log anonymization helper program "ipv6loganon"

On autoconfiguration, the interface part of an IPv6 address is based on the MAC address of the network interface card (NIC). This address is used for outgoing requests, if privacy option (RFC3041) is not enabled. This results in many privacy related information on web- or mail-server log files. Administrators, which won't (be allowed to) store such information over time, but still do not want to loose information about address type distribution should use 'ipv6loganon' to anonymize their log files.

### Anonymization details

The anonymizer would keep as much information as possible for IPv6 address types.

Client-side IID would be anonymized by

- UI-48 based: serial number would be zero'ed, keeping OID

- EUI-64 based: serial number would be zero'ed, keeping OID

- ISATAP: client IPv4 address would be anonymized by given IPv4 mask

- TEREDO: client IPv4 address would be anonymized by given IPv4 mask, client port would be zero'ed

- 6to4(Microsoft): client IPv4 address would be anonymized by given IPv4 mask

- local: whole IID would be zero'ed

Client-side SLA would be anonymized by

- SLA would be zero'ed

Prefix would be anonymized by

- 6to4: client IPv4 address would be anonymized by given IPv4 mask

Compat/Mapped IPv4 addresses would be anonymized by

- IPv4 address would be anonymized by given IPv4 mask

### Supported log file formats

Currently native supported log files:

- Apache log file format, 1st token is IPv4 or IPv6 address

There are plans to support also mail server log files sometimes in the future, but because of different formats, this would be probably done by a Perl program which parses the log file and a (cached) 'ip6calc' call with action 'anonymize'.

### Supported options

    $ ./ipv6loganon -?
    ipv6loganon: version 0.70.1
    (P) & (C) 2007 by Peter Bieringer <pb (at) bieringer.de>

    This program anonymizes IPv4/IPv6 addresses in HTTP server log files

     General:
      [-d|--debug <debug value>] : debug value (bitwise like)
      [-V|--verbose] : be verbose
      [-n|--nocache] : disable caching
      [-c|--cachelimit <value>] : set cache limit
                                   default: 20
                                   maximum: 200
     Output anonymization:
      --mask-ipv4 <bits>     : mask all IPv4 addresses [0-32], default 24
                                even if occurs in IPv6-IID
      --mask-ipv6 <bits>     : mask IPv6 prefix [0-64], default 48
                                only applied to related address types
      --no-mask-iid          : do not mask non-IPv4 based IPv6-IID
      --anonymize-standard   : preset for standard anonymization
      (default)                 mask-ipv4=24 mask-ipv6=48 mask-iid
      --anonymize-careful    : preset for careful anonymization
                                mask-ipv4=20 mask-ipv6=40 mask-iid
      --anonymize-paranoid   : preset for paranoid anonymization
                                mask-ipv4=16 mask-ipv6=32 mask-iid

     Takes data from stdin, outputs the processed data to stdout

### Usage

Currently, only offline conversion is supported. Implementation as pipe filter between Apache and 'cronolog' has been tested, but didn't work for unknown reason.

    $ cat /path/to/http_log | ./ipv6loganon >/path/to/http_log_anonymized

## Perl CGI wrapper program "ipv6calcweb.cgi"

Because calling C programs directly as CGI isn't really recommended (too much security troubles all the time), I wrote a small wrapper utility which calls "ipv6calc" to get information about client and server address for displaying on a web page.

### Examples

A demonstration about which kind of output is possible to produce is shown at

- http://www.ipv6.bieringer.de/ (IPv6 only)

- http://ipv6.aerasec.de/index2.html (IPv4/IPv6)

- http://www.sixxs.net/tools/ipv6calc/ (IPv4/IPv6)

- http://ipv6-info.internet2.edu/

## Webserver log statistics helper program "ipv6logstats"

This program parses a given webserver logfile and count addresses, useful for time period statistics.

### Supported options

    $ ./ipv6logstats -?
    ipv6logstats: version 0.70.1
    (P) & (C) 2003-2005 by Peter Bieringer <pb (at) bieringer.de>

     General:
      [-d|--debug <debug value>] : debug value (bitwise like)
      [-u|--unknown]             : print unknown IP addresses to stderr
      [-c|--colums]              : print statistics in colums
      [-n|--noheader]            : don't print header in colums mode
      [-o|--onlyheader]          : print only header in colums mode
      [-p|--prefix <token>]      : print token as prefix

     Takes http log data from stdin and print a table on output

### Usage

There are a README and some helper scripts available in the package how to use this program and how to generate a graph using Gnuplot.

### Examples

A demonstration with real data is available at http://mirrors.bieringer.de/stats/timeline.html.