RemoteWebConsole 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94896087ba07c17255f8644f93552895742f3f1e37dbb28218739abd2c038054
-  data.tar.gz: ff9a6eb87e0cefee1271814f96f7d73761f11321f62c2167d6398a29110d5229
+  metadata.gz: 130aeeb342a0d697598d2beffa62a8e41912b5847d0212796d37ea47e062bd7e
+  data.tar.gz: 9fef7199fafeb3e8b4b6d306c0ed8dec8380fcfe4b61c8d904d052d86e371c0f
 SHA512:
-  metadata.gz: 98a7c597250b695b0cca7d8c5e6870b35813ff213eb61e62ac0b14ef2157df2d3c842ca85a2251e9f1ab568c445c53d656d12f5a03c8fdc0575423d97eb76d2c
-  data.tar.gz: f888291e31bab5f9bbbb95acf9baf35072951fd7c3d210ec48194423e2e922a35f7e48d5ef64bcf458818bf965b613b6a441ae340576a7743e3fb442861de2d2
+  metadata.gz: 2fffa6d8986a335d44d9066613922a301fc5c6bdd3325408638abfe1eb0ea3f987cdc21629625ec11bfe1cbb390d118c93964d320e9a077cb1182655a537ee87
+  data.tar.gz: 795a316ef71700c8cd893ac8a4e359239d598ca31f38986b4110e2886073ccafff46bcaade7104483ec7cbdea7654836b340d02e556aad5c8bc069fc51f6d34c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Cynicallity
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Webconsole
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webconsole'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install webconsole
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,18 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/webconsole_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/webconsole .css

data/app/assets/stylesheets/webconsole/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/webconsole/console.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/webconsole/application_controller.rb

@@ -0,0 +1,4 @@
+module Webconsole
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/webconsole/console_controller.rb

@@ -0,0 +1,163 @@
+require_dependency "webconsole/application_controller"
+
+module Webconsole
+  class ConsoleController < ApplicationController
+    skip_before_action :verify_authenticity_token, except: [:index]
+    before_action :check_admin_access, only: [:run_command]
+
+    require 'ipaddr'
+    require 'httparty'
+    require 'json'
+
+    def index
+        if params[:ip]
+            @details = {
+                name: "Webconsole",
+                ip: params[:ip],
+                connect: true
+            }
+        else
+            @details = {
+                name: "Webconsole",
+                connect: false
+            }
+        end
+    end
+
+    def connect
+        if not allowed_ips.any? { |block| block.include?(request.remote_ip) }
+            render json: {
+                connected: false,
+                message: "You are not allowed to connect to the console.",
+                ip: request.remote_ip
+            }
+        else
+            render json: {
+                connected: true,
+                ip: request.remote_ip
+            }
+        end
+    end
+
+    def run_command
+        command = params[:command].strip
+
+        if command.nil? || command.empty?
+            send_response("No command specified", "error", "string")
+            return
+        end
+
+        if command[0, 6] == "shell "
+            begin
+                eval_result = system(command[6..-1])
+                status = "success"
+            rescue Exception => e
+                eval_result = e.message
+                status = "error"
+            end
+        else
+            begin
+                eval_result = eval(command)
+                status = "success"
+            rescue Exception => e
+                eval_result = e.message.to_s
+                status = "error"
+            end
+        end
+
+        puts "Result of command: #{eval_result}"
+
+        result = parse_command_response(eval_result)
+
+        send_response(
+            result[:result],
+            status
+        )
+    end
+
+    def send_command
+        begin
+            response = HTTParty.put("http://" + params[:ip] + "/webconsole/console",
+                body: {
+                    command: params[:command]
+                }
+            )
+
+            if response.code == 200
+                render json: JSON.parse(response.body)
+            else
+                render json: {
+                    status: "error",
+                    message: "Error while sending command"
+                }
+            end
+        rescue Exception => e
+            render json: {
+                status: "error",
+                message: "Error while sending command"
+            }
+        end
+    end
+
+    def remote_connect
+        begin
+            response = HTTParty.put("http://" + params[:ip] + "/webconsole/console/connect")
+            if response.code == 200
+                render json: JSON.parse(response.body)
+            else
+                render json: {
+                    connected: false
+                }
+            end
+        rescue Exception => e
+            render json: {
+                connected: false
+            }
+        end
+    end
+
+    private
+
+    def send_response(result, status)
+        render json: {
+            result: result,
+            status: status
+        }
+    end
+
+    def parse_command_response(response)
+        if response.is_a?(String)
+            return {
+                result: response
+            }
+        elsif response.is_a?(Array)
+            return {
+                result: response.join("\n")
+            }
+        else
+            return {
+                result: response.to_json
+            }
+        end
+    end
+
+    def check_admin_access
+        if !allowed_ips.include?(current_ip_address)
+            render json: {
+                connected: false,
+                ip: request.remote_ip
+            }
+        end
+    end
+
+    def allowed_ips
+        %w{
+            ::1
+        }.map { |ip| IPAddr.new ip }
+    end
+
+    def current_ip_address
+        request.env['HTTP_X_REAL_IP'] || request.env['REMOTE_ADDR']
+    end
+  end
+end

