Added geneve header options by HareshKhandelwal · Pull Request #3329 · secdev/scapy

HareshKhandelwal · 2021-08-10T16:41:40Z

currently, we dont have geneve options working.
This patch aims to fix them.

Unit test cases:

With Options:

sendp(Ether(dst='0c:42:a1:d1:da:98',src='40:a6:b7:0b:e9:b1')/Dot1Q(vlan=304,type='IPv4')/IP(proto=17,src='172.17.2.161',dst='172.17.2.32')/UDP(sport=57025,dport=6081)/GENEVE(proto=0x6558,vni=4,options=GeneveOptions(classid=0x0102,type=0x80,data=b'\x00\x01\x00\x02'))/Ether(dst='fa:16:3e:81:fa:0f',src='fa:16:3e:e7:a9:8a',type=0x0800)/IP(proto=1,dst='192.168.2.181',src='192.168.2.92')/ICMP(type=8),iface="wlp0s20f3")


16:19:54.952429 40:a6:b7:0b:e9:b1 > 0c:42:a1:d1:da:98, ethertype 802.1Q (0x8100), length 104: vlan 304, p 0, ethertype IPv4, (tos 0x0, ttl 64, id 1, offset 0, flags [none], proto UDP (17), length 86)
    172.17.2.161.57025 > 172.17.2.32.6081: [udp sum ok] Geneve, Flags [none], vni 0x4, proto TEB (0x6558), options [class Open Virtual Networking (OVN) (0x102) type 0x80(C) len 8 data 00010002]
	fa:16:3e:e7:a9:8a > fa:16:3e:81:fa:0f, ethertype IPv4 (0x0800), length 42: (tos 0x0, ttl 64, id 1, offset 0, flags [none], proto ICMP (1), length 28)
    192.168.2.92 > 192.168.2.181: ICMP echo request, id 0, seq 0, length 8

Without options:

sendp(Ether(dst='0c:42:a1:d1:da:98',src='40:a6:b7:0b:e9:b1')/Dot1Q(vlan=304,type='IPv4')/IP(proto=17,src='172.17.2.161',dst='172.17.2.32')/UDP(sport=57025,dport=6081)/GENEVE(proto=0x6558,vni=4)/Ether(dst='fa:16:3e:81:fa:0f',src='fa:16:3e:e7:a9:8a',type=0x0800)/IP(proto=1,dst='192.168.2.181',src='192.168.2.92')/ICMP(type=8),iface="wlp0s20f3")

16:21:08.305638 40:a6:b7:0b:e9:b1 > 0c:42:a1:d1:da:98, ethertype 802.1Q (0x8100), length 96: vlan 304, p 0, ethertype IPv4, (tos 0x0, ttl 64, id 1, offset 0, flags [none], proto UDP (17), length 78)
    172.17.2.161.57025 > 172.17.2.32.6081: [udp sum ok] Geneve, Flags [none], vni 0x4, proto TEB (0x6558)
	fa:16:3e:e7:a9:8a > fa:16:3e:81:fa:0f, ethertype IPv4 (0x0800), length 42: (tos 0x0, ttl 64, id 1, offset 0, flags [none], proto ICMP (1), length 28)
    192.168.2.92 > 192.168.2.181: ICMP echo request, id 0, seq 0, length 8

>>> packet = GeneveOptions(classid=0x0102,type=0x80,data=b'\x00\x01\x00\x02')
>>> packet.show()
###[ Geneve Options ]### 
  classid   = Open Virtual Networking (OVN)
  type      = 0x80
  reserved  = 0
  length    = None
  data      = '\x00\x01\x00\x02'

>>> packet.show2()
###[ Geneve Options ]### 
  classid   = Open Virtual Networking (OVN)
  type      = 0x80
  reserved  = 0
  length    = 1
  data      = '\x00\x01\x00\x02'

>>> 

>>> packet = GENEVE(proto=0x6558,vni=4,options=GeneveOptions(classid=0x0102,type=0x80,data=b'\x00\x04\x00\x05'))
>>> packet.show()
###[ GENEVE ]### 
  version   = 0
  optionlen = None
  oam       = 0
  critical  = 0
  reserved  = 0
  proto     = TEB
  vni       = 0x4
  reserved2 = 0x0
  \options   \
   |###[ Geneve Options ]### 
   |  classid   = Open Virtual Networking (OVN)
   |  type      = 0x80
   |  reserved  = 0
   |  length    = None
   |  data      = '\x00\x04\x00\x05'

