Mercurial > emacs
view doc/misc/sasl.texi @ 112370:7935463f385e
Fix NextStep build problems with globals.h introducion.
* src/globals.h (struct emacs_globals): Add f_ns_input_file,
f_ns_input_font, f_ns_input_fontsize, f_ns_input_line,
f_ns_input_color, f_ns_input_text, f_ns_working_text,
f_ns_input_spi_name, f_ns_input_spi_arg, f_ns_alternate_modifier,
f_ns_right_alternate_modifier, f_ns_command_modifier,
f_ns_right_command_modifier, f_ns_control_modifier,
f_ns_right_control_modifier, f_ns_function_modifier,
f_ns_antialias_text, f_ns_confirm_quit, f_Vns_icon_type_alist,
f_Vns_version_string, f_Vns_sent_selection_hooks,
f_Vns_lost_selection_hooks, f_Vselection_alist, f_Vns_reg_to_script
and corresponding defines.
* src/nsfns.m (Vmenu_bar_mode, Vtool_bar_mode): Remove declaration.
(Vns_icon_type_alist, Vns_version_string): Move to globals.h.
(syms_of_nsfns): Remove & from DEFVAR_LISP calls.
* src/nsfont.m (Vns_reg_to_script, ns_antialias_text): Move to
globals.h.
(syms_of_nsfont): Remove & from DEFVAR_LISP.
* src/nsselect.m (Vns_sent_selection_hooks, Vns_lost_selection_hooks
(Vselection_alist, Vselection_converter_alist): Move to globals.h.
(syms_of_nsselect): Remove & from DEFVAR_LISP.
* src/nsterm.m (ns_input_file, ns_input_font, ns_input_fontsize)
(ns_input_line, ns_input_color, ns_input_text, ns_working_text)
(ns_input_spi_name, ns_input_spi_arg)
(ns_alternate_modifier, ns_right_alternate_modifier)
(ns_command_modifier, ns_right_command_modifier, ns_control_modifier)
(ns_right_control_modifier, ns_function_modifier)
(ns_antialias_text, ns_confirm_quit): Move to globals.h.
(Vx_toolkit_scroll_bars, x_use_underline_position_properties)
(x_underline_at_descent_line): Remove declaration.
(syms_of_nsterm): Remove & from DEFVAR_LISP and DEFVAR_BOOL.
* src/nsmenu.m (Voverriding_local_map, Voverriding_local_map_menu_flag):
Remove declaration.
author | Jan D. <jan.h.d@swipnet.se> |
---|---|
date | Wed, 19 Jan 2011 23:11:33 +0100 |
parents | 417b1e4d63cd |
children |
line wrap: on
line source
\input texinfo @c -*-texinfo-*- @setfilename ../../info/sasl @set VERSION 0.2 @settitle Emacs SASL Library @value{VERSION} @copying This file describes the Emacs SASL library, version @value{VERSION}. Copyright @copyright{} 2000, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled ``GNU Free Documentation License'' in the Emacs manual. (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and modify this GNU manual. Buying copies from the FSF supports it in developing GNU and promoting software freedom.'' This document is part of a collection distributed under the GNU Free Documentation License. If you want to distribute this document separately from the collection, you can do so by adding a copy of the license to the document, as described in section 6 of the license. @end quotation @end copying @dircategory Emacs @direntry * SASL: (sasl). The Emacs SASL library. @end direntry @titlepage @title Emacs SASL Library @value{VERSION} @author by Daiki Ueno @page @vskip 0pt plus 1filll @insertcopying @end titlepage @node Top @top Emacs SASL SASL is a common interface to share several authentication mechanisms between applications using different protocols. @ifnottex @insertcopying @end ifnottex @menu * Overview:: What Emacs SASL library is. * How to use:: Adding authentication support to your applications. * Data types:: * Back end drivers:: Writing your own drivers. * Index:: * Function Index:: * Variable Index:: @end menu @node Overview @chapter Overview @sc{sasl} is short for @dfn{Simple Authentication and Security Layer}. This standard is documented in RFC2222. It provides a simple method for adding authentication support to various application protocols. The toplevel interface of this library is inspired by Java @sc{sasl} Application Program Interface. It defines an abstraction over a series of authentication mechanism drivers (@ref{Back end drivers}). Back end drivers are designed to be close as possible to the authentication mechanism. You can access the additional configuration information anywhere from the implementation. @node How to use @chapter How to use (Not yet written). To use Emacs SASL library, please evaluate following expression at the beginning of your application program. @lisp (require 'sasl) @end lisp If you want to check existence of sasl.el at runtime, instead you can list autoload settings for functions you want. @node Data types @chapter Data types There are three data types to be used for carrying a negotiated security layer---a mechanism, a client parameter and an authentication step. @menu * Mechanisms:: * Clients:: * Steps:: @end menu @node Mechanisms @section Mechanisms A mechanism (@code{sasl-mechanism} object) is a schema of the @sc{sasl} authentication mechanism driver. @defvar sasl-mechanisms A list of mechanism names. @end defvar @defun sasl-find-mechanism mechanisms Retrieve an appropriate mechanism. This function compares @var{mechanisms} and @code{sasl-mechanisms} then returns appropriate @code{sasl-mechanism} object. @example (let ((sasl-mechanisms '("CRAM-MD5" "DIGEST-MD5"))) (setq mechanism (sasl-find-mechanism server-supported-mechanisms))) @end example @end defun @defun sasl-mechanism-name mechanism Return name of mechanism, a string. @end defun If you want to write an authentication mechanism driver (@ref{Back end drivers}), use @code{sasl-make-mechanism} and modify @code{sasl-mechanisms} and @code{sasl-mechanism-alist} correctly. @defun sasl-make-mechanism name steps Allocate a @code{sasl-mechanism} object. This function takes two parameters---name of the mechanism, and a list of authentication functions. @example (defconst sasl-anonymous-steps '(identity ;no initial response sasl-anonymous-response)) (put 'sasl-anonymous 'sasl-mechanism (sasl-make-mechanism "ANONYMOUS" sasl-anonymous-steps)) @end example @end defun @node Clients @section Clients A client (@code{sasl-client} object) initialized with four parameters---a mechanism, a user name, name of the service and name of the server. @defun sasl-make-client mechanism name service server Prepare a @code{sasl-client} object. @end defun @defun sasl-client-mechanism client Return the mechanism (@code{sasl-mechanism} object) of client. @end defun @defun sasl-client-name client Return the authorization name of client, a string. @end defun @defun sasl-client-service client Return the service name of client, a string. @end defun @defun sasl-client-server client Return the server name of client, a string. @end defun If you want to specify additional configuration properties, please use @code{sasl-client-set-property}. @defun sasl-client-set-property client property value Add the given property/value to client. @end defun @defun sasl-client-property client property Return the value of the property of client. @end defun @defun sasl-client-set-properties client plist Destructively set the properties of client. The second argument is the new property list. @end defun @defun sasl-client-properties client Return the whole property list of client configuration. @end defun @node Steps @section Steps A step (@code{sasl-step} object) is an abstraction of authentication ``step'' which holds the response value and the next entry point for the authentication process (the latter is not accessible). @defun sasl-step-data step Return the data which @var{step} holds, a string. @end defun @defun sasl-step-set-data step data Store @var{data} string to @var{step}. @end defun To get the initial response, you should call the function @code{sasl-next-step} with the second argument @code{nil}. @example (setq name (sasl-mechanism-name mechanism)) @end example At this point we could send the command which starts a SASL authentication protocol exchange. For example, @example (process-send-string process (if (sasl-step-data step) ;initial response (format "AUTH %s %s\r\n" name (base64-encode-string (sasl-step-data step) t)) (format "AUTH %s\r\n" name))) @end example To go on with the authentication process, all you have to do is call @code{sasl-next-step} consecutively. @defun sasl-next-step client step Perform the authentication step. At the first time @var{step} should be set to @code{nil}. @end defun @node Back end drivers @chapter Back end drivers (Not yet written). @node Index @chapter Index @printindex cp @node Function Index @chapter Function Index @printindex fn @node Variable Index @chapter Variable Index @printindex vr @summarycontents @contents @bye @c End: