usr/src/man/man3sasl/sasl_decode.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_DECODE 3SASL "Aug 28, 2003"
   9 .SH NAME
  10 sasl_decode \- decode data received
  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_decode\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst char *\fR\fIinput\fR, \fBunsigned\fR \fIinputlen\fR,
  18      \fBconst char **\fR\fIoutput\fR, \fBunsigned *\fR\fIoutputlen\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 Use the \fBsasl_decode()\fR interface to decode data received. After
  25 authentication, call this function on all data received. The data is decoded
  26 from encrypted or signed form to plain data. If no security lay is negotiated,
  27 the output is identical to the input.
  28 .sp
  29 .LP
  30 Do not give \fBsasl_decode()\fR more data than the negotiated \fBmaxbufsize\fR.
  31 See \fBsasl_getprop\fR(3SASL).
  32 .sp
  33 .LP
  34 \fBsasl_decode()\fR can complete successfully although the value of
  35 \fIoutputlen\fR is zero. If this is the case, wait for more data and call
  36 \fBsasl_decode()\fR again.
  37 .SH PARAMETERS
  38 .sp
  39 .ne 2
  40 .na
  41 \fB\fIconn\fR\fR
  42 .ad
  43 .RS 13n
  44 The SASL connection context.
  45 .RE
  46
  47 .sp
  48 .ne 2
  49 .na
  50 \fB\fIinput\fR\fR
  51 .ad
  52 .RS 13n
  53 Data received.
  54 .RE
  55
  56 .sp
  57 .ne 2
  58 .na
  59 \fB\fIinputlen\fR\fR
  60 .ad
  61 .RS 13n
  62 The length of \fIinput\fR
  63 .RE
  64
  65 .sp
  66 .ne 2
  67 .na
  68 \fB\fIoutput\fR\fR
  69 .ad
  70 .RS 13n
  71 The decoded data. \fIoutput\fR must be allocated or freed by the library.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fIoutputlen\fR\fR
  78 .ad
  79 .RS 13n
  80 The length of \fIoutput\fR.
  81 .RE
  82
  83 .SH RETURN VALUES
  84 .sp
  85 .LP
  86 \fBsasl_decode()\fR returns an integer that corresponds to a SASL error code.
  87 .SH ERRORS
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBSASL_OK\fR\fR
  92 .ad
  93 .RS 11n
  94 The call to \fBsasl_decode()\fR was successful.
  95 .RE
  96
  97 .sp
  98 .LP
  99 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for descriptions of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 Interface Stability     Evolving
 114 _
 115 MT-Level        Safe
 116 .TE
 117
 118 .SH SEE ALSO
 119 .sp
 120 .LP
 121 \fBsasl_errors\fR(3SASL), \fBsasl_getprop\fR(3SASL), \fBattributes\fR(5)