1 // Copyright (C) 2019 Bayerische Motoren Werke Aktiengesellschaft (BMW AG)
2 // This Source Code Form is subject to the terms of the Mozilla Public
3 // License, v. 2.0. If a copy of the MPL was not distributed with this
4 // file, You can obtain one at http://mozilla.org/MPL/2.0/.
5 
6 #ifndef VSOMEIP_V3_SECURITY_SECURITY_HPP_
7 #define VSOMEIP_V3_SECURITY_SECURITY_HPP_
8 
9 #include <memory>
10 #include <unordered_set>
11 
12 #include <vsomeip/payload.hpp>
13 #include <vsomeip/primitive_types.hpp>
14 
15 namespace vsomeip_v3 {
16 
17 struct configuration_element;
18 
19 class security {
20 public:
21     VSOMEIP_EXPORT static std::shared_ptr<security> get();
22 
~security()23     virtual ~security() {};
24 
25     virtual void load(const configuration_element &_element) = 0;
26 
27     virtual bool is_enabled() const = 0;
28     virtual bool is_audit() const = 0;
29 
30     virtual bool check_credentials(client_t _client, uid_t _uid, gid_t _gid) = 0;
31     virtual bool check_routing_credentials(client_t _client,
32             uint32_t _uid, uint32_t _gid) const = 0;
33 
34     virtual bool is_client_allowed(uint32_t _uid, uint32_t _gid, client_t _client,
35             service_t _service, instance_t _instance, method_t _method,
36             bool _is_request_service = false) const = 0;
37     virtual bool is_remote_client_allowed() const = 0;
38     virtual bool is_offer_allowed(uint32_t _uid, uint32_t _gid, client_t _client,
39             service_t _service, instance_t _instance) const = 0;
40 
41     virtual void update_security_policy(uint32_t _uid, uint32_t _gid,
42             const std::shared_ptr<policy>& _policy) = 0;
43     virtual bool remove_security_policy(uint32_t _uid, uint32_t _gid) = 0;
44 
45     virtual bool get_uid_gid_to_client_mapping(std::pair<uint32_t, uint32_t> _uid_gid,
46             std::set<client_t> &_clients) = 0;
47     virtual bool remove_client_to_uid_gid_mapping(client_t _client) = 0;
48 
49     virtual bool get_client_to_uid_gid_mapping(client_t _client,
50             std::pair<uint32_t, uint32_t> &_uid_gid) = 0;
51 
52     virtual bool store_client_to_uid_gid_mapping(client_t _client,
53         uint32_t _uid, uint32_t _gid) = 0;
54     virtual void store_uid_gid_to_client_mapping(uint32_t _uid, uint32_t _gid,
55         client_t _client) = 0;
56 
57     virtual void get_requester_policies(const std::shared_ptr<policy> _policy,
58             std::set<std::shared_ptr<policy> > &_requesters) const = 0;
59     virtual void get_clients(uid_t _uid, gid_t _gid,
60             std::unordered_set<client_t> &_clients) const = 0;
61 };
62 
63 } // namespace vsomeip_v3
64 
65 #endif // VSOMEIP_V3_SECURITY_SECURITY_HPP_
66