# Command-line Interface (CLI)

# Description

Imunify360 command-line interface (CLI) makes working with Imunify360 basics and features from your terminal even simpler.

# Usage

For access to Imunify360 agent features from command-line interface (CLI), use the following command:

imunify360-agent

Basic usage:

imunify360-agent [command] [--option1] [--option2]...

# Options

The following options are available for all commands.

# Examples

1. This command returns help message for the 3rdparty command:

   imunify360-agent 3rdparty -h
   

2. This command returns data in JSON format in a good-looking view for the get command:

   imunify360-agent get --period 1h --by-country-code UA --by-list black --json --verbose
   

Available commands:

Optional arguments for the commands:

# 3rdparty

Command for disabling 3rd party IDS (currently they are cPHulk and fail2ban) and make Imunify360 agent the primary IDS.

Usage:

imunify360-agent 3rdparty

command is a positional argument and can be:

Examples:

1. The following command shows if there are any conflicts with other software:

imunify360-agent 3rdparty conflicts

1. The following command lists other IDS that might be running concurrently with Imunify360. Here is the example of the command and the output on the server with Fail2ban enabled:

imunify360-agent 3rdparty list
fail2ban

# Backup systems

Allows to manage backup systems integrated to Imunify360.

Usage:

imunify360-agent backup-systems [command] <value>

command is a positional argument and can be:

The status command returns {'<key>': <value>} (JSON formatted):

The extended-status command returns {'<key>': <value>} (JSON formatted):

Examples:

1. The following command prints a list of all available backup systems:

imunify360-agent backup-systems list
acronis 
r1soft 
cpanel

2. The following command initializes cPanel backup system:

imunify360-agent backup-systems init cpanel
Backup initialization process is in progress

3. The following command checks if the cPanel backup system is connected:

imunify360-agent backup-systems status
{'backup_system': 'cpanel', 'enabled': True}

# Blacklist

This command allows you to view or edit actual IPs in the Black List.

Usage:

imunify360-agent blacklist [subject] [command] <value> [--option]

subject is a positional argument and can be:

command is a second positional argument and can be:

Please note that by default list command outputs only first 100 items in the list as if it was run as imunify360-agent blacklist ip list --limit 100. To check whether specific IP address is in the list, you can run the following command:

imunify360-agent blacklist ip list --by-ip 12.34.56.78

where 12.34.56.78 is that specific IP address.

value is an item to manipulate with. It can be IP itself or a country code (find necessary country codes here in CIDR notation in the column ISO ALPHA-2 CODE).

option can be one or few of the optional arguments specified above and one more:

Examples:

• The following command adds IP 1.2.3.4 to the Black List with a comment “one bad IP”:

imunify360-agent blacklist ip add 1.2.3.4 --comment “one bad ip”

• The following command returns a list of IPs in the Black List which are from Bolivia:

imunify360-agent blacklist --by-country-code BO
IP       TTL  COUNTRY  IMPORTED_FROM  COMMENT
1.2.3.4

• The following command adds an IP 1.2.3.4 to the Black List and sets the scope to group:

imunify360-agent blacklist ip add 1.2.3.4 --scope group
OK

To blacklist multiple IP addresses, put them into a file and add to the black list as follows:

cat list.txt | xargs -n 1 imunify360-agent blacklist ip add

The alternative would be using the external white/black list feature.

# Blocked ports

This command allows to view or edit ports, IPs, and protocols in the list of blocked ports.

Usage:

imunify360-agent blocked-port [command] <value> [--option]

command is a first positional argument and can be:

value is an item to manipulate with. value is : separated pair of port number and protocol: 5432:tcp, 28:udp

option can be one or few of the optional arguments specified above and some more:

Example:

The following command blocks port 5555 for tcp connections with a comment "Some comment":

imunify360-agent blocked-port add 5555:tcp --comment "Some comment"

This one includes the list of example IPs and ports blocked:

# imunify360-agent blocked-port list

COMMENT       ID  IPS                                                                                   PORT  PROTO
              1   []                                                                                    3306  tcp  
Some comment  2   [{'comment': None, 'ip': '111.111.111.111'}, {'comment': None, 'ip': '22.22.22.22'}]  5555  tcp 

# Blocked Port IP

This command allows to change the list of IPs that are excluded (allowed) for a certain blocked port.

Usage:

imunify360-agent blocked-port-ip [command] <value> [--option]

command is a first positional argument and can be:

value is an IP address and blocked port.

option can be one or few of the optional arguments for all commands specified above and one more:

Example:

The following command blocks port tcp 5555 to all IPs except 12.34.56.78 with a comment 'Some comment':

imunify360-agent blocked-port-ip add 5555:tcp --ips 12.34.56.78 --comment 'Some comment'
OK

