3 * Copyright 2016 gRPC authors.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
19 #include <grpc/support/port_platform.h>
21 #include "src/core/lib/surface/validate_metadata.h"
26 #include <grpc/grpc.h>
27 #include <grpc/support/alloc.h>
29 #include "src/core/lib/gprpp/bitset.h"
30 #include "src/core/lib/gprpp/memory.h"
31 #include "src/core/lib/iomgr/error.h"
32 #include "src/core/lib/slice/slice_internal.h"
33 #include "src/core/lib/slice/slice_string_helpers.h"
35 #if __cplusplus > 201103l
36 #define GRPC_VALIDATE_METADATA_CONSTEXPR_FN constexpr
37 #define GRPC_VALIDATE_METADATA_CONSTEXPR_VALUE constexpr
39 #define GRPC_VALIDATE_METADATA_CONSTEXPR_FN
40 #define GRPC_VALIDATE_METADATA_CONSTEXPR_VALUE const
43 static grpc_error_handle conforms_to(const grpc_slice& slice,
44 const grpc_core::BitSet<256>& legal_bits,
45 const char* err_desc) {
46 const uint8_t* p = GRPC_SLICE_START_PTR(slice);
47 const uint8_t* e = GRPC_SLICE_END_PTR(slice);
49 if (!legal_bits.is_set(*p)) {
50 grpc_error_handle error = grpc_error_set_str(
51 grpc_error_set_int(GRPC_ERROR_CREATE_FROM_COPIED_STRING(err_desc),
52 GRPC_ERROR_INT_OFFSET,
53 p - GRPC_SLICE_START_PTR(slice)),
54 GRPC_ERROR_STR_RAW_BYTES,
55 grpc_dump_slice_to_slice(slice, GPR_DUMP_HEX | GPR_DUMP_ASCII));
59 return GRPC_ERROR_NONE;
62 static int error2int(grpc_error_handle error) {
63 int r = (error == GRPC_ERROR_NONE);
64 GRPC_ERROR_UNREF(error);
69 class LegalHeaderKeyBits : public grpc_core::BitSet<256> {
71 GRPC_VALIDATE_METADATA_CONSTEXPR_FN LegalHeaderKeyBits() {
72 for (int i = 'a'; i <= 'z'; i++) set(i);
73 for (int i = '0'; i <= '9'; i++) set(i);
79 static GRPC_VALIDATE_METADATA_CONSTEXPR_VALUE LegalHeaderKeyBits
80 g_legal_header_key_bits;
83 grpc_error_handle grpc_validate_header_key_is_legal(const grpc_slice& slice) {
84 if (GRPC_SLICE_LENGTH(slice) == 0) {
85 return GRPC_ERROR_CREATE_FROM_STATIC_STRING(
86 "Metadata keys cannot be zero length");
88 if (GRPC_SLICE_LENGTH(slice) > UINT32_MAX) {
89 return GRPC_ERROR_CREATE_FROM_STATIC_STRING(
90 "Metadata keys cannot be larger than UINT32_MAX");
92 if (GRPC_SLICE_START_PTR(slice)[0] == ':') {
93 return GRPC_ERROR_CREATE_FROM_STATIC_STRING(
94 "Metadata keys cannot start with :");
96 return conforms_to(slice, g_legal_header_key_bits, "Illegal header key");
99 int grpc_header_key_is_legal(grpc_slice slice) {
100 return error2int(grpc_validate_header_key_is_legal(slice));
104 class LegalHeaderNonBinValueBits : public grpc_core::BitSet<256> {
106 GRPC_VALIDATE_METADATA_CONSTEXPR_FN LegalHeaderNonBinValueBits() {
107 for (int i = 32; i <= 126; i++) {
112 static GRPC_VALIDATE_METADATA_CONSTEXPR_VALUE LegalHeaderNonBinValueBits
113 g_legal_header_non_bin_value_bits;
116 grpc_error_handle grpc_validate_header_nonbin_value_is_legal(
117 const grpc_slice& slice) {
118 return conforms_to(slice, g_legal_header_non_bin_value_bits,
119 "Illegal header value");
122 int grpc_header_nonbin_value_is_legal(grpc_slice slice) {
123 return error2int(grpc_validate_header_nonbin_value_is_legal(slice));
126 int grpc_is_binary_header_internal(const grpc_slice& slice) {
127 return grpc_key_is_binary_header(GRPC_SLICE_START_PTR(slice),
128 GRPC_SLICE_LENGTH(slice));
131 int grpc_is_binary_header(grpc_slice slice) {
132 return grpc_is_binary_header_internal(slice);