]>
git.proxmox.com Git - ceph.git/blob - ceph/src/pybind/mgr/dashboard/services/access_control.py
1 # -*- coding: utf-8 -*-
2 # pylint: disable=too-many-arguments,too-many-return-statements
3 # pylint: disable=too-many-branches, too-many-locals, too-many-statements
4 from __future__
import absolute_import
13 from mgr_module
import CLIReadCommand
, CLIWriteCommand
15 from .. import mgr
, logger
16 from ..security
import Scope
, Permission
17 from ..exceptions
import RoleAlreadyExists
, RoleDoesNotExist
, ScopeNotValid
, \
18 PermissionNotValid
, RoleIsAssociatedWithUser
, \
19 UserAlreadyExists
, UserDoesNotExist
, ScopeNotInRole
, \
23 # password hashing algorithm
24 def password_hash(password
, salt_password
=None):
28 salt_password
= bcrypt
.gensalt()
30 salt_password
= salt_password
.encode('utf8')
31 return bcrypt
.hashpw(password
.encode('utf8'), salt_password
).decode('utf8')
34 _P
= Permission
# short alias
38 def __init__(self
, name
, description
=None, scope_permissions
=None):
40 self
.description
= description
41 if scope_permissions
is None:
42 self
.scopes_permissions
= {}
44 self
.scopes_permissions
= scope_permissions
47 return hash(self
.name
)
49 def __eq__(self
, other
):
50 return self
.name
== other
.name
52 def set_scope_permissions(self
, scope
, permissions
):
53 if not Scope
.valid_scope(scope
):
54 raise ScopeNotValid(scope
)
55 for perm
in permissions
:
56 if not Permission
.valid_permission(perm
):
57 raise PermissionNotValid(perm
)
60 self
.scopes_permissions
[scope
] = permissions
62 def del_scope_permissions(self
, scope
):
63 if scope
not in self
.scopes_permissions
:
64 raise ScopeNotInRole(scope
, self
.name
)
65 del self
.scopes_permissions
[scope
]
67 def reset_scope_permissions(self
):
68 self
.scopes_permissions
= {}
70 def authorize(self
, scope
, permissions
):
71 if scope
in self
.scopes_permissions
:
72 role_perms
= self
.scopes_permissions
[scope
]
73 for perm
in permissions
:
74 if perm
not in role_perms
:
82 'description': self
.description
,
83 'scopes_permissions': self
.scopes_permissions
87 def from_dict(cls
, r_dict
):
88 return Role(r_dict
['name'], r_dict
['description'],
89 r_dict
['scopes_permissions'])
92 # static pre-defined system roles
93 # this roles cannot be deleted nor updated
95 # admin role provides all permissions for all scopes
96 ADMIN_ROLE
= Role('administrator', 'Administrator', {
97 scope_name
: Permission
.all_permissions()
98 for scope_name
in Scope
.all_scopes()
102 # read-only role provides read-only permission for all scopes
103 READ_ONLY_ROLE
= Role('read-only', 'Read-Only', {
104 scope_name
: [_P
.READ
] for scope_name
in Scope
.all_scopes()
105 if scope_name
!= Scope
.DASHBOARD_SETTINGS
109 # block manager role provides all permission for block related scopes
110 BLOCK_MGR_ROLE
= Role('block-manager', 'Block Manager', {
111 Scope
.RBD_IMAGE
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
112 Scope
.POOL
: [_P
.READ
],
113 Scope
.ISCSI
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
114 Scope
.RBD_MIRRORING
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
118 # RadosGW manager role provides all permissions for block related scopes
119 RGW_MGR_ROLE
= Role('rgw-manager', 'RGW Manager', {
120 Scope
.RGW
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
121 Scope
.CONFIG_OPT
: [_P
.READ
],
125 # Cluster manager role provides all permission for OSDs, Monitors, and
127 CLUSTER_MGR_ROLE
= Role('cluster-manager', 'Cluster Manager', {
128 Scope
.HOSTS
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
129 Scope
.OSD
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
130 Scope
.MONITOR
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
131 Scope
.MANAGER
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
132 Scope
.CONFIG_OPT
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
133 Scope
.LOG
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
137 # Pool manager role provides all permissions for pool related scopes
138 POOL_MGR_ROLE
= Role('pool-manager', 'Pool Manager', {
139 Scope
.POOL
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
140 Scope
.CONFIG_OPT
: [_P
.READ
],
143 # Pool manager role provides all permissions for CephFS related scopes
144 CEPHFS_MGR_ROLE
= Role('cephfs-manager', 'CephFS Manager', {
145 Scope
.CEPHFS
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
146 Scope
.CONFIG_OPT
: [_P
.READ
],
149 GANESHA_MGR_ROLE
= Role('ganesha-manager', 'NFS Ganesha Manager', {
150 Scope
.NFS_GANESHA
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
151 Scope
.CEPHFS
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
152 Scope
.RGW
: [_P
.READ
, _P
.CREATE
, _P
.UPDATE
, _P
.DELETE
],
153 Scope
.CONFIG_OPT
: [_P
.READ
],
158 ADMIN_ROLE
.name
: ADMIN_ROLE
,
159 READ_ONLY_ROLE
.name
: READ_ONLY_ROLE
,
160 BLOCK_MGR_ROLE
.name
: BLOCK_MGR_ROLE
,
161 RGW_MGR_ROLE
.name
: RGW_MGR_ROLE
,
162 CLUSTER_MGR_ROLE
.name
: CLUSTER_MGR_ROLE
,
163 POOL_MGR_ROLE
.name
: POOL_MGR_ROLE
,
164 CEPHFS_MGR_ROLE
.name
: CEPHFS_MGR_ROLE
,
165 GANESHA_MGR_ROLE
.name
: GANESHA_MGR_ROLE
,
170 def __init__(self
, username
, password
, name
=None, email
=None, roles
=None,
172 self
.username
= username
173 self
.password
= password
180 if lastUpdate
is None:
181 self
.refreshLastUpdate()
183 self
.lastUpdate
= lastUpdate
185 def refreshLastUpdate(self
):
186 self
.lastUpdate
= int(time
.time())
188 def set_password(self
, password
):
189 self
.password
= password_hash(password
)
190 self
.refreshLastUpdate()
192 def set_roles(self
, roles
):
193 self
.roles
= set(roles
)
194 self
.refreshLastUpdate()
196 def add_roles(self
, roles
):
197 self
.roles
= self
.roles
.union(set(roles
))
198 self
.refreshLastUpdate()
200 def del_roles(self
, roles
):
202 if role
not in self
.roles
:
203 raise RoleNotInUser(role
.name
, self
.username
)
204 self
.roles
.difference_update(set(roles
))
205 self
.refreshLastUpdate()
207 def authorize(self
, scope
, permissions
):
208 for role
in self
.roles
:
209 if role
.authorize(scope
, permissions
):
213 def permissions_dict(self
):
215 for role
in self
.roles
:
216 for scope
, perms_list
in role
.scopes_permissions
.items():
218 perms_tmp
= set(perms
[scope
]).union(set(perms_list
))
219 perms
[scope
] = list(perms_tmp
)
221 perms
[scope
] = perms_list
227 'username': self
.username
,
228 'password': self
.password
,
229 'roles': sorted([r
.name
for r
in self
.roles
]),
232 'lastUpdate': self
.lastUpdate
236 def from_dict(cls
, u_dict
, roles
):
237 return User(u_dict
['username'], u_dict
['password'], u_dict
['name'],
238 u_dict
['email'], {roles
[r
] for r
in u_dict
['roles']},
239 u_dict
['lastUpdate'])
242 class AccessControlDB(object):
244 ACDB_CONFIG_KEY
= "accessdb_v"
246 def __init__(self
, version
, users
, roles
):
248 self
.version
= version
250 self
.lock
= threading
.RLock()
252 def create_role(self
, name
, description
=None):
254 if name
in SYSTEM_ROLES
or name
in self
.roles
:
255 raise RoleAlreadyExists(name
)
256 role
= Role(name
, description
)
257 self
.roles
[name
] = role
260 def get_role(self
, name
):
262 if name
not in self
.roles
:
263 raise RoleDoesNotExist(name
)
264 return self
.roles
[name
]
266 def delete_role(self
, name
):
268 if name
not in self
.roles
:
269 raise RoleDoesNotExist(name
)
270 role
= self
.roles
[name
]
272 # check if role is not associated with a user
273 for username
, user
in self
.users
.items():
274 if role
in user
.roles
:
275 raise RoleIsAssociatedWithUser(name
, username
)
279 def create_user(self
, username
, password
, name
, email
):
280 logger
.debug("AC: creating user: username=%s", username
)
282 if username
in self
.users
:
283 raise UserAlreadyExists(username
)
284 user
= User(username
, password_hash(password
), name
, email
)
285 self
.users
[username
] = user
288 def get_user(self
, username
):
290 if username
not in self
.users
:
291 raise UserDoesNotExist(username
)
292 return self
.users
[username
]
294 def delete_user(self
, username
):
296 if username
not in self
.users
:
297 raise UserDoesNotExist(username
)
298 del self
.users
[username
]
300 def update_users_with_roles(self
, role
):
304 for _
, user
in self
.users
.items():
305 if role
in user
.roles
:
306 user
.refreshLastUpdate()
311 'users': {un
: u
.to_dict() for un
, u
in self
.users
.items()},
312 'roles': {rn
: r
.to_dict() for rn
, r
in self
.roles
.items()},
313 'version': self
.version
315 mgr
.set_store(self
.accessdb_config_key(), json
.dumps(db
))
318 def accessdb_config_key(cls
, version
=None):
320 version
= cls
.VERSION
321 return "{}{}".format(cls
.ACDB_CONFIG_KEY
, version
)
323 def check_and_update_db(self
):
324 logger
.debug("AC: Checking for previews DB versions")
325 if self
.VERSION
== 1: # current version
326 # check if there is username/password from previous version
327 username
= mgr
.get_module_option('username', None)
328 password
= mgr
.get_module_option('password', None)
329 if username
and password
:
330 logger
.debug("AC: Found single user credentials: user=%s",
332 # found user credentials
333 user
= self
.create_user(username
, "", None, None)
334 # password is already hashed, so setting manually
335 user
.password
= password
336 user
.add_roles([ADMIN_ROLE
])
339 raise NotImplementedError()
343 logger
.info("AC: Loading user roles DB version=%s", cls
.VERSION
)
345 json_db
= mgr
.get_store(cls
.accessdb_config_key())
347 logger
.debug("AC: No DB v%s found, creating new...", cls
.VERSION
)
348 db
= cls(cls
.VERSION
, {}, {})
349 # check if we can update from a previous version database
350 db
.check_and_update_db()
353 db
= json
.loads(json_db
)
354 roles
= {rn
: Role
.from_dict(r
)
355 for rn
, r
in db
.get('roles', {}).items()}
356 users
= {un
: User
.from_dict(u
, dict(roles
, **SYSTEM_ROLES
))
357 for un
, u
in db
.get('users', {}).items()}
358 return cls(db
['version'], users
, roles
)
361 def load_access_control_db():
362 mgr
.ACCESS_CTRL_DB
= AccessControlDB
.load()
365 # CLI dashboard access control scope commands
367 @CLIWriteCommand('dashboard set-login-credentials',
368 'name=username,type=CephString '
369 'name=password,type=CephString',
370 'Set the login credentials')
371 def set_login_credentials_cmd(_
, username
, password
):
373 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
374 user
.set_password(password
)
375 except UserDoesNotExist
:
376 user
= mgr
.ACCESS_CTRL_DB
.create_user(username
, password
, None, None)
377 user
.set_roles([ADMIN_ROLE
])
379 mgr
.ACCESS_CTRL_DB
.save()
382 ******************************************************************
383 *** WARNING: this command is deprecated. ***
384 *** Please use the ac-user-* related commands to manage users. ***
385 ******************************************************************
386 Username and password updated''', ''
389 @CLIReadCommand('dashboard ac-role-show',
390 'name=rolename,type=CephString,req=false',
392 def ac_role_show_cmd(_
, rolename
=None):
394 roles
= dict(mgr
.ACCESS_CTRL_DB
.roles
)
395 roles
.update(SYSTEM_ROLES
)
396 roles_list
= [name
for name
, _
in roles
.items()]
397 return 0, json
.dumps(roles_list
), ''
399 role
= mgr
.ACCESS_CTRL_DB
.get_role(rolename
)
400 except RoleDoesNotExist
as ex
:
401 if rolename
not in SYSTEM_ROLES
:
402 return -errno
.ENOENT
, '', str(ex
)
403 role
= SYSTEM_ROLES
[rolename
]
404 return 0, json
.dumps(role
.to_dict()), ''
407 @CLIWriteCommand('dashboard ac-role-create',
408 'name=rolename,type=CephString '
409 'name=description,type=CephString,req=false',
410 'Create a new access control role')
411 def ac_role_create_cmd(_
, rolename
, description
=None):
413 role
= mgr
.ACCESS_CTRL_DB
.create_role(rolename
, description
)
414 mgr
.ACCESS_CTRL_DB
.save()
415 return 0, json
.dumps(role
.to_dict()), ''
416 except RoleAlreadyExists
as ex
:
417 return -errno
.EEXIST
, '', str(ex
)
420 @CLIWriteCommand('dashboard ac-role-delete',
421 'name=rolename,type=CephString',
422 'Delete an access control role')
423 def ac_role_delete_cmd(_
, rolename
):
425 mgr
.ACCESS_CTRL_DB
.delete_role(rolename
)
426 mgr
.ACCESS_CTRL_DB
.save()
427 return 0, "Role '{}' deleted".format(rolename
), ""
428 except RoleDoesNotExist
as ex
:
429 if rolename
in SYSTEM_ROLES
:
430 return -errno
.EPERM
, '', "Cannot delete system role '{}'" \
432 return -errno
.ENOENT
, '', str(ex
)
433 except RoleIsAssociatedWithUser
as ex
:
434 return -errno
.EPERM
, '', str(ex
)
437 @CLIWriteCommand('dashboard ac-role-add-scope-perms',
438 'name=rolename,type=CephString '
439 'name=scopename,type=CephString '
440 'name=permissions,type=CephString,n=N',
441 'Add the scope permissions for a role')
442 def ac_role_add_scope_perms_cmd(_
, rolename
, scopename
, permissions
):
444 role
= mgr
.ACCESS_CTRL_DB
.get_role(rolename
)
445 perms_array
= [perm
.strip() for perm
in permissions
]
446 role
.set_scope_permissions(scopename
, perms_array
)
447 mgr
.ACCESS_CTRL_DB
.update_users_with_roles(role
)
448 mgr
.ACCESS_CTRL_DB
.save()
449 return 0, json
.dumps(role
.to_dict()), ''
450 except RoleDoesNotExist
as ex
:
451 if rolename
in SYSTEM_ROLES
:
452 return -errno
.EPERM
, '', "Cannot update system role '{}'" \
454 return -errno
.ENOENT
, '', str(ex
)
455 except ScopeNotValid
as ex
:
456 return -errno
.EINVAL
, '', str(ex
) + "\n Possible values: {}" \
457 .format(Scope
.all_scopes())
458 except PermissionNotValid
as ex
:
459 return -errno
.EINVAL
, '', str(ex
) + \
460 "\n Possible values: {}" \
461 .format(Permission
.all_permissions())
464 @CLIWriteCommand('dashboard ac-role-del-scope-perms',
465 'name=rolename,type=CephString '
466 'name=scopename,type=CephString',
467 'Delete the scope permissions for a role')
468 def ac_role_del_scope_perms_cmd(_
, rolename
, scopename
):
470 role
= mgr
.ACCESS_CTRL_DB
.get_role(rolename
)
471 role
.del_scope_permissions(scopename
)
472 mgr
.ACCESS_CTRL_DB
.update_users_with_roles(role
)
473 mgr
.ACCESS_CTRL_DB
.save()
474 return 0, json
.dumps(role
.to_dict()), ''
475 except RoleDoesNotExist
as ex
:
476 if rolename
in SYSTEM_ROLES
:
477 return -errno
.EPERM
, '', "Cannot update system role '{}'" \
479 return -errno
.ENOENT
, '', str(ex
)
480 except ScopeNotInRole
as ex
:
481 return -errno
.ENOENT
, '', str(ex
)
484 @CLIReadCommand('dashboard ac-user-show',
485 'name=username,type=CephString,req=false',
487 def ac_user_show_cmd(_
, username
=None):
489 users
= mgr
.ACCESS_CTRL_DB
.users
490 users_list
= [name
for name
, _
in users
.items()]
491 return 0, json
.dumps(users_list
), ''
493 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
494 return 0, json
.dumps(user
.to_dict()), ''
495 except UserDoesNotExist
as ex
:
496 return -errno
.ENOENT
, '', str(ex
)
499 @CLIWriteCommand('dashboard ac-user-create',
500 'name=username,type=CephString '
501 'name=password,type=CephString,req=false '
502 'name=rolename,type=CephString,req=false '
503 'name=name,type=CephString,req=false '
504 'name=email,type=CephString,req=false',
506 def ac_user_create_cmd(_
, username
, password
=None, rolename
=None, name
=None,
509 role
= mgr
.ACCESS_CTRL_DB
.get_role(rolename
) if rolename
else None
510 except RoleDoesNotExist
as ex
:
511 if rolename
not in SYSTEM_ROLES
:
512 return -errno
.ENOENT
, '', str(ex
)
513 role
= SYSTEM_ROLES
[rolename
]
516 user
= mgr
.ACCESS_CTRL_DB
.create_user(username
, password
, name
, email
)
517 except UserAlreadyExists
as ex
:
518 return -errno
.EEXIST
, '', str(ex
)
521 user
.set_roles([role
])
522 mgr
.ACCESS_CTRL_DB
.save()
523 return 0, json
.dumps(user
.to_dict()), ''
526 @CLIWriteCommand('dashboard ac-user-delete',
527 'name=username,type=CephString',
529 def ac_user_delete_cmd(_
, username
):
531 mgr
.ACCESS_CTRL_DB
.delete_user(username
)
532 mgr
.ACCESS_CTRL_DB
.save()
533 return 0, "User '{}' deleted".format(username
), ""
534 except UserDoesNotExist
as ex
:
535 return -errno
.ENOENT
, '', str(ex
)
538 @CLIWriteCommand('dashboard ac-user-set-roles',
539 'name=username,type=CephString '
540 'name=roles,type=CephString,n=N',
542 def ac_user_set_roles_cmd(_
, username
, roles
):
545 for rolename
in rolesname
:
547 roles
.append(mgr
.ACCESS_CTRL_DB
.get_role(rolename
))
548 except RoleDoesNotExist
as ex
:
549 if rolename
not in SYSTEM_ROLES
:
550 return -errno
.ENOENT
, '', str(ex
)
551 roles
.append(SYSTEM_ROLES
[rolename
])
553 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
554 user
.set_roles(roles
)
555 mgr
.ACCESS_CTRL_DB
.save()
556 return 0, json
.dumps(user
.to_dict()), ''
557 except UserDoesNotExist
as ex
:
558 return -errno
.ENOENT
, '', str(ex
)
561 @CLIWriteCommand('dashboard ac-user-add-roles',
562 'name=username,type=CephString '
563 'name=roles,type=CephString,n=N',
565 def ac_user_add_roles_cmd(_
, username
, roles
):
568 for rolename
in rolesname
:
570 roles
.append(mgr
.ACCESS_CTRL_DB
.get_role(rolename
))
571 except RoleDoesNotExist
as ex
:
572 if rolename
not in SYSTEM_ROLES
:
573 return -errno
.ENOENT
, '', str(ex
)
574 roles
.append(SYSTEM_ROLES
[rolename
])
576 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
577 user
.add_roles(roles
)
578 mgr
.ACCESS_CTRL_DB
.save()
579 return 0, json
.dumps(user
.to_dict()), ''
580 except UserDoesNotExist
as ex
:
581 return -errno
.ENOENT
, '', str(ex
)
584 @CLIWriteCommand('dashboard ac-user-del-roles',
585 'name=username,type=CephString '
586 'name=roles,type=CephString,n=N',
587 'Delete roles from user')
588 def ac_user_del_roles_cmd(_
, username
, roles
):
591 for rolename
in rolesname
:
593 roles
.append(mgr
.ACCESS_CTRL_DB
.get_role(rolename
))
594 except RoleDoesNotExist
as ex
:
595 if rolename
not in SYSTEM_ROLES
:
596 return -errno
.ENOENT
, '', str(ex
)
597 roles
.append(SYSTEM_ROLES
[rolename
])
599 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
600 user
.del_roles(roles
)
601 mgr
.ACCESS_CTRL_DB
.save()
602 return 0, json
.dumps(user
.to_dict()), ''
603 except UserDoesNotExist
as ex
:
604 return -errno
.ENOENT
, '', str(ex
)
605 except RoleNotInUser
as ex
:
606 return -errno
.ENOENT
, '', str(ex
)
609 @CLIWriteCommand('dashboard ac-user-set-password',
610 'name=username,type=CephString '
611 'name=password,type=CephString',
613 def ac_user_set_password(_
, username
, password
):
615 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
616 user
.set_password(password
)
618 mgr
.ACCESS_CTRL_DB
.save()
619 return 0, json
.dumps(user
.to_dict()), ''
620 except UserDoesNotExist
as ex
:
621 return -errno
.ENOENT
, '', str(ex
)
624 @CLIWriteCommand('dashboard ac-user-set-info',
625 'name=username,type=CephString '
626 'name=name,type=CephString '
627 'name=email,type=CephString',
629 def ac_user_set_info(_
, username
, name
, email
):
631 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
636 mgr
.ACCESS_CTRL_DB
.save()
637 return 0, json
.dumps(user
.to_dict()), ''
638 except UserDoesNotExist
as ex
:
639 return -errno
.ENOENT
, '', str(ex
)
642 class LocalAuthenticator(object):
644 load_access_control_db()
646 def get_user(self
, username
):
647 return mgr
.ACCESS_CTRL_DB
.get_user(username
)
649 def authenticate(self
, username
, password
):
651 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
653 pass_hash
= password_hash(password
, user
.password
)
654 if pass_hash
== user
.password
:
655 return user
.permissions_dict()
656 except UserDoesNotExist
:
657 logger
.debug("User '%s' does not exist", username
)
660 def authorize(self
, username
, scope
, permissions
):
661 user
= mgr
.ACCESS_CTRL_DB
.get_user(username
)
662 return user
.authorize(scope
, permissions
)