# Checkdb

Checks database integrity. In case database is corrupt, then this command saves backup copy of the database at the /var/imunify360 and tries to restore integrity of the original database. Note that if this command cannot restore database integrity, then it will destroy the original broken database.

Usage:

imunify360-agent checkdb

Example:

The following command checks the database integrity:

imunify360-agent checkdb

# Check-domains

Allows to send domains list for a check to the Imunify360 central server. After domains checked, the results is available via command infected-domains.

Usage:

imunify360-agent check-domains [--optional arguments]

Example:

The following command sends the domains list for a check to the Imunify360 central server:

imunify360-agent check-domains
OK

# Check modsec directives

Allows to check whether the global ModSecurity directives have values recommended by Imunify360.

Usage:

imunify360-agent check modsec directives [--optional arguments]

Example:

The following command checks whether the global ModSecurity directives have values recommended by Imunify360.

imunify360-agent check modsec directives
WARNING: {'ignored': False, 'id': '1000', 'fix': 'Run `imunify360-agent fix modsec directives` command', 'title': "Wrong value for SecConnEngine ModSecurity directive. Expected: 'Off' Got: None", 'url': 'https://docs.imunify360.com/'}
WARNING: {'ignored': False, 'id': '1000', 'fix': 'Run `imunify360-agent fix modsec directives` command', 'title': "Wrong value for SecAuditEngine ModSecurity directive. Expected: 'RelevantOnly' Got: None", 'url': 'https://docs.imunify360.com/'}
WARNING: {'ignored': False, 'id': '1000', 'fix': 'Run `imunify360-agent fix modsec directives` command', 'title': "Wrong value for SecRuleEngine ModSecurity directive. Expected: 'On' Got: None", 'url': 'https://docs.imunify360.com/'}

# Clean

Clean the incident list.

Usage:

imunify360-agent clean [--optional arguments]

Optional arguments:

Example:

The following command deletes all incidents that are older than 5 days from today and leave only 5000 new incidents. The output identifies the number of the incidents cleaned.

# imunify360-agent clean --days 5 --limit 5000
2521

# Config

Allows to update and show configuration file via CLI.

Usage:

imunify360-agent config [command] [configuration options]

command can be:

You can find all configuration options here and instructions on how to apply configuration changes from CLI here.

Example:

Set MALWARE_SCAN_INTENSITY.cpu = 5 configuration option from a command line:

imunify360-agent config update '{"MALWARE_SCAN_INTENSITY": {"cpu": 5}}'

The successful output should display the configuration file content.

# Doctor

Collecting information about Imunify360 state, generating the report and sending it to Imunify360 Support Team. This command can be used in case of any troubles or issues with Imunify360. This command will generate a key to be sent to Imunify360 Support Team. With that key Imunify360 Support Team can help with any problem as fast as possible.

Usage:

imunify360-agent doctor
Please, provide this key:
SSXX11xXXXxxxxXX.1a1bcd1e-222f-33g3-hi44-5551k5lmn555
to Imunify360 Support Team

# Eula

Allows to show and accept the end-user license agreement to automate installation.

Usage:

imunify360-agent eula [command]

command can be one of the following:

Example:

Show the end-user license agreement:

imunify360-agent eula show

# Features

Allows to enable or disable additional CloudLinux software included in Imunify360 for free. The following software is available:

• KernelCare – use kernelcare feature name
• HardenedPHP – use hardened-php feature name
• Invisible Captcha – use invisible-captcha feature name

Usage:

imunify360-agent features [command] <feature name>

command is a positional arguments and can be :

Examples:

1. The following command checks if KernelCare is installed:

imunify360-agent features status kernelcare
{'status': 'not_installed', 'message': 'KernelCare is not installed'}

2. The following command installs KernelCare:

imunify360-agent features install kernelcare

3. The following command uninstalls KernelCare:

imunify360-agent features remove kernelcare

# Feature-management

Allows to manage Imunify360 features available for users.

Usage:

imunify360-agent feature-management [command] [--optional argument]...

Command can be one of the following:

Optional argument for the enable/disable commands can be one of the following:

The mandatory argument for the get command:

The mandatory argument for the native command:

Example:

1. The following command enables Malware Cleanup feature for the user1:

imunify360-agent feature-management enable --feature av --users user1

2. The following command disables the Native Features Management

imunify360-agent feature-management native disable

Once the command executed:

• The Native Features Management will be deactivated
• The Imunify360 Package Extensions will be removed from all packages
• The original Imunify360 Features Management will be activated

1. The following command enables the Native Features Management

imunify360-agent feature-management native enable
OK

Once the command executed, the following default Imunify360 Package Extension settings will be applied to all Packages:

• Malware Scanner - View Reports Only
• Proactive Defense - Available

