support.versasec.com Open in urlscan Pro
104.16.53.111  Public Scan

URL: https://support.versasec.com/hc/en-us/articles/360017020420-vSEC-CMS-Client-Server-Communication
Submission: On July 04 via manual from CL — Scanned from DE

Form analysis 1 forms found in the DOM

GET /hc/en-us/search

<form role="search" class="form-field mb-0" data-search="" data-instant="true" autocomplete="off" action="/hc/en-us/search" accept-charset="UTF-8" method="get"><input name="utf8" type="hidden" value="✓" autocomplete="off"><input type="search"
    name="query" id="query" placeholder="Search" autocomplete="off" aria-label="Search"></form>

Text Content

We value your privacy

We use cookies on our website to give you the most relevant experience by
remembering your preferences and repeat visits. 

Customize Accept All
Customize Consent Preferences

We use cookies to help you navigate efficiently and perform certain functions.
You will find detailed information about all cookies under each consent category
below.

The cookies that are categorized as "Necessary" are stored on your browser as
they are essential for enabling the basic functionalities of the site. ... Show
more


NecessaryAlways Active

Necessary cookies are required to enable the basic features of this site, such
as providing secure log-in or adjusting your consent preferences. These cookies
do not store any personally identifiable data.

 * Cookie
   uncode_privacy[consent_types]
 * Duration
   1 year
 * Description
   This cookie is set by Uncode WordPress theme and is used to manage privacy
   settings on the website.

 * Cookie
   cookieyes-consent
 * Duration
   1 year
 * Description
   CookieYes sets this cookie to remember users' consent preferences so that
   their preferences are respected on subsequent visits to this site. It does
   not collect or store any personal information about the site visitors.

 * Cookie
   rc::a
 * Duration
   never
 * Description
   This cookie is set by the Google recaptcha service to identify bots to
   protect the website against malicious spam attacks.

 * Cookie
   rc::c
 * Duration
   session
 * Description
   This cookie is set by the Google recaptcha service to identify bots to
   protect the website against malicious spam attacks.

 * Cookie
   __cfruid
 * Duration
   session
 * Description
   Cloudflare sets this cookie to identify trusted web traffic.

 * Cookie
   AWSALBCORS
 * Duration
   7 days
 * Description
   Amazon Web Services set this cookie for load balancing.

 * Cookie
   _help_center_session
 * Duration
   session
 * Description
   Zdassests sets this cookie to hold preferences and session settings for
   customer support management, and it will be deleted when we leave the web
   browser.

 * Cookie
   ep201
 * Duration
   1 hour
 * Description
   This cookie is set by Wufoo for load balancing, site traffic and preventing
   site abuse.

 * Cookie
   PHPSESSID
 * Duration
   session
 * Description
   This cookie is native to PHP applications. The cookie stores and identifies a
   user's unique session ID to manage user sessions on the website. The cookie
   is a session cookie and will be deleted when all the browser windows are
   closed.

Functional


