SleuthkitJNI.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * Copyright 2011-2016 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.datamodel;

import java.io.BufferedReader;
import java.io.FileReader;
import java.io.IOException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.GregorianCalendar;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.TimeZone;
import java.util.UUID;
import org.sleuthkit.datamodel.TskData.TSK_FS_ATTR_TYPE_ENUM;

public class SleuthkitJNI {

        /*
         * Loads the SleuthKit libraries.
         */
        static {
                LibraryUtils.loadSleuthkitJNI();
        }

        /*
         * A monitor used to guard access to cached SleuthKit image and file system
         * handles.
         */
        private static final Object cacheLock = new Object();

        private SleuthkitJNI() {
        }

        public static class CaseDbHandle {

                /*
                 * A pointer to a TskCaseDb object.
                 */
                private final long caseDbPointer;

                /*
                 * A SleuthKit image handle cache implemented as a mappng of
                 * concatenated image file paths to image handles.
                 */
                private static final Map<String, Long> imageHandleCache = new HashMap<String, Long>();

                /*
                 * A SleuthKit file system handles cache implemented as a mapping of
                 * image handles to image offset and file system handle pairs.
                 */
                private static final Map<Long, Map<Long, Long>> fsHandleCache = new HashMap<Long, Map<Long, Long>>();

                private CaseDbHandle(long caseDbPointer) {
                        this.caseDbPointer = caseDbPointer;
                }

                void free() throws TskCoreException {
                        synchronized (cacheLock) {
                                /*
                                 * Close any cached file system handles.
                                 */
                                for (Map<Long, Long> imageToFsMap : fsHandleCache.values()) {
                                        for (Long fsHandle : imageToFsMap.values()) {
                                                closeFsNat(fsHandle);
                                        }
                                }

                                /*
                                 * Close any cached image handles.
                                 */
                                for (Long imageHandle : imageHandleCache.values()) {
                                        closeImgNat(imageHandle);
                                }

                                fsHandleCache.clear();
                                imageHandleCache.clear();
                        }

                        SleuthkitJNI.closeCaseDbNat(caseDbPointer);
                }

                long addImageInfo(long deviceObjId, List<String> imageFilePaths, String timeZone) throws TskCoreException {
                        try {
                                long tskAutoDbPointer = initializeAddImgNat(caseDbPointer, timezoneLongToShort(timeZone), false, false, false);
                                runOpenAndAddImgNat(tskAutoDbPointer, UUID.randomUUID().toString(), imageFilePaths.toArray(new String[0]), imageFilePaths.size(), timeZone);
                                return commitAddImgNat(tskAutoDbPointer);
                        } catch (TskDataException ex) {
                                throw new TskCoreException("Error adding image to case database", ex);
                        }
                }

                AddImageProcess initAddImageProcess(String timeZone, boolean addUnallocSpace, boolean skipFatFsOrphans, String imageWriterPath) {
                        return new AddImageProcess(timeZone, addUnallocSpace, skipFatFsOrphans, imageWriterPath);
                }

                public class AddImageProcess {

                        private final String timeZone;
                        private final boolean addUnallocSpace;
                        private final boolean skipFatFsOrphans;
                        private final String imageWriterPath;
                        private volatile long tskAutoDbPointer;
                        private boolean isCanceled;

                        private AddImageProcess(String timeZone, boolean addUnallocSpace, boolean skipFatFsOrphans, String imageWriterPath) {
                                this.timeZone = timeZone;
                                this.addUnallocSpace = addUnallocSpace;
                                this.skipFatFsOrphans = skipFatFsOrphans;
                                this.imageWriterPath = imageWriterPath;
                                tskAutoDbPointer = 0;
                                this.isCanceled = false;
                        }

                        public void run(String deviceId, String[] imageFilePaths) throws TskCoreException, TskDataException {
                                long imageHandle = 0;
                                synchronized (this) {
                                        if (0 != tskAutoDbPointer) {
                                                throw new TskCoreException("Add image process already started");
                                        }
                                        if (!isCanceled) { //with isCanceled being guarded by this it will have the same value everywhere in this synchronized block
                                                imageHandle = openImage(imageFilePaths, false);
                                                tskAutoDbPointer = initAddImgNat(caseDbPointer, timezoneLongToShort(timeZone), addUnallocSpace, skipFatFsOrphans);
                                        }
                                        if (0 == tskAutoDbPointer) {
                                                throw new TskCoreException("initAddImgNat returned a NULL TskAutoDb pointer");
                                        }
                                }
                                if (imageHandle != 0) {
                                        runAddImgNat(tskAutoDbPointer, deviceId, imageHandle, timeZone, imageWriterPath);
                                }
                        }