Imunify360 Package Extensions will be auto-enabled for all packages disregarding the fact they have Imunify360 plugin enabled or not.

All existing Features Management settings will be overridden with the Imunify360 Package Extensions ones for all users.

# Fix modsec directives

Fixes the non-recommended values (sets them to ones recommended by Imunify360)

Usage:

imunify360-agent fix modsec directives [--optional arguments]

Example:

The following command sets the ModSecurity directives values to ones recommended by Imunify360:

imunify360-agent fix modsec directives
OK

If the execution was unsuccessful, the actual error message will be displayed if there are any issues with that.

# Get

The command returns the lists of incidents.

Usage:

imunify360-agent get [--required argument] [--optional argument]...

Option can be one or few of the optional arguments listed above and one more.

Example:

The following command shows the incidents (in JSON format) for recent one hour, filtered by country code UA and filtered by Black List IPs:

imunify360-agent get --period 1h --by-country-code UA --by-list black --json

This one will show the incidents with the severity level 5 of triggered rules, e.g.:

# imunify360-agent get --period 20d --severity 5

TIMESTAMP   ABUSER        COUNTRY  TIMES    NAME                         SEVERITY
1600162404  11.22.33.44    CN        1      SSHD authentication failed.  5       
1600154599  11.22.33.44    CN        1      SSHD authentication failed.  5       
1600138163  11.22.33.44    CN        1      Process exiting (killed).    5 

To get more detailed output to check the plugin or the rule ID these incidents belong to, use the --json argument.

# Graylist

This command allows to view or edit IP Gray List.

Usage:

imunify360-agent graylist ip [command] [--optional argument]

Available commands:

Optional arguments for list:

Please note that by default list command outputs only first 100 items in the list as if it was run as graylist ip list --limit 100. To check whether specific IP address is in the list, you can run the following command:

imunify360-agent graylist ip list --by-ip 12.34.56.78

where 12.34.56.78 is that specific IP address.

Example:

The following command will remove IP 1.2.3.4 from the Gray List:

imunify360-agent graylist ip delete 1.2.3.4
OK

# Hooks

You can find more about hooks here.

This command allows managing hooks.

Usage:

imunify360-agent hook [command] --event [event_name|all] [--path </path/to/hook_script>]

command can be one of the following:

Example:

The following command shows existing event handlers. If you have any hooks configured, the output will include something similar to this:

imunify360-agent hook list --event all
Event: malware-detected, Path: /root/directory/im360mwscannereventhooks/get_user.py

# Import

This command allows to import Black List and White List from the other 3rd party IDS (only CSF supported at the moment) to Imunify360 database. Note. If CSF is enabled, then it is not necessary to run the command because Imunify360 is integrated with CSF.

Usage:

imunify360-agent import {blocked-ports, wblist} ...

Positional arguments:

Example:

The following command will import Black List and White List from the 3rd party IDS:

imunify360-agent import wblist

# Infected-domains

Allows to retrieve infected domains list.

Usage:

imunify360-agent infected-domains [--optional arguments]

Optional arguments:

Example:

The following command displays the results of the check-domains command. In case there are no infected domains located on the server, you will see no output. If there are any, you will get the following output:

imunify360-agent infected-domains
'domain1.com'
'domain2.com'

# Login

Allows to get a token which can be used for authentication in stand-alone Imunify UI.

Usage:

imunify360-agent login [command] [--optional arguments]

command can be one of the following:

Optional arguments for get:

Optional arguments for pam:

Example:

1. You can use the login get command to implement your own authorization mechanism for stand-alone Imunify. For example, you can generate tokens for users which are already authorized in your system/panel, and redirect to stand-alone Imunify UI with https://example.com/#/login?token=<TOKEN> or https://example.com/#?token=<TOKEN> in URL. (You can also set it in localStorage: localStorage.setItem('I360_AUTH_TOKEN', '<TOKEN>');). The output will display similar to the following:

imunify360-agent login get --username my-user1
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE2MDAyNDQwMTAuMDk5MzE5LCJ1c2VyX3R5cGUiOiJjbGllbnQiLCJ1c2VybmFtZSI6ImNsdGVzdCJ9.V_Q03hYw4dNLX5cewEb_h46hOw96KWBWP0E0ChbP3dA

2. This command is used internally by stand-alone Imunify UI as the default authorization method.

imunify360-agent login pam --username my-user1 --password ********

# Malware

Allows to manage malware options.

Usage:

imunify360-agent malware [command] [--optional arguments]

Available commands:

Optional arguments:

action is the second positional argument for ignore and can be one of the following:

where PATHS are the absolute paths to files or folders divided by a whitespace.

command2 is the second positional argument for the malicious command and can be one of the following:

