Metadefender Core V4.17.2
Total Page:16
File Type:pdf, Size:1020Kb
MetaDefender Core v4.17.2 © 2020 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 12 Key Features of MetaDefender Core 13 1. Quick Start with MetaDefender Core 14 1.1. Installation 14 Operating system invariant initial steps 14 Basic setup 15 1.1.1. Configuration wizard 15 1.2. License Activation 20 1.3. Process Files with MetaDefender Core 20 2. Installing or Upgrading MetaDefender Core 21 2.1. Recommended System Requirements 21 System Requirements For Server 21 Browser Requirements for the Metadefender Core Management Console 25 2.2. Installing MetaDefender 26 Installation 26 Installation notes 26 2.2.1. Installing Metadefender Core using command line 26 2.2.2. Installing Metadefender Core using the Install Wizard 30 2.3. Upgrading MetaDefender Core 30 Upgrading from MetaDefender Core 3.x 30 Upgrading from MetaDefender Core 4.x 30 2.4. MetaDefender Core Licensing 30 2.4.1. Activating Metadefender Licenses 31 2.4.2. Checking Your Metadefender Core License 36 2.5. Performance and Load Estimation 37 What to know before reading the results: Some factors that affect performance 37 How test results are calculated 38 Test Reports 38 Performance Report - Multi-Scanning On Linux 38 Performance Report - Multi-Scanning On Windows 42 2.6. Special installation options 45 Use RAMDISK for the tempdirectory 45 3. Configuring MetaDefender Core 49 3.1. Management Console 49 3.1.1. Password Recovery 50 3.2. MetaDefender Configuration 57 3.2.1. Startup Core Configuration 58 3.2.2. Startup Node Configuration 62 3.2.3 Nginx related configuration (for API Rate Limiting) 68 3.3. User management 70 3.3.1. Users and groups 70 3.3.2. Roles 75 3.3.3. User directories 80 3.3.4. Active Directory attributes 87 3.3.5. Change user password 90 3.4. Update settings 91 Internet 92 Folder 93 Manual 93 3.5. Clean up scan database 94 Technology Note: 94 3.6. Policy configuration 94 3.6.1. How MetaDefender Core policies work 95 3.6.2. Workflow template configuration 95 3.6.3. Security zone configuration 109 3.6.4. Workflow rule configuration 110 3.6.5. Quarantine 115 3.7. Logging 123 3.7.1. Configuration 123 3.7.2 Log message format 124 3.7.3 Syslog message format 125 3.7.4 Error Message Description Table 129 3.8 Security settings on web console 170 3.8.1 Enabling HTTPS 170 3.8.2 Session timeout 174 3.8.3 Password Policy 175 3.9. Configuring proxy settings 176 How can I set proxy server for the product 176 3.10. External Scanners And Post Actions 177 External Scanners 177 Post Actions 180 3.11. Yara rule sources 182 3.12. Configuring mail settings 185 Server configuration 185 User authentication 186 4. Process files with MetaDefender Core 187 Process Files via REST API 187 Process Files via Web Interface 187 Choose what to process and how 188 5. Deep CDR (Data Sanitization) 189 6. Proactive DLP 190 Detect and then block approach 190 Prevent and then allow approach 190 6.1 Detect sensitive information 190 Sensitive Data 190 Certainty score 191 Supported File Types 191 Sample regular expressions 192 6.2 Redact sensitive information 196 Supported File Types 197 Supported Sensitive Information 197 To set redaction 197 6.3 Remove metadata 199 Supported File Types 199 To set remove metadata 199 6.4 Watermark files 200 Supported File Types 200 To set watermark 201 7. Operating MetaDefender Core 203 7.1. Dashboard 203 Overview page 203 Processing history 204 Quarantine 205 Update history 205 7.2. Inventory Management 206 Certificates 206 Modules 209 Nodes 219 Skip by hash 221 7.3. Regular Maintenance 223 Checking for Upgrades 223 Checking Engines / Databases Health 223 7.4 Import/Export configuration 224 Export 224 Import 224 Note 225 8. MetaDefender Core Developer Guide 226 How to Interact with MetaDefender Core using REST 226 File scan process 226 8.1. MetaDefender API 226 8.1.1. Sessions 227 8.1.2. Licensing 230 8.1.3. Processing files 235 8.1.4. Processing files in batch 259 8.1.5. Download Sanitized Files 271 8.1.6. Vulnerability Info In Processing Result 272 8.1.7. Skip by hash 276 8.1.8. Get version of components 281 8.1.9. Configuration related APIs 284 8.1.10. Yara 412 8.1.11. Webhooks 418 8.2. MetaDefender API Code Samples 423 9. Advanced MetaDefender Deployment 425 9.1. Scripted license management 425 Requirements 425 Activation steps 425 Deactivation steps 427 Important notes 428 9.2. Deployment automation support 428 Installation 429 Initialization 429 Configuration 434 9.3. Cloud Deployment 434 9.3.1. AWS Deployment 434 9.4. Multi-node deployment 454 Setting up several Metadefender Core nodes 454 9.5. Using external load-balancer 458 9.5.1. HTTP(S) - Layer 7 load balancing 458 9.5.2. DNS load balancing 461 10. Troubleshooting MetaDefender Core 464 Installation issues 464 Issues with nodes 464 Where are the Metadefender Core logs located? 464 How can I create a support package? 464 Issues under high load 464 Debug logging 465 How to Create Support Package? 465 Creating the package on Linux 465 Creating the package on Windows 466 Content of the created package 466 How to Read the Metadefender Core Log? 467 Files 467 Format 467 Severity levels of log entries 467 Inaccessible Management Console 468 How to detect 468 Solution 468 Possible Issues on Nodes 468 Q. Node detected 3rd party product on system 468 Q. There is no scan node connected 469 Too Many Sockets or Files Open 469 How to detect 469 Solution 470 Too Many TIME_WAIT Socket 471 How to detect 471 Solution 471 Technical Insights 472 11. Release notes 474 11.1 Archived release notes 477 Version v4.17.1 477 Version v4.17.0.1 478 Version v4.17.0 478 Version v4.16.3 480 Version v4.16.2 480 Version v4.16.1 481 Version v4.16.0 481 Version v4.15.2 482 Version v4.15.1 482 Version v4.15.0 483 Version v4.14.3 484 Version v4.14.2 485 Version v4.14.1 485 Version v4.14.0 485 Version v4.13.2 486 Version v4.13.1 486 Version v4.13.0 486 Version v4.12.2 487 Version v4.12.1 487 Version v4.12.0 487 Version v4.11.3 488 Version v4.11.2 488 Version v4.11.1 489 Version v4.11.0 489 Version v4.10.2 489 Version v4.10.1 490 Version v4.10.0 490 Version 4.9.1 491 Version 4.9.0 491 Version 4.8.2 492 Version 4.8.1 492 Version 4.7.2 493 Version 4.7.1 494 Version 4.6.3 495 Version 4.6.2 495 Version 4.6.1 495 Version 4.6.0 495 Version 4.5.1 497 Version 4.5.0 497 Version 4.4.1 497 Version 4.3.0 498 Version 4.2.0 499 Version 4.1.0 499 Version 4.0.1 500 Version 4.0.0 500 11.2 Proactive DLP Release Notes 501 v2.2.1 501 v2.2 501 v2.1.2 501 v2.1.1 501 v2.1 502 v2.0.1 502 v2.0 502 v1.0.3 502 12. Legal 503 Copyright 503 DISCLAIMER OF WARRANTY 503 COPYRIGHT NOTICE 503 MetaDefender Export Classification 503 13. Knowledge Base Articles 505 Are MetaDefender Core v4 upgrades free? 507 Are there any limitations regarding the MetaDefender Core v4 scan engines? 507 Can I control access to the RAM disk in MetaDefender Core v4? 508 Does Metadefender Core v4 offer real-time antivirus protection on the system where it is installed? 508 Does MetaDefender Core v4 Detect the NotPetya Ransomware? 508 Does the fixing updates for Meltdown and Spectre vulnerabilities affect any engines in MetaDefender Core v4? 510 External scanners in MetaDefender core v4.8.0 and above 511 How can I configure the maximum queue size in Metadefender Core v4 ? 513 How can I find a sanitized file scanned with MetaDefender Core v4? 515 How can I increase the scaling up performance? 515 How can I run tests to see the different scan results on MetaDefender Core v4? 517 How can I upgrade from Core v4.7.0/v4.7.1 to a newer Core v4.7 release 519 How can the TEMP folder be changed? 520 How do I collect verbose debug packages on MetaDefender Core v4 for Linux? 521 How do I deploy MetaDefender Core v4 to an offline Linux environment? 523 Installing MetaDefender Core 523 Activate your license 524 Installing the MetaDefender Update Downloader utility 526 Applying offline updates 528 Contacting OPSWAT Support 528 How do I deploy MetaDefender Core v4 to an offline Windows environment? 529 Installing MetaDefender Core 529 Activate your license 530 Installing the MetaDefender Update Downloader utility 532 Applying offline updates 534 Contacting OPSWAT Support 535 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? 535 How do I remove an engine from my MetaDefender v4 instance? 537 How do I use MetaDefender Core v4 Workflows ? 537 Defining and administering Workflow Templates in MetaDefender Core v4 538 How long is the support life cycle for a specific version/release of MetaDefender Core v4? 539 How to install MSE on Windows Server 2012 R2 and Windows Server 2016 541 MSE on Windows Server 2012 R2 541 MSE on Windows Server 2016 545 How to transfer your Metadefender Core v4 scan history database 551 Is Metadefender Core compromised while scanning files? 551 Is there a virus test I could use to test MetaDefender Core v4? 552 MetaDefender Core v4 shows a large number of files that failed to scan.