|
| 1 | +/* |
| 2 | + * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * The Universal Permissive License (UPL), Version 1.0 |
| 6 | + * |
| 7 | + * Subject to the condition set forth below, permission is hereby granted to any |
| 8 | + * person obtaining a copy of this software, associated documentation and/or |
| 9 | + * data (collectively the "Software"), free of charge and under any and all |
| 10 | + * copyright rights in the Software, and any and all patent rights owned or |
| 11 | + * freely licensable by each licensor hereunder covering either (i) the |
| 12 | + * unmodified Software as contributed to or provided by such licensor, or (ii) |
| 13 | + * the Larger Works (as defined below), to deal in both |
| 14 | + * |
| 15 | + * (a) the Software, and |
| 16 | + * |
| 17 | + * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if |
| 18 | + * one is included with the Software each a "Larger Work" to which the Software |
| 19 | + * is contributed by such licensors), |
| 20 | + * |
| 21 | + * without restriction, including without limitation the rights to copy, create |
| 22 | + * derivative works of, display, perform, and distribute the Software and make, |
| 23 | + * use, sell, offer for sale, import, export, have made, and have sold the |
| 24 | + * Software and the Larger Work(s), and to sublicense the foregoing rights on |
| 25 | + * either these or other terms. |
| 26 | + * |
| 27 | + * This license is subject to the following condition: |
| 28 | + * |
| 29 | + * The above copyright notice and either this complete permission notice or at a |
| 30 | + * minimum a reference to the UPL must be included in all copies or substantial |
| 31 | + * portions of the Software. |
| 32 | + * |
| 33 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 34 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 35 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 36 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 37 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 38 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 39 | + * SOFTWARE. |
| 40 | + */ |
| 41 | +package org.graalvm.nativeimage.test; |
| 42 | + |
| 43 | +import java.io.IOException; |
| 44 | +import java.nio.file.Files; |
| 45 | +import java.nio.file.Path; |
| 46 | +import java.util.ArrayList; |
| 47 | +import java.util.List; |
| 48 | + |
| 49 | +/** |
| 50 | + * Utility for scanning a binary file to find matches for given strings. |
| 51 | + * |
| 52 | + * This is a partial port of the {@code AbsPathInImage.java} OpenJDK test. |
| 53 | + */ |
| 54 | +public class FindPathsInBinary { |
| 55 | + |
| 56 | + private static final boolean IS_WINDOWS = System.getProperty("os.name").toLowerCase().contains("windows"); |
| 57 | + |
| 58 | + /** |
| 59 | + * Searches the binary file in {@code args[0]} for the patterns in |
| 60 | + * {@code args[1], args[2], ...}. A line is printed to stdout for each match found. |
| 61 | + */ |
| 62 | + public static void main(String[] args) throws IOException { |
| 63 | + if (args.length < 2) { |
| 64 | + System.err.printf("Usage: %s <file to scan> <patterns to find>%n", FindPathsInBinary.class.getName()); |
| 65 | + System.exit(-1); |
| 66 | + } |
| 67 | + Path fileToScan = Path.of(args[0]); |
| 68 | + List<byte[]> searchPatterns = new ArrayList<>(); |
| 69 | + for (int i = 1; i < args.length; i++) { |
| 70 | + expandPatterns(searchPatterns, args[i]); |
| 71 | + } |
| 72 | + |
| 73 | + scanFile(fileToScan, searchPatterns); |
| 74 | + } |
| 75 | + |
| 76 | + /** |
| 77 | + * Add path pattern to list of patterns to search for. Create all possible variants depending on |
| 78 | + * platform. |
| 79 | + */ |
| 80 | + private static void expandPatterns(List<byte[]> searchPatterns, String pattern) { |
| 81 | + if (IS_WINDOWS) { |
| 82 | + String forward = pattern.replace('\\', '/'); |
| 83 | + String back = pattern.replace('/', '\\'); |
| 84 | + if (pattern.charAt(1) == ':') { |
| 85 | + String forwardUpper = String.valueOf(pattern.charAt(0)).toUpperCase() + forward.substring(1); |
| 86 | + String forwardLower = String.valueOf(pattern.charAt(0)).toLowerCase() + forward.substring(1); |
| 87 | + String backUpper = String.valueOf(pattern.charAt(0)).toUpperCase() + back.substring(1); |
| 88 | + String backLower = String.valueOf(pattern.charAt(0)).toLowerCase() + back.substring(1); |
| 89 | + searchPatterns.add(forwardUpper.getBytes()); |
| 90 | + searchPatterns.add(forwardLower.getBytes()); |
| 91 | + searchPatterns.add(backUpper.getBytes()); |
| 92 | + searchPatterns.add(backLower.getBytes()); |
| 93 | + } else { |
| 94 | + searchPatterns.add(forward.getBytes()); |
| 95 | + searchPatterns.add(back.getBytes()); |
| 96 | + } |
| 97 | + } else { |
| 98 | + searchPatterns.add(pattern.getBytes()); |
| 99 | + } |
| 100 | + } |
| 101 | + |
| 102 | + private static void scanFile(Path file, List<byte[]> searchPatterns) throws IOException { |
| 103 | + List<String> matches = scanBytes(Files.readAllBytes(file), searchPatterns); |
| 104 | + if (matches.size() > 0) { |
| 105 | + for (String match : matches) { |
| 106 | + System.out.println(match); |
| 107 | + } |
| 108 | + } |
| 109 | + } |
| 110 | + |
| 111 | + private static List<String> scanBytes(byte[] data, List<byte[]> searchPatterns) { |
| 112 | + List<String> matches = new ArrayList<>(); |
| 113 | + for (int i = 0; i < data.length; i++) { |
| 114 | + for (byte[] searchPattern : searchPatterns) { |
| 115 | + boolean found = true; |
| 116 | + for (int j = 0; j < searchPattern.length; j++) { |
| 117 | + if ((i + j >= data.length || data[i + j] != searchPattern[j])) { |
| 118 | + found = false; |
| 119 | + break; |
| 120 | + } |
| 121 | + } |
| 122 | + if (found) { |
| 123 | + int cs = charsStart(data, i); |
| 124 | + int co = charsOffset(data, i, searchPattern.length); |
| 125 | + matches.add(new String(data, cs, co)); |
| 126 | + // No need to search the same string for multiple patterns |
| 127 | + break; |
| 128 | + } |
| 129 | + } |
| 130 | + } |
| 131 | + return matches; |
| 132 | + } |
| 133 | + |
| 134 | + private static int charsStart(byte[] data, int startIndex) { |
| 135 | + int index = startIndex; |
| 136 | + while (--index > 0) { |
| 137 | + byte datum = data[index]; |
| 138 | + if (datum < 32 || datum > 126) { |
| 139 | + break; |
| 140 | + } |
| 141 | + } |
| 142 | + return index + 1; |
| 143 | + } |
| 144 | + |
| 145 | + private static int charsOffset(byte[] data, int startIndex, int startOffset) { |
| 146 | + int offset = startOffset; |
| 147 | + while (startIndex + ++offset < data.length) { |
| 148 | + byte datum = data[startIndex + offset]; |
| 149 | + if (datum < 32 || datum > 126) { |
| 150 | + break; |
| 151 | + } |
| 152 | + } |
| 153 | + return offset; |
| 154 | + } |
| 155 | +} |
0 commit comments