src/service/logic/Logic.cpp

   1 /*
   2  * Copyright (c) 2014-2015 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *    Licensed under the Apache License, Version 2.0 (the "License");
   5  *    you may not use this file except in compliance with the License.
   6  *    You may obtain a copy of the License at
   7  *
   8  *        http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  *    Unless required by applicable law or agreed to in writing, software
  11  *    distributed under the License is distributed on an "AS IS" BASIS,
  12  *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  *    See the License for the specific language governing permissions and
  14  *    limitations under the License.
  15  */
  16 /**
  17  * @file        src/service/logic/Logic.cpp
  18  * @author      Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
  19  * @author      Zofia Abramowska <z.abramowska@samsung.com>
  20  * @version     1.0
  21  * @brief       This file implements main class of logic layer in cynara service
  22  */
  23
  24 #include <csignal>
  25 #include <cinttypes>
  26 #include <functional>
  27 #include <memory>
  28 #include <vector>
  29
  30 #include <log/log.h>
  31 #include <common.h>
  32 #include <log/log.h>
  33 #include <exceptions/BucketNotExistsException.h>
  34 #include <exceptions/DatabaseException.h>
  35 #include <exceptions/DefaultBucketDeletionException.h>
  36 #include <exceptions/DefaultBucketSetNoneException.h>
  37 #include <exceptions/InvalidBucketIdException.h>
  38 #include <exceptions/PluginErrorException.h>
  39 #include <exceptions/PluginNotFoundException.h>
  40 #include <exceptions/UnexpectedErrorException.h>
  41 #include <exceptions/UnknownPolicyTypeException.h>
  42 #include <request/AdminCheckRequest.h>
  43 #include <request/AgentActionRequest.h>
  44 #include <request/AgentRegisterRequest.h>
  45 #include <request/CancelRequest.h>
  46 #include <request/CheckRequest.h>
  47 #include <request/DescriptionListRequest.h>
  48 #include <request/EraseRequest.h>
  49 #include <request/InsertOrUpdateBucketRequest.h>
  50 #include <request/ListRequest.h>
  51 #include <request/RemoveBucketRequest.h>
  52 #include <request/RequestContext.h>
  53 #include <request/SetPoliciesRequest.h>
  54 #include <request/SignalRequest.h>
  55 #include <request/SimpleCheckRequest.h>
  56 #include <response/AdminCheckResponse.h>
  57 #include <response/AgentRegisterResponse.h>
  58 #include <response/CancelResponse.h>
  59 #include <response/CheckResponse.h>
  60 #include <response/CodeResponse.h>
  61 #include <response/DescriptionListResponse.h>
  62 #include <response/ListResponse.h>
  63 #include <response/SimpleCheckResponse.h>
  64 #include <types/Policy.h>
  65
  66 #include <main/Cynara.h>
  67 #include <agent/AgentManager.h>
  68 #include <sockets/SocketManager.h>
  69 #include <storage/Storage.h>
  70
  71 #include <cynara-plugin.h>
  72
  73 #include <cynara-agent.h>
  74
  75 #include "Logic.h"
  76
  77 namespace Cynara {
  78
  79 Logic::Logic() {
  80 }
  81
  82 Logic::~Logic() {
  83 }
  84
  85 void Logic::execute(RequestContextPtr context UNUSED, SignalRequestPtr request) {
  86     LOGD("Processing signal: [%d]", request->signalNumber());
  87
  88     switch (request->signalNumber()) {
  89     case SIGTERM:
  90         LOGI("SIGTERM received!");
  91         m_socketManager->mainLoopStop();
  92         break;
  93     }
  94 }
  95
  96 void Logic::execute(RequestContextPtr context, AdminCheckRequestPtr request) {
  97     PolicyResult result;
  98     bool bucketValid = true;
  99     try {
 100         result = m_storage->checkPolicy(request->key(), request->startBucket(),
 101                                         request->recursive());
 102     } catch (const BucketNotExistsException &ex) {
 103         bucketValid = false;
 104     }
 105
 106     context->returnResponse(context, std::make_shared<AdminCheckResponse>(result, bucketValid,
 107                             request->sequenceNumber()));
 108 }
 109
 110 void Logic::execute(RequestContextPtr context, AgentActionRequestPtr request) {
 111     AgentTalkerPtr talkerPtr = m_agentManager->getTalker(context->responseQueue(),
 112                                                          request->sequenceNumber());
 113     if (!talkerPtr) {
 114         LOGD("Received response from agent with invalid request id: [%" PRIu16 "]",
 115              request->sequenceNumber());
 116         return;
 117     }
 118
 119     CheckContextPtr checkContextPtr = m_checkRequestManager.getContext(talkerPtr);
 120     if (!checkContextPtr) {
 121         LOGE("No matching check context for agent talker.");
 122         m_agentManager->removeTalker(talkerPtr);
 123         return;
 124     }
 125
 126     if (!checkContextPtr->cancelled()) {
 127         PluginData data(request->data().begin(), request->data().end());
 128         if (request->type() == CYNARA_MSG_TYPE_CANCEL) {
 129             // Nothing to do for now
 130         } else if (request->type() == CYNARA_MSG_TYPE_ACTION) {
 131             update(checkContextPtr->m_key, checkContextPtr->m_checkId, data,
 132                    checkContextPtr->m_requestContext, checkContextPtr->m_plugin);
 133         } else {
 134             LOGE("Invalid response type [%d] in response from agent <%s>",
 135                  static_cast<int>(request->type()), talkerPtr->agentType().c_str());
 136             // TODO: disconnect agent
 137         }
 138     }
 139
 140     m_agentManager->removeTalker(talkerPtr);
 141     m_checkRequestManager.removeRequest(checkContextPtr);
 142 }
 143
 144 void Logic::execute(RequestContextPtr context, AgentRegisterRequestPtr request) {
 145     auto result = m_agentManager->registerAgent(request->agentType(), context->responseQueue());
 146     context->returnResponse(context, std::make_shared<AgentRegisterResponse>(
 147                             result, request->sequenceNumber()));
 148 }
 149
 150 void Logic::execute(RequestContextPtr context, CancelRequestPtr request) {
 151     CheckContextPtr checkContextPtr = m_checkRequestManager.getContext(context->responseQueue(),
 152                                                                        request->sequenceNumber());
 153     if (!checkContextPtr) {
 154         LOGD("Cancel request id: [%" PRIu16 "] with no matching request in progress.",
 155              request->sequenceNumber());
 156         return;
 157     }
 158
 159     if (checkContextPtr->cancelled())
 160         return;
 161
 162     checkContextPtr->cancel();
 163     checkContextPtr->m_agentTalker->cancel();
 164
 165     LOGD("Returning response for cancel request id: [%" PRIu16 "].", request->sequenceNumber());
 166     context->returnResponse(context, std::make_shared<CancelResponse>(request->sequenceNumber()));
 167 }
 168
 169 void Logic::execute(RequestContextPtr context, CheckRequestPtr request) {
 170     PolicyResult result(PredefinedPolicyType::DENY);
 171     if (check(context, request->key(), request->sequenceNumber(), result)) {
 172         context->returnResponse(context, std::make_shared<CheckResponse>(result,
 173                                 request->sequenceNumber()));
 174     }
 175 }
 176
 177 bool Logic::check(const RequestContextPtr &context, const PolicyKey &key,
 178                   ProtocolFrameSequenceNumber checkId, PolicyResult &result) {
 179
 180     if (m_checkRequestManager.getContext(context->responseQueue(), checkId)) {
 181         LOGE("Check request for checkId: [%" PRIu16 "] is already processing", checkId);
 182         return false;
 183     }
 184
 185     result = m_storage->checkPolicy(key);
 186
 187     switch (result.policyType()) {
 188         case PredefinedPolicyType::ALLOW :
 189             LOGD("check of policy key <%s> returned ALLOW", key.toString().c_str());
 190             return true;
 191         case PredefinedPolicyType::DENY :
 192             LOGD("check of policy key <%s> returned DENY", key.toString().c_str());
 193             return true;
 194     }
 195
 196     return pluginCheck(context, key, checkId, result);
 197 }
 198
 199 bool Logic::pluginCheck(const RequestContextPtr &context, const PolicyKey &key,
 200                         ProtocolFrameSequenceNumber checkId, PolicyResult &result) {
 201
 202     LOGD("Trying to check policy: <%s> in plugin.", key.toString().c_str());
 203
 204     ExternalPluginPtr plugin = m_pluginManager->getPlugin(result.policyType());
 205     if (!plugin) {
 206         LOGE("Plugin not found for policy: [0x%x]", result.policyType());
 207         result = PolicyResult(PredefinedPolicyType::DENY);
 208         return true;
 209     }
 210
 211     ServicePluginInterfacePtr servicePlugin =
 212             std::dynamic_pointer_cast<ServicePluginInterface>(plugin);
 213     if (!servicePlugin) {
 214         result = PolicyResult(PredefinedPolicyType::DENY);
 215         return true;
 216     }
 217
 218     AgentType requiredAgent;
 219     PluginData pluginData;
 220
 221     auto ret = servicePlugin->check(key.client().toString(), key.user().toString(),
 222                                     key.privilege().toString(), result, requiredAgent, pluginData);
 223
 224     switch (ret) {
 225         case ServicePluginInterface::PluginStatus::ANSWER_READY:
 226             return true;
 227         case ServicePluginInterface::PluginStatus::ANSWER_NOTREADY: {
 228                 result = PolicyResult(PredefinedPolicyType::DENY);
 229                 AgentTalkerPtr agentTalker = m_agentManager->createTalker(requiredAgent);
 230                 if (!agentTalker) {
 231                     LOGE("Required agent talker for: <%s> could not be created.",
 232                          requiredAgent.c_str());
 233                     return true;
 234                 }
 235
 236                 if (!m_checkRequestManager.createContext(key, context, checkId, servicePlugin,
 237                                                          agentTalker)) {
 238                     LOGE("Check context for checkId: [%" PRIu16 "] could not be created.",
 239                          checkId);
 240                     m_agentManager->removeTalker(agentTalker);
 241                     return true;
 242                 }
 243                 agentTalker->send(pluginData);
 244             }
 245             return false;
 246         default:
 247             result = PolicyResult(PredefinedPolicyType::DENY);
 248             return true;
 249     }
 250 }
 251
 252 bool Logic::update(const PolicyKey &key, ProtocolFrameSequenceNumber checkId,
 253                    const PluginData &agentData, const RequestContextPtr &context,
 254                    const ServicePluginInterfacePtr &plugin) {
 255
 256     LOGD("Check update: <%s>:[%" PRIu16 "]", key.toString().c_str(), checkId);
 257
 258     PolicyResult result;
 259     bool answerReady = false;
 260     auto ret = plugin->update(key.client().toString(), key.user().toString(),
 261                               key.privilege().toString(), agentData, result);
 262     switch (ret) {
 263         case ServicePluginInterface::PluginStatus::SUCCESS:
 264             answerReady = true;
 265             break;
 266         case ServicePluginInterface::PluginStatus::ERROR:
 267             result = PolicyResult(PredefinedPolicyType::DENY);
 268             answerReady = true;
 269             break;
 270         default:
 271             throw PluginErrorException(key);
 272     }
 273
 274     if (answerReady && context->responseQueue()) {
 275         context->returnResponse(context, std::make_shared<CheckResponse>(result, checkId));
 276         return true;
 277     }
 278
 279     return false;
 280 }
 281
 282 void Logic::execute(RequestContextPtr context, DescriptionListRequestPtr request) {
 283     auto descriptions = m_pluginManager->getPolicyDescriptions();
 284     descriptions.insert(descriptions.begin(), predefinedPolicyDescr.begin(),
 285                         predefinedPolicyDescr.end());
 286     context->returnResponse(context, std::make_shared<DescriptionListResponse>(descriptions,
 287                             request->sequenceNumber()));
 288 }
 289
 290 void Logic::execute(RequestContextPtr context, EraseRequestPtr request) {
 291     auto code = CodeResponse::Code::OK;
 292
 293     try {
 294         m_storage->erasePolicies(request->startBucket(), request->recursive(), request->filter());
 295         onPoliciesChanged();
 296     } catch (const DatabaseException &ex) {
 297         code = CodeResponse::Code::FAILED;
 298     } catch (const BucketNotExistsException &ex) {
 299         code = CodeResponse::Code::NO_BUCKET;
 300     }
 301
 302     context->returnResponse(context, std::make_shared<CodeResponse>(code,
 303                             request->sequenceNumber()));
 304 }
 305
 306 void Logic::execute(RequestContextPtr context, InsertOrUpdateBucketRequestPtr request) {
 307     auto code = CodeResponse::Code::OK;
 308
 309     try {
 310         checkSinglePolicyType(request->result().policyType(), true, true);
 311         m_storage->addOrUpdateBucket(request->bucketId(), request->result());
 312         onPoliciesChanged();
 313     } catch (const DatabaseException &ex) {
 314         code = CodeResponse::Code::FAILED;
 315     } catch (const DefaultBucketSetNoneException &ex) {
 316         code = CodeResponse::Code::NOT_ALLOWED;
 317     } catch (const InvalidBucketIdException &ex) {
 318         code = CodeResponse::Code::NOT_ALLOWED;
 319     } catch (const UnknownPolicyTypeException &ex) {
 320         code = CodeResponse::Code::NO_POLICY_TYPE;
 321     }
 322
 323     context->returnResponse(context, std::make_shared<CodeResponse>(code,
 324                             request->sequenceNumber()));
 325 }
 326
 327 void Logic::execute(RequestContextPtr context, ListRequestPtr request) {
 328     bool bucketValid = true;
 329
 330     std::vector<Policy> policies;
 331     try {
 332         policies = m_storage->listPolicies(request->bucket(), request->filter());
 333     } catch (const BucketNotExistsException &ex) {
 334         bucketValid = false;
 335     }
 336
 337     context->returnResponse(context, std::make_shared<ListResponse>(policies, bucketValid,
 338                             request->sequenceNumber()));
 339 }
 340
 341 void Logic::execute(RequestContextPtr context, RemoveBucketRequestPtr request) {
 342     auto code = CodeResponse::Code::OK;
 343     try {
 344         m_storage->deleteBucket(request->bucketId());
 345         onPoliciesChanged();
 346     } catch (const DatabaseException &ex) {
 347         code = CodeResponse::Code::FAILED;
 348     } catch (const BucketNotExistsException &ex) {
 349         code = CodeResponse::Code::NO_BUCKET;
 350     } catch (const DefaultBucketDeletionException &ex) {
 351         code = CodeResponse::Code::NOT_ALLOWED;
 352     }
 353     context->returnResponse(context, std::make_shared<CodeResponse>(code,
 354                             request->sequenceNumber()));
 355 }
 356
 357 void Logic::execute(RequestContextPtr context, SetPoliciesRequestPtr request) {
 358     auto code = CodeResponse::Code::OK;
 359     try {
 360         checkPoliciesTypes(request->policiesToBeInsertedOrUpdated(), true, false);
 361         m_storage->insertPolicies(request->policiesToBeInsertedOrUpdated());
 362         m_storage->deletePolicies(request->policiesToBeRemoved());
 363         onPoliciesChanged();
 364     } catch (const DatabaseException &ex) {
 365         code = CodeResponse::Code::FAILED;
 366     } catch (const BucketNotExistsException &ex) {
 367         code = CodeResponse::Code::NO_BUCKET;
 368     } catch (const UnknownPolicyTypeException &ex) {
 369         code = CodeResponse::Code::NO_POLICY_TYPE;
 370     }
 371     context->returnResponse(context, std::make_shared<CodeResponse>(code,
 372                             request->sequenceNumber()));
 373 }
 374
 375 void Logic::execute(RequestContextPtr context, SimpleCheckRequestPtr request) {
 376     int retValue = CYNARA_API_SUCCESS;
 377     PolicyResult result;
 378     PolicyKey key = request->key();
 379     result = m_storage->checkPolicy(key);
 380
 381     switch (result.policyType()) {
 382     case PredefinedPolicyType::ALLOW:
 383         LOGD("simple check of policy key <%s> returned ALLOW", key.toString().c_str());
 384         break;
 385     case PredefinedPolicyType::DENY:
 386         LOGD("simple check of policy key <%s> returned DENY", key.toString().c_str());
 387         break;
 388     default: {
 389         ExternalPluginPtr plugin = m_pluginManager->getPlugin(result.policyType());
 390         if (!plugin) {
 391             LOGE("Plugin not found for policy: [0x%x]", result.policyType());
 392             result = PolicyResult(PredefinedPolicyType::DENY);
 393             retValue = CYNARA_API_SUCCESS;
 394             break;
 395         }
 396
 397         ServicePluginInterfacePtr servicePlugin =
 398                 std::dynamic_pointer_cast<ServicePluginInterface>(plugin);
 399         if (!servicePlugin) {
 400             LOGE("Couldn't cast plugin pointer to ServicePluginInterface");
 401             result = PolicyResult(PredefinedPolicyType::DENY);
 402             retValue = CYNARA_API_SUCCESS;
 403             break;
 404         }
 405
 406         AgentType requiredAgent;
 407         PluginData pluginData;
 408         auto ret = servicePlugin->check(key.client().toString(), key.user().toString(),
 409                                         key.privilege().toString(), result, requiredAgent,
 410                                         pluginData);
 411         switch (ret) {
 412         case ServicePluginInterface::PluginStatus::ANSWER_READY:
 413             LOGD("simple check of policy key <%s> in plugin returned [" PRIu16 "]",
 414                  key.toString().c_str(), result.policyType());
 415             break;
 416         case ServicePluginInterface::PluginStatus::ANSWER_NOTREADY:
 417             retValue = CYNARA_API_ACCESS_NOT_RESOLVED;
 418             break;
 419         default:
 420             result = PolicyResult(PredefinedPolicyType::DENY);
 421             retValue = CYNARA_API_SUCCESS;
 422         }
 423     }
 424     }
 425     context->returnResponse(context, std::make_shared<SimpleCheckResponse>(retValue, result,
 426                                                                   request->sequenceNumber()));
 427 }
 428
 429 void Logic::checkPoliciesTypes(const std::map<PolicyBucketId, std::vector<Policy>> &policies,
 430                                bool allowBucket, bool allowNone) {
 431     for (const auto &group : policies) {
 432         for (const auto &policy : group.second) {
 433             checkSinglePolicyType(policy.result().policyType(), allowBucket, allowNone);
 434         }
 435     }
 436 }
 437
 438 void Logic::checkSinglePolicyType(const PolicyType &policyType, bool allowBucket, bool allowNone) {
 439     if (allowBucket && policyType == PredefinedPolicyType::BUCKET)
 440         return;
 441     if (allowNone && policyType == PredefinedPolicyType::NONE)
 442         return;
 443     for (const auto &descr : predefinedPolicyDescr) {
 444         if (descr.type == policyType)
 445             return;
 446     }
 447     m_pluginManager->checkPolicyType(policyType);
 448 }
 449
 450 void Logic::contextClosed(RequestContextPtr context) {
 451     LOGD("context closed");
 452
 453     LinkId linkId = context->responseQueue();
 454
 455     m_agentManager->cleanupAgent(linkId, [&](const AgentTalkerPtr &talker) -> void {
 456                                  handleAgentTalkerDisconnection(talker); });
 457
 458     m_checkRequestManager.cancelRequests(linkId,
 459                                          [&](const CheckContextPtr &checkContextPtr) -> void {
 460                                          handleClientDisconnection(checkContextPtr); });
 461 }
 462
 463 void Logic::onPoliciesChanged(void) {
 464     m_storage->save();
 465     m_socketManager->disconnectAllClients();
 466     m_pluginManager->invalidateAll();
 467     //todo remove all saved contexts (if there will be any saved contexts)
 468 }
 469
 470 void Logic::handleAgentTalkerDisconnection(const AgentTalkerPtr &agentTalkerPtr) {
 471     CheckContextPtr checkContextPtr = m_checkRequestManager.getContext(agentTalkerPtr);
 472     if (checkContextPtr == nullptr) {
 473         LOGE("No matching check context for agent talker.");
 474         return;
 475     }
 476
 477     if (!checkContextPtr->cancelled() && checkContextPtr->m_requestContext->responseQueue()) {
 478         PolicyResult result(PredefinedPolicyType::DENY);
 479         checkContextPtr->m_requestContext->returnResponse(checkContextPtr->m_requestContext,
 480                 std::make_shared<CheckResponse>(result, checkContextPtr->m_checkId));
 481     }
 482
 483     m_checkRequestManager.removeRequest(checkContextPtr);
 484 }
 485
 486 void Logic::handleClientDisconnection(const CheckContextPtr &checkContextPtr) {
 487     LOGD("Handle client disconnection");
 488
 489     if (!checkContextPtr->cancelled()) {
 490         checkContextPtr->cancel();
 491         checkContextPtr->m_agentTalker->cancel();
 492     }
 493 }
 494
 495 } // namespace Cynara