a-c-m
/
community.crypto
mirror of https://github.com/ansible-collections/community.crypto.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Deprecate the default value 'false' of asn1_base64. (#600)

pull/649/head
Felix Fontein 2023-08-12 12:23:37 +02:00 committed by GitHub
parent 5526fcac27
commit 62c842548d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelogs/fragments/600-get_certificate-asn1_base64.yml Normal file
View File

@ -0,0 +1,2 @@
deprecated_features:
- "get_certificate - the default ``false`` of the ``asn1_base64`` option is deprecated and will change to ``true`` in community.crypto 3.0.0 (https://github.com/ansible-collections/community.crypto/pull/600)."

16
plugins/modules/get_certificate.py
View File

@ -95,10 +95,9 @@ options:
description: description:
- Whether to encode the ASN.1 values in the RV(extensions) return value with Base64 or not. - Whether to encode the ASN.1 values in the RV(extensions) return value with Base64 or not.
- The documentation claimed for a long time that the values are Base64 encoded, but they - The documentation claimed for a long time that the values are Base64 encoded, but they
never were. For compatibility this option is set to V(false), but that value will eventually never were. For compatibility this option is set to V(false).
be deprecated and changed to V(true). - The default value V(false) is B(deprecated) and will change to V(true) in community.crypto 3.0.0.
type: bool type: bool
default: false
version_added: 2.12.0 version_added: 2.12.0
notes: notes:
@ -272,7 +271,7 @@ def main():
select_crypto_backend=dict(type='str', choices=['auto', 'cryptography'], default='auto'), select_crypto_backend=dict(type='str', choices=['auto', 'cryptography'], default='auto'),
starttls=dict(type='str', choices=['mysql']), starttls=dict(type='str', choices=['mysql']),
ciphers=dict(type='list', elements='str'), ciphers=dict(type='list', elements='str'),
asn1_base64=dict(type='bool', default=False), asn1_base64=dict(type='bool'),
), ),
) )
@ -286,6 +285,15 @@ def main():
start_tls_server_type = module.params.get('starttls') start_tls_server_type = module.params.get('starttls')
ciphers = module.params.get('ciphers') ciphers = module.params.get('ciphers')
asn1_base64 = module.params['asn1_base64'] asn1_base64 = module.params['asn1_base64']
if asn1_base64 is None:
module.deprecate(
'The default value `false` for asn1_base64 is deprecated and will change to `true` in '
'community.crypto 3.0.0. If you need this value, it is best to set the value explicitly '
'and adjust your roles/playbooks to use `asn1_base64=true` as soon as possible',
version='3.0.0',
collection_name='community.crypto',
)
asn1_base64 = False
backend = module.params.get('select_crypto_backend') backend = module.params.get('select_crypto_backend')
if backend == 'auto': if backend == 'auto':