# -*- 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.
"""Keycloak authorization Policy module."""
from ..exceptions import KeycloakAuthorizationConfigError
[docs]class Policy:
"""Base policy class.
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):
"""Init method."""
self.name = name
self.type = type
self.logic = logic
self.decision_strategy = decision_strategy
self.roles = []
self.permissions = []
[docs] def __repr__(self):
"""Repr method."""
return "<Policy: %s (%s)>" % (self.name, self.type)
[docs] def __str__(self):
"""Str method."""
return "Policy: %s (%s)" % (self.name, self.type)
@property
[docs] def name(self):
"""Get name."""
return self._name
@name.setter
def name(self, value):
self._name = value
@property
[docs] def type(self):
"""Get type."""
return self._type
@type.setter
def type(self, value):
self._type = value
@property
[docs] def logic(self):
"""Get logic."""
return self._logic
@logic.setter
def logic(self, value):
self._logic = value
@property
[docs] def decision_strategy(self):
"""Get decision strategy."""
return self._decision_strategy
@decision_strategy.setter
def decision_strategy(self, value):
self._decision_strategy = value
@property
[docs] def roles(self):
"""Get roles."""
return self._roles
@roles.setter
def roles(self, value):
self._roles = value
@property
[docs] def permissions(self):
"""Get permissions."""
return self._permissions
@permissions.setter
def permissions(self, value):
self._permissions = value
[docs] 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)
[docs] def add_permission(self, permission):
"""Add keycloak permission in policy.
:param permission: keycloak permission.
:return:
"""
self._permissions.append(permission)