gsasl  1.10.0
About: GNU SASL is an implementation of the Simple Authentication and Security Layer (SASL). Development version.
  Fossies Dox: gsasl-1.10.0.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

gsasl.h File Reference
#include <stdio.h>
#include <stddef.h>
#include <unistd.h>
#include <gsasl-mech.h>
#include <gsasl-compat.h>
Include dependency graph for gsasl.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define GSASL_API
 
#define GSASL_VERSION   "1.10.0"
 
#define GSASL_VERSION_MAJOR   1
 
#define GSASL_VERSION_MINOR   10
 
#define GSASL_VERSION_PATCH   0
 
#define GSASL_VERSION_NUMBER   0x010a00
 

Typedefs

typedef struct Gsasl Gsasl
 
typedef struct Gsasl_session Gsasl_session
 
typedef int(* Gsasl_callback_function) (Gsasl *ctx, Gsasl_session *sctx, Gsasl_property prop)
 

Enumerations

enum  { GSASL_MIN_MECHANISM_SIZE = 1 , GSASL_MAX_MECHANISM_SIZE = 20 }
 
enum  Gsasl_rc {
  GSASL_OK = 0 , GSASL_NEEDS_MORE = 1 , GSASL_UNKNOWN_MECHANISM = 2 , GSASL_MECHANISM_CALLED_TOO_MANY_TIMES = 3 ,
  GSASL_MALLOC_ERROR = 7 , GSASL_BASE64_ERROR = 8 , GSASL_CRYPTO_ERROR = 9 , GSASL_SASLPREP_ERROR = 29 ,
  GSASL_MECHANISM_PARSE_ERROR = 30 , GSASL_AUTHENTICATION_ERROR = 31 , GSASL_INTEGRITY_ERROR = 33 , GSASL_NO_CLIENT_CODE = 35 ,
  GSASL_NO_SERVER_CODE = 36 , GSASL_NO_CALLBACK = 51 , GSASL_NO_ANONYMOUS_TOKEN = 52 , GSASL_NO_AUTHID = 53 ,
  GSASL_NO_AUTHZID = 54 , GSASL_NO_PASSWORD = 55 , GSASL_NO_PASSCODE = 56 , GSASL_NO_PIN = 57 ,
  GSASL_NO_SERVICE = 58 , GSASL_NO_HOSTNAME = 59 , GSASL_NO_CB_TLS_UNIQUE = 65 , GSASL_NO_SAML20_IDP_IDENTIFIER = 66 ,
  GSASL_NO_SAML20_REDIRECT_URL = 67 , GSASL_NO_OPENID20_REDIRECT_URL = 68 , GSASL_GSSAPI_RELEASE_BUFFER_ERROR = 37 , GSASL_GSSAPI_IMPORT_NAME_ERROR = 38 ,
  GSASL_GSSAPI_INIT_SEC_CONTEXT_ERROR = 39 , GSASL_GSSAPI_ACCEPT_SEC_CONTEXT_ERROR = 40 , GSASL_GSSAPI_UNWRAP_ERROR = 41 , GSASL_GSSAPI_WRAP_ERROR = 42 ,
  GSASL_GSSAPI_ACQUIRE_CRED_ERROR = 43 , GSASL_GSSAPI_DISPLAY_NAME_ERROR = 44 , GSASL_GSSAPI_UNSUPPORTED_PROTECTION_ERROR = 45 , GSASL_KERBEROS_V5_INIT_ERROR = 46 ,
  GSASL_KERBEROS_V5_INTERNAL_ERROR = 47 , GSASL_SHISHI_ERROR = GSASL_KERBEROS_V5_INTERNAL_ERROR , GSASL_SECURID_SERVER_NEED_ADDITIONAL_PASSCODE = 48 , GSASL_SECURID_SERVER_NEED_NEW_PIN = 49 ,
  GSASL_GSSAPI_ENCAPSULATE_TOKEN_ERROR = 60 , GSASL_GSSAPI_DECAPSULATE_TOKEN_ERROR = 61 , GSASL_GSSAPI_INQUIRE_MECH_FOR_SASLNAME_ERROR = 62 , GSASL_GSSAPI_TEST_OID_SET_MEMBER_ERROR = 63 ,
  GSASL_GSSAPI_RELEASE_OID_SET_ERROR = 64
}
 
enum  Gsasl_qop { GSASL_QOP_AUTH = 1 , GSASL_QOP_AUTH_INT = 2 , GSASL_QOP_AUTH_CONF = 4 }
 
enum  Gsasl_cipher {
  GSASL_CIPHER_DES = 1 , GSASL_CIPHER_3DES = 2 , GSASL_CIPHER_RC4 = 4 , GSASL_CIPHER_RC4_40 = 8 ,
  GSASL_CIPHER_RC4_56 = 16 , GSASL_CIPHER_AES = 32
}
 
enum  Gsasl_saslprep_flags { GSASL_ALLOW_UNASSIGNED = 1 }
 
enum  Gsasl_property {
  GSASL_AUTHID = 1 , GSASL_AUTHZID = 2 , GSASL_PASSWORD = 3 , GSASL_ANONYMOUS_TOKEN = 4 ,
  GSASL_SERVICE = 5 , GSASL_HOSTNAME = 6 , GSASL_GSSAPI_DISPLAY_NAME = 7 , GSASL_PASSCODE = 8 ,
  GSASL_SUGGESTED_PIN = 9 , GSASL_PIN = 10 , GSASL_REALM = 11 , GSASL_DIGEST_MD5_HASHED_PASSWORD = 12 ,
  GSASL_QOPS = 13 , GSASL_QOP = 14 , GSASL_SCRAM_ITER = 15 , GSASL_SCRAM_SALT = 16 ,
  GSASL_SCRAM_SALTED_PASSWORD = 17 , GSASL_SCRAM_SERVERKEY = 23 , GSASL_SCRAM_STOREDKEY = 24 , GSASL_CB_TLS_UNIQUE = 18 ,
  GSASL_SAML20_IDP_IDENTIFIER = 19 , GSASL_SAML20_REDIRECT_URL = 20 , GSASL_OPENID20_REDIRECT_URL = 21 , GSASL_OPENID20_OUTCOME_DATA = 22 ,
  GSASL_SAML20_AUTHENTICATE_IN_BROWSER = 250 , GSASL_OPENID20_AUTHENTICATE_IN_BROWSER = 251 , GSASL_VALIDATE_SIMPLE = 500 , GSASL_VALIDATE_EXTERNAL = 501 ,
  GSASL_VALIDATE_ANONYMOUS = 502 , GSASL_VALIDATE_GSSAPI = 503 , GSASL_VALIDATE_SECURID = 504 , GSASL_VALIDATE_SAML20 = 505 ,
  GSASL_VALIDATE_OPENID20 = 506
}
 
enum  Gsasl_hash { GSASL_HASH_SHA1 = 2 , GSASL_HASH_SHA256 = 3 }
 
