Extended maintenance of Ruby versions 1.8.7 and 1.9.2 ended on July 31, 2014. Read more

In Files

  • webrick/httpauth/htdigest.rb

WEBrick::HTTPAuth::Htdigest

Public Class Methods

new(path) click to toggle source
 
               # File webrick/httpauth/htdigest.rb, line 19
def initialize(path)
  @path = path
  @mtime = Time.at(0)
  @digest = Hash.new
  @mutex = Mutex::new
  @auth_type = DigestAuth
  open(@path,"a").close unless File::exist?(@path)
  reload
end
            

Public Instance Methods

delete_passwd(realm, user) click to toggle source
 
               # File webrick/httpauth/htdigest.rb, line 75
def delete_passwd(realm, user)
  if hash = @digest[realm]
    hash.delete(user)
  end
end
            
each() click to toggle source
 
               # File webrick/httpauth/htdigest.rb, line 81
def each
  @digest.keys.sort.each{|realm|
    hash = @digest[realm]
    hash.keys.sort.each{|user|
      yield([user, realm, hash[user]])
    }
  }
end
            
flush(output=nil) click to toggle source
 
               # File webrick/httpauth/htdigest.rb, line 47
def flush(output=nil)
  output ||= @path
  tmp = Tempfile.new("htpasswd", File::dirname(output))
  begin
    each{|item| tmp.puts(item.join(":")) }
    tmp.close
    File::rename(tmp.path, output)
  rescue
    tmp.close(true)
  end
end
            
get_passwd(realm, user, reload_db) click to toggle source
 
               # File webrick/httpauth/htdigest.rb, line 59
def get_passwd(realm, user, reload_db)
  reload() if reload_db
  if hash = @digest[realm]
    hash[user]
  end
end
            
reload() click to toggle source
 
               # File webrick/httpauth/htdigest.rb, line 29
def reload
  mtime = File::mtime(@path)
  if mtime > @mtime
    @digest.clear
    open(@path){|io|
      while line = io.gets
        line.chomp!
        user, realm, pass = line.split(/:/, 3)
        unless @digest[realm]
          @digest[realm] = Hash.new
        end
        @digest[realm][user] = pass
      end
    }
    @mtime = mtime
  end
end
            
set_passwd(realm, user, pass) click to toggle source
 
               # File webrick/httpauth/htdigest.rb, line 66
def set_passwd(realm, user, pass)
  @mutex.synchronize{
    unless @digest[realm]
      @digest[realm] = Hash.new
    end
    @digest[realm][user] = make_passwd(realm, user, pass)
  }
end
            

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit Documenting-ruby.org.

blog comments powered by Disqus