man/sasl_server_step.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_step "10 July 2001" SASL "SASL man pages"
  42 .SH NAME
  43 sasl_server_step \- Perform a step in the authentication negotiation
  44
  45
  46 .SH SYNOPSIS
  47 .nf
  48 .B #include <sasl/sasl.h>
  49 .sp
  50 .BI "int sasl_server_step(sasl_conn_t " *conn ", "
  51 .BI "                     const char " *clientin ", "
  52 .BI "                     unsigned " clientinlen ", "
  53 .BI "                     const char ** " serverout ", "
  54 .BI "                     unsigned * " serveroutlen ");"
  55
  56
  57 .SH DESCRIPTION
  58
  59 .B sasl_server_step()
  60 performs a step in the authentication negotiation. It returns SASL_OK
  61 if the whole negotiation is successful and SASL_CONTINUE if this step
  62 is ok but at least one more step is needed.
  63
  64 .PP
  65 .I conn
  66 is the SASL connection context
  67 .PP
  68 .I clientin
  69 is the data given by the client (decoded if the protocol encodes requests sent over the wire)
  70 .I clientinlen
  71 is the length of
  72 .I clientin
  73 .PP
  74 .I serverout
  75 and
  76 .I serveroutlen
  77 are set by the library and should be sent to the client.
  78 .PP
  79 .SH "RETURN VALUE"
  80
  81 sasl_server_step returns an integer which corresponds to one of the
  82 SASL error codes. SASL_CONTINUE indicates success and that there are
  83 more steps needed in the authentication. SASL_OK indicates that the
  84 authentication is complete. All other return codes indicate errors and
  85 should either be handled or the authentication session should be quit.
  86
  87 .SH "CONFORMING TO"
  88 RFC 2222
  89 .SH "SEE ALSO"
  90 sasl(3), sasl_errors(3), sasl_server_init(3), sasl_server_new(3), sasl_server_start(3)