gsasl  1.8.0
Defines | Functions
obsolete.c File Reference
#include "internal.h"
#include <minmax.h>

Go to the source code of this file.

Defines

#define MAX_SECURID   32 /* See RFC 2808. */

Functions

int gsasl_client_listmech (Gsasl *ctx, char *out, size_t *outlen)
int gsasl_server_listmech (Gsasl *ctx, char *out, size_t *outlen)
int gsasl_client_step (Gsasl_session *sctx, const char *input, size_t input_len, char *output, size_t *output_len)
int gsasl_server_step (Gsasl_session *sctx, const char *input, size_t input_len, char *output, size_t *output_len)
int gsasl_client_step_base64 (Gsasl_session *sctx, const char *b64input, char *b64output, size_t b64output_len)
int gsasl_server_step_base64 (Gsasl_session *sctx, const char *b64input, char *b64output, size_t b64output_len)
void gsasl_client_finish (Gsasl_session *sctx)
void gsasl_server_finish (Gsasl_session *sctx)
Gsaslgsasl_client_ctx_get (Gsasl_session *sctx)
void gsasl_client_application_data_set (Gsasl_session *sctx, void *application_data)
void * gsasl_client_application_data_get (Gsasl_session *sctx)
Gsaslgsasl_server_ctx_get (Gsasl_session *sctx)
void gsasl_server_application_data_set (Gsasl_session *sctx, void *application_data)
void * gsasl_server_application_data_get (Gsasl_session *sctx)
int gsasl_randomize (int strong, char *data, size_t datalen)
Gsaslgsasl_ctx_get (Gsasl_session *sctx)
int gsasl_encode_inline (Gsasl_session *sctx, const char *input, size_t input_len, char *output, size_t *output_len)
int gsasl_decode_inline (Gsasl_session *sctx, const char *input, size_t input_len, char *output, size_t *output_len)
void gsasl_application_data_set (Gsasl *ctx, void *appdata)
void * gsasl_application_data_get (Gsasl *ctx)
void gsasl_appinfo_set (Gsasl_session *sctx, void *appdata)
void * gsasl_appinfo_get (Gsasl_session *sctx)
const char * gsasl_server_suggest_mechanism (Gsasl *ctx, const char *mechlist)
void gsasl_client_callback_authentication_id_set (Gsasl *ctx, Gsasl_client_callback_authentication_id cb)
Gsasl_client_callback_authentication_id gsasl_client_callback_authentication_id_get (Gsasl *ctx)
void gsasl_client_callback_authorization_id_set (Gsasl *ctx, Gsasl_client_callback_authorization_id cb)
Gsasl_client_callback_authorization_id gsasl_client_callback_authorization_id_get (Gsasl *ctx)
void gsasl_client_callback_password_set (Gsasl *ctx, Gsasl_client_callback_password cb)
Gsasl_client_callback_password gsasl_client_callback_password_get (Gsasl *ctx)
void gsasl_client_callback_passcode_set (Gsasl *ctx, Gsasl_client_callback_passcode cb)
Gsasl_client_callback_passcode gsasl_client_callback_passcode_get (Gsasl *ctx)
void gsasl_client_callback_pin_set (Gsasl *ctx, Gsasl_client_callback_pin cb)
Gsasl_client_callback_pin gsasl_client_callback_pin_get (Gsasl *ctx)
void gsasl_client_callback_service_set (Gsasl *ctx, Gsasl_client_callback_service cb)
Gsasl_client_callback_service gsasl_client_callback_service_get (Gsasl *ctx)
void gsasl_client_callback_anonymous_set (Gsasl *ctx, Gsasl_client_callback_anonymous cb)
Gsasl_client_callback_anonymous gsasl_client_callback_anonymous_get (Gsasl *ctx)
void gsasl_client_callback_qop_set (Gsasl *ctx, Gsasl_client_callback_qop cb)
Gsasl_client_callback_qop gsasl_client_callback_qop_get (Gsasl *ctx)
void gsasl_client_callback_maxbuf_set (Gsasl *ctx, Gsasl_client_callback_maxbuf cb)
Gsasl_client_callback_maxbuf gsasl_client_callback_maxbuf_get (Gsasl *ctx)
void gsasl_client_callback_realm_set (Gsasl *ctx, Gsasl_client_callback_realm cb)
Gsasl_client_callback_realm gsasl_client_callback_realm_get (Gsasl *ctx)
void gsasl_server_callback_validate_set (Gsasl *ctx, Gsasl_server_callback_validate cb)
Gsasl_server_callback_validate gsasl_server_callback_validate_get (Gsasl *ctx)
void gsasl_server_callback_retrieve_set (Gsasl *ctx, Gsasl_server_callback_retrieve cb)
Gsasl_server_callback_retrieve gsasl_server_callback_retrieve_get (Gsasl *ctx)
void gsasl_server_callback_cram_md5_set (Gsasl *ctx, Gsasl_server_callback_cram_md5 cb)
Gsasl_server_callback_cram_md5 gsasl_server_callback_cram_md5_get (Gsasl *ctx)
void gsasl_server_callback_digest_md5_set (Gsasl *ctx, Gsasl_server_callback_digest_md5 cb)
Gsasl_server_callback_digest_md5 gsasl_server_callback_digest_md5_get (Gsasl *ctx)
void gsasl_server_callback_external_set (Gsasl *ctx, Gsasl_server_callback_external cb)
Gsasl_server_callback_external gsasl_server_callback_external_get (Gsasl *ctx)
void gsasl_server_callback_anonymous_set (Gsasl *ctx, Gsasl_server_callback_anonymous cb)
Gsasl_server_callback_anonymous gsasl_server_callback_anonymous_get (Gsasl *ctx)
void gsasl_server_callback_realm_set (Gsasl *ctx, Gsasl_server_callback_realm cb)
Gsasl_server_callback_realm gsasl_server_callback_realm_get (Gsasl *ctx)
void gsasl_server_callback_qop_set (Gsasl *ctx, Gsasl_server_callback_qop cb)
Gsasl_server_callback_qop gsasl_server_callback_qop_get (Gsasl *ctx)
void gsasl_server_callback_maxbuf_set (Gsasl *ctx, Gsasl_server_callback_maxbuf cb)
Gsasl_server_callback_maxbuf gsasl_server_callback_maxbuf_get (Gsasl *ctx)
void gsasl_server_callback_cipher_set (Gsasl *ctx, Gsasl_server_callback_cipher cb)
Gsasl_server_callback_cipher gsasl_server_callback_cipher_get (Gsasl *ctx)
void gsasl_server_callback_securid_set (Gsasl *ctx, Gsasl_server_callback_securid cb)
Gsasl_server_callback_securid gsasl_server_callback_securid_get (Gsasl *ctx)
void gsasl_server_callback_gssapi_set (Gsasl *ctx, Gsasl_server_callback_gssapi cb)
Gsasl_server_callback_gssapi gsasl_server_callback_gssapi_get (Gsasl *ctx)
void gsasl_server_callback_service_set (Gsasl *ctx, Gsasl_server_callback_service cb)
Gsasl_server_callback_service gsasl_server_callback_service_get (Gsasl *ctx)
char * gsasl_stringprep_nfkc (const char *in, ssize_t len)
char * gsasl_stringprep_saslprep (const char *in, int *stringprep_rc)
char * gsasl_stringprep_trace (const char *in, int *stringprep_rc)
int gsasl_md5pwd_get_password (const char *filename, const char *username, char *key, size_t *keylen)
int gsasl_base64_encode (char const *src, size_t srclength, char *target, size_t targsize)
int gsasl_base64_decode (char const *src, char *target, size_t targsize)
const char * _gsasl_obsolete_property_map (Gsasl_session *sctx, Gsasl_property prop)
int _gsasl_obsolete_callback (Gsasl *ctx, Gsasl_session *sctx, Gsasl_property prop)

