abalone 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 84a963023ccdf4286214f6e0bfcf7392c12289e6
+  data.tar.gz: 887a90254e4836b4dab02a1e4efc8b4e0dcb6914
+SHA512:
+  metadata.gz: 9b628557aadd49c273a684830203c2190be6945fc9f5bf081b0a5dcd0a1d750ab0a9b1266c107605e3dcbff094929f51bac3b1152fbfc85b6dcc1e7353f0ecdc
+  data.tar.gz: 3d530f9fa812d1ab3a4fc753de0df5a763997c70655dd2487a05b83e0cae5f1948b7ea0010c2aceaac6b2aeced8a4790507e3d6535f9058fd76e4c337463ca54

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,5 @@
+# abalone
+A simple Sinatra & hterm based web terminal.
+
+Simply exposes a login shell to a web browser. This is currently
+nowhere near to production quality, so don't actually use it.

data/bin/abalone

@@ -0,0 +1,60 @@
+#! /usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'abalone'
+
+gemroot = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+options = {
+  :port           => 9000,
+  :host           => '0.0.0.0',
+  :bind           => '0.0.0.0',
+}
+logfile  = $stderr
+loglevel = Logger::WARN
+
+optparse = OptionParser.new { |opts|
+    opts.banner = "Usage : abalone [-p <port>] [-l [logfile]] [-d]
+         -- Runs the Abalone web shell.
+
+"
+
+    opts.on("-d", "--debug", "Display or log debugging messages") do
+        loglevel = Logger::DEBUG
+    end
+
+    opts.on("--disable DISABLED_CHECKS", "Lint checks to disable. Either comma-separated list or filename.") do |arg|
+        puts "Disabling #{arg}"
+        options[:disabled_lint_checks] = arg
+    end
+
+    opts.on("-l [LOGFILE]", "--logfile [LOGFILE]", "Path to logfile. Defaults to no logging, or /var/log/abalone if no filename is passed.") do |arg|
+        logfile = arg || '/var/log/abalone'
+    end
+
+    opts.on("-p PORT", "--port", "Port to listen on. Defaults to 9000.") do |arg|
+        options[:port] = arg
+    end
+
+    opts.separator('')
+
+    opts.on("-h", "--help", "Displays this help") do
+        puts
+        puts opts
+        puts
+        exit
+    end
+}
+optparse.parse!
+
+logger           = Logger.new(logfile)
+logger.level     = loglevel
+options[:logger] = logger
+
+puts
+puts
+puts "Starting Abalone Web Shell. Browse to http://localhost:#{options[:port]}"
+puts
+puts
+
+Abalone.run! options

data/lib/abalone.rb

@@ -0,0 +1,103 @@
+require 'json'
+require 'logger'
+require 'sinatra/base'
+require 'sinatra-websocket'
+
+require 'pty'
+require 'io/console'
+
+class Abalone < Sinatra::Base
+  set :logging, true
+  set :strict, true
+  set :public_folder, 'public'
+
+  before {
+    env["rack.logger"] = settings.logger if settings.logger
+  }
+
+  get '/' do
+    if !request.websocket?
+      redirect '/index.html'
+    else
+      request.websocket do |ws|
+        ws.onopen do
+          warn("websocket opened")
+          reader, @writer, @pid = PTY.spawn(login_binary)
+          @writer.winsize = [24,80]
+
+          # there must be some form of event driven pty interaction, EM or some gem maybe?
+          reader.sync = true
+          @term = Thread.new do
+            loop do
+              begin
+                PTY.check(@pid, true)
+                data = reader.read_nonblock(512) # we read non-blocking to stream data as quickly as we can
+              rescue IO::WaitReadable
+                IO.select([reader])
+                retry
+              rescue PTY::ChildExited => e
+                puts "Terminal has exited!"
+                ws.send({'event' => 'logout'}.to_json)
+                Thread.exit
+              end
+              ws.send({'event' => 'output', 'data' => data}.to_json)
+              sleep(0.01)
+            end
+          end
+
+        end
+
+        ws.onclose do
+          warn("websocket closed")
+          stop_term()
+        end
+
+        ws.onmessage do |message|
+          message = JSON.parse(message)
+
+          begin
+            case message['event']
+            when 'input'
+              @writer.write message['data']
+
+            when 'resize'
+              row = message['row']
+              col = message['col']
+              @writer.winsize = [row, col]
+
+            when 'logout', 'disconnect'
+              warn("Client exited.")
+              stop_term()
+
+            else
+              warn("Unrecognized message: #{message.inspect}")
+            end
+          rescue Errno::EIO => e
+            puts "Terminal has died!"
+            puts e.message
+            ws.send({'event' => 'logout'}.to_json)
+          end
+
+        end
+      end
+    end
+  end
+
+  not_found do
+    halt 404, "You shall not pass! (page not found)\n"
+  end
+
+  helpers do
+    def stop_term()
+      Process.kill('TERM', @pid) rescue nil
+      @term.join
+    end
+
+    def login_binary()
+      [ '/bin/login', '/usr/bin/login' ].each do |path|
+        return path if File.executable? path
+      end
+      raise 'No login binary found.'
+    end
+  end
+end