Functional cookies help perform certain functionalities like sharing the content
of the website on social media platforms, collecting feedback, and other
third-party features.

 * Cookie
   twk_idm_key
 * Duration
   session
 * Description
   Tawk set this cookie to allow the website to recognise the visitor in order
   to optimize the chat-box functionality.

 * Cookie
   TawkConnectionTime
 * Duration
   session
 * Description
   Tawk.to, a live chat functionality, sets this cookie. For improved service,
   this cookie helps remember users so that previous chats can be linked
   together.

 * Cookie
   NID
 * Duration
   6 months
 * Description
   Google sets the cookie for advertising purposes; to limit the number of times
   the user sees an ad, to unwanted mute ads, and to measure the effectiveness
   of ads.

 * Cookie
   yt-player-headers-readable
 * Duration
   never
 * Description
   The yt-player-headers-readable cookie is used by YouTube to store user
   preferences related to video playback and interface, enhancing the user's
   viewing experience.

 * Cookie
   ytidb::LAST_RESULT_ENTRY_KEY
 * Duration
   never
 * Description
   The cookie ytidb::LAST_RESULT_ENTRY_KEY is used by YouTube to store the last
   search result entry that was clicked by the user. This information is used to
   improve the user experience by providing more relevant search results in the
   future.

 * Cookie
   yt-remote-device-id
 * Duration
   never
 * Description
   YouTube sets this cookie to store the user's video preferences using embedded
   YouTube videos.

 * Cookie
   yt-remote-connected-devices
 * Duration
   never
 * Description
   YouTube sets this cookie to store the user's video preferences using embedded
   YouTube videos.

 * Cookie
   yt-remote-session-app
 * Duration
   session
 * Description
   The yt-remote-session-app cookie is used by YouTube to store user preferences
   and information about the interface of the embedded YouTube video player.

 * Cookie
   yt-remote-cast-installed
 * Duration
   session
 * Description
   The yt-remote-cast-installed cookie is used to store the user's video player
   preferences using embedded YouTube video.

 * Cookie
   yt-remote-session-name
 * Duration
   session
 * Description
   The yt-remote-session-name cookie is used by YouTube to store the user's
   video player preferences using embedded YouTube video.

 * Cookie
   yt-remote-cast-available
 * Duration
   session
 * Description
   The yt-remote-cast-available cookie is used to store the user's preferences
   regarding whether casting is available on their YouTube video player.

 * Cookie
   yt-remote-fast-check-period
 * Duration
   session
 * Description
   The yt-remote-fast-check-period cookie is used by YouTube to store the user's
   video player preferences for embedded YouTube videos.

 * Cookie
   __zlcmid
 * Duration
   1 year
 * Description
   Zopim sets this cookie to store a unique user ID.

 * Cookie
   __zlcstore
 * Duration
   never
 * Description
   Zopim sets this cookie to store information about the current status of the
   chat.

 * Cookie
   yt-player-bandwidth
 * Duration
   never
 * Description
   The yt-player-bandwidth cookie is used to store the user's video player
   preferences and settings, particularly related to bandwidth and streaming
   quality on YouTube.

 * Cookie
   ep203
 * Duration
   3 months
 * Description
   Surveymonkey sets this cookie to mitigate account sharing.

Analytics


Analytical cookies are used to understand how visitors interact with the
website. These cookies help provide information on metrics such as the number of
visitors, bounce rate, traffic source, etc.

 * Cookie
   _ga_*
 * Duration
   1 year 1 month 4 days
 * Description
   Google Analytics sets this cookie to store and count page views.

 * Cookie
   _ga
 * Duration
   1 year 1 month 4 days
 * Description
   Google Analytics sets this cookie to calculate visitor, session and campaign
   data and track site usage for the site's analytics report. The cookie stores
   information anonymously and assigns a randomly generated number to recognise
   unique visitors.

 * Cookie
   _gcl_au
 * Duration
   3 months
 * Description
   Google Tag Manager sets the cookie to experiment advertisement efficiency of
   websites using their services.

Performance

Performance cookies are used to understand and analyze the key performance
indexes of the website which helps in delivering a better user experience for
the visitors.

No cookies to display.

Advertisement


Advertisement cookies are used to provide visitors with customized
advertisements based on the pages you visited previously and to analyze the
effectiveness of the ad campaigns.

 * Cookie
   YSC
 * Duration
   session
 * Description
   Youtube sets this cookie to track the views of embedded videos on Youtube
   pages.

 * Cookie
   VISITOR_INFO1_LIVE
 * Duration
   6 months
 * Description
   YouTube sets this cookie to measure bandwidth, determining whether the user
   gets the new or old player interface.

 * Cookie
   VISITOR_PRIVACY_METADATA
 * Duration
   6 months
 * Description
   YouTube sets this cookie to store the user's cookie consent state for the
   current domain.

 * Cookie
   yt.innertube::requests
 * Duration
   never
 * Description
   YouTube sets this cookie to register a unique ID to store data on what videos
   from YouTube the user has seen.

 * Cookie
   yt.innertube::nextId
 * Duration
   never
 * Description
   YouTube sets this cookie to register a unique ID to store data on what videos
   from YouTube the user has seen.

 * Cookie
   test_cookie
 * Duration
   15 minutes
 * Description
   doubleclick.net sets this cookie to determine if the user's browser supports
   cookies.

 * Cookie
   IDE
 * Duration
   1 year 24 days
 * Description
   Google DoubleClick IDE cookies store information about how the user uses the
   website to present them with relevant ads according to the user profile.

Uncategorized


