-
Notifications
You must be signed in to change notification settings - Fork 98
/
sasl_config.go
228 lines (206 loc) · 6.59 KB
/
sasl_config.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
/*
Copyright 2022 The Numaproj Authors.
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 util
import (
"crypto/sha256"
"crypto/sha512"
"fmt"
"os"
"github.com/IBM/sarama"
dfv1 "github.com/numaproj/numaflow/pkg/apis/numaflow/v1alpha1"
"github.com/xdg-go/scram"
corev1 "k8s.io/api/core/v1"
)
func GetSASL(saslConfig *dfv1.SASL) (*struct {
Enable bool
Mechanism sarama.SASLMechanism
Version int16
Handshake bool
AuthIdentity string
User string
Password string
SCRAMAuthzID string
SCRAMClientGeneratorFunc func() sarama.SCRAMClient
TokenProvider sarama.AccessTokenProvider
GSSAPI sarama.GSSAPIConfig
}, error) {
return getSASLStrategy(saslConfig, osFile{})
}
// GetSASLConfig A utility function to get sarama.Config.Net.SASL
func getSASLStrategy(saslConfig *dfv1.SASL, strategy volumeReader) (*struct {
Enable bool
Mechanism sarama.SASLMechanism
Version int16
Handshake bool
AuthIdentity string
User string
Password string
SCRAMAuthzID string
SCRAMClientGeneratorFunc func() sarama.SCRAMClient
TokenProvider sarama.AccessTokenProvider
GSSAPI sarama.GSSAPIConfig
}, error) {
config := sarama.NewConfig()
switch *saslConfig.Mechanism {
case dfv1.SASLTypeGSSAPI:
if gssapi := saslConfig.GSSAPI; gssapi != nil {
config.Net.SASL.Enable = true
config.Net.SASL.Mechanism = sarama.SASLTypeGSSAPI
if gssapi, err := GetGSSAPIConfig(gssapi); err != nil {
return nil, fmt.Errorf("error loading gssapi config, %w", err)
} else {
config.Net.SASL.GSSAPI = *gssapi
}
}
case dfv1.SASLTypePlaintext:
if plain := saslConfig.Plain; plain != nil {
config.Net.SASL.Enable = true
config.Net.SASL.Mechanism = sarama.SASLTypePlaintext
err := setUserPassword(config, plain.UserSecret, plain.PasswordSecret, strategy)
if err != nil {
return nil, err
}
config.Net.SASL.Handshake = plain.Handshake
}
case dfv1.SASLTypeSCRAMSHA256:
if scram := saslConfig.SCRAMSHA256; scram != nil {
config.Net.SASL.Enable = true
config.Net.SASL.Mechanism = sarama.SASLTypeSCRAMSHA256
config.Net.SASL.SCRAMClientGeneratorFunc = func() sarama.SCRAMClient { return &XDGSCRAMClient{HashGeneratorFcn: SHA256} }
err := setUserPassword(config, scram.UserSecret, scram.PasswordSecret, strategy)
if err != nil {
return nil, err
}
config.Net.SASL.Handshake = scram.Handshake
}
case dfv1.SASLTypeSCRAMSHA512:
if scram := saslConfig.SCRAMSHA512; scram != nil {
config.Net.SASL.Enable = true
config.Net.SASL.Mechanism = sarama.SASLTypeSCRAMSHA512
config.Net.SASL.SCRAMClientGeneratorFunc = func() sarama.SCRAMClient { return &XDGSCRAMClient{HashGeneratorFcn: SHA512} }
err := setUserPassword(config, scram.UserSecret, scram.PasswordSecret, strategy)
if err != nil {
return nil, err
}
config.Net.SASL.Handshake = scram.Handshake
}
default:
return nil, fmt.Errorf("SASL mechanism not supported: %s", *saslConfig.Mechanism)
}
return &config.Net.SASL, nil
}
func setUserPassword(config *sarama.Config, userSecret *corev1.SecretKeySelector, passwordSecret *corev1.SecretKeySelector, strategy volumeReader) error {
if userSecret != nil {
user, err := strategy.getSecretFromVolume(userSecret)
if err != nil {
return err
} else {
config.Net.SASL.User = user
}
}
if passwordSecret != nil {
password, err := strategy.getSecretFromVolume(passwordSecret)
if err != nil {
return err
} else {
config.Net.SASL.Password = password
}
}
return nil
}
// GetGSSAPIConfig A utility function to get sasl.gssapi.Config
func GetGSSAPIConfig(config *dfv1.GSSAPI) (*sarama.GSSAPIConfig, error) {
if config == nil {
return nil, nil
}
c := &sarama.GSSAPIConfig{
ServiceName: config.ServiceName,
Realm: config.Realm,
}
switch *config.AuthType {
case dfv1.KRB5UserAuth:
c.AuthType = sarama.KRB5_USER_AUTH
case dfv1.KRB5KeytabAuth:
c.AuthType = sarama.KRB5_KEYTAB_AUTH
default:
return nil, fmt.Errorf("failed to parse GSSAPI AuthType %v. Must be one of the following: ['KRB5_USER_AUTH', 'KRB5_KEYTAB_AUTH']", config.AuthType)
}
if config.UsernameSecret != nil {
username, err := GetSecretFromVolume(config.UsernameSecret)
if err != nil {
return nil, err
} else {
c.Username = username
}
}
if config.KeytabSecret != nil {
keyTabPath, err := GetSecretVolumePath(config.KeytabSecret)
if err != nil {
return nil, err
}
if len(keyTabPath) > 0 {
_, err := os.ReadFile(keyTabPath)
if err != nil {
return nil, fmt.Errorf("failed to read keytab file %s, %w", keyTabPath, err)
}
}
c.KeyTabPath = keyTabPath
}
if config.KerberosConfigSecret != nil {
kerberosConfigPath, err := GetSecretVolumePath(config.KerberosConfigSecret)
if err != nil {
return nil, err
}
if len(kerberosConfigPath) > 0 {
_, err := os.ReadFile(kerberosConfigPath)
if err != nil {
return nil, fmt.Errorf("failed to read kerberos config file %s, %w", kerberosConfigPath, err)
}
}
c.KerberosConfigPath = kerberosConfigPath
}
if config.PasswordSecret != nil {
password, err := GetSecretFromVolume(config.PasswordSecret)
if err != nil {
return nil, err
} else {
c.Password = password
}
}
return c, nil
}
// copied from https://github.com/IBM/sarama/blob/main/examples/sasl_scram_client/scram_client.go
var (
SHA256 scram.HashGeneratorFcn = sha256.New
SHA512 scram.HashGeneratorFcn = sha512.New
)
type XDGSCRAMClient struct {
*scram.Client
*scram.ClientConversation
scram.HashGeneratorFcn
}
func (x *XDGSCRAMClient) Begin(userName, password, authzID string) (err error) {
x.Client, err = x.HashGeneratorFcn.NewClient(userName, password, authzID)
if err != nil {
return err
}
x.ClientConversation = x.Client.NewConversation()
return nil
}
func (x *XDGSCRAMClient) Step(challenge string) (response string, err error) {
response, err = x.ClientConversation.Step(challenge)
return
}
func (x *XDGSCRAMClient) Done() bool {
return x.ClientConversation.Done()
}