comparing 8dceef7e92839b675f179521c990d135c5d30d79 and main on anil.recoil.org/ocaml-fastcgi

bin/dune

···

       1
       1
       +
       (executable

     

       2
       2
       +
        (public_name fcgi-server)

     

       3
       3
       +
        (name fcgi_server)

     

       4
       4
       +
        (libraries cmdliner eio eio_main fastcgi))

+79

bin/fcgi_server.ml

···

       1
       1
       +
       open Cmdliner

     

       2
       2
       +
       

     

       3
       3
       +
       (* Handler function that processes FastCGI requests *)

     

       4
       4
       +
       let handler ~stdout ~stderr request =

     

       5
       5
       +
         Eio.traceln "Processing request: %a" Fastcgi.Request.pp request;

     

       6
       6
       +
       

     

       7
       7
       +
         (* Get request parameters *)

     

       8
       8
       +
         let params = request.Fastcgi.Request.params in

     

       9
       9
       +
         let method_ = Fastcgi.Record.KV.find_opt "REQUEST_METHOD" params |> Option.value ~default:"GET" in

     

       10
       10
       +
         let uri = Fastcgi.Record.KV.find_opt "REQUEST_URI" params |> Option.value ~default:"/" in

     

       11
       11
       +
         let script_name = Fastcgi.Record.KV.find_opt "SCRIPT_NAME" params |> Option.value ~default:"" in

     

       12
       12
       +
       

     

       13
       13
       +
         (* Log request info *)

     

       14
       14
       +
         Eio.traceln "  Method: %s" method_;

     

       15
       15
       +
         Eio.traceln "  URI: %s" uri;

     

       16
       16
       +
         Eio.traceln "  Script: %s" script_name;

     

       17
       17
       +
       

     

       18
       18
       +
         (* Generate simple HTTP response *)

     

       19
       19
       +
         let response_body =

     

       20
       20
       +
           Printf.sprintf

     

       21
       21
       +
             "<!DOCTYPE html>\n\

     

       22
       22
       +
              <html>\n\

     

       23
       23
       +
              <head><title>FastCGI OCaml Server</title></head>\n\

     

       24
       24
       +
              <body>\n\

     

       25
       25
       +
              <h1>FastCGI OCaml Server</h1>\n\

     

       26
       26
       +
              <p>Request processed successfully!</p>\n\

     

       27
       27
       +
              <ul>\n\

     

       28
       28
       +
              <li>Method: %s</li>\n\

     

       29
       29
       +
              <li>URI: %s</li>\n\

     

       30
       30
       +
              <li>Script: %s</li>\n\

     

       31
       31
       +
              </ul>\n\

     

       32
       32
       +
              <h2>All Parameters:</h2>\n\

     

       33
       33
       +
              <pre>%s</pre>\n\

     

       34
       34
       +
              </body>\n\

     

       35
       35
       +
              </html>\n"

     

       36
       36
       +
             method_ uri script_name

     

       37
       37
       +
             (let params_seq = Fastcgi.Record.KV.to_seq params in

     

       38
       38
       +
              let params_list = List.of_seq params_seq in

     

       39
       39
       +
              String.concat "\n" (List.map (fun (k, v) -> Printf.sprintf "%s = %s" k v) params_list))

     

       40
       40
       +
         in

     

       41
       41
       +
       

     

       42
       42
       +
         (* Write HTTP response using FastCGI STDOUT records *)

     

       43
       43
       +
         let response_headers =

     

       44
       44
       +
           Printf.sprintf

     

       45
       45
       +
             "Status: 200 OK\r\n\

     

       46
       46
       +
              Content-Type: text/html; charset=utf-8\r\n\

     

       47
       47
       +
              Content-Length: %d\r\n\

     

       48
       48
       +
              \r\n"

     

       49
       49
       +
             (String.length response_body)

     

       50
       50
       +
         in

     

       51
       51
       +
         stdout response_headers;

     

       52
       52
       +
         stderr "stderr stuff";

     

       53
       53
       +
         stdout response_body

     

       54
       54
       +
       

     

       55
       55
       +
       let run port =

     

       56
       56
       +
         Eio_main.run @@ fun env ->

     

       57
       57
       +
         Eio.Switch.run @@ fun sw ->

     

       58
       58
       +
         let net = Eio.Stdenv.net env in

     

       59
       59
       +
         let addr = `Tcp (Eio.Net.Ipaddr.V4.loopback, port) in

     

       60
       60
       +
         let server_socket = Eio.Net.listen net ~backlog:10 ~reuse_addr:true ~sw addr in

     

       61
       61
       +
         Eio.traceln "FastCGI server listening on port %d" port;

     

       62
       62
       +
       

     

       63
       63
       +
         (* Run the FastCGI server *)

     

       64
       64
       +
         Fastcgi.run server_socket

     

       65
       65
       +
           ~on_error:(fun ex ->

     

       66
       66
       +
           Eio.traceln "Error: %s" (Printexc.to_string ex);

     

       67
       67
       +
           Eio.traceln "bt: %s" (Printexc.get_backtrace ()))

     

       68
       68
       +
           handler

     

       69
       69
       +
       

     

       70
       70
       +
       let port =

     

       71
       71
       +
         let doc = "Port to listen on" in

     

       72
       72
       +
         Arg.(value & opt int 9000 & info ["p"; "port"] ~docv:"PORT" ~doc)

     

       73
       73
       +
       

     

       74
       74
       +
       let cmd =

     

       75
       75
       +
         let doc = "FastCGI server" in

     

       76
       76
       +
         let info = Cmd.info "fcgi-server" ~doc in

     

       77
       77
       +
         Cmd.v info Term.(const run $ port)

     

       78
       78
       +
       

     

       79
       79
       +
       let () = exit (Cmd.eval cmd)

config/Caddyfile

···

       1
       1
       +
       {

     

       2
       2
       +
         debug

     

       3
       3
       +
       }

     

       4
       4
       +
       

     

       5
       5
       +
       localhost:80 {

     

       6
       6
       +
         php_fastcgi 127.0.0.1:9000

     

       7
       7
       +
       }

+3 -1

dune-project

···

       20
       20
        
        (depends 

     

       21
       21
        
         ocaml 

     

       22
       22
        
         dune

     

       23
       23
       -
         eio)

     

       23
       23
       +
         eio

     

       24
       24
       +
         cmdliner

     

       25
       25
       +
         eio_main)

     

       24
       26
        
        (synopsis "FastCGI protocol implementation for OCaml using Eio")

     

       25
       27
        
        (description "A type-safe implementation of the FastCGI protocol for OCaml using the Eio effects-based IO library. Supports all three FastCGI roles: Responder, Authorizer, and Filter."))

fastcgi.opam

···

       13
       13
        
         "ocaml"

     

       14
       14
        
         "dune" {>= "3.0"}

     

       15
       15
        
         "eio"

     

       16
       16
       +
         "cmdliner"

     

       17
       17
       +
         "eio_main"

     

       16
       18
        
         "odoc" {with-doc}

     

       17
       19
        
       ]

     

       18
       20
        
       build: [

+1 -4

lib/dune

···

       5
       5
        
        (modules

     

       6
       6
        
         fastcgi

     

       7
       7
        
         fastcgi_record

     

       8
       8
       -
        )

     

       9
       9
       -
        (modules_without_implementation

     

       10
       10
       -
         fastcgi

     

       11
       11
       -
         fastcgi_record

     

       8
       8
       +
         fastcgi_request

     

       12
       9
        
        )

     

       13
       10
        
       )

+50

lib/fastcgi.ml

···

       1
       1
       +
       module Record = Fastcgi_record

     

       2
       2
       +
       

     

       3
       3
       +
       (** Request-level state machine and application interface *)

     

       4
       4
       +
       module Request = Fastcgi_request

     

       5
       5
       +
       

     

       6
       6
       +
       (* The lifetime of the handler is that the fiber should return when the

     

       7
       7
       +
          stdout and stderr flows are closed, or an abort request has been received *)

     

       8
       8
       +
       let handle req bw cancel fn =

     

       9
       9
       +
         let cancel () =

     

       10
       10
       +
           Eio.Promise.await cancel;

     

       11
       11
       +
           Eio.traceln "cancelled TODO"

     

       12
       12
       +
         in

     

       13
       13
       +
         let stdout buf = Request.write_stdout_records bw req.Request.request_id buf in

     

       14
       14
       +
         let stderr buf = Request.write_stderr_records bw req.Request.request_id buf in

     

       15
       15
       +
         let run () =

     

       16
       16
       +
           fn ~stdout ~stderr req;

     

       17
       17
       +
           Request.write_end_request bw req.Request.request_id 0 Request.Request_complete

     

       18
       18
       +
         in

     

       19
       19
       +
         Eio.Fiber.first run cancel

     

       20
       20
       +
       

     

       21
       21
       +
       let run ?max_connections ?additional_domains ?stop ~on_error socket handler =

     

       22
       22
       +
         Eio.Net.run_server socket ?max_connections ?additional_domains ?stop ~on_error

     

       23
       23
       +
           (fun socket peer_address ->

     

       24
       24
       +
             let ids = Hashtbl.create 7 in

     

       25
       25
       +
             Eio.Switch.run @@ fun sw ->

     

       26
       26
       +
             Eio.traceln  "%a: accept connection" Eio.Net.Sockaddr.pp peer_address;

     

       27
       27
       +
             let input = Eio.Buf_read.of_flow ~max_size:max_int socket in

     

       28
       28
       +
             Eio.Buf_write.with_flow socket @@ fun output ->

     

       29
       29
       +
             let cont = ref true in

     

       30
       30
       +
             try while !cont do

     

       31
       31
       +
               match Request.read_request input with

     

       32
       32
       +
               | Error msg ->

     

       33
       33
       +
                   Eio.traceln "%a: failed to read request: %s" Eio.Net.Sockaddr.pp peer_address msg;

     

       34
       34
       +
                   failwith "done";

     

       35
       35
       +
               | Ok req ->

     

       36
       36
       +
                   cont := req.Request.keep_conn;

     

       37
       37
       +
                   Eio.traceln "%a: %b read request %a" Eio.Net.Sockaddr.pp peer_address !cont Request.pp req;

     

       38
       38
       +
                   Eio.Fiber.fork ~sw (fun () ->

     

       39
       39
       +
                     Eio.Switch.run ~name:"req_handler" @@ fun sw ->

     

       40
       40
       +
                     let cancel, canceler = Eio.Promise.create () in

     

       41
       41
       +
                     Hashtbl.add ids req.Request.request_id canceler;

     

       42
       42
       +
                     Eio.Switch.on_release sw (fun () ->

     

       43
       43
       +
                       Hashtbl.remove ids req.Request.request_id

     

       44
       44
       +
                     );

     

       45
       45
       +
                     handle req output cancel handler;

     

       46
       46
       +
                   );

     

       47
       47
       +
             done

     

       48
       48
       +
             with Eio.Io (Eio.Net.E (Connection_reset _), _) ->

     

       49
       49
       +
               Eio.traceln "%a: connection reset" Eio.Net.Sockaddr.pp peer_address

     

       50
       50
       +
           )

+20 -1

lib/fastcgi.mli

···

       3
       3
        
           This library provides a complete implementation of the FastCGI protocol

     

       4
       4
        
           for building high-performance web applications in OCaml. *)

     

       5
       5
        
       

     

       6
       6
       +
       

     

       6
       7
        
       (** {1 Core Protocol Components} *)

     

       7
       8
        
       

     

       8
       9
        
       (** Record-level protocol handling *)

     

       9
       9
       -
       module Record = Fastcgi_record
     

       10
       10
       +
       module Record = Fastcgi_record

     

       11
       11
       +
       

     

       12
       12
       +
       (** Request-level state machine and application interface *)

     

       13
       13
       +
       module Request = Fastcgi_request

     

       14
       14
       +
       

     

       15
       15
       +
       (** {1 High-level Request Processing} *)

     

       16
       16
       +
       

     

       17
       17
       +
       (** [handle_connection ~sw flow handler] handles complete FastCGI connection.

     

       18
       18
       +
           Reads requests from flow, processes them with handler, multiplexes responses.

     

       19
       19
       +
           Continues until connection is closed. *)

     

       20
       20
       +
       val run :

     

       21
       21
       +
                  ?max_connections:int ->

     

       22
       22
       +
                  ?additional_domains:[> Eio.Domain_manager.ty ] Eio.Resource.t *

     

       23
       23
       +
                                      int ->

     

       24
       24
       +
                  ?stop:'a Eio__core.Promise.t ->

     

       25
       25
       +
                  on_error:(exn -> unit) ->

     

       26
       26
       +
                  [> [> `Generic ] Eio.Net.listening_socket_ty ] Eio.Resource.t ->

     

       27
       27
       +
                  (stdout:(string -> unit) ->

     

       28
       28
       +
                   stderr:(string -> unit) -> Request.t -> unit) -> 'a

+305

lib/fastcgi_record.ml

···

       1
       1
       +
       

     

       2
       2
       +
       (** {1 Error Handling Helpers} *)

     

       3
       3
       +
       

     

       4
       4
       +
       (** Helper functions for consistent error handling *)

     

       5
       5
       +
       let invalid_version version = 

     

       6
       6
       +
         invalid_arg (Printf.sprintf "Unsupported FastCGI version: %d" version)

     

       7
       7
       +
       

     

       8
       8
       +
       let unknown_record_type n = 

     

       9
       9
       +
         invalid_arg (Printf.sprintf "Unknown FastCGI record type: %d" n)

     

       10
       10
       +
       

     

       11
       11
       +
       let buffer_underflow msg = 

     

       12
       12
       +
         failwith (Printf.sprintf "Unexpected end of buffer while %s" msg)

     

       13
       13
       +
       

     

       14
       14
       +
       let check_bounds buf pos len context =

     

       15
       15
       +
         if pos + len > String.length buf then

     

       16
       16
       +
           buffer_underflow context

     

       17
       17
       +
       

     

       18
       18
       +
       type version = int

     

       19
       19
       +
       

     

       20
       20
       +
       type record =

     

       21
       21
       +
         | Begin_request

     

       22
       22
       +
         | Abort_request

     

       23
       23
       +
         | End_request

     

       24
       24
       +
         | Params

     

       25
       25
       +
         | Stdin

     

       26
       26
       +
         | Stdout

     

       27
       27
       +
         | Stderr

     

       28
       28
       +
         | Data

     

       29
       29
       +
         | Get_values

     

       30
       30
       +
         | Get_values_result

     

       31
       31
       +
         | Unknown_type

     

       32
       32
       +
       

     

       33
       33
       +
       let record_to_int = function

     

       34
       34
       +
         | Begin_request -> 1

     

       35
       35
       +
         | Abort_request -> 2

     

       36
       36
       +
         | End_request -> 3

     

       37
       37
       +
         | Params -> 4

     

       38
       38
       +
         | Stdin -> 5

     

       39
       39
       +
         | Stdout -> 6

     

       40
       40
       +
         | Stderr -> 7

     

       41
       41
       +
         | Data -> 8

     

       42
       42
       +
         | Get_values -> 9

     

       43
       43
       +
         | Get_values_result -> 10

     

       44
       44
       +
         | Unknown_type -> 11

     

       45
       45
       +
       

     

       46
       46
       +
       let record_of_int = function

     

       47
       47
       +
         | 1 -> Begin_request

     

       48
       48
       +
         | 2 -> Abort_request

     

       49
       49
       +
         | 3 -> End_request

     

       50
       50
       +
         | 4 -> Params

     

       51
       51
       +
         | 5 -> Stdin

     

       52
       52
       +
         | 6 -> Stdout

     

       53
       53
       +
         | 7 -> Stderr

     

       54
       54
       +
         | 8 -> Data

     

       55
       55
       +
         | 9 -> Get_values

     

       56
       56
       +
         | 10 -> Get_values_result

     

       57
       57
       +
         | 11 -> Unknown_type

     

       58
       58
       +
         | n -> unknown_record_type n

     

       59
       59
       +
       

     

       60
       60
       +
       let pp_record ppf = function

     

       61
       61
       +
         | Begin_request -> Format.pp_print_string ppf "Begin_request"

     

       62
       62
       +
         | Abort_request -> Format.pp_print_string ppf "Abort_request"

     

       63
       63
       +
         | End_request -> Format.pp_print_string ppf "End_request"

     

       64
       64
       +
         | Params -> Format.pp_print_string ppf "Params"

     

       65
       65
       +
         | Stdin -> Format.pp_print_string ppf "Stdin"

     

       66
       66
       +
         | Stdout -> Format.pp_print_string ppf "Stdout"

     

       67
       67
       +
         | Stderr -> Format.pp_print_string ppf "Stderr"

     

       68
       68
       +
         | Data -> Format.pp_print_string ppf "Data"

     

       69
       69
       +
         | Get_values -> Format.pp_print_string ppf "Get_values"

     

       70
       70
       +
         | Get_values_result -> Format.pp_print_string ppf "Get_values_result"

     

       71
       71
       +
         | Unknown_type -> Format.pp_print_string ppf "Unknown_type"

     

       72
       72
       +
       

     

       73
       73
       +
       type request_id = int

     

       74
       74
       +
       

     

       75
       75
       +
       type t = {

     

       76
       76
       +
         version : version;

     

       77
       77
       +
         record_type : record;

     

       78
       78
       +
         request_id : request_id;

     

       79
       79
       +
         content : string;

     

       80
       80
       +
         offset : int;

     

       81
       81
       +
         length : int;

     

       82
       82
       +
       }

     

       83
       83
       +
       

     

       84
       84
       +
       let pp ?(max_content_len=100) ppf record =

     

       85
       85
       +
         let actual_content = String.sub record.content record.offset record.length in

     

       86
       86
       +
         let truncated_content = 

     

       87
       87
       +
           let len = String.length actual_content in

     

       88
       88
       +
           if len <= max_content_len then actual_content

     

       89
       89
       +
           else String.sub actual_content 0 max_content_len ^ "..." ^ Printf.sprintf " (%d more bytes)" (len - max_content_len)

     

       90
       90
       +
         in

     

       91
       91
       +
         Format.fprintf ppf

     

       92
       92
       +
           "@[<2>{ version = %d;@ record_type = %a;@ request_id = %d;@ content = %S;@ offset = %d;@ length = %d }@]"

     

       93
       93
       +
           record.version

     

       94
       94
       +
           pp_record record.record_type

     

       95
       95
       +
           record.request_id

     

       96
       96
       +
           truncated_content

     

       97
       97
       +
           record.offset

     

       98
       98
       +
           record.length

     

       99
       99
       +
       

     

       100
       100
       +
       (* FastCGI constants *)

     

       101
       101
       +
       let fcgi_version_1 = 1

     

       102
       102
       +
       let fcgi_header_len = 8

     

       103
       103
       +
       

     

       104
       104
       +
       let read buf_read =

     

       105
       105
       +
         Printf.eprintf "[DEBUG] Fastcgi_record.read: Starting to read record\n%!";

     

       106
       106
       +
         (* Read the 8-byte header *)

     

       107
       107
       +
         Printf.eprintf "[DEBUG] Fastcgi_record.read: Reading %d-byte header\n%!" fcgi_header_len;

     

       108
       108
       +
         let header = Eio.Buf_read.take fcgi_header_len buf_read in

     

       109
       109
       +
         

     

       110
       110
       +
         (* Parse header fields *)

     

       111
       111
       +
         let version = Char.code header.[0] in

     

       112
       112
       +
         let record_type_int = Char.code header.[1] in

     

       113
       113
       +
         let request_id = (Char.code header.[2] lsl 8) lor (Char.code header.[3]) in

     

       114
       114
       +
         let content_length = (Char.code header.[4] lsl 8) lor (Char.code header.[5]) in

     

       115
       115
       +
         let padding_length = Char.code header.[6] in

     

       116
       116
       +
         let _reserved = Char.code header.[7] in

     

       117
       117
       +
         

     

       118
       118
       +
         Printf.eprintf "[DEBUG] Fastcgi_record.read: Header parsed - version=%d, type=%d, id=%d, content_len=%d, padding=%d\n%!"

     

       119
       119
       +
           version record_type_int request_id content_length padding_length;

     

       120
       120
       +
         

     

       121
       121
       +
         (* Validate version *)

     

       122
       122
       +
         if version <> fcgi_version_1 then invalid_version version;

     

       123
       123
       +
         

     

       124
       124
       +
         (* Convert record type *)

     

       125
       125
       +
         let record_type = record_of_int record_type_int in

     

       126
       126
       +
         Printf.eprintf "[DEBUG] Fastcgi_record.read: Record type = %s\n%!" 

     

       127
       127
       +
           (Format.asprintf "%a" pp_record record_type);

     

       128
       128
       +
         

     

       129
       129
       +
         (* Read content *)

     

       130
       130
       +
         let content = 

     

       131
       131
       +
           if content_length = 0 then (

     

       132
       132
       +
             Printf.eprintf "[DEBUG] Fastcgi_record.read: No content to read (length=0)\n%!";

     

       133
       133
       +
             ""

     

       134
       134
       +
           ) else (

     

       135
       135
       +
             Printf.eprintf "[DEBUG] Fastcgi_record.read: Reading %d bytes of content\n%!" content_length;

     

       136
       136
       +
             let c = Eio.Buf_read.take content_length buf_read in

     

       137
       137
       +
             Printf.eprintf "[DEBUG] Fastcgi_record.read: Successfully read %d bytes\n%!" (String.length c);

     

       138
       138
       +
             c

     

       139
       139
       +
           )

     

       140
       140
       +
         in

     

       141
       141
       +
         

     

       142
       142
       +
         (* Skip padding *)

     

       143
       143
       +
         if padding_length > 0 then (

     

       144
       144
       +
           Printf.eprintf "[DEBUG] Fastcgi_record.read: Skipping %d bytes of padding\n%!" padding_length;

     

       145
       145
       +
           ignore (Eio.Buf_read.take padding_length buf_read)

     

       146
       146
       +
         );

     

       147
       147
       +
         

     

       148
       148
       +
         let record = { version; record_type; request_id; content; offset = 0; length = String.length content } in

     

       149
       149
       +
         Printf.eprintf "[DEBUG] Fastcgi_record.read: Complete record = %s\n%!" 

     

       150
       150
       +
           (Format.asprintf "%a" (pp ~max_content_len:50) record);

     

       151
       151
       +
         record

     

       152
       152
       +
       

     

       153
       153
       +
       let write buf_write record =

     

       154
       154
       +
         let total_content_length = String.length record.content in

     

       155
       155
       +
         let content_offset = record.offset in

     

       156
       156
       +
         let content_length = record.length in

     

       157
       157
       +
         

     

       158
       158
       +
         (* Validate bounds *)

     

       159
       159
       +
         if content_offset < 0 || content_offset > total_content_length then

     

       160
       160
       +
           invalid_arg "Fastcgi_record.write: offset out of bounds";

     

       161
       161
       +
         if content_length < 0 || content_offset + content_length > total_content_length then

     

       162
       162
       +
           invalid_arg "Fastcgi_record.write: length out of bounds";

     

       163
       163
       +
         

     

       164
       164
       +
         (* Calculate padding for 8-byte alignment *)

     

       165
       165
       +
         let padding_length = (8 - (content_length land 7)) land 7 in

     

       166
       166
       +
         

     

       167
       167
       +
         (* Create and write header *)

     

       168
       168
       +
         let header = Bytes.create fcgi_header_len in

     

       169
       169
       +
         Bytes.set_uint8 header 0 record.version;

     

       170
       170
       +
         Bytes.set_uint8 header 1 (record_to_int record.record_type);

     

       171
       171
       +
         Bytes.set_uint16_be header 2 record.request_id;

     

       172
       172
       +
         Bytes.set_uint16_be header 4 content_length;

     

       173
       173
       +
         Bytes.set_uint8 header 6 padding_length;

     

       174
       174
       +
         Bytes.set_uint8 header 7 0; (* reserved *)

     

       175
       175
       +
         

     

       176
       176
       +
         Eio.Buf_write.string buf_write (Bytes.to_string header);

     

       177
       177
       +
         

     

       178
       178
       +
         (* Write content with offset and length *)

     

       179
       179
       +
         if content_length > 0 then

     

       180
       180
       +
           Eio.Buf_write.string buf_write record.content ~off:content_offset ~len:content_length;

     

       181
       181
       +
         

     

       182
       182
       +
         (* Write padding *)

     

       183
       183
       +
         if padding_length > 0 then

     

       184
       184
       +
           Eio.Buf_write.string buf_write (String.make padding_length '\000')

     

       185
       185
       +
       

     

       186
       186
       +
       let create ?(version=1) ~record ~request_id ~content ?(offset=0) ?length () =

     

       187
       187
       +
         let content_length = match length with

     

       188
       188
       +
           | None -> String.length content - offset

     

       189
       189
       +
           | Some l -> l

     

       190
       190
       +
         in

     

       191
       191
       +
         { version; record_type = record; request_id; content; offset; length = content_length }

     

       192
       192
       +
       

     

       193
       193
       +
       module KV = struct

     

       194
       194
       +
         type t = (string * string) list

     

       195
       195
       +
       

     

       196
       196
       +
         let empty = []

     

       197
       197
       +
       

     

       198
       198
       +
         let add key value kvs = (key, value) :: kvs

     

       199
       199
       +
       

     

       200
       200
       +
         let remove key kvs = List.filter (fun (k, _) -> k <> key) kvs

     

       201
       201
       +
         

     

       202
       202
       +
         let cardinal kvs = List.length kvs

     

       203
       203
       +
       

     

       204
       204
       +
         let find key kvs = 

     

       205
       205
       +
           try List.assoc key kvs

     

       206
       206
       +
           with Not_found -> raise Not_found

     

       207
       207
       +
       

     

       208
       208
       +
         let find_opt key kvs = 

     

       209
       209
       +
           try Some (List.assoc key kvs)

     

       210
       210
       +
           with Not_found -> None

     

       211
       211
       +
       

     

       212
       212
       +
         let to_seq kvs = List.to_seq kvs

     

       213
       213
       +
       

     

       214
       214
       +
         let of_seq seq = List.of_seq seq

     

       215
       215
       +
       

     

       216
       216
       +
         (** Helper functions for length encoding/decoding *)

     

       217
       217
       +
         let is_long_length first_byte = first_byte land 0x80 <> 0

     

       218
       218
       +
         

     

       219
       219
       +
         let decode_short_length first_byte = first_byte

     

       220
       220
       +
         

     

       221
       221
       +
         let decode_long_length buf pos =

     

       222
       222
       +
           check_bounds buf pos 4 "reading 4-byte length";

     

       223
       223
       +
           let first_byte = Char.code buf.[pos] in

     

       224
       224
       +
           ((first_byte land 0x7f) lsl 24) lor

     

       225
       225
       +
           ((Char.code buf.[pos + 1]) lsl 16) lor

     

       226
       226
       +
           ((Char.code buf.[pos + 2]) lsl 8) lor

     

       227
       227
       +
           (Char.code buf.[pos + 3])

     

       228
       228
       +
       

     

       229
       229
       +
         let encode_length len =

     

       230
       230
       +
           if len <= 127 then

     

       231
       231
       +
             String.make 1 (Char.chr len)

     

       232
       232
       +
           else

     

       233
       233
       +
             let b = Bytes.create 4 in

     

       234
       234
       +
             Bytes.set_int32_be b 0 (Int32.logor (Int32.of_int len) 0x80000000l);

     

       235
       235
       +
             Bytes.to_string b

     

       236
       236
       +
       

     

       237
       237
       +
         let decode_length buf pos =

     

       238
       238
       +
           check_bounds buf pos 1 "reading length";

     

       239
       239
       +
           let first_byte = Char.code buf.[pos] in

     

       240
       240
       +
           if is_long_length first_byte then

     

       241
       241
       +
             (* Four byte length *)

     

       242
       242
       +
             let len = decode_long_length buf pos in

     

       243
       243
       +
             (len, pos + 4)

     

       244
       244
       +
           else

     

       245
       245
       +
             (* Single byte length *)

     

       246
       246
       +
             (decode_short_length first_byte, pos + 1)

     

       247
       247
       +
       

     

       248
       248
       +
         let encode kvs =

     

       249
       249
       +
           let buf = Buffer.create 256 in

     

       250
       250
       +
           List.iter (fun (key, value) ->

     

       251
       251
       +
             let key_len = String.length key in

     

       252
       252
       +
             let value_len = String.length value in

     

       253
       253
       +
             Buffer.add_string buf (encode_length key_len);

     

       254
       254
       +
             Buffer.add_string buf (encode_length value_len);

     

       255
       255
       +
             Buffer.add_string buf key;

     

       256
       256
       +
             Buffer.add_string buf value

     

       257
       257
       +
           ) kvs;

     

       258
       258
       +
           Buffer.contents buf

     

       259
       259
       +
       

     

       260
       260
       +
         (** Extract key-value pair from buffer at given position *)

     

       261
       261
       +
         let extract_kv_pair content pos name_len value_len =

     

       262
       262
       +
           check_bounds content pos (name_len + value_len) "reading key-value data";

     

       263
       263
       +
           let name = String.sub content pos name_len in

     

       264
       264
       +
           let value = String.sub content (pos + name_len) value_len in

     

       265
       265
       +
           (name, value)

     

       266
       266
       +
       

     

       267
       267
       +
         let decode content =

     

       268
       268
       +
           let len = String.length content in

     

       269
       269
       +
           let rec loop pos acc =

     

       270
       270
       +
             if pos >= len then

     

       271
       271
       +
               List.rev acc

     

       272
       272
       +
             else

     

       273
       273
       +
               (* Read name length *)

     

       274
       274
       +
               let name_len, pos = decode_length content pos in

     

       275
       275
       +
               (* Read value length *)

     

       276
       276
       +
               let value_len, pos = decode_length content pos in

     

       277
       277
       +
               

     

       278
       278
       +
               (* Extract name and value *)

     

       279
       279
       +
               let name, value = extract_kv_pair content pos name_len value_len in

     

       280
       280
       +
               

     

       281
       281
       +
               loop (pos + name_len + value_len) ((name, value) :: acc)

     

       282
       282
       +
           in

     

       283
       283
       +
           loop 0 []

     

       284
       284
       +
       

     

       285
       285
       +
         let read buf_read =

     

       286
       286
       +
           (* For reading from a stream, we need to determine how much data to read.

     

       287
       287
       +
              Since we're in a record context, we should read all available data

     

       288
       288
       +
              until we hit the end of the record content. *)

     

       289
       289
       +
           let content = Eio.Buf_read.take_all buf_read in

     

       290
       290
       +
           decode content

     

       291
       291
       +
       

     

       292
       292
       +
         let write buf_write kvs =

     

       293
       293
       +
           let encoded = encode kvs in

     

       294
       294
       +
           Eio.Buf_write.string buf_write encoded

     

       295
       295
       +
       

     

       296
       296
       +
         let pp ppf kvs =

     

       297
       297
       +
           Format.fprintf ppf "@[<2>[@[";

     

       298
       298
       +
           let first = ref true in

     

       299
       299
       +
           List.iter (fun (key, value) ->

     

       300
       300
       +
             if not !first then Format.fprintf ppf ";@ ";

     

       301
       301
       +
             first := false;

     

       302
       302
       +
             Format.fprintf ppf "(%S, %S)" key value

     

       303
       303
       +
           ) kvs;

     

       304
       304
       +
           Format.fprintf ppf "@]]@]"

     

       305
       305
       +
       end

