tracim.lib.utils.auth.require_workspace_role() - Code Metrics - Inspection of "new authorization mecanism with decorators" - tracim/tracim_backend - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 68bc61...042191 )

unknown

created 2018-04-12 10:19 UTC

tracim.lib.utils.auth.require_workspace_role() A

↳ Parent: tracim.lib.utils.auth

Complexity

Conditions

Size

Total Lines	12
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	10
dl	0
loc	12
rs	9.4285
c	0
b	0
f	0
cc	2
nop	1

# -*- coding: utf-8 -*-
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
import typing

from pyramid.interfaces import IAuthorizationPolicy
from zope.interface import implementer

try:
    from json.decoder import JSONDecodeError
except ImportError:  # python3.4
    JSONDecodeError = ValueError
from sqlalchemy.orm.exc import NoResultFound

from pyramid.request import Request


from tracim.models.auth import User
from tracim.models.data import Workspace
from tracim.lib.core.user import UserApi
from tracim.lib.core.workspace import WorkspaceApi

from tracim.exceptions import NotAuthentificated
from tracim.exceptions import WorkspaceNotFound
from tracim.exceptions import InsufficientUserWorkspaceRole
BASIC_AUTH_WEBUI_REALM = "tracim"
TRACIM_DEFAULT_PERM = 'tracim'


def get_safe_user(
        request: Request,
) -> User:
    """
    Get current pyramid authenticated user from request
    :param request: pyramid request
    :return: current authenticated user
    """
    app_config = request.registry.settings['CFG']
    uapi = UserApi(None, session=request.dbsession, config=app_config)
    user = None
    try:
        login = request.authenticated_userid
        if not login:
            raise NotAuthentificated('not authenticated user_id,'
                                     'Failed Authentification ?')
        user = uapi.get_one_by_email(login)
    except NoResultFound:
        raise NotAuthentificated('User not found')
    return user


def get_workspace(user: User, request: Request) -> typing.Optional[Workspace]:
    """
    Get current workspace from request
    :param user: User who want to check the workspace
    :param request: pyramid request
    :return:
    """
    workspace_id = ''
    try:
        if 'workspace_id' not in request.json_body:
            return None
        workspace_id = request.json_body['workspace_id']
        wapi = WorkspaceApi(current_user=user, session=request.dbsession)
        workspace = wapi.get_one(workspace_id)
    except JSONDecodeError:
        raise WorkspaceNotFound('Bad json body')
    except NoResultFound:
        raise WorkspaceNotFound(
            'Workspace {} does not exist '
            'or is not visible for this user'.format(workspace_id)
        )
    return workspace

###
# BASIC AUTH
###


def basic_auth_check_credentials(
        login: str,
        cleartext_password: str,
        request: 'TracimRequest'
) -> typing.Optional[list]:
    """
    Check credential for pyramid basic_auth
    :param login: login of user
    :param cleartext_password: user password in cleartext
    :param request: Pyramid request
    :return: None if auth failed, list of permissions if auth succeed
    """

    # Do not accept invalid user
    user = _get_basic_auth_unsafe_user(request)
    if not user \
            or user.email != login \
            or not user.validate_password(cleartext_password):
        return None
    return []


def _get_basic_auth_unsafe_user(
    request: Request,

) -> typing.Optional[User]:
    """
    :param request: pyramid request
    :return: User or None
    """
    app_config = request.registry.settings['CFG']
    uapi = UserApi(None, session=request.dbsession, config=app_config)
    try:
        login = request.unauthenticated_userid
        if not login:
            return None
        user = uapi.get_one_by_email(login)
    except NoResultFound:
        return None
    return user

####


def require_workspace_role(minimal_required_role):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    def decorator(func):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""

        def wrapper(self, request: 'TracimRequest'):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
            user = request.current_user
            workspace = request.current_workspace
            if workspace.get_user_role(user) >= minimal_required_role:
                return func(self, request)
            raise InsufficientUserWorkspaceRole()

        return wrapper
    return decorator

###


@implementer(IAuthorizationPolicy)

class AcceptAllAuthorizationPolicy(object):
    """
    Simple AuthorizationPolicy to avoid trouble with pyramid.
    Acceot any request.
    """
    def permits(self, context, principals, permision):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        return True

    def principals_allowed_by_permission(self, context, permission):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        raise NotImplementedError()


1			# -- coding: utf-8 --
			0 ignored issues – show Coding Style introduced 2018-04-09 13:01 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2			import typing
3
4			from pyramid.interfaces import IAuthorizationPolicy
5			from zope.interface import implementer
6
7			try:
8			from json.decoder import JSONDecodeError
9			except ImportError: # python3.4
10			JSONDecodeError = ValueError
11			from sqlalchemy.orm.exc import NoResultFound
12
13			from pyramid.request import Request
			0 ignored issues – show introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report Imports from package pyramid are not grouped Loading history...