action is the second positional argument for on-demand and can be one of the following:

The optional arguments for on-demand start and on-demand queue put are:

action is the second positional argument for suspicious and can be one of:

action is the second positional argument for user and can be one of the following:

Examples

1. The following command starts on-demand scanner for the path specified after the start command:

imunify360-agent malware on-demand start --path /home/<username>/public_html/

2. The following command shows the example of the ignore-mask usage when you have to scan all d* folders except for the dixon77w.com and dunnrrr.com:

imunify360-agent malware on-demand start --path='/var/www/vhosts/d*' --ignore-mask='/var/www/vhosts/dixon77w.com/*,/var/www/vhosts/dunnrrr.com/*'

3. The following command adds on-demand scans for the selected path(s) to the scan queue

imunify360-agent malware on-demand queue put "/home/user1/some folder" "/home/user2" --file-mask="*.php"

4. The following command removes the selected scans from the scan queue

imunify360-agent malware on-demand list	# get scan_ids for the selected scans from the malicious list
imunify360-agent malware on-demand queue remove 84f043211dc045ae8e6d641f3b9fdb0a 8c4ee39d4d8f43e296e893940c8e791a

5. The following command stops the on-demand Malware Scanner process

imunify360-agent malware on-demand stop

6. The following command stops the on-demand Malware Scanner process and clears the scan queue

imunify360-agent malware on-demand stop --all

7. The following command shows how to get an extended list of malicious files for a particular user. By default, a limit value equals to 50

imunify360-agent malware malicious list --user cltest --limit 500

The list of the infected files found will be looking in the following way:

CLEANED_AT  CREATED     EXTRA_DATA  FILE  HASH  ID  MALICIOUS  SCAN_ID  SCAN_TYPE  SIZE  STATUS  TYPE  USERNAME
None        1599955297  {}          /home/cltest/public_html/test/TsMeJD.php        275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1627  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/test/TZlfnU.php        275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1628  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/test/Ke7V8n.php        275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1629  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/yoUq0L.php             275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1630  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/test/PKiuhY.php        275a021bbfb6489e54d471899f7db9d1663fc695ec2fe2a2c4538aabf651fd0f  1631  True       1996cd86e6b14b12a1c165e79e3540d9  background  68    found   SMW-SA-05057-eicar.tst-4  cltest   
None        1599955297  {}          /home/cltest/public_html/public_html/Zqrsvh.php  275a021bbfb6489e54d471899f7db9d1663fc695

8. The following command adds the specified path to the Ignore List

imunify360-agent malware ignore add /home/user1/public_html/ "/home/some user/public_html/index.php"

9. The following command saves changes after editing watched and excluded patterns for Malware Scanner.

imunify360-agent malware rebuild patterns

10. The following command lists all users and their current infection status

imunify360-agent malware user list

The successful initiation/stopping of a scanning process or adding of ignore directories/files should give you OK in the output.

# Notifications config

Allows administrators to do the following:

• configure email addresses to submit reports on events execution
• execute custom scripts on events execution

Usage:

imunify360-agent notifications-config [command] [configuration options]

command can be:

We advise administrators to use the notifications-config show to get the full config, pick what they want to edit, and feed it to the notifications-config update.

The general structure of the imunify360-agent notifications-config show command output:

{
   "rules": {
      "SCRIPT_BLOCKED": {
         "SCRIPT": {
            "scripts": [], 
            "period": 1,
            "enabled": False
         }, 
         "ADMIN": {
            "period": 1,
            "admin_emails": [],
            "enabled": False
         }
      },
      "USER_SCAN_FINISHED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "USER_SCAN_MALWARE_FOUND": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         },
         "ADMIN": {
         "admin_emails": [],
         "enabled": False
         }
      },
      "USER_SCAN_STARTED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "CUSTOM_SCAN_STARTED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "REALTIME_MALWARE_FOUND": {
         "SCRIPT": {
            "scripts": [], 
            "period": 1,
            "enabled": False
         },
         "ADMIN": {
            "period": 1,
            "admin_emails": [],
            "enabled": False
         }
      },
      "CUSTOM_SCAN_FINISHED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "CUSTOM_SCAN_MALWARE_FOUND": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         },
         "ADMIN": {
            "admin_emails": [],
            "enabled": False
         }
      }
   },
   "admin": {
      "notify_from_email": None,
      "default_emails": []
   }
}

Let's review all the options.

Rules:

