Hawk Server. Administrator Guide. Beta Version MHInvent Limited. All rights reserved.

Transcription

1 Administrator Guide Beta Version

2 Introduction Thank you for being part of the beta program for Hawk Secure Browser! This document will guide you through the administration process for Hawk Server. The Hawk Administration Tool is a web service which comes installed with Hawk Server and provides access to the major settings of the server including: Configuring the IP address and port number of the Hawk Server s gateways. Configuring the end service which Hawk Server points to. Setting the URL domain of the web service you wish to securely access. Creating and managing user accounts for Hawk Secure Browsers. Generating registration tokens for each user. Managing Hawk Browser clients provisioned for a user. We really do want your feedback to help us improve the product to better fit your needs. Please visit to let us know your thoughts and suggestions. Before you Begin Please ensure you have access to an installation of Hawk Server and note the server s IP address. If you haven t installed an instance of Hawk Server please visit hawk-browser.com where you can freely register and download the beta of Hawk Server. You will also find complete instructions for installing Hawk Server. Accessing Hawk Administration Tool To access the Hawk Administration Tool installed on the Hawk Server, visit address>:8080/admin-tool via your preferred web browser, where <IP address> is the location of your Hawk Server installation. You will be presented with the homepage of the Hawk Administration Tool. 2

3 Administrator Guide From here, you can see menus giving administrators access to: Server Locations Services Domains User Accounts You will also find more information about the server on the homepage including the release version of Hawk Server, the license issue date and expiry, and the maximum number of Hawk Browser clients allowed on the server. To return to this homepage at any time, click on the MHI logo at the top-left. Please note that the maximum number of registered Hawk Browsers for our beta program is 49. If you wish to register more Hawk Browsers, please contact our sales team at or call us on +44 (0) Configuring Server Locations The Server Locations page defines the location of the gateways which allow Hawk Server to operate. In order for Hawk Server to function, these gateways must be configured. To access the Server Locations page, click on the Server Locations menu. Hawk Server Administrator Guide 3

4 Enter the IP address of your Verification Gateway. This is typically the same IP address as the Hawk Server. If you are using IPV6 then check the IPV6 checkbox. Enter the port number your Verification Gateway is listening on. By default, this is Enter the IP address of your Service Gateway. This is typically the same IP address as the Hawk Server. If you are using IPV6 then check the IPV6 checkbox. Enter the port number your Service Gateway is listening on. By default, this is Enter the IP address of your Eagle Tunnel. This is typically the same IP address as the Hawk Server. If you are using IPV6 then check the IPV6 checkbox. Enter the port number your Eagle Tunnel is listening on. By default, this is Click Save Changes. Your configuration will now be stored, however you can change any of these 4

5 Administrator Guide settings at any time. Configuring Services The Services page defines the service endpoint Hawk Server points to. For the purposes of our beta program we automatically set service to point to an internal proxy on port If you have a fixed IP address and port number for your service/site, you can update the Services details with this information. This increases the security model by limiting the browser to only connect to that IP, if the web service serves any content from another IP than the one defined (e.g. external advertisements), it will not be displayed. To access the Services page, click on the Services menu. Enter the IP address of the service endpoint you want Hawk Server to point to. Enter the port number of the service endpoint. Enter the session timeout (in seconds). This should match the session timeout for your service. If unknown, leave at the default value of 300. Enter the verification attempt limit, where 0 means there s no verification limit. This is the number of attempts that a user can input their passcode before their account is suspended. Click Update to save changes. Configuring Domains The Domains page sets the URLs the Hawk Server accesses. This means that each provisioned Hawk Browser will access and display the page from the URL defined here. An initial URL must be entered in the Domains page before proceeding. To access the Domains page, click on the Domains menu. Hawk Server Administrator Guide 5

6 Enter an initial URL you wish Hawk Server to access. The initial URL could be a login URL page or an initial page for registering with your chosen web service. Otherwise, just enter the URL of your choice. Please ensure you enter a fully qualified URL e.g. (Optional) Enter a home URL. The home URL value will affect the URL Hawk Browser visits when a user clicks on the Home button in the browser. If you leave this field blank, Hawk Server will automatically duplicate the value in Initial URL into this field. Please ensure to enter a fully qualified URL e.g. Click Update to save changes. Adding Domains Adding a domain creates a white list of locations that the Hawk Browser can access and secure, all other domains will be redirected to the user s default browser if installed. This is particularly powerful when used with a proxy server. If the Hawk Browser is to be locked down to a single IP address, rather than a proxy, the domains can be used to control access to virtual hosts. Adding a domain can be be achieved in the following format: * subdomain.yourdomain.com *.yourdomain.com If no domain is added, then by default all accessible sites will be displayed via the Hawk Browser. 6

