gsasl: gsasl-compat.h File Reference

#define __attribute__ ( Spec )

Definition at line 29 of file gsasl-compat.h.

typedef Gsasl_session Gsasl_session_ctx __attribute__((deprecated))

Definition at line 64 of file gsasl-compat.h.

typedef Gsasl Gsasl_ctx __attribute__((deprecated))

Definition at line 63 of file gsasl-compat.h.

typedef int(*) Gsasl_client_callback_anonymous(Gsasl_session *sctx, char *out, size_t *outlen)

Definition at line 148 of file gsasl-compat.h.

typedef int(*) Gsasl_client_callback_authentication_id(Gsasl_session *sctx, char *out, size_t *outlen)

Definition at line 150 of file gsasl-compat.h.

typedef int(*) Gsasl_client_callback_authorization_id(Gsasl_session *sctx, char *out, size_t *outlen)

Definition at line 153 of file gsasl-compat.h.

typedef size_t(*) Gsasl_client_callback_maxbuf(Gsasl_session *sctx, size_t servermaxbuf)

Definition at line 172 of file gsasl-compat.h.

typedef int(*) Gsasl_client_callback_passcode(Gsasl_session *sctx, char *out, size_t *outlen)

Definition at line 158 of file gsasl-compat.h.

typedef int(*) Gsasl_client_callback_password(Gsasl_session *sctx, char *out, size_t *outlen)

Definition at line 156 of file gsasl-compat.h.

typedef int(*) Gsasl_client_callback_pin(Gsasl_session *sctx, char *suggestion, char *out, size_t *outlen)

Definition at line 160 of file gsasl-compat.h.

typedef Gsasl_qop(*) Gsasl_client_callback_qop(Gsasl_session *sctx, Gsasl_qop serverqops)

Definition at line 170 of file gsasl-compat.h.

typedef int(*) Gsasl_client_callback_realm(Gsasl_session *sctx, char *out, size_t *outlen)

Definition at line 174 of file gsasl-compat.h.

typedef int(*) Gsasl_client_callback_service(Gsasl_session *sctx, char *service, size_t *servicelen, char *hostname, size_t *hostnamelen, char *servicename, size_t *servicenamelen)

Definition at line 163 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_anonymous(Gsasl_session *sctx, const char *token)

Definition at line 207 of file gsasl-compat.h.

typedef Gsasl_cipher(*) Gsasl_server_callback_cipher(Gsasl_session *sctx)

Definition at line 213 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_cram_md5(Gsasl_session *sctx, char *username, char *challenge, char *response)

Definition at line 194 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_digest_md5(Gsasl_session *sctx, char *username, char *realm, char *secrethash)

Definition at line 198 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_external(Gsasl_session *sctx)

Definition at line 206 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_gssapi(Gsasl_session *sctx, const char *clientname, const char *authentication_id)

Definition at line 185 of file gsasl-compat.h.

typedef size_t(*) Gsasl_server_callback_maxbuf(Gsasl_session *sctx)

Definition at line 212 of file gsasl-compat.h.

typedef Gsasl_qop(*) Gsasl_server_callback_qop(Gsasl_session *sctx)

Definition at line 211 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_realm(Gsasl_session *sctx, char *out, size_t *outlen, size_t nth)

Definition at line 209 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_retrieve(Gsasl_session *sctx, const char *authentication_id, const char *authorization_id, const char *realm, char *key, size_t *keylen)

Definition at line 176 of file gsasl-compat.h.

typedef 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)

Definition at line 188 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_service(Gsasl_session *sctx, char *service, size_t *servicelen, char *hostname, size_t *hostnamelen)

Definition at line 201 of file gsasl-compat.h.

typedef int(*) Gsasl_server_callback_validate(Gsasl_session *sctx, const char *authorization_id, const char *authentication_id, const char *password)

Definition at line 181 of file gsasl-compat.h.

anonymous enum

Enumerator:

GSASL_TOO_SMALL_BUFFER
GSASL_FOPEN_ERROR
GSASL_FCLOSE_ERROR
GSASL_GCRYPT_ERROR
GSASL_CANNOT_GET_CTX
GSASL_NEED_CLIENT_ANONYMOUS_CALLBACK
GSASL_NEED_CLIENT_PASSWORD_CALLBACK
GSASL_NEED_CLIENT_PASSCODE_CALLBACK
GSASL_NEED_CLIENT_PIN_CALLBACK
GSASL_NEED_CLIENT_AUTHORIZATION_ID_CALLBACK
GSASL_NEED_CLIENT_AUTHENTICATION_ID_CALLBACK
GSASL_NEED_CLIENT_SERVICE_CALLBACK
GSASL_NEED_SERVER_VALIDATE_CALLBACK
GSASL_NEED_SERVER_CRAM_MD5_CALLBACK
GSASL_NEED_SERVER_DIGEST_MD5_CALLBACK
GSASL_NEED_SERVER_EXTERNAL_CALLBACK
GSASL_NEED_SERVER_ANONYMOUS_CALLBACK
GSASL_NEED_SERVER_REALM_CALLBACK
GSASL_NEED_SERVER_SECURID_CALLBACK
GSASL_NEED_SERVER_SERVICE_CALLBACK
GSASL_NEED_SERVER_GSSAPI_CALLBACK
GSASL_NEED_SERVER_RETRIEVE_CALLBACK
GSASL_UNICODE_NORMALIZATION_ERROR
GSASL_NO_MORE_REALMS
GSASL_INVALID_HANDLE

