Metadefender Core V4.10.2
Total Page:16
File Type:pdf, Size:1020Kb
MetaDefender Core v4.10.2 © 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 Installing Metadefender Core on Ubuntu or Debian computers 15 Installing Metadefender Core on Red Hat Enterprise Linux or CentOS computers 15 Installing Metadefender Core on Windows computers 16 1.2. License Activation 16 1.3. Scan Files with Metadefender Core 17 2. Installing or Upgrading Metadefender Core 18 2.1. Recommended System Requirements 18 System Requirements For Server 18 Browser Requirements for the Metadefender Core Management Console 20 2.2. Installing Metadefender Core 21 Installation 21 Installation notes 21 2.2.1. Installing Metadefender Core using command line 22 2.2.2. Installing Metadefender Core using the Install Wizard 23 2.3. Upgrading MetaDefender Core 23 Upgrading from MetaDefender Core 3.x 23 Upgrading from MetaDefender Core 4.x 24 2.4. Metadefender Core Licensing 24 2.4.1. Activating Metadefender Core Licenses 24 2.4.2. Checking Your Metadefender Core License 31 2.5. Performance and Load Estimation 32 What to know before reading the results: Some factors that affect performance 32 How test results are calculated 33 Test Reports 33 Performance Report - Multi-Scanning On Linux 33 Performance Report - Multi-Scanning On Windows 37 2.6. Special installation options 42 Use RAMDISK for the tempdirectory 42 3. Configuring Metadefender Core 46 3.1. Management Console 46 3.2. Metadefender Configuration 47 3.2.1. Startup Core Configuration 47 3.2.2. Startup Node Configuration 51 3.3. User management 54 3.3.1. Users and groups 54 3.3.2. Roles 59 3.3.3. User directories 61 3.3.4. Active Directory attributes 69 3.3.5. Change user password 72 3.4. Update settings 73 Internet 74 Folder 75 Manual 75 3.5. Clean up scan database 76 Technology Note: 76 3.6. Policies configuration 76 3.6.1. How MetaDefender Core policies work 77 3.6.2. Workflow template configuration 77 3.6.3. Security zone configuration 90 3.6.4. Workflow rule configuration 90 3.7. Logging 94 3.7.1. Configuration 95 3.7.2. Debug logging 95 3.8. Enabling HTTPS 95 Enabling HTTPS via Management Console 96 Enabling HTTPS via configuration files 98 3.9. Configuring proxy settings 100 How can I set proxy server for the product 100 3.10. External Scanners And Post Actions 100 External Scanners 101 Post Actions 104 4. Scan files with Metadefender Core 107 Scan Files via REST API 107 Scan Files via Web Interface 108 Choose what to scan and how 108 Start scanning 108 Progress of scanning 108 5. Data Sanitization 110 6. Operating Metadefender Core 111 6.1. Dashboard 111 Overview page 111 Scan history 112 Quarantine 112 Update history 112 6.2. Inventory Management 113 Certificates 113 Engines 116 Nodes 123 Whitelist (by hash) 125 6.3. Regular Maintenance 127 Checking for Upgrades 127 Checking Engines / Databases Health 127 6.4 Import/Export configuration 127 Export 128 Import 128 Note 128 7. Metadefender Core Developer Guide 129 How to Interact with Metadefender Core using REST 129 File scan process 129 Activate License Online 129 Successful response 130 Error response 130 Cancel Batch 131 Cancel Scan Batch 131 Close Batch 132 Close Scan Batch 132 Download Batch Signed Result 134 Download Batch Signed Result 134 Download Sanitized Files 136 Download Sanitized Files Using Data Id 136 Error response 137 Fetching Available Scan Rules 138 Successful response 138 Error response 139 Fetching Engine/Database Versions 139 Successful response 140 Error response 141 Fetch Scan Result 141 Retrieving Scan Reports Using Data ID 141 Successful response 141 Successful response with archive detection 146 Response (not existing data_id) 148 Error response 148 Fetch Scan Result by File Hash 149 Retrieve Scan Results Using Hash 149 Request http header parameters 149 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. 149 Successful response 149 Successful response with archive detection 153 Response (not existing hash) 155 Error response 155 Get Current License Information 156 Successful response 156 Error response 157 Get Product Version 157 Successful response 158 Error response 158 Initiate Batch 159 Initiate Scan Batch 159 Login / Create a Session 160 Successful response 160 Error response 161 Logout / Destroy a Session 161 Successful response 162 Error response 162 Scan A File 162 Successful response 163 Error response 163 Scan file in batch 164 Scan file in batch 164 Status of Batch 165 Status of Scan Batch 165 Uploading License Key File 166 Successful response 167 Error response 167 Vulnerability Info In Scan Result 168 Example 168 8. Advanced Metadefender Core Deployment 172 8.1. Scripted license management 172 Requirements 172 Activation steps 172 Deactivation steps 173 Important notes 175 8.2. Multi-node deployment 175 Setting up several Metadefender Core nodes 175 8.3. Using external load-balancer 178 8.3.1. HTTP(S) - Layer 7 load balancing 178 8.3.2. DNS load balancing 181 9. Troubleshooting Metadefender Core 185 Installation issues 185 Issues with nodes 185 Where are the Metadefender Core logs located? 185 How can I create a support package? 185 Issues under high load 185 How to Create Support Package? 186 Creating the package on Linux 186 Creating the package on Windows 186 Content of the created package 187 How to Read the Metadefender Core Log? 187 Files 187 Format 187 Severity levels of log entries 188 Inaccessible Management Console 188 How to detect 188 Solution 188 Possible Issues on Nodes 189 Q. Node detected 3rd party product on system 189 Q. There is no scan node connected 189 Too Many Sockets or Files Open 190 How to detect 190 Solution 190 Too Many TIME_WAIT Socket 191 How to detect 191 Solution 191 Technical Insights 192 10. Release notes 193 Version v4.10.2 193 Version v4.10.1 193 Version v4.10.0 193 Version 4.9.1 194 Version 4.9.0 195 Version 4.8.2 195 Version 4.8.1 195 Version 4.7.2 197 Version 4.7.1 197 Version 4.6.3 198 Version 4.6.2 198 Version 4.6.1 198 Version 4.6.0 199 Version 4.5.1 200 Version 4.5.0 200 Version 4.4.1 201 Version 4.3.0 202 Version 4.2.0 202 Version 4.1.0 203 Version 4.0.1 204 Version 4.0.0 204 11. Metadefender / Client 205 About This Guide 205 Key Features of MetaDefender Client 205 Supported Operating Systems 205 1. MetaDefender Client Packages 206 MetaDefender Free Client 206 MetaDefender Premium Client 206 2. MetaDefender Premium Client 207 2.1 Install using the Install Wizard 207 2.2 Install using the Command Line 209 2.3 Using the MetaDefender Premium Client 210 2.4 Configuring through the config file 225 2.5 Configuring through Central Management 232 3. MetaDefender Free Client 237 4. Command Line Interface 237 Example: 237 Command Line Options 237 4.1 Generating and using the Administrator Password 241 5. MetaDefender Client Release Notes 243 Tips and Known Issues 243 4.1.5 Release 243 4.1.4 Release 244 4.1.3 Release 244 4.1.2 Release 245 4.1.1 Release 245 4.1.0 Release 245 4.0.18 Release 246 4.0.17 Release 246 4.0.16 Release 246 4.0.15 Release 247 4.0.14 Release 247 4.0.13 Release 248 4.0.12 Release 248 4.0.11 Release 248 4.0.10 Release 249 4.0.9 Release 250 4.0.8 Release 250 4.0.7 Release 250 4.0.6 Release 250 4.0.5 Release 251 4.0.4 Release (Internal Only) 251 4.0.3 Release 251 4.0.2 Release 252 4.0.1 Release 252 4.0.0 Release 253 Changes in 3.12.5 253 12. Legal 254 Copyright 254 DISCLAIMER OF WARRANTY 254 COPYRIGHT NOTICE 254 Export Classification EAR99 254 13. Knowledge Base Articles 255 Are MetaDefender Core v4 upgrades free? 256 Are there any dependencies that need to be fulfilled for MetaDefender Core v4 engines ? 256 Does Metadefender Core v4 offer real-time antivirus protection on the system where it is installed? 257 Does MetaDefender Core v4 Detect the NotPetya Ransomware? 257 Does the fixing updates for Meltdown and Spectre vulnerabilities affects any engines in MetaDefender Core v4? 260 External scanners in MetaDefender core v4.8.0 and above 260 How can I configure the maximum queue size in MetaDefender Core v4 ? 262 How can I find a sanitized file scanned with MetaDefender Core v4? 264 How can I increase the scaling up performance? 264 How can I upgrade from Core v4.7.0/v4.7.1 to a newer Core v4.7 release 266 How can the TEMP folder be changed? 267 How do I collect verbose debug packages on MetaDefender Core v4 for Linux? 268 How do I deploy MetaDefender Core v4 to an offline Linux environment? 270 Installing MetaDefender Core 270 Activate your license 270 Installing the MetaDefender Update Downloader utility 272 Applying offline updates 273 Contacting OPSWAT Support 274 How do I deploy MetaDefender Core v4 to an offline Windows environment? 274 Installing MetaDefender Core 275 Activate your license 275 Installing the MetaDefender Update Downloader utility 276 Applying offline updates 278 Contacting OPSWAT Support 279 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? 279 How do I remove an engine from my MetaDefender v4 instance? 281 How do I use MetaDefender Core v4 Workflows ? 281 Defining and administering Workflow Templates in MetaDefender Core v4 282 Is action needed because Metadefender v4's AVG license is expiring on 2018-06-15? 283 What do I need to do? 283 What if I don't take action by June 15, 2018? 284 Why is the license for AVG expiring? 284 What if I need more assistance from OPSWAT on this topic? 284 Is there a virus test I could use to test MetaDefender Core v4? 284 MetaDefender Core v4 shows a large number of files that failed to scan.