-
Notifications
You must be signed in to change notification settings - Fork 348
/
authenticator.go
169 lines (135 loc) · 5.2 KB
/
authenticator.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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
package remoteauthenticator
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"time"
"github.com/go-openapi/swag"
"github.com/treeverse/lakefs/pkg/auth"
"github.com/treeverse/lakefs/pkg/auth/model"
"github.com/treeverse/lakefs/pkg/logging"
)
const remoteAuthSource = "remote_authenticator"
var ErrBadConfig = errors.New("invalid configuration")
// AuthenticatorConfig holds authentication configuration.
type AuthenticatorConfig struct {
// Enabled if set true will enable authenticator
Enabled bool
// Endpoint URL of the remote authentication service (e.g. https://my-auth.example.com/auth)
Endpoint string
// DefaultUserGroup is the default group for the users authenticated by the remote service
DefaultUserGroup string
// RequestTimeout timeout for remote authentication requests
RequestTimeout time.Duration
}
// AuthenticationRequest is the request object that will be sent to the remote authenticator service as JSON payload in a POST request
type AuthenticationRequest struct {
Username string `json:"username"`
Password string `json:"password"`
}
// AuthenticationResponse is the expected response from the remote authenticator service
type AuthenticationResponse struct {
// ExternalUserIdentifier is optional, if returned then the user will be used as the official username in lakeFS
ExternalUserIdentifier *string `json:"external_user_identifier,omitempty"`
}
// Authenticator client
type Authenticator struct {
AuthService auth.Service
Logger logging.Logger
Config AuthenticatorConfig
client *http.Client
}
func NewAuthenticator(conf AuthenticatorConfig, authService auth.Service, logger logging.Logger) (*Authenticator, error) {
if conf.Endpoint == "" {
return nil, fmt.Errorf("endpoint is empty: %w", ErrBadConfig)
}
httpClient := &http.Client{Timeout: conf.RequestTimeout}
log := logger.WithField("service_name", remoteAuthSource)
log.WithFields(logging.Fields{
"auth_url": conf.Endpoint,
"request_timeout": httpClient.Timeout,
}).Info("initializing remote authenticator")
return &Authenticator{
Logger: log,
Config: conf,
AuthService: authService,
client: httpClient,
}, nil
}
func (ra *Authenticator) doRequest(ctx context.Context, log logging.Logger, username, password string) (*AuthenticationResponse, error) {
payload, err := json.Marshal(&AuthenticationRequest{Username: username, Password: password})
if err != nil {
return nil, fmt.Errorf("failed marshaling request body: %w", err)
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, ra.Config.Endpoint, bytes.NewReader(payload))
if err != nil {
return nil, fmt.Errorf("failed creating request to remote authenticator: %w", err)
}
req.Header.Set("Content-Type", "application/json")
log = log.WithField("url", req.URL.String())
log.Trace("starting http request to remote authenticator")
resp, err := ra.client.Do(req)
if err != nil {
return nil, fmt.Errorf("failed sending request to remote authenticator: %w", err)
}
defer func() { _ = resp.Body.Close() }()
log = log.WithField("status_code", resp.StatusCode)
if resp.StatusCode < http.StatusOK || resp.StatusCode >= 300 {
return nil, fmt.Errorf("bad status code %d: %w", resp.StatusCode, auth.ErrUnexpectedStatusCode)
}
log.Debug("got response from remote authenticator")
body, err := io.ReadAll(resp.Body)
if err != nil {
return nil, fmt.Errorf("failed reading response body: %w", err)
}
var res AuthenticationResponse
if err := json.Unmarshal(body, &res); err != nil {
return nil, fmt.Errorf("unmarshaling authenticator response %s: %w", username, err)
}
return &res, nil
}
func (ra *Authenticator) AuthenticateUser(ctx context.Context, username, password string) (string, error) {
log := ra.Logger.WithContext(ctx).WithField("input_username", username)
res, err := ra.doRequest(ctx, log, username, password)
if err != nil {
return "", err
}
dbUsername := username
// if the external authentication service provided an external user identifier, use it as the username
externalUserIdentifier := swag.StringValue(res.ExternalUserIdentifier)
if externalUserIdentifier != "" {
log = log.WithField("external_user_identifier", externalUserIdentifier)
dbUsername = externalUserIdentifier
}
user, err := ra.AuthService.GetUser(ctx, dbUsername)
if err == nil {
log.WithField("user", fmt.Sprintf("%+v", user)).Debug("Got existing user")
return user.Username, nil
}
if !errors.Is(err, auth.ErrNotFound) {
return "", fmt.Errorf("get user %s: %w", dbUsername, err)
}
log.Info("first time remote authenticated user, creating them")
newUser := &model.User{
CreatedAt: time.Now().UTC(),
Username: dbUsername,
FriendlyName: &username,
Source: remoteAuthSource,
}
_, err = ra.AuthService.CreateUser(ctx, newUser)
if err != nil {
return "", fmt.Errorf("create backing user for remote auth user %s: %w", newUser.Username, err)
}
err = ra.AuthService.AddUserToGroup(ctx, newUser.Username, ra.Config.DefaultUserGroup)
if err != nil {
return "", fmt.Errorf("add newly created remote auth user %s to %s: %w", newUser.Username, ra.Config.DefaultUserGroup, err)
}
return newUser.Username, nil
}
func (ra *Authenticator) String() string {
return remoteAuthSource
}