data/app/helpers/webconsole/application_helper.rb

@@ -0,0 +1,4 @@
+module Webconsole
+  module ApplicationHelper
+  end
+end

data/app/helpers/webconsole/console_helper.rb

@@ -0,0 +1,4 @@
+module Webconsole
+  module ConsoleHelper
+  end
+end

data/app/jobs/webconsole/application_job.rb

@@ -0,0 +1,4 @@
+module Webconsole
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/webconsole/application_mailer.rb

@@ -0,0 +1,6 @@
+module Webconsole
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/webconsole/application_record.rb

@@ -0,0 +1,5 @@
+module Webconsole
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/webconsole/application.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Webconsole</title>
+    <%= csrf_meta_tags %>
+    <%= csp_meta_tag %>
+
+    <%= stylesheet_link_tag    "webconsole/application", media: "all" %>
+
+    <script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
+    <script src="https://unpkg.com/jquery.terminal/js/jquery.terminal.min.js"></script>
+    <link rel="stylesheet" href="https://unpkg.com/jquery.terminal/css/jquery.terminal.min.css"/>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/app/views/webconsole/console/index.html.erb

@@ -0,0 +1,144 @@
+<script>
+    <% if not @details[:connect] %>
+        let connected = false;
+        let connected_to = "";
+        let greeting = "Type: connect [[b;#fff;]connect :ip] to connect to remote server";
+    <% else %>
+        let connected = true;
+        let connected_to = "<%= @details[:ip] %>";
+        let greeting = "You are connected to <%= @details[:ip] %>";
+
+        if (connected_to == "::1")
+            connected_to = "localhost:3000";
+    <% end %>
+
+    function send_command(command, shell) {
+        return new Promise(function(resolve) {
+            if (shell)
+                command = "shell " + command;
+            $.ajax({
+                url: '/webconsole/console/send_command',
+                type: 'POST',
+                data: {
+                    command: command,
+                    ip: connected_to
+                },
+                success: function(data) {
+                    resolve(data);
+                }.bind(this),
+                error: function(xhr, status, error) {
+                    resolve({
+                        status: "error",
+                        message: error
+                    });
+                }.bind(this)
+            });
+        })
+    }
+
+    function echo(console, response) {
+        if (response.result == "null")
+            response.result = "success";
+        
+        if (response.status == "success") {
+            console.echo(response.result);
+        } else {
+            if (connected) {
+                console.echo('[[b;red;]' + response.result + ']');
+
+                console.echo('Spinners, type [[b;#fff;]help] to display '+
+                'available spinners or [[b;#fff;]spinner <n'+
+                'ame>] for animation', {
+                    keepWords: true
+                });
+            } else {
+                console.echo('[[b;red;]Not connected to any server]');
+
+                console.echo('Connect, type [[b;#fff;]connect :ip] to connect '+
+                'to a server.', {
+                    keepWords: true
+                });
+            }
+        }
+    }
+
+    $('body').terminal({
+        connect: function(ip) {
+            if (connected) {
+                this.echo('Already connected to ' + connected_to);
+                this.echo('Use "disconnect" to disconnect');
+                return;
+            }
+
+            this.pause();
+            $.ajax({
+                url: '/webconsole/console/remote_connect',
+                type: 'POST',
+                data: {
+                    ip: ip
+                },
+                success: function(data) {
+                    if (data.connected) {
+                        this.echo('Connected to ' + ip);
+                        connected = true;
+                        connected_to = ip;
+                    } else {
+                        this.echo('Could not connect to ' + ip);
+                    }
+                }.bind(this),
+                error: function(xhr, status, error) {
+                    this.echo('Could not connect to ' + ip);
+                }.bind(this)
+            });
+            this.resume();
+        },
+        disconnect: function() {
+            if (!connected) {
+                this.echo('Not connected to any server');
+                return;
+            }
+
+            this.pause();
+            this.echo('Disconnected from ' + connected_to);
+            connected = false;
+            connected_to = "";
+            this.resume();
+        },
+        shell: async function(...args) {
+            this.pause();
+            command = args.join(' ');
+            let response = await send_command(command, true);
+            echo(this, response);
+            this.resume();
+        },
+        rails: async function(...args) {
+            this.pause();
+            command = args.join(' ');
+            let response = await send_command(command, false);
+            echo(this, response);
+            this.resume();
+        },
+        server: function() {
+            this.pause();
+            echo(this, {
+                status: "success",
+                result: "Connected to " + connected_to
+            })
+            this.resume();
+        },
+        help: function() {
+            this.pause();
+            this.echo('Available commands:');
+            this.echo('[[b;#fff;]connect :ip] to connect to remote server');
+            this.echo('[[b;#fff;]disconnect] to disconnect from remote server');
+            this.echo('[[b;#fff;]shell <command>] to run shell command');
+            this.echo('[[b;#fff;]rails <command>] to run rails command');
+            this.echo('[[b;#fff;]server] to display server info');
+            this.echo('[[b;#fff;]help] to display this help');
+            this.resume();
+        }
+    }, {
+        checkArity: false,
+        greetings: greeting,
+    });
+</script>

