[{"_1":2,"_169":-5,"_170":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_159":160},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)",{"_27":28,"_29":30,"_75":76,"_84":-7,"_85":-7,"_86":-7,"_87":-7,"_88":-5,"_89":-5,"_90":11,"_91":11,"_69":92,"_150":11,"_121":64,"_151":120,"_152":68,"_35":36,"_153":11,"_154":21,"_155":47,"_156":-5,"_157":11,"_158":11},"scanningType","none","tagData",{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":42,"_60":61,"_62":34,"_63":64,"_65":66,"_67":68,"_69":70,"_71":49,"_72":61,"_73":58,"_74":21},"content_type","image","creator",2520828,"digest","sha256:e32d409697538c11f1bf7d529cb8f64ddb25c78dc9ffa811cb18556dd9020c8f","full_size",7438917,"id",927904938,"images",[43],{"_44":45,"_35":36,"_46":47,"_48":49,"_50":51,"_52":53,"_54":47,"_55":-5,"_56":38,"_57":58,"_59":-5},"architecture","amd64","features","","last_pulled","2026-10-09T10:35:55.260804157Z","last_pushed","2025-07-02T21:27:57.625345812Z","os","linux","os_features","os_version","size","status","active","variant","last_updated","2025-07-02T21:27:57.76756Z","last_updater","last_updater_username","simonkowallik","media_type","application/vnd.docker.container.image.v1+json","name","apiserver-amd64","repository",18806161,"tag_last_pulled","tag_last_pushed","tag_status","v2","tagImages",[77],{"_44":45,"_35":36,"_46":47,"_48":49,"_50":51,"_78":79,"_52":53,"_54":47,"_55":-5,"_56":38,"_57":58,"_59":-5},"layers",[80],{"_35":81,"_56":38,"_82":83},"sha256:81751ac1ec1ed5bbfdc4fe2240f87cb5516b7e6e473c5a5980cb068e54eb2bff","instruction","apko","layerOrdinals","packageName","cveId","sbom","scoutSummary","staticSummary","isScoutPaymentRequired","canSeeVulnerabilities",{"_93":94,"_105":106,"_107":108,"_109":110,"_111":11,"_60":112,"_113":114,"_115":116,"_67":120,"_121":64,"_122":123,"_124":32,"_125":126,"_57":126,"_127":58,"_128":-5,"_129":130,"_131":132,"_133":11,"_134":64,"_135":136,"_141":11,"_142":143,"_147":64,"_148":149},"categories",[95,99,102],{"_67":96,"_97":98},"Networking","slug","networking",{"_67":100,"_97":101},"Languages & frameworks","languages-and-frameworks",{"_67":103,"_97":104},"Integration & delivery","integration-and-delivery","content_types",[32],"date_registered","2022-12-18T11:34:40.189437Z","description"," irulescan - security analyzer for iRules","is_private","2025-07-06T11:47:48.537917Z","last_modified","2025-07-02T22:11:07.224375Z","media_types",[66,117,118,119],"application/vnd.docker.distribution.manifest.list.v2+json","application/vnd.oci.image.config.v1+json","application/vnd.oci.image.index.v1+json","irulescan","namespace","pull_count",1977,"repository_type","star_count",1,"status_description","source","collaborator_count",0,"full_description","

\n\n $\"irulescan\"$ \n\n
\n security analyzer for iRules\n

\n\n---\n\n

\n\n $\"test\"$ \n\n\n $\"container$ \n\n\n $\"releases\"$ \n\n

\n\n`irulescan` is a tool to scan iRules for unexpected/unsafe expressions that may have undesirable effects like double substitution and additional issues.\n\n`irulescan` would not exist without [tclscan](https://github.com/aidanhs/tclscan).\n\nIt is available as a docker/container image as well as a Github Action [`irulescan-action`](https://github.com/marketplace/actions/irules-security-scan).\n\n## Usage\n\nIt is easiest to use irulescan as a container to scan your iRules, available via [docker hub](https://hub.docker.com/r/simonkowallik/irulescan) as well as [ghcr.io](https://github.com/simonkowallik/irulescan/pkgs/container/irulescan).\n\nThe container will recursively scan files in the `/scandir` directory within the container and return results in JSON format.\nOnly files with the (case insensitive) file extensions `.tcl`, `.irul` and `.irule` will be scanned unless overwritten by environment variable `IRULESCAN_FILE_EXTENSIONS`.\n\n### Command line\n\nScanning all iRules in a directory recursively (`$PWD/tests/basic`):\n\n```shell\ndocker run --rm -v \"$PWD/tests/basic:/scandir\" simonkowallik/irulescan\n```\n\n```json\n[\n {\n \"filepath\": \"dangerous.tcl\",\n \"warning\": [\n \"Unquoted expr at `1` in `expr 1 + $one`\",\n \"Unquoted expr at `+` in `expr 1 + $one`\"\n ],\n \"dangerous\": [\"Dangerous unquoted expr at `$one` in `expr 1 + $one`\"]\n },\n {\n \"filepath\": \"ok.tcl\",\n \"warning\": [],\n \"dangerous\": []\n },\n {\n \"filepath\": \"warning.tcl\",\n \"warning\": [\n \"Unquoted expr at `1` in `expr 1 + 1`\",\n \"Unquoted expr at `+` in `expr 1 + 1`\",\n \"Unquoted expr at `1` in `expr 1 + 1`\"\n ],\n \"dangerous\": []\n }\n]\n```\n\nIf you plan to use irulescan frequently, consider adding a shell function to wrap the container execution and add it in your shell, eg. in your `.bashrc` or similar.\n\n```shell\nirulescan(){ docker run --rm -iv \"$PWD:$PWD\" -w \"$PWD\" simonkowallik/irulescan:latest \"${@:--help}\"; }\n# invoke ephemeral (--rm) container interactively (-i)\n# bind mount (-v) PWD to the same path and use it as workdir (-w)\n# pass any parameters, if none/empty, pass \"help\" (\"${@:--help}\")\n```\n\n> [!NOTE]\n> For brevity and readability the below examples use `jq` and `yq` to format the json output.\n\n```bash\nirulescan check --exclude-empty-findings ./tests/basic/ | yq -pjson -oyaml\n```\n\n```yaml\n- filepath: tests/basic/dangerous.tcl\n warning:\n - message: unsafe expression, use braces `{ .. }`\n issue_location: \"1\"\n context: expr 1 + $one\n line: 2\n - message: unsafe expression, use braces `{ .. }`\n issue_location: +\n context: expr 1 + $one\n line: 2\n dangerous:\n - message: dangerous unsafe expression, use braces `{ .. }`\n issue_location: $one\n context: expr 1 + $one\n line: 2\n- filepath: tests/basic/warning.tcl\n warning:\n - message: unsafe expression, use braces `{ .. }`\n issue_location: \"1\"\n context: expr 1 + 1\n line: 1\n - message: unsafe expression, use braces `{ .. }`\n issue_location: +\n context: expr 1 + 1\n line: 1\n - message: unsafe expression, use braces `{ .. }`\n issue_location: \"1\"\n context: expr 1 + 1\n line: 1\n dangerous: []\n```\n\n>[!NOTE]\n> Please note the differences in `\"filepath\"` between the two invocation methods.\n> This is important to consider when comparing a new scan to existing results.\n> `--exclude-empty-findings` removes the entry for the file `\"ok.tcl\"` as it has no findings.\n> `cd tests/basic; irulescan check . | jq` would have provided the same results as the docker command from the previous example.\n\nWhen specifying a file explicitly, irulescan will try to scan the file regardless of the file extension.\n\n```bash\nirulescan check --no-warn tests/basic/dangerous.tcl\n```\n\n```json\n[{\"filepath\":\"tests/basic/dangerous.tcl\",\"warning\":[],\"dangerous\":[{\"message\":\"dangerous unsafe expression, use braces `{ .. }`\",\"issue_location\":\"$one\",\"context\":\"expr 1 + $one\",\"line\":2}]}]\n```\n\n```bash\nirulescan --help\n```\n\n```bash\nirulescan is a tool to scan iRules for unexpected/unsafe expressions that may have undesirable effects like double substitution.\nhome: https://github.com/simonkowallik/irulescan\n\nUsage: irulescan \n\nCommands:\n check Scan all iRules in a directory (recursively) or the specified file or - for stdin\n checkref Scan all iRules in reference file (JSON) and compare to reference\n parsestr Parse given string or stdin\n mcpserver Run MCP server (HTTP stream transport)\n apiserver Run HTTP API server (OpenAPI v3)\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n -h, --help\n Print help (see a summary with '-h')\n\n -V, --version\n Print version\n```\n\n### API Server\n\nThe irulescan container tag `:apiserver` provides a simple OpenAPI server (previously Swagger) for scanning iRule code or multiple files.\n\nStart the API server:\n\n```shell\ndocker run -t --rm -p 8000:8000 simonkowallik/irulescan:apiserver\n```\n\nScanning a single file / iRule code:\n\n```shell\ncurl -s http://localhost:8000/scan/ \\\n --data-binary '@tests/basic/dangerous.tcl' | yq -pjson -oyaml\n```\n\n```yaml\nwarning:\n - message: unsafe expression, use braces `{ .. }`\n issue_location: \"1\"\n context: expr 1 + $one\n line: 2\n - message: unsafe expression, use braces `{ .. }`\n issue_location: +\n context: expr 1 + $one\n line: 2\ndangerous:\n - message: dangerous unsafe expression, use braces `{ .. }`\n issue_location: $one\n context: expr 1 + $one\n line: 2\n```\n\nScanning multiple files:\n\n```shell\ncurl -s http://localhost:8000/scanfiles/ \\\n -F 'file=@tests/basic/warning.tcl' \\\n -F 'file=@tests/basic/ok.tcl' \\\n | yq -pjson -oyaml\n```\n\n```yaml\n- filepath: warning.tcl\n warning:\n - message: unsafe expression, use braces `{ .. }`\n issue_location: \"1\"\n context: expr 1 + 1\n line: 1\n - message: unsafe expression, use braces `{ .. }`\n issue_location: +\n context: expr 1 + 1\n line: 1\n - message: unsafe expression, use braces `{ .. }`\n issue_location: \"1\"\n context: expr 1 + 1\n line: 1\n dangerous: []\n- filepath: ok.tcl\n warning: []\n dangerous: []\n```\n\nHere is a demo of the apiserver UI:\n\n

\n\n $\"simonkowallik/irulescan:apiserver\"$ \n\n

\n\n### MCP Server\n\nStart the MCP server:\n\n```bash\ndocker run -t --rm -p 8000:8000 simonkowallik/irulescan:mcpserver\n```\n\nWith VSCode and Copilot, follow [Use MCP servers in VS Code (Preview)](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_enable-mcp-support-in-vs-code).\n\nThe below is a - per workspace - config example:\n\n```bash\nmkdir .vscode\ncat <<'EOF' > .vscode/mcp.json\n{\n \"servers\": {\n \"irulescan\": {\n \"url\": \"http://localhost:8000\"\n }\n }\n}\nEOF\n```\n\nHere is a demo of the mcpserver using VSCode:\n\n

\n\n $\"simonkowallik/irulescan:apiserver\"$ \n\n

\n\n## Additional resources\n\nFor safer authoring the VS Code iRules Extension is highly recommended:\n\n- [F5 Networks iRules by bitwisecook](https://marketplace.visualstudio.com/items?itemName=bitwisecook.iRule) [on github](https://github.com/bitwisecook/vscode-iRule)\n\n- [Avoiding Common iRules Security Pitfalls on F5 DevCentral](https://community.f5.com/t5/technical-articles/avoiding-common-irules-security-pitfalls/ta-p/306623)\n\n- [iRules Style Guide on F5 DevCentral](https://community.f5.com/t5/technical-articles/irules-style-guide/ta-p/305921)\n\n## Advanced topics\n\n### Using irulescan in CI\n\nThe container uses `irulescan` as the entry point with the default CMD set to `check .` which will scan `/scandir` recursively.\n\nWhen using a CI system with custom mount points (eg. `/custom/path`), this can be easily supported by passing a new CMD like below. Note that, like outlined above, this will change the prefix of `\"filepath\"` for each iRule file.\n\n```shell\ndocker run --rm \\\n -v \"$PWD/tests/tcl/:/custom/path\" \\\n simonkowallik/irulescan check /custom/path\n```\n\nAlso have a look at [GitHub Action: irulescan-action](https://github.com/simonkowallik/irulescan-action), which can be used when using GitHub.\n\nAlternatives are using the API Server (see below) or invoke the irulescan container as outlined above. Consider creating a scan result file to compare against known findings and known iRules. Any change in findings could then be used to fail the CI run.\n\n### Check results against a reference (previous scan result)\n\nThe `checkref` command can be used to check each file listed in that reference file. The reference file is just a saved scan. See examples below.\n\n```bash\nirulescan/ $ cd ./tests/basic\n```\n\nUsing a previous scan result (`irulescan.json`) and passing it to `checkref` via STDIN. If the check is successful, the exist code will be 0.\n\n```bash\n$ cat irulescan.json | irulescan checkref -\nOK\n\n$ echo $?\n0\n```\n\nRe-checking `irulescan_nowarn.json` with no additional options.\n\n```bash\n$ irulescan checkref irulescan_nowarn.json\nFailed reference check!\nExtra in scan_results: .[1].warning.[0].({\"message\":\"unsafe expression, use braces `{ .. }`\",\"issue_location\":\"+\",\"context\":\"expr 1 + 1\",\"line\":1})\nExtra in scan_results: .[1].warning.[1].({\"message\":\"unsafe expression, use braces `{ .. }`\",\"issue_location\":\"1\",\"context\":\"expr 1 + 1\",\"line\":1})\nExtra in scan_results: .[1].warning.[2].({\"message\":\"unsafe expression, use braces `{ .. }`\",\"issue_location\":\"1\",\"context\":\"expr 1 + 1\",\"line\":1})\nExtra in scan_results: .[2].warning.[0].({\"message\":\"unsafe expression, use braces `{ .. }`\",\"issue_location\":\"+\",\"context\":\"expr 1 + $one\",\"line\":2})\nExtra in scan_results: .[2].warning.[1].({\"message\":\"unsafe expression, use braces `{ .. }`\",\"issue_location\":\"1\",\"context\":\"expr 1 + $one\",\"line\":2})\n\n$ echo $?\n1\n```\n\nThe above example produces a failed check as the scan results produce additional findings. The exit code is 1.\n\nThe previous scan result `irulescan_nowarn.json` does not contain any warnings, using the `--no-warn` option the check succeeds.\n\n```bash\n$ irulescan checkref --no-warn irulescan_nowarn.json\nOK\n\n$ echo $?\n0\n```\n\n### CLI exit codes\n\nWhen using the `irulescan check` command:\n\n- Always exits with code `0` no matter what findings are produced\n- Errors lead to a non-zero exit code > 1 (eg. a crash)\n\nWhen using the `irulescan checkref` command:\n\n- Exits with code `0` when the reference scan matches the current results\n- Exits with code `1` when the reference scan does NOT match the current results\n- Errors lead to a non-zero exit code > 1 (eg. a crash)\n\n### Environment Variables\n\nirulescan supports several environment variables to customize its behavior across different usage modes (command line, API server, and MCP server).\n\n#### Command Line and Container\n\nFor command line and container usage, you can use `IRULESCAN_FILE_EXTENSIONS` to specify which file extensions to scan. The default value is `.tcl,.irul,.irule`. File extensions are always case insensitive. File extensions should be comma-separated without spaces. This is particularly useful when working with custom file naming conventions or when you want to scan files with non-standard extensions.\n\n```bash\nexport IRULESCAN_FILE_EXTENSIONS=\".f5rule,.f5irule,.txt\"\nirulescan check ./my-rules/\n\n# Use container with custom file extensions\ndocker run --rm -v \"$PWD:/scandir\" -e IRULESCAN_FILE_EXTENSIONS=\".f5rule,.custom\" simonkowallik/irulescan\n```\n\n#### API Server and MCP Server\n\nFor API server and MCP server modes, you can configure the listen address and logging level using `IRULESCAN_LISTEN` and `IRULESCAN_LOG` respectively.\n\nThe `IRULESCAN_LISTEN` variable defaults to `0.0.0.0:8000` and controls the address and port the server binds to. The environment variable has the highest priority and will overwrite the default listen address as well as any listen address specified as a command line option to either mcpserver or apiserver.\n\nThe `IRULESCAN_LOG` variable defaults to info and accepts standard log levels: `trace`, `debug`, `info`, `warn`, and `error`, where `trace` provides the most verbose output.\n","has_starred","hub_user","immutable_tags_settings",{"_137":11,"_138":139},"enabled","rules",[140],".*","is_automated","permissions",{"_144":21,"_145":11,"_146":11},"read","write","admin","user","storage_size",504110968,"isOrg","reponame","tag","canDeleteTags","isHubSbxKitsEnabled","currentTab","tagAttestations","displaySecurityMetadata","showSbxLogoOverride","routes/_layout.layers.$namespace.$reponame.$tag.(images).($imageUrlDigest)._index",{"_27":28,"_86":-7,"_84":-7,"_85":-7,"_29":161,"_35":36,"_164":165,"_168":11},{"_31":32,"_33":34,"_35":36,"_37":38,"_39":40,"_41":162,"_60":61,"_62":34,"_63":64,"_65":66,"_67":68,"_69":70,"_71":49,"_72":61,"_73":58,"_74":21},[163],{"_44":45,"_35":36,"_46":47,"_48":49,"_50":51,"_52":53,"_54":47,"_55":-5,"_56":38,"_57":58,"_59":-5},"imageWithLayers",{"_44":45,"_35":36,"_46":47,"_48":49,"_50":51,"_78":166,"_52":53,"_54":47,"_55":-5,"_56":38,"_57":58,"_59":-5},[167],{"_35":81,"_56":38,"_82":83},"hasPermissionToViewRepoSettings","actionData","errors"]

simonkowallik/irulescan:apiserver-amd64