forgejo/models/login_source.go

559 lines
13 KiB
Go
Raw Normal View History

// Copyright 2014 The Gogs Authors. All rights reserved.
2014-05-05 11:32:47 +02:00
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.
2014-04-26 08:21:04 +02:00
package models
2014-05-03 04:48:14 +02:00
import (
2014-05-15 20:46:04 +02:00
"crypto/tls"
2014-05-03 04:48:14 +02:00
"encoding/json"
2014-05-05 10:40:25 +02:00
"errors"
2014-05-11 09:49:36 +02:00
"fmt"
"net/smtp"
"net/textproto"
2014-05-11 08:12:45 +02:00
"strings"
2014-05-03 04:48:14 +02:00
"time"
2014-04-26 08:21:04 +02:00
2015-09-11 18:03:08 +02:00
"github.com/Unknwon/com"
"github.com/go-macaron/binding"
2014-05-03 04:48:14 +02:00
"github.com/go-xorm/core"
2014-05-05 10:40:25 +02:00
"github.com/go-xorm/xorm"
2014-05-05 11:32:47 +02:00
2014-05-03 04:48:14 +02:00
"github.com/gogits/gogs/modules/auth/ldap"
2015-04-23 13:58:57 +02:00
"github.com/gogits/gogs/modules/auth/pam"
2014-05-15 16:34:36 +02:00
"github.com/gogits/gogs/modules/log"
2014-05-03 04:48:14 +02:00
)
2014-04-26 08:21:04 +02:00
type LoginType int
2016-08-31 10:22:41 +02:00
// Note: new type must append to the end of list to maintain compatibility.
2014-05-05 10:40:25 +02:00
const (
LOGIN_NOTYPE LoginType = iota
LOGIN_PLAIN // 1
LOGIN_LDAP // 2
LOGIN_SMTP // 3
LOGIN_PAM // 4
LOGIN_DLDAP // 5
2014-05-05 10:40:25 +02:00
)
2015-09-10 23:11:41 +02:00
var LoginNames = map[LoginType]string{
LOGIN_LDAP: "LDAP (via BindDN)",
LOGIN_DLDAP: "LDAP (simple auth)", // Via direct bind
LOGIN_SMTP: "SMTP",
LOGIN_PAM: "PAM",
2014-05-05 10:40:25 +02:00
}
2014-04-26 08:21:04 +02:00
var SecurityProtocolNames = map[ldap.SecurityProtocol]string{
ldap.SECURITY_PROTOCOL_UNENCRYPTED: "Unencrypted",
ldap.SECURITY_PROTOCOL_LDAPS: "LDAPS",
ldap.SECURITY_PROTOCOL_START_TLS: "StartTLS",
}
2014-12-07 02:22:48 +01:00
// Ensure structs implemented interface.
2014-05-12 17:02:36 +02:00
var (
_ core.Conversion = &LDAPConfig{}
_ core.Conversion = &SMTPConfig{}
2015-04-23 13:58:57 +02:00
_ core.Conversion = &PAMConfig{}
2014-05-12 17:02:36 +02:00
)
2014-04-26 08:21:04 +02:00
type LDAPConfig struct {
2015-09-14 21:48:51 +02:00
*ldap.Source
2014-04-26 08:21:04 +02:00
}
func (cfg *LDAPConfig) FromDB(bs []byte) error {
2015-09-14 21:48:51 +02:00
return json.Unmarshal(bs, &cfg)
2014-04-26 08:21:04 +02:00
}
func (cfg *LDAPConfig) ToDB() ([]byte, error) {
2015-09-14 21:48:51 +02:00
return json.Marshal(cfg)
2014-04-26 08:21:04 +02:00
}
func (cfg *LDAPConfig) SecurityProtocolName() string {
return SecurityProtocolNames[cfg.SecurityProtocol]
}
2014-05-11 09:49:36 +02:00
type SMTPConfig struct {
Auth string
Host string
Port int
AllowedDomains string `xorm:"TEXT"`
TLS bool
SkipVerify bool
2014-05-11 09:49:36 +02:00
}
func (cfg *SMTPConfig) FromDB(bs []byte) error {
return json.Unmarshal(bs, cfg)
}
func (cfg *SMTPConfig) ToDB() ([]byte, error) {
return json.Marshal(cfg)
}
2015-04-23 13:58:57 +02:00
type PAMConfig struct {
ServiceName string // pam service (e.g. system-auth)
}
func (cfg *PAMConfig) FromDB(bs []byte) error {
return json.Unmarshal(bs, &cfg)
}
func (cfg *PAMConfig) ToDB() ([]byte, error) {
return json.Marshal(cfg)
}
2016-08-31 10:22:41 +02:00
// LoginSource represents an external way for authorizing users.
2014-04-26 08:21:04 +02:00
type LoginSource struct {
ID int64 `xorm:"pk autoincr"`
Type LoginType
Name string `xorm:"UNIQUE"`
IsActived bool `xorm:"NOT NULL DEFAULT false"`
Cfg core.Conversion `xorm:"TEXT"`
Created time.Time `xorm:"-"`
CreatedUnix int64
Updated time.Time `xorm:"-"`
UpdatedUnix int64
}
func (s *LoginSource) BeforeInsert() {
s.CreatedUnix = time.Now().Unix()
s.UpdatedUnix = s.CreatedUnix
}
func (s *LoginSource) BeforeUpdate() {
s.UpdatedUnix = time.Now().Unix()
2014-05-03 04:48:14 +02:00
}
2016-01-11 07:34:32 +01:00
// Cell2Int64 converts a xorm.Cell type to int64,
// and handles possible irregular cases.
func Cell2Int64(val xorm.Cell) int64 {
switch (*val).(type) {
2016-01-11 08:47:23 +01:00
case []uint8:
log.Trace("Cell2Int64 ([]uint8): %v", *val)
return com.StrTo(string((*val).([]uint8))).MustInt64()
2016-01-11 07:34:32 +01:00
}
return (*val).(int64)
}
func (source *LoginSource) BeforeSet(colName string, val xorm.Cell) {
switch colName {
case "type":
2016-01-11 07:34:32 +01:00
switch LoginType(Cell2Int64(val)) {
case LOGIN_LDAP, LOGIN_DLDAP:
source.Cfg = new(LDAPConfig)
case LOGIN_SMTP:
source.Cfg = new(SMTPConfig)
case LOGIN_PAM:
source.Cfg = new(PAMConfig)
2015-09-11 18:03:08 +02:00
default:
panic("unrecognized login source type: " + com.ToStr(*val))
}
}
}
func (s *LoginSource) AfterSet(colName string, _ xorm.Cell) {
switch colName {
case "created_unix":
s.Created = time.Unix(s.CreatedUnix, 0).Local()
case "updated_unix":
s.Updated = time.Unix(s.UpdatedUnix, 0).Local()
}
}
2015-09-10 23:11:41 +02:00
func (source *LoginSource) TypeName() string {
return LoginNames[source.Type]
2014-05-05 10:40:25 +02:00
}
2015-09-11 18:03:08 +02:00
func (source *LoginSource) IsLDAP() bool {
return source.Type == LOGIN_LDAP
2015-09-11 18:03:08 +02:00
}
func (source *LoginSource) IsDLDAP() bool {
return source.Type == LOGIN_DLDAP
2015-09-11 18:03:08 +02:00
}
func (source *LoginSource) IsSMTP() bool {
return source.Type == LOGIN_SMTP
2015-09-11 18:03:08 +02:00
}
func (source *LoginSource) IsPAM() bool {
return source.Type == LOGIN_PAM
2015-09-11 18:03:08 +02:00
}
func (source *LoginSource) HasTLS() bool {
return ((source.IsLDAP() || source.IsDLDAP()) &&
source.LDAP().SecurityProtocol > ldap.SECURITY_PROTOCOL_UNENCRYPTED) ||
source.IsSMTP()
}
2015-09-11 18:03:08 +02:00
func (source *LoginSource) UseTLS() bool {
switch source.Type {
case LOGIN_LDAP, LOGIN_DLDAP:
return source.LDAP().SecurityProtocol != ldap.SECURITY_PROTOCOL_UNENCRYPTED
case LOGIN_SMTP:
2015-09-11 18:03:08 +02:00
return source.SMTP().TLS
}
return false
}
2015-09-14 21:48:51 +02:00
func (source *LoginSource) SkipVerify() bool {
switch source.Type {
case LOGIN_LDAP, LOGIN_DLDAP:
2015-09-14 21:48:51 +02:00
return source.LDAP().SkipVerify
case LOGIN_SMTP:
2015-09-14 21:48:51 +02:00
return source.SMTP().SkipVerify
}
return false
}
2014-05-05 10:40:25 +02:00
func (source *LoginSource) LDAP() *LDAPConfig {
return source.Cfg.(*LDAPConfig)
}
2014-05-11 09:49:36 +02:00
func (source *LoginSource) SMTP() *SMTPConfig {
return source.Cfg.(*SMTPConfig)
}
2015-04-23 13:58:57 +02:00
func (source *LoginSource) PAM() *PAMConfig {
return source.Cfg.(*PAMConfig)
}
func CreateLoginSource(source *LoginSource) error {
has, err := x.Get(&LoginSource{Name: source.Name})
if err != nil {
return err
} else if has {
return ErrLoginSourceAlreadyExist{source.Name}
}
_, err = x.Insert(source)
return err
}
func LoginSources() ([]*LoginSource, error) {
auths := make([]*LoginSource, 0, 5)
return auths, x.Find(&auths)
2014-05-03 04:48:14 +02:00
}
2015-12-05 23:13:13 +01:00
// GetLoginSourceByID returns login source by given ID.
func GetLoginSourceByID(id int64) (*LoginSource, error) {
2014-05-05 10:40:25 +02:00
source := new(LoginSource)
2014-06-21 06:51:41 +02:00
has, err := x.Id(id).Get(source)
2014-05-05 10:40:25 +02:00
if err != nil {
return nil, err
} else if !has {
return nil, ErrLoginSourceNotExist{id}
2014-05-05 10:40:25 +02:00
}
return source, nil
}
2014-05-11 12:10:37 +02:00
func UpdateSource(source *LoginSource) error {
_, err := x.Id(source.ID).AllCols().Update(source)
2014-05-03 04:48:14 +02:00
return err
}
2015-09-11 18:03:08 +02:00
func DeleteSource(source *LoginSource) error {
count, err := x.Count(&User{LoginSource: source.ID})
2014-05-05 10:40:25 +02:00
if err != nil {
return err
2015-09-11 18:03:08 +02:00
} else if count > 0 {
2016-08-31 10:22:41 +02:00
return ErrLoginSourceInUse{source.ID}
2014-05-05 10:40:25 +02:00
}
2015-09-11 18:03:08 +02:00
_, err = x.Id(source.ID).Delete(new(LoginSource))
2014-05-03 04:48:14 +02:00
return err
2014-04-26 08:21:04 +02:00
}
2014-05-11 08:12:45 +02:00
2016-08-31 10:22:41 +02:00
// CountLoginSources returns number of login sources.
func CountLoginSources() int64 {
count, _ := x.Count(new(LoginSource))
return count
}
// .____ ________ _____ __________
// | | \______ \ / _ \\______ \
// | | | | \ / /_\ \| ___/
// | |___ | ` \/ | \ |
// |_______ \/_______ /\____|__ /____|
// \/ \/ \/
2014-05-11 08:12:45 +02:00
2016-08-31 10:22:41 +02:00
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,
2015-11-21 18:58:31 +01:00
// and create a local user if success when enabled.
2016-08-31 10:22:41 +02:00
func LoginViaLDAP(user *User, login, passowrd string, source *LoginSource, autoRegister bool) (*User, error) {
username, fn, sn, mail, isAdmin, succeed := source.Cfg.(*LDAPConfig).SearchEntry(login, passowrd, source.Type == LOGIN_DLDAP)
if !succeed {
2014-12-06 00:08:09 +01:00
// User not in LDAP, do nothing
2016-08-31 10:22:41 +02:00
return nil, ErrUserNotExist{0, login}
2014-05-11 08:12:45 +02:00
}
2014-05-11 08:12:45 +02:00
if !autoRegister {
2016-08-31 10:22:41 +02:00
return user, nil
2014-05-11 08:12:45 +02:00
}
2014-12-06 00:08:09 +01:00
// Fallback.
if len(username) == 0 {
2016-08-31 10:22:41 +02:00
username = login
}
// Validate username make sure it satisfies requirement.
2016-07-21 08:15:04 +02:00
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)
}
2014-12-06 00:08:09 +01:00
if len(mail) == 0 {
mail = fmt.Sprintf("%s@localhost", username)
2014-12-06 00:08:09 +01:00
}
2016-08-31 10:22:41 +02:00
user = &User{
LowerName: strings.ToLower(username),
Name: username,
FullName: composeFullName(fn, sn, username),
2016-08-31 10:22:41 +02:00
Email: mail,
2015-09-05 05:39:23 +02:00
LoginType: source.Type,
LoginSource: source.ID,
2016-08-31 10:22:41 +02:00
LoginName: login,
2014-12-06 00:08:09 +01:00
IsActive: true,
2016-08-31 10:22:41 +02:00
IsAdmin: isAdmin,
2014-05-11 08:12:45 +02:00
}
2016-08-31 10:22:41 +02:00
return user, CreateUser(user)
}
// _________ __________________________
// / _____/ / \__ ___/\______ \
// \_____ \ / \ / \| | | ___/
// / \/ Y \ | | |
// /_______ /\____|__ /____| |____|
// \/ \/
2016-08-31 10:22:41 +02:00
type smtpLoginAuth struct {
2014-05-11 09:49:36 +02:00
username, password string
}
2016-08-31 10:22:41 +02:00
func (auth *smtpLoginAuth) Start(server *smtp.ServerInfo) (string, []byte, error) {
return "LOGIN", []byte(auth.username), nil
2014-05-11 09:49:36 +02:00
}
2016-08-31 10:22:41 +02:00
func (auth *smtpLoginAuth) Next(fromServer []byte, more bool) ([]byte, error) {
2014-05-11 09:49:36 +02:00
if more {
switch string(fromServer) {
case "Username:":
2016-08-31 10:22:41 +02:00
return []byte(auth.username), nil
2014-05-11 09:49:36 +02:00
case "Password:":
2016-08-31 10:22:41 +02:00
return []byte(auth.password), nil
2014-05-11 09:49:36 +02:00
}
}
return nil, nil
}
const (
2014-05-11 12:10:37 +02:00
SMTP_PLAIN = "PLAIN"
SMTP_LOGIN = "LOGIN"
2014-05-11 09:49:36 +02:00
)
2015-09-10 23:11:41 +02:00
var SMTPAuths = []string{SMTP_PLAIN, SMTP_LOGIN}
func SMTPAuth(a smtp.Auth, cfg *SMTPConfig) error {
c, err := smtp.Dial(fmt.Sprintf("%s:%d", cfg.Host, cfg.Port))
2014-05-11 09:49:36 +02:00
if err != nil {
return err
}
defer c.Close()
2014-05-15 20:46:04 +02:00
if err = c.Hello("gogs"); err != nil {
return err
}
if cfg.TLS {
2014-05-11 14:04:28 +02:00
if ok, _ := c.Extension("STARTTLS"); ok {
if err = c.StartTLS(&tls.Config{
InsecureSkipVerify: cfg.SkipVerify,
ServerName: cfg.Host,
}); err != nil {
2014-05-11 14:04:28 +02:00
return err
}
} else {
2014-05-16 05:03:26 +02:00
return errors.New("SMTP server unsupports TLS")
2014-05-11 09:49:36 +02:00
}
}
if ok, _ := c.Extension("AUTH"); ok {
if err = c.Auth(a); err != nil {
return err
}
return nil
}
return ErrUnsupportedLoginType
2014-05-11 09:49:36 +02:00
}
2016-08-31 10:22:41 +02:00
// LoginViaSMTP queries if login/password is valid against the SMTP,
// and create a local user if success when enabled.
func LoginViaSMTP(user *User, login, password string, sourceID int64, cfg *SMTPConfig, autoRegister bool) (*User, error) {
// Verify allowed domains.
if len(cfg.AllowedDomains) > 0 {
2016-08-31 10:22:41 +02:00
idx := strings.Index(login, "@")
if idx == -1 {
2016-08-31 10:22:41 +02:00
return nil, ErrUserNotExist{0, login}
} else if !com.IsSliceContainsStr(strings.Split(cfg.AllowedDomains, ","), login[idx+1:]) {
return nil, ErrUserNotExist{0, login}
}
}
2014-05-11 09:49:36 +02:00
var auth smtp.Auth
2014-05-11 12:10:37 +02:00
if cfg.Auth == SMTP_PLAIN {
2016-08-31 10:22:41 +02:00
auth = smtp.PlainAuth("", login, password, cfg.Host)
2014-05-11 12:10:37 +02:00
} else if cfg.Auth == SMTP_LOGIN {
2016-08-31 10:22:41 +02:00
auth = &smtpLoginAuth{login, password}
2014-05-11 14:04:28 +02:00
} else {
2014-05-15 20:46:04 +02:00
return nil, errors.New("Unsupported SMTP auth type")
2014-05-11 09:49:36 +02:00
}
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") {
2016-08-31 10:22:41 +02:00
return nil, ErrUserNotExist{0, login}
2014-05-15 20:46:04 +02:00
}
2014-05-11 09:49:36 +02:00
return nil, err
}
if !autoRegister {
2016-08-31 10:22:41 +02:00
return user, nil
2014-05-11 09:49:36 +02:00
}
2016-08-31 10:22:41 +02:00
username := login
idx := strings.Index(login, "@")
2014-05-11 14:04:28 +02:00
if idx > -1 {
2016-08-31 10:22:41 +02:00
username = login[:idx]
2014-05-11 14:04:28 +02:00
}
2016-08-31 10:22:41 +02:00
user = &User{
LowerName: strings.ToLower(username),
Name: strings.ToLower(username),
Email: login,
Passwd: password,
LoginType: LOGIN_SMTP,
LoginSource: sourceID,
2016-08-31 10:22:41 +02:00
LoginName: login,
2014-05-11 09:49:36 +02:00
IsActive: true,
}
2016-08-31 10:22:41 +02:00
return user, CreateUser(user)
2014-05-11 09:49:36 +02:00
}
2015-04-23 13:58:57 +02:00
// __________ _____ _____
// \______ \/ _ \ / \
// | ___/ /_\ \ / \ / \
// | | / | \/ Y \
// |____| \____|__ /\____|__ /
// \/ \/
2016-08-31 10:22:41 +02:00
// LoginViaPAM queries if login/password is valid against the PAM,
// and create a local user if success when enabled.
func LoginViaPAM(user *User, login, password string, sourceID int64, cfg *PAMConfig, autoRegister bool) (*User, error) {
if err := pam.PAMAuth(cfg.ServiceName, login, password); err != nil {
2015-04-23 13:58:57 +02:00
if strings.Contains(err.Error(), "Authentication failure") {
2016-08-31 10:22:41 +02:00
return nil, ErrUserNotExist{0, login}
2015-04-23 13:58:57 +02:00
}
return nil, err
}
if !autoRegister {
2016-08-31 10:22:41 +02:00
return user, nil
2015-04-23 13:58:57 +02:00
}
2016-08-31 10:22:41 +02:00
user = &User{
LowerName: strings.ToLower(login),
Name: login,
Email: login,
Passwd: password,
LoginType: LOGIN_PAM,
LoginSource: sourceID,
2016-08-31 10:22:41 +02:00
LoginName: login,
2015-04-23 13:58:57 +02:00
IsActive: true,
}
2016-08-31 10:22:41 +02:00
return user, CreateUser(user)
2015-04-23 13:58:57 +02:00
}
2016-08-31 10:22:41 +02:00
func ExternalUserLogin(user *User, login, password string, source *LoginSource, autoRegister bool) (*User, error) {
if !source.IsActived {
return nil, ErrLoginSourceNotActived
}
switch source.Type {
case LOGIN_LDAP, LOGIN_DLDAP:
2016-08-31 10:22:41 +02:00
return LoginViaLDAP(user, login, password, source, autoRegister)
case LOGIN_SMTP:
2016-08-31 10:22:41 +02:00
return LoginViaSMTP(user, login, password, source.ID, source.Cfg.(*SMTPConfig), autoRegister)
case LOGIN_PAM:
2016-08-31 10:22:41 +02:00
return LoginViaPAM(user, login, password, source.ID, source.Cfg.(*PAMConfig), autoRegister)
}
return nil, ErrUnsupportedLoginType
}
// UserSignIn validates user name and password.
2016-08-31 10:22:41 +02:00
func UserSignIn(username, passowrd string) (*User, error) {
var user *User
if strings.Contains(username, "@") {
user = &User{Email: strings.ToLower(username)}
} else {
2016-08-31 10:22:41 +02:00
user = &User{LowerName: strings.ToLower(username)}
}
2016-08-31 10:22:41 +02:00
hasUser, err := x.Get(user)
if err != nil {
return nil, err
}
2016-08-31 10:22:41 +02:00
if hasUser {
switch user.LoginType {
case LOGIN_NOTYPE, LOGIN_PLAIN:
2016-08-31 10:22:41 +02:00
if user.ValidatePassword(passowrd) {
return user, nil
}
2016-08-31 10:22:41 +02:00
return nil, ErrUserNotExist{user.ID, user.Name}
default:
var source LoginSource
2016-08-31 10:22:41 +02:00
hasSource, err := x.Id(user.LoginSource).Get(&source)
if err != nil {
return nil, err
} else if !hasSource {
2016-08-31 10:22:41 +02:00
return nil, ErrLoginSourceNotExist{user.LoginSource}
}
2016-08-31 10:22:41 +02:00
return ExternalUserLogin(user, user.LoginName, passowrd, &source, false)
}
}
2016-08-31 10:22:41 +02:00
sources := make([]*LoginSource, 3)
if err = x.UseBool().Find(&sources, &LoginSource{IsActived: true}); err != nil {
return nil, err
}
for _, source := range sources {
2016-08-31 10:22:41 +02:00
authUser, err := ExternalUserLogin(nil, username, passowrd, source, true)
if err == nil {
2016-08-31 10:22:41 +02:00
return authUser, nil
}
2016-08-31 10:22:41 +02:00
log.Warn("Failed to login '%s' via '%s': %v", username, source.Name, err)
}
2016-08-31 10:22:41 +02:00
return nil, ErrUserNotExist{user.ID, user.Name}
}