HashLookupSettings.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 * 
 * Copyright 2011-2018 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.autopsy.modules.hashdatabase;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.logging.Level;
import javax.swing.JOptionPane;
import org.apache.commons.io.FileUtils;
import org.openide.util.NbBundle;
import org.openide.util.io.NbObjectInputStream;
import org.openide.util.io.NbObjectOutputStream;
import org.openide.windows.WindowManager;
import org.sleuthkit.autopsy.core.RuntimeProperties;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.PlatformUtil;
import org.sleuthkit.autopsy.coreutils.XMLUtil;
import org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.CentralRepoHashSet;
import org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.SleuthkitHashSet;
import org.sleuthkit.datamodel.TskCoreException;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
import org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.HashDb;

final class HashLookupSettings implements Serializable {

    private static final String SERIALIZATION_FILE_NAME = "hashLookup.settings"; //NON-NLS
    private static final String SERIALIZATION_FILE_PATH = PlatformUtil.getUserConfigDirectory() + File.separator + SERIALIZATION_FILE_NAME; //NON-NLS
    private static final String SET_ELEMENT = "hash_set"; //NON-NLS
    private static final String SET_NAME_ATTRIBUTE = "name"; //NON-NLS
    private static final String SET_TYPE_ATTRIBUTE = "type"; //NON-NLS
    private static final String SEARCH_DURING_INGEST_ATTRIBUTE = "use_for_ingest"; //NON-NLS
    private static final String SEND_INGEST_MESSAGES_ATTRIBUTE = "show_inbox_messages"; //NON-NLS
    private static final String PATH_ELEMENT = "hash_set_path"; //NON-NLS
    private static final String LEGACY_PATH_NUMBER_ATTRIBUTE = "number"; //NON-NLS
    private static final String CONFIG_FILE_NAME = "hashsets.xml"; //NON-NLS
    private static final String configFilePath = PlatformUtil.getUserConfigDirectory() + File.separator + CONFIG_FILE_NAME;
    private static final Logger logger = Logger.getLogger(HashDbManager.class.getName());
    
    private static final String USER_DIR_PLACEHOLDER = "[UserConfigFolder]";
    private static final String CURRENT_USER_DIR = PlatformUtil.getUserConfigDirectory();

    private static final long serialVersionUID = 1L;
    private final List<HashDbInfo> hashDbInfoList;

    HashLookupSettings(List<HashDbInfo> hashDbInfoList) {
        this.hashDbInfoList = hashDbInfoList;
    }
    
    static List<HashDbInfo> convertHashSetList(List<HashDbManager.HashDb> hashSets) throws HashLookupSettingsException{
        List<HashDbInfo> dbInfoList = new ArrayList<>();
        for(HashDbManager.HashDb db:hashSets){
            try{
                dbInfoList.add(new HashDbInfo(db));
            } catch (TskCoreException ex){
                logger.log(Level.SEVERE, "Could not load hash set settings for {0}", db.getHashSetName());
            }
        }
        return dbInfoList;
    }

    List<HashDbInfo> getHashDbInfo() {
        return hashDbInfoList;
    }

    static HashLookupSettings readSettings() throws HashLookupSettingsException {
        File fileSetFile = new File(SERIALIZATION_FILE_PATH);
        if (fileSetFile.exists()) {
            return readSerializedSettings();
        }
        return readXmlSettings();

    }

    private static HashLookupSettings readSerializedSettings() throws HashLookupSettingsException {        
        try {
            try (NbObjectInputStream in = new NbObjectInputStream(new FileInputStream(SERIALIZATION_FILE_PATH))) {
                HashLookupSettings filesSetsSettings = (HashLookupSettings) in.readObject();

                /* NOTE: to support JIRA-4177, we need to check if any of the hash 
                database paths are in Windows user directory. If so, we replace the path 
                with USER_DIR_PLACEHOLDER before saving to disk. When reading from disk, 
                USER_DIR_PLACEHOLDER needs to be replaced with current user directory path.
                 */
                convertPlaceholderToPath(filesSetsSettings);
                return filesSetsSettings;
            }
        } catch (IOException | ClassNotFoundException ex) {
            throw new HashLookupSettingsException("Could not read hash set settings.", ex);
        }
    }

