| 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_encode "10 July 2001" SASL "SASL man pages" |
|---|
| 42 | .SH NAME |
|---|
| 43 | sasl_encode \- Encode data for transport to authenticated host |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | .SH SYNOPSIS |
|---|
| 47 | .nf |
|---|
| 48 | .B #include <sasl/sasl.h> |
|---|
| 49 | |
|---|
| 50 | .sp |
|---|
| 51 | .BI "int sasl_encode(sasl_conn_t " *conn ", " |
|---|
| 52 | .BI " const char * " input ", " |
|---|
| 53 | .BI " unsigned " inputlen ", " |
|---|
| 54 | .BI " const char ** " output ", " |
|---|
| 55 | .BI " unsigned * " outputlen ");" |
|---|
| 56 | |
|---|
| 57 | .BI "int sasl_encodev(sasl_conn_t " *conn ", " |
|---|
| 58 | .BI " const struct iovec * " invec ", " |
|---|
| 59 | .BI " unsigned " numiov ", " |
|---|
| 60 | .BI " const char ** " output ", " |
|---|
| 61 | .BI " unsigned * " outputlen ");" |
|---|
| 62 | |
|---|
| 63 | .fi |
|---|
| 64 | .SH DESCRIPTION |
|---|
| 65 | |
|---|
| 66 | .B sasl_encode |
|---|
| 67 | encodes data to be sent to be sent to a remote host who we've had a successful authentication session with. If there is a negotiated security the data in signed/encrypted and the output should be sent without modification to the remote host. If there is no security layer the output is identical to the input. |
|---|
| 68 | |
|---|
| 69 | .B sasl_encodev |
|---|
| 70 | does the same, but for a struct iovec instead of a character buffer. |
|---|
| 71 | |
|---|
| 72 | .I output |
|---|
| 73 | contains the encoded data and is allocated/freed by the library. |
|---|
| 74 | |
|---|
| 75 | .SH "RETURN VALUE" |
|---|
| 76 | Returns SASL_OK on success. See sasl_errors(3) for meanings of other return |
|---|
| 77 | codes. |
|---|
| 78 | |
|---|
| 79 | .SH "CONFORMING TO" |
|---|
| 80 | RFC 2222 |
|---|
| 81 | .SH "SEE ALSO" |
|---|
| 82 | sasl(3), sasl_errors(3), sasl_decode(3) |
|---|
