Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sfuhrm/message-digest-assembly-handler
Calculates MD5SUMS/SHA1SUMS-alike files for the contents in a Maven archiver archive
https://github.com/sfuhrm/message-digest-assembly-handler
assembly checksum checksum-calculation checksums java maven maven-assembly-plugin md5 md5sums message-digest sha-1 sha-256 sha-3 sha256sum
Last synced: about 2 months ago
JSON representation
Calculates MD5SUMS/SHA1SUMS-alike files for the contents in a Maven archiver archive
- Host: GitHub
- URL: https://github.com/sfuhrm/message-digest-assembly-handler
- Owner: sfuhrm
- License: other
- Created: 2020-03-15T17:39:55.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T13:03:30.000Z (over 1 year ago)
- Last Synced: 2024-11-05T16:12:44.532Z (3 months ago)
- Topics: assembly, checksum, checksum-calculation, checksums, java, maven, maven-assembly-plugin, md5, md5sums, message-digest, sha-1, sha-256, sha-3, sha256sum
- Language: Java
- Homepage:
- Size: 80.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
Message Digest Assembly Handler
===================
[](https://travis-ci.org/sfuhrm/message-digest-assembly-handler)
[](https://maven-badges.herokuapp.com/maven-central/de.sfuhrm/message-digest-assembly-handler)
[](https://www.codacy.com/manual/sfuhrm/message-digest-assembly-handler?utm_source=github.com&utm_medium=referral&utm_content=sfuhrm/message-digest-assembly-handler&utm_campaign=Badge_Grade)
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/sfuhrm/message-digest-assembly-handler/releases)
This is a plugin for the [Maven Assembly Plugin](http://maven.apache.org/plugins/maven-assembly-plugin/) that calculates
Message Digests for the files in the archive.
A typical possible outcome is a `MD5SUMS` file or `SHA256SUMS` file.
Requirements
--------------
The message-digest-assembly-handler requires at least the following environment:
* JDK 8 and later
* Maven-Assembly-Plugin 3.2.0 and later as a plugin in your `pom.xml`
Setup
--------------
You need to add the handler to your `pom.xml` and your assembly descriptor file.
Examples are shown in the next subsections.
### In your POM
In your `pom.xml`, add the `message-digest-assembly-handler` as a dependency to your `maven-assembly-plugin` plugin as described below.
```xml
org.apache.maven.plugins
maven-assembly-plugin
3.2.0
de.sfuhrm
message-digest-assembly-handler
0.9.2
```
### In your assembly descriptor
In your XML assembly descriptor, add one `containerDescriptorHandler` element:
```xml
my-id
jar
message-digest
MD5
MD5SUMS
```
Instead of the `handlerName` `"message-digest"` you can also directly
refer to the shortcuts in the following table.
| Message Digest | `handlerName` Parameter | Default `checksumFile` | Note |
|-----------------|----------------------------|------------------------|----------------------------------------------|
| MD5 * | `message-digest` | `MD5SUMS` * | * default is MD5, overwriting is possible |
| MD5 | `message-digest-md5` | `MD5SUMS` | |
| SHA | `message-digest-sha-1` | `SHA1SUMS` | "SHA" in JDK refers to the SHA-1 algorithm |
| SHA-256 | `message-digest-sha-2-256` | `SHA256SUMS` | SHA-2 |
| SHA-512 | `message-digest-sha-2-512` | `SHA512SUMS` | SHA-2 |
Note that overwriting the messageDigest and checksumFile is possible for
every handlerName, but except the generic
`message-digest` it will probably confuse to have a different algorithm that
does not match the handler name.
Configuration
--------------
The handler declaration in the assembly descriptor
understands the following configuration parameters:
* `messageDigest`: The name of a MessageDigest algorithm from the JDK.
Defaults to `MD5`.
The following lists the MessageDigest algorithms supported by AdoptOpenJDK13:
`MD2, MD5, SHA, SHA-224, SHA-256, SHA-384, SHA-512, SHA-512/224, SHA-512/256, SHA3-224, SHA3-256, SHA3-384, SHA3-512`.
* `checksumFile`: The name of the checksum file generated. Defaults to
`MD5SUMS`. Typical names are
`MD5SUMS`, `SHA1SUMS`, and so on.
* `exclusionRegex`: A regular expression that defines what files shall not
be handled by this handler. This option is important if you want to create
multiple checksum files with multiple `containerDescriptorHandler` sections.
You can then exclude the handlers from each other, for example by
giving the regex `(MD5SUMS|SHA1SUMS)`.