enum  Gsasl_hash_length { GSASL_HASH_SHA1_SIZE = 20 , GSASL_HASH_SHA256_SIZE = 32 , GSASL_HASH_MAX_SIZE = GSASL_HASH_SHA256_SIZE }
 

Functions

int gsasl_init (Gsasl **ctx)
 
void gsasl_done (Gsasl *ctx)
 
const char * gsasl_check_version (const char *req_version)
 
void gsasl_callback_set (Gsasl *ctx, Gsasl_callback_function cb)
 
int gsasl_callback (Gsasl *ctx, Gsasl_session *sctx, Gsasl_property prop)
 
void gsasl_callback_hook_set (Gsasl *ctx, void *hook)
 
void * gsasl_callback_hook_get (Gsasl *ctx)
 
void gsasl_session_hook_set (Gsasl_session *sctx, void *hook)
 
void * gsasl_session_hook_get (Gsasl_session *sctx)
 
void gsasl_property_set (Gsasl_session *sctx, Gsasl_property prop, const char *data)
 
void gsasl_property_set_raw (Gsasl_session *sctx, Gsasl_property prop, const char *data, size_t len)
 
const char * gsasl_property_get (Gsasl_session *sctx, Gsasl_property prop)
 
const char * gsasl_property_fast (Gsasl_session *sctx, Gsasl_property prop)
 
int gsasl_client_mechlist (Gsasl *ctx, char **out)
 
int gsasl_client_support_p (Gsasl *ctx, const char *name)
 
const char * gsasl_client_suggest_mechanism (Gsasl *ctx, const char *mechlist)
 
int gsasl_server_mechlist (Gsasl *ctx, char **out)
 
int gsasl_server_support_p (Gsasl *ctx, const char *name)
 
int gsasl_client_start (Gsasl *ctx, const char *mech, Gsasl_session **sctx)
 
int gsasl_server_start (Gsasl *ctx, const char *mech, Gsasl_session **sctx)
 
int gsasl_step (Gsasl_session *sctx, const char *input, size_t input_len, char **output, size_t *output_len)
 
int gsasl_step64 (Gsasl_session *sctx, const char *b64input, char **b64output)
 
void gsasl_finish (Gsasl_session *sctx)
 
int gsasl_encode (Gsasl_session *sctx, const char *input, size_t input_len, char **output, size_t *output_len)
 
int gsasl_decode (Gsasl_session *sctx, const char *input, size_t input_len, char **output, size_t *output_len)
 
const char * gsasl_mechanism_name (Gsasl_session *sctx)
 
const char * gsasl_strerror (int err)
 
const char * gsasl_strerror_name (int err)
 
int gsasl_saslprep (const char *in, Gsasl_saslprep_flags flags, char **out, int *stringpreprc)
 
int gsasl_nonce (char *data, size_t datalen)
 
int gsasl_random (char *data, size_t datalen)
 
size_t gsasl_hash_length (Gsasl_hash hash)
 
int gsasl_scram_secrets_from_salted_password (Gsasl_hash hash, const char *salted_password, char *client_key, char *server_key, char *stored_key)
 
int gsasl_scram_secrets_from_password (Gsasl_hash hash, const char *password, unsigned int iteration_count, const char *salt, size_t saltlen, char *salted_password, char *client_key, char *server_key, char *stored_key)
 
int gsasl_simple_getpass (const char *filename, const char *username, char **key)
 
int gsasl_base64_to (const char *in, size_t inlen, char **out, size_t *outlen)
 
int gsasl_base64_from (const char *in, size_t inlen, char **out, size_t *outlen)
 
int gsasl_hex_to (const char *in, size_t inlen, char **out, size_t *outlen)
 
int gsasl_hex_from (const char *in, char **out, size_t *outlen)
 
void gsasl_free (void *ptr)
 

Variables

const char * GSASL_VALID_MECHANISM_CHARACTERS
 

Macro Definition Documentation

◆ GSASL_API

#define GSASL_API

Definition at line 38 of file gsasl.h.

◆ GSASL_VERSION

#define GSASL_VERSION   "1.10.0"

GSASL_VERSION

Pre-processor symbol with a string that describe the header file version number. Used together with gsasl_check_version() to verify header file and run-time library consistency.

Definition at line 54 of file gsasl.h.

◆ GSASL_VERSION_MAJOR

#define GSASL_VERSION_MAJOR   1

GSASL_VERSION_MAJOR

Pre-processor symbol with a decimal value that describe the major level of the header file version number. For example, when the header version is 1.2.3 this symbol will be 1.

Since: 1.1

Definition at line 65 of file gsasl.h.

◆ GSASL_VERSION_MINOR

#define GSASL_VERSION_MINOR   10

GSASL_VERSION_MINOR

Pre-processor symbol with a decimal value that describe the minor level of the header file version number. For example, when the header version is 1.2.3 this symbol will be 2.

Since: 1.1

Definition at line 76 of file gsasl.h.

◆ GSASL_VERSION_NUMBER

#define GSASL_VERSION_NUMBER   0x010a00

GSASL_VERSION_NUMBER

Pre-processor symbol with a hexadecimal value describing the header file version number. For example, when the header version is 1.2.3 this symbol will have the value 0x010203.

Since: 1.1

Definition at line 98 of file gsasl.h.

◆ GSASL_VERSION_PATCH

#define GSASL_VERSION_PATCH   0

GSASL_VERSION_PATCH

Pre-processor symbol with a decimal value that describe the patch level of the header file version number. For example, when the header version is 1.2.3 this symbol will be 3.

Since: 1.1

Definition at line 87 of file gsasl.h.

Typedef Documentation

◆ Gsasl

typedef struct Gsasl Gsasl

Gsasl:

Handle to global library context.

Definition at line 110 of file gsasl.h.

◆ Gsasl_callback_function

typedef int(* Gsasl_callback_function) (Gsasl *ctx, Gsasl_session *sctx, Gsasl_property prop)

Gsasl_callback_function: @ctx: libgsasl handle. @sctx: session handle, may be NULL. @prop: enumerated value of Gsasl_property type.

Prototype of function that the application should implement. Use gsasl_callback_set() to inform the library about your callback function.

It is called by the SASL library when it need some information from the application. Depending on the value of @prop, it should either set some property (e.g., username or password) using gsasl_property_set(), or it should extract some properties (e.g., authentication and authorization identities) using gsasl_property_fast() and use them to make a policy decision, perhaps returning GSASL_AUTHENTICATION_ERROR or GSASL_OK depending on whether the policy permitted the operation.

Return value: Any valid return code, the interpretation of which depend on the @prop value.

Since: 0.2.0

Definition at line 396 of file gsasl.h.

◆ Gsasl_session

typedef struct Gsasl_session Gsasl_session

Gsasl_session:

Handle to SASL session context.

Definition at line 110 of file gsasl.h.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
GSASL_MIN_MECHANISM_SIZE 
GSASL_MAX_MECHANISM_SIZE 

