-
Notifications
You must be signed in to change notification settings - Fork 2
/
auth_provider.go
57 lines (45 loc) · 1.78 KB
/
auth_provider.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
/*
* © 2022-2023 Khulnasoft Limited
*
* 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 vulnmap
import (
"context"
"errors"
)
type AuthenticationFailedError struct {
ManualAuthentication bool
}
func (e *AuthenticationFailedError) Error() string {
const authFailMessage = "Failed to authenticate with Vulnmap. Please make sure you have a valid token. "
const autoAuthMessage = "You can reset the token to re-authenticate automatically."
message := authFailMessage
if !e.ManualAuthentication {
message += autoAuthMessage
}
return message
}
type AuthenticationFunction func() (string, error)
type AuthenticationProvider interface {
// Authenticate triggers the authentication. This may involve manual steps, like logging in using a browser
Authenticate(ctx context.Context) (string, error)
// ClearAuthentication removes all authentication information from the configuration
ClearAuthentication(ctx context.Context) error
// AuthURL returns the latest provided AuthenticationURL. This can be empty.
AuthURL(ctx context.Context) string
// SetAuthURL sets the latest provided Authentication URL. This is a temporary URL.
SetAuthURL(url string)
GetCheckAuthenticationFunction() AuthenticationFunction
}
var ErrEmptyAPIToken = errors.New("auth-provider: api token is not set")