usr/src/man/man3sasl/sasl_encode.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_ENCODE 3SASL "Oct 22, 2003"
   9 .SH NAME
  10 sasl_encode, sasl_encodev \- encode data for transport to an authenticated host
  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_encode\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 .LP
  22 .nf
  23 \fBint\fR  \fBsasl_encodev\fR(\fBsasl_conn_t *\fR\fIconn\fR, \fBconst struct iovec *\fR\fIinvec\fR,
  24      \fBunsigned\fR \fInumiov\fR, \fBconst char *\fR\fIoutputlen\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBsasl_encode()\fR interface encodes data to be sent to a remote host for
  31 which there has been a successful authentication session. If there is a
  32 negotiated security, the data is signed or encrypted, and the output is sent
  33 without modification to the remote host. If there is no security layer, the
  34 output is identical to the input.
  35 .sp
  36 .LP
  37 The \fBsasl_encodev()\fR interface functions the same as the
  38 \fBsasl_encode()\fR interface, but operates on a \fBstruct iovec\fR instead of
  39 a character buffer.
  40 .SH PARAMETERS
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fIconn\fR\fR
  45 .ad
  46 .RS 13n
  47 The SASL connection context.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIinput\fR\fR
  54 .ad
  55 .RS 13n
  56 Data.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIinputlen\fR\fR
  63 .ad
  64 .RS 13n
  65 \fIinput\fR length.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fIoutput\fR\fR
  72 .ad
  73 .RS 13n
  74 The encoded data. \fIoutput\fR must be allocated or freed by the library.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fIoutputlen\fR\fR
  81 .ad
  82 .RS 13n
  83 The length of \fIoutput\fR.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fB\fIinvec\fR\fR
  90 .ad
  91 .RS 13n
  92 A pointer to set of \fBiovec\fR structures.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fB\fInumiov\fR\fR
  99 .ad
 100 .RS 13n
 101 The number of \fBiovec\fR structures in the \fIinvec\fR set.
 102 .RE
 103
 104 .SH RETURN VALUES
 105 .sp
 106 .LP
 107 \fBsasl_encode()\fR returns an integer that corresponds to a SASL error code.
 108 .SH ERRORS
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBSASL_OK\fR\fR
 113 .ad
 114 .RS 11n
 115 The call to \fBsasl_encode()\fR or \fBsasl_encodev()\fRwas successful.
 116 .RE
 117
 118 .sp
 119 .LP
 120 See \fBsasl_errors\fR(3SASL) for information on SASL error codes.
 121 .SH ATTRIBUTES
 122 .sp
 123 .LP
 124 See \fBattributes\fR(5) for descriptions of the following attributes:
 125 .sp
 126
 127 .sp
 128 .TS
 129 box;
 130 c | c
 131 l | l .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 Interface Stability     Evolving
 135 _
 136 MT-Level        Safe
 137 .TE
 138
 139 .SH SEE ALSO
 140 .sp
 141 .LP
 142 \fBattributes\fR(5)