Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Auth: Add all settings to Azure AD SSO config UI #83618

Merged
merged 6 commits into from Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 7 additions & 2 deletions pkg/login/social/connectors/azuread_oauth.go
Expand Up @@ -31,7 +31,10 @@ import (
const forceUseGraphAPIKey = "force_use_graph_api" // #nosec G101 not a hardcoded credential

var (
ExtraAzureADSettingKeys = []string{forceUseGraphAPIKey, allowedOrganizationsKey}
ExtraAzureADSettingKeys = map[string]ExtraKeyInfo{
forceUseGraphAPIKey: {Type: Bool, DefaultValue: false},
allowedOrganizationsKey: {Type: String},
}
errAzureADMissingGroups = &SocialError{"either the user does not have any group membership or the groups claim is missing from the token."}
)

Expand Down Expand Up @@ -80,7 +83,7 @@ func NewAzureADProvider(info *social.OAuthInfo, cfg *setting.Cfg, ssoSettings ss
SocialBase: newSocialBase(social.AzureADProviderName, info, features, cfg),
cache: cache,
allowedOrganizations: util.SplitString(info.Extra[allowedOrganizationsKey]),
forceUseGraphAPI: MustBool(info.Extra[forceUseGraphAPIKey], false),
forceUseGraphAPI: MustBool(info.Extra[forceUseGraphAPIKey], ExtraAzureADSettingKeys[forceUseGraphAPIKey].DefaultValue.(bool)),
}

if info.UseRefreshToken {
Expand Down Expand Up @@ -200,6 +203,8 @@ func (s *SocialAzureAD) Validate(ctx context.Context, settings ssoModels.SSOSett

return validation.Validate(info, requester,
validateAllowedGroups,
// FIXME: uncomment this after the Terraform provider is updated
//validation.MustBeEmptyValidator(info.ApiUrl, "API URL"),
validation.RequiredUrlValidator(info.AuthUrl, "Auth URL"),
validation.RequiredUrlValidator(info.TokenUrl, "Token URL"))
}
Expand Down
12 changes: 12 additions & 0 deletions pkg/login/social/connectors/common.go
Expand Up @@ -18,6 +18,18 @@ import (
"github.com/grafana/grafana/pkg/util"
)

type ExtraFieldType int

const (
String ExtraFieldType = iota
Bool
)

type ExtraKeyInfo struct {
Type ExtraFieldType
DefaultValue any
}

const (
// consider moving this to OAuthInfo
teamIdsKey = "team_ids"
Expand Down
8 changes: 7 additions & 1 deletion pkg/login/social/connectors/generic_oauth.go
Expand Up @@ -28,7 +28,13 @@ const (
idTokenAttributeNameKey = "id_token_attribute_name" // #nosec G101 not a hardcoded credential
)

var ExtraGenericOAuthSettingKeys = []string{nameAttributePathKey, loginAttributePathKey, idTokenAttributeNameKey, teamIdsKey, allowedOrganizationsKey}
var ExtraGenericOAuthSettingKeys = map[string]ExtraKeyInfo{
nameAttributePathKey: {Type: String},
loginAttributePathKey: {Type: String},
idTokenAttributeNameKey: {Type: String},
teamIdsKey: {Type: String},
allowedOrganizationsKey: {Type: String},
}

var _ social.SocialConnector = (*SocialGenericOAuth)(nil)
var _ ssosettings.Reloadable = (*SocialGenericOAuth)(nil)
Expand Down
5 changes: 4 additions & 1 deletion pkg/login/social/connectors/github_oauth.go
Expand Up @@ -24,7 +24,10 @@ import (
"github.com/grafana/grafana/pkg/util/errutil"
)

var ExtraGithubSettingKeys = []string{allowedOrganizationsKey, teamIdsKey}
var ExtraGithubSettingKeys = map[string]ExtraKeyInfo{
allowedOrganizationsKey: {Type: String},
teamIdsKey: {Type: String},
}

var _ social.SocialConnector = (*SocialGithub)(nil)
var _ ssosettings.Reloadable = (*SocialGithub)(nil)
Expand Down
5 changes: 4 additions & 1 deletion pkg/login/social/connectors/google_oauth.go
Expand Up @@ -27,9 +27,12 @@ const (
validateHDKey = "validate_hd"
)

var ExtraGoogleSettingKeys = map[string]ExtraKeyInfo{
validateHDKey: {Type: Bool, DefaultValue: true},
}

var _ social.SocialConnector = (*SocialGoogle)(nil)
var _ ssosettings.Reloadable = (*SocialGoogle)(nil)
var ExtraGoogleSettingKeys = []string{validateHDKey}

type SocialGoogle struct {
*SocialBase
Expand Down
4 changes: 3 additions & 1 deletion pkg/login/social/connectors/grafana_com_oauth.go
Expand Up @@ -20,7 +20,9 @@ import (
"github.com/grafana/grafana/pkg/util"
)

var ExtraGrafanaComSettingKeys = []string{allowedOrganizationsKey}
var ExtraGrafanaComSettingKeys = map[string]ExtraKeyInfo{
allowedOrganizationsKey: {Type: String, DefaultValue: ""},
}

var _ social.SocialConnector = (*SocialGrafanaCom)(nil)
var _ ssosettings.Reloadable = (*SocialGrafanaCom)(nil)
Expand Down
17 changes: 13 additions & 4 deletions pkg/services/ssosettings/strategies/oauth_strategy.go
Expand Up @@ -15,7 +15,7 @@ type OAuthStrategy struct {
settingsByProvider map[string]map[string]any
}

var extraKeysByProvider = map[string][]string{
var extraKeysByProvider = map[string]map[string]connectors.ExtraKeyInfo{
social.AzureADProviderName: connectors.ExtraAzureADSettingKeys,
social.GenericOAuthProviderName: connectors.ExtraGenericOAuthSettingKeys,
social.GitHubProviderName: connectors.ExtraGithubSettingKeys,
Expand Down Expand Up @@ -104,9 +104,18 @@ func (s *OAuthStrategy) loadSettingsForProvider(provider string) map[string]any
"signout_redirect_url": section.Key("signout_redirect_url").Value(),
}

extraFields := extraKeysByProvider[provider]
for _, key := range extraFields {
result[key] = section.Key(key).Value()
extraKeys := extraKeysByProvider[provider]
for key, keyInfo := range extraKeys {
switch keyInfo.Type {
case connectors.Bool:
result[key] = section.Key(key).MustBool(keyInfo.DefaultValue.(bool))
default:
if _, ok := keyInfo.DefaultValue.(string); !ok {
result[key] = section.Key(key).Value()
} else {
result[key] = section.Key(key).MustString(keyInfo.DefaultValue.(string))
}
}
}

return result
Expand Down
4 changes: 2 additions & 2 deletions pkg/services/ssosettings/strategies/oauth_strategy_test.go
Expand Up @@ -147,7 +147,7 @@ func TestGetProviderConfig_ExtraFields(t *testing.T) {
result, err := strategy.GetProviderConfig(context.Background(), social.AzureADProviderName)
require.NoError(t, err)

require.Equal(t, "true", result["force_use_graph_api"])
require.Equal(t, true, result["force_use_graph_api"])
require.Equal(t, "org1, org2", result["allowed_organizations"])
})

Expand Down Expand Up @@ -181,7 +181,7 @@ func TestGetProviderConfig_ExtraFields(t *testing.T) {
result, err := strategy.GetProviderConfig(context.Background(), social.GoogleProviderName)
require.NoError(t, err)

require.Equal(t, "true", result["validate_hd"])
require.Equal(t, true, result["validate_hd"])
})
}

Expand Down
44 changes: 43 additions & 1 deletion public/app/features/auth-config/fields.tsx
Expand Up @@ -14,7 +14,6 @@ export const fields: Record<SSOProvider['provider'], Array<keyof SSOProvider['se
github: ['name', 'clientId', 'clientSecret', 'teamIds', 'allowedOrganizations'],
google: ['name', 'clientId', 'clientSecret', 'allowedDomains'],
gitlab: ['name', 'clientId', 'clientSecret', 'allowedOrganizations', 'teamIds'],
azuread: ['name', 'clientId', 'clientSecret', 'authUrl', 'tokenUrl', 'scopes', 'allowedGroups', 'allowedDomains'],
okta: [
'name',
'clientId',
Expand All @@ -39,6 +38,44 @@ type Section = Record<
>;

export const sectionFields: Section = {
azuread: [
{
name: 'General settings',
id: 'general',
fields: [
'name',
'clientId',
'clientSecret',
'scopes',
'authUrl',
'tokenUrl',
'allowSignUp',
'autoLogin',
'signoutRedirectUrl',
],
},
{
name: 'User mapping',
id: 'user',
fields: ['roleAttributePath', 'roleAttributeStrict', 'allowAssignGrafanaAdmin', 'skipOrgRoleSync'],
},
{
name: 'Extra security measures',
id: 'extra',
fields: [
'allowedOrganizations',
'allowedDomains',
'allowedGroups',
'forceUseGraphApi',
'usePkce',
'useRefreshToken',
'tlsSkipVerifyInsecure',
'tlsClientCert',
'tlsClientKey',
'tlsClientCa',
dmihai marked this conversation as resolved.
Show resolved Hide resolved
],
},
],
generic_oauth: [
{
name: 'General settings',
Expand Down Expand Up @@ -320,6 +357,11 @@ export function fieldMap(provider: string): Record<string, FieldData> {
label: 'Define allowed teams ids',
type: 'switch',
},
forceUseGraphApi: {
label: 'Force use Graph API',
description: "If enabled, Grafana will fetch the users' groups using the Microsoft Graph API.",
type: 'checkbox',
},
usePkce: {
label: 'Use PKCE',
description: (
Expand Down
2 changes: 2 additions & 0 deletions public/app/features/auth-config/types.ts
Expand Up @@ -53,6 +53,8 @@ export type SSOProviderSettingsBase = {
defineAllowedTeamsIds?: boolean;
configureTLS?: boolean;
tlsSkipVerifyInsecure?: boolean;
// For Azure AD
forceUseGraphApi?: boolean;
};

// SSO data received from the API and sent to it
Expand Down