2019-10-23 07:59:13 +02:00
|
|
|
/*
|
|
|
|
* 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 crypto
|
|
|
|
|
|
|
|
import "github.com/minio/minio/cmd/config"
|
|
|
|
|
|
|
|
// Help template for KMS vault
|
|
|
|
var (
|
2019-11-19 22:48:13 +01:00
|
|
|
Help = config.HelpKVS{
|
|
|
|
config.HelpKV{
|
|
|
|
Key: KMSVaultEndpoint,
|
2019-12-05 00:32:37 +01:00
|
|
|
Description: `HashiCorp Vault API endpoint e.g. "http://vault-endpoint-ip:8200"`,
|
2019-11-19 22:48:13 +01:00
|
|
|
Type: "url",
|
|
|
|
},
|
|
|
|
config.HelpKV{
|
|
|
|
Key: KMSVaultKeyName,
|
2019-12-05 00:32:37 +01:00
|
|
|
Description: `transit key name used in vault policy, must be unique name e.g. "my-minio-key"`,
|
2019-11-19 22:48:13 +01:00
|
|
|
Type: "string",
|
|
|
|
},
|
|
|
|
config.HelpKV{
|
|
|
|
Key: KMSVaultAuthType,
|
2019-12-05 00:32:37 +01:00
|
|
|
Description: `authentication type to Vault API endpoint e.g. "approle"`,
|
2019-11-19 22:48:13 +01:00
|
|
|
Type: "string",
|
|
|
|
},
|
|
|
|
config.HelpKV{
|
|
|
|
Key: KMSVaultAppRoleID,
|
2019-12-05 00:32:37 +01:00
|
|
|
Description: `unique role ID created for AppRole`,
|
2019-11-19 22:48:13 +01:00
|
|
|
Type: "string",
|
|
|
|
},
|
|
|
|
config.HelpKV{
|
|
|
|
Key: KMSVaultAppRoleSecret,
|
2019-12-05 00:32:37 +01:00
|
|
|
Description: `unique secret ID created for AppRole`,
|
2019-11-19 22:48:13 +01:00
|
|
|
Type: "string",
|
|
|
|
},
|
|
|
|
config.HelpKV{
|
|
|
|
Key: KMSVaultNamespace,
|
2019-12-05 00:32:37 +01:00
|
|
|
Description: `only needed if AppRole engine is scoped to Vault Namespace e.g. "ns1"`,
|
2019-11-19 22:48:13 +01:00
|
|
|
Optional: true,
|
|
|
|
Type: "string",
|
|
|
|
},
|
|
|
|
config.HelpKV{
|
|
|
|
Key: KMSVaultKeyVersion,
|
|
|
|
Description: `KMS Vault key version`,
|
|
|
|
Optional: true,
|
|
|
|
Type: "number",
|
|
|
|
},
|
|
|
|
config.HelpKV{
|
|
|
|
Key: KMSVaultCAPath,
|
2019-12-05 00:32:37 +01:00
|
|
|
Description: `path to PEM-encoded CA cert files to use mTLS authentication (optional) e.g. "/home/user/custom-certs"`,
|
2019-11-19 22:48:13 +01:00
|
|
|
Optional: true,
|
|
|
|
Type: "path",
|
|
|
|
},
|
|
|
|
config.HelpKV{
|
|
|
|
Key: config.Comment,
|
2019-12-05 00:32:37 +01:00
|
|
|
Description: config.DefaultComment,
|
2019-11-19 22:48:13 +01:00
|
|
|
Optional: true,
|
|
|
|
Type: "sentence",
|
|
|
|
},
|
2019-10-23 07:59:13 +02:00
|
|
|
}
|
|
|
|
)
|