Skip to content

Commit f28a3fd

Browse files
1 parent 673bcd5 commit f28a3fd

9 files changed

+53
-36
lines changed

src/CloudKMS/CryptoKey.php

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,10 @@ public function getImportOnly()
215215
* the policy. The policy is defined by specifying zero or more allowed
216216
* justification codes. https://cloud.google.com/assured-workloads/key-access-
217217
* justifications/docs/justification-codes By default, this field is absent,
218-
* and all justification codes are allowed.
218+
* and all justification codes are allowed. If the
219+
* `key_access_justifications_policy.allowed_access_reasons` is empty (zero
220+
* allowed justification code), all encrypt, decrypt, and sign operations will
221+
* fail.
219222
*
220223
* @param KeyAccessJustificationsPolicy $keyAccessJustificationsPolicy
221224
*/

src/CloudKMS/KeyAccessJustificationsEnrollmentConfig.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,20 +20,20 @@
2020
class KeyAccessJustificationsEnrollmentConfig extends \Google\Model
2121
{
2222
/**
23-
* Whether the project has KAJ logging enabled.
23+
* Indicates whether the project has KAJ logging enabled.
2424
*
2525
* @var bool
2626
*/
2727
public $auditLogging;
2828
/**
29-
* Whether the project is enrolled in KAJ policy enforcement.
29+
* Indicates whether the project is enrolled in KAJ policy enforcement.
3030
*
3131
* @var bool
3232
*/
3333
public $policyEnforcement;
3434

3535
/**
36-
* Whether the project has KAJ logging enabled.
36+
* Indicates whether the project has KAJ logging enabled.
3737
*
3838
* @param bool $auditLogging
3939
*/
@@ -49,7 +49,7 @@ public function getAuditLogging()
4949
return $this->auditLogging;
5050
}
5151
/**
52-
* Whether the project is enrolled in KAJ policy enforcement.
52+
* Indicates whether the project is enrolled in KAJ policy enforcement.
5353
*
5454
* @param bool $policyEnforcement
5555
*/

src/CloudKMS/KeyAccessJustificationsPolicy.php

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,18 +21,20 @@ class KeyAccessJustificationsPolicy extends \Google\Collection
2121
{
2222
protected $collection_key = 'allowedAccessReasons';
2323
/**
24-
* The list of allowed reasons for access to a CryptoKey. Zero allowed access
25-
* reasons means all encrypt, decrypt, and sign operations for the CryptoKey
26-
* associated with this policy will fail.
24+
* The list of allowed reasons for access to a CryptoKey. Note that empty
25+
* allowed_access_reasons has a different meaning depending on where this
26+
* message appears. If this is under KeyAccessJustificationsPolicyConfig, it
27+
* means allow-all. If this is under CryptoKey, it means deny-all.
2728
*
2829
* @var string[]
2930
*/
3031
public $allowedAccessReasons;
3132

3233
/**
33-
* The list of allowed reasons for access to a CryptoKey. Zero allowed access
34-
* reasons means all encrypt, decrypt, and sign operations for the CryptoKey
35-
* associated with this policy will fail.
34+
* The list of allowed reasons for access to a CryptoKey. Note that empty
35+
* allowed_access_reasons has a different meaning depending on where this
36+
* message appears. If this is under KeyAccessJustificationsPolicyConfig, it
37+
* means allow-all. If this is under CryptoKey, it means deny-all.
3638
*
3739
* @param string[] $allowedAccessReasons
3840
*/

src/CloudKMS/KeyAccessJustificationsPolicyConfig.php

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,23 @@ class KeyAccessJustificationsPolicyConfig extends \Google\Model
2222
protected $defaultKeyAccessJustificationPolicyType = KeyAccessJustificationsPolicy::class;
2323
protected $defaultKeyAccessJustificationPolicyDataType = '';
2424
/**
25-
* Identifier. The resource name for this KeyAccessJustificationsPolicyConfig
26-
* in the format of "{organizations|folders|projects}/kajPolicyConfig".
25+
* Identifier. Represents the resource name for this
26+
* KeyAccessJustificationsPolicyConfig in the format of
27+
* "{organizations|folders|projects}/kajPolicyConfig".
2728
*
2829
* @var string
2930
*/
3031
public $name;
3132

3233
/**
33-
* Optional. The default key access justification policy used when a CryptoKey
34-
* is created in this folder. This is only used when a Key Access
35-
* Justifications policy is not provided in the CreateCryptoKeyRequest. This
36-
* overrides any default policies in its ancestry.
34+
* Optional. Specifies the default key access justifications (KAJ) policy used
35+
* when a CryptoKey is created in this folder. This is only used when a Key
36+
* Access Justifications policy is not provided in the CreateCryptoKeyRequest.
37+
* This overrides any default policies in its ancestry. If this field is
38+
* unset, or is set but contains an empty allowed_access_reasons list, no
39+
* default Key Access Justifications (KAJ) policy configuration is active. In
40+
* this scenario, all newly created keys will default to an "allow-all"
41+
* policy.
3742
*
3843
* @param KeyAccessJustificationsPolicy $defaultKeyAccessJustificationPolicy
3944
*/
@@ -49,8 +54,9 @@ public function getDefaultKeyAccessJustificationPolicy()
4954
return $this->defaultKeyAccessJustificationPolicy;
5055
}
5156
/**
52-
* Identifier. The resource name for this KeyAccessJustificationsPolicyConfig
53-
* in the format of "{organizations|folders|projects}/kajPolicyConfig".
57+
* Identifier. Represents the resource name for this
58+
* KeyAccessJustificationsPolicyConfig in the format of
59+
* "{organizations|folders|projects}/kajPolicyConfig".
5460
*
5561
* @param string $name
5662
*/

