2023-01-23 08:11:40 +01:00
|
|
|
package azuread
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
|
|
|
|
"github.com/zitadel/oidc/v2/pkg/oidc"
|
|
|
|
"golang.org/x/oauth2"
|
|
|
|
"golang.org/x/text/language"
|
|
|
|
|
2023-03-14 20:20:38 +01:00
|
|
|
"github.com/zitadel/zitadel/internal/domain"
|
2023-01-23 08:11:40 +01:00
|
|
|
"github.com/zitadel/zitadel/internal/idp"
|
|
|
|
"github.com/zitadel/zitadel/internal/idp/providers/oauth"
|
|
|
|
)
|
|
|
|
|
|
|
|
const (
|
|
|
|
authURLTemplate string = "https://login.microsoftonline.com/%s/oauth2/v2.0/authorize"
|
|
|
|
tokenURLTemplate string = "https://login.microsoftonline.com/%s/oauth2/v2.0/token"
|
2023-08-04 11:35:36 +02:00
|
|
|
userURL string = "https://graph.microsoft.com/v1.0/me"
|
|
|
|
userinfoEndpoint string = "https://graph.microsoft.com/oidc/userinfo"
|
2023-04-17 09:02:16 +02:00
|
|
|
|
|
|
|
ScopeUserRead string = "User.Read"
|
2023-01-23 08:11:40 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
// TenantType are the well known tenant types to scope the users that can authenticate. TenantType is not an
|
|
|
|
// exclusive list of Azure Tenants which can be used. A consumer can also use their own Tenant ID to scope
|
|
|
|
// authentication to their specific Tenant either through the Tenant ID or the friendly domain name.
|
|
|
|
//
|
|
|
|
// see also https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-v2-protocols#endpoints
|
|
|
|
type TenantType string
|
|
|
|
|
|
|
|
const (
|
|
|
|
// CommonTenant allows users with both personal Microsoft accounts and work/school accounts from Azure Active
|
|
|
|
// Directory to sign in to the application.
|
|
|
|
CommonTenant TenantType = "common"
|
|
|
|
|
|
|
|
// OrganizationsTenant allows only users with work/school accounts from Azure Active Directory to sign in to the application.
|
|
|
|
OrganizationsTenant TenantType = "organizations"
|
|
|
|
|
|
|
|
// ConsumersTenant allows only users with personal Microsoft accounts (MSA) to sign in to the application.
|
|
|
|
ConsumersTenant TenantType = "consumers"
|
|
|
|
)
|
|
|
|
|
|
|
|
var _ idp.Provider = (*Provider)(nil)
|
|
|
|
|
|
|
|
// Provider is the [idp.Provider] implementation for AzureAD (V2 Endpoints)
|
|
|
|
type Provider struct {
|
|
|
|
*oauth.Provider
|
|
|
|
tenant TenantType
|
|
|
|
emailVerified bool
|
|
|
|
options []oauth.ProviderOpts
|
|
|
|
}
|
|
|
|
|
|
|
|
type ProviderOptions func(*Provider)
|
|
|
|
|
|
|
|
// WithTenant allows to set a [TenantType] (can also be a Tenant ID)
|
|
|
|
// default is CommonTenant
|
|
|
|
func WithTenant(tenantType TenantType) ProviderOptions {
|
|
|
|
return func(p *Provider) {
|
|
|
|
p.tenant = tenantType
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithEmailVerified allows to set every email received as verified
|
|
|
|
func WithEmailVerified() ProviderOptions {
|
|
|
|
return func(p *Provider) {
|
|
|
|
p.emailVerified = true
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// WithOAuthOptions allows to specify [oauth.ProviderOpts] like [oauth.WithLinkingAllowed]
|
|
|
|
func WithOAuthOptions(opts ...oauth.ProviderOpts) ProviderOptions {
|
|
|
|
return func(p *Provider) {
|
|
|
|
p.options = append(p.options, opts...)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// New creates an AzureAD provider using the [oauth.Provider] (OAuth 2.0 generic provider).
|
|
|
|
// By default, it uses the [CommonTenant] and unverified emails.
|
2023-03-15 07:48:37 +01:00
|
|
|
func New(name, clientID, clientSecret, redirectURI string, scopes []string, opts ...ProviderOptions) (*Provider, error) {
|
2023-01-23 08:11:40 +01:00
|
|
|
provider := &Provider{
|
|
|
|
tenant: CommonTenant,
|
|
|
|
options: make([]oauth.ProviderOpts, 0),
|
|
|
|
}
|
|
|
|
for _, opt := range opts {
|
|
|
|
opt(provider)
|
|
|
|
}
|
2023-03-15 07:48:37 +01:00
|
|
|
config := newConfig(provider.tenant, clientID, clientSecret, redirectURI, scopes)
|
2023-01-23 08:11:40 +01:00
|
|
|
rp, err := oauth.New(
|
|
|
|
config,
|
|
|
|
name,
|
2023-08-04 11:35:36 +02:00
|
|
|
userURL,
|
2023-01-23 08:11:40 +01:00
|
|
|
func() idp.User {
|
|
|
|
return &User{isEmailVerified: provider.emailVerified}
|
|
|
|
},
|
|
|
|
provider.options...,
|
|
|
|
)
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
provider.Provider = rp
|
|
|
|
return provider, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
func newConfig(tenant TenantType, clientID, secret, callbackURL string, scopes []string) *oauth2.Config {
|
2023-04-17 09:02:16 +02:00
|
|
|
return &oauth2.Config{
|
2023-01-23 08:11:40 +01:00
|
|
|
ClientID: clientID,
|
|
|
|
ClientSecret: secret,
|
|
|
|
RedirectURL: callbackURL,
|
|
|
|
Endpoint: oauth2.Endpoint{
|
|
|
|
AuthURL: fmt.Sprintf(authURLTemplate, tenant),
|
|
|
|
TokenURL: fmt.Sprintf(tokenURLTemplate, tenant),
|
|
|
|
},
|
2023-04-17 09:02:16 +02:00
|
|
|
Scopes: ensureMinimalScope(scopes),
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|
2023-04-17 09:02:16 +02:00
|
|
|
}
|
2023-01-23 08:11:40 +01:00
|
|
|
|
2023-04-17 09:02:16 +02:00
|
|
|
// ensureMinimalScope ensures that at least openid and `User.Read` ist set
|
|
|
|
// if none is provided it will request `openid profile email phone User.Read`
|
|
|
|
func ensureMinimalScope(scopes []string) []string {
|
|
|
|
if len(scopes) == 0 {
|
|
|
|
return []string{oidc.ScopeOpenID, oidc.ScopeProfile, oidc.ScopeEmail, oidc.ScopePhone, ScopeUserRead}
|
|
|
|
}
|
|
|
|
var openIDSet, userReadSet bool
|
|
|
|
for _, scope := range scopes {
|
|
|
|
if scope == oidc.ScopeOpenID {
|
|
|
|
openIDSet = true
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
if scope == ScopeUserRead {
|
|
|
|
userReadSet = true
|
|
|
|
continue
|
|
|
|
}
|
|
|
|
}
|
|
|
|
if !openIDSet {
|
|
|
|
scopes = append(scopes, oidc.ScopeOpenID)
|
|
|
|
}
|
|
|
|
if !userReadSet {
|
|
|
|
scopes = append(scopes, ScopeUserRead)
|
|
|
|
}
|
|
|
|
return scopes
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// User represents the structure return on the userinfo endpoint and implements the [idp.User] interface
|
|
|
|
//
|
|
|
|
// AzureAD does not return an `email_verified` claim.
|
|
|
|
// The verification can be automatically activated on the provider ([WithEmailVerified])
|
|
|
|
type User struct {
|
2023-03-15 07:48:37 +01:00
|
|
|
ID string `json:"id"`
|
|
|
|
BusinessPhones []domain.PhoneNumber `json:"businessPhones"`
|
|
|
|
DisplayName string `json:"displayName"`
|
|
|
|
FirstName string `json:"givenName"`
|
|
|
|
JobTitle string `json:"jobTitle"`
|
|
|
|
Email domain.EmailAddress `json:"mail"`
|
|
|
|
MobilePhone domain.PhoneNumber `json:"mobilePhone"`
|
|
|
|
OfficeLocation string `json:"officeLocation"`
|
|
|
|
PreferredLanguage string `json:"preferredLanguage"`
|
|
|
|
LastName string `json:"surname"`
|
|
|
|
UserPrincipalName string `json:"userPrincipalName"`
|
2023-01-23 08:11:40 +01:00
|
|
|
isEmailVerified bool
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetID is an implementation of the [idp.User] interface.
|
|
|
|
func (u *User) GetID() string {
|
2023-03-15 07:48:37 +01:00
|
|
|
return u.ID
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// GetFirstName is an implementation of the [idp.User] interface.
|
|
|
|
func (u *User) GetFirstName() string {
|
2023-03-15 07:48:37 +01:00
|
|
|
return u.FirstName
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// GetLastName is an implementation of the [idp.User] interface.
|
|
|
|
func (u *User) GetLastName() string {
|
2023-03-15 07:48:37 +01:00
|
|
|
return u.LastName
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// GetDisplayName is an implementation of the [idp.User] interface.
|
|
|
|
func (u *User) GetDisplayName() string {
|
2023-03-15 07:48:37 +01:00
|
|
|
return u.DisplayName
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// GetNickname is an implementation of the [idp.User] interface.
|
|
|
|
// It returns an empty string because AzureAD does not provide the user's nickname.
|
|
|
|
func (u *User) GetNickname() string {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetPreferredUsername is an implementation of the [idp.User] interface.
|
|
|
|
func (u *User) GetPreferredUsername() string {
|
2023-03-15 07:48:37 +01:00
|
|
|
return u.UserPrincipalName
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// GetEmail is an implementation of the [idp.User] interface.
|
2023-03-14 20:20:38 +01:00
|
|
|
func (u *User) GetEmail() domain.EmailAddress {
|
2023-03-15 07:48:37 +01:00
|
|
|
if u.Email == "" {
|
|
|
|
// if the user used a social login on Azure as well, the email will be empty
|
|
|
|
// but is used as username
|
|
|
|
return domain.EmailAddress(u.UserPrincipalName)
|
|
|
|
}
|
2023-01-23 08:11:40 +01:00
|
|
|
return u.Email
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsEmailVerified is an implementation of the [idp.User] interface
|
|
|
|
// returning the value specified in the creation of the [Provider].
|
|
|
|
// Default is false because AzureAD does not return an `email_verified` claim.
|
|
|
|
// The verification can be automatically activated on the provider ([WithEmailVerified]).
|
|
|
|
func (u *User) IsEmailVerified() bool {
|
|
|
|
return u.isEmailVerified
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetPhone is an implementation of the [idp.User] interface.
|
|
|
|
// It returns an empty string because AzureAD does not provide the user's phone.
|
2023-03-14 20:20:38 +01:00
|
|
|
func (u *User) GetPhone() domain.PhoneNumber {
|
2023-01-23 08:11:40 +01:00
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
// IsPhoneVerified is an implementation of the [idp.User] interface.
|
|
|
|
// It returns false because AzureAD does not provide the user's phone.
|
|
|
|
func (u *User) IsPhoneVerified() bool {
|
|
|
|
return false
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetPreferredLanguage is an implementation of the [idp.User] interface.
|
|
|
|
func (u *User) GetPreferredLanguage() language.Tag {
|
2023-03-15 07:48:37 +01:00
|
|
|
return language.Make(u.PreferredLanguage)
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// GetProfile is an implementation of the [idp.User] interface.
|
|
|
|
// It returns an empty string because AzureAD does not provide the user's profile page.
|
|
|
|
func (u *User) GetProfile() string {
|
|
|
|
return ""
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetAvatarURL is an implementation of the [idp.User] interface.
|
|
|
|
func (u *User) GetAvatarURL() string {
|
2023-03-15 07:48:37 +01:00
|
|
|
return ""
|
2023-01-23 08:11:40 +01:00
|
|
|
}
|