feat: support oauth2 scope field (#151)

* feat: support oauth2 scope field

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>

* restore unnecessary change

* update go-client dependency

---------

Signed-off-by: ericsyh <ericshenyuhao@outlook.com>
Co-authored-by: labuladong <labuladong@foxmail.com>

Author: ericsyh

api/v1alpha1/common.go

@@ -65,6 +65,7 @@ type PulsarAuthenticationOAuth2 struct {
 	ClientID       string           `json:"clientID"`
 	Audience       string           `json:"audience"`
 	Key            ValueOrSecretRef `json:"key"`
+	Scope          string           `json:"scope"`
 }
 
 // IsPulsarResourceReady returns true if resource satisfies with these condition

go.mod

@@ -3,7 +3,7 @@ module github.com/streamnative/pulsar-resources-operator
 go 1.19
 
 require (
-	github.com/apache/pulsar-client-go v0.9.1-0.20230816081803-fbee610ddcbf
+	github.com/apache/pulsar-client-go v0.9.1-0.20230925013839-ac9c1a639933
 	github.com/go-logr/logr v1.2.1
 	github.com/onsi/ginkgo v1.16.5
 	github.com/onsi/gomega v1.19.0

go.sum

@@ -72,8 +72,8 @@ github.com/alecthomas/units v0.0.0-20190717042225-c3de453c63f4/go.mod h1:ybxpYRF
 github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d/go.mod h1:rBZYJk541a8SKzHPHnH3zbiI+7dagKZ0cgpgrD7Fyho=
 github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kdvxnR2qWY=
 github.com/antlr/antlr4/runtime/Go/antlr v0.0.0-20210826220005-b48c857c3a0e/go.mod h1:F7bn7fEU90QkQ3tnmaTx3LTKLEDqnwWODIYppRQ5hnY=
-github.com/apache/pulsar-client-go v0.9.1-0.20230816081803-fbee610ddcbf h1:k9hqsKPh5ncKf0e3CkzvBTYXLwCYNYFb1Vtk3qnYAvk=
-github.com/apache/pulsar-client-go v0.9.1-0.20230816081803-fbee610ddcbf/go.mod h1:Ea/yiZA7plgiaWRyOuO1B0k5/hjpl1thmiKig+D9PBQ=
+github.com/apache/pulsar-client-go v0.9.1-0.20230925013839-ac9c1a639933 h1:lYWPZnfWZZ/OZO0kS/WhNS/vmujPrT9fmuPse3X/ecc=
+github.com/apache/pulsar-client-go v0.9.1-0.20230925013839-ac9c1a639933/go.mod h1:Ea/yiZA7plgiaWRyOuO1B0k5/hjpl1thmiKig+D9PBQ=
 github.com/armon/circbuf v0.0.0-20150827004946-bbbad097214e/go.mod h1:3U/XgcO3hCbHZ8TKRvWD2dDTCfh9M9ya+I9JpbB7O8o=
 github.com/armon/go-metrics v0.0.0-20180917152333-f0300d1749da/go.mod h1:Q73ZrmVTwzkszR9V5SSuryQ31EELlFMUz1kKyl939pY=
 github.com/armon/go-radix v0.0.0-20180808171621-7fddfc383310/go.mod h1:ufUuZ+zHj4x4TnLV4JWEpy2hxWSpsRywHrMgIH9cCH8=

pkg/admin/interface.go

@@ -17,6 +17,7 @@ package admin
 import (
 	"io/ioutil"
 	"os"
+	"strings"
 
 	"github.com/apache/pulsar-client-go/oauth2"
 	"github.com/apache/pulsar-client-go/pulsaradmin/pkg/admin"
@@ -177,6 +178,7 @@ type PulsarAdminConfig struct {
 	ClientID       string
 	Audience       string
 	Key            string
+	Scope          string
 }
 
 // NewPulsarAdmin initialize a pulsar admin client with configuration
@@ -208,16 +210,24 @@ func NewPulsarAdmin(conf PulsarAdminConfig) (PulsarAdmin, error) {
 		config.ClientID = conf.ClientID
 		config.Audience = conf.Audience
 		config.KeyFile = keyFilePath
+		config.Scope = conf.Scope
 
-		oauthProvider, err := auth.NewAuthenticationOAuth2WithDefaultFlow(oauth2.Issuer{
+		oauthProvider, err := auth.NewAuthenticationOAuth2WithFlow(oauth2.Issuer{
 			IssuerEndpoint: conf.IssuerEndpoint,
 			ClientID:       conf.ClientID,
 			Audience:       conf.Audience,
-		}, keyFilePath)
+		}, oauth2.ClientCredentialsFlowOptions{
+			KeyFile:          keyFilePath,
+			AdditionalScopes: strings.Split(conf.Scope, " "),
+		})
+
+		if err != nil {
+			return nil, err
+		}
+		adminClient, err = admin.NewPulsarClientWithAuthProvider(config, oauthProvider)
 		if err != nil {
 			return nil, err
 		}
-		adminClient = admin.NewWithAuthProvider(config, oauthProvider)
 	} else {
 		config.Token = conf.Token
 

pkg/connection/reconciler.go

@@ -216,6 +216,7 @@ func (r *PulsarConnectionReconciler) MakePulsarAdminConfig(ctx context.Context)
 			cfg.IssuerEndpoint = oauth2.IssuerEndpoint
 			cfg.ClientID = oauth2.ClientID
 			cfg.Audience = oauth2.Audience
+			cfg.Scope = oauth2.Scope
 			value, err := GetValue(ctx, r.client, r.connection.Namespace, &oauth2.Key)
 			if err != nil {
 				return nil, err

tests/go.mod

@@ -5,7 +5,7 @@ go 1.18
 require (
 	// pulsar-client-go latest version is v0.9.0,
 	// it removed the go.mod from oauth2, this will cause the issue of ambiguous import
-	github.com/apache/pulsar-client-go v0.9.1-0.20230816081803-fbee610ddcbf
+	github.com/apache/pulsar-client-go v0.9.1-0.20230925013839-ac9c1a639933
 	github.com/onsi/ginkgo/v2 v2.1.3
 	github.com/onsi/gomega v1.19.0
 	github.com/sirupsen/logrus v1.8.1

tests/go.sum

@@ -68,6 +68,7 @@ github.com/antihax/optional v1.0.0/go.mod h1:uupD/76wgC+ih3iEmQUL+0Ugr19nfwCT1kd
 github.com/apache/pulsar-client-go v0.8.1 h1:UZINLbH3I5YtNzqkju7g9vrl4CKrEgYSx2rbpvGufrE=
 github.com/apache/pulsar-client-go v0.8.1/go.mod h1:yJNcvn/IurarFDxwmoZvb2Ieylg630ifxeO/iXpk27I=
 github.com/apache/pulsar-client-go v0.9.1-0.20230816081803-fbee610ddcbf/go.mod h1:Ea/yiZA7plgiaWRyOuO1B0k5/hjpl1thmiKig+D9PBQ=
+github.com/apache/pulsar-client-go v0.9.1-0.20230925013839-ac9c1a639933/go.mod h1:Ea/yiZA7plgiaWRyOuO1B0k5/hjpl1thmiKig+D9PBQ=
 github.com/ardielle/ardielle-go v1.5.2 h1:TilHTpHIQJ27R1Tl/iITBzMwiUGSlVfiVhwDNGM3Zj4=
 github.com/ardielle/ardielle-go v1.5.2/go.mod h1:I4hy1n795cUhaVt/ojz83SNVCYIGsAFAONtv2Dr7HUI=
 github.com/ardielle/ardielle-tools v1.5.4/go.mod h1:oZN+JRMnqGiIhrzkRN9l26Cej9dEx4jeNG6A+AdkShk=