    private static HashLookupSettings readXmlSettings() throws HashLookupSettingsException {
        File xmlFile = new File(configFilePath);
        if (xmlFile.exists()) {
            boolean updatedSchema = false;

            // Open the XML document that implements the configuration file.
            final Document doc = XMLUtil.loadDoc(HashDbManager.class, configFilePath);
            if (doc == null) {
                throw new HashLookupSettingsException("Could not open xml document.");
            }

            // Get the root element.
            Element root = doc.getDocumentElement();
            if (root == null) {
                throw new HashLookupSettingsException("Error loading hash sets: invalid file format.");
            }

            // Get the hash set elements.
            NodeList setsNList = root.getElementsByTagName(SET_ELEMENT);
            int numSets = setsNList.getLength();

            // Create HashDbInfo objects for each hash set element. Throws on malformed xml.
            String attributeErrorMessage = "Missing %s attribute"; //NON-NLS
            String elementErrorMessage = "Empty %s element"; //NON-NLS
            List<String> hashSetNames = new ArrayList<>();
            List<HashDbInfo> hashDbInfoList = new ArrayList<>();
            for (int i = 0; i < numSets; ++i) {
                Element setEl = (Element) setsNList.item(i);

                String hashSetName = setEl.getAttribute(SET_NAME_ATTRIBUTE);
                if (hashSetName.isEmpty()) {
                    throw new HashLookupSettingsException(String.format(attributeErrorMessage, SET_NAME_ATTRIBUTE));
                }

                // Handle configurations saved before duplicate hash set names were not permitted.
                if (hashSetNames.contains(hashSetName)) {
                    int suffix = 0;
                    String newHashSetName;
                    do {
                        ++suffix;
                        newHashSetName = hashSetName + suffix;
                    } while (hashSetNames.contains(newHashSetName));
                    logger.log(Level.INFO, "Duplicate hash set name " + hashSetName + " found. Replacing with " + newHashSetName + ".");
                    if (RuntimeProperties.runningWithGUI()) {
                        JOptionPane.showMessageDialog(WindowManager.getDefault().getMainWindow(),
                                NbBundle.getMessage(HashLookupSettings.class,
                                        "HashDbManager.replacingDuplicateHashsetNameMsg",
                                        hashSetName, newHashSetName),
                                NbBundle.getMessage(HashLookupSettings.class, "HashDbManager.openHashDbErr"),
                                JOptionPane.ERROR_MESSAGE);
                        hashSetName = newHashSetName;
                    }
                }

                String knownFilesType = setEl.getAttribute(SET_TYPE_ATTRIBUTE);
                if (knownFilesType.isEmpty()) {
                    throw new HashLookupSettingsException(String.format(attributeErrorMessage, SET_TYPE_ATTRIBUTE));
                }

                // Handle legacy known files types.
                if (knownFilesType.equals("NSRL")) { //NON-NLS
                    knownFilesType = HashDbManager.HashDb.KnownFilesType.KNOWN.toString();
                    updatedSchema = true;
                }

                final String searchDuringIngest = setEl.getAttribute(SEARCH_DURING_INGEST_ATTRIBUTE);
                if (searchDuringIngest.isEmpty()) {
                    throw new HashLookupSettingsException(String.format(attributeErrorMessage, SEND_INGEST_MESSAGES_ATTRIBUTE));
                }
                Boolean searchDuringIngestFlag = Boolean.parseBoolean(searchDuringIngest);

                final String sendIngestMessages = setEl.getAttribute(SEND_INGEST_MESSAGES_ATTRIBUTE);
                if (searchDuringIngest.isEmpty()) {
                    throw new HashLookupSettingsException(String.format(attributeErrorMessage, SEND_INGEST_MESSAGES_ATTRIBUTE));
                }
                Boolean sendIngestMessagesFlag = Boolean.parseBoolean(sendIngestMessages);

                String dbPath;
                NodeList pathsNList = setEl.getElementsByTagName(PATH_ELEMENT);
                if (pathsNList.getLength() > 0) {
                    Element pathEl = (Element) pathsNList.item(0); // Shouldn't be more than one.

                    // Check for legacy path number attribute.
                    String legacyPathNumber = pathEl.getAttribute(LEGACY_PATH_NUMBER_ATTRIBUTE);
                    if (null != legacyPathNumber && !legacyPathNumber.isEmpty()) {
                        updatedSchema = true;
                    }

                    dbPath = pathEl.getTextContent();
                    if (dbPath.isEmpty()) {
                        throw new HashLookupSettingsException(String.format(elementErrorMessage, PATH_ELEMENT));
                    }
                } else {
                    throw new HashLookupSettingsException(String.format(elementErrorMessage, PATH_ELEMENT));
                }
                hashDbInfoList.add(new HashDbInfo(hashSetName, HashDbManager.HashDb.KnownFilesType.valueOf(knownFilesType),
                        searchDuringIngestFlag, sendIngestMessagesFlag, dbPath));
                hashSetNames.add(hashSetName);
            }

            if (updatedSchema) {
                String backupFilePath = configFilePath + ".v1_backup"; //NON-NLS
                String messageBoxTitle = NbBundle.getMessage(HashLookupSettings.class,
                        "HashDbManager.msgBoxTitle.confFileFmtChanged");
                String baseMessage = NbBundle.getMessage(HashLookupSettings.class,
                        "HashDbManager.baseMessage.updatedFormatHashDbConfig");
                try {
                    FileUtils.copyFile(new File(configFilePath), new File(backupFilePath));
                    logger.log(Level.INFO, "Updated the schema, backup saved at: " + backupFilePath);
                    if (RuntimeProperties.runningWithGUI()) {
                        JOptionPane.showMessageDialog(WindowManager.getDefault().getMainWindow(),
                                NbBundle.getMessage(HashLookupSettings.class,
                                        "HashDbManager.savedBackupOfOldConfigMsg",
                                        baseMessage, backupFilePath),
                                messageBoxTitle,
                                JOptionPane.INFORMATION_MESSAGE);
                    }
                } catch (IOException ex) {
                    logger.log(Level.WARNING, "Failed to save backup of old format configuration file to " + backupFilePath, ex); //NON-NLS
                    JOptionPane.showMessageDialog(WindowManager.getDefault().getMainWindow(), baseMessage, messageBoxTitle, JOptionPane.INFORMATION_MESSAGE);
                }
                HashLookupSettings settings;
                settings = new HashLookupSettings(hashDbInfoList);
                HashLookupSettings.writeSettings(settings);
            }
            return new HashLookupSettings(hashDbInfoList);
        } else {
            return new HashLookupSettings(new ArrayList<>());
        }
    }

