Wala shell

Advanced PHP File Manager

Server IP: 127.0.0.1 | PHP Version: 8.3.30 | Domains Hosted: 54

Name	Size	Last Modified
📁 ..	-	2026-03-31 19:08
📄 sasl.3 .\" Man page generated from reStructuredText. . .TH "SASL" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl \- 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 DESCRIPTION .sp The CMU Cyrus SASL library is a general purpose authentication library for sever and client applications. .sp \fBSystem Administrators\fP .sp For information on setting up/configuring the SASL library see the System Administrators Guide: \fI\%https://www.cyrusimap.org/sasl/sasl/sysadmin.html\fP .sp \fBProgrammers\fP .sp See man pages for individual sasl functions or the Programmers Guide in the doc/ directory of the SASL distribution. .sp Conforming to \fI\%RFC 2222\fP .SH SEE ALSO .sp sasl_authorize_t(3), sasl_auxprop(3), sasl_auxprop_getctx(3), sasl_auxprop_request(3), sasl_canon_user_t(3), sasl_callbacks(3), sasl_chalprompt_t(3), sasl_checkapop(3), sasl_checkpass(3), sasl_client_init(3), sasl_client_new(3), sasl_client_start(3), sasl_client_step(3), sasl_decode(3), sasl_dispose(3), sasl_done(3), sasl_encode(3), sasl_encodev(3), sasl_errdetail(3), sasl_errors(3), sasl_errstring(3), sasl_errors(3), sasl_getopt_t(3), sasl_getpath_t(3), sasl_getprop(3), sasl_getrealm_t(3), sasl_getsecret_t(3), sasl_getsimple_t(3), sasl_idle(3), sasl_listmech(3), sasl_log_t(3), sasl_server_init(3), sasl_server_new(3), sasl_server_start(3), sasl_server_step(3), sasl_server_userdb_checkpass_t(3), sasl_server_userdb_setpass_t(3), sasl_setpass(3), sasl_setprop(3), sasl_user_exists(3), sasl_verifyfile_t(3), sasl_global_listmech(3) .SH REFERENCED BY .sp ldap.conf(5), overload(3), sasl_getconfpath_t(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.87 KB	2024-07-15 12:36
📄 sasl_authorize_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_AUTHORIZE_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_authorize_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_authorize_t(void context, const char requested_user, unsigned alen, const char auth_identity, unsigned alen, const char def_realm, unsigned urlen, struct propctx *propctx) .fi .SH DESCRIPTION .sp \fBsasl_authorize_t\fP is used to check whether the authorized user auth_identity may act as the user requested_user. For example the user root may wish to authenticate with his credentials but act as the user mmercer (with all of mmercer’s rights not roots). A server application should be very careful, and probably err on the side of caution, when determining which users may proxy as whom. .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_OK\fP indicates success. .SH SEE ALSO .sp sasl(3), sasl_callbacks(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.42 KB	2024-07-15 12:36
📄 sasl_auxprop.3 .\" Man page generated from reStructuredText. . .TH "SASL_AUXPROP" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_auxprop \- 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/prop.h> struct propctx prop_new(unsigned estimate) int prop_dup(struct propctx src_ctx, struct propctx dst_ctx) int prop_request(struct propctx ctx, const char *names) const struct propval prop_get(struct propctx ctx) int prop_getnames(struct propctx ctx, const char *names, struct propval vals) void prop_clear(struct propctx ctx, int requests) void prop_erase(struct propctx ctx, const char name) void prop_dispose(struct propctx ctx) int prop_format(struct propctx ctx, const char sep, int seplen, char outbuf, unsigned outmax, unsigned outlen) int prop_set(struct propctx ctx, const char name, const char value, int vallen) int prop_setvals(struct propctx ctx, const char name, const char *values) .fi .SH DESCRIPTION .sp SASL auxiliary properties are used to obtain properties from external sources during the authentication process. For example, a mechanism might need to query an LDAP server to obtain the authentication secret. The application probably needs other information from there as well, such as home directory or UID. The auxiliary property interface allows the two to cooperate, and only results in a single query against the LDAP server (or other property sources). .sp Property lookups take place directly after user canonicalization occurs. Therefore, all requests should be registered with the context before that time. Note that requests can also be registered using the sasl_auxprop_request(3) function. Most of the functions listed below, however, require a property context which can be obtained by calling sasl_auxprop_getctx(3)\&. .SH API DESCRIPTION .INDENT 0.0 .TP .B struct \fI\%propctx\fP prop_new(unsigned\fI\ estimate\fP) Create a new property context. Probably unnecessary for application developers to call this at any point. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBestimate\fP – is the estimate of storage needed in total for requests & responses. A value of 0 implies the library default. .UNINDENT .TP .B Returns a new property context: \fI\%propctx\fP .UNINDENT .UNINDENT .INDENT 0.0 .TP .B int prop_dup(struct \fI\%propctx\fP\fI\ src_ctx\fP, struct \fI\%propctx\fP\fI\ dst_ctx\fP) Duplicate a given property context. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBsrc_ctx\fP (\fI\%propctx\fP) – Property context to copy. .IP \(bu 2 \fBdst_ctx\fP (\fI\%propctx\fP) – Destination context to copy into. .UNINDENT .TP .B Returns SASL error code. .UNINDENT .UNINDENT .INDENT 0.0 .TP .B int prop_request(struct \fI\%propctx\fP\fI\ ctx\fP, const char\fI\ names\fP) Add properties to the request list of a given context. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to add add the request list to. .IP \(bu 2 \fBnames\fP – is the NULL\-terminated array of property names, and must persist until the requests are cleared or the context is disposed of with a call to \fI\%prop_dispose()\fP\&. .UNINDENT .TP .B Returns SASL error code .UNINDENT .UNINDENT .INDENT 0.0 .TP .B const struct \fI\%propval\fP prop_get(struct \fI\%propctx\fP\fI\ ctx\fP) Fetch out the property values from a context. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to fetch from. .UNINDENT .TP .B Returns a NULL\-terminated array of property values from the given context. .UNINDENT .UNINDENT .INDENT 0.0 .TP .B int prop_getnames(struct \fI\%propctx\fP\fI\ ctx\fP, const char\fI\ *names\fP, struct \fI\%propval\fP\fI\ vals\fP) Fill in a (provided) array of property values based on a list of property names. This implies that the \fBvals\fP array is at least as long as the \fBnames\fP array. The values that are filled in by this call persist until next call to \fI\%prop_request()\fP, \fI\%prop_clear()\fP, or \fI\%prop_dispose()\fP on context. If a name specified here was never requested, then its associated values entry will be set to NULL. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to fill in. .UNINDENT .TP .B Returns number of matching properties that were found, or a SASL error code. .UNINDENT .UNINDENT .INDENT 0.0 .TP .B void prop_clear(struct \fI\%propctx\fP\fI\ ctx\fP, int\fI\ requests\fP) Clear values and (optionally) requests from a property context. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to clear. .IP \(bu 2 \fBrequests\fP – set to 1 if the requests should be cleared, 0 otherwise. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B void prop_erase(struct \fI\%propctx\fP\fI\ ctx\fP, const char\fI\ name\fP) Securely erase the value of a property from a context. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to find the property in. .IP \(bu 2 \fBname\fP – is the name of the property to erase. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B void prop_dispose(struct \fI\%propctx\fP\fI\ ctx\fP) Disposes of a property context and NULLifys the pointer. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to clear. .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B int prop_format(struct \fI\%propctx\fP\fI\ ctx\fP, const char\fI\ sep\fP, int\fI\ seplen\fP, char\fI\ outbuf\fP, unsigned\fI\ outmax\fP, unsigned\fI\ outlen\fP) Format the requested property names into a string. This not intended for use by the application (\fIonly by auxprop plugins\fP). .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to extract values from. .IP \(bu 2 \fBsep\fP – the separator to use for the string .IP \(bu 2 \fBoutbuf\fP – destination string. Caller must allocate the buffer of length \fBoutmax\fP (including NUL terminator). .IP \(bu 2 \fBoutlen\fP – if non\-NULL, will contain the length of the resulting string (excluding NUL terminator). .UNINDENT .TP .B Returns SASL error code. .UNINDENT .UNINDENT .INDENT 0.0 .TP .B int prop_set(struct \fI\%propctx\fP\fI\ ctx\fP, const char\fI\ name\fP, const char\fI\ value\fP, int\fI\ vallen\fP) Adds a property value to the context. \fIThis is intended for use by auxprop plugins only.\fP .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to add a value to. .IP \(bu 2 \fBname\fP – the name of the property to receive the new value, or NULL, which implies that the value will be added to the same property as the last call to either \fI\%prop_set()\fP or \fI\%prop_setvals()\fP\&. .IP \(bu 2 \fBvalue\fP – the new value (of length \fIvallen\fP) .IP \(bu 2 \fBvallen\fP – the length of the string \fIvalue\fP\&. .UNINDENT .TP .B Returns SASL error code .UNINDENT .UNINDENT .INDENT 0.0 .TP .B int prop_setvals(struct \fI\%propctx\fP\fI\ ctx\fP, const char\fI\ name\fP, const char\fI\ *values\fP) Adds multiple values to a single property. \fIThis is intended for use by auxprop plugins only\fP\&. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBctx\fP (\fI\%propctx\fP) – The property context to add values to. .IP \(bu 2 \fBname\fP – The name of the property to receive the new value, or NULL, which implies that the values will be added to the same property as the last call to either \fI\%prop_set()\fP or \fI\%prop_setvals()\fP\&. .IP \(bu 2 \fBvalues\fP – A NULL\-terminated array of values to be added the property. .UNINDENT .TP .B Returns SASL error code .UNINDENT .UNINDENT .SH DATA STRUCTURES .INDENT 0.0 .TP .B propval A struct holding a name and its property values. A name can have zero or more values. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBname\fP – \fBconst char \fP\&. Name of this propval. NULL means end of list. .IP \(bu 2 \fBvalues\fP – \fBconst char *\fP\&. List of string values. If property not found, values == NULL. If property found with no values, then values == NULL .UNINDENT .UNINDENT .UNINDENT .INDENT 0.0 .TP .B propctx A property context. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBvalues\fP (\fI\%propval\fP *) – List of property values in this context. .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp The property functions that return an int return SASL error codes. See sasl_errors(3)\&. Those that return pointers will return a valid pointer on success, or NULL on any error. .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3), sasl_errors(3), sasl_auxprop_request(3), sasl_auxprop_getctx(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	10.01 KB	2024-07-15 12:36
📄 sasl_auxprop_getctx.3 .\" Man page generated from reStructuredText. . .TH "SASL_AUXPROP_GETCTX" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_auxprop_getctx \- 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_auxprop_getctx(sasl_conn_t conn) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_auxprop_getctx(\fI\%sasl_conn_t\fP\fI\ conn\fP) Fetches an auxiliary property context for the connection on which the functions described in sasl_auxprop(3) can operate. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – pointer to the \fI\%sasl_conn_t\fP for which the request is being made. .UNINDENT .TP .B Returns A pointer to the context on success. Returns NULL on failure. .UNINDENT .UNINDENT .INDENT 0.0 .TP .B sasl_conn_t Context for a SASL connection negotiation .UNINDENT .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3), sasl_auxprop(3), sasl_auxprop_request(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.24 KB	2024-07-15 12:36
📄 sasl_auxprop_request.3 .\" Man page generated from reStructuredText. . .TH "SASL_AUXPROP_REQUEST" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_auxprop_request \- 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_auxprop_request(sasl_conn_t conn, const char * propnames) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_auxprop_request(sasl_conn_t\fI\ conn\fP, const char *\fI\ propnames\fP) \fBsasl_auxprop_request\fP will request that the SASL library obtain properties from any auxiliary property plugins that might be installed (such as the user’s home directory from an LDAP server for example). Such lookup occurs just after username canonicalization is complete. Therefore, the request should be made before the call to sasl_server_start(3), but after the call to sasl_server_new(3)\&. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – the \fBsasl_conn_t\fP for which the request is being made. .IP \(bu 2 \fBpropnames\fP – a NULL\-terminated array of property names to request. Note that this array must persist until a call to sasl_dispose(3) on the \fBsasl_conn_t\fP\&. .UNINDENT .TP .B Returns Returns \fBSASL_OK\fP on success. See sasl_errors(3) for meanings of other return codes. .UNINDENT .UNINDENT .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3), sasl_errors(3), sasl_auxprop(3), sasl_auxprop_getctx(3), sasl_server_new(3), sasl_server_start(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.73 KB	2024-07-15 12:36
📄 sasl_callbacks.3 .\" Man page generated from reStructuredText. . .TH "SASL_CALLBACKS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_callbacks \- 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> .fi .SH DESCRIPTION .sp \fBsasl_callbacks\fP are used when the application needs some information from the application. Common reasons are getting for getting usernames and passwords. A client MUST specify what callbacks they support in the sasl_client_init(3)/sasl_server_init(3) or sasl_client_new(3)/sasl_server_new(3) calls. If an authentication mechanism needs a callback that the application does not state it supports it cannot be used. .sp If a callback has an id parameter that should be checked to make sure you are giving the appropriate value. .sp If an application is using the client side of the library functions to handle the callbacks are not necessary. Instead the application may deal with callbacks via SASL_INTERACT’s. See sasl_client_start(3)/sasl_client_step(3) for more information. .SS Common Callbacks .INDENT 0.0 .TP .B sasl_getopt_t Get an option value .TP .B sasl_log_t Log message handler .TP .B sasl_getpath_t Get path to search for plugins (e.g. SASL mechanisms) .TP .B sasl_verifyfile_t Verify files for use by SASL .TP .B sasl_canon_user_t(3) Username canonicalization function .UNINDENT .SS Client\-only Callbacks .INDENT 0.0 .TP .B sasl_getsimple_t Get user/language list .TP .B sasl_getsecret_t Get authentication secret .TP .B sasl_chalprompt_t(3) Display challenge and prompt for response .TP .B sasl_getrealm_t Get the realm for authentication .UNINDENT .SS Server\-only Callbacks .INDENT 0.0 .TP .B sasl_authorize_t(3) Authorize policy callback .TP .B sasl_server_userdb_checkpass_t verify plaintext password .TP .B sasl_server_userdb_setpass_t set plaintext password .TP .B sasl_getconfpath_t Get path to search for SASL configuration file (server side only). New in SASL 2.1.22. .UNINDENT .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl_errors(3) for a complete list. \fBSASL_OK\fP typically indicates success. .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3), sasl_errors(3), sasl_authorize_t(3), sasl_log_t(3), sasl_getpath_t(3), sasl_getconfpath_t(3), sasl_verifyfile_t(3), sasl_canon_user_t(3), sasl_getsimple_t(3), sasl_getsecret_t(3), sasl_chalprompt_t(3), sasl_getrealm_t(3), sasl_server_userdb_checkpass_t(3), sasl_server_userdb_setpass_t(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.8 KB	2024-07-15 12:36
📄 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. .	3.23 KB	2024-07-15 12:36
📄 sasl_chalprompt_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_CHALPROMPT_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_chalprompt_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/prop.h> int sasl_chalprompt_t(void context, int id, const char challenge, const char prompt, const char defresult, const char *result, unsigned len) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_chalprompt_t(void context, .TP .B int id, .TP .B const char challenge, .TP .B const char prompt, .TP .B const char defresult, .TP .B const char *result, .TP .B unsigned len) \fBsasl_chalprompt_t\fP is used to prompt for input in response to a server challenge. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcontext\fP – is the context from the callback record .IP \(bu 2 \fBid\fP – is the callback id (either SASL_CB_ECHOPROMPT or SASL_CB_NOECHOPROMPT) .IP \(bu 2 \fBchallenge\fP – the server’s challenge .IP \(bu 2 \fBprompt\fP – A prompt for the user .IP \(bu 2 \fBdefresult\fP – Default result (may be NULL) .IP \(bu 2 \fBlen\fP – Length of the user’s response. .UNINDENT .TP .B Result The user’s response (a NUL terminated string) or SASL error code. .UNINDENT .UNINDENT .SH RETURN VALUE .sp The user’s response (NUL terminated), or a SASL error code. See sasl_errors(3)\&. .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. .	2.71 KB	2024-07-15 12:36
📄 sasl_checkapop.3 .\" Man page generated from reStructuredText. . .TH "SASL_CHECKAPOP" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_checkapop \- 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_checkapop(sasl_conn_t conn, const char challenge, unsigned challen, const char response, unsigned resplen) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_checkapop(sasl_conn_t conn, .TP .B const char challenge, .TP .B unsigned challen, .TP .B const char response, .TP .B unsigned resplen) \fBsasl_checkapop\fP will check an APOP challenge/response. APOP is an optional POP3 (\fI\%RFC 1939\fP) authentication command which uses a shared secret (password). The password is stored in the SASL secrets database. For information on the SASL shared secrets database see the System Administrators Guide\&. .sp If called with a NULL challenge, sasl_checkapop() will check to see if the APOP mechanism is enabled. .UNINDENT .SH RETURN VALUE .sp sasl_checkapop returns an integer which corresponds to one of the following codes. \fBSASL_OK\fP indicates that the authentication is complete. All other return codes indicate errors and should either be handled or the authentication session should be quit. See sasl_errors(3) for meanings of return codes. .SH CONFORMING TO .sp \fI\%RFC 4422\fP, \fI\%RFC 1939\fP .SH SEE ALSO .sp sasl(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.77 KB	2024-07-15 12:36
📄 sasl_checkpass.3 .\" Man page generated from reStructuredText. . .TH "SASL_CHECKPASS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_checkpass \- 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_checkpass(sasl_conn_t conn, const char user, unsigned userlen, const char pass, unsigned passlen); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_checkpass(sasl_conn_t conn, .TP .B const char user, .TP .B unsigned userlen, .TP .B const char pass, .TP .B unsigned passlen) \fBsasl_checkpass\fP will check a plaintext password. This is needed for protocols that had a login method before SASL (for example the LOGIN command in IMAP). The password is checked with the pwcheck_method. See sasl_callbacks(3) for information on how this parameter is set. .UNINDENT .SH RETURN VALUE .sp sasl_checkpass returns an integer which corresponds to one of the following codes. \fBSASL_OK\fP indicates that the authentication is complete. All other return codes indicate errors and should either be handled or the authentication session should be quit. See sasl_errors(3) for meanings of return codes. .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3), sasl_errors(3), sasl_callbacks(3), sasl_setpass(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.62 KB	2024-07-15 12:36
📄 sasl_client_init.3 .\" Man page generated from reStructuredText. . .TH "SASL_CLIENT_INIT" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_client_init \- 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_client_init(const sasl_callback_t *callbacks ) .fi .SH DESCRIPTION .sp \fBsasl_client_init\fP initializes SASL. .sp It must be called before any calls to sasl_client_start(3)\&. This call initializes all SASL client drivers (e.g. authentication mechanisms). These are usually found in the \fI/usr/lib/sasl2\fP directory but the directory may be overridden with the \fISASL_PATH\fP environment variable. .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 The following return codes indicate errors and should either be handled or the authentication session should be quit: .INDENT 0.0 .IP \(bu 2 \fBSASL_BADVERS\fP: Mechanism version mismatch .IP \(bu 2 \fBSASL_BADPARAM\fP: Error in config file .IP \(bu 2 \fBSASL_NOMEM\fP: Not enough memory to complete operation .UNINDENT .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_client_new(3), sasl_client_start(3), sasl_client_step(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.56 KB	2024-07-15 12:36
📄 sasl_client_new.3 .\" Man page generated from reStructuredText. . .TH "SASL_CLIENT_NEW" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_client_new \- 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_client_new(const char service, const char serverFQDN, const char iplocalport, const char ipremoteport, const sasl_callback_t prompt_supp, unsigned flags, sasl_conn_t * pconn); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_client_new(const char service, .TP .B const char serverFQDN, .TP .B const char iplocalport, .TP .B const char ipremoteport, .TP .B const sasl_callback_t prompt_supp, .TP .B unsigned flags, .TP .B sasl_conn_t * pconn); \fBsasl_client_new()\fP creates a new SASL context. This context will be used for all SASL calls for one connection. It handles both authentication and integrity/encryption layers after authentication. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBservice\fP – the registered name of the service (usually the protocol name) using SASL (e.g. “imap”). .IP \(bu 2 \fBserverFQDN\fP – the fully qualified domain name of the server (e.g. “serverhost.example.com”). .IP \(bu 2 \fBiplocalport\fP – the IP and port of the local side of the connection, or NULL. If iplocalport is NULL it will disable mechanisms that require IP address information. This string must be in one of the following formats: “a.b.c.d;port” (IPv4), “e:f:g:h:i:j:k:l;port” (IPv6), or “e:f:g:h:i:j:a.b.c.d;port” (IPv6) .IP \(bu 2 \fBipremoteport\fP – the IP and port of the remote side of the connection, or NULL (see iplocalport) .IP \(bu 2 \fBprompt_supp\fP – a list of client interactions supported that is unique to this connection. If this parameter is NULL the global callbacks (specified in sasl_client_init(3)) will be used. See sasl_callbacks(3) for more information. .IP \(bu 2 \fBflags\fP – are connection flags (see below) .IP \(bu 2 \fBpconn\fP – the connection context allocated by the library. This structure will be used for all future SASL calls for this connection. .UNINDENT .UNINDENT .UNINDENT .SS Connection Flags .sp Flags that may be passed to \fBsasl_client_new()\fP: .INDENT 0.0 .IP \(bu 2 \fISASL_SUCCESS_DATA\fP: The protocol supports a server‐last send .IP \(bu 2 .INDENT 2.0 .TP .B \fISASL_NEED_PROXY\fP: Force the use of a mechanism that supports an authorization id that is not the authentication id. .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 The following return codes indicate errors and should either be handled or the authentication session should be quit: .INDENT 0.0 .IP \(bu 2 \fBSASL_NOMECH\fP: No mechanism meets requested properties .IP \(bu 2 \fBSASL_BADPARAM\fP: Error in config file .IP \(bu 2 \fBSASL_NOMEM\fP: Not enough memory to complete operation .UNINDENT .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_client_init(3), sasl_client_start(3), sasl_client_step(3), sasl_setprop(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	4.47 KB	2024-07-15 12:36
📄 sasl_client_start.3 .\" Man page generated from reStructuredText. . .TH "SASL_CLIENT_START" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_client_start \- 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_client_start(sasl_conn_t * conn, const char * mechlist, sasl_interact_t prompt_need, const char clientout, unsigned * clientoutlen, const char ** mech); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_client_start(sasl_conn_t * conn, .TP .B const char * mechlist, .TP .B sasl_interact_t prompt_need, .TP .B const char clientout, .TP .B unsigned * clientoutlen, .TP .B const char ** mech); \fBsasl_client_start()\fP selects a mechanism for authentication and starts the authentication session. The mechlist is the list of mechanisms the client might like to use. The mech‐ anisms in the list are not necessarily supported by the client or even valid. SASL determines which of these to use based upon the security preferences specified earlier. The list of mechanisms is typically a list of mechanisms the server supports acquired from a capability request. .sp If \fBSASL_INTERACT\fP is returned the library needs some values to be filled in before it can proceed. The \fIprompt_need\fP structure will be filled in with requests. The application should fulfill these requests and call sasl_client_start again with identical parameters (the \fIprompt_need\fP parameter will be the same pointer as before but filled in by the application). .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBmechlist\fP – is a list of mechanisms the server has available. Punctuation is ignored. .IP \(bu 2 \fBprompt_need\fP – is filled in with a list of prompts needed to continue (if necessary). .IP \(bu 2 \fBclientout\fP – .sp is created. It is the initial client response to send to the server. It is the job of the client to send it over the network to the server. Any protocol specific encoding (such as base64 encoding) necessary needs to be done by the client. .sp If the protocol lacks client‐send‐first capability, then set clientout to NULL. .sp If there is no initial client‐send, then *clientout will be set to NULL on return. .IP \(bu 2 \fBclientoutlen\fP – length of \fIclientout\fP\&. .IP \(bu 2 \fBmech\fP – contains the name of the chosen SASL mechanism (on success) .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_CONTINUE\fP indicates success and that there are more steps needed in the authentication. .sp Other return codes indicate errors and should either be handled or the authentication session should be quit. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_client_init(3), sasl_client_new(3), sasl_client_step(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	4.23 KB	2024-07-15 12:36
📄 sasl_client_step.3 .\" Man page generated from reStructuredText. . .TH "SASL_CLIENT_STEP" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_client_step \- 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_client_step(sasl_conn_t conn, const char serverin, unsigned serverinlen, sasl_interact_t prompt_need, const char clientout, unsigned * clientoutlen); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_client_step(sasl_conn_t conn, .TP .B const char serverin, .TP .B unsigned serverinlen, .TP .B sasl_interact_t prompt_need, .TP .B const char clientout, .TP .B unsigned * clientoutlen); \fBsasl_client_step()\fP performs a step in the authentication negotiation. It returns \fBSASL_OK\fP if the whole negotiation is successful and \fBSASL_CONTINUE\fP if this step is ok but at least one more step is needed. A client should not assume an authentication negotiation is successful just because the server signaled success via protocol (i.e. if the server said “. OK Authentication succeeded” in IMAP, sasl_client_step should still be called one more time with a \fIserverinlen\fP of zero. .sp If \fBSASL_INTERACT\fP is returned the library needs some values to be filled in before it can proceed. \fIThe prompt_need\fP structure will be filled in with requests. The application should fulfill these requests and call sasl_client_start again with identical parameters (the \fIprompt_need\fP parameter will be the same pointer as before but filled in by the application). .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBserverin\fP – is the data given by the server (decoded if the protocol encodes requests sent over the wire) .IP \(bu 2 \fBserverinlen\fP – is the length of \fIserverin\fP .IP \(bu 2 \fBclientout\fP – is created. It is the initial client response to send to the server. It is the job of the client to send it over the network to the server. Any protocol specific encoding (such as base64 encoding) nec‐ essary needs to be done by the client. .IP \(bu 2 \fBclientoutlen\fP – length of \fIclientout\fP\&. .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_CONTINUE\fP indicates success and that there are more steps needed in the authentication. \fBSASL_OK\fP indicates that the authentication is complete. .sp Other return codes indicate errors and should either be handled or the authentication session should be quit. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_client_init(3), sasl_client_new(3), sasl_client_start(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	4.09 KB	2024-07-15 12:36
📄 sasl_decode.3 .\" Man page generated from reStructuredText. . .TH "SASL_DECODE" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_decode \- 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_decode(sasl_conn_t conn, const char input, unsigned inputlen, const char ** output, unsigned * outputlen); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_decode(sasl_conn_t conn, .TP .B const char input, .TP .B unsigned inputlen, .TP .B const char ** output, .TP .B unsigned * outputlen); \fBsasl_decode\fP decodes data received. After successful authentication this function should be called on all data received. It decodes the data from encrypted or signed form to plain data. If there was no security layer negotiated the \fIoutput\fP is identical to the \fIinput\fP\&. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBoutput\fP – contains the decoded data and is allocated/freed by the library. .IP \(bu 2 \fBoutputlen\fP – length of \fIoutput\fP\&. .UNINDENT .UNINDENT .sp One should not give sasl_decode more data than the negotiated \fImaxbufsize\fP (see sasl_getprop(3)). .sp Note that sasl_decode can succeed and outputlen can be zero. If this is the case simply wait for more data and call sasl_decode again. .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_encode(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3 KB	2024-07-15 12:36
📄 sasl_dispose.3 .\" Man page generated from reStructuredText. . .TH "SASL_DISPOSE" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_dispose \- 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> void sasl_dispose(sasl_conn_t *pconn ); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_encode(sasl_conn_t conn, .TP .B const char * input, .TP .B unsigned inputlen, .TP .B const char ** output, .TP .B unsigned * outputlen); \fBsasl_dispose\fP is called when a SASL connection object is no longer needed. .sp Note that this is usually when the protocol session is done NOT when the authentication is done since a security layer may have been negotiated. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp No return values .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(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. .	2.25 KB	2024-07-15 12:36
📄 sasl_done.3 .\" Man page generated from reStructuredText. . .TH "SASL_DONE" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_done \- 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> void sasl_done( void ); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B void sasl_done( void ); \fBsasl_done()\fP is called when the application is completely done with the SASL library. .UNINDENT .SH RETURN VALUE .sp No return values. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_server_init(3), sasl_client_init(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	1.86 KB	2024-07-15 12:36
📄 sasl_encode.3 .\" Man page generated from reStructuredText. . .TH "SASL_ENCODE" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_encode \- 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_encode(sasl_conn_t conn, const char input, unsigned inputlen, const char ** output, unsigned * outputlen); int sasl_encodev(sasl_conn_t conn, const struct iovec invec, unsigned numiov, const char ** output, unsigned * outputlen); .fi .SH DESCRIPTION .sp \fBsasl_encode\fP 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. .sp \fBsasl_encodev\fP does the same, but for a \fIstruct iovec\fP instead of a character buffer. .INDENT 0.0 .TP .B int sasl_encode(sasl_conn_t conn, .TP .B const char input, .TP .B unsigned inputlen, .TP .B const char ** output, .TP .B unsigned * outputlen); .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBoutput\fP – contains the decoded data and is allocated/freed by the library. .IP \(bu 2 \fBoutputlen\fP – length of \fIoutput\fP\&. .UNINDENT .UNINDENT .INDENT 7.0 .TP .B int sasl_encodev(sasl_conn_t conn, .TP .B const struct iovec invec, .TP .B unsigned numiov, .TP .B const char ** output, .TP .B unsigned * outputlen); .UNINDENT .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBoutput\fP – contains the decoded data and is allocated/freed by the library. .IP \(bu 2 \fBoutputlen\fP – length of \fIoutput\fP\&. .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_decode(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.53 KB	2024-07-15 12:36
📄 sasl_encodev.3 .\" Man page generated from reStructuredText. . .TH "SASL_ENCODEV" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_encodev \- 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_encode(sasl_conn_t conn, const char input, unsigned inputlen, const char ** output, unsigned * outputlen); int sasl_encodev(sasl_conn_t conn, const struct iovec invec, unsigned numiov, const char ** output, unsigned * outputlen); .fi .SH DESCRIPTION .sp \fBsasl_encode\fP 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. .sp \fBsasl_encodev\fP does the same, but for a \fIstruct iovec\fP instead of a character buffer. .INDENT 0.0 .TP .B int sasl_encode(sasl_conn_t conn, .TP .B const char input, .TP .B unsigned inputlen, .TP .B const char ** output, .TP .B unsigned * outputlen); .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBoutput\fP – contains the decoded data and is allocated/freed by the library. .IP \(bu 2 \fBoutputlen\fP – length of \fIoutput\fP\&. .UNINDENT .UNINDENT .INDENT 7.0 .TP .B int sasl_encodev(sasl_conn_t conn, .TP .B const struct iovec invec, .TP .B unsigned numiov, .TP .B const char ** output, .TP .B unsigned * outputlen); .UNINDENT .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBoutput\fP – contains the decoded data and is allocated/freed by the library. .IP \(bu 2 \fBoutputlen\fP – length of \fIoutput\fP\&. .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_decode(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.53 KB	2024-07-15 12:36
📄 sasl_errdetail.3 .\" Man page generated from reStructuredText. . .TH "SASL_ERRDETAIL" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_errdetail \- 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> const char sasl_errdetail( sasl_conn_t conn ); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B const char sasl_errdetail( sasl_conn_t conn ); \fBsasl_errdetail\fP provides more detailed information about the most recent error to occur, beyond the information contained in the SASL result code. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – the SASL connection context to inquire about. .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp Returns the string describing the error that occurred, or NULL if no error has occurred, or there was an error retrieving it. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.18 KB	2024-07-15 12:36
📄 sasl_errors.3 .\" Man page generated from reStructuredText. . .TH "SASL_ERRORS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_errors \- 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> .fi .SH DESCRIPTION .sp The following are the general error codes that may be returned by calls into the SASL library, and their meanings (that may vary slightly based on context). .SS Common Result Codes .INDENT 0.0 .TP .B SASL_OK Success .UNINDENT .INDENT 0.0 .TP .B SASL_CONTINUE Another step is needed in authentication .UNINDENT .INDENT 0.0 .TP .B SASL_FAIL Generic Failure .UNINDENT .INDENT 0.0 .TP .B SASL_NOMEM Memory shortage failure .UNINDENT .INDENT 0.0 .TP .B SASL_BUFOVER Overflowed buffer .UNINDENT .INDENT 0.0 .TP .B SASL_NOMECH Mechanism not supported / No mechanisms matched requirements .UNINDENT .INDENT 0.0 .TP .B SASL_BADPROT Bad / Invalid Protocol or Protocol cancel .UNINDENT .INDENT 0.0 .TP .B SASL_NOTDONE Cannot request information / Not applicable until later in exchange .UNINDENT .INDENT 0.0 .TP .B SASL_BADPARAM Invalid Parameter Supplied .UNINDENT .INDENT 0.0 .TP .B SASL_TRYAGAIN Transient Failure (e.g. weak key) .UNINDENT .INDENT 0.0 .TP .B SASL_BADMAC Integrity Check Failed .UNINDENT .INDENT 0.0 .TP .B SASL_NOTINIT SASL library not initialized .UNINDENT .SS Client\-only Result Codes .INDENT 0.0 .TP .B SASL_INTERACT Needs user interaction .UNINDENT .INDENT 0.0 .TP .B SASL_BADSERV Server failed mutual authentication step .UNINDENT .INDENT 0.0 .TP .B SASL_WRONGMECH Mechanism does not support requested feature .UNINDENT .SS Server\-only Result Codes .INDENT 0.0 .TP .B SASL_BADAUTH Authentication Failure .UNINDENT .INDENT 0.0 .TP .B SASL_NOAUTHZ Authorization Failure .UNINDENT .INDENT 0.0 .TP .B SASL_TOOWEAK Mechanism too weak for this user .UNINDENT .INDENT 0.0 .TP .B SASL_ENCRYPT Encryption needed to use mechanism .UNINDENT .INDENT 0.0 .TP .B SASL_TRANS One time use of a plaintext password will enable requested mechanism for user .UNINDENT .INDENT 0.0 .TP .B SASL_EXPIRED Passphrase expired, must be reset .UNINDENT .INDENT 0.0 .TP .B SASL_DISABLED Account Disabled .UNINDENT .INDENT 0.0 .TP .B SASL_NOUSER User Not Found .UNINDENT .INDENT 0.0 .TP .B SASL_BADVERS Version mismatch with plug\-in .UNINDENT .INDENT 0.0 .TP .B SASL_NOVERIFY User exists, but no verifier for user .UNINDENT .SS Password Setting Result Codes .INDENT 0.0 .TP .B SASL_PWLOCK Passphrase locked .UNINDENT .INDENT 0.0 .TP .B SASL_NOCHANGE Requested change was not needed .UNINDENT .INDENT 0.0 .TP .B SASL_WEAKPASS Passphrase is too week for security policy. .UNINDENT .INDENT 0.0 .TP .B SASL_NOUSERPASS User supplied passwords are not permitted .UNINDENT .SH CONFORMING TO .sp \fI\%RFC 4422\fP .SH SEE ALSO .sp sasl(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	4.03 KB	2024-07-15 12:36
📄 sasl_errstring.3 .\" Man page generated from reStructuredText. . .TH "SASL_ERRSTRING" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_errstring \- 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> const char * sasl_errstring(int saslerr, const char * langlist, const char ** outlang); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B const char * sasl_errstring(int saslerr, .TP .B const char * langlist, .TP .B const char ** outlang); \fBsasl_errstring\fP is called to convert a SASL return code (an integer) into a human readable string. At this time the only language available is American English. Note that if the string is going to be sent to the client, a server should call sasl_usererr(3) on a return code first. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBsaslerr\fP – specifies the error number to convert. .IP \(bu 2 \fBlanglist\fP – is currently unused; Use NULL. .IP \(bu 2 \fBoutlang\fP – specifies the desired \fI\%RFC 1766\fP language for output. NULL defaults to “en‐us”; currently the only supported language. .UNINDENT .UNINDENT .sp This function is not the recommended means of extracting error code information from SASL, instead application should use sasl_errdetail(3), which contains this information (and more). .UNINDENT .SH RETURN VALUE .sp Returns the string. If langlist is NULL, US‐ASCII is used. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_errdetail(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.78 KB	2024-07-15 12:36
📄 sasl_getconfpath_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_GETCONFPATH_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_getconfpath_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_getconfpath_t(void context, char * path); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getconfpath_t(void context, char * path); \fBsasl_getconfpath_t()\fP is used if the application wishes to use a different location for the SASL configuration files. If this callback is not used SASL will either use the location in the environment variable SASL_CONF_PATH (provided we are not SUID or SGID) or \fI/etc/sasl2\fP by default. .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_callbacks(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.28 KB	2024-07-15 12:36
📄 sasl_getopt_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_GETOPT_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_getopt_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_getopt_t(void context, const char plugin_name, const char option, const char * result, unsigned * len); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getopt_t(void context, .TP .B const char plugin_name, .TP .B const char option, .TP .B const char * result, .TP .B unsigned * len); \fBsasl_getopt_t\fP is used to retrieve an option, often mechanism specific, from the application. An example of this is requesting what KERBEROS_V4 srvtab file to use. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcontext\fP – is the SASL connection context .IP \(bu 2 \fBplugin_name\fP – is the plugin this value is for. .IP \(bu 2 \fBoption\fP – is a string representing the option. A common option that all server applications should handle is the method for checking plaintext passwords. See the \fI\%administrators guide\fP for a full description of this option. .UNINDENT .UNINDENT .sp Memory management of options supplied by the getopt callback should be done by the application, however, any requested option must remain available until the callback is no longer valid. That is, when sasl_dispose(3) is called for a the connection it is associated with, or sasl_done(3) is called for global callbacks. .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_callbacks(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.11 KB	2024-07-15 12:36
📄 sasl_getpath_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_GETPATH_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_getpath_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_getpath_t(void context, char * path); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getpath_t(void context, char * path); \fBsasl_getpath_t()\fP is used if the application wishes to use a different location for the SASL mechanism drivers (the shared library files). If this callback is not used SASL will either use the location in the environment variable SASL_PATH or \fI/usr/lib/sasl2\fP by default. .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_callbacks(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.26 KB	2024-07-15 12:36
📄 sasl_getprop.3 .\" Man page generated from reStructuredText. . .TH "SASL_GETPROP" "3" "November 08, 2018" "2.1.27" "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 .. . .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. .	3.54 KB	2024-07-15 12:36
📄 sasl_getrealm_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_GETREALM_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_getrealm_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_getrealm_t(void context, int id, const char availrealms, const char result) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getrealm_t(void context, .TP .B int id, .TP .B const char availrealms, .TP .B const char result) \fBsasl_getrealm_t()\fP is used when there is an interaction with SASL_CB_GETREALM as the type. .sp If a mechanism would use this callback, but it is not present, then the first realm listed is automatically selected. (Note that a mechanism may still force the existence of a getrealm callback by SASL_CB_GETREALM to its required_prompts list). .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcontext\fP – context from the callback record .IP \(bu 2 \fBid\fP – callback ID (SASL_CB_GETREALM) .IP \(bu 2 \fBavailrealms\fP – A string list of the available realms. NULL terminated, may be empty. .IP \(bu 2 \fBresult\fP – The chosen realm. (a NUL terminated string) .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_callbacks(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.79 KB	2024-07-15 12:36
📄 sasl_getsecret_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_GETSECRET_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_getsecret_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_getsecret_t(sasl_conn_t conn, void context, int id, sasl_secret_t ** psecret); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getsecret_t(sasl_conn_t conn, .TP .B void context, .TP .B int id, .TP .B sasl_secret_t ** psecret); \fBsasl_getsecret_t()\fP is used to retrieve the secret from the application. A sasl_secret_t should be allocated to length \fIsizeof(sasl_secret_t) + <length of secret>\fP\&. It has two fields: \fIlen\fP which is the length of the secret in bytes and \fIdata\fP which contains the secret itself (does not need to be null terminated). .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .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_callbacks(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.58 KB	2024-07-15 12:36
📄 sasl_getsimple_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_GETSIMPLE_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_getsimple_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_getsimple_t(void context, int id, const char * result, unsigned * len); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_getsimple_t(void context, .TP .B int id, .TP .B const char * result, .TP .B unsigned * len); \fBsasl_getsimple_t\fP is used to retrieve simple things from the application. In practice this is authentication name, authorization name, and realm. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcontext\fP – SASL connection context .IP \(bu 2 \fBid\fP – .sp indicates which value is being requested. Possible values include: .INDENT 2.0 .IP \(bu 2 SASL_CB_USER ‐ Client user identity to login as .IP \(bu 2 SASL_CB_AUTHNAME ‐ Client authentication name .IP \(bu 2 SASL_CB_LANGUAGE ‐ Comma‐separated list of \fI\%RFC 1766\fP languages .IP \(bu 2 SASL_CB_CNONCE ‐ Client‐nonce (for testing mostly) .UNINDENT .IP \(bu 2 \fBresult\fP – value of the item requested .IP \(bu 2 \fBlen\fP – lenth of the result .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. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.82 KB	2024-07-15 12:36
📄 sasl_global_listmech.3 .\" Man page generated from reStructuredText. . .TH "SASL_GLOBAL_LISTMECH" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_global_listmech \- 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> const char sasl_global_listmech(); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B const char sasl_global_listmech(); \fBsasl_global_listmech\fP returns a null‐terminated array of strings that lists all mechanisms that are loaded by either the client or server side of the library. .UNINDENT .SH RETURN VALUE .sp Returns a pointer to the array on success. NULL on failure (sasl library uninitialized). .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_server_init(3), sasl_listmech(3), sasl_client_init(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.06 KB	2024-07-15 12:36
📄 sasl_idle.3 .\" Man page generated from reStructuredText. . .TH "SASL_IDLE" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_idle \- 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_idle( sasl_conn_t conn) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_idle(sasl_conn_t\fI\ conn\fP) \fBsasl_idle()\fP may be called during an idle period to allow the SASL library or any mechanisms to perform any necessary precalculation. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – may be NULL to do precalculation prior to a connection taking place. .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp Returns 1 if action was taken, 0 if no action was taken. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.08 KB	2024-07-15 12:36
📄 sasl_listmech.3 .\" Man page generated from reStructuredText. . .TH "SASL_LISTMECH" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_listmech \- 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_listmech(sasl_conn_t conn, const char user, const char prefix, const char sep, const char suffix, const char result, unsigned plen, int pcount); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_listmech(sasl_conn_t conn, .TP .B const char user, .TP .B const char prefix, .TP .B const char sep, .TP .B const char suffix, .TP .B const char *result, .TP .B unsigned plen, .TP .B int *pcount); \fBsasl_listmech\fP returns a string listing the SASL names of all the mechanisms available to the specified user. This is typically given to the client through a capability command or initial server response. Client applications need this list so that they know what mechanisms the server supports. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – the SASL context for this connection .IP \(bu 2 \fBuser\fP – (optional) restricts the mechanism list to only those available to the user. .IP \(bu 2 \fBprefix\fP – appended to beginning of result .IP \(bu 2 \fBsep\fP – appended between mechanisms .IP \(bu 2 \fBsuffix\fP – appended to end of result .IP \(bu 2 \fBresult\fP – NULL terminated result string (allocated/freed by library) .IP \(bu 2 \fBplen\fP – length of result filled in by library. May be NULL .IP \(bu 2 \fBpcount\fP – Number of mechanisms available (filled in by library). May be NULL .UNINDENT .UNINDENT .UNINDENT .SH EXAMPLE .sp .nf sasl_listmech(conn,NULL,"(",",",")",&mechlist,NULL,NULL); .fi .sp may give the following string as a result: .INDENT 0.0 .INDENT 3.5 \fI(ANONYMOUS,KERBEROS_V4,DIGEST‐MD5)\fP .UNINDENT .UNINDENT .SH RETURN VALUE .sp SASL functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_OK\fP indicates success. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_server_new(3), sasl_errors(3), sasl_client_new(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.46 KB	2024-07-15 12:36
📄 sasl_log_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_LOG_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_log_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_log_t(void context, int level, const char message); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_log_t(void context, .TP .B int level, .TP .B const char message); .INDENT 7.0 .TP \fBsasl_log_t\fP is used to log warning/error messages from the SASL library. If not specified \fBsyslog\fP will be used. .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. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.13 KB	2024-07-15 12:36
📄 sasl_server_init.3 .\" Man page generated from reStructuredText. . .TH "SASL_SERVER_INIT" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_server_init \- 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_server_init(const sasl_callback_t callbacks, const char appname); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_server_init(const sasl_callback_t callbacks, .TP .B const char appname); \fBsasl_server_init()\fP initializes SASL. It must be called before any calls to sasl_server_start, and only once per process. This call initializes all SASL mechanism drivers (e.g. authentication mechanisms). These are usually found in the /usr/lib/sasl2 directory but the directory may be overridden with the SASL_PATH environment variable (or at compile time). .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcallbacks\fP – specifies the base callbacks for all client connections. See the sasl_callbacks(3) man page for more information. .IP \(bu 2 \fBappname\fP – is the name of the application. It is used to find the default configuration file. .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 either be handled or the authentication session should be quit. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_callbacks(3), sasl_server_new(3), sasl_server_start(3), sasl_server_step(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.86 KB	2024-07-15 12:36
📄 sasl_server_new.3 .\" Man page generated from reStructuredText. . .TH "SASL_SERVER_NEW" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_server_new \- 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_server_new(const char service, const char serverFQDN, const char user_realm, const char iplocalport, const char ipremoteport, const sasl_callback_t callbacks, unsigned flags, sasl_conn_t ** pconn); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_server_new(const char service, .TP .B const char serverFQDN, .TP .B const char user_realm, .TP .B const char iplocalport, .TP .B const char ipremoteport, .TP .B const sasl_callback_t callbacks, .TP .B unsigned flags, .TP .B sasl_conn_t ** pconn); \fBsasl_server_new()\fP creates a new SASL context. This context will be used for all SASL calls for one connection. It handles both authentication and integrity/encryption layers after authentication. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBservice\fP – is the registered name of the service (usually the protocol name) using SASL (e.g. “imap”). .IP \(bu 2 \fBserverFQDN\fP – is the fully qualified server domain name. NULL means use gethostname(). This is useful for multi\-homed servers. .IP \(bu 2 \fBuser_realm\fP – is the domain of the user agent. This is usually not necessary (NULL is default) .IP \(bu 2 \fBiplocalport\fP – .sp is the IP and port of the local side of the connection, or NULL. If iplocalport is NULL it will disable mechanisms that require IP address information. This strings must be in one of the following formats: .INDENT 2.0 .IP \(bu 2 ”a.b.c.d;port” (IPv4), .IP \(bu 2 ”e:f:g:h:i:j:k:l;port” (IPv6), or .IP \(bu 2 ”e:f:g:h:i:j:a.b.c.d;port” (IPv6) .UNINDENT .IP \(bu 2 \fBipremoteport\fP – is the IP and port of the remote side of the connection, or NULL (see iplocalport) .IP \(bu 2 \fBflags\fP – are connection flags (see below) .IP \(bu 2 \fBpconn\fP – is a pointer to the connection context allocated by the library. This structure will be used for all future SASL calls for this connection. .UNINDENT .UNINDENT .UNINDENT .SS Connection flags .sp Flags that may be passed to \fBsasl_server_new()\fP: .INDENT 0.0 .IP \(bu 2 \fISASL_SUCCESS_DATA\fP: The protocol supports a server‐last send .IP \(bu 2 .INDENT 2.0 .TP .B \fISASL_NEED_PROXY\fP: Force the use of a mechanism that supports an authorization id that is not the authentication id. .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 either be handled or the authentication session should be quit. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_server_init(3), sasl_server_start(3), sasl_server_step(3), sasl_setprop(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	4.3 KB	2024-07-15 12:36
📄 sasl_server_start.3 .\" Man page generated from reStructuredText. . .TH "SASL_SERVER_START" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_server_start \- 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_server_start(sasl_conn_t * conn, const char * mech, const char * clientin, unsigned clientinlen, const char ** serverout, unsigned * serveroutlen); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_server_start(sasl_conn_t * conn, .TP .B const char * mech, .TP .B const char * clientin, .TP .B unsigned * clientinlen, .TP .B const char ** serverout, .TP .B unsigned * serveroutlen); \fBsasl_server_start()\fP begins the authentication with the mechanism specified with mech. This fails if the mechanism is not supported. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBmech\fP – is the mechanism name that the client requested .IP \(bu 2 \fBclientin\fP – is the client initial response, NULL if the protocol lacks support for client‐send‐first or if the other end did not have an initial send. Note that no initial client send is distinct from an initial send of a null string, and the protocol MUST account for this difference. .IP \(bu 2 \fBclientinlen\fP – is the length of initial response .IP \(bu 2 \fBserverout\fP – is created by the plugin library. It is the initial server response to send to the client. This is allocated/freed by the library and it is the job of the client to send it over the network to the server. Also protocol specific encoding (such as base64 encoding) must needs to be done by the server. .IP \(bu 2 \fBserveroutlen\fP – is set to the length of initial server challenge .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 is returned if the authentication is complete and the user is authenticated. \fBSASL_CONTINUE\fP is returned if one or more steps are still required in the authentication. .sp All other return values indicate errors and should be handled or the authentication session should be quit. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_server_init(3), sasl_server_new(3), sasl_server_step(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.65 KB	2024-07-15 12:36
📄 sasl_server_step.3 .\" Man page generated from reStructuredText. . .TH "SASL_SERVER_STEP" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_server_step \- 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_server_step(sasl_conn_t conn, const char clientin, unsigned clientinlen, const char ** serverout, unsigned * serveroutlen); .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_server_step(sasl_conn_t conn, .TP .B const char clientin, .TP .B unsigned clientinlen, .TP .B const char ** serverout, .TP .B unsigned * serveroutlen); \fBsasl_server_step()\fP performs a step in the authentication negotiation. It returns \fBSASL_OK\fP if the whole negotiation is successful and \fBSASL_CONTINUE\fP if this step is ok but at least one more step is needed. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBclientin\fP – is the data given by the client (decoded if the protocol encodes requests sent over the wire) .IP \(bu 2 \fBclientinlen\fP – is the length of \fIclientin\fP .IP \(bu 2 \fBserverout\fP – set by the library and should be sent to the client. .IP \(bu 2 \fBserveroutlen\fP – length of \fIserverout\fP\&. .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp SASL callback functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_CONTINUE\fP indicates success and that there are more steps needed in the authentication. \fBSASL_OK\fP indicates that the authentication is complete. .sp Other return codes indicate errors and should either be handled or the authentication session should be quit. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP, sasl_server_init(3), sasl_server_new(3), sasl_server_start(3), sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.08 KB	2024-07-15 12:36
📄 sasl_server_userdb_checkpass_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_SERVER_USERDB_CHECKPASS_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_server_userdb_checkpass_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_server_userdb_checkpass_t(sasl_conn_t conn, void context, const char user, const char pass, unsigned passlen, struct propctx propctx) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_server_userdb_checkpass_t(sasl_conn_t conn, .TP .B void context, .TP .B const char user, .TP .B const char pass, .TP .B unsigned passlen, .TP .B struct propctx propctx) \fBsasl_server_userdb_checkpass_t()\fP is used to verify a plaintext password against the callback supplier’s user database. This is to allow additional ways to encode the userPassword property. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBcontext\fP – context from the callback record .IP \(bu 2 \fBuser\fP – NUL terminated user name with \fIuser@realm\fP syntax .IP \(bu 2 \fBpass\fP – password to check (may not be NUL terminated) .IP \(bu 2 \fBpasslen\fP – length of the password .IP \(bu 2 \fBpropctx\fP – property context to fill in with userPassword .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_callbacks(3) sasl_errors(3), sasl_server_userdb_setpass_t(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.95 KB	2024-07-15 12:36
📄 sasl_server_userdb_setpass_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_SERVER_USERDB_SETPASS_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_server_userdb_setpass_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_server_userdb_setpass_t(sasl_conn_t conn, void context, const char user, const char pass, unsigned passlen, struct propctx propctx, unsigned flags) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_server_userdb_setpass_t(sasl_conn_t conn, .TP .B void context, .TP .B const char user, .TP .B const char pass, .TP .B unsigned passlen, .TP .B struct propctx propctx, .TP .B unsigned flags) \fBsasl_server_userdb_setpass_t\fP is used to store or change a plaintext password in the callback‐supplier’s user database. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection .IP \(bu 2 \fBcontext\fP – context from the callback record .IP \(bu 2 \fBuser\fP – NUL terminated user name with \fIuser@realm\fP syntax .IP \(bu 2 \fBpass\fP – password to check (may not be NUL terminated) .IP \(bu 2 \fBpasslen\fP – length of the password .IP \(bu 2 \fBpropctx\fP – Auxilliary Properties (not stored) .IP \(bu 2 \fBflags\fP – These are the same flags that are passed to sasl_setpass(3), and are documented on that man page. .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_callbacks(3), sasl_server_userdb_checkpass_t(3), sasl_setpass(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.2 KB	2024-07-15 12:36
📄 sasl_setpass.3 .\" Man page generated from reStructuredText. . .TH "SASL_SETPASS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_setpass \- 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_setpass(sasl_conn_t conn, const char user, const char pass, unsigned passlen, const char oldpass, unsigned oldpasslen, unsigned flags) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_setpass(sasl_conn_t conn, .TP .B const char user, .TP .B const char pass, unsigned passlen, .TP .B const char oldpass, unsigned oldpasslen, .TP .B unsigned flags) \fBsasl_setpass\fP will set passwords in the sasldb, and trigger the setpass callbacks for all available mechanisms. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – is the SASL connection context .IP \(bu 2 \fBuser\fP – is the username to set the password for .IP \(bu 2 \fBpass\fP – the password to set .IP \(bu 2 \fBpasslen\fP – length of the password to set (\fIpass\fP) .IP \(bu 2 \fBoldpass\fP – optional. The old password. .IP \(bu 2 \fBoldpasslen\fP – optional. The old password length. .IP \(bu 2 \fBflags\fP – .sp are flags including \fISASL_SET_CREATE\fP and \fISASL_SET_DISABLE\fP (to cause the creating of nonexistent accounts and the disabling of an account, respectively) .sp \fIoldpass\fP and \fIoldpasslen\fP are unused in the Cyrus SASL implementation, though are passed on to any mechanisms that may require them. .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_checkpass(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.13 KB	2024-07-15 12:36
📄 sasl_setprop.3 .\" Man page generated from reStructuredText. . .TH "SASL_SETPROP" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_setprop \- 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_setprop(sasl_conn_t conn, int propnum, const void pvalue) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_setprop(sasl_conn_t conn, .TP .B int propnum, .TP .B const void pvalue) \fBsasl_setprop\fP sets the value of a SASL property. For example an application should tell the SASL library about any external negotiated security layer (i.e. TLS). .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 contains a pointer to the data. It is the applications job to make sure this type is correct. This is an easy way to crash a program. .INDENT 2.0 .IP \(bu 2 SASL_AUTH_EXTERNAL ‐ external authentication ID (const char ) .IP \(bu 2 SASL_SSF_EXTERNAL ‐ external SSF active ‐‐ (sasl_ssf_t) .IP \(bu 2 SASL_DEFUSERREALM ‐ user realm (const char ) .IP \(bu 2 SASL_SEC_PROPS ‐ \fIsasl_security_properties_t\fP (may be freed after call) .IP \(bu 2 .INDENT 2.0 .TP .B SASL_IPLOCALPORT ‐ string describing the local ip and port in the form ”a.b.c.d;p”, or “e:f:g:h:i:j:k:l;port” .UNINDENT .IP \(bu 2 .INDENT 2.0 .TP .B SASL_IPREMOTEPORT ‐ string describing the remote ip and port in the form ”a.b.c.d;p”, or “e:f:g:h:i:j:k:l;port” .UNINDENT .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) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	3.2 KB	2024-07-15 12:36
📄 sasl_user_exists.3 .\" Man page generated from reStructuredText. . .TH "SASL_USER_EXISTS" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_user_exists \- 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_user_exists( sasl_conn_t conn, const char service, const char user_realm, const char user) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_user_exists( sasl_conn_t conn, .TP .B const char service, .TP .B const char user_realm, .TP .B const char user) \fBsasl_user_exists\fP will check if a user exists on the server. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBconn\fP – the SASL context for this connection .IP \(bu 2 \fBservice\fP – Service name or NULL (for service name of connection context) .IP \(bu 2 \fBuser_realm\fP – Realm to check in or NULL (for default realm) .IP \(bu 2 \fBuser\fP – User name to check for existence. .UNINDENT .UNINDENT .UNINDENT .SH RETURN VALUE .sp SASL functions should return SASL return codes. See sasl.h for a complete list. \fBSASL_OK\fP indicates success. .SH SEE ALSO .sp \fI\%RFC 4422\fP,:saslman:\fIsasl(3)\fP,:saslman:\fIsasl_errors(3)\fP .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.51 KB	2024-07-15 12:36
📄 sasl_verifyfile_t.3 .\" Man page generated from reStructuredText. . .TH "SASL_VERIFYFILE_T" "3" "November 08, 2018" "2.1.27" "Cyrus SASL" .SH NAME sasl_verifyfile_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> typedef enum { SASL_VRFY_PLUGIN, /* a DLL/shared library plugin / SASL_VRFY_CONF, / a configuration file / SASL_VRFY_PASSWD, / a password storage file / SASL_VRFY_OTHER / some other file type / } sasl_verify_type_t int sasl_verifyfile_t(void context, const char file, sasl_verify_type_t type) .fi .SH DESCRIPTION .INDENT 0.0 .TP .B int sasl_verifyfile_t(void context, .TP .B const char *file, .TP .B sasl_verify_type_t type) \fBsasl_verifyfile_t()\fP is used to check whether a given file is okay for use by the SASL library. This is intended to allow applications to sanity check the environment. For example, to ensure that plugins or the config file cannot be written to. .INDENT 7.0 .TP .B Parameters .INDENT 7.0 .IP \(bu 2 \fBcontext\fP – context from the callback record .IP \(bu 2 \fBcontext\fP – context from the callback record .IP \(bu 2 \fBfile\fP – full path of the file to verify .IP \(bu 2 \fBtype\fP – type of the file. .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_callbacks(3) sasl_errors(3) .SH AUTHOR The Cyrus Team .SH COPYRIGHT 1993-2016, The Cyrus Team .\" Generated by docutils manpage writer. .	2.87 KB	2024-07-15 12:36

Edit File:

Terminal