You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert

5
5
6
-
7
-
`irulescan` is a tool to scan iRules for unexpected/unsafe expressions that may have undesirable effects like double substitution.
6
+
`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).
8
7
9
8
`irulescan` would not exist without [tclscan](https://github.com/aidanhs/tclscan).
10
9
11
10
## Usage
12
11
13
-
It is easiest to use the irulescan container to scan any irules.
12
+
It is easiest to use the irulescan container to scan your irules.
14
13
15
-
By default the container will scan any `.tcl` and `.irule` file within the `/scandir` folder of the container.
14
+
The container will scan any `.tcl` and `.irule` file within the `/scandir` folder of the container and return the result in YAML format.
16
15
17
16
Here is an example:
18
17
@@ -44,4 +43,21 @@ Invoking irulescan directly:
44
43
45
44
```sh
46
45
docker run -it --rm simonkowallik/irulescan irulescan
47
-
```
46
+
```
47
+
48
+
The container ships with a simple shell script, `scandir.sh`, which can be invoked directly.
49
+
This is especially useful when using a CI system with custom mount points (eg. `/my/custom/path`), here is an example:
50
+
51
+
```sh
52
+
docker run -it --rm simonkowallik/irulescan /scandir.sh /my/custom/path
53
+
```
54
+
55
+
## Additional resources
56
+
57
+
For safer authoring the VS Code iRules Extension is highly recommended:
58
+
59
+
-[F5 Networks iRules by bitwisecook](https://marketplace.visualstudio.com/items?itemName=bitwisecook.iRule)[on github](https://github.com/bitwisecook/vscode-iRule)
60
+
61
+
-[Avoiding Common iRules Security Pitfalls on F5 DevCentral](https://community.f5.com/t5/technical-articles/avoiding-common-irules-security-pitfalls/ta-p/306623)
62
+
63
+
-[iRules Style Guide on F5 DevCentral](https://community.f5.com/t5/technical-articles/irules-style-guide/ta-p/305921)
0 commit comments