openstack
/
puppet-barbican
Code Issues Proposed changes

Add support for always_set_cka_sensitive parameter 

Some time ago BarbicanPkcs11AlwaysSetCkaSensitive option was
added to tripleo-heat-templates. change:
If3fa975e8243dfe30ef67ec81db891943a94a9d5

At the same time, it looks like relevant change was not added
to puppet-barbican project. This patch adds missing parameter
to barbican::plugins::p11_crypto class.

Backport note:
This backport includes the subsequent commit[1] which added
a unit test case for the new parameter.

 [1] d7e27eb854

Partial-bug: #1916386
Change-Id: Idf9dc70cd68d4e594119efcd2a3c3a0e56621c96
(cherry picked from commit 27b1cc2735)
This commit is contained in:
Alexey Stupnikov 2021-03-21 14:12:27 +01:00
parent 46a343434b
commit b44996d6c2
3 changed files with 45 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
manifests/plugins/p11_crypto.pp
View File

@ -70,26 +70,32 @@
# the PKCS#11 client library. # the PKCS#11 client library.
# Defaults to $::os_service_default # Defaults to $::os_service_default
# #
# [*p11_crypto_plugin_always_set_cka_sensitive*]
# (optional) Always set CKA_SENSITIVE when generating keys.
# In some HSMs extractable keys cannot be marked sensitive.
# Defaults to $::os_service_default
#
# [*global_default*] # [*global_default*]
# (optional) set plugin as global default # (optional) set plugin as global default
# Defaults to false # Defaults to false
# #
class barbican::plugins::p11_crypto ( class barbican::plugins::p11_crypto (
$p11_crypto_plugin_library_path = undef, $p11_crypto_plugin_library_path = undef,
$p11_crypto_plugin_login = undef, $p11_crypto_plugin_login = undef,
$p11_crypto_plugin_mkek_label = undef, $p11_crypto_plugin_mkek_label = undef,
$p11_crypto_plugin_mkek_length = undef, $p11_crypto_plugin_mkek_length = undef,
$p11_crypto_plugin_hmac_label = undef, $p11_crypto_plugin_hmac_label = undef,
$p11_crypto_plugin_token_serial_number = $::os_service_default, $p11_crypto_plugin_token_serial_number = $::os_service_default,
$p11_crypto_plugin_token_label = $::os_service_default, $p11_crypto_plugin_token_label = $::os_service_default,
$p11_crypto_plugin_token_labels = $::os_service_default, $p11_crypto_plugin_token_labels = $::os_service_default,
$p11_crypto_plugin_slot_id = $::os_service_default, $p11_crypto_plugin_slot_id = $::os_service_default,
$p11_crypto_plugin_encryption_mechanism = $::os_service_default, $p11_crypto_plugin_encryption_mechanism = $::os_service_default,
$p11_crypto_plugin_hmac_key_type = $::os_service_default, $p11_crypto_plugin_hmac_key_type = $::os_service_default,
$p11_crypto_plugin_hmac_keygen_mechanism = $::os_service_default, $p11_crypto_plugin_hmac_keygen_mechanism = $::os_service_default,
$p11_crypto_plugin_aes_gcm_generate_iv = $::os_service_default, $p11_crypto_plugin_aes_gcm_generate_iv = $::os_service_default,
$p11_crypto_plugin_os_locking_ok = $::os_service_default, $p11_crypto_plugin_os_locking_ok = $::os_service_default,
$global_default = false, $p11_crypto_plugin_always_set_cka_sensitive = $::os_service_default,
$global_default = false,
) { ) {
include barbican::deps include barbican::deps
@ -111,20 +117,21 @@ class barbican::plugins::p11_crypto (
} }
barbican_config { barbican_config {
'p11_crypto_plugin/library_path': value => $p11_crypto_plugin_library_path; 'p11_crypto_plugin/library_path': value => $p11_crypto_plugin_library_path;
'p11_crypto_plugin/login': value => $p11_crypto_plugin_login; 'p11_crypto_plugin/login': value => $p11_crypto_plugin_login;
'p11_crypto_plugin/mkek_label': value => $p11_crypto_plugin_mkek_label; 'p11_crypto_plugin/mkek_label': value => $p11_crypto_plugin_mkek_label;
'p11_crypto_plugin/mkek_length': value => $p11_crypto_plugin_mkek_length; 'p11_crypto_plugin/mkek_length': value => $p11_crypto_plugin_mkek_length;
'p11_crypto_plugin/hmac_label': value => $p11_crypto_plugin_hmac_label; 'p11_crypto_plugin/hmac_label': value => $p11_crypto_plugin_hmac_label;
'p11_crypto_plugin/token_serial_number': value => $p11_crypto_plugin_token_serial_number; 'p11_crypto_plugin/token_serial_number': value => $p11_crypto_plugin_token_serial_number;
'p11_crypto_plugin/token_label': value => $p11_crypto_plugin_token_label; 'p11_crypto_plugin/token_label': value => $p11_crypto_plugin_token_label;
'p11_crypto_plugin/token_labels': value => $p11_crypto_plugin_token_labels; 'p11_crypto_plugin/token_labels': value => $p11_crypto_plugin_token_labels;
'p11_crypto_plugin/slot_id': value => $p11_crypto_plugin_slot_id; 'p11_crypto_plugin/slot_id': value => $p11_crypto_plugin_slot_id;
'p11_crypto_plugin/encryption_mechanism': value => $p11_crypto_plugin_encryption_mechanism; 'p11_crypto_plugin/encryption_mechanism': value => $p11_crypto_plugin_encryption_mechanism;
'p11_crypto_plugin/hmac_key_type': value => $p11_crypto_plugin_hmac_key_type; 'p11_crypto_plugin/hmac_key_type': value => $p11_crypto_plugin_hmac_key_type;
'p11_crypto_plugin/hmac_keygen_mechanism': value => $p11_crypto_plugin_hmac_keygen_mechanism; 'p11_crypto_plugin/hmac_keygen_mechanism': value => $p11_crypto_plugin_hmac_keygen_mechanism;
'p11_crypto_plugin/aes_gcm_generate_iv': value => $p11_crypto_plugin_aes_gcm_generate_iv; 'p11_crypto_plugin/aes_gcm_generate_iv': value => $p11_crypto_plugin_aes_gcm_generate_iv;
'p11_crypto_plugin/os_locking_ok': value => $p11_crypto_plugin_os_locking_ok; 'p11_crypto_plugin/os_locking_ok': value => $p11_crypto_plugin_os_locking_ok;
'p11_crypto_plugin/always_set_cka_sensitive': value => $p11_crypto_plugin_always_set_cka_sensitive;
} }
barbican_config { barbican_config {

6
releasenotes/notes/p11_crypto_plugin_always_set_cka_sensitive-1c9a9b9726c3cf93.yaml Normal file
View File

@ -0,0 +1,6 @@
---
features:
- |
Support for the ``[p11_crypto_plugin] always_set_cka_sensitive`` parameter
has been added.

3
spec/classes/barbican_plugins_p11_crypto_spec.rb
View File

@ -39,6 +39,7 @@ describe 'barbican::plugins::p11_crypto' do
:p11_crypto_plugin_hmac_keygen_mechanism => 'CKM_AES_KEY_GEN', :p11_crypto_plugin_hmac_keygen_mechanism => 'CKM_AES_KEY_GEN',
:p11_crypto_plugin_aes_gcm_generate_iv => false, :p11_crypto_plugin_aes_gcm_generate_iv => false,
:p11_crypto_plugin_os_locking_ok => false, :p11_crypto_plugin_os_locking_ok => false,
:p11_crypto_plugin_always_set_cka_sensitive => true,
:global_default => true, :global_default => true,
} }
end end
@ -72,6 +73,8 @@ describe 'barbican::plugins::p11_crypto' do
.with_value(params[:p11_crypto_plugin_aes_gcm_generate_iv]) .with_value(params[:p11_crypto_plugin_aes_gcm_generate_iv])
is_expected.to contain_barbican_config('p11_crypto_plugin/os_locking_ok') \ is_expected.to contain_barbican_config('p11_crypto_plugin/os_locking_ok') \
.with_value(params[:p11_crypto_plugin_os_locking_ok]) .with_value(params[:p11_crypto_plugin_os_locking_ok])
is_expected.to contain_barbican_config('p11_crypto_plugin/always_set_cka_sensitive') \
.with_value(params[:p11_crypto_plugin_always_set_cka_sensitive])
is_expected.to contain_barbican_config( is_expected.to contain_barbican_config(
'secretstore:pkcs11/secret_store_plugin') \ 'secretstore:pkcs11/secret_store_plugin') \
.with_value('store_crypto') .with_value('store_crypto')