password.rb

#   Copyright 2012-2013 Barry Allard <[email protected]>
#   Copyright 2014 Justin W. Smith <[email protected]>
#   All rights reserved.
#
#   Redistribution and use in source and binary forms, with or without modification, 
#   are permitted provided that the following conditions are met:
#
#     1. Redistributions of source code must retain the above copyright notice, this
#        list of conditions and the following disclaimer.
#
#     2. Redistributions in binary form must reproduce the above copyright notice,
#        this list of conditions and the following disclaimer in the documentation 
#        and/or other materials provided with the distribution.
#
#     3. The names of its contributors may not be used to endorse or promote products 
#        derived from this software without specific prior written permission.
#
#   THIS SOFTWARE  IS PROVIDED BY THE  COPYRIGHT HOLDERS AND  CONTRIBUTORS "AS IS" AND
#   ANY EXPRESS  OR IMPLIED  WARRANTIES,  INCLUDING, BUT  NOT LIMITED TO,  THE IMPLIED 
#   WARRANTIES OF MERCHANTABILITY AND FITNESS  FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
#   IN NO EVENT SHALL THE  COPYRIGHT HOLDER OR  CONTRIBUTORS  BE LIABLE FOR ANY DIRECT,
#   INDIRECT,  INCIDENTAL,  SPECIAL, EXEMPLARY,  OR  CONSEQUENTIAL  DAMAGES (INCLUDING,
#   BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
#   OR  PROFITS;  OR  BUSINESS INTERRUPTION)  HOWEVER  CAUSED  AND  ON  ANY  THEORY OF 
#   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 
#   OTHERWISE) ARISING IN ANY WAY OUT OF THE  USE OF THIS SOFTWARE, EVEN IF ADVISED OF
#   THE POSSIBILITY OF SUCH DAMAGE.

# Ask for a password from CLI, 
# if it exists.

# Forked from https://gist.github.com/steakknife/2040373

module Password

  # --- Platform inspectors

  def windows? ; RUBY_PLATFORM =~ /win(32|dows|ce)|djgpp|(ms|cyg|bcc)win|mingw32/i end
  def jruby?   ; RUBY_PLATFORM =~ /java/i      end
  def os2?     ; RUBY_PLATFORM =~ /os2/i       end
  def beos?    ; RUBY_PLATFORM =~ /beos/i      end
  def unix?    ; !jruby? && !windows? && !os2? && !beos end
                                                                #  NOTE: 99.999% of mac detection code has a subtle flaw.
                                                                #  i.e.:    RUBY_PLATFORM =~ /darwin|apple|mac/i

    def mac?     ; RUBY_PLATFORM =~ /.*(sal|86).*-darwin1/i end #  e.g.. 'x86_64-darwin11.3.0'       MRI 1.9.3      Lion
                                                                #        'x86_64-apple-darwin11.3.0' Rubinius       Lion
                                                                #        'i686-darwin11.3.0'         RubyEnterprise Lion
                                                                #        'universal-darwin10.0'      MacRuby        Lion

    def ios?     ; RUBY_PLATFORM =~ /arm-darwin/i     end       #  e.g., 'arm-darwin9'

                                                                #              Can you spot the implication?

    def linux?   ; RUBY_PLATFORM =~ /linux/i          end
      # patches welcome: rh, oel, sl, slc, cent, fed, ubt, deb, mint, sles, suse, arch, parabola, nixos, ad ⧝
    def bsd?     ; freebsd? || netbsd? || openbsd?    end 
      def freebsd? ; RUBY_PLATFORM =~ /freebsd/i        end
      def netbsd?  ; RUBY_PLATFORM =~ /netbsd/i         end
      def openbsd? ; RUBY_PLATFORM =~ /openbsd/i        end
    def solaris? ; RUBY_PLATFORM =~ /solaris/i        end

  # TODO: cleanly chain signal handlers to prevent leaving -(echo|icanon) 

  # --- Lé code

  def ask_for_password_on_unix(prompt = "Enter password: ")
    raise 'Could not ask for password because there is no interactive terminal (tty)' unless $stdin.tty?
    unless prompt.nil?
      $stderr.print prompt 
      $stderr.flush
    end
    raise 'Could not disable echo to ask for password security' unless system 'stty -echo -icanon'
    password = $stdin.gets
    password.chomp! if password
    password
  ensure
    raise 'Could not re-enable echo while securely asking for password' unless system 'stty echo icanon'
  end

  alias :ask_for_password_on_linux :ask_for_password_on_unix

  def ask_for_password_on_windows(prompt = "Enter password: ")
    raise 'Could not ask for password because there is no interactive terminal (tty)' unless $stdin.tty?

    require 'Win32API'

    char = nil
    password = ''

    unless prompt.nil?
      $stderr.print prompt 
      $stderr.flush
    end

    while char = Win32API.new("crtdll", "_getch", [ ], "L").Call do
      break if char == 10 || char == 13 # return or newline
      if char == 127 || char == 8 # backspace and delete
        password[-1] = ' '
        password.slice!(-1, 1)
      else
        password << char.chr
      end
    end
    char = ' '

    $stderr.puts
    password
  end

  def ask_for_password_on_jruby(prompt = "Enter password: ")
    raise 'Could not ask for password because there is no interactive terminal (tty)' unless $stdin.tty?

    password=''

    require 'java'
    include_class 'java.lang.System'
    include_class 'java.io.Console'

    unless prompt.nil?
      $stderr.print prompt 
      $stderr.flush  
    end

    console = System.console()
    return unless console != java.null
    loop do
      break unless (read_passwd = console.readPassword()) != java.null
      passwd_chr = java.lang.String.new(read_passwd).to_string
      case passwd_chr
        when "\e" # ESC
          password.length.times do |i|
            password[i] = ' '
          end
          return nil
        when "", "\r", "\n" # Enter (for certain), ..., ...
          break
        when "\177", "\b" # Ctrl-H, Bkspace
          if password.length > 0       
            password[-1] = ' '
            password.slice!(-1, 1)
          end
        when "\004" # Ctrl-D
          password.length.times do |i|
            password[i] = ' '
          end
          password = ''
        else
          password << passwd_chr
      end
    end

    $stderr.puts
    passwd
  end

  def ask(prompt = "Enter password: ")
    %w|linux windows unix jruby|.each do |platform|
      if self.send("#{platform}?")
        return self.send("ask_for_password_on_#{platform}".to_sym, prompt) 
      end
    end
    raise "Could not read password on unknown Ruby platform: #{RUBY_DESCRIPTION}"
  end
end