+17 -9

lib/fastcgi_record.mli

···

       43
       43
        
           content and optional padding for alignment. *)

     

       44
       44
        
       type t = {

     

       45
       45
        
         version : version;           (** Protocol version (always 1) *)

     

       46
       46
       -
         record_type : record;   (** Type of this record *)

     

       46
       46
       +
         record_type : record;        (** Type of this record *)

     

       47
       47
        
         request_id : request_id;     (** Request identifier *)

     

       48
       48
        
         content : string;            (** Record content data *)

     

       49
       49
       +
         offset : int;                (** Offset within content string (default: 0) *)

     

       50
       50
       +
         length : int;                (** Length to use from content (default: String.length content) *)

     

       49
       51
        
       }

     

       50
       52
        
       

     

       51
       51
       -
       (** [pp ppf record] pretty-prints a FastCGI record *)

     

       52
       52
       -
       val pp : Format.formatter -> t -> unit

     

       53
       53
       +
       (** [pp ?max_content_len ppf record] pretty-prints a FastCGI record.

     

       54
       54
       +
           [max_content_len] limits the displayed content length (default: 100 bytes) *)

     

       55
       55
       +
       val pp : ?max_content_len:int -> Format.formatter -> t -> unit

     

       53
       56
        
       

     

       54
       57
        
       (** {1 Record Operations} *)

     

       55
       58
        
       

     
···

       62
       65
        
       (** [write buf_write record] writes a FastCGI record to the output buffer.

     

       63
       66
        
           The record header is automatically constructed from the record fields,

     

       64
       67
        
           and appropriate padding is added to align the record on 8-byte boundaries

     

       65
       65
       -
           for optimal performance. *)

     

       68
       68
       +
           for optimal performance. Uses the record's offset and length fields to

     

       69
       69
       +
           determine which portion of the content to write. *)

     

       66
       70
        
       val write : Eio.Buf_write.t -> t -> unit

     

       67
       71
        
       

     

       68
       68
       -
       (** [create ~version ~record ~request_id ~content] creates a new record

     

       69
       69
       -
           with the specified parameters. The content length is automatically

     

       70
       70
       -
           calculated from the content string. *)

     

       71
       71
       -
       val create : version:version -> record:record -> 

     

       72
       72
       -
                    request_id:request_id -> content:string -> t

     

       72
       72
       +
       (** [create ?version ~record ~request_id ~content ?offset ?length] creates a new record

     

       73
       73
       +
           with the specified parameters. Version defaults to 1 (the only supported version).

     

       74
       74
       +
           If offset and length are not provided, the entire content string is used. *)

     

       75
       75
       +
       val create : ?version:version -> record:record -> 

     

       76
       76
       +
                    request_id:request_id -> content:string -> 

     

       77
       77
       +
                    ?offset:int -> ?length:int -> unit -> t

     

       73
       78
        
       

     

       74
       79
        
       (** {1 Key-Value Pairs} *)

     

       75
       80
        
       

     
