ULTEO OPEN VIRTUAL DESKTOP

V4.0.0.0~RC1

WEB APPLICATIONS GATEWAY - CONFIGURATION FILE SYNTAX

Ulteo Open Virtual Desktop v4.0.0.0~RC1

Contents

1 Introduction 2

2 Main section 32.1 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

3 Handlers 43.1 ServerHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3.2 ClientHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3.3 DispatchHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3.4 ChainHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

3.5 RedirectHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

© ULTEO SAS 2014 - 1

Ulteo Open Virtual Desktop v4.0.0.0~RC1

Section 1 Introduction

This documentation aims to describe how to configure the Web Applications Gateway

which is a new feature in Ulteo Open Virtual Desktop 4.0 This configuration file shouldbe in YAML format. More details of this format can be found in Wikipedia: http://en.wikipedia.org/wiki/YAML One YAML file should define one web application. Upload ofYAML config file should be done in Admin Console. There is also possible to customize

some of parameters.

© ULTEO SAS 2014 - 2

Ulteo Open Virtual Desktop v4.0.0.0~RC1

Section 2 Main section

Main section (first level) defines application name. This name is used in virtual host

name as prefix. For example: if WebAppGW is configured to work on domainwgw.example.comand main section key is app1 than when user will click application icon that he will seethis application on domain app1.wgw.example.com. When administrator adds new webapplication, he should be sure that application name (first key of YAML file) is unique

and configure subdomain (DNS entry).

This section has following subsections:

• Configuration

• Handlers

2.1 Configuration

Parameters described in this section are variables which are configurable in Admin

Console. They can be used in handlers and filters on any nesting level. Usage of this

variable is $(VARNAME).

There are five types of variable:

• string – text input field in Admin Console• boolean – checkbox input field in Admin Console• user_login – login of current logged in user• user_passwd – password of current logged in user• dbvalue – value from SQL database

Any other type used in YAML file will be displayed in Admin Console as read-only text

input field.

Optional parameter title is used in Admin Console as label for input field.Variable check_ssl_certificates has special usage – it defines how WebAppGW shouldhandle SSL errors. If check_ssl_certificates is set to true than if web application’s certifi-cate is incorrect (self-signed, expired etc.) that WebAppGW will show error page (error

page file location should be configured in slaveserver.conf, parameter invalid_cert_page).If check_ssl_certificates is set to false WebAppGW will ignore SSL errors.

© ULTEO SAS 2014 - 3

Ulteo Open Virtual Desktop v4.0.0.0~RC1

Section 3 Handlers

This section defines what handlers and in which order should be used to handle traffic

between user’s browser and web application.

Each handler should have unique name (key). Parameter type is obligatory and definestype of handlers. Optional parameter filters describes filters that should be proceed

during request handling.

3.1 ServerHandler

ServerHandler - manages basic configuration of target web application

Parameters:

• baseURI – (obligatory) – address of web application• next_handler – (obligatory) – name of next handler

Example:

Server:type: "ServerHandler"baseURI: "http ://$(TARGETIP)"next_handler: "Dispatch"

3.2 ClientHandler

ClientHandler opens connection to target web application, download requested date

and returns it to user’s browser.

Example:

Client:type: "ClientHandler"

3.3 DispatchHandler

DispatchHandler chains the query to others handlers, based on rules.

Parameters bindings (mandatory) defines list of conditions and next_handler (handlerto execute if no condition is fulfilled).

Condition parameter:

• cond – (mandatory) – valid python expression.• next_handler (mandatory) - name of handler executed if condition is fulfilled

Variables available in cond expression:

© ULTEO SAS 2014 - 4

Ulteo Open Virtual Desktop v4.0.0.0~RC1

• request_path – (string) – path of requested resource• request_headers – (list) – list of request headers

Example:

Dispatch:type: "DispatchHandler"bindings:

condition1:cond: "request_path.startswith(‘/manage’)"next_handler: "Unauthorized"

condition2:cond: "’login_form’ in request_path"next_handler: "LoginForm"

next_handler: "Client"

3.4 ChainHandler

ChainHandler basic connector between two handlers, used mainly to add filters be-

tween two handlers.

Example:

Example:Chain:

type: "ChainHandler"next_handler: "Client"

3.5 RedirectHandler

RedirectHandler redirects to given location. Parameter location (mandatory) can de-fine URL or path to which user should be redirected.

Example:

Example:Chain:

type: "ChainHandler"next_handler: "Client"

© ULTEO SAS 2014 - 5