Definition at line 34 of file gsasl-compat.h.

void* gsasl_appinfo_get ( Gsasl_session * sctx )

gsasl_appinfo_get:

Parameters:

sctx

libgsasl 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 594 of file obsolete.c.

References Gsasl_session::application_data.

Referenced by gsasl_client_application_data_get(), and gsasl_server_application_data_get().

void gsasl_appinfo_set	(	Gsasl_session *	sctx,
		void *	appdata
	)

gsasl_appinfo_set:

Parameters:

	sctx	libgsasl session handle.
	appdata	opaque 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 575 of file obsolete.c.

References Gsasl_session::application_data.

Referenced by gsasl_client_application_data_set(), and gsasl_server_application_data_set().

void* gsasl_application_data_get ( Gsasl * ctx )

gsasl_application_data_get:

Parameters:

ctx

libgsasl 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 556 of file obsolete.c.

References Gsasl::application_hook.

void gsasl_application_data_set	(	Gsasl *	ctx,
		void *	appdata
	)

gsasl_application_data_set:

Parameters:

	ctx	libgsasl handle.
	appdata	opaque 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 537 of file obsolete.c.

References Gsasl::application_hook.

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

gsasl_base64_decode:

Parameters:

	src	input byte array
	target	output byte array
	targsize	size 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 1886 of file obsolete.c.

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

gsasl_base64_encode:

Parameters:

	src	input byte array
	srclength	size of input byte array
	target	output byte array
	targsize	size 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 1807 of file obsolete.c.

References Assert.

void* gsasl_client_application_data_get ( Gsasl_session * sctx )

gsasl_client_application_data_get:

Parameters:

sctx

libgsasl 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 348 of file obsolete.c.

References gsasl_appinfo_get().

void gsasl_client_application_data_set	(	Gsasl_session *	sctx,
		void *	application_data
	)

gsasl_client_application_data_set:

Parameters:

	sctx	libgsasl client handle.
	application_data	opaque 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 327 of file obsolete.c.

References gsasl_appinfo_set().

Gsasl_client_callback_anonymous gsasl_client_callback_anonymous_get ( Gsasl * ctx )

gsasl_client_callback_anonymous_get:

Parameters:

ctx

libgsasl handle.

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 895 of file obsolete.c.

References Gsasl::cbc_anonymous.

Referenced by gsasl_property_get().

void gsasl_client_callback_anonymous_set	(	Gsasl *	ctx,
		Gsasl_client_callback_anonymous	cb
	)

gsasl_client_callback_anonymous_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 876 of file obsolete.c.

References Gsasl::cbc_anonymous.

Gsasl_client_callback_authentication_id gsasl_client_callback_authentication_id_get ( Gsasl * ctx )

gsasl_client_callback_authentication_id_get:

Parameters:

ctx

libgsasl handle.

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 652 of file obsolete.c.

References Gsasl::cbc_authentication_id.

Referenced by _gsasl_kerberos_v5_client_step(), and gsasl_property_get().

void gsasl_client_callback_authentication_id_set	(	Gsasl *	ctx,
		Gsasl_client_callback_authentication_id	cb
	)

gsasl_client_callback_authentication_id_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 632 of file obsolete.c.

References Gsasl::cbc_authentication_id.

Gsasl_client_callback_authorization_id gsasl_client_callback_authorization_id_get ( Gsasl * ctx )

gsasl_client_callback_authorization_id_get:

Parameters:

ctx

libgsasl handle.

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 692 of file obsolete.c.

References Gsasl::cbc_authorization_id.

Referenced by _gsasl_kerberos_v5_client_step(), and gsasl_property_get().

void gsasl_client_callback_authorization_id_set	(	Gsasl *	ctx,
		Gsasl_client_callback_authorization_id	cb
	)

gsasl_client_callback_authorization_id_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 672 of file obsolete.c.

References Gsasl::cbc_authorization_id.

Gsasl_client_callback_maxbuf gsasl_client_callback_maxbuf_get ( Gsasl * ctx )

gsasl_client_callback_maxbuf_get:

Parameters:

ctx

libgsasl handle.

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 975 of file obsolete.c.

References Gsasl::cbc_maxbuf.

