CorrelationAttributeInstance.java

Go to the documentation of this file.

/*
 * Central Repository
 *
 * Copyright 2015-2020 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 java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.regex.Pattern;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.datamodel.Account;
import org.sleuthkit.datamodel.TskData;

@Messages({
    "EamArtifactInstances.knownStatus.bad=Bad",
    "EamArtifactInstances.knownStatus.known=Known",
    "EamArtifactInstances.knownStatus.unknown=Unknown"})
public class CorrelationAttributeInstance implements Serializable {

    private static final long serialVersionUID = 1L;

    private int ID;
    private String correlationValue;
    private CorrelationAttributeInstance.Type correlationType;
    private CorrelationCase correlationCase;
    private CorrelationDataSource correlationDataSource;
    private String filePath;
    private String comment;
    private TskData.FileKnown knownStatus;
    private Long objectId;
    private Long accountId;

    public CorrelationAttributeInstance(
            CorrelationAttributeInstance.Type correlationType,
            String correlationValue,
            CorrelationCase eamCase,
            CorrelationDataSource eamDataSource,
            String filePath,
            String comment,
            TskData.FileKnown knownStatus,
            long fileObjectId) throws CentralRepoException, CorrelationAttributeNormalizationException {
        this(correlationType, correlationValue, -1, eamCase, eamDataSource, filePath, comment, knownStatus, fileObjectId);
    }

    CorrelationAttributeInstance(
            Type type,
            String value,
            int instanceId,
            CorrelationCase eamCase,
            CorrelationDataSource eamDataSource,
            String filePath,
            String comment,
            TskData.FileKnown knownStatus,
            Long fileObjectId
    ) throws CentralRepoException, CorrelationAttributeNormalizationException {
         this(type, value, -1, eamCase, eamDataSource, filePath, comment, knownStatus, fileObjectId, (long)-1);
    }
    public CorrelationAttributeInstance(
            Type type,
            String value,
            int instanceId,
            CorrelationCase eamCase,
            CorrelationDataSource eamDataSource,
            String filePath,
            String comment,
            TskData.FileKnown knownStatus,
            Long fileObjectId,
            Long accountId
    ) throws CentralRepoException, CorrelationAttributeNormalizationException {
        if (filePath == null) {
            throw new CentralRepoException("file path is null");
        }

        this.correlationType = type;
        this.correlationValue = CorrelationAttributeNormalizer.normalize(type, value);
        this.ID = instanceId;
        this.correlationCase = eamCase;
        this.correlationDataSource = eamDataSource;
        // Lower case paths to normalize paths and improve correlation results, if this causes significant issues on case-sensitive file systems, remove
        this.filePath = filePath.toLowerCase();
        this.comment = comment;
        this.knownStatus = knownStatus;
        this.objectId = fileObjectId;
        this.accountId = accountId;
    }

    public Boolean equals(CorrelationAttributeInstance otherInstance) {
        return ((this.getID() == otherInstance.getID())
                && (this.getCorrelationValue().equals(otherInstance.getCorrelationValue()))
                && (this.getCorrelationType().equals(otherInstance.getCorrelationType()))
                && (this.getCorrelationCase().equals(otherInstance.getCorrelationCase()))
                && (this.getCorrelationDataSource().equals(otherInstance.getCorrelationDataSource()))
                && (this.getFilePath().equals(otherInstance.getFilePath()))
                && (this.getKnownStatus().equals(otherInstance.getKnownStatus()))
                && (this.getComment().equals(otherInstance.getComment()))
                && (this.getAccountId().equals(otherInstance.getAccountId())));
    }

    @Override
    public String toString() {
        return this.getID()
                + this.getCorrelationCase().getCaseUUID()
                + this.getCorrelationDataSource().getDeviceID()
                + this.getAccountId()
                + this.getFilePath()
                + this.getCorrelationType().toString()
                + this.getCorrelationValue()
                + this.getKnownStatus()
                + this.getComment();
    }

    public String getCorrelationValue() {
        return correlationValue;
    }

    public Type getCorrelationType() {
        return correlationType;
    }

    public boolean isDatabaseInstance() {
        return (ID >= 0);
    }

    public int getID() {
        return ID;
    }

    public CorrelationCase getCorrelationCase() {
        return correlationCase;
    }

    public CorrelationDataSource getCorrelationDataSource() {
        return correlationDataSource;
    }

    public String getFilePath() {
        return filePath;
    }

    public String getComment() {
        return null == comment ? "" : comment;
    }

    public void setComment(String comment) {
        this.comment = comment;
    }

    public TskData.FileKnown getKnownStatus() {
        return knownStatus;
    }

    public void setKnownStatus(TskData.FileKnown knownStatus) {
        this.knownStatus = knownStatus;
    }

    public Long getFileObjectId() {
        return objectId;
    }

    public Long getAccountId() {
        return accountId;
    }

    void setAccountId(Long accountId) {
        this.accountId = accountId;
    }
    
    // Type ID's for Default Correlation Types
    public static final int FILES_TYPE_ID = 0;
    public static final int DOMAIN_TYPE_ID = 1;
    public static final int EMAIL_TYPE_ID = 2;
    public static final int PHONE_TYPE_ID = 3;
    public static final int USBID_TYPE_ID = 4;
    public static final int SSID_TYPE_ID = 5;
    public static final int MAC_TYPE_ID = 6;
    public static final int IMEI_TYPE_ID = 7;
    public static final int IMSI_TYPE_ID = 8;
    public static final int ICCID_TYPE_ID = 9;
    
    // An offset to assign Ids for additional  correlation types.
    public static final int ADDITIONAL_TYPES_BASE_ID = 1000;

    @Messages({"CorrelationType.FILES.displayName=Files",
        "CorrelationType.DOMAIN.displayName=Domains",
        "CorrelationType.EMAIL.displayName=Email Addresses",
        "CorrelationType.PHONE.displayName=Phone Numbers",
        "CorrelationType.USBID.displayName=USB Devices",
        "CorrelationType.SSID.displayName=Wireless Networks",
        "CorrelationType.MAC.displayName=MAC Addresses",
        "CorrelationType.IMEI.displayName=IMEI Number",
        "CorrelationType.IMSI.displayName=IMSI Number",
        "CorrelationType.ICCID.displayName=ICCID Number"})
    public static List<CorrelationAttributeInstance.Type> getDefaultCorrelationTypes() throws CentralRepoException {
        List<CorrelationAttributeInstance.Type> defaultCorrelationTypes = new ArrayList<>();
        
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(FILES_TYPE_ID, Bundle.CorrelationType_FILES_displayName(), "file", true, true)); // NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(DOMAIN_TYPE_ID, Bundle.CorrelationType_DOMAIN_displayName(), "domain", true, true)); // NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(EMAIL_TYPE_ID, Bundle.CorrelationType_EMAIL_displayName(), "email_address", true, true)); // NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(PHONE_TYPE_ID, Bundle.CorrelationType_PHONE_displayName(), "phone_number", true, true)); // NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(USBID_TYPE_ID, Bundle.CorrelationType_USBID_displayName(), "usb_devices", true, true)); // NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(SSID_TYPE_ID, Bundle.CorrelationType_SSID_displayName(), "wireless_networks", true, true)); // NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(MAC_TYPE_ID, Bundle.CorrelationType_MAC_displayName(), "mac_address", true, true)); //NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(IMEI_TYPE_ID, Bundle.CorrelationType_IMEI_displayName(), "imei_number", true, true)); //NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(IMSI_TYPE_ID, Bundle.CorrelationType_IMSI_displayName(), "imsi_number", true, true)); //NON-NLS
        defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(ICCID_TYPE_ID, Bundle.CorrelationType_ICCID_displayName(), "iccid_number", true, true)); //NON-NLS
        
        // Create Correlation Types for Accounts.
        int correlationTypeId = ADDITIONAL_TYPES_BASE_ID;
        for (Account.Type type : Account.Type.PREDEFINED_ACCOUNT_TYPES) {
            // Skip Device account type - we dont want to correlate on those.
            // Skip Phone and Email accounts as there are already Correlation types defined for those.
            if (type != Account.Type.DEVICE && type != Account.Type.EMAIL && type != Account.Type.PHONE) {
                defaultCorrelationTypes.add(new CorrelationAttributeInstance.Type(correlationTypeId, type.getDisplayName(), type.getTypeName().toLowerCase() + "_acct", true, true)); //NON-NLS
                correlationTypeId++;
            }
        }

        return defaultCorrelationTypes;
    }

    @SuppressWarnings("serial")
    public static class Type implements Serializable { // NOPMD Avoid short class names like Type

        private int typeId;
        private String displayName;
        private String dbTableName;
        private Boolean supported;
        private Boolean enabled;
        private final static String DB_NAMES_REGEX = "[a-z][a-z0-9_]*";

        @Messages({"CorrelationAttributeInstance.nullName.message=Database name is null.",
            "CorrelationAttributeInstance.invalidName.message=Invalid database table name. Name must start with a lowercase letter and can only contain lowercase letters, numbers, and '_'."})
        public Type(int typeId, String displayName, String dbTableName, Boolean supported, Boolean enabled) throws CentralRepoException {
            if (dbTableName == null) {
                throw new CentralRepoException("dbTableName is null", Bundle.CorrelationAttributeInstance_nullName_message());
            }
            this.typeId = typeId;
            this.displayName = displayName;
            this.dbTableName = dbTableName;
            this.supported = supported;
            this.enabled = enabled;
            if (!Pattern.matches(DB_NAMES_REGEX, dbTableName)) {
                throw new CentralRepoException("Invalid database table name. Name must start with a lowercase letter and can only contain lowercase letters, numbers, and '_'.", Bundle.CorrelationAttributeInstance_invalidName_message()); // NON-NLS
            }
        }

        public Type(String displayName, String dbTableName, Boolean supported, Boolean enabled) throws CentralRepoException {
            this(-1, displayName, dbTableName, supported, enabled);
        }

        @Override
        public boolean equals(Object that) {
            if (this == that) {
                return true;
            } else if (!(that instanceof CorrelationAttributeInstance.Type)) {
                return false;
            } else {
                return ((CorrelationAttributeInstance.Type) that).sameType(this);
            }
        }

        private boolean sameType(CorrelationAttributeInstance.Type that) {
            return this.typeId == that.getId()
                    && Objects.equals(this.supported, that.isSupported())
                    && Objects.equals(this.enabled, that.isEnabled());
        }

        @Override
        public int hashCode() {
            int hash = 7;
            hash = 67 * hash + Objects.hashCode(this.typeId);
            hash = 67 * hash + Objects.hashCode(this.supported);
            hash = 67 * hash + Objects.hashCode(this.enabled);
            return hash;
        }

        @Override
        public String toString() {
            StringBuilder str = new StringBuilder(55);
            str.append("(id=")
                    .append(getId())
                    .append(", displayName=")
                    .append(getDisplayName())
                    .append(", dbTableName=")
                    .append(getDbTableName())
                    .append(", supported=")
                    .append(isSupported().toString())
                    .append(", enabled=")
                    .append(isEnabled().toString())
                    .append(')');
            return str.toString();
        }

        public int getId() {
            return typeId;
        }

        public void setId(int typeId) {
            this.typeId = typeId;
        }

        public Boolean isSupported() {
            return supported;
        }

        public void setSupported(Boolean supported) {
            this.supported = supported;
        }

        public Boolean isEnabled() {
            return enabled;
        }

        public void setEnabled(Boolean enabled) {
            this.enabled = enabled;
        }

        public String getDisplayName() {
            return displayName;
        }

        public void setDisplayName(String displayName) {
            this.displayName = displayName;
        }

        public String getDbTableName() {
            return dbTableName;
        }

        public void setDbTableName(String dbTableName) throws CentralRepoException {
            if (!Pattern.matches(DB_NAMES_REGEX, dbTableName)) {
                throw new CentralRepoException("Invalid database table name. Name must start with a lowercase letter and can only contain lowercase letters, numbers, and '_'."); // NON-NLS
            }
            this.dbTableName = dbTableName;
        }
    }
}