Class SigningExtension
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringThe name of the configuration that all signature artifacts will be placed into ("signatures")
- 
Constructor SummaryConstructorsConstructorDescriptionSigningExtension(Project project) Configures the signing settings for the given project.
- 
Method SummaryModifier and TypeMethodDescriptionprotected voidAdds conventions to the given spec, using this settings object's default signatory and signature type as the default signatory and signature type for the spec.protected ObjectaddSignaturesToConfiguration(Sign task, Configuration configuration) protected SignatoryProvider<?> Provides the signatory provider.protected SignatureTypeProviderProvides the signature type provider.protected SignOperationdoSignOperation(Closure<?> setup) protected SignOperationdoSignOperation(Action<SignOperation> setup) The configuration that signature artifacts are added to.protected ConfigurationProvides the configuration that signature artifacts are added to.final ProjectThe signatory that will be used for signing when an explicit signatory has not been specified.The signature type that will be used for signing files when an explicit signature type has not been specified.booleanWhether this task should fail if no signatory or signature type are configured at generation time.voidsetConfiguration(Configuration configuration) voidsetRequired(boolean required) Whether this task should fail if no signatory or signature type are configured at generation time.voidsetRequired(Object required) Whether this task should fail if no signatory or signature type are configured at generation time.voidsetSignatories(SignatoryProvider<?> signatories) voidsetSignatureTypes(SignatureTypeProvider signatureTypes) Creates a newsign operationusing the given closure to configure it before executing it.Digitally signs the files, generating signature files alongside them.Digitally signs the files, generating signature files alongside them.sign(Action<SignOperation> setup) Creates a newsign operationusing the given action to configure it before executing it.sign(Configuration... configurations) Creates signing tasks that signall artifactsof the given configurations.sign(PublishArtifact... publishArtifacts) Digitally signs the publish artifacts, generating signature files alongside them.sign(DomainObjectCollection<Publication> publications) Creates signing tasks that sign all publishable artifacts of the given publication collection.sign(Publication... publications) Creates signing tasks that sign all publishable artifacts of the given publications.Creates signing tasks that depend on and sign the "archive" produced by the given tasks.signatories(Closure<?> closure) Configures the signatory provider (delegating to itsconfigure method).voidUse GnuPG agent to perform signing work.voiduseInMemoryPgpKeys(String defaultSecretKey, String defaultPassword) Use the supplied ascii-armored in-memory PGP secret key and password instead of reading it from a keyring.voiduseInMemoryPgpKeys(String defaultKeyId, String defaultSecretKey, String defaultPassword) Use the supplied ascii-armored in-memory PGP secret key and password instead of reading it from a keyring.
- 
Field Details- 
DEFAULT_CONFIGURATION_NAMEThe name of the configuration that all signature artifacts will be placed into ("signatures")- See Also:
 
 
- 
- 
Constructor Details- 
SigningExtensionConfigures the signing settings for the given project.
 
- 
- 
Method Details- 
getProject
- 
setRequiredpublic void setRequired(boolean required) Whether this task should fail if no signatory or signature type are configured at generation time.- Since:
- 4.0
 
- 
setRequiredWhether this task should fail if no signatory or signature type are configured at generation time. Ifrequiredis aCallable, it will be stored and "called" on demand (i.e. whenisRequired()is called) and the return value will be interpreting according to the Groovy Truth. For example:signing { required = { gradle.taskGraph.hasTask("publish") } }Because the task graph is not known until Gradle starts executing, we must use defer the decision. We can do this via using aClosure(which is aCallable). For any other type, the value will be stored and evaluated on demand according to the Groovy Truth.signing { required = false }
- 
isRequiredpublic boolean isRequired()Whether this task should fail if no signatory or signature type are configured at generation time.Defaults to true.- See Also:
 
- 
getDefaultConfigurationProvides the configuration that signature artifacts are added to. Called once during construction.
- 
createSignatureTypeProviderProvides the signature type provider. Called once during construction.
- 
createSignatoryProviderProvides the signatory provider. Called once during construction.
- 
signatoriesConfigures the signatory provider (delegating to itsconfigure method).- Parameters:
- closure- the signatory provider configuration DSL
- Returns:
- the configured signatory provider
 
- 
getSignatoryThe signatory that will be used for signing when an explicit signatory has not been specified.Delegates to the signatory provider's default signatory. 
- 
getSignatureTypeThe signature type that will be used for signing files when an explicit signature type has not been specified.Delegates to the signature type provider's default type. 
- 
setSignatureTypes
- 
getSignatureTypes
- 
setSignatories
- 
setConfiguration
- 
useGpgCmdpublic void useGpgCmd()Use GnuPG agent to perform signing work.- Since:
- 4.5
 