Referenced by _gsasl_kerberos_v5_client_step().

void gsasl_client_callback_maxbuf_set	(	Gsasl *	ctx,
		Gsasl_client_callback_maxbuf	cb
	)

gsasl_client_callback_maxbuf_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 956 of file obsolete.c.

References Gsasl::cbc_maxbuf.

Gsasl_client_callback_passcode gsasl_client_callback_passcode_get ( Gsasl * ctx )

gsasl_client_callback_passcode_get:

Parameters:

ctx

libgsasl handle.

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 772 of file obsolete.c.

References Gsasl::cbc_passcode.

Referenced by gsasl_property_get().

void gsasl_client_callback_passcode_set	(	Gsasl *	ctx,
		Gsasl_client_callback_passcode	cb
	)

gsasl_client_callback_passcode_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 752 of file obsolete.c.

References Gsasl::cbc_passcode.

Gsasl_client_callback_password gsasl_client_callback_password_get ( Gsasl * ctx )

gsasl_client_callback_password_get:

Parameters:

ctx

libgsasl handle.

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 732 of file obsolete.c.

References Gsasl::cbc_password.

Referenced by _gsasl_kerberos_v5_client_step(), and gsasl_property_get().

void gsasl_client_callback_password_set	(	Gsasl *	ctx,
		Gsasl_client_callback_password	cb
	)

gsasl_client_callback_password_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 712 of file obsolete.c.

References Gsasl::cbc_password.

Gsasl_client_callback_pin gsasl_client_callback_pin_get ( Gsasl * ctx )

gsasl_client_callback_pin_get:

Parameters:

ctx

libgsasl handle.

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 813 of file obsolete.c.

References Gsasl::cbc_pin.

Referenced by gsasl_property_get().

void gsasl_client_callback_pin_set	(	Gsasl *	ctx,
		Gsasl_client_callback_pin	cb
	)

gsasl_client_callback_pin_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 794 of file obsolete.c.

References Gsasl::cbc_pin.

Gsasl_client_callback_qop gsasl_client_callback_qop_get ( Gsasl * ctx )

gsasl_client_callback_qop_get:

Parameters:

ctx

libgsasl handle.

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 933 of file obsolete.c.

References Gsasl::cbc_qop.

Referenced by _gsasl_kerberos_v5_client_step().

void gsasl_client_callback_qop_set	(	Gsasl *	ctx,
		Gsasl_client_callback_qop	cb
	)

gsasl_client_callback_qop_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 915 of file obsolete.c.

References Gsasl::cbc_qop.

Gsasl_client_callback_realm gsasl_client_callback_realm_get ( Gsasl * ctx )

gsasl_client_callback_realm_get:

Parameters:

ctx

libgsasl handle.

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 1014 of file obsolete.c.

References Gsasl::cbc_realm.

Referenced by _gsasl_kerberos_v5_client_step(), and gsasl_property_get().

void gsasl_client_callback_realm_set	(	Gsasl *	ctx,
		Gsasl_client_callback_realm	cb
	)

gsasl_client_callback_realm_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 996 of file obsolete.c.

References Gsasl::cbc_realm.

Gsasl_client_callback_service gsasl_client_callback_service_get ( Gsasl * ctx )

gsasl_client_callback_service_get:

Parameters:

ctx

libgsasl handle.

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 855 of file obsolete.c.

References Gsasl::cbc_service.

Referenced by _gsasl_kerberos_v5_client_step(), and gsasl_property_get().

void gsasl_client_callback_service_set	(	Gsasl *	ctx,
		Gsasl_client_callback_service	cb
	)

gsasl_client_callback_service_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 836 of file obsolete.c.

References Gsasl::cbc_service.

Gsasl* gsasl_client_ctx_get ( Gsasl_session * sctx )

gsasl_client_ctx_get:

Parameters:

sctx

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 307 of file obsolete.c.

References Gsasl_session::ctx.

Referenced by _gsasl_kerberos_v5_client_step().

void gsasl_client_finish ( Gsasl_session * sctx )

gsasl_client_finish:

Parameters:

sctx

libgsasl 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 278 of file obsolete.c.

References gsasl_finish().

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

gsasl_client_listmech:

Parameters:

	ctx	libgsasl handle.
	out	output character array.
	outlen	input 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 out=NULL.

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

Deprecated: Use gsasl_client_mechlist() instead.

Definition at line 41 of file obsolete.c.

References gsasl_client_mechlist(), GSASL_OK, and GSASL_TOO_SMALL_BUFFER.

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

gsasl_client_step:

Parameters:

	sctx	libgsasl client handle.
	input	input byte array.
	input_len	size of input byte array.
	output	output byte array.
	output_len	size 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 161 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:

	sctx	libgsasl client handle.
	b64input	input base64 encoded byte array.
	b64output	output base64 encoded byte array.
	b64output_len	size 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 239 of file obsolete.c.

