• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2023 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.android.server.sdksandbox.verifier;
18 
19 import com.android.server.sdksandbox.verifier.SerialDexLoader.DexSymbols;
20 
21 import java.io.File;
22 import java.io.IOException;
23 import java.util.List;
24 import java.util.Map;
25 
26 /**
27  * Interface for DEX parsing, needed for SDK verification
28  *
29  * @hide
30  */
31 public interface DexParser {
32 
33     /**
34      * Returns a multimap of apkFile to a list of dexEntries, for all dex files in apks found in the
35      * package path to verify.
36      *
37      * @param apkPathFile path to apks containing one or more dex files
38      */
getDexFilePaths(File apkPathFile)39     List<DexEntry> getDexFilePaths(File apkPathFile) throws IOException;
40 
41     /**
42      * Parses the dex file and reads the symbols in, populates data in the DexLoadResult.
43      *
44      * @param apkFile apk file to parse
45      * @param dexEntry the specific .dex file to load
46      * @param dexLoadResult sparse array to insert the methods loaded from the dex file
47      */
loadDexSymbols(File apkFile, String dexEntry, DexSymbols dexSymbols)48     void loadDexSymbols(File apkFile, String dexEntry, DexSymbols dexSymbols) throws IOException;
49 
50     /**
51      * Class that represents a dex entry in a given apk file.
52      */
53     public class DexEntry {
54         private File apkFile;
55         private String dexEntry;
56 
DexEntry(File apkFile, String dexEntry)57         public DexEntry(File apkFile, String dexEntry) {
58             this.apkFile = apkFile;
59             this.dexEntry = dexEntry;
60         }
61 
getApkFile()62         public File getApkFile() {
63             return apkFile;
64         }
65 
getDexEntry()66         public String getDexEntry() {
67             return dexEntry;
68         }
69 
getEntryFilename()70         public String getEntryFilename() {
71             return dexEntry.substring(dexEntry.lastIndexOf('/') + 1);
72         }
73 
74         @Override
toString()75         public String toString() {
76             return apkFile.getName() + "/" + dexEntry;
77         }
78     }
79 }
80