- 
useInMemoryPgpKeysUse the supplied ascii-armored in-memory PGP secret key and password instead of reading it from a keyring.signing { def secretKey = findProperty("mySigningKey") def password = findProperty("mySigningPassword") useInMemoryPgpKeys(secretKey, password) }- Since:
- 5.4
 
- 
useInMemoryPgpKeyspublic void useInMemoryPgpKeys(@Nullable String defaultKeyId, @Nullable String defaultSecretKey, @Nullable String defaultPassword) Use the supplied ascii-armored in-memory PGP secret key and password instead of reading it from a keyring. In case a signing subkey is provided, keyId must be provided as well.signing { def keyId = findProperty("keyId") def secretKey = findProperty("mySigningKey") def password = findProperty("mySigningPassword") useInMemoryPgpKeys(keyId, secretKey, password) }- Since:
- 6.0
 
- 
getConfigurationThe configuration that signature artifacts are added to.
- 
addSignatureSpecConventionsAdds conventions to the given spec, using this settings object's default signatory and signature type as the default signatory and signature type for the spec.
- 
signCreates signing tasks that depend on and sign the "archive" produced by the given tasks.The created tasks will be named "sign<input task name capitalized>". That is, given a task with the name "jar" the created task will be named "signJar". If the task is not an AbstractArchiveTask, anInvalidUserDataExceptionwill be thrown.The signature artifact for the created task is added to the for this settings object.- Parameters:
- tasks- The tasks whose archives are to be signed
- Returns:
- the created tasks.
 
- 
signCreates signing tasks that signall artifactsof the given configurations.The created tasks will be named "sign<configuration name capitalized>". That is, given a configuration with the name "conf" the created task will be named "signConf". The signature artifacts for the created tasks are added to the configurationfor this settings object.- Parameters:
- configurations- The configurations whose archives are to be signed
- Returns:
- the created tasks.
 
- 
signCreates signing tasks that sign all publishable artifacts of the given publications.The created tasks will be named "sign<publication name capitalized>Publication". That is, given a publication with the name "mavenJava" the created task will be named "signMavenJavaPublication". The signature artifacts for the created tasks are added to the publishable artifacts of the given publications. - Parameters:
- publications- The publications whose artifacts are to be signed
- Returns:
- the created tasks.
- Since:
- 4.8
 
- 
signCreates signing tasks that sign all publishable artifacts of the given publication collection.The created tasks will be named "sign<publication name capitalized>Publication". That is, given a publication with the name "mavenJava" the created task will be named "signMavenJavaPublication". The signature artifacts for the created tasks are added to the publishable artifacts of the given publications. - Parameters:
- publications- The collection of publications whose artifacts are to be signed
- Returns:
- the created tasks.
- Since:
- 4.8
 
- 
addSignaturesToConfiguration
- 
signDigitally signs the publish artifacts, generating signature files alongside them.The project's default signatory and default signature type from the signing settingswill be used to generate the signature. The returnedsign operationgives access to the created signature files.If there is no configured default signatory available, the sign operation will fail. - Parameters:
- publishArtifacts- The publish artifacts to sign
- Returns:
- The executed sign operation
 
- 
signDigitally signs the files, generating signature files alongside them.The project's default signatory and default signature type from the signing settingswill be used to generate the signature. The returnedsign operationgives access to the created signature files.If there is no configured default signatory available, the sign operation will fail. - Parameters:
- files- The files to sign.
- Returns:
- The executed sign operation.
 
- 
signDigitally signs the files, generating signature files alongside them.The project's default signatory and default signature type from the signing settingswill be used to generate the signature. The returnedsign operationgives access to the created signature files.If there is no configured default signatory available, the sign operation will fail. - Parameters:
- classifier- The classifier to assign to the created signature artifacts.
- files- The publish artifacts to sign.
- Returns:
- The executed sign operation.
 
- 
signCreates a newsign operationusing the given closure to configure it before executing it.The project's default signatory and default signature type from the signing settingswill be used to generate the signature. The returnedsign operationgives access to the created signature files.If there is no configured default signatory available (and one is not explicitly specified in this operation's configuration), the sign operation will fail. - Parameters:
- closure- The configuration of the- sign operation.
- Returns:
- The executed sign operation.
 
- 
signCreates a newsign operationusing the given action to configure it before executing it.The project's default signatory and default signature type from the signing settingswill be used to generate the signature. The returnedsign operationgives access to the created signature files.If there is no configured default signatory available (and one is not explicitly specified in this operation's configuration), the sign operation will fail. - Parameters:
- setup- The configuration action of the- sign operation.
- Returns:
- The executed sign operation.
- Since:
- 7.5
 
- 
doSignOperation
- 
doSignOperation
- 
getSignatories
 
-