Skip to content

Commit

Permalink
Add edit, enable, and disable to mc idp ldap accesskey (#5033)
Browse files Browse the repository at this point in the history
  • Loading branch information
taran-p authored Sep 5, 2024
1 parent ba97441 commit 54268c4
Show file tree
Hide file tree
Showing 7 changed files with 322 additions and 22 deletions.
3 changes: 3 additions & 0 deletions cmd/auto-complete.go
Original file line number Diff line number Diff line change
Expand Up @@ -388,6 +388,9 @@ var completeCmds = map[string]complete.Predictor{
"/idp/ldap/accesskey/remove": aliasCompleter,
"/idp/ldap/accesskey/rm": aliasCompleter,
"/idp/ldap/accesskey/info": aliasCompleter,
"/idp/ldap/accesskey/edit": aliasCompleter,
"/idp/ldap/accesskey/enable": aliasCompleter,
"/idp/ldap/accesskey/disable": aliasCompleter,

"/admin/policy/info": aliasCompleter,
"/admin/policy/update": aliasCompleter,
Expand Down
48 changes: 48 additions & 0 deletions cmd/idp-ldap-accesskey-disable.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
// Copyright (c) 2015-2024 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

package cmd

import (
"github.com/minio/cli"
)

var idpLdapAccesskeyDisableCmd = cli.Command{
Name: "disable",
Usage: "disable an access key",
Action: mainIDPLdapAccesskeyDisable,
Before: setGlobalsFromContext,
Flags: globalFlags,
OnUsageError: onUsageError,
CustomHelpTemplate: `NAME:
{{.HelpName}} - {{.Usage}}
USAGE:
{{.HelpName}} [FLAGS] [TARGET]
FLAGS:
{{range .VisibleFlags}}{{.}}
{{end}}
EXAMPLES:
1. Disable LDAP access key
{{.Prompt}} {{.HelpName}} myminio myaccesskey
`,
}

func mainIDPLdapAccesskeyDisable(ctx *cli.Context) error {
return enableDisableAccesskey(ctx, false)
}
167 changes: 167 additions & 0 deletions cmd/idp-ldap-accesskey-edit.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
// Copyright (c) 2015-2024 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

package cmd

import (
"bytes"
"errors"
"fmt"
"os"
"time"

"github.com/minio/cli"
"github.com/minio/madmin-go/v3"
"github.com/minio/mc/pkg/probe"
"github.com/minio/pkg/v3/policy"
)

var idpLdapAccesskeyEditFlags = []cli.Flag{
cli.StringFlag{
Name: "secret-key",
Usage: "set a secret key for the account",
},
cli.StringFlag{
Name: "policy",
Usage: "path to a JSON policy file",
},
cli.StringFlag{
Name: "name",
Usage: "friendly name for the account",
},
cli.StringFlag{
Name: "description",
Usage: "description for the account",
},
cli.StringFlag{
Name: "expiry-duration",
Usage: "duration before the access key expires",
},
cli.StringFlag{
Name: "expiry",
Usage: "expiry date for the access key",
},
}

var idpLdapAccesskeyEditCmd = cli.Command{
Name: "edit",
Usage: "edit existing access keys for LDAP",
Action: mainIDPLdapAccesskeyEdit,
Before: setGlobalsFromContext,
Flags: append(idpLdapAccesskeyEditFlags, globalFlags...),
OnUsageError: onUsageError,
CustomHelpTemplate: `NAME:
{{.HelpName}} - {{.Usage}}
USAGE:
{{.HelpName}} [FLAGS] [TARGET]
FLAGS:
{{range .VisibleFlags}}{{.}}
{{end}}
EXAMPLES:
1. Change the secret key for the access key "testkey"
{{.Prompt}} {{.HelpName}} myminio/ testkey --secret-key 'xxxxxxx'
2. Change the expiry duration for the access key "testkey"
{{.Prompt}} {{.HelpName}} myminio/ testkey ---expiry-duration 24h
`,
}

func mainIDPLdapAccesskeyEdit(ctx *cli.Context) error {
if len(ctx.Args()) == 0 || len(ctx.Args()) > 2 {
showCommandHelpAndExit(ctx, 1) // last argument is exit code
}

args := ctx.Args()
aliasedURL := args.Get(0)
accessKey := args.Get(1)

opts := accessKeyEditOpts(ctx)
client, err := newAdminClient(aliasedURL)
fatalIf(err, "Unable to initialize admin connection.")

e := client.UpdateServiceAccount(globalContext, accessKey, opts)
fatalIf(probe.NewError(e), "Unable to edit service account.")

m := ldapAccesskeyMessage{
op: "edit",
Status: "success",
AccessKey: accessKey,
}
printMsg(m)

return nil
}

func accessKeyEditOpts(ctx *cli.Context) madmin.UpdateServiceAccountReq {
name := ctx.String("name")
expVal := ctx.String("expiry")
policyPath := ctx.String("policy")
secretKey := ctx.String("secret-key")
description := ctx.String("description")
expDurVal := ctx.Duration("expiry-duration")

if expVal != "" && expDurVal != 0 {
fatalIf(probe.NewError(errors.New("Only one of --expiry or --expiry-duration can be specified")), "invalid flags")
}

opts := madmin.UpdateServiceAccountReq{
NewName: name,
NewSecretKey: secretKey,
NewDescription: description,
}

if policyPath != "" {
// Validate the policy document and ensure it has at least one statement
policyBytes, e := os.ReadFile(policyPath)
fatalIf(probe.NewError(e), "unable to read the policy document")

p, e := policy.ParseConfig(bytes.NewReader(policyBytes))
fatalIf(probe.NewError(e), "unable to parse the policy document")

if p.IsEmpty() {
fatalIf(errInvalidArgument(), "empty policies are not allowed")
}

opts.NewPolicy = policyBytes
}

switch {
case expVal != "":
location, e := time.LoadLocation("Local")
fatalIf(probe.NewError(e), "unable to load local location. verify your local TZ=<val> settings")

var found bool
for _, format := range supportedTimeFormats {
t, e := time.ParseInLocation(format, expVal, location)
if e == nil {
found = true
opts.NewExpiration = &t
break
}
}

if !found {
fatalIf(probe.NewError(fmt.Errorf("invalid expiry date format '%s'", expVal)), "unable to parse the expiry argument")
}
case expDurVal != 0:
t := time.Now().Add(expDurVal)
opts.NewExpiration = &t
}

return opts
}
84 changes: 84 additions & 0 deletions cmd/idp-ldap-accesskey-enable.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
// Copyright (c) 2015-2024 MinIO, Inc.
//
// This file is part of MinIO Object Storage stack
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

package cmd

import (
"github.com/minio/cli"
"github.com/minio/madmin-go/v3"
"github.com/minio/mc/pkg/probe"
)

var idpLdapAccesskeyEnableCmd = cli.Command{
Name: "enable",
Usage: "enable an access key",
Action: mainIDPLdapAccesskeyEnable,
Before: setGlobalsFromContext,
Flags: globalFlags,
OnUsageError: onUsageError,
CustomHelpTemplate: `NAME:
{{.HelpName}} - {{.Usage}}
USAGE:
{{.HelpName}} [FLAGS] [TARGET]
FLAGS:
{{range .VisibleFlags}}{{.}}
{{end}}
EXAMPLES:
1. Enable LDAP access key
{{.Prompt}} {{.HelpName}} myminio myaccesskey
`,
}

func mainIDPLdapAccesskeyEnable(ctx *cli.Context) error {
return enableDisableAccesskey(ctx, true)
}

func enableDisableAccesskey(ctx *cli.Context, enable bool) error {
if len(ctx.Args()) == 0 || len(ctx.Args()) > 2 {
showCommandHelpAndExit(ctx, 1) // last argument is exit code
}

args := ctx.Args()
aliasedURL := args.Get(0)
accessKey := args.Get(1)

client, err := newAdminClient(aliasedURL)
fatalIf(err, "Unable to initialize admin connection.")

op := "disable"
status := "off"
if enable {
op = "enable"
status = "on"
}

e := client.UpdateServiceAccount(globalContext, accessKey, madmin.UpdateServiceAccountReq{
NewStatus: status,
})
fatalIf(probe.NewError(e), "Unable to add service account.")

m := ldapAccesskeyMessage{
op: op,
Status: "success",
AccessKey: accessKey,
}
printMsg(m)

return nil
}
35 changes: 17 additions & 18 deletions cmd/idp-ldap-accesskey-info.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import (
"github.com/minio/cli"
json "github.com/minio/colorjson"
"github.com/minio/mc/pkg/probe"
"github.com/minio/pkg/v3/console"
)

var idpLdapAccesskeyInfoCmd = cli.Command{
Expand Down Expand Up @@ -68,6 +67,8 @@ type ldapAccesskeyMessage struct {
}

func (m ldapAccesskeyMessage) String() string {
labelStyle := lipgloss.NewStyle().Foreground(lipgloss.Color("#04B575")) // green
o := strings.Builder{}
switch m.op {
case "info":
expirationStr := "NONE"
Expand All @@ -78,39 +79,37 @@ func (m ldapAccesskeyMessage) String() string {
if m.ImpliedPolicy {
policyStr = "implied"
}

labelStyle := lipgloss.NewStyle().Foreground(lipgloss.Color("#04B575")) // green
o := strings.Builder{}

statusStr := "enabled"
if m.AccountStatus == "off" {
statusStr = "disabled"
}
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Access Key:"), m.AccessKey))
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Parent User:"), m.ParentUser))
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Status:"), statusStr))
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Policy:"), policyStr))
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Name:"), m.Name))
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Description:"), m.Description))
o.WriteString(iFmt(0, "%s %s\n\n", labelStyle.Render("Expiration:"), expirationStr))

return o.String()

o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Expiration:"), expirationStr))
case "create":
expirationStr := "NONE"
if m.Expiration != nil && !m.Expiration.IsZero() && !m.Expiration.Equal(timeSentinel) {
expirationStr = m.Expiration.String()
}

labelStyle := lipgloss.NewStyle().Foreground(lipgloss.Color("#04B575")) // green
o := strings.Builder{}

o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Access Key:"), m.AccessKey))
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Secret Key:"), m.SecretKey))
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Expiration:"), expirationStr))
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Name:"), m.Name))
o.WriteString(iFmt(0, "%s %s\n\n", labelStyle.Render("Description:"), m.Description))

return o.String()
o.WriteString(iFmt(0, "%s %s\n", labelStyle.Render("Description:"), m.Description))
case "remove":
return console.Colorize("RemoveAccessKey", "Successfully removed access key `"+m.AccessKey+"`.")
o.WriteString(labelStyle.Render(iFmt(0, "Successfully removed access key `%s`.", m.AccessKey)))
case "edit":
o.WriteString(labelStyle.Render(iFmt(0, "Successfully edited access key `%s`.", m.AccessKey)))
case "enable":
o.WriteString(labelStyle.Render(iFmt(0, "Successfully enabled access key `%s`.", m.AccessKey)))
case "disable":
o.WriteString(labelStyle.Render(iFmt(0, "Successfully disabled access key `%s`.", m.AccessKey)))
}
return ""
return o.String()
}

func (m ldapAccesskeyMessage) JSON() string {
Expand Down
Loading

0 comments on commit 54268c4

Please sign in to comment.