AXIGEN User Manual. Version beta2. Last update on: 6/29/2005 7:41:22 PM Document version: 2.0

Transcription

1 Version beta2 Last update on: 6/29/2005 7:41:22 PM Document version: 2.0 1

2 Copyright & trademark notices This edition/ notices applies to version beta2 of the licensed program AXIGEN and to all subsequent releases and modifications until otherwise indicated in new editions. Notices References in this publication to GECAD TECHNOLOGIES Ltd. products, programs, or services do not imply that GECAD TECHNOLOGIES Ltd. intends to make these available in all countries in which GECAD TECHNOLOGIES Ltd. operates. Evaluation and verification of operation in conjunction with other products, except those expressly designated by GECAD TECHNOLOGIES Ltd., are the user's responsibility. GECAD TECHNOLOGIES Ltd. may have patents or pending patent applications covering subject matter in this document. Supplying this document does not give you any license to these patents. You can send license inquiries, in writing, to the GECAD TECHNOLOGIES Ltd. marketing department, Copyright Acknowledgement (c) GECAD TECHNOLOGIES Ltd All rights reserved. All rights reserved. This document is copyrighted and all rights are reserved by GECAD TECHNOLOGIES Ltd.. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, or by any information storage and retrieval system without the permission in writing from GECAD TECHNOLOGIES Ltd.. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. GECAD TECHNOLOGIES Ltd. will not be responsible for any loss, costs or damages incurred due to the use of this documentation. GECAD TECHNOLOGIES TM and AXIGEN are trademarks of GECAD TECHNOLOGIES Ltd. Other company, product or service names may be trademarks or service marks of others. AXIGEN is a SOFTWARE PRODUCT of GECAD TECHNOLOGIES Ltd. If you brake any of this copyright & trademark notices, GECAD TECHNOLOGIES Ltd. reserves its right to take legal action against you for damages. GECAD TECHNOLOGIES Ltd. 10A Dimitrie Pombei blvd, Connect Business Center, 2nd fl., Bucharest 2, ROMANIA; tel: ; fax: ; Sales: sales@axigen.com Technical support: support@axigen.com Website: (c) Copyright GECAD TECHNOLOGIES Ltd All rights reserved. 2

3 Table of contents Part I: Introduction...9 Welcome...9 Structure and purpose of this document...9 Scope...9 Audience and knowledge requirements Terminology Related documentation About GECAD TECHNOLOGIES Development Strategy...11 Technical support...11 Part II: Overview of AXIGEN...12 Description...12 Requirements and availability...12 Software requirements Hardware requirements Tested platforms Product architecture...14 About AXIGEN main services AXIGEN SMTP...14 AXIGEN IMAP...15 AXIGEN POP AXIGEN Webmail...15 About AXIGEN additional services Log server...15 Reporting...15 Mail filtering...15 About other entities in AXIGEN Storage...16 Config file...16 Listeners...16 Part III: Installing/Uninstalling AXIGEN...17 Installation steps...17 Required files Installing AXIGEN under RedHat and SuSE

4 Installing AXIGEN under Debian Installing AXIGEN under Gentoo Installing AXIGEN under Slackware Uninstalling AXIGEN under RedHat and SuSE Uninstalling AXIGEN under Debian Uninstalling AXIGEN under Gentoo Uninstalling AXIGEN under Slackware Starting/stopping/restarting AXIGEN Part IV: Configuring AXIGEN...24 General server configuration (axigen.cfg file) Restrictions...24 Definitions...24 Server-related settings...25 Parameters...25 Settings related to SMTP Incoming module...26 Connection Error Control Parameters...27 Connection Thread Control Parameters...28 Log Control Parameters...29 Authentication Parameters...31 Additional security features Client Management Parameters...33 Listener Control Settings related to Processing module...36 The Queue Message statuses Mail Scheduling Parameters...37 Inspecting the queue Parameters...39 Local delivery Parameters

5 Log Control Parameters...40 Settings related to SMTP Outgoing module...42 Connection Thread Control Parameters...43 Log Control Parameters...44 Client Management Parameters...45 Settings related to POP3 module...48 Connection Error Control Parameters...49 Connection Thread Control Parameters...50 Log Control Parameters...51 Listener Control Settings related to IMAP module...53 Authentication Parameters...54 Connection Error Control Parameters...55 Connection Thread Control Parameters...56 Log Control Parameters...57 Listener Control Settings related to Webmail module...59 Features Complex customization...59 Easy to use, secure and user-friendly...59 Server side scripting language...60 Listeners...60 Compose while attach...60 Connection Thread Control Parameters...60 Log Control Parameters

6 Path Parameter...63 Webmail session control Parameters...63 Listener Control Server-side scripting language Changing Webmail look and feel Settings related to DNR (Domain Name Resolver)...65 General Attributes Settings related to Log service...66 AXIGEN log types Logging format Actions Rules AXIGEN Log levels Attributes of the Log service Listeners for AXIGEN Log service Settings related to Filters...71 Specific Filters AntiVirus / AntiSpam filters...73 Custom Filters: Sieve...73 Applying other filters on AXIGEN...73 Parameters SPF Authentication Other filters on AXIGEN Sieve Scripts Description...75 AXIGEN Sieve implementation Implemented Extensions...77 AXIGEN Sieve implementation Restrictions and Constraints...77 About AXIGEN Storage...79 Message and account storages Storage containers Filling the containers Storage features Simultaneous access...80 Error control

7 About Listeners...81 IP Rules Using the 'denyrules' and 'allowrules' attributes...81 TCP Rules Example of a listener configuration Limiting the number of allowed connections for a given listener...87 Limiting the number of accepted connections for a specific IP address 88 Limiting the inactivity for a given listener...88 About Reporting...89 Functional description Traffic Counters How do the counters function?...90 Monitor Part V: Working with AXIGEN...92 Configuring domains in AXIGEN...92 Configuring accounts in AXIGEN...93 Creating/Changing accounts and domains in AXIGEN...94 Description of the 'provisioner' tool...96 Provisioner flags Provisioner options Provisioner commands Provisioner commands in interactive mode Provisioner error codes Other command line parameters in AXIGEN server Display version...99 Run in foreground...99 Crash control...99 Process ID Path to configuration file Using mqview tool to view status message for files in queue POP3 Authentication Appendix A: Bug Report Form Appendix B: AXIGEN and RFCS POP3 specifications SMTP specifications IMAP specifications Implementation Recommendations SMTP service extensions DNS specifications

8 Sieve extensions implemented in AXIGEN Appendix C: AXIGEN counters

9 Part I: Introduction Welcome Congratulations on your decision to evaluate AXIGEN. Currently this product is in beta phase, so it only includes some of the features it will finally include in the commercial version once released. For a complete description of the functions currently available in AXIGEN, please refer to the Description section in this document. The commercial version of AXIGEN will include SMTP, POP, IMAP and Webmail offering numerous other capabilities. Structure and purpose of this document Scope This document is divided into 3 main sections and 2 appendixes: Part 1: Introduction contains general information about AXIGEN and its producer, GECAD TECHNOLOGIES; Part 2: Overview of AXIGEN contains a description of the product and its functionalities, as well as the hardware & software requirements and the availability of the product; Part 3: Installing AXIGEN explains how to install and un-install the product, the directory/file structure and how you can start, stop and restart AXIGEN server; Part 4: Configuring AXIGEN describes the configuration options available in the product, Part 5: Working with AXIGEN explains how you can work with AXIGEN, in terms of creating new accounts and domains, loading them on AXIGEN server, changing configuration for existing accounts and domains, etc.; Appendix A: Bug Report Form provides a form you can use to report any bugs in the product; Appendix B: AXIGEN and RFCs provides a list of RFCs applied in the programming of AXIGEN ; Appendix C: AXIGEN Counters provides a list of the counters included by default in AXIGEN. This document serves as a guide to administrators of the mail servers in companies where the version beta2 of AXIGEN application is installed and evaluated. The purpose of this User Manual is to provide: A brief overview of the architecture and functions of AXIGEN ; An overview of the installation process for AXIGEN, including preinstallation requirements and hardware and software requirements; A brief presentation of the configuration and administration options; Instructions on how to report eventual problems and obtain technical support for your AXIGEN. 9

10 To make sure you will be efficiently using AXIGEN from the very beginning, we strongly recommend you to read carefully this User Manual. Important: This document relates to a beta version of AXIGEN. We would really appreciate your feedback on this beta version. Audience and knowledge requirements The intended audience for this User Manual is represented by administrators of the mail servers in companies where the version beta2 of AXIGEN application is installed and evaluated. In order to build, extract and acquire the correct information from this manual, a regular audience should have: A detailed knowledge of general mail server abilities and functions. Good comprehension of the RFC requirements. Scripting skills, in order to use correctly AXIGEN Webmail extension capabilities. Terminology The following terms are being used with the specified meaning throughout this manual: SMTP (Simple Mail Transfer Protocol) is a TCP/IP protocol used in sending and receiving . However, since it is limited in its ability to store messages at the receiving end, it is usually used with one of two other protocols, POP3 or IMAP, that allow the user to download the messages periodically from the server. POP3 (Post Office Protocol version 3) is a standard protocol for accessing from your mail server. When you read your mail, all of it is immediately downloaded to your computer and, except when previously arranged, no longer maintained on the server. POP3 can be thought of as a "store-and-forward" service. IMAP is an Internet messaging protocol that enables a client to access mail messages directly on a server, without downloading them on the user s computer. Mailing list: a list of people who subscribe to a periodic mailing distribution on a particular topic. Mailing lists have become a popular way for Internet users to keep up with topics they're interested in. Many software producers and other vendors are now using them as a way to keep in touch with customers. Queue: a list of messages waiting to be processed. Open Mail Relay: An open mail relay is an SMTP ( ) server configured in such a way that it allows anyone on the Internet to relay (i.e. send) through it. Directory Service: In the context of , a directory service provides a list of information about users on a computer network such as names, addresses, phone numbers, and office locations. RFC: Abbreviation for Request For Comments. The documents that contain the protocols, standards and information that define the internet. Gathered and published by the Internet Engineering Task Force, a consensus-building body made up of institutions and corporations involved with online communications, they are preceded by RFC and followed by a number. A complete list of RFCs can be found at while the list of RFCs implemented in AXIGEN 10

