Edit File: sasl_canon_user_t.3
.\" Man page generated from reStructuredText. . .TH "SASL_CANON_USER_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_canon_user_t \- Cyrus SASL documentation . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. . .nr rst2man-indent-level 0 . .de1 rstReportMargin \\$1 \\n[an-margin] level \\n[rst2man-indent-level] level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] - \\n[rst2man-indent0] \\n[rst2man-indent1] \\n[rst2man-indent2] .. .de1 INDENT .\" .rstReportMargin pre: . RS \\$1 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] . nr rst2man-indent-level +1 .\" .rstReportMargin post: .. .de UNINDENT . RE .\" indent \\n[an-margin] .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] .nr rst2man-indent-level -1 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] .in \\n[rst2man-indent\\n[rst2man-indent-level]]u .. .SH SYNOPSIS .sp .nf #include <sasl/sasl.h> int sasl_canon_user_t(sasl_conn_t *conn, void *context, const char *user, unsigned ulen, unsigned flags, const char *user_realm, char *out_user, unsigned out_umax, unsigned *out_ulen) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_canon_user_t(sasl_conn_t *conn, .TP .B void *context, .TP .B const char *user, .TP .B unsigned ulen, .TP .B unsigned flags, .TP .B const char *user_realm, .TP .B char *out_user, .TP .B unsigned out_umax, .TP .B unsigned *out_ulen) \fBsasl_canon_user_t\fP is the callback for an application\-supplied user canonicalization function. This function is subject to the requirements that all user canonicalization functions are: It must copy the result into the output buffers, but the output buffers and the input buffers may be the same. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcontext\fP – context from the callback record .IP \(bu 2 \fBuser\fP – un\-canonicalized username .IP \(bu 2 \fBulen\fP – length of user .IP \(bu 2 \fBflags\fP – Either SASL_CU_AUTHID (indicating the authentication ID is being canonicalized) or SASL_CU_AUTHZID (indicating the authorization ID is to be canonicalized) or a bitwise OR of the the two. .IP \(bu 2 \fBuser_realm\fP – Realm of authentication. .IP \(bu 2 \fBout_user\fP – The output buffer for the canonicalized username .IP \(bu 2 \fBout_umax\fP – Maximum length for out_user .IP \(bu 2 \fBout_ulen\fP – Actual length of out_user .UNINDENT .TP .B Returns \fBSASL_OK\fP indicates success. See sasl_errors(3) for a full list of SASL error codes. .UNINDENT .UNINDENT .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3), sasl_errors(3), sasl_callbacks(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .
Back to File Manager