                        public synchronized void stop() throws TskCoreException {
                                isCanceled = true;
                                if (tskAutoDbPointer != 0) {
                                        stopAddImgNat(tskAutoDbPointer);
                                }
                        }

                        public synchronized void revert() throws TskCoreException {
                                if (tskAutoDbPointer == 0) {
                                        throw new TskCoreException("AddImgProcess::revert: AutoDB pointer is NULL");
                                }

                                revertAddImgNat(tskAutoDbPointer);
                                // the native code deleted the object
                                tskAutoDbPointer = 0;
                        }

                        public synchronized long commit() throws TskCoreException {
                                if (tskAutoDbPointer == 0) {
                                        throw new TskCoreException("AddImgProcess::commit: AutoDB pointer is NULL");
                                }

                                long id = commitAddImgNat(tskAutoDbPointer);
                                // the native code deleted the object
                                tskAutoDbPointer = 0;
                                return id;
                        }

                        public synchronized String currentDirectory() {
                                return tskAutoDbPointer == 0 ? "" : getCurDirNat(tskAutoDbPointer); //NON-NLS
                        }

                        @Deprecated
                        public void run(String[] imageFilePaths) throws TskCoreException, TskDataException {
                                run(null, imageFilePaths);
                        }
                }

        }

        static CaseDbHandle newCaseDb(String path) throws TskCoreException {
                return new CaseDbHandle(newCaseDbNat(path));
        }

        static CaseDbHandle newCaseDb(String databaseName, CaseDbConnectionInfo info) throws TskCoreException {
                return new CaseDbHandle(newCaseDbMultiNat(info.getHost(), info.getPort(), info.getUserName(), info.getPassword(), info.getDbType().ordinal(), databaseName));
        }

        static CaseDbHandle openCaseDb(String path) throws TskCoreException {
                return new CaseDbHandle(openCaseDbNat(path));
        }

        static CaseDbHandle openCaseDb(String databaseName, CaseDbConnectionInfo info) throws TskCoreException {
                return new CaseDbHandle(openCaseDbMultiNat(info.getHost(), info.getPort(), info.getUserName(), info.getPassword(), info.getDbType().ordinal(), databaseName));
        }

        public static String getVersion() {
                return getVersionNat();
        }

        public static void startVerboseLogging(String logPath) {
                startVerboseLoggingNat(logPath);
        }

        public static long openImage(String[] imageFiles) throws TskCoreException {
                return openImage(imageFiles, true);
        }

        private static long openImage(String[] imageFiles, boolean useCache) throws TskCoreException {

                long imageHandle;

                StringBuilder keyBuilder = new StringBuilder();
                for (int i = 0; i < imageFiles.length; ++i) {
                        keyBuilder.append(imageFiles[i]);
                }
                final String imageKey = keyBuilder.toString();

                synchronized (cacheLock) {
                        // If we're getting a fresh copy, remove any existing cache references
                        if (!useCache && CaseDbHandle.imageHandleCache.containsKey(imageKey)) {
                                long tempImageHandle = CaseDbHandle.imageHandleCache.get(imageKey);
                                CaseDbHandle.fsHandleCache.remove(tempImageHandle);
                                CaseDbHandle.imageHandleCache.remove(imageKey);
                        }

                        if (useCache && CaseDbHandle.imageHandleCache.containsKey(imageKey)) //get from cache
                        {
                                imageHandle = CaseDbHandle.imageHandleCache.get(imageKey);
                        } else {
                                //open new handle and cache it
                                imageHandle = openImgNat(imageFiles, imageFiles.length);
                                CaseDbHandle.fsHandleCache.put(imageHandle, new HashMap<Long, Long>());
                                CaseDbHandle.imageHandleCache.put(imageKey, imageHandle);
                        }
                }
                return imageHandle;
        }

        public static long openVs(long imgHandle, long vsOffset) throws TskCoreException {
                return openVsNat(imgHandle, vsOffset);
        }

        //get pointers
        public static long openVsPart(long vsHandle, long volId) throws TskCoreException {
                //returned long is ptr to vs Handle object in tsk
                return openVolNat(vsHandle, volId);
        }

        public static long openFs(long imgHandle, long fsOffset) throws TskCoreException {
                long fsHandle;
                synchronized (cacheLock) {
                        final Map<Long, Long> imgOffSetToFsHandle = CaseDbHandle.fsHandleCache.get(imgHandle);
                        if (imgOffSetToFsHandle.containsKey(fsOffset)) {
                                //return cached
                                fsHandle = imgOffSetToFsHandle.get(fsOffset);
                        } else {
                                fsHandle = openFsNat(imgHandle, fsOffset);
                                //cache it
                                imgOffSetToFsHandle.put(fsOffset, fsHandle);
                        }
                }
                return fsHandle;
        }

