1 .\" Copyright (c) 2020 Omar Polo <op@omarpolo.com>
2 .\"
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
6 .\"
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14 .Dd $Mdocdate: October 2 2020$
15 .Dt GMIND 1
16 .Os
17 .Sh NAME
18 .Nm gmid
19 .Nd dead simple zero configuration gemini server
20 .Sh SYNOPSIS
21 .Nm
22 .Bk -words
23 .Op Fl n
24 .Op Fl c Ar config
25 |
26 .Op Fl 6fh
27 .Op Fl C Ar cert
28 .Op Fl d Ar root
29 .Op Fl K Ar key
30 .Op Fl p Ar port
31 .Op Fl x Ar directory
32 .Ek
33 .Sh DESCRIPTION
34 .Nm
35 is a simple and minimal gemini server that can serve static files and
36 execute CGI scripts.
37 It can run without a configuration file with a limited set of features
38 available.
39 If a configuration file is given, no other flags shall be given,
40 except for
41 .Fl n .
42 .Pp
43 .Nm
44 fully supports IRIs (Internationalized Resource Identifiers, see
45 RFC3987).
46 .Pp
47 The options are as follows:
48 .Bl -tag -width 12m
49 .It Fl c Pa config
50 Specifies the configuration file.
51 .It Fl n
52 Check that the configuration is valid, but don't start the server.
53 .El
54 .Pp
55 If no configuration file is given,
56 .Nm
57 will look for the following option
58 .Bl -tag -width 12m
59 .It Fl 6
60 Enable IPv6.
61 .It Fl C Pa file
62 The certificate to use.
63 .It Fl d Pa directory
64 The root directory to serve.
65 .It Fl f
66 Stays and log in the foreground, do not daemonize the process.
67 .It Fl h
68 Print the usage and exit.
69 .It Fl K Pa file
70 The key for the certificate.
71 .It Fl p Ar port
72 The port to listen on, by default 1965.
73 .It Fl x Pa directory
74 Enable execution of CGI scripts.
75 See the description of the
76 .Ic cgi
77 .Ic server
78 option in the section
79 .Sq Servers
80 below to learn how
81 .Pa directory
82 is processed.
83 Cannot be provided more than once.
84 .El
85 .Sh CONFIGURATION FILE
86 The configuration file is divided into two sections:
87 .Bl -tag -width xxxx
88 .It Sy Global Options
89 Global settings for
90 .Nm .
91 .It Sy Servers
92 Virtual hosts definition
93 .El
94 .Pp
95 Within the sections, empty lines are ignored and comments can be put
96 anywhere in the file using a hash mark
97 .Pq Sq # ,
98 and extend to the end of the current line.
99 A boolean is either the symbol
100 .Sq on
101 or
102 .Sq off .
103 .Ss Global Options
104 .Bl -tag -width 12m
105 .It Ic daemon Ar bool
106 Enable or disables the daemon mode.
107 In daemon mode
108 .Nm
109 will log to syslog and fork in the background.
110 By default is off.
111 .It Ic ipv6 Ar bool
112 Enable or disable IPv6 support.
113 By default is off.
114 .It Ic port Ar portno
115 The port to listen on.
116 By default is 1965.
117 .It Ic protocols Ar string
118 Specify the TLS protocols to enable.
119 Refer to
120 .Xr tls_config_parse_protocols 3
121 for the valid protocol string values.
122 By default, both TLSv1.3 and TLSv1.2 are used.
123 Use
124 .Dq tlsv1.3
125 to enable only TLSv1.3.
126 .It Ic mime Ar mime-type Ar file-extension
127 Add a mapping for the given
128 .Ar file-extension
129 to the given
130 .Ar mime-type .
131 Both argument are strings.
132 .El
133 .Ss Servers
134 Every virtual host is defined by a
135 .Ic server
136 block:
137 .Bl -tag -width Ds
138 .It Ic server Ar hostname Brq ...
139 Match the server name using shell globbing rules.  This can be an explicit name,
140 .Ar www.example.com ,
141 or a name including a wildcards,
142 .Ar *.example.com .
143 .El
144 .Pp
145 Followed by a block of options that is enclosed in curly brackets:
146 .Bl -tag -width Ds
147 .It Ic cert Pa file
148 Path to the certificate to use for this server.
149 The
150 .Pa file
151 should contain a PEM encoded certificate.
152 This option is mandatory.
153 .It Ic key Pa file
154 Specify the private key to use for this server.
155 The
156 .Pa file
157 should contain a PEM encoded private key.
158 This option is mandatory.
159 .It Ic root Pa directory
160 Specify the root directory for this server.
161 This option is mandatory.
162 .It Ic cgi Pa path
163 Enable the execution of CGI scripts if
164 .Pa path
165 is a prefix of the user request string.
166 An empty path "" will effectively enable the execution of any file
167 with the executable bit set inside the root directory.
168 .It Ic default type Ar string
169 Set the default media type that is used if the media type for a
170 specified extension is not found.
171 If not specified, the
172 .Ic default type
173 is set to
174 .Dq application/octet-stream .
175 .It Ic lang Ar string
176 Specify the language tag for the text/gemini content served.
177 If not specified, no
178 .Dq lang
179 parameter will be added in the response.
180 .El
181 .Sh CGI
182 When CGI scripts are enabled for a directory, a request for an
183 executable file will execute it and fed its output to the client.
184 .Pp
185 The CGI scripts will inherit the environment from
186 .Nm
187 with these additional variables set:
188 .Bl -tag -width 18m
189 .It Ev SERVER_SOFTWARE
190 "gmid"
191 .It Ev SERVER_PORT
192 "1965"
193 .It Ev SCRIPT_NAME
194 The (public) path to the script.
195 .It Ev SCRIPT_EXECUTABLE
196 The full path to the executable.
197 .It Ev REQUEST_URI
198 The user request (without the query parameters.)
199 .It Ev REQUEST_RELATIVE
200 The request relative to the script.
201 .It Ev QUERY_STRING
202 The query parameters.
203 .It Ev REMOTE_HOST
204 The remote IP address.
205 .It Ev REMOTE_ADDR
206 The remote IP address.
207 .It Ev DOCUMENT_ROOT
208 The root directory being served, the one provided with the
209 .Ar d
210 parameter to
211 .Nm
212 or the root directory of the virtual host.
213 .It Ev AUTH_TYPE
214 The string "Certificate" if the client used a certificate, otherwise unset.
215 .It Ev REMOTE_USER
216 The subject of the client certificate if provided, otherwise unset.
217 .It Ev TLS_CLIENT_ISSUER
218 The is the issuer of the client certificate if provided, otherwise unset.
219 .It Ev TLS_CLIENT_HASH
220 The hash of the client certificate if provided, otherwise unset.
221 The format is "ALGO:HASH".
222 .El
223 .Pp
224 Let's say you have a script in
225 .Pa /cgi-bin/script
226 and the user request is
227 .Pa /cgi-bin/script/foo/bar?quux .
228 Then
229 .Ev SCRIPT_NAME
230 will be
231 .Pa cgi-bin/script ,
232 .Ev SCRIPT_EXECUTABLE
233 will be
234 .Pa $DOCUMENT_ROOT/cgi-bin/script ,
235 .Ev REQUEST_URI
236 will be
237 .Pa cgi-bin/script/foo/bar ,
238 .Ev REQUEST_RELATIVE
239 will be
240 .Pa foo/bar
241 and
242 .Ev QUERY_STRING
243 will be
244 .Ar quux .
245 .Sh EXAMPLES
246 To quickly getting started
247 .Bd -literal -offset indent
248 $ # generate a cert and a key
249 $ openssl req -x509 -newkey rsa:4096 -keyout key.pem \\
250         -out cert.pem -days 365 -nodes
251 $ mkdir docs
252 $ cat <<EOF > docs/index.gmi
253 # Hello world
254 test paragraph...
255 EOF
256 $ gmid -C cert.pem -K key.pem -d docs
257 .Ed
258 .Pp
259 Now you can visit gemini://localhost/ with your preferred gemini
260 client.
261 .Pp
262 To add some CGI scripts, assuming a setup similar to the previous
263 example, you can
264 .Bd -literal -offset indent
265 $ mkdir docs/cgi-bin
266 $ cat <<EOF > docs/cgi-bin/hello-world
267 #!/bin/sh
268 printf "20 text/plain\\r\\n"
269 echo "hello world!"
270 EOF
271 $ gmid -C cert.pem -K key.pem -d docs -x cgi-bin
272 .Ed
273 .Pp
274 Note that the argument to the
275 .Fl x
276 option is
277 .Pa cgi-bin
278 and not
279 .Pa docs/cgi-bin ,
280 since it's relative to the document root.
281 .Pp
282 The following is an example of a possible configuration for a site
283 that enables only TLSv1.3, adds a mime type for the file extension
284 "rtf" and defines two virtual host:
285 .Bd -literal -offset indent
286 ipv6 on		# enable ipv6
287 daemon on	# enable daemon mode
288 
289 protocols "tlsv1.3"
290 
291 mime "application/rtf" "rtf"
292 
293 server "example.com" {
294 	cert "/path/to/cert.pem"
295 	key  "/path/to/key.pem"
296 	root "/var/gemini/example.com"
297 }
298 
299 server "it.example.com" {
300 	cert "/path/to/cert.pem"
301 	key  "/path/to/key.pem"
302 	root "/var/gemini/it.example.com"
303 	cgi  "/cgi-bin"
304 	lang "it"
305 }
306 .Ed
307 .Sh ACKNOWLEDGEMENTS
308 .Nm
309 uses the
310 .Dq Flexible and Economical
311 UTF-8 decoder written by
312 .An Bjoern Hoehrmann
313 for its IRI parser.
314 .Sh CAVEATS
315 .Bl -bullet
316 .It
317 The root directories of all virtual hosts are opened during the daemon
318 startup; this means that if a root directory gets deleted and then
319 re-created,
320 .Nm
321 won't be able to serve files inside that directory until a restart.
322 This restriction applies only to the root directories and not their content.
323 .It
324 a %2F sequence in the path part is indistinguishable from a literal
325 slash: this is not RFC3986-compliant.
326 .It
327 a %00 sequence either in the path or in the query part is treated as
328 invalid character and thus rejected.
329 .El