Jive Antivirus Extension Administrator's Guide for 5.0 and earlier

    This document will serve as the Administrator's Guide for the Jive Antivirus Extension for 5.0 and earlier.

     

    Installation

     

    Artifacts

    The Jive Antivirus Extension is delivered in a .jar file that is installed on an existing Jive instance.  The name of the file will depend on the version of the plugin (e.g. virus-scan-plugin-5.0.3.0-1.jar).  The version number of will generally correspond to the version of Jive for which it was intended, with the -X suffix indicating the release number (0-based) for that version.  For example, 5.0.3.0-1 indicates the second release of the extension for Jive 5.0.3.0.  To be sure you have the most recent release of the extension for your version of Jive, consult the Jive Antivirus Extension Compatibility Matrix, which will contain the recommended releases for each Jive version.

     

    Virus Scan Server

    The Antivirus Extension requires a virus scan server to perform the actual virus scanning.  The Antivirus Extension supports ClamAV, which is freely available, and McAfee products with ICAP support such as McAfee Web Gateway | McAfee Products.  For hosted customers, Jive Hosting provides a ClamAV server.  On-premise customers must provide their own virus scan server.  Installation and configuration of the virus scan server is outside of the scope of this document.  Please refer to the ClamAV documentation or McAfee Product Support.

     

    McAfee Configuration

    A security policy may need to be created to add the X-Infection-Found header to the ICAP response.

     

    Licensing

    While the Antivirus Extension is available for anyone to download, you must have a valid license to run it on your instance.  You can check your license in your Jive instance's Admin Console, under the System > Management > License Information section.

     

    Screen Shot 2012-06-11 at 7.59.21 PM.png

     

    If you see the Antivirus Module entry listed in the License Components and Allotments section, you are all set to install the Antivirus Extension.  The extension itself may still be installed if it has not been licensed on your instance, but no Antivirus functionality will be enabled.  If the module is not listed, but you have purchased the Antivirus Extension, file a case requesting Jive Account Support to update your license.  If you have not purchased the Antivirus Extension yet, please contact Jive Sales.

     

    For Hosted Customers

    To install the Antivirus Extension, hosted customers need only file a case and request that the extension be installed.  Jive Account Support will install the extension for you.  Installation only takes a few minutes, but will require a server restart.  Jive Account Support will configure the extension for the appropriate Virus Scan server based on the data center in which your instance resides.  Additional configuration options are available and are described later in this document.

     

    For On-Prem Customers

    Customers hosting their own Jive instance can install the Antivirus Extension, like any other Jive Plugin, via the Admin Console.  Once the file is uploaded, and the plugin is installed, the server will need to be restarted.

     

    After restarting, the Antivirus Extension will show up in the Admin Console's Plugins tab.  The Antivirus Extension is not enabled by default and needs some additional configuration before it can be enabled.

     

    Screen Shot 2012-06-11 at 8.16.30 PM.png

     

    Post Installation Configuration

    On-prem installations are responsible for the required configuration and enabling virus scanning.  Post installation, the Virus Scanner settings in the Admin Console (System > Settings > Virus Scanner) will be as shown below, with virus scanning disabled.

    configuration.png

    At minimum, a Virus Scanner URI must be entered and the Virus Scanner enabled.  An explanation for each of the settings is provided later in this document.

     

    Uninstalling the Antivirus Extension, which also requires a restart, will remove the extension from the system, but not its data.  Therefore, files that are in a blocked or queued state will remain blocked and queued even after the Antivirus Extension has been removed.

     

    Configuration

    The Antivirus Extension is configured in the Admin Console by going to System > Settings > Virus Scanner.

     

    PropertyDescriptionDefault Value
    Virus Scanner EnabledAllows virus scanning to be turned on and off.  Needs to be set to Yes for files to be scanned.No
    Virus Scanner URI

    Specifies the URI of the virus scanner.  The URI must be in one of the following formats:

    • ClamAV: tcp://hostname/clamav
    • McAfee:  icap://hostname:port/RESPMOD
    Number of Retries

    Specifies the number of times the Antivirus Extension will attempt to stream a file to the virus scanner.  This setting applies to each file.  -1 indicates unlimited retries.  It is recommended this be set to a low number to prevent the virus scan server from being overwhelmed in the event of an outage.  We recommend Jive Hosted customers set this to between 3 and 5.

     

    Once the number of retries has been exceeded, an e-mail will be sent to the addresses in the Email Notify List alerting that the virus scan server may be down.  An admin may re-queue the files for scanning once the virus scan server is operational.    This e-mail will only be sent once every 24 hours once the Number of Retries has been exceeded.

    -1
    Email Notify List

    Specifies the e-mail addresses that will receive a notification when:

    • The virus scanner has determined that an uploaded file is infected.
    • The Number of Retries has been exceeded

     

    The content of these e-mails is described later in this document.

    Notify User Enabled

    Whether or not the user that uploaded the file is notified when the virus scanner has determined the file they uploaded is infected.


    The content of the e-mail is described later in this document.

    No

     

    Testing

    Virus scanning can be tested using the test files provided at Download ° EICAR - European Expert Group for IT-Security.

     

    Message Templates

    The Antivirus Extension adds two message templates to the system.  Message Templates can be managed in the Admin Console under System > Settings > Message Templates.

     

    Message Template NameSent ToWhenTokens Available
    Virus Scan

    Users specified in Email Notify List

    User that uploaded the file, but only if Notifiy User Enable is set to Yes

    When the Virus Scanner determines an uploaded file is infected
    • fileName - name of the file uploaded
    • isAdminEmail - if this instance of the e-mail is being sent to an address in the Email Notify List
    • userName - username of the user that uploaded the file
    • userEmail - e-mail address of the user that uploaded the file
    • virusList - list of violations the Virus Scanner reported for the file
    • containerName - name of the Place for the content associated with the file
    • contentSubject - subject of the content associated with the file
    • contentDeleted - boolean indicating if the content has been deleted
    • contentURL - URL to access the content associated with the file
    • sbsName - name of the Jive instance sending the e-mail
    • sbsInstanceURL - URL of the Jive instance sending the e-mail
    • rootCommunity - name of the root Space of the Jive instance sending the e-mail
    Virus Scan Server DownUsers specified in Email Notify ListWhen the maximum number of attempts of scanning a file has been reached.  Only one of these e-mails will be sent in a 24 hour period.

     

    Troubleshooting