Updates to HTTP request paths in preparation for removing prefix matching behaviour. (#6732)

We're looking to remove the prefix matching that our homebrew HTTP
server does with routes, so I've updated a couple things in the code to
remove any reliance on this behaviour. In particular:
- The Python RPC library makes requests to the /RPC2 endpoint, which
used to get redirected by the prefix matching, so I've added that as a
valid endpoint.
- nbd was making requests to "/var/xapi/xapi" in error, as this is the
socket it was connecting to.
- "uri" in the HTTP server actually referred to the path, not the entire
uri - changed this.

Author: robhoes

ocaml/idl/datamodel.ml

@@ -11005,6 +11005,16 @@ let http_actions =
       , []
       )
     )
+    (* For XC < 8460 compatibility, remove when out of support *)
+  ; ( "get_vm_rrds"
+    , ( Get
+      , "/vm_rrds"
+      , true
+      , [String_query_arg "uuid"; Bool_query_arg "json"]
+      , _R_READ_ONLY
+      , []
+      )
+    )
   ; ( Constants.get_host_rrd
     , ( Get
       , Constants.get_host_rrd_uri
@@ -11014,6 +11024,10 @@ let http_actions =
       , []
       )
     )
+    (* For XC < 8460 compatibility, remove when out of support *)
+  ; ( "get_host_rrds"
+    , (Get, "/host_rrds", true, [Bool_query_arg "json"], _R_READ_ONLY, [])
+    )
   ; ( Constants.get_sr_rrd
     , ( Get
       , Constants.get_sr_rrd_uri
@@ -11081,6 +11095,7 @@ let http_actions =
     )
   ; (* XMLRPC callback *)
     ("post_root", (Post, "/", false, [], _R_READ_ONLY, []))
+  ; ("post_RPC2", (Post, "/RPC2", false, [], _R_READ_ONLY, []))
   ; (* JSON callback *)
     ("post_json", (Post, Constants.json_uri, false, [], _R_READ_ONLY, []))
   ; ("post_root_options", (Options, "/", false, [], _R_READ_ONLY, []))
@@ -11133,6 +11148,7 @@ let http_actions =
 let public_http_actions_with_no_rbac_check =
   [
     "post_root"
+  ; "post_RPC2"
   ; (* XMLRPC (API) calls -> checks RBAC internally *)
     "post_cli"
   ; (* CLI commands -> calls XMLRPC *)

ocaml/libs/http-lib/http.ml

@@ -505,7 +505,7 @@ end
 module Request = struct
   type t = {
       m: method_t
-    ; uri: string
+    ; path: string
     ; query: (string * string) list
     ; version: string
     ; frame: bool
@@ -528,7 +528,7 @@ module Request = struct
   let empty =
     {
       m= Unknown ""
-    ; uri= ""
+    ; path= ""
     ; query= []
     ; version= ""
     ; frame= false
@@ -563,7 +563,7 @@ module Request = struct
     ; host
     ; user_agent= Some user_agent
     ; m= meth
-    ; uri= path
+    ; path
     ; additional_headers= headers
     ; body
     ; accept
@@ -577,10 +577,10 @@ module Request = struct
       String.concat "; " (List.map (fun (k, v) -> k ^ "=" ^ v) x)
     in
     Printf.sprintf
-      "{ frame = %b; method = %s; uri = %s; query = [ %s ]; content_length = [ \
-       %s ]; transfer encoding = %s; version = %s; cookie = [ %s ]; task = %s; \
-       subtask_of = %s; content-type = %s; host = %s; user_agent = %s; }"
-      x.frame (string_of_method_t x.m) x.uri (kvpairs x.query)
+      "{ frame = %b; method = %s; path = %s; query = [ %s ]; content_length = \
+       [ %s ]; transfer encoding = %s; version = %s; cookie = [ %s ]; task = \
+       %s; subtask_of = %s; content-type = %s; host = %s; user_agent = %s; }"
+      x.frame (string_of_method_t x.m) x.path (kvpairs x.query)
       (Option.fold ~none:"" ~some:Int64.to_string x.content_length)
       (Option.value ~default:"" x.transfer_encoding)
       x.version "(value filtered)" (* cookies *)
@@ -642,7 +642,7 @@ module Request = struct
       [(Hdr.connection ^ ": " ^ if x.close then "close" else "keep-alive")]
     in
     [
-      Printf.sprintf "%s %s%s HTTP/%s" (string_of_method_t x.m) x.uri query
+      Printf.sprintf "%s %s%s HTTP/%s" (string_of_method_t x.m) x.path query
         x.version
     ]
     @ cookie
@@ -809,17 +809,17 @@ module Url = struct
 
   type scheme = Http of http | File of file
 
-  type data = {uri: string; query_params: (string * string) list}
+  type data = {path: string; query_params: (string * string) list}
 
   type t = scheme * data
 
-  let file_equal a b = String.equal a.path b.path
+  let file_equal (a : file) (b : file) = String.equal a.path b.path
 
   let query_params_equal (ak, av) (bk, bv) =
     String.equal ak bk && String.equal av bv
 
   let data_equal a b =
-    String.equal a.uri b.uri
+    String.equal a.path b.path
     && List.equal query_params_equal a.query_params b.query_params
 
   let http_equal a b =
@@ -858,7 +858,7 @@ module Url = struct
       in
       let data =
         {
-          uri= (match Uri.path_unencoded uri with "" -> "/" | path -> path)
+          path= (match Uri.path_unencoded uri with "" -> "/" | path -> path)
         ; query_params= Uri.query uri |> List.map query
         }
       in
@@ -872,19 +872,19 @@ module Url = struct
           (scheme ~ssl:true, data)
       | Some "file" ->
           let scheme = File {path= Uri.path_unencoded uri} in
-          (scheme, {data with uri= "/"})
+          (scheme, {data with path= "/"})
       | _ ->
           failwith "unsupported URI scheme"
     with e ->
       fail "%s: can't parse '%s': %s" __FUNCTION__ url (Printexc.to_string e)
 
-  let data_to_string {uri; query_params= params} =
+  let data_to_string {path; query_params= params} =
     let kvpairs x =
       String.concat "&"
         (List.map (fun (k, v) -> urlencode k ^ "=" ^ urlencode v) x)
     in
     let params = if params = [] then "" else "?" ^ kvpairs params in
-    uri ^ params
+    path ^ params
 
   let to_string scheme =
     let query (k, v) = (k, [v]) in
@@ -893,7 +893,7 @@ module Url = struct
       | File {path}, {query_params= params; _} ->
           Uri.make ~scheme:"file" ~path ~query:(List.map query params) ()
           |> Uri.to_string
-      | Http h, {uri; query_params= params} ->
+      | Http h, {path; query_params= params} ->
           let auth =
             match h.auth with
             | Some (Basic (username, password)) ->
@@ -905,16 +905,16 @@ module Url = struct
           in
           Uri.make
             ~scheme:(if h.ssl then "https" else "http")
-            ~host:h.host ?port:h.port ?userinfo:auth ~path:uri
+            ~host:h.host ?port:h.port ?userinfo:auth ~path
             ~query:(List.map query params) ()
           |> Uri.to_string
     in
     debug "%s: %s" __FUNCTION__ str ;
     str
 
-  let get_uri (_scheme, data) = data.uri
+  let get_path (_scheme, data) = data.path
 
-  let set_uri (scheme, data) u = (scheme, {data with uri= u})
+  let set_path (scheme, data) u = (scheme, {data with path= u})
 
   let get_query_params (_scheme, data) = data.query_params
 

ocaml/libs/http-lib/http.mli

@@ -72,7 +72,7 @@ end
 module Request : sig
   type t = {
       m: method_t
-    ; uri: string
+    ; path: string
     ; query: (string * string) list
     ; version: string
     ; frame: bool
@@ -254,7 +254,7 @@ module Url : sig
 
   type scheme = Http of http | File of file
 
-  type data = {uri: string; query_params: (string * string) list}
+  type data = {path: string; query_params: (string * string) list}
 
   type t = scheme * data
 
@@ -264,9 +264,9 @@ module Url : sig
 
   val to_string : t -> string
 
-  val get_uri : t -> string
+  val get_path : t -> string
 
-  val set_uri : t -> string -> t
+  val set_path : t -> string -> t
 
   val get_query_params : t -> (string * string) list
 

ocaml/libs/http-lib/http_svr.ml

@@ -103,7 +103,7 @@ module Helper = struct
   include Tracing.Propagator.Make (struct
     include Tracing_propagator.Propagator.Http
 
-    let name_span req = req.Http.Request.uri
+    let name_span req = req.Http.Request.path
   end)
 end
 
@@ -310,13 +310,13 @@ module Server = struct
 
   let empty default_context = {handlers= MethodMap.empty; default_context}
 
-  let add_handler x ty uri handler =
+  let add_handler x ty path handler =
     let existing =
       Option.value (MethodMap.find_opt ty x.handlers) ~default:Radix_tree.empty
     in
     x.handlers <-
       MethodMap.add ty
-        (Radix_tree.insert uri {(TE.empty ()) with TE.handler} existing)
+        (Radix_tree.insert path {(TE.empty ()) with TE.handler} existing)
         x.handlers
 
   let find_stats x m uri =
@@ -386,7 +386,7 @@ let read_request_exn ~proxy_seen ~read_timeout ~total_timeout ~max_length fd =
                  (* Request-Line   = Method SP Request-URI SP HTTP-Version CRLF *)
                  let uri_t = Uri.of_string uri in
                  if uri_t = Uri.empty then raise Http_parse_failure ;
-                 let uri = Uri.path_unencoded uri_t in
+                 let path = Uri.path_unencoded uri_t in
                  let query = Uri.query uri_t |> kvlist_flatten in
                  let m = Http.method_t_of_string meth in
                  let version =
@@ -396,7 +396,7 @@ let read_request_exn ~proxy_seen ~read_timeout ~total_timeout ~max_length fd =
                      (String.length x - String.length prefix)
                  in
                  let close = version = "1.0" in
-                 (true, {req with m; uri; query; version; close})
+                 (true, {req with m; path; query; version; close})
              | _ ->
                  raise Http_parse_failure
            else
@@ -525,7 +525,7 @@ let handle_one (x : 'a Server.t) ss context req =
     let empty = TE.empty () in
     let te =
       Option.value ~default:empty
-        (Radix_tree.longest_prefix req.Request.uri method_map)
+        (Radix_tree.longest_prefix req.Request.path method_map)
     in
     let@ _ = Tracing.with_child_trace span ~name:"handler" in
     te.TE.handler req ss context ;

ocaml/libs/http-lib/http_test.ml

@@ -170,7 +170,7 @@ module URL = struct
     let open Http.Url in
     [
       ( "file:/var/xapi/storage"
-      , (File {path= "/var/xapi/storage"}, {uri= "/"; query_params= []})
+      , (File {path= "/var/xapi/storage"}, {path= "/"; query_params= []})
       )
     ; ( "http://root:foo@localhost"
       , ( Http
@@ -180,17 +180,17 @@ module URL = struct
             ; host= "localhost"
             ; port= None
             }
-        , {uri= "/"; query_params= []}
+        , {path= "/"; query_params= []}
         )
       )
     ; ( "https://google.com/gmail"
       , ( Http {auth= None; ssl= true; host= "google.com"; port= None}
-        , {uri= "/gmail"; query_params= []}
+        , {path= "/gmail"; query_params= []}
         )
       )
     ; ( "https://xapi.xen.org/services/SM"
       , ( Http {auth= None; ssl= true; host= "xapi.xen.org"; port= None}
-        , {uri= "/services/SM"; query_params= []}
+        , {path= "/services/SM"; query_params= []}
         )
       )
     ; ( "https://root:[email protected]:1234/services/SM"
@@ -201,12 +201,12 @@ module URL = struct
             ; host= "xapi.xen.org"
             ; port= Some 1234
             }
-        , {uri= "/services/SM"; query_params= []}
+        , {path= "/services/SM"; query_params= []}
         )
       )
     ; ( "https://xapi.xen.org/services/SM?foo=bar"
       , ( Http {auth= None; ssl= true; host= "xapi.xen.org"; port= None}
-        , {uri= "/services/SM"; query_params= [("foo", "bar")]}
+        , {path= "/services/SM"; query_params= [("foo", "bar")]}
         )
       )
     ]
@@ -221,7 +221,7 @@ module URL = struct
     let data = "https://xapi.xen.org/services/SM?foo=bar" in
     let expected = "https://xapi.xen.org/services/SM/data?foo=bar" in
     let u = Http.Url.of_string data in
-    let u' = Http.Url.set_uri u (Http.Url.get_uri u ^ "/data") in
+    let u' = Http.Url.set_path u (Http.Url.get_path u ^ "/data") in
     let actual = Http.Url.to_string u' in
     Alcotest.(check string) data expected actual
 

ocaml/libs/http-lib/ws_helpers.ml

@@ -21,10 +21,10 @@
 
 (* Websockets helper functions *)
 
-(* A couple of short helper functions for upgrading an HTTP 
- * connection to a websockets connection 
+(* A couple of short helper functions for upgrading an HTTP
+ * connection to a websockets connection
  * See for reference:
- * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-17 
+ * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-17
  *)
 
 type protocol = Hixie76 | Hybi10
@@ -123,7 +123,7 @@ let hixie_v76_upgrade req s =
     try Some (find_header headers "sec-websocket-protocol") with _ -> None
   in
   let real_uri =
-    req.Http.Request.uri
+    req.Http.Request.path
     ^ "?"
     ^ String.concat "&"
         (List.map

ocaml/nbd/lib/consts.ml

@@ -1,5 +1,6 @@
 (** Xapi's local Unix domain socket *)
-let xapi_unix_domain_socket_uri = "file:///var/xapi/xapi"
+let xapi_unix_domain_socket_uri =
+  Uri.make ~scheme:"file" ~path:"/var/xapi/xapi" ()
 
 (** Location of the xensource-inventory file on XenServer *)
 let xensource_inventory_filename = "/etc/xensource-inventory"

ocaml/nbd/lib/dune

@@ -1,6 +1,7 @@
 (library
  (name consts)
  (modes best)
+ (libraries uri)
  (modules consts)
 )
 

ocaml/xapi-cli-server/xapi_cli.ml

@@ -125,7 +125,7 @@ module TraceHelper = struct
   include Tracing.Propagator.Make (struct
     include Tracing_propagator.Propagator.Http
 
-    let name_span req = req.Http.Request.uri
+    let name_span req = req.Http.Request.path
   end)
 
   let inject_span_into_req (span : Tracing.Span.t option) =

ocaml/xapi-guard/test/xapi_guard_test.ml

@@ -86,8 +86,8 @@ let with_rpc f switch () =
     Server_interface.make_server_varstored push_nothing ~cache path vm_uuid
   in
   (* rpc simulates what varstored would do *)
-  let uri = Uri.make ~scheme:"file" ~path () |> Uri.to_string in
-  D.debug "Connecting to %s" uri ;
+  let uri = Uri.make ~scheme:"file" ~path () in
+  D.debug "Connecting to %s" (Uri.to_string uri) ;
   let rpc = make uri in
   Lwt.finalize
     (fun () ->