        public static long openFile(long fsHandle, long fileId, TSK_FS_ATTR_TYPE_ENUM attrType, int attrId) throws TskCoreException {
                /*
                 * NOTE: previously attrId used to be stored in AbstractFile as (signed)
                 * short even though it is stored as uint16 in TSK. In extremely rare
                 * occurrences attrId can be larger than what a signed short can hold
                 * (2^15). Changes were made to AbstractFile to store attrId as integer.
                 * However, a depricated method still exists in AbstractFile to get
                 * attrId as short. In that method we convert attribute ids that are
                 * larger than 32K to a negative number. Therefore if encountered, we
                 * need to convert negative attribute id to uint16 which is what TSK is
                 * using to store attribute id.
                 */
                return openFileNat(fsHandle, fileId, attrType.getValue(), convertSignedToUnsigned(attrId));
        }

        private static int convertSignedToUnsigned(int val) {
                if (val >= 0) {
                        return val;
                }

                return val & 0xffff;    // convert negative value to positive value
        }

        //do reads
        public static int readImg(long imgHandle, byte[] readBuffer, long offset, long len) throws TskCoreException {
                //returned byte[] is the data buffer
                return readImgNat(imgHandle, readBuffer, offset, len);
        }

        public static int readVs(long vsHandle, byte[] readBuffer, long offset, long len) throws TskCoreException {
                return readVsNat(vsHandle, readBuffer, offset, len);
        }

        public static int readVsPart(long volHandle, byte[] readBuffer, long offset, long len) throws TskCoreException {
                //returned byte[] is the data buffer
                return readVolNat(volHandle, readBuffer, offset, len);
        }

        public static int readFs(long fsHandle, byte[] readBuffer, long offset, long len) throws TskCoreException {
                //returned byte[] is the data buffer
                return readFsNat(fsHandle, readBuffer, offset, len);
        }

        private enum TSK_FS_FILE_READ_OFFSET_TYPE_ENUM {
                START_OF_FILE(0),
                START_OF_SLACK(1);

                private final int val;

                TSK_FS_FILE_READ_OFFSET_TYPE_ENUM(int val) {
                        this.val = val;
                }

                int getValue() {
                        return val;
                }
        }

        public static int readFile(long fileHandle, byte[] readBuffer, long offset, long len) throws TskCoreException {
                return readFileNat(fileHandle, readBuffer, offset, TSK_FS_FILE_READ_OFFSET_TYPE_ENUM.START_OF_FILE.getValue(), len);
        }

        public static int readFileSlack(long fileHandle, byte[] readBuffer, long offset, long len) throws TskCoreException {
                return readFileNat(fileHandle, readBuffer, offset, TSK_FS_FILE_READ_OFFSET_TYPE_ENUM.START_OF_SLACK.getValue(), len);
        }

        public static List<String> getFileMetaDataText(long fileHandle) throws TskCoreException {
                try {
                        java.io.File tmp = java.io.File.createTempFile("tsk", ".txt");

                        saveFileMetaDataTextNat(fileHandle, tmp.getAbsolutePath());

                        FileReader fr = new FileReader(tmp.getAbsolutePath());
                        BufferedReader textReader = new BufferedReader(fr);

                        List<String> lines = new ArrayList<String>();
                        while (true) {
                                String line = textReader.readLine();
                                if (line == null) {
                                        break;
                                }
                                lines.add(line);
                        }
                        textReader.close();
                        fr.close();
                        tmp.delete();
                        return lines;
                } catch (IOException ex) {
                        throw new TskCoreException("Error reading istat output: " + ex.getLocalizedMessage());
                }
        }

        //free pointers
        public static void closeImg(long imgHandle) {
                //@@@ TODO close the image handle when Case is closed instead
                //currently the image handle is not being freed, it's cached for duration of the application
                //closeImgNat(imgHandle); 
        }

        public static void closeVs(long vsHandle) {
                closeVsNat(vsHandle);
        }

        public static void closeFs(long fsHandle) {
                //@@@ TODO close the fs handle when Case is closed instead
                //currently the fs handle is not being freed, it's cached for duration of the application
                //closeFsNat(fsHandle);
        }

        public static void closeFile(long fileHandle) {
                closeFileNat(fileHandle);
        }

        public static void createLookupIndexForHashDatabase(int dbHandle) throws TskCoreException {
                hashDbCreateIndexNat(dbHandle);
        }

