2 * Copyright 1999-2004 The Apache Software Foundation
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include "ajp_header.h"
20 static const char *response_trans_headers[] = {
34 static const char *long_res_header_for_sc(int sc)
36 const char *rc = NULL;
38 if(sc <= SC_RES_HEADERS_NUM && sc > 0) {
39 rc = response_trans_headers[sc - 1];
45 #define UNKNOWN_METHOD (-1)
47 static int sc_for_req_header(const char *header_name)
50 apr_size_t len = strlen(header_name);
51 const char *p = header_name;
54 /* ACCEPT-LANGUAGE is the longest headeer
55 * that is of interest.
57 if (len < 4 || len > 15)
58 return UNKNOWN_METHOD;
61 header[i++] = apr_toupper(*p++);
67 if (memcmp(p, "CCEPT", 5) == 0) {
70 else if (header[6] == '-') {
72 if (memcmp(p, "CHARSET", 7) == 0)
73 return SC_ACCEPT_CHARSET;
74 else if (memcmp(p, "ENCODING", 8) == 0)
75 return SC_ACCEPT_ENCODING;
76 else if (memcmp(p, "LANGUAGE", 8) == 0)
77 return SC_ACCEPT_LANGUAGE;
79 return UNKNOWN_METHOD;
82 return UNKNOWN_METHOD;
84 else if (memcmp(p, "UTHORIZATION", 12) == 0)
85 return SC_AUTHORIZATION;
87 return UNKNOWN_METHOD;
90 if (memcmp(p, "OOKIE", 5) == 0)
92 else if(memcmp(p, "ONNECTION", 9) == 0)
94 else if(memcmp(p, "ONTENT-TYPE", 11) == 0)
95 return SC_CONTENT_TYPE;
96 else if(memcmp(p, "ONTENT-LENGTH", 13) == 0)
97 return SC_CONTENT_LENGTH;
98 else if(memcmp(p, "OOKIE2", 6) == 0)
101 return UNKNOWN_METHOD;
104 if(memcmp(p, "OST", 3) == 0)
107 return UNKNOWN_METHOD;
110 if(memcmp(p, "RAGMA", 5) == 0)
113 return UNKNOWN_METHOD;
116 if(memcmp(p, "EFERER", 6) == 0)
119 return UNKNOWN_METHOD;
122 if(memcmp(p, "SER-AGENT", 9) == 0)
123 return SC_USER_AGENT;
125 return UNKNOWN_METHOD;
128 return UNKNOWN_METHOD;
134 /* Apache method number to SC methods transform table */
135 static const unsigned char sc_for_req_method_table[] = {
151 SC_M_VERSION_CONTROL,
160 SC_M_BASELINE_CONTROL,
165 static int sc_for_req_method_by_id(int method_id)
167 if (method_id < 0 || method_id > M_INVALID)
168 return UNKNOWN_METHOD;
170 return sc_for_req_method_table[method_id] ?
171 sc_for_req_method_table[method_id] : UNKNOWN_METHOD;
178 AJPV13_REQUEST/AJPV14_REQUEST=
179 request_prefix (1) (byte)
189 num_headers*(req_header_name header_value)
191 ?context (byte)(string)
192 ?servlet_path (byte)(string)
193 ?remote_user (byte)(string)
194 ?auth_type (byte)(string)
195 ?query_string (byte)(string)
196 ?jvm_route (byte)(string)
197 ?ssl_cert (byte)(string)
198 ?ssl_cipher (byte)(string)
199 ?ssl_session (byte)(string)
200 ?ssl_key_size (byte)(int) via JkOptions +ForwardKeySize
201 request_terminator (byte)
202 ?body content_length*(var binary)
206 static apr_status_t ajp_marshal_into_msgb(ajp_msg_t *msg,
210 apr_uint32_t i, num_headers = 0;
214 const char *session_route, *envvar;
215 const apr_array_header_t *arr = apr_table_elts(r->subprocess_env);
216 const apr_table_entry_t *elts = (const apr_table_entry_t *)arr->elts;
218 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
219 "Into ajp_marshal_into_msgb");
221 if ((method = sc_for_req_method_by_id(r->method_number)) == UNKNOWN_METHOD) {
222 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
223 "Error ajp_marshal_into_msgb - No such method %s",
228 /* XXXX need something */
229 is_ssl = (apr_byte_t) 0; /* s->is_ssl */
231 if (r->headers_in && apr_table_elts(r->headers_in)) {
232 const apr_array_header_t *t = apr_table_elts(r->headers_in);
233 num_headers = t->nelts;
236 remote_host = (char *)ap_get_remote_host(r->connection, r->per_dir_config, REMOTE_HOST, NULL);
238 uri = apr_pstrdup(r->pool, r->uri);
240 char *query_str = strchr(uri, '?');
241 if (query_str != NULL) {
249 if (ajp_msg_append_uint8(msg, CMD_AJP13_FORWARD_REQUEST) ||
250 ajp_msg_append_uint8(msg, method) ||
251 ajp_msg_append_string(msg, r->protocol) ||
252 ajp_msg_append_string(msg, uri) ||
253 ajp_msg_append_string(msg, r->connection->remote_ip) ||
254 ajp_msg_append_string(msg, remote_host) ||
255 ajp_msg_append_string(msg, ap_get_server_name(r)) ||
256 ajp_msg_append_uint16(msg, (apr_uint16_t)r->connection->local_addr->port) ||
257 ajp_msg_append_uint8(msg, is_ssl) ||
258 ajp_msg_append_uint16(msg, (apr_uint16_t) num_headers)) {
260 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
261 "Error ajp_marshal_into_msgb - "
262 "Error appending the message begining");
266 for (i = 0 ; i < num_headers ; i++) {
268 const apr_array_header_t *t = apr_table_elts(r->headers_in);
269 const apr_table_entry_t *elts = (apr_table_entry_t *)t->elts;
271 if ((sc = sc_for_req_header(elts[i].key)) != UNKNOWN_METHOD) {
272 if (ajp_msg_append_uint16(msg, (apr_uint16_t)sc)) {
273 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
274 "Error ajp_marshal_into_msgb - "
275 "Error appending the header name");
280 if (ajp_msg_append_string(msg, elts[i].key)) {
281 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
282 "Error ajp_marshal_into_msgb - "
283 "Error appending the header name");
288 if (ajp_msg_append_string(msg, elts[i].val)) {
289 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
290 "Error ajp_marshal_into_msgb - "
291 "Error appending the header value");
294 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
295 "ajp_marshal_into_msgb: Header[%d] [%s] = [%s]",
296 i, elts[i].key, elts[i].val);
299 /* XXXX need to figure out how to do this
301 if (ajp_msg_append_uint8(msg, SC_A_SECRET) ||
302 ajp_msg_append_string(msg, s->secret)) {
303 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
304 "Error ajp_marshal_into_msgb - "
305 "Error appending secret");
312 if (ajp_msg_append_uint8(msg, SC_A_REMOTE_USER) ||
313 ajp_msg_append_string(msg, r->user)) {
314 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
315 "Error ajp_marshal_into_msgb - "
316 "Error appending the remote user");
320 if (r->ap_auth_type) {
321 if (ajp_msg_append_uint8(msg, SC_A_AUTH_TYPE) ||
322 ajp_msg_append_string(msg, r->ap_auth_type)) {
323 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
324 "Error ajp_marshal_into_msgb - "
325 "Error appending the auth type");
329 /* XXXX ebcdic (args converted?) */
331 if (ajp_msg_append_uint8(msg, SC_A_QUERY_STRING) ||
332 ajp_msg_append_string(msg, r->args)) {
333 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
334 "Error ajp_marshal_into_msgb - "
335 "Error appending the query string");
339 if ((session_route = apr_table_get(r->notes, "session-route"))) {
340 if (ajp_msg_append_uint8(msg, SC_A_JVM_ROUTE) ||
341 ajp_msg_append_string(msg, session_route)) {
342 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
343 "Error ajp_marshal_into_msgb - "
344 "Error appending the jvm route");
348 /* XXX: Is the subprocess_env a right place?
349 * <Location /examples>
350 * ProxyPass ajp://remote:8009/servlets-examples
351 * SetEnv SSL_SESSION_ID CUSTOM_SSL_SESSION_ID
354 if ((envvar = apr_table_get(r->subprocess_env,
355 AJP13_SSL_CLIENT_CERT_INDICATOR))) {
356 if (ajp_msg_append_uint8(msg, SC_A_SSL_CERT) ||
357 ajp_msg_append_string(msg, envvar)) {
358 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
359 "Error ajp_marshal_into_msgb - "
360 "Error appending the SSL certificates");
365 if ((envvar = apr_table_get(r->subprocess_env,
366 AJP13_SSL_CIPHER_INDICATOR))) {
367 if (ajp_msg_append_uint8(msg, SC_A_SSL_CIPHER) ||
368 ajp_msg_append_string(msg, envvar)) {
369 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
370 "Error ajp_marshal_into_msgb - "
371 "Error appending the SSL ciphers");
376 if ((envvar = apr_table_get(r->subprocess_env,
377 AJP13_SSL_SESSION_INDICATOR))) {
378 if (ajp_msg_append_uint8(msg, SC_A_SSL_SESSION) ||
379 ajp_msg_append_string(msg, envvar)) {
380 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
381 "Error ajp_marshal_into_msgb - "
382 "Error appending the SSL session");
388 * ssl_key_size is required by Servlet 2.3 API
389 * added support only in ajp14 mode
390 * JFC removed: ae->proto == AJP14_PROTO
392 /* XXXX ignored for the moment
393 if (s->ssl_key_size != -1) {
394 if (ajp_msg_append_uint8(msg, SC_A_SSL_KEY_SIZE) ||
395 ajp_msg_append_uint16(msg, (unsigned short) s->ssl_key_size)) {
396 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
397 "Error ajp_marshal_into_msgb - "
398 "Error appending the SSL key size");
403 /* Use the environment vars prefixed with AJP_
404 * and pass it to the header striping that prefix.
406 for (i = 0; i < (apr_uint32_t)arr->nelts; i++) {
407 if (!strncmp(elts[i].key, "AJP_", 4)) {
408 if (ajp_msg_append_uint8(msg, SC_A_REQ_ATTRIBUTE) ||
409 ajp_msg_append_string(msg, elts[i].key + 4) ||
410 ajp_msg_append_string(msg, elts[i].val)) {
411 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
412 "Error ajp_marshal_into_msgb - "
413 "Error appending attribute %s=%s",
414 elts[i].key, elts[i].val);
420 if (ajp_msg_append_uint8(msg, SC_A_ARE_DONE)) {
421 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
422 "Error ajp_marshal_into_msgb - "
423 "Error appending the message end");
427 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
428 "ajp_marshal_into_msgb - Done");
433 AJPV13_RESPONSE/AJPV14_RESPONSE:=
438 num_headers*(res_header_name header_value)
440 terminator boolean <! -- recycle connection or not -->
443 sc_req_header_name | (string)
446 sc_res_header_name | (string)
453 body length*(var binary)
458 static apr_status_t ajp_unmarshal_response(ajp_msg_t *msg,
464 apr_uint16_t num_headers;
467 rc = ajp_msg_get_uint16(msg, &status);
469 if (rc != APR_SUCCESS) {
470 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
471 "Error ajp_unmarshal_response - Null status");
476 rc = ajp_msg_get_string(msg, &ptr);
477 if (rc == APR_SUCCESS) {
478 r->status_line = apr_psprintf(r->pool, "%d %s", status, ptr);
479 #if defined(AS400) || defined(_OSD_POSIX)
480 ap_xlate_proto_from_ascii(r->status_line, strlen(r->status_line));
483 r->status_line = NULL;
486 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
487 "ajp_unmarshal_response: status = %d", status);
489 rc = ajp_msg_get_uint16(msg, &num_headers);
490 if (rc == APR_SUCCESS) {
491 r->headers_out = apr_table_make(r->pool, num_headers);
493 r->headers_out = NULL;
497 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
498 "ajp_unmarshal_response: Number of headers is = %d",
501 for(i = 0 ; i < (int) num_headers ; i++) {
505 rc = ajp_msg_peek_uint16(msg, &name);
506 if (rc != APR_SUCCESS) {
510 if ((name & 0XFF00) == 0XA000) {
511 ajp_msg_peek_uint16(msg, &name);
512 stringname = (char *)long_res_header_for_sc(name);
513 if (stringname == NULL) {
514 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
515 "Error ajp_unmarshal_response - "
522 rc = ajp_msg_get_string(msg, &stringname);
523 if (rc != APR_SUCCESS) {
524 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
525 "Error ajp_unmarshal_response - "
529 #if defined(AS400) || defined(_OSD_POSIX)
530 ap_xlate_proto_from_ascii(stringname, strlen(stringname));
534 rc = ajp_msg_get_string(msg, &value);
535 if (rc != APR_SUCCESS) {
536 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
537 "Error ajp_unmarshal_response - "
538 "Null header value");
542 #if defined(AS400) || defined(_OSD_POSIX)
543 ap_xlate_proto_from_ascii(value, strlen(value));
545 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
546 "ajp_unmarshal_response: Header[%d] [%s] = [%s]",
547 i, stringname, value);
548 apr_table_add(r->headers_out, stringname, value);
550 /* Content-type needs an additional handling */
551 if (memcmp(stringname, "Content-Type", 12) == 0) {
552 /* add corresponding filter */
553 ap_set_content_type(r, apr_pstrdup(r->pool, value));
554 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
555 "ajp_unmarshal_response: ap_set_content_type done");
563 * Build the ajp header message and send it
565 apr_status_t ajp_send_header(apr_socket_t *sock,
571 rc = ajp_msg_create(r->pool, &msg);
572 if (rc != APR_SUCCESS) {
573 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
574 "ajp_send_header: ajp_msg_create failed");
578 rc = ajp_marshal_into_msgb(msg, r);
579 if (rc != APR_SUCCESS) {
580 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
581 "ajp_send_header: ajp_marshal_into_msgb failed");
585 rc = ajp_ilink_send(sock, msg);
586 if (rc != APR_SUCCESS) {
587 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
588 "ajp_send_header: ajp_ilink_send failed");
596 * Read the ajp message and return the type of the message.
598 apr_status_t ajp_read_header(apr_socket_t *sock,
605 rc = ajp_msg_create(r->pool, msg);
606 if (rc != APR_SUCCESS) {
607 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
608 "ajp_read_header: ajp_msg_create failed");
612 rc = ajp_ilink_receive(sock, *msg);
613 if (rc != APR_SUCCESS) {
614 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
615 "ajp_read_header: ajp_ilink_receive failed");
618 rc = ajp_msg_peek_uint8(*msg, &result);
619 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
620 "ajp_read_header: ajp_ilink_received %02x", result);
624 /* parse the msg to read the type */
625 int ajp_parse_type(request_rec *r, ajp_msg_t *msg)
628 ajp_msg_peek_uint8(msg, &result);
629 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
630 "ajp_parse_type: got %02x", result);
634 /* parse the header */
635 apr_status_t ajp_parse_header(request_rec *r, ajp_msg_t *msg)
640 rc = ajp_msg_get_uint8(msg, &result);
641 if (rc != APR_SUCCESS) {
642 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
643 "ajp_parse_headers: ajp_msg_get_byte failed");
646 if (result != CMD_AJP13_SEND_HEADERS) {
647 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
648 "ajp_parse_headers: wrong type %02x expecting 0x04", result);
651 return ajp_unmarshal_response(msg, r);
654 /* parse the body and return data address and length */
655 apr_status_t ajp_parse_data(request_rec *r, ajp_msg_t *msg,
656 apr_uint16_t *len, char **ptr)
661 rc = ajp_msg_get_uint8(msg, &result);
662 if (rc != APR_SUCCESS) {
663 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
664 "ajp_parse_data: ajp_msg_get_byte failed");
667 if (result != CMD_AJP13_SEND_BODY_CHUNK) {
668 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
669 "ajp_parse_data: wrong type %02x expecting 0x03", result);
672 rc = ajp_msg_get_uint16(msg, len);
673 if (rc != APR_SUCCESS) {
676 *ptr = (char *)&(msg->buf[msg->pos]);
681 * Allocate a msg to send data
683 apr_status_t ajp_alloc_data_msg(request_rec *r, char **ptr, apr_size_t *len,
688 rc = ajp_msg_create(r->pool, msg);
689 if (rc != APR_SUCCESS) {
690 ap_log_error(APLOG_MARK, APLOG_ERR, 0, r->server,
691 "ajp_alloc_data_msg: ajp_msg_create failed");
695 *ptr = (char *)&((*msg)->buf[6]);
696 *len = AJP_MSG_BUFFER_SZ-6;
702 * Send the data message
704 apr_status_t ajp_send_data_msg(apr_socket_t *sock, request_rec *r,
705 ajp_msg_t *msg, apr_size_t len)
708 msg->buf[4] = (apr_byte_t)((len >> 8) & 0xFF);
709 msg->buf[5] = (apr_byte_t)(len & 0xFF);
711 msg->len += len + 2; /* + 1 XXXX where is '\0' */
713 ap_log_error(APLOG_MARK, APLOG_DEBUG, 0, r->server,
714 "ajp_send_data_msg: sending %" APR_SIZE_T_FMT, len);
716 return ajp_ilink_send(sock, msg);