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
|
import random
import string
import struct
import socket
import json
import yaml
import binascii
import base64
import inspect
from trex_stl_packet_builder_interface import CTrexPktBuilderInterface
from scapy.all import *
class CTRexPacketBuildException(Exception):
"""
This is the general Packet Building error exception class.
"""
def __init__(self, code, message):
self.code = code
self.message = message
def __str__(self):
return self.__repr__()
def __repr__(self):
return u"[errcode:%r] %r" % (self.code, self.message)
################################################################################################
def ipv4_str_to_num (ipv4_buffer):
assert type(ipv4_buffer)==str, 'type of ipv4_buffer is not str'
assert len(ipv4_buffer)==4, 'size of ipv4_buffer is not 4'
res=0
shift=24
for i in ipv4_buffer:
res = res + (ord(i)<<shift);
shift =shift -8
return res
def is_valid_ipv4(ip_addr):
"""
return buffer in network order
"""
if type(ip_addr)==str and len(ip_addr) == 4:
return ip_addr
if type(ip_addr)==int :
ip_addr = socket.inet_ntoa(struct.pack("!I", ip_addr))
try:
return socket.inet_pton(socket.AF_INET, ip_addr)
except AttributeError: # no inet_pton here, sorry
return socket.inet_aton(ip_addr)
except socket.error: # not a valid address
raise CTRexPacketBuildException(-10,"not valid ipv4 format");
def is_valid_ipv6(ipv6_addr):
"""
return buffer in network order
"""
if type(ipv6_addr)==str and len(ipv6_addr) == 16:
return ipv6_addr
try:
return socket.inet_pton(socket.AF_INET6, ipv6_addr)
except AttributeError: # no inet_pton here, sorry
raise CTRexPacketBuildException(-10, 'No inet_pton function available')
except:
raise CTRexPacketBuildException(-10, 'Not valid ipv6 format')
class CTRexScriptsBase(object):
"""
VM Script base class
"""
def clone (self):
return copy.deepcopy(self)
class CTRexScFieldRangeBase(CTRexScriptsBase):
FILED_TYPES = ['inc', 'dec', 'rand']
def __init__(self, field_name,
field_type
):
super(CTRexScFieldRangeBase, self).__init__()
self.field_name =field_name
self.field_type =field_type
if not self.field_type in CTRexScFieldRangeBase.FILED_TYPES :
raise CTRexPacketBuildException(-12, 'field type should be in %s' % FILED_TYPES);
class CTRexScFieldRangeValue(CTRexScFieldRangeBase):
"""
range of field value
"""
def __init__(self, field_name,
field_type,
min_value,
max_value
):
super(CTRexScFieldRangeValue, self).__init__(field_name,field_type)
self.min_value =min_value;
self.max_value =max_value;
if min_value > max_value:
raise CTRexPacketBuildException(-12, 'min is greater than max');
if min_value == max_value:
raise CTRexPacketBuildException(-13, "min value is equal to max value, you can't use this type of range");
class CTRexScIpv4SimpleRange(CTRexScFieldRangeBase):
"""
range of ipv4 ip
"""
def __init__(self, field_name, field_type, min_ip, max_ip):
super(CTRexScIpv4SimpleRange, self).__init__(field_name,field_type)
self.min_ip = min_ip
self.max_ip = max_ip
mmin=ipv4_str_to_num (is_valid_ipv4(min_ip))
mmax=ipv4_str_to_num (is_valid_ipv4(max_ip))
if mmin > mmax :
raise CTRexPacketBuildException(-11, 'CTRexScIpv4SimpleRange m_min ip is bigger than max');
class CTRexScIpv4TupleGen(CTRexScriptsBase):
"""
range tuple
"""
FLAGS_ULIMIT_FLOWS =1
def __init__(self, min_ipv4, max_ipv4, num_flows=100000, min_port=1025, max_port=65535, flags=0):
super(CTRexScIpv4TupleGen, self).__init__()
self.min_ip = min_ipv4
self.max_ip = max_ipv4
mmin=ipv4_str_to_num (is_valid_ipv4(min_ipv4))
mmax=ipv4_str_to_num (is_valid_ipv4(max_ipv4))
if mmin > mmax :
raise CTRexPacketBuildException(-11, 'CTRexScIpv4SimpleRange m_min ip is bigger than max');
self.num_flows=num_flows;
self.min_port =min_port
self.max_port =max_port
self.flags = flags
class CTRexScTrimPacketSize(CTRexScriptsBase):
"""
trim packet size. field type is CTRexScFieldRangeBase.FILED_TYPES = ["inc","dec","rand"]
"""
def __init__(self,field_type="rand",min_pkt_size=None, max_pkt_size=None):
super(CTRexScTrimPacketSize, self).__init__()
self.field_type = field_type
self.min_pkt_size = min_pkt_size
self.max_pkt_size = max_pkt_size
if max_pkt_size != None and min_pkt_size !=None :
if min_pkt_size == max_pkt_size:
raise CTRexPacketBuildException(-11, 'CTRexScTrimPacketSize min_pkt_size is the same as max_pkt_size ');
if min_pkt_size > max_pkt_size:
raise CTRexPacketBuildException(-11, 'CTRexScTrimPacketSize min_pkt_size is bigger than max_pkt_size ');
class CTRexScRaw(CTRexScriptsBase):
"""
raw instructions
"""
def __init__(self,list_of_commands=None,split_by_field=None):
super(CTRexScRaw, self).__init__()
self.split_by_field = split_by_field
if list_of_commands==None:
self.commands =[]
else:
self.commands = list_of_commands
def add_cmd (self,cmd):
self.commands.append(cmd)
################################################################################################
# VM raw instructions
################################################################################################
class CTRexVmInsBase(object):
"""
instruction base
"""
def __init__(self, ins_type):
self.type = ins_type
assert type(ins_type)==str, 'type of ins_type is not str'
class CTRexVmInsFixIpv4(CTRexVmInsBase):
def __init__(self, offset):
super(CTRexVmInsFixIpv4, self).__init__("fix_checksum_ipv4")
self.pkt_offset = offset
assert type(offset)==int, 'type of offset is not int'
class CTRexVmInsFlowVar(CTRexVmInsBase):
#TBD add more validation tests
OPERATIONS =['inc', 'dec', 'random']
VALID_SIZES =[1, 2, 4, 8]
def __init__(self, fv_name, size, op, init_value, min_value, max_value,step):
super(CTRexVmInsFlowVar, self).__init__("flow_var")
self.name = fv_name;
assert type(fv_name)==str, 'type of fv_name is not str'
self.size = size
self.op = op
self.init_value = init_value
assert type(init_value)==int, 'type of init_value is not int'
self.min_value=min_value
assert type(min_value)==int, 'type of min_value is not int'
self.max_value=max_value
assert type(max_value)==int, 'type of min_value is not int'
self.step=step
assert type(step)==int, 'type of step should be int'
class CTRexVmInsWrFlowVar(CTRexVmInsBase):
def __init__(self, fv_name, pkt_offset, add_value=0, is_big_endian=True):
super(CTRexVmInsWrFlowVar, self).__init__("write_flow_var")
self.name = fv_name
assert type(fv_name)==str, 'type of fv_name is not str'
self.pkt_offset = pkt_offset
assert type(pkt_offset)==int, 'type of pkt_offset is not int'
self.add_value = add_value
assert type(add_value)==int, 'type of add_value is not int'
self.is_big_endian = is_big_endian
assert type(is_big_endian)==bool, 'type of is_big_endian is not bool'
class CTRexVmInsWrMaskFlowVar(CTRexVmInsBase):
def __init__(self, fv_name, pkt_offset,pkt_cast_size,mask,shift, is_big_endian=True):
super(CTRexVmInsWrMaskFlowVar, self).__init__("write_mask_flow_var")
self.name = fv_name
assert type(fv_name)==str, 'type of fv_name is not str'
self.pkt_offset = pkt_offset
assert type(pkt_offset)==int, 'type of pkt_offset is not int'
self.pkt_cast_size = pkt_cast_size
assert type(pkt_cast_size)==int, 'type of pkt_cast_size is not int'
self.mask = mask
assert type(mask)==int, 'type of mask is not int'
self.shift = shift
assert type(shift)==int, 'type of shift is not int'
self.is_big_endian = is_big_endian
assert type(is_big_endian)==bool, 'type of is_big_endian is not bool'
class CTRexVmInsTrimPktSize(CTRexVmInsBase):
def __init__(self,fv_name):
super(CTRexVmInsTrimPktSize, self).__init__("trim_pkt_size")
self.name = fv_name
assert type(fv_name)==str, 'type of fv_name is not str'
class CTRexVmInsTupleGen(CTRexVmInsBase):
def __init__(self, fv_name, ip_min, ip_max, port_min, port_max, limit_flows, flags=0):
super(CTRexVmInsTupleGen, self).__init__("tuple_flow_var")
self.name =fv_name
assert type(fv_name)==str, 'type of fv_name is not str'
self.ip_min = ip_min;
self.ip_max = ip_max;
self.port_min = port_min;
self.port_max = port_max;
self.limit_flows = limit_flows;
self.flags =flags;
################################################################################################
#
class CTRexVmEngine(object):
def __init__(self):
"""
inlcude list of instruction
"""
super(CTRexVmEngine, self).__init__()
self.ins=[]
self.split_by_var = ''
# return as json
def get_json (self):
inst_array = [];
# dump it as dict
for obj in self.ins:
inst_array.append(obj.__dict__);
return {'instructions': inst_array, 'split_by_var': self.split_by_var}
def add_ins (self,ins):
#assert issubclass(ins, CTRexVmInsBase)
self.ins.append(ins);
def dump (self):
cnt=0;
for obj in self.ins:
print "ins",cnt
cnt = cnt +1
print obj.__dict__
def dump_bjson (self):
print json.dumps(self.get_json(), sort_keys=True, indent=4)
def dump_as_yaml (self):
print yaml.dump(self.get_json(), default_flow_style=False)
################################################################################################
class CTRexScapyPktUtl(object):
def __init__(self, scapy_pkt):
self.pkt = scapy_pkt
def pkt_iter (self):
p=self.pkt;
while True:
yield p
p=p.payload
if p ==None or isinstance(p,NoPayload):
break;
def get_list_iter(self):
l=list(self.pkt_iter())
return l
def get_pkt_layers(self):
"""
return string 'IP:UDP:TCP'
"""
l=self.get_list_iter ();
l1=map(lambda p: p.name,l );
return ":".join(l1);
def _layer_offset(self, name, cnt = 0):
"""
return offset of layer e.g 'IP',1 will return offfset of layer ip:1
"""
save_cnt=cnt
for pkt in self.pkt_iter ():
if pkt.name == name:
if cnt==0:
return (pkt, pkt.offset)
else:
cnt=cnt -1
raise CTRexPacketBuildException(-11,("no layer %s-%d" % (name, save_cnt)));
def layer_offset(self, name, cnt = 0):
"""
return offset of layer e.g 'IP',1 will return offfset of layer ip:1
"""
save_cnt=cnt
for pkt in self.pkt_iter ():
if pkt.name == name:
if cnt==0:
return pkt.offset
else:
cnt=cnt -1
raise CTRexPacketBuildException(-11,("no layer %s-%d" % (name, save_cnt)));
def get_field_offet(self, layer, layer_cnt, field_name):
"""
return offset of layer e.g 'IP',1 will return offfset of layer ip:1
"""
t=self._layer_offset(layer,layer_cnt);
l_offset=t[1];
layer_pkt=t[0]
#layer_pkt.dump_fields_offsets ()
for f in layer_pkt.fields_desc:
if f.name == field_name:
return (l_offset+f.offset,f.get_size_bytes ());
raise CTRexPacketBuildException(-11, "no layer %s-%d." % (name, save_cnt, field_name));
def get_layer_offet_by_str(self, layer_des):
"""
return layer offset by string
:parameters:
IP:0
IP:1
return offset
"""
l1=layer_des.split(":")
layer=""
layer_cnt=0;
if len(l1)==1:
layer=l1[0];
else:
layer=l1[0];
layer_cnt=int(l1[1]);
return self.layer_offset(layer, layer_cnt)
def get_field_offet_by_str(self, field_des):
"""
return field_des (offset,size) layer:cnt.field
for example
802|1Q.vlan get 802.1Q->valn replace | with .
IP.src
IP:0.src (first IP.src like IP.src)
for example IP:1.src for internal IP
return (offset, size) as tuple
"""
s=field_des.split(".");
if len(s)!=2:
raise CTRexPacketBuildException(-11, ("field desription should be layer:cnt.field e.g IP.src or IP:1.src"));
layer_ex = s[0].replace("|",".")
field = s[1]
l1=layer_ex.split(":")
layer=""
layer_cnt=0;
if len(l1)==1:
layer=l1[0];
else:
layer=l1[0];
layer_cnt=int(l1[1]);
return self.get_field_offet(layer,layer_cnt,field)
def has_IPv4 (self):
return self.pkt.has_layer("IP");
def has_IPv6 (self):
return self.pkt.has_layer("IPv6");
def has_UDP (self):
return self.pkt.has_layer("UDP");
################################################################################################
class CTRexVmDescBase(object):
"""
instruction base
"""
def __init__(self):
pass;
def get_obj(self):
return self;
def get_json(self):
return self.get_obj().__dict__
def dump_bjson(self):
print json.dumps(self.get_json(), sort_keys=True, indent=4)
def dump_as_yaml(self):
print yaml.dump(self.get_json(), default_flow_style=False)
def get_var_ref (self):
'''
virtual function return a ref var name
'''
return None
def get_var_name(self):
'''
virtual function return the varible name if exists
'''
return None
def compile(self,parent):
'''
virtual function to take parent than has function name_to_offset
'''
pass;
def valid_fv_size (size):
if not (size in CTRexVmInsFlowVar.VALID_SIZES):
raise CTRexPacketBuildException(-11,("flow var has not valid size %d ") % size );
def valid_fv_ops (op):
if not (op in CTRexVmInsFlowVar.OPERATIONS):
raise CTRexPacketBuildException(-11,("flow var does not have a valid op %s ") % op );
def convert_val (val):
if type(val) == int:
return val
else:
if type(val) == str:
return ipv4_str_to_num (is_valid_ipv4(val))
else:
raise CTRexPacketBuildException(-11,("init val not valid %s ") % val );
def check_for_int (val):
assert type(val)==int, 'type of vcal is not int'
class CTRexVmDescFlowVar(CTRexVmDescBase):
def __init__(self, name, init_value=None, min_value=0, max_value=255, size=4, step=1,op="inc"):
super(CTRexVmDescFlowVar, self).__init__()
self.name = name;
assert type(name)==str, 'type of name is not str'
self.size =size
valid_fv_size(size)
self.op =op
valid_fv_ops (op)
# choose default value for init val
if init_value == None:
init_value = max_value if op == "dec" else min_value
self.init_value = convert_val (init_value)
self.min_value = convert_val (min_value);
self.max_value = convert_val (max_value)
self.step = convert_val (step)
if self.min_value > self.max_value :
raise CTRexPacketBuildException(-11,("max %d is lower than min %d ") % (self.max_value,self.min_value) );
def get_obj (self):
return CTRexVmInsFlowVar(self.name,self.size,self.op,self.init_value,self.min_value,self.max_value,self.step);
def get_var_name(self):
return [self.name]
class CTRexVmDescFixIpv4(CTRexVmDescBase):
def __init__(self, offset):
super(CTRexVmDescFixIpv4, self).__init__()
self.offset = offset; # could be a name of offset
def get_obj (self):
return CTRexVmInsFixIpv4(self.offset);
def compile(self,parent):
if type(self.offset)==str:
self.offset = parent._pkt_layer_offset(self.offset);
class CTRexVmDescWrFlowVar(CTRexVmDescBase):
def __init__(self, fv_name, pkt_offset, offset_fixup=0, add_val=0, is_big=True):
super(CTRexVmDescWrFlowVar, self).__init__()
self.name =fv_name
assert type(fv_name)==str, 'type of fv_name is not str'
self.offset_fixup =offset_fixup
assert type(offset_fixup)==int, 'type of offset_fixup is not int'
self.pkt_offset =pkt_offset
self.add_val =add_val
assert type(add_val)==int,'type of add_val is not int'
self.is_big =is_big;
assert type(is_big)==bool,'type of is_big_endian is not bool'
def get_var_ref (self):
return self.name
def get_obj (self):
return CTRexVmInsWrFlowVar(self.name,self.pkt_offset+self.offset_fixup,self.add_val,self.is_big)
def compile(self,parent):
if type(self.pkt_offset)==str:
t=parent._name_to_offset(self.pkt_offset)
self.pkt_offset = t[0]
class CTRexVmDescWrMaskFlowVar(CTRexVmDescBase):
def __init__(self, fv_name, pkt_offset, pkt_cast_size=1, mask=0xff, shift=0, offset_fixup=0, is_big=True):
super(CTRexVmDescWrMaskFlowVar, self).__init__()
self.name =fv_name
assert type(fv_name)==str, 'type of fv_name is not str'
self.offset_fixup =offset_fixup
assert type(offset_fixup)==int, 'type of offset_fixup is not int'
self.pkt_offset =pkt_offset
self.pkt_cast_size =pkt_cast_size
assert type(pkt_cast_size)==int,'type of pkt_cast_size is not int'
if not (pkt_cast_size in [1,2,4]):
raise CTRexPacketBuildException(-10,"not valid cast size");
self.mask = mask
assert type(mask)==int,'type of mask is not int'
self.shift = shift
assert type(shift)==int,'type of shift is not int'
self.is_big =is_big;
assert type(is_big)==bool,'type of is_big_endian is not bool'
def get_var_ref (self):
return self.name
def get_obj (self):
return CTRexVmInsWrMaskFlowVar(self.name,self.pkt_offset+self.offset_fixup,self.pkt_cast_size,self.mask,self.shift,self.is_big)
def compile(self,parent):
if type(self.pkt_offset)==str:
t=parent._name_to_offset(self.pkt_offset)
self.pkt_offset = t[0]
class CTRexVmDescTrimPktSize(CTRexVmDescBase):
def __init__(self,fv_name):
super(CTRexVmDescTrimPktSize, self).__init__()
self.name = fv_name
assert type(fv_name)==str, 'type of fv_name is not str'
def get_var_ref (self):
return self.name
def get_obj (self):
return CTRexVmInsTrimPktSize(self.name)
class CTRexVmDescTupleGen(CTRexVmDescBase):
def __init__(self,name, ip_min="0.0.0.1", ip_max="0.0.0.10", port_min=1025, port_max=65535, limit_flows=100000, flags=0):
super(CTRexVmDescTupleGen, self).__init__()
self.name = name
assert type(name)==str, 'type of fv_name is not str'
self.ip_min = convert_val(ip_min);
self.ip_max = convert_val(ip_max);
self.port_min = port_min;
check_for_int (port_min)
self.port_max = port_max;
check_for_int(port_max)
self.limit_flows = limit_flows;
check_for_int(limit_flows)
self.flags =flags;
check_for_int(flags)
def get_var_name(self):
return [self.name+".ip",self.name+".port"]
def get_obj (self):
return CTRexVmInsTupleGen(self.name, self.ip_min, self.ip_max, self.port_min, self.port_max, self.limit_flows, self.flags);
################################################################################################
class CScapyTRexPktBuilder(CTrexPktBuilderInterface):
"""
This class defines the TRex API of building a packet using dpkt package.
Using this class the user can also define how TRex will handle the packet by specifying the VM setting.
pkt could be Scapy pkt or pcap file name
When path_relative_to_profile is True load pcap file from path relative to the profile
"""
def __init__(self, pkt = None, pkt_buffer = None, vm = None, path_relative_to_profile = False):
"""
Instantiate a CTRexPktBuilder object
:parameters:
None
"""
super(CScapyTRexPktBuilder, self).__init__()
self.pkt = None # as input
self.pkt_raw = None # from raw pcap file
self.vm_scripts = [] # list of high level instructions
self.vm_low_level = None
self.metadata=""
self.path_relative_to_profile = path_relative_to_profile
if pkt != None and pkt_buffer != None:
raise CTRexPacketBuildException(-15, "packet builder cannot be provided with both pkt and pkt_buffer")
# process packet
if pkt != None:
self.set_packet(pkt)
elif pkt_buffer != None:
self.set_pkt_as_str(pkt_buffer)
# process VM
if vm != None:
if not isinstance(vm, (CTRexScRaw, list)):
raise CTRexPacketBuildException(-14, "bad value for variable vm")
self.add_command(vm if isinstance(vm, CTRexScRaw) else CTRexScRaw(vm))
# if we have packet and VM - compile now
if (self.pkt or self.pkt_raw) and (self.vm_scripts):
self.compile()
def dump_vm_data_as_yaml(self):
print yaml.dump(self.get_vm_data(), default_flow_style=False)
def get_vm_data(self):
"""
Dumps the instructions
:parameters:
None
:return:
+ json object of instructions
:raises:
+ :exc:`AssertionError`, in case VM is not compiled (is None).
"""
assert self.vm_low_level is not None, 'vm_low_level is None, please use compile()'
return self.vm_low_level.get_json()
def dump_pkt(self, encode = True):
"""
Dumps the packet as a decimal array of bytes (each item x gets value between 0-255)
:parameters:
encode : bool
Encode using base64. (disable for debug)
Default: **True**
:return:
+ packet representation as array of bytes
:raises:
+ :exc:`AssertionError`, in case packet is empty.
"""
pkt_buf = self._get_pkt_as_str()
return {'binary': base64.b64encode(pkt_buf) if encode else pkt_buf,
'meta': self.metadata}
def dump_pkt_to_pcap(self, file_path):
wrpcap(file_path, self._get_pkt_as_str())
def add_command (self, script):
self.vm_scripts.append(script.clone());
def dump_scripts (self):
self.vm_low_level.dump_as_yaml()
def dump_as_hex (self):
pkt_buf = self._get_pkt_as_str()
print hexdump(pkt_buf)
def pkt_layers_desc (self):
"""
return layer description like this IP:TCP:Pyload
"""
pkt_buf = self._get_pkt_as_str()
return self.pkt_layers_desc_from_buffer(pkt_buf)
@staticmethod
def pkt_layers_desc_from_buffer (pkt_buf):
scapy_pkt = Ether(pkt_buf);
pkt_utl = CTRexScapyPktUtl(scapy_pkt);
return pkt_utl.get_pkt_layers()
def set_pkt_as_str (self, pkt_buffer):
assert type(pkt_buffer)==str, "pkt_buffer should be string"
self.pkt_raw = pkt_buffer
def set_pcap_file (self, pcap_file):
"""
load raw pcap file into a buffer. load only the first packet
:parameters:
pcap_file : file_name
:raises:
+ :exc:`AssertionError`, in case packet is empty.
"""
f_path = self._get_pcap_file_path (pcap_file)
p=RawPcapReader(f_path)
was_set = False
for pkt in p:
was_set=True;
self.pkt_raw = str(pkt[0])
break
if not was_set :
raise CTRexPacketBuildException(-14, "no buffer inside the pcap file {0}".format(f_path))
def set_packet (self, pkt):
"""
Scapy packet Ether()/IP(src="16.0.0.1",dst="48.0.0.1")/UDP(dport=12,sport=1025)/IP()/"A"*10
"""
if isinstance(pkt, Packet):
self.pkt = pkt;
else:
if isinstance(pkt, str):
self.set_pcap_file(pkt)
else:
raise CTRexPacketBuildException(-14, "bad packet" )
def is_def_src_mac (self):
p = self.pkt
if isinstance(p, Packet):
if isinstance(p,Ether):
if 'src' in p.fields :
return False
return True
def is_def_dst_mac (self):
p = self.pkt
if isinstance(p, Packet):
if isinstance(p,Ether):
if 'dst' in p.fields :
return False
return True
def compile (self):
if self.pkt == None and self.pkt_raw == None:
raise CTRexPacketBuildException(-14, "Packet is empty")
self.vm_low_level = CTRexVmEngine()
# before VM compile set this to false
self.is_pkt_built = False
# compile the VM
for sc in self.vm_scripts:
if isinstance(sc, CTRexScRaw):
self._compile_raw(sc)
####################################################
# private
def _get_pcap_file_path (self,pcap_file_name):
f_path = pcap_file_name
if os.path.isabs(pcap_file_name):
f_path = pcap_file_name
else:
if self.path_relative_to_profile:
p = self._get_path_relative_to_profile () # loader
if p :
f_path=os.path.abspath(os.path.join(os.path.dirname(p),pcap_file_name))
return f_path
def _get_path_relative_to_profile (self):
p = inspect.stack()
for obj in p:
if obj[3]=='get_streams':
return obj[1]
return None
def _compile_raw (self,obj):
# make sure we have varibles once
vars={};
# add it add var to dit
for desc in obj.commands:
var_names = desc.get_var_name()
if var_names :
for var_name in var_names:
if vars.has_key(var_name):
raise CTRexPacketBuildException(-11,("variable %s define twice ") % (var_name) );
else:
vars[var_name]=1
# check that all write exits
for desc in obj.commands:
var_name = desc.get_var_ref()
if var_name :
if not vars.has_key(var_name):
raise CTRexPacketBuildException(-11,("variable %s does not exists ") % (var_name) );
desc.compile(self);
for desc in obj.commands:
self.vm_low_level.add_ins(desc.get_obj());
# set split_by_var
if obj.split_by_field :
assert type(obj.split_by_field)==str, "type of split by var should be string"
#if not vars.has_key(obj.split_by_field):
# raise CTRexPacketBuildException(-11,("variable %s does not exists. change split_by_var args ") % (var_name) );
self.vm_low_level.split_by_var = obj.split_by_field
# lazy packet build only on demand
def __lazy_build_packet (self):
# alrady built ? bail out
if self.is_pkt_built:
return
# for buffer, promote to a scapy packet
if self.pkt_raw:
self.pkt = Ether(self.pkt_raw)
self.pkt.build()
self.pkt_raw = None
# regular scapy packet
elif self.pkt:
self.pkt.build()
else:
# should not reach here
raise CTRexPacketBuildException(-11, 'empty packet')
self.is_pkt_built = True
def _pkt_layer_offset (self,layer_name):
self.__lazy_build_packet()
p_utl=CTRexScapyPktUtl(self.pkt);
return p_utl.get_layer_offet_by_str(layer_name)
def _name_to_offset(self,field_name):
self.__lazy_build_packet()
p_utl=CTRexScapyPktUtl(self.pkt);
return p_utl.get_field_offet_by_str(field_name)
def _get_pkt_as_str(self):
if self.pkt:
return str(self.pkt)
if self.pkt_raw:
return self.pkt_raw
raise CTRexPacketBuildException(-11, 'empty packet');
def _add_tuple_gen(self,tuple_gen):
pass;
|