576 lines
56 KiB
HTML
576 lines
56 KiB
HTML
|
|
|||
|
|
|
|||
|
|
<!DOCTYPE html>
|
|||
|
|
<html class="writer-html5" lang="en" data-content_root="./">
|
|||
|
|
<head>
|
|||
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|||
|
|
<meta content="2.16.1" name="antsibull-docs" />
|
|||
|
|
|
|||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|||
|
|
<title>community.crypto.openssl_privatekey_info module – Provide information for OpenSSL private keys — Community.Crypto Collection documentation</title>
|
|||
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5707b69d" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="_static/css/ansible.css?v=c5b67dd2" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="_static/antsibull-minimal.css" />
|
|||
|
|
<link rel="stylesheet" type="text/css" href="_static/css/rtd-ethical-ads.css?v=289b023e" />
|
|||
|
|
|
|||
|
|
|
|||
|
|
<link rel="shortcut icon" href="_static/images/Ansible-Mark-RGB_Black.png"/>
|
|||
|
|
<script src="_static/jquery.js?v=5d32c60e"></script>
|
|||
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|||
|
|
<script src="_static/documentation_options.js?v=7f41d439"></script>
|
|||
|
|
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|||
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|||
|
|
<script src="_static/js/theme.js"></script>
|
|||
|
|
<link rel="search" title="Search" href="search.html" />
|
|||
|
|
<link rel="next" title="community.crypto.openssl_privatekey_pipe module – Generate OpenSSL private keys without disk access" href="openssl_privatekey_pipe_module.html" />
|
|||
|
|
<link rel="prev" title="community.crypto.openssl_privatekey_convert module – Convert OpenSSL private keys" href="openssl_privatekey_convert_module.html" /><!-- extra head elements for Ansible beyond RTD Sphinx Theme -->
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</head>
|
|||
|
|
|
|||
|
|
<body class="wy-body-for-nav"><!-- extra body elements for Ansible beyond RTD Sphinx Theme -->
|
|||
|
|
|
|||
|
|
<div class="DocSite-globalNav ansibleNav">
|
|||
|
|
<ul>
|
|||
|
|
<li><a href="https://www.ansible.com/blog" target="_blank">Blog</a></li>
|
|||
|
|
<li><a href="https://forum.ansible.com/" target="_blank">Ansible community forum</a></li>
|
|||
|
|
<li><a href="https://docs.ansible.com/" target="_blank">Documentation</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<a class="DocSite-nav" href="https://ansible-collections.github.io/community.crypto/branch/main/" style="padding-bottom: 30px;">
|
|||
|
|
|
|||
|
|
<img class="DocSiteNav-logo"
|
|||
|
|
src="_static/images/Ansible-Mark-RGB_White.png"
|
|||
|
|
alt="Ansible Logo">
|
|||
|
|
<div class="DocSiteNav-title">Community.Crypto Collection Docs</div>
|
|||
|
|
</a>
|
|||
|
|
<div class="wy-grid-for-nav">
|
|||
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|||
|
|
<div class="wy-side-scroll">
|
|||
|
|
<div class="wy-side-nav-search" >
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
<a href="index.html" class="icon icon-home">
|
|||
|
|
Community.Crypto Collection
|
|||
|
|
</a><!--- Based on https://github.com/rtfd/sphinx_rtd_theme/pull/438/files -->
|
|||
|
|
|
|||
|
|
<div class="version">
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
<div role="search">
|
|||
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|||
|
|
<label class="sr-only" for="q">Search docs:</label>
|
|||
|
|
<input type="text" class="st-default-search-input" id="q" name="q" placeholder="Search docs" />
|
|||
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|||
|
|
<input type="hidden" name="area" value="default" />
|
|||
|
|
</form>
|
|||
|
|
</div>
|
|||
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|||
|
|
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Community.Crypto Release Notes</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="docsite/guide_selfsigned.html">How to create self-signed certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="docsite/guide_ownca.html">How to create a small CA</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul class="current">
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_account_module.html">community.crypto.acme_account module – Create, modify or delete ACME accounts</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_account_info_module.html">community.crypto.acme_account_info module – Retrieves information on ACME accounts</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_ari_info_module.html">community.crypto.acme_ari_info module – Retrieves ACME Renewal Information (ARI) for a certificate</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_certificate_module.html">community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_certificate_deactivate_authz_module.html">community.crypto.acme_certificate_deactivate_authz module – Deactivate all authz for an ACME v2 order</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_certificate_renewal_info_module.html">community.crypto.acme_certificate_renewal_info module – Determine whether a certificate should be renewed or not</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_certificate_revoke_module.html">community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_challenge_cert_helper_module.html">community.crypto.acme_challenge_cert_helper module – Prepare certificates required for ACME challenges such as <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code></a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="acme_inspect_module.html">community.crypto.acme_inspect module – Send direct requests to an ACME server</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="certificate_complete_chain_module.html">community.crypto.certificate_complete_chain module – Complete certificate chain given a set of untrusted and root certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="crypto_info_module.html">community.crypto.crypto_info module – Retrieve cryptographic capabilities</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="ecs_certificate_module.html">community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="ecs_domain_module.html">community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="get_certificate_module.html">community.crypto.get_certificate module – Get a certificate from a host:port</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="luks_device_module.html">community.crypto.luks_device module – Manage encrypted (LUKS) devices</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssh_cert_module.html">community.crypto.openssh_cert module – Generate OpenSSH host or user certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssh_keypair_module.html">community.crypto.openssh_keypair module – Generate OpenSSH private and public keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_csr_module.html">community.crypto.openssl_csr module – Generate OpenSSL Certificate Signing Request (CSR)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_csr_info_module.html">community.crypto.openssl_csr_info module – Provide information of OpenSSL Certificate Signing Requests (CSR)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_csr_pipe_module.html">community.crypto.openssl_csr_pipe module – Generate OpenSSL Certificate Signing Request (CSR)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_dhparam_module.html">community.crypto.openssl_dhparam module – Generate OpenSSL Diffie-Hellman Parameters</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_pkcs12_module.html">community.crypto.openssl_pkcs12 module – Generate OpenSSL PKCS#12 archive</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_privatekey_module.html">community.crypto.openssl_privatekey module – Generate OpenSSL private keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_privatekey_convert_module.html">community.crypto.openssl_privatekey_convert module – Convert OpenSSL private keys</a></li>
|
|||
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">community.crypto.openssl_privatekey_info module – Provide information for OpenSSL private keys</a><ul>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#synopsis">Synopsis</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#requirements">Requirements</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#parameters">Parameters</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#attributes">Attributes</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#see-also">See Also</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#examples">Examples</a></li>
|
|||
|
|
<li class="toctree-l2"><a class="reference internal" href="#return-values">Return Values</a><ul>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#authors">Authors</a></li>
|
|||
|
|
<li class="toctree-l3"><a class="reference internal" href="#collection-links">Collection links</a></li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_privatekey_pipe_module.html">community.crypto.openssl_privatekey_pipe module – Generate OpenSSL private keys without disk access</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_publickey_module.html">community.crypto.openssl_publickey module – Generate an OpenSSL public key from its private key</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_publickey_info_module.html">community.crypto.openssl_publickey_info module – Provide information for OpenSSL public keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_signature_module.html">community.crypto.openssl_signature module – Sign data with openssl</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_signature_info_module.html">community.crypto.openssl_signature_info module – Verify signatures with openssl</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_certificate_module.html">community.crypto.x509_certificate module – Generate and/or check OpenSSL certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_certificate_convert_module.html">community.crypto.x509_certificate_convert module – Convert X.509 certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_certificate_info_module.html">community.crypto.x509_certificate_info module – Provide information of OpenSSL X.509 certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_certificate_pipe_module.html">community.crypto.x509_certificate_pipe module – Generate and/or check OpenSSL certificates</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_crl_module.html">community.crypto.x509_crl module – Generate Certificate Revocation Lists (CRLs)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_crl_info_module.html">community.crypto.x509_crl_info module – Retrieve information on Certificate Revocation Lists (CRLs)</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="gpg_fingerprint_filter.html">community.crypto.gpg_fingerprint filter – Retrieve a GPG fingerprint from a GPG public or private key</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_csr_info_filter.html">community.crypto.openssl_csr_info filter – Retrieve information from OpenSSL Certificate Signing Requests (CSR)</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_privatekey_info_filter.html">community.crypto.openssl_privatekey_info filter – Retrieve information from OpenSSL private keys</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="openssl_publickey_info_filter.html">community.crypto.openssl_publickey_info filter – Retrieve information from OpenSSL public keys in PEM format</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="parse_serial_filter.html">community.crypto.parse_serial filter – Convert a serial number as a colon-separated list of hex numbers to an integer</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="split_pem_filter.html">community.crypto.split_pem filter – Split PEM file contents into multiple objects</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="to_serial_filter.html">community.crypto.to_serial filter – Convert an integer to a colon-separated list of hex numbers</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_certificate_info_filter.html">community.crypto.x509_certificate_info filter – Retrieve information from X.509 certificates in PEM format</a></li>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="x509_crl_info_filter.html">community.crypto.x509_crl_info filter – Retrieve information from X.509 CRLs in PEM format</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<ul>
|
|||
|
|
<li class="toctree-l1"><a class="reference internal" href="gpg_fingerprint_lookup.html">community.crypto.gpg_fingerprint lookup – Retrieve a GPG fingerprint from a GPG public or private key file</a></li>
|
|||
|
|
</ul>
|
|||
|
|
<!-- extra nav elements for Ansible beyond RTD Sphinx Theme -->
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|||
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|||
|
|
<a href="index.html">Community.Crypto Collection</a>
|
|||
|
|
</nav>
|
|||
|
|
|
|||
|
|
<div class="wy-nav-content">
|
|||
|
|
<div class="rst-content">
|
|||
|
|
<div role="navigation" aria-label="Page navigation">
|
|||
|
|
<ul class="wy-breadcrumbs">
|
|||
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|||
|
|
<li class="breadcrumb-item active">community.crypto.openssl_privatekey_info module – Provide information for OpenSSL private keys</li>
|
|||
|
|
<li class="wy-breadcrumbs-aside">
|
|||
|
|
<!-- User defined GitHub URL -->
|
|||
|
|
<a href="https://github.com/ansible-collections/community.crypto/edit/main/plugins/modules/openssl_privatekey_info.py?description=%23%23%23%23%23%20SUMMARY%0A%3C!—%20Your%20description%20here%20–%3E%0A%0A%0A%23%23%23%23%23%20ISSUE%20TYPE%0A-%20Docs%20Pull%20Request%0A%0A%2Blabel:%20docsite_pr" class="fa fa-github"> Edit on GitHub</a>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
<hr/>
|
|||
|
|
</div>
|
|||
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|||
|
|
|
|||
|
|
|
|||
|
|
<div itemprop="articleBody">
|
|||
|
|
|
|||
|
|
<span class="target" id="ansible-collections-community-crypto-openssl-privatekey-info-module"></span><section id="community-crypto-openssl-privatekey-info-module-provide-information-for-openssl-private-keys">
|
|||
|
|
<h1>community.crypto.openssl_privatekey_info module – Provide information for OpenSSL private keys<a class="headerlink" href="#community-crypto-openssl-privatekey-info-module-provide-information-for-openssl-private-keys" title="Link to this heading"></a></h1>
|
|||
|
|
<div class="admonition note">
|
|||
|
|
<p class="admonition-title">Note</p>
|
|||
|
|
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/ui/repo/published/community/crypto/">community.crypto collection</a> (version 2.23.0).</p>
|
|||
|
|
<p>It is not included in <code class="docutils literal notranslate"><span class="pre">ansible-core</span></code>.
|
|||
|
|
To check whether it is installed, run <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">list</span></code>.</p>
|
|||
|
|
<p>To install it, use: <code class="code docutils literal notranslate"><span class="pre">ansible-galaxy</span> <span class="pre">collection</span> <span class="pre">install</span> <span class="pre">community.crypto</span></code>.
|
|||
|
|
You need further requirements to be able to use this module,
|
|||
|
|
see <a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
|||
|
|
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.crypto.openssl_privatekey_info</span></code>.</p>
|
|||
|
|
</div>
|
|||
|
|
<nav class="contents local" id="contents">
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><a class="reference internal" href="#synopsis" id="id1">Synopsis</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#requirements" id="id2">Requirements</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#parameters" id="id3">Parameters</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#attributes" id="id4">Attributes</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#see-also" id="id5">See Also</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#examples" id="id6">Examples</a></p></li>
|
|||
|
|
<li><p><a class="reference internal" href="#return-values" id="id7">Return Values</a></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</nav>
|
|||
|
|
<section id="synopsis">
|
|||
|
|
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Link to this heading"></a></h2>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>This module allows one to query information on OpenSSL private keys.</p></li>
|
|||
|
|
<li><p>In case the key consistency checks fail, the module will fail as this indicates a faked private key. In this case, all return variables are still returned. Note that key consistency checks are not available all key types; if none is available, <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> is returned for <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-key-is-consistent"><span class="std std-ref"><span class="pre">key_is_consistent</span></span></a></code>.</p></li>
|
|||
|
|
<li><p>It uses the cryptography python library to interact with OpenSSL.</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section id="requirements">
|
|||
|
|
<span id="ansible-collections-community-crypto-openssl-privatekey-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Link to this heading"></a></h2>
|
|||
|
|
<p>The below requirements are needed on the host that executes this module.</p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>cryptography >= 1.2.3</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section id="parameters">
|
|||
|
|
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Parameters</a><a class="headerlink" href="#parameters" title="Link to this heading"></a></h2>
|
|||
|
|
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Parameter</p></th>
|
|||
|
|
<th class="head"><p>Comments</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-check_consistency"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-check-consistency"><strong>check_consistency</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-check_consistency" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
<p><em class="ansible-option-versionadded">added in community.crypto 2.0.0</em></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Whether to check consistency of the private key.</p>
|
|||
|
|
<p>In community.crypto < 2.0.0, consistency was always checked.</p>
|
|||
|
|
<p>Since community.crypto 2.0.0, the consistency check has been disabled by default to avoid private key material to be transported around and computed with, and only do so when requested explicitly. This can potentially prevent <a class="reference external" href="https://en.wikipedia.org/wiki/Side-channel_attack">side-channel attacks</a>.</p>
|
|||
|
|
<p>Note that consistency checks only work for certain key types, and might depend on the version of the cryptography library. For example, with cryptography 42.0.0 and newer consistency of RSA keys can no longer be checked.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-content"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-content"><strong>content</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-content" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
<p><em class="ansible-option-versionadded">added in community.crypto 1.0.0</em></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Content of the private key file.</p>
|
|||
|
|
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-content"><span class="std std-ref"><span class="pre">content</span></span></a></strong></code> must be specified, but not both.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-passphrase"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-passphrase"><strong>passphrase</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-passphrase" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The passphrase for the private key.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-path"><strong>path</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Remote absolute path where the private key file is loaded from.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-return_private_key_data"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-return-private-key-data"><strong>return_private_key_data</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-return_private_key_data" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Whether to return private key data.</p>
|
|||
|
|
<p>Only set this to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> when you want private information about this key to leave the remote machine.</p>
|
|||
|
|
<p><strong>WARNING:</strong> you have to make sure that private key data is not accidentally logged!</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="parameter-select_crypto_backend"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-select-crypto-backend"><strong>select_crypto_backend</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#parameter-select_crypto_backend" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Determines which crypto backend to use.</p>
|
|||
|
|
<p>The default choice is <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code>, which tries to use <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> if available.</p>
|
|||
|
|
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">cryptography</span></code>, will try to use the <a class="reference external" href="https://cryptography.io/">cryptography</a> library.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">"auto"</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
|||
|
|
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"cryptography"</span></code></p></li>
|
|||
|
|
</ul>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</section>
|
|||
|
|
<section id="attributes">
|
|||
|
|
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Attributes</a><a class="headerlink" href="#attributes" title="Link to this heading"></a></h2>
|
|||
|
|
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Attribute</p></th>
|
|||
|
|
<th class="head"><p>Support</p></th>
|
|||
|
|
<th class="head"><p>Description</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-attribute-check-mode"><strong>check_mode</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#attribute-check_mode" title="Permalink to this attribute"></a></div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong><strong class="ansible-attribute-support-full">full</strong></p>
|
|||
|
|
<p>This action does not modify state.</p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Can run in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code> and return changed status prediction without modifying target.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="attribute-diff_mode"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-attribute-diff-mode"><strong>diff_mode</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#attribute-diff_mode" title="Permalink to this attribute"></a></div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p><strong class="ansible-attribute-support-label">Support: </strong> <span class="ansible-attribute-support-na">N/A</span></p>
|
|||
|
|
<p>This action does not modify state.</p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Will return details on what has changed (or possibly needs changing in <code class="docutils literal notranslate"><span class="pre">check_mode</span></code>), when in diff mode.</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</section>
|
|||
|
|
<section id="see-also">
|
|||
|
|
<h2><a class="toc-backref" href="#id5" role="doc-backlink">See Also</a><a class="headerlink" href="#see-also" title="Link to this heading"></a></h2>
|
|||
|
|
<div class="admonition seealso">
|
|||
|
|
<p class="admonition-title">See also</p>
|
|||
|
|
<dl class="simple">
|
|||
|
|
<dt><a class="reference internal" href="openssl_privatekey_module.html#ansible-collections-community-crypto-openssl-privatekey-module"><span class="std std-ref">community.crypto.openssl_privatekey</span></a></dt><dd><p>Generate OpenSSL private keys.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt><a class="reference internal" href="openssl_privatekey_pipe_module.html#ansible-collections-community-crypto-openssl-privatekey-pipe-module"><span class="std std-ref">community.crypto.openssl_privatekey_pipe</span></a></dt><dd><p>Generate OpenSSL private keys without disk access.</p>
|
|||
|
|
</dd>
|
|||
|
|
<dt><a class="reference internal" href="openssl_privatekey_info_filter.html#ansible-collections-community-crypto-openssl-privatekey-info-filter"><span class="std std-ref">community.crypto.openssl_privatekey_info</span></a> filter plugin</dt><dd><p>A filter variant of this module.</p>
|
|||
|
|
</dd>
|
|||
|
|
</dl>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section id="examples">
|
|||
|
|
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Link to this heading"></a></h2>
|
|||
|
|
<div class="highlight-yaml+jinja notranslate"><div class="highlight"><pre><span></span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Generate an OpenSSL private key with the default values (4096 bits, RSA)</span>
|
|||
|
|
<span class="w"> </span><span class="nt">community.crypto.openssl_privatekey</span><span class="p">:</span>
|
|||
|
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/private/ansible.com.pem</span>
|
|||
|
|
|
|||
|
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Get information on generated key</span>
|
|||
|
|
<span class="w"> </span><span class="nt">community.crypto.openssl_privatekey_info</span><span class="p">:</span>
|
|||
|
|
<span class="w"> </span><span class="nt">path</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/private/ansible.com.pem</span>
|
|||
|
|
<span class="w"> </span><span class="nt">register</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result</span>
|
|||
|
|
|
|||
|
|
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Dump information</span>
|
|||
|
|
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
|||
|
|
<span class="w"> </span><span class="nt">var</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result</span>
|
|||
|
|
</pre></div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
<section id="return-values">
|
|||
|
|
<h2><a class="toc-backref" href="#id7" role="doc-backlink">Return Values</a><a class="headerlink" href="#return-values" title="Link to this heading"></a></h2>
|
|||
|
|
<p>Common return values are documented <a class="reference external" href="https://docs.ansible.com/ansible/devel/reference_appendices/common_return_values.html#common-return-values" title="(in Ansible vdevel)"><span class="xref std std-ref">here</span></a>, the following are the fields unique to this module:</p>
|
|||
|
|
<table class="longtable ansible-option-table docutils align-default" style="width: 100%">
|
|||
|
|
<thead>
|
|||
|
|
<tr class="row-odd"><th class="head"><p>Key</p></th>
|
|||
|
|
<th class="head"><p>Description</p></th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-can_load_key"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-can-load-key"><strong>can_load_key</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-can_load_key" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Whether the module was able to load the private key from disk.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-can_parse_key"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-can-parse-key"><strong>can_parse_key</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-can_parse_key" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Whether the module was able to parse the private key.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> always</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-key_is_consistent"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-key-is-consistent"><strong>key_is_consistent</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-key_is_consistent" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Whether the key is consistent. Can also return <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> next to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>, to indicate that consistency could not be checked.</p>
|
|||
|
|
<p>In case the check returns <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>, the module will fail.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-check-consistency"><span class="std std-ref"><span class="pre">check_consistency=true</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-private_data"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-private-data"><strong>private_data</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-private_data" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Private key data. Depends on key type.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success and when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-parameter-return-private-key-data"><span class="std std-ref"><span class="pre">return_private_key_data</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data"><strong>public_data</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Public key data. Depends on key type.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/curve"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-curve"><strong>curve</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/curve" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The curve’s name for ECC.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=ECC</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/exponent"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-exponent"><strong>exponent</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/exponent" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s public exponent.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=RSA</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/exponent_size"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-exponent-size"><strong>exponent_size</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/exponent_size" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The maximum number of bits of a private key. This is basically the bit size of the subgroup used.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=ECC</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/g"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-g"><strong>g</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/g" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The <code class="docutils literal notranslate"><span class="pre">g</span></code> value for DSA.</p>
|
|||
|
|
<p>This is the element spanning the subgroup of the multiplicative group of the prime field used.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=DSA</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/modulus"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-modulus"><strong>modulus</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/modulus" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s modulus.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=RSA</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/p"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-p"><strong>p</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/p" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The <code class="docutils literal notranslate"><span class="pre">p</span></code> value for DSA.</p>
|
|||
|
|
<p>This is the prime modulus upon which arithmetic takes place.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=DSA</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/q"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-q"><strong>q</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/q" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The <code class="docutils literal notranslate"><span class="pre">q</span></code> value for DSA.</p>
|
|||
|
|
<p>This is a prime that divides <code class="docutils literal notranslate"><span class="pre">p</span> <span class="pre">-</span> <span class="pre">1</span></code>, and at the same time the order of the subgroup of the multiplicative group of the prime field used.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=DSA</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/size"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-size"><strong>size</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/size" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Bit size of modulus (RSA) or prime number (DSA).</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=RSA</span></span></a></code> or <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=DSA</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/x"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-x"><strong>x</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/x" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The <code class="docutils literal notranslate"><span class="pre">x</span></code> coordinate for the public point on the elliptic curve.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=ECC</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_data/y"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-data-y"><strong>y</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_data/y" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>For <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=ECC</span></span></a></code>, this is the <code class="docutils literal notranslate"><span class="pre">y</span></code> coordinate for the public point on the elliptic curve.</p>
|
|||
|
|
<p>For <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=DSA</span></span></a></code>, this is the publicly known group element whose discrete logarithm w.r.t. <code class="docutils literal notranslate"><span class="pre">g</span></code> is the private key.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=DSA</span></span></a></code> or <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><span class="std std-ref"><span class="pre">type=ECC</span></span></a></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_key"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-key"><strong>public_key</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_key" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Private key’s public key in PEM format.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"-----BEGIN</span> <span class="pre">PUBLIC</span> <span class="pre">KEY-----\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8A..."</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-even"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-public_key_fingerprints"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-public-key-fingerprints"><strong>public_key_fingerprints</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-public_key_fingerprints" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>Fingerprints of private key’s public key.</p>
|
|||
|
|
<p>For every hash algorithm available, the fingerprint is computed.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"{'sha256':</span> <span class="pre">'d4:b3:aa:6d:c8:04:ce:4e:ba:f6:29:4d:92:a3:94:b0:c2:ff:bd:bf:33:63:11:43:34:0f:51:b0:95:09:2f:63',</span> <span class="pre">'sha512':</span> <span class="pre">'f7:07:4a:f0:b0:f0:e6:8b:95:5f:f9:e6:61:0a:32:68:f1..."</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr class="row-odd"><td><div class="ansible-option-cell">
|
|||
|
|
<div class="ansibleOptionAnchor" id="return-type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-module-return-type"><strong>type</strong></p>
|
|||
|
|
<a class="ansibleOptionLink" href="#return-type" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
|||
|
|
</div></td>
|
|||
|
|
<td><div class="ansible-option-cell"><p>The key’s type.</p>
|
|||
|
|
<p>One of <code class="ansible-value docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="ansible-value docutils literal notranslate"><span class="pre">X448</span></code>.</p>
|
|||
|
|
<p>Will start with <code class="ansible-value docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</p>
|
|||
|
|
<p class="ansible-option-line"><strong class="ansible-option-returned-bold">Returned:</strong> success</p>
|
|||
|
|
<p class="ansible-option-line ansible-option-sample"><strong class="ansible-option-sample-bold">Sample:</strong> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
|||
|
|
</div></td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
<section id="authors">
|
|||
|
|
<h3>Authors<a class="headerlink" href="#authors" title="Link to this heading"></a></h3>
|
|||
|
|
<ul class="simple">
|
|||
|
|
<li><p>Felix Fontein (@felixfontein)</p></li>
|
|||
|
|
<li><p>Yanis Guenane (@Spredzy)</p></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
<section id="collection-links">
|
|||
|
|
<h3>Collection links<a class="headerlink" href="#collection-links" title="Link to this heading"></a></h3>
|
|||
|
|
<ul class="ansible-links">
|
|||
|
|
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.crypto/issues" rel="noopener external" target="_blank">Issue Tracker</a></span></li>
|
|||
|
|
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.crypto" rel="noopener external" target="_blank">Repository (Sources)</a></span></li>
|
|||
|
|
<li><span><a aria-role="button" class="ansible-link reference external" href="https://forum.ansible.com/tags/c/help/6/none/crypto" rel="noopener external" target="_blank">Ask for help (crypto)</a></span></li>
|
|||
|
|
<li><span><a aria-role="button" class="ansible-link reference external" href="https://forum.ansible.com/tags/c/help/6/none/acme" rel="noopener external" target="_blank">Ask for help (ACME)</a></span></li>
|
|||
|
|
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.crypto/issues/new?assignees=&labels=&template=bug_report.md" rel="noopener external" target="_blank">Submit a bug report</a></span></li>
|
|||
|
|
<li><span><a aria-role="button" class="ansible-link reference external" href="https://github.com/ansible-collections/community.crypto/issues/new?assignees=&labels=&template=feature_request.md" rel="noopener external" target="_blank">Request a feature</a></span></li>
|
|||
|
|
<li><span><a class="reference internal" href="index.html#communication-for-community-crypto"><span class="std std-ref">Communication</span></a></span></li>
|
|||
|
|
</ul>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
</section>
|
|||
|
|
|
|||
|
|
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|||
|
|
<a href="openssl_privatekey_convert_module.html" class="btn btn-neutral float-left" title="community.crypto.openssl_privatekey_convert module – Convert OpenSSL private keys" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|||
|
|
<a href="openssl_privatekey_pipe_module.html" class="btn btn-neutral float-right" title="community.crypto.openssl_privatekey_pipe module – Generate OpenSSL private keys without disk access" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
<hr/>
|
|||
|
|
|
|||
|
|
<div role="contentinfo">
|
|||
|
|
<p>© Copyright Community.Crypto Contributors.</p>
|
|||
|
|
</div>
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
</footer>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</section>
|
|||
|
|
</div>
|
|||
|
|
<script>
|
|||
|
|
jQuery(function () {
|
|||
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|||
|
|
});
|
|||
|
|
</script><!-- extra footer elements for Ansible beyond RTD Sphinx Theme -->
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|