Other uncategorized cookies are those that are being analyzed and have not been
classified into a category as yet.

 * Cookie
   GFE_RTT
 * Duration
   5 minutes
 * Description
   No description available.

 * Cookie
   BALANCEID
 * Duration
   session
 * Description
   No description available.

 * Cookie
   _zendesk_cookie
 * Duration
   1 year
 * Description
   Description is currently not available.

 * Cookie
   cf_clearance
 * Duration
   1 year
 * Description
   Description is currently not available.

 * Cookie
   _zdsession_talk_embeddables_service
 * Duration
   session
 * Description
   No description available.

 * Cookie
   zte2095
 * Duration
   session
 * Description
   Description is currently not available.

 * Cookie
   CX_249073790
 * Duration
   1 year
 * Description
   Description is currently not available.

 * Cookie
   apex__sm
 * Duration
   session
 * Description
   No description available.

 * Cookie
   auth
 * Duration
   session
 * Description
   Description is currently not available.

 * Cookie
   sm_rec
 * Duration
   session
 * Description
   No description available.

 * Cookie
   sm_dc
 * Duration
   past
 * Description
   Description is currently not available.

 * Cookie
   _splunk_rum_sid
 * Duration
   15 minutes
 * Description
   Description is currently not available.

Accept All Save My Preferences
Powered by

Skip to main content
Toggle navigation menu
Versasec Web Downloads My Tickets Submit a request Sign in


HOW CAN WE HELP?


SEARCH




 1. Versasec
 2. vSEC:CMS Documentation
 3. Installation and Setup


VSEC:CMS CLIENT-SERVER COMMUNICATION

Anthony - Versasec Support
 * Updated 1 month ago


INTRODUCTION

vSEC:CMS client-server architecture uses HTTP(S) as the underlying communication
protocol. There are 2 protocol frameworks that can be used:

 * SOAP
 * gRPC

These protocols are supported when using vSEC:CMS User, vSEC:CMS Admin or Agent
and vSEC:CMS Remote Security Device Management (RSDM).

Important
Starting March 2024, we will discontinue support for SOAP client interface. For
optimal performance and compatibility, it is recommended to select force gRPC in
the protocol dropdown list.
Recommendation
It is recommended to configure all of the above mentioned Windows services to
Startup type of Automatic (Delayed Start). This ensures that the services will
come back up after a system reboot.
Note
Historically, the vSEC:CMS User application was referred to as vSEC:CMS User
Self-Service (USS). Similarly, the vSEC:CMS Admin and Agent applications were
referred to as vSEC:CMS Operator Console (OC).

This article will describe how these protocols can be used when configuring your
client-server architecture for vSEC:CMS.


USING GRPC

gRPC can be configured when using USS, OC and RSDM. You configure this when
setting up these connections if they are to be used in your environment. In this
article we will describe how this can be setup for the USS.

Note
The same configuration steps should be used if setting up OC and RSDM.


CONFIGURE SERVER-SIDE

From Options - Connections click the Add button and select User Self-Service and
click Ok. Enable the Enable gRPC checkbox. Depending on your environment
settings enter a hostname and port to listen on. You can also setup support for
SSL if you wish to use HTTPS for secure communication between the client and
server. The SSL certificate should be a machine web server certificate available
on the vSEC:CMS server.



Make sure that the vSEC:CMS - User Self-Service service is running after you
configure this in Windows services.

Important
If you use Microsoft CA you would need to use Microsoft Enhanced RSA and AES
Cryptographic Provider as in below example. You should ensure that only this
checkbox is selected in the template that will be used when issuing and renewing
the SSL/TLS certificate used for the secure connection.



Important
If you are also configuring OC and/or RSDM (from Options - Connections) you need
to use a different port for each service to what you configure for USS, i.e. a
unique port number needs to be used for each service you use for gRPC. This is
not the case if you are using SOAP where the same port can be used.
Important
When issuing a web server certificate for the vSEC:CMS server it is important
that the Common Name (CN) of the certificate is unique for that server,
otherwise you run the risk that the wrong certificate will be chosen. This is
because of a limitation in OpenSSL which is used when searching for certificates
in the local computer store. vSEC:CMS will use the subject of the certificate
(CN) to establish the SSL connection to. Therefore it is also important that the
subject of the certificate is resolvable from a DNS perspective from the client
side.
Additionally, if SSL/TLS is used, the subject CN is case sensitive. For example,
if the certificate subject CN for the SSL/TLS is Myserver.cms.com then you need
to enter Myserver.cms.com and not myserver.com.com when configuring the
connection URL below.
Note
It is possible to configure support for SOAP in parallel to using gRPC (simply
enable it above and follow instructions below for SOAP). This will give you more
flexibility in how your clients can be configured. For example, you can
configure your clients to use gRPC and if for whatever reason gRPC service was
not available the clients can fall back to use SOAP. If you plan to use such a
configuration refer to the Installing the vSEC:CMS MSI Client article for
details on how to enable this during client installations.