7 Administrator Guide Configuring User Accounts The User Accounts page allows Hawk Server administrators to create and manage user accounts within Hawk Server. Once a user account has been created, the administrator can generate a registration token and the user will be able to register their Hawk Secure Browser with the Hawk Server. User Accounts can register multiple Hawk Browsers on different computers e.g. their home computer and work computer. Please note that a unique registration token will need to be generated for each user device. To access the User Accounts page, click on the User Accounts menu. Hawk Server Administrator Guide 7

8 Creating a User Account To create a user account, click the Show/Hide Create Form. Enter the user s forename. Enter the user s surname. Set whether you wish the user account to be enabled or disabled. Click the Create button. The user will appear under the Page User Accounts section. 8

9 Administrator Guide Searching for a User Account To search for an existing user account: Start typing a name in the search box under Search User Accounts on the User Accounts page. If a match is found, a drop-down menu will display the results. Click on the user account within the drop-down menu. Hawk Server Administrator Guide 9

10 Editing a User Account To edit an existing user account: Search for the user account on the User Accounts page you wish to edit and click the Edit button. Deleting a User Account To delete a user account: Search for the user account on the User Accounts page and click the Delete button. A prompt will appear asking whether you re sure about deleting the user account? Click OK. Generating a Registration Token To generate a registration token for a user s device, search for the appropriate user account and click the Edit button next to the user. 10

11 Administrator Guide Click on the Create Registration Token button. Enter the token lifetime. This defines the expiry length of the registration token you are about to generate. Token lifetime only accepts the ISO Date Format (ISO8601). E.g. p1w means a lifetime of 1 week. PT5m means a lifetime of 5 minutes. PT120s means a lifetime of 120 seconds. Enter a registration password. This is a password that must be known or shared by the user who is registering their Hawk Browser. This is a simple step to add additional security to the registration process. It ensures that the token is only used by the person who knows this password. Enter the registration password again to confirm. Click Generate Registration Token. Hawk Server Administrator Guide 11

12 The user s account page will now reload and generate a token on-screen with an expiry date. Please share this token with the user in a secure manner so they can register their Hawk Browser. Managing Registered Hawk Secure Browser Clients Once a user has successfully registered a Hawk Browser on their device, an administrator is able to manage the provisioned Hawk Browser Client from the Hawk Server. Deleting a Registered Hawk Secure Browser Client Deleting a Hawk Browser client for a user may be necessary for some of the following reasons: The user no longer owns the device Hawk Browser is installed on. The user s device is lost or stolen. The user no longer wishes to use their Hawk Browser. An administrator wishes to revoke the user s access. To delete a Hawk Browser client for a registered user: Click on the User Accounts menu. Page or search for the appropriate user account. Click the Edit button next to the user account. Scroll down to the Clients section on the user account s page. Find the client you wish to delete and click on the Delete button. A prompt will appear asking whether you re sure about deleting the client? 12

13 Administrator Guide Click OK. Resetting Passcodes for Registered Hawk Secure Browser Clients When a user registers their Hawk Secure Browser, they must create a passcode (using images or text-based) in order to log in. A passcode is generated per client, rather than per user account, thus if a device is lost, the specific device can be disabled and the user does not need to reset their password for all their other devices. A user can choose if they want to use a different passcode on every device, or use the same one. It s entirely up to the user. For security reasons, administrators do not have access to the user s passcode for each client and have no way to inform a user of their login credentials or reset it,should they forget their details. If a user forgets their passcode, simply delete their appropriate client from their user account and generate a new registration token. The user can use their already installed Hawk Browser to register again and select a new passcode. Getting Support If you require any technical support on Hawk Server or any version of Hawk Secure Browser please visit our website at: You can also contact us via at: support@hawk-browser.com Our team are more than happy to help to get you up and running with Hawk Secure Browser. Sending Feedback As part of this beta release program we welcome any feedback on our software including Hawk Secure Browser and Hawk Server. We are always looking for ways to improve the ease of use, customer experience and crucially the security of our products. If you wish to send us any feedback please visit our website at: Or, contact us via at: feedback@hawk-browser.com Hawk Server Administrator Guide 13