Skip to content

Commit 12b4b36

Browse files
authored
Merge pull request #177230 from sebansal/patch-102
Update azure-policy.md
2 parents d988fce + c1ac61f commit 12b4b36

File tree

2 files changed

+29
-27
lines changed

2 files changed

+29
-27
lines changed

articles/key-vault/general/azure-policy.md

Lines changed: 28 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,16 @@ Key Vault has created a set of policies, which can be used to manage key vaults
3535

3636
# [Certificate Policies](#tab/certificates)
3737

38-
### Certificates should have the specified maximum validity period (preview)
38+
### Manage certificates that are within a specified number of days of expiration
3939

40-
This policy allows you to manage the maximum validity period of your certificates stored in key vault. It is a good security practice to limit the maximum validity period of your certificates. If a private key of your certificate were to become compromised without detection, using short lived certificates minimizes the time frame for ongoing damage and reduces the value of the certificate to an attacker.
40+
Your service can experience an outage if a certificate that is not being adequately monitored is not rotated prior to its expiration. This policy is critical to making sure that your certificates stored in key vault are being monitored. It is recommended that you apply this policy multiple times with different expiration thresholds, for example, at 180, 90, 60, and 30-day thresholds. This policy can be used to monitor and triage certificate expiration in your organization.
41+
42+
43+
### Certificates should have the specified lifetime action triggers
44+
45+
This policy allows you to manage the lifetime action specified for certificates that are either within a certain number of days of their expiration or have reached a certain percentage of their usable life.
4146

42-
### Certificates should use allowed key types (preview)
47+
### Certificates should use allowed key types
4348

4449
This policy allows you to restrict the type of certificates that can be in your key vault. You can use this policy to make sure that your certificate private keys are RSA, ECC, or are HSM backed. You can choose from the following list which certificate types are allowed.
4550

@@ -48,19 +53,15 @@ This policy allows you to restrict the type of certificates that can be in your
4853
- ECC
4954
- ECC - HSM
5055

51-
### Certificates should have the specified lifetime action triggers (preview)
52-
53-
This policy allows you to manage the lifetime action specified for certificates that are either within a certain number of days of their expiration or have reached a certain percentage of their usable life.
54-
55-
### Certificates should be issued by the specified integrated certificate authority (preview)
56+
### Certificates should be issued by the specified integrated certificate authority
5657

5758
If you use a Key Vault integrated certificate authority (Digicert or GlobalSign) and you want users to use one or either of these providers, you can use this policy to audit or enforce your selection. This policy will evaluate the CA selected in the issuance policy of the cert and the CA provider defined in the key vault. This policy can also be used to audit or deny the creation of self-signed certificates in key vault.
5859

59-
### Certificates should be issued by the specified non-integrated certificate authority (preview)
60+
### Certificates should be issued by the specified non-integrated certificate authority
6061

6162
If you use an internal certificate authority or a certificate authority not integrated with key vault and you want users to use a certificate authority from a list you provide, you can use this policy to create an allowed list of certificate authorities by issuer name. This policy can also be used to audit or deny the creation of self-signed certificates in key vault.
6263

63-
### Certificates using elliptic curve cryptography should have allowed curve names (preview)
64+
### Certificates using elliptic curve cryptography should have allowed curve names
6465

6566
If you use elliptic curve cryptography or ECC certificates, you can customize an allowed list of curve names from the list below. The default option allows all the following curve names.
6667

@@ -69,29 +70,29 @@ If you use elliptic curve cryptography or ECC certificates, you can customize an
6970
- P-384
7071
- P-521
7172

72-
## Certificates using RSA cryptography Manage minimum key size for RSA certificates (preview)
73+
### Certificates using RSA cryptography Manage minimum key size for RSA certificates
7374

7475
If you use RSA certificates, you can choose a minimum key size that your certificates must have. You may select one option from the list below.
7576

7677
- 2048 bit
7778
- 3072 bit
7879
- 4096 bit
7980

80-
## Manage certificates that are within a specified number of days of expiration (preview)
81+
### Certificates should have the specified maximum validity period (preview)
8182

