![]() | ![]() | ![]() | GNU SASL API Reference Manual | ![]() |
---|
gsasl-compat —
int gsasl_client_listmech (Gsasl *ctx, char *out); int gsasl_server_listmech (Gsasl *ctx, char *out); int gsasl_client_step (Gsasl_session *sctx, const char *input, size_t input_len, char *output); int gsasl_client_step_base64 (Gsasl_session *sctx, const char *b64input, char *b64output); int gsasl_server_step (Gsasl_session *sctx, const char *input, size_t input_len, char *output); int gsasl_server_step_base64 (Gsasl_session *sctx, const char *b64input, char *b64output); void gsasl_client_finish (); void gsasl_server_finish (); Gsasl* gsasl_client_ctx_get (); Gsasl* gsasl_server_ctx_get (); void gsasl_client_application_data_set (Gsasl_session *sctx); void* gsasl_client_application_data_get (); void gsasl_server_application_data_set (Gsasl_session *sctx); void* gsasl_server_application_data_get (); int gsasl_randomize (int strong, char *data); Gsasl* gsasl_ctx_get (); int gsasl_encode_inline (Gsasl_session *sctx, const char *input, size_t input_len, char *output); int gsasl_decode_inline (Gsasl_session *sctx, const char *input, size_t input_len, char *output); void gsasl_application_data_set (Gsasl *ctx); void* gsasl_application_data_get (); void gsasl_appinfo_set (Gsasl_session *sctx); void* gsasl_appinfo_get (); const char* gsasl_server_suggest_mechanism (Gsasl *ctx); int (*Gsasl_client_callback_anonymous) (Gsasl_session *sctx, char *out, size_t *outlen); int (*Gsasl_client_callback_authentication_id) (Gsasl_session *sctx, char *out, size_t *outlen); int (*Gsasl_client_callback_authorization_id) (Gsasl_session *sctx, char *out, size_t *outlen); int (*Gsasl_client_callback_password) (Gsasl_session *sctx, char *out, size_t *outlen); int (*Gsasl_client_callback_passcode) (Gsasl_session *sctx, char *out, size_t *outlen); int (*Gsasl_client_callback_pin) (Gsasl_session *sctx, char *suggestion, char *out, size_t *outlen); int (*Gsasl_client_callback_service) (Gsasl_session *sctx, char *service, size_t *servicelen, char *hostname, size_t *hostnamelen, char *servicename, size_t *servicenamelen); Gsasl_qop (*Gsasl_client_callback_qop) (Gsasl_session *sctx, Gsasl_qop serverqops); size_t (*Gsasl_client_callback_maxbuf) (Gsasl_session *sctx, size_t servermaxbuf); int (*Gsasl_client_callback_realm) (Gsasl_session *sctx, char *out, size_t *outlen); int (*Gsasl_server_callback_retrieve) (Gsasl_session *sctx, const char *authentication_id, const char *authorization_id, const char *realm, char *key, size_t *keylen); int (*Gsasl_server_callback_validate) (Gsasl_session *sctx, const char *authorization_id, const char *authentication_id, const char *password); int (*Gsasl_server_callback_gssapi) (Gsasl_session *sctx, const char *clientname, const char *authentication_id); int (*Gsasl_server_callback_securid) (Gsasl_session *sctx, const char *authentication_id, const char *authorization_id, const char *passcode, char *pin, char *suggestpin, size_t *suggestpinlen); int (*Gsasl_server_callback_cram_md5) (Gsasl_session *sctx, char *username, char *challenge, char *response); int (*Gsasl_server_callback_digest_md5) (Gsasl_session *sctx, char *username, char *realm, char *secrethash); int (*Gsasl_server_callback_service) (Gsasl_session *sctx, char *service, size_t *servicelen, char *hostname, size_t *hostnamelen); int (*Gsasl_server_callback_external) (Gsasl_session *sctx); int (*Gsasl_server_callback_anonymous) (Gsasl_session *sctx, const char *token); int (*Gsasl_server_callback_realm) (Gsasl_session *sctx, char *out, size_t *outlen, size_t nth); Gsasl_qop (*Gsasl_server_callback_qop) (Gsasl_session *sctx); size_t (*Gsasl_server_callback_maxbuf) (Gsasl_session *sctx); Gsasl_cipher (*Gsasl_server_callback_cipher) (Gsasl_session *sctx); Gsasl_client_callback_authorization_id gsasl_client_callback_authorization_id_get (); Gsasl_client_callback_authentication_id gsasl_client_callback_authentication_id_get (); void gsasl_client_callback_anonymous_set (Gsasl *ctx); Gsasl_client_callback_anonymous gsasl_client_callback_anonymous_get (); void gsasl_client_callback_password_set (Gsasl *ctx); Gsasl_client_callback_password gsasl_client_callback_password_get (); void gsasl_client_callback_passcode_set (Gsasl *ctx); Gsasl_client_callback_passcode gsasl_client_callback_passcode_get (); void gsasl_client_callback_pin_set (Gsasl *ctx); Gsasl_client_callback_pin gsasl_client_callback_pin_get (); void gsasl_client_callback_service_set (Gsasl *ctx); Gsasl_client_callback_service gsasl_client_callback_service_get (); void gsasl_client_callback_qop_set (Gsasl *ctx); Gsasl_client_callback_qop gsasl_client_callback_qop_get (); void gsasl_client_callback_maxbuf_set (Gsasl *ctx); Gsasl_client_callback_maxbuf gsasl_client_callback_maxbuf_get (); void gsasl_client_callback_realm_set (Gsasl *ctx); Gsasl_client_callback_realm gsasl_client_callback_realm_get (); void gsasl_server_callback_validate_set (Gsasl *ctx); Gsasl_server_callback_validate gsasl_server_callback_validate_get (); void gsasl_server_callback_retrieve_set (Gsasl *ctx); Gsasl_server_callback_retrieve gsasl_server_callback_retrieve_get (); void gsasl_server_callback_cram_md5_set (Gsasl *ctx); Gsasl_server_callback_cram_md5 gsasl_server_callback_cram_md5_get (); void gsasl_server_callback_digest_md5_set (Gsasl *ctx); Gsasl_server_callback_digest_md5 gsasl_server_callback_digest_md5_get (); void gsasl_server_callback_external_set (Gsasl *ctx); Gsasl_server_callback_external gsasl_server_callback_external_get (); void gsasl_server_callback_anonymous_set (Gsasl *ctx); Gsasl_server_callback_anonymous gsasl_server_callback_anonymous_get (); void gsasl_server_callback_realm_set (Gsasl *ctx); Gsasl_server_callback_realm gsasl_server_callback_realm_get (); void gsasl_server_callback_qop_set (Gsasl *ctx); Gsasl_server_callback_qop gsasl_server_callback_qop_get (); void gsasl_server_callback_maxbuf_set (Gsasl *ctx); Gsasl_server_callback_maxbuf gsasl_server_callback_maxbuf_get (); void gsasl_server_callback_cipher_set (Gsasl *ctx); Gsasl_server_callback_cipher gsasl_server_callback_cipher_get (); void gsasl_server_callback_securid_set (Gsasl *ctx); Gsasl_server_callback_securid gsasl_server_callback_securid_get (); void gsasl_server_callback_gssapi_set (Gsasl *ctx); Gsasl_server_callback_gssapi gsasl_server_callback_gssapi_get (); void gsasl_server_callback_service_set (Gsasl *ctx); Gsasl_server_callback_service gsasl_server_callback_service_get ();
int gsasl_client_listmech (Gsasl *ctx, char *out);
gsasl_client_listmech is deprecated and should not be used in newly-written code. Use gsasl_client_mechlist() instead.
Write SASL names, separated by space, of mechanisms supported by the libgsasl client to the output array. To find out how large the output array must be, call this function with out=NULL.
ctx : | libgsasl handle. |
out : | output character array. |
Returns : | Returns GSASL_OK if successful, or error code. |
int gsasl_server_listmech (Gsasl *ctx, char *out);
gsasl_server_listmech is deprecated and should not be used in newly-written code. Use gsasl_server_mechlist() instead.
Write SASL names, separated by space, of mechanisms supported by the libgsasl server to the output array. To find out how large the output array must be, call this function with out=NULL.
ctx : | libgsasl handle. |
out : | output character array. |
Returns : | Returns GSASL_OK if successful, or error code. |
int gsasl_client_step (Gsasl_session *sctx, const char *input, size_t input_len, char *output);
gsasl_client_step is deprecated and should not be used in newly-written code. Use gsasl_step() instead.
Perform one step of SASL authentication in client. This reads data from server (specified with input and input_len), processes it (potentially invoking callbacks to the application), and writes data to server (into variables output and output_len).
The contents of the output buffer is unspecified if this functions returns anything other than GSASL_NEEDS_MORE.
sctx : | libgsasl client handle. |
input : | input byte array. |
input_len : | size of input byte array. |
output : | output byte array. |
Returns : | Returns GSASL_OK if authenticated terminated successfully, GSASL_NEEDS_MORE if more data is needed, or error code. |
int gsasl_client_step_base64 (Gsasl_session *sctx, const char *b64input, char *b64output);
gsasl_client_step_base64 is deprecated and should not be used in newly-written code. Use gsasl_step64() instead.
This is a simple wrapper around gsasl_client_step() that base64 decodes the input and base64 encodes the output.
sctx : | libgsasl client handle. |
b64input : | input base64 encoded byte array. |
b64output : | output base64 encoded byte array. |
Returns : | See gsasl_client_step(). |
int gsasl_server_step (Gsasl_session *sctx, const char *input, size_t input_len, char *output);
gsasl_server_step is deprecated and should not be used in newly-written code. Use gsasl_step() instead.
Perform one step of SASL authentication in server. This reads data from client (specified with input and input_len), processes it (potentially invoking callbacks to the application), and writes data to client (into variables output and output_len).
The contents of the output buffer is unspecified if this functions returns anything other than GSASL_NEEDS_MORE.
sctx : | libgsasl server handle. |
input : | input byte array. |
input_len : | size of input byte array. |
output : | output byte array. |
Returns : | Returns GSASL_OK if authenticated terminated successfully, GSASL_NEEDS_MORE if more data is needed, or error code. |
int gsasl_server_step_base64 (Gsasl_session *sctx, const char *b64input, char *b64output);
gsasl_server_step_base64 is deprecated and should not be used in newly-written code. Use gsasl_step64() instead.
This is a simple wrapper around gsasl_server_step() that base64 decodes the input and base64 encodes the output.
sctx : | libgsasl server handle. |
b64input : | input base64 encoded byte array. |
b64output : | output base64 encoded byte array. |
Returns : | See gsasl_server_step(). |
void gsasl_client_finish ();
gsasl_client_finish is deprecated and should not be used in newly-written code. Use gsasl_finish() instead.
Destroy a libgsasl client handle. The handle must not be used with other libgsasl functions after this call.
void gsasl_server_finish ();
gsasl_server_finish is deprecated and should not be used in newly-written code. Use gsasl_finish() instead.
Destroy a libgsasl server handle. The handle must not be used with other libgsasl functions after this call.
Gsasl* gsasl_client_ctx_get ();
gsasl_client_ctx_get is deprecated and should not be used in newly-written code. This function is not useful with the new 0.2.0 API.
Returns : | Returns the libgsasl handle given a libgsasl client handle. |
Gsasl* gsasl_server_ctx_get ();
gsasl_server_ctx_get is deprecated and should not be used in newly-written code. This function is not useful with the new 0.2.0 API.
Returns : | Returns the libgsasl handle given a libgsasl server handle. |
void gsasl_client_application_data_set (Gsasl_session *sctx);
gsasl_client_application_data_set is deprecated and should not be used in newly-written code. Use gsasl_callback_hook_set() instead.
Store application specific data in the libgsasl client handle. The application data can be later (for instance, inside a callback) be retrieved by calling gsasl_client_application_data_get(). It is normally used by the application to maintain state between the main program and the callback.
sctx : | libgsasl client handle. |
void* gsasl_client_application_data_get ();
gsasl_client_application_data_get is deprecated and should not be used in newly-written code. Use gsasl_callback_hook_get() instead.
Retrieve application specific data from libgsasl client handle. The application data is set using gsasl_client_application_data_set(). It is normally used by the application to maintain state between the main program and the callback.
void gsasl_server_application_data_set (Gsasl_session *sctx);
gsasl_server_application_data_set is deprecated and should not be used in newly-written code. Use gsasl_callback_hook_set() instead.
Store application specific data in the libgsasl server handle. The application data can be later (for instance, inside a callback) be retrieved by calling gsasl_server_application_data_get(). It is normally used by the application to maintain state between the main program and the callback.
sctx : | libgsasl server handle. |
void* gsasl_server_application_data_get ();
gsasl_server_application_data_get is deprecated and should not be used in newly-written code. Use gsasl_callback_hook_get() instead.
Retrieve application specific data from libgsasl server handle. The application data is set using gsasl_server_application_data_set(). It is normally used by the application to maintain state between the main program and the callback.
int gsasl_randomize (int strong, char *data);
gsasl_randomize is deprecated and should not be used in newly-written code. Use gsasl_random() or gsasl_nonce() instead.
Store cryptographically random data of given size in the provided buffer.
strong : | 0 iff operation should not block, non-0 for very strong randomness. |
data : | output array to be filled with random data. |
Returns : | Returns GSASL_OK iff successful. |
Gsasl* gsasl_ctx_get ();
gsasl_ctx_get is deprecated and should not be used in newly-written code. This function is not useful with the new 0.2.0 API.
Returns : | Returns the libgsasl handle given a libgsasl session handle. |
int gsasl_encode_inline (Gsasl_session *sctx, const char *input, size_t input_len, char *output);
gsasl_encode_inline is deprecated and should not be used in newly-written code. Use gsasl_encode() instead.
Encode data according to negotiated SASL mechanism. This might mean that data is integrity or privacy protected.
sctx : | libgsasl session handle. |
input : | input byte array. |
input_len : | size of input byte array. |
output : | output byte array. |
Returns : | Returns GSASL_OK if encoding was successful, otherwise an error code. |
Since 0.2.0
int gsasl_decode_inline (Gsasl_session *sctx, const char *input, size_t input_len, char *output);
gsasl_decode_inline is deprecated and should not be used in newly-written code. Use gsasl_decode() instead.
Decode data according to negotiated SASL mechanism. This might mean that data is integrity or privacy protected.
sctx : | libgsasl session handle. |
input : | input byte array. |
input_len : | size of input byte array. |
output : | output byte array. |
Returns : | Returns GSASL_OK if encoding was successful, otherwise an error code. |
Since 0.2.0
void gsasl_application_data_set (Gsasl *ctx);
gsasl_application_data_set is deprecated and should not be used in newly-written code. Use gsasl_callback_hook_set() instead.
Store application specific data in the libgsasl handle. The application data can be later (for instance, inside a callback) be retrieved by calling gsasl_application_data_get(). It is normally used by the application to maintain state between the main program and the callback.
ctx : | libgsasl handle. |
void* gsasl_application_data_get ();
gsasl_application_data_get is deprecated and should not be used in newly-written code. Use gsasl_callback_hook_get() instead.
Retrieve application specific data from libgsasl handle. The application data is set using gsasl_application_data_set(). It is normally used by the application to maintain state between the main program and the callback.
void gsasl_appinfo_set (Gsasl_session *sctx);
gsasl_appinfo_set is deprecated and should not be used in newly-written code. Use gsasl_callback_hook_set() instead.
Store application specific data in the libgsasl session handle. The application data can be later (for instance, inside a callback) be retrieved by calling gsasl_appinfo_get(). It is normally used by the application to maintain state between the main program and the callback.
sctx : | libgsasl session handle. |
void* gsasl_appinfo_get ();
gsasl_appinfo_get is deprecated and should not be used in newly-written code. Use gsasl_callback_hook_get() instead.
Retrieve application specific data from libgsasl session handle. The application data is set using gsasl_appinfo_set(). It is normally used by the application to maintain state between the main program and the callback.
const char* gsasl_server_suggest_mechanism (Gsasl *ctx);
gsasl_server_suggest_mechanism is deprecated and should not be used in newly-written code. This function was never useful, since it is the client that chose which mechanism to use.
ctx : | libgsasl handle. |
Returns : | Returns name of "best" SASL mechanism supported by the libgsasl server which is present in the input string. |
int (*Gsasl_client_callback_anonymous) (Gsasl_session *sctx, char *out, size_t *outlen);
sctx : | |
out : | |
outlen : | |
Returns : |
int (*Gsasl_client_callback_authentication_id) (Gsasl_session *sctx, char *out, size_t *outlen);
sctx : | |
out : | |
outlen : | |
Returns : |
int (*Gsasl_client_callback_authorization_id) (Gsasl_session *sctx, char *out, size_t *outlen);
sctx : | |
out : | |
outlen : | |
Returns : |
int (*Gsasl_client_callback_password) (Gsasl_session *sctx, char *out, size_t *outlen);
sctx : | |
out : | |
outlen : | |
Returns : |
int (*Gsasl_client_callback_passcode) (Gsasl_session *sctx, char *out, size_t *outlen);
sctx : | |
out : | |
outlen : | |
Returns : |
int (*Gsasl_client_callback_pin) (Gsasl_session *sctx, char *suggestion, char *out, size_t *outlen);
sctx : | |
suggestion : | |
out : | |
outlen : | |
Returns : |
int (*Gsasl_client_callback_service) (Gsasl_session *sctx, char *service, size_t *servicelen, char *hostname, size_t *hostnamelen, char *servicename, size_t *servicenamelen);
sctx : | |
service : | |
servicelen : | |
hostname : | |
hostnamelen : | |
servicename : | |
servicenamelen : | |
Returns : |
Gsasl_qop (*Gsasl_client_callback_qop) (Gsasl_session *sctx, Gsasl_qop serverqops);
sctx : | |
serverqops : | |
Returns : |
size_t (*Gsasl_client_callback_maxbuf) (Gsasl_session *sctx, size_t servermaxbuf);
sctx : | |
servermaxbuf : | |
Returns : |
int (*Gsasl_client_callback_realm) (Gsasl_session *sctx, char *out, size_t *outlen);
sctx : | |
out : | |
outlen : | |
Returns : |
int (*Gsasl_server_callback_retrieve) (Gsasl_session *sctx, const char *authentication_id, const char *authorization_id, const char *realm, char *key, size_t *keylen);
sctx : | |
authentication_id : | |
authorization_id : | |
realm : | |
key : | |
keylen : | |
Returns : |
int (*Gsasl_server_callback_validate) (Gsasl_session *sctx, const char *authorization_id, const char *authentication_id, const char *password);
sctx : | |
authorization_id : | |
authentication_id : | |
password : | |
Returns : |
int (*Gsasl_server_callback_gssapi) (Gsasl_session *sctx, const char *clientname, const char *authentication_id);
sctx : | |
clientname : | |
authentication_id : | |
Returns : |
int (*Gsasl_server_callback_securid) (Gsasl_session *sctx, const char *authentication_id, const char *authorization_id, const char *passcode, char *pin, char *suggestpin, size_t *suggestpinlen);
sctx : | |
authentication_id : | |
authorization_id : | |
passcode : | |
pin : | |
suggestpin : | |
suggestpinlen : | |
Returns : |
int (*Gsasl_server_callback_cram_md5) (Gsasl_session *sctx, char *username, char *challenge, char *response);
sctx : | |
username : | |
challenge : | |
response : | |
Returns : |
int (*Gsasl_server_callback_digest_md5) (Gsasl_session *sctx, char *username, char *realm, char *secrethash);
sctx : | |
username : | |
realm : | |
secrethash : | |
Returns : |
int (*Gsasl_server_callback_service) (Gsasl_session *sctx, char *service, size_t *servicelen, char *hostname, size_t *hostnamelen);
sctx : | |
service : | |
servicelen : | |
hostname : | |
hostnamelen : | |
Returns : |
int (*Gsasl_server_callback_external) (Gsasl_session *sctx);
sctx : | |
Returns : |
int (*Gsasl_server_callback_anonymous) (Gsasl_session *sctx, const char *token);
sctx : | |
token : | |
Returns : |
int (*Gsasl_server_callback_realm) (Gsasl_session *sctx, char *out, size_t *outlen, size_t nth);
sctx : | |
out : | |
outlen : | |
nth : | |
Returns : |
Gsasl_qop (*Gsasl_server_callback_qop) (Gsasl_session *sctx);
sctx : | |
Returns : |
size_t (*Gsasl_server_callback_maxbuf) (Gsasl_session *sctx);
sctx : | |
Returns : |
Gsasl_cipher (*Gsasl_server_callback_cipher) (Gsasl_session *sctx);
sctx : | |
Returns : |
Gsasl_client_callback_authorization_id gsasl_client_callback_authorization_id_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_authorization_id_set(). |
Gsasl_client_callback_authentication_id gsasl_client_callback_authentication_id_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_authentication_id_set(). |
void gsasl_client_callback_anonymous_set (Gsasl *ctx);
Specify the callback function to use in the client to set the anonymous token, which usually is the users email address. The function can be later retrieved using gsasl_client_callback_anonymous_get().
ctx : | libgsasl handle. |
Gsasl_client_callback_anonymous gsasl_client_callback_anonymous_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_anonymous_set(). |
void gsasl_client_callback_password_set (Gsasl *ctx);
Specify the callback function to use in the client to set the password. The function can be later retrieved using gsasl_client_callback_password_get().
ctx : | libgsasl handle. |
Gsasl_client_callback_password gsasl_client_callback_password_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_password_set(). |
void gsasl_client_callback_passcode_set (Gsasl *ctx);
Specify the callback function to use in the client to set the passcode. The function can be later retrieved using gsasl_client_callback_passcode_get().
ctx : | libgsasl handle. |
Gsasl_client_callback_passcode gsasl_client_callback_passcode_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_passcode_set(). |
void gsasl_client_callback_pin_set (Gsasl *ctx);
Specify the callback function to use in the client to chose a new pin, possibly suggested by the server, for the SECURID mechanism. This is not normally invoked, but only when the server requests it. The function can be later retrieved using gsasl_client_callback_pin_get().
ctx : | libgsasl handle. |
Gsasl_client_callback_pin gsasl_client_callback_pin_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_pin_set(). |
void gsasl_client_callback_service_set (Gsasl *ctx);
Specify the callback function to use in the client to set the name of the service. The service buffer should be a registered GSSAPI host-based service name, hostname the name of the server. Servicename is used by DIGEST-MD5 and should be the name of generic server in case of a replicated service. The function can be later retrieved using gsasl_client_callback_service_get().
ctx : | libgsasl handle. |
Gsasl_client_callback_service gsasl_client_callback_service_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_service_set(). |
void gsasl_client_callback_qop_set (Gsasl *ctx);
Specify the callback function to use in the client to determine the qop to use after looking at what the server offered. The function can be later retrieved using gsasl_client_callback_qop_get().
ctx : | libgsasl handle. |
Gsasl_client_callback_qop gsasl_client_callback_qop_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_qop_set(). |
void gsasl_client_callback_maxbuf_set (Gsasl *ctx);
Specify the callback function to use in the client to inform the server of the largest buffer the client is able to receive when using the DIGEST-MD5 "auth-int" or "auth-conf" Quality of Protection (qop). If this directive is missing, the default value 65536 will be assumed. The function can be later retrieved using gsasl_client_callback_maxbuf_get().
ctx : | libgsasl handle. |
Gsasl_client_callback_maxbuf gsasl_client_callback_maxbuf_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_maxbuf_set(). |
void gsasl_client_callback_realm_set (Gsasl *ctx);
Specify the callback function to use in the client to know which realm it belongs to. The realm is used by the server to determine which username and password to use. The function can be later retrieved using gsasl_client_callback_realm_get().
ctx : | libgsasl handle. |
Gsasl_client_callback_realm gsasl_client_callback_realm_get ();
Returns : | Returns the callback earlier set by calling gsasl_client_callback_realm_set(). |
void gsasl_server_callback_validate_set (Gsasl *ctx);
Specify the callback function to use in the server for deciding if user is authenticated using authentication identity, authorization identity and password. The function can be later retrieved using gsasl_server_callback_validate_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_validate gsasl_server_callback_validate_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_validate_set(). |
void gsasl_server_callback_retrieve_set (Gsasl *ctx);
Specify the callback function to use in the server for deciding if user is authenticated using authentication identity, authorization identity and password. The function can be later retrieved using gsasl_server_callback_retrieve_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_retrieve gsasl_server_callback_retrieve_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_retrieve_set(). |
void gsasl_server_callback_cram_md5_set (Gsasl *ctx);
Specify the callback function to use in the server for deciding if user is authenticated using CRAM-MD5 challenge and response. The function can be later retrieved using gsasl_server_callback_cram_md5_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_cram_md5 gsasl_server_callback_cram_md5_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_cram_md5_set(). |
void gsasl_server_callback_digest_md5_set (Gsasl *ctx);
Specify the callback function to use in the server for retrieving the secret hash of the username, realm and password for use in the DIGEST-MD5 mechanism. The function can be later retrieved using gsasl_server_callback_digest_md5_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_digest_md5 gsasl_server_callback_digest_md5_get ();
Returns : | Return the callback earlier set by calling gsasl_server_callback_digest_md5_set(). |
void gsasl_server_callback_external_set (Gsasl *ctx);
Specify the callback function to use in the server for deciding if user is authenticated out of band. The function can be later retrieved using gsasl_server_callback_external_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_external gsasl_server_callback_external_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_external_set(). |
void gsasl_server_callback_anonymous_set (Gsasl *ctx);
Specify the callback function to use in the server for deciding if user is permitted anonymous access. The function can be later retrieved using gsasl_server_callback_anonymous_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_anonymous gsasl_server_callback_anonymous_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_anonymous_set(). |
void gsasl_server_callback_realm_set (Gsasl *ctx);
Specify the callback function to use in the server to know which realm it serves. The realm is used by the user to determine which username and password to use. The function can be later retrieved using gsasl_server_callback_realm_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_realm gsasl_server_callback_realm_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_realm_set(). |
void gsasl_server_callback_qop_set (Gsasl *ctx);
Specify the callback function to use in the server to know which quality of protection it accepts. The quality of protection eventually used is selected by the client though. It is currently used by the DIGEST-MD5 mechanism. The function can be later retrieved using gsasl_server_callback_qop_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_qop gsasl_server_callback_qop_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_qop_set(). |
void gsasl_server_callback_maxbuf_set (Gsasl *ctx);
Specify the callback function to use in the server to inform the client of the largest buffer the server is able to receive when using the DIGEST-MD5 "auth-int" or "auth-conf" Quality of Protection (qop). If this directive is missing, the default value 65536 will be assumed. The function can be later retrieved using gsasl_server_callback_maxbuf_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_maxbuf gsasl_server_callback_maxbuf_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_maxbuf_set(). |
void gsasl_server_callback_cipher_set (Gsasl *ctx);
Specify the callback function to use in the server to inform the client of the cipher suites supported. The DES and 3DES ciphers must be supported for interoperability. It is currently used by the DIGEST-MD5 mechanism. The function can be later retrieved using gsasl_server_callback_cipher_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_cipher gsasl_server_callback_cipher_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_cipher_set(). |
void gsasl_server_callback_securid_set (Gsasl *ctx);
Specify the callback function to use in the server for validating a user via the SECURID mechanism. The function should return GSASL_OK if user authenticated successfully, GSASL_SECURID_SERVER_NEED_ADDITIONAL_PASSCODE if it wants another passcode, GSASL_SECURID_SERVER_NEED_NEW_PIN if it wants a PIN change, or an error. When (and only when) GSASL_SECURID_SERVER_NEED_NEW_PIN is returned, suggestpin can be populated with a PIN code the server suggests, and suggestpinlen set to the length of the PIN. The function can be later retrieved using gsasl_server_callback_securid_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_securid gsasl_server_callback_securid_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_securid_set(). |
void gsasl_server_callback_gssapi_set (Gsasl *ctx);
Specify the callback function to use in the server for checking if a GSSAPI user is authorized for username (by, e.g., calling krb5_userok()). The function should return GSASL_OK if the user should be permitted access, or an error code such as GSASL_AUTHENTICATION_ERROR on failure. The function can be later retrieved using gsasl_server_callback_gssapi_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_gssapi gsasl_server_callback_gssapi_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_gssapi_set(). |
void gsasl_server_callback_service_set (Gsasl *ctx);
Specify the callback function to use in the server to set the name of the service. The service buffer should be a registered GSSAPI host-based service name, hostname the name of the server. The function can be later retrieved using gsasl_server_callback_service_get().
ctx : | libgsasl handle. |
Gsasl_server_callback_service gsasl_server_callback_service_get ();
Returns : | Returns the callback earlier set by calling gsasl_server_callback_service_set(). |
<< gsasl-mech | Index >> |