Definition at line 105 of file gsasl.h.

◆ Gsasl_cipher

Gsasl_cipher: @GSASL_CIPHER_DES: Cipher DES. @GSASL_CIPHER_3DES: Cipher 3DES. @GSASL_CIPHER_RC4: Cipher RC4. @GSASL_CIPHER_RC4_40: Cipher RC4 with 40-bit keys. @GSASL_CIPHER_RC4_56: Cipher RC4 with 56-bit keys. @GSASL_CIPHER_AES: Cipher AES.

Encryption types (DIGEST-MD5) for confidentiality services of application data. We recommend that you use TLS instead as it is generally more secure and have better chance of working.

Enumerator
GSASL_CIPHER_DES 
GSASL_CIPHER_3DES 
GSASL_CIPHER_RC4 
GSASL_CIPHER_RC4_40 
GSASL_CIPHER_RC4_56 
GSASL_CIPHER_AES 

Definition at line 253 of file gsasl.h.

◆ Gsasl_hash

enum Gsasl_hash
Enumerator
GSASL_HASH_SHA1 
GSASL_HASH_SHA256 

Definition at line 470 of file gsasl.h.

◆ Gsasl_hash_length

Enumerator
GSASL_HASH_SHA1_SIZE 
GSASL_HASH_SHA256_SIZE 
GSASL_HASH_MAX_SIZE 

Definition at line 477 of file gsasl.h.

◆ Gsasl_property

Gsasl_property: @GSASL_AUTHID: Authentication identity (username). @GSASL_AUTHZID: Authorization identity. @GSASL_PASSWORD: Password. @GSASL_ANONYMOUS_TOKEN: Anonymous identifier. @GSASL_SERVICE: Service name @GSASL_HOSTNAME: Host name. @GSASL_GSSAPI_DISPLAY_NAME: GSS-API credential principal name. @GSASL_PASSCODE: SecurID passcode. @GSASL_SUGGESTED_PIN: SecurID suggested PIN. @GSASL_PIN: SecurID PIN. @GSASL_REALM: User realm. @GSASL_DIGEST_MD5_HASHED_PASSWORD: Pre-computed hashed DIGEST-MD5 password, to avoid storing passwords in the clear. @GSASL_QOPS: Set of quality-of-protection values. @GSASL_QOP: Quality-of-protection value. @GSASL_SCRAM_ITER: Number of iterations in password-to-key hashing. @GSASL_SCRAM_SALT: Salt for password-to-key hashing. @GSASL_SCRAM_SALTED_PASSWORD: Hex-encoded hashed/salted password. @GSASL_SCRAM_SERVERKEY: Hex-encoded SCRAM ServerKey derived from users' passowrd. @GSASL_SCRAM_STOREDKEY: Hex-encoded SCRAM StoredKey derived from users' passowrd. @GSASL_CB_TLS_UNIQUE: Base64 encoded tls-unique channel binding. @GSASL_SAML20_IDP_IDENTIFIER: SAML20 user IdP URL. @GSASL_SAML20_REDIRECT_URL: SAML 2.0 URL to access in browser. @GSASL_OPENID20_REDIRECT_URL: OpenID 2.0 URL to access in browser. @GSASL_OPENID20_OUTCOME_DATA: OpenID 2.0 authentication outcome data. @GSASL_SAML20_AUTHENTICATE_IN_BROWSER: Request to perform SAML 2.0 authentication in browser. @GSASL_OPENID20_AUTHENTICATE_IN_BROWSER: Request to perform OpenID 2.0 authentication in browser. @GSASL_VALIDATE_SIMPLE: Request for simple validation. @GSASL_VALIDATE_EXTERNAL: Request for validation of EXTERNAL. @GSASL_VALIDATE_ANONYMOUS: Request for validation of ANONYMOUS. @GSASL_VALIDATE_GSSAPI: Request for validation of GSSAPI/GS2. @GSASL_VALIDATE_SECURID: Reqest for validation of SecurID. @GSASL_VALIDATE_SAML20: Reqest for validation of SAML20. @GSASL_VALIDATE_OPENID20: Reqest for validation of OpenID 2.0 login.

Callback/property types.

Enumerator
GSASL_AUTHID 
GSASL_AUTHZID 
GSASL_PASSWORD 
GSASL_ANONYMOUS_TOKEN 
GSASL_SERVICE 
GSASL_HOSTNAME 
GSASL_GSSAPI_DISPLAY_NAME 
GSASL_PASSCODE 
GSASL_SUGGESTED_PIN 
GSASL_PIN 
GSASL_REALM 
GSASL_DIGEST_MD5_HASHED_PASSWORD 
GSASL_QOPS 
GSASL_QOP 
GSASL_SCRAM_ITER 
GSASL_SCRAM_SALT 
GSASL_SCRAM_SALTED_PASSWORD 
GSASL_SCRAM_SERVERKEY 
GSASL_SCRAM_STOREDKEY 
GSASL_CB_TLS_UNIQUE 
GSASL_SAML20_IDP_IDENTIFIER 
GSASL_SAML20_REDIRECT_URL 
GSASL_OPENID20_REDIRECT_URL 
GSASL_OPENID20_OUTCOME_DATA 
GSASL_SAML20_AUTHENTICATE_IN_BROWSER 
GSASL_OPENID20_AUTHENTICATE_IN_BROWSER 
GSASL_VALIDATE_SIMPLE 
GSASL_VALIDATE_EXTERNAL 
GSASL_VALIDATE_ANONYMOUS 
GSASL_VALIDATE_GSSAPI 
GSASL_VALIDATE_SECURID 
GSASL_VALIDATE_SAML20 
GSASL_VALIDATE_OPENID20 

Definition at line 332 of file gsasl.h.

◆ Gsasl_qop

enum Gsasl_qop

Gsasl_qop: @GSASL_QOP_AUTH: Authentication only. @GSASL_QOP_AUTH_INT: Authentication and integrity. @GSASL_QOP_AUTH_CONF: Authentication, integrity and confidentiality.

Quality of Protection types (DIGEST-MD5 and GSSAPI). The integrity and confidentiality values is about application data wrapping. We recommend that you use @GSASL_QOP_AUTH with TLS as that combination is generally more secure and have better chance of working than the integrity/confidentiality layers of SASL.

Enumerator
GSASL_QOP_AUTH 
GSASL_QOP_AUTH_INT 
GSASL_QOP_AUTH_CONF 

Definition at line 233 of file gsasl.h.

◆ Gsasl_rc

enum Gsasl_rc

