Skip to content

Commit

Permalink
doc: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
simonkowallik committed Dec 31, 2022
1 parent 1c94d74 commit 141629f
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,15 @@
[![Test Build](https://github.com/simonkowallik/irulescan/actions/workflows/test.yaml/badge.svg)](https://github.com/simonkowallik/irulescan/actions/workflows/test.yaml)
![Docker Image Size (latest by date)](https://img.shields.io/docker/image-size/simonkowallik/irulescan)


`irulescan` is a tool to scan iRules for unexpected/unsafe expressions that may have undesirable effects like double substitution.
`irulescan` is a tool to scan iRules for unexpected/unsafe expressions that may have undesirable effects like double substitution. It is available as a Github Action [`irulescan-action`](https://github.com/marketplace/actions/irules-security-scan).

`irulescan` would not exist without [tclscan](https://github.com/aidanhs/tclscan).

## Usage

It is easiest to use the irulescan container to scan any irules.
It is easiest to use the irulescan container to scan your irules.

By default the container will scan any `.tcl` and `.irule` file within the `/scandir` folder of the container.
The container will scan any `.tcl` and `.irule` file within the `/scandir` folder of the container and return the result in YAML format.

Here is an example:

Expand Down Expand Up @@ -44,4 +43,21 @@ Invoking irulescan directly:

```sh
docker run -it --rm simonkowallik/irulescan irulescan
```
```

The container ships with a simple shell script, `scandir.sh`, which can be invoked directly.
This is especially useful when using a CI system with custom mount points (eg. `/my/custom/path`), here is an example:

```sh
docker run -it --rm simonkowallik/irulescan /scandir.sh /my/custom/path
```

## Additional resources

For safer authoring the VS Code iRules Extension is highly recommended:

- [F5 Networks iRules by bitwisecook](https://marketplace.visualstudio.com/items?itemName=bitwisecook.iRule) [on github](https://github.com/bitwisecook/vscode-iRule)

- [Avoiding Common iRules Security Pitfalls on F5 DevCentral](https://community.f5.com/t5/technical-articles/avoiding-common-irules-security-pitfalls/ta-p/306623)

- [iRules Style Guide on F5 DevCentral](https://community.f5.com/t5/technical-articles/irules-style-guide/ta-p/305921)

0 comments on commit 141629f

Please sign in to comment.