summaryrefslogtreecommitdiffstats
path: root/dom/ipc/AppProcessChecker.h
blob: e5e7a90ba7278387adced20aaaa52e5cf59394a3 (plain)
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
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_AppProcessChecker_h
#define mozilla_AppProcessChecker_h

#include <stdint.h>

class nsIPrincipal;

namespace mozilla {

namespace dom {
class TabContext;
class PBrowserParent;
class PContentParent;
} // namespace dom

namespace hal_sandbox {
class PHalParent;
} // namespace hal_sandbox

enum AssertAppProcessType {
  ASSERT_APP_PROCESS_PERMISSION,
  ASSERT_APP_PROCESS_MANIFEST_URL,
  ASSERT_APP_HAS_PERMISSION
};

/**
 * Return true if the specified browser has the specified capability.
 * If this returns false, the browser didn't have the capability and
 * will be killed.
 */
bool
AssertAppProcess(mozilla::dom::PBrowserParent* aActor,
                 AssertAppProcessType aType,
                 const char* aCapability);

/**
 * Return true if the specified app has the specified status.
 * If this returns false, the browser will be killed.
 */
bool
AssertAppStatus(mozilla::dom::PBrowserParent* aActor,
                unsigned short aStatus);

/**
 * Return true if the specified browser has the specified capability.
 * If this returns false, the browser didn't have the capability and
 * will be killed.
 */
bool
AssertAppProcess(const mozilla::dom::TabContext& aContext,
                 AssertAppProcessType aType,
                 const char* aCapability);

/**
 * Return true if the specified app has the specified status.
 * If this returns false, the browser will be killed.
 */
bool
AssertAppStatus(const mozilla::dom::TabContext& aContext,
                unsigned short aStatus);

/**
 * Return true if any of the PBrowsers loaded in this content process
 * has the specified capability.  If this returns false, the process
 * didn't have the capability and will be killed.
 */
bool
AssertAppProcess(mozilla::dom::PContentParent* aActor,
                 AssertAppProcessType aType,
                 const char* aCapability);

/**
 * Return true if any of the PBrowsers loaded in this content process
 * has an app with the specified status. If this returns false, the process
 * didn't have the status and will be killed.
 */
bool
AssertAppStatus(mozilla::dom::PContentParent* aActor,
                unsigned short aStatus);

bool
AssertAppProcess(mozilla::hal_sandbox::PHalParent* aActor,
                 AssertAppProcessType aType,
                 const char* aCapability);

// NB: when adding capability checks for other IPDL actors, please add
// them to this file and have them delegate to the two functions above
// as appropriate.  For example,
//
//   bool AppProcessHasCapability(PNeckoParent* aActor, AssertAppProcessType aType) {
//     return AssertAppProcess(aActor->Manager(), aType);
//   }

bool
AssertAppPrincipal(mozilla::dom::PContentParent* aParent,
                   nsIPrincipal* aPrincipal);

/**
 * Check if the specified principal is valid, and return the saved permission
 * value for permission `aPermission' on that principal.
 * See nsIPermissionManager.idl for possible return values.
 *
 * nsIPermissionManager::UNKNOWN_ACTION is retuned if the principal is invalid.
 */
uint32_t
CheckPermission(mozilla::dom::PContentParent* aParent,
                nsIPrincipal* aPrincipal, const char* aPermission);

/**
 * Inline function for asserting the process's permission.
 */
template<typename T>
inline bool
AssertAppProcessPermission(T* aActor,
                           const char* aPermission) {
  return AssertAppProcess(aActor,
                          ASSERT_APP_PROCESS_PERMISSION,
                          aPermission);
}

/**
 * Inline function for asserting the process's manifest URL.
 */
template<typename T>
inline bool
AssertAppProcessManifestURL(T* aActor,
                            const char* aManifestURL) {
  return AssertAppProcess(aActor,
                          ASSERT_APP_PROCESS_MANIFEST_URL,
                          aManifestURL);
}

/**
 * Inline function for asserting the process's manifest URL.
 */
template<typename T>
inline bool
AssertAppHasPermission(T* aActor,
                       const char* aPermission) {
  return AssertAppProcess(aActor,
                          ASSERT_APP_HAS_PERMISSION,
                          aPermission);
}

template<typename T>
inline bool
AssertAppHasStatus(T* aActor,
                   unsigned short aStatus) {
  return AssertAppStatus(aActor, aStatus);
}

} // namespace mozilla

#endif // mozilla_AppProcessChecker_h