Metadefender Core V4.18.0
Total Page:16
File Type:pdf, Size:1020Kb
MetaDefender Core v4.18.0 © 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 14 Key Features of MetaDefender Core 15 1. Quick Start with MetaDefender Core 16 1.1. Installation 16 Operating system invariant initial steps 16 Basic setup 17 1.1.1. Configuration wizard 17 1.2. License Activation 22 1.3. Process Files with MetaDefender Core 22 2. Installing or Upgrading MetaDefender Core 23 2.1. Recommended System Configuration 23 Microsoft Windows Deployments 23 Unix Based Deployments 25 Data Retention 27 Custom Engines 28 Browser Requirements for the Metadefender Core Management Console 28 2.2. Installing MetaDefender 28 Installation 28 Installation notes 28 2.2.1. Installing Metadefender Core using command line 29 2.2.2. Installing Metadefender Core using the Install Wizard 32 2.3. Upgrading MetaDefender Core 32 Upgrading from MetaDefender Core 3.x 32 Upgrading from MetaDefender Core 4.x 32 2.4. MetaDefender Core Licensing 33 2.4.1. Activating Metadefender Licenses 33 2.4.2. Checking Your Metadefender Core License 38 2.5. Performance and Load Estimation 39 What to know before reading the results: Some factors that affect performance 39 How test results are calculated 40 Test Reports 40 Performance Report - Multi-Scanning On Linux 40 Performance Report - Multi-Scanning On Windows 44 2.6. Special installation options 47 Use RAMDISK for the tempdirectory 47 3. Configuring MetaDefender Core 51 3.1. Management Console 51 3.1.1. Password Recovery 52 3.2. MetaDefender Configuration 59 3.2.1. Startup Core Configuration 60 3.2.2. Startup Node Configuration 69 3.2.3 Nginx related configuration (for API Rate Limiting) 76 3.3. User management 78 3.3.1. Users and groups 78 3.3.2. Roles 83 3.3.3. User directories 88 3.3.4. Active Directory attributes 95 3.3.5. Change user password 98 3.3.6. Single Sign-On (SSO) 99 3.4. Update settings 122 Internet 123 Folder 124 Manual 124 3.5. Clean up scan database 125 Technology Note: 125 3.6. Policy configuration 125 3.6.1. How MetaDefender Core policies work 126 3.6.2. Workflow template configuration 126 3.6.3. Security zone configuration 140 3.6.4. Workflow rule configuration 141 3.6.5. Quarantine 146 3.7. Logging 154 3.7.1. Configuration 154 3.7.2 Log message format 155 3.7.3 Syslog message format 156 3.7.4 Error Message Description Table 160 3.8 Security settings on web console 201 3.8.1 Enabling HTTPS 201 3.8.2 Session timeout 205 3.8.3 Password Policy 206 3.9. Configuring proxy settings 207 How can I set proxy server for the product 207 3.10. External Scanners And Post Actions 208 External Scanners 208 Post Actions 211 3.11. Yara rule sources 213 3.12. Configuring mail settings 216 Server configuration 216 User authentication 217 4. Process files with MetaDefender Core 218 Process Files via REST API 218 Process Files via Web Interface 218 Choose what to process and how 219 5. Deep CDR (Data Sanitization) 220 6. Proactive DLP 222 Detect and then block approach 222 Prevent and then allow approach 222 6.1 Detect sensitive information 222 Sensitive Data 222 Certainty score 223 Supported File Types 223 Optical Character Recognition (OCR) 224 Sample regular expressions 226 6.2 Redact sensitive information 230 Supported File Types 230 Supported Sensitive Information 231 To set redaction 231 6.3 Remove metadata 233 Supported File Types 233 To set remove metadata 233 6.4 Watermark files 234 Supported File Types 234 To set watermark 235 7. Operating MetaDefender Core 237 7.1. Dashboard 237 Overview page 238 Processing history 238 Quarantine 239 Update history 239 7.2. Inventory Management 240 7.2.1. Certificates 240 7.2.2. Modules 243 7.2.3. Nodes 253 7.2.4. Skip by hash 255 7.3. Regular Maintenance 257 Checking for Upgrades 257 Checking Engines / Databases Health 257 7.4 Import/Export configuration 258 Export 258 Import 258 Note 259 7.5. Database Defragmentation and Optimization 259 7.6. Reporting 262 7.7. Statistics 264 8. MetaDefender Core Developer Guide 265 How to Interact with MetaDefender Core using REST 265 File scan process 265 8.1. MetaDefender API 265 8.1.1. Sessions 266 8.1.2. Licensing 269 8.1.3. Processing files 274 8.1.4. Processing files in batch 301 8.1.5. Download Sanitized Files 313 8.1.6. Vulnerability Info In Processing Result 315 8.1.7. Skip by hash 318 8.1.8. Get version of components 324 8.1.9. Configuration related APIs 326 8.1.10. Yara 463 8.1.11. Webhooks 470 8.2. MetaDefender API Code Samples 474 10. Advanced MetaDefender Deployment 476 10.1. Scripted license management 476 Requirements 476 Activation steps 476 Deactivation steps 478 Important notes 479 10.2. Deployment automation support 479 Installation 480 Initialization 480 Configuration 485 10.3. Cloud Deployment 485 10.3.1. AWS Deployment 485 10.4. Multi-node deployment 505 Setting up several Metadefender Core nodes 505 10.5. Using external load-balancer 509 10.5.1. HTTP(S) - Layer 7 load balancing 509 10.5.2. DNS load balancing 512 11. Troubleshooting MetaDefender Core 515 Installation issues 515 Issues with nodes 515 Where are the Metadefender Core logs located? 515 How can I create a support package? 515 Issues under high load 515 Debug logging 516 How to Create Support Package? 516 Creating the package on Linux 516 Creating the package on Windows 517 Content of the created package 517 How to Read the Metadefender Core Log? 518 Files 518 Format 518 Severity levels of log entries 518 Inaccessible Management Console 519 How to detect 519 Solution 519 Possible Issues on Nodes 519 Q. Node detected 3rd party product on system 519 Q. There is no scan node connected 520 Too Many Sockets or Files Open 520 How to detect 520 Solution 521 Too Many TIME_WAIT Socket 522 How to detect 522 Solution 522 Technical Insights 523 12. Legal 524 Copyright 524 DISCLAIMER OF WARRANTY 524 COPYRIGHT NOTICE 524 MetaDefender Export Classification 524 12. Release notes 527 12.1 Archived release notes 530 Version v4.17.3 530 Version v4.17.2 533 Version v4.17.1 535 Version v4.17.0.1 536 Version v4.17.0 536 Version v4.16.3 538 Version v4.16.2 538 Version v4.16.1 539 Version v4.16.0 540 Version v4.15.2 540 Version v4.15.1 541 Version v4.15.0 541 Version v4.14.3 542 Version v4.14.2 543 Version v4.14.1 543 Version v4.14.0 544 Version v4.13.2 544 Version v4.13.1 544 Version v4.13.0 545 Version v4.12.2 545 Version v4.12.1 545 Version v4.12.0 546 Version v4.11.3 546 Version v4.11.2 546 Version v4.11.1 547 Version v4.11.0 547 Version v4.10.2 548 Version v4.10.1 548 Version v4.10.0 548 Version 4.9.1 549 Version 4.9.0 550 Version 4.8.2 550 Version 4.8.1 550 Version 4.7.2 552 Version 4.7.1 552 Version 4.6.3 553 Version 4.6.2 553 Version 4.6.1 553 Version 4.6.0 554 Version 4.5.1 555 Version 4.5.0 555 Version 4.4.1 555 Version 4.3.0 556 Version 4.2.0 557 Version 4.1.0 558 Version 4.0.1 558 Version 4.0.0 559 12.2 Proactive DLP Release Notes 559 v2.3.2 559 v2.3.1 559 v2.3.0 559 v2.2.1 560 v2.2 560 v2.1.2 560 v2.1.1 560 v2.1 560 v2.0.1 561 v2.0 561 v1.0.3 561 13. Knowledge Base Articles 562 Are MetaDefender Core v4 upgrades free? 564 Are there any limitations regarding the MetaDefender Core v4 scan engines? 564 Can I control access to the RAM disk in MetaDefender Core v4? 565 Does Metadefender Core v4 offer real-time antivirus protection on the system where it is installed? 565 Does MetaDefender Core v4 Detect the NotPetya Ransomware? 565 Does the fixing updates for Meltdown and Spectre vulnerabilities affect any engines in MetaDefender Core v4? 567 Engine clean-up instructions 568 External scanners in MetaDefender core v4.8.0 and above 571 How can I configure the maximum queue size in Metadefender Core v4 ? 574 How can I find a sanitized file scanned with MetaDefender Core v4? 575 How can I increase the scaling up performance? 575 How can I run tests to see the different scan results on MetaDefender Core v4? 578 How can I upgrade from Core v4.7.0/v4.7.1 to a newer Core v4.7 release 579 How can the TEMP folder be changed? 581 How do I check if "noexec" flag exists on a Linux OS? 582 How do I collect verbose debug packages on MetaDefender Core v4 for Linux? 583 How do I deploy MetaDefender Core v4 to an offline Linux environment? 584 Installing MetaDefender Core 585 Activate your license 585 Installing the MetaDefender Update Downloader utility 587 Applying offline updates 589 Contacting OPSWAT Support 589 How do I deploy MetaDefender Core v4 to an offline Windows environment? 590 Installing MetaDefender Core 590 Activate your license 591 Installing the MetaDefender Update Downloader utility 593 Applying offline updates 595 Contacting OPSWAT Support 596 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? 596 How do I remove an engine from my MetaDefender v4 instance? 598 How do I use MetaDefender Core v4 Workflows ? 598 Defining and administering Workflow Templates in MetaDefender Core v4 599 How long is the support life cycle for a specific version/release of MetaDefender Core v4? 600 How to install MSE on Windows Server 2012 R2 and Windows Server 2016 602 MSE on Windows Server 2012 R2 602 MSE on Windows Server 2016 606 How to transfer your Metadefender Core v4 scan history database 612 Is Metadefender Core compromised while scanning files? 612 Is there a virus test I could use to test MetaDefender Core v4? 613 MetaDefender Core v4 shows a large number of files that failed to scan.