1 /*
2  * Copyright (C) 2014 The Android Open Source Project
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 #pragma once
18 
19 #include <set>
20 
21 #include "Network.h"
22 #include "UidRanges.h"
23 
24 namespace android::net {
25 
26 // A VirtualNetwork may be "secure" or not.
27 //
28 // A secure VPN is the usual type of VPN that grabs the default route (and thus all user traffic).
29 // Only a few privileged UIDs may skip the VPN and go directly to the underlying physical network.
30 //
31 // A non-secure VPN ("bypassable" VPN) also grabs all user traffic by default. But all apps are
32 // permitted to skip it and pick any other network for their connections.
33 class VirtualNetwork : public Network {
34 public:
35     VirtualNetwork(unsigned netId, bool secure);
36     virtual ~VirtualNetwork();
37 
38     bool isSecure() const;
39     bool appliesToUser(uid_t uid) const;
40 
41     [[nodiscard]] int addUsers(const UidRanges& uidRanges, const std::set<uid_t>& protectableUsers);
42     [[nodiscard]] int removeUsers(const UidRanges& uidRanges,
43                                   const std::set<uid_t>& protectableUsers);
44 
45   private:
46     Type getType() const override;
47     [[nodiscard]] int addInterface(const std::string& interface) override;
48     [[nodiscard]] int removeInterface(const std::string& interface) override;
49     int maybeCloseSockets(bool add, const UidRanges& uidRanges,
50                           const std::set<uid_t>& protectableUsers);
51 
52     const bool mSecure;
53     UidRanges mUidRanges;
54 };
55 
56 }  // namespace android::net
57