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
|
/*
* Copyright (C) 2018 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ART_RUNTIME_HIDDEN_API_H_
#define ART_RUNTIME_HIDDEN_API_H_
#include "art_field-inl.h"
#include "art_method-inl.h"
#include "dex/hidden_api_access_flags.h"
#include "mirror/class-inl.h"
#include "reflection.h"
#include "runtime.h"
namespace art {
namespace hiddenapi {
enum Action {
kAllow,
kAllowButWarn,
kAllowButWarnAndToast,
kDeny
};
enum AccessMethod {
kReflection,
kJNI,
kLinking,
kOverride,
};
inline std::ostream& operator<<(std::ostream& os, AccessMethod value) {
switch (value) {
case kReflection:
os << "reflection";
break;
case kJNI:
os << "JNI";
break;
case kLinking:
os << "linking";
break;
case kOverride:
os << "override";
break;
}
return os;
}
inline Action GetMemberAction(uint32_t access_flags) {
switch (HiddenApiAccessFlags::DecodeFromRuntime(access_flags)) {
case HiddenApiAccessFlags::kWhitelist:
return kAllow;
case HiddenApiAccessFlags::kLightGreylist:
return kAllowButWarn;
case HiddenApiAccessFlags::kDarkGreylist:
return kAllowButWarnAndToast;
case HiddenApiAccessFlags::kBlacklist:
return kDeny;
}
}
// Issue a warning about field access.
inline void WarnAboutMemberAccess(ArtField* field, AccessMethod access_method)
REQUIRES_SHARED(Locks::mutator_lock_) {
std::string tmp;
LOG(WARNING) << "Accessing hidden field "
<< field->GetDeclaringClass()->GetDescriptor(&tmp) << "->"
<< field->GetName() << ":" << field->GetTypeDescriptor()
<< " (" << HiddenApiAccessFlags::DecodeFromRuntime(field->GetAccessFlags())
<< ", " << access_method << ")";
}
// Issue a warning about method access.
inline void WarnAboutMemberAccess(ArtMethod* method, AccessMethod access_method)
REQUIRES_SHARED(Locks::mutator_lock_) {
std::string tmp;
LOG(WARNING) << "Accessing hidden method "
<< method->GetDeclaringClass()->GetDescriptor(&tmp) << "->"
<< method->GetName() << method->GetSignature().ToString()
<< " (" << HiddenApiAccessFlags::DecodeFromRuntime(method->GetAccessFlags())
<< ", " << access_method << ")";
}
// Returns true if access to `member` should be denied to the caller of the
// reflective query. The decision is based on whether the caller is in boot
// class path or not. Because different users of this function determine this
// in a different way, `fn_caller_in_boot(self)` is called and should return
// true if the caller is in boot class path.
// This function might print warnings into the log if the member is hidden.
template<typename T>
inline bool ShouldBlockAccessToMember(T* member,
Thread* self,
std::function<bool(Thread*)> fn_caller_in_boot,
AccessMethod access_method)
REQUIRES_SHARED(Locks::mutator_lock_) {
DCHECK(member != nullptr);
Runtime* runtime = Runtime::Current();
if (!runtime->AreHiddenApiChecksEnabled()) {
// Exit early. Nothing to enforce.
return false;
}
Action action = GetMemberAction(member->GetAccessFlags());
if (action == kAllow) {
// Nothing to do.
return false;
}
// Member is hidden. Walk the stack to find the caller.
// This can be *very* expensive. Save it for last.
if (fn_caller_in_boot(self)) {
// Caller in boot class path. Exit.
return false;
}
// Member is hidden and we are not in the boot class path.
// Print a log message with information about this class member access.
// We do this regardless of whether we block the access or not.
WarnAboutMemberAccess(member, access_method);
// Block access if on blacklist.
if (action == kDeny) {
return true;
}
// Allow access to this member but print a warning.
DCHECK(action == kAllowButWarn || action == kAllowButWarnAndToast);
// Depending on a runtime flag, we might move the member into whitelist and
// skip the warning the next time the member is accessed.
if (runtime->ShouldDedupeHiddenApiWarnings()) {
member->SetAccessFlags(HiddenApiAccessFlags::EncodeForRuntime(
member->GetAccessFlags(), HiddenApiAccessFlags::kWhitelist));
}
// If this action requires a UI warning, set the appropriate flag.
if (action == kAllowButWarnAndToast || runtime->ShouldAlwaysSetHiddenApiWarningFlag()) {
Runtime::Current()->SetPendingHiddenApiWarning(true);
}
return false;
}
// Returns true if access to `member` should be denied to a caller loaded with
// `caller_class_loader`.
// This function might print warnings into the log if the member is hidden.
template<typename T>
inline bool ShouldBlockAccessToMember(T* member,
ObjPtr<mirror::ClassLoader> caller_class_loader,
AccessMethod access_method)
REQUIRES_SHARED(Locks::mutator_lock_) {
bool caller_in_boot = (caller_class_loader.IsNull());
return ShouldBlockAccessToMember(member,
/* thread */ nullptr,
[caller_in_boot] (Thread*) { return caller_in_boot; },
access_method);
}
} // namespace hiddenapi
} // namespace art
#endif // ART_RUNTIME_HIDDEN_API_H_
|