Secure access with a PSM HTML5 gateway

This topic describes how to configure PSM to work through an HTML5 gateway.

Configure the PVWA

The following procedure describes how to configure the PVWA to work with the PSM HTML5 gateway server.

Interaction between local and remote machines

When working in HTML5 browser-based PSM sessions, you can copy files and text between the local workstation and the remote target.

Copy files

Copy text

Keyboard layouts

The HTML5 gateway supports multiple keyboard layouts, as described below.

Keyboard layouts in v11.5

The HTML5 gateway v11.5 supports the following keyboard layouts:

Keyboard layout

Description

en-us-qwerty (default)

English (US) keyboard

fr-fr-azerty

French keyboard (azerty)

de-de-qwertz

German keyboard (qwertz)

ca-psm-unicode

A CyberArk custom Unicode keyboard. Most characters pass as Unicode data and not as keystrokes. Functionality that depends on capturing keystrokes might be affected.

Implement a non-default keyboard layout in v11.5

  1. Deploy the HTML5 Gateway Docker image as described in Install the HTML5 Gateway for PSM (side-by-side).

  2. Add the following parameter to the docker run command:

    Parameter

    Description

    -e ServerKeyboardLayout

    The type of keyboard layout to implement. Specify any of keyboard layouts as displayed above.

    For example, to implement the unicode keyboard:

     
    sudo docker run --restart unless-stopped -ti -v <certificates directory>:/opt/import:ro -d --cap-drop=all --cap-add={CHOWN,DAC_OVERRIDE,FOWNER,SETGID,SETUID} -e AcceptCyberArkEULA=yes -e EnableJWTValidation=no -e PSMCAFile=psmca.pem -e ServerKeyboardLayout=ca-psm-unicode --net=cyberark --hostname <container name> --name <container name> docker.io/alerocyberark/psmhtml5
  3. In environments with only one keyboard layout (qwerty\ azerty\ qwertz) , set ServerKeyboardLayout to one of the following keyboard layouts:

    • en-us-qwerty (default)

    • fr-fr-azerty

    • de-de-qwertz

    For RDP sessions, align the keyboard layout on the target machine.

    For all other sessions, align the keyboard layout on the PSM machine.

  4. In environments with targets and PSM machines that use different keyboard layouts, set ServerKeyboardLayout to ca-psm-unicode.

    Certain key combinations are not supported in this mode. For example:

    • Ctrl+a (select all)

    • Ctrl+z (undo)

    • Ctrl+y (redo)

    For PSM-RDP sessions, to work with universal keystrokes audit, set WindowsKeystrokesSingleLanguage=No. For more details, see Configure universal keystrokes for Windows connections when an additional language is used in the PAS docs.

     

    By default, PSM-RDP is configured with WindowsEventsAudit. To work with KeystrokesAudit, you need to configure it instead of WindowsEvents.

Keyboard layouts in v11.7

The HTML5 gateway v11.7 supports the following keyboard layouts:

Keyboard layout

Description

en-us-qwerty (default)

English (US) keyboard

en-gb-qwerty

English (UK) keyboard

de-ch-qwertz

Swiss German keyboard (qwertz)

de-de-qwertz

German keyboard (qwertz)

fr-be-azerty

Belgian French keyboard (azerty)

fr-fr-azerty

French keyboard (azerty)

fr-ch-qwertz

Swiss French keyboard (qwertz)

hu-hu-qwertz

Hungarian keyboard (qwertz)

it-it-qwerty

Italian keyboard

ja-jp-qwerty

Japanese keyboard

pt-br-qwerty

Portuguese Brazilian keyboard

es-es-qwerty

Spanish keyboard

es-latam-qwerty

Latin American keyboard

sv-se-qwerty

Swedish keyboard

tr-tr-qwerty

Turkish-Q keyboard

ca-psm-unicode

A CyberArk custom Unicode keyboard. Most characters pass as Unicode data and not as keystrokes. Functionality that depends on capturing keystrokes might be affected.

failsafe

A full Unicode keyboard. All characters pass as Unicode data and not as keystrokes. Functionality that depends on capturing keystrokes might be affected.

Implement a non-default keyboard layout in v11.7

  1. Deploy the HTML5 Gateway Docker image as described in Install the HTML5 Gateway for PSM (side-by-side).

  2. Set ServerKeyboardLayout to a non-default value. For details, see Secure access with a PSM HTML5 gateway.

    The default value for ServerKeyboardLayout is en-us-qwerty.

    • In environments with one of the following keyboard layouts, set the ServerKeyboardLayout value with that layout:

    • fr-fr-azerty

    • fr-be-azerty

      fr-ch-qwertz

      de-ch-qwertz

      de-de-qwertz

      en-us-qwerty

      en-gb-qwerty

      hu-hu-qwertz

      it-it-qwerty

      ja-jp-qwerty

      pt-br-qwerty

      es-es-qwerty

      es-latam-qwerty

      sv-se-qwerty

      tr-tr-qwerty

       

      For RDP sessions, align the keyboard layout on the target machine. For all other sessions, align the keyboard layout on the PSM machine.

    • In an environment with keyboard layouts not included in the above list, or in an environment with targets and PSM machines that use different keyboard layouts, set ServerKeyboardLayout to failsafe. This option sends only unicode events and does not support key combinations that include letters, such as:

      • Ctrl+a (select all)

      • Ctrl+z (undo)

      • Ctrl+y (redo)

       

      This option should work for any keyboard, though not necessarily all RDP servers or applications.

    • If the targets and PSM machines in your environment use different keyboard layouts, but all layouts are en-us-qwerty, fr-fr-azerty, or de-de-qwertz, you can set ServerKeyboardLayout to ca-psm-unicode. This option is based on unicode, but supports some key combinations, such as Ctrl+c and Ctrl+v.

       

       

      For PSM-RDP sessions, to work with universal keystrokes audit, set WindowsKeystrokesSingleLanguage=No. For details, see Configure universal keystrokes for Windows connections when an additional language is used in the PAS docs.

      By default, PSM-RDP is configured with WindowsEventsAudit. To work with KeystrokesAudit, you must configure it instead of WindowsEventsAudit.

Logs

Logs are generated for the PSM HTML5 gateway web application and the guacd daemon service.