CONFIGURE CLIENT-SIDE

On a client machine it will be necessary to install the vSEC:CMS User (USS)
application. Use the vSEC:CMS Client MSI to install this component. It is
recommended to install the USS silently as it is possible to pass in the URL
link to the backend vSEC:CMS server that the USS needs to communicate with. This
will remove the requirement to manually configure the USS to communicate with
the backend in this case.

Open a command Window as administrator and change to the location where the MSI
installer is located. Run the command similar to below

Command
msiexec /i "vSEC_CMS Client 64bit.msi" /quiet ADDLOCAL=USS
USSGRPC="https://2016-server:8445" USSPCL=4

Where USSGRPC points to the backend gPRC service where vSEC:CMS is installed and
USSPCL=4 configures the USS client to use gRPC.

Important
For optimal security you should configure the connection from clients to use
SSL/TLS. In this case it is important that the full certificate chain (root and
intermediate certificates) are available and trusted on the client host.
Note
The client host will automatically reboot when running above command so make
sure you have saved any material you may be working on when performing this
task.
Note
If you are installing OC please refer to the article Install Operator
Console for details on installing this component.


USING SOAP

As already mentioned above support for SOAP has been discontinued from March,
2024. You can still use SOAP but any issues encountered when using SOAP will not
be supported. For historical reason we will keep this section here for
information purposes only.

SOAP can be configured when using USS, RSDM and OC. You configure this when
setting up these connections if they are to be used in your environment. In this
article we will describe how this can be setup for the USS.

Note
The same configuration steps should be used if setting up RSDM and/or OC.


CONFIGURE SERVER-SIDE

From Options - Connections click the Add button and select User Self-Service and
click Ok. Enable the Enable SOAP checkbox. Depending on your environment
settings enter a hostname and port to listen on. You can also setup support for
SSL if you wish to use HTTPS for secure communication between the client and
server. If you use SSL it is important that the HostIP address field is entered
with the name of the server as it appears in the SSL certificate. The SSL
certificate should be a machine web server certificate available on the vSEC:CMS
server.



Make sure that the vSEC:CMS - User Self-Service service is running after you
configure this in Windows services.

Note
It is possible to configure support for gRPC in parallel to using SOAP (simply
enable it above and follow instructions above for gRPC). This will give you more
flexibility in how your clients can be configured. For example, you can
configure your clients to use SOAP and if for whatever reason SOAP service is
not available the clients can fall back to use gRPC. If you plan to use such a
configuration refer to the Installing the vSEC:CMS MSI Client article for
details on how to enable this during client installations.


CONFIGURE CLIENT-SIDE

On a client machine it will be necessary to install the vSEC:CMS User
Self-Service (USS) application. Use the vSEC:CMS Client MSI to install this
component. It is recommended to install the USS silently as it is possible to
pass in the URL link to the backend vSEC:CMS server that the USS needs to
communicate with. This will remove the requirement to manually configure the USS
to communicate with the backend in this case.

Open a command Window as administrator and change to the location where the MSI
installer is located. Run the command similar to below

Command
msiexec /i "vSEC_CMS Client 64bit.msi" /quiet ADDLOCAL=USS
USSSOAP="https://2016-server:8443/uss" USSPCL=3

Where USSSOAP points to the backend SOAP service where vSEC:CMS is installed and
USSPCL=3 configures the USS client to use SOAP. Important to append /uss to the
end of the server hostname/IP. 

Note
The client host will automatically reboot when running above command so make
sure you have saved any material you may be working on when performing this
task.



ARTICLES IN THIS SECTION

 * Overview
 * Setup Evaluation Version
 * Migrate from Evaluation to Production
 * Install Admin Application
 * Install Agent Application
 * vSEC:CMS User Application
 * Automatic Startup for vSEC:CMS Services
 * Configure Server-side EA Signing MS CA
 * vSEC:CMS Client-Server Communication
 * Migrate Clients from SOAP to gRPC

See all 28 articles


IN THIS ARTICLE

 1. Introduction
 2. Using gRPC
 3. Using SOAP


Versasec Support Blog Privacy Policy

Return to top