···

       102
       107
        
       

     

       103
       108
        
         (** [of_seq pairs] creates from a sequence of (key, value) tuples *)

     

       104
       109
        
         val of_seq : (string * string) Seq.t -> t

     

       110
       110
       +
         

     

       111
       111
       +
         (** [cardinal pairs] returns the number of key-value pairs *)

     

       112
       112
       +
         val cardinal : t -> int

     

       105
       113
        
       

     

       106
       114
        
         (** [read buf_read] reads key-value pairs from a buffer.

     

       107
       115
        
             Handles the FastCGI variable-length encoding where lengths ≤ 127 bytes

+279

lib/fastcgi_request.ml

···

       1
       1
       +
       open Fastcgi_record

     

       2
       2
       +
       

     

       3
       3
       +
       (** {1 Request Roles} *)

     

       4
       4
       +
       

     

       5
       5
       +
       type role =

     

       6
       6
       +
         | Responder

     

       7
       7
       +
         | Authorizer

     

       8
       8
       +
         | Filter

     

       9
       9
       +
       

     

       10
       10
       +
       let pp_role ppf = function

     

       11
       11
       +
         | Responder -> Format.pp_print_string ppf "Responder"

     

       12
       12
       +
         | Authorizer -> Format.pp_print_string ppf "Authorizer"

     

       13
       13
       +
         | Filter -> Format.pp_print_string ppf "Filter"

     

       14
       14
       +
       

     

       15
       15
       +
       let role_of_begin_request record =

     

       16
       16
       +
         if record.record_type <> Begin_request then

     

       17
       17
       +
           Error "Expected BEGIN_REQUEST record"

     

       18
       18
       +
         else if String.length record.content <> 8 then

     

       19
       19
       +
           Error "Invalid BEGIN_REQUEST content length"

     

       20
       20
       +
         else

     

       21
       21
       +
           let content = record.content in

     

       22
       22
       +
           let role_int = (Char.code content.[0] lsl 8) lor (Char.code content.[1]) in

     

       23
       23
       +
           match role_int with

     

       24
       24
       +
           | 1 -> Ok Responder

     

       25
       25
       +
           | 2 -> Ok Authorizer

     

       26
       26
       +
           | 3 -> Ok Filter

     

       27
       27
       +
           | n -> Error (Printf.sprintf "Unknown FastCGI role: %d" n)

     

       28
       28
       +
       

     

       29
       29
       +
       (** {1 Request Context} *)

     

       30
       30
       +
       

     

       31
       31
       +
       type t = {

     

       32
       32
       +
         request_id : request_id;

     

       33
       33
       +
         role : role;

     

       34
       34
       +
         keep_conn : bool;

     

       35
       35
       +
         params : KV.t;

     

       36
       36
       +
         stdin_data : string;

     

       37
       37
       +
         data_stream : string option;

     

       38
       38
       +
       }

     

       39
       39
       +
       

     

       40
       40
       +
       let pp ppf request =

     

       41
       41
       +
         let data_str = match request.data_stream with

     

       42
       42
       +
           | None -> "None"

     

       43
       43
       +
           | Some d -> Printf.sprintf "Some(%d bytes)" (String.length d)

     

       44
       44
       +
         in

     

       45
       45
       +
         Format.fprintf ppf

     

       46
       46
       +
           "@[<2>{ request_id = %d;@ role = %a;@ keep_conn = %b;@ params = %a;@ stdin = %d bytes;@ data = %s }@]"

     

       47
       47
       +
           request.request_id

     

       48
       48
       +
           pp_role request.role

     

       49
       49
       +
           request.keep_conn

     

       50
       50
       +
           (KV.pp) request.params

     

       51
       51
       +
           (String.length request.stdin_data)

     

       52
       52
       +
           data_str

     

       53
       53
       +
       

     

       54
       54
       +
       let create record =

     

       55
       55
       +
         match role_of_begin_request record with

     

       56
       56
       +
         | Error _ as e -> e

     

       57
       57
       +
         | Ok role ->

     

       58
       58
       +
             if String.length record.content <> 8 then

     

       59
       59
       +
               Error "Invalid BEGIN_REQUEST content length"

     

       60
       60
       +
             else

     

       61
       61
       +
               let flags_int = Char.code record.content.[2] in

     

       62
       62
       +
               let keep_conn = (flags_int land 1) <> 0 in

     

       63
       63
       +
               Ok {

     

       64
       64
       +
                 request_id = record.request_id;

     

       65
       65
       +
                 role;

     

       66
       66
       +
                 keep_conn;

     

       67
       67
       +
                 params = KV.empty;

     

       68
       68
       +
                 stdin_data = "";

     

       69
       69
       +
                 data_stream = if role = Filter then Some "" else None;

     

       70
       70
       +
               }

     

       71
       71
       +
       

     

       72
       72
       +
       

     

       73
       73
       +
       (** {1 Stream Processing} *)

     

       74
       74
       +
       

     

       75
       75
       +
       (** Helper functions for result binding to simplify nested pattern matching *)

     

       76
       76
       +
       let ( let* ) = Result.bind

     

       77
       77
       +
       

     

       78
       78
       +
       let is_stream_terminator record =

     

       79
       79
       +
         String.length record.content = 0

     

       80
       80
       +
       

     

       81
       81
       +
       

     

       82
       82
       +
       let read_params buf_read =

     

       83
       83
       +
         Printf.eprintf "[DEBUG] read_params_from_flow: Starting\n%!";

     

       84
       84
       +
         let params = ref KV.empty in

     

       85
       85
       +
         let rec loop () =

     

       86
       86
       +
           try

     

       87
       87
       +
             Printf.eprintf "[DEBUG] read_params_from_flow: Reading next PARAMS record\n%!";

     

       88
       88
       +
             let record = Fastcgi_record.read buf_read in

     

       89
       89
       +
             Printf.eprintf "[DEBUG] read_params_from_flow: Got record type=%s, content_length=%d\n%!"

     

       90
       90
       +
               (Format.asprintf "%a" pp_record record.record_type)

     

       91
       91
       +
               (String.length record.content);

     

       92
       92
       +
             if record.record_type <> Params then

     

       93
       93
       +
               Error (Printf.sprintf "Expected PARAMS record, got %s"

     

       94
       94
       +
                             (Format.asprintf "%a" pp_record record.record_type))

     

       95
       95
       +
             else if is_stream_terminator record then (

     

       96
       96
       +
               Printf.eprintf "[DEBUG] read_params_from_flow: Got stream terminator, returning %d params\n%!"

     

       97
       97
       +
                 (Fastcgi_record.KV.cardinal !params);

     

       98
       98
       +
               Ok !params

     

       99
       99
       +
             ) else (

     

       100
       100
       +
               let record_params = KV.decode record.content in

     

       101
       101
       +
               Printf.eprintf "[DEBUG] read_params_from_flow: Decoded %d params from record\n%!"

     

       102
       102
       +
                 (Fastcgi_record.KV.cardinal record_params);

     

       103
       103
       +
               params := KV.to_seq record_params

     

       104
       104
       +
                         |> Seq.fold_left (fun acc (k, v) -> KV.add k v acc) !params;

     

       105
       105
       +
               loop ()

     

       106
       106
       +
             )

     

       107
       107
       +
           with

     

       108
       108
       +
           | End_of_file -> 

     

       109
       109
       +
               Printf.eprintf "[DEBUG] read_params_from_flow: Hit End_of_file\n%!";

     

       110
       110
       +
               Error "Unexpected end of stream while reading PARAMS"

     

       111
       111
       +
           | exn -> 

     

       112
       112
       +
               Printf.eprintf "[DEBUG] read_params_from_flow: Exception: %s\n%!" (Printexc.to_string exn);

     

       113
       113
       +
               Error (Printf.sprintf "Error reading PARAMS: %s" (Printexc.to_string exn))

     

       114
       114
       +
         in

     

       115
       115
       +
         loop ()

     

       116
       116
       +
       

     

       117
       117
       +
       let read_stdin buf_read =

     

       118
       118
       +
         Printf.eprintf "[DEBUG] read_stdin_from_flow: Starting\n%!";

     

       119
       119
       +
         let data = Buffer.create 1024 in

     

       120
       120
       +
         let rec loop () =

     

       121
       121
       +
           try

     

       122
       122
       +
             Printf.eprintf "[DEBUG] read_stdin_from_flow: Reading next STDIN record\n%!";

     

       123
       123
       +
             let record = Fastcgi_record.read buf_read in

     

       124
       124
       +
             Printf.eprintf "[DEBUG] read_stdin_from_flow: Got record type=%s, content_length=%d\n%!"

     

       125
       125
       +
               (Format.asprintf "%a" pp_record record.record_type)

     

       126
       126
       +
               (String.length record.content);

     

       127
       127
       +
             if record.record_type <> Stdin then

     

       128
       128
       +
               Error (Printf.sprintf "Expected STDIN record, got %s"

     

       129
       129
       +
                             (Format.asprintf "%a" pp_record record.record_type))

     

       130
       130
       +
             else if is_stream_terminator record then (

     

       131
       131
       +
               Printf.eprintf "[DEBUG] read_stdin_from_flow: Got stream terminator, total stdin=%d bytes\n%!"

     

       132
       132
       +
                 (Buffer.length data);

     

       133
       133
       +
               Ok (Buffer.contents data)

     

       134
       134
       +
             ) else (

     

       135
       135
       +
               Buffer.add_string data record.content;

     

       136
       136
       +
               Printf.eprintf "[DEBUG] read_stdin_from_flow: Added %d bytes, total now %d\n%!"

     

       137
       137
       +
                 (String.length record.content) (Buffer.length data);

     

       138
       138
       +
               loop ()

     

       139
       139
       +
             )

     

       140
       140
       +
           with

     

       141
       141
       +
           | End_of_file -> 

     

       142
       142
       +
               Printf.eprintf "[DEBUG] read_stdin_from_flow: Hit End_of_file\n%!";

     

       143
       143
       +
               Error "Unexpected end of stream while reading STDIN"

     

       144
       144
       +
           | exn -> 

     

       145
       145
       +
               Printf.eprintf "[DEBUG] read_stdin_from_flow: Exception: %s\n%!" (Printexc.to_string exn);

     

       146
       146
       +
               Error (Printf.sprintf "Error reading STDIN: %s" (Printexc.to_string exn))

     

       147
       147
       +
         in

     

       148
       148
       +
         loop ()

     

       149
       149
       +
       

     

       150
       150
       +
       (** Read DATA stream for Filter role *)

     

       151
       151
       +
       let read_data buf_read =

     

       152
       152
       +
         let data_buf = Buffer.create 1024 in

     

       153
       153
       +
         let rec read_data () =

     

       154
       154
       +
           try

     

       155
       155
       +
             let record = Fastcgi_record.read buf_read in

     

       156
       156
       +
             if record.record_type <> Data then

     

       157
       157
       +
               Error "Expected DATA record"

     

       158
       158
       +
             else if is_stream_terminator record then

     

       159
       159
       +
               Ok (Buffer.contents data_buf)

     

       160
       160
       +
             else (

     

       161
       161
       +
               Buffer.add_string data_buf record.content;

     

       162
       162
       +
               read_data ()

     

       163
       163
       +
             )

     

       164
       164
       +
           with

     

       165
       165
       +
           | End_of_file -> Error "Unexpected end of DATA stream"

     

       166
       166
       +
           | exn -> Error (Printf.sprintf "Error reading DATA: %s" (Printexc.to_string exn))

     

       167
       167
       +
         in

     

       168
       168
       +
         read_data ()

     

       169
       169
       +
       

     

       170
       170
       +
       (** Read request streams based on role *)

     

       171
       171
       +
       let read_request_streams request buf_read =

     

       172
       172
       +
         Printf.eprintf "[DEBUG] read_request_streams: Processing role=%s\n%!" 

     

       173
       173
       +
           (Format.asprintf "%a" pp_role request.role);

     

       174
       174
       +
         match request.role with

     

       175
       175
       +
         | Authorizer -> 

     

       176
       176
       +
             Printf.eprintf "[DEBUG] read_request_streams: Authorizer role, no streams to read\n%!";

     

       177
       177
       +
             Ok request

     

       178
       178
       +
         | Responder ->

     

       179
       179
       +
             Printf.eprintf "[DEBUG] read_request_streams: Responder role, reading STDIN\n%!";

     

       180
       180
       +
             let* stdin_data = read_stdin buf_read in

     

       181
       181
       +
             Printf.eprintf "[DEBUG] read_request_streams: Got STDIN data, %d bytes\n%!" (String.length stdin_data);

     

       182
       182
       +
             Ok { request with stdin_data }

     

       183
       183
       +
         | Filter ->

     

       184
       184
       +
             Printf.eprintf "[DEBUG] read_request_streams: Filter role, reading STDIN and DATA\n%!";

     

       185
       185
       +
             let* stdin_data = read_stdin buf_read in

     

       186
       186
       +
             Printf.eprintf "[DEBUG] read_request_streams: Got STDIN data, %d bytes\n%!" (String.length stdin_data);

     

       187
       187
       +
             let request = { request with stdin_data } in

     

       188
       188
       +
             let* data = read_data buf_read in

     

       189
       189
       +
             Printf.eprintf "[DEBUG] read_request_streams: Got DATA stream, %d bytes\n%!" (String.length data);

     

       190
       190
       +
             Ok { request with data_stream = Some data }

     

       191
       191
       +
       

     

       192
       192
       +
       let read_request buf_read =

     

       193
       193
       +
         Printf.eprintf "[DEBUG] read_request: Starting\n%!";

     

       194
       194
       +
         try

     

       195
       195
       +
           (* Read BEGIN_REQUEST *)

     

       196
       196
       +
           Printf.eprintf "[DEBUG] read_request: Reading BEGIN_REQUEST record\n%!";

     

       197
       197
       +
           let begin_record = Fastcgi_record.read buf_read in

     

       198
       198
       +
           Printf.eprintf "[DEBUG] read_request: Got BEGIN_REQUEST record: %s\n%!"

     

       199
       199
       +
             (Format.asprintf "%a" (Fastcgi_record.pp ~max_content_len:50) begin_record);

     

       200
       200
       +
           let* request = create begin_record in

     

       201
       201
       +
           Printf.eprintf "[DEBUG] read_request: Created request with role=%s, id=%d\n%!"

     

       202
       202
       +
             (Format.asprintf "%a" pp_role request.role) request.request_id;

     

       203
       203
       +
           (* Read PARAMS stream *)

     

       204
       204
       +
           Printf.eprintf "[DEBUG] read_request: Reading PARAMS stream\n%!";

     

       205
       205
       +
           let* params = read_params buf_read in

     

       206
       206
       +
           Printf.eprintf "[DEBUG] read_request: Got %d params\n%!" (Fastcgi_record.KV.cardinal params);

     

       207
       207
       +
           let request = { request with params } in

     

       208
       208
       +
           (* Read remaining streams based on role *)

     

       209
       209
       +
           Printf.eprintf "[DEBUG] read_request: Reading streams for role=%s\n%!"

     

       210
       210
       +
             (Format.asprintf "%a" pp_role request.role);

     

       211
       211
       +
           let result = read_request_streams request buf_read in

     

       212
       212
       +
           Printf.eprintf "[DEBUG] read_request: Finished reading request\n%!";

     

       213
       213
       +
           result

     

       214
       214
       +
         with

     

       215
       215
       +
         | End_of_file -> 

     

       216
       216
       +
             Printf.eprintf "[DEBUG] read_request: Hit End_of_file\n%!";

     

       217
       217
       +
             Error "Unexpected end of stream"

     

       218
       218
       +
         | exn -> 

     

       219
       219
       +
             Printf.eprintf "[DEBUG] read_request: Exception: %s\n%!" (Printexc.to_string exn);

     

       220
       220
       +
             Error (Printf.sprintf "Error reading request: %s" (Printexc.to_string exn))

     

       221
       221
       +
       

     

       222
       222
       +
       (** {1 Response Generation} *)

     

       223
       223
       +
       

     

       224
       224
       +
       type app_status = int

     

       225
       225
       +
       type protocol_status = 

     

       226
       226
       +
         | Request_complete

     

       227
       227
       +
         | Cant_mpx_conn  

     

       228
       228
       +
         | Overloaded

     

       229
       229
       +
         | Unknown_role

     

       230
       230
       +
       

     

       231
       231
       +
       let pp_protocol_status ppf = function

     

       232
       232
       +
         | Request_complete -> Format.pp_print_string ppf "Request_complete"

     

       233
       233
       +
         | Cant_mpx_conn -> Format.pp_print_string ppf "Cant_mpx_conn"

     

       234
       234
       +
         | Overloaded -> Format.pp_print_string ppf "Overloaded"

     

       235
       235
       +
         | Unknown_role -> Format.pp_print_string ppf "Unknown_role"

     

       236
       236
       +
       

     

       237
       237
       +
       let protocol_status_to_int = function

     

       238
       238
       +
         | Request_complete -> 0

     

       239
       239
       +
         | Cant_mpx_conn -> 1

     

       240
       240
       +
         | Overloaded -> 2

     

       241
       241
       +
         | Unknown_role -> 3

     

       242
       242
       +
       

     

       243
       243
       +
       let write_stream_records buf_write request_id record_type content =

     

       244
       244
       +
         let max_chunk = 65535 in (* FastCGI max record content length *)

     

       245
       245
       +
         let len = String.length content in

     

       246
       246
       +
         let rec chunk_string pos =

     

       247
       247
       +
           if pos < len then begin

     

       248
       248
       +
             let chunk_len = min max_chunk (len - pos) in

     

       249
       249
       +
             let record = Fastcgi_record.create ~record:record_type ~request_id ~content ~offset:pos ~length:chunk_len () in

     

       250
       250
       +
             Fastcgi_record.write buf_write record;

     

       251
       251
       +
             chunk_string (pos + chunk_len)

     

       252
       252
       +
           end

     

       253
       253
       +
         in

     

       254
       254
       +
         chunk_string 0;

     

       255
       255
       +
         let terminator = Fastcgi_record.create ~record:record_type ~request_id ~content:"" () in

     

       256
       256
       +
         Fastcgi_record.write buf_write terminator

     

       257
       257
       +
       

     

       258
       258
       +
       let write_stdout_records buf_write request_id content =

     

       259
       259
       +
         Printf.eprintf "[DEBUG] write_stdout_records: Writing %d bytes for request_id=%d\n%!" 

     

       260
       260
       +
           (String.length content) request_id;

     

       261
       261
       +
         write_stream_records buf_write request_id Stdout content

     

       262
       262
       +
       

     

       263
       263
       +
       let write_stderr_records buf_write request_id content =

     

       264
       264
       +
         Printf.eprintf "[DEBUG] write_stderr_records: Writing %d bytes for request_id=%d\n%!" 

     

       265
       265
       +
           (String.length content) request_id;

     

       266
       266
       +
         write_stream_records buf_write request_id Stderr content

     

       267
       267
       +
       

     

       268
       268
       +
       let write_end_request buf_write request_id app_status protocol_status =

     

       269
       269
       +
         let content = 

     

       270
       270
       +
           let buf = Bytes.create 8 in

     

       271
       271
       +
           Bytes.set_int32_be buf 0 (Int32.of_int app_status);

     

       272
       272
       +
           Bytes.set_uint8 buf 4 (protocol_status_to_int protocol_status);

     

       273
       273
       +
           Bytes.set_uint8 buf 5 0; (* reserved *)

     

       274
       274
       +
           Bytes.set_uint8 buf 6 0; (* reserved *)

     

       275
       275
       +
           Bytes.set_uint8 buf 7 0; (* reserved *)

     

       276
       276
       +
           Bytes.to_string buf

     

       277
       277
       +
         in

     

       278
       278
       +
         let record = Fastcgi_record.create ~record:End_request ~request_id ~content () in

     

       279
       279
       +
         Fastcgi_record.write buf_write record

+80

lib/fastcgi_request.mli

···

       1
       1
       +
       (** FastCGI request handling with functional state management and Eio flows.

     

       2
       2
       +
       

     

       3
       3
       +
           This module provides a functional approach to FastCGI request processing,

     

       4
       4
       +
           using immutable data structures and higher-order functions. Input and output

     

       5
       5
       +
           are handled through Eio flows for efficient streaming I/O. *)

     

       6
       6
       +
       

     

       7
       7
       +
       (** {1 Request Roles} *)

     

       8
       8
       +
       

     

       9
       9
       +
       (** FastCGI application roles defining request processing behavior *)

     

       10
       10
       +
       type role =

     

       11
       11
       +
         | Responder   (** Standard CGI-like request/response processing *)

     

       12
       12
       +
         | Authorizer  (** Authorization decision with optional variables *)

     

       13
       13
       +
         | Filter      (** Content filtering with additional data stream *)

     

       14
       14
       +
       

     

       15
       15
       +
       (** [pp_role ppf role] pretty-prints a FastCGI role *)

     

       16
       16
       +
       val pp_role : Format.formatter -> role -> unit

     

       17
       17
       +
       

     

       18
       18
       +
       (** [role_of_begin_request record] extracts role from BEGIN_REQUEST record *)

     

       19
       19
       +
       val role_of_begin_request : Fastcgi_record.t -> (role, string) result

     

       20
       20
       +
       

     

       21
       21
       +
       (** {1 Request Context} *)

     

       22
       22
       +
       

     

       23
       23
       +
       (** Immutable request context containing all request data *)

     

       24
       24
       +
       type t = private {

     

       25
       25
       +
         request_id : Fastcgi_record.request_id;  (** Request identifier *)

     

       26
       26
       +
         role : role;                             (** Application role *)

     

       27
       27
       +
         keep_conn : bool;                        (** Connection keep-alive flag *)

     

       28
       28
       +
         params : Fastcgi_record.KV.t;            (** Environment parameters *)

     

       29
       29
       +
         stdin_data : string;                     (** Complete STDIN content *)

     

       30
       30
       +
         data_stream : string option;             (** DATA stream for Filter role *)

     

       31
       31
       +
       }

     

       32
       32
       +
       

     

       33
       33
       +
       (** [pp ppf request] pretty-prints a request context *)

     

       34
       34
       +
       val pp : Format.formatter -> t -> unit

     

       35
       35
       +
       

     

       36
       36
       +
       (** [create record] creates request context from BEGIN_REQUEST record *)

     

       37
       37
       +
       val create : Fastcgi_record.t -> (t, string) result

     

       38
       38
       +
       

     

       39
       39
       +
       (** {1 Stream Processing} *)

     

       40
       40
       +
       

     

       41
       41
       +
       (** [read_params buf_read] reads PARAMS stream from buf_read until empty record.

     

       42
       42
       +
           Returns the accumulated parameters. *)

     

       43
       43
       +
       val read_params : Eio.Buf_read.t -> (Fastcgi_record.KV.t, string) result

     

       44
       44
       +
       

     

       45
       45
       +
       (** [read_stdin buf_read] reads STDIN stream from buf_read until empty record.

     

       46
       46
       +
           Returns the accumulated data. *)

     

       47
       47
       +
       val read_stdin : Eio.Buf_read.t -> (string, string) result

     

       48
       48
       +
       

     

       49
       49
       +
       (** [read_data buf_read] reads DATA stream from buf_read until empty record.

     

       50
       50
       +
           Returns the accumulated data for Filter role. *)

     

       51
       51
       +
       val read_data : Eio.Buf_read.t -> (string, string) result

     

       52
       52
       +
       

     

       53
       53
       +
       (** [read_request buf_read] reads a complete FastCGI request from buf_read.

     

       54
       54
       +
           Processes BEGIN_REQUEST, PARAMS, STDIN, and DATA records until complete.

     

       55
       55
       +
           Returns the populated request context. *)

     

       56
       56
       +
       val read_request : Eio.Buf_read.t -> (t, string) result

     

       57
       57
       +
       

     

       58
       58
       +
       (** {1 Response Generation} *)

     

       59
       59
       +
       

     

       60
       60
       +
       (** Response status codes *)

     

       61
       61
       +
       type app_status = int

     

       62
       62
       +
       type protocol_status = 

     

       63
       63
       +
         | Request_complete

     

       64
       64
       +
         | Cant_mpx_conn  

     

       65
       65
       +
         | Overloaded

     

       66
       66
       +
         | Unknown_role

     

       67
       67
       +
       

     

       68
       68
       +
       (** [pp_protocol_status ppf status] pretty-prints protocol status *)

     

       69
       69
       +
       val pp_protocol_status : Format.formatter -> protocol_status -> unit

     

       70
       70
       +
       

     

       71
       71
       +
       (** [write_stdout_records buf_write request_id content] writes STDOUT stream records.

     

       72
       72
       +
           Splits content into chunks and writes with terminator. *)

     

       73
       73
       +
       val write_stdout_records : Eio.Buf_write.t -> Fastcgi_record.request_id -> string -> unit

     

       74
       74
       +
       

     

       75
       75
       +
       (** [write_stderr_records buf_write request_id content] writes STDERR stream records.

     

       76
       76
       +
           Splits content into chunks and writes with terminator. *)

     

       77
       77
       +
       val write_stderr_records : Eio.Buf_write.t -> Fastcgi_record.request_id -> string -> unit

     

       78
       78
       +
       

     

       79
       79
       +
       (** [write_end_request buf_write request_id app_status protocol_status] writes END_REQUEST record. *)

     

       80
       80
       +
       val write_end_request : Eio.Buf_write.t -> Fastcgi_record.request_id -> app_status -> protocol_status -> unit

+13

test/dune

···

       1
       1
       +
       (test

     

       2
       2
       +
        (name simple_test)

     

       3
       3
       +
        (modules simple_test)

     

       4
       4
       +
        (libraries fastcgi eio eio_main)

     

       5
       5
       +
        (deps (source_tree test_cases))

     

       6
       6
       +
       )

     

       7
       7
       +
       

     

       8
       8
       +
       (test

     

       9
       9
       +
        (name validate_all_test_cases)

     

       10
       10
       +
        (modules validate_all_test_cases)

     

       11
       11
       +
        (libraries fastcgi eio eio_main)

     

       12
       12
       +
        (deps (source_tree test_cases))

     

       13
       13
       +
       )

+161

test/simple_test.ml

···

       1
       1
       +
       open Fastcgi

     

       2
       2
       +
       

     

       3
       3
       +
       let hex_dump ?(max_bytes=256) content =

     

       4
       4
       +
         let len = String.length content in

     

       5
       5
       +
         let display_len = min len max_bytes in

     

       6
       6
       +
         let bytes_per_line = 16 in

     

       7
       7
       +
         let lines_to_show = (display_len - 1) / bytes_per_line + 1 in

     

       8
       8
       +
         

     

       9
       9
       +
         for i = 0 to lines_to_show - 1 do

     

       10
       10
       +
           let start = i * bytes_per_line in

     

       11
       11
       +
           let end_ = min (start + bytes_per_line) display_len in

     

       12
       12
       +
           Printf.printf "  %04x: " start;

     

       13
       13
       +
           

     

       14
       14
       +
           (* Print hex bytes *)

     

       15
       15
       +
           for j = start to end_ - 1 do

     

       16
       16
       +
             Printf.printf "%02x " (Char.code content.[j]);

     

       17
       17
       +
             if j = start + 7 then Printf.printf " "

     

       18
       18
       +
           done;

     

       19
       19
       +
           

     

       20
       20
       +
           (* Pad remaining space *)

     

       21
       21
       +
           for _ = end_ to start + bytes_per_line - 1 do

     

       22
       22
       +
             Printf.printf "   ";

     

       23
       23
       +
             if end_ <= start + 7 then Printf.printf " "

     

       24
       24
       +
           done;

     

       25
       25
       +
           

     

       26
       26
       +
           Printf.printf " |";

     

       27
       27
       +
           

     

       28
       28
       +
           (* Print ASCII representation *)

     

       29
       29
       +
           for j = start to end_ - 1 do

     

       30
       30
       +
             let c = content.[j] in

     

       31
       31
       +
             if c >= ' ' && c <= '~' then

     

       32
       32
       +
               Printf.printf "%c" c

     

       33
       33
       +
             else

     

       34
       34
       +
               Printf.printf "."

     

       35
       35
       +
           done;

     

       36
       36
       +
           

     

       37
       37
       +
           Printf.printf "|\n%!"

     

       38
       38
       +
         done;

     

       39
       39
       +
         

     

       40
       40
       +
         if len > max_bytes then

     

       41
       41
       +
           Printf.printf "  ... (%d more bytes truncated)\n%!" (len - max_bytes)

     

       42
       42
       +
       

     

       43
       43
       +
       

     

       44
       44
       +
       let test_record_types () =

     

       45
       45
       +
         Printf.printf "Testing record type conversions...\n%!";

     

       46
       46
       +
         

     

       47
       47
       +
         let test_type rt expected_int =

     

       48
       48
       +
           assert (Record.record_to_int rt = expected_int);

     

       49
       49
       +
           assert (Record.record_of_int expected_int = rt)

     

       50
       50
       +
         in

     

       51
       51
       +
         

     

       52
       52
       +
         test_type Begin_request 1;

     

       53
       53
       +
         test_type Abort_request 2;

     

       54
       54
       +
         test_type End_request 3;

     

       55
       55
       +
         test_type Params 4;

     

       56
       56
       +
         test_type Stdin 5;

     

       57
       57
       +
         test_type Stdout 6;

     

       58
       58
       +
         test_type Stderr 7;

     

       59
       59
       +
         test_type Data 8;

     

       60
       60
       +
         test_type Get_values 9;

     

       61
       61
       +
         test_type Get_values_result 10;

     

       62
       62
       +
         test_type Unknown_type 11;

     

       63
       63
       +
         

     

       64
       64
       +
         (* Test invalid record type *)

     

       65
       65
       +
         (try

     

       66
       66
       +
            let _ = Record.record_of_int 99 in

     

       67
       67
       +
            assert false (* Should not reach here *)

     

       68
       68
       +
          with Invalid_argument _ -> ());

     

       69
       69
       +
         

     

       70
       70
       +
         Printf.printf "✓ Record type conversion test passed\n%!"

     

       71
       71
       +
       

     

       72
       72
       +
       let test_kv_encoding () =

     

       73
       73
       +
         Printf.printf "Testing key-value encoding...\n%!";

     

       74
       74
       +
         

     

       75
       75
       +
         let kv = Record.KV.empty

     

       76
       76
       +
           |> Record.KV.add "REQUEST_METHOD" "GET"

     

       77
       77
       +
           |> Record.KV.add "SERVER_NAME" "localhost"

     

       78
       78
       +
           |> Record.KV.add "SERVER_PORT" "80"

     

       79
       79
       +
         in

     

       80
       80
       +
         

     

       81
       81
       +
         let encoded = Record.KV.encode kv in

     

       82
       82
       +
         let decoded = Record.KV.decode encoded in

     

       83
       83
       +
         

     

       84
       84
       +
         (* Check that all original pairs are present *)

     

       85
       85
       +
         assert (Record.KV.find "REQUEST_METHOD" decoded = "GET");

     

       86
       86
       +
         assert (Record.KV.find "SERVER_NAME" decoded = "localhost");

     

       87
       87
       +
         assert (Record.KV.find "SERVER_PORT" decoded = "80");

     

       88
       88
       +
         

     

       89
       89
       +
         Printf.printf "✓ Key-value encoding test passed\n%!"

     

       90
       90
       +
       

     

       91
       91
       +
       let test_long_key_value () =

     

       92
       92
       +
         Printf.printf "Testing long key-value encoding...\n%!";

     

       93
       93
       +
         

     

       94
       94
       +
         (* Create a long key and value to test 4-byte length encoding *)

     

       95
       95
       +
         let long_key = String.make 200 'k' in

     

       96
       96
       +
         let long_value = String.make 300 'v' in

     

       97
       97
       +
         

     

       98
       98
       +
         let kv = Record.KV.empty

     

       99
       99
       +
           |> Record.KV.add long_key long_value

     

       100
       100
       +
           |> Record.KV.add "short" "val"

     

       101
       101
       +
         in

     

       102
       102
       +
         

     

       103
       103
       +
         let encoded = Record.KV.encode kv in

     

       104
       104
       +
         let decoded = Record.KV.decode encoded in

     

       105
       105
       +
         

     

       106
       106
       +
         assert (Record.KV.find long_key decoded = long_value);

     

       107
       107
       +
         assert (Record.KV.find "short" decoded = "val");

     

       108
       108
       +
         

     

       109
       109
       +
         Printf.printf "✓ Long key-value encoding test passed\n%!"

     

       110
       110
       +
       

     

       111
       111
       +
       let test_with_binary_test_case ~fs filename expected_type expected_request_id =

     

       112
       112
       +
         Printf.printf "Testing with binary test case: %s...\n%!" filename;

     

       113
       113
       +
         

     

       114
       114
       +
         let (raw_content, parsed) = 

     

       115
       115
       +
           Eio.Path.with_open_in (fs, "test_cases/" ^ filename) @@ fun flow ->

     

       116
       116
       +
           let buf = Buffer.create 1024 in

     

       117
       117
       +
           Eio.Flow.copy flow (Eio.Flow.buffer_sink buf);

     

       118
       118
       +
           let raw_content = Buffer.contents buf in

     

       119
       119
       +
           let buf_read = Eio.Buf_read.of_string raw_content in

     

       120
       120
       +
           let parsed = Record.read buf_read in

     

       121
       121
       +
           (raw_content, parsed)

     

       122
       122
       +
         in

     

       123
       123
       +
         

     

       124
       124
       +
         Printf.printf "\nRaw file contents (%d bytes):\n" (String.length raw_content);

     

       125
       125
       +
         hex_dump raw_content;

     

       126
       126
       +
         

     

       127
       127
       +
         Printf.printf "\nParsed record:\n";

     

       128
       128
       +
         Format.printf "%a\n" (fun ppf -> Record.pp ppf) parsed;

     

       129
       129
       +
         

     

       130
       130
       +
         (* If this is a Params record, also show the decoded key-value pairs *)

     

       131
       131
       +
         if parsed.record_type = Params && String.length parsed.content > 0 then (

     

       132
       132
       +
           let params = Record.KV.decode parsed.content in

     

       133
       133
       +
           Printf.printf "\nDecoded parameters:\n";

     

       134
       134
       +
           Format.printf "%a\n" Record.KV.pp params

     

       135
       135
       +
         );

     

       136
       136
       +
         

     

       137
       137
       +
         assert (parsed.version = 1);

     

       138
       138
       +
         assert (parsed.record_type = expected_type);

     

       139
       139
       +
         assert (parsed.request_id = expected_request_id);

     

       140
       140
       +
         

     

       141
       141
       +
         Printf.printf "✓ Binary test case %s passed\n%!" filename

     

       142
       142
       +
       

     

       143
       143
       +
       let run_tests ~fs =

     

       144
       144
       +
         Printf.printf "Running FastCGI Record tests...\n\n%!";

     

       145
       145
       +
         

     

       146
       146
       +
         test_record_types ();

     

       147
       147
       +
         test_kv_encoding ();

     

       148
       148
       +
         test_long_key_value ();

     

       149
       149
       +
         

     

       150
       150
       +
         (* Test with some of our binary test cases *)

     

       151
       151
       +
         test_with_binary_test_case ~fs "begin_request_responder.bin" Begin_request 1;

     

       152
       152
       +
         test_with_binary_test_case ~fs "params_empty.bin" Params 1;

     

       153
       153
       +
         test_with_binary_test_case ~fs "end_request_success.bin" End_request 1;

     

       154
       154
       +
         test_with_binary_test_case ~fs "get_values.bin" Get_values 0;

     

       155
       155
       +
         test_with_binary_test_case ~fs "abort_request.bin" Abort_request 1;

     

       156
       156
       +
         

     

       157
       157
       +
         Printf.printf "\n✅ All FastCGI Record tests passed!\n%!"

     

       158
       158
       +
       

     

       159
       159
       +
       let () = Eio_main.run @@ fun env ->

     

       160
       160
       +
         let fs = Eio.Stdenv.cwd env in

     

       161
       161
       +
         run_tests ~fs:(fst fs)

+123

test/test_cases/README.md

···

       1
       1
       +
       # FastCGI Test Cases

     

       2
       2
       +
       

     

       3
       3
       +
       This directory contains binary test case files representing various FastCGI records as defined in the FastCGI specification. These files can be used to test a FastCGI parser implementation.

     

       4
       4
       +
       

     

       5
       5
       +
       ## Test Case Files

     

       6
       6
       +
       

     

       7
       7
       +
       ### Management Records (requestId = 0)

     

       8
       8
       +
       

     

       9
       9
       +
       - **`get_values.bin`** - FCGI_GET_VALUES record requesting capability information

     

       10
       10
       +
       - **`get_values_result.bin`** - FCGI_GET_VALUES_RESULT record with capability responses

     

       11
       11
       +
       - **`unknown_type.bin`** - FCGI_UNKNOWN_TYPE record for unrecognized record types

     

       12
       12
       +
       

     

       13
       13
       +
       ### Application Records (requestId > 0)

     

       14
       14
       +
       

     

       15
       15
       +
       #### BEGIN_REQUEST Records

     

       16
       16
       +
       - **`begin_request_responder.bin`** - Begin request for Responder role with KEEP_CONN flag

     

       17
       17
       +
       - **`begin_request_no_keep.bin`** - Begin request for Responder role without KEEP_CONN flag

     

       18
       18
       +
       - **`begin_request_authorizer.bin`** - Begin request for Authorizer role

     

       19
       19
       +
       - **`begin_request_filter.bin`** - Begin request for Filter role

     

       20
       20
       +
       

     

       21
       21
       +
       #### Stream Records

     

       22
       22
       +
       - **`params_get.bin`** - FCGI_PARAMS record with GET request environment variables

     

       23
       23
       +
       - **`params_post.bin`** - FCGI_PARAMS record with POST request environment variables

     

       24
       24
       +
       - **`params_empty.bin`** - Empty FCGI_PARAMS record (end of params stream)

     

       25
       25
       +
       - **`stdin_form_data.bin`** - FCGI_STDIN record with form data

     

       26
       26
       +
       - **`stdin_empty.bin`** - Empty FCGI_STDIN record (end of stdin stream)

     

       27
       27
       +
       - **`stdout_response.bin`** - FCGI_STDOUT record with HTTP response

     

       28
       28
       +
       - **`stdout_empty.bin`** - Empty FCGI_STDOUT record (end of stdout stream)

     

       29
       29
       +
       - **`stderr_message.bin`** - FCGI_STDERR record with error message

     

       30
       30
       +
       - **`stderr_empty.bin`** - Empty FCGI_STDERR record (end of stderr stream)

     

       31
       31
       +
       - **`data_filter.bin`** - FCGI_DATA record with file content (for Filter role)

     

       32
       32
       +
       - **`data_empty.bin`** - Empty FCGI_DATA record (end of data stream)

     

       33
       33
       +
       

     

       34
       34
       +
       #### Control Records

     

       35
       35
       +
       - **`end_request_success.bin`** - FCGI_END_REQUEST record with successful completion

     

       36
       36
       +
       - **`end_request_error.bin`** - FCGI_END_REQUEST record with error status

     

       37
       37
       +
       - **`abort_request.bin`** - FCGI_ABORT_REQUEST record

     

       38
       38
       +
       

     

       39
       39
       +
       ### Complex Scenarios

     

       40
       40
       +
       - **`multiplexed_requests.bin`** - Multiple concurrent requests on same connection

     

       41
       41
       +
       - **`large_record.bin`** - Record with maximum content size (65KB)

     

       42
       42
       +
       - **`padded_record.bin`** - Record with padding for 8-byte alignment

     

       43
       43
       +
       

     

       44
       44
       +
       ## Record Format

     

       45
       45
       +
       

     

       46
       46
       +
       All records follow the FastCGI record format:

     

       47
       47
       +
       

     

       48
       48
       +
       ```

     

       49
       49
       +
       typedef struct {

     

       50
       50
       +
           unsigned char version;           // FCGI_VERSION_1 (1)

     

       51
       51
       +
           unsigned char type;              // Record type (1-11)

     

       52
       52
       +
           unsigned char requestIdB1;       // Request ID high byte

     

       53
       53
       +
           unsigned char requestIdB0;       // Request ID low byte

     

       54
       54
       +
           unsigned char contentLengthB1;   // Content length high byte

     

       55
       55
       +
           unsigned char contentLengthB0;   // Content length low byte

     

       56
       56
       +
           unsigned char paddingLength;     // Padding length

     

       57
       57
       +
           unsigned char reserved;          // Reserved (always 0)

     

       58
       58
       +
           // contentData[contentLength]

     

       59
       59
       +
           // paddingData[paddingLength]

     

       60
       60
       +
       } FCGI_Record;

     

       61
       61
       +
       ```

     

       62
       62
       +
       

     

       63
       63
       +
       ## Usage for Parser Testing

     

       64
       64
       +
       

     

       65
       65
       +
       These test cases can be used to verify:

     

       66
       66
       +
       

     

       67
       67
       +
       1. **Header parsing** - Correct extraction of version, type, requestId, lengths

     

       68
       68
       +
       2. **Content parsing** - Proper handling of record body data

     

       69
       69
       +
       3. **Stream handling** - Recognition of stream start/end patterns

     

       70
       70
       +
       4. **Name-value pair parsing** - Decoding of FCGI_PARAMS format

     

       71
       71
       +
       5. **Role-specific parsing** - Different record sequences for each role

     

       72
       72
       +
       6. **Error handling** - Response to unknown types, malformed data

     

       73
       73
       +
       7. **Multiplexing** - Handling multiple concurrent request IDs

     

       74
       74
       +
       8. **Padding** - Correct skipping of padding bytes

     

       75
       75
       +
       

     

       76
       76
       +
       ## Typical Protocol Flows

     

       77
       77
       +
       

     

       78
       78
       +
       ### Simple Responder Request

     

       79
       79
       +
       1. `begin_request_responder.bin`

     

       80
       80
       +
       2. `params_get.bin`

     

       81
       81
       +
       3. `params_empty.bin`

     

       82
       82
       +
       4. `stdin_empty.bin`

     

       83
       83
       +
       5. `stdout_response.bin`

     

       84
       84
       +
       6. `stdout_empty.bin`

     

       85
       85
       +
       7. `end_request_success.bin`

     

       86
       86
       +
       

     

       87
       87
       +
       ### POST Request with Form Data

     

       88
       88
       +
       1. `begin_request_responder.bin`

     

       89
       89
       +
       2. `params_post.bin`

     

       90
       90
       +
       3. `params_empty.bin`

     

       91
       91
       +
       4. `stdin_form_data.bin`

     

       92
       92
       +
       5. `stdin_empty.bin`

     

       93
       93
       +
       6. `stdout_response.bin`

     

       94
       94
       +
       7. `stdout_empty.bin`

     

       95
       95
       +
       8. `end_request_success.bin`

     

       96
       96
       +
       

     

       97
       97
       +
       ### Authorizer Request

     

       98
       98
       +
       1. `begin_request_authorizer.bin`

     

       99
       99
       +
       2. `params_get.bin`

     

       100
       100
       +
       3. `params_empty.bin`

     

       101
       101
       +
       4. `stdout_response.bin`

     

       102
       102
       +
       5. `stdout_empty.bin`

     

       103
       103
       +
       6. `end_request_success.bin`

     

       104
       104
       +
       

     

       105
       105
       +
       ### Filter Request

     

       106
       106
       +
       1. `begin_request_filter.bin`

     

       107
       107
       +
       2. `params_get.bin`

     

       108
       108
       +
       3. `params_empty.bin`

     

       109
       109
       +
       4. `stdin_empty.bin`

     

       110
       110
       +
       5. `data_filter.bin`

     

       111
       111
       +
       6. `data_empty.bin`

     

       112
       112
       +
       7. `stdout_response.bin`

     

       113
       113
       +
       8. `stdout_empty.bin`

     

       114
       114
       +
       9. `end_request_success.bin`

     

       115
       115
       +
       

     

       116
       116
       +
       ## Binary Format Verification

     

       117
       117
       +
       

     

       118
       118
       +
       You can inspect the binary content using hexdump:

     

       119
       119
       +
       ```bash

     

       120
       120
       +
       hexdump -C begin_request_responder.bin

     

       121
       121
       +
       ```

     

       122
       122
       +
       

     

       123
       123
       +
       The first 8 bytes should always be the FastCGI header, followed by the record content and any padding.

test/test_cases/abort_request.bin

This is a binary file and will not be displayed.

test/test_cases/begin_request_authorizer.bin

This is a binary file and will not be displayed.

test/test_cases/begin_request_filter.bin

This is a binary file and will not be displayed.

test/test_cases/begin_request_no_keep.bin

This is a binary file and will not be displayed.

test/test_cases/begin_request_responder.bin

This is a binary file and will not be displayed.

test/test_cases/data_empty.bin

This is a binary file and will not be displayed.

test/test_cases/data_filter.bin

This is a binary file and will not be displayed.

test/test_cases/end_request_error.bin

This is a binary file and will not be displayed.

test/test_cases/end_request_success.bin

This is a binary file and will not be displayed.

+349

test/test_cases/generate_test_cases.py

···

       1
       1
       +
       #!/usr/bin/env python3

     

       2
       2
       +
       """

     

       3
       3
       +
       Generate FastCGI test case files based on the specification.

     

       4
       4
       +
       """

     

       5
       5
       +
       import struct

     

       6
       6
       +
       import os

     

       7
       7
       +
       

     

       8
       8
       +
       # FastCGI constants from the specification

     

       9
       9
       +
       FCGI_VERSION_1 = 1

     

       10
       10
       +
       

     

       11
       11
       +
       # Record types

     

       12
       12
       +
       FCGI_BEGIN_REQUEST = 1

     

       13
       13
       +
       FCGI_ABORT_REQUEST = 2

     

       14
       14
       +
       FCGI_END_REQUEST = 3

     

       15
       15
       +
       FCGI_PARAMS = 4

     

       16
       16
       +
       FCGI_STDIN = 5

     

       17
       17
       +
       FCGI_STDOUT = 6

     

       18
       18
       +
       FCGI_STDERR = 7

     

       19
       19
       +
       FCGI_DATA = 8

     

       20
       20
       +
       FCGI_GET_VALUES = 9

     

       21
       21
       +
       FCGI_GET_VALUES_RESULT = 10

     

       22
       22
       +
       FCGI_UNKNOWN_TYPE = 11

     

       23
       23
       +
       

     

       24
       24
       +
       # Roles

     

       25
       25
       +
       FCGI_RESPONDER = 1

     

       26
       26
       +
       FCGI_AUTHORIZER = 2

     

       27
       27
       +
       FCGI_FILTER = 3

     

       28
       28
       +
       

     

       29
       29
       +
       # Flags

     

       30
       30
       +
       FCGI_KEEP_CONN = 1

     

       31
       31
       +
       

     

       32
       32
       +
       # Protocol status

     

       33
       33
       +
       FCGI_REQUEST_COMPLETE = 0

     

       34
       34
       +
       FCGI_CANT_MPX_CONN = 1

     

       35
       35
       +
       FCGI_OVERLOADED = 2

     

       36
       36
       +
       FCGI_UNKNOWN_ROLE = 3

     

       37
       37
       +
       

     

       38
       38
       +
       def create_record_header(version, record_type, request_id, content_length, padding_length=0):

     

       39
       39
       +
           """Create a FastCGI record header."""

     

       40
       40
       +
           return struct.pack('>BBHHBB',

     

       41
       41
       +
                              version,

     

       42
       42
       +
                              record_type,

     

       43
       43
       +
                              request_id,

     

       44
       44
       +
                              content_length,

     

       45
       45
       +
                              padding_length,

     

       46
       46
       +
                              0)  # reserved

     

       47
       47
       +
       

     

       48
       48
       +
       def encode_name_value_pair(name, value):

     

       49
       49
       +
           """Encode a name-value pair according to FastCGI spec."""

     

       50
       50
       +
           name_bytes = name.encode('utf-8')

     

       51
       51
       +
           value_bytes = value.encode('utf-8')

     

       52
       52
       +
           

     

       53
       53
       +
           name_len = len(name_bytes)

     

       54
       54
       +
           value_len = len(value_bytes)

     

       55
       55
       +
           

     

       56
       56
       +
           # Encode lengths

     

       57
       57
       +
           if name_len < 128:

     

       58
       58
       +
               name_len_encoded = struct.pack('B', name_len)

     

       59
       59
       +
           else:

     

       60
       60
       +
               name_len_encoded = struct.pack('>I', name_len | 0x80000000)

     

       61
       61
       +
           

     

       62
       62
       +
           if value_len < 128:

     

       63
       63
       +
               value_len_encoded = struct.pack('B', value_len)

     

       64
       64
       +
           else:

     

       65
       65
       +
               value_len_encoded = struct.pack('>I', value_len | 0x80000000)

     

       66
       66
       +
           

     

       67
       67
       +
           return name_len_encoded + value_len_encoded + name_bytes + value_bytes

     

       68
       68
       +
       

     

       69
       69
       +
       def create_begin_request():

     

       70
       70
       +
           """Create FCGI_BEGIN_REQUEST record."""

     

       71
       71
       +
           # FCGI_BeginRequestBody

     

       72
       72
       +
           body = struct.pack('>HB5x', FCGI_RESPONDER, FCGI_KEEP_CONN)

     

       73
       73
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 1, len(body))

     

       74
       74
       +
           return header + body

     

       75
       75
       +
       

     

       76
       76
       +
       def create_begin_request_no_keep_conn():

     

       77
       77
       +
           """Create FCGI_BEGIN_REQUEST record without keep connection."""

     

       78
       78
       +
           body = struct.pack('>HB5x', FCGI_RESPONDER, 0)

     

       79
       79
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 1, len(body))

     

       80
       80
       +
           return header + body

     

       81
       81
       +
       

     

       82
       82
       +
       def create_begin_request_authorizer():

     

       83
       83
       +
           """Create FCGI_BEGIN_REQUEST record for authorizer role."""

     

       84
       84
       +
           body = struct.pack('>HB5x', FCGI_AUTHORIZER, 0)

     

       85
       85
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 2, len(body))

     

       86
       86
       +
           return header + body

     

       87
       87
       +
       

     

       88
       88
       +
       def create_begin_request_filter():

     

       89
       89
       +
           """Create FCGI_BEGIN_REQUEST record for filter role."""

     

       90
       90
       +
           body = struct.pack('>HB5x', FCGI_FILTER, FCGI_KEEP_CONN)

     

       91
       91
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 3, len(body))

     

       92
       92
       +
           return header + body

     

       93
       93
       +
       

     

       94
       94
       +
       def create_end_request():

     

       95
       95
       +
           """Create FCGI_END_REQUEST record."""

     

       96
       96
       +
           # FCGI_EndRequestBody

     

       97
       97
       +
           body = struct.pack('>IB3x', 0, FCGI_REQUEST_COMPLETE)  # app_status=0, protocol_status=COMPLETE

     

       98
       98
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_END_REQUEST, 1, len(body))

     

       99
       99
       +
           return header + body

     

       100
       100
       +
       

     

       101
       101
       +
       def create_end_request_error():

     

       102
       102
       +
           """Create FCGI_END_REQUEST record with error status."""

     

       103
       103
       +
           body = struct.pack('>IB3x', 1, FCGI_REQUEST_COMPLETE)  # app_status=1 (error)

     

       104
       104
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_END_REQUEST, 1, len(body))

     

       105
       105
       +
           return header + body

     

       106
       106
       +
       

     

       107
       107
       +
       def create_params_record():

     

       108
       108
       +
           """Create FCGI_PARAMS record with CGI environment variables."""

     

       109
       109
       +
           # Typical CGI parameters

     

       110
       110
       +
           params = [

     

       111
       111
       +
               ("REQUEST_METHOD", "GET"),

     

       112
       112
       +
               ("SCRIPT_NAME", "/test.cgi"),

     

       113
       113
       +
               ("REQUEST_URI", "/test.cgi?foo=bar"),

     

       114
       114
       +
               ("QUERY_STRING", "foo=bar"),

     

       115
       115
       +
               ("SERVER_NAME", "localhost"),

     

       116
       116
       +
               ("SERVER_PORT", "80"),

     

       117
       117
       +
               ("HTTP_HOST", "localhost"),

     

       118
       118
       +
               ("HTTP_USER_AGENT", "Mozilla/5.0"),

     

       119
       119
       +
               ("CONTENT_TYPE", ""),

     

       120
       120
       +
               ("CONTENT_LENGTH", "0")

     

       121
       121
       +
           ]

     

       122
       122
       +
           

     

       123
       123
       +
           body = b''

     

       124
       124
       +
           for name, value in params:

     

       125
       125
       +
               body += encode_name_value_pair(name, value)

     

       126
       126
       +
           

     

       127
       127
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 1, len(body))

     

       128
       128
       +
           return header + body

     

       129
       129
       +
       

     

       130
       130
       +
       def create_params_record_post():

     

       131
       131
       +
           """Create FCGI_PARAMS record for POST request."""

     

       132
       132
       +
           params = [

     

       133
       133
       +
               ("REQUEST_METHOD", "POST"),

     

       134
       134
       +
               ("SCRIPT_NAME", "/form.cgi"),

     

       135
       135
       +
               ("REQUEST_URI", "/form.cgi"),

     

       136
       136
       +
               ("QUERY_STRING", ""),

     

       137
       137
       +
               ("SERVER_NAME", "localhost"),

     

       138
       138
       +
               ("SERVER_PORT", "443"),

     

       139
       139
       +
               ("HTTPS", "on"),

     

       140
       140
       +
               ("HTTP_HOST", "localhost"),

     

       141
       141
       +
               ("HTTP_USER_AGENT", "curl/7.68.0"),

     

       142
       142
       +
               ("CONTENT_TYPE", "application/x-www-form-urlencoded"),

     

       143
       143
       +
               ("CONTENT_LENGTH", "23")

     

       144
       144
       +
           ]

     

       145
       145
       +
           

     

       146
       146
       +
           body = b''

     

       147
       147
       +
           for name, value in params:

     

       148
       148
       +
               body += encode_name_value_pair(name, value)

     

       149
       149
       +
           

     

       150
       150
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 1, len(body))

     

       151
       151
       +
           return header + body

     

       152
       152
       +
       

     

       153
       153
       +
       def create_empty_params():

     

       154
       154
       +
           """Create empty FCGI_PARAMS record (end of params stream)."""

     

       155
       155
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 1, 0)

     

       156
       156
       +
           return header

     

       157
       157
       +
       

     

       158
       158
       +
       def create_stdin_record():

     

       159
       159
       +
           """Create FCGI_STDIN record with form data."""

     

       160
       160
       +
           data = b"name=John&email=john@example.com"

     

       161
       161
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDIN, 1, len(data))

     

       162
       162
       +
           return header + data

     

       163
       163
       +
       

     

       164
       164
       +
       def create_empty_stdin():

     

       165
       165
       +
           """Create empty FCGI_STDIN record (end of stdin stream)."""

     

       166
       166
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDIN, 1, 0)

     

       167
       167
       +
           return header

     

       168
       168
       +
       

     

       169
       169
       +
       def create_stdout_record():

     

       170
       170
       +
           """Create FCGI_STDOUT record with HTTP response."""

     

       171
       171
       +
           response = b"Content-Type: text/html\r\n\r\n<html><body>Hello World</body></html>"

     

       172
       172
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, len(response))

     

       173
       173
       +
           return header + response

     

       174
       174
       +
       

     

       175
       175
       +
       def create_empty_stdout():

     

       176
       176
       +
           """Create empty FCGI_STDOUT record (end of stdout stream)."""

     

       177
       177
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, 0)

     

       178
       178
       +
           return header

     

       179
       179
       +
       

     

       180
       180
       +
       def create_stderr_record():

     

       181
       181
       +
           """Create FCGI_STDERR record with error message."""

     

       182
       182
       +
           error_msg = b"Warning: Configuration file not found\n"

     

       183
       183
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDERR, 1, len(error_msg))

     

       184
       184
       +
           return header + error_msg

     

       185
       185
       +
       

     

       186
       186
       +
       def create_empty_stderr():

     

       187
       187
       +
           """Create empty FCGI_STDERR record (end of stderr stream)."""

     

       188
       188
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDERR, 1, 0)

     

       189
       189
       +
           return header

     

       190
       190
       +
       

     

       191
       191
       +
       def create_get_values():

     

       192
       192
       +
           """Create FCGI_GET_VALUES record."""

     

       193
       193
       +
           # Request standard capability variables

     

       194
       194
       +
           body = (encode_name_value_pair("FCGI_MAX_CONNS", "") +

     

       195
       195
       +
                   encode_name_value_pair("FCGI_MAX_REQS", "") +

     

       196
       196
       +
                   encode_name_value_pair("FCGI_MPXS_CONNS", ""))

     

       197
       197
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_GET_VALUES, 0, len(body))

     

       198
       198
       +
           return header + body

     

       199
       199
       +
       

     

       200
       200
       +
       def create_get_values_result():

     

       201
       201
       +
           """Create FCGI_GET_VALUES_RESULT record."""

     

       202
       202
       +
           body = (encode_name_value_pair("FCGI_MAX_CONNS", "1") +

     

       203
       203
       +
                   encode_name_value_pair("FCGI_MAX_REQS", "1") +

     

       204
       204
       +
                   encode_name_value_pair("FCGI_MPXS_CONNS", "0"))

     

       205
       205
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_GET_VALUES_RESULT, 0, len(body))

     

       206
       206
       +
           return header + body

     

       207
       207
       +
       

     

       208
       208
       +
       def create_unknown_type():

     

       209
       209
       +
           """Create FCGI_UNKNOWN_TYPE record."""

     

       210
       210
       +
           # FCGI_UnknownTypeBody

     

       211
       211
       +
           body = struct.pack('B7x', 99)  # unknown type 99

     

       212
       212
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_UNKNOWN_TYPE, 0, len(body))

     

       213
       213
       +
           return header + body

     

       214
       214
       +
       

     

       215
       215
       +
       def create_abort_request():

     

       216
       216
       +
           """Create FCGI_ABORT_REQUEST record."""

     

       217
       217
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_ABORT_REQUEST, 1, 0)

     

       218
       218
       +
           return header

     

       219
       219
       +
       

     

       220
       220
       +
       def create_data_record():

     

       221
       221
       +
           """Create FCGI_DATA record (for Filter role)."""

     

       222
       222
       +
           file_data = b"This is file content that needs to be filtered\nLine 2\nLine 3\n"

     

       223
       223
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_DATA, 3, len(file_data))

     

       224
       224
       +
           return header + file_data

     

       225
       225
       +
       

     

       226
       226
       +
       def create_empty_data():

     

       227
       227
       +
           """Create empty FCGI_DATA record (end of data stream)."""

     

       228
       228
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_DATA, 3, 0)

     

       229
       229
       +
           return header

     

       230
       230
       +
       

     

       231
       231
       +
       def create_multiplexed_records():

     

       232
       232
       +
           """Create a sequence showing multiplexed requests."""

     

       233
       233
       +
           records = []

     

       234
       234
       +
           

     

       235
       235
       +
           # Request 1 begins

     

       236
       236
       +
           records.append(create_begin_request())

     

       237
       237
       +
           records.append(create_params_record())

     

       238
       238
       +
           records.append(create_empty_params())

     

       239
       239
       +
           

     

       240
       240
       +
           # Request 2 begins (different request ID)

     

       241
       241
       +
           body = struct.pack('>HB5x', FCGI_RESPONDER, FCGI_KEEP_CONN)

     

       242
       242
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 2, len(body))

     

       243
       243
       +
           records.append(header + body)

     

       244
       244
       +
           

     

       245
       245
       +
           # Request 1 continues

     

       246
       246
       +
           records.append(create_empty_stdin())

     

       247
       247
       +
           

     

       248
       248
       +
           # Request 2 params

     

       249
       249
       +
           params = [("REQUEST_METHOD", "POST"), ("SCRIPT_NAME", "/other.cgi")]

     

       250
       250
       +
           body = b''

     

       251
       251
       +
           for name, value in params:

     

       252
       252
       +
               body += encode_name_value_pair(name, value)

     

       253
       253
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 2, len(body))

     

       254
       254
       +
           records.append(header + body)

     

       255
       255
       +
           

     

       256
       256
       +
           # Request 2 empty params

     

       257
       257
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 2, 0)

     

       258
       258
       +
           records.append(header)

     

       259
       259
       +
           

     

       260
       260
       +
           # Request 2 completes first

     

       261
       261
       +
           response = b"Content-Type: text/plain\r\n\r\nRequest 2 done"

     

       262
       262
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 2, len(response))

     

       263
       263
       +
           records.append(header + response)

     

       264
       264
       +
           

     

       265
       265
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 2, 0)

     

       266
       266
       +
           records.append(header)

     

       267
       267
       +
           

     

       268
       268
       +
           body = struct.pack('>IB3x', 0, FCGI_REQUEST_COMPLETE)

     

       269
       269
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_END_REQUEST, 2, len(body))

     

       270
       270
       +
           records.append(header + body)

     

       271
       271
       +
           

     

       272
       272
       +
           # Request 1 completes

     

       273
       273
       +
           response = b"Content-Type: text/html\r\n\r\n<html><body>Request 1 done</body></html>"

     

       274
       274
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, len(response))

     

       275
       275
       +
           records.append(header + response)

     

       276
       276
       +
           

     

       277
       277
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, 0)

     

       278
       278
       +
           records.append(header)

     

       279
       279
       +
           

     

       280
       280
       +
           body = struct.pack('>IB3x', 0, FCGI_REQUEST_COMPLETE)

     

       281
       281
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_END_REQUEST, 1, len(body))

     

       282
       282
       +
           records.append(header + body)

     

       283
       283
       +
           

     

       284
       284
       +
           return b''.join(records)

     

       285
       285
       +
       

     

       286
       286
       +
       def create_large_record():

     

       287
       287
       +
           """Create a record with maximum content size."""

     

       288
       288
       +
           # Create a large response (just under 64KB)

     

       289
       289
       +
           large_content = b"x" * 65000

     

       290
       290
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, len(large_content))

     

       291
       291
       +
           return header + large_content

     

       292
       292
       +
       

     

       293
       293
       +
       def create_padded_record():

     

       294
       294
       +
           """Create a record with padding for alignment."""

     

       295
       295
       +
           data = b"Hello"  # 5 bytes

     

       296
       296
       +
           padding_length = 3  # to align to 8-byte boundary (5 + 3 = 8)

     

       297
       297
       +
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, len(data), padding_length)

     

       298
       298
       +
           padding = b'\x00' * padding_length

     

       299
       299
       +
           return header + data + padding

     

       300
       300
       +
       

     

       301
       301
       +
       # Test case definitions

     

       302
       302
       +
       test_cases = {

     

       303
       303
       +
           "begin_request_responder.bin": create_begin_request,

     

       304
       304
       +
           "begin_request_no_keep.bin": create_begin_request_no_keep_conn,

     

       305
       305
       +
           "begin_request_authorizer.bin": create_begin_request_authorizer,

     

       306
       306
       +
           "begin_request_filter.bin": create_begin_request_filter,

     

       307
       307
       +
           "end_request_success.bin": create_end_request,

     

       308
       308
       +
           "end_request_error.bin": create_end_request_error,

     

       309
       309
       +
           "params_get.bin": create_params_record,

     

       310
       310
       +
           "params_post.bin": create_params_record_post,

     

       311
       311
       +
           "params_empty.bin": create_empty_params,

     

       312
       312
       +
           "stdin_form_data.bin": create_stdin_record,

     

       313
       313
       +
           "stdin_empty.bin": create_empty_stdin,

     

       314
       314
       +
           "stdout_response.bin": create_stdout_record,

     

       315
       315
       +
           "stdout_empty.bin": create_empty_stdout,

     

       316
       316
       +
           "stderr_message.bin": create_stderr_record,

     

       317
       317
       +
           "stderr_empty.bin": create_empty_stderr,

     

       318
       318
       +
           "get_values.bin": create_get_values,

     

       319
       319
       +
           "get_values_result.bin": create_get_values_result,

     

       320
       320
       +
           "unknown_type.bin": create_unknown_type,

     

       321
       321
       +
           "abort_request.bin": create_abort_request,

     

       322
       322
       +
           "data_filter.bin": create_data_record,

     

       323
       323
       +
           "data_empty.bin": create_empty_data,

     

       324
       324
       +
           "multiplexed_requests.bin": create_multiplexed_records,

     

       325
       325
       +
           "large_record.bin": create_large_record,

     

       326
       326
       +
           "padded_record.bin": create_padded_record,

     

       327
       327
       +
       }

     

       328
       328
       +
       

     

       329
       329
       +
       if __name__ == "__main__":

     

       330
       330
       +
           for filename, creator in test_cases.items():

     

       331
       331
       +
               with open(filename, 'wb') as f:

     

       332
       332
       +
                   f.write(creator())

     

       333
       333
       +
               print(f"Created {filename}")

     

       334
       334
       +
           

     

       335
       335
       +
           print(f"\nGenerated {len(test_cases)} test case files")

     

       336
       336
       +
           print("\nTest case descriptions:")

     

       337
       337
       +
           print("- begin_request_*.bin: Various BEGIN_REQUEST records for different roles")

     

       338
       338
       +
           print("- end_request_*.bin: END_REQUEST records with different status codes")

     

       339
       339
       +
           print("- params_*.bin: PARAMS records with CGI environment variables")

     

       340
       340
       +
           print("- stdin_*.bin: STDIN records with request body data")

     

       341
       341
       +
           print("- stdout_*.bin: STDOUT records with response data")

     

       342
       342
       +
           print("- stderr_*.bin: STDERR records with error messages")

     

       343
       343
       +
           print("- get_values*.bin: Management records for capability negotiation")

     

       344
       344
       +
           print("- unknown_type.bin: Unknown record type handling")

     

       345
       345
       +
           print("- abort_request.bin: Request abortion")

     

       346
       346
       +
           print("- data_*.bin: DATA records for Filter role")

     

       347
       347
       +
           print("- multiplexed_requests.bin: Multiple concurrent requests")

     

       348
       348
       +
           print("- large_record.bin: Maximum size record")

     

       349
       349
       +
           print("- padded_record.bin: Record with padding for alignment")

