wip

Author: ndyakov

providers.go

@@ -1,6 +1,9 @@
 package entraid
 
 import (
+	"crypto"
+	"crypto/x509"
+
 	"github.com/redis/go-redis/v9/auth"
 )
 
@@ -9,6 +12,10 @@ type CredentialsProviderOptions struct {
 	// This is used to identify the identity when requesting a token.
 	ClientID string
 
+	// TenantID is the tenant ID of the service principal.
+	// This is used to identify the tenant when requesting a token.
+	TenantID 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
@@ -23,42 +30,59 @@ type CredentialsProviderOptions struct {
 	OnRetryableError func(error) error
 }
 
-type SystemAssignedOptions struct {
-	CredentialsProviderOptions
-}
-
-func NewSystemAssignedCredentialsProvider(options SystemAssignedOptions) (auth.StreamingCredentialsProvider, error) {
-	return nil, ErrNotImplemented
-}
-
-type UserAssignedOptions struct {
-	CredentialsProviderOptions
-}
+const (
+	// SystemAssignedIdentity is the type of identity that is automatically managed by Azure.
+	SystemAssignedIdentity = "SystemAssigned"
+	// UserAssignedIdentity is the type of identity that is managed by the user.
+	UserAssignedIdentity = "UserAssigned"
 
-func NewUserAssignedCredentialsProvider(options UserAssignedOptions) (auth.StreamingCredentialsProvider, error) {
-	return nil, ErrNotImplemented
-}
+	// ClientSecretCredentialType is the type of credentials that uses a client secret to authenticate.
+	ClientSecretCredentialType = "ClientSecret"
+	// ClientCertificateCredentialType is the type of credentials that uses a client certificate to authenticate.
+	ClientCertificateCredentialType = "ClientCertificate"
+)
 
-type ClientCredentialsOptions struct {
+type ManagedIdentityCredentialsProviderOptions struct {
 	CredentialsProviderOptions
+	ManagedIdentityType string
 }
 
-func NewClientCredentialsCredentialsProvider(options ClientCredentialsOptions) (auth.StreamingCredentialsProvider, error) {
+// NewManagedIdentityCredentialsProvider creates a new streaming credentials provider for managed identity.
+// It uses the provided options to configure the provider.
+// Use this when you want either a system assigned identity or a user assigned identity.
+// The system assigned identity is automatically managed by Azure and does not require any additional configuration.
+// The user assigned identity is a separate resource that can be managed independently.
+func NewManagedIdentityCredentialsProvider(options ManagedIdentityCredentialsProviderOptions) (*auth.StreamingCredentialsProvider, error) {
 	return nil, ErrNotImplemented
 }
 
-type DefaultAzureOptions struct {
+type ServicePrincipalCredentialsProviderOptions struct {
 	CredentialsProviderOptions
-}
 
-func NewDefaultAzureCredentialsProvider(options DefaultAzureOptions) (auth.StreamingCredentialsProvider, error) {
-	return nil, ErrNotImplemented
-}
-
-type AuthorizationCodeWithPKCEOptions struct {
-	CredentialsProviderOptions
+	// ClientCredentialType is the type of credentials that are used to authenticate the service principal.
+	// This can be either ClientSecret or ClientCertificate.
+	// ClientSecret is used to authenticate the service principal when requesting a token.
+	// ClientCertificate is used to authenticate the service principal using a certificate.
+	ClientCredentialType string
+
+	// ClientSecret is the client secret of the service principal.
+	// This is used to authenticate the service principal when requesting a token.
+	ClientSecret string
+
+	// ClientCertificate is the client certificate of the service principal.
+	// This is used to authenticate the service principal when requesting a token.
+	ClientCertificate x509.Certificate
+	// ClientCertificatePrivateKey is the private key of the client certificate.
+	// This is used to authenticate the service principal when requesting a token.
+	ClientCertificatePrivateKey crypto.PrivateKey
 }
 
-func NewAuthorizationCodeWithPKCECredentialsProvider(options AuthorizationCodeWithPKCEOptions) (auth.StreamingCredentialsProvider, error) {
+// NewServicePrincipalCredentialsProvider creates a new streaming credentials provider for service principal.
+// It uses the provided options to configure the provider.
+// Use this when you want to use a service principal to authenticate with Azure.
+// The service principal is a security identity that is used to authenticate with Azure.
+// It is typically used in scenarios where a user cannot be present to authenticate interactively.
+// The service principal is created in Azure Active Directory and is used to authenticate with Azure resources.
+func NewServicePrincipalCredentialsProvider(options ServicePrincipalCredentialsProviderOptions) (*auth.StreamingCredentialsProvider, error) {
 	return nil, ErrNotImplemented
 }