Define Documentation

#define MAX_SECURID   32 /* See RFC 2808. */

Function Documentation

int _gsasl_obsolete_callback ( Gsasl ctx,
Gsasl_session sctx,
Gsasl_property  prop 
)

Definition at line 2058 of file obsolete.c.

const char* _gsasl_obsolete_property_map ( Gsasl_session sctx,
Gsasl_property  prop 
)

Definition at line 2041 of file obsolete.c.

void* gsasl_appinfo_get ( Gsasl_session sctx)

gsasl_appinfo_get:

Parameters:
sctxlibgsasl session handle.

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.

Return value: Returns the application specific data, or NULL.

Deprecated: Use gsasl_callback_hook_get() instead.

Definition at line 606 of file obsolete.c.

void gsasl_appinfo_set ( Gsasl_session sctx,
void *  appdata 
)

gsasl_appinfo_set:

Parameters:
sctxlibgsasl session handle.
appdataopaque pointer to application specific data.

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.

Deprecated: Use gsasl_callback_hook_set() instead.

Definition at line 587 of file obsolete.c.

gsasl_application_data_get:

Parameters:
ctxlibgsasl handle.

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.

Return value: Returns the application specific data, or NULL.

Deprecated: Use gsasl_callback_hook_get() instead.

Definition at line 568 of file obsolete.c.

