Module krb_realm_conf

Data Types

config()

config() = #{realm => realm(), kdc => [kdc_spec()], use_dns => boolean(), port => integer(), parallel => integer(), timeout => msecs(), retries => integer(), ciphers => [krb_crypto:etype()]}

Describes configuration relating to a specific Kerberos realm and how to communicate with it.

Configuration is taken from (in order of priority, highest priority first):
  1. Parameters given to krb_realm_config:configure/2
  2. OTP application configuration for kerlberos (see the type otp_config()
  3. System-wide configuration files (/etc/krb5.conf etc.)
  4. Hard-coded default values

config_list()

config_list() = [config_list_item()]

config_list_item()

config_list_item() = {realm, realm()} | {kdc, [kdc_spec()]} | {use_dns, boolean()} | {port, integer()} | {parallel, integer()} | {timeout, msecs()} | {retries, integer()} | {ciphers, [krb_crypto:etype()]}

kdc_spec()

kdc_spec() = inet:ip_address() | inet:hostname() | {inet:ip_address() | inet:hostname(), Port::integer()}

msecs()

msecs() = integer()

otp_config()

otp_config() = {kerlberos, [{realms, [otp_realm_config()]}]}

otp_realm_config()

otp_realm_config() = [{default | realm(), config_list()}]

realm()

realm() = string()

Function Index

configure/1
configure/2

Function Details

configure/1

configure(Realm::realm()) -> config()

configure/2

configure(Realm::realm(), UserConf::config()) -> config()


Generated by EDoc