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
|
#!/usr/bin/env python3
# Copyright (c) 2021 Cisco and/or its affiliates.
#
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
#
# Licensed under the Apache License 2.0 or
# GNU General Public License v2.0 or later; you may not use this file
# except in compliance with one of these Licenses. You
# may obtain a copy of the Licenses at:
#
# http://www.apache.org/licenses/LICENSE-2.0
# https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
#
# Note: If this file is linked with Scapy, which is GPLv2+, your use of it
# must be under GPLv2+. If at any point in the future it is no longer linked
# with Scapy (or other GPLv2+ licensed software), you are free to choose
# Apache 2.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Traffic script for IPsec verification."""
import sys
from ipaddress import ip_address
from scapy.layers.inet import IP
from scapy.layers.inet6 import IPv6, ICMPv6ND_NS, ICMPv6MLReport2, ICMPv6ND_RA
from scapy.layers.ipsec import SecurityAssociation, ESP
from scapy.layers.l2 import Ether
from scapy.packet import Raw
from .PacketVerifier import RxQueue, TxQueue
from .TrafficScriptArg import TrafficScriptArg
def check_ipsec(pkt_recv, ip_layer, dst_tun, src_ip, dst_ip, sa_in):
"""Check received IPsec packet.
:param pkt_recv: Received packet to verify.
:param ip_layer: Scapy IP layer.
:param dst_tun: IPsec tunnel destination address.
:param src_ip: Source IP/IPv6 address of original IP/IPv6 packet.
:param dst_ip: Destination IP/IPv6 address of original IP/IPv6 packet.
:param sa_in: IPsec SA for packet decryption.
:type pkt_recv: scapy.Ether
:type ip_layer: scapy.layers.inet.IP or scapy.layers.inet6.IPv6
:type dst_tun: str
:type src_ip: str
:type dst_ip: str
:type sa_in: scapy.layers.ipsec.SecurityAssociation
:raises RuntimeError: If received packet is invalid.
"""
if not pkt_recv.haslayer(ip_layer):
raise RuntimeError(
f"Not an {ip_layer.name} packet received: {pkt_recv!r}"
)
if pkt_recv[ip_layer].dst != dst_tun:
raise RuntimeError(
f"Received packet has invalid destination address: "
f"{pkt_recv[ip_layer].dst} should be: {dst_tun}"
)
if not pkt_recv.haslayer(ESP):
raise RuntimeError(f"Not an ESP packet received: {pkt_recv!r}")
ip_pkt = pkt_recv[ip_layer]
d_pkt = sa_in.decrypt(ip_pkt)
if d_pkt[ip_layer].dst != dst_ip:
raise RuntimeError(
f"Decrypted packet has invalid destination address: "
f"{d_pkt[ip_layer].dst} should be: {dst_ip}"
)
if d_pkt[ip_layer].src != src_ip:
raise RuntimeError(
f"Decrypted packet has invalid source address: "
f"{d_pkt[ip_layer].src} should be: {src_ip}"
)
if ip_layer == IP and d_pkt[ip_layer].proto != 61:
raise RuntimeError(
f"Decrypted packet has invalid IP protocol: "
f"{d_pkt[ip_layer].proto} should be: 61"
)
def check_ip(pkt_recv, ip_layer, src_ip, dst_ip):
"""Check received IP/IPv6 packet.
:param pkt_recv: Received packet to verify.
:param ip_layer: Scapy IP layer.
:param src_ip: Source IP/IPv6 address.
:param dst_ip: Destination IP/IPv6 address.
:type pkt_recv: scapy.Ether
:type ip_layer: scapy.layers.inet.IP or scapy.layers.inet6.IPv6
:type src_ip: str
:type dst_ip: str
:raises RuntimeError: If received packet is invalid.
"""
if not pkt_recv.haslayer(ip_layer):
raise RuntimeError(
f"Not an {ip_layer.name} packet received: {pkt_recv!r}"
)
if pkt_recv[ip_layer].dst != dst_ip:
raise RuntimeError(
f"Received packet has invalid destination address: "
f"{pkt_recv[ip_layer.name].dst} should be: {dst_ip}"
)
if pkt_recv[ip_layer].src != src_ip:
raise RuntimeError(
f"Received packet has invalid destination address: "
f"{pkt_recv[ip_layer.name].dst} should be: {src_ip}"
)
if ip_layer == IP and pkt_recv[ip_layer].proto != 61:
raise RuntimeError(
f"Received packet has invalid IP protocol: "
f"{pkt_recv[ip_layer].proto} should be: 61"
)
# TODO: Pylint says too-many-locals and too-many-statements. Refactor!
def main():
"""Send and receive IPsec packet."""
args = TrafficScriptArg(
[
u"tx_src_mac", u"tx_dst_mac", u"rx_src_mac", u"rx_dst_mac",
u"src_ip", u"dst_ip", u"crypto_alg", u"crypto_key", u"integ_alg",
u"integ_key", u"l_spi", u"r_spi"
],
[u"src_tun", u"dst_tun"]
)
tx_txq = TxQueue(args.get_arg(u"tx_if"))
tx_rxq = RxQueue(args.get_arg(u"tx_if"))
rx_txq = TxQueue(args.get_arg(u"rx_if"))
rx_rxq = RxQueue(args.get_arg(u"rx_if"))
tx_src_mac = args.get_arg(u"tx_src_mac")
tx_dst_mac = args.get_arg(u"tx_dst_mac")
rx_src_mac = args.get_arg(u"rx_src_mac")
rx_dst_mac = args.get_arg(u"rx_dst_mac")
src_ip = args.get_arg(u"src_ip")
dst_ip = args.get_arg(u"dst_ip")
crypto_alg = args.get_arg(u"crypto_alg")
crypto_key = args.get_arg(u"crypto_key")
integ_alg = args.get_arg(u"integ_alg")
integ_key = args.get_arg(u"integ_key")
l_spi = int(args.get_arg(u"l_spi"))
r_spi = int(args.get_arg(u"r_spi"))
src_tun = args.get_arg(u"src_tun")
dst_tun = args.get_arg(u"dst_tun")
ip_layer = IP if ip_address(src_ip).version == 4 else IPv6
tunnel_out = ip_layer(src=src_tun, dst=dst_tun) if src_tun and dst_tun \
else None
tunnel_in = ip_layer(src=dst_tun, dst=src_tun) if src_tun and dst_tun \
else None
if not (src_tun and dst_tun):
src_tun = src_ip
sa_in = SecurityAssociation(
ESP, spi=r_spi, crypt_algo=crypto_alg,
crypt_key=crypto_key.encode(encoding=u"utf-8"), auth_algo=integ_alg,
auth_key=integ_key.encode(encoding=u"utf-8"), tunnel_header=tunnel_in
)
sa_out = SecurityAssociation(
ESP, spi=l_spi, crypt_algo=crypto_alg,
crypt_key=crypto_key.encode(encoding=u"utf-8"), auth_algo=integ_alg,
auth_key=integ_key.encode(encoding=u"utf-8"), tunnel_header=tunnel_out
)
ip_pkt = ip_layer(src=src_ip, dst=dst_ip, proto=61) if ip_layer == IP \
else ip_layer(src=src_ip, dst=dst_ip)
ip_pkt = ip_layer(ip_pkt)
e_pkt = sa_out.encrypt(ip_pkt)
tx_pkt_send = (Ether(src=tx_src_mac, dst=tx_dst_mac) /
e_pkt)
sent_packets = list()
tx_pkt_send /= Raw()
sent_packets.append(tx_pkt_send)
tx_txq.send(tx_pkt_send)
while True:
rx_pkt_recv = rx_rxq.recv(2)
if rx_pkt_recv is None:
raise RuntimeError(f"{ip_layer.name} packet Rx timeout")
if rx_pkt_recv.haslayer(ICMPv6ND_NS):
# read another packet in the queue if the current one is ICMPv6ND_NS
continue
elif rx_pkt_recv.haslayer(ICMPv6MLReport2):
# read another packet in the queue if the current one is
# ICMPv6MLReport2
continue
elif rx_pkt_recv.haslayer(ICMPv6ND_RA):
# read another packet in the queue if the current one is
# ICMPv6ND_RA
continue
# otherwise process the current packet
break
check_ip(rx_pkt_recv, ip_layer, src_ip, dst_ip)
rx_ip_pkt = ip_layer(src=dst_ip, dst=src_ip, proto=61) if ip_layer == IP \
else ip_layer(src=dst_ip, dst=src_ip)
rx_pkt_send = (Ether(src=rx_dst_mac, dst=rx_src_mac) /
rx_ip_pkt)
rx_pkt_send /= Raw()
rx_txq.send(rx_pkt_send)
while True:
tx_pkt_recv = tx_rxq.recv(2, sent_packets)
if tx_pkt_recv is None:
raise RuntimeError(u"ESP packet Rx timeout")
if tx_pkt_recv.haslayer(ICMPv6ND_NS):
# read another packet in the queue if the current one is ICMPv6ND_NS
continue
elif tx_pkt_recv.haslayer(ICMPv6MLReport2):
# read another packet in the queue if the current one is
# ICMPv6MLReport2
continue
elif tx_pkt_recv.haslayer(ICMPv6ND_RA):
# read another packet in the queue if the current one is
# ICMPv6ND_RA
continue
break
check_ipsec(tx_pkt_recv, ip_layer, src_tun, dst_ip, src_ip, sa_in)
sys.exit(0)
if __name__ == u"__main__":
main()
|
