introduces the config package to refactor the way the config is obtained #582
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit refactors the ffuf code to simplify the configuration
process. ffuf's configuration has become complex, since it takes configurations
from multiple configuration sources like the commandline, multiple configuration
files and HTTP request files (sometimes called HTTP templates). Inputs from
these configuration sources have to be merged into one coherent configuration
and it's consistency validated. ffuf lacked a clear way to obtain it's
configuration easily and clearly. Any contributor who wanted to introduce a new
feature had to study the configuration code and insert his or modify the
configuration process with the hopes of not breaking anything.
The config package aims to simplify and formalize the configuration of ffuf,
while making it flexible and extensible. It provides:
* One simple function call to obtain a configuration from a standard hierarchy
of all configurations sources
* A mechanism to merge the defined configuration sources
* A mechanism to validate the merged configuration and supply error messages
to the caller
* A way to add a configuration source to ffuf
* A way to add validation to new or changed options without knowing the code
base
A pkg/config/README.md is provided to further explain the configuration
process. Additionally, the core functionality is of this package is tested an
examples as Go code are provided.
This commit had to make changes to code outside the main package to untangle the
imports, which were causing import cycles.
The HTTP version was parsed with http.ParseHTTPVersion, which conforms to RFC 7230, which makes explicit, that the version part of the request line must have a major and minor version like so "HTTP/<major>.<minor>", http.ParseHTTPVersion errors if the version part is "HTTP/2". Because this version of ffuf extracts configuration parameters from the version part in the request line, especially ConfigOptions.HTTPOptions.Http2, a helper function parseHTTPVersion was introduced, which handles the version extraction more suitable to web fuzzing.
|
Oh boy, I've been on a hiatus for a while, and just now stumbled upon this PR. I do agree with the points made, and in case you are interested to keep on working on this, I'd be delighted to have it in. There are a couple large commits that will be made towards master in the coming days for the next release, so I would wait for a bit before continuing on the merge conflicts etc. Also this PR is so large that it will take a good amount of time and multiple large containers of coffee to review properly. |
|
Hi joohoi, yes I'd be happy to work on getting these conflicts resolved. Next week is the earliest I could take a look, though. Yeah, it's quite large xD so look at it at your own leasure. I'd be happy to assist. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit refactors the ffuf code to simplify the configuration
process. ffuf's configuration has become complex, since it takes configurations
from multiple configuration sources like the commandline, multiple configuration
files and HTTP request files (sometimes called HTTP templates). Inputs from
these configuration sources have to be merged into one coherent configuration
and it's consistency validated. ffuf lacked a clear way to obtain it's
configuration easily and clearly. Any contributor who wanted to introduce a new
feature had to study the configuration code and insert his or modify the
configuration process with the hopes of not breaking anything.
The config package aims to simplify and formalize the configuration of ffuf,
while making it flexible and extensible. It provides:
of all configurations sources
to the caller
base
A pkg/config/README.md is provided to further explain the configuration
process. Additionally, the core functionality is of this package is tested an
examples as Go code are provided.
This commit had to make changes to code outside the main package to untangle the
imports, which were causing import cycles.