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
|
#
# Copyright (c) 2018 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# 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.
#
import datetime
from socket import inet_pton, AF_INET6, AF_INET
import socket
import ipaddress
from . import macaddress
# Copies from vl_api_address_t definition
ADDRESS_IP4 = 0
ADDRESS_IP6 = 1
def verify_enum_hint(e):
return (e.ADDRESS_IP4.value == ADDRESS_IP4) and (e.ADDRESS_IP6.value == ADDRESS_IP6)
#
# Type conversion for input arguments and return values
#
def format_vl_api_address_t(args):
try:
return {"un": {"ip6": inet_pton(AF_INET6, args)}, "af": ADDRESS_IP6}
# PY2: raises socket.error
# PY3: raises OSError
except (socket.error, OSError):
return {"un": {"ip4": inet_pton(AF_INET, args)}, "af": ADDRESS_IP4}
def format_vl_api_prefix_t(args):
if isinstance(args, (ipaddress.IPv4Network, ipaddress.IPv6Network)):
return {
"address": format_vl_api_address_t(str(args.network_address)),
"len": int(args.prefixlen),
}
p, length = args.split("/")
return {"address": format_vl_api_address_t(p), "len": int(length)}
def format_vl_api_address_with_prefix_t(args):
if isinstance(args, (ipaddress.IPv4Interface, ipaddress.IPv6Interface)):
return {
"address": format_vl_api_address_t(str(args.network_address)),
"len": int(args.prefixlen),
}
p, length = args.split("/")
return {"address": format_vl_api_address_t(p), "len": int(length)}
def format_vl_api_ip6_prefix_t(args):
if isinstance(args, ipaddress.IPv6Network):
return {"address": args.network_address.packed, "len": int(args.prefixlen)}
p, length = args.split("/")
return {"address": inet_pton(AF_INET6, p), "len": int(length)}
def format_vl_api_ip6_address_with_prefix_t(args):
if isinstance(args, ipaddress.IPv6Interface):
return {"address": args.network_address.packed, "len": int(args.prefixlen)}
p, length = args.split("/")
return {"address": inet_pton(AF_INET6, p), "len": int(length)}
def format_vl_api_ip4_prefix_t(args):
if isinstance(args, ipaddress.IPv4Network):
return {"address": args.network_address.packed, "len": int(args.prefixlen)}
p, length = args.split("/")
return {"address": inet_pton(AF_INET, p), "len": int(length)}
def format_vl_api_ip4_address_with_prefix_t(args):
if isinstance(args, ipaddress.IPv4Interface):
return {"address": args.network_address.packed, "len": int(args.prefixlen)}
p, length = args.split("/")
return {"address": inet_pton(AF_INET, p), "len": int(length)}
conversion_table = {
"vl_api_ip6_address_t": {
"IPv6Address": lambda o: o.packed,
"str": lambda s: inet_pton(AF_INET6, s),
},
"vl_api_ip4_address_t": {
"IPv4Address": lambda o: o.packed,
"str": lambda s: inet_pton(AF_INET, s),
},
"vl_api_ip6_prefix_t": {
"IPv6Network": lambda o: {
"address": o.network_address.packed,
"len": o.prefixlen,
},
"str": lambda s: format_vl_api_ip6_prefix_t(s),
},
"vl_api_ip4_prefix_t": {
"IPv4Network": lambda o: {
"address": o.network_address.packed,
"len": o.prefixlen,
},
"str": lambda s: format_vl_api_ip4_prefix_t(s),
},
"vl_api_address_t": {
"IPv4Address": lambda o: {"af": ADDRESS_IP4, "un": {"ip4": o.packed}},
"IPv6Address": lambda o: {"af": ADDRESS_IP6, "un": {"ip6": o.packed}},
"str": lambda s: format_vl_api_address_t(s),
},
"vl_api_prefix_t": {
"IPv4Network": lambda o: {
"address": {"af": ADDRESS_IP4, "un": {"ip4": o.network_address.packed}},
"len": o.prefixlen,
},
"IPv6Network": lambda o: {
"address": {"af": ADDRESS_IP6, "un": {"ip6": o.network_address.packed}},
"len": o.prefixlen,
},
"str": lambda s: format_vl_api_prefix_t(s),
},
"vl_api_address_with_prefix_t": {
"IPv4Interface": lambda o: {
"address": {"af": ADDRESS_IP4, "un": {"ip4": o.packed}},
"len": o.network.prefixlen,
},
"IPv6Interface": lambda o: {
"address": {"af": ADDRESS_IP6, "un": {"ip6": o.packed}},
"len": o.network.prefixlen,
},
"str": lambda s: format_vl_api_address_with_prefix_t(s),
},
"vl_api_ip4_address_with_prefix_t": {
"IPv4Interface": lambda o: {"address": o.packed, "len": o.network.prefixlen},
"str": lambda s: format_vl_api_ip4_address_with_prefix_t(s),
},
"vl_api_ip6_address_with_prefix_t": {
"IPv6Interface": lambda o: {"address": o.packed, "len": o.network.prefixlen},
"str": lambda s: format_vl_api_ip6_address_with_prefix_t(s),
},
"vl_api_mac_address_t": {
"MACAddress": lambda o: o.packed,
"str": lambda s: macaddress.mac_pton(s),
},
"vl_api_timestamp_t": {
"datetime.datetime": lambda o: (
o - datetime.datetime(1970, 1, 1)
).total_seconds()
},
}
def unformat_api_address_t(o):
if o.af == 1:
return ipaddress.IPv6Address(o.un.ip6)
if o.af == 0:
return ipaddress.IPv4Address(o.un.ip4)
return None
def unformat_api_prefix_t(o):
if o.address.af == 1:
return ipaddress.IPv6Network((o.address.un.ip6, o.len), False)
if o.address.af == 0:
return ipaddress.IPv4Network((o.address.un.ip4, o.len), False)
return None
if isinstance(o.address, ipaddress.IPv4Address):
return ipaddress.IPv4Network((o.address, o.len), False)
if isinstance(o.address, ipaddress.IPv6Address):
return ipaddress.IPv6Network((o.address, o.len), False)
raise ValueError("Unknown instance {}", format(o))
def unformat_api_address_with_prefix_t(o):
if o.address.af == 1:
return ipaddress.IPv6Interface((o.address.un.ip6, o.len))
if o.address.af == 0:
return ipaddress.IPv4Interface((o.address.un.ip4, o.len))
return None
def unformat_api_ip4_address_with_prefix_t(o):
return ipaddress.IPv4Interface((o.address, o.len))
def unformat_api_ip6_address_with_prefix_t(o):
return ipaddress.IPv6Interface((o.address, o.len))
conversion_unpacker_table = {
"vl_api_ip6_address_t": lambda o: ipaddress.IPv6Address(o),
"vl_api_ip6_prefix_t": lambda o: ipaddress.IPv6Network((o.address, o.len)),
"vl_api_ip4_address_t": lambda o: ipaddress.IPv4Address(o),
"vl_api_ip4_prefix_t": lambda o: ipaddress.IPv4Network((o.address, o.len)),
"vl_api_address_t": lambda o: unformat_api_address_t(o),
"vl_api_prefix_t": lambda o: unformat_api_prefix_t(o),
"vl_api_address_with_prefix_t": lambda o: unformat_api_address_with_prefix_t(o),
"vl_api_ip4_address_with_prefix_t": lambda o: unformat_api_ip4_address_with_prefix_t(
o
),
"vl_api_ip6_address_with_prefix_t": lambda o: unformat_api_ip6_address_with_prefix_t(
o
),
"vl_api_mac_address_t": lambda o: macaddress.MACAddress(o),
"vl_api_timestamp_t": lambda o: datetime.datetime.fromtimestamp(o),
"vl_api_timedelta_t": lambda o: datetime.timedelta(seconds=o),
}
|