• SCRIPT_BLOCKED – occurs when the Proactive Defense has blocked malicious script.
• USER_SCAN_FINISHED – occurs immediately after the user scanning has finished, regardless the malware has found or not.
• USER_SCAN_MALWARE_FOUND – occurs when the malware scanning process of a user account has finished and malware found.
• USER_SCAN_STARTED – occurs immediately after the user scanning has started.
• CUSTOM_SCAN_STARTED – occurs immediately after on-demand (manual) scanning has started.
• REALTIME_MALWARE_FOUND – occurs when malware is detected during the real-time scanning.
• CUSTOM_SCAN_FINISHED – occurs immediately after on-demand (manual) scanning has finished, regardless the malware has found or not.
• CUSTOM_SCAN_MALWARE_FOUND – occurs when the on-demand scanning process has finished and malware found.

Admin:

• default_emails – specify the default list of emails used for all enabled admin email notifications.
• notify_from_email – specify a sender of all emails sent by the Hooks.

Let's review all options for a specific event on the REALTIME_MALWARE_FOUND example:

   "REALTIME_MALWARE_FOUND": {
      "SCRIPT": {
         "scripts": [], 
         "period": 1,
         "enabled": False
      },
      "ADMIN": {
         "period": 1,
         "admin_emails": [],
         "enabled": False
      }

SCRIPT

• scripts – specify the full path to the script(s) or any other Linux executable to be launched on event occurrence. Make sure that the script has an executable bit (+x) on. A line-separated list of scripts is supported.
• period – set a notification interval in seconds. The data for all events that happened within the interval will be accumulated and sent altogether.
• enabled – run (True) a script (event handler) upon event occurrence.

ADMIN:

• period – set a notification interval in minutes. The data for all events that happened within the interval will be accumulated and sent altogether.
• admin_emails – set default to use the default administrator emails and/or specify your emails for notifications.
• enabled – notify (True) the administrator and a custom user list via email upon event occurrence.

Examples:

1. Update admin default emails:

imunify360-agent notifications-config update '{"admin": {"default_emails": ["email1@email.com", "email2@email.com"]}}'

2. Enable and configure email notifications for ADMIN for the REALTIME_MALWARE_FOUND event:

imunify360-agent notifications-config update '{"rules": {"REALTIME_MALWARE_FOUND": {"ADMIN": {"enabled": true, "period": 3600, "admin_emails": ["email3@email.com", "email4@email.com", "default"]}}}}'

After the successful execution, the imunify360-agent notifications-config update command returns the full config with changes.

The imunify360-agent notifications-config show command output after applying the examples 1 and 2:

{
   "rules": {
      "SCRIPT_BLOCKED": {
         "ADMIN": {
            "admin_emails": [],
            "period": 1,
            "enabled": False
         },
         "SCRIPT": {
            "scripts": [],
            "period": 1,
            "enabled": False
         }
      },
      "USER_SCAN_FINISHED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      }, 
      "USER_SCAN_MALWARE_FOUND": {
         "ADMIN": {
            "admin_emails": [],
            "enabled": False
         },
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "CUSTOM_SCAN_STARTED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "REALTIME_MALWARE_FOUND": {
         "ADMIN": {
            "admin_emails": ['email3@email.com', 'email4@email.com', 'default'],
            "period": 3600,
            "enabled": True
         },
         "SCRIPT": {
            "scripts": [],
            "period": 1,
            "enabled": False
         }
      },
      "USER_SCAN_STARTED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "CUSTOM_SCAN_FINISHED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "CUSTOM_SCAN_MALWARE_FOUND": {
         "ADMIN": {
            "admin_emails": [],
            "enabled": False
         },
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      }
   },
   "admin": {
      "notify_from_email": None,
      "default_emails": ["email1@email.com", "email2@email.com"]
   }
}

More examples:

3. Run the custom script on the USER_SCAN_FINISHED event occurrence:

imunify360-agent notifications-config update '{"rules": {"USER_SCAN_FINISHED": {"SCRIPT": {"scripts": ["/script/my-handler.py"], "enabled": true}}}}'

4. Change the period for the SCRIPT hook for the REALTIME_MALWARE_FOUND event to 1 minute:

imunify360-agent notifications-config update '{"rules": {"REALTIME_MALWARE_FOUND": {"SCRIPT": {"period": 60}}}}'

After the successful execution, the imunify360-agent notifications-config update command returns the full config with changes.

The imunify360-agent notifications-config show command output after applying the examples 3 and 4:

{
   "rules": {
      "CUSTOM_SCAN_MALWARE_FOUND": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         },
         "ADMIN": {
            "enabled": False,
            "admin_emails": []
         }
      },
      "USER_SCAN_STARTED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "CUSTOM_SCAN_FINISHED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "SCRIPT_BLOCKED": {
         "SCRIPT": {
            "period": 1,
            "scripts": [],
            "enabled": False
         },
         "ADMIN": {
            "period": 1,
            "enabled": False,
            "admin_emails": []
         }
      },
      "CUSTOM_SCAN_STARTED": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         }
      },
      "USER_SCAN_MALWARE_FOUND": {
         "SCRIPT": {
            "scripts": [],
            "enabled": False
         },
         "ADMIN": {
            "enabled": False,
            "admin_emails": []
         }
      },
      "REALTIME_MALWARE_FOUND": {
         "SCRIPT": {
            "period": 60,
            "scripts": [],
            "enabled": False
         },
         "ADMIN": {
            "period": 3600,
            "enabled": True,
            "admin_emails": ['email3@email.com', 'email4@email.com', 'default']
         }
      },
      "USER_SCAN_FINISHED": {
         "SCRIPT": {
            "scripts": ['/script/my-handler.py'],
            "enabled": True
         }
      }
   },
   "admin": {
      "notify_from_email": None,
      "default_emails": ["email1@email.com", "email2@email.com"]
   }
}

