ronin-app 0.1.0.rc1

data/docker-compose.yml

@@ -0,0 +1,45 @@
+---
+version: '3'
+services:
+  web:
+    build:
+      context: .
+    privileged: true
+    command: bundle exec puma -C ./config/puma.rb -e production
+    ports:
+      - "1337:1337"
+    volumes:
+      - "./db:/app/db:z"
+      - "./log:/app/log:z"
+      - "./tmp:/app/tmp:z"
+    links:
+      - redis
+    environment:
+      - HOST=0.0.0.0
+      - PORT=1337
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - DATABASE_URL=sqlite3:/app/db/production.sqlite3
+
+  sidekiq:
+    build:
+      context: .
+    privileged: true
+    cap_add:
+      - "NET_RAW"
+      - "NET_ADMIN"
+      - "NET_BIND_SERVICE"
+    command: bundle exec sidekiq -C ./config/sidekiq.yml -r ./config/sidekiq.rb -r ./workers.rb -e production
+    volumes:
+      - "./db:/app/db:z"
+      - "./log:/app/log:z"
+      - "./tmp:/app/tmp:z"
+    links:
+      - redis
+    environment:
+      - REDIS_HOST=redis
+      - REDIS_PORT=6379
+      - DATABASE_URL=sqlite3:/app/db/production.sqlite3
+
+  redis:
+    image: redis

data/etc/systemd/user/ronin-app-sidekiq.1.service

@@ -0,0 +1,17 @@
+[Unit]
+PartOf=ronin-app.target
+StopWhenUnneeded=yes
+
+[Service]
+User=ronin-app
+WorkingDirectory=/srv/ronin-app
+Environment=PS=sidekiq.1
+ExecStart=/bin/bash -lc 'exec -a "ronin-app-sidekiq.1" bundle exec sidekiq -C ./config/sidekiq.yml -r ./config/sidekiq.rb -r ./workers.rb -e production'
+Restart=always
+RestartSec=14s
+StandardInput=null
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=%n
+KillMode=mixed
+TimeoutStopSec=5

data/etc/systemd/user/ronin-app-web.1.service

@@ -0,0 +1,18 @@
+[Unit]
+PartOf=ronin-app.target
+StopWhenUnneeded=yes
+
+[Service]
+User=ronin-app
+WorkingDirectory=/srv/ronin-app
+Environment=PORT=1337
+Environment=PS=web.1
+ExecStart=/bin/bash -lc 'exec -a "ronin-app-web.1" bundle exec puma -C ./config/puma.rb -e production'
+Restart=always
+RestartSec=14s
+StandardInput=null
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=%n
+KillMode=mixed
+TimeoutStopSec=5

data/etc/systemd/user/ronin-app.target

@@ -0,0 +1,5 @@
+[Unit]
+Wants=redis.service ronin-app-web.1.service ronin-app-sidekiq.1.service
+
+[Install]
+WantedBy=multi-user.target

data/gemspec.yml