Gsasl_rc: @GSASL_OK: Successful return code, guaranteed to be always 0. @GSASL_NEEDS_MORE: Mechanism expects another round-trip. @GSASL_UNKNOWN_MECHANISM: Application requested an unknown mechanism. @GSASL_MECHANISM_CALLED_TOO_MANY_TIMES: Application requested too many round trips from mechanism. @GSASL_MALLOC_ERROR: Memory allocation failed. @GSASL_BASE64_ERROR: Base64 encoding/decoding failed. @GSASL_CRYPTO_ERROR: Cryptographic error. @GSASL_SASLPREP_ERROR: Failed to prepare internationalized string. @GSASL_MECHANISM_PARSE_ERROR: Mechanism could not parse input. @GSASL_AUTHENTICATION_ERROR: Authentication has failed. @GSASL_INTEGRITY_ERROR: Application data integrity check failed. @GSASL_NO_CLIENT_CODE: Library was built with client functionality. @GSASL_NO_SERVER_CODE: Library was built with server functionality. @GSASL_NO_CALLBACK: Application did not provide a callback. @GSASL_NO_ANONYMOUS_TOKEN: Could not get required anonymous token. @GSASL_NO_AUTHID: Could not get required authentication identity (username). @GSASL_NO_AUTHZID: Could not get required authorization identity. @GSASL_NO_PASSWORD: Could not get required password. @GSASL_NO_PASSCODE: Could not get required SecurID PIN. @GSASL_NO_PIN: Could not get required SecurID PIN. @GSASL_NO_SERVICE: Could not get required service name. @GSASL_NO_HOSTNAME: Could not get required hostname. @GSASL_NO_CB_TLS_UNIQUE: Could not get required tls-unique CB. @GSASL_NO_SAML20_IDP_IDENTIFIER: Could not get required SAML IdP. @GSASL_NO_SAML20_REDIRECT_URL: Could not get required SAML redirect URL. @GSASL_NO_OPENID20_REDIRECT_URL: Could not get required OpenID redirect URL. @GSASL_GSSAPI_RELEASE_BUFFER_ERROR: GSS-API library call error. @GSASL_GSSAPI_IMPORT_NAME_ERROR: GSS-API library call error. @GSASL_GSSAPI_INIT_SEC_CONTEXT_ERROR: GSS-API library call error. @GSASL_GSSAPI_ACCEPT_SEC_CONTEXT_ERROR: GSS-API library call error. @GSASL_GSSAPI_UNWRAP_ERROR: GSS-API library call error. @GSASL_GSSAPI_WRAP_ERROR: GSS-API library call error. @GSASL_GSSAPI_ACQUIRE_CRED_ERROR: GSS-API library call error. @GSASL_GSSAPI_DISPLAY_NAME_ERROR: GSS-API library call error. @GSASL_GSSAPI_UNSUPPORTED_PROTECTION_ERROR: An unsupported quality-of-protection layer was requeted. @GSASL_GSSAPI_ENCAPSULATE_TOKEN_ERROR: GSS-API library call error. @GSASL_GSSAPI_DECAPSULATE_TOKEN_ERROR: GSS-API library call error. @GSASL_GSSAPI_INQUIRE_MECH_FOR_SASLNAME_ERROR: GSS-API library call error. @GSASL_GSSAPI_TEST_OID_SET_MEMBER_ERROR: GSS-API library call error. @GSASL_GSSAPI_RELEASE_OID_SET_ERROR: GSS-API library call error. @GSASL_KERBEROS_V5_INIT_ERROR: Init error in KERBEROS_V5. @GSASL_KERBEROS_V5_INTERNAL_ERROR: General error in KERBEROS_V5. @GSASL_SHISHI_ERROR: Same as GSASL_KERBEROS_V5_INTERNAL_ERROR. @GSASL_SECURID_SERVER_NEED_ADDITIONAL_PASSCODE: SecurID mechanism needs an additional passcode. @GSASL_SECURID_SERVER_NEED_NEW_PIN: SecurID mechanism needs an new PIN.

Error codes for library functions.

Enumerator
GSASL_OK 
GSASL_NEEDS_MORE 
GSASL_UNKNOWN_MECHANISM 
GSASL_MECHANISM_CALLED_TOO_MANY_TIMES 
GSASL_MALLOC_ERROR 
GSASL_BASE64_ERROR 
GSASL_CRYPTO_ERROR 
GSASL_SASLPREP_ERROR 
GSASL_MECHANISM_PARSE_ERROR 
GSASL_AUTHENTICATION_ERROR 
GSASL_INTEGRITY_ERROR 
GSASL_NO_CLIENT_CODE 
GSASL_NO_SERVER_CODE 
GSASL_NO_CALLBACK 
GSASL_NO_ANONYMOUS_TOKEN 
GSASL_NO_AUTHID 
GSASL_NO_AUTHZID 
GSASL_NO_PASSWORD 
GSASL_NO_PASSCODE 
GSASL_NO_PIN 
GSASL_NO_SERVICE 
GSASL_NO_HOSTNAME 
GSASL_NO_CB_TLS_UNIQUE 
GSASL_NO_SAML20_IDP_IDENTIFIER 
GSASL_NO_SAML20_REDIRECT_URL 
GSASL_NO_OPENID20_REDIRECT_URL 
GSASL_GSSAPI_RELEASE_BUFFER_ERROR 
GSASL_GSSAPI_IMPORT_NAME_ERROR 
GSASL_GSSAPI_INIT_SEC_CONTEXT_ERROR 
GSASL_GSSAPI_ACCEPT_SEC_CONTEXT_ERROR 
GSASL_GSSAPI_UNWRAP_ERROR 
GSASL_GSSAPI_WRAP_ERROR 
GSASL_GSSAPI_ACQUIRE_CRED_ERROR 
GSASL_GSSAPI_DISPLAY_NAME_ERROR 
GSASL_GSSAPI_UNSUPPORTED_PROTECTION_ERROR 
GSASL_KERBEROS_V5_INIT_ERROR 
GSASL_KERBEROS_V5_INTERNAL_ERROR 
GSASL_SHISHI_ERROR 
GSASL_SECURID_SERVER_NEED_ADDITIONAL_PASSCODE 
GSASL_SECURID_SERVER_NEED_NEW_PIN 
GSASL_GSSAPI_ENCAPSULATE_TOKEN_ERROR 
GSASL_GSSAPI_DECAPSULATE_TOKEN_ERROR 
GSASL_GSSAPI_INQUIRE_MECH_FOR_SASLNAME_ERROR 
GSASL_GSSAPI_TEST_OID_SET_MEMBER_ERROR 
GSASL_GSSAPI_RELEASE_OID_SET_ERROR 

Definition at line 169 of file gsasl.h.

◆ Gsasl_saslprep_flags

Gsasl_saslprep_flags: @GSASL_ALLOW_UNASSIGNED: Allow unassigned code points.

Flags for the SASLprep function, see gsasl_saslprep(). For background, see the GNU Libidn documentation.

Enumerator
GSASL_ALLOW_UNASSIGNED 

Definition at line 270 of file gsasl.h.

Function Documentation

◆ gsasl_base64_from()

int gsasl_base64_from ( const char *  in,
size_t  inlen,
char **  out,
size_t outlen 
)

