Mehari 1.0

.gitignore

@@ -1,38 +1,10 @@
-*.annot
-*.cmo
-*.cma
-*.cmi
-*.a
-*.o
-*.cmx
-*.cmxs
-*.cmxa
-
-# ocamlbuild working directory
 _build/
+_opam
 
-# ocamlbuild targets
-*.byte
-*.native
-
-# oasis generated files
-setup.data
-setup.log
-
-# Merlin configuring file for Vim and Emacs
-.merlin
+compile_commands.json
+dune
+dune-workspace
+vendors/
 
-# Dune generated files
-*.install
-
-# Local OPAM switch
-_opam/
-.DS_Store
-
-# Certificates
 *.key
 *.pem
-
-# Sublime Text
-*.sublime-project
-*.sublime-workspace

.ocamlformat

@@ -1 +1,3 @@
 profile = default
+version = 0.29.0
+

Makefile

@@ -18,4 +18,4 @@ fmt:
 	dune build @fmt --auto-promote
 
 deps:
-	opam install --deps-only .
+	opam install . --deps-only --with-test --with-dev

README.md

@@ -1,11 +1,11 @@
 # Mehari
 
-Mehari is a cross-platform library for building Gemini servers. It fully
+Mehari is a library for building Gemini servers. It fully
 implements the
 [Gemini protocol specification](https://geminiprotocol.net/docs/protocol-specification.gmi).
 
-It takes heavy inspiration from [Dream](https://github.com/aantron/dream), a
-tidy, feature-complete Web framework.
+It takes inspiration from [Dream](https://github.com/aantron/dream), a
+tidy feature-complete Web framework, and from [Nightmare](https://github.com/funkywork/nightmare), a powerful typesafe layer compatible with Dream.
 
 <p align="center">
   <img src="https://user-images.githubusercontent.com/59396366/211079934-44f65ed1-8cf7-4193-a815-8da94a85be5d.png" alt="banner"/>
@@ -23,23 +23,70 @@ opam install mehari
 ## Features
 
 - Mirage OS friendly
+- Type safe route API
 - Static files serving
 - MIME type inference from file content (using experimental [Conan](https://github.com/mirage/conan/) support)
 - Rate limit
-- Virtual hosting using SNI
-- CGI
+- Virtual hosting using TLS SNI
+- CGI support
 - Long-running TCP connection
 
-## Feedback
-
-Since Mehari is in its early stages, any feedback and contributions regarding the API or security are appreciated.
-
 ## Important links
 
 - API documentation: https://docs.heyplzlookat.me/mehari/
 - Tutorial: https://docs.heyplzlookat.me/mehari/index.html#tutorial
 - Issues: https://github.com/Psi-Prod/Mehari/issues
 
+
+## Building the unikernel
+
+Setup dev environment:
+```bash
+$ opam install mehari-mirage solo5 ocaml-solo5
+$ opam pin vif.dev git+https://github.com/robur-coop/vif.git#3fb86c53bc56d3af78ce5df76b285a2b476e39ad
+$ opam pin vifu.dev git+https://github.com/robur-coop/vif.git#3fb86c53bc56d3af78ce5df76b285a2b476e39ad
+$ opam pin zarith.dev git+https://github.com/mirage/Zarith.git#df8969d9bb95cffca13e31a615189ab27ada0684
+```
+
+Vendor dependencies:
+```bash
+$ ./unikernel/vendor.sh
+```
+
+Setup network bridge:
+```bash
+$ ip link add name service type bridge
+$ ip addr add 10.0.0.1/24 dev service
+$ ip tuntap add name tap0 mode tap
+$ ip link set tap0 master service
+$ ip link set service up
+$ ip link set tap0 up
+```
+
+Create `dune` and `dune-workspace` files at the root of the repo:
+
+``` bash
+$ cat >dune<<EOF
+(vendored_dirs vendors)
+EOF
+$ cat >dune-workspace<<EOF
+(lang dune 3.23)
+(context (default))
+(context (default
+ (name solo5)
+ (host default)
+ (toolchain solo5)
+ (disable_dynamically_linked_foreign_archives true)))
+EOF
+```
+
+Compile and run the unikernel:
+
+```bash
+$ dune build --profile=release
+$ solo5-hvt --net:service=tap0 -- ./_build/solo5/unikernel/unikernel.exe --ipv4=10.0.0.2/24
+```
+
 ## License
 
 Distributed under the **LGPL-3.0 License**. See [license](LICENSE) for more information.

dune-project

@@ -1,6 +1,6 @@
-(lang dune 3.0)
+(lang dune 3.23)
 
-(version 0.4)
+(version 0.5)
 
 (name mehari)
 
@@ -15,84 +15,57 @@
 
 (homepage "https://github.com/Psi-Prod/Mehari")
 
+(maintenance_intent "(latest)")
+
 (generate_opam_files true)
 
 (package
  (name mehari)
- (synopsis "A cross-platform library for building Gemini servers")
+ (synopsis "A library for building Gemini servers.")
  (description
-  "Mehari is a cross-platform library for building Gemini servers.\nIt fully implements the Gemini protocol specification.\nIt takes heavy inspiration from Dream, a tidy, feature-complete Web framework.")
+  "Mehari is a library for building Gemini servers.\nIt fully implements the Gemini protocol specification.\nIt takes heavy inspiration from Dream, a tidy, feature-complete Web framework.")
  (depends
   (ocaml
-   (>= 4.14))
+   (>= 5.4))
   (conan
-   (>= 0.0.5))
+   (>= 0.0.7))
   (conan-database
-   (>= 0.0.5))
+   (>= 0.0.7))
+  (ipaddr
+   (>= 5.6.2))
   (logs
-   (>= 0.7.0))
-  (re
-   (>= 1.10.4))
+   (>= 0.10.0))
+  (mirage-ptime
+   (>= 5.2.0))
   (tls
-   (>= 0.16.0))
+   (>= 2.0.4))
   (uri
-   (>= 4.2.0))
-  (x509
-   (>= 0.16.2))))
-
-(package
- (name mehari-mirage)
- (synopsis "Mehari IO implementation for MirageOS")
- (depends
-  (mehari
-   (= :version))
-  (ipaddr
-   (>= 5.3.1))
-  (lwt
-   (>= 5.6.1))
-  (mirage-channel
-   (>= 4.1.0))
-  (mirage-time
-   (>= 3.0.0))
-  (tcpip
-   (>= 7.1.2))
-  (tls-mirage
-   (>= 0.15.4))
-  (tls-lwt
-   (>= 0.16.0))))
+   (>= 4.4.0))
+  (alcotest :with-test)
+  (utop :with-dev-setup)
+  (ocamlformat :with-dev-setup)
+  (ocp-indent :with-dev-setup)
+  (merlin :with-dev-setup)
+  (ocaml-lsp-server :with-dev-setup)))
 
 (package
- (name mehari-lwt-unix)
- (synopsis "Mehari IO implementation using Lwt and Unix bindings")
+ (name mehari-miou)
+ (synopsis "Mehari server implementation using Miou.")
  (depends
   (mehari
    (= :version))
-  (mehari-mirage
-   (= :version))
-  (lwt
-   (>= 5.6.1))
-  (mirage-clock-unix
-   (>= 4.2.0))
-  (mirage-flow-unix
-   (>= 3.0.0))
-  (mirage-time-unix
-   (>= 3.0.0))
-  (tcpip
-   (>= 7.1.2))))
+  (tls-miou-unix
+   (>= 2.0.4))))
 
 (package
- (name mehari-eio)
- (synopsis "Mehari IO implementation using Eio")
+ (name mehari-mirage)
+ (synopsis "Mehari server implementation for Mirage.")
  (depends
-  (ocaml
-   (>= 5.0.0))
   (mehari
    (= :version))
-  (eio
-   (>= 1.0))
-  (logs
-   (>= 0.7.0))
-  (tls
-   (>= 0.15.4))
-  (tls-eio
-   (>= 0.15.5))))
+  (mkernel
+   (>= 0.0.2))
+  (mnet
+   (>= 0.0.2))
+  (mnet-tls
+   (>= 0.0.2))))

