Types.cs

// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License.

using Newtonsoft.Json;
using Newtonsoft.Json.Converters;

namespace Microsoft.CST.AttackSurfaceAnalyzer.Types
{
    /// <summary>
    ///     From https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.addressfamily?view=netcore-3.1
    /// </summary>
    [JsonConverter(typeof(StringEnumConverter))]
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1069:Enums values should not be duplicated", Justification = "See documentation in comment.")]
    public enum ADDRESS_FAMILY
    {
        AppleTalk = 16,
        Atm = 22,
        Banyan = 21,
        Ccitt = 10,
        Chaos = 5,
        Cluster = 24,
        ControllerAreaNetwork = 65537,
        DataKits = 9,
        DataLink = 13,
        DecNet = 12,
        Ecma = 8,
        FireFox = 19,
        HyperChannel = 15,
        Ieee12844 = 25,
        ImpLink = 3,
        InterNetwork = 2,
        InterNetworkV6 = 23,
        Ipx = 6,
        Irda = 26,
        Iso = 7,
        Lat = 14,
        Max = 29,
        NetBios = 17,
        NetworkDesigners = 28,
        NS = 6,
        Osi = 7,
        Packet = 65536,
        Pup = 4,
        Sna = 11,
        Unix = 1,
        Unknown = -1,
        Unspecified = 0,
        VoiceView = 18
    }

    /// <summary>
    ///     Flags available for analysis rules.
    /// </summary>
    [JsonConverter(typeof(StringEnumConverter))] 
    public enum ANALYSIS_RESULT_TYPE
    {
        /// <summary>
        ///     Lowest Level - 0
        /// </summary>
        NONE,

        /// <summary>
        ///     1
        /// </summary>
        VERBOSE,

        /// <summary>
        ///     2
        /// </summary>
        DEBUG,

        /// <summary>
        ///     3
        /// </summary>
        INFORMATION,

        /// <summary>
        ///     4
        /// </summary>
        WARNING,

        /// <summary>
        ///     5
        /// </summary>
        ERROR,

        /// <summary>
        ///     6 - Highest level
        /// </summary>
        FATAL
    }

    /// <summary>
    ///     Errors enum.
    /// </summary>
    [JsonConverter(typeof(StringEnumConverter))]
    public enum ASA_ERROR
    {
        NONE,
        UNIQUE_ID,
        INVALID_PATH,
        ALREADY_RUNNING,
        NO_COLLECTORS,
        MATCHING_SCHEMA,
        FAILED_TO_CREATE_DATABASE,
        INVALID_ID,
        INVALID_RULES,
        FAILED_TO_ESTABLISH_MAIN_DB_CONNECTION,
        UNKNOWN,
        CANCELLED,
        FAILED_TO_COMMIT,
        DATABASE_NULL,
        FAILED_TO_LOCATE_GUI_ASSETS
    }

    /// <summary>
    ///     The change type of a CompareResult object.
    /// </summary>
    [JsonConverter(typeof(StringEnumConverter))]
    public enum CHANGE_TYPE
    {
        INVALID,
        CREATED,
        DELETED,
        MODIFIED,
        RENAMED
    }

    /// <summary>
    ///     These are the characteristics defined in the PE Header for Windows executables. See
    ///     https://docs.microsoft.com/en-us/windows/win32/debug/pe-format for the oracle definitions of these values
    /// </summary>
    [System.Diagnostics.CodeAnalysis.SuppressMessage("Naming", "CA1717:Only FlagsAttribute enums should have plural names", Justification = "This is the official name for the enum.")]
    [JsonConverter(typeof(StringEnumConverter))]
    public enum DLLCHARACTERISTICS
    {
        /// <summary>
        ///     64 Bit ASLR
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_HIGH_ENTROPY_VA = 0x0020,

        /// <summary>
        ///     ASLR
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_DYNAMIC_BASE = 0x0040,

