X-Git-Url: https://git.hcoop.net/hcoop/debian/courier-authlib.git/blobdiff_plain/426e783363e20f878a4df0131ac76e294cf0948c..64ff59baf3361c2591d52e52bdddabebfcd21e4c:/README.html diff --git a/README.html b/README.html dissimilarity index 96% index 62c8d23..1890b53 100644 --- a/README.html +++ b/README.html @@ -1,80 +1,103 @@ - - - - - README - - - - -

Courier Authentication Library

- -

This is the Courier authentication library. Copies of this library code -used to exist in other tarballs: Courier, Courier-IMAP, and SqWebMail. -Building and installing any of these packages would've automatically -installed this authentication code.

- -

The authentication library is now a separate, standalone package. This -authentication library must now be installed, separately, before upgrading to -the following builds (or if installing them for the first time): Courier -0.48, Courier-IMAP 4.0, and SqWebMail 5.0. See NEWS -for more information.

- -

Download: http://www.courier-mta.org/download.php#authlib

- -

Overview

- -

The Courier authentication library provides authentication services for -other Courier applications. In this context, the term "authentication" refers -to the following functions:

-
    -
  1. Take a userid or a loginid, and a password. Determine whether the - loginid and the password are valid.
  2. -
  3. Given a userid, obtain the following information about the userid: -
      -
    1. The account's home directory.
    2. -
    3. The numeric system userid and groupid that owns all files - associated with this account.
    4. -
    5. The location of the account's maildir.
    6. -
    7. Any maildir quota defined for this account. See the Courier - documentation for more information on maildir quotas.
    8. -
    9. Other miscellaneous account-specific options.
    10. -
    -
  4. -
  5. Change the password associated with a loginid.
  6. -
  7. Obtain a complete list of all loginids.
  8. -
- -

The Courier authentication library provides alternative implementations of -these authentication services:

-
    -
  1. Use the traditional system password files: /etc/passwd and - /etc/shadow, possibly in conjunction with the PAM - library.
  2. -
  3. Maintain all this information in a GDBM or a DB database. The GDBM or - the DB database is compiled from plain text files. Perl scripts provide a - simple interface for creating and editing the authentication information, - then a script compiles the plain text files into a database.
  4. -
  5. Use an LDAP server for authentication.
  6. -
  7. Use a table in a MySQL database for authentication.
  8. -
  9. Use a table in a PostgreSQL database for authentication.
  10. -
- -

All Courier components that use this authentication library, therefore, -will be able to authenticate E-mail accounts -using any of the above methods.

- -

Additional information can be found in the INSTALL file.

- -

The authentication API is documented.

- -

Further resources

- -

Subscribe to the courier-users mailing list: http://lists.sourceforge.net/lists/listinfo/courier-users.

- -

- - + + + + + + + README + + + +

Courier Authentication Library

+ +

This is the Courier authentication library. Copies of this + library code used to exist in other tarballs: Courier, + Courier-IMAP, and SqWebMail. Building and installing any of these + packages would've automatically installed this authentication + code.

+ +

The authentication library is now a separate, standalone + package. This authentication library must now be installed, + separately, before upgrading to the following builds (or if + installing them for the first time): Courier 0.48, Courier-IMAP + 4.0, and SqWebMail 5.0. See NEWS for more + information.

+ +

Download: http://www.courier-mta.org/download.php#authlib

+ +

Overview

+ +

The Courier authentication library provides authentication + services for other Courier applications. In this context, the + term "authentication" refers to the following functions:

+ +
    +
  1. Take a userid or a loginid, and a password. Determine + whether the loginid and the password are valid.
  2. + +
  3. Given a userid, obtain the following information about the + userid: + +
      +
    1. The account's home directory.
    2. + +
    3. The numeric system userid and groupid that owns all + files associated with this account.
    4. + +
    5. The location of the account's maildir.
    6. + +
    7. Any maildir quota defined for this account. See the + Courier documentation for more information on maildir + quotas.
    8. + +
    9. Other miscellaneous account-specific options.
    10. +
    +
  4. + +
  5. Change the password associated with a loginid.
  6. + +
  7. Obtain a complete list of all loginids.
  8. +
+ +

The Courier authentication library provides alternative + implementations of these authentication services:

+ +
    +
  1. Use the traditional system password files: + /etc/passwd and /etc/shadow, possibly + in conjunction with the PAM library.
  2. + +
  3. Maintain all this information in a GDBM or a DB database. + The GDBM or the DB database is compiled from plain text files. + Perl scripts provide a simple interface for creating and + editing the authentication information, then a script compiles + the plain text files into a database.
  4. + +
  5. Use an LDAP server for authentication.
  6. + +
  7. Use a table in a MySQL database for authentication.
  8. + +
  9. Use a table in a PostgreSQL database for + authentication.
  10. +
+ +

All Courier components that use this authentication library, + therefore, will be able to authenticate E-mail accounts using any + of the above methods.

+ +

Additional information can be found in the INSTALL file.

+ +

The authentication API is documented.

+ +

Further resources

+ +

Subscribe to the courier-users mailing list: + http://lists.sourceforge.net/lists/listinfo/courier-users.

+ +