server_fcgi.c revision 1.13
1/*	$OpenBSD: server_fcgi.c,v 1.13 2014/08/03 10:38:42 reyk Exp $	*/
2
3/*
4 * Copyright (c) 2014 Florian Obser <florian@openbsd.org>
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19#include <sys/types.h>
20#include <sys/queue.h>
21#include <sys/time.h>
22#include <sys/stat.h>
23#include <sys/socket.h>
24#include <sys/un.h>
25#include <sys/tree.h>
26#include <sys/hash.h>
27
28#include <net/if.h>
29#include <netinet/in_systm.h>
30#include <netinet/in.h>
31#include <netinet/ip.h>
32#include <netinet/tcp.h>
33#include <arpa/inet.h>
34
35#include <errno.h>
36#include <fcntl.h>
37#include <stdlib.h>
38#include <string.h>
39#include <unistd.h>
40#include <stdio.h>
41#include <err.h>
42#include <event.h>
43
44#include <openssl/ssl.h>
45
46#include "httpd.h"
47#include "http.h"
48
49#define FCGI_CONTENT_SIZE	 65535
50#define FCGI_PADDING_SIZE	 255
51#define FCGI_RECORD_SIZE	 \
52    (sizeof(struct fcgi_record_header) + FCGI_CONTENT_SIZE + FCGI_PADDING_SIZE)
53
54#define FCGI_BEGIN_REQUEST	 1
55#define FCGI_ABORT_REQUEST	 2
56#define FCGI_END_REQUEST	 3
57#define FCGI_PARAMS		 4
58#define FCGI_STDIN		 5
59#define FCGI_STDOUT		 6
60#define FCGI_STDERR		 7
61#define FCGI_DATA		 8
62#define FCGI_GET_VALUES		 9
63#define FCGI_GET_VALUES_RESULT	10
64#define FCGI_UNKNOWN_TYPE	11
65#define FCGI_MAXTYPE		(FCGI_UNKNOWN_TYPE)
66
67#define FCGI_RESPONDER		 1
68
69struct fcgi_record_header {
70	uint8_t		version;
71	uint8_t		type;
72	uint16_t	id;
73	uint16_t	content_len;
74	uint8_t		padding_len;
75	uint8_t		reserved;
76} __packed;
77
78struct fcgi_begin_request_body {
79	uint16_t	role;
80	uint8_t		flags;
81	uint8_t		reserved[5];
82} __packed;
83
84int	server_fcgi_header(struct client *, u_int);
85void	server_fcgi_read(struct bufferevent *, void *);
86int	fcgi_add_param(uint8_t *, const char *, const char *, int *,
87    struct client *);
88
89int
90server_fcgi(struct httpd *env, struct client *clt)
91{
92	uint8_t				 buf[FCGI_RECORD_SIZE];
93	char				 hbuf[MAXHOSTNAMELEN];
94	struct server_config		*srv_conf = clt->clt_srv_conf;
95	struct http_descriptor		*desc	= clt->clt_desc;
96	struct sockaddr_un		 sun;
97	struct fcgi_record_header	*h;
98	struct fcgi_begin_request_body	*begin;
99	struct kv			*kv, key;
100	size_t				 len;
101	int				 fd = -1, total_len;
102	const char			*errstr = NULL;
103	char				*request_uri, *p;
104	in_port_t			 port;
105	struct sockaddr_storage		 ss;
106
107	if (srv_conf->path[0] == ':') {
108		p = srv_conf->path + 1;
109
110		port = strtonum(p, 0, 0xffff, &errstr);
111		if (errstr != NULL) {
112			log_warn("%s: strtonum %s, %s", __func__, p, errstr);
113			goto fail;
114		}
115		memset(&ss, 0, sizeof(ss));
116		ss.ss_family = AF_INET;
117		((struct sockaddr_in *)
118		    &ss)->sin_addr.s_addr = htonl(INADDR_LOOPBACK);
119		port = htons(port);
120
121		if ((fd = server_socket_connect(&ss, port, srv_conf)) == -1)
122			goto fail;
123	} else {
124		if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1)
125			goto fail;
126
127		memset(&sun, 0, sizeof(sun));
128		sun.sun_family = AF_UNIX;
129		len = strlcpy(sun.sun_path,
130		    srv_conf->path, sizeof(sun.sun_path));
131		if (len >= sizeof(sun.sun_path)) {
132			errstr = "socket path to long";
133			goto fail;
134		}
135		sun.sun_len = len;
136
137		if (connect(fd, (struct sockaddr *)&sun, sizeof(sun)) == -1)
138			goto fail;
139	}
140
141	socket_set_blockmode(fd, BM_NONBLOCK);
142
143	memset(&hbuf, 0, sizeof(hbuf));
144	clt->clt_fcgi_state = FCGI_READ_HEADER;
145	clt->clt_fcgi_toread = sizeof(struct fcgi_record_header);
146
147	if (clt->clt_srvevb != NULL)
148		evbuffer_free(clt->clt_srvevb);
149
150	clt->clt_srvevb = evbuffer_new();
151	if (clt->clt_srvevb == NULL) {
152		errstr = "failed to allocate evbuffer";
153		goto fail;
154	}
155
156	clt->clt_fd = fd;
157	if (clt->clt_srvbev != NULL)
158		bufferevent_free(clt->clt_srvbev);
159
160	clt->clt_srvbev = bufferevent_new(fd, server_fcgi_read,
161	    NULL, server_file_error, clt);
162	if (clt->clt_srvbev == NULL) {
163		errstr = "failed to allocate fcgi buffer event";
164		goto fail;
165	}
166
167	memset(&buf, 0, sizeof(buf));
168
169	h = (struct fcgi_record_header *) &buf;
170	h->version = 1;
171	h->type = FCGI_BEGIN_REQUEST;
172	h->id = htons(1);
173	h->content_len = htons(sizeof(struct fcgi_begin_request_body));
174	h->padding_len = 0;
175
176	begin = (struct fcgi_begin_request_body *) &buf[sizeof(struct
177	    fcgi_record_header)];
178	begin->role = htons(FCGI_RESPONDER);
179
180	bufferevent_write(clt->clt_srvbev, &buf,
181	    sizeof(struct fcgi_record_header) +
182	    sizeof(struct fcgi_begin_request_body));
183
184	h->type = FCGI_PARAMS;
185	h->content_len = total_len = 0;
186
187	if (fcgi_add_param(buf, "SCRIPT_NAME", desc->http_path, &total_len,
188	    clt) == -1) {
189		errstr = "failed to encode param";
190		goto fail;
191	}
192
193	if (desc->http_query)
194		if (fcgi_add_param(buf, "QUERY_STRING", desc->http_query,
195		    &total_len, clt) == -1) {
196			errstr = "failed to encode param";
197			goto fail;
198		}
199
200	if (fcgi_add_param(buf, "DOCUMENT_URI", desc->http_path, &total_len,
201	    clt) == -1) {
202		errstr = "failed to encode param";
203		goto fail;
204	}
205	if (fcgi_add_param(buf, "GATEWAY_INTERFACE", "CGI/1.1", &total_len,
206	    clt) == -1) {
207		errstr = "failed to encode param";
208		goto fail;
209	}
210
211	key.kv_key = "Accept";
212	if ((kv = kv_find(&desc->http_headers, &key)) != NULL &&
213	    kv->kv_value != NULL)
214		if (fcgi_add_param(buf, "HTTP_ACCEPT", kv->kv_value,
215		    &total_len, clt) == -1) {
216			errstr = "failed to encode param";
217			goto fail;
218		}
219
220	key.kv_key = "Accept-Encoding";
221	if ((kv = kv_find(&desc->http_headers, &key)) != NULL &&
222	    kv->kv_value != NULL)
223		if (fcgi_add_param(buf, "HTTP_ACCEPT_ENCODING", kv->kv_value,
224		    &total_len, clt) == -1) {
225			errstr = "failed to encode param";
226			goto fail;
227		}
228
229	key.kv_key = "Accept-Language";
230	if ((kv = kv_find(&desc->http_headers, &key)) != NULL &&
231	    kv->kv_value != NULL)
232		if (fcgi_add_param(buf, "HTTP_ACCEPT_LANGUAGE", kv->kv_value,
233		    &total_len, clt) == -1) {
234			errstr = "failed to encode param";
235			goto fail;
236		}
237
238	key.kv_key = "Connection";
239	if ((kv = kv_find(&desc->http_headers, &key)) != NULL &&
240	    kv->kv_value != NULL)
241		if (fcgi_add_param(buf, "HTTP_CONNECTION", kv->kv_value,
242		    &total_len, clt) == -1) {
243			errstr = "failed to encode param";
244			goto fail;
245		}
246
247	key.kv_key = "Cookie";
248	if ((kv = kv_find(&desc->http_headers, &key)) != NULL &&
249	    kv->kv_value != NULL)
250		if (fcgi_add_param(buf, "HTTP_COOKIE", kv->kv_value,
251		    &total_len, clt) == -1) {
252			errstr = "failed to encode param";
253			goto fail;
254		}
255
256	key.kv_key = "Host";
257	if ((kv = kv_find(&desc->http_headers, &key)) != NULL &&
258	    kv->kv_value != NULL)
259		if (fcgi_add_param(buf, "HTTP_HOST", kv->kv_value,
260		    &total_len, clt) == -1) {
261			errstr = "failed to encode param";
262			goto fail;
263		}
264
265	key.kv_key = "User-Agent";
266	if ((kv = kv_find(&desc->http_headers, &key)) != NULL &&
267	    kv->kv_value != NULL)
268		if (fcgi_add_param(buf, "HTTP_USER_AGENT", kv->kv_value,
269		    &total_len, clt) == -1) {
270			errstr = "failed to encode param";
271			goto fail;
272		}
273
274	(void)print_host(&clt->clt_ss, hbuf, sizeof(hbuf));
275	if (fcgi_add_param(buf, "REMOTE_ADDR", hbuf, &total_len, clt) == -1) {
276		errstr = "failed to encode param";
277		goto fail;
278	}
279
280	(void)snprintf(hbuf, sizeof(hbuf), "%d", ntohs(clt->clt_port));
281	if (fcgi_add_param(buf, "REMOTE_PORT", hbuf, &total_len, clt) == -1) {
282		errstr = "failed to encode param";
283		goto fail;
284	}
285
286	if (fcgi_add_param(buf, "REQUEST_METHOD",
287	    server_httpmethod_byid(desc->http_method), &total_len, clt) == -1) {
288		errstr = "failed to encode param";
289		goto fail;
290	}
291
292	if (!desc->http_query) {
293		if (fcgi_add_param(buf, "REQUEST_URI", desc->http_path,
294		    &total_len, clt) == -1) {
295			errstr = "failed to encode param";
296			goto fail;
297		}
298	} else if (asprintf(&request_uri, "%s?%s", desc->http_path,
299	    desc->http_query) != -1) {
300		if (fcgi_add_param(buf, "REQUEST_URI", request_uri, &total_len,
301		    clt) == -1) {
302			errstr = "failed to encode param";
303			goto fail;
304		}
305		free(request_uri);
306	}
307
308	(void)print_host(&clt->clt_srv_ss, hbuf, sizeof(hbuf));
309	if (fcgi_add_param(buf, "SERVER_ADDR", hbuf, &total_len, clt) == -1) {
310		errstr = "failed to encode param";
311		goto fail;
312	}
313
314	(void)snprintf(hbuf, sizeof(hbuf), "%d",
315	    ntohs(server_socket_getport(&clt->clt_srv_ss)));
316	if (fcgi_add_param(buf, "SERVER_PORT", hbuf, &total_len, clt) == -1) {
317		errstr = "failed to encode param";
318		goto fail;
319	}
320
321	if (fcgi_add_param(buf, "SERVER_NAME", srv_conf->name, &total_len,
322	    clt) == -1) {
323		errstr = "failed to encode param";
324		goto fail;
325	}
326
327	if (fcgi_add_param(buf, "SERVER_PROTOCOL", desc->http_version,
328	    &total_len, clt) == -1) {
329		errstr = "failed to encode param";
330		goto fail;
331	}
332
333	if (fcgi_add_param(buf, "SERVER_SOFTWARE", HTTPD_SERVERNAME, &total_len,
334	    clt) == -1) {
335		errstr = "failed to encode param";
336		goto fail;
337	}
338
339	if (total_len != 0) {	/* send last params record */
340		bufferevent_write(clt->clt_srvbev, &buf,
341		    sizeof(struct fcgi_record_header) +
342		    ntohs(h->content_len));
343	}
344
345	/* send "no more params" message */
346	h->content_len = 0;
347	bufferevent_write(clt->clt_srvbev, &buf,
348	    sizeof(struct fcgi_record_header));
349
350	h->type = FCGI_STDIN;
351
352	bufferevent_write(clt->clt_srvbev, &buf,
353	    sizeof(struct fcgi_record_header));
354
355	bufferevent_settimeout(clt->clt_srvbev,
356	    srv_conf->timeout.tv_sec, srv_conf->timeout.tv_sec);
357	bufferevent_enable(clt->clt_srvbev, EV_READ|EV_WRITE);
358	bufferevent_disable(clt->clt_bev, EV_READ);
359
360	/*
361	 * persist is not supported yet because we don't get the
362	 * Content-Length from slowcgi and don't support chunked encoding.
363	 */
364	clt->clt_persist = 0;
365	clt->clt_done = 0;
366
367	return (0);
368 fail:
369	if (errstr == NULL)
370		errstr = strerror(errno);
371	server_abort_http(clt, 500, errstr);
372	return (-1);
373}
374
375int
376fcgi_add_param(uint8_t *buf, const char *key, const char *val, int *total_len,
377    struct client *clt)
378{
379	struct fcgi_record_header	*h;
380	int				 len = 0;
381	int				 key_len = strlen(key);
382	int				 val_len = strlen(val);
383	uint8_t				*param;
384
385	len += key_len + val_len;
386	len += key_len > 127 ? 4 : 1;
387	len += val_len > 127 ? 4 : 1;
388
389	DPRINTF("%s: %s[%d] => %s[%d], total_len: %d", __func__, key, key_len,
390	    val, val_len, *total_len);
391
392	if (len > FCGI_CONTENT_SIZE)
393		return (-1);
394
395	if (*total_len + len > FCGI_CONTENT_SIZE) {
396		bufferevent_write(clt->clt_srvbev, buf,
397		    sizeof(struct fcgi_record_header) + *total_len);
398		*total_len = 0;
399	}
400
401	h = (struct fcgi_record_header *) buf;
402	param = buf + sizeof(struct fcgi_record_header) + *total_len;
403
404	if (key_len > 127) {
405		*param++ = ((key_len >> 24) & 0xff) | 0x80;
406		*param++ = ((key_len >> 16) & 0xff);
407		*param++ = ((key_len >> 8) & 0xff);
408		*param++ = (key_len & 0xff);
409	} else
410		*param++ = key_len;
411
412	if (val_len > 127) {
413		*param++ = ((val_len >> 24) & 0xff) | 0x80;
414		*param++ = ((val_len >> 16) & 0xff);
415		*param++ = ((val_len >> 8) & 0xff);
416		*param++ = (val_len & 0xff);
417	} else
418		*param++ = val_len;
419
420	memcpy(param, key, key_len);
421	param += key_len;
422	memcpy(param, val, val_len);
423
424	*total_len += len;
425
426	h->content_len = htons(*total_len);
427	return (0);
428}
429
430void
431server_fcgi_read(struct bufferevent *bev, void *arg)
432{
433	uint8_t				 buf[FCGI_RECORD_SIZE];
434	struct client			*clt = (struct client *) arg;
435	struct fcgi_record_header	*h;
436	size_t				 len;
437
438	do {
439		len = bufferevent_read(bev, &buf, clt->clt_fcgi_toread);
440		/* XXX error handling */
441		evbuffer_add(clt->clt_srvevb, &buf, len);
442		clt->clt_fcgi_toread -= len;
443		DPRINTF("%s: len: %lu toread: %d state: %d", __func__, len,
444		    clt->clt_fcgi_toread, clt->clt_fcgi_state);
445
446		if (clt->clt_fcgi_toread != 0)
447			return;
448
449		switch (clt->clt_fcgi_state) {
450		case FCGI_READ_HEADER:
451			clt->clt_fcgi_state = FCGI_READ_CONTENT;
452			h = (struct fcgi_record_header *)
453			    EVBUFFER_DATA(clt->clt_srvevb);
454			DPRINTF("%s: record header: version %d type %d id %d "
455			    "content len %d padding %d", __func__,
456			     h->version, h->type, ntohs(h->id),
457			     ntohs(h->content_len), h->padding_len);
458			clt->clt_fcgi_type = h->type;
459			clt->clt_fcgi_toread = ntohs(h->content_len);
460			clt->clt_fcgi_padding_len = h->padding_len;
461			evbuffer_drain(clt->clt_srvevb,
462			    EVBUFFER_LENGTH(clt->clt_srvevb));
463			if (clt->clt_fcgi_toread != 0)
464				break;
465
466			/* fallthrough if content_len == 0 */
467		case FCGI_READ_CONTENT:
468			if (clt->clt_fcgi_type == FCGI_STDOUT &&
469			    EVBUFFER_LENGTH(clt->clt_srvevb) > 0) {
470				if (++clt->clt_chunk == 1)
471					server_fcgi_header(clt, 200);
472				server_bufferevent_write_buffer(clt,
473				    clt->clt_srvevb);
474			}
475			evbuffer_drain(clt->clt_srvevb,
476			    EVBUFFER_LENGTH(clt->clt_srvevb));
477			if (!clt->clt_fcgi_padding_len) {
478				clt->clt_fcgi_state = FCGI_READ_HEADER;
479				clt->clt_fcgi_toread =
480				    sizeof(struct fcgi_record_header);
481			} else {
482				clt->clt_fcgi_state = FCGI_READ_PADDING;
483				clt->clt_fcgi_toread =
484				    clt->clt_fcgi_padding_len;
485			}
486			break;
487		case FCGI_READ_PADDING:
488			evbuffer_drain(clt->clt_srvevb,
489			    EVBUFFER_LENGTH(clt->clt_srvevb));
490			clt->clt_fcgi_state = FCGI_READ_HEADER;
491			clt->clt_fcgi_toread =
492			    sizeof(struct fcgi_record_header);
493			break;
494		}
495	} while (len > 0);
496}
497
498int
499server_fcgi_header(struct client *clt, u_int code)
500{
501	struct http_descriptor	*desc = clt->clt_desc;
502	const char		*error;
503	char			 tmbuf[32];
504
505	if (desc == NULL || (error = server_httperror_byid(code)) == NULL)
506		return (-1);
507
508	if (server_log_http(clt, code, 0) == -1)
509		return (-1);
510
511	kv_purge(&desc->http_headers);
512
513	/* Add error codes */
514	if (kv_setkey(&desc->http_pathquery, "%lu", code) == -1 ||
515	    kv_set(&desc->http_pathquery, "%s", error) == -1)
516		return (-1);
517
518	/* Add headers */
519	if (kv_add(&desc->http_headers, "Server", HTTPD_SERVERNAME) == NULL)
520		return (-1);
521
522	/* Is it a persistent connection? */
523	if (clt->clt_persist) {
524		if (kv_add(&desc->http_headers,
525		    "Connection", "keep-alive") == NULL)
526			return (-1);
527	} else if (kv_add(&desc->http_headers, "Connection", "close") == NULL)
528		return (-1);
529
530	/* Date header is mandatory and should be added last */
531	server_http_date(tmbuf, sizeof(tmbuf));
532	if (kv_add(&desc->http_headers, "Date", tmbuf) == NULL)
533		return (-1);
534
535	/* Write initial header (fcgi might append more) */
536	if (server_writeresponse_http(clt) == -1 ||
537	    server_bufferevent_print(clt, "\r\n") == -1 ||
538	    server_writeheader_http(clt) == -1)
539		return (-1);
540
541	return (0);
542}
543