← Back
Editing: sasl_getprop.3
.\" Man page generated from reStructuredText. . .TH "SASL_GETPROP" "3" "February 18, 2022" "2.1.28" "Cyrus SASL" .SH NAME sasl_getprop \- 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 .. .SH SYNOPSIS .sp .nf #include <sasl/sasl.h> int sasl_getprop(sasl_conn_t *conn, int propnum, const void ** pvalue); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getprop(sasl_conn_t *conn, .TP .B int propnum, .TP .B const void ** pvalue); \fBsasl_getprop\fP gets the value of a SASL property. For example after successful authentication a server may wish to know the authorization name. Or a client application may wish to know the strength of the negotiated security layer. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBpropnum\fP – is the identifier for the property requested .IP \(bu 2 \fBpvalue\fP – .sp is filled on success. List of properties: .INDENT 2.0 .IP \(bu 2 SASL_USERNAME ‐ pointer to NUL terminated user name .IP \(bu 2 .INDENT 2.0 .TP .B SASL_SSF ‐ security layer security strength factor, if 0, call to sasl_encode(3), sasl_decode(3) unnecessary .UNINDENT .IP \(bu 2 SASL_MAXOUTBUF ‐ security layer max output buf unsigned .IP \(bu 2 SASL_DEFUSERREALM ‐ server authentication realm used .IP \(bu 2 SASL_GETOPTCTX ‐ context for getopt callback .IP \(bu 2 SASL_IPLOCALPORT ‐ local address string .IP \(bu 2 SASL_IPREMOTEPORT ‐ remote address string .IP \(bu 2 SASL_SERVICE ‐ service passed to \fIsasl_*_new\fP .IP \(bu 2 SASL_SERVERFQDN ‐ serverFQDN passed to \fIsasl_*_new\fP .IP \(bu 2 .INDENT 2.0 .TP .B SASL_AUTHSOURCE ‐ name of auth source last used, useful for failed authentication tracking .UNINDENT .IP \(bu 2 SASL_MECHNAME ‐ active mechanism name, if any .IP \(bu 2 SASL_PLUGERR ‐ similar to \fIsasl_errdetail\fP .UNINDENT .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_OK\fP indicates success. .sp Other return codes indicate errors and should be handled. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_errors(3) sasl_server_new(3), sasl_client_new(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .
Save File
Cancel