Viewing SSH Private Keys

To view the SSH private keys registered on the Rhapsody server, navigate to View>Certificate and Key Manager to display the Certificate and Key Manager and select the SSH Private Keys tab:

If you are connecting to an engine that does not support SSH key management, then the Certificate and Key Manager does not display the SSH Public Keys and SSH Private Keys tabs.

The tab provides the following information:

Field Description
Alias

The unique user-defined name for the key.

Key aliases must be unique across all certificates and keys in Rhapsody.
Algorithm The encryption algorithm used (RSA or DSA).
Key Size The key bit length.
Fingerprint MD5 hash of the key.

You can perform the following actions from the tab via buttons or the right-click menu:

Action Description
Import... Add an SSH private key.
Export... Export an SSH private key.
Remove Delete an SSH private key.
Show Uses Open the Security Object Uses dialog to display the components an SSH private key is being used in. Double-click a component to view or edit its configuration properties.
Filter Perform text-based filtering to filter the list of displayed SSH private keys.

Importing an SSH Private Key

SSH private keys can be imported from either OpenSSH, ssh.com, or Putty formats, and the user is prompted for a passphrase to use to decrypt the key.

To import an SSH private key:

  1. Navigate to View>Certificate and Key Manager.

  2. On the SSH Private Keys tab, select the Import... button. The Import SSH Private Key dialog is displayed:

  3. Enter: 
    • A name in the Key Alias field to identify the key, if required.
    • The path of the key you want to import in the Filename field or click the Browse link to locate it.
    • The passphrase in the Passphrase field.
  4. Select the OK button to import the key.

  5. If the import is successful, then the new key is added to the list. If it fails, an error message is displayed indicating the reason why it failed. Failure reasons include:

    • Duplicate key alias.
    • Specified file does not exist.
    • Specified file could not be opened.
    • Specified file is too large (you cannot import files larger than 1MB).
    • Specified file is not the appropriate type of key (you cannot load an SSH private key from the public keys page or vice versa).
    • Specified file is not an SSH key.
    • Passphrase is incorrect for an SSH private key.

Exporting an SSH Private Key

SSH private keys can only be exported using the OpenSSH private key format. If another format is desired, then a tool such as PuttyGen can be used to convert between the formats.

The 'Export SSH private keys' access right is required to export SSH private keys. By default, this privilege is only given to the root Administrator user.

To export an SSH private key:

  1. Navigate to View>Certificate and Key Manager.

  2. On the SSH Private Keys tab, select a private key to export and then select the Export... button. The Export SSH Private Key dialog is displayed:

  3. Enter a path in the Filename field or click the Browse... link to select a path to save the key to that location.
  4. Enter a password in the Password and Confirm fields.
  5. Select the OK button to export the private key. The OK button becomes available only when the mandatory fields have been entered (all fields are mandatory).

Removing an SSH Private Key

To remove an SSH private key:

  1. Navigate to View>Certificate and Key Manager.

  2. On the SSH Private Keys tab, select the private key you want to remove.

  3. Select the Remove button. A confirmation dialog is displayed

  4. Select the Yes button on the confirmation dialog to remove the key (you can undo the deletion by selecting the Undo Remove button).

Supported Private Key Formats

Rhapsody supports SSH private keys in the OpenSSH, ssh.com, and Putty key formats, for example:

OpenSSH Private Key Format