void gsasl_application_data_set ( Gsasl ctx,
void *  appdata 
)

gsasl_application_data_set:

Parameters:
ctxlibgsasl handle.
appdataopaque pointer to application specific data.

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.

Deprecated: Use gsasl_callback_hook_set() instead.

Definition at line 549 of file obsolete.c.

int gsasl_base64_decode ( char const *  src,
char *  target,
size_t  targsize 
)

gsasl_base64_decode:

Parameters:
srcinput byte array
targetoutput byte array
targsizesize of output byte array

Decode Base64 data. Skips all whitespace anywhere. Converts characters, four at a time, starting at (or after) src from Base64 numbers into three 8 bit bytes in the target area.

Return value: Returns the number of data bytes stored at the target, or -1 on error.

Deprecated: Use gsasl_base64_from() instead.

Definition at line 1858 of file obsolete.c.

int gsasl_base64_encode ( char const *  src,
size_t  srclength,
char *  target,
size_t  targsize 
)

gsasl_base64_encode:

Parameters:
srcinput byte array
srclengthsize of input byte array
targetoutput byte array
targsizesize of output byte array

Encode data as base64. Converts characters, three at a time, starting at src into four base64 characters in the target area until the entire input buffer is encoded.

Return value: Returns the number of data bytes stored at the target, or -1 on error.

Deprecated: Use gsasl_base64_to() instead.

Definition at line 1823 of file obsolete.c.

gsasl_client_application_data_get:

Parameters:
sctxlibgsasl client handle.

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.

Return value: Returns the application specific data, or NULL.

Deprecated: Use gsasl_callback_hook_get() or gsasl_session_hook_get() instead.

Definition at line 356 of file obsolete.c.

void gsasl_client_application_data_set ( Gsasl_session sctx,
void *  application_data 
)

gsasl_client_application_data_set:

Parameters:
sctxlibgsasl client handle.
application_dataopaque pointer to application specific data.

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.

Deprecated: Use gsasl_callback_hook_set() or gsasl_session_hook_set() instead.

Definition at line 335 of file obsolete.c.

gsasl_client_callback_anonymous_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_anonymous_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_anonymous_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 931 of file obsolete.c.

gsasl_client_callback_anonymous_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 909 of file obsolete.c.

gsasl_client_callback_authentication_id_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_authentication_id_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_authentication_id_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 670 of file obsolete.c.

gsasl_client_callback_authentication_id_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

Specify the callback function to use in the client to set the authentication identity. The function can be later retrieved using gsasl_client_callback_authentication_id_get().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 647 of file obsolete.c.

