Sha256: 83be81f09b5861b3d26794f4cf09d6b24603b1b38d126727071340598673f744

Contents?: true

Size: 1.95 KB

Versions: 28

Compression:

Stored size: 1.95 KB

Contents

require 'io/console'

module Net; module SSH

  # Default prompt implementation, called for asking password from user.
  # It will never be instantiated directly, but will instead be created for
  # you automatically.
  #
  # A custom prompt objects can implement caching, or different UI. The prompt
  # object should implemnted a start method, which should return something implementing
  # ask and success. Net::SSH uses it like:
  #
  #   prompter = options[:password_prompt].start({type:'password'})
  #   while !ok && max_retries < 3
  #     user = prompter.ask("user: ", {}, true)
  #     password = prompter.ask("password: ", {}, false)
  #     ok = send(user, password)
  #     prompter.sucess if ok
  #   end
  #
  class Prompt
    # factory
    def self.default(options = {})
      @default ||= new(options)
    end

    def initialize(options = {}); end

    # default prompt object implementation. More sophisticated implemenetations
    # might implement caching.
    class Prompter
      def initialize(info)
        if info[:type] == 'keyboard-interactive'
          $stdout.puts(info[:name]) unless info[:name].empty?
          $stdout.puts(info[:instruction]) unless info[:instruction].empty?
        end
      end

      # ask input from user, a prompter might ask for multiple inputs
      # (like user and password) in a single session.
      def ask(prompt, echo=true)
        $stdout.print(prompt)
        $stdout.flush
        ret = $stdin.noecho(&:gets).chomp
        $stdout.print("\n")
        ret
      end

      # success method will be called when the password was accepted
      # It's a good time to save password asked to a cache.
      def success; end
    end

    # start password session. Multiple questions might be asked multiple times
    # on the returned object. Info hash tries to uniquely identify the password
    # session, so caching implementations can save passwords properly.
    def start(info)
      Prompter.new(info)
    end
  end

end; end

Version data entries

28 entries across 25 versions & 3 rubygems

Version Path
vagrant-unbundled-2.2.7.0 vendor/bundle/ruby/2.4.0/gems/net-ssh-4.1.0/lib/net/ssh/prompt.rb
vagrant-unbundled-2.1.2.0 vendor/bundle/ruby/2.3.0/gems/net-ssh-4.2.0/lib/net/ssh/prompt.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.5.0/gems/net-ssh-4.2.0/lib/net/ssh/prompt.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.4.0/gems/net-ssh-4.2.0/lib/net/ssh/prompt.rb
vagrant-packet-0.1.1 vendor/bundle/ruby/2.3.0/gems/net-ssh-4.2.0/lib/net/ssh/prompt.rb
vagrant-unbundled-2.1.1.0 vendor/bundle/ruby/2.5.0/gems/net-ssh-4.2.0/lib/net/ssh/prompt.rb
vagrant-unbundled-2.0.4.0 vendor/bundle/ruby/2.5.0/gems/net-ssh-4.2.0/lib/net/ssh/prompt.rb
vagrant-unbundled-2.0.3.0 vendor/bundle/ruby/2.5.0/gems/net-ssh-4.2.0/lib/net/ssh/prompt.rb
net-ssh-5.0.0.beta1 lib/net/ssh/prompt.rb
vagrant-unbundled-2.0.2.0 vendor/bundle/ruby/2.5.0/gems/net-ssh-4.2.0/lib/net/ssh/prompt.rb
vagrant-unbundled-2.0.2.0 vendor/bundle/ruby/2.4.0/gems/net-ssh-4.1.0/lib/net/ssh/prompt.rb
vagrant-unbundled-2.0.1.0 vendor/bundle/ruby/2.4.0/gems/net-ssh-4.1.0/lib/net/ssh/prompt.rb
vagrant-unbundled-2.0.0.1 vendor/bundle/ruby/2.4.0/gems/net-ssh-4.1.0/lib/net/ssh/prompt.rb
net-ssh-4.2.0 lib/net/ssh/prompt.rb
vagrant-unbundled-1.9.8.1 vendor/bundle/ruby/2.4.0/gems/net-ssh-4.1.0/lib/net/ssh/prompt.rb
vagrant-unbundled-1.9.7.1 vendor/bundle/ruby/2.4.0/gems/net-ssh-4.1.0/lib/net/ssh/prompt.rb
net-ssh-4.2.0.rc2 lib/net/ssh/prompt.rb
net-ssh-4.2.0.rc1 lib/net/ssh/prompt.rb
vagrant-unbundled-1.9.5.1 vendor/bundle/ruby/2.4.0/gems/net-ssh-4.1.0/lib/net/ssh/prompt.rb
net-ssh-4.1.0 lib/net/ssh/prompt.rb