The first part of this document gives release managers a basic introduction to release signing. See under Further reading for links to authoritative sources of deeper information.
The second part answers some frequently-asked questions from people who downlaod releases from Apache projects.
This document is informative and does not constitute policy.
All new RSA keys generated should be at least 4096 bits. Do not generate new DSA keys.
Recent research has revealed weaknesses in SHA-1, and thus in the DSA and 1024 bit RSA OpenPGP keys which must use this algorithm. Though no realistic attacks have been made public, experience with similar weaknesses in MD5 suggests that further advances may well lead to practical attacks within the next few years. This accords with current NIST guidance on DSA.
The impact of this weakness on Apache can be mitigated by action now. What needs to be done is a little involved, so we have provided complete instructions.
How to find the length of your key is described here.
Every artifact distributed by the Apache Software Foundation must be accompanied by one file containing an OpenPGP-compatible ASCII armored detached signature and another file containing a SHA or MD5) checksum.
Form the names of these files by adding to the name of the artifact the following suffixes:
Release managers must not store private keys used to sign Apache releases on ASF hardware.
See the release distribution policy for details.
A signature allows anyone to verify that a file is identical to the one your project's release manager created. Since your project's release has a signature:
Create a OpenPGP compatible ASCII armored detached signature for the released artifact. Upload the signature with the released artifact. See here for a basic overview.
To create one using GNU Privacy Guard for file
$ gpg --armor --output foo.tar.gz.asc --detach-sig foo.tar.gz
$ openssl md5 < file
Platform-specific applications are also common, such as
md5sum on linux:
$ md5sum file
$ gpg --print-md MD5 [fileName] > [fileName].md5
Run the command in the same directory as the file so the output only contains the file name with no directory prefixes.
Note that the security of MD5 is now questionable and is only useful as part of a defense in depth.
$ gpg --print-md SHA1 [fileName] > [fileName].sha1
Avoid further use of SHA-1.
SHA512 use the same
SHA algorithm family with longer hash
lengths (256 and 512 bits respectively). These longer variations are less vulnerable to the weaknesses found in the algorithm family than
SHA1. Apache recommends using SHA512.
To create a
SHA512 checksum use:
$ sha512sum [fileName] > [fileName].sha512
Run the command in the same directory as the file so the output only contains the file name with no directory prefixes.
There are other members of the
SHA family that are rarely used.
A message digest algorithm takes a document and produces a much smaller hash of that document. A good algorithm will produce different digests for very similar documents. A good algorithm makes it infeasible to create a message matching a given hash.
You can use a trusted digest for a document can be used to verify the contents of an untrusted file. You can deliver the digest, which has a small size over a secure but expensive channel while delivering the untrusted file over an insecure but inexpensive one. This is useful when distributing releases.
Responsible cryptography talks about infeasible cracks (rather than impossible ones) since this is more accurate. All current practical methods can be subjected to brute force attacks and so can be cracked. So a better question is whether attacks are feasible given the current state of the art.
Many applications are available (some commercial, some freeware, some software libre) to help you sign releases. Whichever one you choose, please subscribe to the appropriate security lists and keep the application fully patched.
Apache recommends that ASF release managers use GNU Privacy Guard.
Creating signatures requires the private key. Keep limited copies of the private key securely and confidentially. Though the file used to store the private key is typically protected by encryption, it is vulnerable to dictionary attacks on the passphrase. So keep this file secret.
Create signatures on the machine where you store the private key, on secure hardware with limited read permissions, protected by a good passphrase. Consider using removable media or an isolated installation.
A master private key used to sign Apache artifacts (or to secure communications with the ASF) is particularly valuable. If you want or need to be able to create signatures for other purposes (for example, signing email messages) in other, less secure, locations, create multiple sub keys for these purposes.
Do not store your private key on any ASF machine. Do not create signatures on ASF machines.
When you use GNU Privacy Guard you may see a warning similar to:
gpg: WARNING: using insecure memory! gpg: please see http://www.gnupg.org/faq.html for more information
If you are using GnuPG on Apache hardware, please read this. Do not carry out sensitive operations using a private key on ASF hardware.
If you encounter this issue elsewhere, it indicates that GnuPG cannot lock memory pages, so they may be swapped out to disc. It would then be feasible for an attacker who had gained access to the machine to read the private key from the swap file. For more details, read the FAQ.
If the code signing machine is owned, it is only a matter of time before the key is compromised.
At a minimum, the machine should well maintained: kept up to date with security patches and with appropriate anti-virus and firewall software. The ideal is an isolated, well-maintained installation that you only use for creating releases. You can achieve this with a little effort by creating an isolated installation on a separate hard disc (which is physically disconnected when not in use signing releases) or a live CD.
Though feasible collision attacks that can defeat MD5 are known, they are still computationally expensive. MD5 may still be useful as an additional layer in a defense in depth, but Apache does not recommend it as your single security option.
Research has revealed weaknesses in this algorithm. Though there are no practical attacks known at the time of writing, experience with similar weaknesses in MD5 suggest that code signers should move away from this algorithm.
SHA-3 is the designation for a new cryptographic hash algorithm to replace the SHA family. The full standard was issued in 2015, but it hasn't yet been officially introduced into the OpenPGP standard. For that reason GnuPG doesn't support it yet.
Feasible - though expensive - attacks on MD5 have been made public. Similar weaknesses have been found in the SHA family of hashes, though practical attacks are not yet publicly known. However, longer hash sizes offer considerable protection, so larger members of the SHA family still look likely to be secure enough for a number of years.
SHA512 is the strongest well-studied, widely-used cryptographic hash. It is therefore the best recommendation until SHA3 is available.
The exact mechanics are application-dependent. For GnuPG (recommended):
We recommend that you use your Apache email address as the primary
User-ID for the code signing key. For example,
The comment should include CODE SIGNING KEY. This makes clear the primary use for this key. This can be helpful if you later generate keys for other uses.
Include the comment NOT FOR CODE SIGNING for keys you generate for other purposes.
Public key servers exist to distribute public keys. They do not vouch for the actual identity of the owner of each key. You must establish this either directly or through a web of trust. Do not trust a key just because it has been downloaded from a key server.
The major public key servers synchronize their records regularly so you only need to upload a key to one and rely on that server to disseminate it to the other key servers. We recommend using:
There are two common ways to upload a key to a public key server:
$ gpg --send-key B13131DE2
You must export each changed key separately.
The public web of trust grows constantly as people sign new keys and upload the new signatures onto the network of public key servers. You should refresh public keys periodically to make sure that your local web of trust is as full as possible. Many OpenPGP clients make it easy to refresh keys by querying a public key server. For example, to refresh all keys using GNU Privacy Guard use:
$ gpg --refresh-keys
You can export a public key through OpenPGP by using
--export. Typically, the export should be ASCII armored.
To export all public keys to the command line use:
gpg --export --armor
In most cases, it is better to export all keys - this ensures that signatures made on other keys will be exported. However, it is possible to export just one key by specifying it on the command line.
You can export secret keys. However, this poses a security risk and there are better solutions for most common use cases. For
example, copying the
GNUPGHOME directory (typically
~/.gnupg) is a better way to transfer an OpenPGP keyring from one machine to another.
A key ID is similar to a fingerprint but is much smaller in length. There is no guarantee that key IDs are unique. Consequently, we strongly recommend that you check the key's fingerprint before signing with it. People us key IDs for locating keys and identifying keys already contained within the keyring.
A short guide to discovering the key ID for a key is available.
Each OpenPGP keyring has a single master key. This key is for signing only. It may also optionally have a number of sub keys for encryption and signing.
If you want to sign emails using a key related to one you use to sign code, we recommend that you use a signing sub key.
To keep a code signing key safe and secure we recommend that you don't keep the key on a drive on a regular development machine. This means that you should not use the master key directly to sign emails. However, there are occasions when digitally signed emails are desirable.
To do that, create a sub key for email signing and export it to your regular machine. You can then keep the master key safely offline. For more details, read Subkey cross certification.
https://svn.apache.org/repos/private/committers repository contains scripts that assist with batch signing several distributions at one time.
The way to transfer secret keys depends on the application you are using. Instructions for GnuPG are available.
When you switch from an uncompromised key to another, usually stronger, one, it is convenient to use a transition period. During a transition, both keys are trustworthy but you only use the newer one to sign documents and certify links in the web of trust.
When you replace one uncompromised key with a newer and usually larger one, a transition period during which both keys are trustworthy and participate in the web of trust allows - by trust transitivity - links to the old key to be used to trust signatures and links created by the new key. During a transition, both keys are trustworthy but you only use the newer oneto sign documents and certify links in the web of trust.
If your key has been compromised then you must not transition. Revoke the old key and replace it with a new one immediately. Do not use a transition period.
There are several Apache documents you have to update when you have a new key. Follow these instructions.
RSA is a well known public key cryptography algorithm which supports signing and encryption. See further reading for more details.
The easiest way to discover the length of a key with id
KEYID is to use
gpg --list-keys KEYID. This prints basic information about the key. The first line includes the size in the second column, just before the id.
$ gpg --list-keys B1313DE2 pub 1024D/B1313DE2 2003-01-15 uid Robert Burrell Donkin (CODE SIGNING KEY) <email@example.com> uid Robert Burrell Donkin <firstname.lastname@example.org> uid Robert Burrell Donkin <email@example.com> sub 4096R/40A882CB 2009-06-18 [expires: 2010-06-18]</p> $ gpg --list-keys A6EE6908 pub 8192R/A6EE6908 2009-08-07 uid Robert Burrell Donkin (CODE SIGNING KEY) <firstname.lastname@example.org> sub 8192R/B800EFC1 2009-08-07
shows that key
B1313DE2 has length 1024 and
A6EE6908 length 8192.
The KEYS file is a plain-text file containing the public key signatures of the release managers (and optionally other committers) for the project. A good example is the Apache Ant KEYS file.
It is traditional to include the following header to explain how to use the file. These commands generate a descriptive comment describing the key, followed by the key itself. Key handling software ignores the comments when importing a key file:
This file contains the PGP keys of various developers.</p> Users: pgp < KEYS or gpg --import KEYS Developers: pgp -kxa <your name> and append it to this file. or (pgpk -ll <your name> && pgpk -xa <your name>) >> this file. or (gpg --list-sigs <your name> && gpg --armor --export <your name>) >> this file.
Store the KEYS file with the release archives to which it applies at the top level of the ASF mirror area for the project. This makes it available for users to download, and for automatic archiving with its release. For example, the Ant KEYS file is in the directory
https://downloads.apache.org/ant. The corresponding SVN area is at
Since users may need the KEYS file to check signatures for archived releases, it is important to retain in the file all keys that have ever been used to sign releases. Add entries with eadch new key the project uses, but do not remove entries.
Applied cryptography is a subject that has considerable depth. Luckily, it's possible to get started signing releases without being an expert. Just remember that you will encounter some situations that require research and learning. We hope the FAQ will be a reasonable first port of call.
You need an application to manage keys and create signatures. We recommend GNU Privacy Guard, and the Apache documentation generally assumes that's what you're using. (We welcome contributions that document use of other tools.) Read the Apache PGP user guide and keep the manual handy.
GnuPG can handle MD5 and SHA checksums as well as PGP signatures. It is your all-in-one cross-platform tool for release signing and verification.
Note: It can be hard for newbies to be confident that they have executed operations correctly. Consider doing some practice before you try to sign an actual release.
When you use public key cryptography, you can freely distribute the public key, but you must keep the private key secret. It is vital to protect private key files.. Private keys are typically stored in files protected by symmetric encryption. Choose a strong passphrase to protect the file.
You create a digital signature from an original document using a private key. Possession of the corresponding public key allows verification that a given file is identical to the original document. An attached signature is attached to the document whereas a detached signature is contained in a separate file.
ASCII armoring is an encoding format that converts a binary file into a string of ASCII characters. This format is more human readable and more portable than other formats.
To practice using OpenPGP, use separate environments. each with a different practice keyring.
For example, using GNU Privacy Guard:
$ mkdir -m 700.gnupg
It is difficult to personally verify the identity of all useful public keys. However, having verified the identity of only a small number of public keys it is possible to deduce the identity of public keys trusted by the owners of these keys. This process can be repeated. This extended graph of trusted identities is termed a >web of trust.
You can use webs of trust to solve the problem of verifying the identity of public keys.
Note: to take full advantage of a web of trust, it is important to actively build your personal web of trust into the major public webs of trust. Conferences are an ideal opportunity for exchanging key information, but you must come prepared.
For more information read the GNU Privacy Handbook.
You join a web of trust when an existing member of that web signs your public key to verify your identity. See a short explanation.
You can link into the Apache web of trust by meeting other Apache committers face-to-face and exchanging public keys:
Subscribe to the
party list and when you visit a new city, see if committers want to meet up.
A public key is for verifying signatures and encrypting messages; a private key is for generating signatures and decrypting messages. You can freely distribute public keys safely , but you must keep private keys protected. More details here.
Anyone who possesses a copy of a private key used to sign releases can create doctored releases with valid signatures. If this person intends harm then the consequences could be serious indeed. It is therefore very important to keep the private key secret.
It is vital that the private key is kept safe and secure. Though the file is encrypted using a passphrase , given enough time any determined cracker will be able to break that encryption. Basic precautions should include ensuring that only the user can read the directories.
However, for code signing keys we recommend taking additional measures. Reduce the window of vulnerability by using an isolated installation or by storing the private key on removable media (which you should remove and store securely when not actually signing a release.).
An isolated installation is inaccessible when you are not using it to sign releases. For example, create an installation on a separate hard disc or use a live CD.
The number of operations required to break a key by brute force increases with key size. However, the cost of using the key also rises. You must take into account the planned use of the key. You will use keys for code signing rarely and in situations where performance is not the main concern, so you can use long keys.
Over time, the cost of attacking a key of a given length by brute force falls as computing power increases. So a key whose length seems adequate today may be seem too short in a few years time. This is a significant issue for long-lived keys such as those used to sign ASF releases, and another reason to use longer keys with releases.
Now that there is doubt about the medium term security of SHA-1, avoid the DSA keys and 1024 bit RSA keys which depend on this algorithm. We recommended that new keys be at least 4096 bit RSA (the longest widely supported key length).
In cryptography passphrase is often used for what might be known as a password in other contexts. For example, an OpenPGP private key is typically stored to disc in a file encrypted by a symmetric cypher keyed by a passphrase. This passphrase is one of the weakest elements in the system: should anyone else gain access to the file then a dictionary attack will be feasible on a weak passphrase. So choosing a strong passphrase is very important.
Passphrases, unlike passwords, are typically unlimited in length. We recommend using long passphrases. You can use sequences of (at least seven) unrelated words or more conventional mixtures of symbols and alphanumerics.
Even a good passphrase offers only limited protection. Given the encrypted file and enough time, a determined cracker will be able to break any passphrase. A good passphrase will buy important time in the event of a compromise, but is no substitute for keeping the private key safe and secure in the first place.
OpenPGP defines a special type of signed message called a revocation certificate. This message indicates that the signer believes that the key is no longer trustworthy. Typically, the revocation certificate will be signed by the key to be revoked (though the key may specify that other keys should be trusted for revocation). Use the type of revocation and the comment included to judge how much trust to place in a good signature by a revoked key.
You should generate a revocation certificate for each public key you use. Store the revocation certificates safely, securely and separately from their public keys.
Each revocation certificate has a type specifying a general (machine readable) reason for the revocation:
Create certificates to cover the first two cases. Note that if a key is lost or can no longer be accessed (due to media failure or some other reason), assume that the key has been potentially compromised. Print copies of the revocation certificates and store them safely to guard against media failure.
$ gpg --output revoke.asc --armor --gen-revoke bob
Securely store the certificate.
If you are preparing a revocation certificate for future use, you should test it before storing it. See safe practice.
$ gpg --import revoke.asc gpg: key 4A03679A: "Some User<email@example.com>" revocation certificate imported gpg: Total number processed: 1 gpg: new key revocations: 1
Store each revocation certificate securely and separately from the key it revokes. Burning the certificate onto a CDROM or printing it out as a hard copy are good solutions.
If a key has been compromised, distribute its revocation certificate to those using the key. This process is a mirror of the process by which you distributred the original key.
When you delete a key from a keyring, it is simply removed. You can add it again later.
When you revoke a key, it is marked in the key ring. Whenever a message signed by this key is verified in the future, the user will get a warning that the key has been revoked.
For example, when you verify a revoked key, GNU Privacy Guard issues the following comment:
$ gpg --verify message.asc.message gpg: Signature made Sat Apr 8 09:28:31 2006 BST using DSA key ID 4A03679A gpg: Good signature from "Some User <firstname.lastname@example.org>" gpg: checking the trustdb gpg: checking at depth 0 signed=0 ot(-/q/n/m/f/u)=0/0/0/0/0/1 gpg: WARNING: This key has been revoked by its owner! gpg: This could mean that the signature is forgery. gpg: reason for revocation: Key has been compromised gpg: revocation comment: gpg: WARNING: This key is not certified with a trusted signature! gpg: There is no indication that the signature belongs to the owner. Primary key fingerprint: 82D1 169B E6F1 9D14 DA76 A5DD 968E 66E4 4A03 679A
You can use public key cryptography to test whether a particular file is identical in content to an original by verifying a signature. The signature file is a digest of the original file signed by a private key which attests to the digest's authenticity.
For example, when using GNU Privacy Guard you verify the signature
foo-1.0.tar.gz.asc for release
foo-1.0.tar.gz using the following command:
$ gpg --verify foo-1.0.tar.gz.asc foo-1.0.tar.gz
A signature is valid, if
gpg verifies the
.asc as a good signature, and doesn't complain about expired
or revoked keys. Technically :
$ gpg --verify --status-fd 1 foo-1.0.tar.gz.asc foo-1.0.tar.gz
should classify the
.asc as a
Trust is required in the identity of the public key that made the signature and that the signature is for the original file and not some other file. When verifying a release from an untrusted source (for example, over P2P file sharing or from a mirror) it is important to download the signature from a trusted source. Signatures for all Apache releases are available directly for download from
MD5 and SHA checksums provide a simple way to verify the integrity of a download. You can simply create a checksum (in the same way as the release manager) after download, and compare the result to the checksum downloaded from the main Apache site. However, this process does not provide for authentication and non-repudiation as anybody can create the same checksum.
You can also check the integrity of a release by verifying the signature. You need more knowledge to correctly interpret the result, but it does provide authentication and non-repudiation. If you are connected to the Apache web of trust, this also offers superior security.
$ gpg --verify foo-1.0.tar.gz.asc foo-1.0.tar.gz gpg: Signature made Mon Sep 26 22:26:18 2005 BST using RSA key ID 00000000 gpg: Can't check signature: public key not found
Apache projects normally keep the developers' public keys in a file called
KEYS. You may be able to find that file on the project's website, or in their code repository. Use
$ gpg --import KEYS
to import the public keys.
The transitive nature of the web of trust places a responsibility on the owner to verify the identity of the owner of those keys marked as trusted.
For more information read the GNU Privacy Guard User Guide.
Trustfulness and validity are different concepts. You may elect to trust the identity of a key to various degrees (or not at all). For a particular key, a particular signature for a particular file may be valid (created by the private key from an identical file) or invalid (either corrupt or created from a different file).
Do not trust a file with an invalid signature. You can trust a file with a valid signature as much as you trust the identity of the key that was used to verify the signature.
For example, when you use GNU Privacy Guard, a message similar to the following indicates that the signature is invalid:
$ gpg --verify foo-1.0.tar.gz.asc foo-1.0.tar.gz gpg: Signature made Mon Sep 26 22:26:18 2005 BST using RSA key ID 00000000 gpg: BAD signature from "email@example.com"
A message similar to the following indicates that the signature is valid but for an untrusted key:
$ gpg --verify foo-1.0.tar.gz.asc foo-1.0.tar.gz gpg: Signature made Mon Sep 26 22:05:28 2005 BST using RSA key ID 00000000 gpg: Good signature from "firstname.lastname@example.org" gpg: aka "email@example.com" gpg: checking the trustdb gpg: checking at depth 0 signed=1 ot(-/q/n/m/f/u)=0/0/0/0/0/1 gpg: checking at depth 1 signed=0 ot(-/q/n/m/f/u)=1/0/0/0/0/0 gpg: WARNING: This key is not certified with a trusted signature! gpg: There is no indication that the signature belongs to the owner. Primary key fingerprint: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
You can use the fingerprint to decide how much trust to assign to the key.
Public keys are long and even when ASCII armored are not very easy for humans to understand or compare. A fingerprint is a short digest of the key formatted in a way that makes it easier for humans to read and compare.
On occasion, the user (who understands the risks) may trust a key but not consider it trustworthy enough to exported to the web of trust. OpenPGP lets you sign keys as local only. These trust relationships will not be exported to the public web of trust but are treated as trusted when you use the key ring locally.
For example, with GNU Privacy Guard use:
$ gpg --lsign-key someuser
There are many other excellent resources on signing releases, but these make a good start: