1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496
|
//
// 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 madmin
import (
"context"
"encoding/json"
"net/http"
"net/url"
"time"
)
// KMSStatus contains various informations about
// the KMS connected to a MinIO server - like
// the KMS endpoints and the default key ID.
type KMSStatus struct {
Name string `json:"name"` // Name or type of the KMS
DefaultKeyID string `json:"default-key-id"` // The key ID used when no explicit key is specified
Endpoints map[string]ItemState `json:"endpoints"` // List of KMS endpoints and their status (online/offline)
State KMSState `json:"state"` // Current KMS server state
}
// KMSState is a KES server status snapshot.
type KMSState struct {
Version string
KeyStoreLatency time.Duration
KeyStoreReachable bool
KeystoreAvailable bool
OS string
Arch string
UpTime time.Duration
CPUs int
UsableCPUs int
HeapAlloc uint64
StackAlloc uint64
}
// KMSKeyInfo contains key metadata
type KMSKeyInfo struct {
CreatedAt time.Time `json:"createdAt"`
CreatedBy string `json:"createdBy"`
Name string `json:"name"`
}
// KMSPolicyInfo contains policy metadata
type KMSPolicyInfo struct {
CreatedAt time.Time `json:"created_at"`
CreatedBy string `json:"created_by"`
Name string `json:"name"`
}
// KMSIdentityInfo contains policy metadata
type KMSIdentityInfo struct {
CreatedAt time.Time `json:"createdAt"`
CreatedBy string `json:"createdBy"`
Identity string `json:"identity"`
Policy string `json:"policy"`
Error string `json:"error"`
}
// KMSDescribePolicy contains policy metadata
type KMSDescribePolicy struct {
Name string `json:"name"`
CreatedAt time.Time `json:"created_at"`
CreatedBy string `json:"created_by"`
}
// KMSPolicy represents a KMS policy
type KMSPolicy struct {
Allow []string `json:"allow"`
Deny []string `json:"deny"`
}
// KMSDescribeIdentity contains identity metadata
type KMSDescribeIdentity struct {
Policy string `json:"policy"`
Identity string `json:"identity"`
IsAdmin bool `json:"isAdmin"`
CreatedAt time.Time `json:"createdAt"`
CreatedBy string `json:"createdBy"`
}
// KMSDescribeSelfIdentity describes the identity issuing the request
type KMSDescribeSelfIdentity struct {
Policy *KMSPolicy `json:"policy"`
PolicyName string `json:"policyName"`
Identity string `json:"identity"`
IsAdmin bool `json:"isAdmin"`
CreatedAt string `json:"createdAt"`
CreatedBy string `json:"createdBy"`
}
type KMSMetrics struct {
RequestOK int64 `json:"kes_http_request_success"`
RequestErr int64 `json:"kes_http_request_error"`
RequestFail int64 `json:"kes_http_request_failure"`
RequestActive int64 `json:"kes_http_request_active"`
AuditEvents int64 `json:"kes_log_audit_events"`
ErrorEvents int64 `json:"kes_log_error_events"`
LatencyHistogram map[int64]int64 `json:"kes_http_response_time"`
UpTime int64 `json:"kes_system_up_time"`
CPUs int64 `json:"kes_system_num_cpu"`
UsableCPUs int64 `json:"kes_system_num_cpu_used"`
Threads int64 `json:"kes_system_num_threads"`
HeapAlloc int64 `json:"kes_system_mem_heap_used"`
HeapObjects int64 `json:"kes_system_mem_heap_objects"`
StackAlloc int64 `json:"kes_system_mem_stack_used"`
}
type KMSAPI struct {
Method string
Path string
MaxBody int64
Timeout int64
}
type KMSVersion struct {
Version string `json:"version"`
}
// KMSStatus returns status information about the KMS connected
// to the MinIO server, if configured.
func (adm *AdminClient) KMSStatus(ctx context.Context) (KMSStatus, error) {
// GET /minio/kms/v1/status
resp, err := adm.doKMSRequest(ctx, "/status", http.MethodGet, nil, map[string]string{})
if err != nil {
return KMSStatus{}, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return KMSStatus{}, httpRespToErrorResponse(resp)
}
var status KMSStatus
if err = json.NewDecoder(resp.Body).Decode(&status); err != nil {
return KMSStatus{}, err
}
return status, nil
}
// KMSMetrics returns metrics about the KMS connected
// to the MinIO server, if configured.
func (adm *AdminClient) KMSMetrics(ctx context.Context) (*KMSMetrics, error) {
// GET /minio/kms/v1/metrics
resp, err := adm.doKMSRequest(ctx, "/metrics", http.MethodGet, nil, map[string]string{})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var metrics KMSMetrics
if err = json.NewDecoder(resp.Body).Decode(&metrics); err != nil {
return nil, err
}
return &metrics, nil
}
// KMSAPIs returns a list of supported API endpoints in the KMS connected
// to the MinIO server, if configured.
func (adm *AdminClient) KMSAPIs(ctx context.Context) ([]KMSAPI, error) {
// GET /minio/kms/v1/apis
resp, err := adm.doKMSRequest(ctx, "/apis", http.MethodGet, nil, map[string]string{})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var apis []KMSAPI
if err = json.NewDecoder(resp.Body).Decode(&apis); err != nil {
return nil, err
}
return apis, nil
}
// KMSVersion returns a list of supported API endpoints in the KMS connected
// to the MinIO server, if configured.
func (adm *AdminClient) KMSVersion(ctx context.Context) (*KMSVersion, error) {
// GET /minio/kms/v1/version
resp, err := adm.doKMSRequest(ctx, "/version", http.MethodGet, nil, map[string]string{})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var version KMSVersion
if err = json.NewDecoder(resp.Body).Decode(&version); err != nil {
return nil, err
}
return &version, nil
}
// CreateKey tries to create a new master key with the given keyID
// at the KMS connected to a MinIO server.
func (adm *AdminClient) CreateKey(ctx context.Context, keyID string) error {
// POST /minio/kms/v1/key/create?key-id=<keyID>
resp, err := adm.doKMSRequest(ctx, "/key/create", http.MethodPost, nil, map[string]string{"key-id": keyID})
if err != nil {
return err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return httpRespToErrorResponse(resp)
}
return nil
}
// DeleteKey tries to delete a key with the given keyID
// at the KMS connected to a MinIO server.
func (adm *AdminClient) DeleteKey(ctx context.Context, keyID string) error {
// DELETE /minio/kms/v1/key/delete?key-id=<keyID>
resp, err := adm.doKMSRequest(ctx, "/key/delete", http.MethodDelete, nil, map[string]string{"key-id": keyID})
if err != nil {
return err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return httpRespToErrorResponse(resp)
}
return nil
}
// ImportKey tries to import a cryptographic key
// at the KMS connected to a MinIO server.
func (adm *AdminClient) ImportKey(ctx context.Context, keyID string, content []byte) error {
// POST /minio/kms/v1/key/import?key-id=<keyID>
resp, err := adm.doKMSRequest(ctx, "/key/import", http.MethodPost, content, map[string]string{"key-id": keyID})
if err != nil {
return err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return httpRespToErrorResponse(resp)
}
return nil
}
// ListKeys tries to get all key names that match the specified pattern
func (adm *AdminClient) ListKeys(ctx context.Context, pattern string) ([]KMSKeyInfo, error) {
// GET /minio/kms/v1/key/list?pattern=<pattern>
resp, err := adm.doKMSRequest(ctx, "/key/list", http.MethodGet, nil, map[string]string{"pattern": pattern})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var results []KMSKeyInfo
if err = json.NewDecoder(resp.Body).Decode(&results); err != nil {
return nil, err
}
return results, nil
}
// GetKeyStatus requests status information about the key referenced by keyID
// from the KMS connected to a MinIO by performing a Admin-API request.
// It basically hits the `/minio/admin/v3/kms/key/status` API endpoint.
func (adm *AdminClient) GetKeyStatus(ctx context.Context, keyID string) (*KMSKeyStatus, error) {
// GET /minio/kms/v1/key/status?key-id=<keyID>
resp, err := adm.doKMSRequest(ctx, "/key/status", http.MethodGet, nil, map[string]string{"key-id": keyID})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var keyInfo KMSKeyStatus
if err = json.NewDecoder(resp.Body).Decode(&keyInfo); err != nil {
return nil, err
}
return &keyInfo, nil
}
// KMSKeyStatus contains some status information about a KMS master key.
// The MinIO server tries to access the KMS and perform encryption and
// decryption operations. If the MinIO server can access the KMS and
// all master key operations succeed it returns a status containing only
// the master key ID but no error.
type KMSKeyStatus struct {
KeyID string `json:"key-id"`
EncryptionErr string `json:"encryption-error,omitempty"` // An empty error == success
DecryptionErr string `json:"decryption-error,omitempty"` // An empty error == success
}
// SetKMSPolicy tries to create or update a policy
// at the KMS connected to a MinIO server.
func (adm *AdminClient) SetKMSPolicy(ctx context.Context, policy string, content []byte) error {
// POST /minio/kms/v1/policy/set?policy=<policy>
resp, err := adm.doKMSRequest(ctx, "/policy/set", http.MethodPost, content, map[string]string{"policy": policy})
if err != nil {
return err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return httpRespToErrorResponse(resp)
}
return nil
}
// AssignPolicy tries to assign a policy to an identity
// at the KMS connected to a MinIO server.
func (adm *AdminClient) AssignPolicy(ctx context.Context, policy string, content []byte) error {
// POST /minio/kms/v1/policy/assign?policy=<policy>
resp, err := adm.doKMSRequest(ctx, "/policy/assign", http.MethodPost, content, map[string]string{"policy": policy})
if err != nil {
return err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return httpRespToErrorResponse(resp)
}
return nil
}
// DescribePolicy tries to describe a KMS policy
func (adm *AdminClient) DescribePolicy(ctx context.Context, policy string) (*KMSDescribePolicy, error) {
// GET /minio/kms/v1/policy/describe?policy=<policy>
resp, err := adm.doKMSRequest(ctx, "/policy/describe", http.MethodGet, nil, map[string]string{"policy": policy})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var dp KMSDescribePolicy
if err = json.NewDecoder(resp.Body).Decode(&dp); err != nil {
return nil, err
}
return &dp, nil
}
// GetPolicy tries to get a KMS policy
func (adm *AdminClient) GetPolicy(ctx context.Context, policy string) (*KMSPolicy, error) {
// GET /minio/kms/v1/policy/get?policy=<policy>
resp, err := adm.doKMSRequest(ctx, "/policy/get", http.MethodGet, nil, map[string]string{"policy": policy})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var p KMSPolicy
if err = json.NewDecoder(resp.Body).Decode(&p); err != nil {
return nil, err
}
return &p, nil
}
// ListPolicies tries to get all policies that match the specified pattern
func (adm *AdminClient) ListPolicies(ctx context.Context, pattern string) ([]KMSPolicyInfo, error) {
// GET /minio/kms/v1/policy/list?pattern=<pattern>
resp, err := adm.doKMSRequest(ctx, "/policy/list", http.MethodGet, nil, map[string]string{"pattern": pattern})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var results []KMSPolicyInfo
if err = json.NewDecoder(resp.Body).Decode(&results); err != nil {
return nil, err
}
return results, nil
}
// DeletePolicy tries to delete a policy
// at the KMS connected to a MinIO server.
func (adm *AdminClient) DeletePolicy(ctx context.Context, policy string) error {
// DELETE /minio/kms/v1/policy/delete?policy=<policy>
resp, err := adm.doKMSRequest(ctx, "/policy/delete", http.MethodDelete, nil, map[string]string{"policy": policy})
if err != nil {
return err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return httpRespToErrorResponse(resp)
}
return nil
}
// DescribeIdentity tries to describe a KMS identity
func (adm *AdminClient) DescribeIdentity(ctx context.Context, identity string) (*KMSDescribeIdentity, error) {
// GET /minio/kms/v1/identity/describe?identity=<identity>
resp, err := adm.doKMSRequest(ctx, "/identity/describe", http.MethodGet, nil, map[string]string{"identity": identity})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var i KMSDescribeIdentity
if err = json.NewDecoder(resp.Body).Decode(&i); err != nil {
return nil, err
}
return &i, nil
}
// DescribeSelfIdentity tries to describe the identity issuing the request.
func (adm *AdminClient) DescribeSelfIdentity(ctx context.Context) (*KMSDescribeSelfIdentity, error) {
// GET /minio/kms/v1/identity/describe-self
resp, err := adm.doKMSRequest(ctx, "/identity/describe-self", http.MethodGet, nil, map[string]string{})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var si KMSDescribeSelfIdentity
if err = json.NewDecoder(resp.Body).Decode(&si); err != nil {
return nil, err
}
return &si, nil
}
// ListIdentities tries to get all identities that match the specified pattern
func (adm *AdminClient) ListIdentities(ctx context.Context, pattern string) ([]KMSIdentityInfo, error) {
// GET /minio/kms/v1/identity/list?pattern=<pattern>
if pattern == "" { // list identities does not default to *
pattern = "*"
}
resp, err := adm.doKMSRequest(ctx, "/identity/list", http.MethodGet, nil, map[string]string{"pattern": pattern})
if err != nil {
return nil, err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return nil, httpRespToErrorResponse(resp)
}
var results []KMSIdentityInfo
if err = json.NewDecoder(resp.Body).Decode(&results); err != nil {
return nil, err
}
return results, nil
}
// DeleteIdentity tries to delete a identity
// at the KMS connected to a MinIO server.
func (adm *AdminClient) DeleteIdentity(ctx context.Context, identity string) error {
// DELETE /minio/kms/v1/identity/delete?identity=<identity>
resp, err := adm.doKMSRequest(ctx, "/identity/delete", http.MethodDelete, nil, map[string]string{"identity": identity})
if err != nil {
return err
}
defer closeResponse(resp)
if resp.StatusCode != http.StatusOK {
return httpRespToErrorResponse(resp)
}
return nil
}
func (adm *AdminClient) doKMSRequest(ctx context.Context, path, method string, content []byte, values map[string]string) (*http.Response, error) {
qv := url.Values{}
for key, value := range values {
qv.Set(key, value)
}
reqData := requestData{
relPath: kmsAPIPrefix + path,
queryValues: qv,
isKMS: true,
content: content,
}
return adm.executeMethod(ctx, method, reqData)
}
|