wip

ndyakov · ndyakov · commit 9b37515473d4 · 2025-03-13T14:10:59.000+02:00
diff --git a/credentials.go b/credentials.go
@@ -0,0 +1,27 @@
+package entraid
+
+import (
+	auth "github.com/redis/go-redis/v9/auth"
+)
+
+// authCredentials implements the auth.Credentials interface.
+var _ auth.Credentials = (*authCredentials)(nil)
+
+// authCredentials represents the authentication credentials used to access the Entraid API.
+// It contains the username, password, and raw credentials.
+// The authCredentials struct is used to store the authentication credentials
+type authCredentials struct {
+	username       string
+	password       string
+	rawCredentials string
+}
+
+// BasicAuth returns the username and password for basic authentication.
+func (a *authCredentials) BasicAuth() (username string, password string) {
+	return a.username, a.password
+}
+
+// RawCredentials returns the raw credentials for authentication.
+func (a *authCredentials) RawCredentials() string {
+	return a.rawCredentials
+}
diff --git a/credentials_provider.go b/credentials_provider.go
@@ -0,0 +1,132 @@
+package entraid
+
+import (
+	"fmt"
+
+	"github.com/redis/go-redis/v9/auth"
+)
+
+// entraidCredentialsProvider implements the auth.StreamingCredentialsProvider interface.
+var _ auth.StreamingCredentialsProvider = (*entraidCredentialsProvider)(nil)
+
+// entraidCredentialsProvider is a struct that implements the CredentialProvider interface.
+type entraidCredentialsProvider struct {
+	options CredentialsProviderOptions
+
+	tokenManager       TokenManager
+	cancelTokenManager cancelFunc
+
+	listeners []auth.CredentialsListener
+}
+
+// onTokenNext is a method that is called when the token manager receives a new token.
+func (e *entraidCredentialsProvider) onTokenNext(token *Token) {
+	// Notify all listeners with the new token.
+	for _, listener := range e.listeners {
+		listener.OnNext(&authCredentials{
+			username:       token.Username,
+			password:       token.Password,
+			rawCredentials: token.RawToken,
+		})
+	}
+}
+
+// onError is a method that is called when the token manager encounters an error.
+// It notifies all listeners with the error.
+func (e *entraidCredentialsProvider) onTokenError(err error) {
+	// Notify all listeners with the error.
+	for _, listener := range e.listeners {
+		listener.OnError(err)
+	}
+}
+
+// Subscribe subscribes to the credentials provider and returns a channel that will receive updates.
+// The first response is blocking, then data will notify the listener.
+// The listener will be notified with the credentials when they are available.
+// The listener will be notified with an error if there is an error obtaining the credentials.
+// The caller can cancel the subscription by calling the cancel function which is the second return value.
+func (e *entraidCredentialsProvider) Subscribe(listener auth.CredentialsListener) (auth.Credentials, auth.CancelProviderFunc, error) {
+	// Check if the listener is already in the list of listeners.
+	alreadySubscribed := false
+	for _, l := range e.listeners {
+		if l == listener {
+			alreadySubscribed = true
+			break
+		}
+	}
+
+	if !alreadySubscribed {
+		// Get the token from the identity provider.
+		e.listeners = append(e.listeners, listener)
+	}
+
+	token, err := e.tokenManager.GetToken()
+	if err != nil {
+		listener.OnError(err)
+		return nil, nil, err
+	}
+
+	// Create a new credentials object.
+	credentials := &authCredentials{
+		username:       token.Username,
+		password:       token.Password,
+		rawCredentials: token.RawToken,
+	}
+
+	// Notify the listener with the credentials.
+	listener.OnNext(credentials)
+
+	cancel := func() error {
+		// Remove the listener from the list of listeners.
+		for i, l := range e.listeners {
+			if l == listener {
+				e.listeners = append(e.listeners[:i], e.listeners[i+1:]...)
+				break
+			}
+		}
+		if len(e.listeners) == 0 {
+			e.cancelTokenManager()
+		}
+		return nil
+	}
+
+	return credentials, cancel, nil
+}
+
+// newCredentialsProvider creates a new credentials provider.
+// It takes a TokenManager and CredentialProviderOptions as arguments and returns a StreamingCredentialsProvider interface.
+// The TokenManager is used to obtain the token, and the CredentialProviderOptions contains options for the credentials provider.
+// The credentials provider is responsible for managing the credentials and refreshing them when necessary.
+// It returns an error if the token manager cannot be started.
+func newCredentialsProvider(tokenManager TokenManager, options CredentialProviderOptions) (auth.StreamingCredentialsProvider, error) {
+	cp := &entraidCredentialsProvider{
+		tokenManager: tokenManager,
+		options:      options,
+	}
+	cancelTokenManager, err := cp.tokenManager.Start(tokenListenerFromCP(cp))
+	if err != nil {
+		return nil, fmt.Errorf("couldn't start token manager: %w", err)
+	}
+	cp.cancelTokenManager = cancelTokenManager
+	return cp, nil
+}
+
+type entraidTokenListener struct {
+	onTokenNext  func(token *Token)
+	onTokenError func(err error)
+}
+
+func tokenListenerFromCP(cp *entraidCredentialsProvider) *entraidTokenListener {
+	return &entraidTokenListener{
+		onTokenNext:  cp.onTokenNext,
+		onTokenError: cp.onTokenError,
+	}
+}
+
+func (l *entraidTokenListener) OnTokenNext(token *Token) {
+	l.onTokenNext(token)
+}
+
+func (l *entraidTokenListener) OnTokenError(err error) {
+	l.onTokenError(err)
+}
diff --git a/entraid.go b/entraid.go
@@ -0,0 +1 @@
+package entraid
diff --git a/errors.go b/errors.go
@@ -0,0 +1,5 @@
+package entraid
+
+import "fmt"
+
+var ErrNotImplemented = fmt.Errorf("credentials provider not implemented")
diff --git a/examples/example_test.go b/examples/example_test.go
@@ -0,0 +1,16 @@
+package examples_test
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/redis/go-redis/v9"
+)
+
+func ExampleEstablishRedisConn() {
+	rdb := redis.NewUniversalClient(&redis.UniversalOptions{
+		Addrs: []string{"localhost:6379"},
+	})
+	fmt.Println(rdb.Ping(context.Background()).String())
+	// Output: ping: PONG
+}
diff --git a/examples/go.mod b/examples/go.mod
@@ -0,0 +1,10 @@
+module examples
+
+go 1.23
+
+require github.com/redis/go-redis/v9 v9.7.1
+
+require (
+	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
+)
diff --git a/examples/go.sum b/examples/go.sum
@@ -0,0 +1,10 @@
+github.com/bsm/ginkgo/v2 v2.12.0 h1:Ny8MWAHyOepLGlLKYmXG4IEkioBysk6GpaRTLC8zwWs=
+github.com/bsm/ginkgo/v2 v2.12.0/go.mod h1:SwYbGRRDovPVboqFv0tPTcG1sN61LM1Z4ARdbAV9g4c=
+github.com/bsm/gomega v1.27.10 h1:yeMWxP2pV2fG3FgAODIY8EiRE3dy0aeFYt4l7wh6yKA=
+github.com/bsm/gomega v1.27.10/go.mod h1:JyEr/xRbxbtgWNi8tIEVPUYZ5Dzef52k01W3YH0H+O0=
+github.com/cespare/xxhash/v2 v2.2.0 h1:DC2CZ1Ep5Y4k3ZQ899DldepgrayRUGE6BBZ/cd9Cj44=
+github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f h1:lO4WD4F/rVNCu3HqELle0jiPLLBs70cWOduZpkS1E78=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
+github.com/redis/go-redis/v9 v9.7.1 h1:4LhKRCIduqXqtvCUlaq9c8bdHOkICjDMrr1+Zb3osAc=
+github.com/redis/go-redis/v9 v9.7.1/go.mod h1:f6zhXITC7JUJIlPEiBOTXxJgPLdZcA93GewI7inzyWw=
diff --git a/go.mod b/go.mod
@@ -2,4 +2,8 @@ module github.com/redis-developer/go-redis-entraid
 
 go 1.18
 