Gsasl* gsasl_ctx_get ( Gsasl_session * sctx )

gsasl_ctx_get:

Parameters:

sctx

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 438 of file obsolete.c.

References Gsasl_session::ctx.

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

gsasl_decode_inline:

Parameters:

	sctx	libgsasl session handle.
	input	input byte array.
	input_len	size of input byte array.
	output	output byte array.
	output_len	size 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 502 of file obsolete.c.

References gsasl_decode(), GSASL_OK, and GSASL_TOO_SMALL_BUFFER.

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

gsasl_encode_inline:

Parameters:

	sctx	libgsasl session handle.
	input	input byte array.
	input_len	size of input byte array.
	output	output byte array.
	output_len	size 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 462 of file obsolete.c.

References gsasl_encode(), GSASL_OK, and GSASL_TOO_SMALL_BUFFER.

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

gsasl_md5pwd_get_password:

Parameters:

	filename	filename of file containing passwords.
	username	username string.
	key	output character array.
	keylen	input 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 1685 of file obsolete.c.

References GSASL_AUTHENTICATION_ERROR, GSASL_FCLOSE_ERROR, GSASL_FOPEN_ERROR, GSASL_OK, and GSASL_TOO_SMALL_BUFFER.

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

gsasl_randomize:

Parameters:

	strong	0 iff operation should not block, non-0 for very strong randomness.
	data	output array to be filled with random data.
	datalen	size 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 422 of file obsolete.c.

References gsasl_nonce(), and gsasl_random().

void* gsasl_server_application_data_get ( Gsasl_session * sctx )

gsasl_server_application_data_get:

Parameters:

sctx

libgsasl 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 403 of file obsolete.c.

References gsasl_appinfo_get().

void gsasl_server_application_data_set	(	Gsasl_session *	sctx,
		void *	application_data
	)

gsasl_server_application_data_set:

Parameters:

	sctx	libgsasl server handle.
	application_data	opaque 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 382 of file obsolete.c.

References gsasl_appinfo_set().

Gsasl_server_callback_anonymous gsasl_server_callback_anonymous_get ( Gsasl * ctx )

gsasl_server_callback_anonymous_get:

Parameters:

ctx

libgsasl handle.

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 1252 of file obsolete.c.

References Gsasl::cbs_anonymous.

Referenced by gsasl_callback().

void gsasl_server_callback_anonymous_set	(	Gsasl *	ctx,
		Gsasl_server_callback_anonymous	cb
	)

gsasl_server_callback_anonymous_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1233 of file obsolete.c.

References Gsasl::cbs_anonymous.

Gsasl_server_callback_cipher gsasl_server_callback_cipher_get ( Gsasl * ctx )

gsasl_server_callback_cipher_get:

Parameters:

ctx

libgsasl handle.

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 1414 of file obsolete.c.

References Gsasl::cbs_cipher.

void gsasl_server_callback_cipher_set	(	Gsasl *	ctx,
		Gsasl_server_callback_cipher	cb
	)

gsasl_server_callback_cipher_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1395 of file obsolete.c.

References Gsasl::cbs_cipher.

Gsasl_server_callback_cram_md5 gsasl_server_callback_cram_md5_get ( Gsasl * ctx )

gsasl_server_callback_cram_md5_get:

Parameters:

ctx

libgsasl handle.

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 1134 of file obsolete.c.

References Gsasl::cbs_cram_md5.

void gsasl_server_callback_cram_md5_set	(	Gsasl *	ctx,
		Gsasl_server_callback_cram_md5	cb
	)

gsasl_server_callback_cram_md5_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1115 of file obsolete.c.

References Gsasl::cbs_cram_md5.

Gsasl_server_callback_digest_md5 gsasl_server_callback_digest_md5_get ( Gsasl * ctx )

gsasl_server_callback_digest_md5_get:

Parameters:

ctx

libgsasl handle.

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 1174 of file obsolete.c.

References Gsasl::cbs_digest_md5.

void gsasl_server_callback_digest_md5_set	(	Gsasl *	ctx,
		Gsasl_server_callback_digest_md5	cb
	)

gsasl_server_callback_digest_md5_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1155 of file obsolete.c.

References Gsasl::cbs_digest_md5.

Gsasl_server_callback_external gsasl_server_callback_external_get ( Gsasl * ctx )

gsasl_server_callback_external_get:

Parameters:

ctx

libgsasl handle.

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 1213 of file obsolete.c.

References Gsasl::cbs_external.

Referenced by gsasl_callback().

void gsasl_server_callback_external_set	(	Gsasl *	ctx,
		Gsasl_server_callback_external	cb
	)

gsasl_server_callback_external_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1194 of file obsolete.c.

References Gsasl::cbs_external.

Gsasl_server_callback_gssapi gsasl_server_callback_gssapi_get ( Gsasl * ctx )

