smb-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9611e08df4c60e4278781668b7ab2fc373432592
+  data.tar.gz: 184445b65f712ad037d2473e71abb2695859c743
+SHA512:
+  metadata.gz: 6d351cb503ff2aaa09c95345860bc0847ab4a0d8dc969d41ef6524cd129fe7969d534bd4f56f0c9232accb5114fcc512623d7bbcffc8372b0f8d9e64cda7efce
+  data.tar.gz: 91c220e9cfa602d920f0deeb2de33201d0dd8529aed86b94bf7b328cab10f4859a69c894c814150db319cf133d7b8b4ea2376e13f96a37fb78b4e5ff6c97adbb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.16.0

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 ralf@rherzog.de. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in smb-client.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    smb-client (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.10.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+  smb-client!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Ralf Herzog
+
+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,85 @@
+# SMB::Client
+
+SMB::Client is a wrapper around the smbclient binary installed on your system.
+
+Currently just the SMB2 protocol was tested.
+
+Inspired by the [sambala](https://github.com/lp/sambala) gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smb/client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smb-client
+
+## Usage
+
+### Setup
+
+```ruby
+options = {
+  host: 'Your host',
+  user: 'username',
+  share: 'share',
+  password: 'password',
+  version: 2
+}
+@smb_client = SMB::Client.new options
+```
+
+### List directories
+
+Always returns an array with `LsItem` elements.
+
+```ruby
+@smb_client.ls
+ls_items = @smb_client.ls 'subdirectory/'
+# => [#<SMB::ClientHelper::LsItem:0x007f3c58020468 @name=".", @type="D", @size=0, @change_time=2017-11-20 00:02:12 +0100>]
+current_dir = ls_items.find { |ls_item| ls_item.name == '.' }
+current_dir.file?      # => false
+current_dir.directory? # => true
+current_dir.hidden?    # => false
+```
+
+### Directories
+
+```ruby
+@smb_client.mkdir(directory) # => true or raises
+@smb_client.rmdir(directory) # => true or raises
+```
+
+### Files
+```ruby
+@smb_client.put(local_path, remote_path) # => true or raises
+@smb_client.write(content, local_path)   # => true or raises
+@smb_client.del(filename)  # => true or raises
+@smb_client.read(filename) # => Reads content of file
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/RalfHerzog/smb-client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 SMB::Client project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/RalfHerzog/smb-client/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'smb/client'
+
+# 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/lib/smb/client.rb

@@ -0,0 +1,2 @@
+require_relative 'client/version'
+require_relative 'client/client'

data/lib/smb/client/client.rb

@@ -0,0 +1,124 @@
+require 'pty'
+require 'expect'
+require 'open3'
+require 'timeout'
+
+require_relative 'connection_error'
+require_relative 'client_helper'
+require_relative 'runtime_error'
+
+module SMB
+  class Client
+    include ClientHelper
+
+    attr_accessor :executable, :pid
+
+    def initialize(options = {})
+      @executable = ENV.fetch('SMBCLIENT_EXECUTABLE') { 'smbclient' }
+      @options = {
+        user: options[:user],
+        share: options[:share],
+        password: options[:password],
+        version: options[:version] || 2,
+        host: options[:host] || 'localhost',
+        workgroup: options[:workgroup] || 'WORKGROUP'
+      }
+
+      Thread.abort_on_exception = true
+      connect
+
+      # Pipe used to pass commands to pty
+      @read1, @write1 = IO.pipe
+
+      # Pipe used to pass responses from pty
+      @read2, @write2 = IO.pipe
+
+      # Indicates if first output should be ignored
+      @first_message = true
+
+      @connection_established = false
+    end
+
+    def close
+      Process.kill('QUIT', @pid) == 1
+    end
+
+    def exec(cmd)
+      # Send command
+      @write1.puts cmd
+
+      # Wait for response
+      text = @read2.read
+
+      # Close previous pipe
+      @read2.close
+
+      # Create new pipe
+      @read2, @write2 = IO.pipe
+
+      # Raise at the end to support continuing
+      raise Client::RuntimeError, text if text.start_with? 'NT_STATUS_'
+
+      text
+    end
+
+    private
+
+    def connect
+      # Run +@executable+ in a separate thread to talk to hin asynchronosly
+      Thread.start do
+        # Spawn the actual +@executable+ pty with +input+ and +output+ handle
+        begin
+          PTY.spawn(@executable + ' ' + params) do |output, input, pid|
+            @pid = pid
+            output.sync = true
+            input.sync = true
+
+            # Write inputs to pty from +exec+ method
+            Thread.start do
+              while (line = @read1.readline)
+                input.puts line
+              end
+            end
+
+            @connection_established = true
+
+            # Wait for responses ending with input prompt
+            loop do
+              output.expect(/smb: \\>$/) { |text| handle_response text }
+            end
+          end
+        rescue Errno::EIO => e
+          if @connection_established
+            raise StandardError, "Unexpected error: [#{e.message}]"
+          else
+            raise Client::ConnectionError, 'Cannot connect to SMB server'
+          end
+        end
+      end
+    end
+
+    def params
+      @options.map do |k, v|
+        v.nil? && raise(Client::RuntimeError, "Missing option [:#{k}]")
+      end
+      "//#{@options[:host]}/#{@options[:share]} #{@options[:password]} \
+-U #{@options[:user]} #{@options[:workgroup]} -m SMB#{@options[:version]}"
+    end
+
+    def handle_response(text)
+      # Write to second pipe so the origin command invocation thread can
+      # receive this
+      if @first_message
+        @first_message = false
+        return
+      end
+
+      # Format responses
+      # Ignore command sent (the first returned line) and the last returned
+      # which is the smb prompt
+      @write2.write text[0].lines[1..-2].join
+      @write2.close
+    end
+  end
+end

data/lib/smb/client/client_helper.rb

@@ -0,0 +1,119 @@
+require 'time'
+require 'tempfile'
+
+module SMB
+  module ClientHelper
+    class LsItem
+      REGEX = /(?<name>[\.|\w]+)\s+(?<type>.)\s+(?<size>\d+)\s+(?<change_time>.+)/
+
+      attr_accessor :name, :type, :size, :change_time
+
+      def file?
+        @type.include? 'N'
+      end
+
+      def directory?
+        @type.include? 'D'
+      end
+
+      def hidden?
+        @type.include? 'H'
+      end
+
+      def self.from_line(line)
+        match_data = REGEX.match line
+        return nil unless match_data
+
+        item = LsItem.new
+        item.name = match_data['name']
+        item.type = match_data['type']
+        item.size = match_data['size'].to_i
+        item.change_time = Time.parse match_data['change_time']
+        item
+      end
+    end
+
+    def ls(mask = '', raise = true)
+      ls_items = []
+      output = exec 'ls ' + mask
+      output.lines.each do |line|
+        ls_item = LsItem.from_line(line)
+        ls_items << ls_item if ls_item
+      end
+      ls_items
+    rescue Client::RuntimeError => e
+      raise e if raise
+      []
+    end
+
+    alias dir ls
+
+    def mkdir(path, raise = true)
+      exec 'mkdir ' + path
+      true
+    rescue Client::RuntimeError => e
+      raise e if raise
+      false
+    end
+
+    def rmdir(path, raise = true)
+      exec 'rmdir ' + path
+      true
+    rescue Client::RuntimeError => e
+      raise e if raise
+      false
+    end
+
+    def put(from, to, overwrite = false, raise = true)
+      ls_items = ls to, false
+      if !overwrite && !ls_items.empty?
+        raise Client::RuntimeError, "File [#{to}] already exist"
+      end
+      exec 'put ' + from + ' ' + to
+      true
+    rescue Client::RuntimeError => e
+      raise e if raise
+      false
+    end
+
+    def write(content, to, overwrite = false, raise = true)
+      tempfile = Tempfile.new
+      tempfile.write content
+      tempfile.close
+
+      put tempfile.path, to, overwrite, raise
+    end
+
+    def del(path, raise = true)
+      exec 'del ' + path
+      true
+    rescue Client::RuntimeError => e
+      raise e if raise
+      false
+    end
+
+    alias rm del
+
+    def get(from, to = nil, overwrite = false, raise = true)
+      tempfile = Tempfile.new
+      to ||= tempfile.path
+      tempfile.unlink
+      if !overwrite && File.exist?(to)
+        raise Client::RuntimeError, "File [#{to}] already exist locally"
+      end
+      exec 'get ' + from + ' ' + to
+      to
+    rescue Client::RuntimeError => e
+      raise e if raise
+      false
+    end
+
+    def read(from, overwrite = false, raise = true)
+      tempfile = Tempfile.new
+      to = tempfile.path
+      tempfile.unlink
+      get from, to, overwrite, raise
+      File.read to
+    end
+  end
+end

data/lib/smb/client/connection_error.rb

@@ -0,0 +1,6 @@
+module SMB
+  class Client
+    class ConnectionError < ::StandardError
+    end
+  end
+end

data/lib/smb/client/runtime_error.rb

@@ -0,0 +1,6 @@
+module SMB
+  class Client
+    class RuntimeError < ::StandardError
+    end
+  end
+end

data/lib/smb/client/version.rb

@@ -0,0 +1,5 @@
+module SMB
+  class Client
+    VERSION = '0.1.0'.freeze
+  end
+end

data/smb-client.gemspec

@@ -0,0 +1,36 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smb/client/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'smb-client'
+  spec.version = SMB::Client::VERSION
+  spec.authors = ['Ralf Herzog']
+  spec.email = ['ralf@rherzog.de']
+
+  spec.summary = 'SMB Client wrapper for smbclient executable'
+  spec.description = 'SMB Client wrapper for smbclient executable'
+  spec.homepage = 'https://github.com/NetcomKassel/smb-client'
+  spec.license = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the
+  # 'allowed_push_host' to allow pushing to a single host or delete this section
+  # to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: smb-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ralf Herzog
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: SMB Client wrapper for smbclient executable
+email:
+- ralf@rherzog.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/smb/client.rb
+- lib/smb/client/client.rb
+- lib/smb/client/client_helper.rb
+- lib/smb/client/connection_error.rb
+- lib/smb/client/runtime_error.rb
+- lib/smb/client/version.rb
+- smb-client.gemspec
+homepage: https://github.com/NetcomKassel/smb-client
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: SMB Client wrapper for smbclient executable
+test_files: []