Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 1 | /* |
| 2 | * |
Craig Tiller | 0605995 | 2015-02-18 08:34:56 -0800 | [diff] [blame] | 3 | * Copyright 2015, Google Inc. |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | * |
| 32 | */ |
| 33 | |
| 34 | #include "src/core/channel/http_server_filter.h" |
ctiller | d74729d | 2015-01-12 13:31:36 -0800 | [diff] [blame] | 35 | |
| 36 | #include <string.h> |
Craig Tiller | c50e398 | 2015-01-20 16:30:54 -0800 | [diff] [blame] | 37 | #include <grpc/support/alloc.h> |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 38 | #include <grpc/support/log.h> |
Craig Tiller | 1f41b6b | 2015-10-09 15:07:02 -0700 | [diff] [blame] | 39 | #include "src/core/profiling/timers.h" |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 40 | #include "src/core/transport/static_metadata.h" |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 41 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 42 | typedef struct call_data { |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 43 | gpr_uint8 seen_path; |
| 44 | gpr_uint8 seen_post; |
Craig Tiller | d2d0a11 | 2015-01-19 16:07:52 -0800 | [diff] [blame] | 45 | gpr_uint8 sent_status; |
| 46 | gpr_uint8 seen_scheme; |
Craig Tiller | d2d0a11 | 2015-01-19 16:07:52 -0800 | [diff] [blame] | 47 | gpr_uint8 seen_te_trailers; |
Craig Tiller | c4b56b6 | 2015-07-23 17:44:11 -0700 | [diff] [blame] | 48 | gpr_uint8 seen_authority; |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 49 | grpc_linked_mdelem status; |
Craig Tiller | cb01417 | 2015-09-08 16:40:26 -0700 | [diff] [blame] | 50 | grpc_linked_mdelem content_type; |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 51 | |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 52 | grpc_metadata_batch *recv_initial_metadata; |
Craig Tiller | 98bf7e6 | 2015-06-24 08:47:07 -0700 | [diff] [blame] | 53 | /** Closure to call when finished with the hs_on_recv hook */ |
Craig Tiller | 3382511 | 2015-09-18 07:44:19 -0700 | [diff] [blame] | 54 | grpc_closure *on_done_recv; |
Craig Tiller | 98bf7e6 | 2015-06-24 08:47:07 -0700 | [diff] [blame] | 55 | /** Receive closures are chained: we inject this closure as the on_done_recv |
| 56 | up-call on transport_op, and remember to call our on_done_recv member |
| 57 | after handling it. */ |
Craig Tiller | 3382511 | 2015-09-18 07:44:19 -0700 | [diff] [blame] | 58 | grpc_closure hs_on_recv; |
ctiller | d74729d | 2015-01-12 13:31:36 -0800 | [diff] [blame] | 59 | } call_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 60 | |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 61 | typedef struct channel_data { gpr_uint8 unused; } channel_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 62 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 63 | typedef struct { |
Craig Tiller | d1bec03 | 2015-09-18 17:29:00 -0700 | [diff] [blame] | 64 | grpc_call_element *elem; |
Craig Tiller | 8af4c33 | 2015-09-22 12:32:31 -0700 | [diff] [blame] | 65 | grpc_exec_ctx *exec_ctx; |
Craig Tiller | d1bec03 | 2015-09-18 17:29:00 -0700 | [diff] [blame] | 66 | } server_filter_args; |
| 67 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 68 | static grpc_mdelem *server_filter(void *user_data, grpc_mdelem *md) { |
Craig Tiller | d1bec03 | 2015-09-18 17:29:00 -0700 | [diff] [blame] | 69 | server_filter_args *a = user_data; |
| 70 | grpc_call_element *elem = a->elem; |
Craig Tiller | fd7d3ec | 2015-01-21 13:37:09 -0800 | [diff] [blame] | 71 | call_data *calld = elem->call_data; |
Craig Tiller | fd7d3ec | 2015-01-21 13:37:09 -0800 | [diff] [blame] | 72 | |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 73 | /* Check if it is one of the headers we care about. */ |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 74 | if (md == GRPC_MDELEM_TE_TRAILERS || md == GRPC_MDELEM_METHOD_POST || |
| 75 | md == GRPC_MDELEM_SCHEME_HTTP || md == GRPC_MDELEM_SCHEME_HTTPS || |
| 76 | md == GRPC_MDELEM_CONTENT_TYPE_APPLICATION_SLASH_GRPC) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 77 | /* swallow it */ |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 78 | if (md == GRPC_MDELEM_METHOD_POST) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 79 | calld->seen_post = 1; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 80 | } else if (md->key == GRPC_MDSTR_SCHEME) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 81 | calld->seen_scheme = 1; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 82 | } else if (md == GRPC_MDELEM_TE_TRAILERS) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 83 | calld->seen_te_trailers = 1; |
| 84 | } |
| 85 | /* TODO(klempner): Track that we've seen all the headers we should |
| 86 | require */ |
| 87 | return NULL; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 88 | } else if (md->key == GRPC_MDSTR_CONTENT_TYPE) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 89 | if (strncmp(grpc_mdstr_as_c_string(md->value), "application/grpc+", 17) == |
| 90 | 0) { |
| 91 | /* Although the C implementation doesn't (currently) generate them, |
| 92 | any custom +-suffix is explicitly valid. */ |
| 93 | /* TODO(klempner): We should consider preallocating common values such |
| 94 | as +proto or +json, or at least stashing them if we see them. */ |
| 95 | /* TODO(klempner): Should we be surfacing this to application code? */ |
| 96 | } else { |
| 97 | /* TODO(klempner): We're currently allowing this, but we shouldn't |
| 98 | see it without a proxy so log for now. */ |
| 99 | gpr_log(GPR_INFO, "Unexpected content-type %s", |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 100 | grpc_mdstr_as_c_string(md->value)); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 101 | } |
| 102 | return NULL; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 103 | } else if (md->key == GRPC_MDSTR_TE || md->key == GRPC_MDSTR_METHOD || |
| 104 | md->key == GRPC_MDSTR_SCHEME) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 105 | gpr_log(GPR_ERROR, "Invalid %s: header: '%s'", |
| 106 | grpc_mdstr_as_c_string(md->key), grpc_mdstr_as_c_string(md->value)); |
| 107 | /* swallow it and error everything out. */ |
| 108 | /* TODO(klempner): We ought to generate more descriptive error messages |
| 109 | on the wire here. */ |
| 110 | grpc_call_element_send_cancel(a->exec_ctx, elem); |
| 111 | return NULL; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 112 | } else if (md->key == GRPC_MDSTR_PATH) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 113 | if (calld->seen_path) { |
| 114 | gpr_log(GPR_ERROR, "Received :path twice"); |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 115 | return NULL; |
| 116 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 117 | calld->seen_path = 1; |
| 118 | return md; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 119 | } else if (md->key == GRPC_MDSTR_AUTHORITY) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 120 | calld->seen_authority = 1; |
| 121 | return md; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 122 | } else if (md->key == GRPC_MDSTR_HOST) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 123 | /* translate host to :authority since :authority may be |
| 124 | omitted */ |
| 125 | grpc_mdelem *authority = grpc_mdelem_from_metadata_strings( |
Craig Tiller | b2b4261 | 2015-11-20 12:02:17 -0800 | [diff] [blame^] | 126 | GRPC_MDSTR_AUTHORITY, GRPC_MDSTR_REF(md->value)); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 127 | GRPC_MDELEM_UNREF(md); |
| 128 | calld->seen_authority = 1; |
| 129 | return authority; |
| 130 | } else { |
| 131 | return md; |
| 132 | } |
Craig Tiller | ce6e350 | 2015-01-19 18:04:42 -0800 | [diff] [blame] | 133 | } |
| 134 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 135 | static void hs_on_recv(grpc_exec_ctx *exec_ctx, void *user_data, int success) { |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 136 | grpc_call_element *elem = user_data; |
| 137 | call_data *calld = elem->call_data; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 138 | if (success) { |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 139 | server_filter_args a; |
| 140 | a.elem = elem; |
| 141 | a.exec_ctx = exec_ctx; |
| 142 | grpc_metadata_batch_filter(calld->recv_initial_metadata, server_filter, &a); |
| 143 | /* Have we seen the required http2 transport headers? |
| 144 | (:method, :scheme, content-type, with :path and :authority covered |
| 145 | at the channel level right now) */ |
| 146 | if (calld->seen_post && calld->seen_scheme && calld->seen_te_trailers && |
| 147 | calld->seen_path && calld->seen_authority) { |
| 148 | /* do nothing */ |
| 149 | } else { |
| 150 | if (!calld->seen_path) { |
| 151 | gpr_log(GPR_ERROR, "Missing :path header"); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 152 | } |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 153 | if (!calld->seen_authority) { |
| 154 | gpr_log(GPR_ERROR, "Missing :authority header"); |
| 155 | } |
| 156 | if (!calld->seen_post) { |
| 157 | gpr_log(GPR_ERROR, "Missing :method header"); |
| 158 | } |
| 159 | if (!calld->seen_scheme) { |
| 160 | gpr_log(GPR_ERROR, "Missing :scheme header"); |
| 161 | } |
| 162 | if (!calld->seen_te_trailers) { |
| 163 | gpr_log(GPR_ERROR, "Missing te trailers header"); |
| 164 | } |
| 165 | /* Error this call out */ |
| 166 | success = 0; |
| 167 | grpc_call_element_send_cancel(exec_ctx, elem); |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 168 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 169 | } |
| 170 | calld->on_done_recv->cb(exec_ctx, calld->on_done_recv->cb_arg, success); |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 171 | } |
| 172 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 173 | static void hs_mutate_op(grpc_call_element *elem, |
| 174 | grpc_transport_stream_op *op) { |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 175 | /* grab pointers to our data from the call element */ |
| 176 | call_data *calld = elem->call_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 177 | |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 178 | if (op->send_initial_metadata != NULL && !calld->sent_status) { |
| 179 | calld->sent_status = 1; |
| 180 | grpc_metadata_batch_add_head(op->send_initial_metadata, &calld->status, |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame] | 181 | GRPC_MDELEM_STATUS_200); |
| 182 | grpc_metadata_batch_add_tail( |
| 183 | op->send_initial_metadata, &calld->content_type, |
| 184 | GRPC_MDELEM_CONTENT_TYPE_APPLICATION_SLASH_GRPC); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 185 | } |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 186 | |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 187 | if (op->recv_initial_metadata) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 188 | /* substitute our callback for the higher callback */ |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 189 | calld->recv_initial_metadata = op->recv_initial_metadata; |
| 190 | calld->on_done_recv = op->on_complete; |
| 191 | op->on_complete = &calld->hs_on_recv; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 192 | } |
Craig Tiller | 50d9db5 | 2015-04-23 10:52:14 -0700 | [diff] [blame] | 193 | } |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 194 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 195 | static void hs_start_transport_op(grpc_exec_ctx *exec_ctx, |
| 196 | grpc_call_element *elem, |
| 197 | grpc_transport_stream_op *op) { |
| 198 | GRPC_CALL_LOG_OP(GPR_INFO, elem, op); |
Craig Tiller | 0ba432d | 2015-10-09 16:57:11 -0700 | [diff] [blame] | 199 | GPR_TIMER_BEGIN("hs_start_transport_op", 0); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 200 | hs_mutate_op(elem, op); |
| 201 | grpc_call_next_op(exec_ctx, elem, op); |
Craig Tiller | 0ba432d | 2015-10-09 16:57:11 -0700 | [diff] [blame] | 202 | GPR_TIMER_END("hs_start_transport_op", 0); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 203 | } |
| 204 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 205 | /* Constructor for call_data */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 206 | static void init_call_elem(grpc_exec_ctx *exec_ctx, grpc_call_element *elem, |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 207 | grpc_call_element_args *args) { |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 208 | /* grab pointers to our data from the call element */ |
| 209 | call_data *calld = elem->call_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 210 | /* initialize members */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 211 | memset(calld, 0, sizeof(*calld)); |
| 212 | grpc_closure_init(&calld->hs_on_recv, hs_on_recv, elem); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 213 | } |
| 214 | |
| 215 | /* Destructor for call_data */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 216 | static void destroy_call_elem(grpc_exec_ctx *exec_ctx, |
| 217 | grpc_call_element *elem) {} |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 218 | |
| 219 | /* Constructor for channel_data */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 220 | static void init_channel_elem(grpc_exec_ctx *exec_ctx, |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 221 | grpc_channel_element *elem, |
| 222 | grpc_channel_element_args *args) { |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 223 | GPR_ASSERT(!args->is_last); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 224 | } |
| 225 | |
| 226 | /* Destructor for channel data */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 227 | static void destroy_channel_elem(grpc_exec_ctx *exec_ctx, |
| 228 | grpc_channel_element *elem) { |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 229 | } |
| 230 | |
| 231 | const grpc_channel_filter grpc_http_server_filter = { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 232 | hs_start_transport_op, grpc_channel_next_op, sizeof(call_data), |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 233 | init_call_elem, grpc_call_stack_ignore_set_pollset, destroy_call_elem, |
| 234 | sizeof(channel_data), init_channel_elem, destroy_channel_elem, |
| 235 | grpc_call_next_get_peer, "http-server"}; |