gsasl_base64_from: @in: input byte array @inlen: size of input byte array @out: pointer to newly allocated output byte array @outlen: pointer to size of newly allocated output byte array

Decode Base64 data. The @out buffer must be deallocated by the caller.

Return value: Returns GSASL_OK on success, GSASL_BASE64_ERROR if input was invalid, and GSASL_MALLOC_ERROR on memory allocation errors.

Since: 0.2.2

Definition at line 74 of file base64.c.

References base64_decode_alloc, GSASL_BASE64_ERROR, GSASL_MALLOC_ERROR, GSASL_OK, and NULL.

Referenced by _gsasl_scram_client_step(), _gsasl_scram_server_step(), extract_serverkey(), gsasl_base64_decode(), gsasl_step64(), and mkpasswd().

◆ gsasl_base64_to()

int gsasl_base64_to ( const char *  in,
size_t  inlen,
char **  out,
size_t outlen 
)

gsasl_base64_to: @in: input byte array. @inlen: size of input byte array. @out: pointer to newly allocated base64-encoded string. @outlen: pointer to size of newly allocated base64-encoded string.

Encode data as base64. The @out string is zero terminated, and @outlen holds the length excluding the terminating zero. The @out buffer must be deallocated by the caller.

Return value: Returns GSASL_OK on success, or GSASL_MALLOC_ERROR if input was too large or memory allocation fail.

Since: 0.2.2

Definition at line 44 of file base64.c.

References base64_encode_alloc(), GSASL_MALLOC_ERROR, GSASL_OK, and NULL.

Referenced by _gsasl_digest_md5_client_start(), _gsasl_digest_md5_server_start(), _gsasl_scram_client_step(), _gsasl_scram_server_step(), gsasl_base64_encode(), gsasl_step64(), main(), mkpasswd(), and scram_start().

◆ gsasl_callback()

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

gsasl_callback: @ctx: handle received from gsasl_init(), may be NULL to derive it from @sctx. @sctx: session handle. @prop: enumerated value of Gsasl_property type.

Invoke the application callback. The @prop value indicate what the callback is expected to do. For example, for GSASL_ANONYMOUS_TOKEN, the function is expected to invoke gsasl_property_set(@SCTX, GSASL_ANONYMOUS_TOKEN, "token") where "token" is the anonymous token the application wishes the SASL mechanism to use. See the manual for the meaning of all parameters.

Note that if no callback has been set by the application, but the obsolete callback interface has been used, this function will translate the old callback interface into the new. This interface should be sufficient to invoke all callbacks, both new and old.

Return value: Returns whatever the application callback returns, or GSASL_NO_CALLBACK if no application was known.

Since: 0.2.0

Definition at line 75 of file callback.c.

References _gsasl_obsolete_callback(), Gsasl::cb, Gsasl_session::ctx, GSASL_NO_CALLBACK, and NULL.

Referenced by _gsasl_anonymous_server_step(), _gsasl_digest_md5_client_step(), _gsasl_external_server_step(), _gsasl_gs2_server_step(), _gsasl_gssapi_server_step(), _gsasl_login_server_step(), _gsasl_openid20_client_step(), _gsasl_openid20_server_step(), _gsasl_plain_server_step(), _gsasl_saml20_client_step(), _gsasl_saml20_server_step(), _gsasl_securid_server_step(), and gsasl_property_get().

◆ gsasl_callback_hook_get()

void* gsasl_callback_hook_get ( Gsasl ctx)

gsasl_callback_hook_get: @ctx: libgsasl handle.

Retrieve application specific data from libgsasl handle.

The application data is set using gsasl_callback_hook_set(). This is normally used by the application to maintain a global state between the main program and callbacks.

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

Since: 0.2.0

Definition at line 128 of file callback.c.

References Gsasl::application_hook.

◆ gsasl_callback_hook_set()

void gsasl_callback_hook_set ( Gsasl ctx,
void *  hook 
)

gsasl_callback_hook_set: @ctx: libgsasl handle. @hook: 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_callback_hook_get(). This is normally used by the application to maintain a global state between the main program and callbacks.

Since: 0.2.0

Definition at line 108 of file callback.c.

References Gsasl::application_hook.

◆ gsasl_callback_set()

void gsasl_callback_set ( Gsasl ctx,
Gsasl_callback_function  cb 
)

gsasl_callback_set: @ctx: handle received from gsasl_init(). @cb: pointer to function implemented by application.

Store the pointer to the application provided callback in the library handle. The callback will be used, via gsasl_callback(), by mechanisms to discover various parameters (such as username and passwords). The callback function will be called with a Gsasl_property value indicating the requested behaviour. For example, for GSASL_ANONYMOUS_TOKEN, the function is expected to invoke gsasl_property_set(@CTX, GSASL_ANONYMOUS_TOKEN, "token") where "token" is the anonymous token the application wishes the SASL mechanism to use. See the manual for the meaning of all parameters.

Since: 0.2.0

Definition at line 44 of file callback.c.

References Gsasl::cb.

Referenced by main().

◆ gsasl_check_version()

const char* gsasl_check_version ( const char *  req_version)

gsasl_check_version: @req_version: version string to compare with, or NULL.

Check GNU SASL Library version.

See GSASL_VERSION for a suitable @req_version string.

This function is one of few in the library that can be used without a successful call to gsasl_init().

Return value: Check that the version of the library is at minimum the one given as a string in @req_version and return the actual version string of the library; return NULL if the condition is not met. If NULL is passed to this function no check is done and only the version string is returned.

Definition at line 45 of file version.c.

References GSASL_VERSION, NULL, and strverscmp().

Referenced by main().

◆ gsasl_client_mechlist()

int gsasl_client_mechlist ( Gsasl ctx,
char **  out 
)

gsasl_client_mechlist: @ctx: libgsasl handle. @out: newly allocated output character array.

Return a newly allocated string containing SASL names, separated by space, of mechanisms supported by the libgsasl client. @out is allocated by this function, and it is the responsibility of caller to deallocate it.

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

Definition at line 74 of file listmech.c.

References _gsasl_listmech(), Gsasl::client_mechs, and Gsasl::n_client_mechs.

Referenced by gsasl_client_listmech(), and main().

◆ gsasl_client_start()

int gsasl_client_start ( Gsasl ctx,
const char *  mech,
Gsasl_session **  sctx 
)

gsasl_client_start: @ctx: libgsasl handle. @mech: name of SASL mechanism. @sctx: pointer to client handle.

This functions initiates a client SASL authentication. This function must be called before any other gsasl_client_*() function is called.

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

Definition at line 119 of file xstart.c.

References Gsasl::client_mechs, Gsasl::n_client_mechs, and start().

Referenced by _gsasl_listmech(), gsasl_client_suggest_mechanism(), and main().

◆ gsasl_client_suggest_mechanism()

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

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

Given a list of mechanisms, suggest which to use.

Return value: Returns name of "best" SASL mechanism supported by the libgsasl client which is present in the input string, or NULL if no supported mechanism is found.

