Current section
Files
Jump to
Current section
Files
doc/pest.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Module pest</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
</head>
<body bgcolor="white">
<div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<hr>
<h1>Module pest</h1>
<ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
<h3><a name="Primitive_Erlang_Security_Tool_(PEST)">Primitive Erlang Security Tool (PEST)</a></h3>.
<p><b>Version:</b> 0.3.0 Nov 11 2016 11:02:53
------------------------------------------------------------------------</p>
<h2><a name="description">Description</a></h2>
<h3><a name="Primitive_Erlang_Security_Tool_(PEST)">Primitive Erlang Security Tool (PEST)</a></h3>
<h2><a name="types">Data Types</a></h2>
<h3 class="typedecl"><a name="type-checks">checks()</a></h3>
<p><tt>checks() = [{<a href="#type-severity">severity()</a>, <a href="#type-message">message()</a>, [<a href="#type-problem">problem()</a>, ...]}, ...]</tt></p>
<h3 class="typedecl"><a name="type-file_path">file_path()</a></h3>
<p><tt>file_path() = string()</tt></p>
<h3 class="typedecl"><a name="type-function_name">function_name()</a></h3>
<p><tt>function_name() = atom()</tt></p>
<h3 class="typedecl"><a name="type-line">line()</a></h3>
<p><tt>line() = <a href="erl_anno.html#type-line">erl_anno:line()</a></tt></p>
<h3 class="typedecl"><a name="type-location">location()</a></h3>
<p><tt>location() = <a href="#type-line">line()</a> | {Function::<a href="#type-function_name">function_name()</a>, Arity::arity()}</tt></p>
<h3 class="typedecl"><a name="type-message">message()</a></h3>
<p><tt>message() = nonempty_string()</tt></p>
<h3 class="typedecl"><a name="type-options">options()</a></h3>
<p><tt>options() = [consistency_checks | {checks, <a href="#type-checks">checks()</a>} | {severity_min, <a href="#type-severity">severity()</a>} | {location, line | function} | {functions, remote | any}]</tt></p>
<h3 class="typedecl"><a name="type-problem">problem()</a></h3>
<p><tt>problem() = {Module::module(), Function::<a href="#type-function_name">function_name()</a>, Arity::arity()} | module()</tt></p>
<h3 class="typedecl"><a name="type-severity">severity()</a></h3>
<p><tt>severity() = 0..100</tt></p>
<p> 0 == low, 100 == high</p>
<h3 class="typedecl"><a name="type-warning">warning()</a></h3>
<p><tt>warning() = {<a href="#type-severity">severity()</a>, <a href="#type-message">message()</a>, #{<a href="#type-problem">problem()</a> := [<a href="#type-location">location()</a>, ...]}}</tt></p>
<h3 class="typedecl"><a name="type-warnings">warnings()</a></h3>
<p><tt>warnings() = [<a href="#type-warning">warning()</a>, ...]</tt></p>
<h2><a name="index">Function Index</a></h2>
<table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#analyze-1">analyze/1</a></td><td>
<h4><a name="Analyze_a_file.">Analyze a file.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#analyze-2">analyze/2</a></td><td>
<h4><a name="Analyze_a_file_with_options.">Analyze a file with options.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#checks-0">checks/0</a></td><td>
<h4><a name="Security_checks.">Security checks.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#checks_expand-2">checks_expand/2</a></td><td>
<h4><a name="Expand_the_existing_checks_based_on_the_provided_dependencies.">Expand the existing checks based on the provided dependencies.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#checks_expand-3">checks_expand/3</a></td><td>
<h4><a name="Expand_a_limited_number_of_existing_checks_based_on_the_provided_dependencies.">Expand a limited number of existing checks based on the provided dependencies.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#checks_merge-2">checks_merge/2</a></td><td>
<h4><a name="Merge_existing_checks.">Merge existing checks.</a></h4>.</td></tr>
<tr><td valign="top"><a href="#main-1">main/1</a></td><td>
<h4><a name="Escript_Main_Function.">Escript Main Function.</a></h4>.</td></tr>
</table>
<h2><a name="functions">Function Details</a></h2>
<h3 class="function"><a name="analyze-1">analyze/1</a></h3>
<div class="spec">
<p><tt>analyze(FilePath::<a href="#type-file_path">file_path()</a>) -> ok | {warning, <a href="#type-warnings">warnings()</a>} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Analyze_a_file.">Analyze a file.</a></h4>
</p>
<h3 class="function"><a name="analyze-2">analyze/2</a></h3>
<div class="spec">
<p><tt>analyze(FilePath::<a href="#type-file_path">file_path()</a>, Options::<a href="#type-options">options()</a>) -> ok | {warning, <a href="#type-warnings">warnings()</a>} | {error, any()}</tt><br></p>
</div><p>
<h4><a name="Analyze_a_file_with_options.">Analyze a file with options.</a></h4>
</p>
<h3 class="function"><a name="checks-0">checks/0</a></h3>
<div class="spec">
<p><tt>checks() -> <a href="#type-checks">checks()</a></tt><br></p>
</div><p>
<h4><a name="Security_checks.">Security checks.</a></h4>
</p>
<h3 class="function"><a name="checks_expand-2">checks_expand/2</a></h3>
<div class="spec">
<p><tt>checks_expand(FilePath::<a href="#type-file_path">file_path()</a>, Checks::<a href="#type-checks">checks()</a>) -> NewChecks::<a href="#type-checks">checks()</a></tt><br></p>
</div><p>
<h4><a name="Expand_the_existing_checks_based_on_the_provided_dependencies.">Expand the existing checks based on the provided dependencies.</a></h4>
</p>
<h3 class="function"><a name="checks_expand-3">checks_expand/3</a></h3>
<div class="spec">
<p><tt>checks_expand(FilePath::<a href="#type-file_path">file_path()</a>, SeverityMin::<a href="#type-severity">severity()</a>, Checks::<a href="#type-checks">checks()</a>) -> NewChecks::<a href="#type-checks">checks()</a></tt><br></p>
</div><p>
<h4><a name="Expand_a_limited_number_of_existing_checks_based_on_the_provided_dependencies.">Expand a limited number of existing checks based on the provided dependencies.</a></h4>
</p>
<h3 class="function"><a name="checks_merge-2">checks_merge/2</a></h3>
<div class="spec">
<p><tt>checks_merge(ChecksA::<a href="#type-checks">checks()</a>, ChecksB::<a href="#type-checks">checks()</a>) -> Checks::<a href="#type-checks">checks()</a></tt><br></p>
</div><p>
<h4><a name="Merge_existing_checks.">Merge existing checks.</a></h4>
</p>
<h3 class="function"><a name="main-1">main/1</a></h3>
<div class="spec">
<p><tt>main(Arguments::[string()]) -> no_return()</tt><br></p>
</div><p>
<h4><a name="Escript_Main_Function.">Escript Main Function.</a></h4>
</p>
<hr>
<div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
<p><i>Generated by EDoc, Nov 11 2016, 11:02:53.</i></p>
</body>
</html>