MetaDefender Core v4.12.0 © 2018 OPSWAT, Inc. All rights reserved. OPSWAT®, MetadefenderTM and the OPSWAT logo are trademarks of OPSWAT, Inc. All other trademarks, trade names, service marks, service names, and images mentioned and/or used herein belong to their respective owners. Table of Contents About This Guide 13 Key Features of Metadefender Core 14 1. Quick Start with Metadefender Core 15 1.1. Installation 15 Operating system invariant initial steps 15 Basic setup 16 1.1.1. Configuration wizard 16 1.2. License Activation 21 1.3. Scan Files with Metadefender Core 21 2. Installing or Upgrading Metadefender Core 22 2.1. Recommended System Requirements 22 System Requirements For Server 22 Browser Requirements for the Metadefender Core Management Console 24 2.2. Installing Metadefender 25 Installation 25 Installation notes 25 2.2.1. Installing Metadefender Core using command line 26 2.2.2. Installing Metadefender Core using the Install Wizard 27 2.3. Upgrading MetaDefender Core 27 Upgrading from MetaDefender Core 3.x 27 Upgrading from MetaDefender Core 4.x 28 2.4. Metadefender Core Licensing 28 2.4.1. Activating Metadefender Licenses 28 2.4.2. Checking Your Metadefender Core License 35 2.5. Performance and Load Estimation 36 What to know before reading the results: Some factors that affect performance 36 How test results are calculated 37 Test Reports 37 Performance Report - Multi-Scanning On Linux 37 Performance Report - Multi-Scanning On Windows 41 2.6. Special installation options 46 Use RAMDISK for the tempdirectory 46 3. Configuring Metadefender Core 50 3.1. Management Console 50 3.2. Metadefender Configuration 51 3.2.1. Startup Core Configuration 51 3.2.2. Startup Node Configuration 55 3.2.3 Nginx related configuration 58 3.3. User management 58 3.3.1. Users and groups 59 3.3.2. Roles 64 3.3.3. User directories 66 3.3.4. Active Directory attributes 74 3.3.5. Change user password 77 3.4. Update settings 78 Internet 79 Folder 80 Manual 80 3.5. Clean up scan database 81 Technology Note: 81 3.6. Policies configuration 81 3.6.1. How MetaDefender Core policies work 82 3.6.2. Workflow template configuration 82 3.6.3. Security zone configuration 95 3.6.4. Workflow rule configuration 95 3.7. Logging 99 3.7.1. Configuration 100 3.7.2. Debug logging 100 3.8 Security settings on web console 101 3.8.1 Enabling HTTPS 101 3.8.2 Session timeout 105 3.9. Configuring proxy settings 106 How can I set proxy server for the product 106 3.10. External Scanners And Post Actions 107 External Scanners 107 Post Actions 110 4. Scan files with Metadefender Core 113 Scan Files via REST API 113 Scan Files via Web Interface 114 Choose what to scan and how 114 Start scanning 114 Progress of scanning 114 5. Data Sanitization 116 6. Operating Metadefender Core 117 6.1. Dashboard 117 Overview page 117 Scan history 118 Quarantine 118 Update history 118 6.2. Inventory Management 119 Certificates 119 Nodes 122 Skip by hash 124 Technologies 126 6.3. Regular Maintenance 134 Checking for Upgrades 134 Checking Engines / Databases Health 134 6.4 Import/Export configuration 134 Export 135 Import 135 Note 135 7. Metadefender Core Developer Guide 136 How to Interact with Metadefender Core using REST 136 File scan process 136 7.1. MetaDefender API Code Samples 136 Activate License Online 137 Successful response 137 Error response 138 Cancel Batch 138 Cancel Scan Batch 138 Cancel File Scan 140 Cancel Scan File 140 Close Batch 141 Close Scan Batch 141 Download Batch Signed Result 142 Download Batch Signed Result 142 Download Sanitized Files 145 Download Sanitized Files Using Data Id 145 Error response 145 Fetching Available Scan Rules 146 Successful response 147 Error response 148 Fetching Engine/Database Versions 148 Successful response 148 Error response 149 Fetch Scan Result 150 Retrieving Scan Reports Using Data ID 150 Successful response 150 Successful response with archive detection 156 Response (not existing data_id) 158 Error response 158 Fetch Scan Result by File Hash 159 Retrieve Scan Results Using Hash 159 Request http header parameters 159 The retrieved result is always the most recent for the processed item, if rule is set then it will be the most recent - if exists - under the given rule. 159 Successful response 159 Successful response with archive detection 163 Response (not existing hash) 165 Error response 165 Get Current License Information 166 Successful response 166 Error response 167 Get Product Version 167 Successful response 168 Error response 168 Initiate Batch 169 Initiate Scan Batch 169 Login / Create a Session 170 Successful response 170 Error response 171 Logout / Destroy a Session 171 Successful response 172 Error response 172 Scan A File 172 Successful response 173 Error response 173 Scan file in batch 174 Scan file in batch 174 Status of Batch 175 Status of Scan Batch 175 Uploading License Key File 176 Successful response 177 Error response 177 Vulnerability Info In Scan Result 178 Example 178 8. Advanced Metadefender Deployment 182 8.1. Scripted license management 182 Requirements 182 Activation steps 182 Deactivation steps 184 Important notes 185 8.2. Multi-node deployment 185 Setting up several Metadefender Core nodes 185 8.3. Using external load-balancer 188 8.3.1. HTTP(S) - Layer 7 load balancing 189 8.3.2. DNS load balancing 191 9. Troubleshooting Metadefender Core 195 Installation issues 195 Issues with nodes 195 Where are the Metadefender Core logs located? 195 How can I create a support package? 195 Issues under high load 195 How to Create Support Package? 196 Creating the package on Linux 196 Creating the package on Windows 196 Content of the created package 197 How to Read the Metadefender Core Log? 197 Files 197 Format 197 Severity levels of log entries 198 Inaccessible Management Console 198 How to detect 198 Solution 198 Possible Issues on Nodes 199 Q. Node detected 3rd party product on system 199 Q. There is no scan node connected 199 Too Many Sockets or Files Open 200 How to detect 200 Solution 200 Too Many TIME_WAIT Socket 201 How to detect 201 Solution 201 Technical Insights 202 10. Release notes 203 Version v4.12.0 203 Version v4.11.3 203 Version v4.11.2 203 Version v4.11.1 204 Version v4.11.0 204 Version v4.10.2 205 Version v4.10.1 205 Version v4.10.0 206 Version 4.9.1 206 Version 4.9.0 207 Version 4.8.2 207 Version 4.8.1 208 Version 4.7.2 209 Version 4.7.1 209 Version 4.6.3 210 Version 4.6.2 210 Version 4.6.1 211 Version 4.6.0 211 Version 4.5.1 212 Version 4.5.0 212 Version 4.4.1 213 Version 4.3.0 214 Version 4.2.0 215 Version 4.1.0 215 Version 4.0.1 216 Version 4.0.0 216 11. Metadefender / Client 217 About This Guide 217 Key Features of MetaDefender Client 217 Supported Operating Systems 217 1. MetaDefender Client Packages 218 MetaDefender Free Client 218 MetaDefender Premium Client 218 2. MetaDefender Premium Client 219 2.1 Install using the Install Wizard 219 2.2 Install using the Command Line 221 2.3 Using the MetaDefender Premium Client 222 2.4 Configuring through the config file 237 2.5 Configuring through Central Management 244 3. MetaDefender Free Client 249 4. Command Line Interface 249 Example: 249 Command Line Options 249 4.1 Generating and using the Administrator Password 253 5. MetaDefender Client Release Notes 255 Tips and Known Issues 255 4.1.7 Release 256 4.1.6 Release 256 4.1.5 Release 257 4.1.4 Release 257 4.1.3 Release 257 4.1.2 Release 258 4.1.1 Release 258 4.1.0 Release 259 4.0.18 Release 259 4.0.17 Release 259 4.0.16 Release 260 4.0.15 Release 260 4.0.14 Release 261 4.0.13 Release 261 4.0.12 Release 261 4.0.11 Release 262 4.0.10 Release 262 4.0.9 Release 263 4.0.8 Release 263 4.0.7 Release 264 4.0.6 Release 264 4.0.5 Release 264 4.0.4 Release (Internal Only) 265 4.0.3 Release 265 4.0.2 Release 265 4.0.1 Release 266 4.0.0 Release 266 Changes in 3.12.5 266 12. Legal 268 Copyright 268 DISCLAIMER OF WARRANTY 268 COPYRIGHT NOTICE 268 Export Classification EAR99 268 13. Knowledge Base Articles 269 Are MetaDefender Core v4 upgrades free? 270 Are there any dependencies that need to be fulfilled for MetaDefender Core v4 engines ? 270 Does Metadefender Core v4 offer real-time antivirus protection on the system where it is installed? 271 Does MetaDefender Core v4 Detect the NotPetya Ransomware? 271 Does the fixing updates for Meltdown and Spectre vulnerabilities affect any engines in MetaDefender Core v4? 274 External scanners in MetaDefender core v4.8.0 and above 275 How can I configure the maximum queue size in MetaDefender Core v4 ? 277 How can I find a sanitized file scanned with MetaDefender Core v4? 278 How can I increase the scaling up performance? 279 How can I upgrade from Core v4.7.0/v4.7.1 to a newer Core v4.7 release 281 How can the TEMP folder be changed? 282 How do I collect verbose debug packages on MetaDefender Core v4 for Linux? 283 How do I deploy MetaDefender Core v4 to an offline Linux environment? 284 Installing MetaDefender Core 284 Activate your license 285 Installing the MetaDefender Update Downloader utility 286 Applying offline updates 288 Contacting OPSWAT Support 289 How do I deploy MetaDefender Core v4 to an offline Windows environment? 289 Installing MetaDefender Core 290 Activate your license 290 Installing the MetaDefender Update Downloader utility 291 Applying offline updates 293 Contacting OPSWAT Support 294 How do I disable real-time protection of my anti-malware software if it is not allowed by corporate policy for use with MetaDefender Core v4? 294 How do I remove an engine from my MetaDefender v4 instance? 296 How do I use MetaDefender Core v4 Workflows ? 296 Defining and administering Workflow Templates in MetaDefender Core v4 297 How long is the support life cycle for a specific version/release of MetaDefender Core v4? 298 Is action needed because Metadefender v4's AVG license is expiring on 2018-06-15? 300 What do I need to do? 300 What if I don't take action by June 15, 2018? 300 Why is the license for AVG expiring? 300 What if I need more assistance from OPSWAT on this topic? 301 Is there a virus test I could use to test MetaDefender Core v4? 301 MetaDefender Core v4 shows a large number of files that failed to scan.