// Copyright 2016 Documize Inc. . All rights reserved. // // This software (Documize Community Edition) is licensed under // GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html // // You can operate outside the AGPL restrictions by purchasing // Documize Enterprise Edition and obtaining a commercial license // by contacting . // // https://documize.com package endpoint import ( "bytes" "database/sql" "encoding/json" "errors" "fmt" "io/ioutil" "net/http" "net/url" "obiwan/utility" "sort" "strconv" "strings" "github.com/documize/community/core/api/endpoint/models" "github.com/documize/community/core/api/entity" "github.com/documize/community/core/api/request" "github.com/documize/community/core/api/util" "github.com/documize/community/core/log" "github.com/documize/community/core/secrets" "github.com/documize/community/core/streamutil" "github.com/documize/community/core/stringutil" "github.com/documize/community/core/uniqueid" ) // AuthenticateKeycloak checks Keycloak authentication credentials. func AuthenticateKeycloak(w http.ResponseWriter, r *http.Request) { method := "AuthenticateKeycloak" p := request.GetPersister(r) defer streamutil.Close(r.Body) body, err := ioutil.ReadAll(r.Body) if err != nil { writeBadRequestError(w, method, "Bad payload") return } a := keycloakAuthRequest{} err = json.Unmarshal(body, &a) if err != nil { writePayloadError(w, method, err) return } a.Domain = strings.TrimSpace(strings.ToLower(a.Domain)) a.Domain = request.CheckDomain(a.Domain) // TODO optimize by removing this once js allows empty domains a.Email = strings.TrimSpace(strings.ToLower(a.Email)) // Check for required fields. if len(a.Email) == 0 { writeUnauthorizedError(w) return } org, err := p.GetOrganizationByDomain(a.Domain) if err != nil { writeUnauthorizedError(w) return } p.Context.OrgID = org.RefID // Fetch Keycloak auth provider config ac := keycloakConfig{} err = json.Unmarshal([]byte(org.AuthConfig), &ac) if err != nil { writeBadRequestError(w, method, "Unable to unmarshall Keycloak Public Key") return } // Decode and prepare RSA Public Key used by keycloak to sign JWT. pkb, err := utility.DecodeBase64([]byte(ac.PublicKey)) if err != nil { writeBadRequestError(w, method, "Unable to base64 decode Keycloak Public Key") return } pk := string(pkb) pk = fmt.Sprintf("-----BEGIN PUBLIC KEY-----\n%s\n-----END PUBLIC KEY-----", pk) // Decode and verify Keycloak JWT claims, err := decodeKeycloakJWT(a.Token, pk) if err != nil { log.Info("decodeKeycloakJWT failed") log.Info(pk) util.WriteRequestError(w, err.Error()) return } // Compare the contents from JWT with what we have. // Guards against MITM token tampering. if a.Email != claims["email"].(string) || claims["sub"].(string) != a.RemoteID { writeUnauthorizedError(w) return } log.Info("keycloak logon attempt " + a.Email + " @ " + a.Domain) user, err := p.GetUserByDomain(a.Domain, a.Email) if err != nil && err != sql.ErrNoRows { writeServerError(w, method, err) return } // Create user account if not found if err == sql.ErrNoRows { log.Info("keycloak add user " + a.Email + " @ " + a.Domain) user = entity.User{} user.Firstname = a.Firstname user.Lastname = a.Lastname user.Email = a.Email user.Initials = stringutil.MakeInitials(user.Firstname, user.Lastname) user.Salt = secrets.GenerateSalt() user.Password = secrets.GeneratePassword(secrets.GenerateRandomPassword(), user.Salt) err = addUser(p, &user, ac.DefaultPermissionAddSpace) if err != nil { writeServerError(w, method, err) return } } // Password correct and active user if a.Email != strings.TrimSpace(strings.ToLower(user.Email)) { writeUnauthorizedError(w) return } // Attach user accounts and work out permissions. AttachUserAccounts(p, org.RefID, &user) // No accounts signals data integrity problem // so we reject login request. if len(user.Accounts) == 0 { writeUnauthorizedError(w) return } // Abort login request if account is disabled. for _, ac := range user.Accounts { if ac.OrgID == org.RefID { if ac.Active == false { writeUnauthorizedError(w) return } break } } // Generate JWT token authModel := models.AuthenticationModel{} authModel.Token = generateJWT(user.RefID, org.RefID, a.Domain) authModel.User = user json, err := json.Marshal(authModel) if err != nil { writeJSONMarshalError(w, method, "user", err) return } writeSuccessBytes(w, json) } // SyncKeycloak gets list of Keycloak users and inserts new users into Documize // and marks Keycloak disabled users as inactive. func SyncKeycloak(w http.ResponseWriter, r *http.Request) { p := request.GetPersister(r) if !p.Context.Administrator { writeForbiddenError(w) return } var result struct { Message string `json:"message"` IsError bool `json:"isError"` } // Org contains raw auth provider config org, err := p.GetOrganization(p.Context.OrgID) if err != nil { result.Message = "Error: unable to get organization record" result.IsError = true log.Error(result.Message, err) util.WriteJSON(w, result) return } // Exit if not using Keycloak if org.AuthProvider != "keycloak" { result.Message = "Error: skipping user sync with Keycloak as it is not the configured option" result.IsError = true log.Info(result.Message) util.WriteJSON(w, result) return } // Make Keycloak auth provider config c := keycloakConfig{} err = json.Unmarshal([]byte(org.AuthConfig), &c) if err != nil { result.Message = "Error: unable read Keycloak configuration data" result.IsError = true log.Error(result.Message, err) util.WriteJSON(w, result) return } // User list from Keycloak kcUsers, err := KeycloakUsers(c) if err != nil { result.Message = "Error: unable to fetch Keycloak users: " + err.Error() result.IsError = true log.Error(result.Message, err) util.WriteJSON(w, result) return } // User list from Documize dmzUsers, err := p.GetUsersForOrganization() if err != nil { result.Message = "Error: unable to fetch Documize users" result.IsError = true log.Error(result.Message, err) util.WriteJSON(w, result) return } sort.Slice(kcUsers, func(i, j int) bool { return kcUsers[i].Email < kcUsers[j].Email }) sort.Slice(dmzUsers, func(i, j int) bool { return dmzUsers[i].Email < dmzUsers[j].Email }) insert := []entity.User{} for _, k := range kcUsers { exists := false for _, d := range dmzUsers { if k.Email == d.Email { exists = true } } if !exists { insert = append(insert, k) } } // Insert new users into Documize for _, u := range insert { err = addUser(p, &u, c.DefaultPermissionAddSpace) } result.Message = fmt.Sprintf("Keycloak sync'ed %d users, %d new additions", len(kcUsers), len(insert)) log.Info(result.Message) util.WriteJSON(w, result) } // Helper method to setup user account in Documize using Keycloak provided user data. func addUser(p request.Persister, u *entity.User, addSpace bool) (err error) { // only create account if not dupe addUser := true addAccount := true var userID string userDupe, err := p.GetUserByEmail(u.Email) if err != nil && err != sql.ErrNoRows { return err } if u.Email == userDupe.Email { addUser = false userID = userDupe.RefID } p.Context.Transaction, err = request.Db.Beginx() if err != nil { return err } if addUser { userID = uniqueid.Generate() u.RefID = userID err = p.AddUser(*u) if err != nil { log.IfErr(p.Context.Transaction.Rollback()) return err } } else { AttachUserAccounts(p, p.Context.OrgID, &userDupe) for _, a := range userDupe.Accounts { if a.OrgID == p.Context.OrgID { addAccount = false break } } } // set up user account for the org if addAccount { var a entity.Account a.UserID = userID a.OrgID = p.Context.OrgID a.Editor = addSpace a.Admin = false accountID := uniqueid.Generate() a.RefID = accountID a.Active = true err = p.AddAccount(a) if err != nil { log.IfErr(p.Context.Transaction.Rollback()) return err } } log.IfErr(p.Context.Transaction.Commit()) nu, err := p.GetUser(userID) u = &nu return err } // KeycloakUsers gets list of Keycloak users for specified Realm, Client Id func KeycloakUsers(c keycloakConfig) (users []entity.User, err error) { users = []entity.User{} form := url.Values{} form.Add("username", c.AdminUser) form.Add("password", c.AdminPassword) form.Add("client_id", "admin-cli") form.Add("grant_type", "password") req, err := http.NewRequest("POST", fmt.Sprintf("%s/realms/master/protocol/openid-connect/token", c.URL), bytes.NewBufferString(form.Encode())) req.Header.Set("Content-Type", "application/x-www-form-urlencoded") req.Header.Set("Content-Length", strconv.Itoa(len(form.Encode()))) client := &http.Client{} res, err := client.Do(req) if err != nil { log.Info("Keycloak: cannot connect to auth URL") return users, err } defer res.Body.Close() body, err := ioutil.ReadAll(res.Body) if err != nil { log.Info("Keycloak: cannot read response from auth request") log.Info(string(body)) return users, err } if res.StatusCode != http.StatusOK { if res.StatusCode == http.StatusUnauthorized { return users, errors.New("Check Keycloak username/password") } return users, errors.New("Keycloak authentication failed " + res.Status) } ka := keycloakAPIAuth{} err = json.Unmarshal(body, &ka) if err != nil { return users, err } url := fmt.Sprintf("%s/admin/realms/%s/users?max=500", c.URL, c.Realm) c.Group = strings.TrimSpace(c.Group) if len(c.Group) > 0 { log.Info("Keycloak: filtering by Group members") url = fmt.Sprintf("%s/admin/realms/%s/groups/%s/members?max=500", c.URL, c.Realm, c.Group) } req, err = http.NewRequest("GET", url, nil) req.Header.Add("Authorization", fmt.Sprintf("Bearer %s", ka.AccessToken)) client = &http.Client{} res, err = client.Do(req) if err != nil { log.Info("Keycloak: unable to fetch users") return users, err } defer res.Body.Close() body, err = ioutil.ReadAll(res.Body) if err != nil { log.Info("Keycloak: unable to read user list response") return users, err } if res.StatusCode != http.StatusOK { if res.StatusCode == http.StatusNotFound { if c.Group != "" { return users, errors.New("Keycloak Realm/Client/Group ID not found") } return users, errors.New("Keycloak Realm/Client Id not found") } return users, errors.New("Keycloak users list call failed " + res.Status) } kcUsers := []keycloakUser{} err = json.Unmarshal(body, &kcUsers) if err != nil { log.Info("Keycloak: unable to unmarshal user list response") return users, err } for _, kc := range kcUsers { u := entity.User{} u.Email = kc.Email u.Firstname = kc.Firstname u.Lastname = kc.Lastname u.Initials = stringutil.MakeInitials(u.Firstname, u.Lastname) u.Active = kc.Enabled u.Editor = false users = append(users, u) } return users, nil } // StripAuthSecrets removes sensitive data from auth provider configuration func StripAuthSecrets(provider, config string) string { switch provider { case "documize": return config break case "keycloak": c := keycloakConfig{} err := json.Unmarshal([]byte(config), &c) if err != nil { log.Error("StripAuthSecrets", err) return config } c.AdminPassword = "" c.AdminUser = "" c.PublicKey = "" j, err := json.Marshal(c) if err != nil { log.Error("StripAuthSecrets", err) return config } return string(j) break } return config } // Data received via Keycloak client library type keycloakAuthRequest struct { Domain string `json:"domain"` Token string `json:"token"` RemoteID string `json:"remoteId"` Email string `json:"email"` Username string `json:"username"` Firstname string `json:"firstname"` Lastname string `json:"lastname"` Enabled bool `json:"enabled"` } // Keycloak server configuration type keycloakConfig struct { URL string `json:"url"` Realm string `json:"realm"` ClientID string `json:"clientId"` PublicKey string `json:"publicKey"` AdminUser string `json:"adminUser"` AdminPassword string `json:"adminPassword"` Group string `json:"group"` DisableLogout bool `json:"disableLogout"` DefaultPermissionAddSpace bool `json:"defaultPermissionAddSpace"` } // keycloakAPIAuth is returned when authenticating with Keycloak REST API. type keycloakAPIAuth struct { AccessToken string `json:"access_token"` } // keycloakUser details user record returned by Keycloak type keycloakUser struct { ID string `json:"id"` Username string `json:"username"` Email string `json:"email"` Firstname string `json:"firstName"` Lastname string `json:"lastName"` Enabled bool `json:"enabled"` }