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         }
 127         srcPath := &os.Args[flags.NFlag()+1]
 128
 129         // Validations
 130         if *srcPath == "" {
 131                 return fmt.Errorf("input file path invalid")
 132         }
 133         if !userIDOpts[*userID] {
 134                 var options []string
 135                 for opt := range userIDOpts {
 136                         options = append(options, opt)
 137                 }
 138                 return fmt.Errorf("user ID must be one of: %s", strings.Join(options, ", "))
 139         }
 140         if *userID == "email" {
 141                 // Always do case-insensitive email addresses matching
 142                 *caseInsensitive = true
 143         }
 144
 145         cfg.CaseInsensitive = *caseInsensitive
 146         cfg.DeactivateUnlisted = *deactivateUnlisted
 147         cfg.Path = *srcPath
 148         cfg.UserID = *userID
 149         cfg.Verbose = *verbose
 150
 151         return nil
 152 }
 153
 154 // GetConfig sets up a ConfigParams struct
 155 func GetConfig() (cfg ConfigParams, err error) {
 156         err = ParseFlags(&cfg)
 157         if err != nil {
 158                 return
 159         }
 160
 161         cfg.Client = arvados.NewClientFromEnv()
 162
 163         // Check current user permissions
 164         u, err := cfg.Client.CurrentUser()
 165         if err != nil {
 166                 return cfg, fmt.Errorf("error getting the current user: %s", err)
 167         }
 168         if !u.IsAdmin {
 169                 return cfg, fmt.Errorf("current user %q is not an admin user", u.UUID)
 170         }
 171         if cfg.Verbose {
 172                 log.Printf("Running as admin user %q (%s)", u.Email, u.UUID)
 173         }
 174         cfg.CurrentUser = u
 175
 176         var ac struct {
 177                 ClusterID string
 178                 Login     struct {
 179                         LoginCluster string
 180                 }
 181         }
 182         err = cfg.Client.RequestAndDecode(&ac, "GET", "arvados/v1/config", nil, nil)
 183         if err != nil {
 184                 return cfg, fmt.Errorf("error getting the exported config: %s", err)
 185         }
 186         if ac.Login.LoginCluster != "" && ac.Login.LoginCluster != ac.ClusterID {
 187                 return cfg, fmt.Errorf("cannot run on a cluster other than the login cluster")
 188         }
 189         cfg.SysUserUUID = ac.ClusterID + "-tpzed-000000000000000"
 190         cfg.AnonUserUUID = ac.ClusterID + "-tpzed-anonymouspublic"
 191         cfg.ClusterID = ac.ClusterID
 192
 193         return cfg, nil
 194 }
 195
 196 // GetUserID returns the correct user id value depending on the selector
 197 func GetUserID(u arvados.User, idSelector string) (string, error) {
 198         switch idSelector {
 199         case "email":
 200                 return u.Email, nil
 201         case "username":
 202                 return u.Username, nil
 203         default:
 204                 return "", fmt.Errorf("cannot identify user by %q selector", idSelector)
 205         }
 206 }
 207
 208 func doMain(cfg *ConfigParams) error {
 209         // Try opening the input file early, just in case there's a problem.
 210         f, err := os.Open(cfg.Path)
 211         if err != nil {
 212                 return fmt.Errorf("error opening input file: %s", err)
 213         }
 214         defer f.Close()
 215
 216         iCaseLog := ""
 217         if cfg.UserID == "username" && cfg.CaseInsensitive {
 218                 iCaseLog = " - username matching requested to be case-insensitive"
 219         }
 220         log.Printf("%s %s started. Using %q as users id%s", os.Args[0], version, cfg.UserID, iCaseLog)
 221
 222         allUsers := make(map[string]arvados.User)
 223         userIDToUUID := make(map[string]string) // Index by email or username
 224         dupedEmails := make(map[string][]arvados.User)
 225         emptyUserIDs := []string{}
 226         processedUsers := make(map[string]bool)
 227         results, err := GetAll(cfg.Client, "users", arvados.ResourceListParams{}, &UserList{})
 228         if err != nil {
 229                 return fmt.Errorf("error getting all users: %s", err)
 230         }
 231         log.Printf("Found %d users in cluster %q", len(results), cfg.ClusterID)
 232         localUserUuidRegex := regexp.MustCompile(fmt.Sprintf("^%s-tpzed-[0-9a-z]{15}$", cfg.ClusterID))
 233         for _, item := range results {
 234                 u := item.(arvados.User)
 235
 236                 // Remote user check
 237                 if !localUserUuidRegex.MatchString(u.UUID) {
 238                         if cfg.Verbose {
 239                                 log.Printf("Remote user %q (%s) won't be considered for processing", u.Email, u.UUID)
 240                         }
 241                         continue
 242                 }
 243
 244                 // Duplicated user id check
 245                 uID, err := GetUserID(u, cfg.UserID)
 246                 if err != nil {
 247                         return err
 248                 }
 249                 if uID == "" {
 250                         emptyUserIDs = append(emptyUserIDs, u.UUID)
 251                         log.Printf("Empty %s found in user %s - ignoring", cfg.UserID, u.UUID)
 252                         continue
 253                 }
 254                 if cfg.CaseInsensitive {
 255                         uID = strings.ToLower(uID)
 256                 }
 257                 if alreadySeenUUID, found := userIDToUUID[uID]; found {
 258                         if cfg.UserID == "username" && uID != "" {
 259                                 return fmt.Errorf("case insensitive collision for username %q between %q and %q", uID, u.UUID, alreadySeenUUID)
 260                         } else if cfg.UserID == "email" && uID != "" {
 261                                 log.Printf("Duplicated email %q found in user %s - ignoring", uID, u.UUID)
 262                                 if len(dupedEmails[uID]) == 0 {
 263                                         dupedEmails[uID] = []arvados.User{allUsers[alreadySeenUUID]}
 264                                 }
 265                                 dupedEmails[uID] = append(dupedEmails[uID], u)
 266                                 delete(allUsers, alreadySeenUUID) // Skip even the first occurrence,
 267                                 // for security purposes.
 268                                 continue
 269                         }
 270                 }
 271                 if cfg.Verbose {
 272                         log.Printf("Seen user %q (%s)", uID, u.UUID)
 273                 }
 274                 userIDToUUID[uID] = u.UUID
 275                 allUsers[u.UUID] = u
 276                 processedUsers[u.UUID] = false
 277         }
 278
 279         loadedRecords, err := LoadInputFile(f)
 280         if err != nil {
 281                 return fmt.Errorf("reading input file %q: %s", cfg.Path, err)
 282         }
 283         log.Printf("Loaded %d records from input file", len(loadedRecords))
 284
 285         updatesSucceeded := map[string]bool{}
 286         updatesFailed := map[string]bool{}
 287         updatesSkipped := map[string]bool{}
 288
 289         for _, record := range loadedRecords {
 290                 if cfg.CaseInsensitive {
 291                         record.UserID = strings.ToLower(record.UserID)
 292                 }
 293                 recordUUID := userIDToUUID[record.UserID]
 294                 processedUsers[recordUUID] = true
 295                 if cfg.UserID == "email" && record.UserID == cfg.CurrentUser.Email {
 296                         updatesSkipped[recordUUID] = true
 297                         log.Printf("Skipping current user %q (%s) from processing", record.UserID, cfg.CurrentUser.UUID)
 298                         continue
 299                 }
 300                 if updated, err := ProcessRecord(cfg, record, userIDToUUID, allUsers); err != nil {
 301                         log.Printf("error processing record %q: %s", record.UserID, err)
 302                         updatesFailed[recordUUID] = true
 303                 } else if updated {
 304                         updatesSucceeded[recordUUID] = true
 305                 }
 306         }
 307
 308         if cfg.DeactivateUnlisted {
 309                 for userUUID, user := range allUsers {
 310                         if shouldSkip(cfg, user) {
 311                                 updatesSkipped[userUUID] = true
 312                                 log.Printf("Skipping unlisted user %q (%s) from deactivating", user.Email, user.UUID)
 313                                 continue
 314                         }
 315                         if !processedUsers[userUUID] && allUsers[userUUID].IsActive {
 316                                 if cfg.Verbose {
 317                                         log.Printf("Deactivating unlisted user %q (%s)", user.Username, user.UUID)
 318                                 }
 319                                 var updatedUser arvados.User
 320                                 if err := UnsetupUser(cfg.Client, user.UUID, &updatedUser); err != nil {
 321                                         log.Printf("error deactivating unlisted user %q: %s", user.UUID, err)
 322                                         updatesFailed[userUUID] = true
 323                                 } else {
 324                                         allUsers[userUUID] = updatedUser
 325                                         updatesSucceeded[userUUID] = true
 326                                 }
 327                         }
 328                 }
 329         }
 330
 331         log.Printf("User update successes: %d, skips: %d, failures: %d", len(updatesSucceeded), len(updatesSkipped), len(updatesFailed))
 332
 333         var errors []string
 334         if len(dupedEmails) > 0 {
 335                 emails := make([]string, len(dupedEmails))
 336                 i := 0
 337                 for e := range dupedEmails {
 338                         emails[i] = e
 339                         i++
 340                 }
 341                 errors = append(errors, fmt.Sprintf("skipped %d duplicated email address(es) in the cluster's local user list: %v", len(dupedEmails), emails))
 342         }
 343         if len(emptyUserIDs) > 0 {
 344                 errors = append(errors, fmt.Sprintf("skipped %d user account(s) with empty %s: %v", len(emptyUserIDs), cfg.UserID, emptyUserIDs))
 345         }
 346         if len(errors) > 0 {
 347                 return fmt.Errorf("%s", strings.Join(errors, "\n"))
 348         }
 349
 350         return nil
 351 }
 352
 353 func shouldSkip(cfg *ConfigParams, user arvados.User) bool {
 354         switch user.UUID {
 355         case cfg.SysUserUUID, cfg.AnonUserUUID:
 356                 return true
 357         case cfg.CurrentUser.UUID:
 358                 return true
 359         }
 360         return false
 361 }
 362
 363 type userRecord struct {
 364         UserID    string
 365         FirstName string
 366         LastName  string
 367         Active    bool
 368         Admin     bool
 369 }
 370
 371 func needsUpdating(user arvados.User, record userRecord) bool {
 372         userData := userRecord{"", user.FirstName, user.LastName, user.IsActive, user.IsAdmin}
 373         recordData := userRecord{"", record.FirstName, record.LastName, record.Active, record.Admin}
 374         return userData != recordData
 375 }
 376
 377 // ProcessRecord creates or updates a user based on the given record
 378 func ProcessRecord(cfg *ConfigParams, record userRecord, userIDToUUID map[string]string, allUsers map[string]arvados.User) (bool, error) {
 379         if cfg.Verbose {
 380                 log.Printf("Processing record for user %q", record.UserID)
 381         }
 382
 383         wantedActiveStatus := strconv.FormatBool(record.Active)
 384         wantedAdminStatus := strconv.FormatBool(record.Active && record.Admin)
 385         createRequired := false
 386         updateRequired := false
 387         // Check if user exists, set its active & admin status.
 388         var user arvados.User
 389         recordUUID := userIDToUUID[record.UserID]
 390         user, found := allUsers[recordUUID]
 391         if !found {
 392                 if cfg.Verbose {
 393                         log.Printf("User %q does not exist, creating", record.UserID)
 394                 }
 395                 createRequired = true
 396                 err := CreateUser(cfg.Client, &user, map[string]string{
 397                         cfg.UserID:   record.UserID,
 398                         "first_name": record.FirstName,
 399                         "last_name":  record.LastName,
 400                         "is_active":  wantedActiveStatus,
 401                         "is_admin":   wantedAdminStatus,
 402                 })
 403                 if err != nil {
 404                         return false, fmt.Errorf("error creating user %q: %s", record.UserID, err)
 405                 }
 406         } else if needsUpdating(user, record) {
 407                 updateRequired = true
 408                 if record.Active {
 409                         if !user.IsActive && cfg.Verbose {
 410                                 log.Printf("User %q (%s) is inactive, activating", record.UserID, user.UUID)
 411                         }
 412                         // Here we assume the 'setup' is done elsewhere if needed.
 413                         err := UpdateUser(cfg.Client, user.UUID, &user, map[string]string{
 414                                 "first_name": record.FirstName,
 415                                 "last_name":  record.LastName,
 416                                 "is_active":  wantedActiveStatus,
 417                                 "is_admin":   wantedAdminStatus,
 418                         })
 419                         if err != nil {
 420                                 return false, fmt.Errorf("error updating user %q: %s", record.UserID, err)
 421                         }
 422                 } else {
 423                         fnChanged := user.FirstName != record.FirstName
 424                         lnChanged := user.LastName != record.LastName
 425                         if fnChanged || lnChanged {
 426                                 err := UpdateUser(cfg.Client, user.UUID, &user, map[string]string{
 427                                         "first_name": record.FirstName,
 428                                         "last_name":  record.LastName,
 429                                 })
 430                                 if err != nil {
 431                                         return false, fmt.Errorf("error updating user %q: %s", record.UserID, err)
 432                                 }
 433                         }
 434                         if user.IsActive {
 435                                 if cfg.Verbose {
 436                                         log.Printf("User %q is active, deactivating", record.UserID)
 437                                 }
 438                                 err := UnsetupUser(cfg.Client, user.UUID, &user)
 439                                 if err != nil {
 440                                         return false, fmt.Errorf("error deactivating user %q: %s", record.UserID, err)
 441                                 }
 442                         }
 443                 }
 444         }
 445         allUsers[record.UserID] = user
 446         if createRequired {
 447                 log.Printf("Created user %q", record.UserID)
 448         }
 449         if updateRequired {
 450                 log.Printf("Updated user %q", record.UserID)
 451         }
 452
 453         return createRequired || updateRequired, nil
 454 }
 455
 456 // LoadInputFile reads the input file and returns a list of user records
 457 func LoadInputFile(f *os.File) (loadedRecords []userRecord, err error) {
 458         lineNo := 0
 459         csvReader := csv.NewReader(f)
 460         loadedRecords = make([]userRecord, 0)
 461
 462         for {
 463                 record, e := csvReader.Read()
 464                 if e == io.EOF {
 465                         break
 466                 }
 467                 lineNo++
 468                 if e != nil {
 469                         err = fmt.Errorf("parsing error at line %d: %s", lineNo, e)
 470                         return
 471                 }
 472                 if len(record) != 5 {
 473                         err = fmt.Errorf("parsing error at line %d: expected 5 fields, found %d", lineNo, len(record))
 474                         return
 475                 }
 476                 userID := strings.ToLower(strings.TrimSpace(record[0]))
 477                 firstName := strings.TrimSpace(record[1])
 478                 lastName := strings.TrimSpace(record[2])
 479                 active := strings.TrimSpace(record[3])
 480                 admin := strings.TrimSpace(record[4])
 481                 if userID == "" || firstName == "" || lastName == "" || active == "" || admin == "" {
 482                         err = fmt.Errorf("parsing error at line %d: fields cannot be empty", lineNo)
 483                         return
 484                 }
 485                 activeBool, err := strconv.ParseBool(active)
 486                 if err != nil {
 487                         return nil, fmt.Errorf("parsing error at line %d: active status not recognized", lineNo)
 488                 }
 489                 adminBool, err := strconv.ParseBool(admin)
 490                 if err != nil {
 491                         return nil, fmt.Errorf("parsing error at line %d: admin status not recognized", lineNo)
 492                 }
 493                 loadedRecords = append(loadedRecords, userRecord{
 494                         UserID:    userID,
 495                         FirstName: firstName,
 496                         LastName:  lastName,
 497                         Active:    activeBool,
 498                         Admin:     adminBool,
 499                 })
 500         }
 501         return loadedRecords, nil
 502 }
 503
 504 // GetAll adds all objects of type 'resource' to the 'allItems' list
 505 func GetAll(c *arvados.Client, res string, params arvados.ResourceListParams, page resourceList) (allItems []interface{}, err error) {
 506         // Use the maximum page size the server allows
 507         limit := 1<<31 - 1
 508         params.Limit = &limit
 509         params.Offset = 0
 510         params.Order = "uuid"
 511         for {
 512                 if err = GetResourceList(c, &page, res, params); err != nil {
 513                         return allItems, err
 514                 }
 515                 // Have we finished paging?
 516                 if page.Len() == 0 {
 517                         break
 518                 }
 519                 allItems = append(allItems, page.GetItems()...)
 520                 params.Offset += page.Len()
 521         }
 522         return allItems, nil
 523 }
 524
 525 func jsonReader(rscName string, ob interface{}) io.Reader {
 526         j, err := json.Marshal(ob)
 527         if err != nil {
 528                 panic(err)
 529         }
 530         v := url.Values{}
 531         v[rscName] = []string{string(j)}
 532         return bytes.NewBufferString(v.Encode())
 533 }
 534
 535 // GetResourceList fetches res list using params
 536 func GetResourceList(c *arvados.Client, dst *resourceList, res string, params interface{}) error {
 537         return c.RequestAndDecode(dst, "GET", "/arvados/v1/"+res, nil, params)
 538 }
 539
 540 // CreateUser creates a user with userData parameters, assigns it to dst
 541 func CreateUser(c *arvados.Client, dst *arvados.User, userData map[string]string) error {
 542         return c.RequestAndDecode(dst, "POST", "/arvados/v1/users", jsonReader("user", userData), nil)
 543 }
 544
 545 // UpdateUser updates a user with userData parameters
 546 func UpdateUser(c *arvados.Client, userUUID string, dst *arvados.User, userData map[string]string) error {
 547         return c.RequestAndDecode(&dst, "PUT", "/arvados/v1/users/"+userUUID, jsonReader("user", userData), nil)
 548 }
 549
 550 // UnsetupUser deactivates a user
 551 func UnsetupUser(c *arvados.Client, userUUID string, dst *arvados.User) error {
 552         return c.RequestAndDecode(&dst, "POST", "/arvados/v1/users/"+userUUID+"/unsetup", nil, nil)
 553 }