11 Counter: Entities generating different AXIGEN reports on domain, total and others levels. Domain: Administrative entity grouping one or (usually) more accounts within the same company or location. "axigen.com". Account: Administrative entity in AXIGEN. Synonym to "mailbox". Related documentation Additional information regarding AXIGEN can be found in the following documents: AXIGEN server side scripting language - Contains relevant information for programmers trying to extend the current HSP abilities (Webmail specific); AXIGEN Online documentation. About GECAD TECHNOLOGIES Founded in 2001, GECAD TECHNOLOGIES is a company involved in technology research and project management, offering services initially for antivirus industry (GECAD has sold the RAV Antivirus IPR to Microsoft Inc. in 2003). Since then, we have concentrated on an innovative technology: messaging solutions. GECAD TECHNOLOGIES is a member of GECAD Group. Development Strategy We create messaging technology incorporated in scalable solutions: from small companies to large ISPs. Our products are developed for demanding system administrators, people in a continuous quest for new ways to improve their solution. Our policy is to continuously develop our product in a pace that follows closely our customers' needs. Based on platform independent core and independent running modules and accommodating the newest hardware architectures, our product is built for reliability and security, supplying ease for our customers. Technical support For any details regarding the installation and the functionality of this product, please contact the local dealer you have bought the product from. If he does not offer you the adequate technical support, please feel free to contact AXIGEN Team directly and you will be offered technical support. 11

12 Part II: Overview of AXIGEN Description AXIGEN is a state-of-the-art SMTP, IMAP, POP, secured SSL/TLS and Webmail server. Below you can find a schema describing all the components of AXIGEN. The configuration parameters for each module of AXIGEN can be read from the configuration file. The corresponding sections in Part IV: Configuring AXIGEN present these parameters in details. Some command line arguments are also available in the product. As they are not module specific, we have chosen to present these command line arguments in the Other command line parameters in AXIGEN section of this User Manual. Requirements and availability Software requirements The software requirements, for AXIGEN, are: Linux OS, kernel 2.4/2.6 12

13 glibc version or later libstdc++ version 3.2 or later Hardware requirements AXIGEN has the following minimal hardware requirements: 1. Processor: x86, minimum frequency 300 MHz; 2. RAM: 128 MB. 3. Available space on HDD: 20 MB free space for installation purposes and default configuration files. The actual space AXIGEN will take on your hard disk depends on the numbers of accounts, domains and mailboxes and the size of messages stored on the mail server. Tested platforms AXIGEN has been tested thoroughfully and is guaranteed to work on the following Linux distributions: RedHat 8.0, Suse 8 Enterprise, Gentoo, Debian 3.0, Slackware

14 Product architecture AXIGEN consists of four main services and a number of additional services. About AXIGEN main services The AXIGEN main services are: SMTP (includes SMTP Incoming, Processing and SMTP Outgoing), IMAP, POP3 and Webmail. The AXIGEN Additional services are: Log service, Reporting and Filters. AXIGEN SMTP AXIGEN SMTP is the module responsible with establishing connections initiated by other entities via SMTP/ESMTP protocols and for generating connections for external delivery of mail messages. AXIGEN SMTP module is compliant with ESMTP RFCs, presenting the corresponding features. Practically, the SMTP module contains the three following sub-modules: SMTP Incoming, Processing and SMTP Outgoing. The SMTP Incoming module is responsible with establishing connections initiated by other entities via SMTP/ESMTP protocols. This module includes functions such as configurable listeners (including TCP rules and IP rules, thread management and client management, user authentication and a built-in SPF authentication procedure). 14

15 The Processing module manages the mail messages in AXIGEN queue, offering the system administrator information about mail message status, full control for filtering abilities (antivirus, antispam, custom made filters, Sieve scripts) on server, domain and user levels. This module receives mail messages from the SMTP Incoming and Webmail modules and delivers them to AXIGEN Storage (for local delivery) and to the SMTP Outgoing module (for external delivery). The SMTP Outgoing module is responsible for delivering mail messages to remote hosts. This module includes functions such as thread and client management. The SMTP Outgoing module is using the Domain Name Resolver (DNR) module for mapping domains to IP addresses and includes complete rescheduling procedures. AXIGEN IMAP AXIGEN IMAP module establishes connection with IMAP clients and retrieves mail messages from AXIGEN Storage. AXIGEN IMAP module supports secure connections and allows usage of different allow/deny rules via listeners, as described in the IP rules and Example of a listener configuration sections of this User Manual. Different error control, thread control and log procedures are also available. AXIGEN POP3 AXIGEN POP3 module establishes connection with POP clients and retrieves mail messages from AXIGEN Storage. AXIGEN POP3 module allows usage of different allow/deny rules via listeners. Different error and thread control, plus log procedures are available. AXIGEN Webmail AXIGEN Webmail establishes connection with the corresponding mail client via a Web browser, sends mail messages to and retrieves mail messages from AXIGEN Storage. About AXIGEN additional services Log server Reporting The additional services currently present in AXIGEN are log server, reporting and mail filtering. You can log (internally, remotely or using the system log) the activity of all TCP services available in AXIGEN. This additional service can help you generate a wide set of reports and check server activity, not only on the global traffic level, but also by domain. Mail filtering Using the filters built-in the AXIGEN Mail Server, you can enhance the security of your network environment. About other entities in AXIGEN The following entities have a decisive administrative role in AXIGEN: the Storage and the Config file. 15

16 Storage Config file Listeners AXIGEN Storage is a proprietary format, used for fast & secure storing and retrieving mail messages and account information. It can only be used by AXIGEN modules via specific APIs. AXIGEN is delivered with a fully functional configuration file (called axigen.cfg). Note that you should adjust the product to your network's specific conditions. AXIGEN Mail Server can use different Listeners for its TCP services (SMTP Incoming, POP3, IMAP, Webmail), and for its Log service. The usage of listeners is helpful for applying different apply/deny rules for the AXIGEN main services you are using. Read more in the About Listeners section of this User Manual. Note: The main services are installed from one single executable, including the SMTP, POP3, IMAP and Webmail services. The system administrator can afterwards disable one or more AXIGEN services. The additional features and services (Log Server, Filters, Reporting Server, etc.) are designed as separate entities. They can be installed if needed, thus ensuring the product's flexibility. 16

17 Part III: Installing/Uninstalling AXIGEN The following section describes the general installation and un-installation process for AXIGEN on RedHat and SUSE distributions. For instructions related to a specific Linux flavor, please refer to the Install file included in the installation kit or read the sections starting with Installing AXIGEN under Debian from this User Manual. Installation steps Here are the steps to be taken in order to install AXIGEN. Unzip the original installation package; Install AXIGEN files; Configure axigen.cfg, as explained in the general configuration parameters of this User Manual, in order to adjust the axigen.cfg file to your specific environment; Start the AXIGEN server (Read the Starting/stopping/restarting AXIGEN section in this User Manual for information on how to start AXIGEN ); Create domains/accounts for your AXIGEN installation (more information can be found in the Creating/Changing accounts and domains in AXIGEN section of this User Manual). Reconfigure axigen.cfg (if needed). Reload AXIGEN server. This way the changes committed in the main axigen.cfg file can take effect (domains and accounts operations are made on-the-fly). Read the Starting/stopping/restarting AXIGEN section in this User Manual for information on how to reload AXIGEN. After the installation, no daemons or related application are started. Required files The installation kit consists of the following files: INSTALL, UNINSTALL README Distribution-specific package file(s). Below you can find a list of files and directories provided in the installation kit that that are needed by AXIGEN to run correctly: /etc/init.d/ /etc/init.d/axigen This is the initscript for AXIGEN. The script will start the daemon for the Gentoo, Debian, RedHat and SUSE distributions. /etc/rc.d/rc3.d/s80axigen /etc/rc.d/rc4.d/s80axigen /etc/rc.d/rc5.d/s80axigen 17

18 Symbolic links to the above mentioned initscript file, needed to start the daemon in the respective runlevels (only for RedHat and SUSE distributions). /etc/rc.d/rc.axigen This is the initscript for AXIGEN in the Slackware distribution. /etc/conf.d/axigen This is the configuration file used by the AXIGEN initscript in the Gentoo distribution. /etc/opt/ /etc/opt/axigen/ /etc/opt/axigen/axigen.cfg This is the main configuration file for AXIGEN. /opt/axigen/ /opt/axigen/bin/ /opt/axigen/bin/axigen This is AXIGEN s daemon. /opt/axigen/bin/mqview This is the executable to be used for viewing the status of the queued messages. Please refer to the Using mqview tool to view status message for files in queue section of this User Manual for instructions on using this tool. /opt/axigen/share/ /opt/axigen/share/doc/ /opt/axigen/share/doc/readme Document containing the release notes for this version of AXIGEN. /opt/axigen/share/doc/install Document containing the installation instructions for AXIGEN. /opt/axigen/share/doc/uninstall Document containing the instructions for uninstalling AXIGEN. /opt/axigen/share/doc/license Document containing the license for AXIGEN. /opt/axigen/share/examples/ /opt/axigen/share/examples/axigen.cfg /opt/axigen/share/examples/domain.cfg /opt/axigen/share/examples/account.cfg Sample configuration files, containing the default values for AXIGEN parameters, as presented in this User Manual. /var/opt/ /var/opt/axigen/ /var/opt/axigen/webmail/ Default directory used for storing files pertaining to AXIGEN s Webmail module. /opt/axigen/bin/provisioner An executable to be used for managing domains and accounts through the provision socket 18