Definition at line 38 of file suggest.c.

References Gsasl::client_mechs, gsasl_client_start(), gsasl_finish(), GSASL_OK, GSASL_VALID_MECHANISM_CHARACTERS, Gsasl::n_client_mechs, Gsasl_mechanism::name, and NULL.

Referenced by main().

◆ gsasl_client_support_p()

int gsasl_client_support_p ( Gsasl ctx,
const char *  name 
)

Definition at line 49 of file supportp.c.

References _gsasl_support_p(), Gsasl::client_mechs, Gsasl::n_client_mechs, and name.

◆ gsasl_decode()

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

gsasl_decode: @sctx: libgsasl session handle. @input: input byte array. @input_len: size of input byte array. @output: newly allocated 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.

The @output buffer is allocated by this function, and it is the responsibility of caller to deallocate it by calling free(@output).

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

Definition at line 96 of file xcode.c.

References _gsasl_code(), Gsasl_mechanism::client, Gsasl_session::clientp, code, Gsasl_mechanism_functions::decode, Gsasl_session::mech, and Gsasl_mechanism::server.

Referenced by gsasl_decode_inline(), and main().

◆ gsasl_done()

void gsasl_done ( Gsasl ctx)

gsasl_done: @ctx: libgsasl handle.

This function destroys a libgsasl handle. The handle must not be used with other libgsasl functions after this call.

Definition at line 33 of file done.c.

References Gsasl_mechanism::client, Gsasl::client_mechs, Gsasl_mechanism_functions::done, Gsasl::n_client_mechs, Gsasl::n_server_mechs, NULL, Gsasl_mechanism::server, and Gsasl::server_mechs.

Referenced by gsasl_init(), and main().

◆ gsasl_encode()

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

gsasl_encode: @sctx: libgsasl session handle. @input: input byte array. @input_len: size of input byte array. @output: newly allocated 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.

The @output buffer is allocated by this function, and it is the responsibility of caller to deallocate it by calling free(@output).

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

Definition at line 64 of file xcode.c.

References _gsasl_code(), Gsasl_mechanism::client, Gsasl_session::clientp, code, Gsasl_mechanism_functions::encode, Gsasl_session::mech, and Gsasl_mechanism::server.

Referenced by gsasl_encode_inline(), and main().

◆ gsasl_finish()

◆ gsasl_free()

void gsasl_free ( void *  ptr)

gsasl_free: @ptr: memory pointer

Invoke free(@ptr) to de-allocate memory pointer. Typically used on strings allocated by other libgsasl functions.

This is useful on Windows where libgsasl is linked to one CRT and the application is linked to another CRT. Then malloc/free will not use the same heap. This happens if you build libgsasl using mingw32 and the application with Visual Studio.

Since: 0.2.19

Definition at line 41 of file free.c.

Referenced by _gsasl_scram_client_step(), and _gsasl_scram_server_step().

◆ gsasl_hash_length()

size_t gsasl_hash_length ( Gsasl_hash  hash)

gsasl_hash_length: @hash: a Gsasl_hash element, e.g., GSASL_HASH_SHA256.

Return the digest output size for hash function @hash. For example, gsasl_hash_length(GSASL_HASH_SHA256) returns GSASL_HASH_SHA256_SIZE which is 32.

Returns: size of supplied Gsasl_hash element.

Since: 1.10

Definition at line 72 of file crypto.c.

References GSASL_HASH_SHA1, GSASL_HASH_SHA1_SIZE, GSASL_HASH_SHA256, and GSASL_HASH_SHA256_SIZE.

Referenced by _gsasl_scram_client_step(), _gsasl_scram_server_step(), extract_serverkey(), gsasl_scram_secrets_from_salted_password(), and set_saltedpassword().

◆ gsasl_hex_from()

int gsasl_hex_from ( const char *  in,
char **  out,
size_t outlen 
)

gsasl_hex_from: @in: input byte array @out: pointer to newly allocated output byte array @outlen: pointer to size of newly allocated output byte array

Decode hex data. The @out buffer must be deallocated by the caller.

Return value: Returns GSASL_OK on success, GSASL_BASE64_ERROR if input was invalid, and GSASL_MALLOC_ERROR on memory allocation errors.

Since: 1.10

Definition at line 139 of file base64.c.

References _gsasl_hex_decode(), _gsasl_hex_p(), GSASL_BASE64_ERROR, GSASL_MALLOC_ERROR, and GSASL_OK.

◆ gsasl_hex_to()

int gsasl_hex_to ( const char *  in,
size_t  inlen,
char **  out,
size_t outlen 
)

gsasl_hex_to: @in: input byte array. @inlen: size of input byte array. @out: pointer to newly allocated hex-encoded string. @outlen: pointer to size of newly allocated hex-encoded string.

Hex encode data. The @out string is zero terminated, and @outlen holds the length excluding the terminating zero. The @out buffer must be deallocated by the caller.

Return value: Returns GSASL_OK on success, or GSASL_MALLOC_ERROR if input was too large or memory allocation fail.

Since: 1.10

Definition at line 106 of file base64.c.

References _gsasl_hex_encode(), GSASL_MALLOC_ERROR, GSASL_OK, and NULL.

Referenced by mkpasswd().

◆ gsasl_init()

int gsasl_init ( Gsasl **  ctx)

gsasl_init: @ctx: pointer to libgsasl handle.

This functions initializes libgsasl. The handle pointed to by ctx is valid for use with other libgsasl functions iff this function is successful. It also register all builtin SASL mechanisms, using gsasl_register().

Return value: GSASL_OK iff successful, otherwise GSASL_MALLOC_ERROR.

Definition at line 167 of file init.c.

References gc_init(), GC_OK, GSASL_CRYPTO_ERROR, gsasl_done(), GSASL_MALLOC_ERROR, GSASL_OK, NULL, rc, and register_builtin_mechs().

Referenced by main().

◆ gsasl_mechanism_name()

const char* gsasl_mechanism_name ( Gsasl_session sctx)

gsasl_mechanism_name: @sctx: libgsasl session handle.

This function returns the name of the SASL mechanism used in the session. The pointer must not be deallocated by the caller.

Return value: Returns a zero terminated character array with the name of the SASL mechanism, or NULL if not known.

Since: 0.2.28

Definition at line 38 of file mechname.c.

References Gsasl_session::mech, Gsasl_mechanism::name, and NULL.

Referenced by gs2_get_oid().

◆ gsasl_nonce()

int gsasl_nonce ( char *  data,
size_t  datalen 
)

gsasl_nonce: @data: output array to be filled with unpredictable random data. @datalen: size of output array.

Store unpredictable data of given size in the provided buffer.

Return value: Returns GSASL_OK iff successful.

Definition at line 38 of file crypto.c.

References gc_nonce().

Referenced by _gsasl_digest_md5_client_start(), _gsasl_digest_md5_server_start(), gsasl_randomize(), mkpasswd(), and scram_start().

