• Home
  • History
  • Annotate
  • only in this directory
NameDateSize

..21-Aug-201432

advanced.htmlH A D07-Jul-20041.7 KiB

appconvert.htmlH A D07-Jul-20044.7 KiB

components.htmlH A D02-Dec-20139 KiB

draft-burdis-cat-srp-sasl-xx.txtH A D20-Jan-200689.7 KiB

draft-ietf-sasl-anon-xx.txtH A D20-Jan-200617.2 KiB

draft-ietf-sasl-crammd5-xx.txtH A D20-Jan-200614.8 KiB

draft-ietf-sasl-gssapi-xx.txtH A D20-Jan-200622.2 KiB

draft-ietf-sasl-plain-xx.txtH A D20-Jan-200616.9 KiB

draft-ietf-sasl-rfc2222bis-xx.txtH A D20-Jan-200647.1 KiB

draft-ietf-sasl-rfc2831bis-xx.txtH A D20-Jan-200674.7 KiB

draft-ietf-sasl-saslprep-xx.txtH A D20-Jan-200611.2 KiB

draft-murchison-sasl-login-xx.txtH A D20-Jan-200611.7 KiB

draft-newman-sasl-c-api-xx.txtH A D20-Jan-200652.6 KiB

draft-newman-sasl-passdss-xx.txtH A D20-Jan-200641.5 KiB

gssapi.htmlH A D20-Jan-20067.6 KiB

index.htmlH A D20-Jan-20065.4 KiB

install.htmlH A D02-Dec-201310.1 KiB

macosx.htmlH A D02-Dec-201311.6 KiB

Makefile.amH A D20-Jan-20062.9 KiB

Makefile.inH A D02-Dec-201313.9 KiB

mechanisms.htmlH A D02-Dec-20137.3 KiB

NTMakefileH A D07-Jul-2004717

ONEWSH A D27-Feb-20024.6 KiB

options.htmlH A D02-Dec-201311.5 KiB

plugprog.htmlH A D02-Dec-201316.2 KiB

programming.htmlH A D02-Dec-201340.7 KiB

readme.htmlH A D20-Jan-20064.7 KiB

rfc1321.txtH A D27-Feb-200234.4 KiB

rfc1939.txtH A D27-Feb-200245.9 KiB

rfc2104.txtH A D27-Feb-200221.8 KiB

rfc2195.txtH A D27-Feb-200210.2 KiB

rfc2222.txtH A D27-Feb-200234.2 KiB

rfc2243.txtH A D27-Feb-200219.3 KiB

rfc2245.txtH A D27-Feb-20029.7 KiB

rfc2289.txtH A D27-Feb-200255.2 KiB

rfc2444.txtH A D27-Feb-200213.1 KiB

rfc2595.txtH A D27-Feb-200231.7 KiB

rfc2831.txtH A D27-Feb-200256.8 KiB

rfc2945.txtH A D27-Feb-200217.4 KiB

rfc3174.txtH A D27-Feb-200234.7 KiB

server-plugin-flow.figH A D07-Jul-20044.3 KiB

sysadmin.htmlH A D02-Dec-201321.9 KiB

testing.txtH A D27-Feb-20023.2 KiB

TODOH A D07-Jul-20041.2 KiB

upgrading.htmlH A D20-Jan-20064.1 KiB

windows.htmlH A D02-Dec-20136.1 KiB

readme.html

