Files
grafana/pkg/services/ldap/api/support_bundle.go
Jo d4cfbd9fd3 LDAP: Move LDAP globals to Config (#63255)
* structure dtos and private methods

* add basic LDAP service

* use LDAP service in ldap debug API

* lower non fatal error

* remove unused globals

* wip

* remove final globals

* fix tests to use cfg enabled

* restructure errors

* remove logger from globals

* use ldap service in authn

* use ldap service in context handler

* fix failed tests

* fix ldap middleware provides

* fix provides in auth_test.go
2023-02-10 19:01:55 +01:00

89 lines
2.7 KiB
Go

package api
import (
"bytes"
"context"
"fmt"
"strings"
"github.com/BurntSushi/toml"
"github.com/grafana/grafana/pkg/services/supportbundles"
)
func (s *Service) supportBundleCollector(context.Context) (*supportbundles.SupportItem, error) {
bWriter := bytes.NewBuffer(nil)
bWriter.WriteString("# LDAP information\n\n")
ldapConfig := s.ldapService.Config()
if ldapConfig != nil {
bWriter.WriteString("## LDAP Status\n")
ldapClient := s.ldapService.Client()
ldapStatus, err := ldapClient.Ping()
if err != nil {
bWriter.WriteString(
fmt.Sprintf("Unable to ping server\n Err: %s", err))
}
for _, server := range ldapStatus {
bWriter.WriteString(fmt.Sprintf("\nHost: %s \n", server.Host))
bWriter.WriteString(fmt.Sprintf("Port: %d \n", server.Port))
bWriter.WriteString(fmt.Sprintf("Available: %v \n", server.Available))
if server.Error != nil {
bWriter.WriteString(fmt.Sprintf("Error: %s\n", server.Error))
}
}
bWriter.WriteString("\n## LDAP Common Configuration issues\n\n")
bWriter.WriteString("- Checked for **Mismatched search attributes**\n\n")
issue := false
for _, server := range ldapConfig.Servers {
server.BindPassword = "********" // censor password on config dump
server.ClientKey = "********" // censor client key on config dump
if !strings.Contains(server.SearchFilter, server.Attr.Username) {
bWriter.WriteString(fmt.Sprintf(
"Search filter does not match username attribute \n"+
"Server: %s \n"+
"Search filter: %s \n"+
"Username attribute: %s \n",
server.Host, server.SearchFilter, server.Attr.Username))
issue = true
}
}
if !issue {
bWriter.WriteString("No issues found\n\n")
}
}
bWriter.WriteString("## LDAP configuration\n\n")
bWriter.WriteString("```toml\n")
errM := toml.NewEncoder(bWriter).Encode(ldapConfig)
if errM != nil {
bWriter.WriteString(
fmt.Sprintf("Unable to encode LDAP configuration \n Err: %s", errM))
}
bWriter.WriteString("```\n\n")
bWriter.WriteString("## Grafana LDAP configuration\n\n")
bWriter.WriteString("```ini\n")
bWriter.WriteString(fmt.Sprintf("enabled = %v\n", s.cfg.LDAPEnabled))
bWriter.WriteString(fmt.Sprintf("config_file = %s\n", s.cfg.LDAPConfigFilePath))
bWriter.WriteString(fmt.Sprintf("allow_sign_up = %v\n", s.cfg.LDAPAllowSignup))
bWriter.WriteString(fmt.Sprintf("sync_cron = %s\n", s.cfg.LDAPSyncCron))
bWriter.WriteString(fmt.Sprintf("active_sync_enabled = %v\n", s.cfg.LDAPActiveSyncEnabled))
bWriter.WriteString(fmt.Sprintf("skip_org_role_sync = %v\n", s.cfg.LDAPSkipOrgRoleSync))
bWriter.WriteString("```\n\n")
return &supportbundles.SupportItem{
Filename: "ldap.md",
FileBytes: bWriter.Bytes(),
}, nil
}