White Paper. Installation and Configuration of Fabasoft Folio IMAP Service. Fabasoft Folio 2015 Update Rollup 3

Transcription

1 White Paper Fabasoft Folio 2015 Update Rollup 3

2 Copyright Fabasoft R&D GmbH, Linz, Austria, All rights reserved. All hardware and software names used are registered trade names and/or registered trademarks of the respective manufacturers. No rights to our software or our professional services, or results of our professional services, or other protected rights can be based on the handing over and presentation of these documents. 2

3 Contents 1 Introduction 4 2 Software and Hardware Requirements 4 3 Installation of Automated Setup 4 4 Configuration of Microsoft Windows Environment Linux Environment 10 5 Configuration of Mozilla Thunderbird Configure an Account Using the Account Wizard Client Authentication Basic Authentication (Default Security Settings): Client Certificate Authentication Subscribing Folders 14 6 Mailbox Configuration in Fabasoft Folio 15 3

4 1 Introduction This document describes the installation and configuration of in a Microsoft Windows environment or Linux environment using an existing Fabasoft Folio Domain. 2 Software and Hardware Requirements System environment: All information contained in this document implicitly assumes a Microsoft Windows environment or Linux environment. Supported platforms: For detailed information on supported operating systems and software see the software product information on the Fabasoft distribution media. 3 Installation of This chapter describes the installation of. 3.1 Automated Setup To install using the automated setup, perform the following steps. 1. Insert the Fabasoft product DVD in the DVD drive of your server. The Fabasoft Server Setup dialog will be displayed automatically. Note: If this dialog is not displayed automatically, run setup.exe in the root directory of the Fabasoft product DVD. 2. Accept the Fabasoft legal terms and click Next. 3. Select Install additional Fabasoft services and products for existing domain, enter the host and the port and click Next. Note: can also be installed during the initial setup of the Fabasoft Folio Domain. In this case additionally select when installing the other services and products. 4

5 4. Select and click Next. 5. A check on all prerequisites is performed. Ensure that your system complies with all requirements (indicated by a green tick) and then click Next. 6. In a Microsoft Windows environment specify the service user and click Next. 7. In the Review Configuration, the can be configured. If you want to change the settings, click Edit next to. Otherwise 5

6 click Install to start the installation. In this case the next steps can be omitted. 8. The following parameters can be specified o Fabasoft Web Service URL Specifies the URL to the Fabasoft Folio Web Service. Note: If the should use client certificate authentication, then the web service must be reachable over HTTPS using a certificate. A not encrypted connection is not accepted by the Fabasoft Folio Web Service. If the certificates should be generated automatically by the Fabasoft server setup define the fully qualified domain name (FQDN) here, otherwise a connection would fail due to a certificate error. Note: If the Fabasoft Folio eservice is installed on a Linux Host, the Fabasoft Web Service URL needs to be given in the Format o IMAP Service Authentication Method Select the desired authentication method. The following options are available: 6