82-
Your service can experience an outage if a certificate that is not being adequately monitored is not rotated prior to its expiration. This policy is critical to making sure that your certificates stored in key vault are being monitored. It is recommended that you apply this policy multiple times with different expiration thresholds, for example, at 180, 90, 60, and 30-day thresholds. This policy can be used to monitor and triage certificate expiration in your organization.
83+
This policy allows you to manage the maximum validity period of your certificates stored in key vault. It is a good security practice to limit the maximum validity period of your certificates. If a private key of your certificate were to become compromised without detection, using short lived certificates minimizes the time frame for ongoing damage and reduces the value of the certificate to an attacker.
8384

8485
# [Key Policies](#tab/keys)
8586

86-
### Keys should not be active for longer than the specified number of days (preview)
87+
### Keys should not be active for longer than the specified number of days
8788

8889
If you want to make sure that your keys have not been active for longer than a specified number of days, you can use this policy to audit how long your key has been active.
8990

9091
**If your key has an activation date set**, this policy will calculate the number of days that have elapsed from the **activation date** of the key to the current date. If the number of days exceeds the threshold you set, the key will be marked as non-compliant with the policy.
9192

9293
**If your key does not have an activation date set**, this policy will calculate the number of days that have elapsed from the **creation date** of the key to the current date. If the number of days exceeds the threshold you set, the key will be marked as non-compliant with the policy.
9394

94-
### Keys should be the specified cryptographic type RSA or EC (preview)
95+
### Keys should be the specified cryptographic type RSA or EC
9596

9697
This policy allows you to restrict the type of keys that can be in your key vault. You can use this policy to make sure that your keys are RSA, ECC, or are HSM backed. You can choose from the following list which certificate types are allowed.
9798

@@ -100,7 +101,7 @@ This policy allows you to restrict the type of keys that can be in your key vaul
100101
- ECC
101102
- ECC - HSM
102103

103-
### Keys using elliptic curve cryptography should have the specified curve names (preview)
104+
### Keys using elliptic curve cryptography should have the specified curve names
104105

105106
If you use elliptic curve cryptography or ECC keys, you can customize an allowed list of curve names from the list below. The default option allows all the following curve names.
106107

@@ -109,49 +110,49 @@ If you use elliptic curve cryptography or ECC keys, you can customize an allowed
109110
- P-384
110111
- P-521
111112

112-
### Keys should have expirations dates set (preview)
113+
### Keys should have expirations dates set
113114

114115
This policy audits all keys in your key vaults and flags keys that do not have an expiration date set as non-compliant. You can also use this policy to block the creation of keys that do not have an expiration date set.
115116

116-
### Keys should have more than the specified number of days before expiration (preview)
117+
### Keys should have more than the specified number of days before expiration
117118

118119
If a key is too close to expiration, an organizational delay to rotate the key may result in an outage. Keys should be rotated at a specified number of days prior to expiration to provide sufficient time to react to a failure. This policy will audit keys that are too close to their expiration date and allows you to set this threshold in days. You can also use this policy to prevent the creation of new keys that are too close to their expiration date.
119120

120-
### Keys should be backed by a hardware security module (preview)
121+
### Keys should be backed by a hardware security module
121122

122123
An HSM is a hardware security module that stores keys. An HSM provides a physical layer of protection for cryptographic keys. The cryptographic key cannot leave a physical HSM which provides a greater level of security than a software key. Some organizations have compliance requirements that mandate the use of HSM keys. Use this policy to audit any keys stored in your key vault that is not HSM backed. You can also use this policy to block the creation of new keys that are not HSM backed. This policy will apply to all key types, RSA and ECC.
123124

124-
### Keys using RSA cryptography should have a specified minimum key size (preview)
125+
### Keys using RSA cryptography should have a specified minimum key size
125126

126127
Using RSA keys with smaller key sizes is not a secure design practice. You may be subject to audit and certification standards that mandate the use of a minimum key size. The following policy allows you to set a minimum key size requirement on your key vault. You can audit keys that do not meet this minimum requirement. This policy can also be used to block the creation of new keys that do not meet the minimum key size requirement.
127128

128-
### Keys should have the specified maximum validity period (preview)
129+
### Keys should have the specified maximum validity period
129130

