ldap.go 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
  1. package auth
  2. import (
  3. "errors"
  4. "fmt"
  5. "github.com/go-ldap/ldap"
  6. "github.com/grafana/grafana/pkg/bus"
  7. "github.com/grafana/grafana/pkg/log"
  8. m "github.com/grafana/grafana/pkg/models"
  9. "github.com/grafana/grafana/pkg/setting"
  10. )
  11. func init() {
  12. setting.LdapServers = []*setting.LdapServerConf{
  13. &setting.LdapServerConf{
  14. UseSSL: false,
  15. Host: "127.0.0.1",
  16. Port: "389",
  17. BindDN: "cn=%s,dc=grafana,dc=org",
  18. AttrName: "givenName",
  19. AttrSurname: "sn",
  20. AttrUsername: "cn",
  21. AttrMemberOf: "memberOf",
  22. AttrEmail: "email",
  23. SearchFilter: "(cn=%s)",
  24. SearchBaseDNs: []string{"dc=grafana,dc=org"},
  25. },
  26. }
  27. }
  28. type ldapAuther struct {
  29. server *setting.LdapServerConf
  30. conn *ldap.Conn
  31. }
  32. type ldapUserInfo struct {
  33. FirstName string
  34. LastName string
  35. Username string
  36. Email string
  37. MemberOf []string
  38. }
  39. func (u *ldapUserInfo) isMemberOfAny(groups []string) bool {
  40. for _, group := range groups {
  41. if u.isMemberOf(group) {
  42. return true
  43. }
  44. }
  45. return false
  46. }
  47. func (u *ldapUserInfo) isMemberOf(group string) bool {
  48. for _, member := range u.MemberOf {
  49. if member == group {
  50. return true
  51. }
  52. }
  53. return false
  54. }
  55. func NewLdapAuthenticator(server *setting.LdapServerConf) *ldapAuther {
  56. return &ldapAuther{
  57. server: server,
  58. }
  59. }
  60. func (a *ldapAuther) Dial() error {
  61. address := fmt.Sprintf("%s:%s", a.server.Host, a.server.Port)
  62. var err error
  63. if a.server.UseSSL {
  64. a.conn, err = ldap.DialTLS("tcp", address, nil)
  65. } else {
  66. a.conn, err = ldap.Dial("tcp", address)
  67. }
  68. return err
  69. }
  70. func (a *ldapAuther) login(query *AuthenticateUserQuery) error {
  71. if err := a.Dial(); err != nil {
  72. return err
  73. }
  74. defer a.conn.Close()
  75. // perform initial authentication
  76. if err := a.initialBind(query.Username, query.Password); err != nil {
  77. return err
  78. }
  79. // find user entry & attributes
  80. if ldapUser, err := a.searchForUser(query.Username); err != nil {
  81. return err
  82. } else {
  83. log.Info("Surname: %s", ldapUser.LastName)
  84. log.Info("givenName: %s", ldapUser.FirstName)
  85. log.Info("email: %s", ldapUser.Email)
  86. log.Info("memberOf: %s", ldapUser.MemberOf)
  87. if grafanaUser, err := a.getGrafanaUserFor(ldapUser); err != nil {
  88. return err
  89. } else {
  90. query.User = grafanaUser
  91. return nil
  92. }
  93. }
  94. }
  95. func (a *ldapAuther) getGrafanaUserFor(ldapUser *ldapUserInfo) (*m.User, error) {
  96. // get user from grafana db
  97. userQuery := m.GetUserByLoginQuery{LoginOrEmail: ldapUser.Username}
  98. if err := bus.Dispatch(&userQuery); err != nil {
  99. if err == m.ErrUserNotFound {
  100. return a.createGrafanaUser(ldapUser)
  101. }
  102. }
  103. return userQuery.Result, nil
  104. }
  105. func (a *ldapAuther) createGrafanaUser(ldapUser *ldapUserInfo) (*m.User, error) {
  106. cmd := m.CreateUserCommand{
  107. Login: ldapUser.Username,
  108. Email: ldapUser.Email,
  109. Name: fmt.Sprintf("%s %s", ldapUser.FirstName, ldapUser.LastName),
  110. }
  111. if err := bus.Dispatch(&cmd); err != nil {
  112. return nil, err
  113. }
  114. return &cmd.Result, nil
  115. }
  116. func (a *ldapAuther) initialBind(username, userPassword string) error {
  117. if a.server.BindPassword != "" {
  118. userPassword = a.server.BindPassword
  119. }
  120. bindPath := fmt.Sprintf(a.server.BindDN, username)
  121. if err := a.conn.Bind(bindPath, userPassword); err != nil {
  122. if ldapErr, ok := err.(*ldap.Error); ok {
  123. if ldapErr.ResultCode == 49 {
  124. return ErrInvalidCredentials
  125. }
  126. }
  127. return err
  128. }
  129. return nil
  130. }
  131. func (a *ldapAuther) searchForUser(username string) (*ldapUserInfo, error) {
  132. var searchResult *ldap.SearchResult
  133. var err error
  134. for _, searchBase := range a.server.SearchBaseDNs {
  135. searchReq := ldap.SearchRequest{
  136. BaseDN: searchBase,
  137. Scope: ldap.ScopeWholeSubtree,
  138. DerefAliases: ldap.NeverDerefAliases,
  139. Attributes: []string{
  140. a.server.AttrUsername,
  141. a.server.AttrSurname,
  142. a.server.AttrEmail,
  143. a.server.AttrName,
  144. a.server.AttrMemberOf,
  145. },
  146. Filter: fmt.Sprintf(a.server.SearchFilter, username),
  147. }
  148. searchResult, err = a.conn.Search(&searchReq)
  149. if err != nil {
  150. return nil, err
  151. }
  152. if len(searchResult.Entries) > 0 {
  153. break
  154. }
  155. }
  156. if len(searchResult.Entries) == 0 {
  157. return nil, errors.New("Ldap search matched no entry, please review your filter setting.")
  158. }
  159. if len(searchResult.Entries) > 1 {
  160. return nil, errors.New("Ldap search matched mopre than one entry, please review your filter setting")
  161. }
  162. return &ldapUserInfo{
  163. LastName: getLdapAttr(a.server.AttrSurname, searchResult),
  164. FirstName: getLdapAttr(a.server.AttrName, searchResult),
  165. Username: getLdapAttr(a.server.AttrUsername, searchResult),
  166. Email: getLdapAttr(a.server.AttrEmail, searchResult),
  167. MemberOf: getLdapAttrArray(a.server.AttrMemberOf, searchResult),
  168. }, nil
  169. }
  170. func getLdapAttr(name string, result *ldap.SearchResult) string {
  171. for _, attr := range result.Entries[0].Attributes {
  172. if attr.Name == name {
  173. if len(attr.Values) > 0 {
  174. return attr.Values[0]
  175. }
  176. }
  177. }
  178. return ""
  179. }
  180. func getLdapAttrArray(name string, result *ldap.SearchResult) []string {
  181. for _, attr := range result.Entries[0].Attributes {
  182. if attr.Name == name {
  183. return attr.Values
  184. }
  185. }
  186. return []string{}
  187. }
  188. func createUserFromLdapInfo() error {
  189. return nil
  190. }