usr/src/man/man3sasl/sasl_server_start.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_START 3SASL "Oct 1, 2003"
   9 .SH NAME
  10 sasl_server_start \- create a new server authentication object
  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_start\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char  *\fR\fImech\fR,
  18      \fBconst char  *\fR\fIclientin\fR,\ \fBunsigned *\fR\fIclientinlen\fR,
  19      \fBconst char  **\fR\fIserverout\fR, \fBunsigned *\fR\fIserveroutlen\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBsasl_server_start()\fR interface begins the authentication with the
  26 mechanism specified by the \fImech\fR parameter. \fBsasl_server_start()\fR
  27 fails if the mechanism is not supported.
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIconn\fR\fR
  33 .ad
  34 .RS 16n
  35 The SASL context for this connection.
  36 .RE
  37
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fImech\fR\fR
  42 .ad
  43 .RS 16n
  44 The mechanism name that the client requested.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIclientin\fR\fR
  51 .ad
  52 .RS 16n
  53 The initial response from the client. The value of \fIclientin\fR is \fINULL\fR
  54 if the protocol lacks support for the client-send-first or if the other end did
  55 not have an initial send. No initial client send is distinct from an initial
  56 send of a null string. The protocol must account for this difference.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIclientinlen\fR\fR
  63 .ad
  64 .RS 16n
  65 The length of the initial response.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fIserverout\fR\fR
  72 .ad
  73 .RS 16n
  74 Created by the plugin library. The value of \fIserverout\fR is the initial
  75 server response to send to the client. \fIserverout\fR is allocated or freed by
  76 the library. It is the job of the client to send it over the network to the
  77 server. Protocol specific encoding, for example \fBbase64\fR encoding, must be
  78 done by the server.
  79 .RE
  80
  81 .sp
  82 .ne 2
  83 .na
  84 \fB\fIserveroutlen\fR\fR
  85 .ad
  86 .RS 16n
  87 The length of the initial server challenge.
  88 .RE
  89
  90 .SH RETURN VALUES
  91 .sp
  92 .LP
  93 \fBsasl_server_start()\fR returns an integer that corresponds to a SASL error
  94 code.
  95 .SH ERRORS
  96 .sp
  97 .ne 2
  98 .na
  99 \fB\fBSASL_OK\fR\fR
 100 .ad
 101 .RS 17n
 102 Authentication completed successfully.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fBSASL_CONTINUE\fR\fR
 109 .ad
 110 .RS 17n
 111 The call to \fBsasl_server_start()\fR was successful, and more steps are needed
 112 in the authentication.
 113 .RE
 114
 115 .sp
 116 .LP
 117 All other error codes indicate an error situation that must be handled, or the
 118 authentication session should be quit. See \fBsasl_errors\fR(3SASL) for
 119 information on SASL error codes.
 120 .SH ATTRIBUTES
 121 .sp
 122 .LP
 123 See \fBattributes\fR(5) for descriptions of the following attributes:
 124 .sp
 125
 126 .sp
 127 .TS
 128 box;
 129 c | c
 130 l | l .
 131 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 132 _
 133 Interface Stability     Evolving
 134 _
 135 MT-Level        MT-Safe
 136 .TE
 137
 138 .SH SEE ALSO
 139 .sp
 140 .LP
 141 \fBgethostname\fR(3C), \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)