Update gnulib files.
[gsasl.git] / README
blob228bb365dd828037ea77110001769457892139ff
1 GNU SASL README -- Important introductory notes.
2 Copyright (C) 2002, 2003, 2004, 2005, 2007 Simon Josefsson
3 See the end for copying conditions.
5 This directory holds GNU SASL which is an implementation of the Simple
6 Authentication and Security Layer (SASL).  See doc/gsasl.{info,ps,pdf}
7 for the manual.
9 The GNU SASL library is licensed under the GNU Lesser General Public
10 License (LGPL) version 2.1.  See the file lib/COPYING.  The GNU
11 project typically uses the GNU General Public License (GPL) for
12 libraries, and not the LGPL, but for this project we decided that we
13 would get more help from the community if we used the LGPL, as other
14 free SASL implementations exists.  See also
15 <http://www.gnu.org/licenses/why-not-lgpl.html>.
17 The command-line application and test suite (src/, and tests/) are
18 licensed under the GNU General Public License license version 3.0.
19 See the file COPYING.
21 The documentation (doc/) is licensed under the GNU Free Documentation
22 License.
24 If you need help to use GNU SASL, or wish to help others, you are
25 invited to join our mailing list help-gsasl@gnu.org, see
26 <http://lists.gnu.org/mailman/listinfo/help-gsasl>.
28 Currently there is some support for the following mechanisms:
30   - CRAM-MD5 (RFC 2195)
31   - EXTERNAL (RFC 2222)
32   - GSSAPI (RFC 2222, requires GSS, Heimdal or MIT Kerberos)
33   - ANONYMOUS (RFC 2245)
34   - PLAIN (RFC 2595)
35   - SECURID (RFC 2808)
36   - DIGEST-MD5 (RFC 2831)
37   - LOGIN (non-standard)
38   - NTLM (non-standard, client only, requires Libntlm)
39   - KERBEROS_V5 (experimental, requires Shishi)
41 The library should be portable to all C89 platforms.  The command-line
42 application currently requires POSIX for network communication.
44 Things left to do below.  If you like to start working on anything,
45 please let me know so work duplication can be avoided.
47   * Implement GS2.
48   * Security layer improvements (e.g., DES and AES in DIGEST-MD5).
49   * Bug: If gsasl_decode is handed a string longer than one SASL token,
50     the remaining data will be discarded.  This means if the sender
51     packed two SASL tokens in one network packet, only the first will be
52     seen.  To fix this the best way, and the same time also improve
53     string handling (security), the entire SASL step API probably
54     should change.  Later: It occured to me that the en/de-code functions
55     can simply buffer the left over data until the next invocation.
56     Still, it would be nice to change the API to one that encapsulates
57     string operations inte a separate package (my safestring.*).
58   + Authentication infrastructure implementing the callbacks for
59     PAM, Kerberos, SQL, etc.  Separate project?  GNU Mailutils has
60     some starting points for this, but the API is inflexible.
61   + Provide standard callbacks for tty, GTK, gpg-agent etc.  Probably
62     should be a separate library.
63   + Port applications to use libgsasl
64   + More SASL mechanisms
65   - Cleanup code, possibly by using some string abstraction library.
66   - Privacy separation (authenticate in one process, pass state to another).
67   - Improve documentation
68   - Port to Cyclone? CCured?
70 For updates to the project, see <http://www.gnu.org/software/gsasl/>.
72 ----------------------------------------------------------------------
73 Copying and distribution of this file, with or without modification,
74 are permitted in any medium without royalty provided the copyright
75 notice and this notice are preserved.