README.txt 2.47 KB
Newer Older
Guido Günther's avatar
Guido Günther committed
1 2 3
=========================================================
PyKerberos Package

4
Copyright (c) 2006-2013 Apple Inc. All rights reserved.
Guido Günther's avatar
Guido Günther committed
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

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

    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.

=========================================================

This Python package is a high-level wrapper for Kerberos (GSSAPI) operations.
The goal is to avoid having to build a module that wraps the entire Kerberos.framework,
and instead offer a limited set of functions that do what is needed for client/server
Kerberos authentication based on <http://www.ietf.org/rfc/rfc4559.txt>.

25
Much of the C-code here is adapted from Apache's mod_auth_kerb-5.0rc7.
Guido Günther's avatar
Guido Günther committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50

========
CONTENTS
========

    src/               : directory in which C source code resides.
    setup.py           : Python distutils extension build script.
    config/            : directory of useful Kerberos config files.
      edu.mit.Kerberos : example Kerberos .ini file.
    README.txt         : this file!
    kerberos.py        : Python api documentation/stub implementation.

=====
BUILD
=====

In this directory, run:

    python setup.py build

=======
TESTING
=======

You must have a valid Kerberos setup on the test machine and you should ensure that you have valid
51
Kerberos tickets for any client authentication being done (run 'klist' on the command line).
Guido Günther's avatar
Guido Günther committed
52 53
Additionally, for the server: it must have been configured as a valid Kerberos service with the Kerbersos server
for its realm - this usually requires running kadmin on the server machine to add the principal and generate a keytab
54
entry for it (run 'sudo klist -k' to see the currently available keytab entries).
Guido Günther's avatar
Guido Günther committed
55 56 57 58 59 60 61 62

Make sure that PYTHONPATH includes the appropriate build/lib.xxxx directory.
Then run test.py with suitable command line arguments:

    python test.py -u userid -p password -s service
    
    -u : user id for basic authenticate
    -p : password for basic authenticate
63
    -s : service principal for GSSAPI authentication (defaults to 'http@host.example.com')
Guido Günther's avatar
Guido Günther committed
64 65 66 67 68 69

===========
Python APIs
===========

See kerberos.py.