-
Notifications
You must be signed in to change notification settings - Fork 1
/
packet-couchbase.c
2193 lines (1898 loc) · 65.6 KB
/
packet-couchbase.c
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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* packet-couchbase.c
*
* Routines for Couchbase Protocol.
* Copyright 2011, Sergey Avseyev <sergey.avseyev@gmail.com>
*
* Based on packet-couchbase.c: mecmcache binary protocol.
*
* Routines for Memcache Binary Protocol
* http://code.google.com/p/memcached/wiki/MemcacheBinaryProtocol
*
* Copyright 2009, Stig Bjorlykke <stig@bjorlykke.org>
*
* Routines for Memcache Textual Protocol
* http://code.sixapart.com/svn/memcached/trunk/server/doc/protocol.txt
*
* Copyright 2009, Rama Chitta <rama@gear6.com>
*
* $Id$
*
* Wireshark - Network traffic analyzer
* By Gerald Combs <gerald@wireshark.org>
* Copyright 1998 Gerald Combs
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <glib.h>
#include <epan/conversation.h>
#include <epan/packet.h>
#include <epan/strutil.h>
#include <epan/base64.h>
#include <epan/emem.h>
#include <epan/stats_tree.h>
#include <epan/req_resp_hdrs.h>
#include <epan/prefs.h>
#include <epan/expert.h>
#include "packet-tcp.h"
#define PNAME "Couchbase Protocol"
#define PSNAME "COUCHBASE"
#define PFNAME "couchbase"
#define COUCHBASE_PORT 11210
#define COUCHBASE_HEADER_LEN 24
/* Magic Byte */
#define MAGIC_REQUEST 0x80
#define MAGIC_RESPONSE 0x81
/* Response Status */
#define RS_NO_ERROR 0x0000
#define RS_KEY_NOT_FOUND 0x0001
#define RS_KEY_EXISTS 0x0002
#define RS_VALUE_TOO_BIG 0x0003
#define RS_INVALID_ARGUMENTS 0x0004
#define RS_ITEM_NOT_STORED 0x0005
#define RS_UNKNOWN_COMMAND 0x0081
#define RS_OUT_OF_MEMORY 0x0082
/* Command Opcodes */
#define OP_GET 0x00
#define OP_SET 0x01
#define OP_ADD 0x02
#define OP_REPLACE 0x03
#define OP_DELETE 0x04
#define OP_INCREMENT 0x05
#define OP_DECREMENT 0x06
#define OP_QUIT 0x07
#define OP_FLUSH 0x08
#define OP_GET_Q 0x09
#define OP_NO_OP 0x0A
#define OP_VERSION 0x0B
#define OP_GET_K 0x0C
#define OP_GET_K_Q 0x0D
#define OP_APPEND 0x0E
#define OP_PREPEND 0x0F
#define OP_STAT 0x10
#define OP_SET_Q 0x11
#define OP_ADD_Q 0x12
#define OP_REPLACE_Q 0x13
#define OP_DELETE_Q 0x14
#define OP_INCREMENT_Q 0x15
#define OP_DECREMENT_Q 0x16
#define OP_QUIT_Q 0x17
#define OP_FLUSH_Q 0x18
#define OP_APPEND_Q 0x19
#define OP_PREPEND_Q 0x1A
/* Internally defined command opcodes used in the textual dissector only */
/* This values are not defined in any standard and can be redefined here */
#define OP_GETS 0xF0
#define OP_CAS 0xF1
#define OP_VERBOSE 0xF2
/* Data Types */
#define DT_RAW_BYTES 0x00
static int proto_couchbase = -1;
static int hf_magic = -1;
static int hf_opcode = -1;
static int hf_extlength = -1;
static int hf_keylength = -1;
static int hf_value_length = -1;
static int hf_datatype = -1;
static int hf_vbucket = -1;
static int hf_status = -1;
static int hf_total_bodylength = -1;
static int hf_opaque = -1;
static int hf_cas = -1;
static int hf_extras = -1;
static int hf_extras_flags = -1;
static int hf_extras_expiration = -1;
static int hf_extras_delta = -1;
static int hf_extras_initial = -1;
static int hf_extras_unknown = -1;
static int hf_extras_missing = -1;
static int hf_key = -1;
static int hf_key_missing = -1;
static int hf_value = -1;
static int hf_value_missing = -1;
static int hf_uint64_response = -1;
static int hf_command = -1;
static int hf_subcommand = -1;
static int hf_flags = -1;
static int hf_expiration = -1;
static int hf_noreply = -1;
static int hf_response = -1;
static int hf_version = -1;
static int hf_slabclass = -1;
static int hf_name = -1;
static int hf_name_value = -1;
static gint ett_couchbase = -1;
static gint ett_extras = -1;
static const value_string magic_vals[] = {
{ MAGIC_REQUEST, "Request" },
{ MAGIC_RESPONSE, "Response" },
{ 0, NULL }
};
static const value_string status_vals[] = {
{ RS_NO_ERROR, "No error" },
{ RS_KEY_NOT_FOUND, "Key not found" },
{ RS_KEY_EXISTS, "Key exists" },
{ RS_VALUE_TOO_BIG, "Value too big" },
{ RS_INVALID_ARGUMENTS, "Invalid arguments" },
{ RS_ITEM_NOT_STORED, "Item not stored" },
{ RS_UNKNOWN_COMMAND, "Unknown command" },
{ RS_OUT_OF_MEMORY, "Out of memory" },
{ 0, NULL }
};
static const value_string opcode_vals[] = {
{ OP_GET, "Get" },
{ OP_SET, "Set" },
{ OP_ADD, "Add" },
{ OP_REPLACE, "Replace" },
{ OP_DELETE, "Delete" },
{ OP_INCREMENT, "Increment" },
{ OP_DECREMENT, "Decrement" },
{ OP_QUIT, "Quit" },
{ OP_FLUSH, "Flush" },
{ OP_GET_Q, "Get Quietly" },
{ OP_NO_OP, "No-op" },
{ OP_VERSION, "Version" },
{ OP_GET_K, "Get Key" },
{ OP_GET_K_Q, "Get Key Quietly" },
{ OP_APPEND, "Append" },
{ OP_PREPEND, "Prepend" },
{ OP_STAT, "Statistics" },
{ OP_SET_Q, "Set Quietly" },
{ OP_ADD_Q, "Add Quietly" },
{ OP_REPLACE_Q, "Replace Quietly" },
{ OP_DELETE_Q, "Delete Quietly" },
{ OP_INCREMENT_Q, "Increment Quietly" },
{ OP_DECREMENT_Q, "Decrement Quietly" },
{ OP_QUIT_Q, "Quit Quietly" },
{ OP_FLUSH_Q, "Flush Quietly" },
{ OP_APPEND_Q, "Append Quietly" },
{ OP_PREPEND_Q, "Prepend Quietly" },
/* Internally defined values not valid here */
{ 0, NULL }
};
static const value_string datatype_vals[] = {
{ DT_RAW_BYTES, "Raw bytes" },
{ 0, NULL }
};
/* couchbase message types. */
typedef enum _couchbase_type {
COUCHBASE_REQUEST,
COUCHBASE_RESPONSE,
COUCHBASE_UNKNOWN
} couchbase_type_t;
/* couchbase direct port */
static guint couchbase_tcp_port = COUCHBASE_PORT;
/* desegmentation of COUCHBASE header */
static gboolean couchbase_desegment_headers = TRUE;
/* desegmentation of COUCHBASE payload */
static gboolean couchbase_desegment_body = TRUE;
/* should refer to either the request or the response dissector.
*/
typedef int (*ReqRespDissector)(tvbuff_t*, packet_info *, proto_tree *,
int, const guchar*, const guchar*, guint8);
/* determines if a packet contains a memcache
* request or reply by looking at its first token.
*/
static int
is_memcache_request_or_reply(const gchar *data, int linelen, guint8 *opcode,
couchbase_type_t *type, int *expect_content_length,
ReqRespDissector *reqresp_dissector);
static guint
get_memcache_pdu_len (packet_info *pinfo _U_, tvbuff_t *tvb, int offset)
{
guint32 bodylen;
/* Get the length of the memcache body */
bodylen = tvb_get_ntohl(tvb, offset+8);
/* That length doesn't include the header; add that in */
return bodylen + COUCHBASE_HEADER_LEN;
}
static void
dissect_extras (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree,
gint offset, guint8 extlen, guint8 opcode, gboolean request)
{
proto_tree *extras_tree = NULL;
proto_item *extras_item = NULL, *ti;
gint save_offset = offset;
gboolean illegal = FALSE; /* Set when extras shall not be present */
gboolean missing = FALSE; /* Set when extras is missing */
if (extlen) {
extras_item = proto_tree_add_item (tree, hf_extras, tvb, offset, extlen, ENC_NA);
extras_tree = proto_item_add_subtree (extras_item, ett_extras);
}
switch (opcode) {
case OP_GET:
case OP_GET_Q:
case OP_GET_K:
case OP_GET_K_Q:
if (extlen) {
if (request) {
/* Request shall not have extras */
illegal = TRUE;
} else {
proto_tree_add_item (extras_tree, hf_extras_flags, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
}
} else if (!request) {
/* Response must have extras */
missing = TRUE;
}
break;
case OP_SET:
case OP_SET_Q:
case OP_ADD:
case OP_ADD_Q:
case OP_REPLACE:
case OP_REPLACE_Q:
if (extlen) {
if (request) {
proto_tree_add_item (extras_tree, hf_extras_flags, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
proto_tree_add_item (extras_tree, hf_extras_expiration, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
} else {
/* Response shall not have extras */
illegal = TRUE;
}
} else if (request) {
/* Request must have extras */
missing = TRUE;
}
break;
case OP_INCREMENT:
case OP_INCREMENT_Q:
case OP_DECREMENT:
case OP_DECREMENT_Q:
if (extlen) {
if (request) {
proto_tree_add_item (extras_tree, hf_extras_delta, tvb, offset, 8, ENC_BIG_ENDIAN);
offset += 8;
proto_tree_add_item (extras_tree, hf_extras_initial, tvb, offset, 8, ENC_BIG_ENDIAN);
offset += 8;
proto_tree_add_item (extras_tree, hf_extras_expiration, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
} else {
/* Response must not have extras (response is in Value) */
illegal = TRUE;
}
} else if (request) {
/* Request must have extras */
missing = TRUE;
}
break;
case OP_FLUSH:
case OP_FLUSH_Q:
if (extlen) {
proto_tree_add_item (extras_tree, hf_extras_expiration, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
}
break;
case OP_DELETE:
case OP_DELETE_Q:
case OP_QUIT:
case OP_QUIT_Q:
case OP_VERSION:
case OP_APPEND:
case OP_APPEND_Q:
case OP_PREPEND:
case OP_PREPEND_Q:
case OP_STAT:
/* Must not have extras */
if (extlen) {
illegal = TRUE;
}
break;
default:
if (extlen) {
/* Decode as unknown extras */
proto_tree_add_item (extras_tree, hf_extras_unknown, tvb, offset, extlen, ENC_NA);
offset += extlen;
}
break;
}
if (illegal) {
ti = proto_tree_add_item (extras_tree, hf_extras_unknown, tvb, offset, extlen, ENC_NA);
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "%s %s shall not have Extras",
val_to_str (opcode, opcode_vals, "Opcode %d"),
request ? "Request" : "Response");
offset += extlen;
} else if (missing) {
ti = proto_tree_add_item (tree, hf_extras_missing, tvb, offset, 0, ENC_NA);
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "%s %s must have Extras",
val_to_str (opcode, opcode_vals, "Opcode %d"),
request ? "Request" : "Response");
}
if ((offset - save_offset) != extlen) {
expert_add_info_format (pinfo, extras_item, PI_UNDECODED, PI_WARN,
"Illegal Extras length, should be %d", offset - save_offset);
}
}
static void
dissect_key (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree,
gint offset, int keylen, guint8 opcode, gboolean request)
{
proto_item *ti = NULL;
gboolean illegal = FALSE; /* Set when key shall not be present */
gboolean missing = FALSE; /* Set when key is missing */
if (keylen) {
ti = proto_tree_add_item (tree, hf_key, tvb, offset, keylen, ENC_ASCII|ENC_NA);
offset += keylen;
}
/* Sanity check */
if (keylen) {
if ((opcode == OP_QUIT) || (opcode == OP_QUIT_Q) || (opcode == OP_NO_OP) || (opcode == OP_VERSION)) {
/* Request and Response must not have key */
illegal = TRUE;
}
if ((opcode == OP_SET) || (opcode == OP_ADD) || (opcode == OP_REPLACE) || (opcode == OP_DELETE) ||
(opcode == OP_SET_Q) || (opcode == OP_ADD_Q) || (opcode == OP_REPLACE_Q) || (opcode == OP_DELETE_Q) ||
(opcode == OP_FLUSH) || (opcode == OP_APPEND) || (opcode == OP_PREPEND) ||
(opcode == OP_FLUSH_Q) || (opcode == OP_APPEND_Q) || (opcode == OP_PREPEND_Q))
{
/* Response must not have a key */
if (!request) {
illegal = TRUE;
}
}
} else {
if ((opcode == OP_GET) || (opcode == OP_GET_Q) || (opcode == OP_GET_K) || (opcode == OP_GET_K_Q) ||
(opcode == OP_SET) || (opcode == OP_ADD) || (opcode == OP_REPLACE) || (opcode == OP_DELETE) ||
(opcode == OP_SET_Q) || (opcode == OP_ADD_Q) || (opcode == OP_REPLACE_Q) || (opcode == OP_DELETE_Q) ||
(opcode == OP_INCREMENT) || (opcode == OP_DECREMENT) || (opcode == OP_INCREMENT_Q) || (opcode == OP_DECREMENT_Q))
{
/* Request must have key */
if (request) {
missing = TRUE;
}
}
}
if (illegal) {
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "%s %s shall not have Key",
val_to_str (opcode, opcode_vals, "Opcode %d"),
request ? "Request" : "Response");
} else if (missing) {
ti = proto_tree_add_item (tree, hf_key_missing, tvb, offset, 0, ENC_NA);
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "%s %s must have Key",
val_to_str (opcode, opcode_vals, "Opcode %d"),
request ? "Request" : "Response");
}
}
static void
dissect_value (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree,
gint offset, guint32 value_len, guint8 opcode, gboolean request)
{
proto_item *ti = NULL;
gboolean illegal = FALSE; /* Set when value shall not be present */
gboolean missing = FALSE; /* Set when value is missing */
if (value_len > 0) {
if (!request && ((opcode == OP_INCREMENT) || (opcode == OP_DECREMENT))) {
ti = proto_tree_add_item (tree, hf_uint64_response, tvb, offset, 8, ENC_BIG_ENDIAN);
if (value_len != 8) {
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "Illegal Value length, should be 8");
}
} else {
ti = proto_tree_add_item (tree, hf_value, tvb, offset, value_len, ENC_ASCII|ENC_NA);
}
offset += value_len;
}
/* Sanity check */
if (value_len) {
if ((opcode == OP_GET) || (opcode == OP_GET_Q) || (opcode == OP_GET_K) || (opcode == OP_GET_K_Q) ||
(opcode == OP_INCREMENT) || (opcode == OP_DECREMENT) || (opcode == OP_VERSION) ||
(opcode == OP_INCREMENT_Q) || (opcode == OP_DECREMENT_Q))
{
/* Request must not have value */
if (request) {
illegal = TRUE;
}
}
if ((opcode == OP_DELETE) || (opcode == OP_QUIT) || (opcode == OP_FLUSH) || (opcode == OP_NO_OP) ||
(opcode == OP_DELETE_Q) || (opcode == OP_QUIT_Q) || (opcode == OP_FLUSH_Q))
{
/* Request and Response must not have value */
illegal = TRUE;
}
if ((opcode == OP_SET) || (opcode == OP_ADD) || (opcode == OP_REPLACE) ||
(opcode == OP_SET_Q) || (opcode == OP_ADD_Q) || (opcode == OP_REPLACE_Q) ||
(opcode == OP_APPEND) || (opcode == OP_PREPEND) || (opcode == OP_APPEND_Q) || (opcode == OP_PREPEND_Q))
{
/* Response must not have value */
if (!request) {
illegal = TRUE;
}
}
} else {
if ((opcode == OP_SET) || (opcode == OP_ADD) || (opcode == OP_REPLACE) ||
(opcode == OP_SET_Q) || (opcode == OP_ADD_Q) || (opcode == OP_REPLACE_Q) ||
(opcode == OP_APPEND) || (opcode == OP_PREPEND) || (opcode == OP_APPEND_Q) || (opcode == OP_PREPEND_Q))
{
/* Request must have a value */
if (request) {
missing = TRUE;
}
}
}
if (illegal) {
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "%s %s shall not have Value",
val_to_str (opcode, opcode_vals, "Opcode %d"),
request ? "Request" : "Response");
} else if (missing) {
ti = proto_tree_add_item (tree, hf_value_missing, tvb, offset, 0, ENC_NA);
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "%s %s must have Value",
val_to_str (opcode, opcode_vals, "Opcode %d"),
request ? "Request" : "Response");
}
}
static void
dissect_couchbase (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree)
{
proto_tree *couchbase_tree;
proto_item *couchbase_item, *ti;
gint offset = 0;
guint8 magic, opcode, extlen;
guint16 keylen, status = 0;
guint32 bodylen, value_len;
gboolean request;
col_set_str (pinfo->cinfo, COL_PROTOCOL, PSNAME);
col_clear (pinfo->cinfo, COL_INFO);
couchbase_item = proto_tree_add_item (tree, proto_couchbase, tvb, offset, -1, ENC_NA);
couchbase_tree = proto_item_add_subtree (couchbase_item, ett_couchbase);
magic = tvb_get_guint8 (tvb, offset);
ti = proto_tree_add_item (couchbase_tree, hf_magic, tvb, offset, 1, ENC_BIG_ENDIAN);
offset += 1;
if (match_strval (magic, magic_vals) == NULL) {
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "Unknown magic byte: %d", magic);
}
opcode = tvb_get_guint8 (tvb, offset);
ti = proto_tree_add_item (couchbase_tree, hf_opcode, tvb, offset, 1, ENC_BIG_ENDIAN);
offset += 1;
if (match_strval (opcode, opcode_vals) == NULL) {
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "Unknown opcode: %d", opcode);
}
proto_item_append_text (couchbase_item, ", %s %s", val_to_str (opcode, opcode_vals, "Unknown opcode (%d)"),
val_to_str (magic, magic_vals, "Unknown magic (%d)"));
col_append_fstr (pinfo->cinfo, COL_INFO, "%s %s",
val_to_str (opcode, opcode_vals, "Unknown opcode (%d)"),
val_to_str (magic, magic_vals, "Unknown magic (%d)"));
keylen = tvb_get_ntohs (tvb, offset);
proto_tree_add_item (couchbase_tree, hf_keylength, tvb, offset, 2, ENC_BIG_ENDIAN);
offset += 2;
extlen = tvb_get_guint8 (tvb, offset);
proto_tree_add_item (couchbase_tree, hf_extlength, tvb, offset, 1, ENC_BIG_ENDIAN);
offset += 1;
proto_tree_add_item (couchbase_tree, hf_datatype, tvb, offset, 1, ENC_BIG_ENDIAN);
offset += 1;
status = tvb_get_ntohs (tvb, offset);
if (magic & 0x01) { /* We suppose this is a response, even when unknown magic byte */
request = FALSE;
ti = proto_tree_add_item (couchbase_tree, hf_status, tvb, offset, 2, ENC_BIG_ENDIAN);
if (status != 0) {
expert_add_info_format (pinfo, ti, PI_RESPONSE_CODE, PI_NOTE, "%s: %s",
val_to_str (opcode, opcode_vals, "Unknown opcode (%d)"),
val_to_str (status, status_vals, "Status: %d"));
}
} else {
request = TRUE;
proto_tree_add_item (couchbase_tree, hf_vbucket, tvb, offset, 2, ENC_BIG_ENDIAN);
}
offset += 2;
bodylen = tvb_get_ntohl (tvb, offset);
value_len = bodylen - extlen - keylen;
ti = proto_tree_add_uint (couchbase_tree, hf_value_length, tvb, offset, 0, value_len);
PROTO_ITEM_SET_GENERATED (ti);
proto_tree_add_item (couchbase_tree, hf_total_bodylength, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
proto_tree_add_item (couchbase_tree, hf_opaque, tvb, offset, 4, ENC_BIG_ENDIAN);
offset += 4;
proto_tree_add_item (couchbase_tree, hf_cas, tvb, offset, 8, ENC_BIG_ENDIAN);
offset += 8;
if (status == 0) {
dissect_extras (tvb, pinfo, couchbase_tree, offset, extlen, opcode, request);
offset += extlen;
dissect_key (tvb, pinfo, couchbase_tree, offset, keylen, opcode, request);
offset += keylen;
dissect_value (tvb, pinfo, couchbase_tree, offset, value_len, opcode, request);
offset += value_len;
} else if (bodylen) {
proto_tree_add_item (couchbase_tree, hf_value, tvb, offset, bodylen, ENC_ASCII|ENC_NA);
offset += bodylen;
col_append_fstr (pinfo->cinfo, COL_INFO, " (%s)",
val_to_str (status, status_vals, "Unknown status: %d"));
} else {
ti = proto_tree_add_item (couchbase_tree, hf_value_missing, tvb, offset, 0, ENC_NA);
expert_add_info_format (pinfo, ti, PI_UNDECODED, PI_WARN, "%s with status %s (%d) must have Value",
val_to_str (opcode, opcode_vals, "Opcode %d"),
val_to_str (status, status_vals, "Unknown"), status);
}
}
/* Obtain the content length by peeping into the header.
*/
static gboolean
get_payload_length (tvbuff_t *tvb, const int token_number, int offset,
guint32 *bytes, gboolean *content_length_found)
{
const guchar *next_token;
const guchar *line, *lineend;
guchar *bytes_val;
int tokenlen, i = 0, linelen;
gint next_offset;
/* get the header line. */
linelen = tvb_find_line_end (tvb, offset,
tvb_ensure_length_remaining (tvb, offset), &next_offset,
FALSE);
if (linelen < 0) {
return FALSE;
}
line = tvb_get_ptr (tvb, offset, linelen);
lineend = line + linelen;
while (++i < token_number) {
tokenlen = get_token_len (line, lineend, &next_token);
if (tokenlen == 0) {
return FALSE;
}
offset += (int) (next_token - line);
line = next_token;
}
/* line or the next_token has the value we want. */
tokenlen = get_token_len (line, lineend, &next_token);
if (tokenlen == 0) {
return FALSE;
}
bytes_val = tvb_get_ephemeral_string (tvb, offset, tokenlen);
if (bytes_val) {
if (sscanf (bytes_val, "%u", bytes) == 1) {
*content_length_found = TRUE;
} else {
return FALSE;
}
} else {
return FALSE;
}
/* reached this far, we got what we want. */
return TRUE;
}
/* check if a PDU needs to be desegmented. */
static gboolean
desegment_pdus (tvbuff_t *tvb, packet_info *pinfo, const int offset,
const int data_offset, guint32 content_length)
{
gint length_remaining, reported_length_remaining;
/* data_offset has been set to start of the data block. */
if (!tvb_bytes_exist (tvb, data_offset, content_length)) {
length_remaining = tvb_length_remaining (tvb, data_offset);
reported_length_remaining = tvb_reported_length_remaining (tvb, data_offset);
if (length_remaining < reported_length_remaining) {
/* It's a waste of time asking for more
* data, because that data wasn't captured.
*/
return FALSE;
}
if (length_remaining == -1) {
length_remaining = 0;
}
pinfo->desegment_offset = offset; /* start of the packet. */
pinfo->desegment_len = (content_length + 2) - length_remaining; /* add 2 for /r/n */
return TRUE;
}
return FALSE;
}
/*
* Optionally do reassembly of the requests, responses and data.
*/
static gboolean
memcache_req_resp_hdrs_do_reassembly (
tvbuff_t *tvb, const int offset, packet_info *pinfo,
const gboolean desegment_headers, const gboolean desegment_body,
const couchbase_type_t type, const int expect_content_length)
{
int linelen;
gint next_offset;
gint length_remaining;
gint reported_length_remaining;
guint32 content_length = 0;
gboolean content_length_found = FALSE;
gboolean ret = FALSE;
/*
* If header desegmentation is activated, check the
* header in this tvbuff.
* request one more byte (we don't know how many bytes
* we'll need, so we just ask for one).
*/
if (desegment_headers && pinfo->can_desegment) {
next_offset = offset;
reported_length_remaining = tvb_reported_length_remaining (tvb, next_offset);
/*
* Request one more byte if there're no
* bytes left in the reported data (if there're
* bytes left in the reported data, but not in
* the available data, requesting more bytes
* won't help, as those bytes weren't captured).
*/
if (reported_length_remaining < 1) {
pinfo->desegment_offset = offset;
pinfo->desegment_len = DESEGMENT_ONE_MORE_SEGMENT;
return FALSE;
}
length_remaining = tvb_length_remaining (tvb, next_offset);
/* Request one more byte if we cannot find a
* header (i.e. a line end).
*/
linelen = tvb_find_line_end (tvb, next_offset, -1, &next_offset, TRUE);
if (linelen == -1 && length_remaining >= reported_length_remaining) {
/* Not enough data; ask for one more byte. */
pinfo->desegment_offset = offset;
pinfo->desegment_len = DESEGMENT_ONE_MORE_SEGMENT;
return FALSE;
}
/* Browse through the header to find the content length.
*
* request:
* <command name> <key> <flags> <exptime> <bytes> [noreply]\r\n
* cas <key> <flags> <exptime> <bytes> <cas unqiue> [noreply]\r\n
*
* response:
* VALUE <key> <flags> <bytes> [<cas unique>]\r\n
* <data block>\r\n
*/
if (expect_content_length == TRUE) {
switch (type) {
case COUCHBASE_REQUEST:
/* Get the fifth token in the header.*/
ret = get_payload_length (tvb, 5 , offset, &content_length, &content_length_found);
if (!ret) {
return FALSE;
}
break;
case COUCHBASE_RESPONSE:
/* Get the fourth token in the header.*/
ret = get_payload_length (tvb, 4 , offset, &content_length, &content_length_found);
if (!ret) {
return FALSE;
}
break;
default:
/* Unrecognized message type. */
return FALSE;
}
}
}
/* We have reached the end of a header, so there
* should be 'content_length' bytes after this
* followed by CRLF. The next_offset points to the
* start of the data bytes.
*/
if (desegment_body && content_length_found) {
return !desegment_pdus (tvb, pinfo, offset, next_offset, content_length);
}
/* No further desegmentation needed. */
return TRUE;
}
/* Dissect a memcache message. */
static int
dissect_memcache_message (tvbuff_t *tvb, int offset, packet_info *pinfo, proto_tree *tree)
{
const guchar *line;
const guchar *lineend;
int orig_offset;
int first_linelen;
int datalen;
int expect_content_length = FALSE;
gint next_offset;
gboolean is_request_or_reply;
couchbase_type_t memcache_type;
ReqRespDissector reqresp_dissector = NULL;
proto_tree *couchbase_tree = NULL;
proto_item *couchbase_item = NULL;
guint8 opcode = 0xff; /* set to something that is not in the list. */
/* Find a line end in the packet.
* Note that "tvb_find_line_end ()" will return a value that
* is not longer than what's in the buffer, so the
* "tvb_get_ptr ()" call won't throw an exception.
*/
first_linelen = tvb_find_line_end (tvb, offset,
tvb_ensure_length_remaining (tvb, offset), &next_offset,
FALSE);
if (first_linelen < 0) {
return -1;
}
line = tvb_get_ptr (tvb, offset, first_linelen);
lineend = line + first_linelen;
memcache_type = COUCHBASE_UNKNOWN; /* packet type not known yet */
/* Look at the first token of the first line to
* determine if it is a request or a response?
*/
is_request_or_reply =
is_memcache_request_or_reply ((const gchar *)line,
first_linelen, &opcode, &memcache_type,
&expect_content_length, &reqresp_dissector);
if (is_request_or_reply) {
/* Yes, it is a request or a response.
* Do header and body desegmentation if we've been told to.
*/
if (!memcache_req_resp_hdrs_do_reassembly (tvb, offset, pinfo, couchbase_desegment_headers,
couchbase_desegment_body, memcache_type,
expect_content_length))
{
/* More data needed for desegmentation. */
return -1;
}
}
/* Columns and summary display. */
col_set_str (pinfo->cinfo, COL_PROTOCOL, PSNAME);
/* If the packet is a memcache request or reply,
* put the first line from the buffer into the summary
* Otherwise, just call it a continuation.
*/
if (is_request_or_reply) {
line = tvb_get_ptr (tvb, offset, first_linelen);
col_add_fstr (pinfo->cinfo, COL_INFO, "%s ",
format_text (line, first_linelen));
} else {
col_set_str (pinfo->cinfo, COL_INFO, "COUCHBASE Continuation");
}
orig_offset = offset;
couchbase_item = proto_tree_add_item (tree, proto_couchbase, tvb, offset, -1, ENC_NA);
couchbase_tree = proto_item_add_subtree (couchbase_item, ett_couchbase);
/* Process the packet data. The first line is expected to be a
* header. If its not a header then we don't dissect.
* At this point, we already know if it is a request or a
* response.
*/
if (tvb_reported_length_remaining (tvb, offset) != 0) {
/* Dissect a request or a response. */
if (is_request_or_reply && reqresp_dissector) {
if (tree) {
next_offset = reqresp_dissector (tvb, pinfo, couchbase_tree,
offset, line, lineend, opcode);
if (next_offset == -1) {
/* Error in dissecting. */
return -1;
}
offset = next_offset;
}
}
}
/*
* If a 'bytes' value was supplied, the amount of data to be
* processed as COUCHBASE payload is the minimum of the 'bytes'
* value and the amount of data remaining in the frame.
*
*/
datalen = tvb_length_remaining (tvb, offset);
if (datalen > 0) {
/*
* We've processed "datalen" bytes worth of data
* (which may be no data at all); advance the
* offset past whatever data we've processed.
*/
offset += datalen;
}
return offset - orig_offset;
}
/* Payload dissector
* <data block>\r\n
*/
static int
content_data_dissector (tvbuff_t *tvb, packet_info *pinfo, proto_tree *tree, int offset,
int content_length, guint8 opcode)
{
gint datalen;
gboolean short_pkt = FALSE;
/*
* Expecting to read 'content_length' number of bytes from
* the buffer. It is not necessary that we have all the
* content_length bytes available to read.
*/
if (tvb_reported_length_remaining (tvb, offset) != 0) {
/* bytes actually remaining in this tvbuff. */
datalen = tvb_length_remaining (tvb, offset);
if (content_length >= 0) {
if (datalen >= (content_length + 2)) { /* also consider \r\n*/
datalen = content_length;
} else {
short_pkt = TRUE;
}
}
/* dissect the data block. */
dissect_value (tvb, pinfo, tree, offset, datalen, opcode, TRUE);
if (datalen > 0) {
/*
* We've processed "datalen" bytes worth of data
* (which may be no data at all); advance the
* offset past whatever data we've processed.
*/
if (!short_pkt) {
offset += (datalen + 2); /* go past /r/n*/
} else {
offset += datalen; /* short packet; no /r/n*/
}
}
}
return offset;
}
/* Find the occurrences of a ':' in a stat response. */
static guint
find_stat_colon (const guchar *line, const guchar *lineend,
const guchar **first_colon, const guchar **last_colon)
{
const guchar *linep, *temp;
guint occurrences = 0;
guchar c;
linep = line;
while (linep < lineend) {
temp = linep;
c = *linep++;
switch (c) {
case ':':
occurrences++;
if (occurrences == 1) {
*first_colon = temp;
} else if (occurrences == 2) {
*last_colon = temp;
} else {
/* anything other than 1 or 2;
* return immediately
*/
return occurrences;
}
break;
default:
break;
}
}
return occurrences;