2 * $Id: fcgi_protocol.c,v 1.21 2001/11/20 01:52:37 robs Exp $
7 #include "fcgi_protocol.h"
10 #pragma warning( disable : 4706)
13 /*******************************************************************************
14 * Build and queue a FastCGI message header. It is the caller's
15 * responsibility to make sure that there's enough space in the buffer, and
16 * that the data bytes (specified by 'len') are queued immediately following
19 static void queue_header(fcgi_request
*fr
, unsigned char type
, unsigned int len
)
24 ap_assert(type
<= FCGI_MAXTYPE
);
25 ap_assert(len
<= 0xffff);
26 ap_assert(BufferFree(fr
->serverOutputBuffer
) >= sizeof(FCGI_Header
));
28 /* Assemble and queue the packet header. */
29 header
.version
= FCGI_VERSION
;
31 header
.requestIdB1
= (unsigned char) (fr
->requestId
>> 8);
32 header
.requestIdB0
= (unsigned char) fr
->requestId
;
33 header
.contentLengthB1
= (unsigned char) (len
/ 256); /* MSB */
34 header
.contentLengthB0
= (unsigned char) (len
% 256); /* LSB */
35 header
.paddingLength
= 0;
37 fcgi_buf_add_block(fr
->serverOutputBuffer
, (char *) &header
, sizeof(FCGI_Header
));
40 /*******************************************************************************
41 * Build a FCGI_BeginRequest message body.
43 static void build_begin_request(unsigned int role
, unsigned char keepConnection
,
44 FCGI_BeginRequestBody
*body
)
46 ap_assert((role
>> 16) == 0);
47 body
->roleB1
= (unsigned char) (role
>> 8);
48 body
->roleB0
= (unsigned char) role
;
49 body
->flags
= (unsigned char) ((keepConnection
) ? FCGI_KEEP_CONN
: 0);
50 memset(body
->reserved
, 0, sizeof(body
->reserved
));
53 /*******************************************************************************
54 * Build and queue a FastCGI "Begin Request" message.
56 void fcgi_protocol_queue_begin_request(fcgi_request
*fr
)
58 FCGI_BeginRequestBody body
;
59 int bodySize
= sizeof(FCGI_BeginRequestBody
);
61 /* We should be the first ones to use this buffer */
62 ap_assert(BufferLength(fr
->serverOutputBuffer
) == 0);
64 build_begin_request(fr
->role
, FALSE
, &body
);
65 queue_header(fr
, FCGI_BEGIN_REQUEST
, bodySize
);
66 fcgi_buf_add_block(fr
->serverOutputBuffer
, (char *) &body
, bodySize
);
69 /*******************************************************************************
70 * Build a FastCGI name-value pair (env) header.
72 static void build_env_header(int nameLen
, int valueLen
,
73 unsigned char *headerBuffPtr
, int *headerLenPtr
)
75 unsigned char *startHeaderBuffPtr
= headerBuffPtr
;
77 ap_assert(nameLen
>= 0);
80 *headerBuffPtr
++ = (unsigned char) nameLen
;
82 *headerBuffPtr
++ = (unsigned char) ((nameLen
>> 24) | 0x80);
83 *headerBuffPtr
++ = (unsigned char) (nameLen
>> 16);
84 *headerBuffPtr
++ = (unsigned char) (nameLen
>> 8);
85 *headerBuffPtr
++ = (unsigned char) nameLen
;
88 ap_assert(valueLen
>= 0);
90 if (valueLen
< 0x80) {
91 *headerBuffPtr
++ = (unsigned char) valueLen
;
93 *headerBuffPtr
++ = (unsigned char) ((valueLen
>> 24) | 0x80);
94 *headerBuffPtr
++ = (unsigned char) (valueLen
>> 16);
95 *headerBuffPtr
++ = (unsigned char) (valueLen
>> 8);
96 *headerBuffPtr
++ = (unsigned char) valueLen
;
98 *headerLenPtr
= headerBuffPtr
- startHeaderBuffPtr
;
101 /* A static fn stolen from Apache's util_script.c...
102 * Obtain the Request-URI from the original request-line, returning
103 * a new string from the request pool containing the URI or "".
105 static char *apache_original_uri(request_rec
*r
)
109 if (r
->the_request
== NULL
)
110 return (char *) ap_pcalloc(r
->pool
, 1);
112 first
= r
->the_request
; /* use the request-line */
114 while (*first
&& !ap_isspace(*first
))
115 ++first
; /* skip over the method */
117 while (ap_isspace(*first
))
118 ++first
; /* and the space(s) */
121 while (*last
&& !ap_isspace(*last
))
122 ++last
; /* end at next whitespace */
124 return ap_pstrndup(r
->pool
, first
, last
- first
);
127 /* Based on Apache's ap_add_cgi_vars() in util_script.c.
128 * Apache's spins in sub_req_lookup_uri() trying to setup PATH_TRANSLATED,
129 * so we just don't do that part.
131 static void add_auth_cgi_vars(request_rec
*r
, const int compat
)
133 table
*e
= r
->subprocess_env
;
135 ap_table_setn(e
, "GATEWAY_INTERFACE", "CGI/1.1");
136 ap_table_setn(e
, "SERVER_PROTOCOL", r
->protocol
);
137 ap_table_setn(e
, "REQUEST_METHOD", r
->method
);
138 ap_table_setn(e
, "QUERY_STRING", r
->args
? r
->args
: "");
139 ap_table_setn(e
, "REQUEST_URI", apache_original_uri(r
));
141 /* The FastCGI spec precludes sending of CONTENT_LENGTH, PATH_INFO,
142 * PATH_TRANSLATED, and SCRIPT_NAME (for some reason?). PATH_TRANSLATED we
143 * don't have, its the variable that causes Apache to break trying to set
144 * up (and thus the reason this fn exists vs. using ap_add_cgi_vars()). */
146 ap_table_unset(e
, "CONTENT_LENGTH");
150 /* Note that the code below special-cases scripts run from includes,
151 * because it "knows" that the sub_request has been hacked to have the
152 * args and path_info of the original request, and not any that may have
153 * come with the script URI in the include command. Ugh. */
154 if (!strcmp(r
->protocol
, "INCLUDED")) {
155 ap_table_setn(e
, "SCRIPT_NAME", r
->uri
);
156 if (r
->path_info
&& *r
->path_info
)
157 ap_table_setn(e
, "PATH_INFO", r
->path_info
);
159 else if (!r
->path_info
|| !*r
->path_info
)
160 ap_table_setn(e
, "SCRIPT_NAME", r
->uri
);
162 int path_info_start
= ap_find_path_info(r
->uri
, r
->path_info
);
164 ap_table_setn(e
, "SCRIPT_NAME", ap_pstrndup(r
->pool
, r
->uri
, path_info_start
));
165 ap_table_setn(e
, "PATH_INFO", r
->path_info
);
169 static void add_pass_header_vars(fcgi_request
*fr
)
171 const array_header
*ph
= fr
->dynamic
? dynamic_pass_headers
: fr
->fs
->pass_headers
;
174 const char **elt
= (const char **)ph
->elts
;
177 for ( ; i
; --i
, ++elt
) {
178 const char *val
= ap_table_get(fr
->r
->headers_in
, *elt
);
180 ap_table_setn(fr
->r
->subprocess_env
, *elt
, val
);
186 /*******************************************************************************
187 * Build and queue the environment name-value pairs. Returns TRUE if the
188 * complete ENV was buffered, FALSE otherwise. Note: envp is updated to
189 * reflect the current position in the ENV.
191 int fcgi_protocol_queue_env(request_rec
*r
, fcgi_request
*fr
, env_status
*env
)
195 if (env
->envp
== NULL
) {
196 ap_add_common_vars(r
);
197 add_pass_header_vars(fr
);
199 if (fr
->role
== FCGI_RESPONDER
)
202 add_auth_cgi_vars(r
, fr
->auth_compat
);
204 env
->envp
= ap_create_environment(r
->pool
, r
->subprocess_env
);
212 env
->equalPtr
= strchr(*env
->envp
, '=');
213 ap_assert(env
->equalPtr
!= NULL
);
214 env
->nameLen
= env
->equalPtr
- *env
->envp
;
215 env
->valueLen
= strlen(++env
->equalPtr
);
216 build_env_header(env
->nameLen
, env
->valueLen
, env
->headerBuff
, &env
->headerLen
);
217 env
->totalLen
= env
->headerLen
+ env
->nameLen
+ env
->valueLen
;
222 if (BufferFree(fr
->serverOutputBuffer
) < (int)(sizeof(FCGI_Header
) + env
->headerLen
)) {
225 queue_header(fr
, FCGI_PARAMS
, env
->totalLen
);
226 fcgi_buf_add_block(fr
->serverOutputBuffer
, (char *)env
->headerBuff
, env
->headerLen
);
231 charCount
= fcgi_buf_add_block(fr
->serverOutputBuffer
, *env
->envp
, env
->nameLen
);
232 if (charCount
!= env
->nameLen
) {
233 *env
->envp
+= charCount
;
234 env
->nameLen
-= charCount
;
241 charCount
= fcgi_buf_add_block(fr
->serverOutputBuffer
, env
->equalPtr
, env
->valueLen
);
242 if (charCount
!= env
->valueLen
) {
243 env
->equalPtr
+= charCount
;
244 env
->valueLen
-= charCount
;
252 if (BufferFree(fr
->serverOutputBuffer
) < sizeof(FCGI_Header
)) {
255 queue_header(fr
, FCGI_PARAMS
, 0);
259 /*******************************************************************************
260 * Queue data from the client input buffer to the FastCGI server output
261 * buffer (encapsulating the data in FastCGI protocol messages).
263 void fcgi_protocol_queue_client_buffer(fcgi_request
*fr
)
266 int in_len
, out_free
;
272 * If there's some client data and room for at least one byte
273 * of data in the output buffer (after protocol overhead), then
274 * move some data to the output buffer.
276 in_len
= BufferLength(fr
->clientInputBuffer
);
277 out_free
= max(0, BufferFree(fr
->serverOutputBuffer
) - sizeof(FCGI_Header
));
278 movelen
= min(in_len
, out_free
);
280 queue_header(fr
, FCGI_STDIN
, movelen
);
281 fcgi_buf_get_to_buf(fr
->serverOutputBuffer
, fr
->clientInputBuffer
, movelen
);
285 * If all the client data has been sent, and there's room
286 * in the output buffer, indicate EOF.
288 if (movelen
== in_len
&& fr
->expectingClientContent
<= 0
289 && BufferFree(fr
->serverOutputBuffer
) >= sizeof(FCGI_Header
))
291 queue_header(fr
, FCGI_STDIN
, 0);
296 /*******************************************************************************
297 * Read FastCGI protocol messages from the FastCGI server input buffer into
298 * fr->header when parsing headers, to fr->fs_stderr when reading stderr data,
299 * or to the client output buffer otherwises.
301 int fcgi_protocol_dequeue(pool
*p
, fcgi_request
*fr
)
306 while (BufferLength(fr
->serverInputBuffer
) > 0) {
308 * State #1: looking for the next complete packet header.
310 if (fr
->gotHeader
== FALSE
) {
311 if (BufferLength(fr
->serverInputBuffer
) < sizeof(FCGI_Header
)) {
314 fcgi_buf_get_to_block(fr
->serverInputBuffer
, (char *) &header
,
315 sizeof(FCGI_Header
));
317 * XXX: Better handling of packets with other version numbers
318 * and other packet problems.
320 if (header
.version
!= FCGI_VERSION
) {
321 ap_log_rerror(FCGI_LOG_ERR_NOERRNO
, fr
->r
,
322 "FastCGI: comm with server \"%s\" aborted: protocol error: invalid version: %d != FCGI_VERSION(%d)",
323 fr
->fs_path
, header
.version
, FCGI_VERSION
);
326 if (header
.type
> FCGI_MAXTYPE
) {
327 ap_log_rerror(FCGI_LOG_ERR_NOERRNO
, fr
->r
,
328 "FastCGI: comm with server \"%s\" aborted: protocol error: invalid type: %d > FCGI_MAXTYPE(%d)",
329 fr
->fs_path
, header
.type
, FCGI_MAXTYPE
);
333 fr
->packetType
= header
.type
;
334 fr
->dataLen
= (header
.contentLengthB1
<< 8)
335 + header
.contentLengthB0
;
336 fr
->gotHeader
= TRUE
;
337 fr
->paddingLen
= header
.paddingLength
;
341 * State #2: got a header, and processing packet bytes.
343 len
= min(fr
->dataLen
, BufferLength(fr
->serverInputBuffer
));
345 switch (fr
->packetType
) {
348 switch(fr
->parseHeader
) {
349 case SCAN_CGI_READING_HEADERS
:
350 fcgi_buf_get_to_array(fr
->serverInputBuffer
, fr
->header
, len
);
352 case SCAN_CGI_FINISHED
:
353 len
= min(BufferFree(fr
->clientOutputBuffer
), len
);
355 fcgi_buf_get_to_buf(fr
->clientOutputBuffer
, fr
->serverInputBuffer
, len
);
361 /* Toss data on the floor */
370 if (fr
->fs_stderr
== NULL
)
372 fr
->fs_stderr
= ap_palloc(p
, FCGI_SERVER_MAX_STDERR_LINE_LEN
+ 1);
375 /* We're gonna consume all thats here */
380 char *null
, *end
, *start
= fr
->fs_stderr
;
382 /* Get as much as will fit in the buffer */
383 int get_len
= min(len
, FCGI_SERVER_MAX_STDERR_LINE_LEN
- fr
->fs_stderr_len
);
384 fcgi_buf_get_to_block(fr
->serverInputBuffer
, start
+ fr
->fs_stderr_len
, get_len
);
386 fr
->fs_stderr_len
+= get_len
;
387 *(start
+ fr
->fs_stderr_len
) = '\0';
389 /* Disallow nulls, we could be nicer but this is the motivator */
390 while ((null
= memchr(start
, '\0', fr
->fs_stderr_len
)))
392 int discard
= ++null
- start
;
393 ap_log_rerror(FCGI_LOG_ERR_NOERRNO
, fr
->r
,
394 "FastCGI: server \"%s\" sent a null character in the stderr stream!?, "
395 "discarding %d characters of stderr", fr
->fs_path
, discard
);
397 fr
->fs_stderr_len
-= discard
;
400 /* Print as much as possible */
401 while ((end
= strpbrk(start
, "\r\n")))
406 ap_log_rerror(FCGI_LOG_ERR_NOERRNO
, fr
->r
, "FastCGI: server \"%s\" stderr: %s", fr
->fs_path
, start
);
408 end
+= strspn(++end
, "\r\n");
409 fr
->fs_stderr_len
-= (end
- start
);
413 if (fr
->fs_stderr_len
)
415 if (start
!= fr
->fs_stderr
)
417 /* Move leftovers down */
418 memmove(fr
->fs_stderr
, start
, fr
->fs_stderr_len
);
420 else if (fr
->fs_stderr_len
== FCGI_SERVER_MAX_STDERR_LINE_LEN
)
422 /* Full buffer, dump it and complain */
423 ap_log_rerror(FCGI_LOG_ERR_NOERRNO
, fr
->r
, "FastCGI: server \"%s\" stderr: %s", fr
->fs_path
, fr
->fs_stderr
);
424 ap_log_rerror(FCGI_LOG_WARN_NOERRNO
, fr
->r
,
425 "FastCGI: too much stderr received from server \"%s\", "
426 "increase FCGI_SERVER_MAX_STDERR_LINE_LEN (%d) and rebuild "
427 "or use \"\\n\" to terminate lines",
428 fr
->fs_path
, FCGI_SERVER_MAX_STDERR_LINE_LEN
);
429 fr
->fs_stderr_len
= 0;
435 case FCGI_END_REQUEST
:
436 if (!fr
->readingEndRequestBody
) {
437 if (fr
->dataLen
!= sizeof(FCGI_EndRequestBody
)) {
438 ap_log_rerror(FCGI_LOG_ERR_NOERRNO
, fr
->r
,
439 "FastCGI: comm with server \"%s\" aborted: protocol error: invalid FCGI_END_REQUEST size: "
440 "%d != sizeof(FCGI_EndRequestBody)(%d)",
441 fr
->fs_path
, fr
->dataLen
, sizeof(FCGI_EndRequestBody
));
444 fr
->readingEndRequestBody
= TRUE
;
447 fcgi_buf_get_to_buf(fr
->erBufPtr
, fr
->serverInputBuffer
, len
);
450 if (fr
->dataLen
== 0) {
451 FCGI_EndRequestBody
*erBody
= &fr
->endRequestBody
;
452 fcgi_buf_get_to_block(
453 fr
->erBufPtr
, (char *) &fr
->endRequestBody
,
454 sizeof(FCGI_EndRequestBody
));
455 if (erBody
->protocolStatus
!= FCGI_REQUEST_COMPLETE
) {
457 * XXX: What to do with FCGI_OVERLOADED?
459 ap_log_rerror(FCGI_LOG_ERR_NOERRNO
, fr
->r
,
460 "FastCGI: comm with server \"%s\" aborted: protocol error: invalid FCGI_END_REQUEST status: "
461 "%d != FCGI_REQUEST_COMPLETE(%d)", fr
->fs_path
,
462 erBody
->protocolStatus
, FCGI_REQUEST_COMPLETE
);
465 fr
->exitStatus
= (erBody
->appStatusB3
<< 24)
466 + (erBody
->appStatusB2
<< 16)
467 + (erBody
->appStatusB1
<< 8)
468 + (erBody
->appStatusB0
);
469 fr
->exitStatusSet
= TRUE
;
470 fr
->readingEndRequestBody
= FALSE
;
473 case FCGI_GET_VALUES_RESULT
:
474 /* XXX coming soon */
475 case FCGI_UNKNOWN_TYPE
:
476 /* XXX coming soon */
479 * XXX Ignore unknown packet types from the FastCGI server.
482 fcgi_buf_toss(fr
->serverInputBuffer
, len
);
488 * Discard padding, then start looking for
491 if (fr
->dataLen
== 0) {
492 if (fr
->paddingLen
> 0) {
493 len
= min(fr
->paddingLen
,
494 BufferLength(fr
->serverInputBuffer
));
495 fcgi_buf_toss(fr
->serverInputBuffer
, len
);
496 fr
->paddingLen
-= len
;
498 if (fr
->paddingLen
== 0) {
499 fr
->gotHeader
= FALSE
;