README
1Authen::Krb5::Simple version 0.42
2===============================================================================
3
4The Authen::Krb5::Simple module provides a means to authenticate a
5user/password using Kerberose 5. Simply use this module and call its
6authenticate function with a username (or user@KRB_REALM) and a password.
7
8Detailed usage information can be found in the module's perldoc.
9
10INSTALLATION
11
12To install this module edit the CONFIG file to set test kerberos realm,
13username and password. These are optional. If either the username or
14password is not given, then the user auth tests will be skipped. If a
15realm is specified, it will be used for the test. Otherwise, the default
16realm for the system will be used (if properly configured of course).
17
18You can also specify a location of the Kerberos include and libs directories
19in the environment variables KRB5_INCLUDE and KRB5_LIB respectively. Setting
20these will cause the build to try them first. This would normally be used
21if your Kerberos libraries are in a non-standard location, or you wanted to
22overide the system defaults.
23
24Once that is done, then type the following:
25
26 perl Makefile.PL
27 make
28 make test
29 make install
30
31Note: In the absence of the KRB5_INCLUDE and KRB4LIB environment variables
32 mentioned above, the module will make an attempt to try and find
33 out the location of the Kerberos 5 include and lib files.
34
35 If you continue to get "Can't build and link to 'xxx'" errors from
36 the "perl Makefile.PL" command. you can try setting the skip_lib_check
37 environment variable to skip the lib check (this was necessary on some
38 FreeBSD systems that had conflicting libkrb5.so files). For example:
39
40 skip_lib_check=1 perl Makefile.PL
41
42 If that doesn't work, you will need to manually override by setting
43 the environment variables (if not already set) or editing Makfile.PL
44 to directly.
45
46DEPENDENCIES
47
48This module requires the Kerberos 5 header and library files installed
49on the local system.
50
51-------------------------------------------------------------------------------
52
53COPYRIGHT AND LICENCE
54
55Copyright (c) 2003-2009 Damien S. Stuart. All rights reserved.
56 This program is free software; you can redistribute it and/or modify it
57 under the same terms as Perl itself.
58
59