# Example of scripts to create custom notifications

Simple and generic scripts aiming to be a reference/template to create custom scripts to use with imunify-notifier.

For notifications subsystem:

• Shell script

For hooks subsystem:

• Shell script
• Python script

You can use these scripts as a reference and customize them.

chown root:_imunify hook_script.sh

# Python script description

The agent generates messages of different types on hook events. The ‘if chain’ in the script calls the particular method corresponding to type of the event that came from the agent.

For example, if you'd like to block sites for all users, that were detected as infected by realtime scan you can use the handle_realtime_malware_found method.

To unblock user sites which were scanned as clean, you can use the handle_user_scan_finished method.

Add your path to the related hook (or multiple hooks) and implement the custom logic of blocking and unblocking sites.

Also in this script you could find the way to parse JSON that come from Imunify360 and description of this JSON schema in every possible case. Such descriptions are provided by docstring of the handle methods.

# Adding custom email template

Imunify Notifications Engine supports adding custom email messages either the header or body. It may be useful for adding warnings or any message.

To add a custom email template, follow these steps:

1. Enable notification for the CUSTOM_SCAN_MALWARE_FOUND event. It is triggered by a malware caught by on-demand scan:

imunify360-agent notifications-config update '{"rules": {"CUSTOM_SCAN_MALWARE_FOUND": {"ADMIN": {"enabled": true, "admin_emails": ["your-email@example.domain"]}}}}'

2. Create template directory:

mkdir -p /etc/imunify360/emails/custom_scan_malware_found

3. Add a "Hello World" template:

cat <<EOF > /etc/imunify360/emails/custom_scan_malware_found/en.json
[
    {
        "id": "subject",
        "other": "TESTING templates on {{serverName}}"
    },
    {
        "id": "scan_description_section",
        "other": "Hello World, from custom template test"
    }
]
EOF

cat <<EOF > /etc/imunify360/emails/custom_scan_malware_found/t.tmpl
From: {{.mail_from}}
To: {{.mail_to}}
Subject: {{.messages.subject}}

{{.messages.scan_description_section}}
EOF

More examples are available at: /usr/share/imunify-notifier/templates/

# Proactive

These commands allow to manage Proactive Defense feature.

Usage:

imunify360-agent proactive [command] [--option] <value>

Available commands:

option can be one or few of the optional arguments listed above and one more.

Examples:

1. This command adds a file located at /home/user/index.php to Proactive Defense Ignore List for the rule id 12 and name Suspicious detection rule. It means that Proactive Defense will not analyze this file according to this rule:

imunify360-agent proactive ignore add --path /home/user/index.php --rule-id 12 --rule-name 'Suspicious detection rule'
OK

2. This command removes files located at <path to file 1> and <path to file 2> from Proactive Defense Ignore List:

imunify360-agent proactive ignore delete path <path to file 1> <path to file 2>
OK

# Register

Allows to register and activate Imunify360. You can use it in case if Imunify360 was not activated during installation process or in case if activation key of the Imunify360 was changed for any reason. If you do not know what is an activation key or have any problem with it then, please, read Installation guide or contact our support team.

Usage:

imunify360-agent register [--optional arguments] [KEY]

KEY is a positional argument:

If you will use this command without the KEY argument, then it will try to register and activate current activation key.

In case when the number of users on the server changes and one license is replaced by another, it is necessary to run the following command to update the license:

imunify360-agent update-license
OK

Example 1:

The following command will register and activate Imunify360 with the provided activation key:

imunify360-agent register IM250sdfkKK245kJHIL
OK

Example 2:

If you have an IP-based license, you can use IPL argument to register and activate Imunify360:

imunify360-agent register IPL
OK

# Reload lists

Allows to use external files with the list of Black/White-listed IPs.

Usage:

imunify360-agent reload-lists

Example:

