Protocol

ULTEO OPEN VIRTUAL DESKTOP
V4.0.2
PROTOCOL DESCRIPTION

Ulteo Open Virtual Desktop v4.0.2
Contents
1 List of Protocols 3
1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.2 Hyper Text Transfer Protocol (HTTP) . . . . . . . . . . . . . . . . . . . . . . 3
1.3 Remote Desktop Protocol (RDP) . . . . . . . . . . . . . . . . . . . . . . . . 3
1.4 Secure Socket Layer (SSL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2 Server Communication 5
2.1 Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 HTTP Return Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
3 OVD Client Session 6
3.1 Establing a Simple Session . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
3.2 Session Manager Client Web Services . . . . . . . . . . . . . . . . . . . . . 7
3.2.1 applications.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
3.2.2 auth.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.2.3 icon.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
3.2.4 logout.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2.5 mimetype-icon.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2.6 session_status.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2.7 userlist.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.2.8 start.php . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
4 API for Web Clients 11
© ULTEO SAS - HTTP://WWW.ULTEO.COM 2014 - 1

The purpose of this documentation is to describe the protocols used by Ulteo Open
Virtual Desktop.

Section 1 List of Protocols
1.1 Overview
Here is a global view of OVD roles, protocols and ports.
1.2 Hyper Text Transfer Protocol (HTTP)
The base communication protocol used in Ulteo OVD for session establishment and
management is HTTP over SSL. This protocol runs over TCP port 443.
Ulteo OVD use also HTTP for communication between servers: Session Manager to
Application Server and vice versa. For this usage, the TCP ports 1111 and 1112 (non
standart service ports) are used.
Several products of Ulteo OVD such as the Administration Console and Web Portal are
purely web-based and use HTTP because the client in this case would normally be a
web-browser.
HTTP on Wikipedia
1.3 Remote Desktop Protocol (RDP)
RDP is the remote display protocol used by Microsoft Corp.® for their Terminal Ser-
vices™ software.
RDP is used by Ulteo Open Virtual Desktop to display desktop and applications on the
client machine.
RDP uses TCP port 3389.
RDP on Wikipedia

1.4 Secure Socket Layer (SSL)
SSL is an cryptographic layer protocol that provide encryption between server and
client.
SSL is used by Ulteo OVD to tunnel RDP.
SSL on Wikipedia

Section 2 Server Communication
Servers communicate by using HTTP webservices (hosted by Apache). The Session
Manager listens on TCP port 1111 and Application Servers use port 1112.
The Session Manager identifies an Application Server using its Fully Qualified Domain
Name (FQDN).
Applications Servers only respond to the Session Manager whose address is stored in
their configuration file.
2.1 Security
A server is authenticated using the DNS resolution system.
When an Application Server sends a status, it sends an extra argument named fqdn.
The Session Manager performs 2 authentication tests and 1 authorization.
• FQDN resolution: resolves the FQDN to get an IP address and tests if it matches
the remote server IP ($SERVER[’REMOTE_ADDR’] in PHP). Authentication directly
depends on that result being correct
• reverse resolution: resolves the server IP address and tests if it matches the
FQDN argument. Authentication directly depends on that result being correct.
This test can be disabled in the administration console using the Disable FQDN
checkparameter
• authorization: tests the match of the FQDN with one of the Authorized FQDN
parameters defined in the administration console.
2.2 HTTP Return Codes
Webservices use the standard HTTP return codes to know if the request succeeded.
• 200 OK : request succeeded
• 400 Bad Request : request argument not valid
• 401 Unauthorized : From SM to ApS: ApS detects that the remote address does
not match its configured SM. From ApS to SM: ApS is not registered yet or failed
authentication.
• 500 Internal Server Error : The request failed because of an error in the system
or the system is broken.

Section 3 OVD Client Session
3.1 Establing a Simple Session
The following schema describe the steps of the establishement of an Ulteo OVD ses-
sion.
In this example, only one Application Server is used, the session does not use File
Servers (internal or external) and the client connects directly to the SM without using
an OVD Gateway.

3.2 Session Manager Client Web Services
Session Manager client webservices are used by client software to negotiate and man-
age their session.
The base URL to access these services is https://sm.test.demo/ovd.
Here is the list of availables webservices.
3.2.1 applications.php
• method: GET
• arguments: none (except authentication, see auth.php)
• returns: an application list and application details as XML content.
This webservice provides the available application list and application details for the
current authenticated user. The authentication can be done either by the dedicated
service (auth.php) or directly using this one.
XML format:
• user Root node
• login Attribute
• application nodes
• application Node
• id Attribute
• name Attribute
• description Attribute
• mime nodes
• mime Node
• type Attribute
Here is an example:
<?xml version ="1.0" encoding ="utf -8"?>
<user login=" mwilson">
<application id ="1850" name=" AbiWord" description ="Compose , edit ,
and view documents">
<mime type=" application/docbook+xml"/>
<mime type=" application/msword"/>
<mime type=" application/rtf"/>
</application >

<application id ="1857" name=" Mousepad" description =" Simple text ←
editor">
<mime type="text/plain"/>
</application >
</user >
3.2.2 auth.php
• method: POST
• arguments: XML input (optionnal)
• returns: HTTP default return codes.
This is the dedicated authentication service. The authentication method used de-
pends on the enabled authentication module as deﬁned in the Administration con-
sole.
The XML input is only used for password and token authentication mechanisms.
XML format: the root node and the XML tree doesn’t matter for this webservice.
The system only checks if a user node exists and then attempts to authenticate it.
• user node
• login Attribute
• password Attribute
• token Attribute
If the password module is enabled, it uses the login and password attributes.
If the token module is enabled, it only uses the token attribute.
3.2.3 icon.php
• method: GET
• arguments:
• id: an application identiﬁer
• returns: the application icon as 32x32:32 image/png
This service provide an application icon from an application id.
The authentication can be done either by the dedicated service (auth.php) or di-
rectly using this one. It is also possible to access any icon anonymously by enabling
the Public Webservices access option in the Administration Console.

3.2.4 logout.php
• method: ANY
• arguments: None
• returns: XML
This webservice can be called to turn logout the user and terminate the session.
3.2.5 mimetype-icon.php
• method: GET
• arguments:
• id: a mime-type name
• returns: the application icon as 32x32:32 image/png
This service provide an mime-type icon building it on the ﬂy from the most appro-
priate application supporting that mime-type.
3.2.6 session_status.php
• method: GET
• arguments: None
• returns: session status as XML content
XML format:
• session Root node
• id Attribute
• status Attribute
3.2.7 userlist.php
• method: GET

• arguments: none
• returns: a user list as XML content.
This webservice provides the available user list from the user base used by the
Session Manager.
XML format:
• users Root node
• user nodes
• user Node
• login Attribute
• displayname Attribute
The service only respond if the Display users list setting is enable in the Administra-
tion Console.
The service sets a limit of 100 items in the list by default (can be changed in the
Administration Console).
3.2.8 start.php
• method: POST
• arguments: XML content
• returns: session parameters as XML content
This service is the one used by a client to negotiate a session. In the input XML, the
client describes the parameter wanted for the session. According to the Adminis-
tration Console deﬁned policy, the Session Manager returns either a session (with
parameter and access) or an error message explaining why the session cannot be
created.
The error returned message can be:
• auth_failed
• in_maintenance
• internal_error
• invalid_user
• service_not_available
• unauthorized_session_mode
• user_with_active_session

Section 4 API for Web Clients
Ulteo OVD provides a Javascript API to easily start an application or a desktop from
another web based service.
Here is a simple example HTML page which start a seamless Ulteo OVD application:
<html >
<head >

<script type="text/javascript"
src="http ://web.test.demo/ovd/media/script/lib/jquery/jquery.js ←
"
charset ="utf -8"></script >
<script type="text/javascript"
src="http ://web.test.demo/ovd/media/script/webclient/external. ←
js"
charset ="utf -8"></script >
<script type="text/javascript">
function start(form_) {
var ovd = new UlteoOVD_session(
’http ://’+ form_.server.value+’/ovd ’,
ULTEO_OVD_SESSION_MODE_DESKTOP
);
ovd.setAuthPassword(form_.login.value , form_.password.value);
ovd.start();
}
</script >
</head >
<body >
<form action ="#" onsubmit ="start(this); return false;">
Server:
<input type="text" name=" server" value="web.test.demo" />
<br/>
Login:
<input type="text" name="login" value ="" />
<br/>
Password:
<input type=" password" name=" password" value ="" />
<br/>
Application id:
<input type="text" name="app" value ="2" />
<br/>
<input type=" submit" value=" Launch" />
</form >
</body >
</html >

Protocol

More Related Content

What's hot (19)

Viewers also liked (10)

Similar to Protocol (20)

Recently uploaded (20)

Protocol