PanoptesLinter.cpp File Reference

#include "PanoptesLinter.h"
#include "Configuration.hpp"

Go to the source code of this file.

Functions
bool	FileExists (const std::string &filePath)
	Check if a file exists.
void	RemoveStringFromVector (std::vector< std::string > &vec, const std::string &str)
	Remove a string from a vector.
bool	IsStringInVector (const std::vector< std::string > &vec, const std::string &str)
	Check if a string is in a vector.
int	main (int argc, char *argv[])

Variables
std::vector< std::string >	AcceptableConfigParams
	The acceptable configuration parameters.
std::vector< std::string >	RequiredConfigParams
	The required configuration parameters.

Function Documentation

FileExists()

bool FileExists

(

const std::string &

filePath

)

Check if a file exists.

Parameters

filePath

The path to the file

Returns

True if the file exists, false otherwise

Definition at line 22 of file PanoptesLinter.cpp.

                                           {
    DWORD fileAttributes = GetFileAttributesA(filePath.c_str());
    return (fileAttributes != INVALID_FILE_ATTRIBUTES &&
        !(fileAttributes & FILE_ATTRIBUTE_DIRECTORY));
}

Referenced by main().

IsStringInVector()

bool IsStringInVector	(	const std::vector< std::string > &	vec,
		const std::string &	str
	)

Check if a string is in a vector.

Parameters

vec	The vector to check
str	The string to check

Returns

True if the string is in the vector, false otherwise

Definition at line 39 of file PanoptesLinter.cpp.

                                                                             {
    return std::find(vec.begin(), vec.end(), str) != vec.end();
}

Referenced by main().

main()

int main	(	int	argc,
		char *	argv[]
	)

Definition at line 43 of file PanoptesLinter.cpp.

                                 {
        bool goodConfig = false;
 
    if (argc < 2) {
        std::cerr << "[!] Missing configuration file path" << std::endl;
        return 1;
    }
 
    if (!FileExists(argv[1])) {
        std::cerr << "[!] Configuration file does not exist: " << argv[1] << std::endl;
        return 1;
    }
 
#pragma region Checking if the configuration file is a valid JSON file
    Configuration config = Configuration(argv[1]);
    try {
        config.IsValidJson();
    }
    catch (const nlohmann::json::parse_error& e) {
        std::cerr << "JSON parse error: " << e.what() << std::endl;
    }
    catch (const std::runtime_error& e) {
        //Checking for the error in the configuration file
        std::cerr << "[!] Error: " << e.what() << std::endl;
    }
#pragma endregion
 
#pragma region Check for unknown keys
    std::vector<std::string> keys;
    try {
        keys = config.GetJsonKeys();
    }
    catch (const std::runtime_error& e) {
        std::cerr << "[!] Error: " << e.what() << std::endl;
    }
 
    for (const auto& key : keys) {
        if (!IsStringInVector(AcceptableConfigParams, key)) {
            std::cerr << "[!] Invalid Panoptes Configuration Key: " << key << std::endl;
            goodConfig = false;
            continue;
        }
    }
 
#pragma endregion
 
#pragma region Check for required keys
    // Check for required keys
    for (const auto& key : keys) {
        if (IsStringInVector(RequiredConfigParams, key)) {
            RemoveStringFromVector(RequiredConfigParams, key);
        }
    }
 
    //Printing out the missing required keys
    if (RequiredConfigParams.size() > 0) {
        std::cerr << "[!] Missing Required Panoptes Configuration Key(s): " << std::endl;
        for (const auto& key : RequiredConfigParams) {
            std::cerr << key << std::endl;
        }
        std::cerr << std::endl;
    }
 
    if (RequiredConfigParams.size() == 0) {
        goodConfig = true;
    }
#pragma endregion
 
    end:
    if (goodConfig) {
        std::cout << "[+] Panoptes Configuration is valid" << std::endl;
    }
    else {
        std::cerr << "[!] Panoptes Configuration is invalid" << std::endl;
    }
 
}

References AcceptableConfigParams, FileExists(), Configuration::GetJsonKeys(), IsStringInVector(), Configuration::IsValidJson(), RemoveStringFromVector(), and RequiredConfigParams.

RemoveStringFromVector()

void RemoveStringFromVector	(	std::vector< std::string > &	vec,
		const std::string &	str
	)

Remove a string from a vector.

Remove a string from a vector

Parameters

vec	The vector to remove the string from
str	The string to remove

Definition at line 31 of file PanoptesLinter.cpp.

                                                                             {
    vec.erase(std::remove(vec.begin(), vec.end(), str), vec.end());
}

Referenced by main().

Variable Documentation

AcceptableConfigParams

std::vector<std::string> AcceptableConfigParams

Initial value:

= {
    "ExtensibilitySelected", 
    "Exclusions",
    "IgnoreDriver",
    "QuarantineMaliciousFiles",
    "EventProviders"
}

The acceptable configuration parameters.

Definition at line 5 of file PanoptesLinter.cpp.

                                              {
    "ExtensibilitySelected", 
    "Exclusions",
    "IgnoreDriver",
    "QuarantineMaliciousFiles",
    "EventProviders"
};

Referenced by main().

RequiredConfigParams

std::vector<std::string> RequiredConfigParams

Initial value:

= {
    "ExtensibilitySelected",
    "EventProviders"
}

The required configuration parameters.

Definition at line 14 of file PanoptesLinter.cpp.

                                            {
    "ExtensibilitySelected",
    "EventProviders"
};

Referenced by main().