gsasl_client_callback_authorization_id_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_authorization_id_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_authorization_id_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 713 of file obsolete.c.

gsasl_client_callback_authorization_id_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

Specify the callback function to use in the client to set the authorization identity. The function can be later retrieved using gsasl_client_callback_authorization_id_get().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 690 of file obsolete.c.

gsasl_client_callback_maxbuf_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_maxbuf_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_maxbuf_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1017 of file obsolete.c.

gsasl_client_callback_maxbuf_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 995 of file obsolete.c.

gsasl_client_callback_passcode_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_passcode_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_passcode_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 799 of file obsolete.c.

gsasl_client_callback_passcode_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 776 of file obsolete.c.

gsasl_client_callback_password_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_password_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_password_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 756 of file obsolete.c.

gsasl_client_callback_password_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 733 of file obsolete.c.

gsasl_client_callback_pin_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_pin_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_pin_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 843 of file obsolete.c.

gsasl_client_callback_pin_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 821 of file obsolete.c.

gsasl_client_callback_qop_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_qop_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_qop_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 972 of file obsolete.c.

gsasl_client_callback_qop_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 951 of file obsolete.c.

gsasl_client_callback_realm_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_realm_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_realm_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1059 of file obsolete.c.

gsasl_client_callback_realm_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1038 of file obsolete.c.

gsasl_client_callback_service_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_client_callback_service_set().

Return value: Returns the callback earlier set by calling gsasl_client_callback_service_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 888 of file obsolete.c.

gsasl_client_callback_service_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 866 of file obsolete.c.

gsasl_client_ctx_get:

Parameters:
sctxlibgsasl client handle

Get the libgsasl handle given a libgsasl client handle.

Return value: Returns the libgsasl handle given a libgsasl client handle.

Deprecated: This function is not useful with the new 0.2.0 API.

Definition at line 315 of file obsolete.c.

gsasl_client_finish:

Parameters:
sctxlibgsasl client handle.

Destroy a libgsasl client handle. The handle must not be used with other libgsasl functions after this call.

Deprecated: Use gsasl_finish() instead.

Definition at line 284 of file obsolete.c.

int gsasl_client_listmech ( Gsasl ctx,
char *  out,
size_t *  outlen 
)

gsasl_client_listmech:

Parameters:
ctxlibgsasl handle.
outoutput character array.
outleninput maximum size of output character array, on output contains actual length of output array.

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 a NULL parameter.

Return value: Returns GSASL_OK if successful, or error code.

Deprecated: Use gsasl_client_mechlist() instead.

Definition at line 46 of file obsolete.c.

int gsasl_client_step ( Gsasl_session sctx,
const char *  input,
size_t  input_len,
char *  output,
size_t *  output_len 
)

gsasl_client_step:

Parameters:
sctxlibgsasl client handle.
inputinput byte array.
input_lensize of input byte array.
outputoutput byte array.
output_lensize of output byte array.

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.

Return value: Returns GSASL_OK if authenticated terminated successfully, GSASL_NEEDS_MORE if more data is needed, or error code.

Deprecated: Use gsasl_step() instead.

Definition at line 167 of file obsolete.c.

int gsasl_client_step_base64 ( Gsasl_session sctx,
const char *  b64input,
char *  b64output,
size_t  b64output_len 
)

gsasl_client_step_base64:

Parameters:
sctxlibgsasl client handle.
b64inputinput base64 encoded byte array.
b64outputoutput base64 encoded byte array.
b64output_lensize of output base64 encoded byte array.

This is a simple wrapper around gsasl_client_step() that base64 decodes the input and base64 encodes the output.

Return value: See gsasl_client_step().

Deprecated: Use gsasl_step64() instead.

Definition at line 245 of file obsolete.c.

gsasl_ctx_get:

Parameters:
sctxlibgsasl session handle

Get the libgsasl handle given a libgsasl session handle.

