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
|
# Copyright 2020-2023 VyOS maintainers and contributors <maintainers@vyos.io>
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
#Package to communicate with Strongswan VICI
class ViciInitiateError(Exception):
"""
VICI can't initiate a session.
"""
pass
class ViciCommandError(Exception):
"""
VICI can't execute a command by any reason.
"""
pass
def get_vici_sas():
from vici import Session as vici_session
try:
session = vici_session()
except Exception:
raise ViciInitiateError("IPsec not initialized")
try:
sas = list(session.list_sas())
return sas
except Exception:
raise ViciCommandError(f'Failed to get SAs')
def get_vici_connections():
from vici import Session as vici_session
try:
session = vici_session()
except Exception:
raise ViciInitiateError("IPsec not initialized")
try:
connections = list(session.list_conns())
return connections
except Exception:
raise ViciCommandError(f'Failed to get connections')
def get_vici_sas_by_name(ike_name: str, tunnel: str) -> list:
"""
Find sas by IKE_SA name and/or CHILD_SA name
and return list of OrdinaryDicts with SASs info
If tunnel is not None return value is list of OrdenaryDicts contained only
CHILD_SAs wich names equal tunnel value.
:param ike_name: IKE SA name
:type ike_name: str
:param tunnel: CHILD SA name
:type tunnel: str
:return: list of Ordinary Dicts with SASs
:rtype: list
"""
from vici import Session as vici_session
try:
session = vici_session()
except Exception:
raise ViciInitiateError("IPsec not initialized")
vici_dict = {}
if ike_name:
vici_dict['ike'] = ike_name
if tunnel:
vici_dict['child'] = tunnel
try:
sas = list(session.list_sas(vici_dict))
return sas
except Exception:
raise ViciCommandError(f'Failed to get SAs')
def terminate_vici_ikeid_list(ike_id_list: list) -> None:
"""
Terminate IKE SAs by their id that contained in the list
:param ike_id_list: list of IKE SA id
:type ike_id_list: list
"""
from vici import Session as vici_session
try:
session = vici_session()
except Exception:
raise ViciInitiateError("IPsec not initialized")
try:
for ikeid in ike_id_list:
session_generator = session.terminate(
{'ike-id': ikeid, 'timeout': '-1'})
# a dummy `for` loop is required because of requirements
# from vici. Without a full iteration on the output, the
# command to vici may not be executed completely
for _ in session_generator:
pass
except Exception:
raise ViciCommandError(
f'Failed to terminate SA for IKE ids {ike_id_list}')
def terminate_vici_by_name(ike_name: str, child_name: str) -> None:
"""
Terminate IKE SAs by name if CHILD SA name is None.
Terminate CHILD SAs by name if CHILD SA name is specified
:param ike_name: IKE SA name
:type ike_name: str
:param child_name: CHILD SA name
:type child_name: str
"""
from vici import Session as vici_session
try:
session = vici_session()
except Exception:
raise ViciInitiateError("IPsec not initialized")
try:
vici_dict: dict= {}
if ike_name:
vici_dict['ike'] = ike_name
if child_name:
vici_dict['child'] = child_name
session_generator = session.terminate(vici_dict)
# a dummy `for` loop is required because of requirements
# from vici. Without a full iteration on the output, the
# command to vici may not be executed completely
for _ in session_generator:
pass
except Exception:
if child_name:
raise ViciCommandError(
f'Failed to terminate SA for IPSEC {child_name}')
else:
raise ViciCommandError(
f'Failed to terminate SA for IKE {ike_name}')
def vici_initiate(ike_sa_name: str, child_sa_name: str, src_addr: str,
dst_addr: str) -> bool:
"""Initiate IKE SA connection with specific peer
Args:
ike_sa_name (str): an IKE SA connection name
child_sa_name (str): a child SA profile name
src_addr (str): source address
dst_addr (str): remote address
Returns:
bool: a result of initiation command
"""
from vici import Session as vici_session
try:
session = vici_session()
except Exception:
raise ViciInitiateError("IPsec not initialized")
try:
session_generator = session.initiate({
'ike': ike_sa_name,
'child': child_sa_name,
'timeout': '-1',
'my-host': src_addr,
'other-host': dst_addr
})
# a dummy `for` loop is required because of requirements
# from vici. Without a full iteration on the output, the
# command to vici may not be executed completely
for _ in session_generator:
pass
return True
except Exception:
raise ViciCommandError(f'Failed to initiate SA for IKE {ike_sa_name}')
|
