KMS Admin-API: add route and handler for KMS key info (#7955)
This commit adds an admin API route and handler for requesting status information about a KMS key. Therefore, the client specifies the KMS key ID (when empty / not set the server takes the currently configured default key-ID) and the server tries to perform a dummy encryption, re-wrap and decryption operation. If all three succeed we know that the server can access the KMS and has permissions to generate, re-wrap and decrypt data keys (policy is set correctly).master
Andreas Auernhammer
6 years ago
committed by
kannappanr
parent
341d61e3d8
commit
810a44e951
@ -0,0 +1,60 @@ |
|||||||
|
// +build ignore
|
||||||
|
|
||||||
|
/* |
||||||
|
* MinIO Cloud Storage, (C) 2019 MinIO, Inc. |
||||||
|
* |
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||||
|
* you may not use this file except in compliance with the License. |
||||||
|
* You may obtain a copy of the License at |
||||||
|
* |
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
* |
||||||
|
* Unless required by applicable law or agreed to in writing, software |
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, |
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||||
|
* See the License for the specific language governing permissions and |
||||||
|
* limitations under the License. |
||||||
|
* |
||||||
|
*/ |
||||||
|
|
||||||
|
package main |
||||||
|
|
||||||
|
import ( |
||||||
|
"log" |
||||||
|
|
||||||
|
"github.com/minio/minio/pkg/madmin" |
||||||
|
) |
||||||
|
|
||||||
|
func main() { |
||||||
|
// Note: YOUR-ACCESSKEYID, YOUR-SECRETACCESSKEY and my-bucketname are
|
||||||
|
// dummy values, please replace them with original values.
|
||||||
|
|
||||||
|
// API requests are secure (HTTPS) if secure=true and insecure (HTTP) otherwise.
|
||||||
|
// New returns an MinIO Admin client object.
|
||||||
|
madmClnt, err := madmin.New("your-minio.example.com:9000", "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", true) |
||||||
|
if err != nil { |
||||||
|
log.Fatalln(err) |
||||||
|
} |
||||||
|
|
||||||
|
status, err := madmClnt.GetKeyStatus("") // empty string refers to the default master key
|
||||||
|
if err != nil { |
||||||
|
log.Fatalln(err) |
||||||
|
} |
||||||
|
|
||||||
|
log.Printf("Key: %s\n", status.KeyID) |
||||||
|
if status.EncryptionErr == "" { |
||||||
|
log.Println("\t • Encryption ✔") |
||||||
|
} else { |
||||||
|
log.Printf("\t • Encryption failed: %s\n", status.EncryptionErr) |
||||||
|
} |
||||||
|
if status.UpdateErr == "" { |
||||||
|
log.Println("\t • Re-wrap ✔") |
||||||
|
} else { |
||||||
|
log.Printf("\t • Re-wrap failed: %s\n", status.UpdateErr) |
||||||
|
} |
||||||
|
if status.DecryptionErr == "" { |
||||||
|
log.Println("\t • Decryption ✔") |
||||||
|
} else { |
||||||
|
log.Printf("\t • Decryption failed: %s\n", status.DecryptionErr) |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,62 @@ |
|||||||
|
/* |
||||||
|
* MinIO Cloud Storage, (C) 2019 MinIO, Inc. |
||||||
|
* |
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); |
||||||
|
* you may not use this file except in compliance with the License. |
||||||
|
* You may obtain a copy of the License at |
||||||
|
* |
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
* |
||||||
|
* Unless required by applicable law or agreed to in writing, software |
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS, |
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
||||||
|
* See the License for the specific language governing permissions and |
||||||
|
* limitations under the License. |
||||||
|
*/ |
||||||
|
|
||||||
|
package madmin |
||||||
|
|
||||||
|
import ( |
||||||
|
"encoding/json" |
||||||
|
"net/http" |
||||||
|
"net/url" |
||||||
|
) |
||||||
|
|
||||||
|
// 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/v1/kms/key/status` API endpoint.
|
||||||
|
func (adm *AdminClient) GetKeyStatus(keyID string) (*KMSKeyStatus, error) { |
||||||
|
// GET /minio/admin/v1/kms/key/status?key-id=<keyID>
|
||||||
|
qv := url.Values{} |
||||||
|
qv.Set("key-id", keyID) |
||||||
|
reqData := requestData{ |
||||||
|
relPath: "/v1/kms/key/status", |
||||||
|
queryValues: qv, |
||||||
|
} |
||||||
|
|
||||||
|
resp, err := adm.executeMethod("GET", reqData) |
||||||
|
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
|
||||||
|
UpdateErr string `json:"update-error,omitempty"` // An empty error == success
|
||||||
|
DecryptionErr string `json:"decryption-error,omitempty"` // An empty error == success
|
||||||
|
} |
||||||
Loading…
Reference in new issue