From a5a4e022bac616b50dbf53866a8d3057b4f8dd7d Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 11 May 2025 19:17:58 +0200 Subject: [PATCH] Make all module_utils and plugin_utils private (#887) * Add leading underscore. Remove deprecated module utils. * Document module and plugin utils as private. Add changelog fragment. * Convert relative to absolute imports. * Remove unnecessary imports. --- README.md | 2 +- .../887-module_utils-plugin_utils.yml | 4 +++ plugins/action/openssl_privatekey_pipe.py | 12 +++---- plugins/doc_fragments/cryptography_dep.py | 4 +-- plugins/filter/gpg_fingerprint.py | 4 +-- plugins/filter/openssl_csr_info.py | 6 ++-- plugins/filter/openssl_privatekey_info.py | 6 ++-- plugins/filter/openssl_publickey_info.py | 6 ++-- plugins/filter/parse_serial.py | 2 +- plugins/filter/split_pem.py | 2 +- plugins/filter/to_serial.py | 2 +- plugins/filter/x509_certificate_info.py | 6 ++-- plugins/filter/x509_crl_info.py | 8 ++--- plugins/lookup/gpg_fingerprint.py | 4 +-- .../module_utils/{acme => _acme}/account.py | 9 +++-- plugins/module_utils/{acme => _acme}/acme.py | 23 ++++++++----- .../{acme => _acme}/backend_cryptography.py | 31 ++++++++++------- .../{acme => _acme}/backend_openssl_cli.py | 18 ++++++---- .../module_utils/{acme => _acme}/backends.py | 15 +++++--- .../{acme => _acme}/certificate.py | 34 ++++++++++++------- .../{acme => _acme}/certificates.py | 13 ++++--- .../{acme => _acme}/challenges.py | 12 ++++--- .../module_utils/{acme => _acme}/errors.py | 3 ++ plugins/module_utils/{acme => _acme}/io.py | 5 ++- .../module_utils/{acme => _acme}/orders.py | 13 ++++--- plugins/module_utils/{acme => _acme}/utils.py | 14 +++++--- .../module_utils/{argspec.py => _argspec.py} | 3 ++ .../module_utils/{crypto => _crypto}/_asn1.py | 3 ++ .../{crypto => _crypto}/_obj2txt.py | 3 ++ .../{crypto => _crypto}/_objects.py | 7 +++- .../{crypto => _crypto}/_objects_data.py | 3 ++ .../module_utils/{crypto => _crypto}/basic.py | 3 ++ .../{crypto => _crypto}/cryptography_crl.py | 18 +++++++--- .../cryptography_support.py | 24 +++++++++---- .../module_utils/{crypto => _crypto}/math.py | 3 ++ .../module_backends/certificate.py | 20 ++++++----- .../module_backends/certificate_acme.py | 10 ++++-- .../module_backends/certificate_entrust.py | 18 ++++++---- .../module_backends/certificate_info.py | 26 +++++++++----- .../module_backends/certificate_ownca.py | 18 ++++++---- .../module_backends/certificate_selfsigned.py | 16 +++++---- .../module_backends/crl_info.py | 20 +++++++---- .../module_backends/csr.py | 22 +++++++----- .../module_backends/csr_info.py | 20 +++++++---- .../module_backends/privatekey.py | 20 ++++++----- .../module_backends/privatekey_convert.py | 15 ++++---- .../module_backends/privatekey_info.py | 22 +++++++----- .../module_backends/publickey_info.py | 18 ++++++---- .../module_utils/{crypto => _crypto}/pem.py | 3 ++ .../{crypto => _crypto}/support.py | 25 +++++++------- ...yptography_dep.py => _cryptography_dep.py} | 14 +++++--- plugins/module_utils/{ecs => _ecs}/api.py | 3 ++ plugins/module_utils/{gnupg => _gnupg}/cli.py | 3 ++ plugins/module_utils/{io.py => _io.py} | 3 ++ .../{openssh => _openssh}/backends/common.py | 10 ++++-- .../backends/keypair_backend.py | 13 ++++--- .../{openssh => _openssh}/certificate.py | 15 +++++--- .../{openssh => _openssh}/cryptography.py | 3 ++ .../{openssh => _openssh}/utils.py | 3 ++ .../module_utils/{serial.py => _serial.py} | 5 ++- plugins/module_utils/{time.py => _time.py} | 5 ++- .../module_utils/{version.py => _version.py} | 3 ++ plugins/module_utils/crypto/openssh.py | 13 ------- plugins/modules/acme_account.py | 6 ++-- plugins/modules/acme_account_info.py | 8 ++--- plugins/modules/acme_ari_info.py | 4 +-- plugins/modules/acme_certificate.py | 22 ++++++------ .../acme_certificate_deactivate_authz.py | 8 ++--- .../modules/acme_certificate_order_create.py | 6 ++-- .../acme_certificate_order_finalize.py | 8 ++--- .../modules/acme_certificate_order_info.py | 6 ++-- .../acme_certificate_order_validate.py | 8 ++--- .../modules/acme_certificate_renewal_info.py | 8 ++--- plugins/modules/acme_certificate_revoke.py | 8 ++--- plugins/modules/acme_challenge_cert_helper.py | 10 +++--- plugins/modules/acme_inspect.py | 4 +-- plugins/modules/certificate_complete_chain.py | 4 +-- plugins/modules/ecs_certificate.py | 8 ++--- plugins/modules/ecs_domain.py | 2 +- plugins/modules/get_certificate.py | 6 ++-- plugins/modules/openssh_cert.py | 6 ++-- plugins/modules/openssh_keypair.py | 2 +- plugins/modules/openssl_csr.py | 10 +++--- plugins/modules/openssl_csr_info.py | 4 +-- plugins/modules/openssl_csr_pipe.py | 6 ++-- plugins/modules/openssl_dhparam.py | 8 ++--- plugins/modules/openssl_pkcs12.py | 14 ++++---- plugins/modules/openssl_privatekey.py | 10 +++--- plugins/modules/openssl_privatekey_convert.py | 10 +++--- plugins/modules/openssl_privatekey_info.py | 4 +-- plugins/modules/openssl_publickey.py | 10 +++--- plugins/modules/openssl_publickey_info.py | 4 +-- plugins/modules/openssl_signature.py | 8 ++--- plugins/modules/openssl_signature_info.py | 8 ++--- plugins/modules/x509_certificate.py | 18 +++++----- plugins/modules/x509_certificate_convert.py | 11 +++--- plugins/modules/x509_certificate_info.py | 8 ++--- plugins/modules/x509_certificate_pipe.py | 12 +++---- plugins/modules/x509_crl.py | 20 +++++------ plugins/modules/x509_crl_info.py | 6 ++-- .../{action_module.py => _action_module.py} | 5 ++- .../{filter_module.py => _filter_module.py} | 3 ++ plugins/plugin_utils/{gnupg.py => _gnupg.py} | 5 ++- tests/sanity/ignore-2.17.txt | 30 ++++++++-------- tests/sanity/ignore-2.18.txt | 28 +++++++-------- tests/sanity/ignore-2.19.txt | 14 ++++---- .../{acme => _acme}/backend_data.py | 8 ++--- .../{acme => _acme}/fixtures/cert_1.pem | 0 .../fixtures/cert_1.pem.license | 0 .../{acme => _acme}/fixtures/cert_1.txt | 0 .../fixtures/cert_1.txt.license | 0 .../{acme => _acme}/fixtures/cert_2-b.txt | 0 .../fixtures/cert_2-b.txt.license | 0 .../{acme => _acme}/fixtures/cert_2.pem | 0 .../fixtures/cert_2.pem.license | 0 .../{acme => _acme}/fixtures/cert_2.txt | 0 .../fixtures/cert_2.txt.license | 0 .../{acme => _acme}/fixtures/csr_1.pem | 0 .../fixtures/csr_1.pem.license | 0 .../{acme => _acme}/fixtures/csr_1.pem.old | 0 .../fixtures/csr_1.pem.old.license | 0 .../{acme => _acme}/fixtures/csr_1.txt | 0 .../fixtures/csr_1.txt.license | 0 .../{acme => _acme}/fixtures/csr_2.pem | 0 .../fixtures/csr_2.pem.license | 0 .../{acme => _acme}/fixtures/csr_2.txt | 0 .../fixtures/csr_2.txt.license | 0 .../{acme => _acme}/fixtures/privatekey_1.pem | 0 .../fixtures/privatekey_1.pem.license | 0 .../{acme => _acme}/fixtures/privatekey_1.txt | 0 .../fixtures/privatekey_1.txt.license | 0 .../test_backend_cryptography.py | 10 +++--- .../test_backend_openssl_cli.py | 6 ++-- .../{acme => _acme}/test_challenges.py | 4 +-- .../{acme => _acme}/test_errors.py | 2 +- .../module_utils/{acme => _acme}/test_io.py | 2 +- .../{acme => _acme}/test_orders.py | 4 +-- .../{acme => _acme}/test_utils.py | 4 +-- .../{crypto => _crypto}/test_asn1.py | 2 +- .../test_cryptography_support.py | 6 ++-- .../{crypto => _crypto}/test_math.py | 2 +- .../{crypto => _crypto}/test_pem.py | 2 +- .../{openssh => _openssh}/test_certificate.py | 2 +- .../test_cryptography.py | 4 +-- .../{openssh => _openssh}/test_utils.py | 2 +- .../{test_time.py => test__time.py} | 2 +- 146 files changed, 678 insertions(+), 465 deletions(-) create mode 100644 changelogs/fragments/887-module_utils-plugin_utils.yml rename plugins/module_utils/{acme => _acme}/account.py (97%) rename plugins/module_utils/{acme => _acme}/acme.py (96%) rename plugins/module_utils/{acme => _acme}/backend_cryptography.py (93%) rename plugins/module_utils/{acme => _acme}/backend_openssl_cli.py (96%) rename plugins/module_utils/{acme => _acme}/backends.py (92%) rename plugins/module_utils/{acme => _acme}/certificate.py (91%) rename plugins/module_utils/{acme => _acme}/certificates.py (87%) rename plugins/module_utils/{acme => _acme}/challenges.py (96%) rename plugins/module_utils/{acme => _acme}/errors.py (97%) rename plugins/module_utils/{acme => _acme}/io.py (92%) rename plugins/module_utils/{acme => _acme}/orders.py (93%) rename plugins/module_utils/{acme => _acme}/utils.py (89%) rename plugins/module_utils/{argspec.py => _argspec.py} (95%) rename plugins/module_utils/{crypto => _crypto}/_asn1.py (96%) rename plugins/module_utils/{crypto => _crypto}/_obj2txt.py (93%) rename plugins/module_utils/{crypto => _crypto}/_objects.py (80%) rename plugins/module_utils/{crypto => _crypto}/_objects_data.py (99%) rename plugins/module_utils/{crypto => _crypto}/basic.py (77%) rename plugins/module_utils/{crypto => _crypto}/cryptography_crl.py (90%) rename plugins/module_utils/{crypto => _crypto}/cryptography_support.py (98%) rename plugins/module_utils/{crypto => _crypto}/math.py (96%) rename plugins/module_utils/{crypto => _crypto}/module_backends/certificate.py (94%) rename plugins/module_utils/{crypto => _crypto}/module_backends/certificate_acme.py (92%) rename plugins/module_utils/{crypto => _crypto}/module_backends/certificate_entrust.py (93%) rename plugins/module_utils/{crypto => _crypto}/module_backends/certificate_info.py (94%) rename plugins/module_utils/{crypto => _crypto}/module_backends/certificate_ownca.py (94%) rename plugins/module_utils/{crypto => _crypto}/module_backends/certificate_selfsigned.py (93%) rename plugins/module_utils/{crypto => _crypto}/module_backends/crl_info.py (81%) rename plugins/module_utils/{crypto => _crypto}/module_backends/csr.py (97%) rename plugins/module_utils/{crypto => _crypto}/module_backends/csr_info.py (94%) rename plugins/module_utils/{crypto => _crypto}/module_backends/privatekey.py (96%) rename plugins/module_utils/{crypto => _crypto}/module_backends/privatekey_convert.py (94%) rename plugins/module_utils/{crypto => _crypto}/module_backends/privatekey_info.py (93%) rename plugins/module_utils/{crypto => _crypto}/module_backends/publickey_info.py (90%) rename plugins/module_utils/{crypto => _crypto}/pem.py (96%) rename plugins/module_utils/{crypto => _crypto}/support.py (95%) rename plugins/module_utils/{cryptography_dep.py => _cryptography_dep.py} (80%) rename plugins/module_utils/{ecs => _ecs}/api.py (98%) rename plugins/module_utils/{gnupg => _gnupg}/cli.py (92%) rename plugins/module_utils/{io.py => _io.py} (95%) rename plugins/module_utils/{openssh => _openssh}/backends/common.py (97%) rename plugins/module_utils/{openssh => _openssh}/backends/keypair_backend.py (97%) rename plugins/module_utils/{openssh => _openssh}/certificate.py (97%) rename plugins/module_utils/{openssh => _openssh}/cryptography.py (99%) rename plugins/module_utils/{openssh => _openssh}/utils.py (98%) rename plugins/module_utils/{serial.py => _serial.py} (86%) rename plugins/module_utils/{time.py => _time.py} (95%) rename plugins/module_utils/{version.py => _version.py} (69%) delete mode 100644 plugins/module_utils/crypto/openssh.py rename plugins/plugin_utils/{action_module.py => _action_module.py} (97%) rename plugins/plugin_utils/{filter_module.py => _filter_module.py} (81%) rename plugins/plugin_utils/{gnupg.py => _gnupg.py} (88%) rename tests/unit/plugins/module_utils/{acme => _acme}/backend_data.py (96%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_1.pem (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_1.pem.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_1.txt (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_1.txt.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_2-b.txt (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_2-b.txt.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_2.pem (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_2.pem.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_2.txt (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/cert_2.txt.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_1.pem (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_1.pem.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_1.pem.old (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_1.pem.old.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_1.txt (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_1.txt.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_2.pem (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_2.pem.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_2.txt (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/csr_2.txt.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/privatekey_1.pem (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/privatekey_1.pem.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/privatekey_1.txt (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/fixtures/privatekey_1.txt.license (100%) rename tests/unit/plugins/module_utils/{acme => _acme}/test_backend_cryptography.py (94%) rename tests/unit/plugins/module_utils/{acme => _acme}/test_backend_openssl_cli.py (96%) rename tests/unit/plugins/module_utils/{acme => _acme}/test_challenges.py (97%) rename tests/unit/plugins/module_utils/{acme => _acme}/test_errors.py (99%) rename tests/unit/plugins/module_utils/{acme => _acme}/test_io.py (89%) rename tests/unit/plugins/module_utils/{acme => _acme}/test_orders.py (89%) rename tests/unit/plugins/module_utils/{acme => _acme}/test_utils.py (95%) rename tests/unit/plugins/module_utils/{crypto => _crypto}/test_asn1.py (98%) rename tests/unit/plugins/module_utils/{crypto => _crypto}/test_cryptography_support.py (96%) rename tests/unit/plugins/module_utils/{crypto => _crypto}/test_math.py (97%) rename tests/unit/plugins/module_utils/{crypto => _crypto}/test_pem.py (96%) rename tests/unit/plugins/module_utils/{openssh => _openssh}/test_certificate.py (99%) rename tests/unit/plugins/module_utils/{openssh => _openssh}/test_cryptography.py (98%) rename tests/unit/plugins/module_utils/{openssh => _openssh}/test_utils.py (97%) rename tests/unit/plugins/module_utils/{test_time.py => test__time.py} (99%) diff --git a/README.md b/README.md index 4096262f..a605c4cd 100644 --- a/README.md +++ b/README.md @@ -106,6 +106,6 @@ This collection is primarily licensed and distributed as a whole under the GNU G See [LICENSES/GPL-3.0-or-later.txt](https://github.com/ansible-collections/community.crypto/blob/main/COPYING) for the full text. -Parts of the collection are licensed under the [Apache 2.0 license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/Apache-2.0.txt) (`plugins/module_utils/crypto/_obj2txt.py` and `plugins/module_utils/crypto/_objects_data.py`), the [BSD 2-Clause license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/BSD-2-Clause.txt) (`plugins/module_utils/ecs/api.py`), the [BSD 3-Clause license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/BSD-3-Clause.txt) (`plugins/module_utils/crypto/_obj2txt.py`, `tests/integration/targets/prepare_jinja2_compat/filter_plugins/jinja_compatibility.py`), and the [PSF 2.0 license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/PSF-2.0.txt) (`plugins/module_utils/_version.py`). This only applies to vendored files in ``plugins/module_utils/`` and to the ECS module utils. +Parts of the collection are licensed under the [Apache 2.0 license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/Apache-2.0.txt) (`plugins/module_utils/_crypto/_obj2txt.py` and `plugins/module_utils/_crypto/_objects_data.py`), the [BSD 2-Clause license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/BSD-2-Clause.txt) (`plugins/module_utils/_ecs/api.py`), the [BSD 3-Clause license](https://github.com/ansible-collections/community.crypto/blob/main/LICENSES/BSD-3-Clause.txt) (`plugins/module_utils/_crypto/_obj2txt.py`). This only applies to vendored files in ``plugins/module_utils/`` and to the ECS module utils. All files have a machine readable `SDPX-License-Identifier:` comment denoting its respective license(s) or an equivalent entry in an accompanying `.license` file. Only changelog fragments (which will not be part of a release) are covered by a blanket statement in `REUSE.toml`. This conforms to the [REUSE specification](https://reuse.software/spec/). diff --git a/changelogs/fragments/887-module_utils-plugin_utils.yml b/changelogs/fragments/887-module_utils-plugin_utils.yml new file mode 100644 index 00000000..58378bb2 --- /dev/null +++ b/changelogs/fragments/887-module_utils-plugin_utils.yml @@ -0,0 +1,4 @@ +breaking_changes: + - "All module_utils and plugin_utils are now private to the collection and must not be used from other collections or unrelated plugins/modules. + Breaking changes in these can happen at any time, even in bugfix releases + (https://github.com/ansible-collections/community.crypto/pull/887)." diff --git a/plugins/action/openssl_privatekey_pipe.py b/plugins/action/openssl_privatekey_pipe.py index eee36e3d..6c32a17a 100644 --- a/plugins/action/openssl_privatekey_pipe.py +++ b/plugins/action/openssl_privatekey_pipe.py @@ -8,26 +8,26 @@ import base64 import typing as t from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey import ( get_privatekey_argument_spec, select_backend, ) -from ansible_collections.community.crypto.plugins.plugin_utils.action_module import ( +from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( ActionModuleBase, ) if t.TYPE_CHECKING: - from ansible_collections.community.crypto.plugins.module_utils.argspec import ( + from ansible_collections.community.crypto.plugins.module_utils._argspec import ( ArgumentSpec, ) - from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey import ( + from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey import ( PrivateKeyBackend, ) - from ansible_collections.community.crypto.plugins.plugin_utils.action_module import ( + from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( AnsibleActionModule, ) diff --git a/plugins/doc_fragments/cryptography_dep.py b/plugins/doc_fragments/cryptography_dep.py index 0b8c89db..bcd50271 100644 --- a/plugins/doc_fragments/cryptography_dep.py +++ b/plugins/doc_fragments/cryptography_dep.py @@ -9,10 +9,10 @@ class ModuleDocFragment: """ Doc fragments for cryptography requirements. - Must be kept in sync with plugins/module_utils/cryptography_dep.py. + Must be kept in sync with plugins/module_utils/_cryptography_dep.py. """ - # Corresponds to the plugins.module_utils.cryptography_dep.COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION constant + # Corresponds to the plugins.module_utils._cryptography_dep.COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION constant MINIMUM = r""" requirements: - cryptography >= 3.3 diff --git a/plugins/filter/gpg_fingerprint.py b/plugins/filter/gpg_fingerprint.py index 9d7aefcb..2714318a 100644 --- a/plugins/filter/gpg_fingerprint.py +++ b/plugins/filter/gpg_fingerprint.py @@ -43,11 +43,11 @@ import typing as t from ansible.errors import AnsibleFilterError from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.gnupg.cli import ( +from ansible_collections.community.crypto.plugins.module_utils._gnupg.cli import ( GPGError, get_fingerprint_from_bytes, ) -from ansible_collections.community.crypto.plugins.plugin_utils.gnupg import ( +from ansible_collections.community.crypto.plugins.plugin_utils._gnupg import ( PluginGPGRunner, ) diff --git a/plugins/filter/openssl_csr_info.py b/plugins/filter/openssl_csr_info.py index 7abc0028..c0bdba87 100644 --- a/plugins/filter/openssl_csr_info.py +++ b/plugins/filter/openssl_csr_info.py @@ -278,13 +278,13 @@ import typing as t from ansible.errors import AnsibleFilterError from ansible.module_utils.common.text.converters import to_bytes, to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.csr_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.csr_info import ( get_csr_info, ) -from ansible_collections.community.crypto.plugins.plugin_utils.filter_module import ( +from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( FilterModuleMock, ) diff --git a/plugins/filter/openssl_privatekey_info.py b/plugins/filter/openssl_privatekey_info.py index f7597c44..69a97d69 100644 --- a/plugins/filter/openssl_privatekey_info.py +++ b/plugins/filter/openssl_privatekey_info.py @@ -150,14 +150,14 @@ import typing as t from ansible.errors import AnsibleFilterError from ansible.module_utils.common.text.converters import to_bytes, to_text -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey_info import ( PrivateKeyParseError, get_privatekey_info, ) -from ansible_collections.community.crypto.plugins.plugin_utils.filter_module import ( +from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( FilterModuleMock, ) diff --git a/plugins/filter/openssl_publickey_info.py b/plugins/filter/openssl_publickey_info.py index 940d96ad..e92d146c 100644 --- a/plugins/filter/openssl_publickey_info.py +++ b/plugins/filter/openssl_publickey_info.py @@ -127,14 +127,14 @@ import typing as t from ansible.errors import AnsibleFilterError from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.publickey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.publickey_info import ( PublicKeyParseError, get_publickey_info, ) -from ansible_collections.community.crypto.plugins.plugin_utils.filter_module import ( +from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( FilterModuleMock, ) diff --git a/plugins/filter/parse_serial.py b/plugins/filter/parse_serial.py index 80d5afd7..f7e086a2 100644 --- a/plugins/filter/parse_serial.py +++ b/plugins/filter/parse_serial.py @@ -43,7 +43,7 @@ import typing as t from ansible.errors import AnsibleFilterError from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.crypto.plugins.module_utils.serial import ( +from ansible_collections.community.crypto.plugins.module_utils._serial import ( parse_serial, ) diff --git a/plugins/filter/split_pem.py b/plugins/filter/split_pem.py index 446db6af..d37b6e04 100644 --- a/plugins/filter/split_pem.py +++ b/plugins/filter/split_pem.py @@ -42,7 +42,7 @@ import typing as t from ansible.errors import AnsibleFilterError from ansible.module_utils.common.text.converters import to_text -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( split_pem_list, ) diff --git a/plugins/filter/to_serial.py b/plugins/filter/to_serial.py index 4549212d..f2c72b91 100644 --- a/plugins/filter/to_serial.py +++ b/plugins/filter/to_serial.py @@ -42,7 +42,7 @@ _value: import typing as t from ansible.errors import AnsibleFilterError -from ansible_collections.community.crypto.plugins.module_utils.serial import to_serial +from ansible_collections.community.crypto.plugins.module_utils._serial import to_serial def to_serial_filter(input: int) -> str: diff --git a/plugins/filter/x509_certificate_info.py b/plugins/filter/x509_certificate_info.py index dbc0a24a..6d9db836 100644 --- a/plugins/filter/x509_certificate_info.py +++ b/plugins/filter/x509_certificate_info.py @@ -312,13 +312,13 @@ import typing as t from ansible.errors import AnsibleFilterError from ansible.module_utils.common.text.converters import to_bytes, to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_info import ( get_certificate_info, ) -from ansible_collections.community.crypto.plugins.plugin_utils.filter_module import ( +from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( FilterModuleMock, ) diff --git a/plugins/filter/x509_crl_info.py b/plugins/filter/x509_crl_info.py index fedeee4e..b726972a 100644 --- a/plugins/filter/x509_crl_info.py +++ b/plugins/filter/x509_crl_info.py @@ -159,16 +159,16 @@ import typing as t from ansible.errors import AnsibleFilterError from ansible.module_utils.common.text.converters import to_bytes, to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.crl_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.crl_info import ( get_crl_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( identify_pem_format, ) -from ansible_collections.community.crypto.plugins.plugin_utils.filter_module import ( +from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( FilterModuleMock, ) diff --git a/plugins/lookup/gpg_fingerprint.py b/plugins/lookup/gpg_fingerprint.py index 8e439d7f..fde0452b 100644 --- a/plugins/lookup/gpg_fingerprint.py +++ b/plugins/lookup/gpg_fingerprint.py @@ -48,11 +48,11 @@ import typing as t from ansible.errors import AnsibleLookupError from ansible.module_utils.common.text.converters import to_native from ansible.plugins.lookup import LookupBase -from ansible_collections.community.crypto.plugins.module_utils.gnupg.cli import ( +from ansible_collections.community.crypto.plugins.module_utils._gnupg.cli import ( GPGError, get_fingerprint_from_file, ) -from ansible_collections.community.crypto.plugins.plugin_utils.gnupg import ( +from ansible_collections.community.crypto.plugins.plugin_utils._gnupg import ( PluginGPGRunner, ) diff --git a/plugins/module_utils/acme/account.py b/plugins/module_utils/_acme/account.py similarity index 97% rename from plugins/module_utils/acme/account.py rename to plugins/module_utils/_acme/account.py index b2830e27..4c86d990 100644 --- a/plugins/module_utils/acme/account.py +++ b/plugins/module_utils/_acme/account.py @@ -3,19 +3,24 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import typing as t from ansible.module_utils.common._collections_compat import Mapping -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, ModuleFailException, ) if t.TYPE_CHECKING: - from .acme import ACMEClient + from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( + ACMEClient, + ) class ACMEAccount: diff --git a/plugins/module_utils/acme/acme.py b/plugins/module_utils/_acme/acme.py similarity index 96% rename from plugins/module_utils/acme/acme.py rename to plugins/module_utils/_acme/acme.py index c14cdddb..8fbbb6c1 100644 --- a/plugins/module_utils/acme/acme.py +++ b/plugins/module_utils/_acme/acme.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import copy @@ -15,29 +18,29 @@ import typing as t from ansible.module_utils.basic import missing_required_lib from ansible.module_utils.common.text.converters import to_bytes from ansible.module_utils.urls import fetch_url -from ansible_collections.community.crypto.plugins.module_utils.acme.backend_cryptography import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.backend_cryptography import ( CRYPTOGRAPHY_ERROR, CRYPTOGRAPHY_MINIMAL_VERSION, CRYPTOGRAPHY_VERSION, HAS_CURRENT_CRYPTOGRAPHY, CryptographyBackend, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.backend_openssl_cli import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.backend_openssl_cli import ( OpenSSLCLIBackend, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, KeyParsingError, ModuleFailException, NetworkException, format_http_status, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( compute_cert_id, nopad_b64, parse_retry_after, ) -from ansible_collections.community.crypto.plugins.module_utils.argspec import ( +from ansible_collections.community.crypto.plugins.module_utils._argspec import ( ArgumentSpec, ) @@ -46,9 +49,13 @@ if t.TYPE_CHECKING: import os from ansible.module_utils.basic import AnsibleModule - - from .account import ACMEAccount - from .backends import CertificateInformation, CryptoBackend + from ansible_collections.community.crypto.plugins.module_utils._acme.account import ( + ACMEAccount, + ) + from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( + CertificateInformation, + CryptoBackend, + ) # -1 usually means connection problems diff --git a/plugins/module_utils/acme/backend_cryptography.py b/plugins/module_utils/_acme/backend_cryptography.py similarity index 93% rename from plugins/module_utils/acme/backend_cryptography.py rename to plugins/module_utils/_acme/backend_cryptography.py index f9127af9..37d28529 100644 --- a/plugins/module_utils/acme/backend_cryptography.py +++ b/plugins/module_utils/_acme/backend_cryptography.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 @@ -12,41 +15,41 @@ import traceback import typing as t from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text -from ansible_collections.community.crypto.plugins.module_utils.acme.backends import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( CertificateInformation, CryptoBackend, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.certificates import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.certificates import ( ChainMatcher, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( BackendException, KeyParsingError, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.io import read_file -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.io import read_file +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( nopad_b64, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, cryptography_name_to_oid, get_not_valid_after, get_not_valid_before, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.math import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.math import ( convert_int_to_bytes, convert_int_to_hex, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( extract_first_pem, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( parse_name_field, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( add_or_remove_timezone, ) -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) @@ -80,8 +83,10 @@ if t.TYPE_CHECKING: import datetime from ansible.module_utils.basic import AnsibleModule - - from .certificates import CertificateChain, Criterium + from ansible_collections.community.crypto.plugins.module_utils._acme.certificates import ( + CertificateChain, + Criterium, + ) class CryptographyChainMatcher(ChainMatcher): diff --git a/plugins/module_utils/acme/backend_openssl_cli.py b/plugins/module_utils/_acme/backend_openssl_cli.py similarity index 96% rename from plugins/module_utils/acme/backend_openssl_cli.py rename to plugins/module_utils/_acme/backend_openssl_cli.py index 139f8afd..0d6a104f 100644 --- a/plugins/module_utils/acme/backend_openssl_cli.py +++ b/plugins/module_utils/_acme/backend_openssl_cli.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 @@ -16,29 +19,30 @@ import traceback import typing as t from ansible.module_utils.common.text.converters import to_bytes, to_text -from ansible_collections.community.crypto.plugins.module_utils.acme.backends import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( CertificateInformation, CryptoBackend, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( BackendException, KeyParsingError, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( nopad_b64, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.math import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.math import ( convert_bytes_to_int, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( ensure_utc_timezone, ) if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - - from .certificates import Criterium + from ansible_collections.community.crypto.plugins.module_utils._acme.certificates import ( + Criterium, + ) _OPENSSL_ENVIRONMENT_UPDATE = dict(LANG="C", LC_ALL="C", LC_MESSAGES="C", LC_CTYPE="C") diff --git a/plugins/module_utils/acme/backends.py b/plugins/module_utils/_acme/backends.py similarity index 92% rename from plugins/module_utils/acme/backends.py rename to plugins/module_utils/_acme/backends.py index 2876c74f..6047711c 100644 --- a/plugins/module_utils/acme/backends.py +++ b/plugins/module_utils/_acme/backends.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -10,13 +13,13 @@ import datetime import re import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( BackendException, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( UTC, ensure_utc_timezone, from_epoch_seconds, @@ -31,8 +34,10 @@ if t.TYPE_CHECKING: import os from ansible.module_utils.basic import AnsibleModule - - from .certificates import ChainMatcher, Criterium + from ansible_collections.community.crypto.plugins.module_utils._acme.certificates import ( + ChainMatcher, + Criterium, + ) class CertificateInformation(t.NamedTuple): diff --git a/plugins/module_utils/acme/certificate.py b/plugins/module_utils/_acme/certificate.py similarity index 91% rename from plugins/module_utils/acme/certificate.py rename to plugins/module_utils/_acme/certificate.py index 0e0075b8..f08cbde9 100644 --- a/plugins/module_utils/acme/certificate.py +++ b/plugins/module_utils/_acme/certificate.py @@ -2,41 +2,51 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.account import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.account import ( ACMEAccount, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.certificates import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.certificates import ( CertificateChain, Criterium, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.challenges import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.challenges import ( Authorization, wait_for_validation, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.io import write_file -from ansible_collections.community.crypto.plugins.module_utils.acme.orders import Order -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.io import ( + write_file, +) +from ansible_collections.community.crypto.plugins.module_utils._acme.orders import Order +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( pem_to_der, ) if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - - from .backends import CryptoBackend - from .certificates import ChainMatcher - from .challenges import Challenge + from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( + CryptoBackend, + ) + from ansible_collections.community.crypto.plugins.module_utils._acme.certificates import ( + ChainMatcher, + ) + from ansible_collections.community.crypto.plugins.module_utils._acme.challenges import ( + Challenge, + ) class ACMECertificateClient: diff --git a/plugins/module_utils/acme/certificates.py b/plugins/module_utils/_acme/certificates.py similarity index 87% rename from plugins/module_utils/acme/certificates.py rename to plugins/module_utils/_acme/certificates.py index 204569e8..e364c10a 100644 --- a/plugins/module_utils/acme/certificates.py +++ b/plugins/module_utils/_acme/certificates.py @@ -3,25 +3,30 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( der_to_pem, process_links, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( split_pem_list, ) if t.TYPE_CHECKING: - from .acme import ACMEClient + from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( + ACMEClient, + ) _CertificateChain = t.TypeVar("_CertificateChain", bound="CertificateChain") diff --git a/plugins/module_utils/acme/challenges.py b/plugins/module_utils/_acme/challenges.py similarity index 96% rename from plugins/module_utils/acme/challenges.py rename to plugins/module_utils/_acme/challenges.py index 114f4681..9208b4a8 100644 --- a/plugins/module_utils/acme/challenges.py +++ b/plugins/module_utils/_acme/challenges.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 @@ -14,20 +17,21 @@ import time import typing as t from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, ModuleFailException, format_error_problem, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( nopad_b64, ) if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - - from .acme import ACMEClient + from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( + ACMEClient, + ) def create_key_authorization(client: ACMEClient, token: str) -> str: diff --git a/plugins/module_utils/acme/errors.py b/plugins/module_utils/_acme/errors.py similarity index 97% rename from plugins/module_utils/acme/errors.py rename to plugins/module_utils/_acme/errors.py index 5899e537..161733e4 100644 --- a/plugins/module_utils/acme/errors.py +++ b/plugins/module_utils/_acme/errors.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import typing as t diff --git a/plugins/module_utils/acme/io.py b/plugins/module_utils/_acme/io.py similarity index 92% rename from plugins/module_utils/acme/io.py rename to plugins/module_utils/_acme/io.py index 081056fd..6e72138b 100644 --- a/plugins/module_utils/acme/io.py +++ b/plugins/module_utils/_acme/io.py @@ -4,6 +4,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os @@ -12,7 +15,7 @@ import tempfile import traceback import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) diff --git a/plugins/module_utils/acme/orders.py b/plugins/module_utils/_acme/orders.py similarity index 93% rename from plugins/module_utils/acme/orders.py rename to plugins/module_utils/_acme/orders.py index 904031f2..b6400874 100644 --- a/plugins/module_utils/acme/orders.py +++ b/plugins/module_utils/_acme/orders.py @@ -3,26 +3,31 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import time import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.challenges import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.challenges import ( Authorization, normalize_combined_identifier, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( nopad_b64, ) if t.TYPE_CHECKING: - from .acme import ACMEClient + from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( + ACMEClient, + ) _Order = t.TypeVar("_Order", bound="Order") diff --git a/plugins/module_utils/acme/utils.py b/plugins/module_utils/_acme/utils.py similarity index 89% rename from plugins/module_utils/acme/utils.py rename to plugins/module_utils/_acme/utils.py index 9eaf49a8..e5b12a59 100644 --- a/plugins/module_utils/acme/utils.py +++ b/plugins/module_utils/_acme/utils.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 @@ -14,19 +17,22 @@ import traceback import typing as t from urllib.parse import unquote -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.math import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.math import ( convert_int_to_bytes, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_now_datetime, ) if t.TYPE_CHECKING: - from .backends import CertificateInformation, CryptoBackend + from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( + CertificateInformation, + CryptoBackend, + ) def nopad_b64(data: bytes) -> str: diff --git a/plugins/module_utils/argspec.py b/plugins/module_utils/_argspec.py similarity index 95% rename from plugins/module_utils/argspec.py rename to plugins/module_utils/_argspec.py index a0a02c8a..4d13b6a0 100644 --- a/plugins/module_utils/argspec.py +++ b/plugins/module_utils/_argspec.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import typing as t diff --git a/plugins/module_utils/crypto/_asn1.py b/plugins/module_utils/_crypto/_asn1.py similarity index 96% rename from plugins/module_utils/crypto/_asn1.py rename to plugins/module_utils/_crypto/_asn1.py index 826561e9..53b153eb 100644 --- a/plugins/module_utils/crypto/_asn1.py +++ b/plugins/module_utils/_crypto/_asn1.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import enum diff --git a/plugins/module_utils/crypto/_obj2txt.py b/plugins/module_utils/_crypto/_obj2txt.py similarity index 93% rename from plugins/module_utils/crypto/_obj2txt.py rename to plugins/module_utils/_crypto/_obj2txt.py index f1dcf95c..6f0c6246 100644 --- a/plugins/module_utils/crypto/_obj2txt.py +++ b/plugins/module_utils/_crypto/_obj2txt.py @@ -4,6 +4,9 @@ # dynamically by Ansible, still belong to the author of the module, and may assign # their own license to the complete work. +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + # This excerpt is dual licensed under the terms of the Apache License, Version # 2.0, and the BSD License. See the LICENSE file at # https://github.com/pyca/cryptography/blob/master/LICENSE for complete details. diff --git a/plugins/module_utils/crypto/_objects.py b/plugins/module_utils/_crypto/_objects.py similarity index 80% rename from plugins/module_utils/crypto/_objects.py rename to plugins/module_utils/_crypto/_objects.py index 4b0a6a42..91e2e57a 100644 --- a/plugins/module_utils/crypto/_objects.py +++ b/plugins/module_utils/_crypto/_objects.py @@ -2,9 +2,14 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations -from ._objects_data import OID_MAP +from ansible_collections.community.crypto.plugins.module_utils._crypto._objects_data import ( + OID_MAP, +) OID_LOOKUP: dict[str, str] = dict() diff --git a/plugins/module_utils/crypto/_objects_data.py b/plugins/module_utils/_crypto/_objects_data.py similarity index 99% rename from plugins/module_utils/crypto/_objects_data.py rename to plugins/module_utils/_crypto/_objects_data.py index 3c62f976..3dbea4e6 100644 --- a/plugins/module_utils/crypto/_objects_data.py +++ b/plugins/module_utils/_crypto/_objects_data.py @@ -14,6 +14,9 @@ # SPDX-License-Identifier: Apache-2.0 # https://github.com/openssl/openssl/blob/master/LICENSE.txt or LICENSES/Apache-2.0.txt +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/module_utils/crypto/basic.py b/plugins/module_utils/_crypto/basic.py similarity index 77% rename from plugins/module_utils/crypto/basic.py rename to plugins/module_utils/_crypto/basic.py index 49fad12f..13e3330d 100644 --- a/plugins/module_utils/crypto/basic.py +++ b/plugins/module_utils/_crypto/basic.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/module_utils/crypto/cryptography_crl.py b/plugins/module_utils/_crypto/cryptography_crl.py similarity index 90% rename from plugins/module_utils/crypto/cryptography_crl.py rename to plugins/module_utils/_crypto/cryptography_crl.py index 6edfaa71..f84e7453 100644 --- a/plugins/module_utils/crypto/cryptography_crl.py +++ b/plugins/module_utils/_crypto/cryptography_crl.py @@ -2,11 +2,14 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import typing as t -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion as _LooseVersion, ) @@ -18,9 +21,16 @@ except ImportError: # Error handled in the calling module. pass -from ._obj2txt import obj2txt -from .basic import HAS_CRYPTOGRAPHY -from .cryptography_support import CRYPTOGRAPHY_TIMEZONE, cryptography_decode_name +from ansible_collections.community.crypto.plugins.module_utils._crypto._obj2txt import ( + obj2txt, +) +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( + HAS_CRYPTOGRAPHY, +) +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( + CRYPTOGRAPHY_TIMEZONE, + cryptography_decode_name, +) if t.TYPE_CHECKING: diff --git a/plugins/module_utils/crypto/cryptography_support.py b/plugins/module_utils/_crypto/cryptography_support.py similarity index 98% rename from plugins/module_utils/crypto/cryptography_support.py rename to plugins/module_utils/_crypto/cryptography_support.py index bfbfd92f..fbd31f91 100644 --- a/plugins/module_utils/crypto/cryptography_support.py +++ b/plugins/module_utils/_crypto/cryptography_support.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import base64 @@ -17,12 +20,13 @@ from urllib.parse import ( ) from ansible.module_utils.common.text.converters import to_bytes, to_text -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto._asn1 import ( + serialize_asn1_string_as_der, +) +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) -from ._asn1 import serialize_asn1_string_as_der - try: import cryptography @@ -68,10 +72,16 @@ except ImportError: IDNA_IMP_ERROR = traceback.format_exc() from ansible.module_utils.basic import missing_required_lib - -from ._obj2txt import obj2txt -from ._objects import NORMALIZE_NAMES, NORMALIZE_NAMES_SHORT, OID_LOOKUP, OID_MAP -from .basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto._obj2txt import ( + obj2txt, +) +from ansible_collections.community.crypto.plugins.module_utils._crypto._objects import ( + NORMALIZE_NAMES, + NORMALIZE_NAMES_SHORT, + OID_LOOKUP, + OID_MAP, +) +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) diff --git a/plugins/module_utils/crypto/math.py b/plugins/module_utils/_crypto/math.py similarity index 96% rename from plugins/module_utils/crypto/math.py rename to plugins/module_utils/_crypto/math.py index 453a2e0a..7d51e787 100644 --- a/plugins/module_utils/crypto/math.py +++ b/plugins/module_utils/_crypto/math.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations diff --git a/plugins/module_utils/crypto/module_backends/certificate.py b/plugins/module_utils/_crypto/module_backends/certificate.py similarity index 94% rename from plugins/module_utils/crypto/module_backends/certificate.py rename to plugins/module_utils/_crypto/module_backends/certificate.py index 42827edb..a72869e9 100644 --- a/plugins/module_utils/crypto/module_backends/certificate.py +++ b/plugins/module_utils/_crypto/module_backends/certificate.py @@ -3,32 +3,35 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc import typing as t -from ansible_collections.community.crypto.plugins.module_utils.argspec import ( +from ansible_collections.community.crypto.plugins.module_utils._argspec import ( ArgumentSpec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLBadPassphraseError, OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( cryptography_compare_public_keys, get_not_valid_after, get_not_valid_before, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_info import ( get_certificate_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( load_certificate, load_certificate_privatekey, load_certificate_request, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) @@ -38,12 +41,13 @@ if t.TYPE_CHECKING: import datetime from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( + CertificatePrivateKeyTypes, + ) from cryptography.hazmat.primitives.asymmetric.types import ( CertificateIssuerPrivateKeyTypes, ) - from ..cryptography_support import CertificatePrivateKeyTypes - MINIMAL_CRYPTOGRAPHY_VERSION = COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION diff --git a/plugins/module_utils/crypto/module_backends/certificate_acme.py b/plugins/module_utils/_crypto/module_backends/certificate_acme.py similarity index 92% rename from plugins/module_utils/crypto/module_backends/certificate_acme.py rename to plugins/module_utils/_crypto/module_backends/certificate_acme.py index dc49a644..2a78d86f 100644 --- a/plugins/module_utils/crypto/module_backends/certificate_acme.py +++ b/plugins/module_utils/_crypto/module_backends/certificate_acme.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os @@ -11,7 +14,7 @@ import traceback import typing as t from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate import ( CertificateBackend, CertificateError, CertificateProvider, @@ -20,8 +23,9 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.module_bac if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - - from ...argspec import ArgumentSpec + from ansible_collections.community.crypto.plugins.module_utils._argspec import ( + ArgumentSpec, + ) class AcmeCertificateBackend(CertificateBackend): diff --git a/plugins/module_utils/crypto/module_backends/certificate_entrust.py b/plugins/module_utils/_crypto/module_backends/certificate_entrust.py similarity index 93% rename from plugins/module_utils/crypto/module_backends/certificate_entrust.py rename to plugins/module_utils/_crypto/module_backends/certificate_entrust.py index 48d3ad5e..4a24fae7 100644 --- a/plugins/module_utils/crypto/module_backends/certificate_entrust.py +++ b/plugins/module_utils/_crypto/module_backends/certificate_entrust.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import datetime @@ -10,24 +13,24 @@ import os import typing as t from ansible.module_utils.common.text.converters import to_bytes, to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, get_not_valid_after, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate import ( CertificateBackend, CertificateError, CertificateProvider, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( load_certificate, ) -from ansible_collections.community.crypto.plugins.module_utils.ecs.api import ( +from ansible_collections.community.crypto.plugins.module_utils._ecs.api import ( ECSClient, RestOperationException, SessionConfigurationException, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_now_datetime, get_relative_time_option, ) @@ -35,8 +38,9 @@ from ansible_collections.community.crypto.plugins.module_utils.time import ( if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - - from ...argspec import ArgumentSpec + from ansible_collections.community.crypto.plugins.module_utils._argspec import ( + ArgumentSpec, + ) try: diff --git a/plugins/module_utils/crypto/module_backends/certificate_info.py b/plugins/module_utils/_crypto/module_backends/certificate_info.py similarity index 94% rename from plugins/module_utils/crypto/module_backends/certificate_info.py rename to plugins/module_utils/_crypto/module_backends/certificate_info.py index 9f745fd9..de6a857f 100644 --- a/plugins/module_utils/crypto/module_backends/certificate_info.py +++ b/plugins/module_utils/_crypto/module_backends/certificate_info.py @@ -4,6 +4,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -11,7 +14,7 @@ import binascii import typing as t from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, cryptography_decode_name, cryptography_get_extensions_from_cert, @@ -19,18 +22,18 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptograp get_not_valid_after, get_not_valid_before, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.publickey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.publickey_info import ( get_publickey_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( get_fingerprint_of_bytes, load_certificate, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_now_datetime, ) @@ -39,12 +42,17 @@ if t.TYPE_CHECKING: import datetime from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.module_utils._argspec import ( + ArgumentSpec, + ) + from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( + AnsibleActionModule, + ) + from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( + FilterModuleMock, + ) from cryptography.hazmat.primitives.asymmetric.types import PublicKeyTypes - from ....plugin_utils.action_module import AnsibleActionModule - from ....plugin_utils.filter_module import FilterModuleMock - from ...argspec import ArgumentSpec - GeneralAnsibleModule = t.Union[AnsibleModule, AnsibleActionModule, FilterModuleMock] diff --git a/plugins/module_utils/crypto/module_backends/certificate_ownca.py b/plugins/module_utils/_crypto/module_backends/certificate_ownca.py similarity index 94% rename from plugins/module_utils/crypto/module_backends/certificate_ownca.py rename to plugins/module_utils/_crypto/module_backends/certificate_ownca.py index a0dde491..7ab20bb8 100644 --- a/plugins/module_utils/crypto/module_backends/certificate_ownca.py +++ b/plugins/module_utils/_crypto/module_backends/certificate_ownca.py @@ -3,16 +3,19 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os import typing as t from random import randrange -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLBadPassphraseError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, cryptography_compare_public_keys, cryptography_key_needs_digest_for_signing, @@ -23,17 +26,17 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptograp set_not_valid_after, set_not_valid_before, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate import ( CertificateBackend, CertificateError, CertificateProvider, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( load_certificate, load_certificate_issuer_privatekey, select_message_digest, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_relative_time_option, ) @@ -42,12 +45,13 @@ if t.TYPE_CHECKING: import datetime from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.module_utils._argspec import ( + ArgumentSpec, + ) from cryptography.hazmat.primitives.asymmetric.types import ( CertificateIssuerPrivateKeyTypes, ) - from ...argspec import ArgumentSpec - try: import cryptography diff --git a/plugins/module_utils/crypto/module_backends/certificate_selfsigned.py b/plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py similarity index 93% rename from plugins/module_utils/crypto/module_backends/certificate_selfsigned.py rename to plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py index 65e1bf6c..74ddde0c 100644 --- a/plugins/module_utils/crypto/module_backends/certificate_selfsigned.py +++ b/plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py @@ -3,13 +3,16 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os import typing as t from random import randrange -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, cryptography_key_needs_digest_for_signing, cryptography_verify_certificate_signature, @@ -19,15 +22,15 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptograp set_not_valid_after, set_not_valid_before, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate import ( CertificateBackend, CertificateError, CertificateProvider, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( select_message_digest, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_relative_time_option, ) @@ -36,12 +39,13 @@ if t.TYPE_CHECKING: import datetime from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.module_utils._argspec import ( + ArgumentSpec, + ) from cryptography.hazmat.primitives.asymmetric.types import ( CertificateIssuerPrivateKeyTypes, ) - from ...argspec import ArgumentSpec - try: import cryptography diff --git a/plugins/module_utils/crypto/module_backends/crl_info.py b/plugins/module_utils/_crypto/module_backends/crl_info.py similarity index 81% rename from plugins/module_utils/crypto/module_backends/crl_info.py rename to plugins/module_utils/_crypto/module_backends/crl_info.py index 07227cd2..3e8a169f 100644 --- a/plugins/module_utils/crypto/module_backends/crl_info.py +++ b/plugins/module_utils/_crypto/module_backends/crl_info.py @@ -2,23 +2,26 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import typing as t -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_crl import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_crl import ( TIMESTAMP_FORMAT, cryptography_decode_revoked_certificate, cryptography_dump_revoked, cryptography_get_signature_algorithm_oid_from_crl, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( cryptography_oid_to_name, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( identify_pem_format, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) @@ -26,13 +29,16 @@ from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( + AnsibleActionModule, + ) + from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( + FilterModuleMock, + ) from cryptography.hazmat.primitives.asymmetric.types import ( PrivateKeyTypes, ) - from ....plugin_utils.action_module import AnsibleActionModule - from ....plugin_utils.filter_module import FilterModuleMock - GeneralAnsibleModule = t.Union[AnsibleModule, AnsibleActionModule, FilterModuleMock] diff --git a/plugins/module_utils/crypto/module_backends/csr.py b/plugins/module_utils/_crypto/module_backends/csr.py similarity index 97% rename from plugins/module_utils/crypto/module_backends/csr.py rename to plugins/module_utils/_crypto/module_backends/csr.py index 90a40653..19874088 100644 --- a/plugins/module_utils/crypto/module_backends/csr.py +++ b/plugins/module_utils/_crypto/module_backends/csr.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -10,17 +13,17 @@ import binascii import typing as t from ansible.module_utils.common.text.converters import to_text -from ansible_collections.community.crypto.plugins.module_utils.argspec import ( +from ansible_collections.community.crypto.plugins.module_utils._argspec import ( ArgumentSpec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLBadPassphraseError, OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_crl import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_crl import ( REVOCATION_REASON_MAP, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( cryptography_get_basic_constraints, cryptography_get_name, cryptography_key_needs_digest_for_signing, @@ -29,17 +32,17 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptograp cryptography_parse_relative_distinguished_name, is_potential_certificate_issuer_public_key, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.csr_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.csr_info import ( get_csr_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( load_certificate_issuer_privatekey, load_certificate_request, parse_name_field, parse_ordered_name_field, select_message_digest, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) @@ -47,13 +50,14 @@ from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( + CertificatePrivateKeyTypes, + ) from cryptography.hazmat.primitives.asymmetric.types import ( CertificateIssuerPrivateKeyTypes, PrivateKeyTypes, ) - from ..cryptography_support import CertificatePrivateKeyTypes - _ET = t.TypeVar("_ET", bound="cryptography.x509.ExtensionType") diff --git a/plugins/module_utils/crypto/module_backends/csr_info.py b/plugins/module_utils/_crypto/module_backends/csr_info.py similarity index 94% rename from plugins/module_utils/crypto/module_backends/csr_info.py rename to plugins/module_utils/_crypto/module_backends/csr_info.py index 4de8ac26..4f12087c 100644 --- a/plugins/module_utils/crypto/module_backends/csr_info.py +++ b/plugins/module_utils/_crypto/module_backends/csr_info.py @@ -4,6 +4,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -11,18 +14,18 @@ import binascii import typing as t from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( cryptography_decode_name, cryptography_get_extensions_from_csr, cryptography_oid_to_name, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.publickey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.publickey_info import ( get_publickey_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( load_certificate_request, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) @@ -30,14 +33,17 @@ from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( + AnsibleActionModule, + ) + from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( + FilterModuleMock, + ) from cryptography.hazmat.primitives.asymmetric.types import ( CertificatePublicKeyTypes, PrivateKeyTypes, ) - from ....plugin_utils.action_module import AnsibleActionModule - from ....plugin_utils.filter_module import FilterModuleMock - GeneralAnsibleModule = t.Union[AnsibleModule, AnsibleActionModule, FilterModuleMock] diff --git a/plugins/module_utils/crypto/module_backends/privatekey.py b/plugins/module_utils/_crypto/module_backends/privatekey.py similarity index 96% rename from plugins/module_utils/crypto/module_backends/privatekey.py rename to plugins/module_utils/_crypto/module_backends/privatekey.py index 60fab40b..9bf87551 100644 --- a/plugins/module_utils/crypto/module_backends/privatekey.py +++ b/plugins/module_utils/_crypto/module_backends/privatekey.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -11,24 +14,24 @@ import traceback import typing as t from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.argspec import ( +from ansible_collections.community.crypto.plugins.module_utils._argspec import ( ArgumentSpec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey_info import ( PrivateKeyConsistencyError, PrivateKeyParseError, get_privatekey_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( identify_private_key_format, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( get_fingerprint_of_privatekey, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) @@ -36,12 +39,13 @@ from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( + AnsibleActionModule, + ) from cryptography.hazmat.primitives.asymmetric.types import ( PrivateKeyTypes, ) - from ....plugin_utils.action_module import AnsibleActionModule - GeneralAnsibleModule = t.Union[AnsibleModule, AnsibleActionModule] diff --git a/plugins/module_utils/crypto/module_backends/privatekey_convert.py b/plugins/module_utils/_crypto/module_backends/privatekey_convert.py similarity index 94% rename from plugins/module_utils/crypto/module_backends/privatekey_convert.py rename to plugins/module_utils/_crypto/module_backends/privatekey_convert.py index 585fb8ae..f25da944 100644 --- a/plugins/module_utils/crypto/module_backends/privatekey_convert.py +++ b/plugins/module_utils/_crypto/module_backends/privatekey_convert.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -9,23 +12,23 @@ import traceback import typing as t from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.argspec import ( +from ansible_collections.community.crypto.plugins.module_utils._argspec import ( ArgumentSpec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( cryptography_compare_private_keys, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( identify_private_key_format, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.io import load_file +from ansible_collections.community.crypto.plugins.module_utils._io import load_file if t.TYPE_CHECKING: diff --git a/plugins/module_utils/crypto/module_backends/privatekey_info.py b/plugins/module_utils/_crypto/module_backends/privatekey_info.py similarity index 93% rename from plugins/module_utils/crypto/module_backends/privatekey_info.py rename to plugins/module_utils/_crypto/module_backends/privatekey_info.py index 271a2bf1..41c53563 100644 --- a/plugins/module_utils/crypto/module_backends/privatekey_info.py +++ b/plugins/module_utils/_crypto/module_backends/privatekey_info.py @@ -4,27 +4,30 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc import typing as t from ansible.module_utils.common.text.converters import to_bytes, to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.math import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.math import ( binary_exp_mod, quick_is_not_prime, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.publickey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.publickey_info import ( _get_cryptography_public_key_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( get_fingerprint_of_bytes, load_privatekey, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) @@ -32,13 +35,16 @@ from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( + AnsibleActionModule, + ) + from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( + FilterModuleMock, + ) from cryptography.hazmat.primitives.asymmetric.types import ( PrivateKeyTypes, ) - from ....plugin_utils.action_module import AnsibleActionModule - from ....plugin_utils.filter_module import FilterModuleMock - GeneralAnsibleModule = t.Union[AnsibleModule, AnsibleActionModule, FilterModuleMock] diff --git a/plugins/module_utils/crypto/module_backends/publickey_info.py b/plugins/module_utils/_crypto/module_backends/publickey_info.py similarity index 90% rename from plugins/module_utils/crypto/module_backends/publickey_info.py rename to plugins/module_utils/_crypto/module_backends/publickey_info.py index e99a706b..7446ed9d 100644 --- a/plugins/module_utils/crypto/module_backends/publickey_info.py +++ b/plugins/module_utils/_crypto/module_backends/publickey_info.py @@ -2,19 +2,22 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc import typing as t -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( get_fingerprint_of_bytes, load_publickey, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) @@ -22,13 +25,16 @@ from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( + AnsibleActionModule, + ) + from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( + FilterModuleMock, + ) from cryptography.hazmat.primitives.asymmetric.types import ( PublicKeyTypes, ) - from ....plugin_utils.action_module import AnsibleActionModule - from ....plugin_utils.filter_module import FilterModuleMock - GeneralAnsibleModule = t.Union[AnsibleModule, AnsibleActionModule, FilterModuleMock] diff --git a/plugins/module_utils/crypto/pem.py b/plugins/module_utils/_crypto/pem.py similarity index 96% rename from plugins/module_utils/crypto/pem.py rename to plugins/module_utils/_crypto/pem.py index efa26956..b15cf0fb 100644 --- a/plugins/module_utils/crypto/pem.py +++ b/plugins/module_utils/_crypto/pem.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import typing as t diff --git a/plugins/module_utils/crypto/support.py b/plugins/module_utils/_crypto/support.py similarity index 95% rename from plugins/module_utils/crypto/support.py rename to plugins/module_utils/_crypto/support.py index 4bc7f795..e81b7363 100644 --- a/plugins/module_utils/crypto/support.py +++ b/plugins/module_utils/_crypto/support.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -11,22 +14,14 @@ import os import typing as t from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( is_potential_certificate_issuer_private_key, is_potential_certificate_private_key, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( identify_pem_format, ) -# These imports are for backwards compatibility: -from ansible_collections.community.crypto.plugins.module_utils.time import ( # noqa: F401, pylint: disable=unused-import - convert_relative_to_datetime, - ensure_utc_timezone, - get_now_datetime, - get_relative_time_option, -) - try: from cryptography import x509 @@ -36,19 +31,23 @@ except ImportError: # Error handled in the calling module. pass -from .basic import OpenSSLBadPassphraseError, OpenSSLObjectError +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( + OpenSSLBadPassphraseError, + OpenSSLObjectError, +) if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( + CertificatePrivateKeyTypes, + ) from cryptography.hazmat.primitives.asymmetric.types import ( CertificateIssuerPrivateKeyTypes, PrivateKeyTypes, PublicKeyTypes, ) - from .cryptography_support import CertificatePrivateKeyTypes - # This list of preferred fingerprints is used when prefer_one=True is supplied to the # fingerprinting methods. diff --git a/plugins/module_utils/cryptography_dep.py b/plugins/module_utils/_cryptography_dep.py similarity index 80% rename from plugins/module_utils/cryptography_dep.py rename to plugins/module_utils/_cryptography_dep.py index 12d2583d..5f67d3bf 100644 --- a/plugins/module_utils/cryptography_dep.py +++ b/plugins/module_utils/_cryptography_dep.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + """ Module utils for cryptography requirements. @@ -14,16 +17,19 @@ import traceback import typing as t from ansible.module_utils.basic import missing_required_lib -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - - from ..plugin_utils.action_module import AnsibleActionModule - from ..plugin_utils.filter_module import FilterModuleMock + from ansible_collections.community.crypto.plugins.plugin_utils._action_module import ( + AnsibleActionModule, + ) + from ansible_collections.community.crypto.plugins.plugin_utils._filter_module import ( + FilterModuleMock, + ) GeneralAnsibleModule = t.Union[AnsibleModule, AnsibleActionModule, FilterModuleMock] diff --git a/plugins/module_utils/ecs/api.py b/plugins/module_utils/_ecs/api.py similarity index 98% rename from plugins/module_utils/ecs/api.py rename to plugins/module_utils/_ecs/api.py index 8436999e..2475dac6 100644 --- a/plugins/module_utils/ecs/api.py +++ b/plugins/module_utils/_ecs/api.py @@ -8,6 +8,9 @@ # Simplified BSD License (see LICENSES/BSD-2-Clause.txt or https://opensource.org/licenses/BSD-2-Clause) # SPDX-License-Identifier: BSD-2-Clause +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import json diff --git a/plugins/module_utils/gnupg/cli.py b/plugins/module_utils/_gnupg/cli.py similarity index 92% rename from plugins/module_utils/gnupg/cli.py rename to plugins/module_utils/_gnupg/cli.py index 799d7928..0a3b0aa2 100644 --- a/plugins/module_utils/gnupg/cli.py +++ b/plugins/module_utils/_gnupg/cli.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc diff --git a/plugins/module_utils/io.py b/plugins/module_utils/_io.py similarity index 95% rename from plugins/module_utils/io.py rename to plugins/module_utils/_io.py index 73bb33d5..39d27868 100644 --- a/plugins/module_utils/io.py +++ b/plugins/module_utils/_io.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import errno diff --git a/plugins/module_utils/openssh/backends/common.py b/plugins/module_utils/_openssh/backends/common.py similarity index 97% rename from plugins/module_utils/openssh/backends/common.py rename to plugins/module_utils/_openssh/backends/common.py index a4b4b630..cac35488 100644 --- a/plugins/module_utils/openssh/backends/common.py +++ b/plugins/module_utils/_openssh/backends/common.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -10,20 +13,21 @@ import stat import traceback import typing as t -from ansible_collections.community.crypto.plugins.module_utils.openssh.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.utils import ( parse_openssh_version, ) if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule + from ansible_collections.community.crypto.plugins.module_utils._openssh.certificate import ( + OpensshCertificateTimeParameters, + ) from cryptography.hazmat.primitives.asymmetric.types import ( CertificateIssuerPrivateKeyTypes, PrivateKeyTypes, ) - from ..certificate import OpensshCertificateTimeParameters - Param = t.ParamSpec("Param") diff --git a/plugins/module_utils/openssh/backends/keypair_backend.py b/plugins/module_utils/_openssh/backends/keypair_backend.py similarity index 97% rename from plugins/module_utils/openssh/backends/keypair_backend.py rename to plugins/module_utils/_openssh/backends/keypair_backend.py index c29e4462..817bfe6a 100644 --- a/plugins/module_utils/openssh/backends/keypair_backend.py +++ b/plugins/module_utils/_openssh/backends/keypair_backend.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -11,17 +14,17 @@ import typing as t from ansible.module_utils.basic import missing_required_lib from ansible.module_utils.common.text.converters import to_bytes, to_text -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, ) -from ansible_collections.community.crypto.plugins.module_utils.openssh.backends.common import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.backends.common import ( KeygenCommand, OpensshModule, PrivateKey, PublicKey, parse_private_key_format, ) -from ansible_collections.community.crypto.plugins.module_utils.openssh.cryptography import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.cryptography import ( CRYPTOGRAPHY_VERSION, HAS_OPENSSH_SUPPORT, InvalidCommentError, @@ -30,12 +33,12 @@ from ansible_collections.community.crypto.plugins.module_utils.openssh.cryptogra OpenSSHError, OpensshKeypair, ) -from ansible_collections.community.crypto.plugins.module_utils.openssh.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.utils import ( any_in, file_mode, secure_write, ) -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/module_utils/openssh/certificate.py b/plugins/module_utils/_openssh/certificate.py similarity index 97% rename from plugins/module_utils/openssh/certificate.py rename to plugins/module_utils/_openssh/certificate.py index 40d89c59..d3234be3 100644 --- a/plugins/module_utils/openssh/certificate.py +++ b/plugins/module_utils/_openssh/certificate.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import abc @@ -14,21 +17,23 @@ from datetime import datetime from hashlib import sha256 from ansible.module_utils.common.text.converters import to_text -from ansible_collections.community.crypto.plugins.module_utils.openssh.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.utils import ( OpensshParser, _OpensshWriter, ) -from ansible_collections.community.crypto.plugins.module_utils.time import UTC as _UTC -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import UTC as _UTC +from ansible_collections.community.crypto.plugins.module_utils._time import ( add_or_remove_timezone as _add_or_remove_timezone, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( convert_relative_to_datetime, ) if t.TYPE_CHECKING: - from .cryptography import KeyType + from ansible_collections.community.crypto.plugins.module_utils._openssh.cryptography import ( + KeyType, + ) DateFormat = t.Literal["human_readable", "openssh", "timestamp"] DateFormatStr = t.Literal["human_readable", "openssh"] diff --git a/plugins/module_utils/openssh/cryptography.py b/plugins/module_utils/_openssh/cryptography.py similarity index 99% rename from plugins/module_utils/openssh/cryptography.py rename to plugins/module_utils/_openssh/cryptography.py index d0c3808f..41348ed8 100644 --- a/plugins/module_utils/openssh/cryptography.py +++ b/plugins/module_utils/_openssh/cryptography.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os diff --git a/plugins/module_utils/openssh/utils.py b/plugins/module_utils/_openssh/utils.py similarity index 98% rename from plugins/module_utils/openssh/utils.py rename to plugins/module_utils/_openssh/utils.py index 39520a1e..08de0943 100644 --- a/plugins/module_utils/openssh/utils.py +++ b/plugins/module_utils/_openssh/utils.py @@ -3,6 +3,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import os diff --git a/plugins/module_utils/serial.py b/plugins/module_utils/_serial.py similarity index 86% rename from plugins/module_utils/serial.py rename to plugins/module_utils/_serial.py index 8445cfc7..bc7f6db9 100644 --- a/plugins/module_utils/serial.py +++ b/plugins/module_utils/_serial.py @@ -2,10 +2,13 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.math import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.math import ( convert_int_to_hex, ) diff --git a/plugins/module_utils/time.py b/plugins/module_utils/_time.py similarity index 95% rename from plugins/module_utils/time.py rename to plugins/module_utils/_time.py index 29e157c4..654dd7e2 100644 --- a/plugins/module_utils/time.py +++ b/plugins/module_utils/_time.py @@ -2,13 +2,16 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import datetime import re from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) diff --git a/plugins/module_utils/version.py b/plugins/module_utils/_version.py similarity index 69% rename from plugins/module_utils/version.py rename to plugins/module_utils/_version.py index 6187bcef..653a1b05 100644 --- a/plugins/module_utils/version.py +++ b/plugins/module_utils/_version.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this module util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + """Provide version object to compare version numbers.""" from __future__ import annotations diff --git a/plugins/module_utils/crypto/openssh.py b/plugins/module_utils/crypto/openssh.py deleted file mode 100644 index 080dc897..00000000 --- a/plugins/module_utils/crypto/openssh.py +++ /dev/null @@ -1,13 +0,0 @@ -# Copyright (c) 2020, Doug Stanley -# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) -# SPDX-License-Identifier: GPL-3.0-or-later - -from __future__ import annotations - -# This import is only to maintain backwards compatibility -from ansible_collections.community.crypto.plugins.module_utils.openssh.utils import ( # noqa: F401, pylint: disable=unused-import - parse_openssh_version, -) - - -# TODO: delete! diff --git a/plugins/modules/acme_account.py b/plugins/modules/acme_account.py index 05ed2562..c437be90 100644 --- a/plugins/modules/acme_account.py +++ b/plugins/modules/acme_account.py @@ -167,15 +167,15 @@ account_uri: import base64 import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.account import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.account import ( ACMEAccount, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( KeyParsingError, ModuleFailException, ) diff --git a/plugins/modules/acme_account_info.py b/plugins/modules/acme_account_info.py index fd215cff..2d0ba0a0 100644 --- a/plugins/modules/acme_account_info.py +++ b/plugins/modules/acme_account_info.py @@ -206,18 +206,18 @@ order_uris: import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.account import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.account import ( ACMEAccount, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( process_links, ) diff --git a/plugins/modules/acme_ari_info.py b/plugins/modules/acme_ari_info.py index eec21555..09e0d931 100644 --- a/plugins/modules/acme_ari_info.py +++ b/plugins/modules/acme_ari_info.py @@ -96,12 +96,12 @@ renewal_info: import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) diff --git a/plugins/modules/acme_certificate.py b/plugins/modules/acme_certificate.py index 0df02a14..60438d4a 100644 --- a/plugins/modules/acme_certificate.py +++ b/plugins/modules/acme_certificate.py @@ -564,30 +564,32 @@ all_chains: import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.account import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.account import ( ACMEAccount, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.certificates import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.certificates import ( CertificateChain, Criterium, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.challenges import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.challenges import ( combine_identifier, normalize_combined_identifier, split_identifier, wait_for_validation, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.io import write_file -from ansible_collections.community.crypto.plugins.module_utils.acme.orders import Order -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.io import ( + write_file, +) +from ansible_collections.community.crypto.plugins.module_utils._acme.orders import Order +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( compute_cert_id, pem_to_der, ) @@ -595,11 +597,11 @@ from ansible_collections.community.crypto.plugins.module_utils.acme.utils import if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - from ansible_collections.community.crypto.plugins.module_utils.acme.backends import ( + from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( CertificateInformation, CryptoBackend, ) - from ansible_collections.community.crypto.plugins.module_utils.acme.challenges import ( + from ansible_collections.community.crypto.plugins.module_utils._acme.challenges import ( Authorization, ) diff --git a/plugins/modules/acme_certificate_deactivate_authz.py b/plugins/modules/acme_certificate_deactivate_authz.py index 842e8a45..72711246 100644 --- a/plugins/modules/acme_certificate_deactivate_authz.py +++ b/plugins/modules/acme_certificate_deactivate_authz.py @@ -53,18 +53,18 @@ RETURN = """#""" import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.account import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.account import ( ACMEAccount, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.orders import Order +from ansible_collections.community.crypto.plugins.module_utils._acme.orders import Order def main() -> t.NoReturn: diff --git a/plugins/modules/acme_certificate_order_create.py b/plugins/modules/acme_certificate_order_create.py index 02c248af..0549a768 100644 --- a/plugins/modules/acme_certificate_order_create.py +++ b/plugins/modules/acme_certificate_order_create.py @@ -373,14 +373,14 @@ account_uri: import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.certificate import ( ACMECertificateClient, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) diff --git a/plugins/modules/acme_certificate_order_finalize.py b/plugins/modules/acme_certificate_order_finalize.py index c2cc8d78..f8cc26c9 100644 --- a/plugins/modules/acme_certificate_order_finalize.py +++ b/plugins/modules/acme_certificate_order_finalize.py @@ -319,20 +319,20 @@ selected_chain: import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.certificate import ( ACMECertificateClient, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) if t.TYPE_CHECKING: - from ansible_collections.community.crypto.plugins.module_utils.acme.certificates import ( + from ansible_collections.community.crypto.plugins.module_utils._acme.certificates import ( CertificateChain, ) diff --git a/plugins/modules/acme_certificate_order_info.py b/plugins/modules/acme_certificate_order_info.py index bd6f291a..ba8838db 100644 --- a/plugins/modules/acme_certificate_order_info.py +++ b/plugins/modules/acme_certificate_order_info.py @@ -359,14 +359,14 @@ authorizations_by_status: import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.certificate import ( ACMECertificateClient, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) diff --git a/plugins/modules/acme_certificate_order_validate.py b/plugins/modules/acme_certificate_order_validate.py index 981a3dec..49cb0099 100644 --- a/plugins/modules/acme_certificate_order_validate.py +++ b/plugins/modules/acme_certificate_order_validate.py @@ -231,20 +231,20 @@ validating_challenges: import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.certificate import ( ACMECertificateClient, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) if t.TYPE_CHECKING: - from ansible_collections.community.crypto.plugins.module_utils.acme.challenges import ( + from ansible_collections.community.crypto.plugins.module_utils._acme.challenges import ( Authorization, ) diff --git a/plugins/modules/acme_certificate_renewal_info.py b/plugins/modules/acme_certificate_renewal_info.py index cdf838e3..da84cdbb 100644 --- a/plugins/modules/acme_certificate_renewal_info.py +++ b/plugins/modules/acme_certificate_renewal_info.py @@ -162,16 +162,16 @@ import os import random import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.io import read_file -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.io import read_file +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( compute_cert_id, ) diff --git a/plugins/modules/acme_certificate_revoke.py b/plugins/modules/acme_certificate_revoke.py index 95428952..81faeb75 100644 --- a/plugins/modules/acme_certificate_revoke.py +++ b/plugins/modules/acme_certificate_revoke.py @@ -112,20 +112,20 @@ RETURN = """#""" import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.account import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.account import ( ACMEAccount, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, KeyParsingError, ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( nopad_b64, pem_to_der, ) diff --git a/plugins/modules/acme_challenge_cert_helper.py b/plugins/modules/acme_challenge_cert_helper.py index 8ad70c2f..0baa7ca7 100644 --- a/plugins/modules/acme_challenge_cert_helper.py +++ b/plugins/modules/acme_challenge_cert_helper.py @@ -153,20 +153,20 @@ import typing as t from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes, to_text -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ModuleFailException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.io import read_file -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.io import read_file +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, set_not_valid_after, set_not_valid_before, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_now_datetime, ) diff --git a/plugins/modules/acme_inspect.py b/plugins/modules/acme_inspect.py index ead2c5ab..a0b2afd8 100644 --- a/plugins/modules/acme_inspect.py +++ b/plugins/modules/acme_inspect.py @@ -226,12 +226,12 @@ output_json: import typing as t from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text -from ansible_collections.community.crypto.plugins.module_utils.acme.acme import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.acme import ( ACMEClient, create_backend, create_default_argspec, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, ModuleFailException, ) diff --git a/plugins/modules/certificate_complete_chain.py b/plugins/modules/certificate_complete_chain.py index 3372ec17..428bd50d 100644 --- a/plugins/modules/certificate_complete_chain.py +++ b/plugins/modules/certificate_complete_chain.py @@ -125,10 +125,10 @@ import typing as t from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( split_pem_list, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) diff --git a/plugins/modules/ecs_certificate.py b/plugins/modules/ecs_certificate.py index dfa7bc24..61efecb9 100644 --- a/plugins/modules/ecs_certificate.py +++ b/plugins/modules/ecs_certificate.py @@ -554,20 +554,20 @@ import typing as t from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( load_certificate, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.ecs.api import ( +from ansible_collections.community.crypto.plugins.module_utils._ecs.api import ( ECSClient, RestOperationException, SessionConfigurationException, ecs_client_argument_spec, ) -from ansible_collections.community.crypto.plugins.module_utils.io import write_file +from ansible_collections.community.crypto.plugins.module_utils._io import write_file MINIMAL_CRYPTOGRAPHY_VERSION = COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION diff --git a/plugins/modules/ecs_domain.py b/plugins/modules/ecs_domain.py index c5761051..c2e68f74 100644 --- a/plugins/modules/ecs_domain.py +++ b/plugins/modules/ecs_domain.py @@ -221,7 +221,7 @@ import time import typing as t from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.ecs.api import ( +from ansible_collections.community.crypto.plugins.module_utils._ecs.api import ( ECSClient, RestOperationException, SessionConfigurationException, diff --git a/plugins/modules/get_certificate.py b/plugins/modules/get_certificate.py index 6048b5a7..f96778be 100644 --- a/plugins/modules/get_certificate.py +++ b/plugins/modules/get_certificate.py @@ -280,18 +280,18 @@ from ssl import ( from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes, to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, cryptography_get_extensions_from_cert, cryptography_oid_to_name, get_not_valid_after, get_not_valid_before, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_now_datetime, ) diff --git a/plugins/modules/openssh_cert.py b/plugins/modules/openssh_cert.py index 24fd2205..5143cdba 100644 --- a/plugins/modules/openssh_cert.py +++ b/plugins/modules/openssh_cert.py @@ -287,17 +287,17 @@ import os import typing as t from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.openssh.backends.common import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.backends.common import ( KeygenCommand, OpensshModule, PrivateKey, ) -from ansible_collections.community.crypto.plugins.module_utils.openssh.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.certificate import ( OpensshCertificate, OpensshCertificateTimeParameters, parse_option_list, ) -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/modules/openssh_keypair.py b/plugins/modules/openssh_keypair.py index 6161be44..8dd34707 100644 --- a/plugins/modules/openssh_keypair.py +++ b/plugins/modules/openssh_keypair.py @@ -201,7 +201,7 @@ comment: import typing as t from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.openssh.backends.keypair_backend import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.backends.keypair_backend import ( select_backend, ) diff --git a/plugins/modules/openssl_csr.py b/plugins/modules/openssl_csr.py index 5d0dbee5..3f7cf22e 100644 --- a/plugins/modules/openssl_csr.py +++ b/plugins/modules/openssl_csr.py @@ -241,17 +241,17 @@ csr: import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.csr import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.csr import ( get_csr_argument_spec, select_backend, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, ) -from ansible_collections.community.crypto.plugins.module_utils.io import ( +from ansible_collections.community.crypto.plugins.module_utils._io import ( load_file_if_exists, write_file, ) @@ -259,7 +259,7 @@ from ansible_collections.community.crypto.plugins.module_utils.io import ( if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.csr import ( + from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.csr import ( CertificateSigningRequestBackend, ) diff --git a/plugins/modules/openssl_csr_info.py b/plugins/modules/openssl_csr_info.py index a7abe449..72b3a0ac 100644 --- a/plugins/modules/openssl_csr_info.py +++ b/plugins/modules/openssl_csr_info.py @@ -311,10 +311,10 @@ authority_cert_serial_number: import typing as t from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.csr_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.csr_info import ( select_backend, ) diff --git a/plugins/modules/openssl_csr_pipe.py b/plugins/modules/openssl_csr_pipe.py index 35d8eb0a..d67a0076 100644 --- a/plugins/modules/openssl_csr_pipe.py +++ b/plugins/modules/openssl_csr_pipe.py @@ -129,10 +129,10 @@ csr: import typing as t -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.csr import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.csr import ( get_csr_argument_spec, select_backend, ) @@ -140,7 +140,7 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.module_bac if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.csr import ( + from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.csr import ( CertificateSigningRequestBackend, ) diff --git a/plugins/modules/openssl_dhparam.py b/plugins/modules/openssl_dhparam.py index d2ab17f1..cc1e1a22 100644 --- a/plugins/modules/openssl_dhparam.py +++ b/plugins/modules/openssl_dhparam.py @@ -136,18 +136,18 @@ import typing as t from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.math import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.math import ( count_bits, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.io import ( +from ansible_collections.community.crypto.plugins.module_utils._io import ( load_file_if_exists, write_file, ) -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) diff --git a/plugins/modules/openssl_pkcs12.py b/plugins/modules/openssl_pkcs12.py index 12671a9e..c0fb0a2c 100644 --- a/plugins/modules/openssl_pkcs12.py +++ b/plugins/modules/openssl_pkcs12.py @@ -284,26 +284,26 @@ import typing as t from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes, to_native -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLBadPassphraseError, OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( parse_pkcs12, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( split_pem_list, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, load_certificate, load_certificate_issuer_privatekey, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.io import ( +from ansible_collections.community.crypto.plugins.module_utils._io import ( load_file_if_exists, write_file, ) @@ -336,7 +336,7 @@ else: CRYPTOGRAPHY_HAS_COMPATIBILITY2022 = True if t.TYPE_CHECKING: - from ..module_utils.crypto.cryptography_support import ( + from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CertificateIssuerPrivateKeyTypes, ) diff --git a/plugins/modules/openssl_privatekey.py b/plugins/modules/openssl_privatekey.py index 6b997479..84982c82 100644 --- a/plugins/modules/openssl_privatekey.py +++ b/plugins/modules/openssl_privatekey.py @@ -157,17 +157,17 @@ privatekey: import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey import ( get_privatekey_argument_spec, select_backend, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, ) -from ansible_collections.community.crypto.plugins.module_utils.io import ( +from ansible_collections.community.crypto.plugins.module_utils._io import ( load_file_if_exists, write_file, ) @@ -175,7 +175,7 @@ from ansible_collections.community.crypto.plugins.module_utils.io import ( if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey import ( + from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey import ( PrivateKeyBackend, ) diff --git a/plugins/modules/openssl_privatekey_convert.py b/plugins/modules/openssl_privatekey_convert.py index 92179d30..ecd36bbc 100644 --- a/plugins/modules/openssl_privatekey_convert.py +++ b/plugins/modules/openssl_privatekey_convert.py @@ -62,17 +62,17 @@ backup_file: import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey_convert import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey_convert import ( get_privatekey_argument_spec, select_backend, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, ) -from ansible_collections.community.crypto.plugins.module_utils.io import ( +from ansible_collections.community.crypto.plugins.module_utils._io import ( load_file_if_exists, write_file, ) @@ -80,7 +80,7 @@ from ansible_collections.community.crypto.plugins.module_utils.io import ( if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey_convert import ( + from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey_convert import ( PrivateKeyConvertBackend, ) diff --git a/plugins/modules/openssl_privatekey_info.py b/plugins/modules/openssl_privatekey_info.py index fd74178b..af133dcd 100644 --- a/plugins/modules/openssl_privatekey_info.py +++ b/plugins/modules/openssl_privatekey_info.py @@ -203,10 +203,10 @@ private_data: import typing as t from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.privatekey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.privatekey_info import ( PrivateKeyConsistencyError, PrivateKeyParseError, select_backend, diff --git a/plugins/modules/openssl_publickey.py b/plugins/modules/openssl_publickey.py index 096f1692..7fb9356e 100644 --- a/plugins/modules/openssl_publickey.py +++ b/plugins/modules/openssl_publickey.py @@ -189,24 +189,24 @@ import os import typing as t from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLBadPassphraseError, OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.publickey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.publickey_info import ( PublicKeyParseError, get_publickey_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, get_fingerprint, load_privatekey, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.io import ( +from ansible_collections.community.crypto.plugins.module_utils._io import ( load_file_if_exists, write_file, ) diff --git a/plugins/modules/openssl_publickey_info.py b/plugins/modules/openssl_publickey_info.py index e472b980..f57ff8a1 100644 --- a/plugins/modules/openssl_publickey_info.py +++ b/plugins/modules/openssl_publickey_info.py @@ -155,10 +155,10 @@ public_data: import typing as t from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.publickey_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.publickey_info import ( PublicKeyParseError, select_backend, ) diff --git a/plugins/modules/openssl_signature.py b/plugins/modules/openssl_signature.py index df182ef2..f0a8b418 100644 --- a/plugins/modules/openssl_signature.py +++ b/plugins/modules/openssl_signature.py @@ -101,11 +101,11 @@ import base64 import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) @@ -122,10 +122,10 @@ except ImportError: CRYPTOGRAPHY_VERSION = LooseVersion("0.0") from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, load_privatekey, ) diff --git a/plugins/modules/openssl_signature_info.py b/plugins/modules/openssl_signature_info.py index 1a0ccf4d..8222e211 100644 --- a/plugins/modules/openssl_signature_info.py +++ b/plugins/modules/openssl_signature_info.py @@ -90,11 +90,11 @@ import base64 import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) @@ -111,10 +111,10 @@ except ImportError: CRYPTOGRAPHY_VERSION = LooseVersion("0.0") from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, load_certificate, ) diff --git a/plugins/modules/x509_certificate.py b/plugins/modules/x509_certificate.py index 019a5010..443e418a 100644 --- a/plugins/modules/x509_certificate.py +++ b/plugins/modules/x509_certificate.py @@ -226,33 +226,33 @@ certificate: import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate import ( get_certificate_argument_spec, select_backend, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_acme import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_acme import ( AcmeCertificateProvider, add_acme_provider_to_argument_spec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_entrust import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_entrust import ( EntrustCertificateProvider, add_entrust_provider_to_argument_spec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_ownca import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_ownca import ( OwnCACertificateProvider, add_ownca_provider_to_argument_spec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_selfsigned import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_selfsigned import ( SelfSignedCertificateProvider, add_selfsigned_provider_to_argument_spec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, ) -from ansible_collections.community.crypto.plugins.module_utils.io import ( +from ansible_collections.community.crypto.plugins.module_utils._io import ( load_file_if_exists, write_file, ) @@ -260,7 +260,7 @@ from ansible_collections.community.crypto.plugins.module_utils.io import ( if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate import ( + from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate import ( CertificateBackend, ) diff --git a/plugins/modules/x509_certificate_convert.py b/plugins/modules/x509_certificate_convert.py index 9c8d137e..a01685ae 100644 --- a/plugins/modules/x509_certificate_convert.py +++ b/plugins/modules/x509_certificate_convert.py @@ -110,10 +110,10 @@ import typing as t from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_bytes, to_text -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( PEM_END, PEM_END_START, PEM_START, @@ -121,14 +121,14 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import identify_pem_format, split_pem_list, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.io import ( +from ansible_collections.community.crypto.plugins.module_utils._io import ( load_file_if_exists, write_file, ) @@ -137,7 +137,6 @@ from ansible_collections.community.crypto.plugins.module_utils.io import ( MINIMAL_CRYPTOGRAPHY_VERSION = COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION try: - import cryptography # noqa: F401, pylint: disable=unused-import from cryptography.x509 import load_der_x509_certificate except ImportError: pass diff --git a/plugins/modules/x509_certificate_info.py b/plugins/modules/x509_certificate_info.py index 0ed1b442..d93d7d10 100644 --- a/plugins/modules/x509_certificate_info.py +++ b/plugins/modules/x509_certificate_info.py @@ -394,16 +394,16 @@ import typing as t from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_text -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_info import ( select_backend, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_relative_time_option, ) diff --git a/plugins/modules/x509_certificate_pipe.py b/plugins/modules/x509_certificate_pipe.py index f47951c3..2e7d6981 100644 --- a/plugins/modules/x509_certificate_pipe.py +++ b/plugins/modules/x509_certificate_pipe.py @@ -120,22 +120,22 @@ certificate: import typing as t -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate import ( get_certificate_argument_spec, select_backend, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_entrust import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_entrust import ( EntrustCertificateProvider, add_entrust_provider_to_argument_spec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_ownca import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_ownca import ( OwnCACertificateProvider, add_ownca_provider_to_argument_spec, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate_selfsigned import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate_selfsigned import ( SelfSignedCertificateProvider, add_selfsigned_provider_to_argument_spec, ) @@ -143,7 +143,7 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.module_bac if t.TYPE_CHECKING: from ansible.module_utils.basic import AnsibleModule - from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.certificate import ( + from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.certificate import ( CertificateBackend, ) diff --git a/plugins/modules/x509_crl.py b/plugins/modules/x509_crl.py index 8b64c961..641596c1 100644 --- a/plugins/modules/x509_crl.py +++ b/plugins/modules/x509_crl.py @@ -430,11 +430,11 @@ import typing as t from ansible.module_utils.basic import AnsibleModule from ansible.module_utils.common.text.converters import to_text from ansible.module_utils.common.validation import check_type_int, check_type_str -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLBadPassphraseError, OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_crl import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_crl import ( CRYPTOGRAPHY_TIMEZONE_INVALIDITY_DATE, REVOCATION_REASON_MAP, TIMESTAMP_FORMAT, @@ -447,7 +447,7 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptograp set_next_update, set_revocation_date, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, cryptography_decode_name, cryptography_get_name, @@ -455,13 +455,13 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptograp cryptography_name_to_oid, cryptography_oid_to_name, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.crl_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.crl_info import ( get_crl_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( identify_pem_format, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.support import ( OpenSSLObject, load_certificate, load_certificate_issuer_privatekey, @@ -469,15 +469,15 @@ from ansible_collections.community.crypto.plugins.module_utils.crypto.support im parse_ordered_name_field, select_message_digest, ) -from ansible_collections.community.crypto.plugins.module_utils.cryptography_dep import ( +from ansible_collections.community.crypto.plugins.module_utils._cryptography_dep import ( COLLECTION_MINIMUM_CRYPTOGRAPHY_VERSION, assert_required_cryptography_version, ) -from ansible_collections.community.crypto.plugins.module_utils.io import write_file -from ansible_collections.community.crypto.plugins.module_utils.serial import ( +from ansible_collections.community.crypto.plugins.module_utils._io import write_file +from ansible_collections.community.crypto.plugins.module_utils._serial import ( parse_serial, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( get_relative_time_option, ) diff --git a/plugins/modules/x509_crl_info.py b/plugins/modules/x509_crl_info.py index f58918c1..dd4a88ec 100644 --- a/plugins/modules/x509_crl_info.py +++ b/plugins/modules/x509_crl_info.py @@ -177,13 +177,13 @@ import binascii import typing as t from ansible.module_utils.basic import AnsibleModule -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.module_backends.crl_info import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.module_backends.crl_info import ( get_crl_info, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( identify_pem_format, ) diff --git a/plugins/plugin_utils/action_module.py b/plugins/plugin_utils/_action_module.py similarity index 97% rename from plugins/plugin_utils/action_module.py rename to plugins/plugin_utils/_action_module.py index 9e2b3dd5..4bbac2f1 100644 --- a/plugins/plugin_utils/action_module.py +++ b/plugins/plugin_utils/_action_module.py @@ -6,6 +6,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this plugin util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + # Parts taken from ansible.module_utils.basic and ansible.module_utils.common.warnings. # NOTE: THIS IS ONLY FOR ACTION PLUGINS! @@ -26,7 +29,7 @@ from ansible.plugins.action import ActionBase if t.TYPE_CHECKING: - from ansible_collections.community.crypto.plugins.module_utils.argspec import ( + from ansible_collections.community.crypto.plugins.module_utils._argspec import ( ArgumentSpec, ) diff --git a/plugins/plugin_utils/filter_module.py b/plugins/plugin_utils/_filter_module.py similarity index 81% rename from plugins/plugin_utils/filter_module.py rename to plugins/plugin_utils/_filter_module.py index 2b040e91..c9bff86a 100644 --- a/plugins/plugin_utils/filter_module.py +++ b/plugins/plugin_utils/_filter_module.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this plugin util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + # NOTE: THIS IS ONLY FOR FILTER PLUGINS! from __future__ import annotations diff --git a/plugins/plugin_utils/gnupg.py b/plugins/plugin_utils/_gnupg.py similarity index 88% rename from plugins/plugin_utils/gnupg.py rename to plugins/plugin_utils/_gnupg.py index a7d76f60..baa67f3c 100644 --- a/plugins/plugin_utils/gnupg.py +++ b/plugins/plugin_utils/_gnupg.py @@ -2,6 +2,9 @@ # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt) # SPDX-License-Identifier: GPL-3.0-or-later +# Note that this plugin util is **PRIVATE** to the collection. It can have breaking changes at any time. +# Do not use this from other collections or standalone plugins/modules! + from __future__ import annotations import typing as t @@ -9,7 +12,7 @@ from subprocess import PIPE, Popen from ansible.module_utils.common.process import get_bin_path from ansible.module_utils.common.text.converters import to_native -from ansible_collections.community.crypto.plugins.module_utils.gnupg.cli import ( +from ansible_collections.community.crypto.plugins.module_utils._gnupg.cli import ( GPGError, GPGRunner, ) diff --git a/tests/sanity/ignore-2.17.txt b/tests/sanity/ignore-2.17.txt index 6a8af3b7..92f3a165 100644 --- a/tests/sanity/ignore-2.17.txt +++ b/tests/sanity/ignore-2.17.txt @@ -1,18 +1,18 @@ -plugins/module_utils/acme/account.py pep8:E704 -plugins/module_utils/acme/acme.py pep8:E704 -plugins/module_utils/acme/acme.py pylint:unpacking-non-sequence -plugins/module_utils/acme/backend_openssl_cli.py pep8:E704 -plugins/module_utils/acme/certificate.py pep8:E704 -plugins/module_utils/crypto/cryptography_support.py pep8:E704 -plugins/module_utils/crypto/module_backends/certificate.py no-assert -plugins/module_utils/crypto/module_backends/certificate_entrust.py no-assert -plugins/module_utils/crypto/module_backends/certificate_ownca.py no-assert -plugins/module_utils/crypto/module_backends/certificate_selfsigned.py no-assert -plugins/module_utils/crypto/module_backends/csr.py no-assert -plugins/module_utils/crypto/module_backends/privatekey_convert.py no-assert -plugins/module_utils/crypto/support.py pep8:E704 -plugins/module_utils/openssh/backends/keypair_backend.py no-assert -plugins/module_utils/openssh/certificate.py pep8:E704 +plugins/module_utils/_acme/account.py pep8:E704 +plugins/module_utils/_acme/acme.py pep8:E704 +plugins/module_utils/_acme/acme.py pylint:unpacking-non-sequence +plugins/module_utils/_acme/backend_openssl_cli.py pep8:E704 +plugins/module_utils/_acme/certificate.py pep8:E704 +plugins/module_utils/_crypto/cryptography_support.py pep8:E704 +plugins/module_utils/_crypto/module_backends/certificate.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_entrust.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_ownca.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py no-assert +plugins/module_utils/_crypto/module_backends/csr.py no-assert +plugins/module_utils/_crypto/module_backends/privatekey_convert.py no-assert +plugins/module_utils/_crypto/support.py pep8:E704 +plugins/module_utils/_openssh/backends/keypair_backend.py no-assert +plugins/module_utils/_openssh/certificate.py pep8:E704 plugins/modules/acme_account.py pylint:unpacking-non-sequence plugins/modules/acme_account_info.py pylint:unpacking-non-sequence plugins/modules/acme_certificate.py pylint:unpacking-non-sequence diff --git a/tests/sanity/ignore-2.18.txt b/tests/sanity/ignore-2.18.txt index 0cc09ff5..45ae0ec8 100644 --- a/tests/sanity/ignore-2.18.txt +++ b/tests/sanity/ignore-2.18.txt @@ -1,17 +1,17 @@ -plugins/module_utils/acme/account.py pep8:E704 -plugins/module_utils/acme/acme.py pep8:E704 -plugins/module_utils/acme/backend_openssl_cli.py pep8:E704 -plugins/module_utils/acme/certificate.py pep8:E704 -plugins/module_utils/crypto/cryptography_support.py pep8:E704 -plugins/module_utils/crypto/module_backends/certificate.py no-assert -plugins/module_utils/crypto/module_backends/certificate_entrust.py no-assert -plugins/module_utils/crypto/module_backends/certificate_ownca.py no-assert -plugins/module_utils/crypto/module_backends/certificate_selfsigned.py no-assert -plugins/module_utils/crypto/module_backends/csr.py no-assert -plugins/module_utils/crypto/module_backends/privatekey_convert.py no-assert -plugins/module_utils/crypto/support.py pep8:E704 -plugins/module_utils/openssh/backends/keypair_backend.py no-assert -plugins/module_utils/openssh/certificate.py pep8:E704 +plugins/module_utils/_acme/account.py pep8:E704 +plugins/module_utils/_acme/acme.py pep8:E704 +plugins/module_utils/_acme/backend_openssl_cli.py pep8:E704 +plugins/module_utils/_acme/certificate.py pep8:E704 +plugins/module_utils/_crypto/cryptography_support.py pep8:E704 +plugins/module_utils/_crypto/module_backends/certificate.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_entrust.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_ownca.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py no-assert +plugins/module_utils/_crypto/module_backends/csr.py no-assert +plugins/module_utils/_crypto/module_backends/privatekey_convert.py no-assert +plugins/module_utils/_crypto/support.py pep8:E704 +plugins/module_utils/_openssh/backends/keypair_backend.py no-assert +plugins/module_utils/_openssh/certificate.py pep8:E704 plugins/modules/acme_certificate.py no-assert plugins/modules/luks_device.py no-assert plugins/modules/openssl_pkcs12.py no-assert diff --git a/tests/sanity/ignore-2.19.txt b/tests/sanity/ignore-2.19.txt index c3ea832d..3f35bdce 100644 --- a/tests/sanity/ignore-2.19.txt +++ b/tests/sanity/ignore-2.19.txt @@ -1,10 +1,10 @@ -plugins/module_utils/crypto/module_backends/certificate.py no-assert -plugins/module_utils/crypto/module_backends/certificate_entrust.py no-assert -plugins/module_utils/crypto/module_backends/certificate_ownca.py no-assert -plugins/module_utils/crypto/module_backends/certificate_selfsigned.py no-assert -plugins/module_utils/crypto/module_backends/csr.py no-assert -plugins/module_utils/crypto/module_backends/privatekey_convert.py no-assert -plugins/module_utils/openssh/backends/keypair_backend.py no-assert +plugins/module_utils/_crypto/module_backends/certificate.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_entrust.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_ownca.py no-assert +plugins/module_utils/_crypto/module_backends/certificate_selfsigned.py no-assert +plugins/module_utils/_crypto/module_backends/csr.py no-assert +plugins/module_utils/_crypto/module_backends/privatekey_convert.py no-assert +plugins/module_utils/_openssh/backends/keypair_backend.py no-assert plugins/modules/acme_certificate.py no-assert plugins/modules/luks_device.py no-assert plugins/modules/openssl_pkcs12.py no-assert diff --git a/tests/unit/plugins/module_utils/acme/backend_data.py b/tests/unit/plugins/module_utils/_acme/backend_data.py similarity index 96% rename from tests/unit/plugins/module_utils/acme/backend_data.py rename to tests/unit/plugins/module_utils/_acme/backend_data.py index de58022a..e8c20285 100644 --- a/tests/unit/plugins/module_utils/acme/backend_data.py +++ b/tests/unit/plugins/module_utils/_acme/backend_data.py @@ -9,19 +9,19 @@ import datetime import os import typing as t -from ansible_collections.community.crypto.plugins.module_utils.acme.backends import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( CertificateInformation, CryptoBackend, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( BackendException, ) -from ..test_time import TIMEZONES, cartesian_product +from ..test__time import TIMEZONES, cartesian_product if t.TYPE_CHECKING: - from ansible_collections.community.crypto.plugins.module_utils.acme.backends import ( + from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( Criterium, ) diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_1.pem b/tests/unit/plugins/module_utils/_acme/fixtures/cert_1.pem similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_1.pem rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_1.pem diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_1.pem.license b/tests/unit/plugins/module_utils/_acme/fixtures/cert_1.pem.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_1.pem.license rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_1.pem.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_1.txt b/tests/unit/plugins/module_utils/_acme/fixtures/cert_1.txt similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_1.txt rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_1.txt diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_1.txt.license b/tests/unit/plugins/module_utils/_acme/fixtures/cert_1.txt.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_1.txt.license rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_1.txt.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_2-b.txt b/tests/unit/plugins/module_utils/_acme/fixtures/cert_2-b.txt similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_2-b.txt rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_2-b.txt diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_2-b.txt.license b/tests/unit/plugins/module_utils/_acme/fixtures/cert_2-b.txt.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_2-b.txt.license rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_2-b.txt.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_2.pem b/tests/unit/plugins/module_utils/_acme/fixtures/cert_2.pem similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_2.pem rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_2.pem diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_2.pem.license b/tests/unit/plugins/module_utils/_acme/fixtures/cert_2.pem.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_2.pem.license rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_2.pem.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_2.txt b/tests/unit/plugins/module_utils/_acme/fixtures/cert_2.txt similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_2.txt rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_2.txt diff --git a/tests/unit/plugins/module_utils/acme/fixtures/cert_2.txt.license b/tests/unit/plugins/module_utils/_acme/fixtures/cert_2.txt.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/cert_2.txt.license rename to tests/unit/plugins/module_utils/_acme/fixtures/cert_2.txt.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_1.pem b/tests/unit/plugins/module_utils/_acme/fixtures/csr_1.pem similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_1.pem rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_1.pem diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_1.pem.license b/tests/unit/plugins/module_utils/_acme/fixtures/csr_1.pem.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_1.pem.license rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_1.pem.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_1.pem.old b/tests/unit/plugins/module_utils/_acme/fixtures/csr_1.pem.old similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_1.pem.old rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_1.pem.old diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_1.pem.old.license b/tests/unit/plugins/module_utils/_acme/fixtures/csr_1.pem.old.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_1.pem.old.license rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_1.pem.old.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_1.txt b/tests/unit/plugins/module_utils/_acme/fixtures/csr_1.txt similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_1.txt rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_1.txt diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_1.txt.license b/tests/unit/plugins/module_utils/_acme/fixtures/csr_1.txt.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_1.txt.license rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_1.txt.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_2.pem b/tests/unit/plugins/module_utils/_acme/fixtures/csr_2.pem similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_2.pem rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_2.pem diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_2.pem.license b/tests/unit/plugins/module_utils/_acme/fixtures/csr_2.pem.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_2.pem.license rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_2.pem.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_2.txt b/tests/unit/plugins/module_utils/_acme/fixtures/csr_2.txt similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_2.txt rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_2.txt diff --git a/tests/unit/plugins/module_utils/acme/fixtures/csr_2.txt.license b/tests/unit/plugins/module_utils/_acme/fixtures/csr_2.txt.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/csr_2.txt.license rename to tests/unit/plugins/module_utils/_acme/fixtures/csr_2.txt.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/privatekey_1.pem b/tests/unit/plugins/module_utils/_acme/fixtures/privatekey_1.pem similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/privatekey_1.pem rename to tests/unit/plugins/module_utils/_acme/fixtures/privatekey_1.pem diff --git a/tests/unit/plugins/module_utils/acme/fixtures/privatekey_1.pem.license b/tests/unit/plugins/module_utils/_acme/fixtures/privatekey_1.pem.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/privatekey_1.pem.license rename to tests/unit/plugins/module_utils/_acme/fixtures/privatekey_1.pem.license diff --git a/tests/unit/plugins/module_utils/acme/fixtures/privatekey_1.txt b/tests/unit/plugins/module_utils/_acme/fixtures/privatekey_1.txt similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/privatekey_1.txt rename to tests/unit/plugins/module_utils/_acme/fixtures/privatekey_1.txt diff --git a/tests/unit/plugins/module_utils/acme/fixtures/privatekey_1.txt.license b/tests/unit/plugins/module_utils/_acme/fixtures/privatekey_1.txt.license similarity index 100% rename from tests/unit/plugins/module_utils/acme/fixtures/privatekey_1.txt.license rename to tests/unit/plugins/module_utils/_acme/fixtures/privatekey_1.txt.license diff --git a/tests/unit/plugins/module_utils/acme/test_backend_cryptography.py b/tests/unit/plugins/module_utils/_acme/test_backend_cryptography.py similarity index 94% rename from tests/unit/plugins/module_utils/acme/test_backend_cryptography.py rename to tests/unit/plugins/module_utils/_acme/test_backend_cryptography.py index 14bc9cb1..484cf6e0 100644 --- a/tests/unit/plugins/module_utils/acme/test_backend_cryptography.py +++ b/tests/unit/plugins/module_utils/_acme/test_backend_cryptography.py @@ -11,20 +11,20 @@ from unittest.mock import ( ) import pytest -from ansible_collections.community.crypto.plugins.module_utils.acme.backend_cryptography import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.backend_cryptography import ( HAS_CURRENT_CRYPTOGRAPHY, CryptographyBackend, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( CRYPTOGRAPHY_TIMEZONE, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( UTC, ensure_utc_timezone, ) from freezegun import freeze_time -from ..test_time import TIMEZONES +from ..test__time import TIMEZONES from .backend_data import ( TEST_CERT, TEST_CERT_DAYS, @@ -37,7 +37,7 @@ from .backend_data import ( if t.TYPE_CHECKING: - from ansible_collections.community.crypto.plugins.module_utils.acme.backends import ( + from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( CertificateInformation, ) diff --git a/tests/unit/plugins/module_utils/acme/test_backend_openssl_cli.py b/tests/unit/plugins/module_utils/_acme/test_backend_openssl_cli.py similarity index 96% rename from tests/unit/plugins/module_utils/acme/test_backend_openssl_cli.py rename to tests/unit/plugins/module_utils/_acme/test_backend_openssl_cli.py index 9de4bb09..64ebc75c 100644 --- a/tests/unit/plugins/module_utils/acme/test_backend_openssl_cli.py +++ b/tests/unit/plugins/module_utils/_acme/test_backend_openssl_cli.py @@ -11,10 +11,10 @@ from unittest.mock import ( ) import pytest -from ansible_collections.community.crypto.plugins.module_utils.acme.backend_openssl_cli import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.backend_openssl_cli import ( OpenSSLCLIBackend, ) -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( UTC, ensure_utc_timezone, ) @@ -33,7 +33,7 @@ from .backend_data import ( if t.TYPE_CHECKING: - from ansible_collections.community.crypto.plugins.module_utils.acme.backends import ( + from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( CertificateInformation, ) diff --git a/tests/unit/plugins/module_utils/acme/test_challenges.py b/tests/unit/plugins/module_utils/_acme/test_challenges.py similarity index 97% rename from tests/unit/plugins/module_utils/acme/test_challenges.py rename to tests/unit/plugins/module_utils/_acme/test_challenges.py index 42ed706e..e0f0f76a 100644 --- a/tests/unit/plugins/module_utils/acme/test_challenges.py +++ b/tests/unit/plugins/module_utils/_acme/test_challenges.py @@ -10,13 +10,13 @@ from unittest.mock import ( ) import pytest -from ansible_collections.community.crypto.plugins.module_utils.acme.challenges import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.challenges import ( Authorization, Challenge, combine_identifier, split_identifier, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, ModuleFailException, ) diff --git a/tests/unit/plugins/module_utils/acme/test_errors.py b/tests/unit/plugins/module_utils/_acme/test_errors.py similarity index 99% rename from tests/unit/plugins/module_utils/acme/test_errors.py rename to tests/unit/plugins/module_utils/_acme/test_errors.py index bcc84e7e..2ee7c40a 100644 --- a/tests/unit/plugins/module_utils/acme/test_errors.py +++ b/tests/unit/plugins/module_utils/_acme/test_errors.py @@ -10,7 +10,7 @@ from unittest.mock import ( ) import pytest -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, format_error_problem, ) diff --git a/tests/unit/plugins/module_utils/acme/test_io.py b/tests/unit/plugins/module_utils/_acme/test_io.py similarity index 89% rename from tests/unit/plugins/module_utils/acme/test_io.py rename to tests/unit/plugins/module_utils/_acme/test_io.py index 522814de..8db05bfe 100644 --- a/tests/unit/plugins/module_utils/acme/test_io.py +++ b/tests/unit/plugins/module_utils/_acme/test_io.py @@ -8,7 +8,7 @@ from unittest.mock import ( MagicMock, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.io import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.io import ( read_file, write_file, ) diff --git a/tests/unit/plugins/module_utils/acme/test_orders.py b/tests/unit/plugins/module_utils/_acme/test_orders.py similarity index 89% rename from tests/unit/plugins/module_utils/acme/test_orders.py rename to tests/unit/plugins/module_utils/_acme/test_orders.py index eb9a3978..19b15888 100644 --- a/tests/unit/plugins/module_utils/acme/test_orders.py +++ b/tests/unit/plugins/module_utils/_acme/test_orders.py @@ -9,10 +9,10 @@ from unittest.mock import ( ) import pytest -from ansible_collections.community.crypto.plugins.module_utils.acme.errors import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.errors import ( ACMEProtocolException, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.orders import Order +from ansible_collections.community.crypto.plugins.module_utils._acme.orders import Order def test_order_from_json() -> None: diff --git a/tests/unit/plugins/module_utils/acme/test_utils.py b/tests/unit/plugins/module_utils/_acme/test_utils.py similarity index 95% rename from tests/unit/plugins/module_utils/acme/test_utils.py rename to tests/unit/plugins/module_utils/_acme/test_utils.py index 361bb6b7..0e7e80c0 100644 --- a/tests/unit/plugins/module_utils/acme/test_utils.py +++ b/tests/unit/plugins/module_utils/_acme/test_utils.py @@ -8,11 +8,11 @@ import datetime import typing as t import pytest -from ansible_collections.community.crypto.plugins.module_utils.acme.backends import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.backends import ( CertificateInformation, CryptoBackend, ) -from ansible_collections.community.crypto.plugins.module_utils.acme.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._acme.utils import ( compute_cert_id, nopad_b64, parse_retry_after, diff --git a/tests/unit/plugins/module_utils/crypto/test_asn1.py b/tests/unit/plugins/module_utils/_crypto/test_asn1.py similarity index 98% rename from tests/unit/plugins/module_utils/crypto/test_asn1.py rename to tests/unit/plugins/module_utils/_crypto/test_asn1.py index 2093cfaf..a1de18e3 100644 --- a/tests/unit/plugins/module_utils/crypto/test_asn1.py +++ b/tests/unit/plugins/module_utils/_crypto/test_asn1.py @@ -9,7 +9,7 @@ import re import subprocess import pytest -from ansible_collections.community.crypto.plugins.module_utils.crypto._asn1 import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto._asn1 import ( serialize_asn1_string_as_der, ) diff --git a/tests/unit/plugins/module_utils/crypto/test_cryptography_support.py b/tests/unit/plugins/module_utils/_crypto/test_cryptography_support.py similarity index 96% rename from tests/unit/plugins/module_utils/crypto/test_cryptography_support.py rename to tests/unit/plugins/module_utils/_crypto/test_cryptography_support.py index ef9df834..7023a199 100644 --- a/tests/unit/plugins/module_utils/crypto/test_cryptography_support.py +++ b/tests/unit/plugins/module_utils/_crypto/test_cryptography_support.py @@ -9,16 +9,16 @@ import typing as t import cryptography import pytest -from ansible_collections.community.crypto.plugins.module_utils.crypto.basic import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.basic import ( OpenSSLObjectError, ) -from ansible_collections.community.crypto.plugins.module_utils.crypto.cryptography_support import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.cryptography_support import ( _adjust_idn, _parse_dn, _parse_dn_component, cryptography_get_name, ) -from ansible_collections.community.crypto.plugins.module_utils.version import ( +from ansible_collections.community.crypto.plugins.module_utils._version import ( LooseVersion, ) from cryptography.x509 import NameAttribute, OtherName, oid diff --git a/tests/unit/plugins/module_utils/crypto/test_math.py b/tests/unit/plugins/module_utils/_crypto/test_math.py similarity index 97% rename from tests/unit/plugins/module_utils/crypto/test_math.py rename to tests/unit/plugins/module_utils/_crypto/test_math.py index 6ee34513..aa3f0e0d 100644 --- a/tests/unit/plugins/module_utils/crypto/test_math.py +++ b/tests/unit/plugins/module_utils/_crypto/test_math.py @@ -5,7 +5,7 @@ from __future__ import annotations import pytest -from ansible_collections.community.crypto.plugins.module_utils.crypto.math import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.math import ( binary_exp_mod, convert_bytes_to_int, convert_int_to_bytes, diff --git a/tests/unit/plugins/module_utils/crypto/test_pem.py b/tests/unit/plugins/module_utils/_crypto/test_pem.py similarity index 96% rename from tests/unit/plugins/module_utils/crypto/test_pem.py rename to tests/unit/plugins/module_utils/_crypto/test_pem.py index 15ebe6c1..0597162c 100644 --- a/tests/unit/plugins/module_utils/crypto/test_pem.py +++ b/tests/unit/plugins/module_utils/_crypto/test_pem.py @@ -7,7 +7,7 @@ from __future__ import annotations import typing as t import pytest -from ansible_collections.community.crypto.plugins.module_utils.crypto.pem import ( +from ansible_collections.community.crypto.plugins.module_utils._crypto.pem import ( extract_first_pem, identify_pem_format, identify_private_key_format, diff --git a/tests/unit/plugins/module_utils/openssh/test_certificate.py b/tests/unit/plugins/module_utils/_openssh/test_certificate.py similarity index 99% rename from tests/unit/plugins/module_utils/openssh/test_certificate.py rename to tests/unit/plugins/module_utils/_openssh/test_certificate.py index 3887e358..aebd6c6b 100644 --- a/tests/unit/plugins/module_utils/openssh/test_certificate.py +++ b/tests/unit/plugins/module_utils/_openssh/test_certificate.py @@ -5,7 +5,7 @@ from __future__ import annotations import pytest -from ansible_collections.community.crypto.plugins.module_utils.openssh.certificate import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.certificate import ( OpensshCertificate, OpensshCertificateOption, OpensshCertificateTimeParameters, diff --git a/tests/unit/plugins/module_utils/openssh/test_cryptography.py b/tests/unit/plugins/module_utils/_openssh/test_cryptography.py similarity index 98% rename from tests/unit/plugins/module_utils/openssh/test_cryptography.py rename to tests/unit/plugins/module_utils/_openssh/test_cryptography.py index 2f3fef1c..59d19059 100644 --- a/tests/unit/plugins/module_utils/openssh/test_cryptography.py +++ b/tests/unit/plugins/module_utils/_openssh/test_cryptography.py @@ -12,7 +12,7 @@ from socket import gethostname from tempfile import mkdtemp import pytest -from ansible_collections.community.crypto.plugins.module_utils.openssh.cryptography import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.cryptography import ( HAS_OPENSSH_SUPPORT, InvalidCommentError, InvalidKeySizeError, @@ -25,7 +25,7 @@ from ansible_collections.community.crypto.plugins.module_utils.openssh.cryptogra if t.TYPE_CHECKING: - from ansible_collections.community.crypto.plugins.module_utils.openssh.cryptography import ( + from ansible_collections.community.crypto.plugins.module_utils._openssh.cryptography import ( KeyType, ) diff --git a/tests/unit/plugins/module_utils/openssh/test_utils.py b/tests/unit/plugins/module_utils/_openssh/test_utils.py similarity index 97% rename from tests/unit/plugins/module_utils/openssh/test_utils.py rename to tests/unit/plugins/module_utils/_openssh/test_utils.py index c17df7f0..f3cf9b10 100644 --- a/tests/unit/plugins/module_utils/openssh/test_utils.py +++ b/tests/unit/plugins/module_utils/_openssh/test_utils.py @@ -7,7 +7,7 @@ from __future__ import annotations import typing as t import pytest -from ansible_collections.community.crypto.plugins.module_utils.openssh.utils import ( +from ansible_collections.community.crypto.plugins.module_utils._openssh.utils import ( OpensshParser, _OpensshWriter, parse_openssh_version, diff --git a/tests/unit/plugins/module_utils/test_time.py b/tests/unit/plugins/module_utils/test__time.py similarity index 99% rename from tests/unit/plugins/module_utils/test_time.py rename to tests/unit/plugins/module_utils/test__time.py index 2d7fb9ff..b7f64c24 100644 --- a/tests/unit/plugins/module_utils/test_time.py +++ b/tests/unit/plugins/module_utils/test__time.py @@ -8,7 +8,7 @@ import datetime import typing as t import pytest -from ansible_collections.community.crypto.plugins.module_utils.time import ( +from ansible_collections.community.crypto.plugins.module_utils._time import ( UTC, add_or_remove_timezone, convert_relative_to_datetime,