// \file SNFMilterConfig.hpp // // Copyright (C) 2011 ARM Research Labs, LLC. // See www.armresearch.com for the copyright terms. // // This file defines the SNFMilterConfig interface. // // $Id$ // /////////////////////////////////////////////////////////////////////////////////////////////////// #ifndef SNFMilterConfighpp_included #define SNFMilterConfighpp_included #include #include "UtilityConfig.hpp" #include "PostfixIntegrate.hpp" /// Class to manage the SNFMilter configuration. // // This class creates/maintains the sniffer configuration file, and // integrates/unintegrates with MTAs. // ////////////////////////////////////////////////////////////////////////////////////////////////////////// class SNFMilterConfig : public UtilityConfig { public: /// Command specified. enum CommandEnum { SetupRepairCommand, ///< Setup or repair the configuration. UpdateCredentialsCommand, ///< Update the credentials. IntegrateWithPostfixCommand, ///< Integrate with postfix. IntegrateWithSendmailCommand, ///< Integrate with sendmail. IntegrateWithNoneCommand, ///< Unintegrate with all supported MTAs. StartSnifferCommand, ///< Start the Sniffer. StopSnifferCommand, ///< Stop the Sniffer. NoCommand, ///< No command specified. UnknownCommand ///< Unknown. }; /// Display usage. // // \param[in] Version is the SNFMilter version. // void DisplayHelp(std::string Version); /// Get the command-line input parameters for SNFMilter. // // \param[in] argc is the number of parameters. // // \param[in] argv is the parameters. // // \returns true if all the required command line parameters are // present and there are no unknown command-line parameters, false // otherwise. // bool GetCommandLineInput(int argc, char* argv[]); /// Execute the command specified by the command-line parameters. // void ExecuteCommand(void); /// Save the state of all files that might be changed, except the /// config file. // void SaveFileState(void); // OBSOLETE. /// Execute the command to integrate/unintegrate with the MTAs. void DoIntegrationCommand(); private: /// Load the socket info (file name) from the section /// of the loaded config file. void LoadSocketInfo(); /// Setup/repair the directory containing the milter socket. // // This method ensures that the directore to contain the milter // socket exists and has the correct owner and permissions. void SetupRepairSocketDir(); PostfixIntegrate Postfix; ///< Postfix integration object. /// Unintegrate with MTAs. // // Unintegrate with all MTAs except the specified MTA. // // \param[in] Except is the MTA to not integrate with. The // acceptable values are: // //
    //
  1. "postfix"
  2. //
  3. ""
  4. //
// // The default value is "", which specifies unintegration with all // MTAs. // void UnintegrateWithAllExcept(std::string Except = ""); CommandEnum Command; ///< Specified command. static const std::string DefaultConfigFile; ///< Default config file. static const std::string SampleConfigFile; ///< Sample config file. static const std::string SampleIdentityFile; ///< Sample identity file. static const std::string ApplicationName; ///< Application name. std::string SocketFileName; }; #endif