examples/README.md

@@ -12,20 +12,6 @@ openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 3
 - [guestbook](guestbook.ml) — a more complex application.
 - [rate_limt](rate_limit.ml) — rate limits a route.
 - [client_cert](client_cert.ml) — demonstrates how to deal with client certificate.
-- [eio_backend](eio_backend.ml) — a minimalistic app which shows the rudiments of `Mehari_eio`.
-- [stream](stream.ml) — take advantage of Eio's direct style to setup a request handler to stream a response body instead of plain text.
+- [stream](stream.ml) — setup a request handler to stream a response body instead of plain text.
 - [cgi](cgi.ml) — demonstrates CGI support. Don't forget to make `cgi_script.py` executable.
 - [vhost](vhost.ml) — demonstrates the virtual hosting support.
-
-## Unikernel
-
-[unikernel/](unikernel/) is a simple unikernel which serves files located in [unikernel/gemtext/](unikernel/gemtext/).
-Copy your private key in [unikernel/tls/server.key](unikernel/tls/server.key) and your certificate in [unikernel/tls/server.pem](unikernel/tls/server.pem) and run the following:
-
-```bash
-$ cd unikernel/
-$ mirage configure -t unix # initial setup for UNIX backend
-$ make depend # install dependencies
-$ make # build the program
-$ dist/gemini-srv # run the program
-```

