2 * Copyright (c) 2000-2020 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
18 * @author Krzysztof Jackiewicz (k.jackiewicz@samsung.com)
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 <ckmc/ckmc-manager.h>
32 #include <tests_common.h>
33 #include <sys/types.h>
35 extern const std::string SMACK_USER_APP_PREFIX;
36 extern const char *SYSTEM_LABEL;
37 extern const char *TEST_LABEL;
38 extern const char *TEST_LABEL_2;
39 extern const char *TEST_LABEL_3;
40 extern const char *TEST_LABEL_4;
41 extern const char *TEST_LABEL_5;
43 // support for error printing
44 const char * CKMCErrorToString(int error);
45 std::string CKMCReadableError(int error);
47 // RUNNER_ASSERT wrappers
48 template <typename F, typename... Args>
49 void assert_result(int expected, F&& func, Args... args)
51 int ret = func(args...);
52 RUNNER_ASSERT_MSG(ret == expected,
53 "Expected: " << CKMCErrorToString(expected) << "(" << expected << ")"
54 " got: " << CKMCErrorToString(ret) << "(" << ret << ")");
57 template <typename F, typename... Args>
58 void assert_positive(F&& func, Args... args)
60 assert_result(CKMC_ERROR_NONE, std::move(func), args...);
63 template <typename F, typename... Args>
64 void assert_invalid_param(F&& func, Args... args)
66 assert_result(CKMC_ERROR_INVALID_PARAMETER, std::move(func), args...);
72 size_t list_size(const T* list)
82 std::string getLabel();
83 // returns process owner id
84 std::string getOwnerIdFromSelf();
86 std::string aliasWithLabel(const char *label, const char *alias);
88 std::string aliasWithLabelFromSelf(const char *alias);
90 void save_data(const char* alias, const char *data, size_t len, const char* password,
91 int expected_err = CKMC_ERROR_NONE, bool exportable = true);
92 void save_data(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE,
93 bool exportable = true);
94 void save_data(const char* alias, const char *data, size_t len,
95 int expected_err = CKMC_ERROR_NONE, bool exportable = true);
99 ScopedSaveData(const char* alias, const char *data, int expected_err = CKMC_ERROR_NONE);
100 virtual ~ScopedSaveData();
109 ScopedDBUnlock(uid_t user_id, const char* passwd);
110 virtual ~ScopedDBUnlock();
116 void check_remove_allowed(const char* alias);
117 void check_remove_denied(const char* alias);
118 void check_remove_not_visible(const char* alias);
119 void check_read(const char* alias,
121 const char *test_data,
123 int expected_code = CKMC_ERROR_NONE);
124 void check_read(const char* alias,
126 const char *test_data,
127 int expected_code = CKMC_ERROR_NONE);
128 void check_read_allowed(const char* alias, const char *data);
129 void check_read_not_visible(const char* alias);
130 void check_key(const char *alias,
131 int expected_error = CKMC_ERROR_NONE,
132 ckmc_key_type_e expected_type = CKMC_KEY_NONE);
133 void check_key_allowed(const char *alias, ckmc_key_type_e expected_type = CKMC_KEY_NONE);
134 void check_key_not_visible(const char *alias);
135 void check_cert_allowed(const char *alias);
136 void check_cert_not_visible(const char *alias);
137 void allow_access(const char* alias, const char* accessor, int permissionMask);
138 void allow_access_negative(const char* alias, const char* accessor, int permissionMask, int expectedCode);
139 void deny_access(const char* alias, const char* accessor);
140 void deny_access_negative(const char* alias, const char* accessor, int expectedCode);
142 void unlock_user_data(uid_t user_id, const char *passwd);
143 void remove_user_data(uid_t user_id);
144 void reset_user_data(uid_t user_id, const char *passwd);
146 ckmc_raw_buffer_s prepare_message_buffer(const char * input);
147 void check_alias_list(const CKM::AliasVector& expected);
150 Info(const CKM::Alias &alias,
151 bool passwordProtected,
152 CKM::BackendId backend = CKM::BackendId::SW) :
154 passwordProtected(passwordProtected),
158 bool passwordProtected;
159 CKM::BackendId backend;
161 typedef std::vector<Info> InfoVector;
162 typedef std::unordered_map<std::string, Info> InfoMap;
164 CKM::BackendId backend();
166 void check_alias_info_list_helper(const InfoVector& expected,
167 const InfoMap& actual,
168 const std::string &userSmackLabel = {});
169 void check_alias_info_list(const InfoVector& expected);
176 size_t count_aliases(alias_type_ type, size_t minimum_initial_element_count = 0);
177 std::string sharedDatabase(const CKM::Alias & alias);
178 CKM::RawBuffer createRandomBuffer(size_t random_bytes);
179 ckmc_raw_buffer_s* createRandomBufferCAPI(size_t random_bytes);
181 ckmc_key_s *generate_AES_key(size_t lengthBits, const char *passwd);
182 void validate_AES_key(ckmc_key_s *analyzed);
183 void compare_AES_keys(ckmc_key_s *first, ckmc_key_s *second); // true if equal
184 CKM::Policy generate_ckm_policy(int iterator_nr); // generates policy based on given number
186 // Test env class for database cleanup. Pass database uids to cleanup before and after test
187 template <uid_t ...Args>
191 class RemoveDataEnv<>
194 void init(const std::string&)
200 template <uid_t UID, uid_t ...Args>
201 class RemoveDataEnv<UID, Args...> : public RemoveDataEnv<Args...>
204 void init(const std::string & str) {
205 remove_user_data(UID);
206 RemoveDataEnv<Args...>::init(str);
209 RemoveDataEnv<Args...>::finish();
210 remove_user_data(UID);
214 typedef std::shared_ptr<ckmc_raw_buffer_s> RawBufferPtr;
215 typedef std::shared_ptr<struct __ckmc_param_list> ParamListPtr;
216 typedef std::shared_ptr<struct __ckmc_cipher_ctx> CipherCtxPtr;
218 ParamListPtr createParamListPtr();
219 void setParam(ParamListPtr& params, ckmc_param_name_e name, ckmc_raw_buffer_s* buffer);
220 void setParam(ParamListPtr& params, ckmc_param_name_e name, uint64_t integer);
222 void assert_buffers_equal(const ckmc_raw_buffer_s* b1, const ckmc_raw_buffer_s* b2, bool equal=true);
224 RawBufferPtr create_raw_buffer(ckmc_raw_buffer_s* buffer);
226 CipherCtxPtr create_cipher_ctx(ckmc_cipher_ctx_h ctx);
229 template <typename F, typename... Args>
230 void test_no_observer(F&& func, Args... args)
232 CKM::ManagerAsync::ObserverPtr obs;
233 CKM::ManagerAsync mgr;
236 (mgr.*func)(obs, args...);
237 RUNNER_ASSERT_MSG(false, "function() should have thrown an exception");
238 } catch (const std::invalid_argument& e) {
241 RUNNER_ASSERT_MSG(false, "Unexpected exception");
248 AliasRemover(const char* alias) : alias(alias) {}
250 ckmc_remove_alias(alias);
253 AliasRemover(AliasRemover&& other) {
255 other.alias = nullptr;
258 AliasRemover& operator=(AliasRemover&& other) {
263 other.alias = nullptr;
270 void require_default_user(char *argv[]);