CorrelationDataSource.java

Go to the documentation of this file.

/*
 * Central Repository
 *
 * Copyright 2015-2019 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.centralrepository.datamodel;

import java.io.Serializable;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.Image;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.TskDataException;

public class CorrelationDataSource implements Serializable {

    private static final long serialVersionUID = 1L;

    private final int caseID; //the value in the id column of the case table in the central repo
    private final int dataSourceID;   //< Id in the central repo
    private final Long dataSourceObjectID; //< Id for data source in the caseDB 
    private final String deviceID;  //< Unique to its associated case (not necessarily globally unique)
    private final String name;
    private String md5Hash;
    private String sha1Hash;
    private String sha256Hash;

    public CorrelationDataSource(CorrelationCase correlationCase,
            String deviceId,
            String name,
            Long dataSourceObjectId,
            String md5Hash,
            String sha1Hash,
            String sha256Hash) {
        this(correlationCase.getID(), -1, deviceId, name, dataSourceObjectId, md5Hash, sha1Hash, sha256Hash);
    }

    CorrelationDataSource(int caseId,
            int dataSourceId,
            String deviceId,
            String name,
            Long dataSourceObjectId,
            String md5Hash,
            String sha1Hash,
            String sha256Hash) {
        this.caseID = caseId;
        this.dataSourceID = dataSourceId;
        this.deviceID = deviceId;
        this.name = name;
        this.dataSourceObjectID = dataSourceObjectId;
        this.md5Hash = md5Hash;
        this.sha1Hash = sha1Hash;
        this.sha256Hash = sha256Hash;
    }

    public static CorrelationDataSource fromTSKDataSource(CorrelationCase correlationCase, Content dataSource) throws CentralRepoException {
        Case curCase;
        try {
            curCase = Case.getCurrentCaseThrows();
        } catch (NoCurrentCaseException ex) {
            throw new CentralRepoException("Autopsy case is closed");
        }

        CorrelationDataSource correlationDataSource = null;
        boolean useCR = CentralRepository.isEnabled();
        if (useCR) {
            correlationDataSource = CentralRepository.getInstance().getDataSource(correlationCase, dataSource.getId());
        }

        if (correlationDataSource == null) {
            String deviceId;
            String md5 = null;
            String sha1 = null;
            String sha256 = null;
            try {
                deviceId = curCase.getSleuthkitCase().getDataSource(dataSource.getId()).getDeviceId();
                
                if (dataSource instanceof Image) {
                    Image image = (Image) dataSource;
                    md5 = image.getMd5();
                    sha1 = image.getSha1();
                    sha256 = image.getSha256();
                }
            } catch (TskDataException | TskCoreException ex) {
                throw new CentralRepoException("Error getting data source info: " + ex.getMessage());
            }

            correlationDataSource = new CorrelationDataSource(correlationCase, deviceId, dataSource.getName(), dataSource.getId(), md5, sha1, sha256);
            if (useCR) {
                //add the correlation data source to the central repository and fill in the Central repository data source id in the object
                correlationDataSource = CentralRepository.getInstance().newDataSource(correlationDataSource);
            }
        }
        return correlationDataSource;
    }

    @Override
    public String toString() {
        StringBuilder str = new StringBuilder();
        str.append("(");
        str.append("ID=").append(Integer.toString(getID()));
        str.append(",caseID=").append(Integer.toString(getCaseID()));
        str.append(",deviceID=").append(getDeviceID());
        str.append(",name=").append(getName());
        str.append(")");
        return str.toString();
    }

    public int getID() {
        return dataSourceID;
    }

    public String getDeviceID() {
        return deviceID;
    }

    public int getCaseID() {
        return caseID;
    }

    public Long getDataSourceObjectID() {
        return dataSourceObjectID;
    }

    public String getName() {
        return name;
    }
    
    public String getMd5() {
        return (md5Hash == null ? "" : md5Hash);
    }
    
    public void setMd5(String md5Hash) throws CentralRepoException {
        this.md5Hash = md5Hash;
        
        if (dataSourceObjectID != -1) {
            CentralRepository.getInstance().updateDataSourceMd5Hash(this);
        }
    }
    
    public String getSha1() {
        return (sha1Hash == null ? "" : sha1Hash);
    }
    
    public void setSha1(String sha1Hash) throws CentralRepoException {
        this.sha1Hash = sha1Hash;
        
        if (dataSourceObjectID != -1) {
            CentralRepository.getInstance().updateDataSourceSha1Hash(this);
        }
    }
    
    public String getSha256() {
        return (sha256Hash == null ? "" : sha256Hash);
    }
    
    public void setSha256(String sha256Hash) throws CentralRepoException {
        this.sha256Hash = sha256Hash;
        
        if (dataSourceObjectID != -1) {
            CentralRepository.getInstance().updateDataSourceSha256Hash(this);
        }
    }
}