Skip to content

Commit f6cbb4e

Browse files
committed
Fix comments
1 parent 162ff1a commit f6cbb4e

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

services/auth/reverseproxy.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ const ReverseProxyMethodName = "reverse_proxy"
2828
// ReverseProxy implements the Auth interface, but actually relies on
2929
// a reverse proxy for authentication of users.
3030
// On successful authentication the proxy is expected to populate the username in the
31-
// "setting.ReverseProxyAuthUser" header. Optionally it can also populate the email of the
31+
// "setting.ReverseProxyAuth.ReverseProxyAuthUser" header. Optionally it can also populate the email of the
3232
// user in the "setting.ReverseProxyAuthEmail" header.
3333
type ReverseProxy struct{}
3434

35-
// getUserName extracts the username from the "setting.ReverseProxyAuthUser" header
35+
// getUserName extracts the username from the "setting.ReverseProxyAuth.ReverseProxyAuthUser" header
3636
func (r *ReverseProxy) getUserName(req *http.Request) string {
3737
return strings.TrimSpace(req.Header.Get(setting.ReverseProxyAuth.ReverseProxyAuthUser))
3838
}
@@ -42,11 +42,11 @@ func (r *ReverseProxy) Name() string {
4242
return ReverseProxyMethodName
4343
}
4444

45-
// getUserFromAuthUser extracts the username from the "setting.ReverseProxyAuthUser" header
45+
// getUserFromAuthUser extracts the username from the "setting.ReverseProxyAuth.ReverseProxyAuthUser" header
4646
// of the request and returns the corresponding user object for that name.
4747
// Verification of header data is not performed as it should have already been done by
4848
// the reverse proxy.
49-
// If a username is available in the "setting.ReverseProxyAuthUser" header an existing
49+
// If a username is available in the "setting.ReverseProxyAuth.ReverseProxyAuthUser" header an existing
5050
// user object is returned (populated with username or email found in header).
5151
// Returns nil if header is empty.
5252
func (r *ReverseProxy) getUserFromAuthUser(req *http.Request) (*user_model.User, error) {

0 commit comments

Comments
 (0)