basic_auth

启用 HTTP 基本认证，可用于通过用户名和哈希密码保护目录和文件。

请注意，基本认证在普通 HTTP 上不安全。 在决定使用 HTTP 基本认证保护什么内容时要谨慎。

当用户请求受保护的资源时，如果尚未提供用户名和密码，浏览器将提示用户输入。如果 Authorization 头中包含正确的凭据，服务器将授予对资源的访问权限。如果缺少该头或凭据不正确，服务器将响应 HTTP 401 Unauthorized。

Caddy 配置不接受明文密码；在将其放入配置之前，您必须对其进行哈希处理。 caddy hash-password 命令可以帮助您完成此操作。

成功认证后，将提供 {http.auth.user.id} 占位符，其中包含已认证的用户名。

在 v2.8.0 之前，此指令名为 basicauth，但为了与其他指令保持一致而重命名。

语法

basic_auth [<matcher>] [<hash_algorithm> [<realm>]] {
	<username> <hashed_password>
	...
}

• <hash_algorithm> 是用于此配置中哈希的密码哈希算法（或 KDF）的名称。默认值：bcrypt

• <realm> 是自定义领域名称。

• <username> 是用户名或用户 ID。

• <hashed_password> 是密码哈希。

示例

要求对 example.com 的所有请求进行认证：

example.com {
	basic_auth {
		# 用户名 "Bob"，密码 "hiccup"
		Bob $2a$14$Zkx19XLiW6VYouLHR5NmfOFU0z2GTNmpkT/5qqR7hx4IjWJPDhjvG
	}
	respond "Welcome, {http.auth.user.id}" 200
}

保护 /secret/ 中的文件，使只有 Bob 可以访问（任何人都可以查看其他路径）：

example.com {
	root * /srv

	basic_auth /secret/* {
		# 用户名 "Bob"，密码 "hiccup"
		Bob $2a$14$Zkx19XLiW6VYouLHR5NmfOFU0z2GTNmpkT/5qqR7hx4IjWJPDhjvG
	}

	file_server
}