File Coverage

blib/lib/Auth/ActiveDirectory.pm

Criterion	Covered	Total	%
statement	63	77	81.8
branch	21	32	65.6
condition	2	4	50.0
subroutine	19	21	90.4
pod	10	10	100.0
total	115	144	79.8

package Auth::ActiveDirectory;

=head1 NAME

Auth::ActiveDirectory - Authentication module for MS ActiveDirectory

=head1 VERSION

Version 0.01

=cut

our $VERSION = '0.01';

use strict;
use warnings FATAL => 'all';
use Carp qw/cluck/;
use Net::LDAP qw[];
use Net::LDAP::Constant qw[LDAP_INVALID_CREDENTIALS];
my $ErrorCodes = {
    '525' => { error => 'user not found' },
    '52e' => { error => 'invalid credentials' },
    '530' => { error => 'not permitted to logon at this time' },
    '531' => { error => 'not permitted to logon at this workstation' },
    '532' => { error => 'password expired' },
    '533' => { error => 'data 533' },
    '701' => { error => 'account expired' },
    '773' => { error => 'user must reset password' },
    '775' => { error => 'user account locked' },
    '534' => {
        error       => 'account disabled',
        description => 'The user has not been granted the requested logon type at this machine'
    },
};

=head1 SUBROUTINES/METHODS

=cut

{

=head2 _ad2unixtimestamp

This value represents the number of 100-nanosecond intervals since January 1, 1601 (UTC).
https://msdn.microsoft.com

ad_timestamp / nanoseconds - offset to 1601

=cut

    sub _ad2unixtimestamp { $_[0] / 10000000 - 11644473600 }

=head2 _create_connection

=cut

    sub _create_connection {
        my ( $host, $port, $timeout ) = @_;
        return Net::LDAP->new( $host, port => $port || 389, timeout => $timeout || 60 ) || sub {
            cluck(qq/Failed to connect to '$host'. Reason: '$@'/);
            return undef;
        };
    }

=head2 _v_is_error

=cut

    sub _v_is_error {
        my ( $message, $s_user ) = @_;
        return 0 if ( !$message->is_error );
        my $error = $message->error;
        my $level = $message->code == LDAP_INVALID_CREDENTIALS ? 'debug' : 'error';
        cluck(qq/Failed to authenticate user '$s_user'. Reason: '$error'/);
        return 1;
    }

=head2 _parse_error_message

=cut

    sub _parse_error_message {
        my ($message)   = @_;
        my ($errorcode) = $message->{errorMessage} =~ m/(?:data\s(.*)),/;
        return $ErrorCodes->{$errorcode};
    }

=head2 _search_users

=cut

    sub _search_users {
        my ( $self, $filter ) = @_;
        return $self->ldap->search( base => $self->base, filter => $filter );
    }

}

=head2 new

Constructor

=cut

sub new {
    my $class = shift;
    my $self  = {@_};
    bless $self, $class;
    $self->{base} = qq/dc=$self->{domain},dc=$self->{principal}/ unless $self->{base};
    $self->{ldap} = _create_connection( $self->{host}, $self->{port}, $self->{timeout} ) unless $self->{ldap};
    return $self;
}

=head2 authenticate

Basicaly the subroutine for authentication in the ActiveDirectory

=cut

sub authenticate {
    my ( $self, $username, $password ) = @_;
    return undef unless $self->ldap;
    my $user = sprintf( '%s@%s', $username, $self->domain );
    my $message = $self->ldap->bind( $user, password => $password );
    return _parse_error_message($message) if ( _v_is_error( $message, $user ) );
    my $result = $self->_search_users( qq/(&(objectClass=person)(userPrincipalName=$user./ . $self->principal . '))' );
    foreach ( $result->entries ) {
        require Auth::ActiveDirectory::Group;
        require Auth::ActiveDirectory::User;
        return Auth::ActiveDirectory::User->new(
            uid               => $username,
            user              => $user,
            firstname         => $_->get_value(q/givenName/),
            surname           => $_->get_value(q/sn/),
            display_name      => $_->get_value(q/displayName/),
            mail              => $_->get_value(q/mail/),
            last_password_set => _ad2unixtimestamp( $_->get_value('pwdLastSet') ),

            # A value of 0 or 0x7FFFFFFFFFFFFFFF (9223372036854775807) indicates that the account never expires.
            # https://msdn.microsoft.com/en-us/library/ms675098(v=vs.85).aspx
            account_expires => ( $_->get_value('accountExpires') != 9223372036854775807 ) ? _ad2unixtimestamp( $_->get_value('accountExpires') ) : undef,
            groups => [ map { m/^CN=(.*),OU=.*$/ ? Auth::ActiveDirectory::Group->new( name => $1 ) : () } $_->get_value(q/memberOf/) ],

        );
    }
    return undef;
}

=head2 list_users

=cut

sub list_users {
    my ( $self, $user, $password, $search_string ) = @_;
    my $connection = $self->ldap || return undef;
    my $message = $connection->bind( $user, password => $password );
    return undef if ( _v_is_error( $message, $user ) );
    my $result = $self->_search_users(qq/(&(objectClass=person)(name=$search_string*))/);
    return [ map { Auth::ActiveDirectory::User->new( name => $_->get_value(q/name/), uid => $_->get_value(q/sAMAccountName/) ) } $result->entries ];
}

=head2 host

Getter/Setter for internal hash key host.

=cut

sub host {
    return $_[0]->{host} unless $_[1];
    $_[0]->{host} = $_[1];
    return $_[0]->{host};
}

=head2 port

Getter/Setter for internal hash key port.

=cut

sub port {
    return $_[0]->{port} unless $_[1];
    $_[0]->{port} = $_[1];
    return $_[0]->{port};
}

=head2 timeout

Getter/Setter for internal hash key timeout.

=cut

sub timeout {
    return $_[0]->{timeout} unless $_[1];
    $_[0]->{timeout} = $_[1];
    return $_[0]->{timeout};
}

=head2 domain

Getter/Setter for internal hash key domain.

=cut

sub domain {
    return $_[0]->{domain} unless $_[1];
    $_[0]->{domain} = $_[1];
    return $_[0]->{domain};
}

=head2 principal

Getter/Setter for internal hash key principal.

=cut

sub principal {
    return $_[0]->{principal} unless $_[1];
    $_[0]->{principal} = $_[1];
    return $_[0]->{principal};
}

=head2 ldap

Getter/Setter for internal hash key ldap.

=cut

sub ldap {
    return $_[0]->{ldap} unless $_[1];
    $_[0]->{ldap} = $_[1];
    return $_[0]->{ldap};
}

=head2 base

Getter/Setter for internal hash key base.

=cut

sub base {
    return $_[0]->{base} unless $_[1];
    $_[0]->{base} = $_[1];
    return $_[0]->{base};
}

1;    # Auth::ActiveDirectory

__END__