1
0
mirror of https://github.com/minio/mc.git synced 2025-11-10 13:42:32 +03:00
Files
mc/cmd/admin-kms-key-status.go
2022-11-01 08:04:26 -07:00

118 lines
3.5 KiB
Go

// Copyright (c) 2015-2021 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 (
"fmt"
"github.com/fatih/color"
"github.com/minio/cli"
json "github.com/minio/colorjson"
"github.com/minio/mc/pkg/probe"
"github.com/minio/pkg/console"
)
var adminKMSKeyStatusCmd = cli.Command{
Name: "status",
Usage: "request status information for a KMS master key",
Action: mainAdminKMSKeyStatus,
OnUsageError: onUsageError,
Before: setGlobalsFromContext,
Flags: globalFlags,
CustomHelpTemplate: `NAME:
{{.HelpName}} - {{.Usage}}
USAGE:
{{.HelpName}} TARGET [KEY_NAME]
FLAGS:
{{range .VisibleFlags}}{{.}}
{{end}}
EXAMPLES:
1. Get default master key and its status from a MinIO server/cluster.
$ {{.HelpName}} play
2. Get the status of one particular master key from a MinIO server/cluster.
$ {{.HelpName}} play my-master-key
`,
}
// adminKMSKeyCmd is the handle for the "mc admin kms key" command.
func mainAdminKMSKeyStatus(ctx *cli.Context) error {
if len(ctx.Args()) == 0 || len(ctx.Args()) > 2 {
showCommandHelpAndExit(ctx, 1) // last argument is exit code
}
console.SetColor("StatusSuccess", color.New(color.FgGreen, color.Bold))
console.SetColor("StatusError", color.New(color.FgRed, color.Bold))
client, err := newAdminClient(ctx.Args().Get(0))
fatalIf(err, "Unable to get a configured admin connection.")
var keyID string
if len(ctx.Args()) == 2 {
keyID = ctx.Args().Get(1)
}
status, e := client.GetKeyStatus(globalContext, keyID)
fatalIf(probe.NewError(e), "Failed to get status information")
printMsg(kmsKeyStatusMsg{
KeyID: status.KeyID,
Encryption: status.EncryptionErr == "",
Decryption: status.DecryptionErr == "",
EncryptionErr: status.EncryptionErr,
DecryptionErr: status.DecryptionErr,
})
return nil
}
type kmsKeyStatusMsg struct {
KeyID string `json:"keyId"`
Encryption bool `json:"encryption"`
Decryption bool `json:"decryption"`
EncryptionErr string `json:"encryptionError,omitempty"`
DecryptionErr string `json:"decryptionError,omitempty"`
Status string `json:"status"`
}
func (s kmsKeyStatusMsg) JSON() string {
s.Status = "success"
if !s.Encryption && !s.Decryption {
s.Status = "error"
}
kmsBytes, e := json.MarshalIndent(s, "", " ")
fatalIf(probe.NewError(e), "Unable to marshal into JSON.")
return string(kmsBytes)
}
func (s kmsKeyStatusMsg) String() string {
msg := fmt.Sprintf("Key: %s\n", s.KeyID)
if s.Encryption {
msg += " - Encryption " + console.Colorize("StatusSuccess", "✔") + "\n"
} else {
msg += fmt.Sprintf(" - Encryption %s (%s)\n", console.Colorize("StatusError", "✗"), s.EncryptionErr)
}
if s.Decryption {
msg += " - Decryption " + console.Colorize("StatusSuccess", "✔") + "\n"
} else {
msg += fmt.Sprintf(" - Decryption %s (%s)\n", console.Colorize("StatusError", "✗"), s.DecryptionErr)
}
return msg
}