Setting up keys for a local repository on a new ubuntu 20.10 virtual machine, I got a message that apt-key add was deprecated and I should read the apt-key(8) man page. The apt-key(8) man page is a collection of words strung together, but if it contains information I can't winkle it out. Can anyone tell me what, exactly, I should type on my terminal instead of:
apt-key add name-of-fileThe command does apparently still work after honking at me, so I was able to proceed, but would like to know what I'll need to do in the future.
17 Answers
You need to know why apt-key add is deprecated
All of the answers so far work around the symptom ("Don't use apt-key add") but fail to address the actual problem that led to apt-key add being deprecated. The problem is not a question of appending a key to one big keyring file etc/apt/trusted.gpg vs manually putting single-key keyring files into the directory /etc/apt/trusted.gpg.d/. These two things are equivalent, and doing either one is a huge security risk.
The problem is that any key you add to either of the above is completely and unconditionally trusted by apt. This means that when installing any package from any repo (including the official distro repos), apt will happily accept the package being signed by any of those trusted keys (whether the key belongs to the repository the package is coming from or not). This weakens the assurance provided by the package signing mechanism against malicous packages being injected into the official Ubuntu mirrors network.
What we want to do instead is configure apt to accept signatures from a third-party repository only on packages being installed from that repository — no cross-signing. Apt's default pinning rules give higher priority to official distro repos, which (in conjunction with proper key management) offers some protection against third-party repos replacing distro-provided packages. (At least, I think that's default. You can use apt-cache policy to inspect the current pin priorities, and if needed you can adjust pinning based on origin to achieve this effect. See man apt_preferences for details.)
The instructions given in Ugo Delle Donne's answer for converting the key to the (legacy) keyring v4 format that apt will accept are correct and helpful, but that's only half of the solution. I'll reiterate them here (cleaned up slightly) so all the steps are consolidated in one place:
- Download the key:
wget
(No need for-Oor>;wgetdefaults to saving the file in your current directory with the same filename it has on the server.)
- Verify that the filetype is "PGP public key block Public-Key (old)":
file <keyfile>.<ext>
gpgsupports a number of key formats, so if your key is in a different format, convert it by importing it into a temp keyring, then exporting it again:gpg --no-default-keyring --keyring ./temp-keyring.gpg --import <keyfile>.<ext>gpg --no-default-keyring --keyring ./temp-keyring.gpg --export --output <your-keyfile-name>.gpgrm temp-keyring.gpg
Now that you have your converted key, do not add it to apt's trusted keystore by copying it into /etc/apt/trusted.gpg.d/. Instead, put it somewhere like /usr/local/share/keyrings/. (You'll need to create that keyrings directory first.) There's nothing special about that location, it's just convention that /usr/local is for stuff that's specific to this machine, share because it's not a binary or a library or specific to any given user, and keyrings is just a descriptive name.
At this point, nothing has changed and apt doesn't know the key exists. The last step is to modify the specific .list file for the repository to tell apt where to find the key for that specific repo.
- Edit the file
/etc/apt/sources.list.d/<example>.list, and in betweendeband the url, add[signed-by=/usr/local/share/keyrings/<your-keyfile-name>.gpg]
Now apt will accept that key's signature for all packages in that repo and only that repo.
Notes:
- If you already have keyring files in
/etc/apt/trusted.gpg.d/, you cancopymove them to/usr/local/share/keyrings/as-is, and then update all the corresponding.listfiles so each one has asigned-byfield pointing to its own key. - If you already have keys in the
/etc/apt/trusted.gpgkeyring file beyond the official repo keys, this answer details the steps to locate and remove them. You can then follow all the same steps above to set them up the safer way. (Exporting them from that keyring is also possible, but the exact steps are left as an exercise for the reader.) - To import a repo's key from a keyserver to a standalone file:
gpg --no-default-keyring --keyring <output-file-name>.gpg --keyserver <some.keyserver.uri> --recv-keys <fingerprint>- This should give you a key that apt will accept without conversion.
- Apt is still very trusting, and a malicious or compromised repo can bypass this measure easily because packages currently can run arbitrary shell code as root in their setup scripts. Closing off one attack vector doesn't hurt, though, and progress is (slowly) being made on other fronts.
- Optionally, you can switch to the newer, more verbose
Deb822format using individual.sourcesfiles instead of.listfiles. It's more work, but personally I find the result far more readable.
Sources:
- Debian Wiki
- Excellent and detailed answer on Unix&Linux StackExchange
I stumbled on the same problem and luckily some other question lighted the way. In my example I was trying to add a teamviewer repository to a recent Kali linux and I was being blocked by the key verification.
I'm quite sure there's a more elegant way to do this but the following steps helped me fix the problem:
Download the relevant key
wget -O - > ~/teamviewer.keyVerify the type of file
file ~/teamviewer.keyit should be PGP public key block Public-Key (old)
Create a keyring
gpg --no-default-keyring --keyring ./teamviewer_keyring.gpg --import teamviewer.keyThis file is still not a valid key that can be added to /etc/apt/trusted.gpg.d/ since it's a keyring, but from the keyring we can extract the key with
gpg --no-default-keyring --keyring ./teamviewer_keyring.gpg --export > ./teamviewer.gpgThis file is the key you want to move to the trusted key folder
sudo mv ./teamviewer.gpg /etc/apt/trusted.gpg.d/
happy sudo apt update!!!
The reason for this deprecation is because using apt-key add simply appends the gpg key to the trusted global APT keyring. It's similar to the preferred method of adding local_repo.list to /etc/apt/sources.list.d/ instead of using add-apt-repository dep /link/to/repo version, which appends the message to the global sources.list file.
I think it's a bit more awkward to understand than using the .d folder, but essentially we want to get the gpg key into a standalone keyring file, then point to this keyring file in the source listing. The default keyring file location is /usr/share/keyrings, and it can be a .asc or .gpg file. I'm not sure the difference but I do know the global keyring files are binary files, not plaintext.
For example:
Using generic names can be a bit hard to understand sometimes, so here is an example of installing mongoDB:
Get the MongoDB gpg key and add it to a new keyring file
curl | sudo tee -a /usr/share/keyrings/buster-mongodb-org-4_2.ascAdd a source entry for apt, pointed to this new keyring
echo "deb [signed-by=/usr/share/keyrings/buster-mongodb-org-4_2.asc] buster/mongodb-org/4.2 mainInstall mongodb from this newly added repo
sudo apt install -y mongodb-org
Reference
This is still new to me, but most of what I know came from this excellent answer in the unix SE
1I created a shell script that can download and install keys to be used with [signed-by=] declaration in sources.list.
It's available on .
4POSIX Script for installing APT keys
General help
This script will help with installing PGP keys for APT repositories.
This script supports up to 2 arguments:
- 1st argument is input file. This can be either:
- An URL - key will be downloaded into current path (using wget or curl)
- A filename - reads an existing key in current path
- A path and a filename - reads an existing key in given path
- 2nd argument is key output path and output name. This can be either:
- Only filename - output path is set in config, saved as given filename
- A path and a filename - output path is given here, saved as given filename
- Only a path (end with /) - output path is given here, filename is taken from existing key
- Empty - output path is set in config, filename is taken from existing key
This script has a config file
/usr/local/etc/add-apt-key.conf, where the following variables can be set:
keypath: path to store converted key - default is/usr/share/keyringsverbosity: if set to Yes - displays extra outputremovetmp: if set to Yes - remove input (non-converted) fileExample 1: (
PWD=/root)sudo add-apt-key /usr/local/share/keyrings/Will download key in
/root, convert it and store as/usr/local/share/keyrings/mariadb_release_signing_key.gpgExample 2: (
PWD=/home/user)sudo add-apt-key /root/mariadb_release_signing_key.asc /usr/local/share/keyrings/mariadbkeyWill use existing key in
/root, convert it and store as/usr/local/share/keyrings/mariadbkey.gpgExample 3: (
PWD=/home/user)sudo add-apt-key mariadb_release_signing_key.asc mariadbkeyWill use existing key in
/home/user, convert it and store as/usr/share/keyrings/mariadbkey.gpgAfter installing the PGP key, it is also possible to add the key and repository to
/etc/apt/sources.list
- The choice to add this will be presented in the script as the first input option
- If Yes is chosen, the repository string must be pasted as the second input option
This completes the key installation by adding the corresponding repository line to
/etc/apt/sources.listInstallation
Install by running the following commands:
sudo curl -L -o /usr/local/bin/add-apt-key sudo curl -L -o /usr/local/etc/add-apt-key.conf sudo chmod a+rx /usr/local/bin/add-apt-key
Keys for use by apt are stored in /etc/apt/trusted.gpg.d/. apt-key managed these keyrings for you, but now that it's deprecated you need to choose a suitable file name <KEYRING> for the keyring yourself.
If you have the key already as a local file <FILE>, run
gpg --no-default-keyring --keyring=gnupg-ring:/etc/apt/trusted.gpg.d/<KEYRING>.gpg --import <FILE>To directly read the key from <URL>, run
curl -sSfL <URL> | gpg --no-default-keyring --keyring=gnupg-ring:/etc/apt/trusted.gpg.d/<KEYRING>.gpg --importNote: the prefix gnupg-ring: before the keyring name is required to create the keyring in the apt compatible (legacy) v4 format, rather than the (newer) keybox v1 format.
As a direct workalike, replace apt-key add with gpg --dearmor:
curl [KEYURL] | sudo gpg --dearmor --yes -o /etc/apt/trusted.gpg.d/[KEYFILE].gpg
However, this is not recommended (other than as a workalike to apt-key) since all keys in the trusted directory are unconditionally trusted; it is better to put the output in a (non-globally) trusted directory (as others have suggested), and have each source specify which key(s) to trust, individually.
5All of the answers here are great, What I'm sharing here is what I took from all of these answers, and automated to make setting up machines easier for me.
Although adding an apt source is a rare occasion per machine, it still is something I do on multiple machines, cloud machines, etc...
The following is a bash script I wrote for myself to add the stack of APT sources on an ubuntu/pop-os based machine I use for DevOps work:
NOTE: Don't just copy paste, if you don't understand what's going on - ask. These are the type of actions no person should take lightly.
My add-my-apt-repos.sh script (GH🔗):
#! /usr/bin/env bash
# Make sure the /usr/share/keyrings dir exists
sudo mkdir -p /usr/share/keyrings 2>&1 > /dev/null
# Make sure all of the basic required tools are installed for the code
# below to work
sudo apt-get install --yes --no-install-recommends \ curl gnupg software-properties-common apt-transport-https
# some utility variables, _YES is optionally '--yes'
[[ ! -z "$1" && "$1" == '--yes' ]] && _YES='--yes'
_OS=$(lsb_release -is | awk '{ print tolower($0) }')
[[ $_OS == 'pop' ]] && _OS='ubuntu'
_REL=$(lsb_release -rs) # Release
_CNM=$(lsb_release -cs) # CodeName
_ARC=$(dpkg --print-architecture) # Architecture
# The function that does the _Heavy Lifting_.
# see the code that follows for the parameter signature
function add_repo() { REPO_FQDN=$1 #'download.docker.com' GPG_KEY_URL=${2:-https:\/\/$REPO_FQDN\/gpg} GPG_KEY_PATH=/usr/share/keyrings/$REPO_FQDN.gpg REPO_ARCH=${3:-${_ARC}} [[ $REPO_ARCH == '-' ]] && REPO_ARCH='' || REPO_ARCH="arch=$REPO_ARCH" REPO_URL=${4:-https:\/\/$REPO_FQDN} REPO_SUITE=${5:-$_CNM} REPO_CMP=${6:-main} curl -fsSL $GPG_KEY_URL | sudo gpg --dearmor -o $GPG_KEY_PATH $_YES echo "Key created: $GPG_KEY_PATH" echo "deb [$(echo "$REPO_ARCH signed-by=$GPG_KEY_PATH" | xargs )] $REPO_URL $REPO_SUITE $REPO_CMP" | \ sudo tee /etc/apt/sources.list.d/$REPO_FQDN.list > /dev/null echo "APT source list added: /etc/apt/sources.list.d/$REPO_FQDN.list"
}
#Long line - 197 characters long
#add_repo REPO_FQDN/Name GPG_KEY_URL REPO_ARCH REPO_URL REPO_SUITE REPO_CMP # TBD: PIN_PRIORITY
#defaults: <required> ' $_ARC ' $_CNM 'main' # <optional>
# ---------------------------- ------------------------------------------------------- ---------- ------------------------------------------------ ----------- ---------
# for: docker-ce docker-ce-cli containerd.io docker-compose-plugin
# Also don't forget:
# remove: docker docker-engine docker.io containerd runc
# possibly remove docker-compose and install:
add_repo 'download.docker.com' "" '' "" '' 'stable'
# for: anydesk
add_repo 'deb.anydesk.com' ' '-' ' 'all' ''
# for: google-cloud-cli
add_repo 'packages.cloud.google.com' ' '-' ' 'cloud-sdk' ''
# for: code (optionally: powershell dotnet-*)
add_repo 'packages.microsoft.com' ' '' "" '' ''
# for: microsoft-edge-stable
add_repo 'packages.microsoft.com-edge' ' '' ' 'stable' ''
# for: terraform
add_repo 'apt.releases.hashicorp.com' ' '' ' '' ''
# I really LOVE xscreensavers, but it's been stuck in limbo on the
# `stable` repos, so I install it from the `unstable`, aka `sid`, suite.
# To do that safely, I make sure the repo is pinned to a lower priority.
# I do this BEFORE I add the repo.
# # Debian sid (unstable) as low-priority option
(echo 'Package: *'; echo 'Pin: release a=unstable'; echo 'Pin-Priority: 200') | sudo tee /etc/apt/preferences.d/unstable > /dev/null
# # pin xscreensaver to unstable
(echo 'Package: xscreenaver*'; echo 'Pin: release a=unstable'; echo 'Pin-Priority: 2000') | sudo tee /etc/apt/preferences.d/xscreensaver > /dev/null
# for: xscreensaver xscreensaver-data xscreensaver-data-extra
# xscreensaver-screensaver-bsod xscreensaver-screensaver-webcollage
# Add the unstable/sid repo - THIS IS DANGEROUS without the pinning via
# /etc/apt/preferences.d files created by the code above.
sudo apt-add-repository $_YES --no-update "deb [arch=amd64] sid main non-free contrib"
# Finally, run `apt update` to check that everything completed successfully
sudo apt update