HTTP mode configuration file

March 5, 2024

ID 184799

The HTTP mode configuration file (hereinafter, also configuration file) is an XML file that specifies general settings for Kaspersky Scan Engine.

HTTP mode configuration file (Linux)

The Kaspersky Scan Engine distribution kit for Linux contains a %distr_kit%/etc/kavhttpd.xml configuration file.

After installing Kaspersky Scan Engine, you can copy kavhttpd.xml to your preferred location:

  • If you copy kavhttpd.xml to the /etc/ directory, Kaspersky Scan Engine automatically finds and parses this file.
  • If you copy kavhttpd.xml to a different location, you must set the path to this location when you start Kaspersky Scan Engine:

HTTP mode configuration file (Windows)

The Kaspersky Scan Engine distribution kit for Windows contains a %distr_kit%\bin\kavhttpd.xml configuration file.

We recommend specifying full paths to files in kavhttpd.xml. In particular, it is strongly recommended to specify the full paths to the certificate (the TlsCertificateFile element) and the key file (the TlsCertificateKeyFile element).

Parameters of the HTTP mode configuration file

Most elements of the configuration file have default values that are used when the element is absent. Elements that are present in the configuration file must not be empty, unless stated otherwise.

KAV HTTPD configuration file contains the following parent elements:

Structure of the configuration file

Following is an example of the HTTP mode configuration file.

<Configuration>

 

<ServerSettings>

<ConnectionString>/tmp/.kavhttpd</ConnectionString>

<MaxIncomingConnectionsNum>100</MaxIncomingConnectionsNum>

<MaxHTTPSessionsNum>50</MaxHTTPSessionsNum>

<MaxTCPFileSize>100</MaxTCPFileSize>

<SessionTimeout>1000</SessionTimeout>

<Flags>KAV_SHT_ENGINE_KSN | KAV_SHT_ENGINE_APUF</Flags>

<TlsCertificateKeyFile>opt/kaspersky/http_data/https_key.pem</TlsCertificateKeyFile>

<TlsCertificateFile>opt/kaspersky/http_data/https_cert.crt</TlsCertificateFile>

<CORS>

<AccessControlAllowOrigin>https://example.com</AccessControlAllowOrigin>

<AccessControlAllowOrigin>https://kaspersky.ru</AccessControlAllowOrigin>

</CORS>

<KeepAliveSettings>

<Enabled>1</Enabled>

<TimeoutMs>5000</TimeoutMs>

<MaxRequests>1000</MaxRequests>

</KeepAliveSettings>

<AuthSettings>

<UseAccessToken>0</UseAccessToken> <!--Enable or disable API-token authentication -->

<AuthRequestField>Authorization</AuthRequestField>

<UseBearerAuthScheme>1</UseBearerAuthScheme>

<AccessTokens>

<Token>

<Name>Unlimited key</Name>

<Value>JWXA529CU2q7Udv7r3ji6BEMsha-5yu0KqU3yvKtf-6I+TU2AEQACKAABIgpEIIM</Value>

<Description>Kaspersky Scan Engine Clients. Full access scope</Description>

<Enabled>1</Enabled>

</Token>

<Token>

<Name>Key for URL-scanning</Name>

<Value>MIIEpgIBAAKCAQEA2UT+I6-ftKvy3UqK0uy5-ahsMEB6ij3r7vdU7q2UC925AXWJ</Value>

<Description>Server access key. Only URL-scanning</Description>

<Enabled>0</Enabled>

</Token>

</AccessTokens>

</AuthSettings>

</ServerSettings>

 

<KSNSettings>

<UrlCheckTimeoutMs>20000</UrlCheckTimeoutMs>

<ObjectCheckOnDemandTimeoutMs>10000</ObjectCheckOnDemandTimeoutMs>

<CacheSizeKb>30720</CacheSizeKb>

</KSNSettings>

 

<KAVScanningSettings>

<ScannersCount>4</ScannersCount>

<ThreadsCount>8</ThreadsCount>

<QueueLen>1024</QueueLen>

<Flags>KAV_O_M_PACKED | KAV_O_M_ARCHIVED | KAV_O_M_MAILBASES | KAV_O_M_MAILPLAIN | KAV_O_M_HEURISTIC_LEVEL_DETAIL</Flags>

<Mode>KAV_SKIP</Mode>

<MaxArchivesScanningDepth>0</MaxArchivesScanningDepth>

</KAVScanningSettings>

 

<DirectorySettings>

<BasesPath>/home/bases</BasesPath>

<TempPath>/home/temp</TempPath>

<LicensePath>/home/license</LicensePath>

<LicensingMode>1</LicensingMode>

<ScanningPaths>

<ScanningPath></ScanningPath>

</ScanningPaths>

</DirectorySettings>

 

<UseHTTPProxy>1</UseHTTPProxy>

 

<HTTPProxy>

<url>myproxy.mycompany.com</url>

<port>3128</port>

<user>doOTrypDTxpVJxUHYeKQTw==</user>

<pass>8mSHXFix3uL+RP9oNeKDZQ==</pass>

</HTTPProxy>

 

<UpdateSettings>

<DisableBackup>0</DisableBackup>

<UpdatePeriodMinutes>0</UpdatePeriodMinutes>

<UseOnlyCustomSources>0</UseOnlyCustomSources>

<UpdateSources>

<Source>[update source]</Source>

</UpdateSources>

<UpdatesCertFile></UpdatesCertFile>

<CertificateConfirmationAction>0</CertificateConfirmationAction>

<UseReducedBases>0</UseReducedBases>

</UpdateSettings>

 

<FormatRecognizerSettings>

<FormatsToSkipScanning>

<KAV_FF_GENERAL_TXT/>

<KAV_FF_GENERAL_CSV/>

<KAV_FF_AUDIO_WMA/>

</FormatsToSkipScanning>

</FormatRecognizerSettings>

 

</Configuration>

Did you find this article helpful?
What can we do better?
Thank you for your feedback! You're helping us improve.
Thank you for your feedback! You're helping us improve.