-
Notifications
You must be signed in to change notification settings - Fork 13.7k
/
security_converge.py
273 lines (228 loc) · 9.05 KB
/
security_converge.py
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
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you 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 logging
from dataclasses import dataclass
from sqlalchemy import (
Column,
ForeignKey,
Integer,
Sequence,
String,
Table,
UniqueConstraint,
)
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import Load, relationship, Session
logger = logging.getLogger(__name__)
Base = declarative_base()
@dataclass(frozen=True)
class Pvm:
view: str
permission: str
PvmMigrationMapType = dict[Pvm, tuple[Pvm, ...]]
# Partial freeze of the current metadata db schema
class Permission(Base): # type: ignore
__tablename__ = "ab_permission"
id = Column(Integer, Sequence("ab_permission_id_seq"), primary_key=True)
name = Column(String(100), unique=True, nullable=False)
def __repr__(self) -> str:
return f"{self.name}"
class ViewMenu(Base): # type: ignore
__tablename__ = "ab_view_menu"
id = Column(Integer, Sequence("ab_view_menu_id_seq"), primary_key=True)
name = Column(String(250), unique=True, nullable=False)
def __repr__(self) -> str:
return f"{self.name}"
def __eq__(self, other: object) -> bool:
return (isinstance(other, self.__class__)) and (self.name == other.name)
def __neq__(self, other: object) -> bool:
return (isinstance(other, self.__class__)) and self.name != other.name
assoc_permissionview_role = Table(
"ab_permission_view_role",
Base.metadata,
Column("id", Integer, Sequence("ab_permission_view_role_id_seq"), primary_key=True),
Column("permission_view_id", Integer, ForeignKey("ab_permission_view.id")),
Column("role_id", Integer, ForeignKey("ab_role.id")),
UniqueConstraint("permission_view_id", "role_id"),
)
class Role(Base): # type: ignore
__tablename__ = "ab_role"
id = Column(Integer, Sequence("ab_role_id_seq"), primary_key=True)
name = Column(String(64), unique=True, nullable=False)
permissions = relationship(
"PermissionView", secondary=assoc_permissionview_role, backref="role"
)
def __repr__(self) -> str:
return f"{self.name}"
class PermissionView(Base): # type: ignore
__tablename__ = "ab_permission_view"
__table_args__ = (UniqueConstraint("permission_id", "view_menu_id"),)
id = Column(Integer, Sequence("ab_permission_view_id_seq"), primary_key=True)
permission_id = Column(Integer, ForeignKey("ab_permission.id"))
permission = relationship("Permission")
view_menu_id = Column(Integer, ForeignKey("ab_view_menu.id"))
view_menu = relationship("ViewMenu")
def __repr__(self) -> str:
return f"{self.permission} {self.view_menu}"
def _add_view_menu(session: Session, view_name: str) -> ViewMenu:
"""
Check and add the new view menu
"""
new_view = session.query(ViewMenu).filter(ViewMenu.name == view_name).one_or_none()
if not new_view:
new_view = ViewMenu(name=view_name)
session.add(new_view)
return new_view
def _add_permission(session: Session, permission_name: str) -> Permission:
"""
Check and add the new Permission
"""
new_permission = (
session.query(Permission)
.filter(Permission.name == permission_name)
.one_or_none()
)
if not new_permission:
new_permission = Permission(name=permission_name)
session.add(new_permission)
return new_permission
def _add_permission_view(
session: Session, permission: Permission, view_menu: ViewMenu
) -> PermissionView:
"""
Check and add the new Permission View
"""
new_pvm = (
session.query(PermissionView)
.filter(
PermissionView.view_menu_id == view_menu.id,
PermissionView.permission_id == permission.id,
)
.one_or_none()
)
if not new_pvm:
new_pvm = PermissionView(view_menu=view_menu, permission=permission)
session.add(new_pvm)
return new_pvm
def _find_pvm(session: Session, view_name: str, permission_name: str) -> PermissionView:
return (
session.query(PermissionView)
.join(Permission)
.join(ViewMenu)
.filter(ViewMenu.name == view_name, Permission.name == permission_name)
).one_or_none()
def add_pvms(
session: Session, pvm_data: dict[str, tuple[str, ...]], commit: bool = False
) -> list[PermissionView]:
"""
Checks if exists and adds new Permissions, Views and PermissionView's
"""
pvms = []
for view_name, permissions in pvm_data.items():
# Check and add the new View
new_view = _add_view_menu(session, view_name)
for permission_name in permissions:
new_permission = _add_permission(session, permission_name)
# Check and add the new PVM
pvms.append(_add_permission_view(session, new_permission, new_view))
if commit:
session.commit()
return pvms
def _delete_old_permissions(
session: Session, pvm_map: dict[PermissionView, list[PermissionView]]
) -> None:
"""
Delete old permissions:
- Delete the PermissionView
- Deletes the Permission if it's an orphan now
- Deletes the ViewMenu if it's an orphan now
"""
# Delete old permissions
for old_pvm, new_pvms in pvm_map.items():
old_permission_name = old_pvm.permission.name
old_view_name = old_pvm.view_menu.name
logger.info(f"Going to delete pvm: {old_pvm}")
session.delete(old_pvm)
pvms_with_permission = (
session.query(PermissionView)
.join(Permission)
.filter(Permission.name == old_permission_name)
).first()
if not pvms_with_permission:
logger.info(f"Going to delete permission: {old_pvm.permission}")
session.delete(old_pvm.permission)
pvms_with_view_menu = (
session.query(PermissionView)
.join(ViewMenu)
.filter(ViewMenu.name == old_view_name)
).first()
if not pvms_with_view_menu:
logger.info(f"Going to delete view_menu: {old_pvm.view_menu}")
session.delete(old_pvm.view_menu)
def migrate_roles(
session: Session,
pvm_key_map: PvmMigrationMapType,
commit: bool = False,
) -> None:
"""
Migrates all existing roles that have the permissions to be migrated
"""
# Collect a map of PermissionView objects for migration
pvm_map: dict[PermissionView, list[PermissionView]] = {}
for old_pvm_key, new_pvms_ in pvm_key_map.items():
old_pvm = _find_pvm(session, old_pvm_key.view, old_pvm_key.permission)
if old_pvm:
for new_pvm_key in new_pvms_:
new_pvm = _find_pvm(session, new_pvm_key.view, new_pvm_key.permission)
if old_pvm not in pvm_map:
pvm_map[old_pvm] = [new_pvm]
else:
pvm_map[old_pvm].append(new_pvm)
# Replace old permissions by the new ones on all existing roles
roles = session.query(Role).options(Load(Role).joinedload(Role.permissions)).all()
for role in roles:
for old_pvm, new_pvms in pvm_map.items():
if old_pvm in role.permissions:
logger.info(f"Removing {old_pvm} from {role}")
role.permissions.remove(old_pvm)
for new_pvm in new_pvms:
if new_pvm not in role.permissions:
logger.info(f"Add {new_pvm} to {role}")
role.permissions.append(new_pvm)
# Delete old permissions
_delete_old_permissions(session, pvm_map)
if commit:
session.commit()
def get_reversed_new_pvms(pvm_map: PvmMigrationMapType) -> dict[str, tuple[str, ...]]:
reversed_pvms: dict[str, tuple[str, ...]] = {}
for old_pvm, new_pvms in pvm_map.items():
if old_pvm.view not in reversed_pvms:
reversed_pvms[old_pvm.view] = (old_pvm.permission,)
else:
reversed_pvms[old_pvm.view] = reversed_pvms[old_pvm.view] + (
old_pvm.permission,
)
return reversed_pvms
def get_reversed_pvm_map(pvm_map: PvmMigrationMapType) -> PvmMigrationMapType:
reversed_pvm_map: PvmMigrationMapType = {}
for old_pvm, new_pvms in pvm_map.items():
for new_pvm in new_pvms:
if new_pvm not in reversed_pvm_map:
reversed_pvm_map[new_pvm] = (old_pvm,)
else:
reversed_pvm_map[new_pvm] = reversed_pvm_map[new_pvm] + (old_pvm,)
return reversed_pvm_map