The module Fpath_Cmdliner is a set of functions that parse untrusted

file paths in Cmdliner-based command line interfaces.

File paths that are rejected include, but are not limited to:

  • File paths with null (0) bytes.
Sourceval untainted_fpath : ?usage:unit -> string Tr1Cmdliner_Std.Cmdliner.Term.t -> Tr1Fpath_Std.Fpath.t Cmdliner.Term.t

untainted_fpath ?usage string_t is a Cmdliner term that parses a string option into a Fpath option. If the file path is rejected then Cmdliner will print a message, including the ~usage:() flag is on.

Untainting does not do Tr1Fpath_Std.Fpath.normalize.

Sourceval untainted_fpath_opt : ?usage:unit -> string option Tr1Cmdliner_Std.Cmdliner.Term.t -> Tr1Fpath_Std.Fpath.t option Tr1Cmdliner_Std.Cmdliner.Term.t

untainted_fpath_opt ?usage string_t is a Cmdliner term that parses an optional string option into an optional Fpath option. If the file path is rejected then Cmdliner will print a message, including the ~usage:() flag is on.

Untainting does not do Tr1Fpath_Std.Fpath.normalize.

Sourceval untainted_fpath_list : ?usage:unit -> string list Tr1Cmdliner_Std.Cmdliner.Term.t -> Tr1Fpath_Std.Fpath.t list Tr1Cmdliner_Std.Cmdliner.Term.t

untainted_fpath_opt ?usage string_t is a Cmdliner term that parses a list of string options into a list of Fpath options. If the file path is rejected then Cmdliner will print a message, including the ~usage:() flag is on.

Untainting does not do Tr1Fpath_Std.Fpath.normalize.