MixAudit

https://hexdocs.pm/mix_audit/
Admin
MixAudit provides a mix deps.audit task to scan Mix dependencies for security vulnerabilities,...
Tokens:1,857
Snippets:24
Trust Score:9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install MixAudit as Global escript

Source: https://hexdocs.pm/mix_audit/index.html

Install `mix_audit` as a global escript if you prefer not to include it in project dependencies. This allows you to use the `mix_audit` executable directly.

```bash
$ mix escript.install hex mix_audit
…
* creating …/.mix/escripts/mix_audit
```

--------------------------------

### MixAudit CLI - Run Function

Source: https://hexdocs.pm/mix_audit/MixAudit.CLI.Help.html

The `run/1` function is the primary entry point for executing MixAudit with specified options.

```APIDOC
## MixAudit.CLI.Help run(opts)

### Description
Executes the MixAudit with the provided options.

### Method
CLI Command

### Endpoint
mix audit run

### Parameters
#### Query Parameters
- **opts** (keyword list) - Required - A list of keyword options to configure the audit.

### Request Example
```elixir
mix audit run --verbose --format json
```

### Response
#### Success Response (0)
- **Output** (string) - The audit results in the specified format.

#### Response Example
```json
{
  "audit_results": [
    {
      "module": "ExampleModule",
      "function": "example_function",
      "line": 10,
      "message": "Potential issue found."
    }
  ]
}
```
```

--------------------------------

### MixAudit run function

Source: https://hexdocs.pm/mix_audit/MixAudit.CLI.Version.html

The `run` function is the primary entry point for executing MixAudit with specified options.

```APIDOC
## MixAudit.run

### Description
Executes MixAudit with the provided options.

### Method
N/A (Function call)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **opts** (keyword list) - Required - A list of options to configure the execution of MixAudit.
```

--------------------------------

### run(opts)

Source: https://hexdocs.pm/mix_audit/MixAudit.CLI.Audit.html

Executes the audit process based on the provided options.

```APIDOC
## run(opts)

### Description
Executes the audit process for the project dependencies based on the provided options.

### Parameters
- **opts** (map) - Required - Configuration options for the audit process.
```

--------------------------------

### version()

Source: https://hexdocs.pm/mix_audit/MixAudit.html

Retrieves the current version of the MixAudit library.

```APIDOC
## version()

### Description
Returns the current version string of the MixAudit library (v2.1.5).

### Response
- **version** (string) - The version number of the library.
```

--------------------------------

### dependencies(path)

Source: https://hexdocs.pm/mix_audit/MixAudit.Project.html

Retrieves the dependencies for a project located at the specified path.

```APIDOC
## dependencies(path)

### Description
Retrieves the dependencies for a project located at the specified path.

### Parameters
- **path** (String) - Required - The file system path to the project directory.
```

--------------------------------

### Run MixAudit Security Scan

Source: https://hexdocs.pm/mix_audit/index.html

Execute the `mix deps.audit` task to generate a security report for your project's dependencies. The task exits with status 0 if no vulnerabilities are found, and 1 otherwise.

```bash
$ mix deps.audit
```

--------------------------------

### MixAudit.CLI - run function

Source: https://hexdocs.pm/mix_audit/MixAudit.CLI.html

The 'run' function is the primary interface for executing MixAudit commands.

```APIDOC
## run(args)

### Description
Executes MixAudit with the provided arguments.

### Method
CLI Command

### Endpoint
N/A (CLI command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
mix audit run --option1 value1 --option2 value2
```

### Response
#### Success Response (0)
- **output** (string) - The standard output from the MixAudit execution.

#### Response Example
```json
{
  "output": "Audit completed successfully."
}
```

#### Error Response (Non-zero exit code)
- **error** (string) - A message describing the error encountered during execution.
```

--------------------------------

### MixAudit CLI Version

Source: https://hexdocs.pm/mix_audit/MixAudit.CLI.Version.html

Displays the current version of the MixAudit CLI.

```APIDOC
## MixAudit.CLI.Version

### Description
Displays the current version of the MixAudit CLI.

### Version
v2.1.5
```

--------------------------------

### ignored_advisory_ids_from_file(opts)

Source: https://hexdocs.pm/mix_audit/MixAudit.CLI.Audit.html

Retrieves a list of ignored advisory IDs from a specified configuration file.

```APIDOC
## ignored_advisory_ids_from_file(opts)

### Description
Reads and parses ignored advisory IDs from a file defined within the options.

### Parameters
- **opts** (map) - Required - Configuration options containing the file path for ignored advisories.
```

--------------------------------

### advisories()

Source: https://hexdocs.pm/mix_audit/MixAudit.Repo.html

Retrieves a list of advisories from the repository.

```APIDOC
## advisories()

### Description
Retrieves the list of advisories managed by the MixAudit.Repo.

### Response
- **Returns** (List) - A list of advisory records.
```

--------------------------------

### Add MixAudit as Project Dependency

Source: https://hexdocs.pm/mix_audit/index.html

Include `mix_audit` in your project's `mix.exs` file for development and testing. Ensure to run `mix deps.get` and `mix deps.compile` afterwards.

```elixir
defp deps do
  [
    {:mix_audit, "~> 2.1", only: [:dev, :test], runtime: false}
  ]
end
```

--------------------------------

### mix deps.audit

Source: https://hexdocs.pm/mix_audit/Mix.Tasks.Deps.Audit.html

Executes a security scan on project dependencies to identify known vulnerabilities.

```APIDOC
## MIX TASK: mix deps.audit

### Description
Scans project dependencies for security vulnerabilities using the mix_audit library.

### Usage
`mix deps.audit [options]`

### Options
- `--help` - Displays help information and available options for the task.
```

--------------------------------

### MixAudit.Formatting.format

Source: https://hexdocs.pm/mix_audit/MixAudit.Formatting.html

Formats a report according to the specified format.

```APIDOC
## MixAudit.Formatting.format

### Description
Formats a given report into a specified format.

### Function Signature
`format(report, format)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "report": "Your report data here",
  "format": "json"
}
```

### Response
#### Success Response (200)
- **formatted_report** (string) - The report formatted according to the specified format.

#### Response Example
```json
{
  "formatted_report": "{\"key\": \"value\"}"
}
```
```

--------------------------------

### format/1

Source: https://hexdocs.pm/mix_audit/MixAudit.Formatting.Human.html

Formats a given audit report into a human-readable string representation.

```APIDOC
## format(report)

### Description
Formats the provided audit report into a human-readable format.

### Parameters
- **report** (any) - Required - The audit report data structure to be formatted.
```

--------------------------------

### format(report)

Source: https://hexdocs.pm/mix_audit/MixAudit.Formatting.JSON.html

Formats a given audit report into a JSON structure.

```APIDOC
## format(report)

### Description
Formats the provided audit report into a JSON representation.

### Parameters
- **report** (any) - Required - The audit report data to be formatted.
```

--------------------------------

### MixAudit Report Function

Source: https://hexdocs.pm/mix_audit/MixAudit.Audit.html

The report function generates an audit report. It takes dependencies and advisories as input.

```APIDOC
## MixAudit.Audit: report/2

### Description
Generates an audit report based on provided dependencies and advisories.

### Function Signature
report(dependencies, advisories)

### Parameters
#### Arguments
- **dependencies** (list) - A list of project dependencies.
- **advisories** (list) - A list of security advisories.

### Returns
- (map) - A map containing the audit report details.
```
Tokens:
Raw