+replace github.com/redis/go-redis/v9 => /Users/nedyalko.dyakov/go-redis/
 
+require github.com/redis/go-redis/v9 v9.7.1
+
+require github.com/AzureAD/microsoft-authentication-library-for-go v1.4.1 // indirect
diff --git a/go.sum b/go.sum
@@ -0,0 +1,5 @@
+github.com/AzureAD/microsoft-authentication-library-for-go v1.4.1 h1:8BKxhZZLX/WosEeoCvWysmKUscfa9v8LIPEEU0JjE2o=
+github.com/AzureAD/microsoft-authentication-library-for-go v1.4.1/go.mod h1:wP83P5OoQ5p6ip3ScPr0BAq0BvuPAvacpEuSzyouqAI=
+github.com/cespare/xxhash/v2 v2.2.0/go.mod h1:VGX0DQ3Q6kWi7AoAeZDth3/j3BFtOZR5XLFGgcrjCOs=
+github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f/go.mod h1:cuUVRXasLTGF7a8hSLbxyZXjz+1KgoB3wDUb6vlszIc=
+github.com/redis/go-redis/v9 v9.7.1/go.mod h1:f6zhXITC7JUJIlPEiBOTXxJgPLdZcA93GewI7inzyWw=
diff --git a/identity_provider.go b/identity_provider.go
@@ -0,0 +1,6 @@
+package entraid
+
+type IdentityProvider interface {
+	// requestToken requests a token from the identity provider.
+	requestToken() (string, error)
+}
diff --git a/internal/idps/azure.go b/internal/idps/azure.go
@@ -0,0 +1,9 @@
+package idps
+
+type Azure struct {
+}
+
+func (a Azure) requestToken() string {
+	//TODO implement me
+	panic("implement me")
+}
diff --git a/internal/idps/identity_providers.go b/internal/idps/identity_providers.go
@@ -0,0 +1,13 @@
+package idps
+
+import "fmt"
+
+type IdentityProviderType string
+
+var ErrUnimplemented = fmt.Errorf("identity provider not implemented")
+
+const (
+	ManagedIdentity        IdentityProviderType = "managed-identity"
+	DefaultAzureCredential IdentityProviderType = "default-azure-credentials"
+	ServicePrincipal       IdentityProviderType = "service-principal"
+)
diff --git a/internal/idps/msal.go b/internal/idps/msal.go
@@ -0,0 +1,43 @@
+package idps
+
+import "github.com/AzureAD/microsoft-authentication-library-for-go/apps/public"
+
+// MSALIdentityProviderOptions is a struct that holds the options for the MSAL identity provider.
+// It contains the ClientID which is used to initialize the MSAL client.
+// The ClientID is a unique identifier for the application registered in Azure AD.
+// The MSAL client is used to request tokens from the Microsoft identity platform.
+type MSALIdentityProviderOptions struct {
+	// ClientID is the unique identifier for the application registered in Azure AD.
+	ClientID string
+	// ClientSecret is the secret key for the application registered in Azure AD.
+	ClientSecret string
+}
+
+// MSALIdentityProvider is a struct that implements the IdentityProvider interface.
+type MSALIdentityProvider struct {
+	client  public.Client
+	idpType IdentityProviderType
+}
+
+func (m *MSALIdentityProvider) getToken() (string, error) {
+	// This method is not implemented yet.
+	return "", ErrNotImplemented
+}
+
+// requestToken requests a token from the MSAL identity provider.
+func (m *MSALIdentityProvider) requestToken() (string, error) {
+	return "", ErrNotImplemented
+}
+
+// NewMSALIdentityProvider creates a new MSALIdentityProvider with the given options.
+// It initializes the MSAL client with the provided ClientID.
+func NewMSALIdentityProvider(options MSALIdentityProviderOptions) (*MSALIdentityProvider, error) {
+	client, err := public.New(options.ClientID)
+	if err != nil {
+		return nil, err
+	}
+
+	return &MSALIdentityProvider{
+		client: client,
+	}, nil
+}
diff --git a/providers.go b/providers.go
@@ -0,0 +1,64 @@
+package entraid
+
+import (
+	"github.com/redis/go-redis/v9/auth"
+)
+
+type CredentialsProviderOptions struct {
+	// ClientID is the client ID of the system assigned identity.
+	// This is used to identify the identity when requesting a token.
+	ClientID string
+
+	// Scopes is a list of scopes that the identity has access to.
+	// This is used to specify the permissions that the identity has when requesting a token.
+	Scopes []string
+
+	TokenManagerOptions TokenManagerOptions
+	// rewrite to go
+
+	// OnReAuthenticationError is a callback function that is called when a re-authentication error occurs.
+	OnReAuthenticationError func(error) error
+
+	// OnRetryableError is a callback function that is called when a retryable error occurs.
+	OnRetryableError func(error) error
+}
+
+type SystemAssignedOptions struct {
+	CredentialsProviderOptions
+}
+
+func NewSystemAssignedCredentialsProvider(options SystemAssignedOptions) (auth.StreamingCredentialsProvider, error) {
+	return nil, ErrNotImplemented
+}
+
+type UserAssignedOptions struct {
+	CredentialsProviderOptions
+}
+
+func NewUserAssignedCredentialsProvider(options UserAssignedOptions) (auth.StreamingCredentialsProvider, error) {
+	return nil, ErrNotImplemented
+}
+
+type ClientCredentialsOptions struct {
+	CredentialsProviderOptions
+}
+
+func NewClientCredentialsCredentialsProvider(options ClientCredentialsOptions) (auth.StreamingCredentialsProvider, error) {
+	return nil, ErrNotImplemented
+}
+
+type DefaultAzureOptions struct {
+	CredentialsProviderOptions
+}
+
+func NewDefaultAzureCredentialsProvider(options DefaultAzureOptions) (auth.StreamingCredentialsProvider, error) {
+	return nil, ErrNotImplemented
+}
+
+type AuthorizationCodeWithPKCEOptions struct {
+	CredentialsProviderOptions
+}
+
+func NewAuthorizationCodeWithPKCECredentialsProvider(options AuthorizationCodeWithPKCEOptions) (auth.StreamingCredentialsProvider, error) {
+	return nil, ErrNotImplemented
+}
diff --git a/token.go b/token.go
@@ -0,0 +1,33 @@
+package entraid
+
+// Token represents the authentication token used to access the Entraid API.
+// It contains the username, password, expiration time, time to live, and the raw token.
+// The token is used to authenticate the user and authorize access to the API.
+// The token is typically obtained from an identity provider and is used to access the Entraid API.
+// The token is valid for a limited time and must be refreshed periodically.
+type Token struct {
+	// Username is the username of the user.
+	Username string `json:"username"`
+	// Password is the password of the user.
+	Password string `json:"password"`
+	// ExpiresAt is the expiration time of the token.
+	ExpiresAt int64 `json:"expires_at"`
+	// TTL is the time to live of the token.
+	TTL int64 `json:"ttl"`
+	// RawToken is the authentication token.
+	RawToken string `json:"raw_token"`
+}
+
+// TokenParserFunc is a function that parses the token and returns the username and password.
+type TokenParserFunc func(token string) (*Token, error)
+
+// copyToken creates a copy of the token.
+func copyToken(token *Token) *Token {
+	return &Token{
+		Username:  token.Username,
+		Password:  token.Password,
+		ExpiresAt: token.ExpiresAt,
+		TTL:       token.TTL,
+		RawToken:  token.RawToken,
+	}
+}
diff --git a/token_manager.go b/token_manager.go
diff --git a/version.go b/version.go
