op public repos

Blame

Date:: Fri Nov 6 12:01:31 2020 UTC
Message:: implementing CGI – NOT READY YET! This is a first try at implementing CGI scripting. The idea is that, if CGI is explicitly enabled by the user, when a user requires an executable file instead of serving it to the client, that file will be executed and its output fed to the client. There are various pieces that are still lacking, the firsts that comes to mind are: - performance: the handle_cgi just loops ignoring the WANT_POLLIN/POLLOUT and blocking if the child process hasn’t outputted anything. - we don’t parse query variable (yet) - we need to set more variables in the child environment side question: it’s better to set the variables using setenv() or by providing an explicit environment? - document what environment the CGI script will get - improve the horrible unveil/pledge(cgi ? …) but now I can serve “hello-world”-tier script from gmid!
Actions:: History | Blob | Raw File

  1 3e4749f7 2020-10-02 op .\" Copyright (c) 2020 Omar Polo <op@omarpolo.com>
  2 3e4749f7 2020-10-02 op .\"
  3 3e4749f7 2020-10-02 op .\" Permission to use, copy, modify, and distribute this software for any
  4 3e4749f7 2020-10-02 op .\" purpose with or without fee is hereby granted, provided that the above
  5 3e4749f7 2020-10-02 op .\" copyright notice and this permission notice appear in all copies.
  6 3e4749f7 2020-10-02 op .\"
  7 3e4749f7 2020-10-02 op .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  8 3e4749f7 2020-10-02 op .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  9 3e4749f7 2020-10-02 op .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 10 3e4749f7 2020-10-02 op .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 11 3e4749f7 2020-10-02 op .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 12 3e4749f7 2020-10-02 op .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 13 3e4749f7 2020-10-02 op .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 14 3e4749f7 2020-10-02 op .Dd $Mdocdate: October 2 2020$
 15 3e4749f7 2020-10-02 op .Dt GMIND 1
 16 3e4749f7 2020-10-02 op .Os
 17 3e4749f7 2020-10-02 op .Sh NAME
 18 3e4749f7 2020-10-02 op .Nm gmid
 19 fab952e1 2020-10-03 op .Nd dead simple zero configuration gemini server
 20 3e4749f7 2020-10-02 op .Sh SYNOPSIS
 21 3e4749f7 2020-10-02 op .Nm
 22 3e4749f7 2020-10-02 op .Bk -words
 23 72342dc9 2020-11-06 op .Op Fl hx
 24 3e4749f7 2020-10-02 op .Op Fl c Ar cert.pem
 25 3e4749f7 2020-10-02 op .Op Fl d Ar docs
 26 3e4749f7 2020-10-02 op .Op Fl k Ar key.pem
 27 2c3a40fa 2020-11-06 op .Op Fl l Ar access.log
 28 3e4749f7 2020-10-02 op .Ek
 29 3e4749f7 2020-10-02 op .Sh DESCRIPTION
 30 3e4749f7 2020-10-02 op .Nm
 31 3e4749f7 2020-10-02 op is a very simple and minimal gemini server.
 32 3e4749f7 2020-10-02 op It only supports serving static content, and strive to be as simple as
 33 3e4749f7 2020-10-02 op possible.
 34 3e4749f7 2020-10-02 op .Pp
 35 3e4749f7 2020-10-02 op .Nm
 36 3e4749f7 2020-10-02 op will strip any sequence of
 37 3e4749f7 2020-10-02 op .Pa ../
 38 3e4749f7 2020-10-02 op or trailing
 39 3e4749f7 2020-10-02 op .Pa ..
 40 3e4749f7 2020-10-02 op in the requests made by clients, so it's impossible to serve content
 41 3e4749f7 2020-10-02 op outside the
 42 3e4749f7 2020-10-02 op .Pa docs
 43 fab952e1 2020-10-03 op directory by mistake, and will also refuse to follow symlink.
 44 6980aad6 2020-10-02 op Furthermore, on
 45 6980aad6 2020-10-02 op .Ox ,
 46 6980aad6 2020-10-02 op .Xr pledge 2
 47 3e4749f7 2020-10-02 op and
 48 6980aad6 2020-10-02 op .Xr unveil 2
 49 3e4749f7 2020-10-02 op are used to ensure that
 50 3e4749f7 2020-10-02 op .Nm
 51 3e4749f7 2020-10-02 op dosen't do anything else than read files from the given directory and
 52 3e4749f7 2020-10-02 op accept network connections.
 53 3e4749f7 2020-10-02 op .Pp
 54 3e4749f7 2020-10-02 op It should be noted that
 55 3e4749f7 2020-10-02 op .Nm
 56 3e4749f7 2020-10-02 op is very simple in its implementation, and so it may not be appropriate
 57 3e4749f7 2020-10-02 op for serving site with lots of users.
 58 20f68838 2020-11-05 op After all, the code is single threaded and use a single process
 59 20f68838 2020-11-05 op (multiple requests are handled concurrently thanks to async I/O.)
 60 3e4749f7 2020-10-02 op .Pp
 61 fab952e1 2020-10-03 op If a user request path is a directory,
 62 fab952e1 2020-10-03 op .Nm
 63 fab952e1 2020-10-03 op will try to serve a
 64 fab952e1 2020-10-03 op .Pa index.gmi
 65 fab952e1 2020-10-03 op file inside that directory.
 66 fab952e1 2020-10-03 op If not found, it will return an error 51 (not found) to the user.
 67 fab952e1 2020-10-03 op .Pp
 68 3e4749f7 2020-10-02 op The options are as follows:
 69 3e4749f7 2020-10-02 op .Bl -tag -width 12m
 70 3e4749f7 2020-10-02 op .It Fl c Ar cert.pem
 71 3e4749f7 2020-10-02 op The certificate to use, by default is
 72 fab952e1 2020-10-03 op .Pa cert.pem .
 73 3e4749f7 2020-10-02 op .It Fl d Ar docs
 74 3e4749f7 2020-10-02 op The root directory to serve.
 75 3e4749f7 2020-10-02 op .Nm
 76 3e4749f7 2020-10-02 op won't serve any file that is outside that directory.
 77 3e4749f7 2020-10-02 op .It Fl h
 78 fab952e1 2020-10-03 op Print the usage and exit.
 79 3e4749f7 2020-10-02 op .It Fl k Ar key.pem
 80 3e4749f7 2020-10-02 op The key for the certificate, by default is
 81 fab952e1 2020-10-03 op .Pa key.pem .
 82 2c3a40fa 2020-11-06 op .It Fl l Ar access.log
 83 2c3a40fa 2020-11-06 op log to the given file instead of the standard error.
 84 72342dc9 2020-11-06 op .It Fl x
 85 72342dc9 2020-11-06 op Enable CGI scripts.
 86 3e4749f7 2020-10-02 op .El
 87 72342dc9 2020-11-06 op .Sh CGI
 88 72342dc9 2020-11-06 op If CGI scripts are enabled, when a file requested by a client is
 89 72342dc9 2020-11-06 op marked as executable it is executed and its output fed to the client.
 90 72342dc9 2020-11-06 op .Pp
 91 72342dc9 2020-11-06 op Note that since this give the chance to anybody to execute possibly
 92 72342dc9 2020-11-06 op .Sy any file
 93 72342dc9 2020-11-06 op in the served directory, this option is disabled by default.
 94 3e4749f7 2020-10-02 op .Sh EXAMPLES
 95 3e4749f7 2020-10-02 op To quickly getting started
 96 6980aad6 2020-10-02 op .Bd -literal -offset indent
 97 3e4749f7 2020-10-02 op $ # generate a cert and a key
 98 3e4749f7 2020-10-02 op $ openssl req -x509 -newkey rsa:4096 -keyout key.pem \\
 99 3e4749f7 2020-10-02 op         -out cert.pem -days 365 -nodes
100 3e4749f7 2020-10-02 op $ mkdir docs
101 3e4749f7 2020-10-02 op $ cat <<EOF > docs/index.gmi
102 3e4749f7 2020-10-02 op # Hello world
103 3e4749f7 2020-10-02 op test paragraph...
104 3e4749f7 2020-10-02 op EOF
105 3e4749f7 2020-10-02 op $ gmid -c cert.pem -k key.pem -d docs
106 6980aad6 2020-10-02 op .Ed
107 3e4749f7 2020-10-02 op .Pp
108 3e4749f7 2020-10-02 op now you can visit gemini://localhost/ with your preferred gemini client.
109 3e4749f7 2020-10-02 op .Sh CAVEATS
110 3e4749f7 2020-10-02 op .Bl -bullet
111 3e4749f7 2020-10-02 op .It
112 fab952e1 2020-10-03 op it doesn't support virtual hosts: the host part of the request URL is
113 3e4749f7 2020-10-02 op completely ignored.
114 3e4749f7 2020-10-02 op .It
115 3e4749f7 2020-10-02 op it doesn't fork in the background or anything like that.
116 3e4749f7 2020-10-02 op .El