github.com/minio/mc@v0.0.0-20240503112107-b471de8d1882/cmd/admin-user-info.go (about)

     1  // Copyright (c) 2015-2022 MinIO, Inc.
     2  //
     3  // This file is part of MinIO Object Storage stack
     4  //
     5  // This program is free software: you can redistribute it and/or modify
     6  // it under the terms of the GNU Affero General Public License as published by
     7  // the Free Software Foundation, either version 3 of the License, or
     8  // (at your option) any later version.
     9  //
    10  // This program is distributed in the hope that it will be useful
    11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    13  // GNU Affero General Public License for more details.
    14  //
    15  // You should have received a copy of the GNU Affero General Public License
    16  // along with this program.  If not, see <http://www.gnu.org/licenses/>.
    17  
    18  package cmd
    19  
    20  import (
    21  	"fmt"
    22  	"strings"
    23  
    24  	"github.com/fatih/color"
    25  	"github.com/minio/cli"
    26  	"github.com/minio/madmin-go/v3"
    27  	"github.com/minio/mc/pkg/probe"
    28  	"github.com/minio/pkg/v2/console"
    29  )
    30  
    31  var adminUserInfoCmd = cli.Command{
    32  	Name:         "info",
    33  	Usage:        "display info of a user",
    34  	Action:       mainAdminUserInfo,
    35  	OnUsageError: onUsageError,
    36  	Before:       setGlobalsFromContext,
    37  	Flags:        globalFlags,
    38  	CustomHelpTemplate: `NAME:
    39    {{.HelpName}} - {{.Usage}}
    40  
    41  USAGE:
    42    {{.HelpName}} TARGET USERNAME
    43  
    44  FLAGS:
    45    {{range .VisibleFlags}}{{.}}
    46    {{end}}
    47  EXAMPLES:
    48    1. Display the info of a user "foobar".
    49       {{.Prompt}} {{.HelpName}} myminio foobar
    50  `,
    51  }
    52  
    53  // checkAdminUserAddSyntax - validate all the passed arguments
    54  func checkAdminUserInfoSyntax(ctx *cli.Context) {
    55  	if len(ctx.Args()) != 2 {
    56  		showCommandHelpAndExit(ctx, 1) // last argument is exit code
    57  	}
    58  }
    59  
    60  // mainAdminUserInfo is the handler for "mc admin user info" command.
    61  func mainAdminUserInfo(ctx *cli.Context) error {
    62  	checkAdminUserInfoSyntax(ctx)
    63  
    64  	console.SetColor("UserMessage", color.New(color.FgGreen))
    65  
    66  	// Get the alias parameter from cli
    67  	args := ctx.Args()
    68  	aliasedURL := args.Get(0)
    69  
    70  	// Create a new MinIO Admin Client
    71  	client, err := newAdminClient(aliasedURL)
    72  	fatalIf(err, "Unable to initialize admin connection.")
    73  
    74  	user, e := client.GetUserInfo(globalContext, args.Get(1))
    75  	fatalIf(probe.NewError(e).Trace(args...), "Unable to get user info")
    76  
    77  	memberOf := []userGroup{}
    78  	for _, group := range user.MemberOf {
    79  		gd, e := client.GetGroupDescription(globalContext, group)
    80  		fatalIf(probe.NewError(e).Trace(args...), "Unable to fetch group info")
    81  		policies := []string{}
    82  		if gd.Policy != "" {
    83  			policies = strings.Split(gd.Policy, ",")
    84  		}
    85  		memberOf = append(memberOf, userGroup{
    86  			Name:     gd.Name,
    87  			Policies: policies,
    88  		})
    89  	}
    90  
    91  	printMsg(userMessage{
    92  		op:             ctx.Command.Name,
    93  		AccessKey:      args.Get(1),
    94  		PolicyName:     user.PolicyName,
    95  		UserStatus:     string(user.Status),
    96  		MemberOf:       memberOf,
    97  		Authentication: authInfoToUserMessage(user.AuthInfo),
    98  	})
    99  
   100  	return nil
   101  }
   102  
   103  func authInfoToUserMessage(a *madmin.UserAuthInfo) string {
   104  	if a == nil {
   105  		return ""
   106  	}
   107  
   108  	authServer := ""
   109  	if a.Type != madmin.BuiltinUserAuthType {
   110  		authServer = "/" + a.AuthServer
   111  	}
   112  
   113  	return fmt.Sprintf("%s%s (%s)", a.Type, authServer, a.AuthServerUserID)
   114  }