    static boolean writeSettings(HashLookupSettings settings) {
        
        /* NOTE: to support JIRA-4177, we need to check if any of the hash 
        database paths are in Windows user directory. If so, replace the path 
        with USER_DIR_PLACEHOLDER so that when it is read, it gets updated to be 
        the current user directory path. 
         */
        convertPathToPlaceholder(settings);
        try (NbObjectOutputStream out = new NbObjectOutputStream(new FileOutputStream(SERIALIZATION_FILE_PATH))) {
            out.writeObject(settings);
            // restore the paths, in case they are going to be used somewhere
            convertPlaceholderToPath(settings);
            return true;
        } catch (Exception ex) {
            logger.log(Level.SEVERE, "Could not write hash set settings.");
            return false;
        }
    }

    static void convertPathToPlaceholder(HashLookupSettings settings) {
        for (HashDbInfo hashDbInfo : settings.getHashDbInfo()) {
            if (hashDbInfo.isFileDatabaseType()) {
                String dbPath = hashDbInfo.getPath();
                if (dbPath.startsWith(CURRENT_USER_DIR)) {
                    // replace the current user directory with place holder
                    String remainingPath = dbPath.substring(CURRENT_USER_DIR.length());
                    hashDbInfo.setPath(USER_DIR_PLACEHOLDER + remainingPath);
                }
            }
        }
    }
    
