The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Net-Address-IP-Cipher-0.6
River stage zero No dependents
1 ++
/ Net::Address::IP::Cipher

NAME

Net::Address::IP::Cipher - IPv6 / IPv4 address encryption to a valid address, for pseudo anonymization.

VERSION

Version 0.6

SYNOPSIS

Net::Address::IP::Cipher encrypts and decrypts IPv6 and IPv4 addresses to another valid IPv6/v4 address, using a secret key, in a way that's impossible to guess the original IP without the key.

    use Net::Address::IP::Cipher;

    my $ipcipher = Net::Address::IP::Cipher->new(
        password => 'super secret'
    );
    my $enc = $ipcipher->enc('::1');
    print $enc; # 3a3e:7137:6e36:5ecd:4d31:e516:cf47:ec1b

It's intended use is to pseudo-anonymize IPs from logs, packet captures, and other analysis. By this way you benefit of having still valid IP addresses and be able to group streams of several messagess, but without revealing the source.

This module implements in native perl language the "ipcipher" specification from: https://github.com/PowerDNS/ipcipher

PREREQUISITES

This module requires Net::IP for v6/v4 handling and CryptX for all crypto stuff (Crypt::KeyDerivation, Crypt::Cipher::AES).

METHODS

new

Creates a new Net::Address::IP::Cipher object. You must indicate the secret key for encryption/decryption:

  my $ipcipher = Net::Address::IP::Cipher->new(password => 'super secret');

The key should be declared in either one of two formats:

  password => 'super secret'

for any string used as a password, or

  barekey => 'bb8dcd7be9a6f43b3304c640d7d7103c'

for an hexadecimal representation of a 128-bit key.

If you provide both, just the 'password' format will be used.

enc

Receive an IPv6 or IPv4 string address, in any valid format for Net::IP, and returns the encrypted version as string.

    my $enc = $ipcipher->enc('::1');
    print $enc;  # b733:fb7:c957:82fc:3d67:e7c3:a667:28da

dec

Receive and IPv6 or IPv4 string address in its encrypted version, and returns the decrypted IP string.

    my $dec = $ipcipher->dec('b733:fb7:c957:82fc:3d67:e7c3:a667:28da');
    print $dec;  # ::1

AUTHOR

Hugo Salgado, <hsalgado at vulcano.cl>

BUGS

Please report any bugs or feature requests through the web interface at https://github.com/huguei/p5-Net-Address-IP-Cipher/issues. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Net::Address::IP::Cipher

You can also look for information at:

REPOSITORY

https://github.com/huguei/p5-Net-Address-IP-Cipher

ACKNOWLEDGEMENTS

The v4 version is based on the original ipcrypt python version from Jean-Philippe Aumasson: https://github.com/veorq/ipcrypt

LICENSE AND COPYRIGHT

Copyright 2023 Hugo Salgado.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.