130131
Manage your organizational compliance requirements by specifying the maximum amount of time in days that a key can be valid within your key vault. Keys that are valid longer than the threshold you set will be marked as non-compliant. You can also use this policy to block the creation of new keys that have an expiration date set longer than the maximum validity period you specify.
131132

132133
# [Secret Policies](#tab/secrets)
133134

134-
### Secrets should not be active for longer than the specified number of days (preview)
135+
### Secrets should not be active for longer than the specified number of days
135136

136137
If you want to make sure that your secrets have not been active for longer than a specified number of days, you can use this policy to audit how long your secret has been active.
137138

138139
**If your secret has an activation date set**, this policy will calculate the number of days that have elapsed from the **activation date** of the secret to the current date. If the number of days exceeds the threshold you set, the secret will be marked as non-compliant with the policy.
139140

140141
**If your secret does not have an activation date set**, this policy will calculate the number of days that have elapsed from the **creation date** of the secret to the current date. If the number of days exceeds the threshold you set, the secret will be marked as non-compliant with the policy.
141142

142-
### Secrets should have content type set (preview)
143+
### Secrets should have content type set
143144

144145
Any plain text or encoded file can be stored as a key vault secret. However, your organization may want to set different rotation policies and restrictions on passwords, connection strings, or certificates stored as keys. A content type tag can help a user see what is stored in a secret object without reading the value of the secret. You can use this policy to audit secrets that don't have a content type tag set. You can also use this policy to prevent new secrets from being created if they don't have a content type tag set.
145146

146-
### Secrets should have expiration date set (preview)
147+
### Secrets should have expiration date set
147148

148149
This policy audits all secrets in your key vault and flags secrets that do not have an expiration date set as non-compliant. You can also use this policy to block the creation of secrets that do not have an expiration date set.
149150

150-
### Secrets should have more than the specified number of days before expiration (preview)
151+
### Secrets should have more than the specified number of days before expiration
151152

152153
If a secret is too close to expiration, an organizational delay to rotate the secret may result in an outage. Secrets should be rotated at a specified number of days prior to expiration to provide sufficient time to react to a failure. This policy will audit secrets that are too close to their expiration date and allows you to set this threshold in days. You can also use this policy to prevent the creation of new secrets that are too close to their expiration date.
153154

154-
### Secrets should have the specified maximum validity period (preview)
155+
### Secrets should have the specified maximum validity period
155156

156157
Manage your organizational compliance requirements by specifying the maximum amount of time in days that a secret can be valid within your key vault. Secrets that are valid longer than the threshold you set will be marked as non-compliant. You can also use this policy to block the creation of new secrets that have an expiration date set longer than the maximum validity period you specify.
157158

@@ -261,6 +262,7 @@ If the compliance results show up as "Not Started" it may be due to the followin
261262
262263
## Next Steps
263264

265+
- [Logging and frequently asked questions for Azure policy for key vault](../general/troubleshoot-azure-policy-for-key-vault.md)
264266
- Learn more about the [Azure Policy service](../../governance/policy/overview.md)
265267
- See Key Vault samples: [Key Vault built-in policy definitions](../../governance/policy/samples/built-in-policies.md#key-vault)
266268
- Learn about [Azure Security Benchmark guidance on Key vault](/security/benchmark/azure/baselines/key-vault-security-baseline?source=docs#network-security)

articles/key-vault/general/troubleshoot-azure-policy-for-key-vault.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When you enable logging, a new container called **AzurePolicyEvaluationDetails**
2929
>
3030
3131
Individual blobs are stored as text, formatted as a JSON blob.
32-
Let's look at an example log entry for a Key policy : [Keys should have expiration date set](azure-policy.md?tabs=keys#secrets-should-have-expiration-date-set-preview). This policy evaluates all keys in your key vaults and flags keys that do not have an expiration date set as non-compliant.
32+
Let's look at an example log entry for a Key policy : [Keys should have expiration date set](azure-policy.md?tabs=keys#secrets-should-have-expiration-date-set). This policy evaluates all keys in your key vaults and flags keys that do not have an expiration date set as non-compliant.
3333

3434
```json
3535
{

0 commit comments

Comments
 (0)