1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/**
* @file policy_manager.h
* @brief Policy Manager header file.
*/
// Copyright (c) 2013, Ford Motor Company
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
//
// Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following
// disclaimer in the documentation and/or other materials provided with the
// distribution.
//
// Neither the name of the Ford Motor Company nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 'A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
#ifndef SRC_COMPONENTS_POLICIES_INCLUDE_POLICIES_POLICY_MANAGER_H_
#define SRC_COMPONENTS_POLICIES_INCLUDE_POLICIES_POLICY_MANAGER_H_
#include "interfaces/MOBILE_API.h"
#include "policies/policy_configuration.h"
#include "smart_objects/smart_object.h"
namespace policies {
/**
* @brief enumeration of result for asking permissions by application
**/
enum PermissionResult {
/**
* @brief RPC is allowed.
*/
PERMISSION_ALLOWED = 0,
/**
* @brief Initialization of Policy Manager failed.
*/
PERMISSION_INIT_FAILED,
/**
* @brief Verification of Policy Table failed.
*
* Policy Table as smart object has failed in verification against schema.
*/
PERMISSION_PT_VERIFICATION_FAILED,
/**
* @brief RPC is allowed by the PT(backend), but disallowed by the user.
*/
PERMISSION_USER_DISALLOWED,
/**
* @brief RPC is not allowed by the PT(backend).
*/
PERMISSION_DISALLOWED,
/**
* @brief RPC is allowed by PT(backend), but user has not been prompted yet.
*/
PERMISSION_PENDING_USER_CONSENT
};
// Namespace is neseccary because it is used for automatic string<->enum
// convertion using schema
namespace Priority {
enum eType {
/**
* @brief Mandatory item. Used for enum<->string convertion
*/
INVALID_ENUM = -1,
/**
* @brief NONE
*/
PRIORITY_NONE = 0,
/**
* @brief NORMAL
*/
PRIORITY_NORMAL,
/**
* @brief COMMUNICATION
*/
PRIORITY_COMMUNICATION,
/**
* @brief NAVIGATION
*/
PRIORITY_NAVIGATION,
/**
* @brief EMERGENCY
*/
PRIORITY_EMERGENCY,
};
} // namespace Priority
/**
* @brief Init() result enumeration
**/
enum InitResult {
/**
* @brief PT file loaded successfully
**/
INIT_OK = 0,
/**
* @brief Initialization has failed
*
* Possible reason: Policy Table file missing, failed verification
*
**/
INIT_FAILED
};
/**
* @brief Enumeration for state wich reflects states of User consent procedure
* @TODO (anyone) for future use
*/
enum eType {
/**
* @brief User was not asked for consent
*/
STATE_IDLE = 0,
/**
* @brief User was asked just now for consent
*/
STATE_PENDING_CONSENT,
/**
* @brief User answered 'YES' just now
*/
STATE_CONSENT_YES,
/**
* @brief User answered 'NO' just now
*/
STATE_CONSENT_NO
};
/**
* @biref Struct contains data of result to return when Policy Manager
* is requested for CheckPermission()
*/
struct CheckPermissionResult {
/**
* @brief Permission result
*/
PermissionResult result;
/**
* @brief Stored priority for current application
*/
Priority::eType priority;
};
/**
* @brief Interface class of policy manager.
*/
class PolicyManager {
public:
/**
* @brief Destructor
*
**/
virtual ~PolicyManager() {}
/**
* @brief Initialization method
*
* @param config PolicyManager configuration
*/
virtual InitResult Init(const PolicyConfiguration& config) = 0;
/**
* @brief Checking permissions for application whether rpc is allowed.
*
* @param app_id Application identifier
* @param rpc Remote procedure call
* @param hmi_status HMI level status
*
* @return result of check permission
*/
virtual CheckPermissionResult CheckPermission(uint32_t app_id,
const NsSmartDeviceLink::NsSmartObjects::SmartObject& rpc,
mobile_apis::HMILevel::eType hmi_status) = 0;
};
} // namespace policies
#endif // SRC_COMPONENTS_POLICIES_INCLUDE_POLICIES_POLICY_MANAGER_H_
|