Return value: Returns the libgsasl handle given a libgsasl session handle.

Deprecated: This function is not useful with the new 0.2.0 API.

Definition at line 450 of file obsolete.c.

int gsasl_decode_inline ( Gsasl_session sctx,
const char *  input,
size_t  input_len,
char *  output,
size_t *  output_len 
)

gsasl_decode_inline:

Parameters:
sctxlibgsasl session handle.
inputinput byte array.
input_lensize of input byte array.
outputoutput byte array.
output_lensize of output byte array.

Decode data according to negotiated SASL mechanism. This might mean that data is integrity or privacy protected.

Return value: Returns GSASL_OK if encoding was successful, otherwise an error code.

Deprecated: Use gsasl_decode() instead.

Since: 0.2.0

Definition at line 514 of file obsolete.c.

int gsasl_encode_inline ( Gsasl_session sctx,
const char *  input,
size_t  input_len,
char *  output,
size_t *  output_len 
)

gsasl_encode_inline:

Parameters:
sctxlibgsasl session handle.
inputinput byte array.
input_lensize of input byte array.
outputoutput byte array.
output_lensize of output byte array.

Encode data according to negotiated SASL mechanism. This might mean that data is integrity or privacy protected.

Return value: Returns GSASL_OK if encoding was successful, otherwise an error code.

Deprecated: Use gsasl_encode() instead.

Since: 0.2.0

Definition at line 474 of file obsolete.c.

int gsasl_md5pwd_get_password ( const char *  filename,
const char *  username,
char *  key,
size_t *  keylen 
)

gsasl_md5pwd_get_password:

Parameters:
filenamefilename of file containing passwords.
usernameusername string.
keyoutput character array.
keyleninput maximum size of output character array, on output contains actual length of output array.

Retrieve password for user from specified file. To find out how large the output array must be, call this function with out=NULL.

The file should be on the UoW "MD5 Based Authentication" format, which means it is in text format with comments denoted by # first on the line, with user entries looking as "usernameTABpassword". This function removes CR and LF at the end of lines before processing. TAB, CR, and LF denote ASCII values 9, 13, and 10, respectively.

Return value: Return GSASL_OK if output buffer contains the password, GSASL_AUTHENTICATION_ERROR if the user could not be found, or other error code.

Deprecated: Use gsasl_simple_getpass() instead.

Definition at line 1769 of file obsolete.c.

int gsasl_randomize ( int  strong,
char *  data,
size_t  datalen 
)

gsasl_randomize:

Parameters:
strong0 iff operation should not block, non-0 for very strong randomness.
dataoutput array to be filled with random data.
datalensize of output array.

Store cryptographically random data of given size in the provided buffer.

Return value: Returns GSASL_OK iff successful.

Deprecated: Use gsasl_random() or gsasl_nonce() instead.

Definition at line 432 of file obsolete.c.

gsasl_server_application_data_get:

Parameters:
sctxlibgsasl server handle.

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.

Return value: Returns the application specific data, or NULL.

Deprecated: Use gsasl_callback_hook_get() or gsasl_session_hook_get() instead.

Definition at line 413 of file obsolete.c.

void gsasl_server_application_data_set ( Gsasl_session sctx,
void *  application_data 
)

gsasl_server_application_data_set:

Parameters:
sctxlibgsasl server handle.
application_dataopaque pointer to application specific data.

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.

Deprecated: Use gsasl_callback_hook_set() or gsasl_session_hook_set() instead.

Definition at line 392 of file obsolete.c.

gsasl_server_callback_anonymous_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_anonymous_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_anonymous_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1315 of file obsolete.c.

gsasl_server_callback_anonymous_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1293 of file obsolete.c.

gsasl_server_callback_cipher_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_cipher_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_cipher_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1489 of file obsolete.c.

gsasl_server_callback_cipher_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1467 of file obsolete.c.

gsasl_server_callback_cram_md5_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_cram_md5_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_cram_md5_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1188 of file obsolete.c.

