mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
9749bfbf73
This adds a password_hash keyword argument to WEBrick::HTTPAuth::Htpasswd#initialize. If set to :bcrypt, it will create bcrypt hashes instead of crypt hashes, and will raise an exception if the .htpasswd file uses crypt hashes. If :bcrypt is used, then instead of calling BasicAuth.make_passwd (which uses crypt), WEBrick::HTTPAuth::Htpasswd#set_passwd will set the bcrypt password directly. It isn't possible to change the make_passwd API to accept the password hash format, as that would break configurations who use Htpasswd#auth_type= to set a custom auth_type. This modifies WEBrick::HTTPAuth::BasicAuth to handle checking both crypt and bcrypt hashes. There are commented out requires for 'string/crypt', to handle when String#crypt is deprecated and the undeprecated version is moved to a gem. There is also a commented out warning for the case when the password_hash keyword is not specified and 'string/crypt' cannot be required. I think the warning makes sense to nudge users to using bcrypt. I've updated the tests to test nil, :crypt, and :bcrypt values for the password_hash keyword, skipping the bcrypt tests if the bcrypt library cannot be required. [ruby-core:88111] [Feature #14940] From: Jeremy Evans <code@jeremyevans.net> git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@64060 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
116 lines
3.3 KiB
Ruby
116 lines
3.3 KiB
Ruby
# frozen_string_literal: false
|
|
#
|
|
# httpauth/basicauth.rb -- HTTP basic access authentication
|
|
#
|
|
# Author: IPR -- Internet Programming with Ruby -- writers
|
|
# Copyright (c) 2003 Internet Programming with Ruby writers. All rights
|
|
# reserved.
|
|
#
|
|
# $IPR: basicauth.rb,v 1.5 2003/02/20 07:15:47 gotoyuzo Exp $
|
|
|
|
require 'webrick/config'
|
|
require 'webrick/httpstatus'
|
|
require 'webrick/httpauth/authenticator'
|
|
|
|
module WEBrick
|
|
module HTTPAuth
|
|
|
|
##
|
|
# Basic Authentication for WEBrick
|
|
#
|
|
# Use this class to add basic authentication to a WEBrick servlet.
|
|
#
|
|
# Here is an example of how to set up a BasicAuth:
|
|
#
|
|
# config = { :Realm => 'BasicAuth example realm' }
|
|
#
|
|
# htpasswd = WEBrick::HTTPAuth::Htpasswd.new 'my_password_file', password_hash: :bcrypt
|
|
# htpasswd.set_passwd config[:Realm], 'username', 'password'
|
|
# htpasswd.flush
|
|
#
|
|
# config[:UserDB] = htpasswd
|
|
#
|
|
# basic_auth = WEBrick::HTTPAuth::BasicAuth.new config
|
|
|
|
class BasicAuth
|
|
include Authenticator
|
|
|
|
AuthScheme = "Basic" # :nodoc:
|
|
|
|
##
|
|
# Used by UserDB to create a basic password entry
|
|
|
|
def self.make_passwd(realm, user, pass)
|
|
pass ||= ""
|
|
pass.crypt(Utils::random_string(2))
|
|
end
|
|
|
|
attr_reader :realm, :userdb, :logger
|
|
|
|
##
|
|
# Creates a new BasicAuth instance.
|
|
#
|
|
# See WEBrick::Config::BasicAuth for default configuration entries
|
|
#
|
|
# You must supply the following configuration entries:
|
|
#
|
|
# :Realm:: The name of the realm being protected.
|
|
# :UserDB:: A database of usernames and passwords.
|
|
# A WEBrick::HTTPAuth::Htpasswd instance should be used.
|
|
|
|
def initialize(config, default=Config::BasicAuth)
|
|
check_init(config)
|
|
@config = default.dup.update(config)
|
|
end
|
|
|
|
##
|
|
# Authenticates a +req+ and returns a 401 Unauthorized using +res+ if
|
|
# the authentication was not correct.
|
|
|
|
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
|
|
|
|
case encpass
|
|
when /\A\$2[aby]\$/
|
|
password_matches = BCrypt::Password.new(encpass.sub(/\A\$2[aby]\$/, '$2a$')) == password
|
|
else
|
|
password_matches = password.crypt(encpass) == encpass
|
|
end
|
|
|
|
unless password_matches
|
|
error("%s: password unmatch.", userid)
|
|
challenge(req, res)
|
|
end
|
|
info("%s: authentication succeeded.", userid)
|
|
req.user = userid
|
|
end
|
|
|
|
##
|
|
# Returns a challenge response which asks for authentication information
|
|
|
|
def challenge(req, res)
|
|
res[@response_field] = "#{@auth_scheme} realm=\"#{@realm}\""
|
|
raise @auth_exception
|
|
end
|
|
end
|
|
|
|
##
|
|
# Basic authentication for proxy servers. See BasicAuth for details.
|
|
|
|
class ProxyBasicAuth < BasicAuth
|
|
include ProxyAuthenticator
|
|
end
|
|
end
|
|
end
|