gsasl_server_callback_gssapi_get:

Parameters:

ctx

libgsasl handle.

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 1502 of file obsolete.c.

References Gsasl::cbs_gssapi.

Referenced by gsasl_callback().

void gsasl_server_callback_gssapi_set	(	Gsasl *	ctx,
		Gsasl_server_callback_gssapi	cb
	)

gsasl_server_callback_gssapi_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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_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().

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 1483 of file obsolete.c.

References Gsasl::cbs_gssapi.

Gsasl_server_callback_maxbuf gsasl_server_callback_maxbuf_get ( Gsasl * ctx )

gsasl_server_callback_maxbuf_get:

Parameters:

ctx

libgsasl handle.

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 1373 of file obsolete.c.

References Gsasl::cbs_maxbuf.

Referenced by _gsasl_kerberos_v5_server_step().

void gsasl_server_callback_maxbuf_set	(	Gsasl *	ctx,
		Gsasl_server_callback_maxbuf	cb
	)

gsasl_server_callback_maxbuf_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1354 of file obsolete.c.

References Gsasl::cbs_maxbuf.

Gsasl_server_callback_qop gsasl_server_callback_qop_get ( Gsasl * ctx )

gsasl_server_callback_qop_get:

Parameters:

ctx

libgsasl handle.

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 1331 of file obsolete.c.

References Gsasl::cbs_qop.

Referenced by _gsasl_kerberos_v5_server_step().

void gsasl_server_callback_qop_set	(	Gsasl *	ctx,
		Gsasl_server_callback_qop	cb
	)

gsasl_server_callback_qop_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1313 of file obsolete.c.

References Gsasl::cbs_qop.

Gsasl_server_callback_realm gsasl_server_callback_realm_get ( Gsasl * ctx )

gsasl_server_callback_realm_get:

Parameters:

ctx

libgsasl handle.

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 1291 of file obsolete.c.

References Gsasl::cbs_realm.

Referenced by _gsasl_kerberos_v5_server_step().

void gsasl_server_callback_realm_set	(	Gsasl *	ctx,
		Gsasl_server_callback_realm	cb
	)

gsasl_server_callback_realm_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1273 of file obsolete.c.

References Gsasl::cbs_realm.

Gsasl_server_callback_retrieve gsasl_server_callback_retrieve_get ( Gsasl * ctx )

gsasl_server_callback_retrieve_get:

Parameters:

ctx

libgsasl handle.

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 1094 of file obsolete.c.

References Gsasl::cbs_retrieve.

Referenced by _gsasl_kerberos_v5_server_step(), and gsasl_callback().

void gsasl_server_callback_retrieve_set	(	Gsasl *	ctx,
		Gsasl_server_callback_retrieve	cb
	)

gsasl_server_callback_retrieve_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1075 of file obsolete.c.

References Gsasl::cbs_retrieve.

Gsasl_server_callback_securid gsasl_server_callback_securid_get ( Gsasl * ctx )

gsasl_server_callback_securid_get:

Parameters:

ctx

libgsasl handle.

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 1460 of file obsolete.c.

References Gsasl::cbs_securid.

Referenced by gsasl_callback().

void gsasl_server_callback_securid_set	(	Gsasl *	ctx,
		Gsasl_server_callback_securid	cb
	)

gsasl_server_callback_securid_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1441 of file obsolete.c.

References Gsasl::cbs_securid.

Gsasl_server_callback_service gsasl_server_callback_service_get ( Gsasl * ctx )

gsasl_server_callback_service_get:

Parameters:

ctx

libgsasl handle.

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 1543 of file obsolete.c.

References Gsasl::cbs_service.

Referenced by _gsasl_kerberos_v5_server_step().

void gsasl_server_callback_service_set	(	Gsasl *	ctx,
		Gsasl_server_callback_service	cb
	)

gsasl_server_callback_service_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1524 of file obsolete.c.

References Gsasl::cbs_service.

Gsasl_server_callback_validate gsasl_server_callback_validate_get ( Gsasl * ctx )

gsasl_server_callback_validate_get:

Parameters:

ctx

libgsasl handle.

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 1054 of file obsolete.c.

References Gsasl::cbs_validate.

Referenced by gsasl_callback().

void gsasl_server_callback_validate_set	(	Gsasl *	ctx,
		Gsasl_server_callback_validate	cb
	)

gsasl_server_callback_validate_set:

Parameters:

	ctx	libgsasl handle.
	cb	callback 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 1035 of file obsolete.c.

References Gsasl::cbs_validate.

Gsasl* gsasl_server_ctx_get ( Gsasl_session * sctx )

gsasl_server_ctx_get:

Parameters:

sctx

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 362 of file obsolete.c.

References Gsasl_session::ctx.

Referenced by _gsasl_kerberos_v5_server_step().

