NAME

Authen::Krb5::Effortless - This module is a subclass to Authen::Krb5, adding 'Effortless' ways to authenticate against a Kerberos Domain Controller.

VERSION

Version 0.02

Description

Authen::Krb5::Effortless is more then a 'Simple' module, as it supports both pass-phrase and key-tab based authorization.

Methods

new() - Initializes Authen::Krb5 and returns a Authen::Krb5::Effortless object.

fetch_TGT_KEYTAB() - Uses a keytab file to get a Kerberos credential.

fetch_TGT_PW() - Will use a password to get and cache a Kerberos credential.

clear_cache() - Will clear your local cache of all stored principals.

read_cache() - Will read your Kerberos cache and return the following values from the cache:

cache_present: returns 0 or 1 if the cache is present

starttime: epoch time when ticket is good from

authtime: epoch time when authentication occured

endtime: epoch time when the ticket expires

principal: name of the principal contained in the cache

EXAMPLES

A keytab example:

  use Authen::Krb5::Effortless;
  my $username  =  getlogin();                            
  my $keytab    =  "/path/to/my/keytab";
  my $krb5      =  Authen::Krb5::Effortless->new();
  $krb5->fetch_TGT_KEYTAB($keytab, $username);

A password example:

  use Authen::Krb5::Effortless;
  my $username = getlogin();
  my $krb5   = Authen::Krb5::Effortless->new();
  $krb5->fetch_TGT_PW('sekret_phss_wurd', $username);

A example for reading cache:

  use Authen::Krb5::Effortless;
  my $krb5  = Authen::Krb5::Effortless->new();
  $krb5->read_cache();
  if ($krb5->{'cache_present'}) { 
    print $krb5->{'principal'}, "\n";
  }

A example for deleting the cache:

  use Authen::Krb5::Effortless;
  my $krb5  = Authen::Krb5::Effortless->new();
  $krb5->clear_cache();

REQUIREMENETS

Authen::Krb5 needs to be installed for this module to work. In addition, because I'm using a pragma introduced with perl 5.10.1, I am requireing the use of perl 5.10.1 or newer.

AUTHOR

Adam Faris, <authen-krb5-effortless at mekanix dot org>

BUGS

Bugs are tracked at github. Please report any bugs to https://github.com/opsmekanix/Authen-Krb5-Effortless/issues

SUPPORT

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

    perldoc Authen::Krb5::Effortless

You can also look for information at:

• AnnoCPAN: Annotated CPAN documentation

  http://annocpan.org/dist/Authen-Krb5-Effortless

• CPAN Ratings

  http://cpanratings.perl.org/d/Authen-Krb5-Effortless

• Search CPAN

  http://search.cpan.org/dist/Authen-Krb5-Effortless/

ACKNOWLEDGEMENTS

I would like to acknowledge Jeff Horwitz, Doug MacEachern, Malcolm Beattie, and Scott Hutton for their work on Authen::Krb5.

LICENSE AND COPYRIGHT

Copyright 2013 Adam Faris.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

    L<http://www.apache.org/licenses/LICENSE-2.0>

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

cpanm Authen::Krb5::Effortless

perl -MCPAN -e shell
install Authen::Krb5::Effortless