Source code

001/*
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *   http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing,
013 * software distributed under the License is distributed on an
014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 * KIND, either express or implied.  See the License for the
016 * specific language governing permissions and limitations
017 * under the License.
018 */
019package org.eclipse.aether.internal.impl.checksum;
020
021import javax.inject.Inject;
022import javax.inject.Named;
023import javax.inject.Singleton;
024
025import java.io.BufferedReader;
026import java.io.IOException;
027import java.io.UncheckedIOException;
028import java.nio.charset.StandardCharsets;
029import java.nio.file.Files;
030import java.nio.file.Path;
031import java.util.ArrayList;
032import java.util.HashMap;
033import java.util.List;
034import java.util.Map;
035import java.util.Objects;
036import java.util.concurrent.ConcurrentHashMap;
037import java.util.concurrent.atomic.AtomicBoolean;
038import java.util.function.Function;
039import java.util.stream.Collectors;
040
041import org.eclipse.aether.MultiRuntimeException;
042import org.eclipse.aether.RepositorySystemSession;
043import org.eclipse.aether.artifact.Artifact;
044import org.eclipse.aether.impl.RepositorySystemLifecycle;
045import org.eclipse.aether.internal.impl.LocalPathComposer;
046import org.eclipse.aether.repository.ArtifactRepository;
047import org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory;
048import org.eclipse.aether.spi.io.PathProcessor;
049import org.eclipse.aether.util.ConfigUtils;
050import org.eclipse.aether.util.repository.RepositoryIdHelper;
051import org.slf4j.Logger;
052import org.slf4j.LoggerFactory;
053
054import static java.util.Objects.requireNonNull;
055
056/**
057 * Compact file {@link FileTrustedChecksumsSourceSupport} implementation that use specified directory as base
058 * directory, where it expects a "summary" file named as "checksums.${checksumExt}" for each checksum algorithm.
059 * File format is GNU Coreutils compatible: each line holds checksum followed by two spaces and artifact relative path
060 * (from local repository root, without leading "./"). This means that trusted checksums summary file can be used to
061 * validate artifacts or generate it using standard GNU tools like GNU {@code sha1sum} is (for BSD derivatives same
062 * file can be used with {@code -r} switch).
063 * <p>
064 * The format supports comments "#" (hash) and empty lines for easier structuring the file content, and both are
065 * ignored. Also, their presence makes the summary file incompatible with GNU Coreutils format. On save of the
066 * summary file, the comments and empty lines are lost, and file is sorted by path names for easier diffing
067 * (2nd column in file).
068 * <p>
069 * The source by default is "origin aware", and it will factor in origin repository ID as well into summary file name,
070 * for example "checksums-central.sha256".
071 * <p>
072 * Example commands for managing summary file (in examples will use repository ID "central"):
073 * <ul>
074 *     <li>To create summary file: {@code find * -not -name "checksums-central.sha256" -type f -print0 |
075 *       xargs -0 sha256sum | sort -k 2 > checksums-central.sha256}</li>
076 *     <li>To verify artifacts using summary file: {@code sha256sum --quiet -c checksums-central.sha256}</li>
077 * </ul>
078 * <p>
079 * The checksums summary file is lazily loaded and remains cached during lifetime of the component, so file changes
080 * during lifecycle of the component are not picked up. This implementation can be simultaneously used to lookup and
081 * also record checksums. The recorded checksums will become visible for every session, and will be flushed
082 * at repository system shutdown, merged with existing ones on disk.
083 * <p>
084 * The name of this implementation is "summaryFile".
085 *
086 * @see <a href="https://man7.org/linux/man-pages/man1/sha1sum.1.html">sha1sum man page</a>
087 * @see <a href="https://www.gnu.org/software/coreutils/manual/coreutils.html#md5sum-invocation">GNU Coreutils: md5sum</a>
088 * @since 1.9.0
089 */
090@Singleton
091@Named(SummaryFileTrustedChecksumsSource.NAME)
092public final class SummaryFileTrustedChecksumsSource extends FileTrustedChecksumsSourceSupport {
093    public static final String NAME = "summaryFile";
094
095    private static final String CONFIG_PROPS_PREFIX =
096            FileTrustedChecksumsSourceSupport.CONFIG_PROPS_PREFIX + NAME + ".";
097
098    /**
099     * Is checksum source enabled?
100     *
101     * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
102     * @configurationType {@link java.lang.Boolean}
103     * @configurationDefaultValue false
104     */
105    public static final String CONFIG_PROP_ENABLED = FileTrustedChecksumsSourceSupport.CONFIG_PROPS_PREFIX + NAME;
106
107    /**
108     * The basedir where checksums are. If relative, is resolved from local repository root.
109     *
110     * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
111     * @configurationType {@link java.lang.String}
112     * @configurationDefaultValue {@link #LOCAL_REPO_PREFIX_DIR}
113     */
114    public static final String CONFIG_PROP_BASEDIR = CONFIG_PROPS_PREFIX + "basedir";
115
116    public static final String LOCAL_REPO_PREFIX_DIR = ".checksums";
117
118    /**
119     * Is source origin aware?
120     *
121     * @configurationSource {@link RepositorySystemSession#getConfigProperties()}
122     * @configurationType {@link java.lang.Boolean}
123     * @configurationDefaultValue true
124     */
125    public static final String CONFIG_PROP_ORIGIN_AWARE = CONFIG_PROPS_PREFIX + "originAware";
126
127    public static final String CHECKSUMS_FILE_PREFIX = "checksums";
128
129    private static final Logger LOGGER = LoggerFactory.getLogger(SummaryFileTrustedChecksumsSource.class);
130
131    private final LocalPathComposer localPathComposer;
132
133    private final RepositorySystemLifecycle repositorySystemLifecycle;
134
135    private final PathProcessor pathProcessor;
136
137    private final ConcurrentHashMap<Path, ConcurrentHashMap<String, String>> checksums;
138
139    private final ConcurrentHashMap<Path, Boolean> changedChecksums;
140
141    private final AtomicBoolean onShutdownHandlerRegistered;
142
143    @Inject
144    public SummaryFileTrustedChecksumsSource(
145            LocalPathComposer localPathComposer,
146            RepositorySystemLifecycle repositorySystemLifecycle,
147            PathProcessor pathProcessor) {
148        this.localPathComposer = requireNonNull(localPathComposer);
149        this.repositorySystemLifecycle = requireNonNull(repositorySystemLifecycle);
150        this.pathProcessor = requireNonNull(pathProcessor);
151        this.checksums = new ConcurrentHashMap<>();
152        this.changedChecksums = new ConcurrentHashMap<>();
153        this.onShutdownHandlerRegistered = new AtomicBoolean(false);
154    }
155
156    @Override
157    protected boolean isEnabled(RepositorySystemSession session) {
158        return ConfigUtils.getBoolean(session, false, CONFIG_PROP_ENABLED);
159    }
160
161    private boolean isOriginAware(RepositorySystemSession session) {
162        return ConfigUtils.getBoolean(session, true, CONFIG_PROP_ORIGIN_AWARE);
163    }
164
165    @Override
166    protected Map<String, String> doGetTrustedArtifactChecksums(
167            RepositorySystemSession session,
168            Artifact artifact,
169            ArtifactRepository artifactRepository,
170            List<ChecksumAlgorithmFactory> checksumAlgorithmFactories) {
171        final HashMap<String, String> result = new HashMap<>();
172        final Path basedir = getBasedir(session, LOCAL_REPO_PREFIX_DIR, CONFIG_PROP_BASEDIR, false);
173        if (Files.isDirectory(basedir)) {
174            final String artifactPath = localPathComposer.getPathForArtifact(artifact, false);
175            final boolean originAware = isOriginAware(session);
176            for (ChecksumAlgorithmFactory checksumAlgorithmFactory : checksumAlgorithmFactories) {
177                Path summaryFile = summaryFile(
178                        basedir,
179                        originAware,
180                        RepositoryIdHelper.cachedIdToPathSegment(session).apply(artifactRepository),
181                        checksumAlgorithmFactory.getFileExtension());
182                ConcurrentHashMap<String, String> algorithmChecksums =
183                        checksums.computeIfAbsent(summaryFile, f -> loadProvidedChecksums(summaryFile));
184                String checksum = algorithmChecksums.get(artifactPath);
185                if (checksum != null) {
186                    result.put(checksumAlgorithmFactory.getName(), checksum);
187                }
188            }
189        }
190        return result;
191    }
192
193    @Override
194    protected Writer doGetTrustedArtifactChecksumsWriter(RepositorySystemSession session) {
195        if (onShutdownHandlerRegistered.compareAndSet(false, true)) {
196            repositorySystemLifecycle.addOnSystemEndedHandler(this::saveRecordedLines);
197        }
198        return new SummaryFileWriter(
199                checksums,
200                getBasedir(session, LOCAL_REPO_PREFIX_DIR, CONFIG_PROP_BASEDIR, true),
201                isOriginAware(session),
202                RepositoryIdHelper.cachedIdToPathSegment(session));
203    }
204
205    /**
206     * Returns the summary file path. The file itself and its parent directories may not exist, this method merely
207     * calculate the path.
208     */
209    private Path summaryFile(Path basedir, boolean originAware, String safeRepositoryId, String checksumExtension) {
210        String fileName = CHECKSUMS_FILE_PREFIX;
211        if (originAware) {
212            fileName += "-" + safeRepositoryId;
213        }
214        return basedir.resolve(fileName + "." + checksumExtension);
215    }
216
217    private ConcurrentHashMap<String, String> loadProvidedChecksums(Path summaryFile) {
218        ConcurrentHashMap<String, String> result = new ConcurrentHashMap<>();
219        if (Files.isRegularFile(summaryFile)) {
220            try (BufferedReader reader = Files.newBufferedReader(summaryFile, StandardCharsets.UTF_8)) {
221                String line;
222                while ((line = reader.readLine()) != null) {
223                    if (!line.startsWith("#") && !line.isEmpty()) {
224                        String[] parts = line.split("  ", 2);
225                        if (parts.length == 2) {
226                            String newChecksum = parts[0];
227                            String artifactPath = parts[1];
228                            String oldChecksum = result.put(artifactPath, newChecksum);
229                            if (oldChecksum != null) {
230                                if (Objects.equals(oldChecksum, newChecksum)) {
231                                    LOGGER.warn(
232                                            "Checksums file '{}' contains duplicate checksums for artifact {}: {}",
233                                            summaryFile,
234                                            artifactPath,
235                                            oldChecksum);
236                                } else {
237                                    LOGGER.warn(
238                                            "Checksums file '{}' contains different checksums for artifact {}: "
239                                                    + "old '{}' replaced by new '{}'",
240                                            summaryFile,
241                                            artifactPath,
242                                            oldChecksum,
243                                            newChecksum);
244                                }
245                            }
246                        } else {
247                            LOGGER.warn("Checksums file '{}' ignored malformed line '{}'", summaryFile, line);
248                        }
249                    }
250                }
251            } catch (IOException e) {
252                throw new UncheckedIOException(e);
253            }
254            LOGGER.info("Loaded {} trusted checksums from {}", result.size(), summaryFile);
255        }
256        return result;
257    }
258
259    private class SummaryFileWriter implements Writer {
260        private final ConcurrentHashMap<Path, ConcurrentHashMap<String, String>> cache;
261
262        private final Path basedir;
263
264        private final boolean originAware;
265
266        private final Function<ArtifactRepository, String> idToPathSegmentFunction;
267
268        private SummaryFileWriter(
269                ConcurrentHashMap<Path, ConcurrentHashMap<String, String>> cache,
270                Path basedir,
271                boolean originAware,
272                Function<ArtifactRepository, String> idToPathSegmentFunction) {
273            this.cache = cache;
274            this.basedir = basedir;
275            this.originAware = originAware;
276            this.idToPathSegmentFunction = idToPathSegmentFunction;
277        }
278
279        @Override
280        public void addTrustedArtifactChecksums(
281                Artifact artifact,
282                ArtifactRepository artifactRepository,
283                List<ChecksumAlgorithmFactory> checksumAlgorithmFactories,
284                Map<String, String> trustedArtifactChecksums) {
285            String artifactPath = localPathComposer.getPathForArtifact(artifact, false);
286            for (ChecksumAlgorithmFactory checksumAlgorithmFactory : checksumAlgorithmFactories) {
287                Path summaryFile = summaryFile(
288                        basedir,
289                        originAware,
290                        idToPathSegmentFunction.apply(artifactRepository),
291                        checksumAlgorithmFactory.getFileExtension());
292                String checksum = requireNonNull(trustedArtifactChecksums.get(checksumAlgorithmFactory.getName()));
293
294                String oldChecksum = cache.computeIfAbsent(summaryFile, k -> loadProvidedChecksums(summaryFile))
295                        .put(artifactPath, checksum);
296
297                if (oldChecksum == null) {
298                    changedChecksums.put(summaryFile, Boolean.TRUE); // new
299                } else if (!Objects.equals(oldChecksum, checksum)) {
300                    changedChecksums.put(summaryFile, Boolean.TRUE); // replaced
301                    LOGGER.info(
302                            "Trusted checksum for artifact {} replaced: old {}, new {}",
303                            artifact,
304                            oldChecksum,
305                            checksum);
306                }
307            }
308        }
309    }
310
311    /**
312     * On-close handler that saves recorded checksums, if any.
313     */
314    private void saveRecordedLines() {
315        if (changedChecksums.isEmpty()) {
316            return;
317        }
318
319        ArrayList<Exception> exceptions = new ArrayList<>();
320        for (Map.Entry<Path, ConcurrentHashMap<String, String>> entry : checksums.entrySet()) {
321            Path summaryFile = entry.getKey();
322            if (changedChecksums.get(summaryFile) != Boolean.TRUE) {
323                continue;
324            }
325            ConcurrentHashMap<String, String> recordedLines = entry.getValue();
326            if (!recordedLines.isEmpty()) {
327                try {
328                    ConcurrentHashMap<String, String> result = new ConcurrentHashMap<>();
329                    result.putAll(loadProvidedChecksums(summaryFile));
330                    result.putAll(recordedLines);
331
332                    LOGGER.info("Saving {} checksums to '{}'", result.size(), summaryFile);
333                    pathProcessor.writeWithBackup(
334                            summaryFile,
335                            result.entrySet().stream()
336                                    .sorted(Map.Entry.comparingByKey())
337                                    .map(e -> e.getValue() + "  " + e.getKey())
338                                    .collect(Collectors.joining(System.lineSeparator())));
339                } catch (IOException e) {
340                    exceptions.add(e);
341                }
342            }
343        }
344        MultiRuntimeException.mayThrow("session save checksums failure", exceptions);
345    }
346}