19 Installing AXIGEN under RedHat and SuSE Here are the steps to be taken in order to install AXIGEN under RedHat and SuSE. 1. Installation The installaton kit consists in the INSTALL, UNINSTALL, README and axigen b2-1.i386.rpm files. In order to install the RPM package, you must issue (while logged in as root) the following command, from the same directory with the rpm file: rpm -ivh axigen b2-1.i386.rpm After the installation, no daemons or related application will be started. 2. Configuration Before you start AXIGEN, you need to configure it. You can do that by modifying the main configuration file (please refer to the General configuration parameters section in this User Manual for more information). 3. Start AXIGEN. In both RedHat and SUSE, the AXIGEN server can be started via its initscript, by issuing /etc/init.d/axigen start Installing AXIGEN under Debian Here are the steps to be taken in order to install AXIGEN under Debian. 1. Installation The installation kit consists in the INSTALL, UNINSTALL, README and axigen_0.8.14b2-1_i386.deb files. In order to install the DEB package, you must issue (while logged in as root) the following command, from the same directory with the deb file: dpkg -i axigen_0.8.14b2-1_i386.deb After the installation, no daemons or related application will be started. 2. Configuration Before you start AXIGEN, you need to configure it. You can do that by modifying the main configuration file and the other specific configuration files (please refer to the README file from the installation kit, for more information about their names and locations). More information about each configuration setting can be found in the sample configuration files installed by default, as comments. 3. Start AXIGEN. In Debian, AXIGEN can be started via its initscript, by issuing: /etc/init.d/axigen start Installing AXIGEN under Gentoo Here are the steps to be taken in order to install AXIGEN under Gentoo. 1. Installation 19

20 The installation kit consists in the INSTALL, UNINSTALL, README, prepare.sh, axigen _beta2.ebuild files. In order to install the ebuild package, you must follow (while logged in as root) the steps described below, from the same directory as the ebuild file:./prepare.sh emerge axigen After the installation, no daemons or related applications are started. 2. Configuration Before you start AXIGEN, you need to configure it. You can do that by modifying the main configuration file and the other specific configuration files (please refer to the README file from the installation kit, for more information about their names and locations). More information about each configuration setting can be found in the sample configuration files installed by default, as comments. 3. Start AXIGEN. In Gentoo, AXIGEN can be started via its initscript, by issuing: /etc/init.d/axigen start Several settings for the AXIGEN initscript are available via the following file (please read the comments from this file for information about using them): /etc/conf.d/axigen Installing AXIGEN under Slackware Here are the steps to be taken in order to install AXIGEN under Slackware. 1. Installation The installation kit consists in the INSTALL, UNINSTALL, README and axigen b2-i386-1.tgz files. In order to install the Slackware TGZ package, you must issue (while logged in as root) the following command, from the same directory with the tgz file: installpkg axigen b2-i386-1.tgz After the installation, no daemons or related applications are started. 2. Configuration Before you start AXIGEN, you need to configure it. You can do that by modifying the main configuration file (please refer to the General configuration parameters section in this User Manual for more information). 3. Start AXIGEN. In Slackware, AXIGEN can be started via its initscript, by issuing: /etc/rc.d/rc.axigen start In order to start AXIGEN initscript at boot time, you need to add the following line in the /etc/rc.d/rc.local file: [ -x /etc/rc.d/rc.axigen ] && /etc/rc.d/rc.axigen start and set the executable bit for the script: chmod +x /etc/rc.d/rc.axigen 20

21 Uninstalling AXIGEN under RedHat and SuSE This document contains the steps to be taken in order to uninstall the AXIGEN mail server. 1. Remove the AXIGEN RPM package In order to remove the AXIGEN package and its related files and directories, you can issue the following command, while logged in as root: rpm -e axigen The command explained above will also stop the AXIGEN daemon. 2. Optional: Remove the rest of the files/directories The command from the first step does not automatically remove the files that were modified after the installation (such as configuration files), non-empty directories and other files or directories that were not created as a result of the installation. All the files and/or directories that are contained in the following locations must be deleted manually: /etc/opt/axigen/ /var/opt/axigen/ /opt/axigen/ Uninstalling AXIGEN under Debian Here are the steps to be taken in order to uninstall AXIGEN under Debian. 1. Remove AXIGEN s DEB package In order to remove AXIGEN package and its related files and directories, you can issue the following command, while logged in as root: dpkg -P AXIGEN (to "purge" the package - this is the recommended option -, or) dpkg -r AXIGEN (to "remove" the package). These commands also stop AXIGEN s daemon. 2. Optional: Remove the rest of the files/directories The commands on Step 1 do not automatically remove the files that were modified after the installation (such as configuration files), non-empty directories and other files or directories that were not created as a result of the installation. All the files and/or directories that are contained in the following locations must be deleted manually: /etc/opt/axigen/ /var/opt/axigen/ /opt/axigen/ Uninstalling AXIGEN under Gentoo Here are the steps to be taken in order to uninstall AXIGEN under Gentoo. 1. Remove AXIGEN s ebuild package In order to remove AXIGEN package and its related files and directories, you can issue the following command, while logged in as root: emerge --unmerge AXIGEN 21

22 This command also stops AXIGEN s daemon. 2. Optional: Remove the rest of the files/directories The command on Step 1 does not automatically remove the files that were modified after the installation (such as configuration files), non-empty directories and other files or directories that were not created as a result of the installation. All the files and/or directories that are contained in the following locations must be deleted manually: /etc/opt/axigen/ /var/opt/axigen/ /opt/axigen/ Uninstalling AXIGEN under Slackware Here are the steps to be taken in order to uninstall AXIGEN under Slackware. 1. Remove AXIGEN s Slackware TGZ package In order to remove AXIGEN package and its related files and directories, you can issue the following command, while logged in as root: First, stop AXIGEN daemon: /etc/rc.d/rc.axigen stop Then remove AXIGEN package: removepkg axigen-0.9-i Optional: Remove the rest of the files/directories The command on Step 1 does not automatically remove the files that were modified after the installation (such as configuration files), non-empty directories and other files or directories that were not created as a result of the installation. All the files and/or directories that are contained in the following locations must be deleted manually: /etc/opt/axigen/ /var/opt/axigen/ /opt/axigen/ Also, you can remove the following line from the /etc/rc.d/rc.local: [ -x /etc/rc.d/rc.axigen ] && /etc/rc.d/rc.axigen start Starting/stopping/restarting AXIGEN In RedHat, Debian, Gentoo and SUSE distributions, you can start the server with the following command: /etc/init.d/axigen start To stop the server, you can issue: /etc/init.d/axigen stop In order to restart AXIGEN s daemon (in order to reload the new configuration settings, for instance), you can use the 'restart' parameter: /etc/init.d/axigen restart To view AXIGEN s daemon status, you can pass the 'status' parameter: /etc/init.d/axigen status In Slackware, you can use the same commands, applied to the /etc/rc.d/rc.axigen initscript, instead of /etc/init.d/axigen, e.g. for starting the server, you can issue: 22

23 /etc/rc.d/rc.axigen start 23

24 Part IV: Configuring AXIGEN The server (general) configuration settings can be found in the /etc/opt/axigen/axigen.cfg file. You can find more information about the settings available in this file in the General server configuration (axigen.cfg file) section. Sample configuration files for domains and accounts can be found in the /opt/axigen/share/examples/ directory. Read more information about the settings available for domains and accounts in the Configuring domains in AXIGEN and Configuring accounts in AXIGEN sections of this document. General server configuration (axigen.cfg file) The axigen.cfg file includes the complete specifications for AXIGEN configuration. Besides containing configuration data specific for AXIGEN modules, axigen.cfg is also used for specifying the primary domain for AXIGEN server (primarydomain), and the path for the socket used for handling domains and accounts via the provisioner tool. Restrictions When working with axigen.cfg file, please follow the restrictions listed below: maximum attribute name length: 64 maximum attribute value length: 128 (expressed as string in configuration file). Each STRING value is limited to this length, 255 Note: Each time you modify the main configuration file, a reload signal must be sent to AXIGEN, in order to load the new configuration settings. Definitions When working with axigen.cfg file: UINT - unsigned integer STRING - case insensitive string, eventually quoted using double quotes CS_STRING - case sensitive string, eventually quoted using double quotes IP - a IPv4 address in decimal numbers-and-dots format, i.e.: IP_SET - a set for IPv4 addresses specified in one of the following modes: 1. IP interval IP address/ip mask / IP address/ip mask size /8 IP_PORT - a IPv4 address in decimal numbers-and-dots format followed by a ":" char and a decimal port number, i.e.: :25 CHOICE - a single STRING from a specified set of STRINGs, i.e.: "yes" from ("yes" "no") set CHOICE-SET - means a subset of STRINGs from the specified set of STRINGs; the subset must be specified between round parentheses () 24

25 Server-related settings The following parameters are used for configuring different server-related settings in AXIGEN. Parameters services Parameter used for specifying the services AXIGEN is allowed to run. Type: CHOICE-SET (smtpincoming processing smtpoutgoing imap pop3 log webmail report) Default value: (smtp processing imap pop3 log webmail report) services = (smtp processing imap pop3 log webmail report) Note: Use 'smtp' instead of 'smtpincoming smtpoutgoing' to run both SMTP services. primarydomain Parameter used for specifying the primary domain for AXIGEN. If this parameter is not set, its value is obtained automatically by calling the standard getdomainname() function. Type: STRING Default value: CALLTO getdomainname() primarydomain = localdomain provisionsocket Parameter used for specifying the local socket where the provision service accepts commands. Type: CS_STRING Default value: "/var/opt/axigen/run/.provision" provisionsocket = "/var/opt/axigen/run/.provision" domaindata Parameter used for specifying the Domain database(s) location(s). Type: CS_STRING set Default value: ( "/var/opt/axigen/domains" ) domaindata = ( "/var/opt/axigen/domains" ) 25

26 Settings related to SMTP Incoming module The AXIGEN SMTP Incoming module is responsible with accepting connections initiated by other entities via SMTP/ESMTP protocols. This module includes functions such as configurable listeners (as described in the IP rules and Example of a listener configuration sections of this User Manual), thread and client management, user authentication and a built-in SPF authentication procedure. This SPF authentication feature can be enabled/disables using the 'spfenabled' environment variable (see the corresponding SMTP Incoming authentication section in this User Manual for more details). AXIGEN SMTP Incoming establishes the dialogue, receives the mail message if all conditions set by the System Administrator are fulfilled and forwards the mail message to the Processing module. The SMTP Incoming module is compliant with ESMTP RFCs, therefore presenting the corresponding features. This module has not only the role of receiving the mail messages from other entities, but also to protect the Mail Server against attacks and ensure a good functionality adjusted to the processing power of the hardware, the bandwidth, and other factors. In order to ensure this, the module has a number of attributes managing connectivity. The logs are sent to AXIGEN LOG Server (that might be running on another machine) or to the System Log, according to the specified Log type and Log level. In many mailservers, the filters (such as AntiVirus, AntiSpam, Billing applications or customer designed filters) are applied in only one spot along the Processing flow, usually in the queue. In AXIGEN, the filters may be applied to the queue, at the Processing level, but also at the SMTP Incoming 1 level, thus ensuring an increased efficiency: the mail messages rejected by filters will never reach the queue, the "busiest" mail server entity. 1 This feature is not available in the current beta version. 26

