David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | # |
| 3 | # Copyright (C) 2018 The Android Open Source Project |
| 4 | # |
| 5 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | # you may not use this file except in compliance with the License. |
| 7 | # You may obtain a copy of the License at |
| 8 | # |
| 9 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | # |
| 11 | # Unless required by applicable law or agreed to in writing, software |
| 12 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | # See the License for the specific language governing permissions and |
| 15 | # limitations under the License. |
| 16 | """ |
| 17 | Generate API lists for non-SDK API enforcement. |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 18 | """ |
| 19 | import argparse |
David Brazdil | 17d16e8 | 2018-12-13 17:00:09 +0000 | [diff] [blame] | 20 | from collections import defaultdict |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 21 | import os |
| 22 | import sys |
| 23 | import re |
| 24 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 25 | # Names of flags recognized by the `hiddenapi` tool. |
| 26 | FLAG_WHITELIST = "whitelist" |
| 27 | FLAG_GREYLIST = "greylist" |
| 28 | FLAG_BLACKLIST = "blacklist" |
| 29 | FLAG_GREYLIST_MAX_O = "greylist-max-o" |
David Brazdil | 5cd148f | 2018-11-01 09:54:25 +0000 | [diff] [blame] | 30 | FLAG_GREYLIST_MAX_P = "greylist-max-p" |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 31 | FLAG_CORE_PLATFORM_API = "core-platform-api" |
Andrei Onea | 80a5660 | 2019-03-01 18:49:15 +0000 | [diff] [blame] | 32 | FLAG_PUBLIC_API = "public-api" |
| 33 | FLAG_SYSTEM_API = "system-api" |
| 34 | FLAG_TEST_API = "test-api" |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 35 | |
| 36 | # List of all known flags. |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 37 | FLAGS_API_LIST = [ |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 38 | FLAG_WHITELIST, |
| 39 | FLAG_GREYLIST, |
| 40 | FLAG_BLACKLIST, |
| 41 | FLAG_GREYLIST_MAX_O, |
David Brazdil | 5cd148f | 2018-11-01 09:54:25 +0000 | [diff] [blame] | 42 | FLAG_GREYLIST_MAX_P, |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 43 | ] |
Andrei Onea | 80a5660 | 2019-03-01 18:49:15 +0000 | [diff] [blame] | 44 | ALL_FLAGS = FLAGS_API_LIST + [ |
| 45 | FLAG_CORE_PLATFORM_API, |
| 46 | FLAG_PUBLIC_API, |
| 47 | FLAG_SYSTEM_API, |
| 48 | FLAG_TEST_API, |
| 49 | ] |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 50 | |
| 51 | FLAGS_API_LIST_SET = set(FLAGS_API_LIST) |
| 52 | ALL_FLAGS_SET = set(ALL_FLAGS) |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 53 | |
| 54 | # Suffix used in command line args to express that only known and |
| 55 | # otherwise unassigned entries should be assign the given flag. |
| 56 | # For example, the P dark greylist is checked in as it was in P, |
| 57 | # but signatures have changes since then. The flag instructs this |
| 58 | # script to skip any entries which do not exist any more. |
| 59 | FLAG_IGNORE_CONFLICTS_SUFFIX = "-ignore-conflicts" |
| 60 | |
| 61 | # Regex patterns of fields/methods used in serialization. These are |
| 62 | # considered public API despite being hidden. |
| 63 | SERIALIZATION_PATTERNS = [ |
| 64 | r'readObject\(Ljava/io/ObjectInputStream;\)V', |
| 65 | r'readObjectNoData\(\)V', |
| 66 | r'readResolve\(\)Ljava/lang/Object;', |
| 67 | r'serialVersionUID:J', |
| 68 | r'serialPersistentFields:\[Ljava/io/ObjectStreamField;', |
| 69 | r'writeObject\(Ljava/io/ObjectOutputStream;\)V', |
| 70 | r'writeReplace\(\)Ljava/lang/Object;', |
| 71 | ] |
| 72 | |
| 73 | # Single regex used to match serialization API. It combines all the |
| 74 | # SERIALIZATION_PATTERNS into a single regular expression. |
| 75 | SERIALIZATION_REGEX = re.compile(r'.*->(' + '|'.join(SERIALIZATION_PATTERNS) + r')$') |
| 76 | |
| 77 | # Predicates to be used with filter_apis. |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 78 | HAS_NO_API_LIST_ASSIGNED = lambda api, flags: not FLAGS_API_LIST_SET.intersection(flags) |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 79 | IS_SERIALIZATION = lambda api, flags: SERIALIZATION_REGEX.match(api) |
| 80 | |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 81 | def get_args(): |
| 82 | """Parses command line arguments. |
| 83 | |
| 84 | Returns: |
| 85 | Namespace: dictionary of parsed arguments |
| 86 | """ |
| 87 | parser = argparse.ArgumentParser() |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 88 | parser.add_argument('--output', required=True) |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 89 | parser.add_argument('--csv', nargs='*', default=[], metavar='CSV_FILE', |
| 90 | help='CSV files to be merged into output') |
| 91 | |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 92 | for flag in ALL_FLAGS: |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 93 | ignore_conflicts_flag = flag + FLAG_IGNORE_CONFLICTS_SUFFIX |
| 94 | parser.add_argument('--' + flag, dest=flag, nargs='*', default=[], metavar='TXT_FILE', |
| 95 | help='lists of entries with flag "' + flag + '"') |
| 96 | parser.add_argument('--' + ignore_conflicts_flag, dest=ignore_conflicts_flag, nargs='*', |
| 97 | default=[], metavar='TXT_FILE', |
| 98 | help='lists of entries with flag "' + flag + |
| 99 | '". skip entry if missing or flag conflict.') |
| 100 | |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 101 | return parser.parse_args() |
| 102 | |
| 103 | def read_lines(filename): |
| 104 | """Reads entire file and return it as a list of lines. |
| 105 | |
David Brazdil | ae88d4e | 2018-09-06 14:46:55 +0100 | [diff] [blame] | 106 | Lines which begin with a hash are ignored. |
| 107 | |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 108 | Args: |
| 109 | filename (string): Path to the file to read from. |
| 110 | |
| 111 | Returns: |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 112 | Lines of the file as a list of string. |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 113 | """ |
| 114 | with open(filename, 'r') as f: |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 115 | lines = f.readlines(); |
| 116 | lines = filter(lambda line: not line.startswith('#'), lines) |
| 117 | lines = map(lambda line: line.strip(), lines) |
| 118 | return set(lines) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 119 | |
| 120 | def write_lines(filename, lines): |
| 121 | """Writes list of lines into a file, overwriting the file it it exists. |
| 122 | |
| 123 | Args: |
| 124 | filename (string): Path to the file to be writting into. |
| 125 | lines (list): List of strings to write into the file. |
| 126 | """ |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 127 | lines = map(lambda line: line + '\n', lines) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 128 | with open(filename, 'w') as f: |
| 129 | f.writelines(lines) |
| 130 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 131 | class FlagsDict: |
David Brazdil | 17d16e8 | 2018-12-13 17:00:09 +0000 | [diff] [blame] | 132 | def __init__(self): |
| 133 | self._dict_keyset = set() |
| 134 | self._dict = defaultdict(set) |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 135 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 136 | def _check_entries_set(self, keys_subset, source): |
| 137 | assert isinstance(keys_subset, set) |
| 138 | assert keys_subset.issubset(self._dict_keyset), ( |
| 139 | "Error processing: {}\n" |
| 140 | "The following entries were unexpected:\n" |
| 141 | "{}" |
| 142 | "Please visit go/hiddenapi for more information.").format( |
| 143 | source, "".join(map(lambda x: " " + str(x), keys_subset - self._dict_keyset))) |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 144 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 145 | def _check_flags_set(self, flags_subset, source): |
| 146 | assert isinstance(flags_subset, set) |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 147 | assert flags_subset.issubset(ALL_FLAGS_SET), ( |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 148 | "Error processing: {}\n" |
| 149 | "The following flags were not recognized: \n" |
| 150 | "{}\n" |
| 151 | "Please visit go/hiddenapi for more information.").format( |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 152 | source, "\n".join(flags_subset - ALL_FLAGS_SET)) |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 153 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 154 | def filter_apis(self, filter_fn): |
| 155 | """Returns APIs which match a given predicate. |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 156 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 157 | This is a helper function which allows to filter on both signatures (keys) and |
| 158 | flags (values). The built-in filter() invokes the lambda only with dict's keys. |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 159 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 160 | Args: |
| 161 | filter_fn : Function which takes two arguments (signature/flags) and returns a boolean. |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 162 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 163 | Returns: |
| 164 | A set of APIs which match the predicate. |
| 165 | """ |
| 166 | return set(filter(lambda x: filter_fn(x, self._dict[x]), self._dict_keyset)) |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 167 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 168 | def get_valid_subset_of_unassigned_apis(self, api_subset): |
| 169 | """Sanitizes a key set input to only include keys which exist in the dictionary |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 170 | and have not been assigned any API list flags. |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 171 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 172 | Args: |
| 173 | entries_subset (set/list): Key set to be sanitized. |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 174 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 175 | Returns: |
| 176 | Sanitized key set. |
| 177 | """ |
| 178 | assert isinstance(api_subset, set) |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 179 | return api_subset.intersection(self.filter_apis(HAS_NO_API_LIST_ASSIGNED)) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 180 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 181 | def generate_csv(self): |
| 182 | """Constructs CSV entries from a dictionary. |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 183 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 184 | Returns: |
| 185 | List of lines comprising a CSV file. See "parse_and_merge_csv" for format description. |
| 186 | """ |
| 187 | return sorted(map(lambda api: ",".join([api] + sorted(self._dict[api])), self._dict)) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 188 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 189 | def parse_and_merge_csv(self, csv_lines, source = "<unknown>"): |
| 190 | """Parses CSV entries and merges them into a given dictionary. |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 191 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 192 | The expected CSV format is: |
| 193 | <api signature>,<flag1>,<flag2>,...,<flagN> |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 194 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 195 | Args: |
| 196 | csv_lines (list of strings): Lines read from a CSV file. |
| 197 | source (string): Origin of `csv_lines`. Will be printed in error messages. |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 198 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 199 | Throws: |
David Brazdil | 17d16e8 | 2018-12-13 17:00:09 +0000 | [diff] [blame] | 200 | AssertionError if parsed flags are invalid. |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 201 | """ |
| 202 | # Split CSV lines into arrays of values. |
| 203 | csv_values = [ line.split(',') for line in csv_lines ] |
| 204 | |
David Brazdil | 17d16e8 | 2018-12-13 17:00:09 +0000 | [diff] [blame] | 205 | # Update the full set of API signatures. |
| 206 | self._dict_keyset.update([ csv[0] for csv in csv_values ]) |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 207 | |
| 208 | # Check that all flags are known. |
| 209 | csv_flags = set(reduce(lambda x, y: set(x).union(y), [ csv[1:] for csv in csv_values ], [])) |
| 210 | self._check_flags_set(csv_flags, source) |
| 211 | |
| 212 | # Iterate over all CSV lines, find entry in dict and append flags to it. |
| 213 | for csv in csv_values: |
Andrei Onea | 80a5660 | 2019-03-01 18:49:15 +0000 | [diff] [blame] | 214 | flags = csv[1:] |
| 215 | if (FLAG_PUBLIC_API in flags) or (FLAG_SYSTEM_API in flags): |
| 216 | flags.append(FLAG_WHITELIST) |
| 217 | elif FLAG_TEST_API in flags: |
| 218 | flags.append(FLAG_GREYLIST) |
| 219 | self._dict[csv[0]].update(flags) |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 220 | |
| 221 | def assign_flag(self, flag, apis, source="<unknown>"): |
| 222 | """Assigns a flag to given subset of entries. |
| 223 | |
| 224 | Args: |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 225 | flag (string): One of ALL_FLAGS. |
Andrei Onea | 80a5660 | 2019-03-01 18:49:15 +0000 | [diff] [blame] | 226 | apis (set): Subset of APIs to receive the flag. |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 227 | source (string): Origin of `entries_subset`. Will be printed in error messages. |
| 228 | |
| 229 | Throws: |
| 230 | AssertionError if parsed API signatures of flags are invalid. |
| 231 | """ |
| 232 | # Check that all APIs exist in the dict. |
| 233 | self._check_entries_set(apis, source) |
| 234 | |
| 235 | # Check that the flag is known. |
| 236 | self._check_flags_set(set([ flag ]), source) |
| 237 | |
| 238 | # Iterate over the API subset, find each entry in dict and assign the flag to it. |
| 239 | for api in apis: |
| 240 | self._dict[api].add(flag) |
David Brazdil | 4a55eeb | 2018-09-11 11:09:01 +0100 | [diff] [blame] | 241 | |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 242 | def main(argv): |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 243 | # Parse arguments. |
| 244 | args = vars(get_args()) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 245 | |
David Brazdil | 17d16e8 | 2018-12-13 17:00:09 +0000 | [diff] [blame] | 246 | # Initialize API->flags dictionary. |
| 247 | flags = FlagsDict() |
| 248 | |
| 249 | # Merge input CSV files into the dictionary. |
| 250 | # Do this first because CSV files produced by parsing API stubs will |
| 251 | # contain the full set of APIs. Subsequent additions from text files |
| 252 | # will be able to detect invalid entries, and/or filter all as-yet |
| 253 | # unassigned entries. |
| 254 | for filename in args["csv"]: |
| 255 | flags.parse_and_merge_csv(read_lines(filename), filename) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 256 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 257 | # Combine inputs which do not require any particular order. |
| 258 | # (1) Assign serialization API to whitelist. |
| 259 | flags.assign_flag(FLAG_WHITELIST, flags.filter_apis(IS_SERIALIZATION)) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 260 | |
David Brazdil | 17d16e8 | 2018-12-13 17:00:09 +0000 | [diff] [blame] | 261 | # (2) Merge text files with a known flag into the dictionary. |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 262 | for flag in ALL_FLAGS: |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 263 | for filename in args[flag]: |
| 264 | flags.assign_flag(flag, read_lines(filename), filename) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 265 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 266 | # Merge text files where conflicts should be ignored. |
| 267 | # This will only assign the given flag if: |
| 268 | # (a) the entry exists, and |
| 269 | # (b) it has not been assigned any other flag. |
| 270 | # Because of (b), this must run after all strict assignments have been performed. |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 271 | for flag in ALL_FLAGS: |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 272 | for filename in args[flag + FLAG_IGNORE_CONFLICTS_SUFFIX]: |
| 273 | valid_entries = flags.get_valid_subset_of_unassigned_apis(read_lines(filename)) |
| 274 | flags.assign_flag(flag, valid_entries, filename) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 275 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 276 | # Assign all remaining entries to the blacklist. |
David Brazdil | 439d349 | 2018-12-07 11:49:55 +0000 | [diff] [blame] | 277 | flags.assign_flag(FLAG_BLACKLIST, flags.filter_apis(HAS_NO_API_LIST_ASSIGNED)) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 278 | |
David Brazdil | 89bf0f2 | 2018-10-30 18:21:24 +0000 | [diff] [blame] | 279 | # Write output. |
| 280 | write_lines(args["output"], flags.generate_csv()) |
David Brazdil | 8503b90 | 2018-08-30 13:35:03 +0100 | [diff] [blame] | 281 | |
| 282 | if __name__ == "__main__": |
| 283 | main(sys.argv) |