From 81e01468d15f3db6e2d5fb279d9298a58be233dd Mon Sep 17 00:00:00 2001 From: swrup Date: Mon, 13 Oct 2025 03:26:15 +0200 Subject: [PATCH] rm config.ml + add tofu comment --- src/assets.ml | 58 ++++++++++++++++++++++++++++++++++++++++++--- src/config.ml | 19 --------------- src/headers.ml | 18 +++++++++----- src/mte.ml | 4 ++-- src/taler_config.ml | 1 + src/util.ml | 37 +---------------------------- 6 files changed, 71 insertions(+), 66 deletions(-) delete mode 100644 src/config.ml diff --git a/src/assets.ml b/src/assets.ml index 4ec1b634..109a0b36 100644 --- a/src/assets.ml +++ b/src/assets.ml @@ -7,7 +7,59 @@ (* docs: https://docs.taler.net/manpages/taler-exchange.conf.5.html https://docs.taler.net/design-documents/003-tos-rendering.html *) -(* todo: maybe move this type to config.ml *) +(* hardcoded config just for static assets *) +module Config = struct + let default_lang = "en" + let default_encoding : [< `Identity | `DEFLATE | `Gzip ] = `Identity + + (* TODO Taler documentation markdown mimetype should be the prefered one, and be + supported, according to DD we take text/plain as default instead for now *) + let default_mimetype = ("text", "plain") + let default_extension = ".txt" + let terms_dir = Fpath.(v "terms") + let privacy_dir = Fpath.(v "privacy") + + (* ETAG is used as base filename it should be encoded in Crockford base-32 we do + not generate it and we do not verify it *) + let terms_etag = "0" |> Headers_lib.Etag.of_crockford32 |> Result.get_ok + let privacy_etag = "0" |> Headers_lib.Etag.of_crockford32 |> Result.get_ok + let terms_legal_version = "1" + let privacy_legal_version = "1" +end + +module Mimetype = struct + let mimetype_extension_assoc = + [ + (("text", "plain"), ".txt"); (("text", "markdown"), ".md"); + (("text", "html"), ".html"); (("text", "html"), ".htm"); + (("application", "pdf"), ".pdf"); (("image", "jpeg"), ".jpg"); + (("image", "jpeg"), ".jpeg"); (("image", "png"), ".png"); + (("image", "gif"), ".gif"); + ] + + let mimetype_l, _ = List.split mimetype_extension_assoc + + let of_cohttp_media = function + | Cohttp.Accept.MediaType (m, m_sub) -> + List.find_opt (( = ) (m, m_sub)) mimetype_l + | AnyMediaSubtype m -> + List.find_opt (fun (m', _) -> String.equal m m') mimetype_l + | AnyMedia -> Some Config.default_mimetype + + let to_extension (m, m_sub) = + assert (m <> "*"); + assert (m_sub <> "*"); + List.assoc_opt (m, m_sub) mimetype_extension_assoc + + let of_extension ext = + List.find_map + (fun (mime, ext') -> + match String.equal ext ext' with false -> None | true -> Some mime) + mimetype_extension_assoc + + let pp_mime fmt mime = Fmt.pf fmt "%s/%s" (fst mime) (snd mime) +end + type t = | Terms | Privacy @@ -88,7 +140,7 @@ let supported_lang_arr, supported_ext_arr = (Array.of_list lang_l, Array.of_list ext_l) let supported_mimetype_arr = - Array.map Util.Mimetype.of_extension supported_ext_arr |> Array.map Option.get + Array.map Mimetype.of_extension supported_ext_arr |> Array.map Option.get let is_supported_lang lang = Array.mem lang supported_lang_arr let is_supported_ext ext = Array.mem ext supported_ext_arr @@ -101,7 +153,7 @@ let is_supported_mimetype mime = Array.mem mime supported_mimetype_arr let get_content ~lang ~mime t = let etag = Headers_lib.Etag.to_raw_string (etag t) in let ext = - match Util.Mimetype.to_extension mime with + match Mimetype.to_extension mime with | None -> Fmt.failwith "mimetype `%s/%s` unknown" (fst mime) (snd mime) | Some ext -> ext in diff --git a/src/config.ml b/src/config.ml deleted file mode 100644 index b03e00c7..00000000 --- a/src/config.ml +++ /dev/null @@ -1,19 +0,0 @@ -(* config_mte.ml - config value that are not in official config options *) - -let default_lang = "en" -let default_encoding : [< `Identity | `DEFLATE | `Gzip ] = `Identity - -(* TODO Taler documentation markdown mimetype should be the prefered one, and be - supported, according to DD we take text/plain as default instead for now *) -let default_mimetype = ("text", "plain") -let default_extension = ".txt" -let terms_dir = Fpath.(v "terms") -let privacy_dir = Fpath.(v "privacy") - -(* ETAG is used as base filename it should be encoded in Crockford base-32 we do - not generate it and we do not verify it *) -let terms_etag = "0" |> Headers_lib.Etag.of_crockford32 |> Result.get_ok -let privacy_etag = "0" |> Headers_lib.Etag.of_crockford32 |> Result.get_ok -let terms_legal_version = "1" -let privacy_legal_version = "1" diff --git a/src/headers.ml b/src/headers.ml index 7c6525f0..fa0d5646 100644 --- a/src/headers.ml +++ b/src/headers.ml @@ -1,16 +1,22 @@ +let pp_array pp_item item = Fmt.array ~sep:(Fmt.any ", ") pp_item item + let accept_header_value = - let s = Fmt.str "%a" Util.(pp_array pp_mime) Assets.supported_mimetype_arr in + let s = + Fmt.str "%a" + (pp_array Assets.Mimetype.pp_mime) + Assets.supported_mimetype_arr + in s let avail_languages_header_value = - let s = Fmt.str "%a" (Util.pp_array Fmt.string) Assets.supported_lang_arr in + let s = Fmt.str "%a" (pp_array Fmt.string) Assets.supported_lang_arr in s let select_mimetype headers = let accept = Vif.Headers.get headers "accept" in Cohttp.Accept.media_ranges accept |> Cohttp.Accept.qsort - |> List.filter_map (fun (_q, (m, _p)) -> Util.Mimetype.of_cohttp_media m) + |> List.filter_map (fun (_q, (m, _p)) -> Assets.Mimetype.of_cohttp_media m) |> List.find_opt Assets.is_supported_mimetype let select_language headers = @@ -19,14 +25,14 @@ let select_language headers = |> Cohttp.Accept.qsort |> List.map (fun (_q, lang) -> lang) |> List.map (function - | Cohttp.Accept.AnyLanguage -> Config.default_lang + | Cohttp.Accept.AnyLanguage -> Assets.Config.default_lang | Language language_range -> ( (* ignore language subtags (e.g. "en-US" -> "en") *) match language_range with | [] -> assert false | primary_tag :: _ -> primary_tag)) |> List.find_opt Assets.is_supported_lang - |> Option.value ~default:Config.default_lang + |> Option.value ~default:Assets.Config.default_lang let select_encoding headers = Vif.Headers.get headers "accept-encoding" @@ -37,7 +43,7 @@ let select_encoding headers = | Cohttp.Accept.Identity -> Some `Identity | Deflate -> Some `DEFLATE | Gzip -> Some `Gzip - | AnyEncoding -> Some Config.default_encoding + | AnyEncoding -> Some Assets.Config.default_encoding | Encoding _ | Compress -> (* unsupported *) None) |> function | [] -> assert false diff --git a/src/mte.ml b/src/mte.ml index 8c013b47..d785aef8 100644 --- a/src/mte.ml +++ b/src/mte.ml @@ -83,13 +83,13 @@ module Static = struct in let* () = (* todo: is it "taler-privacy-version" for /policy ? *) - add ~field:"taler-terms-version" Config.terms_legal_version + add ~field:"taler-terms-version" Assets.Config.terms_legal_version in let* () = add ~field:"avail-languages" Headers.avail_languages_header_value in let* () = - let content_type = Fmt.str "%a" Util.pp_mime mime in + let content_type = Fmt.str "%a" Assets.Mimetype.pp_mime mime in add ~field:"content-type" content_type in respond `OK) diff --git a/src/taler_config.ml b/src/taler_config.ml index 3374a962..117c0548 100644 --- a/src/taler_config.ml +++ b/src/taler_config.ml @@ -168,6 +168,7 @@ module type Offline_signing = sig - we need two different file here - there is three, not two, crypto helper modules is it only two, because the eddsa one is not comptabilized as a "crypto helper" here? *) + (* tofu = Trust On First Use *) val secm_tofu_file : file_path val secm_denom_pubkey : string option val secm_esign_pubkey : string option diff --git a/src/util.ml b/src/util.ml index 047ffc7e..c5721f38 100644 --- a/src/util.ml +++ b/src/util.ml @@ -1,43 +1,8 @@ +(* TODO *) module Protocol_version = struct (* libtool version format *) - (* todo *) let current = 0 let revision = 0 let age = 0 let v = Fmt.str "%d:%d:%d" end - -module Mimetype = struct - let mimetype_extension_assoc = - [ - (("text", "plain"), ".txt"); (("text", "markdown"), ".md"); - (("text", "html"), ".html"); (("text", "html"), ".htm"); - (("application", "pdf"), ".pdf"); (("image", "jpeg"), ".jpg"); - (("image", "jpeg"), ".jpeg"); (("image", "png"), ".png"); - (("image", "gif"), ".gif"); - ] - - let mimetype_l, _ = List.split mimetype_extension_assoc - - let of_cohttp_media = function - | Cohttp.Accept.MediaType (m, m_sub) -> - List.find_opt (( = ) (m, m_sub)) mimetype_l - | AnyMediaSubtype m -> - List.find_opt (fun (m', _) -> String.equal m m') mimetype_l - | AnyMedia -> Some Config.default_mimetype - - let to_extension (m, m_sub) = - assert (m <> "*"); - assert (m_sub <> "*"); - List.assoc_opt (m, m_sub) mimetype_extension_assoc - - let of_extension ext = - List.find_map - (fun (mime, ext') -> - match String.equal ext ext' with false -> None | true -> Some mime) - mimetype_extension_assoc -end - -(* -- pretty printers -- *) -let pp_mime fmt mime = Fmt.pf fmt "%s/%s" (fst mime) (snd mime) -let pp_array pp_item item = Fmt.array ~sep:(Fmt.any ", ") pp_item item