27 The SMTP Incoming module accepts connections as specified by the SMTP listeners defined in configuration file, receives the message, applies the filter and places the message in the Queue. By default the server accepts connections on :25. Connection Error Control In order to protect the server, the system administrator can limit the number of failed/wrong commands that can be received from SMTP clients during one session. This way, incomplete connections or connections that are not RFC compliant are dropped and the corresponding messages are not accepted, thus freeing important bandwidth. You can limit the number of authentication errors allowed for one SMTP client per session by using the maxautherrors parameter. If this limit is exceeded, AXIGEN server drops the connection with that SMTP client. You can limit the number of errors allowed for one SMTP client per session by using the maxerrors parameter. If this limit is exceeded, AXIGEN server drops the connection with that SMTP client. Important: If you do not specify a limit for the maximum number of (authentication) errors allowed for a SMTP client's session, security risks may arise. Parameters maxerrors Parameter used for specifying the maximum number of wrong commands that can be received from a SMTP client during one session. Type: UINT Accepted values: Default value: 20 maxerrors = 20 Note: The value "0" is accepted and its meaning is "unlimited". maxautherrors Parameter used for specifying the maximum number of failed authentications allowed during one session. Type: UINT Accepted values: Default value: 5 maxautherrors = 5 Note: The value "0" is accepted and its meaning is "unlimited". 27

28 Connection Thread Control AXIGEN can run on a large variety of systems and machines, in networks with very different traffic loads, structures, domain configurations, user rights, authorization procedures, etc. Depending on your specific network specifications and conditions, you can adapt the workload to the server's processing power, in order to prevent a system overload (with maxconnthreads) or to improve the server's performance (with minconnthreads). These two complementary parameters define the interval for the number of threads that are opened at any given moment by AXIGEN SMTP Incoming module. With maxconnthreads you can set the maximum number of threads that can be opened at a specific moment of time, in order to manage the server connections. This is important because by setting an adequate maximum number of threads that can be opened simultaneously at any given moment, the system administrator can easily avoid a system overload. With minconnthreads you can set the minimum number of threads that can be opened at a specific moment of time. This is important because even when there is no activity for AXIGEN server, you must be alert: a burst of new messages, i.e. a large workload, can arrive at any moment. With some threads already in "waiting" status (the number of threads is specified by minconnthreads), this burst can be processed automatically and in good conditions, without delays. Parameters maxconnthreads Parameter used for specifying the maximum number of threads handling the SMTP Incoming service's connections. Type: UINT Accepted values: Default value: 20 maxconnthreads = 20 minconnthreads Parameter used for specifying the minimum number of threads handling the SMTP service's connections. Type: UINT Accepted values: Default value: 2 minconnthreads = 2 28

29 Log Control Just like all the other AXIGEN main services, the SMTP Incoming module can log different types of events. The system administrator can specify what events are logged, where and how they are logged. A detailed explanation of the configuration options available for log management is available in the Log Service section of this User Manual. The SMTP Incoming's Log Control function can be configured using the following three attributes: loglevel, logtype and loghost. The loglevel parameter is used for configuring the service logging level. In AXIGEN, the events are organized in 6 categories and you can select which category of events to collect. AXIGEN modules must define the "loglevel" parameter. In order to specify the desired sets of events to log you have to specify the correspondent log levels or a combination of thereof. The loglevels in AXIGEN are: 0: no messages are logged 1: log critical messages 2: log errors 4: log warnings 8: log informative messages 16: log protocol communication For more information about logging format, mask, etc., please consult the Log Service section of this User Manual. The logtype parameter is used for configuring the service logging type. The system administrator can choose to log the information: internal (inside the same AXIGEN session), system (use the system's syslog) and remote (into a different AXIGEN session, running the log service). The loghost parameter is used for specifying the service's remote logging host when logtype is set to "remote". Important: If the service is logging a set of events (i.e. loglevel =15), these events will be logged on AXIGEN Log server only if the log server is configured to accept this set of events - in other words, only if the server's loglevel includes these categories. Parameters loglevel Use this parameter for specifying the service's logging level. Type: UINT Accepted values: 0-31 Default value: 15 loglevel = 15 29

30 logtype Use this parameter for specifying the service's logging type. Type: CHOICE internal system remote Default value: internal logtype = internal loghost Use this parameter for specifying the service's remote logging host (used only if logtype=remote). Type: IP_PORT - only valid host IP addresses. Default value: :2000 loghost = :

31 Authentication AXIGEN server offers several different methods for protecting user privacy and preventing non-desirable actions, such as spam, attacks, viruses, worms, etc. Besides using filters (see Settings related to Filters section in this User Manual) or listeners (see About Listeners section in this User Manual) with corresponding IP and TCP rules, another method for preventing non-desirable actions is granting access to AXIGEN server's SMTP Incoming features only for authenticated users. Note: AXIGEN server supports authentication, meaning it can be instructed to accept only connections/messages from authenticated entities. However, not all mail clients support this feature. If your mail client does not support SMTP authentication, this feature will not be available. The SMTP Incoming authentication process can be executed in plain text (the username and password are sent to AXIGEN server in "base64" format; the server only accepts users correctly defined in account storage and that supply the corresponding passwords) or using CRAM MD5 (same data is provided, this time using the MD5 coding format). Below you can find a short explanation on the procedure for choosing the authentication method in AXIGEN's SMTP Incoming. From the list supplied by the client as answer to EHLO command, one of the CRAM- MD5, LOGIN and PLAIN methods is chosen (in this order). In case the CRAM-MD5 or LOGIN method is selected, if an error after the AUTH command occurs, AXIGEN tries to use one of the other methods supplied by the server. Parameters allowstarttls Use this parameter for specifying if AXIGEN server should allow secure connections or not. Type: CHOICE (yes no). Default value: yes allowstarttls = yes secureconnauthtypes Use this parameter for specifying the type of authentication allowed on a secure (TLSenabled) connection. Possible options are: plain, login, cram-md5 and all). Default value is all (all types of authentication are allowed on a secure connection). Type: CHOICE-SET ( plain login cram-md5 all ) Default value: all 31

32 secureconnauthtypes = ( all ) plainconnauthtypes Use this parameter for specifying the type of authentication allowed on a plain (non- TLS-enabled) connection. Possible options are: plain, login, cram-md5 and all). Default value is cram-md5 (only a cram-md5 authentication is allowed on a plain connection) Type: CHOICE-SET ( plain login cram-md5 all ) Default value: all plainconnauthtypes = ( cram-md5 ) spfenabled Use this parameter for specifying if SPF (Sender Policy Framework) should be used for client authentication or not. Type: CHOICE (yes no) Default value: yes spfenabled = ( no ) Additional security features maxreceivedheaders Use this parameter for specifying the maximum number of Received: headers allowed for a mail message. If this maximum value is not respected, the mail message is considered looping and it is bounced. Type: UINT Accepted values: Default value: 30 maxreceivedheaders = 30 32

33 Client Management This feature is used for managing existing SMTP Incoming client connections, generated from different hosts, through different applications (like Outlook, Outlook Expres, Eudora, Mozilla Mail/Thunderbird). When a client connects to AXIGEN SMTP Incoming, it declares his identity (for instance EHLO yourcompanyname.com). In case the SPF function accepts this name, the SMTP Incoming machine will identify from now on that client by that specific name. If the SPF function does not accept this name, or no name is used by the client, the SMTP Incoming machine will identify from now on that client by its IP address. This name is afterwards searched for in the client list using the "pattern" attribute. The search is executed in ascending order, based on client's priority, and the first pattern with the highest priority is chosen. A lower value in priority therefore represents a higher priority. When an object of type "clients" is found, the rules specified for that object are applied. If no pattern matches the client's name, the attributes' default values are used. Parameters pattern Specify a pattern to be matched by the client name in order for AXIGEN to use this rule for establishing client rights and limitations for the defined hosts. Use this parameter to specify other domains (besides the PrimaryDomain and additional domains specified by the domains attribute) for which AXIGEN server accepts relaying mail messages. Type: REQUIRED CS_STRING Default value: "*" pattern = "*.axigen.com" priority Parameter used for specifying the client's priority for AXIGEN SMTP Incoming module. The search for client is executed in ascending order, based on client's priority, and the first name matching the pattern is chosen. A lower value in priority therefore represents a higher priority. Type: UINT Accepted values: Default value: 1 priority = 1 remotedelivery 33

34 Parameter used for specifying which client messages are allowed to be delivered by AXIGEN remote delivery service (relay). It can be one of 'all', 'none' or 'auth'. In the case of 'auth', only messages from authenticated users can be relayed. Type: CHOICE of (all none auth) Default value: auth remotedelivery = auth localdelivery Parameter used for specifying which client messages are allowed to be delivered to AXIGEN local domains (local delivery). It can be one of 'all', 'none' or 'auth'. In the case of 'auth', only messages from authenticated users can be delivered to local domains. Type: CHOICE of (all none auth) Default value: all localdelivery = all maxrcptcount Parameter used for specifying the maximum number of recipients for one mail message. When this limit is exceeded, AXIGEN server sends an error message to the mail client. Type: UINT Accepted values: Default value: 1000 maxrcptcount = 1000 maxdatasize Parameter used for specifying the maximum DATA size (in KB) for one mail message (includes the message itself and any eventual attachments). When this data size limit is exceeded, AXIGEN server gives up delivering the message and sends an error message to the SMTP client. Type: UINT Accepted values: Default value: (KB, i.e. 10 MB) maxdatasize =

