aboutsummaryrefslogtreecommitdiffstats
path: root/moon_manager/moon_manager/api/meta_rules.py
blob: 738aad71a153bb7161fb5e56b8b73949a1c649bc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
# Copyright 2015 Open Platform for NFV Project, Inc. and its contributors
# This software is distributed under the terms and conditions of the 'Apache-2.0'
# license which can be found in the file 'LICENSE' in this package distribution
# or at 'http://www.apache.org/licenses/LICENSE-2.0'.
"""
Meta rules are skeleton for security policies

"""

from flask import request
from flask_restful import Resource
import logging
from python_moonutilities.security_functions import check_auth
from python_moondb.core import ModelManager
from python_moonutilities.security_functions import validate_input

__version__ = "4.3.2"

logger = logging.getLogger("moon.manager.api." + __name__)


class MetaRules(Resource):
    """
    Endpoint for meta rules requests
    """

    __urls__ = (
        "/meta_rules",
        "/meta_rules/",
        "/meta_rules/<string:meta_rule_id>",
        "/meta_rules/<string:meta_rule_id>/"
    )

    @validate_input("get", kwargs_state=[False, False])
    @check_auth
    def get(self, meta_rule_id=None, user_id=None):
        """Retrieve all sub meta rules

        :param meta_rule_id: Meta rule algorithm ID
        :param user_id: user ID who do the request
        :return: {
            "meta_rules": {
                "meta_rule_id1": {
                    "name": "name of the meta rule",
                    "subject_categories": ["subject_category_id1",
                                           "subject_category_id2"],
                    "object_categories": ["object_category_id1"],
                    "action_categories": ["action_category_id1"]
                },
            }
        }
        :internal_api: get_meta_rules
        """

        data = ModelManager.get_meta_rules(
            user_id=user_id, meta_rule_id=meta_rule_id)

        return {"meta_rules": data}

    @validate_input("post", body_state={"name": True, "subject_categories": False,
                                        "object_categories": False, "action_categories": False})
    @check_auth
    def post(self, meta_rule_id=None, user_id=None):
        """Add a meta rule

        :param meta_rule_id: Meta rule ID (not used here)
        :param user_id: user ID who do the request
        :request body: post = {
            "name": "name of the meta rule (mandatory)",
            "subject_categories": ["subject_category_id1 (mandatory)",
                                   "subject_category_id2"],
            "object_categories": ["object_category_id1 (mandatory)"],
            "action_categories": ["action_category_id1 (mandatory)"]
        }
        :return: {
            "meta_rules": {
                "meta_rule_id1": {
                    "name": "name of the meta rule",
                    "subject_categories": ["subject_category_id1",
                                           "subject_category_id2"],
                    "object_categories": ["object_category_id1"],
                    "action_categories": ["action_category_id1"]
                },
            }
        }
        :internal_api: add_meta_rules
        """

        data = ModelManager.add_meta_rule(
            user_id=user_id, meta_rule_id=None, value=request.json)

        return {"meta_rules": data}

    @validate_input("patch", kwargs_state=[True, False],
                    body_state={"name": True, "subject_categories": False,
                                "object_categories": False, "action_categories": False})
    @check_auth
    def patch(self, meta_rule_id=None, user_id=None):
        """Update a meta rule

        :param meta_rule_id: Meta rule ID
        :param user_id: user ID who do the request
        :request body: patch = {
            "name": "name of the meta rule",
            "subject_categories": ["subject_category_id1",
                                   "subject_category_id2"],
            "object_categories": ["object_category_id1"],
            "action_categories": ["action_category_id1"]
        }
        :return: {
            "meta_rules": {
                "meta_rule_id1": {
                    "name": "name of the meta rule",
                    "subject_categories": ["subject_category_id1",
                                           "subject_category_id2"],
                    "object_categories": ["object_category_id1"],
                    "action_categories": ["action_category_id1"]
                },
            }
        }
        :internal_api: set_meta_rules
        """
        data = ModelManager.update_meta_rule(
            user_id=user_id, meta_rule_id=meta_rule_id, value=request.json)

        return {"meta_rules": data}

    @validate_input("delete", kwargs_state=[True, False])
    @check_auth
    def delete(self, meta_rule_id=None, user_id=None):
        """Delete a meta rule

        :param meta_rule_id: Meta rule ID
        :param user_id: user ID who do the request
        :return: {
            "meta_rules": {
                "meta_rule_id1": {
                    "name": "name of the meta rule",
                    "subject_categories": ["subject_category_id1",
                                           "subject_category_id2"],
                    "object_categories": ["object_category_id1"],
                    "action_categories": ["action_category_id1"]
                },
            }
        }
        :internal_api: delete_meta_rules
        """

        data = ModelManager.delete_meta_rule(
            user_id=user_id, meta_rule_id=meta_rule_id)

        return {"result": True}