@@ -0,0 +1,55 @@
+name: ronin-app
+summary: A local web interface for Ronin
+description: |
+ ronin-app is a small web application that is meant to be ran locally by the
+  user. It provides a web interface to ronin-support, ronin-repos, ronin-db,
+  ronin-payloads, ronin-exploits, as well as automating
+  ronin-nmap, ronin-masscan, ronin-web-spider, ronin-recon, and ronin-vulns.
+
+license: AGPL-3.0
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://ronin-rb.dev/
+has_yard: true
+
+metadata:
+  source_code_uri:   https://github.com/ronin-rb/ronin-app
+  bug_tracker_uri:   https://github.com/ronin-rb/ronin-app/issues
+  changelog_uri:     https://github.com/ronin-rb/ronin-app/blob/main/ChangeLog.md
+  rubygems_mfa_required: 'true'
+
+generated_files:
+ - man/ronin-app.1
+
+excluded_files:
+ - screenshots/*.svg
+
+required_ruby_version: ">= 3.1.0"
+
+dependencies:
+  dry-schema: ~> 1.0
+  dry-validation: ~> 1.0
+  dry-struct: ~> 1.0
+  redis: ~> 5.0
+  redis-namespace: ~> 1.10
+  sinatra: ~> 3.0
+  sinatra-contrib: ~> 3.0
+  pagy: ~> 6.2
+  sinatra-flash: ~> 0.3
+  sidekiq: ~> 7.0
+  puma: ~> 6.0
+  # Ronin dependencies:
+  ronin-support: ~> 1.1.0.rc1
+  ronin-core: ~> 0.2.0.rc1
+  ronin-db-activerecord: ~> 0.2.0.rc1
+  ronin-db: ~> 0.2.0.rc1
+  ronin-payloads: ~> 0.2.0.rc1
+  ronin-exploits: ~> 1.1.0.rc1
+  ronin-vulns: ~> 0.2.0.rc1
+  ronin-web-spider: ~> 0.2.0.rc1
+  ronin-nmap: ~> 0.1.0.rc1
+  ronin-masscan: ~> 0.1.0.rc1
+  ronin-recon: ~> 0.1.0.rc1
+
+development_dependencies:
+  bundler: ~> 2.0

data/lib/middleware/sidekiq/active_record_connection_pool.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+#
+# ronin-app - a local web app for Ronin.
+#
+# Copyright (C) 2023 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-app is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-app 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with ronin-app.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'active_record'
+
+module Middleware
+  module Sidekiq
+    #
+    # Sidekiq middleware to clear the ActiveRecord connection pool after each
+    # job.
+    #
+    class ActiveRecordConnectionPool
+
+      #
+      # Allows the job to be processed, then clears the ActiveRecord connection
+      # pool.
+      #
+      def call(*)
+        yield
+      ensure
+        begin
+          ActiveRecord::Base.connection_handler.clear_active_connections!
+        rescue => error
+          warn error.message
+        end
+      end
+
+    end
+  end
+end

data/lib/ronin/app/cli.rb

@@ -0,0 +1,197 @@
+# frozen_string_literal: true
+#
+# ronin-app - a local web app for Ronin.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-app is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-app 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with ronin-app.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/core/cli/command'
+require 'ronin/core/cli/logging'
+require 'ronin/db/config_file'
+require 'ronin/app/root'
+require 'ronin/app/version'
+
+require 'command_kit/options/version'
+require 'command_kit/open_app'
+
+module Ronin
+  module App
+    #
+    # Starts the ronin web app.
+    #
+    # ## Usage
+    #
+    #     ronin-app [options]
+    #
+    # ## Options
+    #
+    #     -V, --version                    Prints the version and exits
+    #     -H, --host IP                    The host to listen on (Default: localhost)
+    #         --db NAME                    The ronin-db database to connect to
+    #         --db-uri URI                 The ronin-db database URI to connect to
+    #     -p, --port PORT                  The port to listen on (Default: 1337)
+    #     -h, --help                       Print help information
+    #
+    # @api private
+    #
+    class CLI < Core::CLI::Command
+
+      include Core::CLI::Logging
+      include CommandKit::Options::Version
+      include CommandKit::OpenApp
+
+      command_name 'ronin-app'
+
+      option :host, short: '-H',
+                    value: {
+                      type:    String,
+                      usage:   'IP',
+                      default: 'localhost'
+                    },
+                    desc: 'The host to listen on'
+
+      option :port, short: '-p',
+                    value: {
+                      type:    Integer,
+                      usage:   'PORT',
+                      default: 1337
+                    },
+                    desc: 'The port to listen on'
+
+      option :db, value: {
+                    type:  DB::ConfigFile.load.keys,
+                    usage: 'NAME'
+                  },
+                  desc: 'The ronin-db database to connect to'
+
+      option :db_uri, value: {
+                        type:  String,
+                        usage: 'URI'
+                      },
+                      desc: 'The ronin-db database URI to connect to'
+
+      description 'Starts the ronin web app'
+
+      man_dir File.join(ROOT,'man')
+      man_page 'ronin-app.1'
+
+      version VERSION
+
+      #
+      # Runs the `ronin-app` command.
+      #
+      def run
+        host = options[:host]
+        port = options[:port]
+
+        pids = []
+
+        # switch to the app directory
+        Dir.chdir(ROOT)
+
+        begin
+          unless is_redis_running?
+            log_info "Starting Redis server ..."
+            pids << start_redis
+            sleep 1
+          end
+
+          # start the web server process
+          log_info "Starting Web server on #{host}:#{port} ..."
+          pids << start_web_server
+          sleep 1
+
+          # start the sidekiq process
+          log_info "Starting Sidekiq ..."
+          pids << start_sidekiq
+          sleep 1
+
+          open_app_for("http://#{host}:#{port}") if stdout.tty?
+          sleep
+        ensure
+          pids.each do |pid|
+            Process.kill('TERM',pid)
+            Process.kill('HUP',pid)
+          end
+
+          Process.waitall
+        end
+      end
+
+      #
+      # Determines if the Redis server is running.
+      #
+      # @return [Boolean]
+      #   Specifies whether the `redis-server` process is running or not.
+      #
+      def is_redis_running?
+        !`pgrep redis-server`.empty?
+      end
+
+      #
+      # Starts the Redis server.
+      #
+      # @return [Integer]
+      #   The PID of the `redis-server` process.
+      #
+      def start_redis
+        Process.spawn('redis-server')
+      end
+
+      #
+      # Starts the web server process.
+      #
+      # @return [Integer]
+      #   The PID of the `puma` web server process.
+      #
+      def start_web_server
+        command = %w[puma -C ./config/puma.rb -e production]
+        command << '-b' << "tcp://#{options[:host]}:#{options[:port]}"
+
+        Process.spawn(app_env,*command)
+      end
+
+      #
+      # Starts the sidekiq background job process.
+      #
+      # @return [Integer]
+      #   The PID of the `sidekiq` process.
+      #
+      def start_sidekiq
+        Process.spawn(app_env,"sidekiq -C ./config/sidekiq.yml -e production -r ./config/sidekiq.rb -r ./workers.rb")
+      end
+
+      #
+      # The environment variables Hash for the app processes.
+      #
+      # @return [Hash{String => String}]
+      #   The env Hash to pass into the app processes.
+      #
+      def app_env
+        env = {}
+
+        if options[:db_uri]
+          env['DATABASE_URL'] = options[:db_uri]
+        elsif options[:db]
+          env['DATABASE_NAME'] = options[:db].to_s
+        end
+
+        return env
+      end
+
+    end
+  end
+end

data/lib/ronin/app/helpers/html.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+#
+# ronin-app - a local web app for Ronin.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-app is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-app 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with ronin-app.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'rack/utils'
+
+module Ronin
+  module App
+    module Helpers
+      #
+      # HTML helper methods.
+      #
+      module HTML
+        #
+        # Renders a partial template.
+        #
+        # @param [Symbol] name
+        #   The partial template name without the `_`.
+        #
+        # @param [Hash{Symbol => Object}] locals
+        #   Additional local variables to pass to the partial.
+        #
+        def partial(name,**locals)
+          erb(:"_#{name}", layout: nil, locals: locals)
+        end
+
+        #
+        # Escapes the text as HTML text.
+        #
+        # @param [String] text
+        #   The string to escape.
+        #
+        # @return [String]
+        #   The HTML escaped string.
+        #
+        def h(text)
+          Rack::Utils.escape_html(text.to_s) if text
+        end
+
+        #
+        # Escapes the text as an HTML attribute value.
+        #
+        # @param [String] text
+        #   The string to escape.
+        #
+        # @return [String]
+        #   The escaped HTML attribute.
+        #
+        def hattr(text)
+          Rack::Utils.escape_path(text.to_s) if text
+        end
+      end
+    end
+  end
+end

data/lib/ronin/app/root.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+#
+# ronin-app - a local web app for Ronin.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-app is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-app 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with ronin-app.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+module Ronin
+  module App
+    # Path to `ronin-app` root directory.
+    #
+    # @api private
+    ROOT = File.expand_path(File.join(__dir__,'..','..','..'))
+  end
+end

data/lib/ronin/app/schemas/params_schema.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+#
+# ronin-app - a local web app for Ronin.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-app is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-app 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with ronin-app.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'dry-schema'
+require 'ronin/app/types'
+
+require 'ronin/core/params/types'
+
+module Ronin
+  module App
+    #
+    # Contains class methods for building dynamic dry-schemas.
+    #
+    module Schemas
+      #
+      # Builds a `Dry::Schema::Params` schema using a class'es defined params.
+      #
+      # @param [Hash{Symbol => Ronin::Core::Params::Param}] params
+      #   The class'es params.
+      #
+      def self.ParamsSchema(params)
+        dsl = Dry::Schema::DSL.new(processor_type: Dry::Schema::Params)
+
+        params.each do |name,param|
+          schema_type = case param.type
+                        when Ronin::Core::Params::Types::Enum
+                          Types::String.enum(*param.type.values)
+                        when Ronin::Core::Params::Types::Boolean
+                          :bool
+                        when Ronin::Core::Params::Types::Integer
+                          :integer
+                        when Ronin::Core::Params::Types::Float
+                          :float
+                        else
+                          :string
+                        end
+
+          if (param.required? && !param.has_default?)
+            dsl.required(name).filled(schema_type)
+          else
+            dsl.optional(name).maybe(schema_type)
+          end
+        end
+
+        return dsl.call
+      end
+    end
+  end
+end

data/lib/ronin/app/schemas/payloads/build_schema.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+#
+# ronin-app - a local web app for Ronin.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-app is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-app 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with ronin-app.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'dry/schema'
+
+require 'ronin/app/schemas/params_schema'
+
+module Ronin
+  module App
+    module Schemas
+      #
+      # Contains class methods for building dry-schemas for the `/payloads`
+      # routes.
+      #
+      module Payloads
+        #
+        # Builds a `Dry::Schema::Params` schema for the given payload class and
+        # for the `POST /payloads/.../build` route.
+        #
+        # @param [Class<Ronin::Payloads::Payload>] payload_class
+        #   The payload class to build the schema for.
+        #
+        # @return [Dry::Schema::Params]
+        #   The built schema.
+        #
+        def self.BuildSchema(payload_class)
+          # dynamically build the dry-schema based on the payload's params
+          params_schema = Schemas::ParamsSchema(payload_class.params)
+
+          return Dry::Schema::Params() do
+            unless payload_class.params.empty?
+              required(:params).hash(params_schema)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ronin/app/schemas/payloads/encoders/encode_schema.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+#
+# ronin-app - a local web app for Ronin.
+#
+# Copyright (c) 2023-2024 Hal Brodigan (postmodern.mod3@gmail.com)
+#
+# ronin-app is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-app 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 Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with ronin-app.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+require 'dry/schema'
+
+require 'ronin/app/schemas/params_schema'
+
+module Ronin
+  module App
+    module Schemas
+      module Payloads
+        #
+        # Contains class methods for building dry-schemas for the
+        # `/payloads/encoders` routes.
+        #
+        module Encoders
+          #
+          # Builds a `Dry::Schema::Params` schema for the given payload encoder
+          # class and for the `POST /payloads/encoders/encode...` route.
+          #
+          # @param [Class<Ronin::Payloads::Encoders::Encode>] encoder_class
+          #   The payload encoder class to build the schema for.
+          #
+          # @return [Dry::Schema::Params]
+          #   The built schema.
+          #
+          def self.EncodeSchema(encoder_class)
+            # dynamically encode the dry-schema based on the encoder's params
+            params_schema = Schemas::ParamsSchema(encoder_class.params)
+
+            return Dry::Schema::Params() do
+              required(:data).filled(:string)
+
+              unless encoder_class.params.empty?
+                required(:params).hash(params_schema)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end