-
-
Notifications
You must be signed in to change notification settings - Fork 53
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
99fa17a
commit 3f50f7a
Showing
6 changed files
with
225 additions
and
14 deletions.
There are no files selected for viewing
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -79,6 +79,7 @@ Commands: | |
| cert-dump | ||
| cert-gen | ||
| cert-grab | ||
| completion | ||
| decode, dec | ||
| decrypt | ||
| dns | ||
|
|
||
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| # frozen_string_literal: true | ||
| # | ||
| # Copyright (c) 2006-2023 Hal Brodigan (postmodern.mod3 at gmail.com) | ||
| # | ||
| # Ronin is free software: you can redistribute it and/or modify | ||
| # it under the terms of the GNU General Public License as published by | ||
| # the Free Software Foundation, either version 3 of the License, or | ||
| # (at your option) any later version. | ||
| # | ||
| # Ronin 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 General Public License for more details. | ||
| # | ||
| # You should have received a copy of the GNU General Public License | ||
| # along with Ronin. If not, see <https://www.gnu.org/licenses/>. | ||
| # | ||
|
|
||
| require 'ronin/core/cli/completion_command' | ||
| require 'ronin/repos/cli/commands/completion' | ||
| require 'ronin/db/cli/commands/completion' | ||
| require 'ronin/fuzzer/cli/commands/completion' | ||
| require 'ronin/web/cli/commands/completion' | ||
| require 'ronin/vulns/cli/commands/completion' | ||
| require 'ronin/payloads/cli/commands/completion' | ||
| require 'ronin/exploits/cli/commands/completion' | ||
| require 'ronin/listener/cli/commands/completion' | ||
| require 'ronin/nmap/cli/commands/completion' | ||
| require 'ronin/masscan/cli/commands/completion' | ||
| require 'ronin/recon/cli/commands/completion' | ||
| require 'ronin/root' | ||
|
|
||
| module Ronin | ||
| class CLI | ||
| module Commands | ||
| # | ||
| # Manages the shell completion rule for `ronin` and all other `ronin-*` | ||
| # commands. | ||
| # | ||
| # ## Usage | ||
| # | ||
| # ronin completion [options] | ||
| # | ||
| # ## Options | ||
| # | ||
| # --print Prints the shell completion file | ||
| # --install Installs the shell completion file | ||
| # --uninstall Uninstalls the shell completion file | ||
| # -h, --help Print help information | ||
| # | ||
| # ## Examples | ||
| # | ||
| # ronin completion --print | ||
| # ronin completion --install | ||
| # ronin completion --uninstall | ||
| # | ||
| # @since 2.1.0 | ||
| # | ||
| class Completion < Core::CLI::CompletionCommand | ||
|
|
||
| man_dir File.join(ROOT,'man') | ||
| man_page 'ronin-completion.1' | ||
|
|
||
| description 'Manages the shell completion rules for ronin and all other ronin-* commands' | ||
|
|
||
| # All shell completion files for `ronin` and the other `ronin-*` | ||
| # commands. | ||
| COMPLETION_FILES = [ | ||
| File.join(ROOT,'data','completions','ronin'), | ||
|
|
||
| Repos::CLI::Commands::Completion.completion_file, | ||
| DB::CLI::Commands::Completion.completion_file, | ||
| Fuzzer::CLI::Commands::Completion.completion_file, | ||
| Web::CLI::Commands::Completion.completion_file, | ||
| Vulns::CLI::Commands::Completion.completion_file, | ||
| Payloads::CLI::Commands::Completion.completion_file, | ||
| Exploits::CLI::Commands::Completion.completion_file, | ||
| Listener::CLI::Commands::Completion.completion_file, | ||
| Nmap::CLI::Commands::Completion.completion_file, | ||
| Masscan::CLI::Commands::Completion.completion_file, | ||
| Recon::CLI::Commands::Completion.completion_file | ||
| ] | ||
|
|
||
| # | ||
| # Prints all completion files. | ||
| # | ||
| def print_completion_file | ||
| COMPLETION_FILES.each do |completion_file| | ||
| super(completion_file) | ||
| end | ||
| end | ||
|
|
||
| # | ||
| # Installs all completion files. | ||
| # | ||
| def install_completion_file | ||
| COMPLETION_FILES.each do |completion_file| | ||
| super(completion_file) | ||
| end | ||
| end | ||
|
|
||
| # | ||
| # Uninstall all completion files. | ||
| # | ||
| def uninstall_completion_file | ||
| COMPLETION_FILES.each do |completion_file| | ||
| super(completion_file) | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end | ||
| end |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| # ronin-completion 1 "2024-01-01" Ronin "User Manuals" | ||
|
|
||
| ## NAME | ||
|
|
||
| ronin-completion - Manages shell completion rules for `ronin-repos` | ||
|
|
||
| ## SYNOPSIS | ||
|
|
||
| `ronin-repos completion` [*options*] | ||
|
|
||
| ## DESCRIPTION | ||
|
|
||
| The `ronin completion` command can print, install, or uninstall shell | ||
| completion rules for the `ronin` command and all other `ronin-*` commands. | ||
|
|
||
| Supports installing completion rules for Bash or Zsh shells. | ||
| Completion rules for the Fish shell is currently not supported. | ||
|
|
||
| ### ZSH SUPPORT | ||
|
|
||
| Zsh users will have to add the following lines to their `~/.zshrc` file in | ||
| order to enable Zsh's Bash completion compatibility layer: | ||
|
|
||
| autoload -Uz +X compinit && compinit | ||
| autoload -Uz +X bashcompinit && bashcompinit | ||
|
|
||
| ## OPTIONS | ||
|
|
||
| `--print` | ||
| : Prints the shell completion file. | ||
|
|
||
| `--install` | ||
| : Installs the shell completion file. | ||
|
|
||
| `--uninstall` | ||
| : Uninstalls the shell completion file. | ||
|
|
||
| `-h`, `--help` | ||
| : Prints help information. | ||
|
|
||
| ## ENVIRONMENT | ||
|
|
||
| *PREFIX* | ||
| : Specifies the root prefix for the file system. | ||
|
|
||
| *HOME* | ||
| : Specifies the home directory of the user. Ronin will search for the | ||
| `~/.cache/ronin-repos` cache directory within the home directory. | ||
|
|
||
| *XDG_DATA_HOME* | ||
| : Specifies the data directory to use. Defaults to `$HOME/.local/share`. | ||
|
|
||
| ## FILES | ||
|
|
||
| `~/.local/share/bash-completion/completions/` | ||
| : The user-local installation directory for Bash completion files. | ||
|
|
||
| `/usr/local/share/bash-completion/completions/` | ||
| : The system-wide installation directory for Bash completions files. | ||
|
|
||
| `/usr/local/share/zsh/site-functions/` | ||
| : The installation directory for Zsh completion files. | ||
|
|
||
| ## EXAMPLES | ||
|
|
||
| `ronin completion --print` | ||
| : Prints all shell completion rules instead of installing them. | ||
|
|
||
| `ronin completion --install` | ||
| : Installs all shell completion rules for `ronin` and the other `ronin-*` | ||
| commands. | ||
|
|
||
| `ronin-repos completion --uninstall` | ||
| : Uninstalls all shell completion rules for `ronin` and the other `ronin-*` | ||
| commands. | ||
|
|
||
| ## AUTHOR | ||
|
|
||
| Postmodern <[email protected]> | ||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| require 'spec_helper' | ||
| require 'ronin/cli/commands/completion' | ||
| require_relative 'man_page_example' | ||
|
|
||
| describe Ronin::CLI::Commands::Completion do | ||
| it "must inherit from Ronin::Core::CLI::CompletionCommand" do | ||
| expect(described_class).to be < Ronin::Core::CLI::CompletionCommand | ||
| end | ||
|
|
||
| it "must set man_dir" do | ||
| expect(described_class.man_dir).to_not be(nil) | ||
| expect(File.directory?(described_class.man_dir)).to be(true) | ||
| end | ||
|
|
||
| include_examples "man_page" | ||
| end |