NAME

Catalyst::Plugin::EncryptID - Obfuscate IDs/string in URLs

VERSION

Version 0.01

DESCRIPTION

This module makes easy to obfuscate internal IDs when using them in a URL given to users. Instead of seeing http://example.com/item/42 users will see http://example.com/item/c98ea08a8e8ad715 . This will prevent nosy users from trying to iterate all items based on a simple ID in the URL.

CONFIGURATION

Configuration requires a secret key at a minimum.

Or set the secret key at run time, with:

    BEGIN {
                TestApp->config(
                        name    => 'TestApp',
                        EncryptID => {
                                secret => 'abc123xyz',
                                padding_character => '!'
                        }
                );
    }

SYNOPSIS

        package TestApp;

        use strict;
        use warnings;

        use Catalyst qw/EncryptID/;

        TestApp->config(
                name    => 'TestApp',
                EncryptID => {
                        secret => 'abc123xyz',
                        padding_character => '!'
                }
        );

        1;

In Controller

        package TestApp::Controller::Root;
        use base 'Catalyst::Controller';

        __PACKAGE__->config->{namespace} = '';

        sub index : Private {
            my ( $self, $c ) = @_;
            $c->res->body('root index');
        }

        sub encrypt : Global Args(1) {
            my ( $self, $c, $id ) = @_;
            my $encripted_hash = $c->encrypt_data($id);
            ...
        }

        sub decrypt : Global Args(1) {
            my ( $self, $c, $hashid ) = @_;
            my $decrypted_string = $c->decrypt_data($hashid);
            ...
        }

        sub validhash : Global Args(1) {
            my ( $self, $c, $hashid ) = @_;
            my $status = $c->is_valid_encrypt_hash($hashid);
            ...
        }

        1;

EXPORT

A list of functions that can be exported. You can delete this section if you don't export anything, such as for a purely object-oriented module.

SUBROUTINES/METHODS

encrypt_data

encrypt_data(ID [,PREFIX]) - Encrypt the given ID, returns the encoded hash value. If "PREFIX" is given, it will be added to the ID before encoding. It can be used when decoding to verify the decoded value is valid.

decrypt_data

decrypt_data(ID) - Decrypt the given ID, returns the original (text) ID value.

is_valid_encrypt_hash

is_valid_encrypt_hash(HASH) - Return true if given encrypt has is valid

AUTHOR

Rakesh Kumar Shardiwal, <rakesh.shardiwal at gmail.com>

BUGS

Please report any bugs or feature requests to bug-catalyst-plugin-encryptid at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-Plugin-EncryptID. 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 Catalyst::Plugin::EncryptID

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2016 Rakesh Kumar Shardiwal.

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.