2 * Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 * @file src/service/logic/Logic.cpp
18 * @author Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
20 * @brief This file implements main class of logic layer in cynara service
32 #include <exceptions/BucketNotExistsException.h>
33 #include <exceptions/DatabaseException.h>
34 #include <exceptions/DefaultBucketDeletionException.h>
35 #include <exceptions/DefaultBucketSetNoneException.h>
36 #include <exceptions/InvalidBucketIdException.h>
37 #include <exceptions/PluginErrorException.h>
38 #include <exceptions/PluginNotFoundException.h>
39 #include <exceptions/UnexpectedErrorException.h>
40 #include <request/AdminCheckRequest.h>
41 #include <request/AgentActionRequest.h>
42 #include <request/AgentRegisterRequest.h>
43 #include <request/CancelRequest.h>
44 #include <request/CheckRequest.h>
45 #include <request/DescriptionListRequest.h>
46 #include <request/EraseRequest.h>
47 #include <request/InsertOrUpdateBucketRequest.h>
48 #include <request/ListRequest.h>
49 #include <request/RemoveBucketRequest.h>
50 #include <request/RequestContext.h>
51 #include <request/SetPoliciesRequest.h>
52 #include <request/SignalRequest.h>
53 #include <response/AdminCheckResponse.h>
54 #include <response/AgentRegisterResponse.h>
55 #include <response/CancelResponse.h>
56 #include <response/CheckResponse.h>
57 #include <response/CodeResponse.h>
58 #include <response/DescriptionListResponse.h>
59 #include <response/ListResponse.h>
60 #include <types/Policy.h>
62 #include <main/Cynara.h>
63 #include <agent/AgentManager.h>
64 #include <sockets/SocketManager.h>
65 #include <storage/Storage.h>
67 #include <cynara-plugin.h>
69 #include <cynara-agent.h>
81 void Logic::execute(RequestContextPtr context UNUSED, SignalRequestPtr request) {
82 LOGD("Processing signal: [%d]", request->signalNumber());
84 switch (request->signalNumber()) {
86 LOGI("SIGTERM received!");
87 m_socketManager->mainLoopStop();
92 void Logic::execute(RequestContextPtr context, AdminCheckRequestPtr request) {
94 bool bucketValid = true;
96 result = m_storage->checkPolicy(request->key(), request->startBucket(),
97 request->recursive());
98 } catch (const BucketNotExistsException &ex) {
102 context->returnResponse(context, std::make_shared<AdminCheckResponse>(result, bucketValid,
103 request->sequenceNumber()));
106 void Logic::execute(RequestContextPtr context, AgentActionRequestPtr request) {
107 AgentTalkerPtr talkerPtr = m_agentManager->getTalker(context->responseQueue(),
108 request->sequenceNumber());
110 LOGD("Received response from agent with invalid request id: [%" PRIu16 "]",
111 request->sequenceNumber());
115 CheckContextPtr checkContextPtr = m_checkRequestManager.getContext(talkerPtr);
116 if (!checkContextPtr) {
117 LOGE("No matching check context for agent talker.");
118 m_agentManager->removeTalker(talkerPtr);
122 if (!checkContextPtr->cancelled()) {
123 PluginData data(request->data().begin(), request->data().end());
124 if (request->type() == CYNARA_MSG_TYPE_CANCEL) {
125 // Nothing to do for now
126 } else if (request->type() == CYNARA_MSG_TYPE_ACTION) {
127 update(checkContextPtr->m_key, checkContextPtr->m_checkId, data,
128 checkContextPtr->m_requestContext, checkContextPtr->m_plugin);
130 LOGE("Invalid response type [%d] in response from agent <%s>",
131 static_cast<int>(request->type()), talkerPtr->agentType().c_str());
132 // TODO: disconnect agent
136 m_agentManager->removeTalker(talkerPtr);
137 m_checkRequestManager.removeRequest(checkContextPtr);
140 void Logic::execute(RequestContextPtr context, AgentRegisterRequestPtr request) {
141 auto result = m_agentManager->registerAgent(request->agentType(), context->responseQueue());
142 context->returnResponse(context, std::make_shared<AgentRegisterResponse>(
143 result, request->sequenceNumber()));
146 void Logic::execute(RequestContextPtr context, CancelRequestPtr request) {
147 CheckContextPtr checkContextPtr = m_checkRequestManager.getContext(context->responseQueue(),
148 request->sequenceNumber());
149 if (!checkContextPtr) {
150 LOGD("Cancel request id: [%" PRIu16 "] with no matching request in progress.",
151 request->sequenceNumber());
155 if (checkContextPtr->cancelled())
158 checkContextPtr->cancel();
159 checkContextPtr->m_agentTalker->cancel();
161 LOGD("Returning response for cancel request id: [%" PRIu16 "].", request->sequenceNumber());
162 context->returnResponse(context, std::make_shared<CancelResponse>(request->sequenceNumber()));
165 void Logic::execute(RequestContextPtr context, CheckRequestPtr request) {
166 PolicyResult result(PredefinedPolicyType::DENY);
167 if (check(context, request->key(), request->sequenceNumber(), result)) {
168 context->returnResponse(context, std::make_shared<CheckResponse>(result,
169 request->sequenceNumber()));
173 bool Logic::check(const RequestContextPtr &context, const PolicyKey &key,
174 ProtocolFrameSequenceNumber checkId, PolicyResult &result) {
176 if (m_checkRequestManager.getContext(context->responseQueue(), checkId)) {
177 LOGE("Check request for checkId: [%" PRIu16 "] is already processing", checkId);
181 result = m_storage->checkPolicy(key);
183 switch (result.policyType()) {
184 case PredefinedPolicyType::ALLOW :
185 LOGD("check of policy key <%s> returned ALLOW", key.toString().c_str());
187 case PredefinedPolicyType::DENY :
188 LOGD("check of policy key <%s> returned DENY", key.toString().c_str());
192 return pluginCheck(context, key, checkId, result);
195 bool Logic::pluginCheck(const RequestContextPtr &context, const PolicyKey &key,
196 ProtocolFrameSequenceNumber checkId, PolicyResult &result) {
198 LOGD("Trying to check policy: <%s> in plugin.", key.toString().c_str());
200 ExternalPluginPtr plugin = m_pluginManager->getPlugin(result.policyType());
202 LOGE("Plugin not found for policy: [0x%x]", result.policyType());
203 result = PolicyResult(PredefinedPolicyType::DENY);
207 ServicePluginInterfacePtr servicePlugin =
208 std::dynamic_pointer_cast<ServicePluginInterface>(plugin);
210 throw PluginNotFoundException(result);
213 AgentType requiredAgent;
214 PluginData pluginData;
216 auto ret = servicePlugin->check(key.client().toString(), key.user().toString(),
217 key.privilege().toString(), result, requiredAgent, pluginData);
220 case ServicePluginInterface::PluginStatus::ANSWER_READY:
222 case ServicePluginInterface::PluginStatus::ANSWER_NOTREADY: {
223 result = PolicyResult(PredefinedPolicyType::DENY);
224 AgentTalkerPtr agentTalker = m_agentManager->createTalker(requiredAgent);
226 LOGE("Required agent talker for: <%s> could not be created.",
227 requiredAgent.c_str());
231 if (!m_checkRequestManager.createContext(key, context, checkId, servicePlugin,
233 LOGE("Check context for checkId: [%" PRIu16 "] could not be created.",
235 m_agentManager->removeTalker(agentTalker);
238 agentTalker->send(pluginData);
242 throw PluginErrorException(key); // This 'throw' should be removed or handled properly.
246 bool Logic::update(const PolicyKey &key, ProtocolFrameSequenceNumber checkId,
247 const PluginData &agentData, const RequestContextPtr &context,
248 const ServicePluginInterfacePtr &plugin) {
250 LOGD("Check update: <%s>:[%" PRIu16 "]", key.toString().c_str(), checkId);
253 bool answerReady = false;
254 auto ret = plugin->update(key.client().toString(), key.user().toString(),
255 key.privilege().toString(), agentData, result);
257 case ServicePluginInterface::PluginStatus::SUCCESS:
260 case ServicePluginInterface::PluginStatus::ERROR:
261 result = PolicyResult(PredefinedPolicyType::DENY);
265 throw PluginErrorException(key);
268 if (answerReady && context->responseQueue()) {
269 context->returnResponse(context, std::make_shared<CheckResponse>(result, checkId));
276 void Logic::execute(RequestContextPtr context, DescriptionListRequestPtr request) {
277 auto descriptions = m_pluginManager->getPolicyDescriptions();
278 descriptions.insert(descriptions.begin(), predefinedPolicyDescr.begin(),
279 predefinedPolicyDescr.end());
280 context->returnResponse(context, std::make_shared<DescriptionListResponse>(descriptions,
281 request->sequenceNumber()));
284 void Logic::execute(RequestContextPtr context, EraseRequestPtr request) {
285 auto code = CodeResponse::Code::OK;
288 m_storage->erasePolicies(request->startBucket(), request->recursive(), request->filter());
290 } catch (const DatabaseException &ex) {
291 code = CodeResponse::Code::FAILED;
292 } catch (const BucketNotExistsException &ex) {
293 code = CodeResponse::Code::NO_BUCKET;
296 context->returnResponse(context, std::make_shared<CodeResponse>(code,
297 request->sequenceNumber()));
300 void Logic::execute(RequestContextPtr context, InsertOrUpdateBucketRequestPtr request) {
301 auto code = CodeResponse::Code::OK;
304 m_storage->addOrUpdateBucket(request->bucketId(), request->result());
306 } catch (const DatabaseException &ex) {
307 code = CodeResponse::Code::FAILED;
308 } catch (const DefaultBucketSetNoneException &ex) {
309 code = CodeResponse::Code::NOT_ALLOWED;
310 } catch (const InvalidBucketIdException &ex) {
311 code = CodeResponse::Code::NOT_ALLOWED;
314 context->returnResponse(context, std::make_shared<CodeResponse>(code,
315 request->sequenceNumber()));
318 void Logic::execute(RequestContextPtr context, ListRequestPtr request) {
319 bool bucketValid = true;
321 std::vector<Policy> policies;
323 policies = m_storage->listPolicies(request->bucket(), request->filter());
324 } catch (const BucketNotExistsException &ex) {
328 context->returnResponse(context, std::make_shared<ListResponse>(policies, bucketValid,
329 request->sequenceNumber()));
332 void Logic::execute(RequestContextPtr context, RemoveBucketRequestPtr request) {
333 auto code = CodeResponse::Code::OK;
335 m_storage->deleteBucket(request->bucketId());
337 } catch (const DatabaseException &ex) {
338 code = CodeResponse::Code::FAILED;
339 } catch (const BucketNotExistsException &ex) {
340 code = CodeResponse::Code::NO_BUCKET;
341 } catch (const DefaultBucketDeletionException &ex) {
342 code = CodeResponse::Code::NOT_ALLOWED;
344 context->returnResponse(context, std::make_shared<CodeResponse>(code,
345 request->sequenceNumber()));
348 void Logic::execute(RequestContextPtr context, SetPoliciesRequestPtr request) {
349 auto code = CodeResponse::Code::OK;
351 m_storage->insertPolicies(request->policiesToBeInsertedOrUpdated());
352 m_storage->deletePolicies(request->policiesToBeRemoved());
354 } catch (const DatabaseException &ex) {
355 code = CodeResponse::Code::FAILED;
356 } catch (const BucketNotExistsException &ex) {
357 code = CodeResponse::Code::NO_BUCKET;
359 context->returnResponse(context, std::make_shared<CodeResponse>(code,
360 request->sequenceNumber()));
363 void Logic::contextClosed(RequestContextPtr context) {
364 LOGD("context closed");
366 LinkId linkId = context->responseQueue();
368 m_agentManager->cleanupAgent(linkId, [&](const AgentTalkerPtr &talker) -> void {
369 handleAgentTalkerDisconnection(talker); });
371 m_checkRequestManager.cancelRequests(linkId,
372 [&](const CheckContextPtr &checkContextPtr) -> void {
373 handleClientDisconnection(checkContextPtr); });
376 void Logic::onPoliciesChanged(void) {
378 m_socketManager->disconnectAllClients();
379 m_pluginManager->invalidateAll();
380 //todo remove all saved contexts (if there will be any saved contexts)
383 void Logic::handleAgentTalkerDisconnection(const AgentTalkerPtr &agentTalkerPtr) {
384 CheckContextPtr checkContextPtr = m_checkRequestManager.getContext(agentTalkerPtr);
385 if (checkContextPtr == nullptr) {
386 LOGE("No matching check context for agent talker.");
390 if (!checkContextPtr->cancelled() && checkContextPtr->m_requestContext->responseQueue()) {
391 PolicyResult result(PredefinedPolicyType::DENY);
392 checkContextPtr->m_requestContext->returnResponse(checkContextPtr->m_requestContext,
393 std::make_shared<CheckResponse>(result, checkContextPtr->m_checkId));
396 m_checkRequestManager.removeRequest(checkContextPtr);
399 void Logic::handleClientDisconnection(const CheckContextPtr &checkContextPtr) {
400 LOGD("Handle client disconnection");
402 if (!checkContextPtr->cancelled()) {
403 checkContextPtr->cancel();
404 checkContextPtr->m_agentTalker->cancel();
408 } // namespace Cynara