35 Listener Control AXIGEN Mail Server can use different Listeners for its SMTP Incoming service. The usage of listeners is helpful for applying different apply/deny rules for AXIGEN services you are using. The Listeners for AXIGEN SMTP Incoming service are defined in the section from the configuration file corresponding to this TCP service. For more information, please consult the About Listeners section of this User Manual. 35

36 Settings related to Processing module The Processing module manages the mail messages in AXIGEN Queue, offering the system administrator information about mail message status, full control for filtering abilities (antivirus, antispam, custom made filters, Sieve scripts) on server, domain and user levels. This module receives mail messages from the SMTP Incoming and Webmail modules and delivers them to AXIGEN Storage (for local delivery) and to the SMTP Outgoing module (for external delivery). The Local Mail Delivery module ensures the placement of mail messages in the Message Storage. To test the Local Mail Delivery module, you can use the directories specified by messagestorages and accountstorages parameters from the domain configuration (domain.cfg). The directories are created automatically when the AXIGEN server is started, and the messagestorages and accountstorages parameters are automatically generated when a domain is generated. The Processing module decides if the mail message will be stored locally or will be sent for external delivery (in the latter case, the SMTP Outgoing module is called). If there are any delivery errors, the delivery module will re-schedule the mail for later delivery. If there are too many delivery failures (default value is 20), the server will give up on delivering the message and will send a failure notification to the sender. After each delivery attempt, the reschedule interval is calculated according to the formula presented in the Mail Scheduling section of this User Manual. 36

37 AXIGEN Processing module interacts with AXIGEN IMAP and Webmail modules: 1. the AXIGEN IMAP module uses the AXIGEN Processing module for Append operations executed on mailboxes; 2. the AXIGEN Webmail module uses the AXIGEN Processing module for Compose operations (after the message is composed, it is placed in AXIGEN Queue). The Queue The messages received from SMTP clients are stored in a queue that is processed by AXIGEN server according to specific rules. The system administrator can execute different operations on this queue, such as inspecting the queue, specifying/modifying the path where the queue is stored, modifying the number of subdirectories in the internal queue, etc. The queue is stored physically on several sub-folders. The numbers of these subfolders is specified in the configuration file, with the queueentrycount parameter. The mqview tool can be used to inspect the status of the files currently stored in AXIGEN s queue. Please refer to the Using mqview tool to view status message for files in queue section of this User Manual for instructions on using this tool. Note: Currently any change in the parameters specific to the Processing module needs a sever restart to become effective. Message statuses A message in a queue can have one of the following statuses: - Incoming: The message is currently being received. It has not been treated in either way by AXIGEN; - Received: The message has been received. No action has been taken on it yet. - Processing: Message processing is underway. - Processed: The message processing ended. The message processing could end successfully or not successfully. If the message is successfully processed, the next specific action (for instance delivery) specified for the message is carried out. If the message processing ends unsuccessfully, the message remains in Processed status. - Sending: The process of sending the message is underway. - Sent: The message has been sent. Mail Scheduling When a message can not be delivered by AXIGEN SMTP service for some non-critical reason, it can be re-scheduled, meaning AXIGEN server can try to re-send after some time interval is elapsed. You can adjust AXIGEN server's mail scheduling feature using the following three parameters: schedinterval, maxschedinterval and maxretrycount. Parameters schedinterval 37

38 Use this parameter for specifying the time interval (in seconds) for rescheduling a message in case of a non-critical delivery error. Type: UINT Accepted values: , must be smaller than maxschedinterval Default value: 3600 (1h) schedinterval = 3600 maxschedinterval Use this parameter for specifying the maximum time interval (in seconds) for rescheduling a message in case of a non-critical delivery error. Type: UINT Accepted values: Default value: (8h) maxschedinterval = maxretrycount Use this parameter for specifying the number of times AXIGEN server should try to deliver a mail message. Type: UINT Accepted values: Default value: 8 (2 days for the default values above) maxretrycount = 8 Note 1: The mail scheduling feature is only available if the reason for re-scheduling the message is non-critical, i.e. it does not automatically trigger the message being dropped by AXIGEN server (for instance due to its length exceeding the limit specified by the maxdatasize parameter). Note 2: The interval for rescheduling mail messages is calculated using the following formula: min(schedinterval * (2 ^ (retrycount - 1)), maxschedinterval) Inspecting the queue You can inspect the status of files currently stored in AXIGEN s queue by using the mqview tool. Please see the example below or refer to the Using mqview tool to view status message for files in queue section of this User Manual for instructions on using this tool. 38

39 Parameters queuepath Use this parameter for specifying the path to the internal server queue. If the string does not represent a valid path, the queue is not stored. By default, AXIGEN server queue is stored in /var/opt/axigen/queue. Type: CS_STRING Default value: /var/opt/axigen/queue queuepath = /var/opt/axigen/queue queueentrycount Use this parameter for specifying the upper limit for the number of subdirectories in the internal queue. The actual number is computed as maximum power of 2 smaller than 'queueentrycount' value. Type: UINT Accepted values: Default value: 64 queueentrycount = 64 Local delivery Parameters deliverythreads Use this parameter for specifying the number of threads handling local SMTP delivery. Type: UINT Accepted values: Default value: 20 deliverythreads = 20 Log Control Just like all the other AXIGEN main modules, the Processing module can log different types of events. The system administrator can specify what events are logged, where and how they are logged. A detailed explanation of the configuration options available for log management is available in the Log Service section of this User Manual. The Processing's Log Control function can be configured using the following three attributes: loglevel, logtype and loghost The loglevel parameter is used for configuring the service logging level. In AXIGEN the events are organized in 6 categories and you can select which category of events to collect. AXIGEN modules must define the "loglevel" parameter. In order to specify the 39

40 desired sets of events to log you have to specify the correspondent log levels or a combination of thereof. The loglevels in AXIGEN are: 0: no messages are logged 1: log critical messages 2: log errors 4: log warnings 8: log informative messages 16: log protocol communication For more information about logging format, mask, etc., please consult the Log Service section of this User Manual. The logtype parameter is used for configuring the service logging type. The system administrator can choose to log the information: internal (inside the same AXIGEN session), system (use the system's syslog) and remote (into a different AXIGEN session). The loghost parameter is used for specifying the service's remote logging host when logtype=remote. Important: If the service is logging a set of events (i.e. loglevel =15), these events will be logged on AXIGEN Log server only if the log server is configured to accept this set of events - in other words, only if the server's loglevel includes these categories. Parameters loglevel Use this parameter for specifying the service's logging level. Type: UINT Accepted values: 0-31 Default value: 15 loglevel = 15 logtype Use this parameter for specifying the service's logging type. Type: CHOICE internal system remote Default value: internal logtype = internal loghost Use this parameter for specifying the service's remote logging host (used only if logtype=remote). 40

41 Type: IP_PORT - only valid host IP addresses. Default value: :2000 loghost = :

42 Settings related to SMTP Outgoing module The SMTP Outgoing module is responsible for delivering mail messages to remote hosts. This module includes functions such as thread and client management. SMTP Outgoing is AXIGEN module taking care of sending messages directly to message's recipients. AXIGEN SMTP Outgoing is using DNR (Domain Name Resolver) for mapping domain names to IP addresses and includes complete rescheduling procedures. By default AXIGEN is configured not to allow open relaying. If AXIGEN fails to send messages to a specific domain because this domain was down for some time, when the domain is up again, the first message that goes successfully to that domain will queue also the rest of the pending messages from the queue and will force delivery of all messages. Connection Thread Control AXIGEN can run on a large variety of systems and machines, in networks with very different traffic loads, structures, domain configurations, user rights, authorization procedures, etc. Depending on your specific network specifications and conditions, you can adapt the workload to the server's processing power, in order to prevent a system overload (with maxconnthreads) or to improve the server's performance (with minconnthreads). These two complementary parameters define the interval for the number of threads that are opened at any given moment by AXIGEN SMTP Outgoing module. With maxconnthreads you can set the maximum number of threads that can be opened at a specific moment of time, in order to manage the server connections. This is important because by setting an adequate maximum number of threads that can be opened simultaneously at any given moment, the system administrator can easily avoid a system overload. With minconnthreads you can set the minimum number of threads that can be opened at a specific moment of time. This is important because even when there is no 42

43 activity for AXIGEN server, you must be alert: a burst of new messages, i.e. a large workload, can arrive at any moment. With some threads already in "waiting" status (the number of threads is specified by minconnthreads), this burst can be processed automatically and in good conditions, without delays. Parameters maxconnthreads Parameter used for specifying the maximum number of threads handling the SMTP Outgoing service's connections. Type: UINT Accepted values: Default value: 20 maxconnthreads = 20 minconnthreads Parameter used for specifying the minimum number of threads handling the SMTP Outgoing service's connections. Type: UINT Accepted values: Default value: 2 minconnthreads = 2 Log Control Just like all the other AXIGEN main modules, the SMTP Outgoing module can log different types of events. The system administrator can specify what events are logged, where and how they are logged. A detailed explanation of the configuration options available for log management is available in the Log Service section of this User Manual. The SMTP Outgoing's Log Control function can be configured using the following three attributes: loglevel, logtype and loghost. The loglevel parameter is used for configuring the service logging level. In AXIGEN the events are organized in 6 categories and you can select which category of events to collect. AXIGEN modules must define the "loglevel" parameter. In order to specify the desired sets of events to log you have to specify the correspondent log levels or a combination of thereof. The loglevels in AXIGEN are: 0: no messages are logged 1: log critical messages 2: log errors 4: log warnings 8: log informative messages 43

44 16: log protocol communication For more information about logging format, mask, etc., please consult the Log Service section of this User Manual. The logtype parameter is used for configuring the service logging type. The system administrator can choose to log the information: internal (inside the same AXIGEN session), system (use the system's syslog) and remote (into a different AXIGEN session). The loghost parameter is used for specifying the service's remote logging host when logtype=remote. Important: If the service is logging a set of events (i.e. loglevel =15), these events will be logged on AXIGEN Log server only if the log server is configured to accept this set of events - in other words, only if the server's loglevel includes these categories. Parameters loglevel Use this parameter for specifying the service's logging level. Type: UINT Accepted values: 0-31 Default value: 15 loglevel = 15 logtype Use this parameter for specifying the service's logging type. Type: CHOICE internal system remote Default value: internal logtype = internal loghost Use this parameter for specifying the service's remote logging host (used only if logtype=remote). Type: IP_PORT - only valid host IP addresses. Default value: :2000 loghost = :

45 Client Management Parameters This feature is used for managing existing SMTP Outgoing client connections. pattern Specify a pattern to be matched by the client name in order for AXIGEN to use this rule for establishing client rights and limitations for the defined hosts. Use this parameter to specify other domains (besides the PrimaryDomain and additional domains specified by the domains attribute) for which AXIGEN server accepts sending mail messages. Type: REQUIRED CS_STRING Default value: "*" pattern = "*.axigen.com" priority Parameter used for specifying the client's priority for AXIGEN SMTP Incoming module. The search for client is executed in ascending order, based on client's priority, and the first name matching the pattern is chosen. A lower value in priority therefore represents a higher priority. Type: UINT Accepted values: Default value: 500 priority = 1 authuser This parameter is only valid for mail clients supporting SMTP authentication and it specifies the account to be used for authentication when delivering the message. Type: CS_STRING Default value: "username" authuser = "username" authpass This parameter is only valid for mail clients supporting SMTP authentication and it specifies the password to be used for authentication when delivering the message. Type: CS_STRING Default value: "userpassword" authpass = "userpassword" 45

46 maxconnections Use this parameter for specifying the maximum connections to be used for reception on the remote host. By default, this parameter is set to 5. Type: UINT Accepted values: Default value: 5 maxconnections = 5 smtpport Use this parameter for specifying the port to be used for reception on the remote host. By default, the port 25 is used. Type: UINT Accepted values: Default value: 25 smtpport = 25 requestauth Use this parameter for specifying whether or not a successful authentication must be required or not before relaying mails to this client. By default, this option is disabled. Type: CHOICE (yes no) Default value: No requestauth = no secureconnauthtypes Use this parameter for specifying the type of authentication allowed on a secure (TLSenabled) connection. Possible options are: plain, login, cram-md5 and all). Default value is all (all types of authentication are allowed on a secure connection). Type: CHOICE-SET ( plain login cram-md5 all ) Default value: all secureconnauthtypes = ( all ) plainconnauthtypes Use this parameter for specifying the type of authentication allowed on a plain (non- TLS-enabled) connection. Possible options are: plain, login, cram-md5 and all). 46

