src/common/include/smack-labels.h

   1 /*
   2  *  Copyright (c) 2014 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  *  Contact: Rafal Krypa <r.krypa@samsung.com>
   5  *
   6  *  Licensed under the Apache License, Version 2.0 (the "License");
   7  *  you may not use this file except in compliance with the License.
   8  *  You may obtain a copy of the License at
   9  *
  10  *      http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  *  Unless required by applicable law or agreed to in writing, software
  13  *  distributed under the License is distributed on an "AS IS" BASIS,
  14  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  *  See the License for the specific language governing permissions and
  16  *  limitations under the License
  17  */
  18 /**
  19  * @file        smack-labels.h
  20  * @author      Jan Cybulski <j.cybulski@samsung.com>
  21  * @author      Rafal Krypa <r.krypa@samsung.com>
  22  * @version     1.0
  23  * @brief       Header file of functions managing smack labels
  24  *
  25  */
  26 #ifndef _SMACK_LABELS_H_
  27 #define _SMACK_LABELS_H_
  28
  29 #include <string>
  30 #include <utility>
  31
  32 #include "security-manager.h"
  33
  34 namespace SecurityManager {
  35
  36 /**
  37  * Sets Smack labels on a directory and its contents, recursively.
  38  *
  39  * @param appId[in] application's identifier
  40  * @param path[in] path to a file or directory to setup
  41  * @param pathType[in] type of path to setup. See description of
  42  *         app_install_path_type in security-manager.h for details
  43  *
  44  * @return true on success, false on error.
  45  */
  46 bool setupPath(const std::string &appId, const std::string &path,
  47     app_install_path_type pathType);
  48
  49 /**
  50  * Generates application name for a label fetched from Cynara
  51  *
  52  * @param[in] label string to fetch application name for
  53  * @return application name on success, empty string on error.
  54 */
  55 std::string generateAppNameFromLabel(const std::string &label);
  56
  57 /**
  58  * Sets Smack labels on a <ROOT_APP>/<pkg_id> and <ROOT_APP>/<pkg_id>/<app_id>
  59  * non-recursively
  60  *
  61  * @param pkgID[in] package identifier
  62  * @param appID[in] application's identifier
  63  * @param path[in] <ROOT_APP> path
  64  */
  65 bool setupCorrectPath(const std::string &pkgID, const std::string &appID,
  66         const std::string &path);
  67
  68 /**
  69  * Generates label for an application with a specific application ID
  70  * read from @ref appId and assigns it to @ref label.
  71  *
  72  * @param[in] appId application's identifier
  73  * @param[out] label string in which application's label will be stored
  74  * @return true on success, false on error.
  75 */
  76 bool generateAppLabel(const std::string &appId, std::string &label);
  77 /**
  78  * Generates label for an application with a package ID
  79  * read from @ref appPkgId and assigns it to @ref label.
  80  *
  81  * @param[in] pkgId
  82  * @param[out] label
  83  * @return true on success, false on error.
  84  */
  85 bool generatePkgLabel(const std::string &pkgId, std::string &label);
  86 } // namespace SecurityManager
  87
  88 #endif /* _SMACK_LABELS_H_ */