tools/sync-users/sync-users.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 package main
   6
   7 import (
   8         "bytes"
   9         "encoding/csv"
  10         "encoding/json"
  11         "flag"
  12         "fmt"
  13         "io"
  14         "log"
  15         "net/url"
  16         "os"
  17         "regexp"
  18         "strconv"
  19         "strings"
  20
  21         "git.arvados.org/arvados.git/lib/cmd"
  22         "git.arvados.org/arvados.git/sdk/go/arvados"
  23 )
  24
  25 var version = "dev"
  26
  27 type resourceList interface {
  28         Len() int
  29         GetItems() []interface{}
  30 }
  31
  32 // UserList implements resourceList interface
  33 type UserList struct {
  34         arvados.UserList
  35 }
  36
  37 // Len returns the amount of items this list holds
  38 func (l UserList) Len() int {
  39         return len(l.Items)
  40 }
  41
  42 // GetItems returns the list of items
  43 func (l UserList) GetItems() (out []interface{}) {
  44         for _, item := range l.Items {
  45                 out = append(out, item)
  46         }
  47         return
  48 }
  49
  50 func main() {
  51         cfg, err := GetConfig()
  52         if err != nil {
  53                 log.Fatalf("%v", err)
  54         }
  55
  56         if err := doMain(&cfg); err != nil {
  57                 log.Fatalf("%v", err)
  58         }
  59 }
  60
  61 type ConfigParams struct {
  62         CaseInsensitive    bool
  63         Client             *arvados.Client
  64         ClusterID          string
  65         CurrentUser        arvados.User
  66         DeactivateUnlisted bool
  67         Path               string
  68         UserID             string
  69         SysUserUUID        string
  70         AnonUserUUID       string
  71         Verbose            bool
  72 }
  73
  74 func ParseFlags(cfg *ConfigParams) error {
  75         // Acceptable attributes to identify a user on the CSV file
  76         userIDOpts := map[string]bool{
  77                 "email":    true, // default
  78                 "username": true,
  79         }
  80
  81         flags := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
  82         flags.Usage = func() {
  83                 usageStr := `Synchronize remote users into Arvados from a CSV format file with 5 columns:
  84   * 1st: User Identifier (email or username)
  85   * 2nd: First name
  86   * 3rd: Last name
  87   * 4th: Active status (0 or 1)
  88   * 5th: Admin status (0 or 1)`
  89                 fmt.Fprintf(flags.Output(), "%s\n\n", usageStr)
  90                 fmt.Fprintf(flags.Output(), "Usage:\n%s [OPTIONS] <input-file.csv>\n\n", os.Args[0])
  91                 fmt.Fprintf(flags.Output(), "Options:\n")
  92                 flags.PrintDefaults()
  93         }
  94
  95         caseInsensitive := flags.Bool(
  96                 "case-insensitive",
  97                 false,
  98                 "Performs case insensitive matching on user IDs. Always ON when using 'email' user IDs.")
  99         deactivateUnlisted := flags.Bool(
 100                 "deactivate-unlisted",
 101                 false,
 102                 "Deactivate users that are not in the input file.")
 103         userID := flags.String(
 104                 "user-id",
 105                 "email",
 106                 "Attribute by which every user is identified. Valid values are: email and username.")
 107         verbose := flags.Bool(
 108                 "verbose",
 109                 false,
 110                 "Log informational messages.")
 111         getVersion := flags.Bool(
 112                 "version",
 113                 false,
 114                 "Print version information and exit.")
 115
 116         if ok, code := cmd.ParseFlags(flags, os.Args[0], os.Args[1:], "input-file.csv", os.Stderr); !ok {
 117                 os.Exit(code)
 118         } else if *getVersion {
 119                 fmt.Printf("%s %s\n", os.Args[0], version)
 120                 os.Exit(0)
 121         }
 122
 123         // Input file as a required positional argument
 124         if flags.NArg() == 0 {
 125                 return fmt.Errorf("please provide a path to an input file")
 126         } else if flags.NArg() > 1 {
 127                 return fmt.Errorf("please provide just one input file argument")
 128         }
 129         srcPath := &os.Args[len(os.Args)-1]
 130
 131         // Validations
 132         if *srcPath == "" {
 133                 return fmt.Errorf("input file path invalid")
 134         }
 135         if !userIDOpts[*userID] {
 136                 var options []string
 137                 for opt := range userIDOpts {
 138                         options = append(options, opt)
 139                 }
 140                 return fmt.Errorf("user ID must be one of: %s", strings.Join(options, ", "))
 141         }
 142         if *userID == "email" {
 143                 // Always do case-insensitive email addresses matching
 144                 *caseInsensitive = true
 145         }
 146
 147         cfg.CaseInsensitive = *caseInsensitive
 148         cfg.DeactivateUnlisted = *deactivateUnlisted
 149         cfg.Path = *srcPath
 150         cfg.UserID = *userID
 151         cfg.Verbose = *verbose
 152
 153         return nil
 154 }
 155
 156 // GetConfig sets up a ConfigParams struct
 157 func GetConfig() (cfg ConfigParams, err error) {
 158         err = ParseFlags(&cfg)
 159         if err != nil {
 160                 return
 161         }
 162
 163         cfg.Client = arvados.NewClientFromEnv()
 164
 165         // Check current user permissions
 166         u, err := cfg.Client.CurrentUser()
 167         if err != nil {
 168                 return cfg, fmt.Errorf("error getting the current user: %s", err)
 169         }
 170         if !u.IsAdmin {
 171                 return cfg, fmt.Errorf("current user %q is not an admin user", u.UUID)
 172         }
 173         if cfg.Verbose {
 174                 log.Printf("Running as admin user %q (%s)", u.Email, u.UUID)
 175         }
 176         cfg.CurrentUser = u
 177
 178         var ac struct {
 179                 ClusterID string
 180                 Login     struct {
 181                         LoginCluster string
 182                 }
 183         }
 184         err = cfg.Client.RequestAndDecode(&ac, "GET", "arvados/v1/config", nil, nil)
 185         if err != nil {
 186                 return cfg, fmt.Errorf("error getting the exported config: %s", err)
 187         }
 188         if ac.Login.LoginCluster != "" && ac.Login.LoginCluster != ac.ClusterID {
 189                 return cfg, fmt.Errorf("cannot run on a cluster other than the login cluster")
 190         }
 191         cfg.SysUserUUID = ac.ClusterID + "-tpzed-000000000000000"
 192         cfg.AnonUserUUID = ac.ClusterID + "-tpzed-anonymouspublic"
 193         cfg.ClusterID = ac.ClusterID
 194
 195         return cfg, nil
 196 }
 197
 198 // GetUserID returns the correct user id value depending on the selector
 199 func GetUserID(u arvados.User, idSelector string) (string, error) {
 200         switch idSelector {
 201         case "email":
 202                 return u.Email, nil
 203         case "username":
 204                 return u.Username, nil
 205         default:
 206                 return "", fmt.Errorf("cannot identify user by %q selector", idSelector)
 207         }
 208 }
 209
 210 func doMain(cfg *ConfigParams) error {
 211         // Try opening the input file early, just in case there's a problem.
 212         f, err := os.Open(cfg.Path)
 213         if err != nil {
 214                 return fmt.Errorf("error opening input file: %s", err)
 215         }
 216         defer f.Close()
 217
 218         iCaseLog := ""
 219         if cfg.UserID == "username" && cfg.CaseInsensitive {
 220                 iCaseLog = " - username matching requested to be case-insensitive"
 221         }
 222         log.Printf("%s %s started. Using %q as users id%s", os.Args[0], version, cfg.UserID, iCaseLog)
 223
 224         allUsers := make(map[string]arvados.User)
 225         userIDToUUID := make(map[string]string) // Index by email or username
 226         dupedEmails := make(map[string][]arvados.User)
 227         emptyUserIDs := []string{}
 228         processedUsers := make(map[string]bool)
 229         results, err := GetAll(cfg.Client, "users", arvados.ResourceListParams{}, &UserList{})
 230         if err != nil {
 231                 return fmt.Errorf("error getting all users: %s", err)
 232         }
 233         log.Printf("Found %d users in cluster %q", len(results), cfg.ClusterID)
 234         localUserUuidRegex := regexp.MustCompile(fmt.Sprintf("^%s-tpzed-[0-9a-z]{15}$", cfg.ClusterID))
 235         for _, item := range results {
 236                 u := item.(arvados.User)
 237
 238                 // Remote user check
 239                 if !localUserUuidRegex.MatchString(u.UUID) {
 240                         if cfg.Verbose {
 241                                 log.Printf("Remote user %q (%s) won't be considered for processing", u.Email, u.UUID)
 242                         }
 243                         continue
 244                 }
 245
 246                 // Duplicated user id check
 247                 uID, err := GetUserID(u, cfg.UserID)
 248                 if err != nil {
 249                         return err
 250                 }
 251                 if uID == "" {
 252                         emptyUserIDs = append(emptyUserIDs, u.UUID)
 253                         log.Printf("Empty %s found in user %s - ignoring", cfg.UserID, u.UUID)
 254                         continue
 255                 }
 256                 if cfg.CaseInsensitive {
 257                         uID = strings.ToLower(uID)
 258                 }
 259                 if alreadySeenUUID, found := userIDToUUID[uID]; found {
 260                         if cfg.UserID == "username" && uID != "" {
 261                                 return fmt.Errorf("case insensitive collision for username %q between %q and %q", uID, u.UUID, alreadySeenUUID)
 262                         } else if cfg.UserID == "email" && uID != "" {
 263                                 log.Printf("Duplicated email %q found in user %s - ignoring", uID, u.UUID)
 264                                 if len(dupedEmails[uID]) == 0 {
 265                                         dupedEmails[uID] = []arvados.User{allUsers[alreadySeenUUID]}
 266                                 }
 267                                 dupedEmails[uID] = append(dupedEmails[uID], u)
 268                                 delete(allUsers, alreadySeenUUID) // Skip even the first occurrence,
 269                                 // for security purposes.
 270                                 continue
 271                         }
 272                 }
 273                 if cfg.Verbose {
 274                         log.Printf("Seen user %q (%s)", uID, u.UUID)
 275                 }
 276                 userIDToUUID[uID] = u.UUID
 277                 allUsers[u.UUID] = u
 278                 processedUsers[u.UUID] = false
 279         }
 280
 281         loadedRecords, err := LoadInputFile(f)
 282         if err != nil {
 283                 return fmt.Errorf("reading input file %q: %s", cfg.Path, err)
 284         }
 285         log.Printf("Loaded %d records from input file", len(loadedRecords))
 286
 287         updatesSucceeded := map[string]bool{}
 288         updatesFailed := map[string]bool{}
 289         updatesSkipped := map[string]bool{}
 290
 291         for _, record := range loadedRecords {
 292                 if cfg.CaseInsensitive {
 293                         record.UserID = strings.ToLower(record.UserID)
 294                 }
 295                 recordUUID := userIDToUUID[record.UserID]
 296                 processedUsers[recordUUID] = true
 297                 if cfg.UserID == "email" && record.UserID == cfg.CurrentUser.Email {
 298                         updatesSkipped[recordUUID] = true
 299                         log.Printf("Skipping current user %q (%s) from processing", record.UserID, cfg.CurrentUser.UUID)
 300                         continue
 301                 }
 302                 if updated, err := ProcessRecord(cfg, record, userIDToUUID, allUsers); err != nil {
 303                         log.Printf("error processing record %q: %s", record.UserID, err)
 304                         updatesFailed[recordUUID] = true
 305                 } else if updated {
 306                         updatesSucceeded[recordUUID] = true
 307                 }
 308         }
 309
 310         if cfg.DeactivateUnlisted {
 311                 for userUUID, user := range allUsers {
 312                         if shouldSkip(cfg, user) {
 313                                 updatesSkipped[userUUID] = true
 314                                 log.Printf("Skipping unlisted user %q (%s) from deactivating", user.Email, user.UUID)
 315                                 continue
 316                         }
 317                         if !processedUsers[userUUID] && allUsers[userUUID].IsActive {
 318                                 if cfg.Verbose {
 319                                         log.Printf("Deactivating unlisted user %q (%s)", user.Username, user.UUID)
 320                                 }
 321                                 var updatedUser arvados.User
 322                                 if err := UnsetupUser(cfg.Client, user.UUID, &updatedUser); err != nil {
 323                                         log.Printf("error deactivating unlisted user %q: %s", user.UUID, err)
 324                                         updatesFailed[userUUID] = true
 325                                 } else {
 326                                         allUsers[userUUID] = updatedUser
 327                                         updatesSucceeded[userUUID] = true
 328                                 }
 329                         }
 330                 }
 331         }
 332
 333         log.Printf("User update successes: %d, skips: %d, failures: %d", len(updatesSucceeded), len(updatesSkipped), len(updatesFailed))
 334
 335         var errors []string
 336         if len(dupedEmails) > 0 {
 337                 emails := make([]string, len(dupedEmails))
 338                 i := 0
 339                 for e := range dupedEmails {
 340                         emails[i] = e
 341                         i++
 342                 }
 343                 errors = append(errors, fmt.Sprintf("skipped %d duplicated email address(es) in the cluster's local user list: %v", len(dupedEmails), emails))
 344         }
 345         if len(emptyUserIDs) > 0 {
 346                 errors = append(errors, fmt.Sprintf("skipped %d user account(s) with empty %s: %v", len(emptyUserIDs), cfg.UserID, emptyUserIDs))
 347         }
 348         if len(errors) > 0 {
 349                 return fmt.Errorf("%s", strings.Join(errors, "\n"))
 350         }
 351
 352         return nil
 353 }
 354
 355 func shouldSkip(cfg *ConfigParams, user arvados.User) bool {
 356         switch user.UUID {
 357         case cfg.SysUserUUID, cfg.AnonUserUUID:
 358                 return true
 359         case cfg.CurrentUser.UUID:
 360                 return true
 361         }
 362         return false
 363 }
 364
 365 type userRecord struct {
 366         UserID    string
 367         FirstName string
 368         LastName  string
 369         Active    bool
 370         Admin     bool
 371 }
 372
 373 func needsUpdating(user arvados.User, record userRecord) bool {
 374         userData := userRecord{"", user.FirstName, user.LastName, user.IsActive, user.IsAdmin}
 375         recordData := userRecord{"", record.FirstName, record.LastName, record.Active, record.Admin}
 376         return userData != recordData
 377 }
 378
 379 // ProcessRecord creates or updates a user based on the given record
 380 func ProcessRecord(cfg *ConfigParams, record userRecord, userIDToUUID map[string]string, allUsers map[string]arvados.User) (bool, error) {
 381         if cfg.Verbose {
 382                 log.Printf("Processing record for user %q", record.UserID)
 383         }
 384
 385         wantedActiveStatus := strconv.FormatBool(record.Active)
 386         wantedAdminStatus := strconv.FormatBool(record.Active && record.Admin)
 387         createRequired := false
 388         updateRequired := false
 389         // Check if user exists, set its active & admin status.
 390         var user arvados.User
 391         recordUUID := userIDToUUID[record.UserID]
 392         user, found := allUsers[recordUUID]
 393         if !found {
 394                 if cfg.Verbose {
 395                         log.Printf("User %q does not exist, creating", record.UserID)
 396                 }
 397                 createRequired = true
 398                 err := CreateUser(cfg.Client, &user, map[string]string{
 399                         cfg.UserID:   record.UserID,
 400                         "first_name": record.FirstName,
 401                         "last_name":  record.LastName,
 402                         "is_active":  wantedActiveStatus,
 403                         "is_admin":   wantedAdminStatus,
 404                 })
 405                 if err != nil {
 406                         return false, fmt.Errorf("error creating user %q: %s", record.UserID, err)
 407                 }
 408         } else if needsUpdating(user, record) {
 409                 updateRequired = true
 410                 if record.Active {
 411                         if !user.IsActive && cfg.Verbose {
 412                                 log.Printf("User %q (%s) is inactive, activating", record.UserID, user.UUID)
 413                         }
 414                         // Here we assume the 'setup' is done elsewhere if needed.
 415                         err := UpdateUser(cfg.Client, user.UUID, &user, map[string]string{
 416                                 "first_name": record.FirstName,
 417                                 "last_name":  record.LastName,
 418                                 "is_active":  wantedActiveStatus,
 419                                 "is_admin":   wantedAdminStatus,
 420                         })
 421                         if err != nil {
 422                                 return false, fmt.Errorf("error updating user %q: %s", record.UserID, err)
 423                         }
 424                 } else {
 425                         fnChanged := user.FirstName != record.FirstName
 426                         lnChanged := user.LastName != record.LastName
 427                         if fnChanged || lnChanged {
 428                                 err := UpdateUser(cfg.Client, user.UUID, &user, map[string]string{
 429                                         "first_name": record.FirstName,
 430                                         "last_name":  record.LastName,
 431                                 })
 432                                 if err != nil {
 433                                         return false, fmt.Errorf("error updating user %q: %s", record.UserID, err)
 434                                 }
 435                         }
 436                         if user.IsActive {
 437                                 if cfg.Verbose {
 438                                         log.Printf("User %q is active, deactivating", record.UserID)
 439                                 }
 440                                 err := UnsetupUser(cfg.Client, user.UUID, &user)
 441                                 if err != nil {
 442                                         return false, fmt.Errorf("error deactivating user %q: %s", record.UserID, err)
 443                                 }
 444                         }
 445                 }
 446         }
 447         allUsers[record.UserID] = user
 448         if createRequired {
 449                 log.Printf("Created user %q", record.UserID)
 450         }
 451         if updateRequired {
 452                 log.Printf("Updated user %q", record.UserID)
 453         }
 454
 455         return createRequired || updateRequired, nil
 456 }
 457
 458 // LoadInputFile reads the input file and returns a list of user records
 459 func LoadInputFile(f *os.File) (loadedRecords []userRecord, err error) {
 460         lineNo := 0
 461         csvReader := csv.NewReader(f)
 462         loadedRecords = make([]userRecord, 0)
 463
 464         for {
 465                 record, e := csvReader.Read()
 466                 if e == io.EOF {
 467                         break
 468                 }
 469                 lineNo++
 470                 if e != nil {
 471                         err = fmt.Errorf("parsing error at line %d: %s", lineNo, e)
 472                         return
 473                 }
 474                 if len(record) != 5 {
 475                         err = fmt.Errorf("parsing error at line %d: expected 5 fields, found %d", lineNo, len(record))
 476                         return
 477                 }
 478                 userID := strings.ToLower(strings.TrimSpace(record[0]))
 479                 firstName := strings.TrimSpace(record[1])
 480                 lastName := strings.TrimSpace(record[2])
 481                 active := strings.TrimSpace(record[3])
 482                 admin := strings.TrimSpace(record[4])
 483                 if userID == "" || firstName == "" || lastName == "" || active == "" || admin == "" {
 484                         err = fmt.Errorf("parsing error at line %d: fields cannot be empty", lineNo)
 485                         return
 486                 }
 487                 activeBool, err := strconv.ParseBool(active)
 488                 if err != nil {
 489                         return nil, fmt.Errorf("parsing error at line %d: active status not recognized", lineNo)
 490                 }
 491                 adminBool, err := strconv.ParseBool(admin)
 492                 if err != nil {
 493                         return nil, fmt.Errorf("parsing error at line %d: admin status not recognized", lineNo)
 494                 }
 495                 loadedRecords = append(loadedRecords, userRecord{
 496                         UserID:    userID,
 497                         FirstName: firstName,
 498                         LastName:  lastName,
 499                         Active:    activeBool,
 500                         Admin:     adminBool,
 501                 })
 502         }
 503         return loadedRecords, nil
 504 }
 505
 506 // GetAll adds all objects of type 'resource' to the 'allItems' list
 507 func GetAll(c *arvados.Client, res string, params arvados.ResourceListParams, page resourceList) (allItems []interface{}, err error) {
 508         // Use the maximum page size the server allows
 509         limit := 1<<31 - 1
 510         params.Limit = &limit
 511         params.Offset = 0
 512         params.Order = "uuid"
 513         for {
 514                 if err = GetResourceList(c, &page, res, params); err != nil {
 515                         return allItems, err
 516                 }
 517                 // Have we finished paging?
 518                 if page.Len() == 0 {
 519                         break
 520                 }
 521                 allItems = append(allItems, page.GetItems()...)
 522                 params.Offset += page.Len()
 523         }
 524         return allItems, nil
 525 }
 526
 527 func jsonReader(rscName string, ob interface{}) io.Reader {
 528         j, err := json.Marshal(ob)
 529         if err != nil {
 530                 panic(err)
 531         }
 532         v := url.Values{}
 533         v[rscName] = []string{string(j)}
 534         return bytes.NewBufferString(v.Encode())
 535 }
 536
 537 // GetResourceList fetches res list using params
 538 func GetResourceList(c *arvados.Client, dst *resourceList, res string, params interface{}) error {
 539         return c.RequestAndDecode(dst, "GET", "/arvados/v1/"+res, nil, params)
 540 }
 541
 542 // CreateUser creates a user with userData parameters, assigns it to dst
 543 func CreateUser(c *arvados.Client, dst *arvados.User, userData map[string]string) error {
 544         return c.RequestAndDecode(dst, "POST", "/arvados/v1/users", jsonReader("user", userData), nil)
 545 }
 546
 547 // UpdateUser updates a user with userData parameters
 548 func UpdateUser(c *arvados.Client, userUUID string, dst *arvados.User, userData map[string]string) error {
 549         return c.RequestAndDecode(&dst, "PUT", "/arvados/v1/users/"+userUUID, jsonReader("user", userData), nil)
 550 }
 551
 552 // UnsetupUser deactivates a user
 553 func UnsetupUser(c *arvados.Client, userUUID string, dst *arvados.User) error {
 554         return c.RequestAndDecode(&dst, "POST", "/arvados/v1/users/"+userUUID+"/unsetup", nil, nil)
 555 }