blob: 7f7ffa781e9ac1a37d4ee477f52e202ba7681203 [file] [log] [blame]
Steven Moreland65b3fd92017-12-06 14:18:35 -08001// Copyright 2017 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package android
16
17import (
Liz Kammera3d79152021-10-28 18:14:04 -040018 "fmt"
Steven Moreland65b3fd92017-12-06 14:18:35 -080019 "path/filepath"
20 "reflect"
Anton Hansson45376402020-04-09 14:18:21 +010021 "regexp"
Steven Moreland65b3fd92017-12-06 14:18:35 -080022 "strconv"
23 "strings"
24
25 "github.com/google/blueprint/proptools"
26)
27
28// "neverallow" rules for the build system.
29//
30// This allows things which aren't related to the build system and are enforced
Joe Onoratob4638c12021-10-27 15:47:06 -070031// against assumptions, in progress code refactors, or policy to be expressed in a
Steven Moreland65b3fd92017-12-06 14:18:35 -080032// straightforward away disjoint from implementations and tests which should
33// work regardless of these restrictions.
34//
35// A module is disallowed if all of the following are true:
Paul Duffin730f2a52019-06-27 14:08:51 +010036// - it is in one of the "In" paths
37// - it is not in one of the "NotIn" paths
38// - it has all "With" properties matched
Steven Moreland65b3fd92017-12-06 14:18:35 -080039// - - values are matched in their entirety
40// - - nil is interpreted as an empty string
41// - - nested properties are separated with a '.'
42// - - if the property is a list, any of the values in the list being matches
43// counts as a match
Paul Duffin730f2a52019-06-27 14:08:51 +010044// - it has none of the "Without" properties matched (same rules as above)
Steven Moreland65b3fd92017-12-06 14:18:35 -080045
Paul Duffin45338f02021-03-30 23:07:52 +010046func registerNeverallowMutator(ctx RegisterMutatorsContext) {
Colin Cross8a962802024-10-09 15:29:27 -070047 ctx.BottomUp("neverallow", neverallowMutator)
Steven Moreland65b3fd92017-12-06 14:18:35 -080048}
49
Paul Duffin730f2a52019-06-27 14:08:51 +010050var neverallows = []Rule{}
Steven Moreland65b3fd92017-12-06 14:18:35 -080051
Paul Duffin730f2a52019-06-27 14:08:51 +010052func init() {
Paul Duffinc8111702019-07-22 12:13:55 +010053 AddNeverAllowRules(createIncludeDirsRules()...)
Paul Duffin730f2a52019-06-27 14:08:51 +010054 AddNeverAllowRules(createTrebleRules()...)
Paul Duffin730f2a52019-06-27 14:08:51 +010055 AddNeverAllowRules(createJavaDeviceForHostRules()...)
Colin Crossc511bc52020-04-07 16:50:32 +000056 AddNeverAllowRules(createCcSdkVariantRules()...)
David Srbeckye033cba2020-05-20 22:20:28 +010057 AddNeverAllowRules(createUncompressDexRules()...)
Nelson Li43808202024-11-20 09:05:53 +000058 AddNeverAllowRules(createInstallInRootAllowingRules()...)
Jiyong Park3c306f32022-04-05 15:29:53 +090059 AddNeverAllowRules(createProhibitFrameworkAccessRules()...)
Alan Stokes73feba32022-11-14 12:21:24 +000060 AddNeverAllowRules(createCcStubsRule())
Mark Whitea15790a2023-08-22 21:28:11 +000061 AddNeverAllowRules(createProhibitHeaderOnlyRule())
Steven Moreland0db999c2024-09-03 22:06:24 +000062 AddNeverAllowRules(createLimitNdkExportRule()...)
Inseob Kim76e19852024-10-10 17:57:22 +090063 AddNeverAllowRules(createLimitDirgroupRule()...)
Jihoon Kang0d545b82024-10-11 00:21:57 +000064 AddNeverAllowRules(createFilesystemIsAutoGeneratedRule())
Luca Stefani50098f72024-10-12 17:55:31 +020065 AddNeverAllowRules(createKotlinPluginRule()...)
Jihoon Kang2a7bf752024-11-01 21:21:25 +000066 AddNeverAllowRules(createPrebuiltEtcBpDefineRule())
Spandan Dase2f98da2024-11-18 19:22:39 +000067 AddNeverAllowRules(createAutogenRroBpDefineRule())
Neil Fullerdf5f3562018-10-21 17:19:10 +010068}
Steven Moreland65b3fd92017-12-06 14:18:35 -080069
Paul Duffin730f2a52019-06-27 14:08:51 +010070// Add a NeverAllow rule to the set of rules to apply.
71func AddNeverAllowRules(rules ...Rule) {
72 neverallows = append(neverallows, rules...)
73}
74
Sam Delmerico46d08b42022-11-15 15:51:04 -050075var (
76 neverallowNotInIncludeDir = []string{
Paul Duffinc8111702019-07-22 12:13:55 +010077 "art",
Orion Hodson6341f012019-11-06 13:39:46 +000078 "art/libnativebridge",
79 "art/libnativeloader",
Paul Duffinc8111702019-07-22 12:13:55 +010080 "libcore",
81 "libnativehelper",
82 "external/apache-harmony",
83 "external/apache-xml",
84 "external/boringssl",
85 "external/bouncycastle",
86 "external/conscrypt",
87 "external/icu",
88 "external/okhttp",
89 "external/vixl",
90 "external/wycheproof",
Paul Duffinc8111702019-07-22 12:13:55 +010091 }
Sam Delmerico46d08b42022-11-15 15:51:04 -050092 neverallowNoUseIncludeDir = []string{
Steven Morelandf36a3ac2021-04-27 18:03:14 +000093 "frameworks/av/apex",
94 "frameworks/av/tools",
95 "frameworks/native/cmds",
96 "system/apex",
97 "system/bpf",
98 "system/gatekeeper",
99 "system/hwservicemanager",
100 "system/libbase",
Steven Moreland8fc8dbf2021-04-27 02:31:07 +0000101 "system/libfmq",
Steven Morelandf36a3ac2021-04-27 18:03:14 +0000102 "system/libvintf",
Steven Moreland8fc8dbf2021-04-27 02:31:07 +0000103 }
Sam Delmerico46d08b42022-11-15 15:51:04 -0500104)
Paul Duffinc8111702019-07-22 12:13:55 +0100105
Sam Delmerico46d08b42022-11-15 15:51:04 -0500106func createIncludeDirsRules() []Rule {
107 rules := make([]Rule, 0, len(neverallowNotInIncludeDir)+len(neverallowNoUseIncludeDir))
Steven Moreland8fc8dbf2021-04-27 02:31:07 +0000108
Sam Delmerico46d08b42022-11-15 15:51:04 -0500109 for _, path := range neverallowNotInIncludeDir {
Paul Duffinc8111702019-07-22 12:13:55 +0100110 rule :=
111 NeverAllow().
112 WithMatcher("include_dirs", StartsWith(path+"/")).
113 Because("include_dirs is deprecated, all usages of '" + path + "' have been migrated" +
114 " to use alternate mechanisms and so can no longer be used.")
115
116 rules = append(rules, rule)
117 }
118
Sam Delmerico46d08b42022-11-15 15:51:04 -0500119 for _, path := range neverallowNoUseIncludeDir {
Steven Moreland8fc8dbf2021-04-27 02:31:07 +0000120 rule := NeverAllow().In(path+"/").WithMatcher("include_dirs", isSetMatcherInstance).
121 Because("include_dirs is deprecated, all usages of them in '" + path + "' have been migrated" +
122 " to use alternate mechanisms and so can no longer be used.")
123 rules = append(rules, rule)
124 }
125
Paul Duffinc8111702019-07-22 12:13:55 +0100126 return rules
127}
128
Paul Duffin730f2a52019-06-27 14:08:51 +0100129func createTrebleRules() []Rule {
130 return []Rule{
131 NeverAllow().
132 In("vendor", "device").
133 With("vndk.enabled", "true").
134 Without("vendor", "true").
Justin Yun0ecf0b22020-02-28 15:07:59 +0900135 Without("product_specific", "true").
Paul Duffin730f2a52019-06-27 14:08:51 +0100136 Because("the VNDK can never contain a library that is device dependent."),
137 NeverAllow().
138 With("vndk.enabled", "true").
139 Without("vendor", "true").
140 Without("owner", "").
141 Because("a VNDK module can never have an owner."),
Steven Moreland65b3fd92017-12-06 14:18:35 -0800142
Neil Fullerdf5f3562018-10-21 17:19:10 +0100143 // TODO(b/67974785): always enforce the manifest
Paul Duffin730f2a52019-06-27 14:08:51 +0100144 NeverAllow().
Steven Moreland51ce4f62020-02-10 17:21:32 -0800145 Without("name", "libhidlbase-combined-impl").
146 Without("name", "libhidlbase").
Paul Duffin730f2a52019-06-27 14:08:51 +0100147 With("product_variables.enforce_vintf_manifest.cflags", "*").
148 Because("manifest enforcement should be independent of ."),
Neil Fullerdf5f3562018-10-21 17:19:10 +0100149
150 // TODO(b/67975799): vendor code should always use /vendor/bin/sh
Paul Duffin730f2a52019-06-27 14:08:51 +0100151 NeverAllow().
152 Without("name", "libc_bionic_ndk").
153 With("product_variables.treble_linker_namespaces.cflags", "*").
154 Because("nothing should care if linker namespaces are enabled or not"),
Neil Fullerdf5f3562018-10-21 17:19:10 +0100155
156 // Example:
Paul Duffin730f2a52019-06-27 14:08:51 +0100157 // *NeverAllow().with("Srcs", "main.cpp"))
Neil Fullerdf5f3562018-10-21 17:19:10 +0100158 }
159}
160
Paul Duffin730f2a52019-06-27 14:08:51 +0100161func createJavaDeviceForHostRules() []Rule {
Colin Cross440e0d02020-06-11 11:32:11 -0700162 javaDeviceForHostProjectsAllowedList := []string{
Dan Willemsen9fe14102021-07-13 21:52:04 -0700163 "development/build",
Colin Crossb5191a52019-04-11 14:07:38 -0700164 "external/guava",
Steve Elliott8053f822022-10-18 17:09:28 -0400165 "external/kotlinx.coroutines",
Colin Crossfd4f7432019-03-05 15:06:16 -0800166 "external/robolectric-shadows",
Rex Hoffman54641d22022-08-25 17:29:50 +0000167 "external/robolectric",
Makoto Onukib66bba32023-11-11 00:06:09 +0000168 "frameworks/base/ravenwood",
169 "frameworks/base/tools/hoststubgen",
Jerome Gaillard655ee022021-09-23 11:38:08 +0000170 "frameworks/layoutlib",
Colin Crossfd4f7432019-03-05 15:06:16 -0800171 }
172
Paul Duffin730f2a52019-06-27 14:08:51 +0100173 return []Rule{
174 NeverAllow().
Colin Cross440e0d02020-06-11 11:32:11 -0700175 NotIn(javaDeviceForHostProjectsAllowedList...).
Paul Duffin730f2a52019-06-27 14:08:51 +0100176 ModuleType("java_device_for_host", "java_host_for_device").
Colin Cross440e0d02020-06-11 11:32:11 -0700177 Because("java_device_for_host can only be used in allowed projects"),
Colin Crossfd4f7432019-03-05 15:06:16 -0800178 }
179}
180
Colin Crossc511bc52020-04-07 16:50:32 +0000181func createCcSdkVariantRules() []Rule {
Colin Cross440e0d02020-06-11 11:32:11 -0700182 sdkVersionOnlyAllowedList := []string{
Colin Crossc511bc52020-04-07 16:50:32 +0000183 // derive_sdk_prefer32 has stem: "derive_sdk" which conflicts with the derive_sdk.
184 // This sometimes works because the APEX modules that contain derive_sdk and
185 // derive_sdk_prefer32 suppress the platform installation rules, but fails when
186 // the APEX modules contain the SDK variant and the platform variant still exists.
Anton Hansson4b8e64b2020-05-27 18:25:23 +0100187 "packages/modules/SdkExtensions/derive_sdk",
Dan Alberte2054a92020-04-20 14:46:47 -0700188 // These are for apps and shouldn't be used by non-SDK variant modules.
189 "prebuilts/ndk",
Jiyong Parka574d532024-08-28 18:06:43 +0900190 "frameworks/native/libs/binder/ndk",
Dan Alberte2054a92020-04-20 14:46:47 -0700191 "tools/test/graphicsbenchmark/apps/sample_app",
192 "tools/test/graphicsbenchmark/functional_tests/java",
Dan Albert55576052020-04-20 14:46:47 -0700193 "vendor/xts/gts-tests/hostsidetests/gamedevicecert/apps/javatests",
Chang Li66d3cb72021-06-18 14:04:50 +0000194 "external/libtextclassifier/native",
Colin Crossc511bc52020-04-07 16:50:32 +0000195 }
196
Colin Cross440e0d02020-06-11 11:32:11 -0700197 platformVariantPropertiesAllowedList := []string{
Colin Crossc511bc52020-04-07 16:50:32 +0000198 // android_native_app_glue and libRSSupport use native_window.h but target old
199 // sdk versions (minimum and 9 respectively) where libnativewindow didn't exist,
200 // so they can't add libnativewindow to shared_libs to get the header directory
201 // for the platform variant. Allow them to use the platform variant
202 // property to set shared_libs.
203 "prebuilts/ndk",
204 "frameworks/rs",
205 }
206
207 return []Rule{
208 NeverAllow().
Colin Cross440e0d02020-06-11 11:32:11 -0700209 NotIn(sdkVersionOnlyAllowedList...).
Colin Crossc511bc52020-04-07 16:50:32 +0000210 WithMatcher("sdk_variant_only", isSetMatcherInstance).
Colin Cross440e0d02020-06-11 11:32:11 -0700211 Because("sdk_variant_only can only be used in allowed projects"),
Colin Crossc511bc52020-04-07 16:50:32 +0000212 NeverAllow().
Colin Cross440e0d02020-06-11 11:32:11 -0700213 NotIn(platformVariantPropertiesAllowedList...).
Colin Crossc511bc52020-04-07 16:50:32 +0000214 WithMatcher("platform.shared_libs", isSetMatcherInstance).
Colin Cross440e0d02020-06-11 11:32:11 -0700215 Because("platform variant properties can only be used in allowed projects"),
Colin Crossc511bc52020-04-07 16:50:32 +0000216 }
217}
218
Alan Stokes73feba32022-11-14 12:21:24 +0000219func createCcStubsRule() Rule {
220 ccStubsImplementationInstallableProjectsAllowedList := []string{
Jiyong Parkf6736c72024-07-22 11:22:35 +0900221 "packages/modules/Virtualization/libs/libvm_payload",
Alan Stokes73feba32022-11-14 12:21:24 +0000222 }
223
224 return NeverAllow().
225 NotIn(ccStubsImplementationInstallableProjectsAllowedList...).
226 WithMatcher("stubs.implementation_installable", isSetMatcherInstance).
227 Because("implementation_installable can only be used in allowed projects.")
228}
229
David Srbeckye033cba2020-05-20 22:20:28 +0100230func createUncompressDexRules() []Rule {
231 return []Rule{
232 NeverAllow().
233 NotIn("art").
234 WithMatcher("uncompress_dex", isSetMatcherInstance).
235 Because("uncompress_dex is only allowed for certain jars for test in art."),
236 }
237}
238
Nelson Li43808202024-11-20 09:05:53 +0000239func createInstallInRootAllowingRules() []Rule {
Inseob Kim800d1142021-06-14 12:03:51 +0900240 return []Rule{
241 NeverAllow().
Nikita Ioffe11a9c2c2023-06-21 16:51:09 +0100242 Without("name", "init_first_stage_defaults").
Inseob Kim800d1142021-06-14 12:03:51 +0900243 Without("name", "init_first_stage").
Nikita Ioffe11a9c2c2023-06-21 16:51:09 +0100244 Without("name", "init_first_stage.microdroid").
Nelson Li43808202024-11-20 09:05:53 +0000245 Without("name", "librecovery_ui_ext").
Inseob Kim800d1142021-06-14 12:03:51 +0900246 With("install_in_root", "true").
Inseob Kimbe6a66d2024-07-11 15:43:44 +0900247 NotModuleType("prebuilt_root").
Nelson Li43808202024-11-20 09:05:53 +0000248 Because("install_in_root is only for init_first_stage or librecovery_ui_ext."),
Inseob Kim800d1142021-06-14 12:03:51 +0900249 }
250}
251
Jiyong Park3c306f32022-04-05 15:29:53 +0900252func createProhibitFrameworkAccessRules() []Rule {
253 return []Rule{
254 NeverAllow().
255 With("libs", "framework").
256 WithoutMatcher("sdk_version", Regexp("(core_.*|^$)")).
257 Because("framework can't be used when building against SDK"),
258 }
259}
260
Mark Whitea15790a2023-08-22 21:28:11 +0000261func createProhibitHeaderOnlyRule() Rule {
262 return NeverAllow().
263 Without("name", "framework-minus-apex-headers").
264 With("headers_only", "true").
265 Because("headers_only can only be used for generating framework-minus-apex headers for non-updatable modules")
266}
267
Steven Moreland0db999c2024-09-03 22:06:24 +0000268func createLimitNdkExportRule() []Rule {
269 reason := "If the headers you're trying to export are meant to be a part of the NDK, they should be exposed by an ndk_headers module. If the headers shouldn't be a part of the NDK, the headers should instead be exposed from a separate `cc_library_headers` which consumers depend on."
270 // DO NOT ADD HERE - please consult danalbert@
271 // b/357711733
272 return []Rule{
273 NeverAllow().
274 NotIn("frameworks/native/libs/binder/ndk").
275 ModuleType("ndk_library").
276 WithMatcher("export_header_libs", isSetMatcherInstance).Because(reason),
277 NeverAllow().ModuleType("ndk_library").WithMatcher("export_generated_headers", isSetMatcherInstance).Because(reason),
278 NeverAllow().ModuleType("ndk_library").WithMatcher("export_include_dirs", isSetMatcherInstance).Because(reason),
279 NeverAllow().ModuleType("ndk_library").WithMatcher("export_shared_lib_headers", isSetMatcherInstance).Because(reason),
280 NeverAllow().ModuleType("ndk_library").WithMatcher("export_static_lib_headers", isSetMatcherInstance).Because(reason),
281 }
282}
283
Inseob Kim76e19852024-10-10 17:57:22 +0900284func createLimitDirgroupRule() []Rule {
285 reason := "dirgroup module and dir_srcs property of genrule is allowed only to Trusty build rule."
286 return []Rule{
287 NeverAllow().
288 ModuleType("dirgroup").
289 WithMatcher("visibility", NotInList([]string{"//trusty/vendor/google/aosp/scripts"})).Because(reason),
290 NeverAllow().
291 ModuleType("dirgroup").
292 Without("visibility", "//trusty/vendor/google/aosp/scripts").Because(reason),
293 NeverAllow().
294 ModuleType("genrule").
Inseob Kime8b1ac42024-10-24 09:27:44 +0000295 Without("name", "trusty-arm64.lk.elf.gen").
Alice Wang38aed8d2024-11-27 08:18:59 +0000296 Without("name", "trusty-arm64-virt-test-debug.lk.elf.gen").
Inseob Kime8b1ac42024-10-24 09:27:44 +0000297 Without("name", "trusty-x86_64.lk.elf.gen").
298 Without("name", "trusty-x86_64-test.lk.elf.gen").
Inseob Kim76e19852024-10-10 17:57:22 +0900299 WithMatcher("dir_srcs", isSetMatcherInstance).Because(reason),
300 }
301}
302
Jihoon Kang0d545b82024-10-11 00:21:57 +0000303func createFilesystemIsAutoGeneratedRule() Rule {
304 return NeverAllow().
305 NotIn("build/soong/fsgen").
306 ModuleType("filesystem", "android_system_image").
307 WithMatcher("is_auto_generated", isSetMatcherInstance).
308 Because("is_auto_generated property is only allowed for filesystem modules in build/soong/fsgen directory")
309}
310
Luca Stefani50098f72024-10-12 17:55:31 +0200311func createKotlinPluginRule() []Rule {
312 kotlinPluginProjectsAllowedList := []string{
313 // TODO: Migrate compose plugin to the bundled compiler plugin
314 // Actual path prebuilts/sdk/current/androidx/m2repository/androidx/compose/compiler/compiler-hosted
315 "prebuilts/sdk/current/androidx",
316 "external/kotlinc",
317 }
318
319 return []Rule{
320 NeverAllow().
321 NotIn(kotlinPluginProjectsAllowedList...).
322 ModuleType("kotlin_plugin").
323 Because("kotlin_plugin can only be used in allowed projects"),
324 }
325}
326
Jihoon Kang2a7bf752024-11-01 21:21:25 +0000327// These module types are introduced to convert PRODUCT_COPY_FILES to Soong,
328// and is only intended to be used by filesystem_creator.
329func createPrebuiltEtcBpDefineRule() Rule {
330 return NeverAllow().
331 ModuleType(
332 "prebuilt_usr_srec",
333 "prebuilt_priv_app",
334 "prebuilt_rfs",
335 "prebuilt_framework",
336 "prebuilt_res",
337 "prebuilt_wlc_upt",
338 "prebuilt_odm",
Jihoon Kang2e2b7442024-11-05 00:26:20 +0000339 "prebuilt_vendor_dlkm",
340 "prebuilt_bt_firmware",
Jihoon Kangdca2f2b2024-11-06 18:43:19 +0000341 "prebuilt_tvservice",
342 "prebuilt_optee",
Jihoon Kangecf76dd2024-11-12 05:24:46 +0000343 "prebuilt_tvconfig",
Jihoon Kang2a7bf752024-11-01 21:21:25 +0000344 ).
345 DefinedInBpFile().
346 Because("module type not allowed to be defined in bp file")
347}
348
Spandan Dase2f98da2024-11-18 19:22:39 +0000349func createAutogenRroBpDefineRule() Rule {
350 return NeverAllow().
351 ModuleType(
352 "autogen_runtime_resource_overlay",
353 ).
354 DefinedInBpFile().
355 Because("Module type will be autogenerated by soong. Use runtime_resource_overlay instead")
356}
357
Steven Moreland65b3fd92017-12-06 14:18:35 -0800358func neverallowMutator(ctx BottomUpMutatorContext) {
359 m, ok := ctx.Module().(Module)
360 if !ok {
361 return
362 }
363
364 dir := ctx.ModuleDir() + "/"
365 properties := m.GetProperties()
366
Paul Duffinf1c9bbe2019-07-26 10:48:06 +0100367 osClass := ctx.Module().Target().Os.Class
368
Paul Duffin115445b2019-08-07 15:31:07 +0100369 for _, r := range neverallowRules(ctx.Config()) {
Paul Duffin730f2a52019-06-27 14:08:51 +0100370 n := r.(*rule)
Steven Moreland65b3fd92017-12-06 14:18:35 -0800371 if !n.appliesToPath(dir) {
372 continue
373 }
374
Colin Crossfd4f7432019-03-05 15:06:16 -0800375 if !n.appliesToModuleType(ctx.ModuleType()) {
376 continue
377 }
378
Cole Faust5b35cb92024-08-27 15:47:06 -0700379 if !n.appliesToProperties(ctx, properties) {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800380 continue
381 }
382
Paul Duffinf1c9bbe2019-07-26 10:48:06 +0100383 if !n.appliesToOsClass(osClass) {
384 continue
385 }
386
Paul Duffin35781882019-07-25 15:41:09 +0100387 if !n.appliesToDirectDeps(ctx) {
388 continue
389 }
390
Jihoon Kang2a7bf752024-11-01 21:21:25 +0000391 if !n.appliesToBpDefinedModule(ctx) {
392 continue
393 }
394
Steven Moreland65b3fd92017-12-06 14:18:35 -0800395 ctx.ModuleErrorf("violates " + n.String())
396 }
397}
398
Paul Duffin73bf0542019-07-12 14:12:49 +0100399type ValueMatcher interface {
Anton Hanssone1b18362021-12-23 15:05:38 +0000400 Test(string) bool
Paul Duffin73bf0542019-07-12 14:12:49 +0100401 String() string
402}
403
404type equalMatcher struct {
405 expected string
406}
407
Anton Hanssone1b18362021-12-23 15:05:38 +0000408func (m *equalMatcher) Test(value string) bool {
Paul Duffin73bf0542019-07-12 14:12:49 +0100409 return m.expected == value
410}
411
412func (m *equalMatcher) String() string {
413 return "=" + m.expected
414}
415
416type anyMatcher struct {
417}
418
Anton Hanssone1b18362021-12-23 15:05:38 +0000419func (m *anyMatcher) Test(value string) bool {
Paul Duffin73bf0542019-07-12 14:12:49 +0100420 return true
421}
422
423func (m *anyMatcher) String() string {
424 return "=*"
425}
426
427var anyMatcherInstance = &anyMatcher{}
428
Paul Duffinc8111702019-07-22 12:13:55 +0100429type startsWithMatcher struct {
430 prefix string
431}
432
Anton Hanssone1b18362021-12-23 15:05:38 +0000433func (m *startsWithMatcher) Test(value string) bool {
Paul Duffinc8111702019-07-22 12:13:55 +0100434 return strings.HasPrefix(value, m.prefix)
435}
436
437func (m *startsWithMatcher) String() string {
438 return ".starts-with(" + m.prefix + ")"
439}
440
Anton Hansson45376402020-04-09 14:18:21 +0100441type regexMatcher struct {
442 re *regexp.Regexp
443}
444
Anton Hanssone1b18362021-12-23 15:05:38 +0000445func (m *regexMatcher) Test(value string) bool {
Anton Hansson45376402020-04-09 14:18:21 +0100446 return m.re.MatchString(value)
447}
448
449func (m *regexMatcher) String() string {
450 return ".regexp(" + m.re.String() + ")"
451}
452
Andrei Onea115e7e72020-06-05 21:14:03 +0100453type notInListMatcher struct {
454 allowed []string
455}
456
Anton Hanssone1b18362021-12-23 15:05:38 +0000457func (m *notInListMatcher) Test(value string) bool {
Andrei Onea115e7e72020-06-05 21:14:03 +0100458 return !InList(value, m.allowed)
459}
460
461func (m *notInListMatcher) String() string {
462 return ".not-in-list(" + strings.Join(m.allowed, ",") + ")"
463}
464
Colin Crossc511bc52020-04-07 16:50:32 +0000465type isSetMatcher struct{}
466
Anton Hanssone1b18362021-12-23 15:05:38 +0000467func (m *isSetMatcher) Test(value string) bool {
Colin Crossc511bc52020-04-07 16:50:32 +0000468 return value != ""
469}
470
471func (m *isSetMatcher) String() string {
472 return ".is-set"
473}
474
475var isSetMatcherInstance = &isSetMatcher{}
476
Steven Moreland65b3fd92017-12-06 14:18:35 -0800477type ruleProperty struct {
Paul Duffin73bf0542019-07-12 14:12:49 +0100478 fields []string // e.x.: Vndk.Enabled
479 matcher ValueMatcher
Steven Moreland65b3fd92017-12-06 14:18:35 -0800480}
481
Liz Kammera3d79152021-10-28 18:14:04 -0400482func (r *ruleProperty) String() string {
483 return fmt.Sprintf("%q matches: %s", strings.Join(r.fields, "."), r.matcher)
484}
485
486type ruleProperties []ruleProperty
487
488func (r ruleProperties) String() string {
489 var s []string
490 for _, r := range r {
491 s = append(s, r.String())
492 }
493 return strings.Join(s, " ")
494}
495
Paul Duffin730f2a52019-06-27 14:08:51 +0100496// A NeverAllow rule.
497type Rule interface {
498 In(path ...string) Rule
499
500 NotIn(path ...string) Rule
501
Paul Duffin35781882019-07-25 15:41:09 +0100502 InDirectDeps(deps ...string) Rule
503
Paul Duffinf1c9bbe2019-07-26 10:48:06 +0100504 WithOsClass(osClasses ...OsClass) Rule
505
Paul Duffin730f2a52019-06-27 14:08:51 +0100506 ModuleType(types ...string) Rule
507
508 NotModuleType(types ...string) Rule
509
510 With(properties, value string) Rule
511
Paul Duffinc8111702019-07-22 12:13:55 +0100512 WithMatcher(properties string, matcher ValueMatcher) Rule
513
Paul Duffin730f2a52019-06-27 14:08:51 +0100514 Without(properties, value string) Rule
515
Paul Duffinc8111702019-07-22 12:13:55 +0100516 WithoutMatcher(properties string, matcher ValueMatcher) Rule
517
Jihoon Kang2a7bf752024-11-01 21:21:25 +0000518 DefinedInBpFile() Rule
519
Paul Duffin730f2a52019-06-27 14:08:51 +0100520 Because(reason string) Rule
521}
522
Steven Moreland65b3fd92017-12-06 14:18:35 -0800523type rule struct {
524 // User string for why this is a thing.
525 reason string
526
527 paths []string
528 unlessPaths []string
529
Paul Duffin35781882019-07-25 15:41:09 +0100530 directDeps map[string]bool
531
Paul Duffinf1c9bbe2019-07-26 10:48:06 +0100532 osClasses []OsClass
533
Colin Crossfd4f7432019-03-05 15:06:16 -0800534 moduleTypes []string
535 unlessModuleTypes []string
536
Liz Kammera3d79152021-10-28 18:14:04 -0400537 props ruleProperties
538 unlessProps ruleProperties
Andrei Onea115e7e72020-06-05 21:14:03 +0100539
540 onlyBootclasspathJar bool
Jihoon Kang2a7bf752024-11-01 21:21:25 +0000541
542 definedInBp bool
Steven Moreland65b3fd92017-12-06 14:18:35 -0800543}
544
Paul Duffin730f2a52019-06-27 14:08:51 +0100545// Create a new NeverAllow rule.
546func NeverAllow() Rule {
Paul Duffin35781882019-07-25 15:41:09 +0100547 return &rule{directDeps: make(map[string]bool)}
Steven Moreland65b3fd92017-12-06 14:18:35 -0800548}
Colin Crossfd4f7432019-03-05 15:06:16 -0800549
Liz Kammera3d79152021-10-28 18:14:04 -0400550// In adds path(s) where this rule applies.
Paul Duffin730f2a52019-06-27 14:08:51 +0100551func (r *rule) In(path ...string) Rule {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800552 r.paths = append(r.paths, cleanPaths(path)...)
553 return r
554}
Colin Crossfd4f7432019-03-05 15:06:16 -0800555
Liz Kammera3d79152021-10-28 18:14:04 -0400556// NotIn adds path(s) to that this rule does not apply to.
Paul Duffin730f2a52019-06-27 14:08:51 +0100557func (r *rule) NotIn(path ...string) Rule {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800558 r.unlessPaths = append(r.unlessPaths, cleanPaths(path)...)
559 return r
560}
Colin Crossfd4f7432019-03-05 15:06:16 -0800561
Liz Kammera3d79152021-10-28 18:14:04 -0400562// InDirectDeps adds dep(s) that are not allowed with this rule.
Paul Duffin35781882019-07-25 15:41:09 +0100563func (r *rule) InDirectDeps(deps ...string) Rule {
564 for _, d := range deps {
565 r.directDeps[d] = true
566 }
567 return r
568}
569
Liz Kammera3d79152021-10-28 18:14:04 -0400570// WithOsClass adds osClass(es) that this rule applies to.
Paul Duffinf1c9bbe2019-07-26 10:48:06 +0100571func (r *rule) WithOsClass(osClasses ...OsClass) Rule {
572 r.osClasses = append(r.osClasses, osClasses...)
573 return r
574}
575
Liz Kammera3d79152021-10-28 18:14:04 -0400576// ModuleType adds type(s) that this rule applies to.
Paul Duffin730f2a52019-06-27 14:08:51 +0100577func (r *rule) ModuleType(types ...string) Rule {
Colin Crossfd4f7432019-03-05 15:06:16 -0800578 r.moduleTypes = append(r.moduleTypes, types...)
579 return r
580}
581
Liz Kammera3d79152021-10-28 18:14:04 -0400582// NotModuleType adds type(s) that this rule does not apply to..
Paul Duffin730f2a52019-06-27 14:08:51 +0100583func (r *rule) NotModuleType(types ...string) Rule {
Colin Crossfd4f7432019-03-05 15:06:16 -0800584 r.unlessModuleTypes = append(r.unlessModuleTypes, types...)
585 return r
586}
587
Liz Kammera3d79152021-10-28 18:14:04 -0400588// With specifies property/value combinations that are restricted for this rule.
Paul Duffin730f2a52019-06-27 14:08:51 +0100589func (r *rule) With(properties, value string) Rule {
Paul Duffinc8111702019-07-22 12:13:55 +0100590 return r.WithMatcher(properties, selectMatcher(value))
591}
592
Liz Kammera3d79152021-10-28 18:14:04 -0400593// WithMatcher specifies property/matcher combinations that are restricted for this rule.
Paul Duffinc8111702019-07-22 12:13:55 +0100594func (r *rule) WithMatcher(properties string, matcher ValueMatcher) Rule {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800595 r.props = append(r.props, ruleProperty{
Paul Duffin73bf0542019-07-12 14:12:49 +0100596 fields: fieldNamesForProperties(properties),
Paul Duffinc8111702019-07-22 12:13:55 +0100597 matcher: matcher,
Steven Moreland65b3fd92017-12-06 14:18:35 -0800598 })
599 return r
600}
Colin Crossfd4f7432019-03-05 15:06:16 -0800601
Liz Kammera3d79152021-10-28 18:14:04 -0400602// Without specifies property/value combinations that this rule does not apply to.
Paul Duffin730f2a52019-06-27 14:08:51 +0100603func (r *rule) Without(properties, value string) Rule {
Paul Duffinc8111702019-07-22 12:13:55 +0100604 return r.WithoutMatcher(properties, selectMatcher(value))
605}
606
Liz Kammera3d79152021-10-28 18:14:04 -0400607// Without specifies property/matcher combinations that this rule does not apply to.
Paul Duffinc8111702019-07-22 12:13:55 +0100608func (r *rule) WithoutMatcher(properties string, matcher ValueMatcher) Rule {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800609 r.unlessProps = append(r.unlessProps, ruleProperty{
Paul Duffin73bf0542019-07-12 14:12:49 +0100610 fields: fieldNamesForProperties(properties),
Paul Duffinc8111702019-07-22 12:13:55 +0100611 matcher: matcher,
Steven Moreland65b3fd92017-12-06 14:18:35 -0800612 })
613 return r
614}
Colin Crossfd4f7432019-03-05 15:06:16 -0800615
Jihoon Kang2a7bf752024-11-01 21:21:25 +0000616// DefinedInBpFile specifies that this rule applies to modules that are defined
617// in bp files, and does not apply to modules that are auto generated by other modules.
618func (r *rule) DefinedInBpFile() Rule {
619 r.definedInBp = true
620 return r
621}
622
Paul Duffin73bf0542019-07-12 14:12:49 +0100623func selectMatcher(expected string) ValueMatcher {
624 if expected == "*" {
625 return anyMatcherInstance
626 }
627 return &equalMatcher{expected: expected}
628}
629
Liz Kammera3d79152021-10-28 18:14:04 -0400630// Because specifies a reason for this rule.
Paul Duffin730f2a52019-06-27 14:08:51 +0100631func (r *rule) Because(reason string) Rule {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800632 r.reason = reason
633 return r
634}
635
636func (r *rule) String() string {
Liz Kammera3d79152021-10-28 18:14:04 -0400637 s := []string{"neverallow requirements. Not allowed:"}
638 if len(r.paths) > 0 {
639 s = append(s, fmt.Sprintf("in dirs: %q", r.paths))
Steven Moreland65b3fd92017-12-06 14:18:35 -0800640 }
Liz Kammera3d79152021-10-28 18:14:04 -0400641 if len(r.moduleTypes) > 0 {
642 s = append(s, fmt.Sprintf("module types: %q", r.moduleTypes))
Steven Moreland65b3fd92017-12-06 14:18:35 -0800643 }
Liz Kammera3d79152021-10-28 18:14:04 -0400644 if len(r.props) > 0 {
645 s = append(s, fmt.Sprintf("properties matching: %s", r.props))
Colin Crossfd4f7432019-03-05 15:06:16 -0800646 }
Liz Kammera3d79152021-10-28 18:14:04 -0400647 if len(r.directDeps) > 0 {
Cole Faust18994c72023-02-28 16:02:16 -0800648 s = append(s, fmt.Sprintf("dep(s): %q", SortedKeys(r.directDeps)))
Colin Crossfd4f7432019-03-05 15:06:16 -0800649 }
Liz Kammera3d79152021-10-28 18:14:04 -0400650 if len(r.osClasses) > 0 {
651 s = append(s, fmt.Sprintf("os class(es): %q", r.osClasses))
Paul Duffinf1c9bbe2019-07-26 10:48:06 +0100652 }
Liz Kammera3d79152021-10-28 18:14:04 -0400653 if len(r.unlessPaths) > 0 {
654 s = append(s, fmt.Sprintf("EXCEPT in dirs: %q", r.unlessPaths))
655 }
656 if len(r.unlessModuleTypes) > 0 {
657 s = append(s, fmt.Sprintf("EXCEPT module types: %q", r.unlessModuleTypes))
658 }
659 if len(r.unlessProps) > 0 {
660 s = append(s, fmt.Sprintf("EXCEPT properties matching: %q", r.unlessProps))
Andrei Onea115e7e72020-06-05 21:14:03 +0100661 }
Steven Moreland65b3fd92017-12-06 14:18:35 -0800662 if len(r.reason) != 0 {
Liz Kammera3d79152021-10-28 18:14:04 -0400663 s = append(s, " which is restricted because "+r.reason)
Steven Moreland65b3fd92017-12-06 14:18:35 -0800664 }
Liz Kammera3d79152021-10-28 18:14:04 -0400665 if len(s) == 1 {
666 s[0] = "neverallow requirements (empty)"
667 }
668 return strings.Join(s, "\n\t")
Steven Moreland65b3fd92017-12-06 14:18:35 -0800669}
670
671func (r *rule) appliesToPath(dir string) bool {
Jaewoong Jung3aff5782020-02-11 07:54:35 -0800672 includePath := len(r.paths) == 0 || HasAnyPrefix(dir, r.paths)
673 excludePath := HasAnyPrefix(dir, r.unlessPaths)
Steven Moreland65b3fd92017-12-06 14:18:35 -0800674 return includePath && !excludePath
675}
676
Paul Duffin35781882019-07-25 15:41:09 +0100677func (r *rule) appliesToDirectDeps(ctx BottomUpMutatorContext) bool {
678 if len(r.directDeps) == 0 {
679 return true
680 }
681
682 matches := false
683 ctx.VisitDirectDeps(func(m Module) {
684 if !matches {
685 name := ctx.OtherModuleName(m)
686 matches = r.directDeps[name]
687 }
688 })
689
690 return matches
691}
692
Paul Duffinf1c9bbe2019-07-26 10:48:06 +0100693func (r *rule) appliesToOsClass(osClass OsClass) bool {
694 if len(r.osClasses) == 0 {
695 return true
696 }
697
698 for _, c := range r.osClasses {
699 if c == osClass {
700 return true
701 }
702 }
703
704 return false
705}
706
Colin Crossfd4f7432019-03-05 15:06:16 -0800707func (r *rule) appliesToModuleType(moduleType string) bool {
708 return (len(r.moduleTypes) == 0 || InList(moduleType, r.moduleTypes)) && !InList(moduleType, r.unlessModuleTypes)
709}
710
Cole Faust5b35cb92024-08-27 15:47:06 -0700711func (r *rule) appliesToProperties(ctx BottomUpMutatorContext, properties []interface{}) bool {
712 includeProps := hasAllProperties(ctx, properties, r.props)
713 excludeProps := hasAnyProperty(ctx, properties, r.unlessProps)
Steven Moreland65b3fd92017-12-06 14:18:35 -0800714 return includeProps && !excludeProps
715}
716
Jihoon Kang2a7bf752024-11-01 21:21:25 +0000717func (r *rule) appliesToBpDefinedModule(ctx BottomUpMutatorContext) bool {
718 if !r.definedInBp {
719 return true
720 }
721 return !ctx.OtherModuleIsAutoGenerated(ctx.Module()) == r.definedInBp
722}
723
Paul Duffinc8111702019-07-22 12:13:55 +0100724func StartsWith(prefix string) ValueMatcher {
725 return &startsWithMatcher{prefix}
726}
727
Anton Hansson45376402020-04-09 14:18:21 +0100728func Regexp(re string) ValueMatcher {
729 r, err := regexp.Compile(re)
730 if err != nil {
731 panic(err)
732 }
733 return &regexMatcher{r}
734}
735
Andrei Onea115e7e72020-06-05 21:14:03 +0100736func NotInList(allowed []string) ValueMatcher {
737 return &notInListMatcher{allowed}
738}
739
Steven Moreland65b3fd92017-12-06 14:18:35 -0800740// assorted utils
741
742func cleanPaths(paths []string) []string {
743 res := make([]string, len(paths))
744 for i, v := range paths {
745 res[i] = filepath.Clean(v) + "/"
746 }
747 return res
748}
749
750func fieldNamesForProperties(propertyNames string) []string {
751 names := strings.Split(propertyNames, ".")
752 for i, v := range names {
753 names[i] = proptools.FieldNameForProperty(v)
754 }
755 return names
756}
757
Cole Faust5b35cb92024-08-27 15:47:06 -0700758func hasAnyProperty(ctx BottomUpMutatorContext, properties []interface{}, props []ruleProperty) bool {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800759 for _, v := range props {
Cole Faust5b35cb92024-08-27 15:47:06 -0700760 if hasProperty(ctx, properties, v) {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800761 return true
762 }
763 }
764 return false
765}
766
Cole Faust5b35cb92024-08-27 15:47:06 -0700767func hasAllProperties(ctx BottomUpMutatorContext, properties []interface{}, props []ruleProperty) bool {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800768 for _, v := range props {
Cole Faust5b35cb92024-08-27 15:47:06 -0700769 if !hasProperty(ctx, properties, v) {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800770 return false
771 }
772 }
773 return true
774}
775
Cole Faust5b35cb92024-08-27 15:47:06 -0700776func hasProperty(ctx BottomUpMutatorContext, properties []interface{}, prop ruleProperty) bool {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800777 for _, propertyStruct := range properties {
778 propertiesValue := reflect.ValueOf(propertyStruct).Elem()
779 for _, v := range prop.fields {
780 if !propertiesValue.IsValid() {
781 break
782 }
783 propertiesValue = propertiesValue.FieldByName(v)
784 }
785 if !propertiesValue.IsValid() {
786 continue
787 }
788
Paul Duffin73bf0542019-07-12 14:12:49 +0100789 check := func(value string) bool {
Anton Hanssone1b18362021-12-23 15:05:38 +0000790 return prop.matcher.Test(value)
Steven Moreland65b3fd92017-12-06 14:18:35 -0800791 }
792
Cole Faust5b35cb92024-08-27 15:47:06 -0700793 if matchValue(ctx, propertiesValue, check) {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800794 return true
795 }
796 }
797 return false
798}
799
Cole Faust5b35cb92024-08-27 15:47:06 -0700800func matchValue(ctx BottomUpMutatorContext, value reflect.Value, check func(string) bool) bool {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800801 if !value.IsValid() {
802 return false
803 }
804
805 if value.Kind() == reflect.Ptr {
806 if value.IsNil() {
807 return check("")
808 }
809 value = value.Elem()
810 }
811
Cole Faust5b35cb92024-08-27 15:47:06 -0700812 switch v := value.Interface().(type) {
813 case string:
814 return check(v)
815 case bool:
816 return check(strconv.FormatBool(v))
817 case int:
818 return check(strconv.FormatInt((int64)(v), 10))
819 case []string:
820 for _, v := range v {
821 if check(v) {
822 return true
823 }
Steven Moreland65b3fd92017-12-06 14:18:35 -0800824 }
Cole Faust5b35cb92024-08-27 15:47:06 -0700825 return false
826 case proptools.Configurable[string]:
827 return check(v.GetOrDefault(ctx, ""))
828 case proptools.Configurable[bool]:
829 return check(strconv.FormatBool(v.GetOrDefault(ctx, false)))
830 case proptools.Configurable[[]string]:
831 for _, v := range v.GetOrDefault(ctx, nil) {
Steven Moreland65b3fd92017-12-06 14:18:35 -0800832 if check(v) {
833 return true
834 }
835 }
836 return false
837 }
838
839 panic("Can't handle type: " + value.Kind().String())
840}
Paul Duffin115445b2019-08-07 15:31:07 +0100841
842var neverallowRulesKey = NewOnceKey("neverallowRules")
843
844func neverallowRules(config Config) []Rule {
845 return config.Once(neverallowRulesKey, func() interface{} {
846 // No test rules were set by setTestNeverallowRules, use the global rules
847 return neverallows
848 }).([]Rule)
849}
850
851// Overrides the default neverallow rules for the supplied config.
852//
853// For testing only.
Paul Duffin45338f02021-03-30 23:07:52 +0100854func setTestNeverallowRules(config Config, testRules []Rule) {
Paul Duffin115445b2019-08-07 15:31:07 +0100855 config.Once(neverallowRulesKey, func() interface{} { return testRules })
856}
Paul Duffin45338f02021-03-30 23:07:52 +0100857
858// Prepares for a test by setting neverallow rules and enabling the mutator.
859//
860// If the supplied rules are nil then the default rules are used.
861func PrepareForTestWithNeverallowRules(testRules []Rule) FixturePreparer {
862 return GroupFixturePreparers(
863 FixtureModifyConfig(func(config Config) {
864 if testRules != nil {
865 setTestNeverallowRules(config, testRules)
866 }
867 }),
868 FixtureRegisterWithContext(func(ctx RegistrationContext) {
869 ctx.PostDepsMutators(registerNeverallowMutator)
870 }),
871 )
872}