hrr_rb_sftp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 836dd45879b224d1b99e0584fa6dfb374d51ddb77cbd90dbb08c2697aed1e8b4
+  data.tar.gz: 68dccfef0acb49b3576ef35fe500c8669e213d5b732ebdac34d3ab54ebba3953
+SHA512:
+  metadata.gz: cf36e84da8b26837ad259906b8d6340ed1cfc5e7e0ed3c88c1bd93555d8ab9964321504d40971b26e8cfae48808492389964bf5ffc706bbd4012c1adee1749ff
+  data.tar.gz: 87ef0bfbefdfc259747eecfce36cf7bcef3a07729380b1c827907f62cc64fe5b1065092f5ab65f41622b64afba0dac7744c73d6a69f4410001e65af64159b7c0

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# Bundler related files
+/Gemfile.lock
+/vendor
+
+# rbenv related files
+/.ruby-version

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
+  - ruby-head
+jobs:
+  allow_failures:
+  - rvm: ruby-head
+before_install:
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
+  - yes | gem update --system --force
+  - gem update bundler
+install:
+  - bundle install
+script:
+  - bundle exec rake spec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hirura@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hrr_rb_sftp.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 hirura
+
+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,135 @@
+# HrrRbSftp
+
+[![Build Status](https://travis-ci.com/hirura/hrr_rb_sftp.svg?branch=master)](https://travis-ci.com/hirura/hrr_rb_sftp)
+[![Gem Version](https://badge.fury.io/rb/hrr_rb_sftp.svg)](https://badge.fury.io/rb/hrr_rb_sftp)
+
+hrr_rb_sftp is a pure Ruby SFTP server implementation. hrr_rb_sftp now supports SFTP protocol version 1, 2, and 3.
+
+hrr_rb_sftp can be run on SSH 2.0 server like OpenSSH or [hrr_rb_ssh](https://github.com/hirura/hrr_rb_ssh).
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+    - [hrr\_rb\_ssh's SFTP subsystem](#hrr_rb_sshs-sftp-subsystem)
+    - [OpenSSH's SFTP subsystem](#opensshs-sftp-subsystem)
+- [Development](#development)
+- [Contributing](#contributing)
+- [License](#license)
+- [Code of Conduct](#code-of-conduct)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hrr_rb_sftp'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hrr_rb_sftp
+
+## Usage
+
+Here, some typical usage is described, but is not limited to.
+
+### hrr_rb_ssh's SFTP subsystem
+
+hrr_rb_sftp is written in Ruby, so it is straightforward to implement SFTP server on SSH 2.0 server library written in Ruby like hrr_rb_ssh.
+
+There are two ways to work with hrr_rb_ssh, on same process or spawning child process. On both cases, hrr_rb_ssh's request handler mechanism is used.
+
+To run hrr_rb_sftp server on the same process as hrr_rb_ssh is running, the hrr_rb_ssh's request handler is as follows.
+
+```ruby
+subsys = HrrRbSsh::Connection::RequestHandler.new { |ctx|
+  ctx.chain_proc { |chain|
+    case ctx.subsystem_name
+    when 'sftp'
+      begin
+        sftp_server = HrrRbSftp::Server.new(logger: nil)
+        sftp_server.start(ctx.io[0], ctx.io[1], ctx.io[2])
+        exitstatus = 0
+      rescue
+        exitstatus = 1
+      end
+    else
+      # Do something for other subsystem, or just return exitstatus
+      exitstatus = 0
+    end
+    exitstatus
+  }
+}
+
+options['connection_channel_request_subsystem']  = subsys
+```
+
+On the other hand, because the arguments for the hrr_rb_sftp server can be standard input, output, and error, so hrr_rb_sftp can be a independent program and be spawned as a child process.
+
+```ruby
+subsys = HrrRbSsh::Connection::RequestHandler.new { |ctx|
+  ctx.chain_proc { |chain|
+    case ctx.subsystem_name
+    when 'sftp'
+      pid = spawn("/path/to/hrr_rb_sftp_server.rb", {in: ctx.io[0], out: ctx.io[1], err: ctx.io[2]})
+      exitstatus = Process.waitpid(pid).to_i
+    else
+      # Do something for other subsystem, or just return exitstatus
+      exitstatus = 0
+    end
+    exitstatus
+  }
+}
+
+options['connection_channel_request_subsystem']  = subsys
+```
+
+Where, the /path/to/hrr_rb_sftp_server.rb is as follows.
+
+```ruby
+#!/usr/bin/env ruby
+
+require "hrr_rb_sftp"
+
+server = HrrRbSftp::Server.new(logger: nil)
+server.start($stdin, $stdout, $stderr)
+```
+
+### OpenSSH's SFTP subsystem
+
+OpenSSH has capability to run user-defined subsystems. Subsystems that the OpenSSH server recognizes are listed in /etc/ssh/sshd_config file. Usually SFTP subsystem is defined by default to use OpenSSH's SFTP server implementation.
+
+    $ cat /etc/ssh/sshd_config | grep Subsystem
+    Subsystem   sftp    /usr/lib/openssh/sftp-server
+
+hrr_rb_sftp can be an alternative with replacing the line in the config file. (After editing the config, reloading or restarting sshd is required.)
+
+    $ cat /etc/ssh/sshd_config | grep Subsystem
+    #Subsystem  sftp    /usr/lib/openssh/sftp-server    # Comment out the original line
+    Subsystem   sftp    /path/to/hrr_rb_sftp_server.rb
+
+Where, the /path/to/hrr_rb_sftp_server.rb code is the same as shown above.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hirura/hrr_rb_sftp. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hirura/hrr_rb_sftp/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the HrrRbSftp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hirura/hrr_rb_sftp/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hrr_rb_sftp"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/demo/hrr_rb_sftp_server.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "logger"
+
+begin
+  require 'hrr_rb_sftp'
+rescue LoadError
+  $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'hrr_rb_sftp'
+end
+
+class MyLoggerFormatter < ::Logger::Formatter
+  def call severity, time, progname, msg
+    "%s, [%s#%d.%x] %5s -- %s: %s\n" % [severity[0..0], format_datetime(time), Process.pid, Thread.current.object_id, severity, progname, msg2str(msg)]
+  end
+end
+
+logger = Logger.new(File.join(File.dirname(__FILE__), "hrr_rb_sftp_server.log"))
+logger.level = Logger::INFO
+logger.formatter = MyLoggerFormatter.new
+
+server = HrrRbSftp::Server.new(logger: logger)
+server.start $stdin, $stdout, $stderr

data/demo/instantiate_hrr_rb_sftp_server.rb

@@ -0,0 +1,67 @@
+require 'logger'
+require 'socket'
+require 'hrr_rb_ssh'
+
+begin
+  require 'hrr_rb_sftp'
+rescue LoadError
+  $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'hrr_rb_sftp'
+end
+
+class MyLoggerFormatter < ::Logger::Formatter
+  def call severity, time, progname, msg
+    "%s, [%s#%d.%x] %5s -- %s: %s\n" % [severity[0..0], format_datetime(time), Process.pid, Thread.current.object_id, severity, progname, msg2str(msg)]
+  end
+end
+
+logger = Logger.new(File.join(File.dirname(__FILE__), "instantiate_hrr_rb_sftp_server.log"))
+logger.level = Logger::INFO
+logger.formatter = MyLoggerFormatter.new
+
+auth_publickey = HrrRbSsh::Authentication::Authenticator.new { |ctx|
+  true # accept any user
+}
+
+conn_subsys = HrrRbSsh::Connection::RequestHandler.new { |ctx|
+  ctx.chain_proc { |chain|
+    case ctx.subsystem_name
+    when 'sftp'
+      sftp_server = HrrRbSftp::Server.new(logger: logger)
+      sftp_server.start(ctx.io[0], ctx.io[1], ctx.io[2])
+      exitstatus = 0
+    else
+      exitstatus = 1
+    end
+    exitstatus
+  }
+}
+
+options = {}
+options['authentication_publickey_authenticator'] = auth_publickey
+options['connection_channel_request_subsystem']   = conn_subsys
+
+server = TCPServer.new 10022
+while true
+  Thread.new(server.accept) do |io|
+    begin
+      pid = fork do
+        begin
+          ssh_server = HrrRbSsh::Server.new(options, logger: logger)
+          ssh_server.start io
+        rescue => e
+          logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+          exit false
+        end
+      end
+      logger.info { "process #{pid} started" }
+      io.close rescue nil
+      pid, status = Process.waitpid2(pid)
+    rescue => e
+      logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+    ensure
+      status ||= nil
+      logger.info { "process #{pid} finished with status #{status.inspect}" }
+    end
+  end
+end

data/demo/spawn_hrr_rb_sftp_server.rb

@@ -0,0 +1,66 @@
+require 'logger'
+require 'socket'
+require 'hrr_rb_ssh'
+
+begin
+  require 'hrr_rb_sftp'
+rescue LoadError
+  $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'hrr_rb_sftp'
+end
+
+class MyLoggerFormatter < ::Logger::Formatter
+  def call severity, time, progname, msg
+    "%s, [%s#%d.%x] %5s -- %s: %s\n" % [severity[0..0], format_datetime(time), Process.pid, Thread.current.object_id, severity, progname, msg2str(msg)]
+  end
+end
+
+logger = Logger.new(File.join(File.dirname(__FILE__), "spawn_hrr_rb_sftp_server.log"))
+logger.level = Logger::INFO
+logger.formatter = MyLoggerFormatter.new
+
+auth_publickey = HrrRbSsh::Authentication::Authenticator.new { |ctx|
+  true # accept any user
+}
+
+conn_subsys = HrrRbSsh::Connection::RequestHandler.new { |ctx|
+  ctx.chain_proc { |chain|
+    case ctx.subsystem_name
+    when 'sftp'
+      pid = spawn(File.join(File.dirname(__FILE__), "hrr_rb_sftp_server.rb"), {in: ctx.io[0], out: ctx.io[1], err: ctx.io[2]})
+      exitstatus = Process.waitpid(pid).to_i
+    else
+      exitstatus = 1
+    end
+    exitstatus
+  }
+}
+
+options = {}
+options['authentication_publickey_authenticator'] = auth_publickey
+options['connection_channel_request_subsystem']   = conn_subsys
+
+server = TCPServer.new 10022
+while true
+  Thread.new(server.accept) do |io|
+    begin
+      pid = fork do
+        begin
+          ssh_server = HrrRbSsh::Server.new(options, logger: logger)
+          ssh_server.start io
+        rescue => e
+          logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+          exit false
+        end
+      end
+      logger.info { "process #{pid} started" }
+      io.close rescue nil
+      pid, status = Process.waitpid2(pid)
+    rescue => e
+      logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+    ensure
+      status ||= nil
+      logger.info { "process #{pid} finished with status #{status.inspect}" }
+    end
+  end
+end