Skip to content

Commit 01c32ac

Browse files
authored
Add section for supported KMS actions (#1448)
Adds section to the policy based access control page for supported KMS action keys. Refers two existing kms related keys to the preferred `kms:` keys. Closes #1283
1 parent 71405b0 commit 01c32ac

File tree

1 file changed

+69
-0
lines changed

1 file changed

+69
-0
lines changed

source/administration/identity-access-management/policy-based-access-control.rst

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -754,11 +754,15 @@ services:
754754
.. policy-action:: admin:KMSCreateKey
755755

756756
Allows creating a new KMS master key
757+
758+
While this option is still supported, :policy-action:`kms:CreateKey` is preferred.
757759

758760
.. policy-action:: admin:KMSKeyStatus
759761

760762
Allows getting KMS key status
761763

764+
While this option is still supported, :policy-action:`kms:KeyStatus` is preferred.
765+
762766
.. policy-action:: admin:ServerInfo
763767

764768
Allows listing server info
@@ -922,6 +926,71 @@ services:
922926

923927
Allows access to start, query, or stop a rebalancing of objects across pools with varying free storage space.
924928

929+
KMS policy action keys
930+
----------------------
931+
932+
MinIO supports restricting key management service (KMS) actions by policy.
933+
934+
You can restrict KMS activities in a policy with any of the following KMS actions:
935+
936+
.. policy-action:: kms:Status
937+
938+
Check the status of KMS.
939+
940+
.. policy-action:: kms:Metrics
941+
942+
Obtain Prometheus-formatted metrics.
943+
944+
.. policy-action:: kms:API
945+
946+
List supported API endpoints.
947+
948+
.. policy-action:: kms:Version
949+
950+
Retrieve the KMS version.
951+
952+
.. policy-action:: kms:CreateKey
953+
954+
Create a new KMS key.
955+
956+
.. policy-action:: kms:ListKeys
957+
958+
Retrieve a list of existing KMS keys.
959+
960+
.. policy-action:: kms:KeyStatus
961+
962+
Retrieve the status of a specified KMS key.
963+
964+
To select all of the available kms policy actions, use ``kms:*``.
965+
966+
.. versionchanged:: RELEASE.2024-07-16T23-46-41Z
967+
968+
KMS actions can be restricted by resource or a resource prefix.
969+
The wildcard character ``*`` can be used to apply the KMS action policy to all resources that match the prefix.
970+
971+
For example, the following policy document allows a user to list keys, create new keys, and check the status of keys for any resource that begins with ``keys-abc-`` or ``myuser-``.
972+
973+
.. codeblock:: shell
974+
:class: copyable
975+
976+
{
977+
"Version": "2012-10-17",
978+
"Statement": [
979+
{
980+
"Effect": "Allow",
981+
"Action": [
982+
"kms:CreateKey",
983+
"kms:KeyStatus",
984+
"kms:ListKeys"
985+
],
986+
"Resource": [
987+
"arn:minio:kms:::keys-abc-*",
988+
"arn:minio:kms:::myuser-*"
989+
]
990+
}
991+
]
992+
}
993+
925994
``mc admin`` Policy Condition Keys
926995
----------------------------------
927996

0 commit comments

Comments
 (0)