data/config/routes.rb

@@ -1,6 +1,8 @@
-WebConsole::Engine.routes do
-    put '/console', to: 'console#run_command', as: :console_run_command
-    put '/console/connect', to: 'console#connect', as: :console_connect
-    put '/console/connect_remote/:id', to: 'console#connect_remote', as: :console_connect_remote
-    put '/console/send_command', to: 'console#send_command', as: :console_send_command
-end
+Webconsole::Engine.routes.draw do
+    root to: 'console#index'
+    get '/:ip', to: 'console#index'
+    put '/console', to: 'console#run_command', as: :console_run_command
+    put '/console/connect', to: 'console#connect'
+    post '/console/remote_connect', to: 'console#remote_connect', as: :console_remote_connect
+    post '/console/send_command', to: 'console#send_command', as: :console_send_command
+end

data/lib/tasks/webconsole_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :webconsole do
+#   # Task goes here
+# end

data/lib/webconsole/config.rb

@@ -0,0 +1,6 @@
+module Webconsole
+    whitelisted_ips = %w{
+        ::1
+    }
+end
+  

data/lib/webconsole/engine.rb

@@ -0,0 +1,5 @@
+module Webconsole
+  class Engine < ::Rails::Engine
+    isolate_namespace Webconsole
+  end
+end

data/lib/webconsole/version.rb

@@ -0,0 +1,3 @@
+module Webconsole
+  VERSION = '0.1.4'
+end

data/lib/webconsole.rb

@@ -1,2 +1,6 @@
-class WebConsole
-end
+require "webconsole/version"
+require "webconsole/engine"
+
+module Webconsole
+  # Your code goes here...
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: RemoteWebConsole
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Sebastian Eriksson
@@ -9,22 +9,55 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2022-05-21 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.6
 description: A webconsole that can be used accross multiple applications.
-email: sebastian98@live.se
+email:
+- sebastian98@live.se
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- app/controllers/webconsole/webconsole_controller.rb
-- app/helpers/console_helper.rb
-- config/locales/en.yml
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/webconsole_manifest.js
+- app/assets/stylesheets/webconsole/application.css
+- app/assets/stylesheets/webconsole/console.css
+- app/controllers/webconsole/application_controller.rb
+- app/controllers/webconsole/console_controller.rb
+- app/helpers/webconsole/application_helper.rb
+- app/helpers/webconsole/console_helper.rb
+- app/jobs/webconsole/application_job.rb
+- app/mailers/webconsole/application_mailer.rb
+- app/models/webconsole/application_record.rb
+- app/views/layouts/webconsole/application.html.erb
+- app/views/webconsole/console/connect.html.erb
+- app/views/webconsole/console/index.html.erb
 - config/routes.rb