>>> packet.show2()
###[ GENEVE ]### 
  version   = 0
  optionlen = 2
  oam       = 0
  critical  = 0
  reserved  = 0
  proto     = TEB
  vni       = 0x4
  reserved2 = 0x0
  \options   \
   |###[ Geneve Options ]### 
   |  classid   = Open Virtual Networking (OVN)
   |  type      = 0x80
   |  reserved  = 0
   |  length    = 1
   |  data      = '\x00\x04\x00\x05'

>>>

Checklist:

If you are new to Scapy: I have checked CONTRIBUTING.md (esp. section submitting-pull-requests)
I squashed commits belonging together
I added unit tests or explained why they are not relevant
I executed the regression tests for Python2 and Python3 (using tox or, cd test && ./run_tests_py2, cd test && ./run_tests_py3)
If the PR is still not finished, please create a Draft Pull Request

fixes #xxx

HareshKhandelwal · 2021-08-10T16:44:00Z

Hi @guedou , Mistakenly pull request#3287 got closed. Raised this new one.
Addressed your comments on re add author name, named options variable as you suggested. Provided unit test cases.
Please have a review.

Thanks

guedou

This looks good to me.

Would you mind adding some simple unit tests such as https://github.com/secdev/scapy/blob/master/test/contrib/geneve.uts#L8 ?

Yarboa

please check this
https://github.com/secdev/scapy/pull/3329/checks?check_run_id=3341694828#step:5:1

scapy/contrib/geneve.py

HareshKhandelwal · 2022-01-18T20:06:07Z

Hi @guedou

I am writing the unit test cases and got stuck at one place. Can you please provide your opinion where i am going wrong!

Unit test case is

s = Ether(dst='0c:42:a1:d1:da:98',src='40:a6:b7:0b:e9:b1')/Dot1Q(vlan=304,type='IPv4')/IP(proto=17,src='172.17.2.161',dst='172.17.2.32')/UDP(sport=57025,dport=6081)/GENEVE()/Ether(dst='fa:16:3e:81:fa:0f',src='fa:16:3e:e7:a9:8a',type=0x0800)/IP(proto=1,dst='192.168.2.181',src='192.168.2.92')/ICMP(type=8)

While i am able to send proper packet with above packet construct, s.show2() doesnt show any other Encap post Geneve.

s.show2()
###[ Ethernet ]###
dst = 0c:42:a1:d1:da:98
src = 40:a6:b7:0b:e9:b1
type = n_802_1Q
###[ 802.1Q ]###
prio = 0
id = 0
vlan = 304
type = IPv4
###[ IP ]###
version = 4
ihl = 5
tos = 0x0
len = 78
id = 1
flags =
frag = 0
ttl = 64
proto = udp
chksum = 0x1dbb
src = 172.17.2.161
dst = 172.17.2.32
\options
###[ UDP ]###
sport = 57025
dport = geneve
len = 58
chksum = 0x298a
###[ GENEVE ]###
version = 0
optionlen = 0
oam = 0
critical = 0
reserved = 0
proto = TEB
vni = 0x0
reserved2 = 0x0
\options
|###[ Geneve Options ]###
| classid = 0xfa16
| type = 0x3e
| reserved = 4
| length = 1
| data = '\xfa\x0f\xfa\x16>穊\x08\x00E\x00\x00\x1c\x00\x01\x00\x00@\x01\xf4~\xc0\xa8\x02\\xc0\xa8\x02\xb5\x08\x00\xf7\xff\x00\x00\x00\x00'

This makes existing unit test case fail (Which check further encap of Ether). I have checked packet length but didn't find any issue, may be missing anything. Can you please help to identify the issue?

Thanks

guedou · 2022-01-26T09:25:40Z

It seens that GeneveOptions is consuming all the remaining data. You likely need to define extract_padding as done in

scapy/scapy/layers/dns.py

Line 524 in adaa923

class EDNS0TLV(Packet):

HareshKhandelwal · 2022-01-28T11:48:56Z

Hi @guedou

I did rework on clean up and updated unit cases as well. All unit cases passing now.

Thanks
-Haresh

gpotter2 · 2022-02-03T14:09:16Z

scapy/contrib/geneve.py

Forgotten debug print

my bad..removed now

codecov · 2022-02-03T18:09:34Z

Codecov Report