test/test_cases/get_values.bin

This is a binary file and will not be displayed.

test/test_cases/get_values_result.bin

This is a binary file and will not be displayed.

test/test_cases/large_record.bin

This is a binary file and will not be displayed.

test/test_cases/multiplexed_requests.bin

This is a binary file and will not be displayed.

test/test_cases/padded_record.bin

This is a binary file and will not be displayed.

test/test_cases/params_empty.bin

This is a binary file and will not be displayed.

test/test_cases/params_get.bin

This is a binary file and will not be displayed.

test/test_cases/params_post.bin

This is a binary file and will not be displayed.

test/test_cases/stderr_empty.bin

This is a binary file and will not be displayed.

test/test_cases/stderr_message.bin

This is a binary file and will not be displayed.

test/test_cases/stdin_empty.bin

This is a binary file and will not be displayed.

test/test_cases/stdin_form_data.bin

This is a binary file and will not be displayed.

test/test_cases/stdout_empty.bin

This is a binary file and will not be displayed.

test/test_cases/stdout_response.bin

This is a binary file and will not be displayed.

+24

test/test_cases/test_case_sizes.txt

···

       1
       1
       +
       abort_request.bin	8 bytes

     

       2
       2
       +
       begin_request_authorizer.bin	16 bytes

     

       3
       3
       +
       begin_request_filter.bin	16 bytes

     

       4
       4
       +
       begin_request_no_keep.bin	16 bytes

     

       5
       5
       +
       begin_request_responder.bin	16 bytes

     

       6
       6
       +
       data_empty.bin	8 bytes

     

       7
       7
       +
       data_filter.bin	69 bytes

     

       8
       8
       +
       end_request_error.bin	16 bytes

     

       9
       9
       +
       end_request_success.bin	16 bytes

     

       10
       10
       +
       get_values_result.bin	59 bytes

     

       11
       11
       +
       get_values.bin	56 bytes

     

       12
       12
       +
       large_record.bin	65008 bytes

     

       13
       13
       +
       multiplexed_requests.bin	496 bytes

     

       14
       14
       +
       padded_record.bin	16 bytes

     

       15
       15
       +
       params_empty.bin	8 bytes

     

       16
       16
       +
       params_get.bin	216 bytes

     

       17
       17
       +
       params_post.bin	246 bytes

     

       18
       18
       +
       stderr_empty.bin	8 bytes

     

       19
       19
       +
       stderr_message.bin	46 bytes

     

       20
       20
       +
       stdin_empty.bin	8 bytes

     

       21
       21
       +
       stdin_form_data.bin	40 bytes

     

       22
       22
       +
       stdout_empty.bin	8 bytes

     

       23
       23
       +
       stdout_response.bin	72 bytes

     

       24
       24
       +
       unknown_type.bin	16 bytes

test/test_cases/unknown_type.bin

This is a binary file and will not be displayed.

+130

test/test_cases/validate_test_cases.py