1<HTML><HEAD>
2<title>Cyrus SASLv2 README</title>
3<!-- $Id: readme.html,v 1.6 2006/01/20 20:15:07 snsimon Exp $ -->
4</HEAD>
5<BODY>
6<H1>Read Me First</H1>
7
8This document offers a general overview of the Cyrus SASL library.
9The Cyrus SASL Libray provides applications with an implementation
10of the Simple Authentication and Security Layer (RFC2222), and
11several authentication mechanisms.  Users interested in the "big picture"
12of what is provided by the library should read about
13<a href=components.html>Cyrus SASL Components</a>.
14
15<H2>FEATURES</H2>
16
17The following <a href="mechanisms.html">mechanisms</a> are included in
18this distribution:
19<ul>
20<li>ANONYMOUS
21<li>CRAM-MD5
22<li>DIGEST-MD5
23<li>EXTERNAL
24<li>GSSAPI (MIT Kerberos 5, Heimdal Kerberos 5 or CyberSafe)
25<li>KERBEROS_V4
26<li>LOGIN
27<li>NTLM (requires OpenSSL libcrypto)
28<li>OTP (requires OpenSSL libcrypto)
29<li>PLAIN
30<li>SRP (work in progress; requires OpenSSL libcrypto)
31</ul>
32
33The library also supports storing user secrets in either a hash
34database (e.g. Berkeley DB, gdbm, ndbm), LDAP, or in a SQL database 
35(MySQL, Postgres).
36
37
38Additionally, mechanisms such as PLAIN and LOGIN
39(where the plaintext password is directly supplied by the client)
40can perform direct password verification via the saslauthd daemon.  This
41allows the use of LDAP, PAM, and a variety of other password verification
42routines.
43
44The sample directory contains two programs which provide a reference
45for using the library, as well as making it easy to test a mechanism
46on the command line.  See <a
47href="programming.html">programming.html</a> for more information.<p>
48
49This library is believed to be thread safe IF:
50<ul>
51<li>you supply mutex functions (see sasl_set_mutex())
52<li>you make no libsasl calls until sasl_client/server_init() completes
53<li>no libsasl calls are made after sasl_done() is begun
54<li>when using GSSAPI, you use a thread-safe GSS / Kerberos 5 library.
55</ul>
56
57<H2>TYPICAL UNIX INSTALLATION</H2>
58
59First, if you are upgrading from Cyrus SASLv1, please see <a
60href="upgrading.html">upgrading.html</a>.<p>
61
62Please see the file <a href="install.html">install.html</a> for instructions
63on how to install this package.<p>
64
65Note that the library can use the environment variable SASL_PATH to locate the
66directory where the mechanisms are; this should be a colon-separated
67list of directories containing plugins.  Otherwise it will default to the
68value of <tt>--with-plugindir</tt> as supplied to <tt>configure</tt> (which
69itself defaults to <tt>/usr/local/lib</tt>).
70
71<H2>INSTALLATION ON MAC OS X</H2>
72Please read <A HREF="macosx.html">macosx.html</A>
73
74<H2>INSTALLATION ON WINDOWS</H2>
75Please read <A HREF="windows.html">windows.html</A>.  This configuration
76has not been extensively tested.
77
78<H2>CONFIGURATION</H2>
79There are two main ways to configure the SASL library for a given
80application.  The first (and typically easiest) is to make use
81of the application's configuration files.  Provided the application supports it
82(via the <tt>SASL_CB_GETOPT</tt> callback), please refer to that documetation
83for how to supply <a href=options.html>SASL options</a>.<p>
84
85Alternatively, Cyrus SASL looks for configuration files in
86/usr/lib/sasl/Appname.conf where Appname is settable by the
87application (for example, Sendmail 8.10 and later set this to
88"Sendmail").<p>
89
90Configuration using the application's configuration files (via
91the <tt>getopt</tt> callback) will override those supplied by
92the SASL configuration files.<p>
93
94For a detailed guide on configuring libsasl, please look at
95<A HREF=sysadmin.html>sysadmin.html</A> and
96<A HREF=options.html>options.html</A>
97
98<H2>KNOWN BUGS</H2>
99<ul>
100<li>libtool doesn't always link libraries together.  In our environment,
101we only have static Krb5 libraries; the GSSAPI plugin should link
102these libraries in on platforms that support it (Solaris and Linux
103among them) but it does not.  It also doesn't always get the runpath
104of libraries correct.
105<li>Also see our <A HREF=http://bugzilla.andrew.cmu.edu>bugzilla</A>.
106</ul>
107
108<H2>AUTHORS</H2>
109
110For any comments/suggestions/bug reports, please contact <a
111href="mailto:cyrus-bugs@andrew.cmu.edu">cyrus-bugs@andrew.cmu.edu</a>.
112Be sure to include the version of libsasl and your operating system;
113messages without this information will not be answered.<p>
114
115Major contributors to the libsasl code can be found in the top-level
116file AUTHORS.  Additionally saslauthd has an AUTHORS file that lists
117major contributors as well.<p>
118
119People considering doing binary distributions that include saslauthd
120should be aware that the code is covered by several slightly different
121(but compatible) licenses, due to how it was contributed.  Details can
122be found within the source code.<p>
123
124<hr>
125Back to the <A href=index.html>index</a>
126
127</body>
128</html>
129
130