Section 3: library functions
sasl_idle – Perform precalculations during an idle period Synopsis #include <sasl/sasl.h> int sasl_idle( sasl_conn_t *conn) Description sasl_idle may be called during an idle period to allow the SASL library or any mechanisms to perform any necessary precalculation. conn may be NULL to do precalculation prior to a connection taking place. Return Value Returns 1 if…
sasl_listmech – Retrieve a list of the supported SASL mechanisms Synopsis #include <sasl/sasl.h> const char ** sasl_global_listmech() Description sasl_global_listmech() returns a null-terminated array of strings that lists all mechanisms that are loaded by either the client or server side of the library. Return Value Returns a pointer to the array on success. NULL on failure…
sasl_getsimple_t – The SASL callback for username/authname/realm Synopsis #include <sasl/sasl.h> int sasl_getsimple_t(void *context, int id, const char **result, unsigned *len); Description sasl_getsimple_t is used to retrieve simple things from the application. In practice this is authentication name, authorization name, and realm. The id parameter indicates which value is being requested. Possible values include: SASL_CB_USER -…
sasl_getsecret_t – The SASL callback for secrets (passwords) Synopsis #include <sasl/sasl.h> int sasl_getsecret_t(sasl_conn_t *conn, void *context, int id, sasl_secret_t **psecret); Description sasl_getsecret_t is used to retrieve the secret from the application. A sasl_secret_t should be allocated to length sizeof(sasl_secret_t)+<length of secret>. It has two fields len which is the length of the secret in bytes…
sasl_getrealm_t – Realm Acquisition Callback Synopsis #include <sasl/sasl.h> int sasl_getrealm_t(void *context, int id, const char **availrealms, const char **result) Description sasl_getrealm_t is used when there is an interaction with SASL_CB_GETREALM as the type. If a mechanism would use this callback, but it is not present, then the first realm listed is automatically selected. (Note that…
sasl_getprop – Get a SASL property Synopsis #include <sasl/sasl.h> int sasl_getprop(sasl_conn_t *conn, int propnum, const void **pvalue); Description sasl_getprop 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….
sasl_getpath_t – The SASL callback to indicate location of the mechanism drivers Synopsis #include <sasl/sasl.h> int sasl_getpath_t(void *context, char **path); Description sasl_getpath_t 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…
sasl_getopt_t – The SASL get option callback Synopsis #include <sasl/sasl.h> int sasl_getopt_t(void *context, const char *plugin_name, const char *option, const char **result, unsigned *len); Description sasl_getopt_t is used to retrieve an option, often mechanism specific, from the application. An example of this is requested what KERBEROS_V4 srvtab file to use. plugin_name is the plugin this…
sasl_getconfpath_t – The SASL callback to indicate location of the config files Synopsis #include <sasl.h> int sasl_getconfpath_t(void *context, char **path); Description sasl_getconfpath_t 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…
sasl_errstring – Translate a SASL return code to a human-readable form Synopsis #include <sasl/sasl.h> const char *sasl_errstring(int saslerr, const char *langlist, const char **outlang); Description sasl_usererr 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 written by programmers (aka…
sasl_errors – SASL error codes Synopsis #include <sasl/sasl.h> Description 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): Common Result Codes SASL_OK Success SASL_CONTINUE Another step is needed in authentication SASL_FAIL Generic Failure SASL_NOMEM Memory shortage failure…
sasl_errdetail – Retrieve detailed information about an error Synopsis #include <sasl/sasl.h> const char *sasl_errdetail(sasl_conn_t *conn); Description sasl_errdetail provides more detailed information about the most recent error to occur, beyond the information contained in the SASL result code. conn the connection context to inquire about. Return Value Returns the string describing the error that occurred, or…
sasl_encode – Encode data for transport to authenticated host Synopsis #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); Description sasl_encode encodes data to be sent to be sent to a remote host who we’ve…
sasl_encode – Encode data for transport to authenticated host Synopsis #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); Description sasl_encode encodes data to be sent to be sent to a remote host who we’ve…
sasl_done – Dispose of a SASL connection object Synopsis #include <sasl/sasl.h> void sasl_done(void); Description sasl_done is called when the application is completely done with the SASL library. Return Value No return values Conforming To RFC 4422 See Also sasl(3), sasl_server_init(3), sasl_client_init(3)
sasl_dispose – Dispose of a SASL connection object Synopsis #include <sasl/sasl.h> void sasl_dispose(sasl_conn_t **pconn); Description sasl_dispose is called when a SASL connection object is no longer needed. 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. Return Value No…
sasl_decode – Decode data received Synopsis #include <sasl/sasl.h> int sasl_decode(sasl_conn_t *conn, const char *input, unsigned inputlen, const char **output, unsigned *outputlen); Description sasl_decode 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…
sasl_client_step – Perform a step in the authentication negotiation Synopsis #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); Description sasl_client_step() performs a step in the authentication negotiation. It returns SASL_OK if the whole negotiation is successful and SASL_CONTINUE if this step is ok but at least…
sasl_client_start – Begin an authentication negotiation Synopsis #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); Description sasl_client_start() selects a mechanism for authentication and starts the authentication session. The mechlist is the list of mechanisms the client might like to use. The mechanisms in the list…
sasl_client_new – Create a new client authentication object Synopsis #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); Description sasl_client_new() creates a new SASL context. This context will be used for all SASL calls for one connection. It handles both authentication and…