···

       1
       1
       +
       #!/usr/bin/env python3

     

       2
       2
       +
       """

     

       3
       3
       +
       Validate that the generated FastCGI test cases are properly formatted.

     

       4
       4
       +
       """

     

       5
       5
       +
       import struct

     

       6
       6
       +
       import os

     

       7
       7
       +
       import glob

     

       8
       8
       +
       

     

       9
       9
       +
       def parse_record_header(data):

     

       10
       10
       +
           """Parse a FastCGI record header."""

     

       11
       11
       +
           if len(data) < 8:

     

       12
       12
       +
               return None

     

       13
       13
       +
           

     

       14
       14
       +
           version, record_type, request_id, content_length, padding_length, reserved = struct.unpack('>BBHHBB', data[:8])

     

       15
       15
       +
           return {

     

       16
       16
       +
               'version': version,

     

       17
       17
       +
               'type': record_type,

     

       18
       18
       +
               'request_id': request_id,

     

       19
       19
       +
               'content_length': content_length,

     

       20
       20
       +
               'padding_length': padding_length,

     

       21
       21
       +
               'reserved': reserved,

     

       22
       22
       +
               'total_length': 8 + content_length + padding_length

     

       23
       23
       +
           }

     

       24
       24
       +
       

     

       25
       25
       +
       def validate_file(filename):

     

       26
       26
       +
           """Validate a single test case file."""

     

       27
       27
       +
           print(f"\nValidating {filename}:")

     

       28
       28
       +
           

     

       29
       29
       +
           with open(filename, 'rb') as f:

     

       30
       30
       +
               data = f.read()

     

       31
       31
       +
           

     

       32
       32
       +
           if len(data) < 8:

     

       33
       33
       +
               print(f"  ❌ File too short: {len(data)} bytes")

     

       34
       34
       +
               return False

     

       35
       35
       +
           

     

       36
       36
       +
           # Parse all records in the file

     

       37
       37
       +
           offset = 0

     

       38
       38
       +
           record_count = 0

     

       39
       39
       +
           

     

       40
       40
       +
           while offset < len(data):

     

       41
       41
       +
               if offset + 8 > len(data):

     

       42
       42
       +
                   print(f"  ❌ Incomplete header at offset {offset}")

     

       43
       43
       +
                   return False

     

       44
       44
       +
               

     

       45
       45
       +
               header = parse_record_header(data[offset:])

     

       46
       46
       +
               if not header:

     

       47
       47
       +
                   print(f"  ❌ Failed to parse header at offset {offset}")

     

       48
       48
       +
                   return False

     

       49
       49
       +
               

     

       50
       50
       +
               record_count += 1

     

       51
       51
       +
               print(f"  Record {record_count}:")

     

       52
       52
       +
               print(f"    Version: {header['version']}")

     

       53
       53
       +
               print(f"    Type: {header['type']}")

     

       54
       54
       +
               print(f"    Request ID: {header['request_id']}")

     

       55
       55
       +
               print(f"    Content Length: {header['content_length']}")

     

       56
       56
       +
               print(f"    Padding Length: {header['padding_length']}")

     

       57
       57
       +
               print(f"    Reserved: {header['reserved']}")

     

       58
       58
       +
               

     

       59
       59
       +
               # Validate header fields

     

       60
       60
       +
               if header['version'] != 1:

     

       61
       61
       +
                   print(f"    ❌ Invalid version: {header['version']}")

     

       62
       62
       +
                   return False

     

       63
       63
       +
               

     

       64
       64
       +
               if header['type'] < 1 or header['type'] > 11:

     

       65
       65
       +
                   print(f"    ❌ Invalid record type: {header['type']}")

     

       66
       66
       +
                   return False

     

       67
       67
       +
               

     

       68
       68
       +
               if header['reserved'] != 0:

     

       69
       69
       +
                   print(f"    ❌ Reserved field not zero: {header['reserved']}")

     

       70
       70
       +
                   return False

     

       71
       71
       +
               

     

       72
       72
       +
               # Check if we have enough data for content and padding

     

       73
       73
       +
               expected_end = offset + header['total_length']

     

       74
       74
       +
               if expected_end > len(data):

     

       75
       75
       +
                   print(f"    ❌ Not enough data: need {header['total_length']}, have {len(data) - offset}")

     

       76
       76
       +
                   return False

     

       77
       77
       +
               

     

       78
       78
       +
               # Extract content

     

       79
       79
       +
               content_start = offset + 8

     

       80
       80
       +
               content_end = content_start + header['content_length']

     

       81
       81
       +
               content = data[content_start:content_end]

     

       82
       82
       +
               

     

       83
       83
       +
               # Extract padding

     

       84
       84
       +
               padding_start = content_end

     

       85
       85
       +
               padding_end = padding_start + header['padding_length']

     

       86
       86
       +
               padding = data[padding_start:padding_end]

     

       87
       87
       +
               

     

       88
       88
       +
               print(f"    Content: {len(content)} bytes")

     

       89
       89
       +
               if header['padding_length'] > 0:

     

       90
       90
       +
                   print(f"    Padding: {len(padding)} bytes")

     

       91
       91
       +
               

     

       92
       92
       +
               # Show content preview for small records

     

       93
       93
       +
               if len(content) <= 32:

     

       94
       94
       +
                   print(f"    Content hex: {content.hex()}")

     

       95
       95
       +
               else:

     

       96
       96
       +
                   print(f"    Content preview: {content[:16].hex()}...")

     

       97
       97
       +
               

     

       98
       98
       +
               print(f"    ✅ Record valid")

     

       99
       99
       +
               

     

       100
       100
       +
               offset = expected_end

     

       101
       101
       +
           

     

       102
       102
       +
           print(f"  ✅ File valid: {record_count} record(s), {len(data)} total bytes")

     

       103
       103
       +
           return True

     

       104
       104
       +
       

     

       105
       105
       +
       def main():

     

       106
       106
       +
           """Validate all test case files."""

     

       107
       107
       +
           test_files = glob.glob("*.bin")

     

       108
       108
       +
           test_files.sort()

     

       109
       109
       +
           

     

       110
       110
       +
           print(f"Found {len(test_files)} test case files")

     

       111
       111
       +
           

     

       112
       112
       +
           valid_count = 0

     

       113
       113
       +
           for filename in test_files:

     

       114
       114
       +
               if validate_file(filename):

     

       115
       115
       +
                   valid_count += 1

     

       116
       116
       +
           

     

       117
       117
       +
           print(f"\n{'='*50}")

     

       118
       118
       +
           print(f"Validation complete: {valid_count}/{len(test_files)} files valid")

     

       119
       119
       +
           

     

       120
       120
       +
           if valid_count == len(test_files):

     

       121
       121
       +
               print("✅ All test cases are valid!")

     

       122
       122
       +
           else:

     

       123
       123
       +
               print("❌ Some test cases failed validation")

     

       124
       124
       +
               return 1

     

       125
       125
       +
           

     

       126
       126
       +
           return 0

     

       127
       127
       +
       

     

       128
       128
       +
       if __name__ == "__main__":

     

       129
       129
       +
           import sys

     

       130
       130
       +
           sys.exit(main())

+438

test/test_cases/validation_results.txt

···

       1
       1
       +
       Found 24 test case files

     

       2
       2
       +
       

     

       3
       3
       +
       Validating abort_request.bin:

     

       4
       4
       +
         Record 1:

     

       5
       5
       +
           Version: 1

     

       6
       6
       +
           Type: 2

     

       7
       7
       +
           Request ID: 1

     

       8
       8
       +
           Content Length: 0

     

       9
       9
       +
           Padding Length: 0

     

       10
       10
       +
           Reserved: 0

     

       11
       11
       +
           Content: 0 bytes

     

       12
       12
       +
           Content hex: 

     

       13
       13
       +
           ✅ Record valid

     

       14
       14
       +
         ✅ File valid: 1 record(s), 8 total bytes

     

       15
       15
       +
       

     

       16
       16
       +
       Validating begin_request_authorizer.bin:

     

       17
       17
       +
         Record 1:

     

       18
       18
       +
           Version: 1

     

       19
       19
       +
           Type: 1

     

       20
       20
       +
           Request ID: 2

     

       21
       21
       +
           Content Length: 8

     

       22
       22
       +
           Padding Length: 0

     

       23
       23
       +
           Reserved: 0

     

       24
       24
       +
           Content: 8 bytes

     

       25
       25
       +
           Content hex: 0002000000000000

     

       26
       26
       +
           ✅ Record valid

     

       27
       27
       +
         ✅ File valid: 1 record(s), 16 total bytes

     

       28
       28
       +
       

     

       29
       29
       +
       Validating begin_request_filter.bin:

     

       30
       30
       +
         Record 1:

     

       31
       31
       +
           Version: 1

     

       32
       32
       +
           Type: 1

     

       33
       33
       +
           Request ID: 3

     

       34
       34
       +
           Content Length: 8

     

       35
       35
       +
           Padding Length: 0

     

       36
       36
       +
           Reserved: 0

     

       37
       37
       +
           Content: 8 bytes

     

       38
       38
       +
           Content hex: 0003010000000000

     

       39
       39
       +
           ✅ Record valid

     

       40
       40
       +
         ✅ File valid: 1 record(s), 16 total bytes

     

       41
       41
       +
       

     

       42
       42
       +
       Validating begin_request_no_keep.bin:

     

       43
       43
       +
         Record 1:

     

       44
       44
       +
           Version: 1

     

       45
       45
       +
           Type: 1

     

       46
       46
       +
           Request ID: 1

     

       47
       47
       +
           Content Length: 8

     

       48
       48
       +
           Padding Length: 0

     

       49
       49
       +
           Reserved: 0

     

       50
       50
       +
           Content: 8 bytes

     

       51
       51
       +
           Content hex: 0001000000000000

     

       52
       52
       +
           ✅ Record valid

     

       53
       53
       +
         ✅ File valid: 1 record(s), 16 total bytes

     

       54
       54
       +
       

     

       55
       55
       +
       Validating begin_request_responder.bin:

     

       56
       56
       +
         Record 1:

     

       57
       57
       +
           Version: 1

     

       58
       58
       +
           Type: 1

     

       59
       59
       +
           Request ID: 1

     

       60
       60
       +
           Content Length: 8

     

       61
       61
       +
           Padding Length: 0

     

       62
       62
       +
           Reserved: 0

     

       63
       63
       +
           Content: 8 bytes

     

       64
       64
       +
           Content hex: 0001010000000000

     

       65
       65
       +
           ✅ Record valid

     

       66
       66
       +
         ✅ File valid: 1 record(s), 16 total bytes

     

       67
       67
       +
       

     

       68
       68
       +
       Validating data_empty.bin:

     

       69
       69
       +
         Record 1:

     

       70
       70
       +
           Version: 1

     

       71
       71
       +
           Type: 8

     

       72
       72
       +
           Request ID: 3

     

       73
       73
       +
           Content Length: 0

     

       74
       74
       +
           Padding Length: 0

     

       75
       75
       +
           Reserved: 0

     

       76
       76
       +
           Content: 0 bytes

     

       77
       77
       +
           Content hex: 

     

       78
       78
       +
           ✅ Record valid

     

       79
       79
       +
         ✅ File valid: 1 record(s), 8 total bytes

     

       80
       80
       +
       

     

       81
       81
       +
       Validating data_filter.bin:

     

       82
       82
       +
         Record 1:

     

       83
       83
       +
           Version: 1

     

       84
       84
       +
           Type: 8

     

       85
       85
       +
           Request ID: 3

     

       86
       86
       +
           Content Length: 61

     

       87
       87
       +
           Padding Length: 0

     

       88
       88
       +
           Reserved: 0

     

       89
       89
       +
           Content: 61 bytes

     

       90
       90
       +
           Content preview: 546869732069732066696c6520636f6e...

     

       91
       91
       +
           ✅ Record valid

     

       92
       92
       +
         ✅ File valid: 1 record(s), 69 total bytes

     

       93
       93
       +
       

     

       94
       94
       +
       Validating end_request_error.bin:

     

       95
       95
       +
         Record 1:

     

       96
       96
       +
           Version: 1

     

       97
       97
       +
           Type: 3

     

       98
       98
       +
           Request ID: 1

     

       99
       99
       +
           Content Length: 8

     

       100
       100
       +
           Padding Length: 0

     

       101
       101
       +
           Reserved: 0

     

       102
       102
       +
           Content: 8 bytes

     

       103
       103
       +
           Content hex: 0000000100000000

     

       104
       104
       +
           ✅ Record valid

     

       105
       105
       +
         ✅ File valid: 1 record(s), 16 total bytes

     

       106
       106
       +
       

     

       107
       107
       +
       Validating end_request_success.bin:

     

       108
       108
       +
         Record 1:

     

       109
       109
       +
           Version: 1

     

       110
       110
       +
           Type: 3

     

       111
       111
       +
           Request ID: 1

     

       112
       112
       +
           Content Length: 8

     

       113
       113
       +
           Padding Length: 0

     

       114
       114
       +
           Reserved: 0

     

       115
       115
       +
           Content: 8 bytes

     

       116
       116
       +
           Content hex: 0000000000000000

     

       117
       117
       +
           ✅ Record valid

     

       118
       118
       +
         ✅ File valid: 1 record(s), 16 total bytes

     

       119
       119
       +
       

     

       120
       120
       +
       Validating get_values.bin:

     

       121
       121
       +
         Record 1:

     

       122
       122
       +
           Version: 1

     

       123
       123
       +
           Type: 9

     

       124
       124
       +
           Request ID: 0

     

       125
       125
       +
           Content Length: 48

     

       126
       126
       +
           Padding Length: 0

     

       127
       127
       +
           Reserved: 0

     

       128
       128
       +
           Content: 48 bytes

     

       129
       129
       +
           Content preview: 0e00464347495f4d41585f434f4e4e53...

     

       130
       130
       +
           ✅ Record valid

     

       131
       131
       +
         ✅ File valid: 1 record(s), 56 total bytes

     

       132
       132
       +
       

     

       133
       133
       +
       Validating get_values_result.bin:

     

       134
       134
       +
         Record 1:

     

       135
       135
       +
           Version: 1

     

       136
       136
       +
           Type: 10

     

       137
       137
       +
           Request ID: 0

     

       138
       138
       +
           Content Length: 51

     

       139
       139
       +
           Padding Length: 0

     

       140
       140
       +
           Reserved: 0

     

       141
       141
       +
           Content: 51 bytes

     

       142
       142
       +
           Content preview: 0e01464347495f4d41585f434f4e4e53...

     

       143
       143
       +
           ✅ Record valid

     

       144
       144
       +
         ✅ File valid: 1 record(s), 59 total bytes

     

       145
       145
       +
       

     

       146
       146
       +
       Validating large_record.bin:

     

       147
       147
       +
         Record 1:

     

       148
       148
       +
           Version: 1

     

       149
       149
       +
           Type: 6

     

       150
       150
       +
           Request ID: 1

     

       151
       151
       +
           Content Length: 65000

     

       152
       152
       +
           Padding Length: 0

     

       153
       153
       +
           Reserved: 0

     

       154
       154
       +
           Content: 65000 bytes

     

       155
       155
       +
           Content preview: 78787878787878787878787878787878...

     

       156
       156
       +
           ✅ Record valid

     

       157
       157
       +
         ✅ File valid: 1 record(s), 65008 total bytes

     

       158
       158
       +
       

     

       159
       159
       +
       Validating multiplexed_requests.bin:

     

       160
       160
       +
         Record 1:

     

       161
       161
       +
           Version: 1

     

       162
       162
       +
           Type: 1

     

       163
       163
       +
           Request ID: 1

     

       164
       164
       +
           Content Length: 8

     

       165
       165
       +
           Padding Length: 0

     

       166
       166
       +
           Reserved: 0

     

       167
       167
       +
           Content: 8 bytes

     

       168
       168
       +
           Content hex: 0001010000000000

     

       169
       169
       +
           ✅ Record valid

     

       170
       170
       +
         Record 2:

     

       171
       171
       +
           Version: 1

     

       172
       172
       +
           Type: 4

     

       173
       173
       +
           Request ID: 1

     

       174
       174
       +
           Content Length: 208

     

       175
       175
       +
           Padding Length: 0

     

       176
       176
       +
           Reserved: 0

     

       177
       177
       +
           Content: 208 bytes

     

       178
       178
       +
           Content preview: 0e03524551554553545f4d4554484f44...

     

       179
       179
       +
           ✅ Record valid

     

       180
       180
       +
         Record 3:

     

       181
       181
       +
           Version: 1

     

       182
       182
       +
           Type: 4

     

       183
       183
       +
           Request ID: 1

     

       184
       184
       +
           Content Length: 0

     

       185
       185
       +
           Padding Length: 0

     

       186
       186
       +
           Reserved: 0

     

       187
       187
       +
           Content: 0 bytes

     

       188
       188
       +
           Content hex: 

     

       189
       189
       +
           ✅ Record valid

     

       190
       190
       +
         Record 4:

     

       191
       191
       +
           Version: 1

     

       192
       192
       +
           Type: 1

     

       193
       193
       +
           Request ID: 2

     

       194
       194
       +
           Content Length: 8

     

       195
       195
       +
           Padding Length: 0

     

       196
       196
       +
           Reserved: 0

     

       197
       197
       +
           Content: 8 bytes

     

       198
       198
       +
           Content hex: 0001010000000000

     

       199
       199
       +
           ✅ Record valid

     

       200
       200
       +
         Record 5:

     

       201
       201
       +
           Version: 1

     

       202
       202
       +
           Type: 5

     

       203
       203
       +
           Request ID: 1

     

       204
       204
       +
           Content Length: 0

     

       205
       205
       +
           Padding Length: 0

     

       206
       206
       +
           Reserved: 0

     

       207
       207
       +
           Content: 0 bytes

     

       208
       208
       +
           Content hex: 

     

       209
       209
       +
           ✅ Record valid

     

       210
       210
       +
         Record 6:

     

       211
       211
       +
           Version: 1

     

       212
       212
       +
           Type: 4

     

       213
       213
       +
           Request ID: 2

     

       214
       214
       +
           Content Length: 43

     

       215
       215
       +
           Padding Length: 0

     

       216
       216
       +
           Reserved: 0

     

       217
       217
       +
           Content: 43 bytes

     

       218
       218
       +
           Content preview: 0e04524551554553545f4d4554484f44...

     

       219
       219
       +
           ✅ Record valid

     

       220
       220
       +
         Record 7:

     

       221
       221
       +
           Version: 1

     

       222
       222
       +
           Type: 4

     

       223
       223
       +
           Request ID: 2

     

       224
       224
       +
           Content Length: 0

     

       225
       225
       +
           Padding Length: 0

     

       226
       226
       +
           Reserved: 0

     

       227
       227
       +
           Content: 0 bytes

     

       228
       228
       +
           Content hex: 

     

       229
       229
       +
           ✅ Record valid

     

       230
       230
       +
         Record 8:

     

       231
       231
       +
           Version: 1

     

       232
       232
       +
           Type: 6

     

       233
       233
       +
           Request ID: 2

     

       234
       234
       +
           Content Length: 42

     

       235
       235
       +
           Padding Length: 0

     

       236
       236
       +
           Reserved: 0

     

       237
       237
       +
           Content: 42 bytes

     

       238
       238
       +
           Content preview: 436f6e74656e742d547970653a207465...

     

       239
       239
       +
           ✅ Record valid

     

       240
       240
       +
         Record 9:

     

       241
       241
       +
           Version: 1

     

       242
       242
       +
           Type: 6

     

       243
       243
       +
           Request ID: 2

     

       244
       244
       +
           Content Length: 0

     

       245
       245
       +
           Padding Length: 0

     

       246
       246
       +
           Reserved: 0

     

       247
       247
       +
           Content: 0 bytes

     

       248
       248
       +
           Content hex: 

     

       249
       249
       +
           ✅ Record valid

     

       250
       250
       +
         Record 10:

     

       251
       251
       +
           Version: 1

     

       252
       252
       +
           Type: 3

     

       253
       253
       +
           Request ID: 2

     

       254
       254
       +
           Content Length: 8

     

       255
       255
       +
           Padding Length: 0

     

       256
       256
       +
           Reserved: 0

     

       257
       257
       +
           Content: 8 bytes

     

       258
       258
       +
           Content hex: 0000000000000000

     

       259
       259
       +
           ✅ Record valid

     

       260
       260
       +
         Record 11:

     

       261
       261
       +
           Version: 1

     

       262
       262
       +
           Type: 6

     

       263
       263
       +
           Request ID: 1

     

       264
       264
       +
           Content Length: 67

     

       265
       265
       +
           Padding Length: 0

     

       266
       266
       +
           Reserved: 0

     

       267
       267
       +
           Content: 67 bytes

     

       268
       268
       +
           Content preview: 436f6e74656e742d547970653a207465...

     

       269
       269
       +
           ✅ Record valid

     

       270
       270
       +
         Record 12:

     

       271
       271
       +
           Version: 1

     

       272
       272
       +
           Type: 6

     

       273
       273
       +
           Request ID: 1

     

       274
       274
       +
           Content Length: 0

     

       275
       275
       +
           Padding Length: 0

     

       276
       276
       +
           Reserved: 0

     

       277
       277
       +
           Content: 0 bytes

     

       278
       278
       +
           Content hex: 

     

       279
       279
       +
           ✅ Record valid

     

       280
       280
       +
         Record 13:

     

       281
       281
       +
           Version: 1

     

       282
       282
       +
           Type: 3

     

       283
       283
       +
           Request ID: 1

     

       284
       284
       +
           Content Length: 8

     

       285
       285
       +
           Padding Length: 0

     

       286
       286
       +
           Reserved: 0

     

       287
       287
       +
           Content: 8 bytes

     

       288
       288
       +
           Content hex: 0000000000000000

     

       289
       289
       +
           ✅ Record valid

     

       290
       290
       +
         ✅ File valid: 13 record(s), 496 total bytes

     

       291
       291
       +
       

     

       292
       292
       +
       Validating padded_record.bin:

     

       293
       293
       +
         Record 1:

     

       294
       294
       +
           Version: 1

     

       295
       295
       +
           Type: 6

     

       296
       296
       +
           Request ID: 1

     

       297
       297
       +
           Content Length: 5

     

       298
       298
       +
           Padding Length: 3

     

       299
       299
       +
           Reserved: 0

     

       300
       300
       +
           Content: 5 bytes

     

       301
       301
       +
           Padding: 3 bytes

     

       302
       302
       +
           Content hex: 48656c6c6f

     

       303
       303
       +
           ✅ Record valid

     

       304
       304
       +
         ✅ File valid: 1 record(s), 16 total bytes

     

       305
       305
       +
       

     

       306
       306
       +
       Validating params_empty.bin:

     

       307
       307
       +
         Record 1:

     

       308
       308
       +
           Version: 1

     

       309
       309
       +
           Type: 4

     

       310
       310
       +
           Request ID: 1

     

       311
       311
       +
           Content Length: 0

     

       312
       312
       +
           Padding Length: 0

     

       313
       313
       +
           Reserved: 0

     

       314
       314
       +
           Content: 0 bytes

     

       315
       315
       +
           Content hex: 

     

       316
       316
       +
           ✅ Record valid

     

       317
       317
       +
         ✅ File valid: 1 record(s), 8 total bytes

     

       318
       318
       +
       

     

       319
       319
       +
       Validating params_get.bin:

     

       320
       320
       +
         Record 1:

     

       321
       321
       +
           Version: 1

     

       322
       322
       +
           Type: 4

     

       323
       323
       +
           Request ID: 1

     

       324
       324
       +
           Content Length: 208

     

       325
       325
       +
           Padding Length: 0

     

       326
       326
       +
           Reserved: 0

     

       327
       327
       +
           Content: 208 bytes

     

       328
       328
       +
           Content preview: 0e03524551554553545f4d4554484f44...

     

       329
       329
       +
           ✅ Record valid

     

       330
       330
       +
         ✅ File valid: 1 record(s), 216 total bytes

     

       331
       331
       +
       

     

       332
       332
       +
       Validating params_post.bin:

     

       333
       333
       +
         Record 1:

     

       334
       334
       +
           Version: 1

     

       335
       335
       +
           Type: 4

     

       336
       336
       +
           Request ID: 1

     

       337
       337
       +
           Content Length: 238

     

       338
       338
       +
           Padding Length: 0

     

       339
       339
       +
           Reserved: 0

     

       340
       340
       +
           Content: 238 bytes

     

       341
       341
       +
           Content preview: 0e04524551554553545f4d4554484f44...

     

       342
       342
       +
           ✅ Record valid

     

       343
       343
       +
         ✅ File valid: 1 record(s), 246 total bytes

     

       344
       344
       +
       

     

       345
       345
       +
       Validating stderr_empty.bin:

     

       346
       346
       +
         Record 1:

     

       347
       347
       +
           Version: 1

     

       348
       348
       +
           Type: 7

     

       349
       349
       +
           Request ID: 1

     

       350
       350
       +
           Content Length: 0

     

       351
       351
       +
           Padding Length: 0

     

       352
       352
       +
           Reserved: 0

     

       353
       353
       +
           Content: 0 bytes

     

       354
       354
       +
           Content hex: 

     

       355
       355
       +
           ✅ Record valid

     

       356
       356
       +
         ✅ File valid: 1 record(s), 8 total bytes

     

       357
       357
       +
       

     

       358
       358
       +
       Validating stderr_message.bin:

     

       359
       359
       +
         Record 1:

     

       360
       360
       +
           Version: 1

     

       361
       361
       +
           Type: 7

     

       362
       362
       +
           Request ID: 1

     

       363
       363
       +
           Content Length: 38

     

       364
       364
       +
           Padding Length: 0

     

       365
       365
       +
           Reserved: 0

     

       366
       366
       +
           Content: 38 bytes

     

       367
       367
       +
           Content preview: 5761726e696e673a20436f6e66696775...

     

       368
       368
       +
           ✅ Record valid

     

       369
       369
       +
         ✅ File valid: 1 record(s), 46 total bytes

     

       370
       370
       +
       

     

       371
       371
       +
       Validating stdin_empty.bin:

     

       372
       372
       +
         Record 1:

     

       373
       373
       +
           Version: 1

     

       374
       374
       +
           Type: 5

     

       375
       375
       +
           Request ID: 1

     

       376
       376
       +
           Content Length: 0

     

       377
       377
       +
           Padding Length: 0

     

       378
       378
       +
           Reserved: 0

     

       379
       379
       +
           Content: 0 bytes

     

       380
       380
       +
           Content hex: 

     

       381
       381
       +
           ✅ Record valid

     

       382
       382
       +
         ✅ File valid: 1 record(s), 8 total bytes

     

       383
       383
       +
       

     

       384
       384
       +
       Validating stdin_form_data.bin:

     

       385
       385
       +
         Record 1:

     

       386
       386
       +
           Version: 1

     

       387
       387
       +
           Type: 5

     

       388
       388
       +
           Request ID: 1

     

       389
       389
       +
           Content Length: 32

     

       390
       390
       +
           Padding Length: 0

     

       391
       391
       +
           Reserved: 0

     

       392
       392
       +
           Content: 32 bytes

     

       393
       393
       +
           Content hex: 6e616d653d4a6f686e26656d61696c3d6a6f686e406578616d706c652e636f6d

     

       394
       394
       +
           ✅ Record valid

     

       395
       395
       +
         ✅ File valid: 1 record(s), 40 total bytes

     

       396
       396
       +
       

     

       397
       397
       +
       Validating stdout_empty.bin:

     

       398
       398
       +
         Record 1:

     

       399
       399
       +
           Version: 1

     

       400
       400
       +
           Type: 6

     

       401
       401
       +
           Request ID: 1

     

       402
       402
       +
           Content Length: 0

     

       403
       403
       +
           Padding Length: 0

     

       404
       404
       +
           Reserved: 0

     

       405
       405
       +
           Content: 0 bytes

     

       406
       406
       +
           Content hex: 

     

       407
       407
       +
           ✅ Record valid

     

       408
       408
       +
         ✅ File valid: 1 record(s), 8 total bytes

     

       409
       409
       +
       

     

       410
       410
       +
       Validating stdout_response.bin:

     

       411
       411
       +
         Record 1:

     

       412
       412
       +
           Version: 1

     

       413
       413
       +
           Type: 6

     

       414
       414
       +
           Request ID: 1

     

       415
       415
       +
           Content Length: 64

     

       416
       416
       +
           Padding Length: 0

     

       417
       417
       +
           Reserved: 0

     

       418
       418
       +
           Content: 64 bytes

     

       419
       419
       +
           Content preview: 436f6e74656e742d547970653a207465...

     

       420
       420
       +
           ✅ Record valid

     

       421
       421
       +
         ✅ File valid: 1 record(s), 72 total bytes

     

       422
       422
       +
       

     

       423
       423
       +
       Validating unknown_type.bin:

     

       424
       424
       +
         Record 1:

     

       425
       425
       +
           Version: 1

     

       426
       426
       +
           Type: 11

     

       427
       427
       +
           Request ID: 0

     

       428
       428
       +
           Content Length: 8

     

       429
       429
       +
           Padding Length: 0

     

       430
       430
       +
           Reserved: 0

     

       431
       431
       +
           Content: 8 bytes

     

       432
       432
       +
           Content hex: 6300000000000000

     

       433
       433
       +
           ✅ Record valid

     

       434
       434
       +
         ✅ File valid: 1 record(s), 16 total bytes

     

       435
       435
       +
       

     

       436
       436
       +
       ==================================================

     

       437
       437
       +
       Validation complete: 24/24 files valid

     

       438
       438
       +
       ✅ All test cases are valid!