void gsasl_server_finish ( Gsasl_session * sctx )

gsasl_server_finish:

Parameters:

sctx

libgsasl 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 293 of file obsolete.c.

References gsasl_finish().

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

gsasl_server_listmech:

Parameters:

	ctx	libgsasl handle.
	out	output character array.
	outlen	input 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 out=NULL.

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

Deprecated: Use gsasl_server_mechlist() instead.

Definition at line 83 of file obsolete.c.

References GSASL_OK, gsasl_server_mechlist(), and GSASL_TOO_SMALL_BUFFER.

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

gsasl_server_step:

Parameters:

	sctx	libgsasl server handle.
	input	input byte array.
	input_len	size of input byte array.
	output	output byte array.
	output_len	size 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 191 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:

	sctx	libgsasl server handle.
	b64input	input base64 encoded byte array.
	b64output	output base64 encoded byte array.
	b64output_len	size 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 261 of file obsolete.c.

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

gsasl_server_suggest_mechanism:

Parameters:

	ctx	libgsasl handle.
	mechlist	input character array with SASL mechanism names, separated by invalid characters (e.g. SPC).

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 612 of file obsolete.c.

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

gsasl_stringprep_nfkc:

Parameters:

	in	a UTF-8 encoded string.
	len	length 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 , o 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 1579 of file obsolete.c.

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

gsasl_stringprep_saslprep:

Parameters:

	in	input ASCII or UTF-8 string with data to prepare according to SASLprep.
	stringprep_rc	pointer 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 1610 of file obsolete.c.

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

gsasl_stringprep_trace:

Parameters:

	in	input ASCII or UTF-8 string with data to prepare according to "trace".
	stringprep_rc	pointer 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 1644 of file obsolete.c.

enum { ... } deprecated


