Bria 3.
CounterPath Corporation CounterPath Corporation. Suite 300, One Bentall Centre 505 Burrard Street Box 95 Vancouver BC V7X 1M3 Tel: 1.604.320.3344 sales@counterpath.com www.counterpath.com © February 2010 This document contains information proprietary to CounterPath Corporation, and shall not be used for engineering, design, procurement, or manufacture, in whole or in part, without the consent of CounterPath Corporation.
Contents 1 About Provisioning ....................................................................................................................3 1.1 Provisioning Functions .....................................................................................................3 1.2 Licenses ............................................................................................................................3 1.3 What Provisioning Does: Writing to Settings................................................
CounterPath Corporation 2
About this Manual This manual describes the mechanism of remote login/provisioning. It describes how to set up a server (or servers) for the remote login and optionally the remote provisioning, remote update and remote upgrade features of Bria: • • • • Remote login controls access to the application; the softphone will not start until the user has logged in. Remote provisioning lets you configure the softphone remotely.
CounterPath Corporation 2
1 About Provisioning 1.1 Provisioning Functions Provisioning of Bria includes the following features: • • • • Controlling access to the VoIP service through a remote login. The ability to provide a license key remotely. below Updating the Bria configuration (changing the factory defaults). Bria can be configured differently for each user. This feature is optional. See page 15. Providing upgrades to the executable by making new versions of Bria available to each Bria installation to download.
CounterPath Corporation Bria connects to https://secure.counterpath.com via port 443; make sure your firewall allows this HTTPS traffic to this URL. In addition, if you have explicitly set a web proxy (Start > Control Panel > Internet Options > Connections) then Bria will use this proxy; make sure the proxy allows this traffic. 1.3 What Provisioning Does: Writing to Settings Each provisioning function involves writing to settings stored on Bria computer.
Bria 3.0 Provisioning Guide – Retail Deployments 1.4 The Mechanism of Remote Provisioning Each remote provisioning service involves an exchange between the login server and an individual Bria client. The exchange is performed over HTTP or HTTPS. 1.4.1 Servers You must deploy servers to handle the provisioning requests: • • • The “login server”: a server to handle login requests, if you decide to implement login. This server is simply a web server that, at a minimum, can serve one plaintext or XML file.
CounterPath Corporation might become this POST used to log in the user: https://mycustomloginserver.com/login.php -------------------------------------------------------------------------------------Username=21187 Password=rosebud platform=win32 lic=d3874ihfd8t23975v1iu5182ruity3iusapor236u545uye0r9qwjj Note that “Username” and “Password” (with initial capitals) are always sent in a login POST; the URL does not have to include macros for this data.
Bria 3.0 Provisioning Guide – Retail Deployments 1.4.4 Data Format All the data included in the GET or POST response is in a specific format. This format is similar to that of Microsoft® Windows®.ini files.
CounterPath Corporation 1.4.5 Example of an Implementation The hardware requirements of the login server depend on what the server will do. If it will have a complicated backend database and processing in order to retrieve the settings that are to be provisioned, then the server should be of higher processing capabilities. Regardless, the login server is simply a web server and it only needs to serve one file for provisioning; this file is in plaintext or XML format.
2 Login and Configuring 2.1 Credentials Required 2.1.1 Types of Credentials Login Credentials Login refers to the process of signing into the VoIP service. The Bria user must enter login credentials – user name and password – in order to access to Bria. Login credentials cannot be changed through provisioning. SIP Account Credentials Once the user has logged in, the SIP account credentials allow the user to register for your VoIP service; they are known to your SIP registrar.
CounterPath Corporation • • The authorization user name is used only to register the account. It does not replace the account user name in identifying the user to the outside world. If you use an authorization name, make sure it is different from the user name! 2.2 Specifying the Login Server You can identify the login server in one of these ways: • • Bria discovers login server via DHCP. Users enter login server manually.
Bria 3.0 Provisioning Guide – Retail Deployments The user should enter the server URL and their login credentials and click Login. Bria attempts to login to that server, as described in “The Login Process” on page 12. If the login is successful, then account credentials and other data are sent through provisioning. This data, along with the manually entered URL for the login server, is stored locally on the Bria computer. The next time the user logs in, the locally stored server URL is used. 2.
CounterPath Corporation 2.4 The Login Process The login server must be set up to handle the following procedure. Step client GUI client your Server proxy User enters login credentials on Login dialog box Query Login credentials Verification Perform any verification, including license verification success and account credentials Response Local verification Client verifies license key Register using account credentials Login Procedure Is Invoked The Login dialog box is displayed.
Bria 3.0 Provisioning Guide – Retail Deployments might become this POST used to log in the user: https://mycustomloginserver.com/login.php -------------------------------------------------------------------------------------Username=21187 Password=rosebud platform=win32 cid=d3874ihfd8t23975v1iu5182ruity3iusapor236u545uye0r9qwjj where: • • “Username” and “Password” (with initial capitals) are always sent in a login POST; the URL does not have to include macros for this data.
CounterPath Corporation Example that includes a license key being sent down to the computer: [DATA] Success=1 LicenseKey="e48jey45379ryeioo8a7e934q8dhfudufoladskiuwb" [SETTINGS] proxies:proxy:user_name="KPerera" [##MEMORY##] proxies:proxy0:password="rosebud" where: • • • • • Success: this line is required. LicenseKey: the license key for the computer. This data should be sent for a new deployment or if you want to change the existing license key. Settings: the username will be saved at shutdown.
Bria 3.0 Provisioning Guide – Retail Deployments 3 Updates and Upgrades Remote Updates You can configure Bria to check with the update server at specified intervals for changes to the user’s settings. Remote Upgrades There are two ways to support upgrades to Bria. Use CounterPath Upgrade Server The default behavior is to obtain upgrades from the CounterPath upgrade server.
CounterPath Corporation feature:auto_update update_check_t1_s See below for a description. Default is 86400 seconds (24 hours). Typically, leave the default. feature:auto_update timer_factor See below for a description. Default is 1.00 Timer Settings Remote upgrades and remote updates rely on four timers in the user’s settings. The timers control how frequently Bria contacts the update and upgrade executable servers. All values are in seconds.
Bria 3.0 Provisioning Guide – Retail Deployments 3.2 Remote Update 3.2.1 Setting Up • • Set up Bria as described on page 15. Set up the update server to handle the procedure described below. 3.2.2 How Remote Update Is Performed Assuming that the timers are not all set to zero, this procedure runs “in the background” for as long as Bria is running. 1.
CounterPath Corporation 3.3 Remote Upgrade 3.3.1 Setting Up • • Set up Bria as described on page 15. Set up an upgrade server as follows: • You can use a script to include logic that determines a given deployment needs an upgrade. See below for an example. Obtain the sample upgrade script from CounterPath and modify it to suit your needs.
Bria 3.0 Provisioning Guide – Retail Deployments [DATA] Success=1 Mandatory=1 version=60000 url=https://executableupgradeserver.com/newversion.exe where: • Success: 1=true (there is an upgrade) or 0=false (there is no upgrade). • Mandatory: 1=true. This response is optional; the default is “0”. Bria handles the upgrade differently depending on this response; see below. • version: identifies a build stamp set by Bria during build time.
CounterPath Corporation 20
A Script Samples Contact CounterPath to obtain sample scripts. These sample scripts, written in PHP, are intended to illustrate a possible implementation. They are not intended to be used without modification. You should write scripts suitable to your environment, in an appropriate scripting language. login.php Custom login script. Bria passes in the username and password.
CounterPath Corporation B Macros Macro Description $acc_passwdn$ where n is an account. The password for the specified SIP account (for deployments that support more than one SIP account). Value Stored as a setting. $acc_usern$ where n is an account. The username for the specified SIP account (for deployments that support more than one SIP account). Stored as a setting. $build$ The unique buildstamp.
