Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 1 | // 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 | |
| 15 | package android |
| 16 | |
| 17 | import ( |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 18 | "fmt" |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 19 | "path/filepath" |
| 20 | "reflect" |
Anton Hansson | 4537640 | 2020-04-09 14:18:21 +0100 | [diff] [blame] | 21 | "regexp" |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 22 | "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 Onorato | b4638c1 | 2021-10-27 15:47:06 -0700 | [diff] [blame] | 31 | // against assumptions, in progress code refactors, or policy to be expressed in a |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 32 | // 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 Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 36 | // - 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 Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 39 | // - - 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 Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 44 | // - it has none of the "Without" properties matched (same rules as above) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 45 | |
Paul Duffin | 45338f0 | 2021-03-30 23:07:52 +0100 | [diff] [blame] | 46 | func registerNeverallowMutator(ctx RegisterMutatorsContext) { |
Colin Cross | 8a96280 | 2024-10-09 15:29:27 -0700 | [diff] [blame] | 47 | ctx.BottomUp("neverallow", neverallowMutator) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 48 | } |
| 49 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 50 | var neverallows = []Rule{} |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 51 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 52 | func init() { |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 53 | AddNeverAllowRules(createIncludeDirsRules()...) |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 54 | AddNeverAllowRules(createTrebleRules()...) |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 55 | AddNeverAllowRules(createJavaDeviceForHostRules()...) |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 56 | AddNeverAllowRules(createCcSdkVariantRules()...) |
David Srbecky | e033cba | 2020-05-20 22:20:28 +0100 | [diff] [blame] | 57 | AddNeverAllowRules(createUncompressDexRules()...) |
Nelson Li | 4380820 | 2024-11-20 09:05:53 +0000 | [diff] [blame] | 58 | AddNeverAllowRules(createInstallInRootAllowingRules()...) |
Jiyong Park | 3c306f3 | 2022-04-05 15:29:53 +0900 | [diff] [blame] | 59 | AddNeverAllowRules(createProhibitFrameworkAccessRules()...) |
Alan Stokes | 73feba3 | 2022-11-14 12:21:24 +0000 | [diff] [blame] | 60 | AddNeverAllowRules(createCcStubsRule()) |
Mark White | a15790a | 2023-08-22 21:28:11 +0000 | [diff] [blame] | 61 | AddNeverAllowRules(createProhibitHeaderOnlyRule()) |
Steven Moreland | 0db999c | 2024-09-03 22:06:24 +0000 | [diff] [blame] | 62 | AddNeverAllowRules(createLimitNdkExportRule()...) |
Inseob Kim | 76e1985 | 2024-10-10 17:57:22 +0900 | [diff] [blame] | 63 | AddNeverAllowRules(createLimitDirgroupRule()...) |
Jihoon Kang | 0d545b8 | 2024-10-11 00:21:57 +0000 | [diff] [blame] | 64 | AddNeverAllowRules(createFilesystemIsAutoGeneratedRule()) |
Luca Stefani | 50098f7 | 2024-10-12 17:55:31 +0200 | [diff] [blame] | 65 | AddNeverAllowRules(createKotlinPluginRule()...) |
Jihoon Kang | 2a7bf75 | 2024-11-01 21:21:25 +0000 | [diff] [blame] | 66 | AddNeverAllowRules(createPrebuiltEtcBpDefineRule()) |
Spandan Das | e2f98da | 2024-11-18 19:22:39 +0000 | [diff] [blame] | 67 | AddNeverAllowRules(createAutogenRroBpDefineRule()) |
Neil Fuller | df5f356 | 2018-10-21 17:19:10 +0100 | [diff] [blame] | 68 | } |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 69 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 70 | // Add a NeverAllow rule to the set of rules to apply. |
| 71 | func AddNeverAllowRules(rules ...Rule) { |
| 72 | neverallows = append(neverallows, rules...) |
| 73 | } |
| 74 | |
Sam Delmerico | 46d08b4 | 2022-11-15 15:51:04 -0500 | [diff] [blame] | 75 | var ( |
| 76 | neverallowNotInIncludeDir = []string{ |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 77 | "art", |
Orion Hodson | 6341f01 | 2019-11-06 13:39:46 +0000 | [diff] [blame] | 78 | "art/libnativebridge", |
| 79 | "art/libnativeloader", |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 80 | "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 Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 91 | } |
Sam Delmerico | 46d08b4 | 2022-11-15 15:51:04 -0500 | [diff] [blame] | 92 | neverallowNoUseIncludeDir = []string{ |
Steven Moreland | f36a3ac | 2021-04-27 18:03:14 +0000 | [diff] [blame] | 93 | "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 Moreland | 8fc8dbf | 2021-04-27 02:31:07 +0000 | [diff] [blame] | 101 | "system/libfmq", |
Steven Moreland | f36a3ac | 2021-04-27 18:03:14 +0000 | [diff] [blame] | 102 | "system/libvintf", |
Steven Moreland | 8fc8dbf | 2021-04-27 02:31:07 +0000 | [diff] [blame] | 103 | } |
Sam Delmerico | 46d08b4 | 2022-11-15 15:51:04 -0500 | [diff] [blame] | 104 | ) |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 105 | |
Sam Delmerico | 46d08b4 | 2022-11-15 15:51:04 -0500 | [diff] [blame] | 106 | func createIncludeDirsRules() []Rule { |
| 107 | rules := make([]Rule, 0, len(neverallowNotInIncludeDir)+len(neverallowNoUseIncludeDir)) |
Steven Moreland | 8fc8dbf | 2021-04-27 02:31:07 +0000 | [diff] [blame] | 108 | |
Sam Delmerico | 46d08b4 | 2022-11-15 15:51:04 -0500 | [diff] [blame] | 109 | for _, path := range neverallowNotInIncludeDir { |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 110 | 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 Delmerico | 46d08b4 | 2022-11-15 15:51:04 -0500 | [diff] [blame] | 119 | for _, path := range neverallowNoUseIncludeDir { |
Steven Moreland | 8fc8dbf | 2021-04-27 02:31:07 +0000 | [diff] [blame] | 120 | 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 Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 126 | return rules |
| 127 | } |
| 128 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 129 | func createTrebleRules() []Rule { |
| 130 | return []Rule{ |
| 131 | NeverAllow(). |
| 132 | In("vendor", "device"). |
| 133 | With("vndk.enabled", "true"). |
| 134 | Without("vendor", "true"). |
Justin Yun | 0ecf0b2 | 2020-02-28 15:07:59 +0900 | [diff] [blame] | 135 | Without("product_specific", "true"). |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 136 | 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 Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 142 | |
Neil Fuller | df5f356 | 2018-10-21 17:19:10 +0100 | [diff] [blame] | 143 | // TODO(b/67974785): always enforce the manifest |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 144 | NeverAllow(). |
Steven Moreland | 51ce4f6 | 2020-02-10 17:21:32 -0800 | [diff] [blame] | 145 | Without("name", "libhidlbase-combined-impl"). |
| 146 | Without("name", "libhidlbase"). |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 147 | With("product_variables.enforce_vintf_manifest.cflags", "*"). |
| 148 | Because("manifest enforcement should be independent of ."), |
Neil Fuller | df5f356 | 2018-10-21 17:19:10 +0100 | [diff] [blame] | 149 | |
| 150 | // TODO(b/67975799): vendor code should always use /vendor/bin/sh |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 151 | 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 Fuller | df5f356 | 2018-10-21 17:19:10 +0100 | [diff] [blame] | 155 | |
| 156 | // Example: |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 157 | // *NeverAllow().with("Srcs", "main.cpp")) |
Neil Fuller | df5f356 | 2018-10-21 17:19:10 +0100 | [diff] [blame] | 158 | } |
| 159 | } |
| 160 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 161 | func createJavaDeviceForHostRules() []Rule { |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 162 | javaDeviceForHostProjectsAllowedList := []string{ |
Dan Willemsen | 9fe1410 | 2021-07-13 21:52:04 -0700 | [diff] [blame] | 163 | "development/build", |
Colin Cross | b5191a5 | 2019-04-11 14:07:38 -0700 | [diff] [blame] | 164 | "external/guava", |
Steve Elliott | 8053f82 | 2022-10-18 17:09:28 -0400 | [diff] [blame] | 165 | "external/kotlinx.coroutines", |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 166 | "external/robolectric-shadows", |
Rex Hoffman | 54641d2 | 2022-08-25 17:29:50 +0000 | [diff] [blame] | 167 | "external/robolectric", |
Makoto Onuki | b66bba3 | 2023-11-11 00:06:09 +0000 | [diff] [blame] | 168 | "frameworks/base/ravenwood", |
| 169 | "frameworks/base/tools/hoststubgen", |
Jerome Gaillard | 655ee02 | 2021-09-23 11:38:08 +0000 | [diff] [blame] | 170 | "frameworks/layoutlib", |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 171 | } |
| 172 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 173 | return []Rule{ |
| 174 | NeverAllow(). |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 175 | NotIn(javaDeviceForHostProjectsAllowedList...). |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 176 | ModuleType("java_device_for_host", "java_host_for_device"). |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 177 | Because("java_device_for_host can only be used in allowed projects"), |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 178 | } |
| 179 | } |
| 180 | |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 181 | func createCcSdkVariantRules() []Rule { |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 182 | sdkVersionOnlyAllowedList := []string{ |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 183 | // 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 Hansson | 4b8e64b | 2020-05-27 18:25:23 +0100 | [diff] [blame] | 187 | "packages/modules/SdkExtensions/derive_sdk", |
Dan Albert | e2054a9 | 2020-04-20 14:46:47 -0700 | [diff] [blame] | 188 | // These are for apps and shouldn't be used by non-SDK variant modules. |
| 189 | "prebuilts/ndk", |
Jiyong Park | a574d53 | 2024-08-28 18:06:43 +0900 | [diff] [blame] | 190 | "frameworks/native/libs/binder/ndk", |
Dan Albert | e2054a9 | 2020-04-20 14:46:47 -0700 | [diff] [blame] | 191 | "tools/test/graphicsbenchmark/apps/sample_app", |
| 192 | "tools/test/graphicsbenchmark/functional_tests/java", |
Dan Albert | 5557605 | 2020-04-20 14:46:47 -0700 | [diff] [blame] | 193 | "vendor/xts/gts-tests/hostsidetests/gamedevicecert/apps/javatests", |
Chang Li | 66d3cb7 | 2021-06-18 14:04:50 +0000 | [diff] [blame] | 194 | "external/libtextclassifier/native", |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 195 | } |
| 196 | |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 197 | platformVariantPropertiesAllowedList := []string{ |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 198 | // 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 Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 209 | NotIn(sdkVersionOnlyAllowedList...). |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 210 | WithMatcher("sdk_variant_only", isSetMatcherInstance). |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 211 | Because("sdk_variant_only can only be used in allowed projects"), |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 212 | NeverAllow(). |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 213 | NotIn(platformVariantPropertiesAllowedList...). |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 214 | WithMatcher("platform.shared_libs", isSetMatcherInstance). |
Colin Cross | 440e0d0 | 2020-06-11 11:32:11 -0700 | [diff] [blame] | 215 | Because("platform variant properties can only be used in allowed projects"), |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 216 | } |
| 217 | } |
| 218 | |
Alan Stokes | 73feba3 | 2022-11-14 12:21:24 +0000 | [diff] [blame] | 219 | func createCcStubsRule() Rule { |
| 220 | ccStubsImplementationInstallableProjectsAllowedList := []string{ |
Jiyong Park | f6736c7 | 2024-07-22 11:22:35 +0900 | [diff] [blame] | 221 | "packages/modules/Virtualization/libs/libvm_payload", |
Alan Stokes | 73feba3 | 2022-11-14 12:21:24 +0000 | [diff] [blame] | 222 | } |
| 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 Srbecky | e033cba | 2020-05-20 22:20:28 +0100 | [diff] [blame] | 230 | func 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 Li | 4380820 | 2024-11-20 09:05:53 +0000 | [diff] [blame] | 239 | func createInstallInRootAllowingRules() []Rule { |
Inseob Kim | 800d114 | 2021-06-14 12:03:51 +0900 | [diff] [blame] | 240 | return []Rule{ |
| 241 | NeverAllow(). |
Nikita Ioffe | 11a9c2c | 2023-06-21 16:51:09 +0100 | [diff] [blame] | 242 | Without("name", "init_first_stage_defaults"). |
Inseob Kim | 800d114 | 2021-06-14 12:03:51 +0900 | [diff] [blame] | 243 | Without("name", "init_first_stage"). |
Nikita Ioffe | 11a9c2c | 2023-06-21 16:51:09 +0100 | [diff] [blame] | 244 | Without("name", "init_first_stage.microdroid"). |
Nelson Li | 4380820 | 2024-11-20 09:05:53 +0000 | [diff] [blame] | 245 | Without("name", "librecovery_ui_ext"). |
Inseob Kim | 800d114 | 2021-06-14 12:03:51 +0900 | [diff] [blame] | 246 | With("install_in_root", "true"). |
Inseob Kim | be6a66d | 2024-07-11 15:43:44 +0900 | [diff] [blame] | 247 | NotModuleType("prebuilt_root"). |
Nelson Li | 4380820 | 2024-11-20 09:05:53 +0000 | [diff] [blame] | 248 | Because("install_in_root is only for init_first_stage or librecovery_ui_ext."), |
Inseob Kim | 800d114 | 2021-06-14 12:03:51 +0900 | [diff] [blame] | 249 | } |
| 250 | } |
| 251 | |
Jiyong Park | 3c306f3 | 2022-04-05 15:29:53 +0900 | [diff] [blame] | 252 | func 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 White | a15790a | 2023-08-22 21:28:11 +0000 | [diff] [blame] | 261 | func 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 Moreland | 0db999c | 2024-09-03 22:06:24 +0000 | [diff] [blame] | 268 | func 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 Kim | 76e1985 | 2024-10-10 17:57:22 +0900 | [diff] [blame] | 284 | func createLimitDirgroupRule() []Rule { |
Inseob Kim | 7195b06 | 2024-11-29 15:40:49 +0900 | [diff] [blame^] | 285 | reason := "dirgroup module and dir_srcs / keep_gendir property of genrule is allowed only to Trusty build rule." |
Inseob Kim | 76e1985 | 2024-10-10 17:57:22 +0900 | [diff] [blame] | 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 Kim | e8b1ac4 | 2024-10-24 09:27:44 +0000 | [diff] [blame] | 295 | Without("name", "trusty-arm64.lk.elf.gen"). |
Alice Wang | 38aed8d | 2024-11-27 08:18:59 +0000 | [diff] [blame] | 296 | Without("name", "trusty-arm64-virt-test-debug.lk.elf.gen"). |
Inseob Kim | e8b1ac4 | 2024-10-24 09:27:44 +0000 | [diff] [blame] | 297 | Without("name", "trusty-x86_64.lk.elf.gen"). |
| 298 | Without("name", "trusty-x86_64-test.lk.elf.gen"). |
Inseob Kim | 76e1985 | 2024-10-10 17:57:22 +0900 | [diff] [blame] | 299 | WithMatcher("dir_srcs", isSetMatcherInstance).Because(reason), |
Inseob Kim | 7195b06 | 2024-11-29 15:40:49 +0900 | [diff] [blame^] | 300 | NeverAllow(). |
| 301 | ModuleType("genrule"). |
| 302 | Without("name", "trusty-arm64.lk.elf.gen"). |
| 303 | Without("name", "trusty-arm64-virt-test-debug.lk.elf.gen"). |
| 304 | Without("name", "trusty-x86_64.lk.elf.gen"). |
| 305 | Without("name", "trusty-x86_64-test.lk.elf.gen"). |
| 306 | With("keep_gendir", "true").Because(reason), |
Inseob Kim | 76e1985 | 2024-10-10 17:57:22 +0900 | [diff] [blame] | 307 | } |
| 308 | } |
| 309 | |
Jihoon Kang | 0d545b8 | 2024-10-11 00:21:57 +0000 | [diff] [blame] | 310 | func createFilesystemIsAutoGeneratedRule() Rule { |
| 311 | return NeverAllow(). |
| 312 | NotIn("build/soong/fsgen"). |
| 313 | ModuleType("filesystem", "android_system_image"). |
| 314 | WithMatcher("is_auto_generated", isSetMatcherInstance). |
| 315 | Because("is_auto_generated property is only allowed for filesystem modules in build/soong/fsgen directory") |
| 316 | } |
| 317 | |
Luca Stefani | 50098f7 | 2024-10-12 17:55:31 +0200 | [diff] [blame] | 318 | func createKotlinPluginRule() []Rule { |
| 319 | kotlinPluginProjectsAllowedList := []string{ |
| 320 | // TODO: Migrate compose plugin to the bundled compiler plugin |
| 321 | // Actual path prebuilts/sdk/current/androidx/m2repository/androidx/compose/compiler/compiler-hosted |
| 322 | "prebuilts/sdk/current/androidx", |
| 323 | "external/kotlinc", |
| 324 | } |
| 325 | |
| 326 | return []Rule{ |
| 327 | NeverAllow(). |
| 328 | NotIn(kotlinPluginProjectsAllowedList...). |
| 329 | ModuleType("kotlin_plugin"). |
| 330 | Because("kotlin_plugin can only be used in allowed projects"), |
| 331 | } |
| 332 | } |
| 333 | |
Jihoon Kang | 2a7bf75 | 2024-11-01 21:21:25 +0000 | [diff] [blame] | 334 | // These module types are introduced to convert PRODUCT_COPY_FILES to Soong, |
| 335 | // and is only intended to be used by filesystem_creator. |
| 336 | func createPrebuiltEtcBpDefineRule() Rule { |
| 337 | return NeverAllow(). |
| 338 | ModuleType( |
| 339 | "prebuilt_usr_srec", |
| 340 | "prebuilt_priv_app", |
| 341 | "prebuilt_rfs", |
| 342 | "prebuilt_framework", |
| 343 | "prebuilt_res", |
| 344 | "prebuilt_wlc_upt", |
| 345 | "prebuilt_odm", |
Jihoon Kang | 2e2b744 | 2024-11-05 00:26:20 +0000 | [diff] [blame] | 346 | "prebuilt_vendor_dlkm", |
| 347 | "prebuilt_bt_firmware", |
Jihoon Kang | dca2f2b | 2024-11-06 18:43:19 +0000 | [diff] [blame] | 348 | "prebuilt_tvservice", |
| 349 | "prebuilt_optee", |
Jihoon Kang | ecf76dd | 2024-11-12 05:24:46 +0000 | [diff] [blame] | 350 | "prebuilt_tvconfig", |
Jihoon Kang | 2a7bf75 | 2024-11-01 21:21:25 +0000 | [diff] [blame] | 351 | ). |
| 352 | DefinedInBpFile(). |
| 353 | Because("module type not allowed to be defined in bp file") |
| 354 | } |
| 355 | |
Spandan Das | e2f98da | 2024-11-18 19:22:39 +0000 | [diff] [blame] | 356 | func createAutogenRroBpDefineRule() Rule { |
| 357 | return NeverAllow(). |
| 358 | ModuleType( |
| 359 | "autogen_runtime_resource_overlay", |
| 360 | ). |
| 361 | DefinedInBpFile(). |
| 362 | Because("Module type will be autogenerated by soong. Use runtime_resource_overlay instead") |
| 363 | } |
| 364 | |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 365 | func neverallowMutator(ctx BottomUpMutatorContext) { |
| 366 | m, ok := ctx.Module().(Module) |
| 367 | if !ok { |
| 368 | return |
| 369 | } |
| 370 | |
| 371 | dir := ctx.ModuleDir() + "/" |
| 372 | properties := m.GetProperties() |
| 373 | |
Paul Duffin | f1c9bbe | 2019-07-26 10:48:06 +0100 | [diff] [blame] | 374 | osClass := ctx.Module().Target().Os.Class |
| 375 | |
Paul Duffin | 115445b | 2019-08-07 15:31:07 +0100 | [diff] [blame] | 376 | for _, r := range neverallowRules(ctx.Config()) { |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 377 | n := r.(*rule) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 378 | if !n.appliesToPath(dir) { |
| 379 | continue |
| 380 | } |
| 381 | |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 382 | if !n.appliesToModuleType(ctx.ModuleType()) { |
| 383 | continue |
| 384 | } |
| 385 | |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 386 | if !n.appliesToProperties(ctx, properties) { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 387 | continue |
| 388 | } |
| 389 | |
Paul Duffin | f1c9bbe | 2019-07-26 10:48:06 +0100 | [diff] [blame] | 390 | if !n.appliesToOsClass(osClass) { |
| 391 | continue |
| 392 | } |
| 393 | |
Paul Duffin | 3578188 | 2019-07-25 15:41:09 +0100 | [diff] [blame] | 394 | if !n.appliesToDirectDeps(ctx) { |
| 395 | continue |
| 396 | } |
| 397 | |
Jihoon Kang | 2a7bf75 | 2024-11-01 21:21:25 +0000 | [diff] [blame] | 398 | if !n.appliesToBpDefinedModule(ctx) { |
| 399 | continue |
| 400 | } |
| 401 | |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 402 | ctx.ModuleErrorf("violates " + n.String()) |
| 403 | } |
| 404 | } |
| 405 | |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 406 | type ValueMatcher interface { |
Anton Hansson | e1b1836 | 2021-12-23 15:05:38 +0000 | [diff] [blame] | 407 | Test(string) bool |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 408 | String() string |
| 409 | } |
| 410 | |
| 411 | type equalMatcher struct { |
| 412 | expected string |
| 413 | } |
| 414 | |
Anton Hansson | e1b1836 | 2021-12-23 15:05:38 +0000 | [diff] [blame] | 415 | func (m *equalMatcher) Test(value string) bool { |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 416 | return m.expected == value |
| 417 | } |
| 418 | |
| 419 | func (m *equalMatcher) String() string { |
| 420 | return "=" + m.expected |
| 421 | } |
| 422 | |
| 423 | type anyMatcher struct { |
| 424 | } |
| 425 | |
Anton Hansson | e1b1836 | 2021-12-23 15:05:38 +0000 | [diff] [blame] | 426 | func (m *anyMatcher) Test(value string) bool { |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 427 | return true |
| 428 | } |
| 429 | |
| 430 | func (m *anyMatcher) String() string { |
| 431 | return "=*" |
| 432 | } |
| 433 | |
| 434 | var anyMatcherInstance = &anyMatcher{} |
| 435 | |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 436 | type startsWithMatcher struct { |
| 437 | prefix string |
| 438 | } |
| 439 | |
Anton Hansson | e1b1836 | 2021-12-23 15:05:38 +0000 | [diff] [blame] | 440 | func (m *startsWithMatcher) Test(value string) bool { |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 441 | return strings.HasPrefix(value, m.prefix) |
| 442 | } |
| 443 | |
| 444 | func (m *startsWithMatcher) String() string { |
| 445 | return ".starts-with(" + m.prefix + ")" |
| 446 | } |
| 447 | |
Anton Hansson | 4537640 | 2020-04-09 14:18:21 +0100 | [diff] [blame] | 448 | type regexMatcher struct { |
| 449 | re *regexp.Regexp |
| 450 | } |
| 451 | |
Anton Hansson | e1b1836 | 2021-12-23 15:05:38 +0000 | [diff] [blame] | 452 | func (m *regexMatcher) Test(value string) bool { |
Anton Hansson | 4537640 | 2020-04-09 14:18:21 +0100 | [diff] [blame] | 453 | return m.re.MatchString(value) |
| 454 | } |
| 455 | |
| 456 | func (m *regexMatcher) String() string { |
| 457 | return ".regexp(" + m.re.String() + ")" |
| 458 | } |
| 459 | |
Andrei Onea | 115e7e7 | 2020-06-05 21:14:03 +0100 | [diff] [blame] | 460 | type notInListMatcher struct { |
| 461 | allowed []string |
| 462 | } |
| 463 | |
Anton Hansson | e1b1836 | 2021-12-23 15:05:38 +0000 | [diff] [blame] | 464 | func (m *notInListMatcher) Test(value string) bool { |
Andrei Onea | 115e7e7 | 2020-06-05 21:14:03 +0100 | [diff] [blame] | 465 | return !InList(value, m.allowed) |
| 466 | } |
| 467 | |
| 468 | func (m *notInListMatcher) String() string { |
| 469 | return ".not-in-list(" + strings.Join(m.allowed, ",") + ")" |
| 470 | } |
| 471 | |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 472 | type isSetMatcher struct{} |
| 473 | |
Anton Hansson | e1b1836 | 2021-12-23 15:05:38 +0000 | [diff] [blame] | 474 | func (m *isSetMatcher) Test(value string) bool { |
Colin Cross | c511bc5 | 2020-04-07 16:50:32 +0000 | [diff] [blame] | 475 | return value != "" |
| 476 | } |
| 477 | |
| 478 | func (m *isSetMatcher) String() string { |
| 479 | return ".is-set" |
| 480 | } |
| 481 | |
| 482 | var isSetMatcherInstance = &isSetMatcher{} |
| 483 | |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 484 | type ruleProperty struct { |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 485 | fields []string // e.x.: Vndk.Enabled |
| 486 | matcher ValueMatcher |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 487 | } |
| 488 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 489 | func (r *ruleProperty) String() string { |
| 490 | return fmt.Sprintf("%q matches: %s", strings.Join(r.fields, "."), r.matcher) |
| 491 | } |
| 492 | |
| 493 | type ruleProperties []ruleProperty |
| 494 | |
| 495 | func (r ruleProperties) String() string { |
| 496 | var s []string |
| 497 | for _, r := range r { |
| 498 | s = append(s, r.String()) |
| 499 | } |
| 500 | return strings.Join(s, " ") |
| 501 | } |
| 502 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 503 | // A NeverAllow rule. |
| 504 | type Rule interface { |
| 505 | In(path ...string) Rule |
| 506 | |
| 507 | NotIn(path ...string) Rule |
| 508 | |
Paul Duffin | 3578188 | 2019-07-25 15:41:09 +0100 | [diff] [blame] | 509 | InDirectDeps(deps ...string) Rule |
| 510 | |
Paul Duffin | f1c9bbe | 2019-07-26 10:48:06 +0100 | [diff] [blame] | 511 | WithOsClass(osClasses ...OsClass) Rule |
| 512 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 513 | ModuleType(types ...string) Rule |
| 514 | |
| 515 | NotModuleType(types ...string) Rule |
| 516 | |
| 517 | With(properties, value string) Rule |
| 518 | |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 519 | WithMatcher(properties string, matcher ValueMatcher) Rule |
| 520 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 521 | Without(properties, value string) Rule |
| 522 | |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 523 | WithoutMatcher(properties string, matcher ValueMatcher) Rule |
| 524 | |
Jihoon Kang | 2a7bf75 | 2024-11-01 21:21:25 +0000 | [diff] [blame] | 525 | DefinedInBpFile() Rule |
| 526 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 527 | Because(reason string) Rule |
| 528 | } |
| 529 | |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 530 | type rule struct { |
| 531 | // User string for why this is a thing. |
| 532 | reason string |
| 533 | |
| 534 | paths []string |
| 535 | unlessPaths []string |
| 536 | |
Paul Duffin | 3578188 | 2019-07-25 15:41:09 +0100 | [diff] [blame] | 537 | directDeps map[string]bool |
| 538 | |
Paul Duffin | f1c9bbe | 2019-07-26 10:48:06 +0100 | [diff] [blame] | 539 | osClasses []OsClass |
| 540 | |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 541 | moduleTypes []string |
| 542 | unlessModuleTypes []string |
| 543 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 544 | props ruleProperties |
| 545 | unlessProps ruleProperties |
Andrei Onea | 115e7e7 | 2020-06-05 21:14:03 +0100 | [diff] [blame] | 546 | |
| 547 | onlyBootclasspathJar bool |
Jihoon Kang | 2a7bf75 | 2024-11-01 21:21:25 +0000 | [diff] [blame] | 548 | |
| 549 | definedInBp bool |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 550 | } |
| 551 | |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 552 | // Create a new NeverAllow rule. |
| 553 | func NeverAllow() Rule { |
Paul Duffin | 3578188 | 2019-07-25 15:41:09 +0100 | [diff] [blame] | 554 | return &rule{directDeps: make(map[string]bool)} |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 555 | } |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 556 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 557 | // In adds path(s) where this rule applies. |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 558 | func (r *rule) In(path ...string) Rule { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 559 | r.paths = append(r.paths, cleanPaths(path)...) |
| 560 | return r |
| 561 | } |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 562 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 563 | // NotIn adds path(s) to that this rule does not apply to. |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 564 | func (r *rule) NotIn(path ...string) Rule { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 565 | r.unlessPaths = append(r.unlessPaths, cleanPaths(path)...) |
| 566 | return r |
| 567 | } |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 568 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 569 | // InDirectDeps adds dep(s) that are not allowed with this rule. |
Paul Duffin | 3578188 | 2019-07-25 15:41:09 +0100 | [diff] [blame] | 570 | func (r *rule) InDirectDeps(deps ...string) Rule { |
| 571 | for _, d := range deps { |
| 572 | r.directDeps[d] = true |
| 573 | } |
| 574 | return r |
| 575 | } |
| 576 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 577 | // WithOsClass adds osClass(es) that this rule applies to. |
Paul Duffin | f1c9bbe | 2019-07-26 10:48:06 +0100 | [diff] [blame] | 578 | func (r *rule) WithOsClass(osClasses ...OsClass) Rule { |
| 579 | r.osClasses = append(r.osClasses, osClasses...) |
| 580 | return r |
| 581 | } |
| 582 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 583 | // ModuleType adds type(s) that this rule applies to. |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 584 | func (r *rule) ModuleType(types ...string) Rule { |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 585 | r.moduleTypes = append(r.moduleTypes, types...) |
| 586 | return r |
| 587 | } |
| 588 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 589 | // NotModuleType adds type(s) that this rule does not apply to.. |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 590 | func (r *rule) NotModuleType(types ...string) Rule { |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 591 | r.unlessModuleTypes = append(r.unlessModuleTypes, types...) |
| 592 | return r |
| 593 | } |
| 594 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 595 | // With specifies property/value combinations that are restricted for this rule. |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 596 | func (r *rule) With(properties, value string) Rule { |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 597 | return r.WithMatcher(properties, selectMatcher(value)) |
| 598 | } |
| 599 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 600 | // WithMatcher specifies property/matcher combinations that are restricted for this rule. |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 601 | func (r *rule) WithMatcher(properties string, matcher ValueMatcher) Rule { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 602 | r.props = append(r.props, ruleProperty{ |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 603 | fields: fieldNamesForProperties(properties), |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 604 | matcher: matcher, |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 605 | }) |
| 606 | return r |
| 607 | } |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 608 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 609 | // Without specifies property/value combinations that this rule does not apply to. |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 610 | func (r *rule) Without(properties, value string) Rule { |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 611 | return r.WithoutMatcher(properties, selectMatcher(value)) |
| 612 | } |
| 613 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 614 | // Without specifies property/matcher combinations that this rule does not apply to. |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 615 | func (r *rule) WithoutMatcher(properties string, matcher ValueMatcher) Rule { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 616 | r.unlessProps = append(r.unlessProps, ruleProperty{ |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 617 | fields: fieldNamesForProperties(properties), |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 618 | matcher: matcher, |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 619 | }) |
| 620 | return r |
| 621 | } |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 622 | |
Jihoon Kang | 2a7bf75 | 2024-11-01 21:21:25 +0000 | [diff] [blame] | 623 | // DefinedInBpFile specifies that this rule applies to modules that are defined |
| 624 | // in bp files, and does not apply to modules that are auto generated by other modules. |
| 625 | func (r *rule) DefinedInBpFile() Rule { |
| 626 | r.definedInBp = true |
| 627 | return r |
| 628 | } |
| 629 | |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 630 | func selectMatcher(expected string) ValueMatcher { |
| 631 | if expected == "*" { |
| 632 | return anyMatcherInstance |
| 633 | } |
| 634 | return &equalMatcher{expected: expected} |
| 635 | } |
| 636 | |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 637 | // Because specifies a reason for this rule. |
Paul Duffin | 730f2a5 | 2019-06-27 14:08:51 +0100 | [diff] [blame] | 638 | func (r *rule) Because(reason string) Rule { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 639 | r.reason = reason |
| 640 | return r |
| 641 | } |
| 642 | |
| 643 | func (r *rule) String() string { |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 644 | s := []string{"neverallow requirements. Not allowed:"} |
| 645 | if len(r.paths) > 0 { |
| 646 | s = append(s, fmt.Sprintf("in dirs: %q", r.paths)) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 647 | } |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 648 | if len(r.moduleTypes) > 0 { |
| 649 | s = append(s, fmt.Sprintf("module types: %q", r.moduleTypes)) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 650 | } |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 651 | if len(r.props) > 0 { |
| 652 | s = append(s, fmt.Sprintf("properties matching: %s", r.props)) |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 653 | } |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 654 | if len(r.directDeps) > 0 { |
Cole Faust | 18994c7 | 2023-02-28 16:02:16 -0800 | [diff] [blame] | 655 | s = append(s, fmt.Sprintf("dep(s): %q", SortedKeys(r.directDeps))) |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 656 | } |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 657 | if len(r.osClasses) > 0 { |
| 658 | s = append(s, fmt.Sprintf("os class(es): %q", r.osClasses)) |
Paul Duffin | f1c9bbe | 2019-07-26 10:48:06 +0100 | [diff] [blame] | 659 | } |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 660 | if len(r.unlessPaths) > 0 { |
| 661 | s = append(s, fmt.Sprintf("EXCEPT in dirs: %q", r.unlessPaths)) |
| 662 | } |
| 663 | if len(r.unlessModuleTypes) > 0 { |
| 664 | s = append(s, fmt.Sprintf("EXCEPT module types: %q", r.unlessModuleTypes)) |
| 665 | } |
| 666 | if len(r.unlessProps) > 0 { |
| 667 | s = append(s, fmt.Sprintf("EXCEPT properties matching: %q", r.unlessProps)) |
Andrei Onea | 115e7e7 | 2020-06-05 21:14:03 +0100 | [diff] [blame] | 668 | } |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 669 | if len(r.reason) != 0 { |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 670 | s = append(s, " which is restricted because "+r.reason) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 671 | } |
Liz Kammer | a3d7915 | 2021-10-28 18:14:04 -0400 | [diff] [blame] | 672 | if len(s) == 1 { |
| 673 | s[0] = "neverallow requirements (empty)" |
| 674 | } |
| 675 | return strings.Join(s, "\n\t") |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 676 | } |
| 677 | |
| 678 | func (r *rule) appliesToPath(dir string) bool { |
Jaewoong Jung | 3aff578 | 2020-02-11 07:54:35 -0800 | [diff] [blame] | 679 | includePath := len(r.paths) == 0 || HasAnyPrefix(dir, r.paths) |
| 680 | excludePath := HasAnyPrefix(dir, r.unlessPaths) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 681 | return includePath && !excludePath |
| 682 | } |
| 683 | |
Paul Duffin | 3578188 | 2019-07-25 15:41:09 +0100 | [diff] [blame] | 684 | func (r *rule) appliesToDirectDeps(ctx BottomUpMutatorContext) bool { |
| 685 | if len(r.directDeps) == 0 { |
| 686 | return true |
| 687 | } |
| 688 | |
| 689 | matches := false |
| 690 | ctx.VisitDirectDeps(func(m Module) { |
| 691 | if !matches { |
| 692 | name := ctx.OtherModuleName(m) |
| 693 | matches = r.directDeps[name] |
| 694 | } |
| 695 | }) |
| 696 | |
| 697 | return matches |
| 698 | } |
| 699 | |
Paul Duffin | f1c9bbe | 2019-07-26 10:48:06 +0100 | [diff] [blame] | 700 | func (r *rule) appliesToOsClass(osClass OsClass) bool { |
| 701 | if len(r.osClasses) == 0 { |
| 702 | return true |
| 703 | } |
| 704 | |
| 705 | for _, c := range r.osClasses { |
| 706 | if c == osClass { |
| 707 | return true |
| 708 | } |
| 709 | } |
| 710 | |
| 711 | return false |
| 712 | } |
| 713 | |
Colin Cross | fd4f743 | 2019-03-05 15:06:16 -0800 | [diff] [blame] | 714 | func (r *rule) appliesToModuleType(moduleType string) bool { |
| 715 | return (len(r.moduleTypes) == 0 || InList(moduleType, r.moduleTypes)) && !InList(moduleType, r.unlessModuleTypes) |
| 716 | } |
| 717 | |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 718 | func (r *rule) appliesToProperties(ctx BottomUpMutatorContext, properties []interface{}) bool { |
| 719 | includeProps := hasAllProperties(ctx, properties, r.props) |
| 720 | excludeProps := hasAnyProperty(ctx, properties, r.unlessProps) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 721 | return includeProps && !excludeProps |
| 722 | } |
| 723 | |
Jihoon Kang | 2a7bf75 | 2024-11-01 21:21:25 +0000 | [diff] [blame] | 724 | func (r *rule) appliesToBpDefinedModule(ctx BottomUpMutatorContext) bool { |
| 725 | if !r.definedInBp { |
| 726 | return true |
| 727 | } |
| 728 | return !ctx.OtherModuleIsAutoGenerated(ctx.Module()) == r.definedInBp |
| 729 | } |
| 730 | |
Paul Duffin | c811170 | 2019-07-22 12:13:55 +0100 | [diff] [blame] | 731 | func StartsWith(prefix string) ValueMatcher { |
| 732 | return &startsWithMatcher{prefix} |
| 733 | } |
| 734 | |
Anton Hansson | 4537640 | 2020-04-09 14:18:21 +0100 | [diff] [blame] | 735 | func Regexp(re string) ValueMatcher { |
| 736 | r, err := regexp.Compile(re) |
| 737 | if err != nil { |
| 738 | panic(err) |
| 739 | } |
| 740 | return ®exMatcher{r} |
| 741 | } |
| 742 | |
Andrei Onea | 115e7e7 | 2020-06-05 21:14:03 +0100 | [diff] [blame] | 743 | func NotInList(allowed []string) ValueMatcher { |
| 744 | return ¬InListMatcher{allowed} |
| 745 | } |
| 746 | |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 747 | // assorted utils |
| 748 | |
| 749 | func cleanPaths(paths []string) []string { |
| 750 | res := make([]string, len(paths)) |
| 751 | for i, v := range paths { |
| 752 | res[i] = filepath.Clean(v) + "/" |
| 753 | } |
| 754 | return res |
| 755 | } |
| 756 | |
| 757 | func fieldNamesForProperties(propertyNames string) []string { |
| 758 | names := strings.Split(propertyNames, ".") |
| 759 | for i, v := range names { |
| 760 | names[i] = proptools.FieldNameForProperty(v) |
| 761 | } |
| 762 | return names |
| 763 | } |
| 764 | |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 765 | func hasAnyProperty(ctx BottomUpMutatorContext, properties []interface{}, props []ruleProperty) bool { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 766 | for _, v := range props { |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 767 | if hasProperty(ctx, properties, v) { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 768 | return true |
| 769 | } |
| 770 | } |
| 771 | return false |
| 772 | } |
| 773 | |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 774 | func hasAllProperties(ctx BottomUpMutatorContext, properties []interface{}, props []ruleProperty) bool { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 775 | for _, v := range props { |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 776 | if !hasProperty(ctx, properties, v) { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 777 | return false |
| 778 | } |
| 779 | } |
| 780 | return true |
| 781 | } |
| 782 | |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 783 | func hasProperty(ctx BottomUpMutatorContext, properties []interface{}, prop ruleProperty) bool { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 784 | for _, propertyStruct := range properties { |
| 785 | propertiesValue := reflect.ValueOf(propertyStruct).Elem() |
| 786 | for _, v := range prop.fields { |
| 787 | if !propertiesValue.IsValid() { |
| 788 | break |
| 789 | } |
| 790 | propertiesValue = propertiesValue.FieldByName(v) |
| 791 | } |
| 792 | if !propertiesValue.IsValid() { |
| 793 | continue |
| 794 | } |
| 795 | |
Paul Duffin | 73bf054 | 2019-07-12 14:12:49 +0100 | [diff] [blame] | 796 | check := func(value string) bool { |
Anton Hansson | e1b1836 | 2021-12-23 15:05:38 +0000 | [diff] [blame] | 797 | return prop.matcher.Test(value) |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 798 | } |
| 799 | |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 800 | if matchValue(ctx, propertiesValue, check) { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 801 | return true |
| 802 | } |
| 803 | } |
| 804 | return false |
| 805 | } |
| 806 | |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 807 | func matchValue(ctx BottomUpMutatorContext, value reflect.Value, check func(string) bool) bool { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 808 | if !value.IsValid() { |
| 809 | return false |
| 810 | } |
| 811 | |
| 812 | if value.Kind() == reflect.Ptr { |
| 813 | if value.IsNil() { |
| 814 | return check("") |
| 815 | } |
| 816 | value = value.Elem() |
| 817 | } |
| 818 | |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 819 | switch v := value.Interface().(type) { |
| 820 | case string: |
| 821 | return check(v) |
| 822 | case bool: |
| 823 | return check(strconv.FormatBool(v)) |
| 824 | case int: |
| 825 | return check(strconv.FormatInt((int64)(v), 10)) |
| 826 | case []string: |
| 827 | for _, v := range v { |
| 828 | if check(v) { |
| 829 | return true |
| 830 | } |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 831 | } |
Cole Faust | 5b35cb9 | 2024-08-27 15:47:06 -0700 | [diff] [blame] | 832 | return false |
| 833 | case proptools.Configurable[string]: |
| 834 | return check(v.GetOrDefault(ctx, "")) |
| 835 | case proptools.Configurable[bool]: |
| 836 | return check(strconv.FormatBool(v.GetOrDefault(ctx, false))) |
| 837 | case proptools.Configurable[[]string]: |
| 838 | for _, v := range v.GetOrDefault(ctx, nil) { |
Steven Moreland | 65b3fd9 | 2017-12-06 14:18:35 -0800 | [diff] [blame] | 839 | if check(v) { |
| 840 | return true |
| 841 | } |
| 842 | } |
| 843 | return false |
| 844 | } |
| 845 | |
| 846 | panic("Can't handle type: " + value.Kind().String()) |
| 847 | } |
Paul Duffin | 115445b | 2019-08-07 15:31:07 +0100 | [diff] [blame] | 848 | |
| 849 | var neverallowRulesKey = NewOnceKey("neverallowRules") |
| 850 | |
| 851 | func neverallowRules(config Config) []Rule { |
| 852 | return config.Once(neverallowRulesKey, func() interface{} { |
| 853 | // No test rules were set by setTestNeverallowRules, use the global rules |
| 854 | return neverallows |
| 855 | }).([]Rule) |
| 856 | } |
| 857 | |
| 858 | // Overrides the default neverallow rules for the supplied config. |
| 859 | // |
| 860 | // For testing only. |
Paul Duffin | 45338f0 | 2021-03-30 23:07:52 +0100 | [diff] [blame] | 861 | func setTestNeverallowRules(config Config, testRules []Rule) { |
Paul Duffin | 115445b | 2019-08-07 15:31:07 +0100 | [diff] [blame] | 862 | config.Once(neverallowRulesKey, func() interface{} { return testRules }) |
| 863 | } |
Paul Duffin | 45338f0 | 2021-03-30 23:07:52 +0100 | [diff] [blame] | 864 | |
| 865 | // Prepares for a test by setting neverallow rules and enabling the mutator. |
| 866 | // |
| 867 | // If the supplied rules are nil then the default rules are used. |
| 868 | func PrepareForTestWithNeverallowRules(testRules []Rule) FixturePreparer { |
| 869 | return GroupFixturePreparers( |
| 870 | FixtureModifyConfig(func(config Config) { |
| 871 | if testRules != nil { |
| 872 | setTestNeverallowRules(config, testRules) |
| 873 | } |
| 874 | }), |
| 875 | FixtureRegisterWithContext(func(ctx RegistrationContext) { |
| 876 | ctx.PostDepsMutators(registerNeverallowMutator) |
| 877 | }), |
| 878 | ) |
| 879 | } |