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

In Files

  • webrick/httpauth/basicauth.rb

WEBrick::HTTPAuth::BasicAuth

Constants

AuthScheme

Attributes

logger[R]
realm[R]
userdb[R]

Public Class Methods

make_passwd(realm, user, pass) click to toggle source
 
               # File webrick/httpauth/basicauth.rb, line 21
def self.make_passwd(realm, user, pass)
  pass ||= ""
  pass.crypt(Utils::random_string(2))
end
            
new(config, default=Config::BasicAuth) click to toggle source
 
               # File webrick/httpauth/basicauth.rb, line 28
def initialize(config, default=Config::BasicAuth)
  check_init(config)
  @config = default.dup.update(config)
end
            

Public Instance Methods

authenticate(req, res) click to toggle source
 
               # File webrick/httpauth/basicauth.rb, line 33
def authenticate(req, res)
  unless basic_credentials = check_scheme(req)
    challenge(req, res)
  end
  userid, password = basic_credentials.unpack("m*")[0].split(":", 2)
  password ||= ""
  if userid.empty?
    error("user id was not given.")
    challenge(req, res)
  end
  unless encpass = @userdb.get_passwd(@realm, userid, @reload_db)
    error("%s: the user is not allowed.", userid)
    challenge(req, res)
  end
  if password.crypt(encpass) != encpass
    error("%s: password unmatch.", userid)
    challenge(req, res)
  end
  info("%s: authentication succeeded.", userid)
  req.user = userid
end
            
challenge(req, res) click to toggle source
 
               # File webrick/httpauth/basicauth.rb, line 55
def challenge(req, res)
  res[@response_field] = "#{@auth_scheme} realm=\"#{@realm}\""
  raise @auth_exception
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