mirror of
https://github.com/ansible-collections/community.crypto.git
synced 2026-04-14 04:41:09 +00:00
deploy: 8fa4dc75c9
This commit is contained in:
123
pr/600/_static/_sphinx_javascript_frameworks_compat.js
Normal file
123
pr/600/_static/_sphinx_javascript_frameworks_compat.js
Normal file
@@ -0,0 +1,123 @@
|
||||
/* Compatability shim for jQuery and underscores.js.
|
||||
*
|
||||
* Copyright Sphinx contributors
|
||||
* Released under the two clause BSD licence
|
||||
*/
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*
|
||||
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
if (!x) {
|
||||
return x
|
||||
}
|
||||
return decodeURIComponent(x.replace(/\+/g, ' '));
|
||||
};
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s === 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node, addItems) {
|
||||
if (node.nodeType === 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 &&
|
||||
!jQuery(node.parentNode).hasClass(className) &&
|
||||
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||
var span;
|
||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.className = className;
|
||||
}
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
}
|
||||
}
|
||||
var addItems = [];
|
||||
var result = this.each(function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
for (var i = 0; i < addItems.length; ++i) {
|
||||
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
@@ -471,9 +471,10 @@ tr .ansibleOptionLink {
|
||||
}
|
||||
/*
|
||||
* Without this,
|
||||
* for example most links in the page's TOC aren't usable anymore
|
||||
* for example most links in the page's TOC aren't usable anymore, and tables
|
||||
* sometimes overlap the text above
|
||||
* */
|
||||
section a[id] {
|
||||
section a[id], section table[id] {
|
||||
padding-top: 0;
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
File diff suppressed because one or more lines are too long
2
pr/600/_static/jquery.js
vendored
Normal file
2
pr/600/_static/jquery.js
vendored
Normal file
File diff suppressed because one or more lines are too long
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -147,7 +149,7 @@
|
||||
<h1>community.crypto.acme_account_facts<a class="headerlink" href="#community-crypto-acme-account-facts" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This plugin was part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This plugin was part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</p>
|
||||
</div>
|
||||
<p>This module has been removed
|
||||
in version 2.0.0 of community.crypto.
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.acme_account_info module – Retrieves information on ACME accounts<a class="headerlink" href="#community-crypto-acme-account-info-module-retrieves-information-on-acme-accounts" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-acme-account-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -212,8 +214,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-account_key_content" 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>Content of the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code> is not used.</p>
|
||||
<p><strong>Warning:</strong> the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.</p>
|
||||
<p>In case <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.</p>
|
||||
</div></td>
|
||||
@@ -235,8 +237,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to a file containing the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Private keys can be created with the <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> or <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> modules. If the requisite (cryptography) is not available, keys can also be created directly with the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> command line tool: RSA keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">genrsa</span> <span class="pre">...</span></code>. Elliptic curve keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">ecparam</span> <span class="pre">-genkey</span> <span class="pre">...</span></code>. Any other tool creating private keys in PEM format can be used as well.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code> is not used.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -265,8 +267,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-acme_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The ACME version of the endpoint.</p>
|
||||
<p>Must be <code class="docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p>Must be <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="ansible-value docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">1</span></code></p></li>
|
||||
@@ -289,9 +291,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-retrieve_orders" 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>Whether to retrieve the list of order URLs or order objects, if provided by the ACME server.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">ignore</span></code> will not fetch the list of orders.</p>
|
||||
<p>If the value is not <code class="docutils literal notranslate"><span class="pre">ignore</span></code> and the ACME server supports orders, the <code class="docutils literal notranslate"><span class="pre">order_uris</span></code> return value is always populated. The <code class="docutils literal notranslate"><span class="pre">orders</span></code> return value is only returned if this option is set to <code class="docutils literal notranslate"><span class="pre">object_list</span></code>.</p>
|
||||
<p>Currently, Let’s Encrypt does not return orders, so the <code class="docutils literal notranslate"><span class="pre">orders</span></code> result will always be empty.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will not fetch the list of orders.</p>
|
||||
<p>If the value is not <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> and the ACME server supports orders, the <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-return-order-uris"><span class="std std-ref"><span class="pre">order_uris</span></span></a></code> return value is always populated. The <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-return-orders"><span class="std std-ref"><span class="pre">orders</span></span></a></code> return value is only returned if this option is set to <code class="ansible-value docutils literal notranslate"><span class="pre">object_list</span></code>.</p>
|
||||
<p>Currently, Let’s Encrypt does not return orders, so the <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-return-orders"><span class="std std-ref"><span class="pre">orders</span></span></a></code> result will always be empty.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -305,9 +307,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<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="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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</p>
|
||||
<p>If set to <code class="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>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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -321,7 +323,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-validate_certs" 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 calls to the ACME directory will validate TLS certificates.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -378,7 +380,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<ul class="simple">
|
||||
<li><p>The <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a> module allows to modify, create and delete ACME accounts.</p></li>
|
||||
<li><p>This module was called <code class="docutils literal notranslate"><span class="pre">acme_account_facts</span></code> before Ansible 2.8. The usage did not change.</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="docutils literal notranslate"><span class="pre">select_crypto_backend</span></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>).</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-select-crypto-backend"><span class="std std-ref"><span class="pre">select_crypto_backend</span></span></a></strong></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>).</p></li>
|
||||
<li><p>Although the defaults are chosen so that the module can be used with the <a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a> CA, the module can in principle be used with any CA providing an ACME endpoint, such as <a class="reference external" href="https://www.buypass.com/ssl/products/acme">Buypass Go SSL</a>.</p></li>
|
||||
<li><p>So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and <a class="reference external" href="https://github.com/letsencrypt/Pebble">Pebble testing server</a>. We have got community feedback that they also work with Sectigo ACME Service for InCommon. If you experience problems with another ACME server, please <a class="reference external" href="https://github.com/ansible-collections/community.crypto/issues/new/choose">create an issue</a> to help us supporting it. Feedback that an ACME server not mentioned does work is also appreciated.</p></li>
|
||||
</ul>
|
||||
@@ -401,7 +403,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<span class="w"> </span><span class="nt">account_key_src</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/pki/cert/private/account.key</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">account_data</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">Verify that account exists</span>
|
||||
<span class="w"> </span><span class="nt">assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">that</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">account_data.exists</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">Print account URI</span>
|
||||
@@ -417,7 +419,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<span class="w"> </span><span class="nt">account_uri</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">acme_account_uri</span> <span class="cp">}}</span><span class="s">"</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">account_data</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">Verify that account exists</span>
|
||||
<span class="w"> </span><span class="nt">assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">that</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">account_data.exists</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">Print account contacts</span>
|
||||
@@ -458,7 +460,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#return-account/orders" 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>A URL where a list of orders can be retrieved for this account.</p>
|
||||
<p>Use the <em>retrieve_orders</em> option to query this URL and retrieve the complete list of orders.</p>
|
||||
<p>Use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-retrieve-orders"><span class="std std-ref"><span class="pre">retrieve_orders</span></span></a></strong></code> option to query this URL and retrieve the complete list of orders.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"https://example.ca/account/1/orders"</span></code></p>
|
||||
</div></td>
|
||||
@@ -509,9 +511,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.5.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The list of orders.</p>
|
||||
<p>If <em>retrieve_orders</em> is <code class="docutils literal notranslate"><span class="pre">url_list</span></code>, this will be a list of URLs.</p>
|
||||
<p>If <em>retrieve_orders</em> is <code class="docutils literal notranslate"><span class="pre">object_list</span></code>, this will be a list of objects.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if account exists, <em>retrieve_orders</em> is not <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, and server supports order listing</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-retrieve-orders"><span class="std std-ref"><span class="pre">retrieve_orders</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">url_list</span></code>, this will be a list of URLs.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-retrieve-orders"><span class="std std-ref"><span class="pre">retrieve_orders</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">object_list</span></code>, this will be a list of objects.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if account exists, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-retrieve-orders"><span class="std std-ref"><span class="pre">retrieve_orders</span></span></a></strong></code> is not <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, and server supports order listing</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -519,7 +521,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#return-orders" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The list of orders.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if account exists, <em>retrieve_orders</em> is <code class="docutils literal notranslate"><span class="pre">object_list</span></code>, and server supports order listing</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if account exists, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-parameter-retrieve-orders"><span class="std std-ref"><span class="pre">retrieve_orders</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">object_list</span></code>, and server supports order listing</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -553,7 +555,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>When the order expires.</p>
|
||||
<p>Timestamp should be formatted as described in RFC3339.</p>
|
||||
<p>Only required to be included in result when <em>status</em> is <code class="docutils literal notranslate"><span class="pre">pending</span></code> or <code class="docutils literal notranslate"><span class="pre">valid</span></code>.</p>
|
||||
<p>Only required to be included in result when <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-return-orders-status"><span class="std std-ref"><span class="pre">orders[].status</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">pending</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">valid</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when server gives expiry date</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -577,8 +579,13 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="return-orders/identifiers/type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-account-info-module-return-orders-identifiers-type"><strong>type</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-orders/identifiers/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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Type of identifier. <code class="docutils literal notranslate"><span class="pre">dns</span></code> or <code class="docutils literal notranslate"><span class="pre">ip</span></code>.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Type of identifier.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Can only return:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"dns"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -593,7 +600,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="return-orders/identifiers/wildcard"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-account-info-module-return-orders-identifiers-wildcard"><strong>wildcard</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-orders/identifiers/wildcard" 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-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether <em>value</em> is actually a wildcard. The wildcard prefix <code class="docutils literal notranslate"><span class="pre">*.</span></code> is not included in <em>value</em> if this is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-return-orders-identifiers-value"><span class="std std-ref"><span class="pre">orders[].identifiers[].value</span></span></a></code> is actually a wildcard. The wildcard prefix <code class="docutils literal notranslate"><span class="pre">*.</span></code> is not included in <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-info-module-return-orders-identifiers-value"><span class="std std-ref"><span class="pre">orders[].identifiers[].value</span></span></a></code> if this is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> required to be included if the identifier is wildcarded</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.acme_account module – Create, modify or delete ACME accounts<a class="headerlink" href="#community-crypto-acme-account-module-create-modify-or-delete-acme-accounts" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-acme-account-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -212,8 +214,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-account_key_content" 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>Content of the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code> is not used.</p>
|
||||
<p><strong>Warning:</strong> the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.</p>
|
||||
<p>In case <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.</p>
|
||||
</div></td>
|
||||
@@ -235,8 +237,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to a file containing the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Private keys can be created with the <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> or <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> modules. If the requisite (cryptography) is not available, keys can also be created directly with the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> command line tool: RSA keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">genrsa</span> <span class="pre">...</span></code>. Elliptic curve keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">ecparam</span> <span class="pre">-genkey</span> <span class="pre">...</span></code>. Any other tool creating private keys in PEM format can be used as well.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code> is not used.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -265,8 +267,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-acme_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The ACME version of the endpoint.</p>
|
||||
<p>Must be <code class="docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p>Must be <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="ansible-value docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">1</span></code></p></li>
|
||||
@@ -278,7 +280,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="parameter-allow_creation"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-account-module-parameter-allow-creation"><strong>allow_creation</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-allow_creation" 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 account creation is allowed (when state is <code class="docutils literal notranslate"><span class="pre">present</span></code>).</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether account creation is allowed (when state is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -293,7 +295,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<td><div class="ansible-option-cell"><p>A list of contact URLs.</p>
|
||||
<p>Email addresses must be prefixed with <code class="docutils literal notranslate"><span class="pre">mailto:</span></code>.</p>
|
||||
<p>See <a class="reference external" href="https://tools.ietf.org/html/rfc8555#section-7.3">https://tools.ietf.org/html/rfc8555#section-7.3</a> for what is allowed.</p>
|
||||
<p>Must be specified when state is <code class="docutils literal notranslate"><span class="pre">present</span></code>. Will be ignored if state is <code class="docutils literal notranslate"><span class="pre">absent</span></code> or <code class="docutils literal notranslate"><span class="pre">changed_key</span></code>.</p>
|
||||
<p>Must be specified when state is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>. Will be ignored if state is <code class="ansible-value docutils literal notranslate"><span class="pre">absent</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">changed_key</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">[]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -312,7 +314,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-external_account_binding/alg" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The MAC algorithm provided by the CA.</p>
|
||||
<p>If not specified by the CA, this is probably <code class="docutils literal notranslate"><span class="pre">HS256</span></code>.</p>
|
||||
<p>If not specified by the CA, this is probably <code class="ansible-value docutils literal notranslate"><span class="pre">HS256</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"HS256"</span></code></p></li>
|
||||
@@ -326,7 +328,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-external_account_binding/key" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Base64 URL encoded value of the MAC key provided by the CA.</p>
|
||||
<p>Padding (<code class="docutils literal notranslate"><span class="pre">=</span></code> symbols at the end) can be omitted.</p>
|
||||
<p>Padding (<code class="ansible-value docutils literal notranslate"><span class="pre">=</span></code> symbols at the end) can be omitted.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -341,9 +343,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-new_account_key_content" 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>Content of the ACME account RSA or Elliptic Curve key to change to.</p>
|
||||
<p>Same restrictions apply as to <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">new_account_key_src</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">new_account_key_src</span></code> is not used and state is <code class="docutils literal notranslate"><span class="pre">changed_key</span></code>.</p>
|
||||
<p>Same restrictions apply as to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-new-account-key-src"><span class="std std-ref"><span class="pre">new_account_key_src</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-new-account-key-src"><span class="std std-ref"><span class="pre">new_account_key_src</span></span></a></strong></code> is not used and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">changed_key</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -360,9 +362,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-new_account_key_src" 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>Path to a file containing the ACME account RSA or Elliptic Curve key to change to.</p>
|
||||
<p>Same restrictions apply as to <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">new_account_key_content</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">new_account_key_content</span></code> is not used and state is <code class="docutils literal notranslate"><span class="pre">changed_key</span></code>.</p>
|
||||
<p>Same restrictions apply as to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-new-account-key-content"><span class="std std-ref"><span class="pre">new_account_key_content</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-new-account-key-content"><span class="std std-ref"><span class="pre">new_account_key_content</span></span></a></strong></code> is not used and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">changed_key</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -380,9 +382,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<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="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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</p>
|
||||
<p>If set to <code class="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>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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -396,8 +398,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-state" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The state of the account, to be identified by its account key.</p>
|
||||
<p>If the state is <code class="docutils literal notranslate"><span class="pre">absent</span></code>, the account will either not exist or be deactivated.</p>
|
||||
<p>If the state is <code class="docutils literal notranslate"><span class="pre">changed_key</span></code>, the account must exist. The account key will be changed; no other information will be touched.</p>
|
||||
<p>If the state is <code class="ansible-value docutils literal notranslate"><span class="pre">absent</span></code>, the account will either not exist or be deactivated.</p>
|
||||
<p>If the state is <code class="ansible-value docutils literal notranslate"><span class="pre">changed_key</span></code>, the account must exist. The account key will be changed; no other information will be touched.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"present"</span></code></p></li>
|
||||
@@ -411,7 +413,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-terms_agreed" 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>Boolean indicating whether you agree to the terms of service document.</p>
|
||||
<p>ACME servers can require this to be true.</p>
|
||||
<p>ACME servers can require this to be <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -424,7 +426,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-validate_certs" 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 calls to the ACME directory will validate TLS certificates.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -477,8 +479,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>The <a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module"><span class="std std-ref">community.crypto.acme_certificate</span></a> module also allows to do basic account management. When using both modules, it is recommended to disable account management for <a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module"><span class="std std-ref">community.crypto.acme_certificate</span></a>. For that, use the <code class="docutils literal notranslate"><span class="pre">modify_account</span></code> option of <a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module"><span class="std std-ref">community.crypto.acme_certificate</span></a>.</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="docutils literal notranslate"><span class="pre">select_crypto_backend</span></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>).</p></li>
|
||||
<li><p>The <a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module"><span class="std std-ref">community.crypto.acme_certificate</span></a> module also allows to do basic account management. When using both modules, it is recommended to disable account management for <a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module"><span class="std std-ref">community.crypto.acme_certificate</span></a>. For that, use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module-parameter-modify-account"><span class="std std-ref"><span class="pre">modify_account</span></span></a></strong></code> option of <a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module"><span class="std std-ref">community.crypto.acme_certificate</span></a>.</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-select-crypto-backend"><span class="std std-ref"><span class="pre">select_crypto_backend</span></span></a></strong></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-account-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>).</p></li>
|
||||
<li><p>Although the defaults are chosen so that the module can be used with the <a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a> CA, the module can in principle be used with any CA providing an ACME endpoint, such as <a class="reference external" href="https://www.buypass.com/ssl/products/acme">Buypass Go SSL</a>.</p></li>
|
||||
<li><p>So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and <a class="reference external" href="https://github.com/letsencrypt/Pebble">Pebble testing server</a>. We have got community feedback that they also work with Sectigo ACME Service for InCommon. If you experience problems with another ACME server, please <a class="reference external" href="https://github.com/ansible-collections/community.crypto/issues/new/choose">create an issue</a> to help us supporting it. Feedback that an ACME server not mentioned does work is also appreciated.</p></li>
|
||||
</ul>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.acme_certificate module – Create SSL/TLS certificates with the ACME protocol<a class="headerlink" href="#community-crypto-acme-certificate-module-create-ssl-tls-certificates-with-the-acme-protocol" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-acme-certificate-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -186,9 +188,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Create and renew SSL/TLS certificates with a CA supporting the <a class="reference external" href="https://tools.ietf.org/html/rfc8555">ACME protocol</a>, such as <a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a> or <a class="reference external" href="https://www.buypass.com/">Buypass</a>. The current implementation supports the <code class="docutils literal notranslate"><span class="pre">http-01</span></code>, <code class="docutils literal notranslate"><span class="pre">dns-01</span></code> and <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenges.</p></li>
|
||||
<li><p>To use this module, it has to be executed twice. Either as two different tasks in the same run or during two runs. Note that the output of the first run needs to be recorded and passed to the second run as the module argument <code class="docutils literal notranslate"><span class="pre">data</span></code>.</p></li>
|
||||
<li><p>Between these two tasks you have to fulfill the required steps for the chosen challenge by whatever means necessary. For <code class="docutils literal notranslate"><span class="pre">http-01</span></code> that means creating the necessary challenge file on the destination webserver. For <code class="docutils literal notranslate"><span class="pre">dns-01</span></code> the necessary dns record has to be created. For <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> the necessary certificate has to be created and served. It is <em>not</em> the responsibility of this module to perform these steps.</p></li>
|
||||
<li><p>Create and renew SSL/TLS certificates with a CA supporting the <a class="reference external" href="https://tools.ietf.org/html/rfc8555">ACME protocol</a>, such as <a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a> or <a class="reference external" href="https://www.buypass.com/">Buypass</a>. The current implementation supports the <code class="ansible-value docutils literal notranslate"><span class="pre">http-01</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">dns-01</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenges.</p></li>
|
||||
<li><p>To use this module, it has to be executed twice. Either as two different tasks in the same run or during two runs. Note that the output of the first run needs to be recorded and passed to the second run as the module argument <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-data"><span class="std std-ref"><span class="pre">data</span></span></a></strong></code>.</p></li>
|
||||
<li><p>Between these two tasks you have to fulfill the required steps for the chosen challenge by whatever means necessary. For <code class="ansible-value docutils literal notranslate"><span class="pre">http-01</span></code> that means creating the necessary challenge file on the destination webserver. For <code class="ansible-value docutils literal notranslate"><span class="pre">dns-01</span></code> the necessary dns record has to be created. For <code class="ansible-value docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> the necessary certificate has to be created and served. It is <em>not</em> the responsibility of this module to perform these steps.</p></li>
|
||||
<li><p>For details on how to fulfill these challenges, you might have to read through <a class="reference external" href="https://tools.ietf.org/html/rfc8555#section-8">the main ACME specification</a> and the <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc8737.html#section-3">TLS-ALPN-01 specification</a>. Also, consider the examples provided for this module.</p></li>
|
||||
<li><p>The module includes experimental support for IP identifiers according to the <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc8738.html">RFC 8738</a>.</p></li>
|
||||
</ul>
|
||||
@@ -216,7 +218,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The email address associated with this account.</p>
|
||||
<p>It will be used for certificate expiration warnings.</p>
|
||||
<p>Note that when <code class="docutils literal notranslate"><span class="pre">modify_account</span></code> is not set to <code class="docutils literal notranslate"><span class="pre">false</span></code> and you also used the <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a> module to specify more than one contact for your account, this module will update your account and restrict it to the (at most one) contact email address specified here.</p>
|
||||
<p>Note that when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-modify-account"><span class="std std-ref"><span class="pre">modify_account</span></span></a></strong></code> is not set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> and you also used the <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a> module to specify more than one contact for your account, this module will update your account and restrict it to the (at most one) contact email address specified here.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -224,8 +226,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-account_key_content" 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>Content of the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code> is not used.</p>
|
||||
<p><strong>Warning:</strong> the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.</p>
|
||||
<p>In case <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.</p>
|
||||
</div></td>
|
||||
@@ -247,8 +249,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to a file containing the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Private keys can be created with the <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> or <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> modules. If the requisite (cryptography) is not available, keys can also be created directly with the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> command line tool: RSA keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">genrsa</span> <span class="pre">...</span></code>. Elliptic curve keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">ecparam</span> <span class="pre">-genkey</span> <span class="pre">...</span></code>. Any other tool creating private keys in PEM format can be used as well.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code> is not used.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -277,8 +279,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-acme_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The ACME version of the endpoint.</p>
|
||||
<p>Must be <code class="docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p>Must be <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="ansible-value docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">1</span></code></p></li>
|
||||
@@ -290,9 +292,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="parameter-agreement"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-certificate-module-parameter-agreement"><strong>agreement</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-agreement" 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>URI to a terms of service document you agree to when using the ACME v1 service at <code class="docutils literal notranslate"><span class="pre">acme_directory</span></code>.</p>
|
||||
<p>Default is latest gathered from <code class="docutils literal notranslate"><span class="pre">acme_directory</span></code> URL.</p>
|
||||
<p>This option will only be used when <code class="docutils literal notranslate"><span class="pre">acme_version</span></code> is 1.</p>
|
||||
<td><div class="ansible-option-cell"><p>URI to a terms of service document you agree to when using the ACME v1 service at <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-acme-directory"><span class="std std-ref"><span class="pre">acme_directory</span></span></a></strong></code>.</p>
|
||||
<p>Default is latest gathered from <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-acme-directory"><span class="std std-ref"><span class="pre">acme_directory</span></span></a></strong></code> URL.</p>
|
||||
<p>This option will only be used when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-acme-version"><span class="std std-ref"><span class="pre">acme_version</span></span></a></strong></code> is 1.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -309,11 +311,13 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-challenge" 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 challenge to be performed.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">no</span> <span class="pre">challenge</span></code>, no challenge will be used. This is necessary for some private CAs which use External Account Binding and other means of validating certificate assurance. For example, an account could be allowed to issue certificates for <code class="docutils literal notranslate"><span class="pre">foo.example.com</span></code> without any further validation for a certain period of time.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"http-01"</span></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">"dns-01"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"tls-alpn-01"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"no</span> <span class="pre">challenge"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -327,7 +331,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<p>Can be created with <a class="reference internal" href="openssl_csr_module.html#ansible-collections-community-crypto-openssl-csr-module"><span class="std std-ref">community.crypto.openssl_csr</span></a> or <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">req</span> <span class="pre">...</span></code>.</p>
|
||||
<p>The CSR may contain multiple Subject Alternate Names, but each one will lead to an individual challenge that must be fulfilled for the CSR to be signed.</p>
|
||||
<p><em>Note</em>: the private key used to create the CSR <em>must not</em> be the account key. This is a bad idea from a security point of view, and the CA should not accept the CSR. The ACME server should return an error in this case.</p>
|
||||
<p>Precisely one of <em>csr</em> or <em>csr_content</em> must be specified.</p>
|
||||
<p>Precisely one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-csr-content"><span class="std std-ref"><span class="pre">csr_content</span></span></a></strong></code> must be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -339,7 +343,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<p>Can be created with <a class="reference internal" href="openssl_csr_pipe_module.html#ansible-collections-community-crypto-openssl-csr-pipe-module"><span class="std std-ref">community.crypto.openssl_csr_pipe</span></a> or <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">req</span> <span class="pre">...</span></code>.</p>
|
||||
<p>The CSR may contain multiple Subject Alternate Names, but each one will lead to an individual challenge that must be fulfilled for the CSR to be signed.</p>
|
||||
<p><em>Note</em>: the private key used to create the CSR <em>must not</em> be the account key. This is a bad idea from a security point of view, and the CA should not accept the CSR. The ACME server should return an error in this case.</p>
|
||||
<p>Precisely one of <em>csr</em> or <em>csr_content</em> must be specified.</p>
|
||||
<p>Precisely one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-csr-content"><span class="std std-ref"><span class="pre">csr_content</span></span></a></strong></code> must be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -348,8 +352,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The data to validate ongoing challenges. This must be specified for the second run of the module only.</p>
|
||||
<p>The value that must be used here will be provided by a previous use of this module. See the examples for more details.</p>
|
||||
<p>Note that for ACME v2, only the <code class="docutils literal notranslate"><span class="pre">order_uri</span></code> entry of <code class="docutils literal notranslate"><span class="pre">data</span></code> will be used. For ACME v1, <code class="docutils literal notranslate"><span class="pre">data</span></code> must be non-empty to indicate the second stage is active; all needed data will be taken from the CSR.</p>
|
||||
<p><em>Note</em>: the <code class="docutils literal notranslate"><span class="pre">data</span></code> option was marked as <code class="docutils literal notranslate"><span class="pre">no_log</span></code> up to Ansible 2.5. From Ansible 2.6 on, it is no longer marked this way as it causes error messages to be come unusable, and <code class="docutils literal notranslate"><span class="pre">data</span></code> does not contain any information which can be used without having access to the account key or which are not public anyway.</p>
|
||||
<p>Note that for ACME v2, only the <code class="docutils literal notranslate"><span class="pre">order_uri</span></code> entry of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-data"><span class="std std-ref"><span class="pre">data</span></span></a></strong></code> will be used. For ACME v1, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-data"><span class="std std-ref"><span class="pre">data</span></span></a></strong></code> must be non-empty to indicate the second stage is active; all needed data will be taken from the CSR.</p>
|
||||
<p><em>Note</em>: the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-data"><span class="std std-ref"><span class="pre">data</span></span></a></strong></code> option was marked as <code class="docutils literal notranslate"><span class="pre">no_log</span></code> up to Ansible 2.5. From Ansible 2.6 on, it is no longer marked this way as it causes error messages to be come unusable, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-data"><span class="std std-ref"><span class="pre">data</span></span></a></strong></code> does not contain any information which can be used without having access to the account key or which are not public anyway.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -372,14 +376,14 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The destination file for the certificate.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">fullchain_dest</span></code> is not specified.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-fullchain-dest"><span class="std std-ref"><span class="pre">fullchain_dest</span></span></a></strong></code> is not specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-certificate-module-parameter-force"><strong>force</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force" 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>Enforces the execution of the challenge and validation, even if an existing certificate is still valid for more than <code class="docutils literal notranslate"><span class="pre">remaining_days</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Enforces the execution of the challenge and validation, even if an existing certificate is still valid for more than <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code>.</p>
|
||||
<p>This is especially helpful when having an updated CSR, for example with additional domains for which a new certificate is desired.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -395,7 +399,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The destination file for the full chain (that is, a certificate followed by chain of intermediate certificates).</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">dest</span></code> is not specified.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-dest"><span class="std std-ref"><span class="pre">dest</span></span></a></strong></code> is not specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -403,8 +407,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-modify_account" 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>Boolean indicating whether the module should create the account if necessary, and update its contact data.</p>
|
||||
<p>Set to <code class="docutils literal notranslate"><span class="pre">false</span></code> if you want to use the <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a> module to manage your account instead, and to avoid accidental creation of a new account using an old key if you changed the account key with <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a>.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, <code class="docutils literal notranslate"><span class="pre">terms_agreed</span></code> and <code class="docutils literal notranslate"><span class="pre">account_email</span></code> are ignored.</p>
|
||||
<p>Set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> if you want to use the <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a> module to manage your account instead, and to avoid accidental creation of a new account using an old key if you changed the account key with <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a>.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-terms-agreed"><span class="std std-ref"><span class="pre">terms_agreed</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-account-email"><span class="std std-ref"><span class="pre">account_email</span></span></a></strong></code> are ignored.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -416,8 +420,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="parameter-remaining_days"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-certificate-module-parameter-remaining-days"><strong>remaining_days</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remaining_days" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The number of days the certificate must have left being valid. If <code class="docutils literal notranslate"><span class="pre">cert_days</span> <span class="pre"><</span> <span class="pre">remaining_days</span></code>, then it will be renewed. If the certificate is not renewed, module return values will not include <code class="docutils literal notranslate"><span class="pre">challenge_data</span></code>.</p>
|
||||
<p>To make sure that the certificate is renewed in any case, you can use the <code class="docutils literal notranslate"><span class="pre">force</span></code> option.</p>
|
||||
<td><div class="ansible-option-cell"><p>The number of days the certificate must have left being valid. If <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-return-cert-days"><span class="std std-ref"><span class="pre">cert_days</span></span></a></code> < <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code>, then it will be renewed. If the certificate is not renewed, module return values will not include <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-return-challenge-data"><span class="std std-ref"><span class="pre">challenge_data</span></span></a></code>.</p>
|
||||
<p>To make sure that the certificate is renewed in any case, you can use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">10</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -435,7 +439,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="parameter-retrieve_all_alternates"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-certificate-module-parameter-retrieve-all-alternates"><strong>retrieve_all_alternates</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-retrieve_all_alternates" 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>When set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, will retrieve all alternate trust chains offered by the ACME CA. These will not be written to disk, but will be returned together with the main chain as <code class="docutils literal notranslate"><span class="pre">all_chains</span></code>. See the documentation for the <code class="docutils literal notranslate"><span class="pre">all_chains</span></code> return value for details.</p>
|
||||
<td><div class="ansible-option-cell"><p>When set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, will retrieve all alternate trust chains offered by the ACME CA. These will not be written to disk, but will be returned together with the main chain as <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-return-all-chains"><span class="std std-ref"><span class="pre">all_chains</span></span></a></code>. See the documentation for the <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-return-all-chains"><span class="std std-ref"><span class="pre">all_chains</span></span></a></code> return value for details.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -451,7 +455,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<td><div class="ansible-option-cell"><p>Allows to specify criteria by which an (alternate) trust chain can be selected.</p>
|
||||
<p>The list of criteria will be processed one by one until a chain is found matching a criterium. If such a chain is found, it will be used by the module instead of the default chain.</p>
|
||||
<p>If a criterium matches multiple chains, the first one matching will be returned. The order is determined by the ordering of the <code class="docutils literal notranslate"><span class="pre">Link</span></code> headers returned by the ACME server and might not be deterministic.</p>
|
||||
<p>Every criterium can consist of multiple different conditions, like <em>issuer</em> and <em>subject</em>. For the criterium to match a chain, all conditions must apply to the same certificate in the chain.</p>
|
||||
<p>Every criterium can consist of multiple different conditions, like <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-select-chain-issuer"><span class="std std-ref"><span class="pre">select_chain[].issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-select-chain-subject"><span class="std std-ref"><span class="pre">select_chain[].subject</span></span></a></strong></code>. For the criterium to match a chain, all conditions must apply to the same certificate in the chain.</p>
|
||||
<p>This option can only be used with the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -460,7 +464,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-select_chain/authority_key_identifier" 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-indent-desc"></div><div class="ansible-option-cell"><p>Checks for the AuthorityKeyIdentifier extension. This is an identifier based on the private key of the issuer of the intermediate certificate.</p>
|
||||
<p>The identifier must be of the form <code class="docutils literal notranslate"><span class="pre">C4:A7:B1:A4:7B:2C:71:FA:DB:E1:4B:90:75:FF:C4:15:60:85:89:10</span></code>.</p>
|
||||
<p>The identifier must be of the form <code class="ansible-value docutils literal notranslate"><span class="pre">C4:A7:B1:A4:7B:2C:71:FA:DB:E1:4B:90:75:FF:C4:15:60:85:89:10</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -468,8 +472,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-select_chain/issuer" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Allows to specify parts of the issuer of a certificate in the chain must have to be selected.</p>
|
||||
<p>If <em>issuer</em> is empty, any certificate will match.</p>
|
||||
<p>An example value would be <code class="docutils literal notranslate"><span class="pre">{"commonName":</span> <span class="pre">"My</span> <span class="pre">Preferred</span> <span class="pre">CA</span> <span class="pre">Root"}</span></code>.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-select-chain-issuer"><span class="std std-ref"><span class="pre">select_chain[].issuer</span></span></a></strong></code> is empty, any certificate will match.</p>
|
||||
<p>An example value would be <code class="ansible-value docutils literal notranslate"><span class="pre">{"commonName":</span> <span class="pre">"My</span> <span class="pre">Preferred</span> <span class="pre">CA</span> <span class="pre">Root"}</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -477,8 +481,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-select_chain/subject" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Allows to specify parts of the subject of a certificate in the chain must have to be selected.</p>
|
||||
<p>If <em>subject</em> is empty, any certificate will match.</p>
|
||||
<p>An example value would be <code class="docutils literal notranslate"><span class="pre">{"CN":</span> <span class="pre">"My</span> <span class="pre">Preferred</span> <span class="pre">CA</span> <span class="pre">Intermediate"}</span></code></p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-select-chain-subject"><span class="std std-ref"><span class="pre">select_chain[].subject</span></span></a></strong></code> is empty, any certificate will match.</p>
|
||||
<p>An example value would be <code class="ansible-value docutils literal notranslate"><span class="pre">{"CN":</span> <span class="pre">"My</span> <span class="pre">Preferred</span> <span class="pre">CA</span> <span class="pre">Intermediate"}</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -486,7 +490,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-select_chain/subject_key_identifier" 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-indent-desc"></div><div class="ansible-option-cell"><p>Checks for the SubjectKeyIdentifier extension. This is an identifier based on the private key of the intermediate certificate.</p>
|
||||
<p>The identifier must be of the form <code class="docutils literal notranslate"><span class="pre">A8:4A:6A:63:04:7D:DD:BA:E6:D1:39:B7:A6:45:65:EF:F3:A8:EC:A1</span></code>.</p>
|
||||
<p>The identifier must be of the form <code class="ansible-value docutils literal notranslate"><span class="pre">A8:4A:6A:63:04:7D:DD:BA:E6:D1:39:B7:A6:45:65:EF:F3:A8:EC:A1</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -494,9 +498,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-select_chain/test_certificates" 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-indent-desc"></div><div class="ansible-option-cell"><p>Determines which certificates in the chain will be tested.</p>
|
||||
<p><em>all</em> tests all certificates in the chain (excluding the leaf, which is identical in all chains).</p>
|
||||
<p><em>first</em> only tests the first certificate in the chain, that is the one which signed the leaf.</p>
|
||||
<p><em>last</em> only tests the last certificate in the chain, that is the one furthest away from the leaf. Its issuer is the root certificate of this chain.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">all</span></code> tests all certificates in the chain (excluding the leaf, which is identical in all chains).</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">first</span></code> only tests the first certificate in the chain, that is the one which signed the leaf.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">last</span></code> only tests the last certificate in the chain, that is the one furthest away from the leaf. Its issuer is the root certificate of this chain.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"first"</span></code></p></li>
|
||||
@@ -510,9 +514,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<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="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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</p>
|
||||
<p>If set to <code class="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>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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -527,7 +531,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Boolean indicating whether you agree to the terms of service document.</p>
|
||||
<p>ACME servers can require this to be true.</p>
|
||||
<p>This option will only be used when <code class="docutils literal notranslate"><span class="pre">acme_version</span></code> is not 1.</p>
|
||||
<p>This option will only be used when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-acme-version"><span class="std std-ref"><span class="pre">acme_version</span></span></a></strong></code> is not 1.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -540,7 +544,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-validate_certs" 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 calls to the ACME directory will validate TLS certificates.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -601,10 +605,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>At least one of <code class="docutils literal notranslate"><span class="pre">dest</span></code> and <code class="docutils literal notranslate"><span class="pre">fullchain_dest</span></code> must be specified.</p></li>
|
||||
<li><p>This module includes basic account management functionality. If you want to have more control over your ACME account, use the <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a> module and disable account management for this module using the <code class="docutils literal notranslate"><span class="pre">modify_account</span></code> option.</p></li>
|
||||
<li><p>At least one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-dest"><span class="std std-ref"><span class="pre">dest</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-fullchain-dest"><span class="std std-ref"><span class="pre">fullchain_dest</span></span></a></strong></code> must be specified.</p></li>
|
||||
<li><p>This module includes basic account management functionality. If you want to have more control over your ACME account, use the <a class="reference internal" href="acme_account_module.html#ansible-collections-community-crypto-acme-account-module"><span class="std std-ref">community.crypto.acme_account</span></a> module and disable account management for this module using the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-modify-account"><span class="std std-ref"><span class="pre">modify_account</span></span></a></strong></code> option.</p></li>
|
||||
<li><p>This module was called <code class="docutils literal notranslate"><span class="pre">letsencrypt</span></code> before Ansible 2.6. The usage did not change.</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="docutils literal notranslate"><span class="pre">select_crypto_backend</span></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>).</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-select-crypto-backend"><span class="std std-ref"><span class="pre">select_crypto_backend</span></span></a></strong></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>).</p></li>
|
||||
<li><p>Although the defaults are chosen so that the module can be used with the <a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a> CA, the module can in principle be used with any CA providing an ACME endpoint, such as <a class="reference external" href="https://www.buypass.com/ssl/products/acme">Buypass Go SSL</a>.</p></li>
|
||||
<li><p>So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and <a class="reference external" href="https://github.com/letsencrypt/Pebble">Pebble testing server</a>. We have got community feedback that they also work with Sectigo ACME Service for InCommon. If you experience problems with another ACME server, please <a class="reference external" href="https://github.com/ansible-collections/community.crypto/issues/new/choose">create an issue</a> to help us supporting it. Feedback that an ACME server not mentioned does work is also appreciated.</p></li>
|
||||
</ul>
|
||||
@@ -621,9 +625,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</dd>
|
||||
<dt><a class="reference external" href="https://tools.ietf.org/html/rfc8555">Automatic Certificate Management Environment (ACME)</a></dt><dd><p>The specification of the ACME protocol (RFC 8555).</p>
|
||||
</dd>
|
||||
<dt><a class="reference external" href="https://www.rfc-editor.org/rfc/rfc8737.html-05">ACME TLS ALPN Challenge Extension</a></dt><dd><p>The specification of the <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenge (RFC 8737).</p>
|
||||
<dt><a class="reference external" href="https://www.rfc-editor.org/rfc/rfc8737.html-05">ACME TLS ALPN Challenge Extension</a></dt><dd><p>The specification of the <code class="ansible-value docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenge (RFC 8737).</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="acme_challenge_cert_helper_module.html#ansible-collections-community-crypto-acme-challenge-cert-helper-module"><span class="std std-ref">community.crypto.acme_challenge_cert_helper</span></a></dt><dd><p>Helps preparing <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenges.</p>
|
||||
<dt><a class="reference internal" href="acme_challenge_cert_helper_module.html#ansible-collections-community-crypto-acme-challenge-cert-helper-module"><span class="std std-ref">community.crypto.acme_challenge_cert_helper</span></a></dt><dd><p>Helps preparing <code class="ansible-value docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenges.</p>
|
||||
</dd>
|
||||
<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>Can be used to create private keys (both for certificates and accounts).</p>
|
||||
</dd>
|
||||
@@ -675,14 +679,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<span class="c1"># perform the necessary steps to fulfill the challenge</span>
|
||||
<span class="c1"># for example:</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># - copy:</span>
|
||||
<span class="c1"># - name: Copy http-01 challenge for sample.com</span>
|
||||
<span class="c1"># ansible.builtin.copy:</span>
|
||||
<span class="c1"># dest: /var/www/html/</span><span class="cp">{{</span> <span class="nv">sample_com_challenge</span><span class="o">[</span><span class="s1">'challenge_data'</span><span class="o">][</span><span class="s1">'sample.com'</span><span class="o">][</span><span class="s1">'http-01'</span><span class="o">][</span><span class="s1">'resource'</span><span class="o">]</span> <span class="cp">}}</span>
|
||||
<span class="c1"># content: "</span><span class="cp">{{</span> <span class="nv">sample_com_challenge</span><span class="o">[</span><span class="s1">'challenge_data'</span><span class="o">][</span><span class="s1">'sample.com'</span><span class="o">][</span><span class="s1">'http-01'</span><span class="o">][</span><span class="s1">'resource_value'</span><span class="o">]</span> <span class="cp">}}</span><span class="c1">"</span>
|
||||
<span class="c1"># when: sample_com_challenge is changed and 'sample.com' in sample_com_challenge['challenge_data']</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Alternative way:</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># - copy:</span>
|
||||
<span class="c1"># - name: Copy http-01 challenges</span>
|
||||
<span class="c1"># ansible.builtin.copy:</span>
|
||||
<span class="c1"># dest: /var/www/</span><span class="cp">{{</span> <span class="nv">item.key</span> <span class="cp">}}</span><span class="c1">/</span><span class="cp">{{</span> <span class="nv">item.value</span><span class="o">[</span><span class="s1">'http-01'</span><span class="o">][</span><span class="s1">'resource'</span><span class="o">]</span> <span class="cp">}}</span>
|
||||
<span class="c1"># content: "</span><span class="cp">{{</span> <span class="nv">item.value</span><span class="o">[</span><span class="s1">'http-01'</span><span class="o">][</span><span class="s1">'resource_value'</span><span class="o">]</span> <span class="cp">}}</span><span class="c1">"</span>
|
||||
<span class="c1"># loop: "</span><span class="cp">{{</span> <span class="nv">sample_com_challenge.challenge_data</span> <span class="o">|</span> <span class="nf">dict2items</span> <span class="cp">}}</span><span class="c1">"</span>
|
||||
@@ -714,7 +720,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<span class="c1"># perform the necessary steps to fulfill the challenge</span>
|
||||
<span class="c1"># for example:</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># - community.aws.route53:</span>
|
||||
<span class="c1"># - name: Create DNS record for sample.com dns-01 challenge</span>
|
||||
<span class="c1"># community.aws.route53:</span>
|
||||
<span class="c1"># zone: sample.com</span>
|
||||
<span class="c1"># record: "</span><span class="cp">{{</span> <span class="nv">sample_com_challenge.challenge_data</span><span class="o">[</span><span class="s1">'sample.com'</span><span class="o">][</span><span class="s1">'dns-01'</span><span class="o">]</span><span class="nv">.record</span> <span class="cp">}}</span><span class="c1">"</span>
|
||||
<span class="c1"># type: TXT</span>
|
||||
@@ -727,7 +734,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># Alternative way:</span>
|
||||
<span class="c1">#</span>
|
||||
<span class="c1"># - community.aws.route53:</span>
|
||||
<span class="c1"># - name: Create DNS records for dns-01 challenges</span>
|
||||
<span class="c1"># community.aws.route53:</span>
|
||||
<span class="c1"># zone: sample.com</span>
|
||||
<span class="c1"># record: "</span><span class="cp">{{</span> <span class="nv">item.key</span> <span class="cp">}}</span><span class="c1">"</span>
|
||||
<span class="c1"># type: TXT</span>
|
||||
@@ -805,9 +813,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="return-all_chains"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-certificate-module-return-all-chains"><strong>all_chains</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-all_chains" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When <em>retrieve_all_alternates</em> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the module will query the ACME server for alternate chains. This return value will contain a list of all chains returned, the first entry being the main chain returned by the server.</p>
|
||||
<td><div class="ansible-option-cell"><p>When <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-retrieve-all-alternates"><span class="std std-ref"><span class="pre">retrieve_all_alternates</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, the module will query the ACME server for alternate chains. This return value will contain a list of all chains returned, the first entry being the main chain returned by the server.</p>
|
||||
<p>See <a class="reference external" href="https://tools.ietf.org/html/rfc8555#section-7.4.2">Section 7.4.2 of RFC8555</a> for details.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when certificate was retrieved and <em>retrieve_all_alternates</em> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when certificate was retrieved and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-retrieve-all-alternates"><span class="std std-ref"><span class="pre">retrieve_all_alternates</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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -866,7 +874,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#return-challenge_data/record" 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 full DNS record’s name for the challenge.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and challenge is <code class="docutils literal notranslate"><span class="pre">dns-01</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and challenge is <code class="ansible-value docutils literal notranslate"><span class="pre">dns-01</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"_acme-challenge.example.com"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -883,8 +891,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="return-challenge_data/resource_original"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-certificate-module-return-challenge-data-resource-original"><strong>resource_original</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-challenge_data/resource_original" 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 original challenge resource including type identifier for <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenges.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and challenge is <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code></p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The original challenge resource including type identifier for <code class="ansible-value docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenges.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-module-parameter-challenge"><span class="std std-ref"><span class="pre">challenge</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">tls-alpn-01</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"DNS:example.com"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -893,8 +901,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#return-challenge_data/resource_value" 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 value the resource has to produce for the validation.</p>
|
||||
<p>For <code class="docutils literal notranslate"><span class="pre">http-01</span></code> and <code class="docutils literal notranslate"><span class="pre">dns-01</span></code> challenges, the value can be used as-is.</p>
|
||||
<p>For <code class="docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenges, note that this return value contains a Base64 encoded version of the correct binary blob which has to be put into the acmeValidation x509 extension; see <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc8737.html#section-3">https://www.rfc-editor.org/rfc/rfc8737.html#section-3</a> for details. To do this, you might need the <code class="docutils literal notranslate"><span class="pre">b64decode</span></code> Jinja filter to extract the binary blob from this return value.</p>
|
||||
<p>For <code class="ansible-value docutils literal notranslate"><span class="pre">http-01</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">dns-01</span></code> challenges, the value can be used as-is.</p>
|
||||
<p>For <code class="ansible-value docutils literal notranslate"><span class="pre">tls-alpn-01</span></code> challenges, note that this return value contains a Base64 encoded version of the correct binary blob which has to be put into the acmeValidation x509 extension; see <a class="reference external" href="https://www.rfc-editor.org/rfc/rfc8737.html#section-3">https://www.rfc-editor.org/rfc/rfc8737.html#section-3</a> for details. To do this, you might need the <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/builtin/b64decode_filter.html#ansible-collections-ansible-builtin-b64decode-filter" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.builtin.b64decode</span></a> Jinja filter to extract the binary blob from this return value.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"IlirfxKKXA...17Dt3juxGJ-PCt92wr-oA"</span></code></p>
|
||||
</div></td>
|
||||
@@ -903,7 +911,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="return-challenge_data_dns"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-certificate-module-return-challenge-data-dns"><strong>challenge_data_dns</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-challenge_data_dns" 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>List of TXT values per DNS record, in case challenge is <code class="docutils literal notranslate"><span class="pre">dns-01</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>List of TXT values per DNS record, in case challenge is <code class="ansible-value docutils literal notranslate"><span class="pre">dns-01</span></code>.</p>
|
||||
<p>Since Ansible 2.8.5, only challenges which are not yet valid are returned.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed</p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.acme_certificate_revoke module – Revoke certificates with the ACME protocol<a class="headerlink" href="#community-crypto-acme-certificate-revoke-module-revoke-certificates-with-the-acme-protocol" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-acme-certificate-revoke-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -209,7 +211,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-account_key_content" 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>Content of the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Note that exactly one of <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>, <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>, <code class="docutils literal notranslate"><span class="pre">private_key_src</span></code> or <code class="docutils literal notranslate"><span class="pre">private_key_content</span></code> must be specified.</p>
|
||||
<p>Note that exactly one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-private-key-src"><span class="std std-ref"><span class="pre">private_key_src</span></span></a></strong></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-private-key-content"><span class="std std-ref"><span class="pre">private_key_content</span></span></a></strong></code> must be specified.</p>
|
||||
<p><em>Warning</em>: the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.</p>
|
||||
<p>In case <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.</p>
|
||||
</div></td>
|
||||
@@ -231,8 +233,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to a file containing the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>RSA keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">rsa</span> <span class="pre">...</span></code>. Elliptic curve keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">ecparam</span> <span class="pre">-genkey</span> <span class="pre">...</span></code>. Any other tool creating private keys in PEM format can be used as well.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code> is not used.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -261,8 +263,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-acme_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The ACME version of the endpoint.</p>
|
||||
<p>Must be <code class="docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p>Must be <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="ansible-value docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">1</span></code></p></li>
|
||||
@@ -282,7 +284,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-private_key_content" 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>Content of the certificate’s private key.</p>
|
||||
<p>Note that exactly one of <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>, <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>, <code class="docutils literal notranslate"><span class="pre">private_key_src</span></code> or <code class="docutils literal notranslate"><span class="pre">private_key_content</span></code> must be specified.</p>
|
||||
<p>Note that exactly one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-private-key-src"><span class="std std-ref"><span class="pre">private_key_src</span></span></a></strong></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-private-key-content"><span class="std std-ref"><span class="pre">private_key_content</span></span></a></strong></code> must be specified.</p>
|
||||
<p><em>Warning</em>: the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.</p>
|
||||
<p>In case <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.</p>
|
||||
</div></td>
|
||||
@@ -301,7 +303,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-private_key_src" 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>Path to the certificate’s private key.</p>
|
||||
<p>Note that exactly one of <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>, <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>, <code class="docutils literal notranslate"><span class="pre">private_key_src</span></code> or <code class="docutils literal notranslate"><span class="pre">private_key_content</span></code> must be specified.</p>
|
||||
<p>Note that exactly one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-private-key-src"><span class="std std-ref"><span class="pre">private_key_src</span></span></a></strong></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-private-key-content"><span class="std std-ref"><span class="pre">private_key_content</span></span></a></strong></code> must be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -319,7 +321,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-revoke_reason" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>One of the revocation reasonCodes defined in <a class="reference external" href="https://tools.ietf.org/html/rfc5280#section-5.3.1">Section 5.3.1 of RFC5280</a>.</p>
|
||||
<p>Possible values are <code class="docutils literal notranslate"><span class="pre">0</span></code> (unspecified), <code class="docutils literal notranslate"><span class="pre">1</span></code> (keyCompromise), <code class="docutils literal notranslate"><span class="pre">2</span></code> (cACompromise), <code class="docutils literal notranslate"><span class="pre">3</span></code> (affiliationChanged), <code class="docutils literal notranslate"><span class="pre">4</span></code> (superseded), <code class="docutils literal notranslate"><span class="pre">5</span></code> (cessationOfOperation), <code class="docutils literal notranslate"><span class="pre">6</span></code> (certificateHold), <code class="docutils literal notranslate"><span class="pre">8</span></code> (removeFromCRL), <code class="docutils literal notranslate"><span class="pre">9</span></code> (privilegeWithdrawn), <code class="docutils literal notranslate"><span class="pre">10</span></code> (aACompromise).</p>
|
||||
<p>Possible values are <code class="ansible-value docutils literal notranslate"><span class="pre">0</span></code> (unspecified), <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> (keyCompromise), <code class="ansible-value docutils literal notranslate"><span class="pre">2</span></code> (cACompromise), <code class="ansible-value docutils literal notranslate"><span class="pre">3</span></code> (affiliationChanged), <code class="ansible-value docutils literal notranslate"><span class="pre">4</span></code> (superseded), <code class="ansible-value docutils literal notranslate"><span class="pre">5</span></code> (cessationOfOperation), <code class="ansible-value docutils literal notranslate"><span class="pre">6</span></code> (certificateHold), <code class="ansible-value docutils literal notranslate"><span class="pre">8</span></code> (removeFromCRL), <code class="ansible-value docutils literal notranslate"><span class="pre">9</span></code> (privilegeWithdrawn), <code class="ansible-value docutils literal notranslate"><span class="pre">10</span></code> (aACompromise).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -327,9 +329,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<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="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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</p>
|
||||
<p>If set to <code class="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>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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -343,7 +345,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-validate_certs" 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 calls to the ACME directory will validate TLS certificates.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -396,9 +398,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>Exactly one of <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>, <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>, <code class="docutils literal notranslate"><span class="pre">private_key_src</span></code> or <code class="docutils literal notranslate"><span class="pre">private_key_content</span></code> must be specified.</p></li>
|
||||
<li><p>Exactly one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-private-key-src"><span class="std std-ref"><span class="pre">private_key_src</span></span></a></strong></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-private-key-content"><span class="std std-ref"><span class="pre">private_key_content</span></span></a></strong></code> must be specified.</p></li>
|
||||
<li><p>Trying to revoke an already revoked certificate should result in an unchanged status, even if the revocation reason was different than the one specified here. Also, depending on the server, it can happen that some other error is returned if the certificate has already been revoked.</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="docutils literal notranslate"><span class="pre">select_crypto_backend</span></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>).</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-select-crypto-backend"><span class="std std-ref"><span class="pre">select_crypto_backend</span></span></a></strong></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-certificate-revoke-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>).</p></li>
|
||||
<li><p>Although the defaults are chosen so that the module can be used with the <a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a> CA, the module can in principle be used with any CA providing an ACME endpoint, such as <a class="reference external" href="https://www.buypass.com/ssl/products/acme">Buypass Go SSL</a>.</p></li>
|
||||
<li><p>So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and <a class="reference external" href="https://github.com/letsencrypt/Pebble">Pebble testing server</a>. We have got community feedback that they also work with Sectigo ACME Service for InCommon. If you experience problems with another ACME server, please <a class="reference external" href="https://github.com/ansible-collections/community.crypto/issues/new/choose">create an issue</a> to help us supporting it. Feedback that an ACME server not mentioned does work is also appreciated.</p></li>
|
||||
</ul>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>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 class="headerlink" href="#community-crypto-acme-challenge-cert-helper-module-prepare-certificates-required-for-acme-challenges-such-as-tls-alpn-01" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-acme-challenge-cert-helper-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -219,7 +221,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="parameter-challenge_data"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-challenge-cert-helper-module-parameter-challenge-data"><strong>challenge_data</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-challenge_data" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The <code class="docutils literal notranslate"><span class="pre">challenge_data</span></code> entry provided by <a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module"><span class="std std-ref">community.crypto.acme_certificate</span></a> for the challenge.</p>
|
||||
<td><div class="ansible-option-cell"><p>The <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module-return-challenge-data"><span class="std std-ref"><span class="pre">challenge_data</span></span></a></code> entry provided by <a class="reference internal" href="acme_certificate_module.html#ansible-collections-community-crypto-acme-certificate-module"><span class="std std-ref">community.crypto.acme_certificate</span></a> for the challenge.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -227,7 +229,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-private_key_content" 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>Content of the private key to use for this challenge certificate.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">private_key_src</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-challenge-cert-helper-module-parameter-private-key-src"><span class="std std-ref"><span class="pre">private_key_src</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -243,7 +245,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-private_key_src" 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>Path to a file containing the private key file to use for this challenge certificate.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">private_key_content</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-challenge-cert-helper-module-parameter-private-key-content"><span class="std std-ref"><span class="pre">private_key_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -366,7 +368,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="return-identifier"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-challenge-cert-helper-module-return-identifier"><strong>identifier</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-identifier" 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 identifier for the actual resource. Will be a domain name if the type is <code class="docutils literal notranslate"><span class="pre">dns</span></code>, or an IP address if the type is <code class="docutils literal notranslate"><span class="pre">ip</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The identifier for the actual resource. Will be a domain name if <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-challenge-cert-helper-module-return-identifier-type"><span class="std std-ref"><span class="pre">identifier_type=dns</span></span></a></code>, or an IP address if <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-acme-challenge-cert-helper-module-return-identifier-type"><span class="std std-ref"><span class="pre">identifier_type=ip</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -374,8 +376,13 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="return-identifier_type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-challenge-cert-helper-module-return-identifier-type"><strong>identifier_type</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-identifier_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 identifier type for the actual resource identifier. Will be <code class="docutils literal notranslate"><span class="pre">dns</span></code> or <code class="docutils literal notranslate"><span class="pre">ip</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The identifier type for the actual resource identifier.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> always</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Can only return:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"dns"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ip"</span></code></p></li>
|
||||
</ul>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.acme_inspect module – Send direct requests to an ACME server<a class="headerlink" href="#community-crypto-acme-inspect-module-send-direct-requests-to-an-acme-server" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-acme-inspect-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -213,8 +215,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-account_key_content" 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>Content of the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_src</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-account-key-src"><span class="std std-ref"><span class="pre">account_key_src</span></span></a></strong></code> is not used.</p>
|
||||
<p><strong>Warning:</strong> the content will be written into a temporary file, which will be deleted by Ansible when the module completes. Since this is an important private key — it can be used to change the account key, or to revoke your certificates without knowing their private keys —, this might not be acceptable.</p>
|
||||
<p>In case <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> is used, the content is not written into a temporary file. It can still happen that it is written to disk by Ansible in the process of moving the module with its argument to the node where it is executed.</p>
|
||||
</div></td>
|
||||
@@ -236,8 +238,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Path to a file containing the ACME account RSA or Elliptic Curve key.</p>
|
||||
<p>Private keys can be created with the <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> or <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> modules. If the requisite (cryptography) is not available, keys can also be created directly with the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> command line tool: RSA keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">genrsa</span> <span class="pre">...</span></code>. Elliptic curve keys can be created with <code class="docutils literal notranslate"><span class="pre">openssl</span> <span class="pre">ecparam</span> <span class="pre">-genkey</span> <span class="pre">...</span></code>. Any other tool creating private keys in PEM format can be used as well.</p>
|
||||
<p>Mutually exclusive with <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>.</p>
|
||||
<p>Required if <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code> is not used.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code> is not used.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -266,8 +268,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-acme_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The ACME version of the endpoint.</p>
|
||||
<p>Must be <code class="docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p>Must be <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> for the classic Let’s Encrypt and Buypass ACME endpoints, or <code class="ansible-value docutils literal notranslate"><span class="pre">2</span></code> for standardized ACME v2 endpoints.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code> is deprecated since community.crypto 2.0.0 and will be removed from community.crypto 3.0.0.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">1</span></code></p></li>
|
||||
@@ -279,15 +281,15 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="ansibleOptionAnchor" id="parameter-content"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-inspect-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>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>An encoded JSON object which will be sent as the content if <em>method</em> is <code class="docutils literal notranslate"><span class="pre">post</span></code>.</p>
|
||||
<p>Required when <em>method</em> is <code class="docutils literal notranslate"><span class="pre">post</span></code>, and not allowed otherwise.</p>
|
||||
<td><div class="ansible-option-cell"><p>An encoded JSON object which will be sent as the content if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-method"><span class="std std-ref"><span class="pre">method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">post</span></code>.</p>
|
||||
<p>Required when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-method"><span class="std std-ref"><span class="pre">method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">post</span></code>, and not allowed otherwise.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-fail_on_acme_error"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-acme-inspect-module-parameter-fail-on-acme-error"><strong>fail_on_acme_error</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-fail_on_acme_error" 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>If <em>method</em> is <code class="docutils literal notranslate"><span class="pre">post</span></code> or <code class="docutils literal notranslate"><span class="pre">get</span></code>, make the module fail in case an ACME error is returned.</p>
|
||||
<td><div class="ansible-option-cell"><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-method"><span class="std std-ref"><span class="pre">method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">post</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">get</span></code>, make the module fail in case an ACME error is returned.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -300,9 +302,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-method" 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 method to use to access the given URL on the ACME server.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">post</span></code> executes an authenticated POST request. The content must be specified in the <em>content</em> option.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">get</span></code> executes an authenticated POST-as-GET request for ACME v2, and a regular GET request for ACME v1.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">directory-only</span></code> only retrieves the directory, without doing a request.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">post</span></code> executes an authenticated POST request. The content must be specified in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-content"><span class="std std-ref"><span class="pre">content</span></span></a></strong></code> option.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">get</span></code> executes an authenticated POST-as-GET request for ACME v2, and a regular GET request for ACME v1.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">directory-only</span></code> only retrieves the directory, without doing a request.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"get"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -326,9 +328,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<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="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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</p>
|
||||
<p>If set to <code class="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>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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary.</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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -342,7 +344,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-url" 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 URL to send the request to.</p>
|
||||
<p>Must be specified if <em>method</em> is not <code class="docutils literal notranslate"><span class="pre">directory-only</span></code>.</p>
|
||||
<p>Must be specified if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-method"><span class="std std-ref"><span class="pre">method</span></span></a></strong></code> is not <code class="ansible-value docutils literal notranslate"><span class="pre">directory-only</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -350,7 +352,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<a class="ansibleOptionLink" href="#parameter-validate_certs" 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 calls to the ACME directory will validate TLS certificates.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p><strong>Warning:</strong> Should <strong>only ever</strong> be set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> for testing purposes, for example when testing against a local Pebble server.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -403,9 +405,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ac
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>The <em>account_uri</em> option must be specified for properly authenticated ACME v2 requests (except a <code class="docutils literal notranslate"><span class="pre">new-account</span></code> request).</p></li>
|
||||
<li><p>The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-account-uri"><span class="std std-ref"><span class="pre">account_uri</span></span></a></strong></code> option must be specified for properly authenticated ACME v2 requests (except a <code class="docutils literal notranslate"><span class="pre">new-account</span></code> request).</p></li>
|
||||
<li><p>Using the <code class="docutils literal notranslate"><span class="pre">ansible</span></code> tool, <a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module"><span class="std std-ref">community.crypto.acme_inspect</span></a> can be used to directly execute ACME requests without the need of writing a playbook. For example, the following command retrieves the ACME account with ID 1 from Let’s Encrypt (assuming <code class="docutils literal notranslate"><span class="pre">/path/to/key</span></code> is the correct private account key): <code class="docutils literal notranslate"><span class="pre">ansible</span> <span class="pre">localhost</span> <span class="pre">-m</span> <span class="pre">acme_inspect</span> <span class="pre">-a</span> <span class="pre">"account_key_src=/path/to/key</span> <span class="pre">acme_directory=https://acme-v02.api.letsencrypt.org/directory</span> <span class="pre">acme_version=2</span> <span class="pre">account_uri=https://acme-v02.api.letsencrypt.org/acme/acct/1</span> <span class="pre">method=get</span> <span class="pre">url=https://acme-v02.api.letsencrypt.org/acme/acct/1"</span></code></p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="docutils literal notranslate"><span class="pre">select_crypto_backend</span></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="docutils literal notranslate"><span class="pre">account_key_content</span></code>).</p></li>
|
||||
<li><p>If a new enough version of the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library is available (see Requirements for details), it will be used instead of the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary. This can be explicitly disabled or enabled with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-select-crypto-backend"><span class="std std-ref"><span class="pre">select_crypto_backend</span></span></a></strong></code> option. Note that using the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> binary will be slower and less secure, as private key contents always have to be stored on disk (see <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-acme-inspect-module-parameter-account-key-content"><span class="std std-ref"><span class="pre">account_key_content</span></span></a></strong></code>).</p></li>
|
||||
<li><p>Although the defaults are chosen so that the module can be used with the <a class="reference external" href="https://letsencrypt.org/">Let’s Encrypt</a> CA, the module can in principle be used with any CA providing an ACME endpoint, such as <a class="reference external" href="https://www.buypass.com/ssl/products/acme">Buypass Go SSL</a>.</p></li>
|
||||
<li><p>So far, the ACME modules have only been tested by the developers against Let’s Encrypt (staging and production), Buypass (staging and production), ZeroSSL (production), and <a class="reference external" href="https://github.com/letsencrypt/Pebble">Pebble testing server</a>. We have got community feedback that they also work with Sectigo ACME Service for InCommon. If you experience problems with another ACME server, please <a class="reference external" href="https://github.com/ansible-collections/community.crypto/issues/new/choose">create an issue</a> to help us supporting it. Feedback that an ACME server not mentioned does work is also appreciated.</p></li>
|
||||
</ul>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -163,7 +165,7 @@
|
||||
<h1>community.crypto.certificate_complete_chain module – Complete certificate chain given a set of untrusted and root certificates<a class="headerlink" href="#community-crypto-certificate-complete-chain-module-complete-certificate-chain-given-a-set-of-untrusted-and-root-certificates" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-certificate-complete-chain-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -277,7 +279,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ce
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ca-certificates/</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">www_ansible_com</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">Write root certificate to disk</span>
|
||||
<span class="w"> </span><span class="nt">copy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.copy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/csr/www.ansible.com-root.pem</span>
|
||||
<span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">www_ansible_com.root</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
|
||||
@@ -292,11 +294,11 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ce
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ca-certificates/</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">www_ansible_com</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">Write complete chain to disk</span>
|
||||
<span class="w"> </span><span class="nt">copy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.copy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/csr/www.ansible.com-completechain.pem</span>
|
||||
<span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="s1">''</span><span class="nv">.join</span><span class="o">(</span><span class="nv">www_ansible_com.complete_chain</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</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">Write root chain (intermediates and root) to disk</span>
|
||||
<span class="w"> </span><span class="nt">copy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.copy</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">dest</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/etc/ssl/csr/www.ansible.com-rootchain.pem</span>
|
||||
<span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="s1">''</span><span class="nv">.join</span><span class="o">(</span><span class="nv">www_ansible_com.chain</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
</pre></div>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -161,7 +163,7 @@
|
||||
<h1>community.crypto.crypto_info module – Retrieve cryptographic capabilities<a class="headerlink" href="#community-crypto-crypto-info-module-retrieve-cryptographic-capabilities" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.crypto.crypto_info</span></code>.</p>
|
||||
</div>
|
||||
@@ -240,7 +242,7 @@
|
||||
<a class="ansibleOptionLink" href="#return-openssl" 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>Information on the installed OpenSSL binary.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when <em>openssl_present=true</em></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-crypto-info-module-return-openssl-present"><span class="std std-ref"><span class="pre">openssl_present=true</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -284,7 +286,7 @@
|
||||
<a class="ansibleOptionLink" href="#return-python_cryptography_capabilities" 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>Information on the installed <a class="reference external" href="https://cryptography.io/">Python cryptography library</a>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when <em>python_cryptography_installed=true</em></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-crypto-info-module-return-python-cryptography-installed"><span class="std std-ref"><span class="pre">python_cryptography_installed=true</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -426,7 +428,7 @@
|
||||
<a class="ansibleOptionLink" href="#return-python_cryptography_import_error" 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>Import error when trying to import the <a class="reference external" href="https://cryptography.io/">Python cryptography library</a>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when <em>python_cryptography_installed=false</em></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-crypto-info-module-return-python-cryptography-installed"><span class="std std-ref"><span class="pre">python_cryptography_installed=false</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/sphinx_highlight.js"></script>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="../_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="../_static/jquery.js"></script>
|
||||
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||||
<script src="../_static/doctools.js"></script>
|
||||
<script src="../_static/sphinx_highlight.js"></script>
|
||||
@@ -148,13 +150,13 @@
|
||||
<section id="how-to-create-self-signed-certificates">
|
||||
<span id="ansible-collections-community-crypto-docsite-guide-selfsigned"></span><h1>How to create self-signed certificates<a class="headerlink" href="#how-to-create-self-signed-certificates" title="Permalink to this heading"></a></h1>
|
||||
<p>The <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> offers multiple modules that create private keys, certificate signing requests, and certificates. This guide shows how to create self-signed certificates.</p>
|
||||
<p>For creating any kind of certificate, you always have to start with a private key. You can use the <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 module</span></a> to create a private key. If you only specify <code class="docutils literal notranslate"><span class="pre">path</span></code>, the default parameters will be used. This will result in a 4096 bit RSA private key:</p>
|
||||
<p>For creating any kind of certificate, you always have to start with a private key. You can use the <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 module</span></a> to create a private key. If you only specify <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../openssl_privatekey_module.html#ansible-collections-community-crypto-openssl-privatekey-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code>, the default parameters will be used. This will result in a 4096 bit RSA private key:</p>
|
||||
<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">Create private key (RSA, 4096 bits)</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">/path/to/certificate.key</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>You can specify <code class="docutils literal notranslate"><span class="pre">type</span></code> to select another key type, <code class="docutils literal notranslate"><span class="pre">size</span></code> to select a different key size (only available for RSA and DSA keys), or <code class="docutils literal notranslate"><span class="pre">passphrase</span></code> if you want to store the key password-protected:</p>
|
||||
<p>You can specify <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../openssl_privatekey_module.html#ansible-collections-community-crypto-openssl-privatekey-module-parameter-type"><span class="std std-ref"><span class="pre">type</span></span></a></strong></code> to select another key type, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../openssl_privatekey_module.html#ansible-collections-community-crypto-openssl-privatekey-module-parameter-size"><span class="std std-ref"><span class="pre">size</span></span></a></strong></code> to select a different key size (only available for RSA and DSA keys), or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../openssl_privatekey_module.html#ansible-collections-community-crypto-openssl-privatekey-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> if you want to store the key password-protected:</p>
|
||||
<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">Create private key (X25519) with password protection</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">/path/to/certificate.key</span>
|
||||
@@ -170,8 +172,8 @@
|
||||
<span class="w"> </span><span class="nt">provider</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">selfsigned</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>(If you used <code class="docutils literal notranslate"><span class="pre">passphrase</span></code> for the private key, you have to provide <code class="docutils literal notranslate"><span class="pre">privatekey_passphrase</span></code>.)</p>
|
||||
<p>You can use <code class="docutils literal notranslate"><span class="pre">selfsigned_not_after</span></code> to define when the certificate expires (default: in roughly 10 years), and <code class="docutils literal notranslate"><span class="pre">selfsigned_not_before</span></code> to define from when the certificate is valid (default: now).</p>
|
||||
<p>(If you used <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../openssl_privatekey_module.html#ansible-collections-community-crypto-openssl-privatekey-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> for the private key, you have to provide <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module-parameter-privatekey-passphrase"><span class="std std-ref"><span class="pre">privatekey_passphrase</span></span></a></strong></code>.)</p>
|
||||
<p>You can use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module-parameter-selfsigned-not-after"><span class="std std-ref"><span class="pre">selfsigned_not_after</span></span></a></strong></code> to define when the certificate expires (default: in roughly 10 years), and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="../x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module-parameter-selfsigned-not-before"><span class="std std-ref"><span class="pre">selfsigned_not_before</span></span></a></strong></code> to define from when the certificate is valid (default: now).</p>
|
||||
<p>To define further properties of the certificate, like the subject, Subject Alternative Names (SANs), key usages, name constraints, etc., you need to first create a Certificate Signing Request (CSR) and provide it to the <a class="reference internal" href="../x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate module</span></a>. If you do not need the CSR file, you can use the <a class="reference internal" href="../openssl_csr_pipe_module.html#ansible-collections-community-crypto-openssl-csr-pipe-module"><span class="std std-ref">community.crypto.openssl_csr_pipe module</span></a> as in the example below. (To store it to disk, use the <a class="reference internal" href="../openssl_csr_module.html#ansible-collections-community-crypto-openssl-csr-module"><span class="std std-ref">community.crypto.openssl_csr module</span></a> instead.)</p>
|
||||
<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">Create certificate signing request (CSR) for self-signed certificate</span>
|
||||
<span class="w"> </span><span class="nt">community.crypto.openssl_csr_pipe</span><span class="p">:</span>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.ecs_certificate module – Request SSL/TLS certificates with the Entrust Certificate Services (ECS) API<a class="headerlink" href="#community-crypto-ecs-certificate-module-request-ssl-tls-certificates-with-the-entrust-certificate-services-ecs-api" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-ecs-certificate-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -219,7 +221,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="parameter-backup"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-backup"><strong>backup</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-backup" 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 a backup should be made for the certificate in <em>path</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether a backup should be made for the certificate in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -231,12 +233,12 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="parameter-cert_expiry"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-expiry"><strong>cert_expiry</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-cert_expiry" 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 date the certificate should be set to expire, in RFC3339 compliant date or date-time format. For example, <code class="docutils literal notranslate"><span class="pre">2020-02-23</span></code>, <code class="docutils literal notranslate"><span class="pre">2020-02-23T15:00:00.05Z</span></code>.</p>
|
||||
<p><em>cert_expiry</em> is only supported for requests of <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code> or <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>. If <code class="docutils literal notranslate"><span class="pre">request_type=reissue</span></code>, <em>cert_expiry</em> will be used for the first certificate issuance, but subsequent issuances will have the same expiry as the initial certificate.</p>
|
||||
<td><div class="ansible-option-cell"><p>The date the certificate should be set to expire, in RFC3339 compliant date or date-time format. For example, <code class="ansible-value docutils literal notranslate"><span class="pre">2020-02-23</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">2020-02-23T15:00:00.05Z</span></code>.</p>
|
||||
<p><code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-expiry"><span class="std std-ref"><span class="pre">cert_expiry</span></span></a></strong></code> is only supported for requests of <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=new</span></span></a></code> or <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=renew</span></span></a></code>. If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=reissue</span></span></a></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-expiry"><span class="std std-ref"><span class="pre">cert_expiry</span></span></a></strong></code> will be used for the first certificate issuance, but subsequent issuances will have the same expiry as the initial certificate.</p>
|
||||
<p>A reissued certificate will always have the same expiry as the original certificate.</p>
|
||||
<p>Note that only the date (day, month, year) is supported for specifying the expiry date. If you choose to specify an expiry time with the expiry date, the time will be adjusted to Eastern Standard Time (EST). This could have the unintended effect of moving your expiry date to the previous day.</p>
|
||||
<p>Applies only to accounts with a pooling inventory model.</p>
|
||||
<p>Only one of <em>cert_expiry</em> or <em>cert_lifetime</em> may be specified.</p>
|
||||
<p>Only one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-expiry"><span class="std std-ref"><span class="pre">cert_expiry</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-lifetime"><span class="std std-ref"><span class="pre">cert_lifetime</span></span></a></strong></code> may be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -245,12 +247,12 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The lifetime of the certificate.</p>
|
||||
<p>Applies to all certificates for accounts with a non-pooling inventory model.</p>
|
||||
<p><em>cert_lifetime</em> is only supported for requests of <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code> or <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>. If <code class="docutils literal notranslate"><span class="pre">request_type=reissue</span></code>, <em>cert_lifetime</em> will be used for the first certificate issuance, but subsequent issuances will have the same expiry as the initial certificate.</p>
|
||||
<p>Applies to certificates of <em>cert_type</em>=<code class="docutils literal notranslate"><span class="pre">CDS_INDIVIDUAL,</span> <span class="pre">CDS_GROUP,</span> <span class="pre">CDS_ENT_LITE,</span> <span class="pre">CDS_ENT_PRO,</span> <span class="pre">SMIME_ENT</span></code> for accounts with a pooling inventory model.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">P1Y</span></code> is a certificate with a 1 year lifetime.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">P2Y</span></code> is a certificate with a 2 year lifetime.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">P3Y</span></code> is a certificate with a 3 year lifetime.</p>
|
||||
<p>Only one of <em>cert_expiry</em> or <em>cert_lifetime</em> may be specified.</p>
|
||||
<p><code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-lifetime"><span class="std std-ref"><span class="pre">cert_lifetime</span></span></a></strong></code> is only supported for requests of <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=new</span></span></a></code> or <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=renew</span></span></a></code>. If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=reissue</span></span></a></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-lifetime"><span class="std std-ref"><span class="pre">cert_lifetime</span></span></a></strong></code> will be used for the first certificate issuance, but subsequent issuances will have the same expiry as the initial certificate.</p>
|
||||
<p>Applies to certificates of <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-type"><span class="std std-ref"><span class="pre">cert_type=CDS_INDIVIDUAL</span></span></a></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">CDS_GROUP</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">CDS_ENT_LITE</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">CDS_ENT_PRO</span></code>, or <code class="ansible-value docutils literal notranslate"><span class="pre">SMIME_ENT</span></code> for accounts with a pooling inventory model.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">P1Y</span></code> is a certificate with a 1 year lifetime.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">P2Y</span></code> is a certificate with a 2 year lifetime.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">P3Y</span></code> is a certificate with a 3 year lifetime.</p>
|
||||
<p>Only one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-expiry"><span class="std std-ref"><span class="pre">cert_expiry</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-lifetime"><span class="std std-ref"><span class="pre">cert_lifetime</span></span></a></strong></code> may be specified.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"P1Y"</span></code></p></li>
|
||||
@@ -264,7 +266,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#parameter-cert_type" 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>Specify the type of certificate requested.</p>
|
||||
<p>If a certificate is being reissued or renewed, this parameter is ignored, and the <code class="docutils literal notranslate"><span class="pre">cert_type</span></code> of the initial certificate is used.</p>
|
||||
<p>If a certificate is being reissued or renewed, this parameter is ignored, and the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-type"><span class="std std-ref"><span class="pre">cert_type</span></span></a></strong></code> of the initial certificate is used.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"STANDARD_SSL"</span></code></p></li>
|
||||
@@ -290,7 +292,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The client ID to submit the Certificate Signing Request under.</p>
|
||||
<p>If no client ID is specified, the certificate will be submitted under the primary client with ID of 1.</p>
|
||||
<p>When using a client other than the primary client, the <em>org</em> parameter cannot be specified.</p>
|
||||
<p>When using a client other than the primary client, the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-org"><span class="std std-ref"><span class="pre">org</span></span></a></strong></code> parameter cannot be specified.</p>
|
||||
<p>The issued certificate will have an organization value in the subject distinguished name represented by the client.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">1</span></code></p>
|
||||
</div></td>
|
||||
@@ -299,12 +301,12 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="parameter-csr"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><strong>csr</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-csr" 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>Base-64 encoded Certificate Signing Request (CSR). <em>csr</em> is accepted with or without PEM formatting around the Base-64 string.</p>
|
||||
<p>If no <em>csr</em> is provided when <code class="docutils literal notranslate"><span class="pre">request_type=reissue</span></code> or <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>, the certificate will be generated with the same public key as the certificate being renewed or reissued.</p>
|
||||
<p>If <em>subject_alt_name</em> is specified, it will override the subject alternate names in the CSR.</p>
|
||||
<p>If <em>eku</em> is specified, it will override the extended key usage in the CSR.</p>
|
||||
<p>If <em>ou</em> is specified, it will override the organizational units “ou=” present in the subject distinguished name of the CSR, if any.</p>
|
||||
<p>The organization “O=” field from the CSR will not be used. It will be replaced in the issued certificate by <em>org</em> if present, and if not present, the organization tied to <em>client_id</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Base-64 encoded Certificate Signing Request (CSR). <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code> is accepted with or without PEM formatting around the Base-64 string.</p>
|
||||
<p>If no <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code> is provided when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=reissue</span></span></a></code> or <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=renew</span></span></a></code>, the certificate will be generated with the same public key as the certificate being renewed or reissued.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-subject-alt-name"><span class="std std-ref"><span class="pre">subject_alt_name</span></span></a></strong></code> is specified, it will override the subject alternate names in the CSR.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-eku"><span class="std std-ref"><span class="pre">eku</span></span></a></strong></code> is specified, it will override the extended key usage in the CSR.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><span class="std std-ref"><span class="pre">ou</span></span></a></strong></code> is specified, it will override the organizational units “ou=” present in the subject distinguished name of the CSR, if any.</p>
|
||||
<p>The organization “O=” field from the CSR will not be used. It will be replaced in the issued certificate by <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-org"><span class="std std-ref"><span class="pre">org</span></span></a></strong></code> if present, and if not present, the organization tied to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-client-id"><span class="std std-ref"><span class="pre">client_id</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -312,9 +314,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#parameter-ct_log" 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>In compliance with browser requirements, this certificate may be posted to the Certificate Transparency (CT) logs. This is a best practice technique that helps domain owners monitor certificates issued to their domains. Note that not all certificates are eligible for CT logging.</p>
|
||||
<p>If <em>ct_log</em> is not specified, the certificate uses the account default.</p>
|
||||
<p>If <em>ct_log</em> is specified and the account settings allow it, <em>ct_log</em> overrides the account default.</p>
|
||||
<p>If <em>ct_log</em> is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, but the account settings are set to “always log”, the certificate generation will fail.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ct-log"><span class="std std-ref"><span class="pre">ct_log</span></span></a></strong></code> is not specified, the certificate uses the account default.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ct-log"><span class="std std-ref"><span class="pre">ct_log</span></span></a></strong></code> is specified and the account settings allow it, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ct-log"><span class="std std-ref"><span class="pre">ct_log</span></span></a></strong></code> overrides the account default.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ct-log"><span class="std std-ref"><span class="pre">ct_log</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>, but the account settings are set to “always log”, the certificate generation will fail.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -580,7 +582,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="parameter-eku"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-eku"><strong>eku</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-eku" 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>If specified, overrides the key usage in the <em>csr</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>If specified, overrides the key usage in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"SERVER_AUTH"</span></code></p></li>
|
||||
@@ -593,8 +595,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="parameter-end_user_key_storage_agreement"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-end-user-key-storage-agreement"><strong>end_user_key_storage_agreement</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-end_user_key_storage_agreement" 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>The end user of the Code Signing certificate must generate and store the private key for this request on cryptographically secure hardware to be compliant with the Entrust CSP and Subscription agreement. If requesting a certificate of type <code class="docutils literal notranslate"><span class="pre">CODE_SIGNING</span></code> or <code class="docutils literal notranslate"><span class="pre">EV_CODE_SIGNING</span></code>, you must set <em>end_user_key_storage_agreement</em> to true if and only if you acknowledge that you will inform the user of this requirement.</p>
|
||||
<p>Applicable only to <em>cert_type</em> of values <code class="docutils literal notranslate"><span class="pre">CODE_SIGNING</span></code> and <code class="docutils literal notranslate"><span class="pre">EV_CODE_SIGNING</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The end user of the Code Signing certificate must generate and store the private key for this request on cryptographically secure hardware to be compliant with the Entrust CSP and Subscription agreement. If requesting a certificate of type <code class="ansible-value docutils literal notranslate"><span class="pre">CODE_SIGNING</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">EV_CODE_SIGNING</span></code>, you must set <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-end-user-key-storage-agreement"><span class="std std-ref"><span class="pre">end_user_key_storage_agreement</span></span></a></strong></code> to true if and only if you acknowledge that you will inform the user of this requirement.</p>
|
||||
<p>Applicable only to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-type"><span class="std std-ref"><span class="pre">cert_type</span></span></a></strong></code> of values <code class="ansible-value docutils literal notranslate"><span class="pre">CODE_SIGNING</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">EV_CODE_SIGNING</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -643,8 +645,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="parameter-force"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-force"><strong>force</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force" 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>If force is used, a certificate is requested regardless of whether <em>path</em> points to an existing valid certificate.</p>
|
||||
<p>If <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>, a forced renew will fail if the certificate being renewed has been issued within the past 30 days, regardless of the value of <em>remaining_days</em> or the return value of <em>cert_days</em> - the ECS API does not support the “renew” operation for certificates that are not at least 30 days old.</p>
|
||||
<td><div class="ansible-option-cell"><p>If force is used, a certificate is requested regardless of whether <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> points to an existing valid certificate.</p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=renew</span></span></a></code>, a forced renew will fail if the certificate being renewed has been issued within the past 30 days, regardless of the value of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code> or the return value of <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-return-cert-days"><span class="std std-ref"><span class="pre">cert_days</span></span></a></code> - the ECS API does not support the “renew” operation for certificates that are not at least 30 days old.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -664,8 +666,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#parameter-org" 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>Organization “O=” to include in the certificate.</p>
|
||||
<p>If <em>org</em> is not specified, the organization from the client represented by <em>client_id</em> is used.</p>
|
||||
<p>Unless the <em>cert_type</em> is <code class="docutils literal notranslate"><span class="pre">PD_SSL</span></code>, this field may not be specified if the value of <em>client_id</em> is not “1” (the primary client). non-primary clients, certificates may only be issued with the organization of that client.</p>
|
||||
<p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-org"><span class="std std-ref"><span class="pre">org</span></span></a></strong></code> is not specified, the organization from the client represented by <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-client-id"><span class="std std-ref"><span class="pre">client_id</span></span></a></strong></code> is used.</p>
|
||||
<p>Unless the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-type"><span class="std std-ref"><span class="pre">cert_type</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">PD_SSL</span></code>, this field may not be specified if the value of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-client-id"><span class="std std-ref"><span class="pre">client_id</span></span></a></strong></code> is not “1” (the primary client). non-primary clients, certificates may only be issued with the organization of that client.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -673,10 +675,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#parameter-ou" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Organizational unit “OU=” to include in the certificate.</p>
|
||||
<p><em>ou</em> behavior is dependent on whether organizational units are enabled for your account. If organizational unit support is disabled for your account, organizational units from the <em>csr</em> and the <em>ou</em> parameter are ignored.</p>
|
||||
<p>If both <em>csr</em> and <em>ou</em> are specified, the value in <em>ou</em> will override the OU fields present in the subject distinguished name in the <em>csr</em></p>
|
||||
<p>If neither <em>csr</em> nor <em>ou</em> are specified for a renew or reissue operation, the OU fields in the initial certificate are reused.</p>
|
||||
<p>An invalid OU from <em>csr</em> is ignored, but any invalid organizational units in <em>ou</em> will result in an error indicating “Unapproved OU”. The <em>ou</em> parameter can be used to force failure if an unapproved organizational unit is provided.</p>
|
||||
<p><code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><span class="std std-ref"><span class="pre">ou</span></span></a></strong></code> behavior is dependent on whether organizational units are enabled for your account. If organizational unit support is disabled for your account, organizational units from the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code> and the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><span class="std std-ref"><span class="pre">ou</span></span></a></strong></code> parameter are ignored.</p>
|
||||
<p>If both <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><span class="std std-ref"><span class="pre">ou</span></span></a></strong></code> are specified, the value in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><span class="std std-ref"><span class="pre">ou</span></span></a></strong></code> will override the OU fields present in the subject distinguished name in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code></p>
|
||||
<p>If neither <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code> nor <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><span class="std std-ref"><span class="pre">ou</span></span></a></strong></code> are specified for a renew or reissue operation, the OU fields in the initial certificate are reused.</p>
|
||||
<p>An invalid OU from <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></strong></code> is ignored, but any invalid organizational units in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><span class="std std-ref"><span class="pre">ou</span></span></a></strong></code> will result in an error indicating “Unapproved OU”. The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-ou"><span class="std std-ref"><span class="pre">ou</span></span></a></strong></code> parameter can be used to force failure if an unapproved organizational unit is provided.</p>
|
||||
<p>A maximum of one OU may be specified for current products. Multiple OUs are reserved for future products.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -686,18 +688,18 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The destination path for the generated certificate as a PEM encoded cert.</p>
|
||||
<p>If the certificate at this location is not an Entrust issued certificate, a new certificate will always be requested even if the current certificate is technically valid.</p>
|
||||
<p>If there is already an Entrust certificate at this location, whether it is replaced is depends on the <em>remaining_days</em> calculation.</p>
|
||||
<p>If an existing certificate is being replaced (see <em>remaining_days</em>, <em>force</em>, and <em>tracking_id</em>), whether a new certificate is requested or the existing certificate is renewed or reissued is based on <em>request_type</em>.</p>
|
||||
<p>If there is already an Entrust certificate at this location, whether it is replaced is depends on the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code> calculation.</p>
|
||||
<p>If an existing certificate is being replaced (see <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code>), whether a new certificate is requested or the existing certificate is renewed or reissued is based on <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-remaining_days"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><strong>remaining_days</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remaining_days" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The number of days the certificate must have left being valid. If <code class="docutils literal notranslate"><span class="pre">cert_days</span> <span class="pre"><</span> <span class="pre">remaining_days</span></code> then a new certificate will be obtained using <em>request_type</em>.</p>
|
||||
<p>If <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>, a renewal will fail if the certificate being renewed has been issued within the past 30 days, so do not set a <em>remaining_days</em> value that is within 30 days of the full lifetime of the certificate being acted upon.</p>
|
||||
<p>For exmaple, if you are requesting Certificates with a 90 day lifetime, do not set <em>remaining_days</em> to a value <code class="docutils literal notranslate"><span class="pre">60</span></code> or higher).</p>
|
||||
<p>The <em>force</em> option may be used to ensure that a new certificate is always obtained.</p>
|
||||
<td><div class="ansible-option-cell"><p>The number of days the certificate must have left being valid. If <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-return-cert-days"><span class="std std-ref"><span class="pre">cert_days</span></span></a></code> < <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code> then a new certificate will be obtained using <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type</span></span></a></strong></code>.</p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=renew</span></span></a></code>, a renewal will fail if the certificate being renewed has been issued within the past 30 days, so do not set a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code> value that is within 30 days of the full lifetime of the certificate being acted upon.</p>
|
||||
<p>For exmaple, if you are requesting Certificates with a 90 day lifetime, do not set <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code> to a value <code class="ansible-value docutils literal notranslate"><span class="pre">60</span></code> or higher).</p>
|
||||
<p>The <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code> option may be used to ensure that a new certificate is always obtained.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">30</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -705,15 +707,15 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="parameter-request_type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><strong>request_type</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-request_type" 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 operation performed if <em>tracking_id</em> references a valid certificate to reissue, or there is already a certificate present in <em>path</em> but either <em>force</em> is specified or <code class="docutils literal notranslate"><span class="pre">cert_days</span> <span class="pre"><</span> <span class="pre">remaining_days</span></code>.</p>
|
||||
<p>Specifying <code class="docutils literal notranslate"><span class="pre">request_type=validate_only</span></code> means the request will be validated against the ECS API, but no certificate will be issued.</p>
|
||||
<p>Specifying <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code> means a certificate request will always be submitted and a new certificate issued.</p>
|
||||
<p>Specifying <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code> means that an existing certificate (specified by <em>tracking_id</em> if present, otherwise <em>path</em>) will be renewed. If there is no certificate to renew, a new certificate is requested.</p>
|
||||
<p>Specifying <code class="docutils literal notranslate"><span class="pre">request_type=reissue</span></code> means that an existing certificate (specified by <em>tracking_id</em> if present, otherwise <em>path</em>) will be reissued. If there is no certificate to reissue, a new certificate is requested.</p>
|
||||
<p>If a certificate was issued within the past 30 days, the <code class="docutils literal notranslate"><span class="pre">renew</span></code> operation is not a valid operation and will fail.</p>
|
||||
<p>Note that <code class="docutils literal notranslate"><span class="pre">reissue</span></code> is an operation that will result in the revocation of the certificate that is reissued, be cautious with its use.</p>
|
||||
<p><em>check_mode</em> is only supported if <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code></p>
|
||||
<p>For example, setting <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code> and <code class="docutils literal notranslate"><span class="pre">remaining_days=30</span></code> and pointing to the same certificate on multiple playbook runs means that on the first run new certificate will be requested. It will then be left along on future runs until it is within 30 days of expiry, then the ECS “renew” operation will be performed.</p>
|
||||
<td><div class="ansible-option-cell"><p>The operation performed if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> references a valid certificate to reissue, or there is already a certificate present in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> but either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code> is specified or <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-return-cert-days"><span class="std std-ref"><span class="pre">cert_days</span></span></a></code> < <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code>.</p>
|
||||
<p>Specifying <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=validate_only</span></span></a></code> means the request will be validated against the ECS API, but no certificate will be issued.</p>
|
||||
<p>Specifying <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=new</span></span></a></code> means a certificate request will always be submitted and a new certificate issued.</p>
|
||||
<p>Specifying <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=renew</span></span></a></code> means that an existing certificate (specified by <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> if present, otherwise <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code>) will be renewed. If there is no certificate to renew, a new certificate is requested.</p>
|
||||
<p>Specifying <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=reissue</span></span></a></code> means that an existing certificate (specified by <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> if present, otherwise <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code>) will be reissued. If there is no certificate to reissue, a new certificate is requested.</p>
|
||||
<p>If a certificate was issued within the past 30 days, the <code class="ansible-value docutils literal notranslate"><span class="pre">renew</span></code> operation is not a valid operation and will fail.</p>
|
||||
<p>Note that <code class="ansible-value docutils literal notranslate"><span class="pre">reissue</span></code> is an operation that will result in the revocation of the certificate that is reissued, be cautious with its use.</p>
|
||||
<p><em>check_mode</em> is only supported if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=new</span></span></a></code></p>
|
||||
<p>For example, setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=renew</span></span></a></code> and <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days=30</span></span></a></code> and pointing to the same certificate on multiple playbook runs means that on the first run new certificate will be requested. It will then be left along on future runs until it is within 30 days of expiry, then the ECS “renew” operation will be performed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"new"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -748,10 +750,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="parameter-subject_alt_name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-module-parameter-subject-alt-name"><strong>subject_alt_name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-subject_alt_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The subject alternative name identifiers, as an array of values (applies to <em>cert_type</em> with a value of <code class="docutils literal notranslate"><span class="pre">STANDARD_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">ADVANTAGE_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">UC_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">EV_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">WILDCARD_SSL</span></code>, <code class="docutils literal notranslate"><span class="pre">PRIVATE_SSL</span></code>, and <code class="docutils literal notranslate"><span class="pre">PD_SSL</span></code>).</p>
|
||||
<p>If you are requesting a new SSL certificate, and you pass a <em>subject_alt_name</em> parameter, any SAN names in the CSR are ignored. If no subjectAltName parameter is passed, the SAN names in the CSR are used.</p>
|
||||
<p>See <em>request_type</em> to understand more about SANs during reissues and renewals.</p>
|
||||
<p>In the case of certificates of type <code class="docutils literal notranslate"><span class="pre">STANDARD_SSL</span></code> certificates, if the CN of the certificate is <domain>.<tld> only the www.<domain>.<tld> value is accepted. If the CN of the certificate is www.<domain>.<tld> only the <domain>.<tld> value is accepted.</p>
|
||||
<td><div class="ansible-option-cell"><p>The subject alternative name identifiers, as an array of values (applies to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-cert-type"><span class="std std-ref"><span class="pre">cert_type</span></span></a></strong></code> with a value of <code class="ansible-value docutils literal notranslate"><span class="pre">STANDARD_SSL</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ADVANTAGE_SSL</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">UC_SSL</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">EV_SSL</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">WILDCARD_SSL</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">PRIVATE_SSL</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">PD_SSL</span></code>).</p>
|
||||
<p>If you are requesting a new SSL certificate, and you pass a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-subject-alt-name"><span class="std std-ref"><span class="pre">subject_alt_name</span></span></a></strong></code> parameter, any SAN names in the CSR are ignored. If no subjectAltName parameter is passed, the SAN names in the CSR are used.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type</span></span></a></strong></code> to understand more about SANs during reissues and renewals.</p>
|
||||
<p>In the case of certificates of type <code class="ansible-value docutils literal notranslate"><span class="pre">STANDARD_SSL</span></code> certificates, if the CN of the certificate is <domain>.<tld> only the www.<domain>.<tld> value is accepted. If the CN of the certificate is www.<domain>.<tld> only the <domain>.<tld> value is accepted.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -759,11 +761,11 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#parameter-tracking_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The tracking ID of the certificate to reissue or renew.</p>
|
||||
<p><em>tracking_id</em> is invalid if <code class="docutils literal notranslate"><span class="pre">request_type=new</span></code> or <code class="docutils literal notranslate"><span class="pre">request_type=validate_only</span></code>.</p>
|
||||
<p>If there is a certificate present in <em>path</em> and it is an ECS certificate, <em>tracking_id</em> will be ignored.</p>
|
||||
<p>If there is no certificate present in <em>path</em> or there is but it is from another provider, the certificate represented by <em>tracking_id</em> will be renewed or reissued and saved to <em>path</em>.</p>
|
||||
<p>If there is no certificate present in <em>path</em> and the <em>force</em> and <em>remaining_days</em> parameters do not indicate a new certificate is needed, the certificate referenced by <em>tracking_id</em> certificate will be saved to <em>path</em>.</p>
|
||||
<p>This can be used when a known certificate is not currently present on a server, but you want to renew or reissue it to be managed by an ansible playbook. For example, if you specify <code class="docutils literal notranslate"><span class="pre">request_type=renew</span></code>, <em>tracking_id</em> of an issued certificate, and <em>path</em> to a file that does not exist, the first run of a task will download the certificate specified by <em>tracking_id</em> (assuming it is still valid). Future runs of the task will (if applicable - see <em>force</em> and <em>remaining_days</em>) renew the certificate now present in <em>path</em>.</p>
|
||||
<p><code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> is invalid if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=new</span></span></a></code> or <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=validate_only</span></span></a></code>.</p>
|
||||
<p>If there is a certificate present in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> and it is an ECS certificate, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> will be ignored.</p>
|
||||
<p>If there is no certificate present in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> or there is but it is from another provider, the certificate represented by <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> will be renewed or reissued and saved to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code>.</p>
|
||||
<p>If there is no certificate present in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> and the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code> parameters do not indicate a new certificate is needed, the certificate referenced by <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> certificate will be saved to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code>.</p>
|
||||
<p>This can be used when a known certificate is not currently present on a server, but you want to renew or reissue it to be managed by an ansible playbook. For example, if you specify <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=renew</span></span></a></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> of an issued certificate, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> to a file that does not exist, the first run of a task will download the certificate specified by <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-tracking-id"><span class="std std-ref"><span class="pre">tracking_id</span></span></a></strong></code> (assuming it is still valid). Future runs of the task will (if applicable - see <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-remaining-days"><span class="std std-ref"><span class="pre">remaining_days</span></span></a></strong></code>) renew the certificate now present in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -790,7 +792,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="attribute-check_mode"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-certificate-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><span class="ansible-attribute-support-label">Support: </span><span class="ansible-attribute-support-partial">partial</span></p>
|
||||
<p>Check mode is only supported if <em>request_type=new</em>.</p>
|
||||
<p>Check mode is only supported if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-request-type"><span class="std std-ref"><span class="pre">request_type=new</span></span></a></code>.</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>
|
||||
@@ -819,7 +821,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">path</span></code> must be specified as the output location of the certificate.</p></li>
|
||||
<li><p><code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> must be specified as the output location of the certificate.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@@ -967,7 +969,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created for the certificate.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/www.ansible.com.crt.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -976,7 +978,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#return-backup_full_chain_file" 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>Name of the backup file created for the certificate chain.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code> and <em>full_chain_path</em> is set.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-certificate-module-parameter-full-chain-path"><span class="std std-ref"><span class="pre">full_chain_path</span></span></a></strong></code> is set.</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/ca.chain.crt.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -1003,7 +1005,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#return-cert_status" 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 certificate status in ECS.</p>
|
||||
<p>Current possible values (which may be expanded in the future) are: <code class="docutils literal notranslate"><span class="pre">ACTIVE</span></code>, <code class="docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="docutils literal notranslate"><span class="pre">DEACTIVATED</span></code>, <code class="docutils literal notranslate"><span class="pre">DECLINED</span></code>, <code class="docutils literal notranslate"><span class="pre">EXPIRED</span></code>, <code class="docutils literal notranslate"><span class="pre">NA</span></code>, <code class="docutils literal notranslate"><span class="pre">PENDING</span></code>, <code class="docutils literal notranslate"><span class="pre">PENDING_QUORUM</span></code>, <code class="docutils literal notranslate"><span class="pre">READY</span></code>, <code class="docutils literal notranslate"><span class="pre">REISSUED</span></code>, <code class="docutils literal notranslate"><span class="pre">REISSUING</span></code>, <code class="docutils literal notranslate"><span class="pre">RENEWED</span></code>, <code class="docutils literal notranslate"><span class="pre">RENEWING</span></code>, <code class="docutils literal notranslate"><span class="pre">REVOKED</span></code>, <code class="docutils literal notranslate"><span class="pre">SUSPENDED</span></code></p>
|
||||
<p>Current possible values (which may be expanded in the future) are: <code class="ansible-value docutils literal notranslate"><span class="pre">ACTIVE</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">DEACTIVATED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">DECLINED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">NA</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">PENDING</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">PENDING_QUORUM</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">READY</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">REISSUED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">REISSUING</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">RENEWED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">RENEWING</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">REVOKED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">SUSPENDED</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"ACTIVE"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.ecs_domain module – Request validation of a domain with the Entrust Certificate Services (ECS) API<a class="headerlink" href="#community-crypto-ecs-domain-module-request-validation-of-a-domain-with-the-entrust-certificate-services-ecs-api" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-ecs-domain-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -190,11 +192,11 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<li><p>Request validation or re-validation of a domain with the Entrust Certificate Services (ECS) API.</p></li>
|
||||
<li><p>Requires credentials for the <a class="reference external" href="https://www.entrustdatacard.com/products/categories/ssl-certificates">Entrust Certificate Services</a> (ECS) API.</p></li>
|
||||
<li><p>If the domain is already in the validation process, no new validation will be requested, but the validation data (if applicable) will be returned.</p></li>
|
||||
<li><p>If the domain is already in the validation process but the <em>verification_method</em> specified is different than the current <em>verification_method</em>, the <em>verification_method</em> will be updated and validation data (if applicable) will be returned.</p></li>
|
||||
<li><p>If the domain is an active, validated domain, the return value of <em>changed</em> will be false, unless <code class="docutils literal notranslate"><span class="pre">domain_status=EXPIRED</span></code>, in which case a re-validation will be performed.</p></li>
|
||||
<li><p>If <code class="docutils literal notranslate"><span class="pre">verification_method=dns</span></code>, details about the required DNS entry will be specified in the return parameters <em>dns_contents</em>, <em>dns_location</em>, and <em>dns_resource_type</em>.</p></li>
|
||||
<li><p>If <code class="docutils literal notranslate"><span class="pre">verification_method=web_server</span></code>, details about the required file details will be specified in the return parameters <em>file_contents</em> and <em>file_location</em>.</p></li>
|
||||
<li><p>If <code class="docutils literal notranslate"><span class="pre">verification_method=email</span></code>, the email address(es) that the validation email(s) were sent to will be in the return parameter <em>emails</em>. This is purely informational. For domains requested using this module, this will always be a list of size 1.</p></li>
|
||||
<li><p>If the domain is already in the validation process but the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> specified is different than the current <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code>, the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> will be updated and validation data (if applicable) will be returned.</p></li>
|
||||
<li><p>If the domain is an active, validated domain, the return value of <code class="docutils literal notranslate"><span class="pre">changed</span></code> will be false, unless <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-domain-status"><span class="std std-ref"><span class="pre">domain_status=EXPIRED</span></span></a></code>, in which case a re-validation will be performed.</p></li>
|
||||
<li><p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=dns</span></span></a></code>, details about the required DNS entry will be specified in the return parameters <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><span class="std std-ref"><span class="pre">dns_contents</span></span></a></code>, <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><span class="std std-ref"><span class="pre">dns_location</span></span></a></code>, and <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-resource-type"><span class="std std-ref"><span class="pre">dns_resource_type</span></span></a></code>.</p></li>
|
||||
<li><p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=web_server</span></span></a></code>, details about the required file details will be specified in the return parameters <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-file-contents"><span class="std std-ref"><span class="pre">file_contents</span></span></a></code> and <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-file-location"><span class="std std-ref"><span class="pre">file_location</span></span></a></code>.</p></li>
|
||||
<li><p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=email</span></span></a></code>, the email address(es) that the validation email(s) were sent to will be in the return parameter <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-emails"><span class="std std-ref"><span class="pre">emails</span></span></a></code>. This is purely informational. For domains requested using this module, this will always be a list of size 1.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
@@ -271,12 +273,12 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#parameter-verification_email" 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>Email address to be used to verify domain ownership.</p>
|
||||
<p>Email address must be either an email address present in the WHOIS data for <em>domain_name</em>, or one of the following constructed emails: admin@<em>domain_name</em>, administrator@<em>domain_name</em>, webmaster@<em>domain_name</em>, hostmaster@<em>domain_name</em>, postmaster@<em>domain_name</em>.</p>
|
||||
<p>Note that if <em>domain_name</em> includes subdomains, the top level domain should be used. For example, if requesting validation of example1.ansible.com, or test.example2.ansible.com, and you want to use the “admin” preconstructed name, the email address should be <a class="reference external" href="mailto:admin%40ansible.com">admin<span>@</span>ansible<span>.</span>com</a>.</p>
|
||||
<p>Email address must be either an email address present in the WHOIS data for <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><span class="std std-ref"><span class="pre">domain_name</span></span></a></strong></code>, or one of the following constructed emails: admin@<code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><span class="std std-ref"><span class="pre">domain_name</span></span></a></strong></code>, administrator@<code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><span class="std std-ref"><span class="pre">domain_name</span></span></a></strong></code>, webmaster@<code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><span class="std std-ref"><span class="pre">domain_name</span></span></a></strong></code>, hostmaster@<code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><span class="std std-ref"><span class="pre">domain_name</span></span></a></strong></code>, postmaster@<code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><span class="std std-ref"><span class="pre">domain_name</span></span></a></strong></code>.</p>
|
||||
<p>Note that if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-domain-name"><span class="std std-ref"><span class="pre">domain_name</span></span></a></strong></code> includes subdomains, the top level domain should be used. For example, if requesting validation of example1.ansible.com, or test.example2.ansible.com, and you want to use the “admin” preconstructed name, the email address should be <a class="reference external" href="mailto:admin%40ansible.com">admin<span>@</span>ansible<span>.</span>com</a>.</p>
|
||||
<p>If using the email values from the WHOIS data for the domain or its top level namespace, they must be exact matches.</p>
|
||||
<p>If <code class="docutils literal notranslate"><span class="pre">verification_method=email</span></code> but <em>verification_email</em> is not provided, the first email address found in WHOIS data for the domain will be used.</p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=email</span></span></a></code> but <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-email"><span class="std std-ref"><span class="pre">verification_email</span></span></a></strong></code> is not provided, the first email address found in WHOIS data for the domain will be used.</p>
|
||||
<p>To verify domain ownership, domain owner must follow the instructions in the email they receive.</p>
|
||||
<p>Only allowed if <code class="docutils literal notranslate"><span class="pre">verification_method=email</span></code></p>
|
||||
<p>Only allowed if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=email</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -284,10 +286,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<a class="ansibleOptionLink" href="#parameter-verification_method" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The verification method to be used to prove control of the domain.</p>
|
||||
<p>If <code class="docutils literal notranslate"><span class="pre">verification_method=email</span></code> and the value <em>verification_email</em> is specified, that value is used for the email validation. If <em>verification_email</em> is not provided, the first value present in WHOIS data will be used. An email will be sent to the address in <em>verification_email</em> with instructions on how to verify control of the domain.</p>
|
||||
<p>If <code class="docutils literal notranslate"><span class="pre">verification_method=dns</span></code>, the value <em>dns_contents</em> must be stored in location <em>dns_location</em>, with a DNS record type of <em>verification_dns_record_type</em>. To prove domain ownership, update your DNS records so the text string returned by <em>dns_contents</em> is available at <em>dns_location</em>.</p>
|
||||
<p>If <code class="docutils literal notranslate"><span class="pre">verification_method=web_server</span></code>, the contents of return value <em>file_contents</em> must be made available on a web server accessible at location <em>file_location</em>.</p>
|
||||
<p>If <code class="docutils literal notranslate"><span class="pre">verification_method=manual</span></code>, the domain will be validated with a manual process. This is not recommended.</p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=email</span></span></a></code> and the value <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-email"><span class="std std-ref"><span class="pre">verification_email</span></span></a></strong></code> is specified, that value is used for the email validation. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-email"><span class="std std-ref"><span class="pre">verification_email</span></span></a></strong></code> is not provided, the first value present in WHOIS data will be used. An email will be sent to the address in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-email"><span class="std std-ref"><span class="pre">verification_email</span></span></a></strong></code> with instructions on how to verify control of the domain.</p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=dns</span></span></a></code>, the value <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><span class="std std-ref"><span class="pre">dns_contents</span></span></a></code> must be stored in location <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><span class="std std-ref"><span class="pre">dns_location</span></span></a></code>, with a DNS record type of <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-resource-type"><span class="std std-ref"><span class="pre">dns_resource_type</span></span></a></code>. To prove domain ownership, update your DNS records so the text string returned by <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><span class="std std-ref"><span class="pre">dns_contents</span></span></a></code> is available at <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><span class="std std-ref"><span class="pre">dns_location</span></span></a></code>.</p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=web_server</span></span></a></code>, the contents of return value <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-file-contents"><span class="std std-ref"><span class="pre">file_contents</span></span></a></code> must be made available on a web server accessible at location <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-file-location"><span class="std std-ref"><span class="pre">file_location</span></span></a></code>.</p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=manual</span></span></a></code>, the domain will be validated with a manual process. This is not recommended.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"dns"</span></code></p></li>
|
||||
@@ -334,7 +336,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>There is a small delay (typically about 5 seconds, but can be as long as 60 seconds) before obtaining the random values when requesting a validation while <code class="docutils literal notranslate"><span class="pre">verification_method=dns</span></code> or <code class="docutils literal notranslate"><span class="pre">verification_method=web_server</span></code>. Be aware of that if doing many domain validation requests.</p></li>
|
||||
<li><p>There is a small delay (typically about 5 seconds, but can be as long as 60 seconds) before obtaining the random values when requesting a validation while <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=dns</span></span></a></code> or <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method=web_server</span></span></a></code>. Be aware of that if doing many domain validation requests.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@@ -343,7 +345,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="admonition seealso">
|
||||
<p class="admonition-title">See also</p>
|
||||
<dl class="simple">
|
||||
<dt><a class="reference internal" href="x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a></dt><dd><p>Can be used to request certificates from ECS, with <code class="docutils literal notranslate"><span class="pre">provider=entrust</span></code>.</p>
|
||||
<dt><a class="reference internal" href="x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a></dt><dd><p>Can be used to request certificates from ECS, with <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module-parameter-provider"><span class="std std-ref"><span class="pre">provider=entrust</span></span></a></code>.</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="ecs_certificate_module.html#ansible-collections-community-crypto-ecs-certificate-module"><span class="std std-ref">community.crypto.ecs_certificate</span></a></dt><dd><p>Can be used to request a Certificate from ECS using a verified domain.</p>
|
||||
</dd>
|
||||
@@ -408,7 +410,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-client_id"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-client-id"><strong>client_id</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-client_id" 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-cell"><p>Client ID that the domain belongs to. If the input value <em>client_id</em> is specified, this will always be the same as <em>client_id</em></p>
|
||||
<td><div class="ansible-option-cell"><p>Client ID that the domain belongs to. If the input value <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-client-id"><span class="std std-ref"><span class="pre">client_id</span></span></a></strong></code> is specified, this will always be the same as <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-client-id"><span class="std std-ref"><span class="pre">client_id</span></span></a></strong></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">1</span></code></p>
|
||||
</div></td>
|
||||
@@ -417,8 +419,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-dns_contents"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><strong>dns_contents</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-dns_contents" 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 value that ECS will be expecting to find in the DNS record located at <em>dns_location</em>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>verification_method</em> is <code class="docutils literal notranslate"><span class="pre">dns</span></code></p>
|
||||
<td><div class="ansible-option-cell"><p>The value that ECS will be expecting to find in the DNS record located at <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><span class="std std-ref"><span class="pre">dns_location</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">dns</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"AB23CD41432522FF2526920393982FAB"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -426,8 +428,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-dns_location"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><strong>dns_location</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-dns_location" 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 location that ECS will be expecting to be able to find the DNS entry for domain verification, containing the contents of <em>dns_contents</em>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>verification_method</em> is <code class="docutils literal notranslate"><span class="pre">dns</span></code></p>
|
||||
<td><div class="ansible-option-cell"><p>The location that ECS will be expecting to be able to find the DNS entry for domain verification, containing the contents of <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-contents"><span class="std std-ref"><span class="pre">dns_contents</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">dns</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"_pki-validation.ansible.com"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -435,8 +437,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-dns_resource_type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-dns-resource-type"><strong>dns_resource_type</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-dns_resource_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 type of resource record that ECS will be expecting for the DNS record located at <em>dns_location</em>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>verification_method</em> is <code class="docutils literal notranslate"><span class="pre">dns</span></code></p>
|
||||
<td><div class="ansible-option-cell"><p>The type of resource record that ECS will be expecting for the DNS record located at <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-dns-location"><span class="std std-ref"><span class="pre">dns_location</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">dns</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"TXT"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -444,7 +446,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-domain_status"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-domain-status"><strong>domain_status</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-domain_status" 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>Status of the current domain. Will be one of <code class="docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="docutils literal notranslate"><span class="pre">DECLINED</span></code>, <code class="docutils literal notranslate"><span class="pre">CANCELLED</span></code>, <code class="docutils literal notranslate"><span class="pre">INITIAL_VERIFICATION</span></code>, <code class="docutils literal notranslate"><span class="pre">DECLINED</span></code>, <code class="docutils literal notranslate"><span class="pre">CANCELLED</span></code>, <code class="docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code>, <code class="docutils literal notranslate"><span class="pre">EXPIRED</span></code>, <code class="docutils literal notranslate"><span class="pre">EXPIRING</span></code></p>
|
||||
<td><div class="ansible-option-cell"><p>Status of the current domain. Will be one of <code class="ansible-value docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">DECLINED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">CANCELLED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">INITIAL_VERIFICATION</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">DECLINED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">CANCELLED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRING</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"APPROVED"</span></code></p>
|
||||
</div></td>
|
||||
@@ -455,7 +457,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The list of emails used to request validation of this domain.</p>
|
||||
<p>Domains requested using this module will only have a list of size 1.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>verification_method</em> is <code class="docutils literal notranslate"><span class="pre">email</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">email</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["admin@ansible.com",</span> <span class="pre">"administrator@ansible.com"]</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -463,8 +465,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-ev_days_remaining"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-ev-days-remaining"><strong>ev_days_remaining</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-ev_days_remaining" 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-cell"><p>The number of days the domain remains eligible for submission of “EV” certificates. Will never be greater than the value of <em>ov_days_remaining</em></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and <em>ev_eligible</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code> and <em>domain_status</em> is <code class="docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code> or <code class="docutils literal notranslate"><span class="pre">EXPIRING</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The number of days the domain remains eligible for submission of “EV” certificates. Will never be greater than the value of <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-ov-days-remaining"><span class="std std-ref"><span class="pre">ov_days_remaining</span></span></a></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-ev-eligible"><span class="std std-ref"><span class="pre">ev_eligible</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> and <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-domain-status"><span class="std std-ref"><span class="pre">domain_status</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRING</span></code>.</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">94</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -472,8 +474,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-ev_eligible"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-ev-eligible"><strong>ev_eligible</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-ev_eligible" 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 domain is eligible for submission of “EV” certificates. Will never be <code class="docutils literal notranslate"><span class="pre">true</span></code> if <em>ov_eligible</em> is <code class="docutils literal notranslate"><span class="pre">false</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and <em>domain_status</em> is <code class="docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code> or <code class="docutils literal notranslate"><span class="pre">EXPIRING</span></code>, or <code class="docutils literal notranslate"><span class="pre">EXPIRED</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether the domain is eligible for submission of “EV” certificates. Will never be <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> if <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-ov-eligible"><span class="std std-ref"><span class="pre">ov_eligible</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-domain-status"><span class="std std-ref"><span class="pre">domain_status</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRING</span></code>, or <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRED</span></code>.</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -481,8 +483,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-file_contents"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-file-contents"><strong>file_contents</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-file_contents" 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 contents of the file that ECS will be expecting to find at <code class="docutils literal notranslate"><span class="pre">file_location</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>verification_method</em> is <code class="docutils literal notranslate"><span class="pre">web_server</span></code></p>
|
||||
<td><div class="ansible-option-cell"><p>The contents of the file that ECS will be expecting to find at <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-file-location"><span class="std std-ref"><span class="pre">file_location</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">web_server</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"AB23CD41432522FF2526920393982FAB"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -490,8 +492,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-file_location"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-file-location"><strong>file_location</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-file_location" 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 location that ECS will be expecting to be able to find the file for domain verification, containing the contents of <em>file_contents</em>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <em>verification_method</em> is <code class="docutils literal notranslate"><span class="pre">web_server</span></code></p>
|
||||
<td><div class="ansible-option-cell"><p>The location that ECS will be expecting to be able to find the file for domain verification, containing the contents of <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-file-contents"><span class="std std-ref"><span class="pre">file_contents</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">web_server</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"http://ansible.com/.well-known/pki-validation/abcd.txt"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -499,8 +501,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-ov_days_remaining"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-ov-days-remaining"><strong>ov_days_remaining</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-ov_days_remaining" 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-cell"><p>The number of days the domain remains eligible for submission of “OV” certificates. Will never be less than the value of <em>ev_days_remaining</em></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and <em>ov_eligible</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code> and <em>domain_status</em> is <code class="docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code> or <code class="docutils literal notranslate"><span class="pre">EXPIRING</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The number of days the domain remains eligible for submission of “OV” certificates. Will never be less than the value of <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-ev-days-remaining"><span class="std std-ref"><span class="pre">ev_days_remaining</span></span></a></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-ov-eligible"><span class="std std-ref"><span class="pre">ov_eligible</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> and <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-domain-status"><span class="std std-ref"><span class="pre">domain_status</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRING</span></code>.</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">129</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -508,8 +510,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-ov_eligible"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-ov-eligible"><strong>ov_eligible</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-ov_eligible" 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 domain is eligible for submission of “OV” certificates. Will never be <code class="docutils literal notranslate"><span class="pre">false</span></code> if <em>ov_eligible</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and <em>domain_status</em> is <code class="docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code>, <code class="docutils literal notranslate"><span class="pre">EXPIRING</span></code>, or <code class="docutils literal notranslate"><span class="pre">EXPIRED</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether the domain is eligible for submission of “OV” certificates. Will never be <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> if <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-ev-eligible"><span class="std std-ref"><span class="pre">ev_eligible</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-return-domain-status"><span class="std std-ref"><span class="pre">domain_status</span></span></a></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">APPROVED</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">RE_VERIFICATION</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRING</span></code>, or <code class="ansible-value docutils literal notranslate"><span class="pre">EXPIRED</span></code>.</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -517,7 +519,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ec
|
||||
<div class="ansibleOptionAnchor" id="return-verification_method"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-ecs-domain-module-return-verification-method"><strong>verification_method</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-verification_method" 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>Verification method used to request the domain validation. If <code class="docutils literal notranslate"><span class="pre">changed</span></code> will be the same as <em>verification_method</em> input parameter.</p>
|
||||
<td><div class="ansible-option-cell"><p>Verification method used to request the domain validation. If <code class="docutils literal notranslate"><span class="pre">changed</span></code> will be the same as <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-ecs-domain-module-parameter-verification-method"><span class="std std-ref"><span class="pre">verification_method</span></span></a></strong></code> input parameter.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"dns"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.get_certificate module – Get a certificate from a host:port<a class="headerlink" href="#community-crypto-get-certificate-module-get-a-certificate-from-a-host-port" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-get-certificate-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -193,7 +195,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ge
|
||||
<span id="ansible-collections-community-crypto-get-certificate-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>python >= 2.7 when using <code class="docutils literal notranslate"><span class="pre">proxy_host</span></code></p></li>
|
||||
<li><p>python >= 2.7 when using <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-get-certificate-module-parameter-proxy-host"><span class="std std-ref"><span class="pre">proxy_host</span></span></a></strong></code></p></li>
|
||||
<li><p>cryptography >= 1.6</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -211,9 +213,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ge
|
||||
<a class="ansibleOptionLink" href="#parameter-asn1_base64" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.12.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether to encode the ASN.1 values in the <code class="docutils literal notranslate"><span class="pre">extensions</span></code> return value with Base64 or not.</p>
|
||||
<p>The documentation claimed for a long time that the values are Base64 encoded, but they never were. For compatibility this option is set to <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<p>The default value <code class="docutils literal notranslate"><span class="pre">false</span></code> is <strong>deprecated</strong> and will change to <code class="docutils literal notranslate"><span class="pre">true</span></code> in community.crypto 3.0.0.</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether to encode the ASN.1 values in the <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-get-certificate-module-return-extensions"><span class="std std-ref"><span class="pre">extensions</span></span></a></code> return value with Base64 or not.</p>
|
||||
<p>The documentation claimed for a long time that the values are Base64 encoded, but they never were. For compatibility this option is set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<p>The default value <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> is <strong>deprecated</strong> and will change to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> in community.crypto 3.0.0.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -235,7 +237,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ge
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.11.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>SSL/TLS Ciphers to use for the request.</p>
|
||||
<p>When a list is provided, all ciphers are joined in order with <code class="docutils literal notranslate"><span class="pre">:</span></code>.</p>
|
||||
<p>When a list is provided, all ciphers are joined in order with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code>.</p>
|
||||
<p>See the <a class="reference external" href="https://www.openssl.org/docs/manmaster/man1/openssl-ciphers.html#CIPHER-LIST-FORMAT">OpenSSL Cipher List Format</a> for more details.</p>
|
||||
<p>The available ciphers is dependent on the Python and OpenSSL/LibreSSL versions.</p>
|
||||
</div></td>
|
||||
@@ -274,8 +276,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ge
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -297,7 +299,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ge
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.9.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Requests a secure connection for protocols which require clients to initiate encryption.</p>
|
||||
<p>Only available for <code class="docutils literal notranslate"><span class="pre">mysql</span></code> currently.</p>
|
||||
<p>Only available for <code class="ansible-value docutils literal notranslate"><span class="pre">mysql</span></code> currently.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"mysql"</span></code></p></li>
|
||||
@@ -374,7 +376,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ge
|
||||
<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">cert</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">How many days until cert expires</span>
|
||||
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">"cert</span><span class="nv"> </span><span class="s">expires</span><span class="nv"> </span><span class="s">in:</span><span class="nv"> </span><span class="cp">{{</span> <span class="nv">expire_days</span> <span class="cp">}}</span><span class="nv"> </span><span class="s">days."</span>
|
||||
<span class="w"> </span><span class="nt">vars</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">expire_days</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="o">((</span> <span class="nv">cert.not_after</span> <span class="o">|</span> <span class="nf">to_datetime</span><span class="o">(</span><span class="s1">'%Y%m%d%H%M%SZ'</span><span class="o">))</span> <span class="o">-</span> <span class="o">(</span><span class="nv">ansible_date_time.iso8601</span> <span class="o">|</span> <span class="nf">to_datetime</span><span class="o">(</span><span class="s1">'%Y-%m-%dT%H:%M:%SZ'</span><span class="o">))</span> <span class="o">)</span><span class="nv">.days</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
@@ -420,7 +422,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-ge
|
||||
<a class="ansibleOptionLink" href="#return-extensions/asn1_data" 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 ASN.1 content of the extension.</p>
|
||||
<p>If <em>asn1_base64=true</em> this will be Base64 encoded, otherwise the raw binary value will be returned.</p>
|
||||
<p>If <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-get-certificate-module-parameter-asn1-base64"><span class="std std-ref"><span class="pre">asn1_base64=true</span></span></a></code> this will be Base64 encoded, otherwise the raw binary value will be returned.</p>
|
||||
<p>Please note that the raw binary value might not survive JSON serialization to the Ansible controller, and also might cause failures when displaying it. See <a class="reference external" href="https://github.com/ansible/ansible/issues/80258">https://github.com/ansible/ansible/issues/80258</a> for more information.</p>
|
||||
<p><strong>Note</strong> that depending on the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> version used, it is not possible to extract the ASN.1 content of the extension, but only to provide the re-encoded content of the extension in case it was parsed by <code class="docutils literal notranslate"><span class="pre">cryptography</span></code>. This should usually result in exactly the same value, except if the original extension value was malformed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -146,7 +148,7 @@
|
||||
|
||||
<section id="community-crypto">
|
||||
<span id="plugins-in-community-crypto"></span><h1>Community.Crypto<a class="headerlink" href="#community-crypto" title="Permalink to this heading"></a></h1>
|
||||
<p>Collection version 2.14.0</p>
|
||||
<p>Collection version 2.14.1</p>
|
||||
<nav class="contents local" id="contents">
|
||||
<ul class="simple">
|
||||
<li><p><a class="reference internal" href="#description" id="id1">Description</a></p></li>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -163,7 +165,7 @@
|
||||
<h1>community.crypto.luks_device module – Manage encrypted (LUKS) devices<a class="headerlink" href="#community-crypto-luks-device-module-manage-encrypted-luks-devices" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-luks-device-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -190,9 +192,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>cryptsetup</p></li>
|
||||
<li><p>wipefs (when <em>state</em> is <code class="docutils literal notranslate"><span class="pre">absent</span></code>)</p></li>
|
||||
<li><p>wipefs (when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">absent</span></code>)</p></li>
|
||||
<li><p>lsblk</p></li>
|
||||
<li><p>blkid (when <em>label</em> or <em>uuid</em> options are used)</p></li>
|
||||
<li><p>blkid (when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-label"><span class="std std-ref"><span class="pre">label</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-uuid"><span class="std std-ref"><span class="pre">uuid</span></span></a></strong></code> options are used)</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
@@ -211,21 +213,21 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>This option allows the user to define the cipher specification string for the LUKS container.</p>
|
||||
<p>Will only be used on container creation.</p>
|
||||
<p>For pre-2.6.10 kernels, use <code class="docutils literal notranslate"><span class="pre">aes-plain</span></code> as they do not understand the new cipher spec strings. To use ESSIV, use <code class="docutils literal notranslate"><span class="pre">aes-cbc-essiv:sha256</span></code>.</p>
|
||||
<p>For pre-2.6.10 kernels, use <code class="ansible-value docutils literal notranslate"><span class="pre">aes-plain</span></code> as they do not understand the new cipher spec strings. To use ESSIV, use <code class="ansible-value docutils literal notranslate"><span class="pre">aes-cbc-essiv:sha256</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-device"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-device"><strong>device</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-device" 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>Device to work with (for example <code class="docutils literal notranslate"><span class="pre">/dev/sda1</span></code>). Needed in most cases. Can be omitted only when <em>state=closed</em> together with <em>name</em> is provided.</p>
|
||||
<td><div class="ansible-option-cell"><p>Device to work with (for example <code class="ansible-value docutils literal notranslate"><span class="pre">/dev/sda1</span></code>). Needed in most cases. Can be omitted only when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-state"><span class="std std-ref"><span class="pre">state=closed</span></span></a></code> together with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-name"><span class="std std-ref"><span class="pre">name</span></span></a></strong></code> is provided.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-force_remove_last_key"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-force-remove-last-key"><strong>force_remove_last_key</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-force_remove_last_key" 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>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, allows removing the last key from a container.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, allows removing the last key from a container.</p>
|
||||
<p>BEWARE that when the last key has been removed from a container, the container can no longer be opened!</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -247,7 +249,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<div class="ansibleOptionAnchor" id="parameter-keyfile"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><strong>keyfile</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-keyfile" 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>Used to unlock the container. Either a <em>keyfile</em> or a <em>passphrase</em> is needed for most of the operations. Parameter value is the path to the keyfile with the passphrase.</p>
|
||||
<td><div class="ansible-option-cell"><p>Used to unlock the container. Either a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> or a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> is needed for most of the operations. Parameter value is the path to the keyfile with the passphrase.</p>
|
||||
<p>BEWARE that working with keyfiles in plaintext is dangerous. Make sure that they are protected.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -265,22 +267,22 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>This option allow the user to create a LUKS2 format container with label support, respectively to identify the container by label on later usages.</p>
|
||||
<p>Will only be used on container creation, or when <em>device</em> is not specified.</p>
|
||||
<p>This cannot be specified if <em>type</em> is set to <code class="docutils literal notranslate"><span class="pre">luks1</span></code>.</p>
|
||||
<p>Will only be used on container creation, or when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code> is not specified.</p>
|
||||
<p>This cannot be specified if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-type"><span class="std std-ref"><span class="pre">type</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">luks1</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-name" 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>Sets container name when <em>state=opened</em>. Can be used instead of <em>device</em> when closing the existing container (that is, when <em>state=closed</em>).</p>
|
||||
<td><div class="ansible-option-cell"><p>Sets container name when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-state"><span class="std std-ref"><span class="pre">state=opened</span></span></a></code>. Can be used instead of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code> when closing the existing container (that is, when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-state"><span class="std std-ref"><span class="pre">state=closed</span></span></a></code>).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-new_keyfile"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-new-keyfile"><strong>new_keyfile</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-new_keyfile" 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>Adds additional key to given container on <em>device</em>. Needs <em>keyfile</em> or <em>passphrase</em> option for authorization. LUKS container supports up to 8 keyslots. Parameter value is the path to the keyfile with the passphrase.</p>
|
||||
<td><div class="ansible-option-cell"><p>Adds additional key to given container on <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code>. Needs <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> option for authorization. LUKS container supports up to 8 keyslots. Parameter value is the path to the keyfile with the passphrase.</p>
|
||||
<p>NOTE that adding additional keys is idempotent only since community.crypto 1.4.0. For older versions, a new keyslot will be used even if another keyslot already exists for this keyfile.</p>
|
||||
<p>BEWARE that working with keyfiles in plaintext is dangerous. Make sure that they are protected.</p>
|
||||
</div></td>
|
||||
@@ -290,7 +292,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<a class="ansibleOptionLink" href="#parameter-new_passphrase" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Adds additional passphrase to given container on <em>device</em>. Needs <em>keyfile</em> or <em>passphrase</em> option for authorization. LUKS container supports up to 8 keyslots. Parameter value is a string with the new passphrase.</p>
|
||||
<td><div class="ansible-option-cell"><p>Adds additional passphrase to given container on <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code>. Needs <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> option for authorization. LUKS container supports up to 8 keyslots. Parameter value is a string with the new passphrase.</p>
|
||||
<p>NOTE that adding additional passphrase is idempotent only since community.crypto 1.4.0. For older versions, a new keyslot will be used even if another keyslot already exists for this passphrase.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -299,7 +301,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<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>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Used to unlock the container. Either a <em>passphrase</em> or a <em>keyfile</em> is needed for most of the operations. Parameter value is a string with the passphrase.</p>
|
||||
<td><div class="ansible-option-cell"><p>Used to unlock the container. Either a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> or a <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> is needed for most of the operations. Parameter value is a string with the passphrase.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -330,7 +332,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<a class="ansibleOptionLink" href="#parameter-pbkdf/iteration_count" title="Permalink to this option"></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>Specify the iteration count used for the PBKDF.</p>
|
||||
<p>Mutually exclusive with <em>iteration_time</em>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-iteration-time"><span class="std std-ref"><span class="pre">pbkdf.iteration_time</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -339,7 +341,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Specify the iteration time used for the PBKDF.</p>
|
||||
<p>Note that this is in <strong>seconds</strong>, not in milliseconds as on the command line.</p>
|
||||
<p>Mutually exclusive with <em>iteration_count</em>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-pbkdf-iteration-count"><span class="std std-ref"><span class="pre">pbkdf.iteration_count</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -422,7 +424,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<a class="ansibleOptionLink" href="#parameter-persistent" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.3.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Allows the user to store options into container’s metadata persistently and automatically use them next time. Only <em>perf_same_cpu_crypt</em>, <em>perf_submit_from_crypt_cpus</em>, <em>perf_no_read_workqueue</em>, and <em>perf_no_write_workqueue</em> can be stored persistently.</p>
|
||||
<td><div class="ansible-option-cell"><p>Allows the user to store options into container’s metadata persistently and automatically use them next time. Only <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-perf-same-cpu-crypt"><span class="std std-ref"><span class="pre">perf_same_cpu_crypt</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-perf-submit-from-crypt-cpus"><span class="std std-ref"><span class="pre">perf_submit_from_crypt_cpus</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-perf-no-read-workqueue"><span class="std std-ref"><span class="pre">perf_no_read_workqueue</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-perf-no-write-workqueue"><span class="std std-ref"><span class="pre">perf_no_write_workqueue</span></span></a></strong></code> can be stored persistently.</p>
|
||||
<p>Will only work with LUKS2 containers.</p>
|
||||
<p>Will only be used when opening containers.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
@@ -436,9 +438,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<div class="ansibleOptionAnchor" id="parameter-remove_keyfile"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-parameter-remove-keyfile"><strong>remove_keyfile</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-remove_keyfile" 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>Removes given key from the container on <em>device</em>. Does not remove the keyfile from filesystem. Parameter value is the path to the keyfile with the passphrase.</p>
|
||||
<td><div class="ansible-option-cell"><p>Removes given key from the container on <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code>. Does not remove the keyfile from filesystem. Parameter value is the path to the keyfile with the passphrase.</p>
|
||||
<p>NOTE that removing keys is idempotent only since community.crypto 1.4.0. For older versions, trying to remove a key which no longer exists results in an error.</p>
|
||||
<p>NOTE that to remove the last key from a LUKS container, the <em>force_remove_last_key</em> option must be set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>NOTE that to remove the last key from a LUKS container, the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-force-remove-last-key"><span class="std std-ref"><span class="pre">force_remove_last_key</span></span></a></strong></code> option must be set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>BEWARE that working with keyfiles in plaintext is dangerous. Make sure that they are protected.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -447,9 +449,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<a class="ansibleOptionLink" href="#parameter-remove_passphrase" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Removes given passphrase from the container on <em>device</em>. Parameter value is a string with the passphrase to remove.</p>
|
||||
<td><div class="ansible-option-cell"><p>Removes given passphrase from the container on <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code>. Parameter value is a string with the passphrase to remove.</p>
|
||||
<p>NOTE that removing passphrases is idempotent only since community.crypto 1.4.0. For older versions, trying to remove a passphrase which no longer exists results in an error.</p>
|
||||
<p>NOTE that to remove the last keyslot from a LUKS container, the <em>force_remove_last_key</em> option must be set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>NOTE that to remove the last keyslot from a LUKS container, the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-force-remove-last-key"><span class="std std-ref"><span class="pre">force_remove_last_key</span></span></a></strong></code> option must be 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">
|
||||
@@ -466,10 +468,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<a class="ansibleOptionLink" href="#parameter-state" 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>Desired state of the LUKS container. Based on its value creates, destroys, opens or closes the LUKS container on a given device.</p>
|
||||
<p><em>present</em> will create LUKS container unless already present. Requires <em>device</em> and either <em>keyfile</em> or <em>passphrase</em> options to be provided.</p>
|
||||
<p><em>absent</em> will remove existing LUKS container if it exists. Requires <em>device</em> or <em>name</em> to be specified.</p>
|
||||
<p><em>opened</em> will unlock the LUKS container. If it does not exist it will be created first. Requires <em>device</em> and either <em>keyfile</em> or <em>passphrase</em> to be specified. Use the <em>name</em> option to set the name of the opened container. Otherwise the name will be generated automatically and returned as a part of the result.</p>
|
||||
<p><em>closed</em> will lock the LUKS container. However if the container does not exist it will be created. Requires <em>device</em> and either <em>keyfile</em> or <em>passphrase</em> options to be provided. If container does already exist <em>device</em> or <em>name</em> will suffice.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> will create LUKS container unless already present. Requires <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code> and either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> options to be provided.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">absent</span></code> will remove existing LUKS container if it exists. Requires <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-name"><span class="std std-ref"><span class="pre">name</span></span></a></strong></code> to be specified.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">opened</span></code> will unlock the LUKS container. If it does not exist it will be created first. Requires <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code> and either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> to be specified. Use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-name"><span class="std std-ref"><span class="pre">name</span></span></a></strong></code> option to set the name of the opened container. Otherwise the name will be generated automatically and returned as a part of the result.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">closed</span></code> will lock the LUKS container. However if the container does not exist it will be created. Requires <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code> and either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-keyfile"><span class="std std-ref"><span class="pre">keyfile</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code> options to be provided. If container does already exist <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-name"><span class="std std-ref"><span class="pre">name</span></span></a></strong></code> will suffice.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"present"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -484,7 +486,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<a class="ansibleOptionLink" href="#parameter-type" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>This option allow the user explicit define the format of LUKS container that wants to work with. Options are <code class="docutils literal notranslate"><span class="pre">luks1</span></code> or <code class="docutils literal notranslate"><span class="pre">luks2</span></code></p>
|
||||
<td><div class="ansible-option-cell"><p>This option allow the user explicit define the format of LUKS container that wants to work with. Options are <code class="ansible-value docutils literal notranslate"><span class="pre">luks1</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">luks2</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"luks1"</span></code></p></li>
|
||||
@@ -498,7 +500,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>With this option user can identify the LUKS container by UUID.</p>
|
||||
<p>Will only be used when <em>device</em> and <em>label</em> are not specified.</p>
|
||||
<p>Will only be used when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-device"><span class="std std-ref"><span class="pre">device</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-label"><span class="std std-ref"><span class="pre">label</span></span></a></strong></code> are not specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -649,7 +651,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-lu
|
||||
<div class="ansibleOptionAnchor" id="return-name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-luks-device-module-return-name"><strong>name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-name" 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>When <em>state=opened</em> returns (generated or given) name of LUKS container. Returns None if no name is supplied.</p>
|
||||
<td><div class="ansible-option-cell"><p>When <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-luks-device-module-parameter-state"><span class="std std-ref"><span class="pre">state=opened</span></span></a></code> returns (generated or given) name of LUKS container. Returns None if no name is supplied.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"luks-c1da9a58-2fde-4256-9d9f-6ab008b4dd1b"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -163,7 +165,7 @@
|
||||
<h1>community.crypto.openssh_cert module – Generate OpenSSH host or user certificates.<a class="headerlink" href="#community-crypto-openssh-cert-module-generate-openssh-host-or-user-certificates" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-openssh-cert-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -218,7 +220,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-force" 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>Should the certificate be regenerated even if it already exists and is valid.</p>
|
||||
<p>Equivalent to <em>regenerate=always</em>.</p>
|
||||
<p>Equivalent to <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate=always</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -246,7 +248,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-ignore_timestamps" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.2.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether the <em>valid_from</em> and <em>valid_to</em> timestamps should be ignored for idempotency checks.</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-from"><span class="std std-ref"><span class="pre">valid_from</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-to"><span class="std std-ref"><span class="pre">valid_to</span></span></a></strong></code> timestamps should be ignored for idempotency checks.</p>
|
||||
<p>However, the values will still be applied to a new certificate if it meets any other necessary conditions for generation/regeneration.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -273,19 +275,19 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-options" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Specify certificate options when signing a key. The option that are valid for user certificates are:</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">clear</span></code>: Clear all enabled permissions. This is useful for clearing the default set of permissions so permissions may be added individually.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">force-command=command</span></code>: Forces the execution of command instead of any shell or command specified by the user when the certificate is used for authentication.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">no-agent-forwarding</span></code>: Disable ssh-agent forwarding (permitted by default).</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">no-port-forwarding</span></code>: Disable port forwarding (permitted by default).</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">no-pty</span></code>: Disable PTY allocation (permitted by default).</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">no-user-rc</span></code>: Disable execution of <code class="docutils literal notranslate"><span class="pre">~/.ssh/rc</span></code> by sshd (permitted by default).</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">no-x11-forwarding</span></code>: Disable X11 forwarding (permitted by default)</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">permit-agent-forwarding</span></code>: Allows ssh-agent forwarding.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">permit-port-forwarding</span></code>: Allows port forwarding.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">permit-pty</span></code>: Allows PTY allocation.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">permit-user-rc</span></code>: Allows execution of <code class="docutils literal notranslate"><span class="pre">~/.ssh/rc</span></code> by sshd.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">permit-x11-forwarding</span></code>: Allows X11 forwarding.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">source-address=address_list</span></code>: Restrict the source addresses from which the certificate is considered valid. The <code class="docutils literal notranslate"><span class="pre">address_list</span></code> is a comma-separated list of one or more address/netmask pairs in CIDR format.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">clear</span></code>: Clear all enabled permissions. This is useful for clearing the default set of permissions so permissions may be added individually.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">force-command=command</span></code>: Forces the execution of command instead of any shell or command specified by the user when the certificate is used for authentication.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">no-agent-forwarding</span></code>: Disable ssh-agent forwarding (permitted by default).</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">no-port-forwarding</span></code>: Disable port forwarding (permitted by default).</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">no-pty</span></code>: Disable PTY allocation (permitted by default).</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">no-user-rc</span></code>: Disable execution of <code class="docutils literal notranslate"><span class="pre">~/.ssh/rc</span></code> by sshd (permitted by default).</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">no-x11-forwarding</span></code>: Disable X11 forwarding (permitted by default)</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">permit-agent-forwarding</span></code>: Allows ssh-agent forwarding.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">permit-port-forwarding</span></code>: Allows port forwarding.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">permit-pty</span></code>: Allows PTY allocation.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">permit-user-rc</span></code>: Allows execution of <code class="docutils literal notranslate"><span class="pre">~/.ssh/rc</span></code> by sshd.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">permit-x11-forwarding</span></code>: Allows X11 forwarding.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">source-address=address_list</span></code>: Restrict the source addresses from which the certificate is considered valid. The <code class="docutils literal notranslate"><span class="pre">address_list</span></code> is a comma-separated list of one or more address/netmask pairs in CIDR format.</p>
|
||||
<p>At present, no options are valid for host keys.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -311,7 +313,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.1.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>To use a signing key that resides on a PKCS#11 token, set this to the name (or full path) of the shared library to use with the token. Usually <code class="docutils literal notranslate"><span class="pre">libpkcs11.so</span></code>.</p>
|
||||
<p>If this is set, <em>signing_key</em> needs to point to a file containing the public key of the CA.</p>
|
||||
<p>If this is set, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-signing-key"><span class="std std-ref"><span class="pre">signing_key</span></span></a></strong></code> needs to point to a file containing the public key of the CA.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -326,7 +328,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-public_key" 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>The path to the public key that will be signed with the signing key in order to generate the certificate.</p>
|
||||
<p>Required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -334,11 +336,11 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-regenerate" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.8.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>When <code class="docutils literal notranslate"><span class="pre">never</span></code> the task will fail if a certificate already exists at <em>path</em> and is unreadable otherwise a new certificate will only be generated if there is no existing certificate.</p>
|
||||
<p>When <code class="docutils literal notranslate"><span class="pre">fail</span></code> the task will fail if a certificate already exists at <em>path</em> and does not match the module’s options.</p>
|
||||
<p>When <code class="docutils literal notranslate"><span class="pre">partial_idempotence</span></code> an existing certificate will be regenerated based on <em>serial</em>, <em>signature_algorithm</em>, <em>type</em>, <em>valid_from</em>, <em>valid_to</em>, <em>valid_at</em>, and <em>principals</em>. <em>valid_from</em> and <em>valid_to</em> can be excluded by <em>ignore_timestamps=true</em>.</p>
|
||||
<p>When <code class="docutils literal notranslate"><span class="pre">full_idempotence</span></code> <em>identifier</em>, <em>options</em>, <em>public_key</em>, and <em>signing_key</em> are also considered when compared against an existing certificate.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">always</span></code> is equivalent to <em>force=true</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>When <code class="ansible-value docutils literal notranslate"><span class="pre">never</span></code> the task will fail if a certificate already exists at <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> and is unreadable otherwise a new certificate will only be generated if there is no existing certificate.</p>
|
||||
<p>When <code class="ansible-value docutils literal notranslate"><span class="pre">fail</span></code> the task will fail if a certificate already exists at <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> and does not match the module’s options.</p>
|
||||
<p>When <code class="ansible-value docutils literal notranslate"><span class="pre">partial_idempotence</span></code> an existing certificate will be regenerated based on <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-serial-number"><span class="std std-ref"><span class="pre">serial_number</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-signature-algorithm"><span class="std std-ref"><span class="pre">signature_algorithm</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-type"><span class="std std-ref"><span class="pre">type</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-from"><span class="std std-ref"><span class="pre">valid_from</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-to"><span class="std std-ref"><span class="pre">valid_to</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-at"><span class="std std-ref"><span class="pre">valid_at</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-principals"><span class="std std-ref"><span class="pre">principals</span></span></a></strong></code>. <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-from"><span class="std std-ref"><span class="pre">valid_from</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-to"><span class="std std-ref"><span class="pre">valid_to</span></span></a></strong></code> can be excluded by <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=true</span></span></a></code>.</p>
|
||||
<p>When <code class="ansible-value docutils literal notranslate"><span class="pre">full_idempotence</span></code> <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-identifier"><span class="std std-ref"><span class="pre">identifier</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-options"><span class="std std-ref"><span class="pre">options</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-public-key"><span class="std std-ref"><span class="pre">public_key</span></span></a></strong></code>, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-signing-key"><span class="std std-ref"><span class="pre">signing_key</span></span></a></strong></code> are also considered when compared against an existing certificate.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">always</span></code> is equivalent to <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-force"><span class="std std-ref"><span class="pre">force=true</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"never"</span></code></p></li>
|
||||
@@ -395,8 +397,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-signature_algorithm" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.10.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>As of OpenSSH 8.2 the SHA-1 signature algorithm for RSA keys has been disabled and <code class="docutils literal notranslate"><span class="pre">ssh</span></code> will refuse host certificates signed with the SHA-1 algorithm. OpenSSH 8.1 made <code class="docutils literal notranslate"><span class="pre">rsa-sha2-512</span></code> the default algorithm when acting as a CA and signing certificates with a RSA key. However, for OpenSSH versions less than 8.1 the SHA-2 signature algorithms, <code class="docutils literal notranslate"><span class="pre">rsa-sha2-256</span></code> or <code class="docutils literal notranslate"><span class="pre">rsa-sha2-512</span></code>, must be specified using this option if compatibility with newer <code class="docutils literal notranslate"><span class="pre">ssh</span></code> clients is required. Conversely if hosts using OpenSSH version 8.2 or greater must remain compatible with <code class="docutils literal notranslate"><span class="pre">ssh</span></code> clients using OpenSSH less than 7.2, then <code class="docutils literal notranslate"><span class="pre">ssh-rsa</span></code> can be used when generating host certificates (a corresponding change to the sshd_config to add <code class="docutils literal notranslate"><span class="pre">ssh-rsa</span></code> to the <code class="docutils literal notranslate"><span class="pre">CASignatureAlgorithms</span></code> keyword is also required).</p>
|
||||
<p>Using any value for this option with a non-RSA <em>signing_key</em> will cause this module to fail.</p>
|
||||
<td><div class="ansible-option-cell"><p>As of OpenSSH 8.2 the SHA-1 signature algorithm for RSA keys has been disabled and <code class="docutils literal notranslate"><span class="pre">ssh</span></code> will refuse host certificates signed with the SHA-1 algorithm. OpenSSH 8.1 made <code class="ansible-value docutils literal notranslate"><span class="pre">rsa-sha2-512</span></code> the default algorithm when acting as a CA and signing certificates with a RSA key. However, for OpenSSH versions less than 8.1 the SHA-2 signature algorithms, <code class="ansible-value docutils literal notranslate"><span class="pre">rsa-sha2-256</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">rsa-sha2-512</span></code>, must be specified using this option if compatibility with newer <code class="docutils literal notranslate"><span class="pre">ssh</span></code> clients is required. Conversely if hosts using OpenSSH version 8.2 or greater must remain compatible with <code class="docutils literal notranslate"><span class="pre">ssh</span></code> clients using OpenSSH less than 7.2, then <code class="ansible-value docutils literal notranslate"><span class="pre">ssh-rsa</span></code> can be used when generating host certificates (a corresponding change to the sshd_config to add <code class="ansible-value docutils literal notranslate"><span class="pre">ssh-rsa</span></code> to the <code class="docutils literal notranslate"><span class="pre">CASignatureAlgorithms</span></code> keyword is also required).</p>
|
||||
<p>Using any value for this option with a non-RSA <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-signing-key"><span class="std std-ref"><span class="pre">signing_key</span></span></a></strong></code> will cause this module to fail.</p>
|
||||
<p>Note: OpenSSH versions prior to 7.2 do not support SHA-2 signature algorithms for RSA keys and OpenSSH versions prior to 7.3 do not support SHA-2 signature algorithms for certificates.</p>
|
||||
<p>See <a class="reference external" href="https://www.openssh.com/txt/release-8.2">https://www.openssh.com/txt/release-8.2</a> for more information.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
@@ -412,8 +414,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-signing_key" 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>The path to the private openssh key that is used for signing the public key in order to generate the certificate.</p>
|
||||
<p>If the private key is on a PKCS#11 token (<em>pkcs11_provider</em>), set this to the path to the public key instead.</p>
|
||||
<p>Required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>If the private key is on a PKCS#11 token (<code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-pkcs11-provider"><span class="std std-ref"><span class="pre">pkcs11_provider</span></span></a></strong></code>), set this to the path to the public key instead.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -433,7 +435,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-type" 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>Whether the module should generate a host or a user certificate.</p>
|
||||
<p>Required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"host"</span></code></p></li>
|
||||
@@ -473,26 +475,26 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-valid_at"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssh-cert-module-parameter-valid-at"><strong>valid_at</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-valid_at" 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>Check if the certificate is valid at a certain point in time. If it is not the certificate will be regenerated. Time will always be interpreted as UTC. Mainly to be used with relative timespec for <em>valid_from</em> and / or <em>valid_to</em>. Note that if using relative time this module is NOT idempotent.</p>
|
||||
<td><div class="ansible-option-cell"><p>Check if the certificate is valid at a certain point in time. If it is not the certificate will be regenerated. Time will always be interpreted as UTC. Mainly to be used with relative timespec for <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-from"><span class="std std-ref"><span class="pre">valid_from</span></span></a></strong></code> and / or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-valid-to"><span class="std std-ref"><span class="pre">valid_to</span></span></a></strong></code>. Note that if using relative time this module is NOT idempotent.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-valid_from"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssh-cert-module-parameter-valid-from"><strong>valid_from</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-valid_from" 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 point in time the certificate is valid from. Time can be specified either as relative time or as absolute timestamp. Time will always be interpreted as UTC. Valid formats are: <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DD</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DDTHH:MM:SS</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DD</span> <span class="pre">HH:MM:SS</span> <span class="pre">|</span> <span class="pre">always</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>). Note that if using relative time this module is NOT idempotent.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">always</span></code> is only supported for OpenSSH 7.7 and greater, however, the value <code class="docutils literal notranslate"><span class="pre">1970-01-01T00:00:01</span></code> can be used with earlier versions as an equivalent expression.</p>
|
||||
<p>To ignore this value during comparison with an existing certificate set <em>ignore_timestamps=true</em>.</p>
|
||||
<p>Required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The point in time the certificate is valid from. Time can be specified either as relative time or as absolute timestamp. Time will always be interpreted as UTC. Valid formats are: <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DD</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DDTHH:MM:SS</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DD</span> <span class="pre">HH:MM:SS</span> <span class="pre">|</span> <span class="pre">always</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>). Note that if using relative time this module is NOT idempotent.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">always</span></code> is only supported for OpenSSH 7.7 and greater, however, the value <code class="ansible-value docutils literal notranslate"><span class="pre">1970-01-01T00:00:01</span></code> can be used with earlier versions as an equivalent expression.</p>
|
||||
<p>To ignore this value during comparison with an existing certificate set <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=true</span></span></a></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-valid_to"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssh-cert-module-parameter-valid-to"><strong>valid_to</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-valid_to" 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 point in time the certificate is valid to. Time can be specified either as relative time or as absolute timestamp. Time will always be interpreted as UTC. Valid formats are: <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DD</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DDTHH:MM:SS</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DD</span> <span class="pre">HH:MM:SS</span> <span class="pre">|</span> <span class="pre">forever</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>). Note that if using relative time this module is NOT idempotent.</p>
|
||||
<p>To ignore this value during comparison with an existing certificate set <em>ignore_timestamps=true</em>.</p>
|
||||
<p>Required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The point in time the certificate is valid to. Time can be specified either as relative time or as absolute timestamp. Time will always be interpreted as UTC. Valid formats are: <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DD</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DDTHH:MM:SS</span> <span class="pre">|</span> <span class="pre">YYYY-MM-DD</span> <span class="pre">HH:MM:SS</span> <span class="pre">|</span> <span class="pre">forever</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>). Note that if using relative time this module is NOT idempotent.</p>
|
||||
<p>To ignore this value during comparison with an existing certificate set <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=true</span></span></a></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-cert-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssh_keypair module – Generate OpenSSH private and public keys<a class="headerlink" href="#community-crypto-openssh-keypair-module-generate-openssh-private-and-public-keys" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-openssh-keypair-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -184,16 +186,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>This module allows one to (re)generate OpenSSH private and public keys. It uses ssh-keygen to generate keys. One can generate <code class="docutils literal notranslate"><span class="pre">rsa</span></code>, <code class="docutils literal notranslate"><span class="pre">dsa</span></code>, <code class="docutils literal notranslate"><span class="pre">rsa1</span></code>, <code class="docutils literal notranslate"><span class="pre">ed25519</span></code> or <code class="docutils literal notranslate"><span class="pre">ecdsa</span></code> private keys.</p></li>
|
||||
<li><p>This module allows one to (re)generate OpenSSH private and public keys. It uses ssh-keygen to generate keys. One can generate <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">rsa1</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ed25519</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">ecdsa</span></code> private keys.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-community-crypto-openssh-keypair-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>ssh-keygen (if <em>backend=openssh</em>)</p></li>
|
||||
<li><p>cryptography >= 2.6 (if <em>backend=cryptography</em> and OpenSSH < 7.8 is installed)</p></li>
|
||||
<li><p>cryptography >= 3.0 (if <em>backend=cryptography</em> and OpenSSH >= 7.8 is installed)</p></li>
|
||||
<li><p>ssh-keygen (if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-backend"><span class="std std-ref"><span class="pre">backend=openssh</span></span></a></code>)</p></li>
|
||||
<li><p>cryptography >= 2.6 (if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-backend"><span class="std std-ref"><span class="pre">backend=cryptography</span></span></a></code> and OpenSSH < 7.8 is installed)</p></li>
|
||||
<li><p>cryptography >= 3.0 (if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-backend"><span class="std std-ref"><span class="pre">backend=cryptography</span></span></a></code> and OpenSSH >= 7.8 is installed)</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
@@ -222,8 +224,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-backend" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.7.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Selects between the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> library or the OpenSSH binary <code class="docutils literal notranslate"><span class="pre">opensshbin</span></code>.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">auto</span></code> will default to <code class="docutils literal notranslate"><span class="pre">opensshbin</span></code> unless the OpenSSH binary is not installed or when using <em>passphrase</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Selects between the <code class="ansible-value docutils literal notranslate"><span class="pre">cryptography</span></code> library or the OpenSSH binary <code class="ansible-value docutils literal notranslate"><span class="pre">opensshbin</span></code>.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code> will default to <code class="ansible-value docutils literal notranslate"><span class="pre">opensshbin</span></code> unless the OpenSSH binary is not installed or when using <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-passphrase"><span class="std std-ref"><span class="pre">passphrase</span></span></a></strong></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -287,8 +289,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.7.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Passphrase used to decrypt an existing private key or encrypt a newly generated private key.</p>
|
||||
<p>Passphrases are not supported for <em>type=rsa1</em>.</p>
|
||||
<p>Can only be used when <em>backend=cryptography</em>, or when <em>backend=auto</em> and a required <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> version is installed.</p>
|
||||
<p>Passphrases are not supported for <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-type"><span class="std std-ref"><span class="pre">type=rsa1</span></span></a></code>.</p>
|
||||
<p>Can only be used when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-backend"><span class="std std-ref"><span class="pre">backend=cryptography</span></span></a></code>, or when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-backend"><span class="std std-ref"><span class="pre">backend=auto</span></span></a></code> and a required <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> version is installed.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -303,11 +305,11 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-private_key_format" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.7.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Used when <em>backend=cryptography</em> to select a format for the private key at the provided <em>path</em>.</p>
|
||||
<p>When set to <code class="docutils literal notranslate"><span class="pre">auto</span></code> this module will match the key format of the installed OpenSSH version.</p>
|
||||
<td><div class="ansible-option-cell"><p>Used when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-backend"><span class="std std-ref"><span class="pre">backend=cryptography</span></span></a></code> to select a format for the private key at the provided <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code>.</p>
|
||||
<p>When set to <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code> this module will match the key format of the installed OpenSSH version.</p>
|
||||
<p>For OpenSSH < 7.8 private keys will be in PKCS1 format except ed25519 keys which will be in OpenSSH format.</p>
|
||||
<p>For OpenSSH >= 7.8 all private key types will be in the OpenSSH format.</p>
|
||||
<p>Using this option when <em>regenerate=partial_idempotence</em> or <em>regenerate=full_idempotence</em> will cause a new keypair to be generated if the private key’s format does not match the value of <em>private_key_format</em>. This module will not however convert existing private keys between formats.</p>
|
||||
<p>Using this option when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate=partial_idempotence</span></span></a></code> or <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate=full_idempotence</span></span></a></code> will cause a new keypair to be generated if the private key’s format does not match the value of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-private-key-format"><span class="std std-ref"><span class="pre">private_key_format</span></span></a></strong></code>. This module will not however convert existing private keys between formats.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -323,13 +325,13 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Allows to configure in which situations the module is allowed to regenerate private keys. The module will always generate a new key if the destination file does not exist.</p>
|
||||
<p>By default, the key will be regenerated when it does not match the module’s options, except when the key cannot be read or the passphrase does not match. Please note that this <strong>changed</strong> for Ansible 2.10. For Ansible 2.9, the behavior was as if <code class="docutils literal notranslate"><span class="pre">full_idempotence</span></code> is specified.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">never</span></code>, the module will fail if the key cannot be read or the passphrase is not matching, and will never regenerate an existing key.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">fail</span></code>, the module will fail if the key does not correspond to the module’s options.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">partial_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. The key is <strong>not</strong> regenerated if it cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">full_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. This is also the case if the key cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified. Make sure you have a <strong>backup</strong> when using this option!</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">always</span></code>, the module will always regenerate the key. This is equivalent to setting <em>force</em> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Note that adjusting the comment and the permissions can be changed without regeneration. Therefore, even for <code class="docutils literal notranslate"><span class="pre">never</span></code>, the task can result in changed.</p>
|
||||
<p>By default, the key will be regenerated when it does not match the module’s options, except when the key cannot be read or the passphrase does not match. Please note that this <strong>changed</strong> for Ansible 2.10. For Ansible 2.9, the behavior was as if <code class="ansible-value docutils literal notranslate"><span class="pre">full_idempotence</span></code> is specified.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">never</span></code>, the module will fail if the key cannot be read or the passphrase is not matching, and will never regenerate an existing key.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">fail</span></code>, the module will fail if the key does not correspond to the module’s options.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">partial_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. The key is <strong>not</strong> regenerated if it cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">full_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. This is also the case if the key cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified. Make sure you have a <strong>backup</strong> when using this option!</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">always</span></code>, the module will always regenerate the key. This is equivalent to setting <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code> to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Note that adjusting the comment and the permissions can be changed without regeneration. Therefore, even for <code class="ansible-value docutils literal notranslate"><span class="pre">never</span></code>, the task can result in changed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"never"</span></code></p></li>
|
||||
@@ -397,7 +399,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-type"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssh-keypair-module-parameter-type"><strong>type</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-type" 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 algorithm used to generate the SSH private key. <code class="docutils literal notranslate"><span class="pre">rsa1</span></code> is for protocol version 1. <code class="docutils literal notranslate"><span class="pre">rsa1</span></code> is deprecated and may not be supported by every version of ssh-keygen.</p>
|
||||
<td><div class="ansible-option-cell"><p>The algorithm used to generate the SSH private key. <code class="ansible-value docutils literal notranslate"><span class="pre">rsa1</span></code> is for protocol version 1. <code class="ansible-value docutils literal notranslate"><span class="pre">rsa1</span></code> is deprecated and may not be supported by every version of ssh-keygen.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"rsa"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -468,8 +470,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<ul class="simple">
|
||||
<li><p>In case the ssh key is broken or password protected, the module will fail. Set the <em>force</em> option to <code class="docutils literal notranslate"><span class="pre">true</span></code> if you want to regenerate the keypair.</p></li>
|
||||
<li><p>In the case a custom <code class="docutils literal notranslate"><span class="pre">mode</span></code>, <code class="docutils literal notranslate"><span class="pre">group</span></code>, <code class="docutils literal notranslate"><span class="pre">owner</span></code>, or other file attribute is provided it will be applied to both key files.</p></li>
|
||||
<li><p>In case the ssh key is broken or password protected, the module will fail. Set the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> if you want to regenerate the keypair.</p></li>
|
||||
<li><p>In the case a custom <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-group"><span class="std std-ref"><span class="pre">group</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssh-keypair-module-parameter-owner"><span class="std std-ref"><span class="pre">owner</span></span></a></strong></code>, or other file attribute is provided it will be applied to both key files.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -147,7 +149,7 @@
|
||||
<h1>community.crypto.openssl_certificate_info<a class="headerlink" href="#community-crypto-openssl-certificate-info" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This plugin was part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This plugin was part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</p>
|
||||
</div>
|
||||
<p>This module has been removed
|
||||
in version 2.0.0 of community.crypto.
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -147,7 +149,7 @@
|
||||
<h1>community.crypto.openssl_certificate<a class="headerlink" href="#community-crypto-openssl-certificate" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This plugin was part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This plugin was part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</p>
|
||||
</div>
|
||||
<p>This module has been removed
|
||||
in version 2.0.0 of community.crypto.
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_csr_info filter – Retrieve information from OpenSSL Certificate Signing Requests (CSR)<a class="headerlink" href="#community-crypto-openssl-csr-info-filter-retrieve-information-from-openssl-certificate-signing-requests-csr" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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 filter plugin,
|
||||
see <a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -193,7 +195,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<span id="ansible-collections-community-crypto-openssl-csr-info-filter-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the local controller node that executes this filter.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If <em>name_encoding</em> is set to another value than <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> is set to another value than <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="input">
|
||||
@@ -232,10 +234,10 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#parameter-name_encoding" 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>How to encode names (DNS names, URIs, email addresses) in return values.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="docutils literal notranslate"><span class="pre">idna</span></code> and <code class="docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -293,8 +295,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/authority_cert_issuer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The CSR’s authority cert issuer as a list of general names.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:www.ansible.com",</span> <span class="pre">"IP:1.2.3.4"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -304,7 +306,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/authority_cert_serial_number" 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 CSR’s authority cert serial number.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">12345</span></code></p>
|
||||
</div></td>
|
||||
@@ -314,8 +316,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/authority_key_identifier" 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 CSR’s authority key identifier.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"</span></code></p>
|
||||
</div></td>
|
||||
@@ -324,7 +326,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/basic_constraints"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-filter-return-value-basic-constraints"><strong>basic_constraints</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/basic_constraints" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">basic_constraints</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">basic_constraints</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["CA:TRUE",</span> <span class="pre">"pathlen:1"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -341,7 +343,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/extended_key_usage"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-filter-return-value-extended-key-usage"><strong>extended_key_usage</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/extended_key_usage" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">extended_key_usage</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">extended_key_usage</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["Biometric</span> <span class="pre">Info",</span> <span class="pre">"DVCS",</span> <span class="pre">"Time</span> <span class="pre">Stamping"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -385,7 +387,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/key_usage"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-filter-return-value-key-usage"><strong>key_usage</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/key_usage" 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>Entries in the <code class="docutils literal notranslate"><span class="pre">key_usage</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">key_usage</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"['Key</span> <span class="pre">Agreement',</span> <span class="pre">'Data</span> <span class="pre">Encipherment']"</span></code></p>
|
||||
</div></td>
|
||||
@@ -403,7 +405,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/name_constraints_critical" 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-indent-desc"></div><div class="ansible-option-cell"><p>Whether the <code class="docutils literal notranslate"><span class="pre">name_constraints</span></code> extension is critical.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -412,8 +414,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/name_constraints_excluded" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>List of excluded subtrees the CA cannot sign certificates for.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["email:.com"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -431,7 +433,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/ocsp_must_staple"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-filter-return-value-ocsp-must-staple"><strong>ocsp_must_staple</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/ocsp_must_staple" 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-indent-desc"></div><div class="ansible-option-cell"><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the OCSP Must Staple extension is present, <code class="docutils literal notranslate"><span class="pre">none</span></code> otherwise.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p><code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> if the OCSP Must Staple extension is present, <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> otherwise.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -465,7 +467,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>The curve’s name for ECC.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -473,7 +475,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s public exponent.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -481,7 +483,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -490,7 +492,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -498,7 +500,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s modulus.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -507,7 +509,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -516,7 +518,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -524,7 +526,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>Bit size of modulus (RSA) or prime number (DSA).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code> or <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -532,16 +534,16 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-_value/public_key_data/y"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-data-y"><strong>y</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>For <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></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="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code> or <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<td><div class="ansible-option-indent-desc"></div><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-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_type=DSA</span></span></a></code>, this is the publicly known group element whose discrete logarithm with respect to <code class="docutils literal notranslate"><span class="pre">g</span></code> is the private key.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-csr-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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">
|
||||
@@ -559,7 +561,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>The CSR’s public key’s type.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="docutils literal notranslate"><span class="pre">X448</span></code>.</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="docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
||||
@@ -570,7 +572,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/signature_valid" 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-indent-desc"></div><div class="ansible-option-cell"><p>Whether the CSR’s signature is valid.</p>
|
||||
<p>In case the check returns <code class="docutils literal notranslate"><span class="pre">false</span></code>, the module will fail.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -588,8 +590,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/subject_alt_name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-filter-return-value-subject-alt-name"><strong>subject_alt_name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/subject_alt_name" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:www.ansible.com",</span> <span class="pre">"IP:1.2.3.4"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -607,8 +609,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/subject_key_identifier" 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 CSR’s subject key identifier.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">SubjectKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">SubjectKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_csr_info module – Provide information of OpenSSL Certificate Signing Requests (CSR)<a class="headerlink" href="#community-crypto-openssl-csr-info-module-provide-information-of-openssl-certificate-signing-requests-csr" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-csr-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -193,7 +195,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<span id="ansible-collections-community-crypto-openssl-csr-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If <em>name_encoding</em> is set to another value than <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> is set to another value than <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>cryptography >= 1.3</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -212,7 +214,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the CSR file.</p>
|
||||
<p>Either <em>path</em> or <em>content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-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-csr-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-odd"><td><div class="ansible-option-cell">
|
||||
@@ -220,10 +222,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-name_encoding" 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>How to encode names (DNS names, URIs, email addresses) in return values.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="docutils literal notranslate"><span class="pre">idna</span></code> and <code class="docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -237,7 +239,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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 CSR file is loaded from.</p>
|
||||
<p>Either <em>path</em> or <em>content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-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-csr-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-odd"><td><div class="ansible-option-cell">
|
||||
@@ -245,8 +247,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -297,7 +299,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="openssl_csr_pipe_module.html#ansible-collections-community-crypto-openssl-csr-pipe-module"><span class="std std-ref">community.crypto.openssl_csr_pipe</span></a></dt><dd><p>Generate OpenSSL Certificate Signing Request (CSR).</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="openssl_csr_info_filter.html#ansible-collections-community-crypto-openssl-csr-info-filter"><span class="std std-ref">community.crypto.openssl_csr_info filter</span></a></dt><dd><p>A filter variant of this module.</p>
|
||||
<dt><a class="reference internal" href="openssl_csr_info_filter.html#ansible-collections-community-crypto-openssl-csr-info-filter"><span class="std std-ref">community.crypto.openssl_csr_info</span></a> filter plugin</dt><dd><p>A filter variant of this module.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
@@ -316,7 +318,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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">debug</span><span class="p">:</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>
|
||||
@@ -336,8 +338,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-authority_cert_issuer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The CSR’s authority cert issuer as a list of general names.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:www.ansible.com",</span> <span class="pre">"IP:1.2.3.4"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -347,7 +349,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-authority_cert_serial_number" 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-cell"><p>The CSR’s authority cert serial number.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">12345</span></code></p>
|
||||
</div></td>
|
||||
@@ -357,8 +359,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-authority_key_identifier" 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 CSR’s authority key identifier.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"</span></code></p>
|
||||
</div></td>
|
||||
@@ -367,7 +369,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="return-basic_constraints"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-module-return-basic-constraints"><strong>basic_constraints</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-basic_constraints" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">basic_constraints</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">basic_constraints</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["CA:TRUE",</span> <span class="pre">"pathlen:1"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -384,7 +386,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="return-extended_key_usage"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-module-return-extended-key-usage"><strong>extended_key_usage</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-extended_key_usage" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">extended_key_usage</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">extended_key_usage</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["Biometric</span> <span class="pre">Info",</span> <span class="pre">"DVCS",</span> <span class="pre">"Time</span> <span class="pre">Stamping"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -428,7 +430,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="return-key_usage"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-module-return-key-usage"><strong>key_usage</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-key_usage" 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>Entries in the <code class="docutils literal notranslate"><span class="pre">key_usage</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">key_usage</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"['Key</span> <span class="pre">Agreement',</span> <span class="pre">'Data</span> <span class="pre">Encipherment']"</span></code></p>
|
||||
</div></td>
|
||||
@@ -447,7 +449,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.1.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether the <code class="docutils literal notranslate"><span class="pre">name_constraints</span></code> extension is critical.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -457,8 +459,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.1.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of excluded subtrees the CA cannot sign certificates for.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["email:.com"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -477,7 +479,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="return-ocsp_must_staple"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-module-return-ocsp-must-staple"><strong>ocsp_must_staple</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-ocsp_must_staple" 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><code class="docutils literal notranslate"><span class="pre">true</span></code> if the OCSP Must Staple extension is present, <code class="docutils literal notranslate"><span class="pre">none</span></code> otherwise.</p>
|
||||
<td><div class="ansible-option-cell"><p><code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> if the OCSP Must Staple extension is present, <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> otherwise.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -512,7 +514,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -520,7 +522,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -528,7 +530,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -537,7 +539,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -545,7 +547,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -554,7 +556,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -563,7 +565,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -571,7 +573,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code> or <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -579,16 +581,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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_key_data/y"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-data-y"><strong>y</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></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="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code> or <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<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-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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-csr-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -607,8 +609,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.7.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The CSR’s public key’s type.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="docutils literal notranslate"><span class="pre">X448</span></code>.</p>
|
||||
<p>Will start with <code class="docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
||||
</div></td>
|
||||
@@ -618,7 +620,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-signature_valid" 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 CSR’s signature is valid.</p>
|
||||
<p>In case the check returns <code class="docutils literal notranslate"><span class="pre">false</span></code>, the module will fail.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -636,8 +638,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="return-subject_alt_name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-csr-info-module-return-subject-alt-name"><strong>subject_alt_name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-subject_alt_name" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:www.ansible.com",</span> <span class="pre">"IP:1.2.3.4"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -655,8 +657,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-subject_key_identifier" 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 CSR’s subject key identifier.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">SubjectKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">SubjectKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.openssl_csr module – Generate OpenSSL Certificate Signing Request (CSR)<a class="headerlink" href="#community-crypto-openssl-csr-module-generate-openssl-certificate-signing-request-csr" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-csr-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -186,7 +188,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Please note that the module regenerates an existing CSR if it does not match the module’s options, or if it seems to be corrupt. If you are concerned that this could overwrite your existing CSR, consider using the <em>backup</em> option.</p></li>
|
||||
<li><p>Please note that the module regenerates an existing CSR if it does not match the module’s options, or if it seems to be corrupt. If you are concerned that this could overwrite your existing CSR, consider using the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> option.</p></li>
|
||||
<li><p>This module allows one to (re)generate OpenSSL certificate signing requests.</p></li>
|
||||
<li><p>This module supports the subjectAltName, keyUsage, extendedKeyUsage, basicConstraints and OCSP Must Staple extensions.</p></li>
|
||||
</ul>
|
||||
@@ -224,12 +226,12 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-authority_cert_issuer" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Names that will be present in the authority cert issuer field of the certificate signing request.</p>
|
||||
<p>Values must be prefixed by their options. (i.e., <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code> and the ones specific to your CA)</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">DNS:ca.example.org</span></code></p>
|
||||
<p>If specified, <em>authority_cert_serial_number</em> must also be specified.</p>
|
||||
<p>Values must be prefixed by their options. (That is, <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code>, and the ones specific to your CA)</p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">DNS:ca.example.org</span></code></p>
|
||||
<p>If specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-cert-serial-number"><span class="std std-ref"><span class="pre">authority_cert_serial_number</span></span></a></strong></code> must also be specified.</p>
|
||||
<p>Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <em>authority_key_identifier</em>, <em>authority_cert_issuer</em> and <em>authority_cert_serial_number</em> is specified.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-key-identifier"><span class="std std-ref"><span class="pre">authority_key_identifier</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-cert-issuer"><span class="std std-ref"><span class="pre">authority_cert_issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-cert-serial-number"><span class="std std-ref"><span class="pre">authority_cert_serial_number</span></span></a></strong></code> is specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -237,10 +239,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-authority_cert_serial_number" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The authority cert serial number.</p>
|
||||
<p>If specified, <em>authority_cert_issuer</em> must also be specified.</p>
|
||||
<p>If specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-cert-issuer"><span class="std std-ref"><span class="pre">authority_cert_issuer</span></span></a></strong></code> must also be specified.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p>Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <em>authority_key_identifier</em>, <em>authority_cert_issuer</em> and <em>authority_cert_serial_number</em> is specified.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-key-identifier"><span class="std std-ref"><span class="pre">authority_key_identifier</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-cert-issuer"><span class="std std-ref"><span class="pre">authority_cert_issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-cert-serial-number"><span class="std std-ref"><span class="pre">authority_cert_serial_number</span></span></a></strong></code> is specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -248,10 +250,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-authority_key_identifier" 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 authority key identifier as a hex string, where two bytes are separated by colons.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33</span></code></p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33</span></code></p>
|
||||
<p>Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <em>authority_key_identifier</em>, <em>authority_cert_issuer</em> and <em>authority_cert_serial_number</em> is specified.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-key-identifier"><span class="std std-ref"><span class="pre">authority_key_identifier</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-cert-issuer"><span class="std std-ref"><span class="pre">authority_cert_issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-authority-cert-serial-number"><span class="std std-ref"><span class="pre">authority_cert_serial_number</span></span></a></strong></code> is specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -344,8 +346,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-crl_distribution_points/full_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Describes how the CRL can be retrieved.</p>
|
||||
<p>Mutually exclusive with <em>relative_name</em>.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">URI:https://ca.example.com/revocations.crl</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-crl-distribution-points-relative-name"><span class="std std-ref"><span class="pre">crl_distribution_points[].relative_name</span></span></a></strong></code>.</p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">URI:https://ca.example.com/revocations.crl</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -371,8 +373,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-crl_distribution_points/relative_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Describes how the CRL can be retrieved relative to the CRL issuer.</p>
|
||||
<p>Mutually exclusive with <em>full_name</em>.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">/CN=example.com</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-crl-distribution-points-full-name"><span class="std std-ref"><span class="pre">crl_distribution_points[].full_name</span></span></a></strong></code>.</p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">/CN=example.com</span></code>.</p>
|
||||
<p>Can only be used when cryptography >= 1.6 is installed.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -504,7 +506,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.1.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>For CA certificates, this specifies a list of identifiers which describe subtrees of names that this CA is <strong>not</strong> allowed to issue certificates for.</p>
|
||||
<p>Values must be prefixed by their options. (i.e., <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code> and the ones specific to your CA).</p>
|
||||
<p>Values must be prefixed by their options. (That is, <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code>, and the ones specific to your CA).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -513,7 +515,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.1.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>For CA certificates, this specifies a list of identifiers which describe subtrees of names that this CA is allowed to issue certificates for.</p>
|
||||
<p>Values must be prefixed by their options. (i.e., <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code> and the ones specific to your CA).</p>
|
||||
<p>Values must be prefixed by their options. (That is, <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code>, and the ones specific to your CA).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -587,7 +589,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The content of the private key to use when signing the certificate signing request.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_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-csr-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code> must be specified if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -603,7 +605,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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>The path to the private key to use when signing the certificate signing request.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_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-csr-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code> must be specified if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -611,7 +613,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-return_content" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) CSR’s content as <em>csr</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) CSR’s content as <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-return-csr"><span class="std std-ref"><span class="pre">csr</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -624,8 +626,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -695,8 +697,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Key/value pairs that will be present in the subject name field of the certificate signing request.</p>
|
||||
<p>If you need to specify more than one value with the same key, use a list as value.</p>
|
||||
<p>If the order of the components is important, use <em>subject_ordered</em>.</p>
|
||||
<p>Mutually exclusive with <em>subject_ordered</em>.</p>
|
||||
<p>If the order of the components is important, use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-subject-ordered"><span class="std std-ref"><span class="pre">subject_ordered</span></span></a></strong></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-subject-ordered"><span class="std std-ref"><span class="pre">subject_ordered</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -707,7 +709,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Subject Alternative Name (SAN) extension to attach to the certificate signing request.</p>
|
||||
<p>Values must be prefixed by their options. (These are <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code>, and the ones specific to your CA).</p>
|
||||
<p>Note that if no SAN is specified, but a common name, the common name will be added as a SAN except if <code class="docutils literal notranslate"><span class="pre">useCommonNameForSAN</span></code> is set to <em>false</em>.</p>
|
||||
<p>Note that if no SAN is specified, but a common name, the common name will be added as a SAN except if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-use-common-name-for-san"><span class="std std-ref"><span class="pre">use_common_name_for_san</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<p>More at <a class="reference external" href="https://tools.ietf.org/html/rfc5280#section-4.2.1.6">https://tools.ietf.org/html/rfc5280#section-4.2.1.6</a>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -730,9 +732,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-subject_key_identifier" 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 subject key identifier as a hex string, where two bytes are separated by colons.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33</span></code></p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33</span></code></p>
|
||||
<p>Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.</p>
|
||||
<p>Note that this option can only be used if <em>create_subject_key_identifier</em> is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<p>Note that this option can only be used if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-create-subject-key-identifier"><span class="std std-ref"><span class="pre">create_subject_key_identifier</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -743,7 +745,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A list of dictionaries, where every dictionary must contain one key/value pair. This key/value pair will be present in the subject name field of the certificate signing request.</p>
|
||||
<p>If you want to specify more than one value with the same key in a row, you can use a list as value.</p>
|
||||
<p>Mutually exclusive with <em>subject</em>, and any other subject field option, such as <em>country_name</em>, <em>state_or_province_name</em>, <em>locality_name</em>, <em>organization_name</em>, <em>organizational_unit_name</em>, <em>common_name</em>, or <em>email_address</em>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-subject"><span class="std std-ref"><span class="pre">subject</span></span></a></strong></code>, and any other subject field option, such as <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-country-name"><span class="std std-ref"><span class="pre">country_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-state-or-province-name"><span class="std std-ref"><span class="pre">state_or_province_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-locality-name"><span class="std std-ref"><span class="pre">locality_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-organization-name"><span class="std std-ref"><span class="pre">organization_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-organizational-unit-name"><span class="std std-ref"><span class="pre">organizational_unit_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-common-name"><span class="std std-ref"><span class="pre">common_name</span></span></a></strong></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-email-address"><span class="std std-ref"><span class="pre">email_address</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -767,7 +769,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-use_common_name_for_san" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: useCommonNameForSAN</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the module will fill the common name in for <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> with <code class="docutils literal notranslate"><span class="pre">DNS:</span></code> prefix if no SAN is specified.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, the module will fill the common name in for <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-subject-alt-name"><span class="std std-ref"><span class="pre">subject_alt_name</span></span></a></strong></code> with <code class="docutils literal notranslate"><span class="pre">DNS:</span></code> prefix if no SAN is specified.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -975,7 +977,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/www.ansible.com.csr.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -994,7 +996,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The (current or generated) CSR’s content.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and <em>return_content</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-return-content"><span class="std std-ref"><span class="pre">return_content</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -1058,7 +1060,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-privatekey" 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>Path to the TLS/SSL private key the CSR was generated for</p>
|
||||
<p>Will be <code class="docutils literal notranslate"><span class="pre">none</span></code> if the private key has been provided in <em>privatekey_content</em>.</p>
|
||||
<p>Will be <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the private key has been provided in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/etc/ssl/private/ansible.com.pem"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.openssl_csr_pipe module – Generate OpenSSL Certificate Signing Request (CSR)<a class="headerlink" href="#community-crypto-openssl-csr-pipe-module-generate-openssl-certificate-signing-request-csr" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-csr-pipe-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -213,12 +215,12 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-authority_cert_issuer" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Names that will be present in the authority cert issuer field of the certificate signing request.</p>
|
||||
<p>Values must be prefixed by their options. (i.e., <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code> and the ones specific to your CA)</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">DNS:ca.example.org</span></code></p>
|
||||
<p>If specified, <em>authority_cert_serial_number</em> must also be specified.</p>
|
||||
<p>Values must be prefixed by their options. (That is, <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code>, and the ones specific to your CA)</p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">DNS:ca.example.org</span></code></p>
|
||||
<p>If specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-cert-serial-number"><span class="std std-ref"><span class="pre">authority_cert_serial_number</span></span></a></strong></code> must also be specified.</p>
|
||||
<p>Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <em>authority_key_identifier</em>, <em>authority_cert_issuer</em> and <em>authority_cert_serial_number</em> is specified.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-key-identifier"><span class="std std-ref"><span class="pre">authority_key_identifier</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-cert-issuer"><span class="std std-ref"><span class="pre">authority_cert_issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-cert-serial-number"><span class="std std-ref"><span class="pre">authority_cert_serial_number</span></span></a></strong></code> is specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -226,10 +228,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-authority_cert_serial_number" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The authority cert serial number.</p>
|
||||
<p>If specified, <em>authority_cert_issuer</em> must also be specified.</p>
|
||||
<p>If specified, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-cert-issuer"><span class="std std-ref"><span class="pre">authority_cert_issuer</span></span></a></strong></code> must also be specified.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p>Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <em>authority_key_identifier</em>, <em>authority_cert_issuer</em> and <em>authority_cert_serial_number</em> is specified.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-key-identifier"><span class="std std-ref"><span class="pre">authority_key_identifier</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-cert-issuer"><span class="std std-ref"><span class="pre">authority_cert_issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-cert-serial-number"><span class="std std-ref"><span class="pre">authority_cert_serial_number</span></span></a></strong></code> is specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -237,10 +239,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-authority_key_identifier" 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 authority key identifier as a hex string, where two bytes are separated by colons.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33</span></code></p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33</span></code></p>
|
||||
<p>Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <em>authority_key_identifier</em>, <em>authority_cert_issuer</em> and <em>authority_cert_serial_number</em> is specified.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension will only be added if at least one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-key-identifier"><span class="std std-ref"><span class="pre">authority_key_identifier</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-cert-issuer"><span class="std std-ref"><span class="pre">authority_cert_issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-authority-cert-serial-number"><span class="std std-ref"><span class="pre">authority_cert_serial_number</span></span></a></strong></code> is specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -328,8 +330,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-crl_distribution_points/full_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Describes how the CRL can be retrieved.</p>
|
||||
<p>Mutually exclusive with <em>relative_name</em>.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">URI:https://ca.example.com/revocations.crl</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-crl-distribution-points-relative-name"><span class="std std-ref"><span class="pre">crl_distribution_points[].relative_name</span></span></a></strong></code>.</p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">URI:https://ca.example.com/revocations.crl</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -355,8 +357,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-crl_distribution_points/relative_name" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Describes how the CRL can be retrieved relative to the CRL issuer.</p>
|
||||
<p>Mutually exclusive with <em>full_name</em>.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">/CN=example.com</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-crl-distribution-points-full-name"><span class="std std-ref"><span class="pre">crl_distribution_points[].full_name</span></span></a></strong></code>.</p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">/CN=example.com</span></code>.</p>
|
||||
<p>Can only be used when cryptography >= 1.6 is installed.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -453,7 +455,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-name_constraints_excluded" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>For CA certificates, this specifies a list of identifiers which describe subtrees of names that this CA is <strong>not</strong> allowed to issue certificates for.</p>
|
||||
<p>Values must be prefixed by their options. (i.e., <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code> and the ones specific to your CA).</p>
|
||||
<p>Values must be prefixed by their options. (That is, <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code>, and the ones specific to your CA).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -461,7 +463,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-name_constraints_permitted" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>For CA certificates, this specifies a list of identifiers which describe subtrees of names that this CA is allowed to issue certificates for.</p>
|
||||
<p>Values must be prefixed by their options. (i.e., <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code> and the ones specific to your CA).</p>
|
||||
<p>Values must be prefixed by their options. (That is, <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code>, and the ones specific to your CA).</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -518,7 +520,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_content" 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 content of the private key to use when signing the certificate signing request.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_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-csr-pipe-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code> must be specified, but not both.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -534,7 +536,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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>The path to the private key to use when signing the certificate signing request.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_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-csr-pipe-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code> must be specified, but not both.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -542,8 +544,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -567,8 +569,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Key/value pairs that will be present in the subject name field of the certificate signing request.</p>
|
||||
<p>If you need to specify more than one value with the same key, use a list as value.</p>
|
||||
<p>If the order of the components is important, use <em>subject_ordered</em>.</p>
|
||||
<p>Mutually exclusive with <em>subject_ordered</em>.</p>
|
||||
<p>If the order of the components is important, use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-subject-ordered"><span class="std std-ref"><span class="pre">subject_ordered</span></span></a></strong></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-subject-ordered"><span class="std std-ref"><span class="pre">subject_ordered</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -579,7 +581,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Subject Alternative Name (SAN) extension to attach to the certificate signing request.</p>
|
||||
<p>Values must be prefixed by their options. (These are <code class="docutils literal notranslate"><span class="pre">email</span></code>, <code class="docutils literal notranslate"><span class="pre">URI</span></code>, <code class="docutils literal notranslate"><span class="pre">DNS</span></code>, <code class="docutils literal notranslate"><span class="pre">RID</span></code>, <code class="docutils literal notranslate"><span class="pre">IP</span></code>, <code class="docutils literal notranslate"><span class="pre">dirName</span></code>, <code class="docutils literal notranslate"><span class="pre">otherName</span></code>, and the ones specific to your CA).</p>
|
||||
<p>Note that if no SAN is specified, but a common name, the common name will be added as a SAN except if <code class="docutils literal notranslate"><span class="pre">useCommonNameForSAN</span></code> is set to <em>false</em>.</p>
|
||||
<p>Note that if no SAN is specified, but a common name, the common name will be added as a SAN except if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-use-common-name-for-san"><span class="std std-ref"><span class="pre">use_common_name_for_san</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<p>More at <a class="reference external" href="https://tools.ietf.org/html/rfc5280#section-4.2.1.6">https://tools.ietf.org/html/rfc5280#section-4.2.1.6</a>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -602,9 +604,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-subject_key_identifier" 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 subject key identifier as a hex string, where two bytes are separated by colons.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33</span></code></p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33</span></code></p>
|
||||
<p>Please note that commercial CAs ignore this value, respectively use a value of their own choice. Specifying this option is mostly useful for self-signed certificates or for own CAs.</p>
|
||||
<p>Note that this option can only be used if <em>create_subject_key_identifier</em> is <code class="docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<p>Note that this option can only be used if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-create-subject-key-identifier"><span class="std std-ref"><span class="pre">create_subject_key_identifier</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -615,7 +617,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A list of dictionaries, where every dictionary must contain one key/value pair. This key/value pair will be present in the subject name field of the certificate signing request.</p>
|
||||
<p>If you want to specify more than one value with the same key in a row, you can use a list as value.</p>
|
||||
<p>Mutually exclusive with <em>subject</em>, and any other subject field option, such as <em>country_name</em>, <em>state_or_province_name</em>, <em>locality_name</em>, <em>organization_name</em>, <em>organizational_unit_name</em>, <em>common_name</em>, or <em>email_address</em>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-subject"><span class="std std-ref"><span class="pre">subject</span></span></a></strong></code>, and any other subject field option, such as <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-country-name"><span class="std std-ref"><span class="pre">country_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-state-or-province-name"><span class="std std-ref"><span class="pre">state_or_province_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-locality-name"><span class="std std-ref"><span class="pre">locality_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-organization-name"><span class="std std-ref"><span class="pre">organization_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-organizational-unit-name"><span class="std std-ref"><span class="pre">organizational_unit_name</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-common-name"><span class="std std-ref"><span class="pre">common_name</span></span></a></strong></code>, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-email-address"><span class="std std-ref"><span class="pre">email_address</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -624,7 +626,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-use_common_name_for_san" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: useCommonNameForSAN</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the module will fill the common name in for <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> with <code class="docutils literal notranslate"><span class="pre">DNS:</span></code> prefix if no SAN is specified.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, the module will fill the common name in for <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-subject-alt-name"><span class="std std-ref"><span class="pre">subject_alt_name</span></span></a></strong></code> with <code class="docutils literal notranslate"><span class="pre">DNS:</span></code> prefix if no SAN is specified.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -719,7 +721,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<span class="w"> </span><span class="nt">privatekey_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">common_name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">www.ansible.com</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">debug</span><span class="p">:</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">Print CSR</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.csr</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 Certificate Signing Request with an inline CSR</span>
|
||||
@@ -813,7 +816,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-privatekey" 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>Path to the TLS/SSL private key the CSR was generated for</p>
|
||||
<p>Will be <code class="docutils literal notranslate"><span class="pre">none</span></code> if the private key has been provided in <em>privatekey_content</em>.</p>
|
||||
<p>Will be <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the private key has been provided in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-csr-pipe-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/etc/ssl/private/ansible.com.pem"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_dhparam module – Generate OpenSSL Diffie-Hellman Parameters<a class="headerlink" href="#community-crypto-openssl-dhparam-module-generate-openssl-diffie-hellman-parameters" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-dhparam-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -186,8 +188,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<ul class="simple">
|
||||
<li><p>This module allows one to (re)generate OpenSSL DH-params.</p></li>
|
||||
<li><p>This module uses file common arguments to specify generated file permissions.</p></li>
|
||||
<li><p>Please note that the module regenerates existing DH params if they do not match the module’s options. If you are concerned that this could overwrite your existing DH params, consider using the <em>backup</em> option.</p></li>
|
||||
<li><p>The module can use the cryptography Python library, or the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> executable. By default, it tries to detect which one is available. This can be overridden with the <em>select_crypto_backend</em> option.</p></li>
|
||||
<li><p>Please note that the module regenerates existing DH params if they do not match the module’s options. If you are concerned that this could overwrite your existing DH params, consider using the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-dhparam-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> option.</p></li>
|
||||
<li><p>The module can use the cryptography Python library, or the <code class="docutils literal notranslate"><span class="pre">openssl</span></code> executable. By default, it tries to detect which one is available. This can be overridden with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-dhparam-module-parameter-select-crypto-backend"><span class="std std-ref"><span class="pre">select_crypto_backend</span></span></a></strong></code> option.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
@@ -285,7 +287,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-return_content" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) DH parameter’s content as <em>dhparams</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) DH parameter’s content as <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-dhparam-module-return-dhparams"><span class="std std-ref"><span class="pre">dhparams</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -299,9 +301,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</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="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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the OpenSSL <code class="docutils literal notranslate"><span class="pre">openssl</span></code> executable.</p>
|
||||
<p>If set to <code class="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>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, and falls back to <code class="docutils literal notranslate"><span class="pre">openssl</span></code>.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">openssl</span></code>, will try to use the OpenSSL <code class="docutils literal notranslate"><span class="pre">openssl</span></code> executable.</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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -470,7 +472,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-dhparam-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/dhparams.pem.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -480,7 +482,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The (current or generated) DH params’ content.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and <em>return_content</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-dhparam-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-dhparam-module-parameter-return-content"><span class="std std-ref"><span class="pre">return_content</span></span></a></strong></code> is <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">
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_pkcs12 module – Generate OpenSSL PKCS#12 archive<a class="headerlink" href="#community-crypto-openssl-pkcs12-module-generate-openssl-pkcs-12-archive" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-pkcs12-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -185,7 +187,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>This module allows one to (re-)generate PKCS#12.</p></li>
|
||||
<li><p>The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available, assuming none of the <em>iter_size</em> and <em>maciter_size</em> options are used. This can be overridden with the <em>select_crypto_backend</em> option.</p></li>
|
||||
<li><p>The module can use the cryptography Python library, or the pyOpenSSL Python library. By default, it tries to detect which one is available, assuming none of the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-iter-size"><span class="std std-ref"><span class="pre">iter_size</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-maciter-size"><span class="std std-ref"><span class="pre">maciter_size</span></span></a></strong></code> options are used. This can be overridden with the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-select-crypto-backend"><span class="std std-ref"><span class="pre">select_crypto_backend</span></span></a></strong></code> option.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
@@ -208,7 +210,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-action"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-pkcs12-module-parameter-action"><strong>action</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-action" 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><code class="docutils literal notranslate"><span class="pre">export</span></code> or <code class="docutils literal notranslate"><span class="pre">parse</span></code> a PKCS#12.</p>
|
||||
<td><div class="ansible-option-cell"><p><code class="ansible-value docutils literal notranslate"><span class="pre">export</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">parse</span></code> a PKCS#12.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"export"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -254,8 +256,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.8.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Determines the encryption level used.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">auto</span></code> uses the default of the selected backend. For <code class="docutils literal notranslate"><span class="pre">cryptography</span></code>, this is what the cryptography library’s specific version considers the best available encryption.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">compatibility2022</span></code> uses compatibility settings for older software in 2022. This is only supported by the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend if cryptography >= 38.0.0 is available.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code> uses the default of the selected backend. For <code class="docutils literal notranslate"><span class="pre">cryptography</span></code>, this is what the cryptography library’s specific version considers the best available encryption.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">compatibility2022</span></code> uses compatibility settings for older software in 2022. This is only supported by the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend if cryptography >= 38.0.0 is available.</p>
|
||||
<p><strong>Note</strong> that this option is <strong>not used for idempotency</strong>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -299,8 +301,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Number of times to repeat the encryption step.</p>
|
||||
<p>This is <strong>not considered during idempotency checks</strong>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> backend, or when <em>encryption_level=compatibility2022</em>.</p>
|
||||
<p>When using it, the default is <code class="docutils literal notranslate"><span class="pre">2048</span></code> for <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> and <code class="docutils literal notranslate"><span class="pre">50000</span></code> for <code class="docutils literal notranslate"><span class="pre">cryptography</span></code>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> backend, or when <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-encryption-level"><span class="std std-ref"><span class="pre">encryption_level=compatibility2022</span></span></a></code>.</p>
|
||||
<p>When using it, the default is <code class="ansible-value docutils literal notranslate"><span class="pre">2048</span></code> for <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">50000</span></code> for <code class="docutils literal notranslate"><span class="pre">cryptography</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -309,7 +311,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Number of times to repeat the MAC step.</p>
|
||||
<p>This is <strong>not considered during idempotency checks</strong>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> backend. When using it, the default is <code class="docutils literal notranslate"><span class="pre">1</span></code>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> backend. When using it, the default is <code class="ansible-value docutils literal notranslate"><span class="pre">1</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -331,8 +333,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-other_certificates" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-aliases">aliases: ca_certificates</span></p>
|
||||
<p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=path</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of other certificates to include. Pre Ansible 2.8 this parameter was called <em>ca_certificates</em>.</p>
|
||||
<p>Assumes there is one PEM-encoded certificate per file. If a file contains multiple PEM certificates, set <em>other_certificates_parse_all</em> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>List of other certificates to include. Pre Ansible 2.8 this parameter was called <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-ca-certificates"><span class="std std-ref"><span class="pre">ca_certificates</span></span></a></strong></code>.</p>
|
||||
<p>Assumes there is one PEM-encoded certificate per file. If a file contains multiple PEM certificates, set <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-other-certificates-parse-all"><span class="std std-ref"><span class="pre">other_certificates_parse_all</span></span></a></strong></code> 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">
|
||||
@@ -340,7 +342,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-other_certificates_parse_all" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.4.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, assumes that the files mentioned in <em>other_certificates</em> can contain more than one certificate per file (or even none per file).</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, assumes that the files mentioned in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-other-certificates"><span class="std std-ref"><span class="pre">other_certificates</span></span></a></strong></code> can contain more than one certificate per file (or even none per file).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -378,7 +380,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.3.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the private key file.</p>
|
||||
<p>Mutually exclusive with <em>privatekey_path</em>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -393,7 +395,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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>File to read private key from.</p>
|
||||
<p>Mutually exclusive with <em>privatekey_content</em>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -401,7 +403,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-return_content" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) PKCS#12’s content as <em>pkcs12</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) PKCS#12’s content as <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-return-pkcs12"><span class="std std-ref"><span class="pre">pkcs12</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -415,9 +417,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.7.0</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="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, and falls back to <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code>. If <em>iter_size</em> is used together with <em>encryption_level != compatibility2022</em>, or if <em>maciter_size</em> is used, <code class="docutils literal notranslate"><span class="pre">auto</span></code> will always result in <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> to be chosen for backwards compatibility.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code>, will try to use the <a class="reference external" href="https://pypi.org/project/pyOpenSSL/">pyOpenSSL</a> library.</p>
|
||||
<p>If set to <code class="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>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, and falls back to <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code>. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-iter-size"><span class="std std-ref"><span class="pre">iter_size</span></span></a></strong></code> is used together with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-encryption-level"><span class="std std-ref"><span class="pre">encryption_level</span></span></a></strong></code> is not <code class="ansible-value docutils literal notranslate"><span class="pre">compatibility2022</span></code>, or if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-maciter-size"><span class="std std-ref"><span class="pre">maciter_size</span></span></a></strong></code> is used, <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code> will always result in <code class="docutils literal notranslate"><span class="pre">pyopenssl</span></code> to be chosen for backwards compatibility.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">pyopenssl</span></code>, will try to use the <a class="reference external" href="https://pypi.org/project/pyOpenSSL/">pyOpenSSL</a> library.</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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -471,7 +473,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-state"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-pkcs12-module-parameter-state"><strong>state</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-state" 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>Whether the file should exist or not. All parameters except <code class="docutils literal notranslate"><span class="pre">path</span></code> are ignored when state is <code class="docutils literal notranslate"><span class="pre">absent</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether the file should exist or not. All parameters except <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-path"><span class="std std-ref"><span class="pre">path</span></span></a></strong></code> are ignored when state is <code class="ansible-value docutils literal notranslate"><span class="pre">absent</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"absent"</span></code></p></li>
|
||||
@@ -638,7 +640,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/ansible.com.pem.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -657,7 +659,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The (current or generated) PKCS#12’s content Base64 encoded.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and <em>return_content</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-pkcs12-module-parameter-return-content"><span class="std std-ref"><span class="pre">return_content</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_privatekey_convert module – Convert OpenSSL private keys<a class="headerlink" href="#community-crypto-openssl-privatekey-convert-module-convert-openssl-private-keys" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-convert-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -186,7 +188,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>This module allows one to convert OpenSSL private keys.</p></li>
|
||||
<li><p>The default mode for the private key file will be <code class="docutils literal notranslate"><span class="pre">0600</span></code> if <em>mode</em> is not explicitly set.</p></li>
|
||||
<li><p>The default mode for the private key file will be <code class="ansible-value docutils literal notranslate"><span class="pre">0600</span></code> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-convert-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code> is not explicitly set.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
@@ -240,7 +242,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-dest_path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-convert-module-parameter-dest-path"><strong>dest_path</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-dest_path" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">path</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the file in which the generated TLS/SSL private key will be written. It will have <code class="docutils literal notranslate"><span class="pre">0600</span></code> mode if <em>mode</em> is not explicitly set.</p>
|
||||
<td><div class="ansible-option-cell"><p>Name of the file in which the generated TLS/SSL private key will be written. It will have <code class="ansible-value docutils literal notranslate"><span class="pre">0600</span></code> mode if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-convert-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code> is not explicitly set.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -326,7 +328,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-src_content" 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 content of the file containing the OpenSSL private key to convert.</p>
|
||||
<p>Exactly one of <em>src_path</em> or <em>src_content</em> must be specified.</p>
|
||||
<p>Exactly one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-convert-module-parameter-src-path"><span class="std std-ref"><span class="pre">src_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-convert-module-parameter-src-content"><span class="std std-ref"><span class="pre">src_content</span></span></a></strong></code> must be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -341,7 +343,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-src_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>Name of the file containing the OpenSSL private key to convert.</p>
|
||||
<p>Exactly one of <em>src_path</em> or <em>src_content</em> must be specified.</p>
|
||||
<p>Exactly one of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-convert-module-parameter-src-path"><span class="std std-ref"><span class="pre">src_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-convert-module-parameter-src-content"><span class="std std-ref"><span class="pre">src_content</span></span></a></strong></code> must be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -439,7 +441,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-convert-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/privatekey.pem.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_privatekey_info filter – Retrieve information from OpenSSL private keys<a class="headerlink" href="#community-crypto-openssl-privatekey-info-filter-retrieve-information-from-openssl-private-keys" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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 filter plugin,
|
||||
see <a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -193,7 +195,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<span id="ansible-collections-community-crypto-openssl-privatekey-info-filter-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the local controller node that executes this filter.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If <em>name_encoding</em> is set to another value than <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> is set to another value than <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="input">
|
||||
@@ -232,10 +234,10 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#parameter-name_encoding" 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>How to encode names (DNS names, URIs, email addresses) in return values.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="docutils literal notranslate"><span class="pre">idna</span></code> and <code class="docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -256,7 +258,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<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="docutils literal notranslate"><span class="pre">true</span></code> when you want private information about this key to be extracted.</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 be extracted.</p>
|
||||
<p><strong>WARNING:</strong> you have to make sure that private key data is not accidentally logged!</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -314,7 +316,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>Private key data. Depends on key type.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and when <em>return_private_key_data</em> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success and when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -330,7 +332,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>The curve’s name for ECC.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -338,7 +340,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s public exponent.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -346,7 +348,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -355,7 +357,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -363,7 +365,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s modulus.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -372,7 +374,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -381,7 +383,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -389,7 +391,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>Bit size of modulus (RSA) or prime number (DSA).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code> or <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -397,16 +399,16 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-_value/public_data/y"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-public-data-y"><strong>y</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>For <code class="docutils literal notranslate"><span class="pre">type=ECC</span></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="docutils literal notranslate"><span class="pre">type=DSA</span></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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code> or <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<td><div class="ansible-option-indent-desc"></div><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-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.type=DSA</span></span></a></code>, this is the publicly known group element whose discrete logarithm with respect to <code class="docutils literal notranslate"><span class="pre">g</span></code> is the private key.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -433,8 +435,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>The key’s type.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="docutils literal notranslate"><span class="pre">X448</span></code>.</p>
|
||||
<p>Will start with <code class="docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<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="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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>
|
||||
@@ -185,7 +187,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink 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="docutils literal notranslate"><span class="pre">none</span></code> is returned for <code class="docutils literal notranslate"><span class="pre">key_is_consistent</span></code>.</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>
|
||||
@@ -226,7 +228,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the private key file.</p>
|
||||
<p>Either <em>path</em> or <em>content</em> must be specified, but not both.</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">
|
||||
@@ -248,7 +250,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="docutils literal notranslate"><span class="pre">true</span></code> when you want private information about this key to leave the remote machine.</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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -262,8 +264,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -314,7 +316,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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 filter</span></a></dt><dd><p>A filter variant of this module.</p>
|
||||
<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>
|
||||
@@ -366,9 +368,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="docutils literal notranslate"><span class="pre">none</span></code> next to <code class="docutils literal notranslate"><span class="pre">true</span></code> and <code class="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="docutils literal notranslate"><span class="pre">false</span></code>, the module will fail.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> when <em>check_consistency=true</em></p>
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -376,7 +378,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> success and when <em>return_private_key_data</em> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -392,7 +394,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -400,7 +402,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -408,7 +410,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -417,7 +419,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -425,7 +427,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -434,7 +436,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -443,7 +445,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -451,7 +453,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code> or <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -459,16 +461,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> 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="docutils literal notranslate"><span class="pre">type=ECC</span></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="docutils literal notranslate"><span class="pre">type=DSA</span></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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code> or <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> 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">
|
||||
@@ -495,8 +497,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="docutils literal notranslate"><span class="pre">X448</span></code>.</p>
|
||||
<p>Will start with <code class="docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_privatekey module – Generate OpenSSL private keys<a class="headerlink" href="#community-crypto-openssl-privatekey-module-generate-openssl-private-keys" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -185,9 +187,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Keys are generated in PEM format.</p></li>
|
||||
<li><p>One can generate <a class="reference external" href="https://en.wikipedia.org/wiki/RSA_%28cryptosystem%29">RSA</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Digital_Signature_Algorithm">DSA</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Elliptic-curve_cryptography">ECC</a> or <a class="reference external" href="https://en.wikipedia.org/wiki/EdDSA">EdDSA</a> private keys.</p></li>
|
||||
<li><p>Please note that the module regenerates private keys if they do not match the module’s options. In particular, if you provide another passphrase (or specify none), change the keysize, etc., the private key will be regenerated. If you are concerned that this could <strong>overwrite your private key</strong>, consider using the <em>backup</em> option.</p></li>
|
||||
<li><p>The default mode for the private key file will be <code class="docutils literal notranslate"><span class="pre">0600</span></code> if <em>mode</em> is not explicitly set.</p></li>
|
||||
<li><p>One can generate <a class="reference external" href="https://en.wikipedia.org/wiki/RSA_%2528cryptosystem%2529">RSA</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Digital_Signature_Algorithm">DSA</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Elliptic-curve_cryptography">ECC</a> or <a class="reference external" href="https://en.wikipedia.org/wiki/EdDSA">EdDSA</a> private keys.</p></li>
|
||||
<li><p>Please note that the module regenerates private keys if they do not match the module’s options. In particular, if you provide another passphrase (or specify none), change the keysize, etc., the private key will be regenerated. If you are concerned that this could <strong>overwrite your private key</strong>, consider using the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> option.</p></li>
|
||||
<li><p>The default mode for the private key file will be <code class="ansible-value docutils literal notranslate"><span class="pre">0600</span></code> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code> is not explicitly set.</p></li>
|
||||
<li><p>This module allows one to (re)generate OpenSSL private keys.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -235,7 +237,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-cipher"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-module-parameter-cipher"><strong>cipher</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-cipher" 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 cipher to encrypt the private key. Must be <code class="docutils literal notranslate"><span class="pre">auto</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The cipher to encrypt the private key. Must be <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -243,9 +245,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-curve" 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>Note that not all curves are supported by all versions of <code class="docutils literal notranslate"><span class="pre">cryptography</span></code>.</p>
|
||||
<p>For maximal interoperability, <code class="docutils literal notranslate"><span class="pre">secp384r1</span></code> or <code class="docutils literal notranslate"><span class="pre">secp256r1</span></code> should be used.</p>
|
||||
<p>For maximal interoperability, <code class="ansible-value docutils literal notranslate"><span class="pre">secp384r1</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">secp256r1</span></code> should be used.</p>
|
||||
<p>We use the curve names as defined in the <a class="reference external" href="https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-8">IANA registry for TLS</a>.</p>
|
||||
<p>Please note that all curves except <code class="docutils literal notranslate"><span class="pre">secp224r1</span></code>, <code class="docutils literal notranslate"><span class="pre">secp256k1</span></code>, <code class="docutils literal notranslate"><span class="pre">secp256r1</span></code>, <code class="docutils literal notranslate"><span class="pre">secp384r1</span></code> and <code class="docutils literal notranslate"><span class="pre">secp521r1</span></code> are discouraged for new private keys.</p>
|
||||
<p>Please note that all curves except <code class="ansible-value docutils literal notranslate"><span class="pre">secp224r1</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">secp256k1</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">secp256r1</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">secp384r1</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">secp521r1</span></code> are discouraged for new private keys.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"secp224r1"</span></code></p></li>
|
||||
@@ -288,8 +290,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Determines which format the private key is written in. By default, PKCS1 (traditional OpenSSL format) is used for all keys which support it. Please note that not every key can be exported in any format.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">auto</span></code> selects a format based on the key format. The value <code class="docutils literal notranslate"><span class="pre">auto_ignore</span></code> does the same, but for existing private key files, it will not force a regenerate when its format is not the automatically selected one for generation.</p>
|
||||
<p>Note that if the format for an existing private key mismatches, the key is <strong>regenerated</strong> by default. To change this behavior, use the <em>format_mismatch</em> option.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code> selects a format based on the key format. The value <code class="ansible-value docutils literal notranslate"><span class="pre">auto_ignore</span></code> does the same, but for existing private key files, it will not force a regenerate when its format is not the automatically selected one for generation.</p>
|
||||
<p>Note that if the format for an existing private key mismatches, the key is <strong>regenerated</strong> by default. To change this behavior, use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-format-mismatch"><span class="std std-ref"><span class="pre">format_mismatch</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"pkcs1"</span></code></p></li>
|
||||
@@ -306,8 +308,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Determines behavior of the module if the format of a private key does not match the expected format, but all other parameters are as expected.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">regenerate</span></code> (default), generates a new private key.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">convert</span></code>, the key will be converted to the new format instead.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">regenerate</span></code> (default), generates a new private key.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">convert</span></code>, the key will be converted to the new format instead.</p>
|
||||
<p>Only supported by the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -357,7 +359,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-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> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the file in which the generated TLS/SSL private key will be written. It will have <code class="docutils literal notranslate"><span class="pre">0600</span></code> mode if <em>mode</em> is not explicitly set.</p>
|
||||
<td><div class="ansible-option-cell"><p>Name of the file in which the generated TLS/SSL private key will be written. It will have <code class="ansible-value docutils literal notranslate"><span class="pre">0600</span></code> mode if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code> is not explicitly set.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -366,13 +368,13 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Allows to configure in which situations the module is allowed to regenerate private keys. The module will always generate a new key if the destination file does not exist.</p>
|
||||
<p>By default, the key will be regenerated when it does not match the module’s options, except when the key cannot be read or the passphrase does not match. Please note that this <strong>changed</strong> for Ansible 2.10. For Ansible 2.9, the behavior was as if <code class="docutils literal notranslate"><span class="pre">full_idempotence</span></code> is specified.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">never</span></code>, the module will fail if the key cannot be read or the passphrase is not matching, and will never regenerate an existing key.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">fail</span></code>, the module will fail if the key does not correspond to the module’s options.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">partial_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. The key is <strong>not</strong> regenerated if it cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">full_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. This is also the case if the key cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified. Make sure you have a <strong>backup</strong> when using this option!</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">always</span></code>, the module will always regenerate the key. This is equivalent to setting <em>force</em> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Note that if <em>format_mismatch</em> is set to <code class="docutils literal notranslate"><span class="pre">convert</span></code> and everything matches except the format, the key will always be converted, except if <em>regenerate</em> is set to <code class="docutils literal notranslate"><span class="pre">always</span></code>.</p>
|
||||
<p>By default, the key will be regenerated when it does not match the module’s options, except when the key cannot be read or the passphrase does not match. Please note that this <strong>changed</strong> for Ansible 2.10. For Ansible 2.9, the behavior was as if <code class="ansible-value docutils literal notranslate"><span class="pre">full_idempotence</span></code> is specified.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">never</span></code>, the module will fail if the key cannot be read or the passphrase is not matching, and will never regenerate an existing key.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">fail</span></code>, the module will fail if the key does not correspond to the module’s options.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">partial_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. The key is <strong>not</strong> regenerated if it cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">full_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. This is also the case if the key cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified. Make sure you have a <strong>backup</strong> when using this option!</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">always</span></code>, the module will always regenerate the key. This is equivalent to setting <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-force"><span class="std std-ref"><span class="pre">force</span></span></a></strong></code> to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Note that if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-format-mismatch"><span class="std std-ref"><span class="pre">format_mismatch</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">convert</span></code> and everything matches except the format, the key will always be converted, except if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">always</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"never"</span></code></p></li>
|
||||
@@ -388,9 +390,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-return_content" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) private key’s content as <em>privatekey</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) private key’s content as <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-return-privatekey"><span class="std std-ref"><span class="pre">privatekey</span></span></a></code>.</p>
|
||||
<p>Note that especially if the private key is not encrypted, you have to make sure that the returned value is treated appropriately and not accidentally written to logs etc.! Use with care!</p>
|
||||
<p>Use Ansible’s <em>no_log</em> task option to avoid the output being shown. See also <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#how-do-i-keep-secret-data-in-my-playbook">https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#how-do-i-keep-secret-data-in-my-playbook</a>.</p>
|
||||
<p>Use Ansible’s <code class="docutils literal notranslate"><span class="pre">no_log</span></code> task option to avoid the output being shown. See also <a class="reference external" href="https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#how-do-i-keep-secret-data-in-my-playbook">https://docs.ansible.com/ansible/latest/reference_appendices/faq.html#how-do-i-keep-secret-data-in-my-playbook</a>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -403,8 +405,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -471,7 +473,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-type" 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 algorithm used to generate the TLS/SSL private key.</p>
|
||||
<p>Note that <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X448</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code> and <code class="docutils literal notranslate"><span class="pre">Ed448</span></code> require the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend. <code class="docutils literal notranslate"><span class="pre">X25519</span></code> needs cryptography 2.5 or newer, while <code class="docutils literal notranslate"><span class="pre">X448</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code> and <code class="docutils literal notranslate"><span class="pre">Ed448</span></code> require cryptography 2.6 or newer. For <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, the minimal cryptography version required depends on the <em>curve</em> option.</p>
|
||||
<p>Note that <code class="ansible-value docutils literal notranslate"><span class="pre">ECC</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">X448</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">Ed25519</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">Ed448</span></code> require the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend. <code class="ansible-value docutils literal notranslate"><span class="pre">X25519</span></code> needs cryptography 2.5 or newer, while <code class="ansible-value docutils literal notranslate"><span class="pre">X448</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">Ed25519</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">Ed448</span></code> require cryptography 2.6 or newer. For <code class="ansible-value docutils literal notranslate"><span class="pre">ECC</span></code>, the minimal cryptography version required depends on the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-curve"><span class="std std-ref"><span class="pre">curve</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"DSA"</span></code></p></li>
|
||||
@@ -609,7 +611,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/privatekey.pem.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -618,7 +620,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-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-cell"><p>Elliptic curve used to generate the TLS/SSL private key.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success, and <em>type</em> is <code class="docutils literal notranslate"><span class="pre">ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-type"><span class="std std-ref"><span class="pre">type</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">ECC</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"secp256r1"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -647,7 +649,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The (current or generated) private key’s content.</p>
|
||||
<p>Will be Base64-encoded if the key is in raw format.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and <em>return_content</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-module-parameter-return-content"><span class="std std-ref"><span class="pre">return_content</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_privatekey_pipe module – Generate OpenSSL private keys without disk access<a class="headerlink" href="#community-crypto-openssl-privatekey-pipe-module-generate-openssl-private-keys-without-disk-access" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-pipe-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -186,10 +188,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>Keys are generated in PEM format.</p></li>
|
||||
<li><p>Make sure to not write the result of this module into logs or to the console, as it contains private key data! Use the <em>no_log</em> task option to be sure.</p></li>
|
||||
<li><p>Make sure to not write the result of this module into logs or to the console, as it contains private key data! Use the <code class="docutils literal notranslate"><span class="pre">no_log</span></code> task option to be sure.</p></li>
|
||||
<li><p>Note that this module is implemented as an <a class="reference external" href="https://docs.ansible.com/ansible/latest/plugins/action.html">action plugin</a> and will always be executed on the controller.</p></li>
|
||||
<li><p>One can generate <a class="reference external" href="https://en.wikipedia.org/wiki/RSA_%28cryptosystem%29">RSA</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Digital_Signature_Algorithm">DSA</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Elliptic-curve_cryptography">ECC</a> or <a class="reference external" href="https://en.wikipedia.org/wiki/EdDSA">EdDSA</a> private keys.</p></li>
|
||||
<li><p>Please note that the module regenerates private keys if they do not match the module’s options. In particular, if you provide another passphrase (or specify none), change the keysize, etc., the private key will be regenerated. If you are concerned that this could <strong>overwrite your private key</strong>, consider using the <em>backup</em> option.</p></li>
|
||||
<li><p>One can generate <a class="reference external" href="https://en.wikipedia.org/wiki/RSA_%2528cryptosystem%2529">RSA</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Digital_Signature_Algorithm">DSA</a>, <a class="reference external" href="https://en.wikipedia.org/wiki/Elliptic-curve_cryptography">ECC</a> or <a class="reference external" href="https://en.wikipedia.org/wiki/EdDSA">EdDSA</a> private keys.</p></li>
|
||||
<li><p>This allows to read and write keys to vaults without having to write intermediate versions to disk.</p></li>
|
||||
<li><p>This module allows one to (re)generate OpenSSL private keys without disk access.</p></li>
|
||||
</ul>
|
||||
@@ -218,7 +219,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-cipher"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-cipher"><strong>cipher</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-cipher" 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 cipher to encrypt the private key. Must be <code class="docutils literal notranslate"><span class="pre">auto</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The cipher to encrypt the private key. Must be <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -233,7 +234,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-content_base64"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-content-base64"><strong>content_base64</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-content_base64" 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>Set to <code class="docutils literal notranslate"><span class="pre">true</span></code> if the content is base64 encoded.</p>
|
||||
<td><div class="ansible-option-cell"><p>Set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> if the content is base64 encoded.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -246,9 +247,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-curve" 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>Note that not all curves are supported by all versions of <code class="docutils literal notranslate"><span class="pre">cryptography</span></code>.</p>
|
||||
<p>For maximal interoperability, <code class="docutils literal notranslate"><span class="pre">secp384r1</span></code> or <code class="docutils literal notranslate"><span class="pre">secp256r1</span></code> should be used.</p>
|
||||
<p>For maximal interoperability, <code class="ansible-value docutils literal notranslate"><span class="pre">secp384r1</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">secp256r1</span></code> should be used.</p>
|
||||
<p>We use the curve names as defined in the <a class="reference external" href="https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-8">IANA registry for TLS</a>.</p>
|
||||
<p>Please note that all curves except <code class="docutils literal notranslate"><span class="pre">secp224r1</span></code>, <code class="docutils literal notranslate"><span class="pre">secp256k1</span></code>, <code class="docutils literal notranslate"><span class="pre">secp256r1</span></code>, <code class="docutils literal notranslate"><span class="pre">secp384r1</span></code> and <code class="docutils literal notranslate"><span class="pre">secp521r1</span></code> are discouraged for new private keys.</p>
|
||||
<p>Please note that all curves except <code class="ansible-value docutils literal notranslate"><span class="pre">secp224r1</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">secp256k1</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">secp256r1</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">secp384r1</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">secp521r1</span></code> are discouraged for new private keys.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"secp224r1"</span></code></p></li>
|
||||
@@ -278,8 +279,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-format" 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 format the private key is written in. By default, PKCS1 (traditional OpenSSL format) is used for all keys which support it. Please note that not every key can be exported in any format.</p>
|
||||
<p>The value <code class="docutils literal notranslate"><span class="pre">auto</span></code> selects a format based on the key format. The value <code class="docutils literal notranslate"><span class="pre">auto_ignore</span></code> does the same, but for existing private key files, it will not force a regenerate when its format is not the automatically selected one for generation.</p>
|
||||
<p>Note that if the format for an existing private key mismatches, the key is <strong>regenerated</strong> by default. To change this behavior, use the <em>format_mismatch</em> option.</p>
|
||||
<p>The value <code class="ansible-value docutils literal notranslate"><span class="pre">auto</span></code> selects a format based on the key format. The value <code class="ansible-value docutils literal notranslate"><span class="pre">auto_ignore</span></code> does the same, but for existing private key files, it will not force a regenerate when its format is not the automatically selected one for generation.</p>
|
||||
<p>Note that if the format for an existing private key mismatches, the key is <strong>regenerated</strong> by default. To change this behavior, use the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-format-mismatch"><span class="std std-ref"><span class="pre">format_mismatch</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"pkcs1"</span></code></p></li>
|
||||
@@ -295,8 +296,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-format_mismatch" 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 behavior of the module if the format of a private key does not match the expected format, but all other parameters are as expected.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">regenerate</span></code> (default), generates a new private key.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">convert</span></code>, the key will be converted to the new format instead.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">regenerate</span></code> (default), generates a new private key.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">convert</span></code>, the key will be converted to the new format instead.</p>
|
||||
<p>Only supported by the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -317,13 +318,13 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-regenerate" 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>Allows to configure in which situations the module is allowed to regenerate private keys. The module will always generate a new key if the destination file does not exist.</p>
|
||||
<p>By default, the key will be regenerated when it does not match the module’s options, except when the key cannot be read or the passphrase does not match. Please note that this <strong>changed</strong> for Ansible 2.10. For Ansible 2.9, the behavior was as if <code class="docutils literal notranslate"><span class="pre">full_idempotence</span></code> is specified.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">never</span></code>, the module will fail if the key cannot be read or the passphrase is not matching, and will never regenerate an existing key.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">fail</span></code>, the module will fail if the key does not correspond to the module’s options.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">partial_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. The key is <strong>not</strong> regenerated if it cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">full_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. This is also the case if the key cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified. Make sure you have a <strong>backup</strong> when using this option!</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">always</span></code>, the module will always regenerate the key. This is equivalent to setting <em>force</em> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Note that if <em>format_mismatch</em> is set to <code class="docutils literal notranslate"><span class="pre">convert</span></code> and everything matches except the format, the key will always be converted, except if <em>regenerate</em> is set to <code class="docutils literal notranslate"><span class="pre">always</span></code>.</p>
|
||||
<p>By default, the key will be regenerated when it does not match the module’s options, except when the key cannot be read or the passphrase does not match. Please note that this <strong>changed</strong> for Ansible 2.10. For Ansible 2.9, the behavior was as if <code class="ansible-value docutils literal notranslate"><span class="pre">full_idempotence</span></code> is specified.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">never</span></code>, the module will fail if the key cannot be read or the passphrase is not matching, and will never regenerate an existing key.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">fail</span></code>, the module will fail if the key does not correspond to the module’s options.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">partial_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. The key is <strong>not</strong> regenerated if it cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">full_idempotence</span></code>, the key will be regenerated if it does not conform to the module’s options. This is also the case if the key cannot be read (broken file), the key is protected by an unknown passphrase, or when they key is not protected by a passphrase, but a passphrase is specified. Make sure you have a <strong>backup</strong> when using this option!</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">always</span></code>, the module will always regenerate the key.</p>
|
||||
<p>Note that if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-format-mismatch"><span class="std std-ref"><span class="pre">format_mismatch</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">convert</span></code> and everything matches except the format, the key will always be converted, except if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-regenerate"><span class="std std-ref"><span class="pre">regenerate</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">always</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"never"</span></code></p></li>
|
||||
@@ -338,8 +339,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<div class="ansibleOptionAnchor" id="parameter-return_current_key"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-return-current-key"><strong>return_current_key</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-return_current_key" 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>Set to <code class="docutils literal notranslate"><span class="pre">true</span></code> to return the current private key when the module did not generate a new one.</p>
|
||||
<p>Note that in case of check mode, when this option is not set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, the module always returns the current key (if it was provided) and Ansible will replace it by <code class="docutils literal notranslate"><span class="pre">VALUE_SPECIFIED_IN_NO_LOG_PARAMETER</span></code>.</p>
|
||||
<td><div class="ansible-option-cell"><p>Set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> to return the current private key when the module did not generate a new one.</p>
|
||||
<p>Note that in case of check mode, when this option is not set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, the module always returns the current key (if it was provided) and Ansible will replace it by <code class="docutils literal notranslate"><span class="pre">VALUE_SPECIFIED_IN_NO_LOG_PARAMETER</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -352,8 +353,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -374,7 +375,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-type" 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 algorithm used to generate the TLS/SSL private key.</p>
|
||||
<p>Note that <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X448</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code> and <code class="docutils literal notranslate"><span class="pre">Ed448</span></code> require the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend. <code class="docutils literal notranslate"><span class="pre">X25519</span></code> needs cryptography 2.5 or newer, while <code class="docutils literal notranslate"><span class="pre">X448</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code> and <code class="docutils literal notranslate"><span class="pre">Ed448</span></code> require cryptography 2.6 or newer. For <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, the minimal cryptography version required depends on the <em>curve</em> option.</p>
|
||||
<p>Note that <code class="ansible-value docutils literal notranslate"><span class="pre">ECC</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">X448</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">Ed25519</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">Ed448</span></code> require the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend. <code class="ansible-value docutils literal notranslate"><span class="pre">X25519</span></code> needs cryptography 2.5 or newer, while <code class="ansible-value docutils literal notranslate"><span class="pre">X448</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">Ed25519</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">Ed448</span></code> require cryptography 2.6 or newer. For <code class="ansible-value docutils literal notranslate"><span class="pre">ECC</span></code>, the minimal cryptography version required depends on the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-curve"><span class="std std-ref"><span class="pre">curve</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"DSA"</span></code></p></li>
|
||||
@@ -466,15 +467,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Examples</a><a class="headerlink" href="#examples" title="Permalink 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_pipe</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">output</span>
|
||||
<span class="w"> </span><span class="nt">no_log</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># make sure that private key data is not accidentally revealed in logs!</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">Show generated key</span>
|
||||
<span class="w"> </span><span class="nt">debug</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.debug</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">msg</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">output.privatekey</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
<span class="w"> </span><span class="c1"># DO NOT OUTPUT KEY MATERIAL TO CONSOLE OR LOGS IN PRODUCTION!</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">block</span><span class="p">:</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 or update a Mozilla sops encrypted key</span>
|
||||
<span class="w"> </span><span class="nt">block</span><span class="p">:</span>
|
||||
<span class="w"> </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">Update sops-encrypted key with the community.sops collection</span>
|
||||
<span class="w"> </span><span class="nt">community.crypto.openssl_privatekey_pipe</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">content</span><span class="p">:</span><span class="w"> </span><span class="s">"</span><span class="cp">{{</span> <span class="nv">lookup</span><span class="o">(</span><span class="s1">'community.sops.sops'</span><span class="o">,</span> <span class="s1">'private_key.pem.sops'</span><span class="o">)</span> <span class="cp">}}</span><span class="s">"</span>
|
||||
@@ -489,7 +491,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<span class="w"> </span><span class="nt">when</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">output is changed</span>
|
||||
<span class="w"> </span><span class="nt">always</span><span class="p">:</span>
|
||||
<span class="w"> </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">Make sure that output (which contains the private key) is overwritten</span>
|
||||
<span class="w"> </span><span class="nt">set_fact</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.set_fact</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">output</span><span class="p">:</span><span class="w"> </span><span class="s">''</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
@@ -509,7 +511,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-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-cell"><p>Elliptic curve used to generate the TLS/SSL private key.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success, and <em>type</em> is <code class="docutils literal notranslate"><span class="pre">ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success, and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-type"><span class="std std-ref"><span class="pre">type</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">ECC</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"secp256r1"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -527,9 +529,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-privatekey" 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 generated private key’s content.</p>
|
||||
<p>Please note that if the result is not changed, the current private key will only be returned if the <em>return_current_key</em> option is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Please note that if the result is not changed, the current private key will only be returned if the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-return-current-key"><span class="std std-ref"><span class="pre">return_current_key</span></span></a></strong></code> option is set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Will be Base64-encoded if the key is in raw format.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed, or <em>return_current_key</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed, or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-privatekey-pipe-module-parameter-return-current-key"><span class="std std-ref"><span class="pre">return_current_key</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -162,7 +164,7 @@
|
||||
<h1>community.crypto.openssl_publickey_info filter – Retrieve information from OpenSSL public keys in PEM format<a class="headerlink" href="#community-crypto-openssl-publickey-info-filter-retrieve-information-from-openssl-public-keys-in-pem-format" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.crypto.openssl_publickey_info</span></code>.</p>
|
||||
</div>
|
||||
@@ -267,7 +269,7 @@
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>The curve’s name for ECC.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -275,7 +277,7 @@
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s public exponent.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -283,7 +285,7 @@
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -292,7 +294,7 @@
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -300,7 +302,7 @@
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s modulus.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -309,7 +311,7 @@
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -318,7 +320,7 @@
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -326,7 +328,7 @@
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>Bit size of modulus (RSA) or prime number (DSA).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code> or <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -334,16 +336,16 @@
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-_value/public_data/y"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-public-data-y"><strong>y</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>For <code class="docutils literal notranslate"><span class="pre">type=ECC</span></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="docutils literal notranslate"><span class="pre">type=DSA</span></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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code> or <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<td><div class="ansible-option-indent-desc"></div><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-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.type=DSA</span></span></a></code>, this is the publicly known group element whose discrete logarithm with respect to <code class="docutils literal notranslate"><span class="pre">g</span></code> is the private key.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.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-publickey-info-filter-return-value-type"><span class="std std-ref"><span class="pre">_value.type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -351,8 +353,8 @@
|
||||
<a class="ansibleOptionLink" href="#return-_value/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-indent-desc"></div><div class="ansible-option-cell"><p>The key’s type.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="docutils literal notranslate"><span class="pre">X448</span></code>.</p>
|
||||
<p>Will start with <code class="docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_publickey_info module – Provide information for OpenSSL public keys<a class="headerlink" href="#community-crypto-openssl-publickey-info-module-provide-information-for-openssl-public-keys" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-publickey-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -210,7 +212,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the public key file.</p>
|
||||
<p>Either <em>path</em> or <em>content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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-publickey-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-odd"><td><div class="ansible-option-cell">
|
||||
@@ -225,8 +227,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -277,7 +279,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="openssl_privatekey_info_module.html#ansible-collections-community-crypto-openssl-privatekey-info-module"><span class="std std-ref">community.crypto.openssl_privatekey_info</span></a></dt><dd><p>Provide information for OpenSSL private keys.</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="openssl_publickey_info_filter.html#ansible-collections-community-crypto-openssl-publickey-info-filter"><span class="std std-ref">community.crypto.openssl_publickey_info filter</span></a></dt><dd><p>A filter variant of this module.</p>
|
||||
<dt><a class="reference internal" href="openssl_publickey_info_filter.html#ansible-collections-community-crypto-openssl-publickey-info-filter"><span class="std std-ref">community.crypto.openssl_publickey_info</span></a> filter plugin</dt><dd><p>A filter variant of this module.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
@@ -337,7 +339,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -345,7 +347,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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">
|
||||
@@ -353,7 +355,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -362,7 +364,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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">
|
||||
@@ -370,7 +372,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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">
|
||||
@@ -379,7 +381,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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">
|
||||
@@ -388,7 +390,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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">
|
||||
@@ -396,7 +398,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=RSA</span></code> or <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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-publickey-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">
|
||||
@@ -404,16 +406,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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-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-publickey-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="docutils literal notranslate"><span class="pre">type=ECC</span></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="docutils literal notranslate"><span class="pre">type=DSA</span></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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">type=DSA</span></code> or <code class="docutils literal notranslate"><span class="pre">type=ECC</span></code></p>
|
||||
<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-publickey-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-publickey-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-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-publickey-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-cell">
|
||||
@@ -421,8 +423,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="docutils literal notranslate"><span class="pre">X448</span></code>.</p>
|
||||
<p>Will start with <code class="docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.openssl_publickey module – Generate an OpenSSL public key from its private key.<a class="headerlink" href="#community-crypto-openssl-publickey-module-generate-an-openssl-public-key-from-its-private-key" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-publickey-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -194,7 +196,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>cryptography >= 1.2.3 (older versions might work as well)</p></li>
|
||||
<li><p>Needs cryptography >= 1.4 if <em>format</em> is <code class="docutils literal notranslate"><span class="pre">OpenSSH</span></code></p></li>
|
||||
<li><p>Needs cryptography >= 1.4 if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-format"><span class="std std-ref"><span class="pre">format</span></span></a></strong></code> is <code class="docutils literal notranslate"><span class="pre">OpenSSH</span></code></p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
@@ -297,7 +299,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The content of the TLS/SSL private key from which to generate the public key.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified, but not both. If <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, one of them is required.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_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-publickey-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code> must be specified, but not both. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>, one of them is required.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -312,7 +314,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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>Path to the TLS/SSL private key from which to generate the public key.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified, but not both. If <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, one of them is required.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_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-publickey-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code> must be specified, but not both. If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>, one of them is required.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -320,7 +322,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-return_content" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) public key’s content as <em>publickey</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) public key’s content as <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-return-publickey"><span class="std std-ref"><span class="pre">publickey</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -333,8 +335,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -519,7 +521,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/publickey.pem.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -555,7 +557,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#return-privatekey" 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>Path to the TLS/SSL private key the public key was generated from.</p>
|
||||
<p>Will be <code class="docutils literal notranslate"><span class="pre">none</span></code> if the private key has been provided in <em>privatekey_content</em>.</p>
|
||||
<p>Will be <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the private key has been provided in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed or success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/etc/ssl/private/ansible.com.pem"</span></code></p>
|
||||
</div></td>
|
||||
@@ -566,7 +568,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The (current or generated) public key’s content.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and <em>return_content</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-publickey-module-parameter-return-content"><span class="std std-ref"><span class="pre">return_content</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.openssl_signature_info module – Verify signatures with openssl<a class="headerlink" href="#community-crypto-openssl-signature-info-module-verify-signatures-with-openssl" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-signature-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -212,7 +214,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-certificate_content" 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 content of the certificate used to verify the signature.</p>
|
||||
<p>Either <em>certificate_path</em> or <em>certificate_content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-signature-info-module-parameter-certificate-path"><span class="std std-ref"><span class="pre">certificate_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-signature-info-module-parameter-certificate-content"><span class="std std-ref"><span class="pre">certificate_content</span></span></a></strong></code> must be specified, but not both.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -220,7 +222,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-certificate_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>The path to the certificate used to verify the signature.</p>
|
||||
<p>Either <em>certificate_path</em> or <em>certificate_content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-signature-info-module-parameter-certificate-path"><span class="std std-ref"><span class="pre">certificate_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-signature-info-module-parameter-certificate-content"><span class="std std-ref"><span class="pre">certificate_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">
|
||||
@@ -236,8 +238,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -326,7 +328,7 @@ ed448 and ed25519 keys: <code class="docutils literal notranslate"><span class="
|
||||
<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">verify</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">Make sure the signature is valid</span>
|
||||
<span class="w"> </span><span class="nt">assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">that</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">verify.valid</span>
|
||||
</pre></div>
|
||||
@@ -346,7 +348,7 @@ ed448 and ed25519 keys: <code class="docutils literal notranslate"><span class="
|
||||
<div class="ansibleOptionAnchor" id="return-valid"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-openssl-signature-info-module-return-valid"><strong>valid</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-valid" 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><code class="docutils literal notranslate"><span class="pre">true</span></code> means the signature was valid for the given file, <code class="docutils literal notranslate"><span class="pre">false</span></code> means it was not.</p>
|
||||
<td><div class="ansible-option-cell"><p><code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> means the signature was valid for the given file, <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code> means it was not.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.openssl_signature module – Sign data with openssl<a class="headerlink" href="#community-crypto-openssl-signature-module-sign-data-with-openssl" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-signature-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -220,7 +222,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_content" 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 content of the private key to use when signing the certificate signing request.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-signature-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_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-signature-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_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">
|
||||
@@ -236,7 +238,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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>The path to the private key to use when signing.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-openssl-signature-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_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-signature-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_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">
|
||||
@@ -244,8 +246,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-op
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -326,7 +328,7 @@ ed448 and ed25519 keys: <code class="docutils literal notranslate"><span class="
|
||||
<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">verify</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">Make sure the signature is valid</span>
|
||||
<span class="w"> </span><span class="nt">assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">that</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">verify.valid</span>
|
||||
</pre></div>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -161,7 +163,7 @@
|
||||
<h1>community.crypto.split_pem filter – Split PEM file contents into multiple objects<a class="headerlink" href="#community-crypto-split-pem-filter-split-pem-file-contents-into-multiple-objects" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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>.</p>
|
||||
<p>To use it in a playbook, specify: <code class="code docutils literal notranslate"><span class="pre">community.crypto.split_pem</span></code>.</p>
|
||||
</div>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.x509_certificate_info filter – Retrieve information from X.509 certificates in PEM format<a class="headerlink" href="#community-crypto-x509-certificate-info-filter-retrieve-information-from-x-509-certificates-in-pem-format" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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 filter plugin,
|
||||
see <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -193,7 +195,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<span id="ansible-collections-community-crypto-x509-certificate-info-filter-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the local controller node that executes this filter.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If <em>name_encoding</em> is set to another value than <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> is set to another value than <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="input">
|
||||
@@ -232,10 +234,10 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#parameter-name_encoding" 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>How to encode names (DNS names, URIs, email addresses) in return values.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="docutils literal notranslate"><span class="pre">idna</span></code> and <code class="docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -293,8 +295,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/authority_cert_issuer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The certificate’s authority cert issuer as a list of general names.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:www.ansible.com",</span> <span class="pre">"IP:1.2.3.4"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -304,7 +306,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/authority_cert_serial_number" 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 certificate’s authority cert serial number.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">12345</span></code></p>
|
||||
</div></td>
|
||||
@@ -314,8 +316,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/authority_key_identifier" 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 certificate’s authority key identifier.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"</span></code></p>
|
||||
</div></td>
|
||||
@@ -324,7 +326,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/basic_constraints"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-filter-return-value-basic-constraints"><strong>basic_constraints</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/basic_constraints" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">basic_constraints</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">basic_constraints</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["CA:TRUE",</span> <span class="pre">"pathlen:1"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -349,7 +351,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/extended_key_usage"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-filter-return-value-extended-key-usage"><strong>extended_key_usage</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/extended_key_usage" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">extended_key_usage</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">extended_key_usage</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["Biometric</span> <span class="pre">Info",</span> <span class="pre">"DVCS",</span> <span class="pre">"Time</span> <span class="pre">Stamping"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -422,7 +424,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/issuer_uri"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-filter-return-value-issuer-uri"><strong>issuer_uri</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/issuer_uri" 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 Issuer URI, if included in the certificate. Will be <code class="docutils literal notranslate"><span class="pre">none</span></code> if no issuer URI is included.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The Issuer URI, if included in the certificate. Will be <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if no issuer URI is included.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -430,7 +432,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/key_usage"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-filter-return-value-key-usage"><strong>key_usage</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/key_usage" 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>Entries in the <code class="docutils literal notranslate"><span class="pre">key_usage</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">key_usage</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"['Key</span> <span class="pre">Agreement',</span> <span class="pre">'Data</span> <span class="pre">Encipherment']"</span></code></p>
|
||||
</div></td>
|
||||
@@ -465,7 +467,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/ocsp_must_staple"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-filter-return-value-ocsp-must-staple"><strong>ocsp_must_staple</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/ocsp_must_staple" 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-indent-desc"></div><div class="ansible-option-cell"><p><code class="docutils literal notranslate"><span class="pre">true</span></code> if the OCSP Must Staple extension is present, <code class="docutils literal notranslate"><span class="pre">none</span></code> otherwise.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p><code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> if the OCSP Must Staple extension is present, <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> otherwise.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -481,7 +483,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/ocsp_uri"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-filter-return-value-ocsp-uri"><strong>ocsp_uri</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/ocsp_uri" 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 OCSP responder URI, if included in the certificate. Will be <code class="docutils literal notranslate"><span class="pre">none</span></code> if no OCSP responder URI is included.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The OCSP responder URI, if included in the certificate. Will be <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if no OCSP responder URI is included.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -507,7 +509,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>The curve’s name for ECC.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -515,7 +517,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s public exponent.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -523,7 +525,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -532,7 +534,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -540,7 +542,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>The RSA key’s modulus.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -549,7 +551,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -558,7 +560,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -566,7 +568,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>Bit size of modulus (RSA) or prime number (DSA).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code> or <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_type=RSA</span></span></a></code> or <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
@@ -574,16 +576,16 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-indent"></div><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="return-_value/public_key_data/y"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-data-y"><strong>y</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>For <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></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="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code> or <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<td><div class="ansible-option-indent-desc"></div><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-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_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-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_type=DSA</span></span></a></code>, this is the publicly known group element whose discrete logarithm with respect to <code class="docutils literal notranslate"><span class="pre">g</span></code> is the private key.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_type=DSA</span></span></a></code> or <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-return-value-public-key-type"><span class="std std-ref"><span class="pre">_value.public_key_type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -601,8 +603,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/public_key_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-indent-desc"></div><div class="ansible-option-cell"><p>The certificate’s public key’s type.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="docutils literal notranslate"><span class="pre">X448</span></code>.</p>
|
||||
<p>Will start with <code class="docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
||||
</div></td>
|
||||
@@ -639,8 +641,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/subject_alt_name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-filter-return-value-subject-alt-name"><strong>subject_alt_name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/subject_alt_name" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:www.ansible.com",</span> <span class="pre">"IP:1.2.3.4"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -658,8 +660,8 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/subject_key_identifier" 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 certificate’s subject key identifier.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">SubjectKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">SubjectKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"</span></code></p>
|
||||
</div></td>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.x509_certificate_info module – Provide information of OpenSSL X.509 certificates<a class="headerlink" href="#community-crypto-x509-certificate-info-module-provide-information-of-openssl-x-509-certificates" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-x509-certificate-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -188,14 +190,14 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<ul class="simple">
|
||||
<li><p>This module allows one to query information on OpenSSL certificates.</p></li>
|
||||
<li><p>It uses the cryptography python library to interact with OpenSSL.</p></li>
|
||||
<li><p>Note that this module was called <code class="docutils literal notranslate"><span class="pre">openssl_certificate_info</span></code> when included directly in Ansible up to version 2.9. When moved to the collection <code class="docutils literal notranslate"><span class="pre">community.crypto</span></code>, it was renamed to <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module"><span class="std std-ref">community.crypto.x509_certificate_info</span></a>. From Ansible 2.10 on, it can still be used by the old short name (or by <code class="docutils literal notranslate"><span class="pre">ansible.builtin.openssl_certificate_info</span></code>), which redirects to <code class="docutils literal notranslate"><span class="pre">community.crypto.x509_certificate_info</span></code>. When using FQCNs or when using the <a class="reference external" href="https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-a-playbook">collections</a> keyword, the new name <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module"><span class="std std-ref">community.crypto.x509_certificate_info</span></a> should be used to avoid a deprecation warning.</p></li>
|
||||
<li><p>Note that this module was called <code class="docutils literal notranslate"><span class="pre">openssl_certificate_info</span></code> when included directly in Ansible up to version 2.9. When moved to the collection <code class="docutils literal notranslate"><span class="pre">community.crypto</span></code>, it was renamed to <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module"><span class="std std-ref">community.crypto.x509_certificate_info</span></a>. From Ansible 2.10 on, it can still be used by the old short name (or by <code class="docutils literal notranslate"><span class="pre">ansible.builtin.openssl_certificate_info</span></code>), which redirects to <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module"><span class="std std-ref">community.crypto.x509_certificate_info</span></a>. When using FQCNs or when using the <a class="reference external" href="https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-a-playbook">collections</a> keyword, the new name <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module"><span class="std std-ref">community.crypto.x509_certificate_info</span></a> should be used to avoid a deprecation warning.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="requirements">
|
||||
<span id="ansible-collections-community-crypto-x509-certificate-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If <em>name_encoding</em> is set to another value than <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> is set to another value than <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>cryptography >= 1.6</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -214,7 +216,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the X.509 certificate in PEM format.</p>
|
||||
<p>Either <em>path</em> or <em>content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-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-x509-certificate-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-odd"><td><div class="ansible-option-cell">
|
||||
@@ -222,10 +224,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-name_encoding" 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>How to encode names (DNS names, URIs, email addresses) in return values.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="docutils literal notranslate"><span class="pre">idna</span></code> and <code class="docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -239,7 +241,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<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 certificate file is loaded from.</p>
|
||||
<p>Either <em>path</em> or <em>content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-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-x509-certificate-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>
|
||||
<p>PEM and DER formats are supported.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -247,8 +250,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -260,10 +263,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-valid_at"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-parameter-valid-at"><strong>valid_at</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-valid_at" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A dict of names mapping to time specifications. Every time specified here will be checked whether the certificate is valid at this point. See the <code class="docutils literal notranslate"><span class="pre">valid_at</span></code> return value for informations on the result.</p>
|
||||
<td><div class="ansible-option-cell"><p>A dict of names mapping to time specifications. Every time specified here will be checked whether the certificate is valid at this point. See the <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-valid-at"><span class="std std-ref"><span class="pre">valid_at</span></span></a></code> return value for informations on the result.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>), and ASN.1 TIME (in other words, pattern <code class="docutils literal notranslate"><span class="pre">YYYYMMDDHHMMSSZ</span></code>). Note that all timestamps will be treated as being in UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>), and ASN.1 TIME (in other words, pattern <code class="docutils literal notranslate"><span class="pre">YYYYMMDDHHMMSSZ</span></code>). Note that all timestamps will be treated as being in UTC.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@@ -318,7 +321,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="x509_certificate_pipe_module.html#ansible-collections-community-crypto-x509-certificate-pipe-module"><span class="std std-ref">community.crypto.x509_certificate_pipe</span></a></dt><dd><p>Generate and/or check OpenSSL certificates.</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="x509_certificate_info_filter.html#ansible-collections-community-crypto-x509-certificate-info-filter"><span class="std std-ref">community.crypto.x509_certificate_info filter</span></a></dt><dd><p>A filter variant of this module.</p>
|
||||
<dt><a class="reference internal" href="x509_certificate_info_filter.html#ansible-collections-community-crypto-x509-certificate-info-filter"><span class="std std-ref">community.crypto.x509_certificate_info</span></a> filter plugin</dt><dd><p>A filter variant of this module.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
@@ -359,7 +362,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<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">Validate that certificate is valid tomorrow, but not in three weeks</span>
|
||||
<span class="w"> </span><span class="nt">assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">that</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result.valid_at.point_1</span><span class="w"> </span><span class="c1"># valid in one day</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">not result.valid_at.point_2</span><span class="w"> </span><span class="c1"># not valid in three weeks</span>
|
||||
@@ -381,8 +384,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-authority_cert_issuer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The certificate’s authority cert issuer as a list of general names.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:www.ansible.com",</span> <span class="pre">"IP:1.2.3.4"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -392,7 +395,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-authority_cert_serial_number" 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-cell"><p>The certificate’s authority cert serial number.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">12345</span></code></p>
|
||||
</div></td>
|
||||
@@ -402,8 +405,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-authority_key_identifier" 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 certificate’s authority key identifier.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">AuthorityKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"</span></code></p>
|
||||
</div></td>
|
||||
@@ -412,7 +415,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-basic_constraints"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-return-basic-constraints"><strong>basic_constraints</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-basic_constraints" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">basic_constraints</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">basic_constraints</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["CA:TRUE",</span> <span class="pre">"pathlen:1"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -437,7 +440,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-extended_key_usage"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-return-extended-key-usage"><strong>extended_key_usage</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-extended_key_usage" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">extended_key_usage</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">extended_key_usage</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["Biometric</span> <span class="pre">Info",</span> <span class="pre">"DVCS",</span> <span class="pre">"Time</span> <span class="pre">Stamping"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -512,7 +515,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-issuer_uri" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.9.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The Issuer URI, if included in the certificate. Will be <code class="docutils literal notranslate"><span class="pre">none</span></code> if no issuer URI is included.</p>
|
||||
<td><div class="ansible-option-cell"><p>The Issuer URI, if included in the certificate. Will be <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if no issuer URI is included.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -520,7 +523,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-key_usage"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-return-key-usage"><strong>key_usage</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-key_usage" 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>Entries in the <code class="docutils literal notranslate"><span class="pre">key_usage</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">key_usage</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"['Key</span> <span class="pre">Agreement',</span> <span class="pre">'Data</span> <span class="pre">Encipherment']"</span></code></p>
|
||||
</div></td>
|
||||
@@ -555,7 +558,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-ocsp_must_staple"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-return-ocsp-must-staple"><strong>ocsp_must_staple</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-ocsp_must_staple" 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><code class="docutils literal notranslate"><span class="pre">true</span></code> if the OCSP Must Staple extension is present, <code class="docutils literal notranslate"><span class="pre">none</span></code> otherwise.</p>
|
||||
<td><div class="ansible-option-cell"><p><code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> if the OCSP Must Staple extension is present, <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> otherwise.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -571,7 +574,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-ocsp_uri"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-return-ocsp-uri"><strong>ocsp_uri</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-ocsp_uri" 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 OCSP responder URI, if included in the certificate. Will be <code class="docutils literal notranslate"><span class="pre">none</span></code> if no OCSP responder URI is included.</p>
|
||||
<td><div class="ansible-option-cell"><p>The OCSP responder URI, if included in the certificate. Will be <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if no OCSP responder URI is included.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -598,7 +601,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -606,7 +609,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -614,7 +617,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -623,7 +626,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -631,7 +634,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -640,7 +643,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -649,7 +652,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -657,7 +660,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=RSA</span></code> or <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_type=RSA</span></span></a></code> or <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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">
|
||||
@@ -665,16 +668,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_type=ECC</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_key_data/y"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-data-y"><strong>y</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-public_key_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="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></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="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="docutils literal notranslate"><span class="pre">public_key_type=DSA</span></code> or <code class="docutils literal notranslate"><span class="pre">public_key_type=ECC</span></code></p>
|
||||
<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-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_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"><span class="ansible-option-returned-bold">Returned:</span> When <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_type=DSA</span></span></a></code> or <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-return-public-key-type"><span class="std std-ref"><span class="pre">public_key_type=ECC</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -693,8 +696,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.7.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The certificate’s public key’s type.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">RSA</span></code>, <code class="docutils literal notranslate"><span class="pre">DSA</span></code>, <code class="docutils literal notranslate"><span class="pre">ECC</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed25519</span></code>, <code class="docutils literal notranslate"><span class="pre">X25519</span></code>, <code class="docutils literal notranslate"><span class="pre">Ed448</span></code>, or <code class="docutils literal notranslate"><span class="pre">X448</span></code>.</p>
|
||||
<p>Will start with <code class="docutils literal notranslate"><span class="pre">unknown</span></code> if the key type cannot be determined.</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"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"RSA"</span></code></p>
|
||||
</div></td>
|
||||
@@ -731,8 +734,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-subject_alt_name"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-return-subject-alt-name"><strong>subject_alt_name</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-subject_alt_name" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> extension, or <code class="docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<td><div class="ansible-option-cell"><p>Entries in the <code class="docutils literal notranslate"><span class="pre">subject_alt_name</span></code> extension, or <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if extension is not present.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:www.ansible.com",</span> <span class="pre">"IP:1.2.3.4"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -750,8 +753,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-subject_key_identifier" 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 certificate’s subject key identifier.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">SubjectKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p>The identifier is returned in hexadecimal, with <code class="ansible-value docutils literal notranslate"><span class="pre">:</span></code> used to separate bytes.</p>
|
||||
<p>Is <code class="ansible-value docutils literal notranslate"><span class="pre">none</span></code> if the <code class="docutils literal notranslate"><span class="pre">SubjectKeyIdentifier</span></code> extension is not present.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"00:11:22:33:44:55:66:77:88:99:aa:bb:cc:dd:ee:ff:00:11:22:33"</span></code></p>
|
||||
</div></td>
|
||||
@@ -769,7 +772,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-valid_at"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-info-module-return-valid-at"><strong>valid_at</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-valid_at" 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>For every time stamp provided in the <em>valid_at</em> option, a boolean whether the certificate is valid at that point in time or not.</p>
|
||||
<td><div class="ansible-option-cell"><p>For every time stamp provided in the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-info-module-parameter-valid-at"><span class="std std-ref"><span class="pre">valid_at</span></span></a></strong></code> option, a boolean whether the certificate is valid at that point in time or not.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.x509_certificate module – Generate and/or check OpenSSL certificates<a class="headerlink" href="#community-crypto-x509-certificate-module-generate-and-or-check-openssl-certificates" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-x509-certificate-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -186,11 +188,11 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>It implements a notion of provider (one of <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code>, <code class="docutils literal notranslate"><span class="pre">ownca</span></code>, <code class="docutils literal notranslate"><span class="pre">acme</span></code>, and <code class="docutils literal notranslate"><span class="pre">entrust</span></code>) for your certificate.</p></li>
|
||||
<li><p>It implements a notion of provider (one of <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">acme</span></code>, and <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>) for your certificate.</p></li>
|
||||
<li><p>It uses the cryptography python library to interact with OpenSSL.</p></li>
|
||||
<li><p>Note that this module was called <code class="docutils literal notranslate"><span class="pre">openssl_certificate</span></code> when included directly in Ansible up to version 2.9. When moved to the collection <code class="docutils literal notranslate"><span class="pre">community.crypto</span></code>, it was renamed to <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a>. From Ansible 2.10 on, it can still be used by the old short name (or by <code class="docutils literal notranslate"><span class="pre">ansible.builtin.openssl_certificate</span></code>), which redirects to <code class="docutils literal notranslate"><span class="pre">community.crypto.x509_certificate</span></code>. When using FQCNs or when using the <a class="reference external" href="https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-a-playbook">collections</a> keyword, the new name <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a> should be used to avoid a deprecation warning.</p></li>
|
||||
<li><p>Please note that the module regenerates existing certificate if it does not match the module’s options, or if it seems to be corrupt. If you are concerned that this could overwrite your existing certificate, consider using the <em>backup</em> option.</p></li>
|
||||
<li><p>The <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider is intended for generating an OpenSSL certificate signed with your own CA (Certificate Authority) certificate (self-signed certificate).</p></li>
|
||||
<li><p>Note that this module was called <code class="docutils literal notranslate"><span class="pre">openssl_certificate</span></code> when included directly in Ansible up to version 2.9. When moved to the collection <code class="docutils literal notranslate"><span class="pre">community.crypto</span></code>, it was renamed to <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a>. From Ansible 2.10 on, it can still be used by the old short name (or by <code class="docutils literal notranslate"><span class="pre">ansible.builtin.openssl_certificate</span></code>), which redirects to <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a>. When using FQCNs or when using the <a class="reference external" href="https://docs.ansible.com/ansible/latest/user_guide/collections_using.html#using-collections-in-a-playbook">collections</a> keyword, the new name <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a> should be used to avoid a deprecation warning.</p></li>
|
||||
<li><p>Please note that the module regenerates existing certificate if it does not match the module’s options, or if it seems to be corrupt. If you are concerned that this could overwrite your existing certificate, consider using the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> option.</p></li>
|
||||
<li><p>The <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider is intended for generating an OpenSSL certificate signed with your own CA (Certificate Authority) certificate (self-signed certificate).</p></li>
|
||||
<li><p>This module allows one to (re)generate OpenSSL certificates.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -198,8 +200,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<span id="ansible-collections-community-crypto-x509-certificate-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>acme-tiny >= 4.0.0 (if using the <code class="docutils literal notranslate"><span class="pre">acme</span></code> provider)</p></li>
|
||||
<li><p>cryptography >= 1.6 (if using <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> or <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider)</p></li>
|
||||
<li><p>acme-tiny >= 4.0.0 (if using the <code class="ansible-value docutils literal notranslate"><span class="pre">acme</span></code> provider)</p></li>
|
||||
<li><p>cryptography >= 1.6 (if using <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider)</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
@@ -215,8 +217,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-acme_accountkey_path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-module-parameter-acme-accountkey-path"><strong>acme_accountkey_path</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-acme_accountkey_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>The path to the accountkey for the <code class="docutils literal notranslate"><span class="pre">acme</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">acme</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>The path to the accountkey for the <code class="ansible-value docutils literal notranslate"><span class="pre">acme</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">acme</span></code> provider.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -224,8 +226,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-acme_chain" 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>Include the intermediate certificate to the generated certificate</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">acme</span></code> provider.</p>
|
||||
<p>Note that this is only available for older versions of <code class="docutils literal notranslate"><span class="pre">acme-tiny</span></code>. New versions include the chain automatically, and setting <em>acme_chain</em> to <code class="docutils literal notranslate"><span class="pre">true</span></code> results in an error.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">acme</span></code> provider.</p>
|
||||
<p>Note that this is only available for older versions of <code class="docutils literal notranslate"><span class="pre">acme-tiny</span></code>. New versions include the chain automatically, and setting <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-acme-chain"><span class="std std-ref"><span class="pre">acme_chain</span></span></a></strong></code> to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> results in an error.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -237,8 +239,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-acme_challenge_path"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-module-parameter-acme-challenge-path"><strong>acme_challenge_path</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-acme_challenge_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>The path to the ACME challenge directory that is served on <a class="reference external" href="http:/">http:/</a>/<HOST>:80/.well-known/acme-challenge/</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">acme</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>The path to the ACME challenge directory that is served on <a class="reference external" href="http://%3CHOST%3E:80/.well-known/acme-challenge/">http://%3CHOST%3E:80/.well-known/acme-challenge/</a></p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">acme</span></code> provider.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -281,7 +283,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the Certificate Signing Request (CSR) used to generate this certificate.</p>
|
||||
<p>This is mutually exclusive with <em>csr_path</em>.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-csr-path"><span class="std std-ref"><span class="pre">csr_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -289,7 +291,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-csr_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>Path to the Certificate Signing Request (CSR) used to generate this certificate.</p>
|
||||
<p>This is mutually exclusive with <em>csr_content</em>.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-csr-content"><span class="std std-ref"><span class="pre">csr_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -297,8 +299,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_api_client_cert_key_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>The path to the private key of the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -306,8 +308,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_api_client_cert_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>The path to the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -315,8 +317,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_api_key" 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 key (password) for authentication to the Entrust Certificate Services (ECS) API.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -325,7 +327,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The path to the specification file defining the Entrust Certificate Services (ECS) API configuration.</p>
|
||||
<p>You can use this to keep a local copy of the specification to avoid downloading it every time the module is used.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://cloud.entrust.net/EntrustCloud/documentation/cms-api-2.1.0.yaml"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -334,8 +336,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_api_user" 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 username for authentication to the Entrust Certificate Services (ECS) API.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -343,7 +345,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_cert_type" 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>Specify the type of certificate requested.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"STANDARD_SSL"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -365,15 +367,15 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The point in time at which the certificate stops being valid.</p>
|
||||
<p>Time can be specified either as relative time or as an absolute timestamp.</p>
|
||||
<p>A valid absolute time format is <code class="docutils literal notranslate"><span class="pre">ASN.1</span> <span class="pre">TIME</span></code> such as <code class="docutils literal notranslate"><span class="pre">2019-06-18</span></code>.</p>
|
||||
<p>A valid relative time format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code>, such as <code class="docutils literal notranslate"><span class="pre">+365d</span></code> or <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>A valid absolute time format is <code class="docutils literal notranslate"><span class="pre">ASN.1</span> <span class="pre">TIME</span></code> such as <code class="ansible-value docutils literal notranslate"><span class="pre">2019-06-18</span></code>.</p>
|
||||
<p>A valid relative time format is <code class="ansible-value docutils literal notranslate"><span class="pre">[+-]timespec</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code>, such as <code class="ansible-value docutils literal notranslate"><span class="pre">+365d</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Note that only the date (day, month, year) is supported for specifying the expiry date of the issued certificate.</p>
|
||||
<p>The full date-time is adjusted to EST (GMT -5:00) before issuance, which may result in a certificate with an expiration date one day earlier than expected if a relative time is used.</p>
|
||||
<p>The minimum certificate lifetime is 90 days, and maximum is three years.</p>
|
||||
<p>If this value is not specified, the certificate will stop being valid 365 days the date of issue.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>Please note that this value is <strong>not</strong> covered by the <em>ignore_timestamps</em> option.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>Please note that this value is <strong>not</strong> covered by the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+365d"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -382,8 +384,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_requester_email" 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 email of the requester of the certificate (for tracking purposes).</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -391,8 +393,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_requester_name" 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 name of the requester of the certificate (for tracking purposes).</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -400,8 +402,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_requester_phone" 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 phone number of the requester of the certificate (for tracking purposes).</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -430,7 +432,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether the “not before” and “not after” timestamps should be ignored for idempotency checks.</p>
|
||||
<p>It is better to keep the default value <code class="docutils literal notranslate"><span class="pre">true</span></code> when using relative timestamps (like <code class="docutils literal notranslate"><span class="pre">+0s</span></code> for now).</p>
|
||||
<p>It is better to keep the default value <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> when using relative timestamps (like <code class="ansible-value docutils literal notranslate"><span class="pre">+0s</span></code> for now).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -457,8 +459,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the CA (Certificate Authority) certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <em>ownca_path</em>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-path"><span class="std std-ref"><span class="pre">ownca_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -467,7 +469,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Create a Authority Key Identifier from the CA’s certificate. If the CSR provided a authority key identifier, it is ignored.</p>
|
||||
<p>The Authority Key Identifier is generated from the CA certificate’s Subject Key Identifier, if available. If it is not available, the CA certificate’s public key will be used.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -481,10 +483,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_create_subject_key_identifier" 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>Whether to create the Subject Key Identifier (SKI) from the public key.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">create_if_not_provided</span></code> (default) only creates a SKI when the CSR does not provide one.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">always_create</span></code> always creates a SKI. If the CSR provides one, that one is ignored.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">never_create</span></code> never creates a SKI. If the CSR provides one, that one is used.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">create_if_not_provided</span></code> (default) only creates a SKI when the CSR does not provide one.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">always_create</span></code> always creates a SKI. If the CSR provides one, that one is ignored.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">never_create</span></code> never creates a SKI. If the CSR provides one, that one is used.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -498,8 +500,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-ownca_digest"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-digest"><strong>ownca_digest</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_digest" 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 digest algorithm to be used for the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>The digest algorithm to be used for the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> certificate.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"sha256"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -510,10 +512,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time at which the certificate stops being valid.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>If this value is not specified, the certificate will stop being valid 10 years from now.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <em>ignore_timestamps</em> option to <code class="docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <em>ignore_timestamps=false</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>On macOS 10.15 and onwards, TLS server certificates must have a validity period of 825 days or fewer. Please see <a class="reference external" href="https://support.apple.com/en-us/HT210176">https://support.apple.com/en-us/HT210176</a> for more details.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+3650d"</span></code></p>
|
||||
</div></td>
|
||||
@@ -525,10 +527,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time the certificate is valid from.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>If this value is not specified, the certificate will start being valid from now.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <em>ignore_timestamps</em> option to <code class="docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <em>ignore_timestamps=false</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+0s"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -537,8 +539,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_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 of the CA (Certificate Authority) certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <em>ownca_content</em>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-content"><span class="std std-ref"><span class="pre">ownca_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -547,16 +549,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the CA (Certificate Authority) private key to use when signing the certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <em>ownca_privatekey_path</em>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-privatekey-path"><span class="std std-ref"><span class="pre">ownca_privatekey_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ownca_privatekey_passphrase"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-privatekey-passphrase"><strong>ownca_privatekey_passphrase</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_privatekey_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 <em>ownca_privatekey_path</em> resp. <em>ownca_privatekey_content</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>The passphrase for the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-privatekey-path"><span class="std std-ref"><span class="pre">ownca_privatekey_path</span></span></a></strong></code> resp. <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-privatekey-content"><span class="std std-ref"><span class="pre">ownca_privatekey_content</span></span></a></strong></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -564,17 +566,17 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_privatekey_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>Path to the CA (Certificate Authority) private key to use when signing the certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <em>ownca_privatekey_content</em>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-privatekey-content"><span class="std std-ref"><span class="pre">ownca_privatekey_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ownca_version"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-module-parameter-ownca-version"><strong>ownca_version</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The version of the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> certificate.</p>
|
||||
<p>Nowadays it should almost always be <code class="docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>The version of the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> certificate.</p>
|
||||
<p>Nowadays it should almost always be <code class="ansible-value docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">3</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -600,14 +602,14 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the private key to use when signing the certificate.</p>
|
||||
<p>This is mutually exclusive with <em>privatekey_path</em>.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-privatekey_passphrase"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-module-parameter-privatekey-passphrase"><strong>privatekey_passphrase</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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 <em>privatekey_path</em> resp. <em>privatekey_content</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The passphrase for the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_path</span></span></a></strong></code> resp. <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code>.</p>
|
||||
<p>This is required if the private key is password protected.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -616,7 +618,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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>Path to the private key to use when signing the certificate.</p>
|
||||
<p>This is mutually exclusive with <em>privatekey_content</em>.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -624,8 +626,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-provider" 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>Name of the provider to use to generate/retrieve the OpenSSL certificate. Please see the examples on how to emulate it with <a class="reference internal" href="x509_certificate_info_module.html#ansible-collections-community-crypto-x509-certificate-info-module"><span class="std std-ref">community.crypto.x509_certificate_info</span></a>, <a class="reference internal" href="openssl_csr_info_module.html#ansible-collections-community-crypto-openssl-csr-info-module"><span class="std std-ref">community.crypto.openssl_csr_info</span></a>, <a class="reference internal" href="openssl_privatekey_info_module.html#ansible-collections-community-crypto-openssl-privatekey-info-module"><span class="std std-ref">community.crypto.openssl_privatekey_info</span></a> and <a class="reference external" href="https://docs.ansible.com/ansible/devel/collections/ansible/builtin/assert_module.html#ansible-collections-ansible-builtin-assert-module" title="(in Ansible vdevel)"><span class="xref std std-ref">ansible.builtin.assert</span></a>.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider was added for Ansible 2.9 and requires credentials for the <a class="reference external" href="https://www.entrustdatacard.com/products/categories/ssl-certificates">Entrust Certificate Services</a> (ECS) API.</p>
|
||||
<p>Required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>The <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider was added for Ansible 2.9 and requires credentials for the <a class="reference external" href="https://www.entrustdatacard.com/products/categories/ssl-certificates">Entrust Certificate Services</a> (ECS) API.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"acme"</span></code></p></li>
|
||||
@@ -640,7 +642,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-return_content" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) certificate’s content as <em>certificate</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) certificate’s content as <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-return-certificate"><span class="std std-ref"><span class="pre">certificate</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -653,8 +655,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -676,10 +678,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-selfsigned_create_subject_key_identifier" 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>Whether to create the Subject Key Identifier (SKI) from the public key.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">create_if_not_provided</span></code> (default) only creates a SKI when the CSR does not provide one.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">always_create</span></code> always creates a SKI. If the CSR provides one, that one is ignored.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">never_create</span></code> never creates a SKI. If the CSR provides one, that one is used.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">create_if_not_provided</span></code> (default) only creates a SKI when the CSR does not provide one.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">always_create</span></code> always creates a SKI. If the CSR provides one, that one is ignored.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">never_create</span></code> never creates a SKI. If the CSR provides one, that one is used.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -694,7 +696,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-selfsigned_digest" 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>Digest algorithm to be used when self-signing the certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"sha256"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -707,10 +709,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time at which the certificate stops being valid.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>If this value is not specified, the certificate will stop being valid 10 years from now.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <em>ignore_timestamps</em> option to <code class="docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <em>ignore_timestamps=false</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>On macOS 10.15 and onwards, TLS server certificates must have a validity period of 825 days or fewer. Please see <a class="reference external" href="https://support.apple.com/en-us/HT210176">https://support.apple.com/en-us/HT210176</a> for more details.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+3650d"</span></code></p>
|
||||
</div></td>
|
||||
@@ -724,10 +726,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time the certificate is valid from.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>If this value is not specified, the certificate will start being valid from now.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <em>ignore_timestamps</em> option to <code class="docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <em>ignore_timestamps=false</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+0s"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -735,9 +737,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-selfsigned_version"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-module-parameter-selfsigned-version"><strong>selfsigned_version</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-selfsigned_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Version of the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> certificate.</p>
|
||||
<p>Nowadays it should almost always be <code class="docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>Version of the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> certificate.</p>
|
||||
<p>Nowadays it should almost always be <code class="ansible-value docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">3</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -840,8 +842,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<ul class="simple">
|
||||
<li><p>All ASN.1 TIME values should be specified following the YYYYMMDDHHMMSSZ pattern.</p></li>
|
||||
<li><p>Date specified should be UTC. Minutes and seconds are mandatory.</p></li>
|
||||
<li><p>For security reason, when you use <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider, you should NOT run <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a> on a target machine, but on a dedicated CA machine. It is recommended not to store the CA private key on the target machine. Once signed, the certificate can be moved to the target machine.</p></li>
|
||||
<li><p>For the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider, <em>csr_path</em> and <em>csr_content</em> are optional. If not provided, a certificate without any information (Subject, Subject Alternative Names, Key Usage, etc.) is created.</p></li>
|
||||
<li><p>For security reason, when you use <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider, you should NOT run <a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a> on a target machine, but on a dedicated CA machine. It is recommended not to store the CA private key on the target machine. Once signed, the certificate can be moved to the target machine.</p></li>
|
||||
<li><p>For the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-csr-path"><span class="std std-ref"><span class="pre">csr_path</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-csr-content"><span class="std std-ref"><span class="pre">csr_content</span></span></a></strong></code> are optional. If not provided, a certificate without any information (Subject, Subject Alternative Names, Key Usage, etc.) is created.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
@@ -943,7 +945,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<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/csr/ansible.com.key</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_privatekey</span>
|
||||
|
||||
<span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">assert</span><span class="p">:</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">Check conditions on certificate, CSR, and private key</span>
|
||||
<span class="w"> </span><span class="nt">ansible.builtin.assert</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="nt">that</span><span class="p">:</span>
|
||||
<span class="w"> </span><span class="c1"># When private key was specified for assertonly, this was checked:</span>
|
||||
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">result.public_key == result_privatekey.public_key</span>
|
||||
@@ -997,7 +1000,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/www.ansible.com.crt.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -1007,7 +1010,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The (current or generated) certificate’s content.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and <em>return_content</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-module-parameter-return-content"><span class="std std-ref"><span class="pre">return_content</span></span></a></strong></code> is <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">
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.x509_certificate_pipe module – Generate and/or check OpenSSL certificates<a class="headerlink" href="#community-crypto-x509-certificate-pipe-module-generate-and-or-check-openssl-certificates" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-x509-certificate-pipe-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -187,10 +189,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<section id="synopsis">
|
||||
<h2><a class="toc-backref" href="#id1" role="doc-backlink">Synopsis</a><a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<ul class="simple">
|
||||
<li><p>It implements a notion of provider (ie. <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code>, <code class="docutils literal notranslate"><span class="pre">ownca</span></code>, <code class="docutils literal notranslate"><span class="pre">entrust</span></code>) for your certificate.</p></li>
|
||||
<li><p>It implements a notion of provider (one of <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code>, <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>) for your certificate.</p></li>
|
||||
<li><p>It uses the cryptography python library to interact with OpenSSL.</p></li>
|
||||
<li><p>Please note that the module regenerates an existing certificate if it does not match the module’s options, or if it seems to be corrupt. If you are concerned that this could overwrite your existing certificate, consider using the <em>backup</em> option.</p></li>
|
||||
<li><p>The <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider is intended for generating an OpenSSL certificate signed with your own CA (Certificate Authority) certificate (self-signed certificate).</p></li>
|
||||
<li><p>The <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider is intended for generating an OpenSSL certificate signed with your own CA (Certificate Authority) certificate (self-signed certificate).</p></li>
|
||||
<li><p>This module allows one to (re)generate OpenSSL certificates.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -198,7 +199,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<span id="ansible-collections-community-crypto-x509-certificate-pipe-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink 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.6 (if using <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> or <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider)</p></li>
|
||||
<li><p>cryptography >= 1.6 (if using <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider)</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="parameters">
|
||||
@@ -222,7 +223,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-csr_content" 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>Content of the Certificate Signing Request (CSR) used to generate this certificate.</p>
|
||||
<p>This is mutually exclusive with <em>csr_path</em>.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-csr-path"><span class="std std-ref"><span class="pre">csr_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -230,7 +231,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-csr_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>Path to the Certificate Signing Request (CSR) used to generate this certificate.</p>
|
||||
<p>This is mutually exclusive with <em>csr_content</em>.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-csr-content"><span class="std std-ref"><span class="pre">csr_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -238,8 +239,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_api_client_cert_key_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>The path to the private key of the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -247,8 +248,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_api_client_cert_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>The path to the client certificate used to authenticate to the Entrust Certificate Services (ECS) API.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -256,8 +257,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_api_key" 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 key (password) for authentication to the Entrust Certificate Services (ECS) API.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -266,7 +267,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The path to the specification file defining the Entrust Certificate Services (ECS) API configuration.</p>
|
||||
<p>You can use this to keep a local copy of the specification to avoid downloading it every time the module is used.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"https://cloud.entrust.net/EntrustCloud/documentation/cms-api-2.1.0.yaml"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -275,8 +276,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_api_user" 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 username for authentication to the Entrust Certificate Services (ECS) API.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -284,7 +285,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_cert_type" 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>Specify the type of certificate requested.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"STANDARD_SSL"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -306,15 +307,15 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The point in time at which the certificate stops being valid.</p>
|
||||
<p>Time can be specified either as relative time or as an absolute timestamp.</p>
|
||||
<p>A valid absolute time format is <code class="docutils literal notranslate"><span class="pre">ASN.1</span> <span class="pre">TIME</span></code> such as <code class="docutils literal notranslate"><span class="pre">2019-06-18</span></code>.</p>
|
||||
<p>A valid relative time format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code>, such as <code class="docutils literal notranslate"><span class="pre">+365d</span></code> or <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>A valid absolute time format is <code class="docutils literal notranslate"><span class="pre">ASN.1</span> <span class="pre">TIME</span></code> such as <code class="ansible-value docutils literal notranslate"><span class="pre">2019-06-18</span></code>.</p>
|
||||
<p>A valid relative time format is <code class="ansible-value docutils literal notranslate"><span class="pre">[+-]timespec</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code>, such as <code class="ansible-value docutils literal notranslate"><span class="pre">+365d</span></code> or <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Note that only the date (day, month, year) is supported for specifying the expiry date of the issued certificate.</p>
|
||||
<p>The full date-time is adjusted to EST (GMT -5:00) before issuance, which may result in a certificate with an expiration date one day earlier than expected if a relative time is used.</p>
|
||||
<p>The minimum certificate lifetime is 90 days, and maximum is three years.</p>
|
||||
<p>If this value is not specified, the certificate will stop being valid 365 days the date of issue.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>Please note that this value is <strong>not</strong> covered by the <em>ignore_timestamps</em> option.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>Please note that this value is <strong>not</strong> covered by the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+365d"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -323,8 +324,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_requester_email" 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 email of the requester of the certificate (for tracking purposes).</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -332,8 +333,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_requester_name" 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 name of the requester of the certificate (for tracking purposes).</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -341,8 +342,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-entrust_requester_phone" 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 phone number of the requester of the certificate (for tracking purposes).</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider.</p>
|
||||
<p>This is required if the provider is <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -363,7 +364,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.0.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Whether the “not before” and “not after” timestamps should be ignored for idempotency checks.</p>
|
||||
<p>It is better to keep the default value <code class="docutils literal notranslate"><span class="pre">true</span></code> when using relative timestamps (like <code class="docutils literal notranslate"><span class="pre">+0s</span></code> for now).</p>
|
||||
<p>It is better to keep the default value <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code> when using relative timestamps (like <code class="ansible-value docutils literal notranslate"><span class="pre">+0s</span></code> for now).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">false</span></code></p></li>
|
||||
@@ -376,8 +377,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_content" 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>Content of the CA (Certificate Authority) certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <em>ownca_path</em>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-path"><span class="std std-ref"><span class="pre">ownca_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -386,7 +387,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Create a Authority Key Identifier from the CA’s certificate. If the CSR provided a authority key identifier, it is ignored.</p>
|
||||
<p>The Authority Key Identifier is generated from the CA certificate’s Subject Key Identifier, if available. If it is not available, the CA certificate’s public key will be used.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -400,10 +401,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_create_subject_key_identifier" 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>Whether to create the Subject Key Identifier (SKI) from the public key.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">create_if_not_provided</span></code> (default) only creates a SKI when the CSR does not provide one.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">always_create</span></code> always creates a SKI. If the CSR provides one, that one is ignored.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">never_create</span></code> never creates a SKI. If the CSR provides one, that one is used.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">create_if_not_provided</span></code> (default) only creates a SKI when the CSR does not provide one.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">always_create</span></code> always creates a SKI. If the CSR provides one, that one is ignored.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">never_create</span></code> never creates a SKI. If the CSR provides one, that one is used.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -417,8 +418,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-ownca_digest"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-digest"><strong>ownca_digest</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_digest" 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 digest algorithm to be used for the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>The digest algorithm to be used for the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> certificate.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"sha256"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -429,10 +430,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time at which the certificate stops being valid.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>If this value is not specified, the certificate will stop being valid 10 years from now.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <em>ignore_timestamps</em> option to <code class="docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <em>ignore_timestamps=false</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>On macOS 10.15 and onwards, TLS server certificates must have a validity period of 825 days or fewer. Please see <a class="reference external" href="https://support.apple.com/en-us/HT210176">https://support.apple.com/en-us/HT210176</a> for more details.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+3650d"</span></code></p>
|
||||
</div></td>
|
||||
@@ -444,10 +445,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time the certificate is valid from.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>If this value is not specified, the certificate will start being valid from now.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <em>ignore_timestamps</em> option to <code class="docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <em>ignore_timestamps=false</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+0s"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -456,8 +457,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_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 of the CA (Certificate Authority) certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <em>ownca_content</em>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-content"><span class="std std-ref"><span class="pre">ownca_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -465,16 +466,16 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_privatekey_content" 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>Content of the CA (Certificate Authority) private key to use when signing the certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <em>ownca_privatekey_path</em>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-privatekey-path"><span class="std std-ref"><span class="pre">ownca_privatekey_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ownca_privatekey_passphrase"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-privatekey-passphrase"><strong>ownca_privatekey_passphrase</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_privatekey_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 <em>ownca_privatekey_path</em> resp. <em>ownca_privatekey_content</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>The passphrase for the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-privatekey-path"><span class="std std-ref"><span class="pre">ownca_privatekey_path</span></span></a></strong></code> resp. <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-privatekey-content"><span class="std std-ref"><span class="pre">ownca_privatekey_content</span></span></a></strong></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -482,17 +483,17 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_privatekey_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>Path to the CA (Certificate Authority) private key to use when signing the certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <em>ownca_privatekey_content</em>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-privatekey-content"><span class="std std-ref"><span class="pre">ownca_privatekey_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-ownca_version"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ownca-version"><strong>ownca_version</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ownca_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The version of the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> certificate.</p>
|
||||
<p>Nowadays it should almost always be <code class="docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>The version of the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> certificate.</p>
|
||||
<p>Nowadays it should almost always be <code class="ansible-value docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">3</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -501,14 +502,14 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_content" 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>Content of the private key to use when signing the certificate.</p>
|
||||
<p>This is mutually exclusive with <em>privatekey_path</em>.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_path</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-privatekey_passphrase"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-privatekey-passphrase"><strong>privatekey_passphrase</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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 <em>privatekey_path</em> resp. <em>privatekey_content</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The passphrase for the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_path</span></span></a></strong></code> resp. <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code>.</p>
|
||||
<p>This is required if the private key is password protected.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -517,7 +518,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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>Path to the private key to use when signing the certificate.</p>
|
||||
<p>This is mutually exclusive with <em>privatekey_content</em>.</p>
|
||||
<p>This is mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -525,7 +526,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-provider" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span> / <span class="ansible-option-required">required</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Name of the provider to use to generate/retrieve the OpenSSL certificate.</p>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">entrust</span></code> provider requires credentials for the <a class="reference external" href="https://www.entrustdatacard.com/products/categories/ssl-certificates">Entrust Certificate Services</a> (ECS) API.</p>
|
||||
<p>The <code class="ansible-value docutils literal notranslate"><span class="pre">entrust</span></code> provider requires credentials for the <a class="reference external" href="https://www.entrustdatacard.com/products/categories/ssl-certificates">Entrust Certificate Services</a> (ECS) API.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"entrust"</span></code></p></li>
|
||||
@@ -539,8 +540,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<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="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="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>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"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"auto"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -553,10 +554,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-selfsigned_create_subject_key_identifier" 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>Whether to create the Subject Key Identifier (SKI) from the public key.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">create_if_not_provided</span></code> (default) only creates a SKI when the CSR does not provide one.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">always_create</span></code> always creates a SKI. If the CSR provides one, that one is ignored.</p>
|
||||
<p>A value of <code class="docutils literal notranslate"><span class="pre">never_create</span></code> never creates a SKI. If the CSR provides one, that one is used.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">create_if_not_provided</span></code> (default) only creates a SKI when the CSR does not provide one.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">always_create</span></code> always creates a SKI. If the CSR provides one, that one is ignored.</p>
|
||||
<p>A value of <code class="ansible-value docutils literal notranslate"><span class="pre">never_create</span></code> never creates a SKI. If the CSR provides one, that one is used.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>Note that this is only supported if the <code class="docutils literal notranslate"><span class="pre">cryptography</span></code> backend is used!</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -571,7 +572,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-selfsigned_digest" 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>Digest algorithm to be used when self-signing the certificate.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"sha256"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -584,10 +585,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time at which the certificate stops being valid.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>If this value is not specified, the certificate will stop being valid 10 years from now.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <em>ignore_timestamps</em> option to <code class="docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <em>ignore_timestamps=false</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>On macOS 10.15 and onwards, TLS server certificates must have a validity period of 825 days or fewer. Please see <a class="reference external" href="https://support.apple.com/en-us/HT210176">https://support.apple.com/en-us/HT210176</a> for more details.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+3650d"</span></code></p>
|
||||
</div></td>
|
||||
@@ -601,10 +602,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time the certificate is valid from.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>If this value is not specified, the certificate will start being valid from now.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <em>ignore_timestamps</em> option to <code class="docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <em>ignore_timestamps=false</em>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p>Note that this value is <strong>not used to determine whether an existing certificate should be regenerated</strong>. This can be changed by setting the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> option to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>. Please note that you should avoid relative timestamps when setting <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps=false</span></span></a></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+0s"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -612,9 +613,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-selfsigned_version"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-selfsigned-version"><strong>selfsigned_version</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-selfsigned_version" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Version of the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> certificate.</p>
|
||||
<p>Nowadays it should almost always be <code class="docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||||
<p>This is only used by the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<td><div class="ansible-option-cell"><p>Version of the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> certificate.</p>
|
||||
<p>Nowadays it should almost always be <code class="ansible-value docutils literal notranslate"><span class="pre">3</span></code>.</p>
|
||||
<p>This is only used by the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">3</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -657,8 +658,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<ul class="simple">
|
||||
<li><p>All ASN.1 TIME values should be specified following the YYYYMMDDHHMMSSZ pattern.</p></li>
|
||||
<li><p>Date specified should be UTC. Minutes and seconds are mandatory.</p></li>
|
||||
<li><p>For security reason, when you use <code class="docutils literal notranslate"><span class="pre">ownca</span></code> provider, you should NOT run <a class="reference internal" href="x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a> on a target machine, but on a dedicated CA machine. It is recommended not to store the CA private key on the target machine. Once signed, the certificate can be moved to the target machine.</p></li>
|
||||
<li><p>For the <code class="docutils literal notranslate"><span class="pre">selfsigned</span></code> provider, <em>csr_path</em> and <em>csr_content</em> are optional. If not provided, a certificate without any information (Subject, Subject Alternative Names, Key Usage, etc.) is created.</p></li>
|
||||
<li><p>For security reason, when you use <code class="ansible-value docutils literal notranslate"><span class="pre">ownca</span></code> provider, you should NOT run <a class="reference internal" href="x509_certificate_module.html#ansible-collections-community-crypto-x509-certificate-module"><span class="std std-ref">community.crypto.x509_certificate</span></a> on a target machine, but on a dedicated CA machine. It is recommended not to store the CA private key on the target machine. Once signed, the certificate can be moved to the target machine.</p></li>
|
||||
<li><p>For the <code class="ansible-value docutils literal notranslate"><span class="pre">selfsigned</span></code> provider, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-csr-path"><span class="std std-ref"><span class="pre">csr_path</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-certificate-pipe-module-parameter-csr-content"><span class="std std-ref"><span class="pre">csr_content</span></span></a></strong></code> are optional. If not provided, a certificate without any information (Subject, Subject Alternative Names, Key Usage, etc.) is created.</p></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -163,7 +165,7 @@
|
||||
<h1>community.crypto.x509_crl_info filter – Retrieve information from X.509 CRLs in PEM format<a class="headerlink" href="#community-crypto-x509-crl-info-filter-retrieve-information-from-x-509-crls-in-pem-format" title="Permalink to this heading"></a></h1>
|
||||
<div class="admonition note">
|
||||
<p class="admonition-title">Note</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This filter plugin is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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 filter plugin,
|
||||
see <a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-filter-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -192,7 +194,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<span id="ansible-collections-community-crypto-x509-crl-info-filter-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the local controller node that executes this filter.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If <em>name_encoding</em> is set to another value than <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> is set to another value than <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="input">
|
||||
@@ -231,7 +233,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#parameter-list_revoked_certificates" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.7.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the list of revoked certificates is not included in the result.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>, the list of revoked certificates is not included in the result.</p>
|
||||
<p>This is useful when retrieving information on large CRL files. Enumerating all revoked certificates can take some time, including serializing the result as JSON, sending it to the Ansible controller, and decoding it again.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -245,10 +247,10 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#parameter-name_encoding" 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>How to encode names (DNS names, URIs, email addresses) in return values.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="docutils literal notranslate"><span class="pre">idna</span></code> and <code class="docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -314,8 +316,13 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<div class="ansibleOptionAnchor" id="return-_value/format"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-crl-info-filter-return-value-format"><strong>format</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/format" 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>Whether the CRL is in PEM format (<code class="docutils literal notranslate"><span class="pre">pem</span></code>) or in DER format (<code class="docutils literal notranslate"><span class="pre">der</span></code>).</p>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Whether the CRL is in PEM format (<code class="ansible-value docutils literal notranslate"><span class="pre">pem</span></code>) or in DER format (<code class="ansible-value docutils literal notranslate"><span class="pre">der</span></code>).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Can only return:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"pem"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"der"</span></code></p></li>
|
||||
</ul>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"pem"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -325,7 +332,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The CRL’s issuer.</p>
|
||||
<p>Note that for repeated values, only the last one will be returned.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"commonName":</span> <span class="pre">"ca.example.com",</span> <span class="pre">"organizationName":</span> <span class="pre">"Ansible"}</span></code></p>
|
||||
</div></td>
|
||||
@@ -362,7 +369,7 @@ example: <code class="docutils literal notranslate"><span class="pre">input</spa
|
||||
<a class="ansibleOptionLink" href="#return-_value/revoked_certificates" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>List of certificates to be revoked.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success if <em>list_revoked_certificates=true</em></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-filter-parameter-list-revoked-certificates"><span class="std std-ref"><span class="pre">list_revoked_certificates=true</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -389,7 +396,7 @@ or that the certificate otherwise became invalid as ASN.1 TIME.</p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/revoked_certificates/issuer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The certificate’s issuer.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-filter-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:ca.example.org"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -408,8 +415,20 @@ or that the certificate otherwise became invalid as ASN.1 TIME.</p>
|
||||
<a class="ansibleOptionLink" href="#return-_value/revoked_certificates/reason" 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-indent-desc"></div><div class="ansible-option-cell"><p>The value for the revocation reason extension.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">unspecified</span></code>, <code class="docutils literal notranslate"><span class="pre">key_compromise</span></code>, <code class="docutils literal notranslate"><span class="pre">ca_compromise</span></code>, <code class="docutils literal notranslate"><span class="pre">affiliation_changed</span></code>, <code class="docutils literal notranslate"><span class="pre">superseded</span></code>, <code class="docutils literal notranslate"><span class="pre">cessation_of_operation</span></code>, <code class="docutils literal notranslate"><span class="pre">certificate_hold</span></code>, <code class="docutils literal notranslate"><span class="pre">privilege_withdrawn</span></code>, <code class="docutils literal notranslate"><span class="pre">aa_compromise</span></code>, and <code class="docutils literal notranslate"><span class="pre">remove_from_crl</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Can only return:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"unspecified"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"key_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ca_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"affiliation_changed"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"superseded"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"cessation_of_operation"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"certificate_hold"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"privilege_withdrawn"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"aa_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"remove_from_crl"</span></code></p></li>
|
||||
</ul>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"key_compromise"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -165,7 +167,7 @@
|
||||
<h1>community.crypto.x509_crl_info module – Retrieve information on Certificate Revocation Lists (CRLs)<a class="headerlink" href="#community-crypto-x509-crl-info-module-retrieve-information-on-certificate-revocation-lists-crls" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-x509-crl-info-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -194,7 +196,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<span id="ansible-collections-community-crypto-x509-crl-info-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If <em>name_encoding</em> is set to another value than <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> is set to another value than <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>cryptography >= 1.2</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -212,7 +214,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<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>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Content of the X.509 CRL in PEM format, or Base64-encoded X.509 CRL.</p>
|
||||
<p>Either <em>path</em> or <em>content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-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-x509-crl-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-odd"><td><div class="ansible-option-cell">
|
||||
@@ -220,7 +222,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-list_revoked_certificates" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 1.7.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="docutils literal notranslate"><span class="pre">false</span></code>, the list of revoked certificates is not included in the result.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">false</span></code>, the list of revoked certificates is not included in the result.</p>
|
||||
<p>This is useful when retrieving information on large CRL files. Enumerating all revoked certificates can take some time, including serializing the result as JSON, sending it to the Ansible controller, and decoding it again.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -234,10 +236,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-name_encoding" 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>How to encode names (DNS names, URIs, email addresses) in return values.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="docutils literal notranslate"><span class="pre">idna</span></code> and <code class="docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -251,7 +253,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<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 generated CRL file should be created or is already located.</p>
|
||||
<p>Either <em>path</em> or <em>content</em> must be specified, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-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-x509-crl-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>
|
||||
</tbody>
|
||||
@@ -304,7 +306,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<dl class="simple">
|
||||
<dt><a class="reference internal" href="x509_crl_module.html#ansible-collections-community-crypto-x509-crl-module"><span class="std std-ref">community.crypto.x509_crl</span></a></dt><dd><p>Generate Certificate Revocation Lists (CRLs).</p>
|
||||
</dd>
|
||||
<dt><a class="reference internal" href="x509_crl_info_filter.html#ansible-collections-community-crypto-x509-crl-info-filter"><span class="std std-ref">community.crypto.x509_crl_info filter</span></a></dt><dd><p>A filter variant of this module.</p>
|
||||
<dt><a class="reference internal" href="x509_crl_info_filter.html#ansible-collections-community-crypto-x509-crl-info-filter"><span class="std std-ref">community.crypto.x509_crl_info</span></a> filter plugin</dt><dd><p>A filter variant of this module.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
@@ -351,8 +353,13 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-format"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-crl-info-module-return-format"><strong>format</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-format" 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>Whether the CRL is in PEM format (<code class="docutils literal notranslate"><span class="pre">pem</span></code>) or in DER format (<code class="docutils literal notranslate"><span class="pre">der</span></code>).</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether the CRL is in PEM format (<code class="ansible-value docutils literal notranslate"><span class="pre">pem</span></code>) or in DER format (<code class="ansible-value docutils literal notranslate"><span class="pre">der</span></code>).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Can only return:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"pem"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"der"</span></code></p></li>
|
||||
</ul>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"pem"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -362,7 +369,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The CRL’s issuer.</p>
|
||||
<p>Note that for repeated values, only the last one will be returned.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"commonName":</span> <span class="pre">"ca.example.com",</span> <span class="pre">"organizationName":</span> <span class="pre">"Ansible"}</span></code></p>
|
||||
</div></td>
|
||||
@@ -399,7 +406,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-revoked_certificates" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of certificates to be revoked.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success if <em>list_revoked_certificates=true</em></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success if <code class="ansible-option-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-module-parameter-list-revoked-certificates"><span class="std std-ref"><span class="pre">list_revoked_certificates=true</span></span></a></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -426,7 +433,7 @@ or that the certificate otherwise became invalid as ASN.1 TIME.</p>
|
||||
<a class="ansibleOptionLink" href="#return-revoked_certificates/issuer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The certificate’s issuer.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-info-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:ca.example.org"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -445,8 +452,20 @@ or that the certificate otherwise became invalid as ASN.1 TIME.</p>
|
||||
<a class="ansibleOptionLink" href="#return-revoked_certificates/reason" 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 value for the revocation reason extension.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">unspecified</span></code>, <code class="docutils literal notranslate"><span class="pre">key_compromise</span></code>, <code class="docutils literal notranslate"><span class="pre">ca_compromise</span></code>, <code class="docutils literal notranslate"><span class="pre">affiliation_changed</span></code>, <code class="docutils literal notranslate"><span class="pre">superseded</span></code>, <code class="docutils literal notranslate"><span class="pre">cessation_of_operation</span></code>, <code class="docutils literal notranslate"><span class="pre">certificate_hold</span></code>, <code class="docutils literal notranslate"><span class="pre">privilege_withdrawn</span></code>, <code class="docutils literal notranslate"><span class="pre">aa_compromise</span></code>, and <code class="docutils literal notranslate"><span class="pre">remove_from_crl</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Can only return:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"unspecified"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"key_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ca_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"affiliation_changed"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"superseded"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"cessation_of_operation"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"certificate_hold"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"privilege_withdrawn"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"aa_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"remove_from_crl"</span></code></p></li>
|
||||
</ul>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"key_compromise"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
@@ -14,6 +14,8 @@
|
||||
<script src="_static/js/html5shiv.min.js"></script>
|
||||
<![endif]-->
|
||||
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
||||
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/doctools.js"></script>
|
||||
<script src="_static/sphinx_highlight.js"></script>
|
||||
@@ -164,7 +166,7 @@
|
||||
<h1>community.crypto.x509_crl module – Generate Certificate Revocation Lists (CRLs)<a class="headerlink" href="#community-crypto-x509-crl-module-generate-certificate-revocation-lists-crls" title="Permalink 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/community/crypto">community.crypto collection</a> (version 2.14.0).</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://galaxy.ansible.com/community/crypto">community.crypto collection</a> (version 2.14.1).</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-x509-crl-module-requirements"><span class="std std-ref">Requirements</span></a> for details.</p>
|
||||
@@ -193,7 +195,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<span id="ansible-collections-community-crypto-x509-crl-module-requirements"></span><h2><a class="toc-backref" href="#id2" role="doc-backlink">Requirements</a><a class="headerlink" href="#requirements" title="Permalink to this heading"></a></h2>
|
||||
<p>The below requirements are needed on the host that executes this module.</p>
|
||||
<ul class="simple">
|
||||
<li><p>If <em>name_encoding</em> is set to another value than <code class="docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>If <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> is set to another value than <code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code>, the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> needs to be installed.</p></li>
|
||||
<li><p>cryptography >= 1.2</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
@@ -236,10 +238,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<p><span class="ansible-option-versionadded">added in community.crypto 2.13.0</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Defines how to process entries of existing CRLs.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">generate</span></code>, makes sure that the CRL has the exact set of revoked certificates as specified in <em>revoked_certificates</em>.</p>
|
||||
<p>If set to <code class="docutils literal notranslate"><span class="pre">update</span></code>, makes sure that the CRL contains the revoked certificates from <em>revoked_certificates</em>, but can also contain other revoked certificates. If the CRL file already exists, all entries from the existing CRL will also be included in the new CRL. When using <code class="docutils literal notranslate"><span class="pre">update</span></code>, you might be interested in setting <em>ignore_timestamps</em> to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>The default value is <code class="docutils literal notranslate"><span class="pre">generate</span></code>.</p>
|
||||
<p>This parameter was called <em>mode</em> before community.crypto 2.13.0. It has been renamed to avoid a collision with the common <em>mode</em> parameter for setting the CRL file’s access mode.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">generate</span></code>, makes sure that the CRL has the exact set of revoked certificates as specified in <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates"><span class="std std-ref"><span class="pre">revoked_certificates</span></span></a></strong></code>.</p>
|
||||
<p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">update</span></code>, makes sure that the CRL contains the revoked certificates from <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates"><span class="std std-ref"><span class="pre">revoked_certificates</span></span></a></strong></code>, but can also contain other revoked certificates. If the CRL file already exists, all entries from the existing CRL will also be included in the new CRL. When using <code class="ansible-value docutils literal notranslate"><span class="pre">update</span></code>, you might be interested in setting <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>The default value is <code class="ansible-value docutils literal notranslate"><span class="pre">generate</span></code>.</p>
|
||||
<p>This parameter was called <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code> before community.crypto 2.13.0. It has been renamed to avoid a collision with the common <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code> parameter for setting the CRL file’s access mode.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"generate"</span></code></p></li>
|
||||
@@ -272,7 +274,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-format" 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>Whether the CRL file should be in PEM or DER format.</p>
|
||||
<p>If an existing CRL file does match everything but <em>format</em>, it will be converted to the correct format instead of regenerated.</p>
|
||||
<p>If an existing CRL file does match everything but <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-format"><span class="std std-ref"><span class="pre">format</span></span></a></strong></code>, it will be converted to the correct format instead of regenerated.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"pem"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -292,7 +294,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-ignore_timestamps"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-crl-module-parameter-ignore-timestamps"><strong>ignore_timestamps</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-ignore_timestamps" 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 the timestamps <em>last_update</em>, <em>next_update</em> and <em>revocation_date</em> (in <em>revoked_certificates</em>) should be ignored for idempotency checks. The timestamp <em>invalidity_date</em> in <em>revoked_certificates</em> will never be ignored.</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether the timestamps <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-last-update"><span class="std std-ref"><span class="pre">last_update</span></span></a></strong></code>, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-next-update"><span class="std std-ref"><span class="pre">next_update</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates-revocation-date"><span class="std std-ref"><span class="pre">revoked_certificates[].revocation_date</span></span></a></strong></code> should be ignored for idempotency checks. The timestamp <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates-invalidity-date"><span class="std std-ref"><span class="pre">revoked_certificates[].invalidity_date</span></span></a></strong></code> will never be ignored.</p>
|
||||
<p>Use this in combination with relative timestamps for these values to get idempotency.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
@@ -307,9 +309,9 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>Key/value pairs that will be present in the issuer name field of the CRL.</p>
|
||||
<p>If you need to specify more than one value with the same key, use a list as value.</p>
|
||||
<p>If the order of the components is important, use <em>issuer_ordered</em>.</p>
|
||||
<p>One of <em>issuer</em> and <em>issuer_ordered</em> is required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>Mutually exclusive with <em>issuer_ordered</em>.</p>
|
||||
<p>If the order of the components is important, use <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-issuer-ordered"><span class="std std-ref"><span class="pre">issuer_ordered</span></span></a></strong></code>.</p>
|
||||
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-issuer"><span class="std std-ref"><span class="pre">issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-issuer-ordered"><span class="std std-ref"><span class="pre">issuer_ordered</span></span></a></strong></code> is required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-issuer-ordered"><span class="std std-ref"><span class="pre">issuer_ordered</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -319,8 +321,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>A list of dictionaries, where every dictionary must contain one key/value pair. This key/value pair will be present in the issuer name field of the CRL.</p>
|
||||
<p>If you want to specify more than one value with the same key in a row, you can use a list as value.</p>
|
||||
<p>One of <em>issuer</em> and <em>issuer_ordered</em> is required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>Mutually exclusive with <em>issuer</em>.</p>
|
||||
<p>One of <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-issuer"><span class="std std-ref"><span class="pre">issuer</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-issuer-ordered"><span class="std std-ref"><span class="pre">issuer_ordered</span></span></a></strong></code> is required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-issuer"><span class="std std-ref"><span class="pre">issuer</span></span></a></strong></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -330,8 +332,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-cell"><p>The point in time from which this CRL can be trusted.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Note that if using relative time this module is NOT idempotent, except when <em>ignore_timestamps</em> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Note that if using relative time this module is NOT idempotent, except when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+0s"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -339,8 +341,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-mode"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-crl-module-parameter-mode"><strong>mode</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-mode" 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>This parameter has been renamed to <em>crl_mode</em>. The old name <em>mode</em> is now deprecated and will be removed in community.crypto 3.0.0. Replace usage of this parameter with <em>crl_mode</em>.</p>
|
||||
<p>Note that from community.crypto 3.0.0 on, <em>mode</em> will be used for the CRL file’s mode.</p>
|
||||
<td><div class="ansible-option-cell"><p>This parameter has been renamed to <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-crl-mode"><span class="std std-ref"><span class="pre">crl_mode</span></span></a></strong></code>. The old name <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code> is now deprecated and will be removed in community.crypto 3.0.0. Replace usage of this parameter with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-crl-mode"><span class="std std-ref"><span class="pre">crl_mode</span></span></a></strong></code>.</p>
|
||||
<p>Note that from community.crypto 3.0.0 on, <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-mode"><span class="std std-ref"><span class="pre">mode</span></span></a></strong></code> will be used for the CRL file’s mode.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"generate"</span></code></p></li>
|
||||
@@ -353,10 +355,10 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-name_encoding" 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>How to encode names (DNS names, URIs, email addresses) in return values.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="docutils literal notranslate"><span class="pre">idna</span></code> and <code class="docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">ignore</span></code> will use the encoding returned by the backend.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> will convert all labels of domain names to IDNA encoding. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 encoding fails.</p>
|
||||
<p><code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> will convert all labels of domain names to Unicode. IDNA2008 will be preferred, and IDNA2003 will be used if IDNA2008 decoding fails.</p>
|
||||
<p><strong>Note</strong> that <code class="ansible-value docutils literal notranslate"><span class="pre">idna</span></code> and <code class="ansible-value docutils literal notranslate"><span class="pre">unicode</span></code> require the <a class="reference external" href="https://pypi.org/project/idna/">idna Python library</a> to be installed.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">"ignore"</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -369,12 +371,12 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="parameter-next_update"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-crl-module-parameter-next-update"><strong>next_update</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-next_update" 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 absolute latest point in time by which this <em>issuer</em> is expected to have issued another CRL. Many clients will treat a CRL as expired once <em>next_update</em> occurs.</p>
|
||||
<td><div class="ansible-option-cell"><p>The absolute latest point in time by which this <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-issuer"><span class="std std-ref"><span class="pre">issuer</span></span></a></strong></code> is expected to have issued another CRL. Many clients will treat a CRL as expired once <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-next-update"><span class="std std-ref"><span class="pre">next_update</span></span></a></strong></code> occurs.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Note that if using relative time this module is NOT idempotent, except when <em>ignore_timestamps</em> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Note that if using relative time this module is NOT idempotent, except when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-cell">
|
||||
@@ -398,14 +400,14 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_content" 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 content of the CA’s private key to use when signing the CRL.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_path</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code> must be specified if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-privatekey_passphrase"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-crl-module-parameter-privatekey-passphrase"><strong>privatekey_passphrase</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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 <em>privatekey_path</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>The passphrase for the <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_path</span></span></a></strong></code>.</p>
|
||||
<p>This is required if the private key is password protected.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -414,14 +416,14 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-privatekey_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>Path to the CA’s private key to use when signing the CRL.</p>
|
||||
<p>Either <em>privatekey_path</em> or <em>privatekey_content</em> must be specified if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
<p>Either <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-privatekey-path"><span class="std std-ref"><span class="pre">privatekey_path</span></span></a></strong></code> or <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-privatekey-content"><span class="std std-ref"><span class="pre">privatekey_content</span></span></a></strong></code> must be specified if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>, but not both.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
<div class="ansibleOptionAnchor" id="parameter-return_content"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-crl-module-parameter-return-content"><strong>return_content</strong></p>
|
||||
<a class="ansibleOptionLink" href="#parameter-return_content" 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>If set to <code class="docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) CRL’s content as <em>crl</em>.</p>
|
||||
<td><div class="ansible-option-cell"><p>If set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>, will return the (current or generated) CRL’s content as <code class="ansible-return-value docutils literal notranslate"><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-return-crl"><span class="std std-ref"><span class="pre">crl</span></span></a></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Choices:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-default-bold docutils literal notranslate"><span class="pre">false</span></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
|
||||
@@ -434,7 +436,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-revoked_certificates" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=dictionary</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>List of certificates to be revoked.</p>
|
||||
<p>Required if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
<p>Required if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code>.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -443,7 +445,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Content of a certificate in PEM format.</p>
|
||||
<p>The serial number and issuer will be extracted from the certificate.</p>
|
||||
<p>Mutually exclusive with <em>path</em> and <em>serial_number</em>. One of these three options must be specified.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates-path"><span class="std std-ref"><span class="pre">revoked_certificates[].path</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates-serial-number"><span class="std std-ref"><span class="pre">revoked_certificates[].serial_number</span></span></a></strong></code>. One of these three options must be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -453,8 +455,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The point in time it was known/suspected that the private key was compromised or that the certificate otherwise became invalid.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Note that if using relative time this module is NOT idempotent. This will NOT change when <em>ignore_timestamps</em> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Note that if using relative time this module is NOT idempotent. This will NOT change when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</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-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -474,7 +476,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-revoked_certificates/issuer" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The certificate’s issuer.</p>
|
||||
<p>Example: <code class="docutils literal notranslate"><span class="pre">DNS:ca.example.org</span></code></p>
|
||||
<p>Example: <code class="ansible-value docutils literal notranslate"><span class="pre">DNS:ca.example.org</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -495,7 +497,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>Path to a certificate in PEM format.</p>
|
||||
<p>The serial number and issuer will be extracted from the certificate.</p>
|
||||
<p>Mutually exclusive with <em>content</em> and <em>serial_number</em>. One of these three options must be specified.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates-content"><span class="std std-ref"><span class="pre">revoked_certificates[].content</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates-serial-number"><span class="std std-ref"><span class="pre">revoked_certificates[].serial_number</span></span></a></strong></code>. One of these three options must be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-indent"></div><div class="ansible-option-cell">
|
||||
@@ -537,8 +539,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The point in time the certificate was revoked.</p>
|
||||
<p>Time can be specified either as relative time or as absolute timestamp.</p>
|
||||
<p>Time will always be interpreted as UTC.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Note that if using relative time this module is NOT idempotent, except when <em>ignore_timestamps</em> is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p>Valid format is <code class="docutils literal notranslate"><span class="pre">[+-]timespec</span> <span class="pre">|</span> <span class="pre">ASN.1</span> <span class="pre">TIME</span></code> where timespec can be an integer + <code class="docutils literal notranslate"><span class="pre">[w</span> <span class="pre">|</span> <span class="pre">d</span> <span class="pre">|</span> <span class="pre">h</span> <span class="pre">|</span> <span class="pre">m</span> <span class="pre">|</span> <span class="pre">s]</span></code> (for example <code class="ansible-value docutils literal notranslate"><span class="pre">+32w1d2h</span></code>).</p>
|
||||
<p>Note that if using relative time this module is NOT idempotent, except when <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-ignore-timestamps"><span class="std std-ref"><span class="pre">ignore_timestamps</span></span></a></strong></code> is set to <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-default-bold">Default:</span> <code class="ansible-option-default docutils literal notranslate"><span class="pre">"+0s"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -547,7 +549,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#parameter-revoked_certificates/serial_number" title="Permalink to this option"></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>Serial number of the certificate.</p>
|
||||
<p>Mutually exclusive with <em>path</em> and <em>content</em>. One of these three options must be specified.</p>
|
||||
<p>Mutually exclusive with <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates-path"><span class="std std-ref"><span class="pre">revoked_certificates[].path</span></span></a></strong></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-revoked-certificates-content"><span class="std std-ref"><span class="pre">revoked_certificates[].content</span></span></a></strong></code>. One of these three options must be specified.</p>
|
||||
</div></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><div class="ansible-option-cell">
|
||||
@@ -700,7 +702,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-backup_file" 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>Name of backup file created.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <em>backup</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> changed and if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-backup"><span class="std std-ref"><span class="pre">backup</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"/path/to/my-ca.crl.2019-03-09@11:22~"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -709,8 +711,8 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<a class="ansibleOptionLink" href="#return-crl" 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 (current or generated) CRL’s content.</p>
|
||||
<p>Will be the CRL itself if <em>format</em> is <code class="docutils literal notranslate"><span class="pre">pem</span></code>, and Base64 of the CRL if <em>format</em> is <code class="docutils literal notranslate"><span class="pre">der</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <em>state</em> is <code class="docutils literal notranslate"><span class="pre">present</span></code> and <em>return_content</em> is <code class="docutils literal notranslate"><span class="pre">true</span></code></p>
|
||||
<p>Will be the CRL itself if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-format"><span class="std std-ref"><span class="pre">format</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">pem</span></code>, and Base64 of the CRL if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-format"><span class="std std-ref"><span class="pre">format</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">der</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> if <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-state"><span class="std std-ref"><span class="pre">state</span></span></a></strong></code> is <code class="ansible-value docutils literal notranslate"><span class="pre">present</span></code> and <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-return-content"><span class="std std-ref"><span class="pre">return_content</span></span></a></strong></code> is <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">
|
||||
@@ -735,8 +737,13 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
<div class="ansibleOptionAnchor" id="return-format"></div><p class="ansible-option-title" id="ansible-collections-community-crypto-x509-crl-module-return-format"><strong>format</strong></p>
|
||||
<a class="ansibleOptionLink" href="#return-format" 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>Whether the CRL is in PEM format (<code class="docutils literal notranslate"><span class="pre">pem</span></code>) or in DER format (<code class="docutils literal notranslate"><span class="pre">der</span></code>).</p>
|
||||
<td><div class="ansible-option-cell"><p>Whether the CRL is in PEM format (<code class="ansible-value docutils literal notranslate"><span class="pre">pem</span></code>) or in DER format (<code class="ansible-value docutils literal notranslate"><span class="pre">der</span></code>).</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Can only return:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"pem"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"der"</span></code></p></li>
|
||||
</ul>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"pem"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
@@ -746,7 +753,7 @@ see <a class="reference internal" href="#ansible-collections-community-crypto-x5
|
||||
</div></td>
|
||||
<td><div class="ansible-option-cell"><p>The CRL’s issuer.</p>
|
||||
<p>Note that for repeated values, only the last one will be returned.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">{"commonName":</span> <span class="pre">"ca.example.com",</span> <span class="pre">"organizationName":</span> <span class="pre">"Ansible"}</span></code></p>
|
||||
</div></td>
|
||||
@@ -819,7 +826,7 @@ or that the certificate otherwise became invalid as ASN.1 TIME.</p>
|
||||
<a class="ansibleOptionLink" href="#return-revoked_certificates/issuer" title="Permalink to this return value"></a><p class="ansible-option-type-line"><span class="ansible-option-type">list</span> / <span class="ansible-option-elements">elements=string</span></p>
|
||||
</div></td>
|
||||
<td><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"><p>The certificate’s issuer.</p>
|
||||
<p>See <em>name_encoding</em> for how IDNs are handled.</p>
|
||||
<p>See <code class="ansible-option docutils literal notranslate"><strong><a class="reference internal" href="#ansible-collections-community-crypto-x509-crl-module-parameter-name-encoding"><span class="std std-ref"><span class="pre">name_encoding</span></span></a></strong></code> for how IDNs are handled.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">["DNS:ca.example.org"]</span></code></p>
|
||||
</div></td>
|
||||
@@ -838,8 +845,20 @@ or that the certificate otherwise became invalid as ASN.1 TIME.</p>
|
||||
<a class="ansibleOptionLink" href="#return-revoked_certificates/reason" 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 value for the revocation reason extension.</p>
|
||||
<p>One of <code class="docutils literal notranslate"><span class="pre">unspecified</span></code>, <code class="docutils literal notranslate"><span class="pre">key_compromise</span></code>, <code class="docutils literal notranslate"><span class="pre">ca_compromise</span></code>, <code class="docutils literal notranslate"><span class="pre">affiliation_changed</span></code>, <code class="docutils literal notranslate"><span class="pre">superseded</span></code>, <code class="docutils literal notranslate"><span class="pre">cessation_of_operation</span></code>, <code class="docutils literal notranslate"><span class="pre">certificate_hold</span></code>, <code class="docutils literal notranslate"><span class="pre">privilege_withdrawn</span></code>, <code class="docutils literal notranslate"><span class="pre">aa_compromise</span></code>, and <code class="docutils literal notranslate"><span class="pre">remove_from_crl</span></code>.</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-returned-bold">Returned:</span> success</p>
|
||||
<p class="ansible-option-line"><span class="ansible-option-choices">Can only return:</span></p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"unspecified"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"key_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"ca_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"affiliation_changed"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"superseded"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"cessation_of_operation"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"certificate_hold"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"privilege_withdrawn"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"aa_compromise"</span></code></p></li>
|
||||
<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">"remove_from_crl"</span></code></p></li>
|
||||
</ul>
|
||||
<p class="ansible-option-line ansible-option-sample"><span class="ansible-option-sample-bold">Sample:</span> <code class="ansible-option-sample docutils literal notranslate"><span class="pre">"key_compromise"</span></code></p>
|
||||
</div></td>
|
||||
</tr>
|
||||
|
||||
Reference in New Issue
Block a user