Initial release, version 0.0.0.
[gsasl.git] / README
blob4409ea18906c88f0f06dd61e3004ea7c69aed88c
1 This directory holds the library `libgsasl', which implement the
2 Simple Authentication and Security Layer (SASL), and an application
3 `gsasl' for interfacing with the library from the command line.
5 Libgsasl is unstable and in its early steps of development.  You
6 should expect it to not work as well as having security problems.
7 Currently there is some support for the following mechanisms:
9   - CRAM-MD5 (RFC 2195, requires libgcrypt)
10   - EXTERNAL (RFC 2222)
11   - GSSAPI (RFC 2222, client only, requires MIT Kerberos 5 GSSAPI library)
12   - ANONYMOUS (RFC 2245)
13   - PLAIN (RFC 2595)
14   - SECURID (RFC 2808)
15   - DIGEST-MD5 (RFC 2831, requires libgcrypt)
16   - LOGIN (non-standard)
17   - NTLM (non-standard, client only, requires libntlm)
19 You probably need GNU make to build libgsasl (i.e., it sometimes work
20 with other make tools but not reliably).  Libgsasl has at some point
21 in time built on the following systems, but no guarantees.
23   - alphaev67-dec-osf5.0 (Tru64 UNIX C, GNU make)
24   - i686-pc-linux-gnu (Debian unstable)
25   - i686-pc-linux-gnu (RedHat 7.2)
26   - mips-sgi-irix6.5 (MIPS C compiler, GNU make)
27   - rs6000-ibm-aix4.3.2.0 (GCC 2.9-aix43-000718, GNU make)
28   - rs6000-ibm-aix4.3.2.0 (IBM C for AIX compiler, GNU make)
29   - sparc-sun-solaris2.6 (Sun WorkShop Compiler C 5.0, non-GNU make)
31 Things left to do below.  If you like to start working on anything,
32 please let me know so work duplication can be avoided.
34   * Encryption/integrity layers (gsasl_encode() and gsasl_decode())
35   * Authentication infrastructure implementing the callbacks for
36          PAM, Kerberos, SQL, etc.  Separate project?
37   + Port applications to use libgsasl
38   + More SASL mechanisms
39   - Improve documentation
40   - Port to Cyclone?
42 The library (lib/) is licensed under the GNU Lesser Public License
43 license (see COPYING.LIB), the application (src/) is licensed under
44 the GNU Public License (see COPYING), and the documentation (doc/) is
45 licensed under the GNU Free Documentation License (see COPYING.DOC).
47 For mailing list information and archives, and other updates to the
48 project, see <URL:http://josefsson.org/libgsasl/>.
50 Send all bug reports by electronic mail to bug-libgsasl@josefsson.org.