Modified:
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/AbstractGpgMojo.html
==============================================================================
---
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/AbstractGpgMojo.html
(original)
+++
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/AbstractGpgMojo.html
Tue Apr 16 13:25:58 2024
@@ -139,309 +139,322 @@
<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em
class="jxr_javadoccomment"> * Server id to lookup the passphrase under
Maven settings. <em>Do not use this parameter, it leaks</em>
<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em
class="jxr_javadoccomment"> * sensitive data. Passphrase should be provided
only via gpg-agent or via env variable.</em>
<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em
class="jxr_javadoccomment"> * If parameter {@link #bestPractices} set to
{@code true}, plugin fails when this parameter is configured.</em></em>
-<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em
class="jxr_javadoccomment"> * @since 1.6</em>
-<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em
class="jxr_javadoccomment"> * @deprecated Do not use this configuration, it
may leak sensitive information. Rely on gpg-agent or env</em>
-<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em
class="jxr_javadoccomment"> * variables instead.</em>
-<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em
class="jxr_javadoccomment"> **/</em>
-<a class="jxr_linenumber" name="L139" href="#L139">139</a> @Deprecated
-<a class="jxr_linenumber" name="L140" href="#L140">140</a>
@Parameter(property = <span class="jxr_string">"gpg.passphraseServerId"</span>,
defaultValue = GPG_PASSPHRASE)
-<a class="jxr_linenumber" name="L141" href="#L141">141</a> <strong
class="jxr_keyword">private</strong> String passphraseServerId;
-<a class="jxr_linenumber" name="L142" href="#L142">142</a>
-<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The "name" of the key to
sign with. Passed to gpg as <code>--local-user</code>.</em>
-<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L146" href="#L146">146</a>
@Parameter(property = <span class="jxr_string">"gpg.keyname"</span>)
-<a class="jxr_linenumber" name="L147" href="#L147">147</a> <strong
class="jxr_keyword">private</strong> String keyname;
-<a class="jxr_linenumber" name="L148" href="#L148">148</a>
-<a class="jxr_linenumber" name="L149" href="#L149">149</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em
class="jxr_javadoccomment"> * All signers: whether gpg-agent is allowed to
be used or not. If enabled, passphrase is optional, as agent may</em>
-<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em
class="jxr_javadoccomment"> * provide it. Have to be noted, that in "batch"
mode, gpg-agent will be prevented to pop up pinentry</em>
-<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em
class="jxr_javadoccomment"> * dialogue, hence best is to "prime" the agent
caches beforehand.</em>
-<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em
class="jxr_javadoccomment"> * GPG Signer: Passes
<code>--use-agent</code> or <code>--no-use-agent</code>
option to gpg if it is version 2.1</em>
-<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em
class="jxr_javadoccomment"> * or older. Otherwise, will use an agent. In
non-interactive mode gpg options are appended with</em>
-<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> * <code>--pinentry-mode
error</code>, preventing gpg agent to pop up pinentry dialogue. Agent
will be able to</em>
-<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> * hand over only cached passwords.</em>
-<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> * BC Signer: Allows signer to communicate with
gpg agent. In non-interactive mode it uses</em>
-<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em
class="jxr_javadoccomment"> * <code>--no-ask</code> option with
the <code>GET_PASSPHRASE</code> function. Agent will be able to
hand over</em>
-<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em
class="jxr_javadoccomment"> * only cached passwords.</em>
-<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L163" href="#L163">163</a>
@Parameter(property = <span class="jxr_string">"gpg.useagent"</span>,
defaultValue = <span class="jxr_string">"true"</span>)
-<a class="jxr_linenumber" name="L164" href="#L164">164</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> useAgent;
-<a class="jxr_linenumber" name="L165" href="#L165">165</a>
-<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The path to the GnuPG
executable to use for artifact signing. Defaults to either "gpg" or</em>
-<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> * "gpg.exe" depending on the operating
system.</em>
-<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> * @since 1.1</em>
-<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L172" href="#L172">172</a>
@Parameter(property = <span class="jxr_string">"gpg.executable"</span>)
-<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong
class="jxr_keyword">private</strong> String executable;
-<a class="jxr_linenumber" name="L174" href="#L174">174</a>
-<a class="jxr_linenumber" name="L175" href="#L175">175</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em
class="jxr_javadoccomment"> * GPG Signer only: Whether to add the default
keyrings from gpg's home directory to the list of used keyrings.</em>
-<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment"> * @since 1.2</em>
-<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L180" href="#L180">180</a>
@Parameter(property = <span class="jxr_string">"gpg.defaultKeyring"</span>,
defaultValue = <span class="jxr_string">"true"</span>)
-<a class="jxr_linenumber" name="L181" href="#L181">181</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> defaultKeyring;
-<a class="jxr_linenumber" name="L182" href="#L182">182</a>
-<a class="jxr_linenumber" name="L183" href="#L183">183</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The path to a secret keyring
to add to the list of keyrings. By default, only the</em>
-<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment"> * {@code secring.gpg} from gpg's home directory
is considered. Use this option (in combination with</em>
-<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment"> * {@link #publicKeyring} and {@link
#defaultKeyring} if required) to use a different secret key.</em>
-<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment"> * <em>Note:</em> Relative paths are
resolved against gpg's home directory, not the project base directory.</em>
-<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> * <strong>NOTE: </strong>As of gpg
2.1 this is an obsolete option and ignored. All secret keys are stored in
the</em>
-<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment"> * âprivate-keys-v1.dâ directory below the
GnuPG home directory.</em>
-<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em
class="jxr_javadoccomment"> * @since 1.2</em>
-<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em
class="jxr_javadoccomment"> * @deprecated Obsolete option since GnuPG 2.1
version.</em>
-<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L195" href="#L195">195</a> @Deprecated
-<a class="jxr_linenumber" name="L196" href="#L196">196</a>
@Parameter(property = <span class="jxr_string">"gpg.secretKeyring"</span>)
-<a class="jxr_linenumber" name="L197" href="#L197">197</a> <strong
class="jxr_keyword">private</strong> String secretKeyring;
-<a class="jxr_linenumber" name="L198" href="#L198">198</a>
-<a class="jxr_linenumber" name="L199" href="#L199">199</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The path to a public keyring
to add to the list of keyrings. By default, only the</em>
-<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_javadoccomment"> * {@code pubring.gpg} from gpg's home directory
is considered. Use this option (and {@link #defaultKeyring}</em>
-<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em
class="jxr_javadoccomment"> * if required) to use a different public key.
<em>Note:</em> Relative paths are resolved against gpg's home</em>
-<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em
class="jxr_javadoccomment"> * directory, not the project base
directory.</em>
-<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em
class="jxr_javadoccomment"> * <p></em>
-<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em
class="jxr_javadoccomment"> * <strong>NOTE: </strong>As of gpg
2.1 this is an obsolete option and ignored. All public keys are stored in
the</em>
-<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em
class="jxr_javadoccomment"> * âpubring.kbxâ file below the GnuPG home
directory.</em>
-<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em
class="jxr_javadoccomment"> * @since 1.2</em>
-<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em
class="jxr_javadoccomment"> * @deprecated Obsolete option since GnuPG 2.1
version.</em>
-<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L211" href="#L211">211</a> @Deprecated
-<a class="jxr_linenumber" name="L212" href="#L212">212</a>
@Parameter(property = <span class="jxr_string">"gpg.publicKeyring"</span>)
-<a class="jxr_linenumber" name="L213" href="#L213">213</a> <strong
class="jxr_keyword">private</strong> String publicKeyring;
-<a class="jxr_linenumber" name="L214" href="#L214">214</a>
-<a class="jxr_linenumber" name="L215" href="#L215">215</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The lock mode to use when
invoking gpg. By default no lock mode will be specified. Valid</em>
-<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em
class="jxr_javadoccomment"> * values are {@code once}, {@code multiple} and
{@code never}. The lock mode gets translated into the</em>
-<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em
class="jxr_javadoccomment"> * corresponding {@code --lock-___} command line
argument. Improper usage of this option may lead to data and</em>
-<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em
class="jxr_javadoccomment"> * key corruption.</em>
-<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em
class="jxr_javadoccomment"> * @see <a href="<a
href="http://www.gnupg.org/documentation/manuals/gnupg/GPG-Configuration-Options.html"
target="alexandria_uri">http://www.gnupg.org/documentation/manuals/gnupg/GPG-Configuration-Options.html</a>">the</em>
-<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em
class="jxr_javadoccomment"> * --lock-options</a></em>
-<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em
class="jxr_javadoccomment"> * @since 1.5</em>
-<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L225" href="#L225">225</a>
@Parameter(property = <span class="jxr_string">"gpg.lockMode"</span>)
-<a class="jxr_linenumber" name="L226" href="#L226">226</a> <strong
class="jxr_keyword">private</strong> String lockMode;
-<a class="jxr_linenumber" name="L227" href="#L227">227</a>
-<a class="jxr_linenumber" name="L228" href="#L228">228</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em
class="jxr_javadoccomment"> * Skip doing the gpg signing.</em>
-<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L231" href="#L231">231</a>
@Parameter(property = <span class="jxr_string">"gpg.skip"</span>, defaultValue
= <span class="jxr_string">"false"</span>)
-<a class="jxr_linenumber" name="L232" href="#L232">232</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> skip;
-<a class="jxr_linenumber" name="L233" href="#L233">233</a>
-<a class="jxr_linenumber" name="L234" href="#L234">234</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em
class="jxr_javadoccomment"> * GPG Signer only: Sets the arguments to be
passed to gpg. Example:</em>
-<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em
class="jxr_javadoccomment"> * <pre></em>
-<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em
class="jxr_javadoccomment"> * &lt;gpgArguments&gt;</em>
-<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em
class="jxr_javadoccomment"> *
&lt;arg&gt;--no-random-seed-file&lt;/arg&gt;</em>
-<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> *
&lt;arg&gt;--no-permission-warning&lt;/arg&gt;</em>
-<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> * &lt;/gpgArguments&gt;</em>
-<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> * </pre></em>
-<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em
class="jxr_javadoccomment"> * @since 1.5</em>
-<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L246" href="#L246">246</a> @Parameter
-<a class="jxr_linenumber" name="L247" href="#L247">247</a> <strong
class="jxr_keyword">private</strong> List<String> gpgArguments;
-<a class="jxr_linenumber" name="L248" href="#L248">248</a>
-<a class="jxr_linenumber" name="L249" href="#L249">249</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em
class="jxr_javadoccomment"> * The name of the Signer implementation to use.
Accepted values are {@code "gpg"} (the default, uses GnuPG</em>
-<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em
class="jxr_javadoccomment"> * executable) and {@code "bc"} (uses Bouncy
Castle pure Java signer).</em>
-<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em
class="jxr_javadoccomment"> * @since 3.2.0</em>
-<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L255" href="#L255">255</a>
@Parameter(property = <span class="jxr_string">"gpg.signer"</span>,
defaultValue = GpgSigner.NAME)
-<a class="jxr_linenumber" name="L256" href="#L256">256</a> <strong
class="jxr_keyword">private</strong> String signer;
-<a class="jxr_linenumber" name="L257" href="#L257">257</a>
-<a class="jxr_linenumber" name="L258" href="#L258">258</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em
class="jxr_javadoccomment"> * @since 3.0.0</em>
-<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L261" href="#L261">261</a> @Component
-<a class="jxr_linenumber" name="L262" href="#L262">262</a> <strong
class="jxr_keyword">protected</strong> MavenSession session;
-<a class="jxr_linenumber" name="L263" href="#L263">263</a>
-<a class="jxr_linenumber" name="L264" href="#L264">264</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em
class="jxr_javadoccomment"> * Switch to improve plugin enforcement of "best
practices". If set to {@code false}, plugin retains all the</em>
-<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em
class="jxr_javadoccomment"> * backward compatibility regarding getting
secrets (but will warn). If set to {@code true}, plugin will fail</em>
-<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em
class="jxr_javadoccomment"> * if any "bad practices" regarding sensitive
data handling are detected. By default, plugin remains backward</em>
-<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em
class="jxr_javadoccomment"> * compatible (this flag is {@code false}).
Somewhere in the future, when this parameter enabling transitioning</em>
-<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em
class="jxr_javadoccomment"> * from older plugin versions is removed, the
logic using this flag will be modified like it is set to {@code true}.</em>
-<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em
class="jxr_javadoccomment"> * It is warmly advised to configure this
parameter to {@code true} and migrate project and user environment</em>
-<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em
class="jxr_javadoccomment"> * regarding how sensitive information is
stored.</em>
-<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em
class="jxr_javadoccomment"> * @since 3.2.0</em>
-<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L275" href="#L275">275</a>
@Parameter(property = <span class="jxr_string">"gpg.bestPractices"</span>,
defaultValue = <span class="jxr_string">"false"</span>)
-<a class="jxr_linenumber" name="L276" href="#L276">276</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> bestPractices;
-<a class="jxr_linenumber" name="L277" href="#L277">277</a>
-<a class="jxr_linenumber" name="L278" href="#L278">278</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em
class="jxr_javadoccomment"> * Current user system settings for use in
Maven.</em>
-<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em
class="jxr_javadoccomment"> * @since 1.6</em>
-<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L283" href="#L283">283</a>
@Parameter(defaultValue = <span class="jxr_string">"${settings}"</span>,
readonly = <strong class="jxr_keyword">true</strong>, required = <strong
class="jxr_keyword">true</strong>)
-<a class="jxr_linenumber" name="L284" href="#L284">284</a> <strong
class="jxr_keyword">protected</strong> Settings settings;
-<a class="jxr_linenumber" name="L285" href="#L285">285</a>
-<a class="jxr_linenumber" name="L286" href="#L286">286</a> <em
class="jxr_javadoccomment">/**</em>
-<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em
class="jxr_javadoccomment"> * Maven Security Dispatcher.</em>
-<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em
class="jxr_javadoccomment"> *</em>
-<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em
class="jxr_javadoccomment"> * @since 1.6</em>
-<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em
class="jxr_javadoccomment"> * @deprecated Provides quasi-encryption, should
be avoided.</em>
-<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em
class="jxr_javadoccomment"> */</em>
-<a class="jxr_linenumber" name="L292" href="#L292">292</a> @Deprecated
-<a class="jxr_linenumber" name="L293" href="#L293">293</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
SecDispatcher secDispatcher =
-<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong
class="jxr_keyword">new</strong> DefaultSecDispatcher(<strong
class="jxr_keyword">new</strong> DefaultPlexusCipher(), Collections.emptyMap(),
<span class="jxr_string">"~/.m2/settings-security.xml"</span>);
-<a class="jxr_linenumber" name="L295" href="#L295">295</a>
-<a class="jxr_linenumber" name="L296" href="#L296">296</a> @Override
-<a class="jxr_linenumber" name="L297" href="#L297">297</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">void</strong> execute() <strong
class="jxr_keyword">throws</strong> MojoExecutionException,
MojoFailureException {
-<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong
class="jxr_keyword">if</strong> (skip) {
-<a class="jxr_linenumber" name="L299" href="#L299">299</a> <em
class="jxr_comment">// We're skipping the signing stuff</em>
-<a class="jxr_linenumber" name="L300" href="#L300">300</a> <strong
class="jxr_keyword">return</strong>;
-<a class="jxr_linenumber" name="L301" href="#L301">301</a> }
-<a class="jxr_linenumber" name="L302" href="#L302">302</a> <strong
class="jxr_keyword">if</strong> (bestPractices &&
(isNotBlank(passphrase) || isNotBlank(passphraseServerId))) {
-<a class="jxr_linenumber" name="L303" href="#L303">303</a> <em
class="jxr_comment">// Stop propagating worst practices: passphrase MUST NOT be
in any file on disk</em>
-<a class="jxr_linenumber" name="L304" href="#L304">304</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoFailureException(
-<a class="jxr_linenumber" name="L305" href="#L305">305</a>
<span class="jxr_string">"Do not store passphrase in any file (disk or SCM
repository), rely on GnuPG agent or provide passphrase in "</span>
-<a class="jxr_linenumber" name="L306" href="#L306">306</a>
+ passphraseEnvName + <span class="jxr_string">" environment
variable."</span>);
-<a class="jxr_linenumber" name="L307" href="#L307">307</a> }
-<a class="jxr_linenumber" name="L308" href="#L308">308</a>
-<a class="jxr_linenumber" name="L309" href="#L309">309</a> doExecute();
-<a class="jxr_linenumber" name="L310" href="#L310">310</a> }
+<a class="jxr_linenumber" name="L134" href="#L134">134</a> <em
class="jxr_javadoccomment"> * Is programatically defaulted to {@link
#GPG_PASSPHRASE}.</em>
+<a class="jxr_linenumber" name="L135" href="#L135">135</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L136" href="#L136">136</a> <em
class="jxr_javadoccomment"> * @since 1.6</em>
+<a class="jxr_linenumber" name="L137" href="#L137">137</a> <em
class="jxr_javadoccomment"> * @deprecated Do not use this configuration, it
may leak sensitive information. Rely on gpg-agent or env</em>
+<a class="jxr_linenumber" name="L138" href="#L138">138</a> <em
class="jxr_javadoccomment"> * variables instead.</em>
+<a class="jxr_linenumber" name="L139" href="#L139">139</a> <em
class="jxr_javadoccomment"> **/</em>
+<a class="jxr_linenumber" name="L140" href="#L140">140</a> @Deprecated
+<a class="jxr_linenumber" name="L141" href="#L141">141</a>
@Parameter(property = <span class="jxr_string">"gpg.passphraseServerId"</span>)
+<a class="jxr_linenumber" name="L142" href="#L142">142</a> <strong
class="jxr_keyword">private</strong> String passphraseServerId;
+<a class="jxr_linenumber" name="L143" href="#L143">143</a>
+<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The "name" of the key to
sign with. Passed to gpg as <code>--local-user</code>.</em>
+<a class="jxr_linenumber" name="L146" href="#L146">146</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L147" href="#L147">147</a>
@Parameter(property = <span class="jxr_string">"gpg.keyname"</span>)
+<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong
class="jxr_keyword">private</strong> String keyname;
+<a class="jxr_linenumber" name="L149" href="#L149">149</a>
+<a class="jxr_linenumber" name="L150" href="#L150">150</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L151" href="#L151">151</a> <em
class="jxr_javadoccomment"> * All signers: whether gpg-agent is allowed to
be used or not. If enabled, passphrase is optional, as agent may</em>
+<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em
class="jxr_javadoccomment"> * provide it. Have to be noted, that in "batch"
mode, gpg-agent will be prevented to pop up pinentry</em>
+<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em
class="jxr_javadoccomment"> * dialogue, hence best is to "prime" the agent
caches beforehand.</em>
+<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em
class="jxr_javadoccomment"> * GPG Signer: Passes
<code>--use-agent</code> or <code>--no-use-agent</code>
option to gpg if it is version 2.1</em>
+<a class="jxr_linenumber" name="L156" href="#L156">156</a> <em
class="jxr_javadoccomment"> * or older. Otherwise, will use an agent. In
non-interactive mode gpg options are appended with</em>
+<a class="jxr_linenumber" name="L157" href="#L157">157</a> <em
class="jxr_javadoccomment"> * <code>--pinentry-mode
error</code>, preventing gpg agent to pop up pinentry dialogue. Agent
will be able to</em>
+<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em
class="jxr_javadoccomment"> * hand over only cached passwords.</em>
+<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em
class="jxr_javadoccomment"> * BC Signer: Allows signer to communicate with
gpg agent. In non-interactive mode it uses</em>
+<a class="jxr_linenumber" name="L161" href="#L161">161</a> <em
class="jxr_javadoccomment"> * <code>--no-ask</code> option with
the <code>GET_PASSPHRASE</code> function. Agent will be able to
hand over</em>
+<a class="jxr_linenumber" name="L162" href="#L162">162</a> <em
class="jxr_javadoccomment"> * only cached passwords.</em>
+<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L164" href="#L164">164</a>
@Parameter(property = <span class="jxr_string">"gpg.useagent"</span>,
defaultValue = <span class="jxr_string">"true"</span>)
+<a class="jxr_linenumber" name="L165" href="#L165">165</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> useAgent;
+<a class="jxr_linenumber" name="L166" href="#L166">166</a>
+<a class="jxr_linenumber" name="L167" href="#L167">167</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L168" href="#L168">168</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The path to the GnuPG
executable to use for artifact signing. Defaults to either "gpg" or</em>
+<a class="jxr_linenumber" name="L169" href="#L169">169</a> <em
class="jxr_javadoccomment"> * "gpg.exe" depending on the operating
system.</em>
+<a class="jxr_linenumber" name="L170" href="#L170">170</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L171" href="#L171">171</a> <em
class="jxr_javadoccomment"> * @since 1.1</em>
+<a class="jxr_linenumber" name="L172" href="#L172">172</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L173" href="#L173">173</a>
@Parameter(property = <span class="jxr_string">"gpg.executable"</span>)
+<a class="jxr_linenumber" name="L174" href="#L174">174</a> <strong
class="jxr_keyword">private</strong> String executable;
+<a class="jxr_linenumber" name="L175" href="#L175">175</a>
+<a class="jxr_linenumber" name="L176" href="#L176">176</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L177" href="#L177">177</a> <em
class="jxr_javadoccomment"> * GPG Signer only: Whether to add the default
keyrings from gpg's home directory to the list of used keyrings.</em>
+<a class="jxr_linenumber" name="L178" href="#L178">178</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L179" href="#L179">179</a> <em
class="jxr_javadoccomment"> * @since 1.2</em>
+<a class="jxr_linenumber" name="L180" href="#L180">180</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L181" href="#L181">181</a>
@Parameter(property = <span class="jxr_string">"gpg.defaultKeyring"</span>,
defaultValue = <span class="jxr_string">"true"</span>)
+<a class="jxr_linenumber" name="L182" href="#L182">182</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> defaultKeyring;
+<a class="jxr_linenumber" name="L183" href="#L183">183</a>
+<a class="jxr_linenumber" name="L184" href="#L184">184</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L185" href="#L185">185</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The path to a secret keyring
to add to the list of keyrings. By default, only the</em>
+<a class="jxr_linenumber" name="L186" href="#L186">186</a> <em
class="jxr_javadoccomment"> * {@code secring.gpg} from gpg's home directory
is considered. Use this option (in combination with</em>
+<a class="jxr_linenumber" name="L187" href="#L187">187</a> <em
class="jxr_javadoccomment"> * {@link #publicKeyring} and {@link
#defaultKeyring} if required) to use a different secret key.</em>
+<a class="jxr_linenumber" name="L188" href="#L188">188</a> <em
class="jxr_javadoccomment"> * <em>Note:</em> Relative paths are
resolved against gpg's home directory, not the project base directory.</em>
+<a class="jxr_linenumber" name="L189" href="#L189">189</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L190" href="#L190">190</a> <em
class="jxr_javadoccomment"> * <strong>NOTE: </strong>As of gpg
2.1 this is an obsolete option and ignored. All secret keys are stored in
the</em>
+<a class="jxr_linenumber" name="L191" href="#L191">191</a> <em
class="jxr_javadoccomment"> * âprivate-keys-v1.dâ directory below the
GnuPG home directory.</em>
+<a class="jxr_linenumber" name="L192" href="#L192">192</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L193" href="#L193">193</a> <em
class="jxr_javadoccomment"> * @since 1.2</em>
+<a class="jxr_linenumber" name="L194" href="#L194">194</a> <em
class="jxr_javadoccomment"> * @deprecated Obsolete option since GnuPG 2.1
version.</em>
+<a class="jxr_linenumber" name="L195" href="#L195">195</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L196" href="#L196">196</a> @Deprecated
+<a class="jxr_linenumber" name="L197" href="#L197">197</a>
@Parameter(property = <span class="jxr_string">"gpg.secretKeyring"</span>)
+<a class="jxr_linenumber" name="L198" href="#L198">198</a> <strong
class="jxr_keyword">private</strong> String secretKeyring;
+<a class="jxr_linenumber" name="L199" href="#L199">199</a>
+<a class="jxr_linenumber" name="L200" href="#L200">200</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L201" href="#L201">201</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The path to a public keyring
to add to the list of keyrings. By default, only the</em>
+<a class="jxr_linenumber" name="L202" href="#L202">202</a> <em
class="jxr_javadoccomment"> * {@code pubring.gpg} from gpg's home directory
is considered. Use this option (and {@link #defaultKeyring}</em>
+<a class="jxr_linenumber" name="L203" href="#L203">203</a> <em
class="jxr_javadoccomment"> * if required) to use a different public key.
<em>Note:</em> Relative paths are resolved against gpg's home</em>
+<a class="jxr_linenumber" name="L204" href="#L204">204</a> <em
class="jxr_javadoccomment"> * directory, not the project base
directory.</em>
+<a class="jxr_linenumber" name="L205" href="#L205">205</a> <em
class="jxr_javadoccomment"> * <p></em>
+<a class="jxr_linenumber" name="L206" href="#L206">206</a> <em
class="jxr_javadoccomment"> * <strong>NOTE: </strong>As of gpg
2.1 this is an obsolete option and ignored. All public keys are stored in
the</em>
+<a class="jxr_linenumber" name="L207" href="#L207">207</a> <em
class="jxr_javadoccomment"> * âpubring.kbxâ file below the GnuPG home
directory.</em>
+<a class="jxr_linenumber" name="L208" href="#L208">208</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L209" href="#L209">209</a> <em
class="jxr_javadoccomment"> * @since 1.2</em>
+<a class="jxr_linenumber" name="L210" href="#L210">210</a> <em
class="jxr_javadoccomment"> * @deprecated Obsolete option since GnuPG 2.1
version.</em>
+<a class="jxr_linenumber" name="L211" href="#L211">211</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L212" href="#L212">212</a> @Deprecated
+<a class="jxr_linenumber" name="L213" href="#L213">213</a>
@Parameter(property = <span class="jxr_string">"gpg.publicKeyring"</span>)
+<a class="jxr_linenumber" name="L214" href="#L214">214</a> <strong
class="jxr_keyword">private</strong> String publicKeyring;
+<a class="jxr_linenumber" name="L215" href="#L215">215</a>
+<a class="jxr_linenumber" name="L216" href="#L216">216</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L217" href="#L217">217</a> <em
class="jxr_javadoccomment"> * GPG Signer only: The lock mode to use when
invoking gpg. By default no lock mode will be specified. Valid</em>
+<a class="jxr_linenumber" name="L218" href="#L218">218</a> <em
class="jxr_javadoccomment"> * values are {@code once}, {@code multiple} and
{@code never}. The lock mode gets translated into the</em>
+<a class="jxr_linenumber" name="L219" href="#L219">219</a> <em
class="jxr_javadoccomment"> * corresponding {@code --lock-___} command line
argument. Improper usage of this option may lead to data and</em>
+<a class="jxr_linenumber" name="L220" href="#L220">220</a> <em
class="jxr_javadoccomment"> * key corruption.</em>
+<a class="jxr_linenumber" name="L221" href="#L221">221</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L222" href="#L222">222</a> <em
class="jxr_javadoccomment"> * @see <a href="<a
href="http://www.gnupg.org/documentation/manuals/gnupg/GPG-Configuration-Options.html"
target="alexandria_uri">http://www.gnupg.org/documentation/manuals/gnupg/GPG-Configuration-Options.html</a>">the</em>
+<a class="jxr_linenumber" name="L223" href="#L223">223</a> <em
class="jxr_javadoccomment"> * --lock-options</a></em>
+<a class="jxr_linenumber" name="L224" href="#L224">224</a> <em
class="jxr_javadoccomment"> * @since 1.5</em>
+<a class="jxr_linenumber" name="L225" href="#L225">225</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L226" href="#L226">226</a>
@Parameter(property = <span class="jxr_string">"gpg.lockMode"</span>)
+<a class="jxr_linenumber" name="L227" href="#L227">227</a> <strong
class="jxr_keyword">private</strong> String lockMode;
+<a class="jxr_linenumber" name="L228" href="#L228">228</a>
+<a class="jxr_linenumber" name="L229" href="#L229">229</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L230" href="#L230">230</a> <em
class="jxr_javadoccomment"> * Skip doing the gpg signing.</em>
+<a class="jxr_linenumber" name="L231" href="#L231">231</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L232" href="#L232">232</a>
@Parameter(property = <span class="jxr_string">"gpg.skip"</span>, defaultValue
= <span class="jxr_string">"false"</span>)
+<a class="jxr_linenumber" name="L233" href="#L233">233</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> skip;
+<a class="jxr_linenumber" name="L234" href="#L234">234</a>
+<a class="jxr_linenumber" name="L235" href="#L235">235</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L236" href="#L236">236</a> <em
class="jxr_javadoccomment"> * GPG Signer only: Sets the arguments to be
passed to gpg. Example:</em>
+<a class="jxr_linenumber" name="L237" href="#L237">237</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L238" href="#L238">238</a> <em
class="jxr_javadoccomment"> * <pre></em>
+<a class="jxr_linenumber" name="L239" href="#L239">239</a> <em
class="jxr_javadoccomment"> * &lt;gpgArguments&gt;</em>
+<a class="jxr_linenumber" name="L240" href="#L240">240</a> <em
class="jxr_javadoccomment"> *
&lt;arg&gt;--no-random-seed-file&lt;/arg&gt;</em>
+<a class="jxr_linenumber" name="L241" href="#L241">241</a> <em
class="jxr_javadoccomment"> *
&lt;arg&gt;--no-permission-warning&lt;/arg&gt;</em>
+<a class="jxr_linenumber" name="L242" href="#L242">242</a> <em
class="jxr_javadoccomment"> * &lt;/gpgArguments&gt;</em>
+<a class="jxr_linenumber" name="L243" href="#L243">243</a> <em
class="jxr_javadoccomment"> * </pre></em>
+<a class="jxr_linenumber" name="L244" href="#L244">244</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L245" href="#L245">245</a> <em
class="jxr_javadoccomment"> * @since 1.5</em>
+<a class="jxr_linenumber" name="L246" href="#L246">246</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L247" href="#L247">247</a> @Parameter
+<a class="jxr_linenumber" name="L248" href="#L248">248</a> <strong
class="jxr_keyword">private</strong> List<String> gpgArguments;
+<a class="jxr_linenumber" name="L249" href="#L249">249</a>
+<a class="jxr_linenumber" name="L250" href="#L250">250</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L251" href="#L251">251</a> <em
class="jxr_javadoccomment"> * The name of the Signer implementation to use.
Accepted values are {@code "gpg"} (the default, uses GnuPG</em>
+<a class="jxr_linenumber" name="L252" href="#L252">252</a> <em
class="jxr_javadoccomment"> * executable) and {@code "bc"} (uses Bouncy
Castle pure Java signer).</em>
+<a class="jxr_linenumber" name="L253" href="#L253">253</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L254" href="#L254">254</a> <em
class="jxr_javadoccomment"> * @since 3.2.0</em>
+<a class="jxr_linenumber" name="L255" href="#L255">255</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L256" href="#L256">256</a>
@Parameter(property = <span class="jxr_string">"gpg.signer"</span>,
defaultValue = GpgSigner.NAME)
+<a class="jxr_linenumber" name="L257" href="#L257">257</a> <strong
class="jxr_keyword">private</strong> String signer;
+<a class="jxr_linenumber" name="L258" href="#L258">258</a>
+<a class="jxr_linenumber" name="L259" href="#L259">259</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L260" href="#L260">260</a> <em
class="jxr_javadoccomment"> * @since 3.0.0</em>
+<a class="jxr_linenumber" name="L261" href="#L261">261</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L262" href="#L262">262</a> @Component
+<a class="jxr_linenumber" name="L263" href="#L263">263</a> <strong
class="jxr_keyword">protected</strong> MavenSession session;
+<a class="jxr_linenumber" name="L264" href="#L264">264</a>
+<a class="jxr_linenumber" name="L265" href="#L265">265</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L266" href="#L266">266</a> <em
class="jxr_javadoccomment"> * Switch to improve plugin enforcement of "best
practices". If set to {@code false}, plugin retains all the</em>
+<a class="jxr_linenumber" name="L267" href="#L267">267</a> <em
class="jxr_javadoccomment"> * backward compatibility regarding getting
secrets (but will warn). If set to {@code true}, plugin will fail</em>
+<a class="jxr_linenumber" name="L268" href="#L268">268</a> <em
class="jxr_javadoccomment"> * if any "bad practices" regarding sensitive
data handling are detected. By default, plugin remains backward</em>
+<a class="jxr_linenumber" name="L269" href="#L269">269</a> <em
class="jxr_javadoccomment"> * compatible (this flag is {@code false}).
Somewhere in the future, when this parameter enabling transitioning</em>
+<a class="jxr_linenumber" name="L270" href="#L270">270</a> <em
class="jxr_javadoccomment"> * from older plugin versions is removed, the
logic using this flag will be modified like it is set to {@code true}.</em>
+<a class="jxr_linenumber" name="L271" href="#L271">271</a> <em
class="jxr_javadoccomment"> * It is warmly advised to configure this
parameter to {@code true} and migrate project and user environment</em>
+<a class="jxr_linenumber" name="L272" href="#L272">272</a> <em
class="jxr_javadoccomment"> * regarding how sensitive information is
stored.</em>
+<a class="jxr_linenumber" name="L273" href="#L273">273</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L274" href="#L274">274</a> <em
class="jxr_javadoccomment"> * @since 3.2.0</em>
+<a class="jxr_linenumber" name="L275" href="#L275">275</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L276" href="#L276">276</a>
@Parameter(property = <span class="jxr_string">"gpg.bestPractices"</span>,
defaultValue = <span class="jxr_string">"false"</span>)
+<a class="jxr_linenumber" name="L277" href="#L277">277</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> bestPractices;
+<a class="jxr_linenumber" name="L278" href="#L278">278</a>
+<a class="jxr_linenumber" name="L279" href="#L279">279</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L280" href="#L280">280</a> <em
class="jxr_javadoccomment"> * Current user system settings for use in
Maven.</em>
+<a class="jxr_linenumber" name="L281" href="#L281">281</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L282" href="#L282">282</a> <em
class="jxr_javadoccomment"> * @since 1.6</em>
+<a class="jxr_linenumber" name="L283" href="#L283">283</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L284" href="#L284">284</a>
@Parameter(defaultValue = <span class="jxr_string">"${settings}"</span>,
readonly = <strong class="jxr_keyword">true</strong>, required = <strong
class="jxr_keyword">true</strong>)
+<a class="jxr_linenumber" name="L285" href="#L285">285</a> <strong
class="jxr_keyword">protected</strong> Settings settings;
+<a class="jxr_linenumber" name="L286" href="#L286">286</a>
+<a class="jxr_linenumber" name="L287" href="#L287">287</a> <em
class="jxr_javadoccomment">/**</em>
+<a class="jxr_linenumber" name="L288" href="#L288">288</a> <em
class="jxr_javadoccomment"> * Maven Security Dispatcher.</em>
+<a class="jxr_linenumber" name="L289" href="#L289">289</a> <em
class="jxr_javadoccomment"> *</em>
+<a class="jxr_linenumber" name="L290" href="#L290">290</a> <em
class="jxr_javadoccomment"> * @since 1.6</em>
+<a class="jxr_linenumber" name="L291" href="#L291">291</a> <em
class="jxr_javadoccomment"> * @deprecated Provides quasi-encryption, should
be avoided.</em>
+<a class="jxr_linenumber" name="L292" href="#L292">292</a> <em
class="jxr_javadoccomment"> */</em>
+<a class="jxr_linenumber" name="L293" href="#L293">293</a> @Deprecated
+<a class="jxr_linenumber" name="L294" href="#L294">294</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong>
SecDispatcher secDispatcher =
+<a class="jxr_linenumber" name="L295" href="#L295">295</a> <strong
class="jxr_keyword">new</strong> DefaultSecDispatcher(<strong
class="jxr_keyword">new</strong> DefaultPlexusCipher(), Collections.emptyMap(),
<span class="jxr_string">"~/.m2/settings-security.xml"</span>);
+<a class="jxr_linenumber" name="L296" href="#L296">296</a>
+<a class="jxr_linenumber" name="L297" href="#L297">297</a> @Override
+<a class="jxr_linenumber" name="L298" href="#L298">298</a> <strong
class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong>
<strong class="jxr_keyword">void</strong> execute() <strong
class="jxr_keyword">throws</strong> MojoExecutionException,
MojoFailureException {
+<a class="jxr_linenumber" name="L299" href="#L299">299</a> <strong
class="jxr_keyword">if</strong> (skip) {
+<a class="jxr_linenumber" name="L300" href="#L300">300</a> <em
class="jxr_comment">// We're skipping the signing stuff</em>
+<a class="jxr_linenumber" name="L301" href="#L301">301</a> <strong
class="jxr_keyword">return</strong>;
+<a class="jxr_linenumber" name="L302" href="#L302">302</a> }
+<a class="jxr_linenumber" name="L303" href="#L303">303</a> <strong
class="jxr_keyword">if</strong> (bestPractices) {
+<a class="jxr_linenumber" name="L304" href="#L304">304</a>
enforceBestPractices();
+<a class="jxr_linenumber" name="L305" href="#L305">305</a> } <strong
class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L306" href="#L306">306</a> <strong
class="jxr_keyword">if</strong> (!isNotBlank(passphraseServerId)) {
+<a class="jxr_linenumber" name="L307" href="#L307">307</a> <em
class="jxr_comment">// default it programmatically: this is needed to handle
different cases re bestPractices</em>
+<a class="jxr_linenumber" name="L308" href="#L308">308</a>
passphraseServerId = GPG_PASSPHRASE;
+<a class="jxr_linenumber" name="L309" href="#L309">309</a> }
+<a class="jxr_linenumber" name="L310" href="#L310">310</a> }
<a class="jxr_linenumber" name="L311" href="#L311">311</a>
-<a class="jxr_linenumber" name="L312" href="#L312">312</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong>
doExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException,
MojoFailureException;
-<a class="jxr_linenumber" name="L313" href="#L313">313</a>
-<a class="jxr_linenumber" name="L314" href="#L314">314</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong>
logBestPracticeWarning(String source) {
-<a class="jxr_linenumber" name="L315" href="#L315">315</a>
getLog().warn(<span class="jxr_string">""</span>);
-<a class="jxr_linenumber" name="L316" href="#L316">316</a>
getLog().warn(<span class="jxr_string">"W A R N I N G"</span>);
-<a class="jxr_linenumber" name="L317" href="#L317">317</a>
getLog().warn(<span class="jxr_string">""</span>);
-<a class="jxr_linenumber" name="L318" href="#L318">318</a>
getLog().warn(<span class="jxr_string">"Do not store passphrase in any file
(disk or SCM repository),"</span>);
-<a class="jxr_linenumber" name="L319" href="#L319">319</a>
getLog().warn(<span class="jxr_string">"instead rely on GnuPG agent or provide
passphrase in "</span>);
-<a class="jxr_linenumber" name="L320" href="#L320">320</a>
getLog().warn(passphraseEnvName + <span class="jxr_string">" environment
variable for batch mode."</span>);
-<a class="jxr_linenumber" name="L321" href="#L321">321</a>
getLog().warn(<span class="jxr_string">""</span>);
-<a class="jxr_linenumber" name="L322" href="#L322">322</a>
getLog().warn(<span class="jxr_string">"Sensitive content loaded from "</span>
+ source);
-<a class="jxr_linenumber" name="L323" href="#L323">323</a>
getLog().warn(<span class="jxr_string">""</span>);
-<a class="jxr_linenumber" name="L324" href="#L324">324</a> }
-<a class="jxr_linenumber" name="L325" href="#L325">325</a>
-<a class="jxr_linenumber" name="L326" href="#L326">326</a> <strong
class="jxr_keyword">protected</strong> <a name="AbstractGpgSigner"
href="../../../../../org/apache/maven/plugins/gpg/AbstractGpgSigner.html#AbstractGpgSigner">AbstractGpgSigner</a>
newSigner(MavenProject mavenProject) <strong
class="jxr_keyword">throws</strong> MojoFailureException {
-<a class="jxr_linenumber" name="L327" href="#L327">327</a> <a
name="AbstractGpgSigner"
href="../../../../../org/apache/maven/plugins/gpg/AbstractGpgSigner.html#AbstractGpgSigner">AbstractGpgSigner</a>
signer;
-<a class="jxr_linenumber" name="L328" href="#L328">328</a> <strong
class="jxr_keyword">if</strong> (GpgSigner.NAME.equals(<strong
class="jxr_keyword">this</strong>.signer)) {
-<a class="jxr_linenumber" name="L329" href="#L329">329</a> signer
= <strong class="jxr_keyword">new</strong> <a name="GpgSigner"
href="../../../../../org/apache/maven/plugins/gpg/GpgSigner.html#GpgSigner">GpgSigner</a>(executable);
-<a class="jxr_linenumber" name="L330" href="#L330">330</a> } <strong
class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>
(BcSigner.NAME.equals(<strong class="jxr_keyword">this</strong>.signer)) {
-<a class="jxr_linenumber" name="L331" href="#L331">331</a> signer
= <strong class="jxr_keyword">new</strong> <a name="BcSigner"
href="../../../../../org/apache/maven/plugins/gpg/BcSigner.html#BcSigner">BcSigner</a>(
-<a class="jxr_linenumber" name="L332" href="#L332">332</a>
session.getRepositorySession(),
-<a class="jxr_linenumber" name="L333" href="#L333">333</a>
keyEnvName,
-<a class="jxr_linenumber" name="L334" href="#L334">334</a>
keyFingerprintEnvName,
-<a class="jxr_linenumber" name="L335" href="#L335">335</a>
agentSocketLocations,
-<a class="jxr_linenumber" name="L336" href="#L336">336</a>
keyFilePath,
-<a class="jxr_linenumber" name="L337" href="#L337">337</a>
keyFingerprint);
-<a class="jxr_linenumber" name="L338" href="#L338">338</a> } <strong
class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoFailureException(<span class="jxr_string">"Unknown signer: "</span> +
<strong class="jxr_keyword">this</strong>.signer);
-<a class="jxr_linenumber" name="L340" href="#L340">340</a> }
-<a class="jxr_linenumber" name="L341" href="#L341">341</a>
-<a class="jxr_linenumber" name="L342" href="#L342">342</a>
signer.setLog(getLog());
-<a class="jxr_linenumber" name="L343" href="#L343">343</a>
signer.setInteractive(settings.isInteractiveMode());
-<a class="jxr_linenumber" name="L344" href="#L344">344</a>
signer.setKeyName(keyname);
-<a class="jxr_linenumber" name="L345" href="#L345">345</a>
signer.setUseAgent(useAgent);
-<a class="jxr_linenumber" name="L346" href="#L346">346</a>
signer.setHomeDirectory(homedir);
-<a class="jxr_linenumber" name="L347" href="#L347">347</a>
signer.setDefaultKeyring(defaultKeyring);
-<a class="jxr_linenumber" name="L348" href="#L348">348</a>
signer.setSecretKeyring(secretKeyring);
-<a class="jxr_linenumber" name="L349" href="#L349">349</a>
signer.setPublicKeyring(publicKeyring);
-<a class="jxr_linenumber" name="L350" href="#L350">350</a>
signer.setLockMode(lockMode);
-<a class="jxr_linenumber" name="L351" href="#L351">351</a>
signer.setArgs(gpgArguments);
-<a class="jxr_linenumber" name="L352" href="#L352">352</a>
-<a class="jxr_linenumber" name="L353" href="#L353">353</a> <em
class="jxr_comment">// "new way": env prevails</em>
-<a class="jxr_linenumber" name="L354" href="#L354">354</a> String
passphrase =
-<a class="jxr_linenumber" name="L355" href="#L355">355</a>
(String) session.getRepositorySession().getConfigProperties().get(<span
class="jxr_string">"env."</span> + passphraseEnvName);
-<a class="jxr_linenumber" name="L356" href="#L356">356</a> <strong
class="jxr_keyword">if</strong> (isNotBlank(passphrase)) {
-<a class="jxr_linenumber" name="L357" href="#L357">357</a>
signer.setPassPhrase(passphrase);
-<a class="jxr_linenumber" name="L358" href="#L358">358</a> } <strong
class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>
(!bestPractices) {
-<a class="jxr_linenumber" name="L359" href="#L359">359</a> <em
class="jxr_comment">// "old way": mojo config</em>
-<a class="jxr_linenumber" name="L360" href="#L360">360</a>
passphrase = <strong class="jxr_keyword">this</strong>.passphrase;
-<a class="jxr_linenumber" name="L361" href="#L361">361</a> <strong
class="jxr_keyword">if</strong> (isNotBlank(passphrase)) {
-<a class="jxr_linenumber" name="L362" href="#L362">362</a>
logBestPracticeWarning(<span class="jxr_string">"Mojo configuration"</span>);
-<a class="jxr_linenumber" name="L363" href="#L363">363</a>
signer.setPassPhrase(passphrase);
-<a class="jxr_linenumber" name="L364" href="#L364">364</a> }
<strong class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L365" href="#L365">365</a> <em
class="jxr_comment">// "old way": serverId + settings</em>
-<a class="jxr_linenumber" name="L366" href="#L366">366</a>
passphrase = loadGpgPassphrase();
-<a class="jxr_linenumber" name="L367" href="#L367">367</a>
<strong class="jxr_keyword">if</strong> (isNotBlank(passphrase)) {
-<a class="jxr_linenumber" name="L368" href="#L368">368</a>
logBestPracticeWarning(<span class="jxr_string">"settings.xml"</span>);
-<a class="jxr_linenumber" name="L369" href="#L369">369</a>
signer.setPassPhrase(passphrase);
-<a class="jxr_linenumber" name="L370" href="#L370">370</a> }
<strong class="jxr_keyword">else</strong> {
-<a class="jxr_linenumber" name="L371" href="#L371">371</a>
<em class="jxr_comment">// "old way": project properties</em>
-<a class="jxr_linenumber" name="L372" href="#L372">372</a>
passphrase = getPassphrase(mavenProject);
-<a class="jxr_linenumber" name="L373" href="#L373">373</a>
<strong class="jxr_keyword">if</strong> (isNotBlank(passphrase)) {
-<a class="jxr_linenumber" name="L374" href="#L374">374</a>
logBestPracticeWarning(<span class="jxr_string">"Project
properties"</span>);
-<a class="jxr_linenumber" name="L375" href="#L375">375</a>
signer.setPassPhrase(passphrase);
-<a class="jxr_linenumber" name="L376" href="#L376">376</a>
}
-<a class="jxr_linenumber" name="L377" href="#L377">377</a> }
-<a class="jxr_linenumber" name="L378" href="#L378">378</a> }
-<a class="jxr_linenumber" name="L379" href="#L379">379</a> }
-<a class="jxr_linenumber" name="L380" href="#L380">380</a>
signer.prepare();
-<a class="jxr_linenumber" name="L381" href="#L381">381</a>
-<a class="jxr_linenumber" name="L382" href="#L382">382</a> <strong
class="jxr_keyword">return</strong> signer;
-<a class="jxr_linenumber" name="L383" href="#L383">383</a> }
-<a class="jxr_linenumber" name="L384" href="#L384">384</a>
-<a class="jxr_linenumber" name="L385" href="#L385">385</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> isNotBlank(String string) {
-<a class="jxr_linenumber" name="L386" href="#L386">386</a> <strong
class="jxr_keyword">return</strong> string != <strong
class="jxr_keyword">null</strong> && !string.trim().isEmpty();
-<a class="jxr_linenumber" name="L387" href="#L387">387</a> }
-<a class="jxr_linenumber" name="L388" href="#L388">388</a>
-<a class="jxr_linenumber" name="L389" href="#L389">389</a> <em
class="jxr_comment">// Below is attic, to be thrown out</em>
-<a class="jxr_linenumber" name="L390" href="#L390">390</a>
-<a class="jxr_linenumber" name="L391" href="#L391">391</a> @Deprecated
-<a class="jxr_linenumber" name="L392" href="#L392">392</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
String GPG_PASSPHRASE = <span class="jxr_string">"gpg.passphrase"</span>;
-<a class="jxr_linenumber" name="L393" href="#L393">393</a>
-<a class="jxr_linenumber" name="L394" href="#L394">394</a> @Deprecated
-<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong
class="jxr_keyword">private</strong> String loadGpgPassphrase() <strong
class="jxr_keyword">throws</strong> MojoFailureException {
-<a class="jxr_linenumber" name="L396" href="#L396">396</a> <strong
class="jxr_keyword">if</strong> (isNotBlank(passphraseServerId)) {
-<a class="jxr_linenumber" name="L397" href="#L397">397</a> Server
server = settings.getServer(passphraseServerId);
-<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong
class="jxr_keyword">if</strong> (server != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L399" href="#L399">399</a>
<strong class="jxr_keyword">if</strong> (isNotBlank(server.getPassphrase())) {
-<a class="jxr_linenumber" name="L400" href="#L400">400</a>
<strong class="jxr_keyword">try</strong> {
-<a class="jxr_linenumber" name="L401" href="#L401">401</a>
<strong class="jxr_keyword">return</strong>
secDispatcher.decrypt(server.getPassphrase());
-<a class="jxr_linenumber" name="L402" href="#L402">402</a>
} <strong class="jxr_keyword">catch</strong> (SecDispatcherException e) {
-<a class="jxr_linenumber" name="L403" href="#L403">403</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> MojoFailureException(<span
class="jxr_string">"Unable to decrypt gpg passphrase"</span>, e);
-<a class="jxr_linenumber" name="L404" href="#L404">404</a>
}
-<a class="jxr_linenumber" name="L405" href="#L405">405</a> }
-<a class="jxr_linenumber" name="L406" href="#L406">406</a> }
-<a class="jxr_linenumber" name="L407" href="#L407">407</a> }
-<a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L409" href="#L409">409</a> }
-<a class="jxr_linenumber" name="L410" href="#L410">410</a>
-<a class="jxr_linenumber" name="L411" href="#L411">411</a> @Deprecated
-<a class="jxr_linenumber" name="L412" href="#L412">412</a> <strong
class="jxr_keyword">public</strong> String getPassphrase(MavenProject project) {
-<a class="jxr_linenumber" name="L413" href="#L413">413</a> String pass
= <strong class="jxr_keyword">null</strong>;
-<a class="jxr_linenumber" name="L414" href="#L414">414</a> <strong
class="jxr_keyword">if</strong> (project != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L415" href="#L415">415</a> pass =
project.getProperties().getProperty(GPG_PASSPHRASE);
-<a class="jxr_linenumber" name="L416" href="#L416">416</a> <strong
class="jxr_keyword">if</strong> (pass == <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L417" href="#L417">417</a>
MavenProject prj2 = findReactorProject(project);
-<a class="jxr_linenumber" name="L418" href="#L418">418</a>
pass = prj2.getProperties().getProperty(GPG_PASSPHRASE);
+<a class="jxr_linenumber" name="L312" href="#L312">312</a> doExecute();
+<a class="jxr_linenumber" name="L313" href="#L313">313</a> }
+<a class="jxr_linenumber" name="L314" href="#L314">314</a>
+<a class="jxr_linenumber" name="L315" href="#L315">315</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">void</strong> enforceBestPractices() <strong
class="jxr_keyword">throws</strong> MojoFailureException {
+<a class="jxr_linenumber" name="L316" href="#L316">316</a> <em
class="jxr_comment">// if any of those are not blank: meaning user did
explicitly configure these</em>
+<a class="jxr_linenumber" name="L317" href="#L317">317</a> <strong
class="jxr_keyword">if</strong> (isNotBlank(passphrase) ||
isNotBlank(passphraseServerId)) {
+<a class="jxr_linenumber" name="L318" href="#L318">318</a> <em
class="jxr_comment">// Stop propagating worst practices: passphrase MUST NOT be
in any file on disk</em>
+<a class="jxr_linenumber" name="L319" href="#L319">319</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoFailureException(
+<a class="jxr_linenumber" name="L320" href="#L320">320</a>
<span class="jxr_string">"Do not store passphrase in any file (disk or SCM
repository), rely on GnuPG agent or provide passphrase in "</span>
+<a class="jxr_linenumber" name="L321" href="#L321">321</a>
+ passphraseEnvName + <span class="jxr_string">" environment
variable."</span>);
+<a class="jxr_linenumber" name="L322" href="#L322">322</a> }
+<a class="jxr_linenumber" name="L323" href="#L323">323</a> }
+<a class="jxr_linenumber" name="L324" href="#L324">324</a>
+<a class="jxr_linenumber" name="L325" href="#L325">325</a> <strong
class="jxr_keyword">protected</strong> <strong
class="jxr_keyword">abstract</strong> <strong class="jxr_keyword">void</strong>
doExecute() <strong class="jxr_keyword">throws</strong> MojoExecutionException,
MojoFailureException;
+<a class="jxr_linenumber" name="L326" href="#L326">326</a>
+<a class="jxr_linenumber" name="L327" href="#L327">327</a> <strong
class="jxr_keyword">private</strong> <strong class="jxr_keyword">void</strong>
logBestPracticeWarning(String source) {
+<a class="jxr_linenumber" name="L328" href="#L328">328</a>
getLog().warn(<span class="jxr_string">""</span>);
+<a class="jxr_linenumber" name="L329" href="#L329">329</a>
getLog().warn(<span class="jxr_string">"W A R N I N G"</span>);
+<a class="jxr_linenumber" name="L330" href="#L330">330</a>
getLog().warn(<span class="jxr_string">""</span>);
+<a class="jxr_linenumber" name="L331" href="#L331">331</a>
getLog().warn(<span class="jxr_string">"Do not store passphrase in any file
(disk or SCM repository),"</span>);
+<a class="jxr_linenumber" name="L332" href="#L332">332</a>
getLog().warn(<span class="jxr_string">"instead rely on GnuPG agent or provide
passphrase in "</span>);
+<a class="jxr_linenumber" name="L333" href="#L333">333</a>
getLog().warn(passphraseEnvName + <span class="jxr_string">" environment
variable for batch mode."</span>);
+<a class="jxr_linenumber" name="L334" href="#L334">334</a>
getLog().warn(<span class="jxr_string">""</span>);
+<a class="jxr_linenumber" name="L335" href="#L335">335</a>
getLog().warn(<span class="jxr_string">"Sensitive content loaded from "</span>
+ source);
+<a class="jxr_linenumber" name="L336" href="#L336">336</a>
getLog().warn(<span class="jxr_string">""</span>);
+<a class="jxr_linenumber" name="L337" href="#L337">337</a> }
+<a class="jxr_linenumber" name="L338" href="#L338">338</a>
+<a class="jxr_linenumber" name="L339" href="#L339">339</a> <strong
class="jxr_keyword">protected</strong> <a name="AbstractGpgSigner"
href="../../../../../org/apache/maven/plugins/gpg/AbstractGpgSigner.html#AbstractGpgSigner">AbstractGpgSigner</a>
newSigner(MavenProject mavenProject) <strong
class="jxr_keyword">throws</strong> MojoFailureException {
+<a class="jxr_linenumber" name="L340" href="#L340">340</a> <a
name="AbstractGpgSigner"
href="../../../../../org/apache/maven/plugins/gpg/AbstractGpgSigner.html#AbstractGpgSigner">AbstractGpgSigner</a>
signer;
+<a class="jxr_linenumber" name="L341" href="#L341">341</a> <strong
class="jxr_keyword">if</strong> (GpgSigner.NAME.equals(<strong
class="jxr_keyword">this</strong>.signer)) {
+<a class="jxr_linenumber" name="L342" href="#L342">342</a> signer
= <strong class="jxr_keyword">new</strong> <a name="GpgSigner"
href="../../../../../org/apache/maven/plugins/gpg/GpgSigner.html#GpgSigner">GpgSigner</a>(executable);
+<a class="jxr_linenumber" name="L343" href="#L343">343</a> } <strong
class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>
(BcSigner.NAME.equals(<strong class="jxr_keyword">this</strong>.signer)) {
+<a class="jxr_linenumber" name="L344" href="#L344">344</a> signer
= <strong class="jxr_keyword">new</strong> <a name="BcSigner"
href="../../../../../org/apache/maven/plugins/gpg/BcSigner.html#BcSigner">BcSigner</a>(
+<a class="jxr_linenumber" name="L345" href="#L345">345</a>
session.getRepositorySession(),
+<a class="jxr_linenumber" name="L346" href="#L346">346</a>
keyEnvName,
+<a class="jxr_linenumber" name="L347" href="#L347">347</a>
keyFingerprintEnvName,
+<a class="jxr_linenumber" name="L348" href="#L348">348</a>
agentSocketLocations,
+<a class="jxr_linenumber" name="L349" href="#L349">349</a>
keyFilePath,
+<a class="jxr_linenumber" name="L350" href="#L350">350</a>
keyFingerprint);
+<a class="jxr_linenumber" name="L351" href="#L351">351</a> } <strong
class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L352" href="#L352">352</a> <strong
class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong>
MojoFailureException(<span class="jxr_string">"Unknown signer: "</span> +
<strong class="jxr_keyword">this</strong>.signer);
+<a class="jxr_linenumber" name="L353" href="#L353">353</a> }
+<a class="jxr_linenumber" name="L354" href="#L354">354</a>
+<a class="jxr_linenumber" name="L355" href="#L355">355</a>
signer.setLog(getLog());
+<a class="jxr_linenumber" name="L356" href="#L356">356</a>
signer.setInteractive(settings.isInteractiveMode());
+<a class="jxr_linenumber" name="L357" href="#L357">357</a>
signer.setKeyName(keyname);
+<a class="jxr_linenumber" name="L358" href="#L358">358</a>
signer.setUseAgent(useAgent);
+<a class="jxr_linenumber" name="L359" href="#L359">359</a>
signer.setHomeDirectory(homedir);
+<a class="jxr_linenumber" name="L360" href="#L360">360</a>
signer.setDefaultKeyring(defaultKeyring);
+<a class="jxr_linenumber" name="L361" href="#L361">361</a>
signer.setSecretKeyring(secretKeyring);
+<a class="jxr_linenumber" name="L362" href="#L362">362</a>
signer.setPublicKeyring(publicKeyring);
+<a class="jxr_linenumber" name="L363" href="#L363">363</a>
signer.setLockMode(lockMode);
+<a class="jxr_linenumber" name="L364" href="#L364">364</a>
signer.setArgs(gpgArguments);
+<a class="jxr_linenumber" name="L365" href="#L365">365</a>
+<a class="jxr_linenumber" name="L366" href="#L366">366</a> <em
class="jxr_comment">// "new way": env prevails</em>
+<a class="jxr_linenumber" name="L367" href="#L367">367</a> String
passphrase =
+<a class="jxr_linenumber" name="L368" href="#L368">368</a>
(String) session.getRepositorySession().getConfigProperties().get(<span
class="jxr_string">"env."</span> + passphraseEnvName);
+<a class="jxr_linenumber" name="L369" href="#L369">369</a> <strong
class="jxr_keyword">if</strong> (isNotBlank(passphrase)) {
+<a class="jxr_linenumber" name="L370" href="#L370">370</a>
signer.setPassPhrase(passphrase);
+<a class="jxr_linenumber" name="L371" href="#L371">371</a> } <strong
class="jxr_keyword">else</strong> <strong class="jxr_keyword">if</strong>
(!bestPractices) {
+<a class="jxr_linenumber" name="L372" href="#L372">372</a> <em
class="jxr_comment">// "old way": mojo config</em>
+<a class="jxr_linenumber" name="L373" href="#L373">373</a>
passphrase = <strong class="jxr_keyword">this</strong>.passphrase;
+<a class="jxr_linenumber" name="L374" href="#L374">374</a> <strong
class="jxr_keyword">if</strong> (isNotBlank(passphrase)) {
+<a class="jxr_linenumber" name="L375" href="#L375">375</a>
logBestPracticeWarning(<span class="jxr_string">"Mojo configuration"</span>);
+<a class="jxr_linenumber" name="L376" href="#L376">376</a>
signer.setPassPhrase(passphrase);
+<a class="jxr_linenumber" name="L377" href="#L377">377</a> }
<strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L378" href="#L378">378</a> <em
class="jxr_comment">// "old way": serverId + settings</em>
+<a class="jxr_linenumber" name="L379" href="#L379">379</a>
passphrase = loadGpgPassphrase();
+<a class="jxr_linenumber" name="L380" href="#L380">380</a>
<strong class="jxr_keyword">if</strong> (isNotBlank(passphrase)) {
+<a class="jxr_linenumber" name="L381" href="#L381">381</a>
logBestPracticeWarning(<span class="jxr_string">"settings.xml"</span>);
+<a class="jxr_linenumber" name="L382" href="#L382">382</a>
signer.setPassPhrase(passphrase);
+<a class="jxr_linenumber" name="L383" href="#L383">383</a> }
<strong class="jxr_keyword">else</strong> {
+<a class="jxr_linenumber" name="L384" href="#L384">384</a>
<em class="jxr_comment">// "old way": project properties</em>
+<a class="jxr_linenumber" name="L385" href="#L385">385</a>
passphrase = getPassphrase(mavenProject);
+<a class="jxr_linenumber" name="L386" href="#L386">386</a>
<strong class="jxr_keyword">if</strong> (isNotBlank(passphrase)) {
+<a class="jxr_linenumber" name="L387" href="#L387">387</a>
logBestPracticeWarning(<span class="jxr_string">"Project
properties"</span>);
+<a class="jxr_linenumber" name="L388" href="#L388">388</a>
signer.setPassPhrase(passphrase);
+<a class="jxr_linenumber" name="L389" href="#L389">389</a>
}
+<a class="jxr_linenumber" name="L390" href="#L390">390</a> }
+<a class="jxr_linenumber" name="L391" href="#L391">391</a> }
+<a class="jxr_linenumber" name="L392" href="#L392">392</a> }
+<a class="jxr_linenumber" name="L393" href="#L393">393</a>
signer.prepare();
+<a class="jxr_linenumber" name="L394" href="#L394">394</a>
+<a class="jxr_linenumber" name="L395" href="#L395">395</a> <strong
class="jxr_keyword">return</strong> signer;
+<a class="jxr_linenumber" name="L396" href="#L396">396</a> }
+<a class="jxr_linenumber" name="L397" href="#L397">397</a>
+<a class="jxr_linenumber" name="L398" href="#L398">398</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">boolean</strong> isNotBlank(String string) {
+<a class="jxr_linenumber" name="L399" href="#L399">399</a> <strong
class="jxr_keyword">return</strong> string != <strong
class="jxr_keyword">null</strong> && !string.trim().isEmpty();
+<a class="jxr_linenumber" name="L400" href="#L400">400</a> }
+<a class="jxr_linenumber" name="L401" href="#L401">401</a>
+<a class="jxr_linenumber" name="L402" href="#L402">402</a> <em
class="jxr_comment">// Below is attic, to be thrown out</em>
+<a class="jxr_linenumber" name="L403" href="#L403">403</a>
+<a class="jxr_linenumber" name="L404" href="#L404">404</a> @Deprecated
+<a class="jxr_linenumber" name="L405" href="#L405">405</a> <strong
class="jxr_keyword">private</strong> <strong
class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong>
String GPG_PASSPHRASE = <span class="jxr_string">"gpg.passphrase"</span>;
+<a class="jxr_linenumber" name="L406" href="#L406">406</a>
+<a class="jxr_linenumber" name="L407" href="#L407">407</a> @Deprecated
+<a class="jxr_linenumber" name="L408" href="#L408">408</a> <strong
class="jxr_keyword">private</strong> String loadGpgPassphrase() <strong
class="jxr_keyword">throws</strong> MojoFailureException {
+<a class="jxr_linenumber" name="L409" href="#L409">409</a> <strong
class="jxr_keyword">if</strong> (isNotBlank(passphraseServerId)) {
+<a class="jxr_linenumber" name="L410" href="#L410">410</a> Server
server = settings.getServer(passphraseServerId);
+<a class="jxr_linenumber" name="L411" href="#L411">411</a> <strong
class="jxr_keyword">if</strong> (server != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L412" href="#L412">412</a>
<strong class="jxr_keyword">if</strong> (isNotBlank(server.getPassphrase())) {
+<a class="jxr_linenumber" name="L413" href="#L413">413</a>
<strong class="jxr_keyword">try</strong> {
+<a class="jxr_linenumber" name="L414" href="#L414">414</a>
<strong class="jxr_keyword">return</strong>
secDispatcher.decrypt(server.getPassphrase());
+<a class="jxr_linenumber" name="L415" href="#L415">415</a>
} <strong class="jxr_keyword">catch</strong> (SecDispatcherException e) {
+<a class="jxr_linenumber" name="L416" href="#L416">416</a>
<strong class="jxr_keyword">throw</strong> <strong
class="jxr_keyword">new</strong> MojoFailureException(<span
class="jxr_string">"Unable to decrypt gpg passphrase"</span>, e);
+<a class="jxr_linenumber" name="L417" href="#L417">417</a>
}
+<a class="jxr_linenumber" name="L418" href="#L418">418</a> }
<a class="jxr_linenumber" name="L419" href="#L419">419</a> }
<a class="jxr_linenumber" name="L420" href="#L420">420</a> }
-<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong
class="jxr_keyword">if</strong> (project != <strong
class="jxr_keyword">null</strong> && pass != <strong
class="jxr_keyword">null</strong>) {
-<a class="jxr_linenumber" name="L422" href="#L422">422</a>
findReactorProject(project).getProperties().setProperty(GPG_PASSPHRASE, pass);
-<a class="jxr_linenumber" name="L423" href="#L423">423</a> }
-<a class="jxr_linenumber" name="L424" href="#L424">424</a> <strong
class="jxr_keyword">return</strong> pass;
-<a class="jxr_linenumber" name="L425" href="#L425">425</a> }
-<a class="jxr_linenumber" name="L426" href="#L426">426</a>
-<a class="jxr_linenumber" name="L427" href="#L427">427</a> @Deprecated
-<a class="jxr_linenumber" name="L428" href="#L428">428</a> <strong
class="jxr_keyword">private</strong> MavenProject
findReactorProject(MavenProject prj) {
-<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong
class="jxr_keyword">if</strong> (prj.getParent() != <strong
class="jxr_keyword">null</strong>
-<a class="jxr_linenumber" name="L430" href="#L430">430</a>
&& prj.getParent().getBasedir() != <strong
class="jxr_keyword">null</strong>
-<a class="jxr_linenumber" name="L431" href="#L431">431</a>
&& prj.getParent().getBasedir().exists()) {
-<a class="jxr_linenumber" name="L432" href="#L432">432</a> <strong
class="jxr_keyword">return</strong> findReactorProject(prj.getParent());
+<a class="jxr_linenumber" name="L421" href="#L421">421</a> <strong
class="jxr_keyword">return</strong> <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L422" href="#L422">422</a> }
+<a class="jxr_linenumber" name="L423" href="#L423">423</a>
+<a class="jxr_linenumber" name="L424" href="#L424">424</a> @Deprecated
+<a class="jxr_linenumber" name="L425" href="#L425">425</a> <strong
class="jxr_keyword">public</strong> String getPassphrase(MavenProject project) {
+<a class="jxr_linenumber" name="L426" href="#L426">426</a> String pass
= <strong class="jxr_keyword">null</strong>;
+<a class="jxr_linenumber" name="L427" href="#L427">427</a> <strong
class="jxr_keyword">if</strong> (project != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L428" href="#L428">428</a> pass =
project.getProperties().getProperty(GPG_PASSPHRASE);
+<a class="jxr_linenumber" name="L429" href="#L429">429</a> <strong
class="jxr_keyword">if</strong> (pass == <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L430" href="#L430">430</a>
MavenProject prj2 = findReactorProject(project);
+<a class="jxr_linenumber" name="L431" href="#L431">431</a>
pass = prj2.getProperties().getProperty(GPG_PASSPHRASE);
+<a class="jxr_linenumber" name="L432" href="#L432">432</a> }
<a class="jxr_linenumber" name="L433" href="#L433">433</a> }
-<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong
class="jxr_keyword">return</strong> prj;
-<a class="jxr_linenumber" name="L435" href="#L435">435</a> }
-<a class="jxr_linenumber" name="L436" href="#L436">436</a> }
+<a class="jxr_linenumber" name="L434" href="#L434">434</a> <strong
class="jxr_keyword">if</strong> (project != <strong
class="jxr_keyword">null</strong> && pass != <strong
class="jxr_keyword">null</strong>) {
+<a class="jxr_linenumber" name="L435" href="#L435">435</a>
findReactorProject(project).getProperties().setProperty(GPG_PASSPHRASE, pass);
+<a class="jxr_linenumber" name="L436" href="#L436">436</a> }
+<a class="jxr_linenumber" name="L437" href="#L437">437</a> <strong
class="jxr_keyword">return</strong> pass;
+<a class="jxr_linenumber" name="L438" href="#L438">438</a> }
+<a class="jxr_linenumber" name="L439" href="#L439">439</a>
+<a class="jxr_linenumber" name="L440" href="#L440">440</a> @Deprecated
+<a class="jxr_linenumber" name="L441" href="#L441">441</a> <strong
class="jxr_keyword">private</strong> MavenProject
findReactorProject(MavenProject prj) {
+<a class="jxr_linenumber" name="L442" href="#L442">442</a> <strong
class="jxr_keyword">if</strong> (prj.getParent() != <strong
class="jxr_keyword">null</strong>
+<a class="jxr_linenumber" name="L443" href="#L443">443</a>
&& prj.getParent().getBasedir() != <strong
class="jxr_keyword">null</strong>
+<a class="jxr_linenumber" name="L444" href="#L444">444</a>
&& prj.getParent().getBasedir().exists()) {
+<a class="jxr_linenumber" name="L445" href="#L445">445</a> <strong
class="jxr_keyword">return</strong> findReactorProject(prj.getParent());
+<a class="jxr_linenumber" name="L446" href="#L446">446</a> }
+<a class="jxr_linenumber" name="L447" href="#L447">447</a> <strong
class="jxr_keyword">return</strong> prj;
+<a class="jxr_linenumber" name="L448" href="#L448">448</a> }
+<a class="jxr_linenumber" name="L449" href="#L449">449</a> }
</pre>
<hr/>
<div id="footer">Copyright © 2002–2024 <a
href="https://www.apache.org/">The Apache Software Foundation</a>. All rights
reserved.</div>
Modified:
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/package-frame.html
==============================================================================
---
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/package-frame.html
(original)
+++
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/package-frame.html
Tue Apr 16 13:25:58 2024
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven GPG Plugin 3.2.3 Reference Package
org.apache.maven.plugins.gpg</title>
+ <title>Apache Maven GPG Plugin 3.2.4 Reference Package
org.apache.maven.plugins.gpg</title>
<link rel="stylesheet" type="text/css"
href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified:
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/package-summary.html
==============================================================================
---
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/package-summary.html
(original)
+++
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/gpg/package-summary.html
Tue Apr 16 13:25:58 2024
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven GPG Plugin 3.2.3 Reference Package
org.apache.maven.plugins.gpg</title>
+ <title>Apache Maven GPG Plugin 3.2.4 Reference Package
org.apache.maven.plugins.gpg</title>
<link rel="stylesheet" type="text/css"
href="../../../../../stylesheet.css" title="style" />
</head>
@@ -23,7 +23,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven GPG Plugin
3.2.3 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven GPG Plugin
3.2.4 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -156,7 +156,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven GPG Plugin
3.2.3 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven GPG Plugin
3.2.4 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
Modified:
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/maven_gpg_plugin/package-frame.html
==============================================================================
---
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/maven_gpg_plugin/package-frame.html
(original)
+++
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/maven_gpg_plugin/package-frame.html
Tue Apr 16 13:25:58 2024
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven GPG Plugin 3.2.3 Reference Package
org.apache.maven.plugins.maven_gpg_plugin</title>
+ <title>Apache Maven GPG Plugin 3.2.4 Reference Package
org.apache.maven.plugins.maven_gpg_plugin</title>
<link rel="stylesheet" type="text/css"
href="../../../../../stylesheet.css" title="style" />
</head>
<body>
Modified:
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/maven_gpg_plugin/package-summary.html
==============================================================================
---
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/maven_gpg_plugin/package-summary.html
(original)
+++
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/org/apache/maven/plugins/maven_gpg_plugin/package-summary.html
Tue Apr 16 13:25:58 2024
@@ -4,7 +4,7 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven GPG Plugin 3.2.3 Reference Package
org.apache.maven.plugins.maven_gpg_plugin</title>
+ <title>Apache Maven GPG Plugin 3.2.4 Reference Package
org.apache.maven.plugins.maven_gpg_plugin</title>
<link rel="stylesheet" type="text/css"
href="../../../../../stylesheet.css" title="style" />
</head>
@@ -23,7 +23,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven GPG Plugin
3.2.3 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven GPG Plugin
3.2.4 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
@@ -81,7 +81,7 @@
<li>Index</li>
<li>Help</li>
</ul>
- <div class="aboutLanguage"><em><strong>Apache Maven GPG Plugin
3.2.3 Reference</strong></em></div>
+ <div class="aboutLanguage"><em><strong>Apache Maven GPG Plugin
3.2.4 Reference</strong></em></div>
</div>
<div class="subNav">
<ul class="navList">
Modified:
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/overview-frame.html
==============================================================================
---
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/overview-frame.html
(original)
+++
maven/website/components/plugins-archives/maven-gpg-plugin-LATEST/xref/overview-frame.html
Tue Apr 16 13:25:58 2024
@@ -4,11 +4,11 @@
<!-- generated by Apache Maven JXR (jdk8) -->
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
- <title>Apache Maven GPG Plugin 3.2.3 Reference</title>
+ <title>Apache Maven GPG Plugin 3.2.4 Reference</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css"
title="style" />
</head>
<body>
- <h1 title="Apache Maven GPG Plugin 3.2.3 Reference"
class="bar"><strong>Apache Maven GPG Plugin 3.2.3 Reference</strong></h1>
+ <h1 title="Apache Maven GPG Plugin 3.2.4 Reference"
class="bar"><strong>Apache Maven GPG Plugin 3.2.4 Reference</strong></h1>
<div class="indexHeader"><span><a href="allclasses-frame.html"
target="packageFrame">All Classes</a></span></div>
<div class="indexContainer">
<h2 title="Packages">Packages</h2>