OsAccountDataPanel.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2021 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.contentviewers.osaccount;

import java.awt.BorderLayout;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import static java.util.Locale.US;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.ExecutionException;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.swing.Box;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.SwingWorker;
import javax.swing.border.EmptyBorder;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.contentviewers.layout.ContentViewerDefaults;
import org.sleuthkit.autopsy.contentviewers.osaccount.SectionData.RowData;
import org.sleuthkit.autopsy.coreutils.TimeZoneUtils;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.DataSource;
import org.sleuthkit.datamodel.Host;
import org.sleuthkit.datamodel.OsAccount;
import org.sleuthkit.datamodel.OsAccount.OsAccountAttribute;
import org.sleuthkit.datamodel.OsAccountInstance;
import org.sleuthkit.datamodel.OsAccountManager;
import org.sleuthkit.datamodel.OsAccountRealm;
import org.sleuthkit.datamodel.SleuthkitCase;

public class OsAccountDataPanel extends JPanel {

    private static final long serialVersionUID = 1L;
    final private static Logger logger = Logger.getLogger(OsAccountDataPanel.class.getName());

    private static final int KEY_COLUMN = 0;
    private static final int VALUE_COLUMN = 1;
    
    private final static Insets FIRST_HEADER_INSETS = new Insets(0, 0, 0, 0);
    private final static Insets HEADER_INSETS = new Insets(ContentViewerDefaults.getSectionSpacing(), 0, ContentViewerDefaults.getLineSpacing(), 0);
    private final static Insets VALUE_COLUMN_INSETS = new Insets(0, ContentViewerDefaults.getColumnSpacing(), ContentViewerDefaults.getLineSpacing(), 0);
    private final static Insets KEY_COLUMN_INSETS = new Insets(0, ContentViewerDefaults.getSectionIndent(), ContentViewerDefaults.getLineSpacing(), 0);
    private static final SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("MMM dd yyyy", US);

    private PanelDataFetcher dataFetcher = null;

    // Panel constructor.
    OsAccountDataPanel() {
        initialize();
    }

    private void initialize() {
        this.setLayout(new GridBagLayout());
        this.setBorder(new EmptyBorder(ContentViewerDefaults.getPanelInsets()));
    }

    void setOsAccountId(Long osAccountId) {
        removeAll();
        revalidate();

        if (osAccountId != null) {
            setLayout(new BorderLayout());
            add(new JLabel("Loading OsAccount Data..."), BorderLayout.NORTH);

            if (dataFetcher != null && !dataFetcher.isDone()) {
                dataFetcher.cancel(true);
            }

            dataFetcher = new PanelDataFetcher(osAccountId);
            dataFetcher.execute();
        }
    }
    
    void setOsAccount(OsAccount account) {
        removeAll();
        revalidate();

        if (account != null) {
            setLayout(new BorderLayout());
            add(new JLabel("Loading OsAccount Data..."), BorderLayout.NORTH);

            if (dataFetcher != null && !dataFetcher.isDone()) {
                dataFetcher.cancel(true);
            }

            dataFetcher = new PanelDataFetcher(account);
            dataFetcher.execute();
        }
    }

    private void addDataComponents(List<SectionData> panelData) {
        int rowCnt = 0;
        for (SectionData section : panelData) {
            addTitle(section.getTitle(), rowCnt++);

            for (RowData<String, String> rowData : section) {
                String key = rowData.getKey();
                String value = rowData.getValue();

                addPropertyName(key, rowCnt);
                addPropertyValue(value, rowCnt++);
            }
        }

        // Generate the constraints for a Vertical Glue to fill the space, if
        // any at the bottom of the panel.
        GridBagConstraints constraints = new GridBagConstraints();
        constraints.gridx = 0;
        constraints.gridy = rowCnt;
        constraints.gridwidth = 2;
        constraints.fill = GridBagConstraints.BOTH;
        constraints.weightx = 1;
        constraints.weighty = 1;
        add(Box.createVerticalGlue(), constraints);
    }

    @Messages({
        "OsAccountDataPanel_basic_title=Basic Properties",
        "OsAccountDataPanel_basic_login=Login",
        "OsAccountDataPanel_basic_fullname=Full Name",
        "OsAccountDataPanel_basic_address=Address",
        "OsAccountDataPanel_basic_admin=Administrator",
        "OsAccountDataPanel_basic_type=Type",
        "OsAccountDataPanel_basic_creationDate=Creation Date",})

    private SectionData buildBasicProperties(OsAccount account) {
        SectionData data = new SectionData(Bundle.OsAccountDataPanel_basic_title());

        Optional<String> optional = account.getLoginName();
        data.addData(Bundle.OsAccountDataPanel_basic_login(),
                optional.isPresent() ? optional.get() : "");

        optional = account.getFullName();
        data.addData(Bundle.OsAccountDataPanel_basic_fullname(),
                optional.isPresent() ? optional.get() : "");

        data.addData(Bundle.OsAccountDataPanel_basic_address(),
                account.getName() == null || account.getName().isEmpty() ? "" : account.getName());

        
        data.addData(Bundle.OsAccountDataPanel_basic_type(), 
            account.getOsAccountType().isPresent() ? account.getOsAccountType().get().getName() : "");

        Optional<Long> crTime = account.getCreationTime();        
        data.addData(Bundle.OsAccountDataPanel_basic_creationDate(), crTime.isPresent() ? TimeZoneUtils.getFormattedTime(crTime.get()) : "");

        return data;
    }

