ULTEO OPEN VIRTUAL DESKTOP V . . .

~RC
WEB APPLICATIONS GATEWAY - CONFIGURATION FILE SYNTAX

Ulteo Open Virtual Desktop v . . . ~RC

Contents
Introduction Main section . Conguration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Handlers . . . . . ServerHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ClientHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DispatchHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ChainHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RedirectHandler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

ULTEO SAS

Ulteo Open Virtual Desktop v . . . ~RC

Section 1

Introduction

This documentation aims to describe how to congure the Web Applications Gateway which is a new feature in Ulteo Open Virtual Desktop . This conguration le should be in YAML format. More details of this format can be found in Wikipedia: http://en. wikipedia.org/wiki/YAML One YAML le should dene one web application. Upload of YAML cong le should be done in Admin Console. There is also possible to customize some of parameters.

ULTEO SAS

Ulteo Open Virtual Desktop v . . . ~RC

Section 2

Main section

Main section (rst level) denes application name. This name is used in virtual host name as prex. For example: if WebAppGW is congured to work on domain wgw.example.com and main section key is app than when user will click application icon that he will see this application on domain app .wgw.example.com. When administrator adds new web application, he should be sure that application name (rst key of YAML le) is unique and congure subdomain (DNS entry). This section has following subsections: Conguration Handlers

2.1

Configuration

Parameters described in this section are variables which are congurable in Admin Console. They can be used in handlers and lters on any nesting level. Usage of this variable is $(VARNAME). There are ve types of variable: string text input eld in Admin Console boolean checkbox input eld 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 le will be displayed in Admin Console as read-only text input eld. Optional parameter title is used in Admin Console as label for input eld. Variable check_ssl_certicates has special usage it denes how WebAppGW should handle SSL errors. If check_ssl_certicates is set to true than if web applications certicate is incorrect (self-signed, expired etc.) that WebAppGW will show error page (error page le location should be congured in slaveserver.conf, parameter invalid_cert_page). If check_ssl_certicates is set to false WebAppGW will ignore SSL errors.

ULTEO SAS

Ulteo Open Virtual Desktop v . . . ~RC

Section 3

Handlers

This section denes what handlers and in which order should be used to handle trac between user s browser and web application. Each handler should have unique name (key). Parameter type is obligatory and denes type of handlers. Optional parameter lters describes lters that should be proceed during request handling.

3.1

ServerHandler

ServerHandler - manages basic conguration 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) denes list of conditions and next_handler (handler to execute if no condition is fullled). Condition parameter: cond (mandatory) valid python expression. next_handler (mandatory) - name of handler executed if condition is fullled Variables available in cond expression:
ULTEO SAS -

Ulteo Open Virtual Desktop v . . . ~RC

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 lters between two handlers. Example:
Example : Chain : type : " ChainHandler " next_handler : " Client "

3.5

RedirectHandler

RedirectHandler redirects to given location. Parameter location (mandatory) can dene URL or path to which user should be redirected. Example:
Example : Chain : type : " ChainHandler " next_handler : " Client "

ULTEO SAS