eac54dbcbf03e49b0106511a990c4a2e1dba92bc
[itkacl] / README
1 README for ITKACL
2
3 ITKACL is an authorization system. It is intended to solve the problem where you have
4 an identification system (e.g. UNIX passwd files or LDAP) and an authentication system
5 (e.g. Kerberos) going, but not all valid users are to have access to all systems.
6
7 ITKACL is designed to be lightweight and easily integratable into your own systems.
8 At Studentersamfundet i Trondhjem (the student society of Trondheim), where ITKACL
9 was developed, we use Kerberos+ITKACL to control access to well over fifty different
10 services (most of them web-based).
11
12 Although the master record for your ACLs is a PostgreSQL database, the core library
13 does its checking by querying a precomputed user/service database stored in DNS.
14 This yields a very high degree of infrastructure reuse, enabling very fast
15 lookups, well-tested replication, and secure integrity checking (through DNSSEC).
16 ITKACL scales up to at least thousands of users and hundreds of different ACLs;
17 probably much further.
18
19 The ITKACL distribution is currently a bit raw, since it is extracted from various
20 software packages written more or less independently over the course of ten years.
21 However, ITKACL is not complex or very hard to set up. Included is a web interface
22 for adminstering ACLs, a C library for checking (using libunbound to do the actual
23 DNS lookups and DNSSEC validation), bindings for several languages (Perl, Python,
24 PHP), and authorization modules for Apache and PAM. Everything can be built as
25 Debian packages, or you can go the way of make + make install for each package.
26
27 To get started, the first thing you want to do is probably to set up the database
28 and the web interface; see the itkacl-web-1.0 directory. After that, compile the
29 core library from itkacl-2.1, and adjust the example /etc/itkacl.conf.
30 You also want to set up your DNS zone, set up DNS keys for dynamic updating,
31 and run the DNS sync job (also from itkacl-2.1) for the first time.
32
33 After this, you are ready to authorize your services using ITKACL! Here's an example
34 for how to limit access to a web site in Apache using Kerberos and ITKACL:
35
36   AuthType Kerberos
37   KrbAuthRealms SAMFUNDET.NO
38   Krb5Keytab /etc/apache2/krb5/amsit.keytab
39   AuthName "AMSIT, Serveringsgjengen"
40   require itkacl /web/amsit/sg
41
42 Remember SSL, so that the password is not sent in clear text.
43
44 The PAM module can be used like this (together with pam_unix.so, for instance):
45
46   account required pam_itkacl.so realm='/login/itk-workstations'
47
48 The programming interfaces should be pretty self-explanatory. However, do note
49 that the return values are not the same in every language; for instance, since
50 scripting languages typically communicate fatal errors through exceptions,
51 they will typically throw such an exception on an error, instead of just returning
52 -1. Also, since success in e.g. Perl is typically specified using true instead
53 of 0, the return value is different from the C convention.
54
55 ITKACL is Copyright 2004-2013 Steinar H. Gunderson, and is licensed under the
56 GNU General Public License, version 2. See the included COPYING file for the
57 full license text.