src/policy-deny.c

   1 /*
   2  * Copyright © 2020 Collabora, Ltd.
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining
   5  * a copy of this software and associated documentation files (the
   6  * "Software"), to deal in the Software without restriction, including
   7  * without limitation the rights to use, copy, modify, merge, publish,
   8  * distribute, sublicense, and/or sell copies of the Software, and to
   9  * permit persons to whom the Software is furnished to do so, subject to
  10  * the following conditions:
  11  *
  12  * The above copyright notice and this permission notice (including the
  13  * next paragraph) shall be included in all copies or substantial
  14  * portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include "ivi-compositor.h"
  27 #include "policy.h"
  28
  29 #include <string.h>
  30 #include "shared/helpers.h"
  31
  32 static const char *const applications_permitted[] = {
  33         "homescreen", "alexa-viewer", "launcher", "hvac",
  34         "navigation", "mediaplayer"
  35 };
  36
  37 /* helper start searches the applications_permitted for the
  38  * app_id
  39  */
  40 static bool
  41 ivi_policy_verify_permitted_app(const char *app_id)
  42 {
  43         for (size_t i = 0; i < ARRAY_LENGTH(applications_permitted); i++)
  44                 if (strcmp(app_id, applications_permitted[i]) == 0)
  45                         return true;
  46
  47         return false;
  48 }
  49
  50 static bool
  51 ivi_policy_verify_ivi_surface(struct ivi_surface *surf)
  52 {
  53         const char *app_id = weston_desktop_surface_get_app_id(surf->dsurface);
  54         return ivi_policy_verify_permitted_app(app_id);
  55 }
  56
  57 /*
  58  * deny-all policy implementation allows every action to be denied
  59  *
  60  * This is an example, that implements the API
  61  *
  62  * For injecting rules back in the compositor one should use ivi_policy_add()
  63  * - policy_rule_allow_to_add is required in order to add further policy rules
  64  * - policy_rule_try_event will be callback executed when handling the state
  65  *   change
  66  */
  67 static bool
  68 ivi_policy_default_surface_create(struct ivi_surface *surf, void *user_data)
  69 {
  70         return ivi_policy_verify_ivi_surface(surf);
  71 }
  72
  73 static bool
  74 ivi_policy_default_surface_commmited(struct ivi_surface *surf, void *user_data)
  75 {
  76         return ivi_policy_verify_ivi_surface(surf);
  77 }
  78
  79 static bool
  80 ivi_policy_default_surface_activate(struct ivi_surface *surf, void *user_data)
  81 {
  82         return ivi_policy_verify_ivi_surface(surf);
  83 }
  84
  85 static bool
  86 ivi_policy_default_surface_deactivate(struct ivi_surface *surf, void *user_data)
  87 {
  88         return ivi_policy_verify_ivi_surface(surf);
  89 }
  90
  91 static bool
  92 ivi_policy_default_surface_activate_default(struct ivi_surface *surf, void *user_data)
  93 {
  94         return ivi_policy_verify_ivi_surface(surf);
  95 }
  96
  97 static bool
  98 ivi_policy_default_surface_advertise_state_change(struct ivi_surface *surf, void *user_data)
  99 {
 100         return ivi_policy_verify_ivi_surface(surf);
 101 }
 102
 103 static bool
 104 ivi_policy_default_shell_bind_interface(void *client, void *interface)
 105 {
 106         return false;
 107 }
 108
 109 static bool
 110 ivi_policy_default_allow_to_add(void *user_data)
 111 {
 112         /* verify that policy rules can be added with ivi_policy_add() */
 113         return true;
 114 }
 115
 116 /*
 117  * Policy rules added by ivi_policy_add() will be handled by this callback, and
 118  * should be treated depending on the event. Note this is just an example.
 119  */
 120 static void
 121 ivi_policy_default_try_event(struct ivi_a_policy *a_policy)
 122 {
 123         uint32_t event = a_policy->event;
 124
 125         switch (event) {
 126         case AGL_SHELL_POLICY_EVENT_SHOW:
 127                 ivi_layout_activate(a_policy->output, a_policy->app_id);
 128                 break;
 129         case AGL_SHELL_POLICY_EVENT_HIDE:
 130                 ivi_layout_deactivate(a_policy->policy->ivi, a_policy->app_id);
 131         default:
 132                 break;
 133         }
 134 }
 135
 136 static const struct ivi_policy_api policy_api = {
 137         .struct_size = sizeof(policy_api),
 138         .surface_create = ivi_policy_default_surface_create,
 139         .surface_commited = ivi_policy_default_surface_commmited,
 140         .surface_activate = ivi_policy_default_surface_activate,
 141         .surface_deactivate = ivi_policy_default_surface_deactivate,
 142         .surface_activate_by_default = ivi_policy_default_surface_activate_default,
 143         .surface_advertise_state_change = ivi_policy_default_surface_advertise_state_change,
 144         .shell_bind_interface = ivi_policy_default_shell_bind_interface,
 145         .policy_rule_allow_to_add = ivi_policy_default_allow_to_add,
 146         .policy_rule_try_event = ivi_policy_default_try_event,
 147 };
 148
 149 int
 150 ivi_policy_init(struct ivi_compositor *ivi)
 151 {
 152         ivi->policy = ivi_policy_create(ivi, &policy_api, ivi);
 153         if (!ivi->policy)
 154                 return -1;
 155
 156         weston_log("Installing 'deny-all' policy engine\n");
 157         return 0;
 158 }