1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
*
* Libmemcached library
*
* Copyright (C) 2011 Data Differential, http://datadifferential.com/
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
*
* * The names of its contributors may not be used to endorse or
* promote products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*/
/* -*- Mode: C; tab-width: 2; c-basic-offset: 2; indent-tabs-mode: nil -*- */
#include <libmemcachedprotocol/common.h>
#include <sys/types.h>
#define ensure(a) if (!(a)) { return false; }
bool memcached_binary_protocol_pedantic_check_request(const protocol_binary_request_header *request)
{
ensure(request->request.magic == PROTOCOL_BINARY_REQ);
ensure(request->request.datatype == PROTOCOL_BINARY_RAW_BYTES);
ensure(request->bytes[6] == 0);
ensure(request->bytes[7] == 0);
uint8_t opcode= request->request.opcode;
uint16_t keylen= ntohs(request->request.keylen);
uint8_t extlen= request->request.extlen;
uint32_t bodylen= ntohl(request->request.bodylen);
ensure(bodylen >= (keylen + extlen));
switch (opcode) {
case PROTOCOL_BINARY_CMD_GET:
case PROTOCOL_BINARY_CMD_GETK:
case PROTOCOL_BINARY_CMD_GETKQ:
case PROTOCOL_BINARY_CMD_GETQ:
ensure(extlen == 0);
ensure(keylen > 0);
ensure(keylen == bodylen);
ensure(request->request.cas == 0);
break;
case PROTOCOL_BINARY_CMD_ADD:
case PROTOCOL_BINARY_CMD_ADDQ:
/* it makes no sense to run add with a cas value */
ensure(request->request.cas == 0);
/* FALLTHROUGH */
case PROTOCOL_BINARY_CMD_SET:
case PROTOCOL_BINARY_CMD_SETQ:
case PROTOCOL_BINARY_CMD_REPLACE:
case PROTOCOL_BINARY_CMD_REPLACEQ:
ensure(keylen > 0);
ensure(extlen == 8);
break;
case PROTOCOL_BINARY_CMD_DELETE:
case PROTOCOL_BINARY_CMD_DELETEQ:
ensure(extlen == 0);
ensure(keylen > 0);
ensure(keylen == bodylen);
break;
case PROTOCOL_BINARY_CMD_INCREMENT:
case PROTOCOL_BINARY_CMD_INCREMENTQ:
case PROTOCOL_BINARY_CMD_DECREMENT:
case PROTOCOL_BINARY_CMD_DECREMENTQ:
ensure(extlen == 20);
ensure(keylen > 0);
ensure(keylen + extlen == bodylen);
break;
case PROTOCOL_BINARY_CMD_QUIT:
case PROTOCOL_BINARY_CMD_QUITQ:
case PROTOCOL_BINARY_CMD_NOOP:
case PROTOCOL_BINARY_CMD_VERSION:
ensure(extlen == 0);
ensure(keylen == 0);
ensure(bodylen == 0);
break;
case PROTOCOL_BINARY_CMD_FLUSH:
case PROTOCOL_BINARY_CMD_FLUSHQ:
ensure(extlen == 0 || extlen == 4);
ensure(keylen == 0);
ensure(bodylen == extlen);
break;
case PROTOCOL_BINARY_CMD_STAT:
ensure(extlen == 0);
/* May have key, but not value */
ensure(keylen == bodylen);
break;
case PROTOCOL_BINARY_CMD_APPEND:
case PROTOCOL_BINARY_CMD_APPENDQ:
case PROTOCOL_BINARY_CMD_PREPEND:
case PROTOCOL_BINARY_CMD_PREPENDQ:
ensure(extlen == 0);
ensure(keylen > 0);
break;
default:
/* Unknown command */
;
}
return true;
}
bool memcached_binary_protocol_pedantic_check_response(const protocol_binary_request_header *request,
const protocol_binary_response_header *response)
{
ensure(response->response.magic == PROTOCOL_BINARY_RES);
ensure(response->response.datatype == PROTOCOL_BINARY_RAW_BYTES);
ensure(response->response.opaque == request->request.opaque);
uint16_t status= ntohs(response->response.status);
uint8_t opcode= response->response.opcode;
if (status == PROTOCOL_BINARY_RESPONSE_SUCCESS)
{
switch (opcode) {
case PROTOCOL_BINARY_CMD_ADDQ:
case PROTOCOL_BINARY_CMD_APPENDQ:
case PROTOCOL_BINARY_CMD_DECREMENTQ:
case PROTOCOL_BINARY_CMD_DELETEQ:
case PROTOCOL_BINARY_CMD_FLUSHQ:
case PROTOCOL_BINARY_CMD_INCREMENTQ:
case PROTOCOL_BINARY_CMD_PREPENDQ:
case PROTOCOL_BINARY_CMD_QUITQ:
case PROTOCOL_BINARY_CMD_REPLACEQ:
case PROTOCOL_BINARY_CMD_SETQ:
/* Quiet command shouldn't return on success */
return false;
default:
break;
}
switch (opcode) {
case PROTOCOL_BINARY_CMD_ADD:
case PROTOCOL_BINARY_CMD_REPLACE:
case PROTOCOL_BINARY_CMD_SET:
case PROTOCOL_BINARY_CMD_APPEND:
case PROTOCOL_BINARY_CMD_PREPEND:
ensure(response->response.keylen == 0);
ensure(response->response.extlen == 0);
ensure(response->response.bodylen == 0);
ensure(response->response.cas != 0);
break;
case PROTOCOL_BINARY_CMD_FLUSH:
case PROTOCOL_BINARY_CMD_NOOP:
case PROTOCOL_BINARY_CMD_QUIT:
case PROTOCOL_BINARY_CMD_DELETE:
ensure(response->response.keylen == 0);
ensure(response->response.extlen == 0);
ensure(response->response.bodylen == 0);
ensure(response->response.cas == 0);
break;
case PROTOCOL_BINARY_CMD_DECREMENT:
case PROTOCOL_BINARY_CMD_INCREMENT:
ensure(response->response.keylen == 0);
ensure(response->response.extlen == 0);
ensure(ntohl(response->response.bodylen) == 8);
ensure(response->response.cas != 0);
break;
case PROTOCOL_BINARY_CMD_STAT:
ensure(response->response.extlen == 0);
/* key and value exists in all packets except in the terminating */
ensure(response->response.cas == 0);
break;
case PROTOCOL_BINARY_CMD_VERSION:
ensure(response->response.keylen == 0);
ensure(response->response.extlen == 0);
ensure(response->response.bodylen != 0);
ensure(response->response.cas == 0);
break;
case PROTOCOL_BINARY_CMD_GET:
case PROTOCOL_BINARY_CMD_GETQ:
ensure(response->response.keylen == 0);
ensure(response->response.extlen == 4);
ensure(response->response.cas != 0);
break;
case PROTOCOL_BINARY_CMD_GETK:
case PROTOCOL_BINARY_CMD_GETKQ:
ensure(response->response.keylen != 0);
ensure(response->response.extlen == 4);
ensure(response->response.cas != 0);
break;
default:
/* Undefined command code */
break;
}
}
else
{
ensure(response->response.cas == 0);
ensure(response->response.extlen == 0);
if (opcode != PROTOCOL_BINARY_CMD_GETK)
{
ensure(response->response.keylen == 0);
}
}
return true;
}
|
