cgit.sxemacs.org Git - gnus/blob - texi/sasl.texi

   1 \input texinfo                  @c -*-texinfo-*-
   2
   3 @setfilename sasl.info
   4
   5 @set VERSION 0.2
   6 @settitle Emacs SASL Library @value{VERSION}
   7
   8 @copying
   9 This file describes the Emacs SASL library, version @value{VERSION}.
  10
  11 Copyright @copyright{} 2000, 2004, 2005, 2006, 2007, 2008, 2009
  12 Free Software Foundation, Inc.
  13
  14 @quotation
  15 Permission is granted to copy, distribute and/or modify this document
  16 under the terms of the GNU Free Documentation License, Version 1.3 or
  17 any later version published by the Free Software Foundation; with no
  18 Invariant Sections, with the Front-Cover texts being ``A GNU Manual,''
  19 and with the Back-Cover Texts as in (a) below.  A copy of the license
  20 is included in the section entitled ``GNU Free Documentation License''
  21 in the Emacs manual.
  22
  23 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
  24 modify this GNU manual.  Buying copies from the FSF supports it in
  25 developing GNU and promoting software freedom.''
  26
  27 This document is part of a collection distributed under the GNU Free
  28 Documentation License.  If you want to distribute this document
  29 separately from the collection, you can do so by adding a copy of the
  30 license to the document, as described in section 6 of the license.
  31 @end quotation
  32 @end copying
  33
  34 @dircategory Emacs
  35 @direntry
  36 * SASL: (sasl).   The Emacs SASL library.
  37 @end direntry
  38
  39
  40 @titlepage
  41 @title Emacs SASL Library @value{VERSION}
  42
  43 @author by Daiki Ueno
  44 @page
  45
  46 @vskip 0pt plus 1filll
  47 @insertcopying
  48 @end titlepage
  49
  50
  51 @node Top
  52 @top Emacs SASL
  53
  54 SASL is a common interface to share several authentication mechanisms between
  55 applications using different protocols.
  56
  57 @ifnottex
  58 @insertcopying
  59 @end ifnottex
  60
  61 @menu
  62 * Overview::                    What Emacs SASL library is.
  63 * How to use::                  Adding authentication support to your applications.
  64 * Data types::
  65 * Back end drivers::             Writing your own drivers.
  66 * Index::
  67 * Function Index::
  68 * Variable Index::
  69 @end menu
  70
  71 @node Overview
  72 @chapter Overview
  73
  74 @sc{sasl} is short for @dfn{Simple Authentication and Security Layer}.
  75 This standard is documented in RFC2222.  It provides a simple method for
  76 adding authentication support to various application protocols.
  77
  78 The toplevel interface of this library is inspired by Java @sc{sasl}
  79 Application Program Interface.  It defines an abstraction over a series
  80 of authentication mechanism drivers (@ref{Back end drivers}).
  81
  82 Back end drivers are designed to be close as possible to the
  83 authentication mechanism.  You can access the additional configuration
  84 information anywhere from the implementation.
  85
  86 @node How to use
  87 @chapter How to use
  88
  89 (Not yet written).
  90
  91 To use Emacs SASL library, please evaluate following expression at the
  92 beginning of your application program.
  93
  94 @lisp
  95 (require 'sasl)
  96 @end lisp
  97
  98 If you want to check existence of sasl.el at runtime, instead you
  99 can list autoload settings for functions you want.
 100
 101 @node Data types
 102 @chapter Data types
 103
 104 There are three data types to be used for carrying a negotiated
 105 security layer---a mechanism, a client parameter and an authentication
 106 step.
 107
 108 @menu
 109 * Mechanisms::
 110 * Clients::
 111 * Steps::
 112 @end menu
 113
 114 @node Mechanisms
 115 @section Mechanisms
 116
 117 A mechanism (@code{sasl-mechanism} object) is a schema of the @sc{sasl}
 118 authentication mechanism driver.
 119
 120 @defvar sasl-mechanisms
 121 A list of mechanism names.
 122 @end defvar
 123
 124 @defun sasl-find-mechanism mechanisms
 125
 126 Retrieve an appropriate mechanism.
 127 This function compares @var{mechanisms} and @code{sasl-mechanisms} then
 128 returns appropriate @code{sasl-mechanism} object.
 129