+219

test/validate_all_test_cases.ml

···

       1
       1
       +
       open Fastcgi

     

       2
       2
       +
       open Record

     

       3
       3
       +
       

     

       4
       4
       +
       let hex_dump ?(max_bytes=256) content =

     

       5
       5
       +
         let len = String.length content in

     

       6
       6
       +
         let display_len = min len max_bytes in

     

       7
       7
       +
         let bytes_per_line = 16 in

     

       8
       8
       +
         let lines_to_show = (display_len - 1) / bytes_per_line + 1 in

     

       9
       9
       +
         

     

       10
       10
       +
         for i = 0 to lines_to_show - 1 do

     

       11
       11
       +
           let start = i * bytes_per_line in

     

       12
       12
       +
           let end_ = min (start + bytes_per_line) display_len in

     

       13
       13
       +
           Printf.printf "  %04x: " start;

     

       14
       14
       +
           

     

       15
       15
       +
           (* Print hex bytes *)

     

       16
       16
       +
           for j = start to end_ - 1 do

     

       17
       17
       +
             Printf.printf "%02x " (Char.code content.[j]);

     

       18
       18
       +
             if j = start + 7 then Printf.printf " "

     

       19
       19
       +
           done;

     

       20
       20
       +
           

     

       21
       21
       +
           (* Pad remaining space *)

     

       22
       22
       +
           for _ = end_ to start + bytes_per_line - 1 do

     

       23
       23
       +
             Printf.printf "   ";

     

       24
       24
       +
             if end_ <= start + 7 then Printf.printf " "

     

       25
       25
       +
           done;

     

       26
       26
       +
           

     

       27
       27
       +
           Printf.printf " |";

     

       28
       28
       +
           

     

       29
       29
       +
           (* Print ASCII representation *)

     

       30
       30
       +
           for j = start to end_ - 1 do

     

       31
       31
       +
             let c = content.[j] in

     

       32
       32
       +
             if c >= ' ' && c <= '~' then

     

       33
       33
       +
               Printf.printf "%c" c

     

       34
       34
       +
             else

     

       35
       35
       +
               Printf.printf "."

     

       36
       36
       +
           done;

     

       37
       37
       +
           

     

       38
       38
       +
           Printf.printf "|\n%!"

     

       39
       39
       +
         done;

     

       40
       40
       +
         

     

       41
       41
       +
         if len > max_bytes then

     

       42
       42
       +
           Printf.printf "  ... (%d more bytes truncated)\n%!" (len - max_bytes)

     

       43
       43
       +
       

     

       44
       44
       +
       

     

       45
       45
       +
       let test_cases = [

     

       46
       46
       +
         ("abort_request.bin", Abort_request, 1);

     

       47
       47
       +
         ("begin_request_authorizer.bin", Begin_request, 2);

     

       48
       48
       +
         ("begin_request_filter.bin", Begin_request, 3);

     

       49
       49
       +
         ("begin_request_no_keep.bin", Begin_request, 1);

     

       50
       50
       +
         ("begin_request_responder.bin", Begin_request, 1);

     

       51
       51
       +
         ("data_empty.bin", Data, 3);

     

       52
       52
       +
         ("data_filter.bin", Data, 3);

     

       53
       53
       +
         ("end_request_error.bin", End_request, 1);

     

       54
       54
       +
         ("end_request_success.bin", End_request, 1);

     

       55
       55
       +
         ("get_values.bin", Get_values, 0);

     

       56
       56
       +
         ("get_values_result.bin", Get_values_result, 0);

     

       57
       57
       +
         ("params_empty.bin", Params, 1);

     

       58
       58
       +
         ("params_get.bin", Params, 1);

     

       59
       59
       +
         ("params_post.bin", Params, 1);

     

       60
       60
       +
         ("stderr_empty.bin", Stderr, 1);

     

       61
       61
       +
         ("stderr_message.bin", Stderr, 1);

     

       62
       62
       +
         ("stdin_empty.bin", Stdin, 1);

     

       63
       63
       +
         ("stdin_form_data.bin", Stdin, 1);

     

       64
       64
       +
         ("stdout_empty.bin", Stdout, 1);

     

       65
       65
       +
         ("stdout_response.bin", Stdout, 1);

     

       66
       66
       +
         ("unknown_type.bin", Unknown_type, 0);

     

       67
       67
       +
       ]

     

       68
       68
       +
       

     

       69
       69
       +
       let test_binary_file ~fs filename expected_type expected_request_id =

     

       70
       70
       +
         Printf.printf "Testing %s...\n" filename;

     

       71
       71
       +
         

     

       72
       72
       +
         let (raw_content, parsed) = 

     

       73
       73
       +
           Eio.Path.with_open_in (fs, "test_cases/" ^ filename) @@ fun flow ->

     

       74
       74
       +
           let buf = Buffer.create 1024 in

     

       75
       75
       +
           Eio.Flow.copy flow (Eio.Flow.buffer_sink buf);

     

       76
       76
       +
           let raw_content = Buffer.contents buf in

     

       77
       77
       +
           let buf_read = Eio.Buf_read.of_string raw_content in

     

       78
       78
       +
           let parsed = Record.read buf_read in

     

       79
       79
       +
           (raw_content, parsed)

     

       80
       80
       +
         in

     

       81
       81
       +
         

     

       82
       82
       +
         Printf.printf "\nRaw file contents (%d bytes):\n" (String.length raw_content);

     

       83
       83
       +
         hex_dump raw_content;

     

       84
       84
       +
         

     

       85
       85
       +
         Printf.printf "\nParsed record:\n";

     

       86
       86
       +
         Format.printf "%a\n" (fun ppf -> Record.pp ppf) parsed;

     

       87
       87
       +
         

     

       88
       88
       +
         (* If this is a Params record, also show the decoded key-value pairs *)

     

       89
       89
       +
         if parsed.record_type = Params && String.length parsed.content > 0 then (

     

       90
       90
       +
           let params = Record.KV.decode parsed.content in

     

       91
       91
       +
           Printf.printf "\nDecoded parameters:\n";

     

       92
       92
       +
           Format.printf "%a\n" Record.KV.pp params

     

       93
       93
       +
         );

     

       94
       94
       +
         

     

       95
       95
       +
         assert (parsed.version = 1);

     

       96
       96
       +
         assert (parsed.record_type = expected_type);

     

       97
       97
       +
         assert (parsed.request_id = expected_request_id);

     

       98
       98
       +
         

     

       99
       99
       +
         Printf.printf "✓ %s passed\n\n%!" filename

     

       100
       100
       +
       

     

       101
       101
       +
       let test_params_decoding ~fs =

     

       102
       102
       +
         Printf.printf "Testing params record content decoding...\n";

     

       103
       103
       +
         

     

       104
       104
       +
         let parsed = 

     

       105
       105
       +
           Eio.Path.with_open_in (fs, "test_cases/params_get.bin") @@ fun flow ->

     

       106
       106
       +
           let buf_read = Eio.Buf_read.of_flow flow ~max_size:1000000 in

     

       107
       107
       +
           Record.read buf_read

     

       108
       108
       +
         in

     

       109
       109
       +
         

     

       110
       110
       +
         Printf.printf "\nParsed params record:\n";

     

       111
       111
       +
         Format.printf "%a\n" (fun ppf -> Record.pp ppf) parsed;

     

       112
       112
       +
         

     

       113
       113
       +
         (* Decode the params content *)

     

       114
       114
       +
         let params = Record.KV.decode parsed.content in

     

       115
       115
       +
         

     

       116
       116
       +
         Printf.printf "\nDecoded parameters:\n";

     

       117
       117
       +
         Format.printf "%a\n" Record.KV.pp params;

     

       118
       118
       +
         

     

       119
       119
       +
         (* Check some expected environment variables *)

     

       120
       120
       +
         assert (Record.KV.find "REQUEST_METHOD" params = "GET");

     

       121
       121
       +
         assert (Record.KV.find "SERVER_NAME" params = "localhost");

     

       122
       122
       +
         assert (Record.KV.find "SERVER_PORT" params = "80");

     

       123
       123
       +
         

     

       124
       124
       +
         Printf.printf "✓ params decoding passed\n\n%!"

     

       125
       125
       +
       

     

       126
       126
       +
       let test_large_record ~fs =

     

       127
       127
       +
         Printf.printf "Testing large record...\n";

     

       128
       128
       +
         

     

       129
       129
       +
         let parsed = 

     

       130
       130
       +
           Eio.Path.with_open_in (fs, "test_cases/large_record.bin") @@ fun flow ->

     

       131
       131
       +
           let buf_read = Eio.Buf_read.of_flow flow ~max_size:1000000 in

     

       132
       132
       +
           Record.read buf_read

     

       133
       133
       +
         in

     

       134
       134
       +
         

     

       135
       135
       +
         Printf.printf "\nParsed large record:\n";

     

       136
       136
       +
         Format.printf "%a\n" (fun ppf -> Record.pp ppf) parsed;

     

       137
       137
       +
         

     

       138
       138
       +
         assert (parsed.version = 1);

     

       139
       139
       +
         assert (parsed.record_type = Stdout);

     

       140
       140
       +
         assert (parsed.request_id = 1);

     

       141
       141
       +
         assert (String.length parsed.content = 65000);

     

       142
       142
       +
         

     

       143
       143
       +
         Printf.printf "✓ large record test passed\n\n%!"

     

       144
       144
       +
       

     

       145
       145
       +
       let test_padded_record ~fs =

     

       146
       146
       +
         Printf.printf "Testing padded record...\n";

     

       147
       147
       +
         

     

       148
       148
       +
         let parsed = 

     

       149
       149
       +
           Eio.Path.with_open_in (fs, "test_cases/padded_record.bin") @@ fun flow ->

     

       150
       150
       +
           let buf_read = Eio.Buf_read.of_flow flow ~max_size:1000000 in

     

       151
       151
       +
           Record.read buf_read

     

       152
       152
       +
         in

     

       153
       153
       +
         

     

       154
       154
       +
         Printf.printf "\nParsed padded record:\n";

     

       155
       155
       +
         Format.printf "%a\n" (fun ppf -> Record.pp ppf) parsed;

     

       156
       156
       +
         

     

       157
       157
       +
         assert (parsed.version = 1);

     

       158
       158
       +
         assert (parsed.record_type = Stdout);

     

       159
       159
       +
         assert (parsed.request_id = 1);

     

       160
       160
       +
         assert (parsed.content = "Hello");

     

       161
       161
       +
         

     

       162
       162
       +
         Printf.printf "✓ padded record test passed\n\n%!"

     

       163
       163
       +
       

     

       164
       164
       +
       let test_multiplexed_records ~fs =

     

       165
       165
       +
         Printf.printf "Testing multiplexed records...\n";

     

       166
       166
       +
         

     

       167
       167
       +
         let records = 

     

       168
       168
       +
           Eio.Path.with_open_in (fs, "test_cases/multiplexed_requests.bin") @@ fun flow ->

     

       169
       169
       +
           let buf_read = Eio.Buf_read.of_flow flow ~max_size:1000000 in

     

       170
       170
       +
           let records = ref [] in

     

       171
       171
       +
           

     

       172
       172
       +
           (* Read all records from the multiplexed stream *)

     

       173
       173
       +
           (try

     

       174
       174
       +
             while true do

     

       175
       175
       +
               let record = Record.read buf_read in

     

       176
       176
       +
               records := record :: !records

     

       177
       177
       +
             done

     

       178
       178
       +
            with End_of_file -> ());

     

       179
       179
       +
           !records

     

       180
       180
       +
         in

     

       181
       181
       +
         

     

       182
       182
       +
         let records = List.rev records in

     

       183
       183
       +
         

     

       184
       184
       +
         Printf.printf "\nParsed %d multiplexed records:\n" (List.length records);

     

       185
       185
       +
         List.iteri (fun i record ->

     

       186
       186
       +
           Printf.printf "\nRecord %d:\n" (i + 1);

     

       187
       187
       +
           Format.printf "%a\n" (fun ppf -> Record.pp ppf) record

     

       188
       188
       +
         ) records;

     

       189
       189
       +
         

     

       190
       190
       +
         (* Should have multiple records with different request IDs *)

     

       191
       191
       +
         assert (List.length records > 5);

     

       192
       192
       +
         

     

       193
       193
       +
         (* Check that we have records for both request ID 1 and 2 *)

     

       194
       194
       +
         let request_ids = List.map (fun r -> r.Record.request_id) records in

     

       195
       195
       +
         assert (List.mem 1 request_ids);

     

       196
       196
       +
         assert (List.mem 2 request_ids);

     

       197
       197
       +
         

     

       198
       198
       +
         Printf.printf "✓ multiplexed records test passed\n\n%!"

     

       199
       199
       +
       

     

       200
       200
       +
       let run_all_tests ~fs =

     

       201
       201
       +
         Printf.printf "Validating all FastCGI test case files...\n\n%!";

     

       202
       202
       +
         

     

       203
       203
       +
         (* Test individual files *)

     

       204
       204
       +
         List.iter (fun (filename, expected_type, expected_request_id) ->

     

       205
       205
       +
           test_binary_file ~fs filename expected_type expected_request_id

     

       206
       206
       +
         ) test_cases;

     

       207
       207
       +
         

     

       208
       208
       +
         Printf.printf "\nTesting specific content decoding...\n%!";

     

       209
       209
       +
         test_params_decoding ~fs;

     

       210
       210
       +
         test_large_record ~fs;

     

       211
       211
       +
         test_padded_record ~fs;

     

       212
       212
       +
         test_multiplexed_records ~fs;

     

       213
       213
       +
         

     

       214
       214
       +
         Printf.printf "\n✅ All %d test case files validated successfully!\n%!" (List.length test_cases);

     

       215
       215
       +
         Printf.printf "✅ FastCGI Record implementation is working correctly!\n%!"

     

       216
       216
       +
       

     

       217
       217
       +
       let () = Eio_main.run @@ fun env ->

     

       218
       218
       +
         let fs = Eio.Stdenv.cwd env in

     

       219
       219
       +
         run_all_tests ~fs:(fst fs)

-123

test_cases/README.md

···

       1
       1
       -
       # FastCGI Test Cases

     

       2
       2
       -
       

     

       3
       3
       -
       This directory contains binary test case files representing various FastCGI records as defined in the FastCGI specification. These files can be used to test a FastCGI parser implementation.

     

       4
       4
       -
       

     

       5
       5
       -
       ## Test Case Files

     

       6
       6
       -
       

     

       7
       7
       -
       ### Management Records (requestId = 0)

     

       8
       8
       -
       

     

       9
       9
       -
       - **`get_values.bin`** - FCGI_GET_VALUES record requesting capability information

     

       10
       10
       -
       - **`get_values_result.bin`** - FCGI_GET_VALUES_RESULT record with capability responses

     

       11
       11
       -
       - **`unknown_type.bin`** - FCGI_UNKNOWN_TYPE record for unrecognized record types

     

       12
       12
       -
       

     

       13
       13
       -
       ### Application Records (requestId > 0)

     

       14
       14
       -
       

     

       15
       15
       -
       #### BEGIN_REQUEST Records

     

       16
       16
       -
       - **`begin_request_responder.bin`** - Begin request for Responder role with KEEP_CONN flag

     

       17
       17
       -
       - **`begin_request_no_keep.bin`** - Begin request for Responder role without KEEP_CONN flag

     

       18
       18
       -
       - **`begin_request_authorizer.bin`** - Begin request for Authorizer role

     

       19
       19
       -
       - **`begin_request_filter.bin`** - Begin request for Filter role

     

       20
       20
       -
       

     

       21
       21
       -
       #### Stream Records

     

       22
       22
       -
       - **`params_get.bin`** - FCGI_PARAMS record with GET request environment variables

     

       23
       23
       -
       - **`params_post.bin`** - FCGI_PARAMS record with POST request environment variables

     

       24
       24
       -
       - **`params_empty.bin`** - Empty FCGI_PARAMS record (end of params stream)

     

       25
       25
       -
       - **`stdin_form_data.bin`** - FCGI_STDIN record with form data

     

       26
       26
       -
       - **`stdin_empty.bin`** - Empty FCGI_STDIN record (end of stdin stream)

     

       27
       27
       -
       - **`stdout_response.bin`** - FCGI_STDOUT record with HTTP response

     

       28
       28
       -
       - **`stdout_empty.bin`** - Empty FCGI_STDOUT record (end of stdout stream)

     

       29
       29
       -
       - **`stderr_message.bin`** - FCGI_STDERR record with error message

     

       30
       30
       -
       - **`stderr_empty.bin`** - Empty FCGI_STDERR record (end of stderr stream)

     

       31
       31
       -
       - **`data_filter.bin`** - FCGI_DATA record with file content (for Filter role)

     

       32
       32
       -
       - **`data_empty.bin`** - Empty FCGI_DATA record (end of data stream)

     

       33
       33
       -
       

     

       34
       34
       -
       #### Control Records

     

       35
       35
       -
       - **`end_request_success.bin`** - FCGI_END_REQUEST record with successful completion

     

       36
       36
       -
       - **`end_request_error.bin`** - FCGI_END_REQUEST record with error status

     

       37
       37
       -
       - **`abort_request.bin`** - FCGI_ABORT_REQUEST record

     

       38
       38
       -
       

     

       39
       39
       -
       ### Complex Scenarios

     

       40
       40
       -
       - **`multiplexed_requests.bin`** - Multiple concurrent requests on same connection

     

       41
       41
       -
       - **`large_record.bin`** - Record with maximum content size (65KB)

     

       42
       42
       -
       - **`padded_record.bin`** - Record with padding for 8-byte alignment

     

       43
       43
       -
       

     

       44
       44
       -
       ## Record Format

     

       45
       45
       -
       

     

       46
       46
       -
       All records follow the FastCGI record format:

     

       47
       47
       -
       

     

       48
       48
       -
       ```

     

       49
       49
       -
       typedef struct {

     

       50
       50
       -
           unsigned char version;           // FCGI_VERSION_1 (1)

     

       51
       51
       -
           unsigned char type;              // Record type (1-11)

     

       52
       52
       -
           unsigned char requestIdB1;       // Request ID high byte

     

       53
       53
       -
           unsigned char requestIdB0;       // Request ID low byte

     

       54
       54
       -
           unsigned char contentLengthB1;   // Content length high byte

     

       55
       55
       -
           unsigned char contentLengthB0;   // Content length low byte

     

       56
       56
       -
           unsigned char paddingLength;     // Padding length

     

       57
       57
       -
           unsigned char reserved;          // Reserved (always 0)

     

       58
       58
       -
           // contentData[contentLength]

     

       59
       59
       -
           // paddingData[paddingLength]

     

       60
       60
       -
       } FCGI_Record;

     

       61
       61
       -
       ```

     

       62
       62
       -
       

     

       63
       63
       -
       ## Usage for Parser Testing

     

       64
       64
       -
       

     

       65
       65
       -
       These test cases can be used to verify:

     

       66
       66
       -
       

     

       67
       67
       -
       1. **Header parsing** - Correct extraction of version, type, requestId, lengths

     

       68
       68
       -
       2. **Content parsing** - Proper handling of record body data

     

       69
       69
       -
       3. **Stream handling** - Recognition of stream start/end patterns

     

       70
       70
       -
       4. **Name-value pair parsing** - Decoding of FCGI_PARAMS format

     

       71
       71
       -
       5. **Role-specific parsing** - Different record sequences for each role

     

       72
       72
       -
       6. **Error handling** - Response to unknown types, malformed data

     

       73
       73
       -
       7. **Multiplexing** - Handling multiple concurrent request IDs

     

       74
       74
       -
       8. **Padding** - Correct skipping of padding bytes

     

       75
       75
       -
       

     

       76
       76
       -
       ## Typical Protocol Flows

     

       77
       77
       -
       

     

       78
       78
       -
       ### Simple Responder Request

     

       79
       79
       -
       1. `begin_request_responder.bin`

     

       80
       80
       -
       2. `params_get.bin`

     

       81
       81
       -
       3. `params_empty.bin`

     

       82
       82
       -
       4. `stdin_empty.bin`

     

       83
       83
       -
       5. `stdout_response.bin`

     

       84
       84
       -
       6. `stdout_empty.bin`

     

       85
       85
       -
       7. `end_request_success.bin`

     

       86
       86
       -
       

     

       87
       87
       -
       ### POST Request with Form Data

     

       88
       88
       -
       1. `begin_request_responder.bin`

     

       89
       89
       -
       2. `params_post.bin`

     

       90
       90
       -
       3. `params_empty.bin`

     

       91
       91
       -
       4. `stdin_form_data.bin`

     

       92
       92
       -
       5. `stdin_empty.bin`

     

       93
       93
       -
       6. `stdout_response.bin`

     

       94
       94
       -
       7. `stdout_empty.bin`

     

       95
       95
       -
       8. `end_request_success.bin`

     

       96
       96
       -
       

     

       97
       97
       -
       ### Authorizer Request

     

       98
       98
       -
       1. `begin_request_authorizer.bin`

     

       99
       99
       -
       2. `params_get.bin`

     

       100
       100
       -
       3. `params_empty.bin`

     

       101
       101
       -
       4. `stdout_response.bin`

     

       102
       102
       -
       5. `stdout_empty.bin`

     

       103
       103
       -
       6. `end_request_success.bin`

     

       104
       104
       -
       

     

       105
       105
       -
       ### Filter Request

     

       106
       106
       -
       1. `begin_request_filter.bin`

     

       107
       107
       -
       2. `params_get.bin`

     

       108
       108
       -
       3. `params_empty.bin`

     

       109
       109
       -
       4. `stdin_empty.bin`

     

       110
       110
       -
       5. `data_filter.bin`

     

       111
       111
       -
       6. `data_empty.bin`

     

       112
       112
       -
       7. `stdout_response.bin`

     

       113
       113
       -
       8. `stdout_empty.bin`

     

       114
       114
       -
       9. `end_request_success.bin`

     

       115
       115
       -
       

     

       116
       116
       -
       ## Binary Format Verification

     

       117
       117
       -
       

     

       118
       118
       -
       You can inspect the binary content using hexdump:

     

       119
       119
       -
       ```bash

     

       120
       120
       -
       hexdump -C begin_request_responder.bin

     

       121
       121
       -
       ```

     

       122
       122
       -
       

     

       123
       123
       -
       The first 8 bytes should always be the FastCGI header, followed by the record content and any padding.

test_cases/abort_request.bin

This is a binary file and will not be displayed.

test_cases/begin_request_authorizer.bin

This is a binary file and will not be displayed.

test_cases/begin_request_filter.bin

This is a binary file and will not be displayed.

test_cases/begin_request_no_keep.bin

This is a binary file and will not be displayed.

test_cases/begin_request_responder.bin

This is a binary file and will not be displayed.

test_cases/data_empty.bin

This is a binary file and will not be displayed.

test_cases/data_filter.bin

This is a binary file and will not be displayed.

test_cases/end_request_error.bin

This is a binary file and will not be displayed.

test_cases/end_request_success.bin

This is a binary file and will not be displayed.

-349

test_cases/generate_test_cases.py

