SSH.COM PrivX

SSH.COM PrivX Documentation Hub

Welcome to the SSH.COM PrivX documentation! Here you'll find the PrivX administration manual, use case specific guides as well as API specifications.

Documentation    API Reference

PrivX microservices architecture

PrivX has been built around modular microservices architecture. All the microservices communicate with each other using REST APIs and trigger content update notifications through Redis. PrivX can be deployed to run either on an on-premise host or on an cloud instance.

Components

See the following sections for more information on the PrivX microservices.

  1. Nginx
    Nginx is an open source HTTP server and reverse proxy. It routes traffic from the public facing 443 and 80 ports to individual PrivX microservices. It also routes internal microservice TLS traffic. It also serves static files. All traffic is HTTPS apart from Windows Certificate Revocation List requests which in accordance with Microsoft implementation must be over HTTP port 80. All external and internal communication is through REST APIs.
  2. Static files
    Nginx serves the static files from /www/data -directory on the PrivX host. The files consist of the HTML5 javascript UI and accompanying HTML, CSS and image files. The UI will function on top of PrivX through REST APIs.
  3. Monitor Service
    The Monitor Service collects health data and audit events from PrivX microservices and associated extenders.
  4. Workflow Engine
    The Workflow Engine allows users to request roles and for the approvers to grant or deny role requests. It will also push out email notifications to approvers.
  5. User Store
    The User Store is a PrivX-specific user directory. By default, the initial administrator account is created into the user directory. The User Store allows PrivX to act as a standalone solution and it also allows the creation of temporary users which necessarily need not be created in a user directory upstream from PrivX.
  6. Authentication
    The Authentication microservice authenticates clients and users to PrivX system via OAuth2. It will authenticate the requesting client either against the local user store or a specified remote user source such as an Active Directory, LDAP or Open ID Connect provider.
  7. Secrets Vault
    Sensitive material such as passwords and keys can be stored to PrivX via the Secrets Vault API or the PrivX user interface. The secrets are encrypted and stored to the database.
  8. Role Store
    The Role Store integrates to both user providers (sources) (B) and to host directories (targets) (C & D). It essentially fetches users from remote sources (B) and maps the users to PrivX roles according to pre-defined rules or explicit role grants. Other microservices will query Role Store for user's roles on on-demand basis. The role store will also fetch target hosts from cloud providers (C & D) and push them to host store (9). Role Store keeps discovered users and mapped roles in-memory for fast access and resolving.
  9. Host Store
    The Host Store stores all locally added hosts as well as hosts discovered from cloud providers (C & D). It also keeps track of service, account and role mappings and the proxy microservices will check the host configuration from the host store before allowing access to a target host.
  10. Connection Manager
    The Connection Manager keeps track of all ongoing proxied connections to target hosts. The administrator can also terminate connections, or if the connection was audited, playback the audit trail from the trail storage (20).
  11. SSH Proxy
    SSH Proxy establishes SSH connections to target hosts. It will verify user's roles and check that the roles match the configuration found for the host from the host store. The PrivX UI will establish a websocket connection to the SSH Proxy for the VT100 terminal emulation. If the connection is audited, the SSH Proxy will create a trail file to trail storage (14) and also play it back on Connection Manager's (11) request. The proxy can connect to the target host directly or via the PrivX extender (24).
  12. SSH Bastion
    SSH Bastion routes native client SSH connections to target hosts according to user's role configuration. The connections can be established either by using a bastion syntax or via interactive menu within the bastion. Connections can be audited. The bastion can connect to the target host directly or via the PrivX extender (24).
  13. RDP Proxy
    RDP proxy establishes RDP connections to target hosts. It will verify user's roles and check that the roles match the configuration found for the host from the host store. The PrivX UI will establish a websocket connection to the RDP Proxy desktop session. If the connection is audited, the RDP Proxy will create a trail file to trail storage (14) and also play it back on Connection Manager's (11) request. The proxy can connect to the target host directly or via the PrivX extender (24).
  14. RDP Bastion
    RDP Bastion routes native client RDP connections to target hosts according to user's role configuration. The connections can be established either by using a bastion syntax or via interactive menu within the bastion. Connections can be audited. The bastion can connect to the target host directly or via the PrivX extender (24).
  15. License Manager
    License Manager keep track of the internal license status of the PrivX installation and periodically polls for license updates from the SSH.COM license backend.
  16. Internal Keyvault
    Keyvault microservice stores PrivX internal sensitive data. The sensitive data includes stored credentials, private keys and so forth.
  17. Settings Service
    Settings service stores PrivX installation-specific settings and offers them up for other microservices.
  18. Authorizer
    Authorizer creates the ephemeral certificates needed to access SSH and RDP target hosts via certificate authentication. It will also provide public keys and/or stored credentials from the keyvault to proxies for authentication.
  19. Trail Index
    Trail Index microservice provides on-demand searching within the trail files stored in Audit Trail Storage (20)
  20. Audit Trail Storage
    The audit trail storage is a directory on the PrivX host. Ideally, this directory would be mounted to a secure NAS/SAN solution.
  21. Redis
    Redis is used as a notification mechanism between the microservices. No sensitive data is put in it, only timestamps.
  22. Postgres
    PrivX uses PostgreSQL as the storage mechanism for configuration data such as role mappings as well as manually added users or hosts and discovered cloud hosts.
  23. rsyslog
    The PrivX microservices write audit-, debug- and systemlogs to local syslog file. Rsyslog (or equivalent) should be configured to transfer the log files to an external SIEM solution (A).
  24. PrivX Extender
    PrivX Extender enables PrivX to reach firewalled private networks or virtual private clouds. Once deployed in the private network, it will establish a number of websocket connections to PrivX to route traffic from PrivX proxies to the target network.
  25. PrivX Carrier
    PrivX Carrier provides a virtualized runtime environment via Docker for the Firefox containers used for Web Access.
  26. PrivX Web Proxy
    PrivX Web Proxy intercepts the traffic from the Firefox containers to the target hosts and provides secrets on the fly.

Updated 5 months ago


PrivX microservices architecture


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.