Configuring SSH Keys

Owned by israel drori (Unlicensed)
Last updated: 03 Oct 2023 by Alon Men
3 min read

SSH Keys are used in ZEN Master to enable ZEN Master to access the web UI of a connected Zixi resource (e.g. Broadcaster, Feeder, Receiver or other Zixi enabled device).

When you configure resources in ZEN Master you will assign an SSH key to each resource. You can use a single SSH key for several resources or use a separate key for each resource. Each SSH key is associated with one or more Tags which control which users have access to that key.

There are two methods for generating SSH keys:

  • Generate the key in ZEN Master and then download the private part of the key and load it into the external device. (simplest method)

OR

  • Generate the key on the external device and then Import the public part of the key into ZEN Master. (most secure method)

If you are importing a public key, it must be a "strong" key in order for it to be accepted in ZEN Master.

If an SSH Key was imported from an external device (not generated in ZEN Master) then you will need to use the manual method to connect the device to ZEN Master and not the automatic method (i.e. v12 method).

The SSH Security & Keys screen shows a list of the SSH keys available in your system as well as the tag/s associated with each key.

You can perform the following action for each SSH key.

  • Edit – Edit the name and/or Tag for that key.
  • Download – Download the private part of the key onto your local machine (for keys generated in ZEN Master).
  • Delete – Delete the key.

The Tunnels/IO Server tab shows the Hostname used for SSH tunnels and includes a link to download the Public Key used to sign the SSH server's unique ID. 

To generate a new SSH key:

  1. In the main navigation, click Configuration > SSH Security & Keys.
    The SSH Security & Keys screen is displayed.
  2. Click + Add.
    The Create New SSH Key screen appears.
     
  3. In the Name field, type a name for the new key using any alphanumeric characters.
  4. In the Tags field, select one or more of the predefined Tags from the drop-down list.
    Tags are used for access control. By selecting an Tag you are relating this SSH Key to that Tag. Tags are associated with certain roles (through the Users & Roles screen), and roles, in turn, are associated with users and user groups. If you would like to create a new Tag, see Creating a Tag.
  5. Under SSH Key, select Generate.
  6. Click Save.
    The new SSH key is added to the list of SSH keys.
    You can download the new SSH Key by clicking Download next to the relevant key. This file can be used to configure the SSH tunnel for connecting a Zixi component to ZEN Master.

To import an SSH key:

  1. First, generate an SSH key on the external device.
  2. Then, in ZEN Master main navigation, click Configuration > SSH Keys.
    The SSH Security & Keys screen is displayed.
  3. Click + Add.
    The Create New SSH Key screen appears.

  4. In the Name field, type a name for the new key using any alphanumeric characters.
  5. In the Tag field, select one or more of the predefined Tags from the drop-down list.
    Tags are used for access control. By selecting an Tag you are relating this SSH Key to that Tag. Tags are associated with certain roles (through the Users & Roles screen), and roles, in turn, are associated with users and user groups. If you would like to create a new Tag, see Creating a Tag    .
  6. In the SSH Public Key field, enter the public key that was generated on the external device.
  7. Click Save.
    The new SSH key is added to the list of SSH keys.