◆ gsasl_property_fast()

const char* gsasl_property_fast ( Gsasl_session sctx,
Gsasl_property  prop 
)

gsasl_property_fast: @sctx: session handle. @prop: enumerated value of Gsasl_property type, indicating the type of data in @data.

Retrieve the data stored in the session handle for given property @prop.

The pointer is to live data, and must not be deallocated or modified in any way.

This function will not invoke the application callback.

Return value: Return property value, if known, or NULL if no value known.

Since: 0.2.0

Definition at line 226 of file property.c.

References map(), NULL, and p.

Referenced by _gsasl_digest_md5_client_step(), callback(), gsasl_property_get(), and pmap().

◆ gsasl_property_get()

const char* gsasl_property_get ( Gsasl_session sctx,
Gsasl_property  prop 
)

gsasl_property_get: @sctx: session handle. @prop: enumerated value of Gsasl_property type, indicating the type of data in @data.

Retrieve the data stored in the session handle for given property @prop, possibly invoking the application callback to get the value.

The pointer is to live data, and must not be deallocated or modified in any way.

This function will invoke the application callback, using gsasl_callback(), when a property value is not known.

If no value is known, and no callback is specified or if the callback fail to return data, and if any obsolete callback functions has been set by the application, this function will try to call these obsolete callbacks, and store the returned data as the corresponding property. This behaviour of this function will be removed when the obsolete callback interfaces are removed.

Return value: Return data for property, or NULL if no value known.

Since: 0.2.0

Definition at line 263 of file property.c.

References _gsasl_obsolete_property_map(), gsasl_callback(), gsasl_property_fast(), NULL, and p.

Referenced by _gsasl_anonymous_client_step(), _gsasl_cram_md5_client_step(), _gsasl_cram_md5_server_step(), _gsasl_digest_md5_client_step(), _gsasl_digest_md5_server_step(), _gsasl_external_client_step(), _gsasl_gssapi_client_step(), _gsasl_gssapi_server_step(), _gsasl_login_client_step(), _gsasl_login_server_step(), _gsasl_ntlm_client_step(), _gsasl_openid20_client_step(), _gsasl_openid20_server_step(), _gsasl_plain_client_step(), _gsasl_plain_server_step(), _gsasl_saml20_client_step(), _gsasl_saml20_server_step(), _gsasl_scram_client_step(), _gsasl_scram_server_step(), _gsasl_securid_client_step(), _gsasl_securid_server_step(), callback(), gs2_get_cred(), and prepare().

◆ gsasl_property_set()

void gsasl_property_set ( Gsasl_session sctx,
Gsasl_property  prop,
const char *  data 
)

gsasl_property_set: @sctx: session handle. @prop: enumerated value of Gsasl_property type, indicating the type of data in @data. @data: zero terminated character string to store.

Make a copy of @data and store it in the session handle for the indicated property @prop.

You can immediately deallocate @data after calling this function, without affecting the data stored in the session handle.

Since: 0.2.0

Definition at line 158 of file property.c.

References gsasl_property_set_raw().

Referenced by _gsasl_cram_md5_server_step(), _gsasl_digest_md5_client_step(), _gsasl_digest_md5_server_step(), _gsasl_external_server_step(), _gsasl_gs2_server_step(), _gsasl_login_server_step(), _gsasl_obsolete_callback(), _gsasl_openid20_server_step(), _gsasl_plain_server_step(), _gsasl_saml20_server_step(), _gsasl_scram_client_step(), _gsasl_scram_server_step(), _gsasl_securid_server_step(), callback(), pmap(), and set_saltedpassword().

◆ gsasl_property_set_raw()

void gsasl_property_set_raw ( Gsasl_session sctx,
Gsasl_property  prop,
const char *  data,
size_t  len 
)

gsasl_property_set_raw: @sctx: session handle. @prop: enumerated value of Gsasl_property type, indicating the type of data in @data. @data: character string to store. @len: length of character string to store.

Make a copy of @len sized @data and store a zero terminated version of it in the session handle for the indicated property @prop.

You can immediately deallocate @data after calling this function, without affecting the data stored in the session handle.

Except for the length indicator, this function is identical to gsasl_property_set.

Since: 0.2.0

Definition at line 184 of file property.c.

References map(), NULL, and p.

Referenced by _gsasl_anonymous_server_step(), _gsasl_external_server_step(), _gsasl_gs2_server_step(), _gsasl_gssapi_server_step(), _gsasl_obsolete_callback(), _gsasl_openid20_client_step(), _gsasl_openid20_server_step(), _gsasl_saml20_client_step(), _gsasl_saml20_server_step(), _gsasl_securid_client_step(), and gsasl_property_set().

◆ gsasl_random()

int gsasl_random ( char *  data,
size_t  datalen 
)

gsasl_random: @data: output array to be filled with strong random data. @datalen: size of output array.

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

Return value: Returns GSASL_OK iff successful.

Definition at line 54 of file crypto.c.

References gc_random().

Referenced by gsasl_randomize().

◆ gsasl_saslprep()

◆ gsasl_scram_secrets_from_password()

int gsasl_scram_secrets_from_password ( Gsasl_hash  hash,
const char *  password,
unsigned int  iteration_count,
const char *  salt,
size_t  saltlen,
char *  salted_password,
char *  client_key,
char *  server_key,
char *  stored_key 
)

gsasl_scram_secrets_from_password: @hash: a Gsasl_hash element, e.g., GSASL_HASH_SHA256. @password: input parameter with password. @iteration_count: number of PBKDF2 rounds to apply. @salt: input character array of @saltlen length with salt for PBKDF2. @saltlen: length of @salt. @salted_password: pre-allocated output array with derived salted password. @client_key: pre-allocated output array with derived client key. @server_key: pre-allocated output array with derived server key. @stored_key: pre-allocated output array with derived stored key.

Helper function to generate SCRAM secrets from a password. The @salted_password, @client_key, @server_key, and @stored_key buffers must have room to hold digest for given @hash, use GSASL_HASH_MAX_SIZE which is sufficient for all hashes.

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

Since: 1.10

Definition at line 155 of file crypto.c.

References _gsasl_pbkdf2(), GSASL_ALLOW_UNASSIGNED, GSASL_OK, gsasl_saslprep(), gsasl_scram_secrets_from_salted_password(), NULL, and res.

Referenced by _gsasl_scram_client_step(), _gsasl_scram_server_step(), and mkpasswd().

◆ gsasl_scram_secrets_from_salted_password()

int gsasl_scram_secrets_from_salted_password ( Gsasl_hash  hash,
const char *  salted_password,
char *  client_key,
char *  server_key,
char *  stored_key 
)

gsasl_scram_secrets_from_salted_password: @hash: a Gsasl_hash element, e.g., GSASL_HASH_SHA256. @salted_password: input array with salted password. @client_key: pre-allocated output array with derived client key. @server_key: pre-allocated output array with derived server key. @stored_key: pre-allocated output array with derived stored key.

