Skip to content

Add Archive and GitArchive output formats #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 16 commits into
base: 0.2.0
Choose a base branch
from
Draft

Add Archive and GitArchive output formats #173

wants to merge 16 commits into from

Conversation

@moozzi
Copy link
Member

@moozzi moozzi commented Aug 30, 2024 •
edited
Loading

postmodern and others added 15 commits August 19, 2024 15:36
@postmodern
Version bump to 0.2.0.
68d8071
@nirebu @postmodern
Add a SecurityTrails API worker (ronin-rb#152)
c1a64c6 
This worker will accept a domain as input and, given a valid API key,
will return a list of subdomain hosts by querying the Security Trails API.

---------

Co-authored-by: Postmodern <[email protected]>
@moozzi @postmodern
Fix att_reader description for SecurityTrails
c56ddf0
@postmodern
Allow Worker classes to omit defining outputs values (closes roni…
4e5aa00 
…n-rb#158).

* Some workers will need to accept values, process/save them, but not
  yield any Values themselves (ex: `web/wordlist` and `web/screenshot`).
@postmodern
Renamed ronin-recon test to ronin-recon run-worker (closes ronin-…
9e8f021 
…rb#165).

* Left behind an alias for `ronin-recon test` to
  `ronin-recon run-worker`.
@postmodern
Upgraded to ronin-core ~> 0.3 for command_kit ~> 0.6 (closes roni…
682ab41 
…n-rb#132).
@moozzi @postmodern
Add an optional worker for the BuiltWith API (ronin-rb#163)
770ae49 
---------

Co-authored-by: Postmodern <[email protected]>
@postmodern
Fixed ronin-recon new example commands.
858a146
@postmodern
Fixed copy/pasted README examples.
8fdfd4f
@moozzi @postmodern
Add an optional worker for the ZoomEye API (ronin-rb#166)
3f50e4f 
---------

Co-authored-by: Postmodern <[email protected]>
@moozzi @postmodern
Add an optional worker for the hunter.io API (ronin-rb#167)
434e18b 
---------

Co-authored-by: Postmodern <[email protected]>
@postmodern
Avoid creating empty Hashes and Arrays.
d382c89
@postmodern
Stylistic fixes.
2338010
@moozzi @postmodern
Add a Values::URL#=== method (ronin-rb#164)
fc4ba5b 
---------

Co-authored-by: Postmodern <[email protected]>
@moozzi @postmodern
Add support for multiple output files
b63b583
@moozzi moozzi force-pushed the add_archive_and_git_archive_output_formats branch from c086226 to 5d844e0 Compare August 30, 2024 14:00
@moozzi moozzi self-assigned this Aug 30, 2024
postmodern
postmodern reviewed Aug 30, 2024
View reviewed changes
Copy link
Member

@postmodern postmodern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sub-classing Ronin::Web::Spider::Archive classes might come back to bite us, if we ever change their APIs or if we add a << method to them. Using composition and initializing ivars might be a better option.

lib/ronin/recon/output_formats/archive.rb Outdated
#
# Represents a web archive directory.
#
class Archive < Ronin::Web::Spider::Archive
Copy link
Member

@postmodern postmodern Aug 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sub-classing Ronin::Web::Spider::Archive might cause problems for us in the future if we ever change it's API. Might be safer to initialize it as an ivar in initialize.

lib/ronin/recon/output_formats/git_archive.rb Outdated
# The path to the root directory.
#
def initialize(root)
super(root)
Copy link
Member

@postmodern postmodern Aug 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be safer to initialize Ronin::Web::Spider::GitArchive as an ivar.

postmodern
postmodern reviewed Sep 1, 2024
View reviewed changes
Copy link
Member

@postmodern postmodern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To avoid confusion, we should name these new output formats web_archive and git_web_archive (or web_git_archive). This should indicate to the user that only the URLs will be saved into the archive.

@moozzi moozzi force-pushed the add_archive_and_git_archive_output_formats branch from 5d844e0 to 8d62799 Compare September 1, 2024 16:49
postmodern
postmodern requested changes Sep 6, 2024
View reviewed changes
Copy link
Member

@postmodern postmodern left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forgot to rename the classes to match the output-format names.

lib/ronin/recon/output_formats.rb
register :png, '.png', PNG
register :pdf, '.pdf', PDF
register :web_archive, '', Archive
register :web_git_archive, '', GitArchive
Copy link
Member

@postmodern postmodern Sep 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename classes to WebArchive and GitArchive.

Copy link
Member

@postmodern postmodern Sep 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The file-exts can be omitted now that they are optional.

lib/ronin/recon/output_formats/archive.rb
#
# Represents a web archive directory.
#
class Archive
Copy link
Member

@postmodern postmodern Sep 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename class to WebArchive.

lib/ronin/recon/output_formats/git_archive.rb
#
# Represents a web archive directory that is backed by Git.
#
class GitArchive
Copy link
Member

@postmodern postmodern Sep 6, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename class to WebGitArchive.

This was referenced Sep 6, 2024
Open
Open
@postmodern postmodern force-pushed the 0.2.0 branch 2 times, most recently from 14a8e49 to c3e8f79 Compare June 23, 2025 21:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@postmodern postmodern postmodern requested changes

Assignees

@moozzi moozzi

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@moozzi @postmodern @nirebu