Fix golint errors in users.go

Author: abbot

users.go

@@ -6,18 +6,14 @@ import (
 	"sync"
 )
 
-/*
- SecretProvider is used by authenticators. Takes user name and realm
- as an argument, returns secret required for authentication (HA1 for
- digest authentication, properly encrypted password for basic).
-
- Returning an empty string means failing the authentication.
-*/
+// SecretProvider is used by authenticators. Takes user name and realm
+// as an argument, returns secret required for authentication (HA1 for
+// digest authentication, properly encrypted password for basic).
+//
+// Returning an empty string means failing the authentication.
 type SecretProvider func(user, realm string) string
 
-/*
- Common functions for file auto-reloading
-*/
+// File handles automatic file reloading on changes.
 type File struct {
 	Path string
 	Info os.FileInfo
@@ -26,6 +22,11 @@ type File struct {
 	mu     sync.Mutex
 }
 
+// ReloadIfNeeded checks file Stat and calls Reload() if any changes
+// were detected. File mutex is Locked for the duration of Reload()
+// call.
+//
+// This function will panic() if Stat fails.
 func (f *File) ReloadIfNeeded() {
 	info, err := os.Stat(f.Path)
 	if err != nil {
@@ -39,27 +40,26 @@ func (f *File) ReloadIfNeeded() {
 	}
 }
 
-/*
- Structure used for htdigest file authentication. Users map realms to
- maps of users to their HA1 digests.
-*/
+// HtdigestFile is a File holding htdigest authentication data.
 type HtdigestFile struct {
+	// File is used for automatic reloading of the authentication data.
 	File
+	// Users is a map of realms to users to HA1 digests.
 	Users map[string]map[string]string
 	mu    sync.RWMutex
 }
 
-func reload_htdigest(hf *HtdigestFile) {
+func reloadHTDigest(hf *HtdigestFile) {
 	r, err := os.Open(hf.Path)
 	if err != nil {
 		panic(err)
 	}
-	csv_reader := csv.NewReader(r)
-	csv_reader.Comma = ':'
-	csv_reader.Comment = '#'
-	csv_reader.TrimLeadingSpace = true
+	reader := csv.NewReader(r)
+	reader.Comma = ':'
+	reader.Comment = '#'
+	reader.TrimLeadingSpace = true
 
-	records, err := csv_reader.ReadAll()
+	records, err := reader.ReadAll()
 	if err != nil {
 		panic(err)
 	}
@@ -76,14 +76,12 @@ func reload_htdigest(hf *HtdigestFile) {
 	}
 }
 
-/*
- SecretProvider implementation based on htdigest-formated files. Will
- reload htdigest file on changes. Will panic on syntax errors in
- htdigest files.
-*/
+// HtdigestFileProvider is a SecretProvider implementation based on
+// htdigest-formated files. It will automatically reload htdigest file
+// on changes. It panics on syntax errors in htdigest files.
 func HtdigestFileProvider(filename string) SecretProvider {
 	hf := &HtdigestFile{File: File{Path: filename}}
-	hf.Reload = func() { reload_htdigest(hf) }
+	hf.Reload = func() { reloadHTDigest(hf) }
 	return func(user, realm string) string {
 		hf.ReloadIfNeeded()
 		hf.mu.RLock()
@@ -100,27 +98,27 @@ func HtdigestFileProvider(filename string) SecretProvider {
 	}
 }
 
-/*
- Structure used for htdigest file authentication. Users map users to
- their salted encrypted password
-*/
+// HtpasswdFile is a File holding basic authentication data.
 type HtpasswdFile struct {
+	// File is used for automatic reloading of the authentication data.
 	File
+	// Users is a map of users to their secrets (salted encrypted
+	// passwords).
 	Users map[string]string
 	mu    sync.RWMutex
 }
 
-func reload_htpasswd(h *HtpasswdFile) {
+func reloadHTPasswd(h *HtpasswdFile) {
 	r, err := os.Open(h.Path)
 	if err != nil {
 		panic(err)
 	}
-	csv_reader := csv.NewReader(r)
-	csv_reader.Comma = ':'
-	csv_reader.Comment = '#'
-	csv_reader.TrimLeadingSpace = true
+	reader := csv.NewReader(r)
+	reader.Comma = ':'
+	reader.Comment = '#'
+	reader.TrimLeadingSpace = true
 
-	records, err := csv_reader.ReadAll()
+	records, err := reader.ReadAll()
 	if err != nil {
 		panic(err)
 	}
@@ -133,14 +131,13 @@ func reload_htpasswd(h *HtpasswdFile) {
 	}
 }
 
-/*
- SecretProvider implementation based on htpasswd-formated files. Will
- reload htpasswd file on changes. Will panic on syntax errors in
- htpasswd files. Realm argument of the SecretProvider is ignored.
-*/
+// HtpasswdFileProvider is a SecretProvider implementation based on
+// htpasswd-formated files. It will automatically reload htpasswd file
+// on changes. It panics on syntax errors in htpasswd files. Realm
+// argument of the SecretProvider is ignored.
 func HtpasswdFileProvider(filename string) SecretProvider {
 	h := &HtpasswdFile{File: File{Path: filename}}
-	h.Reload = func() { reload_htpasswd(h) }
+	h.Reload = func() { reloadHTPasswd(h) }
 	return func(user, realm string) string {
 		h.ReloadIfNeeded()
 		h.mu.RLock()