gsasl_server_callback_cram_md5_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1166 of file obsolete.c.

gsasl_server_callback_digest_md5_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_digest_md5_set().

Return value: Return the callback earlier set by calling gsasl_server_callback_digest_md5_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1231 of file obsolete.c.

gsasl_server_callback_digest_md5_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1209 of file obsolete.c.

gsasl_server_callback_external_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_external_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_external_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1273 of file obsolete.c.

gsasl_server_callback_external_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1251 of file obsolete.c.

gsasl_server_callback_gssapi_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_gssapi_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_gssapi_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1583 of file obsolete.c.

gsasl_server_callback_gssapi_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

Specify the callback function to use in the server for checking if a GSSAPI user is authorized for username (by, e.g., calling krb5_kuserok). 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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1561 of file obsolete.c.

gsasl_server_callback_maxbuf_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_maxbuf_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_maxbuf_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1445 of file obsolete.c.

gsasl_server_callback_maxbuf_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1423 of file obsolete.c.

gsasl_server_callback_qop_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_qop_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_qop_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1400 of file obsolete.c.

gsasl_server_callback_qop_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1379 of file obsolete.c.

gsasl_server_callback_realm_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_realm_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_realm_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1357 of file obsolete.c.

gsasl_server_callback_realm_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1336 of file obsolete.c.

gsasl_server_callback_retrieve_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_retrieve_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_retrieve_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1145 of file obsolete.c.

gsasl_server_callback_retrieve_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1123 of file obsolete.c.

gsasl_server_callback_securid_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_securid_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_securid_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1538 of file obsolete.c.

gsasl_server_callback_securid_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1516 of file obsolete.c.

gsasl_server_callback_service_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_service_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_service_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1627 of file obsolete.c.

gsasl_server_callback_service_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1605 of file obsolete.c.

gsasl_server_callback_validate_get:

Parameters:
ctxlibgsasl handle.

Get the callback earlier set by calling gsasl_server_callback_validate_set().

Return value: Returns the callback earlier set by calling gsasl_server_callback_validate_set().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1102 of file obsolete.c.

gsasl_server_callback_validate_set:

Parameters:
ctxlibgsasl handle.
cbcallback function

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().

Deprecated: This function is part of the old callback interface. The new interface uses gsasl_callback_set() to set the application callback, and uses gsasl_callback() or gsasl_property_get() to invoke the callback for certain properties.

Definition at line 1080 of file obsolete.c.

gsasl_server_ctx_get:

Parameters:
sctxlibgsasl server handle

Get the libgsasl handle given a libgsasl server handle.

Return value: Returns the libgsasl handle given a libgsasl server handle.

Deprecated: This function is not useful with the new 0.2.0 API.

Definition at line 372 of file obsolete.c.

gsasl_server_finish:

Parameters:
sctxlibgsasl server handle.

Destroy a libgsasl server handle. The handle must not be used with other libgsasl functions after this call.

Deprecated: Use gsasl_finish() instead.

Definition at line 299 of file obsolete.c.

int gsasl_server_listmech ( Gsasl ctx,
char *  out,
size_t *  outlen 
)

gsasl_server_listmech:

Parameters:
ctxlibgsasl handle.
outoutput character array.
outleninput maximum size of output character array, on output contains actual length of output array.

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 a NULL parameter.

Return value: Returns GSASL_OK if successful, or error code.

Deprecated: Use gsasl_server_mechlist() instead.

Definition at line 89 of file obsolete.c.

int gsasl_server_step ( Gsasl_session sctx,
const char *  input,
size_t  input_len,
char *  output,
size_t *  output_len 
)

gsasl_server_step:

Parameters:
sctxlibgsasl server handle.
inputinput byte array.
input_lensize of input byte array.
outputoutput byte array.
output_lensize of output byte array.

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.

Return value: Returns GSASL_OK if authenticated terminated successfully, GSASL_NEEDS_MORE if more data is needed, or error code.

