forked from Mirror/python-keycloak
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
113 lines
3.6 KiB
113 lines
3.6 KiB
# -*- coding: utf-8 -*-
|
|
#
|
|
# The MIT License (MIT)
|
|
#
|
|
# Copyright (C) 2017 Marcos Pereira <marcospereira.mpj@gmail.com>
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
# this software and associated documentation files (the "Software"), to deal in
|
|
# the Software without restriction, including without limitation the rights to
|
|
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
# the Software, and to permit persons to whom the Software is furnished to do so,
|
|
# subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in all
|
|
# copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
from ..exceptions import KeycloakAuthorizationConfigError
|
|
|
|
|
|
class Policy:
|
|
"""
|
|
A policy defines the conditions that must be satisfied to grant access to an object.
|
|
Unlike permissions, you do not specify the object being protected but rather the conditions
|
|
that must be satisfied for access to a given object (for example, resource, scope, or both).
|
|
Policies are strongly related to the different access control mechanisms (ACMs) that you can use to
|
|
protect your resources. With policies, you can implement strategies for attribute-based access control
|
|
(ABAC), role-based access control (RBAC), context-based access control, or any combination of these.
|
|
|
|
https://keycloak.gitbooks.io/documentation/authorization_services/topics/policy/overview.html
|
|
|
|
"""
|
|
|
|
def __init__(self, name, type, logic, decision_strategy):
|
|
self._name = name
|
|
self._type = type
|
|
self._logic = logic
|
|
self._decision_strategy = decision_strategy
|
|
self._roles = []
|
|
self._permissions = []
|
|
|
|
def __repr__(self):
|
|
return "<Policy: %s (%s)>" % (self.name, self.type)
|
|
|
|
def __str__(self):
|
|
return "Policy: %s (%s)" % (self.name, self.type)
|
|
|
|
@property
|
|
def name(self):
|
|
return self._name
|
|
|
|
@name.setter
|
|
def name(self, value):
|
|
self._name = value
|
|
|
|
@property
|
|
def type(self):
|
|
return self._type
|
|
|
|
@type.setter
|
|
def type(self, value):
|
|
self._type = value
|
|
|
|
@property
|
|
def logic(self):
|
|
return self._logic
|
|
|
|
@logic.setter
|
|
def logic(self, value):
|
|
self._logic = value
|
|
|
|
@property
|
|
def decision_strategy(self):
|
|
return self._decision_strategy
|
|
|
|
@decision_strategy.setter
|
|
def decision_strategy(self, value):
|
|
self._decision_strategy = value
|
|
|
|
@property
|
|
def roles(self):
|
|
return self._roles
|
|
|
|
@property
|
|
def permissions(self):
|
|
return self._permissions
|
|
|
|
def add_role(self, role):
|
|
"""
|
|
Add keycloak role in policy.
|
|
|
|
:param role: keycloak role.
|
|
:return:
|
|
"""
|
|
if self.type != 'role':
|
|
raise KeycloakAuthorizationConfigError(
|
|
"Can't add role. Policy type is different of role")
|
|
self._roles.append(role)
|
|
|
|
def add_permission(self, permission):
|
|
"""
|
|
Add keycloak permission in policy.
|
|
|
|
:param permission: keycloak permission.
|
|
:return:
|
|
"""
|
|
self._permissions.append(permission)
|