Skip to content

Commit f75c91c

Browse files
qingyang-huqingyang-hu
authored
GODRIVER-3429 Revert internal-only "AuthenticateToAnything". (#2025)
1 parent dc48722 commit f75c91c

File tree

8 files changed

+189
-11
lines changed

8 files changed

+189
-11
lines changed

internal/options/options.go renamed to internal/optionsutil/options.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
// not use this file except in compliance with the License. You may obtain
55
// a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
66

7-
package options
7+
package optionsutil
88

99
// Options stores internal options.
1010
type Options struct {

‎mongo/options/clientoptions.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
"go.mongodb.org/mongo-driver/v2/bson"
2727
"go.mongodb.org/mongo-driver/v2/event"
2828
"go.mongodb.org/mongo-driver/v2/internal/httputil"
29-
"go.mongodb.org/mongo-driver/v2/internal/options"
29+
"go.mongodb.org/mongo-driver/v2/internal/optionsutil"
3030
"go.mongodb.org/mongo-driver/v2/mongo/readconcern"
3131
"go.mongodb.org/mongo-driver/v2/mongo/readpref"
3232
"go.mongodb.org/mongo-driver/v2/mongo/writeconcern"
@@ -302,7 +302,7 @@ type ClientOptions struct {
302302
//
303303
// Deprecated: This option is for internal use only and should not be set. It may be changed or removed in any
304304
// release.
305-
Custom options.Options
305+
Custom optionsutil.Options
306306

307307
connString *connstring.ConnString
308308
err error

‎mongo/options/clientoptions_test.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import (
2727
"go.mongodb.org/mongo-driver/v2/event"
2828
"go.mongodb.org/mongo-driver/v2/internal/assert"
2929
"go.mongodb.org/mongo-driver/v2/internal/httputil"
30-
"go.mongodb.org/mongo-driver/v2/internal/options"
30+
"go.mongodb.org/mongo-driver/v2/internal/optionsutil"
3131
"go.mongodb.org/mongo-driver/v2/internal/ptrutil"
3232
"go.mongodb.org/mongo-driver/v2/mongo/readconcern"
3333
"go.mongodb.org/mongo-driver/v2/mongo/readpref"
@@ -157,7 +157,7 @@ func TestClientOptions(t *testing.T) {
157157
cmp.Comparer(func(r1, r2 *bson.Registry) bool { return r1 == r2 }),
158158
cmp.Comparer(func(cfg1, cfg2 *tls.Config) bool { return cfg1 == cfg2 }),
159159
cmp.Comparer(func(fp1, fp2 *event.PoolMonitor) bool { return fp1 == fp2 }),
160-
cmp.Comparer(options.Equal),
160+
cmp.Comparer(optionsutil.Equal),
161161
cmp.AllowUnexported(ClientOptions{}),
162162
cmpopts.IgnoreFields(http.Client{}, "Transport"),
163163
); diff != "" {
@@ -1255,7 +1255,7 @@ func TestApplyURI(t *testing.T) {
12551255
cmp.Comparer(func(r1, r2 *bson.Registry) bool { return r1 == r2 }),
12561256
cmp.Comparer(compareTLSConfig),
12571257
cmp.Comparer(compareErrors),
1258-
cmp.Comparer(options.Equal),
1258+
cmp.Comparer(optionsutil.Equal),
12591259
cmpopts.SortSlices(stringLess),
12601260
cmpopts.IgnoreFields(connstring.ConnString{}, "SSLClientCertificateKeyPassword"),
12611261
cmpopts.IgnoreFields(http.Client{}, "Transport"),

‎x/mongo/driver/auth/auth_test.go‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,19 @@
77
package auth_test
88

99
import (
10+
"context"
11+
"fmt"
1012
"net/http"
1113
"testing"
1214

1315
"github.com/google/go-cmp/cmp"
1416
"go.mongodb.org/mongo-driver/v2/internal/require"
1517
"go.mongodb.org/mongo-driver/v2/x/bsonx/bsoncore"
18+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver"
1619
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/auth"
20+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/description"
21+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/drivertest"
22+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/mnet"
1723
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/wiremessage"
1824
)
1925

@@ -101,3 +107,56 @@ func compareResponses(t *testing.T, wm []byte, expectedPayload bsoncore.Document
101107
t.Errorf("Payloads don't match. got %v; want %v", actualPayload, expectedPayload)
102108
}
103109
}
110+
111+
type testAuthenticator struct{}
112+
113+
func (a *testAuthenticator) Auth(context.Context, *driver.AuthConfig) error {
114+
return fmt.Errorf("test error")
115+
}
116+
117+
func (a *testAuthenticator) Reauth(context.Context, *driver.AuthConfig) error {
118+
return nil
119+
}
120+
121+
func TestPerformAuthentication(t *testing.T) {
122+
t.Parallel()
123+
124+
cases := []struct {
125+
name string
126+
authenticateToAnything bool
127+
require func(*testing.T, error)
128+
}{
129+
{
130+
name: "positive",
131+
authenticateToAnything: true,
132+
require: func(t *testing.T, err error) {
133+
require.EqualError(t, err, "auth error: test error")
134+
},
135+
},
136+
{
137+
name: "negative",
138+
authenticateToAnything: false,
139+
require: func(t *testing.T, err error) {
140+
require.NoError(t, err)
141+
},
142+
},
143+
}
144+
mnetconn := mnet.NewConnection(&drivertest.ChannelConn{})
145+
for _, tc := range cases {
146+
tc := tc
147+
148+
t.Run(tc.name, func(t *testing.T) {
149+
t.Parallel()
150+
151+
handshaker := auth.Handshaker(nil, &auth.HandshakeOptions{
152+
Authenticator: &testAuthenticator{},
153+
PerformAuthentication: func(description.Server) bool {
154+
return tc.authenticateToAnything
155+
},
156+
})
157+
158+
err := handshaker.FinishHandshake(context.Background(), mnetconn)
159+
tc.require(t, err)
160+
})
161+
}
162+
}

‎x/mongo/driver/topology/topology_options.go‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,11 @@ import (
1515

1616
"go.mongodb.org/mongo-driver/v2/event"
1717
"go.mongodb.org/mongo-driver/v2/internal/logger"
18+
"go.mongodb.org/mongo-driver/v2/internal/optionsutil"
1819
"go.mongodb.org/mongo-driver/v2/mongo/options"
1920
"go.mongodb.org/mongo-driver/v2/x/mongo/driver"
2021
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/auth"
22+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/description"
2123
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/ocsp"
2224
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/operation"
2325
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/session"
@@ -270,6 +272,14 @@ func NewConfigFromOptionsWithAuthenticator(opts *options.ClientOptions, clock *s
270272
// Required for SASL mechanism negotiation during handshake
271273
handshakeOpts.DBUser = opts.Auth.AuthSource + "." + opts.Auth.Username
272274
}
275+
if a := optionsutil.Value(opts.Custom, "authenticateToAnything"); a != nil {
276+
if v, ok := a.(bool); ok && v {
277+
// Authenticate arbiters
278+
handshakeOpts.PerformAuthentication = func(_ description.Server) bool {
279+
return true
280+
}
281+
}
282+
}
273283

274284
handshaker = func(driver.Handshaker) driver.Handshaker {
275285
return auth.Handshaker(nil, handshakeOpts)

‎x/mongo/driver/topology/topology_options_test.go‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
package topology
88

99
import (
10+
"context"
1011
"fmt"
1112
"net/url"
1213
"reflect"
@@ -17,6 +18,10 @@ import (
1718
"go.mongodb.org/mongo-driver/v2/internal/require"
1819
"go.mongodb.org/mongo-driver/v2/mongo/options"
1920
"go.mongodb.org/mongo-driver/v2/x/mongo/driver"
21+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/description"
22+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/drivertest"
23+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/mnet"
24+
"go.mongodb.org/mongo-driver/v2/x/mongo/driver/xoptions"
2025
)
2126

2227
func TestDirectConnectionFromConnString(t *testing.T) {
@@ -85,6 +90,76 @@ func TestLoadBalancedFromConnString(t *testing.T) {
8590
}
8691
}
8792

93+
type testAuthenticator struct{}
94+
95+
var _ driver.Authenticator = &testAuthenticator{}
96+
97+
func (a *testAuthenticator) Auth(context.Context, *driver.AuthConfig) error {
98+
return fmt.Errorf("test error")
99+
}
100+
101+
func (a *testAuthenticator) Reauth(context.Context, *driver.AuthConfig) error {
102+
return nil
103+
}
104+
105+
func TestAuthenticateToAnything(t *testing.T) {
106+
t.Parallel()
107+
108+
cases := []struct {
109+
name string
110+
set func(*options.ClientOptions) error
111+
require func(*testing.T, error)
112+
}{
113+
{
114+
name: "default",
115+
set: func(*options.ClientOptions) error { return nil },
116+
require: func(t *testing.T, err error) {
117+
require.NoError(t, err)
118+
},
119+
},
120+
{
121+
name: "positive",
122+
set: func(opt *options.ClientOptions) error {
123+
return xoptions.SetInternalClientOptions(opt, "authenticateToAnything", true)
124+
},
125+
require: func(t *testing.T, err error) {
126+
require.EqualError(t, err, "auth error: test error")
127+
},
128+
},
129+
{
130+
name: "negative",
131+
set: func(opt *options.ClientOptions) error {
132+
return xoptions.SetInternalClientOptions(opt, "authenticateToAnything", false)
133+
},
134+
require: func(t *testing.T, err error) {
135+
require.NoError(t, err)
136+
},
137+
},
138+
}
139+
140+
describer := &drivertest.ChannelConn{
141+
Desc: description.Server{Kind: description.ServerKindRSArbiter},
142+
}
143+
for _, tc := range cases {
144+
tc := tc
145+
146+
t.Run(tc.name, func(t *testing.T) {
147+
t.Parallel()
148+
149+
opt := options.Client().SetAuth(options.Credential{Username: "foo", Password: "bar"})
150+
err := tc.set(opt)
151+
require.NoError(t, err, "error setting authenticateToAnything: %v", err)
152+
cfg, err := NewConfigFromOptionsWithAuthenticator(opt, nil, &testAuthenticator{})
153+
require.NoError(t, err, "error constructing topology config: %v", err)
154+
155+
srvrCfg := newServerConfig(defaultConnectionTimeout, cfg.ServerOpts...)
156+
connCfg := newConnectionConfig(srvrCfg.connectionOpts...)
157+
err = connCfg.handshaker.FinishHandshake(context.TODO(), &mnet.Connection{Describer: describer})
158+
tc.require(t, err)
159+
})
160+
}
161+
}
162+
88163
func TestTopologyNewConfig(t *testing.T) {
89164
t.Run("default ServerSelectionTimeout", func(t *testing.T) {
90165
cfg, err := NewConfig(options.Client(), nil)

‎x/mongo/driver/xoptions/options.go‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ package xoptions
99
import (
1010
"fmt"
1111

12+
"go.mongodb.org/mongo-driver/v2/internal/optionsutil"
1213
"go.mongodb.org/mongo-driver/v2/mongo/options"
1314
"go.mongodb.org/mongo-driver/v2/x/mongo/driver"
1415
)
@@ -17,20 +18,28 @@ import (
1718
//
1819
// Deprecated: This function is for internal use only. It may be changed or removed in any release.
1920
func SetInternalClientOptions(opts *options.ClientOptions, key string, option any) error {
20-
const typeErr = "unexpected type for %s"
21+
typeErrFunc := func(t string) error {
22+
return fmt.Errorf("unexpected type for %s: %T is not %s", key, option, t)
23+
}
2124
switch key {
2225
case "crypt":
2326
c, ok := option.(driver.Crypt)
2427
if !ok {
25-
return fmt.Errorf(typeErr, key)
28+
return typeErrFunc("driver.Crypt")
2629
}
2730
opts.Crypt = c
2831
case "deployment":
2932
d, ok := option.(driver.Deployment)
3033
if !ok {
31-
return fmt.Errorf(typeErr, key)
34+
return typeErrFunc("driver.Deployment")
3235
}
3336
opts.Deployment = d
37+
case "authenticateToAnything":
38+
b, ok := option.(bool)
39+
if !ok {
40+
return typeErrFunc("bool")
41+
}
42+
opts.Custom = optionsutil.WithValue(opts.Custom, key, b)
3443
default:
3544
return fmt.Errorf("unsupported option: %s", key)
3645
}

‎x/mongo/driver/xoptions/options_test.go‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,10 @@
77
package xoptions
88

99
import (
10+
"fmt"
1011
"testing"
1112

13+
"go.mongodb.org/mongo-driver/v2/internal/optionsutil"
1214
"go.mongodb.org/mongo-driver/v2/internal/require"
1315
"go.mongodb.org/mongo-driver/v2/mongo/options"
1416
"go.mongodb.org/mongo-driver/v2/x/mongo/driver"
@@ -18,6 +20,29 @@ import (
1820
func TestSetInternalClientOptions(t *testing.T) {
1921
t.Parallel()
2022

23+
cases := []struct {
24+
key string
25+
value any
26+
}{
27+
{
28+
key: "authenticateToAnything",
29+
value: true,
30+
},
31+
}
32+
for _, tc := range cases {
33+
tc := tc
34+
35+
t.Run(fmt.Sprintf("set %s", tc.key), func(t *testing.T) {
36+
t.Parallel()
37+
38+
opts := options.Client()
39+
err := SetInternalClientOptions(opts, tc.key, tc.value)
40+
require.NoError(t, err, "error setting %s: %v", tc.key, err)
41+
v := optionsutil.Value(opts.Custom, tc.key)
42+
require.Equal(t, tc.value, v, "expected %v, got %v", tc.value, v)
43+
})
44+
}
45+
2146
t.Run("set crypt", func(t *testing.T) {
2247
t.Parallel()
2348

@@ -33,7 +58,7 @@ func TestSetInternalClientOptions(t *testing.T) {
3358

3459
opts := options.Client()
3560
err := SetInternalClientOptions(opts, "crypt", &drivertest.MockDeployment{})
36-
require.EqualError(t, err, "unexpected type for crypt")
61+
require.EqualError(t, err, "unexpected type for crypt: *drivertest.MockDeployment is not driver.Crypt")
3762
})
3863

3964
t.Run("set deployment", func(t *testing.T) {
@@ -51,7 +76,7 @@ func TestSetInternalClientOptions(t *testing.T) {
5176

5277
opts := options.Client()
5378
err := SetInternalClientOptions(opts, "deployment", driver.NewCrypt(&driver.CryptOptions{}))
54-
require.EqualError(t, err, "unexpected type for deployment")
79+
require.EqualError(t, err, "unexpected type for deployment: *driver.crypt is not driver.Deployment")
5580
})
5681

5782
t.Run("set unsupported option", func(t *testing.T) {

0 commit comments

Comments
 (0)