aboutsummaryrefslogtreecommitdiff
path: root/internal/db/login_source.go
diff options
context:
space:
mode:
authorᴜɴᴋɴᴡᴏɴ <u@gogs.io>2020-09-20 11:19:02 +0800
committerGitHub <noreply@github.com>2020-09-20 11:19:02 +0800
commit3af91d7cfdb334e602d312743a89e64cd2d369ee (patch)
treec04a148917cdd9be878ca0e5fbcd552825c18df7 /internal/db/login_source.go
parentb836a56e6e823eecbce2dd99121a340418f1d5b7 (diff)
auth: decouple types and functions from db (#6320)
Diffstat (limited to 'internal/db/login_source.go')
-rw-r--r--internal/db/login_source.go342
1 files changed, 0 insertions, 342 deletions
diff --git a/internal/db/login_source.go b/internal/db/login_source.go
deleted file mode 100644
index 125d771a..00000000
--- a/internal/db/login_source.go
+++ /dev/null
@@ -1,342 +0,0 @@
-// Copyright 2014 The Gogs Authors. All rights reserved.
-// Use of this source code is governed by a MIT-style
-// license that can be found in the LICENSE file.
-
-// FIXME: Put this file into its own package and separate into different files based on login sources.
-package db
-
-import (
- "crypto/tls"
- "fmt"
- "net/smtp"
- "net/textproto"
- "strings"
-
- "github.com/go-macaron/binding"
- "github.com/unknwon/com"
-
- "gogs.io/gogs/internal/auth/github"
- "gogs.io/gogs/internal/auth/ldap"
- "gogs.io/gogs/internal/auth/pam"
- "gogs.io/gogs/internal/db/errors"
-)
-
-type LoginType int
-
-// Note: new type must append to the end of list to maintain compatibility.
-// TODO: Move to authutil.
-const (
- LoginNotype LoginType = iota
- LoginPlain // 1
- LoginLDAP // 2
- LoginSMTP // 3
- LoginPAM // 4
- LoginDLDAP // 5
- LoginGitHub // 6
-)
-
-var LoginNames = map[LoginType]string{
- LoginLDAP: "LDAP (via BindDN)",
- LoginDLDAP: "LDAP (simple auth)", // Via direct bind
- LoginSMTP: "SMTP",
- LoginPAM: "PAM",
- LoginGitHub: "GitHub",
-}
-
-// ***********************
-// ----- LDAP config -----
-// ***********************
-
-type LDAPConfig struct {
- ldap.Source `ini:"config"`
-}
-
-var SecurityProtocolNames = map[ldap.SecurityProtocol]string{
- ldap.SecurityProtocolUnencrypted: "Unencrypted",
- ldap.SecurityProtocolLDAPS: "LDAPS",
- ldap.SecurityProtocolStartTLS: "StartTLS",
-}
-
-func (cfg *LDAPConfig) SecurityProtocolName() string {
- return SecurityProtocolNames[cfg.SecurityProtocol]
-}
-
-func composeFullName(firstname, surname, username string) string {
- switch {
- case len(firstname) == 0 && len(surname) == 0:
- return username
- case len(firstname) == 0:
- return surname
- case len(surname) == 0:
- return firstname
- default:
- return firstname + " " + surname
- }
-}
-
-// LoginViaLDAP queries if login/password is valid against the LDAP directory pool,
-// and create a local user if success when enabled.
-func LoginViaLDAP(login, password string, source *LoginSource, autoRegister bool) (*User, error) {
- username, fn, sn, mail, isAdmin, succeed := source.Config.(*LDAPConfig).SearchEntry(login, password, source.Type == LoginDLDAP)
- if !succeed {
- // User not in LDAP, do nothing
- return nil, ErrUserNotExist{args: map[string]interface{}{"login": login}}
- }
-
- if !autoRegister {
- return nil, nil
- }
-
- // Fallback.
- if len(username) == 0 {
- username = login
- }
- // Validate username make sure it satisfies requirement.
- if binding.AlphaDashDotPattern.MatchString(username) {
- return nil, fmt.Errorf("Invalid pattern for attribute 'username' [%s]: must be valid alpha or numeric or dash(-_) or dot characters", username)
- }
-
- if len(mail) == 0 {
- mail = fmt.Sprintf("%s@localhost", username)
- }
-
- user := &User{
- LowerName: strings.ToLower(username),
- Name: username,
- FullName: composeFullName(fn, sn, username),
- Email: mail,
- LoginSource: source.ID,
- LoginName: login,
- IsActive: true,
- IsAdmin: isAdmin,
- }
-
- ok, err := IsUserExist(0, user.Name)
- if err != nil {
- return user, err
- }
-
- if ok {
- return user, UpdateUser(user)
- }
-
- return user, CreateUser(user)
-}
-
-// ***********************
-// ----- SMTP config -----
-// ***********************
-
-type SMTPConfig struct {
- Auth string
- Host string
- Port int
- AllowedDomains string
- TLS bool `ini:"tls"`
- SkipVerify bool
-}
-
-type smtpLoginAuth struct {
- username, password string
-}
-
-func (auth *smtpLoginAuth) Start(server *smtp.ServerInfo) (string, []byte, error) {
- return "LOGIN", []byte(auth.username), nil
-}
-
-func (auth *smtpLoginAuth) Next(fromServer []byte, more bool) ([]byte, error) {
- if more {
- switch string(fromServer) {
- case "Username:":
- return []byte(auth.username), nil
- case "Password:":
- return []byte(auth.password), nil
- }
- }
- return nil, nil
-}
-
-const (
- SMTPPlain = "PLAIN"
- SMTPLogin = "LOGIN"
-)
-
-var SMTPAuths = []string{SMTPPlain, SMTPLogin}
-
-func SMTPAuth(a smtp.Auth, cfg *SMTPConfig) error {
- c, err := smtp.Dial(fmt.Sprintf("%s:%d", cfg.Host, cfg.Port))
- if err != nil {
- return err
- }
- defer c.Close()
-
- if err = c.Hello("gogs"); err != nil {
- return err
- }
-
- if cfg.TLS {
- if ok, _ := c.Extension("STARTTLS"); ok {
- if err = c.StartTLS(&tls.Config{
- InsecureSkipVerify: cfg.SkipVerify,
- ServerName: cfg.Host,
- }); err != nil {
- return err
- }
- } else {
- return errors.New("SMTP server unsupports TLS")
- }
- }
-
- if ok, _ := c.Extension("AUTH"); ok {
- if err = c.Auth(a); err != nil {
- return err
- }
- return nil
- }
- return errors.New("Unsupported SMTP authentication method")
-}
-
-// LoginViaSMTP queries if login/password is valid against the SMTP,
-// and create a local user if success when enabled.
-func LoginViaSMTP(login, password string, sourceID int64, cfg *SMTPConfig, autoRegister bool) (*User, error) {
- // Verify allowed domains.
- if len(cfg.AllowedDomains) > 0 {
- idx := strings.Index(login, "@")
- if idx == -1 {
- return nil, ErrUserNotExist{args: map[string]interface{}{"login": login}}
- } else if !com.IsSliceContainsStr(strings.Split(cfg.AllowedDomains, ","), login[idx+1:]) {
- return nil, ErrUserNotExist{args: map[string]interface{}{"login": login}}
- }
- }
-
- var auth smtp.Auth
- if cfg.Auth == SMTPPlain {
- auth = smtp.PlainAuth("", login, password, cfg.Host)
- } else if cfg.Auth == SMTPLogin {
- auth = &smtpLoginAuth{login, password}
- } else {
- return nil, errors.New("Unsupported SMTP authentication type")
- }
-
- if err := SMTPAuth(auth, cfg); err != nil {
- // Check standard error format first,
- // then fallback to worse case.
- tperr, ok := err.(*textproto.Error)
- if (ok && tperr.Code == 535) ||
- strings.Contains(err.Error(), "Username and Password not accepted") {
- return nil, ErrUserNotExist{args: map[string]interface{}{"login": login}}
- }
- return nil, err
- }
-
- if !autoRegister {
- return nil, nil
- }
-
- username := login
- idx := strings.Index(login, "@")
- if idx > -1 {
- username = login[:idx]
- }
-
- user := &User{
- LowerName: strings.ToLower(username),
- Name: strings.ToLower(username),
- Email: login,
- Passwd: password,
- LoginSource: sourceID,
- LoginName: login,
- IsActive: true,
- }
- return user, CreateUser(user)
-}
-
-// **********************
-// ----- PAM config -----
-// **********************
-
-type PAMConfig struct {
- // The name of the PAM service, e.g. system-auth.
- ServiceName string
-}
-
-// LoginViaPAM queries if login/password is valid against the PAM,
-// and create a local user if success when enabled.
-func LoginViaPAM(login, password string, sourceID int64, cfg *PAMConfig, autoRegister bool) (*User, error) {
- if err := pam.PAMAuth(cfg.ServiceName, login, password); err != nil {
- if strings.Contains(err.Error(), "Authentication failure") {
- return nil, ErrUserNotExist{args: map[string]interface{}{"login": login}}
- }
- return nil, err
- }
-
- if !autoRegister {
- return nil, nil
- }
-
- user := &User{
- LowerName: strings.ToLower(login),
- Name: login,
- Email: login,
- Passwd: password,
- LoginSource: sourceID,
- LoginName: login,
- IsActive: true,
- }
- return user, CreateUser(user)
-}
-
-// *************************
-// ----- GitHub config -----
-// *************************
-
-type GitHubConfig struct {
- // the GitHub service endpoint, e.g. https://api.github.com/.
- APIEndpoint string
-}
-
-func LoginViaGitHub(login, password string, sourceID int64, cfg *GitHubConfig, autoRegister bool) (*User, error) {
- fullname, email, url, location, err := github.Authenticate(cfg.APIEndpoint, login, password)
- if err != nil {
- if strings.Contains(err.Error(), "401") {
- return nil, ErrUserNotExist{args: map[string]interface{}{"login": login}}
- }
- return nil, err
- }
-
- if !autoRegister {
- return nil, nil
- }
- user := &User{
- LowerName: strings.ToLower(login),
- Name: login,
- FullName: fullname,
- Email: email,
- Website: url,
- Passwd: password,
- LoginSource: sourceID,
- LoginName: login,
- IsActive: true,
- Location: location,
- }
- return user, CreateUser(user)
-}
-
-func authenticateViaLoginSource(source *LoginSource, login, password string, autoRegister bool) (*User, error) {
- if !source.IsActived {
- return nil, errors.LoginSourceNotActivated{SourceID: source.ID}
- }
-
- switch source.Type {
- case LoginLDAP, LoginDLDAP:
- return LoginViaLDAP(login, password, source, autoRegister)
- case LoginSMTP:
- return LoginViaSMTP(login, password, source.ID, source.Config.(*SMTPConfig), autoRegister)
- case LoginPAM:
- return LoginViaPAM(login, password, source.ID, source.Config.(*PAMConfig), autoRegister)
- case LoginGitHub:
- return LoginViaGitHub(login, password, source.ID, source.Config.(*GitHubConfig), autoRegister)
- }
-
- return nil, errors.InvalidLoginSourceType{Type: source.Type}
-}