        public static boolean hashDatabaseHasLookupIndex(int dbHandle) throws TskCoreException {
                return hashDbIndexExistsNat(dbHandle);
        }

        public static boolean hashDatabaseCanBeReindexed(int dbHandle) throws TskCoreException {
                return hashDbIsReindexableNat(dbHandle);
        }

        public static String getHashDatabasePath(int dbHandle) throws TskCoreException {
                return hashDbPathNat(dbHandle);
        }

        public static String getHashDatabaseIndexPath(int dbHandle) throws TskCoreException {
                return hashDbIndexPathNat(dbHandle);
        }

        public static int openHashDatabase(String path) throws TskCoreException {
                return hashDbOpenNat(path);
        }

        public static int createHashDatabase(String path) throws TskCoreException {
                return hashDbNewNat(path);
        }

        public static void closeAllHashDatabases() throws TskCoreException {
                hashDbCloseAll();
        }

        public static void closeHashDatabase(int dbHandle) throws TskCoreException {
                hashDbClose(dbHandle);
        }

        public static String getHashDatabaseDisplayName(int dbHandle) throws TskCoreException {
                return hashDbGetDisplayName(dbHandle);
        }

        public static boolean lookupInHashDatabase(String hash, int dbHandle) throws TskCoreException {
                return hashDbLookup(hash, dbHandle);
        }

        public static HashHitInfo lookupInHashDatabaseVerbose(String hash, int dbHandle) throws TskCoreException {
                return hashDbLookupVerbose(hash, dbHandle);
        }

        public static void addToHashDatabase(String filename, String md5, String sha1, String sha256, String comment, int dbHandle) throws TskCoreException {
                hashDbAddEntryNat(filename, md5, sha1, sha256, comment, dbHandle);
        }

        public static void addToHashDatabase(List<HashEntry> hashes, int dbHandle) throws TskCoreException {
                hashDbBeginTransactionNat(dbHandle);
                try {
                        for (HashEntry entry : hashes) {
                                hashDbAddEntryNat(entry.getFileName(), entry.getMd5Hash(), entry.getSha1Hash(), entry.getSha256Hash(), entry.getComment(), dbHandle);
                        }
                        hashDbCommitTransactionNat(dbHandle);
                } catch (TskCoreException ex) {
                        try {
                                hashDbRollbackTransactionNat(dbHandle);
                        } catch (TskCoreException ex2) {
                                ex2.initCause(ex);
                                throw ex2;
                        }
                        throw ex;
                }
        }

        public static boolean isUpdateableHashDatabase(int dbHandle) throws TskCoreException {
                return hashDbIsUpdateableNat(dbHandle);
        }

        public static boolean hashDatabaseIsIndexOnly(int dbHandle) throws TskCoreException {
                return hashDbIsIdxOnlyNat(dbHandle);
        }

        private static String timezoneLongToShort(String timezoneLongForm) {
                if (timezoneLongForm == null || timezoneLongForm.isEmpty()) {
                        return "";
                }

                String timezoneShortForm;
                TimeZone zone = TimeZone.getTimeZone(timezoneLongForm);
                int offset = zone.getRawOffset() / 1000;
                int hour = offset / 3600;
                int min = (offset % 3600) / 60;
                DateFormat dfm = new SimpleDateFormat("z");
                dfm.setTimeZone(zone);
                boolean hasDaylight = zone.useDaylightTime();
                String first = dfm.format(new GregorianCalendar(2010, 1, 1).getTime()).substring(0, 3); // make it only 3 letters code
                String second = dfm.format(new GregorianCalendar(2011, 6, 6).getTime()).substring(0, 3); // make it only 3 letters code
                int mid = hour * -1;
                timezoneShortForm = first + Integer.toString(mid);
                if (min != 0) {
                        timezoneShortForm = timezoneShortForm + ":" + (min < 10 ? "0" : "") + Integer.toString(min);
                }
                if (hasDaylight) {
                        timezoneShortForm += second;
                }
                return timezoneShortForm;
        }

        public static int finishImageWriter(long imgHandle) throws TskCoreException {
                return finishImageWriterNat(imgHandle);
        }

        public static int getFinishImageProgress(long imgHandle) {
                return getFinishImageProgressNat(imgHandle);
        }

        public static void cancelFinishImage(long imgHandle) {
                cancelFinishImageNat(imgHandle);
        }

        public static long findDeviceSize(String devPath) throws TskCoreException {
                return findDeviceSizeNat(devPath);
        }

        public static boolean isImageSupported(String imagePath) {
                return isImageSupportedNat(imagePath);
        }

        private static native String getVersionNat();