14
15			from tracim.models.auth import User
16			from tracim.models.data import Workspace
17			from tracim.lib.core.user import UserApi
18			from tracim.lib.core.workspace import WorkspaceApi
19
20			from tracim.exceptions import NotAuthentificated
21			from tracim.exceptions import WorkspaceNotFound
22			from tracim.exceptions import InsufficientUserWorkspaceRole
23			BASIC_AUTH_WEBUI_REALM = "tracim"
24			TRACIM_DEFAULT_PERM = 'tracim'
25
26
27			def get_safe_user(
28			request: Request,
29			) -> User:
30			"""
31			Get current pyramid authenticated user from request
32			:param request: pyramid request
33			:return: current authenticated user
34			"""
35			app_config = request.registry.settings['CFG']
36			uapi = UserApi(None, session=request.dbsession, config=app_config)
37			user = None
38			try:
39			login = request.authenticated_userid
40			if not login:
41			raise NotAuthentificated('not authenticated user_id,'
42			'Failed Authentification ?')
43			user = uapi.get_one_by_email(login)
44			except NoResultFound:
45			raise NotAuthentificated('User not found')
46			return user
47
48
49			def get_workspace(user: User, request: Request) -> typing.Optional[Workspace]:
50			"""
51			Get current workspace from request
52			:param user: User who want to check the workspace
53			:param request: pyramid request
54			:return:
55			"""
56			workspace_id = ''
57			try:
58			if 'workspace_id' not in request.json_body:
59			return None
60			workspace_id = request.json_body['workspace_id']
61			wapi = WorkspaceApi(current_user=user, session=request.dbsession)
62			workspace = wapi.get_one(workspace_id)
63			except JSONDecodeError:
64			raise WorkspaceNotFound('Bad json body')
65			except NoResultFound:
66			raise WorkspaceNotFound(
67			'Workspace {} does not exist '
68			'or is not visible for this user'.format(workspace_id)
69			)
70			return workspace
71
72			###
73			# BASIC AUTH
74			###
75
76
77			def basic_auth_check_credentials(
78			login: str,
79			cleartext_password: str,
80			request: 'TracimRequest'
81			) -> typing.Optional[list]:
82			"""
83			Check credential for pyramid basic_auth
84			:param login: login of user
85			:param cleartext_password: user password in cleartext
86			:param request: Pyramid request
87			:return: None if auth failed, list of permissions if auth succeed
88			"""
89
90			# Do not accept invalid user
91			user = _get_basic_auth_unsafe_user(request)
92			if not user \
93			or user.email != login \
94			or not user.validate_password(cleartext_password):
95			return None
96			return []
97
98
99			def _get_basic_auth_unsafe_user(
100			request: Request,
			0 ignored issues – show Coding Style introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report Wrong hanging indentation before block (add 4 spaces). Loading history...
101			) -> typing.Optional[User]:
102			"""
103			:param request: pyramid request
104			:return: User or None
105			"""
106			app_config = request.registry.settings['CFG']
107			uapi = UserApi(None, session=request.dbsession, config=app_config)
108			try:
109			login = request.unauthenticated_userid
110			if not login:
111			return None
112			user = uapi.get_one_by_email(login)
113			except NoResultFound:
114			return None
115			return user
116
117			####
118
119
120			def require_workspace_role(minimal_required_role):
			0 ignored issues – show Coding Style introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
121			def decorator(func):
			0 ignored issues – show Coding Style introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
122
123			def wrapper(self, request: 'TracimRequest'):
			0 ignored issues – show Coding Style introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report This function should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
124			user = request.current_user
125			workspace = request.current_workspace
126			if workspace.get_user_role(user) >= minimal_required_role:
127			return func(self, request)
128			raise InsufficientUserWorkspaceRole()
129
130			return wrapper
131			return decorator
132
133			###
134
135
136			@implementer(IAuthorizationPolicy)
			0 ignored issues – show Unused Code introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report The variable `__class__` seems to be unused. Loading history...
137			class AcceptAllAuthorizationPolicy(object):
138			"""
139			Simple AuthorizationPolicy to avoid trouble with pyramid.
140			Acceot any request.
141			"""
142			def permits(self, context, principals, permision):
			0 ignored issues – show Coding Style introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history... Unused Code introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report The argument `context` seems to be unused. Loading history... Unused Code introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report The argument `permision` seems to be unused. Loading history... Unused Code introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report The argument `principals` seems to be unused. Loading history... Coding Style introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report This method could be written as a function/class method. If a method does not access any attributes of the class, it could also be implemented as a function or static method. This can help improve readability. For example class Foo: def some_method(self, x, y): return x + y; could be written as class Foo: @classmethod def some_method(cls, x, y): return x + y; Loading history...
143			return True
144
145			def principals_allowed_by_permission(self, context, permission):
			0 ignored issues – show Coding Style Naming introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report The name `principals_allowed_by_permission` does not conform to the method naming conventions (`(([a-z][a-z0-9_]{2,30})\|(_[a-z0-9_]*))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history... Coding Style introduced 2018-04-12 10:22 UTC by Report Bug Copy Issue Report This method should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
146			raise NotImplementedError()
147

tracim / tracim_backend

Push — master ( 68bc61...042191 )

tracim.lib.utils.auth.require_workspace_role() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like