ronin-rb / ronin-repos Goto Github PK

View Code? Open in Web Editor NEW

7.0 1.0 1.0 112 KB

Third-party git repository support for ronin.

Home Page: https://ronin-rb.dev

License: GNU Lesser General Public License v3.0

Ruby 100.00%

ronin-rb repository-management repository-manager third-party

ronin-repos's Introduction

ronin-repos

Description

ronin-repos provides a repository system for installing, managing, and accessing third-party git repositories, that can contain additional Ruby code or other data.

Third-party git repositories can be used to extend parts of Ronin. Other Ronin libraries can then list and load additional third-party Ruby classes from specific directories within the installed third-party repos:

exploits/ - may contain additional exploits for ronin-exploits.
payloads/ - may contain additional payloads for ronin-payloads.

tl;dr ronin-repos is essentially a decentralized plugin system for Ronin using git repos.

ronin-repos is part of the ronin-rb project, a toolkit for security research and development.

Features

Supports installing any Git repository.
Manages installed repositories.
Has 85% documentation coverage.
Has 100% test coverage.

Synopsis

Usage: ronin-repos [options] [COMMAND [ARGS...]]

Options:
    -h, --help                       Print help information

Arguments:
    [COMMAND]                        The command name to run
    [ARGS ...]                       Additional arguments for the command

Commands:
    help
    install
    list, ls
    new
    purge
    remove, rm
    update, up

Install a repository:

$ ronin-repos install https://github.com/...

List installed Repositories:

$ ronin-repos ls

Update all installed Repositories:

$ ronin-repos update

Update a specific Repositories:

$ ronin-repos update NAME

Uninstall a specific Repositories:

$ ronin-repos rm repo-name

Delete all repositories:

$ ronin-repos purge

Generate your own repo:

$ ronin-repos new my-repo
$ git remote add origin [email protected]:user/my-repo.git
$ git push -u origin main

Examples

require 'ronin/repos'

Ronin::Repos.find_file('wordlists/wordlist.txt')
# => "/home/user/.cache/ronin-repos/foo-repo/wordlists/wordlist.txt"

Rnnin::Repos.glob("wordlists/*.txt")
# => ["/home/user/.cache/ronin-repos/foo-repo/wordlists/cities.txt",
#     "/home/user/.cache/ronin-repos/foo-repo/wordlists/states.txt",
#     "/home/user/.cache/ronin-repos/bar-repo/wordlists/bands.txt",
#     "/home/user/.cache/ronin-repos/bar-repo/wordlists/beers.txt"]

Requirements

Ruby >= 3.0.0
ronin-core ~> 0.1

Install

$ gem install ronin-repos

Gemfile

gem 'ronin-repos', '~> 0.1'

Development

Fork It!
Clone It!
cd ronin-repos
bundle install
git checkout -b my_feature
Code It!
bundle exec rake spec
git push origin my_feature

License

ronin-repos is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

ronin-repos is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with ronin-repos. If not, see https://www.gnu.org/licenses/.

ronin-repos's People

Contributors

Stargazers

Watchers

Forkers

yonasbsd

ronin-repos's Issues

Release 0.2.0

Update to kramdown-man 1.0.0

Update the kramdown-man dependency to 1.0.0. Also update the man pages to use the new kramdown-man syntax (definition lists for arguments/options definitions and [ronin-foo](ronin-foo.1.md) man page links).

Add shell completions for `ronin-repos`

Use command_kit-completion to generate shell completions for ronin-repos.

Add a `Repository#last_updated_at` method

Add a method to Repository that queries the timestamp from the last commit (ex: git log --date=iso8601 --pretty="%cd" -1).

Add methods to allow requiring a single file from a repository

It should be possible to require a .rb file from a repository. These methods should accept a relative path and check in the lib/ directory of each repository.

If the repository has a Gemfile, somehow activate Bundler to activate any additional dependencies.

Add a `ronin-repos show` command separate from `ronin-repos list`

Change ronin-repos list to accept partial string to filter repo names with. Add a separate ronin-repos show command (aliased to info as well) for printing additional information about a repo.

Eventually re-enable jruby in the CI matrix

Due to jruby still working on 2.7 and 3.0 support, and that command_kit does not support ruby 2.6, jruby will be temporarily disabled in the CI matrix. Re-enable jruby support once they achieve 2.7 support.

Add a `Repository#url` method

If the repository is a git repository, then query git remote get-url origin.

Add `NAME` sections to all man pages

Add a NAME section to the tops of all man pages with the command's name and a short summary.

## NAME

ronin foo - summary here

This can probably be automated with a Ruby script.

Add Repository#has_file? method

We will need a simple method to test if a repository has a file.

Release ronin-repos 0.1.0.beta1

Release 0.1.1

Release a bug fix release.

Add rubocop

Add rubocop to the repository.

Add the rubocop gem to the Gemfile.
Start with the template rubocop.yml file which closely matches Ronin's general code style.
Add the rubocop task and add it to the CI.

Add an `exec` subcommand to ronin-repos

It should be possible to exec a ruby script (or other executable file) within a repository's bin/ directory.

If the repository has a Gemfile, then prefix the command with bundle exec. Also set the BUNDLER_GEMFILE env variable so bundler knows where the Gemfile is.

Release ronin-repos 0.1.0

Eventually re-enable truffleruby in the CI matrix

Temporarily disable truffleruby in the CI matrix, due to a truffleruby bug with splatting keyword arguments, which breaks command_kit.

Prefix all git methods in Repository with `git_`

Prefix all git related methods in Repository with git_. Add additional high-level methods for install, update, delete which call the git_ methods, and possibly other related methods. This will allow doing post-install tasks, like running bundle install, etc.

Add the ability of detecting a Gemfile and running `bundle install`

It should be possible to put a Gemfile in a repository, and run bundle install when the repository is installed. Gems should probably be installed into a local vendor/bundle directory or possibly a shared ~/.cache/ronin-repos/vendor/bundle directory.

Must also run bundle install after a repository has been updated.

Add a Repository#has_directory? method

We will need a simple method to test whether a repository has a directory.