NAME

Dancer2::Plugin::Auth::Extensible::Provider::ActiveDirectory - ActiveDirectory authentication provider for Dancer2::Plugin::Auth::Extensible

DESCRIPTION

This class is an ActiveDirectory authentication provider.

See Dancer2::Plugin::Auth::Extensible for details on how to use the authentication framework.

ATTRIBUTES

host

The ActiveDirectory host name or IP address passed to Auth::ActiveDirectory.

Required.

port

The ActiveDirectory port. Defaults to 389.

timeout

Connection timeout in seconds. Defaults to 60.

domain

The ActiveDirectory domain.

Required.

principal

The ActiveDirectory principal.

Required.

allowed_groups

List of groups allowed to login. If empty, all groups are allowed.

METHODS

authenticate_user $username, $password

Returns true if the user could be authenticated. Returns also false if the user could be authenticated, but is member of any allowed group.

get_user_details $username

get_user_roles

PRIVATE METHODS

_active_directory

Returns a connected Auth::ActiveDirectory object.

_user_cache $username [, $value]

Implements the user data cache. As we can only receive the user information from Auth::ActiveDirectory when authenticating, we save it in the cache and can use it when asked via the get_user_details or get_user_roles methods.

TODO

I was not able to create useful tests for this module. I tried to adopt the tests from Dancer2::Plugin::Auth::Extensible::Provider::LDAP, but I was not able to fill the mock object with the correct data for the Test App to work. Please tell me if you can help out.

AUTHOR

Dominic Sonntag, <dsonntag at cpan.org>

BUGS

Please report any bugs or feature requests to bug-dancer2-plugin-auth-extensible-provider-activedirectory at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dancer2-Plugin-Auth-Extensible-Provider-ActiveDirectory. 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 Dancer2::Plugin::Auth::Extensible::Provider::ActiveDirectory

If you want to contribute to this module, write me an email or create a Pull request on Github: https://github.com/sonntagd/Dancer2-Plugin-Auth-Extensible-Provider-ActiveDirectory

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2016 Dominic Sonntag.

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.