ace_install/include/ace_api_install.h

   1 /*
   2  * Copyright (c) 2011 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        ace_api_setup.h
  18  * @author      Tomasz Swierczek (t.swierczek@samsung.com)
  19  * @version     1.0
  20  * @brief       This is C api for Access Control Engine (ACE), installer mode
  21  *              (RW part).
  22  *
  23  */
  24
  25 #ifndef ACE_API_H
  26 #define ACE_API_H
  27
  28 #include <ace_api_common.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /*
  35  * API defined in this header should be used only from one thread. If used
  36  * otherwise, unexpected behaviour may occur, including segmentation faults and
  37  * escalation of global warming. Be warned.
  38  */
  39
  40 // --------------- Initialization and policy update ----------------------------
  41
  42 /*
  43  * Initializes ACE - connects (RW) to the database. Must be called only once.
  44  * Returns ACE_OK or error
  45  */
  46 ace_return_t ace_install_initialize(void);
  47
  48 /*
  49  * Deinitializes ACE - deinitialize internal structures, detach DB, etc.
  50  * Must be called only once.
  51  * Returns ACE_OK or error
  52  */
  53 ace_return_t ace_install_shutdown(void);
  54
  55 /*
  56  * Updates policy - parses XML files from known locations (reason for no arguments),
  57  * also clears policy and prompt caches.
  58  * Returns ACE_OK or error
  59  */
  60 ace_return_t ace_update_policy(void);
  61
  62 // --------------- Requested device capabilities API for installer -------------
  63
  64 typedef struct
  65 {
  66     ace_string_t   device_capability;
  67     ace_bool_t     smack_granted;
  68 } ace_requested_dev_cap_t;
  69
  70 typedef struct
  71 {
  72     ace_size_t              count;
  73     ace_requested_dev_cap_t*  items;
  74 } ace_requested_dev_cap_list_t;
  75
  76 /*
  77  * Deletes data allocated by ace_get_requested_dev_caps - a helper function
  78  */
  79 ace_return_t ace_free_requested_dev_caps(ace_requested_dev_cap_list_t* caps);
  80
  81 /*
  82  * Returns ACE_OK or error; 'caps' will hold device capabilities information.
  83  * To free allcated resources in 'caps', use ace_free_requested_dev_caps
  84  */
  85 ace_return_t ace_get_requested_dev_caps(ace_widget_handle_t handle,
  86                                         ace_requested_dev_cap_list_t* caps);
  87
  88 /*
  89  * Returns error or ACE_OK
  90  */
  91 ace_return_t ace_set_requested_dev_caps(ace_widget_handle_t handle,
  92                                         const ace_requested_dev_cap_list_t* caps);
  93
  94 // ---------------- Accepted Api featuresk API for installer ----------------
  95
  96
  97 ace_return_t ace_set_accepted_feature(ace_widget_handle_t handle,
  98                                       const ace_feature_list_t* flist);
  99
 100 ace_return_t ace_rem_accepted_feature(ace_widget_handle_t handle);
 101
 102 // --------------- Widget data setup for installation --------------------------
 103
 104 typedef enum
 105 {
 106     WAC20 = 0,
 107     Tizen
 108 } ace_widget_type_t;
 109
 110 /*
 111  * Sets widget type. Use in installer to determine which policy will be used
 112  * by ACE for this widget.
 113  * Returns error or ACE_OK
 114  */
 115 ace_return_t ace_set_widget_type(ace_widget_handle_t handle,
 116                                  ace_widget_type_t type);
 117
 118 /*
 119  * Gets widget type in 'type'. Use in installer to determine which policy will be used
 120  * by ACE for this widget.
 121  * Returns error or ACE_OK
 122  */
 123 ace_return_t ace_get_widget_type(ace_widget_handle_t handle,
 124                                  ace_widget_type_t* type);
 125
 126 // --------------- Installation time policy check ------------------------------
 127
 128 typedef enum
 129 {
 130     ACE_PERMIT,
 131     ACE_DENY,
 132     ACE_PROMPT,
 133     ACE_UNDEFINED
 134 } ace_policy_result_t;
 135
 136 /*
 137  * Gets current policy evaluation for given device capability and given widget.
 138  * Returns error or ACE_OK
 139  */
 140 ace_return_t ace_get_policy_result(const ace_resource_t,
 141                                    ace_widget_handle_t handle,
 142                                    ace_policy_result_t* result);
 143
 144 #ifdef __cplusplus
 145 }
 146 #endif
 147
 148 #endif // ACE_API_H