47 Default value is cram-md5 (only a cram-md5 authentication is allowed on a plain connection) Type: CHOICE-SET ( plain login cram-md5 all ) Default value: all plainconnauthtypes = ( cram-md5 ) smtpip Use this parameter to force AXIGEN server to connect to this IP address when trying to deliver mail messages to this client; if this IP address is set to the host MX will be used. Type: IP address Default value: smtpip =

48 Settings related to POP3 module AXIGEN POP3 module establishes connections with POP clients and retrieves mail messages from the AXIGEN Storage. It allows you to use different allow/deny rules via listeners, as described in the IP rules and Example of a listener configuration sections of this User Manual. Different error and thread control, plus log procedures are available. The server accepts connections as specified by the POP3 listeners defined in the configuration file. By default the server accepts connections on :110. For primary domain and its aliases the POP3 clients may use both the local part from a user mail address or the entire mail address in order to access a mailbox. In AXIGEN, the POP3 module works as follows: shows only the messages that existed in the mailbox when the mailbox was opened keeps zombie copies for the messages deleted during the current session; the module shows them as messages of a zero size, and the module reports an error when a client application tries to retrieve a deleted message RETR command, the message is marked with the "Seen" flag (this change is noticed when using an IMAP or Webmail client). The POP3 module sends logs according to the log level set in the configuration file. 48

49 Note: The server only manages mail messages in AXIGEN Storage format. For more information on this format, please consult the AXIGEN Storage section in this User Manual. Connection Error Control In order to protect the server, the system administrator can limit the number of failed/wrong commands that can be received from a POP3 client during one session. This way, incomplete connections or connections that are not RFC compliant are dropped and the corresponding messages are not accepted, thus freeing important bandwidth. You can limit the number of authentication errors allowed for one POP3 client per session by using the maxautherrors parameter. If this limit is exceeded, AXIGEN server drops the connection with that POP3 client. You can limit the number of errors allowed for one POP3 client per session by using the maxerrors parameter. If this limit is exceeded, AXIGEN server drops the connection with that POP3 client. Note: If you do not specify a limit for the maximum number of (authentication) errors allowed for a POP3 client's session, security risks may arise. Parameters maxerrors Parameter used for specifying the maximum number of wrong commands that can be received from a POP3 client during one session. Type: UINT Accepted values: Default value: 20 maxerrors = 20 Note: The value "0" is accepted and its meaning is "unlimited". maxautherrors Parameter used for specifying the maximum number of failed authentications allowed during one session. Type: UINT Accepted values: Default value: 5 maxautherrors = 5 Note: The value "0" is accepted and its meaning is "unlimited". 49

50 Connection Thread Control AXIGEN can run on a large variety of systems and machines, in networks with very different traffic loads, structures, domain configurations, user rights, authorization procedures, etc. Depending on your specific network specifications and conditions, you can adapt the workload to the server's processing power, in order to prevent a system overload (with maxconnthreads) or to improve the server's performance (with minconnthreads). These two complementary parameters define the interval for the number of threads that are opened at any given moment by AXIGEN POP3 module. With maxconnthreads you can set the maximum number of threads that can be opened at a specific moment of time, in order to manage the server connections. This is important because by setting an adequate maximum number of threads that can be opened simultaneously at any given moment, the system administrator can easily avoid a system overload. With minconnthreads you can set the minimum number of threads that can be opened at a specific moment of time. This is important because even when there is no activity for AXIGEN server, you must be alert: a burst of new messages, i.e. a large workload, can arrive at any moment. With some threads already in "waiting" status (the number of threads is specified by minconnthreads), this burst can be processed automatically and in good conditions, without delays. Parameters maxconnthreads Parameter used for specifying the maximum number of threads handling the SMTP Incoming service's connections. Type: UINT Accepted values: Default value: 20 maxconnthreads = 20 minconnthreads Parameter used for specifying the minimum number of threads handling the SMTP service's connections. Type: UINT Accepted values: Default value: 2 minconnthreads = 2 50

51 Log Control Just like all the other AXIGEN main modules, the POP3 module can log different types of events. The system administrator can specify what events are logged, where and how they are logged. A detailed explanation of the configuration options available for log management is available in the Log Service section of this User Manual. The POP3 Log Control function can be configured using the following three attributes: loglevel, logtype and loghost. The loglevel parameter is used for configuring the service logging level. In AXIGEN the events are organized in 6 categories and you can select which category of events to collect. AXIGEN modules must define the "loglevel" parameter. In order to specify the desired sets of events to log you have to specify the correspondent log levels or a combination of thereof. The loglevels in AXIGEN are: 0: no messages are logged 1: log critical messages 2: log errors 4: log warnings 8: log informative messages 16: log protocol communication For more information about logging format, mask, etc., please consult the Log Service section of this User Manual. The logtype parameter is used for configuring the service logging type. The system administrator can choose to log the information: internal (inside the same AXIGEN session), system (use the system's syslog) and remote (into a different AXIGEN session). The loghost parameter is used for specifying the service's remote logging host when logtype=remote. Important: If the service is logging a set of events (i.e. loglevel =15), these events will be logged on AXIGEN Log server only if the log server is configured to accept this set of events - in other words, only if the server's loglevel includes these categories. Parameters loglevel Use this parameter for specifying the service's logging level. Type: UINT Accepted values: 0-31 Default value: 15 loglevel = 15 51

52 logtype Use this parameter for specifying the service's logging type. Type: CHOICE internal system remote Default value: internal logtype = internal loghost Use this parameter for specifying the service's remote logging host (used only if logtype=remote). Type: IP_PORT - only valid host IP addresses. Default value: :2000 loghost = :2000 Listener Control AXIGEN Mail Server can use different Listeners for its POP3 service. The usage of listeners is helpful for applying different apply/deny rules for AXIGEN services you are using. The Listeners for AXIGEN POP3 service are defined in the section from the configuration file corresponding to this TCP service. For more information, please consult the About Listeners section of this User Manual. 52

53 Settings related to IMAP module AXIGEN IMAP module establishes connections with IMAP clients and retrieves mail messages from AXIGEN Storage. AXIGEN IMAP module supports secure connections and allows usage of different allow/deny rules via listeners, as described in the IP rules and Example of a listener configuration sections of this User Manual. Different error control and log procedures are also available. Authentication The communication between AXIGEN IMAP module and the clients can be executed via either a secured connection or not 2. AXIGEN IMAP module can be configured to accept plain connections, secure (encrypted) connections or both. For each connection type, be it plain or secure, you can configure the IMAP module to authenticate incoming clients using: - plain text login (this option should be disabled for plain connections); - an authentication method (plain, login, cram-md5); or - both. 2 The IMAP authentication feature is not available in this beta version. 53

54 Parameters allowstarttls Use this parameter for specifying if AXIGEN server should allow secure connections or not. Type: CHOICE (yes no). Default value: yes allowstarttls = yes secureconnallowlogin Use this parameter for specifying if AXIGEN server should allow or not login with plain text on a secure (TLS-enabled) connection. Type: CHOICE (yes no). Default value: yes secureconnallowlogin = yes secureconnauthtypes Use this parameter for specifying the types of allowed authentication on a secure (TLSenabled) connection. Type: CHOICE-SET ( plain login cram-md5 all ) Default value: all secureconnauthtypes = ( all ) plainconnallowlogin Use this parameter for specifying if AXIGEN server should allow or not login with plain text on a plain (non-tls-enabled) connection. Type: CHOICE (yes no) Default value: no plainconnallowlogin = no plainconnauthtypes Use this parameter for specifying the types of allowed authentication on a plain (non- TLS-enabled) connection. Type: CHOICE-SET ( plain login cram-md5 all ) Default value: all plainconnauthtypes = ( cram-md5 ) 54

55 Connection Error Control In order to protect the server, the system administrator can limit the number of failed/wrong commands that can be received from an IMAP client during one session. This way, non-authenticated connections, idle connections or connections that are not RFC compliant are dropped, thus freeing system resources. You can limit the number of authentication errors allowed for one IMAP connection using the maxautherrors parameter. If this limit is exceeded, AXIGEN server drops the connection with that IMAP client. You can limit the number of errors (of all types) allowed for one IMAP connection using the maxerrors parameter. If this limit is exceeded, AXIGEN server drops the connection for that IMAP client. Note: If you do not specify a limit for the maximum number of (authentication) errors allowed for a IMAP connection, security risks may arise. Parameters maxerrors Parameter used for specifying the maximum number of wrong commands that can be received from an IMAP client during one session. Type: UINT Accepted values: Default value: 20 maxerrors = 20 Note: The value "0" is accepted and its meaning is "unlimited". maxautherrors Parameter used for specifying the maximum number of failed authentications allowed during one session. Type: UINT Accepted values: Default value: 5 maxautherrors = 5 Note: The value "0" is accepted and its meaning is "unlimited". 55

56 Connection Thread Control AXIGEN can run on a large variety of systems and machines, in networks with very different traffic loads, structures, domain configurations, user rights, authorization procedures, etc. Depending on your specific network specifications and conditions, you can adapt the workload to the server's processing power, in order to prevent a system overload (with maxconnthreads) or to improve the server's performance (with minconnthreads). These two complementary parameters define the interval for the number of threads that are opened at any given moment by AXIGEN IMAP module. With maxconnthreads you can set the maximum number of threads that can be opened at a specific moment of time, in order to manage the server connections. This is important because by setting an adequate maximum number of threads that can be opened simultaneously at any given moment, the system administrator can easily avoid a system overload. With minconnthreads you can set the minimum number of threads that can be opened at a specific moment of time. This is important because even when there is no activity for AXIGEN server, you must be alert: a burst of new messages, i.e. a large workload, can arrive at any moment. With some threads already in "waiting" status (the number of threads is specified by minconnthreads), this burst can be processed automatically and in good conditions, without delays. Parameters maxconnthreads Parameter used for specifying the maximum number of threads handling the SMTP Incoming service's connections. Type: UINT Accepted values: Default value: 20 maxconnthreads = 20 minconnthreads Parameter used for specifying the minimum number of threads handling the SMTP service's connections. Type: UINT Accepted values: Default value: 2 minconnthreads = 2 56

57 Log Control Just like all the other AXIGEN main modules, the IMAP module can log different types of events. The system administrator can specify what events are logged, where and how they are logged. A detailed explanation of the configuration options available for log management is available in the Log Service section of this User Manual. The IMAP's Log Control function can be configured using the following three attributes: loglevel, logtype and loghost. The loglevel parameter is used for configuring the service logging level. In AXIGEN the events are organized in 6 categories and you can select which category of events to collect. AXIGEN modules must define the "loglevel" parameter. In order to specify the desired sets of events to log you have to specify the correspondent log levels or a combination of thereof. The loglevels in AXIGEN are: 0: no messages are logged 1: log critical messages 2: log errors 4: log warnings 8: log informative messages 16: log protocol communication For more information about logging format, mask, etc., please consult the Log Service section of this User Manual. The logtype parameter is used for configuring the service logging type. The system administrator can choose to log the information: internal (inside the same AXIGEN session), system (use the system's syslog) and remote (into a different AXIGEN session). The loghost parameter is used for specifying the service's remote logging host when logtype=remote. Important: If the service is logging a set of events (i.e. loglevel =15), these events will be logged on AXIGEN Log server only if the log server is configured to accept this set of events - in other words, only if the server's loglevel includes these categories. Parameters loglevel Use this parameter for specifying the service's logging level. Type: UINT Accepted values: 0-31 Default value: 15 loglevel = 15 logtype 57