Merging #3329 (237fde2) into master (6508907) will increase coverage by 86.30%.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##           master    #3329       +/-   ##
===========================================
+ Coverage        0   86.30%   +86.30%     
===========================================
  Files           0      282      +282     
  Lines           0    64044    +64044     
===========================================
+ Hits            0    55275    +55275     
- Misses          0     8769     +8769

Impacted Files	Coverage Δ
scapy/contrib/geneve.py	`97.29% <100.00%> (ø)`
scapy/contrib/automotive/ecu.py	`94.13% <0.00%> (ø)`
scapy/contrib/automotive/obd/iid/__init__.py	`100.00% <0.00%> (ø)`
scapy/layers/tls/crypto/suites.py	`100.00% <0.00%> (ø)`
scapy/contrib/ldp.py	`86.06% <0.00%> (ø)`
scapy/layers/mobileip.py	`100.00% <0.00%> (ø)`
scapy/layers/tls/automaton_srv.py	`60.90% <0.00%> (ø)`
scapy/contrib/igmp.py	`100.00% <0.00%> (ø)`
scapy/layers/zigbee.py	`79.85% <0.00%> (ø)`
scapy/contrib/automotive/ccp.py	`97.05% <0.00%> (ø)`
... and 273 more

currently, we dont have geneve options working. This patch aims to fix them.

HareshKhandelwal · 2022-02-15T09:22:41Z

@gpotter2 @guedou can you please help with your reviews? Thanks

polydroi · 2022-02-16T06:47:21Z

LGTM

HareshKhandelwal mentioned this pull request Aug 10, 2021

Currently, geneve options are not working. #3287

Closed

5 tasks

guedou reviewed Aug 16, 2021

View reviewed changes

gpotter2 force-pushed the master branch from a34aad2 to 1de3e84 Compare August 24, 2021 09:36

Yarboa reviewed Aug 26, 2021

View reviewed changes

scapy/contrib/geneve.py Outdated Show resolved Hide resolved

scapy/contrib/geneve.py Outdated Show resolved Hide resolved

scapy/contrib/geneve.py Outdated Show resolved Hide resolved

scapy/contrib/geneve.py Outdated Show resolved Hide resolved

gpotter2 added the needs rework/cleanup label Sep 11, 2021

HareshKhandelwal force-pushed the geneve_options branch from e5d84ce to 30d30bc Compare January 18, 2022 11:21

HareshKhandelwal force-pushed the geneve_options branch from 0addba9 to ed05162 Compare January 28, 2022 11:43

HareshKhandelwal force-pushed the geneve_options branch from ed05162 to df23c6b Compare February 1, 2022 14:14

HareshKhandelwal requested a review from guedou February 1, 2022 18:44

gpotter2 reviewed Feb 3, 2022

View reviewed changes

HareshKhandelwal force-pushed the geneve_options branch from df23c6b to 97cc24f Compare February 3, 2022 17:42

HareshKhandelwal requested a review from gpotter2 February 3, 2022 17:43

Added geneve header options

237fde2

currently, we dont have geneve options working. This patch aims to fix them.

HareshKhandelwal force-pushed the geneve_options branch from 97cc24f to 237fde2 Compare February 7, 2022 10:54

gpotter2 approved these changes Feb 16, 2022

View reviewed changes

guedou approved these changes Mar 1, 2022

View reviewed changes

guedou merged commit 2d4091d into secdev:master Mar 1, 2022

HareshKhandelwal deleted the geneve_options branch March 1, 2022 10:28

gpotter2 added this to the 2.5.0 milestone Mar 29, 2022

Uh oh!

Conversation

HareshKhandelwal commented Aug 10, 2021 • edited by guedou Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

HareshKhandelwal commented Aug 10, 2021

Uh oh!

guedou left a comment

Choose a reason for hiding this comment

Uh oh!

Yarboa left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HareshKhandelwal commented Jan 18, 2022

Uh oh!

guedou commented Jan 26, 2022

Uh oh!

HareshKhandelwal commented Jan 28, 2022

Uh oh!

gpotter2 Feb 3, 2022

Choose a reason for hiding this comment

Uh oh!

HareshKhandelwal Feb 3, 2022

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Feb 3, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

HareshKhandelwal commented Feb 15, 2022

Uh oh!

polydroi commented Feb 16, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

HareshKhandelwal commented Aug 10, 2021 •

edited by guedou

Loading

codecov bot commented Feb 3, 2022 •

edited

Loading