PrivX SSH Agent
===============

The PrivX SSH Agent communicates with the PrivX CA to request
certificates and SSH keys for the SSH client.


Setup
-----

Before using the PrivX Agent you first need to configure the
PrivX server URL:
  - Start PrivX Agent in
    'Start Menu' -> 'SSH Communications Security' -> 'PrivX Windows Agent'
  - Right click on the PrivX Agent tray icon and click 'Settings'
  - Enter PrivX server URL and click 'Test'
    Note: If PrivX server is using an untrusted TLS certificate you need to
    check that the certificate details are valid.
    - Click 'View' to open the Certificate Properties
    - Check the certificate detail. You do not need to install the certificate
      to the system.
  - Click 'Ok' save PrivX server URL and certificate

The PrivX server URL and certificate are stored to windows registry. You can
later modify the PrivX server URL by going back to 'Settings'.

Login
-----

Login to PrivX server by right clicking the PrivX Agent tray icon and clicking
'Login'. Login using your PrivX username and password and complete multi factor
authentication in case it is required.

Note: Multi factor authentication setup must be performed through the PrivX Web
UI. If PrivX Agent login fails with 'Failed: Login through web UI is required'
then please use a web browser to login to PrivX server and complete multi
factor authentication setup.

Connecting to Target Hosts
--------------------------

You can see your PrivX roles and accessible target hosts by right clicking
PrivX Agent tray icon and clicking 'Connections'.

If you wish to explicitly specify the PrivX role to be used for target host
login, select the appropriate role in 'Roles' dropdown and click 'Ok'. When a
role is selected the PrivX Agent will asks credentials from PrivX server only
for that role when connecting to target hosts. You can also explicitly specify
the target host by selecting the target in 'Targets' dropdown.

To connect to a target host select the appropriate SSH client in 'Clients' and
click 'Connect'. Alternatively you can use your SSH client for connecting to
the target.

Exit
----

Right click on PrivX Agent tray icon and click 'Exit'.



Copyright 2019 SSH Communications Security Corp.
