文档
一个 项目

basic_auth

启用 HTTP Basic Authentication,可用于使用用户名和哈希密码保护目录和文件。

请注意,basic auth 在纯 HTTP 上是不安全的。 在决定使用 HTTP Basic Authentication 保护什么内容时请谨慎。

当用户请求受保护的资源时,如果用户尚未提供用户名和密码,浏览器将提示用户输入。如果 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> 是自定义 realm 名称。

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

  • <hashed_password> 是密码哈希。

示例

要求对 example.com 的所有请求进行身份验证

example.com {
	basic_auth {
		# Username "Bob", password "hiccup"
		Bob $2a$14$Zkx19XLiW6VYouLHR5NmfOFU0z2GTNmpkT/5qqR7hx4IjWJPDhjvG
	}
	respond "Welcome, {http.auth.user.id}" 200
}

保护 /secret/ 中的文件,以便只有 Bob 可以访问它们(任何人都可以查看其他路径)

example.com {
	root * /srv

	basic_auth /secret/* {
		# Username "Bob", password "hiccup"
		Bob $2a$14$Zkx19XLiW6VYouLHR5NmfOFU0z2GTNmpkT/5qqR7hx4IjWJPDhjvG
	}

	file_server
}