Browse Source

Deprecate pki related options

check_revocations_for_cached and hash_algorithms are deprecated for
removel because of PKI token format is no longer supported.
Update warning message and add a release note.

Change-Id: Ic360bd95c3cf542ca2833e366102950cecd7ef5b
Closes-Bug: #1804562
Closes-Bug: #1804720
ZhongShengping 6 months ago
parent
commit
ff52d5f8a5

+ 27
- 21
manifests/keystone/authtoken.pp View File

@@ -63,12 +63,6 @@
63 63
 #   (Optional) Required if identity server requires client certificate
64 64
 #   Defaults to $::os_service_default.
65 65
 #
66
-# [*check_revocations_for_cached*]
67
-#   (Optional) If true, the revocation list will be checked for cached tokens.
68
-#   This requires that PKI tokens are configured on the identity server.
69
-#   boolean value.
70
-#   Defaults to $::os_service_default.
71
-#
72 66
 # [*delay_auth_decision*]
73 67
 #   (Optional) Do not handle authorization requests within the middleware, but
74 68
 #   delegate the authorization decision to downstream WSGI components. Boolean
@@ -85,17 +79,6 @@
85 79
 #   must be present in tokens. String value.
86 80
 #   Defaults to $::os_service_default.
87 81
 #
88
-# [*hash_algorithms*]
89
-#   (Optional) Hash algorithms to use for hashing PKI tokens. This may be a
90
-#   single algorithm or multiple. The algorithms are those supported by Python
91
-#   standard hashlib.new(). The hashes will be tried in the order given, so put
92
-#   the preferred one first for performance. The result of the first hash will
93
-#   be stored in the cache. This will typically be set to multiple values only
94
-#   while migrating from a less secure algorithm to a more secure one. Once all
95
-#   the old tokens are expired this option should be set to a single value for
96
-#   better performance. List value.
97
-#   Defaults to $::os_service_default.
98
-#
99 82
 # [*http_connect_timeout*]
100 83
 #   (Optional) Request timeout value for communicating with Identity API
101 84
 #   server.
@@ -189,6 +172,23 @@
189 172
 #   (Optional) Complete public Identity API endpoint.
190 173
 #   Defaults to undef
191 174
 #
