284 lines
9.4 KiB
Python
284 lines
9.4 KiB
Python
# Copyright 2017 AT&T Intellectual Property. All other rights reserved.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
#
|
|
import functools
|
|
import logging
|
|
|
|
import falcon
|
|
from oslo_config import cfg
|
|
from oslo_policy import policy
|
|
|
|
from shipyard_airflow.errors import ApiError, AppError
|
|
|
|
CONF = cfg.CONF
|
|
LOG = logging.getLogger(__name__)
|
|
policy_engine = None
|
|
|
|
|
|
class ShipyardPolicy(object):
|
|
"""
|
|
Initialize policy defaults
|
|
"""
|
|
|
|
RULE_ADMIN_REQUIRED = 'rule:admin_required'
|
|
RULE_DENY_ALL = 'rule:deny_all'
|
|
|
|
# Base Policy
|
|
base_rules = [
|
|
policy.RuleDefault(
|
|
'admin_required',
|
|
'role:admin',
|
|
description='Actions requiring admin authority'
|
|
),
|
|
policy.RuleDefault(
|
|
'deny_all',
|
|
'!',
|
|
description='Rule to deny all access. Used for default denial'
|
|
),
|
|
]
|
|
|
|
# Orchestrator Policy
|
|
task_rules = [
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:list_actions',
|
|
RULE_ADMIN_REQUIRED,
|
|
'List workflow actions invoked by users',
|
|
[{
|
|
'path': '/api/v1.0/actions',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:create_action',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Create a workflow action',
|
|
[{
|
|
'path': '/api/v1.0/actions',
|
|
'method': 'POST'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_action',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Retrieve an action by its id',
|
|
[{
|
|
'path': '/api/v1.0/actions/{action_id}',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_action_step',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Retrieve an action step by its id',
|
|
[{
|
|
'path': '/api/v1.0/actions/{action_id}/steps/{step_id}',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_action_step_logs',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Retrieve logs of an action step by its id',
|
|
[{
|
|
'path': '/api/v1.0/actions/{action_id}/steps/{step_id}/logs',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_action_validation',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Retrieve an action validation by its id',
|
|
[{
|
|
'path':
|
|
'/api/v1.0/actions/{action_id}/validations/{validation_id}',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:invoke_action_control',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Send a control to an action',
|
|
[{
|
|
'path': '/api/v1.0/actions/{action_id}/control/{control_verb}',
|
|
'method': 'POST'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_configdocs_status',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Retrieve the status of the configdocs',
|
|
[{
|
|
'path': '/api/v1.0/configdocs',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:create_configdocs',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Ingest configuration documents for the site design',
|
|
[{
|
|
'path': '/api/v1.0/configdocs/{collection_id}',
|
|
'method': 'POST'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_configdocs',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Retrieve a collection of configuration documents',
|
|
[{
|
|
'path': '/api/v1.0/configdocs/{collection_id}',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:commit_configdocs',
|
|
RULE_ADMIN_REQUIRED,
|
|
('Move documents from the Shipyard buffer to the committed '
|
|
'documents'),
|
|
[{
|
|
'path': '/api/v1.0/commitconfigdocs',
|
|
'method': 'POST'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_renderedconfigdocs',
|
|
RULE_ADMIN_REQUIRED,
|
|
('Retrieve the configuration documents rendered by Deckhand into '
|
|
'a complete design'),
|
|
[{
|
|
'path': '/api/v1.0/renderedconfigdocs',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:list_workflows',
|
|
RULE_ADMIN_REQUIRED,
|
|
('Retrieve the list of workflows (DAGs) that have been invoked '
|
|
'in Airflow, whether via Shipyard or scheduled'),
|
|
[{
|
|
'path': '/api/v1.0/workflows',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_workflow',
|
|
RULE_ADMIN_REQUIRED,
|
|
('Retrieve the detailed information for a workflow (DAG) from '
|
|
'Airflow'),
|
|
[{
|
|
'path': '/api/v1.0/workflows/{id}',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
policy.DocumentedRuleDefault(
|
|
'workflow_orchestrator:get_site_statuses',
|
|
RULE_ADMIN_REQUIRED,
|
|
'Retrieve the statuses for the site',
|
|
[{
|
|
'path': '/api/v1.0/site_statuses',
|
|
'method': 'GET'
|
|
}]
|
|
),
|
|
]
|
|
|
|
# Regions Policy
|
|
|
|
def __init__(self):
|
|
self.enforcer = policy.Enforcer(cfg.CONF)
|
|
|
|
def register_policy(self):
|
|
self.enforcer.register_defaults(ShipyardPolicy.base_rules)
|
|
self.enforcer.register_defaults(ShipyardPolicy.task_rules)
|
|
|
|
def authorize(self, action, ctx):
|
|
target = {'project_id': ctx.project_id, 'user_id': ctx.user_id}
|
|
return self.enforcer.authorize(action, target, ctx.to_policy_view())
|
|
|
|
|
|
class ApiEnforcer(object):
|
|
"""
|
|
A decorator class for enforcing RBAC policies
|
|
"""
|
|
|
|
def __init__(self, action):
|
|
self.action = action
|
|
self.logger = LOG
|
|
|
|
def __call__(self, f):
|
|
@functools.wraps(f)
|
|
def secure_handler(slf, req, resp, *args, **kwargs):
|
|
ctx = req.context
|
|
policy_eng = ctx.policy_engine
|
|
LOG.info("Policy Engine: %s", policy_eng.__class__.__name__)
|
|
# perform auth
|
|
LOG.info("Enforcing policy %s on request %s",
|
|
self.action, ctx.request_id)
|
|
# policy engine must be configured
|
|
if policy_eng is None:
|
|
LOG.error(
|
|
"Error-Policy engine required-action: %s", self.action)
|
|
raise AppError(
|
|
title="Auth is not being handled by any policy engine",
|
|
status=falcon.HTTP_500,
|
|
retry=False
|
|
)
|
|
authorized = False
|
|
try:
|
|
if policy_eng.authorize(self.action, ctx):
|
|
# authorized
|
|
LOG.info("Request is authorized")
|
|
authorized = True
|
|
except:
|
|
# couldn't service the auth request
|
|
LOG.exception(
|
|
"Error - Expectation Failed - action: %s", self.action)
|
|
raise ApiError(
|
|
title="Expectation Failed",
|
|
status=falcon.HTTP_417,
|
|
retry=False
|
|
)
|
|
if authorized:
|
|
return f(slf, req, resp, *args, **kwargs)
|
|
else:
|
|
LOG.error("Auth check failed. Authenticated:%s",
|
|
ctx.authenticated)
|
|
# raise the appropriate response exeception
|
|
if ctx.authenticated:
|
|
LOG.error("Error: Forbidden access - action: %s",
|
|
self.action)
|
|
raise ApiError(
|
|
title="Forbidden",
|
|
status=falcon.HTTP_403,
|
|
description="Credentials do not permit access",
|
|
retry=False
|
|
)
|
|
else:
|
|
LOG.error("Error - Unauthenticated access")
|
|
raise ApiError(
|
|
title="Unauthenticated",
|
|
status=falcon.HTTP_401,
|
|
description="Credentials are not established",
|
|
retry=False
|
|
)
|
|
|
|
return secure_handler
|
|
|
|
|
|
def list_policies():
|
|
default_policy = []
|
|
default_policy.extend(ShipyardPolicy.base_rules)
|
|
default_policy.extend(ShipyardPolicy.task_rules)
|
|
|
|
return default_policy
|