1/*
2 * Copyright (C) 2011 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#define LOG_TAG "NativeLibraryHelper"
18//#define LOG_NDEBUG 0
19
20#include "core_jni_helpers.h"
21
22#include <nativehelper/ScopedUtfChars.h>
23#include <androidfw/ZipFileRO.h>
24#include <androidfw/ZipUtils.h>
25#include <utils/Log.h>
26#include <utils/Vector.h>
27
28#include <zlib.h>
29
30#include <fcntl.h>
31#include <stdlib.h>
32#include <string.h>
33#include <time.h>
34#include <unistd.h>
35#include <inttypes.h>
36#include <sys/stat.h>
37#include <sys/types.h>
38
39#include <memory>
40
41#define APK_LIB "lib/"
42#define APK_LIB_LEN (sizeof(APK_LIB) - 1)
43
44#define LIB_PREFIX "/lib"
45#define LIB_PREFIX_LEN (sizeof(LIB_PREFIX) - 1)
46
47#define LIB_SUFFIX ".so"
48#define LIB_SUFFIX_LEN (sizeof(LIB_SUFFIX) - 1)
49
50#define RS_BITCODE_SUFFIX ".bc"
51
52#define TMP_FILE_PATTERN "/tmp.XXXXXX"
53#define TMP_FILE_PATTERN_LEN (sizeof(TMP_FILE_PATTERN) - 1)
54
55namespace android {
56
57// These match PackageManager.java install codes
58enum install_status_t {
59    INSTALL_SUCCEEDED = 1,
60    INSTALL_FAILED_INVALID_APK = -2,
61    INSTALL_FAILED_INSUFFICIENT_STORAGE = -4,
62    INSTALL_FAILED_CONTAINER_ERROR = -18,
63    INSTALL_FAILED_INTERNAL_ERROR = -110,
64    INSTALL_FAILED_NO_MATCHING_ABIS = -113,
65    NO_NATIVE_LIBRARIES = -114
66};
67
68typedef install_status_t (*iterFunc)(JNIEnv*, void*, ZipFileRO*, ZipEntryRO, const char*);
69
70// Equivalent to android.os.FileUtils.isFilenameSafe
71static bool
72isFilenameSafe(const char* filename)
73{
74    off_t offset = 0;
75    for (;;) {
76        switch (*(filename + offset)) {
77        case 0:
78            // Null.
79            // If we've reached the end, all the other characters are good.
80            return true;
81
82        case 'A' ... 'Z':
83        case 'a' ... 'z':
84        case '0' ... '9':
85        case '+':
86        case ',':
87        case '-':
88        case '.':
89        case '/':
90        case '=':
91        case '_':
92            offset++;
93            break;
94
95        default:
96            // We found something that is not good.
97            return false;
98        }
99    }
100    // Should not reach here.
101}
102
103static bool
104isFileDifferent(const char* filePath, uint32_t fileSize, time_t modifiedTime,
105        uint32_t zipCrc, struct stat64* st)
106{
107    if (lstat64(filePath, st) < 0) {
108        // File is not found or cannot be read.
109        ALOGV("Couldn't stat %s, copying: %s\n", filePath, strerror(errno));
110        return true;
111    }
112
113    if (!S_ISREG(st->st_mode)) {
114        return true;
115    }
116
117    if (static_cast<uint64_t>(st->st_size) != static_cast<uint64_t>(fileSize)) {
118        return true;
119    }
120
121    // For some reason, bionic doesn't define st_mtime as time_t
122    if (time_t(st->st_mtime) != modifiedTime) {
123        ALOGV("mod time doesn't match: %ld vs. %ld\n", st->st_mtime, modifiedTime);
124        return true;
125    }
126
127    int fd = TEMP_FAILURE_RETRY(open(filePath, O_RDONLY));
128    if (fd < 0) {
129        ALOGV("Couldn't open file %s: %s", filePath, strerror(errno));
130        return true;
131    }
132
133    // uLong comes from zlib.h. It's a bit of a wart that they're
134    // potentially using a 64-bit type for a 32-bit CRC.
135    uLong crc = crc32(0L, Z_NULL, 0);
136    unsigned char crcBuffer[16384];
137    ssize_t numBytes;
138    while ((numBytes = TEMP_FAILURE_RETRY(read(fd, crcBuffer, sizeof(crcBuffer)))) > 0) {
139        crc = crc32(crc, crcBuffer, numBytes);
140    }
141    close(fd);
142
143    ALOGV("%s: crc = %lx, zipCrc = %" PRIu32 "\n", filePath, crc, zipCrc);
144
145    if (crc != static_cast<uLong>(zipCrc)) {
146        return true;
147    }
148
149    return false;
150}
151
152static install_status_t
153sumFiles(JNIEnv*, void* arg, ZipFileRO* zipFile, ZipEntryRO zipEntry, const char*)
154{
155    size_t* total = (size_t*) arg;
156    uint32_t uncompLen;
157
158    if (!zipFile->getEntryInfo(zipEntry, NULL, &uncompLen, NULL, NULL, NULL, NULL)) {
159        return INSTALL_FAILED_INVALID_APK;
160    }
161
162    *total += static_cast<size_t>(uncompLen);
163
164    return INSTALL_SUCCEEDED;
165}
166
167/*
168 * Copy the native library if needed.
169 *
170 * This function assumes the library and path names passed in are considered safe.
171 */
172static install_status_t
173copyFileIfChanged(JNIEnv *env, void* arg, ZipFileRO* zipFile, ZipEntryRO zipEntry, const char* fileName)
174{
175    void** args = reinterpret_cast<void**>(arg);
176    jstring* javaNativeLibPath = (jstring*) args[0];
177    jboolean extractNativeLibs = *(jboolean*) args[1];
178    jboolean hasNativeBridge = *(jboolean*) args[2];
179
180    ScopedUtfChars nativeLibPath(env, *javaNativeLibPath);
181
182    uint32_t uncompLen;
183    uint32_t when;
184    uint32_t crc;
185
186    uint16_t method;
187    off64_t offset;
188
189    if (!zipFile->getEntryInfo(zipEntry, &method, &uncompLen, NULL, &offset, &when, &crc)) {
190        ALOGD("Couldn't read zip entry info\n");
191        return INSTALL_FAILED_INVALID_APK;
192    }
193
194    if (!extractNativeLibs) {
195        // check if library is uncompressed and page-aligned
196        if (method != ZipFileRO::kCompressStored) {
197            ALOGD("Library '%s' is compressed - will not be able to open it directly from apk.\n",
198                fileName);
199            return INSTALL_FAILED_INVALID_APK;
200        }
201
202        if (offset % PAGE_SIZE != 0) {
203            ALOGD("Library '%s' is not page-aligned - will not be able to open it directly from"
204                " apk.\n", fileName);
205            return INSTALL_FAILED_INVALID_APK;
206        }
207
208        if (!hasNativeBridge) {
209          return INSTALL_SUCCEEDED;
210        }
211    }
212
213    // Build local file path
214    const size_t fileNameLen = strlen(fileName);
215    char localFileName[nativeLibPath.size() + fileNameLen + 2];
216
217    if (strlcpy(localFileName, nativeLibPath.c_str(), sizeof(localFileName)) != nativeLibPath.size()) {
218        ALOGD("Couldn't allocate local file name for library");
219        return INSTALL_FAILED_INTERNAL_ERROR;
220    }
221
222    *(localFileName + nativeLibPath.size()) = '/';
223
224    if (strlcpy(localFileName + nativeLibPath.size() + 1, fileName, sizeof(localFileName)
225                    - nativeLibPath.size() - 1) != fileNameLen) {
226        ALOGD("Couldn't allocate local file name for library");
227        return INSTALL_FAILED_INTERNAL_ERROR;
228    }
229
230    // Only copy out the native file if it's different.
231    struct tm t;
232    ZipUtils::zipTimeToTimespec(when, &t);
233    const time_t modTime = mktime(&t);
234    struct stat64 st;
235    if (!isFileDifferent(localFileName, uncompLen, modTime, crc, &st)) {
236        return INSTALL_SUCCEEDED;
237    }
238
239    char localTmpFileName[nativeLibPath.size() + TMP_FILE_PATTERN_LEN + 1];
240    if (strlcpy(localTmpFileName, nativeLibPath.c_str(), sizeof(localTmpFileName))
241            != nativeLibPath.size()) {
242        ALOGD("Couldn't allocate local file name for library");
243        return INSTALL_FAILED_INTERNAL_ERROR;
244    }
245
246    if (strlcpy(localTmpFileName + nativeLibPath.size(), TMP_FILE_PATTERN,
247                    TMP_FILE_PATTERN_LEN + 1) != TMP_FILE_PATTERN_LEN) {
248        ALOGI("Couldn't allocate temporary file name for library");
249        return INSTALL_FAILED_INTERNAL_ERROR;
250    }
251
252    int fd = mkstemp(localTmpFileName);
253    if (fd < 0) {
254        ALOGI("Couldn't open temporary file name: %s: %s\n", localTmpFileName, strerror(errno));
255        return INSTALL_FAILED_CONTAINER_ERROR;
256    }
257
258    if (!zipFile->uncompressEntry(zipEntry, fd)) {
259        ALOGI("Failed uncompressing %s to %s\n", fileName, localTmpFileName);
260        close(fd);
261        unlink(localTmpFileName);
262        return INSTALL_FAILED_CONTAINER_ERROR;
263    }
264
265    close(fd);
266
267    // Set the modification time for this file to the ZIP's mod time.
268    struct timeval times[2];
269    times[0].tv_sec = st.st_atime;
270    times[1].tv_sec = modTime;
271    times[0].tv_usec = times[1].tv_usec = 0;
272    if (utimes(localTmpFileName, times) < 0) {
273        ALOGI("Couldn't change modification time on %s: %s\n", localTmpFileName, strerror(errno));
274        unlink(localTmpFileName);
275        return INSTALL_FAILED_CONTAINER_ERROR;
276    }
277
278    // Set the mode to 755
279    static const mode_t mode = S_IRUSR | S_IWUSR | S_IXUSR | S_IRGRP |  S_IXGRP | S_IROTH | S_IXOTH;
280    if (chmod(localTmpFileName, mode) < 0) {
281        ALOGI("Couldn't change permissions on %s: %s\n", localTmpFileName, strerror(errno));
282        unlink(localTmpFileName);
283        return INSTALL_FAILED_CONTAINER_ERROR;
284    }
285
286    // Finally, rename it to the final name.
287    if (rename(localTmpFileName, localFileName) < 0) {
288        ALOGI("Couldn't rename %s to %s: %s\n", localTmpFileName, localFileName, strerror(errno));
289        unlink(localTmpFileName);
290        return INSTALL_FAILED_CONTAINER_ERROR;
291    }
292
293    ALOGV("Successfully moved %s to %s\n", localTmpFileName, localFileName);
294
295    return INSTALL_SUCCEEDED;
296}
297
298/*
299 * An iterator over all shared libraries in a zip file. An entry is
300 * considered to be a shared library if all of the conditions below are
301 * satisfied :
302 *
303 * - The entry is under the lib/ directory.
304 * - The entry name ends with ".so" and the entry name starts with "lib",
305 *   an exception is made for entries whose name is "gdbserver".
306 * - The entry filename is "safe" (as determined by isFilenameSafe).
307 *
308 */
309class NativeLibrariesIterator {
310private:
311    NativeLibrariesIterator(ZipFileRO* zipFile, bool debuggable, void* cookie)
312        : mZipFile(zipFile), mDebuggable(debuggable), mCookie(cookie), mLastSlash(NULL) {
313        fileName[0] = '\0';
314    }
315
316public:
317    static NativeLibrariesIterator* create(ZipFileRO* zipFile, bool debuggable) {
318        void* cookie = NULL;
319        // Do not specify a suffix to find both .so files and gdbserver.
320        if (!zipFile->startIteration(&cookie, APK_LIB, NULL /* suffix */)) {
321            return NULL;
322        }
323
324        return new NativeLibrariesIterator(zipFile, debuggable, cookie);
325    }
326
327    ZipEntryRO next() {
328        ZipEntryRO next = NULL;
329        while ((next = mZipFile->nextEntry(mCookie)) != NULL) {
330            // Make sure this entry has a filename.
331            if (mZipFile->getEntryFileName(next, fileName, sizeof(fileName))) {
332                continue;
333            }
334
335            // Make sure the filename is at least to the minimum library name size.
336            const size_t fileNameLen = strlen(fileName);
337            static const size_t minLength = APK_LIB_LEN + 2 + LIB_PREFIX_LEN + 1 + LIB_SUFFIX_LEN;
338            if (fileNameLen < minLength) {
339                continue;
340            }
341
342            const char* lastSlash = strrchr(fileName, '/');
343            ALOG_ASSERT(lastSlash != NULL, "last slash was null somehow for %s\n", fileName);
344
345            // Skip directories.
346            if (*(lastSlash + 1) == 0) {
347                continue;
348            }
349
350            // Make sure the filename is safe.
351            if (!isFilenameSafe(lastSlash + 1)) {
352                continue;
353            }
354
355            if (!mDebuggable) {
356              // Make sure the filename starts with lib and ends with ".so".
357              if (strncmp(fileName + fileNameLen - LIB_SUFFIX_LEN, LIB_SUFFIX, LIB_SUFFIX_LEN)
358                  || strncmp(lastSlash, LIB_PREFIX, LIB_PREFIX_LEN)) {
359                  continue;
360              }
361            }
362
363            mLastSlash = lastSlash;
364            break;
365        }
366
367        return next;
368    }
369
370    inline const char* currentEntry() const {
371        return fileName;
372    }
373
374    inline const char* lastSlash() const {
375        return mLastSlash;
376    }
377
378    virtual ~NativeLibrariesIterator() {
379        mZipFile->endIteration(mCookie);
380    }
381private:
382
383    char fileName[PATH_MAX];
384    ZipFileRO* const mZipFile;
385    const bool mDebuggable;
386    void* mCookie;
387    const char* mLastSlash;
388};
389
390static install_status_t
391iterateOverNativeFiles(JNIEnv *env, jlong apkHandle, jstring javaCpuAbi,
392                       jboolean debuggable, iterFunc callFunc, void* callArg) {
393    ZipFileRO* zipFile = reinterpret_cast<ZipFileRO*>(apkHandle);
394    if (zipFile == NULL) {
395        return INSTALL_FAILED_INVALID_APK;
396    }
397
398    std::unique_ptr<NativeLibrariesIterator> it(
399            NativeLibrariesIterator::create(zipFile, debuggable));
400    if (it.get() == NULL) {
401        return INSTALL_FAILED_INVALID_APK;
402    }
403
404    const ScopedUtfChars cpuAbi(env, javaCpuAbi);
405    if (cpuAbi.c_str() == NULL) {
406        // This would've thrown, so this return code isn't observable by
407        // Java.
408        return INSTALL_FAILED_INVALID_APK;
409    }
410    ZipEntryRO entry = NULL;
411    while ((entry = it->next()) != NULL) {
412        const char* fileName = it->currentEntry();
413        const char* lastSlash = it->lastSlash();
414
415        // Check to make sure the CPU ABI of this file is one we support.
416        const char* cpuAbiOffset = fileName + APK_LIB_LEN;
417        const size_t cpuAbiRegionSize = lastSlash - cpuAbiOffset;
418
419        if (cpuAbi.size() == cpuAbiRegionSize && !strncmp(cpuAbiOffset, cpuAbi.c_str(), cpuAbiRegionSize)) {
420            install_status_t ret = callFunc(env, callArg, zipFile, entry, lastSlash + 1);
421
422            if (ret != INSTALL_SUCCEEDED) {
423                ALOGV("Failure for entry %s", lastSlash + 1);
424                return ret;
425            }
426        }
427    }
428
429    return INSTALL_SUCCEEDED;
430}
431
432
433static int findSupportedAbi(JNIEnv *env, jlong apkHandle, jobjectArray supportedAbisArray,
434        jboolean debuggable) {
435    const int numAbis = env->GetArrayLength(supportedAbisArray);
436    Vector<ScopedUtfChars*> supportedAbis;
437
438    for (int i = 0; i < numAbis; ++i) {
439        supportedAbis.add(new ScopedUtfChars(env,
440            (jstring) env->GetObjectArrayElement(supportedAbisArray, i)));
441    }
442
443    ZipFileRO* zipFile = reinterpret_cast<ZipFileRO*>(apkHandle);
444    if (zipFile == NULL) {
445        return INSTALL_FAILED_INVALID_APK;
446    }
447
448    std::unique_ptr<NativeLibrariesIterator> it(
449            NativeLibrariesIterator::create(zipFile, debuggable));
450    if (it.get() == NULL) {
451        return INSTALL_FAILED_INVALID_APK;
452    }
453
454    ZipEntryRO entry = NULL;
455    int status = NO_NATIVE_LIBRARIES;
456    while ((entry = it->next()) != NULL) {
457        // We're currently in the lib/ directory of the APK, so it does have some native
458        // code. We should return INSTALL_FAILED_NO_MATCHING_ABIS if none of the
459        // libraries match.
460        if (status == NO_NATIVE_LIBRARIES) {
461            status = INSTALL_FAILED_NO_MATCHING_ABIS;
462        }
463
464        const char* fileName = it->currentEntry();
465        const char* lastSlash = it->lastSlash();
466
467        // Check to see if this CPU ABI matches what we are looking for.
468        const char* abiOffset = fileName + APK_LIB_LEN;
469        const size_t abiSize = lastSlash - abiOffset;
470        for (int i = 0; i < numAbis; i++) {
471            const ScopedUtfChars* abi = supportedAbis[i];
472            if (abi->size() == abiSize && !strncmp(abiOffset, abi->c_str(), abiSize)) {
473                // The entry that comes in first (i.e. with a lower index) has the higher priority.
474                if (((i < status) && (status >= 0)) || (status < 0) ) {
475                    status = i;
476                }
477            }
478        }
479    }
480
481    for (int i = 0; i < numAbis; ++i) {
482        delete supportedAbis[i];
483    }
484
485    return status;
486}
487
488static jint
489com_android_internal_content_NativeLibraryHelper_copyNativeBinaries(JNIEnv *env, jclass clazz,
490        jlong apkHandle, jstring javaNativeLibPath, jstring javaCpuAbi,
491        jboolean extractNativeLibs, jboolean hasNativeBridge, jboolean debuggable)
492{
493    void* args[] = { &javaNativeLibPath, &extractNativeLibs, &hasNativeBridge };
494    return (jint) iterateOverNativeFiles(env, apkHandle, javaCpuAbi, debuggable,
495            copyFileIfChanged, reinterpret_cast<void*>(args));
496}
497
498static jlong
499com_android_internal_content_NativeLibraryHelper_sumNativeBinaries(JNIEnv *env, jclass clazz,
500        jlong apkHandle, jstring javaCpuAbi, jboolean debuggable)
501{
502    size_t totalSize = 0;
503
504    iterateOverNativeFiles(env, apkHandle, javaCpuAbi, debuggable, sumFiles, &totalSize);
505
506    return totalSize;
507}
508
509static jint
510com_android_internal_content_NativeLibraryHelper_findSupportedAbi(JNIEnv *env, jclass clazz,
511        jlong apkHandle, jobjectArray javaCpuAbisToSearch, jboolean debuggable)
512{
513    return (jint) findSupportedAbi(env, apkHandle, javaCpuAbisToSearch, debuggable);
514}
515
516enum bitcode_scan_result_t {
517  APK_SCAN_ERROR = -1,
518  NO_BITCODE_PRESENT = 0,
519  BITCODE_PRESENT = 1,
520};
521
522static jint
523com_android_internal_content_NativeLibraryHelper_hasRenderscriptBitcode(JNIEnv *env, jclass clazz,
524        jlong apkHandle) {
525    ZipFileRO* zipFile = reinterpret_cast<ZipFileRO*>(apkHandle);
526    void* cookie = NULL;
527    if (!zipFile->startIteration(&cookie, NULL /* prefix */, RS_BITCODE_SUFFIX)) {
528        return APK_SCAN_ERROR;
529    }
530
531    char fileName[PATH_MAX];
532    ZipEntryRO next = NULL;
533    while ((next = zipFile->nextEntry(cookie)) != NULL) {
534        if (zipFile->getEntryFileName(next, fileName, sizeof(fileName))) {
535            continue;
536        }
537        const char* lastSlash = strrchr(fileName, '/');
538        const char* baseName = (lastSlash == NULL) ? fileName : fileName + 1;
539        if (isFilenameSafe(baseName)) {
540            zipFile->endIteration(cookie);
541            return BITCODE_PRESENT;
542        }
543    }
544
545    zipFile->endIteration(cookie);
546    return NO_BITCODE_PRESENT;
547}
548
549static jlong
550com_android_internal_content_NativeLibraryHelper_openApk(JNIEnv *env, jclass, jstring apkPath)
551{
552    ScopedUtfChars filePath(env, apkPath);
553    ZipFileRO* zipFile = ZipFileRO::open(filePath.c_str());
554
555    return reinterpret_cast<jlong>(zipFile);
556}
557
558static jlong
559com_android_internal_content_NativeLibraryHelper_openApkFd(JNIEnv *env, jclass,
560        jobject fileDescriptor, jstring debugPathName)
561{
562    ScopedUtfChars debugFilePath(env, debugPathName);
563
564    int fd = jniGetFDFromFileDescriptor(env, fileDescriptor);
565    if (fd < 0) {
566        jniThrowException(env, "java/lang/IllegalArgumentException", "Bad FileDescriptor");
567        return 0;
568    }
569
570    ZipFileRO* zipFile = ZipFileRO::openFd(fd, debugFilePath.c_str());
571
572    return reinterpret_cast<jlong>(zipFile);
573}
574
575static void
576com_android_internal_content_NativeLibraryHelper_close(JNIEnv *env, jclass, jlong apkHandle)
577{
578    delete reinterpret_cast<ZipFileRO*>(apkHandle);
579}
580
581static const JNINativeMethod gMethods[] = {
582    {"nativeOpenApk",
583            "(Ljava/lang/String;)J",
584            (void *)com_android_internal_content_NativeLibraryHelper_openApk},
585    {"nativeOpenApkFd",
586            "(Ljava/io/FileDescriptor;Ljava/lang/String;)J",
587            (void *)com_android_internal_content_NativeLibraryHelper_openApkFd},
588    {"nativeClose",
589            "(J)V",
590            (void *)com_android_internal_content_NativeLibraryHelper_close},
591    {"nativeCopyNativeBinaries",
592            "(JLjava/lang/String;Ljava/lang/String;ZZZ)I",
593            (void *)com_android_internal_content_NativeLibraryHelper_copyNativeBinaries},
594    {"nativeSumNativeBinaries",
595            "(JLjava/lang/String;Z)J",
596            (void *)com_android_internal_content_NativeLibraryHelper_sumNativeBinaries},
597    {"nativeFindSupportedAbi",
598            "(J[Ljava/lang/String;Z)I",
599            (void *)com_android_internal_content_NativeLibraryHelper_findSupportedAbi},
600    {"hasRenderscriptBitcode", "(J)I",
601            (void *)com_android_internal_content_NativeLibraryHelper_hasRenderscriptBitcode},
602};
603
604
605int register_com_android_internal_content_NativeLibraryHelper(JNIEnv *env)
606{
607    return RegisterMethodsOrDie(env,
608            "com/android/internal/content/NativeLibraryHelper", gMethods, NELEM(gMethods));
609}
610
611};
612