···

       1
       1
       -
       #!/usr/bin/env python3

     

       2
       2
       -
       """

     

       3
       3
       -
       Generate FastCGI test case files based on the specification.

     

       4
       4
       -
       """

     

       5
       5
       -
       import struct

     

       6
       6
       -
       import os

     

       7
       7
       -
       

     

       8
       8
       -
       # FastCGI constants from the specification

     

       9
       9
       -
       FCGI_VERSION_1 = 1

     

       10
       10
       -
       

     

       11
       11
       -
       # Record types

     

       12
       12
       -
       FCGI_BEGIN_REQUEST = 1

     

       13
       13
       -
       FCGI_ABORT_REQUEST = 2

     

       14
       14
       -
       FCGI_END_REQUEST = 3

     

       15
       15
       -
       FCGI_PARAMS = 4

     

       16
       16
       -
       FCGI_STDIN = 5

     

       17
       17
       -
       FCGI_STDOUT = 6

     

       18
       18
       -
       FCGI_STDERR = 7

     

       19
       19
       -
       FCGI_DATA = 8

     

       20
       20
       -
       FCGI_GET_VALUES = 9

     

       21
       21
       -
       FCGI_GET_VALUES_RESULT = 10

     

       22
       22
       -
       FCGI_UNKNOWN_TYPE = 11

     

       23
       23
       -
       

     

       24
       24
       -
       # Roles

     

       25
       25
       -
       FCGI_RESPONDER = 1

     

       26
       26
       -
       FCGI_AUTHORIZER = 2

     

       27
       27
       -
       FCGI_FILTER = 3

     

       28
       28
       -
       

     

       29
       29
       -
       # Flags

     

       30
       30
       -
       FCGI_KEEP_CONN = 1

     

       31
       31
       -
       

     

       32
       32
       -
       # Protocol status

     

       33
       33
       -
       FCGI_REQUEST_COMPLETE = 0

     

       34
       34
       -
       FCGI_CANT_MPX_CONN = 1

     

       35
       35
       -
       FCGI_OVERLOADED = 2

     

       36
       36
       -
       FCGI_UNKNOWN_ROLE = 3

     

       37
       37
       -
       

     

       38
       38
       -
       def create_record_header(version, record_type, request_id, content_length, padding_length=0):

     

       39
       39
       -
           """Create a FastCGI record header."""

     

       40
       40
       -
           return struct.pack('>BBHHBB',

     

       41
       41
       -
                              version,

     

       42
       42
       -
                              record_type,

     

       43
       43
       -
                              request_id,

     

       44
       44
       -
                              content_length,

     

       45
       45
       -
                              padding_length,

     

       46
       46
       -
                              0)  # reserved

     

       47
       47
       -
       

     

       48
       48
       -
       def encode_name_value_pair(name, value):

     

       49
       49
       -
           """Encode a name-value pair according to FastCGI spec."""

     

       50
       50
       -
           name_bytes = name.encode('utf-8')

     

       51
       51
       -
           value_bytes = value.encode('utf-8')

     

       52
       52
       -
           

     

       53
       53
       -
           name_len = len(name_bytes)

     

       54
       54
       -
           value_len = len(value_bytes)

     

       55
       55
       -
           

     

       56
       56
       -
           # Encode lengths

     

       57
       57
       -
           if name_len < 128:

     

       58
       58
       -
               name_len_encoded = struct.pack('B', name_len)

     

       59
       59
       -
           else:

     

       60
       60
       -
               name_len_encoded = struct.pack('>I', name_len | 0x80000000)

     

       61
       61
       -
           

     

       62
       62
       -
           if value_len < 128:

     

       63
       63
       -
               value_len_encoded = struct.pack('B', value_len)

     

       64
       64
       -
           else:

     

       65
       65
       -
               value_len_encoded = struct.pack('>I', value_len | 0x80000000)

     

       66
       66
       -
           

     

       67
       67
       -
           return name_len_encoded + value_len_encoded + name_bytes + value_bytes

     

       68
       68
       -
       

     

       69
       69
       -
       def create_begin_request():

     

       70
       70
       -
           """Create FCGI_BEGIN_REQUEST record."""

     

       71
       71
       -
           # FCGI_BeginRequestBody

     

       72
       72
       -
           body = struct.pack('>HB5x', FCGI_RESPONDER, FCGI_KEEP_CONN)

     

       73
       73
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 1, len(body))

     

       74
       74
       -
           return header + body

     

       75
       75
       -
       

     

       76
       76
       -
       def create_begin_request_no_keep_conn():

     

       77
       77
       -
           """Create FCGI_BEGIN_REQUEST record without keep connection."""

     

       78
       78
       -
           body = struct.pack('>HB5x', FCGI_RESPONDER, 0)

     

       79
       79
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 1, len(body))

     

       80
       80
       -
           return header + body

     

       81
       81
       -
       

     

       82
       82
       -
       def create_begin_request_authorizer():

     

       83
       83
       -
           """Create FCGI_BEGIN_REQUEST record for authorizer role."""

     

       84
       84
       -
           body = struct.pack('>HB5x', FCGI_AUTHORIZER, 0)

     

       85
       85
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 2, len(body))

     

       86
       86
       -
           return header + body

     

       87
       87
       -
       

     

       88
       88
       -
       def create_begin_request_filter():

     

       89
       89
       -
           """Create FCGI_BEGIN_REQUEST record for filter role."""

     

       90
       90
       -
           body = struct.pack('>HB5x', FCGI_FILTER, FCGI_KEEP_CONN)

     

       91
       91
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 3, len(body))

     

       92
       92
       -
           return header + body

     

       93
       93
       -
       

     

       94
       94
       -
       def create_end_request():

     

       95
       95
       -
           """Create FCGI_END_REQUEST record."""

     

       96
       96
       -
           # FCGI_EndRequestBody

     

       97
       97
       -
           body = struct.pack('>IB3x', 0, FCGI_REQUEST_COMPLETE)  # app_status=0, protocol_status=COMPLETE

     

       98
       98
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_END_REQUEST, 1, len(body))

     

       99
       99
       -
           return header + body

     

       100
       100
       -
       

     

       101
       101
       -
       def create_end_request_error():

     

       102
       102
       -
           """Create FCGI_END_REQUEST record with error status."""

     

       103
       103
       -
           body = struct.pack('>IB3x', 1, FCGI_REQUEST_COMPLETE)  # app_status=1 (error)

     

       104
       104
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_END_REQUEST, 1, len(body))

     

       105
       105
       -
           return header + body

     

       106
       106
       -
       

     

       107
       107
       -
       def create_params_record():

     

       108
       108
       -
           """Create FCGI_PARAMS record with CGI environment variables."""

     

       109
       109
       -
           # Typical CGI parameters

     

       110
       110
       -
           params = [

     

       111
       111
       -
               ("REQUEST_METHOD", "GET"),

     

       112
       112
       -
               ("SCRIPT_NAME", "/test.cgi"),

     

       113
       113
       -
               ("REQUEST_URI", "/test.cgi?foo=bar"),

     

       114
       114
       -
               ("QUERY_STRING", "foo=bar"),

     

       115
       115
       -
               ("SERVER_NAME", "localhost"),

     

       116
       116
       -
               ("SERVER_PORT", "80"),

     

       117
       117
       -
               ("HTTP_HOST", "localhost"),

     

       118
       118
       -
               ("HTTP_USER_AGENT", "Mozilla/5.0"),

     

       119
       119
       -
               ("CONTENT_TYPE", ""),

     

       120
       120
       -
               ("CONTENT_LENGTH", "0")

     

       121
       121
       -
           ]

     

       122
       122
       -
           

     

       123
       123
       -
           body = b''

     

       124
       124
       -
           for name, value in params:

     

       125
       125
       -
               body += encode_name_value_pair(name, value)

     

       126
       126
       -
           

     

       127
       127
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 1, len(body))

     

       128
       128
       -
           return header + body

     

       129
       129
       -
       

     

       130
       130
       -
       def create_params_record_post():

     

       131
       131
       -
           """Create FCGI_PARAMS record for POST request."""

     

       132
       132
       -
           params = [

     

       133
       133
       -
               ("REQUEST_METHOD", "POST"),

     

       134
       134
       -
               ("SCRIPT_NAME", "/form.cgi"),

     

       135
       135
       -
               ("REQUEST_URI", "/form.cgi"),

     

       136
       136
       -
               ("QUERY_STRING", ""),

     

       137
       137
       -
               ("SERVER_NAME", "localhost"),

     

       138
       138
       -
               ("SERVER_PORT", "443"),

     

       139
       139
       -
               ("HTTPS", "on"),

     

       140
       140
       -
               ("HTTP_HOST", "localhost"),

     

       141
       141
       -
               ("HTTP_USER_AGENT", "curl/7.68.0"),

     

       142
       142
       -
               ("CONTENT_TYPE", "application/x-www-form-urlencoded"),

     

       143
       143
       -
               ("CONTENT_LENGTH", "23")

     

       144
       144
       -
           ]

     

       145
       145
       -
           

     

       146
       146
       -
           body = b''

     

       147
       147
       -
           for name, value in params:

     

       148
       148
       -
               body += encode_name_value_pair(name, value)

     

       149
       149
       -
           

     

       150
       150
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 1, len(body))

     

       151
       151
       -
           return header + body

     

       152
       152
       -
       

     

       153
       153
       -
       def create_empty_params():

     

       154
       154
       -
           """Create empty FCGI_PARAMS record (end of params stream)."""

     

       155
       155
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 1, 0)

     

       156
       156
       -
           return header

     

       157
       157
       -
       

     

       158
       158
       -
       def create_stdin_record():

     

       159
       159
       -
           """Create FCGI_STDIN record with form data."""

     

       160
       160
       -
           data = b"name=John&email=john@example.com"

     

       161
       161
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDIN, 1, len(data))

     

       162
       162
       -
           return header + data

     

       163
       163
       -
       

     

       164
       164
       -
       def create_empty_stdin():

     

       165
       165
       -
           """Create empty FCGI_STDIN record (end of stdin stream)."""

     

       166
       166
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDIN, 1, 0)

     

       167
       167
       -
           return header

     

       168
       168
       -
       

     

       169
       169
       -
       def create_stdout_record():

     

       170
       170
       -
           """Create FCGI_STDOUT record with HTTP response."""

     

       171
       171
       -
           response = b"Content-Type: text/html\r\n\r\n<html><body>Hello World</body></html>"

     

       172
       172
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, len(response))

     

       173
       173
       -
           return header + response

     

       174
       174
       -
       

     

       175
       175
       -
       def create_empty_stdout():

     

       176
       176
       -
           """Create empty FCGI_STDOUT record (end of stdout stream)."""

     

       177
       177
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, 0)

     

       178
       178
       -
           return header

     

       179
       179
       -
       

     

       180
       180
       -
       def create_stderr_record():

     

       181
       181
       -
           """Create FCGI_STDERR record with error message."""

     

       182
       182
       -
           error_msg = b"Warning: Configuration file not found\n"

     

       183
       183
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDERR, 1, len(error_msg))

     

       184
       184
       -
           return header + error_msg

     

       185
       185
       -
       

     

       186
       186
       -
       def create_empty_stderr():

     

       187
       187
       -
           """Create empty FCGI_STDERR record (end of stderr stream)."""

     

       188
       188
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDERR, 1, 0)

     

       189
       189
       -
           return header

     

       190
       190
       -
       

     

       191
       191
       -
       def create_get_values():

     

       192
       192
       -
           """Create FCGI_GET_VALUES record."""

     

       193
       193
       -
           # Request standard capability variables

     

       194
       194
       -
           body = (encode_name_value_pair("FCGI_MAX_CONNS", "") +

     

       195
       195
       -
                   encode_name_value_pair("FCGI_MAX_REQS", "") +

     

       196
       196
       -
                   encode_name_value_pair("FCGI_MPXS_CONNS", ""))

     

       197
       197
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_GET_VALUES, 0, len(body))

     

       198
       198
       -
           return header + body

     

       199
       199
       -
       

     

       200
       200
       -
       def create_get_values_result():

     

       201
       201
       -
           """Create FCGI_GET_VALUES_RESULT record."""

     

       202
       202
       -
           body = (encode_name_value_pair("FCGI_MAX_CONNS", "1") +

     

       203
       203
       -
                   encode_name_value_pair("FCGI_MAX_REQS", "1") +

     

       204
       204
       -
                   encode_name_value_pair("FCGI_MPXS_CONNS", "0"))

     

       205
       205
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_GET_VALUES_RESULT, 0, len(body))

     

       206
       206
       -
           return header + body

     

       207
       207
       -
       

     

       208
       208
       -
       def create_unknown_type():

     

       209
       209
       -
           """Create FCGI_UNKNOWN_TYPE record."""

     

       210
       210
       -
           # FCGI_UnknownTypeBody

     

       211
       211
       -
           body = struct.pack('B7x', 99)  # unknown type 99

     

       212
       212
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_UNKNOWN_TYPE, 0, len(body))

     

       213
       213
       -
           return header + body

     

       214
       214
       -
       

     

       215
       215
       -
       def create_abort_request():

     

       216
       216
       -
           """Create FCGI_ABORT_REQUEST record."""

     

       217
       217
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_ABORT_REQUEST, 1, 0)

     

       218
       218
       -
           return header

     

       219
       219
       -
       

     

       220
       220
       -
       def create_data_record():

     

       221
       221
       -
           """Create FCGI_DATA record (for Filter role)."""

     

       222
       222
       -
           file_data = b"This is file content that needs to be filtered\nLine 2\nLine 3\n"

     

       223
       223
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_DATA, 3, len(file_data))

     

       224
       224
       -
           return header + file_data

     

       225
       225
       -
       

     

       226
       226
       -
       def create_empty_data():

     

       227
       227
       -
           """Create empty FCGI_DATA record (end of data stream)."""

     

       228
       228
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_DATA, 3, 0)

     

       229
       229
       -
           return header

     

       230
       230
       -
       

     

       231
       231
       -
       def create_multiplexed_records():

     

       232
       232
       -
           """Create a sequence showing multiplexed requests."""

     

       233
       233
       -
           records = []

     

       234
       234
       -
           

     

       235
       235
       -
           # Request 1 begins

     

       236
       236
       -
           records.append(create_begin_request())

     

       237
       237
       -
           records.append(create_params_record())

     

       238
       238
       -
           records.append(create_empty_params())

     

       239
       239
       -
           

     

       240
       240
       -
           # Request 2 begins (different request ID)

     

       241
       241
       -
           body = struct.pack('>HB5x', FCGI_RESPONDER, FCGI_KEEP_CONN)

     

       242
       242
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_BEGIN_REQUEST, 2, len(body))

     

       243
       243
       -
           records.append(header + body)

     

       244
       244
       -
           

     

       245
       245
       -
           # Request 1 continues

     

       246
       246
       -
           records.append(create_empty_stdin())

     

       247
       247
       -
           

     

       248
       248
       -
           # Request 2 params

     

       249
       249
       -
           params = [("REQUEST_METHOD", "POST"), ("SCRIPT_NAME", "/other.cgi")]

     

       250
       250
       -
           body = b''

     

       251
       251
       -
           for name, value in params:

     

       252
       252
       -
               body += encode_name_value_pair(name, value)

     

       253
       253
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 2, len(body))

     

       254
       254
       -
           records.append(header + body)

     

       255
       255
       -
           

     

       256
       256
       -
           # Request 2 empty params

     

       257
       257
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_PARAMS, 2, 0)

     

       258
       258
       -
           records.append(header)

     

       259
       259
       -
           

     

       260
       260
       -
           # Request 2 completes first

     

       261
       261
       -
           response = b"Content-Type: text/plain\r\n\r\nRequest 2 done"

     

       262
       262
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 2, len(response))

     

       263
       263
       -
           records.append(header + response)

     

       264
       264
       -
           

     

       265
       265
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 2, 0)

     

       266
       266
       -
           records.append(header)

     

       267
       267
       -
           

     

       268
       268
       -
           body = struct.pack('>IB3x', 0, FCGI_REQUEST_COMPLETE)

     

       269
       269
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_END_REQUEST, 2, len(body))

     

       270
       270
       -
           records.append(header + body)

     

       271
       271
       -
           

     

       272
       272
       -
           # Request 1 completes

     

       273
       273
       -
           response = b"Content-Type: text/html\r\n\r\n<html><body>Request 1 done</body></html>"

     

       274
       274
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, len(response))

     

       275
       275
       -
           records.append(header + response)

     

       276
       276
       -
           

     

       277
       277
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, 0)

     

       278
       278
       -
           records.append(header)

     

       279
       279
       -
           

     

       280
       280
       -
           body = struct.pack('>IB3x', 0, FCGI_REQUEST_COMPLETE)

     

       281
       281
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_END_REQUEST, 1, len(body))

     

       282
       282
       -
           records.append(header + body)

     

       283
       283
       -
           

     

       284
       284
       -
           return b''.join(records)

     

       285
       285
       -
       

     

       286
       286
       -
       def create_large_record():

     

       287
       287
       -
           """Create a record with maximum content size."""

     

       288
       288
       -
           # Create a large response (just under 64KB)

     

       289
       289
       -
           large_content = b"x" * 65000

     

       290
       290
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, len(large_content))

     

       291
       291
       -
           return header + large_content

     

       292
       292
       -
       

     

       293
       293
       -
       def create_padded_record():

     

       294
       294
       -
           """Create a record with padding for alignment."""

     

       295
       295
       -
           data = b"Hello"  # 5 bytes

     

       296
       296
       -
           padding_length = 3  # to align to 8-byte boundary (5 + 3 = 8)

     

       297
       297
       -
           header = create_record_header(FCGI_VERSION_1, FCGI_STDOUT, 1, len(data), padding_length)

     

       298
       298
       -
           padding = b'\x00' * padding_length

     

       299
       299
       -
           return header + data + padding

     

       300
       300
       -
       

     

       301
       301
       -
       # Test case definitions

     

       302
       302
       -
       test_cases = {

     

       303
       303
       -
           "begin_request_responder.bin": create_begin_request,

     

       304
       304
       -
           "begin_request_no_keep.bin": create_begin_request_no_keep_conn,

     

       305
       305
       -
           "begin_request_authorizer.bin": create_begin_request_authorizer,

     

       306
       306
       -
           "begin_request_filter.bin": create_begin_request_filter,

     

       307
       307
       -
           "end_request_success.bin": create_end_request,

     

       308
       308
       -
           "end_request_error.bin": create_end_request_error,

     

       309
       309
       -
           "params_get.bin": create_params_record,

     

       310
       310
       -
           "params_post.bin": create_params_record_post,

     

       311
       311
       -
           "params_empty.bin": create_empty_params,

     

       312
       312
       -
           "stdin_form_data.bin": create_stdin_record,

     

       313
       313
       -
           "stdin_empty.bin": create_empty_stdin,

     

       314
       314
       -
           "stdout_response.bin": create_stdout_record,

     

       315
       315
       -
           "stdout_empty.bin": create_empty_stdout,

     

       316
       316
       -
           "stderr_message.bin": create_stderr_record,

     

       317
       317
       -
           "stderr_empty.bin": create_empty_stderr,

     

       318
       318
       -
           "get_values.bin": create_get_values,

     

       319
       319
       -
           "get_values_result.bin": create_get_values_result,

     

       320
       320
       -
           "unknown_type.bin": create_unknown_type,

     

       321
       321
       -
           "abort_request.bin": create_abort_request,

     

       322
       322
       -
           "data_filter.bin": create_data_record,

     

       323
       323
       -
           "data_empty.bin": create_empty_data,

     

       324
       324
       -
           "multiplexed_requests.bin": create_multiplexed_records,

     

       325
       325
       -
           "large_record.bin": create_large_record,

     

       326
       326
       -
           "padded_record.bin": create_padded_record,

     

       327
       327
       -
       }

     

       328
       328
       -
       

     

       329
       329
       -
       if __name__ == "__main__":

     

       330
       330
       -
           for filename, creator in test_cases.items():

     

       331
       331
       -
               with open(filename, 'wb') as f:

     

       332
       332
       -
                   f.write(creator())

     

       333
       333
       -
               print(f"Created {filename}")

     

       334
       334
       -
           

     

       335
       335
       -
           print(f"\nGenerated {len(test_cases)} test case files")

     

       336
       336
       -
           print("\nTest case descriptions:")

     

       337
       337
       -
           print("- begin_request_*.bin: Various BEGIN_REQUEST records for different roles")

     

       338
       338
       -
           print("- end_request_*.bin: END_REQUEST records with different status codes")

     

       339
       339
       -
           print("- params_*.bin: PARAMS records with CGI environment variables")

     

       340
       340
       -
           print("- stdin_*.bin: STDIN records with request body data")

     

       341
       341
       -
           print("- stdout_*.bin: STDOUT records with response data")

     

       342
       342
       -
           print("- stderr_*.bin: STDERR records with error messages")

     

       343
       343
       -
           print("- get_values*.bin: Management records for capability negotiation")

     

       344
       344
       -
           print("- unknown_type.bin: Unknown record type handling")

     

       345
       345
       -
           print("- abort_request.bin: Request abortion")

     

       346
       346
       -
           print("- data_*.bin: DATA records for Filter role")

     

       347
       347
       -
           print("- multiplexed_requests.bin: Multiple concurrent requests")

     

       348
       348
       -
           print("- large_record.bin: Maximum size record")

     

       349
       349
       -
           print("- padded_record.bin: Record with padding for alignment")

test_cases/get_values.bin

This is a binary file and will not be displayed.

test_cases/get_values_result.bin

This is a binary file and will not be displayed.

test_cases/large_record.bin

This is a binary file and will not be displayed.

test_cases/multiplexed_requests.bin

This is a binary file and will not be displayed.

test_cases/padded_record.bin

This is a binary file and will not be displayed.

test_cases/params_empty.bin

This is a binary file and will not be displayed.

test_cases/params_get.bin

This is a binary file and will not be displayed.

test_cases/params_post.bin

This is a binary file and will not be displayed.

test_cases/stderr_empty.bin

This is a binary file and will not be displayed.

test_cases/stderr_message.bin

This is a binary file and will not be displayed.

test_cases/stdin_empty.bin

This is a binary file and will not be displayed.

test_cases/stdin_form_data.bin

This is a binary file and will not be displayed.

test_cases/stdout_empty.bin

This is a binary file and will not be displayed.

test_cases/stdout_response.bin

This is a binary file and will not be displayed.

-24

test_cases/test_case_sizes.txt

···

       1
       1
       -
       abort_request.bin	8 bytes

     

       2
       2
       -
       begin_request_authorizer.bin	16 bytes

     

       3
       3
       -
       begin_request_filter.bin	16 bytes

     

       4
       4
       -
       begin_request_no_keep.bin	16 bytes

     

       5
       5
       -
       begin_request_responder.bin	16 bytes

     

       6
       6
       -
       data_empty.bin	8 bytes

     

       7
       7
       -
       data_filter.bin	69 bytes

     

       8
       8
       -
       end_request_error.bin	16 bytes

     

       9
       9
       -
       end_request_success.bin	16 bytes

     

       10
       10
       -
       get_values_result.bin	59 bytes

     

       11
       11
       -
       get_values.bin	56 bytes

     

       12
       12
       -
       large_record.bin	65008 bytes

     

       13
       13
       -
       multiplexed_requests.bin	496 bytes

     

       14
       14
       -
       padded_record.bin	16 bytes

     

       15
       15
       -
       params_empty.bin	8 bytes

     

       16
       16
       -
       params_get.bin	216 bytes

     

       17
       17
       -
       params_post.bin	246 bytes

     

       18
       18
       -
       stderr_empty.bin	8 bytes

     

       19
       19
       -
       stderr_message.bin	46 bytes

     

       20
       20
       -
       stdin_empty.bin	8 bytes

     

       21
       21
       -
       stdin_form_data.bin	40 bytes

     

       22
       22
       -
       stdout_empty.bin	8 bytes

     

       23
       23
       -
       stdout_response.bin	72 bytes

     

       24
       24
       -
       unknown_type.bin	16 bytes

test_cases/unknown_type.bin

This is a binary file and will not be displayed.

-130

test_cases/validate_test_cases.py

