/
httpauth.go
63 lines (55 loc) · 2.16 KB
/
httpauth.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
// Copyright 2020-2022 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package httpauth
import (
"net/http"
"github.com/bufbuild/buf/private/pkg/app"
)
// Authenticator adds authentication to request.
//
// This could be instead replaced with a http.RoundTripper workflow, however
// this means we have to use the same http.Client, and we generally pass EnvContainers
// to functions right now, and not building objects with EnvContainers, so this would
// not fit in with the rest of this codebase. This should be re-evaluated though.
type Authenticator interface {
// SetAuth sets authentication on the request.
//
// Returns true if authentication successfully set.
// Does nothing and returns false if no authentication available for the given request.
// Does nothing and returns false if the request scheme is not https.
SetAuth(envContainer app.EnvContainer, request *http.Request) (bool, error)
}
// NewEnvAuthenticator returns a new env Authenticator for the environment.
func NewEnvAuthenticator(usernameKey string, passwordKey string) Authenticator {
return newEnvAuthenticator(
usernameKey,
passwordKey,
)
}
// NewNetrcAuthenticator returns a new netrc Authenticator.
func NewNetrcAuthenticator() Authenticator {
return newNetrcAuthenticator()
}
// NewNopAuthenticator returns a new nop Authenticator.
//
// Always returns false and nil.
func NewNopAuthenticator() Authenticator {
return newNopAuthenticator()
}
// NewMultiAuthenticator returns a new multi Authenticator.
//
// Stops on first matching SetAuth request.
func NewMultiAuthenticator(authenticators ...Authenticator) Authenticator {
return newMultiAuthenticator(authenticators...)
}