horusec-leaks/

README

HORUSEC-LEAKS-CLI

This is a Command Line Interface to make it search vulnerabilities of type leaks in your project. To learn more about the structure of this service you can see more in this /assets/horusec-analysis-cli.jpg.

Using with docker

To use with docker you can running this example:

    LOCAL_PROJECT_PATH="$(pwd)/horusec-leaks/examples"; \
    docker run --rm \
        -v $LOCAL_PROJECT_PATH:/src \
        horuszup/horusec-leaks:latest \
        /bin/sh -c "horusec-leaks run -p /src -o /tmp/output.json && cat /tmp/output.json"

Using locally

To use locally is necessary clone horusec in your local machine and run:

make build-install-leaks-cli

Check the installation

horusec-leaks version

Commands

The available commands to usage are:

Command	Description
run	This command start analysis with default values and in your current directory
version	You see actual version running in your local machine

Using Flags

You can pass some flags and change their values, for example:

horusec-leaks --help

All available flags are:

Flag Flag	Flag shortcut	Default Value	Description
log-level	l	info	This setting will define what level of logging I want to see. The available levels are: "panic","fatal","error","warn","info","debug","trace"
json-output-file	o	output.json	Name of the json file to save result of the analysis
project-path	p	${CURRENT_DIRECTORY}	This setting is to know if I want to change the analysis directory and do not want to run in the current directory. If this value is not passed, Horusec will ask if you want to run the analysis in the current directory. If you pass it it will start the analysis in the directory informed by you without asking anything.

Output

When you run analysis you receive this example of output

[
  {
    "ID": "3dfb3624-e218-4e2b-a7e9-814b64aaa43e",
    "Name": "HardCodedPassword",
    "Description": "Hardcoded password is an vulnerability",
    "SourceLocation": {
      "Filename": "/src/leaks-hardcodedpass/src/main.go",
      "Line": 148,
      "Column": 8
    }
  }
]

How add more rules?

To add new rules it is necessary to understand the structure of this CLI. When we start the CLI we use a base called cli_standard its goal is to have the initial commands and call the controller to the CLI in this example is the package analysis, this package will call its rules which in turn triggers all the rules that it considers necessary for this CLI.

Rules

The rules added in horusec-leaks are grouped in two places in this project which are::

• [Rules generics](/ development-kit/pkg/engines/leaks)

All rules follow a flow subdivided between the types:

• And
  • The purpose of these rules would be if all the rules exist in the analyzed file, it will be charged.
• Or
  • The purpose of these rules would be if any rule exists in the analyzed file, it will be charged
• Regular
  • The purpose of these rules would be if any rules exist in the analyzed file and have exactly what is expected, it will be charged

Example adding more rules in Leaks

To exemplify the process of how to add a new rule is quite simple. First you must create a new constructor with a very descriptive name in the file you want and started with the text NewLeaks + TypeRule + Name example NewLeaksRegularAWSManagerID, this new constructor will return a text.TextRule, then you will return it and add the new constructor to the list of rules that will be executed in the file [leaks.go](/ development-kit/pkg/engines/leaks/leaks.go).

In this builder's content add:

    Metadata.ID: "text type field preferred a UUID v4"
    Metadata.Name: "descriptive name of the vulnerability"
    Metadata.Description: "brief description of the vulnerability and if possible add a reference to the CWE that it fits"
    Metadata.Severity: "using the severity enum rate how critical this vulnerability is"
    Metadata.Confidence: "using the confidence enum classify how assertive this vulnerability is"
    Type: "classify the type of this vulnerability according to the package"
    Expressions: "List of regular expressions you want to add if the vulnerability exists in the analyzed file"

regular.go

...
func NewLeaksRegularAWSManagerID() text.TextRule {
	return text.TextRule{
		Metadata: engine.Metadata{
			ID:          "18332543-1ec3-47c7-b064-2a159359bc73",
			Name:        "AWS Manager ID",
			Description: "When use AWS Manager ID is recommended use vault or environment variable encrypted for the best security. For more information checkout the CWE-798 (https://cwe.mitre.org/data/definitions/798.html) advisory.",
			Severity:    severity.High.ToString(),
			Confidence:  confidence.Medium.ToString(),
		},
		Type: text.Regular,
		Expressions: []*regexp.Regexp{
			regexp.MustCompile(`(A3T[A-Z0-9]|AKIA|AGPA|AIDA|AROA|AIPA|ANPA|ANVA|ASIA)[A-Z0-9]{16}`),
		},
	}
}

leaks.go

...
func AllRulesLeaksRegular() []text.TextRule {
    return []text.TextRule{
        ...
        regular.NewLeaksRegularAWSManagerID(),
    }
}
...

Finally check if all tests have passed and if possible add a unit test within [leaks_test.go](/ development-kit/pkg/engines/leaks/leaks_test.go) exemplifying the scenario that this new rule would apply.