remove redundant bool return value from IsCorrect

Author: briskt

apikey.go

@@ -54,20 +54,20 @@ func (k *ApiKey) Hash() error {
 }
 
 // IsCorrect returns true if and only if the given string is a match for HashedSecret
-func (k *ApiKey) IsCorrect(given string) (bool, error) {
+func (k *ApiKey) IsCorrect(given string) error {
 	if given == "" {
-		return false, errors.New("secret to compare cannot be empty")
+		return errors.New("secret to compare cannot be empty")
 	}
 	if k.HashedSecret == "" {
-		return false, errors.New("cannot compare with empty hashed secret")
+		return errors.New("cannot compare with empty hashed secret")
 	}
 
 	err := bcrypt.CompareHashAndPassword([]byte(k.HashedSecret), []byte(given))
 	if err != nil {
-		return false, err
+		return err
 	}
 
-	return true, nil
+	return nil
 }
 
 // EncryptData uses the Secret to AES encrypt an arbitrary data block. It does not encrypt the key itself.

apikey_test.go

@@ -17,21 +17,18 @@ func TestApiKey_IsCorrect(t *testing.T) {
 		name         string
 		HashedSecret string
 		Given        string
-		want         bool
 		wantErr      bool
 	}{
 		{
 			name:         "valid secret",
 			HashedSecret: "$2y$10$Y.FlUK8q//DfybgFzNG2lONaJwvEFxHnCRo/r60BZbITDT6rOUhGa",
 			Given:        "abc123",
-			want:         true,
 			wantErr:      false,
 		},
 		{
 			name:         "invalid secret",
 			HashedSecret: "$2y$10$Y.FlUK8q//DfybgFzNG2lONaJwvEFxHnCRo/r60BZbITDT6rOUhGa",
 			Given:        "123abc",
-			want:         false,
 			wantErr:      true,
 		},
 	}
@@ -40,14 +37,11 @@ func TestApiKey_IsCorrect(t *testing.T) {
 			k := &ApiKey{
 				HashedSecret: tt.HashedSecret,
 			}
-			got, err := k.IsCorrect(tt.Given)
+			err := k.IsCorrect(tt.Given)
 			if (err != nil) != tt.wantErr {
 				t.Errorf("IsCorrect() error = %v, wantErr %v", err, tt.wantErr)
 				return
 			}
-			if got != tt.want {
-				t.Errorf("IsCorrect() got = %v, want %v", got, tt.want)
-			}
 		})
 	}
 }
@@ -79,15 +73,11 @@ func TestApiKey_Hash(t *testing.T) {
 				t.Error("hashed secret is empty after call to hash")
 				return
 			}
-			valid, err := k.IsCorrect(tt.Secret)
+			err = k.IsCorrect(tt.Secret)
 			if err != nil {
 				t.Errorf("hashed password not valid after hashing??? error: %s", err)
 				return
 			}
-			if !valid {
-				t.Error("hmm, password is not valid but no errors???")
-				return
-			}
 		})
 	}
 }

auth.go

@@ -42,15 +42,11 @@ func AuthenticateRequest(r *http.Request) (User, error) {
 		return nil, fmt.Errorf("api call attempted for not yet activated key: %s", apiKey.Key)
 	}
 
-	valid, err := apiKey.IsCorrect(secret)
+	err = apiKey.IsCorrect(secret)
 	if err != nil {
 		return nil, fmt.Errorf("failed to validate api key: %w", err)
 	}
 
-	if !valid {
-		return nil, fmt.Errorf("invalid api secret for key %s", key)
-	}
-
 	path := r.URL.Path
 	segments := strings.Split(strings.TrimPrefix(path, "/"), "/")
 	switch segments[0] {