    @Messages({
        "OsAccountDataPanel_realm_title=Realm Properties",
        "OsAccountDataPanel_realm_name=Name",
        "OsAccountDataPanel_realm_address=Address",
        "OsAccountDataPanel_realm_confidence=Confidence",
        "OsAccountDataPanel_realm_unknown=Unknown",
        "OsAccountDataPanel_realm_scope=Scope",})

    private SectionData buildRealmProperties(OsAccountRealm realm) {
        SectionData data = new SectionData(Bundle.OsAccountDataPanel_realm_title());

        String realmName = realm.getRealmNames().isEmpty() ?  Bundle.OsAccountDataPanel_realm_unknown() :  realm.getRealmNames().get(0);
        data.addData(Bundle.OsAccountDataPanel_realm_name(), realmName);

         Optional<String> optional = realm.getRealmAddr();
        data.addData(Bundle.OsAccountDataPanel_realm_address(),
                optional.isPresent() ? optional.get() : "");

        data.addData(Bundle.OsAccountDataPanel_realm_scope(),
                realm.getScope().getName());

        data.addData(Bundle.OsAccountDataPanel_realm_confidence(),
                realm.getScopeConfidence().getName());

        return data;
    }

    @Messages({
        "# {0} - hostName",
        "OsAccountDataPanel_host_section_title={0} Details",
        "OsAccountDataPanel_host_count_title=Login Count",
        "OsAccountDataPanel_data_accessed_title=Last Login",
        "OsAccountDataPanel_administrator_title=Administrator"
    })
    private SectionData buildHostData(Host host, List<OsAccountAttribute> attributeList) {
        SectionData data = new SectionData(Bundle.OsAccountDataPanel_host_section_title(host.getName()));
        for (OsAccountAttribute attribute : attributeList) {
            String displayName = attribute.getAttributeType().getDisplayName();
            String value = attribute.getDisplayString();
            
            if(attribute.getAttributeType().getTypeID() == BlackboardAttribute.ATTRIBUTE_TYPE.TSK_COUNT.getTypeID()) {
                displayName = Bundle.OsAccountDataPanel_host_count_title();
            } else if(attribute.getAttributeType().getTypeID() == BlackboardAttribute.ATTRIBUTE_TYPE.TSK_IS_ADMIN.getTypeID()) {
                displayName = Bundle.OsAccountDataPanel_administrator_title();
                if(attribute.getValueInt() == 0) {
                    value = "False";
                } else {
                    value = "True";
                }
            } else if(attribute.getAttributeType().getTypeID() == BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_ACCESSED.getTypeID()) {
                displayName = Bundle.OsAccountDataPanel_data_accessed_title();
            }
            
            data.addData(displayName, value);
        }

        return data;
    }

    private void addTitle(String title, int row) {
        JLabel label = new JLabel(title);
        // Make the title bold.
        label.setFont(ContentViewerDefaults.getHeaderFont());
        add(label, getTitleContraints(row));
    }

    private void addPropertyName(String key, int row) {
        JLabel label = new JLabel(key + ":");
        add(label, getPropertyNameContraints(row));
    }

    private void addPropertyValue(String value, int row) {
        JLabel label = new JLabel(value);
        add(label, getPropertyValueContraints(row));
    }

    private GridBagConstraints getTitleContraints(int row) {
        GridBagConstraints constraints = new GridBagConstraints();

        constraints.gridx = 0;
        constraints.gridy = row;
        constraints.gridwidth = 2; // The title goes across the other columns
        constraints.gridheight = 1;
        constraints.anchor = GridBagConstraints.NORTHWEST;
        constraints.fill = GridBagConstraints.HORIZONTAL;
        constraints.weightx = 1;
        constraints.insets = (row == 0)
                ? FIRST_HEADER_INSETS 
                : HEADER_INSETS;

        return constraints;
    }

    private GridBagConstraints getPropertyNameContraints(int row) {
        GridBagConstraints constraints = new GridBagConstraints();

        constraints.gridx = KEY_COLUMN;
        constraints.gridy = row;
        constraints.gridwidth = 1; // The title goes across the other columns
        constraints.gridheight = 1;
        constraints.anchor = GridBagConstraints.WEST;
        constraints.insets = KEY_COLUMN_INSETS;

        return constraints;
    }

