usr/src/man/man3sasl/sasl_server_step.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_STEP 3SASL "Oct 14, 2003"
   9 .SH NAME
  10 sasl_server_step \- perform a step in the server authentication negotiation
  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_step\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char  *\fR\fIclientin\fR,
  18      \fBunsigned\fR \fIclientinlen\fR, \fBconst char  **\fR\fIserverout\fR,
  19      \fBunsigned *\fR\fIserveroutlen\fR);
  20 .fi
  21
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBsasl_server_step()\fR performs a step in the authentication negotiation.
  26 .SH PARAMETERS
  27 .sp
  28 .ne 2
  29 .na
  30 \fB\fIconn\fR\fR
  31 .ad
  32 .RS 16n
  33 The SASL context for this connection.
  34 .RE
  35
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fIclientin\fR\fR
  40 .ad
  41 .RS 16n
  42 The data given by the client. The data is decoded if the protocol encodes
  43 requests that are sent over the wire.
  44 .RE
  45
  46 .sp
  47 .ne 2
  48 .na
  49 \fB\fIclientinlen\fR\fR
  50 .ad
  51 .RS 16n
  52 The length of \fIclientin\fR.
  53 .RE
  54
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fIserverout\fR\fR
  59 .ad
  60 .br
  61 .na
  62 \fB\fIserveroutlen\fR\fR
  63 .ad
  64 .RS 16n
  65 Set by the library and sent to the client.
  66 .RE
  67
  68 .SH RETURN VALUES
  69 .sp
  70 .LP
  71 \fBsasl_server_step()\fR returns an integer that corresponds to a SASL error
  72 code.
  73 .SH ERRORS
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBSASL_OK\fR\fR
  78 .ad
  79 .RS 17n
  80 The whole authentication completed successfully.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBSASL_CONTINUE\fR\fR
  87 .ad
  88 .RS 17n
  89 The call to \fBsasl_server_step()\fR was successful, and at least one more step
  90 is needed for the authentication.
  91 .RE
  92
  93 .sp
  94 .LP
  95 All other error codes indicate an error situation that you must handle, or you
  96 should quit the authentication session. See \fBsasl_errors\fR(3SASL) for
  97 information on SASL error codes.
  98 .SH ATTRIBUTES
  99 .sp
 100 .LP
 101 See \fBattributes\fR(5) for descriptions of the following attributes:
 102 .sp
 103
 104 .sp
 105 .TS
 106 box;
 107 c | c
 108 l | l .
 109 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 110 _
 111 Interface Stability     Evolving
 112 _
 113 MT-Level        MT-Safe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBsasl_errors\fR(3SASL), \fBattributes\fR(5)