src/ckm/ckm-common.h

   1 /*
   2  *  Copyright (c) 2000-2020 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.h
  18  * @author     Krzysztof Jackiewicz (k.jackiewicz@samsung.com)
  19  * @version    1.0
  20  */
  21
  22 #pragma once
  23
  24 #include <string>
  25 #include <memory>
  26 #include <stdexcept>
  27 #include <ckm/ckm-type.h>
  28 #include <ckm/ckm-manager-async.h>
  29 #include <ckmc/ckmc-type.h>
  30 #include <ckmc/ckmc-error.h>
  31 #include <tests_common.h>
  32 #include <sys/types.h>
  33
  34 extern const std::string SMACK_USER_APP_PREFIX;
  35 extern const char *SYSTEM_LABEL;
  36 extern const char *TEST_LABEL;
  37 extern const char *TEST_LABEL_2;
  38 extern const char *TEST_LABEL_3;
  39 extern const char *TEST_LABEL_4;
  40 extern const char *TEST_LABEL_5;
  41
  42 // support for error printing
  43 const char * CKMCErrorToString(int error);
  44 std::string CKMCReadableError(int error);
  45
  46 // RUNNER_ASSERT wrappers
  47 template <typename F, typename... Args>
  48 void assert_result(int expected, F&& func, Args... args)
  49 {
  50     int ret = func(args...);
  51     RUNNER_ASSERT_MSG(ret == expected,
  52                       "Expected: " << CKMCErrorToString(expected) << "(" << expected << ")"
  53                       " got: " << CKMCErrorToString(ret) << "(" << ret << ")");
  54 }
  55
  56 template <typename F, typename... Args>
  57 void assert_positive(F&& func, Args... args)
  58 {
  59     assert_result(CKMC_ERROR_NONE, std::move(func), args...);
  60 }
  61
  62 template <typename F, typename... Args>
  63 void assert_invalid_param(F&& func, Args... args)
  64 {
  65     assert_result(CKMC_ERROR_INVALID_PARAMETER, std::move(func), args...);
  66 }
  67
  68
  69 // list operations
  70 template <typename T>
  71 size_t list_size(const T* list)
  72 {
  73     size_t size = 0;
  74     while(list) {
  75         list = list->next;
  76         size++;
  77     }
  78     return size;
  79 }
  80
  81 std::string getLabel();
  82 // returns process owner id
  83 std::string getOwnerIdFromSelf();
  84
  85 std::string aliasWithLabel(const char *label, const char *alias);
  86
  87 std::string aliasWithLabelFromSelf(const char *alias);
  88
  89 void save_data(const char* alias, const char *data, size_t len, const char* password,
  90                int expected_err = CKMC_ERROR_NONE, bool exportable = true);
  91 void save_data(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE,
  92                bool exportable = true);
  93 void save_data(const char* alias, const char *data, size_t len,
  94                int expected_err = CKMC_ERROR_NONE, bool exportable = true);
  95 class ScopedSaveData
  96 {
  97 public:
  98     ScopedSaveData(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE);
  99     virtual ~ScopedSaveData();
 100
 101 private:
 102     std::string m_alias;
 103 };
 104
 105 class ScopedDBUnlock
 106 {
 107 public:
 108     ScopedDBUnlock(uid_t user_id, const char* passwd);
 109     virtual ~ScopedDBUnlock();
 110
 111 private:
 112     uid_t m_uid;
 113 };
 114
 115 void check_remove_allowed(const char* alias);
 116 void check_remove_denied(const char* alias);
 117 void check_remove_not_visible(const char* alias);
 118 void check_read(const char* alias,
 119                 const char *label,
 120                 const char *test_data,
 121                 size_t len,
 122                 int expected_code = CKMC_ERROR_NONE);
 123 void check_read(const char* alias,
 124                 const char *label,
 125                 const char *test_data,
 126                 int expected_code = CKMC_ERROR_NONE);
 127 void check_read_allowed(const char* alias, const char *data);
 128 void check_read_not_visible(const char* alias);
 129 void check_key(const char *alias,
 130                int expected_error = CKMC_ERROR_NONE,
 131                ckmc_key_type_e expected_type = CKMC_KEY_NONE);
 132 void check_key_allowed(const char *alias, ckmc_key_type_e expected_type = CKMC_KEY_NONE);
 133 void check_key_not_visible(const char *alias);
 134 void check_cert_allowed(const char *alias);
 135 void check_cert_not_visible(const char *alias);
 136 void allow_access(const char* alias, const char* accessor, int permissionMask);
 137 void allow_access_negative(const char* alias, const char* accessor, int permissionMask, int expectedCode);
 138 void deny_access(const char* alias, const char* accessor);
 139 void deny_access_negative(const char* alias, const char* accessor, int expectedCode);
 140
 141 void unlock_user_data(uid_t user_id, const char *passwd);
 142 void remove_user_data(uid_t user_id);
 143 void reset_user_data(uid_t user_id, const char *passwd);
 144
 145 ckmc_raw_buffer_s prepare_message_buffer(const char * input);
 146 void check_alias_list(const CKM::AliasVector& expected);
 147 void check_alias_info_list_helper(const CKM::AliasPwdVector& expected, const CKM::AliasPwdVector& actual,
 148                                   const std::string &userSmackLabel = {});
 149 void check_alias_info_list(const CKM::AliasPwdVector& expected);
 150
 151 typedef enum {
 152     ALIAS_KEY,
 153     ALIAS_CERT,
 154     ALIAS_DATA
 155 } alias_type_;
 156 size_t count_aliases(alias_type_ type, size_t minimum_initial_element_count = 0);
 157 std::string sharedDatabase(const CKM::Alias & alias);
 158 CKM::RawBuffer createRandomBuffer(size_t random_bytes);
 159 ckmc_raw_buffer_s* createRandomBufferCAPI(size_t random_bytes);
 160
 161 ckmc_key_s *generate_AES_key(size_t lengthBits, const char *passwd);
 162 void validate_AES_key(ckmc_key_s *analyzed);
 163 void compare_AES_keys(ckmc_key_s *first, ckmc_key_s *second); // true if equal
 164 CKM::Policy generate_ckm_policy(int iterator_nr); // generates policy based on given number
 165
 166 // Test env class for database cleanup. Pass database uids to cleanup before and after test
 167 template <uid_t ...Args>
 168 class RemoveDataEnv;
 169
 170 template <>
 171 class RemoveDataEnv<>
 172 {
 173 public:
 174     void init(const std::string&)
 175     {}
 176     void finish()
 177     {}
 178 };
 179
 180 template <uid_t UID, uid_t ...Args>
 181 class RemoveDataEnv<UID, Args...> : public RemoveDataEnv<Args...>
 182 {
 183 public:
 184     void init(const std::string & str) {
 185         remove_user_data(UID);
 186         RemoveDataEnv<Args...>::init(str);
 187     }
 188     void finish() {
 189         RemoveDataEnv<Args...>::finish();
 190         remove_user_data(UID);
 191     }
 192 };
 193
 194 typedef std::shared_ptr<ckmc_raw_buffer_s> RawBufferPtr;
 195 typedef std::shared_ptr<struct __ckmc_param_list> ParamListPtr;
 196
 197 ParamListPtr createParamListPtr();
 198 void setParam(ParamListPtr& params, ckmc_param_name_e name, ckmc_raw_buffer_s* buffer);
 199 void setParam(ParamListPtr& params, ckmc_param_name_e name, uint64_t integer);
 200
 201 void assert_buffers_equal(const ckmc_raw_buffer_s* b1, const ckmc_raw_buffer_s* b2, bool equal=true);
 202
 203 RawBufferPtr create_raw_buffer(ckmc_raw_buffer_s* buffer);
 204
 205
 206 template <typename F, typename... Args>
 207 void test_no_observer(F&& func, Args... args)
 208 {
 209     CKM::ManagerAsync::ObserverPtr obs;
 210     CKM::ManagerAsync mgr;
 211
 212     try {
 213         (mgr.*func)(obs, args...);
 214         RUNNER_ASSERT_MSG(false, "function() should have thrown an exception");
 215     } catch (const std::invalid_argument& e) {
 216         RUNNER_ASSERT(true);
 217     } catch (...) {
 218         RUNNER_ASSERT_MSG(false, "Unexpected exception");
 219     }
 220 }