Skip to main content

Hello. I'm just an abstract object 📦 and I would be very glad to have user authorization because I hate criminals 🦹‍♂️ like pedophiles, robbers, hackers and so on.

Project description

django-object-checker

codecov

Hello. I'm just an abstract object 📦 and I would be very glad to have user authorization because I hate criminals 🦹‍♂️ like pedophiles, robbers, hackers and so on.

Introduction

Project django-object-checker extends standard django role base access control to be able to check individual object types.

Main purpose of this extended authorization system is to maintain control for each objects individually with modular solution.

Installation

# pip
pip install django-object-checker

# pipenv
pipenv install django-object-checker

# poetry
poetry add django-object-checker

Setup

Just add checkers module path to settings.OBJECT_CHECKERS_MODULE:

The path is path to the module, where you going to implement all your checkers. This is required for our BaseObjectChecker to be able to find his subclasses.

OBJECT_CHECKERS_MODULE = 'app.checkers'

Example

1. Create module according to specified path in settings

2. Create your own ObjectChecker class with checker method

Valid check methods are only these, which name starts with check_. So if you want to implement your custom methods which you want to be ignored by BaseObjectChecker your hands are free.

from django.contrib.auth.models import Group, User

from object_checker.base_object_checker import ObjectChecker


class MyObjectChecker(ObjectChecker):
    @staticmethod
    def check_my_object(role: Group, user: User, obj):
        result = False

        if role.name == 'manager':
            result = True

        return result

3. Add new object check class to module __init__.py

from app.checkers.my_object_checker import MyObjectChecker

4. Example usage of your custom object checker in your project

Method to check is has_object_permission and has three arguments:

  1. name of check method
  2. user object
  3. object/objects to be checked
from object_checker.base_object_checker import has_object_permission

if has_object_permission('check_my_object', user, my_object):
    print('User has access to this/these object/objects.')
else:
    print('User has NOT access to this/these object/objects.')

Made with ❤ by Adam Žúrek & BACKBONE s.r.o.

0.1.0 : 2020-09-23

  • Initial release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-object-checker-0.1.0.tar.gz (3.8 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page