···

       1
       1
       -
       #!/usr/bin/env python3

     

       2
       2
       -
       """

     

       3
       3
       -
       Validate that the generated FastCGI test cases are properly formatted.

     

       4
       4
       -
       """

     

       5
       5
       -
       import struct

     

       6
       6
       -
       import os

     

       7
       7
       -
       import glob

     

       8
       8
       -
       

     

       9
       9
       -
       def parse_record_header(data):

     

       10
       10
       -
           """Parse a FastCGI record header."""

     

       11
       11
       -
           if len(data) < 8:

     

       12
       12
       -
               return None

     

       13
       13
       -
           

     

       14
       14
       -
           version, record_type, request_id, content_length, padding_length, reserved = struct.unpack('>BBHHBB', data[:8])

     

       15
       15
       -
           return {

     

       16
       16
       -
               'version': version,

     

       17
       17
       -
               'type': record_type,

     

       18
       18
       -
               'request_id': request_id,

     

       19
       19
       -
               'content_length': content_length,

     

       20
       20
       -
               'padding_length': padding_length,

     

       21
       21
       -
               'reserved': reserved,

     

       22
       22
       -
               'total_length': 8 + content_length + padding_length

     

       23
       23
       -
           }

     

       24
       24
       -
       

     

       25
       25
       -
       def validate_file(filename):

     

       26
       26
       -
           """Validate a single test case file."""

     

       27
       27
       -
           print(f"\nValidating {filename}:")

     

       28
       28
       -
           

     

       29
       29
       -
           with open(filename, 'rb') as f:

     

       30
       30
       -
               data = f.read()

     

       31
       31
       -
           

     

       32
       32
       -
           if len(data) < 8:

     

       33
       33
       -
               print(f"  ❌ File too short: {len(data)} bytes")

     

       34
       34
       -
               return False

     

       35
       35
       -
           

     

       36
       36
       -
           # Parse all records in the file

     

       37
       37
       -
           offset = 0

     

       38
       38
       -
           record_count = 0

     

       39
       39
       -
           

     

       40
       40
       -
           while offset < len(data):

     

       41
       41
       -
               if offset + 8 > len(data):

     

       42
       42
       -
                   print(f"  ❌ Incomplete header at offset {offset}")

     

       43
       43
       -
                   return False

     

       44
       44
       -
               

     

       45
       45
       -
               header = parse_record_header(data[offset:])

     

       46
       46
       -
               if not header:

     

       47
       47
       -
                   print(f"  ❌ Failed to parse header at offset {offset}")

     

       48
       48
       -
                   return False

     

       49
       49
       -
               

     

       50
       50
       -
               record_count += 1

     

       51
       51
       -
               print(f"  Record {record_count}:")

     

       52
       52
       -
               print(f"    Version: {header['version']}")

     

       53
       53
       -
               print(f"    Type: {header['type']}")

     

       54
       54
       -
               print(f"    Request ID: {header['request_id']}")

     

       55
       55
       -
               print(f"    Content Length: {header['content_length']}")

     

       56
       56
       -
               print(f"    Padding Length: {header['padding_length']}")

     

       57
       57
       -
               print(f"    Reserved: {header['reserved']}")

     

       58
       58
       -
               

     

       59
       59
       -
               # Validate header fields

     

       60
       60
       -
               if header['version'] != 1:

     

       61
       61
       -
                   print(f"    ❌ Invalid version: {header['version']}")

     

       62
       62
       -
                   return False

     

       63
       63
       -
               

     

       64
       64
       -
               if header['type'] < 1 or header['type'] > 11:

     

       65
       65
       -
                   print(f"    ❌ Invalid record type: {header['type']}")

     

       66
       66
       -
                   return False

     

       67
       67
       -
               

     

       68
       68
       -
               if header['reserved'] != 0:

     

       69
       69
       -
                   print(f"    ❌ Reserved field not zero: {header['reserved']}")

     

       70
       70
       -
                   return False

     

       71
       71
       -
               

     

       72
       72
       -
               # Check if we have enough data for content and padding

     

       73
       73
       -
               expected_end = offset + header['total_length']

     

       74
       74
       -
               if expected_end > len(data):

     

       75
       75
       -
                   print(f"    ❌ Not enough data: need {header['total_length']}, have {len(data) - offset}")

     

       76
       76
       -
                   return False

     

       77
       77
       -
               

     

       78
       78
       -
               # Extract content

     

       79
       79
       -
               content_start = offset + 8

     

       80
       80
       -
               content_end = content_start + header['content_length']

     

       81
       81
       -
               content = data[content_start:content_end]

     

       82
       82
       -
               

     

       83
       83
       -
               # Extract padding

     

       84
       84
       -
               padding_start = content_end

     

       85
       85
       -
               padding_end = padding_start + header['padding_length']

     

       86
       86
       -
               padding = data[padding_start:padding_end]

     

       87
       87
       -
               

     

       88
       88
       -
               print(f"    Content: {len(content)} bytes")

     

       89
       89
       -
               if header['padding_length'] > 0:

     

       90
       90
       -
                   print(f"    Padding: {len(padding)} bytes")

     

       91
       91
       -
               

     

       92
       92
       -
               # Show content preview for small records

     

       93
       93
       -
               if len(content) <= 32:

     

       94
       94
       -
                   print(f"    Content hex: {content.hex()}")

     

       95
       95
       -
               else:

     

       96
       96
       -
                   print(f"    Content preview: {content[:16].hex()}...")

     

       97
       97
       -
               

     

       98
       98
       -
               print(f"    ✅ Record valid")

     

       99
       99
       -
               

     

       100
       100
       -
               offset = expected_end

     

       101
       101
       -
           

     

       102
       102
       -
           print(f"  ✅ File valid: {record_count} record(s), {len(data)} total bytes")

     

       103
       103
       -
           return True

     

       104
       104
       -
       

     

       105
       105
       -
       def main():

     

       106
       106
       -
           """Validate all test case files."""

     

       107
       107
       -
           test_files = glob.glob("*.bin")

     

       108
       108
       -
           test_files.sort()

     

       109
       109
       -
           

     

       110
       110
       -
           print(f"Found {len(test_files)} test case files")

     

       111
       111
       -
           

     

       112
       112
       -
           valid_count = 0

     

       113
       113
       -
           for filename in test_files:

     

       114
       114
       -
               if validate_file(filename):

     

       115
       115
       -
                   valid_count += 1

     

       116
       116
       -
           

     

       117
       117
       -
           print(f"\n{'='*50}")

     

       118
       118
       -
           print(f"Validation complete: {valid_count}/{len(test_files)} files valid")

     

       119
       119
       -
           

     

       120
       120
       -
           if valid_count == len(test_files):

     

       121
       121
       -
               print("✅ All test cases are valid!")

     

       122
       122
       -
           else:

     

       123
       123
       -
               print("❌ Some test cases failed validation")

     

       124
       124
       -
               return 1

     

       125
       125
       -
           

     

       126
       126
       -
           return 0

     

       127
       127
       -
       

     

       128
       128
       -
       if __name__ == "__main__":

     

       129
       129
       -
           import sys

     

       130
       130
       -
           sys.exit(main())

-438

test_cases/validation_results.txt

···

       1
       1
       -
       Found 24 test case files

     

       2
       2
       -
       

     

       3
       3
       -
       Validating abort_request.bin:

     

       4
       4
       -
         Record 1:

     

       5
       5
       -
           Version: 1

     

       6
       6
       -
           Type: 2

     

       7
       7
       -
           Request ID: 1

     

       8
       8
       -
           Content Length: 0

     

       9
       9
       -
           Padding Length: 0

     

       10
       10
       -
           Reserved: 0

     

       11
       11
       -
           Content: 0 bytes

     

       12
       12
       -
           Content hex: 

     

       13
       13
       -
           ✅ Record valid

     

       14
       14
       -
         ✅ File valid: 1 record(s), 8 total bytes

     

       15
       15
       -
       

     

       16
       16
       -
       Validating begin_request_authorizer.bin:

     

       17
       17
       -
         Record 1:

     

       18
       18
       -
           Version: 1

     

       19
       19
       -
           Type: 1

     

       20
       20
       -
           Request ID: 2

     

       21
       21
       -
           Content Length: 8

     

       22
       22
       -
           Padding Length: 0

     

       23
       23
       -
           Reserved: 0

     

       24
       24
       -
           Content: 8 bytes

     

       25
       25
       -
           Content hex: 0002000000000000

     

       26
       26
       -
           ✅ Record valid

     

       27
       27
       -
         ✅ File valid: 1 record(s), 16 total bytes

     

       28
       28
       -
       

     

       29
       29
       -
       Validating begin_request_filter.bin:

     

       30
       30
       -
         Record 1:

     

       31
       31
       -
           Version: 1

     

       32
       32
       -
           Type: 1

     

       33
       33
       -
           Request ID: 3

     

       34
       34
       -
           Content Length: 8

     

       35
       35
       -
           Padding Length: 0

     

       36
       36
       -
           Reserved: 0

     

       37
       37
       -
           Content: 8 bytes

     

       38
       38
       -
           Content hex: 0003010000000000

     

       39
       39
       -
           ✅ Record valid

     

       40
       40
       -
         ✅ File valid: 1 record(s), 16 total bytes

     

       41
       41
       -
       

     

       42
       42
       -
       Validating begin_request_no_keep.bin:

     

       43
       43
       -
         Record 1:

     

       44
       44
       -
           Version: 1

     

       45
       45
       -
           Type: 1

     

       46
       46
       -
           Request ID: 1

     

       47
       47
       -
           Content Length: 8

     

       48
       48
       -
           Padding Length: 0

     

       49
       49
       -
           Reserved: 0

     

       50
       50
       -
           Content: 8 bytes

     

       51
       51
       -
           Content hex: 0001000000000000

     

       52
       52
       -
           ✅ Record valid

     

       53
       53
       -
         ✅ File valid: 1 record(s), 16 total bytes

     

       54
       54
       -
       

     

       55
       55
       -
       Validating begin_request_responder.bin:

     

       56
       56
       -
         Record 1:

     

       57
       57
       -
           Version: 1

     

       58
       58
       -
           Type: 1

     

       59
       59
       -
           Request ID: 1

     

       60
       60
       -
           Content Length: 8

     

       61
       61
       -
           Padding Length: 0

     

       62
       62
       -
           Reserved: 0

     

       63
       63
       -
           Content: 8 bytes

     

       64
       64
       -
           Content hex: 0001010000000000

     

       65
       65
       -
           ✅ Record valid

     

       66
       66
       -
         ✅ File valid: 1 record(s), 16 total bytes

     

       67
       67
       -
       

     

       68
       68
       -
       Validating data_empty.bin:

     

       69
       69
       -
         Record 1:

     

       70
       70
       -
           Version: 1

     

       71
       71
       -
           Type: 8

     

       72
       72
       -
           Request ID: 3

     

       73
       73
       -
           Content Length: 0

     

       74
       74
       -
           Padding Length: 0

     

       75
       75
       -
           Reserved: 0

     

       76
       76
       -
           Content: 0 bytes

     

       77
       77
       -
           Content hex: 

     

       78
       78
       -
           ✅ Record valid

     

       79
       79
       -
         ✅ File valid: 1 record(s), 8 total bytes

     

       80
       80
       -
       

     

       81
       81
       -
       Validating data_filter.bin:

     

       82
       82
       -
         Record 1:

     

       83
       83
       -
           Version: 1

     

       84
       84
       -
           Type: 8

     

       85
       85
       -
           Request ID: 3

     

       86
       86
       -
           Content Length: 61

     

       87
       87
       -
           Padding Length: 0

     

       88
       88
       -
           Reserved: 0

     

       89
       89
       -
           Content: 61 bytes

     

       90
       90
       -
           Content preview: 546869732069732066696c6520636f6e...

     

       91
       91
       -
           ✅ Record valid

     

       92
       92
       -
         ✅ File valid: 1 record(s), 69 total bytes

     

       93
       93
       -
       

     

       94
       94
       -
       Validating end_request_error.bin:

     

       95
       95
       -
         Record 1:

     

       96
       96
       -
           Version: 1

     

       97
       97
       -
           Type: 3

     

       98
       98
       -
           Request ID: 1

     

       99
       99
       -
           Content Length: 8

     

       100
       100
       -
           Padding Length: 0

     

       101
       101
       -
           Reserved: 0

     

       102
       102
       -
           Content: 8 bytes

     

       103
       103
       -
           Content hex: 0000000100000000

     

       104
       104
       -
           ✅ Record valid

     

       105
       105
       -
         ✅ File valid: 1 record(s), 16 total bytes

     

       106
       106
       -
       

     

       107
       107
       -
       Validating end_request_success.bin:

     

       108
       108
       -
         Record 1:

     

       109
       109
       -
           Version: 1

     

       110
       110
       -
           Type: 3

     

       111
       111
       -
           Request ID: 1

     

       112
       112
       -
           Content Length: 8

     

       113
       113
       -
           Padding Length: 0

     

       114
       114
       -
           Reserved: 0

     

       115
       115
       -
           Content: 8 bytes

     

       116
       116
       -
           Content hex: 0000000000000000

     

       117
       117
       -
           ✅ Record valid

     

       118
       118
       -
         ✅ File valid: 1 record(s), 16 total bytes

     

       119
       119
       -
       

     

       120
       120
       -
       Validating get_values.bin:

     

       121
       121
       -
         Record 1:

     

       122
       122
       -
           Version: 1

     

       123
       123
       -
           Type: 9

     

       124
       124
       -
           Request ID: 0

     

       125
       125
       -
           Content Length: 48

     

       126
       126
       -
           Padding Length: 0

     

       127
       127
       -
           Reserved: 0

     

       128
       128
       -
           Content: 48 bytes

     

       129
       129
       -
           Content preview: 0e00464347495f4d41585f434f4e4e53...

     

       130
       130
       -
           ✅ Record valid

     

       131
       131
       -
         ✅ File valid: 1 record(s), 56 total bytes

     

       132
       132
       -
       

     

       133
       133
       -
       Validating get_values_result.bin:

     

       134
       134
       -
         Record 1:

     

       135
       135
       -
           Version: 1

     

       136
       136
       -
           Type: 10

     

       137
       137
       -
           Request ID: 0

     

       138
       138
       -
           Content Length: 51

     

       139
       139
       -
           Padding Length: 0

     

       140
       140
       -
           Reserved: 0

     

       141
       141
       -
           Content: 51 bytes

     

       142
       142
       -
           Content preview: 0e01464347495f4d41585f434f4e4e53...

     

       143
       143
       -
           ✅ Record valid

     

       144
       144
       -
         ✅ File valid: 1 record(s), 59 total bytes

     

       145
       145
       -
       

     

       146
       146
       -
       Validating large_record.bin:

     

       147
       147
       -
         Record 1:

     

       148
       148
       -
           Version: 1

     

       149
       149
       -
           Type: 6

     

       150
       150
       -
           Request ID: 1

     

       151
       151
       -
           Content Length: 65000

     

       152
       152
       -
           Padding Length: 0

     

       153
       153
       -
           Reserved: 0

     

       154
       154
       -
           Content: 65000 bytes

     

       155
       155
       -
           Content preview: 78787878787878787878787878787878...

     

       156
       156
       -
           ✅ Record valid

     

       157
       157
       -
         ✅ File valid: 1 record(s), 65008 total bytes

     

       158
       158
       -
       

     

       159
       159
       -
       Validating multiplexed_requests.bin:

     

       160
       160
       -
         Record 1:

     

       161
       161
       -
           Version: 1

     

       162
       162
       -
           Type: 1

     

       163
       163
       -
           Request ID: 1

     

       164
       164
       -
           Content Length: 8

     

       165
       165
       -
           Padding Length: 0

     

       166
       166
       -
           Reserved: 0

     

       167
       167
       -
           Content: 8 bytes

     

       168
       168
       -
           Content hex: 0001010000000000

     

       169
       169
       -
           ✅ Record valid

     

       170
       170
       -
         Record 2:

     

       171
       171
       -
           Version: 1

     

       172
       172
       -
           Type: 4

     

       173
       173
       -
           Request ID: 1

     

       174
       174
       -
           Content Length: 208

     

       175
       175
       -
           Padding Length: 0

     

       176
       176
       -
           Reserved: 0

     

       177
       177
       -
           Content: 208 bytes

     

       178
       178
       -
           Content preview: 0e03524551554553545f4d4554484f44...

     

       179
       179
       -
           ✅ Record valid

     

       180
       180
       -
         Record 3:

     

       181
       181
       -
           Version: 1

     

       182
       182
       -
           Type: 4

     

       183
       183
       -
           Request ID: 1

     

       184
       184
       -
           Content Length: 0

     

       185
       185
       -
           Padding Length: 0

     

       186
       186
       -
           Reserved: 0

     

       187
       187
       -
           Content: 0 bytes

     

       188
       188
       -
           Content hex: 

     

       189
       189
       -
           ✅ Record valid

     

       190
       190
       -
         Record 4:

     

       191
       191
       -
           Version: 1

     

       192
       192
       -
           Type: 1

     

       193
       193
       -
           Request ID: 2

     

       194
       194
       -
           Content Length: 8

     

       195
       195
       -
           Padding Length: 0

     

       196
       196
       -
           Reserved: 0

     

       197
       197
       -
           Content: 8 bytes

     

       198
       198
       -
           Content hex: 0001010000000000

     

       199
       199
       -
           ✅ Record valid

     

       200
       200
       -
         Record 5:

     

       201
       201
       -
           Version: 1

     

       202
       202
       -
           Type: 5

     

       203
       203
       -
           Request ID: 1

     

       204
       204
       -
           Content Length: 0

     

       205
       205
       -
           Padding Length: 0

     

       206
       206
       -
           Reserved: 0

     

       207
       207
       -
           Content: 0 bytes

     

       208
       208
       -
           Content hex: 

     

       209
       209
       -
           ✅ Record valid

     

       210
       210
       -
         Record 6:

     

       211
       211
       -
           Version: 1

     

       212
       212
       -
           Type: 4

     

       213
       213
       -
           Request ID: 2

     

       214
       214
       -
           Content Length: 43

     

       215
       215
       -
           Padding Length: 0

     

       216
       216
       -
           Reserved: 0

     

       217
       217
       -
           Content: 43 bytes

     

       218
       218
       -
           Content preview: 0e04524551554553545f4d4554484f44...

     

       219
       219
       -
           ✅ Record valid

     

       220
       220
       -
         Record 7:

     

       221
       221
       -
           Version: 1

     

       222
       222
       -
           Type: 4

     

       223
       223
       -
           Request ID: 2

     

       224
       224
       -
           Content Length: 0

     

       225
       225
       -
           Padding Length: 0

     

       226
       226
       -
           Reserved: 0

     

       227
       227
       -
           Content: 0 bytes

     

       228
       228
       -
           Content hex: 

     

       229
       229
       -
           ✅ Record valid

     

       230
       230
       -
         Record 8:

     

       231
       231
       -
           Version: 1

     

       232
       232
       -
           Type: 6

     

       233
       233
       -
           Request ID: 2

     

       234
       234
       -
           Content Length: 42

     

       235
       235
       -
           Padding Length: 0

     

       236
       236
       -
           Reserved: 0

     

       237
       237
       -
           Content: 42 bytes

     

       238
       238
       -
           Content preview: 436f6e74656e742d547970653a207465...

     

       239
       239
       -
           ✅ Record valid

     

       240
       240
       -
         Record 9:

     

       241
       241
       -
           Version: 1

     

       242
       242
       -
           Type: 6

     

       243
       243
       -
           Request ID: 2

     

       244
       244
       -
           Content Length: 0

     

       245
       245
       -
           Padding Length: 0

     

       246
       246
       -
           Reserved: 0

     

       247
       247
       -
           Content: 0 bytes

     

       248
       248
       -
           Content hex: 

     

       249
       249
       -
           ✅ Record valid

     

       250
       250
       -
         Record 10:

     

       251
       251
       -
           Version: 1

     

       252
       252
       -
           Type: 3

     

       253
       253
       -
           Request ID: 2

     

       254
       254
       -
           Content Length: 8

     

       255
       255
       -
           Padding Length: 0

     

       256
       256
       -
           Reserved: 0

     

       257
       257
       -
           Content: 8 bytes

     

       258
       258
       -
           Content hex: 0000000000000000

     

       259
       259
       -
           ✅ Record valid

     

       260
       260
       -
         Record 11:

     

       261
       261
       -
           Version: 1

     

       262
       262
       -
           Type: 6

     

       263
       263
       -
           Request ID: 1

     

       264
       264
       -
           Content Length: 67

     

       265
       265
       -
           Padding Length: 0

     

       266
       266
       -
           Reserved: 0

     

       267
       267
       -
           Content: 67 bytes

     

       268
       268
       -
           Content preview: 436f6e74656e742d547970653a207465...

     

       269
       269
       -
           ✅ Record valid

     

       270
       270
       -
         Record 12:

     

       271
       271
       -
           Version: 1

     

       272
       272
       -
           Type: 6

     

       273
       273
       -
           Request ID: 1

     

       274
       274
       -
           Content Length: 0

     

       275
       275
       -
           Padding Length: 0

     

       276
       276
       -
           Reserved: 0

     

       277
       277
       -
           Content: 0 bytes

     

       278
       278
       -
           Content hex: 

     

       279
       279
       -
           ✅ Record valid

     

       280
       280
       -
         Record 13:

     

       281
       281
       -
           Version: 1

     

       282
       282
       -
           Type: 3

     

       283
       283
       -
           Request ID: 1

     

       284
       284
       -
           Content Length: 8

     

       285
       285
       -
           Padding Length: 0

     

       286
       286
       -
           Reserved: 0

     

       287
       287
       -
           Content: 8 bytes

     

       288
       288
       -
           Content hex: 0000000000000000

     

       289
       289
       -
           ✅ Record valid

     

       290
       290
       -
         ✅ File valid: 13 record(s), 496 total bytes

     

       291
       291
       -
       

     

       292
       292
       -
       Validating padded_record.bin:

     

       293
       293
       -
         Record 1:

     

       294
       294
       -
           Version: 1

     

       295
       295
       -
           Type: 6

     

       296
       296
       -
           Request ID: 1

     

       297
       297
       -
           Content Length: 5

     

       298
       298
       -
           Padding Length: 3

     

       299
       299
       -
           Reserved: 0

     

       300
       300
       -
           Content: 5 bytes

     

       301
       301
       -
           Padding: 3 bytes

     

       302
       302
       -
           Content hex: 48656c6c6f

     

       303
       303
       -
           ✅ Record valid

     

       304
       304
       -
         ✅ File valid: 1 record(s), 16 total bytes

     

       305
       305
       -
       

     

       306
       306
       -
       Validating params_empty.bin:

     

       307
       307
       -
         Record 1:

     

       308
       308
       -
           Version: 1

     

       309
       309
       -
           Type: 4

     

       310
       310
       -
           Request ID: 1

     

       311
       311
       -
           Content Length: 0

     

       312
       312
       -
           Padding Length: 0

     

       313
       313
       -
           Reserved: 0

     

       314
       314
       -
           Content: 0 bytes

     

       315
       315
       -
           Content hex: 

     

       316
       316
       -
           ✅ Record valid

     

       317
       317
       -
         ✅ File valid: 1 record(s), 8 total bytes

     

       318
       318
       -
       

     

       319
       319
       -
       Validating params_get.bin:

     

       320
       320
       -
         Record 1:

     

       321
       321
       -
           Version: 1

     

       322
       322
       -
           Type: 4

     

       323
       323
       -
           Request ID: 1

     

       324
       324
       -
           Content Length: 208

     

       325
       325
       -
           Padding Length: 0

     

       326
       326
       -
           Reserved: 0

     

       327
       327
       -
           Content: 208 bytes

     

       328
       328
       -
           Content preview: 0e03524551554553545f4d4554484f44...

     

       329
       329
       -
           ✅ Record valid

     

       330
       330
       -
         ✅ File valid: 1 record(s), 216 total bytes

     

       331
       331
       -
       

     

       332
       332
       -
       Validating params_post.bin:

     

       333
       333
       -
         Record 1:

     

       334
       334
       -
           Version: 1

     

       335
       335
       -
           Type: 4

     

       336
       336
       -
           Request ID: 1

     

       337
       337
       -
           Content Length: 238

     

       338
       338
       -
           Padding Length: 0

     

       339
       339
       -
           Reserved: 0

     

       340
       340
       -
           Content: 238 bytes

     

       341
       341
       -
           Content preview: 0e04524551554553545f4d4554484f44...

     

       342
       342
       -
           ✅ Record valid

     

       343
       343
       -
         ✅ File valid: 1 record(s), 246 total bytes

     

       344
       344
       -
       

     

       345
       345
       -
       Validating stderr_empty.bin:

     

       346
       346
       -
         Record 1:

     

       347
       347
       -
           Version: 1

     

       348
       348
       -
           Type: 7

     

       349
       349
       -
           Request ID: 1

     

       350
       350
       -
           Content Length: 0

     

       351
       351
       -
           Padding Length: 0

     

       352
       352
       -
           Reserved: 0

     

       353
       353
       -
           Content: 0 bytes

     

       354
       354
       -
           Content hex: 

     

       355
       355
       -
           ✅ Record valid

     

       356
       356
       -
         ✅ File valid: 1 record(s), 8 total bytes

     

       357
       357
       -
       

     

       358
       358
       -
       Validating stderr_message.bin:

     

       359
       359
       -
         Record 1:

     

       360
       360
       -
           Version: 1

     

       361
       361
       -
           Type: 7

     

       362
       362
       -
           Request ID: 1

     

       363
       363
       -
           Content Length: 38

     

       364
       364
       -
           Padding Length: 0

     

       365
       365
       -
           Reserved: 0

     

       366
       366
       -
           Content: 38 bytes

     

       367
       367
       -
           Content preview: 5761726e696e673a20436f6e66696775...

     

       368
       368
       -
           ✅ Record valid

     

       369
       369
       -
         ✅ File valid: 1 record(s), 46 total bytes

     

       370
       370
       -
       

     

       371
       371
       -
       Validating stdin_empty.bin:

     

       372
       372
       -
         Record 1:

     

       373
       373
       -
           Version: 1

     

       374
       374
       -
           Type: 5

     

       375
       375
       -
           Request ID: 1

     

       376
       376
       -
           Content Length: 0

     

       377
       377
       -
           Padding Length: 0

     

       378
       378
       -
           Reserved: 0

     

       379
       379
       -
           Content: 0 bytes

     

       380
       380
       -
           Content hex: 

     

       381
       381
       -
           ✅ Record valid

     

       382
       382
       -
         ✅ File valid: 1 record(s), 8 total bytes

     

       383
       383
       -
       

     

       384
       384
       -
       Validating stdin_form_data.bin:

     

       385
       385
       -
         Record 1:

     

       386
       386
       -
           Version: 1

     

       387
       387
       -
           Type: 5

     

       388
       388
       -
           Request ID: 1

     

       389
       389
       -
           Content Length: 32

     

       390
       390
       -
           Padding Length: 0

     

       391
       391
       -
           Reserved: 0

     

       392
       392
       -
           Content: 32 bytes

     

       393
       393
       -
           Content hex: 6e616d653d4a6f686e26656d61696c3d6a6f686e406578616d706c652e636f6d

     

       394
       394
       -
           ✅ Record valid

     

       395
       395
       -
         ✅ File valid: 1 record(s), 40 total bytes

     

       396
       396
       -
       

     

       397
       397
       -
       Validating stdout_empty.bin:

     

       398
       398
       -
         Record 1:

     

       399
       399
       -
           Version: 1

     

       400
       400
       -
           Type: 6

     

       401
       401
       -
           Request ID: 1

     

       402
       402
       -
           Content Length: 0

     

       403
       403
       -
           Padding Length: 0

     

       404
       404
       -
           Reserved: 0

     

       405
       405
       -
           Content: 0 bytes

     

       406
       406
       -
           Content hex: 

     

       407
       407
       -
           ✅ Record valid

     

       408
       408
       -
         ✅ File valid: 1 record(s), 8 total bytes

     

       409
       409
       -
       

     

       410
       410
       -
       Validating stdout_response.bin:

     

       411
       411
       -
         Record 1:

     

       412
       412
       -
           Version: 1

     

       413
       413
       -
           Type: 6

     

       414
       414
       -
           Request ID: 1

     

       415
       415
       -
           Content Length: 64

     

       416
       416
       -
           Padding Length: 0

     

       417
       417
       -
           Reserved: 0

     

       418
       418
       -
           Content: 64 bytes

     

       419
       419
       -
           Content preview: 436f6e74656e742d547970653a207465...

     

       420
       420
       -
           ✅ Record valid

     

       421
       421
       -
         ✅ File valid: 1 record(s), 72 total bytes

     

       422
       422
       -
       

     

       423
       423
       -
       Validating unknown_type.bin:

     

       424
       424
       -
         Record 1:

     

       425
       425
       -
           Version: 1

     

       426
       426
       -
           Type: 11

     

       427
       427
       -
           Request ID: 0

     

       428
       428
       -
           Content Length: 8

     

       429
       429
       -
           Padding Length: 0

     

       430
       430
       -
           Reserved: 0

     

       431
       431
       -
           Content: 8 bytes

     

       432
       432
       -
           Content hex: 6300000000000000

     

       433
       433
       -
           ✅ Record valid

     

       434
       434
       -
         ✅ File valid: 1 record(s), 16 total bytes

     

       435
       435
       -
       

     

       436
       436
       -
       ==================================================

     

       437
       437
       -
       Validation complete: 24/24 files valid

     

       438
       438
       -
       ✅ All test cases are valid!

Compare changes