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 (!plugin) {
 214         throw PluginNotFoundException(result);
 215     }
 216
 217     AgentType requiredAgent;
 218     PluginData pluginData;
 219
 220     auto ret = servicePlugin->check(key.client().toString(), key.user().toString(),
 221                                     key.privilege().toString(), result, requiredAgent, pluginData);
 222
 223     switch (ret) {
 224         case ServicePluginInterface::PluginStatus::ANSWER_READY:
 225             return true;
 226         case ServicePluginInterface::PluginStatus::ANSWER_NOTREADY: {
 227                 result = PolicyResult(PredefinedPolicyType::DENY);
 228                 AgentTalkerPtr agentTalker = m_agentManager->createTalker(requiredAgent);
 229                 if (!agentTalker) {
 230                     LOGE("Required agent talker for: <%s> could not be created.",
 231                          requiredAgent.c_str());
 232                     return true;
 233                 }
 234
 235                 if (!m_checkRequestManager.createContext(key, context, checkId, servicePlugin,
 236                                                          agentTalker)) {
 237                     LOGE("Check context for checkId: [%" PRIu16 "] could not be created.",
 238                          checkId);
 239                     m_agentManager->removeTalker(agentTalker);
 240                     return true;
 241                 }
 242                 agentTalker->send(pluginData);
 243             }
 244             return false;
 245         default:
 246             throw PluginErrorException(key); // This 'throw' should be removed or handled properly.
 247     }
 248 }
 249
 250 bool Logic::update(const PolicyKey &key, ProtocolFrameSequenceNumber checkId,
 251                    const PluginData &agentData, const RequestContextPtr &context,
 252                    const ServicePluginInterfacePtr &plugin) {
 253
 254     LOGD("Check update: <%s>:[%" PRIu16 "]", key.toString().c_str(), checkId);
 255
 256     PolicyResult result;
 257     bool answerReady = false;
 258     auto ret = plugin->update(key.client().toString(), key.user().toString(),
 259                               key.privilege().toString(), agentData, result);
 260     switch (ret) {
 261         case ServicePluginInterface::PluginStatus::SUCCESS:
 262             answerReady = true;
 263             break;
 264         case ServicePluginInterface::PluginStatus::ERROR:
 265             result = PolicyResult(PredefinedPolicyType::DENY);
 266             answerReady = true;
 267             break;
 268         default:
 269             throw PluginErrorException(key);
 270     }
 271
 272     if (answerReady && context->responseQueue()) {
 273         context->returnResponse(context, std::make_shared<CheckResponse>(result, checkId));
 274         return true;
 275     }
 276
 277     return false;
 278 }
 279
 280 void Logic::execute(RequestContextPtr context, DescriptionListRequestPtr request) {
 281     auto descriptions = m_pluginManager->getPolicyDescriptions();
 282     descriptions.insert(descriptions.begin(), predefinedPolicyDescr.begin(),
 283                         predefinedPolicyDescr.end());
 284     context->returnResponse(context, std::make_shared<DescriptionListResponse>(descriptions,
 285                             request->sequenceNumber()));
 286 }
 287
 288 void Logic::execute(RequestContextPtr context, EraseRequestPtr request) {
 289     auto code = CodeResponse::Code::OK;
 290
 291     try {
 292         m_storage->erasePolicies(request->startBucket(), request->recursive(), request->filter());
 293         onPoliciesChanged();
 294     } catch (const DatabaseException &ex) {
 295         code = CodeResponse::Code::FAILED;
 296     } catch (const BucketNotExistsException &ex) {
 297         code = CodeResponse::Code::NO_BUCKET;
 298     }
 299
 300     context->returnResponse(context, std::make_shared<CodeResponse>(code,
 301                             request->sequenceNumber()));
 302 }
 303
 304 void Logic::execute(RequestContextPtr context, InsertOrUpdateBucketRequestPtr request) {
 305     auto code = CodeResponse::Code::OK;
 306
 307     try {
 308         checkSinglePolicyType(request->result().policyType(), true, true);
 309         m_storage->addOrUpdateBucket(request->bucketId(), request->result());
 310         onPoliciesChanged();
 311     } catch (const DatabaseException &ex) {
 312         code = CodeResponse::Code::FAILED;
 313     } catch (const DefaultBucketSetNoneException &ex) {
 314         code = CodeResponse::Code::NOT_ALLOWED;
 315     } catch (const InvalidBucketIdException &ex) {
 316         code = CodeResponse::Code::NOT_ALLOWED;
 317     } catch (const UnknownPolicyTypeException &ex) {
 318         code = CodeResponse::Code::NO_POLICY_TYPE;
 319     }
 320
 321     context->returnResponse(context, std::make_shared<CodeResponse>(code,
 322                             request->sequenceNumber()));
 323 }
 324
 325 void Logic::execute(RequestContextPtr context, ListRequestPtr request) {
 326     bool bucketValid = true;
 327
 328     std::vector<Policy> policies;
 329     try {
 330         policies = m_storage->listPolicies(request->bucket(), request->filter());
 331     } catch (const BucketNotExistsException &ex) {
 332         bucketValid = false;
 333     }
 334
 335     context->returnResponse(context, std::make_shared<ListResponse>(policies, bucketValid,
 336                             request->sequenceNumber()));
 337 }
 338
 339 void Logic::execute(RequestContextPtr context, RemoveBucketRequestPtr request) {
 340     auto code = CodeResponse::Code::OK;
 341     try {
 342         m_storage->deleteBucket(request->bucketId());
 343         onPoliciesChanged();
 344     } catch (const DatabaseException &ex) {
 345         code = CodeResponse::Code::FAILED;
 346     } catch (const BucketNotExistsException &ex) {
 347         code = CodeResponse::Code::NO_BUCKET;
 348     } catch (const DefaultBucketDeletionException &ex) {
 349         code = CodeResponse::Code::NOT_ALLOWED;
 350     }
 351     context->returnResponse(context, std::make_shared<CodeResponse>(code,
 352                             request->sequenceNumber()));
 353 }
 354
 355 void Logic::execute(RequestContextPtr context, SetPoliciesRequestPtr request) {
 356     auto code = CodeResponse::Code::OK;
 357     try {
 358         checkPoliciesTypes(request->policiesToBeInsertedOrUpdated(), true, false);
 359         m_storage->insertPolicies(request->policiesToBeInsertedOrUpdated());
 360         m_storage->deletePolicies(request->policiesToBeRemoved());
 361         onPoliciesChanged();
 362     } catch (const DatabaseException &ex) {
 363         code = CodeResponse::Code::FAILED;
 364     } catch (const BucketNotExistsException &ex) {
 365         code = CodeResponse::Code::NO_BUCKET;
 366     } catch (const UnknownPolicyTypeException &ex) {
 367         code = CodeResponse::Code::NO_POLICY_TYPE;
 368     }
 369     context->returnResponse(context, std::make_shared<CodeResponse>(code,
 370                             request->sequenceNumber()));
 371 }
 372
 373 void Logic::execute(RequestContextPtr context, SimpleCheckRequestPtr request) {
 374     int retValue = CYNARA_API_SUCCESS;
 375     PolicyResult result;
 376     PolicyKey key = request->key();
 377     result = m_storage->checkPolicy(key);
 378
 379     switch (result.policyType()) {
 380     case PredefinedPolicyType::ALLOW:
 381         LOGD("simple check of policy key <%s> returned ALLOW", key.toString().c_str());
 382         break;
 383     case PredefinedPolicyType::DENY:
 384         LOGD("simple check of policy key <%s> returned DENY", key.toString().c_str());
 385         break;
 386     default: {
 387         ExternalPluginPtr plugin = m_pluginManager->getPlugin(result.policyType());
 388         if (!plugin) {
 389             LOGE("Plugin not found for policy: [0x%x]", result.policyType());
 390             result = PolicyResult(PredefinedPolicyType::DENY);
 391             retValue = CYNARA_API_SUCCESS;
 392             break;
 393         }
 394
 395         ServicePluginInterfacePtr servicePlugin =
 396                 std::dynamic_pointer_cast<ServicePluginInterface>(plugin);
 397         if (!servicePlugin) {
 398             LOGE("Couldn't cast plugin pointer to ServicePluginInterface");
 399             result = PolicyResult(PredefinedPolicyType::DENY);
 400             retValue = CYNARA_API_SUCCESS;
 401             break;
 402         }
 403
 404         AgentType requiredAgent;
 405         PluginData pluginData;
 406         auto ret = servicePlugin->check(key.client().toString(), key.user().toString(),
 407                                         key.privilege().toString(), result, requiredAgent,
 408                                         pluginData);
 409         switch (ret) {
 410         case ServicePluginInterface::PluginStatus::ANSWER_READY:
 411             LOGD("simple check of policy key <%s> in plugin returned [" PRIu16 "]",
 412                  key.toString().c_str(), result.policyType());
 413             break;
 414         case ServicePluginInterface::PluginStatus::ANSWER_NOTREADY:
 415             retValue = CYNARA_API_ACCESS_NOT_RESOLVED;
 416             break;
 417         default:
 418             result = PolicyResult(PredefinedPolicyType::DENY);
 419             retValue = CYNARA_API_SUCCESS;
 420         }
 421     }
 422     }
 423     context->returnResponse(context, std::make_shared<SimpleCheckResponse>(retValue, result,
 424                                                                   request->sequenceNumber()));
 425 }
 426
 427 void Logic::checkPoliciesTypes(const std::map<PolicyBucketId, std::vector<Policy>> &policies,
 428                                bool allowBucket, bool allowNone) {
 429     for (const auto &group : policies) {
 430         for (const auto &policy : group.second) {
 431             checkSinglePolicyType(policy.result().policyType(), allowBucket, allowNone);
 432         }
 433     }
 434 }
 435
 436 void Logic::checkSinglePolicyType(const PolicyType &policyType, bool allowBucket, bool allowNone) {
 437     if (allowBucket && policyType == PredefinedPolicyType::BUCKET)
 438         return;
 439     if (allowNone && policyType == PredefinedPolicyType::NONE)
 440         return;
 441     for (const auto &descr : predefinedPolicyDescr) {
 442         if (descr.type == policyType)
 443             return;
 444     }
 445     m_pluginManager->checkPolicyType(policyType);
 446 }
 447
 448 void Logic::contextClosed(RequestContextPtr context) {
 449     LOGD("context closed");
 450
 451     LinkId linkId = context->responseQueue();
 452
 453     m_agentManager->cleanupAgent(linkId, [&](const AgentTalkerPtr &talker) -> void {
 454                                  handleAgentTalkerDisconnection(talker); });
 455
 456     m_checkRequestManager.cancelRequests(linkId,
 457                                          [&](const CheckContextPtr &checkContextPtr) -> void {
 458                                          handleClientDisconnection(checkContextPtr); });
 459 }
 460
 461 void Logic::onPoliciesChanged(void) {
 462     m_storage->save();
 463     m_socketManager->disconnectAllClients();
 464     m_pluginManager->invalidateAll();
 465     //todo remove all saved contexts (if there will be any saved contexts)
 466 }
 467
 468 void Logic::handleAgentTalkerDisconnection(const AgentTalkerPtr &agentTalkerPtr) {
 469     CheckContextPtr checkContextPtr = m_checkRequestManager.getContext(agentTalkerPtr);
 470     if (checkContextPtr == nullptr) {
 471         LOGE("No matching check context for agent talker.");
 472         return;
 473     }
 474
 475     if (!checkContextPtr->cancelled() && checkContextPtr->m_requestContext->responseQueue()) {
 476         PolicyResult result(PredefinedPolicyType::DENY);
 477         checkContextPtr->m_requestContext->returnResponse(checkContextPtr->m_requestContext,
 478                 std::make_shared<CheckResponse>(result, checkContextPtr->m_checkId));
 479     }
 480
 481     m_checkRequestManager.removeRequest(checkContextPtr);
 482 }
 483
 484 void Logic::handleClientDisconnection(const CheckContextPtr &checkContextPtr) {
 485     LOGD("Handle client disconnection");
 486
 487     if (!checkContextPtr->cancelled()) {
 488         checkContextPtr->cancel();
 489         checkContextPtr->m_agentTalker->cancel();
 490     }
 491 }
 492
 493 } // namespace Cynara