Module pest

Primitive Erlang Security Tool (PEST)

.

Version: 0.7.0 Dec 15 2018 22:36:57 ------------------------------------------------------------------------

Description

Primitive Erlang Security Tool (PEST)

Data Types

checks()

checks() = [{severity(), message(), [problem(), ...]}, ...]

file_path()

file_path() = string()

function_name()

function_name() = atom()

line()

line() = erl_anno:line()

location()

location() = line() | {Function::function_name(), Arity::arity()}

message()

message() = nonempty_string()

options()

options() = [consistency_checks | {checks, checks()} | {severity_min, severity()} | {location, line | function} | {functions, remote | any}]

problem()

problem() = {Module::module(), Function::function_name(), Arity::arity()} | module()

severity()

severity() = 0..100

0 == low, 100 == high

warning()

warning() = {severity(), message(), #{problem() := [location(), ...]}}

warnings()

warnings() = [warning(), ...]

Function Index

analyze/1

Analyze a file.

.
analyze/2

Analyze a file with options.

.
checks/0

Security checks.

.
checks_expand/2

Expand the existing checks based on the provided dependencies.

.
checks_expand/3

Expand a limited number of existing checks based on the provided dependencies.

.
checks_merge/2

Merge existing checks.

.
main/1

Escript Main Function.

.

Function Details

analyze/1

analyze(FilePath::file_path()) -> ok | {warning, warnings()} | {error, any()}

Analyze a file.

analyze/2

analyze(FilePath::file_path(), Options::options()) -> ok | {warning, warnings()} | {error, any()}

Analyze a file with options.

checks/0

checks() -> checks()

Security checks.

checks_expand/2

checks_expand(FilePath::file_path(), Checks::checks()) -> NewChecks::checks()

Expand the existing checks based on the provided dependencies.

checks_expand/3

checks_expand(FilePath::file_path(), SeverityMin::severity(), Checks::checks()) -> NewChecks::checks()

Expand a limited number of existing checks based on the provided dependencies.

checks_merge/2

checks_merge(ChecksA::checks(), ChecksB::checks()) -> Checks::checks()

Merge existing checks.

main/1

main(Arguments::[string()]) -> no_return()

Escript Main Function.


Generated by EDoc