NAME
    Data::Validate::IP - ip validation methods

SYNOPSIS
      use Data::Validate::IP qw(is_ipv4);
  
      if(is_ipv4($suspect)){
            print "Looks like an ip address";
      } else {
            print "Not an ip address\n";
      }
  
      # or as an object
      my $v = Data::Validate::IP->new();
  
      die "not an ip" unless ($v->is_ipv4('domain.com'));

DESCRIPTION
    This module collects ip validation routines to make input validation,
    and untainting easier and more readable.

    All functions return an untainted value if the test passes, and undef if
    it fails. This means that you should always check for a defined status
    explicitly. Don't assume the return will be true. (e.g.
    is_username('0'))

    The value to test is always the first (and often only) argument.

FUNCTIONS
    new - constructor for OO usage
          $obj = Data::Validate::IP->new();

        *Description*
            Returns a Data::Validator::IP object. This lets you access all
            the validator function calls as methods without importing them
            into your namespace or using the clumsy
            Data::Validate::IP::function_name() format.

        *Arguments*
            None

        *Returns*
            Returns a Data::Validate::IP object

    is_ipv4 - does the value look like an ip v4 address?
          is_ipv4($value);
          or
          $obj->is_ipv4($value);

        *Description*
            Returns the untainted ip address if the test value appears to be
            a well-formed ip address.

        *Arguments*

            $value
                The potential ip to test.

        *Returns*
            Returns the untainted ip on success, undef on failure.

        *Notes, Exceptions, & Bugs*
            The function does not make any attempt to check whether an ip
            actually exists. It only looks to see that the format is
            appropriate.

    is_private_ipv4 - is it a valid private ipv4 address
          is_private_ipv4($value);
          or
          $obj->is_private_ipv4($value);

        *Description*
            Returns the untainted ip address if the test value appears to be
            a well-formed private ip address.

        *Arguments*

            $value
                The potential ip to test.

        *Returns*
            Returns the untainted ip on success, undef on failure.

        *Notes, Exceptions, & Bugs*
            The function does not make any attempt to check whether an ip
            actually exists.

        *From RFC 3330*
               10.0.0.0/8 - This block is set aside for use in private networks.
               Its intended use is documented in [RFC1918].  Addresses within this
               block should not appear on the public Internet.

               172.16.0.0/12 - This block is set aside for use in private networks.
               Its intended use is documented in [RFC1918].  Addresses within this
               block should not appear on the public Internet.

               192.168.0.0/16 - This block is set aside for use in private networks.
               Its intended use is documented in [RFC1918].  Addresses within this
               block should not appear on the public Internet.

    is_loopback_ipv4 - is it a valid loopback ipv4 address
          is_loopback_ipv4($value);
          or
          $obj->is_loopback_ipv4($value);

        *Description*
            Returns the untainted ip address if the test value appears to be
            a well-formed loopback ip address.

        *Arguments*

            $value
                The potential ip to test.

        *Returns*
            Returns the untainted ip on success, undef on failure.

        *Notes, Exceptions, & Bugs*
            The function does not make any attempt to check whether an ip
            actually exists.

        *From RFC 3330*
               127.0.0.0/8 - This block is assigned for use as the Internet host
               loopback address.  A datagram sent by a higher level protocol to an
               address anywhere within this block should loop back inside the host.
               This is ordinarily implemented using only 127.0.0.1/32 for loopback,
               but no addresses within this block should ever appear on any network
               anywhere [RFC1700, page 5].

    is_testnet_ipv4 - is it a valid testnet ipv4 address
          is_testnet_ipv4($value);
          or
          $obj->is_testnet_ipv4($value);

        *Description*
            Returns the untainted ip address if the test value appears to be
            a well-formed testnet ip address.

        *Arguments*

            $value
                The potential ip to test.

        *Returns*
            Returns the untainted ip on success, undef on failure.

        *Notes, Exceptions, & Bugs*
            The function does not make any attempt to check whether an ip
            actually exists.

        *From RFC 3330*
               192.0.2.0/24 - This block is assigned as "TEST-NET" for use in
               documentation and example code.  It is often used in conjunction with
               domain names example.com or example.net in vendor and protocol
               documentation.  Addresses within this block should not appear on the
               public Internet.

    is_public_ipv4 - is it a valid public ipv4 address
          is_public_ipv4($value);
          or
          $obj->is_public_ipv4($value);

        *Description*
            Returns the untainted ip address if the test value appears to be
            a well-formed public ip address.

        *Arguments*

            $value
                The potential ip to test.

        *Returns*
            Returns the untainted ip on success, undef on failure.

        *Notes, Exceptions, & Bugs*
            The function does not make any attempt to check whether an ip
            actually exists or could truly route. This is true for any non-
            private/testnet/loopback ip.

SEE ALSO
    <b>[RFC 3330] [RFC 1918] [RFC 1700]</b>

    Data::Validate(3)

TODO
    Add in support for verifying IPv6 addresses.

AUTHOR
    Neil Neely <neil@frii.net>.

ACKNOWLEDGEMENTS
    Thanks to Richard Sonnen <sonnen@richardsonnen.com> for writing the
    Data::Validate module.

COPYRIGHT AND LICENSE
    Copyright (c) 2005 Neil Neely.

    This library is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself, either Perl version 5.8.2 or, at
    your option, any later version of Perl 5 you may have available.

