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;
039
040import org.eclipse.aether.MultiRuntimeException;
041import org.eclipse.aether.RepositorySystemSession;
042import org.eclipse.aether.artifact.Artifact;
043import org.eclipse.aether.impl.RepositorySystemLifecycle;
044import org.eclipse.aether.internal.impl.LocalPathComposer;
045import org.eclipse.aether.repository.ArtifactRepository;
046import org.eclipse.aether.spi.connector.checksum.ChecksumAlgorithmFactory;
047import org.eclipse.aether.util.ConfigUtils;
048import org.eclipse.aether.util.FileUtils;
049import org.eclipse.aether.util.repository.RepositoryIdHelper;
050import org.slf4j.Logger;
051import org.slf4j.LoggerFactory;
052
053import static java.util.Objects.requireNonNull;
054import static java.util.stream.Collectors.toList;
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 ConcurrentHashMap<Path, ConcurrentHashMap<String, String>> checksums;
136
137    private final ConcurrentHashMap<Path, Boolean> changedChecksums;
138
139    private final AtomicBoolean onShutdownHandlerRegistered;
140
141    @Inject
142    public SummaryFileTrustedChecksumsSource(
143            LocalPathComposer localPathComposer, RepositorySystemLifecycle repositorySystemLifecycle) {
144        this.localPathComposer = requireNonNull(localPathComposer);
145        this.repositorySystemLifecycle = requireNonNull(repositorySystemLifecycle);
146        this.checksums = new ConcurrentHashMap<>();
147        this.changedChecksums = new ConcurrentHashMap<>();
148        this.onShutdownHandlerRegistered = new AtomicBoolean(false);
149    }
150
151    @Override
152    protected boolean isEnabled(RepositorySystemSession session) {
153        return ConfigUtils.getBoolean(session, false, CONFIG_PROP_ENABLED);
154    }
155
156    private boolean isOriginAware(RepositorySystemSession session) {
157        return ConfigUtils.getBoolean(session, true, CONFIG_PROP_ORIGIN_AWARE);
158    }
159
160    @Override
161    protected Map<String, String> doGetTrustedArtifactChecksums(
162            RepositorySystemSession session,
163            Artifact artifact,
164            ArtifactRepository artifactRepository,
165            List<ChecksumAlgorithmFactory> checksumAlgorithmFactories) {
166        final HashMap<String, String> result = new HashMap<>();
167        final Path basedir = getBasedir(session, LOCAL_REPO_PREFIX_DIR, CONFIG_PROP_BASEDIR, false);
168        if (Files.isDirectory(basedir)) {
169            final String artifactPath = localPathComposer.getPathForArtifact(artifact, false);
170            final boolean originAware = isOriginAware(session);
171            for (ChecksumAlgorithmFactory checksumAlgorithmFactory : checksumAlgorithmFactories) {
172                Path summaryFile = summaryFile(
173                        basedir,
174                        originAware,
175                        RepositoryIdHelper.cachedIdToPathSegment(session).apply(artifactRepository),
176                        checksumAlgorithmFactory.getFileExtension());
177                ConcurrentHashMap<String, String> algorithmChecksums =
178                        checksums.computeIfAbsent(summaryFile, f -> loadProvidedChecksums(summaryFile));
179                String checksum = algorithmChecksums.get(artifactPath);
180                if (checksum != null) {
181                    result.put(checksumAlgorithmFactory.getName(), checksum);
182                }
183            }
184        }
185        return result;
186    }
187
188    @Override
189    protected Writer doGetTrustedArtifactChecksumsWriter(RepositorySystemSession session) {
190        if (onShutdownHandlerRegistered.compareAndSet(false, true)) {
191            repositorySystemLifecycle.addOnSystemEndedHandler(this::saveRecordedLines);
192        }
193        return new SummaryFileWriter(
194                checksums,
195                getBasedir(session, LOCAL_REPO_PREFIX_DIR, CONFIG_PROP_BASEDIR, true),
196                isOriginAware(session),
197                RepositoryIdHelper.cachedIdToPathSegment(session));
198    }
199
200    /**
201     * Returns the summary file path. The file itself and its parent directories may not exist, this method merely
202     * calculate the path.
203     */
204    private Path summaryFile(Path basedir, boolean originAware, String safeRepositoryId, String checksumExtension) {
205        String fileName = CHECKSUMS_FILE_PREFIX;
206        if (originAware) {
207            fileName += "-" + safeRepositoryId;
208        }
209        return basedir.resolve(fileName + "." + checksumExtension);
210    }
211
212    private ConcurrentHashMap<String, String> loadProvidedChecksums(Path summaryFile) {
213        ConcurrentHashMap<String, String> result = new ConcurrentHashMap<>();
214        if (Files.isRegularFile(summaryFile)) {
215            try (BufferedReader reader = Files.newBufferedReader(summaryFile, StandardCharsets.UTF_8)) {
216                String line;
217                while ((line = reader.readLine()) != null) {
218                    if (!line.startsWith("#") && !line.isEmpty()) {
219                        String[] parts = line.split("  ", 2);
220                        if (parts.length == 2) {
221                            String newChecksum = parts[0];
222                            String artifactPath = parts[1];
223                            String oldChecksum = result.put(artifactPath, newChecksum);
224                            if (oldChecksum != null) {
225                                if (Objects.equals(oldChecksum, newChecksum)) {
226                                    LOGGER.warn(
227                                            "Checksums file '{}' contains duplicate checksums for artifact {}: {}",
228                                            summaryFile,
229                                            artifactPath,
230                                            oldChecksum);
231                                } else {
232                                    LOGGER.warn(
233                                            "Checksums file '{}' contains different checksums for artifact {}: "
234                                                    + "old '{}' replaced by new '{}'",
235                                            summaryFile,
236                                            artifactPath,
237                                            oldChecksum,
238                                            newChecksum);
239                                }
240                            }
241                        } else {
242                            LOGGER.warn("Checksums file '{}' ignored malformed line '{}'", summaryFile, line);
243                        }
244                    }
245                }
246            } catch (IOException e) {
247                throw new UncheckedIOException(e);
248            }
249            LOGGER.info("Loaded {} trusted checksums from {}", result.size(), summaryFile);
250        }
251        return result;
252    }
253
254    private class SummaryFileWriter implements Writer {
255        private final ConcurrentHashMap<Path, ConcurrentHashMap<String, String>> cache;
256
257        private final Path basedir;
258
259        private final boolean originAware;
260
261        private final Function<ArtifactRepository, String> idToPathSegmentFunction;
262
263        private SummaryFileWriter(
264                ConcurrentHashMap<Path, ConcurrentHashMap<String, String>> cache,
265                Path basedir,
266                boolean originAware,
267                Function<ArtifactRepository, String> idToPathSegmentFunction) {
268            this.cache = cache;
269            this.basedir = basedir;
270            this.originAware = originAware;
271            this.idToPathSegmentFunction = idToPathSegmentFunction;
272        }
273
274        @Override
275        public void addTrustedArtifactChecksums(
276                Artifact artifact,
277                ArtifactRepository artifactRepository,
278                List<ChecksumAlgorithmFactory> checksumAlgorithmFactories,
279                Map<String, String> trustedArtifactChecksums) {
280            String artifactPath = localPathComposer.getPathForArtifact(artifact, false);
281            for (ChecksumAlgorithmFactory checksumAlgorithmFactory : checksumAlgorithmFactories) {
282                Path summaryFile = summaryFile(
283                        basedir,
284                        originAware,
285                        idToPathSegmentFunction.apply(artifactRepository),
286                        checksumAlgorithmFactory.getFileExtension());
287                String checksum = requireNonNull(trustedArtifactChecksums.get(checksumAlgorithmFactory.getName()));
288
289                String oldChecksum = cache.computeIfAbsent(summaryFile, k -> loadProvidedChecksums(summaryFile))
290                        .put(artifactPath, checksum);
291
292                if (oldChecksum == null) {
293                    changedChecksums.put(summaryFile, Boolean.TRUE); // new
294                } else if (!Objects.equals(oldChecksum, checksum)) {
295                    changedChecksums.put(summaryFile, Boolean.TRUE); // replaced
296                    LOGGER.info(
297                            "Trusted checksum for artifact {} replaced: old {}, new {}",
298                            artifact,
299                            oldChecksum,
300                            checksum);
301                }
302            }
303        }
304    }
305
306    /**
307     * On-close handler that saves recorded checksums, if any.
308     */
309    private void saveRecordedLines() {
310        if (changedChecksums.isEmpty()) {
311            return;
312        }
313
314        ArrayList<Exception> exceptions = new ArrayList<>();
315        for (Map.Entry<Path, ConcurrentHashMap<String, String>> entry : checksums.entrySet()) {
316            Path summaryFile = entry.getKey();
317            if (changedChecksums.get(summaryFile) != Boolean.TRUE) {
318                continue;
319            }
320            ConcurrentHashMap<String, String> recordedLines = entry.getValue();
321            if (!recordedLines.isEmpty()) {
322                try {
323                    ConcurrentHashMap<String, String> result = new ConcurrentHashMap<>();
324                    result.putAll(loadProvidedChecksums(summaryFile));
325                    result.putAll(recordedLines);
326
327                    LOGGER.info("Saving {} checksums to '{}'", result.size(), summaryFile);
328                    FileUtils.writeFileWithBackup(
329                            summaryFile,
330                            p -> Files.write(
331                                    p,
332                                    result.entrySet().stream()
333                                            .sorted(Map.Entry.comparingByKey())
334                                            .map(e -> e.getValue() + "  " + e.getKey())
335                                            .collect(toList())));
336                } catch (IOException e) {
337                    exceptions.add(e);
338                }
339            }
340        }
341        MultiRuntimeException.mayThrow("session save checksums failure", exceptions);
342    }
343}