ri > WEBrick::HTTPAuth::BasicAuth

man perldoc info pydoc3 ri search

WEBrick::HTTPAuth::BasicAuth < Object

📦 Includes

Authenticator (from /home/chedong/.local/share/rdoc)

🚀 Quick Reference

Use Case	Command	Description
🔐 Create a BasicAuth instance	WEBrick::HTTPAuth::BasicAuth.new config	Create a new basic authenticator with a configuration hash
🔑 Set user password	htpasswd.set_passwd realm, username, password	Set or update a password for a user in the given realm
💾 Write password file	htpasswd.flush	Write the password database to disk
👤 Authenticate request	basic_auth.authenticate request, response	Authenticate a request (returns user or fails)
⚠️ Send challenge	basic_auth.challenge request, response	Send a 401 Unauthorized challenge to the client
📄 Get logger	basic_auth.logger	Return the logger object (attr_reader)
🌐 Get realm	basic_auth.realm	Return the authentication realm (attr_reader)
🗄️ Get user database	basic_auth.userdb	Return the user database object (attr_reader)

📖 Description

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 Methods

• make_passwd
• new

🔧 Instance Methods

• authenticate
• challenge
• logger
• realm
• userdb

📋 Attributes

• logger (attr_reader)
• realm (attr_reader)
• userdb (attr_reader)

WEBrick::HTTPAuth::BasicAuth < Object 📦 Includes 🚀 Quick Reference 📖 Description 🧩 Class Methods 🔧 Instance Methods 📋 Attributes