        private static native void startVerboseLoggingNat(String logPath);

        private static native long newCaseDbNat(String dbPath) throws TskCoreException;

        private static native long newCaseDbMultiNat(String hostNameOrIP, String portNumber, String userName, String password, int dbTypeOrdinal, String databaseName);

        private static native long openCaseDbMultiNat(String hostNameOrIP, String portNumber, String userName, String password, int dbTypeOrdinal, String databaseName);

        private static native long openCaseDbNat(String path) throws TskCoreException;

        private static native void closeCaseDbNat(long db) throws TskCoreException;

        private static native int hashDbOpenNat(String hashDbPath) throws TskCoreException;

        private static native int hashDbNewNat(String hashDbPath) throws TskCoreException;

        private static native int hashDbBeginTransactionNat(int dbHandle) throws TskCoreException;

        private static native int hashDbCommitTransactionNat(int dbHandle) throws TskCoreException;

        private static native int hashDbRollbackTransactionNat(int dbHandle) throws TskCoreException;

        private static native int hashDbAddEntryNat(String filename, String hashMd5, String hashSha1, String hashSha256, String comment, int dbHandle) throws TskCoreException;

        private static native boolean hashDbIsUpdateableNat(int dbHandle);

        private static native boolean hashDbIsReindexableNat(int dbHandle);

        private static native String hashDbPathNat(int dbHandle);

        private static native String hashDbIndexPathNat(int dbHandle);

        private static native String hashDbGetDisplayName(int dbHandle) throws TskCoreException;

        private static native void hashDbCloseAll() throws TskCoreException;

        private static native void hashDbClose(int dbHandle) throws TskCoreException;

        private static native void hashDbCreateIndexNat(int dbHandle) throws TskCoreException;

        private static native boolean hashDbIndexExistsNat(int dbHandle) throws TskCoreException;

        private static native boolean hashDbIsIdxOnlyNat(int dbHandle) throws TskCoreException;

        private static native boolean hashDbLookup(String hash, int dbHandle) throws TskCoreException;

        private static native HashHitInfo hashDbLookupVerbose(String hash, int dbHandle) throws TskCoreException;

        private static native long initAddImgNat(long db, String timezone, boolean addUnallocSpace, boolean skipFatFsOrphans) throws TskCoreException;

        private static native long initializeAddImgNat(long db, String timezone, boolean addFileSystems, boolean addUnallocSpace, boolean skipFatFsOrphans) throws TskCoreException;

        private static native void runOpenAndAddImgNat(long process, String deviceId, String[] imgPath, int splits, String timezone) throws TskCoreException, TskDataException;

        private static native void runAddImgNat(long process, String deviceId, long a_img_info, String timeZone, String imageWriterPath) throws TskCoreException, TskDataException;

        private static native void stopAddImgNat(long process) throws TskCoreException;

        private static native void revertAddImgNat(long process) throws TskCoreException;

        private static native long commitAddImgNat(long process) throws TskCoreException;

        private static native long openImgNat(String[] imgPath, int splits) throws TskCoreException;

        private static native long openVsNat(long imgHandle, long vsOffset) throws TskCoreException;

        private static native long openVolNat(long vsHandle, long volId) throws TskCoreException;

        private static native long openFsNat(long imgHandle, long fsId) throws TskCoreException;

        private static native long openFileNat(long fsHandle, long fileId, int attrType, int attrId) throws TskCoreException;

        private static native int readImgNat(long imgHandle, byte[] readBuffer, long offset, long len) throws TskCoreException;

        private static native int readVsNat(long vsHandle, byte[] readBuffer, long offset, long len) throws TskCoreException;

        private static native int readVolNat(long volHandle, byte[] readBuffer, long offset, long len) throws TskCoreException;

        private static native int readFsNat(long fsHandle, byte[] readBuffer, long offset, long len) throws TskCoreException;

        private static native int readFileNat(long fileHandle, byte[] readBuffer, long offset, int offset_type, long len) throws TskCoreException;

        private static native int saveFileMetaDataTextNat(long fileHandle, String fileName) throws TskCoreException;

        private static native void closeImgNat(long imgHandle);

        private static native void closeVsNat(long vsHandle);

        private static native void closeFsNat(long fsHandle);

        private static native void closeFileNat(long fileHandle);

        private static native long findDeviceSizeNat(String devicePath) throws TskCoreException;

        private static native String getCurDirNat(long process);

        private static native boolean isImageSupportedNat(String imagePath);

        private static native int finishImageWriterNat(long a_img_info);

        private static native int getFinishImageProgressNat(long a_img_info);

        private static native void cancelFinishImageNat(long a_img_info);

}