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; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 59 | grpc_mdctx *mdctx; |
ctiller | d74729d | 2015-01-12 13:31:36 -0800 | [diff] [blame] | 60 | } call_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 61 | |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 62 | typedef struct channel_data { gpr_uint8 unused; } channel_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 63 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 64 | typedef struct { |
Craig Tiller | d1bec03 | 2015-09-18 17:29:00 -0700 | [diff] [blame] | 65 | grpc_call_element *elem; |
Craig Tiller | 8af4c33 | 2015-09-22 12:32:31 -0700 | [diff] [blame] | 66 | grpc_exec_ctx *exec_ctx; |
Craig Tiller | d1bec03 | 2015-09-18 17:29:00 -0700 | [diff] [blame] | 67 | } server_filter_args; |
| 68 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 69 | static grpc_mdelem *server_filter(void *user_data, grpc_mdelem *md) { |
Craig Tiller | d1bec03 | 2015-09-18 17:29:00 -0700 | [diff] [blame] | 70 | server_filter_args *a = user_data; |
| 71 | grpc_call_element *elem = a->elem; |
Craig Tiller | fd7d3ec | 2015-01-21 13:37:09 -0800 | [diff] [blame] | 72 | call_data *calld = elem->call_data; |
Craig Tiller | fd7d3ec | 2015-01-21 13:37:09 -0800 | [diff] [blame] | 73 | |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 74 | /* Check if it is one of the headers we care about. */ |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 75 | if (md == GRPC_MDELEM_TE_TRAILERS || md == GRPC_MDELEM_METHOD_POST || |
| 76 | md == GRPC_MDELEM_SCHEME_HTTP || md == GRPC_MDELEM_SCHEME_HTTPS || |
| 77 | md == GRPC_MDELEM_CONTENT_TYPE_APPLICATION_SLASH_GRPC) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 78 | /* swallow it */ |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 79 | if (md == GRPC_MDELEM_METHOD_POST) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 80 | calld->seen_post = 1; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 81 | } else if (md->key == GRPC_MDSTR_SCHEME) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 82 | calld->seen_scheme = 1; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 83 | } else if (md == GRPC_MDELEM_TE_TRAILERS) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 84 | calld->seen_te_trailers = 1; |
| 85 | } |
| 86 | /* TODO(klempner): Track that we've seen all the headers we should |
| 87 | require */ |
| 88 | return NULL; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 89 | } else if (md->key == GRPC_MDSTR_CONTENT_TYPE) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 90 | if (strncmp(grpc_mdstr_as_c_string(md->value), "application/grpc+", 17) == |
| 91 | 0) { |
| 92 | /* Although the C implementation doesn't (currently) generate them, |
| 93 | any custom +-suffix is explicitly valid. */ |
| 94 | /* TODO(klempner): We should consider preallocating common values such |
| 95 | as +proto or +json, or at least stashing them if we see them. */ |
| 96 | /* TODO(klempner): Should we be surfacing this to application code? */ |
| 97 | } else { |
| 98 | /* TODO(klempner): We're currently allowing this, but we shouldn't |
| 99 | see it without a proxy so log for now. */ |
| 100 | gpr_log(GPR_INFO, "Unexpected content-type %s", |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 101 | grpc_mdstr_as_c_string(md->value)); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 102 | } |
| 103 | return NULL; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 104 | } else if (md->key == GRPC_MDSTR_TE || md->key == GRPC_MDSTR_METHOD || |
| 105 | md->key == GRPC_MDSTR_SCHEME) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 106 | gpr_log(GPR_ERROR, "Invalid %s: header: '%s'", |
| 107 | grpc_mdstr_as_c_string(md->key), grpc_mdstr_as_c_string(md->value)); |
| 108 | /* swallow it and error everything out. */ |
| 109 | /* TODO(klempner): We ought to generate more descriptive error messages |
| 110 | on the wire here. */ |
| 111 | grpc_call_element_send_cancel(a->exec_ctx, elem); |
| 112 | return NULL; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 113 | } else if (md->key == GRPC_MDSTR_PATH) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 114 | if (calld->seen_path) { |
| 115 | gpr_log(GPR_ERROR, "Received :path twice"); |
Craig Tiller | 6902ad2 | 2015-04-16 08:01:49 -0700 | [diff] [blame] | 116 | return NULL; |
| 117 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 118 | calld->seen_path = 1; |
| 119 | return md; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 120 | } else if (md->key == GRPC_MDSTR_AUTHORITY) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 121 | calld->seen_authority = 1; |
| 122 | return md; |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 123 | } else if (md->key == GRPC_MDSTR_HOST) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 124 | /* translate host to :authority since :authority may be |
| 125 | omitted */ |
| 126 | grpc_mdelem *authority = grpc_mdelem_from_metadata_strings( |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 127 | calld->mdctx, GRPC_MDSTR_AUTHORITY, GRPC_MDSTR_REF(md->value)); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 128 | GRPC_MDELEM_UNREF(md); |
| 129 | calld->seen_authority = 1; |
| 130 | return authority; |
| 131 | } else { |
| 132 | return md; |
| 133 | } |
Craig Tiller | ce6e350 | 2015-01-19 18:04:42 -0800 | [diff] [blame] | 134 | } |
| 135 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 136 | 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] | 137 | grpc_call_element *elem = user_data; |
| 138 | call_data *calld = elem->call_data; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 139 | if (success) { |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 140 | server_filter_args a; |
| 141 | a.elem = elem; |
| 142 | a.exec_ctx = exec_ctx; |
| 143 | grpc_metadata_batch_filter(calld->recv_initial_metadata, server_filter, &a); |
| 144 | /* Have we seen the required http2 transport headers? |
| 145 | (:method, :scheme, content-type, with :path and :authority covered |
| 146 | at the channel level right now) */ |
| 147 | if (calld->seen_post && calld->seen_scheme && calld->seen_te_trailers && |
| 148 | calld->seen_path && calld->seen_authority) { |
| 149 | /* do nothing */ |
| 150 | } else { |
| 151 | if (!calld->seen_path) { |
| 152 | gpr_log(GPR_ERROR, "Missing :path header"); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 153 | } |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 154 | if (!calld->seen_authority) { |
| 155 | gpr_log(GPR_ERROR, "Missing :authority header"); |
| 156 | } |
| 157 | if (!calld->seen_post) { |
| 158 | gpr_log(GPR_ERROR, "Missing :method header"); |
| 159 | } |
| 160 | if (!calld->seen_scheme) { |
| 161 | gpr_log(GPR_ERROR, "Missing :scheme header"); |
| 162 | } |
| 163 | if (!calld->seen_te_trailers) { |
| 164 | gpr_log(GPR_ERROR, "Missing te trailers header"); |
| 165 | } |
| 166 | /* Error this call out */ |
| 167 | success = 0; |
| 168 | grpc_call_element_send_cancel(exec_ctx, elem); |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 169 | } |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 170 | } |
| 171 | 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] | 172 | } |
| 173 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 174 | static void hs_mutate_op(grpc_call_element *elem, |
| 175 | grpc_transport_stream_op *op) { |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 176 | /* grab pointers to our data from the call element */ |
| 177 | call_data *calld = elem->call_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 178 | |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 179 | if (op->send_initial_metadata != NULL && !calld->sent_status) { |
| 180 | calld->sent_status = 1; |
| 181 | grpc_metadata_batch_add_head(op->send_initial_metadata, &calld->status, |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 182 | GRPC_MDELEM_STATUS_200); |
| 183 | grpc_metadata_batch_add_tail( |
| 184 | op->send_initial_metadata, &calld->content_type, |
| 185 | GRPC_MDELEM_CONTENT_TYPE_APPLICATION_SLASH_GRPC); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 186 | } |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 187 | |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 188 | if (op->recv_initial_metadata) { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 189 | /* substitute our callback for the higher callback */ |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 190 | calld->recv_initial_metadata = op->recv_initial_metadata; |
| 191 | calld->on_done_recv = op->on_complete; |
| 192 | op->on_complete = &calld->hs_on_recv; |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 193 | } |
Craig Tiller | 50d9db5 | 2015-04-23 10:52:14 -0700 | [diff] [blame] | 194 | } |
Craig Tiller | 83f88d9 | 2015-04-21 16:02:05 -0700 | [diff] [blame] | 195 | |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 196 | static void hs_start_transport_op(grpc_exec_ctx *exec_ctx, |
| 197 | grpc_call_element *elem, |
| 198 | grpc_transport_stream_op *op) { |
| 199 | GRPC_CALL_LOG_OP(GPR_INFO, elem, op); |
Craig Tiller | 0ba432d | 2015-10-09 16:57:11 -0700 | [diff] [blame] | 200 | GPR_TIMER_BEGIN("hs_start_transport_op", 0); |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 201 | hs_mutate_op(elem, op); |
| 202 | grpc_call_next_op(exec_ctx, elem, op); |
Craig Tiller | 0ba432d | 2015-10-09 16:57:11 -0700 | [diff] [blame] | 203 | GPR_TIMER_END("hs_start_transport_op", 0); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 204 | } |
| 205 | |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 206 | /* Constructor for call_data */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 207 | 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] | 208 | grpc_call_element_args *args) { |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 209 | /* grab pointers to our data from the call element */ |
| 210 | call_data *calld = elem->call_data; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 211 | /* initialize members */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 212 | memset(calld, 0, sizeof(*calld)); |
| 213 | grpc_closure_init(&calld->hs_on_recv, hs_on_recv, elem); |
Craig Tiller | ebdef9d | 2015-11-19 17:09:49 -0800 | [diff] [blame^] | 214 | calld->mdctx = args->metadata_context; |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 215 | } |
| 216 | |
| 217 | /* Destructor for call_data */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 218 | static void destroy_call_elem(grpc_exec_ctx *exec_ctx, |
| 219 | grpc_call_element *elem) {} |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 220 | |
| 221 | /* Constructor for channel_data */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 222 | static void init_channel_elem(grpc_exec_ctx *exec_ctx, |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 223 | grpc_channel_element *elem, |
| 224 | grpc_channel_element_args *args) { |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 225 | GPR_ASSERT(!args->is_last); |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 226 | } |
| 227 | |
| 228 | /* Destructor for channel data */ |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 229 | static void destroy_channel_elem(grpc_exec_ctx *exec_ctx, |
| 230 | grpc_channel_element *elem) { |
Nicolas Noble | b7ebd3b | 2014-11-26 16:33:03 -0800 | [diff] [blame] | 231 | } |
| 232 | |
| 233 | const grpc_channel_filter grpc_http_server_filter = { |
Craig Tiller | a82950e | 2015-09-22 12:33:20 -0700 | [diff] [blame] | 234 | hs_start_transport_op, grpc_channel_next_op, sizeof(call_data), |
Craig Tiller | 577c9b2 | 2015-11-02 14:11:15 -0800 | [diff] [blame] | 235 | init_call_elem, grpc_call_stack_ignore_set_pollset, destroy_call_elem, |
| 236 | sizeof(channel_data), init_channel_elem, destroy_channel_elem, |
| 237 | grpc_call_next_get_peer, "http-server"}; |