https://github.com/simonkowallik/irulescan-action

:shield: irulescan-action is a static security analyzer for iRules for use with Github Actions
https://github.com/simonkowallik/irulescan-action

ci cicd devsecops f5 f5-bigip f5networks irules security security-tools

Last synced: 12 days ago
JSON representation

:shield: irulescan-action is a static security analyzer for iRules for use with Github Actions

• Host: GitHub
• URL: https://github.com/simonkowallik/irulescan-action
• Owner: simonkowallik
• License: mit
• Created: 2022-12-30T11:24:30.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-30T12:15:49.000Z (about 2 years ago)
• Last Synced: 2025-01-11T10:07:42.136Z (16 days ago)
• Topics: ci, cicd, devsecops, f5, f5-bigip, f5networks, irules, security, security-tools
• Language: Shell
• Homepage:
• Size: 6.84 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# irulescan-action

[![Functional Tests](https://github.com/simonkowallik/irulescan-action/actions/workflows/functional_tests.yaml/badge.svg)](https://github.com/simonkowallik/irulescan-action/actions/workflows/functional_tests.yaml)

This action uses [irulescan](https://github.com/simonkowallik/irulescan) to scan iRules within your repository for security issues during execution of a GitHub Actions Workflow.

This action scans all irules in the repository and returns the result of findings in YAML format. __The workflow step will not fail__ by default, hence the execution of the workflow job succeeds even when security issues are found. The goal is to provide the findings to let you choose what to do with them.

`irulescan-action` will scan files with `.tcl` and `.irule` extensions only.

## Usage

In the simplest form the below workflow scans iRules in the whole repository. Please take a look at the provided examples for more details.

```yaml

jobs:

  irulescan-action:

    runs-on: ubuntu-latest

    name: "Workflow"

    steps:

      - name: Checkout

        uses: actions/checkout@v3

      - name: Run irulescan-action

        uses: simonkowallik/irulescan-action@main

```

Some behavior can be modified, see *inputs* below.

### `inputs`

All inputs are *optional*.

- **`scandir`**: Use `scandir` to scan a custom subdirectory within the repository.

- **`expected_results_file`**: Specify a relative path to a YAML file with expected results. If the actual result of irulescan does not match the expected result, a diff will be returned and __the job step will fail__.

- **`cmd`**: Specify a custom command to execute within the container.

### `outputs`

- **`result`**: `result` will be populated with the output results. It can be accessed using `${{ steps..outputs.result }}`.

## Examples

The [`example/`](example/) folder contains example iRules and a [YAML file](examples/expected_results.yaml) with expected results.

[`.github/workflows`](.github/workflows) contains several example workflows, click on the icons below to inspect the workflow:

  

  [![Demo: Successful](https://img.shields.io/github/actions/workflow/status/simonkowallik/irulescan-action/example_success.yaml?style=for-the-badge&label=Demo%3A%20Successful)](.github/workflows/example_success.yaml)

  

  [![Demo: Failing workflow step](https://img.shields.io/github/actions/workflow/status/simonkowallik/irulescan-action/example_failure.yaml?style=for-the-badge&label=Demo%3A%20Failing%20workflow%20step)](.github/workflows/example_failure.yaml)

  

  [![Demo: Custom CMD](https://img.shields.io/github/actions/workflow/status/simonkowallik/irulescan-action/example_custom_cmd.yaml?style=for-the-badge&label=Demo%3A%20Custom%20CMD)](.github/workflows/example_custom_cmd.yaml)

  

  [![Demo: Advanced Usage](https://img.shields.io/github/actions/workflow/status/simonkowallik/irulescan-action/example_advanced.yaml?style=for-the-badge&label=Demo%3A%20Advanced%20Usage)](.github/workflows/example_advanced.yaml)