mirror of
https://github.com/grafana/grafana.git
synced 2025-01-27 16:57:14 -06:00
20bb0a3ab1
* Add AuthNSvc reload handling * Working, need to add test * Remove commented out code * Add Reload implementation to connectors * Align and add tests, refactor * Add more tests, linting * Add extra checks + tests to oauth client * Clean up based on reviews * Move config instantiation into newSocialBase * Use specific error
68 lines
3.5 KiB
Go
68 lines
3.5 KiB
Go
package ssosettings
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/grafana/grafana/pkg/login/social"
|
|
"github.com/grafana/grafana/pkg/services/ssosettings/models"
|
|
)
|
|
|
|
var (
|
|
// ConfigurableOAuthProviders is a list of OAuth providers that can be configured from the API
|
|
// TODO: make it configurable
|
|
ConfigurableOAuthProviders = []string{"github", "gitlab", "google", "generic_oauth", "azuread", "okta"}
|
|
|
|
AllOAuthProviders = []string{social.GitHubProviderName, social.GitlabProviderName, social.GoogleProviderName, social.GenericOAuthProviderName, social.GrafanaComProviderName, social.AzureADProviderName, social.OktaProviderName}
|
|
)
|
|
|
|
// Service is a SSO settings service
|
|
//
|
|
//go:generate mockery --name Service --structname MockService --outpkg ssosettingstests --filename service_mock.go --output ./ssosettingstests/
|
|
type Service interface {
|
|
// List returns all SSO settings from DB and config files
|
|
List(ctx context.Context) ([]*models.SSOSettings, error)
|
|
// ListWithRedactedSecrets returns all SSO settings from DB and config files with secret values redacted
|
|
ListWithRedactedSecrets(ctx context.Context) ([]*models.SSOSettings, error)
|
|
// GetForProvider returns the SSO settings for a given provider (DB or config file)
|
|
GetForProvider(ctx context.Context, provider string) (*models.SSOSettings, error)
|
|
// GetForProviderWithRedactedSecrets returns the SSO settings for a given provider (DB or config file) with secret values redacted
|
|
GetForProviderWithRedactedSecrets(ctx context.Context, provider string) (*models.SSOSettings, error)
|
|
// Upsert creates or updates the SSO settings for a given provider
|
|
Upsert(ctx context.Context, settings *models.SSOSettings) error
|
|
// Delete deletes the SSO settings for a given provider (soft delete)
|
|
Delete(ctx context.Context, provider string) error
|
|
// Patch updates the specified SSO settings (key-value pairs) for a given provider
|
|
Patch(ctx context.Context, provider string, data map[string]any) error
|
|
// RegisterReloadable registers a reloadable for a given provider
|
|
RegisterReloadable(provider string, reloadable Reloadable)
|
|
// Reload reloads the settings for a given provider
|
|
Reload(ctx context.Context, provider string)
|
|
}
|
|
|
|
// Reloadable is an interface that can be implemented by a provider to allow it to be validated and reloaded
|
|
//
|
|
//go:generate mockery --name Reloadable --structname MockReloadable --outpkg ssosettingstests --filename reloadable_mock.go --output ./ssosettingstests/
|
|
type Reloadable interface {
|
|
Reload(ctx context.Context, settings models.SSOSettings) error
|
|
Validate(ctx context.Context, settings models.SSOSettings) error
|
|
}
|
|
|
|
// FallbackStrategy is an interface that can be implemented to allow a provider to load settings from a different source
|
|
// than the database. This is useful for providers that are not configured in the database, but instead are configured
|
|
// using the config file and/or environment variables. Used mostly for backwards compatibility.
|
|
type FallbackStrategy interface {
|
|
IsMatch(provider string) bool
|
|
// TODO: check if GetProviderConfig can return an error
|
|
GetProviderConfig(ctx context.Context, provider string) (map[string]any, error)
|
|
}
|
|
|
|
// Store is a SSO settings store
|
|
//
|
|
//go:generate mockery --name Store --structname MockStore --outpkg ssosettingstests --filename store_mock.go --output ./ssosettingstests/
|
|
type Store interface {
|
|
Get(ctx context.Context, provider string) (*models.SSOSettings, error)
|
|
List(ctx context.Context) ([]*models.SSOSettings, error)
|
|
Upsert(ctx context.Context, settings *models.SSOSettings) error
|
|
Delete(ctx context.Context, provider string) error
|
|
}
|