Metadefender Core V4.14.1
Total Page:16
File Type:pdf, Size:1020Kb
MetaDefender Core v4.14.1 © 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 11 Key Features of Metadefender Core 12 1. Quick Start with Metadefender Core 13 1.1. Installation 13 Operating system invariant initial steps 13 Basic setup 14 1.1.1. Configuration wizard 14 1.2. License Activation 19 1.3. Scan Files with Metadefender Core 19 2. Installing or Upgrading Metadefender Core 20 2.1. Recommended System Requirements 20 System Requirements For Server 20 Browser Requirements for the Metadefender Core Management Console 22 2.2. Installing Metadefender 22 Installation 22 Installation notes 23 2.2.1. Installing Metadefender Core using command line 23 2.2.2. Installing Metadefender Core using the Install Wizard 25 2.3. Upgrading MetaDefender Core 25 Upgrading from MetaDefender Core 3.x 25 Upgrading from MetaDefender Core 4.x 26 2.4. Metadefender Core Licensing 26 2.4.1. Activating Metadefender Licenses 26 2.4.2. Checking Your Metadefender Core License 33 2.5. Performance and Load Estimation 34 What to know before reading the results: Some factors that affect performance 34 How test results are calculated 35 Test Reports 35 Performance Report - Multi-Scanning On Linux 35 Performance Report - Multi-Scanning On Windows 39 2.6. Special installation options 44 Use RAMDISK for the tempdirectory 44 3. Configuring Metadefender Core 48 3.1. Management Console 48 3.2. Metadefender Configuration 49 3.2.1. Startup Core Configuration 49 3.2.2. Startup Node Configuration 53 3.2.3 Nginx related configuration 56 3.3. User management 57 3.3.1. Users and groups 57 3.3.2. Roles 62 3.3.3. User directories 64 3.3.4. Active Directory attributes 72 3.3.5. Change user password 75 3.4. Update settings 76 Internet 77 Folder 78 Manual 78 3.5. Clean up scan database 79 Technology Note: 79 3.6. Policies configuration 79 3.6.1. How MetaDefender Core policies work 80 3.6.2. Workflow template configuration 80 3.6.3. Security zone configuration 95 3.6.4. Workflow rule configuration 95 3.6.5. Quarantine 100 3.7. Logging 109 3.7.1. Configuration 109 3.7.2. Debug logging 110 3.8 Security settings on web console 110 3.8.1 Enabling HTTPS 111 3.8.2 Session timeout 114 3.9. Configuring proxy settings 115 How can I set proxy server for the product 115 3.10. External Scanners And Post Actions 116 External Scanners 116 Post Actions 119 3.11. Yara rule sources 121 4. Scan files with Metadefender Core 123 Scan Files via REST API 123 Scan Files via Web Interface 124 Choose what to scan and how 124 Start scanning 124 Progress of scanning 124 5. Data Sanitization 126 6. Operating Metadefender Core 127 6.1. Dashboard 127 Overview page 127 Scan history 128 Quarantine 128 Update history 128 6.2. Inventory Management 129 Certificates 129 Nodes 132 Skip by hash 134 Technologies 136 6.3. Regular Maintenance 144 Checking for Upgrades 144 Checking Engines / Databases Health 144 6.4 Import/Export configuration 144 Export 145 Import 145 Note 145 7. Metadefender Core Developer Guide 146 How to Interact with Metadefender Core using REST 146 File scan process 146 7.1. MetaDefender API 146 7.1.1. Sessions 147 7.1.2. Licensing 150 7.1.3. Processing files 154 7.1.4. Processing files in batch 170 7.1.5. Download Sanitized Files 179 7.1.6. Vulnerability Info In Processing Result 180 7.1.7. Skip by hash 184 7.1.8. Get version of components 189 7.1.9. Configuration related APIs 192 7.1.10. Yara 310 7.2. MetaDefender API Code Samples 317 7.3. Deployment automation support 318 Installation 318 Initialization 319 Configuration 323 8. Advanced Metadefender Deployment 324 8.1. Scripted license management 324 Requirements 324 Activation steps 324 Deactivation steps 326 Important notes 327 8.2. Multi-node deployment 327 Setting up several Metadefender Core nodes 327 8.3. Using external load-balancer 330 8.3.1. HTTP(S) - Layer 7 load balancing 331 8.3.2. DNS load balancing 333 8.4. Cloud Deployment 336 8.4.1. AWS Deployment 336 9. Troubleshooting Metadefender Core 357 Installation issues 357 Issues with nodes 357 Where are the Metadefender Core logs located? 357 How can I create a support package? 357 Issues under high load 357 How to Create Support Package? 358 Creating the package on Linux 358 Creating the package on Windows 358 Content of the created package 359 How to Read the Metadefender Core Log? 359 Files 359 Format 359 Severity levels of log entries 360 Inaccessible Management Console 360 How to detect 360 Solution 360 Possible Issues on Nodes 361 Q. Node detected 3rd party product on system 361 Q. There is no scan node connected 361 Too Many Sockets or Files Open 362 How to detect 362 Solution 362 Too Many TIME_WAIT Socket 363 How to detect 363 Solution 363 Technical Insights 364 10. Release notes 365 10.1. Archived release notes 365 Version v4.14.0 365 Version v4.13.2 366 Version v4.13.1 366 Version v4.13.0 366 Version v4.12.2 367 Version v4.12.1 367 Version v4.12.0 367 Version v4.11.3 368 Version v4.11.2 368 Version v4.11.1 368 Version v4.11.0 369 Version v4.10.2 369 Version v4.10.1 369 Version v4.10.0 370 Version 4.9.1 371 Version 4.9.0 371 Version 4.8.2 372 Version 4.8.1 372 Version 4.7.2 373 Version 4.7.1 374 Version 4.6.3 374 Version 4.6.2 375 Version 4.6.1 375 Version 4.6.0 375 Version 4.5.1 376 Version 4.5.0 377 Version 4.4.1 377 Version 4.3.0 378 Version 4.2.0 379 Version 4.1.0 379 Version 4.0.1 380 Version 4.0.0 380 11. Metadefender / Client 381 About This Guide 381 Key Features of MetaDefender Client 381 Supported Operating Systems 381 1. MetaDefender Client Packages 382 MetaDefender Free Client 382 MetaDefender Premium Client 382 2. MetaDefender Premium Client 383 2.1 Install using the Install Wizard 383 2.2 Install using the Command Line 385 2.3 Using the MetaDefender Premium Client 386 2.4 Configuring through the config file 401 2.5 Configuring through Central Management 408 3. MetaDefender Free Client 413 4. Command Line Interface 413 Example: 413 Command Line Options 413 4.1 Generating and using the Administrator Password 417 5. MetaDefender Client Release Notes 419 Tips and Known Issues 419 5.1. Archived MetaDefender Client Release Notes 420 12. Legal 434 Copyright 434 DISCLAIMER OF WARRANTY 434 COPYRIGHT NOTICE 434 Export Classification EAR99 434 13. Knowledge Base Articles 435 Are MetaDefender Core v4 upgrades free? 436 Are there any dependencies that need to be fulfilled for MetaDefender Core v4 engines ? 437 Does Metadefender Core v4 offer real-time antivirus protection on the system where it is installed? 437 Does MetaDefender Core v4 Detect the NotPetya Ransomware? 438 Does the fixing updates for Meltdown and Spectre vulnerabilities affect any engines in MetaDefender Core v4? 440 External scanners in MetaDefender core v4.8.0 and above 441 How can I configure the maximum queue size in Metadefender Core v4 ? 443 How can I find a sanitized file scanned with MetaDefender Core v4? 444 How can I increase the scaling up performance? 445 How can I upgrade from Core v4.7.0/v4.7.1 to a newer Core v4.7 release 447 How can the TEMP folder be changed? 448 How do I collect verbose debug packages on MetaDefender Core v4 for Linux? 449 How do I deploy MetaDefender Core v4 to an offline Linux environment? 450 Installing MetaDefender Core 450 Activate your license 451 Installing the MetaDefender Update Downloader utility 452 Applying offline updates 454 Contacting OPSWAT Support 455 How do I deploy MetaDefender Core v4 to an offline Windows environment? 455 Installing MetaDefender Core 456 Activate your license 456 Installing the MetaDefender Update Downloader utility 457 Applying offline updates 459 Contacting OPSWAT Support 460 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? 460 How do I remove an engine from my MetaDefender v4 instance? 462 How do I use MetaDefender Core v4 Workflows ? 462 Defining and administering Workflow Templates in MetaDefender Core v4 463 How long is the support life cycle for a specific version/release of MetaDefender Core v4? 464 How to transfer your Metadefender Core v4 scan history database 466 Is action needed because Metadefender v4's AVG license is expiring on 2018-06-15? 467 What do I need to do? 467 What if I don't take action by June 15, 2018? 468 Why is the license for AVG expiring? 468 What if I need more assistance from OPSWAT on this topic? 468 Is Metadefender Core compromised while scanning files? 468 Is there a virus test I could use to test MetaDefender Core v4? 468 MetaDefender Core v4 shows a large number of files that failed to scan. What can I do? 469 Post actions in MetaDefender core V4.8.0 and above 470 Queue mechanism on Metadefender Core v4 472 Queue mechanism in general 472 Queue size for requests 472 Limit of concurrent connections 472 Max file size allowed 473 Using MetaDefender core V4 BLACKLIST/WHITELIST feature 473 Using filetype groups VS.