7 Basic Authentication In this case IMAP clients will use a non-encrypted connection to the Fabasoft Folio IMAP Service with basic authentication. The used Fabasoft Folio Web Service has to accept basic authentication. Basic Authentication with SSL IMAP clients will use an encrypted connection (SSL) to the with basic authentication. The used Fabasoft Folio Web Service has to accept basic authentication. Client Certificate Authentication will require an encrypted connection and client certificates. The client certificates common name will be used as the user s login name. The used Fabasoft Folio Web Service has to accept client certificate authentication. o IMAP Service Certificate These parameters are not relevant if basic authentication (without SSL) will be used. Specify the following parameter if basic authentication with SSL or client certificate authentication should be used and the certificates should not be generated by the setup automatically: CA Certificate (X.509 PEM) If own certificates are used select your CA here. Server Certificate (PKCS#12) Select the certificate for the IMAP server here. Server Certificate Password Type the password for the server certificate here. Note: If you want that the setup generates the CA and server certificate leave these three fields blank. o eservice Configuration These parameters are only required if client certificate authentication should be used. The following parameters can be specified: IMAP Service Privileged User Specify a username which is used by the to authenticate at Fabasoft Folio. The Fabasoft server setup creates a user in the Fabasoft Folio Domain having this userlogname. This user is defined as privileged user. Note: If the user does not exist as an operating system user the Fabasoft setup will create a local user automatically on Microsoft Windows platforms. IMAP Service Privileged User Password Specify the password of the Fabasoft IMAP Service privileged user. This parameter has to be specified only on Microsoft Windows platforms. IMAP Server IP Address Specify the IP address of the server where the Fabasoft IMAP Service will be installed. If the and the Fabasoft Folio Web Service are installed on the same server specify on Linux or the hosts IP address (e.g. "10.10.x.x") on Microsoft Windows servers. This IP address is necessary to ensure the security with remote user authentication. Client Certificate (PKCS#12) If own certificates are used select your client certificate here which the Fabasoft IMAP Service will use to authenticate at the Fabasoft Folio Web Service. Client Certificate Password Type the appropriate password for the client certificate. CA Certificate (X.509 PEM) Select your CA. Note: If you want that the Fabasoft IMAP Service setup generates the client certificate leave these three fields blank. In this case the Fabasoft IMAP Service setup has to be executed on the same machine where a Fabasoft eservice is installed, otherwise the 7

8 generation of the client certificates will fail. If an existing SSL web service is used the certificates must be set here anyway. The SSL connection must be set as it requires client certificates and a mapping of the client certificate to the user must be configured. 9. Click on to display the configuration details. 10. Verify the configuration settings. Example: 11. Click Install to start the installation. The is installed. 4 Configuration of After the installation the following parameters can be modified changing the values in the registry: httpbaseurl Specifies the URL to the Fabasoft Folio Web Service. httptimeout Specifies the timeout for the HTTP connection to the Fabasoft Folio Web Service in seconds. Default value: 60. imaphost Contains the IP address where to bind the IMAP socket to. Default value: Empty (means, the binding is on all interfaces). 8

9 imapport Specifies the port of the. Default value (Microsoft Windows environment/ssl): 143/993. Default value (Linux environment/ssl): 17143/ imaptimeout Specifies the timeout for the IMAP connection in seconds. Default value: 30. imapenablessl Specifies whether the will require SSL. Set the value of this key to "true" to enable this option. imapsslcert Contains the path to the server certificate file for the. This property is only relevant if SSL is enabled. imapsslkey Contains the path to the server certificate key file for the. This property is only relevant if SSL is enabled. imapsslkeypassphrase Contains the passphrase for the server certificate key file. This property is only relevant if SSL is enabled. imapsslca Contains the path to the certification authority file for the. This property is only relevant if SSL is enabled. imapsslverifydepth Specifies the maximum depth of CA certificates in certificate verification. This parameter is only relevant if SSL is enabled. Default value is 2. imapssluseclientcert Specifies whether the will require client certificates. Set the value of this key to "true" to enable this option. Client certificates can only be used in combination with SSL. See also chapter 3.1 Automated Setup. httpcertcert Contains the path to the user s client certificate file. This client certificate will be used for the authentication on the Fabasoft Folio Web Service. This parameter is only relevant if client certificates are enabled. httpcertkey Contains the path to service user s client certificate key file. This parameter is only relevant if client certificates are enabled. httpcertkeypassphrase Specifies the passphrase for the client certificate key file. This parameter is only relevant if client certificates are enabled. httpcertca Contains the path to the certification authority file for the Fabasoft Folio web service. This parameter is only relevant if client certificates are enabled. 4.1 Microsoft Windows Environment The registry entries for the can be found under HKEY_LOCAL_MACHINE\SOFTWARE\Fabasoft\Fabasoft Components Services\IMAP. The changed values will be used by the IMAP service after a service restart. 9

10 4.2 Linux Environment The configuration entries for the in a Linux environment can be found under /etc/fabasoft/settings/machine/software/fabasoft/fabasoft Components Services/IMAP/IMAPService_<id>/. To change for example the httpbaseurl of the execute following command: echo n " >httpbaseurl After a restart of the IMAP service with the fscmgmt tool the new value will be used. 5 Configuration of Mozilla Thunderbird This chapter describes how to configure an account with Mozilla Thunderbird for accessing e- mails using the Fabasoft Folio IMAP service. At first configure an account with an incoming IMAP server. 5.1 Configure an Account Using the Account Wizard 1. Create a new account: 10

11 2. Specify your name and address: 3. Select IMAP and specify the incoming server: Note: The incoming server has to be the server running the Fabasoft Folio IMAP service. If desired specify also an outgoing SMTP server for sending s. 11

12 4. Specify the incoming user name: Note: This user name will be used if basic authentication (with or without SSL) is required. If client certificate authentication is used the client certificates common name will be used as the user login name. 5. Click "Next" to finish the wizard. Note: Depending on the used settings for the Fabasoft Folio IMAP service it can be required to activate SSL or to change the port settings. Therefore open the Account Settings window and click an Server Settings. 5.2 Client Authentication Basic Authentication (Default Security Settings): If basic authentication (with or without SSL) is used the users password has to be specified. The password can also be stored using the password manager Client Certificate Authentication If client certificate authentication is required perform the following steps: 12

13 1. Activate SSL for the account: Open the "Account Settings" window and click on "Server Settings". In the "Security Settings" section select the SSL option: 2. Import the client certificate: To import the user's client certificate the Mozilla Thunderbird Certificate Manager can be used. Change to the "Security" menu and open the certificate manager by clicking "View Certificates". Import the client certificate using the Import button: 3. Type in a password: Due to the IMAP specification the Mozilla Thunderbird client requires a password although client certificates are used. The entered password will not be used for authentication purposes. 13

14 Therefore any input will be accepted. 5.3 Subscribing Folders If the mailbox in Fabasoft Folio contains more folders than just the inbox which should be displayed in the IMAP client, each folder needs to be subscribed separately. To subscribe these folders right click the mailbox in Mozilla Thunderbird and select "Subscribe...": Select all folders to subscribe and click "OK": Now these folders can be accessed too: 14

15 6 Mailbox Configuration in Fabasoft Folio If a user has access to more than one mailbox in Fabasoft Folio the default mailbox used for the Fabasoft Folio IMAP service is specified in the user environment of the current user. To change the default mailbox click on "User Settings" at the "Settings" menu: Select the default mailbox on the " " tab: 15