package krb

You can search for identifiers within the package.

in-package search v0.2.0

krb.internal
- Krb_internal_public
  - Auth_context
    
    Ap_rep
    
    Ap_req
    
    Client
    
    Krb_cred
    
    Priv
    
    Safe
    
    Service
    
    V0
    
    Client
    
    Service
    
    V1
    
    Client
    
    Service
  - Cache_type
    
    Stable
    
    V1
  - Config
  - Config_gen
    
    S
  - Config_gen_intf
    
    Config_gen
    
    S
    
    S
  - Context
  - Context_sequencer
    
    Expert
  - Cred_cache
    
    Expert
    
    Raw
  - Credentials
    
    Expert
    
    Flags
    
    Raw
  - Cursor
    
    Make
    
    S
    
    Container
    
    Cursor
    
    Item
  - Cursor_intf
    
    Arg
    
    Container
    
    Cursor
    
    Item
    
    Cursor
    
    Make
    
    S
    
    Container
    
    Cursor
    
    Item
  - Data
  - Debug_log_config
    
    Stable
    
    V1
  - Enctype
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Stable
    
    V1
  - Get_init_creds_opts
    
    Raw
  - Inet_of_fd
  - Key_usage_number
  - Keyblock
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Raw
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
  - Keytab
    
    Raw
  - Keytab_entry
    
    Raw
  - Krb_debug
  - Krb_error
  - Krb_error0
  - Krb_flags
    
    Ap_req
    
    Auth_context
    
    Get_credentials
  - Krb_info
  - Krb_result
  - Principal
    
    Raw
  - Sexp_opaque_when_testing
  - Stable
  - Std
  - Ticket
krb.public
- Krb_public
  - Async_protocol
    
    Client
    
    Connection
    
    Cross_realm
    
    Server
    
    Test_mode
    
    Client
    
    Connection
    
    Server
  - Authorize
    
    Anon
    
    Cross_realm
    
    For_internal_use
    
    Anon
  - Client_identity
    
    Fields
    
    Direct
  - Client_principal
  - Conn_type
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Stable
    
    V1
    
    Map
    
    Set
  - Conn_type_preference
    
    Stable
    
    V1
    
    Map
    
    Set
  - Cred_cache
    
    Cross_realm
    
    Expert
  - Cross_realm_principal_name
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Service
    
    Set
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Stable
    
    V1
    
    Map
    
    Set
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    User
  - Fqdn
  - Handshake_error
    
    Kind
  - Kerberized_rw
  - Keytab
    
    Path
    
    Stable
    
    Path
    
    V1
  - Mode
    
    Client
    
    Client_with_auth_conn_type
    
    Server
    
    Server_with_auth_conn_type
    
    Stable
    
    V4
    
    Client
    
    Client_with_auth_conn_type
    
    Server
    
    Server_with_auth_conn_type
  - On_credential_forwarding_request
  - Principal
    
    Cross_realm
    
    Name
    
    Hash_queue
    
    Hash_set
    
    Provide_bin_io
    
    X
    
    Provide_of_sexp
    
    X
    
    Map
    
    Key
    
    Provide_bin_io
    
    Key
    
    Provide_hash
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Replace_polymorphic_compare
    
    Set
    
    Elt
    
    Provide_bin_io
    
    Elt
    
    Provide_hash
    
    Elt
    
    Provide_of_sexp
    
    Elt
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Stable
    
    Name
    
    V1
    
    Map
    
    Set
  - Private
    
    Client_cred_cache
    
    For_testing
    
    Currently_running_user
    
    Blocking
    
    Kerberized_rpc_over_protocol
    
    For_testing
    
    Kerberized_rpc_transport
    
    Internal
    
    Tcp
    
    Tcp
    
    Kerberized_tcp_over_protocol
    
    Client
    
    Server
    
    Endpoint
    
    Protocol
    
    Connection
    
    Cross_realm
    
    Make
    
    Backend
    
    Client
    
    Connection
    
    Cross_realm
    
    Server
    
    S
    
    Client
    
    Connection
    
    Cross_realm
    
    Server
    
    Stable
    
    V1
    
    Client_header
    
    Mode
    
    Server_header
    
    V2
    
    Client_header
    
    Mode
    
    Server_header
    
    V3
    
    Client_header
    
    Mode
    
    Server_header
    
    V4
    
    Client_header
    
    Mode
    
    Server_header
    
    V5
    
    Client_header
    
    Mode
    
    Server_header
    
    Stable_protocol
    
    Client_header
    
    Mode
    
    Server_header
    
    Protocol_backend_intf
    
    S
    
    Protocol_with_test_mode
    
    S
    
    Client
    
    Connection
    
    Cross_realm
    
    Server
    
    Test_mode
    
    Client
    
    Connection
    
    Server
    
    Test_mode_protocol
    
    Ack
    
    Make
    
    Backend
    
    Client
    
    Connection
    
    Server
    
    S
    
    Client
    
    Connection
    
    Server
    
    Syn
  - Realm
  - Rpc
    
    Connection
    
    Internal
    
    Transport
    
    Internal
    
    Tcp
    
    Tcp
  - Server_key_source
    
    Stable
    
    V2
  - Server_principal
  - Stable
  - Tcp
    
    Internal
    
    Endpoint
    
    Server
    
    Krb_or_anon_conn
    
    Server
  - Tgt
    
    Cross_realm

Legend:
Library
Module
Module type
Parameter
Class
Class type

Kerberos clients send encrypted tickets for servers. One of the central underpinning of Kerberos is that only the KDC and the target server know this secret encryption key.

A Server_key_source.t represents which key is used to encrypt service tickets. The Keytab variant should be used for as-users. The Tgt variant should be used for human users. default () will make this choice for you based on the currently running user.

See ../doc/index.mkd for more information on how Kerberos works.

type t =

| Tgt
(*
Use the session key associated with the server's ticket granting ticket (TGT). The user must have a valid TGT in its cred cache. This is the recommended setup for human users that don't have keytabs.
*)
| Keytab of Principal.Name.t * Keytab.Path.t
(*
Use the password-derived key for the specified principal that is stored in the specified keytab.
*)

include Ppx_compare_lib.Comparable.S with type t := t

val compare : t -> t -> int

include Ppx_hash_lib.Hashable.S with type t := t

val hash_fold_t : Base.Hash.state -> t -> Base.Hash.state

val hash : t -> Base.Hash.hash_value

val sexp_of_t : t -> Sexplib0.Sexp.t

val best_effort_validate : 
  ?refresh_tgt:unit ->
  cred_cache:Cred_cache.t ->
  t ->
  unit Async.Deferred.Or_error.t

Make a best effort attempt to validate t. This can be used as a way to fail early after getting a t from the command line. It is automatically called with ~refresh_tgt:() before all Tcp and Rpc client connections.

refresh_tgt will start a background job to refresh credentials in the Keytab case.

Note: it is still possible for this function to return a success but a later call that uses t to fail. This might be because a ticket has expired or because some other process has been mucking around with the credential cache.

val principal : t -> Principal.t Async.Deferred.Or_error.t

principal t returns the Principal.t that will be used to start kerberized services

module Stable : sig ... end