SSH Private Keys

You can log on to a Linux server or VM running Linux OS using the Identity/Pubkey authentication method. The Identity/Pubkey authentication method helps protect against malicious applications like keyloggers, strengthens the security level and simplifies launch of automated tasks.

To use the Identity/Pubkey authentication method, you must generate a pair of keys — a public key and private key:

  • Public key is stored on Linux servers to which you plan to connect from the backup server. The key is kept in a special authorized_keys file containing a list of public keys.
  • Private key is stored on the client machine — backup server. The private key is protected with a passphrase. Even if the private key is intercepted, the eavesdropper will have to provide the passphrase to unlock the key and use it.

For authentication on a Linux server, the client must prove that it has the private key matching the public key stored on the Linux server. To do this, the client generates a cryptogram using the private key and passes this cryptogram to the Linux server. If the client uses the "correct" private key for the cryptogram, the Linux server can decrypt the cryptogram with a matching public key.

Veeam Backup & Replication has the following limitations for the Identity/Pubkey authentication method:

  • Veeam Backup & Replication does not support keys that are stored as binary data, for example, in a file of DER format.
  • Veeam Backup & Replication supports only keys whose passphrase is encrypted with algorithms supported by PuTTY:
  • AES (Rijndael): 128-bit, 192-bit and 256-bit CBC or CTR (SSH-2 only)
  • Blowfish: 128-bit CBC
  • Triple-DES: 168-bit CBC

Tip

Veeam Backup & Replication 12 supports PPK file versions 2 and 3.

  • Passphrases generated in PuTTY must only contain ASCII characters. Unicode characters can create decoding issues in Veeam Backup & Replication.

Veeam Backup & Replication supports the following key algorithms: RSA, DSA, ECDSA, EdDSA (ED25519). For these algorithms you can use the following key formats:

Key Formats

Key Algorithms

RSA

DSA

ECDSA

EdDSA (ED25519)

PEM

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

private

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

private-openssh

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

sshcom

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

PKCS8

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

RDC4716 (private-openssh-new)

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

SSH Private Keys) 

Important

If you use VMware VIX/vSphere Web Services, Veeam Backup & Replication does not support usage of public keys for guest processing on Linux guest servers.

To add a credentials record using the Identity/Pubkey authentication method, do the following:

  1. Generate a pair of keys using a key generation utility, for example, ssh-keygen.

Note that keys generated as ED448 as are not supported.

  1. Place the public key on a Linux server. To do this, add the public key to the authorized_keys file in the .ssh/ directory in the home directory on the Linux server.
  2. Place the private key in some folder on the backup server or in a network shared folder.
  3. In Veeam Backup & Replication, from the main menu select Credentials and Passwords > Datacenter Credentials.
  4. Click Add > SSH private key (Linux private key – before Veeam Backup & Replication 12.1 (build 12.1.0.2131)).
  5. In the Username field, specify a user name for the created credentials record.
  6. In the Password field, specify the password for the user account. The password is required in all cases except when you use root or a user with enabled NOPASSWD:ALL setting in /etc/sudoers.
  7. In the Private key field, enter a path to the private key or click Browse to select a private key.
  8. In the Passphrase field, specify a passphrase for the private key on the backup server. To view the entered passphrase, click and hold the eye icon on the right of the field.
  9. In the SSH port field, specify a number of the SSH port that you plan to use to connect to a Linux server. By default, port 22 is used.
  10. If you specify data for a non-root account that does not have root permissions on a Linux server, you can use the Non-root account section to grant sudo rights to this account.
  1. To provide a non-root user with root account privileges, select the Elevate specified account to root check box.
  2. To add the user account to sudoers file, select the Add account to the sudoers file automatically check box. In the Root password field, enter the password for the root account.

If you do not enable this option, you will have to manually add the user account to the sudoers file.

  1. When registering a Linux server, you have an option to failover to using the su command for distros where the sudo command is not available.

To enable the failover, select the Use "su" if "sudo" fails check box and in the Root password field, enter the password for the root account.

  1. In the Description field, enter a description for the created credentials record. As there can be a number of similar account names, for example, Root, it is recommended that you supply a meaningful unique description for the credentials record so that you can distinguish it in the list. The description is shown in brackets, following the user name.

Important

Cases when root password is required to elevate account rights to root using sudo are no longer supported.

SSH Private Keys) 

Page updated 6/26/2024

Page content applies to build 12.3.0.310