-----BEGIN RSA PRIVATE KEY-----
MIIEoAIBAAKCAQEAkFTRr7nVMZrv9648hfG+ednEQNedt+Cbuam6r+Ug/1TvGSkB
fxf6RWL1ASGgAFna+fun99uJgrF2F82knCa4dTMOwzkcPdhXjGNvTKlby3MH46wq
viT+aICUguQ8LDGVu2iDzhHwbsMFzpVQh+NtIl/WPxybi6zMsYjDRnVTBB54gEls
V5XNkLJc7oXyqPrWfJv5SzTbiMByN1wtHHarekM4cAdyd3VQ7WLo4DGPcZvlP/Ew
n54Ol7vTKobZ8UyHT8W771NhtypfUn14Ma4r/W1lVPuX1b0qj/EhyTN8b88EsAkR
cnicu2dn/TW59bjOQP3lnu8Uliy1u/R/tF48ZQIBJQKCAQAjG4zzZI3Ny73Udn1s
sGyaLg0kh3lkFAo0FIdbN7vrFKjcm0WNngxxvh/rhLg3b817E7M8SiheD32XFlh5
An/lKBhZAA3J2q2DA24ZkPqnG/sAB0iqyrpsck2jTEX86XdyxmU/9oaXe4vKd1jH
G6Tsr4ckG7ch+ZmS98DL8wZa8kh2L13HvsuaGy5FI/rUKFLlFuDN1LCjUnpTCf1J
XifCfAqtH55KjTRkzwbvi8O54EsAi8iznv8AB4jq41dgf5UANjhUYDX1PQwg9Bbi
VKcg1F7l7n1ilrlfI36l5n9cz/3PJ1yu1/gilA6rwwdkia7Sa9lX4qFuE2GoSGXv
Op0tAoGBAOi6dUEsnfpC9h1KuQPV5gSgkCtNh9uRLstJIb466euSP5vf0g5hmUsV
t9ZkJhdeLKr4+LluBZ+pEwf9KCE431gkTboGS+O6mRANpkXakxjr0zRf55Q4kteS
DjwrtWpOc8kY1EbUD+O86gjCAl1jKY0ChmlN1ITMM+ijfLfMscbhAoGBAJ7DgzfZ
WTjwodbAceejxGCgAxVaJinJ6T5DgySz7Tjk6TfIeoP/0GdVrUtN6VNsnD7S8q/d
YB21pkL18PwrtgN/7m+qmGdFQQD2QQ0mablRv1V8sVV5ojx2wsCBrgaHWX18doZ6
Ri6pOSLq2K/1PMfdZsXnzDEFcDudhwhlgpoFAoGAPuZJNDWSev1XRi/e+h4ifcqH
1Fokt+IMpaUQCeZovDVdTLkIVunyFEsPF1lWZy41lf4ZtZNbd0Jz2KVJHbxYCfv5
VN8bbfsUnI4RQ0/UuqCZ8nrI96CWY8acEEMqHLtB41LRlpotztkcqGvJSawZEVqg
3jC1+mC0FVyeP4NuUW0CgYBrRdUzkttrqYIbexyHwa4zcwkAltuEBPeK71icQjiA
Y1F4t+QT/9/XHjbSBDXea/reVy5bJuAUEvPMYPzGD7JVZEco2w0HgdH5uyUI4pp2
S/3R+k5Ogp4NLaYvC4NsMfBbtPYjgwzTa2vLfBXerJ6wjq05nJ65VrOd5vpfnoit
QQKBgCrJYY8QhSX+TTaqF2S2wsoBbmK5RdC/ZMbyyzp1Fi0oTrDaJ7lQxIfQQ/s5
iGQUqnJ8lWrQ2QK/9mnw6d/N41IAlZ4ipoMWeTnAFtjfNXQdZYqBOfKgxpakg2N0
YC4vSDbZSATxq/bzD8Ym4eS62NfMmLm1HO9xLhEHaWil3xTa
-----END RSA PRIVATE KEY-----

SSH.COM Private Key Format

---- BEGIN SSH2 ENCRYPTED PRIVATE KEY ----
Comment: "rsa-key-20140829"
P2/56wAAA+wAAAA3aWYtbW9kbntzaWdue3JzYS1wa2NzMS1zaGExfSxlbmNyeXB0e3JzYS
1wa2NzMXYyLW9hZXB9fQAAAARub25lAAADnQAAA5kAAAAGJQAAB/4jG4zzZI3Ny73Udn1s
sGyaLg0kh3lkFAo0FIdbN7vrFKjcm0WNngxxvh/rhLg3b817E7M8SiheD32XFlh5An/lKB
hZAA3J2q2DA24ZkPqnG/sAB0iqyrpsck2jTEX86XdyxmU/9oaXe4vKd1jHG6Tsr4ckG7ch
+ZmS98DL8wZa8kh2L13HvsuaGy5FI/rUKFLlFuDN1LCjUnpTCf1JXifCfAqtH55KjTRkzw
bvi8O54EsAi8iznv8AB4jq41dgf5UANjhUYDX1PQwg9BbiVKcg1F7l7n1ilrlfI36l5n9c
z/3PJ1yu1/gilA6rwwdkia7Sa9lX4qFuE2GoSGXvOp0tAAAIAJBU0a+51TGa7/euPIXxvn
nZxEDXnbfgm7mpuq/lIP9U7xkpAX8X+kVi9QEhoABZ2vn7p/fbiYKxdhfNpJwmuHUzDsM5
HD3YV4xjb0ypW8tzB+OsKr4k/miAlILkPCwxlbtog84R8G7DBc6VUIfjbSJf1j8cm4uszL
GIw0Z1UwQeeIBJbFeVzZCyXO6F8qj61nyb+Us024jAcjdcLRx2q3pDOHAHcnd1UO1i6OAx
j3Gb5T/xMJ+eDpe70yqG2fFMh0/Fu+9TYbcqX1J9eDGuK/1tZVT7l9W9Ko/xIckzfG/PBL
AJEXJ4nLtnZ/01ufW4zkD95Z7vFJYstbv0f7RePGUAAAP+KslhjxCFJf5NNqoXZLbCygFu
YrlF0L9kxvLLOnUWLShOsNonuVDEh9BD+zmIZBSqcnyVatDZAr/2afDp383jUgCVniKmgx
Z5OcAW2N81dB1lioE58qDGlqSDY3RgLi9INtlIBPGr9vMPxibh5LrY18yYubUc73EuEQdp
aKXfFNoAAAQAnsODN9lZOPCh1sBx56PEYKADFVomKcnpPkODJLPtOOTpN8h6g//QZ1WtS0
3pU2ycPtLyr91gHbWmQvXw/Cu2A3/ub6qYZ0VBAPZBDSZpuVG/VXyxVXmiPHbCwIGuBodZ
fXx2hnpGLqk5IurYr/U8x91mxefMMQVwO52HCGWCmgUAAAQA6Lp1QSyd+kL2HUq5A9XmBK
CQK02H25Euy0khvjrp65I/m9/SDmGZSxW31mQmF14sqvj4uW4Fn6kTB/0oITjfWCRNugZL
47qZEA2mRdqTGOvTNF/nlDiS15IOPCu1ak5zyRjURtQP47zqCMICXWMpjQKGaU3UhMwz6K
N8t8yxxuE=
---- END SSH2 ENCRYPTED PRIVATE KEY ----