        /// <summary>
        ///     Don't run unless properly signed
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_FORCE_INTEGRITY = 0x0080,

        /// <summary>
        ///     DEP
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_NX_COMPAT = 0x0100,

        /// <summary>
        ///     No Isolation
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_NO_ISOLATION = 0x0200,

        /// <summary>
        ///     No Exceptions
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_NO_SEH = 0x0400,

        /// <summary>
        ///     Do not bind the image
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_NO_BIND = 0x0800,

        /// <summary>
        ///     Must execute in an app container
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_APPCONTAINER = 0x1000,

        /// <summary>
        ///     Image is a WDM driver
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_WDM_DRIVER = 0x2000,

        /// <summary>
        ///     Supports Control Flow Guard
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_GUARD_CF = 0x4000,

        /// <summary>
        ///     Image is terminal server aware
        /// </summary>
        IMAGE_DLLCHARACTERISTICS_TERMINAL_SERVER_AWARE = 0x8000
    }

    /// <summary>
    /// </summary>
    [JsonConverter(typeof(StringEnumConverter))]
    public enum EXECUTABLE_TYPE
    {
        UNKNOWN,
        WINDOWS,
        MACOS,
        LINUX,
        NONE,
        JAVA
    }

    /// <summary>
    ///     Platform definitions for Analysis rules.
    /// </summary>
    [JsonConverter(typeof(StringEnumConverter))]
    public enum PLATFORM
    {
        WINDOWS,
        LINUX,
        MACOS,
        UNKNOWN
    }

    /// <summary>
    ///     Specifies the child class type for a CollectObject
    /// </summary>
    [JsonConverter(typeof(StringEnumConverter))]
    public enum RESULT_TYPE
    {
        /// <summary>
        ///     Indicates an Invalid CollectObject
        /// </summary>
        UNKNOWN,

        /// <summary>
        ///     See FileSystemObject
        /// </summary>
        FILE,

        /// <summary>
        ///     See OpenPortObject
        /// </summary>
        PORT,

        /// <summary>
        ///     See RegistryObject
        /// </summary>
        REGISTRY,

        /// <summary>
        ///     See CertificateObject
        /// </summary>
        CERTIFICATE,

        /// <summary>
        ///     See ServiceObject
        /// </summary>
        SERVICE,

        /// <summary>
        ///     See UserAccountObject
        /// </summary>
        USER,

        /// <summary>
        ///     See UserGroupObject
        /// </summary>
        GROUP,

        /// <summary>
        ///     See FirewallObject
        /// </summary>
        FIREWALL,

        /// <summary>
        ///     See ComObject
        /// </summary>
        COM,

        /// <summary>
        ///     See EventLogObject
        /// </summary>
        LOG,

        /// <summary>
        ///     See FileMonitorObject
        /// </summary>
        FILEMONITOR,

        /// <summary>
        ///     A TPM Device
        /// </summary>
        TPM,

        /// <summary>
        ///     A cryptographic key
        /// </summary>
        KEY,

        /// <summary>
        ///     A process running on the system
        /// </summary>
        PROCESS,

        /// <summary>
        ///     A driver
        /// </summary>
        DRIVER,

        /// <summary>
        ///     A wifi network
        /// </summary>
        WIFI
    };

    /// <summary>
    ///     The running status of a Comparator or Collector
    /// </summary>
    [JsonConverter(typeof(StringEnumConverter))]
    public enum RUN_STATUS
    {
        NOT_STARTED,
        RUNNING,
        FAILED,
        COMPLETED,
        NO_RESULTS
    }

    [JsonConverter(typeof(StringEnumConverter))]
    public enum RUN_TYPE
    {
        COLLECT,
        MONITOR,
        COMPARE
    }

    [JsonConverter(typeof(StringEnumConverter))]
    public enum TRANSPORT
    {
        UNKNOWN,
        TCP,
        UDP
    }
}