58 Use this parameter for specifying the service's logging type. Type: CHOICE internal system remote Default value: internal logtype = internal loghost Use this parameter for specifying the service's remote logging host (used only if logtype=remote). Type: IP_PORT - only valid host IP addresses. Default value: :2000 loghost = :2000 Listener Control AXIGEN Mail Server can use different Listeners for its IMAP service. The usage of listeners is helpful for applying different apply/deny rules for AXIGEN services you are using. The Listeners for AXIGEN IMAP service are defined in the section from the configuration file corresponding to this TCP service. For more information, please consult the About Listeners section of this User Manual. 58

59 Settings related to Webmail module AXIGEN Webmail module establishes connections with the corresponding mail clients via Web browsers, sends mail messages to and retrieves mail messages from the AXIGEN Storage. With this module the users can securely access their mailboxes from Internet browsers, while the system administrators are in complete control of the content, functionality and look of the web pages. Features Complex customization You can easily change the skin and behavior of AXIGEN Webmail module. For more information about how you can change the look and feel of your Web interface, please consult section Changing Webmail's look and feel. Easy to use, secure and user-friendly Features like tree structure for folders view, common actions applied on folders (rename, delete, move, create), built in HTTP server, etc. make AXIGEN Webmail easy to use, secure and user-friendly. 59

60 Server side scripting language Listeners The Webmail module implements a proprietary server side scripting language (called HSP) and it is used to generate HTML code. You can specify the location where these HSP files are stored using the path parameter, as described in the Path section of this User Manual. For more information about the HSP language structure, please refer to the Server-side scripting language section in this User Manual. In the corresponding configuration section you can activate different listeners for AXIGEN Webmail service. Read more in the Webmail Listeners control section of this User Manual. Compose while attach Using IFrame technology, AXIGEN server's Webmail service allows users to continue the Compose action while attaching files to their messages. Connection Thread Control AXIGEN can run on a large variety of systems and machines, in networks with very different traffic loads, structures, domain configurations, user rights, authorization procedures, etc. Depending on your specific network specifications and conditions, you can adapt the workload to the server's processing power, in order to prevent a system overload (with maxconnthreads) or to improve the server's performance (with minconnthreads). These two complementary parameters define the interval for the number of threads that are opened at any given moment by AXIGEN SMTP Incoming module. With maxconnthreads you can set the maximum number of threads that can be opened at a specific moment of time, in order to manage the server connections. This is important because by setting an adequate maximum number of threads that can be opened simultaneously at any given moment, the system administrator can easily avoid a system overload. With minconnthreads you can set the minimum number of threads that can be opened at a specific moment of time. This is important because even when there is no activity for AXIGEN server, you must be alert: a burst of new messages, i.e. a large workload, can arrive at any moment. With some threads already in "waiting" status (the number of threads is specified by minconnthreads), this burst can be processed automatically and in good conditions, without delays. Note: You can combine these settings related to the connection thread control with the settings related to the Webmail session control, explained in the Webmail session control section of this User Manual. Parameters maxconnthreads 60

61 Parameter used for specifying the maximum number of threads handling the SMTP Incoming service's connections. Type: UINT Accepted values: Default value: 20 maxconnthreads = 20 minconnthreads Parameter used for specifying the minimum number of threads handling the SMTP service's connections. Type: UINT Accepted values: Default value: 2 minconnthreads = 2 Log Control Just like all the other AXIGEN modules, the Webmail module can log different types of events. The system administrator can specify what events are logged, where and how they are logged. A detailed explanation of the configuration options available for log management is available in the Log Service section of this User Manual. The Webmail's Log Control function can be configured using the following three attributes: loglevel, logtype and loghost. The loglevel parameter is used for configuring the service logging level. In AXIGEN the events are organized in 6 categories and you can select which category of events to collect. AXIGEN modules must define the "loglevel" parameter. In order to specify the desired sets of events to log you have to specify the correspondent log levels or a combination of thereof. The loglevels in AXIGEN are: 0: no messages are logged 1: log critical messages 2: log errors 4: log warnings 8: log informative messages 16: log protocol communication For more information about logging format, mask, etc., please consult the Log Service section. The logtype parameter is used for configuring the service logging type. The system administrator can choose to log the information: internal (inside the same AXIGEN 61

