man/sasl_server_init.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .\" Copyright (c) 2001 Carnegie Mellon University.  All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\"
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\"
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\"
  17 .\" 3. The name "Carnegie Mellon University" must not be used to
  18 .\"    endorse or promote products derived from this software without
  19 .\"    prior written permission. For permission or any other legal
  20 .\"    details, please contact
  21 .\"      Office of Technology Transfer
  22 .\"      Carnegie Mellon University
  23 .\"      5000 Forbes Avenue
  24 .\"      Pittsburgh, PA  15213-3890
  25 .\"      (412) 268-4387, fax: (412) 268-7395
  26 .\"      tech-transfer@andrew.cmu.edu
  27 .\"
  28 .\" 4. Redistributions of any form whatsoever must retain the following
  29 .\"    acknowledgment:
  30 .\"    "This product includes software developed by Computing Services
  31 .\"     at Carnegie Mellon University (http://www.cmu.edu/computing/)."
  32 .\"
  33 .\" CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  34 .\" THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  35 .\" AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  36 .\" FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  37 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  38 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  39 .\" OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  40 .\"
  41 .TH sasl_server_init "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_server_init \- SASL server authentication initialization
  44
  45
  46 .SH SYNOPSIS
  47 .nf
  48 .B #include <sasl/sasl.h>
  49 .sp
  50 .BI "int sasl_server_init(const sasl_callback_t " *callbacks ", "
  51 .BI "                     const char " *appname ");"
  52
  53 .fi
  54 .SH DESCRIPTION
  55
  56 .B sasl_server_init()
  57 initializes SASL. It must be called before any calls to
  58 sasl_server_start, and only once per process.
  59 This call initializes all SASL mechanism drivers
  60 (e.g. authentication mechanisms). These are usually found in the
  61 /usr/lib/sasl2 directory but the directory may be overridden with the
  62 SASL_PATH environment variable (or at compile time).
  63 .PP
  64 .I callbacks
  65 specifies the base callbacks for all client connections. See
  66 the sasl_callbacks man page for more information.
  67 .PP
  68 .I appname
  69 is the name of the application. It is used for where to find the
  70 default configuration file.
  71 .PP
  72
  73 .SH "RETURN VALUE"
  74
  75 sasl_server_init returns an integer which corresponds to one of the
  76 SASL error codes. SASL_OK is the only one that indicates success. All
  77 others indicate errors and should either be handled or the
  78 authentication session should be quit.
  79
  80 .SH "CONFORMING TO"
  81 RFC 2222
  82 .SH "SEE ALSO"
  83 sasl(3), sasl_callbacks(3), sasl_errors(3), sasl_server_new(3), sasl_server_start(3), sasl_server_step(3)