data/public/index.html

@@ -0,0 +1,44 @@
+<!doctype html>
+<html lang="en">
+  <head>
+      <meta charset="UTF-8">
+      <title>Abalone Web Shell</title>
+      <script src="js/hterm_all.js"></script>
+      <script src="js/abalone.js"></script>
+      <style>
+          html,
+          body {
+              height: 100%;
+              width: 100%;
+              margin: 0px;
+          }
+          #overlay {
+              position: absolute;
+              z-index: 1000;
+              height: 100%;
+              width: 100%;
+              background-color: rgba(0,0,0,0.75);
+              display: none;
+          }
+          #overlay input {
+              display: block;
+              margin: auto;
+              position: relative;
+              top: 50%;
+              transform: translateY(-50%);
+          }
+          #terminal {
+              display: block;
+              position: relative;
+              width: 100%;
+              height: 100%;
+          }
+      </style>
+  </head>
+
+  <body>
+      <div id="overlay"><input type="button" onclick="javascript:location.reload();" value="reconnect" /></div>
+      <div id="terminal"></div>
+  </body>
+
+</html>

data/public/js/abalone.js

@@ -0,0 +1,92 @@
+var term;
+var buf = '';
+var protocol = (location.protocol === 'https:') ? 'wss://' : 'ws://';
+var socket   = new WebSocket(protocol + location.host)
+
+socket.onopen    = function()  { connected();            };
+socket.onclose   = function()  { disconnected();         }
+socket.onmessage = function(m) { messageHandler(m.data); };
+
+function connected() {
+  console.log('Client connected');
+  lib.init(function() {
+      hterm.defaultStorage = new lib.Storage.Local();
+      term = new hterm.Terminal();
+      window.term = term;
+      term.decorate(document.getElementById('terminal'));
+
+      term.setCursorPosition(0, 0);
+      term.setCursorVisible(true);
+      term.prefs_.set('ctrl-c-copy', true);
+      term.prefs_.set('ctrl-v-paste', true);
+      term.prefs_.set('use-default-window-copy', true);
+
+      term.runCommandClass(Abalone, document.location.hash.substr(1));
+      socket.send(JSON.stringify({
+        event: 'resize',
+        col: term.screenSize.width,
+        row: term.screenSize.height
+      }));
+
+      if (buf && buf != '')
+      {
+          term.io.writeUTF16(buf);
+          buf = '';
+      }
+  });
+}
+
+function disconnected() {
+  console.log('Client disconnected');
+  document.getElementById("overlay").style.display = "block";
+}
+
+function messageHandler(data) {
+  message = JSON.parse(data);
+
+  switch(message['event']) {
+    case 'output':
+      if (!term) {
+          buf += message['data'];
+          return;
+      }
+      term.io.writeUTF16(message['data']);
+      break;
+
+    case 'logout':
+      console.log("user logout");
+      disconnected();
+      break;
+
+    case 'disconnect':
+      disconnected();
+      break;
+
+    default:
+
+  }
+}
+
+/* borrowed from https://github.com/krishnasrinivas/wetty */
+function Abalone(argv) {
+  this.argv_ = argv;
+  this.io = null;
+  this.pid_ = -1;
+}
+
+Abalone.prototype.run = function() {
+  this.io = this.argv_.io.push();
+
+  this.io.onVTKeystroke = this.sendString_.bind(this);
+  this.io.sendString = this.sendString_.bind(this);
+  this.io.onTerminalResize = this.onTerminalResize.bind(this);
+}
+
+Abalone.prototype.sendString_ = function(str) {
+  socket.send(JSON.stringify({ event: 'input', data: str}));
+};
+
+Abalone.prototype.onTerminalResize = function(col, row) {
+  socket.send(JSON.stringify({ event: 'resize', col: col, row: row}));
+};
+