    static void convertPlaceholderToPath(HashLookupSettings settings) {
        for (HashDbInfo hashDbInfo : settings.getHashDbInfo()) {
            if (hashDbInfo.isFileDatabaseType()) {
                String dbPath = hashDbInfo.getPath();
                if (dbPath.startsWith(USER_DIR_PLACEHOLDER)) {
                    // replace the place holder with current user directory
                    String remainingPath = dbPath.substring(USER_DIR_PLACEHOLDER.length());
                    hashDbInfo.setPath(CURRENT_USER_DIR + remainingPath);
                }
            }
        }
    }


    static final class HashDbInfo implements Serializable {

        enum DatabaseType{
            FILE,
            CENTRAL_REPOSITORY
        };
        
        private static final long serialVersionUID = 1L;
        private final String hashSetName;
        private final HashDbManager.HashDb.KnownFilesType knownFilesType;
        private boolean searchDuringIngest;
        private final boolean sendIngestMessages;
        private String path;
        private final String version;
        private final boolean readOnly;
        private final int referenceSetID;
        private DatabaseType dbType;

        HashDbInfo(String hashSetName, HashDbManager.HashDb.KnownFilesType knownFilesType, boolean searchDuringIngest, boolean sendIngestMessages, String path) {
            this.hashSetName = hashSetName;
            this.knownFilesType = knownFilesType;
            this.searchDuringIngest = searchDuringIngest;
            this.sendIngestMessages = sendIngestMessages;
            this.path = path;
            this.referenceSetID = -1;
            this.version = "";
            this.readOnly = false;
            this.dbType = DatabaseType.FILE;
        }
        
        HashDbInfo(String hashSetName, String version, int referenceSetID, HashDbManager.HashDb.KnownFilesType knownFilesType, boolean readOnly, boolean searchDuringIngest, boolean sendIngestMessages){
            this.hashSetName = hashSetName;
            this.version = version;
            this.referenceSetID = referenceSetID;
            this.knownFilesType = knownFilesType;
            this.readOnly = readOnly;
            this.searchDuringIngest = searchDuringIngest;
            this.sendIngestMessages = sendIngestMessages;
            this.path = "";
            dbType = DatabaseType.CENTRAL_REPOSITORY;     
        }
        
        HashDbInfo(HashDbManager.HashDb db) throws TskCoreException{
            if(db instanceof HashDbManager.SleuthkitHashSet){
                HashDbManager.SleuthkitHashSet fileTypeDb = (HashDbManager.SleuthkitHashSet)db;
                this.hashSetName = fileTypeDb.getHashSetName();
                this.knownFilesType = fileTypeDb.getKnownFilesType();
                this.searchDuringIngest = fileTypeDb.getSearchDuringIngest();
                this.sendIngestMessages = fileTypeDb.getSendIngestMessages();
                this.referenceSetID = -1;
                this.version = "";
                this.readOnly = false;
                this.dbType = DatabaseType.FILE;
                if (fileTypeDb.hasIndexOnly()) {
                    this.path = fileTypeDb.getIndexPath();
                } else {
                    this.path = fileTypeDb.getDatabasePath();
                }
            } else {
                HashDbManager.CentralRepoHashSet centralRepoDb = (HashDbManager.CentralRepoHashSet)db;
                this.hashSetName = centralRepoDb.getHashSetName();
                this.version = centralRepoDb.getVersion();
                this.knownFilesType = centralRepoDb.getKnownFilesType();
                this.readOnly = ! centralRepoDb.isUpdateable();
                this.searchDuringIngest = centralRepoDb.getSearchDuringIngest();
                this.sendIngestMessages = centralRepoDb.getSendIngestMessages();
                this.path = "";
                this.referenceSetID = centralRepoDb.getReferenceSetID();
                this.dbType = DatabaseType.CENTRAL_REPOSITORY;
            }
        }