examples/cgi.ml

@@ -1,10 +1,14 @@
-module M = Mehari_lwt_unix
-open Lwt.Syntax
+open Mehari
 
-let main () =
-  let* certchains = Common.Lwt.load_certchains () in
-  M.router
-    [ M.route "/cgi" (fun req -> M.run_cgi "./examples/cgi_script.py" req) ]
-  |> M.run_lwt ~certchains
+let router =
+  let open Router in
+  router
+    [ route Path.(~/"cgi") (Mehari_miou.run_cgi "./examples/cgi_script.py") ]
 
-let () = Lwt_main.run (main ())
+let () =
+  Miou_unix.run @@ fun () ->
+  Mirage_crypto_rng_unix.use_default ();
+  let certs = Common.load_certs ~cert:"cert.pem" ~priv_key:"key.pem" in
+  Mehari_miou.run ~certs
+    Ipaddr.(V4 (V4.Prefix.make 8 V4.localhost))
+    (Logger.logger router)

examples/cgi_script.py

@@ -1,4 +1,8 @@
 #!/usr/bin/env python3
 
-print("20 text/gemtext\r\n")
-print("Hello from a CGI script!")
+import os
+
+server = os.getenv("SERVER_SOFTWARE")
+
+print("20 text/gemtext\r")
+print(f"Hello from a CGI script served by {server}!")

examples/client_cert.ml

@@ -1,18 +1,27 @@
+open Mehari
+
 let router =
-  Mehari_eio.router
+  Router.router
     [
-      Mehari_eio.route "/" (fun req ->
-          match Mehari.client_cert req with
-          | [] -> Mehari.(response client_cert_req) "Certificate plz"
-          | hd :: _ ->
-              X509.Certificate.encode_pem hd
-              |> Cstruct.to_string
-              |> Printf.sprintf "Client certificate ~nyoron\n%s"
-              |> Mehari.response_text);
+      Router.route Path.root (fun req ->
+          match Request.client_cert req with
+          | None -> Response.respond Status.client_cert_req "Certificate plz"
+          | Some cert ->
+              let pem = X509.Certificate.encode_pem cert in
+              let common_name =
+                X509.Certificate.subject cert
+                |> X509.Distinguished_name.common_name
+                |> Option.value ~default:"None"
+              in
+              Printf.sprintf "Ur client certificate ~nyoron\n%sCommon name: %s"
+                pem common_name
+              |> Response.text);
     ]
 
-let main ~net ~cwd =
-  let certchains = Common.Eio.load_certchains cwd in
-  Mehari_eio.run net ~certchains router
-
-let () = Common.Eio.run_server main
+let () =
+  Miou_unix.run @@ fun () ->
+  Mirage_crypto_rng_unix.use_default ();
+  let certs = Common.load_certs ~cert:"cert.pem" ~priv_key:"key.pem" in
+  Mehari_miou.run ~certs
+    Ipaddr.(V4 (V4.Prefix.make 8 V4.localhost))
+    (Logger.logger router)