Deprecated: Use gsasl_step() instead.

Definition at line 197 of file obsolete.c.

int gsasl_server_step_base64 ( Gsasl_session sctx,
const char *  b64input,
char *  b64output,
size_t  b64output_len 
)

gsasl_server_step_base64:

Parameters:
sctxlibgsasl server handle.
b64inputinput base64 encoded byte array.
b64outputoutput base64 encoded byte array.
b64output_lensize of output base64 encoded byte array.

This is a simple wrapper around gsasl_server_step() that base64 decodes the input and base64 encodes the output.

Return value: See gsasl_server_step().

Deprecated: Use gsasl_step64() instead.

Definition at line 267 of file obsolete.c.

const char* gsasl_server_suggest_mechanism ( Gsasl ctx,
const char *  mechlist 
)

gsasl_server_suggest_mechanism:

Parameters:
ctxlibgsasl handle.
mechlistinput character array with SASL mechanism names, separated by invalid characters (e.g. SPC).

Get name of "best" SASL mechanism supported by the libgsasl server which is present in the input string.

Return value: Returns name of "best" SASL mechanism supported by the libgsasl server which is present in the input string.

Deprecated: This function was never useful, since it is the client that chose which mechanism to use.

Definition at line 627 of file obsolete.c.

char* gsasl_stringprep_nfkc ( const char *  in,
ssize_t  len 
)

gsasl_stringprep_nfkc:

Parameters:
ina UTF-8 encoded string.
lenlength of , in bytes, or -1 if is nul-terminated.

Converts a string into canonical form, standardizing such issues as whether a character with an accent is represented as a base character and combining accent or as a single precomposed character.

The normalization mode is NFKC (ALL COMPOSE). It standardizes differences that do not affect the text content, such as the above-mentioned accent representation. It standardizes the "compatibility" characters in Unicode, such as SUPERSCRIPT THREE to the standard forms (in this case DIGIT THREE). Formatting information may be lost but for most text operations such characters should be considered the same. It returns a result with composed forms rather than a maximally decomposed form.

Return value: Return a newly allocated string, that is the NFKC normalized form of , or NULL on error.

Deprecated: No replacement functionality in GNU SASL, use GNU Libidn instead. Note that in SASL, you most likely want to use SASLprep and not bare NFKC, see gsasl_saslprep().

Definition at line 1663 of file obsolete.c.

char* gsasl_stringprep_saslprep ( const char *  in,
int *  stringprep_rc 
)

gsasl_stringprep_saslprep:

Parameters:
ininput ASCII or UTF-8 string with data to prepare according to SASLprep.
stringprep_rcpointer to output variable with stringprep error code, or NULL to indicate that you don't care about it.

Process a Unicode string for comparison, according to the "SASLprep" stringprep profile. This function is intended to be used by Simple Authentication and Security Layer (SASL) mechanisms (such as PLAIN, CRAM-MD5, and DIGEST-MD5) as well as other protocols exchanging user names and/or passwords.

Return value: Return a newly allocated string that is the "SASLprep" processed form of the input string, or NULL on error, in which case contain the stringprep library error code.

Deprecated: Use gsasl_saslprep() instead.

Definition at line 1694 of file obsolete.c.

char* gsasl_stringprep_trace ( const char *  in,
int *  stringprep_rc 
)

gsasl_stringprep_trace:

Parameters:
ininput ASCII or UTF-8 string with data to prepare according to "trace".
stringprep_rcpointer to output variable with stringprep error code, or NULL to indicate that you don't care about it.

Process a Unicode string for use as trace information, according to the "trace" stringprep profile. The profile is designed for use with the SASL ANONYMOUS Mechanism.

Return value: Return a newly allocated string that is the "trace" processed form of the input string, or NULL on error, in which case contain the stringprep library error code.

Deprecated: No replacement functionality in GNU SASL, use GNU Libidn instead.

Definition at line 1728 of file obsolete.c.