File Protocol
Learn about using Nuclei to work with the local file system
Overview
Nuclei allows modelling templates that can match/extract on the local file system.
Extensions
To match on all extensions (except the ones in default denylist), use the following -
You can also provide a list of custom extensions that should be matched upon.
A denylist of extensions can also be provided. Files with these extensions will not be processed by nuclei.
By default, certain extensions are excluded in nuclei file module. A list of these is provided below-
More Options
max-size parameter can be provided which limits the maximum size (in bytes) of files read by nuclei engine.
As default the max-size
value is 5 MB (5242880), Files larger than the max-size
will not be processed.
no-recursive option disables recursive walking of directories / globs while input is being processed for file module of nuclei.
Matchers / Extractors
File protocol supports 2 types of Matchers -
Matcher Type | Part Matched |
---|---|
word | all |
regex | all |
Extractors Type | Part Matched |
---|---|
word | all |
regex | all |
Example File Template
The final example template file for a Private Key detection is provided below.
More complete examples are provided here
Was this page helpful?