    private GridBagConstraints getPropertyValueContraints(int row) {
        GridBagConstraints constraints = new GridBagConstraints();

        constraints.gridx = VALUE_COLUMN;
        constraints.gridy = row;
        constraints.gridwidth = 1; // The title goes across the other columns
        constraints.gridheight = 1;
        constraints.fill = GridBagConstraints.HORIZONTAL;
        constraints.insets = VALUE_COLUMN_INSETS;
        constraints.weightx = 1;

        return constraints;
    }

    private class PanelDataFetcher extends SwingWorker<WorkerResults, Void> {

        private final Long accountId;
        private OsAccount account;

        PanelDataFetcher(Long accountId) {
            this.accountId = accountId;
            this.account = null;
        }
        
        PanelDataFetcher(OsAccount account) {
            this.account = account;
            this.accountId = null;
        }

        @Override
        protected WorkerResults doInBackground() throws Exception {
            Map<Host, List<OsAccountAttribute>> hostMap = new HashMap<>();
            Map<Host, DataSource> instanceMap = new HashMap<>();
            SleuthkitCase skCase = Case.getCurrentCase().getSleuthkitCase();
            OsAccountManager osAccountManager = skCase.getOsAccountManager();
            
            if(account == null) {
                account = osAccountManager.getOsAccountByObjectId(accountId);
            }
            
            OsAccountRealm realm = skCase.getOsAccountRealmManager().getRealmByRealmId(account.getRealmId());
            
            List<Host> hosts = osAccountManager.getHosts(account);
            List<OsAccountAttribute> attributeList = account.getExtendedOsAccountAttributes();

            if (attributeList != null) {
                if (hosts != null) {
                    // Organize the attributes by hostId
                    Map<Long, List<OsAccountAttribute>> idMap = new HashMap<>();
                    for (OsAccountAttribute attribute : attributeList) {
                        List<OsAccountAttribute> atList = null;
                        Optional<Long> optionalId = attribute.getHostId();
                        Long key = null;
                        if (optionalId.isPresent()) {
                            key = optionalId.get();
                        }

                        atList = idMap.get(key);

                        if (atList == null) {
                            atList = new ArrayList<>();
                            idMap.put(key, atList);
                        }

                        atList.add(attribute);
                    }

                    // Add attribute lists to the hostMap 
                    for (Host host : hosts) {
                        List<OsAccountAttribute> atList = idMap.get(host.getHostId());
                        if (atList != null) {
                            hostMap.put(host, atList);
                        }

                    }
                    List<OsAccountAttribute> atList = idMap.get(null);
                    if (atList != null) {
                        hostMap.put(null, atList);
                    }

                    // Store both the host and the dataSource so that we get
                    // all of the calls to the db done in the thread.
                    for (OsAccountInstance instance : account.getOsAccountInstances()) {
                        instanceMap.put(instance.getDataSource().getHost(), instance.getDataSource());
                    }

                } else {
                    hostMap.put(null, attributeList);
                }
            }

            return new WorkerResults(hostMap, instanceMap, realm);
        }

        @Override
        protected void done() {
            WorkerResults results = null;

            try {
                if (this.isCancelled()) {
                    return;
                } else {
                    results = get();
                }
            } catch (ExecutionException | InterruptedException ex) {
                logger.log(Level.SEVERE, String.format("Failed to retrieve data for OsAccount (%d)", account.getId()), ex);
            }

            if (results != null) {
                removeAll();
                setLayout(new GridBagLayout());

                List<SectionData> data = new ArrayList<>();
                data.add(buildBasicProperties(account));
                Map<Host, List<OsAccountAttribute>> hostDataMap = results.getAttributeMap();
                if (hostDataMap != null && !hostDataMap.isEmpty()) {
                    hostDataMap.forEach((K, V) -> data.add(buildHostData(K, V)));
                }

                OsAccountRealm realm = results.getRealm();
                if (realm != null) {
                    data.add(buildRealmProperties(realm));
                }

//                Removing the instance section for now.  Leaving code here for 
//                future use.                 
//                Map<Host, DataSource> instanceMap = results.getDataSourceMap();
//                if (!instanceMap.isEmpty()) {
//                    SectionData instanceSection = new SectionData("Instances");
//                    instanceMap.forEach((K, V) -> instanceSection.addData(K.getName(), V.getName()));
//
//                    data.add(instanceSection);
//                }
                
                addDataComponents(data);

                revalidate();
                repaint();
            }
        }
    }

    private final class WorkerResults {

        private final Map<Host, List<OsAccountAttribute>> attributeMap;
        private final Map<Host, DataSource> instanceMap;
        private final OsAccountRealm realm;

        WorkerResults(Map<Host, List<OsAccountAttribute>> attributeMap, Map<Host, DataSource> instanceMap, OsAccountRealm realm) {
            this.attributeMap = attributeMap;
            this.instanceMap = instanceMap;
            this.realm = realm;
        }

        Map<Host, List<OsAccountAttribute>> getAttributeMap() {
            return attributeMap;
        }

        Map<Host, DataSource> getDataSourceMap() {
            return instanceMap;
        }
        
        OsAccountRealm getRealm() {
            return realm;
        }
    }
}