62 session), system (use the system's syslog) and remote (into a different AXIGEN session). The loghost parameter is used for specifying the service's remote logging host when logtype=remote. Important: If the service is logging a set of events (i.e. loglevel =15), these events will be logged on AXIGEN Log server only if the log server is configured to accept this set of events - in other words, only if the server's loglevel includes these categories. Parameters loglevel Use this parameter for specifying the service's logging level. Type: UINT Accepted values: 0-31 Default value: 15 loglevel = 15 logtype Use this parameter for specifying the service's logging type. Type: CHOICE internal system remote Default value: internal logtype = internal loghost Use this parameter for specifying the service's remote logging host (used only if logtype=remote). Type: IP_PORT - only valid host IP addresses. Default value: :2000 loghost = :2000 Path The Webmail module implements a proprietary server side scripting language (called HSP) and it is used to generate HTML code. HSP is a proprietary format used for storing all information relevant for AXIGEN Webmail service. You can specify the location where these HSP files are stored using the path parameter. 62

63 Parameter For more information about the HSP language structure, please refer to the Server-side scripting language section in this User Manual. path Use this parameter for specifying the location of HSP files of the WebMail server. Type: CS_STRING. Default value: "/var/opt/axigen/webmail" path = /var/opt/axigen/webmail Webmail session control Use the following settings for specifying the maximum duration for a Webmail session and the maximum duration for a Webmail idle session. Parameters sessionidletimeout Use this parameter for specifying after how many seconds an idle Webmail session is closed. Type: UINT Accepted values: Default value: 900 sessionidletimeout = 900 Note: The value "0" is accepted and its meaning is "unlimited". sessionactivitytimeout Use this parameter for specifying after how many seconds a Webmail session is closed, even if activity exists. Type: UINT Accepted values: Default value: sessionactivitytimeout = Note: The value "0" is accepted and its meaning is "unlimited". Listener Control AXIGEN Mail Server can use different Listeners for its Webmail service. The usage of listeners is helpful for applying different apply/deny rules for AXIGEN services you are using. 63

64 The Listeners for AXIGEN Webmail service are defined in the section from the configuration file corresponding to this TCP service. For more information, please consult the About Listeners section of this User Manual. Server-side scripting language AXIGEN Webmail module implements a proprietary server side scripting language (called HSP) and it is used to generate HTML code. You can find relevant information for programmers trying to extend the current HSP abilities in the document called AXIGEN server side scripting language. Changing Webmail look and feel You can change the look and feel of AXIGEN Webmail module using the corresponding sections from the domain.cfg and account.cfg files. In the domain.cfg file you can: - change the skin used by AXIGEN Webmail module (please note this option is not available in this beta version); - change the number of mail messages displayed on a page by AXIGEN Webmail module, by changing the value for the pagesize parameter; - configure AXIGEN Webmail to request a confirmation before deleting a mail message; - configure AXIGEN Webmail to request a confirmation before emptying a folder in AXIGEN Webmail module; - specify whether you want to keep or not a copy of the mail sent into "Sent" folder; - specify whether the execution of the Delete action will move the mail message into "Trash" folder (when deletetotrash = yes) or directly delete it (when deletetotrash = no); For more details, please read the Create/Changing accounts and domains in AXIGEN section in this User Manual. 64

65 Settings related to DNR (Domain Name Resolver) The Domain Name Resolver (DNR) module is used by AXIGEN services in order to extract information from domain servers. The module implements the specifications from RFC1034 and RFC1035. It communicates with domain name servers using UDP sockets on port 53. AXIGEN modules using DNR: The SMTP Incoming service uses DNR for performing the SPF tests (this action involves PTR and TXT queries). The SMTP outgoing service queries DNR for MX and A information about the domain where to relay the mail messages. General Attributes DNR needs to be initialized with a list of name server IP addresses which will be used as base for executing the DNS queries if the DNR's internal cache does not contain information about name servers of the domain searched. You can specify the addresses for the name servers by using the 'nameservers' attribute. This will make DNR to send queries to first IP and in case of error it will send the same query to the next IP addresses until end of list. The procedure repeats in case of error as many times as specified by the 'retries' parameter. For every DNS query the DNR module waits maximum 'timeout' seconds for a response before making a new query to the next name server or before returning a general DNR TIMEOUT error. The timeout after each retry is calculated according to the formula presented in the Mail Scheduling section of this User Manual. The module queries name servers for information of type A, NS, MX, PTR and TXT and it can maintain a cache with this information in order to limit the bandwidth and time consumed with DNS traffic. For each query type (A, NS, MX, PTR, TXT) it caches 'cachesize' number of responses. 65

66 Settings related to Log service Log service is a special AXIGEN service responsible with collecting events relevant for the System Administrator. AXIGEN Log service can log internal data coming from other AXIGEN modules/services or data coming from the UDP port 2000 (default option). This data can be logged in the same location or in different locations for separate services, depending on the configuration applied by the system administrator. AXIGEN main modules must define the log type to be used by that specific module. The definition is executed via the "logtype" parameter, that can have any of the following three values : "internal", "remote" or "system" log. A detailed explanation for each of these log types is supplied below. For AXIGEN Log service, you can also specify the following information: - on what address the Log listener should be listening (see the Log Listener section for more information); - what hosts should be rejected by the Log service (using denyrules, a priority and an enable/disable switch); - what hosts should be accepted by the Log service (using acceptrules, a priority and an enable/disable switch). AXIGEN log types AXIGEN modules should define the log type using the "logtype" parameter, that can have any single values from the following three: - "internal", - "remote" or - "system" log. "internal" will send events to the Log Service running on the same AXIGEN server. The Server should have the Log Service activated. "remote" will send events to a Log Service running in another AXIGEN server, remotely, at the address specified using the "hostname" attribute. This AXIGEN Server must have the Log Service activated. "system" will send events to the syslog (for instance sysklogd in Linux) with facility "LOG_MAIL" and levels mapped as: 0 - no message sent 1 - LOG_CRIT 2 - LOG_ERR 4 - LOG_WARNING 8 - LOG_INFO 16 - LOG_DEBUG Logging format The format used for data logging is the following: 'date hostname modulename:sessionid: user_message\n' 66

67 Actions AXIGEN Log service then transforms this data in a format similar to the one described below: 'date loglevel hostname modulename:sessionid: user_message\n' :08: johnd-l SMTP: : connection accepted from [ ] loglevel = hostname = 'yourcompany.com' this is the result of the standard 'hostname' command modulename = 'SMTP' other accepted values are : pop3, imap, webmail, relay, processing sessionid this is an UINT value written in hexa incremented separately for each connection of a protocol (for the processing module, as there is no relevant protocol, the value is currently 0; future version will provide however as value the ID of the message in the working queue. loglevel is a 5 bits mask for the following values: LOG_none = 0x00, /// critical LOG_crit = 0x01, /// errors LOG_err = 0x02, /// warnings LOG_warn = 0x04, /// information LOG_info = 0x08, /// log protocol communication LOG_proto = 0x10, If you set loglevel=15 = the information logged will be critical_errors+errors+warnings+information If you set loglevel = 0 the data for that specific service will not be logged by AXIGEN Log service. A log action specifies the information to be stored in the log lines. If multiple actions are defined, they can be referenced using their names. You can define a maximum of 64 different actions for each log. The set defining a log action includes: 67

68 Rules - the name of the action (to be referred by 'rules') - the name of the destination file - the maximum size of the destination file in KB - the maximum duration the destination file is used in seconds - the maximum number of old files (saved) to be kept Multiple log rules can be defined and they are associated with a modulename, logtype, hostname and a log level. A rule can execute only one action. An ordered list is created with all log rules configurations using the 'priority' parameters as ordering key. The Log Service iterates the log rules list and executes only the first matched log rule's action. You can define the Log rules at the AXIGEN main module's level, in the corresponding sections of the configuration file. The Log Service will check if the information sent by the modules is the information that is supposed to receive, according to the Log Service configuration. A log rules set includes the following information: - the rule's priority ("1" means the rule has the highest priority possible) - the hostname of the user of this rule - the module of the user of this rule - the level of log generated by the user of this log (see a detailed explanation below) - the action name used by the rule AXIGEN Log levels In AXIGEN the events are organized in 6 categories and you can select which category of events to collect. AXIGEN modules must define the "loglevel" parameter. In order to specify the desired sets of events to log you have to specify the correspondent log levels or a combination of thereof. The loglevels in AXIGEN are: 0: no messages are logged 1: log critical messages 2: log errors 4: log warnings 8: log informative messages 16: log protocol communication Therefore the accepted values for the loglevel parameter are between 0 and 31. in order to log critical messages (log level 1) and informative messages (log level 8) you define log level 9 (the sum of 1 and 8). 68

69 rules = ( priority = 100 hostname = * module = * loglevel = 15 action = default Attributes of the Log service AXIGEN Log service can log internal data coming from other modules/services or data coming from the UDP port 2000 (default value). This data can be logged in the same location or in different locations for separate services, depending on the configuration applied by system administrator. AXIGEN main modules must define the log type to be used by that specific module. The definition is executed via the "logtype" parameter, that can have any of the following three values : "internal", "remote" or "system" log. A detailed explanation for each of these log types is supplied in the Log Service general section. The value for the loglevel parameter from the log clients (the services sending information for logging to AXIGEN Log service) specifies for themselves the log levels sent for the Log service. The value for the loglevel parameter from the log service's rule specifies the log levels accepted by the service from clients. Therefore if: clientlevel = 15 and rulelevel = 9 the Log service will only log the lines on level 9 (critical+information), even if the information retrieved from client also contains errors and warnings (this information is ignored). Listeners for AXIGEN Log service AXIGEN Log service is an UDP (User Datagram Protocol - see RFC 768 for more information) service. Therefore, there are some functional differences between the Log listeners and the listeners for other (TCP-based) AXIGEN services. You can define the 'listeners' attribute for the Log service is of 'IpListener' OBJECT- SET type (meaning a set of 'IpListener' class objects) in the corresponding section of the configuration file. An 'IpListener' object is similar to a 'TcpListener' object, but it does not contain any limitations related to connections (as there are no connections in UDP). Note: The 'allowrules' attribute is of type 'IpRules' OBJECT-SET (and not 'TcpAllowRules' OBJECT-SET, as for an 'TcpListener' object), because you cannot limit the process of accepting connections, as long as there are no connections under UDP. Below you can find a scheme for a quick understanding of the Log listeners: (here ':' can be translated by 'of type'): 69

70 - TCP service: 'listeners' : 'TcpListener' OBJECT-SET 'allowrules' : 'TcpAllowRule' OBJECT-SET 'denyrules' : 'IpRule' OBJECT-SET - LOG service: 'listeners' : 'IpListener' OBJECT-SET 'allowrules' : 'IpRule' OBJECT-SET 'denyrules' : 'IpRule' OBJECT-SET Note: Currently the 'allowrules' and 'denyrules' attributes are not functional for the Log service's listeners. Therefore, specifying such rules will be considered in the configuration file, but it will not affect the functioning of the Log service. 70

71 Settings related to Filters In order to increase security, you can apply different filters at different levels in AXIGEN. The advanced filtering system ensures an in-depth control over the incoming and outgoing mail traffic. In AXIGEN, you can define filtering rules at three levels (server level, domain level and user level) allowing maximum flexibility in defining what messages should be scanned, what filters should be used, the order in which these filters are applied and the actions taken according to the results of the scanning process. The filters can be applied both for incoming and for outgoing traffic. A Filtering System may consist of one external filter or a series of external filters, including AntiVirus, AntiSpam, other customizable filter and Sieve filters. 71

72 A Filtering System can be applied three levels: server, domain and/or user level, as shown in the picture below. From a functional point of view, the filtering actions are applied at the Processing module level, where the entity responsible with managing filter's actions is the so-called "Shepherd". The Shepherd will consider the configuration settings (applied on all mails, on selected domains or even specified users) and based on this information will send each mail message to the correspondent filter or filters for scanning, taking care not to scan the same mail message twice using the same filter. The Shepherd will also perform other security and efficiency checks. You must configure in each external filter the actions to be taken by that filter during scanning process. Important: The filters can be specified in the configuration files containing a list of filters per domain (and NOT per user). Specific Filters Currently AXIGEN works with specific filters like: CLAM AntiVirus, Spam Assassin, Sieve. 72