Module `Principal.Name`Source

Sourcetype t =

| User of string
| Service of {
1. service : string;
2. hostname : string;
}

A Name.t represents the conventional names that may appear in a Kerberos principal (i.e. the bit before "@REALM").

By default, when constructing a principal from this type, we assume that the principal is within the default realm configured in krb.conf. If realm information should be preserved (eg. within cross-realm environments), use Cross_realm_principal_name.t instead.

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

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

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t

to_string returns either <username> or <service>/<hostname>.

of_string is lenient to inclusion of the realm (for all principals) and full qualification of the domain name (for service principals). We drop the provided realm and drop a provided domain name if it matches the default domain.

include Core.Stringable.S with type t := t

Sourceval of_string : string -> t

Sourceval to_string : t -> string

include Core.Comparable.S_plain with type t := t

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

val (>=) : t -> t -> bool

val (<=) : t -> t -> bool

val (=) : t -> t -> bool

val (>) : t -> t -> bool

val (<) : t -> t -> bool

val (<>) : t -> t -> bool

val equal : t -> t -> bool

val min : t -> t -> t

val max : t -> t -> t

val ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

val descending : t -> t -> int

val between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

val clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

val clamp : t -> min:t -> max:t -> t Base__.Or_error.t

Sourcetype comparator_witness

val comparator : (t, comparator_witness) Base__.Comparator.comparator

Sourceval validate_lbound : min:t Core.Maybe_bound.t -> t Validate.check

Sourceval validate_ubound : max:t Core.Maybe_bound.t -> t Validate.check

Source

val validate_bound : 
  min:t Core.Maybe_bound.t ->
  max:t Core.Maybe_bound.t ->
  t Validate.check

Source

module Replace_polymorphic_compare : 
  Base.Comparable.Comparisons with type t := t

Source

module Map : 
  Core.Map.S_plain
    with type Key.t = t
    with type Key.comparator_witness = comparator_witness

Source

module Set : 
  Core.Set.S_plain
    with type Elt.t = t
    with type Elt.comparator_witness = comparator_witness

include Core.Hashable.S_plain with type t := t

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

val compare : t Base__Ppx_compare_lib.compare

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

Sourceval hash_fold_t : t Base__Ppx_hash_lib.hash_fold

Sourceval hash : t -> Base__Ppx_hash_lib.Std.Hash.hash_value

Sourceval hashable : t Core.Hashtbl.Hashable.t

Sourcemodule Table : Core.Hashtbl.S_plain with type key = t

Sourcemodule Hash_set : Core.Hash_set.S_plain with type elt = t

Sourcemodule Hash_queue : Core.Hash_queue.S with type key = t

Sourceval arg : t Async.Command.Arg_type.t

accepts <username> or <service>/<hostname>

Sourceval to_username : t -> Username_kernel.Username.t option

Returns None if t is a Service

Sourceval to_username_exn : t -> Username_kernel.Username.t

Raises if t is a Service

Sourceval service_on_this_host : service:string -> t

Cross-realm

Sourceval of_cross_realm : Cross_realm_principal_name.t -> t

Sourceval with_realm : realm:Realm.t -> t -> Cross_realm_principal_name.t

Source

val with_default_realm : 
  t ->
  Cross_realm_principal_name.t Async.Deferred.Or_error.t

Install

Dune Dependency

Authors

Maintainers

Sources

doc/krb.public/Krb_public/Principal/Name/index.html

Module `Principal.Name`Source

package krb

Install

Dune Dependency

Authors

Maintainers

Sources

doc/krb.public/Krb_public/Principal/Name/index.html

Module Principal.NameSource

Module `Principal.Name`Source