Defines
#define	__attribute__(Spec)
Typedefs
typedef Gsasl Gsasl_ctx	__attribute__ ((deprecated))
typedef Gsasl_session Gsasl_session_ctx	__attribute__ ((deprecated))
typedef int(*)	Gsasl_client_callback_anonymous (Gsasl_session sctx, char out, size_t *outlen)
typedef int(*)	Gsasl_client_callback_authentication_id (Gsasl_session sctx, char out, size_t *outlen)
typedef int(*)	Gsasl_client_callback_authorization_id (Gsasl_session sctx, char out, size_t *outlen)
typedef int(*)	Gsasl_client_callback_password (Gsasl_session sctx, char out, size_t *outlen)
typedef int(*)	Gsasl_client_callback_passcode (Gsasl_session sctx, char out, size_t *outlen)
typedef int(*)	Gsasl_client_callback_pin (Gsasl_session sctx, char suggestion, char out, size_t outlen)
typedef int(*)	Gsasl_client_callback_service (Gsasl_session sctx, char service, size_t servicelen, char hostname, size_t hostnamelen, char servicename, size_t *servicenamelen)
typedef Gsasl_qop(*)	Gsasl_client_callback_qop (Gsasl_session *sctx, Gsasl_qop serverqops)
typedef size_t(*)	Gsasl_client_callback_maxbuf (Gsasl_session *sctx, size_t servermaxbuf)
typedef int(*)	Gsasl_client_callback_realm (Gsasl_session sctx, char out, size_t *outlen)
typedef int(*)	Gsasl_server_callback_retrieve (Gsasl_session sctx, const char authentication_id, const char authorization_id, const char realm, char key, size_t keylen)
typedef int(*)	Gsasl_server_callback_validate (Gsasl_session sctx, const char authorization_id, const char authentication_id, const char password)
typedef int(*)	Gsasl_server_callback_gssapi (Gsasl_session sctx, const char clientname, const char *authentication_id)
typedef 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)
typedef int(*)	Gsasl_server_callback_cram_md5 (Gsasl_session sctx, char username, char challenge, char response)
typedef int(*)	Gsasl_server_callback_digest_md5 (Gsasl_session sctx, char username, char realm, char secrethash)
typedef int(*)	Gsasl_server_callback_service (Gsasl_session sctx, char service, size_t servicelen, char hostname, size_t *hostnamelen)
typedef int(*)	Gsasl_server_callback_external (Gsasl_session *sctx)
typedef int(*)	Gsasl_server_callback_anonymous (Gsasl_session sctx, const char token)
typedef int(*)	Gsasl_server_callback_realm (Gsasl_session sctx, char out, size_t *outlen, size_t nth)
typedef Gsasl_qop(*)	Gsasl_server_callback_qop (Gsasl_session *sctx)
typedef size_t(*)	Gsasl_server_callback_maxbuf (Gsasl_session *sctx)
typedef Gsasl_cipher(*)	Gsasl_server_callback_cipher (Gsasl_session *sctx)
Enumerations
enum	{ GSASL_TOO_SMALL_BUFFER = 4, GSASL_FOPEN_ERROR = 5, GSASL_FCLOSE_ERROR = 6, GSASL_GCRYPT_ERROR = GSASL_CRYPTO_ERROR, GSASL_CANNOT_GET_CTX = 32, GSASL_NEED_CLIENT_ANONYMOUS_CALLBACK = 11, GSASL_NEED_CLIENT_PASSWORD_CALLBACK = 12, GSASL_NEED_CLIENT_PASSCODE_CALLBACK = 13, GSASL_NEED_CLIENT_PIN_CALLBACK = 14, GSASL_NEED_CLIENT_AUTHORIZATION_ID_CALLBACK = 15, GSASL_NEED_CLIENT_AUTHENTICATION_ID_CALLBACK = 16, GSASL_NEED_CLIENT_SERVICE_CALLBACK = 17, GSASL_NEED_SERVER_VALIDATE_CALLBACK = 18, GSASL_NEED_SERVER_CRAM_MD5_CALLBACK = 19, GSASL_NEED_SERVER_DIGEST_MD5_CALLBACK = 20, GSASL_NEED_SERVER_EXTERNAL_CALLBACK = 21, GSASL_NEED_SERVER_ANONYMOUS_CALLBACK = 22, GSASL_NEED_SERVER_REALM_CALLBACK = 23, GSASL_NEED_SERVER_SECURID_CALLBACK = 24, GSASL_NEED_SERVER_SERVICE_CALLBACK = 25, GSASL_NEED_SERVER_GSSAPI_CALLBACK = 26, GSASL_NEED_SERVER_RETRIEVE_CALLBACK = 27, GSASL_UNICODE_NORMALIZATION_ERROR = 28, GSASL_NO_MORE_REALMS = 34, GSASL_INVALID_HANDLE = 50 }
Functions
int	gsasl_client_listmech (Gsasl ctx, char out, size_t *outlen) __attribute__((deprecated))
int	gsasl_server_listmech (Gsasl ctx, char out, size_t *outlen) __attribute__((deprecated))
int	gsasl_client_step (Gsasl_session sctx, const char input, size_t input_len, char output, size_t output_len) __attribute__((deprecated))
int	gsasl_client_step_base64 (Gsasl_session sctx, const char b64input, char *b64output, size_t b64output_len) __attribute__((deprecated))
int	gsasl_server_step (Gsasl_session sctx, const char input, size_t input_len, char output, size_t output_len) __attribute__((deprecated))
int	gsasl_server_step_base64 (Gsasl_session sctx, const char b64input, char *b64output, size_t b64output_len) __attribute__((deprecated))
void	gsasl_client_finish (Gsasl_session *sctx) __attribute__((deprecated))
void	gsasl_server_finish (Gsasl_session *sctx) __attribute__((deprecated))
Gsasl *	gsasl_client_ctx_get (Gsasl_session *sctx) __attribute__((deprecated))
Gsasl *	gsasl_server_ctx_get (Gsasl_session *sctx) __attribute__((deprecated))
void	gsasl_client_application_data_set (Gsasl_session sctx, void application_data) __attribute__((deprecated))
void *	gsasl_client_application_data_get (Gsasl_session *sctx) __attribute__((deprecated))
void	gsasl_server_application_data_set (Gsasl_session sctx, void application_data) __attribute__((deprecated))
void *	gsasl_server_application_data_get (Gsasl_session *sctx) __attribute__((deprecated))
int	gsasl_randomize (int strong, char *data, size_t datalen) __attribute__((deprecated))
Gsasl *	gsasl_ctx_get (Gsasl_session *sctx) __attribute__((deprecated))
int	gsasl_encode_inline (Gsasl_session sctx, const char input, size_t input_len, char output, size_t output_len) __attribute__((deprecated))
int	gsasl_decode_inline (Gsasl_session sctx, const char input, size_t input_len, char output, size_t output_len) __attribute__((deprecated))
void	gsasl_application_data_set (Gsasl ctx, void appdata) __attribute__((deprecated))
void *	gsasl_application_data_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_appinfo_set (Gsasl_session sctx, void appdata) __attribute__((deprecated))
void *	gsasl_appinfo_get (Gsasl_session *sctx) __attribute__((deprecated))
const char *	gsasl_server_suggest_mechanism (Gsasl ctx, const char mechlist) __attribute__((deprecated))
int	gsasl_base64_encode (char const src, size_t srclength, char target, size_t targsize) __attribute__((deprecated))
int	gsasl_base64_decode (char const src, char target, size_t targsize) __attribute__((deprecated))
char *	gsasl_stringprep_nfkc (const char *in, ssize_t len) __attribute__((deprecated))
char *	gsasl_stringprep_saslprep (const char in, int stringprep_rc) __attribute__((deprecated))
char *	gsasl_stringprep_trace (const char in, int stringprep_rc) __attribute__((deprecated))
int	gsasl_md5pwd_get_password (const char filename, const char username, char key, size_t keylen) __attribute__((deprecated))
void	gsasl_client_callback_authorization_id_set (Gsasl *ctx, Gsasl_client_callback_authorization_id cb) __attribute__((deprecated))
Gsasl_client_callback_authorization_id	gsasl_client_callback_authorization_id_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_authentication_id_set (Gsasl *ctx, Gsasl_client_callback_authentication_id cb) __attribute__((deprecated))
Gsasl_client_callback_authentication_id	gsasl_client_callback_authentication_id_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_anonymous_set (Gsasl *ctx, Gsasl_client_callback_anonymous cb) __attribute__((deprecated))
Gsasl_client_callback_anonymous	gsasl_client_callback_anonymous_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_password_set (Gsasl *ctx, Gsasl_client_callback_password cb) __attribute__((deprecated))
Gsasl_client_callback_password	gsasl_client_callback_password_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_passcode_set (Gsasl *ctx, Gsasl_client_callback_passcode cb) __attribute__((deprecated))
Gsasl_client_callback_passcode	gsasl_client_callback_passcode_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_pin_set (Gsasl *ctx, Gsasl_client_callback_pin cb) __attribute__((deprecated))
Gsasl_client_callback_pin	gsasl_client_callback_pin_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_service_set (Gsasl *ctx, Gsasl_client_callback_service cb) __attribute__((deprecated))
Gsasl_client_callback_service	gsasl_client_callback_service_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_qop_set (Gsasl *ctx, Gsasl_client_callback_qop cb) __attribute__((deprecated))
Gsasl_client_callback_qop	gsasl_client_callback_qop_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_maxbuf_set (Gsasl *ctx, Gsasl_client_callback_maxbuf cb) __attribute__((deprecated))
Gsasl_client_callback_maxbuf	gsasl_client_callback_maxbuf_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_client_callback_realm_set (Gsasl *ctx, Gsasl_client_callback_realm cb) __attribute__((deprecated))
Gsasl_client_callback_realm	gsasl_client_callback_realm_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_validate_set (Gsasl *ctx, Gsasl_server_callback_validate cb) __attribute__((deprecated))
Gsasl_server_callback_validate	gsasl_server_callback_validate_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_retrieve_set (Gsasl *ctx, Gsasl_server_callback_retrieve cb) __attribute__((deprecated))
Gsasl_server_callback_retrieve	gsasl_server_callback_retrieve_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_cram_md5_set (Gsasl *ctx, Gsasl_server_callback_cram_md5 cb) __attribute__((deprecated))
Gsasl_server_callback_cram_md5	gsasl_server_callback_cram_md5_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_digest_md5_set (Gsasl *ctx, Gsasl_server_callback_digest_md5 cb) __attribute__((deprecated))
Gsasl_server_callback_digest_md5	gsasl_server_callback_digest_md5_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_external_set (Gsasl *ctx, Gsasl_server_callback_external cb) __attribute__((deprecated))
Gsasl_server_callback_external	gsasl_server_callback_external_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_anonymous_set (Gsasl *ctx, Gsasl_server_callback_anonymous cb) __attribute__((deprecated))
Gsasl_server_callback_anonymous	gsasl_server_callback_anonymous_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_realm_set (Gsasl *ctx, Gsasl_server_callback_realm cb) __attribute__((deprecated))
Gsasl_server_callback_realm	gsasl_server_callback_realm_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_qop_set (Gsasl *ctx, Gsasl_server_callback_qop cb) __attribute__((deprecated))
Gsasl_server_callback_qop	gsasl_server_callback_qop_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_maxbuf_set (Gsasl *ctx, Gsasl_server_callback_maxbuf cb) __attribute__((deprecated))
Gsasl_server_callback_maxbuf	gsasl_server_callback_maxbuf_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_cipher_set (Gsasl *ctx, Gsasl_server_callback_cipher cb) __attribute__((deprecated))
Gsasl_server_callback_cipher	gsasl_server_callback_cipher_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_securid_set (Gsasl *ctx, Gsasl_server_callback_securid cb) __attribute__((deprecated))
Gsasl_server_callback_securid	gsasl_server_callback_securid_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_gssapi_set (Gsasl *ctx, Gsasl_server_callback_gssapi cb) __attribute__((deprecated))
Gsasl_server_callback_gssapi	gsasl_server_callback_gssapi_get (Gsasl *ctx) __attribute__((deprecated))
void	gsasl_server_callback_service_set (Gsasl *ctx, Gsasl_server_callback_service cb) __attribute__((deprecated))
Gsasl_server_callback_service	gsasl_server_callback_service_get (Gsasl *ctx) __attribute__((deprecated))
Variables
enum { ... }	deprecated

gsasl-compat.h File Reference

Defines

Typedefs

Enumerations

Functions

Variables

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation