src/ckm/ckm-common.cpp

   1 /*
   2  *  Copyright (c) 2000 - 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       ckm-common.cpp
  18  * @author     Krzysztof Jackiewicz (k.jackiewicz@samsung.com)
  19  * @version    1.0
  20  */
  21 #include <string>
  22 #include <fstream>
  23 #include <sys/smack.h>
  24 #include <ckmc/ckmc-type.h>
  25 #include <ckm-common.h>
  26 #include <tests_common.h>
  27 #include <access_provider2.h>
  28 #include <ckm/ckm-control.h>
  29 #include <ckm/ckm-manager.h>
  30 #include <ckmc/ckmc-control.h>
  31 #include <ckmc/ckmc-manager.h>
  32 #include <service_manager.h>
  33 #include <fcntl.h>
  34 #include <unistd.h>
  35
  36 const std::string SMACK_USER_APP_PREFIX = "User::App::";
  37
  38 void generate_random(size_t random_bytes, char *output)
  39 {
  40     RUNNER_ASSERT(random_bytes>0 && output);
  41
  42     std::ifstream is("/dev/urandom", std::ifstream::binary);
  43     RUNNER_ASSERT_MSG(is, "Failed to read /dev/urandom");
  44     is.read(output, random_bytes);
  45     if(static_cast<std::streamsize>(random_bytes) != is.gcount()) {
  46         RUNNER_ASSERT_MSG(false,
  47                           "Not enough bytes read from /dev/urandom: " << random_bytes << "!=" <<
  48                           is.gcount());
  49     }
  50 }
  51
  52 const char* SERVICE[] = {
  53         "central-key-manager-listener.service",
  54         "central-key-manager.service" };
  55
  56 void start_service(ServiceIdx idx)
  57 {
  58     ServiceManager sm(SERVICE[idx]);
  59     sm.startService();
  60 }
  61
  62 void stop_service(ServiceIdx idx)
  63 {
  64     ServiceManager sm(SERVICE[idx]);
  65     sm.stopService();
  66 }
  67
  68 std::string getLabel() {
  69     int ret;
  70     char* myLabel = NULL;
  71     RUNNER_ASSERT_MSG(0 <= (ret = smack_new_label_from_self(&myLabel)),
  72                          "Failed to get smack label for self. Error: " << ret);
  73     RUNNER_ASSERT_MSG(myLabel, "NULL smack label");
  74     std::string result = myLabel;
  75     free(myLabel);
  76     return result;
  77 }
  78
  79 std::string getOwnerIdFromSelf() {
  80     const std::string& prefix = SMACK_USER_APP_PREFIX;
  81     std::string smack = getLabel();
  82     if (0 == smack.compare(0, prefix.size(), prefix))
  83         return smack.substr(prefix.size(), std::string::npos);
  84     return "/" + smack;
  85 }
  86
  87 std::string aliasWithLabel(const char *label, const char *alias)
  88 {
  89     if(label)
  90     {
  91         std::stringstream ss;
  92         ss << label << std::string(ckmc_label_name_separator) << alias;
  93         return ss.str();
  94     }
  95     return std::string(alias);
  96 }
  97
  98 // changes process label
  99 void change_label(const char* label)
 100 {
 101     int ret = smack_set_label_for_self(label);
 102     RUNNER_ASSERT_MSG(0 == ret, "Error in smack_set_label_for_self("<<label<<"). Error: " << ret);
 103 }
 104
 105 ScopedLabel::ScopedLabel(const char* label) : m_original_label(getLabel())
 106 {
 107     change_label(label);
 108 }
 109
 110 ScopedLabel::~ScopedLabel()
 111 {
 112     /*
 113      * Let it throw. If we can't restore label then remaining tests results will be
 114      * unreliable anyway.
 115      */
 116     change_label(m_original_label.c_str());
 117 }
 118
 119 const char * CKMCErrorToString(int error) {
 120 #define ERRORDESCRIBE(name) case name: return #name
 121     switch(error) {
 122         ERRORDESCRIBE(CKMC_ERROR_NONE);
 123         ERRORDESCRIBE(CKMC_ERROR_INVALID_PARAMETER);
 124         ERRORDESCRIBE(CKMC_ERROR_OUT_OF_MEMORY);
 125         ERRORDESCRIBE(CKMC_ERROR_PERMISSION_DENIED);
 126         ERRORDESCRIBE(CKMC_ERROR_SOCKET);
 127         ERRORDESCRIBE(CKMC_ERROR_BAD_REQUEST);
 128         ERRORDESCRIBE(CKMC_ERROR_BAD_RESPONSE);
 129         ERRORDESCRIBE(CKMC_ERROR_SEND_FAILED);
 130         ERRORDESCRIBE(CKMC_ERROR_RECV_FAILED);
 131         ERRORDESCRIBE(CKMC_ERROR_AUTHENTICATION_FAILED);
 132         ERRORDESCRIBE(CKMC_ERROR_BUFFER_TOO_SMALL);
 133         ERRORDESCRIBE(CKMC_ERROR_SERVER_ERROR);
 134         ERRORDESCRIBE(CKMC_ERROR_DB_LOCKED);
 135         ERRORDESCRIBE(CKMC_ERROR_DB_ERROR);
 136         ERRORDESCRIBE(CKMC_ERROR_DB_ALIAS_EXISTS);
 137         ERRORDESCRIBE(CKMC_ERROR_DB_ALIAS_UNKNOWN);
 138         ERRORDESCRIBE(CKMC_ERROR_VERIFICATION_FAILED);
 139         ERRORDESCRIBE(CKMC_ERROR_INVALID_FORMAT);
 140         ERRORDESCRIBE(CKMC_ERROR_FILE_ACCESS_DENIED);
 141         ERRORDESCRIBE(CKMC_ERROR_NOT_EXPORTABLE);
 142         ERRORDESCRIBE(CKMC_ERROR_FILE_SYSTEM);
 143         ERRORDESCRIBE(CKMC_ERROR_UNKNOWN);
 144         default: return "Error not defined";
 145     }
 146 #undef ERRORDESCRIBE
 147 }
 148
 149 std::string CKMCReadableError(int error) {
 150     std::string output("Error: ");
 151     output += std::to_string(error);
 152     output += " Description: ";
 153     output += CKMCErrorToString(error);
 154     return output;
 155 }
 156
 157 void save_data(const char* alias, const char *data, int expected_err)
 158 {
 159     save_data(alias, data, strlen(data), expected_err);
 160 }
 161
 162 void save_data(const char* alias, const char *data, size_t len, int expected_err = CKMC_ERROR_NONE)
 163 {
 164     RUNNER_ASSERT(alias);
 165     RUNNER_ASSERT(data);
 166
 167     ckmc_raw_buffer_s buffer;
 168     buffer.data = reinterpret_cast<unsigned char*>(const_cast<char*>(data));
 169     buffer.size = len;
 170     ckmc_policy_s policy;
 171     policy.password = NULL;
 172     policy.extractable = true;
 173
 174     int ret = ckmc_save_data(alias, buffer, policy);
 175     RUNNER_ASSERT_MSG(expected_err == ret, "Saving data failed. "
 176                         << CKMCErrorToString(ret) << " while expected: "
 177                         << CKMCErrorToString(expected_err));
 178
 179 }
 180
 181 ScopedSaveData::ScopedSaveData(const char* alias, const char *data, int expected_err) : m_alias(alias)
 182 {
 183     save_data(alias, data, expected_err);
 184 }
 185
 186 ScopedSaveData::~ScopedSaveData()
 187 {
 188     /*
 189      * Let it throw. If we can't remove data then remaining tests results will be
 190      * unreliable anyway.
 191      */
 192     check_remove_allowed(m_alias.c_str());
 193 }
 194
 195 void GarbageCollector::add(const char* alias)
 196 {
 197     save_item item;
 198     item.item_alias = std::string(alias);
 199     item.owner_label = getOwnerIdFromSelf();
 200     item.owner_uid = geteuid();
 201     item.owner_gid = getegid();
 202     m_garbage.push_back(item);
 203 }
 204
 205 void GarbageCollector::save(const char* alias, const char *data, int expected_err)
 206 {
 207     save(alias, data, strlen(data), expected_err);
 208 }
 209
 210 void GarbageCollector::save(const char* alias, const char *data, size_t len, int expected_err)
 211 {
 212     save_data(alias, data, len, expected_err);
 213
 214     if(CKMC_ERROR_NONE == expected_err)
 215         add(alias);
 216 }
 217
 218 GarbageCollector::~GarbageCollector()
 219 {
 220     for(auto & item : m_garbage)
 221     {
 222         try {
 223             ScopedAccessProvider ap(item.owner_label, item.owner_uid, item.owner_gid);
 224             check_remove_allowed(item.item_alias.c_str());
 225         } catch (...) {
 226             // prevent exceptions in destructor
 227         }
 228     }
 229 }
 230
 231 ScopedDBUnlock::ScopedDBUnlock(uid_t user_id, const char* passwd) : m_uid(user_id)
 232 {
 233     int temp;
 234     RUNNER_ASSERT_MSG(CKMC_ERROR_NONE == (temp = ckmc_unlock_user_key(user_id, passwd)), CKMCErrorToString(temp));
 235 }
 236 ScopedDBUnlock::~ScopedDBUnlock()
 237 {
 238     int temp;
 239     RUNNER_ASSERT_MSG(CKMC_ERROR_NONE == (temp = ckmc_lock_user_key(m_uid)), CKMCErrorToString(temp));
 240 }
 241
 242 void check_remove_allowed(const char* alias)
 243 {
 244     int ret = ckmc_remove_alias(alias);
 245     // remove, but ignore non existing
 246     RUNNER_ASSERT_MSG((CKMC_ERROR_NONE == ret) || (CKMC_ERROR_DB_ALIAS_UNKNOWN == ret),
 247                          "Removing data failed: " << CKMCErrorToString(ret));
 248 }
 249
 250 void check_remove_denied(const char* alias)
 251 {
 252     int ret = ckmc_remove_alias(alias);
 253     RUNNER_ASSERT_MSG(
 254             CKMC_ERROR_PERMISSION_DENIED == ret,
 255             "App with different label shouldn't have rights to remove this data. "
 256             << CKMCReadableError(ret));
 257 }
 258
 259 void check_remove_not_visible(const char* alias)
 260 {
 261     int ret = ckmc_remove_alias(alias);
 262     RUNNER_ASSERT_MSG(
 263             CKMC_ERROR_DB_ALIAS_UNKNOWN == ret,
 264             "App with different label shouldn't have rights to see this data. "
 265             << CKMCReadableError(ret));
 266 }
 267
 268 void check_read(const char* alias,
 269                 const char *label,
 270                 const char *test_data,
 271                 size_t len,
 272                 int expected_code)
 273 {
 274     ckmc_raw_buffer_s* buffer = NULL;
 275     int ret = ckmc_get_data(aliasWithLabel(label, alias).c_str(), NULL, &buffer);
 276     RUNNER_ASSERT_MSG(expected_code == ret, "Getting data failed. "
 277                       "Expected " << CKMCErrorToString(expected_code) << ", "
 278                       "while result " << CKMCErrorToString(ret));
 279
 280     if(expected_code == CKMC_ERROR_NONE)
 281     {
 282         // compare data with expected
 283         RUNNER_ASSERT_MSG(
 284                 buffer->size == len,
 285                 "Extracted data length do not match expected data length (encrypted?):" <<
 286                 buffer->size << "!=" << len);
 287
 288         RUNNER_ASSERT_MSG(
 289                 memcmp(const_cast<const char*>(reinterpret_cast<char*>(buffer->data)),
 290                        test_data, buffer->size) == 0,
 291                 "Extracted data do not match expected data (encrypted?).");
 292
 293         ckmc_buffer_free(buffer);
 294     }
 295 }
 296
 297 void check_read(const char* alias, const char *label, const char *test_data, int expected_code)
 298 {
 299     check_read(alias, label, test_data, strlen(test_data), expected_code);
 300 }
 301
 302 void check_read_allowed(const char* alias, const char *data)
 303 {
 304     // try to read previously saved data - label taken implicitly
 305     check_read(alias, NULL, data);
 306 }
 307
 308 void check_read_not_visible(const char* alias)
 309 {
 310     // try to read previously saved data - label taken implicitly
 311     {
 312         ckmc_raw_buffer_s* buffer = NULL;
 313         int ret = ckmc_get_data(alias, NULL, &buffer);
 314         RUNNER_ASSERT_MSG(CKMC_ERROR_DB_ALIAS_UNKNOWN == ret,
 315                             "App with different label shouldn't have rights to see this data. " << CKMCErrorToString(ret));
 316         ckmc_buffer_free(buffer);
 317     }
 318 }
 319
 320 void check_key(const char *alias, int expected_error, ckmc_key_type_e expected_type)
 321 {
 322     ckmc_key_s *test_key = NULL;
 323     int temp = ckmc_get_key(alias, 0, &test_key);
 324     RUNNER_ASSERT_MSG(
 325             expected_error == temp,
 326             "received: " << CKMCReadableError(temp) << " while expected: " << CKMCReadableError(expected_error));
 327     if(expected_type != CKMC_KEY_NONE)
 328     {
 329         RUNNER_ASSERT_MSG(
 330                 test_key->key_type == expected_type,
 331                 "received type: " << test_key->key_type << " while expected type: " << expected_type);
 332     }
 333     ckmc_key_free(test_key);
 334 }
 335 void check_key_allowed(const char *alias, ckmc_key_type_e expected_type)
 336 {
 337     check_key(alias, CKMC_ERROR_NONE, expected_type);
 338 }
 339 void check_key_not_visible(const char *alias)
 340 {
 341     check_key(alias, CKMC_ERROR_DB_ALIAS_UNKNOWN);
 342 }
 343 void check_cert_allowed(const char *alias)
 344 {
 345     ckmc_cert_s *test_cert = NULL;
 346     int temp = ckmc_get_cert(alias, 0, &test_cert);
 347     ckmc_cert_free(test_cert);
 348     RUNNER_ASSERT_MSG(CKMC_ERROR_NONE == temp, CKMCReadableError(temp));
 349
 350 }
 351 void check_cert_not_visible(const char *alias)
 352 {
 353     ckmc_cert_s *test_cert = NULL;
 354     int temp = ckmc_get_cert(alias, 0, &test_cert);
 355     ckmc_cert_free(test_cert);
 356     RUNNER_ASSERT_MSG(CKMC_ERROR_DB_ALIAS_UNKNOWN == temp,
 357                       "App with different label shouldn't have rights to see this cert. " << CKMCErrorToString(temp));
 358 }
 359
 360 void allow_access(const char* alias, const char* accessor, int permissionMask)
 361 {
 362     // data removal should revoke this access
 363     int ret = ckmc_set_permission(alias, accessor, permissionMask);
 364     RUNNER_ASSERT_MSG(CKMC_ERROR_NONE == ret, "Trying to allow access returned: "
 365                         << CKMCErrorToString(ret));
 366 }
 367
 368 void allow_access_negative(const char* alias, const char* accessor, int permissionMask, int expectedCode)
 369 {
 370     // data removal should revoke this access
 371     int ret = ckmc_set_permission(alias, accessor, permissionMask);
 372     RUNNER_ASSERT_MSG(expectedCode == ret, "Trying to allow access returned "
 373                         << CKMCErrorToString(ret) << ", while expected: "
 374                         << CKMCErrorToString(expectedCode));
 375 }
 376
 377 void deny_access(const char* alias, const char* accessor)
 378 {
 379     int ret = ckmc_set_permission(alias, accessor, CKMC_PERMISSION_NONE);
 380     RUNNER_ASSERT_MSG(CKMC_ERROR_NONE == ret, "Denying access failed. Error: "
 381                         << CKMCErrorToString(ret));
 382 }
 383
 384 void deny_access_negative(const char* alias, const char* accessor, int expectedCode)
 385 {
 386     int ret = ckmc_set_permission(alias, accessor, CKMC_PERMISSION_NONE);
 387     RUNNER_ASSERT_MSG(expectedCode == ret, "Denying access failed. "
 388                         << CKMCErrorToString(ret) << ", while expected: "
 389                         << CKMCErrorToString(expectedCode));
 390 }
 391
 392 void unlock_user_data(uid_t user_id, const char *passwd)
 393 {
 394     int ret;
 395     auto control = CKM::Control::create();
 396     RUNNER_ASSERT_MSG(CKM_API_SUCCESS == (ret = control->unlockUserKey(user_id, passwd)),
 397                       "Error=" << CKM::ErrorToString(ret));
 398 }
 399
 400 void remove_user_data(uid_t user_id)
 401 {
 402     auto control = CKM::Control::create();
 403     control->lockUserKey(user_id);
 404     control->removeUserData(user_id);
 405 }
 406
 407 void reset_user_data(uid_t user_id, const char *passwd)
 408 {
 409     remove_user_data(user_id);
 410     unlock_user_data(user_id, passwd);
 411 }
 412
 413 ckmc_raw_buffer_s prepare_message_buffer(const char * input)
 414 {
 415     ckmc_raw_buffer_s retval;
 416     retval.data = const_cast<unsigned char *>(reinterpret_cast<const unsigned char *>(input));
 417     retval.size = strlen(input);
 418     return retval;
 419 }
 420
 421 void check_alias_list(const CKM::AliasVector& expected)
 422 {
 423     ckmc_alias_list_s *aliasList = NULL;
 424     int ret = ckmc_get_data_alias_list(&aliasList);
 425     RUNNER_ASSERT_MSG(ret == 0, "Failed to get the list of data aliases. " << ret << " / " << CKMCErrorToString(ret));
 426
 427     CKM::AliasVector actual;
 428     ckmc_alias_list_s *plist = aliasList;
 429     while(plist)
 430     {
 431         actual.push_back(plist->alias);
 432         plist = plist->next;
 433     }
 434     ckmc_alias_list_all_free(aliasList);
 435
 436     RUNNER_ASSERT_MSG(expected == actual, "Actual list of aliases differ from expected list.");
 437 }
 438
 439 size_t count_aliases(alias_type_ type, size_t minimum_initial_element_count)
 440 {
 441     ckmc_alias_list_s *aliasList = NULL;
 442     int ec;
 443     switch(type)
 444     {
 445         case ALIAS_KEY:
 446             ec = ckmc_get_key_alias_list(&aliasList);
 447             break;
 448
 449         case ALIAS_CERT:
 450             ec = ckmc_get_cert_alias_list(&aliasList);
 451             break;
 452
 453         case ALIAS_DATA:
 454             ec = ckmc_get_data_alias_list(&aliasList);
 455             break;
 456         default:
 457             RUNNER_ASSERT_MSG(false, "Unsupported value ALIAS_KEY == " << (int)type);
 458     }
 459
 460     if(ec == CKMC_ERROR_DB_ALIAS_UNKNOWN)
 461         return 0;
 462
 463     RUNNER_ASSERT_MSG(ec == CKMC_ERROR_NONE,
 464                       "Error: alias list failed, ec: " << CKMCErrorToString(ec));
 465
 466     ckmc_alias_list_s *plist = aliasList;
 467     size_t return_count = 0;
 468     while(plist)
 469     {
 470         plist = plist->next;
 471         return_count ++;
 472     }
 473     ckmc_alias_list_all_free(aliasList);
 474
 475     RUNNER_ASSERT_MSG(
 476       return_count >= minimum_initial_element_count,
 477       "Error: alias list failed, current element count: " << return_count <<
 478       " while expected minimal count of " << minimum_initial_element_count <<
 479       " elements");
 480
 481     return return_count;
 482 }
 483
 484 std::string sharedDatabase(const CKM::Alias & alias)
 485 {
 486     return aliasWithLabel(ckmc_label_shared_owner, alias.c_str());
 487 }
 488
 489 ckmc_raw_buffer_s* createRandomBufferCAPI(size_t random_bytes)
 490 {
 491     ckmc_raw_buffer_s* buffer = NULL;
 492     char* data = static_cast<char*>(malloc(random_bytes*sizeof(char)));
 493     RUNNER_ASSERT(data);
 494     generate_random(random_bytes, data);
 495     int ret = ckmc_buffer_new(reinterpret_cast<unsigned char*>(data), random_bytes, &buffer);
 496     RUNNER_ASSERT_MSG(ret == CKMC_ERROR_NONE, "Buffer creation failed: " << CKMCErrorToString(ret));
 497     return buffer;
 498 }
 499
 500 CKM::RawBuffer createRandomBuffer(size_t random_bytes)
 501 {
 502     char buffer[random_bytes];
 503     generate_random(random_bytes, buffer);
 504     return CKM::RawBuffer(buffer, buffer + random_bytes);
 505 }
 506
 507 ckmc_key_s *generate_AES_key(size_t lengthBits, const char *passwd)
 508 {
 509     ckmc_key_s *retval = reinterpret_cast<ckmc_key_s *>(malloc(sizeof(ckmc_key_s)));
 510     RUNNER_ASSERT(retval != NULL);
 511
 512     RUNNER_ASSERT(lengthBits%8 == 0);
 513     char *char_key_AES = reinterpret_cast<char*>(malloc(lengthBits/8));
 514     RUNNER_ASSERT(char_key_AES != NULL);
 515     generate_random(lengthBits/8, char_key_AES);
 516
 517     retval->raw_key  = reinterpret_cast<unsigned char *>(char_key_AES);
 518     retval->key_size = lengthBits/8;
 519     retval->key_type = CKMC_KEY_AES;
 520     retval->password = passwd?strdup(passwd):NULL;
 521
 522     return retval;
 523 }
 524
 525 void validate_AES_key(ckmc_key_s *analyzed)
 526 {
 527     RUNNER_ASSERT_MSG(analyzed, "provided key is NULL");
 528     RUNNER_ASSERT_MSG(analyzed->raw_key != NULL, "provided key is empty");
 529     RUNNER_ASSERT_MSG(analyzed->key_size==(128/8) ||
 530                       analyzed->key_size==(192/8) ||
 531                       analyzed->key_size==(256/8), "provided key length is invalid");
 532     RUNNER_ASSERT_MSG(analyzed->key_type = CKMC_KEY_AES, "expected AES key, while got: " << analyzed->key_type);
 533 }
 534
 535 void compare_AES_keys(ckmc_key_s *first, ckmc_key_s *second)
 536 {
 537     validate_AES_key(first);
 538     validate_AES_key(second);
 539     RUNNER_ASSERT_MSG(
 540         (first->key_size==second->key_size) &&
 541         (memcmp(first->raw_key, second->raw_key, first->key_size)==0),
 542         "data has been modified in key manager");
 543     // bypassing password intentionally
 544 }
 545
 546 ParamListPtr createParamListPtr()
 547 {
 548     ckmc_param_list_s* list = NULL;
 549     assert_positive(ckmc_param_list_new, &list);
 550     return ParamListPtr(list, ckmc_param_list_free);
 551 }
 552
 553 void assert_buffers_equal(const ckmc_raw_buffer_s b1, const ckmc_raw_buffer_s b2, bool equal)
 554 {
 555     if(equal) {
 556         RUNNER_ASSERT_MSG(b1.size == b2.size, "Buffer size differs: " << b1.size << "!=" << b2.size);
 557         RUNNER_ASSERT_MSG(0 == memcmp(b1.data, b2.data, b1.size), "Buffer contents differ");
 558     } else {
 559         RUNNER_ASSERT_MSG(b1.size != b2.size || 0 != memcmp(b1.data, b2.data, b1.size),
 560                           "Buffers should be different");
 561     }
 562 }
 563
 564 RawBufferPtr create_raw_buffer(ckmc_raw_buffer_s* buffer)
 565 {
 566     return RawBufferPtr(buffer, ckmc_buffer_free);
 567 }