Modified: maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/sign-deployed-mojo.html ============================================================================== --- maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/sign-deployed-mojo.html (original) +++ maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/sign-deployed-mojo.html Sat Jun 28 08:56:46 2025 @@ -2,27 +2,26 @@ <!-- - | Generated by Apache Maven Doxia Site Renderer 1.11.1 from org.apache.maven.plugins:maven-plugin-report-plugin:3.13.1:report at 2024-09-24 - | Rendered using Apache Maven Fluido Skin 1.12.0 + | Generated by Apache Maven Doxia Site Renderer 2.0.0 from org.apache.maven.plugins:maven-plugin-report-plugin:3.15.1:report at 2025-06-28 + | Rendered using Apache Maven Fluido Skin 2.1.0 --> <html xmlns="http://www.w3.org/1999/xhtml"; lang="en"> <head> <meta charset="UTF-8" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> - <meta name="generator" content="Apache Maven Doxia Site Renderer 1.11.1" /> - <title>Apache Maven GPG Plugin – gpg:sign-deployed</title> - <link rel="stylesheet" href="./css/apache-maven-fluido-1.12.0.min.css" /> + <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" /> + <title>gpg:sign-deployed â Apache Maven GPG Plugin</title> + <link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.min.css" /> <link rel="stylesheet" href="./css/site.css" /> <link rel="stylesheet" href="./css/print.css" media="print" /> - <script src="./js/apache-maven-fluido-1.12.0.min.js"></script> - + <script src="./js/apache-maven-fluido-2.1.0.min.js"></script> <!-- Matomo --> <script> var _paq = window._paq = window._paq || []; - _paq.push(['disableCookies']); - _paq.push(['trackPageView']); - _paq.push(['enableLinkTracking']); - + _paq.push(['disableCookies']); + _paq.push(['trackPageView']); + _paq.push(['enableLinkTracking']); + (function() { var u="https://analytics.apache.org/";; _paq.push(['setTrackerUrl', u+'/matomo.php']); @@ -37,20 +36,20 @@ <div class="container-fluid container-fluid-top"> <header> <div id="banner"> - <div class="pull-left"><a href="https://www.apache.org/"; id="bannerLeft"><img src="../../images/apache-maven-project.png" style="" /></a></div> - <div class="pull-right"><a href="../../" id="bannerRight"><img src="../../images/maven-logo-black-on-white.png" style="" /></a></div> + <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/";><img src="../../images/apache-maven-project.png" /></a></h1></div></div> + <div class="pull-right"><div id="bannerRight"><h1><a href="../../"><img src="../../images/maven-logo-black-on-white.png" /></a></h1></div></div> <div class="clear"><hr/></div> </div> <div id="breadcrumbs"> <ul class="breadcrumb"> - <li><a href="https://www.apache.org/"; class="externalLink" title="Apache">Apache</a><span class="divider">/</span></li> - <li><a href="../../index.html" title="Maven">Maven</a><span class="divider">/</span></li> - <li><a href="../index.html" title="Plugins">Plugins</a><span class="divider">/</span></li> - <li><a href="index.html" title="Apache Maven GPG Plugin">Apache Maven GPG Plugin</a><span class="divider">/</span></li> - <li class="active ">gpg:sign-deployed</li> - <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2024-09-24</li> - <li id="projectVersion" class="pull-right">Version: 3.2.7</li> + <li><a href="https://www.apache.org/";>Apache</a><span class="divider">/</span></li> + <li><a href="../../index.html">Maven</a><span class="divider">/</span></li> + <li><a href="../index.html">Plugins</a><span class="divider">/</span></li> + <li><a href="index.html">Apache Maven GPG Plugin</a><span class="divider">/</span></li> + <li class="active">gpg:sign-deployed</li> + <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2025-06-28</li> + <li id="projectVersion" class="pull-right">Version: 3.2.8</li> </ul> </div> </header> @@ -59,108 +58,107 @@ <nav class="well sidebar-nav"> <ul class="nav nav-list"> <li class="nav-header">Overview</li> - <li><a href="index.html" title="Introduction"><span class="none"></span>Introduction</a></li> - <li><a href="plugin-info.html" title="Goals"><span class="none"></span>Goals</a></li> - <li><a href="usage.html" title="Usage"><span class="none"></span>Usage</a></li> - <li><a href="faq.html" title="FAQ"><span class="none"></span>FAQ</a></li> - <li><a href="http://www.apache.org/licenses/"; class="externalLink" title="License"><span class="none"></span>License</a></li> - <li><a href="download.html" title="Download"><span class="none"></span>Download</a></li> + <li><a href="index.html">Introduction</a></li> + <li><a href="plugin-info.html">Plugin Documentation</a></li> + <li><a href="usage.html">Usage</a></li> + <li><a href="faq.html">FAQ</a></li> + <li><a href="http://www.apache.org/licenses/";>License</a></li> + <li><a href="download.html">Download</a></li> <li class="nav-header">Examples</li> - <li><a href="examples/deploy-signed-artifacts.html" title="Deploy Signed Artifacts"><span class="none"></span>Deploy Signed Artifacts</a></li> + <li><a href="examples/deploy-signed-artifacts.html">Deploy Signed Artifacts</a></li> <li class="nav-header">Project Documentation</li> - <li><a href="project-info.html" title="Project Information"><span class="icon-chevron-right"></span>Project Information</a></li> - <li><a href="project-reports.html" title="Project Reports"><span class="icon-chevron-right"></span>Project Reports</a></li> + <li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li> + <li><a href="project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li> <li class="nav-header">Maven Projects</li> - <li><a href="../../ref/current" title="Maven"><span class="none"></span>Maven</a></li> - <li><a href="../../archetypes/index.html" title="Archetypes"><span class="none"></span>Archetypes</a></li> - <li><a href="../../extensions/index.html" title="Extensions"><span class="none"></span>Extensions</a></li> - <li><a href="../../pom/index.html" title="Parent POMs"><span class="none"></span>Parent POMs</a></li> - <li><a href="../index.html" title="Plugins"><span class="none"></span>Plugins</a></li> - <li><a href="../../skins/index.html" title="Skins"><span class="none"></span>Skins</a></li> - <li><a href="" title="Components"><span class="icon-chevron-down"></span>Components</a> + <li><a href="../../ref/current">Maven</a></li> + <li><a href="../../archetypes/index.html">Archetypes</a></li> + <li><a href="../../extensions/index.html">Extensions</a></li> + <li><a href="../../pom/index.html">Parent POMs</a></li> + <li><a href="../index.html">Plugins</a></li> + <li><a href="../../skins/index.html">Skins</a></li> + <li><a><span class="icon-chevron-down"></span>Components</a> <ul class="nav nav-list"> - <li><a href="../../archetype/index.html" title="Archetype"><span class="none"></span>Archetype</a></li> - <li><a href="../../resolver/index.html" title="Artifact Resolver"><span class="none"></span>Artifact Resolver</a></li> - <li><a href="../../doxia/index.html" title="Doxia"><span class="none"></span>Doxia</a></li> - <li><a href="../../maven-indexer/index.html" title="Indexer"><span class="none"></span>Indexer</a></li> - <li><a href="../../jxr/index.html" title="JXR"><span class="none"></span>JXR</a></li> - <li><a href="../../plugin-testing/index.html" title="Plugin Testing"><span class="none"></span>Plugin Testing</a></li> - <li><a href="../../plugin-tools/index.html" title="Plugin Tools"><span class="none"></span>Plugin Tools</a></li> - <li><a href="../../apache-resource-bundles/index.html" title="Resource Bundles"><span class="none"></span>Resource Bundles</a></li> - <li><a href="../../scm/index.html" title="SCM"><span class="none"></span>SCM</a></li> - <li><a href="../../shared/index.html" title="Shared Components"><span class="none"></span>Shared Components</a></li> - <li><a href="../../surefire/index.html" title="Surefire"><span class="none"></span>Surefire</a></li> - <li><a href="../../wagon/index.html" title="Wagon"><span class="none"></span>Wagon</a></li> + <li><a href="../../archetype/index.html">Archetype</a></li> + <li><a href="../../resolver/index.html">Artifact Resolver</a></li> + <li><a href="../../doxia/index.html">Doxia</a></li> + <li><a href="../../maven-indexer/index.html">Indexer</a></li> + <li><a href="../../jxr/index.html">JXR</a></li> + <li><a href="../../plugin-testing/index.html">Plugin Testing</a></li> + <li><a href="../../plugin-tools/index.html">Plugin Tools</a></li> + <li><a href="../../apache-resource-bundles/index.html">Resource Bundles</a></li> + <li><a href="../../scm/index.html">SCM</a></li> + <li><a href="../../shared/index.html">Shared Components</a></li> + <li><a href="../../surefire/index.html">Surefire</a></li> + <li><a href="../../wagon/index.html">Wagon</a></li> </ul></li> <li class="nav-header">ASF</li> - <li><a href="https://www.apache.org/foundation/how-it-works.html"; class="externalLink" title="How Apache Works"><span class="none"></span>How Apache Works</a></li> - <li><a href="https://www.apache.org/foundation/"; class="externalLink" title="Foundation"><span class="none"></span>Foundation</a></li> - <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html"; class="externalLink" title="Data Privacy"><span class="none"></span>Data Privacy</a></li> - <li><a href="https://www.apache.org/foundation/sponsorship.html"; class="externalLink" title="Sponsoring Apache"><span class="none"></span>Sponsoring Apache</a></li> - <li><a href="https://www.apache.org/foundation/thanks.html"; class="externalLink" title="Thanks"><span class="none"></span>Thanks</a></li> + <li><a href="https://www.apache.org/foundation/how-it-works.html";>How Apache Works</a></li> + <li><a href="https://www.apache.org/foundation/";>Foundation</a></li> + <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html";>Data Privacy</a></li> + <li><a href="https://www.apache.org/foundation/sponsorship.html";>Sponsoring Apache</a></li> + <li><a href="https://www.apache.org/foundation/thanks.html";>Thanks</a></li> </ul> </nav> <div class="well sidebar-nav"> <div id="poweredBy"> <div class="clear"></div> <div class="clear"></div> - <div class="clear"></div> -<a href="http://maven.apache.org/"; title="Built by Maven" class="poweredBy"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> +<a href="https://maven.apache.org/"; class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a> </div> </div> </header> - <main id="bodyColumn" class="span10" > -<section> -<h2><a name="gpg:sign-deployed"></a>gpg:sign-deployed</h2><a name="gpg:sign-deployed"></a> + <main id="bodyColumn" class="span10"> +<section><a id="gpg.3Asign-deployed"></a> +<h1>gpg:sign-deployed</h1> <p><strong>Full name</strong>:</p> -<p>org.apache.maven.plugins:maven-gpg-plugin:3.2.7:sign-deployed</p> +<p>org.apache.maven.plugins:maven-gpg-plugin:3.2.8:sign-deployed</p> <p><strong>Description</strong>:</p> <p>Resolves given artifacts from a given remote repository, signs them, and deploys the signatures next to signed artifacts, and cleans up afterward. This mojo will use "own" local repository for all the operations to not "pollute" user local repository, and also to be able to fully clean up (delete) after job done.</p> <p><strong>Attributes</strong>:</p> <ul> <li>The goal is thread-safe and supports parallel builds.</li> -<li>Since version: <code>3.2.3</code>.</li></ul><section> -<h3><a name="Required_Parameters"></a>Required Parameters</h3><a name="Required_Parameters"></a> -<table border="0" class="table table-striped"> +<li>Since version: <code>3.2.3</code>.</li></ul><section><a id="Required_Parameters"></a> +<h2>Required Parameters</h2> +<table class="table table-striped"> <tr class="a"> <th>Name</th> <th>Type</th> <th>Since</th> <th>Description</th></tr> <tr class="b"> -<td align="left"><a href="#javadoc"><code><javadoc></code></a></td> +<td><a href="#javadoc"><code><javadoc></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Should generate coordinates "javadoc" sub-artifacts?<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>javadoc</code></td></tr> <tr class="a"> -<td align="left"><a href="#repositoryId"><code><repositoryId></code></a></td> +<td><a href="#repositoryId"><code><repositoryId></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>Server ID to map on the <id> under <server> section of <code>settings.xml</code>. In most cases, this parameter will be required for authentication.<br /><strong>User Property</strong>: <code>repositoryId</code></td></tr> <tr class="b"> -<td align="left"><a href="#sources"><code><sources></code></a></td> +<td><a href="#sources"><code><sources></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Should generate coordinates "sources" sub-artifacts?<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>sources</code></td></tr> <tr class="a"> -<td align="left"><a href="#url"><code><url></code></a></td> +<td><a href="#url"><code><url></code></a></td> <td><code>String</code></td> <td><code>-</code></td> -<td>URL where the artifacts are deployed.<br /><strong>User Property</strong>: <code>url</code></td></tr></table></section><section> -<h3><a name="Optional_Parameters"></a>Optional Parameters</h3><a name="Optional_Parameters"></a> -<table border="0" class="table table-striped"> +<td>URL where the artifacts are deployed.<br /><strong>User Property</strong>: <code>url</code></td></tr></table></section><section><a id="Optional_Parameters"></a> +<h2>Optional Parameters</h2> +<table class="table table-striped"> <tr class="a"> <th>Name</th> <th>Type</th> <th>Since</th> <th>Description</th></tr> <tr class="b"> -<td align="left"><a href="#agentSocketLocations"><code><agentSocketLocations></code></a></td> +<td><a href="#agentSocketLocations"><code><agentSocketLocations></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td>BC Signer only: The comma separate list of Unix Domain Socket paths, to use to communicate with GnuPG agent. If relative, they are resolved against user home directory.<br /><strong>Default</strong>: <code>.gnupg/S.gpg-agent</code><br /><strong>User Property</strong>: <code>gpg.agentSocketLocations</code></td></tr> <tr class="a"> -<td align="left"><a href="#artifacts"><code><artifacts></code></a></td> +<td><a href="#artifacts"><code><artifacts></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>If no <a href="apidocs/org/apache/maven/plugins/gpg/ArtifactCollectorSPI.html"><code>ArtifactCollectorSPI</code></a> is added, this Mojo will fall back to this parameter to collect GAVs that are deployed and needs signatures deployed next to them. This parameter can contain multiple things: @@ -170,22 +168,22 @@ </ul> <p>Note: format of GAV entries must be <code><groupId>:<artifactId>[:<extension>[:<classifier>]]:<version></code>.</p><br /><strong>User Property</strong>: <code>artifacts</code></td></tr> <tr class="b"> -<td align="left"><a href="#bestPractices"><code><bestPractices></code></a></td> +<td><a href="#bestPractices"><code><bestPractices></code></a></td> <td><code>boolean</code></td> <td><code>3.2.0</code></td> <td>Switch to improve plugin enforcement of "best practices". If set to <code>false</code>, plugin retains all the backward compatibility regarding getting secrets (but will warn). If set to <code>true</code>, plugin will fail if any "bad practices" regarding sensitive data handling are detected. By default, plugin remains backward compatible (this flag is <code>false</code>). Somewhere in the future, when this parameter enabling transitioning from older plugin versions is removed, the logic using this flag will be modified like it is set to <code>true</code>. It is warmly advised to configure this parameter to <code>true</code> and migrate project and user environment regarding how sensitive information is stored.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>gpg.bestPractices</code></td></tr> <tr class="a"> -<td align="left"><a href="#defaultKeyring"><code><defaultKeyring></code></a></td> +<td><a href="#defaultKeyring"><code><defaultKeyring></code></a></td> <td><code>boolean</code></td> <td><code>1.2</code></td> <td>GPG Signer only: Whether to add the default keyrings from gpg's home directory to the list of used keyrings.<br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>gpg.defaultKeyring</code></td></tr> <tr class="b"> -<td align="left"><a href="#executable"><code><executable></code></a></td> +<td><a href="#executable"><code><executable></code></a></td> <td><code>String</code></td> <td><code>1.1</code></td> <td>GPG Signer only: The path to the GnuPG executable to use for artifact signing. Defaults to either "gpg" or "gpg.exe" depending on the operating system.<br /><strong>User Property</strong>: <code>gpg.executable</code></td></tr> <tr class="a"> -<td align="left"><a href="#gpgArguments"><code><gpgArguments></code></a></td> +<td><a href="#gpgArguments"><code><gpgArguments></code></a></td> <td><code>List<String></code></td> <td><code>1.5</code></td> <td>GPG Signer only: Sets the arguments to be passed to gpg. Example: @@ -195,105 +193,105 @@ </gpgArguments> </pre></td></tr> <tr class="b"> -<td align="left"><a href="#homedir"><code><homedir></code></a></td> +<td><a href="#homedir"><code><homedir></code></a></td> <td><code>File</code></td> <td><code>1.0</code></td> <td>GPG Signer only: The directory from which gpg will load keyrings. If not specified, gpg will use the value configured for its installation, e.g. <code>~/.gnupg</code> or <code>%APPDATA%/gnupg</code>.<br /><strong>User Property</strong>: <code>gpg.homedir</code></td></tr> <tr class="a"> -<td align="left"><a href="#keyEnvName"><code><keyEnvName></code></a></td> +<td><a href="#keyEnvName"><code><keyEnvName></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td>BC Signer only: The env variable name where the GnuPG key is set. To use BC Signer you must provide GnuPG key, as it does not use GnuPG home directory to extract/find the key (while it does use GnuPG Agent to ask for password in interactive mode). The key should be in <a href="https://openpgp.dev/book/private_keys.html#transferable-secret-key-format";>TSK format</a> and may be passphrase protected.<br /><strong>Default</strong>: <code>MAVEN_GPG_KEY</code><br /><strong>User Property</strong>: <code>gpg.keyEnvName</code></td></tr> <tr class="b"> -<td align="left"><a href="#keyFilePath"><code><keyFilePath></code></a></td> +<td><a href="#keyFilePath"><code><keyFilePath></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td>BC Signer only: The path of the exported key in <a href="https://openpgp.dev/book/private_keys.html#transferable-secret-key-format";>TSK format</a>, and may be passphrase protected. If relative, the file is resolved against user home directory. <p><em>Note: it is not recommended to have sensitive files checked into SCM repository. Key file should reside on developer workstation, outside of SCM tracked repository. For CI-like use cases you should set the key material as env variable instead.</em></p><br /><strong>Default</strong>: <code>maven-signing-key.key</code><br /><strong>User Property</strong>: <code>gpg.keyFilePath</code></td></tr> <tr class="a"> -<td align="left"><a href="#keyFingerprint"><code><keyFingerprint></code></a></td> +<td><a href="#keyFingerprint"><code><keyFingerprint></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td>BC Signer only: The fingerprint of the key to use for signing. If not given, first key in keyring will be used.<br /><strong>User Property</strong>: <code>gpg.keyFingerprint</code></td></tr> <tr class="b"> -<td align="left"><a href="#keyFingerprintEnvName"><code><keyFingerprintEnvName></code></a></td> +<td><a href="#keyFingerprintEnvName"><code><keyFingerprintEnvName></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td>BC Signer only: The env variable name where the GnuPG key fingerprint is set, if the provided keyring contains multiple keys.<br /><strong>Default</strong>: <code>MAVEN_GPG_KEY_FINGERPRINT</code><br /><strong>User Property</strong>: <code>gpg.keyFingerprintEnvName</code></td></tr> <tr class="a"> -<td align="left"><a href="#keyname"><code><keyname></code></a></td> +<td><a href="#keyname"><code><keyname></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td>GPG Signer only: The "name" of the key to sign with. Passed to gpg as <code>--local-user</code>.<br /><strong>User Property</strong>: <code>gpg.keyname</code></td></tr> <tr class="b"> -<td align="left"><a href="#lockMode"><code><lockMode></code></a></td> +<td><a href="#lockMode"><code><lockMode></code></a></td> <td><code>String</code></td> <td><code>1.5</code></td> <td>GPG Signer only: The lock mode to use when invoking gpg. By default no lock mode will be specified. Valid values are <code>once</code>, <code>multiple</code> and <code>never</code>. The lock mode gets translated into the corresponding <code>--lock-___</code> command line argument. Improper usage of this option may lead to data and key corruption.<br /><strong>See also:</strong> <a href="http://www.gnupg.org/documentation/manuals/gnupg/GPG-Configuration-Options.html";>the --lock-options</a><br /><strong>User Property</strong>: <code>gpg.lockMode</code></td></tr> <tr class="a"> -<td align="left"><a href="#passphrase"><code><passphrase></code></a></td> +<td><a href="#passphrase"><code><passphrase></code></a></td> <td><code>String</code></td> <td><code>-</code></td> <td> <div><strong>Deprecated.</strong><br />Do not use this configuration, it may leak sensitive information. Rely on gpg-agent or env variables instead.</div><br />The passphrase to use when signing. If not given, look up the value under Maven settings using server id at 'passphraseServerKey' configuration. <em>Do not use this parameter, it leaks sensitive data. Passphrase should be provided only via gpg-agent or via env variable. If parameter <a href="#bestPractices"><code>bestPractices</code></a> set to <code>true</code>, plugin fails when this parameter is configured.</em><br /><strong>User Property</strong>: <code>gpg.passphrase</code></td></tr> <tr class="b"> -<td align="left"><a href="#passphraseEnvName"><code><passphraseEnvName></code></a></td> +<td><a href="#passphraseEnvName"><code><passphraseEnvName></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td>The env variable name where the GnuPG passphrase is set. This is the recommended way to pass passphrase for signing in batch mode execution of Maven.<br /><strong>Default</strong>: <code>MAVEN_GPG_PASSPHRASE</code><br /><strong>User Property</strong>: <code>gpg.passphraseEnvName</code></td></tr> <tr class="a"> -<td align="left"><a href="#passphraseServerId"><code><passphraseServerId></code></a></td> +<td><a href="#passphraseServerId"><code><passphraseServerId></code></a></td> <td><code>String</code></td> <td><code>1.6</code></td> <td> <div><strong>Deprecated.</strong><br />Do not use this configuration, it may leak sensitive information. Rely on gpg-agent or env variables instead.</div><br />Server id to lookup the passphrase under Maven settings. <em>Do not use this parameter, it leaks sensitive data. Passphrase should be provided only via gpg-agent or via env variable. If parameter <a href="#bestPractices"><code>bestPractices</code></a> set to <code>true</code>, plugin fails when this parameter is configured.</em> Is programatically defaulted to <a href="#GPG_PASSPHRASE"><code>GPG_PASSPHRASE</code></a>.<br /><strong>User Property</strong>: <code>gpg.passphraseServerId</code></td></tr> <tr class="b"> -<td align="left"><a href="#publicKeyring"><code><publicKeyring></code></a></td> +<td><a href="#publicKeyring"><code><publicKeyring></code></a></td> <td><code>String</code></td> <td><code>1.2</code></td> <td> <div><strong>Deprecated.</strong><br />Obsolete option since GnuPG 2.1 version.</div><br />GPG Signer only: The path to a public keyring to add to the list of keyrings. By default, only the <code>pubring.gpg</code> from gpg's home directory is considered. Use this option (and <a href="#defaultKeyring"><code>defaultKeyring</code></a> if required) to use a different public key. <em>Note:</em> Relative paths are resolved against gpg's home directory, not the project base directory. <p><strong>NOTE: </strong>As of gpg 2.1 this is an obsolete option and ignored. All public keys are stored in the âpubring.kbxâ file below the GnuPG home directory.</p><br /><strong>User Property</strong>: <code>gpg.publicKeyring</code></td></tr> <tr class="a"> -<td align="left"><a href="#secretKeyring"><code><secretKeyring></code></a></td> +<td><a href="#secretKeyring"><code><secretKeyring></code></a></td> <td><code>String</code></td> <td><code>1.2</code></td> <td> <div><strong>Deprecated.</strong><br />Obsolete option since GnuPG 2.1 version.</div><br />GPG Signer only: The path to a secret keyring to add to the list of keyrings. By default, only the <code>secring.gpg</code> from gpg's home directory is considered. Use this option (in combination with <a href="#publicKeyring"><code>publicKeyring</code></a> and <a href="#defaultKeyring"><code>defaultKeyring</code></a> if required) to use a different secret key. <em>Note:</em> Relative paths are resolved against gpg's home directory, not the project base directory. <p><strong>NOTE: </strong>As of gpg 2.1 this is an obsolete option and ignored. All secret keys are stored in the âprivate-keys-v1.dâ directory below the GnuPG home directory.</p><br /><strong>User Property</strong>: <code>gpg.secretKeyring</code></td></tr> <tr class="b"> -<td align="left"><a href="#signer"><code><signer></code></a></td> +<td><a href="#signer"><code><signer></code></a></td> <td><code>String</code></td> <td><code>3.2.0</code></td> <td>The name of the Signer implementation to use. Accepted values are <code>"gpg"</code> (the default, uses GnuPG executable) and <code>"bc"</code> (uses Bouncy Castle pure Java signer).<br /><strong>Default</strong>: <code>gpg</code><br /><strong>User Property</strong>: <code>gpg.signer</code></td></tr> <tr class="a"> -<td align="left"><a href="#skip"><code><skip></code></a></td> +<td><a href="#skip"><code><skip></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>Skip doing the gpg signing.<br /><strong>Default</strong>: <code>false</code><br /><strong>User Property</strong>: <code>gpg.skip</code></td></tr> <tr class="b"> -<td align="left"><a href="#terminatePassphrase"><code><terminatePassphrase></code></a></td> +<td><a href="#terminatePassphrase"><code><terminatePassphrase></code></a></td> <td><code>boolean</code></td> <td><code>3.2.7</code></td> <td>Whether to terminate the passphrase with LF character or not, as on some systems and some GPG executable combinations lack of trailing LF may cause GPG to not detect passphrase on STDIN. Since 3.2.0 it was always appended, unless passphrase itself ended with it. Note: before 3.2.7 the "line separator" was used for termination, that on other hand caused issues on Windows, where line separator is CRLF while GPG handles LF only. This parameter affects ONLY the GPG signer, not the BC signer. <p>By default, this parameter is <code>true</code>.</p><br /><strong>See also:</strong> <a href="https://issues.apache.org/jira/browse/MGPG-99";>MGPG-99</a>, <a href="https://issues.apache.org/jira/browse/MGPG-136";>MGPG-136</a><br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>gpg.terminatePassphrase</code></td></tr> <tr class="a"> -<td align="left"><a href="#useAgent"><code><useAgent></code></a></td> +<td><a href="#useAgent"><code><useAgent></code></a></td> <td><code>boolean</code></td> <td><code>-</code></td> <td>All signers: whether gpg-agent is allowed to be used or not. If enabled, passphrase is optional, as agent may provide it. Have to be noted, that in "batch" mode, gpg-agent will be prevented to pop up pinentry dialogue, hence best is to "prime" the agent caches beforehand. <p>GPG Signer: Passes <code>--use-agent</code> or <code>--no-use-agent</code> option to gpg if it is version 2.1 or older. Otherwise, will use an agent. In non-interactive mode gpg options are appended with <code>--pinentry-mode error</code>, preventing gpg agent to pop up pinentry dialogue. Agent will be able to hand over only cached passwords.</p> -<p>BC Signer: Allows signer to communicate with gpg agent. In non-interactive mode it uses <code>--no-ask</code> option with the <code>GET_PASSPHRASE</code> function. Agent will be able to hand over only cached passwords.</p><br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>gpg.useagent</code></td></tr></table></section><section> -<h3><a name="Parameter_Details"></a>Parameter Details</h3><a name="Parameter_Details"></a><a name="agentSocketLocations"></a><section> -<h4><a name="a.3CagentSocketLocations.3E"></a><agentSocketLocations></h4><a name="a.3CagentSocketLocations.3E"></a> +<p>BC Signer: Allows signer to communicate with gpg agent. In non-interactive mode it uses <code>--no-ask</code> option with the <code>GET_PASSPHRASE</code> function. Agent will be able to hand over only cached passwords.</p><br /><strong>Default</strong>: <code>true</code><br /><strong>User Property</strong>: <code>gpg.useagent</code></td></tr></table></section><section><a id="Parameter_Details"></a> +<h2>Parameter Details</h2><a id="agentSocketLocations"></a><section><a id="a.3CagentSocketLocations.3E"></a> +<h3><agentSocketLocations></h3> <div>BC Signer only: The comma separate list of Unix Domain Socket paths, to use to communicate with GnuPG agent. If relative, they are resolved against user home directory.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.agentSocketLocations</code></li> -<li><strong>Default</strong>: <code>.gnupg/S.gpg-agent</code></li></ul><hr /></section><a name="artifacts"></a><section> -<h4><a name="a.3Cartifacts.3E"></a><artifacts></h4><a name="a.3Cartifacts.3E"></a> +<li><strong>Default</strong>: <code>.gnupg/S.gpg-agent</code></li></ul><hr /></section><a id="artifacts"></a><section><a id="a.3Cartifacts.3E"></a> +<h3><artifacts></h3> <div>If no <a href="apidocs/org/apache/maven/plugins/gpg/ArtifactCollectorSPI.html"><code>ArtifactCollectorSPI</code></a> is added, this Mojo will fall back to this parameter to collect GAVs that are deployed and needs signatures deployed next to them. This parameter can contain multiple things: <ul> <li>A path to an existing file, that contains one GAV spec at a line. File may also contain empty lines or lines starting with <code>#</code> that will be ignored.</li> @@ -303,31 +301,31 @@ <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>artifacts</code></li></ul><hr /></section><a name="bestPractices"></a><section> -<h4><a name="a.3CbestPractices.3E"></a><bestPractices></h4><a name="a.3CbestPractices.3E"></a> +<li><strong>User Property</strong>: <code>artifacts</code></li></ul><hr /></section><a id="bestPractices"></a><section><a id="a.3CbestPractices.3E"></a> +<h3><bestPractices></h3> <div>Switch to improve plugin enforcement of "best practices". If set to <code>false</code>, plugin retains all the backward compatibility regarding getting secrets (but will warn). If set to <code>true</code>, plugin will fail if any "bad practices" regarding sensitive data handling are detected. By default, plugin remains backward compatible (this flag is <code>false</code>). Somewhere in the future, when this parameter enabling transitioning from older plugin versions is removed, the logic using this flag will be modified like it is set to <code>true</code>. It is warmly advised to configure this parameter to <code>true</code> and migrate project and user environment regarding how sensitive information is stored.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.bestPractices</code></li> -<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="defaultKeyring"></a><section> -<h4><a name="a.3CdefaultKeyring.3E"></a><defaultKeyring></h4><a name="a.3CdefaultKeyring.3E"></a> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="defaultKeyring"></a><section><a id="a.3CdefaultKeyring.3E"></a> +<h3><defaultKeyring></h3> <div>GPG Signer only: Whether to add the default keyrings from gpg's home directory to the list of used keyrings.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Since</strong>: <code>1.2</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.defaultKeyring</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="executable"></a><section> -<h4><a name="a.3Cexecutable.3E"></a><executable></h4><a name="a.3Cexecutable.3E"></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a id="executable"></a><section><a id="a.3Cexecutable.3E"></a> +<h3><executable></h3> <div>GPG Signer only: The path to the GnuPG executable to use for artifact signing. Defaults to either "gpg" or "gpg.exe" depending on the operating system.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>1.1</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.executable</code></li></ul><hr /></section><a name="gpgArguments"></a><section> -<h4><a name="a.3CgpgArguments.3E"></a><gpgArguments></h4><a name="a.3CgpgArguments.3E"></a> +<li><strong>User Property</strong>: <code>gpg.executable</code></li></ul><hr /></section><a id="gpgArguments"></a><section><a id="a.3CgpgArguments.3E"></a> +<h3><gpgArguments></h3> <div>GPG Signer only: Sets the arguments to be passed to gpg. Example: <pre><gpgArguments> <arg>--no-random-seed-file</arg> @@ -337,30 +335,30 @@ <ul> <li><strong>Type</strong>: <code>java.util.List<java.lang.String></code></li> <li><strong>Since</strong>: <code>1.5</code></li> -<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a name="homedir"></a><section> -<h4><a name="a.3Chomedir.3E"></a><homedir></h4><a name="a.3Chomedir.3E"></a> +<li><strong>Required</strong>: <code>No</code></li></ul><hr /></section><a id="homedir"></a><section><a id="a.3Chomedir.3E"></a> +<h3><homedir></h3> <div>GPG Signer only: The directory from which gpg will load keyrings. If not specified, gpg will use the value configured for its installation, e.g. <code>~/.gnupg</code> or <code>%APPDATA%/gnupg</code>.</div> <ul> <li><strong>Type</strong>: <code>java.io.File</code></li> <li><strong>Since</strong>: <code>1.0</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.homedir</code></li></ul><hr /></section><a name="javadoc"></a><section> -<h4><a name="a.3Cjavadoc.3E"></a><javadoc></h4><a name="a.3Cjavadoc.3E"></a> +<li><strong>User Property</strong>: <code>gpg.homedir</code></li></ul><hr /></section><a id="javadoc"></a><section><a id="a.3Cjavadoc.3E"></a> +<h3><javadoc></h3> <div>Should generate coordinates "javadoc" sub-artifacts?</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Required</strong>: <code>Yes</code></li> <li><strong>User Property</strong>: <code>javadoc</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="keyEnvName"></a><section> -<h4><a name="a.3CkeyEnvName.3E"></a><keyEnvName></h4><a name="a.3CkeyEnvName.3E"></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a id="keyEnvName"></a><section><a id="a.3CkeyEnvName.3E"></a> +<h3><keyEnvName></h3> <div>BC Signer only: The env variable name where the GnuPG key is set. To use BC Signer you must provide GnuPG key, as it does not use GnuPG home directory to extract/find the key (while it does use GnuPG Agent to ask for password in interactive mode). The key should be in <a href="https://openpgp.dev/book/private_keys.html#transferable-secret-key-format";>TSK format</a> and may be passphrase protected.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.keyEnvName</code></li> -<li><strong>Default</strong>: <code>MAVEN_GPG_KEY</code></li></ul><hr /></section><a name="keyFilePath"></a><section> -<h4><a name="a.3CkeyFilePath.3E"></a><keyFilePath></h4><a name="a.3CkeyFilePath.3E"></a> +<li><strong>Default</strong>: <code>MAVEN_GPG_KEY</code></li></ul><hr /></section><a id="keyFilePath"></a><section><a id="a.3CkeyFilePath.3E"></a> +<h3><keyFilePath></h3> <div>BC Signer only: The path of the exported key in <a href="https://openpgp.dev/book/private_keys.html#transferable-secret-key-format";>TSK format</a>, and may be passphrase protected. If relative, the file is resolved against user home directory. <p><em>Note: it is not recommended to have sensitive files checked into SCM repository. Key file should reside on developer workstation, outside of SCM tracked repository. For CI-like use cases you should set the key material as env variable instead.</em></p></div> <ul> @@ -368,59 +366,59 @@ <li><strong>Since</strong>: <code>3.2.0</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.keyFilePath</code></li> -<li><strong>Default</strong>: <code>maven-signing-key.key</code></li></ul><hr /></section><a name="keyFingerprint"></a><section> -<h4><a name="a.3CkeyFingerprint.3E"></a><keyFingerprint></h4><a name="a.3CkeyFingerprint.3E"></a> +<li><strong>Default</strong>: <code>maven-signing-key.key</code></li></ul><hr /></section><a id="keyFingerprint"></a><section><a id="a.3CkeyFingerprint.3E"></a> +<h3><keyFingerprint></h3> <div>BC Signer only: The fingerprint of the key to use for signing. If not given, first key in keyring will be used.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.keyFingerprint</code></li></ul><hr /></section><a name="keyFingerprintEnvName"></a><section> -<h4><a name="a.3CkeyFingerprintEnvName.3E"></a><keyFingerprintEnvName></h4><a name="a.3CkeyFingerprintEnvName.3E"></a> +<li><strong>User Property</strong>: <code>gpg.keyFingerprint</code></li></ul><hr /></section><a id="keyFingerprintEnvName"></a><section><a id="a.3CkeyFingerprintEnvName.3E"></a> +<h3><keyFingerprintEnvName></h3> <div>BC Signer only: The env variable name where the GnuPG key fingerprint is set, if the provided keyring contains multiple keys.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.keyFingerprintEnvName</code></li> -<li><strong>Default</strong>: <code>MAVEN_GPG_KEY_FINGERPRINT</code></li></ul><hr /></section><a name="keyname"></a><section> -<h4><a name="a.3Ckeyname.3E"></a><keyname></h4><a name="a.3Ckeyname.3E"></a> +<li><strong>Default</strong>: <code>MAVEN_GPG_KEY_FINGERPRINT</code></li></ul><hr /></section><a id="keyname"></a><section><a id="a.3Ckeyname.3E"></a> +<h3><keyname></h3> <div>GPG Signer only: The "name" of the key to sign with. Passed to gpg as <code>--local-user</code>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.keyname</code></li></ul><hr /></section><a name="lockMode"></a><section> -<h4><a name="a.3ClockMode.3E"></a><lockMode></h4><a name="a.3ClockMode.3E"></a> +<li><strong>User Property</strong>: <code>gpg.keyname</code></li></ul><hr /></section><a id="lockMode"></a><section><a id="a.3ClockMode.3E"></a> +<h3><lockMode></h3> <div>GPG Signer only: The lock mode to use when invoking gpg. By default no lock mode will be specified. Valid values are <code>once</code>, <code>multiple</code> and <code>never</code>. The lock mode gets translated into the corresponding <code>--lock-___</code> command line argument. Improper usage of this option may lead to data and key corruption.<br /><strong>See also:</strong> <a href="http://www.gnupg.org/documentation/manuals/gnupg/GPG-Configuration-Options.html";>the --lock-options</a></div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>1.5</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.lockMode</code></li></ul><hr /></section><a name="passphrase"></a><section> -<h4><a name="a.3Cpassphrase.3E"></a><passphrase></h4><a name="a.3Cpassphrase.3E"></a> +<li><strong>User Property</strong>: <code>gpg.lockMode</code></li></ul><hr /></section><a id="passphrase"></a><section><a id="a.3Cpassphrase.3E"></a> +<h3><passphrase></h3> <div><strong>Deprecated.</strong><br />Do not use this configuration, it may leak sensitive information. Rely on gpg-agent or env variables instead.</div><br /> <div>The passphrase to use when signing. If not given, look up the value under Maven settings using server id at 'passphraseServerKey' configuration. <em>Do not use this parameter, it leaks sensitive data. Passphrase should be provided only via gpg-agent or via env variable. If parameter <a href="#bestPractices"><code>bestPractices</code></a> set to <code>true</code>, plugin fails when this parameter is configured.</em></div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.passphrase</code></li></ul><hr /></section><a name="passphraseEnvName"></a><section> -<h4><a name="a.3CpassphraseEnvName.3E"></a><passphraseEnvName></h4><a name="a.3CpassphraseEnvName.3E"></a> +<li><strong>User Property</strong>: <code>gpg.passphrase</code></li></ul><hr /></section><a id="passphraseEnvName"></a><section><a id="a.3CpassphraseEnvName.3E"></a> +<h3><passphraseEnvName></h3> <div>The env variable name where the GnuPG passphrase is set. This is the recommended way to pass passphrase for signing in batch mode execution of Maven.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.passphraseEnvName</code></li> -<li><strong>Default</strong>: <code>MAVEN_GPG_PASSPHRASE</code></li></ul><hr /></section><a name="passphraseServerId"></a><section> -<h4><a name="a.3CpassphraseServerId.3E"></a><passphraseServerId></h4><a name="a.3CpassphraseServerId.3E"></a> +<li><strong>Default</strong>: <code>MAVEN_GPG_PASSPHRASE</code></li></ul><hr /></section><a id="passphraseServerId"></a><section><a id="a.3CpassphraseServerId.3E"></a> +<h3><passphraseServerId></h3> <div><strong>Deprecated.</strong><br />Do not use this configuration, it may leak sensitive information. Rely on gpg-agent or env variables instead.</div><br /> <div>Server id to lookup the passphrase under Maven settings. <em>Do not use this parameter, it leaks sensitive data. Passphrase should be provided only via gpg-agent or via env variable. If parameter <a href="#bestPractices"><code>bestPractices</code></a> set to <code>true</code>, plugin fails when this parameter is configured.</em> Is programatically defaulted to <a href="#GPG_PASSPHRASE"><code>GPG_PASSPHRASE</code></a>.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>1.6</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.passphraseServerId</code></li></ul><hr /></section><a name="publicKeyring"></a><section> -<h4><a name="a.3CpublicKeyring.3E"></a><publicKeyring></h4><a name="a.3CpublicKeyring.3E"></a> +<li><strong>User Property</strong>: <code>gpg.passphraseServerId</code></li></ul><hr /></section><a id="publicKeyring"></a><section><a id="a.3CpublicKeyring.3E"></a> +<h3><publicKeyring></h3> <div><strong>Deprecated.</strong><br />Obsolete option since GnuPG 2.1 version.</div><br /> <div>GPG Signer only: The path to a public keyring to add to the list of keyrings. By default, only the <code>pubring.gpg</code> from gpg's home directory is considered. Use this option (and <a href="#defaultKeyring"><code>defaultKeyring</code></a> if required) to use a different public key. <em>Note:</em> Relative paths are resolved against gpg's home directory, not the project base directory. <p><strong>NOTE: </strong>As of gpg 2.1 this is an obsolete option and ignored. All public keys are stored in the âpubring.kbxâ file below the GnuPG home directory.</p></div> @@ -428,14 +426,14 @@ <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>1.2</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.publicKeyring</code></li></ul><hr /></section><a name="repositoryId"></a><section> -<h4><a name="a.3CrepositoryId.3E"></a><repositoryId></h4><a name="a.3CrepositoryId.3E"></a> +<li><strong>User Property</strong>: <code>gpg.publicKeyring</code></li></ul><hr /></section><a id="repositoryId"></a><section><a id="a.3CrepositoryId.3E"></a> +<h3><repositoryId></h3> <div>Server ID to map on the <id> under <server> section of <code>settings.xml</code>. In most cases, this parameter will be required for authentication.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>Yes</code></li> -<li><strong>User Property</strong>: <code>repositoryId</code></li></ul><hr /></section><a name="secretKeyring"></a><section> -<h4><a name="a.3CsecretKeyring.3E"></a><secretKeyring></h4><a name="a.3CsecretKeyring.3E"></a> +<li><strong>User Property</strong>: <code>repositoryId</code></li></ul><hr /></section><a id="secretKeyring"></a><section><a id="a.3CsecretKeyring.3E"></a> +<h3><secretKeyring></h3> <div><strong>Deprecated.</strong><br />Obsolete option since GnuPG 2.1 version.</div><br /> <div>GPG Signer only: The path to a secret keyring to add to the list of keyrings. By default, only the <code>secring.gpg</code> from gpg's home directory is considered. Use this option (in combination with <a href="#publicKeyring"><code>publicKeyring</code></a> and <a href="#defaultKeyring"><code>defaultKeyring</code></a> if required) to use a different secret key. <em>Note:</em> Relative paths are resolved against gpg's home directory, not the project base directory. <p><strong>NOTE: </strong>As of gpg 2.1 this is an obsolete option and ignored. All secret keys are stored in the âprivate-keys-v1.dâ directory below the GnuPG home directory.</p></div> @@ -443,30 +441,30 @@ <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>1.2</code></li> <li><strong>Required</strong>: <code>No</code></li> -<li><strong>User Property</strong>: <code>gpg.secretKeyring</code></li></ul><hr /></section><a name="signer"></a><section> -<h4><a name="a.3Csigner.3E"></a><signer></h4><a name="a.3Csigner.3E"></a> +<li><strong>User Property</strong>: <code>gpg.secretKeyring</code></li></ul><hr /></section><a id="signer"></a><section><a id="a.3Csigner.3E"></a> +<h3><signer></h3> <div>The name of the Signer implementation to use. Accepted values are <code>"gpg"</code> (the default, uses GnuPG executable) and <code>"bc"</code> (uses Bouncy Castle pure Java signer).</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Since</strong>: <code>3.2.0</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.signer</code></li> -<li><strong>Default</strong>: <code>gpg</code></li></ul><hr /></section><a name="skip"></a><section> -<h4><a name="a.3Cskip.3E"></a><skip></h4><a name="a.3Cskip.3E"></a> +<li><strong>Default</strong>: <code>gpg</code></li></ul><hr /></section><a id="skip"></a><section><a id="a.3Cskip.3E"></a> +<h3><skip></h3> <div>Skip doing the gpg signing.</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.skip</code></li> -<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a name="sources"></a><section> -<h4><a name="a.3Csources.3E"></a><sources></h4><a name="a.3Csources.3E"></a> +<li><strong>Default</strong>: <code>false</code></li></ul><hr /></section><a id="sources"></a><section><a id="a.3Csources.3E"></a> +<h3><sources></h3> <div>Should generate coordinates "sources" sub-artifacts?</div> <ul> <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Required</strong>: <code>Yes</code></li> <li><strong>User Property</strong>: <code>sources</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="terminatePassphrase"></a><section> -<h4><a name="a.3CterminatePassphrase.3E"></a><terminatePassphrase></h4><a name="a.3CterminatePassphrase.3E"></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a id="terminatePassphrase"></a><section><a id="a.3CterminatePassphrase.3E"></a> +<h3><terminatePassphrase></h3> <div>Whether to terminate the passphrase with LF character or not, as on some systems and some GPG executable combinations lack of trailing LF may cause GPG to not detect passphrase on STDIN. Since 3.2.0 it was always appended, unless passphrase itself ended with it. Note: before 3.2.7 the "line separator" was used for termination, that on other hand caused issues on Windows, where line separator is CRLF while GPG handles LF only. This parameter affects ONLY the GPG signer, not the BC signer. <p>By default, this parameter is <code>true</code>.</p><br /><strong>See also:</strong> <a href="https://issues.apache.org/jira/browse/MGPG-99";>MGPG-99</a>, <a href="https://issues.apache.org/jira/browse/MGPG-136";>MGPG-136</a></div> <ul> @@ -474,14 +472,14 @@ <li><strong>Since</strong>: <code>3.2.7</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.terminatePassphrase</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a name="url"></a><section> -<h4><a name="a.3Curl.3E"></a><url></h4><a name="a.3Curl.3E"></a> +<li><strong>Default</strong>: <code>true</code></li></ul><hr /></section><a id="url"></a><section><a id="a.3Curl.3E"></a> +<h3><url></h3> <div>URL where the artifacts are deployed.</div> <ul> <li><strong>Type</strong>: <code>java.lang.String</code></li> <li><strong>Required</strong>: <code>Yes</code></li> -<li><strong>User Property</strong>: <code>url</code></li></ul><hr /></section><a name="useAgent"></a><section> -<h4><a name="a.3CuseAgent.3E"></a><useAgent></h4><a name="a.3CuseAgent.3E"></a> +<li><strong>User Property</strong>: <code>url</code></li></ul><hr /></section><a id="useAgent"></a><section><a id="a.3CuseAgent.3E"></a> +<h3><useAgent></h3> <div>All signers: whether gpg-agent is allowed to be used or not. If enabled, passphrase is optional, as agent may provide it. Have to be noted, that in "batch" mode, gpg-agent will be prevented to pop up pinentry dialogue, hence best is to "prime" the agent caches beforehand. <p>GPG Signer: Passes <code>--use-agent</code> or <code>--no-use-agent</code> option to gpg if it is version 2.1 or older. Otherwise, will use an agent. In non-interactive mode gpg options are appended with <code>--pinentry-mode error</code>, preventing gpg agent to pop up pinentry dialogue. Agent will be able to hand over only cached passwords.</p> <p>BC Signer: Allows signer to communicate with gpg agent. In non-interactive mode it uses <code>--no-ask</code> option with the <code>GET_PASSPHRASE</code> function. Agent will be able to hand over only cached passwords.</p></div> @@ -489,24 +487,18 @@ <li><strong>Type</strong>: <code>boolean</code></li> <li><strong>Required</strong>: <code>No</code></li> <li><strong>User Property</strong>: <code>gpg.useagent</code></li> -<li><strong>Default</strong>: <code>true</code></li></ul></section></section></section> - </main> +<li><strong>Default</strong>: <code>true</code></li></ul></section></section></section> </main> </div> </div> <hr/> <footer> <div class="container-fluid"> <div class="row-fluid"> - <p>© 2002â2024 + <p>© 2002â2025 <a href="https://www.apache.org/";>The Apache Software Foundation</a> </p> </div> </div> </footer> -<script> - if(anchors) { - anchors.add(); - } -</script> </body> </html> \ No newline at end of file
