src/common/protocol/ProtocolAdmin.cpp

   1 /*
   2  * Copyright (c) 2014 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/common/protocol/ProtocolAdmin.cpp
  18  * @author      Lukasz Wojciechowski <l.wojciechow@partner.samsung.com>
  19  * @author      Adam Malinowski <a.malinowsk2@partner.samsung.com>
  20  * @version     1.0
  21  * @brief       This file implements protocol class for administration
  22  */
  23
  24 #include <cinttypes>
  25 #include <memory>
  26
  27 #include <exceptions/InvalidProtocolException.h>
  28 #include <log/log.h>
  29 #include <protocol/ProtocolFrame.h>
  30 #include <protocol/ProtocolFrameSerializer.h>
  31 #include <request/AdminCheckRequest.h>
  32 #include <request/InsertOrUpdateBucketRequest.h>
  33 #include <request/ListRequest.h>
  34 #include <request/RemoveBucketRequest.h>
  35 #include <request/RequestContext.h>
  36 #include <request/SetPoliciesRequest.h>
  37 #include <response/CheckResponse.h>
  38 #include <response/CodeResponse.h>
  39 #include <response/ListResponse.h>
  40 #include <types/PolicyKey.h>
  41
  42 #include "ProtocolAdmin.h"
  43
  44 namespace Cynara {
  45
  46 ProtocolAdmin::ProtocolAdmin() {
  47 }
  48
  49 ProtocolAdmin::~ProtocolAdmin() {
  50 }
  51
  52 ProtocolPtr ProtocolAdmin::clone(void) {
  53     return std::make_shared<ProtocolAdmin>();
  54 }
  55
  56 RequestPtr ProtocolAdmin::deserializeAdminCheckRequest(void) {
  57     std::string clientId, userId, privilegeId;
  58     PolicyBucketId startBucket;
  59     bool recursive;
  60
  61     ProtocolDeserialization::deserialize(m_frameHeader, clientId);
  62     ProtocolDeserialization::deserialize(m_frameHeader, userId);
  63     ProtocolDeserialization::deserialize(m_frameHeader, privilegeId);
  64     ProtocolDeserialization::deserialize(m_frameHeader, startBucket);
  65     ProtocolDeserialization::deserialize(m_frameHeader, recursive);
  66
  67     LOGD("Deserialized AdminCheckRequest: clientId <%s>, userId <%s>, privilegeId <%s>, "
  68          "startBucket <%s>, recursive [%d]", clientId.c_str(), userId.c_str(),
  69          privilegeId.c_str(), startBucket.c_str(), recursive);
  70
  71     return std::make_shared<AdminCheckRequest>(PolicyKey(clientId, userId, privilegeId),
  72                                                startBucket, recursive,
  73                                                m_frameHeader.sequenceNumber());
  74 }
  75
  76 RequestPtr ProtocolAdmin::deserializeInsertOrUpdateBucketRequest(void) {
  77     PolicyBucketId policyBucketId;
  78     PolicyType policyType;
  79     PolicyResult::PolicyMetadata policyMetaData;
  80
  81     ProtocolDeserialization::deserialize(m_frameHeader, policyBucketId);
  82     ProtocolDeserialization::deserialize(m_frameHeader, policyType);
  83     ProtocolDeserialization::deserialize(m_frameHeader, policyMetaData);
  84
  85     LOGD("Deserialized InsertOrUpdateBucketRequest: bucketId <%s>, "
  86          "result.type [%" PRIu16 "], result.meta <%s>", policyBucketId.c_str(),
  87          policyType, policyMetaData.c_str());
  88
  89     return std::make_shared<InsertOrUpdateBucketRequest>(policyBucketId,
  90             PolicyResult(policyType, policyMetaData), m_frameHeader.sequenceNumber());
  91 }
  92
  93 RequestPtr ProtocolAdmin::deserializeListRequest(void) {
  94     PolicyBucketId bucketId;
  95     PolicyKeyFeature::ValueType client, user, privilege;
  96
  97     ProtocolDeserialization::deserialize(m_frameHeader, bucketId);
  98     ProtocolDeserialization::deserialize(m_frameHeader, client);
  99     ProtocolDeserialization::deserialize(m_frameHeader, user);
 100     ProtocolDeserialization::deserialize(m_frameHeader, privilege);
 101
 102     LOGD("Deserialized ListRequest: bucketId <%s>, filter client <%s> filter user <%s>, filter "
 103          "privilege <%s>", bucketId.c_str(), client.c_str(), user.c_str(), privilege.c_str());
 104
 105     return std::make_shared<ListRequest>(bucketId, PolicyKey(client, user, privilege),
 106                                          m_frameHeader.sequenceNumber());
 107 }
 108
 109 RequestPtr ProtocolAdmin::deserializeRemoveBucketRequest(void) {
 110     PolicyBucketId policyBucketId;
 111
 112     ProtocolDeserialization::deserialize(m_frameHeader, policyBucketId);
 113
 114     LOGD("Deserialized RemoveBucketRequest: bucketId <%s>", policyBucketId.c_str());
 115
 116     return std::make_shared<RemoveBucketRequest>(policyBucketId, m_frameHeader.sequenceNumber());
 117 }
 118
 119 RequestPtr ProtocolAdmin::deserializeSetPoliciesRequest(void) {
 120     ProtocolFrameFieldsCount toBeInsertedOrUpdatedCount, toBeRemovedCount;
 121     ProtocolFrameFieldsCount policyCount;
 122     PolicyKeyFeature::ValueType clientId, user, privilege;
 123     PolicyType policyType;
 124     PolicyResult::PolicyMetadata metadata;
 125     std::map<PolicyBucketId, std::vector<Policy>> toBeInsertedOrUpdatedPolicies;
 126     std::map<PolicyBucketId, std::vector<PolicyKey>> toBeRemovedPolicies;
 127
 128     ProtocolDeserialization::deserialize(m_frameHeader, toBeInsertedOrUpdatedCount);
 129     for (ProtocolFrameFieldsCount b = 0; b < toBeInsertedOrUpdatedCount; ++b) {
 130         PolicyBucketId policyBucketId;
 131         ProtocolDeserialization::deserialize(m_frameHeader, policyBucketId);
 132         ProtocolDeserialization::deserialize(m_frameHeader, policyCount);
 133         for (ProtocolFrameFieldsCount p = 0; p < policyCount; ++p) {
 134             // PolicyKey
 135             ProtocolDeserialization::deserialize(m_frameHeader, clientId);
 136             ProtocolDeserialization::deserialize(m_frameHeader, user);
 137             ProtocolDeserialization::deserialize(m_frameHeader, privilege);
 138             // PolicyResult
 139             ProtocolDeserialization::deserialize(m_frameHeader, policyType);
 140             ProtocolDeserialization::deserialize(m_frameHeader, metadata);
 141
 142             toBeInsertedOrUpdatedPolicies[policyBucketId].push_back(
 143                     Policy(PolicyKey(clientId, user, privilege),
 144                     PolicyResult(policyType, metadata)));
 145         }
 146     }
 147
 148     ProtocolDeserialization::deserialize(m_frameHeader, toBeRemovedCount);
 149     for (ProtocolFrameFieldsCount b = 0; b < toBeRemovedCount; ++b) {
 150         PolicyBucketId policyBucketId;
 151         ProtocolDeserialization::deserialize(m_frameHeader, policyBucketId);
 152         ProtocolDeserialization::deserialize(m_frameHeader, policyCount);
 153         for (ProtocolFrameFieldsCount p = 0; p < policyCount; ++p) {
 154             // PolicyKey
 155             ProtocolDeserialization::deserialize(m_frameHeader, clientId);
 156             ProtocolDeserialization::deserialize(m_frameHeader, user);
 157             ProtocolDeserialization::deserialize(m_frameHeader, privilege);
 158
 159             toBeRemovedPolicies[policyBucketId].push_back(PolicyKey(clientId, user, privilege));
 160         }
 161     }
 162
 163     LOGD("Deserialized SetPoliciesRequestPtr: insertOrUpdate count [%" PRIu16 "], "
 164          "remove count [%" PRIu16 "]", toBeInsertedOrUpdatedCount, toBeRemovedCount);
 165
 166     return std::make_shared<SetPoliciesRequest>(toBeInsertedOrUpdatedPolicies,
 167                                                 toBeRemovedPolicies,
 168                                                 m_frameHeader.sequenceNumber());
 169 }
 170
 171 RequestPtr ProtocolAdmin::extractRequestFromBuffer(BinaryQueuePtr bufferQueue) {
 172     ProtocolFrameSerializer::deserializeHeader(m_frameHeader, bufferQueue);
 173
 174     if (m_frameHeader.isFrameComplete()) {
 175         ProtocolOpCode opCode;
 176
 177         m_frameHeader.resetState();
 178         ProtocolDeserialization::deserialize(m_frameHeader, opCode);
 179         LOGD("Deserialized opCode [%" PRIu8 "]", opCode);
 180         switch (opCode) {
 181         case OpAdminCheckRequest:
 182             return deserializeAdminCheckRequest();
 183         case OpInsertOrUpdateBucket:
 184             return deserializeInsertOrUpdateBucketRequest();
 185         case OpListRequest:
 186             return deserializeListRequest();
 187         case OpRemoveBucket:
 188             return deserializeRemoveBucketRequest();
 189         case OpSetPolicies:
 190             return deserializeSetPoliciesRequest();
 191         default:
 192             throw InvalidProtocolException(InvalidProtocolException::WrongOpCode);
 193             break;
 194         }
 195     }
 196
 197     return nullptr;
 198 }
 199
 200 ResponsePtr ProtocolAdmin::deserializeCheckResponse(void) {
 201     PolicyType result;
 202     PolicyResult::PolicyMetadata additionalInfo;
 203
 204     ProtocolDeserialization::deserialize(m_frameHeader, result);
 205     ProtocolDeserialization::deserialize(m_frameHeader, additionalInfo);
 206
 207     const PolicyResult policyResult(result, additionalInfo);
 208
 209     LOGD("Deserialized CheckResponse: result [%" PRIu16 "], metadata <%s>",
 210          policyResult.policyType(), policyResult.metadata().c_str());
 211
 212     return std::make_shared<CheckResponse>(policyResult, m_frameHeader.sequenceNumber());
 213 }
 214
 215 ResponsePtr ProtocolAdmin::deserializeCodeResponse(void) {
 216     ProtocolResponseCode responseCode;
 217     ProtocolDeserialization::deserialize(m_frameHeader, responseCode);
 218
 219     LOGD("Deserialized CodeResponse: code [%" PRIu16 "], ", responseCode);
 220
 221     return std::make_shared<CodeResponse>(static_cast<CodeResponse::Code>(responseCode),
 222                                           m_frameHeader.sequenceNumber());
 223 }
 224
 225 ResponsePtr ProtocolAdmin::deserializeListResponse(void) {
 226     ProtocolFrameFieldsCount policiesCount;
 227     PolicyKeyFeature::ValueType client, user, privilege;
 228     PolicyType policyType;
 229     PolicyResult::PolicyMetadata metadata;
 230     std::vector<Policy> policies;
 231
 232     ProtocolDeserialization::deserialize(m_frameHeader, policiesCount);
 233     policies.reserve(policiesCount);
 234
 235     for (ProtocolFrameFieldsCount p = 0; p < policiesCount; ++p) {
 236         // PolicyKey
 237         ProtocolDeserialization::deserialize(m_frameHeader, client);
 238         ProtocolDeserialization::deserialize(m_frameHeader, user);
 239         ProtocolDeserialization::deserialize(m_frameHeader, privilege);
 240         // PolicyResult
 241         ProtocolDeserialization::deserialize(m_frameHeader, policyType);
 242         ProtocolDeserialization::deserialize(m_frameHeader, metadata);
 243
 244         policies.push_back(Policy(PolicyKey(client, user, privilege),
 245                                         PolicyResult(policyType, metadata)));
 246     }
 247
 248     bool isBucketValid;
 249     ProtocolDeserialization::deserialize(m_frameHeader, isBucketValid);
 250
 251     LOGD("Deserialized ListResponse: number of policies [%" PRIu16 "], isBucketValid [%d]",
 252          policiesCount, isBucketValid);
 253
 254     return std::make_shared<ListResponse>(policies, isBucketValid, m_frameHeader.sequenceNumber());
 255 }
 256
 257 ResponsePtr ProtocolAdmin::extractResponseFromBuffer(BinaryQueuePtr bufferQueue) {
 258     ProtocolFrameSerializer::deserializeHeader(m_frameHeader, bufferQueue);
 259
 260     if (m_frameHeader.isFrameComplete()) {
 261         ProtocolOpCode opCode;
 262
 263         m_frameHeader.resetState();
 264         ProtocolDeserialization::deserialize(m_frameHeader, opCode);
 265         LOGD("Deserialized opCode [%" PRIu8 "]", opCode);
 266         switch (opCode) {
 267         case OpCheckPolicyResponse:
 268             return deserializeCheckResponse();
 269         case OpCodeResponse:
 270             return deserializeCodeResponse();
 271         case OpListResponse:
 272             return deserializeListResponse();
 273         default:
 274             throw InvalidProtocolException(InvalidProtocolException::WrongOpCode);
 275             break;
 276         }
 277     }
 278
 279     return nullptr;
 280 }
 281
 282 void ProtocolAdmin::execute(RequestContextPtr context, AdminCheckRequestPtr request) {
 283     LOGD("Serializing AdminCheckRequest: client <%s>, user <%s>, privilege <%s>, "
 284          "startBucket <%s>, recursive [%d]", request->key().client().value().c_str(),
 285          request->key().user().value().c_str(), request->key().privilege().value().c_str(),
 286          request->startBucket().c_str(), request->recursive());
 287
 288     ProtocolFrame frame = ProtocolFrameSerializer::startSerialization(request->sequenceNumber());
 289
 290     ProtocolSerialization::serialize(frame, OpAdminCheckRequest);
 291     ProtocolSerialization::serialize(frame, request->key().client().value());
 292     ProtocolSerialization::serialize(frame, request->key().user().value());
 293     ProtocolSerialization::serialize(frame, request->key().privilege().value());
 294     ProtocolSerialization::serialize(frame, request->startBucket());
 295     ProtocolSerialization::serialize(frame, request->recursive());
 296
 297     ProtocolFrameSerializer::finishSerialization(frame, *(context->responseQueue()));
 298 }
 299
 300 void ProtocolAdmin::execute(RequestContextPtr context, InsertOrUpdateBucketRequestPtr request) {
 301     LOGD("Serializing InsertOrUpdateBucketRequest: sequenceNumber [%" PRIu16 "], bucketId <%s>, "
 302          "result.type [%" PRIu16 "], result.meta <%s>", request->sequenceNumber(),
 303          request->bucketId().c_str(), request->result().policyType(),
 304          request->result().metadata().c_str());
 305
 306     ProtocolFrame frame = ProtocolFrameSerializer::startSerialization(request->sequenceNumber());
 307
 308     ProtocolSerialization::serialize(frame, OpInsertOrUpdateBucket);
 309     ProtocolSerialization::serialize(frame, request->bucketId());
 310     ProtocolSerialization::serialize(frame, request->result().policyType());
 311     ProtocolSerialization::serialize(frame, request->result().metadata());
 312
 313     ProtocolFrameSerializer::finishSerialization(frame, *(context->responseQueue()));
 314 }
 315
 316 void ProtocolAdmin::execute(RequestContextPtr context, ListRequestPtr request) {
 317     LOGD("Serializing ListRequest: sequenceNumber [%" PRIu16 "], bucketId <%s>, "
 318          "filter client <%s> filter user <%s> filter privilege <%s>", request->sequenceNumber(),
 319          request->bucket().c_str(), request->filter().client().value().c_str(),
 320          request->filter().user().value().c_str(), request->filter().privilege().value().c_str());
 321
 322     ProtocolFrame frame = ProtocolFrameSerializer::startSerialization(request->sequenceNumber());
 323
 324     ProtocolSerialization::serialize(frame, OpListRequest);
 325     ProtocolSerialization::serialize(frame, request->bucket());
 326     ProtocolSerialization::serialize(frame, request->filter().client().value());
 327     ProtocolSerialization::serialize(frame, request->filter().user().value());
 328     ProtocolSerialization::serialize(frame, request->filter().privilege().value());
 329
 330     ProtocolFrameSerializer::finishSerialization(frame, *(context->responseQueue()));
 331 }
 332
 333 void ProtocolAdmin::execute(RequestContextPtr context, RemoveBucketRequestPtr request) {
 334     LOGD("Serializing RemoveBucketRequest: sequenceNumber [%" PRIu16 "], bucketId <%s>",
 335          request->sequenceNumber(), request->bucketId().c_str());
 336
 337     ProtocolFrame frame = ProtocolFrameSerializer::startSerialization(request->sequenceNumber());
 338
 339     ProtocolSerialization::serialize(frame, OpRemoveBucket);
 340     ProtocolSerialization::serialize(frame, request->bucketId());
 341
 342     ProtocolFrameSerializer::finishSerialization(frame, *(context->responseQueue()));
 343 }
 344
 345 void ProtocolAdmin::execute(RequestContextPtr context, SetPoliciesRequestPtr request) {
 346     LOGD("Serializing SetPoliciesRequestPtr: sequenceNumber [%" PRIu16 "], "
 347          "insertOrUpdate count [%zu], remove count [%zu]", request->sequenceNumber(),
 348          request->policiesToBeInsertedOrUpdated().size(), request->policiesToBeRemoved().size());
 349
 350     ProtocolFrame frame =
 351             ProtocolFrameSerializer::startSerialization(request->sequenceNumber());
 352
 353     ProtocolSerialization::serialize(frame, OpSetPolicies);
 354
 355     ProtocolSerialization::serialize(frame,
 356             static_cast<ProtocolFrameFieldsCount>(request->policiesToBeInsertedOrUpdated().size()));
 357     for (auto policyBucket : request->policiesToBeInsertedOrUpdated()) {
 358         ProtocolSerialization::serialize(frame, policyBucket.first);
 359         ProtocolSerialization::serialize(frame,
 360                     static_cast<ProtocolFrameFieldsCount>(policyBucket.second.size()));
 361         for (auto policy : policyBucket.second) {
 362             // PolicyKey
 363             ProtocolSerialization::serialize(frame, policy.key().client().value());
 364             ProtocolSerialization::serialize(frame, policy.key().user().value());
 365             ProtocolSerialization::serialize(frame, policy.key().privilege().value());
 366             // PolicyResult
 367             ProtocolSerialization::serialize(frame, policy.result().policyType());
 368             ProtocolSerialization::serialize(frame, policy.result().metadata());
 369         }
 370     }
 371
 372     ProtocolSerialization::serialize(frame,
 373             static_cast<ProtocolFrameFieldsCount>(request->policiesToBeRemoved().size()));
 374     for (auto policyBucket : request->policiesToBeRemoved()) {
 375         ProtocolSerialization::serialize(frame, policyBucket.first);
 376         ProtocolSerialization::serialize(frame,
 377                     static_cast<ProtocolFrameFieldsCount>(policyBucket.second.size()));
 378         for (auto policyKey : policyBucket.second) {
 379             // PolicyKey
 380             ProtocolSerialization::serialize(frame, policyKey.client().value());
 381             ProtocolSerialization::serialize(frame, policyKey.user().value());
 382             ProtocolSerialization::serialize(frame, policyKey.privilege().value());
 383         }
 384     }
 385
 386     ProtocolFrameSerializer::finishSerialization(frame, *(context->responseQueue()));
 387 }
 388
 389 void ProtocolAdmin::execute(RequestContextPtr context, CheckResponsePtr response) {
 390     LOGD("Serializing CheckResponse: op [%" PRIu8 "], sequenceNumber [%" PRIu16 "], "
 391          "policyType [%" PRIu16 "], metadata <%s>", OpCheckPolicyResponse,
 392          response->sequenceNumber(), response->m_resultRef.policyType(),
 393          response->m_resultRef.metadata().c_str());
 394
 395     ProtocolFrame frame = ProtocolFrameSerializer::startSerialization(
 396             response->sequenceNumber());
 397
 398     ProtocolSerialization::serialize(frame, OpCheckPolicyResponse);
 399     ProtocolSerialization::serialize(frame, response->m_resultRef.policyType());
 400     ProtocolSerialization::serialize(frame, response->m_resultRef.metadata());
 401
 402     ProtocolFrameSerializer::finishSerialization(frame, *(context->responseQueue()));
 403 }
 404
 405 void ProtocolAdmin::execute(RequestContextPtr context, CodeResponsePtr response) {
 406     LOGD("Serializing CodeResponse: op [%" PRIu8 "], sequenceNumber [%" PRIu16 "], "
 407          "code [%" PRIu16 "]", OpCodeResponse, response->sequenceNumber(), response->m_code);
 408
 409     ProtocolFrame frame = ProtocolFrameSerializer::startSerialization(
 410             response->sequenceNumber());
 411
 412     ProtocolSerialization::serialize(frame, OpCodeResponse);
 413     ProtocolSerialization::serialize(frame, static_cast<ProtocolResponseCode>(response->m_code));
 414
 415     ProtocolFrameSerializer::finishSerialization(frame, *(context->responseQueue()));
 416 }
 417
 418 void ProtocolAdmin::execute(RequestContextPtr context, ListResponsePtr response) {
 419     ProtocolFrameFieldsCount policiesSize
 420         = static_cast<ProtocolFrameFieldsCount>(response->policies().size());
 421
 422     LOGD("Serializing ListResponse: op [%" PRIu8 "], sequenceNumber [%" PRIu16 "], "
 423          "number of policies [%" PRIu16 "], isBucketValid [%d]", OpListResponse,
 424          response->sequenceNumber(), policiesSize, response->isBucketValid());
 425
 426     ProtocolFrame frame = ProtocolFrameSerializer::startSerialization(response->sequenceNumber());
 427
 428     ProtocolSerialization::serialize(frame, OpListResponse);
 429     ProtocolSerialization::serialize(frame, policiesSize);
 430     for (auto &policy : response->policies()) {
 431         // PolicyKey
 432         ProtocolSerialization::serialize(frame, policy.key().client().value());
 433         ProtocolSerialization::serialize(frame, policy.key().user().value());
 434         ProtocolSerialization::serialize(frame, policy.key().privilege().value());
 435         // PolicyResult
 436         ProtocolSerialization::serialize(frame, policy.result().policyType());
 437         ProtocolSerialization::serialize(frame, policy.result().metadata());
 438     }
 439     ProtocolSerialization::serialize(frame, response->isBucketValid());
 440
 441     ProtocolFrameSerializer::finishSerialization(frame, *(context->responseQueue()));
 442 }
 443
 444 } // namespace Cynara