forked from benthosdev/benthos
/
sasl.go
287 lines (258 loc) · 8.38 KB
/
sasl.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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
package kafka
import (
"context"
"errors"
"fmt"
"github.com/Shopify/sarama"
"github.com/dafanshu/benthos/v4/internal/bundle"
"github.com/dafanshu/benthos/v4/internal/component/cache"
"github.com/dafanshu/benthos/v4/internal/impl/aws/config"
ksasl "github.com/dafanshu/benthos/v4/internal/impl/kafka/sasl"
"github.com/dafanshu/benthos/v4/public/service"
"github.com/twmb/franz-go/pkg/sasl"
"github.com/twmb/franz-go/pkg/sasl/oauth"
"github.com/twmb/franz-go/pkg/sasl/plain"
"github.com/twmb/franz-go/pkg/sasl/scram"
)
func notImportedAWSFn(c *service.ParsedConfig) (sasl.Mechanism, error) {
return nil, errors.New("unable to configure AWS SASL as this binary does not import components/aws")
}
// AWSSASLFromConfigFn is populated with the child `aws` package when imported.
var AWSSASLFromConfigFn = notImportedAWSFn
func saslField() *service.ConfigField {
return service.NewObjectListField("sasl",
service.NewStringAnnotatedEnumField("mechanism", map[string]string{
"none": "Disable sasl authentication",
"PLAIN": "Plain text authentication.",
"OAUTHBEARER": "OAuth Bearer based authentication.",
"SCRAM-SHA-256": "SCRAM based authentication as specified in RFC5802.",
"SCRAM-SHA-512": "SCRAM based authentication as specified in RFC5802.",
"AWS_MSK_IAM": "AWS IAM based authentication as specified by the 'aws-msk-iam-auth' java library.",
}).
Description("The SASL mechanism to use."),
service.NewStringField("username").
Description("A username to provide for PLAIN or SCRAM-* authentication.").
Default(""),
service.NewStringField("password").
Description("A password to provide for PLAIN or SCRAM-* authentication.").
Default("").Secret(),
service.NewStringField("token").
Description("The token to use for a single session's OAUTHBEARER authentication.").
Default(""),
service.NewStringMapField("extensions").
Description("Key/value pairs to add to OAUTHBEARER authentication requests.").
Optional(),
service.NewObjectField("aws", config.SessionFields()...).
Description("Contains AWS specific fields for when the `mechanism` is set to `AWS_MSK_IAM`.").
Optional(),
).
Description("Specify one or more methods of SASL authentication. SASL is tried in order; if the broker supports the first mechanism, all connections will use that mechanism. If the first mechanism fails, the client will pick the first supported mechanism. If the broker does not support any client mechanisms, connections will fail.").
Advanced().Optional().
Example(
[]any{
map[string]any{
"mechanism": "SCRAM-SHA-512",
"username": "foo",
"password": "bar",
},
},
)
}
func saslMechanismsFromConfig(c *service.ParsedConfig) ([]sasl.Mechanism, error) {
if !c.Contains("sasl") {
return nil, nil
}
sList, err := c.FieldObjectList("sasl")
if err != nil {
return nil, err
}
var mechanisms []sasl.Mechanism
var mechanism sasl.Mechanism
for i, mConf := range sList {
mechStr, err := mConf.FieldString("mechanism")
if err == nil {
switch mechStr {
case "", "none":
continue
case "PLAIN":
mechanism, err = plainSaslFromConfig(mConf)
mechanisms = append(mechanisms, mechanism)
case "OAUTHBEARER":
mechanism, err = oauthSaslFromConfig(mConf)
mechanisms = append(mechanisms, mechanism)
case "SCRAM-SHA-256":
mechanism, err = scram256SaslFromConfig(mConf)
mechanisms = append(mechanisms, mechanism)
case "SCRAM-SHA-512":
mechanism, err = scram512SaslFromConfig(mConf)
mechanisms = append(mechanisms, mechanism)
case "AWS_MSK_IAM":
mechanism, err = AWSSASLFromConfigFn(mConf)
mechanisms = append(mechanisms, mechanism)
default:
err = fmt.Errorf("unknown mechanism: %v", mechStr)
}
}
if err != nil {
if len(sList) == 1 {
return nil, err
}
return nil, fmt.Errorf("mechanism %v: %w", i, err)
}
}
return mechanisms, nil
}
func plainSaslFromConfig(c *service.ParsedConfig) (sasl.Mechanism, error) {
username, err := c.FieldString("username")
if err != nil {
return nil, err
}
password, err := c.FieldString("password")
if err != nil {
return nil, err
}
return plain.Plain(func(c context.Context) (plain.Auth, error) {
return plain.Auth{
User: username,
Pass: password,
}, nil
}), nil
}
func oauthSaslFromConfig(c *service.ParsedConfig) (sasl.Mechanism, error) {
token, err := c.FieldString("token")
if err != nil {
return nil, err
}
var extensions map[string]string
if c.Contains("extensions") {
if extensions, err = c.FieldStringMap("extensions"); err != nil {
return nil, err
}
}
return oauth.Oauth(func(c context.Context) (oauth.Auth, error) {
return oauth.Auth{
Token: token,
Extensions: extensions,
}, nil
}), nil
}
func scram256SaslFromConfig(c *service.ParsedConfig) (sasl.Mechanism, error) {
username, err := c.FieldString("username")
if err != nil {
return nil, err
}
password, err := c.FieldString("password")
if err != nil {
return nil, err
}
return scram.Sha256(func(c context.Context) (scram.Auth, error) {
return scram.Auth{
User: username,
Pass: password,
}, nil
}), nil
}
func scram512SaslFromConfig(c *service.ParsedConfig) (sasl.Mechanism, error) {
username, err := c.FieldString("username")
if err != nil {
return nil, err
}
password, err := c.FieldString("password")
if err != nil {
return nil, err
}
return scram.Sha512(func(c context.Context) (scram.Auth, error) {
return scram.Auth{
User: username,
Pass: password,
}, nil
}), nil
}
//------------------------------------------------------------------------------
// SASL specific error types.
var (
ErrUnsupportedSASLMechanism = errors.New("unsupported SASL mechanism")
)
// ApplySASLConfig applies a SASL config to a sarama config.
func ApplySASLConfig(s ksasl.Config, mgr bundle.NewManagement, conf *sarama.Config) error {
switch s.Mechanism {
case sarama.SASLTypeOAuth:
var tp sarama.AccessTokenProvider
var err error
if s.TokenCache != "" {
tp, err = newCacheAccessTokenProvider(mgr, s.TokenCache, s.TokenKey)
if err != nil {
return err
}
} else {
tp, err = newStaticAccessTokenProvider(s.AccessToken)
if err != nil {
return err
}
}
conf.Net.SASL.TokenProvider = tp
case sarama.SASLTypeSCRAMSHA256:
conf.Net.SASL.SCRAMClientGeneratorFunc = func() sarama.SCRAMClient {
return &XDGSCRAMClient{HashGeneratorFcn: SHA256}
}
conf.Net.SASL.User = s.User
conf.Net.SASL.Password = s.Password
case sarama.SASLTypeSCRAMSHA512:
conf.Net.SASL.SCRAMClientGeneratorFunc = func() sarama.SCRAMClient {
return &XDGSCRAMClient{HashGeneratorFcn: SHA512}
}
conf.Net.SASL.User = s.User
conf.Net.SASL.Password = s.Password
case sarama.SASLTypePlaintext:
conf.Net.SASL.User = s.User
conf.Net.SASL.Password = s.Password
case "", "none":
return nil
default:
return ErrUnsupportedSASLMechanism
}
conf.Net.SASL.Enable = true
conf.Net.SASL.Mechanism = sarama.SASLMechanism(s.Mechanism)
return nil
}
//------------------------------------------------------------------------------
// cacheAccessTokenProvider fetches SASL OAUTHBEARER access tokens from a cache.
type cacheAccessTokenProvider struct {
mgr bundle.NewManagement
cacheName string
key string
}
func newCacheAccessTokenProvider(mgr bundle.NewManagement, cache, key string) (*cacheAccessTokenProvider, error) {
if !mgr.ProbeCache(cache) {
return nil, fmt.Errorf("cache resource '%v' was not found", cache)
}
return &cacheAccessTokenProvider{
mgr: mgr,
cacheName: cache,
key: key,
}, nil
}
func (c *cacheAccessTokenProvider) Token() (*sarama.AccessToken, error) {
var tok []byte
var terr error
if err := c.mgr.AccessCache(context.Background(), c.cacheName, func(cache cache.V1) {
tok, terr = cache.Get(context.Background(), c.key)
}); err != nil {
return nil, fmt.Errorf("failed to obtain cache resource '%v': %v", c.cacheName, err)
}
if terr != nil {
return nil, terr
}
return &sarama.AccessToken{Token: string(tok)}, nil
}
//------------------------------------------------------------------------------
// staticAccessTokenProvider provides a static SASL OAUTHBEARER access token.
type staticAccessTokenProvider struct {
token string
}
func newStaticAccessTokenProvider(token string) (*staticAccessTokenProvider, error) {
return &staticAccessTokenProvider{token}, nil
}
func (s *staticAccessTokenProvider) Token() (*sarama.AccessToken, error) {
return &sarama.AccessToken{Token: s.token}, nil
}