1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: AGPL-3.0
19 "git.arvados.org/arvados.git/sdk/go/arvados"
24 type resourceList interface {
26 GetItems() []interface{}
29 // GroupPermissions maps permission levels on groups (can_read, can_write, can_manage)
30 type GroupPermissions map[string]bool
32 // GroupInfo tracks previous and current member's permissions on a particular Group
33 type GroupInfo struct {
35 PreviousMembers map[string]GroupPermissions
36 CurrentMembers map[string]GroupPermissions
39 // GetUserID returns the correct user id value depending on the selector
40 func GetUserID(u arvados.User, idSelector string) (string, error) {
45 return u.Username, nil
47 return "", fmt.Errorf("cannot identify user by %q selector", idSelector)
51 // UserList implements resourceList interface
52 type UserList struct {
56 // Len returns the amount of items this list holds
57 func (l UserList) Len() int {
61 // GetItems returns the list of items
62 func (l UserList) GetItems() (out []interface{}) {
63 for _, item := range l.Items {
64 out = append(out, item)
69 // GroupList implements resourceList interface
70 type GroupList struct {
74 // Len returns the amount of items this list holds
75 func (l GroupList) Len() int {
79 // GetItems returns the list of items
80 func (l GroupList) GetItems() (out []interface{}) {
81 for _, item := range l.Items {
82 out = append(out, item)
87 // LinkList implements resourceList interface
88 type LinkList struct {
92 // Len returns the amount of items this list holds
93 func (l LinkList) Len() int {
97 // GetItems returns the list of items
98 func (l LinkList) GetItems() (out []interface{}) {
99 for _, item := range l.Items {
100 out = append(out, item)
106 // Parse & validate arguments, set up arvados client.
107 cfg, err := GetConfig()
109 log.Fatalf("%v", err)
112 if err := doMain(&cfg); err != nil {
113 log.Fatalf("%v", err)
117 // ConfigParams holds configuration data for this tool
118 type ConfigParams struct {
122 ParentGroupUUID string
123 ParentGroupName string
125 Client *arvados.Client
128 // ParseFlags parses and validates command line arguments
129 func ParseFlags(config *ConfigParams) error {
130 // Acceptable attributes to identify a user on the CSV file
131 userIDOpts := map[string]bool{
132 "email": true, // default
136 flags := flag.NewFlagSet(os.Args[0], flag.ExitOnError)
138 // Set up usage message
139 flags.Usage = func() {
140 usageStr := `Synchronize remote groups into Arvados from a CSV format file with 3 columns:
142 * 2nd: User identifier
143 * 3rd (Optional): User permission on the group: can_read, can_write or can_manage. (Default: can_write)`
144 fmt.Fprintf(os.Stderr, "%s\n\n", usageStr)
145 fmt.Fprintf(os.Stderr, "Usage:\n%s [OPTIONS] <input-file.csv>\n\n", os.Args[0])
146 fmt.Fprintf(os.Stderr, "Options:\n")
147 flags.PrintDefaults()
150 // Set up option flags
151 userID := flags.String(
154 "Attribute by which every user is identified. Valid values are: email and username.")
155 verbose := flags.Bool(
158 "Log informational messages. Off by default.")
159 getVersion := flags.Bool(
162 "Print version information and exit.")
163 parentGroupUUID := flags.String(
166 "Use given group UUID as a parent for the remote groups. Should be owned by the system user. If not specified, a group named '"+config.ParentGroupName+"' will be used (and created if nonexistant).")
168 // Parse args; omit the first arg which is the command name
169 flags.Parse(os.Args[1:])
171 // Print version information if requested
173 fmt.Printf("%s %s\n", os.Args[0], version)
177 // Input file as a required positional argument
178 if flags.NArg() == 0 {
179 return fmt.Errorf("please provide a path to an input file")
181 srcPath := &os.Args[flags.NFlag()+1]
185 return fmt.Errorf("input file path invalid")
187 if !userIDOpts[*userID] {
189 for opt := range userIDOpts {
190 options = append(options, opt)
192 return fmt.Errorf("user ID must be one of: %s", strings.Join(options, ", "))
195 config.Path = *srcPath
196 config.ParentGroupUUID = *parentGroupUUID
197 config.UserID = *userID
198 config.Verbose = *verbose
203 // SetParentGroup finds/create parent group of all remote groups
204 func SetParentGroup(cfg *ConfigParams) error {
205 var parentGroup arvados.Group
206 if cfg.ParentGroupUUID == "" {
207 // UUID not provided, search for preexisting parent group
209 params := arvados.ResourceListParams{
210 Filters: []arvados.Filter{{
213 Operand: cfg.ParentGroupName,
217 Operand: cfg.SysUserUUID,
220 if err := cfg.Client.RequestAndDecode(&gl, "GET", "/arvados/v1/groups", nil, params); err != nil {
221 return fmt.Errorf("error searching for parent group: %s", err)
223 if len(gl.Items) == 0 {
224 // Default parent group does not exist, create it.
226 log.Println("Default parent group not found, creating...")
228 groupData := map[string]string{
229 "name": cfg.ParentGroupName,
230 "owner_uuid": cfg.SysUserUUID,
231 "group_class": "role",
233 if err := CreateGroup(cfg, &parentGroup, groupData); err != nil {
234 return fmt.Errorf("error creating system user owned group named %q: %s", groupData["name"], err)
236 } else if len(gl.Items) == 1 {
237 // Default parent group found.
238 parentGroup = gl.Items[0]
240 // This should never happen, as there's an unique index for
241 // (owner_uuid, name) on groups.
242 return fmt.Errorf("bug: found %d groups owned by system user and named %q", len(gl.Items), cfg.ParentGroupName)
244 cfg.ParentGroupUUID = parentGroup.UUID
246 // UUID provided. Check if exists and if it's owned by system user
247 if err := GetGroup(cfg, &parentGroup, cfg.ParentGroupUUID); err != nil {
248 return fmt.Errorf("error searching for parent group with UUID %q: %s", cfg.ParentGroupUUID, err)
250 if parentGroup.OwnerUUID != cfg.SysUserUUID {
251 return fmt.Errorf("parent group %q (%s) must be owned by system user", parentGroup.Name, cfg.ParentGroupUUID)
257 // GetConfig sets up a ConfigParams struct
258 func GetConfig() (config ConfigParams, err error) {
259 config.ParentGroupName = "Externally synchronized groups"
262 err = ParseFlags(&config)
267 // Arvados Client setup
268 config.Client = arvados.NewClientFromEnv()
270 // Check current user permissions & get System user's UUID
271 u, err := config.Client.CurrentUser()
273 return config, fmt.Errorf("error getting the current user: %s", err)
275 if !u.IsActive || !u.IsAdmin {
276 return config, fmt.Errorf("current user (%s) is not an active admin user", u.UUID)
278 config.SysUserUUID = u.UUID[:12] + "000000000000000"
280 // Set up remote groups' parent
281 if err = SetParentGroup(&config); err != nil {
288 func doMain(cfg *ConfigParams) error {
289 // Try opening the input file early, just in case there's a problem.
290 f, err := os.Open(cfg.Path)
292 return fmt.Errorf("%s", err)
296 log.Printf("%s %s started. Using %q as users id and parent group UUID %q", os.Args[0], version, cfg.UserID, cfg.ParentGroupUUID)
298 // Get the complete user list to minimize API Server requests
299 allUsers := make(map[string]arvados.User)
300 userIDToUUID := make(map[string]string) // Index by email or username
301 results, err := GetAll(cfg.Client, "users", arvados.ResourceListParams{}, &UserList{})
303 return fmt.Errorf("error getting user list: %s", err)
305 log.Printf("Found %d users", len(results))
306 for _, item := range results {
307 u := item.(arvados.User)
309 uID, err := GetUserID(u, cfg.UserID)
313 userIDToUUID[uID] = u.UUID
315 log.Printf("Seen user %q (%s)", u.Username, u.UUID)
319 // Get remote groups and their members
320 remoteGroups, groupNameToUUID, err := GetRemoteGroups(cfg, allUsers)
324 log.Printf("Found %d remote groups", len(remoteGroups))
326 for groupUUID := range remoteGroups {
327 log.Printf("- Group %q: %d users", remoteGroups[groupUUID].Group.Name, len(remoteGroups[groupUUID].PreviousMembers))
331 membershipsRemoved := 0
334 groupsCreated, membershipsAdded, membershipsSkipped, err := ProcessFile(cfg, f, userIDToUUID, groupNameToUUID, remoteGroups, allUsers)
339 // Remove previous members not listed on this run
340 for groupUUID := range remoteGroups {
341 gi := remoteGroups[groupUUID]
342 evictedMemberPerms := subtract(gi.PreviousMembers, gi.CurrentMembers)
343 groupName := gi.Group.Name
344 if len(evictedMemberPerms) > 0 {
345 log.Printf("Removing permissions from %d users on group %q", len(evictedMemberPerms), groupName)
347 for member := range evictedMemberPerms {
349 completeMembershipRemoval := false
350 if _, ok := gi.CurrentMembers[member]; !ok {
351 completeMembershipRemoval = true
354 // Collect which user->group permission links should be removed
355 for p := range evictedMemberPerms[member] {
356 if evictedMemberPerms[member][p] {
357 perms = append(perms, p)
360 membershipsRemoved += len(perms)
362 if err := RemoveMemberLinksFromGroup(cfg, allUsers[userIDToUUID[member]],
363 perms, completeMembershipRemoval, gi.Group); err != nil {
368 log.Printf("Groups created: %d. Memberships added: %d, removed: %d, skipped: %d", groupsCreated, membershipsAdded, membershipsRemoved, membershipsSkipped)
373 // ProcessFile reads the CSV file and process every record
377 userIDToUUID map[string]string,
378 groupNameToUUID map[string]string,
379 remoteGroups map[string]*GroupInfo,
380 allUsers map[string]arvados.User,
381 ) (groupsCreated, membersAdded, membersSkipped int, err error) {
383 csvReader := csv.NewReader(f)
384 // Allow variable number of fields.
385 csvReader.FieldsPerRecord = -1
387 record, e := csvReader.Read()
393 err = fmt.Errorf("error parsing %q, line %d", cfg.Path, lineNo)
396 // Only allow 2 or 3 fields per record for backwards compatibility.
397 if len(record) < 2 || len(record) > 3 {
398 err = fmt.Errorf("error parsing %q, line %d: found %d fields but only 2 or 3 are allowed", cfg.Path, lineNo, len(record))
401 groupName := strings.TrimSpace(record[0])
402 groupMember := strings.TrimSpace(record[1]) // User ID (username or email)
403 groupPermission := "can_write"
404 if len(record) == 3 {
405 groupPermission = strings.ToLower(record[2])
407 if groupName == "" || groupMember == "" || groupPermission == "" {
408 log.Printf("Warning: CSV record has at least one empty field (%s, %s, %s). Skipping", groupName, groupMember, groupPermission)
412 if !(groupPermission == "can_read" || groupPermission == "can_write" || groupPermission == "can_manage") {
413 log.Printf("Warning: 3rd field should be 'can_read', 'can_write' or 'can_manage'. Found: %q at line %d, skipping.", groupPermission, lineNo)
417 if _, found := userIDToUUID[groupMember]; !found {
418 // User not present on the system, skip.
419 log.Printf("Warning: there's no user with %s %q on the system, skipping.", cfg.UserID, groupMember)
423 if _, found := groupNameToUUID[groupName]; !found {
424 // Group doesn't exist, create it before continuing
426 log.Printf("Remote group %q not found, creating...", groupName)
428 var newGroup arvados.Group
429 groupData := map[string]string{
431 "owner_uuid": cfg.ParentGroupUUID,
432 "group_class": "role",
434 if e := CreateGroup(cfg, &newGroup, groupData); e != nil {
435 err = fmt.Errorf("error creating group named %q: %s", groupName, err)
438 // Update cached group data
439 groupNameToUUID[groupName] = newGroup.UUID
440 remoteGroups[newGroup.UUID] = &GroupInfo{
442 PreviousMembers: make(map[string]GroupPermissions),
443 CurrentMembers: make(map[string]GroupPermissions),
447 // Both group & user exist, check if user is a member
448 groupUUID := groupNameToUUID[groupName]
449 gi := remoteGroups[groupUUID]
450 if !gi.PreviousMembers[groupMember][groupPermission] && !gi.CurrentMembers[groupMember][groupPermission] {
452 log.Printf("Adding %q to group %q", groupMember, groupName)
454 // User permissionwasn't there, but should be. Avoid duplicating the
455 // group->user link when necessary.
456 createG2ULink := true
457 if _, ok := gi.PreviousMembers[groupMember]; ok {
458 createG2ULink = false // User is already member of the group
460 if e := AddMemberToGroup(cfg, allUsers[userIDToUUID[groupMember]], gi.Group, groupPermission, createG2ULink); e != nil {
466 if _, ok := gi.CurrentMembers[groupMember]; ok {
467 gi.CurrentMembers[groupMember][groupPermission] = true
469 gi.CurrentMembers[groupMember] = GroupPermissions{groupPermission: true}
476 // GetAll : Adds all objects of type 'resource' to the 'allItems' list
477 func GetAll(c *arvados.Client, res string, params arvados.ResourceListParams, page resourceList) (allItems []interface{}, err error) {
478 // Use the maximum page size the server allows
480 params.Limit = &limit
482 params.Order = "uuid"
484 if err = GetResourceList(c, &page, res, params); err != nil {
487 // Have we finished paging?
491 for _, i := range page.GetItems() {
492 allItems = append(allItems, i)
494 params.Offset += page.Len()
499 func subtract(setA map[string]GroupPermissions, setB map[string]GroupPermissions) map[string]GroupPermissions {
500 result := make(map[string]GroupPermissions)
501 for element := range setA {
502 if _, ok := setB[element]; !ok {
503 result[element] = setA[element]
505 for perm := range setA[element] {
506 if _, ok := setB[element][perm]; !ok {
507 result[element] = GroupPermissions{perm: true}
515 func jsonReader(rscName string, ob interface{}) io.Reader {
516 j, err := json.Marshal(ob)
521 v[rscName] = []string{string(j)}
522 return bytes.NewBufferString(v.Encode())
525 // GetRemoteGroups fetches all remote groups with their members
526 func GetRemoteGroups(cfg *ConfigParams, allUsers map[string]arvados.User) (remoteGroups map[string]*GroupInfo, groupNameToUUID map[string]string, err error) {
527 remoteGroups = make(map[string]*GroupInfo)
528 groupNameToUUID = make(map[string]string) // Index by group name
530 params := arvados.ResourceListParams{
531 Filters: []arvados.Filter{{
534 Operand: cfg.ParentGroupUUID,
537 results, err := GetAll(cfg.Client, "links", params, &LinkList{})
539 return remoteGroups, groupNameToUUID, fmt.Errorf("error getting remote groups: %s", err)
541 for _, item := range results {
542 var group arvados.Group
543 err = GetGroup(cfg, &group, item.(arvados.Link).HeadUUID)
545 return remoteGroups, groupNameToUUID, fmt.Errorf("error getting remote group: %s", err)
547 // Group -> User filter
548 g2uFilter := arvados.ResourceListParams{
549 Filters: []arvados.Filter{{
552 Operand: cfg.SysUserUUID,
556 Operand: "permission",
568 Operand: "arvados#user",
571 // User -> Group filter
572 u2gFilter := arvados.ResourceListParams{
573 Filters: []arvados.Filter{{
576 Operand: cfg.SysUserUUID,
580 Operand: "permission",
584 Operand: []string{"can_read", "can_write", "can_manage"},
592 Operand: "arvados#user",
595 g2uLinks, err := GetAll(cfg.Client, "links", g2uFilter, &LinkList{})
597 return remoteGroups, groupNameToUUID, fmt.Errorf("error getting group->user 'can_read' links for group %q: %s", group.Name, err)
599 u2gLinks, err := GetAll(cfg.Client, "links", u2gFilter, &LinkList{})
601 return remoteGroups, groupNameToUUID, fmt.Errorf("error getting user->group links for group %q: %s", group.Name, err)
603 // Build a list of user ids (email or username) belonging to this group.
604 membersSet := make(map[string]GroupPermissions)
605 u2gLinkSet := make(map[string]GroupPermissions)
606 for _, l := range u2gLinks {
607 link := l.(arvados.Link)
608 // Also save the member's group access level.
609 if _, ok := u2gLinkSet[link.TailUUID]; ok {
610 u2gLinkSet[link.TailUUID][link.Name] = true
612 u2gLinkSet[link.TailUUID] = GroupPermissions{link.Name: true}
615 for _, item := range g2uLinks {
616 link := item.(arvados.Link)
617 // We may have received an old link pointing to a removed account.
618 if _, found := allUsers[link.HeadUUID]; !found {
621 // The matching User -> Group link may not exist if the link
622 // creation failed on a previous run. If that's the case, don't
623 // include this account on the "previous members" list.
624 if _, found := u2gLinkSet[link.HeadUUID]; !found {
627 memberID, err := GetUserID(allUsers[link.HeadUUID], cfg.UserID)
629 return remoteGroups, groupNameToUUID, err
631 membersSet[memberID] = u2gLinkSet[link.HeadUUID]
633 remoteGroups[group.UUID] = &GroupInfo{
635 PreviousMembers: membersSet,
636 CurrentMembers: make(map[string]GroupPermissions),
638 groupNameToUUID[group.Name] = group.UUID
640 return remoteGroups, groupNameToUUID, nil
643 // RemoveMemberLinksFromGroup remove all links related to the membership
644 func RemoveMemberLinksFromGroup(cfg *ConfigParams, user arvados.User, linkNames []string, completeRemoval bool, group arvados.Group) error {
646 log.Printf("Getting group membership links for user %q (%s) on group %q (%s)", user.Username, user.UUID, group.Name, group.UUID)
648 var links []interface{}
649 var filters [][]arvados.Filter
651 // Search for all group<->user links (both ways)
652 filters = [][]arvados.Filter{
657 Operand: "permission",
671 Operand: "permission",
683 // Search only for the requested Group <- User permission links
684 filters = [][]arvados.Filter{
688 Operand: "permission",
705 for _, filterset := range filters {
706 l, err := GetAll(cfg.Client, "links", arvados.ResourceListParams{Filters: filterset}, &LinkList{})
708 userID, _ := GetUserID(user, cfg.UserID)
709 return fmt.Errorf("error getting links needed to remove user %q from group %q: %s", userID, group.Name, err)
711 for _, link := range l {
712 links = append(links, link)
715 for _, item := range links {
716 link := item.(arvados.Link)
717 userID, _ := GetUserID(user, cfg.UserID)
719 log.Printf("Removing %q permission link for %q on group %q", link.Name, userID, group.Name)
721 if err := DeleteLink(cfg, link.UUID); err != nil {
722 return fmt.Errorf("error removing user %q from group %q: %s", userID, group.Name, err)
728 // AddMemberToGroup create membership links
729 func AddMemberToGroup(cfg *ConfigParams, user arvados.User, group arvados.Group, perm string, createG2ULink bool) error {
730 var newLink arvados.Link
731 var linkData map[string]string
733 linkData = map[string]string{
734 "owner_uuid": cfg.SysUserUUID,
735 "link_class": "permission",
737 "tail_uuid": group.UUID,
738 "head_uuid": user.UUID,
740 if err := CreateLink(cfg, &newLink, linkData); err != nil {
741 userID, _ := GetUserID(user, cfg.UserID)
742 return fmt.Errorf("error adding group %q -> user %q read permission: %s", group.Name, userID, err)
745 linkData = map[string]string{
746 "owner_uuid": cfg.SysUserUUID,
747 "link_class": "permission",
749 "tail_uuid": user.UUID,
750 "head_uuid": group.UUID,
752 if err := CreateLink(cfg, &newLink, linkData); err != nil {
753 userID, _ := GetUserID(user, cfg.UserID)
754 return fmt.Errorf("error adding user %q -> group %q %s permission: %s", userID, group.Name, perm, err)
759 // CreateGroup creates a group with groupData parameters, assigns it to dst
760 func CreateGroup(cfg *ConfigParams, dst *arvados.Group, groupData map[string]string) error {
761 return cfg.Client.RequestAndDecode(dst, "POST", "/arvados/v1/groups", jsonReader("group", groupData), nil)
764 // GetGroup fetches a group by its UUID
765 func GetGroup(cfg *ConfigParams, dst *arvados.Group, groupUUID string) error {
766 return cfg.Client.RequestAndDecode(&dst, "GET", "/arvados/v1/groups/"+groupUUID, nil, nil)
769 // CreateLink creates a link with linkData parameters, assigns it to dst
770 func CreateLink(cfg *ConfigParams, dst *arvados.Link, linkData map[string]string) error {
771 return cfg.Client.RequestAndDecode(dst, "POST", "/arvados/v1/links", jsonReader("link", linkData), nil)
774 // DeleteLink deletes a link by its UUID
775 func DeleteLink(cfg *ConfigParams, linkUUID string) error {
777 return fmt.Errorf("cannot delete link with invalid UUID: %q", linkUUID)
779 return cfg.Client.RequestAndDecode(&arvados.Link{}, "DELETE", "/arvados/v1/links/"+linkUUID, nil, nil)
782 // GetResourceList fetches res list using params
783 func GetResourceList(c *arvados.Client, dst *resourceList, res string, params interface{}) error {
784 return c.RequestAndDecode(dst, "GET", "/arvados/v1/"+res, nil, params)