usr/src/man/man3sasl/sasl_server_init.3sasl

   1 '\" te
   2 .\" Copyright (C) 1998-2003, Carnegie Mellon Univeristy.  All Rights Reserved.
   3 .\" Portions Copyright (C) 2003, Sun Microsystems,
   4 .\" Inc. All Rights Reserved
   5 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   6 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   7 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   8 .TH SASL_SERVER_INIT 3SASL "Oct 22, 2003"
   9 .SH NAME
  10 sasl_server_init \- SASL server authentication initialization
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-lsasl\fR   [ \fIlibrary\fR ... ]
  15 #include <sasl/sasl.h>
  16
  17 \fBint\fR \fBsasl_server_init\fR(\fBconst sasl_callback *\fR\fIcallbacks\fR, \fBconst char *\fR\fIappname\fR);
  18 .fi
  19
  20 .SH DESCRIPTION
  21 .sp
  22 .LP
  23 Use the \fBsasl_server_init()\fR interface to initialize SASL. You must call
  24 \fBsasl_server_init()\fR before you make a call to \fBsasl_server_start()\fR.
  25 \fBsasl_server_init()\fR may be called only once per process. A call to
  26 \fBsasl_server_init()\fR initializes all SASL mechanism drivers, that is, the
  27 authentication mechanisms. The SASL mechanism drivers are usually found in the
  28 \fB/usr/lib/sasl\fR directory.
  29 .SH PARAMETERS
  30 .sp
  31 .ne 2
  32 .na
  33 \fB\fIcallbacks\fR\fR
  34 .ad
  35 .RS 13n
  36 Specifies the base callbacks for all client connections.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fIappname\fR\fR
  43 .ad
  44 .RS 13n
  45 The name of the application for lower level logging. For example, the sendmail
  46 server calls \fIappname\fR this way:
  47 .sp
  48 .in +2
  49 .nf
  50 sasl_server_init(srvcallbacks, "Sendmail")
  51 .fi
  52 .in -2
  53
  54 .RE
  55
  56 .SH RETURN VALUES
  57 .sp
  58 .LP
  59 \fBsasl_server_init()\fR returns an integer that corresponds to a SASL error
  60 code.
  61 .SH ERRORS
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBSASL_OK\fR\fR
  66 .ad
  67 .RS 11n
  68 The call to \fBsasl_server_init()\fR was successful.
  69 .RE
  70
  71 .sp
  72 .LP
  73 All other error codes indicate an error situation that must be handled, or the
  74 authentication session should be quit. See \fBsasl_errors\fR(3SASL) for
  75 information on SASL error codes.
  76 .SH ATTRIBUTES
  77 .sp
  78 .LP
  79 See \fBattributes\fR(5) for descriptions of the following attributes:
  80 .sp
  81
  82 .sp
  83 .TS
  84 box;
  85 c | c
  86 l | l .
  87 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  88 _
  89 Interface Stability     Evolving
  90 _
  91 MT-Level        Unsafe
  92 .TE
  93
  94 .SH SEE ALSO
  95 .sp
  96 .LP
  97 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)
  98 .SH NOTES
  99 .sp
 100 .LP
 101 While most of \fBlibsasl\fR is MT-Safe, no other \fBlibsasl\fR function should
 102 be called until this function completes.