2 * security-manager, database access
4 * Copyright (c) 2000 - 2014 Samsung Electronics Co., Ltd All Rights Reserved
6 * Contact: Rafal Krypa <r.krypa@samsung.com>
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
23 * @file privilege_db.h
24 * @author Krzysztof Sasiak <k.sasiak@samsung.com>
25 * @author Rafal Krypa <r.krypa@samsung.com>
27 * @brief This file contains declaration of the API to privilges database.
36 #include <dpl/db/sql_connection.h>
37 #include <tzplatform_config.h>
39 #ifndef PRIVILEGE_DB_H_
40 #define PRIVILEGE_DB_H_
42 namespace SecurityManager {
44 const char *const PRIVILEGE_DB_PATH = tzplatform_mkpath(TZ_SYS_DB, ".security-manager.db");
46 enum class QueryType {
59 * PrivilegeDb database class
63 SecurityManager::DB::SqlConnection *mSqlConnection;
64 const std::map<QueryType, const char * const > Queries = {
65 { QueryType::EGetPkgPrivileges, "SELECT DISTINCT privilege_name FROM app_privilege_view WHERE pkg_name=? AND uid=? ORDER BY privilege_name"},
66 { QueryType::EAddApplication, "INSERT INTO app_pkg_view (app_name, pkg_name, uid) VALUES (?, ?, ?)" },
67 { QueryType::ERemoveApplication, "DELETE FROM app_pkg_view WHERE app_name=? AND uid=?" },
68 { QueryType::EAddAppPrivileges, "INSERT INTO app_privilege_view (app_name, uid, privilege_name) VALUES (?, ?, ?)" },
69 { QueryType::ERemoveAppPrivileges, "DELETE FROM app_privilege_view WHERE app_name=? AND uid=?" },
70 { QueryType::EPkgIdExists, "SELECT * FROM pkg WHERE name=?" },
71 { QueryType::EGetPkgId, " SELECT pkg_name FROM app_pkg_view WHERE app_name = ?" },
72 { QueryType::EGetPrivilegeGroups, " SELECT name FROM privilege_group_view WHERE privilege_name = ?" },
76 * Check if pkgId is already registered in database
78 * @param pkgId - package identifier
79 * @exception DB::SqlConnection::Exception::InternalError on internal error
80 * @return true if pkgId exists in the database
83 bool PkgIdExists(const std::string &pkgId);
89 DECLARE_EXCEPTION_TYPE(SecurityManager::Exception, Base)
90 DECLARE_EXCEPTION_TYPE(Base, IOError)
91 DECLARE_EXCEPTION_TYPE(Base, InternalError)
96 * @exception DB::SqlConnection::Exception::IOError on problems with database access
99 PrivilegeDb(const std::string &path = std::string(PRIVILEGE_DB_PATH));
105 * @exception DB::SqlConnection::Exception::InternalError on internal error
108 void BeginTransaction(void);
112 * @exception DB::SqlConnection::Exception::InternalError on internal error
115 void CommitTransaction(void);
118 * Rollback transaction
119 * @exception DB::SqlConnection::Exception::InternalError on internal error
122 void RollbackTransaction(void);
125 * Return package id associated with a given application id
127 * @param appId - application identifier
128 * @param[out] pkgId - return application's pkgId
129 * @return true is application exists, false otherwise
130 * @exception DB::SqlConnection::Exception::InternalError on internal error
132 bool GetAppPkgId(const std::string &appId, std::string &pkgId);
135 * Retrieve list of privileges assigned to a pkgId
137 * @param pkgId - package identifier
138 * @param uid - user identifier for whom privileges will be retrieved
139 * @param[out] currentPrivileges - list of current privileges assigned to pkgId
140 * @exception DB::SqlConnection::Exception::InternalError on internal error
142 void GetPkgPrivileges(const std::string &pkgId, uid_t uid,
143 std::vector<std::string> ¤tPrivilege);
146 * Add an application into the database
148 * @param appId - application identifier
149 * @param pkgId - package identifier
150 * @param uid - user identifier for whom application is going to be installed
151 * @param[out] pkgIdIsNew - return info if pkgId is new to the database
152 * @exception DB::SqlConnection::Exception::InternalError on internal error
154 void AddApplication(const std::string &appId, const std::string &pkgId,
155 uid_t uid, bool &pkgIdIsNew);
158 * Remove an application from the database
160 * @param appId - application identifier
161 * @param uid - user identifier whose application is going to be uninstalled
162 * @param[out] pkgIdIsNoMore - return info if pkgId is in the database
163 * @exception DB::SqlConnection::Exception::InternalError on internal error
165 void RemoveApplication(const std::string &appId, uid_t uid, bool &pkgIdIsNoMore);
168 * Remove privileges assigned to application
170 * @param appId - application identifier
171 * @param uid - user identifier for whom privileges will be removed
172 * @exception DB::SqlConnection::Exception::InternalError on internal error
174 void RemoveAppPrivileges(const std::string &appId, uid_t uid);
177 * Update privileges assigned to application
178 * To assure data integrity this method must be called inside db transaction.
180 * @param appId - application identifier
181 * @param uid - user identifier for whom privileges will be updated
182 * @param privileges - list of privileges to assign
183 * @exception DB::SqlConnection::Exception::InternalError on internal error
185 void UpdateAppPrivileges(const std::string &appId, uid_t uid,
186 const std::vector<std::string> &privileges);
189 * Retrieve list of group ids assigned to a privilege
191 * @param privilege - privilege identifier
192 * @param[out] grp_names - list of group names assigned to the privilege
193 * @exception DB::SqlConnection::Exception::InternalError on internal error
195 void GetPrivilegeGroups(const std::string &privilege,
196 std::vector<std::string> &grp_names);
200 } //namespace SecurityManager
202 #endif // PRIVILEGE_DB_H_