Module gss_mechanism

This module defines the gss_mechanism behaviour.
Required callback functions: initiate/1, accept/2, continue/2, delete/1, get_mic/2, verify_mic/3, wrap/2, unwrap/2, local_name/1, peer_name/1, translate_name/2.

Data Types

display_name()

display_name() = {hbsn_oid(), hbsn_name()} | {username_oid(), username_name()} | {uid_oid() | uid_name()} | {oid(), string()}

fatal_error()

fatal_error() = {error, reason()} | {error, {reason(), term()}}

An error which aborts the context.

general_oid()

general_oid() = hbsn_oid() | username_oid() | uid_oid()

general_options()

general_options() = #{chan_bindings => binary() | gss_bindings:rfc2744() | mech_specific_chan_bindings(), delegate => boolean(), mutual_auth => boolean(), sequence => boolean(), replay_detect => boolean(), confidentiality => boolean(), integrity => boolean()}

hbsn_name()

hbsn_name() = string()

GSS_C_NT_HOSTBASED_SERVICE: "service@hostname"

hbsn_oid()

hbsn_oid() = hbsn | svchost | '?id-service-name'

internal_name()

internal_name() = term()

mech_specific_chan_bindings()

mech_specific_chan_bindings() = term()

Mechanisms may support other formats for channel bindings.

mech_specific_oid()

mech_specific_oid() = tuple()

mech_specific_options()

mech_specific_options() = #{}

Mechanisms may support specific local options in the options map.

message()

message() = binary()

An unwrapped plain-text application message.

oid()

oid() = general_oid() | mech_specific_oid()

options()

options() = general_options() | mech_specific_options()

per_msg_error()

per_msg_error() = {error, reason(), state()}

An error which affects only the current message/token and does not abort the context.

reason()

reason() = defective_token | defective_cred | bad_mic | no_cred | bad_mech | cred_expired | bad_bindings | old_token | duplicate_token | bad_state | bad_name | context_expired | unseq_token | gap_token | term()

state()

state() = term()

Opaque state managed by the gss mechanism module.

token()

token() = binary()

A token to be transported (or which has been transported) across the connection.

uid_name()

uid_name() = string()

GSS_C_NT_STRING_UID_NAME: "12345"

uid_oid()

uid_oid() = machine_uid | '?id-string-uid-name'

username_name()

username_name() = string()

GSS_C_NT_USER_NAME: "username"

username_oid()

username_oid() = username | '?id-user-name'


Generated by EDoc