Putty Private Key Format

PuTTY-User-Key-File-2: ssh-rsa
Encryption: none
Comment: rsa-key-20140829
Public-Lines: 6
AAAAB3NzaC1yc2EAAAABJQAAAQEAkFTRr7nVMZrv9648hfG+ednEQNedt+Cbuam6
r+Ug/1TvGSkBfxf6RWL1ASGgAFna+fun99uJgrF2F82knCa4dTMOwzkcPdhXjGNv
TKlby3MH46wqviT+aICUguQ8LDGVu2iDzhHwbsMFzpVQh+NtIl/WPxybi6zMsYjD
RnVTBB54gElsV5XNkLJc7oXyqPrWfJv5SzTbiMByN1wtHHarekM4cAdyd3VQ7WLo
4DGPcZvlP/Ewn54Ol7vTKobZ8UyHT8W771NhtypfUn14Ma4r/W1lVPuX1b0qj/Eh
yTN8b88EsAkRcnicu2dn/TW59bjOQP3lnu8Uliy1u/R/tF48ZQ==
Private-Lines: 14
AAABACMbjPNkjc3LvdR2fWywbJouDSSHeWQUCjQUh1s3u+sUqNybRY2eDHG+H+uE
uDdvzXsTszxKKF4PfZcWWHkCf+UoGFkADcnarYMDbhmQ+qcb+wAHSKrKumxyTaNM
Rfzpd3LGZT/2hpd7i8p3WMcbpOyvhyQbtyH5mZL3wMvzBlrySHYvXce+y5obLkUj
+tQoUuUW4M3UsKNSelMJ/UleJ8J8Cq0fnkqNNGTPBu+Lw7ngSwCLyLOe/wAHiOrj
V2B/lQA2OFRgNfU9DCD0FuJUpyDUXuXufWKWuV8jfqXmf1zP/c8nXK7X+CKUDqvD
B2SJrtJr2VfioW4TYahIZe86nS0AAACBAOi6dUEsnfpC9h1KuQPV5gSgkCtNh9uR
LstJIb466euSP5vf0g5hmUsVt9ZkJhdeLKr4+LluBZ+pEwf9KCE431gkTboGS+O6
mRANpkXakxjr0zRf55Q4kteSDjwrtWpOc8kY1EbUD+O86gjCAl1jKY0ChmlN1ITM
M+ijfLfMscbhAAAAgQCew4M32Vk48KHWwHHno8RgoAMVWiYpyek+Q4Mks+045Ok3
yHqD/9BnVa1LTelTbJw+0vKv3WAdtaZC9fD8K7YDf+5vqphnRUEA9kENJmm5Ub9V
fLFVeaI8dsLAga4Gh1l9fHaGekYuqTki6tiv9TzH3WbF58wxBXA7nYcIZYKaBQAA
AIAqyWGPEIUl/k02qhdktsLKAW5iuUXQv2TG8ss6dRYtKE6w2ie5UMSH0EP7OYhk
FKpyfJVq0NkCv/Zp8OnfzeNSAJWeIqaDFnk5wBbY3zV0HWWKgTnyoMaWpINjdGAu
L0g22UgE8av28w/GJuHkutjXzJi5tRzvcS4RB2lopd8U2g==
Private-MAC: f121aaf857fcb3bc7c13624a167440e1d6ead8a0