To use external files with the list of Black/White-listed IPs, you should place this list into one of the following directories: /etc/imunify360/whitelist/*.txt for the White list and /etc/imunify360/blacklist/*.txt for the Black list. Then in order to apply the IP lists, you should run the following command:

imunify360-agent reload-lists
OK

# Remote-proxy

Allows to add an additional proxy subnet.

Usage:

imunify360-agent remote-proxy [commands] [--optional arguments]

Positional arguments:

Positional arguments for add:

Optional arguments for add:

Positional arguments for delete:

Optional arguments for list:

Positional arguments for group:

Positional arguments for enable/disable:

Optional arguments for enable/disable:

Examples

The following command adds proxy subnet 1.1.2.0/24 with name my_own_proxy

imunify360-agent remote-proxy add 1.1.2.0/24 --name "my_own_proxy"
OK

# Rstatus

Allows to check if Imunify360 server license is valid.

Usage:

imunify360-agent rstatus [--optional arguments]

An extended variation (otherwise, you receive OK if everything is fine with the license registered):

imunify360-agent rstatus --json -v

{
  "expiration": null,
  "id": "SSXX11xXXXxxxxXX",
  "license": {
    "expiration": null,
    "id": "SSXX11xXXXxxxxXX",
    "license_type": "imunify360",
    "message": "",
    "redirect_url": " ",
    "status": true,
    "user_count": 100,
    "user_limit": 2147483647
  },
  "license_type": "imunify360",
  "message": "",
  "redirect_url": " ",
  "status": true,
  "strategy": "PRIMARY_IDS",
  "user_count": 100,
  "user_limit": 2147483647,
  "version": "5.1.2-1"
}

# Rules

This command allows user to manage rules disabled for firewall plugins Imunify360 uses.

Usage:

imunify360-agent rules [command] [--option] <value> [--option] <value>

command is a positional argument and can be:

Option can be:

Examples

1. The following command adds a rule with id 42 and name ‘Rule name’ for the ModSecurity rules to the disabled rules list:

imunify360-agent rules disable --id 42 --plugin modsec --name 'Rule name'
OK

2. The following command removes a rule with id 42 for the ModSecurity rules from the disabled rules list:

imunify360-agent rules enable --id 42 --plugin modsec
OK

3. The following command displays the list of disabled rules:

imunify360-agent rules list-disabled

The list is displayed as follows:

{'plugin': 'modsec', 'id': '214920', 'domains': ['captchatest.com'], 'name': 'Imported from config'}

{'plugin': 'modsec', 'id': '42', 'domains': None, 'name': 'Rule name'}

{'plugin': 'ossec', 'id': '1003', 'domains': None, 'name': 'Imported from config'}

{'plugin': 'ossec', 'id': '2502', 'domains': None, 'name': 'User missed the password more than one time'}

Where

• plugin — is a firewall plugin name (modsec for ModSecurity and ossec for OSSEC)
• id — is id number of the rule provided by the firewall plugin
• domains — the list of the domains for which the rule is disabled (None means all domains)*
• name — rule description or details of the rule from ModSecurity or OSSEC

4. The following command updates the WAF ruleset configurator immediately:

imunify360-agent rules update-app-specific-rules
OK

# Submit false-positive/false-negative

To submit file as false positive (if Imunify360 considers file as a malicious but it actually isn't) you can use the following command. Make sure to specify the file name. Relative paths are also supported as well as full paths.

imunify360-agent submit false-positive --reason <reason> <file>

To submit file as false negative (if Imunify360 considers file as a non-malicious but it actually does) you can use the following command (please make sure to specify the file name along with full path):

imunify360-agent submit false-negative <file>
OK

Optional arguments:

# False-positive/False-negative File Submission Tool

This section describes how to use Imunify false positive/false negative submission tool. This tool allows you to submit files for analysis, review the list of your submissions, and monitor their statuses

# Preparation

The configuration phase consists of two steps:

1. Get an API token. For the first run, a new API key should be created. Navigate to cm.imunify.com/#/tokens. Use Imunify/CLN account credentials to log in. Get a new key by clicking on the button "Create API key"

The API key can be used as many times as needed across all servers for the individual Imunify customer.

2. Get the script and set permissions. Run the script shown below. Please note that the script has to be executed with root privileges since it requires access to Imunify license file.

# curl -o fpfn-submission.sh https://files.imunify360.com/static/cm/fpfn-submission.sh 
# chmod 700 fpfn-submission.sh 

# Requirements

For this process to work properly you need the following prerequisites:

• JSON Processor. Jq is required to run the tool. If it is not installed please run the script below.

# yum install jq -y 

• Imunify360 v6.7.3+ is required. Follow the update instructions if the version you use is the earlier one.
• Submission script. The submission tool that can be downloaded from https://files.imunify360.com/static/cm/fpfn-submission.sh.

# Usage

We designed the submission script to accept arguments through the use of the environment variables. Here is the output of the --help page.

# File submission

The following code snippets can be used to submit the false_negative file for analysis:

# FILE_PATH=./eicar.suspicious REASON=false_negative NOTE='support ticket 400' API_TOKEN=<YOUR_API_KEY> ./fpfn submission.sh -p

The response is made to be transparent. The _id field represents a unique submission ID.

# Fetching results

The results of submission processing can be viewed in 1-3 business days using a set of various filters (see --help). The following code uses NOTE to fetch results:

# NOTE="400" API_TOKEN=<YOUR_API_KEY> ./fpfn-submission.sh -g 

Here is the response:

The response contains the section verdicts that describes the processing results. For recent verdicts, it may contain a signature base build id, e.g.

   { 
      "date": "2022-11-11 20:14:40", 
      "verdict": "malicious", 
      "comment": "Added after scan with build 9231" 
   }

If the verdicts section is empty, it means that the file is in process.

# Feedback

Please reach out to us should you have any concerns, questions, and/or feedback. We appreciate all the communication from you.

# Unregister

Allows to unregister and disable Imunify360 on the server.

Usage:

imunify360-agent unregister [--optional arguments]
OK

# Vendors

Command for manipulating Imunify360 vendors.

Usage:

imunify360-agent [command]

command is a positional argument and can be:

Example:

The following command uninstalls the ModSecurity vendors:

imunify360-agent uninstall-vendors
OK

# Version

Allows to view the actual Imunify360 version installed on the server.

Usage:

imunify360-agent version [--json]
4.9.5-3

# Whitelist

This command allows to view or edit actual IPs and domains in the White List.

Usage:

imunify360-agent whitelist [subject] [command] <value> [--option]

subject is a positional argument and can be:

command is a second positional argument and can be:

Please note that by default list command outputs only first 100 items in the list as if it was run as imunify360-agent whitelist ip list --limit 100. To check whether specific IP address is in the list, you can run the following command:

imunify360-agent whitelist ip list --by-ip 12.34.56.78

where 12.34.56.78 is that specific IP address.

value is an item to manipulate with. It can be IP itself or a country code (find the necessary country codes in CIDR notation in ISO ALPHA-2 CODE column), or a domain name.

option can be one or few of the optional arguments from the table above and one more:

Examples:

1. The following commands adds IP 1.2.3.4 to the White List with a comment “one good ip”:

imunify360-agent whitelist ip add 1.2.3.4 --comment "one good ip"
OK

2. The following command returns a list of IPs in the White List which are from Bolivia:

imunify360-agent whitelist --by-country-code BO

3. The following command adds domain with a name example.com to the White List:

imunify360-agent whitelist domain add example.com
OK

4. The following command checks domains in the White List:

imunify360-agent whitelist domain list
OK

5. The following command adds an IP 1.2.3.4 to the White List and sets the scope to group:

imunify360-agent whitelist ip add 1.2.3.4 --scope group
OK

6. The following command adds Bolivia to the White List:

imunify360-agent whitelist country add BO
OK

7. The --json key can be used to get additional details about the IP address. For example, whether it has full access on the server or has just been added to a whitelist:

imunify360-agent whitelist ip list --by-ip 1.2.3.4 -v --json
...
 {
   "auto_whitelisted": false,
   "comment": "Manually added on 2022-09-05 05:16:54",
   "country": {
     "code": "US",
     "id": "1234001",
     "name": "United States"
 },
   "ctime": 1662355015,
   "deep": null,
   "expiration": 0,
   "full_access": true,
   "imported_from": null,
   "ip": "1.2.3.4",
   "listname": "WHITE",
   "manual": true,
   "netmask": 1234967295,
   "network_address": 123495478,
   "scope": "local",
   "version": 4
 }
...

To whitelist multiple IP addresses, put them into a file and add to the white list as follows:

cat list.txt | xargs -n 1 imunify360-agent whitelist ip add

The alternative would be using the external white/black list feature.

# Whitelisted crawlers

Allows do operate with search engine domains.

Usage:

imunify360-agent whitelisted-crawlers [command] 

command can be one of the following:

Examples:

1. This command adds two search engines to the list of whitelisted crawlers:

   imunify360-agent whitelisted-crawlers add yandex.com google.com
   OK
   

2. This command deletes a search engine to the list of whitelisted crawlers

   imunify360-agent whitelisted-crawlers delete yandex.com
   OK
   

3. This command lists all added whitelisted crawlers

   imunify360-agent whitelisted-crawlers list
   DESCRIPTION  DOMAINS                                       ID
   Google       ['.google.com', '.googlebot.com']             1 
   Yandex       ['.yandex.ru', '.yandex.com', '.yandex.net']  2