RuleSetManager.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 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.modules.yara.rules;
 
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.File;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import javax.swing.SwingUtilities;
import org.sleuthkit.autopsy.coreutils.PlatformUtil;

public class RuleSetManager {
 
    private final static String BASE_FOLDER = "yara";
    private final static String RULE_SET_FOLDER = "ruleSets";

    public final static String RULE_SET_ADDED = "YARARuleSetAdded";
    public final static String RULE_SET_DELETED = "YARARuleSetDeleted";
 
    private final PropertyChangeSupport changeSupport;
 
    private static RuleSetManager instance;

    private RuleSetManager() {
        changeSupport = new PropertyChangeSupport(this);
    }

    public synchronized static RuleSetManager getInstance() {
        if (instance == null) {
            instance = new RuleSetManager();
        }
 
        return instance;
    }

    public static void addPropertyChangeListener(PropertyChangeListener listener) {
        getInstance().getChangeSupport().addPropertyChangeListener(listener);
    }

    public void removePropertyChangeListener(PropertyChangeListener listener) {
        getInstance().getChangeSupport().removePropertyChangeListener(listener);
    }

    public synchronized RuleSet createRuleSet(String name) throws RuleSetException {
        if (name == null || name.isEmpty()) {
            throw new RuleSetException("YARA rule set name cannot be null or empty string");
        }
 
        if (isRuleSetExists(name)) {
            throw new RuleSetException(String.format("Yara rule set with name %s already exits.", name));
        }
 
        Path basePath = getRuleSetPath();
        Path setPath = Paths.get(basePath.toString(), name);
 
        setPath.toFile().mkdir();
 
        RuleSet newSet = new RuleSet(name, setPath);
 
        SwingUtilities.invokeLater(new Runnable() {
            @Override
            public void run() {
                getChangeSupport().firePropertyChange(RULE_SET_ADDED, null, newSet);
            }
        });
 
        return newSet;
    }

    public synchronized void deleteRuleSet(RuleSet ruleSet) throws RuleSetException {
        if (ruleSet == null) {
            throw new RuleSetException("YARA rule set name cannot be null or empty string");
        }
 
        if (!isRuleSetExists(ruleSet.getName())) {
            throw new RuleSetException(String.format("A YARA rule set with name %s does not exits.", ruleSet.getName()));
        }
 
        deleteDirectory(ruleSet.getPath().toFile());
 
        SwingUtilities.invokeLater(new Runnable() {
            @Override
            public void run() {
                getChangeSupport().firePropertyChange(RULE_SET_DELETED, ruleSet, null);
            }
        });
    }

    public synchronized List<RuleSet> getRuleSetList() {
        List<RuleSet> ruleSets = new ArrayList<>();
        Path basePath = getRuleSetPath();
 
        String[] ruleSetNames = basePath.toFile().list();
 
        for (String setName : ruleSetNames) {
            ruleSets.add(new RuleSet(setName, Paths.get(basePath.toString(), setName)));
        }
 
        return ruleSets;
    }

    public synchronized boolean isRuleSetExists(String name) {
        Path basePath = getRuleSetPath();
        Path setPath = Paths.get(basePath.toString(), name);
 
        return setPath.toFile().exists();
    }

    private Path getRuleSetPath() {
        Path basePath = Paths.get(PlatformUtil.getUserDirectory().getAbsolutePath(), BASE_FOLDER, RULE_SET_FOLDER);
        File baseFile = basePath.toFile();
 
        if (!baseFile.exists()) {
            baseFile.mkdirs();
        }
 
        return basePath;
    }

    private PropertyChangeSupport getChangeSupport() {
        return changeSupport;
    }

    private boolean deleteDirectory(File directoryToBeDeleted) {
        File[] allContents = directoryToBeDeleted.listFiles();
        if (allContents != null) {
            for (File file : allContents) {
                deleteDirectory(file);
            }
        }
        return directoryToBeDeleted.delete();
    }
 
}