Package cyrus-sasl-devel

Files needed for developing applications with Cyrus SASL

http://asg.web.cmu.edu/sasl/sasl-library.html

The cyrus-sasl-devel package contains files needed for developing and
compiling applications which use the Cyrus SASL library.

Library Functions (Section 3)
sasl
The CMU Cyrus SASL library is a general purpose authentication library for sever and client applications. System Administrators: For information on setting...
sasl_authorize_t
sasl_authorize_t 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...
sasl_auxprop
SASL auxiliary properties are used to obtain properties from external sources during the authentication process. For example, a mechanism might need to query an...
sasl_auxprop_getctx
sasl_auxprop_getctx will return an auxiliary property context for the given sasl_conn_t on which the functions described in sasl_auxprop(3) can operate. conn...
sasl_auxprop_request
sasl_auxprop_request will request that the SASL library obtain properties from any auxiliary property plugins that might be installed (such as the user's home...
sasl_callbacks
sasl_callbacks are used when the application needs some information from the application. Common reasons are getting for getting usernames and passwords. A...
sasl_canon_user_t
sasl_canon_user_t Is the callback for an application-supplied user canonicalization function. This function is subject to the requirements that all user...
sasl_chalprompt_t
sasl_chalprompt_t is used to prompt for input in response to a server challenge. context context from the callback record id callback id (either...
sasl_checkapop
sasl_checkapop() will check an APOP challenge/response. APOP is an optional POP3 (RFC 1939) authentication command which uses a shared secret (password). The...
sasl_checkpass
sasl_checkpass() 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...
sasl_client_init
sasl_client_init() initializes SASL. It must be called before any calls to sasl_client_start. This call initializes all SASL client drivers (e.g. authentication...
sasl_client_new
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...
sasl_client_start
sasl_client_start() selects a mechanism for authentication and starts the authentication session. The mechlist is the list of mechanisms the client might like...
sasl_client_step
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...
sasl_decode
sasl_decode decodes data received. After successful authentication this function should be called on all data received. It decodes the data from encrypted or...
sasl_dispose
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...
sasl_done
sasl_done is called when the application is completely done with the SASL library.
sasl_encode
sasl_encode 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...
sasl_errdetail
sasl_errdetail provides more detailed information about the most recent error to occur, beyond the information contained in the SASL result code. conn the...
sasl_errors
SASL error codes
sasl_errstring
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...
sasl_getconfpath_t
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...
sasl_getopt_t
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...
sasl_getpath_t
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...
sasl_getprop
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...
sasl_getrealm_t
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...
sasl_getsecret_t
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...
sasl_getsimple_t
sasl_getsimple_t is used to retrieve simple things from the application. In practice this is authentication name, authorization name, and realm. The id...
sasl_global_listmech
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.
sasl_idle
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...
sasl_listmech
sasl_listmech() 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...
sasl_log_t
sasl_log_t is used to log warning/error messages from the SASL library. If not specified syslog will be used.
sasl_server_init
sasl_server_init() initializes SASL. It must be called before any calls to sasl_server_start, and only once per process. This call initializes all SASL...
sasl_server_new
sasl_server_new() creates a new SASL context. This context will be used for all SASL calls for one connection. It handles both authentication and...
sasl_server_start
sasl_server_start() begins the authentication with the mechanism specified with mech. This fails if the mechanism is not supported. SASL_OK is returned if the...
sasl_server_step
sasl_server_step() performs a step in the authentication negotiation. It returns SASL_OK if the whole negotiation is successful and SASL_CONTINUE if this step...
sasl_server_userdb_checkpass_t
sasl_server_userdb_checkpass_t is used to verify a plaintext password against the callback supplier's user database. This is to allow additional ways to encode...
sasl_server_userdb_setpass_t
sasl_server_userdb_setpass_t is used to store or change a plaintext password in the callback-supplier's user database. context context from the callback record...
sasl_setpass
sasl_setpass will set passwords in the sasldb, and trigger the setpass callbacks for all available mechanisms. user is the username to set the password for...
sasl_setprop
sasl_setprop 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)...
sasl_user_exists
sasl_user_exists will check if a user exists on the server. conn a connection context service Service name or NULL (for service name of connection context)...
sasl_verifyfile_t
sasl_verifyfile_t 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...