Jump to: navigation, search

Agent Authentication

This article describes how to configure token-based agent authentication between Co-browse server and Workspace Desktop Edition. When enabled, Co-browse checks for a valid token for all communication between server and desktop. For security, tokens are stored in the database using AES128 encryption.

Retrieving a Token

By default, token-based agent authentication is disabled.

To get started setting up authentication, first you need to retrieve a token. Using curl, your browser, or any other http client, enter this URL:

<host:port>/cobrowse/rest/authtoken

This generates a random 26-digit token. Enter this token in two places:

Important
Make sure you configure the token in both applications; otherwise, the session will fail and generate an error message in the Co-browse agent interface.

Configuring the Co-browse Cluster Application

  1. Open Configuration Options for the Co-browse Cluster application.
  2. Select Options
  3. Select slave
  4. Select password
  5. In the Option Value field, enter the 26-digit token.

Configuring the Workspace Desktop Edition Application

After you've entered the token in the Co-browse Cluster application, you now need to enter the token in Workspace Desktop Edition.

  1. Open Genesys Administrator and navigate to PROVISIONING > Environment > Applications.
  2. Select the Workspace Desktop Edition application.
  3. Go to Options > cobrowse section.
  4. Select password.
  5. In the Option Value field, enter the 26-digit token.

Token Validation

The following validation scenarios apply:

  • The server checks the validity of a token when the server starts.
  • The server checks the validity of a token when the password configuration option is updated in the Co-browse Cluster application or the Workspace Desktop Edition application in Genesys Administrator.
  • If a token is not set on Co-browse Cluster application and not present in the request, the Co-browse session proceeds without agent authentication.
  • If a token is present in a request but not set in the Co-browse Cluster application, the Co-browse session proceeds without agent authentication.

Invalid Tokens

Scenario: Token is Invalid

If a token is invalid, the following occurs:

  • An error message displays on the agent interface.
  • A warning appears on the Co-browse server log.

In this case, the Co-browse session does not start.

Scenario: Token is Not Configured in the Co-browse Cluster Application

If a token is configured in the Workspace Desktop Edition application but not configured in the Co-browse Cluster application, the following occurs:

  • A warning appears on the Co-browse server log.

In this case, the Co-browse session is established successfully but without agent authentication.

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on 2 March 2018, at 10:55.