175
+# [*check_revocations_for_cached*]
176
+#   (Optional) If true, the revocation list will be checked for cached tokens.
177
+#   This requires that PKI tokens are configured on the identity server.
178
+#   boolean value.
179
+#   Defaults to undef.
180
+#
181
+# [*hash_algorithms*]
182
+#   (Optional) Hash algorithms to use for hashing PKI tokens. This may be a
183
+#   single algorithm or multiple. The algorithms are those supported by Python
184
+#   standard hashlib.new(). The hashes will be tried in the order given, so put
185
+#   the preferred one first for performance. The result of the first hash will
186
+#   be stored in the cache. This will typically be set to multiple values only
187
+#   while migrating from a less secure algorithm to a more secure one. Once all
188
+#   the old tokens are expired this option should be set to a single value for
189
+#   better performance. List value.
190
+#   Defaults to undef.
191
+#
192 192
 class trove::keystone::authtoken(
193 193
   $username                       = 'trove',
194 194
   $password                       = $::os_service_default,
@@ -204,10 +204,8 @@ class trove::keystone::authtoken(
204 204
   $cache                          = $::os_service_default,
205 205
   $cafile                         = $::os_service_default,
206 206
   $certfile                       = $::os_service_default,
207
-  $check_revocations_for_cached   = $::os_service_default,
208 207
   $delay_auth_decision            = $::os_service_default,
209 208
   $enforce_token_bind             = $::os_service_default,
210
-  $hash_algorithms                = $::os_service_default,
211 209
   $http_connect_timeout           = $::os_service_default,
212 210
   $http_request_max_retries       = $::os_service_default,
213 211
   $include_service_catalog        = $::os_service_default,
@@ -226,6 +224,8 @@ class trove::keystone::authtoken(
226 224
   $token_cache_time               = $::os_service_default,
227 225
   # DEPRECATED PARAMETERS
228 226
   $auth_uri                       = undef,
227
+  $check_revocations_for_cached   = undef,
228
+  $hash_algorithms                = undef,
229 229
 ) {
230 230
 
231 231
   include ::trove::deps
@@ -239,6 +239,14 @@ class trove::keystone::authtoken(
239 239
   }
240 240
   $www_authenticate_uri_real = pick($auth_uri, $www_authenticate_uri)
241 241
 
242
+  if $check_revocations_for_cached {
243
+    warning('check_revocations_for_cached parameter is deprecated, has no effect and will be removed in the future.')
244
+  }
245
+
246
+  if $hash_algorithms {
247
+    warning('hash_algorithms parameter is deprecated, has no effect and will be removed in the future.')
248
+  }
249
+
242 250
   keystone::resource::authtoken { 'trove_config':
243 251
     username                       => $username,
244 252
     password                       => $password,
@@ -254,10 +262,8 @@ class trove::keystone::authtoken(
254 262
     cache                          => $cache,
255 263
     cafile                         => $cafile,
256 264
     certfile                       => $certfile,
257
-    check_revocations_for_cached   => $check_revocations_for_cached,
258 265
     delay_auth_decision            => $delay_auth_decision,
259 266
     enforce_token_bind             => $enforce_token_bind,
260
-    hash_algorithms                => $hash_algorithms,
261 267
     http_connect_timeout           => $http_connect_timeout,
262 268
     http_request_max_retries       => $http_request_max_retries,
263 269
     include_service_catalog        => $include_service_catalog,

+ 6
- 0
releasenotes/notes/deprecate_pki_related_parameters-a29fb4207f537afb.yaml View File

@@ -0,0 +1,6 @@
1
+---
2
+deprecations:
3
+  - check_revocations_for_cached option is now deprecated for removal, the
4
+    parameter has no effect.
5
+  - hash_algorithms option is now deprecated for removal, the parameter
6
+    has no effect.

+ 0
- 6
spec/classes/trove_keystone_authtoken_spec.rb View File

@@ -25,10 +25,8 @@ describe 'trove::keystone::authtoken' do
25 25
         is_expected.to contain_trove_config('keystone_authtoken/cache').with_value('<SERVICE DEFAULT>')
26 26
         is_expected.to contain_trove_config('keystone_authtoken/cafile').with_value('<SERVICE DEFAULT>')
27 27
         is_expected.to contain_trove_config('keystone_authtoken/certfile').with_value('<SERVICE DEFAULT>')
28
-        is_expected.to contain_trove_config('keystone_authtoken/check_revocations_for_cached').with_value('<SERVICE DEFAULT>')
29 28
         is_expected.to contain_trove_config('keystone_authtoken/delay_auth_decision').with_value('<SERVICE DEFAULT>')
30 29
         is_expected.to contain_trove_config('keystone_authtoken/enforce_token_bind').with_value('<SERVICE DEFAULT>')
31
-        is_expected.to contain_trove_config('keystone_authtoken/hash_algorithms').with_value('<SERVICE DEFAULT>')
32 30
         is_expected.to contain_trove_config('keystone_authtoken/http_connect_timeout').with_value('<SERVICE DEFAULT>')
33 31
         is_expected.to contain_trove_config('keystone_authtoken/http_request_max_retries').with_value('<SERVICE DEFAULT>')
34 32
         is_expected.to contain_trove_config('keystone_authtoken/include_service_catalog').with_value('<SERVICE DEFAULT>')
@@ -64,10 +62,8 @@ describe 'trove::keystone::authtoken' do
64 62
           :cache                                => 'somevalue',
65 63
           :cafile                               => '/opt/stack/data/cafile.pem',
66 64
           :certfile                             => 'certfile.crt',
67
-          :check_revocations_for_cached         => false,
68 65
           :delay_auth_decision                  => false,
69 66
           :enforce_token_bind                   => 'permissive',
70
-          :hash_algorithms                      => 'md5',
71 67
           :http_connect_timeout                 => '300',
72 68
           :http_request_max_retries             => '3',
73 69
           :include_service_catalog              => true,
@@ -102,10 +98,8 @@ describe 'trove::keystone::authtoken' do
102 98
         is_expected.to contain_trove_config('keystone_authtoken/cache').with_value(params[:cache])
103 99
         is_expected.to contain_trove_config('keystone_authtoken/cafile').with_value(params[:cafile])
104 100
         is_expected.to contain_trove_config('keystone_authtoken/certfile').with_value(params[:certfile])
105
-        is_expected.to contain_trove_config('keystone_authtoken/check_revocations_for_cached').with_value(params[:check_revocations_for_cached])
106 101
         is_expected.to contain_trove_config('keystone_authtoken/delay_auth_decision').with_value(params[:delay_auth_decision])
107 102
         is_expected.to contain_trove_config('keystone_authtoken/enforce_token_bind').with_value(params[:enforce_token_bind])
108
-        is_expected.to contain_trove_config('keystone_authtoken/hash_algorithms').with_value(params[:hash_algorithms])
109 103
         is_expected.to contain_trove_config('keystone_authtoken/http_connect_timeout').with_value(params[:http_connect_timeout])
110 104
         is_expected.to contain_trove_config('keystone_authtoken/http_request_max_retries').with_value(params[:http_request_max_retries])
111 105
         is_expected.to contain_trove_config('keystone_authtoken/include_service_catalog').with_value(params[:include_service_catalog])

Loading…
Cancel
Save