* A list of mechanisms that are allowed to be used by this context. This

* list can be either white space or comma separated.

*

*/

properties[PROP_ALLOWED_MECHANISMS] = g_param_spec_string(

"allowed-mechanisms", "allowed-mechanism",

* be set to the username of the user to authenticate as, but the username

* and password fields will be proper values for the administrator.

*

*/

properties[PROP_AUTHZID] = g_param_spec_string(

"authzid", "authzid",

* The username of the user that is authenticating for mechanisms that need

* it.

*

*/

properties[PROP_USERNAME] = g_param_spec_string(

"username", "username",

*

* The password to use for mechanisms that need it.

*

*/

properties[PROP_PASSWORD] = g_param_spec_string(

"password", "password",

* [property@Hasl.Context:allow-clear-text] to determine if mechanisms that

* depend on the transport layer to secure credentials should be attempted.

*

*/

properties[PROP_TLS] = g_param_spec_boolean(

"tls", "tls",

* g_free(client_out);

* ```

*

*/

#define HASL_TYPE_CONTEXT (hasl_context_get_type())

*

* Returns: (transfer full): The new context.

*

*/

HASL_AVAILABLE_IN_0_1

HaslContext *hasl_context_new(void);

*

* Returns: The list of allowed mechanisms.

*

*/

HASL_AVAILABLE_IN_0_1

const char *hasl_context_get_allowed_mechanisms(HaslContext *ctx);

*

* @allowed_mechanisms can be white space or comma separated.

*

*/

HASL_AVAILABLE_IN_0_1

void hasl_context_set_allowed_mechanisms(HaslContext *ctx, const char *allowed_mechanisms);

*

* Returns: (nullable): The authzid if one is set, otherwise %NULL.

*

*/

HASL_AVAILABLE_IN_0_1

const char *hasl_context_get_authzid(HaslContext *ctx);

* Sets the authzid of @ctx to @authzid. See [property@Hasl.Context:authzid]

* for more information.

*

*/

HASL_AVAILABLE_IN_0_1

void hasl_context_set_authzid(HaslContext *ctx, const char *authzid);

*

* Returns: (nullable): The username if set, otherwise %NULL.

*

*/

HASL_AVAILABLE_IN_0_1

const char *hasl_context_get_username(HaslContext *ctx);

*

* Sets the username of @ctx to @username.

*

*/

HASL_AVAILABLE_IN_0_1

void hasl_context_set_username(HaslContext *ctx, const char *username);

*

* Returns: (nullable): The password if set, otherwise %NULL.

*

*/

HASL_AVAILABLE_IN_0_1

const char *hasl_context_get_password(HaslContext *ctx);

*

* Sets the password for @ctx to @password.

*

*/

HASL_AVAILABLE_IN_0_1

void hasl_context_set_password(HaslContext *ctx, const char *password);

*

* Returns: %TRUE if @ctx is on a TLS connection, otherwise %FALSE.

*

*/

HASL_AVAILABLE_IN_0_1

gboolean hasl_context_get_tls(HaslContext *ctx);

*

* Sets whether or not @ctx is working with a TLS connection to @tls.

*

*/

HASL_AVAILABLE_IN_0_1

void hasl_context_set_tls(HaslContext *ctx, gboolean tls);

*

* Returns: %TRUE if clear text methods are allowed.

*

*/

HASL_AVAILABLE_IN_0_1

gboolean hasl_context_get_allow_clear_text(HaslContext *ctx);

*

* See [property@Hasl.Context:allow-clear-text] for more information.

*

*/

HASL_AVAILABLE_IN_0_1

void hasl_context_set_allow_clear_text(HaslContext *ctx, gboolean allow_clear_text);

*

* Returns: %TRUE if the mechanism was added, otherwise %FALSE.

*

*/

HASL_AVAILABLE_IN_0_1

gboolean hasl_context_add_mechanism(HaslContext *ctx, const char *name, GType type);

*

* Returns: (transfer full): The list of mechanisms.

*

*/

HASL_AVAILABLE_IN_0_1

char *hasl_context_get_supported_mechanisms(HaslContext *ctx);

*

* Returns: The name of the current mechanism or %NULL.

*

*/

HASL_AVAILABLE_IN_0_1

const char *hasl_context_get_current_mechanism(HaslContext *ctx);

* Returns: (nullable): The name of the next mechanism to try or %NULL if all

* mechanisms have been exhausted.

*

*/

HASL_AVAILABLE_IN_0_1

const char *hasl_context_next(HaslContext *ctx);

*

* Returns: a [enum@Hasl.MechanismResult] on how to proceed.

*

*/

HASL_AVAILABLE_IN_0_1

HaslMechanismResult hasl_context_step(HaslContext *ctx, const guint8 *server_in, gsize server_in_length, guint8 **client_out, gsize *client_out_length, GError **error);

*

* Whether or not the mechanism is a standard GSS-API mechanism.

*

*/

properties[PROP_STANDARD_MECHANISM] = g_param_spec_boolean(

"standard-mechanism", "standard-mechanism",

*

* The channel binding flag for this header.

*

*/

properties[PROP_CHANNEL_BINDING] = g_param_spec_enum(

"channel-binding", "channel-binding",

* If [property@Gs2Header:channel-binding] is set to ClientSupported, this

* must not be %NULL.

*

*/

properties[PROP_CHANNEL_BINDING_NAME] = g_param_spec_string(

"channel-binding-name", "channel-binding-name",

* An optional authzid to use. This is the username to authenticate as when

* using admin/moderator credentials.

*

*/

properties[PROP_AUTHZID] = g_param_spec_string(

"authzid", "authzid",

* https://datatracker.ietf.org/doc/html/rfc5801#section-4 for more

* information.

*

*/

typedef enum {

HaslGs2HeaderChannelBindingClientNotSupported,

* This is primarily meant to be used by mechanism implementations and should

* not be needed for normal use cases.

*

*/

#define HASL_TYPE_GS2_HEADER (hasl_gs2_header_get_type())

*

* Returns: (transfer full): The new gs2_header.

*

*/

HASL_AVAILABLE_IN_0_3

HaslGs2Header *hasl_gs2_header_new(void);

*

* Returns: (transfer full): The serialized header.

*

*/

HASL_AVAILABLE_IN_0_3

char *hasl_gs2_header_to_string(HaslGs2Header *header, GError **error);

*

* Returns: %TRUE if this mechanism is standard, %FALSE otherwise.

*

*/

HASL_AVAILABLE_IN_0_3

gboolean hasl_gs2_header_get_standard_mechanism(HaslGs2Header *header);

*

* Sets whether or not the mechanism is a standard GSS-API mechanism.

*

*/

HASL_AVAILABLE_IN_0_3

void hasl_gs2_header_set_standard_mechanism(HaslGs2Header *header, gboolean standard);

*

* Returns: The channel binding value.

*

*/

HASL_AVAILABLE_IN_0_3

HaslGs2HeaderChannelBinding hasl_gs2_header_get_channel_binding(HaslGs2Header *header);

*

* Sets the channel binding flag for @header.

*

*/

HASL_AVAILABLE_IN_0_3

void hasl_gs2_header_set_channel_binding(HaslGs2Header *header, HaslGs2HeaderChannelBinding channel_binding);

*

* Returns: (nullable): The channel binding name.

*

*/

HASL_AVAILABLE_IN_0_3

const char *hasl_gs2_header_get_channel_binding_name(HaslGs2Header *header);

*

* Sets the name of the channel binding data that should be used.

*

*/

HASL_AVAILABLE_IN_0_3

void hasl_gs2_header_set_channel_binding_name(HaslGs2Header *header, const char *name);

*

* Returns: (nullable): The authzid for this header.

*

*/

HASL_AVAILABLE_IN_0_3

const char *hasl_gs2_header_get_authzid(HaslGs2Header *header);

* or moderator needs to authenticate as a specific user using their own

* credentials.

*

*/

HASL_AVAILABLE_IN_0_3

void hasl_gs2_header_set_authzid(HaslGs2Header *header, const char *authzid);

* All mechanisms need to implement [method@Mechanism.step] but may optionally

* implement [method@Mechanism.possible].

*

*/

#define HASL_TYPE_MECHANISM (hasl_mechanism_get_type())

*

* The result states for [method@Hasl.Mechanism.step].

*

*/

typedef enum {

HASL_MECHANISM_RESULT_SUCCESS = 0,

*

* Returns: A [enum@Hasl.MechanismResult] with @error possibly set.

*

*/

HASL_AVAILABLE_IN_0_1

HaslMechanismResult hasl_mechanism_step(HaslMechanism *mechanism, HaslContext *ctx, const guint8 *server_in, gsize server_in_length, guint8 **client_out, gsize *client_out_length, GError **error);

* [property@Context:allow-clear-text] to %TRUE if [property@Context:tls] is

* %FALSE.

*

*/

#define HASL_TYPE_MECHANISM_ANONYMOUS (hasl_mechanism_anonymous_get_type())

* so there is no dependency on [property@Context:tls] as the server could be

* authenticating via IP addresses for example.

*

*/

#define HASL_TYPE_MECHANISM_EXTERNAL (hasl_mechanism_external_get_type())

* [property@Context:allow-clear-text] to %TRUE if [property@Context:tls] is

* %FALSE.

*

*/

#define HASL_TYPE_MECHANISM_PLAIN (hasl_mechanism_plain_get_type())

* A macro that evaluates to the current stable version of hasl, in a format

* that can be used by the C pre-processor.

*

*/

#define HASL_VERSION_CUR_STABLE \

(G_ENCODE_VERSION(HASL_MAJOR_VERSION, HASL_MINOR_VERSION))

* A macro that evaluates to the 0.1 version of hasl, in a format that can be

* used by the C pre-processor.

*

*/

#define HASL_VERSION_0_1 (G_ENCODE_VERSION(0, 1))

* A macro that evaluates to the 0.2 version of hasl, in a format that can be

* used by the C pre-processor.

*

*/

#define HASL_VERSION_0_2 (G_ENCODE_VERSION(0, 2))

* A macro that evaluates to the 0.3 version of hasl, in a format that can be

* used by the C pre-processor.

*

*/

#define HASL_VERSION_0_3 (G_ENCODE_VERSION(0, 3))

* Returns: %TRUE if the version is the same or newer than the passed-in

* version.

*

*/

#define HASL_CHECK_VERSION(major, minor, micro) ((major) == HASL_MAJOR_VERSION && \

((minor) < HASL_MINOR_VERSION || \

* Returns: %NULL if the versions are compatible, or a string describing

* the version mismatch if not compatible.

*

*/

HASL_AVAILABLE_IN_0_2

const char *hasl_check_version(guint required_major, guint required_minor, guint required_micro);

*

* The full version string of the running hasl.

*

*/

HASL_VAR const char *hasl_version;

* which expands at compile time to the major version of hasl being compiled

* against.

*

*/

HASL_VAR const guint hasl_major_version;

* which expands at compile time to the minor version of hasl being compiled

* against.

*

*/

HASL_VAR const guint hasl_minor_version;

* which expands at compile time to the micro version of hasl being compiled

* against.

*

*/

HASL_VAR const guint hasl_micro_version;