src/CloudKMS/Resource/Folders.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ public function getAutokeyConfig($name, $optParams = [])
5050
* Gets the KeyAccessJustificationsPolicyConfig for a given organization,
5151
* folder, or project. (folders.getKajPolicyConfig)
5252
*
53-
* @param string $name Required. The name of the
53+
* @param string $name Required. Specifies the name of the
5454
* KeyAccessJustificationsPolicyConfig to get.
5555
* @param array $optParams Optional parameters.
5656
* @return KeyAccessJustificationsPolicyConfig
@@ -91,13 +91,14 @@ public function updateAutokeyConfig($name, AutokeyConfig $postBody, $optParams =
9191
* Updates the KeyAccessJustificationsPolicyConfig for a given organization,
9292
* folder, or project. (folders.updateKajPolicyConfig)
9393
*
94-
* @param string $name Identifier. The resource name for this
94+
* @param string $name Identifier. Represents the resource name for this
9595
* KeyAccessJustificationsPolicyConfig in the format of
9696
* "{organizations|folders|projects}/kajPolicyConfig".
9797
* @param KeyAccessJustificationsPolicyConfig $postBody
9898
* @param array $optParams Optional parameters.
9999
*
100-
* @opt_param string updateMask Optional. The list of fields to update.
100+
* @opt_param string updateMask Optional. Specifies the list of fields to
101+
* update.
101102
* @return KeyAccessJustificationsPolicyConfig
102103
* @throws \Google\Service\Exception
103104
*/

src/CloudKMS/Resource/Organizations.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class Organizations extends \Google\Service\Resource
3333
* Gets the KeyAccessJustificationsPolicyConfig for a given organization,
3434
* folder, or project. (organizations.getKajPolicyConfig)
3535
*
36-
* @param string $name Required. The name of the
36+
* @param string $name Required. Specifies the name of the
3737
* KeyAccessJustificationsPolicyConfig to get.
3838
* @param array $optParams Optional parameters.
3939
* @return KeyAccessJustificationsPolicyConfig
@@ -49,13 +49,14 @@ public function getKajPolicyConfig($name, $optParams = [])
4949
* Updates the KeyAccessJustificationsPolicyConfig for a given organization,
5050
* folder, or project. (organizations.updateKajPolicyConfig)
5151
*
52-
* @param string $name Identifier. The resource name for this
52+
* @param string $name Identifier. Represents the resource name for this
5353
* KeyAccessJustificationsPolicyConfig in the format of
5454
* "{organizations|folders|projects}/kajPolicyConfig".
5555
* @param KeyAccessJustificationsPolicyConfig $postBody
5656
* @param array $optParams Optional parameters.
5757
*
58-
* @opt_param string updateMask Optional. The list of fields to update.
58+
* @opt_param string updateMask Optional. Specifies the list of fields to
59+
* update.
5960
* @return KeyAccessJustificationsPolicyConfig
6061
* @throws \Google\Service\Exception
6162
*/

src/CloudKMS/Resource/Projects.php

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public function getAutokeyConfig($name, $optParams = [])
5454
* Gets the KeyAccessJustificationsPolicyConfig for a given organization,
5555
* folder, or project. (projects.getKajPolicyConfig)
5656
*
57-
* @param string $name Required. The name of the
57+
* @param string $name Required. Specifies the name of the
5858
* KeyAccessJustificationsPolicyConfig to get.
5959
* @param array $optParams Optional parameters.
6060
* @return KeyAccessJustificationsPolicyConfig
@@ -89,8 +89,8 @@ public function showEffectiveAutokeyConfig($parent, $optParams = [])
8989
* to the given project in hierarchy.
9090
* (projects.showEffectiveKeyAccessJustificationsEnrollmentConfig)
9191
*
92-
* @param string $project Required. The number or id of the project to get the
93-
* effective KeyAccessJustificationsEnrollmentConfig for.
92+
* @param string $project Required. Specifies the number or id of the project to
93+
* get the effective KeyAccessJustificationsEnrollmentConfig for.
9494
* @param array $optParams Optional parameters.
9595
* @return ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse
9696
* @throws \Google\Service\Exception
@@ -106,8 +106,8 @@ public function showEffectiveKeyAccessJustificationsEnrollmentConfig($project, $
106106
* the given project in hierarchy.
107107
* (projects.showEffectiveKeyAccessJustificationsPolicyConfig)
108108
*
109-
* @param string $project Required. The number or id of the project to get the
110-
* effective KeyAccessJustificationsPolicyConfig. In the format of
109+
* @param string $project Required. Specifies the number or id of the project to
110+
* get the effective KeyAccessJustificationsPolicyConfig. In the format of
111111
* "projects/{|}"
112112
* @param array $optParams Optional parameters.
113113
* @return ShowEffectiveKeyAccessJustificationsPolicyConfigResponse
@@ -148,13 +148,14 @@ public function updateAutokeyConfig($name, AutokeyConfig $postBody, $optParams =
148148
* Updates the KeyAccessJustificationsPolicyConfig for a given organization,
149149
* folder, or project. (projects.updateKajPolicyConfig)
150150
*
151-
* @param string $name Identifier. The resource name for this
151+
* @param string $name Identifier. Represents the resource name for this
152152
* KeyAccessJustificationsPolicyConfig in the format of
153153
* "{organizations|folders|projects}/kajPolicyConfig".
154154
* @param KeyAccessJustificationsPolicyConfig $postBody
155155
* @param array $optParams Optional parameters.
156156
*
157-
* @opt_param string updateMask Optional. The list of fields to update.
157+
* @opt_param string updateMask Optional. Specifies the list of fields to
158+
* update.
158159
* @return KeyAccessJustificationsPolicyConfig
159160
* @throws \Google\Service\Exception
160161
*/

src/CloudKMS/ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse.php

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ class ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse extends \Goog
2727
protected $softwareConfigDataType = '';
2828

2929
/**
30-
* The effective KeyAccessJustificationsEnrollmentConfig for external keys.
30+
* Contains the effective KeyAccessJustificationsEnrollmentConfig for external
31+
* keys.
3132
*
3233
* @param KeyAccessJustificationsEnrollmentConfig $externalConfig
3334
*/
@@ -43,7 +44,8 @@ public function getExternalConfig()
4344
return $this->externalConfig;
4445
}
4546
/**
46-
* The effective KeyAccessJustificationsEnrollmentConfig for hardware keys.
47+
* Contains the effective KeyAccessJustificationsEnrollmentConfig for hardware
48+
* keys.
4749
*
4850
* @param KeyAccessJustificationsEnrollmentConfig $hardwareConfig
4951
*/
@@ -59,7 +61,8 @@ public function getHardwareConfig()
5961
return $this->hardwareConfig;
6062
}
6163
/**
62-
* The effective KeyAccessJustificationsEnrollmentConfig for software keys.
64+
* Contains the effective KeyAccessJustificationsEnrollmentConfig for software
65+
* keys.
6366
*
6467
* @param KeyAccessJustificationsEnrollmentConfig $softwareConfig
6568
*/

src/CloudKMS/ShowEffectiveKeyAccessJustificationsPolicyConfigResponse.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class ShowEffectiveKeyAccessJustificationsPolicyConfigResponse extends \Google\M
2323
protected $effectiveKajPolicyDataType = '';
2424

2525
/**
26-
* The effective KeyAccessJustificationsPolicyConfig.
26+
* Contains the effective KeyAccessJustificationsPolicyConfig.
2727
*
2828
* @param KeyAccessJustificationsPolicyConfig $effectiveKajPolicy
2929
*/

0 commit comments

Comments
 (0)