The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Dancer2-Plugin-Auth-ActiveDirectory-0.03
River stage zero No dependents
++
/ Dancer2::Plugin::Auth::ActiveDirectory

NAME

Dancer2::Plugin::Auth::ActiveDirectory - Dancer2 plugin for MS ActiveDirectory

VERSION

Version 0.03

PRIVATE METHODS

_load_settings

Load plugin settings from environment.

_in_list

Simple list in list comparision sub.

_rights

Get defined rights from environment

_connect_to_ad

Creates a new Auth::ActiveDirectory object including ldap connection to AD server.

_rights_by_user_groups

Returns a hashref with the possible rights. Based on the AD groups where the user is included.

_rights_by_user_groups

Returns a hashref with the possible rights. Based on the AD groups where the user is included.

SYNOPSIS

Configuration:

    plugins:
      Auth::ActiveDirectory:
        host: 0.0.0.0
        principal: yourprincpal
        domain: somedomain
        rights:
          definedright1: ad-group
          definedright2: ad-group
          definedright3: another-ad-group
          definedright4: another-ad-group

Code:

    post '/login' => sub {
        session 'user' => authenticate( params->{user}, params->{pass} );
        return template 'index', { html_error => 'Authentication failed!!' }
            unless ( session('user') );
        return template 'index', { html_error => 'No right for this page!!' }
            if( !has_right( session('user'), 'definedright1') );
        template 'index', { loggedin => 1 };
    };

SUBROUTINES/METHODS

authenticate

Basicaly the subroutine for authentication in the ActiveDirectory

authenticate_config

Subroutine to get configuration for ActiveDirectory

has_right

Check if loged in user has one of the configured rights

list_users

rights

Subroutine to get configurated rights

rights_by_user

Subroutine to get configurated rights

for_versions

AUTHOR

Mario Zieschang, <mziescha at cpan.org>

BUGS

Please report any bugs or feature requests to bug-Dancer2-Plugin-Auth-ActiveDirectory at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dancer2-Plugin-Auth-ActiveDirectory. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

MOTIVATION

I started to write this module for an internal application based on Dancer2. The authentication should be from our AD servers ( don't ask... ), the result ist this Module and Auth::ActiveDirectory.

SUPPORT

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

    perldoc Dancer2::Plugin::Auth::ActiveDirectory

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2015 Mario Zieschang.

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.