From 3f0847a63225c26b6bddfa37d839e9f5690f311d Mon Sep 17 00:00:00 2001 From: ZhongShengping Date: Thu, 22 Nov 2018 11:31:57 +0800 Subject: [PATCH] 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: Ia1de7bb3a36852d9e8d0909f94dc17b396db4064 Closes-Bug: #1804562 Closes-Bug: #1804720 --- manifests/keystone/authtoken.pp | 48 +++++++++++-------- ...i_related_parameters-8f8279bb51ec2b19.yaml | 6 +++ .../octavia_keystone_authtoken_spec.rb | 6 --- 3 files changed, 33 insertions(+), 27 deletions(-) create mode 100644 releasenotes/notes/deprecate_pki_related_parameters-8f8279bb51ec2b19.yaml diff --git a/manifests/keystone/authtoken.pp b/manifests/keystone/authtoken.pp index 03d75d57..fd0bf6d6 100644 --- a/manifests/keystone/authtoken.pp +++ b/manifests/keystone/authtoken.pp @@ -62,12 +62,6 @@ # (Optional) Required if identity server requires client certificate # Defaults to $::os_service_default. # -# [*check_revocations_for_cached*] -# (Optional) If true, the revocation list will be checked for cached tokens. -# This requires that PKI tokens are configured on the identity server. -# boolean value. -# Defaults to $::os_service_default. -# # [*delay_auth_decision*] # (Optional) Do not handle authorization requests within the middleware, but # delegate the authorization decision to downstream WSGI components. Boolean @@ -84,17 +78,6 @@ # must be present in tokens. String value. # Defaults to $::os_service_default. # -# [*hash_algorithms*] -# (Optional) Hash algorithms to use for hashing PKI tokens. This may be a -# single algorithm or multiple. The algorithms are those supported by Python -# standard hashlib.new(). The hashes will be tried in the order given, so put -# the preferred one first for performance. The result of the first hash will -# be stored in the cache. This will typically be set to multiple values only -# while migrating from a less secure algorithm to a more secure one. Once all -# the old tokens are expired this option should be set to a single value for -# better performance. List value. -# Defaults to $::os_service_default. -# # [*http_connect_timeout*] # (Optional) Request timeout value for communicating with Identity API # server. @@ -183,6 +166,23 @@ # (Optional) Complete public Identity API endpoint. # Defaults to undef # +# [*check_revocations_for_cached*] +# (Optional) If true, the revocation list will be checked for cached tokens. +# This requires that PKI tokens are configured on the identity server. +# boolean value. +# Defaults to undef. +# +# [*hash_algorithms*] +# (Optional) Hash algorithms to use for hashing PKI tokens. This may be a +# single algorithm or multiple. The algorithms are those supported by Python +# standard hashlib.new(). The hashes will be tried in the order given, so put +# the preferred one first for performance. The result of the first hash will +# be stored in the cache. This will typically be set to multiple values only +# while migrating from a less secure algorithm to a more secure one. Once all +# the old tokens are expired this option should be set to a single value for +# better performance. List value. +# Defaults to undef. +# class octavia::keystone::authtoken( $password, $username = 'octavia', @@ -198,10 +198,8 @@ class octavia::keystone::authtoken( $cache = $::os_service_default, $cafile = $::os_service_default, $certfile = $::os_service_default, - $check_revocations_for_cached = $::os_service_default, $delay_auth_decision = $::os_service_default, $enforce_token_bind = $::os_service_default, - $hash_algorithms = $::os_service_default, $http_connect_timeout = $::os_service_default, $http_request_max_retries = $::os_service_default, $include_service_catalog = $::os_service_default, @@ -220,6 +218,8 @@ class octavia::keystone::authtoken( $token_cache_time = $::os_service_default, # DEPRECATED PARAMETERS $auth_uri = undef, + $check_revocations_for_cached = undef, + $hash_algorithms = undef, ) { include ::octavia::deps @@ -229,6 +229,14 @@ class octavia::keystone::authtoken( } $www_authenticate_uri_real = pick($auth_uri, $www_authenticate_uri) + if $check_revocations_for_cached { + warning('check_revocations_for_cached parameter is deprecated, has no effect and will be removed in the future.') + } + + if $hash_algorithms { + warning('hash_algorithms parameter is deprecated, has no effect and will be removed in the future.') + } + keystone::resource::authtoken { 'octavia_config': username => $username, password => $password, @@ -244,10 +252,8 @@ class octavia::keystone::authtoken( cache => $cache, cafile => $cafile, certfile => $certfile, - check_revocations_for_cached => $check_revocations_for_cached, delay_auth_decision => $delay_auth_decision, enforce_token_bind => $enforce_token_bind, - hash_algorithms => $hash_algorithms, http_connect_timeout => $http_connect_timeout, http_request_max_retries => $http_request_max_retries, include_service_catalog => $include_service_catalog, diff --git a/releasenotes/notes/deprecate_pki_related_parameters-8f8279bb51ec2b19.yaml b/releasenotes/notes/deprecate_pki_related_parameters-8f8279bb51ec2b19.yaml new file mode 100644 index 00000000..7aa4e60a --- /dev/null +++ b/releasenotes/notes/deprecate_pki_related_parameters-8f8279bb51ec2b19.yaml @@ -0,0 +1,6 @@ +--- +deprecations: + - check_revocations_for_cached option is now deprecated for removal, the + parameter has no effect. + - hash_algorithms option is now deprecated for removal, the parameter + has no effect. diff --git a/spec/classes/octavia_keystone_authtoken_spec.rb b/spec/classes/octavia_keystone_authtoken_spec.rb index f5691a6f..17f337a1 100644 --- a/spec/classes/octavia_keystone_authtoken_spec.rb +++ b/spec/classes/octavia_keystone_authtoken_spec.rb @@ -30,10 +30,8 @@ describe 'octavia::keystone::authtoken' do is_expected.to contain_octavia_config('keystone_authtoken/cache').with_value('') is_expected.to contain_octavia_config('keystone_authtoken/cafile').with_value('') is_expected.to contain_octavia_config('keystone_authtoken/certfile').with_value('') - is_expected.to contain_octavia_config('keystone_authtoken/check_revocations_for_cached').with_value('') is_expected.to contain_octavia_config('keystone_authtoken/delay_auth_decision').with_value('') is_expected.to contain_octavia_config('keystone_authtoken/enforce_token_bind').with_value('') - is_expected.to contain_octavia_config('keystone_authtoken/hash_algorithms').with_value('') is_expected.to contain_octavia_config('keystone_authtoken/http_connect_timeout').with_value('') is_expected.to contain_octavia_config('keystone_authtoken/http_request_max_retries').with_value('') is_expected.to contain_octavia_config('keystone_authtoken/include_service_catalog').with_value('') @@ -69,10 +67,8 @@ describe 'octavia::keystone::authtoken' do :cache => 'somevalue', :cafile => '/opt/stack/data/cafile.pem', :certfile => 'certfile.crt', - :check_revocations_for_cached => false, :delay_auth_decision => false, :enforce_token_bind => 'permissive', - :hash_algorithms => 'md5', :http_connect_timeout => '300', :http_request_max_retries => '3', :include_service_catalog => true, @@ -107,10 +103,8 @@ describe 'octavia::keystone::authtoken' do is_expected.to contain_octavia_config('keystone_authtoken/cache').with_value(params[:cache]) is_expected.to contain_octavia_config('keystone_authtoken/cafile').with_value(params[:cafile]) is_expected.to contain_octavia_config('keystone_authtoken/certfile').with_value(params[:certfile]) - is_expected.to contain_octavia_config('keystone_authtoken/check_revocations_for_cached').with_value(params[:check_revocations_for_cached]) is_expected.to contain_octavia_config('keystone_authtoken/delay_auth_decision').with_value(params[:delay_auth_decision]) is_expected.to contain_octavia_config('keystone_authtoken/enforce_token_bind').with_value(params[:enforce_token_bind]) - is_expected.to contain_octavia_config('keystone_authtoken/hash_algorithms').with_value(params[:hash_algorithms]) is_expected.to contain_octavia_config('keystone_authtoken/http_connect_timeout').with_value(params[:http_connect_timeout]) is_expected.to contain_octavia_config('keystone_authtoken/http_request_max_retries').with_value(params[:http_request_max_retries]) is_expected.to contain_octavia_config('keystone_authtoken/include_service_catalog').with_value(params[:include_service_catalog])