+- lib/tasks/webconsole_tasks.rake
 - lib/webconsole.rb
+- lib/webconsole/config.rb
+- lib/webconsole/engine.rb
+- lib/webconsole/version.rb
 homepage: https://rubygems.org/gems/RemoteWebConsole
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://rubygems.org/gems/RemoteWebConsole
 post_install_message:
 rdoc_options: []
 require_paths:

data/app/controllers/webconsole/webconsole_controller.rb

@@ -1,111 +0,0 @@
-module WebConsole
-    class WebConsoleController < ApplicationController
-        include WebConsoleHelper
-        
-        skip_before_action :verify_authenticity_token
-        before_action :check_admin_access, only: [:run_command]
-
-        def connect
-            # Recieve a connection request from the client
-            # and send back the connection ip and port
-            # if the request is from a valid ip address
-
-            if !allowed_ips.include?(current_ip_address)
-                render json: {
-                    connected: true,
-                    ip: request.remote_ip
-                }
-            else
-                render json: {
-                    connected: false,
-                    ip: request.remote_ip
-                }
-            end
-        end
-
-        def run_command
-            command = params[:command].strip
-            if command.nil? || command.empty?
-                send_response("No command specified", "error", "string")
-                return
-            end
-    
-            begin
-                eval_result = eval(command)
-                status = "success"
-            rescue Exception => e
-                eval_result = e.message
-                status = "error"
-            end
-
-            result = parse_command_response(response)
-
-            send_response(
-                result[:result],
-                status,
-                result[:type]
-            )
-        end
-
-        def send_command
-            # Find the server with the specified id
-            # and send the command to it
-            server = Server.find(params[:id])
-            render json: send_command(params[:command], server.ip)
-        end
-    
-        def connect_remote
-            server = Server.find(params[:id])
-            render json: connect(server.ip)
-        end
-
-        private
-
-        def send_response(result, status, type)
-            render json: {
-                result: result,
-                status: status,
-                type: type
-            }
-        end
-
-        def parse_command_response(response)
-            if response.is_a?(String)
-                return {
-                    result: response,
-                    type: "string"
-                }
-            elsif response.is_a?(Array)
-                return {
-                    result: response.join("\n"),
-                    type: "array"
-                }
-            else
-                return {
-                    result: response.to_json,
-                    type: "json"
-                }
-            end
-        end
-
-        def check_admin_access
-            if !allowed_ips.include?(current_ip_address)
-                render json: {
-                    connected: false,
-                    ip: request.remote_ip
-                }
-            end
-        end
-
-        def allowed_ips
-            ips_blocks = [
-                "::1",
-                "85.24.169.213"
-            ]
-        end
-    
-        def current_ip_address
-            request.env['HTTP_X_REAL_IP'] || request.env['REMOTE_ADDR']
-        end
-    end
-end

data/app/helpers/console_helper.rb

@@ -1,46 +0,0 @@
-module WebConsole
-    class WebConsoleHelper < ApplicationHelper
-        require 'httparty'
-
-        def send_command(command, ip)
-            begin
-                response = HTTParty.put("http://" + ip + "/console",
-                    body: {
-                        command: command
-                    }
-                )
-    
-                if response.code == 200
-                    return JSON.parse(response.body)
-                else
-                    return {
-                        status: "error",
-                        message: "Error while sending command"
-                    }
-                end
-            rescue Exception => e
-                return {
-                    status: "error",
-                    message: "Error while sending command"
-                }
-            end
-        end
-    
-        def connect(ip)
-            begin
-                response = HTTParty.put("http://" + ip + "/console/connect")
-                if response.code == 200
-                    return JSON.parse(response.body)
-                else
-                    return {
-                        connected: false
-                    }
-                end
-            rescue Exception => e
-                return {
-                    connected: false
-                }
-            end
-        end
-    end
-end

data/config/locales/en.yml

@@ -1,9 +0,0 @@
-en:
-  webconsole:
-    connect:
-      refused: "The server has refused your connection attempt"
-      success: "The server has accepted your connection and you are now connected"
-      error: "Something went wrong when connection to server"
-      error_paranoid: "Something went wrong when connection to server. Server might be down"
-    commands:
-      invalid: "Invalid command. Write 'help' for instructions"