        String getHashSetName() {
            return hashSetName;
        }
        
        String getVersion(){
            return version;
        }
        
        boolean isReadOnly(){
            return readOnly;
        }

        HashDbManager.HashDb.KnownFilesType getKnownFilesType() {
            return knownFilesType;
        }

        boolean getSearchDuringIngest() {
            return searchDuringIngest;
        }
        
        void setSearchDuringIngest(boolean searchDuringIngest) {
            this.searchDuringIngest = searchDuringIngest;
        }

        boolean getSendIngestMessages() {
            return sendIngestMessages;
        }

        String getPath() {
            return path;
        }       

        public void setPath(String path) {
            this.path = path;
        }
        
        int getReferenceSetID(){
            return referenceSetID;
        }
        
        boolean isFileDatabaseType(){
            return dbType == DatabaseType.FILE;
        }
        
        boolean isCentralRepoDatabaseType(){
            return dbType == DatabaseType.CENTRAL_REPOSITORY;
        }
        
        boolean matches(HashDb hashDb){
            if(hashDb == null){
                return false;
            }
            
            if( ! this.knownFilesType.equals(hashDb.getKnownFilesType())){
                return false;
            }
            
            if((this.dbType == DatabaseType.CENTRAL_REPOSITORY) && (! (hashDb instanceof CentralRepoHashSet))
                    || (this.dbType == DatabaseType.FILE) && (! (hashDb instanceof SleuthkitHashSet))){
                return false;
            }
            
            if( ! this.hashSetName.equals(hashDb.getHashSetName())){
                return false;
            }
            
            if(hashDb instanceof CentralRepoHashSet){
                CentralRepoHashSet crDb = (CentralRepoHashSet) hashDb;
                if(this.referenceSetID != crDb.getReferenceSetID()){
                    return false;
                }

                if(! version.equals(crDb.getVersion())){
                    return false;
                }
            }
            
            return true;
        }
        
        @Override
        public boolean equals(Object obj) {
            if (obj == null) {
                return false;
            }
            
            if (getClass() != obj.getClass()) {
                return false;
            }
            
            final HashDbInfo other = (HashDbInfo) obj;
            
            if(! this.dbType.equals(other.dbType)){
                return false;
            }
            
            if(this.dbType.equals(DatabaseType.FILE)){
                // For files, we expect the name and known type to match
                return (this.hashSetName.equals(other.hashSetName)
                        && this.knownFilesType.equals(other.knownFilesType));
            } else {
                // For central repo, the name, index, and known files type should match
                return (this.hashSetName.equals(other.hashSetName)
                        && (this.referenceSetID == other.referenceSetID)
                        && this.knownFilesType.equals(other.knownFilesType));
            }
        }

        @Override
        public int hashCode() {
            int hash = 5;
            hash = 89 * hash + Objects.hashCode(this.hashSetName);
            hash = 89 * hash + Objects.hashCode(this.knownFilesType);
            hash = 89 * hash + Objects.hashCode(this.dbType);
            if(this.dbType.equals(DatabaseType.CENTRAL_REPOSITORY)){
                hash = 89 * hash + this.referenceSetID;
            }
            
            return hash;
        }
        
        private void readObject(java.io.ObjectInputStream stream)
            throws IOException, ClassNotFoundException {
            stream.defaultReadObject();
            
            if(dbType == null){
                dbType = DatabaseType.FILE;
            }
        }
    }

    static class HashLookupSettingsException extends Exception {

        private static final long serialVersionUID = 1L;

        HashLookupSettingsException(String message) {
            super(message);
        }

        HashLookupSettingsException(String message, Throwable throwable) {
            super(message, throwable);
        }
    }
}