mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
social: add GitLab authentication backend
GitLab could already be used as an authentication backend by properly configuring `auth.generic_oauth`, but then there was no way to authorize users based on their GitLab group membership. This commit adds a `auth.gitlab` backend, similar to `auth.github`, with an `allowed_groups` option that can be set to a list of groups whose members should be allowed access to Grafana.
This commit is contained in:
parent
aefcb06ff8
commit
7ec146df99
@ -270,6 +270,18 @@ api_url = https://api.github.com/user
|
||||
team_ids =
|
||||
allowed_organizations =
|
||||
|
||||
#################################### GitLab Auth #########################
|
||||
[auth.gitlab]
|
||||
enabled = false
|
||||
allow_sign_up = true
|
||||
client_id = some_id
|
||||
client_secret = some_secret
|
||||
scopes = api
|
||||
auth_url = https://gitlab.com/oauth/authorize
|
||||
token_url = https://gitlab.com/oauth/token
|
||||
api_url = https://gitlab.com/api/v4
|
||||
allowed_groups =
|
||||
|
||||
#################################### Google Auth #########################
|
||||
[auth.google]
|
||||
enabled = false
|
||||
|
@ -8,4 +8,5 @@ const (
|
||||
TWITTER
|
||||
GENERIC
|
||||
GRAFANA_COM
|
||||
GITLAB
|
||||
)
|
||||
|
131
pkg/social/gitlab_oauth.go
Normal file
131
pkg/social/gitlab_oauth.go
Normal file
@ -0,0 +1,131 @@
|
||||
package social
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"regexp"
|
||||
|
||||
"github.com/grafana/grafana/pkg/models"
|
||||
|
||||
"golang.org/x/oauth2"
|
||||
)
|
||||
|
||||
type SocialGitlab struct {
|
||||
*SocialBase
|
||||
allowedDomains []string
|
||||
allowedGroups []string
|
||||
apiUrl string
|
||||
allowSignup bool
|
||||
}
|
||||
|
||||
var (
|
||||
ErrMissingGroupMembership = &Error{"User not a member of one of the required groups"}
|
||||
)
|
||||
|
||||
func (s *SocialGitlab) Type() int {
|
||||
return int(models.GITLAB)
|
||||
}
|
||||
|
||||
func (s *SocialGitlab) IsEmailAllowed(email string) bool {
|
||||
return isEmailAllowed(email, s.allowedDomains)
|
||||
}
|
||||
|
||||
func (s *SocialGitlab) IsSignupAllowed() bool {
|
||||
return s.allowSignup
|
||||
}
|
||||
|
||||
func (s *SocialGitlab) IsGroupMember(client *http.Client) bool {
|
||||
if len(s.allowedGroups) == 0 {
|
||||
return true
|
||||
}
|
||||
|
||||
for groups, url := s.GetGroups(client, s.apiUrl+"/groups"); groups != nil; groups, url = s.GetGroups(client, url) {
|
||||
for _, allowedGroup := range s.allowedGroups {
|
||||
for _, group := range groups {
|
||||
if group == allowedGroup {
|
||||
return true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return false
|
||||
}
|
||||
|
||||
func (s *SocialGitlab) GetGroups(client *http.Client, url string) ([]string, string) {
|
||||
type Group struct {
|
||||
FullPath string `json:"full_path"`
|
||||
}
|
||||
|
||||
var (
|
||||
groups []Group
|
||||
next string
|
||||
)
|
||||
|
||||
if url == "" {
|
||||
return nil, next
|
||||
}
|
||||
|
||||
response, err := HttpGet(client, url)
|
||||
if err != nil {
|
||||
s.log.Error("Error getting groups from GitLab API", "err", err)
|
||||
return nil, next
|
||||
}
|
||||
|
||||
if err := json.Unmarshal(response.Body, &groups); err != nil {
|
||||
s.log.Error("Error parsing JSON from GitLab API", "err", err)
|
||||
return nil, next
|
||||
}
|
||||
|
||||
fullPaths := make([]string, len(groups))
|
||||
for i, group := range groups {
|
||||
fullPaths[i] = group.FullPath
|
||||
}
|
||||
|
||||
if link, ok := response.Headers["Link"]; ok {
|
||||
pattern := regexp.MustCompile(`<([^>]+)>; rel="next"`)
|
||||
if matches := pattern.FindStringSubmatch(link[0]); matches != nil {
|
||||
next = matches[1]
|
||||
}
|
||||
}
|
||||
|
||||
return fullPaths, next
|
||||
}
|
||||
|
||||
func (s *SocialGitlab) UserInfo(client *http.Client, token *oauth2.Token) (*BasicUserInfo, error) {
|
||||
|
||||
var data struct {
|
||||
Id int
|
||||
Username string
|
||||
Email string
|
||||
Name string
|
||||
State string
|
||||
}
|
||||
|
||||
response, err := HttpGet(client, s.apiUrl+"/user")
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("Error getting user info: %s", err)
|
||||
}
|
||||
|
||||
err = json.Unmarshal(response.Body, &data)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("Error getting user info: %s", err)
|
||||
}
|
||||
|
||||
if data.State != "active" {
|
||||
return nil, fmt.Errorf("User %s is inactive", data.Username)
|
||||
}
|
||||
|
||||
userInfo := &BasicUserInfo{
|
||||
Name: data.Name,
|
||||
Login: data.Username,
|
||||
Email: data.Email,
|
||||
}
|
||||
|
||||
if !s.IsGroupMember(client) {
|
||||
return nil, ErrMissingGroupMembership
|
||||
}
|
||||
|
||||
return userInfo, nil
|
||||
}
|
@ -55,7 +55,7 @@ func NewOAuthService() {
|
||||
setting.OAuthService = &setting.OAuther{}
|
||||
setting.OAuthService.OAuthInfos = make(map[string]*setting.OAuthInfo)
|
||||
|
||||
allOauthes := []string{"github", "google", "generic_oauth", "grafananet", "grafana_com"}
|
||||
allOauthes := []string{"github", "gitlab", "google", "generic_oauth", "grafananet", "grafana_com"}
|
||||
|
||||
for _, name := range allOauthes {
|
||||
sec := setting.Raw.Section("auth." + name)
|
||||
@ -115,6 +115,20 @@ func NewOAuthService() {
|
||||
}
|
||||
}
|
||||
|
||||
// GitLab.
|
||||
if name == "gitlab" {
|
||||
SocialMap["gitlab"] = &SocialGitlab{
|
||||
SocialBase: &SocialBase{
|
||||
Config: &config,
|
||||
log: logger,
|
||||
},
|
||||
allowedDomains: info.AllowedDomains,
|
||||
apiUrl: info.ApiUrl,
|
||||
allowSignup: info.AllowSignup,
|
||||
allowedGroups: util.SplitString(sec.Key("allowed_groups").String()),
|
||||
}
|
||||
}
|
||||
|
||||
// Google.
|
||||
if name == "google" {
|
||||
SocialMap["google"] = &SocialGoogle{
|
||||
|
@ -51,6 +51,10 @@
|
||||
<i class="btn-service-icon fa fa-github"></i>
|
||||
Sign in with GitHub
|
||||
</a>
|
||||
<a class="btn btn-medium btn-service btn-service--gitlab login-btn" href="login/gitlab" target="_self" ng-if="oauth.gitlab">
|
||||
<i class="btn-service-icon fa fa-gitlab"></i>
|
||||
Sign in with GitLab
|
||||
</a>
|
||||
<a class="btn btn-medium btn-inverse btn-service btn-service--grafanacom login-btn" href="login/grafana_com" target="_self"
|
||||
ng-if="oauth.grafana_com">
|
||||
<i class="btn-service-icon"></i>
|
||||
|
@ -195,6 +195,7 @@ $tabs-padding: 10px 15px 9px;
|
||||
|
||||
$external-services: (
|
||||
github: (bgColor: #464646, borderColor: #393939, icon: ''),
|
||||
gitlab: (bgColor: #fc6d26, borderColor: #e24329, icon: ''),
|
||||
google: (bgColor: #e84d3c, borderColor: #b83e31, icon: ''),
|
||||
grafanacom: (bgColor: inherit, borderColor: #393939, icon: ''),
|
||||
oauth: (bgColor: inherit, borderColor: #393939, icon: '')
|
||||
|
Loading…
Reference in New Issue
Block a user