Class: HTAuth::CLI::Digest

Inherits:
Object
  • Object
show all
Defined in:
lib/htauth/cli/digest.rb

Overview

Internal: Implemenation of the commandline htdigest-ruby

Constant Summary collapse

MAX_PASSWD_LENGTH = 
255

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Digest

Returns a new instance of Digest.



15
16
17
18
19
 
# File 'lib/htauth/cli/digest.rb', line 15

def initialize
  @digest_file = nil
  @option_parser = nil
  @options = nil
end

Instance Attribute Details

#digest_file ⇒ Object

Returns the value of attribute digest_file.



13
14
15
 
# File 'lib/htauth/cli/digest.rb', line 13

def digest_file
  @digest_file
end

Instance Method Details

#option_parser ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/htauth/cli/digest.rb', line 35

def option_parser
  if not @option_parser then
    @option_parser = OptionParser.new(nil, 14) do |op|
      op.banner = "Usage: #{op.program_name} [options] passwordfile realm username"
      op.on("-c", "--create", "Create a new digest password file; this overwrites an existing file.") do |c|
        options.file_mode = DigestFile::CREATE
      end

      op.on("-D", "--delete", "Delete the specified user.") do |d|
        options.delete_entry = d
      end

      op.on("-h", "--help", "Display this help.") do |h|
        options.show_help = h
      end

      op.on("-v", "--version", "Show version info.") do |v|
        options.show_version = v
      end
    end
  end
  @option_parser
end

#options ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/htauth/cli/digest.rb', line 21

def options
  if @options.nil? then
    @options                = ::OpenStruct.new
    @options.show_version   = false
    @options.show_help      = false
    @options.file_mode      = DigestFile::ALTER
    @options.passwdfile     = nil
    @options.realm          = nil
    @options.username       = nil
    @options.delete_entry   = false
  end
  @options
end

#parse_options(argv) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/htauth/cli/digest.rb', line 69

def parse_options(argv)
  begin
    option_parser.parse!(argv)
    show_version if options.show_version
    show_help if options.show_help or argv.size < 3

    options.passwdfile = argv.shift
    options.realm      = argv.shift
    options.username   = argv.shift
  rescue ::OptionParser::ParseError => pe
    $stderr.puts "ERROR: #{option_parser.program_name} - #{pe}"
    $stderr.puts "Try `#{option_parser.program_name} --help` for more information"
    exit 1
  end
end

#run(argv, env = ENV) ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/htauth/cli/digest.rb', line 85

def run(argv, env = ENV)
  begin
    parse_options(argv)
    digest_file = DigestFile.new(options.passwdfile, options.file_mode)

    if options.delete_entry then
      digest_file.delete(options.username, options.realm)
    else
      console = Console.new

      action = digest_file.has_entry?(options.username, options.realm) ? "Changing" : "Adding"

      console.say "#{action} password for #{options.username} in realm #{options.realm}."

      pw_in       = console.ask("        New password: ")
      raise PasswordError, "password '#{pw_in}' too long" if pw_in.length >= MAX_PASSWD_LENGTH

      pw_validate = console.ask("Re-type new password: ")
      raise PasswordError, "They don't match, sorry." unless pw_in == pw_validate

      digest_file.add_or_update(options.username, options.realm, pw_in)
    end

    digest_file.save!

  rescue HTAuth::FileAccessError => fae
    msg = "Could not open password file #{options.passwdfile} "
    $stderr.puts "#{msg}: #{fae.message}"
    $stderr.puts fae.backtrace.join("\n")
    exit 1
  rescue HTAuth::Error => pe
    $stderr.puts "#{pe.message}"
    exit 1
  rescue SignalException => se
    $stderr.puts
    $stderr.puts "Interrupted #{se}"
    exit 1
  end
  exit 0
end

#show_help ⇒ Object 



59
60
61
62
 
# File 'lib/htauth/cli/digest.rb', line 59

def show_help
  $stdout.puts option_parser
  exit 1
end

#show_version ⇒ Object 



64
65
66
67
 
# File 'lib/htauth/cli/digest.rb', line 64

def show_version
  $stdout.puts "#{option_parser.program_name}: version #{HTAuth::VERSION}"
  exit 1
end