Helper function to derive SCRAM ClientKey/ServerKey/StoredKey. The @client_key, @server_key, and @stored_key buffers must have room to hold digest for given @hash, use GSASL_HASH_MAX_SIZE which is sufficient for all hashes.

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

Since: 1.10

Definition at line 103 of file crypto.c.

References _gsasl_hash(), _gsasl_hmac(), CLIENT_KEY, gsasl_hash_length(), GSASL_OK, res, and SERVER_KEY.

Referenced by _gsasl_scram_client_step(), and gsasl_scram_secrets_from_password().

◆ gsasl_server_mechlist()

int gsasl_server_mechlist ( Gsasl ctx,
char **  out 
)

gsasl_server_mechlist: @ctx: libgsasl handle. @out: newly allocated output character array.

Return a newly allocated string containing SASL names, separated by space, of mechanisms supported by the libgsasl server. @out is allocated by this function, and it is the responsibility of caller to deallocate it.

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

Definition at line 93 of file listmech.c.

References _gsasl_listmech(), Gsasl::n_server_mechs, and Gsasl::server_mechs.

Referenced by gsasl_server_listmech(), and main().

◆ gsasl_server_start()

int gsasl_server_start ( Gsasl ctx,
const char *  mech,
Gsasl_session **  sctx 
)

gsasl_server_start: @ctx: libgsasl handle. @mech: name of SASL mechanism. @sctx: pointer to server handle.

This functions initiates a server SASL authentication. This function must be called before any other gsasl_server_*() function is called.

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

Definition at line 137 of file xstart.c.

References Gsasl::n_server_mechs, Gsasl::server_mechs, and start().

Referenced by _gsasl_listmech(), and main().

◆ gsasl_server_support_p()

int gsasl_server_support_p ( Gsasl ctx,
const char *  name 
)

Definition at line 66 of file supportp.c.

References _gsasl_support_p(), Gsasl::n_server_mechs, name, and Gsasl::server_mechs.

◆ gsasl_session_hook_get()

void* gsasl_session_hook_get ( Gsasl_session sctx)

gsasl_session_hook_get: @sctx: libgsasl session handle.

Retrieve application specific data from libgsasl session handle.

The application data is set using gsasl_callback_hook_set(). This is normally used by the application to maintain a per-session state between the main program and callbacks.

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

Since: 0.2.14

Definition at line 168 of file callback.c.

References Gsasl_session::application_hook.

◆ gsasl_session_hook_set()

void gsasl_session_hook_set ( Gsasl_session sctx,
void *  hook 
)

gsasl_session_hook_set: @sctx: libgsasl session handle. @hook: 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_session_hook_get(). This is normally used by the application to maintain a per-session state between the main program and callbacks.

Since: 0.2.14

Definition at line 148 of file callback.c.

References Gsasl_session::application_hook.

◆ gsasl_simple_getpass()

int gsasl_simple_getpass ( const char *  filename,
const char *  username,
char **  key 
)

gsasl_simple_getpass: @filename: filename of file containing passwords. @username: username string. @key: newly allocated output character array.

Retrieve password for user from specified file. The buffer @key contain the password if this function is successful. The caller is responsible for deallocating it.

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.

Definition at line 47 of file md5pwd.c.

References getline(), GSASL_AUTHENTICATION_ERROR, GSASL_MALLOC_ERROR, GSASL_OK, and NULL.

Referenced by gsasl_md5pwd_get_password().

◆ gsasl_step()

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

gsasl_step: @sctx: libgsasl session handle. @input: input byte array. @input_len: size of input byte array. @output: newly allocated output byte array. @output_len: pointer to output variable with size of output byte array.

Perform one step of SASL authentication. This reads data from the other end (from @input and @input_len), processes it (potentially invoking callbacks to the application), and writes data to server (into newly allocated variable @output and @output_len that indicate the length of @output).

The contents of the @output buffer is unspecified if this functions returns anything other than GSASL_OK or GSASL_NEEDS_MORE. If this function return GSASL_OK or GSASL_NEEDS_MORE, however, the @output buffer is allocated by this function, and it is the responsibility of caller to deallocate it by calling free (@output).

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

Definition at line 51 of file xstep.c.

References Gsasl_mechanism::client, Gsasl_session::clientp, Gsasl_session::mech, Gsasl_session::mech_data, Gsasl_mechanism::server, and Gsasl_mechanism_functions::step.

Referenced by _gsasl_step(), and gsasl_step64().

◆ gsasl_step64()

int gsasl_step64 ( Gsasl_session sctx,
const char *  b64input,
char **  b64output 
)

gsasl_step64: @sctx: libgsasl client handle. @b64input: input base64 encoded byte array. @b64output: newly allocated output base64 encoded byte array.

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

The contents of the @b64output buffer is unspecified if this functions returns anything other than GSASL_OK or GSASL_NEEDS_MORE. If this function return GSASL_OK or GSASL_NEEDS_MORE, however, the @b64output buffer is allocated by this function, and it is the responsibility of caller to deallocate it by calling free (@b64output).

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

Definition at line 86 of file xstep.c.

References GSASL_BASE64_ERROR, gsasl_base64_from(), gsasl_base64_to(), GSASL_NEEDS_MORE, GSASL_OK, gsasl_step(), NULL, and res.

Referenced by _gsasl_step64(), and main().

◆ gsasl_strerror()

const char* gsasl_strerror ( int  err)

gsasl_strerror: @err: libgsasl error code

Convert return code to human readable string explanation of the reason for the particular error code.

This string can be used to output a diagnostic message to the user.

This function is one of few in the library that can be used without a successful call to gsasl_init().

Return value: Returns a pointer to a statically allocated string containing an explanation of the error code @err.

Definition at line 228 of file error.c.

References _, bindtextdomain, errors, LOCALEDIR, N_, p, and PACKAGE.

Referenced by main(), and mkpasswd().

◆ gsasl_strerror_name()

const char* gsasl_strerror_name ( int  err)

gsasl_strerror_name: @err: libgsasl error code

Convert return code to human readable string representing the error code symbol itself. For example, gsasl_strerror_name(GSASL_OK) returns the string "GSASL_OK".

This string can be used to output a diagnostic message to the user.

This function is one of few in the library that can be used without a successful call to gsasl_init().

Return value: Returns a pointer to a statically allocated string containing a string version of the error code @err, or NULL if the error code is not known.

Since: 0.2.29

Definition at line 266 of file error.c.

References errors, and NULL.

Referenced by main().

Variable Documentation

◆ GSASL_VALID_MECHANISM_CHARACTERS

const char* GSASL_VALID_MECHANISM_CHARACTERS
extern

GSASL_VALID_MECHANISM_CHARACTERS:

A zero-terminated character array, or string, with all ASCII characters that may be used within a SASL mechanism name.

Definition at line 51 of file init.c.

Referenced by gsasl_client_suggest_mechanism().