-
Notifications
You must be signed in to change notification settings - Fork 4.6k
/
Sign.java
393 lines (348 loc) · 13.2 KB
/
Sign.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
/*
* Copyright 2016 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.gradle.plugins.signing;
import com.google.common.base.Predicates;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import org.gradle.api.Buildable;
import org.gradle.api.DefaultTask;
import org.gradle.api.DomainObjectSet;
import org.gradle.api.Incubating;
import org.gradle.api.InvalidUserDataException;
import org.gradle.api.Task;
import org.gradle.api.artifacts.Configuration;
import org.gradle.api.artifacts.PublishArtifact;
import org.gradle.api.file.FileCollection;
import org.gradle.api.internal.CollectionCallbackActionDecorator;
import org.gradle.api.internal.file.FileCollectionFactory;
import org.gradle.api.publish.Publication;
import org.gradle.api.publish.PublicationArtifact;
import org.gradle.api.publish.internal.PublicationInternal;
import org.gradle.api.tasks.Input;
import org.gradle.api.tasks.Internal;
import org.gradle.api.tasks.Nested;
import org.gradle.api.tasks.Optional;
import org.gradle.api.tasks.TaskAction;
import org.gradle.api.tasks.bundling.AbstractArchiveTask;
import org.gradle.internal.serialization.Cached;
import org.gradle.internal.serialization.Transient;
import org.gradle.plugins.signing.signatory.Signatory;
import org.gradle.plugins.signing.type.SignatureType;
import org.gradle.work.DisableCachingByDefault;
import javax.inject.Inject;
import java.io.File;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.Callable;
import java.util.function.Predicate;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import static java.util.function.Function.identity;
import static java.util.stream.Collectors.toMap;
import static org.gradle.api.internal.lambdas.SerializableLambdas.spec;
/**
* A task for creating digital signature files for one or more; tasks, files, publishable artifacts or configurations.
*
* <p>The task produces {@link Signature}</p> objects that are publishable artifacts and can be assigned to another configuration. <p> The signature objects are created with defaults and using this
* tasks signatory and signature type.
*/
@DisableCachingByDefault(because = "Not made cacheable, yet")
public abstract class Sign extends DefaultTask implements SignatureSpec {
private SignatureType signatureType;
private Signatory signatory;
private boolean required = true;
private final Transient<DomainObjectSet<Signature>> signatures = Transient.of(getProject().getObjects().domainObjectSet(Signature.class));
private final Cached<Collection<Signature.Generator>> generators = Cached.of(this::computeCachedSignatures);
private List<Signature.Generator> computeCachedSignatures() {
if (getSignatory() == null) {
// The task will fail, so we don't need any state.
return Collections.emptyList();
}
return signatureStream()
.map(Signature::getGenerator)
.filter(Objects::nonNull)
.collect(Collectors.toList());
}
private Stream<Signature> signatureStream() {
return getSignatures().stream();
}
@Inject
public Sign() {
// If we aren't required and don't have a signatory then we just don't run
onlyIf("Signing is required, or signatory is set", spec(task -> isRequired() || getSignatory() != null));
}
/**
* Configures the task to sign the archive produced for each of the given tasks (which must be archive tasks).
*/
public void sign(Task... tasks) {
for (Task task : tasks) {
if (!(task instanceof AbstractArchiveTask)) {
throw new InvalidUserDataException("You cannot sign tasks that are not \'archive\' tasks, such as \'jar\', \'zip\' etc. (you tried to sign " + task + ")");
}
signTask((AbstractArchiveTask) task);
}
}
private void signTask(final AbstractArchiveTask archiveTask) {
dependsOn(archiveTask);
addSignature(new Signature(() -> archiveTask.getArchiveFile().get().getAsFile(), () -> archiveTask.getArchiveClassifier().getOrNull(), this, this));
}
/**
* Configures the task to sign each of the given artifacts
*/
public void sign(PublishArtifact... publishArtifacts) {
for (PublishArtifact publishArtifact : publishArtifacts) {
signArtifact(publishArtifact);
}
}
private void signArtifact(PublishArtifact publishArtifact) {
dependsOn(publishArtifact);
addSignature(new Signature(publishArtifact, this, this));
}
/**
* Configures the task to sign each of the given files
*/
public void sign(File... files) {
addSignatures(null, files);
}
/**
* Configures the task to sign each of the given artifacts, using the given classifier as the classifier for the resultant signature publish artifact.
*/
public void sign(String classifier, File... files) {
addSignatures(classifier, files);
}
private void addSignatures(String classifier, File[] files) {
for (File file : files) {
addSignature(new Signature(file, classifier, this, this));
}
}
/**
* Configures the task to sign every artifact of the given configurations
*/
public void sign(Configuration... configurations) {
for (Configuration configuration : configurations) {
configuration.getAllArtifacts().all(artifact -> {
if (artifact instanceof Signature || hasSignatureFor(artifact)) {
return;
}
signArtifact(artifact);
});
configuration.getAllArtifacts().whenObjectRemoved(this::removeSignature);
}
}
private boolean hasSignatureFor(Buildable source) {
return signatureStream().anyMatch(hasSource(source));
}
/**
* Configures the task to sign every artifact of the given publications
*
* @since 4.8
*/
public void sign(Publication... publications) {
for (Publication publication : publications) {
PublicationInternal<?> publicationInternal = (PublicationInternal<?>) publication;
dependsOn((Callable<Set<? extends PublicationArtifact>>) () -> {
return publicationInternal.getPublishableArtifacts().matching(this::isNoSignatureArtifact);
});
publicationInternal.allPublishableArtifacts(artifact -> {
if (isNoSignatureArtifact(artifact)) {
addSignature(new Signature(artifact, artifact::getFile, null, null, this, this));
}
});
publicationInternal.whenPublishableArtifactRemoved(this::removeSignature);
}
}
private boolean isNoSignatureArtifact(PublicationArtifact artifact) {
return !getSignatureFiles().contains(artifact.getFile());
}
private void addSignature(Signature signature) {
getSignatures().add(signature);
}
private void removeSignature(final Buildable source) {
getSignatures().removeIf(hasSource(source));
}
private Predicate<Signature> hasSource(Buildable source) {
return signature -> signature.getSource().equals(source);
}
/**
* Changes the signatory of the signatures.
*/
public void signatory(Signatory signatory) {
this.signatory = signatory;
}
/**
* Change whether or not this task should fail if no signatory or signature type are configured at the time of generation.
*/
public void required(boolean required) {
setRequired(required);
}
/**
* Generates the signature files.
*/
@TaskAction
public void generate() {
if (getSignatory() == null) {
throw new InvalidUserDataException("Cannot perform signing task \'" + getPath() + "\' because it has no configured signatory");
}
for (Signature.Generator signature : sanitizedGenerators().values()) {
signature.generate();
}
}
/**
* The signatures generated by this task.
*/
@Internal
public DomainObjectSet<Signature> getSignatures() {
return signatures.get();
}
/**
* The signature generators for this task mapped by a unique key used for up-to-date checking.
*
* @since 8.1
*/
@Nested
@Incubating
public Map<String, Signature.Generator> getGeneratorsByKey() {
return sanitizedGenerators();
}
/**
* The signatures generated by this task mapped by a unique key used for up-to-date checking.
*
* @since 5.1
*/
@Internal
public Map<String, Signature> getSignaturesByKey() {
return sanitizedSignatures();
}
private Map<String, Signature.Generator> sanitizedGenerators() {
return sanitize(
signatures.isPresent()
? computeCachedSignatures()
: generators.get()
);
}
/**
* Returns signature generators mapped by their key with duplicated and non-existing inputs removed.
*/
private static Map<String, Signature.Generator> sanitize(Collection<Signature.Generator> generators) {
return generators.stream()
.filter(signature -> signature.getToSign().exists())
.collect(
toMap(
signature -> signature.getToSign().toPath().toAbsolutePath().toString(),
identity(),
(signature, duplicate) -> signature
)
);
}
/**
* Returns the single signature generated by this task.
*
* @return The signature.
* @throws IllegalStateException if there is not exactly one signature.
*/
@Internal
public Signature getSingleSignature() {
Map<String, Signature> sanitizedSignatures = sanitizedSignatures();
if (sanitizedSignatures.size() == 1) {
return sanitizedSignatures.values().iterator().next();
}
throw new IllegalStateException("Expected %s to contain exactly one signature, however, it contains " + sanitizedSignatures.size() + " signatures.");
}
private Map<String, Signature> sanitizedSignatures() {
return getSignatures().matching(signature -> signature.getToSign().exists())
.stream()
.collect(
toMap(
signature -> signature.getToSign().toPath().toAbsolutePath().toString(),
identity(),
(signature, duplicate) -> signature
)
);
}
@Inject
protected FileCollectionFactory getFileCollectionFactory() {
// Implementation provided by decoration
throw new UnsupportedOperationException();
}
/**
* All of the files that will be signed by this task.
*/
@Internal
public FileCollection getFilesToSign() {
return getFileCollectionFactory().fixed("Task \'" + getPath() + "\' files to sign",
Lists.newLinkedList(Iterables.filter(Iterables.transform(getSignatures(), Signature::getToSign), Predicates.notNull())));
}
/**
* All of the signature files that will be generated by this operation.
*/
@Internal
public FileCollection getSignatureFiles() {
return getFileCollectionFactory().fixed("Task \'" + getPath() + "\' signature files",
Lists.newLinkedList(Iterables.filter(Iterables.transform(getSignatures(), Signature::getFile), Predicates.notNull())));
}
@Override
@Nested
@Optional
public SignatureType getSignatureType() {
return signatureType;
}
@Override
public void setSignatureType(SignatureType signatureType) {
this.signatureType = signatureType;
}
/**
* Returns the signatory for this signing task.
*
* @return the signatory
*/
@Override
@Nested
@Optional
public Signatory getSignatory() {
return signatory;
}
@Override
public void setSignatory(Signatory signatory) {
this.signatory = signatory;
}
/**
* Whether or not this task should fail if no signatory or signature type are configured at generation time.
*
* <p>Defaults to {@code true}.</p>
*/
@Override
@Input
public boolean isRequired() {
return required;
}
@Override
public void setRequired(boolean required) {
this.required = required;
}
/**
* Required for decorating reports container callbacks for tracing user code application.
*
* @since 5.1
*/
@Inject
protected CollectionCallbackActionDecorator getCallbackActionDecorator() {
throw new UnsupportedOperationException();
}
}