Deep Security 20 Administration Guide
Uploaded by
Onik GaziDeep Security 20 Administration Guide
Uploaded by
Onik GaziDeep Security 20 Guide
for On-Premise Installations
Legal notices
Trend Micro Incorporated reserves the right to make changes to this document and to the
products described herein without notice. Before installing and using the software, please review
the release notes and the latest version of the applicable user documentation, which are
available from the Trend Micro Web site at:
https://help.deepsecurity.trendmicro.com/software.html
Trend Micro, and the Trend Micro t-ball logo are trademarks or registered trademarks of Trend
Micro Incorporated. All other company or product names may be trademarks or registered
trademarks of their owners. Information contained in this document is subject to change without
notice.
© 2020 Trend Micro Incorporated. All rights reserved
Protected by U.S. Patent No. 7,630,982 B2.
Privacy Policy
Trend Micro, Inc. is committed to protecting your privacy. Please read the Trend Micro Privacy
Policy available at www.trendmicro.com.
Document Number: APEM209012/200622
Publication Date: 10/5/2020 8:09 PM
Trend Micro Deep Security On-Premise 20
Contents
Legal notices 2
Contents 3
About Deep Security 75
Deep Security 20 release strategy and life cycle policy 75
Supported upgrade paths 75
Deep Security 20 updates 76
LTS release support duration and upgrade best practices 76
Support services 78
Agent platform support policy 79
Deep Security life cycle dates 80
Deep Security LTS life cycle dates 80
Deep Security LTS release life cycle dates 80
Support extensions 81
Archive of past support extensions 83
Deep Security FR life cycle dates 84
Deep Security FR release life cycle dates 85
Support extensions 86
About the Deep Security components 87
About the Deep Security protection modules 87
Intrusion Prevention 88
Anti-Malware 88
Firewall 88
Web Reputation 89
Integrity Monitoring 89
Log Inspection 89
Application Control 89
3
Trend Micro Deep Security On-Premise 20
About billing and pricing 90
Billing methods 90
Metered billing 91
Bring-your-own license (BYOL) 91
Free tier billing 91
AWS subscription billing 91
Azure subscription billing 91
Pay as you Go billing 91
Annual + Pay as you Go 92
Prepaid credit 93
Credit card 93
What Deep Security considers as a protection-hour 93
When protection-hours start and stop 94
About this release 95
What's new? 95
What's new in Deep Security Manager? 95
Deep Security Manager 20 update 2020-09-16 95
New features 95
Improved management and quality 95
Enhancements 96
Resolved issues 96
Security updates 97
Notices 97
Deep Security Manager 20 (long-term support release) 97
Action required if you use cross-account roles to add AWS accounts to Deep
Security using the API /rest/cloudaccounts/aws 97
New features 98
Updated platform support 98
Improved Security 98
4
Trend Micro Deep Security On-Premise 20
Improved management and quality 99
Enhancements 100
Resolved issues 105
Security updates 108
Known issues 109
What's new in Deep Security Agent? 109
Deep Security Agent 20.0.0-1194 (20 LTS Update 2020-10-05) 109
New features 110
Enhancements 110
Resolved issues 110
Security updates 112
Deep Security Agent 20 (long-term support release) 112
New features 112
Enhanced platform support 112
Improved security 113
Improved management and quality 113
Enhancements 115
Resolved issues 116
Security updates 119
Kernel support 120
Known issues 120
Deep Security Agent 20 (long-term support release) 120
New features 120
Improved security 120
Improved quality and management 121
Enhancements 122
Resolved issues 123
Security updates 125
Known issues 125
5
Trend Micro Deep Security On-Premise 20
Upgrade notice 126
Deep Security Agent 20.0.0-1194 (20 LTS Update 2020-10-05) 126
Enhancements 126
Resolved issues 126
Security updates 127
Deep Security Agent 20 (long-term support release) 127
New features 127
Improved security 127
Improved quality and management 127
Enhancements 128
Resolved issues 129
Security updates 132
What's new in Deep Security Virtual Appliance? 132
New features 133
Improved security 133
Improved management and quality 133
Enhancements 133
Resolves issues 134
Known issues 134
Compatibility 135
Deep Security Agent platforms 135
Agent platform support table 135
Docker support 139
Systemd support 140
SELinux support 142
Secure Boot support 142
Deep Security Agent Linux kernel support 143
Supported features by platform 145
Microsoft Windows 146
6
Trend Micro Deep Security On-Premise 20
Red Hat Enterprise Linux 151
CentOS Linux 152
Oracle Linux 153
SUSE Linux 154
Ubuntu Linux 155
Debian Linux 156
CloudLinux 157
Amazon Linux 158
Solaris 158
AIX 159
Deep Security Virtual Appliance 20 (NSX) supported guest OS's 160
System requirements 165
Deep Security Manager requirements 166
Deep Security Agent requirements 168
Deep Security Relay requirements 169
Deep Security Virtual Appliance requirements 169
Sizing 172
Deep Security Manager sizing 172
Multiple server nodes 173
Database sizing 173
Database disk space estimates 174
Deep Security Agent and Relay sizing 175
Deep Security Virtual Appliance sizing 176
Port numbers, URLs, and IP addresses 178
Deep Security port numbers 179
Deep Security URLs 184
Deep Security Manager performance features 194
Performance profiles 194
Low disk space alerts 194
7
Trend Micro Deep Security On-Premise 20
Low disk space on the database 194
Low disk space on the manager 195
Get Started 196
Check digital signatures on software packages 196
Check the signature on software ZIP packages 196
Check the signature on installer files (EXE, MSI, RPM or DEB files) 198
Check the signature on an EXE or MSI file 199
Check the signature on an RPM file 199
Check the signature on a DEB file 201
Deploy Deep Security Manager 203
Prepare a database 203
Database requirements 203
Software requirements 203
Microsoft SQL Server Express considerations 204
Hardware requirements 205
Network requirements 205
VMware requirements 206
Scaling requirements 206
Install a database server 206
Configure the database 206
Basic configuration 207
Multi-tenancy configuration 207
Optional PostgreSQL tuning 207
Basic configuration 207
Multi-tenancy configuration 208
Basic configuration 208
Oracle RAC configuration 209
Multi-tenancy configuration 209
Run a readiness check 210
8
Trend Micro Deep Security On-Premise 20
Install Deep Security Manager 210
Before you begin 211
Install the manager 211
Test the installation (log in to the manager) 215
Replace the self-signed certificate 215
Install Deep Security Manager silently 215
Before you begin 216
Run a silent install on Windows 216
Run a silent install on Linux 216
Silent install parameters 216
Sample installation output 217
Successful install 218
Failed install 219
Deep Security settings in the properties file 219
Required Settings 219
LicenseScreen 219
CredentialsScreen 220
Optional Settings 220
LanguageScreen 220
UpgradeVerificationScreen 220
OldDataMigrationScreen 220
DatabaseScreen 221
AddressAndPortsScreen 223
CredentialsScreen 224
MasterKeyConfigurationScreen 224
SecurityUpdateScreen 225
SoftwareUpdateScreen 225
SmartProtectionNetworkScreen 226
RelayScreen 227
9
Trend Micro Deep Security On-Premise 20
Sample properties file 228
Add activation codes 229
Set up multi-tenancy 229
Set up a multi-tenant environment 229
Multi-tenancy requirements 230
Enable multi-tenancy 231
Create a tenant 231
Examples of messages sent to tenants 233
Email Confirmation Link: Account Confirmation Request 233
Email Generated Password 233
Scalability guidelines 234
Multi-tenancy tips 234
Reconnaissance IP list 234
Use multiple database servers 234
Tenant pending deletion state 234
Multi-tenant options under System Settings 235
Managing tenants 235
Tenant Properties 235
General 235
Modules 236
Features 236
Statistics 236
Agent Activation 237
What does the tenant see? 237
Agent-Initiated Activation 238
Tenant diagnostics 239
Usage monitoring 239
Multi-tenant Dashboard 239
Multi-tenant reports 240
10
Trend Micro Deep Security On-Premise 20
Security Module Usage Cumulative Report 240
Security Module Usage Report 240
Tenant Report 241
Configure database user accounts 241
Configuring database user accounts 241
SQL Server 242
Oracle 246
PostgreSQL 249
Configuring multiple database servers 250
Removing or changing secondary databases 250
APIs 250
Upgrade a multi-tenant environment 251
Supporting tenants 252
Multi-tenancy with Deep Security Virtual Appliance 252
Multi-tenant settings 253
Database servers 255
New tenant template 255
Protection usage monitoring 257
Set up multiple nodes 257
Install Deep Security Manager on multiple nodes 257
Set up a load balancer 258
Configure the load balancer in Deep Security 258
Add a node 259
Remove a node 260
Upgrade a node 260
Viewing node statuses 260
Network Map with Activity Graph 260
Jobs by Node 261
Jobs by Type 262
11
Trend Micro Deep Security On-Premise 20
Total jobs by node and type 262
View active Deep Security Manager nodes 263
Deploy Deep Security Relay 265
Deploy Deep Security Agent 266
Get Deep Security Agent software 266
View agent software available for download 267
View a list of imported agent software 267
Import agent software 268
Import agent software directly, from the Download Center 268
Import agent software indirectly, from the Help Center 269
Import agent software updates automatically 269
Export the agent installer 270
Solaris-version-to-agent-package mapping table 271
AIX agent package naming format 271
Delete a software package from the Deep Security database 272
Deleting agent packages in single-tenancy mode 272
Deleting agent packages in multi-tenancy mode 272
Deleting kernel support packages 273
Install the agent 273
Install the agent manually 273
Installation on Amazon WorkSpaces 274
Installation on Windows 2012 Server Core 274
Install the agent using other methods 278
Post-installation tasks 279
Install the agent on Amazon EC2 and WorkSpaces 279
Add your AWS accounts to Deep Security Manager 280
Set the communication direction 280
Configure the activation type 281
Open ports 282
12
Trend Micro Deep Security On-Premise 20
Which ports should be opened? 282
Deploy agents to your Amazon EC2 instances and WorkSpaces 283
Verify that the agent was installed and activated properly 284
Assign a policy 284
Install the agent on an AMI or WorkSpace bundle 285
Add your AWS account to Deep Security Manager 285
Set the communication direction 286
Configure the activation type 286
Launch a 'master' Amazon EC2 instance or Amazon WorkSpace 286
Deploy an agent on the master 286
Verify that the agent was installed and activated properly 287
(Recommended) Set up policy auto-assignment 287
Create an AMI or custom WorkSpace bundle based on the master 288
Use the AMI 288
Install the agent on Azure VMs 289
Install the agent on Google Cloud Platform VMs 289
Install the agent on VMware vCloud 291
Create a minimum rights role for vCloud account tenant users 292
Assign unique UUIDs to new virtual machines 292
Enable the OVF Environment Transport for VMware Tools on your guest VMs 293
Import computers from a VMware vCloud Organization account 293
Import computers from a VMware vCloud Air Virtual data center 294
Activate the agent 295
Deactivate the agent 296
Start or stop the agent 297
Deploy Deep Security Virtual Appliance 297
Protection for VMware environments 297
Deep Security Virtual Appliance features 298
Scan caching 298
13
Trend Micro Deep Security On-Premise 20
Scan storm optimization 298
Ease of management 298
VMware deployments with the virtual appliance and NSX 299
VMware deployments with the agent only 301
Additional information 301
Choose agentless vs. combined mode protection 302
Agentless protection 302
Combined mode 302
Conversion of coordinated approach to combined mode 303
Choose an agent or appliance for each protection feature 303
Enable combined mode in a vCloud Director environment with agent-initiated
activation 304
Before deploying the appliance 305
Review system requirements 305
Install or upgrade NSX, Deep Security Manager and other components 305
Re-register NSX-T 305
Set up communication 306
(Optional) Install Deep Security Agents 306
(Optional) Configure high-availability 307
Next steps 307
Configure VMware DRS 307
Deploy the appliance (NSX-T 3.x) 308
Import the appliance 308
Prepare Fabric settings 309
Configure the User Interface Mode Toggle 309
Configure a Compute Manager 310
Configure a Transport Zone 311
Configure a Transport Node Profile 312
Prepare the host 314
14
Trend Micro Deep Security On-Premise 20
Create a logical switch 316
Add vCenter to Deep Security Manager 318
Install the appliance on NSX-T 3.x 319
Begin the service deployment 319
Configure and start the service deployment 320
Set the Service Deployment Name 320
Set the Compute Manager 320
Set the Cluster 320
Set the Data Store 320
Set the Networks 320
Set the Deployment Specification 321
Set the Service Segment 322
Set the Deployment template 323
Monitor and verify the deployment 323
Monitor the deployment in NSX-T 3.x 324
Monitor the deployment in vSphere Client 324
Verify the deployment in Deep Security Manager 325
Repeat all steps for each cluster 325
Create a group for protection 325
Configure east-west security 327
Add a service profile 327
Add a service chain 328
Add a Network Introspection policy 330
Connect VMs to the logical switch 331
Configure Endpoint Protection 331
Prepare for activation 333
Method 1: Create a 'Computer Created' event-based task 335
Method 2: Create an 'NSX Security Group Change' event-based task 335
Method 3: Synchronize your Deep Security policies to NSX-T 3.x 337
15
Trend Micro Deep Security On-Premise 20
Trigger an activation and policy assignment 339
Check that VMs are activated and assigned a policy 339
Next steps (how to add new VMs) 340
Deploy the appliance (NSX-V) 341
Step 1: Import the appliance package into Deep Security Manager 341
Step 2: Add vCenter to Deep Security Manager 342
Step 3: Prepare ESXi servers 342
Step 4: Install Guest Introspection 344
Step 5: Install the Deep Security Virtual Appliance on NSX-V 347
Step 6: Create an NSX security group and policy 348
Step 7: Prepare for activation on NSX-V 356
Method 1: Create a 'Computer Created' event-based task 357
Method 2: Create an 'NSX Security Group Change' event-based task 358
Method 3: Synchronize your Deep Security policies to NSX-V 361
Step 8: Trigger an activation and policy assignment 362
Step 9: Check that VMs are activated and assigned a policy 363
Next steps (how to add new VMs) 363
Deploy the appliance in a vCloud environment 364
Before you begin 364
Enable agentless protection of vCloud VMs 364
Create a multi-tenant environment 364
Add a vCenter and deploy the Deep Security Virtual Appliance 365
Configure VMware vCloud resources for integration with Deep Security 365
Create a minimum rights role for vCloud account tenant users 365
Assign unique UUIDs to new virtual machines 366
Enable the OVF Environment Transport for VMware Tools on your guest VMs 366
Activate virtual appliance protection on virtual machines 366
Import computers from a VMware vCloud Organization Account 367
Import computers from a VMware vCloud Air Virtual data center 367
16
Trend Micro Deep Security On-Premise 20
Activate virtual appliance protection on virtual machines 368
Automated policy management in NSX environments 368
"NSX Security Group Change" event-based task 369
Conditions under which to perform tasks 369
Available actions 370
Event-based tasks created when adding a vCenter to Deep Security Manager 371
Removal of a vCenter from Deep Security Manager 372
Synchronize Deep Security policies with NSX 373
Configure DPDK mode 374
Configure NSX security tags 376
Configure Anti-Malware to apply NSX security tags 376
Configure Intrusion Prevention to apply NSX security tags 377
Configure the appliance OVF location 378
Deep Security Virtual Appliance memory allocation 380
Configure the appliance's memory allocation prior to deployment to the vCenter 380
Configure the memory allocation of an already-deployed appliance 381
Start or stop the appliance 382
Deploy Deep Security Notifier 382
Copy the Installation Package 382
Install the Deep Security Notifier for Windows 383
User Guide 383
Add computers 383
About adding computers 383
Add computers to the manager 384
Group computers 384
Export your computers list 384
Delete a computer 385
Add local network computers 385
Agent-initiated activation 385
17
Trend Micro Deep Security On-Premise 20
Manually add a computer 385
Discover computers 386
Add Active Directory computers 388
Additional Active Directory options 389
Remove Directory 389
Synchronize Now 390
Server certificate usage 390
Import users and contacts 390
Keep Active Directory objects synchronized 391
Disable Active Directory synchronization 392
Remove computer groups from Active Directory synchronization 392
Delete Active Directory users and contacts 393
Add AWS instances 393
About adding AWS accounts 393
Overview of methods for adding AWS accounts 393
What happens when you add an AWS account? 393
What are the benefits of adding an AWS account? 394
What AWS regions are supported? 394
Add an AWS account using a manager instance role 395
Add an AWS account using an access key 398
Add an AWS account using a cross-account role 401
Add the account through the API 406
Add Amazon WorkSpaces 406
Protect Amazon WorkSpaces if you already added your AWS account 406
Protect Amazon WorkSpaces if you have not yet added your AWS account 407
Manage an AWS account 407
Edit an AWS account 408
Remove an AWS account 408
Synchronize an AWS account 408
18
Trend Micro Deep Security On-Premise 20
Manage an AWS account external ID 409
What is the external ID? 409
Configure the external ID 409
Update the external ID 409
Retrieve the external ID 411
Disable retrieval of the external ID 411
Manage AWS regions 412
Add an Amazon Web Services region 412
Viewing your Amazon Web Services regions 413
Removing an Amazon Web Services region 413
Protect an account running in AWS Outposts 413
Add Azure instances 414
Create an Azure app for Deep Security 414
Assign the correct roles 414
Create the Azure app 415
Record the Azure app ID, Active Directory ID, and password 415
Record the Subscription ID(s) 416
Assign the Azure app a role and connector 416
Add a Microsoft Azure account to Deep Security 416
What are the benefits of adding an Azure account? 417
Configure a proxy setting for the Azure account 417
Add virtual machines from a Microsoft Azure account to Deep Security 417
Manage Azure classic virtual machines with the Azure Resource Manager
connector 418
Remove an Azure account 419
Synchronize an Azure account 419
Why should I upgrade to the new Azure Resource Manager connection
functionality? 419
Add GCP instances 420
Create a Google Cloud Platform service account 420
19
Trend Micro Deep Security On-Premise 20
Prerequisite: Enable the Google APIs 420
Create a GCP service account 421
Add more projects to the GCP service account 426
Create multiple GCP service accounts 429
Add a Google Cloud Platform account 429
What are the benefits of adding a GCP account? 430
Configure a proxy setting for the GCP account 430
Add a GCP account to Deep Security 430
Remove a GCP account 432
Synchronize a GCP account 433
Add VMWare VMs 433
Add a VMware vCenter 433
Add a vCenter 434
vCenter user account specifications 434
NSX user account specifications 437
Add multiple vCenters 438
Add a vCenter - FIPS mode 438
Add virtual machines hosted on VMware vCloud 439
What are the benefits of adding a vCloud account? 440
Proxy setting for cloud accounts 440
Create a VMware vCloud Organization account for the manager 440
Import computers from a VMware vCloud Organization Account 441
Import computers from a VMware vCloud Air data center 441
Configure software updates for cloud accounts 442
Remove a cloud account 442
Add an ESXi to a protected NSX cluster 443
How do I migrate to the new cloud connector functionality? 443
Protect Docker containers 445
Deep Security protection for the Docker host 446
20
Trend Micro Deep Security On-Premise 20
Deep Security protection for Docker containers 446
Limitation on Intrusion Prevention recommendation scans 446
Configure policies 447
Create policies 447
Create a new policy 447
Other ways to create a policy 448
Edit the settings for a policy or individual computer 449
Assign a policy to a computer 449
Disable automatic policy updates 450
Send policy changes manually 450
Export a policy 451
Policies, inheritance, and overrides 451
Inheritance 452
Overrides 453
Override object properties 454
Override rule assignments 455
View the overrides on a computer or policy at a glance 455
Manage and run recommendation scans 456
What gets scanned? 457
Scan limitations 458
Run a recommendation scan 459
Create a scheduled task to regularly run recommendation scans 460
Configure an ongoing scan 460
Manually run a recommendation scan 461
Cancel a recommendation scan 461
Exclude a rule or application type from recommendation scans 461
Automatically implement recommendations 462
Check scan results and manually assign rules 463
Configure recommended rules 464
21
Trend Micro Deep Security On-Premise 20
Implement additional rules for common vulnerabilities 464
Troubleshooting: Recommendation Scan Failure 466
Communication 466
Server resources 466
Timeout values 466
Detect and configure the interfaces available on a computer 467
Configure a policy for multiple interfaces 467
Enforce interface isolation 468
Overview section of the computer editor 468
General tab 468
Computer status 470
Protection module status 470
VMware virtual machine summary 472
Actions tab 472
Activation 472
Policy 472
Agent Software 472
Support 473
TPM tab 473
System Events tab 474
Overview section of the policy editor 474
General tab 474
General 474
Inheritance 474
Modules 474
Computer(s) Using This Policy tab 475
Events tab 475
Network engine settings 475
Define rules, lists, and other common objects used by policies 485
22
Trend Micro Deep Security On-Premise 20
About common objects 485
Rules 485
Lists 486
Other 486
Create a firewall rule 486
Add a new rule 487
Select the behavior and protocol of the rule 487
Select a Packet Source and Packet Destination 489
Configure rule events and alerts 491
Alerts 491
Set a schedule for the rule 491
Assign a context to the rule 491
See policies and computers a rule is assigned to 491
Export a rule 492
Delete a rule 492
Configure intrusion prevention rules 492
See the list of intrusion prevention rules 493
See information about an intrusion prevention rule 493
General Information 493
Details 493
See the list of intrusion prevention rules 494
General Information 494
Identification (Trend Micro rules only) 495
See information about the associated vulnerability (Trend Micro rules only) 495
Assign and unassign rules 495
Automatically assign updated required rules 496
Configure event logging for rules 496
Generate alerts 497
Setting configuration options (Trend Micro rules only) 497
23
Trend Micro Deep Security On-Premise 20
Schedule active times 498
Exclude from recommendations 499
Set the context for a rule 499
Override the behavior mode for a rule 499
Override rule and application type configurations 500
Export and import rules 501
Create an Integrity Monitoring rule 501
Add a new rule 502
Enter Integrity Monitoring rule information 502
Select a rule template and define rule attributes 502
Registry Value template 502
File template 503
Custom (XML) template 503
Configure Trend Micro Integrity Monitoring rules 503
Configure rule events and alerts 504
Real-time event monitoring 504
Alerts 504
See policies and computers a rule is assigned to 505
Export a rule 505
Delete a rule 505
Define a Log Inspection rule for use in policies 505
Create a new Log Inspection rule 506
Decoders 508
Subrules 509
Groups 509
Rules, ID, and Level 510
Description 511
Decoded As 511
Match 512
24
Trend Micro Deep Security On-Premise 20
Conditional Statements 513
Hierarchy of Evaluation 513
Restrictions on the Size of the Log Entry 514
Composite Rules 515
Real world examples 517
Log Inspection rule severity levels and their recommended use 525
strftime() conversion specifiers 526
Examine a Log Inspection rule 527
Log Inspection rule structure and the event matching process 527
Duplicate Sub-rules 530
Create a list of directories for use in policies 531
Import and export directory lists 533
See which policies use a directory list 533
Create a list of file extensions for use in policies 533
Import and export file extension lists 534
See which malware scan configurations use a file extension list 534
Create a list of files for use in policies 534
Import and export file lists 537
See which policies use a file list 537
Create a list of IP addresses for use in policies 537
Import and export IP lists 537
See which rules use an IP list 538
Create a list of ports for use in policies 538
Import and export port lists 538
See which rules use a port list 539
Create a list of MAC addresses for use in policies 539
Import and export MAC lists 539
See which policies use a MAC list 540
Define contexts for use in policies 540
25
Trend Micro Deep Security On-Premise 20
Configure settings used to determine whether a computer has internet connectivity540
Define a context 540
Define stateful firewall configurations 541
Add a stateful configuration 542
Enter stateful configuration information 542
Select packet inspection options 542
IP packet inspection 542
TCP packet inspection 543
FTP Options 544
UDP packet inspection 545
ICMP packet inspection 545
Export a stateful configuration 546
Delete a stateful configuration 546
See policies and computers a stateful configuration is assigned to 546
Define a schedule that you can apply to rules 546
Configure protection modules 547
Configure Anti-Malware 547
About Anti-Malware 547
Types of malware scans 548
Real-time scan 548
Manual scan 548
Scheduled scan 548
Quick scan 549
Scan objects and sequence 549
Malware scan configurations 549
Malware events 550
SmartScan 550
Predictive Machine Learning 551
Connected Threat Defense 551
26
Trend Micro Deep Security On-Premise 20
Malware types 552
Virus 552
Trojans 552
Packer 553
Spyware/grayware 553
Cookie 554
Other threats 554
Possible malware 554
Set up Anti-Malware 554
Enable and configure anti-malware 554
Turn on the anti-malware module 555
Select the types of scans to perform 555
Configure scan exclusions 556
Ensure that Deep Security can keep up to date on the latest threats 556
Configure malware scans 557
Create or edit a malware scan configuration 558
Test malware scans 559
Scan for specific types of malware 559
Scan for spyware and grayware 560
Scan for compressed executable files (real-time scans only) 560
Scan process memory (real-time scans only) 561
Scan compressed files 561
Scan embedded Microsoft Office objects 561
Specify the files to scan 562
Inclusions 562
Exclusions 563
Test file exclusions 563
Syntax for directory lists 564
Syntax of file lists 565
27
Trend Micro Deep Security On-Premise 20
Syntax of file extension lists 567
Syntax of process image file lists (real-time scans only): 567
Scan a network directory (real-time scan only) 568
Specify when real-time scans occur 568
Configure how to handle malware 568
Customize malware remedial actions 568
ActiveAction actions 570
Generate alerts for malware detection 571
Apply NSX security tags 571
Identify malware files by file hash digest 571
Configure notifications on the computer 572
Performance tips for anti-malware 572
Minimize disk usage 572
Optimize CPU usage 573
Optimize RAM usage 574
Disable Windows Defender after installing Deep Security anti-malware on
Windows Server 2016 575
Installing the Anti-Malware module when Windows Defender is already disabled575
Virtual Appliance Scan Caching 575
Scan Cache Configurations 576
Malware Scan Cache Configuration 577
Integrity Monitoring Scan Cache Configuration 577
Scan Cache Settings 577
When to change the default configuration 578
Detect emerging threats using Predictive Machine Learning 578
Ensure Internet connectivity 579
Enable Predictive Machine Learning 579
Detect emerging threats using Connected Threat Defense 580
How does Connected Threat Defense work? 580
28
Trend Micro Deep Security On-Premise 20
Check the Connected Threat Defense prerequisites 581
Set up the connection to Deep Discovery Analyzer 581
Set up the connection to Trend Micro Apex Central 583
Set up the connection if Trend Micro Apex Central is already managing Deep
Security 583
Set up the connection if Trend Micro Apex Central is not yet managing Deep
Security 584
Create a malware scan configuration for use with Connected Threat Defense 585
Enable Connected Threat Defense for your computers 586
Manually submit a file to Deep Discovery for analysis 586
Allow a file that has raised a false alarm 586
Configure the scan action for a suspicious file 587
Update the suspicious objects list in Deep Security 587
Configure Connected Threat Defense in a multi-tenant environment 588
Supported file types 588
Enhanced anti-malware and ransomware scanning with behavior monitoring 589
How does enhanced scanning protect you? 589
How to enable enhanced scanning 590
What happens when enhanced scanning finds a problem? 591
What if my agents can't connect to the Internet directly? 596
Smart Protection in Deep Security 596
Anti-malware and Smart Protection 596
Enable Smart Scan 596
Smart Protection Server for File Reputation Service 597
Web Reputation and Smart Protection 598
Smart Feedback 599
Handle malware 599
View and restore identified malware 599
See a list of identified files 600
Working with identified files 601
29
Trend Micro Deep Security On-Premise 20
Search for an identified file 602
Restore identified files 603
Create a scan exclusion for the file 603
Restore the file 606
Manually restore identified files 606
Create anti-malware exceptions 606
Create an exception from an anti-malware event 607
Manually create an anti-malware exception 607
Exception strategies for spyware and grayware 608
Scan exclusion recommendations 608
Increase debug logging for anti-malware in protected Linux instances 609
Configure Web Reputation 610
Turn on the web reputation module 611
Switch between inline and tap mode 611
Enforce the security level 611
To configure the security level: 612
Create exceptions 612
To create URL exceptions: 612
Configure the Smart Protection Server 613
Smart Protection Server Connection Warning 614
Edit advanced settings 615
Blocking Page 615
Alert 615
Ports 615
Test Web Reputation 615
Configure Intrusion Prevention (IPS) 615
About Intrusion Prevention 615
Intrusion Prevention rules 616
Application types 616
30
Trend Micro Deep Security On-Premise 20
Rule updates 617
Recommendation scans 617
Use behavior modes to test rules 617
Override the behavior mode for rules 618
Intrusion Prevention events 618
Support for secure connections 619
Contexts 619
Interface tagging 619
Set up Intrusion Prevention 619
Enable Intrusion Prevention in Detect mode 620
Test Intrusion Prevention 622
Apply recommended rules 623
Monitor your system 624
Monitor system performance 624
Check Intrusion Prevention events 625
Enable 'fail open' for packet or system failures 625
Switch to Prevent mode 625
Implement best practices for specific rules 625
HTTP Protocol Decoding rule 625
Cross-site scripting and generic SQL injection rules 626
Apply NSX security tags 626
Configure intrusion prevention rules 626
See the list of intrusion prevention rules 627
See information about an intrusion prevention rule 627
General Information 628
Details 628
See the list of intrusion prevention rules 628
General Information 629
Identification (Trend Micro rules only) 629
31
Trend Micro Deep Security On-Premise 20
See information about the associated vulnerability (Trend Micro rules only) 629
Assign and unassign rules 630
Automatically assign updated required rules 630
Configure event logging for rules 631
Generate alerts 632
Setting configuration options (Trend Micro rules only) 632
Schedule active times 632
Exclude from recommendations 633
Set the context for a rule 633
Override the behavior mode for a rule 634
Override rule and application type configurations 634
Export and import rules 635
Configure an SQL injection prevention rule 635
What is an SQL injection attack? 636
What are common characters and strings used in SQL injection attacks? 636
How does the Generic SQL Injection Prevention rule work? 638
Examples of the rule and scoring system in action 639
Example 1: Logged and dropped traffic 639
Example 2: No logged or dropped traffic 640
Configure the Generic SQL Injection Prevention rule 641
Character encoding guidelines 644
Application types 646
See a list of application types 646
General Information 647
Connection 647
Configuration 647
Options 647
Assigned To 647
Inspect SSL or TLS traffic 648
32
Trend Micro Deep Security On-Premise 20
Configure SSL inspection 648
Change port settings 649
Use Intrusion Prevention when traffic is encrypted with Perfect Forward Secrecy
(PFS) 650
Special considerations for Diffie-Hellman ciphers 650
Supported cipher suites 651
Supported protocols 652
Configure anti-evasion settings 652
Performance tips for intrusion prevention 655
Maximum size for configuration packages 656
Configure Firewall 657
About Firewall 657
Firewall rules 657
Set up the Deep Security firewall 658
Test Firewall rules before deploying them 659
Test in Tap mode 659
Test in Inline mode 660
Enable 'fail open' behavior 660
Turn on Firewall 662
Default Firewall rules 662
Default Bypass rule for Deep Security Manager Traffic 663
Restrictive or permissive Firewall design 664
Restrictive Firewall 664
Permissive Firewall 664
Firewall rule actions 664
Firewall rule priorities 665
Allow rules 666
Force Allow rules 666
Bypass rules 666
33
Trend Micro Deep Security On-Premise 20
Recommended Firewall policy rules 666
Test Firewall rules 667
Reconnaissance scans 668
Stateful inspection 669
Example 669
Important things to remember 670
Create a firewall rule 671
Add a new rule 672
Select the behavior and protocol of the rule 672
Select a Packet Source and Packet Destination 674
Configure rule events and alerts 676
Alerts 676
Set a schedule for the rule 676
Assign a context to the rule 676
See policies and computers a rule is assigned to 676
Export a rule 677
Delete a rule 677
Allow trusted traffic to bypass the firewall 677
Create a new IP list of trusted traffic sources 677
Create incoming and outbound firewall rules for trusted traffic using the IP list 678
Assign the firewall rules to a policy used by computers that trusted traffic flows
through 678
Firewall rule actions and priorities 678
Firewall rule actions 679
More about Allow rules 679
More about Bypass rules 680
Default Bypass rule for Deep Security Manager traffic 680
More about Force Allow rules 681
Firewall rule sequence 681
34
Trend Micro Deep Security On-Premise 20
A note on logging 682
How firewall rules work together 683
Rule Action 683
Rule priority 684
Putting rule action and priority together 684
Firewall settings 685
General 686
Firewall 686
Firewall Stateful Configurations 686
Port Scan (Computer Editor only) 686
Assigned Firewall Rules 686
Interface Isolation 687
Interface Isolation 687
Interface Patterns 687
Reconnaissance 688
Reconnaissance Scans 688
Advanced 690
Events 690
Events 690
Firewall settings with Oracle RAC 690
Add a rule to allow communication between nodes 691
Add a rule to allow UDP port 42424 691
Allow other RAC-related packets 693
Ensure that the Oracle SQL Server rule is assigned 695
Ensure that anti-evasion settings are set to "Normal" 695
Define stateful firewall configurations 696
Add a stateful configuration 697
Enter stateful configuration information 697
Select packet inspection options 697
35
Trend Micro Deep Security On-Premise 20
IP packet inspection 697
TCP packet inspection 698
FTP Options 699
UDP packet inspection 699
ICMP packet inspection 700
Export a stateful configuration 701
Delete a stateful configuration 701
See policies and computers a stateful configuration is assigned to 701
Scan for open ports 701
Container Firewall rules 702
Kubernetes Firewall rules 702
Swarm Firewall rules 704
Configure Integrity Monitoring 705
About Integrity Monitoring 705
Set up Integrity Monitoring 705
How to enable Integrity Monitoring 705
Turn on Integrity Monitoring 706
Run a Recommendation scan 707
Apply the Integrity Monitoring rules 707
Build a baseline for the computer 709
Periodically scan for changes 709
Test Integrity Monitoring 709
When Integrity Monitoring scans are performed 710
Integrity Monitoring scan performance settings 711
Limit CPU usage 711
Change the content hash algorithm 711
Enable a VM Scan Cache configuration 712
Integrity Monitoring event tagging 712
Create an Integrity Monitoring rule 713
36
Trend Micro Deep Security On-Premise 20
Add a new rule 713
Enter Integrity Monitoring rule information 714
Select a rule template and define rule attributes 714
Registry Value template 714
File template 714
Custom (XML) template 715
Configure Trend Micro Integrity Monitoring rules 715
Configure rule events and alerts 716
Real-time event monitoring 716
Alerts 716
See policies and computers a rule is assigned to 717
Export a rule 717
Delete a rule 717
Integrity Monitoring rules language 717
About the Integrity Monitoring rules language 717
Entity Sets 718
Hierarchies and wildcards 719
Syntax and concepts 720
Include tag 721
Exclude tag 722
Case sensitivity 722
Entity features 723
ANDs and ORs 724
Order of evaluation 725
Entity attributes 725
Shorthand attributes 727
onChange attribute 727
Environment variables 727
Environment variable overrides 728
37
Trend Micro Deep Security On-Premise 20
Registry values 729
Use of ".." 729
Best practices 730
DirectorySet 730
Tag Attributes 731
Entity Set Attributes 731
Short Hand Attributes 732
Meaning of "Key" 733
Sub Elements 733
FileSet 733
Tag Attributes 733
Entity Set Attributes 734
Short Hand Attributes 735
Drives Mounted as Directories 736
Alternate Data Streams 736
Meaning of "Key" 737
Sub Elements 737
Special attributes of Include and Exclude for FileSets: 737
GroupSet 737
Tag Attributes 738
Entity Set Attributes 738
Short Hand Attributes 738
Meaning of "Key" 738
Include and Exclude 738
InstalledSoftwareSet 739
Tag Attributes 739
Entity Set Attributes 739
Short Hand Attributes 740
Meaning of "Key" 740
38
Trend Micro Deep Security On-Premise 20
Sub Elements 740
Special attributes of Include and Exclude for InstalledSoftwareSets: 741
PortSet 741
Tag Attributes 741
Entity Set Attributes 742
Meaning of "Key" 742
IPV6 743
Matching of the Key 743
Sub Elements 743
Special attributes of Include and Exclude for PortSets: 744
ProcessSet 744
Tag Attributes 745
Entity Set Attributes 745
Short Hand Attributes 746
Meaning of "Key" 746
Sub Elements 746
Special attributes of Include and Exclude for ProcessSets: 746
RegistryKeySet 747
Tag Attributes 748
Entity Set Attributes 748
Short Hand Attributes 748
Meaning of "Key" 748
Sub Elements 749
RegistryValueSet 749
Tag Attributes 749
Entity Set Attributes 749
Short Hand Attributes 750
Meaning of "Key" 750
Default Value 750
39
Trend Micro Deep Security On-Premise 20
Sub Elements 751
ServiceSet 751
Tag Attributes 752
Entity Set Attributes 752
Short Hand Attributes 753
Meaning of "Key" 753
Sub Elements 753
Special attributes of Include and Exclude for ServiceSets: 754
UserSet 754
Tag Attributes 754
Entity Set Attributes 754
Common Attributes 755
Windows-only Attributes 755
Linux, AIX, and Solaris Attributes 756
Short Hand Attributes 756
Meaning of "Key" 757
Sub Elements 757
Include and Exclude 757
Special attributes of Include and Exclude for UserSets 757
WQLSet 758
Entity Set Attributes 760
Meaning of Key 762
Include Exclude 762
Virtual Appliance Scan Caching 763
Scan Cache Configurations 763
Malware Scan Cache Configuration 764
Integrity Monitoring Scan Cache Configuration 764
Scan Cache Settings 764
When to change the default configuration 765
40
Trend Micro Deep Security On-Premise 20
Configure Log Inspection 766
About Log Inspection 766
Set up Log Inspection 766
Turn on the log inspection module 767
Run a recommendation scan 767
Apply the recommended log inspection rules 767
Test Log Inspection 769
Configure log inspection event forwarding and storage 769
Define a Log Inspection rule for use in policies 770
Create a new Log Inspection rule 771
Decoders 773
Subrules 774
Groups 774
Rules, ID, and Level 775
Description 776
Decoded As 776
Match 777
Conditional Statements 778
Hierarchy of Evaluation 778
Restrictions on the Size of the Log Entry 779
Composite Rules 780
Real world examples 782
Log Inspection rule severity levels and their recommended use 790
strftime() conversion specifiers 791
Examine a Log Inspection rule 792
Log Inspection rule structure and the event matching process 792
Duplicate Sub-rules 795
Configure Application Control 796
About Application Control 796
41
Trend Micro Deep Security On-Premise 20
Key concepts 796
How does application control work? 797
A tour of the application control interface 798
Application Control: Software Changes (Actions) 799
Application Control Rulesets 800
Security Events 801
What does application control detect as a software change? 801
Differences in how Deep Security Agent 10 and 11 compare files 802
Set up Application Control 802
Turn on Application Control 803
Monitor new and changed software 804
Tips for handling changes 806
Turn on maintenance mode when making planned changes 807
Application Control tips and considerations 808
Verify that Application Control is enabled 808
Monitor Application Control events 810
Choose which Application Control events to log 810
View Application Control event logs 811
Interpret aggregated security events 811
Monitor Application Control alerts 812
View and change Application Control rulesets 813
View Application Control rulesets 814
Security Events 815
Change the action for an Application Control rule 815
Delete an individual Application Control rule 816
Delete an Application Control ruleset 817
Reset Application Control after too much software change 817
Use the API to create shared and global rulesets 818
Create a shared ruleset 820
42
Trend Micro Deep Security On-Premise 20
Change from shared to computer-specific allow and block rules 821
Deploy Application Control shared rulesets via relays 822
Single tenant deployments 822
Multi-tenant deployments 823
Considerations when using relays with shared rulesets 824
Configure events and alerts 825
About Deep Security event logging 825
Where are event logs on the agent? 825
When are events sent to the manager? 825
How long are events stored? 826
System events 826
Security events 826
See the events associated with a policy or computer 827
View details about an event 827
Filter the list to search for an event 828
Export events 828
Improve logging performance 828
Log and event storage best practices 829
Troubleshooting 831
Limit log file sizes 831
Event logging tips 832
Anti-Malware scan failures and cancellations 833
Anti-Malware scan failure events 833
Anti-Malware scan cancellation events 835
Apply tags to identify and group events 836
Manual tagging 837
Auto-tagging 837
Set the precedence for an auto-tagging rule 838
Auto-tagging log inspection events 838
43
Trend Micro Deep Security On-Premise 20
Trusted source tagging 839
Local trusted computer 839
How does Deep Security determine whether an event on a target computer
matches an event on a trusted source computer? 840
Tag events based on a local trusted computer 840
Tag events based on the Trend Micro Certified Safe Software Service 841
Tag events based on a trusted common baseline 841
Delete a tag 842
Reduce the number of logged events 842
Rank events to quantify their importance 844
Web Reputation event risk values 844
Firewall rule severity values 845
Intrusion Prevention rule severity values 845
Integrity Monitoring rule severity values 845
Log Inspection rule severity values 845
Asset values 846
Forward events to a Syslog or SIEM server 846
Forward Deep Security events to a Syslog or SIEM server 846
Allow event forwarding network traffic 846
Request a client certificate 847
Define a Syslog configuration 847
Forward system events 850
Forward security events 850
Troubleshoot event forwarding 851
"Failed to Send Syslog Message" alert 851
Can't edit Syslog configurations 851
Can't see the Syslog configuration sections of Deep Security Manager 851
Syslog not transferred due to an expired certificate 852
Syslog not delivered due to an expired or changed server certificate 852
44
Trend Micro Deep Security On-Premise 20
Compatibility 852
Syslog message formats 852
CEF syslog message format 853
LEEF 2.0 syslog message format 855
Events originating in the manager 855
System event log format 855
Events originating in the agent 857
Anti-Malware event format 857
Application Control event format 874
Firewall event log format 882
Integrity Monitoring log event format 887
Intrusion Prevention event log format 891
Log Inspection event format 901
Web Reputation event format 904
Configure Red Hat Enterprise Linux to receive event logs 906
Set up a Syslog on Red Hat Enterprise Linux 6 or 7 906
Set up a Syslog on Red Hat Enterprise Linux 5 907
Access events with Amazon SNS 908
Set up Amazon SNS 908
Create an AWS user 909
Create an Amazon SNS topic 909
Enable SNS 909
Create subscriptions 910
SNS configuration in JSON format 910
Version 911
Statement 911
Topic 911
Condition 912
Bool 912
45
Trend Micro Deep Security On-Premise 20
Exists 913
IpAddress 914
NotIpAddress 914
NumericEquals 915
NumericNotEquals 916
NumericGreaterThan 917
NumericGreaterThanEquals 917
NumericLessThan 918
NumericLessThanEquals 919
StringEquals 919
StringNotEquals 920
StringEqualsIgnoreCase 921
StringNotEqualsIgnoreCase 921
StringLike 921
StringNotLike 922
Multiple statements vs. multiple conditions 923
Multiple statements 923
Multiple conditions 924
Example SNS configurations 925
Send all critical intrusion prevention events to an SNS topic 925
Send different events to different SNS topics 925
Events in JSON format 926
Valid event properties 926
Data types of event properties 948
Example events in JSON format 949
System event 949
Anti-Malware events 950
Forward system events to a remote computer via SNMP 952
Configure alerts 953
46
Trend Micro Deep Security On-Premise 20
View alerts in Deep Security Manager 953
Configure alert settings 954
Set up email notification for alerts 954
Turn alert emails on or off 955
Configure an individual user to receive alert emails 957
Configure recipients for all alert emails 958
Configure SMTP settings for email notifications 958
Generate reports about alerts and other activity 959
Set up a single report 959
Set up a scheduled report 962
Lists of events and alerts 963
Predefined alerts 963
Agent events 978
System events 984
Application Control events 1032
What information is displayed for Application Control events? 1032
List of all Application Control events 1033
Anti-malware events 1033
What information is displayed for anti-malware events? 1033
List of all anti-malware events 1034
Firewall events 1035
What information is displayed for firewall events? 1035
List of all firewall events 1037
Intrusion prevention events 1044
What information is displayed for intrusion prevention events? 1044
List of all intrusion prevention events 1046
Integrity monitoring events 1049
What information is displayed for integrity monitoring events? 1049
List of all integrity monitoring events 1049
47
Trend Micro Deep Security On-Premise 20
Log inspection events 1052
What information is displayed for log inspection events? 1052
List of log inspection security events 1053
Web reputation events 1053
What information is displayed for web reputation events? 1054
Add a URL to the list of allowed URLs 1054
Troubleshoot common events, alerts, and errors 1054
Why am I seeing firewall events when the firewall module is off? 1054
Troubleshoot event ID 771 "Contact by Unrecognized Client" 1054
Uninstall Deep Security Agent 1055
Reactivate the computer or clone 1055
Fix interrupted VMware connector synchronization 1055
Troubleshoot "Smart Protection Server disconnected" errors 1055
Check the error details 1056
Is the issue on a Deep Security Virtual Appliance? 1056
Error: Activation Failed 1056
Activation Failed - Protocol Error 1056
Agent-initiated communication 1057
Bidirectional communication 1057
Activation Failed - Unable to resolve hostname 1057
Activation Failed - No agent/appliance 1057
Activation Failed - Blocked port 1058
Activation Failed - Duplicate Computer 1059
Error: Agent version not supported 1059
Error: Anti-Malware Engine Offline 1060
Agent-based protection 1060
If your agent is on Windows: 1060
If your agent is on Linux: 1061
Agentless protection 1061
48
Trend Micro Deep Security On-Premise 20
Error: Check Status Failed 1062
Error: Installation of Feature 'dpi' failed: Not available: Filter 1063
Additional information 1063
Error: Integrity Monitoring Engine Offline and other errors occur after activating a
virtual machine 1063
Error: Interface out of sync 1064
Check the interfaces on the VM 1064
Check the VM's interface information in vCenter 1064
Check the vmx file and the VM's interface information in Deep Security Manager 1065
Check the VM's interface information in the Deep Security Virtual Appliance 1066
Workaround Options 1066
Option 1 1066
Option 2 1066
Option 3 1067
Further Troubleshooting 1067
Error: Intrusion Prevention Rule Compilation Failed 1068
Apply Intrusion Prevention best practices 1068
Manage rules 1068
Unassign application types from a single port 1069
Error: Log Inspection Rules Require Log Files 1070
If the file's location is required: 1070
If the files listed do not exist on the protected machine: 1070
Error: Module installation failed (Linux) 1071
Error: There are one or more application type conflicts on this computer 1071
Resolution 1072
Consolidate ports 1072
Disable the inherit option 1073
Error: Unable to connect to the cloud account 1073
Your AWS account access key ID or secret access key is invalid 1073
49
Trend Micro Deep Security On-Premise 20
The incorrect AWS IAM policy has been applied to the account being used by
Deep Security 1074
NAT, proxy, or firewall ports are not open, or settings are incorrect 1074
Error: Unable to resolve instance hostname 1074
Alert: Integrity Monitoring information collection has been delayed 1075
Alert: Manager Time Out of Sync 1075
Alert: The memory warning threshold of Manager Node has been exceeded 1075
Event: Max TCP connections 1076
Warning: Census, Good File Reputation, and Predictive Machine Learning Service
Disconnected 1077
Cause 1: The agent or relay-enabled agent doesn't have Internet access 1077
Cause 2: A proxy was enabled but not configured properly 1078
Warning: Insufficient disk space 1078
Tips 1078
Warning: Reconnaissance Detected 1079
Types of reconnaissance scans 1079
Suggested actions 1079
Configure proxies 1080
Configure proxies 1080
Register a proxy in the manager 1081
Supported proxy protocols 1081
Connect to the 'primary security update source' via proxy 1082
Connect to Deep Security Manager via proxy 1082
Connect to Deep Security Relays via proxy 1084
Connect to Deep Security Software Updates, CSSS, and more via proxy 1085
Connect to cloud accounts via proxy 1086
Connect to Deep Discovery Analyzer via proxy 1086
Connect to Apex Central via proxy 1086
Connect to the Smart Protection Network via proxy 1087
Remove a proxy 1088
50
Trend Micro Deep Security On-Premise 20
Proxy settings 1089
Proxy server use 1089
Configure relays 1089
How relays work 1089
Relay hierarchy, cost, and performance 1091
Deploy additional relays 1091
Plan the best number and location of relays 1092
Geographic region and distance 1093
Network architecture and bandwidth limits 1093
Air-gapped environments 1094
Configure the update source 1094
Configure relays 1096
Create relay groups 1096
Enable relays 1097
Assign agents to a relay group 1098
Connect agents to a relay's private IP address 1099
Remove relay functionality from an agent 1099
Manage agents (protected computers) 1100
Computer and agent statuses 1100
Status column - computer states 1100
Status column - agent or appliance states 1101
Task(s) column 1102
Computer errors 1106
Protection module status 1107
Perform other actions on your computers 1108
Computers icons 1112
Status information for different types of computers 1114
Ordinary computer 1114
Relay 1114
51
Trend Micro Deep Security On-Premise 20
Deep Security Scanner 1115
Docker hosts 1115
ESXi server 1116
Virtual appliance 1116
Virtual machine with agentless protection 1117
Configure agent version control 1117
Set up agent version control 1118
Use agent version control with URL requests 1120
Agent version control FAQs 1120
Configure teamed NICs 1122
Windows 1122
Solaris 1123
Agent-manager communication 1124
Configure the heartbeat 1124
Configure communication directionality 1125
Supported cipher suites for agent-manager communication 1127
Deep Security Agent 9.5 cipher suites 1128
Deep Security Agent 9.6 cipher suites 1128
Deep Security Agent 10.0 cipher suites 1129
Deep Security Agent 11.0 cipher suites 1129
Deep Security Agent 12.0 and Deep Security Agent 20 cipher suites 1130
Configure agents that have no internet access 1131
Solutions 1131
Use a proxy 1132
Install a Smart Protection Server locally 1132
Get updates in an isolated network 1133
Get rules updates in an isolated network 1135
Disable the features that use Trend Micro security services 1136
Activate and protect agents using agent-initiated activation and communication 1138
52
Trend Micro Deep Security On-Premise 20
Enable agent-initiated activation and communication 1138
Create or modify policies with agent-initiated communication enabled 1138
Enable agent-initiated activation 1139
Assign the policy to agents 1139
Use a deployment script to activate the agents 1139
Automatically upgrade agents on activation 1139
Enable automatic agent upgrade 1140
Check that agents were upgraded successfully 1140
Using Deep Security with iptables 1142
Rules required by Deep Security Manager 1142
Rules required by Deep Security Agent 1143
Prevent Deep Security from automatically adding iptables rules 1143
Enable or disable agent self-protection 1143
Configure self-protection through Deep Security Manager 1144
Configure self-protection using the command line 1144
Are "Offline" agents still protected by Deep Security? 1145
Automate offline computer removal with inactive agent cleanup 1145
Enable inactive agent cleanup 1146
Ensure computers that are offline for extended periods of time remain protected
with Deep Security 1146
Set an override to prevent specific computers from being removed 1147
Check the audit trail for computers removed by an inactive cleanup job 1147
Search system events 1147
System event details 1148
2953 - Inactive Agent Cleanup Completed Successfully 1148
251 - Computer Deleted 1148
716 - Reactivation Attempted by Unknown Agent 1148
Agent settings 1149
Hostnames 1149
53
Trend Micro Deep Security On-Premise 20
Agent-initiated activation (AIA) 1149
Agent Upgrade 1151
Inactive Agent Cleanup 1152
Data Privacy 1152
Agentless vCloud Protection 1152
Deep Security Notifier 1153
How the notifier works 1153
Linux Secure Boot support for agents 1158
Upgrade the agent if you're using Secure Boot 1160
Manage users 1161
Add and manage users 1161
Synchronize users with an Active Directory 1161
Add or edit an individual user 1162
Change a user's password 1165
Lock out a user or reset a lockout 1165
View system events associated with a user 1165
Delete a user 1165
Define roles for users 1166
Add or edit a role 1167
Default settings for full access, auditor, and new roles 1174
Add users who can only receive reports 1182
Add or edit a contact 1182
Delete a contact 1182
Create an API key for a user 1183
Lock out an existing API key 1183
Unlock a locked out user name 1184
Unlock users as an administrator 1184
Unlock administrative users from a command line 1184
Implement SAML single sign-on (SSO) 1185
54
Trend Micro Deep Security On-Premise 20
About SAML single sign-on (SSO) 1185
What are SAML and single sign-on? 1185
How SAML single sign-on works in Deep Security 1185
Establishing a trust relationship 1185
Creating Deep Security accounts from user identities 1185
Implement SAML single sign-on in Deep Security 1186
Configure SAML single sign-on 1187
Configure pre-set up requirements 1187
Configure Deep Security as a SAML service provider 1188
Configure SAML in Deep Security 1189
Import your identity provider's SAML metadata document 1189
Create Deep Security roles for SAML users 1189
Provide information for your identity provider administrator 1189
Download the Deep Security Manager service provider SAML metadata
document 1189
Send URNs and the Deep Security SAML metadata document to the identity
provider administrator 1189
SAML claims structure 1190
Deep Security user name (required) 1190
Sample SAML data (abbreviated) 1190
Deep Security user role (required) 1191
Sample SAML data (abbreviated) 1191
Maximum session duration (optional) 1191
Sample SAML data (abbreviated) 1192
Preferred language (optional) 1192
Sample SAML data (abbreviated) 1192
Test SAML single sign-on 1193
Review the set-up 1193
Create a Diagnostic Package 1193
Service and identity provider settings 1193
55
Trend Micro Deep Security On-Premise 20
Configure SAML single sign-on with Azure Active Directory 1193
Who is involved in this process? 1194
Configure Deep Security as a SAML service provider 1194
Download the Deep Security service provider SAML metadata document 1195
Configure Azure Active Directory 1195
Configure SAML in Deep Security 1197
Import the Azure Active Directory metadata document 1197
Create Deep Security roles for SAML users 1197
Get URNs 1197
Define a role in Azure Active Directory 1197
Service and identity provider settings 1198
SAML claims structure 1198
Deep Security user name (required) 1198
Sample SAML data (abbreviated) 1198
Deep Security user role (required) 1199
Sample SAML data (abbreviated) 1199
Maximum session duration (optional) 1199
Sample SAML data (abbreviated) 1199
Preferred language (optional) 1200
Sample SAML data (abbreviated) 1200
Manage the database 1201
General database maintenance 1201
Maintain PostgreSQL 1201
Log rotation 1202
Example: Daily Database Log Rotation 1203
Lock management 1203
Maximum concurrent connections 1203
Effective cache size 1204
Shared buffers 1204
56
Trend Micro Deep Security On-Premise 20
Work memory and maintenance work memory 1204
Checkpoints 1204
Write-ahead log (WAL) 1204
Autovacuum settings 1205
PostgreSQL on Linux 1206
Transparent huge pages 1206
Host-based authentication 1206
Maintain Microsoft SQL Server Express 1206
Migrate Microsoft SQL Server Express to Enterprise 1206
Back up and restore your database 1208
Back up your database 1208
Restore the database only 1208
Restore both the Deep Security Manager and the database 1208
Export objects in XML or CSV format 1209
Import objects 1210
Navigate and customize Deep Security Manager 1210
Customize the dashboard 1210
Date and time range 1211
Computers and computer groups 1211
Filter by tags 1212
Select dashboard widgets 1213
Monitoring: 1213
System: 1214
Ransomware: 1214
Anti-Malware: 1215
Web Reputation: 1215
Firewall: 1215
Intrusion Prevention: 1216
Integrity Monitoring: 1217
57
Trend Micro Deep Security On-Premise 20
Log Inspection: 1217
Application Control: 1218
Change the layout 1218
Save and manage dashboard layouts 1219
Group computers dynamically with smart folders 1219
Create a smart folder 1220
Edit a smart folder 1222
Clone a smart folder 1222
Focus your search using sub-folders 1222
Automatically create sub-folders 1223
Searchable Properties 1224
General 1224
AWS 1227
Azure 1229
GCP 1229
vCenter 1230
vCloud 1230
Folder 1231
Operators 1231
Customize advanced system settings 1233
Primary Tenant Access 1233
Load Balancers 1234
Multi-tenant Mode 1234
Deep Security Manager Plug-ins 1234
SOAP Web Service API 1235
Status Monitoring API 1235
Export 1235
Whois 1235
Licenses 1235
58
Trend Micro Deep Security On-Premise 20
CPU Usage During Recommendation Scans 1236
NSX 1236
Logo 1236
Manager AWS Identity 1236
Application control 1237
Harden Deep Security 1242
About Deep Security hardening 1242
Protect Deep Security Manager with an agent 1243
Protect Deep Security Agent 1244
Bind Deep Security Agent to a specific Deep Security Manager 1244
Replace the Deep Security Manager TLS certificate 1245
Learn about Java Keystores 1246
Generate the private key and keystore 1246
Generate a CSR and request a certificate 1248
Import the signed certificate into the keystore 1248
Configure Deep Security to use the signed certificate store 1250
Update the load balancer's certificate 1250
Encrypt communication between the Deep Security Manager and the database 1252
Encrypt communication between the manager and database 1253
Microsoft SQL Server database 1253
Oracle database 1254
PostgreSQL 1255
Running an agent on the database server 1255
Disable encryption between the manager and database 1256
Microsoft SQL Server 1256
Oracle Database 1256
PostgreSQL 1257
Upgrade from an old Deep Security Manager version 1257
Upgrade Deep Security Manager 1257
59
Trend Micro Deep Security On-Premise 20
Change the Deep Security Manager database password 1258
Change your Microsoft SQL Server password 1258
Change your Oracle password 1259
Change your PostgreSQL password 1259
Configure HTTP security headers 1260
Customizable security headers 1260
HTTP Strict Transport Security (HSTS) 1261
Content Security Policy (CSP) 1261
HTTP Public Key Pinning (HPKP) 1262
Enable customizable security headers 1262
Reset your configuration 1263
HTTP Strict Transport Security 1263
Content Security Policy 1263
Public Key Pinning Policy 1263
Enforced security headers 1263
Cache-Control and Pragma 1264
X-XSS-Protection 1264
X-Frame-Options 1264
Unsupported security headers 1264
X-Content-Type-Options 1264
Upgrade the Deep Security cryptographic algorithm 1265
Upgrade the algorithm on Windows 1265
Upgrade the algorithm on Linux 1266
Upgrade the algorithm in a multi-node environment 1266
Upgrade the algorithm in a multi-tenant environment 1266
Enforce user password rules 1267
Specify password requirements 1267
Use another identity provider for sign-on 1268
Add a message to the Deep Security Manager Sign In page 1268
60
Trend Micro Deep Security On-Premise 20
Present users with terms and conditions 1268
Other Security settings 1268
Set up multi-factor authentication 1269
Enable multi-factor authentication 1269
Disable multi-factor authentication 1272
Supported multi-factor authentication (MFA) applications 1272
Troubleshooting MFA 1273
What if my MFA is enabled but not working? 1273
What if my MFA device is lost or stops working? 1273
Manage trusted certificates 1273
Import trusted certificates 1274
View trusted certificates 1274
Remove trusted certificates 1275
SSL implementation and credential provisioning 1276
If I have disabled the connection to the Smart Protection Network, is any other
information sent to Trend Micro? 1277
Upgrade Deep Security 1277
About upgrades 1277
How Deep Security Manager checks for software upgrades 1278
Best practices for upgrades 1279
How Deep Security validates update integrity 1280
Digital signatures 1280
Checksums 1281
Apply security updates 1281
Initiate security updates 1282
Check your security update status 1282
View details about pattern updates 1282
Revert, import, or view details about rule updates 1283
Configure security updates 1284
61
Trend Micro Deep Security On-Premise 20
Enable automatic patches for rules 1284
Enable automatic Anti-Malware engine updates 1285
Enable security updates for older agents 1285
Change the alert threshold for late security updates 1286
Disable emails for New Pattern Update alerts 1286
Use a web server to distribute software updates 1287
Web server requirements 1287
Copy the folder structure 1287
Configure agents to use the new software repository 1289
Upgrade Deep Security Manager 1289
Before you begin 1290
Upgrade the manager 1291
Upgrade the manager if it's more than two releases old 1291
Upgrade the manager in a multi-node deployment 1291
Upgrade the manager in a multi-tenant environment 1292
What happens when you upgrade? 1292
Post-upgrade tasks 1293
Troubleshoot the manager upgrade (log files) 1293
Roll back an unsuccessful upgrade of the manager 1294
Upgrade Deep Security Relay 1294
Upgrade a relay starting from the manager 1295
Upgrade a relay by running the installer manually 1295
Upgrade Deep Security Agent 1295
Before you begin an upgrade 1296
Upgrade the agent starting from an alert 1297
Upgrade multiple agents at once 1297
Upgrade the agent from the Computers page 1298
Upgrade the agent on activation 1298
Upgrade the agent manually 1298
62
Trend Micro Deep Security On-Premise 20
Content of ds_adm.file 1301
Upgrade the agent embedded on the virtual appliance automatically 1302
Upgrade best practices for agents 1302
Upgrade Deep Security Virtual Appliance 1303
Check if new appliance software is available 1303
Determine which versions of the appliance SVM and embedded agent you're
using 1304
Determine whether a new appliance SVM is available 1304
Determine whether a new agent is available 1304
Before upgrading the appliance 1305
Review system requirements and supported NSX versions 1305
Verify the vCenter and NSX account permissions 1305
Re-register NSX-T 1305
Import the new appliance ZIP into the manager 1306
Next steps 1306
Upgrade the appliance 1307
Upgrade an existing appliance SVM automatically 1307
Step 1: Upgrade the appliance SVM in the manager 1307
Troubleshooting the 'Appliance (SVM) Upgrade Failed' system event 1310
Step 2: Check that the upgrade succeeded 1311
Upgrade an existing appliance SVM manually 1311
Step 1: Review or restore identified files 1311
Step 2: Migrate guest VMs to another ESXi host 1311
Step 3: Upgrade your old appliance SVM 1312
Step 4: Check that maintenance mode was turned off 1317
Step 5: Check that the new appliance SVM is activated 1317
Step 6: Final step 1318
Upgrade the agent embedded on the appliance SVM 1318
Compatibility table: appliance, agent 1319
63
Trend Micro Deep Security On-Premise 20
Upgrade the database 1319
The upgrade path 1320
Upgrade the database 1320
Error: The installer could not establish a secure connection to the database server 1321
Upgrade the NSX license for more Deep Security features 1321
Upgrade your NSX-T 3.x license 1322
Upgrade your NSX-V license 1322
Step 1: Upgrade your NSX license 1322
Step 2: Remove Deep Security from NSX completely 1326
Step 3: Redeploy the Deep Security Virtual Appliance 1326
Uninstall Deep Security 1326
Uninstall Deep Security 1326
Uninstall Deep Security Relay 1326
Uninstall a relay (Windows) 1326
Uninstall a relay (Linux) 1327
Uninstall Deep Security Agent 1328
Uninstall an agent (Windows) 1328
Uninstall an agent (Linux) 1328
Uninstall an agent (Solaris 10) 1329
Uninstall an agent (Solaris 11) 1329
Uninstall an agent (AIX) 1329
Uninstall Deep Security Notifier 1329
Uninstall Deep Security Manager 1330
Uninstall the manager (Windows) 1330
Uninstall the manager (Linux) 1330
Uninstall Deep Security from your NSX environment 1331
Uninstall Deep Security automatically 1331
Uninstall Deep Security from NSX-T 3.x manually 1333
Uninstall Deep Security from NSX-V manually 1339
64
Trend Micro Deep Security On-Premise 20
Configure Deep Security Manager memory usage 1344
Configuring the installer's maximum memory usage 1344
Configuring Deep Security Manager's maximum memory usage 1344
Restart the Deep Security Manager 1345
Linux 1345
Windows 1345
Windows desktop 1345
Command prompt 1345
PowerShell 1345
Check your license information 1346
DevOps, automation, and APIs 1346
About DevOps, automation, and APIs 1346
Trend Micro Hybrid Cloud Security Command Line Interface (THUS) 1347
Command-line basics 1348
dsa_control 1348
dsa_control options 1349
Agent-initiated activation ("dsa_control -a") 1353
Agent-initiated heartbeat command ("dsa_control -m") 1353
Activate an agent 1361
Windows 1361
Linux 1361
Force the agent to contact the manager 1361
Windows 1361
Linux 1362
Initiate a manual anti-malware scan 1362
Windows 1362
Linux 1362
Create a diagnostic package 1362
Reset the agent 1362
65
Trend Micro Deep Security On-Premise 20
Windows 1362
Linux 1363
dsa_query 1363
dsa_query options 1363
Check CPU usage and RAM usage 1364
Windows 1364
Linux 1364
Check that ds_agent processes or services are running 1364
Windows 1364
Linux 1364
Restart an agent on Linux 1364
dsm_c 1365
dsm_c options 1365
Return codes 1376
Use the Deep Security API to automate tasks 1376
Legacy REST and SOAP APIs 1377
Enable the Status Monitoring API (optional) 1377
Create a Web Service user account 1378
Schedule Deep Security to perform tasks 1378
Create scheduled tasks 1378
Enable or disable a scheduled task 1380
Set up scheduled reports 1381
Automatically perform tasks when a computer is added or changed (event-based
tasks) 1381
Create an event-based task 1381
Edit or stop an existing event-based task 1381
Events that you can monitor 1382
Conditions 1383
List of conditions and descriptions of each 1383
66
Trend Micro Deep Security On-Premise 20
Java regex examples 1385
Actions 1385
Order of execution 1386
Temporarily disable an event-based task 1386
AWS Auto Scaling and Deep Security 1386
Pre-install the agent 1387
Install the agent with a deployment script 1388
Delete instances from Deep Security as a result of Auto Scaling 1390
Azure virtual machine scale sets and Deep Security 1390
Step 1: (Recommended) Add your Azure account to Deep Security Manager 1390
Step 2: Prepare a deployment script 1391
Step 3: Add the agent through a custom script extension to your VMSS instances 1391
Example 1: Create a new VMSS that includes the agent 1392
Example 2: Add the agent to an existing VMSS 1395
GCP auto scaling and Deep Security 1397
Pre-install the agent 1398
Install the agent with a deployment script 1398
Delete instances from Deep Security as a result of GCP MIGs 1400
Use deployment scripts to add and protect computers 1401
Generate a deployment script 1401
Troubleshooting and tips 1403
URL format for download of the agent 1405
Agent download URL format 1405
<dsm fqdn> parameter 1406
<filename> parameter 1406
<agent version> parameter 1407
Should I include the <agent version> explicitly in my scripts? 1407
<platform>, <arch>, and <filename> parameters 1408
Examples 1411
67
Trend Micro Deep Security On-Premise 20
Exceptions for backwards compatibility 1411
Using agent version control to define which agent version is returned 1412
Examples 1412
Interactions between the <agent version> parameter and agent version control 1412
Automatically assign policies by AWS instance tags 1413
Trust and compliance 1414
About compliance 1414
Agent package integrity check 1415
Troubleshoot 1415
Supported Deep Security Relay versions 1416
Meet PCI DSS requirements with Deep Security 1416
Common Criteria configuration 1417
GDPR 1417
FIPS 140-2 support 1417
Differences when operating Deep Security in FIPS mode 1418
System requirements for FIPS mode 1419
Deep Security Manager requirements 1419
Deep Security Agent requirements 1420
Deep Security Virtual Appliance requirements 1420
Enable FIPS mode for your Deep Security Manager 1420
Enable FIPS mode for a Deep Security Manager on Windows 1420
Enable FIPS mode for a Deep Security Manager on Linux 1420
Connect to external services when in FIPS mode 1421
Enable FIPS mode for the operating system of the computers you are protecting 1421
Enable FIPS mode for the Deep Security Agent on the computers you are protecting 1422
Enable FIPS mode for a Windows agent 1422
Enable FIPS mode for an RHEL 7 or CentOS 7 agent 1422
Enable FIPS mode for the Deep Security Virtual Appliance 1422
Using FIPS mode with a PostgreSQL database 1423
68
Trend Micro Deep Security On-Premise 20
Using FIPS mode with a Microsoft SQL Server database 1426
Disable FIPS mode 1428
Bypass vulnerability management scan traffic in Deep Security 1428
Create a new IP list from the vulnerability scan provider IP range or addresses 1428
Create firewall rules for incoming and outbound scan traffic 1429
Assign the new firewall rules to a policy to bypass vulnerability scans 1430
Use TLS 1.2 with Deep Security 1430
TLS 1.2 architectures 1432
Upgrade components to use TLS 1.2 1436
Verify and upgrade your Deep Security Manager 1436
Verify your Deep Security Manager database 1436
Verify your Deep Security Agents 1437
Verify your Deep Security Relays 1437
Verify your Deep Security Virtual Appliance 1437
Enforce TLS 1.2 1438
Where can TLS 1.2 be enforced? 1438
What happens when TLS 1.2 enforced? 1438
Is TLS 1.2 enforced by default? 1438
Under what circumstances is TLS 1.2 enforcement possible? 1439
Enforce TLS 1.2 on Deep Security Manager 1439
Enforce TLS 1.2 on the Deep Security Relay 1439
Enforce TLS 1.2 on just the manager's GUI port (4119) 1440
Test that TLS 1.2 is enforced 1440
Enable early TLS (1.0) 1441
Enable TLS 1.0 on Deep Security Manager and the Deep Security Relay 1442
Enable TLS 1.0 on the manager's GUI port (4119) 1443
Enable TLS 1.0 in deployment scripts 1443
Determine whether TLS 1.2 is enforced 1443
69
Trend Micro Deep Security On-Premise 20
Guidelines for deploying agents, virtual appliances, and relays after TLS 1.2 is
enforced 1444
Guidelines for deploying agents, virtual appliances, and relays when TLS 1.2 is
enforced 1444
Guidelines for using deployment scripts when TLS 1.2 is enforced 1444
Enable TLS 1.2 strong cipher suites 1445
Update Deep Security components 1445
Run a script to enable TLS 1.2 strong cipher suites 1446
Verify that the script worked 1447
Verify the manager using nmap 1447
Verify the relays using nmap 1448
Verify the agents using nmap 1449
Disable TLS 1.2 strong cipher suites 1449
Legal disclosures 1450
Privacy and personal data collection disclosure 1450
Deep Security Product Usage Data Collection 1451
Legal disclaimer 1451
Hot Fix 1451
Major release, Update, Patch or Service Pack 1452
Integrations 1452
Integrate with AWS Control Tower 1452
Overview 1452
Integrate with AWS Control Tower 1453
Upgrade the AWS Control Tower integration 1454
Remove AWS Control Tower integration 1454
Integrate with AWS Systems Manager Distributor 1454
Create parameters 1454
Integrate with AWS Systems Manager Distributor 1455
Protect your computers 1455
Integrate with SAP NetWeaver 1456
70
Trend Micro Deep Security On-Premise 20
Activate the Deep Security Scanner feature 1456
Add the SAP Server 1457
Enable the SAP integration feature in a computer or policy 1457
Set up SAP integration 1457
Deep Security and SAP components 1459
Install the agent 1460
Add the SAP server to the manager 1461
Activate SAP in the manager 1461
Add the SAP server 1461
Activate the agent 1461
Assign a security profile 1464
Configure SAP to use the agent 1469
Configure the Trend Micro scanner group 1470
Configure the Trend Micro virus scan provider 1476
Configure the Trend Micro virus scan profile 1482
Test the virus scan interface 1491
Supported MIME types 1497
Integrate with Smart Protection Server 1501
FAQs 1508
Why does my Windows machine lose network connectivity when I turn on protection? 1508
How do I get news about Deep Security? 1509
How does agent protection work for Solaris zones? 1509
Intrusion Prevention (IPS), Firewall, and Web Reputation 1510
Non-global zones use a shared-IP network interface 1510
Non-global zones use an exclusive-IP network interface 1510
Anti-Malware, Integrity Monitoring, and Log Inspection 1511
How do I protect AWS GovCloud (US) instances? 1511
Protecting AWS GovCloud (US) instances using a manager in a commercial AWS
instance 1512
71
Trend Micro Deep Security On-Premise 20
How do I protect Azure Government instances? 1512
Protecting Azure Government instances using a manager in global Azure 1515
How does Deep Security Agent use the Amazon Instance Metadata Service? 1515
How can I minimize heartbeat alerts for offline environments in an AWS Elastic
Beanstalk environment? 1517
Why can't I add my Azure server using the Azure cloud connector? 1518
Why can't I view all of the VMs in an Azure subscription in Deep Security? 1518
Troubleshooting 1519
"Offline" agent 1519
Causes 1519
Verify that the agent is running 1520
Verify DNS 1521
Allow outbound ports (agent-initiated heartbeat) 1521
Allow inbound ports (manager-initiated heartbeat) 1522
Allow ICMP on Amazon AWS EC2 instances 1523
Fix the upgrade issue on Solaris 11 1523
High CPU usage 1524
Diagnose problems with agent deployment (Windows) 1525
"Anti-Malware Driver Offline" status with VMware 1525
Anti-Malware Windows platform update failed 1525
An incompatible Anti-Malware component from another Trend Micro product 1525
An incompatible Anti-Malware component from a third-party product 1526
Other/unknown Error 1526
Performance issues on an agentless virtual machine 1526
Cause: Limited resources 1526
Cause: Anti-malware 1527
Cause: Network traffic 1527
Cause: Policy 1527
Cause: High CPU 1527
72
Trend Micro Deep Security On-Premise 20
Cause: Security Update 1528
Security update connectivity 1528
SQL Server domain authentication problems 1529
Step 1: Verify the host name and domain 1530
Step 2: Verify the servicePrincipalName (SPN) 1531
Step 2a: Identify the account (SID) running the SQL Server service 1532
Step 2b: Find the account in Active Directory 1534
Step 2c: Identify which FQDN to use in the SPN 1535
Step 2d: Identify whether you're using a default instance or named instance 1535
Case 1: Set the SPN under a local virtual account 1536
Case 2: Set the SPN under a domain account 1538
Case 3: Set the SPN under a Managed Service account 1540
Case 4: Set the SPN for a failover cluster 1542
SPN references 1544
SPN debugging tips 1544
Step 3: Verify the krb5.conf file (Linux only) 1545
Step 4: Verify the system clock 1547
Step 5: Verify the firewall 1547
Prevent MTU-related agent communication issues across Amazon Virtual Private
Clouds (VPC) 1548
Create a diagnostic package and logs 1550
Deep Security Manager diagnostics 1550
Create a diagnostic package for Deep Security Manager 1550
Enable debug logs for Deep Security Manager 1550
Deep Security Agent diagnostics 1551
Create an agent diagnostic package via Deep Security Manager 1552
Create an agent diagnostic package via CLI on a protected computer 1553
Collect debug logs with DebugView 1553
Increase verbose diagnostic package process memory 1554
73
Trend Micro Deep Security On-Premise 20
Removal of older software versions 1555
Troubleshoot SELinux alerts 1555
PDFs 1557
Deep Security Administration Guide 1557
Deep Security Best Practice Guide 1557
74
Trend Micro Deep Security On-Premise 20
About Deep Security
Deep Security 20 release strategy and life cycle policy
Deep Security 20 is a long-term support release (LTS).
There are a number of changes to Deep Security 20 release management and life cycle that
make working this release easier for our customers and partners:
l Deep Security 20 updates will include both new content and fixes to ensure we deliver
new features to our customers with increased velocity.
l To reduce the number of software releases and simplify understanding of the support
policy, we are no longer releasing Feature Releases (FR).
l Standard Support and Extended Support Services are now closely aligned to provide a
more consistent support experience from day 1 to the end of life of the release.
We encourage you to update your software on a regular basis. Software updates provide
additional features, security updates, performance improvements, and updates to stay in sync
with updates from other software in your data center or cloud ecosystem. Keeping software
updated regularly also ensures that, if support is required, you have a supported upgrade path to
any updates that contain necessary fixes.
Supported upgrade paths
Deep Security supports upgrades from the last 2 major releases for all Deep Security software
components (Deep Security Manager, Deep Security Agent, and Deep Security Relay).
You can upgrade to Deep Security 20 from these older versions:
l Deep Security 11 (LTS)
l Deep Security 12 (LTS)
l Deep Security 12 (FR)
Deep Security 20 supports upgrading to new LTS Update releases, but rolling back to a
previous release is not supported.
75
Trend Micro Deep Security On-Premise 20
Deep Security 20 updates
Consistent with previous LTS releases, Deep Security 20 updates will be released monthly. If
the need arises, typically due to critical fixes or vulnerabilities, more frequent releases will be
provided.
With Deep Security 20, each component (manager, agent, appliance) can be released
independently. Agents for different platforms (Windows, Linux, Unix) can also be released
separately. An update may include one or more components and platforms.
If a software fix is required on an actively supported release of software, we will make an update
available that can be applied directly to the software release within the active support period. For
example, if you are running Deep Security 20 Update 2 and have an issue, when the latest
update is released (for example Deep Security 20 Update 10) you can update directly from
Update 2 to Update 10 to ensure that you can resolve issues quickly and easily.
LTS release support duration and upgrade best practices
A key best practice for software updates is to ensure you have a well defined, regularly
scheduled, and, ideally, automated process in place that ensures all components are updated
regularly.
The following table summarizes when updates are released, the support duration of that
component, and considerations when designing your upgrade strategy.
When are
Component updates Support Upgrade considerations
released?
Standard
support until
3 years after
LTS
GA Plan to upgrade regularly to ensure that you
Deep updates
(General remain on a supported release and are able to
Security are
Availability). upgrade to the latest software with a single
Manager released
Extended upgrade.
monthly
support until
4 years after
GA.
Deep LTS Standard LTS agents support upgrades from the last 2
Security updates support until major releases (for example Deep Security
76
Trend Micro Deep Security On-Premise 20
When are
Component updates Support Upgrade considerations
released?
3 years after
Agent 11.0 to Deep Security Agent 20 LTS).
GA.
are Plan to upgrade regularly to ensure that you
Extended
Agent released remain on a supported release and are able to
support until
monthly upgrade to the latest software with a single
4 years after
upgrade.
GA.
Deep
Security If platform support is only provided by an older
Agent release of Deep Security Agent (for example,
(platforms LTS Windows 2000 uses a 9.6 agent and Red Hat
where an updates Enterprise Linux 5 uses a 10.0 agent), use the
Platform-
older are latest agent for that platform and upgrade as
specific
release of released updates are released. For details on which
the agent is monthly agent versions are supported for each platform,
the 'latest' see "Deep Security Agent platforms" on
agent for that page 135.
platform)
LTS
Deep Security Relay is simply a Deep Security
Deep updates
Same as Agent that has relay functionality enabled. The
Security are
agent upgrade recommendations and support policies
Relay released
for agents also apply to relays.
monthly
Appliance SVM: Plan to upgrade yearly.
Embedded agent: Plan to upgrade:
Standard
Released support until l at least yearly, or
Deep with each 3 years after
Security LTS GA. l whenever a new compatible agent is
Virtual release Extended available, or
Appliance of Deep support until
Security 4 years after l regularly to ensure that you remain on a
GA. supported release and are able to
upgrade to the latest software with a
single upgrade
77
Trend Micro Deep Security On-Premise 20
Support services
The following table indicates which support items are available during the life cycle of Deep
Security 20.
LTS - LTS -
Support item standard extended Delivery mechanism
support support (*)
New features ✔ ✔ LTS update
Small enhancements (no change to core
✔ ✔ LTS update
functionality)
Linux Kernel
On
Linux kernel updates ✔ Support Package
request
(LKP)
General bug fixes ✔ ✔ LTS update
Critical bug fixes (system crash or hang, or loss LTS update or
✔ ✔
of major functionality) hotfix
LTS update or
Critical and high vulnerability fixes ✔ ✔
hotfix
Medium and low vulnerability fixes ✔ ✔ LTS update
iAU (Active
Anti-Malware pattern updates ✔ ✔
Update)
Intrusion Prevention, Integrity Monitoring, and iAU (Active
✔ ✔
Log Inspection rule updates Update)
Support for agents and Deep Security Manager
on new versions of supported operating ✔ ✔ LTS update
systems
( *) Extended support is provided to all customers at no additional charge.
78
Trend Micro Deep Security On-Premise 20
Agent platform support policy
Deep Security Agent software is released multiple times a year, as described above. Agent
platforms (operating systems) are supported according to the policy below. We recognize that in
some cases you must commit to platforms for many years. This policy is designed to provide
predictability when you deploy Deep Security in these environments:
l The agent is supported on a large range of platforms, as shown in the "Agent platform
support table" on page 135.
l The support duration of any individual release of agent software is described in the tables
above. For example, you'll receive 3 years of standard support and 4 years of extended
support for LTS releases of the agent (11.0, 12.0, and so on). In cases where you plan to
use an OS platform for an extended period of time, you must also plan to upgrade the
agent software on a regular basis to stay within the support life cycle for any specific Deep
Security software release. In cases where an older agent is recommended for a given
platform, this agent will be considered a part of the overall solution and takes on the
support dates for the release in which it is contained. See the bullet below for details.
l Platforms continue to be supported until at least the OS vendor's end-of-extended-support
date. Where interest dictates, Trend Micro extends support significantly beyond this date.
l To ensure that you have the latest performance and security updates from your OS vendor,
Trend Micro strongly encourages you to move to the latest version of the OS for which an
agent is available.
l We strive to release a new version of the Deep Security Agent for all supported platforms.
However, in some cases we recommend the use of a previous release of the agent to
provide coverage for older platforms. For example, with Deep Security 11.0, the latest
agent for Windows 2000 is Deep Security Agent 9.6. This 9.6 agent becomes part of the
overall 11.0 Deep Security solution and takes on the support dates for the release in which
it is contained.
l You’ll always receive advance warning if we end support for a platform, and we’ll never
shorten the support life cycle of a software release post-General Availability (GA).*
* Once a platform is no longer supported by the OS vendor, there is a risk that a technical issue
arises that cannot be fixed without the support of the OS vendor. If this situation occurs, Trend
Micro will communicate the limitation to you immediately. Note that this situation may result in
loss of functionality. We will do our best to deal with any technical issues if they arise.
79
Trend Micro Deep Security On-Premise 20
Deep Security life cycle dates
Deep Security LTS life cycle dates
Subscribe via RSS
Please refer to Trend Micro’s latest End-of-Life Policy for more information on milestone
definitions and standard timelines.
Deep Security Manager supports the use of older agent versions (see "Deep Security Agent
platforms" on page 135), but we do encourage customers to upgrade agents regularly. New
agent releases provide additional security features and protection, higher quality, performance
improvements, and updates to stay in sync with releases from each platform vendor.
You can find more information in the "Deep Security 20 release strategy and life cycle policy" on
page 75. For feature releases, see "Deep Security FR life cycle dates" on page 84
Note: Products for the Japan region are handled under a region-specific policy.
Deep Security LTS release life cycle dates
The following table defines the dates for each Deep Security long-term support (LTS) release.
These dates define the life cycle for all components (manager, agents, relays, appliances,
security updates) within the release, with the exception of any items listed in the "Support
extensions" on the next page section, below.
End of
GA
Version Component Platform standard End of extended support (EOL)
date
support
31-
Deep 11-
Dec-
Security All All Feb-
2017
9.0 2013 Extended support was introduced in
(EOL)
Deep Security 10.0. See the Trend
Micro End-of-Life Policy for terms and
17- definitions.
Deep 13-
Aug-
Security All All Aug-
2018
9.5 2014
(EOL)
80
Trend Micro Deep Security On-Premise 20
End of
GA
Version Component Platform standard End of extended support (EOL)
date
support
12-
Deep 12-
Aug-
Security All All Aug-
2019
9.6 2015
(EOL)
Deep 09- 09-
Security All All Mar- Mar- 09-Mar-2021
10.0 2017 2020
Deep 22- 23-
Security All All May- May- 22-May-2022
11.0 2018 2021
Deep 20- 20-
Security All All Jun- Jun- 20-Jun-2023
12.0 2019 2022
Deep 30-
30-Jul-
Security All All Jul- 30-Jul-2024
2023
20.0 2020
Support extensions
The following table defines specific extensions to the life cycle dates listed above.
Updated
end of
Platform Component Version More information
life
(EOL)
Deep Security Windows 2000
Platform Support Update.
Updated the guidance on how to
Deep
30-Jul- use Trend Micro Deep Security to
Windows 2000 Agent Security
2023 * protect Windows 2003, Windows
9.6
XP, and Windows 2000 based
systems
81
Trend Micro Deep Security On-Premise 20
Updated
end of
Platform Component Version More information
life
(EOL)
Support will continue as defined in
the "Agent platform support policy"
on page 79
Deep Security Windows 2003
Platform Support Update.
Updated the guidance on how to
use Trend Micro Deep Security to
Deep
30-Jul- protect Windows 2003, Windows
Windows 2003 Agent Security
2023 *
10.0 XP, and Windows 2000 based
systems
Support will continue as defined in
the "Agent platform support policy"
on page 79
Updated the guidance on how to
use Trend Micro Deep Security to
protect Windows 2003, Windows
Deep XP, and Windows 2000 based
30-Jul-
Windows XP Agent Security systems
2023 *
10.0
Support will continue as defined in
the "Agent platform support policy"
on page 79
Deep 31-
Deep Security AIX Platform Support
AIX Agent Security Dec-
Update
9.0 2020
Deep 30-Jul- Support will continue as defined in
CloudLinux 5 (32-
Agent Security the "Agent platform support policy"
and 64-bit) 2023 *
9.6 on page 79
Deep Support will continue as defined in
Cloud Linux 6 (32- 30-Jul-
Agent Security the "Agent platform support policy"
bit) 2023 *
10.0 on page 79
82
Trend Micro Deep Security On-Premise 20
Updated
end of
Platform Component Version More information
life
(EOL)
Deep Support will continue as defined in
Cloud Linux 6 (64- 30-Jul-
Agent Security the "Agent platform support policy"
bit) 2023 *
11.0 on page 79
Deep Support will continue as defined in
30-Jul-
Debian 6 Agent Security the "Agent platform support policy"
2023 *
9.6 on page 79
Deep 20- Support will continue as defined in
Oracle Linux 5 Agent Security Jun- the "Agent platform support policy"
10.0 2023 * on page 79
Deep Support will continue as defined in
Red Hat 30-Jul-
Agent Security the "Agent platform support policy"
Enterprise Linux 5 2023 *
10.0 on page 79
SUSE Linux
Deep 23-
Enterprise Server Deep Security SuSE Enterprise
Agent Security May-
10 SP3, SP4 (32- Linux 10 Platform Support Update
9.6 2021
and 64-bit)
Deep Support will continue as defined in
30-Jul-
Ubuntu 10, 12 Agent Security the "Agent platform support policy"
2023 *
9.6 on page 79
Deep Support will continue as defined in
30-Jul-
Ubuntu 14 Agent Security the "Agent platform support policy"
2023 *
10.0 on page 79
* At this time, there are no plans to end support for this platform. This platform is currently
supported using an older version of Deep Security Agent. The EOL date will be revisited and
updated for this specific agent-platform combination with each annual long-term release of Deep
Security. Please see the "Agent platform support policy" on page 79 for more detail.
Archive of past support extensions
The following table lists support extensions that are now expired.
83
Trend Micro Deep Security On-Premise 20
Updated
end of
Platform Component Version More information
life
(EOL)
The 9.5 Deep Security Virtual Appliance's
embedded agent must be at version 9.6 to
Deep 12- adopt this EOL date. If you do not upgrade
All Appliance Security Aug- the embedded agent to 9.6, then an EOL
9.5 2019 date of August 17, 2018 applies. Upgrading
the embedded agent beyond 9.6 will not
extend the EOL date.
Deep Security Windows 2000 Platform
Support Update
Deep 12-
Windows Updated the guidance on how to use Trend
Agent Security Aug-
2000
8.0 2019 Micro Deep Security to protect Windows
2003, Windows XP, and Windows 2000
based systems
Deep 31-
Deep Security Solaris Platform Support
Solaris Agent Security Dec-
Update
9.0 2019
Only supported for use with Deep Security
Deep 09-
Manager 10.0.
HP-UX Agent Security Mar-
Support for HP-UX platform with Deep
9.0 2020
Security
Deep Security FR life cycle dates
Subscribe via RSS
Please refer to Trend Micro’s latest End-of-Life Policy for more information on milestone
definitions and standard timelines.
Note: To reduce the number of software releases and simplify understanding of the support
policy, we are no longer releasing Feature Releases (FR) after the release of Deep Security
20. See "Deep Security 20 release strategy and life cycle policy" on page 75.
84
Trend Micro Deep Security On-Premise 20
Note: Products for the Japan region are handled under a region-specific policy.
Deep Security FR release life cycle dates
The following table defines the dates for each Deep Security feature release (FR). These dates
define the life cycle for all components (manager, agents, relays, appliances, security updates)
within the release, with the exception of any items listed in the "Support extensions" on the next
page section, below.
Build End of
Version Component Platform GA date
number support
11-Jul- 22-Nov-
Deep Security 10.1 All All 10.1.*
2017 2018
24-Nov- 22-Nov-
Deep Security 10.2 All All 10.2.*
2017 2018
18-Jan- 22-Nov-
Deep Security 10.3 All All 10.3.*
2018 2018
16-Jul- 20-Dec-
Deep Security 11.1 All All 11.1.*
2018 2019
10-Oct- 20-Dec-
Deep Security 11.2 All All 11.2.*
2018 2019
07-Jan- 20-Dec-
Deep Security 11.3 All All 11.3.*
2019 2019
Deep Security 12 FR 2019- 23-Oct- 23-Apr-
Manager All 12.5.349
10-23 2019 2021
Deep Security 12 FR 2019- 12-Dec- 12-Jun-
Manager All 12.5.494
12-12 2019 2021
Deep Security 12 FR 2020- 27-Jan- 27-Jul-
Manager All 12.5.613
01-27 2020 2021
Deep Security 12 FR 2020- 12.5.0- 09-Mar- 09-Sep-
Agent Windows
03-09 713 2020 2021
Deep Security 12 FR 2020- Manager All 12.5.732 09-Mar- 09-Sep-
85
Trend Micro Deep Security On-Premise 20
Build End of
Version Component Platform GA date
number support
03-09 2020 2021
Deep Security 12 FR 2020- 12.5.0- 02-Apr- 02-Oct-
Agent Linux
04-02 814 2020 2021
Deep Security 12 FR 2020- 12.5.0- 16-Apr- 16-Oct-
Agent Windows
04-16 834 2020 2021
Deep Security 12 FR 2020- 29-Apr- 29-Oct-
Manager All 12.5.855
04-29 2020 2021
Deep Security 12 FR 2020- 12.5.0- 19-May- 19-Nov-
Agent Linux
05-19 936 2020 2021
Deep Security 12 FR 2020- 17-Jun- 17-Dec-
Manager All 12.5.985
06-17 2020 2021
Deep Security 12 FR 2020- 12.5.0- 17-Jun- 17-Dec-
Agent All
06-17 1033 2020 2021
Support extensions
The following table defines specific extensions to the life cycle dates listed above.
Updated
Version Component Platform end of More information
life
Deep
Deep Security 22- Extending Linux kernel updates for
Security
Agent Linux Linux Nov- Deep Security 10.x feature release
10.1, 10.2,
Kernel Updates 2019 agents
10.3
Deep
Deep Security 31- Extending Linux kernel updates for
Security
Agent Linux Linux Dec- Deep Security 11.1, 11.2, 11.3
11.1, 11.2,
Kernel Updates 2020 Feature Release Agents
11.3
86
Trend Micro Deep Security On-Premise 20
About the Deep Security components
Trend Micro Deep Security provides advanced server security for physical, virtual, and cloud
servers. It protects enterprise applications and data from breaches and business disruptions
without requiring emergency patching. This comprehensive, centrally managed platform helps
you simplify security operations while enabling regulatory compliance and accelerating the ROI
of virtualization and cloud projects.
For information on the protection modules that are available for Deep Security, see "About the
Deep Security protection modules" below.
Deep Security consists of the following set of components that work together to provide
protection:
l Deep Security Manager, the centralized web-based management console that
administrators use to configure security policy and deploy protection to the enforcement
components: the Deep Security Virtual Appliance and the Deep Security Agent.
l Deep Security Virtual Appliance is a security virtual machine built for VMware vSphere
environments that agentlessly provides anti-malware and integrity monitoring protection
modules for virtual machines in a vShield environment. In an NSX environment, the anti-
malware, integrity monitoring, firewall, intrusion prevention, and web reputation modules
are available agentlessly.
l Deep Security Agent is a security agent deployed directly on a computer which provides
application control, anti-malware, web reputation service, firewall, intrusion prevention,
integrity monitoring, and log inspection protection to computers on which it is installed.
l The Deep Security Agent contains a Relay module. A relay-enabled agent distributes
software and security updates throughout your network of Deep Security components.
l Deep Security Notifier is a Windows System Tray application that communicates
information on the local computer about security status and events, and, in the case of
relay-enabled agents, also provides information about the security updates being
distributed from the local machine.
About the Deep Security protection modules
Trend Micro Deep Security has tightly integrated modules that easily expand your security
capabilities:
87
Trend Micro Deep Security On-Premise 20
l "Intrusion Prevention " below
l "Anti-Malware " below
l "Firewall " below
l "Web Reputation " on the next page
l "Integrity Monitoring " on the next page
l "Log Inspection " on the next page
l "Application Control" on the next page
Intrusion Prevention
The Intrusion Prevention module inspects incoming and outgoing traffic to detect and block
suspicious activity. This prevents exploitation of known and zero-day vulnerabilities. Deep
Security supports "virtual patching": you can use Intrusion Prevention rules to shield from known
vulnerabilities until they can be patched, which is required by many compliance regulations. You
can configure Deep Security to automatically receive new rules that shield newly discovered
vulnerabilities within hours of their discovery.
The Intrusion Prevention module also protects your web applications and the data that they
process from SQL injection attacks, cross-site scripting attacks, and other web application
vulnerabilities until code fixes can be completed.
For more information, see "Set up Intrusion Prevention" on page 619.
Anti-Malware
The Anti-Malware module protects your Windows and Linux workloads against malicious
software, such as malware, spyware, and Trojans. Powered by the Trend Micro™ Smart
Protection Network™, the Anti-Malware module helps you instantly identify and remove malware
and block domains known to be command and control servers.
For more information, see "Enable and configure anti-malware" on page 554.
Firewall
The Firewall module is for controlling incoming and outgoing traffic and it also maintains firewall
event logs for audits.
For more information, see "Set up the Deep Security firewall" on page 658.
88
Trend Micro Deep Security On-Premise 20
Web Reputation
The majority of today’s attacks start with a visit to a URL that’s carrying a malicious payload. The
Web Reputation module provides content filtering by blocking access to malicious domains and
known communication and control (C&C) servers used by criminals. The Web Reputation
module taps into the Trend Micro Smart Protection Network, which identifies new threats quickly
and accurately.
For more information, see "Configure Web Reputation" on page 610.
Integrity Monitoring
The Integrity Monitoring module provides the ability to track both authorized and unauthorized
changes made to an instance and enables you to receive alerts about unplanned or malicious
changes. The ability to detect unauthorized changes is a critical component in your cloud
security strategy because it provides visibility into changes that could indicate the compromise of
an instance.
For more information, see "Set up Integrity Monitoring" on page 705.
Log Inspection
The Log Inspection module captures and analyzes system logs to provide audit evidence for PCI
DSS or internal requirements that your organization may have. It helps you to identify important
security events that may be buried in multiple log entries. You can configure Log Inspection to
forward suspicious events to an SIEM system or centralized logging server for correlation,
reporting, and archiving.
For more information, see "Set up Log Inspection" on page 766.
Application Control
The Application Control module monitors changes - "drift" or "delta" - compared to the
computer’s original software. Once application control is enabled, all software changes are
logged and events are created when it detects new or changed software on the file system.
When Deep Security Agent detects changes, you can allow or block the software, and optionally
lock down the computer.
For more information, see "Verify that Application Control is enabled" on page 808.
89
Trend Micro Deep Security On-Premise 20
About billing and pricing
Topics in this section:
l "Billing methods" below
l "What Deep Security considers as a protection-hour" on page 93
l "When protection-hours start and stop" on page 94
Billing methods
The billing methods available to you depend on your deployment type. For details, see the table
below and the descriptions below the table.
90
Trend Micro Deep Security On-Premise 20
Metered billing
You are billed based on the number of hours your computers are protected with Deep Security.
These are known as 'protection-hours'. Pricing for metered billing depends on the type of
metered billing you choose.
Bring-your-own license (BYOL)
You are billed based on a license that you pre-purchase from Trend Micro. For BYOL pricing,
please contact the Deep Security Support team.
Free tier billing
There are two free options:
l A 30-day trial. You are given unlimited access to Deep Security as a Service for 30 days.
l 5 instance unlimited: You are given unlimited access to Deep Security as a Service with a
5 agent maximum. You are placed automatically in the '5 instance unlimited' category
when your 30-day trial lapses, or when you cancel your metered or BYOL billing.
AWS subscription billing
Your Amazon Web Services (AWS) account is billed.
Azure subscription billing
Your Azure account is billed.
Pay as you Go billing
You are billed monthly for the protection-hours used the previous month.
The pricing for Pay as you Go is shown in the table below. The same rates apply for both AWS
and Azure subscriptions.
Note: The rates below only apply if you added the computers through the manager >
Computers > Add Account. If you used Computers > Add Computer, the protection-hours are
billed at the highest rate (Data Center) regardless of the computer's size.
91
Trend Micro Deep Security On-Premise 20
Cost per hour (in
Computer size Examples
USD) per instance
Amazon EC2: C1, M1, M3, T1, T2
Medium or Amazon WorkSpaces
$0.01
smaller
Azure: 1 core
Google: 1 core
Amazon EC2: C3, C4, M1, M3, M4, R3, T2
Large Azure: 2 cores $0.03
Google: 2-3 cores
Amazon EC2: C1, C3, C4, CC2, CG1, CR1, D2, G2,
HI1, HS1, I2, M1, M2, M3, M4, R3
Extra-large
$0.06
and greater Azure: 4 or more cores
Google: 4 or more cores
All computers in Deep Security Manager that are not
Data Center $0.06
from a cloud connector
Annual + Pay as you Go
You are billed based on a number of seats, or 'licenses', that you pre-purchase from Trend Micro.
1 seat equals 1 agent, and can be purchased for a 1 month, 1 year, 2 year, or 3 year term. If you
need to protect additional computers later, those overages are billed at the Pay as You Go rate.
To lower your costs, Trend Micro applies the Pay as You Go rate to the smallest size possible of
your instances, and uses the (cheaper) seat license rate for your largest instances. For example,
if you initially purchased 5 seats covering 5 medium instances, and then later added 4 more
large instances, your 5 seats would cover the 4 large instances you just added plus 1 of your
existing medium instances. The remaining 4 medium instances would be billed at the Pay as
you Go rate.
92
Trend Micro Deep Security On-Premise 20
Prepaid credit
You are billed based on a number of protection-hour credits that you pre-purchase from Trend
Micro. By prepaying, you receive a discount on Pay as you Go rates. Please contact the Deep
Security Support team for pricing details.
Trend Micro notifies you when an estimated 30 days of credit remain. The estimate is based on
current usage. If credits run out before you renew, then existing protection remains, but you won't
be able to activate Deep Security Agent on new computers, and existing agents won't receive
updates.
Tip: Commit to using Deep Security as a Service for one year and save up to 30% (for largest
instance sizes).
Credit card
Note: Credit card billing is no longer offered for new deployments. If you are already using
credit card billing, you can continue to use it.
You are billed monthly for the protection-hours used the previous month. The manager tallies
your hourly usage and sends the total owing that month to CleverBridge, a third-party billing
service, which subsequently bills you. CleverBridge handles all credit card information so Trend
Micro never sees any of it.
Credit card pricing is the same as Pay as you Go.
What Deep Security considers as a protection-hour
This section applies only to metered billing methods.
Cost is based on hours during which your computers are protected by Deep Security Agent.
Partial protection within a clock-hour boundary is considered a full hour. In the example below,
you can see how this is calculated in the usage scenarios below.
93
Trend Micro Deep Security On-Premise 20
When protection-hours start and stop
This section applies only to metered billing methods.
How Deep Security counts protection-hours varies by how the computer was added to the
manager:
l If added through Computers > Add Account: Protection-hours start when the instance is
powered on, and include hours when the Deep Security Agent status is "Offline".
Protection-hours stop when the instance is powered off, deleted, or the agent is
uninstalled.
l If added through Computers > Add Computer: Same as above, but excludes hours when
the Deep Security Agent status is "Offline".
Note: Even if an agent's status is "Offline", protection continues with the agent's last known
configuration. Other features such as centralized reporting, however, require connectivity with
the manager. To troubleshoot, see "Offline" agent. Alternatively, if the computer is
decommissioned and will be permanently offline, you should de-activate its agent on the
manager.
94
Trend Micro Deep Security On-Premise 20
About this release
What's new?
LTS releases of Deep Security are made available on an annual basis and include new
functionality, enhancements for existing functionality, and bug fixes. LTS releases include long-
term support, as described in "LTS release support duration and upgrade best practices" on
page 76. Once an LTS release is made generally available, updates to LTS releases are
restricted to only fixes and small enhancements.
With Deep Security 20, each component (manager, agent, appliance) can be released
independently. Agents for different platforms (Windows, Linux, Unix) can also be released
separately. An update may include one or more components and platforms.
Read:
l "What's new in Deep Security Manager?" below
l "What's new in Deep Security Agent?" on page 109
l "What's new in Deep Security Virtual Appliance?" on page 132
What's new in Deep Security Manager?
Deep Security Manager 20 update 2020-09-16
Release date: September 16, 2020
Build number: 20.0.174
New features
Improved management and quality
Agent Version Report: The Agent Version Report has been created in order for you to view a
summary of how many agents are using a specific agent version, the percentage of total agents
each version is using and an overview of how many agents are online and how many are offline,
all of which are broken down based on the Deep Security Agent's platform (OS). To generate the
report, go to Events & Reports > Generate Reports > Single Report > New > Agent Version
Report.
95
Trend Micro Deep Security On-Premise 20
Azure Government improvement: Azure Government resources can be added through the
Deep Security Manager Azure connector (Computers > Add > Add Azure Account). For more
information, see How do I protect Azure Government instances?.
Database encryption: The process of encrypting the communication between Deep Security
Manager and your database has been simplified. For more information, see "Encrypt
communication between the Deep Security Manager and the database" on page 1252.
Enhancements
l Reduced the time it takes to validate GCP service accounts when changing your GCP
Account Properties configuration. Previously, this took a long time when there were a large
number of auto-generated GCP projects. SEG-81743/SF03452889/DS-53515
l Updated the pager numbers, phone numbers and mobile numbers listed on the User
Properties window (click your email at the top of the console and select User Properties)
so they can be configured to exceed more than 30 digits.
l Updated the "My User Summary" widget on the console and the "User and Contact
Report" (Events & Reports > Generate Reports > Single Report) to reflect the logins that
have occurred in the last 30 days. SEG-81216/03407489/DSSEG-5897
l Added support for VMware Cloud Director (vCloud) 10.1.1 (with NSX-V only).
l Improved the "Scheduled report sending failed" error message by adding a more thorough
description. For more information, see Troubleshoot: Scheduled report sending failed.
SEG-77886/03221276/DS-54615
l Updated the New Malware Scan Configuration Properties (Policies > Common Objects
> Malware Scans > New) default settings to match the default settings for the Default
Malware Scan Configuration Properties.
Resolved issues
l The Computer Status widget on Deep Security Manager's dashboard did not display the
correct number of managed computers. DS-53294
l The Deep Security Agent trusted certificates were not automatically renewed. SEG-
79146/SF03240076/DS-52488
l The "AWS Contract License Exceeded" alert sometimes occurred even though the number
of protected computers did not exceed the limit. SEG-82932/SF03491496/DSSEG-5974
l Imported VMs in vClouds were unable to activate. SEG-75542/03189161/DS-53447
l The console sometimes showed the incorrect Log Inspection status. /DS-54630
96
Trend Micro Deep Security On-Premise 20
l Some Intrusion Prevention rules were designed to operate exclusively in "Detect Only"
mode, however you were able to change their behavior on the policy and computer pages.
DS-54667
l An incorrect number of overrides were displayed on Computer/Policy Editor > Overrides.
SEG-83802/03513073/DS-54710
l There was a rights issue with Scheduled Tasks that caused incorrect behaviors to occur
when creating them. SEG-78610/SF03320936/DS-53292
l The MasterAdmin could not create a scheduled task for all computers. DS-55522
l The "Ransomware Event History" widget on the dashboard displayed incorrect
information. DS-55494
Security updates
Security updates are included in this release. For more information about how we protect against
vulnerabilities, visit Vulnerability Responses. Please note, in line with responsible disclosure
practices, CVE details will only be made available for select security updates once patches have
been made available for all impacted releases. ( DS-52678 /DS-21167 /DS-53059)
Highest CVSS Score: 7.0
Highest severity: High
Notices
Red Hat Enterprise Linux 5 and 6 are no longer supported platforms for Deep Security Manager.
For a list of supported Deep Security Manager platforms, see "Deep Security Manager
requirements" on page 166.
Deep Security Manager 20 (long-term support release)
Release date: July 30, 2020
Build number: 20.0.60
Action required if you use cross-account roles to add AWS accounts to Deep
Security using the API /rest/cloudaccounts/aws
To better align with AWS best practices and improve AWS account security, we have made a
change to the process of adding a new AWS account into Deep Security using cross-account
roles. Previously, when using a cross-account role for authentication, Deep Security required
97
Trend Micro Deep Security On-Premise 20
two pieces of information: a role ARN, and an external ID trusted by the role. This has now
changed to a new process where Deep Security provides the external ID, and requires that the
role provided has included this external ID in its IAM trust policy. This change provides stronger
security in shared Deep Security environments, and ensures that strong external IDs are always
used. For details on the new process of adding cross-account roles using manager-generated
external ID, see "Add an AWS account using a cross-account role" on page 401.
Action Required:
Switch your external ID to a manager-generated one: "Update the external ID" on page 409.
If you're using cross-account roles with the API /rest/cloudaccounts/aws, see Action
required if you are using cross-account roles with the API /rest/cloudaccounts/aws.
New features
Updated platform support
l Red Hat Enterprise Linux 8 (64-bit)
l Windows Server 2019 (64-bit)
l Oracle 18 database support
l Oracle 19c database support
l PostgreSQL 11 database support
l SQL Server 2019 database support
Google Cloud Platform: Google Cloud Platform (GCP) has been integrated with Deep Security.
You can now view new GCP instances that come online or are removed, and which instances
have protection. If you are using multiple clouds on-premise and in your data center, Deep
Security can provide visibility for all of your environments. This feature is available for VMs that
have Deep Security Agent 12.0 or later installed. For details, see "Add a Google Cloud Platform
account" on page 429.
End of Support for Red Hat Enterprise Linux 6: Red Hat Enterprise Linux 6 is no longer a
supported platform for Deep Security Manager. Please upgrade your operating system.
Improved Security
Protect VMs in NSX-T environments: We have integrated the latest VMware Service Insertion
and Guest Introspection technologies which enables you to protect your guest VMs using
Intrusion Prevention, Web Reputation, Firewall, Integrity Monitoring and recommendation scans
on NSX-T hosts with agentless protection.
98
Trend Micro Deep Security On-Premise 20
Seamless network protection for NSX-T environments: Deep Security Manager now sends
guest VMs' network configuration to all Deep Security Virtual Appliances that are under the
same cluster. The effect is that the appliances can now maintain the protection of guest
machines that use the network features during and after a vMotion migration from one ESXi host
to another under the same cluster. This feature only applies to NSX-T environments where the
guest machine is using an assigned policy without network features overrides.
Continuous Anti-Malware protection for NSX-T environments: Deep Security Manager now
sends guest VMs' Anti-Malware real-time configuration to all Deep Security Virtual Appliances
that are under the same cluster. The effect is that the appliances can now maintain the protection
of guest machines that use the Anti-Malware real-time feature during and after a vMotion
migration from one ESXi host to another under the same cluster. This feature only applies to
NSX-T environments.
Agent version control: Agent version control gives you and your security operations team control
over the specific versions of the Deep Security Agent that can be used by features like
deployment scripts and upgrade on activation. This provides increased control over the Deep
Security Agent used in your environment. For more information, see "Configure agent version
control" on page 1117.
Improved management and quality
Differentiate between Red Hat and CentOS platforms: Deep Security Manager can distinguish
between a Red Hat and CentOS platforms and operations.
Visibility, Protection, and Management on Google Cloud Platform (GCP):
l VMs are organized into projects, which lets you easily see which GCP VMs are protected
and which are not.
l Assign policies automatically based on the GCP Instance Labels, GCP Network Tags, and
other instance attributes while auto-scaling up.
l Group related GCP instances in Smart Folders based on the GCP instance labels, GCP
network tags, and other instance attributes to simplify the management.
Automate Google and AWS accounts via REST API: As you move to more automated
deployments, having APIs to perform common tasks becomes a greater requirement Deep
Security provides REST APIs to allow you to automate the adding of both AWS and Google
Cloud accounts into Deep Security.
Actionable recommendations for Anti-Malware issues: In order for you to understand what is
happening in the Anti-Malware system, many Anti-Malware events have been updated to
99
Trend Micro Deep Security On-Premise 20
provide more details on why a cancellation or failure has occurred. These events can occur for
manual, quick, or scheduled Anti-Malware scans. The enhanced detail is provided in the events
with Deep Security Manager as well as provided through SIEM or AWS SNS.
NSX-T Network Throughput improvement: By introducing the Data Plane Development Kit
(DPDK), we've made the network throughput three times faster when compared with prior
technology, Raw Socket.
Search Cloud Instance Metadata: Added the ability to do a simple search or advanced search
for Cloud Instance Metadata on the Computers page. This allows you to easily find workloads
with specific labels, network tags, and more.
Instance Metadata Service Version 2 (IMDSv2) support: IMDSv2 is supported in this release.
For details, see "How does Deep Security Agent use the Amazon Instance Metadata Service?"
on page 1515
Upgrade on activation: Deep Security Manager now has options (Administration > System
Settings > Agents > Automatically upgrade Linux/Windows agents on activation) that enable
you to automatically upgrade the Deep Security Agent on Linux and Windows computers to the
version specified in Administration > System Settings > Updates > Software > Agent Version
Control when the agent is activated or reactivated. For details, refer to "Automatically upgrade
agents on activation" on page 1139.
Enhanced visibility of scheduled scan tasks and event based tasks: Scheduled scan tasks and
event-based tasks have been improved by providing scan visibility as well as specific reasons
for each uncompleted Anti-Malware scan and recommended actions to resolve the scan.
Reporting improvements to allow chargeback to cloud accounts: The Security Module Usage
Report now includes the Cloud Account ID (AWS Account ID, Azure Subscription ID or GCP
Project ID) for protected instances.
Multiple vCenters: You can add multiple vCenters in the Deep Security Manager, and associate
them to the same NSX-T Data Center. An overwrite warning message is displayed if you are
using NSX Data Center for vSphere (NSX-V), which does not support the use of multiple
vCenters, or if the NSX-T Manager has being registered with another Deep Security Manager
cluster.
Enhancements
UI improvements:
100
Trend Micro Deep Security On-Premise 20
l Added file hash values to Anti-Malware events that are exported to CSV (Events &
Reports > Anti-Malware Export > Export to CSV). SEG-61890/SF02510024/DS-
53441</p>
l Updated the descriptions related to memory on the System Information page so they're
more accurate and easier to understand.
l Improved the description of Behavior Monitoring events by including the reason the event
occurred.
l Added a GCP Network Tag column to the Computers tab.
l Added GCP information such as Instance ID, Labels, Network tags, and more, to
Computer Editor > Overview > General.
l Added the Cloud Instance Metadata field to the Computers page.
l Added a progress bar to Administration > User Management > Roles > New > Computer
Rights > Selected Computers to indicate the status of the computers list that's loading.
l If there are a lot of agent events in a single heartbeat, they will be split into multiple "Event
Retrieved" events.
l Enhanced the Relay management experience by providing possible solutions for the
"Empty Relay Group Assigned" alert in the alert's description and removing the relay count
for tenants that are using the Primary Tenant Relay Group.
l Added "Database Type" and "Database Server" columns to Administration > Tenants.
l Added the "Kernel Unsupported" system event to indicate if your computer has been
upgraded to an unsupported kernel.
l Added a reason ID for the "Manual Malware Scan Cancellation complete" system event.
The reason ID is displayed in REST API calls, SNS information and SIEM information.
l Renamed the scheduled task "AWS Billing Usage Task" to "Metered Billing Usage Task"
because the task now applies to both AWS and Azure billing.
l Added the "TrendMicroDsPacketData" field to Firewall events that are syslog forwarded
via the Deep Security Manager.
l Added the Validate the signature on the agent installer checkbox on Support >
Deployment Scripts. For more information, see "Check digital signatures on software
packages" on page 196.
l Improved the "License Changed" event description by specifying if the plan ID is for Azure
Marketplace billing.
l Renamed the Service Token setting to Data Source GUID on Administration > System
Settings > Managed Detection and Response.
101
Trend Micro Deep Security On-Premise 20
l Added a "Agent GUID" column to the Computers page so you can search computers by
the Agent GUID.
l Included a search bar under Administration > Updates > Software > Local.
l When creating a smart folder, you can now select "Version" as the filter criteria to filter
computers based on their Agent version.
l Added the ability to hide all empty AWS regions, VPCs, subnets, and directories, reducing
clutter and increasing load speed on the Computers page.
l Aggregated identical agent events in a single heartbeat under a single event.
l Modernized the Policies > Lists > Port Lists page.
l When creating a smart folder, you can now select "Task(s)" as the filter criteria, which
filters for values displayed in the "Task(s)" column on the Computers page. For example,
you could create a smart folder that lists all computers that contain "Scheduled Malware
Scan Pending (Offline)" as the task. Additionally, if you are using the Deep Security API to
search for computers, you can now search on the value of the tasks/agentTasks and
tasks/applianceTasks fields.
l Deep Security Manager now prevents you from importing duplicate Trusted Certificates.
l Redesigned the Computers > Add Account synchronization scheduling to handle many
more connectors per tenant, reduce idle thread time, and sync connectors with invalid
credentials less frequently.
l By default, the "My User Summary" widget on the Dashboard only displays information
about sign-ins that have occurred within the last 24 hours.
l You can choose not to send packet data back to the Deep Security Manager by going to
Administration > Agents> Data Privacy and selecting No.
l Deep Security Manager diagnostic packages have the ability to be encrypted. To encrypt
your package and logs, go to Administration > Create Diagnostic Package > Enable AES
256 encryption and enter a password.
Note: Encrypted zips cannot be extracted using the default ZIP extraction tool available
in Windows, it needs to be extracted by 3rd party tools like 7Zip, WinZip etc.
l Redacted potentially sensitive information from the diagnostic packages and logs.
Event-based tasks:
l Improved the capability of event-based tasks by adding support for GCP security
automation with account name, labels, network tags and more in the task conditions.
102
Trend Micro Deep Security On-Premise 20
l Introduced "Cloud Vendor" in the event-based tasks conditions in order to limit a task's
scope for a specific public vendor (for example, AWS or GCP).
Commands:
l Added the following command:
dsm_c -action changesetting -name
com.trendmicro.ds.antimalware:settings.configuration.maxSelfExtractRT
ScanSizeMB -value 512
When Deep Security Agent could not determine the type of the target file, the scan engine
loaded the file to memory to identify if it was a self-extract file. If there were many of these
large files, the scan engine consumed lots of memory. Using the command above, the file-
size limitation is set to 512MB for loading target files. When the file-size exceeds the set
limitation, the scan engine will skip this process and scan the file directly.
To implement this enhancement:
1. Run the command in Deep Security Manager to change the value in the database.
2. Send the policy to your target Deep Security Agent to deploy the setting.
l Added the ability for the Deep Security Administrator to hide unresolved recommendation
scan results from the Intrusion Prevention, Integrity Monitoring and Log Inspection tab in
the policy pages. To hide the unresolved recommendation scan results, use the following
commands
Intrusion Prevention:
dsm_c -action changesetting -name
com.trendmicro.ds.network:settings.configuration.showUnresolvedRecomm
endationsInfoInPolicyPage -value false
Integrity Monitoring:
dsm_c -action changesetting -name
com.trendmicro.ds.integrity:settings.configuration.showUnresolvedReco
mmendationsInfoInPolicyPage -value false
Log Inspection:
dsm_c -action changesetting -name
103
Trend Micro Deep Security On-Premise 20
com.trendmicro.ds.loginspection:settings.configuration.showUnresolved
RecommendationsInfoInPolicyPage -value false
Enhanced scheduled tasks:
l Task enabled has been renamed to Enable task on the last screen of the Create
Scheduled Task wizard
l Synchronize cloud account now indicates it only supports vCloud and Azure connectors
l Computer/group selection details now display in list view for Anti-Malware scans and
Intrusion Prevention tasks
Virtual Appliance:
l Added the ability to auto-activate guest VMs protected by the Deep Security Virtual
Appliance in an NSX-T environment.
l Added the "VMware NSX Policy Configuration Conflict" system event. This event is
generated when Deep Security Manager detects that a NSX-T group is configured with
different security policies for Endpoint Protection and Network Introspection (E-W).
l Updated Deep Security Manager to allow vCloud accounts to be added even if the virtual
machine hardware information is missing.
l When you upgrade the Deep Security Virtual Appliance SVM in NSX-T Manager, Deep
Security Manager will now detect that a new SVM is now protecting guest VMs, and will
auto-activate those VMs after the upgrade.
l Upgraded the vCloud Connector in Deep Security Manager supports vCloud 9.7 and
vCloud 10.0.
l Added the ability to sync Deep Security Manager policies to NSX-T environments.
l Improved the experience when deleting vCenter Connectors with NSX-T Manager.
Previously, you had to manually remove the NSX-T component as a service profile,
endpoint rules and service deployments, or the vCenter deletion would fail.
l Deep Security Manager can now connect to NSX-T Data Center using LDAP account
credentials. Previously, only local NSX-T account credentials could be used.
Other:
l When Anti-Malware actions fail, the results will be displayed in the Syslog result field.
104
Trend Micro Deep Security On-Premise 20
Resolved issues
l When the Hide Unlicensed modules option was selected on Administration > User
Management > Users > customer's current account > Settings, all of the modules were
hidden. SEG-77037/03228448/DS-51202
l When the Alert on any Computer action was selected for Intrusion Prevention, Firewall,
Integrity Monitoring or Log Inspection rules, the computers were not automatically updated
with the new policy. SEG-66986/SF02684105/DSSEG-5201
l Sometimes, you couldn't edit a smart folder. SEG-74078/SF03120830/DSSEG-5450
l When the Alert on any Computer action was selected for Intrusion Prevention, Firewall,
Integrity Monitoring or Log Inspection rules, the computers were not automatically updated
with the new policy. DS-50216/SEG-77260
l Anti-Malware events that were marked as "Pass" were not properly counted on the
dashboard or under Anti-Malware events. DS-49364/SEG-70872
l When an agent activated with no AWS metadata but then provided it on a later heartbeat,
the cloud provider was not updated, which caused the computer to never be rehomed
properly. DS-50713/SEG-77150
l When you did an advanced search on the Computers page for Status Light > Equals >
Managed [Green], then selected Export to CSV, the CSV file did not contain the listed
computers. DS-49936/SEG-74140
l Azure accounts could not be added in Azure Government regions because the login
endpoint was changed. This only applies to Azure Marketplace deployments. DS-52399
l After upgrading VMware ESX, you had to manually re-sync the vCenter to see the new
platform information. DS-50053
l For tenants, the Security Module Usage Report was only visible if you had access to the
default "Full Access" role. (SEG-70494/SF02940195/DS-47492)
l The sign-up page did not render properly in Internet Explorer. (SEG-
73072/SF03075345/DS-48944)
l When several emails with large bodies were queued, they were loaded all at once instead
of in batches, which caused a large amount of memory to be used. (SEG-
71863/SF03024164/DS-49833)
l When the "Untagged" filter was selected on the dashboard, some widgets continued to
display tagged items. (SEG-63290/SF02585007/DS-43795)
l Tenants in a multi-tenant setup could move their relays to the primary tenant relay group.
This would cause the relays to disappear from their 'Relay Management' page. Tenants
105
Trend Micro Deep Security On-Premise 20
are now prevented from moving their relays to the primary tenant relay group. (SEG-
57715/02322762/DS-47509)
l Performance issues occurred when there were 1,000s of requests to download the same
SVG file because the file wasn't cached. (SEG-64280/DS-45002)
l AIA hosts with the same Virtual UUID fail when "Activate a new Computer with the same
name" was selected. (SEG-66346/02725330/DS-45423)
l In some multi-tenant environments, you could not log in as a tenant. For more information,
see https://success.trendmicro.com/solution/000238704. (SF02873892/SEG-68674/DS-
46391)
l When Integrity Monitoring was enabled but Anti-Malware was turned off, a warning
message would appear indicating "Security Update: Pattern Update on Agents/Appliance
Failed". (SEG-68454/SEG-67859/DS-32205)
l In the Malware Scan configurations window, the content of the Advanced tab was
displayed in the General tab. (SEG-64701/SF02657864/DS-44176)
l Deep Security Manager had issues loading the computers trees on some pages when
there were a lot of computers and folders. (SEG-58089/SF02345427/DS-44424)
l AWS connectors sometimes failed to synchronize. (SEG-66472/DS-45029)
l The column names in the CSV output of the "Security Module Usage Report" were
partially misaligned with the data columns.(SEG-66717/SF02619240/DS-45130)
l In the Malware Scan Configuration window (Computers/Policies > Anti-Malware >
General > Manual Scan > Edit > Advanced and select Scan Compressed File) the
Maximum number of files to extract setting could not be set to 0, meaning unlimited.
(SEG-65997/02685854/DS-45081)
l Deep Security Manager with PostgreSQL sometimes stopped forwarding events to AWS
SNS. (SEG-67362/SF02798561/DS-45594)
l When Deep Security Manager was deployed in an environment with a large number of
hosts and protection rules, the manager would sometimes load data for all hosts, even if
the user only requested data from some of the hosts. (SF02552257/SEG-62563/DS-43188)
l When booting up, Deep Security Manager validates the database schema of the events
tables. Logs always said that the schema was updated, even if no update was actually
required. (DS-43196)
l Active Directory synchronization sometimes would not finish. (SEG-52485/DS-38203)
l When a custom Anti-Evasion posture was selected in a parent policy (in the policy editor
Settings > Advanced > Network Engine Settings > Anti-Evasion Posture > select
106
Trend Micro Deep Security On-Premise 20
'Custom'), that setting did not appear in the child policies. (SF02434648/SEG-60410/DS-
41597)
l On Linux systems, the default maximum number of the concurrent opened files did not
meet Deep Security Manager's needs, resulting in the manager failing to acquire file
handles. As a result, features in Deep Security Manager failed randomly and a "Too many
open files" message appeared in logs. (SEG-59895/DS-43192)
l The "Activity Overview" widget sometime displayed the incorrect database size.
(SF02449882/SEG-63362/DS-43946)
l When sorting the "Alert Configuration" page by the "ON" column, the number of alerts was
sometimes incorrect. (SF02578797/SEG-63560/DS-43685)
l Certain smart folder search criteria caused an IllegalStateException error.
(SF02436019/SEG-60330/DS-41369)
l The memory usage percentage display on the "Manager Node Status" dashboard widget
did not match the last recorded system memory usage percentage. (SF02218013/SEG-
55761/DS-39149)
l In Deep Security Manager, under Policies > Intrusion Prevention Rules > Application
Types > (select DNS client) > Properties > General, the Port setting would change to
"Any" after any updates to the port list. (SEG-55634/DS-39444)
l Reconnaissance alerts could not be disabled because the option was not available. (SEG-
49907/DS-35122)
l Some Azure Virtual Machine types categorized incorrectly. (SF01885266/SEG-48561/DS-
33951)
l Users of AWS Marketplace metered-billing would see an error reported in system events
when the billing job was processed. (SF1899351/SEG-48580/DS-33955)
l Integrity Monitoring detailed change and recommendation reports was not running against
smart folders. (SF2056260/SEG-51781/DS-35886)
l When the Computers page was grouped by status, it sometimes didn't display the correct
total number of computers for each group. (SF01655622/SEG-44858/DS-37769)
l When Deep Security Manager was connected to both a case-sensitive Microsoft SQL
database and VMware NSX, the Deep Security Manager upgrade readiness check would
sometimes fail and block the upgrade. (SF02060051/SEG-52044/DS-38405)
l Scheduled task scans could be initiated by a user for computer groups that they do not
have access to in their roles, which caused an error to occur. (SF02119582/SEG-
53275/DS-38892)
107
Trend Micro Deep Security On-Premise 20
l Deep Security Agent sometimes went offline when duplicate virtual UUIDs were stored in
the database. (SF01722554/SEG-41425/DS-39272)
l False alerts regarding the license expiration were occasionally raised. (SF01484611/SEG-
41437/DS-33831)
l Using a local key secret containing the $ symbol stopped the upgrade or fresh install of
Deep Security Manager. (SF02013831/SEG-57243/DS-39526)
l Deep Security used an open source library called SIGAR that is no longer maintained or
supported. This can cause applications to crash and other unintended issues in the future.
(SF02184158/SEG-54629/DS-39394)
l When an invalid or unresolvable SNMP server name was configured in Administration >
System Settings > Event Forwarding > SNMP, it caused SIEM & SNS to also fail.
(SF02339427/SEG-57996/DS-39865)
l Forwarding events "via Deep Security Manager" with SIEM event forwarding would not
work if the Deep Security Manager hostname was not obtained through DNS resolution.
(SEG-50655/DS-37374)
l The events exported via AWS SNS did not contain the HostOwnerID, which corresponds
to the AWS Account ID. (SF02420860/SEG-59870/DS-41089)
l In the computer or policy editor in Deep Security Manager, under Anti-Malware > General
> Real-Time Scan > Schedule > Edit, the Assigned To tab was sometimes empty, even
when the schedule was assigned correctly to computers and policies. (SF02374723/SEG-
58761/DS-41036)
Security updates
Security updates are included in this release. For more information about how we protect against
vulnerabilities, visit Vulnerability Responses. (DS-45446/DS-44955/DS-43627/DS-28754/DS-
32322/DS-33833/DS-26068)
Highest CVSS score: 9.8
Highest Severity: Critical
l Updated the JRE to the latest Java Update (8.0.241/8.43.0.6).
l Updated third-party libraries used by Deep Security Manager. (DS-24214)
l Upgraded Apache Tomcat to 8.5.53. (VRTS-4652)
108
Trend Micro Deep Security On-Premise 20
Known issues
l If you are using an Oracle database, this upgrade will take longer than usual due to a
database schema change. For more information about Deep Security Manager upgrades,
see Upgrade Deep Security Manager.
l When a new Deep Security Virtual Appliance is deployed, the VM name is displayed as
"Trend Micro_Custom - <version>", if you're using a local web server to store the Deep
Security Virtual Appliance software package. This has no effect on the integrity of the
appliance.
l Due to issues discovered during internal testing with SQL 2008 we will now be blocking
upgrades to Deep Security feature release when SQL 2008 is the Deep Security Manager
database. Microsoft SQL Server 2008 is no longer supported by Microsoft and therefore is
no longer being tested and supported for use as a database for the latest releases of Deep
Security Manager. For more information from Microsoft please see End of support for SQL
Server 2008 and SQL Server 2008 R2. For the full list of databases supported for use with
Deep Security Manager please see "Deep Security Manager requirements" on page 166
system requirements. (DS-36715)
l The automatic removal of a vCenter account from Deep Security will fail if NSX-T is
configured to have the same service chain bound to Deep Security and third-party services
simultaneously. This problem occurs because the NSX-T API doesn't allow Deep Security
to modify the service chain with its associated service profiles. To work around this issue,
remove vCenter manually. For details, see "Uninstall Deep Security from your NSX
environment" on page 1331. DS-47944
l Deep Security Manager no longer supports NSX-T Manager version 2.x. Upgrade your
NSX-T Manager to version 3.0.0 or later. DS-50387
What's new in Deep Security Agent?
Linux
Deep Security Agent 20.0.0-1194 (20 LTS Update 2020-10-05)
Release date: October 5, 2020
Build number: 20.0.0-1194
109
Trend Micro Deep Security On-Premise 20
New features
Improved performance for real-time Anti-Malware scanning on Linux: Real-time Anti-
Malware scans have been improved for Deep Security Agent on Linux, resulting in
increased response time, faster processing, and reduced CPU usage. Previously, all
files were scanned during read/write. Now, Anti-Malware scanning is more efficient and
file scanning during write is deferred (the file is added to a queue and scanned in the
background).
Differentiated platforms: Deep Security Manager can now distinguish between Red
Hat and CentOS platforms and operations. DS-52682
Continued network scans: After migrating guest VMs to another ESXi host in the same
cluster using vMotion, the Deep Security Virtual Appliance's network scans will now
continue where they left off, without delay. This feature only applies if you are using
NSX-T Data Center and guest machines are using a policy without network feature
overrides. DS-50482
Enhancements
l Real-time Integrity Monitoring explicitly matches the directory specified in the base
directory. Previously, it matched all paths that started with the base directory. DS-
52692
l Integrity Monitoring detects changes to the "setuid" and "setgid" attributes for
Linux and Unix platforms. DS-52061
l Ceph is now excluded from file system kernel hooking to prevent kernel panic.
SEG-75664/SF03131718/DS-50298
l Recommendation Scans and Integrity Monitoring are now enabled for NSX-T
environments. DS-50478
l Extended the scope of the "If a computer with the same name already exists"
setting on Administration > System Settings > Agents to apply to existing
unactivated computers. Previously, it only applied to existing activated computers.
DS-51800
Resolved issues
l After upgrading the Deep Security Agent, the "Sending Application Control
Ruleset Failed" error sometimes occurred. DS-49828
110
Trend Micro Deep Security On-Premise 20
l The Anti-Malware engine on Deep Security Virtual Appliance went offline when
the signer field in the Census server reply was empty. DS-49807
l Anti-Malware directory exclusion with wildcards didn't match subdirectories
correctly. DS-50245
l Deep Security Agent on Linux would sometimes crash. SEG-
76460/SF03218198/DS-50852
l Deep Security Agent reported incorrect network interface information. SEG-
77161/DS-51397
l The Deep Security Virtual appliance did not detect the Eicar test file. SEG-
71955/SF02955546/DS-49387
l Application Control did not include scripts with the extension ".bash" in the
inventory. This resulted in these scripts being blocking in lock down mode. DS-
50696
l The Anti-Malware driver caused a system hang on Linux platforms where autofs
was used. DS-51926
l The Behavior Monitoring feature of Anti-Malware sometimes raised false alarms.
DS-44974
l When Integrity Monitoring was enabled, the owner of a file was incorrectly
changed to a user that did not exist. DS-52058
l There was an upgrade issue with Deep Security Agent which would sometimes
prevent the agent from going online if Integrity Monitoring or Log Inspection were
enabled. DS-50672
l Kernel Panic occurred when Web Reputation, Firewall, or Intrusion Prevention
were enabled. SEG-80201/DSSEG-5846/DS-52975
l When Anti-Malware real-time scans were enabled in Linux, sometimes the system
crashed because buffers from procfs were not validated. SEG-80183/DS-53204
l When a re-transmission packet with new packets was sent, it sometimes produced
an "Unsupported SSL Version" Intrusion Prevention event. SEG-73893/DSSEG-
5866/DS-53144
l When Deep Security real-time Anti-Malware was enabled on a Linux system, it
caused a high amount of CPU usage. SEG-75739/DS-52976
111
Trend Micro Deep Security On-Premise 20
Security updates
Security updates are included in this release. For more information about how we
protect against vulnerabilities, visit Vulnerability Responses. Please note, in line with
responsible disclosure practices, CVE details will only be made available for select
security updates once patches have been made available for all impacted releases.
VRTS-3704/DS-41233
Highest CVSS score: 4.4
Severity: Medium
Deep Security Agent 20 (long-term support release)
Release date: July 30, 2020
Build number: 20.0.0.877
New features
Enhanced platform support
l Ubuntu 20.04 (64-bit)
l Cloud Linux 8 (64-bit)
l Debian Linux 10 (64-bit)
l Oracle Linux 8 (64-bit)
l SUSE Linux Enterprise Server 15 (64-bit)
l Red Hat Enterprise Linux 8 (64-bit)
l CentOS 8 (64-bit)
SystemD support: SystemD is a Linux service manager that allows services to declare
dependencies, which can enforce load and unload sequences of kernel modules and
other services. See "Systemd support" on page 140 for information about which
platforms are supported. (DS-37395)
Secure Boot support: Deep Security Agent supports additional Linux operating systems
with Secure Boot enabled. For details, see "Secure Boot support" on page 142.
112
Trend Micro Deep Security On-Premise 20
Improved security
Agent integrity check: Deep Security verifies your signature on the Deep Security Agent
to ensure that the software files have not changed since the time of signing.
Protect VMs in NSX-T environments: We have integrated the latest VMware Service
Insertion and Guest Introspection technologies which enables you to protect your guest
VMs using Intrusion Prevention, Web Reputation, Firewall, Integrity Monitoring and
recommendation scans on NSX-T hosts with agentless protection.
Seamless network protection: Deep Security Manager now sends guest VMs' network
configuration to all Deep Security Virtual Appliances that are under the same cluster.
The effect is that the appliances can now maintain the protection of guest machines that
use the network features during and after a vMotion migration from one ESXi host to
another under the same cluster. This feature only applies to NSX-T environments where
the guest machine is using an assigned policy without network features overrides.
SELinux Support: Security-Enhanced Linux (SELinux) enforcing mode is supported on
Red Hat Enterprise Linux 7 and Red Hat Enterprise Linux 8. Deep Security Agent is
compatible with the default SELinux policies.
Note: Anti-Malware software such as ds_agent is required to run in an unconfined
domain in order to protect the system. Any additional SELinux policy customization or
configuration might be block blocked or fail because of ds_agent.
SSL improvements: Deep Security supports handshake hello_request (rfc5246) and
Extension encrypt_then_mac (rfc7366) in SSL inspection.
Continuous Anti-Malware protection: Deep Security Manager now sends guest VMs'
Anti-Malware real-time configuration to all Deep Security Virtual Appliances that are
under the same cluster. The effect is that the appliances can now maintain the
protection of guest machines that use the Anti-Malware real-time feature during and
after a vMotion migration from one ESXi host to another under the same cluster. This
feature only applies to NSX-T environments.
Improved management and quality
Automate the upgrade of agents in your environment: Deep Security gives you the
flexibility to decide if new agents, when activated, should be upgraded to a newer
version if one is available. This can be particularly useful in cases where application
113
Trend Micro Deep Security On-Premise 20
teams are using older golden images containing a version of the agent that is out of
date. Simply enable upgrade on activation, define the lineup of agents you want to use
in your environment using Agent Version Control, and as older agents come online and
activate they are automatically upgraded for you.
NSX-T Network Throughput improvement: By introducing the Data Plane
Development Kit (DPDK), we've made the network throughput three times faster when
compared with prior technology.
Upgrade to supported paths: The "upgrade on activation" feature will only upgrade the
agent on the computer from the last two major releases. If the agent does not meet the
criteria, you must upgrade the agent manually to a release within the last two major
releases. Then the "upgrade on activation" feature will detect the newer version and
complete the upgrade to the designated release.
Protection for AWS accounts with incorrect credentials: In the past, if your credentials
were entered incorrectly for AWS accounts in Deep Security, the agent failed to activate.
This might have occurred because the credentials were entered incorrectly or because,
over time, the credentials changed without a corresponding update on Deep Security.
To help ensure protection remains in place in this situation, which in many cases is a
simple configuration error, we will now create the computer outside of the account and
allow the agent to activate.
Instance Metadata Service Version 2 (IMDSv2) support: IMDSv2 is supported in this
release. For details, see "How does Deep Security Agent use the Amazon Instance
Metadata Service?" on page 1515
Actionable recommendations for scan failures: The Deep Security Agent provides
actionable information about why a scheduled malware scan has been cancelled, and
the recommended actions that should be taken to remedy the failure. For more
information, see "Anti-Malware scan failures and cancellations" on page 833.
Anti-Malware real-time file scan report: Deep Security has the ability to determine the
top 10 files that are scanned by Anti-Malware real-time scan. This provides a starting
point for performance evaluating and tuning, as you can use this information to set file
exclusions and avoid unnecessary scans. The 'AmTopNScan.txt' file with the collected
data can be generated using the following methods:
114
Trend Micro Deep Security On-Premise 20
l By the command dsa_control --AmTopNScan
l By the diagnostic service
Improved process exceptions: The process exception experience has been improved
in the following ways:
l We've provided information about why process exclusion items are not functioning
correctly so you can troubleshoot the issue and know which actions to take to
resolve it.
l We've improved the process exception configuration workflow to make it more
robust.
Enhancements
l Integrity Monitoring detects changes to the "setuid" and "setgid" attributes for
Linux and Unix platforms.
l Improved the heartbeat handling for Amazon WorkSpaces deployments when the
workspace sync feature is not turned on for the matching AWS connector.
l Extended the scope of the If a computer with the same name already exists
setting on Administration > System Settings > Agents to apply to existing
unactivated computers. Previously, it only applied to existing activated computers.
l Improved the Deep Security Agent activation experience in the following ways:
l Enhanced the agent-initiated activation experience by displaying the
activation status (for example, a success message or a message that
explains a newer Deep Security Manager version is required) on Deep
Security Manager.
l After migrating guest VMs to another ESXi host in the same cluster using vMotion,
the Deep Security Virtual Appliance's Anti-Malware real-time scans will now
continue where they left off, without delay. This feature only applies to NSX-T
environments.
l Increased the scan engine's URI path length limitation.
l Added the ability for Deep Security Agent Anti-Malware to scan compressed files
no matter their data types when IntelliScan is disabled.
l Enhanced Linux real-time Anti-Malware performance when executing a Docker
pull command.
115
Trend Micro Deep Security On-Premise 20
l Improved the time it takes to auto-activate guest VMs protected by the Deep
Security Virtual Appliance in an NSX-T environment.
Note: This feature requires Deep Security Manager FR 2019-12-12 or newer
releases.
l Streamlined event management for improved agent performance.
l Added the ability to enable or disable Common Scan Cache for each agent
through a CLI command.
l Enhanced the Malware Scan Failure event description to indicate the possible
reason.
l Enhanced the Anti-Malware kernel level exclusion on Linux. File events coming
from remote file systems won't be handled by Deep Security Agent anymore when
Network Directory Scan is disabled.
l Added the ability to retrieve process and container information for Intrusion
Prevention events, including process name, container ID, container name, image
name, image digest and pod ID.
Resolved issues
l When Anti-Malware real-time scans were enabled in Linux, sometimes the system
crashed because buffers from procfs were not validated. SEG-80183/DS-53204
l When Deep Security real-time Anti-Malware was enabled in Linux, it caused a
high amount of CPU system usage. SEG-75739/SF03036857/DS-52976
l Ceph caused kernel panic. SEG-75664/SF03131718/DS-50298
l Deep Security Agent sometimes crashed. SEG-76460/SF03218198/DS-50852
l Deep Security Agent reported incorrect network interface information. SEG-
77161/DS-51397
l The Deep Security Virtual Appliance did not detect an Eicar file. SEG-
71955/SF02955546/DS-49387
l Application Control did not include scripts with the extension ".bash" in the
inventory. This resulted in these scripts being blocked in lock down mode. SEG-
73174/DS-50696
l Deep Security Virtual Appliance sometimes went offline. (SEG-53294/DS-46728)
116
Trend Micro Deep Security On-Premise 20
l The interface isolation feature was still on when Firewall was turned off. (SEG-
32926/DS-27099)
l In a Red Hat Enterprise Linux 5 or 6 or a CentOS 5 or 6 environment, Integrity
Monitoring events related to the following rule were displayed even if users or
groups were not created or deleted: 1008720 - Users and Groups - Create and
Delete Activity. (SEG-22509/DS-25250)
l Integrity Monitoring events showed an incorrect file path with Unicode encoding.
(SEG-45239/DS-33911)
l Anti-Malware events displayed a blank file path with invalid Unicode encoding.
(SEG-46912/DS-34011)
l Certain data structures in the Deep Security Agent packet engine were cleaned up
prematurely, leading to a kernel panic and system crash. (SF01423970/SEG-
43481/DS-34436)
l Kernel panic occurred when dsa_filter.ko was obtaining network device's
information. (SEG-50480/DS-35192)
l An SAP system with Java running in a Linux environment failed to start when
Deep Security Scanner returned an error code without an error message.
(SF01339187/SEG-38497/SEG-33163/DS-31330)
l Kernel panic occurred because of redirfs. (SF01137463/SEG-34751/DS-32182)
l Deep Security Anti-Malware caused the 'fusermount' process to fail when
mounting the filesystem. (SF01531697/SEG-43146/DS-32753)
l Deep Security Agent's Intrusion Prevention module silently dropped zero payload
UDP packets. (SEG-39711/DS-32799)
l For Web Reputation, Deep Security Agent sent the incorrect credentials to the
proxy, which returned HTTP 407. (SF01704358/SEG-45004/DS-32077)
l Deep Security Agent GSCH driver had an issue with another third-party file
system. (SF01248702/SEG-44565/DS-33155)
l The "Environment Variable Overrides" for Deep Security Anti-Malware did not
work in Linux. (SEG-43362/DS-31328)
l Deep Security Agent process potentially crashed when the detailed logging of
SSL message was enabled and outputted. (SF01745654/SEG-45832/DS-33007)
117
Trend Micro Deep Security On-Premise 20
l When multiple Smart Protection Servers were configured, the Deep Security
Agent process would sometimes crash due to an invalid sps_index.
(SF01415702/SEG-42919/DS-33008)
l The "Send Policy" action failed because of a GetDockerVersion error in Deep
Security Agent. (SF1939658/SEG-49191/DS-34222)
l Deep Security Agent sent invalid JSON objects in response to Deep Security
Manager, which caused errors in Deep Security Manager's log file.
(SF01919585/SEG-48728/DS-34022)
l The ds_agent process would sometimes crash under certain conditions when
Integrity Monitoring was enabled. (SEG-50728/DS-35446)
l Deep Security Agent failed to install on Ubuntu 18.04. (SF01593513/SEG-
43300/DS-37359)
l The Deep Security Agent network engine crashed because the working packet
object was deleted accidentally. (SF01526046/SF02159742/SEG-55453/DS-
38812)
l Unicode user names could not be displayed in real-time Integrity Monitoring file
scan events. (SF02187371/SEG-56645/DS-39398)
l The agent operating system would sometimes crash when Firewall interface
ignores were set. (SF01775560/SEG-49866/DS-39339)
l Deep Security Agent did not add Python extension module (PYD) files to the
inventory of Application Control. (SF01804378/SEG-47425/DS-33690)
l Too many file open events were being processed in user mode, resulting in high
cpu usage. (SF02179544/SEG-55745/DS-39638)
l The "mq_getattr: Bad file descriptor" error occurred while accessing the message
queue when Deep Security real-time Anti-Malware was enabled.
(SF02042265/SEG-52088/DS-39890)
l Linux kernel logs were flooded by Deep Security Anti-Malware driver.
(SF02299406/SEG-57561/DS-41589)
l Non-executable files that were opened with execute permissions resulted in
security events and drift that should not have been generated. (SF01780211/SEG-
46616/DSSEG-3607)
118
Trend Micro Deep Security On-Premise 20
l High CPU use occurred when Application Control was enabled and the host
application was creating a high volume of non-executable files.
(SF02179544/SEG-55745/DS-41142)
l Deep Security Agent real-time Anti-Malware scans didn't work with Debian 10 64-
bit.
l When a guest VM was migrated between ESXi hosts frequently (using vMotion),
sometimes the VM couldn't save the state file. This caused the guest to lose the
protection of the Deep Security Virtual Appliance for several minutes after
migration, until the VM was reactivated by Deep Security Manager automatically
under the new ESXi server. (DSSEG-4341/DS-38221)
l When uninstalling Deep Security Agent in Linux, the uninstall log included a typo.
(DSSEG-4139/DS-34504)
l Deep Security Anti-Malware detected sample malware files but did not
automatically delete them. (SF02230778/SEG-55891/DS-40687)
l When the Deep Security Agent connected through a proxy to the Deep Security
Manager on Deep Security as a Service, Identified Files could not be deleted.
(SF01979829/SEG-51013/DS-37252)
l After applying rule 1006540, "Enable X-Forwarded-For HTTP Header Logging",
Deep Security would extract the X-Forwarded-For header for Intrusion Prevention
events correctly. However, a URL intrusion like "Invalid Traversal" would be
detected in the HTTP request string before the header was parsed. The Intrusion
Prevention engine has been enhanced to search X-Forwarded-For header after
the header is parsed. (SEG-60728/DSSEG-5094)
l Deep Security Agent sent invalid JSON objects in response to Deep Security
Manager, which caused errors in Deep Security Manager's log file.
(SF01919585/SEG-48728/DSSEG-4995)
Security updates
Security updates are included in this release. For more information about how we
protect against vulnerabilities, visit Vulnerability Responses. Please note, in line with
responsible disclosure practices, CVE details will only be made available for select
security updates once patches have been made available for all impacted releases.
(VRTS-3704/VRTS-3176)
Highest CVSS Score: 7.8
119
Trend Micro Deep Security On-Premise 20
Highest Severity: High
l Updated NGINX to 1.16.1 (DSSEG-4600)
l Updated to curl 7.67.0.
l Updated to openssl-1.0.2t.
l Updated JRE to the latest Java Update (8.0.241/8.43.0.6).
Kernel support
To see which Linux kernels are currently supported, see "Deep Security Agent Linux
kernel support" on page 143.
If you'd like to view the Linux kernel release history, see the Readme for Trend Micro
(TM) Deep Security Agent 20.0 for Linux.
Known issues
l Autofs is currently not supported for use when real-time Anti-Malware is enabled. If
autofs is used with real-time Anti-Malware enabled, some mountpoints will not be
unmounted successfully. (SEG-58841)
Windows
Deep Security Agent 20 (long-term support release)
Release date: July 30, 2020
Build number: 20.0.0.877
New features
Improved security
Agent integrity check: Deep Security verifies your signature on the Deep Security Agent
to ensure that the software files have not changed since the time of signing.
Protect AWS accounts with incorrect credentials: In the past, if your credentials were
entered incorrectly for AWS accounts in Deep Security, the agent failed to activate. This
might have occurred because the credentials were entered incorrectly or because, over
120
Trend Micro Deep Security On-Premise 20
time, the credentials changed without a corresponding update on Deep Security. To
help ensure protection remains in place in this situation, which in many cases is a
simple configuration error, we will now create the computer outside of the account and
allow the agent to activate.
SSL improvements: Deep Security supports handshake hello_request (rfc5246) and
Extension encrypt_then_mac (rfc7366) in SSL inspection.
Improved quality and management
Reboot requirement removed for agent upgrade: Previously, there were several
situations where a Windows server would require a reboot for a new agent to complete
the upgrade. The need for the reboot has been completely removed, enabling the
application to not be impacted as result of upgrading a Deep Security Agent.
Automate the upgrade of agents in your environment: Deep Security gives you the
flexibility to decide if new agents, when activated, should be upgraded to a newer
version if one is available. This can be particularly useful in cases where application
teams are using older golden images containing a version of the agent that is out of
date. Simply enable upgrade on activation, define the lineup of agents you want to use
in your environment using Agent Version Control, and as older agents come online and
activate they are automatically upgraded for you.
Instance Metadata Service Version 2 (IMDSv2) support: IMDSv2 is supported with
Deep Security Manager FR 2020-04-30. For details, see "How does Deep Security
Agent use the Amazon Instance Metadata Service?" on page 1515
Actionable recommendations for scan failures: The Deep Security Agent provides
actionable information about why a scheduled malware scan has been canceled, and
the recommended actions that should be taken to remedy the failure. For more
information, see "Anti-Malware scan failures and cancellations" on page 833.
Anti-Malware real-time file scan report: Deep Security has the ability to determine the
top 10 files that are scanned by Anti-Malware real-time scan. This provides a starting
point for performance evaluating and tuning, as you can use this information to set file
exclusions and avoid unnecessary scans. The 'AmTopNScan.txt' file with the collected
data can be generated using the following methods:
l By the command dsa_control --AmTopNScan
l By the diagnostic service
121
Trend Micro Deep Security On-Premise 20
Improved process exceptions: The process exception experience has been improved
in the following ways:
l We've provided information about why process exclusion items are not functioning
correctly so you can troubleshoot the issue and know which actions to take to
resolve it.
l We've improved the process exception configuration workflow to make it more
robust.
Windows Event Channel for Log Inspection: Windows Event Channel logging provides
a new option for tracking OS and Application logging for Windows platforms newer than
Windows Vista. Event channels can be used to collect Log Inspection events which you
can view later.
Enhancements
l Improved the heartbeat handling for Amazon WorkSpaces deployments when the
workspace sync feature is not turned on for the matching AWS connector.
l Removed Integrity Monitoring and Application Control's dependency on Anti-
Malware, so they no longer require Anti-Malware to be installed to function.
l Added the ability for Deep Security Agent Anti-Malware to scan compressed files
no matter their data types when IntelliScan is disabled.
l Added support for agentless mode on vCloud connector for version 9.5 or later.
l Enhanced the agent-initiated activation experience by displaying the activation
status (for example, a success message or a message that explains a newer Deep
Security Manager version is required) on Deep Security Manager.
l Enhanced the Malware Scan Failure event description to indicate the possible
reason.
l Streamlined event management for improved agent performance.
l Added the ability to enable or disable Common Scan Cache for each agent
through a CLI command.
l Added support for Deep Security Agent delayed upgrade to reduce the Anti-
Malware offline issue after triggering an upgrade.
122
Trend Micro Deep Security On-Premise 20
Resolved issues
l After upgrading the Deep Security Agent, the "Sending Application Control
Ruleset Failed" error sometimes occurred. (DS-49828)
l Application Control occasionally appeared offline when Application Control and
Anti-Malware were enabled at the same time.
l Deep Security Agent restarted unexpectedly because of the way Log Inspection
was accessing the SQLite database. (DS-48395)
l The interface isolation feature stayed active when Firewall was turned off. (SEG-
32926/DS-27099)
l Web Reputation, Firewall, Intrusion Prevention, and Log Inspection couldn't be
enabled correctly when the system locale was set to Turkish. (DS-48916)
l Integrity Monitoring events showed an incorrect file path with Unicode encoding.
(SEG-45239/DS-33911)
l The Windows Update procedure was blocked when Application Control was
enabled in Block-Mode. (SF02092464/SEG-53938/DS-38578)
l Deep Security Agent's Intrusion Prevention module silently dropped zero payload
UDP packets. (SEG-39711/DS-32799)
l For Web Reputation, Deep Security Agent sent the incorrect credentials to the
proxy, which returned HTTP 407. (SF01704358/SEG-45004/DS-32077)
l Deep Security's Notifier.exe process caused high CPU usage.
(SF01716752/SEG-45507/DS-33645)
l The "Smart Protection Server Disconnected for Smart Scan" alert did not
automatically clear after the connection had been restored. (SF1609675/SEG-
43574/DS-32947)
l In some cases, the Windows driver did not correctly release spinlock, causing the
system to hang. (SF01990859/SEG-50709/DS-36066)
l Deep Security Agent process sometimes crashed when the detailed logging of
SSL message was enabled and outputted. (SF01745654/SEG-45832/DS-33007)
l When multiple Smart Protection Servers were configured, the Deep Security
Agent process would sometimes crash due to an invalid sps_index.
(SF01415702/SEG-42919/DS-33008)
123
Trend Micro Deep Security On-Premise 20
l The "Send Policy" action failed because of a GetDockerVersion error in Deep
Security Agent. (SF1939658/SEG-49191/DS-34222)
l Deep Security Agent sent invalid JSON objects in response to Deep Security
Manager, which caused errors in Deep Security Manager's log file.
(SF01919585/SEG-48728/DS-34022)
l The ds_agent process would sometimes crash under certain conditions when
Integrity Monitoring was enabled. (SEG-50728/DS-35446)
l The Deep Security Agent network engine crashed because the working packet
object was deleted accidentally. (SF01526046/SF02159742/SEG-55453/DS-
38812)
l Deep Security Agent restarted abnormally along with an "Unable to send data to
Notifier app." error message in ds_agent.log. (SEG-21208/DS-33134/DS-21352)
l When the system region format is "Chinese (Traditional, Hong Kong SAR)", Deep
Security Notifier displayed simplified Chinese instead of traditional Chinese.
(SEG-48075/DS-34778)
l Unicode user names could not be displayed in real-time Integrity Monitoring file
scan events. (SF02187371/SEG-56645/DS-39398)
l Deep Security Agent did not add Python extension module (PYD) files to the
inventory of Application Control. (SF01804378/SEG-47425/DS-33690)
l Too many file open events were being processed in user mode resulting in high
CPU usage. (SF02179544/SEG-55745/DS-39638)
l The "Type" attribute wasn't displayed in Integrity Monitoring events when the
default "STANDARD" attribute was set to monitor registry value changes.
(SF02412251/SEG-59848/DS-41118)
l Non-executable files that were opened with execute permissions resulted in
security events and drift that should not have been generated. (SF01780211/SEG-
46616/DSSEG-3607)
l High CPU use occurred when Application Control was enabled and the host
application was creating a high volume of non-executable files.
(SF02179544/SEG-55745/DS-41142)
l The Windows Update procedure was blocked when Application Control was
enabled in Block-Mode. (SF02092464/SEG-53938/DS-39981)
124
Trend Micro Deep Security On-Premise 20
l Deep Security failed to download security updates because of an outdated user
agent string. (SF02043400/SEG-52069/DS-41316)
l When machines wrote document files to a file server, Anti-Malware needed to
scan the files frequently, which caused other machines to fail to write the file
because the file was being scanned. (SF01949194/SEG-49854/DS-40100)
l When Deep Security Agent scanned large files for viruses, it consumed a large
amount of memory. (SF01572110/SEG-48704/DS-43114)
Security updates
Security updates are included in this release. For more information about how we
protect against vulnerabilities, visit Vulnerability Responses. Please note, in line with
responsible disclosure practices, CVE details will only be made available for select
security updates once patches have been made available for all impacted releases.
(VRTS-3704/VRTS-3176)
Highest CVSS Score: 7.8
Highest Severity: High
l Updated NGINX to 1.16.1 (DSSEG-4600)
l Updated to curl 7.67.0.
l Updated to openssl-1.0.2t.
l Updated JRE to the latest Java Update (8.0.241/8.43.0.6).
Known issues
l After upgrading the Deep Security Agent, the "Sending Application Control
Ruleset Failed" error may occur. To work around this issue, right-click the affected
computer and select Actions > Clear Warnings/Errors, then Send Policy.
l After upgrading the Deep Security Agent on Windows 2008, Anti-Malware may go
offline. If this occurs, fully uninstall Deep Security Agent, reboot your server, then
reinstall the agent.
125
Trend Micro Deep Security On-Premise 20
Upgrade notice
l If you have Application Control enabled, there may be a temporary performance
impact while your software inventory is automatically rebuilding. (DS-41775)
Unix
Deep Security Agent 20.0.0-1194 (20 LTS Update 2020-10-05)
Release date: October 5, 2020
Build number: 20.0.0.1194
Enhancements
l Extended the scope of the "If a computer with the same name already exists"
setting on Administration > System Settings > Agents to apply to existing
unactivated computers. Previously, it only applied to existing activated computers.
DS-51800
l Integrity Monitoring detects changes to the "setuid" and "setgid" attributes for
Linux and Unix platforms. DS-52061
Resolved issues
l Anti-Malware directory exclusion with wildcards didn't match subdirectories
correctly. DS-50245
l Deep Security Agent crashed on Solaris 10 during upgrades. SEG-
72634/SF02975849/DS-49295
l The Behavior Monitoring feature of Anti-Malware sometimes raised false alarms.
DS-44974
l When Integrity Monitoring was enabled, the owner of a file was incorrectly
changed to a user that did not exist. DS-52058
126
Trend Micro Deep Security On-Premise 20
Security updates
Security updates are included in this release. For more information about how we
protect against vulnerabilities, visit Vulnerability Responses. Please note, in line with
responsible disclosure practices, CVE details will only be made available for select
security updates once patches have been made available for all impacted releases.
VRTS-3704/DS-41233
Highest CVSS score: 4.4
Severity: Medium
Deep Security Agent 20 (long-term support release)
Release date: July 30, 2020
Build number: 20.0.0.877
New features
Improved security
SSL improvements: Deep Security supports handshake hello_request (rfc5246) and
Extension encrypt_then_mac (rfc7366) in SSL inspection.
Agent integrity check: Deep Security verifies your signature on the Deep Security Agent
to ensure that the software files have not changed since the time of signing.
Improved quality and management
Upgrade to supported paths: The "upgrade on activation" feature will only upgrade the
agent on the computer from the last two major releases. If the agent does not meet the
criteria, you must upgrade the agent manually to a release within the last two major
releases. Then the "upgrade on activation" feature will detect the newer version and
complete the upgrade to the designated release.
Actionable recommendations for scan failures: The Deep Security Agent provides
actionable information about why a scheduled malware scan has been canceled, and
the recommended actions that should be taken to remedy the failure. For more
information, see "Anti-Malware scan failures and cancellations" on page 833.
127
Trend Micro Deep Security On-Premise 20
Anti-Malware real-time file scan report: Deep Security has the ability to determine the
top 10 files that are scanned by Anti-Malware real-time scan. This provides a starting
point for performance evaluating and tuning, as you can use this information to set file
exclusions and avoid unnecessary scans. The 'AmTopNScan.txt' file with the collected
data can be generated using the following methods:
l By the command dsa_control --AmTopNScan
l By the diagnostic service
Improved process exceptions: The process exception experience has been improved
in the following ways:
l We've provided information about why process exclusion items are not functioning
correctly so you can troubleshoot the issue and know which actions to take to
resolve it.
l We've improved the process exception configuration workflow to make it more
robust.
Automate the upgrade of agents in your environment: Deep Security gives you the
flexibility to decide if new agents, when activated, should be upgraded to a newer
version if one is available. This can be particularly useful in cases where application
teams are using older golden images containing a version of the agent that is out of
date. Simply enable upgrade on activation, define the lineup of agents you want to use
in your environment using Agent Version Control, and as older agents come online and
activate they are automatically upgraded for you.
Enhancements
l Integrity Monitoring detects changes to the "setuid" and "setgid" attributes for
Linux and Unix platforms.
l Improved the heartbeat handling for Amazon WorkSpaces deployments when the
workspace sync feature is not turned on for the matching AWS connector.
l Extended the scope of the If a computer with the same name already exists
setting on Administration > System Settings > Agents to apply to existing
unactivated computers. Previously, it only applied to existing activated computers.
l Increased the scan engine's URI path length limitation.
128
Trend Micro Deep Security On-Premise 20
l Added the ability for Deep Security Agent Anti-Malware to scan compressed files
no matter their data types when IntelliScan is disabled.
l Streamlined event management for improved agent performance.
l Added the ability to enable or disable Common Scan Cache for each agent
through a CLI command.
l Added the ability for Deep Security Agent Anti-Malware to scan compressed files
no matter their data types when IntelliScan is disabled.
Resolved issues
l After upgrading the Deep Security Agent, the "Sending Application Control
Ruleset Failed" error sometimes occurred. (DS-49828)
l Application Control occasionally appeared offline when Application Control and
Anti-Malware were enabled at the same time.
l The displayed packet header data contained redundant payload data. (DS-45792)
l Memory leaked during SSL decryption because of a flaw in the SSL processing.
(SEG-68263/DS-44360)
l On specific Deep Security Agent servers the CPU usage spiked to 100% and
pattern merges failed during the active update process. (SEG-
66210/02711299/DS-46429)
l When a security update was triggered before Anti-Malware was ready, the security
updates failed. (DS-36952)
l When real-time Integrity Monitoring was enabled with the rule "1002875: Unix
Add/Remove Software" applied, the RPM database potentially locked. (SEG-
67275/SF02663756/DS-48524)
l Web Reputation, Firewall, Intrusion Prevention, and Log Inspection couldn't be
enabled correctly when the system locale was set to Turkish. (SEG-
71825/SF03021819/DS-48916)
l Incorrect linking of certain libraries could lead to Deep Security Agent instability.
(SEG-72958/03071960/DS-49324)
l Anti-Malware directory exclusion with wildcard didn't match subdirectories
correctly. (SF03131855/SEG-74892/DS-50245)
129
Trend Micro Deep Security On-Premise 20
l High CPU use occurred when Application Control was enabled and the host
application was creating a high volume of non-executable files.
(SF02179544/SEG-55745/DS-41142)
l Non-executable files that were opened with execute permissions resulted in
security events and drift that should not have been generated. (SF01780211/SEG-
46616/DSSEG-3607)
l Deep Security Agent did not add Python extension module (PYD) files to the
inventory of Application Control. (SF01804378/SEG-47425/DS-33690)
l Unicode user names could not be displayed in real-time Integrity Monitoring file
scan events. (SF02187371/SEG-56645/DS-39398)
l The Deep Security Agent network engine crashed because the working packet
object was deleted accidentally. (SF01526046/SF02159742/SEG-55453/DS-
38812)
l The ds_agent process would sometimes crash under certain conditions when
Integrity Monitoring was enabled. (SEG-50728/DS-35446)
l Deep Security Agent sent invalid JSON objects in response to Deep Security
Manager, which caused errors in Deep Security Manager's log file.
(SF01919585/SEG-48728/DS-34022)
l The "Send Policy" action failed because of a GetDockerVersion error in Deep
Security Agent. (SF1939658/SEG-49191/DS-34222)
l When multiple Smart Protection Servers were configured, the Deep Security
Agent process would sometimes crash due to an invalid sps_index.
(SF01415702/SEG-42919/DS-33008)
l For Web Reputation, Deep Security Agent sent the incorrect credentials to the
proxy, which returned HTTP 407. (SF01704358/SEG-45004/DS-32077)
l Deep Security Agent's Intrusion Prevention module silently dropped zero payload
UDP packets. (SEG-39711/DS-32799)
l Integrity Monitoring events showed an incorrect file path with Unicode encoding.
(SEG-45239/DS-33911)
l The interface isolation feature was still on when Firewall was turned off. (SEG-
32926/DS-27099)
l After applying rule 1006540, "Enable X-Forwarded-For HTTP Header Logging",
Deep Security would extract the X-Forwarded-For header for Intrusion Prevention
130
Trend Micro Deep Security On-Premise 20
events correctly. However, a URL intrusion like "Invalid Traversal" would be
detected in the HTTP request string before the header was parsed. The Intrusion
Prevention engine has been enhanced to search X-Forwarded-For header after
the header is parsed. (SEG-60728/DS-42332
l Deep Security Agent sent invalid JSON objects in response to Deep Security
Manager, which caused errors in Deep Security Manager's log file. (SEG-
48728/SF01919585/DS-34022)
l On Solaris servers with clusters, the Deep Security Intrusion Prevention module
would come under heavy load while inspecting the clusters' private traffic. The
extra load caused latency issues, node evictions, and loss of synchronization
events.
You can now configure the Packet Processing Engine on the agent to bypass
traffic inspection on a specified interface. Where a specific interface on a computer
is dedicated to cluster private traffic, this configuration can be used to bypass
inspection of packets sent to and received from this interface. This results in faster
packet processing on the bypassed interface and other interfaces.
Use of this configuration to bypass traffic inspection is a security risk. It is up to you
to determine if the benefit of reduced latency outweighs the risk involved. It is also
up to you to determine whether only the nodes in the cluster have access to the
subnet whose interface is being bypassed.
To implement the bypass, do the following:
1. Upgrade the Deep Security Agent to the latest build containing this fix.
2. Create a file under /etc directory named "ds_filter.conf".
3. Open the /etc/ds_filter.conf file.
4. Add the MAC addresses of all NIC cards used for cluster communication, as
follows:
MAC_EXCLUSIVE_LIST=XX:XX:XX:XX:XX,XX:XX:XX:XX:XX
5. Save.
6. Wait 60 seconds for your changes to take effect.
In the /etc/ds_filter.conf file:
l The MAC_EXCLUSIVE_LIST line must be the first line in the file.
l All letters in the MAC address must be uppercase.
131
Trend Micro Deep Security On-Premise 20
l Leading zeros in each byte must be included.
Valid MAC_EXCLUSIVE_LIST:
MAC_EXCLUSIVE_LIST=0B:3A;12:F8:32:5E
MAC_EXCLUSIVE_LIST=0B:3A;12:F8:32:5E,6A:23:F0:0F:AB:34
Invalid MAC_EXCLUSIVE_LIST:
MAC_EXCLUSIVE_LIST=B:3A;12:F8:32:5E
MAC_EXCLUSIVE_LIST=0b:3a;12:F8:32:5e,6a:23:F0:0F:ab:34
MAC_EXCLUSIVE_LIST=0B:3A;12:F8:32:5E
If the MAC address is not valid, the interface will not be bypassed. If the exact string
"MAC_EXCLUSIVE_LIST=" is not present at the beginning of the line no interfaces will
be bypassed. (DSSEG-4055)
Security updates
Security updates are included in this release. For more information about how we
protect against vulnerabilities, visit Vulnerability Responses. Please note, in line with
responsible disclosure practices, CVE details will only be made available for select
security updates once patches have been made available for all impacted releases.
(VRTS-3704/VRTS-3176)
Highest CVSS Score: 7.8
Highest Severity: High
l Updated NGINX to 1.16.1 (DSSEG-4600)
l Updated to curl 7.67.0.
l Updated to openssl-1.0.2t.
l Updated JRE to the latest Java Update (8.0.241/8.43.0.6).
What's new in Deep Security Virtual Appliance?
Release date: July 30. 2020
Build number: 20.0.0.877
132
Trend Micro Deep Security On-Premise 20
New features
Improved security
Support for protection features on NSX-T: Recommendation scans, Intrusion Prevention
reconnaissance scans and Integrity Monitoring are enabled for NSX-T environments.
Seamless Anti-Malware protection on Deep Security Virtual Appliance: After migrating guest
VMs to another ESXi host in the same cluster using vMotion, the Deep Security Virtual
Appliance's network scans and Anti-Malware scans will now continue where they left off, without
delay. This feature only applies if you are using NSX-T Data Center and guest machines are
using a policy without network feature overrides.
Protect VMs in NSX-T environments: We have integrated the latest VMware Service Insertion
and Guest Introspection technologies which enables you to protect your guest VMs using
Intrusion Prevention, Web Reputation, Firewall, Integrity Monitoring and recommendation scans
on NSX-T hosts with agentless protection.
Improved management and quality
NSX-T Network Throughput improvement: By introducing the Data Plane Development Kit
(DPDK), we've made the network throughput three times faster when compared with prior
technology.
Enhancements
l Improved the time it takes to auto-activate guest VMs protected by the Deep Security
Virtual Appliance in an NSX-T environment.
l Added the "VMware NSX Policy Configuration Conflict" system event. This event is
generated when Deep Security Manager detects that a NSX-T group is configured with
different security policies for Endpoint Protection and Network Introspection (E-W).
l Updated Deep Security Manager to allow vCloud accounts to be added even if the virtual
machine hardware information is missing.
l Extended the scope of the "If a computer with the same name already exists" setting on
Administration > System Settings > Agents to apply to existing unactivated computers.
Previously, it only applied to existing activated computers.
l When you upgrade the Deep Security Virtual Appliance SVM in NSX-T Manager, Deep
Security Manager will now detect that a new SVM is now protecting guest VMs, and will
auto-activate those VMs after the upgrade.
133
Trend Micro Deep Security On-Premise 20
l Upgraded the vCloud Connector in Deep Security Manager supports vCloud 9.7 and
vCloud 10.0.
l Added the ability to sync Deep Security Manager policies to NSX-T environments.
l Improved the experience when deleting vCenter Connectors with NSX-T Manager.
Previously, you had to manually remove the NSX-T component as a service profile,
endpoint rules and service deployments, or the vCenter deletion would fail.
Resolves issues
l Deep Security Virtual Appliance sometimes went offline. SEG-53294
l The Anti-Malware engine on Deep Security Virtual Appliance went offline when the signer
field in the Census server reply was empty. SEG-73047
l When a guest VM was migrated between ESXi hosts frequently (using vMotion),
sometimes the VM couldn't save the state file. This caused the guest to lose the protection
of the Deep Security Virtual Appliance for several minutes after migration, until the VM was
reactivated by Deep Security Manager automatically under the new ESXi server. (DSSEG-
4341/DS-38221)
l The Deep Security Virtual Appliance did not detect an Eicar file. SEG-
71955/SF02955546/DS-49387
Known issues
l The automatic removal of a vCenter account from Deep Security will fail if NSX-T is
configured to have the same service chain bound to Deep Security and third-party services
simultaneously. This problem occurs because the NSX-T API doesn't allow Deep Security
to modify the service chain with its associated service profiles. To work around this issue,
remove vCenter manually. For details, see "Uninstall Deep Security from your NSX
environment" on page 1331. DS-47944
l Deep Security Manager no longer supports NSX-T Manager version 2.x. Upgrade your
NSX-T Manager to version 3.0.0 or later. DS-50387
134
Trend Micro Deep Security On-Premise 20
Compatibility
Deep Security Agent platforms
Topics on this page:
l "Agent platform support table" below
l "Docker support" on page 139
l "Systemd support" on page 140
l "SELinux support" on page 142
l "Secure Boot support" on page 142
See also "Agent platform support policy" on page 79.
Agent platform support table
Deep Security Manager 20 supports the Deep Security Agents on the operating systems shown
in the table below. If platform support was added in an update release, the minimum update
version is noted next to the check mark in the table.
Deep Security Manager supports the use of older agent versions, but we do encourage
customers to upgrade agents regularly. New agent releases provide additional security features
and protection, higher quality, performance improvements, and updates to stay in sync with
releases from each platform vendor. Each agent has an end-of-life date. For details, see "Deep
Security LTS life cycle dates" on page 80 and "Deep Security FR life cycle dates" on page 84.
Note: Not all Deep Security features are available on all platforms. See "Supported features
by platform" on page 145.
Note: The Deep Security Agent can be installed and is fully supported on various cloud,
virtual, or physical environments, provided the operating system and kernel are supported.
Deep Security Agent Platform Deep Security Agent Version
20 12 11.3 11.2 11.1 11 10 9.6 9.0
12 FR
LTS LTS LTS LTS
Windows 2000, Service Pack 3 ✔
135
Trend Micro Deep Security On-Premise 20
Deep Security Agent Platform Deep Security Agent Version
20 12 11.3 11.2 11.1 11 10 9.6 9.0
12 FR
LTS LTS LTS LTS
or 4 (32-bit) (See Note 5) U17
Windows XP (32- and 64-bit)
✔
(See Note 5)
Windows Server 2003 SP1 or
SP2 (32- and 64-bit) (See Note ✔
5)
Windows Server 2003 R2 SP2
✔
(32- and 64-bit)) (See Note 5)
Windows 7 (32- and 64-bit) (See
✔ ✔ ✔ • • • ✔
Note 5)
Windows 7 Embedded (32-bit)
✔ ✔ ✔ •
(See Note 2 and Note 5)
Windows Server 2008 (32- and
✔ ✔ ✔ • • • ✔
64-bit) (See Note 3 and Note 5)
Windows Server 2008 R2 (64-
✔ ✔ ✔ • • • ✔
bit) (See Note 3 and Note 5)
Windows 8 (32- and 64-bit) ✔ ✔ ✔ • • • ✔
Windows 8.1 (32- and 64-bit) ✔ ✔ ✔ • • • ✔
Windows 8.1 Embedded (32-bit)
✔ ✔ ✔ •
(See Note 2)
Windows 10 (32- and 64-bit)
✔ ✔ ✔ • • • ✔
(See Note 1)
Windows 10 Embedded (64-bit)
✔ ✔ ✔ •
(See Note 2)
Windows Server 2012 (64-bit) ✔ ✔ ✔ • • • ✔
Windows Server 2012 R2 (64-
✔ ✔ ✔ • • • ✔
bit)
Windows Server 2016 (LTSC,
✔ ✔ ✔ • • • ✔
version 1607) (64-bit)
Windows Server Core (SAC,
version 1709) (64-bit) (See Note ✔ ✔ ✔ • • • ✔
1)
Windows Server 2019 (LTSC,
✔ ✔ ✔ • ✔ U4
version 1809) (64-bit)
Red Hat Enterprise Linux 5 (32-
✔
and 64-bit)
Red Hat Enterprise Linux 6 (32-
✔ ✔ ✔ • • • ✔
and 64-bit)
Red Hat Enterprise Linux 7 (64-
✔ ✔ ✔ • • • ✔
bit)
Red Hat Enterprise Linux 8 (64- ✔
✔ ✔ ✔
bit) U12
136
Trend Micro Deep Security On-Premise 20
Deep Security Agent Platform Deep Security Agent Version
20 12 11.3 11.2 11.1 11 10 9.6 9.0
12 FR
LTS LTS LTS LTS
Ubuntu 10 (64-bit) ✔
Ubuntu 12 (64-bit) ✔
Ubuntu 14 (64-bit) ✔
Ubuntu 16 (64-bit) ✔ ✔ ✔ • • • ✔
Ubuntu 18 (64-bit) ✔ ✔ ✔ • • ✔ U2
✔
Ubuntu 20.04 (64-bit) ✔ ✔ U10
CentOS 5 (32- and 64-bit) ✔
CentOS 6 (32- and 64-bit) ✔ ✔ ✔ • • • ✔
CentOS 7 (64-bit) ✔ ✔ ✔ • • • ✔
CentOS 8 (64-bit) ✔ ✔ ✔ U3 ✔ U17
Debian 6 (64-bit) ✔
Debian 7 (64-bit) ✔ • • • ✔
Debian 8 (64-bit) ✔ ✔ ✔ • • • ✔
Debian 9 (64-bit) ✔ ✔ ✔ • • • ✔
✔
Debian 10 (64-bit) ✔ ✔ ✔ U1
U14
Amazon Linux (64-bit) ✔ ✔ ✔ • • • ✔
Amazon Linux 2 (64-bit) ✔ ✔ ✔ • • • ✔
Oracle Linux 5 (32- and 64-bit) ✔
Oracle Linux 6 (32- and 64-bit) ✔ ✔ ✔ • • • ✔
Oracle Linux 7 (64-bit) ✔ ✔ ✔ • • • ✔
✔
Oracle Linux 8 (64-bit) ✔ ✔ ✔ U2
U14
SUSE Linux Enterprise Server
✔
10 (32- and 64-bit)
SUSE Linux Enterprise Server
✔ • • • ✔ ✔
11 (32- and 64-bit)
SUSE Linux Enterprise Server
✔ ✔ ✔ • • • ✔ ✔
12 (64-bit)
SUSE Linux Enterprise Server ✔
✔ ✔ ✔
15 (64-bit) U13
CloudLinux 5 (32- and 64-bit) ✔
CloudLinux 6 (32-bit) ✔
CloudLinux 6 (64-bit) ✔ U6
CloudLinux 7 (64-bit) ✔ ✔ ✔ • • • ✔
✔ FR
CloudLinux 8 (64-bit) ✔ 2020-05-
19
Solaris 10 Updates 4-6 (64-bit,
✔ ✔ ✔ U6
SPARC or x86)
137
Trend Micro Deep Security On-Premise 20
Deep Security Agent Platform Deep Security Agent Version
20 12 11.3 11.2 11.1 11 10 9.6 9.0
12 FR
LTS LTS LTS LTS
Solaris 10 Updates 7-10 (64-bit,
✔ ✔ ✔ U6
SPARC or x86)
Solaris 10 Update 11 (64-bit,
✔ ✔ ✔ U6
SPARC or x86)
Solaris 11.0 (1111)-11.1 (64-bit,
✔ ✔ ✔ U6
SPARC or x86)
Solaris 11.2-11.3 (64-bit, SPARC
✔ ✔ ✔ U6
or x86)
Solaris 11.4 (64-bit, SPARC or
✔ ✔ ✔ U7
x86)
AIX 5.3 (See Note 4) ✔
AIX 6.1, 7.1, 7.2 (See Note 4) ✔ ✔ U5
• Support for these releases is ending soon. Please upgrade to Deep Security Agent 20 as soon
as possible.
If platform support was added in an update or FR release, the minimum update or FR version is
noted next to the check mark in the table. Examples: ✔ U1, ✔ FR 2020-05-04.
Note 1: Microsoft releases regular, semi-annual releases for Microsoft Windows 10 and
Windows Server Core. For details about which specific releases are supported, see Deep
Security Support for Windows 10 and Deep Security Support for Windows Server Core.
Note 2: All Trend Micro testing on Windows Embedded platforms is performed in a virtualized
environment. Because these operating systems are typically run on custom hardware (for
example, on point-of-sale terminals), customers must plan to thoroughly test on their target
hardware platform prior to deployment in a production environment. In addition, before raising
support cases, customers should attempt to reproduce problems in a virtualized environment
because this is the environment the Trend Micro support team has available. If the issue is
specific to deployments on custom hardware, Trend Micro may require the customer to provide
us with remote access to a suitable environment before we can fully respond to support cases.
Note 3: Deep Security Agent is supported with both Full/Desktop Experience and Server Core
installations of Windows Server 2012 and later. For Windows Server 2008 and 2008 R2, only
the 'Full Installation' is supported. (The 'Server Core Installation' is not.)
Note 4: If you want to use Deep Security Agent 9.0 for AIX, you'll need to use a signed agent,
version 9.0.0-5624 or higher. Please be aware that the end-of-life date for this agent is 31-Dec-
138
Trend Micro Deep Security On-Premise 20
2020. You can download this agent from the Earlier Versions tab on the Deep Security
SoftwareDeep Security Software page. The following AIX configurations are supported:
l AIX LPARs running on the PowerVM Hypervisor on Power Servers.
l AIX running as the bare metal OS on Power Servers.
Note 5: Microsoft has changed their signing policy to use only SHA-2. For information on
compatibility and required Microsoft security updates, see:
l Updated guidance for use of Trend Micro Deep Security to protect Windows 2003,
Windows XP, and Windows 2000 based systems
l New versions of Trend Micro Deep Security Agents for Windows will only be signed with
SHA-2 (also available in Japanese)
Also, Deep Security 10.0 Update 26 does not support the installation or upgrade of Deep
Security Agent on Windows 2003 or Windows XP. Support for these platforms will be re-
introduced in a subsequent update. For more information, see Deep Security Agent version 10
update 26 cannot be used for installation or upgrade on Windows XP/2003.
Docker support
You can use Deep Security 10.0 or later to protect Docker hosts and containers running on Linux
distributions. Windows is not supported.
With each Deep Security long-term support (LTS) release, Deep Security supports all Docker
Enterprise Edition (EE) versions that have not reached end-of-life. (See Announcing Docker
Enterprise Edition.) We do not officially support Docker Edge releases, but strive to test against
Docker Edge releases to the best of our ability.
Support for new stable Docker releases is introduced with each release of Deep Security. We
recommend that you refrain from upgrading to the latest stable release of Docker until Trend
Micro documents the support statements for the latest Deep Security release.
Deep
Docker Docker CE Docker EE
Secur
ity
Agent
v1. v1. 17. 17. 17. 18. 18. 18. 19. 17. 18. 18. 18. 19.
versio
12 13 03 09 12 03 06 09 03 06 03 06 09 03
n
10 ✔ ✔
139
Trend Micro Deep Security On-Premise 20
Deep
Docker Docker CE Docker EE
Secur
ity
Agent
v1. v1. 17. 17. 17. 18. 18. 18. 19. 17. 18. 18. 18. 19.
versio
12 13 03 09 12 03 06 09 03 06 03 06 09 03
n
LTS
11
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
LTS
11.1 ✔ ✔ ✔ ✔
11.2 ✔ ✔ ✔ ✔
11.3 ✔ ✔ ✔ ✔
12
✔ ✔ ✔ ✔ ✔ ✔ ✔
LTS
12
✔ ✔ ✔ ✔ ✔ ✔
FR
20
✔ ✔ ✔ ✔ ✔ ✔
LTS
Note: Deep Security support for Docker releases includes any sub-versions of those releases.
For example, Deep Security 11.0 supports Docker 17.09-ce including its sub-versions:
17.09.0-ce and 17.09.1-ce.
Before deploying Deep Security into your target environment, you should ensure that Docker
supports your target environment and platform configuration.
Systemd support
Some versions of the Deep Security Agent for Linux support systemd. See the table below for
details.
140
Trend Micro Deep Security On-Premise 20
Deep Security Agent Platform Deep Security Agent Version
20 12 11
12 FR
LTS LTS LTS
Amazon Linux (64-bit)
Amazon Linux 2 (64-bit)
CloudLinux 6 (64-bit)
CloudLinux 7 (64-bit)
✔ FR 2020-05-
CloudLinux 8 (64-bit) ✔
19
Debian 8 (64-bit)
Debian 9 (64-bit)
Debian 10 (64-bit) ✔ ✔ ✔ U1 ✔ U14
Oracle Linux 6 (32- and 64-bit)
Oracle Linux 7 (64-bit) ✔ ✔ ✔ U1 ✔ U13
Oracle Linux 8 (64-bit) ✔ ✔ ✔ U2 ✔ U14
Red Hat Enterprise Linux 6 (32- and 64-bit)
Red Hat Enterprise Linux 7 (64-bit) ✔ ✔ ✔ U1 ✔ U13
Red Hat Enterprise Linux 8 (64-bit) ✔ ✔ ✔ ✔ U12
SUSE Linux Enterprise Server 11 (32- and
64-bit)
SUSE Linux Enterprise Server 12 (64-bit)
SUSE Linux Enterprise Server 15 (64-bit) ✔ ✔ ✔ ✔ U13
Ubuntu 16 (64-bit)
141
Trend Micro Deep Security On-Premise 20
Deep Security Agent Platform Deep Security Agent Version
Ubuntu 18 (64-bit) ✔ ✔
Ubuntu 20 (64-bit) ✔
If systemd support was added in an update or FR release, the minimum update or FR version is
noted next to the check mark in the table. Examples: ✔ U1, ✔ FR 2020-05-04
SELinux support
Security-Enhanced Linux (SELinux) enforcing mode is supported on these OS and agent
combinations, using the default SELinux policies:
Deep Security Agent Version
Deep Security Agent Platform
20 LTS 12 FR 12 LTS
Red Hat Enterprise Linux 7 (64-bit) ✔ ✔ (FR 2020-05-19 or later) ✔ (Update 9 or later)
Red Hat Enterprise Linux 8 (64-bit) ✔ ✔ (FR 2020-05-19 or later) ✔ (Update 9 or later)
Warning: Anti-Malware software such as Deep Security Agent must run in an unconfined
domain in order to protect the system. Any additional SELinux policy customization or
configuration may cause Deep Security Agent to be blocked.
Note: If any alerts occur, see "Troubleshoot SELinux alerts" on page 1555.
Secure Boot support
Some versions of the Deep Security Agent support the Secure Boot feature. See the table below
for details. For details on configuring the agent for Secure Boot, see "Linux Secure Boot support
for agents" on page 1158.
Note: Secure Boot is not available for AWS instances and Azure VMs.
Note: If you are protecting VMware virtual machines, Secure Boot is available for VMware
vSphere 6.5 or newer.
142
Trend Micro Deep Security On-Premise 20
Deep Security Agent Version
Deep Security Agent Platform 20 LTS 12 FR 12 LTS 11 LTS
Red Hat Enterprise Linux 7 (64-bit) ✔ ✔ ✔ ✔
Red Hat Enterprise Linux 8 (64-bit) ✔ ✔
Debian 10 (64-bit) ✔ ✔
SUSE Linux Enterprise Server 12 (64-bit) ✔ ✔
SUSE Linux Enterprise Server 15 (64-bit) ✔ ✔
Ubuntu 16 (64-bit) ✔ ✔
Ubuntu 18 (64-bit) ✔ ✔
Ubuntu 20 (64-bit) ✔
Deep Security Agent Linux kernel support
l Deep Security Agent 20 Linux kernel support
l Deep Security Agent Feature Releases (12.5) Linux kernel support
l Deep Security Agent 12.0 Linux kernel support
l Deep Security Agent 11.3 Linux kernel support
l Deep Security Agent 11.2 Linux kernel support
l Deep Security Agent 11.1 Linux kernel support
l Deep Security Agent 11.0 Linux kernel support
l Deep Security Agent 10.3 Linux kernel support
l Deep Security Agent 10.2 Linux kernel support
l Deep Security Agent 10.1 Linux kernel support
l Deep Security Agent 10.0 Linux kernel support
l Deep Security Agent 9.6 SP1 Linux kernel support
l Deep Security Agent 9.5 SP1 Linux kernel support
143
Trend Micro Deep Security On-Premise 20
You can also use a JSON version of the complete list of the supported Linux kernels for Deep
Security Agent 10.0 and higher with scripts and automated workflows.
144
Trend Micro Deep Security On-Premise 20
Supported features by platform
The tables below list the features available for each OS platform of Deep Security Agent 20 and the Deep Security Virtual Appliance:
l "Microsoft Windows" on the next page
l "Red Hat Enterprise Linux" on page 151
l "CentOS Linux " on page 152
l "Oracle Linux" on page 153
l "SUSE Linux" on page 154
l "Ubuntu Linux " on page 155
l "Debian Linux " on page 156
l "CloudLinux" on page 157
l "Amazon Linux" on page 158
l "Solaris" on page 158
l "AIX" on page 159
l "Deep Security Virtual Appliance 20 (NSX) supported guest OS's" on page 160
Note:
Older agents are compatible with other platforms (although they don't support new features). See "Deep Security Agent platforms" on page 135 for a complete list of
compatible agents. To see the features available with older agents:
l Deep Security Agent 10.0 (and newer) supported features: In the drop-down menu above, select that version of Deep Security.
l Deep Security Agent 9.6 Service Pack 1 supported features
145
Trend Micro Deep Security On-Premise 20
Microsoft Windows
Note: Deep Security Agent is supported with both Full/Desktop Experience and Server Core installations of Windows Server 2012 and later (any exceptions for particular
features are noted in the table below). For Windows Server 2008 and 2008 R2, only Full Installations are supported.
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
Running Running
SSL File and
Feature Feature Feature Feature Unencrypted File Directory Services, Registry Services,
Encrypted Directory
set 1 set 2 set 1 set 2 Traffic Scans Scans Processes, Scans Processes,
Traffic Scans
Listening Listening
Ports Ports
Windows 7
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(32-bit)
Windows 7
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Windows 7
Embedded ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(32-bit) (3)
Windows
Server
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
2008
(32-bit)
146
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
Running Running
SSL File and
Feature Feature Feature Feature Unencrypted File Directory Services, Registry Services,
Encrypted Directory
set 1 set 2 set 1 set 2 Traffic Scans Scans Processes, Scans Processes,
Traffic Scans
Listening Listening
Ports Ports
Windows
Server
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
2008
(64-bit)
Windows
Server
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
2008 R2
(64-bit)
Windows 8
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(32-bit)
Windows 8
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Windows
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
8.1 (32-bit)
Windows
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
8.1 (64-bit)
147
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
Running Running
SSL File and
Feature Feature Feature Feature Unencrypted File Directory Services, Registry Services,
Encrypted Directory
set 1 set 2 set 1 set 2 Traffic Scans Scans Processes, Scans Processes,
Traffic Scans
Listening Listening
Ports Ports
Windows
8.1
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Embedded
(32-bit) (3)
Windows
10 (32-bit) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(2)
Windows
10 (64-bit) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(2)
Windows
10
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Embedded
(64-bit) (3)
Windows
Server ✔ (1)
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ (1)(5) ✔ ✔ ✔ ✔ ✔ ✔ (5) ✔ ✔ ✔
2012 (5)
(64-bit)
148
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
Running Running
SSL File and
Feature Feature Feature Feature Unencrypted File Directory Services, Registry Services,
Encrypted Directory
set 1 set 2 set 1 set 2 Traffic Scans Scans Processes, Scans Processes,
Traffic Scans
Listening Listening
Ports Ports
Windows
Server
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ (5) ✔
2012 R2
(64-bit)
Windows
Server
2016
(LTSC, ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
version
1607)
(64-bit)
Windows
Server
Core (SAC,
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
version
1709)
(64-bit)(2)
Windows
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Server
149
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
Running Running
SSL File and
Feature Feature Feature Feature Unencrypted File Directory Services, Registry Services,
Encrypted Directory
set 1 set 2 set 1 set 2 Traffic Scans Scans Processes, Scans Processes,
Traffic Scans
Listening Listening
Ports Ports
2019
(LTSC,
version
1809)
(64-bit)
150
Trend Micro Deep Security On-Premise 20
Red Hat Enterprise Linux
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
Red Hat
Enterprise
✔ (4) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Linux 6
(32-bit)
Red Hat
Enterprise
✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Linux 6
(64-bit)
Red Hat
Enterprise
✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Linux 7
(64-bit)
Red Hat
Enterprise
✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Linux 8
(64-bit)
151
Trend Micro Deep Security On-Premise 20
CentOS Linux
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
CentOS
6 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(32-bit)
CentOS
6 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
CentOS
7 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
CentOS
8 (64- ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
bit)
152
Trend Micro Deep Security On-Premise 20
Oracle Linux
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
Oracle
Linux 6 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
(32-bit)
Oracle
Linux 6 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Oracle
Linux 7 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Oracle
Linux 8 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
153
Trend Micro Deep Security On-Premise 20
SUSE Linux
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
SUSE
Linux
Enterprise
Server 12 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
SP1, SP2,
SP3
(64-bit)
SUSE
Linux
Enterprise ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
Server 15
(64-bit)
154
Trend Micro Deep Security On-Premise 20
Ubuntu Linux
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
Ubuntu
16 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Ubuntu
18 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Ubuntu
20.04 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
155
Trend Micro Deep Security On-Premise 20
Debian Linux
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
Debian
8 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Debian
9 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Debian
Linux
✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
10 (64-
bit)
156
Trend Micro Deep Security On-Premise 20
CloudLinux
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
CloudLinux
✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
7, 8 (64-bit)
157
Trend Micro Deep Security On-Premise 20
Amazon Linux
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
Amazon
Linux ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Amazon
Linux 2 ✔(4) ✔ ✔ ✔ ✔ ✔ ✔ (1) ✔ ✔ ✔ ✔ ✔ ✔ ✔
(64-bit)
Solaris
Note: See "How does agent protection work for Solaris zones?" on page 1509 for more on how protection works between Solaris zones. For a list of supported Solaris
versions, see "Deep Security Agent platforms" on page 135.
158
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted File Directory Registry
Encrypted Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans Scans
Traffic Listening Scans Listening
Ports Ports
Solaris ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
AIX
Note: For a list of supported AIX versions, see "Deep Security Agent platforms" on page 135.
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted Directory Registry
Encrypted FileScans Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans
Traffic Listening Scans Listening
Ports Ports
AIX
6.1, ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
7.1,
159
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
SSL Running File and Running
Feature Feature Feature Feature Unencrypted Directory Registry
Encrypted FileScans Processes, Directory Processes,
set 1 set 2 set 1 set 2 Traffic Scans Scans
Traffic Listening Scans Listening
Ports Ports
7.2
Deep Security Virtual Appliance 20 (NSX) supported guest OS's
Deep Security Virtual Appliance can protect guest VMs running OS's from the vendors shown in the table below. From within those vendors, the appliance supports all
OS's that VMware supports. For the list of OS's that VMware supports, see this VMware Compatibility search tool. When using the tool, make sure that:
l What are you looking for? is set to Guest OS.
l OS Vendor is set to one of the supported vendors listed in the table below.
Note: If you are using combined mode, any guest VMs with an agent installed must be supported by the agent. For a list of OS's supported by the agent, see "Supported
features by platform" on page 145.
Note: The list of supported features varies not only by platform, as shown in the table below, but also by NSX license type. For details on which features are supported by
your NSX license, see "VMware deployments with the virtual appliance and NSX" on page 299.
160
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
Running Running
SSL File and
Feature Feature Feature Feature Unencrypted File Directory Services, Registry Services,
Encrypted Directory
set 1 set 2 set 1 set 2 Traffic Scans Scans Processes, Scans Processes,
Traffic Scans
Listening Listening
Ports Ports
OS vendors supported by the appliance on NSX Data Center for VSphere (NSX-V)
Microsoft
✔ ✔ ✔ ✔ ✔ ✔ ✔ N/A
Windows
Red Hat
Enterprise ✔ ✔ ✔ N/A
Linux
CentOS
✔ ✔ ✔ N/A
Linux
Oracle
✔ ✔ ✔ N/A
Linux
SUSE
✔ ✔ ✔ N/A
Linux
Ubuntu
✔ ✔ ✔ N/A
Linux
161
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
Running Running
SSL File and
Feature Feature Feature Feature Unencrypted File Directory Services, Registry Services,
Encrypted Directory
set 1 set 2 set 1 set 2 Traffic Scans Scans Processes, Scans Processes,
Traffic Scans
Listening Listening
Ports Ports
Debian
✔ ✔ ✔ N/A
Linux
OS vendors supported by the appliance on NSX-T Data Center 3.x (NSX-T 3.x)
Microsoft
✔ ✔ ✔ ✔ ✔ ✔ ✔ N/A
Windows
Red Hat
Enterprise ✔ ✔ ✔ N/A
Linux
CentOS
✔ ✔ ✔ N/A
Linux
Oracle
✔ ✔ ✔ N/A
Linux
SUSE
✔ ✔ ✔ N/A
Linux
162
Trend Micro Deep Security On-Premise 20
Web Intrusion
Integrity Log Application Recommen- FIPS
Anti-Malware Reputation Firewall Prevention Relay Scanner
Monitoring Inspection Control dation Scan mode
Service System
Real-time On-demand Real-time On-demand
Scans of Scans of
Running Running
SSL File and
Feature Feature Feature Feature Unencrypted File Directory Services, Registry Services,
Encrypted Directory
set 1 set 2 set 1 set 2 Traffic Scans Scans Processes, Scans Processes,
Traffic Scans
Listening Listening
Ports Ports
Ubuntu
✔ ✔ ✔ N/A
Linux
Debian
✔ ✔ ✔ N/A
Linux
Feature set 1 includes signature-based file scanning, spyware scanning, and document exploit protection.
Feature set 2 includes behavior monitoring, process memory scanning, and registry scanning.
( 1 ) This platform supports enhanced real-time integrity monitoring. It uses the application control driver to provide file monitoring and captures information about who made
changes to a monitored file.
( 2 ) Microsoft releases regular, semi-annual releases for Microsoft Windows 10 and Windows Server Core. For details about which specific releases are supported, see
Deep Security Support for Windows 10 and Deep Security Support for Windows Server Core.
( 3 ) All Trend Micro testing on Windows Embedded platforms is performed in a virtualized environment. Because these operating systems are typically run on custom
hardware (for example, on point-of-sale terminals), customers must plan to thoroughly test on their target hardware platform prior to deployment in a production environment.
In addition, before raising support cases, customers should attempt to reproduce problems in a virtualized environment because this is the environment the Trend Micro
163
Trend Micro Deep Security On-Premise 20
support team has available. If the issue is specific to deployments on custom hardware, Trend Micro may require the customer to provide us with remote access to a
suitable environment before we can fully respond to support cases.
( 4 ) Real-time Anti-Malware support on Linux: Real-time Anti-Malware scanning is highly dependent on the file system hooking implementation, so file system
incompatibility can cause issues with this feature. The following table shows which file systems are compatible with the feature:
Deep Security Agent version
File system type
20 12 FR 12.0 11.3 11.2 11.1 11.0 10.3 10.2 10.1 10.0 9.6
ext2 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
ext3 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
ext4 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Disk file systems
XFS ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Btrfs ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
VFAT ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Optical discs ISO 9660 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
tmpfs ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Special file systems aufs ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
OverlayFS ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
164
Trend Micro Deep Security On-Premise 20
Deep Security Agent version
File system type
20 12 FR 12.0 11.3 11.2 11.1 11.0 10.3 10.2 10.1 10.0 9.6
NFSv3 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
NFSv4 ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Network file systems
(see Note, below) SMB ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
CIFS ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
FTP ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
Note: To protect network file systems, you must select Enable network directory scan in the malware scan configuration. For information, see "Scan a network directory
(real-time scan only)" on page 568.
( 5 ) This feature is available only with Full/Desktop Experience installations. It is not supported with Server Core installations.
System requirements
Each part of a Deep Security deployment has its own system requirements.
l "Deep Security Manager requirements" on the next page
l "Deep Security Agent requirements" on page 168
l "Deep Security Relay requirements" on page 169
l "Deep Security Virtual Appliance requirements" on page 169
Requirements vary by version. For older versions of Deep Security Manager, agents, relays, or virtual appliances, see their documentation.
165
Trend Micro Deep Security On-Premise 20
Note: If you plan to operate Deep Security in FIPS mode, see "FIPS 140-2 support" on page 1417 for additional requirements.
Deep Security Manager requirements
For a list of agent versions that are compatible with this version of the manager, see "Deep Security Agent platforms" on page 135.
System component Requirements
Minimum memory (RAM) Minimum RAM requirements depend on the number of agents that are being managed. See "Deep Security Manager sizing" on page 172.
Note:
On Linux, reserved system memory is separate from process memory. Therefore, although the installer's estimate might be similar, it will
detect less RAM than the computer actually has. To verify the computer's actual total RAM, log in with a superuser account and enter:
grep MemTotal /proc/meminfo
Minimum disk space 1.5 GB (200 GB recommended)
Operating system l Red Hat Enterprise Linux 8 (64-bit)
l Red Hat Enterprise Linux 7 (64-bit)
l Windows Server 2019 (64-bit)
l Windows Server 2016 (64-bit)
l Windows Server 2012 or 2012 R2 (64-bit)
Note: If you are upgrading your Deep Security Manager and are currently using Windows Server 2008, we recommend that you add a
new Deep Security Manager node on a supported operating system (see "Install Deep Security Manager on multiple nodes" on
page 257). When that's complete, decommission the node running on Windows Server 2008.
166
Trend Micro Deep Security On-Premise 20
System component Requirements
Database l PostgreSQL 11.x (only Core, Amazon RDS, or Amazon Aurora distributions)
l PostgreSQL 10.x (only Core, Amazon RDS, or Amazon Aurora distributions)
l PostgreSQL 9.6.x (only Core, Amazon RDS, or Amazon Aurora distributions)
l Microsoft SQL Server 2019
l Microsoft SQL Server 2017
l Microsoft SQL Server 2016
l Microsoft SQL Server 2014
l Microsoft SQL Server 2012
l Microsoft SQL RDS
l Azure SQL Database (SaaS) (multi-tenancy is not supported)
l Oracle 11g, 12c, all supported when deployed as software or when used with Amazon RDS
l Oracle 18, 19c, all supported when deployed as software or when used with Amazon RDS
Deep Security supports these Oracle RAC versions:
l Oracle RAC12c Release 1 (v12.1.0.2.0) on SUSE Linux Enterprise Server 11 SP3
l Oracle RAC 12c Release 1 (v12.1.0.2.0) on Red Hat Linux Enterprise Server 6.6
l Oracle RAC 12c Release 1 (v12.1.0.2) on Red Hat Linux Enterprise Server 7.0
Note:
l PostgreSQL minor versions for the above releases are also supported.
l Microsoft SQL Server Express is only supported in very limited deployments. See "Microsoft SQL Server Express considerations"
on page 204.
167
Trend Micro Deep Security On-Premise 20
System component Requirements
l Microsoft SQL Server service packs for these versions are also supported.
l Microsoft SQL Server is only supported when database containment is set to NONE. For details, see this Microsoft webpage on
contained databases.
l Oracle Database Express (XE) is not supported.
l Oracle container database (CDB) configuration is not supported with Deep Security Manager multi-tenancy.
Web browser Cookies must be enabled.
We recommend using the latest version of these browsers:
l Firefox
l Microsoft Internet Explorer 11 or Edge
l Google Chrome
l Apple Safari on a Mac
Deep Security Agent requirements
l Minimum RAM and disk space: See "Deep Security Agent and Relay sizing" on page 175
l Supported platforms (operating systems): See "Deep Security Agent platforms" on page 135.
l Supported features: Supported Deep Security features vary by platform.
Note: The agent installer permits installation on any supported platform. RAM and disk space requirements are not checked.
168
Trend Micro Deep Security On-Premise 20
Deep Security Relay requirements
Requirements are the same as those of the Deep Security Agent, with a few constraints:
l Relays are only supported on 64-bit operating systems.
l Relays are not supported on Solaris or AIX.
Deep Security Virtual Appliance requirements
Because the appliance uses the same protection modules as agents, if you import an update to the 64-bit agent for Red Hat, it may notify you that new software is available
for the appliance, like it does for Red Hat agents.
Note: VMware does not support running nested ESXi servers in production environments. For more information, see the VMware Knowledge Base article.
System
Requirements
component
CPU 64-bit, Intel-VT or AMD-V present and enabled in UEFI.
The number of CPUs varies by the number of VMs being protected. See "Deep Security Virtual Appliance sizing" on page 176.
Minimum
memory Varies by the number of VMs being protected. See "Deep Security Virtual Appliance sizing" on page 176.
(RAM)
Minimum
disk Varies by the number of VMs being protected. See "Deep Security Virtual Appliance sizing" on page 176.
space
169
Trend Micro Deep Security On-Premise 20
System
Requirements
component
VMware VMware NSX-T Data Center (NSX-T):
l VMware vCenter 7.0 with ESXi 7.0
l VMware vCenter 6.7 with ESXi 6.7 EP06 (release name ESXi 670-201901001)
l VMware vCenter 6.5 with 6.5 U2 P03 (release name ESXi 650-201811002)
l VMware NSX-T 3.x*
*VMware NSX-T 3.x is required to use the appliance in DPDK mode.
VMware NSX Data Center for vSphere (NSX-V):
l VMware vCenter 6.7 with ESXi 6.7
l VMware vCenter 6.5 with ESXi 6.5
l VMware NSX Manager 6.4.x
Note: VMware vSphere 6.5a is the minimum supported version with NSX for vSphere 6.4.0 and later.
VMware vCloud Director:
l supported with VMware NSX Data Center for vSphere (NSX-V) only
l versions up to and including 9.5 are supported
For details, see the VMware compatibility matrix.
For more information about VMware product interoperability, see VMware Interoperability Matrices.
Note: vCloud Networking & Security (vCNS) is not supported.
170
Trend Micro Deep Security On-Premise 20
System
Requirements
component
vSwitches The chosen vSwitch of the appliance must be able to communicate with the manager at the management network level. It can be any one of the following
types:
l vSphere Standard Switch (vSS)
l vSphere Distributed Switch (vDS)
l NSX-T Virtual Distributed Switch (N-VDS)
Guest The VMs (guests) that will be protected by the virtual appliance have these requirements:
VMs
l Supported operating systems: See "Deep Security Virtual Appliance 20 (NSX) supported guest OS's" on page 160.
l Compatible vSphere versions: See this VMware Compatibility Guide.
l Required drivers: If you plan to enable Anti-Malware protection through the virtual appliance, you must install the Guest Introspection Thin Agent with
the File Introspection driver (vsepflt) on each guest. For installation instructions, see your VMware NSX-V documentation or NSX-T documentation
and search for Install the Guest Introspection Thin Agent.
l To use Network Introspection (E-W) with NSX-T, the VMs (guests) must be linked to one of the following switches:
l NSX-T Virtual Distributed Switch (N-VDS)
l vSphere Distributed Switch (vDS) - new in vSphere 7.0:
l vDS 7.0 requires NSX-T 3.0, vCenter 7.0 and ESXi 7.0 or later
Deep
Security Deep Security Manager 20.
Manager
171
Trend Micro Deep Security On-Premise 20
Sizing
Sizing guidelines for Deep Security deployments vary by the scale of your network, hardware, and software.
Deep Security Manager sizing
Sizing recommendations for Deep Security Manager vary by how many agents it will have.
Number of agents Number of CPUs RAM JVM process memory Number of manager nodes Recommended disk space
<500 2 16 GB 8 GB 2 200 GB
500-1000 4 16 GB 8 GB 2 200 GB
1000-5000 4 16 GB 8 GB 2 200 GB
5000-10000 8 16 GB 12 GB 2 200 GB
10000-20000 8 24 GB 16 GB 2 200 GB
For best performance, it's important to allocate enough Java Virtual Machine (JVM) memory to the Deep Security Manager process. See "Configure Deep Security Manager
memory usage" on page 1344.
Recommendation scans are CPU-intensive for the Deep Security Manager. Consider the performance impact when determining how often to run recommendation scans.
See "Manage and run recommendation scans" on page 456.
Resource spikes may occur if a large number of virtual machines are rebooted simultaneously and agents re-establish their connection with Deep Security Manager at the
same time.
172
Trend Micro Deep Security On-Premise 20
Multiple server nodes
For better availability and scalability, use a load balancer, and install the same version of Deep Security Manager on 2 servers ("nodes"). Connect them to the same
database.
Tip: To avoid high load on database servers, don't connect more than two Deep Security Manager nodes to each database server.
Each manager node is capable of all tasks. No node is more important than any of the others. You can log in to any node, and agents, appliances, and relays can connect
with any node. If one node fails, other nodes can still provide service, and no data will be lost.
Database sizing
Database CPU, memory, and disk space required varies by:
l Number of protected computers
l Number of platforms where you install Deep Security Agent
l Number of events (logs) recorded per second (related to which security features are enabled)
l How long events are retained
l Size of the database transaction log
Minimum disk space = (2 x Deep Security data size) + transaction log
For example, if your database plus transaction log is 40 GB, you must have 80 GB (40 x 2) of free disk space during database schema upgrades.
To free disk space, delete any unnecessary agent packages for unused platforms (see "Delete a software package from the Deep Security database" on page 272),
transaction logs, and unnecessary event records.
Event retention is configurable. For security events, retention is configured in the policy, individual computer settings, or both. See "Policies, inheritance, and overrides" on
page 451 and "Log and event storage best practices" on page 829.
173
Trend Micro Deep Security On-Premise 20
To minimize disk usage due to events:
l Store events remotely, not locally. If you need to keep events longer (such as for compliance), forward them to a SIEM or Syslog server and then use pruning to delete
the local copy. (See "Forward Deep Security events to a Syslog or SIEM server" on page 846.)
Note: Some Application Control and Integrity Monitoring operations (Rebuild Baseline, Scan for Integrity Changes, and Scan for Inventory Changes) retain all
records locally, and are never pruned or forwarded.
l Patch the protected computer's software before you enable Intrusion Prevention. Recommendation scans assign more IPS rules to protect a vulnerable OS. More
security events increase local or remote disk usage.
l Disable unnecessary security features that log frequently, such as stateful Firewall for TCP, UDP, and ICMP.
High-traffic computers that use Deep Security Firewall or Intrusion Prevention features might record more events per second, requiring a database with better performance.
You might also need to adjust local event retention.
Tip: If you anticipate many Firewall events, consider disabling "Out of allowed policy" events. (See "Firewall settings" on page 685.)
See also "Deep Security Manager performance features" on page 194.
Database disk space estimates
The table below estimates database disk space with default event retention settings. If the total disk space for the protection modules you enable is more than the "2 or
more modules" value, use the smaller estimate. For example, you could deploy 750 agents with Deep Security Anti-Malware, Intrusion Prevention System and Integrity
Monitoring. The total of the individual recommendations is 320 GB (20 + 100 + 200) but the "2 or more modules" recommendation is less (300 GB). Therefore, you would
estimate 300 GB.
174
Trend Micro Deep Security On-Premise 20
Web Intrusion
Number of Log Application Integrity
Anti-Malware Reputation Firewall Prevention 2 or more modules
agents Inspection Control Monitoring
Service System
1-99 10 GB 15 GB 20 GB 20 GB 40 GB 50 GB 50 GB 100 GB
100-499 10 GB 15 GB 20 GB 20 GB 40 GB 100 GB 100 GB 200 GB
500-999 20 GB 30 GB 50 GB 50 GB 100 GB 200 GB 200 GB 300 GB
1000-9999 50 GB 60 GB 100 GB 100 GB 200 GB 500 GB 400 GB 600 GB
10,000-20,000 100 GB 120 GB 200 GB 200 GB 500 GB 750 GB 750 GB 1 TB
Database disk space also increases with the number of separate Deep Security Agent platforms. For example, if you have 30 agents (maximum 5 versions per agent
platform), this increases the database size by approximately 5 GB.
Deep Security Agent and Relay sizing
Platform Features enabled Minimum RAM Recommended RAM Minimum disk space
Windows All protection 2 GB 4 GB 1 GB
Windows Relay only 2 GB 4 GB 30 GB
Linux All protection 2 GB 5 GB 1 GB
Linux Relay only 2 GB 4 GB 30 GB
Solaris All protection. Relay not supported 4 GB 4 GB 2 GB
175
Trend Micro Deep Security On-Premise 20
Platform Features enabled Minimum RAM Recommended RAM Minimum disk space
AIX All protection. Relay not supported 4 GB 4 GB 2 GB
Less RAM is required for some OS versions, or if you do not enable all Deep Security features.
If protected computers use VMware vMotion, add 10 GB of disk space.
Relays require more disk space if you install Deep Security Agent on many different platforms. (Relays store update packages for each platform.) For details, see "Get Deep
Security Agent software" on page 266.
In smaller deployments, relays can be co-located with a Deep Security Manager. If your deployment has a large number of agents (more than 10,000), however, then relays
should be installed on separate, dedicated servers. Overloaded relays slow down update redistribution. See also "Plan the best number and location of relays" on
page 1092.
Deep Security Virtual Appliance sizing
The Deep Security Virtual Appliance software is delivered as a series of OVF files, with each one being allocated a different set of resources for different deployment sizes
and types. You'll need to choose the OVF file that supports your environment the best. See the table below for details.
See also "Deep Security Virtual Appliance memory allocation" on page 380.
OVF file vCPUs vRAM Disk space Virtual hardware version NSX type Maximum protected VMs DPDK support?
dsva.ovf 2 4 GB 20 GB 13 (ESXi 6.5+) NSX-V 10 no
dsva-small.ovf 4 8 GB 20 GB 13 (ESXi 6.5+) NSX-V 50 no
dsva-medium.ovf 6 16 GB 20 GB 13 (ESXi 6.5+) NSX-V 200 no
dsva-large.ovf 8 24 GB 20 GB 13 (ESXi 6.5+) NSX-V 300 no
176
Trend Micro Deep Security On-Premise 20
OVF file vCPUs vRAM Disk space Virtual hardware version NSX type Maximum protected VMs DPDK support?
dsva-<20.x.x-xxxx>-C2M4-small.ovf 2 4 GB 20 GB 13 (ESXi 6.5+) NSX-T 10 no
10 with DPDK enabled
dsva-<20.x.x-xxxx>-C4M8-small.ovf 4 8 GB 20 GB 13 (ESXi 6.5+) NSX-T yes*
50 with DPDK disabled
dsva-<20.x.x-xxxx>-C6M16-medium.ovf 6 16 GB 20 GB 13 (ESXi 6.5+) NSX-T 200 with DPDK disabled no
dsva-<20.x.x-xxxx>-C8M16-medium.ovf 8 16 GB 20 GB 13 (ESXi 6.5+) NSX-T 150 with DPDK enabled yes*
dsva-<20.x.x-xxxx>-C8M24-large.ovf 8 24 GB 20 GB 13 (ESXi 6.5+) NSX-T 300 with DPDK disabled no
dsva-<20.x.x-xxxx>-C12M24-large.ovf 12 24 GB 20 GB 13 (ESXi 6.5+) NSX-T 300 with DPDK enabled yes*
* To enable DPDK mode, see "Configure DPDK mode" on page 374.
Note:
Requirements above can vary by feature:
l Integrity Monitoring: For larger VDI deployments (more than 50 VMs per ESXi host), use Deep Security Agent instead, not Deep Security Virtual Appliance.
l Anti-Malware: Requirements may vary by version of VMware Guest Introspection. Use the VMware Configuration Maximum tool.
l Firewall, Web Reputation, or Intrusion Prevention: Requirements may vary by version of VMware Network Introspection (NSX). See the VMware Configuration
Maximums tool.
Tip:
Patch the protected computer's software before you enable Intrusion Prevention. Recommendation scans assign more IPS rules to protect a vulnerable OS. This
increases the appliance's memory usage. For example, the table below shows how vRAM usage can increase by the number of IPS rules on 300 VMs (full, linked or
177
Trend Micro Deep Security On-Premise 20
instant clones as virtual desktop infrastructure (VDI)).
Number of Intrusion Prevention rules Appliance vRAM usage
350-400 24 GB
500-600 30 GB
600-700 40 GB
700+ 50 GB+
If the appliance is protecting a large number of VMs, and recommendation scans fail due to timeout errors, see "Manage and run recommendation scans" on page 456 to
increase timeout values.
Port numbers, URLs, and IP addresses
Deep Security default port numbers, URLs, IP addresses, and protocols are listed in the sections below. If a port, URL or IP address is configurable, a link is provided to the
relevant configuration page.
l "Deep Security port numbers" on the next page
l "Deep Security URLs" on page 184
Note: If your network uses a proxy or load balancer, you can configure Deep Security to connect to it instead of directly to the components listed on this page. For details,
see "Configure proxies" on page 1080 and "Load Balancers" on page 1234.
Note: In addition to the ports on this page, Deep Security uses ephemeral ports when opening a socket (source port). Under rare circumstances these may be blocked,
causing connectivity issues. For details, see "Activation Failed - Blocked port" on page 1058.
178
Trend Micro Deep Security On-Premise 20
Deep Security port numbers
The following diagram shows the default ports in a Deep Security system. For details, see the table below the diagram.
179
Trend Micro Deep Security On-Premise 20
180
Trend Micro Deep Security On-Premise 20
Note: In the table below:
l 'Mandatory ports' refer to ports that must be opened to ensure the proper functioning of the Deep Security system.
l 'Optional ports' refer to ports that may be opened depending on the feature or component you want to deploy.
l 'Port' is used in place of 'port number' for brevity.
Port type Default port number and protocol
Deep Security Mandatory port:
Agent
/Appliance l 4118/HTTPS — Deep Security Agent/appliance port. Leave 4118/HTTPS closed if you plan on using agent-initiated communication. Only open it
listening if you plan on using bidirectional or manager-initiated communication. By default, bidirectional communication is used, which is why
(inbound) port 4118/HTTPS is listed here as 'mandatory'. See "Agent-manager communication" on page 1124 for details.
Mandatory ports:
l 53/DNS over TCP or UDP — DNS server port
l 80/HTTP, 443/HTTPS — Smart Protection Network port
l 123/NTP over UDP — NTP server port
Deep Security l 4119/HTTPS — Deep Security Manager GUI and API port
Agent
/Appliance l 4120/HTTPS — Deep Security Manager agent heartbeat port. Allow 4120/HTTPS if you are using bidirectional or agent-initiated communication.
outbound Close it if you are using manager-initiated communication. By default, bidirectional communication is used, which is why 4120/HTTPS is listed
ports
here as 'mandatory'. See "Agent-manager communication" on page 1124 for details.
l 4122/HTTPS — Deep Security Relay port.
Optional ports:
l 514/Syslog over UDP — SIEM or syslog server port. Allow port 514 if you want the agent to send its security events directly to your SIEM or
181
Trend Micro Deep Security On-Premise 20
Port type Default port number and protocol
syslog server. The port number is configurable in the manager.
l 5274/HTTP, 5275/HTTPS — Smart Protection Server ports. Allow ports 5274 and 5275 if you are hosting a Smart Protection Server in your local
network or Virtual Private Network (VPC), instead of having your agents/appliance connect to the cloud-based Smart Protection Network over
80/HTTP and 443/HTTPS. For details, see the Smart Protection Server documentation, or "Integrate with Smart Protection Server" on
page 1501.
l Allow the agent listening port, since it applies to the relay too
l 4122/HTTPS — Deep Security Replay port
Deep Security
Relay l 4123 — This port is for communication between the agent and its own internal relay
listening
(inbound) Note: Port 4123 should not be listening to connections from other computers, and you don't need to configure it in network firewall policies. But if
ports
you have firewall software (such as Windows Firewall or iptables) on the relay itself, verify that it does not block this connection to itself. Also verify
that other applications do not use the same port (a port conflict).
Deep Security
Relay l 80/HTTP, 443/HTTPS — Trend Micro Update Server/Active Update and Download Center ports
outbound l 4122 — port of other Deep Security Relays
ports
Mandatory ports:
Deep Security
Manager l 4119/HTTPS — Deep Security Manager GUI and API port
listening l 4120/HTTPS — Deep Security Manager agent heartbeat port. Allow 4120/HTTPS if you are using bidirectional or agent-initiated communication.
(inbound)
ports Close it if you are using manager-initiated communication. By default, bidirectional communication is used, which is why 4120/HTTPS is listed
here as 'mandatory'. See "Agent-manager communication" on page 1124 for details.
182
Trend Micro Deep Security On-Premise 20
Port type Default port number and protocol
Mandatory ports:
l 53/DNS over TCP or UDP — DNS server port
l 80/HTTP, 443/HTTPS — These ports are used by various Deep Security cloud services, Smart Protection Network services, Trend Micro Apex
Central, Deep Discovery Analyzer, VMware components (vCenter, ESXi, NSX), Whois server, AWS API, and Azure API, and Google Cloud
Platform (GCP) API) 80 and 443 are configurable depending on the service being accessed. You can configure Trend Micro Apex Central and
Deep Discovery Analyzer ports, NSX and vCenter ports, and the Whois port.
l 123/NTP over UDP — NTP server port number. The NTP server can be Trend Micro Apex Central.
l Deep Security Manager's database server port numbers. Select from:
l 1433/SQL over TCP or UDP — Microsoft SQL database port
Deep l 1433/SQL over TCP — Azure SQL Database port
Security l 1521/SQL over TCP — Oracle database port
Manager l 5432/SQL over TCP — PostgreSQL database port
(outbound l 11000-11999/SQL and 14000-14999/SQL over TCP — These are additional Azure SQL Database ports. Allow ports 11000-11999 and
ports) 14000-14999—in addition to 1433—if you are using Azure SQL Database and your Deep Security Manager runs within the Azure cloud
boundary. If your manager runs outside the Azure cloud boundary, you only need to allow port 1433 to Azure SQL Database. For details, see
this Azure document.
l 4118/HTTPS — Deep Security Agent/appliance port. Leave 4118/HTTPS closed if you plan on using agent-initiated communication. Only open it
if you plan on using bidirectional or manager-initiated communication. By default, bidirectional communication is used, which is why
4118/HTTPS is listed here as 'mandatory'. See "Agent-manager communication" on page 1124 for details.
l 4122/HTTPS — Deep Security Relay port.
Optional ports:
l 25/SMTP over TCP — Email server port. Allow port 25 if you want email notifications. 25 is configurable in the manager.
183
Trend Micro Deep Security On-Premise 20
Port type Default port number and protocol
l 162/SNMP over TCP or UDP — SNMP manager port. Allow port 162 if you want to "Forward system events to a remote computer via SNMP" on
page 952.
l 514/Syslog over UDP — SIEM or syslog server port. Allow port 514 if you want to forward Deep Security events to an external SIEM or syslog
server. 514 is configurable in the manager.
l 389/LDAP, 636/LDAPS, both over TCP — Active Directory ports. Allow ports 389 and 636 if you want to add computers from Active Directory to
the manager. 389 and 636 are configurable in the manager if your Active Directory server uses a different port.
Deep Security URLs
If you need to restrict the URLs that are allowed in your environment, read this section.
You'll need to make sure your firewall allows traffic from the 'Source' to the 'Destinations' listed in the table below. For each FQDN, make sure you allow access to its
associated HTTP and HTTPS URLs. For example, for the FQDN files.trendmicro.com, allow access to http://files.trendmicro.com:80 and
https://files.trendmicro.com:443.
Source Destination server or service name Destination fully-qualified domain name (FQDN)
l <manager FQDN or IP>:4119/webservice/Manager?WSDL
API clients Deep Security APIs l <manager FQDN or IP>:4119/api
l <manager FQDN or IP>:4119/rest
Deep Security legacy REST API's Status <manager FQDN or IP>:4119/rest/status/manager/ping
Legacy REST API clients l
Monitoring API
Deep Security Manager, Deep Security files.trendmicro.com
Agent/Appliance, Deep Security Relay Download Center or web server l
184
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
Hosts software.
Smart Protection Network - l gacl.trendmicro.com
Deep Security Manager Certified Safe Software Service (CSSS) l grid-global.trendmicro.com
Used for event tagging with Integrity Monitoring. l grid.trendmicro.com
20.0 and later agents/appliances connect to:
l ds2000-en-census.trendmicro.com
l ds2000-jp-census.trendmicro.com
12.0 and later agents/appliances connect to:
l ds1200-en-census.trendmicro.com
Smart Protection Network - l ds1200-jp-census.trendmicro.com
Global Census Service
Deep Security Agent/Appliance 11.0 and later agents/appliances connect to:
Used for behavior monitoring, and predictive
machine learning. l ds1100-en-census.trendmicro.com
l ds1100-jp-census.trendmicro.com
10.2 and 10.3 agents/appliances connect to:
l ds1020-en-census.trendmicro.com
l ds1020-jp-census.trendmicro.com
l ds1020-sc-census.trendmicro.com
185
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
10.1 and 10.0 agents/appliances connect to:
l ds1000-en.census.trendmicro.com
l ds1000-jp.census.trendmicro.com
l ds1000-sc.census.trendmicro.com
l ds1000-tc.census.trendmicro.com
20.0 and later agents/appliances connect to:
l deepsec20-en.gfrbridge.trendmicro.com
l deepsec20-jp.gfrbridge.trendmicro.com
12.0 and later agents/appliances connect to:
l deepsec12-en.gfrbridge.trendmicro.com
Smart Protection Network -
Good File Reputation Service l deepsec12-jp.gfrbridge.trendmicro.com
Deep Security Agent/Appliance
Used for behavior monitoring, predictive machine 11.0 and later agents/appliances connect to:
learning, and process memory scans.
l deepsec11-en.gfrbridge.trendmicro.com
l deepsec11-jp.gfrbridge.trendmicro.com
10.2 and 10.3 agents/appliances connect to:
l deepsec102-en.gfrbridge.trendmicro.com
l deepsec102-jp.gfrbridge.trendmicro.com
186
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
10.1 and 10.0 agents/appliances connect to:
l deepsec10-en.grid-gfr.trendmicro.com
l deepsec10-jp.grid-gfr.trendmicro.com
l deepsec10-cn.grid-gfr.trendmicro.com
20.0 and later agents/appliances connect to:
l ds200-en.fbs25.trendmicro.com
l ds200-en.fbs25.trendmicro.com
12.0 and later agent/appliance connect to:
l ds120-en.fbs25.trendmicro.com
l ds120-jp.fbs25.trendmicro.com
Smart Protection Network -
Deep Security Agent/Appliance 11.0 and later agents/appliances connect to:
Smart Feedback
l deepsecurity1100-en.fbs25.trendmicro.com
l deepsecurity1100-jp.fbs25.trendmicro.com
10.0 agents/appliances connect to:
l deepsecurity1000-en.fbs20.trendmicro.com
l deepsecurity1000-jp.fbs20.trendmicro.com
l deepsecurity1000-sc.fbs20.trendmicro.com
187
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
20.0 and later agents/appliances connects to:
l ds20.icrc.trendmicro.com
l ds20-jp.icrc.trendmicro.com
12.0 and later agents/appliances connect to:
l ds120.icrc.trendmicro.com
l ds120-jp.icrc.trendmicro.com
11.0 and later agents/appliances connect to:
l ds110.icrc.trendmicro.com
Smart Protection Network - l ds110-jp.icrc.trendmicro.com
Deep Security Agent/Appliance
Smart Scan Service
10.2 and 10.3 agents/appliances connect to:
l ds102.icrc.trendmicro.com
l ds102-jp.icrc.trendmicro.com
l ds102-sc.icrc.trendmicro.com.cn
10.1 and 10.0 agents/appliances connect to:
l ds10.icrc.trendmicro.com
l ds10.icrc.trendmicro.com/tmcss/
l ds10-jp.icrc.trendmicro.com/tmcss/
l ds10-sc.icrc.trendmicro.com.cn/tmcss/
188
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
9.6 and 9.5 agents/appliances connect to:
l iaufdbk.trendmicro.com
l ds96.icrc.trendmicro.com
l ds96-jp.icrc.trendmicro.com
l ds96-sc.icrc.trendmicro.com.cn
l ds95.icrc.trendmicro.com
l ds95-jp.icrc.trendmicro.com
l ds95-sc.icrc.trendmicro.com.cn
20.0 and later agents/appliances connect to:
l ds20-en-b.trx.trendmicro.com
l ds20-jp-b.trx.trendmicro.com
l ds20-en-f.trx.trendmicro.com
l ds20-jp-f.trx.trendmicro.com
Smart Protection Network -
Deep Security Agent/Appliance 12.0 and later agents/appliances connect to:
predictive machine learning
l ds120-en-b.trx.trendmicro.com
l ds120-jp-b.trx.trendmicro.com
l ds120-en-f.trx.trendmicro.com
l ds120-jp-f.trx.trendmicro.com
11.0 and later agents/appliances connect to:
189
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
l ds110-en-b.trx.trendmicro.com
l ds110-jp-b.trx.trendmicro.com
l ds110-en-f.trx.trendmicro.com
l ds110-jp-f.trx.trendmicro.com
10.2 and 10.3 agents/appliances connect to:
l ds102-en-f.trx.trendmicro.com
l ds102-jp-f.trx.trendmicro.com
l ds102-sc-f.trx.trendmicro.com
20.0 and later agents/appliances connect to:
l ds20-0-en.url.trendmicro.com
l ds20-0-jp.url.trendmicro.com
12.0 and later agents/appliances connect to:
Smart Protection Network - l ds12-0-en.url.trendmicro.com
Deep Security Agent/Appliance
Web Reputation Service l ds12-0-jp.url.trendmicro.com
The 11.0 and later agents/appliances connect to:
l ds11-0-en.url.trendmicro.com
l ds11-0-jp.url.trendmicro.com
10.2 and 10.3 agents/appliances connect to:
190
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
l ds10-2-en.url.trendmicro.com
l ds10-2-sc.url.trendmicro.com.cn
l ds10-2-jp.url.trendmicro.com
10.1 and 10.0 agents/appliances connect to:
l ds100-en.url.trendmicro.com
l ds100-sc.url.trendmicro.com
l ds100-jp.url.trendmicro.com
9.6 and 9.5 agents/appliances connect to:
l ds96-en.url.trendmicro.com
l ds96-jp.url.trendmicro.com
l ds95-en.url.trendmicro.com
l ds95-jp.url.trendmicro.com
l help.deepsecurity.trendmicro.com
Deep Security Manager Help and support
l success.trendmicro.com/product-support/deep-security
l licenseupdate.trendmicro.com
Deep Security Manager Licensing and registration servers l clp.trendmicro.com
l olr.trendmicro.com
191
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
l news.deepsecurity.trendmicro.com
Deep Security Manager News feed l news.deepsecurity.trendmicro.com/news.atom
l news.deepsecurity.trendmicro.com/news_ja.atom
Optional. There are links to the URLs below within the manager UI
and on the agent's 'Your administrator has blocked access to this
Browser on Deep Security Agent page for your safety' page.
computers, and the computer used to log in Site Safety
to Deep Security Manager l sitesafety.trendmicro.com
l jp.sitesafety.trendmicro.com
l iaus.activeupdate.trendmicro.com
Deep Security Relay, and Deep Security Update Server (also called Active Update) l iaus.trendmicro.com
Agent/Appliance l ipv6-iaus.trendmicro.com
Hosts security updates.
l ipv6-iaus.activeupdate.trendmicro.com
AWS URLs
AWS and Azure URLs
l URLs of AWS endpoints listed on this AWS page, under
Used for these headings:
adding AWS accounts, Azure accounts and l Amazon Elastic Compute Cloud (Amazon EC2)
Deep Security Manager
Google Cloud Platform (GCP) service accounts to l AWS Security Token Service (AWS STS)
Deep Security Manager.
l AWS Identity and Access Management (IAM)
l Amazon WorkSpaces
192
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
Azure URLs
l login.windows.net (authentication)
l login.microsoftonline.com (authentication)
l management.azure.com (Azure API)
l login.microsoftonline.us (authentication to Azure Government)
l management.usgovcloudapi.net (authentication to Azure
Government)
l management.core.windows.net (Azure API)
Note: The management.core.windows.net URL is only required if
you used the v1 Azure connector available in Deep Security
Manager 9.6 to add an Azure account to the manager. With Deep
Security Manager 10.0 and later, a v2 connector is used, and
does not require access to this URL.
GCP URLs
l oauth2.googleapis.com (authentication)
l www.googleapis.com (GCP API)
l cloudresourcemanager.googleapis.com (GCP API)
Telemetry service
Deep Security Manager l telemetry.deepsecurity.trendmicro.com
Used for anonymous "Deep Security Product
193
Trend Micro Deep Security On-Premise 20
Source Destination server or service name Destination fully-qualified domain name (FQDN)
Usage Data Collection" on page 1451.
Deep Security Manager performance features
Performance profiles
Deep Security Manager uses an optimized concurrent job scheduler that considers the impacts of each job on CPU, database and agents or appliances. By default, new
installations use the "Aggressive" performance profile which is optimized for a dedicated manager. If the Deep Security Manager is installed on a system with other
resource-intensive software it may be preferable to use the "Standard" performance profile. The performance profile can be changed by navigating to Administration >
Manager Nodes. From this screen select a manager node and open the Properties window. From here the performance profile can be changed via the menu.
The performance profile also controls the number of agent- or appliance-initiated connections that the manager will accept. The default of each of the performance profiles
effectively balances the amount of accepted, delayed and rejected heartbeats.
Low disk space alerts
Low disk space on the database
If the Deep Security Manager receives a "disk full" error message from the database, it will start to write events to its own hard drive and will send an email message to all
users informing them of the situation. This behavior is not configurable.
If you are running multiple manager nodes, the events will be written to the disk of whichever node is handling the event. (For more information on running multiple nodes,
see "Install Deep Security Manager on multiple nodes" on page 257.)
194
Trend Micro Deep Security On-Premise 20
Once the disk space issue on the database has been resolved, the manager will write the locally stored data to the database.
Low disk space on the manager
If the available disk space on the computer where Deep Security Manager is installed falls below 10%, the manager generates a "Low Disk Space" alert. This alert is part of
the normal alert system and is configurable like any other. (For more information, see "Configure alerts" on page 953.)
If you are running multiple manager nodes, the node will be identified in the alert.
When the manager's available disk space falls below 5 MB, the manager will send an email message to all users and the manager will shut down. The manager cannot be
restarted until the available disk space is greater than 5 MB.
You must restart the manager manually.
If you are running multiple nodes, only the node that has run out of disk space will shut down. The other manager nodes will continue operating.
195
Trend Micro Deep Security On-Premise 20
Get Started
Check digital signatures on software packages
Before you install Deep Security, you should check the digital signature on the software ZIP
packages and installer files. A correct digital signature indicates that the software is authentically
from Trend Micro and hasn't been corrupted or tampered with.
You should:
l "Check the signature on software ZIP packages" below
l "Check the signature on installer files (EXE, MSI, RPM or DEB files)" on page 198
You can also validate the software's checksums, as well as the security updates' and Deep
Security Agent modules' digital signature. See "How Deep Security validates update integrity"
on page 1280 and "Linux Secure Boot support for agents" on page 1158.
Check the signature on software ZIP packages
The Deep Security Agent, Deep Security Virtual Appliance, and online help are made available
in ZIP packages. These packages are digitally signed. You can check the digital signature on
the ZIP file in the following ways:
By importing or exporting the ZIP to or from the manager
Import or export a ZIP file following the instructions in "Import agent software" on
page 268 or "Export the agent installer" on page 270.
On import or export, the manager checks the digital signature on the ZIP file. If the
signature is good, the manager allows the import or export to proceed. If the signature is
bad, or doesn't exist, the manager disallows the action, deletes the ZIP, and logs an
event.
By viewing the ZIP's properties file
196
Trend Micro Deep Security On-Premise 20
1. Log in to Deep Security Manager.
2. Click Administration at the top.
3. On the left, expand Updates > Software > Local.
4. Find the ZIP package whose digital signature you want to check and double-click
it. (If it's not there, import it.)
5. The Properties page for the ZIP file opens, and the manager checks the digital
signature. If the signature is good, you'll see a green check mark in the Signature
field. (See image below.) If the signature is bad, or doesn't exist, the manager
deletes the ZIP and logs an event.
By using jarsigner
197
Trend Micro Deep Security On-Premise 20
Use the jarsigner Java utility to check a signature on a ZIP when you can't check it
through the manager. For example, let's say you obtained an agent ZIP package from a
non-manager source, such as the Deep Security Software page, and then wanted to
install the agent manually. In this scenario, you'd use the jarsigner utility since the
manager is not involved.
To check a signature using jarsigner:
1. Install the latest Java Development Kit on your computer.
2. Download the ZIP.
3. Use the jarsigner utility within the JDK to check the signature. The command is:
jarsigner -verify -verbose -certs -strict <ZIP_file>
Example:
jarsigner -verify -verbose -certs -strict Agent-RedHat_EL7-
11.2.0-124.x86_64.zip
4. Read any errors as well as the content of the certificate to determine if the
signature can be trusted.
Check the signature on installer files (EXE, MSI, RPM or DEB
files)
The installers for the Deep Security Agent, Deep Security Manager, and Deep Security Notifier
are digitally signed using RSA. The installer is an EXE or MSI file on Windows, an RPM file on
Linux operating systems (Amazon, CloudLinux, Oracle, Red Hat, and SUSE), or a DEB file on
Debian and Ubuntu.
Note: The instructions below describe how to check a digital signature manually on an
installer file. If you'd like to automate this check, you can include it in your agent deployment
scripts. For more on deployment scripts, see "Use deployment scripts to add and protect
computers" on page 1401.
Follow the instructions that correspond to the type of installer file you want to check.
l "Check the signature on an EXE or MSI file" on the next page
l "Check the signature on an RPM file" on the next page
198
Trend Micro Deep Security On-Premise 20
l "Check the signature on a DEB file" on page 201
Check the signature on an EXE or MSI file
1. Right-click the EXE or MSI file and select Properties.
2. Click the Digital Signatures tab to check the signature.
Check the signature on an RPM file
First, install GnuPG
Install GnuPG on the agent computer where you intend to check the signature, if it is not
already installed. This utility includes the GPG command-line tool, which you'll need in
order to import the signing key and check the digital signature.
Note: GnuPG is installed by default on most Linux distributions.
Next, import the signing key
1. Look for the 3trend_public.asc file in the root folder of the agent's ZIP file. The
ASC file contains a GPG public signing key that you can use to verify the digital
signature.
2. (Optional) Verify the SHA-256 hash digest of the ASC file using any hashing
utility. The hash is:
c59caa810a9dc9f4ecdf5dc44e3d1c8a6342932ca1c9573745ec9f1a82c118d7
3. On the agent computer where you intend to check the signature, import the ASC
file. Use this command:
Note: Commands are case-sensitive.
gpg --import 3trend_public.asc
The following messages appear:
gpg: directory `/home/build/.gnupg' created
199
Trend Micro Deep Security On-Premise 20
gpg: new configuration file `/home/build/.gnupg/gpg.conf'
created
gpg: WARNING: options in `/home/build/.gnupg/gpg.conf' are not
yet active during this run
gpg: keyring `/home/build/.gnupg/secring.gpg' created
gpg: keyring `/home/build/.gnupg/pubring.gpg' created
gpg: /home/build/.gnupg/trustdb.gpg: trustdb created
gpg: key E1051CBD: public key "Trend Micro (trend linux sign)
<alloftrendetscodesign@trendmicro.com>" imported
gpg: Total number processed: 1
gpg: imported: 1 (RSA: 1)
4. Export the GPG public signing key from the ASC file:
gpg --export -a 'Trend Micro' > RPM-GPG-KEY-CodeSign
5. Import the GPG public signing key to the RPM database:
sudo rpm --import RPM-GPG-KEY-CodeSign
6. Verify that the GPG public signing key has been imported:
rpm -qa gpg-pubkey*
7. The fingerprints of imported GPG public keys appear. The Trend Micro one is:
gpg-pubkey-e1051cbd-5b59ac99
The signing key has now been imported and can be used to check the digital
signature on the agent RPM file.
Finally, verify the signature on the RPM file
Tip: Instead of checking the signature on the RPM file manually, as described below,
you can have a deployment script do it. See "Use deployment scripts to add and
protect computers" on page 1401 for details.
Use this command:
200
Trend Micro Deep Security On-Premise 20
rpm -K Agent-PGPCore-<OS agent version>.rpm
Example:
rpm -K Agent-PGPCore-RedHat_EL7-11.0.0-950.x86_64.rpm
Make sure you run the above command on the Agent-PGPCore-<...>.rpm file.
(Running it on Agent-Core-<...>.rpm does not work.) If you cannot find the Agent-
PGPCore-<...>.rpm file in the agent ZIP, you'll need to use a newer ZIP, specifically:
l Deep Security Agent 11.0 Update 15 or a later update
or
l Deep Security Agent 12 Update 2 or later
or
l Deep Security Agent 20 or later
If the signature verification is successful, the following message appears:
Agent-PGPCore-RedHat_EL7-11.0.0-950.x86_64.rpm: rsa sha1 (md5) pgp
md5 OK
Check the signature on a DEB file
First, install the dpkg-sig utility
Install dpkg-sig on the agent computer where you intend to check the signature, if it is
not already installed. This utility includes the GPG command-line tool, which you'll need
in order to import the signing key and check the digital signature.
Next, import the signing key
1. Look for the 3trend_public.asc file in the root folder of the agent's ZIP file. The
ASC file contains a GPG public signing key that you can use to verify the digital
signature.
201
Trend Micro Deep Security On-Premise 20
2. (Optional) Verify the SHA-256 hash digest of the ASC file using any hashing
utility. The hash is:
c59caa810a9dc9f4ecdf5dc44e3d1c8a6342932ca1c9573745ec9f1a82c118d7
3. On the agent computer where you intend to check the signature, import the ASC
file to the GPG keyring. Use this command:
gpg --import 3trend_public.asc
The following message appears:
gpg: key E1051CBD: public key "Trend Micro (trend linux sign)
<alloftrendetscodesign@trendmicro.com>" imported
gpg: Total number processed: 1
gpg: imported: 1 (RSA: 1)
4. (Optional) Display the Trend Micro key information. Use this command:
gpg --list-keys
A message similar to the following appears:
/home/user01/.gnupg/pubring.gpg
-------------------------------
pub 2048R/E1051CBD 2018-07-26 [expires: 2021-07-25]
uid Trend Micro (trend linux sign)
<alloftrendetscodesign@trendmicro.com>
sub 2048R/202C302E 2018-07-26 [expires: 2021-07-25]
Finally, verify the signature on the DEB file
Tip: Instead of verifying the signature on the DEB file manually, as described below,
you can have a deployment script do it. See "Use deployment scripts to add and
protect computers" on page 1401 for details.
Enter this command:
dpkg-sig --verify <agent_deb_file>
202
Trend Micro Deep Security On-Premise 20
where <agent_deb_file> is the name and path of the agent DEB file. For example:
dpkg-sig --verify Agent-Core-Ubuntu_16.04-12.0.0-563.x86_64.deb
A processing message appears:
Processing Agent-Core-Ubuntu_16.04-12.0.0-563.x86_64.deb...
If the signature is verified successfully, the following message appears:
GOODSIG _gpgbuilder CF5EBBC17D8178A7776C1D365B09AD42E1051CBD
1568153778
Deploy Deep Security Manager
Prepare a database
Database requirements
Before you install Deep Security Manager, you must install a database server for Deep Security
Manager to use. This database server must meet the following requirements.
l "Software requirements" below
l "Hardware requirements" on page 205
l "Network requirements" on page 205
l "VMware requirements" on page 206
l "Scaling requirements" on page 206
After reviewing the requirements, you are ready to install the database server.
Software requirements
Deep Security supports these databases:
l PostgreSQL 11.x (only Core, Amazon RDS, or Amazon Aurora distributions)
l PostgreSQL 10.x (only Core, Amazon RDS, or Amazon Aurora distributions)
l PostgreSQL 9.6.x (only Core, Amazon RDS, or Amazon Aurora distributions)
203
Trend Micro Deep Security On-Premise 20
l Microsoft SQL Server 2019
l Microsoft SQL Server 2017
l Microsoft SQL Server 2016
l Microsoft SQL Server 2014
l Microsoft SQL Server 2012
l Microsoft SQL RDS
l Azure SQL Database (SaaS) (multi-tenancy is not supported)
l Oracle 11g, 12c, all supported when deployed as software or when used with Amazon
RDS
l Oracle 18, 19c, all supported when deployed as software or when used with Amazon RDS
Deep Security supports these Oracle RAC versions:
l Oracle RAC12c Release 1 (v12.1.0.2.0) on SUSE Linux Enterprise Server 11 SP3
l Oracle RAC 12c Release 1 (v12.1.0.2.0) on Red Hat Linux Enterprise Server 6.6
l Oracle RAC 12c Release 1 (v12.1.0.2) on Red Hat Linux Enterprise Server 7.0
Note:
l PostgreSQL minor versions for the above releases are also supported.
l Microsoft SQL Server Express is only supported in very limited deployments. See
"Microsoft SQL Server Express considerations" below.
l Microsoft SQL Server service packs for these versions are also supported.
l Microsoft SQL Server is only supported when database containment is set to NONE. For
details, see this Microsoft webpage on contained databases.
l Oracle Database Express (XE) is not supported.
l Oracle container database (CDB) configuration is not supported with Deep Security
Manager multi-tenancy.
Microsoft SQL Server Express considerations
Some deployments might be able to use Microsoft SQL Server Express for the Deep Security
Manager database. Important limitations are below. If you think your deployment cannot operate
within these limitations, use another database, or migrate to the Enterprise edition.
204
Trend Micro Deep Security On-Premise 20
Warning: If you exceed the limits, you will experience a service outage and you will need to
upgrade to a paid version of Microsoft SQL Server.
l Express edition size limitations: Microsoft SQL Server Express has a 10 GB maximum
database size and other important limits. High load scenarios are not supported by
Express. Symptoms can include database connection errors.
l Express edition 'LocalDB' preset: Express has a "LocalDB" preset. More configuration
may be required to accept remote connections.
l Limited number of protected computers: Do not use Microsoft SQL Server Express if your
deployment has more than 50 protected computers. More computers' events will cause a
larger database which Microsoft SQL Server Express cannot handle.
l Lack of multi-node support: Multi-node Deep Security Manager, required for larger
deployments, is not supported by Express.
l Security module limitations: Only Deep Security Anti-Malware and Intrusion Prevention
modules are supported with a Microsoft SQL Server Express database due to its
limitations. If you require any other protection modules, use another supported database.
Hardware requirements
l The database CPU, memory, and disk space should conform to the recommendations in
"Database sizing" on page 173.
l The database should be installed on a dedicated server that is separate from the manager
nodes.
Network requirements
l The database should be located on the same network as Deep Security Manager. The
network should have a 1 GB LAN connection to ensure unhindered communication
between the two. (WAN connections are not recommended.) The same applies to
additional Deep Security Manager nodes. 2 ms latency or less is recommended for the
connection from the manager to the database.
l Databases hosted in the cloud should not use multiple availability zones ("multi-AZ"),
which can increase network latency.
205
Trend Micro Deep Security On-Premise 20
VMware requirements
In a VMware environment, Deep Security Manager and its database should always run in the
same ESXi host. To configure this:
1. In the vCenter Web Client, go to Host and Clusters and select the cluster.
2. Go to the Manage tab and click VM/Host Rules > Add.
3. Type a name for the rule.
4. Select Enable rule.
5. From Type select Keep Virtual Machines Together.
6. Click Add and select the manager and database VMs.
Scaling requirements
l You should use database load balancing, mirroring, and high availability (HA)
mechanisms for scalability and service uptime. Consult your database vendor's
documentation for setup details.
l If you decide to replicate the database, you should use database mirroring over database
replication. Database replication technologies sometimes add columns to the database
tables during replication. This changes the Deep Security database schema and can result
in critical failures. Deep Security works with any failover protection technology that does
not change its schema.
Install a database server
After reviewing the database requirements, you are ready to install a database server. Refer to
your database provider's documentation for instructions.
Tip: For a quick and easy setup, use postgreSQL. It's free, and can be downloaded from this
link: PostgreSQL software download page.
After installing the database server, you are ready to configure it.
Configure the database
After installing the database, you are ready to configure it for Deep Security Manager.
First, configure a database instance, a database user, and a few other vendor-specific settings.
See one of the following sections:
206
Trend Micro Deep Security On-Premise 20
Configure PostgreSQL
Basic configuration
1. Connect to the PostgreSQL database server using a client program such as psql
or pgAdmin.
2. Create an empty database instance and a database user with the appropriate
permissions:
CREATE DATABASE "<database-name>";
CREATE ROLE "<dsm-username>" WITH PASSWORD '<password>' LOGIN;
GRANT ALL ON DATABASE "<database-name>" TO "<dsm-username>";
GRANT CONNECT ON DATABASE "<database-name>" TO "<dsm-
username>";
This user will be used by Deep Security Manager to connect to the database instance.
Multi-tenancy configuration
If Deep Security Manager will have multiple tenants:
l Keep the main database name short. It will be easier to read your tenants'
database names. (For example, if the main database is "dsm", the first tenant's
database name will be "dsm_1", the second tenant's database name will be
"dsm_2", and so on.)
l Also grant the right to create new databases and roles for tenants:
ALTER ROLE <dsm-username> CREATEDB CREATEROLE;
Optional PostgreSQL tuning
See "Maintain PostgreSQL" on page 1201.
Configure Microsoft SQL Server
Basic configuration
1. Connect to Microsoft SQL Server by opening Microsoft SQL Server Management
Studio (SSMS).
207
Trend Micro Deep Security On-Premise 20
2. Create an empty database instance. This database instance will be used by Deep
Security Manager.
3. Create a database account with db_owner rights. This account will be used by
Deep Security Manager to connect to the database.
4. Enable the TCP/IP protocol for the database instance (see
https://docs.microsoft.com/en-us/previous-versions/bb909712
(v=vs.120)?redirectedfrom=MSDN).
5. Configure connection timeouts. Go SQL management studio > SQL Server
properties > Connections > Remote query timeout and select 0 (No Timeout).
This setting prevents database connection timeouts that can occur when you
upgrade if each database schema migration operation takes a long time to
complete.
Multi-tenancy configuration
If Deep Security Manager will have multiple tenants:
l Keep the main database name short. It will be easier to read your tenants'
database names. (For example, if the main database is "dsm", the first tenant's
database name will be "dsm_1", the second tenant's database name will be
"dsm_2", and so on.)
l Also grant dbcreator rights to the database account used by the Deep Security
Manager.
Configure Oracle Database
Basic configuration
1. Connect to Oracle Database using a client program such as SQL*Plus or
SQL Developer.
2. Start the "Oracle Listener" service. Verify that it accepts TCP connections.
3. Create an empty database instance. This database instance will be used by Deep
Security Manager.
4. Create a database account that will be used by Deep Security Manager to connect
to the database. When creating the account, follow these guidelines:
l Assign the CONNECT and RESOURCE roles and UNLIMITED
TABLESPACE, CREATE SEQUENCE, CREATE TABLE and CREATE
TRIGGER permissions.
208
Trend Micro Deep Security On-Premise 20
l Don't use special characters in Deep Security Manager's database user
name. Although Oracle allows special characters when configuring the
database user object if they are surrounded by quotes, Deep Security does
not support special characters for the database user.
Oracle RAC configuration
If you're using Oracle RAC, disable the Firewall module or customize the Firewall
settings according to the instructions in "Firewall settings with Oracle RAC" on
page 690.
Multi-tenancy configuration
If Deep Security Manager will have multiple tenants:
l Keep the main database name short. It will be easier to read your tenants'
database names. (For example, if the main database is "MAINDB", the first
tenant's database name will be "MAINDB_1", the second tenant's database name
will be "MAINDB_2", and so on.)
l Also grant CREATE USER, DROP USER, ALTER USER, GRANT ANY
PRIVILEGE and GRANT ANY ROLE to the Deep Security Manager's database
user.
l Don't use the Oracle container database (CDB) configuration. It is not supported
with Deep Security Manager multi-tenancy.
Next, perform these additional configurations:
1. Synchronize both time and time zone. Use the same time source on both the database and
Deep Security Manager servers.
2. Allow network connections between Deep Security Manager and the database server. See
"Port numbers, URLs, and IP addresses" on page 178.
3. (Optional) Configure encryption. See "Encrypt communication between the Deep Security
Manager and the database" on page 1252.
After preparing the database, you can install Deep Security Manager.
209
Trend Micro Deep Security On-Premise 20
Run a readiness check
You can have the manager's installer run a readiness check to make sure your environment is
ready for the Deep Security Manager installation. Nothing will be installed but the installer will
check your installation environment to make sure it complies with system requirements. It will
then generate a report which you can use to fix any issues before actually installing Deep
Security Manager. For example, you may need to free disk space, allocate more vRAM, or install
a new OS. If you're not ready, you can cancel out of the installer and return when ready.
To run a readiness check
Step through the manager's graphical, interactive installer until you reach the page
where you are offered the option to run the check. For details, see "Install Deep Security
Manager" below.
To run a silent readiness check
Run the manager's silent installer with the -t option to indicate you want the installer to
run in readiness check mode. For details, see "Install Deep Security Manager silently"
on page 215
l Windows example:
Manager-Windows-<Version>.x64.exe -q -console -
Dinstall4j.language=<ISO code> -varfile <PropertiesFile> -t
l Linux example:
Manager-Linux-<Version>.x64.sh [-q] [-console] -t [-
Dinstall4j.language=<ISO code>] [-varfile <PropertiesFile>]
Note: On Linux, the readiness check might detect less RAM than the computer
actually has. To verify the computer's actual total RAM, log in with a superuser
account and enter: grep MemTotal /proc/meminfo
Install Deep Security Manager
Topics:
210
Trend Micro Deep Security On-Premise 20
l "Before you begin" below
l "Install the manager" below
l "Test the installation (log in to the manager)" on page 215
l "Replace the self-signed certificate" on page 215
Before you begin
Make sure you have completed these pre-installation tasks:
1. Check system requirements for the manager: See "System requirements" on page 165.
2. Prepare a database: See "Database requirements" on page 203, "Install a database
server" on page 206, and "Configure the database" on page 206.
3. Open ports: Make sure you allow inbound and outbound communication to and from the
manager on the appropriate port numbers. See "Deep Security port numbers" on
page 179.
4. Allow URLs: If you are planning on restricting the URLs to or from the manager server,
make sure you allow the URLs described in "Deep Security URLs" on page 184.
5. Synchronize clocks: Synchronize the OS clock of the manager's server with the clock of
the database. Both computers should use the same NTP service.
6. Configure DNS: Configure DNS with the appropriate records so that the manager, agents,
appliances, and relays can perform DNS lookup queries. Alternatively, use IP addresses,
or add entries to the manager's hosts file. The server's DNS name cannot start with a
number, such as 0000-dsm.example.com. If it does, the install log shows:
java.io.IOException: DNSName components must begin with a letter
7. Download the manager software: It's available at
https://help.deepsecurity.trendmicro.com/software.html.
8. Check the digital signature on the manager's installer file: See "Check the signature on
installer files (EXE, MSI, RPM or DEB files)" on page 198.
9. Run the readiness check: See "Run a readiness check" on the previous page.
Install the manager
After completing the tasks in "Before you begin" above, you are ready to install the manager.
You can use either:
l Graphical, interactive installer (follow the steps below)
l Silent installer (see "Install Deep Security Manager silently" on page 215)
To run the graphical, interactive installer:
211
Trend Micro Deep Security On-Premise 20
1. If you're installing on Linux, make sure X Windows System is installed so you can see the
GUI.
2. Run the installer as root, superuser, or (on Windows) Administrator.
3. For details about how to fill out specific sections of the installer, read the sections below.
Choosing between a fresh install or an upgrade
If the installer detects an existing installation of the manager, you are prompted to select
a fresh install or an upgrade.
l Fresh install (can use existing or new database): This option installs Deep
Security software and initializes the database.
l Upgrade: This option installs new Deep Security software, but keeps existing
computer details, policies, intrusion prevention rules, firewall rules, and so no. The
database schema is updated, if required. Data is migrated to new formats, if
required.
Warning: If you select Fresh install (can use existing or new database), the installer
will delete all data from any previous installation.
Configuring the database connection details
1. On the Database screen, select either Microsoft SQL Server, Oracle Database,
or PostreSQL, whichever you have configured in "Configure the database" on
page 206.
2. In the Host name field, enter the database host name.
3. In the Database name field, enter the name of the empty database you created for
use with Deep Security.
4. If you selected Microsoft SQL Server, then the manager's connection settings
vary by authentication type:
l SQL Server authentication: Enter the User name and Password of the SQL
user.
l Active Directory authentication: Enter the User name(no domain) and
Password of an Active Directory user, and then click Advanced and enter the
Domain separately. Active Directory authentication is also known as Kerberos
or Windows domain authentication.
212
Trend Micro Deep Security On-Premise 20
Note: See also "SQL Server domain authentication problems" on page 1529.
Note: With Microsoft SQL Server, Windows workgroup authentication is not
supported.
5. If you selected Oracle Database or PostgreSQL, enter the user name and
password of a database user who has permissions to the empty database you
created for use with Deep Security.
Configuring a master key
On the Master Key screen, configure a master key. This key will be used to encrypt the
passwords in the manager's database, dsm.properties file, and
configuration.properties file. Choose one of the following options:
l Configure later. With this option, no master key is generated. Instead, the installer
uses a hard-coded seed to encrypt the passwords mentioned above. Encrypted
passwords are prefixed with $1$, for example,
database.Oracle.password=$1$***. If you decide later that you'd like to use a
master key instead of a hard-coded seed, you can use the dsm_c -action
masterkey command to switch. See "Command-line basics" on page 1348 for
details.
l Use Amazon Web Services (AWS) Key Management Service (KMS). With this
option, the installer communicates with AWS KMS to obtain a 256-bit symmetric
customer master key (CMK), which is then used to encrypt the passwords
mentioned above. If you don't yet have a CMK in AWS KMS, follow these AWS
instructions to create one. Specify the CMK's ARN in the Amazon Resource
Name (ARN) field in the manager's installer. To find the ARN, follow these AWS
instructions. Encrypted passwords are prefixed with $DMK$, for example,
database.Oracle.password=$DMK$***.
l Use a local environment variable (automatically created). With this option, the
installer generates a master key and uses it to encrypt the passwords mentioned
above. Encrypted passwords are prefixed with $DMK$. The installer encrypts the
master key with the secret that you specify in the Secret field, and then places the
encrypted key in a local environment variable with a 'name' of 'LOCAL_KEY_
SECRET'. The secret must include:
213
Trend Micro Deep Security On-Premise 20
l a capital letter
l a lower cased letter
l a number
l a special character
l between 8-64 characters
Warning: Remember the secret. You will need it when installing additional
manager nodes.
Choosing whether to install a co-located relay
Deep Security requires at least one relay. Relays distribute security updates to
protected computers. For more information on relays, see "Deploy additional relays" on
page 1091.
When you run the Deep Security Manager installer, it searches its local directory for a
full ZIP package of the agent installer. (Relays are agents whose relay feature is
enabled.) If the ZIP is not found, then the manager's installer will try to download it from
the Trend Micro Download Center on the Internet.
l If an agent installer is found in either location, the manager's installer will offer to
install the newest relay.
Tip:
Trend Micro recommends that you install a local relay to:
l Provide a relay that is local to the manager
l Ensure that at least one relay is always available, even when you
decommission old computers with relays
Warning: When the manager's installer adds an agent to its server, it only
enables the relay feature. It does not apply any default security settings. To
protect the server, in Deep Security Manager, apply a security policy to its agent.
l If no agent installer is found, you can download and install an agent or relay later.
214
Trend Micro Deep Security On-Premise 20
Test the installation (log in to the manager)
The "Trend Micro Deep Security Manager" service starts automatically when you finish its
installer. To log into Deep Security Manager's GUI, open a web browser and go to:
https://[host_name]:[port]/
where [host_name] is the IP address or domain name of the server where you installed Deep
Security Manager, and [port] is the Manager Port you specified during installation.
Example:
https://example.dsm.com:4119/
Replace the self-signed certificate
When installing Deep Security for the first time, the installer creates a self-signed server
certificate that Deep Security Manager uses to identify itself during secure connections with
agents, appliances, relays, and your web browser. It is valid for 10 years. However, because it is
not signed by a trusted Certificate Authority (CA), your web browser will display warnings. To
eliminate these warnings and improve security, consider replacing Deep Security's server
certificate with one signed by a trusted CA. For details, see "Replace the Deep Security
Manager TLS certificate" on page 1245.
Install Deep Security Manager silently
Topics:
l "Before you begin" on the next page
l "Run a silent install on Windows" on the next page
l "Run a silent install on Linux" on the next page
l "Silent install parameters" on the next page
l "Sample installation output" on page 217
l "Deep Security settings in the properties file" on page 219
l " Sample properties file" on page 228
215
Trend Micro Deep Security On-Premise 20
Before you begin
Make sure you have completed all pre-installation tasks in "Install Deep Security Manager" on
page 210.
Run a silent install on Windows
To initiate a silent install on Windows, open a command prompt in the same directory as the
install package and run:
Manager-Windows-<Version>.x64.exe -q -console -Dinstall4j.language=<ISO
code> -varfile <PropertiesFile>
For details on the parameters and variables in the above command, see "Silent install
parameters" below.
Run a silent install on Linux
Note: Before executing this command, grant execution permission to the installation package.
To initiate a silent install on Linux, use the command line to go to the same directory as the
install package and run:
Manager-Linux-<Version>.x64.sh [-q] [-console] [-Dinstall4j.language=<ISO
code>] [-varfile <PropertiesFile>]
For details on the parameters and variables in the above command, see "Silent install
parameters" below.
Silent install parameters
-q forces the installer to execute in unattended (silent) mode.
-console forces messages to appear in the console (stdout).
-Dinstall4j.language=<ISO code> lets you override the default installation language
(English) if other languages are available. Specify a language using standard ISO language
identifiers:
216
Trend Micro Deep Security On-Premise 20
l Japanese: ja
l Simplified Chinese: zh_CN
-varfile <PropertiesFile> , where <PropertiesFile> is the full path to standard Java
properties file with entries for the various settings you can apply during a Deep Security
Manager install. Each property is identified by its equivalent GUI screen and setting in the
Windows Deep Security Manager installation. For example, the Deep Security Manager address
on the "Address and Ports" screen is specified as:
AddressAndPortsScreen.ManagerAddress=
Most of the properties in this file have acceptable defaults and may be omitted.
For a complete description of available settings, see "Deep Security settings in the properties
file" on page 219.
-t runs an installer readiness check rather than a regular install.
Sample installation output
The following is a sample output from a successful install, followed by an example output from a
failed install (invalid license). The [Error] tag in the trace indicates a failure.
217
Trend Micro Deep Security On-Premise 20
Successful install
Stopping Trend Micro Deep Security Manager Service...
Checking for previous versions of Trend Micro Deep Security Manager...
Upgrade Verification Screen settings accepted...
The installation directory has been set to C:\Program Files\Trend
Micro\Deep Security Manager.
Database Screen settings accepted...
License Screen settings accepted...
Address And Ports Screen settings accepted...
Credentials Screen settings accepted...
Security Update Screen settings accepted...
Software Update Screen settings accepted...
Smart Protection Network Screen settings accepted...
All settings accepted, ready to execute...
Extracting files ...
Setting Up...
Connecting to the Database...
Creating the Database Schema...
Creating MasterAdmin Account...
Recording Settings...
Creating Temporary Directory...
Installing Reports...
Installing Modules and Plug-ins...
Creating Help System...
Validating and Applying Activation Codes...
Configure Localizable Settings...
Setting Default Password Policy...
Creating Scheduled Tasks...
Creating Asset Importance Entries...
Creating Auditor Role...
Optimizing...
Importing Software Packages...
Configuring Relay For Install...
Importing Performance Profiles...
Recording Installation...
Clearing Sessions...
Creating Properties File...
Creating Shortcut...
Configuring SSL...
Configuring Service...
Configuring Java Security...
218
Trend Micro Deep Security On-Premise 20
Configuring Java Logging...
Cleaning Up...
Starting Deep Security Manager...
Finishing installation ...
Failed install
This example shows the output generated when the properties file contains an invalid license
string:
Stopping Trend Micro Deep Security Manager Service...
Detecting previous versions of Trend Micro Deep Security Manager...
Upgrade Verification Screen settings accepted...
Database Screen settings accepted...
Database Options Screen settings accepted...
[ERROR] The license code you have entered is invalid.
[ERROR] License Screen settings rejected...
Rolling back changes...
Deep Security settings in the properties file
The format of each entry in the settings property file is:
<Screen Name>.<Property Name>=<Property Value>
The settings properties file has required and optional values.
Note: If you enter an invalid value for optional properties, the installer will use the default
value instead.
Required Settings
LicenseScreen
Property Possible Values Default Value
LicenseScreen.License.-1 <activation code for all modules> <none>
OR
Property Possible Values Default Value
LicenseScreen.License.0 <activation code for Anti-Malware> <none>
LicenseScreen.License.1 <activation code for Firewall/DPI> <none>
LicenseScreen.License.2 <activation code for Integrity Monitoring> <none>
219
Trend Micro Deep Security On-Premise 20
Property Possible Values Default Value
LicenseScreen.License.3 <activation code for Log Inspection> <none>
CredentialsScreen
Default
Property Possible Values
Value
<username for the master
CredentialsScreen.Administrator.Username <none>
administrator>
<password for the master
CredentialsScreen.Administrator.Password <none>
administrator>
Optional Settings
LanguageScreen
Property Possible Values Default Value Notes
l "en_US" indicates
en_US English.
sys.languageId ja en_US
l "ja" indicates
Japanese.
UpgradeVerificationScreen
This screen determines what happens if an existing installation is detected.
Note: This setting is not referenced unless an existing installation is detected.
Property Possible Values Default Value
l True
UpgradeVerificationScreen.Overwrite False
l False
A True value results in a fresh install with all data in the existing database being discarded. A
False value provides the option to repair the existing installation.
Warning: If you set this value to True, it will overwrite any existing data in the database. It will
do this without any further prompts.
OldDataMigrationScreen
This screen defines the number of days of data to keep. When this setting is 0, all historical data
will be kept, but this may increase the amount of time the upgrade will take. During the data
220
Trend Micro Deep Security On-Premise 20
migration, the silent install will show the percentage of records migrated at 10% intervals.
Note: This setting is not referenced unless an existing installation is detected and it requires a
data migration to upgrade the database schema.
Property Possible Values Default Value
OldDataMigrationScreen.HistoricalDays <integer> 0
DatabaseScreen
This screen defines the database type and optionally the parameters needed to access certain
database types.
Note: In the interactive install, you can click Advanced to define the instance name and
domain of a Microsoft SQL server. This appears in a dialog. Because the unattended install
does not support dialogs, these arguments are included in the DatabaseScreen settings
below.
Defaul
Possible
Property t Notes
Values
Value
l Microsoft
SQL
Server Microso
DatabaseScreen.DatabaseType ft SQL None
l Oracle
Server
l PostgreS
QL
l <databas
None
e
hostname You can specify the port
Current
DatabaseScreen.Hostname or IP host in this entry using the
address> name format
l Current <hostname>:<port>.
host name Example: example:123
DatabaseScreen.DatabaseName <string> dsm
l Named
Pipes Named Required for SQL Server
DatabaseScreen.Transport
Pipes only
l TCP
221
Trend Micro Deep Security On-Premise 20
Defaul
Possible
Property t Notes
Values
Value
Username used by the
manager to authenticate
to the database server.
Must match an existing
database account. Note
that the Deep Security
Manager database
permissions will
<database correspond to this user's
DatabaseScreen.Username <none>
username> permissions. For
example, if you choose a
database account with
read-only privileges, the
Deep Security Manager
will not be able to write to
the database. Mandatory
for Microsoft SQL Server
and Oracle.
Password used by the
manager to authenticate
<database
DatabaseScreen.Password <none> to the database server.
password>
Mandatory for Microsoft
SQL Server and Oracle.
Used only with Microsoft
SQL Server, which
supports multiple
instances on a single
server or processor. Only
one instance can be the
default instance and any
others are named
instances. If the Deep
DatabaseScreen.SQLServer.Instance <string> <none>
Security Manager
database instance is not
the default, enter the
name of the instance
here. The value must
match an existing
instance or be left blank
to indicate the default
instance.
Used only with Microsoft
SQL Server. This is the
DatabaseScreen.SQLServer.Domain <string> <none> Windows domain used
when authenticating to
222
Trend Micro Deep Security On-Premise 20
Defaul
Possible
Property t Notes
Values
Value
the SQL Server. The
DatabaseScreen.Userna
me and
DatabaseScreen.Passw
ord described above are
only valid within the
appropriate domain.
Used only with Microsoft
SQL Server. Collation
determines how strings
are sorted and
compared. If the value is
"False", Deep Security
will use Latin1_General_
CS_AS for collation on
DatabaseScreen.SQLServer.UseDefaultColl l True text-type columns. If the
False
ation l False value is "True", Deep
Security will use the
collation method
specified by your SQL
Server database. For
additional information on
collation, refer to your
SQL Server
documentation.
AddressAndPortsScreen
This screen defines the hostname, URL, or IP address of this computer and defines port
numbers for the manager. In the interactive installer, this screen also supports connecting a new
manager node to an existing database, but this option is not supported in the unattended install.
Possible Default
Property Notes
Values Value
<manager
<current
hostname,
AddressAndPortsScreen.ManagerAddress host None
URL or IP
name>
address>
<port See "Port numbers, URLs, and
AddressAndPortsScreen.ManagerPort 4119
number> IP addresses" on page 178.
<port See "Port numbers, URLs, and
AddressAndPortsScreen.HeartbeatPort 4120
number> IP addresses" on page 178.
True indicates that the current
AddressAndPortsScreen.NewNode l True False
install is a new node. If the
223
Trend Micro Deep Security On-Premise 20
Possible Default
Property Notes
Values Value
installer finds existing data in
the database, it will add this
installation as a new node.
(Multi-node setup is always a
l False silent install.) Note: The "New
Node" installation information
about the existing database to
be provided via the
DatabaseScreen properties.
CredentialsScreen
Possible Default
Property Notes
Values Value
l True True causes Deep Security
CredentialsScreen.UseStrongPasswords False Manager to enforce strong
l False passwords.
MasterKeyConfigurationScreen
Defa
Possible ult
Property Notes
Values Valu
e
l Do If configured, the installer will use KMS
not or the local key secret to generate a
confi custom master key. If not configured, a
Do not
MasterKeyConfigurationScreen.Ke gure config hard-coded seed is used instead. See
yConfigType
l Local ure also masterkey.
Key
Instead, you must run masterkey
l KMS commands after the installer.
The Amazon Resource Name (ARN) of
MasterKeyConfigurationScreen.AR <AWS AR <non the KMS key. Only used if
N N> e> MasterKeyConfigurationScreen.Ke
yConfigType is KMS.
The value that you want to use when the
installer configures the local
MasterKeyConfigurationScreen.Loc <non environment variable LOCAL_KEY_
<string> SECRET. Only used if
alKey e>
MasterKeyConfigurationScreen.Ke
yConfigType is Local Key.
224
Trend Micro Deep Security On-Premise 20
SecurityUpdateScreen
Possible Default
Property Notes
Values Value
True will tell the Deep
Security Manager to create
l True a scheduled task to
SecurityUpdateScreen.UpdateComponents True automatically check for
l False security updates. The
scheduled task will run
when installation is
complete.
True will cause Deep
l True Security Manager to use a
SecurityUpdateScreen.Proxy False proxy to connect to the
l False Internet to download
security updates from
Trend Micro.
l HTTP
SecurityUpdateScreen.ProxyType l SOCKS4 <none> The protocol used by the
proxy.
l SOCKS5
<valid IPv4 or
SecurityUpdateScreen.ProxyAddress IPv6 address <none> None
or hostname>
See "Port numbers, URLs,
SecurityUpdateScreen.ProxyPort <proxy port> <none> and IP addresses" on
page 178.
l True True indicates that the
SecurityUpdateScreen.ProxyAuthentication False proxy requires
l False
authentication credentials.
SecurityUpdateScreen.ProxyUsername <string> <none> None
SecurityUpdateScreen.ProxyPassword <string> <none> None
SoftwareUpdateScreen
Possible Default
Property Notes
Values Value
True will tell Deep
Security Manager to
l True create a scheduled task to
SoftwareUpdateScreen.UpdateSoftware True automatically check for
l False software updates. The
scheduled task will run
when installation is
complete.
225
Trend Micro Deep Security On-Premise 20
Possible Default
Property Notes
Values Value
True will cause Deep
l True Security Manager to use a
SoftwareUpdateScreen.Proxy False proxy to connect to the
l False Internet to download
software updates from
Trend Micro.
l HTTP
SoftwareUpdateScreen.ProxyType l SOCKS4 <none> The protocol used by the
proxy.
l SOCKS5
<valid IPv4 or
SoftwareUpdateScreen.ProxyAddress IPv6 address <none> None.
or hostname>
See "Port numbers, URLs,
SoftwareUpdateScreen.ProxyPort <integer> <none> and IP addresses" on
page 178.
l True True indicates that the
SoftwareUpdateScreen.ProxyAuthentication False proxy requires
l False
authentication credentials.
SoftwareUpdateScreen.ProxyUsername <string> <none> None
SoftwareUpdateScreen.ProxyPassword <string> <none> None
SmartProtectionNetworkScreen
This screen defines whether you want to enable Trend Micro Smart Feedback and optionally
your industry.
Defaul
Property Possible Values Notes
t Value
True
l True enables
SmartProtectionNetworkScreen.EnableFeedbac
False Trend
k l False Micro
Smart
Feedback.
l Not specified If a value
is not
l Banking entered, it
SmartProtectionNetworkScreen.IndustryType l Communications <none> has the
same
and media
result as
l Education Not
226
Trend Micro Deep Security On-Premise 20
Defaul
Property Possible Values Notes
t Value
l Energy
l Fast-moving
consumer goods
(FMCG)
l Financial
l Food and beverage
l Government
l Healthcare
l Insurance
l Manufacturing
l Materials specifie
d.
l Media
l Oil and gas
l Real estate
l Retail
l Technology
l Telecommunication
s
l Transportation
l Utilities
l Other
RelayScreen
This screen defines whether you want to install the Deep Security Relay on the same computer
as Deep Security Manager.
Possible Default
Property Notes
Values Value
True installs the Deep Security Relay on the Deep
l True Security Manager computer.
RelayScreen.Install False
l False False does not install the Deep Security Relay on the
Deep Security Manager (silent install), or shows a
227
Trend Micro Deep Security On-Premise 20
Possible Default
Property Notes
Values Value
screen asking you whether you want to install the relay
(regular install).
Sample properties file
This is an example of the content of a typical properties file:
AddressAndPortsScreen.ManagerAddress=10.xxx.xxx.xxx
AddressAndPortsScreen.NewNode=True
UpgradeVerificationScreen.Overwrite=False
LicenseScreen.License.-1=XY-ABCD-ABCDE-ABCDE-ABCDE-ABCDE-ABCDE
DatabaseScreen.DatabaseType=Microsoft SQL Server
DatabaseScreen.Hostname=10.xxx.xxx.xxx
DatabaseScreen.Transport=TCP
DatabaseScreen.DatabaseName=XE
DatabaseScreen.Username=DSM
DatabaseScreen.Password=xxxxxxx
AddressAndPortsScreen.ManagerPort=4119
AddressAndPortsScreen.HeartbeatPort=4120
CredentialsScreen.Administrator.Username=masteradmin
CredentialsScreen.Administrator.Password=xxxxxxxx
CredentialsScreen.UseStrongPasswords=False
SecurityUpdateScreen.UpdateComponents=True
SecurityUpdateScreen.Proxy=False
SecurityUpdateScreen.ProxyType=""
SecurityUpdateScreen.ProxyAddress=""
SecurityUpdateScreen.ProxyPort=""
SecurityUpdateScreen.ProxyAuthentication="False"
SecurityUpdateScreen.ProxyUsername=""
SecurityUpdateScreen.ProxyPassword=""
SoftwareUpdateScreen.UpdateSoftware=True
SoftwareUpdateScreen.Proxy=False
SoftwareUpdateScreen.ProxyType=""
SoftwareUpdateScreen.ProxyAddress=""
SoftwareUpdateScreen.ProxyPort=""
SoftwareUpdateScreen.ProxyAuthentication="False"
SoftwareUpdateScreen.ProxyUsername=""
SoftwareUpdateScreen.ProxyPassword=""
SoftwareUpdateScreen.ProxyAuthentication="False"
228
Trend Micro Deep Security On-Premise 20
RelayScreen.Install=True
SmartProtectionNetworkScreen.EnableFeedback=False
Add activation codes
If you're using bring-your-own license (BYOL) billing, you must enter one or more activation
codes into the manager if you didn't supply them during the installation. If you're using metered
billing, there is no need to enter activation codes because they're not used.
Note: An activation code is also known as a license.
To enter your activation code or codes:
1. Log in to Deep Security Manager.
2. At the top, click Administration.
3. On the left, click Licenses.
4. In the main pane, click Enter New Activation Code.
5. Enter the activation code or codes you obtained from your sales representative.
6. Click Next and close the wizard when you have finished.
Set up multi-tenancy
Set up a multi-tenant environment
The multi-tenancy feature in Deep Security lets you create separate management environments
within a single Deep Security Manager. It allows tenants to each have their own settings and
policies and to monitor their own events. This can be useful if you want to create separate
staging and production environments or if you need to create separate environments for different
business units in your organization. You can also use multi-tenancy to provision Deep Security
to customers in a service model.
Once you enable multi-tenancy, you (as the "primary tenant") retain all of the capabilities of a
regular installation of Deep Security Manager. However, the tenants you subsequently create
can have their access to Deep Security functionality restricted to varying degrees, based on how
you configure the system for them.
Note: FIPS mode is not supported in a multi-tenant environment, See "FIPS 140-2 support" on
page 1417.
229
Trend Micro Deep Security On-Premise 20
In this topic:
l "Multi-tenancy requirements" below
l "Enable multi-tenancy" on the next page
l "Create a tenant" on the next page
l "Scalability guidelines" on page 234
l "Multi-tenancy tips" on page 234
l "Managing tenants" on page 235
l "Set up a multi-tenant environment" on the previous page
l "Usage monitoring" on page 239
l "Configure database user accounts" on page 241
l "APIs" on page 250
l "Upgrade a multi-tenant environment" on page 251
l "Supporting tenants" on page 252
l "Multi-tenancy with Deep Security Virtual Appliance" on page 252
Multi-tenancy requirements
You cannot set up multi-tenancy with:
l Deep Security Manager VM for Azure Marketplace
l Deep Security as a Service
l Azure SQL Database
Multi-tenancy requires an activation code. Multi-tenancy also has additional database
requirements. For details, see "Database requirements" on page 203 and "Configure database
user accounts" on page 241.
To maximize scalability, we recommend that you use a multi-node Deep Security Manager (see
"Install Deep Security Manager on multiple nodes" on page 257). All manager nodes process
GUI, heartbeat, or job requests for any tenant. For background processing, each tenant is
assigned a manager node that takes care of job queuing, maintenance, and other background
tasks. Tasks are rebalanced across remaining nodes when manager nodes are added or taken
offline.
When you enable multi-tenancy, your current installation of Deep Security Manager becomes
the primary tenant (t0) and has special privileges, including the ability to create other tenants.
230
Trend Micro Deep Security On-Premise 20
Other tenants are restricted from using certain features and don't have permissions to see the UI
for those features in Deep Security Manager. For example, non-primary tenants cannot create
other tenants. For details, see "Set up a multi-tenant environment" on page 229
Enable multi-tenancy
Note: Once you enable multi-tenancy, you cannot disable it or remove the primary tenant.
1. In the Deep Security Manager, go to Administration > System Settings > Advanced. In the
Multi-Tenant Options area, click Enable Multi-Tenancy.
2. The Multi-Tenant Configuration wizard appears. Enter your multi-tenancy activation code
and click Next.
3. Choose the license mode that you want to use:
l Inherit Licensing from Primary Tenant: This option gives all tenants the same
licenses that you (the primary tenant) have. This option is recommended if you are
using multi-tenancy in a staging environment, or if you intend to set up tenancies for
separate departments within your organization.
l Per Tenant Licensing: This option is recommended if you are offering Deep Security
as a service. With this configuration, you can use the Deep Security API to provide a
license when you create a tenant, or the tenant can enter a license when they sign in
to the Deep Security Manager for the first time.
4. Click Next.
When the wizard closes, you’ll be able to see Administration > System Settings >
Tenants, where you can configure multi-tenancy options. For information about the options
on that page, click Help in the upper-right corner of Deep Security Manager.
Create a tenant
Tip: You can automate tenant creation and configuration using the Deep Security API. For
examples, see the Create and Manage Tenants guide in the Deep Security Automation
Center.
Once multi-tenant mode is enabled, tenants can be managed from Administration > Tenants.
For information about the database user account permissions that are required for adding
tenants, see "Configure database user accounts" on page 241.
231
Trend Micro Deep Security On-Premise 20
1. In the Deep Security Manager, go to Administration > Tenants and click New.
2. The New Tenant wizard appears. Enter a Tenant Account Name. The account name can
be anything except "Primary", which is reserved for the primary tenant.
3. Enter the email address that is used to contact the tenant.
4. Select the Locale. The locale determines the language of the Deep Security Manager user
interface for the tenant.
5. Select a Time Zone. Times for events are shown relative to this time zone, not the time
zone on the system where the event happened.
6. If your Deep Security installation uses more than one database, select whether to let Deep
Security automatically select a database server on which to store the new tenant account
("Automatic -- No Preference") or to use a particular server.
Database servers that are not accepting new tenants do not appear in the list.
7. Enter a user name for the first user of the new tenant account.
8. Select one of the three password options:
l No Email: The tenant’s first user's user name and password are defined here and no
emails are sent.
l Email Confirmation Link: You set the tenant’s first user's password. However, the
account is not active until the user clicks a link in the confirmation email. The email
confirmation ensures that the email provided belongs to the user before they can
access the account.
l Email Generated Password: This allows you to generate a tenant without specifying
the password.
Tip:
All three options are available via the API. The email confirmation option is suitable for
developing public registration. A CAPTCHA is recommended to ensure that the tenant
creator is a human not an automated bot.
9. Click Next to finish with the wizard and create the tenant.
Tenant creation can take up to four minutes due to the creation of the schema and the population
of the initial data. This ensures each new tenant has the most up-to-date configuration and
removes the burden of managing database templates, especially between multiple database
servers.
232
Trend Micro Deep Security On-Premise 20
Each tenant database has an overhead of around 100 MB of disk space (due to the initial rules,
policies and events that populate the system).
Examples of messages sent to tenants
Email Confirmation Link: Account Confirmation Request
Welcome to Deep Security! To begin using your account, click the following
confirmation URL. You can then access the console using your chosen
password.
Account Name: ExampleCorp
User name: admin
Click the following URL to activate your account:
https://managerIP:portnumber/SignIn.screen?confirmation=1A16EC7A-D84F-
D451-05F6-706095B6F646&tenantAccount=ExampleCorp&username=admin
Email Generated Password
First email : Account and Username Notification
Welcome to Deep Security! A new account has been created for you. Your
password will be generated and provided in a separate email.
Account Name: ExampleCorp
Username: admin
You can access Deep Security using the following URL:
https://managerIP:portnumber/SignIn.screen?tenantAccount=ExampleCorp&usern
ame=admin
Second email: Password Notification
This is the automatically generated password for your Deep Security
account. Your Account Name, Username, and a link to access Deep Security
will follow in a separate email.
Password: z3IgRUQ0jaFi
233
Trend Micro Deep Security On-Premise 20
Scalability guidelines
Deployments of 50-100 tenants or more should follow these guidelines to avoid scalability
issues:
l Create a maximum of 2000 tenants for a set of Deep Security Manager nodes
l Create a maximum of 300 tenants on a single database server
l Use a separate database server for the primary tenant, with no other tenants
l Limit the number of agents per tenant to 3000
l Limit the number of total agents to 20000
l Use a maximum of 2 Deep Security Manager nodes
l Do not use any co-located relays
Multi-tenancy relies on using multiple databases (if you are using Microsoft SQL) or multiple
users (if you are using Oracle). To scale further, you can connect Deep Security Manager to
multiple database servers and automatically distribute the new tenants across the available set
of database servers. See "Configure database user accounts" on page 241.
Multi-tenancy tips
Reconnaissance IP list
In a multi-tenant environment, tenants may need to add the Deep Security Manager IP address
to the "Ignore Reconnaissance IP" list found in Policies > Common Objects > Lists > IP Lists.
This is to avoid getting a "Reconnaissance Detected: Network or Port Scan" warning.
Use multiple database servers
Multi-tenancy relies on using multiple databases (if you are using Microsoft SQL) or multiple
users (if you are using Oracle). To scale further, you can connect Deep Security Manager to
multiple database servers and automatically distribute the new tenants across the available set
of database servers. See "Configure database user accounts" on page 241.
Tenant pending deletion state
Tenants can be deleted, but the process is not immediate. Before it deletes records, Deep
Security requires that all its tenant-related jobs are finished. The least frequent job runs every
week, so tenants may remain in the "pending deletion" state for up to approximately 7 days.
234
Trend Micro Deep Security On-Premise 20
Multi-tenant options under System Settings
Consider these options on Administration > System Settings > Tenants:
Allow Tenants to use the Relays in my "Default Relay Group" (for unassigned Relays): Gives
tenants automatic access to relay-enabled agents set up in the primary tenant. This saves
tenants the effort of setting up dedicated relay-enabled agents for security updates.
Allow Tenants to use the "Run Script" Scheduled task: Scripts present a potentially dangerous
level of access to the system; however, the risk can be mitigated because scripts have to be
installed on the Deep Security Manager using file-system access.
Managing tenants
Administration > Tenants displays the list of all tenants. A tenant can be in any of these States:
l Created: Created, but activation email has not been sent to the tenant user.
l Confirmation Required: Created, but the activation link in the confirmation email sent to
the tenant user has not been clicked. (You can manually override this state.)
l Active: Fully online and managed.
l Suspended: No longer accepting sign-ins.
l Pending Deletion: Tenants can be deleted, but it is not immediate. The tenant may be in
the "pending deletion" state for up to 7 days, until pending jobs finish.
l Database Upgrade Failed: For tenants that failed the upgrade path. The Database
Upgrade button can be used to resolve this situation.
Tenant Properties
Double-click on a tenant to view the tenant's Properties window.
General
You can change the locale, time zone and state. Changes do not affect existing tenant users
(only new ones, and parts of the UI that are not user-specific).
The Database Name indicates the name of the database used by this tenancy. You can access
the tenant database's properties via the hyperlink.
235
Trend Micro Deep Security On-Premise 20
Modules
The Modules tab provides options for protection module visibility. The selected visibility can be
used to tune which modules are visible for which tenants. By default all unlicensed modules are
hidden. You can change this by deselecting Always Hide Unlicensed Modules. Alternatively,
selected modules can be shown on a per-tenant basis.
By default, if you use "per tenant" licensing, each tenant only sees their licensed modules.
If you select Inherit License from Primary Tenant, then all tenants can see all features that you
(the primary tenant) are licensed for.
Note: If you select this option, then all of the primary tenant's unlicensed modules are hiddden
for other tenants, even if you deselect their option Always Hide Unlicensed Modules.
If you are evaluating Deep Security in a test environment and want to see what a full multi-
tenancy installation looks like, you can enable "Multi-Tenancy Demo Mode". When in Demo
Mode, the manager populates its database with simulated tenants, computers, events, alerts,
and other data. Initially, 7 days' worth of data is generated but new data is generated on an
ongoing basis to keep the manager's dashboard, reports and events pages populated with data.
Warning: Do not use Demo Mode in a production environment. Demonstration data will be
mixed with real data, which can make it difficult to determine if there are real attacks or
malware.
Features
As an Administrator, you can enable or disable certain features for specific tenants. These
available features may change over time.
If you enable Extended Descriptions for Event Forwarding, Deep Security includes the full
description of events that are forwarded to Amazon SNS or a SIEM. Otherwise, descriptions are
omitted. SAML Identity Provider Integration, Amazon WorkSpaces Integration, Application
(Application Control), and API Rate Limits (in the Automation Center) are enabled by default.
Statistics
The Statistics tab shows information for the current tenant including database size, jobs
processed, logins, security events and system events. The spark line show the last 24 hours at a
glance.
236
Trend Micro Deep Security On-Premise 20
Agent Activation
The Agent Activation tab displays a command that you can run to activate the agent on the
computer. The command is relative to the agent install directory of this tenant's computers.
Activation is required so that Deep Security Manager can securely connect with it, and the tenant
can assign policies and perform other configuration procedures from the Deep Security
Manager.
What does the tenant see?
When multi-tenancy is enabled, the sign-in page has an additional Account Name text field.
Tenants are required to enter their account name in addition to their user name and password.
The account name allows tenants to have overlapping user names. For example, if multiple
tenants synchronize with the same Active Directory server.
Note: When you (as the primary tenant) log in, leave the account name blank or use "Primary".
Some features in the Deep Security Manager UI are not available to tenant users. These areas
are hidden for tenants:
l Manager Nodes Widget
l Multi-Tenant Widgets
l Administration > System Information
l Administration > Licenses (If Inherit option selected)
l Administration > Manager Nodes
l Administration > Tenants
l Administration > System Settings:
l Tenant Tab
l Security Tab > Sign In Message
l Updates Tab > Setting for Allowing Tenants to use Relays from the Primary Tenant
l Advanced Tab > Load Balancers
l Advanced Tab > Pluggable Section
l Some of the help content not applicable to tenants
l Some reports not applicable to tenants
237
Trend Micro Deep Security On-Premise 20
l Other features based on the multi-tenant options
l Some alert types are also be hidden from tenants:
l Heartbeat Server Failed
l Low Disk Space
l Manager Offline
l Manager Time Out Of Sync
l Newer Version of Deep Security Manager available
l Number of Computers Exceeds Database Limit
l And when inherited licensing is enabled any of the license-related alerts
It is also important to note that tenants cannot see any of the multi-tenant features of the primary
tenant or any data from any other tenant. In addition, certain APIs are restricted since they are
only usable with primary tenant rights (such as creating other tenants).
For more information on what is and is not available to tenant users, see "Multi-tenant settings"
on page 253.
All tenants have the ability to use role-based access control (RBAC) with multiple user accounts
to further sub-divide access. Additionally, they can use Active Directory integration for users to
delegate the authentication to the domain. The Tenant Account Name is still required for any
tenant authentications.
Agent-Initiated Activation
Agent-initiated activation is enabled by default for all tenants.
Note: Unlike agent-initiated activation for the primary tenant, a password and tenant ID are
required to invoke the activation for other tenant users.
Tenants can see the arguments required for agent-initiated activation by going to Administration
> Updates > Software > Local, selecting the agent software, and then clicking Generate
Deployment Scripts. For example, the script for Agent-Initiated Activation on a Windows
machine might look like this:
dsa_control -a dsm://<host or IP>:4120/ "tenantID:XXXXXXXX-XXXX-XXXX-XXXX-
XXXXXXXXXXXX" "token:XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
238
Trend Micro Deep Security On-Premise 20
Tenant diagnostics
Tenants are not able to access manager diagnostic packages due to the sensitivity of the data
contained within the packages. Tenants can still generate agent diagnostics by opening the
computer editor, going to Actions > Overview, and then selecting Agent Diagnostics.
Usage monitoring
Deep Security Manager records data about tenant usage. To view it, go to the dashboard's
Tenant Protection Activity widget, the Tenant Properties window's Statistics tab, and reports.
This information can also be accessed through the legacy REST API's status monitoring, which
can be enabled or disabled by going to Administration > System Settings > Advanced > Status
Monitoring API.
Use the legacy REST API's status monitoring to customize the type of tenant information that
you would like to see, depending on your environment. For enterprises, this can be useful to
determine the usage by each business unit. You can also use the information to monitor the
usage of the overall Deep Security system and look for indicators of abnormal activity. For
example, if a single tenant experiences a spike in security event activity, it might be under attack.
Multi-tenant Dashboard
When multi-tenancy is enabled, primary tenant users have access to the following additional
Dashboard widgets for monitoring tenant activity:
l Tenant Database Usage
l Tenant Job Activity
l Tenant Protection Activity
l Tenant Security Event Activity
l Tenant Sign-In Activity
l Tenant System Event Activity
l Tenants
The same information is available on Administration > Tenants (some in optional columns) and
on the Statistics tab of a tenant's Properties window.
This information provides the ability to monitor the usage of the overall system and look for
indicators of abnormal activity. For example, if a single tenant experiences a spike in security
event activity, they might be under attack.
239
Trend Micro Deep Security On-Premise 20
Multi-tenant reports
To generate reports that contain the information you require, go to Event & Reports > Generate
Reports and choose the report you'd like to generate from the drop-down menu. The following
are reports for multi-tenant environments, and the information they include:
Security Module Usage Cumulative Report
l Tenant
l Hostname
l ID
l Anti-Malware hours
l Network hours
l System hours
l SAP hours
l Enterprise hours
Security Module Usage Report
l Tenant
l ID
l Hostname
l Display name
l Computer group
l Instance type
l Start date
l Start time
l Stop time
l Duration (seconds)
l Anti-malware
l Web Reputation
l Firewall
l Intrusion prevention
240
Trend Micro Deep Security On-Premise 20
l Integrity monitoring
l Log Inspection
l Application Control
l SAP
Tenant Report
l Tenant name
l Database size
l Peak host count
l Protection hours
l Percentage of protected hours
Configure database user accounts
The majority of each tenant's data is stored in a separate database. This database can co-exist
on the same database server as other tenants, or it can be isolated onto its own database server.
In all cases, some data only exists in the primary database (the one installed with Deep Security
Manager). When multiple database servers are available, tenants are created on the database
with the least amount of load.
The segmentation of each tenant's data into a database provides additional benefits:
l Data destruction: Deleting a tenant removes all traces of that tenant's data (supported in
the product).
l Backup: Each tenant's data can be subject to different backup policies. This can be useful
for something like tenancy being used for staging and production where the staging
environment requires less stringent backups (backups are the responsibility of the
administrator setting up Deep Security Manager).
l Balancing: The potential for future re-balancing to maintain an even load on all database
servers.
Configuring database user accounts
Note:
Microsoft SQL Server, Oracle, and PostgreSQL use different terms for database concepts
described below.
241
Trend Micro Deep Security On-Premise 20
Concept SQL Server term Oracle term PostgreSQL term
Process where multiple tenants Database Database
Database
execute Server Server
One tenant's set of data Database Tablespace/User Database
The following section uses the Microsoft SQL Server terms for both SQL Server and Oracle.
SQL Server
Tip: Use a short name for the main database name to make it easier to read your tenants'
database names. Deep Security derives tenants' database names from the main (primary
tenant)'s SQL database name. For example, if the main database is named "dsm", then the first
tenant's database is "dsm_1", the second tenant's database name is "dsm_2", and so on.
Multi-tenancy requires that Deep Security can create databases when you create new tenants,
so its SQL Server database user requires the "dbcreator" role.
242
Trend Micro Deep Security On-Premise 20
For the user role of the primary tenant, assign DB owner to the main database.
243
Trend Micro Deep Security On-Premise 20
You can restrict the rights to include only the ability to modify the schema and access the data.
244
Trend Micro Deep Security On-Premise 20
With the "dbcreator" role, databases that the account creates are automatically owned by the
same user. For example, here are the user's properties after the first tenant has been created:
245
Trend Micro Deep Security On-Premise 20
To create the first account on a secondary database server, only the "dbcreator" server role is
required. No user mapping is required.
Oracle
Multi-tenancy in Oracle is similar to Microsoft SQL Server, but with a few important differences.
Where SQL Server has a single user account per database server, Oracle uses one user
account per tenant. The user that Deep Security was installed with maps to the primary tenant.
That user can be granted permission to allocate additional users and tablespaces.
246
Trend Micro Deep Security On-Premise 20
Note: Although Oracle allows special characters in database object names if they are
surrounded by quotes, Deep Security does not support special characters in database object
names. This page on Oracle's web site describes the allowed characters in non-quoted
names: https://docs.oracle.com/cd/B28359_01/server.111/b28286/sql_
elements008.htm#SQLRF00223#SQLRF00223
Tip: Use a short name for the main database name to make it easier to read your tenants'
database names. Deep Security derives tenants' database names from the main (primary
tenant)'s Oracle database name. For example, if the main database is named "MAINDB", then
the first tenant's database is "MAINDB_1", the second tenant's database name is "MAINDB_
2", and so on.
If multi-tenancy is enabled, you must assign these Oracle permissions:
247
Trend Micro Deep Security On-Premise 20
Tenants are created as users with long random passwords and given these permissions:
248
Trend Micro Deep Security On-Premise 20
For secondary Oracle servers, you must create the first user account (a bootstrap user account).
This user has a mostly tablespace. The configuration is identical to the primary user account.
PostgreSQL
The user must have permissions to create new databases and roles:
ALTER ROLE [username] CREATEDB CREATEROLE;
On a secondary database server, the hostname, username, and password are required. The
username must have privileges to create additional users (roles) and databases.
Tip: Use a short name for the main database name to make it easier to read your tenants'
database names. Deep Security derives tenants' database names from the main (primary
tenant)'s PostgreSQL database name. For example, if the main database is named "dsm", then
249
Trend Micro Deep Security On-Premise 20
the first tenant's database is "dsm_1", the second tenant's database name is "dsm_2", and so
on.
Configuring multiple database servers
By default, all tenants are created on the same database server that Deep Security Manager was
installed with. In order to provide additional scalability, Deep Security Manager supports adding
additional database servers (sometimes referred to as a secondary database). When you add a
tenant, you have the option to let Deep Security automatically select a database server on which
to store the new tenant account or you can specify a particular server.
To configure more databases, go to Administration > System Settings > Tenants. In the
Database Servers section, click View Database Servers, and then click New .
For Microsoft SQL Server, the secondary database server requires a hostname, user name, and
password (named instance and domain). The Deep Security Manager's database user must
have these permissions:
l Create databases
l Delete databases
l Define schema
This account is used not only to create the database but to authenticate to the databases that are
created.
For Oracle, multi-tenant deployments use a different model. The new database definition defines
a user that is bound to a tablespace. That user is used to "bootstrap" the creation of additional
users on Oracle.
Removing or changing secondary databases
You can delete database servers (other than the primary database) if there are no tenants on the
server.
If the hostname, user name, password or any details change for a secondary server, you can
change these values in the Deep Security Manager console. To change values for the primary
database, you must shut down all nodes of the Deep Security Manager and edit the
dsm.properties file with the new details.
APIs
Deep Security Manager includes a number of APIs for:
250
Trend Micro Deep Security On-Premise 20
1. Enabling Multi-Tenancy
2. Managing Tenants
3. Accessing Monitoring Data
4. Accessing Chargeback (Protection Activity) Data
5. Managing Secondary Database Servers
In addition, the legacy SOAP API includes an authenticate method that accepts the Tenant
Account Name as a third parameter.
For more information on the APIs, see "Use the Deep Security API to automate tasks" on
page 1376.
Upgrade a multi-tenant environment
1. Back up all databases:
l With Microsoft SQL and PostgreSQL, there's one main database and an additional
database for each tenant.
l With Oracle, all tenant information is in one manager database, but an additional user
is created for each tenant. Each user has its own tables.
2. Upgrade the manager.
3. The installer does the following:
l shuts down other manager nodes, if they exist, and then starts to upgrade
l updates the database schema
l migrates data into the new structures for the primary tenant (t0)
l migrates data for other tenants (five in each batch)
4. After the manager has been fully upgraded including all tenants, upgrade the next
manager node, if it exists. See "Upgrade a multi-tenant environment" above for details.
Notes:
l If the t0 migration fails, the installer can't recover. It does not continue. You must restore the
database from backup, and then try again.
l If any non-primary tenant's migration fails, the installer continues, but each tenant's state on
Administration > Tenants is set to Database Upgrade Required (offline). You can either
restore from backup and run the installer again, or you can retry migration for that specific
tenant.
l To retry a tenant's migration, use the tenant's interface. If forcing a retry does not work,
please contact your support provider
251
Trend Micro Deep Security On-Premise 20
Supporting tenants
Especially if you are an MSSP that is the first tier support provider to your tenants, sometimes a
primary tenant might need to log in to another tenant's user interface.
To do this, go to Administration > Tenants. Right-click the tenant's name, and then select
Authenticate As. (The option may not be available if the tenant has disabled access.) This
creates a temporary user account with the "Full Access" role inside that tenant, and immediately
logs you into that account. Temporary account names are "support_" followed by their username
inside the primary tenant.
For example, if your primary tenant username is "jdoe", and you create a temporary account
inside tenant "T1", then you would be immediately logged into "T1" as "support_jdoe".
Temporary support accounts are deleted when either they log out or their session times out.
Tenants can see system events about the temporary support account's creation, log in, log out,
and deletion.
Users in the primary tenant can access more diagnostic tools and information:
1. Administration > System Information has more information about tenant memory usage
and the state of threads.
2. server#.log log files (such as server0.log) on each manager node's disks have the
name of the tenant, and the user if applicable, associated with each event.
In some cases, you may need to perform an action or change a tenant's setting that is not
available in the GUI. This usually comes at the request of Trend Micro support. In the command
line, add the argument:
-tenantname <tenant-name>
to apply setting changes or actions to that tenant. If the argument is omitted, the command
applies to the primary tenant.
Multi-tenancy with Deep Security Virtual Appliance
If Deep Security is being deployed in a VMware environment, you can configure the vCenter and
its connector in the primary tenant and the vCloud connector in tenants. If this is configured
properly, the primary tenant sees the ESXi servers, Deep Security Virtual Appliances, and other
infrastructure while tenants only see the agentlessly protected VMs that belong to them in the
vCloud environment.
252
Trend Micro Deep Security On-Premise 20
To enable this type of environment, go to Administration > System Settings > Agents and select
Allow Appliance protection of vCloud VMs.
For more information on vCloud integration, see "Install the agent on VMware vCloud" on
page 291.
Multi-tenant settings
The Tenants tab appears only if you have enabled multi-tenant mode.
l Multi-Tenant License Mode: The multi-tenant license mode can be changed after multi-
tenant is setup, however it is important to note that switching from inherited to per-tenant
will cause existing tenants to no longer have any licensed module.
l Allow Tenants to use the "Run Script" Scheduled Task: Scripts present a potentially
dangerous level of access to the system, however the risk can be mitigated because
scripts have to be installed on the Manager using file-system access.
l Allow Tenants to run "Computer Discovery" (directly and as a Scheduled Task):
Determines if discovery is allowed. This may not be desirable in service provider
environments where network discovery has been prohibited.
l Allow Tenants to run "Port Scan" (directly and as a Scheduled Task): Determines if port
scans can be executed. This may not be desirable in service provider environments where
network scan has been prohibited.
l Allow Tenants to add VMware vCenters: Determines for each tenant if vCenter
connectivity should be allowed. If the deployment occurs via an unsecured or public
network such as the Internet, usually this option should be disabled.
l Allow Tenants to add with Cloud Accounts: Determines if tenants can setup cloud sync.
This is generally applicable to any deployment.
l Allow Tenants to synchronize with LDAP Directories: Determines if tenants can setup
both User and Computer sync with Directories (LDAP or Active Directory for Computers,
Active Directory only for users). If deployment occurs via an unsecured or public network
such as the Internet, usually this option should be disabled.
l Allow Tenants to configure independent Event Forwarding SIEM settings: Displays the
SIEM settings on the Event Forwarding tab.
l Allow Tenants to configure SNS settings: Displays the SNS settings on the Event
Forwarding tab.
l Allow Tenants to configure SNMP settings: Allow tenants to forward System Events to a
remote computer (via SNMP). If this option is not selected, all tenants use the settings
253
Trend Micro Deep Security On-Premise 20
located on the Event Forwarding tab for all event types and syslogs are relayed via the
Deep Security Manager.
l Show the "Forgot Password?" option: Displays a link on the sign in screen which Users
can access to reset their password. SMTP settings must be properly configured on the
Administration > System Settings > SMTP tab for this option to work.
l Show the "Remember Account Name and Username" option: Deep Security will
remember the User's Account Name and Username and populate these fields when the
sign in screen loads.
l Allow Tenants to control access from the Primary Tenant: By default, the primary tenant
can sign in to a tenant's account by using the Sign In As Tenant option on the
Administration > Tenants page. When the Allow Tenants to control access from Primary
Tenant option is selected, tenants are given the option (under Administration > System
Settings > Advanced in their ) to allow or prevent access by primary tenant to their Deep
Security environment. (When this option is enabled, the default setting in the tenant's
environment is to prevent access by the primary tenant.)
Note: Whenever the primary tenant accesses a tenant's account, the access is recorded
in the tenant's System Events.
l Allow Tenants to use Primary Tenant's Trend Micro Apex Central and Deep Discovery
Analyzer Server settings: Enables the primary tenant to share their Connected Threat
Defense settings with tenants. For details, see "Detect emerging threats using Connected
Threat Defense" on page 580.
l Allow Tenants to use the Relays in my "Default Relay Group": gives tenants automatic
access to relays setup in the primary tenant. This saves tenants from having to setup
dedicated Relays for Security Updates.
Note: Tenants can reject the usage of "shared" relays by going to the Updates tab on
the Administration > System Settings and deselecting Use the Primary Tenant Relay
Group as my Default Relay Group (for unassigned Relays). Then they must set up
relays for themselves.
Note: When relays are shared, the primary tenant must keep the relays up-to-date. To
ensure this, you can create Download Security Update scheduled tasks for all relays at a
regular intervals.
254
Trend Micro Deep Security On-Premise 20
l Enable the automatic download of Security Updates on new Tenants: As soon as you
create a new tenant account, it will check for and download the latest available security
updates.
l Lock and hide the following options (all Tenants will use the Primary Tenant's
configurations):
l Data Privacy options on the "Agents" Tab:Allows the primary tenant to configure data
privacy settings. (This setting only applies to "Allow Packet Data Capture on
Encrypted Traffic (SSL)" in on the Administration > System Settings > Agents tab.)
l All options on the "SMTP" Tab: Locks all settings on the SMTP tab.
l All options on the "Storage" Tab:Locks all settings on the Storage tab.
Database servers
By default, all tenants will be created on the same database server that Deep Security Manager
was installed with. In order to provide additional scalability, Deep Security Manager supports
adding additional database servers. For details, see "Set up a multi-tenant environment" on
page 229.
New tenant template
Using a tenant template, you can conveniently create a customized "out-of-the-box" experience
for new tenants. This feature can be useful in service provider (MSSP) environments where
some of the examples are not applicable, or special examples need to be created.
Note: Existing tenants are not affected when you create a new template.
1. Log in as the primary tenant.
2. Create a new tenant.
3. Log out, then log in as the new tenant.
4. Customize the example policies (such as adding, removing, or modifying policies) and/or
the security update version (such as applying newer versions).
Tenants should use the example policies as a starting point, and then customize to match
their unique needs.
255
Trend Micro Deep Security On-Premise 20
Note: Security update packages must have a valid digital signature. If you specify an
invalid security update, new tenant creation will fail. See also "About upgrades" on
page 1277.
5. Log out, then log in again as the primary tenant.
6. Run the tenant template wizard.
7. Select the tenant to create a snapshot.
Templates include:
l Latest Security Update rules (Updates that have been applied to the template when
created. This includes intrusion prevention rules provided by Trend Micro, change
monitoring rules, security log monitoring rules)
l Policy Firewall rules
l IP list
l MAC list
l Directory listing
l File list
l File extension list
l Port list
l Contexts
l Schedule
l Firewall Stateful Configuration
l Malware scan settings
Templates exclude:
l Custom Intrusion Prevention rules
l Custom Application Types
l Custom Integrity Monitoring rules
l Custom Log Inspection rules
l Custom Log Inspection Decoders
l Dashboard
l Alert settings
l System settings
256
Trend Micro Deep Security On-Premise 20
l Scheduled tasks
l Event-based tasks
l Users
l Roles
l Contact information
Protection usage monitoring
Deep Security collects information about protected computers. This information is visible on the
dashboard in the tenants widget and the Tenant Protection Activity widget. The information is
also provide in the Tenant report and is available via the legacy REST API.
Note: In the most basic case, the monitoring can help determine the percentage usage of
Deep Security Manager by hours of protection through the report or the API. Commonly called
viewback or chargeback this information can be used in a variety of ways. In more advanced
cases, this can be used for custom billing based on characteristics like tenant computer
operating systems.
Use these options determine which additional tenant computer details are recorded.
Set up multiple nodes
Install Deep Security Manager on multiple nodes
Instead of running Deep Security Manager on one server, you can install Deep Security
Manager on multiple servers ("nodes") and connect them to one shared database. This provides
better:
l Reliability
l Availability
l Scalability
l Performance
You can log in to any node. Each node can do all types of tasks. No node is more important than
any of the others. A node failure does not cause service downtime, and does not result in data
loss. Deep Security Manager processes many concurrent activities in a distributed pool that all
online nodes execute. All activity that does not happen due to user input is packaged as a job,
257
Trend Micro Deep Security On-Premise 20
and runs on any available manager (with some exceptions for "local" jobs that are executed on
each node, like cache clearing).
Each node must run the same Deep Security Manager software version. When you upgrade,
the first manager you upgrade will temporarily take over all duties and shut down the other
nodes. On Administration > Manager Nodes, other nodes' status will be "Offline" with an
indication that an upgrade is required. Once upgraded, nodes will automatically return online
and begin processing again.
Set up a load balancer
If you are deploying multiple server nodes of Deep Security Manager for a large scale
deployment, a load balancer can help distribute connections with agents and appliances. Load
balancers with virtual IPs can also provide a single inbound port number such as TCP 443,
instead of the multiple port numbers that Deep Security normally requires.
Balance load based upon TCP connections; do not use SSL termination. This ensures that an
entire connection occurs with the same manager node. The next connection may be distributed
to a different node.
For more Deep Security Manager deployment recommendations, see the "Deep Security Best
Practice Guide" on page 1557.
Configure the load balancer in Deep Security
By default, a multi-node manager gives the address of all nodes to all agents and virtual
appliances. The agents and virtual appliances randomly select a node from the list when they try
to connect. If they cannot, then they try another node on the list, continuing this process until
either a connection succeeds, or no nodes can be reached. If they can't reach any node, then
they wait until the next heartbeat to try again.
Each time a node is added or removed, an updated list is sent to all agents and virtual
appliances. Until then, connections to old nodes may fail, and the new node will be unused. This
causes slow communications and increased network traffic. To avoid this, instead configure
agents and virtual appliances to connect via the load balancer's address.
258
Trend Micro Deep Security On-Premise 20
Add a node
1. "Set up a load balancer" on the previous page.
2. After you have installed Deep Security Manager on one server node, run the installer again
on another server. Make sure you follow the guidelines below.
l Install the same version of the manager on all nodes.
l Never run more than one instance of the installer at the same time. Doing so can lead
to unpredictable results including corruption of the database.
l Connect all nodes to the same database.
l Make sure all nodes use the same master key (if configured).
l Have the master key always available so that all nodes can decrypt and read the
encrypted configuration properties and personal data when required. For more
information, see masterkey.
l If the installer shows a Master Key page with the following text: Type the local secret
used to access the master key. All nodes that belong to the same Deep Security
Manager must be configured with the same local secret. On this page, enter the
secret that you specified when you set up the first node. For details, see "Install the
manager" on page 211.
259
Trend Micro Deep Security On-Premise 20
l Set the system clock of each manager node to use the same time zone. The database
must also use the same time zone. If the time zone is different, this causes Manager
Time Out of Sync errors.
Remove a node
Before you remove or replace a server, you should remove it from the pool of Deep Security
Manager nodes.
1. Halt the service or uninstall Deep Security Manager on the node that you want to remove.
Its status must change to "Offline".
2. Log into Deep Security Manager on another node.
3. Go to Administration > Manager Nodes.
4. Double-click the node that you want to remove.
The node's Properties window should appear.
5. In the Options area, click Decommission.
Upgrade a node
Follow the instructions in "Upgrade the manager in a multi-node deployment" on page 1291 for
details on upgrading manager nodes.
Viewing node statuses
To display all Deep Security Manager nodes along with their status, combined activity, and jobs
being processed, go to Administration > System Information. From the drop-down menu, select
which graph you want to view.
Network Map with Activity Graph
The Network Map with Activity Graph in the System Activity area displays a map of all installed
manager nodes and their current status as well their relative activity over the last hour. The
nodes can be in the following states:
l Online
l Offline
l Offline (Upgrade Required)
260
Trend Micro Deep Security On-Premise 20
Note: All Deep Security Manager nodes periodically check the health of all other nodes. If any
manager node loses network connectivity for more than 3 minutes, it is considered offline. The
remaining nodes assume its tasks.
Jobs by Node
This chart displays the number of jobs carried out over the last hour by each node.
261
Trend Micro Deep Security On-Premise 20
Jobs by Type
This chart displays the jobs carried out over the last hour by type.
Total jobs by node and type
This chart displays the number of job types for each node over the last hour.
262
Trend Micro Deep Security On-Premise 20
View active Deep Security Manager nodes
To display a list of all active Deep Security Manager nodes, go to Administration > Manager
Nodes . (See also "Install Deep Security Manager on multiple nodes" on page 257. )
To display details about one of the manager nodes, double-click its row in the list. The
Properties window will display:
l Hostname: The hostname of the computer where Deep Security Manager is installed.
l Description: A description of the manager node.
l Performance Profile: Deep Security Manager's performance can be affected by several
factors including number of CPUs, available bandwidth, and database responsiveness.
The manager's default performance settings are designed to be suited for most installation
environments. However, if you experience performance issues your support provider may
suggest that you change the performance profile assigned to one or more of your Deep
Security Manager nodes. (You should not change these settings without first consulting
your support provider.)
263
Trend Micro Deep Security On-Premise 20
Note: The "Simultaneous Endpoint Disk and Network Jobs" referred to in the tables
below include anti-malware scans, integrity monitoring scans, reconnaissance scans,
sending policy updates to computers, and distributing security updates.
l Aggressive: This performance profile is optimized for installations where the Deep
Security Manager is installed on a dedicated server. For example, this is how some
common concurrent operations could be distributed per manager node using the
Aggressive performance profile:
2-core 8-core
Operation
system system
Activations 10 20
Updates 25 50
Recommendation Scans 5 12
Check Status 100 Same (100)
20 Active 50 Active
Agent- or Appliance-Initiated Heartbeats
40 Queued 40 Queued
Simultaneous Endpoint Disk and Network Jobs 50 50
Simultaneous Endpoint Disk and Network Jobs per
3 3
ESXi
l Standard: This Performance Profile is optimized for installations where the Deep
Security Manager and the database are on the same computer. For example, this is
how some common concurrent operations could be distributed per manager node
using the Standard performance profile:
2-core 8-core
Operation
system system
Activations 5 10
Updates 16 46
Recommendation Scans 3 9
Check Status 65 100
20 Active 50 Active
Agent- or Appliance-Initiated Heartbeats
40 Queued 40 Queued
Simultaneous Endpoint Disk and Network Jobs 50 50
Simultaneous Endpoint Disk and Network Jobs per
3 3
ESXi
l Unlimited Agent Disk and Network Usage: This setting is identical to Aggressive but
has no limit on computer disk and network usage operations.
264
Trend Micro Deep Security On-Premise 20
2-core 8-core
Operation
system system
Activations 10 20
Updates 25 25
Recommendation Scans 5 12
Check Status 100 Same (100)
20 Active 50 Active
Agent- or Appliance-Initiated Heartbeats
40 Queued 40 Queued
Simultaneous Endpoint Disk and Network Jobs Unlimited Unlimited
Simultaneous Endpoint Disk and Network Jobs per
Unlimited Unlimited
ESXi
Note: All performance profiles limit the number of concurrent component updates to 100
per relay group.
l Status: Indicates the node's online and active status from the perspective of the Deep
Security Manager node you are currently logged into.
l Options: You can choose to decommission a manager node. The node must be offline
(uninstalled or service halted) to be decommissioned.
Deploy Deep Security Relay
A Deep Security Relay is an agent that is configured to redistribute Deep Security software and
security updates to other agents and virtual appliances. This helps your deployment scale.
You need at least one relay in your environment, and it might already be installed if you co-
deployed it with Deep Security Manager. To check:
1. Log in to Deep Security Manager.
2. Click Administration at the top.
3. Click Relay Management on the left navigation pane.
4. If you see a relay icon () in the main pane, a relay is already deployed.
To deploy your first relay:
1. Make sure the relay computer meets the requirements. See "Deep Security Agent and
Relay sizing" on page 175 and "Deep Security Relay requirements" on page 169.
2. Make sure you allow inbound and outbound communication to and from the relay on the
appropriate port numbers. See "Deep Security port numbers" on page 179.
265
Trend Micro Deep Security On-Premise 20
3. If the relay must connect through a proxy, see "Connect to the 'primary security update
source' via proxy" on page 1082.
4. Deploy an agent on the chosen computer. See "Get Deep Security Agent software" below
and "Install the agent" on page 273.
5. Enable the agent as a relay:
a. Log in to Deep Security Manager.
b. Click Administration at the top.
c. Click Relay Management in the left navigation pane.
d. Select the relay group into which the relay will be placed. If a relay group does not
exist, create one.
e. Click Add Relay.
f. In Available Computers, select the agent you just deployed.
g. Click Enable Relay and Add to Group.
The agent is enabled as a relay and is displayed with a relay icon ().
Note: Trend Micro recommends using more than one relay. This can be set up after you get
your basic Deep Security deployment running. For details, see "Deploy additional relays" on
page 1091.
Deploy Deep Security Agent
Get Deep Security Agent software
To install Deep Security Agent, you must download the agent installer and load packages for the
agent's protection modules into Deep Security Manager.
Warning: Even if you use a third party deployment system, you must import all installed Deep
Security Agent software into the Deep Security Manager's database. When a Deep Security
Agent is first activated, it only installs protection modules that are currently enabled in the
security policy. If you enable a new protection module later, Deep Security Agent will try to
download its plug-in from Deep Security Manager. If that software is missing, the agent may
not be able to install the protection module.
In this topic:
266
Trend Micro Deep Security On-Premise 20
l "View agent software available for download" below
l "View a list of imported agent software" below
l "Import agent software" on the next page
l "Export the agent installer" on page 270
l "Solaris-version-to-agent-package mapping table" on page 271
l "AIX agent package naming format" on page 271
l "Delete a software package from the Deep Security database" on page 272
View agent software available for download
To view a complete list of software that's available for import into Deep Security Manager, you
can start from Deep Security Manager or you can start from the Help Center.
Starting from Deep Security Manager:
1. In Deep Security Manager, go to Administration > Updates > Software > Download
Center. The Download Center lists all available software that is supported with the Deep
Security Manager you're using.
2. (Optional) Organize the list of software by version or platform (OS) by selecting Version or
Platform from the drop-down list at the top.
3. (Optional) Search the software by entering a search string in the search box at the top-right.
Starting from the Help Center:
1. In the Deep Security Help Center, click Software on the left. The Deep Security Software
page appears.
2. Click the Major Releases (LTS) tab for long-term support releases, and Feature Releases
(FR) tab for feature releases. For details on these release types, see "Deep Security 20
release strategy and life cycle policy" on page 75.
View a list of imported agent software
To view a list of software that you have imported into Deep Security Manager:
1. In Deep Security Manager, go to Administration > Updates > Software > Local. All your
imported software appears.
2. (Optional) Organize the list of software by version or platform (OS) by selecting Version or
Platform from the drop-down list at the top.
267
Trend Micro Deep Security On-Premise 20
Import agent software
Even if you don't use Deep Security Manager to deploy agent updates, you must still import the
software into the Deep Security Manager. There are a few import methods:
l "Import agent software directly, from the Download Center" below
l "Import agent software indirectly, from the Help Center" on the next page
l "Import agent software updates automatically" on the next page
Import agent software directly, from the Download Center
1. Make sure your Deep Security Manager computer has Internet access. If not, see instead
"Import agent software indirectly, from the Help Center" on the next page.
2. In Deep Security Manager, go to Administration > Updates > Software > Download
Center.
The Trend Micro Download Center displays all versions of available software.
3. From the drop-down list at the top, select Platform.
4. Expand a platform to view the agents available for it.
5. Under the VERSION field, look for the version you want and click the import icon. Follow
these guidelines:
l You can select a long-term support (LTS) release or a feature release (FR). For details
on LTS and FRs, see "Deep Security 20 release strategy and life cycle policy" on
page 75.
l If you're trying to import a Solaris agent, see "Solaris-version-to-agent-package
mapping table" on page 271 for information on which agent to choose.
l If you're trying to import an AIX agent, see "AIX agent package naming format" on
page 271 for the naming format, which is different depending on the agent version.
Deep Security Manager connects to the Internet to download the software from Trend
Micro Download Center. The manager then checks the digital signature on the software
package. When the manager has finished, a green check mark appears in the IMPORTED
column for that agent. Software packages now appear on Administration > Updates >
Software > Local.
If a package cannot be imported, you can try importing it indirectly instead.
268
Trend Micro Deep Security On-Premise 20
Import agent software indirectly, from the Help Center
If your Deep Security Manager is "air-gapped" (not connected to the Internet), or if a direct import
didn't work, you can try importing the agent software indirectly:
1. On a computer that has access to the Internet, go to the Deep Security Help Center.
2. On the left, click Software. The Deep Security Software page appears.
3. Download the software ZIP you want. For details on long-term support (LTS) releases and
feature releases, see "Deep Security 20 release strategy and life cycle policy" on page 75.
4. Move the software ZIP to the Deep Security Manager computer.
5. In Deep Security Manager, go to Administration > Updates > Software > Local.
6. In the main pane, click Import to import the ZIP file. The manager checks the digital
signature on the ZIP file, and if it's good, allows the import to occur.
Import agent software updates automatically
You can have Deep Security Manager look for newer software on the Download Center and
import it to your local inventory automatically. Deep Security Manager only imports updates to
already-imported software.
An 'update' is a build in which only the last set of numbers changes.
For example, if you already imported agent version 12.0.0.111, then these versions...
12.0.0.112
12.0.0.113
12.0.0.123
...would be imported automatically, because they are update builds of 12.0.0.111.
However, these versions...
12.1.0.222
11.0.0.333
10.0.0.111
...would not.
To have Deep Security Manager auto-import agent update builds to your local inventory:
1. In Deep Security Manager, go to Administration > System Settings > Updates.
2. Select Automatically download updates to imported software.
269
Trend Micro Deep Security On-Premise 20
3. Click Save.
Note: This setting imports the software to Deep Security Manager but will not
automatically update your agent or appliance software. Continue with "Upgrade Deep
Security Agent" on page 1295.
Export the agent installer
You can download the agent installer from Deep Security Manager.
1. In Deep Security Manager, go to Administration > Updates > Software > Local.
2. Select your agent from the list. If you have imported multiple versions of the same agent,
the latest version of the software will have a green check mark in the Is Latest column.
Note: If you're looking for a Solaris agent, see "Solaris-version-to-agent-package
mapping table" on the next page for information on which agent to choose.
3. Click Export > Export Installer.
The manager then checks the digital signature on the software package. If the signature is
good, the export proceeds.
4. Save the agent installer. If you will install the agent manually, save it on the computer
where you want to install Deep Security Agent.
Tip: To install Deep Security Agent, only use the exported agent installer (the .msi, .rpm, .pkg,
.p5p, or .bff file depending on the platform) not the full agent ZIP package. If you run the agent
installer from the same folder that holds the other zipped agent components, all protection
modules will be installed, even if you haven't enabled them on the computer. This consumes
extra disk space. (For comparison, if you use the .msi, .rpm, .pkg, .p5p, or .bff file, the agent will
download and install protection modules only if your configuration requires them.)
Tip: Installing an agent, activating it, and applying protection with a security policy can be
done using a command line script. For more information, see "Use deployment scripts to add
and protect computers" on page 1401.
Tip: You can generate deployment scripts to automate the agent installation using the Deep
Security API. For more information, see Generate an agent deployment script.
270
Trend Micro Deep Security On-Premise 20
Solaris-version-to-agent-package mapping table
If you're not sure which agent package to pick when importing and exporting the agent, review
the mapping table below.
Solaris-version-to-agent-package mapping table
If you're installing the agent on... Choose this agent package... Help Center option
Solaris 10 Updates 4-6 (64- Agent-Solaris_5.10_U5-xx.x.x-
bit, SPARC or x86) Solaris_5.10_U5
xxx.<sparc|.x86_64>.zip
Solaris 10 Updates 7-11 Agent-Solaris_5.10_U7-xx.x.x-
Solaris_5.10_U7
(64-bit, SPARC or x86) xxx.<sparc|.x86_64>.zip
Solaris 11.0 (1111)-11.3 Agent-Solaris_5.11-xx.x.x-
Solaris_5.11
(64-bit, SPARC or x86) xxx.<sparc|.x86_64>.zip
Solaris 11.4 (64-bit, Agent-Solaris_5.11_U4-xx.x.x-
Solaris_5.11_U4
SPARC or x86) xxx.<sparc|.x86_64>.zip
Notes:
l The Help Center option column shows you which option to select from the Agent drop-
down list on the Help Center's 'Deep Security Software' page, if that's how you've chosen
to obtain the package.
l xx.x.x.xxx is the build number of the agent. For example: 12.0.0-682
l <sparc|.x86_64> is one of sparc or .x86_64, depending on the Solaris processor.
AIX agent package naming format
The naming format is different depending on the agent version:
l Deep Security Agent 12 for AIX: Agent-AIX-<agent_release>-<agent_
build>.powerpc.zip. Example: Agent-AIX-12.0.0-1234.powerpc.zip.
l Deep Security Agent 9.0 for AIX: Agent-AIX_<AIX_version>-<agent_release>-
<build>.powerpc.bff.gz.zip. Example: Agent-AIX_5.3-9.0.0-
5625.powerpc.bff.gz.zip.
271
Trend Micro Deep Security On-Premise 20
For details on which agent you'll need for the version of AIX you're using, see "Deep Security
Agent platforms" on page 135.
Delete a software package from the Deep Security database
To save disk space, Deep Security Manager will periodically remove unused packages from the
Deep Security database. To configure the maximum number of old packages kept, go to System
Settings > Storage.
Note: Deep Security Virtual Appliance uses the same protection modules as Deep Security
Agent for 64-bit Red Hat Enterprise Linux. Therefore if you have an activated Deep Security
Virtual Appliance, and try to delete the 64-bit Red Hat Enterprise Linux Agent software
package from the database, an error message will tell you that the software is in use.
There are two types of packages that can be deleted:
l agent
l kernel support
Deleting agent packages in single-tenancy mode
In single tenancy mode, Deep Security automatically deletes agent packages (Agent-platform-
version.zip) that are not currently being used by agents. Alternatively, you can manually delete
unused agent packages. Only unused software packages can be deleted.
Note: For the Windows and Linux agent packages, only the currently used package (whose
version is the same as the agent installer) cannot be deleted.
Deleting agent packages in multi-tenancy mode
In multi-tenancy mode, unused agent packages (Agent-platform-version.zip) are not deleted
automatically. For privacy reasons, Deep Security cannot determine whether software is
currently in use by your tenants, even though you and your tenants share the same software
repository in the Deep Security database. As the primary tenant, Deep Security does not prevent
you from deleting software that is not currently running on any of your own account's computers,
but before deleting a software package, be very sure that no other tenants are using it.
272
Trend Micro Deep Security On-Premise 20
Deleting kernel support packages
In both single and multi-tenancy mode, Deep Security automatically deletes unused kernel
support packages (KernelSupport-platform-version.zip). A kernel support package can be
deleted if both of these conditions are true:
l No agent package has the same group identifier.
l Another kernel support package has the same group identifier and a later build number.
You can also manually delete unused kernel support packages. For Linux kernel support
packages, only the latest one cannot be deleted.
Install the agent
Topics:
l "Install the agent manually" below
l "Install the agent using other methods" on page 278
l "Post-installation tasks" on page 279
Install the agent manually
Before you begin, make sure you have:
1. Reviewed the agent's system requirements. See "Deep Security Agent requirements" on
page 168.
2. Allowed inbound and outbound communication to and from the agent on the appropriate
port numbers. See "Deep Security port numbers" on page 179.
3. Imported the agent software into the manager. See "Import agent software" on page 268.
4. Exported the agent software from the manager. See "Export the agent installer" on
page 270.
Next, install the agent. Follow the instructions for your platform.
Install the agent on Windows
1. Copy the agent ZIP to the computer and extract it.
2. Double-click the installation file (.MSI file) to run the installer package.
273
Trend Micro Deep Security On-Premise 20
Note: On Windows Server 2012 R2 Server Core, launch the installer using this
command instead: msiexec /i Agent-Core-Windows-12.x-xxxx.x86_
64.msi
3. At the Welcome screen, click Next to begin the installation.
4. End-User License Agreement: If you agree to the terms of the license agreement,
select I accept the terms of the license agreement and click Next.
5. Destination Folder: Select the location where you would like Deep Security Agent
to be installed and click Next.
6. Ready to install Trend Micro Deep Security Agent: Click Install to proceed with
the installation.
7. Completed: when the installation has completed successfully, click Finish.
The Deep Security Agent is now installed and running on this computer, and will start
every time the machine boots.
Note: When installing the agent on Windows 2012 Server Core, the notifier will not be
included.
Note: During an install, network interfaces will be suspended for a few seconds
before being restored. If you are using DHCP, a new request will be generated,
potentially resulting in a new IP address for the restored connection.
Installation on Amazon WorkSpaces
l If you are unable to install Deep Security Agent .msi file due to error code ‘2503’
then you must do one of the following:
l Edit your C:\Windows\Temp folder and allow the write permission for your
user
OR
l Open the command prompt as an administrator and run the .msi file
Note: Amazon has fixed this issue for newly-deployed Amazon WorkSpaces.
Installation on Windows 2012 Server Core
l Deep Security does not support switching the Windows 2012 server mode
between Server Core and Full (GUI) modes after the Deep Security Agent is
274
Trend Micro Deep Security On-Premise 20
installed.
l If you are using Server Core mode in a Hyper-V environment, you will need to use
Hyper-V Manager to remotely manage the Server Core computer from another
computer. When the Server Core computer has the Deep Security Agent installed
and Firewall enabled, the Firewall will block the remote management connection.
To manage the Server Core computer remotely, turn off the Firewall module.
l Hyper-V provides a migration function used to move a guest VM from one Hyper-V
server to another. The Deep Security Firewall module will block the connection
between Hyper-V servers, so you will need to turn off the Firewall module to use
the migration function.
Install the agent on Red Hat, SUSE, Oracle Linux, or Cloud Linux
1. Copy the agent ZIP to the computer and extract it.
2. Install the agent.
# sudo rpm -i <package name>
Preparing... ########################################## [100%]
1:ds_agent ########################################## [100%]
Loading ds_filter_im module version ELx.x [ OK ]
Starting ds_agent: [ OK ]
The Deep Security Agent will start automatically upon installation.
Install the agent on Ubuntu or Debian
1. Copy the agent ZIP to the computer and extract it.
2. Install the agent.
sudo dpkg -i <installer deb file>
To start, stop, or reset the agent:
Using SysV init scripts:
275
Trend Micro Deep Security On-Premise 20
l Start: : /etc/init.d/ds_agent start
l Stop: /etc/init.d/ds_agent stop
l Reset: /etc/init.d/ds_agent reset
l Restart: /etc/init.d/ds_agent restart
l Display status: svcs -a | grep ds_agent
Using systemd commands:
l Start: systemctl start ds_agent
l Stop: systemctl stop ds_agent
l Restart: systemctl restart ds_agent
l Display status: systemctl status ds_agent
Install the agent on Solaris
Note: The Deep Security Agent installation is only supported in the global zone.
Solaris requires the following libraries to be installed to support Deep Security Agent:
Solaris 10: SUNWgccruntime
Solaris 11.0 - 11.3: gcc-45-runtime
Solaris 11.4: none; gcc-c-runtime version 7.3 is installed by default
1. Copy the agent installer package to the computer where you want to install the
agent.
2. Unzip the ZIP file.
3. Unzip the GZ file.
gunzip <agent_GZ_file>
The agent installer file (P5P or PKG) is now available.
4. Install the agent. Some examples of installation commands are provided below.
Alter the commands to suit your Solaris version, Solaris zone, Solaris processor,
and Deep Security agent package name.
276
Trend Micro Deep Security On-Premise 20
l On Solaris 11, with one zone, run the following command in the global zone:
x86: pkg install -g file:///mnt/Agent-Solaris_5.11-xx.x.x-
xxxx.x86_64/Agent-Core-Solaris_5.11-xx.x.x-xxxx.x86_64.p5p
pkg:/security/ds-agent
SPARC: pkg install -g file:///mnt/Agent-Solaris_5.11-xx.x.x-
xxxx.sparc/Agent-Core-Solaris_5.11-xx.x.x-xxxx.sparc.p5p
pkg:/security/ds-agent
l On Solaris 11, with multiple zones, run the following command in the global
zone:
mkdir <path>
pkgrepo create <path>
pkgrecv -s file://<path_to_agent_p5p_file> -d <path> '*'
pkg set-publisher -g <path> trendmicro
pkg install pkg://trendmicro/security/ds-agent
pkg unset-publisher trendmicro
rm -rf <path>
l On Solaris 10, run one of these commands:
x86: pkgadd -G -d Agent-Core-Solaris_5.10_Ux-xx.x.x-xxx.x86_
64.pkg
SPARC: pkgadd -G -d Agent-Core-Solaris_5.10_Ux-xx.x.x-
xxx.sparc.pkg
To start, stop, or reset the agent:
l Start: svcadm enable ds_agent
l Stop: svcadm disable ds_agent
l Reset: /opt/ds_agent/dsa_control -r
l Restart: svcadm restart ds_agent
l Display status: svcs -a | grep ds_agent
To uninstall the agent on Solaris 11:
277
Trend Micro Deep Security On-Premise 20
pkg uninstall pkg:/security/ds-agent
To uninstall the agent on Solaris 10:
pkgrm -v ds-agent
Install the agent on AIX
1. Copy the agent ZIP to the computer and extract it. A GZ file becomes available.
2. Move the GZ file to another location.
3. Extract the GZ file using gunzip. A BFF file becomes available. This is the installer
file.
4. Copy the BFF file to the AIX computer.
5. Place the BFF file in a temporary folder such as /tmp.
6. Install the agent.
/tmp> installp -a -d /tmp/<agent_BFF_file_name> ds_agent
where <agent_BFF_file_name> is replaced with the name of the BFF installer
file you extracted.
To start, stop, load, or unload the driver for the agent:
l Start: startsrc -s ds_agent
l Stop: stopsrc -s ds_agent
l Load the driver: /opt/ds_agent/ds_fctrl load
l Unload the driver: /opt/ds_agent/ds_fctrl unload
Install the agent using other methods
If you don't want to install the agent manually, you can use one of the methods described below.
l Deployment scripts: Generate deployment scripts within the manager and use them to
install the agent. For details, see "Use deployment scripts to add and protect computers"
on page 1401
l Deep Security API: Use the API to generate deployment scripts to automate the
installation of the agent on a computer. See Use Scripts to Deploy Deep Security Manager
and Agent on the Deep Security Automation Center.
278
Trend Micro Deep Security On-Premise 20
l SCCM: Use Microsoft System Center Configuration Manager (SCCM) to install an agent,
activate it, and apply a policy. To use SCCM, go to Administration > System Settings >
Agents and enable agent-initiated activation.
l Template: Include the agent in your VM template. See "Install the agent on an AMI or
WorkSpace bundle" on page 285 and "Install the agent on Azure VMs" on page 289.
Post-installation tasks
After you install the agent, you must perform the following post-installation tasks, if they were not
already completed as part of the installation process:
l "Activate the agent" on page 295
l "Assign a policy to a computer" on page 449
Install the agent on Amazon EC2 and WorkSpaces
Note: The Deep Security Agent only supports Amazon WorkSpaces Windows desktops—it
does not support Linux desktops.
Read this page if you want to protect existing Amazon EC2 instances and Amazon WorkSpaces
with Deep Security.
If instead you want to:
l launch new Amazon EC2 instances and Amazon WorkSpaces with the agent 'baked in',
see "Install the agent on an AMI or WorkSpace bundle" on page 285.
l protect Amazon WorkSpaces after already protecting your Amazon EC2 instances, see
instead "Protect Amazon WorkSpaces if you already added your AWS account" on
page 406.
To protect your existing Amazon EC2 instances and Amazon WorkSpaces with Deep Security,
follow these steps:
1. "Add your AWS accounts to Deep Security Manager" on the next page
2. "Set the communication direction" on the next page
3. "Configure the activation type" on page 281
4. "Open ports" on page 282
5. "Deploy agents to your Amazon EC2 instances and WorkSpaces" on page 283
279
Trend Micro Deep Security On-Premise 20
6. "Verify that the agent was installed and activated properly" on page 284
7. "Assign a policy" on page 284
Add your AWS accounts to Deep Security Manager
You'll need to add your AWS account or accounts to Deep Security Manager. These AWS
accounts contain the Amazon EC2 instances and Amazon WorkSpaces that you want to protect
with Deep Security.
See "About adding AWS accounts" on page 393 for details.
After adding your AWS accounts:
l your existing Amazon EC2 instances and Amazon WorkSpaces appear in Deep Security
Manager. If no agent is installed on them, they appear with a Status of Unmanaged
(Unknown) and a grey dot next to them. If an agent was already installed, they appear with
a Status of Managed (Online) and green dot next to them.
l any new Amazon EC2 instances or Amazon WorkSpaces that you launch through AWS
under this AWS account are auto-detected by Deep Security Manager and displayed in the
list of computers.
Set the communication direction
You'll need to set the communication direction: either agent-initiated, manager-initiated, or bi-
directional.
1. Log in to Deep Security Manager.
2. Set the communication direction following the instructions in "Configure communication
directionality" on page 1125. Follow these guidelines:
l Agent/Appliance Initiated does not require you to open inbound ports on the Amazon
EC2 instance or Amazon WorkSpace, while Bidirectional and Manager-Initiated do.
l Agent/Appliance Initiated is the safest option since no inbound ports need to be
opened on the Amazon EC2 instance or Amazon WorkSpace.
3. If you're using Amazon WorkSpaces, and you chose to set the communication direction to
Bidirectional or Manager-Initiated, manually assign an elastic IP address to each
WorkSpace before proceeding with further steps on this page. This gives the WorkSpace a
public IP that can be contacted by the Deep Security Manager. This is not required for EC2
instances because they already use public IP addresses. WorkSpaces use private
IP addresses.
280
Trend Micro Deep Security On-Premise 20
Configure the activation type
'Activation' is the process of registering an agent with a manager. You'll need to indicate whether
you'll allow agent-initiated activation. If not, only manager-initiated activation is allowed.
1. Log in to Deep Security Manager.
2. Click Administration at the top.
3. On the left, click System Settings.
4. In the main pane, make sure the Agents tab is selected.
5. Select or deselect Allow Agent-Initiated Activation, noting that:
l Agent-initiated activation does not require you to open up inbound ports to your
Amazon EC2 instances or Amazon WorkSpaces, while manager-initiated activation
does.
l If agent-initiated activation is enabled, manager-initiated activation continues to work.
l Agent-initiated activation works even if you set the communication direction to
Manager-Initiated.
6. If you selected Allow Agent-Initiated Activation, also select Reactivate cloned Agents,
and Enable Reactivate unknown Agents. See "Agent settings" on page 1149 for more
information.
7. Click Save.
8. If you're using Amazon WorkSpaces, and you didn't allow agent-initiated activation,
manually assign an elastic IP address to each WorkSpace now, before proceeding with
further steps on this page. This gives each Amazon WorkSpace a public IP that can be
contacted by other computers. This is not required for EC2 instances because they already
use public IP addresses.
281
Trend Micro Deep Security On-Premise 20
Open ports
You'll need to make sure that the necessary ports are open to your Amazon EC2 instances or
Amazon WorkSpaces.
To open ports:
1. Open ports to your Amazon EC2 instances, as follows:
a. Log in to your Amazon Web Services Console.
b. Go to EC2 > Network & Security > Security Groups.
c. Select the security group that is associated with your EC2 instances, then select
Actions > Edit outbound rules.
d. Open the necessary ports. See "Which ports should be opened?" below below.
2. Open ports to your Amazon WorkSpaces, as follows:
a. Go to the firewall software that is protecting your Amazon WorkSpaces, and open the
ports listed above.
You have now opened the necessary ports so that Deep Security Agent and Deep Security
Manager can communicate.
Which ports should be opened?
Generally-speaking:
l agent-to-manager communication requires you to open the outbound TCP port (443 or 80,
by default)
l manager-to-agent communication requires you to open an inbound TCP port (4118).
More specifically:
l If you set the communication direction to Agent/Appliance-Initiated, you'll need to open the
outbound TCP port (443 or 80, by default).
l If you set the communication direction to Manager-Initiated, you'll need to open the
inbound TCP port of 4118.
l If you set the communication direction to Bidirectional, you'll need to open both the
outbound TCP port (443 or 80, by default) AND the inbound TCP port of 4118.
l If you enabled Allow Agent-Initiated Activation, you'll need to open the outbound TCP
port (443 or 80, by default) regardless of how you set the communication direction.
l If you disabled Allow Agent-Initiated Activation, you'll need to open the inbound TCP port
of 4118 regardless of how you set the communication direction.
282
Trend Micro Deep Security On-Premise 20
Deploy agents to your Amazon EC2 instances and WorkSpaces
You'll need to deploy agents onto your Amazon EC2 instances and Amazon WorkSpaces.
Below are a couple of options.
l Option 1: Use a deployment script to install, activate, and assign a policy
Use Option 1 if you need to deploy agents to many Amazon EC2 instances and Amazon
WorkSpaces.
With this option, you must run a deployment script on the Amazon EC2 instances or
Amazon WorkSpaces. The script installs and activates the agent and then assigns a
policy. See "Use deployment scripts to add and protect computers" on page 1401 for
details.
OR
l Option 2: Manually install and activate
Use Option 2 if you only need to deploy agents to a few EC2 instances and Amazon
WorkSpaces.
a. Get the Deep Security Agent software, copy it to the Amazon EC2 instance or Amazon
WorkSpace, and then install it. For details, see "Get Deep Security Agent software" on
page 266, and "Install the agent" on page 273.
b. Activate the agent. You can do so on the agent (if agent-initiated activation was
enabled) or on the Deep Security Manager. For details, see "Activate the agent" on
page 295
You have now installed and activated Deep Security Agent on an Amazon EC2 instance or
Amazon WorkSpace. A policy may or may not have been assigned, depending on the option
you chose. If you chose Option 1 (you used a deployment script), a policy was assigned to the
agent during activation. If you chose Option 2 (you manually installed and activated the agent),
then no policy has been assigned, and you will need to assign one following the instructions
further down on this page.
Verify that the agent was installed and activated properly
You should verify that your agent was installed and activated properly.
283
Trend Micro Deep Security On-Premise 20
1. Log in to Deep Security Manager.
2. Click Computers at the top.
3. On the navigation pane on the left, make sure your Amazon EC2 instance or Amazon
WorkSpace appears under Computers > your_AWS_account > your_region . (Look for
WorkSpaces in a WorkSpaces sub-node.)
4. In the main pane, make sure your Amazon EC2 instances or Amazon WorkSpaces appear
with a Status of Managed (Online) and a green dot next to them.
Assign a policy
Skip this step if you ran a deployment script to install and activate the agent. The script already
assigned a policy so no further action is required.
If you installed and activated the agent manually, you must assign a policy to the agent.
Assigning the policy sends the necessary protection modules to the agent so that your computer
is protected.
To assign a policy, see "Assign a policy to a computer" on page 449.
After assigning a policy, your Amazon EC2 instance or Amazon WorkSpace is now protected.
284
Trend Micro Deep Security On-Premise 20
Install the agent on an AMI or WorkSpace bundle
Read this page if you want to launch new Amazon EC2 instances and Amazon WorkSpaces
with the agent 'baked in'.
If instead you want to:
l protect existing Amazon EC2 instances and Amazon WorkSpaces with Deep Security, see
"Install the agent on Amazon EC2 and WorkSpaces" on page 279.
l protect Amazon WorkSpaces after already protecting your Amazon EC2 instances, see
instead "Protect Amazon WorkSpaces if you already added your AWS account" on
page 406.
'Baking the agent' is the process of launching an EC2 instance based on a public AMI, installing
the agent on it, and then saving this custom EC2 image as an AMI. This AMI (with the agent
'baked in') can then be selected when launching new Amazon EC2 instances.
Similarly, if you want to deploy the Deep Security Agent on multiple Amazon WorkSpaces, you
can create a custom 'WorkSpace bundle' that includes the agent. The custom bundle can then
be selected when launching new Amazon WorkSpaces.
To bake an AMI and create a custom WorkSpace bundle with a pre-installed and pre-activated
agent, follow these steps:
1. "Add your AWS account to Deep Security Manager" below
2. "Set the communication direction" on the next page
3. "Configure the activation type" on the next page
4. "Launch a 'master' Amazon EC2 instance or Amazon WorkSpace" on the next page
5. "Deploy an agent on the master" on the next page
6. "Verify that the agent was installed and activated properly" on page 287
7. "(Recommended) Set up policy auto-assignment" on page 287
8. "Create an AMI or custom WorkSpace bundle based on the master" on page 288
9. "Use the AMI" on page 288
Add your AWS account to Deep Security Manager
You'll need to add your AWS accounts to Deep Security Manager. These are the AWS accounts
that will contain the Amazon EC2 instances and Amazon WorkSpaces that you want to protect.
See "About adding AWS accounts" on page 393 for details.
285
Trend Micro Deep Security On-Premise 20
Set the communication direction
You'll need to set the communication direction: either agent-initiated, manager-initiated, or
bidirectional.
See "Install the agent on Amazon EC2 and WorkSpaces" on page 279 > "Set the
communication direction" on page 280 for instructions.
Configure the activation type
You'll need to indicate whether you'll allow agent-initiated activation.
See "Install the agent on Amazon EC2 and WorkSpaces" on page 279 > "Configure the
activation type" on page 281 for instructions.
Launch a 'master' Amazon EC2 instance or Amazon WorkSpace
You'll need to launch a 'master' Amazon EC2 instance or Amazon WorkSpace. The master
instance is the basis for the EC2 AMI or WorkSpace bundle that you will create later.
1. In AWS, launch an Amazon EC2 instance or Amazon WorkSpace. See the Amazon EC2
documentation and Amazon WorkSpaces documentation for details.
2. Call the instance 'master'.
Deploy an agent on the master
You'll need to install and activate the agent on the master. During this process, you can
optionally install a policy.
See "Install the agent on Amazon EC2 and WorkSpaces" on page 279 > "Deploy agents to your
Amazon EC2 instances and WorkSpaces" on page 283 for instructions.
Tip: Ideally, if you bake the agent into your AMI or workspace bundle and then want to use a
newer agent later on, you should update the bundle to include the new agent. However, if
that's not possible, you can use the Automatically upgrade agents on activation setting so
when the agent in the AMI or bundle activates itself, Deep Security Manager can automatically
upgrade the agent to the latest version. For details, see "Automatically upgrade agents on
activation" on page 1139.
286
Trend Micro Deep Security On-Premise 20
Verify that the agent was installed and activated properly
You should verify that the agent was installed and activated properly on the master before
proceeding.
See "Install the agent on Amazon EC2 and WorkSpaces" on page 279 > "Verify that the agent
was installed and activated properly" on page 284 for instructions.
(Recommended) Set up policy auto-assignment
You may need to set up policy auto-assignment depending on how you deployed the agent on
the master:
l If you used a deployment script, then a policy has already been assigned, and no further
action is required.
l If you manually installed and activated the agent, no policy was assigned to the agent, and
one should be assigned now so that the master is protected. The Amazon EC2 instances
and Amazon WorkSpaces that are launched based on the master will also be protected.
If you want to assign a policy to the master, as well as auto-assign a policy to future EC2
instances and WorkSpaces that are launched using the master, follow these instructions:
1. In Deep Security Manager, create an event-based task with these parameters:
l Set the Event to Agent-Initiated Activation.
l Set Assign Policy to the policy you want to assign.
l (Optional) Set a condition to Cloud Instance Metadata, with
l a tagKey of EC2 and a tagValue.* of True (for an EC2 instance)
OR
l a tagKey of WorkSpaces and a tagValue.* of True (for WorkSpaces)
The above event-based task says:
When an agent is activated, assign the specified policy, on condition that EC2=true
or WorkSpaces=true exists in the Amazon EC2 instance or WorkSpace.
If that key/value pair does not exist in the EC2 instance or WorkSpace, then the policy
is not assigned (but the agent is still activated). If you do not specify a condition, then
the policy is assigned on activation unconditionally.
287
Trend Micro Deep Security On-Premise 20
For details on creating event-based tasks, see "Automatically assign policies by AWS
instance tags" on page 1413.
2. If you added a key/value pair in Deep Security Manager in the previous step, do the
following:
a. Go to AWS.
b. Find your master EC2 instance or WorkSpace.
c. Add tags to the master with a Key of EC2 or WorkSpaces and a Value of True.
For details, see this Amazon EC2 documentation on tagging, and this Amazon
WorkSpace documentation on tagging.
You have now set up policy auto-assignment. New Amazon EC2 instances and
Amazon WorkSpaces that are launched using the master are activated automatically
(since the agent is pre-activated on the master), and then auto-assigned a policy
through the event-based task.
3. On the master EC2 instance or WorkSpace, reactivate the agent by re-running the
activation command on the agent, or by clicking the Reactivate button in Deep Security
Manager. For details, see "Activate the agent" on page 295
The re-activation causes the event-based task to assign the policy to the master. The
master is now protected.
You are now ready to bake your AMI or create a custom WorkSpace bundle.
Create an AMI or custom WorkSpace bundle based on the master
l To create an AMI on Linux, see this Amazon documentation.
l To create an AMI on Windows, see this Amazon documentation.
l To create a custom WorkSpace bundle, see this Amazon documentation.
You now have an AMI or WorkSpace bundle that includes a pre-installed and pre-activated
agent.
Use the AMI
Now that you have a custom AMI or WorkSpace bundle, you can use it as the basis for future
Amazon EC2 instances and Amazon WorkSpaces. With the custom AMI or bundle, Deep
Security Agent starts up automatically, activates itself, and applies the protection policy assigned
to it. It appears in Deep Security Manager with a Status of Managed and a green dot next to it.
288
Trend Micro Deep Security On-Premise 20
Install the agent on Azure VMs
To install the agent on VM instances running in the Microsoft Azure cloud, you need to deploy
Deep Security Agents to them. You can do this in multiple ways:
l You can generate Deep Security deployment scripts for automatically deploying agents
using deployment tools such as RightScale, Chef, Puppet, and SSH. For more information
on how to do so, see "Use deployment scripts to add and protect computers" on
page 1401.
l You can add a custom script extension to an existing virtual machine to deploy and
activate the Deep Security Agent. To do this, navigate to your existing virtual machine in
the Azure management portal and follow the steps below to upload and execute the
deployment script on your Azure VM.
To add a custom script extension to an existing virtual machine:
1. Log in to the Azure portal.
2. Switch to the preview portal, and then click the virtual machine that you want to add the
custom script to.
3. In the Settings blade, click Extensions, in the Extensions blade, click Add extension, in the
New Resource blade, select Custom Script, and then click Create.
4. In the Add Extension blade under Script File (required), click upload, select the saved
.ps1 deployment script, and then click OK.
Install the agent on Google Cloud Platform VMs
Read this page if you want to protect existing Google Cloud Platform (GCP) VM instances with
Deep Security.
To protect your existing GCP VMs:
1. Add a GCP service account to Deep Security Manager. For instructions, see "Add a
Google Cloud Platform account" on page 429.
2. Set the communication direction to Agent/Appliance Initiated. For instructions, see
"Configure communication directionality" on page 1125.
289
Trend Micro Deep Security On-Premise 20
3. Configure agent-initiated activation (AIA). For instructions, see "Activate and protect agents
using agent-initiated activation and communication" on page 1138.
4. Open ports so that Deep Security components can access your GCP VMs and the GCP
API. For information on which ports to open, see "Port numbers, URLs, and IP addresses"
on page 178. For instructions on how to open ports, see this GCP webpage.
5. Deploy agents to your GCP VMs. You must use Deep Security Agent 12 or later.
To deploy agents, you have two options:
Option Use if... Instructions
See "Use
Option 1: deployment
You need to deploy many scripts to add
Use a deployment script to and protect
install, activate, and assign a agents to your GCP VMs. computers" on
policy to the agent page 1401 for
instructions.
a. Obtain the
Deep
Security
Agent
software,
copy it to
the
GCP VM,
and then
Option 2:
You only need to deploy a few install it.
Manually install and activate the agents. For
agent details,
see "Get
Deep
Security
Agent
software"
on
page 266
b. Activate
290
Trend Micro Deep Security On-Premise 20
Option Use if... Instructions
the agent.
You can
do so on
the agent
or on the
Deep
Security
Manager.
For
details,
see
"Activate
the agent"
on
page 295
6. Verify that the agent was installed and activated properly:
a. Log in to Deep Security Manager.
b. Click Computers at the top.
c. On the navigation pane on the left, make sure your GCP VM appears under
Computers > your_GCP_service_account > your_GCP_project .
d. In the main pane, make sure your GCP VMs appear with a Status of Managed
(Online) and a green dot next to them.
7. Assign a policy if you installed and activated the agent manually. For instructions, see
"Assign a policy to a computer" on page 449. Assigning the policy sends the necessary
protection modules to the agent so that your computer is protected.
Note: Skip the policy assignment step if you ran a deployment script to install and
activate the agent. The script already assigned a policy so no further action is required.
After assigning a policy, your GCP VM is now protected.
Install the agent on VMware vCloud
To enable vCloud integration, you must assign a minimum set of rights to the user accounts
tenants will use to import their vCloud "Cloud Accounts" and you must configure the vCenter
database to assign unique UUIDs to new virtual machines.
291
Trend Micro Deep Security On-Premise 20
Note: To deploy Deep Security protection agentlessly in a vCloud environment, see instead
"Deploy the appliance in a vCloud environment" on page 364.
Create a minimum rights role for vCloud account tenant users
The user accounts you create in vCloud Director that the Deep Security tenants will use to add
their cloud accounts to their Deep Security Manager require only the All Rights > General >
Administrator View right.
1. Log in to vCloud Director.
2. In the System tab, click on Administration.
3. In the navigation panel on the left, click on Roles.
4. Click the "plus" sign to create a new Role (for example, "DS_User").
5. Select the Administrator View right in the All Rights > General folder.
6. Click OK.
You can now assign this role to the user accounts you will give to Deep Security users to import
their vCloud resources into the Deep Security Manager.
Note: When providing a Deep Security user with their credentials, you must include the IP
address of the vCloud Organization and instruct them that when importing the vCloud
resources into their Deep Security Manager, their username must include "@orgName". For
example if the vCloud account's username is kevin and the vCloud Organization you've given
the account access to is called CloudOrgOne, then the Deep Security user must enter
kevin@CloudOrgOne as their username when importing the vCloud resources. (For a vCloud
administrator view, use @system.)
Note: You can configure Deep Security Manager to use a proxy server specifically for
connecting to instances being protected in Cloud Accounts. The proxy setting can be found in
Administration > System Settings > Proxies > Proxy Server Use > Deep Security Manager
(Cloud Accounts).
Assign unique UUIDs to new virtual machines
Deep Security requires that all protected virtual machines have unique UUIDs. Virtual machines
created from a vApp template can be assigned duplicate UUIDs which can cause problems. To
292
Trend Micro Deep Security On-Premise 20
configure your vCloud database to assign unique UUIDs, set the CloneBiosUuidOnVmCopy
property to zero (0) following VMware Knowledge Base article 2002506.
Enable the OVF Environment Transport for VMware Tools on your
guest VMs
Enabling the OVF Environment Transport for VMware Tools on your guest VMs will expose the
guestInfo.ovfEnv environment variable making it easier for Agents to uniquely identify their VMs
to the Deep Security Manager. This will reduce the risk of VM misidentification.
1. In vCloud Director, open the VM's Properties screen, go the Guest OS Customization tab
and select the Enable guest customization checkbox. Click OK.
2. In vCenter, select the same VM, open its Properties screen, go to the Options tab.
3. Click vApp Options and select the Enabled radio button. OVF Settings will now be
exposed.
4. In OVF Settings, select the VMware Tools checkbox in the OVF Environment Transport
area. Click OK.
If your VM is running, it must be restarted for the changes to take effect.
The data used by Deep Security are taken from the following properties:
vmware.guestinfo.ovfenv.vcenterid and vmware.guestinfo.ovfenv.vcloud.computername.
Import computers from a VMware vCloud Organization account
Note: vCloud Organization accounts must be added by tenants (not the primary tenant).
1. In the Deep Security Manager, go to the Computers section, right-click Computers in the
navigation panel and select Add vCloud Account to display the Add vCloud Account
wizard.
2. Enter a Name and Description of the resources you are adding. (These are only used for
display purposes in the Deep Security Manager.)
3. Enter the vCloud Address. (The hostname of the vCloud Director host machine.)
4. Enter your User name and Password.
Note: Your User name must be in the form username@vcloudorganization.
5. Click Next.
6. Deep Security Manager will verify the connection to the cloud resources and display a
summary of the import action. Click Finish.
293
Trend Micro Deep Security On-Premise 20
The VMware vCloud resources now appear in the Deep Security Manager under their own
branch under Computers in the navigation panel.
After adding the Cloud Provider resources, you must install an agent, activate the agent, and
assign a policy to the computer (see "Install the agent" on page 273 or "Use deployment scripts
to add and protect computers" on page 1401, and "Activate the agent" on the next page.)
Import computers from a VMware vCloud Air Virtual data center
1. In the Deep Security Manager, go to the Computers section, right-click Computers in the
navigation panel and select Add vCloud Account to display the Add vCloud Account
wizard.
2. Enter a Name and Description of the VMware vCloud Air virtual data center you are
adding. (These are only used for display purposes in the Deep Security Manager.)
3. Enter the Address of the VMware vCloud Air virtual data center.
Note: To determine the address of the VMware vCloud Air virtual data center:
a. Log in to your VMware vCloud Air portal.
b. On the Dashboard tab, click on the data center you want to import into Deep
Security. This will display the Virtual Data Center Details information page.
c. In the Related Links section of the Virtual Data Center Details page, click on vCloud
Director API URL. This will display the full URL of the vCloud Director API.
d. Use the hostname only (not the full URL) as the Address of the VMware vCloud Air
virtual data center that you are importing into Deep Security.
4. Enter your User name and Password.
Note: Your User name must be in the form username@virtualdatacenterid.
5. Click Next.
6. Deep Security Manager will verify the connection to the virtual data center and display a
summary of the import action. Click Finish.
The VMware vCloud Air data center now appears in the Deep Security Manager under its own
branch under Computers in the navigation panel.
After adding the Cloud Provider resources, you must install an agent, activate the agent, and
assign a policy to the computer (see "Install the agent" on page 273 or "Use deployment scripts
to add and protect computers" on page 1401 and "Activate the agent" on the next page.)
294
Trend Micro Deep Security On-Premise 20
Activate the agent
Tip: If you haven't already installed the agent, see "Use deployment scripts to add and protect
computers" on page 1401 or "Install the agent" on page 273 for instructions.
Before the installed agent can protect its computer or be converted to a relay, you must activate
the agent with Deep Security Manager. Activation registers the agent with the manager during
an initial communication.
To do this, you can either:
l Activate the agent from the manager. Go to Computers, right-click the computer whose
agent or appliance you want to activate or reactivate and select Actions
> Activate/Reactivate. (Alternatively, click Activate or Reactivate in the computer's Details
window.)
l Activate the agent through a deployment script. See "Use deployment scripts to add and
protect computers" on page 1401 for details.
l Activate the agent from the computer where the agent is installed. Run this command:
dsa_control -a dsm://<dsm_host_or_IP>:<port>/
where:
<dsm_host_or_IP> is replaced with the Deep Security Manager hostname or IP address,
and
<port> is replaced with the Deep Security Manager heartbeat port, which is 4120, by
default.
For details on this command, including additional parameters, see "Command-line basics"
on page 1348.
l Activate the agent through an event-based task ("Computer Created (by System)" event) to
automatically activate computers when they connect to the manager or when the manager
syncs with an LDAP directory, cloud account, or vCenter. For more information, see
"Automatically perform tasks when a computer is added or changed (event-based tasks)"
on page 1381.
Before activation, the agent or appliance will have one of these statuses:
l No Agent/Appliance: Indicates one of the following situations:
l No agent or appliance is running or listening on the default port.
l An agent or appliance is installed and running but is working with another manager
and communications are configured as agent/appliance-initiated. In this case, the
295
Trend Micro Deep Security On-Premise 20
agent or appliance is not listening for this manager. To correct this situation, deactivate
the agent from the computer.
l Activation Required: The agent or appliance is installed and listening, and is ready to be
activated by the manager.
l Reactivation Required: The agent or appliance is installed and listening and is waiting to
be reactivated by the manager.
l Deactivation Required: The agent or appliance is installed and listening, but has already
been activated by another manager.
l Unknown: The computer has been imported (as part of an imported Computers list) without
state information, or has been added by way of an LDAP directory discovery process.
After a successful activation, the agent or appliance state is Online. If the activation failed, the
computer status is Activation Failed with the reason for the failure in brackets. Click this link to
display the system event for more details on the reason for the activation failure.
Note: Although IPv6 traffic is supported by Deep Security 8.0 and earlier agents and
appliances, it is blocked by default. To allow IPv6 traffic on Deep Security 8.0 Agents and
Appliances, open a Computer or Policy editor 1 and go to Settings > Advanced > Advanced
Network Engine Settings. Set the Block IPv6 for 8.0 and Above Agents and Appliances
option to No.
Deactivate the agent
If you want to transfer control of a computer from one Deep Security Manager installation to
another, you must deactivate the agent or appliance with its current manager, and then re-
activate it with the new manager.
You can normally deactivate the agent or appliance from the Deep Security Manager that is
currently managing the agent or appliance. If the Deep Security Manager cannot communicate
with the agent or appliance, you may have to perform the deactivation manually. To run the
commands below, you must have administrator privileges on the local machine.
To deactivate the agent on Windows:
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
296
Trend Micro Deep Security On-Premise 20
1. From a command line, change to the agent directory (Default is C:\Program Files\Trend
Micro\Deep Security Agent)
2. Run the following: dsa_control -r
To deactivate the agent on Linux:
1. Run the following: /opt/ds_agent/dsa_control -r
Start or stop the agent
To start or stop the agent on Windows:
l Start: sc start ds_agent
l Stop: sc stop ds_agent
To start or stop the agent on Linux:
Using SysV init scripts:
l Start: /etc/init.d/ds_agent start
l Stop: /etc/init.d/ds_agent stop
Using systemd commands:
l Start: systemctl start ds_agent
l Stop: systemctl stop ds_agent
To start or stop the agent that is embedded on the Deep Security Virtual Appliance, see "Start or
stop the appliance" on page 382.
Deploy Deep Security Virtual Appliance
Protection for VMware environments
Trend Micro Deep Security has worked closely with VMware to offer agentless security at the
hypervisor level. This security is provided by the Deep Security Virtual Appliance. The appliance
is deployed at the cluster level through NSX Manager to offer protection to VMs on the same
ESXi host.
Topics on this page:
297
Trend Micro Deep Security On-Premise 20
l "Deep Security Virtual Appliance features" below
l "VMware deployments with the virtual appliance and NSX" on the next page
l "VMware deployments with the agent only" on page 301
l "Additional information" on page 301
Deep Security Virtual Appliance features
Scan caching
The scan cache allows the results of an Anti-Malware scan to be used when scanning multiple
machines with the same files. When the appliance scans the original guest virtual machine, it
keeps track of attributes of the files it is scanning. When other virtual machines are scanned, it
can compare these attributes for each file. This means that subsequent files with the same
attributes do not need to be scanned fully a second time, which reduces the overall scan time. In
situations like virtual desktop infrastructure (VDI) where the images are nearly identical, the
performance savings from scan cache are greater.
Scan storm optimization
A 'scan storm' occurs where many scans occur concurrently, causing performance slowdowns.
Typically, scan storms occur in large-scale VDI deployments. When performing Anti-Malware
scanning, the appliance can use the scan cache feature to optimize its resource usage during a
scan storm.
Ease of management
Generally, deploying one Deep Security Virtual Appliance to each ESXi host is easier than
deploying a Deep Security Agent on multiple VMs. With NSX, this management savings
increases because NSX Manager automatically deploys Deep Security the service when you
add a new ESXi host to the cluster.
The virtual appliance can also help with network flexibility. Each Deep Security Agent requires
network connectivity to resolve the Deep Security Manager and Relay. By using the Deep
Security Virtual Appliance, this network connectivity is limited to the virtual appliance and
connectivity to each VM is not required.
In some cases, the infrastructure and VMs may be managed by different teams. By using the
virtual appliance, the infrastructure team does not require access to the virtual machine to add
298
Trend Micro Deep Security On-Premise 20
protection because it can be deployed at the hypervisor level to protect each of the virtual
machines.
VMware deployments with the virtual appliance and NSX
If you want to use the Deep Security Virtual Appliance to protect your guest VMs, you'll need to
use VMware NSX Data Center for vSphere (NSX-V) or NSX-T Data Center. NSX-V and NSX-T
have several license types. These license types are shown in the table below, along with the
Deep Security features supported by each.
Note: For a more detailed list of supported features and sub-features that are supported by the
Deep Security Virtual Appliance, see "Deep Security Virtual Appliance 20 (NSX) supported
guest OS's" on page 160.
Deep Security Virtual Appliance deployment
NSX for vSphere (NSX-V) 6.4.x
NSX for vSphere (NSX-V) 6.4.x and
NSX-T 3.x
NSX
Data
Standar NSX
Center Data
d
Standar NSX NSX Center
NSX Data
Or d Data Data for
Enterpris Center
Advance Center Center Remot
NSX for e Or Profession
d Advance Enterpris e
vShield al
NSX for d e Plus Office
Endpoin Branch
vShield
t (free) Office
Endpoin
t (free)
Anti-
✔1 ✔1 ✔1 ✔1 ✔1 ✔1 ✔1 ✔1
Malware
Integrity
Monitorin ✔1 ✔1 ✔1 ✔1 ✔1 ✔1 ✔1 ✔1
g
299
Trend Micro Deep Security On-Premise 20
Deep Security Virtual Appliance deployment
NSX for vSphere (NSX-V) 6.4.x
NSX for vSphere (NSX-V) 6.4.x and
NSX-T 3.x
NSX
Data
Standar NSX
Center Data
d
Standar NSX NSX Center
NSX Data
Or d Data Data for
Enterpris Center
Advance Center Center Remot
NSX for e Or Profession
d Advance Enterpris e
vShield al
NSX for d e Plus Office
Endpoin Branch
vShield
t (free) Office
Endpoin
t (free)
Firewall X ✔ ✔ X X ✔ ✔ ✔
Intrusion
Preventio X ✔ ✔ X X ✔ ✔ ✔
n
Web
Reputatio X ✔ ✔ X X ✔ ✔ ✔
n
Log
X X X X X X X X
Inspection
Applicatio
X X X X X X X X
n Control
1 Available on Windows guest VMs only
If a feature is not supported by the appliance (X), it can be procured through the agent. When you
install agents to supplement the virtual appliance's functionality, this is known as combined
mode.
Some key points when considering combined mode:
l Management: Deep Security has deployment scripts that can be used to script the
deployment of the Deep Security Agent using various orchestration tools (Chef, Puppet,
300
Trend Micro Deep Security On-Premise 20
etc). Using the deployment scripts allows for easier deployment of the agent. These scripts
also allow activation and assignment of policy. They help to reduce the manual
intervention required and reduce the management cost when deploying the agent in a
VMware environment.
l "Scan caching" on page 298 performance improvements and "Scan storm optimization" on
page 298: In combined mode, the virtual appliance will do scan caching and scan storm
optimization for Anti-Malware scanning. This allows the agent footprint on each VM to
remain small because only a network driver needs to be installed.
For details on how to set up the Deep Security Virtual Appliance environment, see "Deploy the
appliance (NSX-T 3.x)" on page 308, or "Deploy the appliance (NSX-V)" on page 341
VMware deployments with the agent only
If you want to protect VMware environments without the virtual appliance or NSX, you can do so
by deploying the Deep Security Agent to each of your VMs. In this scenario, you don't need the
Deep Security Virtual Appliance, since all protection is provided by the agents. By using the
Deep Security Agent, you get all of main features of Deep Security, namely: Anti-Malware,
Integrity Monitoring, Firewall, Intrusion Prevention, Web Reputation, Log Inspection, and
Application Control. In addition, the agent has the following characteristics:
l It is lightweight (a Smart Agent). Only the protection modules that you specify (for example,
Anti-Malware and Integrity Monitoring) are installed using a policy that you set up on the
manager. Further, Deep Security has a feature called 'recommendation scanning', which
allows you to only assign rules necessary for the specific workload you are protecting.
l Windows agents include an Anti-Malware scan cache, containing hashes of previously-
scanned files that are frequently accessed, so that they don't need to be rescanned.
To deploy agents, Trend Micro has provided deployment scripts that can be used with various
orchestration tools (Chef, Puppet, etc). You can also install the agent manually.
Additional information
l Trend Micro and VMware Website: https://www.trendmicro.com/VMware/
301
Trend Micro Deep Security On-Premise 20
Choose agentless vs. combined mode protection
If you are protecting virtual machines (VMs) you can install Deep Security Agent, just as you
would for other types of computers. But in Deep Security 9.6 or later, there are two other ways to
protect VMs:
l Agentlessly (via virtual appliance), or
l Mixture of agent-based and agentless ("combined mode")
Agentless protection
Anti-malware and Integrity Monitoring protection can be provided without installing Deep
Security Agent. Instead, the VMware Tools driver installed on the VM can offload security
processing to a Deep Security Virtual Appliance.
Note: On Linux VMs, Deep Security Agent provides anti-malware protection, not the Deep
Security Virtual Appliance.
Note: In Deep Security 9.5 or earlier, to protect VMs without installing a Deep Security Agent,
you would use the Deep Security Virtual Appliance and filter driver. The filter driver was
installed on the ESXi server and was used to intercept network traffic at the hypervisor, and
send it to the appliance. VMware does not support vShield (VMsafe-NET API driver)
anymore, so the old driver is not supported by Deep Security 20, and must be removed.
Because agentless protection requires fast connectivity between the appliance and the
computer you want to protect, don't use agentless if the computer is far from the appliance, on a
remote ESXi server or another data center.
See also "Deploy the appliance in a vCloud environment" on page 364.
Combined mode
If you require other protection features that Deep Security Virtual Appliance doesn't support, you
must install the Deep Security Agent on each of your VMs, but you can still use the Deep
Security Virtual Appliance to provide some of the protection, which can improve performance.
Both the appliance and agent used together is known as "combined mode".
302
Trend Micro Deep Security On-Premise 20
With combined mode, the appliance provides the anti-malware and integrity monitoring. The
Deep Security Agent provides other features.
Conversion of coordinated approach to combined mode
l Coordinated approach — In Deep Security 9.5, if the agent on a VM was offline, protection
features would be provided by the Deep Security Virtual Appliance instead as an
alternative. However, it could not be configured separately for each feature.
l Combined mode — In Deep Security 9.6, each protection feature was configurable to use
either the agent or appliance. However, if the preferred protection source was offline, the
computer didn't use the other alternative.
In Deep Security 10.0 and later, its "protection source" settings provide both behaviors:
l whether each feature is provided by the agent or appliance
l whether to use the agent or appliance alternative if the preferred protection is not available
So if you need behavior like the old coordinated approach, you might want to avoid upgrading to
Deep Security 9.6, and instead upgrade from Deep Security 9.5 to Deep Security 10.0 and then
to 12.
Choose an agent or appliance for each protection feature
If a computer could be protected by either an appliance or agent, you can select which will
provide each protection feature.
Note: Log inspection and application control do not have this setting. With current VMware
integration technologies, Deep Security Virtual Appliance cannot provide those features.
To configure the protection source, import a VMware vCenter into Deep Security Manager, then
in the Computer or Policy editor 1, go to Settings > General.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
303
Trend Micro Deep Security On-Premise 20
For each protection module or group of protection modules, select either:
l Appliance Only: Only the Deep Security Virtual Appliance will provide protection, even if
there is an agent on the VM and the appliance is deactivated or removed.
Warning: Don't use the appliance if you require the scanner (SAP). It requires Deep
Security Agent anti-malware.
Tip: When anti-malware is enabled on the agent, the agent downloads the Anti-malware
Solution Platform (AMSP) and starts it as a service. If you do not want this, then from
Anti-Malware, select Appliance Only. That way, even if the appliance is deactivated, the
agent won't start the AMSP service.
l Appliance Preferred: If there is an activated appliance on the ESXi server, it will provide
the protection. But if the appliance is deactivated or removed, then the agent will provide
protection instead.
l Agent Only:Only the agent will provide protection, even if there is an activated appliance
available.
l Agent Preferred: If there is an activated agent on the VM, it will provide the protection. But
if there is no activated agent, then the appliance will provide protection instead.
Enable combined mode in a vCloud Director environment with agent-initiated
activation
When the hostname of a vCloud Director virtual machine is not resolvable from Deep Security
Manager, use agent-initiated activation to enable combined mode. To enable combined mode
on a vCloud Director virtual machine:
304
Trend Micro Deep Security On-Premise 20
1. Go to Computers, right-click on the target vCloud Director computer, and select Activate.
2. Double-click the target vCloud Director computer, and select Settings > General in the
pop-up window. Change the Communication Direction to Agent/Appliance Initiated.
3. Install Deep Security Agent on the target vCloud Director computer, and activate the agent.
Before deploying the appliance
Before you deploy the Deep Security Virtual Appliance, complete the tasks below.
Note: If you want to upgrade the appliance, see instead "Upgrade Deep Security Virtual
Appliance" on page 1303
Review system requirements
l Review this table to see which NSX licenses and versions are supported.
l Review these system requirements.
Install or upgrade NSX, Deep Security Manager and other components
After reviewing the system requirements, do the following:
l Install or upgrade NSX and make sure you're using a license that supports the features you
want.
l Install or upgrade Deep Security Manager.
l Install or upgrade other required software and hardware.
Re-register NSX-T
Read this section if you previously added NSX-T to Deep Security Manager using the
instructions in "Add a VMware vCenter" on page 433.
You may need to re-register NSX-T.
305
Trend Micro Deep Security On-Premise 20
To check whether NSX-T needs to be re-registered:
1. Go to NSX-T Manager and click System > Service Deployments > CATALOG.
2. Make sure both Endpoint Protection Policy and Intrusion Detection and Prevention
Systems are present, as shown in the image below. If not, it means a re-registration is
required.
To re-register NSX-T:
1. Uninstall Deep Security from your NSX environment. See "Uninstall Deep Security from
your NSX environment" on page 1331 for details.
2. Re-register NSX in the manager. See "Add a VMware vCenter" on page 433.
Set up communication
l Allow inbound and outbound communication to and from the appliance on the appropriate
port numbers. See "Deep Security port numbers" on page 179.
l Make sure the virtual appliance—known as a 'service VM' in VMware terminology—can
communicate with the partner Service Manager (console) at the management network
level. For details, see this NSX 3.0 help page or this NSX-V help page.
(Optional) Install Deep Security Agents
l If the features you want are not available agentlessly, install agents on your VMs and use
'combined mode' so that protection duties are shared by the virtual appliance and agent.
l If you configured guest VMs to have direct access to a network card, install agents on
those VMs. In this case there is no opportunity to intercept packets and an in-guest agent is
preferable. See "Choose agentless vs. combined mode protection" on page 302 for details.
306
Trend Micro Deep Security On-Premise 20
(Optional) Configure high-availability
If you want to use VMware Distributed Resource Scheduler (DRS) for high availability (HA),
configure DRS.
Next steps
You are now ready to deploy the appliance. Proceed to one of these pages depending on your
VMware environment:
l "Deploy the appliance (NSX-T 3.x)" on the next page
l "Deploy the appliance (NSX-V)" on page 341
l "Deploy the appliance in a vCloud environment" on page 364
Configure VMware DRS
If you're planning on using VMware Distributed Resource Scheduler (DRS) for high availability
(HA), configure DRS before installing the Deep Security Virtual Appliance. After DRS is
configured, deploy the virtual appliance on all ESXi servers (including backup ESXi servers),
and use affinity settings "pin" them to each ESXi server. This ensures that agentless protection
is still being applied after HA failover.
Warning: If DRS moves a VM from an ESXi server that has an appliance to one that doesn't,
the VM will become unprotected. If the VM then returns to the original ESXi server, it still won't
be protected again unless you create an event-based task to re-activate and protect a VM
when it is moved onto an ESXi server with an appliance. For more information, see
"Automatically perform tasks when a computer is added or changed (event-based tasks)" on
page 1381.
Warning: Don't apply vMotion to the appliance. Keep each appliance on its specific ESXi
server: in the DRS settings, select Disabled (recommended) or Manual. Alternatively, deploy
the appliance onto local storage, not shared storage. When the virtual appliance is deployed
onto local storage, DRS won't apply vMotion. For more information, see your VMware
documentation.
307
Trend Micro Deep Security On-Premise 20
Deploy the appliance (NSX-T 3.x)
This section describes how to perform a fresh appliance deployment.
Note: If you want to upgrade an existing appliance deployment, see instead "Upgrade Deep
Security Virtual Appliance" on page 1303.
To deploy the appliance, follow these steps:
l "Import the appliance" below
l "Prepare Fabric settings" on the next page
l "Add vCenter to Deep Security Manager" on page 318
l "Install the appliance on NSX-T 3.x" on page 319
l "Create a group for protection" on page 325
l "Configure east-west security" on page 327
l "Configure Endpoint Protection" on page 331
l "Prepare for activation" on page 333
l "Trigger an activation and policy assignment" on page 339
l "Check that VMs are activated and assigned a policy" on page 339
l "Next steps (how to add new VMs)" on page 340
Import the appliance
After completing the tasks in "Before deploying the appliance" on page 305, you are ready to
import the appliance ZIP into Deep Security Manager.
Tip: As an alternative to importing the appliance ZIP, you can place the OVF file at a
URL location to make it faster for NSX to download. For details, see "Configure the appliance
OVF location" on page 378.
1. Go to:
https://help.deepsecurity.trendmicro.com/software.html
2. Download the Deep Security Virtual Appliance package. Check the version requirements
in system requirements.
308
Trend Micro Deep Security On-Premise 20
You can import multiple versions of the appliance. The manager will choose the newest
package.
3. On Deep Security Manager, go to Administration > Updates > Software > Local.
4. Click Import and upload the package to Deep Security Manager.
On import, Deep Security Manager also automatically downloads and imports an agent
that is compatible with the operating system of the virtual appliance VM. This agent has the
same protection modules as Deep Security Agent for 64-bit Red Hat Enterprise Linux.
5. If you want to specify a different embedded agent, go to Administration > System Settings
> Updates and look for Virtual Appliance Deployment. By default, the Virtual Appliance
Deployment option is set to Latest Available (Recommended). This indicates to the
manager to upgrade the virtual appliance to use the newest imported, embedded agent.
Change this setting, as required.
You have now imported the appliance. Continue to "Prepare Fabric settings" below.
Prepare Fabric settings
After completing the tasks in "Import the appliance" on the previous page, you are ready to
prepare Fabric settings.
l "Configure the User Interface Mode Toggle" below
l "Configure a Compute Manager" on the next page
l "Configure a Transport Zone" on page 311
l "Configure a Transport Node Profile" on page 312
l "Prepare the host" on page 314
l "Create a logical switch" on page 316
Configure the User Interface Mode Toggle
First, configure the user interface settings of NSX-T Manager so that you can access the different
mode for later configurations.
1. In NSX-T Manager, at the top, click System, and then click User Interface Settings on the
left.
309
Trend Micro Deep Security On-Premise 20
2. Set Toggle Visibility and Default Mode as you like.
Configure a Compute Manager
Next, add your vCenter as a Compute Manager:
1. Make sure the vCenter and ESXi servers have been configured for management.
2. In NSX-T Manager, at the top, click System, and then click Fabric > Compute Managers
on the left.
3. Click +ADD.
4. The New Compute Manager dialog box appears.
5. Fill in the fields with your vCenter information. In this example, the vCenter is
10.209.48.73.
310
Trend Micro Deep Security On-Premise 20
6. Click Add. The vCenter is added.
7. Verify that the vCenter's Registration Status is Registered, and its Connection Status is
Up.
You have now added your vCenter.
Configure a Transport Zone
Next, make sure an overlay transport zone exists, and if not create one:
Tip: If you already have a transport zone, you can use it and don't need to create one.
311
Trend Micro Deep Security On-Premise 20
1. Still in NSX-T Manager, go to System > Fabric > Transport Zones.
2. Check whether a transport zone with a Traffic Type of Overlay already exists.
3. If an overlay transport zone does not exist, click +ADD to create one.
The New Transport Zone dialog box appears.
4. Set the Name to the the transport zone name. Example: transport-zone-overlay.
5. Set the Traffic Type to Overlay.
6. Click ADD.
An overlay transport zone is created.
Configure a Transport Node Profile
Next, create a Deep Security transport node profile:
Tip: If you already have a Transport Node Profile, you can use it and don't need to create one.
1. Still in NSX-T Manager, on the left, click Fabric > Profiles, and then in the main pane, click
Transport Node Profiles.
2. Click + ADD to create a transport node profile.
The Add Transport Node Profile dialog box appears.
312
Trend Micro Deep Security On-Premise 20
3. Fill out the fields as follows:
l For the Name, enter a name. Example: transport-node-profile.
l For the Description, enter a description. Example: Transport Node Profile.
l Under New Node Switch, for the Type, select N-VDS.
l For the Mode, select either option. In the example, we selected Standard (All hosts).
l For the Name, enter a name for the switch. Example: n-vds-overlay.
l For the Transport Zone, select the transport zone created in the previous step.
Example: transport-zone-overlay.
l For the NIOC Profile, select nsx-default-nioc-hostswitch-profile.
l For the Uplink Profile, select nsx-default-uplink-hostswitch-profile.
l For the LLDP Profile, select either option.
l For the IP Assignment, select either option.
l Under Teaming Policy Switch Mapping, assign valid physical NICs to the Uplinks. In
the example, we assigned vmnic2 to uplink-1 (active).
313
Trend Micro Deep Security On-Premise 20
Note: The assigned NIC(s) must be available on the ESXi servers. In the example, our
ESXi hosts have vmnic2 which can be used for the N-VDS n-vds-overlay.
For details on any of the values, click
at the top of the dialog box.
The bottom portion of the dialog box now looks similar to the following:
4. After filling out the fields, click ADD.
A transport node profile called transport-node-profile is created.
Prepare the host
Next, apply the Deep Security transport profile to your clusters.
1. Still in NSX-T Manager, click Fabric > Nodes, and in the main pane click Host Transport
Nodes.
314
Trend Micro Deep Security On-Premise 20
2. From the Managed by drop-down list, select the vCenter you added previously. In this
example, the vCenter is 10.209.48.73.
3. Select a cluster that contains the VMs that you want to protect with Deep Security Virtual
Appliance. If there is more than one cluster, select all the ones that you want to protected
with Deep Security Virtual Appliance.
4. Click CONFIGURE NSX.
5. From the Select Deployment Profile drop-down list, select transport-node-profile or
whatever you called your transport node profile.
315
Trend Micro Deep Security On-Premise 20
6. Click SAVE. The following occurs:
l The Deep Security transport node profile is applied to the clusters.
l While the profile is being applied, an Applying Profile message may appear and you
can check the installation progress on each node.
l When the operation finishes, each node's NSX Configuration changes to Success and
its Node Status changes to Up. If you have multiple ESXi servers, they should all be
marked with Success and Up.
You have now configured the target cluster.
Create a logical switch
Next, create a logical switch for the transport zone you used previously.
Tip: If you already have a logical switch, you can use it and don't need to create a new one.
1. Still in NSX-T Manager, at the top, click Networking and toggle to MANAGER.
2. On the left, click Logical Switches.
3. In the main pane, click + ADD.
The Add New Logical Switch dialog box appears.
4. On the General tab:
l For the Name, enter a name for your logical switch. Example: logical-switch-
overlay.
l For the Transport Zone, choose the overlay transport zone created previously.
Example: transport-zone-overlay.
l For the Uplink Teaming Policy Name, select [Use Default].
l For the Admin Status, keep the default value.
l For the Replication Mode, select either option.
l For the VLAN, leave the field blank.
316
Trend Micro Deep Security On-Premise 20
5. On the Switching Profiles tab, select the profile you want for each item. In the example, we
kept [Use Default Profile] for all items.
317
Trend Micro Deep Security On-Premise 20
6. Click ADD.
A logical switch is created. You can check the switch status on your host(s) through
vSphere Client.
You have now prepared the Fabric settings in NSX-T Manager. Continue to "Add vCenter
to Deep Security Manager" below.
Add vCenter to Deep Security Manager
After completing the tasks in "Prepare Fabric settings" on page 309, you are ready to add
vCenter.
Follow the instructions in "Add a VMware vCenter" on page 433.
318
Trend Micro Deep Security On-Premise 20
After you have finished:
l your guest VMs are displayed in Deep Security Manager.
l the Trend Micro Deep Security service is registered with NSX-T.
Continue to "Install the appliance on NSX-T 3.x" below.
Install the appliance on NSX-T 3.x
After completing the tasks in "Add vCenter to Deep Security Manager" on the previous page, you
are ready to install the appliance on NSX-T 3.x.
Follow these instructions:
l "Begin the service deployment" below
l "Configure and start the service deployment" on the next page
l "Monitor and verify the deployment" on page 323
l "Monitor and verify the deployment" on page 323
l "Repeat all steps for each cluster" on page 325
Begin the service deployment
1. In NSX-T Manager, click System, and then on the left, select Service Deployments.
2. From the Partner Service drop-down list, select Trend Micro Deep Security. This Trend
Micro Deep Security service was registered when you added your vCenter in Deep
Security Manager previously.
3. Click DEPLOY SERVICE.
A blue panel appears.
319
Trend Micro Deep Security On-Premise 20
4. Fill out the blue panel as described in "Configure and start the service deployment" below.
Configure and start the service deployment
Fill out the service deployment fields as described below and then click SAVE to begin the
deployment.
Set the Service Deployment Name
In the Service Deployment Name field, enter a name. If you have multiple clusters, consider
using a name that includes the name of the cluster of which you're deploying. The cluster is
listed under the Cluster heading on the same page. Example: dsva-vc73-cluster.
Set the Compute Manager
From the Compute Manager drop-down list, select the vCenter you added previously. In our
example, the vCenter is 10.209.48.73.
Set the Cluster
From the Cluster drop-down list, select a cluster you configured previously. The Trend Micro
Deep Security service will be installed to all the ESXi servers in this cluster. If you have multiple
clusters, pick one now. You can come back later to pick another cluster.
Set the Data Store
From the Data Store drop-down list, select the option that is appropriate for your environment. In
our example, we selected Specified on Host.
Set the Networks
Under Networks:
320
Trend Micro Deep Security On-Premise 20
1. Click Set or Edit Details, whichever is available.
2. Select the ens0 - Management Nic check box.
3. Choose the Network and Network Type you want to use.
4. Enable the ens2 - Data-1 NIC check box to obtain east-west security functionality.
5. Click SAVE to save your network settings.
Set the Deployment Specification
From the Deployment Specification drop-down list:
1. Select the Deep Security -<version>-SMALL - small, MEDIUM - medium, or LARGE -
large option, depending on the size of your deployment. If you're not sure of the size of
your deployment, review the information in "Deep Security Virtual Appliance sizing" on
page 176. In our example, we selected Deep Security - 12.0.0-682-SMALL - Small.
2. If you previously configured the OVF at a URL location, make sure to select the same size
OVF as you did before. For example, if you configured the URL of the small OVF
previously, then make sure to select the small OVF under Deployment Specification.
3. Click
to view the OVF URL from which NSX will download the appliance OVF.
321
Trend Micro Deep Security On-Premise 20
Note: If you specified a different URL for the OVF, then that URL will be used instead.
Set the Service Segment
From the Service Segment drop-down list, select a service segment that is configured to use
your overlay transport zone.
If you do not yet have a service segment, create one as follows:
1. Click Action.
The Service Segment dialog box appears.
2. Click ADD SERVICE SEGMENT.
3. Under Name, enter a name such as service-segment.
4. Under Transport Zone (Overlay), select transport-zone-overlay or whichever overlay
transport zone you're using.
5. Leave Connected To empty.
322
Trend Micro Deep Security On-Premise 20
6. Click SAVE and then CLOSE. A service segment is created.
7. From the Service Segments drop-down list, select the service segment you just created.
Set the Deployment template
1. From the Deployment Template drop-down list, select Deep Security - Deployment
Template.
2. (Optional) If you would like to configure the CPU usage of the appliance in DPDK mode
click Configure Attributes and modify the dpdkMode field. For details on DPDK and how
to it works with the appliance, see "Configure DPDK mode" on page 374.
Your service deployment details should look similar to the following:
Monitor and verify the deployment
After starting the deployment, you can monitor it in NSX-T 3.x and vSphere Client, and then
verify it in Deep Security Manager.
323
Trend Micro Deep Security On-Premise 20
Monitor the deployment in NSX-T 3.x
The Status column in NSX-T Manager indicates In Progress.
When the deployment is finished, the Status changes to Up.
If you have multiple ESXi servers in the assigned cluster, then a Trend Micro Deep Security
service is deployed onto each ESXi server. The services will be labeled as follows to
differentiate them.
l Trend Micro_Deep Security - SMALL (1) (for the first ESXi server)
l Trend Micro_Deep Security - SMALL (2) (for the second ESXi server)
l ... and so on.
Monitor the deployment in vSphere Client
You can check the status of the deployment by accessing vCenter through the vSphere Client.
The vSphere Client shows the progress in more detail. Wait until the Status changes to
Complete.
In the image below, you see two Trend Micro Deep Security services listed on the left. Two
services were deployed because there were two ESXi servers in the cluster.
324
Trend Micro Deep Security On-Premise 20
Verify the deployment in Deep Security Manager
You can verify the deployment in Deep Security Manager by clicking Computers at the top and
then on the left, expanding the vCenter where the Trend Micro Deep Security service was
deployed.
Trend Micro_Deep Security (1) appears under Virtual Machines > Datacenter > ESX Agents
with a Platform of Deep Security Virtual Appliance. You see one virtual appliance per ESXi
server in your cluster.
Note: Although your VMs appear in Deep Security Manager, they are not yet protected.
Repeat all steps for each cluster
Repeat all the steps in "Install the appliance on NSX-T 3.x" on page 319 for each cluster.
You have now installed the appliance on NSX-T 3.x. Continue to "Create a group for protection"
below.
Create a group for protection
After completing the tasks in "Install the appliance on NSX-T 3.x" on page 319, you are ready to
create a group that will contain the VMs you want to protect with the Deep Security Virtual
Appliance:
1. In NSX-T Manager, at the top, click Inventory, toggle to POLICY, and then on the left, click
Groups.
2. Click ADD GROUP to create a group which will contain the VMs protected by Deep
Security Virtual Appliance. Fill out the fields as follows:
l For the Name, enter a name for your group. Example: dsva-protection-group.
l For the Compute Members, click Set Members and select which VMs will go in the
group.
325
Trend Micro Deep Security On-Premise 20
Note: The following instructions demonstrate the simplest way to add members. For
more complex ways, such as the use of Membership Criteria, see the NSX-T
documentation.
3. Click Members (0) at the top, and then select VirtualMachine (selected: 0) in the Select
Category drop-down list.
4. Click Refresh at this bottom if your VMs are not visible.
5. Select the guest VMs you want to add to the group. These VMs will become protected by
the Deep Security Virtual Appliance.
Your Select Members dialog box now looks similar to the following:
6. Verify the VM count in the Members tab near the top. In the example above, the count is 2 -
Members (2).
7. Click APPLY.
The ADD GROUP page now shows an updated count.
326
Trend Micro Deep Security On-Premise 20
8. Click SAVE.
You have now added a group with some members. You may repeat the steps to create
more groups.
Continue to "Configure east-west security" below.
Configure east-west security
After completing the tasks in "Create a group for protection" on page 325, you are ready to
configure east-west security. Configuring east-west security is necessary to enable the
networking functionality required for the Integrity Monitoring, Intrusion Prevention, Firewall, and
Web Reputation features.
Follow the steps below to configure east-west security:
l "Add a service profile" below
l "Add a service chain" on the next page
l "Add a Network Introspection policy" on page 330
l "Connect VMs to the logical switch" on page 331
Add a service profile
1. In NSX-T Manager, click Security at the top, toggle to POLICY, and then on the left, find
Settings and click Network Introspection Settings.
2. In the main pane, click SERVICE PROFILES.
3. From the Partner Service drop-down list, select Trend Micro Deep Security if it is not
already selected.
4. Click ADD SERVICE PROFILE and fill out the fields as follows:
l For the Service Profile Name, specify a name. Example: dsva-service-profile-
ni.
l For the Service Profile Description, enter a description. Example: Deep Security
Service Profile for Network Introspection.
l For the Vendor Template, select Default (EBT)_Network. This template was loaded
at the same time as the Trend Micro Deep Security service.
327
Trend Micro Deep Security On-Premise 20
5. The ADD SERVICE PROFILE page should now look similar to the following:
6. Click SAVE.
Add a service chain
1. On the main pane, click the SERVICE CHAINS tab, and click ADD CHAIN. Fill out the
fields as described in the following steps.
2. For the Name, specify a name. Example: dsva-service-chain.
3. For the Service Segments, select the service segment created previously. Example:
service-segment.
4. For the Forward Path:
l Click Set Forward Path to open the dialog box.
l Click ADD PROFILE IN SEQUENCE and add the service profile created previously.
In the example, we selected dsva-service-profile-ni.
l Click ADD.
l Click SAVE.
328
Trend Micro Deep Security On-Premise 20
You're now back on the main SERVICE CHAINS page. Continue with the
SERVICE CHAIN configuration below.
5. For the Reverse Path, keep the Inverse Forward Path check box selected.
6. For the Failure Policy, select Allow.
The service chain should now look like the following:
7. Click SAVE.
329
Trend Micro Deep Security On-Premise 20
Add a Network Introspection policy
1. Click Security at the top, toggle to POLICY, and then on the left, find East West Security
and click Network Introspection (E-W).
2. In the main pane, click + ADD POLICY.
3. In the Name column, click within the New Policy cell and change the name. For example,
use dsva-policy-ni. For Redirect To, select the service chain. In this example, we used
dsva-service-chain.
4. Select the check box next to dsva-policy-ni and click + ADD RULE. A rule appears under
dsva-policy-ni. Click + ADD RULE again because we need 2 rules.
5. Configure the 1st rule for inbound traffic:
l For the Name, enter a name for the rule. Example: rule-in.
l For the Sources, keep Any.
l For the Destinations, select dsva-protection-group.
l For the Services, keep Any.
l For the Applied To, select dsva-protection-group.
l For the Action, select Redirect.
6. Configure the 2nd rule for outbound traffic:
l For the Name, enter a name for the rule. Example: rule-out.
l For the Sources, select dsva-protection-group.
l For the Destinations, keep Any.
l For the Services, keep Any.
l For the Applied To, select dsva-protection-group.
l For the Action, select Redirect.
There is now a mapping between the VMs in the dsva-protection-group and the Default
(EBT)_Network template specified in the dsva-service-chain.
The policy should now look similar to the following:
330
Trend Micro Deep Security On-Premise 20
7. Click PUBLISH to finish the policy and rule creation.
Connect VMs to the logical switch
In order for the VMs in your group to be protected by east-west security in NSX-T, those VMs
connected to the logical switch created in an earlier step.
In the example, we connected the Network adapter 1 to logical-switch-overlay. You can check
that your VMs are connected to this switch by accessing vCenter through vSphere Client.
You have now configured east-west security in NSX-T. Continue to "Configure Endpoint
Protection" below.
Configure Endpoint Protection
After completing the tasks in "Configure east-west security" on page 327, you are ready to
configure Endpoint Protection. Configuring Endpoint Protection is required in order to protect
existing VMs with Deep Security Virtual Appliance's Anti-Malware feature.
Follow the steps below to configure a service profile for the Deep Security Virtual Appliance:
331
Trend Micro Deep Security On-Premise 20
1. Still in NSX-T Manager, click Security at the top, select POLICY at the top, and then on the
left, find Endpoint Protection and click Endpoint Protection Rules.
2. In the main pane, click SERVICE PROFILES.
3. From the Partner Service drop-down list, select Trend Micro Deep Security if it is not
already selected.
4. Click ADD SERVICE PROFILE and fill out the fields as follows:
l For the Service Profile Name, specify a name. Example: dsva-service-profile-
epp.
l For the Service Profile Description, enter a description. Example: Deep Security
Service Profile for Endpoint Protection.
l For the Vendor Template, select Default (EBT). This template was loaded at the
same time as the Trend Micro Deep Security service.
The ADD SERVICE PROFILE page should now look similar to the following:
5. Click SAVE.
6. On the main pane, select the RULES tab and click + ADD POLICY.
7. In the Name column, click within the New Policy cell and change the name. For example,
use dsva-policy-epp.
8. Select the check box next to dsva-policy-epp and click + ADD RULE. A rule appears
under dsva-policy-epp.
9. Name the rule and select the corresponding groups and service profiles. For example,
name the rule dsva-rule-epp, and select dsva-protection-group and dsva-service-
332
Trend Micro Deep Security On-Premise 20
profile-epp. There is now a mapping between the VMs in the dsva-protection-group and
the Default (EBT) template specified in the dsva-service-profile-epp.
The policy should now look similar to the following:
10. Click PUBLISH to finish the policy and rule creation.
You have now configured Endpoint Protection in NSX-T. Continue to "Prepare for
activation" below.
Prepare for activation
After completing the tasks in "Configure Endpoint Protection" on page 331, you are ready to
prepare for activation.
To prepare for activation, you can use Method 1, 2, or 3:
l Method 1: Create a 'Computer Created' event-based task
l Method 2: Create an 'NSX Security Group Change' event-based task
l Method 3: Synchronize your Deep Security policies to NSX
Not sure which method to choose? Here is some information to help:
l Some methods aren't supported with some NSX versions. Consult the table below
for details.
l Method 1 requires less setup work but only protects newly-created VMs. To
protect existing VMs, you'll need to trigger an activation and policy assignment
manually, in the manager. This manual step is explained in a later section.
l Method 2 also requires less setup work, and protects both newly-created and
existing VMs.
333
Trend Micro Deep Security On-Premise 20
l Method 3 requires more setup work, and protects newly-created and existing VMs.
With this method, your Deep Security policies are duplicated in NSX. Choose this
method if you want to assign policies through the NSX UI. For more information,
see "Synchronize Deep Security policies with NSX" on page 373.
Deep Security Virtual Appliance deployment
NS
NSX for vSphere (NSX-V) 6.4.x X-T
3.x
Stand NSX
ard Data
Cent
OR NSX NSX er for
NSX NSX All
Data Data Rem
NSX Data Data licen
Metho Enterpr Cente Center ote
for Advan Center Center se
d ise r Enterpr Offic
vShiel ced Professi Advan type
Stand ise e
d onal ced s
ard Plus Bran
Endpo ch
int Offic
(free) e
Meth
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
od 1
Meth
X ✔1 ✔1 X X ✔1 ✔1 ✔1 ✔
od 2
Meth
X ✔1 ✔1 X X ✔1 ✔1 ✔1 ✔
od 3
1 Requires VMware's Network Introspection Service.
• Requires the following software combination: Deep Security Manager FR 2019-12-12
(build 12.5.494) or newer with Deep Security Agent Linux FR 2020-04-02 (build 12.5.0-
814) or newer.
334
Trend Micro Deep Security On-Premise 20
Method 1: Create a 'Computer Created' event-based task
1. In Deep Security Manager, click Administration at the top.
2. On the left, click Event-Based Tasks.
3. In the main pane, click New.
4. From the Event drop-down list, select Computer Created (by System). Click Next.
5. Select Activate Computer and set it to 5 minutes.
6. Select Assign Policy and select a policy from the drop-down list, for example, Windows
Server 2016.You can click the arrows to view child policies. Click Next.
7. Specify the conditions that restrict when the event-based task is triggered. Add this
condition:
vCenter Name matches <your_vCenter_name>
8. Add more conditions to further restrict when the event-based task is triggered. For
example, if you have a naming convention for your VMs that includes a 'Windows' prefix on
all Windows VMs, you would set:
Computer Name matches Windows*
Click Next.
9. In the Name field, enter a name for the task that reflects the policy you assigned, for
example, Activate Windows Server 2016.
10. Select Task Enabled and then click Finish.
11. Create additional event-based tasks, one per Deep Security policy you plan on assigning.
The event-based task must have an event type of Computer Created (by System) and
must be configured to activate the computer and assign a policy.
You have now set up your event-based tasks to activate and assign policies to newly-
created VMs. As soon as a VM is created, all the Computer Created (by System) event-
based tasks are reviewed. If the conditions in a task are met, the task is triggered, and the
VM is activated and assigned the associated policy.
Method 2: Create an 'NSX Security Group Change' event-based task
To start, create or modify the Activate event-based task:
1. In Deep Security Manager, click Administration at the top.
2. On the left, click Event-Based Tasks.
3. In the main pane, look for the event-based task called Activate <your_vCenter_name> . It
may or may not exist.
335
Trend Micro Deep Security On-Premise 20
4. If the Activate event-based task exists, double-click it and review the table below make
sure it is configured properly. If it doesn't exist, click New and run through the wizard,
making sure to conform to the table below.
5. Create additional Activate event-based tasks if you added multiple vCenter servers to the
manager.
Note: Settings in the table below may appear in a different order from shown.
To configure the
'Activate' event-based To...
task, set...
A name for the task that reflects the action and vCenter assigned under
Name
Conditions, for example, Activate your_vCenter_name>.
NSX Security Group Change
Event The NSX Security Group Change event is triggered when the
manager receives a notification from the data plane (the Deep Security
Virtual Appliance).
Task Enabled Enabled.
Activate Computer 5 minutes.
A policy, for example, Windows Desktop.You can click the arrows to
Assign Policy
view child policies.
Mandatory condition to restrict when the event-based task is triggered:
l vCenter Name matches <your_vCenter_name>
Examples of optional conditions to further restrict triggering:
Conditions
l Appliance Protection Available matches True.
l Appliance Protection Activated matches False.
l NSX Security Group Name matches .+ (which means any)
Next, create or modify the Deactivate event-based task:
336
Trend Micro Deep Security On-Premise 20
1. Still in Deep Security Manager, in the main pane, look for the event-based task called
Deactivate <your_vCenter_name> . It may or may not exist.
2. If the Deactivate event-based task exists, double-click it and review the table below make
sure it is configured properly. If it doesn't exist, click New and run through the wizard,
making sure to conform to the table below.
3. Create additional Deactivate event-based tasks if you added multiple vCenter servers to
the manager.
Note: Settings in the table below may appear in a different order from shown.
To configure the
'Deactivate' event- To...
based task, set...
A name for the task that reflects the action and vCenter assigned
Name
under Conditions, for example, Deactivate your_vCenter_name>.
NSX Security Group Change
Event The NSX Security Group Change event is triggered when the
manager receives a notification from the data plane (the Deep
Security Virtual Appliance).
Task Enabled Enabled.
Deactivate
Enabled.
Computer
l Appliance Protection Activated matches True.
Conditions l NSX Security Group Name matches ^$ (which means none)
l vCenter Name matches <your_vCenter_name>
You have now set up your event-based tasks to activate your VMs. If the conditions in a task are
met, the task is triggered, and the VM is activated (and assigned the associated policy).
Method 3: Synchronize your Deep Security policies to NSX-T 3.x
To start, configure Deep Security Manager:
337
Trend Micro Deep Security On-Premise 20
1. Log in to Deep Security Manager.
2. Make sure that all of the policies in Deep Security Manager have a unique name before
they are synchronized with NSX. All the default ones have unique names.
3. At the top, click Computers.
4. On the left, right-click the vCenter where you want to enable synchronization and select
Properties.
5. On the NSX Configuration tab, select Synchronize Deep Security Policies with NSX
Service Profiles. Click OK.
Next, check that your policies are loading into NSX-T Manager:
1. In NSX-T Manager, click Security at the top, switch to the POLICY mode.
2. On the left, find Settings and click Network Introspection Settings.
3. In the main pane, click SERVICE PROFILES and from the Partner Service drop-down list,
select Trend Micro Deep Security.
4. Click ADD SERVICE PROFILE.
5. Check the Vendor Template drop-down list. Your Deep Security policies should appear in
this list in the format <Deep_Security_Policy_Name>_Network.
6. You have now checked that your policies are loading.
7. Click Cancel to return to the main page.
You have now added your Deep Security policies as vendor templates in NSX.
Finally, reconfigure east-west security and Endpoint Protection:
1. Go back to "Create a group for protection" on page 325 and run through the steps again to
create more groups. For example, Windows_Group.
2. Go back to "Configure east-west security" on page 327 and run through the steps again,
this time selecting one of the Deep Security policies from Vendor Template (instead of
Default (EBT)_Network) and selecting one of the new groups.
3. Go back to "Configure Endpoint Protection" on page 331 and run through the steps again,
this time selecting one of the Deep Security policies from Vendor Template (instead of
Default (EBT)) and selecting one of the new groups. The policy and group must match the
one use for east-west security.
338
Trend Micro Deep Security On-Premise 20
Warning: Make sure to match the template under east-west security and Endpoint
Protection for a particular group. For example, if you select MyWindowsPolicy_Network
under east-west security, select MyWindowsPolicy under Endpoint Protection.
You have now set up policy synchronization to activate VMs, including existing and newly-
created ones.
You have now finished preparing for activation. Continue to "Trigger an activation and policy
assignment" below.
Trigger an activation and policy assignment
After completing the tasks in "Prepare for activation" on page 333, you are ready to trigger an
activation and policy assignment.
If you chose Method 1, you can trigger an activation and policy assignment manually. For
instructions, see below.
If you chose Method 2 or 3, all VMs should be activated and assigned policy automatically now.
They are protected.
To activate and assign a policy through the Actions button:
1. Go to Deep Security Manager, click Computers at the top, and click your vCenter on the
left. Your guest VMs appear on the right.
2. Shift+click a set of VMs, right-click them and then select Actions > Assign Policy. Select a
policy and click OK. A Deep Security policy is assigned to your VMs.
3. Shift+click the same set of VMs, right-click them and then select Actions >
Activate/Reactivate.Your VMs are activated in Deep Security Manager. They are now
protected.
4. If you have additional, existing VMs you want to protect, repeat the procedure in this
section to assign a policy and activate them.
You have now triggered an activation and policy assignment. Continue to "Check that VMs are
activated and assigned a policy" below.
Check that VMs are activated and assigned a policy
After completing the tasks in "Trigger an activation and policy assignment" above, you must
check that VMs were activated and assigned a policy successfully.
To check:
339
Trend Micro Deep Security On-Premise 20
1. In Deep Security Manager, click Computers at the top.
2. On the left, expand Computers > <your_vCenter> > Virtual Machines.
3. Check the TASK(S) and STATUS and columns. (Click Columns at the top to add them if
they are not visible.) The TASK(S) column should indicate Activating, and your VMs
should move from the Unmanaged (Unknown) status, to the Unmanaged (No Agent)
status, to the Managed (Online) status. You may see the VMs move into the VMware
Tools Not Installed status, but this is temporary.
4. Check the POLICY column to make sure the correct Deep Security policy was assigned.
You have now deployed Deep Security Virtual Appliance and protected your VMs with it.
Continue to "Next steps (how to add new VMs)" below.
Next steps (how to add new VMs)
After completing the tasks in "Check that VMs are activated and assigned a policy" on the
previous page, you may need to know how to add new VMs.
Follow the instructions below to learn how to add new VMs to your system and protect them with
Deep Security.
To add a new VM if you chose Method 1 (create a 'Computer Created' event-based task):
l Create a new VM in vCenter. This triggers the Computer Created (by System) event-
based task, which activates and assigns policy to the new VM.
To add a new VM if you chose Method 2 (create an 'NSX Security Group Change' event-based
task):
l Create or move the VM into one of the NSX security groups. This triggers the NSX
Security Group Change event-based task, which activates and assigns policy to the new
VM.
To add a new VM if you chose Method 3 (synchronize Deep Security policies to NSX):
l Create or move the VM into one of the NSX security groups. This activates and assigns
policy to the new VM.
340
Trend Micro Deep Security On-Premise 20
Deploy the appliance (NSX-V)
After completing the tasks in "Before deploying the appliance" on page 305, you are ready to
deploy the appliance on NSX Data Center for vSphere (NSX-V). Follow the steps below.
l "Step 1: Import the appliance package into Deep Security Manager" below
l "Step 2: Add vCenter to Deep Security Manager" on the next page
l "Step 3: Prepare ESXi servers" on the next page
l "Step 4: Install Guest Introspection" on page 344
l "Step 5: Install the Deep Security Virtual Appliance on NSX-V" on page 347
l "Step 6: Create an NSX security group and policy" on page 348
l "Step 7: Prepare for activation on NSX-V" on page 356
l "Step 8: Trigger an activation and policy assignment" on page 362
l "Step 9: Check that VMs are activated and assigned a policy" on page 363
l "Next steps (how to add new VMs)" on page 363
You can also "Upgrade the appliance" on page 1307 to protect against new OS vulnerabilities.
Step 1: Import the appliance package into Deep Security Manager
After completing the tasks in "Before deploying the appliance" on page 305, you are ready to
import the appliance ZIP into Deep Security Manager.
Tip: As an alternative to importing the appliance ZIP, you can place the OVF file at a
URL location to make it faster for NSX to download. For details, see "Configure the appliance
OVF location" on page 378.
1. Go to:
https://help.deepsecurity.trendmicro.com/software.html
2. Download the Deep Security Virtual Appliance package. Check the version requirements
in system requirements.
You can import multiple versions of the appliance. The manager will choose the newest
package.
3. On Deep Security Manager, go to Administration > Updates > Software > Local.
341
Trend Micro Deep Security On-Premise 20
4. Click Import and upload the package to Deep Security Manager.
On import, Deep Security Manager also automatically downloads and imports an agent
that is compatible with the operating system of the virtual appliance VM. This agent has the
same protection modules as Deep Security Agent for 64-bit Red Hat Enterprise Linux.
5. If you want to specify a different embedded agent, go to Administration > System Settings
> Updates and look for Virtual Appliance Deployment. By default, the Virtual Appliance
Deployment option is set to Latest Available (Recommended). This indicates to the
manager to upgrade the virtual appliance to use the newest imported, embedded agent.
Change this setting, as required.
Step 2: Add vCenter to Deep Security Manager
Follow the instructions in "Add a VMware vCenter" on page 433.
After you have finished:
l your guest VMs are displayed in Deep Security Manager.
l the Trend Micro Deep Security service is registered with NSX-T.
Step 3: Prepare ESXi servers
If you are using NSX Advanced Edition or NSX Enterprise Edition, you must prepare your ESXi
servers by installing the drivers necessary for network traffic inspection. This operation is
performed on the cluster.
If you are using another NSX edition, skip this section.
1. In your vSphere Web Client, go to Home > Networking & Security > Installation > Host
Preparation:
342
Trend Micro Deep Security On-Premise 20
2. Locate the NSX cluster you are going to protect with Deep Security in the Clusters & Hosts
list and click Install in the Installation Status column. The installation will complete and the
driver version will be displayed in the Installation Status column:
ESXi host preparation is now complete. For more complete instructions on host
preparation, see VMware documentation.
343
Trend Micro Deep Security On-Premise 20
Step 4: Install Guest Introspection
If you want file-based protection such as Anti-Malware or Intrusion Prevention for your VMs, you
must install the Guest Introspection service on your ESXi servers.
The Guest Introspection service consists of a couple of drivers: the File Introspection (vsepflt)
driver and Network Introspection (vnetflt) driver.
Warning: If you do not install Guest Introspection, the Anti-Malware and Intrusion Prevention
features will not work.
1. In vSphere Web Client, go to Home > Networking & Security > Installation, then click the
Service Deployments tab.
2. Click the green plus icon ( ).
The Deploy Network & Security Services window appears.
3. Select Guest Introspection, then click Next.
344
Trend Micro Deep Security On-Premise 20
4. Select the cluster that contains the ESXi servers and VMs that you want to protect, then
click Next.
5. Select the datastore, the distributed port group used by your NSX cluster, and IP
345
Trend Micro Deep Security On-Premise 20
assignment method, then click Next.
6. Review your settings, then click Finish.
vSphere may take a few minutes to install the guest introspection service on your ESXi
servers. When it is finished, Installation Status will display "Succeeded". To update the
status, you may need to refresh the vSphere Web Client.
346
Trend Micro Deep Security On-Premise 20
Step 5: Install the Deep Security Virtual Appliance on NSX-V
1. In the vSphere Web Client, go to Home > Networking and Security > Installation >
Service Deployments.
2. Click the green plus sign ( ).
3. In the new window that appears, select the Trend Micro Deep Security service and then
click Next. If you do not see this service, it might be because you have not yet added your
vCenter to Deep Security Manager. For details, see "Step 2: Add vCenter to Deep Security
Manager" on page 342.
347
Trend Micro Deep Security On-Premise 20
4. Click Finish.
When deployment is complete, the Trend Micro Deep Security service appears in the list of
network and security service deployments in the cluster.
Step 6: Create an NSX security group and policy
To start, create an NSX security group that will contain the VMs you want to protect with the
Deep Security Virtual Appliance:
348
Trend Micro Deep Security On-Premise 20
1. In vSphere Web Client, go to Home > Networking & Security > Service Composer >
Security Groups.
2. Click New Security Group( ):
3. Define Dynamic Membership: If you want to restrict membership in this group based on
filtering criteria, enter those criteria here.
349
Trend Micro Deep Security On-Premise 20
4. Select the objects that will be included.
There are many ways to include or exclude objects in a NSX security group. For this
example, we will include the NSX cluster that contains the ESXi hosts and VMs that we
want to protect. In the Select objects to include options, select Cluster from the Object
Type menu, and move the NSX cluster that contains the VMs to protect to the Selected
Objects column.
350
Trend Micro Deep Security On-Premise 20
Note: If a VM is included in more than one security group, then when you go to
Computers in Deep Security Manager and search for the VM's name, it will appear more
than once in search results. For more information, please see Duplicate host records
appear in Computer page when the host is located in more than one NSX security group.
5. Click Finish to create the new security group and return to the Security Groups tab to see
the newly listed security group.
351
Trend Micro Deep Security On-Premise 20
Next, create an NSX security policy:
1. In vSphere Web Client, go to Home > Networking and Security > Service Composer >
Security Policies.
2. Click New Security Policy.
3. Guest Introspection Services: Configure Guest Introspection Services if you are using the
Anti-Malware or Intrusion Prevention modules.
Warning: If you do not install Guest Introspection, the Anti-Malware and Intrusion
Prevention features will not work.
Click the green plus sign ( ) to add an Endpoint Service. Provide a name for the
Endpoint Service and select the following settings:
352
Trend Micro Deep Security On-Premise 20
l Action: Apply
l Service Name: Trend Micro Deep Security
l Service Profile: Select Default (EBT). This is a profile configuration that is configured
to trigger event-based task(s) in Deep Security Manager.
l State: Enabled
l Enforce: Yes
Click OK, then click Next.
4. Firewall Rules: do not make any changes. Click Next.
5. Network Introspection Services: Network Introspection Services are only available with
NSX Advanced and Enterprise, and only need to be configured if you are using the Web
Reputation, Firewall, or Intrusion Prevention modules. You will be adding two Network
Introspection Services to the NSX Security Policy: a first one for outbound traffic, and a
second one for inbound traffic.
a. For the first, outbound, service, in the Network Introspection Services options, click
the green plus sign to create a new service. In the Add Network Introspection Service
window, provide a name for the service (preferably one that includes the word
"Outbound") and select the following settings:
353
Trend Micro Deep Security On-Premise 20
l Action: Redirect to service
l Service Name: Trend Micro Deep Security
l Service Profile: Select Default (EBT)
l Source: Policy's Security Groups
l Destination: Any
l Service: Any
l State: Enabled
l Log: Do not log
b. For the second, inbound, service, in the Network Introspection Services options, click
the green plus sign to create a new service. In the Add Network Introspection Service
window, provide a name for the service (preferably one that includes the word
"Inbound") and select the following settings:
l Redirect to service: Yes
l Service Name: Trend Micro Deep Security
l Service Profile: Select Default (EBT)
354
Trend Micro Deep Security On-Premise 20
l Source: Any
l Destination: Policy's Security Groups
l Service: Any
l State: Enabled
l Log: Do not log
c. Click OK in the Add Network Inspection Service window, and then click Finish to
complete and close the New Security Policy window.
You have now created an NSX security policy for Deep Security.
Finally, associate the NSX security policy you just created with the NSX security group you also
just created:
1. Stay on the Security Policies tab of the Home > Networking & Security > Service
Composer page in your vSphere Web Client.
2. With the new security policy selected, click the Apply Security Policy icon ( ).
3. In the Apply Policy to Security Groups window, select the security group that contains the
VMs you want to protect and click OK.
355
Trend Micro Deep Security On-Premise 20
The NSX security policy is now applied to the VMs in the NSX security group.
You have now created NSX security groups and policies. Any VMs that are added to these NSX
security groups will be activated in Deep Security Manager, and assigned a Deep Security
policy.
Step 7: Prepare for activation on NSX-V
To prepare for activation, you can use Method 1, 2, or 3:
l Method 1: Create a 'Computer Created' event-based task
l Method 2: Create an 'NSX Security Group Change' event-based task
l Method 3: Synchronize your Deep Security policies to NSX
Not sure which method to choose? Here is some information to help:
l Some methods aren't supported with some NSX versions. Consult the table below
for details.
l Method 1 requires less setup work but only protects newly-created VMs. To
protect existing VMs, you'll need to trigger an activation and policy assignment
manually, in the manager. This manual step is explained in a later section.
l Method 2 also requires less setup work, and protects both newly-created and
existing VMs.
l Method 3 requires more setup work, and protects newly-created and existing VMs.
With this method, your Deep Security policies are duplicated in NSX. Choose this
356
Trend Micro Deep Security On-Premise 20
method if you want to assign policies through the NSX UI. For more information,
see "Synchronize Deep Security policies with NSX" on page 373.
Deep Security Virtual Appliance deployment
NS
NSX for vSphere (NSX-V) 6.4.x X-T
3.x
Stand NSX
ard Data
Cent
OR NSX NSX er for
NSX NSX All
Data Data Rem
NSX Data Data licen
Metho Enterpr Cente Center ote
for Advan Center Center se
d ise r Enterpr Offic
vShiel ced Professi Advan type
Stand ise e
d onal ced s
ard Plus Bran
Endpo ch
int Offic
(free) e
Meth
✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔ ✔
od 1
Meth
X ✔1 ✔1 X X ✔1 ✔1 ✔1 ✔
od 2
Meth
X ✔1 ✔1 X X ✔1 ✔1 ✔1 ✔
od 3
1 Requires VMware's Network Introspection Service.
• Requires the following software combination: Deep Security Manager FR 2019-12-12
(build 12.5.494) or newer with Deep Security Agent Linux FR 2020-04-02 (build 12.5.0-
814) or newer.
Method 1: Create a 'Computer Created' event-based task
Expand instructions
357
Trend Micro Deep Security On-Premise 20
The instructions below are task-based. For more explanatory information on event-
based tasks, see "Automated policy management in NSX environments" on page 368.
1. In Deep Security Manager, click Administration at the top.
2. On the left, click Event-Based Tasks.
3. In the main pane, click New.
4. From the Event drop-down list, select Computer Created (by System). Click
Next.
5. Select Activate Computer and set it to 5 minutes.
6. Select Assign Policy and select a policy from the drop-down list, for example,
Windows Server 2016.You can click the arrows to view child policies. Click Next.
7. Specify the conditions that restrict when the event-based task is triggered. Add this
condition:
vCenter Name matches <your_vCenter_name>
8. Add more conditions to further restrict when the event-based task is triggered. For
example, if you have a naming convention for your VMs that includes a 'Windows'
prefix on all Windows VMs, you would set:
Computer Name matches Windows*
Click Next.
9. In the Name field, enter a name for the task that reflects the policy you assigned,
for example, Activate Windows Server 2016.
10. Select Task Enabled and then click Finish.
11. Create additional event-based tasks, one per Deep Security policy you plan on
assigning. The event-based task must have an event type of Computer Created
(by System) and must be configured to activate the computer and assign a policy.
You have now set up your event-based tasks to activate and assign policies to
newly-created VMs. As soon as a VM is created, all the Computer Created (by
System) event-based tasks are reviewed. If the conditions in a task are met, the
task is triggered, and the VM is activated and assigned the associated policy.
Method 2: Create an 'NSX Security Group Change' event-based task
Expand instructions
To start, create or modify the Activate event-based task:
358
Trend Micro Deep Security On-Premise 20
1. In Deep Security Manager, click Administration at the top.
2. On the left, click Event-Based Tasks.
3. In the main pane, look for the event-based task called Activate <your_vCenter_
name> . It may or may not exist.
4. If the Activate event-based task exists, double-click it and review the table below
make sure it is configured properly. If it doesn't exist, click New and run through
the wizard, making sure to conform to the table below.
5. Create additional Activate event-based tasks if you added multiple vCenter
servers to the manager.
Note: Settings in the table below may appear in a different order from shown.
To configure the
'Activate' event- To...
based task, set...
A name for the task that reflects the action and vCenter assigned
Name under Conditions, for example, Activate your_vCenter_
name>.
NSX Security Group Change
Event The NSX Security Group Change event is triggered when the
manager receives a notification from the data plane (the Deep
Security Virtual Appliance).
Task Enabled Enabled.
Activate
5 minutes.
Computer
A policy, for example, Windows Desktop.You can click the
Assign Policy
arrows to view child policies.
Mandatory condition to restrict when the event-based task is
triggered:
Conditions
l vCenter Name matches <your_vCenter_name>
Examples of optional conditions to further restrict triggering:
359
Trend Micro Deep Security On-Premise 20
To configure the
'Activate' event- To...
based task, set...
l Appliance Protection Available matches True.
l Appliance Protection Activated matches False.
l NSX Security Group Name matches .+ (which means
any)
Next, create or modify the Deactivate event-based task:
1. Still in Deep Security Manager, in the main pane, look for the event-based task
called Deactivate <your_vCenter_name> . It may or may not exist.
2. If the Deactivate event-based task exists, double-click it and review the table
below make sure it is configured properly. If it doesn't exist, click New and run
through the wizard, making sure to conform to the table below.
3. Create additional Deactivate event-based tasks if you added multiple vCenter
servers to the manager.
Note: Settings in the table below may appear in a different order from shown.
To configure the
'Deactivate' event- To...
based task, set...
A name for the task that reflects the action and vCenter
Name assigned under Conditions, for example, Deactivate your_
vCenter_name>.
NSX Security Group Change
Event The NSX Security Group Change event is triggered when the
manager receives a notification from the data plane (the Deep
Security Virtual Appliance).
Task Enabled Enabled.
Deactivate Enabled.
360
Trend Micro Deep Security On-Premise 20
To configure the
'Deactivate' event- To...
based task, set...
Computer
l Appliance Protection Activated matches True.
l NSX Security Group Name matches ^$ (which means
Conditions
none)
l vCenter Name matches <your_vCenter_name>
You have now set up your event-based tasks to activate your VMs. If the conditions in a
task are met, the task is triggered, and the VM is activated (and assigned the associated
policy).
Method 3: Synchronize your Deep Security policies to NSX-V
Expand instructions
To start, configure Deep Security Manager:
1. Log in to Deep Security Manager.
2. Make sure that all of the policies in Deep Security Manager have a unique name
before they are synchronized with NSX. All the default ones have unique names.
3. At the top, click Computers.
4. On the left, right-click the vCenter where you want to enable synchronization and
select Properties.
5. On the NSX Configuration tab, select Synchronize Deep Security Policies with
NSX Service Profiles. Click OK.
Next, check that your policies are loading into vSphere:
1. In the vSphere Web Client Home page, click the Networking & Security button.
NSX Home appears.
2. On the left, click Service Definitions.
3. In the main pane, under the Services tab, right-click Trend Micro Deep Security
and select Edit settings.
361
Trend Micro Deep Security On-Premise 20
4. In the main pane, select the Manage tab, and under that, select Profile
Configurations.
5. Make sure the Deep Security policies are loading. They appear as individual NSX
profile configurations of the same name. Each profile configuration has an ID that
starts with a 'P', for example, P1, P2, P3, and so on. The 'P' indicates they are
based on Deep Security policies.
You have now added your Deep Security policies as profile configurations in
NSX.
Finally, reconfigure your security groups and policies:
1. Go back to "Step 6: Create an NSX security group and policy" on page 348 and
run through the steps again, but this time making the adjustments described in the
remaining steps.
2. Create multiple NSX security groups.
3. Create multiple NSX security policies. For each policy, set the Guest Introspection
Services and Network Introspection Services (both inbound and outbound)
Service Profile to one of the Deep Security policies that you just loaded.
4. Associate the NSX security policies with the NSX security groups.
Step 8: Trigger an activation and policy assignment
Your VMs are now ready to be activated and assigned a policy.
362
Trend Micro Deep Security On-Premise 20
l If you chose Method 1, you'll need to manually synchronize the vCenter. Go to Deep
Security Manager, right-click the vCenter on the left, and select Synchronize Now. Your
existing VMs should now be protected.
l If you chose Method 2 or 3, all VMs should be activated and assigned policy automatically
now. To check, see the next step.
Step 9: Check that VMs are activated and assigned a policy
To check:
1. In Deep Security Manager, click Computers at the top.
2. On the left, expand Computers > <your_vCenter> > Virtual Machines.
3. Check the TASK(S) and STATUS and columns. (Click Columns at the top to add them if
they are not visible.) The TASK(S) column should indicate Activating, and your VMs
should move from the Unmanaged (Unknown) status, to the Unmanaged (No Agent)
status, to the Managed (Online) status. You may see the VMs move into the VMware
Tools Not Installed status, but this is temporary.
4. Check the POLICY column to make sure the correct Deep Security policy was assigned.
You have now deployed Deep Security Virtual Appliance and protected your VMs with it.
Next steps (how to add new VMs)
Follow the instructions below to learn how to add new VMs to your system and protect them with
Deep Security.
To add a new VM if you chose Method 1 (create a 'Computer Created' event-based task):
l Create a new VM in vCenter. This triggers the Computer Created (by System) event-
based task, which activates and assigns policy to the new VM.
To add a new VM if you chose Method 2 (create an 'NSX Security Group Change' event-based
task):
l Create or move the VM into one of the NSX security groups. This triggers the NSX
Security Group Change event-based task, which activates and assigns policy to the new
VM.
To add a new VM if you chose Method 3 (synchronize Deep Security policies to NSX):
363
Trend Micro Deep Security On-Premise 20
l Create or move the VM into one of the NSX security groups. This activates and assigns
policy to the new VM.
Deploy the appliance in a vCloud environment
VMware vCloud integration enables the primary tenant in a multi-tenant installation to add a
vCenter to their Deep Security Manager, configure a connector, and deploy and manage the
Deep Security Virtual Appliance. The tenants can then import vCloud Organizations as cloud
accounts and apply agentless Deep Security protection to them.
In this topic:
l "Before you begin" below
l "Enable agentless protection of vCloud VMs" below
l "Create a multi-tenant environment" below
l "Add a vCenter and deploy the Deep Security Virtual Appliance" on the next page
l "Configure VMware vCloud resources for integration with Deep Security" on the next page
l "Activate virtual appliance protection on virtual machines" on page 366
Before you begin
Complete the tasks in "Before deploying the appliance" on page 305.
Enable agentless protection of vCloud VMs
1. In the Deep Security Manager console, go to Administration > System Settings > Agents.
2. Select the Allow Appliance protection of vCloud VMs check box.
3. Click Save.
Create a multi-tenant environment
There are two main task required to create a multi-tenancy environment: you must enable multi-
tenancy and then create tenants. For step-by-step instructions on how to perform these tasks, as
well as requirements and recommendations for a multi-tenant environment, see "Set up a multi-
tenant environment" on page 229.
364
Trend Micro Deep Security On-Premise 20
Add a vCenter and deploy the Deep Security Virtual Appliance
The primary tenant must add a vCenter and deploy the Deep Security Virtual Appliance. For
instructions, see "Deploy the appliance (NSX-T 3.x)" on page 308 or "Deploy the appliance
(NSX-V)" on page 341
Configure VMware vCloud resources for integration with Deep Security
To configure VMware vCloud resources for integration with Deep Security:
l "Create a minimum rights role for vCloud account tenant users" below
l "Assign unique UUIDs to new virtual machines" on the next page
l "Enable the OVF Environment Transport for VMware Tools on your guest VMs" on the next
page
Create a minimum rights role for vCloud account tenant users
The user accounts you create in vCloud Director that the Deep Security tenants will use to add
their cloud accounts to their Deep Security Manager require only the All Rights > General >
Administrator View right.
1. Log in to vCloud Director.
2. In the System tab, click on Administration.
3. In the navigation panel on the left, click on Roles.
4. Click the "plus" sign to create a new Role (for example, "DS_User").
5. Select the Administrator View right in the All Rights > General folder.
6. Click OK.
You can now assign this role to the user accounts you will give to Deep Security users to import
their vCloud resources into the Deep Security Manager.
Note: When providing a Deep Security user with their credentials, you must include the IP
address of the vCloud Organization and instruct them that when importing the vCloud
resources into their Deep Security Manager, their username must include "@orgName". For
example if the vCloud account's username is kevin and the vCloud Organization you've given
the account access to is called CloudOrgOne, then the Deep Security user must enter
kevin@CloudOrgOne as their username when importing the vCloud resources. (For a vCloud
administrator view, use @system.)
365
Trend Micro Deep Security On-Premise 20
Note: You can configure Deep Security Manager to use a proxy server specifically for
connecting to instances being protected in Cloud Accounts. The proxy setting can be found in
Administration > System Settings > Proxies > Proxy Server Use > Deep Security Manager
(Cloud Accounts).
Assign unique UUIDs to new virtual machines
Deep Security requires that all protected virtual machines have unique UUIDs. Virtual machines
created from a vApp template can be assigned duplicate UUIDs which can cause problems. To
configure your vCloud database to assign unique UUIDs, set the CloneBiosUuidOnVmCopy
property to zero (0) following VMware Knowledge Base article 2002506.
Enable the OVF Environment Transport for VMware Tools on your guest VMs
Enabling the OVF Environment Transport for VMware Tools on your guest VMs will expose the
guestInfo.ovfEnv environment variable making it easier for agents to uniquely identify their VMs
to the Deep Security Manager. This will reduce the risk of VM misidentification.
1. In vCloud Director, open the VM's Properties screen, go the Guest OS Customization tab
and select the Enable guest customization check box. Click OK.
2. In vCenter, select the same VM, open its Properties screen, go to the Options tab.
3. Click vApp Options and select the Enabled radio button. OVF Settings will now be
exposed.
4. In OVF Settings, select the VMware Tools check box in the OVF Environment Transport
area. Click OK.
If your VM is running, it must be restarted for the changes to take effect.
The data used by Deep Security are taken from the following properties:
vmware.guestinfo.ovfenv.vcenterid and vmware.guestinfo.ovfenv.vcloud.computername.
Activate virtual appliance protection on virtual machines
To activate virtual appliance protection, tenants must import vCloud Organization accounts and
apply agentless Deep Security protection to them.
Note: vCloud Organization accounts must be added by tenants (not the primary tenant).
366
Trend Micro Deep Security On-Premise 20
Import computers from a VMware vCloud Organization Account
1. In the Deep Security Manager, go to the Computers section, right-click Computers in the
navigation panel and select Add vCloud Account to display the Add vCloud Account
wizard.
2. In Name and Description, enter a display name and any additional notes.
3. In Address, enter the vCloud Director's hostname.
4. Enter your User name and Password.
Note: Your User name must be in the form username@vcloudorganization.
5. Click Next.
6. Deep Security Manager verifies the connection to the cloud resources and displays a
summary of the import action. Click Finish.
The VMware vCloud resources now appear in the Deep Security Manager under their own
branch under Computers in the navigation panel.
Import computers from a VMware vCloud Air Virtual data center
1. In the Deep Security Manager, go to the Computers section, right-click Computers in the
navigation panel and select Add vCloud Account to display the Add vCloud Account
wizard.
2. Enter a Name and Description of the VMware vCloud Air virtual data center you are
adding. (These are only used for display purposes in the Deep Security Manager.)
3. Enter the Address of the VMware vCloud Air virtual data center.
To determine the address of the VMware vCloud Air virtual data center:
a. Log in to your VMware vCloud Air portal.
b. On the Dashboard tab, click on the data center you want to import into Deep Security.
This will display the Virtual Data Center Details information page.
c. In the Related Links section of the Virtual Data Center Details page, click on vCloud
Director API URL. This will display the full URL of the vCloud Director API.
d. Use the hostname only (not the full URL) as the Address of the VMware vCloud Air
virtual data center that you are importing into Deep Security.
4. Enter your User name and Password.
Note: Your User name must be in the form username@virtualdatacenterid.
5. Click Next .
367
Trend Micro Deep Security On-Premise 20
6. Deep Security Manager will verify the connection to the virtual data center and display a
summary of the import action. Click Finish.
The VMware vCloud Air data center now appears in the Deep Security Manager under its own
branch under Computers in the navigation panel.
Activate virtual appliance protection on virtual machines
To activate virtual appliance protection, right-click on a virtual machine in the Computers list and
click Actions > Activate.
Automated policy management in NSX environments
Note: If you have enabled synchronization of Deep Security policies to NSX, you will not need
to use the NSX Security Group Change EBT. For information on policy synchronization, see
"Synchronize Deep Security policies with NSX" on page 373.
The security configuration of a VM in an NSX environment can be automatically modified based
changes to the VM's NSX Security Group. The automation of security configuration is done
using the NSX Security Group Change event-based task.
VMs are associated with NSX Security Groups, NSX Security Groups are associated with NSX
Security Policies, and NSX Security Policies are associated with NSX Service Profiles.
368
Trend Micro Deep Security On-Premise 20
"NSX Security Group Change" event-based task
Deep Security has event-based tasks (EBTs) that can be configured to perform actions when
specific events with specific conditions are detected. The NSX Security Group Change EBT
exists to let you modify the protection settings of a VM if changes to the NSX Security Group that
a VM belongs to are detected.
Note: The NSX Security Group Change EBT only detects changes to NSX Security Groups
that are associated with the Default (EBT) NSX Service Profile. Similarly, a VM may be
associated with many Groups and Policies, but Deep Security will only monitor and report
changes that involve Groups and Policies associated with the Default (EBT) NSX Service
Profile.
To modify that task, in Deep Security Manager, go to Administration > Event-Based Tasks.
The NSX Security Group Change EBT is triggered when any of the following events occur:
l A VM is added to an NSX Group that is (indirectly) associated with theDefault (EBT) NSX
Service Profile.
l A VM is removed from an NSX Group that is associated with the Default (EBT) NSX
Service Profile.
l An NSX Policy associated with the Default (EBT) NSX Service Profile is applied to an
NSX Group.
l An NSX Policy associated with the Default (EBT) NSX Service Profile is removed from an
NSX Group.
l An NSX Policy is associated with the Default (EBT) NSX Service Profile.
l An NSX Policy is removed from the Default (EBT) NSX Service Profile.
l An NSX Group that is associated with an Default (EBT) NSX Service Profile changes
name.
An event is triggered for each individual VM affected by a change.
Conditions under which to perform tasks
The following conditions are applicable to the NSX Security Group Change event-based task
and can be tested against before performing an action:
369
Trend Micro Deep Security On-Premise 20
l Computer Name: The hostname of the guest VM.
l ESXi Name: The hostname of the ESXi where the guest VM runs.
l Folder Name: The name of the guest VM's folder in the ESXi folder structure.
l NSX Security Group Name: The name of the NSX Security Group that was changed.
l Platform: The operating system of the guest VM.
l vCenter name; The name of the vCenter that the guest VM belongs to.
l Appliance Protection Available: A Deep Security Virtual Appliance is available to protect
VMs on the ESXi on which the VM is hosted. The VM may or may not be in a "Activated"
state.
l Appliance Protection Activated: A Deep Security Virtual Appliance is available to protect
VMs on the ESXi on which the VM is hosted and the VM is "Activated".
l Last Used IP Address: The current or last known IP address of the VM computer.
For information on these conditions and event-based tasks in general, see "Automatically
perform tasks when a computer is added or changed (event-based tasks)" on page 1381.
The NSX Security Group Name condition is explicitly for changes to the NSX Security Group
Change event-based task.
It accepts a java regular expression match to the NSX Security Group the VM belongs to whose
properties have changed. Two special cases are considered:
l A match for membership in any group. In this case the recommended regular expression is
".+".
l A match for membership in no groups. In this case the recommended regular expression is
"^$".
Other regular expressions can include a specific group name or partial name (to match more
than one group) as desired.
Note: The list of potential groups in this condition refers only to groups associated with
policies associated with the Default (EBT) NSX Service Profile.
Available actions
The following actions can be performed on a VM when Deep Security detects a change to the
NSX Security Group the VM belongs to:
370
Trend Micro Deep Security On-Premise 20
l Activate Computer: Activate Deep Security protection by the Deep Security Virtual
Appliance. Use this when a VM is moved into a Deep Security-protected NSX Security
Group.
l Deactivate Computer: Deactivate Deep Security protection by the Deep Security Virtual
Appliance. Use this when moving a VM out of a Deep Security-protected NSX Security
Group. An Alert will be raised if this action is not performed when a VM is moved out a
NSX Security Group protected by Deep Security because the VM can no longer be
protected.
l Assign Policy: Assign a Deep Security Policy to a VM.
l Assign Relay Group: Assign a Relay Group to a VM.
Event-based tasks created when adding a vCenter to Deep Security Manager
Two event-based tasks can be created when adding an NSX vCenter to DSM. The last page of
the Add vCenter wizard displays a checkbox. If selected, this option creates two event-based
tasks. One to activate VMs when protection is added and the other to deactivate VMs when
protection is removed.
The first event-based task is configured as follows:
l Name: Activate <vCenter Name>, where <vCenter Name> is the value seen in the Name
field on the vCenter properties.
l Event: NSX Security Group Changed
l Task Enabled: True
l Action: Activate Computer after a delay of five minutes
l Conditions:
l vCenterName: <vCenter Name> Must match because the EBT is vCenter-specific.
l Appliance Protection Available: True. Must have an activated Deep Security Virtual
Appliance on the same ESXi.
l Appliance Protection Activated: False. This only applies to unactivated VMs.
l NSX Security Group: ".+". Must be a member of one or more Deep Security Groups.
You can modify the actions associated with this event-based task, for example by applying a
Deep Security protection policy or assigning a different relay group. The actions (and other
properties) of any existing event-based tasks can be edited on the Administration > Event-
Based Tasks page in the Deep Security Manager.
The second event-based task is configured as follows:
371
Trend Micro Deep Security On-Premise 20
l Name: Deactivate <vCenter Name>, where <vCenter Name> is the value seen in the
Name field on the vCenter properties.
l Event: NSX Security Group Changed
l Task Enabled: False
l Action: Deactivate Computer
l Conditions:
l vCenterName: <vCenter Name>. Must match because the event-based task is
vCenter-specific.
l Appliance Protection Activated: True. This only applies to activated VMs.
l NSX Security Group: "^$". Must not be a member of any Deep Security Group.
Note: This event-based task is disabled by default. You can enable it and customize
it as desired after the vCenter installation is complete.
Note: If multiple event-based tasks are triggered by the same condition, the tasks are
executed in alphabetical order by task name.
Removal of a vCenter from Deep Security Manager
Whenever a vCenter is removed from Deep Security Manager disables all event-based tasks
that meet the following criteria:
1. The vCenter Name condition matches the name of the vCenter being removed.
Note: This must be an exact match. Event-based tasks which match multiple vCenter
names will not be disabled.
2. The event-based task Event Type is "NSX Security Group Changed". Event-based tasks
with other event types are not disabled.
To remove a vCenter from Deep Security Manager, you'll first need to remove Deep Security
artifacts from NSX. For instructions on removing Deep Security from NSX and vCenter from
Deep Security Manager, see "Uninstall Deep Security from your NSX environment" on
page 1331.
372
Trend Micro Deep Security On-Premise 20
Synchronize Deep Security policies with NSX
There are two ways to protect your VMs with Deep Security:
l Use event-based tasks to activate and deactivate VMs in Deep Security and apply or
remove a default policy. For more information, see "Event-based tasks created when
adding a vCenter to Deep Security Manager" on page 371.
l Synchronize your Deep Security policies with NSX. This method is described below.
Each VM that you want to protect must belong to an NSX Security Group that has an NSX
Security Policy assigned to it. When you set up an NSX Security Policy, one of the options that
you select is the NSX Service Profile. With Deep Security 9.6 or earlier, there was only one NSX
Service Profile for use with Deep Security. In Deep Security 9.6 SP1 or later, you can choose to
synchronize all of your Deep Security policies with NSX. This creates a matching NSX Service
Profile (which we call a "Mapped Service Profile" in Deep Security) for each of your Deep
Security policies.
Enable policy synchronization:
Note: All of the policies in Deep Security Manager must have a unique name before they are
synchronized with NSX.
1. In the Deep Security Manager, go to the Computers page and right-click the vCenter
where you want to enable synchronization.
2. Click Properties.
3. On the NSX Configuration tab, select Synchronize Deep Security Policies with NSX
Service Profiles. Click OK.
Next steps:
1. There are several steps required to protect your VMs with Deep Security Virtual Appliance,
and they must be completed in a specific order. For a complete list of steps, see "Deploy
the appliance (NSX-T 3.x)" on page 308, "Deploy the appliance (NSX-V)" on page 341, or
"Upgrade the appliance" on page 1307.
Change or remove the policy assigned to a VM
When a VM is protected by a Mapped Service Profile, the policy assignment cannot be changed
from within Deep Security Manager. To change the profile used to protect a VM, you must
change the NSX Security Policy or NSX Security Group from your vSphere Web Client (NSX-V)
or NSX-T Data Center console (NSX-T).
373
Trend Micro Deep Security On-Premise 20
If you unassign an NSX Security Policy from a group, any VMs in that group will be deactivated
in Deep Security Manager.
Change the name of a policy
If you rename a policy in Deep Security Manager, the NSX Service Profile Name will also be
changed.
Delete a policy
If you delete a policy in Deep Security Manager and the corresponding NSX Service Profile is
not in use, it will be deleted. If the corresponding NSX Service Profile is in use, the NSX Service
Profile will be no longer be synchronized with Deep Security Manager and its name will be
changed to indicate that it is no longer valid. If the NSX Service Profile becomes unused later, it
will be deleted.
VMware vRealize
If you are configuring a blueprint with VMware vRealize, you can assign either a NSX Security
Group or an NSX Security Policy to the blueprint. The Security Group or Security Policy can both
use Mapped Service Profiles.
Configure DPDK mode
Note: Trend Micro supports this feature on NSX-T Data Center 3.x only.
Intel Data Plane Development Kit (DPDK) is a collection of open-source libraries that have been
integrated into VMware to speed up packet processing for services that use VMware Network
Introspection. In the case of Deep Security, these services are Firewall, Intrusion Prevention,
and Web Reputation.
To take advantage of the performance improvements offered by DPDK, you can configure the
Deep Security Virtual Appliance in DPDK mode, as follows.
Before you begin:
1. Review "Deep Security Virtual Appliance requirements" on page 169. There are specific
requirements for DPDK mode.
2. Make sure you have configured DPDK in VMware. See this VMWare DPDK document for
an overview.
3. Understand that DPDK mode is configured during the appliance deployment. If you
already have an appliance up and running, you'll need to redeploy it.
374
Trend Micro Deep Security On-Premise 20
Configure DPDK mode:
1. Start the appliance deployment (see "Deploy the appliance (NSX-T 3.x)" on page 308) and
stop when you get to "Configure and start the service deployment" on page 320 under
"Install the appliance on NSX-T 3.x" on page 319.
2. Click Configure Attributes.
The Configure Attributes dialog box appears.
3. Find the dpdkMode field and modify the value according to the size of Deep Security
Virtual Appliance. The possible values are:
l -1: Deep Security Virtual Appliance determines the optimal CPU usage for DPDK
mode. Specifically:
l If the appliance OVF has > = 8 CPUs allocated, then in DPDK mode, it will have 4
CPUs allocated.
l If the appliance OVF has 4 - 7 CPUs allocated, then in DPDK mode, it will have 2
CPUs allocated.
l If the appliance OVF has 2 - 3 CPUs allocated, then in DPDK mode, it will have 1
CPU allocated.
375
Trend Micro Deep Security On-Premise 20
l 0 (default): Disables DPDK mode. Deep Security Virtual Appliance uses the RAW
Socket mode for Network Introspection.
4. Click SAVE to start the appliance deployment.
5. Monitor and verify your deployment following the instructions in "Monitor and verify the
deployment" on page 323
Configure NSX security tags
If you are using agentless protection, you can configure Deep Security Virtual Appliance to apply
NSX security tags to protected VMs when the Anti-Malware and Intrusion Prevention (IPS)
modules detect a threat. NSX security tags can be used with NSX Service Composer to
automate certain tasks, such as quarantining infected VMs. For more information on NSX
tagging and dynamic NSX security group assignment, see the documentation from VMware.
Note: VMware NSX security tags are not the same thing as Deep Security event tags. NSX
tagging occurs in the VMware vSphere environment; Deep Security event tags are in the Deep
Security database.
Topics on this page:
l "Configure Anti-Malware to apply NSX security tags" below
l "Configure Intrusion Prevention to apply NSX security tags" on the next page
Configure Anti-Malware to apply NSX security tags
To configure the Anti-Malware module to apply NSX security tags when malware is found:
1. Go to Computer or Policy editor 1 > Anti-Malware > Advanced > NSX Security Tagging.
2. Select On to enable the feature.
3. From the NSX Security Tag drop-down list, select the name of the NSX security tag that
assigned in NSX when malware is found. Options are:
l ANTI_VIRUS.VirusFound.threat=low
l ANTI_VIRUS.VirusFound.threat=medium
l ANTI_VIRUS.VirusFound.threat=high
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
376
Trend Micro Deep Security On-Premise 20
For example, if you choose ANTI_VIRUS.VirusFound.threat=low, then an NSX security
tag called ANTI_VIRUS.VirusFound.threat=low is assigned to the VM if malware is
found on the VM. The tag name is not related to the threat level of the malware, so the 'low'
tag is applied even if the malware poses a high threat (and vice versa).
4. Optionally, select Apply NSX Security Tag only if remediation action fails if you only want
to apply the NSX security tag if the remediation action attempted by the Anti-Malware
module fails. (The remediation action is determined by the malware scan configuration that
is in effect. To see which malware scan configuration is in effect, go to the Computer or
Policy editor 1 > Anti-Malware > General tab and check the Real-Time Scan, Manual
Scan, and Scheduled Scan areas.)
5. Optionally, select Remove previously applied NSX Security Tags if subsequent Malware
Scans complete without any malware detection events. Choose this option if you want to
have the security tag removed if a subsequent malware scan does not detect any malware.
You should only use this setting if all malware scans are of the same kind.
6. Click Save.
Configure Intrusion Prevention to apply NSX security tags
To configure the Intrusion Prevention module to apply NSX security tags, go to Computer or
Policy editor 2 > Intrusion Prevention > Advanced > NSX Security Tagging.
Intrusion Prevention events have a severity level that is determined by the severity level of the
Intrusion Prevention rule that triggered the event. To configure the severity level of an Intrusion
Prevention rule, go to Computer or Policy editor 3 > Intrusion Prevention > General > Assigned
Intrusion Prevention Rules and double-click a rule. Change the Severity field as required.
Intrusion Prevention rule severity levels map to NSX tags as follows:
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
3You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
377
Trend Micro Deep Security On-Premise 20
IPS Rule Severity NSX Security Tag
Critical IDS_IPS.threat=high
High IDS_IPS.threat=high
Medium IDS_IPS.threat=medium
Low IDS_IPS.threat=low
You can configure the sensitivity of the tagging mechanism by specifying the minimum Intrusion
Prevention severity level that can cause an NSX security tag to be applied to a VM.
The options for the Minimum rule severity to trigger application of an NSX Security Tag setting
are:
l Default (No Tagging): No NSX tag is applied.
l Critical: An NSX tag is applied to the VM if an Intrusion Prevention rule with a severity
level of Critical is triggered.
l High: An NSX tag is applied to the VM if an Intrusion Prevention rule with a severity level
of High or Critical is triggered.
l Medium: An NSX tag is applied to the VM if an Intrusion Prevention rule with a severity
level of Medium, High, or Critical is triggered.
l Low: An NSX tag is applied to the VM if an Intrusion Prevention rule with a severity level of
Low, Medium, High, or Critical is triggered.
Separate settings exist for rules in prevent mode vs. detect-only mode. For information about
behavior modes, see "Use behavior modes to test rules" on page 617.
Configure the appliance OVF location
By default, the Deep Security Virtual Appliance OVF file is located at https://<deep_
security_manager_host>:4119/dsva/dsva.ovf. If you want, you can place the OVF at a
different location, such as on a separate web server, and then point your manager to it. You
might want to do this:
l to improve reliability, and improve the download speed of the appliance OVF by NSX.
l to fix deployment errors in NSX caused by connectivity issues. The error might look like
this: Installation of deployment unit failed, please check if ovf/vib urls are accessible, in
correct format and all the properties in ovf environment have been configured in service
attributes. Please check logs for details.
To configure the appliance OVF location:
378
Trend Micro Deep Security On-Premise 20
First, obtain the appliance ZIP package (it contains the OVF file):
1. In Deep Security Manager, click Administration at the top.
2. On the left, expand Updates > Software > Local (if you've already imported the virtual
appliance), or Updates > Software > Download Center (if you haven't).
3. Find the virtual appliance ZIP file. It is named Appliance-ESX-<appliance_
version>.x86_64.zip.
4. Click Export > Export Package. The ZIP downloads to the local computer.
Next, place the appliance files on a web server:
1. Extract the ZIP file.
2. In the root of the ZIP file, find the dsva.ovf and system.vmdk files.
Note: If the ZIP file version is 12 Update 3 (12.0.682) or later, find instead the *.ovf,
*.vmdk, *.mf, and *.cert files. There will be several files geared towards different
sizes of deployment.
3. Place these files on a web server that is accessible to your ESXi and manager server.
4. On the web server, add the MIME type of each of the file types you just copied. The MIME
types are described in the following table. Consult your web server documentation for
detailed instructions on adding MIME types to the web server.
File extension MIME type
ovf application/vmware
vmdk application/octet-stream
mf text/cache-manifest
cert application/x-x509-user-cert
Finally, configure the manager to point to the new OVF location:
1. In Deep Security Manager, click Computers at the top.
2. On the left, expand Computers, right-click your vCenter, and select Properties.
3. Click the NSX Configuration tab.
4. Select Host the Deep Security Virtual Appliance software package on a local Web Server
instead of Deep Security Manager database.
379
Trend Micro Deep Security On-Premise 20
5. Under URL to Virtual Appliance OVF, enter the URL location of the OVF file. Examples:
l https://my.webserver.com/dsva/dsva.ovf
Or
l https://my.webserver.com/dsva/dsva-12.0.0-682_small.ovf
For help on which OVF file to choose, see "Deep Security Virtual Appliance sizing" on
page 176.
6. Click OK.
The appliance OVF is now accessible to the manager and your ESXi server. You should now be
able to deploy the appliance from its new location. For instructions on deploying or upgrading
the appliance, see "Deploy the appliance (NSX-T 3.x)" on page 308, "Deploy the appliance
(NSX-V)" on page 341, or "Upgrade the appliance" on page 1307.
Deep Security Virtual Appliance memory allocation
Note: This topic is not applicable to NSX-T 3.0 Data Center environments.
In an NSX Data Center for vSphere (NSX-V) environment, Deep Security Virtual Appliance uses
4 GB of RAM by default. If you expect to need more RAM, you will need to modify the
appliance's configuration. There are two options:
l Modify the configuration of the appliance prior to being imported to the vCenter, thereby
setting the default configuration for all subsequent appliance service deployments in that
vCenter.
l Modify the memory allocation of the appliance on a case-by-case basis after it has been
imported to the vCenter and deployed as a service on a ESXi.
For information about the amount of RAM to allocate for appliances, see "Deep Security Virtual
Appliance sizing" on page 176.
Configure the appliance's memory allocation prior to deployment to the
vCenter
To change the appliance's default memory allocation, you must edit the allocation settings in the
appliance's OVF file before it gets imported to the vCenter.
380
Trend Micro Deep Security On-Premise 20
1. Import the appliance ZIP into Deep Security Manager and wait for the appliance package
folder to fully download to <DSM_Install>\temp\Appliance-ESX-<appliance_
version>.
Warning: You must import the appliance ZIP before changing the memory allocation
settings in the OVF. If you reverse these tasks, the modified OVF file will cause a digital
signature check failure, which in turn will lead to an import failure.
2. In a text editor, open dsva.ovf in <DSM_install>\temp\Appliance-ESX-<appliance_
version>.
3. Edit the default memory allocation (4096 MB) to be appropriate for your environment. See,
"Deep Security Virtual Appliance sizing" on page 176 for more information.
<Item>
<rasd:AllocationUnits>byte * 2^20</rasd:AllocationUnits>
<rasd:Description>Memory Size</rasd:Description>
<rasd:ElementName
xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_
ResourceAllocationSettingData">4096 MB of memory</rasd:ElementName>
<rasd:InstanceID xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-
schema/2/CIM_ResourceAllocationSettingData">2</rasd:InstanceID>
<rasd:Reservation>4096</rasd:Reservation>
<rasd:ResourceType>4</rasd:ResourceType>
<rasd:VirtualQuantity>4096</rasd:VirtualQuantity>
</Item>
4. Save the OVF file.
5. If you imported multiple appliance packages to Deep Security Manager, modify the
dsva.ovf in each \Appliance-ESX-<appliance_version> folder.
You can now deploy the virtual appliance OVF file into vCenter. See "Deploy the appliance
(NSX-T 3.x)" on page 308, or "Deploy the appliance (NSX-V)" on page 341.
Configure the memory allocation of an already-deployed appliance
Warning: Changing the appliance's memory allocation settings requires powering off the
appliance's virtual machine. Virtual machines normally protected by the appliance will be
unprotected until it is powered back on. To mitigate this, temporarily configure agent-based
protection where possible.
381
Trend Micro Deep Security On-Premise 20
1. In your VMware vSphere Web Client, right-click on the appliance and select Power > Shut
Down Guest.
2. Right-click on the appliance again and select Edit Settings. The Virtual Machine
Properties screen displays.
3. On the Hardware tab, select Memory and change the memory allocation to the desired
value.
4. Click OK.
5. Right-click the appliance again and select Power > Power On.
Start or stop the appliance
To start or stop the Deep Security Virtual Appliance, you must start or stop its embedded Deep
Security Agent. This can only be done locally on the host computer.
To start or stop the agent on Linux:
Using SysV init scripts:
l Start: /etc/init.d/ds_agent start
l Stop: /etc/init.d/ds_agent stop
Using systemd commands:
l Start: systemctl start ds_agent
l Stop: systemctl stop ds_agent
Deploy Deep Security Notifier
The Deep Security Notifier is a utility for physical or virtual Windows machines which provides
local notification when malware is detected or malicious URLs are blocked. The Deep Security
Notifier is automatically installed as part of the Deep Security Agent on Windows machines. The
stand-alone installation described here is intended for use on agentless Windows VMs being
protected by the Deep Security Virtual Appliance. For more information, see "Deep Security
Notifier" on page 1153.
Copy the Installation Package
Copy the installation file to the computer.
382
Trend Micro Deep Security On-Premise 20
Install the Deep Security Notifier for Windows
Note: Remember that you must have administrator privileges to install and run the Deep
Security Notifier on Windows machines.
1. Double-click the installation file to run the installer package. Click Next to begin the
installation.
2. Read the license agreement and click Next.
3. Click Install to proceed with the installation.
4. Click Finish to complete the installation.
The Deep Security Notifier is now installed and running on this computer, and the Notifier icon
appears in the Windows System Tray. When malware is detected or a URL has been blocked,
the Notifier will display pop-up notifications. You can manually disable them by double-clicking
the tray icon to open the Notifier status and configuration window.
Note: On VMs protected by a virtual appliance, the anti-malware module must be licensed and
enabled on the VM for the Deep Security Notifier to display information.
User Guide
Add computers
About adding computers
The Computers page in Deep Security Manager enables you to manage and monitor the
computers you are protecting with Deep Security.
This page regularly refreshes itself to display the most current information. (You can modify the
refresh rate on a per-user basis. Go to Administration > User Management > Users and then
double-click on a user account to open its Properties window. On the Settings tab, in the
Refresh Rate section, modify the page refresh rate.)
383
Trend Micro Deep Security On-Premise 20
Add computers to the manager
Note: After being installed on a computer, an agent must be activated by the Deep Security
Manager. During activation, the Deep Security Manager sends a fingerprint to the agent, after
which the agent accepts instructions only from a manager with that unique fingerprint.
Note: If you install an agent on a virtual machine that was previously being protected
agentlessly by a Deep Security Virtual Appliance, the virtual machine has to be activated
again from the manager to register the presence of the agent on the computer. Agentless
protection is not available with Deep Security as a Service.
You can add computers through the Computers page.
Group computers
Creating computer groups is useful from an organizational point of view and it speeds up the
process of applying and managing policies. Groups are displayed in the tree structure on the left
side of the Computers page. To create a new group, select the computer group under which you
want to create the new computer group and then click Add > Create Group(s).
To move a computer to a group, select the computer and click Actions > Move to Group. Keep in
mind that policies are applied at the computer level, not the computer group level. Moving a
computer from one computer group to another has no effect on the policy assigned to that
computer.
To remove a group, right-click it and click Remove Group. You can only remove a computer
group if it contains no computers and has no sub-groups.
You can also "Group computers dynamically with smart folders" on page 1219.
Export your computers list
You can click Export on the Computers page to export your computers list to an XML or CSV file.
Exporting is useful when you want to back up your computer information, integrate it with other
reporting systems, or to migrate computers to another Deep Security Manager. (If you export, you
do not have to re-discover and scan computers from the new manager.)
384
Trend Micro Deep Security On-Premise 20
Note: The exported computers file does not include any assigned policies, firewall rules,
firewall stateful configurations or intrusion prevention rules. To export this configuration
information use the Policy export option in the Policies page.
Delete a computer
If you delete a computer (by selecting it and clicking Delete), all information pertaining to that
computer is deleted along with it. If you re-discover the computer, you will have to re-assign a
policy and whatever rules were assigned previously.
Add local network computers
Agent-initiated activation
If the Deep Security Manager cannot initiate communication with computers that you want to
protect (for example, if computers are on a different local network or are protected by a firewall),
then computers must initiate connections to the manager instead. This includes the connection
for agent activation. To use agent-initiated activation, you must install the Deep Security Agent
on the computer and then run a set of command-line instructions which tell the agent to
communicate with the Deep Security Manager. During the communication, the Deep Security
Manager activates the agent and can be further instructed to perform a number of other actions
such as assigning a security policy, making the computer a member of a computer group, and so
on.
If you are going to add a large number of computers to the Deep Security Manager at one time,
you can use the command-line instructions to create scripts to automate the process. For more
information on agent-initiated activation, scripting, and command line options, see "Command-
line basics" on page 1348.
Manually add a computer
You can manually add an individual computer by specifying its IP address or hostname.
1. Go to the Computers page and click Add > Add Computer in the toolbar to display the
New Computer wizard.
2. Enter the new computer's IP address or hostname.
3. Select a policy to assign to it from the list.
385
Trend Micro Deep Security On-Premise 20
4. Select a relay group from which the new computer will download security updates.
5. Click Next to begin the search for the computer.
If the computer is detected and an agent is installed and running on that computer, the computer
will be added to your computers list and the agent will be activated.
Note: "Activating" an agent means that the manager communicates with the agent sending it a
unique "fingerprint". The agent will then use this fingerprint to uniquely identify the Deep
Security Manager and will not accept instructions from any other managers that might try to
contact it.
If a policy has been assigned to the computer, the policy will be deployed to the agent and the
computer will be protected with all the rules and configurations that make up the policy.
By default, the security updates delivered by relay groups include new malware patterns. If you
have enabled the Support 9.0 (and earlier) agents option (on the Administration > System
Settings > Updates page), updates to the engines will also be included.
If the computer is detected but no Deep Security Agent is present, you will be told that the
computer can still be added to your computers list but that you still have to install an agent on the
computer. Once you install an agent on the computer, you will have to find the computer in your
computers list, right-click it, and choose Activate/Reactivate from the context menu.
If the computer is not detected (not visible to the manager), you will be told that you can still add
the computer but that when it becomes visible to the manager you will have to activate it as
above.
Discover computers
A discovery operation scans the network for visible computers. To initiate a discovery operation,
go to the Computers page, click Add > Discover. The Discover Computers dialog will appear.
You are provided several options to restrict the scope of the scan. You can choose to perform a
port scan of each discovered computer.
Note: If you are discovering or scanning a large number of computers, a port scan can take
time and reduce performance until it is complete.
When discovering computers, you can specify a computer group to which they should be added.
Depending on how you have chosen to organize your computer groups, it may be convenient to
386
Trend Micro Deep Security On-Premise 20
create a computer group called "Newly Discovered Computers", or "Newly Discovered
Computers on Network Segment X" if you will be scanning multiple network segments. You can
then move your discovered computers to other computer groups based on their properties and
activate them.
During discovery, the manager searches the network for any visible computers that are not
already listed. When a computer is found, the manager attempts to detect whether an agent is
present. When discovery is complete, the manager displays all the computers it has detected
and displays their status in the Status column.
Note: The Discovery operation only checks the status of newly-discovered computers. To
update the status of already-listed computers, right-click the selected computer(s) and click
Actions > Check Status.
After discovery operations, a computer can be in one of the following states:
l Discovered (No Agent): The computer has been detected but no agent is present. The
computer may also be in this state if an agent is installed but has been previously activated
and is configured for agent initiated communications. In this case, you will have to
deactivate and then reactivate the agent. ("No Agent" will also be reported if the agent is
installed but not running.)
l Discovered (Activation Required): The agent is installed and listening, and has been
activated, but is not yet being managed by the manager. This state indicates that this
manager was at one point managing the agent, but the agent's public certificate is no
longer in the manager's database. This may be the case if the if the computer was removed
from the manager and then discovered again. To begin managing the agent on this
computer, right-click the computer and select Activate/Reactivate. Once reactivated, the
Status will change to "Online".
l Discovered (Deactivation Required): The agent is installed and listening, but it has
already been activated by another manager. In this case, the agent must be deactivated
(reset) prior to activation by this manager. Deactivating an agent can be done using the
manager that originally activated it or it can be reset through the command line. To
deactivate the agent from the manager, right-click the computer and choose Actions >
Deactivate. To deactivate the agent from the command line, see "Reset the agent" on
page 1362.
l Discovered (Activated): The agent is installed and activated by the current manager. In
this case, the status will change to "Online" on the next heartbeat. To begin managing the
387
Trend Micro Deep Security On-Premise 20
agent, right-click the computer and select Activate/Reactivate. Once reactivated, the
Status will change to "Online".
Note: The discovery operation does not discover computers running as virtual machines in a
vCenter, computers in a Microsoft Active Directory or in other LDAP directories.
Add Active Directory computers
Deep Security can use an LDAP server such as Microsoft Active Directory for computer
discovery and to create user accounts and their contacts. Deep Security Manager queries the
server, and then displays computer groups according to the structure in the directory.
Note: If you are using Deep Security in FIPS mode, you must import the Active Directory's
SSL certificate into Deep Security Manager before connecting the manager with the directory.
See "Manage trusted certificates" on page 1273.
1. In Deep Security Manager, click Computers.
2. In the main pane, click Add > Add Active Directory.
3. Type the host name or IP address, name, description, and port number of your Active
Directory server. Also enter your access method and credentials. Follow these guidelines:
l The Server Address must be the same as the Common Name (CN) in the Active
Directory's SSL certificate if the access method is LDAPS.
l The Name doesn't have to match the directory's name in Active Directory.
l The Server Port is Active Directory's LDAP or LDAPS port. The defaults are 389
(LDAP and StartTLS) and 636 (LDAPS).
l The Username must include your domain name. Example: EXAMPLE/Administrator.
l If you are using Deep Security in FIPS mode, click Test Connection in the Trusted
Certificate section to check whether the Active Directory's SSL certificate has been
imported successfully into Deep Security Manager.
Click Next to continue.
4. Specify your directory's schema. (If you haven't customized the schema, you can use the
default values for a Microsoft Active Directory server.)
388
Trend Micro Deep Security On-Premise 20
Note: The Details window of each computer in the Deep Security Manager has a
"Description" field. To use an attribute of the "Computer" object class from your Active
Directory to populate the "Description" field, type the attribute name in the Computer
Description Attribute text box.
Select Create a Scheduled Task to Synchronize this Directory if you want to automatically
keep this structure in the Deep Security Manager synchronized with your Active Directory
server. A Scheduled Task wizard will appear when you are finished adding the directory.
(You can set this up later using the Scheduled Tasks wizard: Administration > Scheduled
Tasks.)
5. Click Next to continue.
6. When the Manager has imported your directory, it will display a list of computers that it
added. Click Finish.
The directory structure will appear on the Computers page.
Additional Active Directory options
Right-clicking an Active Directory structure gives you options that are not available for non-
directory computer groups:
l Remove Directory
l Synchronize Now
Remove Directory
When you remove a directory from the Deep Security Manager, you have these options:
l Remove directory and all subordinate computers/groups from DSM: Remove all traces of
the directory.
l Remove directory but retain computer data and computer group hierarchy: Turn the
imported directory structure into identically organized regular computer groups, no longer
linked with the Active Directory server.
l Remove directory, retain computer data, but flatten hierarchy: Remove links to the Active
Directory server, discards directory structure, and places all the computers into the same
computer group.
389
Trend Micro Deep Security On-Premise 20
Synchronize Now
You can manually trigger Deep Security Manager to synchronize with the Active Directory server
to refresh information on computer groups.
Tip: You can automate this procedure by creating a scheduled task.
Server certificate usage
If it is not already enabled, enable SSL on your Active Directory server.
Computer discovery can use either SSL or TLS or unencrypted clear text, but importing user
accounts (including passwords and contacts) requires authentication and SSL or TLS.
SSL or TLS connections require a server certificate on your Active Directory server. During the
SSL or TLS handshake, the server will present this certificate to clients to prove its identity. This
certificate can be either self-signed or signed by a certificate authority (CA). If you don't know if
your server has a certificate, on the Active Directory server, open the Internet Information
Services (IIS) Manager, and then select Server Certificates. If the server doesn't have a signed
server certificate, you must install it.
Import users and contacts
Deep Security can import user account information from Active Directory and create
corresponding Deep Security users or contacts. This offers the following advantages:
l Users can use their network passwords as defined in Active Directory.
l Administrators can centrally delete accounts from within Active Directory.
l Maintenance of contact information is simplified (e.g., email, phone numbers, etc.) by
leveraging information already in Active Directory.
Both users and contacts can be imported from Active Directory. Users have configuration rights
on the Deep Security Manager. Contacts can only receive Deep Security Manager notifications.
The synchronization wizard allows you to choose which Active Directory objects to import as
users and which to import as contacts.
Note: To successfully import an Active Directory user account into Deep Security as a Deep
Security user or contact, the Active Directory user account must have a userPrincipalName
390
Trend Micro Deep Security On-Premise 20
attribute value. (The userPrincipalName attribute corresponds to an Active Directory account
holder's "User logon name".)
1. Click Administration > User Management and then click either Users or Contacts.
2. Click Synchronize with Directory.
If this is the first time user or contact information is imported, the server information page is
displayed. Otherwise, the Synchronize with Directory wizard is displayed.
3. Select the appropriate access options, provide logon credentials, and click Next.
4. Select the groups you want to synchronize by selecting them from the left column and
clicking >> to add them to the right column and then click Next.
Tip: You can select multiple groups by holding down shift or control while clicking on
them.
5. Select whether to assign the same Deep Security role to all Directory group members or to
assign Deep Security roles based on Directory Group membership and then select a
default role from the list and click Next.
6. If you assigned Deep Security roles based on Directory Group membership, specify the
synchronization options for each group and click Next.
After synchronization, the wizard generates a report showing the number of objects
imported.
Tip: Before you finish the synchronization, you can choose to create a scheduled task to
regularly synchronize users and contacts.
7. Click Finish.
Once imported, you will be able to tell the difference between organic (non-imported) Deep
Security accounts and imported accounts because you will not be able to change any general
information for these accounts.
Keep Active Directory objects synchronized
Once imported, Active Directory objects must be continually synchronized with their Active
Directory servers to reflect the latest updates for these objects. This ensures, for example, that
computers that have been deleted in Active Directory are also deleted in Deep Security
Manager. To keep the Active Directory objects that have been imported to the Deep Security
Manager synchronized with Active Directory, it is essential to set up a scheduled task that
391
Trend Micro Deep Security On-Premise 20
synchronizes directory data. The wizard to import computers includes the option to create these
scheduled tasks.
Alternatively, you can create this task using the Scheduled Task wizard. On-demand
synchronization can be performed using the Synchronize Now option for computers and
Synchronize with Directory button for users and contacts.
Note: You do not need to create a scheduled task to keep users and contacts synchronized.
At log in, Deep Security Manager checks whether the user exists in Active Directory. If the
username and password are valid, and the user belongs to a group that has synchronization
enabled, the user will be added to Deep Security Manager and allowed to log in.
Note: If you disable an account in Active Directory but do not delete it, the user remains visible
and active in Deep Security Manager.
Disable Active Directory synchronization
You can stop Deep Security Manager from synchronizing with Active Directory for both computer
groups and user accounts.
Remove computer groups from Active Directory synchronization
1. Go to Computers.
2. Right-click the directory, and select Remove Directory.
3. Select what to do with the list of computers from this directory when Deep Security
Manager stops synchronizing with it:
l Remove directory and all subordinate computers/groups from Deep Security
Manager: Remove this directory's structure.
l Remove directory but retain computer data and group hierarchy: Keep the existing
structure, including its user and role access to folders and computers.
l Remove directory, retain computer data, but flatten hierarchy: Convert the directory's
structure to a flat list of computers inside a group that is named after the directory. The
new computer group has the same user and role access as the old structure.
4. Confirm the action.
392
Trend Micro Deep Security On-Premise 20
Delete Active Directory users and contacts
Unlike when you remove directory queries for computer groups, if you delete the query for users
and contacts, all those accounts will be deleted from Deep Security Manager. As a result, you
can't delete while logged into Deep Security Manager with a user account that was imported
from the directory server. Doing so will result in an error.
1. On either Users or Contacts, click Synchronize with Directory.
2. Select Discontinue Synchronization and then click OK.
3. Click Finish.
Add AWS instances
About adding AWS accounts
Topics:
l "Overview of methods for adding AWS accounts" below
l "What happens when you add an AWS account?" below
l "What are the benefits of adding an AWS account?" on the next page
l "What AWS regions are supported?" on the next page
Overview of methods for adding AWS accounts
There a few ways to add AWS accounts to Deep Security Manager:
l "Add an AWS account using a manager instance role" on page 395. Use this method if
Deep Security Manager is inside AWS.
l "Add an AWS account using an access key" on page 398. Use this method if Deep
Security Manager is outside AWS.
l "Add an AWS account using a cross-account role" on page 401. Use this method if you
want to add multiple AWS accounts.
What happens when you add an AWS account?
When you add an AWS account to Deep Security, all the Amazon EC2 and Amazon WorkSpace
instances under that account are imported into Deep Security Managerand become visible in
one of these locations:
393
Trend Micro Deep Security On-Premise 20
l EC2 instances appear on the left under Computers > your_AWS_account > your_region >
your_VPC > your_subnet
l Amazon WorkSpaces appear on the left under Computers > your_AWS_account > your_
region >WorkSpaces
Once imported, the EC2 and WorkSpace instances can be managed like any other computer.
Note: If you previously added Amazon EC2 instances or Amazon WorkSpaces as individual
computers, and they are part of your AWS account, after importing the account, the instances
are moved into the treestructure described above.
What are the benefits of adding an AWS account?
The benefits of adding an AWS account (through Deep Security Manager > Computers > Add
AWS Account) instead of adding individual EC2 instances and WorkSpaces (through Deep
Security Manager > Computers > Add Computer), are:
l Changes in your EC2 and WorkSpaces inventory are automatically reflected in Deep
Security Manager. For example, if you delete a number of EC2 or WorkSpace instances in
AWS, those instances disappear automatically from the manager. By contrast, if you use
Computers > Add Computer, EC2 and WorkSpace instances that are deleted from AWS
remain visible in the manager until they are manually deleted.
l Your EC2 and WorkSpace instances are organized into AWS region > VPC > subnet in
the manager, which lets you easily see which instances are protected and which are not.
Without the AWS account, all your EC2 and WorkSpace instances appear at the same root
level under Computers.
l You get AWS metadata, which can be used in event-based tasks (EBTs) to simplify policy
assignment. You can also use metadata with smart folders to organize your AWS
instances.
What AWS regions are supported?
Deep Security Manager's Computers > Add > Add AWS Account option only supports AWS
regions that use the global AWS Identity Access Management (IAM) service at
iam.amazonaws.com. To determine whether your region uses the global service, see this table.
At the time or writing, the following regions do not use the global IAM service
(iam.amazonaws.com):
394
Trend Micro Deep Security On-Premise 20
l China (Beijing)
l China (Ningxia)
l AWS GovCloud (US-East)
l AWS GovCloud (US)
For the regions listed above, and any others that might not use the global IAM service, you can
still load your EC2 and WorkSpace instances into the manager using the Deep Security REST
API. Trend Micro has provided this sample script for your use.
Add an AWS account using a manager instance role
Follow the instructions below to add an AWS account to Deep Security Manager using a
manager instance role. Use this method if Deep Security Manager is running inside of AWS.
Note: The term 'AWS Primary Account' will be used throughout this topic to describe the AWS
account under which your Deep Security Manager is located.
First, log in to the AWS Primary Account
1. Go to Amazon Web Services at https://aws.amazon.com/.
2. Sign in using your AWS Primary Account.
Next, configure an IAM policy
1. In the Amazon Web Services Console, go to the IAM service.
2. In the left navigation pane, click Policies.
Note: If this is your first time on this page, you'll need to click Get Started.
3. Click Create policy.
4. Select the JSON tab.
5. Copy the following JSON code into the text box:
{
"Version": "2012-10-17",
"Statement": [
{
395
Trend Micro Deep Security On-Premise 20
"Sid": "cloudconnector",
"Action": [
"ec2:DescribeImages",
"ec2:DescribeInstances",
"ec2:DescribeRegions",
"ec2:DescribeSubnets",
"ec2:DescribeTags",
"ec2:DescribeVpcs",
"ec2:DescribeAvailabilityZones",
"ec2:DescribeSecurityGroups",
"workspaces:DescribeWorkspaces",
"workspaces:DescribeWorkspaceDirectories",
"workspaces:DescribeWorkspaceBundles",
"workspaces:DescribeTags",
"iam:ListAccountAliases",
"iam:GetRole",
"iam:GetRolePolicy",
"sts:AssumeRole"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
Note: The "sts:AssumeRole" permission is required only if you plan on
adding more AWS accounts to the manager (using cross account roles).
Note: The "iam:GetRole" and "iam:GetRolePolicy" permissions are
optional, but recommended because they allow Deep Security to determine
whether you have the correct policy when an update to the manager occurs that
requires additional AWS permissions.
6. Click Review policy.
7. Give the policy a name and description. Example name: Deep_Security_
Policy.
8. Click Create policy. Your policy is now ready to use.
396
Trend Micro Deep Security On-Premise 20
Next, create a manager instance role
1. Go to the IAM service.
2. Click Roles.
3. Click Create role.
4. Make sure the AWS service box is selected.
5. Click EC2 from the list of services. More options are revealed.
6. Click EC2 Allows EC2 instances to call AWS services on your behalf. Click
Next: Permissions.
7. Select the check box next to the IAM policy you just created. Click Next: Review.
8. Enter a Role name and Role description.
Example role name: Deep_Security_Manager_Instance_Role
9. Click Create role.
Next, attach the manager instance role to the manager in AWS
1. Go to the EC2 service.
2. Click Instances on the left, and select the check box next to the EC2 instance
where your Deep Security Manager is installed.
3. Click Actions > Instance Settings > Attach/Replace IAM Role.
4. From the IAM role drop-down list, select the manager instance role (Deep_
Security_Manager_Instance_Role).
5. Click Apply.
You have now created a manager instance role with the correct IAM policy, and
attached it to the Deep Security Manager's EC2 instance.
Next, configure the manager instance role in the manager
1. In Deep Security Manager, click Administration at the top.
2. Click System Settings on the left.
3. Click the Advanced tab in the main pane.
4. Scroll to the bottom and look for the Manager AWS Identity section.
5. Make sure Use Manager Instance Role is selected.
Note: If Use Manager Instance Role does not appear, make sure that you
attached the role to the EC2 instance where Deep Security Manager is installed,
397
Trend Micro Deep Security On-Premise 20
and then "Restart the Deep Security Manager" on page 1345. On restart, Deep
Security detects the role of the manager's EC2 instance and displays the Use
Manager Instance Role option.
6. Click Save.
Finally, add the AWS Primary Account to the manager
1. In Deep Security Manager, click Computers at the top.
2. In the main pane, click Add > Add AWS Account.
3. Select Use Manager Instance Role.
4. If the AWS Primary Account includes Amazon WorkSpaces, select Include
Amazon WorkSpaces to include them with your Amazon EC2 instances. By
enabling the check box, you ensure that your Amazon WorkSpaces appear in the
correct location in the tree structure in Deep Security Manager and are billed at the
correct rate.
5. Click Next.
Deep Security Manager uses the manager instance role that is attached to its Amazon
EC2 instance to add the AWS Primary Account's EC2 and WorkSpace instances to
Deep Security Manager.
You have now added the AWS Primary Account to Deep Security Manager. The
Amazon EC2 instances and Amazon WorkSpaces under this AWS account are loaded.
After completing the above tasks, proceed to Install the agent on your Amazon EC2 and
WorkSpace instances if you have not done so already.
Add an AWS account using an access key
Follow the instructions below to add an AWS account to Deep Security Manager using an
access key. Use an access key if your Deep Security Manager is on a server outside of AWS, or
if you have tried another method and it doesn't work. For all other scenarios, we recommend you
use another method for adding AWS accounts. (Access keys are discouraged because the keys
need to be updated periodically (for security reasons), which creates management overhead.)
Note: The term 'AWS Primary Account' will be used throughout this topic to describe the AWS
account that contains the EC2 and WorkSpace instances that you want to add to the manager.
398
Trend Micro Deep Security On-Premise 20
First, log in to the AWS Primary Account
1. Go to Amazon Web Services at https://aws.amazon.com/.
2. Sign in using the AWS Primary Account.
Next, configure an IAM policy
1. In the Amazon Web Services Console, go to the IAM service.
2. In the left navigation pane, click Policies.
Note: If this is your first time on this page, you'll need to click Get Started.
3. Click Create policy.
4. Select the JSON tab.
5. Copy the following JSON code into the text box:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "cloudconnector",
"Action": [
"ec2:DescribeImages",
"ec2:DescribeInstances",
"ec2:DescribeRegions",
"ec2:DescribeSubnets",
"ec2:DescribeTags",
"ec2:DescribeVpcs",
"ec2:DescribeAvailabilityZones",
"ec2:DescribeSecurityGroups",
"workspaces:DescribeWorkspaces",
"workspaces:DescribeWorkspaceDirectories",
"workspaces:DescribeWorkspaceBundles",
"workspaces:DescribeTags",
"iam:ListAccountAliases",
"iam:GetRole",
"iam:GetRolePolicy",
"sts:AssumeRole"
399
Trend Micro Deep Security On-Premise 20
],
"Effect": "Allow",
"Resource": "*"
}
]
}
Note: The "sts:AssumeRole" permission is required only if you plan on
adding more AWS accounts to the manager (using cross account roles).
Note: The "iam:GetRole" and "iam:GetRolePolicy" permissions are
optional, but recommended because they allow Deep Security to determine
whether you have the correct policy when an update to the manager occurs that
requires additional AWS permissions.
6. Click Review policy.
7. Give the policy a name and description. Example name: Deep_Security_
Policy.
8. Click Create policy. Your policy is now ready to use.
Next, create an IAM user with an access key ID and secret
1. Go to the IAM service.
2. Click Users.
3. Click Add user.
4. Enter a user name. Example: Deep_Security_IAM_User.
5. For Access type, select Programmatic access.
6. Click Next: Permissions.
7. Click the Attach existing policies directly box.
8. Find the IAM policy you just created and select the check box next to it.
9. Click Next: Review.
10. Click Create user. Your access key ID and secret access key are shown in the
table.
11. Copy the access key ID and secret access key to a safe location. You'll need them
later.
Next, add the access key to the manager
400
Trend Micro Deep Security On-Premise 20
1. Log in to Deep Security Manager.
2. Click Administration at the top.
3. Click System Setting on the left.
4. Click the Advanced tab in the main pane.
5. Scroll to the bottom and look for the Manager AWS Identity heading.
6. Next to Access Key - The Access Key of an AWS User used for the manager
identity, enter the access key of the IAM user you created previously.
7. Next to Secret Key - The Secret Access Key of an AWS User used for the
manager identity, enter the secret key of the IAM user that you created previously.
8. Click Save.
Finally, add your AWS Primary Account and its access key to the manager
1. Click Computers at the top.
2. Click Add > Add AWS Account.
3. Select Use AWS Access Keys.
4. Enter your AWS Primary Account's IAM user Access Key ID and Secret Access
Key that you created previously.
5. If your AWS Primary Account includes Amazon WorkSpaces, select Include
Amazon WorkSpaces to include them with your Amazon EC2 instances. By
enabling the check box, you ensure that your Amazon WorkSpaces appear in the
correct location in the tree structure in Deep Security Manager and are billed at the
correct rate.
Your AWS Primary Account's Amazon EC2 instances and Amazon WorkSpaces
are loaded.
After completing the above tasks, proceed to Install the agent on your Amazon EC2 and
WorkSpace instances if you have not done so already.
Add an AWS account using a cross-account role
Follow the instructions below to add an AWS account using a cross-account role. Use a cross-
account role if you want to add multiple AWS accounts.
The instructions below assume you want to add AWS accounts with these names:
401
Trend Micro Deep Security On-Premise 20
l AWS Primary Account
l AWS Account A
Tip: You can also add a cross-account role through the Deep Security API. See "Add the
account through the API" on page 406 for details.
First, add the AWS Primary Account
l If your manager resides inside AWS, complete all the tasks in "Add an AWS
account using a manager instance role" on page 395 to add the AWS Primary
Account.
l If your manager resides outside AWS, complete all tasks in "Add an AWS account
using an access key" on page 398 to add the AWS Primary Account.
Next, find the AWS Primary Account identifier
If you added the AWS Primary Account using a manager instance account role, do the
following:
1. Make sure you're logged in to the AWS Primary Account.
2. Go to the IAM service.
3. Click Roles.
4. Find the manager instance role that you created in "Add an AWS account using a
manager instance role" on page 395. For example: Deep_Security_Manager_
Instance_Role
5. Select the role in the list to reveal its details.
6. Look for the Role ARN field at the top of the page. Its value is similar to:
arn:aws:iam::1111111111:role/Deep_Security_Manager_Instance_Role
7. Note the role's account ID in the ARN. It is the number (1111111111). You'll need
it later to create the cross-account role.
If you added the AWS Primary Account using an access key, do the following:
1. Make sure you're logged in to the AWS Primary Account.
2. At the top-right of AWS, click Support > Support Center.
3. Note the Account Number shown at the top-right (1111111111, in this example).
You'll need it later to create the cross-account role.
402
Trend Micro Deep Security On-Premise 20
Next, retrieve the external ID
1. Log in to Deep Security Manager.
2. Click Computers at the top.
3. Click Add > Add AWS Account. A wizard appears.
4. Click the eye icon next to the obscured external ID to reveal it. For more on this ID,
see "What is the external ID?" on page 409
5. Copy the external ID to a secure place. You will need it in the next step to
configure AWS Account A and any other AWS accounts you want to add.
6. (Optional.) Close the wizard and the manager.
Next, configure an IAM policy for AWS Account A
Note: This IAM policy is the same as the policy for the AWS Primary Account, except
it does not require the sts:AssumeRole permission.
1. Make sure you're logged in to AWS Account A.
2. In the Amazon Web Services Console, go to the IAM service.
3. In the left navigation pane, click Policies.
Note: If this is your first time on this page, you'll need to click Get Started.
4. Click Create policy.
5. Select the JSON tab.
6. Copy the following JSON code into the text box:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "cloudconnector",
"Action": [
"ec2:DescribeImages",
"ec2:DescribeInstances",
"ec2:DescribeRegions",
"ec2:DescribeSubnets",
"ec2:DescribeTags",
"ec2:DescribeVpcs",
"ec2:DescribeAvailabilityZones",
403
Trend Micro Deep Security On-Premise 20
"ec2:DescribeSecurityGroups",
"workspaces:DescribeWorkspaces",
"workspaces:DescribeWorkspaceDirectories",
"workspaces:DescribeWorkspaceBundles",
"workspaces:DescribeTags",
"iam:ListAccountAliases",
"iam:GetRole",
"iam:GetRolePolicy"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
Note: The "iam:GetRole" and "iam:GetRolePolicy" permissions are
optional, but recommended because they allow Deep Security to determine
whether you have the correct policy when an update to the manager occurs that
requires additional AWS permissions.
7. Click Review policy.
8. Give the policy a name and description. Example name: Deep_Security_
Policy_Cross.
9. Click Create policy. Your policy is now ready to use.
Next, create a cross-account role for AWS Account A
1. Make sure you're logged in to AWS Account A.
2. Go to the IAM service.
3. In the left navigation pane, click Roles.
4. In the main pane, click Create role.
5. Click the Another AWS account box.
6. In the Account ID field:
l If you are using Deep Security Manager inside AWS , enter the manager
instance role ID of AWS Primary Account that you noted in a previous step.
For example: 1111111111
404
Trend Micro Deep Security On-Premise 20
l If you are using Deep Security Manager outside AWS, enter the account ID of
AWS Primary Account that you noted in a previous step. For example:
1111111111
7. Next to Options, enable Require external ID. In the External ID field, enter the
external ID you retrieved from the manager earlier.
8. Click Next: Permissions.
9. Select the IAM policy that you just created (the example name was Deep_
Security_Policy_Cross) and then click Next: Review.
10. On the Review page, enter a role name and description. Example role name:
Deep_Security_Role_Cross.
11. On the main role page, search for the role you just created (Deep_Security_
Role_Cross).
12. Click it.
13. Find the Role ARN field at the top. It looks similar to:
arn:aws:iam::2222222222:role/Deep_Security_Role_Cross
14. Note the Role ARN value. You'll need it later.
You now have a cross-account role under AWS Account A that includes the correct
policy and references the account ID or manager instance role of the AWS Primary
Account.
Next, add AWS Account A to the manager
1. Log in to Deep Security Manager.
2. Click Computers at the top.
3. Click Add > Add AWS Account.
4. Select Use Cross Account Role.
5. Enter AWS Account A's Cross Account Role ARN. You noted this earlier, when
you created the cross-account role. In this example, it is
arn:aws:iam::2222222222:role/Deep_Security_Role_Cross
6. If AWS Account A includes Amazon WorkSpaces, select Include Amazon
WorkSpaces to include them with your Amazon EC2 instances. By enabling the
check box, you ensure that your Amazon WorkSpaces appear in the correct
location in the tree structure in Deep Security Manager and are billed at the correct
rate.
7. Click Next.
AWS Account A's Amazon EC2 instances and Amazon WorkSpaces are loaded.
405
Trend Micro Deep Security On-Premise 20
You have now added AWS Account A to the manager.
After completing the above tasks, proceed to Install the agent on your Amazon EC2 and
WorkSpace instances if you have not done so already.
Add the account through the API
1. If you don’t yet have the external ID, call the Deep Security
/api/awsconnectorsettings endpoint to retrieve it (the ExternalId parameter). For
more on this ID, see "What is the external ID?" on page 409
2. In AWS, specify the external ID in your cross-account role's IAM trust policy.
3. Use the /api/awsconnectors API endpoint to add AWS accounts to Deep Security. (Do
not use the /rest/cloudaccounts/aws API because it has been deprecated.) See
https://success.trendmicro.com/solution/000241973 for details on how long the
/rest/cloudaccounts/aws API will continue to be supported and tips on how to move to
the new endpoint.
Add Amazon WorkSpaces
Amazon WorkSpaces are virtual cloud desktops that run in Amazon Web Services (AWS). You
can protect them with Deep Security following the instructions in one of these sections:
l "Protect Amazon WorkSpaces if you already added your AWS account" below
l "Protect Amazon WorkSpaces if you have not yet added your AWS account" on the next
page
Note: The Deep Security Agent only supports Amazon WorkSpaces Windows desktops—it
does not support Linux desktops.
After completing the steps in one of the above-mentioned sections:
l your Amazon WorkSpaces are displayed in Deep Security Manager on the left under
Computers > your_AWS_account > your_region > WorkSpaces
l your Amazon WorkSpaces are protected by the Deep Security Agent
Protect Amazon WorkSpaces if you already added your AWS account
If you already added your AWS account to Deep Security Manager (to protect your Amazon EC2
instances), complete the steps in this section to configure Deep Security to work with Amazon
406
Trend Micro Deep Security On-Premise 20
WorkSpaces.
1. Upgrade Deep Security Manager to version 10.3 or later. See "Install Deep Security
Manager" on page 210.
2. Launch an Amazon WorkSpace, and then install and activate Deep Security Agent 10.2 or
later on it. See "Install the agent on Amazon EC2 and WorkSpaces" on page 279 for
details. Optionally, create a custom WorkSpace bundle so that you can deploy it to many
people. See "Install the agent on an AMI or WorkSpace bundle" on page 285 for details on
installation, activation, and bundle creation.
3. Modify your IAM policy to include Amazon WorkSpaces permissions:
a. Log in to AWS with the account that was added to Deep Security Manager.
b. Go to the IAM service.
c. Find the Deep Security IAM policy. You can find it under Policies on the left, or you
can look for the Deep Security IAM role or IAM user that references the policy and then
click the policy within it.
d. Modify the Deep Security IAM policy to look like the one shown in "Add an AWS
account using a cross-account role" on page 401. The policy includes Amazon
WorkSpaces permissions. If you added more than one AWS account to Deep Security,
the IAM policy must be updated under all the AWS accounts.
4. In Deep Security Manager, edit your AWS account:
a. On the left, right-click your AWS account and select Properties.
b. Enable Include Amazon WorkSpaces.
c. Click Save.
You have now added Amazon WorkSpaces to Deep Security.
Protect Amazon WorkSpaces if you have not yet added your AWS account
If you have not yet added your AWS account to Deep Security Manager, complete the steps in
one of the following sections:
l If you want to protect existing Amazon WorkSpaces, read "Install the agent on Amazon
EC2 and WorkSpaces" on page 279
l If you want to be able to launch new Amazon WorkSpaces with the agent 'baked in', read
"Install the agent on an AMI or WorkSpace bundle" on page 285.
Manage an AWS account
Topics:
407
Trend Micro Deep Security On-Premise 20
l "Edit an AWS account" below
l "Remove an AWS account" below
l "Synchronize an AWS account" below
Edit an AWS account
You can edit an AWS account's settings in Deep Security Manager. You might need to do this if,
for example, your AWS account needs to be configured to include Amazon WorkSpaces. To edit
an AWS account:
1. Log in to Deep Security Manager.
2. Click Computers at the top.
3. On the left, right-click your AWS account name and select Properties.
4. Edit the settings and click OK.
Remove an AWS account
Removing an AWS account from Deep Security Manager permanently removes the account
from the Deep Security database as well as its underlying computers. Your account with AWS is
unaffected and any Deep Security Agents that were installed on the instances are still installed,
running, and providing protection (although they will no longer receive security updates). If you
decide to re-import computers from the AWS account, the Deep Security Agents download the
latest security updates at the next scheduled opportunity.
1. In Deep Security Manager, click Computers at the top.
2. In the navigation panel, right-click the AWS account and select Remove AWS Account.
3. Confirm that you want to remove the account.
The account is removed from the Deep Security Manager.
Synchronize an AWS account
When you synchronize (sync) an AWS account, Deep Security Manager connects to the AWS
API to obtain and display the latest set of AWS EC2 and WorkSpace instances.
To force a sync immediately:
1. In Deep Security Manager, click Computers.
2. On the left, right-click your AWS account and select Synchronize Now.
There is also a background sync that occurs every 10 minutes, and this interval is not
configurable. If you force a sync, the background sync is unaffected and continues to occur
according to its original schedule.
408
Trend Micro Deep Security On-Premise 20
Manage an AWS account external ID
Note: The AWS account external ID is only used when adding an AWS account using a
cross-account role.
Topics:
l "What is the external ID?" below
l "Configure the external ID" below
l "Update the external ID" below
l "Retrieve the external ID" on page 411
l "Disable retrieval of the external ID" on page 411
What is the external ID?
Along with the cross-account role ARN, the external ID is used to grant access from one AWS
role to another. The external ID is provided by a third-party service that wants to assume the role
of your account. If you trust that service to act on your behalf, you add that external ID to your
cross-account role. In this case, Deep Security is the third-party service that is providing an
external ID to you, in order to act on behalf of your AWS account. Deep Security uses this
access to synchronize information from your AWS account and maintain an up-to-date record of
your resources. For details, see this AWS document: How to Use External ID When Granting
Access to Your AWS Resources.
Notes:
l The external ID is only used when adding an AWS account using a cross-account role.
l The same external ID is used for all AWS accounts added using cross-account roles.
There is one ID per tenant.
Configure the external ID
Configuring the external ID is one step in a larger process of adding a cross-account role. See
"Add an AWS account using a cross-account role" on page 401 for details.
Update the external ID
If you previously added an AWS account using cross-account role, you might have specified a
user-defined external ID. To better align with AWS best-practices, Trend Micro recommends
409
Trend Micro Deep Security On-Premise 20
switching to the manager-defined external ID.
Note: AWS accounts that were previously added with a user-defined external ID will continue
to function as normal.
Determine whether you're using a user- or manager-defined external ID
If you're not sure whether you're currently using a user- or manager-defined external ID,
follow the procedure below to find out.
1. Log in to Deep Security Manager.
2. Click Computers.
3. Right-click the AWS account that was added using a cross-account role and
select Properties.
4. If an Update link appears next to the external ID, it means that a user-defined
external ID is currently in use and should be updated. If an Update link does not
appear, it's because the manager-defined external ID is currently in use, and no
action is necessary.
5. Repeat this procedure for each account that has been added to the manager using
a cross-account role.
Update the external ID through the manager
1. If you have not already done so, log in to Deep Security Manager, right-click the
AWS account you want to update, and select Properties.
2. Click the Update link that appears next to the external ID. The Update link
disappears.
3. Note the external ID. You'll need it in the next step to configure the cross-account
role.
4. Log in to the AWS account whose external ID you just updated. Update the cross-
account role's IAM policy by replacing the old external ID with the new one.
5. Back on the properties window, click Apply to apply changes.
Your account's user-defined external ID has now been updated to the manager-
defined one.
6. Repeat this procedure for each account that has been added to the manager using
a cross-account role.
410
Trend Micro Deep Security On-Premise 20
Update the external ID through the Deep Security API
1. If you don't already have the new manager-defined external ID, call the
/api/awsconnectorsettings endpoint to retrieve it (the ExternalId
parameter).
2. Log in to the AWS account where the cross-account role was configured. Update
the cross-account role's IAM policy by replacing the old external ID with the new
one. Repeat this step for each account that has been added to the manager using
a cross-account role.
3. Using the /api/awsconnectors endpoint, perform an Update action on the
account you are updating, with its CrossAccountRoleARN parameter set to the
same role ARN as it is currently. Do not provide an external ID in the request
object.
Your account's user-defined external ID has now been updated to the manager-
defined one.
Retrieve the external ID
There are a few ways to retrieve the external ID for use with cross-accounts.
Through the 'add account' wizard
l See "Add an AWS account using a cross-account role" on page 401 which
includes a sub-section on how to retrieve the external ID through the wizard.
Through the Deep Security API
l Call the /api/awsconnectorsettings endpoint to retrieve it (the ExternalId
parameter).
Disable retrieval of the external ID
You might want to disable the ability to view and retrieve the external ID in the manager to
prevent unauthorized access to it. You can retrieve the ID once, store it in a safe place like your
secrets manager, and then disable the retrieval for everyone else.
411
Trend Micro Deep Security On-Premise 20
Note: Retrieval can be enabled again at any time.
To disable retrieval:
1. Log in to Deep Security Manager.
2. Click Administration at the top.
3. In the main pane, click the Security tab.
4. Deselect Enable retrieval and viewing of AWS external ID.
5. Click Save.
Tip: You can also use roles to prevent access to the external ID. For details, see "Define roles
for users" on page 1166.
Manage AWS regions
Add an Amazon Web Services region
If the Amazon Web Services (AWS) region hosting your EC2 resources does not appear when
you try to add a cloud account using the Add AWS Cloud Account wizard, manually add the
region.
On the server that is hosting Deep Security Manager, enter the command:
1. dsm_c -action addregion -region REGION -display DISPLAY -endpoint
ENDPOINT
where the parameters are:
Parameter Description Example
The Amazon Web Services identifier for the
REGION ca-east-1
region.
The display string to use for the region in the Add Canada East
DISPLAY
AWS Cloud Account wizard. (Ottawa)
The fully-qualified domain name of the Amazon ec2.ca-east-
ENDPOINT Elastic Compute Cloud (EC2) endpoint to use for
the region. 1.amazonaws.com
Note: If Deep Security Manager is running on a Linux server, you must run the command
with sudo or use a superuser account such as root.
412
Trend Micro Deep Security On-Premise 20
2. If the specific AWS region requires that you import a trusted certificate (most don't), see
"Manage trusted certificates" on page 1273.
Viewing your Amazon Web Services regions
You can view any AWS regions that you have added using the CLI.
On the server that is hosting Deep Security Manager, enter the command:
dsm_c -action listregions
Note: If Deep Security Manager is running on a Linux server, you must run the command with
sudo or use a superuser account such as root.
Removing an Amazon Web Services region
You can delete any AWS regions that you have added using the CLI. Any existing cloud
accounts for the region will continue to work unless you remove them, but administrators won't
be able to create new cloud accounts for the region.
1. On the server that is hosting Deep Security Manager, enter the command:
dsm_c -action listregions
2. Find the identifier for the that you want to remove.
3. Enter the command:
dsm_c -action removeregion -region REGION
The REGION parameter is required.
Parameter Description Example
REGION The Amazon Web Services identifier for the region. ca-east-1
Note: If Deep Security Manager is running on a Linux server, you must run the command with
sudo or use a superuser account such as root.
Protect an account running in AWS Outposts
Deep Security supports AWS accounts running on AWS Outposts.
To protect your AWS accounts in Outposts:
413
Trend Micro Deep Security On-Premise 20
1. "Add an AWS account using a manager instance role" on page 395. .
Note: Once you've added your AWS account to Deep Security Manager, the Computers
page will display the resource as part of the AWS region the Outpost is connected to. For
EC2 instances, the ARN of the Outpost rack is added to the instance metadata.
2. "Install the agent on Amazon EC2 and WorkSpaces" on page 279.
3. "Activate the agent" on page 295.
4. "Create policies" on page 447.
Note: High availability is supported. For more information, see "Install Deep Security Manager
on multiple nodes" on page 257.
Add Azure instances
Create an Azure app for Deep Security
In your operating environment, it may not be desirable to allow the Deep Security Manager to
access Azure resources with an account that has both the Global Administrator role for the Azure
Active Directory and the Subscription Owner role for the Azure subscription. As an alternative,
you can create an Azure app for the Deep Security Manager that provides read-only access to
Azure resources.
Tip: If you have multiple Azure subscriptions, you can create a single Deep Security Azure
app for all of them, as long as the subscriptions all connect to the same Active Directory.
Details are provided within the set of instructions below.
To create an Azure app, you will need to:
1. "Assign the correct roles" below.
2. "Create the Azure app" on the next page.
3. "Record the Azure app ID, Active Directory ID, and password" on the next page.
4. "Record the Subscription ID(s)" on page 416.
5. "Assign the Azure app a role and connector" on page 416.
Assign the correct roles
To create an Azure app, your account must have the User Administrator role for the Azure Active
Directory and the User Access Administrator role for the Azure subscription. Assign these roles
414
Trend Micro Deep Security On-Premise 20
to your Azure account before proceeding.
Create the Azure app
1. In the Azure Active Directory blade, click App registrations.
2. Click New registration.
3. Enter a Name (for example, Deep Security Azure Connector).
4. For the Supported account types, select Accounts in this organizational directory only.
5. Click Register.
The Azure app appears in the App registrations list with the Name you chose in Step 3
(above).
Record the Azure app ID, Active Directory ID, and password
1. In the App registrations list, click the Azure app.
Note: The Azure app will display with the Name you chose for it in Step 3 of the "Create
the Azure app" above procedure.
2. Record the Application (client) ID.
3. Record the Active Directory ID
4. Click Certificates & secrets.
5. Click New client secret.
6. Enter a Description for the client secret.
7. Select an appropriate Duration. The client secret expires after this time.
8. Click Add.
The client secret Value appears.
9. Record the client secret Value. This will be used as the Application Password when
registering the Azure app with Deep Security.
Warning: The client secret Value only appears once, so record it now. If you do not, you
must regenerate it to obtain a new Value.
Note: If the client secret Value expires, you must regenerate it and update it in the
associated Azure accounts.
415
Trend Micro Deep Security On-Premise 20
Record the Subscription ID(s)
1. On the left, go to All Services and click Subscriptions.
A list of subscriptions appears.
2. Record the Subscription ID of each subscription you want to associate with the Azure app.
You will need the ID(s) later, when adding the Azure account(s) to Deep Security.
Assign the Azure app a role and connector
1. Under All Services > Subscriptions, click a subscription that you want to associate with the
Azure app.
Note: You can associate another subscription with the Azure app later if you want to.
2. Click Access Control (IAM).
3. In the main pane, click Add and then select Add Role Assignment from the drop-down
menu.
4. Under Role, enter Reader and then click the Reader role that appears.
5. Under Assign access to, select Azure AD user, user group, or service principal.
6. Under Select, enter the Azure app Name (for example, Deep Security Azure
Connector).
The Azure app appears with the Name you chose for it in Step 3 of the "Create the Azure
app" on the previous page procedure.
7. Click Save.
8. If you want to associate the Azure app to another subscription, repeat this procedure
("Assign the Azure app a role and connector" above) for that subscription.
You can now configure Deep Security to add Azure virtual machines by following the
instructions in "Add a Microsoft Azure account to Deep Security" below.
Add a Microsoft Azure account to Deep Security
Once you've installed Deep Security Manager, you can add and protect Microsoft Azure virtual
machines by connecting a Microsoft Azure account to the Deep Security Manager. Virtual
machines appear on the Computers page, where you can manage them like any other computer.
Topics in this section:
416
Trend Micro Deep Security On-Premise 20
l "What are the benefits of adding an Azure account?" below
l "Configure a proxy setting for the Azure account" below
l "Add virtual machines from a Microsoft Azure account to Deep Security" below
l "Manage Azure classic virtual machines with the Azure Resource Manager connector" on
the next page
l "Remove an Azure account" on page 419
l "Synchronize an Azure account" on page 419
What are the benefits of adding an Azure account?
The benefits of adding an Azure account (through Deep Security Manager > Computers > Add
Azure Account) instead of adding individual Azure virtual machines (through Deep Security
Manager > Computers > Add Computer), are:
l Changes in your Azure virtual machine inventory are automatically reflected in Deep
Security Manager. For example, if you delete a number of instances in Azure, those
instances disappear automatically from the manager. By contrast, if you use Computers
> Add Computer, Azure instances that are deleted from Azure remain visible in the
manager until they are manually deleted.
l Virtual machines are organized into their own branch in the manager, which lets you easily
see which Azure instances are protected and which are not. Without the Azure account, all
your virtual machines appear at the same root level under Computers.
Configure a proxy setting for the Azure account
You can configure the Deep Security Manager to use a proxy server to access resources in
Azure accounts. For details, see "Connect to cloud accounts via proxy" on page 1086.
Add virtual machines from a Microsoft Azure account to Deep Security
Add your Microsoft Azure account to Deep Security following the instructions below.
1. Before you begin, create an Azure app for Deep Security.
2. In Deep Security Manager, go to Computers > Add > Add Azure Account.
Note: As of Deep Security Manager 12.0, 'Quick' mode is no longer available. If you
used Quick mode in prior releases, there is no impact to your deployment. All new Azure
Cloud accounts must use the advanced method.
417
Trend Micro Deep Security On-Premise 20
3. Enter a Display name, and then enter the following Azure access information you recorded
in step 1:
l Active Directory ID
l Subscription ID
l Application ID
l Application Password
Note: If you are upgrading from the Azure classic connector to the Azure Resource
Manager connector, the Display name and the Subscription ID of the existing connector
will be used.
Note: If you have multiple Azure subscriptions, specify only one in the Subscription ID
field. You can add the rest later.
4. Click Next.
5. Review the summary information, and then click Finish.
6. Repeat this procedure for each Azure subscription, specifying a different Subscription ID
each time.
The Azure virtual machines will appear in the Deep Security Manager under their own branch on
the Computers page.
Tip: You can right-click your Azure account name and select Synchronize Now to see the
latest set of Azure VMs.
Tip: You will see all the virtual machines in the account. If you'd like to only see certain virtual
machines, use smart folders to limit your results. See "Group computers dynamically with smart
folders" on page 1219 for more information.
Note: If you have previously added virtual machines from this Azure account, they will be
moved under this account in the Computers tree.
Manage Azure classic virtual machines with the Azure Resource Manager
connector
You can also manage virtual machines that were added with the Azure classic connector with
the Azure Resource Manager connector, allowing you to manage both your Azure classic and
Azure Resource Manager virtual machines with a single connector.
418
Trend Micro Deep Security On-Premise 20
For more information, see "Why should I upgrade to the new Azure Resource Manager
connection functionality?" below
1. On the Computers page, in the Computers tree, right-click the Azure classic portal and
then click Properties.
2. Click Enable Resource Manager connection.
3. Click Next. Follow the corresponding procedure above.
Remove an Azure account
Removing an Azure account from the Deep Security Manager will permanently remove the
account from the Deep Security database. This will not affect the Azure account. Virtual
machines with Deep Security Agents will continue to be protected, but will not receive security
updates. If you later import these virtual machines from the same Azure account, the Deep
Security Agents will download the latest security updates at the next scheduled update.
1. Go to the Computers page, right-click on the Microsoft Azure account in the navigation
panel, and select Remove Cloud Account.
2. Confirm that you want to remove the account.
3. The account is removed from the Deep Security Manager.
Synchronize an Azure account
When you synchronize (sync) an Azure account, Deep Security Manager connects to the Azure
API to obtain and display the latest set of Azure VMs.
To force a sync immediately:
1. In Deep Security Manager, click Computers.
2. On the left, right-click your Azure account and select Synchronize Now.
There is also a background sync that occurs every 10 minutes, and this interval is not
configurable. If you force a sync, the background sync is unaffected and continues to occur
according to its original schedule.
Why should I upgrade to the new Azure Resource Manager connection
functionality?
The next time you try to add an Azure cloud account to Deep Security Manager you will be
shown a message suggesting that you upgrade to the new Resource Manager connection
functionality. Basically, this new functionality allows Deep Security to connect to Azure virtual
419
Trend Micro Deep Security On-Premise 20
machines using the Resource Manager interface. As an Azure user, you are probably aware that
the new Azure deployment model Resource Manager is now the default deployment model,
replacing the classic model. Since new resources are deployed using this model by default,
Deep Security is only able to display these VM resources on the Computers page if it is able to
communicate with the Resource Manager interface. So, if you allow Deep Security to upgrade to
this new functionality then VM resources deployed with either the Resource Manager
deployment model or the classic deployment model will be visible on the Computers page.
l You can upgrade to this new functionality in Deep Security as a Service (DSaaS) and in
Deep Security 10. It is already available in the new Deep Security Manager VM for Azure
Marketplace console and no upgrade is needed.
l Until you perform this upgrade VMs deployed using Resource Manager are still being fully
protected by Deep Security but for you to see them on the Computers page they have to be
added as a computer object. For more information, see "Why can't I view all of the VMs in
an Azure subscription in Deep Security?" on page 1518
Add GCP instances
Create a Google Cloud Platform service account
Below is all the information you need to create a Google Cloud Platform (GCP) service account
for use with Deep Security.
Tip: For information on why you might want to create a GCP service account to use with Deep
Security Manager, see "What are the benefits of adding a GCP account?" on page 430.
Topics:
l "Prerequisite: Enable the Google APIs" below
l "Create a GCP service account" on the next page
l "Add more projects to the GCP service account" on page 426
l "Create multiple GCP service accounts" on page 429
Prerequisite: Enable the Google APIs
Before you can create a GCP service account for Deep Security Manager, you'll need to enable
a few Google APIs under your existing GCP account.
Follow the procedure below to enable these APIs inside each of your projects:
420
Trend Micro Deep Security On-Premise 20
1. Log in to Google Cloud Platform using your existing GCP account. This account must have
access to all the GCP projects that contain VMs that you want to protect with Deep
Security.
2. At the top, select a project that includes VMs that you want to add to Deep Security
Manager. If you have multiple projects, you can select them later.
For example: Project01
3. Click Google Cloud Platform at the top to make sure you're on the Home screen.
4. From the tree view on the left, select APIs & Services > Dashboard.
5. Click + ENABLE APIS AND SERVICES.
6. In the search box, enter cloud resource manager API and then click the Cloud
Resource Manager API box.
7. Click ENABLE.
8. Repeat steps 5 - 7 of this procedure, entering compute engine API and clicking the
Compute Engine API box.
9. Repeat steps 1 - 9 of this procedure for any other projects that include VMs that you want to
add to Deep Security Manager.
For more information on how to enable or disable APIs in GCP, refer to this page from Google:
https://cloud.google.com/apis/docs/getting-started
Create a GCP service account
Note: A service account is a special type of Google account that is associated with an
application or VM, instead of an individual end user. Deep Security Manager assumes the
421
Trend Micro Deep Security On-Premise 20
identity of the service account to call Google APIs, so that users aren't directly involved.
Follow the procedure below to create a service account for Deep Security Manager:
1. Before you begin, make sure you've enabled the GCP APIs. See "Prerequisite: Enable the
Google APIs" on page 420.
2. Log in to Google Cloud Platform using your existing GCP account.
3. At the top, select a project. If you have multiple projects, you can select any one. For
example: Project01.
4. Click Google Cloud Platform at the top to make sure you're on the Home screen.
5. From the tree view on the left, select IAM & admin > Service accounts.
6. Click + CREATE SERVICE ACCOUNT.
422
Trend Micro Deep Security On-Premise 20
7. Enter a service account name, ID and description.
For example:
l Service account name: GCP Deep Security
l Service account ID: gcp-deep-security@<your_project_
ID>.iam.gserviceaccount.com
l Service account description: GCP service account for connecting Deep
Security Manager to GCP.
8. Click Create.
9. In the Select a role drop-down list, select the Compute Engine > Compute Viewer role, or
click inside the Type to filter area and enter compute viewer to find it.
423
Trend Micro Deep Security On-Premise 20
10. Click CONTINUE.
You have now assigned the Compute Viewer role.
424
Trend Micro Deep Security On-Premise 20
11. Click + CREATE KEY.
425
Trend Micro Deep Security On-Premise 20
12. Select JSON and click CREATE.
The key is generated and placed in a JSON file.
13. Save the key (JSON file) to a safe place.
14. Place the JSON file in a location that is accessible to Deep Security Manager for later
upload. If you need to move or distribute the file, make sure you do so using secure
methods.
15. Click DONE.
You have now created a GCP service account with necessary roles, as well as a service
account key in JSON format. The service account is created under the selected project
(Project01), but can be associated with additional projects. For details, see the following
section.
Note: It will take 60 seconds - 7 minutes for the IAM permissions to propagate through
the system. See this Google article for details.
Add more projects to the GCP service account
If you have multiple projects in GCP, you must associate them with the service account you just
created. All your projects (and underlying VMs) will then become visible in Deep Security
426
Trend Micro Deep Security On-Premise 20
Manager when you later add the service account to Deep Security Manager.
Note: If you have many projects, you might find it easier to divide them up across multiple
GCP accounts instead of adding them all to just 1, as described below. For details on a multi-
GCP account setup, see "Create multiple GCP service accounts" on page 429.
Follow this procedure to associate additional projects with 1 service account:
1. Before you begin, make sure you have completed the procedures in "Prerequisite: Enable
the Google APIs" on page 420 and "Create a GCP service account" on page 421.
2. Determine the email of the GCP service account you just created, as follows:
a. In Google Cloud Platform, from the drop-down list at the top, select the project under
which you created the GCP service account (in our example, Project01).
b. On the left, expand IAM & Admin > Service accounts.
c. In the main pane, look under the Email column to find the GCP service account email.
For example:
gcp-deep-security@project01.iam.gserviceaccount.com
The service account email includes the name of the project under which it was
created.
d. Note this address or copy it to the clipboard.
3. Still in Google Cloud Platform, go to another project by selecting it from the drop-down list
at the top. For example: Project02.
4. Click Google Cloud Platform at the top to make sure you're on the Home screen.
427
Trend Micro Deep Security On-Premise 20
5. From the tree view on the left, click IAM & admin > IAM.
6. Click ADD at the top of the main pane.
7. In the New members field, paste the Project01 GCP service account email address. For
example:
gcp-deep-security@project01.iam.gserviceaccount.com
Tip: You can also start typing the email address to auto-fill the field.
8. In the Select a role drop-down list, select the Compute Engine > Compute Viewer role, or
click inside the Type to filter area and enter compute viewer to find it.
You have now added the service account with the Compute Viewer role to Project02.
428
Trend Micro Deep Security On-Premise 20
9. Click SAVE.
10. Repeat steps 1 - 9 in this procedure for each project that you want to associate with the
GCP service account.
For more information on how to create a service account, refer to the following page from
Google:
https://cloud.google.com/compute/docs/access/create-enable-service-accounts-for-instances
You are now ready to add the GCP account you just created to Deep Security Manager. Proceed
to "Add a Google Cloud Platform account" below.
Create multiple GCP service accounts
Normally, you would create a single GCP service account for Deep Security Manager and
associate all your projects to it. This configuration is straightforward and works well for smaller
organizations with fewer projects. If, however, you have a large number of projects, having them
all under the same GCP service account might make them difficult to manage. In this scenario,
you can divide your projects across multiple GCP service accounts. Here's how you would set
this up, assuming your projects were spread across your organization's Finance and Marketing
departments:
1. Create a Finance GCP Deep Security GCP service account for Deep Security
Manager.
2. Add finance-related projects to Finance GCP Deep Security.
3. Create a Marketing GCP Deep Security GCP service account for Deep Security
Manager.
4. Add marketing-related projects to Marketing GCP Deep Security.
For detailed instructions, see "Create a GCP service account" on page 421 and "Add more
projects to the GCP service account" on page 426
5. After creating the GCP service accounts, add them to Deep Security Manager one by one,
following the instructions "Add a Google Cloud Platform account" below.
Add a Google Cloud Platform account
When you add a Google Cloud Platform (GCP) account to Deep Security, all GCP VM instances
associated with that account are imported into Deep Security Manager and become visible in:
l Deep Security Manager > Computers > your_GCP_service_account > your_GCP_project
Once imported, the GCP VM instances can be managed like any other computer.
429
Trend Micro Deep Security On-Premise 20
Note: Adding a GCP account to Deep Security Manager is equivalent to adding a GCP
connector through the Deep Security API.
Topics:
l "What are the benefits of adding a GCP account?" below
l "Configure a proxy setting for the GCP account" below
l "Add a GCP account to Deep Security" below
l "Remove a GCP account" on page 432
l "Synchronize a GCP account" on page 433
What are the benefits of adding a GCP account?
The benefits of adding a GCP account (through Deep Security Manager > Computers > Add
GCP Account) instead of adding individual GCP VMs (through Deep Security Manager >
Computers > Add Computer), are:
l Changes in your GCP VM inventory are automatically reflected in Deep Security Manager.
For example, if you delete a number of VM instances in GCP, those instances
disappear automatically from the manager. By contrast, if you use Computers > Add
Computer, GCP instances that you've deleted remain visible in the manager until you
manually delete them.
l VMs are organized into projects in the manager, which lets you easily see which GCP VMs
are protected and which are not. Without the GCP account, all your GCP VMs appear at
the same root level under Computers.
Configure a proxy setting for the GCP account
Optionally, you can configure the Deep Security Manager to use a proxy server to access
resources in GCP service accounts. For details, see "Connect to cloud accounts via proxy" on
page 1086.
Add a GCP account to Deep Security
To add a GCP account to Deep Security Manager:
1. If you have not done so already, "Create a Google Cloud Platform service account" on
page 420 for Deep Security.
430
Trend Micro Deep Security On-Premise 20
2. In Deep Security Manager, go to Computers > Add > Add GCP Account.
3. Enter a Display Name. We recommend using the GCP service account name. Examples:
GCP Deep Security, Finance GCP Deep Security, Marketing GCP Deep
Security.
4. Choose the Service Account Key. The key is a JSON file that you saved earlier, when
creating the GCP service account. See "Create a Google Cloud Platform service account"
on page 420 for details.
5. Click Next.
6. Review the summary information, and then click Close.
The following occurs:
431
Trend Micro Deep Security On-Premise 20
l Deep Security Manager displays your GCP service account and its associated
projects in their own branch on the left side of the Computers page (see image below).
Associated VMs are displayed in the main pane. You can right-click your GCP service
account name and select Synchronize Now to see the latest set of GCP VMs.
l If you previously added VM instances from this service account through the
Computers > Add Computers option (instead of the Computers > Add GCP Account
option described here), these VMs are moved to the correct project under the service
account you just added. This move occurs only for VMs that have Deep Security Agent
12.0 or later installed. VMs with pre-12.0 agents remain listed under the root
Computers folder.
The following image shows the imported GCP service account, projects, and a VM.
7. Repeat the steps in this procedure for each GCP service account you want to add.
You have now added a GCP service account to Deep Security Manager. Proceed to
"Install the agent on Google Cloud Platform VMs" on page 289 if you have not done so
already.
Remove a GCP account
Removing a GCP account from the Deep Security Manager permanently removes the account
from the Deep Security database. This does not affect the GCP account. VM instances with
Deep Security Agents continue to be protected, but do not receive security updates. If you later
reactivate Deep Security Agents on these VM instances, the Deep Security Agents will
download the latest security updates at the next scheduled update.
To remove a GCP account:
432
Trend Micro Deep Security On-Premise 20
1. In Deep Security Manager, click Computers at the top.
2. Right-click the GCP account in the tree view on the left, and select Remove Cloud
Account.
3. Confirm that you want to remove the account.
The account is removed from the Deep Security Manager.
Synchronize a GCP account
When you synchronize (sync) a GCP account, Deep Security Manager connects to the GCP API
to obtain and display the latest set of GCP VMs.
To force a sync immediately:
1. In Deep Security Manager, click Computers.
2. On the left, right-click your GCP account and select Synchronize Now.
There is also a background sync that occurs every 10 minutes, and this interval is not
configurable. If you force a sync, the background sync is unaffected and continues to occur
according to its original schedule.
Add VMWare VMs
Add a VMware vCenter
You can import a VMware vCenter into Deep Security Manager and then protect its virtual
machines either agentlessly, with an agent, or in combined mode. (For information on those
options, see "Choose agentless vs. combined mode protection" on page 302.)
Note: You cannot import a vCenter that is using vShield Manager. For information on
migrating from vShield Manager to a supported VMware product, see "Install Deep Security
Manager" on page 210.
You have the following options for adding a vCenter:
l "Add a vCenter" on the next page
l "Add multiple vCenters" on page 438
l "Add a vCenter - FIPS mode" on page 438
433
Trend Micro Deep Security On-Premise 20
Add a vCenter
1. In Deep Security Manager, go to Computers > Add > Add VMware vCenter.
The following page appears:
2. Enter vCenter information:
l Server Address: The vCenter server's IP address (or host name if DNS is configured
and able to resolve FQDNs to IP addresses).
l Server Port: The port number to connect to the vCenter (443 by default).
l Name: The name of the vCenter that will appear in the manager.
l Description: A description for the vCenter.
l Username and Password: Enter the user name and password of a vCenter or NSX
user account. This account must conform to the specifications in the tables below, and
is required to synchronize the VM inventory between vCenter and Deep Security
Manager.
Note: Applying the Read Only or Administrator role at the Hosts and Clusters or Virtual
Machine level in vCenter causes synchronization problems.
vCenter user account specifications
434
Trend Micro Deep Security On-Premise 20
Protection
NSX Type vCenter user account specifications
method
The vCenter user account must have the following
two roles:
VMware NSX l Enterprise Administrator role assigned in NSX
Data Center for Manager. For information on assigning roles in
vSphere (NSX-
NSX-V Manager, see this VMware article.
V)
agentless l Administrator role assigned at the data center
or
combined level in vCenter.
mode
The vCenter user account must have the following
VMware NSX-T role:
Data Center
(NSX-T) l Administrator role assigned at the data center
level in vCenter.
No NSX-V or The vCenter user account must have the vCenter
agent
NSX-T Read Only role (or another role that has equal or
only
integration greater privileges) at the data center level.
3. Accept the vCenter TLS (SSL) certificate.
4. Click Next.
The following page appears:
435
Trend Micro Deep Security On-Premise 20
Note: If you don't see the NSX binding options at the top of the page, it's because you're
using an older version of the manager. Upgrade your manager to FR 2019-12-12 to see
the options.
5. Fill out the page as follows:
l Select Configure NSX Manager to bind with vCenter and then enter your NSX
information as described below if you plan on using agentless or combined mode
protection. Otherwise, select Configure vCenter without NSX binding and click Next .
l Manager Address: The NSX Manager IP address (or host name if DNS is configured
and able to resolve FQDNs to IP addresses).
l Manager Port: The port number to connect to NSX Manager (443 by default).
l Username and Password: The user name and password of an NSX or vCenter user
account. This account must conform to the specifications in the table below. This user
436
Trend Micro Deep Security On-Premise 20
is required to synchronize NSX security policies and security groups with Deep
Security Manager.
NSX user account specifications
NSX Type User account specifications
The user account must be:
l the NSX built-in administrator account (which has full
permissions).
Or
VMware NSX
l a vCenter user account with the following two roles:
Data Center for
l Enterprise Administrator role assigned in NSX
vSphere (NSX-V)
Manager. For information on assigning roles in NSX-V
Manager, see this VMware article.
l Administrator role assigned at the data center level in
vCenter. (Applying this role at the cluster level causes
errors.)
The user account must be:
l the NSX built-in admin account (Enterprise Admin, which
has full permissions).
Or
l an NSX-T user account with LDAP credentials with the
VMware NSX-T
Data Center following roles (or other roles that have equal or greater
(NSX-T) privileges):
l GI Partner Admin for Endpoint Protection.
l Netx Partner Admin for E-W Network Introspection.
For details on the privileges assigned to the various VMware
roles, see this VMware article. For details on assigning roles in
NSX-T Manager, see this VMware article.
437
Trend Micro Deep Security On-Premise 20
6. Click Next.
7. Review the NSX and vCenter information and click Finish.
8. The VMware vCenter has been successfully added message is displayed. Click
Close.The vCenter will appear on the Computers page.
Tip: If you select Create an Event Based task to automatically activate VMs added to
protected NSX Security Groups in this vCenter when adding the vCenter, Deep
Security Manager will create two event-based tasks. One activates VMs when protection
is added and the other deactivates VMs when protection is removed. For more
information, see "Automated policy management in NSX environments" on page 368.
If you provided your NSX information as described above, Deep Security Manager registers the
Deep Security service within NSX Manager. The registration permits the deployment of the
Deep Security service to the ESXi servers.
In a large environment with more than 3000 machines reporting to a vCenter Server, this process
may take 20 to 30 minutes to complete. You can check the vCenter's Recent Task section to
verify if there are activities running.
Deep Security Manager will maintain real-time synchronization with this VMware vCenter to
keep the information displayed in Deep Security Manager (number of VMs, their status, etc.) up
to date.
Add multiple vCenters
To add multiple vCenters to Deep Security Manager:
1. Add the first vCenter and NSX Manager following the instructions in "Add a vCenter" on
page 434.
2. Repeat the steps in "Add a vCenter" on page 434 for subsequent vCenters and associated
NSX Managers you want to add.
Add a vCenter - FIPS mode
To add a vCenter when Deep Security Manager is in FIPS mode:
1. Import the vCenter and NSX Manager TLS (SSL) certificates into Deep Security Manager
before adding the vCenter to the manager. See "Manage trusted certificates" on
page 1273.
2. Add a vCenter following the steps in "Add a vCenter" on page 434. The steps are exactly
the same, except that in FIPS mode you will see a Trusted Certificate section on the
438
Trend Micro Deep Security On-Premise 20
vCenter page. Click Test Connection to check whether the vCenter's SSL certificate has
been imported successfully into Deep Security Manager. If there are no errors, click Next
and continue on through the wizard.
Add virtual machines hosted on VMware vCloud
Once you have imported the resources from the cloud provider account into the Deep Security
Manager, the computers in the account are managed like any computer on a local network.
To import cloud resources into Deep Security Manager, Deep Security users must first have a
account with which to access the cloud provider service resources. For each Deep Security user
who will import a cloud account into the Deep Security Manager, Trend Micro recommends
creating a dedicated account for that Deep Security Manager to access the cloud resources.
That is, users should have one account to access and control the virtual machines themselves,
and a separate account for their Deep Security Manager to connect to those resources.
Note: Having a dedicated account for Deep Security ensures that you can refine the rights and
revoke this account at any time. It is recommended to give Deep Security an access key or
secret key with read-only rights at all times.
Note: The Deep Security Manager only requires read-only access to import the cloud
resources and mange their security.
Note: When FIPS mode is enabled, you cannot add virtual machines hosted on VMware
vCloud. See "FIPS 140-2 support" on page 1417.What are the benefits of adding an Azure
account?
Topics in this section:
l "What are the benefits of adding a vCloud account?" on the next page
l "Proxy setting for cloud accounts" on the next page
l "Create a VMware vCloud Organization account for the manager" on the next page
l "Import computers from a VMware vCloud Organization Account" on page 441
l "Import computers from a VMware vCloud Air data center" on page 441
l "Configure software updates for cloud accounts" on page 442
l "Remove a cloud account" on page 442
439
Trend Micro Deep Security On-Premise 20
What are the benefits of adding a vCloud account?
The benefits of adding a vCloud account (through Deep Security Manager > Computers > Add
Azure Account) instead of adding individual vCloud resources (through Deep Security Manager
> Computers > Add Computer), are:
l Changes in your cloud resource inventory are automatically reflected in Deep Security
Manager. For example, if you delete a number of instances from vSphere, those instances
disappear automatically from the manager. By contrast, if you use Computers > Add
Computer, cloud instances that are deleted from vCenter remain visible in the manager
until they are manually deleted.
l Cloud resources are organized into their own branch in the manager, which lets you easily
see which resources are protected and which are not. Without the vCloud account, all your
cloud resources appear at the same root level under Computers.
Proxy setting for cloud accounts
You can configure Deep Security Manager to use a proxy server specifically for connecting to
instances being protected in cloud accounts. The proxy setting can be found in Administration >
System Settings > Proxies > Proxy Server Use > Deep Security Manager (Cloud Accounts -
HTTP Protocol Only).
Create a VMware vCloud Organization account for the manager
1. Log in to VMware vCloud Director.
2. On the System tab, go to Manage And Monitor.
3. In the left navigation pane, click Organizations.
4. Double-click the Organization you wish to give the Deep Security user access to.
5. On the Organizations tab, click Administration.
6. In the left navigation pane, go to Members > Users.
7. Click the " plus " sign to create a new user.
8. Enter the new user's credentials and other information, and select Organization
Administrator as the user's Role.
Note: Organization Administrator is a simple pre-defined Role you can assign to the
new user account, but the only privilege required by the account is All Rights > General
> Administrator View and you should consider creating a new vCloud role with just this
permission. For more detailed information on preparing vCloud resources for Deep
Security integration, see "Deploy the appliance in a vCloud environment" on page 364.
440
Trend Micro Deep Security On-Premise 20
9. Click OK to close the new user's properties window.
The vCloud account is now ready for access by a Deep Security Manager.
Note:
To import the VMware vCloud resources into the Deep Security Manager, users will be
prompted for the Address of the vCloud, their User name , and their Password .
The User name must include "@orgName". For example if the vCloud account's username is
kevin and the vCloud Organization you've given the account access to is called CloudOrgOne,
then the Deep Security user must enter kevin@CloudOrgOne as their username when
importing the vCloud resources.
(For a vCloud administrator view, use @system.)
Import computers from a VMware vCloud Organization Account
1. In the Deep Security Manager, go to Computers.
2. Right-click Computers in the navigation panel and select Add vCloud Account to display
the Add vCloud Cloud Account wizard.
3. In Name and Description, enter the resources you are adding. (These are only used for
display purposes in the Deep Security Manager.)
4. In Address, enter the hostname or address of vCloud Director.
5. In User Name and Password, enter vCloud authentication credentials. User names should
have the format username@vcloudorganization.
6. Click Next.
7. Deep Security Manager will verify the connection to the cloud resources and display a
summary of the import action. Click Finish.
The VMware vCloud resources now appear in the Deep Security Manager under their own
branch on Computers.
Import computers from a VMware vCloud Air data center
1. In the Deep Security Manager, go to the Computers section, right-click Computers in the
navigation panel and select Add vCloud Account to display the Add vCloud Account
wizard.
2. Enter a Name and Description of the vCloud Air data center you are adding. (These are
only used for display purposes in the Deep Security Manager.)
3. Enter the Address of the vCloud Air data center.
441
Trend Micro Deep Security On-Premise 20
To determine the address of the vCloud Air data center:
a. Log in to your vCloud Air portal.
b. On the Dashboard tab, click on the data center you want to import into Deep Security.
This will display the Virtual Data Center Details information page.
c. In the Related Links section of the Virtual Data Center Details page, click on vCloud
Director API URL. This will display the full URL of the vCloud Director API.
d. Use the hostname only (not the full URL) as the Address of the vCloud Air data center
that you are importing into Deep Security.
4. In User Name and Password, enter virtual data center credentials. User names should
have the format username@virtualdatacenterid.
5. Click Next.
6. Deep Security Manager will verify the connection to the vCloud Air data center and display
a summary of the import action. Click Finish.
The VMware vCloud Air data center now appears in the Deep Security Manager under its own
branch on Computers.
Configure software updates for cloud accounts
Relays are modules within Deep Security Agents that are responsible for the download and
distribution of Security and Software updates. Normally, the Deep Security Manager informs the
relays when new updates are available, the relays get the updates and then the agents get their
updates from the relays.
However, if your Deep Security Manager is in an enterprise environment and you are managing
computers in a cloud environment, relays in the cloud may not be able to communicate with
Deep Security Manager. You can solve this problem by allowing the relays to obtain software
updates directly from the Trend Micro Download Center when they cannot connect to the Deep
Security Manager. To enable this option, go to Administration > System Settings > Updates
and under Software Updates, select Allow Relays to download software updates from Trend
Micro Download Center when Deep Security Manager is not accessible.
Remove a cloud account
Removing a cloud provider account from Deep Security Manager permanently removes the
account from the Deep Security database. Your account with your cloud provider is unaffected
and any Deep Security agents that were installed on the instances will still be installed, running,
and providing protection (although they will no longer receive security updates.) If you decide to
re-import computers from the Cloud Provider Account, the Deep Security Agents will download
the latest Security Updates at the next scheduled opportunity.
442
Trend Micro Deep Security On-Premise 20
1. Go to the Computers page, right-click on the Cloud Provider account in the navigation
panel, and select Remove Cloud Account.
2. Confirm that you want to remove the account.
3. The account is removed from the Deep Security Manager.
Add an ESXi to a protected NSX cluster
If you have already protected ESXi servers inside a cluster with Deep Security Virtual Appliance,
and you now want to add another ESXi to that cluster, read the instructions below to ensure the
new ESXi server is protected.
1. Before you begin, make sure you have deployed the appliance to the cluster. See "Deploy
the appliance (NSX-T 3.x)" on page 308 or "Deploy the appliance (NSX-V)" on page 341
for instructions.
2. Add the ESXi to the Data Center but not directly to the cluster.
3. Connect ESXi to the the virtual distributed switch (vDS) if necessary. For NSX-T, make
sure the ESXi host has available NIC(s) for the NSX-T Virtual Distributed Switch (N-VDS).
These NICs will be automatically configured by NSX-T Manager according to your Fabric
settings.
4. Move the ESXi into the cluster. If the cluster has been configured with NSX-T, you will see
the installation progress in NSX-T Manager under System > Fabric > Host Transport
Nodes.
Once the ESXi host is moved into the cluster, NSX should automatically deploy the Deep
Security service.
Note: Connecting to an NSX Manager is supported in FIPS mode. See "FIPS 140-2 support"
on page 1417.
How do I migrate to the new cloud connector functionality?
If you previously used the "Add Cloud Account" wizard to import Amazon Web Services
resources into Deep Security Manager, those resources are organized by AWS region on
Computers. You may have run the wizard more than once if you have multiple AWS regions.
The latest versions of Deep Security provide the ability to display your AWS instances under
your AWS account name, organized in a hierarchy that includes the AWS Region, VPC, and
subnet.
443
Trend Micro Deep Security On-Premise 20
Before migrating your AWS resources, you will need to edit the policy that allows Deep Security
to access your AWS account:
1. Log in to your Amazon Web Services Console and go to Identity and Access
Management (IAM).
2. In the left navigation pane, click Policies.
3. In the list of policies, select the policy that allows Deep Security to access your AWS
account.
4. Go to the Policy Document tab and click Edit.
5. Edit the policy document to include this JSON code:
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "cloudconnector",
"Effect": "Allow",
"Action": [
"ec2:DescribeImages",
"ec2:DescribeInstances",
"ec2:DescribeRegions",
"ec2:DescribeSubnets",
"ec2:DescribeTags",
"ec2:DescribeVpcs",
"iam:ListAccountAliases",
"sts:AssumeRole"
],
"Resource": [
"*"
]
}
]
}
Note: The "sts:AssumeRole" permission is required only if you are using cross-
account role access. For more information on IAM roles, see Tutorial: Delegate Access
Across AWS Accounts Using IAM Roles.
6. Select Save as default version.
To migrate your AWS resources in the Deep Security Manager:
444
Trend Micro Deep Security On-Premise 20
1. In the Deep Security Manager, go to the Computers page.
2. In the Computers tree, right-click an AWS region and select Upgrade to Amazon Account.
3. Click Finish and then Close. Your AWS instances will now appear under your AWS
account name, organized in a hierarchy that includes the AWS Region, VPC, and subnet.
Protect Docker containers
The benefits of a Docker deployment are real, but so is the concern about the significant attack
surface of the Docker host's operating system (OS) itself. Like any well-designed software
deployment, OS hardening and the use of best practices for your deployment, such as the
Center for Internet Security (CIS) Docker Benchmark, provide a solid foundation as a starting
point. Once you have a secure foundation in place, adding Deep Security to your deployment
gives you access to Trend Micro’s extensive experience protecting physical, virtual, and cloud
workloads as well as to real-time threat information from the Trend Micro Smart Protection
Network. Deep Security both protects your deployment as well as helps meet and maintain
continuous compliance requirements. See "Docker support" on page 139 for information on
supported Docker editions and releases.
Deep Security protects your Docker hosts and containers running on Linux distributions. Deep
Security can do the following:
l Identify, find, and protect Docker hosts within your deployment through the use of badges
and smart folders
l Protect Docker hosts and containers from vulnerabilities to protect them against known and
zero-day exploits by virtually patching new found vulnerabilities
l Provide real-time anti-malware detection for the file systems used on Docker hosts and
within the containers
l Assert the integrity of the Docker host for continuous compliance and to protect your
deployment using the following techniques:
l Prevent the unauthorized execution of applications on Docker hosts by helping you
control which applications are allowed to run in addition to the Docker daemon
l Monitor Docker hosts for unexpected changes to system files
l Notify you of suspicious events in your OS logs
Note: Deep Security Docker protection works at the OS level. This means that the Deep
Security Agent must be installed on the Docker host's OS, not inside a container.
445
Trend Micro Deep Security On-Premise 20
Note: Communication between containers in the pod is not supported.
Beginning with Deep Security 10.1, Deep Security supports Docker in swarm mode while using
an overlay network.
Deep Security protection for the Docker host
The following Deep Security modules can be used to protect the Docker host:
l Intrusion Prevention (IPS)
l Anti-Malware
l Integrity Monitoring
l Log Inspection
l Application Control
l Firewall
l Web Reputation
Deep Security protection for Docker containers
The following Deep Security modules can be used to protect Docker containers:
l Intrusion Prevention
l Anti-Malware
Limitation on Intrusion Prevention recommendation scans
Although Deep Security Intrusion Prevention controls work at the host level, it also protects
container traffic on the exposed container port numbers. Since Docker allows multiple
applications to run on the same Docker host, a single Intrusion Prevention policy is applied to all
Docker applications. This means that recommendation scans should not be relied upon for
Docker deployments.
446
Trend Micro Deep Security On-Premise 20
Configure policies
Create policies
Policies allow collections of rules and configuration settings to be saved for easier assignment to
multiple computers. You can use the Policy editor 1 to create and edit policies that you can then
apply to one or more computers. You can also use the Computer editor 2 (which is very similar to
the Policy editor) to apply settings to a specific computer, but the recommended method is to
create specialized policies rather then edit the settings in the Computer editor.
Tip: You can automate policy creation and configuration using the Deep Security API. For
examples, see the Create and Configure Policies guide in the Deep Security Automation
Center.
In this article:
l "Create a new policy" below
l "Other ways to create a policy" on the next page
l "Edit the settings for a policy or individual computer" on page 449
l "Assign a policy to a computer" on page 449
l "Disable automatic policy updates" on page 450
l "Send policy changes manually" on page 450
l "Export a policy" on page 451
Create a new policy
1. Click Policies > New > New Policy.
2. Enter a name for the policy. If you want the new policy to inherit its settings from an existing
policy, select a policy from the Inherit from list. Click Next.
Tip: For information on inheritance, see "Policies, inheritance, and overrides" on
page 451.
1To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
2To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
447
Trend Micro Deep Security On-Premise 20
3. Select whether you want to base this policy on an existing computer's configuration and
then click Next.
4. If you selected Yes in step 3:
a. Select a computer to use as the basis for the new policy and click Next.
b. Specify which protection modules will be enabled for the new policy. If this policy is
inheriting its settings from an existing policy, those settings will be reflected here. Click
Next.
c. On the next screen, select the properties that you want to carry into the new policy and
click Next. Review the configuration and click Finish.
5. If you selected No in step 3, specify which protection modules will be enabled for the new
policy. If this policy is inheriting its settings from an existing policy, those settings will be
reflected here. Click Finish.
6. Click Close. Next, you can edit the settings for the policy, as described in "Edit the settings
for a policy or individual computer" on the next page.
Other ways to create a policy
There are several ways to create a policies on the Policies page:
l Create a new policy as described above.
l Click New > Import From File to import policies from an XML file.
l
Note: When importing policies, ensure that the system where you created the policies
and the system that will receive them both have the latest security updates. If the system
that is receiving the policies is running an older security update, it may not have some of
the rules referenced in the policies from the up-to-date system.
l Duplicate (and then modify and rename) an existing policy. To do so, right-click an existing
policy you want to duplicate and then click Duplicate.
l Create a new policy based on a recommendation scan of a computer. To do so, go to the
Computers page, right-click a computer and select Actions > Scan for Recommendations.
When the scan is complete, return to the Policies page and click New to display the New
Policy wizard. When prompted, choose to base the new policy on "an existing computer's
current configuration". Then select "Recommended Application Types and Intrusion
Prevention Rules", "Recommended Integrity Monitoring Rules", and "Recommended Log
Inspection Rules" from among the computer's properties.
448
Trend Micro Deep Security On-Premise 20
l
Note: The Policy will consist only of recommended elements on the computer,
regardless of what Rules are currently assigned to that computer.
Edit the settings for a policy or individual computer
The Policies page shows your existing policies in their hierarchical tree structure. To edit the
settings for a policy, select it and click Details to open the policy editor.
These sections are available in the Computer or Policy editor 1:
l Overview (the "Overview section of the policy editor" on page 474 and "Overview section
of the computer editor" on page 468 are different)
l Anti-Malware
l Web Reputation
l Firewall
l Intrusion Prevention
l Integrity Monitoring
l Log Inspection
l Application Control
l Interface Types
l Settings
l Overrides
Assign a policy to a computer
1. Go to Computers.
2. Select your computer from the Computers list, right click and choose Actions > Assign
Policy.
3. Select the policy from the hierarchy tree and click OK.
One of the following occurs:
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
449
Trend Micro Deep Security On-Premise 20
l If you set the communication direction to Manager Initiated or Bidirectional, the policy is
sent immediately to the agent computer.
l If you set the communication direction to Agent/Appliance Initiated, then the policy is sent
when the next agent heartbeat occurs.
For more information on how child policies in a hierarchy tree can inherit or override the settings
and rules of parent policies, see "Policies, inheritance, and overrides" on the next page.
After assigning a policy to a computer, you should still run periodic recommendation scans on
your computer to make sure that all vulnerabilities on the computer are protected. See "Manage
and run recommendation scans" on page 456 for more information.
Disable automatic policy updates
By default, any changes to a security policy are automatically sent to the computers that use the
policy. You can change this so automatic sending is disabled, and you must manually send the
policy.
1. Open the Policy editor 1 for the policy to configure.
2. Go to Settings > General > Send Policy Changes Immediately.
3. Next to Automatically send Policy changes to computers, select Yes to allow automatic
sending of policy changes. To disable automatic sending, and only allow manually
sending, select No.
4. Click Save to apply the changes.
Send policy changes manually
If you make a policy change and want to send the policy changes manually to a particular
computer, follow the instructions below.
1. Go to Computers .
2. Double-click your computer from the Computers list.
3. In the navigation pane, make sure Overview is selected.
4. In the main pane, click the Actions tab.
5. Under Policy, click Send Policy.
One of the following occurs:
1To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
450
Trend Micro Deep Security On-Premise 20
l If you set the communication direction to Manager Initiated or Bidirectional, the policy is
sent immediately to the agent computer.
l If you set the communication direction to Agent/Appliance Initiated, then the policy is sent
when the next agent heartbeat occurs.
Export a policy
To export a policy to an XML file, select a policy from the policies tree and click Export > Export
Selected to XML (For Import).
Note: When you export a selected policy to XML, any child policies that the policy may have
are included in the exported package. The export package contains all the actual objects
associated with the policy except: intrusion prevention rules, log inspection rules, integrity
monitoring rules, and application types.
Policies, inheritance, and overrides
Policies in Deep Security are intended to be created in a hierarchical structure. As an
administrator, you begin with one or more base policies from which you create multiple levels of
child policies that get progressively more granular in their detail. You can assign broadly
applicable rules and other configuration settings at the top-level policies and then get more
targeted and specific as you go down through levels of child policies, eventually arriving at rule
and configuration assignments at the individual computer level.
As well as assigning more granular settings as you move down through the policy tree, you can
also override settings from higher up the policy tree.
Deep Security provides a collection of policies that you can use as initial templates for the
design of your own policies tailored to your environment:
451
Trend Micro Deep Security On-Premise 20
In this topic:
l "Inheritance" below
l "Overrides" on the next page
l "View the overrides on a computer or policy at a glance" on page 455
Inheritance
Child policies inherit their settings from their parent policies. This allows you to create a policy
tree that begins with a base parent policy configured with settings and rules that will apply to all
computers. This parent policy can then have a set of child and further descendant policies which
have progressively more specific targeted settings. Your policy trees can be built based on any
kind of classification system that suits your environment. For example, the branch in the policy
tree that comes with Deep Security has two child policies, one designed for a server hosting the
Deep Security Manager and one designed for the Deep Security Virtual Appliance. This is a
role-based tree structure. Deep Security also has three branches designed for specific operating
systems, Linux, Solaris, and Windows. The windows branch has further child policies for various
sub-types of Windows operating systems.
In the Windows policy editor on the Overview page, you can see that the Windows policy was
created as a child of the Base policy. The policy's anti-malware setting is Inherited (Off):
452
Trend Micro Deep Security On-Premise 20
This means that the setting is inherited from the parent Base policy, and that if you were to
change the anti-malware setting in the Base policy from Off to On, the setting would change in
the Windows policy as well. (The Windows policy setting would then read Inherited (On). The
value in parentheses always shows you what the current inherited setting is.)
Overrides
The Overrides page shows you how many settings have been overridden at this policy or
specific computer level. To undo the overrides at this level, click the Remove button.
In this example, the Windows Server policy is a child policy of the Windows policy. Here, the
anti-malware setting is no longer inherited; it is overridden and hard-set to On.
453
Trend Micro Deep Security On-Premise 20
Tip: You can automate override checking, creation, and removal using the Deep Security API.
For examples, see the Configure Computers to Override Policies guide in the Deep Security
Automation Center.
Override object properties
The intrusion prevention rules that are included in this policy are copies of the intrusion
prevention rules stored by the Deep Security Manager which are available for use by any other
policies. If you want to change the properties of a particular rule, you have two choices: modify
the properties of the rule globally so that the changes you make apply to all instances where the
rule is in use, or modify the properties locally so that the changes you make only apply locally.
The default editing mode in a Computer or policy editor is local. If you click Properties on the
Assigned Intrusion Prevention Rules area toolbar, any changes you make in the Properties
window that appears will only apply locally. (Some properties like the rule name can't be edited
locally, only globally.)
454
Trend Micro Deep Security On-Premise 20
Right-clicking a rule displays a context menu which gives you the two Properties editing mode
options: selecting Properties will open the local editor window and Properties (Global) will
open the global editor window.
Most of the shared common objects in Deep Security can have their properties overridden at any
level in the policy hierarchy right down to the individual computer level.
Override rule assignments
You can always assign additional rules at any policy or computer level. However, rules that are
in effect at a particular policy or computer level because their assignment is inherited from a
parent policy cannot be unassigned locally. They must be unassigned at the policy level where
they were initially assigned.
Tip: If you find yourself overriding a large number of settings, you should probably consider
branching your parent policy.
View the overrides on a computer or policy at a glance
You can see the number of settings that have been overridden on a policy or a computer by
going to the Overrides page in the computer or policy Editor:
455
Trend Micro Deep Security On-Premise 20
Overrides are displayed by protection module. You can revert system or module overrides by
clicking the Remove button.
Manage and run recommendation scans
Deep Security can run recommendation scans on computers to help identify intrusion
prevention, integrity monitoring, and log inspection rules that should be applied or removed.
Tip: Recommendation scans provide a good starting point for establishing a list of rules that
you should implement, but there are some important additional rules that are not identified by
recommendation scans. You should implement those rules manually. See "Implement
additional rules for common vulnerabilities" on page 464
You can configure recommendation scans and implement the recommended rules for individual
computers or at the policy level. For large deployments, Trend Micro recommends managing
456
Trend Micro Deep Security On-Premise 20
recommendations through policies. This way, you can make all your rule assignments from a
single source (the policy) rather than having to manage individual rules on individual computers.
This can mean that some rules are assigned to computers on which they are not required;
however, the minimal effect on performance is outweighed by the ease of management that
results from using policies. If you enable recommendation scans in policies, use separate
policies for scanning Windows and Linux computers, to avoid assigning Windows rules to Linux
computers, and vice-versa.
l "What gets scanned?" below
l "Scan limitations" on the next page
l "Run a recommendation scan" on page 459
l "Automatically implement recommendations" on page 462
l "Check scan results and manually assign rules" on page 463
l "Configure recommended rules" on page 464
l "Implement additional rules for common vulnerabilities" on page 464
l "Troubleshooting: Recommendation Scan Failure" on page 466
What gets scanned?
During a recommendation scan, Deep Security Agents scan the operating system for:
l installed applications
l the Windows registry
l open ports
l the directory listing
l the file system
l running processes and services
l environment variables
l users
The Deep Security Virtual Appliance can perform agentless recommendation scans on virtual
machines but only on Windows platforms and is limited to scanning the operating system for:
l installed applications
l the Windows registry
l the file system
457
Trend Micro Deep Security On-Premise 20
Scan limitations
Certain technical or logical limitations result in the rules for some types of software not being
accurately recommended, or not recommended at all:
l On Unix/Linux systems, the recommendation scan engine might have trouble detecting
software that is not installed through the operating system's default package manager, for
example, Apache Struts, Wordpress, or Joomla. Applications installed using standard
package managers are not a problem.
l On Unix/Linux systems, rules for desktop application vulnerabilities or local vulnerabilities
(for example, browsers and media players) are not included in recommendation scans.
l Generic web application protection rules are not included in recommendation scans.
l Smart rules are generally not included in recommendation scans unless they address a
major threat or a specific vulnerability. Smart rules address one or more known and
unknown (zero-day) vulnerabilities. Rule lists in Deep Security Manager identify smart
rules with "Smart" in the Type column.
l When dealing with rules related to a content management system (CMS), the
recommendation scan cannot detect the CMS installation and installed version. It also
cannot detect the plug-ins installed with a CMS and their versions. As a result, whenever a
recommendation scan finds a web server installed and PHP installed or running on a
system, all CMS-related intrusion prevention rules get recommended. This may result in
the over-recommendation of rules, but balances the need for security vs. accuracy.
l The recommendations for the following web technologies may suggest more rules than
necessary, so some tailoring may be required:
l Red Hat JBoss
l Eclipse Jetty
l Apache Struts
l Oracle WebLogic
l WebSphere
l Oracle Application Testing Suite
l Oracle Golden Gate
l Nginx
l OpenSSL rules are recommended on Windows only when OpenSSL is explicitly installed.
If OpenSSL in being used internally by an application but it was not installed as a separate
package, a recommendation scan does not detect it.
458
Trend Micro Deep Security On-Premise 20
l On Linux systems, rules for Java-related vulnerabilities do not get recommended if web
browsers are the only applicable vector.
l Recommendation scans cannot detect the Adobe Flash Player plug-in that is included in a
default Chrome installation. Recommendations are based on the Chrome version, which
means some unnecessary rules may be recommended.
Run a recommendation scan
Because changes to your environment can affect which rules are recommended, it's best to run
recommendation scans on a regular basis (the best practice is to perform recommendation
scans on a weekly basis). Trend Micro releases new intrusion prevention rules on Tuesdays, so
it's recommended that you schedule recommendation scans shortly after those releases. The
use of system resources, including CPU cycles, memory, and network bandwidth, increases
during a recommendation scan so it's best to schedule the scans at non-peak times.
There are several ways to run recommendation scans:
l Scheduled task: Create a scheduled task that runs recommendation scans according to a
schedule that you configure. You can assign the scheduled task to all computers, one
individual computer, a defined computer group, or all computers protected by a particular
policy. See "Create a scheduled task to regularly run recommendation scans" on the next
page.
l Ongoing scans: Configure a policy so that all computers protected by the policy are
scanned for recommendations on a regular basis. You can also configure ongoing scans
for individual computers. This type of scan checks the timestamp of the last scan that
occurred and then and follows the configured interval thereafter to perform future scans.
This results in recommendation scans occurring at different times in your environment.
This setting is helpful in environments where an agent might not be online for more than a
few days (for example, in cloud environments that are building and decommissioning
instances frequently). See "Configure an ongoing scan" on the next page
l Manual scans: Run a single recommendation scan on one or more computers. A manual
scan is useful if you’ve recently made significant platform or application changes and want
to force a check for new recommendations instead of waiting for a scheduled task. See
"Manually run a recommendation scan" on page 461.
l Command line: Initiate a recommendation scan via the Deep Security command-line
interface. See "Command-line basics" on page 1348.
459
Trend Micro Deep Security On-Premise 20
l API: Initiate a recommendation scan via the Deep Security API. See "Use the Deep
Security API to automate tasks" on page 1376.
Note: Scheduled tasks and ongoing scans are each capable of running recommendation
scans independently with their own settings. Use either the scheduled tasks or ongoing scans,
but not both.
Once a recommendation scan has run, alerts are raised on the all computers for which
recommendations have been made.
Create a scheduled task to regularly run recommendation scans
1. In the Deep Security Manager, go to the Administration > Scheduled Tasks page.
2. Click New on the toolbar and select New Scheduled Task to display the New Scheduled
Task wizard.
3. In the Type list, select Scan Computers for Recommendations and then select how often
you want the scan to occur. Click Next.
4. Depending on your choice in step 3, the next page lets you be more specific about the
scan frequency. Make your selection and click Next.
5. Now select which computer(s) to scan and click Next.
Note: You can select all computers, choose one individual computer, select a group of
computers, or select computers that are assigned a particular policy. For large
deployments, it's best to perform all actions, including recommendation scans, through
policies.
6. Give a name to your new scheduled task, select whether or not to Run Task on 'Finish',
click Finish.
Configure an ongoing scan
1. In the Deep Security Manager, open the Computer or Policy editor 1, depending on
whether you want to configure the scan for an individual computer or for all computers that
are using a policy.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
460
Trend Micro Deep Security On-Premise 20
Note: For large deployments, it's best to perform all actions, including recommendation
scans, through policies.
2. Click Settings. On the General tab, under Recommendations, the Perform ongoing
Recommendation Scans setting enables or disables ongoing recommendation scans. The
Ongoing Scan Interval setting specifies how often the scans occur. Both of those settings
can be inherited from the computer or policy's parent (see "Policies, inheritance, and
overrides" on page 451 for details about how inheritance works).
Manually run a recommendation scan
1. In the Deep Security Manager, go to the Computers page.
2. Select the computer or computers you want to scan.
3. Click Actions > Scan for Recommendations.
Cancel a recommendation scan
You can cancel a recommendation scan before it starts running.
1. In the Deep Security Manager, go to the Computers page.
2. Select the computer or computers where you want to cancel the scans.
3. Click Actions > Cancel Recommendation Scan.
Exclude a rule or application type from recommendation scans
If you don't want a particular rule or application type to be included in recommendation scan
results, you can exclude it from scans.
1. In the Deep Security Manager, open the Computer or Policy editor 1.
Note: For large deployments, it's best to perform all actions, including recommendation
scans, through policies.
2. Depending on which type of rule you want to exclude, go to the Intrusion Prevention,
Integrity Monitoring, or Log Inspection page.
3. On the General tab, click Assign/Unassign (for rules) or Application Types (for application
types).
4. Double-click the rule or application type that you want to exclude.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
461
Trend Micro Deep Security On-Premise 20
5. Go to the Options tab. For rules, set Exclude from Recommendations to "Yes" or
"Inherited (Yes)". For application types, select the Exclude from Recommendations
checkbox.
Automatically implement recommendations
You can configure Deep Security to automatically implement recommendation scan results
when it is appropriate to do so:
1. In the Deep Security Manager, open the Computer or Policy editor 1.
Note: For large deployments, it's best to perform all actions, including recommendation
scans, through policies.
2. Depending on which type of rules you want to implement automatically, go to the Intrusion
Prevention, Integrity Monitoring, and/or Log Inspection pages. (You can change the
setting independently for each protection module.)
3. On the General tab, under Recommendations, change the setting to "Yes" or "Inherited
(Yes)".
Not all recommendations can be implemented automatically. The exceptions are:
l Rules that require configuration before they can be applied.
l Rules that are excluded from recommendation scans.
l Rules that have been automatically assigned or unassigned but that a user has
overridden. For example, if Deep Security automatically assigns a rule and you
subsequently unassign it, the rule is not reassigned after the next recommendation scan.
l Rules that have been assigned at a higher level in the policy hierarchy cannot be
unassigned at a lower level. A rule assigned to a computer at the policy level must be
unassigned at the policy level.
l Rules that Trend Micro has issued but which may pose a risk of producing false positives.
(This will be addressed in the rule description.)
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
462
Trend Micro Deep Security On-Premise 20
Check scan results and manually assign rules
The results of the latest recommendation scan are displayed in the Computer or Policy editor 1,
on the General tab of the protection module (Intrusion Prevention, Integrity Monitoring, and Log
Inspection).
The example below describes how to deal with intrusion prevention recommendation scan
results via a policy:
1. Once a recommendation scan is complete, open the policy that is assigned to the
computers you have just scanned.
2. Go to Intrusion Prevention > General. The number of unresolved recommendations (if
any) is displayed in the Recommendations section.
3. Click Assign/Unassign to open the rule assignment window.
4. Sort the rules By Application Type and select Recommended for Assignment from the
display filter menu:
This displays a list of rules that are recommended for assignment but that have not been
assigned.
5. To assign a rule to the policy, select the checkbox next to the rule name. Rules flagged
with a icon have configuration options that you can set. Rules flagged with a icon
have settings that must be configured before the rule is enabled.)
Alternatively, to assign several rules at once, use the Shift or Control keys to select the
rules, right-click the selection, and click Assign Rule(s).
Tip: The results of a recommendation scan can also include recommendations to unassign
rules. This can happen when applications are uninstalled, when security patches from a
manufacturer are applied, or when unnecessary rules have been applied manually. To view
rules that are recommended for unassignment, select Recommended for Unassignment from
the display filter menu.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
463
Trend Micro Deep Security On-Premise 20
Note: Recommended rules are indicated by a full flag ( ) . A partial flag ( ) identifies an
application type where only some of the rules that are part of the application type have been
recommended.
Configure recommended rules
Some rules require configuration before they can be applied. For example, some log inspection
rules require that you specify the location of the log files to be inspected for change. If this is the
case, an alert is raised on the computer on which the recommendation has been made. The text
of the alert will contain the information required to configure the rule. In the policy or computer
editor, rules flagged with a icon have configuration options that you can set. Rules flagged
with a icon have settings that must be configured before the rule is enabled.
Implement additional rules for common vulnerabilities
Recommendation scans provide a good starting point for establishing a list of rules that you
should implement, but there are some additional rules for common vulnerabilities that are not
identified by recommendation scans because they need to be carefully configured and tested
before being implemented in "prevent" (block) mode. Trend Micro recommends that you
configure and test these rules, then manually enable them in your policies (or for individual
computers):
Tip: This list includes the most common of the additional rules you should configure. You can
find others in Deep Security Manager by searching for rules whose type is "Smart" or "Policy".
Rule name Application type
1007598 - Identified Possible Ransomware File Rename Activity Over DCERPC
Network Share Services
1007596 - Identified Possible Ransomware File Extension Rename DCERPC
Activity Over Network Share Services
DCERPC
1006906 - Identified Usage Of PsExec Command Line Tool
Services
1007064 - Executable File Uploaded On System32 Folder Through DCERPC
SMB Share Services
464
Trend Micro Deep Security On-Premise 20
Rule name Application type
DCERPC
1003222 - Block Administrative Share
Services
1001126 - DNS Domain Blocker DNS Client
1000608 - Generic SQL Injection Prevention
Web Application
See "Configure an SQL injection prevention rule" on page 635 for
Common
details.
Web Application
1005613 - Generic SQL Injection Prevention - 2
Common
Web Application
1000552 - Generic Cross Site Scripting (XSS) Prevention
Common
Web Application
1006022 - Identified Suspicious Image With Embedded PHP Code
Common
Web Application
1005402 - Identified Suspicious User Agent In HTTP Request
Common
Web Application
1005934 - Identified Suspicious Command Injection Attack
Common
Web Application
1006823 - Identified Suspicious Command Injection Attack - 1
Common
1005933 - Identified Directory Traversal Sequence In Uri Query Web Application
Parameter Common
1006067 - Identified Too Many HTTP Requests With Specific HTTP Web Server
Method Common
Web Server
1005434 - Disallow Upload Of A PHP File
Common
Web Server
1003025 - Web Server Restrict Executable File Uploads
Common
Web Server
1007212 - Disallow Upload Of An Archive File
Common
1007213 - Disallow Upload Of A Class File Web Server
465
Trend Micro Deep Security On-Premise 20
Rule name Application type
Common
Troubleshooting: Recommendation Scan Failure
If you are receiving a Recommendation Scan Failure on your server, follow the steps below to
resolve the issue. If the issue continues to persist after troubleshooting, create a diagnostic
package from the agent and contact support.
Communication
Typically for communication issues "protocol error" will appear in the body of the error message.
If you don't have open inbound firewall ports from the Deep Security Manger to the agent, open
the ports or switch to agent-initiated communication. For more information, see "Activate and
protect agents using agent-initiated activation and communication" on page 1138.
Server resources
Monitor the CPU and memory resources on the server. If the memory or CPU is becoming
exhausted during the scan, increase the resources.
Timeout values
Increase the timeout values for the recommendation scan.
Note: dsm_c commands are not available on Deep Security as a Service.
1. Open the command prompt and navigate to the Deep Security Manager installation folder.
2. Enter the commands below (if this is a multi-tenant environment, add the tenant name):
dsm_c -action changesetting -name
settings.configuration.agentSocketTimeoutOverride -value 1200
dsm_c -action changesetting -name
settings.configuration.defaultSocketChannelTimeout -value 1200000
dsm_c -action changesetting -name
settings.configuration.recoScanKeepAliveTimeInterval -value 180000
466
Trend Micro Deep Security On-Premise 20
3. If you are using the Deep Security Virtual Appliance, also enter these commands:
dsm_c -action changesetting -name
settings.configuration.timeoutEpsecScanRequest -value 1770
dsm_c -action changesetting -name
settings.configuration.timeoutDsamCommandChannel -value 1800
Detect and configure the interfaces available on a computer
The Computer and Policy editors contain an Interfaces (in the Computer editor) and Interface
Types (in the Policy editor) section that displays the interfaces detected on the computer. If a
policy with multiple interface assignments has been assigned to the computer, interfaces that
match the patterns defined in the policy will be identified.
The Interface Types section of the Policy editor provides additional capabilities:
Configure a policy for multiple interfaces
If you have computers with more than one interface, you can assign various elements of a policy
(firewall rules, etc.) to each interface.
1. In the Policy editor, click Interface Types.
2. In the Network Interface Specificity section, select Rules can apply to specific interfaces
3. In the Interface Type sections that appear, type the names and pattern matching strings.
The interface type name is used only for reference. Common names include "LAN", "WAN",
"DMZ", and "Wi-Fi", though any name can be used to map to your network's topology.
The interface name used for all container network interfaces and host virtual interfaces is
"integrated_veth", which has a MAC address of 02:00:00:00:00:00.
The matches define a wildcard-based interface name to auto map the interfaces to the
appropriate interface type. Examples would be "Local Area Connection *", "eth*", or"Wireless *".
When an interface cannot be mapped automatically, an alert is triggered. You can manually map
it from the Interfaces page in the computer editor for a particular computer.
Note: If Deep Security detects interfaces on the computer that don't match any of these entries,
the manager will trigger an alert.
467
Trend Micro Deep Security On-Premise 20
Enforce interface isolation
When Interface Isolation is enabled, the firewall will try to match the regular expression patterns
to interface names on the local computer. To enforce interface isolation, click Enable Interface
Isolation option on the Policy or Computer Editor > Firewall > Interface Isolation tab and enter
string patterns that will match the names of the interfaces on a computer (in order of priority).
Warning: Before you enable Interface Isolation make sure that you have configured the
interface patterns in the proper order and that you have removed or added all necessary string
patterns. Only interfaces matching the highest priority pattern will be permitted to transmit
traffic. Other interfaces (which match any of the remaining patterns on the list) will be
"restricted". Restricted Interfaces will block all traffic unless an Allow Firewall Rule is used to
allow specific traffic to pass through.
Selecting Limit to one active interface will restrict traffic to only a single interface even if more
than one interface matches the highest priority pattern.
Note: Deep Security uses POSIX basic regular expressions to match interface names. For
information on basic POSIX regular expressions, see
https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap09.html#tag_09_03
Overview section of the computer editor
The computer editor Overview page has the following tabbed sections:
l "General tab" below
l "Actions tab" on page 472
l "TPM tab" on page 473
l "System Events tab" on page 474
General tab
l Hostname: Appears in the Name column on the Computers page. The name must be
either the IP address of the computer or the hostname of the computer. Either a fully
qualified hostname or a relative hostname can be used if a hostname is used instead of an
IP address. You have to specify a hostname that can be resolved or a valid IP address that
468
Trend Micro Deep Security On-Premise 20
the Deep Security Manager can access. This is because the communication between the
Deep Security Manager and the agent computers are based on the hostname. For relay-
enabled agents, all of the computers within the relay group should be able to reach the
specified IP address or hostname. If the Deep Security Manager cannot access the target
computer the communication direction should be set to Agent/Appliance Initiated (Settings
> Computer).
l (Last IP Used: <IP_address> ): The last IP used by the computer. Last IP Used may not
always show the IP address of the Deep Security Agent's host. Instead, it could be the IP
address of a proxy, load balancer, elastic load balancer (ELB), etc., that the agent uses to
communicate with Deep Security Manager.
l Display Name: Appears in the Display Name column and in brackets next to the
Hostname value.
l Description: a description of the computer.
l Platform: Details of the computer's OS will appear here.
l Group: The computer group to which the computer belongs appears in the list. You can
reassign the computer to any other existing computer group.
l Policy: The policy (if any) that has been assigned to this computer.
Note: Keep in mind that if you unassign a policy from a computer, rules may still be in
effect on the computer if they were assigned independently of the policy.
l Asset Importance: Deep Security Manager uses a ranking system to quantify the
importance of security events. Rules are assigned a severity level (high, medium, low,
etc.), and assets (computers) are assigned an "asset importance" level. These levels have
numerical values. When a rule is triggered on a computer the asset importance value and
the severity level value are multiplied together. This produces a score which is used to sort
events by importance. (Event ranking can be seen in the Events pages.) Use this Asset
Importance list to assign an asset importance level to this computer. (To edit the
numerical values associated with severity and importance levels, go to Administration >
System Settings > Ranking.)
l Download Security Updates From: Use the dropdown list to select which relay group the
agent/appliance on this computer will download security updates from. (not displayed if
agent is acting as a relay.)
469
Trend Micro Deep Security On-Premise 20
Computer status
The Status area displays the latest available information about the computer and the protection
modules in effect on it. Whether the computer is protected by an agent or an appliance (or both in
the case of combined mode) is displayed in the top row.
l Status:
l When the computer is unmanaged the status represents the state of the agent or
appliance with respect to activation. The status will display either "Discovered" or
"New" followed by the agent or appliance state in brackets ("No Agent/Appliance",
"Unknown", "Reactivation Required", "Activation Required", or "Deactivation
Required").
l When the computer is managed and no computer errors are present, the status will
display "Managed" followed by the state of the agent or appliance in brackets
("Online" or "Offline").
l When the computer is managed and the agent or appliance is in the process of
performing an action (e.g. "Integrity Scan in Progress", "Upgrading Agent (Install
Program Sent)", etc.) the task status will be displayed.
l When there are errors on the computer (e.g., "Offline", "Update Failed", etc.) the status
will display the error. When more than one error is present, the status will display
"Multiple Errors" and each error will be listed beneath.
Protection module status
With Deep Security 9.5 and later, protection modules are deployed to agents on an as-needed
basis. Only core functionality is included when an agent is first installed.
The Status area provides information about the state of the Deep Security modules. The status
reflects the state of a module on the agent as well as its configuration in Deep Security Manager.
A status of "On" indicates that the module is configured in Deep Security Manager and is
installed and operating on the Deep Security Agent.
A green status light is displayed for a module when it is "On" and working. In addition, modules
that allow individual rule assignment must have at least one rule assigned before they will
display a green light.
l Anti-Malware: Whether Anti-Malware protection is on or off and whether it is configured for
real-time or on-demand scans.
l Web Reputation: Whether Web Reputation is on or off.
470
Trend Micro Deep Security On-Premise 20
l Firewall: Whether the Firewall is on or off and how many rules are in effect.
l Intrusion Prevention: Whether Intrusion Prevention is on or off and how many rules are in
effect.
l Integrity Monitoring: Whether Integrity Monitoring is on or off and how many rules are in
effect.
l Log Inspection: Whether Log Inspection is on or off and how many rules are in effect.
l Application Control: Whether Application Control is on or off.
l Scanner (SAP): Status of the Deep Security Scanner SAP feature.
l Online: Indicates whether the manager can currently communicate with the agent or
appliance.
l Last Communication: The last time the manager successfully communicated with the
agent or appliance on this computer.
l Check Status: This button allows you to force the manager to perform an immediate
heartbeat operation to check the status of the agent or appliance. Check Status will not
perform a security update of the agent or appliance. When manager to agent or appliance
communications is set to "Agent/Appliance Initiated" the Check Status button is disabled.
Checking status will not update the logs for this computer. To update the logs for this
computer, go to the Actions tab.
l Clear Warnings/Errors: Dismisses any alerts or errors on this computer.
l ESXi server: If the computer is a virtual machine protected by a virtual appliance, the ESXi
server that hosts them is displayed.
l Appliance: If the computer is a virtual machine protected by a virtual appliance, the
protecting appliance is displayed.
l ESXi Version: If the computer is an ESXi server, the ESXi version number is displayed.
l Filter Driver version: If the computer is an ESXi server, the filter driver version number is
displayed. If you are using Deep Security Virtual Appliance 10.0 or later with ESXi 6.0 or
later, "N/A" will be displayed because no filter driver is in use.
l Guests: If the computer is an ESXi server, the virtual appliance and guests are displayed.
l Appliance Version: If the computer is a virtual appliance, the appliance version number is
displayed.
l Protected Guests On: If the computer is a virtual appliance, the IP of the ESXi server and
the protected guest are displayed.
471
Trend Micro Deep Security On-Premise 20
VMware virtual machine summary
This section displays a summary of hardware and software configuration information about the
virtual machine on which the agent or appliance is running (VMware virtual machines only).
Actions tab
Activation
A newly installed Deep Security agent or appliance needs to be "activated" by the Deep
Security Manager before policies, rules, requests for event logs, etc. can be sent to it. The
activation procedure includes the exchange of SSL keys which uniquely identify a manager (or
one of its nodes) and an agent/appliance to each other. Once activated by a Deep Security
Manager, an agent/appliance will only accept instructions or communicate with the Deep
Security Manager which activated it (or one of its nodes).
An unactivated agent or appliance can be activated by any Deep Security Manager.
Agents and appliances can only be deactivated locally on the computer or from the Deep
Security Manager which activated it. If an agent or appliance is already activated, the button in
this area will read Reactivate rather than Activate. Reactivation has the same effect as
activation. A reactivation will reset the agent or appliance to the state it was in after first being
installed and initiate the exchange of a new set of SSL keys.
Policy
When you change the configuration of an agent or appliance on a computer using the Deep
Security Manager (apply a new Intrusion Prevention rule, change logging settings, etc.) the
Deep Security Manager has to send the new information to the agent or appliance. This is a
"Send Policy" instruction. Policy updates usually happen immediately but you can force an
update by clicking the Send Policy button.
Agent Software
This displays the version of the agent or appliance currently running on the computer. If a newer
version of the agent or appliance is available for the computer's platform you can click the
Upgrade Agent or Upgrade Appliance button to remotely upgrade the agent or appliance from
the Deep Security Manager. You can configure the Deep Security Manager to trigger an alert if
new versions of the agent or appliance software running on any of your computers by going to
the Administration > System Settings > Updates tab.
472
Trend Micro Deep Security On-Premise 20
Note: Before updating or uninstalling a Deep Security Agent or Relay on Windows, you must
disable agent self-protection. To do this, on the Deep Security Manager, go to Computer
editor 1 > Settings > General. In Agent Self Protection, and then either deselect Prevent local
end-users from uninstalling, stopping, or otherwise modifying the Agent or enter a password
for local override.
Support
The Create Diagnostic Package button creates a snapshot of the state of the agent or appliance
on the computer. Your support provider may request this for troubleshooting purposes.
If you have lost communication with the computer, a diagnostics package can be created locally.
For more information, see "Create a diagnostic package and logs" on page 1550.
TPM tab
Note: The TPM tab will appear in place of the Actions tab for ESXi servers.
A Trusted Platform Module (TPM) is a type of chip that is used for hardware authentication.
VMware uses the TPM with its ESXi hypervisors. During the boot sequence, an ESXi writes a
SHA-1 hash of each hypervisor component to a set of registers as it loads. An unexpected
change in these values from one boot sequence to the next can indicate a possible security
issue worth investigating. Deep Security can monitor the TPM on an ESXi after every boot and
raise an Alert if it detects any changes. If you select the option to enable TPM monitoring on an
ESXi that doesn't support it, the option will be automatically disabled.
Enable TPM Monitoring: Select to enable Trusted Platform Module monitoring.
Raise an alert when TPM Monitoring fails to obtain valid register values: Select to have Deep
Security raise an alert if the Trusted Platform Module fails to obtain valid register values for the
hypervisor components during the ESXi boot sequence.
TPM Register Data Imported: Indicates whether the Trusted Protection Module data has been
imported.
TPM Last Checked: Indicates when the Trusted Protection Module was last checked. You can
click Check Now to start a check of the Trusted Platform Module.
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
473
Trend Micro Deep Security On-Premise 20
Note: The minimum requirements for TPM monitoring are
l TPM/TXT installed and enabled on the ESXi (consult your VMware documentation for
details)
l The Deep Security Integrity Monitoring and Application Control modules must be
properly licensed.
System Events tab
For information about events, see " System events" on page 984.
Overview section of the policy editor
The Overview section of the policy editor has the following tabbed sections:
l "General tab" below
l "Computer(s) Using This Policy tab" on the next page
l "Events tab" on the next page
General tab
General
l Name: Appears in the Display Name column and in brackets next to the Hostname value.
l Description: a description of the computer.
Inheritance
Identifies the parent policy (if any) from which the current policy inherits its settings.
Modules
l Anti-Malware: Whether anti-malware protection is on or off and whether it is configured for
real-time or on-demand scans.
l Web Reputation: Whether web reputation is on or off.
l Firewall: Whether the firewall is on or off and how many rules are in effect.
474
Trend Micro Deep Security On-Premise 20
l Intrusion Prevention: Whether intrusion prevention is on or off and how many rules are in
effect.
l Integrity Monitoring: Whether integrity monitoring is on or off and how many rules are in
effect.
l Log Inspection: Whether log inspection is on or off and how many rules are in effect.
l Application Control: Whether application control is on or off.
Computer(s) Using This Policy tab
Lists computers to which this policy has been assigned.
Events tab
For information about events, see " System events" on page 984.
Network engine settings
To edit the network engine settings of a policy or computer, open the Policy editor 1 or the
Computer editor 2 for the policy or computer to configure and click Settings > Advanced .
Note: The Advanced tab also contains Events settings. For information on those settings, see
"Limit log file sizes" on page 831. It also contains the Generate an Alert when Agent
configuration package exceeds maximum size setting, which controls the display of the
"Agent configuration package too large" setting.
The following settings are available:
l Network Engine Mode : The network engine is a component within the Intrusion
Prevention, Firewall, and Web Reputation modules that decides whether to block or allow
packets. For the Firewall and Intrusion Prevention modules, the network engine performs a
packet sanity check and also makes sure each packet passes the Firewall and Intrusion
Prevention rules (called, rules matching). The network engine can operate inline or in tap
1To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
2To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
475
Trend Micro Deep Security On-Premise 20
mode. When operating inline, the packet stream passes through the network engine and is
either dropped or passed based on the rules you've set. Stateful tables are maintained,
Firewall rules are applied and traffic normalization is carried out so that Intrusion
Prevention and Firewall rules can be applied. When operating in tap mode, the packet is
always passed, with the exception of driver hooking issue or interface isolation. In tap
mode, packet delay is also introduced, which can create a drop in throughput.
l Failure Response: The settings here determine how the network engine behaves when it
finds faulty packets. The default is to block them (Fail closed), but you can let some of them
through (Fail open) for the reasons explained below.
476
Trend Micro Deep Security On-Premise 20
l Network Engine System Failure: This setting determines whether the network engine
blocks or allows faulty packets that occur as a result of system failures on the network
engine host, such as out of memory failures, allocated memory failures, and network
engine (DPI) decoding failures occur. The options are:
l Fail closed (default): The network engine blocks the faulty packet. It does not
perform rules matching. This option provides the highest level of security.
l Fail open: The network engine allows the faulty packet through, does not perform
rules matching, and logs an event. Consider using Fail open if your agent or
virtual appliance frequently encounters network exceptions because of heavy
loads or lack of resources.
l Network Packet Sanity Check Failure: This setting determines whether the network
engine blocks or allows packets that fail the packet sanity checks. Examples of sanity
check failures: Firewall sanity check failures, network layer 2, 3, or 4 attribute check
failures, TCP state check failures. The options are:
l Fail closed (default): The network engine blocks the failed packet. It does not
perform any rules matching. This option provides the highest level of security.
l Fail open: The network engine allows the failed packet, does not perform any
rules matching on it, and logs an event. Consider using Fail open if you want to
disable the packet sanity checks, but preserve rules matching functionality.
l Anti-Evasion Posture: The anti-evasion setting controls the network engine handling of
abnormal packets that may be attempting to evade analysis. For details, see "Configure
anti-evasion settings" on page 652.
l Advanced Network Engine Options: If you deselect the Inherited check box, you can
customize these settings:
l CLOSED timeout: For gateway use. When a gateway passes on a "hard close"
(RST), the side of the gateway that received the RST will keep the connection alive for
this amount of time before closing it.
l SYN_SENT Timeout: How long to stay in the SYN-SENT state before closing the
connection.
l SYN_RCVD Timeout: How long to stay in the SYN_RCVD state before closing the
connection.
l FIN_WAIT1 Timeout: How long to stay in the FIN-WAIT1 state before closing the
connection.
477
Trend Micro Deep Security On-Premise 20
l ESTABLISHED Timeout: How long to stay in the ESTABLISHED state before closing
the connection.
l ERROR Timeout: How long to maintain a connection in an Error state. (For UDP
connections, the error can be caused by any of a variety of UDP problems. For TCP
connections, the errors are probably due to packets being dropped by the Firewall.)
l DISCONNECT Timeout: How long to maintain idle connections before disconnecting.
l CLOSE_WAIT Timeout: How long to stay in the CLOSE-WAIT state before closing
the connection.
l CLOSING Timeout: How long to stay in the CLOSING state before closing the
connection.
l LAST_ACK Timeout: How long to stay in the LAST-ACK state before closing the
connection.
l ACK Storm timeout: The maximum period of time between retransmitted ACKs within
an ACK Storm. In other words, if ACKs are being retransmitted at a lower frequency
then this timeout, they will NOT be considered part of an ACK Storm.
l Boot Start Timeout: For gateway use. When a gateway is booted, there may already
exist established connections passing through the gateway. This timeout defines the
amount of time to allow non-SYN packets that could be part of a connection that was
established before the gateway was booted to close.
l Cold Start Timeout: Amount of time to allow non-SYN packets that could belong to a
connection that was established before the stateful mechanism was started.
l UDP Timeout: Maximum duration of a UDP connection.
l ICMP Timeout: Maximum duration of an ICMP connection.
l Allow Null IP: Allow or block packets with no source or destination IP address.
l Block IPv6 on Agents and Appliances versions 8 and earlier: Block or Allow IPv6
packets on older version 8.0 agents and appliances.
Note: Deep Security Agents and Appliances versions 8.0 and older are unable to
apply Firewall or DPI rules to IPv6 network traffic and so the default setting for these
older versions is to block IPv6 traffic.
l Block IPv6 on Agents and Appliances versions 9 and later: Block or Allow IPv6
packets on agents and appliances that are version 9 or later.
l Connection Cleanup Timeout: Time between cleanup of closed connections (see
next).
478
Trend Micro Deep Security On-Premise 20
l Maximum Connections per Cleanup: Maximum number of closed connections to
cleanup per periodic connection cleanup (see previous).
l Block Same Src-Dest IP Address: Block or allow packets with same source and
destination IP address. (Doesn't apply to loopback interface.)
l Maximum TCP Connections: Maximum simultaneous TCP Connections.
l Maximum UDP Connections: Maximum simultaneous UDP Connections.
l Maximum ICMP Connections: Maximum simultaneous ICMP Connections.
l Maximum Events per Second: Maximum number of events that can be written per
second.
l TCP MSS Limit: 'TCP MSS' is a parameter in the TCP header that defines the
maximum segment size of TCP segments, in bytes. The 'TCP MSS Limit' setting
defines the minimum value allowed for TCP MSS parameter. Having a lower limit for
this parameter is important because it prevents kernel panic and denial of service
(DoS) attacks that may occur when a remote attacker sets up a TCP connection with a
very small maximum segment size (MSS). See CVE-2019-11477, CVE-2019-11478,
and CVE-2019-11479 for details on these attacks. The 'TCP MSS Limit' default is 128
bytes, which shields against most attack sizes. A value of 'No Limit' means that there is
no lower limit and any TCP MSS value is accepted.
Note: The TCP MSS Limit option only works with the following Deep Security
Agent versions:
Deep Security Agent 20
Deep Security Agent 12.0 update 1 or later
Deep Security Agent 11.0 update 13 or later
Deep Security Agent 10.0 update 20 or later
l Number of Event Nodes: The maximum amount of kernel memory the driver will use
to store log/event information for folding at any one time.
Note: Event folding occurs when many events of the same type occur in succession.
In such cases, the agent/appliance will "fold" all the events into one.
l Ignore Status Code: This option lets you ignore certain types of events. If, for example,
you are getting a lot of "Invalid Flags" you can simply ignore all instances of that event.
l Ignore Status Code: Same as above.
l Ignore Status Code: Same as above.
479
Trend Micro Deep Security On-Premise 20
l Advanced Logging Policy:
l Bypass: No filtering of events. Overrides the "Ignore Status Code" settings (above)
and other advanced settings, but does not override logging settings defined in the
Deep Security Manager. For example, if Firewall stateful configuration logging
options set from a Firewall Stateful Configuration Properties window in the Deep
Security Manager will not be affected.
l Normal: All events are logged except dropped retransmits.
l Default: Will switch to "Tap Mode" (below) if the engine is in tap mode, and will
switch to "Normal" (above) if the engine is in inline mode.
l Backwards Compatibility Mode: For support use only.
l Verbose Mode: Same as "Normal" but including dropped retransmits.
l Stateful and Normalization Suppression: Ignores dropped retransmit, out of
connection, invalid flags, invalid sequence, invalid ack, unsolicited udp,
unsolicited ICMP, out of allowed policy.
l Stateful, Normalization, and Frag Suppression: Ignores everything that "Stateful
and Normalization Suppression" ignores as well as events related to
fragmentation.
l Stateful, Frag, and Verifier Suppression: Ignores everything "Stateful,
Normalization, and Frag Suppression" ignores as well as verifier-related events.
l Tap Mode: Ignores dropped retransmit, out of connection, invalid flags, invalid
sequence, invalid ack, max ack retransmit, packet on closed connection.
Note: For a more comprehensive list of which events are ignored in Stateful and
Normalization Suppression; Stateful, Normalization, and Frag Suppression;
Stateful, Frag, and Verifier Suppression; and Tap modes, see "Reduce the number
of logged events" on page 842.
l Silent TCP Connection Drop: When Silent TCP Connection Drop is on, a RST
packet is only sent to the local stack. No RST packet is sent on the wire. This reduces
the amount of information sent back to a potential attacker.
Note: If you enable the Silent TCP Connection Drop you must also adjust the
DISCONNECT Timeout. Possible values for DISCONNECT Timeout range from 0
seconds to 10 minutes. This must be set high enough that the connection is closed
by the application before it is closed by the Deep Security agent/appliance. Factors
480
Trend Micro Deep Security On-Premise 20
that will affect the DISCONNECT Timeout value include the operating system, the
applications that are creating the connections, and network topology.
l Enable Debug Mode: When in debug mode, the agent/appliance captures a certain
number of packets (specified by the setting below: Number of Packets to retain in
Debug Mode). When a rule is triggered and debug mode is on, the agent/appliance
will keep a record of the last X packets that passed before the rule was triggered. It will
return those packets to the manager as debug events.
Note: Debug mode can very easily cause excessive log generation and should only
be used under Client Services supervision.
l Number of Packets to retain in Debug Mode: The number of packets to retain and log
when debug mode is on.
l Log All Packet Data: Record the packet data for events that are not associated with
specific Firewall or Intrusion Prevention rules. That is, log packet data for events such
as "Dropped Retransmit" or "Invalid ACK".
Note: Events that have been aggregated because of event folding cannot have their
packet data saved.
l Log only one packet within period: If this option is enabled and Log All Packet Data is
not, most logs will contain only the header data. A full packet will be attached
periodically, as specified by the Period for Log only one packet within period setting.
l Period for Log only one packet within period: When Log only one packet within
period is enabled, this setting specifies how often the log will contain full packet data.
l Maximum data size to store when packet data is captured: The maximum size of
header or packet data to be attached to a log.
l Generate Connection Events for TCP: Generates a Firewall event every time a TCP
connection is established.
l Generate Connection Events for ICMP: Generates a Firewall event every time an
ICMP connection is established.
l Generate Connection Events for UDP: Generates a Firewall event every time a UDP
connection is established.
l Bypass CISCO WAAS Connections: This mode bypasses stateful analysis of TCP
sequence numbers for connections initiated with the proprietary CISCO WAAS TCP
481
Trend Micro Deep Security On-Premise 20
option selected. This protocol carries extra information in invalid TCP Sequence and
ACK numbers that interfere with stateful Firewall checks. Only enable this option if you
are using CISCO WAAS and you are seeing connections with Invalid SEQ or Invalid
ACK in the Firewall logs. When this option is selected, TCP stateful sequence number
checks are still performed for non WAAS enabled connections.
l Drop Evasive Retransmit: Incoming packets containing data that has already been
processed will be dropped to avoid possible evasive retransmit attack techniques.
l Verify TCP Checksum: The segment's checksum field data will be used to assess the
integrity of the segment.
l Minimum Fragment Offset: Defines the minimum acceptable IP fragment offset.
Packets with offsets less than this will be dropped with reason "IP fragment offset too
small". If set to 0 no limit is enforced. (default 60)
l Minimum Fragment Size: Defines the minimum acceptable IP fragment size.
Fragmented packets that are smaller than this will be dropped with reason "First
fragment too small" as potentially malicious. (default 120)
l SSL Session Size: Sets the maximum number of SSL session entries maintained for
SSL session keys.
l SSL Session Time: Sets how long SSL session renewal keys are valid before they
expire.
l Filter IPv4 Tunnels: Not used by this version of Deep Security.
l Filter IPv6 Tunnels: Not used by this version of Deep Security.
l Strict Teredo Port Check: Not used by this version of Deep Security.
l Drop Teredo Anomalies: Not used by this version of Deep Security.
l Maximum Tunnel Depth: Not used by this version of Deep Security.
l Action if Maximum Tunnel Depth Exceeded: Not used by this version of Deep
Security.
l Drop IPv6 Extension Type 0: Not used by this version of Deep Security.
l Drop IPv6 Fragments Lower Than minimum MTU: Drop IPv6 fragments that do not
meet the minimum MTU size specified by IETF RFC 2460.
l Drop IPv6 Reserved Addresses: Drop these reserved addresses:
l IETF reserved 0000::/8
l IETF reserved 0100::/8
l IETF reserved 0200::/7
482
Trend Micro Deep Security On-Premise 20
l IETF reserved 0400::/6
l IETF reserved 0800::/5
l IETF reserved 1000::/4
l IETF reserved 4000::/2
l IETF reserved 8000::/2
l IETF reserved C000::/3
l IETF reserved E000::/4
l IETF reserved F000::/5
l IETF reserved F800::/6
l Drop IPv6 Site Local Addresses: Drop site local addresses FEC0::/10.
l Drop IPv6 Bogon Addresses: Drop these addresses:
l "loopback ::1
l "IPv4 compatible address", ::/96
l "IPv4 mapped address" ::FFFF:0.0.0.0/96
l "IPv4 mapped address", ::/8
l "OSI NSAP prefix (deprecated by RFC4048)" 0200::/7
l "6bone (deprecated)", 3ffe::/16
l "Documentation prefix", 2001:db8::/32
l Drop 6to4 Bogon Addresses: Drop these addresses:
l "6to4 IPv4 multicast", 2002:e000:: /20
l "6to4 IPv4 loopback", 2002:7f00:: /24
l "6to4 IPv4 default", 2002:0000:: /24
l "6to4 IPv4 invalid", 2002:ff00:: /24
l "6to4 IPv4 10.0.0.0/8", 2002:0a00:: /24
l "6to4 IPv4 172.16.0.0/12", 2002:ac10:: /28
l "6to4 IPv4 192.168.0.0/16", 2002:c0a8:: /32
l Drop IP Packet with Zero Payload: Drop IP packets that have a zero-length payload.
l Drop Unknown SSL Protocol: Drop connection if a client attempts to connect to the
Deep Security Manager with the wrong protocol. By default, any protocol other than
"http/1.1" will cause an error.
483
Trend Micro Deep Security On-Premise 20
l Force Allow DHCP DNS: Controls whether the following hidden Firewall rules are
enabled:
Source Destination
Rule type Priority Direction Protocol
port port
Force Allow 4 Outgoing DNS Any 53
Force Allow 4 Outgoing DHCP 68 67
Force Allow 4 Incoming DHCP 67 68
When the rules are enabled, agent computers can connect with the manager using the
listed protocols and ports. The following values for this property are available:
l Inherited: Inherits the setting from the policy
l Turn off rules: Disables the rules. Note that this setting can cause agent computers
to appear offline
l Allow DNS Query: Enable only the DNS-related rule
l Allow DNS Query and DHCP Client: Enable all 3 rules
l Force Allow ICMP type3 code4: Controls whether the following hidden Firewall rules
are enabled:
Rule type Priority Direction Protocol Type Code
Force Allow 4 Incoming ICMP 3 4
When enabled, these rules allow relay computers to connect with the manager so that
the relay's heartbeat is transmitted. The following values are available:
l Inherited: Inherits the setting from the policy.
l Turn off rules: Disables the rule. This value can cause connection timeouts or
"Destination cannot be reached" responses.
l Add Force Allow rule for ICMP type3 code4: Enables the rule.
l Fragment Timeout: If configured to do so, the Intrusion Prevention rules will inspect
the content of a packet (or packet fragment) if that content is considered suspicious.
This setting determines how long after inspecting to wait for the remaining packet
fragments before discarding the packet.
484
Trend Micro Deep Security On-Premise 20
l Maximum number of fragmented IP packets to keep: Specifies the maximum number
of fragmented packets that Deep Security will keep.
l Send ICMP to indicate fragmented packet timeout exceeded: When this setting is
enabled and the fragment timeout is exceeded, an ICMP packet is sent to the remote
computer.
l Bypass MAC addresses that don't belong to host: Bypass incoming packets whose
destination MAC address does not belong to the host. Enabling this option reduces the
number of network events caused by fetching packets that are created due to NIC
teaming or a NIC in promiscuous mode on agents and appliances that are version
10.2 or later.
Define rules, lists, and other common objects used by policies
About common objects
The Common Objects pages (located under Policies > Common Objects in Deep Security
Manager) provide a way to define objects once so that you can reuse them various policies and
rules. When you use one of the common objects in the policy or computer editor, its settings can
be overridden for that specific policy or computer. For more information on how common object
properties can be inherited and overridden at the policy or computer level, see "Policies,
inheritance, and overrides" on page 451.
Tip: You can automate common object creation and configuration using the Deep Security
API. For examples, see the Create and Configure Common Objects for Policies and
Computers guide in the Deep Security Automation Center.
Rules
Some protection modules make use of rules:
l "Create a firewall rule" on page 671
l Configure an intrusion prevention rule for use in policies
l "Create an Integrity Monitoring rule" on page 713
l "Define a Log Inspection rule for use in policies" on page 770
485
Trend Micro Deep Security On-Premise 20
Lists
l "Create a list of directories for use in policies" on page 531
l "Create a list of file extensions for use in policies" on page 533
l "Create a list of files for use in policies" on page 534
l "Create a list of IP addresses for use in policies" on page 537
l "Create a list of MAC addresses for use in policies" on page 539
l "Create a list of ports for use in policies" on page 538
Other
l "Define contexts for use in policies" on page 540
l "Define stateful firewall configurations" on page 696
l "Configure malware scans" on page 557
l "Define a schedule that you can apply to rules" on page 546
Create a firewall rule
Firewall rules examine the control information in individual packets, and either block or allow
them according to the criteria that you define. Firewall rules can be assigned to a policy or
directly to a computer.
Note: This article specifically covers how to create a firewall rule. For information on how to
configure the firewall module, see "Set up the Deep Security firewall" on page 658.
To create a new firewall rule, you need to:
1. "Add a new rule" on the next page.
2. "Select the behavior and protocol of the rule" on the next page.
3. "Select a Packet Source and Packet Destination" on page 489.
When you're done with your firewall rule, you can also learn how to:
l "Configure rule events and alerts" on page 491
l "Set a schedule for the rule" on page 491
l "See policies and computers a rule is assigned to" on page 491
l "Assign a context to the rule " on page 491
486
Trend Micro Deep Security On-Premise 20
Add a new rule
There are three ways to add a new firewall rule on the Policies > Common Objects > Rules >
Firewall Rules page. You can:
l Create a new rule. Click New > New Firewall Rule.
l Import a rule from an XML file. Click New > Import From File.
l Copy and then modify an existing rule. Right-click the rule in the Firewall Rules list and
then click Duplicate. To edit the new rule, select it and then click Properties.
Select the behavior and protocol of the rule
1. Enter a Name and Description for the rule.
Tip: It is good practice to document all firewall rule changes in the Description field of the
firewall rule. Make a note of when and why rules were created or deleted for easier
firewall maintenance.
2. Select the Action that the rule should perform on packets. You can select from one of the
following five actions:
Note: Only one rule action is applied to a packet, and rules (of the same priority) are
applied in the order of precedence listed below.
l The rule can allow traffic to bypass the firewall. A bypass rule allows traffic to pass
through the firewall and intrusion prevention engine at the fastest possible rate.
Bypass rules are meant for traffic using media intensive protocols where filtering may
not be desired or for traffic originating from trusted sources.
Tip: For an example of how to create and use a bypass rule for trusted sources in a
policy, see "Allow trusted traffic to bypass the firewall" on page 677.
Note: Bypass rules are unidirectional. Explicit rules are required for each direction
of traffic.
Tip: You can achieve maximum throughput performance on a bypass rule with the
following settings:
487
Trend Micro Deep Security On-Premise 20
l Priority: Highest
l Frame Type: IP
l Protocol: TCP, UDP, or other IP protocol. (Do not use the "Any" option.)
l Source and Destination IP and MAC: all "Any"
l If the protocol is TCP or UDP and the traffic direction is "incoming", the
destination ports must be one or more specified ports (not "Any"), and the source
ports must be "Any".
l If the protocol is TCP or UDP and the traffic direction is "outgoing", the source
ports must be one or more specified ports (Not "Any"), and the destination ports
must be "Any".
l Schedule: None.
l The rule can log only. This action will make entries in the logs but will not process
traffic.
l The rule can force allow defined traffic (it will allow traffic defined by this rule without
excluding any other traffic.)
l The rule can deny traffic (it will deny traffic defined by this rule.)
l The rule can allow traffic (it will exclusively allow traffic defined by this rule.)
Note: If you have no allow rules in effect on a computer, all traffic is permitted unless it is
specifically blocked by a deny rule. Once you create a single allow rule, all other traffic is
blocked unless it meets the requirements of the allow rule. There is one exception to this:
ICMPv6 traffic is always permitted unless it is specifically blocked by a deny rule.
3. Select the Priority of the rule. The priority determines the order in which rules are applied.
If you have selected "force allow", "deny", or "bypass" as your rule action, you can set a
priority of 0 (low) to 4 (highest). Setting a priority allows you to combine the actions of rules
to achieve a cascading rule effect.
Note: Log only rules can only have a priority of 4, and Allow rules can only have a
priority of 0.
488
Trend Micro Deep Security On-Premise 20
Note: High priority rules get applied before low priority rules. For example, a port 80
incoming deny rule with a priority of 3 will drop a packet before a port 80 incoming force
allow rule with a priority of 2 gets applied to it.
For detailed information on how actions and priority work together, see "Firewall rule
actions and priorities" on page 678.
4. Select a Packet Direction. Select whether this rule will be applied to incoming (from the
network to the computer) or outgoing(from the computer to the network) traffic.
Note: An individual firewall rule only apply to a single direction of traffic. You may need
to create incoming and outgoing firewall rules in pairs for specific types of traffic.
5. Select an Ethernet Frame Type. The term "frame" refers to Ethernet frames, and the
available protocols specify the data that the frame carries. If you select "Other" as the frame
type, you need to specify a frame number.
6. Note: IP covers both IPv4 and IPv6. You can also select IPv4 or IPv6 individually
Note: On Solaris, Deep Security Agents will only examine packets with an IP frame type,
and Linux Agents will only examine packets with IP or ARP frame types. Packets with
other frame types will be allowed through. Note that the Virtual Appliance does not have
these restrictions and can examine all frame types, regardless of the operating system of
the virtual machine it is protecting.
If you select the Internet Protocol (IP) frame type, you need to select the transport Protocol.
If you select "Other" as the protocol, you also need to enter a protocol number.
Select a Packet Source and Packet Destination
Select a combination of IP and MAC addresses, and if available for the frame type, Port and
Specific Flags for the Packet Source and Packet Destination.
Tip: You can use a previously created IP, MAC or port list.
Support for IP-based frame types is as follows:
489
Trend Micro Deep Security On-Premise 20
IP MAC Port Flags
Any ✔ ✔
ICMP ✔ ✔ ✔
ICMPV6 ✔ ✔ ✔
IGMP ✔ ✔
GGP ✔ ✔
TCP ✔ ✔ ✔ ✔
PUP ✔ ✔
UDP ✔ ✔ ✔
IDP ✔ ✔
ND ✔ ✔
RAW ✔ ✔
TCP+UDP ✔ ✔ ✔ ✔
Note: ARP and REVARP frame types only support using MAC addresses as packet sources
and destinations.
You can select Any Flags or individually select the following flags:
l URG
l ACK
l PSH
l RST
l SYN
l FIN
490
Trend Micro Deep Security On-Premise 20
Configure rule events and alerts
When a firewall rule is triggered, it logs an event in the Deep Security Manager and records the
packet data.
Note: Note that rules using the "Allow", "Force Allow" and "Bypass" actions will not log any
events.
Alerts
You can configure rules to also trigger an alert if they log an event. To do so, open the properties
for a rule, click on Options, and then select Alert when this rule logs an event.
Note: Only firewall rules with an action set to "Deny" or "Log Only" can be configured to trigger
an alert.
Set a schedule for the rule
Select whether the firewall rule should only be active during a scheduled time.
For more information on how to do so, see "Define a schedule that you can apply to rules" on
page 546.
Assign a context to the rule
Rule contexts allow you to set firewall rules uniquely for different network environments.
Contexts are commonly used to allow for different rules to be in effect for laptops when they are
on and off-site.
For more information on how to create a context, see "Define contexts for use in policies" on
page 540.
Tip: For an example of a policy that implements firewall rules using contexts, look at the
properties of the "Windows Mobile Laptop" Policy.
See policies and computers a rule is assigned to
You can see which policies and computers are assigned to a firewall rule on the Assigned To
tab. Click on a policy or computer in the list to see their properties.
491
Trend Micro Deep Security On-Premise 20
Export a rule
You can export all firewall rules to a .csv or .xml file by clicking Export and selecting the
corresponding export action from the list. You can also export specific rules by first selecting
them, clicking Export and then selecting the corresponding export action from the list.
Delete a rule
To delete a rule, right-click the rule in the Firewall Rules list, click Delete and then click OK.
Note: Firewall Rules that are assigned to one or more computers or that are part of a policy
cannot be deleted.
Configure intrusion prevention rules
Perform the following tasks to configure and work with intrusion prevention rules:
l "See the list of intrusion prevention rules" on the next page
l "See information about an intrusion prevention rule" on the next page
l "See information about the associated vulnerability (Trend Micro rules only)" on page 495
l "Assign and unassign rules" on page 495
l "Automatically assign updated required rules" on page 496
l "Configure event logging for rules" on page 496
l "Generate alerts" on page 497
l "Setting configuration options (Trend Micro rules only)" on page 497
l "Schedule active times" on page 498
l "Exclude from recommendations" on page 499
l "Set the context for a rule" on page 499
l "Override the behavior mode for a rule" on page 499
l "Override rule and application type configurations" on page 500
l "Export and import rules" on page 501
l "Configure an SQL injection prevention rule" on page 635
For an overview of the intrusion prevention module, see "About Intrusion Prevention" on
page 615.
492
Trend Micro Deep Security On-Premise 20
See the list of intrusion prevention rules
The Policies page provides a list of intrusion prevention rules. You can search for intrusion
prevention rules, and open and edit rule properties. In the list, rules are grouped by application
type, and some rule properties appear in different columns.
Tip: The "TippingPoint" column contains the equivalent Trend Micro TippingPoint rule ID. In
the Advanced Search for intrusion prevention, you can search on the TippingPoint rule ID. You
can also see the TippingPoint rule ID in the list of assigned intrusion prevention rules in the
policy and computer editor.
To see the list, click Policies, and then below Common Objects/Rules click Intrusion
Prevention Rules.
See information about an intrusion prevention rule
The properties of intrusion prevention rules include information about the rule and the exploit
against which it protects.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
General Information
l Name: The name of the intrusion prevention rule.
l Description: The description of the intrusion prevention rule.
l Minimum Agent/Appliance Version: The minimum version of the Deep Security Agent or
Appliance1 required to support this intrusion prevention rule.
Details
Clicking New ( ) or Properties ( ) displays the Intrusion Prevention Rule Properties
window.
1The Deep Securty Agent and Deep Security Virtual Appliance are the components that enforce the Deep Security policies that you have
defined. Agents are deployed directly on a computer. Appliances are used in VMware vSphere environments to provide agentless protection.
They are not available with Deep Security as a Service.
493
Trend Micro Deep Security On-Premise 20
Note: Note the Configuration tab. Intrusion Prevention Rules from Trend Micro are not directly
editable through Deep Security Manager. Instead, if the Intrusion Prevention Rule requires (or
allows) configuration, those configuration options will be available on the Configuration tab.
Custom Intrusion Prevention Rules that you write yourself will be editable, in which case the
Rules tab will be visible.
See the list of intrusion prevention rules
The Policies page provides a list of intrusion prevention rules. You can search for intrusion
prevention rules, and open and edit rule properties. In the list, rules are grouped by application
type, and some rule properties appear in different columns.
Tip: The "TippingPoint" column contains the equivalent Trend Micro TippingPoint rule ID. In
the Advanced Search for intrusion prevention, you can search on the TippingPoint rule ID. You
can also see the TippingPoint rule ID in the list of assigned intrusion prevention rules in the
policy and computer editor.
To see the list, click Policies, and then below Common Objects/Rules click Intrusion
Prevention Rules.
General Information
l Application Type: The application type under which this intrusion prevention rule is
grouped.
Tip: You can edit application types from this panel. When you edit an application type
from here, the changes are applied to all security elements that use it.
l Priority: The priority level of the rule. Higher priority rules are applied before lower priority
rules.
l Severity: Setting the severity of a rule has no effect on how the rule is implemented or
applied. Severity levels can be useful as sorting criteria when viewing a list of intrusion
prevention rules. More importantly, each severity level is associated with a severity value;
this value is multiplied by a computer's Asset Value to determine the Ranking of an Event.
(See Administration > System Settings > Ranking.)
l CVSS Score: A measure of the severity of the vulnerability according the National
Vulnerability Database.
494
Trend Micro Deep Security On-Premise 20
Identification (Trend Micro rules only)
l Type: Can be either Smart (one or more known and unknown (zero day) vulnerabilities),
Exploit (a specific exploit, usually signature based), or Vulnerability (a specific vulnerability
for which one or more exploits may exist).
l Issued: The date the rule was released. This does not indicate when the rule was
downloaded.
l Last Updated: The last time the rule was modified either locally or during Security Update
download.
l Identifier: The rule's unique identification tag.
See information about the associated vulnerability (Trend Micro rules only)
Rules that Trend Micro provides can include information about the vulnerability against which
the rule protects. When applicable, the Common Vulnerability Scoring System (CVSS) is
displayed. (For information on this scoring system, see the CVSS page at the National
Vulnerability Database.)
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Vulnerabilities tab.
Assign and unassign rules
To apply intrusion prevention rules during agent scans, you assign them to the appropriate
policies and computers. When the rule is no longer necessary because the vulnerability has
been patched you can unassign the rule.
If you cannot unassign intrusion prevention rules from a Computer editor 1, it is likely because
the rules are currently assigned in a policy. Rules assigned at the policy level must be removed
using the Policy editor 2 and cannot be removed at the computer level.
When you make a change to a policy, it affects all computers using the policy. For example,
when you unassign a rule from a policy you remove the rule from all computers that are
protected by that policy. To continue to apply the rule to other computers, create a new policy for
that group of computers. (See "Policies, inheritance, and overrides" on page 451.)
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
2To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
495
Trend Micro Deep Security On-Premise 20
Tip: To see the policies and computers to which a rule is assigned, see the Assigned To tab of
the rule properties.
1. Go to the Policies page, right-click the policy to configure and click Details.
2. Click Intrusion Prevention > General.
The list of rules that are assigned to the policy appear in the Assigned Intrusion
Prevention Rules list.
3. Under Assigned Intrusion Prevention Rules, click Assign/Unassign.
4. To assign a rule, select the check box next to the rule.
5. To unassign a rule, deselect the check box next to the rule.
6. Click OK.
Automatically assign updated required rules
Security updates can include new or updated application types and intrusion prevention rules
which require the assignment of secondary intrusion prevention rules. Deep Security can
automatically assign these rules if they are required. You enable these automatic assignments in
the the policy or computer properties.
1. Go to the Policies page, right-click the policy to configure and click Details.
2. Click Intrusion Prevention > Advanced.
3. To enable the automatic assignments, in the Rule Updates area, select Yes.
4. Click OK.
Configure event logging for rules
Configure whether events are logged for a rule, and whether to include packet data in the log.
Note: Deep Security can display X-Forwarded-For headers in intrusion prevention events
when they are available in the packet data. This information can be useful when the Deep
Security Agent is behind a load balancer or proxy. The X-Forwarded-For header data appears
in the event's Properties window. To include the header data, include packet data in the log. In
addition, rule 1006540 " Enable X-Forwarded-For HTTP Header Logging" must be assigned.
Because it would be impractical to record all packet data every time a rule triggers an event,
Deep Security records the data only the first time the event occurs within a specified period of
time. The default time is five minutes, however you can change the time period using the "Period
for Log only one packet within period" property of a policy's Advanced Network Engine settings.
(See Advanced Network Engine Options.)
496
Trend Micro Deep Security On-Premise 20
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on
page 500.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. On the General tab, go to the Events area and select the desired options:
l To disable logging for the rule, select Disable Event Logging.
l To log an event when a packet is dropped or blocked, select Generate Event on
Packet Drop.
l To include the packet data in the log entry, select Always Include Packet Data.
l To log several packets that precede and follow the packet that the rule detected, select
Enable Debug Mode.Use debug mode only when your support provider instructs you
to do so.
Additionally, to include packet data in the log, the policy to which the rule is assigned must allow
rules to capture packet data:
1. On the Policies page, open the policy that is assigned the rule.
2. Click Intrusion Prevention > Advanced.
3. In the Event Data area, select Yes.
Generate alerts
Generate an alert when an intrusion prevention rule triggers an event.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on
page 500.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Options tab, and in the Alert area select On.
4. Click OK.
Setting configuration options (Trend Micro rules only)
Some intrusion prevention rules that Trend Micro provides have one or more configuration
options such as header length, allowed extensions for HTTP, or cookie length. Some options
require you to configure them. If you assign a rule without setting a required option, an alert is
497
Trend Micro Deep Security On-Premise 20
generated that informs you about the required option. (This also applies to any rules that are
downloaded and automatically applied by way of a Security Update.)
Intrusion prevention rules that have configuration options appear in the Intrusion Prevention
Rules list with a small gear over their icon .
Note: Custom intrusion prevention rules that you write yourself include a Rules tab where you
can edit the rules.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on
page 500.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Configuration tab.
4. Configure the properties and then click OK.
Schedule active times
Schedule a time during which an intrusion prevention rule is active. Intrusion prevention rules
that are active only at scheduled times appear in the Intrusion Prevention Rules page with a
small clock over their icon .
Note: With Agent-based protection, schedules use the same time zone as the endpoint
operating system. With Agentless protection, schedules use the same time zone as the Deep
Security Virtual Appliance. Agentless protection is not available with Deep Security as a
Service.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on
page 500.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Options tab.
4. In the Schedule area, select New or select a frequency.
5. Edit the schedule as required.
6. Click OK.
498
Trend Micro Deep Security On-Premise 20
Exclude from recommendations
Exclude intrusion prevention rules from rule recommendations of recommendation scans.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on the
next page.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Optionstab.
4. In the Recommendations Options area, select Exclude from Recommendations.
5. Click OK.
Set the context for a rule
Set the context in which the rule is applied.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on the
next page.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Options tab.
4. In the Context area, select New or select a context.
5. Edit the context as required.
6. Click OK.
Override the behavior mode for a rule
Set the behavior mode of an intrusion prevention rule to Detect when testing new rules. In Detect
mode, the rule creates a log entry prefaced with the words "detect only:" and does not interfere
with traffic. Some intrusion prevention rules are designed to operate only in Detect mode. For
these rules, you cannot change the behavior mode.
Note: If you disable logging for the rule, the rule activity is not logged regardless of the
behavior mode.
For more information about behavior modes, see "Use behavior modes to test rules" on
page 617.
499
Trend Micro Deep Security On-Premise 20
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" below.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Select Detect Only.
Override rule and application type configurations
From a Computer or Policy editor 1 , you can edit an intrusion prevention rule so that your
changes apply only in the context of the policy or computer. You can also edit the rule so that the
changes apply globally so that the changes affect other policies and computers that are
assigned the rule. Similarly, you can configure application types for a single policy or computer,
or globally.
1. Go to the Policies page, right-click the policy to configure and click Details.
2. Click Intrusion Prevention.
3. To edit a rule, right-click the rule and select one of the following commands:
l Properties: Edit the rule only for the policy.
l Properties (Global): Edit the rule globally, for all policies and computers.
4. To edit the application type of a rule, right-click the rule and select one of the following
commands:
l Application Type Properties: Edit the application type only for the policy.
l Application Type Properties (Global): Edit the application type globally, for all policies
and computers.
5. Click OK.
Tip: When you select the rule and click Properties, you are editing the rule only for the policy
that you are editing.
Note: You cannot assign one port to more than eight application types. If they are, the rules
will not function on that port.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
500
Trend Micro Deep Security On-Premise 20
Export and import rules
You can export one or more intrusion prevention rules to an XML or CSV file, and import rules
from an XML file.
1. Click Policies > Intrusion Prevention Rules.
2. To export one or more rules, select them and click Export > Export Selected to CSV or
Export > Export Selected to XML.
3. To export all rules, click Export > Export to CSV or Export > Export to XML.
4. To import rules, click New > Import From File and follow the instructions on the wizard.
Create an Integrity Monitoring rule
Integrity Monitoring rules describe how Deep Security Agents should scan for and detect
changes to a computer's files, directories, and registry keys and values, as well as changes in
installed software, processes, listening ports, and running services. Integrity Monitoring rules can
be assigned directly to computers or can be made part of a policy.
Note: This article specifically covers how to create an Integrity Monitoring rule. For information
on how to configure the Integrity Monitoring module, see "Set up Integrity Monitoring" on
page 705.
There are two types of Integrity Monitoring rules: those that you have created, and those that are
issued by Trend Micro. For more information on how to configure rules issued by Trend Micro,
see the "Configure Trend Micro Integrity Monitoring rules" on page 503 section.
To create a new Integrity Monitoring rule, you need to:
1. "Add a new rule" on the next page.
2. "Enter Integrity Monitoring rule information " on the next page.
3. "Select a rule template and define rule attributes" on the next page.
When you're done with your rule, you can also learn how to
l "Configure rule events and alerts" on page 504
l "See policies and computers a rule is assigned to" on page 505
l "Export a rule" on page 505
l "Delete a rule" on page 505
501
Trend Micro Deep Security On-Premise 20
Add a new rule
There are three ways to add an Integrity Monitoring rule on the Policies > Common Objects >
Rules > Integrity Monitoring Rules page. You can:
l Create a new rule. Click New > New Integrity Monitoring Rule.
l Import a rule from an XML file. Click New > Import From File.
l Copy and then modify an existing rule. Right-click the rule in the Integrity Monitoring Rules
list and then click Duplicate. To edit the new rule, select it and then click Properties.
Enter Integrity Monitoring rule information
1. Enter a Name and Description for the rule.
Tip: It is good practice to document all Integrity Monitoring rule changes in the
Description field of the rule. Make a note of when and why rules were created or deleted
for easier maintenance.
2. Set the Severity of the rule.
Note: Setting the severity of a rule has no effect on how the rule is implemented or
applied. Severity levels can be useful as sorting criteria when viewing a list of Integrity
Monitoring rules. More importantly, each severity level is associated with a severity
value; this value is multiplied by a computer's Asset Value to determine the ranking of an
event. (See Administration > System Settings > Ranking.)
Select a rule template and define rule attributes
Go to the Content tab and select from one of the following three templates:
Registry Value template
Create an Integrity Monitoring rule to specifically monitor changes to registry values.
Note: The Registry Value template is only for Windows-based computers .
1. Select the Base Key to monitor and whether or not to monitor contents of sub keys.
2. List Value Names to be included or excluded. You can use "?" and "*" as wildcard
characters.
502
Trend Micro Deep Security On-Premise 20
3. Enter Attributes to monitor. Entering "STANDARD" will monitor changes in registry size,
content and type. For more information on Registry Value template attributes see the
"RegistryValueSet" on page 749 documentation.
File template
Create an Integrity Monitoring rule to specifically monitor changes to files.
1. Enter a Base Directory for the rule (for example, C:\Program Files\MySQL .) Select
Include Sub Directories to include the contents of all subdirectories relative to the base
directory. Wildcards are not supported for base directories.
2. Use the File Names fields to include or exclude specific files. You can use wildcards (" ?
" for a single character and " * " for zero or more characters.
Note: Leaving the File Names fields blank will cause the rule to monitor all files in the
base directory. This can use significant system resources if the base directory contains
numerous or large files.
3. Enter Attributes to monitor. Entering "STANDARD" will monitor changes in file creation
date, last modified date, permissions, owner, group, size, content, flags (Windows), and
SymLinkPath (Linux). For more information on File template attributes see the "FileSet" on
page 733 documentation.
Custom (XML) template
Create a custom Integrity Monitoring rule template to monitor directories, registry values, registry
keys, services, processes, installed software, ports, groups, users, files, and the WQL using the
Deep Security XML-based "About the Integrity Monitoring rules language" on page 717.
Tip: You can create your rule in your preferred text editor and paste it to the Content field
when you are done.
Configure Trend Micro Integrity Monitoring rules
Integrity Monitoring rules issued by Trend Micro cannot be edited in the same way as the custom
rules you create. Some Trend Micro rules cannot be modified at all, while other rules may offer
limited configuration options. Both of these rule types will show as "Defined" under the "Type"
column, but rules that can be configured will display a gear in the Integrity Monitoring icon ( ).
503
Trend Micro Deep Security On-Premise 20
You can access the configuration options for a rule by opening the properties for the rule and
clicking on the Configuration tab.
Rules issued by Trend Micro also show the following additional information under the General
tab:
l When the rule was first issued and last updated, as well as a unique identifier for the rule.
l The minimum versions of the Agent and the Deep Security Manager that are required for
the rule to function.
Although you cannot edit rules issued by Trend Micro directly, you can duplicate them and then
edit the copy.
Configure rule events and alerts
Any changes detected by an Integrity Monitoring rule is logged as an event in the Deep Security
Manager.
Real-time event monitoring
By default, events are logged at the time they occur. If you only want events to be logged when
you manually perform a scan for changes, deselect Allow Real Time Monitoring.
Alerts
You can also configure the rules to trigger an alert when they log an event. To do so, open the
properties for a rule, click on Options, and then select Alert when this rule logs an event.
504
Trend Micro Deep Security On-Premise 20
See policies and computers a rule is assigned to
You can see which policies and computers are assigned to an Integrity Monitoring rule on the
Assigned To tab. Click on a policy or computer in the list to see their properties.
Export a rule
You can export all Integrity Monitoring rules to a .csv or .xml file by clicking Export and selecting
the corresponding export action from the list. You can also export specific rules by first selecting
them, clicking Export and then selecting the corresponding export action from the list.
Delete a rule
To delete a rule, right-click the rule in the Integrity Monitoring Rules list, click Delete and then
click OK.
Note: Integrity Monitoring rules that are assigned to one or more computers or that are part of a
policy cannot be deleted.
Define a Log Inspection rule for use in policies
The OSSEC Log Inspection engine is integrated into Deep Security Agents and gives Deep
Security the ability to inspect the logs and events generated by the operating system and
applications running on the computer. Deep Security Manager ships with a standard set of
OSSEC Log Inspection rules that you can assign to computers or policies. You can also create
custom rules if there is no existing rule that fits your requirements.
Log Inspection Rules issued by Trend Micro are not editable (although you can duplicate them
and then edit them.)
Note: Log Inspection Rules that are assigned to one or more computers or that are part of a
policy cannot be deleted.
To create Log Inspection rules, perform these basic steps:
l "Create a new Log Inspection rule" on the next page
l "Decoders" on page 508
l "Subrules" on page 509
505
Trend Micro Deep Security On-Premise 20
l "Real world examples" on page 517
l "Log Inspection rule severity levels and their recommended use" on page 525
l "strftime() conversion specifiers " on page 526
l "Examine a Log Inspection rule" on page 527
For an overview of the Log Inspection module, see "About Log Inspection" on page 766.
Create a new Log Inspection rule
1. In the Deep Security Manager, go to Policies > Common Objects > Rules > Log
Inspection Rules.
2. Click New > New Log Inspection Rule.
3. On the General tab, enter a name and an optional description for the rule.
4. The Content tab is where you define the rule. The easiest way to define a rule is to select
Basic Rule and use the options provided to define the rule. If you need further
customization, you can select Custom (XML) to switch to an XML view of the rule that you
are defining.
Note: Any changes you make in the Custom (XML) view will be lost if you switch back to
the Basic Rule view.
For further assistance in writing your own Log Inspection rules using the XML-based
language, consult the OSSEC documentation or contact your support provider.
These options are available for the Basic Rule template:
l Rule ID: The Rule ID is a unique identifier for the rule. OSSEC defines 100000 - 109999
as the space for user-defined rules. Deep Security Manager will pre-populate the field with
a new unique Rule ID.
l Level: Assign a level to the rule. Zero (0) means the rule never logs an event, although
other rules that watch for this rule may fire.
l Groups: Assign the rule to one or more comma-separated groups. This can be useful
when dependency is used because you can create rules that fire on the firing of a rule, or a
rule that belongs to a specific group.
l Rule Description: Description of the rule.
l Pattern Matching: This is the pattern the rule will look for in the logs. The rule will be
506
Trend Micro Deep Security On-Premise 20
triggered on a match. Pattern matching supports Regular Expressions or simpler String
Patterns. The "String Pattern" pattern type is faster than RegEx but it only supports three
special operations:
l ^ (caret): specifies the beginning of text
l $ (dollar sign): specifies the end of text
l | (pipe): to create a "OR" between multiple patterns
For information on the regular expression syntax used by the Log Inspection module, see
https://www.ossec.net/docs/syntax/regex.html.
l Dependency: Setting a dependency on another rule will cause your rule to only log an
event if the rule specified in this area has also triggered.
l Frequency is the number of times the rule has to match within a specific time frame before
the rule is triggered.
l Time Frame is the period of time in seconds within which the rule has to trigger a certain
number of times (the frequency, above) to log an event.
Note: The Content tab only appears for Log Inspection rules that you create yourself. Log
Inspection rules issued by Trend Micro have a Configuration tab instead that displays the Log
Inspection rule's configuration options (if any).
1. On the Files tab, type the full path to the file(s) you want your rule to monitor and specify
the type of file it is.
2. On the Options tab, in the Alert section, select whether this rule triggers an alert in the
Deep Security Manager.
Alert Minimum Severity sets the minimum severity level that will trigger an Alert for rules
made using the Basic Rule or Custom (XML) template.
Note: The Basic Rule template creates one rule at a time. To write multiple rules in a
single template you can use the Custom (XML) template. If you create multiple rules with
different Levels within a Custom (XML) template, you can use the Alert Minimum
Severity setting to select the minimum severity that will trigger an Alert for all of the rules
in that template.
3. The Assigned To tab lists the policies and computers that are using this Log Inspection
507
Trend Micro Deep Security On-Premise 20
rule. Because you are creating a new rule, it has not been assigned yet.
4. Click OK. The rule is ready to be assigned to policies and computers.
Decoders
A Log Inspection rule consists of a list of files to monitor for changes and a set of conditions to be
met for the rule to trigger. When the Log Inspection engine detects a change in a monitored log
file, the change is parsed by a decoder. Decoders parse the raw log entry into the following
fields:
l log: the message section of the event
l full_log: the entire event
l location: where the log came from
l hostname: hostname of the event source
l program_name: program name from the syslog header of the event
l srcip: the source IP address within the event
l dstip: the destination IP address within the event
l srcport: the source port number within the event
l dstport: the destination port number within the event
l protocol: the protocol within the event
l action: the action taken within the event
l srcuser: the originating user within the event
l dstuser: the destination user within the event
l id: any ID decoded as the ID from the event
l status: the decoded status within the event
l command: the command being called within the event
l url: the URL within the event
l data: any additional data extracted from the event
l systemname: the system name within the event
Rules examine this decoded data looking for information that matches the conditions defined in
the rule.
If the matches are at a sufficiently high severity level, any of the following actions can be taken:
508
Trend Micro Deep Security On-Premise 20
l An alert can be raised. (Configurable on the Options tab of the Log Inspection Rule's
Properties window.)
l The event can be written to syslog. (Configurable in the SIEM area on Administration >
System Settings > Event Forwarding tab.)
l The event can be sent to the Deep Security Manager. (Configurable in the Log Inspection
Syslog Configuration setting on the Policy or Computer Editor > Settings > Event
Forwarding tab.)
Subrules
A single Log Inspection rule can contain multiple subrules. These subrules can be of two types:
atomic or composite. An atomic rule evaluates a single event and a composite rule examines
multiple events and can evaluate frequency, repetition, and correlation between events.
Groups
Each rule, or grouping of rules, must be defined within a <group></group> element. The
attribute name must contain the rules you want to be a part of this group. In the following
example we have indicated that our group contains the syslog and sshd rules:
<group name="syslog,sshd,">
</group>
Note: Notice the trailing comma in the group name. Trailing commas are required if you intend
to use the <if_group></if_group> tag to conditionally append another sub-rule to this one.
Note: When a set of Log Inspection rules are sent to an agent, the Log Inspection engine on
the agent takes the XML data from each assigned rule and assembles it into what becomes
essentially a single long Log Inspection rule. Some group definitions are common to all Log
Inspection rules written by Trend Micro. For this reason Trend Micro has included a rule called
"Default Rules Configuration" which defines these groups and which always gets assigned
along with any other Trend Micro rules. (If you select a rule for assignment and haven't also
selected the "Default Rules Configuration" rule, a notice will appear informing you that the rule
will be assigned automatically.) If you create your own Log Inspection rule and assign it to a
Computer without assigning any Trend Micro-written rules, you must either copy the content of
the "Default Rules Configuration" rule into your new rule, or also select the "Default Rules
Configuration"rule for assignment to the Computer.
509
Trend Micro Deep Security On-Premise 20
Rules, ID, and Level
A group can contain as many rules as you require. The rules are defined using the
<rule></rule> element and must have at least two attributes, the id and the level. The id is a
unique identifier for that signature and the level is the severity of the alert. In the following
example, we have created two rules, each with a different rule ID and level:
<group name="syslog,sshd,">
<rule id="100120" level="5">
</rule>
<rule id="100121" level="6">
</rule>
</group>
Note: Custom rules must have ID values of 100,000 or greater.
You can define additional subgroups within the parent group using the <group></group> tag.
This subgroup can reference any of the groups listed in the following table:
Group Type Group Name Description
connection_attempt Connection attempt
Reconnaissance web_scan Web scan
recon Generic scan
authentication_success Success
authentication_failed Failure
invalid_login Invalid
Authentication Control login_denied Login Denied
authentication_failures Multiple Failures
adduser User account added
account_changed User Account changed or removed
automatic_attack Worm (nontargeted attack)
exploit_attempt Exploit pattern
invalid_access Invalid access
spam Spam
Attack/Misuse
multiple_spam Multiple spam messages
sql_injection SQL injection
attack Generic attack
virus Virus detected
access_denied Access denied
access_allowed Access allowed
unknown_resource Access to nonexistent resource
Access Control firewall_drop Firewall drop
multiple_drops Multiple firewall drops
client_misconfig Client misconfiguration
client_error Client error
510
Trend Micro Deep Security On-Premise 20
Group Type Group Name Description
new_host New computer detected
Network Control
ip_spoof Possible ARP spoofing
service_start Service start
system_error System error
system_shutdown Shutdown
logs_cleared Logs cleared
invalid_request Invalid request
System Monitor
promisc Interface switched to promiscuous mode
policy_changed Policy changed
config_changed Configuration changed
low_diskspace Low disk space
time_changed Time changed
Note: If event auto-tagging is enabled, the event will be labeled with the group name. Log
Inspection rules provided by Trend Micro make use of a translation table that changes the
group to a more user-friendly version. So, for example, "login_denied" would appear as "Login
Denied". Custom rules will be listed by their group name as it appears in the rule.
Description
Include a <description></description> tag. The description text will appear in the event if the
rule is triggered.
<group name="syslog,sshd,">
<rule id="100120" level="5">
<group>authentication_success</group>
<description>SSHD testing authentication success</description>
</rule>
<rule id="100121" level="6">
<description>SSHD rule testing 2</description>
</rule>
</group>
Decoded As
The <decoded_as></decoded_as> tag instructs the Log Inspection engine to only apply the rule
if the specified decoder has decoded the log.
<rule id="100123" level="5">
<decoded_as>sshd</decoded_as>
<description>Logging every decoded sshd message</description>
</rule>
511
Trend Micro Deep Security On-Premise 20
Note: To view the available decoders, go to the Log Inspection Rule page and click
Decoders. Right-click on 1002791-Default Log Decoders and select Properties. Go the
Configuration tab and click View Decoders.
Match
To look for a specific string in a log, use the <match></match>. Here is a Linux sshd failed
password log:
Jan 1 12:34:56 linux_server sshd[1231]: Failed password for invalid
user jsmith from 192.168.1.123 port 1799 ssh2
Use the <match></match> tag to search for the "password failed" string.
<rule id="100124" level="5">
<decoded_as>sshd</decoded_as>
<match>^Failed password</match>
<description>Failed SSHD password attempt</description>
</rule>
Note: Notice the regex caret ("^") indicating the beginning of a string. Although "Failed
password" does not appear at the beginning of the log, the Log Inspection decoder will have
broken up the log into sections. See "Decoders" on page 508 for more information. One of
those sections is "log" which is the message part of the log as opposed to "full_log" which is
the log in its entirety.
The following table lists supported regex syntax:
Regex Syntax Description
\w A-Z, a-z, 0-9 single letters and numerals
\d 0-9 single numerals
\s single space
\t single tab
\p ()*+,-.:;<=>?[]
\W not \w
\D not \d
\S not \s
\. anything
+ match one or more of any of the above (for example, \w+, \d+)
* match zero or more of any of the above (for example, \w*, \d*)
^ indicates the beginning of a string (^somestring)
512
Trend Micro Deep Security On-Premise 20
Regex Syntax Description
$ specify the end of a string (somestring$)
| indicate an "OR" between multiple strings
Conditional Statements
Rule evaluation can be conditional upon other rules having been evaluated as true. The <if_
sid></if_sid> tag instructs the Log Inspection engine to only evaluate this subrule if the rule
identified in the tag has been evaluated as true. The following example shows three rules:
100123, 100124, and 100125. Rules 100124 and 100125 have been modified to be children of
the 100123 rule using the <if_sid></if_sid> tag:
<group name="syslog,sshd,">
<rule id="100123" level="2">
<decoded_as>sshd</decoded_as>
<description>Logging every decoded sshd message</description>
</rule>
<rule id="100124" level="7">
<if_sid>100123</if_sid>
<match>^Failed password</match>
<group>authentication_failure</group>
<description>Failed SSHD password attempt</description>
</rule>
<rule id="100125" level="3">
<if_sid>100123</if_sid>
<match>^Accepted password</match>
<group>authentication_success</group>
<description>Successful SSHD password attempt</description>
</rule>
</group>
Hierarchy of Evaluation
The <if_sid></if_sid> tag essentially creates a hierarchical set of rules. That is, by including an
<if_sid></if_sid> tag in a rule, the rule becomes a child of the rule referenced by the <if_
sid></if_sid> tag. Before applying any rules to a log, the Log Inspection engine assesses the
<if_sid></if_sid> tags and builds a hierarchy of parent and child rules.
Note: The hierarchical parent-child structure can be used to improve the efficiency of your
rules. If a parent rule does not evaluate as true, the Log Inspection engine will ignore the
children of that parent.
513
Trend Micro Deep Security On-Premise 20
Note: Although the <if_sid></if_sid> tag can be used to refer to subrules within an entirely
different Log Inspection rule, you should avoid doing this because it makes the rule very
difficult to review later on.
The list of available atomic rule conditional options is shown in the following table:
Tag Description Notes
match A pattern Any string to match against the event (log).
regex A regular expression Any regular expression to match against the event(log).
decoded_
A string Any prematched string.
as
Any IP address that is decoded as the source IP address.
srcip A source IP address
Use "!" to negate the IP address.
Any IP address that is decoded as the destination IP
dstip A destination IP address
address. Use "!" to negate the IP address.
srcport A source port number Any source port (match format).
dstport A destination port number Any destination port (match format).
user A username Any username that is decoded as a username.
program_ Any program name that is decoded from the syslog
A program name
name process name.
hostname A system hostname Any hostname that is decoded as a syslog hostname.
A time range in the format
The time range that the event must fall within for the rule
time hh:mm - hh:mm or
to trigger.
hh:mm am - hh:mm pm
A weekday (sunday, Day of the week that the event must fall on for the rule to
weekday
monday, tuesday, etc.) trigger.
id An ID Any ID that is decoded from the event.
url A URL Any URL that is decoded from the event.
Use the <if_sid>100125</if_sid> tag to make this rule depend on the 100125 rule. This rule will
be checked only for sshd messages that already matched the successful login rule.
<rule id="100127" level="10">
<if_sid>100125</if_sid>
<time>6 pm - 8:30 am</time>
<description>Login outside business hours.</description>
<group>policy_violation</group>
</rule>
Restrictions on the Size of the Log Entry
The following example takes the previous example and adds the maxsize attribute which tells
the Log Inspection engine to only evaluate rules that are less than the maxsize number of
514
Trend Micro Deep Security On-Premise 20
characters:
<rule id="100127" level="10" maxsize="2000">
<if_sid>100125</if_sid>
<time>6 pm - 8:30 am</time>
<description>Login outside business hours.</description>
<group>policy_violation</group>
</rule>
The following table lists possible atomic rule tree-based options:
Tag Description Notes
Adds this rule as a child rule of the rules that match the specified
if_sid A rule ID
signature ID.
if_group A group ID Adds this rule as a child rule of the rules that match the specified group.
Adds this rule as a child rule of the rules that match the specified
if_level A rule level
severity level.
description A string A description of the rule.
info A string Extra information about the rule.
A CVE Any Common Vulnerabilities and Exposures (CVE) number that you
cve
number would like associated with the rule.
alert_by_
email Additional rule options to indicate if the Alert should generate an e-mail,
options no_email_ alert_by_email, should not generate an email, no_email_alert, or
alert should not log anything at all, no_log.
no_log
Composite Rules
Atomic rules examine single log entries. To correlate multiple entries, you must use composite
rules. Composite rules are supposed to match the current log with those already received.
Composite rules require two additional options: the frequency option specifies how many times
an event or pattern must occur before the rule generates an alert, and the timeframe option tells
the Log Inspection engine how far back, in seconds, it should look for previous logs. All
composite rules have the following structure:
<rule id="100130" level="10" frequency="x" timeframe="y">
</rule>
For example, you could create a composite rule that creates a higher severity alert after five
failed passwords within a period of 10 minutes. Using the <if_matched_sid></if_matched_sid>
tag you can indicate which rule needs to be seen within the desired frequency and timeframe for
your new rule to create an alert. In the following example, the frequency attribute is set to trigger
515
Trend Micro Deep Security On-Premise 20
when five instances of the event are seen and the timeframe attribute is set to specify the time
window as 600 seconds.
The <if_matched_sid></if_matched_sid> tag is used to define which other rule the composite
rule will watch:
<rule id="100130" level="10" frequency="5" timeframe="600">
<if_matched_sid>100124</if_matched_sid>
<description>5 Failed passwords within 10 minutes</description>
</rule>
There are several additional tags that you can use to create more granular composite rules.
These rules, as shown in the following table, allow you to specify that certain parts of the event
must be the same. This allows you to tune your composite rules and reduce false positives:
Tag Description
same_source_ip Specifies that the source IP address must be the same.
same_dest_ip Specifies that the destination IP address must be the same.
same_dst_port Specifies that the destination port must be the same.
same_location Specifies that the location (hostname or agent name) must be the same.
same_user Specifies that the decoded username must be the same.
same_id Specifies that the decoded id must be the same.
If you wanted your composite rule to alert on every authentication failure, instead of a specific
rule ID, you could replace the <if_matched_sid></if_matched_sid> tag with the <if_matched_
group></if_matched_ group> tag. This allows you to specify a category, such as
authentication_ failure, to search for authentication failures across your entire infrastructure.
<rule id="100130" level="10" frequency="5" timeframe="600">
<if_matched_group>authentication_failure</if_matched_group>
<same_source_ip />
<description>5 Failed passwords within 10 minutes</description>
</rule>
In addition to <if_matched_sid></if_matched_sid> and <if_matched_group></if_matched_
group> tags, you can also use the <if_matched_regex></if_matched_regex> tag to specify a
regular expression to search through logs as they are received.
<rule id="100130" level="10" frequency="5" timeframe="600">
<if_matched_regex>^Failed password</if_matched_regex>
<same_source_ip />
516
Trend Micro Deep Security On-Premise 20
<description>5 Failed passwords within 10 minutes</description>
</rule>
Real world examples
Deep Security includes many default Log Inspection rules for dozens of common and popular
applications. Through Security Updates, new rules are added regularly. In spite of the growing
list of applications supported by Log Inspection rules, you may find the need to create a custom
rule for an unsupported or custom application.
In this section we will walk through the creation of a custom CMS (content management system)
hosted on Microsoft Windows Server with IIS and .Net platform, with a Microsoft SQL Server
database as the data repository.
The first step is to identify the following application logging attributes:
1. Where does the application log to?
2. Which Log Inspection decoder can be used to decode the log file?
3. What is the general format of a log file message?
For our custom CMS example the answers are as follows:
1. Windows Event Viewer
2. Windows Event Log (eventlog)
3. Windows Event Log Format with the following core attributes:
l Source: CMS
l Category: None
l Event: <Application Event ID>
The second step is to identify the categories of log events by application feature, and then
organize the categories into a hierarchy of cascading groups for inspection. Not all inspected
groups need to raise events; a match can be used as a conditional statement. For each group,
identify the log format attributes which the rule can use as matching criteria. This can also be
performed by inspecting all application logs for patterns and logical groupings of log events.
For example, the CMS application supports the following functional features which we will
create Log Inspection rules for:
517
Trend Micro Deep Security On-Premise 20
l CMS Application Log (Source: CMS)
l Authentication (Event: 100 to 119)
l User Login successful (Event: 100)
l User Login unsuccessful (Event: 101)
l Administrator Login successful (Event: 105)
l Administrator Login unsuccessful (Event: 106)
l General Errors (Type: Error)
l Database error (Event: 200 to 205)
l Runtime error (Event: 206-249)
l Application Audit (Type: Information)
l Content
l New content added (Event: 450 to 459)
l Existing content modified (Event: 460 to 469)
l Existing content deleted (Event: 470 to 479)
l Administration
l User
l New User created (Event: 445 to 446)
l Existing User deleted (Event: 447 to 449)
This structure will provide you with a good basis for rule creation. Now to create a new Log
Inspection rule in Deep Security Manager.
To create the new CMS Log Inspection Rule:
1. In the Deep Security Manager, go to Policies > Common Objects > Rules > Log
Inspection Rules and click New to display the New Log Inspection Rule Properties
window.
2. Give the new rule a name and a description, and then click the Content tab.
3. The quickest way to create a new custom rule is to start with a basic rule template. Select
the Basic Rule radio button.
4. The Rule ID field will be automatically populated with an unused ID number of 100,000 or
greater, the IDs reserved for custom rules.
5. Set the Level setting to Low (0).
6. Give the rule an appropriate Group name. In this case, "cms".
518
Trend Micro Deep Security On-Premise 20
7. Provide a short rule description.
8. Now select the Custom (XML) option. The options you selected for your "Basic" rule will
be converted to XML.
519
Trend Micro Deep Security On-Premise 20
9. Click the Files tab and click the Add File button to add any application log files and log
types which the rule will be applied to. In this case, "Application", and "eventlog" as the file
type.
Note: Eventlog is a unique file type in Deep Security because the location and filename
of the log files don't have to be specified. Instead, it is sufficient to type the log name as it
is displayed in the Windows Event Viewer. Other log names for the eventlog file type
520
Trend Micro Deep Security On-Premise 20
might be "Security", "System", "Internet Explorer", or any other section listed in the
Windows Event Viewer. Other file types will require the log file's location and filename.
(C/C++ strftime() conversion specifiers are available for matching on filenames. See the
table below for a list of some of the more useful ones.)
10. Click OK to save the basic rule.
11. Working with the basic rule Custom (XML) created, we can begin adding new rules to the
group based on the log groupings identified previously. We will set the base rule criteria to
the initial rule. In the following example, the CMS base rule has identified Windows Event
Logs with a Source attribute of "CMS":
<group name="cms">
<rule id="100000" level="0">
<category>windows</category>
<extra_data>^CMS</extra_data>
<description>Windows events from source 'CMS' group
messages.</description>
</rule>
12. Now we build up subsequent rules from the identified log groups. The following example
identifies the authentication and login success and failure and logs by Event IDs.
<rule id="100001" level="0">
<if_sid>100000</if_sid>
<id>^100|^101|^102|^103|^104|^105|^106|^107|^108|^109|^110</id>
<group>authentication</group>
<description>CMS Authentication event.</description>
</rule>
<rule id="100002" level="0">
<if_group>authentication</if_group>
<id>100</id>
<description>CMS User Login success event.</description>
</rule>
<rule id="100003" level="4">
<if_group>authentication</if_group>
<id>101</id>
<group>authentication_failure</group>
<description>CMS User Login failure event.</description>
</rule>
521
Trend Micro Deep Security On-Premise 20
<rule id="100004" level="0">
<if_group>authentication</if_group>
<id>105</id>
<description>CMS Administrator Login success event.</description>
</rule>
<rule id="100005" level="4">
<if_group>authentication</if_group>
<id>106</id>
<group>authentication_failure</group>
<description>CMS Administrator Login failure event.</description>
</rule>
13. Now we add any composite or correlation rules using the established rules. The follow
example shows a high severity composite rule that is applied to instances where the
repeated login failures have occurred 5 times within a 10 second time period:
<rule id="100006" level="10" frequency="5" timeframe="10">
<if_matched_group>authentication_failure</if_matched_group>
<description>CMS Repeated Authentication Login failure
event.</description>
</rule>
14. Review all rules for appropriate severity levels. For example, error logs should have a
severity of level 5 or higher. Informational rules would have a lower severity.
15. Finally, open the newly created rule, click the Configuration tab and copy your custom rule
XML into the rule field. Click Apply or OK to save the change.
Once the rule is assigned to a policy or computer, the Log Inspection engine should begin
inspecting the designated log file immediately.
The complete Custom CMS Log Inspection Rule:
<group name="cms">
<rule id="100000" level="0">
<category>windows</category>
<extra_data>^CMS</extra_data>
<description>Windows events from source 'CMS' group
messages.</description>
</rule>
<rule id="100001" level="0">
<if_sid>100000</if_sid>
<id>^100|^101|^102|^103|^104|^105|^106|^107|^108|^109|^110</id>
<group>authentication</group>
522
Trend Micro Deep Security On-Premise 20
<description>CMS Authentication event.</description>
</rule>
<rule id="100002" level="0">
<if_group>authentication</if_group>
<id>100</id>
<description>CMS User Login success event.</description>
</rule>
<rule id="100003" level="4">
<if_group>authentication</if_group>
<id>101</id>
<group>authentication_failure</group>
<description>CMS User Login failure event.</description>
</rule>
<rule id="100004" level="0">
<if_group>authentication</if_group>
<id>105</id>
<description>CMS Administrator Login success event.</description>
</rule>
<rule id="100005" level="4">
<if_group>authentication</if_group>
<id>106</id>
<group>authentication_failure</group>
<description>CMS Administrator Login failure event.</description>
</rule>
<rule id="100006" level="10" frequency="5" timeframe="10">
<if_matched_group>authentication_failure</if_matched_group>
<description>CMS Repeated Authentication Login failure
event.</description>
</rule>
<rule id="100007" level="5">
<if_sid>100000</if_sid>
<status>^ERROR</status>
<description>CMS General error event.</description>
<group>cms_error</group>
523
Trend Micro Deep Security On-Premise 20
</rule>
<rule id="100008" level="10">
<if_group>cms_error</if_group>
<id>^200|^201|^202|^203|^204|^205</id>
<description>CMS Database error event.</description>
</rule>
<rule id="100009" level="10">
<if_group>cms_error</if_group>
<id>^206|^207|^208|^209|^230|^231|^232|^233|^234|^235|^236|^237|^238
^239^|240|^241|^242|^243|^244|^245|^246|^247|^248|^249</id>
<description>CMS Runtime error event.</description>
</rule>
<rule id="100010" level="0">
<if_sid>100000</if_sid>
<status>^INFORMATION</status>
<description>CMS General informational event.</description>
<group>cms_information</group>
</rule>
<rule id="100011" level="5">
<if_group>cms_information</if_group>
<id>^450|^451|^452|^453|^454|^455|^456|^457|^458|^459</id>
<description>CMS New Content added event.</description>
</rule>
<rule id="100012" level="5">
<if_group>cms_information</if_group>
<id>^460|^461|^462|^463|^464|^465|^466|^467|^468|^469</id>
<description>CMS Existing Content modified event.</description>
</rule>
<rule id="100013" level="5">
<if_group>cms_information</if_group>
<id>^470|^471|^472|^473|^474|^475|^476|^477|^478|^479</id>
<description>CMS Existing Content deleted event.</description>
</rule>
524
Trend Micro Deep Security On-Premise 20
<rule id="100014" level="5">
<if_group>cms_information</if_group>
<id>^445|^446</id>
<description>CMS User created event.</description>
</rule>
<rule id="100015" level="5">
<if_group>cms_information</if_group>
<id>^447|449</id>
<description>CMS User deleted event.</description>
</rule>
</group>
Log Inspection rule severity levels and their recommended use
Level Description Notes
Level Ignored, no Primarily used to avoid false positives. These rules are scanned before all
0 action taken the others and include events with no security relevance.
no
Level
predefined
1
use
System low
Level
priority System notification or status messages that have no security relevance.
2
notification
Successful
Level or
Successful login attempts, firewall allow events, etc.
3 authorized
events
System low Errors related to bad configurations or unused devices or applications.
Level
priority They have no security relevance and are usually caused by default
4
errors installations or software testing.
User-
Level Missed passwords, denied actions, etc. These messages typically have no
generated
5 security relevance.
errors
Low Indicate a worm or a virus that provide no threat to the system such as a
Level
relevance Windows worm attacking a Linux server. They also include frequently
6
attacks triggered IDS events and common error events.
no
Level
predefined
7
use
no
Level
predefined
8
use
Level Error from Include attempts to login as an unknown user or from an invalid source. The
9 invalid message might have security relevance especially if repeated. They also
525
Trend Micro Deep Security On-Premise 20
Level Description Notes
source include errors regarding the admin or root account.
Multiple
Level user Include multiple bad passwords, multiple failed logins, etc. They might
10 generated indicate an attack, or it might be just that a user forgot his or her credentials.
errors
no
Level
predefined
11
use
High-
Level Include error or warning messages from the system, kernel, etc. They might
importance
12 indicate an attack against a specific application.
event
Unusual
Level Common attack patterns such as a buffer overflow attempt, a larger than
error (high
13 normal syslog message, or a larger than normal URL string.
importance)
High
Level importance Typically the result of the correlation of multiple attack rules and indicative
14 security of an attack.
event
Level Attack
Very small chance of false positive. Immediate attention is necessary.
15 Successful
strftime() conversion specifiers
Specifier Description
%a Abbreviated weekday name (e.g., Thu)
%A Full weekday name (e.g., Thursday)
%b Abbreviated month name (e.g., Aug)
%B Full month name (e.g., August)
%c Date and time representation (e.g., Thu Sep 22 12:23:45 2007)
%d Day of the month (01 - 31) (e.g., 20)
%H Hour in 24 h format (00 - 23) (e.g., 13)
%I Hour in 12 h format (01 - 12) (e.g., 02)
%j Day of the year (001 - 366) (e.g., 235)
%m Month as a decimal number (01 - 12) (e.g., 02)
%M Minute (00 - 59) (e.g., 12)
%p AM or PM designation (e.g., AM)
%S Second (00 - 61) (e.g., 55)
%U Week number with the first Sunday as the first day of week one (00 - 53) (e.g., 52)
%w Weekday as a decimal number with Sunday as 0 (0 - 6) (e.g., 2)
%W Week number with the first Monday as the first day of week one (00 - 53) (e.g., 21)
%x Date representation (e.g., 02/24/79)
%X Time representation (e.g., 04:12:51)
%y Year, last two digits (00 - 99) (e.g., 76)
%Y Year (e.g., 2008)
%Z Time zone name or abbreviation (e.g., EST)
526
Trend Micro Deep Security On-Premise 20
Specifier Description
%% A % sign (e.g., %)
More information can be found at the following websites:
https://www.php.net/manual/en/function.strftime.php
www.cplusplus.com/reference/clibrary/ctime/
Examine a Log Inspection rule
Log Inspection rules are found in the Deep Security Manager at Policies > Common Objects >
Rules > Log Inspection Rules.
Log Inspection rule structure and the event matching process
This screen shot displays the contents of the Configuration tab of the Properties window of the
"Microsoft Exchange" Log Inspection rule:
527
Trend Micro Deep Security On-Premise 20
Here is the structure of the rule:
528
Trend Micro Deep Security On-Premise 20
l 3800 - Grouping of Exchange Rules - Ignore
l 3801 - Email rcpt is not valid (invalid account) - Medium (4)
l 3851 - Multiple email attempts to an invalid account - High (9)
l Frequency - 10
l Time Frame - 120
l Ignore - 120
l 3802 - Email 500 error code - Medium (4)
l 3852 - Email 500 error code (spam) - High (9)
l Frequency - 12
l Time Frame - 120
l Ignore - 240
The Log Inspection engine will apply log events to this structure and see if a match occurs. For
example, if an Exchange event occurs, and this event is an email receipt to an invalid account,
the event will match line 3800 (because it is an Exchange event). The event will then be applied
to line 3800's sub-rules: 3801 and 3802.
If there is no further match, this "cascade" of matches will stop at 3800. Because 3800 has a
severity level of "Ignore", no Log Inspection event would be recorded.
However, an email receipt to an invalid account does match one of 3800's sub-rules: sub-rule
3801. Sub-rule 3801 has a severity level of "Medium(4)". If the matching stopped here, a Log
Inspection event with a severity level of "Medium(4)" would be recorded.
But there is still another sub-rule to be applied to the event: sub-rule 3851. Sub-rule 3851 with its
three attributes will match if the same event has occurred 10 times within the last 120 seconds. If
so, a Log Inspection event with a severity "High(9)" is recorded. (The "Ignore" attribute tells sub-
rule 3851 to ignore individual events that match sub-rule 3801 for the next 120 seconds. This is
useful for reducing "noise".)
Assuming the parameters of sub-rule 3851 have been matched, a Log Inspection event with
Severity "High(9)" is now recorded.
Looking at the Options tab of the Microsoft Exchange Rule, we see that Deep Security Manager
will raise an alert if any sub-rules with a severity level of "Medium(4)" have been matched. Since
this is the case in our example, the alert will be raised (if "Alert when this rule logs an event" is
selected).
529
Trend Micro Deep Security On-Premise 20
Duplicate Sub-rules
Some Log Inspection rules have duplicate sub-rules. To see an example, open the "Microsoft
Windows Events" rule and click on the Configuration tab. Note that sub-rule 18125 (Remote
access login failure) appears under sub-rules 18102 and 18103. Also note that in both cases
sub-rule 18125 does not have a severity value, it only says "See Below".
Instead of being listed twice, Rule 18125 is listed once at the bottom of the Configuration page:
530
Trend Micro Deep Security On-Premise 20
Create a list of directories for use in policies
Create lists of directory paths so that you can use them in multiple policies. A single list is easier
to manage than several identical lists that are each created in a different policy. The most
common use-cases for these lists are for Anti-Malware scan inclusions or exclusions. For more
information, see "Specify the files to scan" on page 562.
Tip: To create a directory list that is similar to an existing one, duplicate the list and then edit it.
The following table describes the syntax for defining directory list items. The use of forward
slashes "/" and backslashes "\" are supported for both Windows and Linux conventions:
Directory Format Description Examples
C:\Program Files\
Includes all files in the specified
Includes all files in the
Directory DIRECTORY directory and all files in all
"Program Files" directory
subdirectories.
and all subdirectories.
\\12.34.56.78\
\\some-comp-name\
Includes all files on a
network resource (and its
subfolders) identified
using an IP or a hostname.
Includes files on a computer included
Network \\NETWORK
as a network resource on a targeted \\12.34.56.78\somefolder\
Resource RESOURCE
computer. \\some-comp-
name\somefolder\
Includes all files in the
folder "somefolder" and its
subfolders on a network
resource identified using
an IP or a hostname.
C:\abc\*\
Includes all files in all
subdirectories of "abc" but
does not include the files
in the "abc" directory.
Includes any subdirectories with any
Directory C:\abc\wx*z\
subdirectory name, but does not
with DIRECTORY\*\ Matches:
include the files in the specified
wildcard (*) C:\abc\wxz\
directory.
C:\abc\wx123z\
Does not match:
C:\abc\wxz
C:\abc\wx123z
531
Trend Micro Deep Security On-Premise 20
Directory Format Description Examples
C:\abc\*wx\
Matches:
C:\abc\wx\
C:\abc\123wx\
Does not match:
C:\abc\wx
C:\abc\123wx
C:\abc\*
Matches:
C:\abc\
C:\abc\1
C:\abc\123
Does not match:
C:\abc
C:\abc\123\
C:\abc\123\456
C:\abx\
C:\xyz\
C:\abc\*wx
Matches:
C:\abc\wx
C:\abc\123wx
Does not match:
Includes any subdirectories with a
Directory C:\abc\wx\
matching name, but does not include
with DIRECTORY\* C:\abc\123wx\
the files in that directory and any
wildcard (*)
subdirectories.
C:\abc\wx*z
Matches:
C:\abc\wxz
C:\abc\wx123z
Does not match:
C:\abc\wxz\
C:\abc\wx123z\
C:\abc\wx*
Matches:
C:\abc\wx
C:\abc\wx\
C:\abc\wx12
C:\abc\wx12\345\
C:\abc\wxz\
Does not match:
C:\abc\wx123z\
Includes all files and subdirectories ${windir}
Environment defined by an environment variable If the variable resolves to
${ENV VAR} with the format ${ENV VAR}. For a "c:\windows", Includes all
variable
Virtual Appliance, the value pairs for the files in "c:\windows"
532
Trend Micro Deep Security On-Premise 20
Directory Format Description Examples
the environment variable must be
defined in Policy or Computer Editor >
and all its subdirectories.
Settings > General > Environment
Variable Overrides.
DIRECTORY Allows you to add comments to your c:\abc #Include the abc
Comments
#Comment inclusion definitions. directory
1. Click Policies > Common Objects > Lists > Directory Lists.
2. Click New > New Directory List.
3. Type a name and, optionally, a description.
4. In the Directory(s) list, add the directory paths, one per line.
5. Click OK.
Import and export directory lists
You can export one or more directory lists to an XML or CSV file, and import lists from an XML
file.
1. Click Policies > Common Objects > Lists > Directory Lists.
2. To export one or more lists, select them and click Export > Export Selected to CSV or
Export > Export Selected to XML.
3. To export all lists, click Export > Export to CSV or Export > Export to XML.
4. To import lists, click New > Import From File and follow the instructions on the wizard.
See which policies use a directory list
It is useful to see which policies use a directory list to be aware of which policies are affected by
any changes you make. For example, you can ensure no policies use a directory list before
deleting it.
1. Click Policies > Common Objects > Lists > Directory Lists.
2. Select the directory list and click Properties.
3. Click the Assigned To tab.
Create a list of file extensions for use in policies
Create lists of file extensions so that you can use them in multiple malware scan configurations.
A single list is easier to manage than several identical lists that are each created in a different
rule. For example, one list of file extensions can be used by multiple malware scan
configurations as files to include in a scan. Another list of file extensions can be used by multiple
malware scan configurations as files to exclude from a scan.
533
Trend Micro Deep Security On-Premise 20
Tip: To create a file extension list that is similar to an existing one, duplicate the list and then
edit it.
You can insert comments into your list by preceding the text with a pound sign ("#").
1. Click Policies > Common Objects > Lists > File Extension Lists.
2. Click New > New File Extension List.
3. Type a name and, optionally, a description.
4. In the File Extension(s) list, add the extensions, one per line.
5. Click OK.
Import and export file extension lists
You can export one or more file extension lists to an XML or CSV file, and import lists from an
XML file.
1. Click Policies > Common Objects > Lists > File Extension Lists.
2. To export one or more lists, select them and click Export > Export Selected to CSV or
Export > Export Selected to XML.
3. To export all lists, click Export > Export to CSV or Export > Export to XML.
4. To import lists, click New > Import From File and follow the instructions on the wizard.
See which malware scan configurations use a file extension list
It is useful to see which malware scan configurations use a file extension list to be aware of
which rules are affected by any changes you make. For example, you can ensure no scan
configurations use a file extension list before deleting it.
1. Click Policies > Common Objects > Lists > File Extension Lists.
2. Select the list and click Properties.
3. Click the Assigned To tab.
Create a list of files for use in policies
Create lists of file paths so that you can use them in multiple policies. A single list is easier to
manage than several identical lists that are each created in a different policy. The most common
use-cases for these lists are for Anti-Malware scan inclusions or exclusions. For more
information, see "Specify the files to scan" on page 562.
Tip: To create a file list that is similar to an existing one, duplicate the list and then edit it.
534
Trend Micro Deep Security On-Premise 20
The following table describes the syntax for defining file list items. The use of forward slashes "/"
and backslashes "\" are supported for both Windows and Linux conventions:
Inclusion Format Description Example
abc.doc
Includes all files
Includes all files with the specified file name
File FILE named "abc.doc" in all
regardless of its location or directory.
directories. Does not
include "abc.exe".
C:\Documents\abc.doc
Includes the specific file specified by the file Includes only the file
File path FILEPATH
path. named "abc.doc" in the
"Documents" directory.
abc*.exe
Includes any file that
has prefix of "abc" and
extension of ".exe".
*.db
Matches:
123.db
abc.db
Does not match:
123db
123.abd
cbc.dba
File with Includes all files with a matching pattern in the *db
FILE*
wildcard (*) file name. Matches:
123.db
123db
ac.db
acdb
db
Does not match:
db123
wxy*.db
Matches:
wxy.db
wxy123.db
Does not match:
wxydb
abc.v*
Includes any file that
File with Includes all files with a matching pattern in the has file name of "abc"
FILE.EXT*
wildcard (*) file extension. and extension
535
Trend Micro Deep Security On-Premise 20
Inclusion Format Description Example
beginning with ".v".
abc.*pp
Matches:
abc.pp
abc.app
Does not match:
wxy.app
abc.a*p
Matches:
abc.ap
abc.a123p
Does not match:
abc.pp
abc.*
Matches:
abc.123
abc.xyz
Does not match:
wxy.123
a*c.a*p
Matches:
ac.ap
File with Includes all files with a matching pattern in the a123c.ap
FILE*.EXT*
wildcard (*) file name and in the extension. ac.a456p
a123c.a456p
Does not match:
ad.aa
Includes files specified by an environment
variable with the format ${ENV VAR}. These ${myDBFile}
Environment ${ENV
can be defined or overridden using Policy or Includes the file
variable VAR}
Computer Editor > Settings > General > "myDBFile".
Environment Variable Overrides.
FILEPATH Allows you to add comments to your inclusion C:\Documents\abc.doc
Comments
#Comment definitions. #This a comment
1. Click Policies > Common Objects > Lists > File Lists.
2. Click New > New File List.
3. Type a name and, optionally, a description.
4. In the File(s) list, add the file paths, one per line.
5. Click OK.
536
Trend Micro Deep Security On-Premise 20
Import and export file lists
You can export one or more file lists to an XML or CSV file, and import lists from an XML file.
1. Click Policies > Common Objects > Lists > File Lists.
2. To export one or more lists, select them and click Export > Export Selected to CSV or
Export > Export Selected to XML.
3. To export all lists, click Export > Export to CSV or Export > Export to XML.
4. To import lists, click New > Import From File and follow the instructions on the wizard.
See which policies use a file list
It is useful to see which policies use a file list to be aware of which policies are affected by any
changes you make. For example, you can ensure no policies use a file list before deleting it.
1. Click Policies > Common Objects > Lists > File Lists.
2. Select the file list and click Properties.
3. Click the Assigned To tab.
Create a list of IP addresses for use in policies
Create lists of IP addresses so that you can use them in multiple firewall rules. A single list is
easier to manage than several identical lists that are each defined in a different rule.
Tip: To create an IP list that is similar to an existing one, duplicate the list and then edit it.
You can enter an individual IP address, or you can enter IP ranges and masked IPs. You can
also insert comments into your IP list by preceding the text with a hash sign ("#").
Masked IP examples are 192.168.0/24, 192.168.2.0/255.255.255.0, and for IPV6
2001:0DB8::CD30:0:0:0:0/60. IP range examples are 192.168.0.2 - 192.168.0.125 and, for IPV6,
FF01::101 - FF01::102
1. Click Policies > Common Objects > Lists > IP Lists.
2. Click New > New IP List.
3. Type a name and, optionally, a description.
4. In the IP(s) list, add the IP addresses, masked IP addresses, or IP ranges (one per line).
5. Click OK.
Import and export IP lists
You can export one or more IP lists to an XML or CSV file, and import lists from an XML file.
537
Trend Micro Deep Security On-Premise 20
1. Click Policies > Common Objects > Lists > IP Lists.
2. To export one or more lists, select them and click Export > Export Selected to CSV or
Export > Export Selected to XML.
3. To export all lists, click Export > Export to CSV or Export > Export to XML.
4. To import lists, click New > Import From File and follow the instructions on the wizard.
See which rules use an IP list
It is useful to see which firewall rules use an IP list to be aware of which rules are affected by any
changes you make. For example, you can ensure no firewall rules use an IP list before deleting
it.
1. Click Policies > Common Objects > Lists > IP Lists.
2. Select the IP list and click Properties.
3. Click the Assigned To tab.
Create a list of ports for use in policies
Create lists of port numbers so that you can use them in multiple rules. A single list is easier to
manage than several identical lists that are each created in a different rule.
Tip: To create a port list that is similar to an existing one, duplicate the list and then edit it.
Individual ports and port ranges can be included on the list, for example 80, and 20-21. You can
insert comments into your port list by preceding the text with a pound sign ("#").
Note: For a listing commonly accepted port number assignments, see the Internet Assigned
Numbers Authority (IANA). For a list of port numbers used by Deep Security Manager, Relay,
or Agent, see "Port numbers, URLs, and IP addresses" on page 178.
1. Click Policies > Common Objects > Lists > Port Lists.
2. Click New > New Port List.
3. Type a name and, optionally, a description.
4. In the Port(s) list, add the port numbers, one per line.
5. Click OK.
Import and export port lists
You can export one or more port lists to an XML or CSV file, and import lists from an XML file.
538
Trend Micro Deep Security On-Premise 20
1. Click Policies > Common Objects > Lists > Port Lists.
2. To export one or more lists, select them and click Export > Export Selected to CSV or
Export > Export Selected to XML.
3. To export all lists, click Export > Export to CSV or Export > Export to XML.
4. To import lists, click New > Import From File and follow the instructions on the wizard.
See which rules use a port list
It is useful to see which rules use a port list to be aware of which rules are affected by any
changes you make. For example, you can ensure no rules use a port list before deleting it.
1. Click Policies > Common Objects > Lists > Port Lists.
2. Select the port list and click Properties.
3. Click the Assigned To tab.
Create a list of MAC addresses for use in policies
Create lists of MAC addresses so that you can use them in multiple policies. A single list is
easier to manage than several identical lists that are each created in a different policy.
Tip: To create a MAC list that is similar to an existing one, duplicate the list and then edit it.
MAC lists support MAC addresses in both hyphen- and colon-separated formats, for example
0A-0F-FF-F0-A0-AF and 0A:0F:FF:F0:A0:AF. You can insert comments into your MAC list by
preceding the text with a pound sign ("#").
1. Click Policies > Common Objects > Lists > MAC Lists.
2. Click New > New MAC List.
3. Type a name and, optionally, a description.
4. In the MAC(s) list, add the MAC addresses, one per line.
5. Click OK.
Import and export MAC lists
You can export one or more MAC lists to an XML or CSV file, and import lists from an XML file.
1. Click Policies > Common Objects > Lists > MAC Lists.
2. To export one or more lists, select them and click Export > Export Selected to CSV or
Export > Export Selected to XML.
3. To export all lists, click Export > Export to CSV or Export > Export to XML.
4. To import lists, click New > Import From File and follow the instructions on the wizard.
539
Trend Micro Deep Security On-Premise 20
See which policies use a MAC list
It is useful to see which policies use a MAC list to be aware of which policies are affected by any
changes you make. For example, you can ensure no policies use a MAC list before deleting it.
1. Click Policies > Common Objects > Lists > MAC Lists.
2. Select the MAC list and click Properties.
3. Click the Assigned To tab.
Define contexts for use in policies
Contexts are a powerful way of implementing different security policies depending on a
computer's network environment.
Contexts are designed to be associated with firewall and intrusion prevention rules. If the
conditions defined in the context associated with a rule are met, the rule is applied.
Configure settings used to determine whether a computer has internet
connectivity
1. In the Deep Security Manager, go to Administration > System Settings > Contexts.
2. In the URL for testing Internet Connectivity Status box, enter the URL to which an HTTP
request will be sent to test for internet connectivity. (You must include "http://".)
3. In the Regular Expression for returned content used to confirm Internet Connectivity
Status box, enter a regular expression that will be applied to the returned content to
confirm that HTTP communication was successful. (If you are certain of the returned
content, you can use a simple string of characters.)
4. In the Test Interval list, select the time interval between connectivity tests.
For example, to test Internet connectivity, you could use the URL "http://www.example.com",
and the string "This domain is established to be used for illustrative examples in documents"
which is returned by the server at that URL.
Define a context
1. In the Deep Security Manager, go to Policies > Common Objects > Other > Contexts and
then click New > New Context.
2. In the General Information area, enter the name and description of the context rule. This
area also displays the earliest version of the Deep Security Agent the rule will be
compatible with.
540
Trend Micro Deep Security On-Premise 20
3. In the Options area, specify when the context will be applied:
l Context applies when connection is: Specifying an option here will determine whether
the Firewall rule is in effect depending on the ability of the computer to connect to its
domain controller or its internet connectivity. (Conditions for testing internet
connectivity can be configured in Administration > System Settings > Contexts.)
If the domain controller can be contacted directly (via ICMP), the connection is "Local".
If it can be contacted via VPN only, then the connection is "Remote".
The time interval between domain controller connectivity tests is the same as the
internet connectivity test interval, which is configurable in Administration > System
Settings > Contexts. The internet connectivity test is only performed if the computer is
unable to connect to its domain controller.
l Context Applies to Interface Isolation Restricted Interfaces: This context will apply to
network interfaces on which traffic has been restricted through the use of interface
isolation. This is primarily used for "Allow" or "Force Allow" Firewall rules. See "Detect
and configure the interfaces available on a computer" on page 467.
After you assign the context to a rule, it is displayed on the Assigned To tab for the context. (To
link a security rule to a context, go to the Options tab in the security rule's Properties window
and select the context from the "Context" list.)
Define stateful firewall configurations
Deep Security's stateful firewall configuration mechanism analyzes each packet in the context of
traffic history, correctness of TCP and IP header values, and TCP connection state transitions. In
the case of stateless protocols like UDP and ICMP, a pseudo-stateful mechanism is
implemented based on historical traffic analysis. Packets are handled by the stateful mechanism
as follows:
1. A packet is passed to the stateful routine if it has been allowed through by the static firewall
rule conditions,
2. The packet is examined to determine whether it belongs to an existing connection, and
3. The TCP header is examined for correctness (e.g. sequence numbers, flag combinations,
etc.).
To create a new stateful configuration, you need to:
1. "Add a stateful configuration " on the next page.
2. "Enter stateful configuration information" on the next page.
541
Trend Micro Deep Security On-Premise 20
3. "Select packet inspection options" below.
When you're done with your stateful configuration, you can also learn how to
l "See policies and computers a stateful configuration is assigned to" on page 546
l "Export a stateful configuration " on page 546
l "Delete a stateful configuration " on page 546
Add a stateful configuration
There are three ways to define a stateful configuration on the Policies > Common Objects >
Other > Firewall Stateful Configurations page:
l Create a new configuration. Click New > New Firewall Stateful Configuration.
l Import a configuration from an XML file. Click New > Import From File.
l Copy and then modify an existing configuration. Right-click the configuration in the
Firewall Stateful Configurations list and then click Duplicate. To edit the new configuration,
select it and then click Properties.
Enter stateful configuration information
Enter a Name and Description for the configuration.
Select packet inspection options
You can define options for IP, TCP, UDP and ICMP packet inspection, end enable Active or
Passive FTP.
IP packet inspection
Under the General tab, select the Deny all incoming fragmented packets to drop any
fragmented packets. Dropped packets will bypass fragmentation analysis and generate an "IP
fragmented packet" log entry. Packets with a total length smaller than the IP header length are
dropped silently.
Warning: Attackers sometimes create and send fragmented packets in an attempt to bypass
Firewall Rules.
Note: The Firewall Engine, by default, performs a series of checks on fragmented packets.
This is default behavior and cannot be reconfigured. Packets with the following characteristics
542
Trend Micro Deep Security On-Premise 20
are dropped:
l Invalid fragmentation flags/offset: A packet is dropped when either the DF and MF flags
in the IP header are set to 1, or the header contains the DF flag set to 1 and an Offset
value different than 0.
l First fragment too small: A packet is dropped if its MF flag is set to 1, its Offset value is
at 0, and it has total length of less than 120 bytes (the maximum combined header
length).
l IP fragment out of boundary: A packet is dropped if its Offset flag value combined with
the total packet length exceeds the maximum datagram length of 65535 bytes.
l IP fragment offset too small: A packet is dropped if it has a non-zero Offset flag with a
value that is smaller than 60 bytes.
TCP packet inspection
Under the TCP tab, select which of the following options you would like to enable:
l Deny TCP packets containing CWR, ECE flags: These flags are set when there is
network congestion.
Note: RFC 3168 defines two of the six bits from the Reserved field to be used for ECN
(Explicit Congestion Notification), as follows:
l Bits 8 to 15: CWR-ECE-URG-ACK-PSH-RST-SYN-FIN
l TCP Header Flags Bit Name Reference:
l Bit 8: CWR (Congestion Window Reduced) [RFC3168]
l Bit 9: ECE (ECN-Echo) [RFC3168]
Warning: Automated packet transmission (such as that generated by a denial of service
attack, among other things) will often produce packets in which these flags are set.
l Enable TCP stateful inspection: Enable stateful inspection at the TCP level. If you enable
stateful TCP inspection, the following options become available:
l Enable TCP stateful logging: TCP stateful inspection events will be logged.
l Limit the number of incoming connections from a single computer to: Limiting the
number of connections from a single computer can lessen the effect of a denial of
service attack.
543
Trend Micro Deep Security On-Premise 20
l Limit the number of outgoing connections to a single computer to: Limiting the
number of outgoing connections to a single computer can significantly reduce the
effects of Nimda-like worms.
l Limit the number of half-open connections from a single computer to: Setting a limit
here can protect you from DoS attacks like SYN Flood. Although most servers have
timeout settings for closing half-open connections, setting a value here can prevent
half-open connections from becoming a significant problem. If the specified limit for
SYN-SENT (remote) entries is reached, subsequent TCP packets from that specific
computer will be dropped.
Note: When deciding on how many open connections from a single computer to
allow, choose your number from somewhere between what you would consider a
reasonable number of half-open connections from a single computer for the type of
protocol being used, and how many half-open connections from a single computer
your system can maintain without getting congested.
l Enable ACK Storm protection when the number of already acknowledged packets
exceeds: Set this option to log an event that an ACK Storm attack has occurred.
l Drop Connection when ACK Storm detected: Set this option to drop the
connection if such an attack is detected.
Note: ACK Storm protection options are only available on Deep Security Agent 8.0
and earlier.
FTP Options
Under the FTP Options tab, you can enable the following options:
Note: The following FTP options are available in Deep Security Agent version 8.0 and earlier.
l Active FTP
l Allow Incoming: Allow Active FTP when this computer is acting as a server.
l Allow Outgoing: Allow Active FTP when this computer is acting as client.
l Passive FTP
l Allow Incoming: Allow Passive FTP when this computer is acting as a server.
l Allow Outgoing: Allow Passive FTP when this computer is acting as a client.
544
Trend Micro Deep Security On-Premise 20
UDP packet inspection
Under the UDP tab, you can enable the following options:
l Enable UDP stateful inspection: Select to enable stateful inspection of UDP traffic.
Note: The UDP stateful mechanism drops unsolicited incoming UDP packets. For every
outgoing UDP packet, the rule will update its UDP "stateful" table and will then only
allow a UDP response if it occurs within 60 seconds of the request. If you wish to allow
specific incoming UDP traffic, you will have to create a Force Allow rule. For example, if
you are running a DNS server, you will have to create a Force Allow rule to allow
incoming UDP packets to destination port 53.
Warning: Without stateful inspection of UDP traffic, an attacker can masquerade as a
DNS server and send unsolicited UDP "replies" from source port 53 to computers behind
a firewall.
l Enable UDP stateful logging: Selecting this option will enable the logging of UDP
stateful inspection events.
ICMP packet inspection
Under the ICMP tab, you can enable the following options:
Note: ICMP stateful inspection is available in Deep Security Agent version 8.0 or earlier.
l Enable ICMP stateful inspection: Select to enable stateful inspection of ICMP traffic.
Note: The ICMP (pseudo-)stateful mechanism drops incoming unsolicited ICMP
packets. For every outgoing ICMP packet, the rule will create or update its ICMP
"stateful" table and will then only allow a ICMP response if it occurs within 60 seconds of
the request. (ICMP pair types supported: Type 0 & 8, 13 & 14, 15 & 16, 17 & 18.)
Warning: With stateful ICMP inspection enabled, you can, for example, only allow an
ICMP echo-reply in if an echo-request has been sent out. Unrequested echo-replies
545
Trend Micro Deep Security On-Premise 20
could be a sign of several kinds of attack including a Smurf amplification attack, a Tribe
Flood Network communication between master and daemon, or a Loki 2 back-door.
l Enable ICMP stateful logging: Selecting this option will enable the logging of ICMP
stateful inspection events.
Export a stateful configuration
You can export all stateful configurations to a .csv or .xml file by clicking Export and selecting
the corresponding export action from the list. You can also export specific stateful configurations
by first selecting them, clicking Export and then selecting the corresponding export action from
the list.
Delete a stateful configuration
To delete a stateful configuration, right-click the configuration in the Firewall Stateful
Configurations list, click Delete and then click OK.
Note: Stateful configurations that are assigned to one or more computers or that are part of a
policy cannot be deleted.
See policies and computers a stateful configuration is assigned to
You can see which policies and computers are assigned to a stateful inspection configuration on
the Assigned To tab. Click on a policy or computer in the list to see their properties.
Define a schedule that you can apply to rules
Schedules are reusable timetables that you can assign to rules, agent upgrades, and more.
1. In Deep Security Manager, go to Policies > Common Objects > Other > Schedules.
2. Click New > New Schedule.
3. In the General Information area, enter a name and description used to identify the
schedule.
4. Click a time block in the grid to select it. To deselect it, click it while pressing Shift.
Schedule periods are defined by hour-long time blocks.
After you assign the schedule to a rule, it is displayed on the Assigned To tab for the schedule.
To link a security rule to a schedule, go to the Options tab in the security rule's Properties
window and select the schedule from the "Schedule" list.
546
Trend Micro Deep Security On-Premise 20
Note: With agent-based protection, schedules use the same time zone as the protected
computer's operating system. With agentless protection, schedules use the same time zone as
the Deep Security Virtual Appliance.
Configure protection modules
Configure Anti-Malware
About Anti-Malware
The Deep Security anti-malware module provides agent computers with both real-time and on-
demand protection against file-based threats, including malware, viruses, Trojans, and spyware.
To identify threats, the anti-malware module checks files on the local hard drive against a
comprehensive threat database. The anti-malware module also checks files for certain
characteristics, such as compression and known exploit code.
Portions of the threat database are hosted on Trend Micro servers or stored locally as patterns.
Deep Security Agents periodically download anti-malware patterns and updates to ensure
protection against the latest threats.
Note: A newly installed Deep Security Agent cannot provide anti-malware protection until it
has contacted an update server to download anti-malware patterns and updates. Ensure that
your Deep Security Agents can communicate with a Deep Security Relay or the Trend Micro
Update Server after installation.
The anti-malware module eliminates threats while minimizing the impact on system
performance. The anti-malware module can clean, delete, or quarantine malicious files. It can
also terminate processes and delete other system objects that are associated with identified
threats.
To turn on and configure the anti-malware module, see "Enable and configure anti-malware" on
page 554.
l "Types of malware scans" on the next page
l "Malware scan configurations" on page 549
l "Malware events" on page 550
547
Trend Micro Deep Security On-Premise 20
l "SmartScan" on page 550
l "Predictive Machine Learning" on page 551
l "Connected Threat Defense" on page 551
l "Types of malware scans" below
Types of malware scans
The anti-malware module performs several types of scans. See also "Select the types of scans
to perform" on page 555.
Real-time scan
Scan immediately each time a file is received, opened, downloaded, copied, or modified, Deep
Security scans the file for security risks. If Deep Security detects no security risk, the file remains
in its location and users can proceed to access the file. If Deep Security detects a security risk, it
displays a notification message that shows the name of the infected file and the specific security
risk.
Real-time scans are in effect continuously unless another time period is configured using the
Schedule option.
Tip: You can configure real-time scanning to run when it will not have a large impact on
performance; for example, when a file server is scheduled to back up files.
This scan can run on all platforms supported by the anti-malware module.
Manual scan
Runs a full system scan on all processes and files on a computer. The time required to complete
a scan depends on the number of files to scan and the computer's hardware resources. A
manual scan requires more time than a Quick Scan.
A manual scan executes when Full Scan for Malware is clicked.
This scan can be run on all platforms supported by the anti-malware module.
Scheduled scan
Runs automatically on the configured date and time. Use scheduled scan to automate routine
scans and improve scan management efficiency.
548
Trend Micro Deep Security On-Premise 20
A scheduled scan runs according to the date and time you specify when you create a Scan
computers for Malware task using scheduled tasks (see "Schedule Deep Security to perform
tasks" on page 1378).
This scan can be run on all platforms supported by the anti-malware module.
Quick scan
Only scans a computer's critical system areas for currently active threats. A Quick Scan will look
for currently active malware but it will not perform deep file scans to look for dormant or stored
infected files. It is significantly faster than a Full Scan on larger drives. Quick scan is not
configurable.
A Quick Scan runs when you click Quick Scan for Malware.
Note: Quick Scan can run only on Windows computers.
Scan objects and sequence
The following table lists the objects scanned during each type of scan and the sequence in
which they are scanned.
Targets Full Scan (Manual or Scheduled) Quick Scan
Drivers 1 1
Trojan 2 2
Process Image 3 3
Memory 4 4
Boot Sector 5 -
Files 6 5
Spyware 7 6
Malware scan configurations
Malware scan configurations are sets of options that control the behavior of malware scans.
When you configure anti-malware using a policy or for a specific computer, you select a malware
549
Trend Micro Deep Security On-Premise 20
scan configuration to use. You can create several malware scan configurations and use them
with different policies when different groups of computers have different scan requirements.
Real-time, manual, and scheduled scans all use malware scan configurations. Deep Security
provides a default malware scan configuration for each type of scan. These scan configurations
are used in the default security policies. You can use the default scan configurations as-is,
modify them, or create your own.
Note: Quick Scans are not configurable, and do not use malware scan configurations.
You can specify which files and directories are included or excluded during a scan and which
actions are taken if malware is detected on a computer (for example, clean, quarantine, or
delete).
For more information, see "Configure malware scans" on page 557.
Malware events
When Deep Security detects malware it triggers an event that appears in the event log. From
there you can see information about the event, or create an exception for the file in case of false
positives. You can also restore files that are actually benign.
For details, see:
l "Anti-malware events" on page 1033
l "View and restore identified malware" on page 599
l "Create anti-malware exceptions" on page 606
SmartScan
Smart Scan uses threat signatures that are stored on Trend Micro servers and provides several
benefits:
l Provides fast, cloud-based, real-time security status lookups
l Reduces the time required to deliver protection against emerging threats
l Reduces network bandwidth consumed during pattern updates (bulk of pattern definition
updates only need to be delivered to the cloud, not to many computers)
l Reduces cost and overhead of corporate-wide pattern deployments
l Lowers kernel memory consumption on computers (consumption increases minimally over
time)
550
Trend Micro Deep Security On-Premise 20
When Smart Scan is enabled, Deep Security first scans locally for security risks. If Deep Security
cannot assess the risk of the file during the scan, it will try to connect to a local Smart Scan
server. If no local Smart Scan Server is detected, Deep Security will attempt to connect to the
Trend Micro Global Smart Scan server. For more information on this feature, see "Smart
Protection in Deep Security" on page 596.
Predictive Machine Learning
Deep Security provides enhanced malware protection for unknown threats and zero-day attacks
through Predictive Machine Learning. Trend Micro Predictive Machine Learning uses advanced
machine learning technology to correlate threat information and perform in-depth file analysis to
detect emerging security risks through digital DNA fingerprinting, API mapping, and other file
features.
Predictive Machine Learning is effective in protecting against security breaches that result from
targeted attacks using techniques such as phishing and spear phishing. In these cases, malware
that is designed specifically to target your environment can bypass traditional malware scanning
techniques.
During real-time scans, when Deep Security detects an unknown or low-prevalence file, Deep
Security scans the file using the Advanced Threat Scan Engine (ATSE) to extract file features. It
then sends the report to the Predictive Machine Learning engine on the Trend Micro Smart
Protection Network. Through the use of malware modeling, Predictive Machine Learning
compares the sample to the malware model, assigns a probability score, and determines the
probable malware type that the file contains.
If the file is identified as a threat, Deep Security cleans, quarantines, or deletes the file to prevent
the threat from continuing to spread across your network.
For information about using Predictive Machine Learning, see "Detect emerging threats using
Predictive Machine Learning" on page 578.
Connected Threat Defense
Connected Threat Defense provides enhanced malware protection for new and emerging
threats by setting up a connection between Deep Security and Trend Micro’s sandboxing
technology, Deep Discovery Analyzer. For details, see "Detect emerging threats using
Connected Threat Defense" on page 580.
551
Trend Micro Deep Security On-Premise 20
Malware types
The anti-malware module protects against many file-based threats. See also "Scan for specific
types of malware" on page 559 and "Configure how to handle malware" on page 568
Virus
Viruses infect files by inserting malicious code. Typically, when an infected file is opened the
malicious code automatically runs and delivers a payload in addition to infecting other files.
Below are some of the more common types of viruses:
l COM and EXE infectors infect DOS and Windows executable files, which typically have
COM and EXE extensions.
l Macro viruses infect Microsoft Office files by inserting malicious macros.
l Boot sector viruses infect the section of hard disk drives that contain operating system
startup instructions
The anti-malware module uses different technologies to identify and clean infected files. The
most traditional method is to detect the actual malicious code that is used to infect files and strip
infected files of this code. Other methods include regulating changes to infectable files or
backing up such files whenever suspicious modifications are applied to them.
Trojans
Some malware does not spread by injecting code into other files. Instead, it has other methods
or effects:
l Trojans: Malware files that execute and infect the system when opened (like the
mythological Trojan horse).
l Backdoors: Malicious applications that open port numbers to allow unauthorized remote
users to access infected systems.
l Worms: Malware programs that use the network to propagate from system to system.
Worms are known to propagate by taking advantage of social engineering through
attractively packaged email messages, instant messages, or shared files. They are also
known to copy themselves to accessible network shares and spread to other computers by
exploiting vulnerabilities.
l Network viruses: Worms that are memory-only or packet-only programs (not file-based).
Anti-malware is unable to detect or remove network viruses.
552
Trend Micro Deep Security On-Premise 20
l Rootkits: File-based malware that manipulate calls to operating system components.
Applications, including monitoring and security software, need to make such calls for very
basic functions, such as listing files or identifying running processes. By manipulating
these calls, rootkits are able to hide their presence or the presence of other malware.
Packer
Packers are compressed and encrypted executable programs. To evade detection, malware
authors often pack existing malware under several layers of compression and encryption. Anti-
malware checks executable files for compression patterns associated with malware.
Spyware/grayware
Spyware and grayware comprises applications and components that collect information to be
transmitted to a separate system or collected by another application. Spyware/grayware
detections, although exhibiting potentially malicious behavior, may include applications used for
legitimate purposes such as remote monitoring. Spyware/grayware applications that are
inherently malicious, including those that are distributed through known malware channels, are
typically detected as other Trojans.
Spyware and grayware applications are typically categorized as:
l Spyware: software installed on a computer to collect and transmit personal information.
l Dialers: malicious dialers are designed to connect through premium-rate numbers causing
unexpected charges. Some dialers also transmit personal information and download
malicious software.
l Hacking tools: programs or sets of programs designed to assist unauthorized access to
computer systems.
l Adware (advertising-supported software): any software package that automatically plays,
displays, or downloads advertising material.
l Cookies: text files stored by a Web browser. Cookies contain website-related data such as
authentication information and site preferences. Cookies are not executable and cannot be
infected; however, they can be used as spyware. Even cookies sent from legitimate
websites can be used for malicious purposes.
l Keyloggers: software that logs user keystrokes to steal passwords and other private
information. Some keyloggers transmit logs to remote systems.
What is grayware?
553
Trend Micro Deep Security On-Premise 20
Although they exhibit what can be intrusive behavior, some spyware-like applications are
considered legitimate. For example, some commercially available remote control and monitoring
applications can track and collect system events and then send information about these events
to another system. System administrators and other users may find themselves installing these
legitimate applications. These applications are called "grayware".
To provide protection against the illegitimate use of grayware, the anti-malware module detects
grayware but provides an option to "approve" detected applications and allow them to run.
Cookie
Cookies are text files stored by a web browser, transmitted back to the web server with each
HTTP request. Cookies can contain authentication information, preferences, and (in the case of
stored attacks from an infected server) SQL injection and XSS exploits.
Other threats
Other threats includes malware not categorized under any of the malware types. This category
includes joke programs, which display false notifications or manipulate screen behavior but are
generally harmless.
Possible malware
Possible malware is a file that appears suspicious but cannot be classified as a specific
malware variant. When possible malware is detected, Trend Micro recommends that you contact
your support provider for assistance in further analysis of the file. By default, these detections are
logged and files are anonymously sent back to Trend Micro for analysis.
Set up Anti-Malware
Enable and configure anti-malware
To use anti-malware, perform these basic steps:
1. "Turn on the anti-malware module" on the next page.
2. "Select the types of scans to perform" on the next page.
3. "Configure scan exclusions" on page 556
4. "Ensure that Deep Security can keep up to date on the latest threats" on page 556.
When you have completed these steps, review "Configure malware scans" on page 557 and
refine the anti-malware scan behavior.
554
Trend Micro Deep Security On-Premise 20
Tip: For most anti-malware settings, you can either configure them for each individual
computer or in a policy that applies to multiple computers (for example, to all Windows 2008
Servers). To make management easier, configure the settings in the policy (not individual
computers) wherever possible. For more information, see "Policies, inheritance, and overrides"
on page 451.
Tip: CPU usage and RAM usage varies by your anti-malware configuration. To optimize anti-
malware performance on Deep Security Agent, see "Performance tips for anti-malware" on
page 572.
For an overview of the anti-malware feature, see "About Anti-Malware" on page 547.
Turn on the anti-malware module
1. Go to Policies.
2. Double-click the policy for which you want to enable anti-malware.
3. Go to Anti-Malware > General.
4. From Anti-Malware State, select On.
5. Click Save.
Select the types of scans to perform
When anti-malware is turned on, Deep Security needs to know what type of scans it should
perform (see "Types of malware scans" on page 548).
1. Go to Policies.
2. Double-click the policy to configure.
3. Click Anti-Malware > General.
4. Enable or disable each type of scan:
a. To perform the scan using default settings, select Default.
b. To perform the scan using a malware scan configuration that you can customize,
select a malware scan configuration.
c. To disable the scan, for the malware scan configuration select No Configuration.
5. Click Save.
Tip: Trend Micro recommends that you configure Deep Security to perform weekly scheduled
scans on all protected servers. You can do this using Scheduled Tasks. (See "Schedule Deep
Security to perform tasks" on page 1378.)
555
Trend Micro Deep Security On-Premise 20
Configure scan exclusions
To reduce scanning time and minimize the use of computing resources, you can configure Deep
Security malware scans to exclude specific folders, files, and file types from all types of scans.
You can also exclude process image files from real-time malware scans that are run on
Windows servers.
All of these exclusions are specified by selecting exclusion lists on the Exclusions tab of the
Malware Scan Configuration editor. See "Specify the files to scan" on page 562.
Tip: If any performance-related issues are experienced when Deep Security anti-malware
protection is enabled, you can use exclusions to help troubleshoot these issues by excluding
specific folders or files from scanning.
Ensure that Deep Security can keep up to date on the latest threats
To remain effective against new viruses and exploits, Deep Security Agents need to be able to
download the latest software and security update packages from Trend Micro or indirectly, from
your own Relay. These packages contain threat definitions and patterns. Relay-enabled agents,
organized into relay groups (also managed and configured by the Deep Security Manager)
retrieve security updates from Trend Micro, and then distribute them to other agents and
appliances.
1. Go to Administration > System Settings > Updates.
2. Configure Deep Security's ability to retrieve security updates from Trend Micro. Make sure
you have at least one relay-enabled agent, and it is assigned to the appropriate agents and
appliances.
To determine if a Deep Security Agent is a relay, next to a computer, click Preview.
556
Trend Micro Deep Security On-Premise 20
3. Go to Administration > Scheduled Tasks.
4. Verify that there is a scheduled task to regularly download available updates for both
security and software updates.
Configure malware scans
Malware scan configurations are reusable saved settings that you can apply when configuring
anti-malware in a policy or for a computer. A malware scan configuration specifies what types of
malware scanning Deep Security performs and which files it scans. Some policy properties also
affect the behavior of malware scans.
l "Create or edit a malware scan configuration" on the next page
l "Scan for specific types of malware" on page 559
l "Specify the files to scan" on page 562
l "Specify when real-time scans occur" on page 568
l "Configure how to handle malware" on page 568
l "Identify malware files by file hash digest" on page 571
l "Configure notifications on the computer" on page 572
557
Trend Micro Deep Security On-Premise 20
The Deep Security Best Practice Guide also provides several recommendations for
configuration malware scans.
Tip: CPU usage and RAM usage varies by your anti-malware configuration. To optimize anti-
malware performance on the Deep Security Agent, see "Performance tips for anti-malware" on
page 572.
Create or edit a malware scan configuration
Create or edit a malware scan configuration to control the behavior of a real-time, manual, or
scheduled scan. (For more information, see "Malware scan configurations" on page 549.) You
can create multiple malware scan configurations as required.
l After you create a malware scan configuration, you can then associate it with a scan in a
policy or computer (see "Select the types of scans to perform" on page 555)
l When you edit a malware scan configuration that a policy or computer is using, the
changes affect the scans that are associated with the configuration.
Tip: To create a malware scan configuration that is similar to an existing one, duplicate the
existing configuration and then edit it.
You can create two types of malware scan configurations according to the type of scan it controls
(see "Types of malware scans" on page 548):
l Real-time scan configuration: Controls real-time scans. Some actions such as Deny
Access are only available to real-time scan configurations
l Manual/scheduled scan configuration: Controls either manual or scheduled scans. Some
options such as CPU Usage are only available to manual/scheduled scan configurations
Deep Security provides a default malware scan configuration for each type of scan.
1. Go to Policies > Common Objects > Other > Malware Scan Configurations.
2. To create a scan configuration, click New and then click New Real-Time Scan
Configuration or New Manual/Scheduled Scan Configuration.
a. Type a name to identify the scan configuration. You see the name in a list when
configuring malware scans in a policy.
b. (Optional) Type a description that explains the use case for the configuration.
3. To view and edit an existing scan configuration, select it and click Properties.
4. To duplicate a scan configuration, select it and click Duplicate.
558
Trend Micro Deep Security On-Premise 20
Tip: To see the policies and computers that are using a malware scan configuration, see the
AssignedTo tab of the properties.
Test malware scans
Before continuing with further Anti-Malware configuration steps, test real-time and
manual/scheduled scans to ensure they're working correctly.
Test real-time scans:
1. Make sure the real-time scan is enabled and that a configuration is selected.
2. Go to the EICAR site and download their anti-malware test file. This standardized file will
test the real-time scan's anti-virus capabilities. The file should be quarantined.
3. On Deep Security Manager, go to Events & Reports > Anti-Malware Events to verify the
record of the EICAR file detection. If the detection is recorded, the Anti-Malware real-time
scans are working correctly.
Test manual/scheduled scans:
Note: Before you begin, make sure the real-time scan is disabled before testing
manual/scheduled scans.
1. Go to Administration.
2. Click Scheduled tasks > New.
3. Select Scan Computers for Malware from the drop-down menu and select a frequency.
Complete the scan configuration with your desired specifications.
4. Go to the EICAR site and download their anti-malware test file. This standardized file will
test the manual/scheduled scan's anti-virus capabilities.
5. Select the scheduled scan and click Run Task Now. The test file should be quarantined.
6. On Deep Security Manager, go to Events & Reports > Anti-Malware Events to verify the
record of the EICAR file detection. If the detection is recorded, the Anti-Malware
manual/scheduled scans are working correctly.
Scan for specific types of malware
l "Scan for spyware and grayware" on the next page
l "Scan for compressed executable files (real-time scans only)" on the next page
l "Scan process memory (real-time scans only)" on page 561
559
Trend Micro Deep Security On-Premise 20
l "Scan compressed files" on the next page
l "Scan embedded Microsoft Office objects" on the next page
See also:
l "Enhanced anti-malware and ransomware scanning with behavior monitoring" on
page 589
l "Detect emerging threats using Connected Threat Defense" on page 580
Scan for spyware and grayware
When spyware and grayware protection is enabled, the spyware scan engine quarantines
suspicious files when they are detected.
1. Open the properties of the malware scan configuration.
2. On the General tab, select Enable spyware/grayware protection.
3. Click OK.
To identify a specific file that the spyware scan engine should ignore, see "Create anti-malware
exceptions" on page 606.
Scan for compressed executable files (real-time scans only)
Viruses often use real-time compression algorithms to attempt to circumvent virus filtering. The
IntelliTrap feature blocks real-time compressed executable files and pairing them with other
malware characteristics.
Note: Because IntelliTrap identifies such files as security risks and may incorrectly block safe
files, consider quarantining (not deleting or cleaning) files when you enable IntelliTrap. (See
"Configure how to handle malware" on page 568.) If users regularly exchange real-time
compressed executable files, disable IntelliTrap. IntelliTrap uses the virus scan engine,
IntelliTrap Pattern, and IntelliTrap Exception Pattern.
1. Open the properties of the malware scan configuration.
2. On the General tab, select Enable IntelliTrap.
3. Click OK.
560
Trend Micro Deep Security On-Premise 20
Scan process memory (real-time scans only)
Monitor process memory in real time and perform additional checks with the Trend Micro Smart
Protection network to determine whether a suspicious process is known to be malicious. If the
process is malicious, Deep Security terminates the process. For more information, see "Smart
Protection in Deep Security" on page 596
1. Open the properties of the malware scan configuration.
2. On the General tab, select Scan process memory for malware.
3. Click OK.
Scan compressed files
Extract compressed files and scan the contents for malware. When you enable the scan, you
specify the maximum size and number of files to extract (large files can affect performance). You
also specify the levels of compression to inspect so that you can scan compressed files that
reside inside compressed files. Level 1 compression is a single compressed file. Compressed
files inside that file are level two. You can scan a maximum of 6 compression levels, however
higher levels can affect performance.
1. Open the properties of the malware scan configuration.
2. On the Advanced tab, select Scan compressed files.
3. Specify the maximum size of content files to extract, in MB, the levels of compression to
scan, and the maximum number of files to extract.
4. Click OK.
Scan embedded Microsoft Office objects
Certain versions of Microsoft Office use Object Linking and Embedding (OLE) to insert files and
other objects into Office files. These embedded objects can contain malicious code.
Specify the number of OLE layers to scan to detect objects that are embedded in other objects.
To reduce the impact on performance, you can scan only a few layers of embedded objects
within each file.
1. Open the properties of the malware scan configuration.
2. On the Advanced tab, select Scan Embedded Microsoft Office Objects.
3. Specify the number of OLE layers to scan.
4. Click OK.
561
Trend Micro Deep Security On-Premise 20
Specify the files to scan
To specify the files to scan for malware, identify files and directories to include in the scan and
then of those files and directories, identify exclusions. You can also scan network directories:
l "Inclusions" below
l "Exclusions" on the next page
l "Scan a network directory (real-time scan only)" on page 568
Inclusions
Specify the directories to scan as well as the files inside the directories to scan.
To identify directories to scan, you can specify all directories or a list of directories. The directory
list uses patterns with a specific syntax to identify the directories to scan. (See "Syntax for
directory lists" on page 564.)
To identify the files to scan, use one of the following options:
l All files
l File types that are identified by IntelliScan. IntelliScan only scans file types that are
vulnerable to infection, such as .zip or .exe. IntelliScan does not rely on file extensions to
determine file type but instead reads the header and content of a file to determine whether
it should be scanned. Compared to scanning all files, Intelliscan reduces the number of
files to scan and improves performance.
l Files that have a file name extension that is included in a specified list: The file extension
list uses patterns with a specific syntax. (See "Syntax of file extension lists" on page 567.)
1. Open the properties of the malware scan configuration.
2. Click the Inclusions tab.
3. To specify the directories to scan, select All directories or Directory List.
4. If you selected Directory List, from the drop-down menu either select an existing list or
select New to create one.
5. To specify the files to scan, select either All files, File types scanned by IntelliScan, or File
Extension List.
6. If you selected File Extension List, from the drop-down menu either select an existing list or
select New to create one.
7. Click OK.
562
Trend Micro Deep Security On-Premise 20
Exclusions
Exclude specific directories, files, and file extensions from being scanned. For real-time scans
(except when performed by Deep Security Virtual Appliance), you can also exclude specific
process image files from being scanned.
Examples of files and folders to exclude:
l If you are creating a malware scan configuration for a Microsoft Exchange server, you
should exclude the SMEX quarantine folder to avoid re-scanning files that have already
been confirmed to be malware.
l If you choose to run malware scans on database servers used by Deep Security Manager,
exclude the data directory. The Deep Security Manager captures and stores intrusion
prevention data that might include viruses, which can trigger a quarantine by the Deep
Security Agent, leading to database corruption.
l If you have large VMware images, exclude the directory containing these images if you
experience performance issues.
To exclude directories, files, and process image files, you create a list that uses patterns to
identify the item to exclude.
1. Open the properties of the malware scan configuration.
2. Click the Exclusions tab.
3. Specify the directories to exclude:
a. Select Directory List.
b. Select a directory list or select New to create one. (See "Syntax for directory lists" on
the next page.)
c. If you created a directory list, select it in the directory list.
4. Similarly, specify the file list, file extension list, and process image file list to exclude. (See
"Syntax of file lists" on page 565, "Syntax of file extension lists" on page 567, and "Syntax
of process image file lists (real-time scans only):" on page 567.)
5. Click OK.
Test file exclusions
Before continuing with further Anti-Malware configuration steps, test file exclusions to ensure
they're working correctly:
563
Trend Micro Deep Security On-Premise 20
Note: Before you begin, make sure the real-time scan is enabled and a configuration is
selected.
1. Go to Policies > Common Objects > Other > Malware Scan Configurations.
2. Click New > New Real-time Scan Configuration.
3. Go to the Exclusions tab, and select New from the directory list.
4. Name the directory list.
5. Under Directory(s) specify the path of the directory you want to exclude from the scan. For
example, c:\Test Folder\ . Click OK .
6. Go to the General tab, name the manual scan, and click OK.
7. Go to the EICAR site and download their anti-malware test file. Save the file in the folder
specified in the previous step. The file should be saved and undetected by the Anti-
Malware module.
Syntax for directory lists
Note: Directory list items accept either forward slash "/" or backslash "\" to support both
Windows and Linux conventions.
Exclusion Format Description Examples
C:\Program Files\
Excludes all files in the specified
Excludes all files in the
Directory DIRECTORY\ directory and all files in all
"Program Files" directory
subdirectories.
and all subdirectories.
C:\abc\*\
Excludes all files in all
subdirectories of "abc" but
does not exclude the files
in the "abc" directory.
C:\abc\wx*z\
Matches:
Directory Excludes all subdirectories except for C:\abc\wxz\
with DIRECTORY\*\ the specified subdirectory and the files C:\abc\wx123z\
wildcard (*) that it contains. Does not match:
C:\abc\wxz
C:\abc\wx123z
C:\abc\*wx\
Matches:
C:\abc\wx\
C:\abc\123wx\
Does not match:
564
Trend Micro Deep Security On-Premise 20
Exclusion Format Description Examples
C:\abc\wx
C:\abc\123wx
C:\Program
Files\SubDirName*\
Excludes any
subdirectories with a
Excludes any subdirectories with a
Directory folder name that begins
matching name, but does not exclude
with DIRECTORY*\ with “SubDirName”. Does
the files in that directory and any
wildcard (*)
subdirectories. not exclude all files under
C:\Program Files\ or any
other subdirectories.
Excludes all files and subdirectories
defined by an environment variable. For ${windir}
a Virtual Appliance, the value pairs for If the variable resolves to
Environment
${ENV VAR} the environment variable must be "c:\windows", excludes all
variable
defined in Policy or Computer Editor > the files in "c:\windows"
Settings > General > Environment and all its subdirectories.
Variable Overrides.
DIRECTORY Adds a comment to your exclusion c:\abc #Exclude the
Comments
#Comment definitions. abc directory
Syntax of file lists
Exclusion Format Description Example
abc.doc
Excludes all files with the specified
Excludes all files named
File FILE file name regardless of its location or
"abc.doc" in all directories.
directory.
Does not exclude "abc.exe".
C:\Documents\abc.doc
Excludes the specific file specified by Excludes only the file named
File path FILEPATH
the file path. "abc.doc" in the "Documents"
directory.
C:\Documents\abc.co* (For
File path Windows Agent platforms only)
Excludes all the specific files Excludes any file that has file
with FILEPATH
specified by the file path. name of "abc" and extension
wildcard (*)
beginning with ".co" in the
"Documents" directory.
565
Trend Micro Deep Security On-Premise 20
Exclusion Format Description Example
abc*.exe
Excludes any file that has
prefix of "abc" and extension of
".exe".
*.db
Matches:
123.db
abc.db
Does not match:
123db
123.abd
cbc.dba
File with Excludes all files with a matching *db
FILE*
wildcard (*) pattern in the file name. Matches:
123.db
123db
ac.db
acdb
db
Does not match:
db123
wxy*.db
Matches:
wxy.db
wxy123.db
Does not match:
wxydb
abc.v*
Excludes any file that has file
name of "abc" and extension
beginning with ".v".
abc.*pp
Matches:
abc.pp
File with Excludes all files with a matching abc.app
FILE.EXT* Does not match:
wildcard (*) pattern in the file extension.
wxy.app
abc.a*p
Matches:
abc.ap
abc.a123p
Does not match:
abc.pp
566
Trend Micro Deep Security On-Premise 20
Exclusion Format Description Example
abc.*
Matches:
abc.123
abc.xyz
Does not match:
wxy.123
a*c.a*p
Matches:
ac.ap
Excludes all files with a matching
File with a123c.ap
FILE*.EXT* pattern in the file name and in the
wildcard (*) ac.a456p
extension.
a123c.a456p
Does not match:
ad.aa
Excludes files specified by an
environment variable with the format
${ENV VAR}. These can be defined
Environment ${ENV ${myDBFile}
or overridden using Policy or
variable VAR} Excludes the file "myDBFile".
Computer Editor > Settings >
General > Environment Variable
Overrides.
FILEPATH Adds a comment to your exclusion C:\Documents\abc.doc
Comments
#Comment definitions. #This is a comment
Syntax of file extension lists
Exclusion Format Description Example
doc
File Matches all files with a matching
EXT Matches all files with a ".doc" extension
Extension file extension.
in all directories.
EXT Adds a comment to your
Comments doc #This a comment
#Comment exclusion definitions.
Syntax of process image file lists (real-time scans only):
Exclusion Format Description Example
C:\abc\file.exe
Excludes the specific Process Image
File path FILEPATH Excludes only the file named
file specified by the file path.
"file.exe" in the "abc" directory.
567
Trend Micro Deep Security On-Premise 20
Scan a network directory (real-time scan only)
If you want to scan files and folders in network shares and mapped network drives that reside in
a Network File System (NFS), Server Message Block (SMB) or Common Internet File System
(CIFS), select Enable Network Directory Scan. This option is available only for real-time scans.
Note: Resources accessed in "~/.gvfs" via GVFS, a virtual file system available for the
GNOME desktop, will be treated as local resources, not network drives.
Specify when real-time scans occur
Choose between scanning files when they are opened for reading, when they are written to, or
both.
1. Open the properties of the malware scan configuration.
2. On the Advanced tab, select one of the options for the Real-Time Scan property.
3. Click OK.
Configure how to handle malware
Configure how Deep Security behaves when malware is detected:
l "Customize malware remedial actions" below
l "Generate alerts for malware detection" on page 571
l "Apply NSX security tags" on page 571
Customize malware remedial actions
When Deep Security detects malware, it performs a remedial action to handle the file. There are
five possible actions that Deep Security can take when it encounters malware:
l Pass: Allows full access to the infected file without doing anything to the file. (An Anti-
Malware Event is still recorded.)
Note: The remedial action Pass should never be used for a possible virus.
l Clean: Cleans an infected file before allowing full access to it. If the file can't be cleaned, it
is quarantined.
l Delete: On Linux, the infected file is deleted without a backup.
On Windows, the infected file is backed up and then deleted. Windows backup files can be
568
Trend Micro Deep Security On-Premise 20
viewed and restored in Events & Reports > Events > Anti-Malware Events > Identified
Files.
l Deny Access: This scan action can only be performed during Real-time scans. When
Deep Security detects an attempt to open or execute an infected file, it immediately blocks
the operation. The infected file is left unchanged. When the Access Denied action is
triggered, the infected files stay in their original location.
Note: Do not use the remedial action Deny Access when Real-Time Scan is set to
During Write. When During Write is selected, files are scanned when they are written
and the action Deny Access has no effect.
l Quarantine: Moves the infected file to the quarantine directory on the computer or Virtual
Appliance. The quarantined file can be viewed and restored in Events & Reports > Events
> Anti-Malware Events > Identified Files.
Note: Malware marked as Quarantined on Linux might be marked as Deleted on
Windows, despite the malware being identical on both operating systems. In either case,
the file can be viewed and restored in Events & Reports > Events > Anti-Malware
Events > Identified Files.
Note: On Windows, infected non-compressed files (for example, .txt files) are
quarantined, while infected compressed files (for example, .zip files) are deleted. On
Windows, both quarantined or deleted files have a backup that can be viewed and
restored in Events & Reports > Events > Anti-Malware Events > Identified Files.
On Linux, all infected files (compressed or non-compressed) are quarantined, and can be
viewed and restored in Events & Reports > Events > Anti-Malware Events > Identified
Files.
The default remediation actions in the malware scan configurations are appropriate for most
circumstances. However, you can customize the actions to take when Deep Security detects
malware. You can either use the action that ActiveAction determines, or specify the action for
each type of vulnerability.
ActiveAction is a predefined group of cleanup actions that are optimized for each malware
category. Trend Micro continually adjusts the actions in ActiveAction to ensure that individual
detections are handled properly. (See "ActiveAction actions" on the next page.)
1. Open the properties of the malware scan configuration.
2. On the Advanced tab, for Remediation Actions select Custom.
569
Trend Micro Deep Security On-Premise 20
3. Specify the action to take:
a. To let ActiveAction decide which action to take, select Use action recommended by
ActiveAction.
b. To specify an action for each type of vulnerability, select Use custom actions, and then
select the actions to use.
4. Specify the action to take for Possible Malware.
5. Click OK.
ActiveAction actions
The following table lists the actions that ActiveAction takes:
Malware Type Action
Clean. If a virus cannot be cleaned, it is deleted (Windows) or quarantined
(Linux or Solaris). There is an exception to this behavior: On a Linux or
"Virus" on page 552
Solaris agent, if a virus of type 'Test Virus' is found, access is denied to the
infected file.
"Trojans" on
Quarantine
page 552
"Packer" on
Quarantine
page 553
"Spyware/grayware"
Quarantine
on page 553
CVE Exploit Quarantine
Pass
Aggressive
(This setting detects more issues but may also result in more false
Detection Rule
positives, so the default action is to raise an event.)
"Cookie" on Delete
page 554 (Does not apply to real-time scans)
Clean
If a threat cannot be cleaned, it is handled as follows:
l on Windows, the infected file is deleted but can be viewed and
"Other threats" on
page 554 restored, if needed
l on Linux or Solaris, access is denied to the infected file
Also, on a Linux or Solaris agent, if a virus of type 'Joke' is found, it is
quarantined immediately. No attempt is made to clean it.
"Possible malware"
ActiveAction
on page 554
570
Trend Micro Deep Security On-Premise 20
Note: When the agent downloads virus pattern updates from an ActiveUpdate server or relay,
it may change its ActiveAction scan actions.
For information about CVE Exploit and Aggressive Detection Rule, see "Create a malware scan
configuration for use with Connected Threat Defense" on page 585.
Generate alerts for malware detection
When Deep Security detects malware, you can generate an alert.
1. Open the properties of the malware scan configuration.
2. On the General tab, for Alert select Alert when this Malware Scan Configuration logs an
event.
3. Click OK.
Apply NSX security tags
Deep Security can apply NSX Security Tags to protected VMs upon detecting a malware threat.
For details, see "Configure Anti-Malware to apply NSX security tags" on page 376.
Identify malware files by file hash digest
Deep Security can calculate the hash value of a malware file and display it on the Events &
Reports > Events > Anti-Malware Events page. Because a particular piece of malware can go
by several different names, the hash value is useful because it uniquely identifies the malware.
You can use the hash value when looking up information about the malware from other sources.
1. Open the policy or computer editor that you want to configure.
2. Click Anti-Malware > Advanced.
3. Under File Hash Calculation, clear the Default or Inherited check box. (Default is
displayed for a root policy and Inherited is displayed for child policies).
Note: When Inherited is selected, the file hash settings are inherited from the current
policy's parent policy.
Note: When Default is selected, Deep Security does not calculate any hash values.
4. Select the Calculate hash values of all anti-malware events.
5. By default, Deep Security will produce SHA-1 hash values. If you want to produce
additional hash values, you can select one or both of MD5 and SHA256.
571
Trend Micro Deep Security On-Premise 20
6. You can also change the maximum size of malware files that will have hash values
calculated. The default is to skip files that are larger than 128MB, but you can change the
value to anything between 64 and 512 MB.
Configure notifications on the computer
On Windows-based agents, you might occasionally see onscreen notification messages alerting
you of Deep Security actions you must take that are related to the anti-malware and web
reputation modules. For example, you might see the message, A reboot is required for
Anti-Malware cleanup task. You must click OK on the dialog box to dismiss it.
If you don't want these notifications to appear:
1. Go to the Computer or Policy editor 1.
2. Click Settings on the left.
3. Under the General tab, scroll to the Notifications section.
4. Set Suppress all pop-up notifications on host to Yes. The messages still appear as alerts
or events in Deep Security Manager. For more information about the notifier, see "Deep
Security Notifier" on page 1153.
Performance tips for anti-malware
To improve system resources utilization on Deep Security Agent, you can optimize these
performance-related settings according to best practices.
See also:
l "Create anti-malware exceptions" on page 606
l "Identify malware files by file hash digest" on the previous page
l "Configure NSX security tags" on page 376
Minimize disk usage
Reserve an appropriate amount of disk space for storing identified malware files. The space that
you reserve applies globally to all computers: physical machines, virtual machines, and Deep
Security Virtual Appliances. The setting can be overridden at the policy level and at the
computer level.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
572
Trend Micro Deep Security On-Premise 20
Tip: Alerts are raised when there is not enough disk space to store an identified file.
1. Open the policy or computer editor that you want to configure.
2. Click Anti-Malware > Advanced.
3. Under Identified Files, clear Default.
4. Specify the disk space to use in the Maximum disk space used to store identified files
box.
5. Click Save.
If you are using a Deep Security Virtual Appliance to protect virtual machines, all identified files
from the protected VMs will be stored on the virtual appliance. As a result, you should increase
the amount of disk space for identified files on the virtual appliance.
See also "Virtual Appliance Scan Caching" on page 763
Optimize CPU usage
l Exclude files from real-time scans if they are normally safe but have high I/O, such as
databases, Microsoft Exchange quarantines, and network shares (on Windows, you can
use procmon to find files with high I/O). See "Exclusions" on page 563.
l Do not scan network directories. See "Scan a network directory (real-time scan only)" on
page 568
l Do not use Smart Scan if the computer doesn't have reliable network connectivity to the
Trend Micro Smart Protection Network or your Smart Protection Server. See "Smart
Protection in Deep Security" on page 596.
l Reduce the CPU impact of malware scans by setting CPU Usage to Medium
(Recommended; pauses between scanning files) or Low (pauses between scanning files
for a longer interval than the medium setting).
a. Open the properties of the malware scan configuration.
b. On the Advanced tab, select the CPU Usage during which scans run.
c. Click OK.
l Create a scheduled task to run scans at a time when CPU resources are more readily
available. See "Schedule Deep Security to perform tasks" on page 1378.
l In VM Scan Cache, select a Real-Time Scan Cache Configuration. If scans are not
frequent, increase the Expiry Time (avoid repeated scans). See "Virtual Appliance Scan
Caching" on page 763.
573
Trend Micro Deep Security On-Premise 20
l Use agentless deployments so that CPU usage is in one centralized virtual appliance, not
on every computer. See "Choose agentless vs. combined mode protection" on page 302
l Reduce or keep small default values for the maximum file size to scan, maximum levels of
compression from which to extract files, maximum size of individual extracted files,
maximum number of files to extract, and OLE Layers to scan. See "Scan for specific types
of malware" on page 559.
Warning: Most malware is small, and nested compression indicates malware. But if you
don't scan large files, there is a small risk that anti-malware won't detect some malware.
You can mitigate this risk with other features such as integrity monitoring. See
l Use multi-threaded processing for manual and scheduled scans (real-time scans use
multi-threaded processing by default). Multi-threaded processing is effective only on
systems that support this capability. To apply the setting, after you have enabled it, restart
the computer.
Note: Do not enable multi-threaded processing under the following circumstances:
l Resources are limited (for example, CPU-bound tasks)
l Resources should be held by only one operator at a time (for example, IO-bound
tasks)
a. Click Policies.
b. Double-click to open the policy where you want to enable multi-threaded processing.
c. Click Anti-Malware > Advanced.
d. In the Resource Allocation for Malware Scans section, select Yes.
e. Restart the computers on which you enabled multi-threaded processing for the setting
to take effect.
Note: Multi-threaded processing may reduce the number of CPU cores available at a
given time to the computer's other processes.
Optimize RAM usage
l Reduce or keep small default values for the maximum file size to scan, maximum levels of
compression from which to extract files, maximum size of individual extracted files,
maximum number of files to extract, and OLE Layers to scan. See "Scan for specific types
of malware" on page 559.
574
Trend Micro Deep Security On-Premise 20
Warning: Most malware is small, and nested compression indicates malware. But if you
don't scan large files, there is a small risk that anti-malware won't detect some malware.
You can mitigate this risk with other features such as integrity monitoring. See "Set up
Integrity Monitoring" on page 705
l Use agentless deployments (RAM usage is in one centralized virtual appliance, not every
computer). See "Choose agentless vs. combined mode protection" on page 302.
Disable Windows Defender after installing Deep Security anti-malware on
Windows Server 2016
When you install the Anti-Malware module for a Deep Security 10.0 Agent on Windows Server
2016, the agent will automatically disable Windows Defender, but not all of the Windows
processes related to the Windows Defender service. To do so, you need to reboot Windows
Server 2016 after the Deep Security Anti-Malware module installation finishes. The Deep
Security Agent will open a Windows message to let you know when to reboot.
Note: The agent will report a computer warning event ("Computer reboot is required for Anti-
Malware protection") to the Deep Security Manager. This event will remain indefinitely, and will
need to be manually dismissed by an administrator.
Installing the Anti-Malware module when Windows Defender is already disabled
If you disable Windows Defender before installing the Deep Security Anti-Malware module, the
Deep Security Agent will not open a Windows reboot message. However, you still need to
reboot Windows Server 2016 to ensure that Deep Security Anti-malware functions correctly.
Virtual Appliance Scan Caching
Scan Caching is used by the Virtual Appliance to maximize the efficiency of Anti-Malware and
Integrity Monitoring Scans of virtual machines. Scan Caching improves the efficiency of scans by
eliminating the unnecessary scanning of identical content across multiple VMs in large VMware
deployments. A Scan Cache contains lists of files and other scan targets that have been
scanned by a Deep Security protection module. If a scan target on a virtual machine is
determined to be identical to a target that has already been scanned, the Virtual Appliance will
not scan the target a second time. Attributes used to determine whether entities are identical are
creation time, modification time, file size, and file name. In the case of Real-time Scan Caching,
Deep Security will read partial content of files to determine if two files are identical. There is an
575
Trend Micro Deep Security On-Premise 20
option setting to use a file's Update Sequence Number (USN, Windows only) but its use should
be limited to cloned virtual machines.
Scan Caching benefits Integrity Monitoring by sharing Integrity Monitoring scan results among
cloned or similar virtual machines.
Scan Caching benefits Manual Malware Scans of cloned or similar virtual machines by
increasing the speed up subsequent scans.
Scan Caching benefits Real-Time Malware Scanning by speeding up boot process scans and
application access scans on cloned or similar virtual machines.
Scan Cache Configurations
A Scan Cache Configuration is a collection of settings that determines Expiry Time, the use of
Update Sequence Numbers (USNs), files to exclude, and files to include.
Note: Virtual machines that use the same Scan Cache Configuration also share the same
Scan Cache.
You can see the list of existing Scan Cache Configurations by going Administration > System
Settings > Advanced>Scan Cache Configurations and clicking View Scan Cache
Configurations . Deep Security comes with several preconfigured default Scan Cache
Configurations. These are implemented automatically by the Virtual Appliance depending the
properties of the virtual machines being protected and the types of scan being performed.
Expiry Time determines the lifetime of individual entries in a Scan Cache. The default
recommended settings are one day for Manual (on-demand) or Scheduled Malware Scans, 15
mins for Real-Time Malware Scans, and one day for Integrity Monitoring Scans.
Use USN (Windows only) specifies whether to make use of Windows NTFS Update Sequence
Numbers, which is a 64-bit number used to record changes to an individual file. This option
should only be set for cloned VMs.
Files Included and Files Excluded are regular expression patterns and lists of files to be
included in or excluded from the Scan Cache. Files to be scanned are matched against the
include list first.
Individual files and folders can be identified by name or you can use wildcards ("*" and "?") to
refer to multiple files and locations with a single expression. (Use "*" to represent any zero or
more characters, and use question mark "?" to represent any single character.)
576
Trend Micro Deep Security On-Premise 20
Note: The include and exclude lists only determine whether the scan of the file will take
advantage of Scan Caching. The lists will not prevent a file from being scanned in the
traditional way.
Malware Scan Cache Configuration
To select which Scan Cache Configuration is used by a virtual machine, open the Computer or
Policy editor 1 and go to Anti-Malware > Advanced > VM Scan Cache. You can select which
Scan Cache Configuration is used for Real-Time Malware Scans and which Scan Cache
Configuration is used for manual and scheduled scans.
Integrity Monitoring Scan Cache Configuration
To select which Scan Cache Configuration is used by a virtual machine, open the Computer or
Policy editor 2 and go to Integrity Monitoring > Advanced > VM Scan Cache.
Scan Cache Settings
Scan Cache Settings are not included in a Scan Cache Configuration because they determine
how the Virtual Appliance manages Scan Caches rather than how Scan Caching is carried out.
Scan Cache settings are controlled at the Policy level. You can find the Scan cache settings by
opening a Policy editor 3 and going to the Settings > General > Virtual Appliance Scans area.
Max Concurrent Scans determines the number of scans that the Virtual Appliance performs at
the same time. The recommended number is five. If you increase this number beyond 10, scan
performance may degrade. Scan requests are queued by the virtual appliance and carried out in
the order in which they arrive. This setting applies to manual and scheduled scans.
Max On-Demand Malware Scan Cache Entries determines, for manual or scheduled malware
scans, the maximum number of records that identify and describe a file or other type of
scannable content to keep. One million entries use approximately 100 MB of memory.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
3To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
577
Trend Micro Deep Security On-Premise 20
Max Malware Real-Time Scan Cache Entries determines, for real-time malware scans, the
maximum number of records that identify and describe a file or other type of scannable content to
keep. One million entries use approximately 100MB of memory.
Max Integrity Monitoring Scan Cache Entries determines the maximum number of entities
included in the baseline data for integrity monitoring. Two hundred thousand entities use
approximately 100MB of memory.
When to change the default configuration
Scan caching is designed to avoid scanning identical files twice. Deep Security does not
examine the entire contents of all files to determine if files are identical. Although when
configured to do so, Deep Security can check the USN value of a file, and during Real-time
Scans it will read partial content of files, it generally examines file attributes to determine if files
are identical. It would be difficult but not impossible for some malware to make changes to a file
and then restore those files attributes to what they were before the file was modified.
Deep Security limits this potential vulnerability by establishing short default cache expiry times.
To strengthen the security you can use shorter expiry times on cache and you can use USN but
doing so may reduce the performance benefit or require a larger cache setting. For the strongest
security for VMs that you want to keep separate and never share scan results you can create
dedicated policies for these VMs kind of like keeping them in separate zones. This might be
appropriate if you have different departments or organizations sharing the same infrastructure.
(In a multi-tenant Deep Security Manager, this is automatically enforced for each tenant.)
If you have a very large number of guest VMs per ESXi host (for example, a VDI environment),
then you should monitor your disk I/O and CPU usage during scanning. If scanning takes too
long, then you may need to increase the size of the cache or adjust the Scan Cache Settings
until you get better performance. If you need to increase cache size, then you may need to adjust
Deep Security Virtual Appliance system memory too.
Detect emerging threats using Predictive Machine Learning
Use Predictive Machine Learning to detect unknown or low-prevalence malware. (For more
information, see "Predictive Machine Learning" on page 551.)
Predictive Machine Learning uses the Advanced Threat Scan Engine (ATSE) to extract file
features and sends the report to the Predictive Machine Learning engine on the Trend Micro
Smart Protection Network. To enable Predictive Machine Learning, perform the following:
578
Trend Micro Deep Security On-Premise 20
1. "Ensure Internet connectivity" below
2. "Enable Predictive Machine Learning" below
As with all detected malware, Predictive Machine Learning logs an event when it detects
malware. (See "About Deep Security event logging" on page 825.) You can also create an
exception for any false positives. (See "Create anti-malware exceptions" on page 606.)
Ensure Internet connectivity
Predictive Machine Learning requires access to the Global Census Service, Good File
Reputation Service, and Predictive Machine Learning Service. These services are hosted in the
Trend Micro Smart Protection Network. If your Deep Security Agents or Virtual Appliance cannot
access the Internet directly, see "Configure agents that have no internet access" on page 1131
for workarounds.
Enable Predictive Machine Learning
Predictive Machine Learning is configured as part of a real-time scan configuration that is
applied to a policy or individual computer. (See "Configure malware scans" on page 557.) After
you configure the scan configuration, apply it to a policy or computer.
Note: Predictive Machine Learning protects only the files and directories that real-time scan is
configured to scan. See "Specify the files to scan" on page 562.
These settings can only be applied to the real-time scan configuration for Windows computers.
1. Go to Policies > Common Objects > Other > Malware Scan Configurations.
2. Select the real-time scan configuration to configure and click Details.
You can also create a new real-time scan configuration if desired.
3. On the General tab, under Predictive Machine Learning, select Enable Predictive
Machine Learning.
4. Click OK.
5. Open the policy or computer editor to which you want to apply the scan configuration and
go to Anti-Malware > General.
6. Ensure that Anti-Malware State is On or Inherited (On).
7. In the Real-Time Scan section, select the malware scan configuration.
8. Click Save.
579
Trend Micro Deep Security On-Premise 20
Detect emerging threats using Connected Threat Defense
In the modern data center, more and more security breaches are a result of targeted attacks
using techniques such as phishing and spear-phishing. In these cases, malware writers can
bypass traditional malware scanners by creating malware specifically targeted for your
environment. Deep Security provides enhanced malware protection for new and emerging
threats through its Connected Threat Defense feature.
Note: Connected Threat Defense is not available when FIPS mode is enabled. See "FIPS
140-2 support" on page 1417.
In this article:
l "How does Connected Threat Defense work?" below
l "Check the Connected Threat Defense prerequisites" on the next page
l "Set up the connection to Deep Discovery Analyzer" on the next page
l "Set up the connection to Trend Micro Apex Central" on page 583
l "Create a malware scan configuration for use with Connected Threat Defense" on
page 585
l "Enable Connected Threat Defense for your computers" on page 586
l "Manually submit a file to Deep Discovery for analysis" on page 586
l "Allow a file that has raised a false alarm" on page 586
l "Configure the scan action for a suspicious file" on page 587
l "Update the suspicious objects list in Deep Security" on page 587
l "Configure Connected Threat Defense in a multi-tenant environment" on page 588
l "Supported file types" on page 588
For an overview of the Anti-Malware module, see "About Anti-Malware" on page 547.
How does Connected Threat Defense work?
1. When all of the components are configured properly, the Deep Security Agent uses
heuristic detection to analyze files on the protected computer and determines whether they
are suspicious.
2. Optionally, you can manually or automatically send suspicious files from Deep Security to
Deep Discovery Analyzer, which executes and observes the suspicious file in a sandbox
(a secure, isolated virtual environment).
580
Trend Micro Deep Security On-Premise 20
3. Deep Security Manager gets the sandbox analysis results from Deep Discovery Analyzer.
Note: The sandbox analysis report doesn’t provide protection; it simply provides
information on the Deep Discovery analysis. For complete protection, this feature
requires a connection to the Trend Micro Apex Central. The report is retrieved from Deep
Discovery Analyzer every 15 minutes.
4. Deep Discovery Analyzer pushes the analysis results to Trend Micro Apex Central, where
an action can be specified for the file based on the analysis. Once the action is specified, a
list of emerging threats called a suspicious object list is created or updated. Other Trend
Micro products, such as Deep Discovery Inspector or Deep Discovery Email Inspector,
may also be connected to Trend Micro Apex Central and able to update the list.
5. Optionally, you can configure Deep Security Manager to receive the list of suspicious
objects from Trend Micro Apex Central and send the list of suspicious objects to Deep
Security Agents.
Check the Connected Threat Defense prerequisites
Before connecting Deep Security to Deep Discovery, check that your environment meets these
requirements:
l Deep Security Manager is installed and configured with Deep Security Agents, Deep
Security Agents protecting computers, or both.
Optional:
l Deep Discovery Analyzer 5.5 is installed and the sandbox virtual machines are
provisioned.
l Trend Micro Apex Central 2019 or later is installed.
l Deep Discovery Analyzer has been added to the Trend Micro Apex Central Managed
Servers. See the Trend Micro Apex Central documentation for details.
Note: To use Connected Threat Defense with the Deep Security Virtual Appliance, you must
be using VMware NSX 6.x.
Set up the connection to Deep Discovery Analyzer
If you want Deep Security Manager to send suspicious files to Deep Discovery Analyzer for
analysis, you'll need to set up a connection.
If Trend Micro Apex Central is already managing Deep Security:
581
Trend Micro Deep Security On-Premise 20
1. In Deep Security Manager, go to Administration > System Settings > Connected Threat
Defense.
2. Select Enable submission of suspicious file to Deep Discovery Analyzer.
3. If you want Deep Security Manager to automatically submit files to Deep Discovery
Analyzer, select Enable automatic file submission.
Note: Automatic Submission to Deep Discovery Analyzer occurs every 15 minutes and
will submit a maximum of 100 files per submission
4. Select Use Deep Discovery Analyzer associated with the Apex Central that Deep
Security is registered with.
5. Click Test Connection. If you get an error saying that Deep Security is unable to connect
due to a missing or invalid certificate, click Add/Update Certificate to update to the correct
Deep Discovery Analyzer certificate.
6. Click Save.
If Trend Micro Apex Central is not yet managing Deep Security:
1. In Deep Discovery Analyzer, go to Help > About and note the Service URL and API key.
You will need these values later, so copy them into a text file temporarily.
2. In Deep Security Manager, go to Administration > System Settings > Connected Threat
Defense.
582
Trend Micro Deep Security On-Premise 20
3. Select Enable submission of suspicious file to Deep Discovery Analyzer.
4. If you want Deep Security Manager to automatically submit files to Deep Discovery
Analyzer, select Enable automatic file submission.
Note: Automatic Submission to Deep Discovery Analyzer occurs every 15 minutes and
will submit a maximum of 100 files per submission
5. Select Manually select a Deep Discovery Analyzer server, and enter the Server URL and
API key that you found in step 1.
6. Click Test Connection. If you get an error saying that Deep Security is unable to connect
due to a missing or invalid certificate, click Add/Update Certificate to update to the correct
Deep Discovery Analyzer certificate.
7. Click Save.
Set up the connection to Trend Micro Apex Central
When you configure these settings, Deep Security Manager will be able to retrieve the
suspected object list from Trend Micro Apex Central, share it with protected computers, and
compare local objects against the Apex Central Suspicious Object List.
Set up the connection if Trend Micro Apex Central is already managing Deep Security
1. In Deep Security Manager, go to Administration > System Settings > Connected Threat
Defense.
583
Trend Micro Deep Security On-Premise 20
2. Select Compare objects against Suspicious Object List.
3. Select Use the Apex Central that Deep Security is registered with. If this option is not
available, it is because Apex Central is not yet managing Deep Security, and you must
follow the instructions under "Set up the connection if Trend Micro Apex Central is not yet
managing Deep Security" below instead.
4. Click Test Connection. If you get an error saying that Deep Security is unable to connect
due to a missing or invalid certificate, click Add/Update Certificate to update to the correct
Trend Micro Apex Central certificate.
5. Click Save.
Set up the connection if Trend Micro Apex Central is not yet managing Deep Security
1. In Trend Micro Apex Central, go to Administration > Managed Servers > Server
Registration.
584
Trend Micro Deep Security On-Premise 20
2. Select Deep Security from the Server Type drop-down menu.
3. Click Add to register Deep Security to the Apex Central server.
Note: Apex Central will automatically transfer the Service URL and API key needed to
register Deep Security within 10 minutes of adding it as a managed product.
Create a malware scan configuration for use with Connected Threat Defense
The following configuration allows Deep Security to detect suspicious files, back up the
suspicious files, and automatically send them to Deep Discovery Analyzer for further analysis.
1. In Deep Security Manager, go to Policies > Common Objects > Other > Malware Scan
Configurations.
2. Create a new scan configuration or edit an existing configuration.
3. On the General tab, under Document Exploit Protection, select Scan documents for
exploits and select one of these options:
l Scan for exploits against known critical vulnerabilities only: Only detects known
critical vulnerabilities. The CVE Exploit vulnerability type is associated with this option
(See "Customize malware remedial actions" on page 568.)
l Scan for exploits against known critical vulnerabilities and aggressive detection of
unknown suspicious exploits: Detects more issues but may also result in more false
positives. If you want to detect suspicious files and submit them to Deep Discovery
Analyzer, you must select this option. The Aggressive Detection Rule vulnerability
type is associated with this option. (See "Customize malware remedial actions" on
page 568.)
4. Configure the other malware scan settings as described in "Configure malware scans" on
page 557.
585
Trend Micro Deep Security On-Premise 20
Enable Connected Threat Defense for your computers
You can enable Connected Threat Defense in policies or for individual computers.
1. In the Computer or Policy editor 1, go to Anti-Malware > General.
2. Ensure that the Anti-Malware State is On or Inherited (On).
3. The General tab contains sections for Real-Time Scan, Manual Scan, and Scheduled
Scan. (For information on the different types of scans, see "Enable and configure anti-
malware" on page 554.) In the appropriate sections, use the Malware Scan Configuration
list to select the scan configuration that you created above.
4. Go to the Connected Threat Defense tab and adjust these settings as required:
l If you want Deep Security to send suspicious files to Deep Discovery Analyzer, set
the option under Sandbox Analysis to Yes or Inherited (Yes).
l If you have set up a connection between Deep Security and Trend Micro Apex
Central and you want to use the suspicious object list from Apex Central to detect
malicious files, set Use Apex Central’s Suspicious Object List (under Suspicious
Objects List) to Yes or Inherited (Yes).
5. Click Save.
Manually submit a file to Deep Discovery for analysis
You can manually submit files that appear on the Events & Reports > Events > Anti-Malware
Events > Identified Files page.
1. Select the file that you want to submit and click the Analyze button.
2. Follow the steps in the wizard that appears.
3. After the file is submitted, you can check the progress of its analysis in the Submission
Status column on the Identified Files page.
4. When the analysis is finished, the Submission Status column will display "Results
Ready". You can click the Results Ready link to see details.
Allow a file that has raised a false alarm
If a file is identified as malware on the Events & Reports > Events > Anti-Malware Events >
Identified Files page but you know it's not malware, you can add it to the Document Exploit
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
586
Trend Micro Deep Security On-Premise 20
Protection Rule Exceptions list on the Anti-Malware > Advanced tab of the Computer or Policy
editor 1.
To allow the file, right-click it, click Allow, and follow the steps in the wizard that appears.
Configure the scan action for a suspicious file
You can view the suspicious objects list in the Trend Micro Apex Central console and configure
the action (log, block, or quarantine) that should be taken when a suspicious object is found.
(See Suspicious Object List Management for details on configuring the actions.) If you have
configured Deep Security Manager to obtain the suspicious object list from Apex Central, Deep
Security will perform the specified action when it finds the suspected object.
Note: Deep Security supports file suspicious objects. It also supports URL suspicious objects
if the Web Reputation protection module is configured to use the Trend Micro Smart Protection
Server. Deep Security does not support IP and domain suspicious objects.
Update the suspicious objects list in Deep Security
After the analysis of a suspicious object has been completed and the action for the file has been
set in Trend Micro Apex Central, Deep Security can use the Suspicious Object list from Apex
Central to protect your computers. To manually update the suspicious file list in Deep Security
Manager, go to Administration > Updates > Security and use the controls in the Suspicious
Object List Updates column to get the latest list and send it to your protected computers. You can
also create a scheduled task that regularly checks for an updated list (see "Schedule Deep
Security to perform tasks" on page 1378).
Note: In Trend Micro Apex Central, the default suspicious object setting is "Log". You may
want to consider changing the default setting to "Quarantine" or "Block".
Once the suspicious object list has been updated in Deep Security and the computer policies
have been updated with the action specified, the Deep Security Agent will then check the
affected computers and use this action any time this file is encountered again on a protected
computer.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
587
Trend Micro Deep Security On-Premise 20
Configure Connected Threat Defense in a multi-tenant environment
In a multi-tenant environment, the primary tenant (t0) can choose whether to share their Deep
Discovery Analyzer and Trend Micro Apex Central settings with their tenants. The setting that
controls this behavior is Administration > System Settings > Tenants > Allow Tenants to use
Primary Tenant's Trend Micro Apex Central and Deep Discovery Analyzer Server settings:
l When the setting is enabled and a tenant goes to Administration > System Settings >
Connected Threat Defense, they see an additional Use default server settings check box.
When this check box is selected, the tenant uses the primary tenant's settings. When Use
default server settings is not selected, the tenant can configure their own Connected
Threat Defense settings.
l When the setting is not enabled, tenants must use their own Trend Micro Apex Central and
Deep Discovery Analyzer if they want to use Connected Threat Defense.
Supported file types
Deep Security can send these file types to Deep Discovery Analyzer:
l doc - Microsoft Word document
l docx - Microsoft Office Word 2007 document
l gul - JungUm Global document
l hwp - Hancom Hangul Word Processor (HWP) document
l hwpx - Hancom Hangul Word Processor 2014 (HWPX) document
l jar - Java Applet Java application
l js - JavaScript file
l jse - JavaScript encoded script file
l jtd - JustSystems Ichitaro document
l lnk - Microsoft Windows Shell Binary Link shortcut
l mov - Apple QuickTime media
l pdf - Adobe Portable Document Format (PDF)
l ppt - Microsoft Powerpoint presentation
l pptx - Microsoft Office PowerPoint 2007 Presentation
l ps1 - Microsoft Windows PowerShell script file
l rtf - Microsoft Rich Text Format (RTF) document
588
Trend Micro Deep Security On-Premise 20
l swf - Adobe Shockwave Flash file
l vbe - Visual Basic encoded script file
l vbs - Visual Basic script file
l xls - Microsoft Excel spreadsheet
l xlsx - Microsoft Office Excel 2007 Spreadsheet
l xml - Microsoft Office 2003 XML file
Enhanced anti-malware and ransomware scanning with behavior
monitoring
Deep Security provides security settings that you can apply to Windows machines that are
protected by a Deep Security Agent to enhance your malware and ransomware detection and
clean rate. These settings enable you to go beyond malware pattern matching and identify
suspicious files that could potentially contain emerging malware that hasn’t yet been added to
the anti-malware patterns (known as a zero-day attack).
In this article:
l "How does enhanced scanning protect you?" below
l "How to enable enhanced scanning" on the next page
l "What happens when enhanced scanning finds a problem?" on page 591
l "What if my agents can't connect to the Internet directly?" on page 596
For an overview of the anti-malware module, see "About Anti-Malware" on page 547.
How does enhanced scanning protect you?
Threat detection: To avoid detection, some types of malware attempt to modify system files or
files related to known installed software. These types of changes often go unnoticed because
the malware takes the place of legitimate files. Deep Security can monitor system files and
installed software for unauthorized changes to detect and prevent these changes from occurring.
Anti-exploit: Malware writers can use malicious code to hook in to user mode processes in order
to gain privileged access to trusted processes and to hide the malicious activity. Malware writers
inject code into user processes through DLL injection, which calls an API with escalated
privilege. They can also trigger an attack on a software exploit by feeding a malicious payload to
trigger code execution in memory. In Deep Security, the anti-exploit functionality monitors for
processes that may be performing actions that are not typically performed by a given process.
589
Trend Micro Deep Security On-Premise 20
Using a number of mechanisms, including Data Execution Prevention (DEP), Structured
Exception Handling Overwrite Protection (SEHOP), and heap spray prevention, Deep Security
can determine whether a process has been compromised and then terminate the process to
prevent further infection.
Extended ransomware protection: Recently, ransomware has become more sophisticated and
targeted. Most organizations have a security policy that includes anti-malware protection on their
endpoints, which offers a level of protection against known ransomware variants; however, it
may not be sufficient to detect and prevent an outbreak for new variants. The ransomware
protection offered by Deep Security can protect documents against unauthorized encryption or
modification. Deep Security has also incorporated a data recovery engine that can optionally
create copies of files being encrypted to offer users an added chance of recovering files that may
have been encrypted by a ransomware process.
How to enable enhanced scanning
Enhanced scanning is configured as part of the anti-malware settings that are applied to a policy
or individual computer. For general information on configuring anti-malware protection, see
"Enable and configure anti-malware" on page 554.
Note: These settings can only be applied to Windows machines that are protected by a Deep
Security Agent.
Warning: Enhanced scanning may have a performance impact on agent computers running
applications with heavy loads. We recommend reviewing the "Performance tips for anti-
malware" on page 572 before deploying Deep Security Agents with enhanced scanning
enabled.
The first step is to enable enhanced scanning in a real-time malware scan configuration:
1. In Deep Security Manager, go to Policies > Common Objects > Other > Malware Scan
Configurations.
2. Double-click an existing real-time scan configuration to edit it (for details on malware scan
configurations, see "Configure malware scans" on page 557).
3. On the General tab, select these options:
l Detect suspicious activity and unauthorized changes (incl. ransomware): Enables
the threat detection, anti-exploit, and ransomware detection features that are described
above.
590
Trend Micro Deep Security On-Premise 20
l Back up and restore ransomware-encrypted files: When this option is selected, Deep
Security will create backup copies of files that are being encrypted, in case they are
being encrypted by a ransomware process.
4. Click OK.
Note: By default, real-time scans are set to scan all directories. If you change the scan settings
to scan a directory list, the enhanced scanning may not work as expected. For example, if you
set Directories to scan to scan "Folder1" and ransomware occurs in Folder1, it may not be
detected if the encryption associated with the ransomware happens to files outside of Folder1.
Next, apply the malware scan configuration to a policy or an individual computer:
1. In the Computer or Policy editor 1, go to Anti-Malware > General.
2. Ensure that the Anti-Malware State is On or Inherited (On).
3. The General tab contains sections for Real-Time Scan, Manual Scan, and Scheduled
Scan. In the appropriate sections, use the Malware Scan Configuration list to select the
scan configuration that you created above.
4. Click Save.
What happens when enhanced scanning finds a problem?
When Deep Security discovers activity or files that match the enhanced scan settings you have
enabled, it will log an event (go to Events & Reports > Events > Anti-Malware Events to see a
list of events). The event will be identified as "Suspicious activity" or "Unauthorized change" in
the Major Virus Type column and details will be displayed in the Target(s) and TargetType
columns.
Deep Security performs many types of checks related to the enhanced scan settings, and the
actions that it takes depend on the type of check that finds an issue. Deep Security may "Deny
Access", "Terminate", or "Clean" a suspicious object. These actions are determined by Deep
Security and are not configurable, with the exception of the "Clean" action:
l Deny Access: When Deep Security detects an attempt to open or execute a suspicious file,
it immediately blocks the operation and records an anti-malware event.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
591
Trend Micro Deep Security On-Premise 20
l Terminate: Deep Security terminates the process that performed the suspicious operation
and records an anti-malware event.
l Clean: Deep Security checks the Malware Scan Configuration and performs the action
specified for Trojans on the Actions tab. One or more additional events will be generated
relating to the action performed on the Trojan files.
Double-click an event to see details:
592
Trend Micro Deep Security On-Premise 20
Events related to ransomware have an additional Targeted Files tab:
593
Trend Micro Deep Security On-Premise 20
594
Trend Micro Deep Security On-Premise 20
If you investigate and find that an identified file is not harmful, you can right-click the event and
click Allow to add the file to a scan exclusion list for the computer or policy. You can check the
scan exclusion list in the policy or computer editor, under Anti-Malware > Advanced > Behavior
Monitoring Protection Exceptions.
595
Trend Micro Deep Security On-Premise 20
What if my agents can't connect to the Internet directly?
The enhanced scanning features described in this article require Internet access to check files
against the Global Census Server and Good File Reputation Service. If your Deep Security
Agents cannot access the Internet directly, see "Configure agents that have no internet access"
on page 1131 for workarounds.
Smart Protection in Deep Security
Smart Protection Network integration is available for your computers and workloads through
anti-malware and web reputation modules. Smart Feedback, which is set at the system level,
allows you to provide continuous feedback to the Smart Protection Network.
For more about Trend Micro's Smart Protection Network, see Smart Protection Network.
In this topic:
l "Anti-malware and Smart Protection" below
l "Web Reputation and Smart Protection" on page 598
l "Smart Feedback" on page 599
See also "Integrate with Smart Protection Server" on page 1501 for AWS deployment
instructions, and the Smart Protection Server documentation for instructions on manually
deploying the server.
Anti-malware and Smart Protection
l "Enable Smart Scan" below
l "Smart Protection Server for File Reputation Service" on the next page
Enable Smart Scan
Smart Scan is available in the anti-malware module. It leverages Trend Micro's Smart Protection
Network to allow local pattern files to be small and reduces the size and number of updates
required by agents and Appliances. When Smart Scan is enabled, the agent downloads a small
version of the much larger full malware pattern from a Smart Protection Server. This smaller
pattern can quickly identify files as either "confirmed safe", or "possibly dangerous". "Possibly
dangerous" files are compared against the larger complete pattern files stored on Trend Micro
Smart Protection Servers to determine with certainty whether they pose a danger or not.
596
Trend Micro Deep Security On-Premise 20
Without Smart Scan enabled, your relay agents must download the full malware pattern from a
Smart Protection Server to be used locally on the agent. The pattern will only be updated as
scheduled security updates are processed. The pattern is typically updated once per day for
your agents to download and is around 120 MB.
Note: Verify that the computer can reliably connect to the global Trend Micro Smart Protection
Network URLs (see "Port numbers, URLs, and IP addresses" on page 178 for a list of URLs). If
connectivity is blocked by a firewall, proxy, or AWS security group or if the connection is
unreliable, it will reduce anti-malware performance.
1. Go to Policies.
2. Double-click a policy.
3. Go to Anti-Malware > Smart Protection.
4. In the Smart Scan section, either:
l select Inherited (if the parent policy has Smart Scan enabled)
l deselect Inherited, and then select either On or On for Deep Security Agent, Off for
Virtual Appliance.
5. Click Save.
Note: A computer that is configured to use Smart Scan will not download full anti-malware
patterns locally. Therefore if your anti-malware license expires while a computer is configured
to use Smart Scan, switching Smart Scan off will not result in local patterns being used to scan
for malware since no anti-malware patterns will be present locally.
Smart Protection Server for File Reputation Service
Smart Protection Server for File Reputation Service is available in the anti-malware module. It
supplies file reputation information required by Smart Scan.
To edit Smart Protection Server for File Reputation Service:
1. Go to Computers or Policies > Anti-Malware > Smart Protection.
2. You can select to connect directly to Trend Micro's Smart Protection Server or to connect to
one or more locally installed Smart Protection Servers.
3. If you want to use a proxy for communication between agents and the Smart Protection
Network, we recommend that you create a proxy server specifically for the Smart
Protection Network. You can view and edit the list of available proxies on the Proxies tab
on the Administration > System Settings page. For information on proxy protocols, see
597
Trend Micro Deep Security On-Premise 20
"Supported proxy protocols" on page 1081.
Note: After you select a proxy, you will need to restart any agents that will be using it.
4. Select the When off domain, connect to global Smart Protection Service (Windows only)
option to use the global Smart Protection Service if the computer is off domain. The
computer is considered to be off domain if it cannot connect to its domain controller. (This
option is for Windows agents only.)
Note: If you have a locally installed Smart Protection Server, this option should be set to
Yes on at least one computer so that you are notified if there is a problem with the Smart
Protection Server itself.
5. Set the Smart Protection Server Connection Warning to generate error events and alerts
when a computer loses its connection to the Smart Protection Server.
Web Reputation and Smart Protection
Smart Protection Server for Web Reputation supplies web reputation information required by the
web reputation module.
To edit Smart Protection Server for Web Reputation Service:
1. Go to Computers or Policies > Web Reputation > Smart Protection.
2. You can select to connect directly to Trend Micro's Smart Protection Server or to connect to
one or more locally installed Smart Protection Servers.
3. If you want to use a proxy for communication between agents and the Smart Protection
Network, we recommend that you create a proxy server specifically for the Smart
Protection Network. You can view and edit the list of available proxies on the Proxies tab
on the Administration > System Settings page. For information on proxy protocols, see
"Supported proxy protocols" on page 1081.
Note: After you select a proxy, you will need to restart any agents that will be using it.
4. Select the When off domain, connect to global Smart Protection Service (Windows only)
option to use the global Smart Protection Service if the computer is off domain. The
computer is considered to be off domain if it cannot connect to its domain controller. (This
option is for Windows agents only.)
Note: If you have a locally installed Smart Protection Server, this option should be set to
Yes on at least one computer so that you are notified if there is a problem with the Smart
Protection Server itself.
598
Trend Micro Deep Security On-Premise 20
5. Set the Smart Protection Server Connection Warning to generate error events and alerts
when a computer loses its connection to the Smart Protection Server.
Smart Feedback
Trend Micro Smart Feedback provides continuous communication between Trend Micro
products and the company's 24/7 threat research centers and technologies. With Smart
Feedback, products become an active part of the Trend Micro Smart Protection Network, where
large amounts of threat data is shared and analyzed in real time. This interconnection enables
never before possible rates of analysis, identification, and prevention of new threats-a level of
responsiveness that addresses the thousands of new threats and threat variants released daily.
Trend Micro Smart Feedback is a system setting in the Deep Security Manager. When enabled,
Smart Feedback shares anonymous threat information with the Smart Protection Network,
allowing Trend Micro to rapidly identify and address new threats. By default, Smart Feedback is
enabled. You can disable it or adjust its settings by going to Administration > System Settings >
Smart Feedback.
Note: Smart Feedback will use the agents, appliances, and relays (security updates) proxy
selected in the Proxy Server Use section on the Administration > System Settings > Proxies
tab.
Handle malware
View and restore identified malware
An identified file is a file that has been found to be or to contain malware and has therefore been
encrypted and moved to a special folder on the protected computer. Whether or not an infected
file can be viewed and restored depends on the anti-malware configuration, and the operating
system on which the file was found:
l On Windows agents, you can view and restore "Customize malware remedial actions" on
page 568 files.
l On Linux agents, you can view and restore only quarantined files.
Topics on this page:
l "See a list of identified files" on the next page
l "Working with identified files" on page 601
599
Trend Micro Deep Security On-Premise 20
l "Search for an identified file" on page 602
l "Restore identified files " on page 603
l "Manually restore identified files" on page 606
For information about events that are generated when malware is encountered, see "Anti-
malware events" on page 1033.
See a list of identified files
The Events and Reports page provides a list of identified files. From there you can see the
details for any of those files.
1. Click Events & Reports > Events > Anti-Malware Events > Identified Files.
2. To see the details of a file, select the file and click View.
The list of identified files includes the following columns of information:
l Infected File: Shows the name of the infected file and the specific security risk.
l Malware: Names the malware infection.
l Computer: Indicates the name of the computer with the suspected infection.
The Details window provides the following information:
l Detection Time: The date and time on the infected computer that the infection was
detected.
l Infected File(s): The name of the infected file.
l File SHA-1: The SHA-1 hash of the file.
l Malware: The name of the malware that was found.
l Scan Type: Indicates whether the malware was detected by a Real-time, Scheduled, or
Manual scan.
l Action Taken: The result of the action taken by Deep Security when the malware was
detected.
l Computer: The computer on which this file was found. (If the computer has been removed,
this entry will read "Unknown Computer".)
l Container Name: Name of the Docker container where the malware was found.
l Container ID: ID of the Docker container where the malware was found.
l Container Image Name: Image name of the Docker container where the malware was
found.
600
Trend Micro Deep Security On-Premise 20
Working with identified files
The Identified Files page allows you to manage tasks related to identified files. Using the menu
bar or the right-click context menu, you can:
l Restore identified files back to their original location and condition.
l Download identified files from the computer or Virtual Appliance to a location of your
choice.
l Analyze identified files from the computer or Virtual Appliance.
l Delete one or more identified files from the computer or Virtual Appliance.
l Export information about the identified file(s) (not the file itself) to a CSV file.
l View the details of an identified file.
l Computer Details displays the screen of the computer on which the malware was
detected.
l View Anti-Malware Event displays the anti-malware event associated with this
identified file.
l Add or Remove Columns by clicking Add/Remove.
l Search for a particular identified file.
Note:
Identified files are automatically deleted from a Deep Security Virtual Appliance when a:
l VM is moved to another ESXi host by vMotion. Identified files associated with that VM
will be deleted from the virtual appliance.
l VM is deactivated from the Deep Security Manager. Identified files associated with that
VM will be deleted from the virtual appliance.
l Deep Security Virtual Appliance is deactivated from the Deep Security Manager. All the
identified files stored on that virtual appliance will be deleted.
l Deep Security Virtual Appliance is deleted from the vCenter. All the identified files stored
on that virtual appliance will also be deleted.
601
Trend Micro Deep Security On-Premise 20
Search for an identified file
l Use the Period drop-down menu to see only the files that were identified within a specific
time frame.
l Use the Computers drop-down menu to organize files by Computer Groups or Computer
Policies.
l Click Search this page > Open Advanced Search to toggle the display of the advanced
search options:
Advanced searches include one or more search criteria for filtering identified files. Each criterion
is a logical statement comprised of the following items:
l The characteristic of the identified file to filter on, such as the type of file (infected file or
malware) or the computer that was affected.
l An operator:
l Contains: The entry in the selected column contains the search string.
l Does Not Contain: The entry in the selected column does not contain the search
string.
l Equals: The entry in the selected column exactly matches the search string.
l Does Not Equal: The entry in the selected column does not exactly match the search
string.
l In: The entry in the selected column exactly matches one of the comma-separated
search string entries.
l Not In: The entry in the selected column does not exactly match any of the comma-
separated search string entries.
602
Trend Micro Deep Security On-Premise 20
l A value.
To add a criterion, click the "plus" button (+) to the right of the topmost criterion.To search, click
the Search button (the circular arrow).
Note: Searches are not case-sensitive.
Restore identified files
Create a scan exclusion for the file
Before you can restore a file to its original location, you have to create a scan exclusion so that
Deep Security doesn't immediately re-identify the file when it reappears on the computer.
Note: The following instructions describe how to create an exclusion for the file on an
individual computer but you can make the same configuration changes at the policy level.
1. Open the Computers page and go to Anti-Malware > Identified Files and double click the
identified file to view its properties.
2. Note the file's exact name and original location.
3. Still in the Computers page, go to Anti-Malware > General and click the Edit button next to
each Malware Scan that's in effect to open the Malware Scan Configuration properties
603
Trend Micro Deep Security On-Premise 20
window.
4. In the Malware Scan Configuration properties window, click on the Exclusions tab.
5. In the Scan Exclusions area, select File List and then either press edit if a file list is already
selected, or select New from the menu to create a new File List.
604
Trend Micro Deep Security On-Premise 20
6. In the File List properties window, enter the file path and name of the file to be restored.
Click OK to close the File List properties window.
7. Close the Malware Scan Configuration properties window by clicking OK.
8. When you've edited all the Malware Scan Configurations, click Save in the Computers
page to save your changes. You're now ready to restore your file.
605
Trend Micro Deep Security On-Premise 20
Restore the file
1. Still in the Computers page, go to the Anti-Malware > Identified Files tab.
2. Right-click the identified file and select Actions > Restore and follow the steps in the
wizard.
Your file is restored to its original location.
Manually restore identified files
To manually restore an identified file, download the file to your computer. The Identified File
wizard will display a link to an Administration Utility which you can use to decrypt, examine, or
restore the file. Use the quarantined file decryption utility to decrypt the file and then move it back
to its original location.
The decryption utility is in a zip file, QFAdminUtil_win32.zip, located in the "util" folder under the
Deep Security Manager root directory. The zipped file contains two utilities which perform the
same function: QDecrypt.exe and QDecrypt.com. Running QDecrypt.exe invokes an open file
dialog that lets you select the file for decryption. QDecrypt.com is a command-line utility with the
following options:
l /h, --help: show this help message
l --verbose: generate verbose log messages
l /i, --in=<str>: quarantined file to be decrypted, where <str> is the name of the quarantined
file
l /o, --out=<str>: decrypted file output, where <str> is the name given to the resulting
decrypted file
Note: This utility is supported only on Windows 32-bit systems.
Create anti-malware exceptions
Files that are not malicious can be falsely identified as malware if they share certain
characteristics with malware. If a file is known to be benign and is identified as malware, you can
create an exception for that file. When an exception is created, the file does not trigger an event
when Deep Security scans the file.
For an overview of the anti-malware module, see "About Anti-Malware" on page 547.
606
Trend Micro Deep Security On-Premise 20
Note: You can also exclude files from real-time, manual, and scheduled scans. See "Specify
the files to scan" on page 562.
Exceptions can be created for the following types of malware and malware scans:
l Predictive Machine Learning scans (for information, see "Detect emerging threats using
Predictive Machine Learning" on page 578.)
l Document exploit protection scans (for information, see "Detect emerging threats using
Connected Threat Defense" on page 580)
l Scans for spyware and grayware (for information, see "Scan for spyware and grayware" on
page 560)
l Behavior monitoring protection (for information, see "Enhanced anti-malware and
ransomware scanning with behavior monitoring" on page 589)
Deep Security maintains a list of exceptions for each type of malware scan in policy and
computer properties.
1. To see the lists of exceptions, open the policy or computer editor.
2. Click Anti-Malware > Advanced.
The exceptions are listed in the Allowed Spyware/Grayware, Document Exploit
Protection Rule Exceptions, Predictive Machine Learning Detection Exceptions, and
Behavior Monitoring Protection Exceptions sections.
See also "Scan exclusion recommendations" on the next page.
Create an exception from an anti-malware event
When a file is identified as malware, Deep Security generates an anti-malware event. If you
know that the file is benign, you can create an exception for the file from the event report.
1. Click Events & Reports > Events > Anti-Malware Events and locate the malware
detection event.
2. Right-click the event.
3. Select Allow.
Manually create an anti-malware exception
You can manually create anti-malware exceptions for spyware or grayware, document exploit
protection rules, predictive machine learning, and behavior monitoring exceptions. To add the
exception, you need specific information from the anti-malware event that the scan generated.
The type of malware or scan determines the information that you need:
607
Trend Micro Deep Security On-Premise 20
l Spyware or grayware: The value in the "MALWARE" field, for example SPY_CCFR_CPP_
TEST.A
l Document exploit protection rules: The value in the "MALWARE" field, for example HEUR_
OLEP.EXE
l Predictive machine learning: The SHA1 digest of the file from the "FILE SHA-1" field, for
example 3395856CE81F2B7382DEE72602F798B642F14140
l Behavior monitoring: The process image path, for example C:\test.exe
1. Click Events & Reports > Events > Anti-Malware Events and copy the field value that is
required to identify the malware.
2. Open the policy or computer editor where you want to create the exception.
3. Click Anti-Malware > Advanced.
4. In the Allowed Spyware/Grayware, Document Exploit Protection Rule Exceptions,
Predictive Machine Learning Detection Exceptions, or Behavior Monitoring Protection
Exceptions section, enter the information from the event in the text box.
5. Click Add.
Exception strategies for spyware and grayware
When spyware is detected, the malware can be immediately cleaned, quarantined, or deleted,
depending on the malware scan configuration that controls the scan. After you create the
exception for a spyware or grayware event, you might have to restore the file. (See "Restore
identified files " on page 603.)
Alternatively, you can temporarily scan for spyware and grayware with the action set to "Pass"
so that all spyware and grayware detections are recorded on the Anti-Malware Events page but
not cleaned, quarantined, or deleted. You can then create exceptions for the detected spyware
and grayware. When your exception list is robust, you can set the action to "Clean",
"Quarantine", or "Delete" modes.
For information about setting the action, see "Configure how to handle malware" on page 568.
Scan exclusion recommendations
The best and most comprehensive source for scan exclusions is from the software vendor. The
following are some high-level scan exclusion recommendations:
l Quarantine folders (such as SMEX on Microsoft Windows Exchange Server) should be
excluded to avoid rescanning files that have already been confirmed to be malware.
608
Trend Micro Deep Security On-Premise 20
l Large databases and database files (for example, dsm.mdf and dsm.ldf) should be
excluded because scanning could impact database performance. If it is necessary to scan
database files, you can create a scheduled task to scan the database during off-peak
hours. Since Microsoft SQL Server databases are dynamic, exclude the directory and
backup folders from the scan list:
For Windows:
${ProgramFiles}\Microsoft SQL Server\MSSQL\Data\
${Windir}\WINNT\Cluster\ # if using SQL Clustering
Q:\ # if using SQL Clustering
For Linux:
/var/lib/mysql/ # if path is set to this Data Location of MySQL in the
machine.
/mnt/volume-mysql/ # if path is set to this Data Location of MySQL in
the machine.
For a list of recommended scan exclusions, see the Trend Micro recommended scan exclusion
list. Microsoft also maintains an Anti-Virus Exclusion List that you can use as a reference for
excluding files from scanning on Windows servers.
Increase debug logging for anti-malware in protected Linux instances
You can increase or decrease verbosity of the anti-malware (AM) debug logging used to
diagnose any issue related to AM when running on a Linux operating system.
Anti-malware debug logs are automatically included when you create a diagnostic package for
technical support.
For information on creating a diagnostic package, see "Create a diagnostic package and logs"
on page 1550.
To increase the anti-malware debug log level, enter the following command in a shell on the
Linux instance as a superuser:
killall -USR1 ds_am
This command will increase the level one unit. By default the level is 6 and the maximum is 8.
609
Trend Micro Deep Security On-Premise 20
To decrease the anti-malware debug log level, enter the following command in a shell on the
Linux instance as a superuser:
killall -USR2 ds_am
This command decreases the level by one unit. The minimum level is 0.
Note: If your Linux distribution doesn't use killall you can substitute it with the pkill
command.
Configure Web Reputation
Note: For a list of operating systems where web reputation is supported, see "Supported
features by platform" on page 145.
The web reputation module protects against web threats by blocking access to malicious URLs.
Deep Security uses Trend Micro's Web security databases from Smart Protection Network
sources to check the reputation of websites that users are attempting to access. The website's
reputation is correlated with the specific web reputation policy enforced on the computer.
Depending on the security level being enforced, Deep Security will either block or allow access
to the URL.
Note: The web reputation module does not block HTTPS traffic.
To enable and configure web reputation, perform the basic steps below:
1. "Turn on the web reputation module" on the next page
2. "Switch between inline and tap mode" on the next page
3. "Enforce the security level" on the next page
4. "Create exceptions" on page 612
5. "Configure the Smart Protection Server" on page 613
6. "Edit advanced settings" on page 615
7. "Test Web Reputation" on page 615
To suppress messages that appear to users of agent computers, see "Configure notifications on
the computer" on page 572
610
Trend Micro Deep Security On-Premise 20
Turn on the web reputation module
1. Go to Policies.
2. Double-click the policy for which you want to enable web reputation.
3. Click Web Reputation > General.
4. For Web Reputation State, select On.
5. Click Save.
Switch between inline and tap mode
Web reputation uses the Deep Security Network Engine which can operate in one of two modes:
l Inline: Packet streams pass directly through the Deep Security network engine. All rules
are applied to the network traffic before they proceed up the protocol stack.
l Tap mode: Packet streams are not modified. The traffic is still processed by Web
Reputation, if it's enabled. However any issues detected do not result in packet or
connection drops. When in Tap mode, Deep Security offers no protection beyond providing
a record of events.
In tap mode, the live stream is not modified. All operations are performed on the replicated
stream. When in tap mode, Deep Security offers no protection beyond providing a record of
events.
To switch between inline and tap mode, open the Computer or Policy editor 1 and go to Settings
> Advanced > Network Engine Mode.
For more on the network engine, see "Test Firewall rules before deploying them" on page 659.
Enforce the security level
Web addresses that are known to be or are suspected of being malicious are assigned a risk
level of:
l Dangerous: Verified to be fraudulent or known sources of threats
l Highly suspicious: Suspected to be fraudulent or possible sources of threats
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
611
Trend Micro Deep Security On-Premise 20
l Suspicious: Associated with spam or possibly compromised
Security levels determine whether Deep Security will allow or block access to a URL, based on
the associated risk level. For example, if you set the security level to low, Deep Security will only
block URLs that are known to be web threats. As you set the security level higher, the web threat
detection rate improves but the possibility of false positives also increases.
To configure the security level:
1. Go to Policies.
2. Double-click the policy that you want to edit.
3. Click Web Reputation > General.
4. Select one of the following security levels:
l High: Blocks pages that are:
l Dangerous
l Highly suspicious
l Suspicious
l Medium: Blocks pages that are:
l Dangerous
l Highly Suspicious
l Low: Blocks pages that are:
l Dangerous
5. Click Save.
Create exceptions
You can override the block and allow behavior dictated by the Smart Protection Network's
assessments with your lists of URLs that you want to block or allow.
Note: The Allowed list takes precedence over the Blocked list. URLs that match entries in the
Allowed list are not checked against the Blocked list.
To create URL exceptions:
1. Go to Policies.
2. Double-click the policy that you want to edit.
3. Click Web Reputation > Exceptions.
612
Trend Micro Deep Security On-Premise 20
4. To allow URLs:
a. Go to the Allowed section.
b. In the blank under URLs to be added to the Allowed list (one per line), enter your
desired URL. Multiple URLs can be added at once but they must be separated by a
line break.
c. Select either:
l Allow URLs from the domain: Allow all pages from the domain. Sub-domains are
supported. Only include the domain (and optionally sub-domain) in the entry. For
example, "example.com" and "another.example.com" are valid entries.
l Allow the URL:: The URL as entered will be allowed. Wildcards are supported.
For example, "example.com/shopping/coats.html", and "example.com/shopping/*"
are valid entries.
d. Click Add.
To block URLs:
a. Go to the Blocked section
b. In the blank under URLs to be added to the Blocked list (one per line), enter your
desired URL. Multiple URLs or keywords can be added at once but they must be
separated by a line break.
c. Select either:
l Block URLs from the domain: Block all pages from the domain. Sub-domains are
supported. Only include the domain (and optionally sub-domain) in the entry. For
example, "example.com" and "another.example.com" are valid entries.
l Block the URL: The URL as entered will be blocked. Wildcards are supported. For
example, "example.com/shopping/coats.html", and "example.com/shopping/*" are
valid entries.
l Block URLs containing this keyword: Any URL containing the keyword will be
blocked.
d. Click Add.
5. Click Save.
Configure the Smart Protection Server
Smart Protection Service for web reputation supplies web information required by the web
reputation module. For more information, see Smart Protection Network - Global Threat
Intelligence.
To configure Smart Protection Server:
613
Trend Micro Deep Security On-Premise 20
1. Go to Policies.
2. Double-click the policy you'd like to edit.
3. Click Web Reputation > Smart Protection.
4. Select whether to connect directly to Trend Micro's Smart Protection service:
a. Select Connect directly to Global Smart Protection Service.
b. Optionally select When accessing Global Smart Protection Service, use proxy.
Select New from the drop down menu and enter your desired proxy.
Or to connect to one or more locally installed Smart Protection Servers:
a. Select Use locally installed Smart Protection Server (ex: "http://[server]:5274").
b. Enter the Smart Protection Server URL into the field and click Add. To find the Smart
Protection Server URL, do one of the following:
l Log in to the Smart Protection Server, and in the main pane, look under Real
Time Status. The Smart Protection Server's HTTP and HTTPS URLs are listed
in the Web Reputation row. The HTTPS URL is only supported with 11.0 Deep
Security Agents and up. If you have 10.3 or earlier agents, use the HTTP URL.
Or
l If you deployed the Smart Protection Server in AWS, go to the AWS
CloudFormation service, select the check box next to the Smart Protection
Server stack, and in the bottom pane, click the Outputs tab. The Smart Protection
Server's HTTP and HTTPS URLs appear in the WRSurl and WRSHTTPSurl
fields. The WRSHTTPSurl is only supported with 11.0 Deep Security Agents
and up. If you have 10.3 or earlier agents, use the WRSurl URL.
c. Optionally select When off domain, connect to global Smart Protection Service.
(Windows only).
5. Click Save.
Smart Protection Server Connection Warning
This option determines whether error events are generated and alerts are raised if a computer
loses its connection to the Smart Protection Server. Select either Yes or No and click Save.
Note: If you have a locally installed Smart Protection Server, this option should be set to Yes
on at least one computer so that you are notified if there is a problem with the Smart Protection
Server itself.
614
Trend Micro Deep Security On-Premise 20
Edit advanced settings
Blocking Page
When users attempt to access a blocked URL, they will be redirected to a blocking page. In the
blank for Link, provide a link that users can use to request access to the blocked URL.
Alert
Decide to raise an alert when a web reputation event is logged by selecting either Yes or No.
Ports
Select specific ports to monitor for potentially harmful web pages from the drop down list next to
Ports to monitor for potentially harmful web pages.
Test Web Reputation
Before continuing, test that the Web Reputation is working correctly:
1. Ensure Web Reputation is enabled.
2. Go to the Computer or Policy editor > Web Reputation > Exceptions.
3. Under Blocked, enter http://www.speedtest.net and click Add. Click Save.
4. Open a browser and attempt to access the website. A message denying the access should
appear.
5. Go to Events & Reports > Web Reputation to verify the record of the denied web access. If
the detection is recorded, the Web Reputation module is working correctly.
Configure Intrusion Prevention (IPS)
About Intrusion Prevention
The Intrusion Prevention module protects your computers from known and zero-day vulnerability
attacks as well as against SQL injections attacks, cross-site scripting attacks, and other web
application vulnerabilities.
When patches are not available for known vulnerabilities in applications or operating systems,
Intrusion Prevention rules can intercept traffic that is trying to exploit the vulnerability. It identifies
malicious software that is accessing the network and it increases visibility into, or control over,
615
Trend Micro Deep Security On-Premise 20
applications that are accessing the network. Therefore your computers are protected until
patches that fix the vulnerability are released, tested, and deployed.
Protection is available for file sharing and messaging software such as Skype, but also web
applications with vulnerabilities such as SQL injection and cross-site scripting (XSS). In this
way, Intrusion Prevention can also be used as a lightweight web application firewall (WAF).
To enable and configure Intrusion Prevention, see "Set up Intrusion Prevention" on page 619.
Intrusion Prevention rules
Intrusion Prevention rules define a set of conditions that are compared to the payload session
and application layers of network packets (such as DNS, HTTP, SSL, and SMTP), as well as the
sequence of those packets according to those higher-layer protocols.
Tip: Firewall rules examine the network and transport layers of a packet (IP, TCP, and UDP,
for example).
When Deep Security Agents scan network traffic and the traffic meets a rule's match conditions,
the agent handles it as a possible or confirmed attack and performs one of the following actions,
depending on the rule:
l Replace specifically defined or suspicious byte sequences
l Completely drop packets
l Reset the connection
Intrusion Prevention rules are assigned to policies and computers. Therefore you can enforce
sets of rules on groups of computers based on the policy that they use, and override policies as
required. (See "Policies, inheritance, and overrides" on page 451.)
For information about how you can affect the functionality of rules, see "Configure intrusion
prevention rules" on page 626.
Application types
Application types organize rules by the application that they are associated with. Application
types can also store property values that rules can reference as required, such as protocols used
for communications, and port numbers. Some application types have configurable properties.
For example, the Database Microsoft SQL application type contains rules that are associated
with Microsoft SQL Server. You can configure this application type to specify the ports used to
connect to the database.
616
Trend Micro Deep Security On-Premise 20
For more information, see "Application types" on page 646.
Rule updates
Trend Micro creates Intrusion Prevention rules for application vulnerabilities as they are
discovered. Security updates can include new or updated rules and application types. When a
rule is already assigned to a policy, and an update includes rules upon which the assigned rule
depends, you can choose to automatically assign the updated rules.
Tip: Intrusion Prevention rules from Trend Micro include information about the vulnerability
against which it protects.
Intrusion Prevention rules from Trend Micro are not directly editable through Deep Security
Manager. However some rules are configurable, and some rules require configuration. (See
"Setting configuration options (Trend Micro rules only)" on page 632.)
Recommendation scans
You can use recommendation scans to discover the Intrusion Prevention rules that you should
assign to your policies and computers. (See "Manage and run recommendation scans" on
page 456.)
Use behavior modes to test rules
Intrusion Prevention works in either Detect or Prevent mode:
l Detect: Intrusion Prevention uses rules to detect matching traffic and generate events, but
does not block traffic. Detect mode is useful to test that Intrusion Prevention rules do not
interfere with legitimate traffic.
l Prevent: Intrusion Prevention uses rules to detect matching traffic, generate events, and
block traffic to prevent attacks.
When you first apply new Intrusion Prevention rules, use Detect mode to verify that they don't
accidentally block normal traffic (false positives). When you are satisfied that no false positives
occur, you can use Prevent mode to enforce the rules and block attacks. (See "Enable Intrusion
Prevention in Detect mode" on page 620 and "Switch to Prevent mode" on page 625.)
Tip: Similar to using Intrusion Prevention in Detect mode, the Deep Security network engine
can run in tap mode for testing purposes. In tap mode, Intrusion Prevention detects rule-
matching traffic and generates events, but doesn't block traffic. Also, tap mode affects the
617
Trend Micro Deep Security On-Premise 20
Firewall and Web Reputation modules. You can use Detect mode to test Intrusion Prevention
rules separately.
You use tap mode with Intrusion Prevention in the same way that tap mode is used for testing
Firewall rules. See "Test Firewall rules before deploying them" on page 659.
Override the behavior mode for rules
By selecting Detect mode for individual rules, you can selectively override Prevent mode
behavior set at the computer or policy level. This is useful for testing new Intrusion Prevention
rules that are applied to a policy or computer. For example, when a policy is configured such that
Intrusion Prevention works in Prevent mode, you can bypass the Prevent mode behavior for an
individual rule by setting that rule to Detect mode. For that rule only, Intrusion Prevention merely
logs the traffic, and enforces other rules that do not override the policy's behavior mode. (See
"Override the behavior mode for a rule" on page 634.)
Note: While Prevent mode at the computer or policy level can be overridden by contradictory
rule settings, Detect mode cannot. Selecting Detect mode at the computer or policy level
enforces Detect mode behavior regardless of rule settings.
Some rules issued by Trend Micro use Detect mode by default. For example, mail client rules
generally use Detect mode because in Prevent mode they block the downloading of all mail.
Some rules trigger an alert only when a condition occurs a large number times, or a certain
number of times within a certain period of time. These types of rules apply to traffic that
constitutes suspicious behavior only when a condition recurs, and a single occurrence of the
condition is considered normal.
Warning:
To prevent blocking legitimate traffic and interrupting network services, when a rule requires
configuration, keep it in Detect mode until you've configured the rule. Switch a rule to Prevent
mode only after configuration and testing.
Intrusion Prevention events
By default, the Deep Security Manager collects Firewall and Intrusion Prevention event logs
from the Deep Security Agents and Appliances1 at every heartbeat. Once collected by the Deep
1The Deep Securty Agent and Deep Security Virtual Appliance are the components that enforce the Deep Security policies that you have
defined. Agents are deployed directly on a computer. Appliances are used in VMware vSphere environments to provide agentless protection.
They are not available with Deep Security as a Service.
618
Trend Micro Deep Security On-Premise 20
Security Manager, event logs are kept for a period of time which can be configured. The default
setting is one week. (See "Log and event storage best practices" on page 829.) You can
configure event logging for individual rules as required. (See "Configure event logging for rules"
on page 631.)
Event tagging can help you to sort events. You can manually apply tags to events or
automatically tag them. You can also use the auto-tagging feature to group and label multiple
events. For more information on event tagging, see "Apply tags to identify and group events" on
page 836.
Support for secure connections
The Intrusion Prevention module supports inspecting packets over secure connections. See
"Inspect SSL or TLS traffic" on page 648.
Contexts
Contexts are a powerful way of implementing different security policies depending on the
computer's network environment. You typically use contexts to create policies that apply different
Firewall and Intrusion Prevention rules to computers (usually mobile laptops) depending on
whether that computer is in the office or away.
To determine a computer's location, contexts examine the nature of the computer's connection to
its domain controller. For more information, see "Define contexts for use in policies" on
page 540.
Interface tagging
You can use interface types when you need to assign Firewall or Intrusion Prevention rules to a
specific interface when a machine has multiple network interfaces. By default, Firewall and
Intrusion Prevention rules are assigned to all interfaces on a computer. For example, to apply
special rules only to the wireless network interface, use interface types to accomplish this. For
more information, see "Configure a policy for multiple interfaces" on page 467.
Set up Intrusion Prevention
Enable the Intrusion Prevention module and monitor network traffic for exploits using Detect
mode. When you are satisfied with how your Intrusion Prevention rules are assigned, switch to
Prevent mode.
619
Trend Micro Deep Security On-Premise 20
1. "Enable Intrusion Prevention in Detect mode" below
2. "Test Intrusion Prevention" on page 622
3. "Apply recommended rules" on page 623
4. "Monitor your system" on page 624
5. "Enable 'fail open' for packet or system failures" on page 625
6. "Switch to Prevent mode" on page 625
7. "Implement best practices for specific rules" on page 625
8. "Apply NSX security tags" on page 626
Note: CPU usage and RAM usage varies by your IPS configuration. To optimize IPS
performance on Deep Security Agent, see "Performance tips for intrusion prevention" on
page 655.
For an overview of the Intrusion Prevention module, see "About Intrusion Prevention" on
page 615.
Enable Intrusion Prevention in Detect mode
Enable Intrusion Prevention and use Detect mode for monitoring. Configure Intrusion Prevention
using the appropriate policies to affect the targeted computers. You can also configure individual
computers.
620
Trend Micro Deep Security On-Premise 20
1. Go to Computer or Policy editor 1 > Intrusion Prevention > General.
2. For Configuration, select either On or Inherited (On).
3. For Intrusion Prevention Behavior, select Detect.
4. With Deep Security Agent 11.1 and earlier, the Intrusion Prevention module inspects traffic
that passes through the host computer's network interface to containers. With Deep
Security Agent 11.2 or later, it can also inspect traffic between containers. When the Scan
container network traffic setting is set to Yes, Deep Security scans the traffic that goes
through both containers and hosts. When it is set to No, Deep Security scans only the
traffic that goes through the host network interface.
5. Click Save.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
621
Trend Micro Deep Security On-Premise 20
Tip: If the behavior settings are not available, Network Engine Mode may be set to Tap. (See
"Test Firewall rules before deploying them" on page 659.)
For more fine-grained control, when you assign Intrusion Prevention rules, you can override the
global behavior mode and configure specific rules to either prevent or detect. (See "Override the
behavior mode for a rule" on page 634.)
Test Intrusion Prevention
You should test that the Intrusion Prevention module is working properly before continuing with
further steps.
1. If you have an agent-based deployment, make sure you have a computer that has an agent
running. For an agentless deployment, make sure your Deep Security Virtual Appliance is
running normally.
2. Turn off the Web Reputation module. In Deep Security Manager, click Computers, then
double-click the computer where you'll test Intrusion Prevention. In the computer's dialog
box, click Web Reputation, and select Off. Web Reputation is now disabled and won't
interfere with the Intrusion Prevention functionality.
3. Make sure bad traffic is blocked. Still in the computer's dialog box, click Intrusion
Prevention, and under the General tab, select Prevent. (If it is shaded, set the
Configuration drop-down list to Inherited (On).)
4. Assign the EICAR test policy. Still in the computer's dialog box, click Intrusion Prevention.
Click Assign/Unassign. Search for 1005924. The 1005924 - Restrict Download of EICAR
Test File Over HTTP policy appears. Select its check box and click OK. The policy is now
assigned to the computer.
5. Try to download the EICAR file (you can't, if Intrusion Prevention is running properly). On
Windows, go to this link: http://files.trendmicro.com/products/eicar-file/eicar.com. On Linux,
enter this command: curl -O http://files.trendmicro.com/products/eicar-
file/eicar.com
6. Check the Intrusion Prevention events for the computer. Still in the computer's dialog box,
click Intrusion Prevention > Intrusion Prevention Events. Click Get Events to see events
that have occurred since the last heartbeat. An event appears with a Reason of 1005924 -
Restrict Download of EICAR Test File Over HTTP. The presence of this event indicates
that Intrusion Prevention is working.
7. Revert your changes to return your system to its previous state. Turn on the Web
Reputation module (if you turned it off), reset the Prevent or Detect option, and remove the
EICAR policy from the computer.
622
Trend Micro Deep Security On-Premise 20
Apply recommended rules
To maximize performance, only assign the Intrusion Prevention rules that are required by your
policies and computers. You can use a recommendation scan to obtain a list of rules that are
appropriate.
Note: Although recommendation scans are performed for a specific computer, you can assign
the recommendations to a policy that the computer uses.
For more information, see "Manage and run recommendation scans" on page 456.
1. Open the properties for the computer to scan. Run the recommendation scan as described
in "Manually run a recommendation scan" on page 461.
Note: You can configure Deep Security to "Automatically implement recommendations"
on page 462 scan results when it is appropriate to do so.
623
Trend Micro Deep Security On-Premise 20
2. Open the policy to which you want to assign the rules, and complete the rule assignments
as described in "Check scan results and manually assign rules" on page 463.
Tip: To automatically and periodically fine tune your assigned Intrusion Prevention rules, you
can schedule recommendation scans. See "Schedule Deep Security to perform tasks" on
page 1378.
Monitor your system
After you apply Intrusion Prevention rules, monitor system performance and Intrusion Prevention
event logs.
Monitor system performance
Monitor CPU, RAM, and network usage to verify that system performance is still acceptable. If
not, you can modify some settings and deployment aspects to improve performance. (See
624
Trend Micro Deep Security On-Premise 20
"Performance tips for intrusion prevention" on page 655.)
Check Intrusion Prevention events
Monitor Intrusion Prevention events to ensure that rules are not matching legitimate network
traffic. If a rule is causing false positives you can unassign the rule. (See "Assign and unassign
rules" on page 630.)
To see Intrusion Prevention events, click Events & Reports > Intrusion Prevention Events.
Enable 'fail open' for packet or system failures
The Intrusion Prevention module includes a network engine that might block packets before
Intrusion Prevention rules can be applied. This might lead to downtime or performance issues
with your services and applications. You can change this behavior so that packets are allowed
through when system or internal packet failures occur. For details, see "Enable 'fail open'
behavior" on page 660.
Switch to Prevent mode
When you are satisfied that Intrusion Prevention is not finding false positives, configure your
policy to use Intrusion Prevention in Prevent mode so that rules are enforced and related events
are logged.
1. Go to Computer or Policy editor 1 > Intrusion Prevention > General.
2. For Intrusion Prevention Behavior, select Prevent.
3. Click Save.
Implement best practices for specific rules
HTTP Protocol Decoding rule
The HTTP Protocol Decoding rule is the most important rule in the "Web Server Common"
Application Type. This rule decodes the HTTP traffic before the other rules inspect it. This rule
also allows you to control various components of the decoding process.
This rule is required when you use any of the Web Application Common or Web Server
Common rules that require it. The Deep Security Manager automatically assigns this rule when it
is required by other rules. As each web application is different, the policy that uses this rule
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
625
Trend Micro Deep Security On-Premise 20
should run in Detect mode for a period of time before switching to Prevent mode to determine if
any configuration changes are required.
Quite often, changes are required to the list of illegal characters.
Refer to the following Knowledge Base articles for more details on this rule and how to tune it:
l https://success.trendmicro.com/solution/1098016
l https://success.trendmicro.com/solution/1054481
l https://success.trendmicro.com/solution/1096566
Cross-site scripting and generic SQL injection rules
Two of the most common application-layer attacks are SQL injection and cross-site scripting
(XSS). Cross-site scripting and SQL injection rules intercept the majority of attacks by default,
but you may need to adjust the drop score for specific resources if they cause false positives.
Both rules are smart filters that need custom configuration for web servers. If you have output
from a Web Application Vulnerability Scanner, you should leverage that information when
applying protection. For example, if the user name field on the login.asp page is vulnerable to
SQL injection, ensure that the SQL injection rule is configured to monitor that parameter with a
low threshold to drop on.
For more information, see https://success.trendmicro.com/solution/1098159
Apply NSX security tags
Apply NSX security tags
Deep Security can apply NSX security tags to protected VMs when Intrusion Prevention rules
are triggered. For details, see "Configure Intrusion Prevention to apply NSX security tags" on
page 377.
Configure intrusion prevention rules
Perform the following tasks to configure and work with intrusion prevention rules:
l "See the list of intrusion prevention rules" on the next page
l "See information about an intrusion prevention rule" on the next page
l "See information about the associated vulnerability (Trend Micro rules only)" on page 629
l "Assign and unassign rules" on page 630
626
Trend Micro Deep Security On-Premise 20
l "Automatically assign updated required rules" on page 630
l "Configure event logging for rules" on page 631
l "Generate alerts" on page 632
l "Setting configuration options (Trend Micro rules only)" on page 632
l "Schedule active times" on page 632
l "Exclude from recommendations" on page 633
l "Set the context for a rule" on page 633
l "Override the behavior mode for a rule" on page 634
l "Override rule and application type configurations" on page 634
l "Export and import rules" on page 635
l "Configure an SQL injection prevention rule" on page 635
For an overview of the intrusion prevention module, see "About Intrusion Prevention" on
page 615.
See the list of intrusion prevention rules
The Policies page provides a list of intrusion prevention rules. You can search for intrusion
prevention rules, and open and edit rule properties. In the list, rules are grouped by application
type, and some rule properties appear in different columns.
Tip: The "TippingPoint" column contains the equivalent Trend Micro TippingPoint rule ID. In
the Advanced Search for intrusion prevention, you can search on the TippingPoint rule ID. You
can also see the TippingPoint rule ID in the list of assigned intrusion prevention rules in the
policy and computer editor.
To see the list, click Policies, and then below Common Objects/Rules click Intrusion
Prevention Rules.
See information about an intrusion prevention rule
The properties of intrusion prevention rules include information about the rule and the exploit
against which it protects.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
627
Trend Micro Deep Security On-Premise 20
General Information
l Name: The name of the intrusion prevention rule.
l Description: The description of the intrusion prevention rule.
l Minimum Agent/Appliance Version: The minimum version of the Deep Security Agent or
Appliance1 required to support this intrusion prevention rule.
Details
Clicking New ( ) or Properties ( ) displays the Intrusion Prevention Rule Properties
window.
Note: Note the Configuration tab. Intrusion Prevention Rules from Trend Micro are not directly
editable through Deep Security Manager. Instead, if the Intrusion Prevention Rule requires (or
allows) configuration, those configuration options will be available on the Configuration tab.
Custom Intrusion Prevention Rules that you write yourself will be editable, in which case the
Rules tab will be visible.
See the list of intrusion prevention rules
The Policies page provides a list of intrusion prevention rules. You can search for intrusion
prevention rules, and open and edit rule properties. In the list, rules are grouped by application
type, and some rule properties appear in different columns.
Tip: The "TippingPoint" column contains the equivalent Trend Micro TippingPoint rule ID. In
the Advanced Search for intrusion prevention, you can search on the TippingPoint rule ID. You
can also see the TippingPoint rule ID in the list of assigned intrusion prevention rules in the
policy and computer editor.
To see the list, click Policies, and then below Common Objects/Rules click Intrusion
Prevention Rules.
1The Deep Securty Agent and Deep Security Virtual Appliance are the components that enforce the Deep Security policies that you have
defined. Agents are deployed directly on a computer. Appliances are used in VMware vSphere environments to provide agentless protection.
They are not available with Deep Security as a Service.
628
Trend Micro Deep Security On-Premise 20
General Information
l Application Type: The application type under which this intrusion prevention rule is
grouped.
Tip: You can edit application types from this panel. When you edit an application type
from here, the changes are applied to all security elements that use it.
l Priority: The priority level of the rule. Higher priority rules are applied before lower priority
rules.
l Severity: Setting the severity of a rule has no effect on how the rule is implemented or
applied. Severity levels can be useful as sorting criteria when viewing a list of intrusion
prevention rules. More importantly, each severity level is associated with a severity value;
this value is multiplied by a computer's Asset Value to determine the Ranking of an Event.
(See Administration > System Settings > Ranking.)
l CVSS Score: A measure of the severity of the vulnerability according the National
Vulnerability Database.
Identification (Trend Micro rules only)
l Type: Can be either Smart (one or more known and unknown (zero day) vulnerabilities),
Exploit (a specific exploit, usually signature based), or Vulnerability (a specific vulnerability
for which one or more exploits may exist).
l Issued: The date the rule was released. This does not indicate when the rule was
downloaded.
l Last Updated: The last time the rule was modified either locally or during Security Update
download.
l Identifier: The rule's unique identification tag.
See information about the associated vulnerability (Trend Micro rules only)
Rules that Trend Micro provides can include information about the vulnerability against which
the rule protects. When applicable, the Common Vulnerability Scoring System (CVSS) is
displayed. (For information on this scoring system, see the CVSS page at the National
Vulnerability Database.)
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Vulnerabilities tab.
629
Trend Micro Deep Security On-Premise 20
Assign and unassign rules
To apply intrusion prevention rules during agent scans, you assign them to the appropriate
policies and computers. When the rule is no longer necessary because the vulnerability has
been patched you can unassign the rule.
If you cannot unassign intrusion prevention rules from a Computer editor 1, it is likely because
the rules are currently assigned in a policy. Rules assigned at the policy level must be removed
using the Policy editor 2 and cannot be removed at the computer level.
When you make a change to a policy, it affects all computers using the policy. For example,
when you unassign a rule from a policy you remove the rule from all computers that are
protected by that policy. To continue to apply the rule to other computers, create a new policy for
that group of computers. (See "Policies, inheritance, and overrides" on page 451.)
Tip: To see the policies and computers to which a rule is assigned, see the Assigned To tab of
the rule properties.
1. Go to the Policies page, right-click the policy to configure and click Details.
2. Click Intrusion Prevention > General.
The list of rules that are assigned to the policy appear in the Assigned Intrusion
Prevention Rules list.
3. Under Assigned Intrusion Prevention Rules, click Assign/Unassign.
4. To assign a rule, select the check box next to the rule.
5. To unassign a rule, deselect the check box next to the rule.
6. Click OK.
Automatically assign updated required rules
Security updates can include new or updated application types and intrusion prevention rules
which require the assignment of secondary intrusion prevention rules. Deep Security can
automatically assign these rules if they are required. You enable these automatic assignments in
the the policy or computer properties.
1. Go to the Policies page, right-click the policy to configure and click Details.
2. Click Intrusion Prevention > Advanced.
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
2To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
630
Trend Micro Deep Security On-Premise 20
3. To enable the automatic assignments, in the Rule Updates area, select Yes.
4. Click OK.
Configure event logging for rules
Configure whether events are logged for a rule, and whether to include packet data in the log.
Note: Deep Security can display X-Forwarded-For headers in intrusion prevention events
when they are available in the packet data. This information can be useful when the Deep
Security Agent is behind a load balancer or proxy. The X-Forwarded-For header data appears
in the event's Properties window. To include the header data, include packet data in the log. In
addition, rule 1006540 " Enable X-Forwarded-For HTTP Header Logging" must be assigned.
Because it would be impractical to record all packet data every time a rule triggers an event,
Deep Security records the data only the first time the event occurs within a specified period of
time. The default time is five minutes, however you can change the time period using the "Period
for Log only one packet within period" property of a policy's Advanced Network Engine settings.
(See Advanced Network Engine Options.)
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on
page 634.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. On the General tab, go to the Events area and select the desired options:
l To disable logging for the rule, select Disable Event Logging.
l To log an event when a packet is dropped or blocked, select Generate Event on
Packet Drop.
l To include the packet data in the log entry, select Always Include Packet Data.
l To log several packets that precede and follow the packet that the rule detected, select
Enable Debug Mode.Use debug mode only when your support provider instructs you
to do so.
Additionally, to include packet data in the log, the policy to which the rule is assigned must allow
rules to capture packet data:
1. On the Policies page, open the policy that is assigned the rule.
2. Click Intrusion Prevention > Advanced.
3. In the Event Data area, select Yes.
631
Trend Micro Deep Security On-Premise 20
Generate alerts
Generate an alert when an intrusion prevention rule triggers an event.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on
page 634.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Options tab, and in the Alert area select On.
4. Click OK.
Setting configuration options (Trend Micro rules only)
Some intrusion prevention rules that Trend Micro provides have one or more configuration
options such as header length, allowed extensions for HTTP, or cookie length. Some options
require you to configure them. If you assign a rule without setting a required option, an alert is
generated that informs you about the required option. (This also applies to any rules that are
downloaded and automatically applied by way of a Security Update.)
Intrusion prevention rules that have configuration options appear in the Intrusion Prevention
Rules list with a small gear over their icon .
Note: Custom intrusion prevention rules that you write yourself include a Rules tab where you
can edit the rules.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on
page 634.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Configuration tab.
4. Configure the properties and then click OK.
Schedule active times
Schedule a time during which an intrusion prevention rule is active. Intrusion prevention rules
that are active only at scheduled times appear in the Intrusion Prevention Rules page with a
small clock over their icon .
632
Trend Micro Deep Security On-Premise 20
Note: With Agent-based protection, schedules use the same time zone as the endpoint
operating system. With Agentless protection, schedules use the same time zone as the Deep
Security Virtual Appliance. Agentless protection is not available with Deep Security as a
Service.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on the
next page.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Options tab.
4. In the Schedule area, select New or select a frequency.
5. Edit the schedule as required.
6. Click OK.
Exclude from recommendations
Exclude intrusion prevention rules from rule recommendations of recommendation scans.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on the
next page.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Optionstab.
4. In the Recommendations Options area, select Exclude from Recommendations.
5. Click OK.
Set the context for a rule
Set the context in which the rule is applied.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" on the
next page.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Click the Options tab.
4. In the Context area, select New or select a context.
633
Trend Micro Deep Security On-Premise 20
5. Edit the context as required.
6. Click OK.
Override the behavior mode for a rule
Set the behavior mode of an intrusion prevention rule to Detect when testing new rules. In Detect
mode, the rule creates a log entry prefaced with the words "detect only:" and does not interfere
with traffic. Some intrusion prevention rules are designed to operate only in Detect mode. For
these rules, you cannot change the behavior mode.
Note: If you disable logging for the rule, the rule activity is not logged regardless of the
behavior mode.
For more information about behavior modes, see "Use behavior modes to test rules" on
page 617.
The configuration performed in the following procedure affects all policies. For information about
configuring a rule for one policy, see "Override rule and application type configurations" below.
1. Click Policies > Intrusion Prevention Rules.
2. Select a rule and click Properties.
3. Select Detect Only.
Override rule and application type configurations
From a Computer or Policy editor 1 , you can edit an intrusion prevention rule so that your
changes apply only in the context of the policy or computer. You can also edit the rule so that the
changes apply globally so that the changes affect other policies and computers that are
assigned the rule. Similarly, you can configure application types for a single policy or computer,
or globally.
1. Go to the Policies page, right-click the policy to configure and click Details.
2. Click Intrusion Prevention.
3. To edit a rule, right-click the rule and select one of the following commands:
l Properties: Edit the rule only for the policy.
l Properties (Global): Edit the rule globally, for all policies and computers.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
634
Trend Micro Deep Security On-Premise 20
4. To edit the application type of a rule, right-click the rule and select one of the following
commands:
l Application Type Properties: Edit the application type only for the policy.
l Application Type Properties (Global): Edit the application type globally, for all policies
and computers.
5. Click OK.
Tip: When you select the rule and click Properties, you are editing the rule only for the policy
that you are editing.
Note: You cannot assign one port to more than eight application types. If they are, the rules
will not function on that port.
Export and import rules
You can export one or more intrusion prevention rules to an XML or CSV file, and import rules
from an XML file.
1. Click Policies > Intrusion Prevention Rules.
2. To export one or more rules, select them and click Export > Export Selected to CSV or
Export > Export Selected to XML.
3. To export all rules, click Export > Export to CSV or Export > Export to XML.
4. To import rules, click New > Import From File and follow the instructions on the wizard.
Configure an SQL injection prevention rule
Deep Security's intrusion prevention module includes a built-in rule that detects SQL injection
attacks and drops the connection or logs it depending on its characteristics. The rule is called
1000608 - Generic SQL Injection Prevention and can be configured to suit your organization's
needs. For example, you can change the sensitivity of the rule by modifying the drop threshold.
Topics in this article:
635
Trend Micro Deep Security On-Premise 20
l "What is an SQL injection attack?" below
l "What are common characters and strings used in SQL injection attacks?" below
l "How does the Generic SQL Injection Prevention rule work?" on page 638
l "Examples of the rule and scoring system in action" on page 639
l "Configure the Generic SQL Injection Prevention rule" on page 641
l "Character encoding guidelines" on page 644
What is an SQL injection attack?
An SQL injection attack, or SQL phishing attack, is a method of attacking data-driven
applications wherein an attacker includes portions of SQL statements in an entry field. The
newly-formed rogue SQL command is passed by the website to your database where it is
executed. The command can result in the attacker being able to read, add, delete, or change
information in the database.
What are common characters and strings used in SQL injection attacks?
Here are some commonly used characters and strings. The list is not exhaustive.
l ('
l %27
l \x22
l %22
l char
l ;
l ascii
l %3B
l %2B
l --
l %2D%2D
l /*
l %2F%2A
l */
l %2A%2F
l substring
636
Trend Micro Deep Security On-Premise 20
l drop table
l drop+table
l insert into
l insert+into
l version(
l values
l group by
l group+by
l create table
l create+table
l delete
l update
l bulk insert
l bulk+insert
l load_file
l shutdown
l union
l having
l select
l declare
l exec
l and
l or
l like
l @@hostname
l @@tmpdir
l is null
l is+null
l is not null
l is+not+null
l %3D
637
Trend Micro Deep Security On-Premise 20
l CONCAT
l %40%40basedir
l version%28,user(
l user%28,system_user(
l (,%28,)
l %29
l @
l %40
l cast
How does the Generic SQL Injection Prevention rule work?
To detect SQL injection attacks, the Generic SQL Injection Prevention rule uses a scoring
system. It works like this:
1. Packets from your application arrive at the Deep Security Agent for analysis.
2. The Generic SQL Injection Prevention rule looks at the packets and determines whether
any of the strings shown in the table below are present. Notice that the strings are
separated by commas and divided into ten groups.
3. If strings are found, a score is calculated as follows:
l If a single string is found, then the score associated with its group constitutes the total
score.
l If multiple strings are found in different groups, then the scores of those groups are
added together.
l If multiple strings are found in the same group, then the score of that group is counted
only once.
See "Examples of the rule and scoring system in action" on the next page for
clarification.
4. Using the total score, Deep Security determines whether to drop the connection or log it. If
the total score exceeds the Drop Threshold score, then the connection is dropped, and if it
exceeds the Log Threshold score, then it is logged.
Note: Trend Micro frequently updates its rules, so the strings in the table below might not
match exactly the ones in Deep Security Manager.
Note: The use of '\W' in the lines below means 'followed by a non-alphanumeric character'.
638
Trend Micro Deep Security On-Premise 20
Sco
Group
re
drop table,drop+table,insert into,insert+into,values\W,create
2
table,create+table,delete\W,update\W,bulk insert,bulk+insert,shutdown\W,from\W
declare\W,select\W 2
cast\W,exec\W,load_file 2
union\W,group by,group+by,order by,order+by,having\W 2
and\W,or\W,like\W,is null,is+null,is not null,is+not+null,where\W 1
--,%2D%2D,/*,%2F%2A,*/,%2A%2F 1
',%27,\x22,%22,char\W 1
;,%3B 1
%2B,CONCAT\W 1
%3D 1
(,%28,),%29,@,%40 1
ascii,substring 1
version(,version%28,user(,user%28,system_user(,system_user%28,database
(,database%28,@@hostname,%40%40hostname,@@basedir,%40%40basedir,@@t 2
mpdir,%40%40tmpdir,
@@datadir,%40%40datadir
Examples of the rule and scoring system in action
Below are some examples of how the scores are tallied and what actions are undertaken in
each scenario.
Example 1: Logged and dropped traffic
Let's assume you are using this rule configuration (where the score for the group comes after the
colon (":")):
639
Trend Micro Deep Security On-Premise 20
drop table,drop+table,insert into,insert+into,values\W,create
table,create+table,delete\W,update\W,bulk
insert,bulk+insert,shutdown\W,from\W:2
declare\W,select\W:2
cast\W,exec\W,load_file:2
union\W,group by,group+by,order by,order+by,having\W:2
and\W,or\W,like\W,is null,is+null,is not null,is+not+null,where\W:1
--,%2D%2D,/*,%2F%2A,*/,%2A%2F:1
',%27,\x22,%22,char\W:1
;,%3B:1
%2B,CONCAT\W:1
%3D:1
(,%28,),%29,@,%40:1
ascii,substring:1
version(,version%28,user(,user%28,system_user(,system_user%28,databas
(,database%28,@@hostname,%40%40hostname,@@basedir,%40%40basedir,@@tmpdir,%
40%40tmpdir,@@datadir,
%40%40datadir:2
Log Threshold: 3
Drop Threshold: 4
And this attack string is encountered:
productID=BB10735166+UNION/**/+SELECT+FROM+user
Then the total score is 5 (2+1+0+2) because:
l The string UNION/ matches the fourth group for a score of 2.
l The string /* matches the sixth group for a score of 1.
l The string */ matches the sixth group for a score of 0 (because the score of the sixth group
has already been counted).
l The string SELECT+ matches the second group for a score of 2.
With a total score of 5, a log is generated and the traffic is dropped.
Example 2: No logged or dropped traffic
Let's assume you are using this rule configuration (where the select\W string has been moved
to the same line as union\W):
640
Trend Micro Deep Security On-Premise 20
drop table,drop+table,insert into,insert+into,values\W,create
table,create+table,delete\W,update\W,bulk
insert,bulk+insert,shutdown\W,from\W:2
declare\W:2
cast\W,exec\W,load_file:2
union\W,select\W,group by,group+by,order by,order+by,having\W:2
and\W,or\W,like\W,is null,is+null,is not null,is+not+null,where\W:1
--,%2D%2D,/*,%2F%2A,*/,%2A%2F:1
',%27,\x22,%22,char\W:1
;,%3B:1
%2B,CONCAT\W:1
%3D:1
(,%28,),%29,@,%40:1
ascii,substring:1
version(,version%28,user(,user%28,system_user(,system_user%28,databas
(,database%28,@@hostname,%40%40hostname,@@basedir,%40%40basedir,@@tmpdir,
%40%40tmpdir,@@datadir,%40%40datadir:2
Log Threshold: 3
Drop Threshold: 4
And this attack string is encountered:
productID=BB10735166+UNION/**/+SELECT+FROM+user
Then the total score is 3 (2+1+0+0) because:
l The string UNION/ matches the fourth group for a score of 2.
l The string /* matches the sixth group for a score of 1.
l The string */ matches the sixth group for a score of 0 (because the score of the sixth group
has already been counted).
l The string SELECT+ matches the fourth group for a score of 0 (because the score of the
fourth group has already been counted).
With a total score of 3, no log is generated and no traffic is dropped. The score must exceed the
thresholds for them to take effect.
Configure the Generic SQL Injection Prevention rule
You can configure the Generic SQL Injection Prevention rule to suit your organization's needs.
The configurable options are shown in the image below.
641
Trend Micro Deep Security On-Premise 20
642
Trend Micro Deep Security On-Premise 20
To configure the rule:
1. Log in to Deep Security Manager.
2. At the top, click Policies.
3. In the search box on the right, enter 1000608 which is the Generic SQL Injection
Prevention rule's numeric identifier. Press Enter. The rule appears in the main pane.
4. Double-click the rule.
5. Click the Configuration tab. You see the SQL injection pattern in the text box at the top.
6. Update the SQL injection pattern with the latest version, if you haven't customized it yet. To
update to the latest pattern, go to the Details tab, copy the text under the Default
SQL Pattern heading and paste it into the SQL Injection Patterns text box on the
Configuration tab. You are now working with the most up-to-date pattern from Trend Micro.
7. Edit the fields as follows:
l SQL Injection Patterns: This is where you to specify the list of characters and strings
used in SQL injection attacks. Characters and strings are grouped and assigned a
score. If you want to add or change the strings, make sure to use the proper encoding.
See "Character encoding guidelines" on the next page below for details.
l Drop Threshold: This is where you specify the drop score. The connection is dropped
when the score exceeds this threshold. (If the score equals the drop threshold, the
connection is maintained.) The default is 4.
l Log Threshold: This is where you specify the log score. The connection is logged
when the score exceeds this threshold. (If the score equals the log threshold, nothing
is logged.) The default is 4.
l Max distance between matches: This is where you specify the number of bytes that
can pass without a match to reset the score to 0. The default is 35.
l
Note: Consider using the next two options to create overrides for pages and fields
that might cause the normal thresholds to be exceeded.
l Pages (resource) with a non-default score to drop on: This is where you can override
the Drop Threshold for specific resources. For example, if your Drop Threshold is 4,
but you want a drop score of 8 for a questionnaire page, specify
/example/questionnaire.html:8. With this configuration,
/example/questionnaire.html needs to have a score higher than 8 in order for the
connection to be dropped, while all other resources only need a score higher than 4.
Specify each resource on a separate line.
l Form parameters with a non-default score to drop on: This is where you can override
the thresholds defined in Drop Threshold or the Pages (resources)with a non-default
643
Trend Micro Deep Security On-Premise 20
score to drop on fields for specific form fields. For example, if your Drop Threshold
score is 4, but you want a higher drop score of 10 for a username field, specify
/example/login.html:username=10, where /example/login.html is replaced
with the path and name of the page where the username field appears, and username
is replaced with the username field used by your application. With this configuration,
the username field needs to have a score higher than 10 for the connection to be
dropped, while the page itself only needs a score higher than 4. Specify each form
field on a separate line.
Note: The Log Threshold does not take effect when connections are dropped due
to a match on the Pages (resources) with a non-default score to drop on or Form
parameters with a non-default score to drop on fields. For example, if you set the
form parameter field to /example/login.html:username=10, and the username
field scores 11, the connection is dropped but there is no log of this event.
8. Click OK.
You have now configured the Generic SQL Injection Prevention rule.
Character encoding guidelines
If you want to change or add strings to the Generic SQL Injection Prevention rule, you must
encode them properly. For example, if you want to use the quote character ' in your pattern,
you must enter \x22.
The table below shows characters and their encoded equivalents, as well as character classes
that you can use to denote extended patterns.
Enter this
To denote...
string...
alphabetic characters, a-z A-Z
\a non-alphabetic characters
\A example: delete\a means "the word 'delete' followed by alphabetical
characters"
\w alphanumeric characters, a-z A-Z 0-9
\W non-alphanumeric characters
644
Trend Micro Deep Security On-Premise 20
Enter this
To denote...
string...
example: delete\W means "the word 'delete' followed by non-alphanumeric
characters"
digits 0-9
\d non-digit characters
\D example: delete\d means "the word 'delete' followed by digits between zero
and nine"
whitespace
\s
not whitespace [\r,\n,\t,0x32]
\S
example: delete\S means "the word 'delete' followed by non-whitespace"
punctuation character, printable ascii other than above
\p non-punctuation character
\P example: delete\p means "the word 'delete' followed by a punctuation
character or printable ascii"
control character, below 32, or greater than or equal to 127, not including
\c whitespace
\C non-control character
You can find details on control characters here.
\. any
\xDD hex byte 0xDD
\x2c comma character (,)
\x22 double-quotes character (")
\\ escaped backslash (\)
645
Trend Micro Deep Security On-Premise 20
Enter this
To denote...
string...
\| escaped pipe (|)
|xx xx xx...| hex pipe (byte sequence)
Application types
The applications defined by Application Types are identified by the direction of traffic, the
protocol being used, and the port number through which the traffic passes. Application Types are
useful for grouping intrusion prevention rules.that have a common purpose. Rule groups simplify
the process of selecting a set of intrusion prevention rules to assign to a computer. For example,
consider the set of rules required to protect HTTP traffic to an Oracle Report Server. Simply
select the rules in the "Web Server Common" and "Web Server Oracle Report Server"
application types and then exclude unneeded rules, such as the rules that are specific to IIS
servers.
See a list of application types
Open the list of application types where you can see the properties of existing application types,
as well as configure, export, and duplicate them. You can export to XML or CSV files. You can
import XML files. You can also create and delete application types.
1. Click Policies > Intrusion Prevention Rules.
2. Click Application Types.
3. To apply a command to an application type, select the type and click the appropriate
button.
Tip: Application types that have configurable properties have an icon with a gear.
See also "Override rule and application type configurations" on page 634.
646
Trend Micro Deep Security On-Premise 20
General Information
The name and description of the Application Type. "Minimum Agent/Appliance Version" tells
you what version of the Deep Security agent or appliance1 is required to support this Application
Type.
Connection
l Direction: The direction of the initiating communication. That is, the direction of the first
packet that establishes a connection between two computers. For example, if you wanted
to define an Application Type for Web browsers, you would select "Outgoing" because it is
the Web browser that sends the first packet to a server to establish a connection (even
though you may only want to examine traffic traveling from the server to the browser). The
Intrusion Prevention Rules associated with a particular Application Type can be written to
examine individual packets traveling in either direction.
l Protocol: The protocol this Application Type applies to.
l Port: The port(s) this Application Type monitors. (Not the port(s) over which traffic is
exclusively allowed.)
Configuration
The Configuration tab displays options that control how Intrusion Prevention Rules associated
with this Application Type behave. For example, the "Web Server Common" Application Type
has an option to "Monitor responses from Web Server". If this option is deselected, Intrusion
Prevention Rules associated with this Application Type will not inspect response traffic.
Options
Items in the Options tab control how the Deep Security Manager uses and applies the
Application Type. For example, most Application Types have an option to exclude them from
Recommendation Scans. This means that if the "Exclude from Recommendations" options is
selected, a Recommendation Scan will not recommend this Application Type and its associated
Intrusion Prevention Rules for a computer even if the application in question is detected.
Assigned To
The Assigned To tab lists the Intrusion Prevention Rules associated with this Application Type.
1The Deep Securty Agent and Deep Security Virtual Appliance are the components that enforce the Deep Security policies that you have
defined. Agents are deployed directly on a computer. Appliances are used in VMware vSphere environments to provide agentless protection.
They are not available with Deep Security as a Service.
647
Trend Micro Deep Security On-Premise 20
Inspect SSL or TLS traffic
For the intrusion prevention module, you can configure SSL inspection for a given credential-
port pair on one or more interfaces of your protected computer.
Note: Compressed traffic does not support SSL inspection.
Credentials can be imported in PKCS#12 or PEM format. The credential file must include the
private key. Windows computers can use CryptoAPI directly.
For an overview of the intrusion prevention module, see "About Intrusion Prevention" on
page 615.
In this topic:
l "Configure SSL inspection" below
l "Change port settings" on the next page
l "Use Intrusion Prevention when traffic is encrypted with Perfect Forward Secrecy (PFS)"
on page 650
l "Supported cipher suites" on page 651
l "Supported protocols" on page 652
Configure SSL inspection
1. In Deep Security Manager, select the computer to configure and click Details to open the
computer editor.
2. In the left pane of the computer editor, click Intrusion Prevention > Advanced > View SSL
Configurations, and click View SSL Configurations to open the SSL computer
Configurations window.
3. Click New to open the SSL Configuration wizard.
4. Specify the interface to which to apply the configuration on this computer:
l To apply to all interfaces on this computer, select All Interface(s).
l To apply to specific interfaces, select Specific Interface(s).
5. Select Port(s) or Ports List and select a list, then click Next.
6. On the IP Selection screen, select All IPs or provide a Specific IP on which to perform SSL
inspection, then click Next.
648
Trend Micro Deep Security On-Premise 20
7. On the Credentials screen, select how to provide the credentials:
l I will upload credentials now
l The credentials are on the computer
Note: The credential file must include the private key.
8. If you chose the option to upload credentials now, enter their type, location, and pass
phrase (if required).
If the credentials are on the computer, provide Credential Details.
l If you are using PEM or PKCS#12 credential formats stored on the computer, identify
the location of the credential file and the file's pass phrase (if required).
l If you are using Windows CryptoAPI credentials, choose the credentials from the list of
credentials found on the computer.
9. Provide a name and description for this configuration.
10. Review the summary and close the SSL Configuration Wizard. Read the summary of the
configuration operation and click Finish to close the wizard.
Change port settings
Change the port settings for the computer to ensure that the agent is performing the appropriate
Intrusion Prevention filtering on the SSL-enabled ports. The changes you make are applied to a
specific application type, such as Web Server Common, on the agent computer. The changes do
not affect the application type on other computers.
1. Go to Intrusion Prevention Rules in the computer's Details window to see the list of
Intrusion Prevention rules being applied on this computer.
2. Sort the rules by Application Type and locate the "Web Server Common" application type.
(You can perform these changes to similar application types as well.)
3. Right-click a rule in the application type and click Application Type Properties.
4. Override the inherited "HTTP" Port List so that you include the port you defined during the
SSL Configuration setup as well as port 80. Enter the ports as comma-separated values.
For example, if you use port 9090 in the SSL configuration, enter 9090, 80.
5. To improve performance, on the Configuration tab, deselect Inherited and Monitor
responses from Web Server.
6. Click OK to close the dialog.
649
Trend Micro Deep Security On-Premise 20
Use Intrusion Prevention when traffic is encrypted with Perfect Forward
Secrecy (PFS)
Perfect Forward Secrecy (PFS) can be used to create a communication channel that cannot be
decrypted if, at a later time, the server's private key is compromised. Since the intent of Perfect
Forward Secrecy is to prevent decryption after the session is over, it also prevents
SSL inspection through the Intrusion Prevention module.
To work around this issue, we recommend you do the following:
1. Use Perfect Forward Secrecy for TLS traffic between the Internet and your load balancer
(or reverse proxy).
2. Terminate the Perfect Forward Secrecy session at your load balancer (or reverse proxy).
3. Use a non-PFS cipher suite (see "Supported cipher suites" on the next page below) for
traffic between the load balancer (or reverse proxy) and the web server or application
server, so that the Intrusion Prevention module on the server can decrypt the TLS sessions
and inspect them.
4. Restrict traffic to the web server for application server ports that do not use Perfect Forward
Secrecy.
Special considerations for Diffie-Hellman ciphers
Perfect Forward Secrecy relies on the Diffie-Hellman key exchange algorithm. On some web
servers, Diffie-Hellman might be the default, which means that SSL inspection won't work
properly. It is therefore important to check the server's configuration file and disable Diffie-
Hellman ciphers for TLS traffic between the web server and load balancer (or reverse proxy). For
example, to disable Diffie-Hellman on an Apache server:
1. Open the server's configuration file. The file name and location of web server configuration
files vary by operating system (OS) and distribution. For example, the path could be:
l Default installation on RHEL4: /etc/httpd/conf.d/ssl.conf
l Apache 2.2.2 on Red Hat Linux: /apache2/conf/extra/httpd-ssl.conf
2. In the configuration file, find the " SSLCipherSuite " variable.
3. Add !DH:!EDH:!ADH: to these fields, if this string does not already appear. (The " ! " tells
Apache to "not" use this cipher.)
4. For example, you might edit the Apache configuration file's cipher suite to look like this:
SSLCipherSuite
!DH:!EDH:!ADH:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP:+eNULL
650
Trend Micro Deep Security On-Premise 20
For more information, see the Apache Documentation for SSLCipherSuite :
http://httpd.apache.org/docs/2.0/mod/mod_ssl.html#sslciphersuite.
Supported cipher suites
Hex Value OpenSSL Name IANA Name NSS Name
TLS_RSA_WITH_RC4_ SSL_RSA_WITH_RC4_
0x00,0x04 RC4-MD5
128_MD5 128_MD5
TLS_RSA_WITH_RC4_ SSL_RSA_WITH_RC4_
0x00,0x05 RC4-SHA
128_SHA 128_SHA
DES-CBC- TLS_RSA_WITH_DES_ SSL_RSA_WITH_DES_
0x00,0x09
SHA CBC_SHA CBC_SHA
DES-CBC3- TLS_RSA_WITH_3DES_ SSL_RSA_WITH_3DES_
0x00,0x0A
SHA EDE_CBC_SHA EDE_CBC_SHA
TLS_RSA_WITH_AES_ TLS_RSA_WITH_AES_
0x00,0x2F AES128-SHA
128_CBC_SHA 128_CBC_SHA
TLS_RSA_WITH_AES_ TLS_RSA_WITH_AES_
0x00,0x35 AES256-SHA
256_CBC_SHA 256_CBC_SHA
AES128- TLS_RSA_WITH_AES_ TLS_RSA_WITH_AES_
0x00,0x3C
SHA256 128_CBC_SHA256 128_CBC_SHA256
AES256- TLS_RSA_WITH_AES_ TLS_RSA_WITH_AES_
0x00,0x3D
SHA256 256_CBC_SHA256 256_CBC_SHA256
TLS_RSA_WITH_ TLS_RSA_WITH_
CAMELLIA128-
0x00,0x41 CAMELLIA_128_CBC_ CAMELLIA_128_CBC_
SHA
SHA SHA
TLS_RSA_WITH_ TLS_RSA_WITH_
CAMELLIA256-
0x00,0x84 CAMELLIA_256_CBC_ CAMELLIA_256_CBC_
SHA
SHA SHA
651
Trend Micro Deep Security On-Premise 20
Hex Value OpenSSL Name IANA Name NSS Name
TLS_RSA_WITH_ TLS_RSA_WITH_
CAMELLIA128-
0x00,0xBA CAMELLIA_128_CBC_ CAMELLIA_128_CBC_
SHA256
SHA256 SHA256
TLS_RSA_WITH_ TLS_RSA_WITH_
not
0x00,0xC0 CAMELLIA_256_CBC_ CAMELLIA_256_CBC_
implemented
SHA256 SHA256
Supported protocols
The following protocols are supported:
l SSL 3.0
l TLS 1.0
l TLS 1.1
l TLS 1.2
Configure anti-evasion settings
Anti-evasion settings control the network engine handling of abnormal packets that may be
attempting to evade analysis. Anti evasion settings are configured in a policy or an individual
computer. The Security Posture setting controls how rigorous intrusion prevention analyzes
packets, and can be set to one of the following values:
l Normal: Prevents the evasion of intrusion prevention rules without false positives. This is
the default value.
l Strict: Performs more stringent checking than Normal mode but can produce some false-
positive results. Strict mode is useful for penetration testing but should not be enabled
under normal circumstances.
l Custom: If you select Custom, additional settings are available that enable you to specify
how Deep Security will handle issues with packets. For these settings (with the exception
of TCP Timestamp PAWS Window), the options are Allow (Deep Security sends the
packet through to the system), Log Only (same behavior as Allow, but an event is logged),
Deny (Deep Security drops the packet and logs an event), or Deny Silent (same behavior
as Deny, but no event is logged):
652
Trend Micro Deep Security On-Premise 20
Note: If you changed the posture to "Custom" in Deep Security 10.1 or earlier, all default
values for the anti-evasion settings were set to "Deny". This led to a dramatic increase in
block events. The default custom values have changed in Deep Security 10.2, as
indicated in the table below.
Default
Default
custom
Normal custom
Setting Description Strict value value
value value (10.2
(pre-
or later)
10.2)
Ignore Ignore
and Log and Log
Invalid TCP Action to take when a TCP (same (same
Deny Deny
Timestamps timestamp is too old function function
as Log as Log
Only) Only)
Packets can have
timestamps. When a
timestamp has an earlier
timestamp than the one that
came before it, it can be
suspicious. The tolerance for
the difference in timestamps
depends on the operating 1 for 1 for 1 for
TCP
system. For Windows Linux Linux Linux
Timestamp
systems, select 0 (the system agents, agents, 0 agents,
PAWS
will only accept packets with otherwise otherwise otherwise
Window
a timestamp that is equal to 0 0 0
or newer than the previous
packet). For Linux systems,
select 1 (the system will
accept packets with a
timestamp that is a maximum
of one second earlier than
the previous packet).
Deny for Deny for Deny for
Linux Linux Linux
Timestamp
Action to take when a TCP agents or agents or agents or
PAWS Zero Deny
timestamp is zero NDIS5, NDIS5, NDIS5,
Allowed
otherwise otherwise otherwise
Allow Allow Allow
653
Trend Micro Deep Security On-Premise 20
Default
Default
custom
Normal custom
Setting Description Strict value value
value value (10.2
(pre-
or later)
10.2)
Fragmented Action to take when a packet
Allow Allow Deny Allow
Packets is fragmented
TCP Zero Action to take when a packet
Deny Deny Deny Deny
Flags has zero flags set
TCP
Action to take when a packet
Congestion Allow Allow Deny Allow
has congestion flags set
Flags
TCP Urgent Action to take when a packet
Allow Deny Deny Allow
Flags has urgent flags set
Action to take when a packet
TCP Syn
has both SYN and FIN flags Deny Deny Deny Deny
Fin Flags
set
Action to take when a packet
TCP Syn
has both SYN and RST flags Deny Deny Deny Deny
Rst Flags
set
Action to take when a packet
TCP Rst
has both RST and FIN flags Deny Deny Deny Deny
Fin Flags
set
Action to take when a packet
TCP Syn
has a SYN flag set and also Deny Deny Deny Deny
with Data
contains data
Action to take when a SYN is
TCP Split
received instead of SYN- Deny Deny Deny Deny
Handshake
ACK, as a reply to a SYN.
RST Packet Action to take for a RST
Out of packet without a known Allow Deny Deny Allow
Connection connection
FIN Packet Action to take for a FIN
Out of packet without a known Allow Deny Deny Allow
654
Trend Micro Deep Security On-Premise 20
Default
Default
custom
Normal custom
Setting Description Strict value value
value value (10.2
(pre-
or later)
10.2)
Connection connection
OUT Packet Action to take for an outgoing
Out of packet without a known Allow Deny Deny Allow
Connection connection
Action to take for a packet
Evasive
with duplicated or Allow Deny Deny Allow
Retransmit
overlapping data
TCP Action to take for a packet
Allow Deny Deny Allow
Checksum with an invalid checksum
Performance tips for intrusion prevention
To improve system resources utilization on Deep Security Agent, optimize certain performance-
related settings.
For an overview of the intrusion prevention module, see "About Intrusion Prevention" on
page 615.
System
Settings that impact performance
resource
l Log an event when a packet is dropped or blocked. Logging packet
modifications may result in a lot of log entries. (See "Configure event
logging for rules" on page 631)
l Include packet data in the event log only during troubleshooting. (See
CPU usage "Configure event logging for rules" on page 631)
l Assign only intrusion prevention rules that apply to the computer's OS
and applications. See "Manage and run recommendation scans" on
page 456 for information about using recommendation scans to discover
applicable vulnerabilities and rules.
l Don't assign more than 300 rules.
655
Trend Micro Deep Security On-Premise 20
System
Settings that impact performance
resource
l Log an event when a packet is dropped or blocked. Logging packet
modifications may result in a lot of log entries. (See "Configure event
logging for rules" on page 631)
l Include packet data in the event log only during troubleshooting. (See
"Configure event logging for rules" on page 631)
Network l Do not monitor HTTP responses from the web server, especially if the
usage or policy has many signatures applied:
throughput
a. Click Policies > Intrusion Prevention Rules.
b. Right-click a rule in the Web Server Common application type and
click Application Type Properties.
c. On the Configuration tab, deselect Inherited and Monitor
responses from Web Server.
Disk usage l Include packet data in the event log only during troubleshooting. (See
"Configure event logging for rules" on page 631)
Maximum size for configuration packages
When an agent is assigned a large number of intrusion prevention rules, the size of the
configuration package can exceed the maximum allowed size. When the allowed size is
exceeded, the status of the agent changes to "Agent configuration package too large" and the
event message "Configuration package too large" appears.
Note: There is a configuration limit of 20 MB in Windows 32-bit platform because it has
smaller kernel memory available. For other platforms, the limit is 32 MB.
For performance reasons, you should have less than 350 intrusion prevention rules assigned to
a computer. To minimize the number of required rules, ensure all available patches are applied
to the computer operation system and any third-party software that is installed.
1. Apply available patches to the computer operating system.
2. Apply available patches to any third-party software that is installed.
656
Trend Micro Deep Security On-Premise 20
3. Apply only the intrusion prevention rules that a recommendation scan recommends.
Remove any rules from the computer or the assigned policy that are recommended for
unassignment. (See "Manage and run recommendation scans" on page 456.)
4. If you are managing intrusion prevention at the policy level and the configuration package
is still too large, configure intrusion prevention in one of the following ways:
l Make the policy more granular, so that all servers in that policy have the same
operating system and applications.
l Manage intrusion prevention at the server level so that rules are added and removed
automatically for the computer.
Use the following procedure to manage intrusion prevention at the server level.
1. Open the editor for the policy that is assigned to the computer.
2. Click Intrusion Prevention > General.
3. In the Recommendations section, set Automatically implement Intrusion Prevention
Recommendations (when possible) to Yes.
4. Remove any intrusion prevention rules from the policy.
5. Run a recommendation scan on the computer.
Configure Firewall
About Firewall
The firewall module provides bidirectional stateful inspection of incoming and outgoing traffic.
Firewall rules define what actions to take on individual packets in that traffic. Packets can be
filtered by IP and MAC address, port and packet flag across all IP-based protocols and frame
types. The firewall module can also help prevent denial of service attacks and detect and
prevent reconnaissance scans.
To enable and configure the firewall, see "Set up the Deep Security firewall" on the next page.
Firewall rules
Firewall rules can process traffic using one of the following actions, listed in order of
precedence:
l Bypass
l Log Only
l Force Allow
657
Trend Micro Deep Security On-Premise 20
l Deny
l Allow
Rules also have a priority level between 4 (highest priority) to 0 (lowest priority). Within a specific
priority level rules are processed in order based on the precedence of the action type of the rule
as listed above. This means that unlike what you may have experienced when configuring other
firewalls, the Deep Security firewall processes rules independently of their assignment order.
For more information on how rule priorities and actions determine processing order, see
"Firewall rule actions and priorities" on page 678.
For more detailed information on how to create firewall rules, see "Create a firewall rule" on
page 671.
Note: When creating your rules, make sure to test them using the Tap and Inline modes of the
firewall module before deploying them. For information on how to do so, see the "Test firewall
rules before deploying them" section of "Set up the Deep Security firewall" below.
Set up the Deep Security firewall
The Deep Security Firewall is a highly flexible Firewall that you can configure to be restrictive or
permissive. Like the intrusion prevention and web reputation modules, the Firewall module can
also be run in two modes: inline or tap. It is recommended that you test your Firewall rules in tap
mode and then switch to inline mode when everything is working correctly.
The configuration and administration of your Firewall must be performed carefully and there is
no one set of rules that fits all environments. Make sure you understand the Firewall rule actions
and rule priorities before creating your rules and proceed with extra caution when creating Allow
rules because they implicitly deny everything else not defined.
In this article:
l "Test Firewall rules before deploying them" on the next page
l "Enable 'fail open' behavior" on page 660
l "Turn on Firewall " on page 662
l "Default Firewall rules" on page 662
l "Restrictive or permissive Firewall design" on page 664
l "Firewall rule actions" on page 664
658
Trend Micro Deep Security On-Premise 20
l "Firewall rule priorities" on page 665
l "Recommended Firewall policy rules" on page 666
l "Test Firewall rules" on page 667
l "Reconnaissance scans" on page 668
l "Stateful inspection" on page 669
l "Example" on page 669
l "Important things to remember" on page 670
Test Firewall rules before deploying them
The Firewall module (as well as the intrusion prevention and web reputation modules) includes
a Deep Security network engine that decides whether to block or allow packets. For the Firewall
and intrusion prevention modules, the network engine performs a packet sanity check and also
makes sure each packet passes the Firewall and intrusion prevention rules. The network engine
operates in one of two modes:
l Tap mode: Packet streams are not modified. The traffic is still processed by the Firewall
and/or intrusion prevention modules, if they are enabled. However any issues detected do
not result in packet or connection drops. When in Tap mode, Deep Security offers no
protection beyond providing a record of events.
l Inline mode: Packet streams pass directly through the Deep Security network engine. All
rules are applied to the network traffic before they proceed up the protocol stack.
It’s important to test your Firewall rules in either Tap mode or Inline mode with the action for the
rules set to Log Only before deploying them. This allows you to preview the effect of the rules on
traffic, without any action being taken. If rules aren’t properly tested before deployment, all traffic
could become blocked and your computer could become inaccessible.
Test in Tap mode
Tap mode allows you to test your Firewall rules, without disturbing the flow of traffic.
1. Go to Computers or Policies in the Deep Security Manager.
2. Right-click a computer (or policy) and select Details to open the Computer or Policy
editor 1.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
659
Trend Micro Deep Security On-Premise 20
3. Go to Settings > Advanced > Network Engine Mode.
4. Select Tap from the list and click Save.
5. Create your rules and click OK. To check your rules, go to Events & Reports > Events >
Firewall Events.
Note: It is not necessary to set the action of the rule to Log Only in Tap mode.
Once you are satisfied with your Firewall rules, go back to the Computer or Policy editor 1, select
Inline from the drop-down list, and click Save.
Test in Inline mode
In most situations, Tap mode is a good way to test your Firewall rules without disturbing traffic.
However, you can also test your rules in Inline mode, if the action of the rule is set to Log Only.
This way, the real world process of analyzing the traffic takes place without having to perform
any action, such as blocking or denying packets.
1. Go to Computers or Policies in the Deep Security Manager.
2. Right-click a computer (or policy) and select Details to open the Computer or Policy
editor 2.
3. Go to Settings > Advanced > Network Engine Mode.
4. Select Inline from the drop down menu and click Save.
5. While you’re creating your rule, ensure the action is set to Log Only.
6. To check your rules, go to Events & Reports > Events > Firewall Events.
Once you are satisfied with your Firewall rules, change the action from Log Only to your desired
action and click OK.
Enable 'fail open' behavior
In some cases, the network engine blocks packets before the Firewall rules (or intrusion
prevention rules) can be applied. By default, the network engine blocks packets if the:
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
660
Trend Micro Deep Security On-Premise 20
l agent or virtual appliance has a system problem, such as if it's out of memory
l packet sanity check fails
This 'fail closed' behavior offers a high level of security: it ensures that cyber attacks cannot
penetrate your network when an agent or virtual appliance is not functioning properly, and
safeguards against potentially malicious packets. The disadvantage to 'fail closed' is that your
services and applications might become unavailable because of problems on the agent or virtual
appliance. You might also experience performance issues if a large number of packets are being
dropped unnecessarily as a result of the packet sanity check (too many false-positives).
If you have concerns about service availability, consider changing the default behavior to allow
packets through (or 'fail open') for system and packet check failures, as explained below.
1. Go to Computers or Policies in the Deep Security Manager.
2. Right-click a computer (or policy) and select Details to open the Computer or Policy
editor 1.
3. Click Settings on the left.
4. Click the Advanced tab.
5. Under Network Engine Settings, set the Failure Response settings as follows:
6. Set Network Engine System Failure to Fail open to allow packets through if the Deep
Security network engine experiences problems, such as out-of-memory failures, allocated
memory failures, and network engine deep packet inspection (DPI) decoding failures.
Consider using fail open here if your agent or virtual appliance frequently encounters
network exceptions because of heavy loads or a lack of resources. With fail open, the
network engine allows the packet through, does not perform Intrusion Prevention rules
checking, and logs an event. Your services and applications remain available despite the
problems on the agent or virtual appliance.
7. Set Network Packet Sanity Check Failure to Fail open to allow packets through that fail
the network engine's packet sanity checks. Examples of packet sanity checks: Firewall
sanity checks, network layer 2, 3, or 4 attribute checks, and TCP state checks. Consider
using fail open here if you want to perform Intrusion Prevention rules checking only on
'good' packets that pass the sanity check. With fail open, the network engine allows the
failed packet through, does not perform Intrusion Prevention rules checking on it, and logs
an event.
8. Click Save.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
661
Trend Micro Deep Security On-Premise 20
You have now enabled fail open behavior for system or packet check failures.
Turn on Firewall
To enable Firewall functionality on a computer:
1. In the Computer or Policy editor 1, go to Firewall > General.
2. With Deep Security Agent 11.1 and earlier, the Firewall module inspects traffic that passes
through the host computer's network interface to containers. With Deep Security Agent
11.2 or later, it can also inspect traffic between containers. When the Scan container
network traffic setting is set to Yes, Deep Security scans the traffic that goes through both
containers and hosts. When it is set to No, Deep Security scans only the traffic that goes
through the host network interface.
3. Select On and then click Save.
Default Firewall rules
No outbound rules are assigned to the policies that come with Deep Security by default but
several recommended inbound rules are. You can view the default inbound rules assigned to
each policy by going to the Firewall tab in the relevant operating system policy. The example
below shows the default assigned Firewall rules for the Windows 10 Desktop policy. You can
configure these Firewall rules to meet the needs of your environment, but we have provided
several default rules for you to get you started.
Tip: To minimize the impact on system performance, try not to assign more than 300 Firewall
rules. It is also good practice to document all Firewall rule changes in the "Description" field of
the Firewall rule. Make a note of when and why rules were created or deleted for easier
Firewall maintenance.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
662
Trend Micro Deep Security On-Premise 20
Default Bypass rule for Deep Security Manager Traffic
The Deep Security Manager automatically implements a Priority 4 Bypass Rule that opens the
listening port number of the agent for heartbeats on computers running Deep Security Agent. A
priority of 4 ensures that this rule is applied before any Deny rule, and Bypass guarantees that
the traffic is never impaired. The Bypass rule is not explicitly shown in the Firewall rule list
because the rule is created internally.
This rule, however, accepts traffic from any IP address and any MAC address. To harden the
Deep Security Agent's listening ports, you can create an alternative, more restrictive, Bypass
rule for this port. The agent will override the default Deep Security Manager traffic rule with the
new custom rule if it has these settings:
l Priority: 4 - Highest
l Packet direction: Incoming
l Frame type: IP
663
Trend Micro Deep Security On-Premise 20
l Protocol: TCP
l Packet Destination Port: Agent's listening port for heartbeats
The custom rule must use the above parameters to replace the default rule. Ideally, the IP
address or MAC address of the actual Deep Security Manager should be used as the packet
source for the rule.
Restrictive or permissive Firewall design
Typically, Firewall policies are based on one of two design strategies. Either they permit any
service unless it is expressly denied or they deny all services unless expressly allowed. It is best
practice to decide what type of Firewall you would like to implement. This helps reduce
administrative overhead in terms of creating and maintaining the rules.
Restrictive Firewall
A restrictive Firewall is the recommended best practice from a security perspective. All traffic is
stopped by default and only traffic that has been explicitly allowed is permitted. If the primary
goal of your planned Firewall is to block unauthorized access, the emphasis needs to be on
restricting rather than enabling connectivity. A restrictive Firewall is easier to maintain and more
secured. Allow rules are used only to permit certain traffic across the Firewall and deny
everything else.
Note: As soon as you assign a single outgoing Allow rule, the outgoing Firewall will operate
in restrictive mode. This is also true for the inbound Firewall: as soon as you assign a single
incoming Allow rule, the inbound Firewall will operate in restrictive mode.
Permissive Firewall
A permissive Firewall permits all traffic by default and only blocks traffic believed to be malicious
based on signatures or other information. A permissive Firewall is easy to implement but it
provides minimal security and requires complex rules. Deny rules are used to explicitly block
traffic.
Firewall rule actions
You can configure the Firewall to take the following actions:
Warning: If you assign only incoming rules, all outgoing traffic will be allowed. If you assign a
single outgoing Allow rule, the outgoing Firewall will operate in restrictive mode. There is one
664
Trend Micro Deep Security On-Premise 20
exception to this: ICMPv6 traffic is always permitted unless it is specifically blocked by a Deny
rule.
Explicitly allows traffic that matches the rule to pass and then implicitly denies
everything else.
Note: You should use an Allow action with caution because it implicitly denies
everything else not defined. Be careful when creating Allow rules without
Allow
defining the related rules correctly because doing so can cause all traffic to be
blocked except for the traffic that the Allow rule is created for. Traffic that is not
explicitly allowed by an Allow rule is dropped and gets recorded as a 'Out of
"allowed" Policy' Firewall event.
Allows traffic to bypass both Firewall and intrusion prevention analysis. Bypass
rules should always be created in pairs (for both incoming and outgoing traffic). A
Bypass rule can be based on IP, port, traffic direction, and protocol.
Bypass
The Bypass rule is designed for media-intensive protocols or traffic originating
from trusted sources.
Deny Explicitly blocks traffic that matches the rule.
If a packet matches a force allow rule, it is passed but still filtered by intrusion
Force prevention. No events are logged.
Allow
This type of Firewall rule action must be used for UDP and ICMP traffic.
Log
Traffic will only be logged. No other action will be taken.
only
For more information on how to create a Firewall rule, see "Create a firewall rule" on page 671.
Firewall rule priorities
Rule priority determines the order in which filters are applied. This means that high priority rules
get applied before low priority rules. When actions share the same priority, the orders of
precedence for rules are: Bypass, Force Allow, and then Deny. However, a Deny action with a
higher priority will take precedence over a Bypass action with a lower priority. For more
665
Trend Micro Deep Security On-Premise 20
information on how rule priorities and actions determine processing order, see "Firewall rule
actions and priorities" on page 678.
To simplify the administration of Firewall rules, consider reserving certain priority levels for
specific actions. For example, apply a default of priority 3 to rules that use Bypass, priority 2 for
Force Allow rules, and priority 1 for Deny rules. This reduces the potential for rule conflicts.
Allow rules
Allow rules can only have a priority of 0. This is to ensure it is processed after all Force Allow
and Deny rules at higher priorities. Keep this in mind when using Allow rules to implicitly deny
traffic (any traffic not matching the Allow rules are denied). This means that when a Deny rule is
assigned, it will take precedence over all of the existing assigned Allow rules.
Force Allow rules
Force Allow rules are recommended for traffic that must always be allowed, such as Address
Resolution Protocol (ARP). The Force Allow action only acts as a trump card to a deny rule at
the same or higher priority. For example, if you have a Deny rule at priority 3 that prevents
access to an allowed port number from the 10.0.0.0/8 subnet, and you want to allow host
10.102.12.56 to access that, you must create a Force Allow rule at priority 3 or 4 to trump the
Deny rule at priority 3. Once a packet triggers this rule, it is immediately allowed and the lower
priority rules will not process it anymore.
Bypass rules
The Bypass rule is a special type of rule that allows a packet to bypass both the Firewall and
Deep Packet Inspection (DPI) engines. This rule must be priority 4 and created in pairs, one rule
for each traffic direction.
Recommended Firewall policy rules
We recommend that you make the following rules mandatory for all of your Firewall policies:
l ARP: Allows incoming ARP requests so that the computer can reply to queries for its MAC
address. If you do not assign this rule, no devices on the network can query the host for its
MAC address and it will be inaccessible from the network.
l Allow solicited TCP/UDP replies: Allows the computer to receive replies to its own TCP
connections and UDP messages. This works in conjunction with TCP and UDP stateful
Firewall configuration.
666
Trend Micro Deep Security On-Premise 20
l Allow solicited ICMP replies: Allows the computer to receive replies to its own ICMP
messages. This works in conjunction with ICMP stateful Firewall configuration.
l DNS Server: Allows DNS servers to receive inbound DNS queries.
l Remote Access RDP: Allows the computer to accept Remote Desktop connections.
l Remote Access SSH: Allows the computer to accept SSH connections.
Test Firewall rules
Before continuing with further Firewall configuration steps, test the recommended Firewall rules
to ensure they're working correctly.
Test the remote access SSH rule:
1. Try to establish a SSH connection to the computer. If the Firewall is enabled and the
Remote Access SSH rule is not enabled, the connection will be denied. Go to Events &
Reports > Firewall Events to view the denied event.
2. Go to the Computer or Policy editor 1 > Firewall. Under Assigned Firewall Rules, click
Assign/Unassign.
3. Search for Remote Access SSH and enable the rule. Click OK and Save.
4. Try to establish a SSH connection to the computer. The connection should be allowed.
Test the remote access RDP rule:
1. Try to establish a RDP connection to the computer. If the Firewall is enabled and the
Remote Access RDP rule is not enabled, the connection will be denied. Go to Events &
Reports > Firewall events to view the denied event.
2. Go to the Computer or Policy editor 2 > Firewall. Under Assigned Firewall Rules, click
Assign/Unassign.
3. Search for Remote Access RDP and enable the rule. Click OK and Save.
4. Try to establish a RDP connection to the computer. The connection should be allowed.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
667
Trend Micro Deep Security On-Premise 20
Reconnaissance scans
You can configure the Firewall to detect possible reconnaissance scans and help prevent
attacks by blocking traffic from the source IPs for a period of time. Once an attack has been
detected, you can instruct agents and appliances to block traffic from the source IPs for a period
of time. Use the Block Traffic lists on the on the Policy or Computer Editor > Firewall >
Reconnaissance tab to set the number of minutes.
l Computer OS Fingerprint Probe: The agent or appliance detects an attempt to discover
the computer's OS.
l Network or Port Scan: The agent or appliance reports a network or port scan if it detects
that a remote IP is visiting an abnormal ratio of IPs to ports. Normally, an agent or
appliance computer will only see traffic destined for itself, so a port scan is the most
common type of probe that will be detected. The statistical analysis method used in
computer or port scan detection is derived from the "TAPS" algorithm proposed in the
paper "Connectionless Port Scan Detection on the Backbone" presented at IPCCC in
2006.
l TCP Null Scan: The agent or appliance detects packages with no flags set.
l TCP SYNFIN Scan: The agent or appliance detects packets with only the SYN and FIN
flags set.
l TCP Xmas Scan: The agent or appliance detects packets with only the FIN, URG, and
PSH flags set or a value of 0xFF (every possible flag set).
For each type of attack, the agent or appliance can be instructed to send the information to the
Deep Security Manager where an alert will be triggered by selecting the option Notify DSM
Immediately. For this option to work, the agents and appliances must be configured for agent or
appliance-initiated or bidirectional communication in Policy / Computer Editor > Settings >
General > Communication Direction. If enabled, the agent or appliance will initiate a heartbeat
to the Deep Security Manager immediately upon detecting the attack or probe.
Note: If you want to enable reconnaissance protection, you must also enable the Firewall and
stateful inspection on the Policy or Computer Editor > Firewall > General tab. You should also
go to the Policy or Computer Editor > Firewall > Advanced tab and enable the Generate
Firewall Events for packets that are 'Out of Allowed Policy' setting. This will generate Firewall
events that are required for reconnaissance.
Note: The reconnaissance scans detection requires there to be at least one active Firewall
rule assigned to the policy of the agent.
668
Trend Micro Deep Security On-Premise 20
For information on how to handle reconnaissance warnings, see "Warning: Reconnaissance
Detected" on page 1079.
Stateful inspection
Deep Security Firewall stateful configuration mechanism should be enabled when the Firewall
is on. This mechanism analyzes each packet in the context of traffic history, correctness of TCP
and IP header values, and TCP connection state transitions. In the case of stateless protocols
like UDP and ICMP, a pseudo-stateful mechanism is implemented based on historical traffic
analysis.
Packets are handled by the stateful mechanism as follows:
1. A packet is passed to the stateful routine if it has been allowed through by the static
Firewall rule conditions.
2. The packet is examined to determine whether it belongs to an existing connection.
3. The TCP header is examined for correctness (for example, sequence numbers, flag
combinations, and so on).
The Deep Security Firewall stateful configuration enables protection against attacks such as
denial of service, provided that a default configuration with stateful TCP, ICMP, or UDP protocol
is enabled and only solicited replies are allowed. If the UDP stateful option is enabled, Force
Allow must be used when running UDP servers (for example, DHCP). If there is no DNS or
WINS server configured for the Deep Security Agents, a Force Allow Incoming UDP Ports 137
rule might be required for NetBIOS.
Stateful logging should be disabled unless required for ICMP or UDP protocols.
Example
This is an example of how a simple Firewall policy can be created for a web server:
1. Enable stateful inspection for TCP, UDP, and ICMP using a global Firewall stateful
configuration with these options enabled.
2. Add a Firewall rule to allow TCP and UDP replies to requests originated on the
workstation. To do this create an incoming Allow rule with the protocol set to TCP + UDP
and select Not and Syn under Specific Flags. At this point the policy only allows TCP and
UDP packets that are replies to requests initiated by a user on the workstation. For
example, in conjunction with the stateful analysis options enabled in step 1, this rule
allows a user on this computer to perform DNS lookups (via UDP) and to browse the Web
via HTTP (TCP).
669
Trend Micro Deep Security On-Premise 20
3. Add a Firewall rule to allow ICMP replies to requests originated on the workstation. To do
this, create an incoming Allow rule with the protocol set to ICMP and select the Any Flags
check box. This means that a user on this computer can ping other workstations and
receive a reply but other users will not be able to ping this computer.
4. Add a Firewall rule to allow incoming TCP traffic to port 80 and 443 with the Syn check box
checked in the Specific Flags section. This means that external users can access a Web
server on this computer.
At this point we have a basic Firewall policy that allows solicited TCP, UDP and ICMP
replies and external access to the Web server on this computer all other incoming traffic is
denied.
For an example of how Deny and Force Allow rule actions can be used to further refine this
policy consider how we may want to restrict traffic from other computers in the network. For
example, we may want to allow access to the Web server on this computer to internal
users but deny access from any computers that are in the DMZ. This can be done by
adding a Deny rule to prohibit access from servers in the DMZ IP range.
5. Add a Deny rule for incoming TCP traffic with source IP 10.0.0.0/24 which is the IP range
assigned to computers in the DMZ. This rule denies any traffic from computers in the DMZ
to this computer.
We may, however, want to refine this policy further to allow incoming traffic from the mail
server which resides in the DMZ.
6. Use a Force Allow for incoming TCP traffic from source IP 10.0.0.100. This Force Allow
overrides the Deny rule we created in the previous step to permit traffic from this one
computer in the DMZ.
Important things to remember
l All traffic is first checked against Firewall rules before being analyzed by the stateful
inspection engine. If the traffic clears the Firewall rules, the traffic is then analyzed by the
stateful inspection engine (provided stateful inspection is enabled in the Firewall Stateful
Configuration).
l Allow rules are prohibitive. Anything not specified in the Allow rules is automatically
dropped. This includes traffic of other frame types so you need to remember to include
rules to allow other types of required traffic. For example, don't forget to include a rule to
allow ARP traffic if static ARP tables are not in use.
670
Trend Micro Deep Security On-Premise 20
l If UDP stateful inspection is enabled a Force Allow rule must be used to allow unsolicited
UDP traffic. For example, if UDP stateful inspection is enabled on a DNS server then a
Force Allow for port 53 is required to allow the server to accept incoming DNS requests.
l If ICMP stateful inspection is enabled a Force Allow rule must be used to allow unsolicited
ICMP traffic. For example, if you wish to allow outside ping requests a Force Allow rule for
ICMP type 3 (Echo Request) is required.
l A Force Allow acts as a trump card only within the same priority context.
l If you do not have a DNS or WINS server configured (which is common in test
environments) a "Force Allow incoming UDP port 137" rule may be required for NetBIOS
(Windows shares).
Note: When troubleshooting a new Firewall policy the first thing you should do is check the
Firewall rule logs on the agent or appliance1. The Firewall rule logs contain all the information
you need to determine what traffic is being denied so that you can further refine your policy as
required.
Create a firewall rule
Firewall rules examine the control information in individual packets, and either block or allow
them according to the criteria that you define. Firewall rules can be assigned to a policy or
directly to a computer.
Note: This article specifically covers how to create a firewall rule. For information on how to
configure the firewall module, see "Set up the Deep Security firewall" on page 658.
To create a new firewall rule, you need to:
1. "Add a new rule" on the next page.
2. "Select the behavior and protocol of the rule" on the next page.
3. "Select a Packet Source and Packet Destination" on page 674.
When you're done with your firewall rule, you can also learn how to:
1The Deep Securty Agent and Deep Security Virtual Appliance are the components that enforce the Deep Security policies that you have
defined. Agents are deployed directly on a computer. Appliances are used in VMware vSphere environments to provide agentless protection.
They are not available with Deep Security as a Service.
671
Trend Micro Deep Security On-Premise 20
l "Configure rule events and alerts" on page 676
l "Set a schedule for the rule" on page 676
l "See policies and computers a rule is assigned to" on page 676
l "Assign a context to the rule " on page 676
Add a new rule
There are three ways to add a new firewall rule on the Policies > Common Objects > Rules >
Firewall Rules page. You can:
l Create a new rule. Click New > New Firewall Rule.
l Import a rule from an XML file. Click New > Import From File.
l Copy and then modify an existing rule. Right-click the rule in the Firewall Rules list and
then click Duplicate. To edit the new rule, select it and then click Properties.
Select the behavior and protocol of the rule
1. Enter a Name and Description for the rule.
Tip: It is good practice to document all firewall rule changes in the Description field of the
firewall rule. Make a note of when and why rules were created or deleted for easier
firewall maintenance.
2. Select the Action that the rule should perform on packets. You can select from one of the
following five actions:
Note: Only one rule action is applied to a packet, and rules (of the same priority) are
applied in the order of precedence listed below.
l The rule can allow traffic to bypass the firewall. A bypass rule allows traffic to pass
through the firewall and intrusion prevention engine at the fastest possible rate.
Bypass rules are meant for traffic using media intensive protocols where filtering may
not be desired or for traffic originating from trusted sources.
Tip: For an example of how to create and use a bypass rule for trusted sources in a
policy, see "Allow trusted traffic to bypass the firewall" on page 677.
672
Trend Micro Deep Security On-Premise 20
Note: Bypass rules are unidirectional. Explicit rules are required for each direction
of traffic.
Tip: You can achieve maximum throughput performance on a bypass rule with the
following settings:
l Priority: Highest
l Frame Type: IP
l Protocol: TCP, UDP, or other IP protocol. (Do not use the "Any" option.)
l Source and Destination IP and MAC: all "Any"
l If the protocol is TCP or UDP and the traffic direction is "incoming", the
destination ports must be one or more specified ports (not "Any"), and the source
ports must be "Any".
l If the protocol is TCP or UDP and the traffic direction is "outgoing", the source
ports must be one or more specified ports (Not "Any"), and the destination ports
must be "Any".
l Schedule: None.
l The rule can log only. This action will make entries in the logs but will not process
traffic.
l The rule can force allow defined traffic (it will allow traffic defined by this rule without
excluding any other traffic.)
l The rule can deny traffic (it will deny traffic defined by this rule.)
l The rule can allow traffic (it will exclusively allow traffic defined by this rule.)
Note: If you have no allow rules in effect on a computer, all traffic is permitted unless it is
specifically blocked by a deny rule. Once you create a single allow rule, all other traffic is
blocked unless it meets the requirements of the allow rule. There is one exception to this:
ICMPv6 traffic is always permitted unless it is specifically blocked by a deny rule.
3. Select the Priority of the rule. The priority determines the order in which rules are applied.
If you have selected "force allow", "deny", or "bypass" as your rule action, you can set a
priority of 0 (low) to 4 (highest). Setting a priority allows you to combine the actions of rules
to achieve a cascading rule effect.
673
Trend Micro Deep Security On-Premise 20
Note: Log only rules can only have a priority of 4, and Allow rules can only have a
priority of 0.
Note: High priority rules get applied before low priority rules. For example, a port 80
incoming deny rule with a priority of 3 will drop a packet before a port 80 incoming force
allow rule with a priority of 2 gets applied to it.
For detailed information on how actions and priority work together, see "Firewall rule
actions and priorities" on page 678.
4. Select a Packet Direction. Select whether this rule will be applied to incoming (from the
network to the computer) or outgoing(from the computer to the network) traffic.
Note: An individual firewall rule only apply to a single direction of traffic. You may need
to create incoming and outgoing firewall rules in pairs for specific types of traffic.
5. Select an Ethernet Frame Type. The term "frame" refers to Ethernet frames, and the
available protocols specify the data that the frame carries. If you select "Other" as the frame
type, you need to specify a frame number.
6. Note: IP covers both IPv4 and IPv6. You can also select IPv4 or IPv6 individually
Note: On Solaris, Deep Security Agents will only examine packets with an IP frame type,
and Linux Agents will only examine packets with IP or ARP frame types. Packets with
other frame types will be allowed through. Note that the Virtual Appliance does not have
these restrictions and can examine all frame types, regardless of the operating system of
the virtual machine it is protecting.
If you select the Internet Protocol (IP) frame type, you need to select the transport Protocol.
If you select "Other" as the protocol, you also need to enter a protocol number.
Select a Packet Source and Packet Destination
Select a combination of IP and MAC addresses, and if available for the frame type, Port and
Specific Flags for the Packet Source and Packet Destination.
Tip: You can use a previously created IP, MAC or port list.
Support for IP-based frame types is as follows:
674
Trend Micro Deep Security On-Premise 20
IP MAC Port Flags
Any ✔ ✔
ICMP ✔ ✔ ✔
ICMPV6 ✔ ✔ ✔
IGMP ✔ ✔
GGP ✔ ✔
TCP ✔ ✔ ✔ ✔
PUP ✔ ✔
UDP ✔ ✔ ✔
IDP ✔ ✔
ND ✔ ✔
RAW ✔ ✔
TCP+UDP ✔ ✔ ✔ ✔
Note: ARP and REVARP frame types only support using MAC addresses as packet sources
and destinations.
You can select Any Flags or individually select the following flags:
l URG
l ACK
l PSH
l RST
l SYN
l FIN
675
Trend Micro Deep Security On-Premise 20
Configure rule events and alerts
When a firewall rule is triggered, it logs an event in the Deep Security Manager and records the
packet data.
Note: Note that rules using the "Allow", "Force Allow" and "Bypass" actions will not log any
events.
Alerts
You can configure rules to also trigger an alert if they log an event. To do so, open the properties
for a rule, click on Options, and then select Alert when this rule logs an event.
Note: Only firewall rules with an action set to "Deny" or "Log Only" can be configured to trigger
an alert.
Set a schedule for the rule
Select whether the firewall rule should only be active during a scheduled time.
For more information on how to do so, see "Define a schedule that you can apply to rules" on
page 546.
Assign a context to the rule
Rule contexts allow you to set firewall rules uniquely for different network environments.
Contexts are commonly used to allow for different rules to be in effect for laptops when they are
on and off-site.
For more information on how to create a context, see "Define contexts for use in policies" on
page 540.
Tip: For an example of a policy that implements firewall rules using contexts, look at the
properties of the "Windows Mobile Laptop" Policy.
See policies and computers a rule is assigned to
You can see which policies and computers are assigned to a firewall rule on the Assigned To
tab. Click on a policy or computer in the list to see their properties.
676
Trend Micro Deep Security On-Premise 20
Export a rule
You can export all firewall rules to a .csv or .xml file by clicking Export and selecting the
corresponding export action from the list. You can also export specific rules by first selecting
them, clicking Export and then selecting the corresponding export action from the list.
Delete a rule
To delete a rule, right-click the rule in the Firewall Rules list, click Delete and then click OK.
Note: Firewall Rules that are assigned to one or more computers or that are part of a policy
cannot be deleted.
Allow trusted traffic to bypass the firewall
You can set up Deep Security to allow trusted traffic to bypass the firewall.
To configure this, the basic steps are as follows:
1. "Create a new IP list of trusted traffic sources" below
2. "Create incoming and outbound firewall rules for trusted traffic using the IP list" on the next
page
3. "Assign the firewall rules to a policy used by computers that trusted traffic flows through" on
the next page
After the firewall rules have been assigned to a policy, Deep Security will allow traffic from
trusted sources in the IP list and will not scan the traffic for stateful issues or vulnerabilities.
Create a new IP list of trusted traffic sources
1. Click Policies.
2. In the left pane, click Lists > IP Lists.
3. Click New > New IP List.
4. Enter a name for the IP list.
5. Paste the IP addresses for your trusted sources into the IP(s) box, one per line.
6. Click OK.
677
Trend Micro Deep Security On-Premise 20
Create incoming and outbound firewall rules for trusted traffic using the IP
list
1. Click Policies.
2. In the left pane, click Rules.
3. Click Firewall Rules > New > New Firewall Rule.
4. Create a firewall rule for incoming trusted traffic using the values in the below:
Name: source name Traffic - Incoming
Action: Bypass
Protocol: Any
Packet Source: IP List (select the IP list created above)
5. Create a firewall rule for outgoing trusted traffic using the values in the below:
Name: source name Traffic - Outgoing
Action: Bypass
Protocol: Any
Packet Destination: IP List (select the IP list created above)
Assign the firewall rules to a policy used by computers that trusted traffic
flows through
1. Click Policies.
2. In the left pane, click Policies.
3. Double-click a policy to open its properties window.
4. In the left pane of the policy's properties window, click Firewall.
5. Click Assign/Unassign.
6. Ensure your view at the top left shows All firewall rules.
7. Use the search window to find the rules you created and select them.
8. Click OK.
9. Repeat the steps above for each computer that trusted traffic flows through.
Firewall rule actions and priorities
In this article:
l "Firewall rule actions" on the next page
l "Firewall rule sequence" on page 681
l "How firewall rules work together" on page 683
678
Trend Micro Deep Security On-Premise 20
l "Rule priority" on page 684
l "Putting rule action and priority together" on page 684
Firewall rule actions
Firewall rules can take the following actions:
l Allow: Explicitly allows traffic that matches the rule to pass, and then implicitly denies
everything else.
l Bypass: Allows traffic to bypass both firewall and intrusion prevention analysis. Use this
setting for media-intensive protocols or for traffic originating from trusted sources. A bypass
rule can be based on IP, port, traffic direction, and protocol.
l Deny: Explicitly blocks traffic that matches the rule.
l Force Allow: Forcibly allows traffic that would otherwise be denied by other rules.
Note: Traffic permitted by a Force Allow rule will still be subject to analysis by the
intrusion prevention module.
l Log only: Traffic will only be logged. No other action will be taken.
More about Allow rules
Allow rules have two functions:
1. Permit traffic that is explicitly allowed.
2. Implicitly deny all other traffic.
Note: Traffic that is not explicitly allowed by an Allow rule is dropped, and gets recorded as an
'Out of "Allowed" Policy' firewall event.
Commonly applied Allow rules include:
l ARP: Permits incoming Address Resolution Protocol (ARP) traffic .
l Allow solicited TCP/UDP replies: Allow the computer to receive replies to its own TCP
and UDP messages. This works in conjunction with TCP and UDP stateful configuration.
l Allow solicited ICMP replies: Allow the computer to receive replies to its own ICMP
messages. This works in conjunction with ICMP stateful configuration.
679
Trend Micro Deep Security On-Premise 20
More about Bypass rules
The Bypass rule is designed for media-intensive protocols or for traffic originating from trusted
sources where filtering by the firewall or intrusion prevention modules is neither required nor
desired.
A packet that matches the conditions of a Bypass rule:
l Is not subject to conditions of stateful configuration settings.
l Bypasses both firewall and Intrusion prevention analysis.
Since stateful inspection is not applied to bypassed traffic, bypassing traffic in one direction does
not automatically bypass the response in the other direction. Bypass rules should always be
created and applied in pairs, one rule for incoming traffic and another for outgoing.
Note: Bypass rule events are not recorded. This is not a configurable behavior.
Tip: If the Deep Security Manager uses a remote database that is protected by a Deep
Security Agent, intrusion prevention-related false alarms may occur when the Deep Security
Manager saves intrusion prevention rules to the database. The contents of the rules
themselves could be misidentified as an attack. One of the workarounds for this is to create a
bypass rule for traffic from the Deep Security Manager to the database.
Default Bypass rule for Deep Security Manager traffic
The Deep Security Manager automatically implements a priority 4 Bypass rule that opens
incoming TCP traffic on the agent's listening port for heartbeats (see "Configure the heartbeat"
on page 1124) on computers running Deep Security Agent. Priority 4 ensures that this rule is
applied before any Deny rules, and Bypass guarantees that the traffic is never impaired. The
Bypass rule is not explicitly shown in the firewall rule list because the rule is created internally.
This rule, however, accepts traffic from any IP address and any MAC address. To harden the
agent's security on this port, you can create an alternative, more restrictive bypass rule for this
port. The agent will actually disable the default Deep Security Manager traffic rule in favor of the
new custom rule provided it has these characteristics:
l Priority: 4 - Highest
l Packet direction: Incoming
l Frame type: IP
680
Trend Micro Deep Security On-Premise 20
l Protocol: TCP
l Packet Destination Port: agent's listening port number for heartbeats from the Manager
The custom rule must use the above parameters to replace the default rule. Ideally, the IP
address or MAC address of the actual Deep Security Manager should be used as the packet
source for the rule.
More about Force Allow rules
The Force Allow option excludes a sub-set of traffic that could otherwise have been covered by
a Deny action. Its relationship to other actions is illustrated below. Force Allow has the same
effect as a Bypass rule. However, unlike Bypass, traffic that passes the firewall because of this
action is still subject to inspection by the intrusion prevention module. The Force Allow action is
particularly useful for making sure that essential network services are able to communicate with
the DSA computer. Generally, Force Allow rules should only be used in conjunction with Allow
and rules to Allow a subset of traffic that has been prohibited by the Allow and Deny rules. Force
Allow rules are also required to Allow unsolicited ICMP and UDP traffic when ICMP and UDP
stateful are enabled.
Note: When using multiple Deep Security Managers in a multi-node arrangement, it may be
useful to define an IP list for these servers, and then create a custom Deep Security Manager
traffic rule with that list.
Firewall rule sequence
Packets arriving at a computer get processed first by firewall rules, then the firewall stateful
configuration conditions, and finally by the intrusion prevention rules.
This is the order in which firewall rules are applied (incoming and outgoing):
1. Firewall rules with priority 4 (highest)
a. Bypass
b. Log Only (Log Only rules can only be assigned a priority of 4 (highest))
c. Force Allow
d. Deny
2. Firewall rules with priority 3 (high)
a. Bypass
b. Force Allow
c. Deny
681
Trend Micro Deep Security On-Premise 20
3. Firewall rules with priority 2 (normal)
a. Bypass
b. Force Allow
c. Deny
4. Firewall rules with priority 1 (low)
a. Bypass
b. Force Allow
c. Deny
5. Firewall rules with priority 0 (lowest)
a. Bypass
b. Force Allow
c. Deny
d. Allow(Note that an Allow rule can only be assigned a priority of 0 (lowest))
Note: If you have no Allow rules in effect on a computer, all traffic is permitted unless it is
specifically blocked by a Deny rule. Once you create a single Allow rule, all other traffic is
blocked unless it meets the conditions of the Allow rule. There is one exception to this: ICMPv6
traffic is always permitted unless it is specifically blocked by a Deny rule.
Within the same priority context, a Deny rule will override an Allow rule, and a Force Allow rule
will override a Deny rule. By using the rule priorities system, a higher priority Deny rule can be
made to override a lower priority Force Allow rule.
Consider the example of a DNS server policy that makes use of a Force Allow rule to Allow all
incoming DNS queries. Creating a Deny rule with a higher priority than the Force Allow rule lets
you specify a particular range of IP addresses that must be prohibited from accessing the same
public server.
Priority-based rule sets allow you set the order in which the rules are applied. If a Deny rule is
set with the highest priority, and there are no Force Allow rules with the same priority, then any
packet matching the Deny rule is automatically dropped and the remaining rules are ignored.
Conversely, if a Force Allow rule with the highest priority flag set exists, any incoming packets
matching the Force Allow rule will be automatically allowed through without being checked
against any other rules.
A note on logging
Bypass rules will never generate an event. This is not configurable.
Log Only rules will only generate an event if the packet in question is not subsequently stopped
by either:
682
Trend Micro Deep Security On-Premise 20
l a Deny rule, or
l an Allow rule that excludes it.
If the packet is stopped by one of those two rules, those rules will generate the Event and not the
Log Only rule. If no subsequent rules stop the packet, the Log Only rule will generate an event.
How firewall rules work together
Deep Security firewall rules have both a rule action and a rule priority. Used in conjunction,
these two properties allow you to create very flexible and powerful rule-sets. Unlike rule-sets
used by other firewalls, which may require that the rules be defined in the order in which they
should be run, Deep Security Firewall rules are run in a deterministic order based on the rule
action and the rule priority, which is independent of the order in which they are defined or
assigned.
Rule Action
Each rule can have one of four actions.
1. Bypass: if a packet matches a Bypass rule, it is passed through both the firewall and the
Intrusion Prevention Engine regardless of any other rule (at the same priority level).
2. Log Only: if a packet matches a Log Only rule it is passed and the event is logged.
3. Force Allow: if a packet matches a Force Allow rule it is passed regardless of any other
rules (at the same priority level).
4. Deny: if a packet matches a Deny rule it is dropped.
5. Allow: if a packet matches an Allow rule, it is passed. Any traffic not matching one of the
Allow rules is denied.
Implementing an Allow rule will cause all other traffic not specifically covered by the Allow rule to
be denied:
A Deny rule can be implemented over an Allow to block specific types of traffic:
683
Trend Micro Deep Security On-Premise 20
A Force Allow rule can be placed over the denied traffic to Allow certain exceptions to pass
through:
Rule priority
Rule actions of type Deny and Force Allow can be defined at any one of 5 priorities to allow
further refinement of the permitted traffic defined by the set of Allow rules. Rules are run in
priority order from highest (Priority 4) to lowest (Priority 0). Within a specific priority level the rules
are processed in order based on the rule action (Force Allow, Deny, Allow, log only).
The priority context Allows a User to successively refine traffic controls using Deny and Force
Allow rule combinations. Within the same priority context, an Allow rule can be negated with a
Deny rule, and a Deny rule can be negated by a Force Allow rule.
Note: Rule actions of type Allow run only at priority 0 while rule actions of type Log Only run
only at priority 4.
Putting rule action and priority together
Rules are run in priority order from highest (Priority 4) to lowest (Priority 0). Within a specific
priority level the rules are processed in order based on the rule action. The order in which rules
of equal priority are processed is as follows:
684
Trend Micro Deep Security On-Premise 20
l Bypass
l Log Only
l Force Allow
l Deny
l Allow
Note: Remember that rule actions of type Allow run only at priority 0 while rule actions of type
Log Only run only at priority 4.
Note: It is important to remember that if you have a Force Allow rule and a Deny rule at the
same priority the Force Allow rule takes precedence over the Deny rule and therefore traffic
matching the Force Allow rule will be permitted.
Firewall settings
The Firewall module provides bidirectional stateful firewall protection. It prevents denial of
service attacks and provides coverage for all IP-based protocols and frame types as well as
filtering for ports and IP and MAC addresses.
The Firewall section of the Computer or Policy editor 1 has the following tabbed sections:
l "General" on the next page
l "Interface Isolation" on page 687
l "Reconnaissance" on page 688
l "Advanced" on page 690
l "Events" on page 690
Note: This article includes references to the Deep Security Virtual Appliance, which is not
available with Deep Security as a Service.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
685
Trend Micro Deep Security On-Premise 20
General
Firewall
You can configure this policy or computer to inherit its firewall On/Off state from its parent policy
or you can lock the setting locally.
Firewall Stateful Configurations
Select which firewall stateful configuration to apply to this policy. If you have defined multiple
Interfaces for this policy (above), you can specify independent configurations for each interface.
For more information on creating a stateful configuration see "Define stateful firewall
configurations" on page 696.
Port Scan (Computer Editor only)
Last Port Scan: The last time that the Deep Security manager ran a port scan on this computer.
Scanned Ports: The ports that were scanned during the most recent port scan.
Open Ports: Listed beneath the IP address of the local computer will be a list of ports that were
found to be open.
The Scan For Open Ports and the Cancel Port Scan buttons let you initiate or cancel a port
scan on this computer. Deep Security Manager will scan the range of ports defined in Computer
or Policy editor 1 > Settings > General > Open Ports > Ports to Scan.
Note: Regardless of the ports configured to be scanned, Deep Security Manager will always
scan the agent or appliance's listening port number for heartbeat connections from the
Manager.
Assigned Firewall Rules
Displays the firewall rules that are in effect for this policy or computer. To add or remove firewall
rules, click Assign/Unassign This will display a window showing all available firewall rules from
which you can select or deselect rules.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
686
Trend Micro Deep Security On-Premise 20
From a Computer or Policy editor 1 window, you can edit a firewall rule so that your changes
apply only locally in the context of your editor, or you can edit the rule so that the changes apply
globally to all other policies and computers that are using the rule.
To edit the Rule locally, right-click the rule and click Properties.
To edit the Rule globally, right-click the rule and click Properties (Global).
For more information on creating firewall rules, see "Create a firewall rule" on page 671.
Interface Isolation
Interface Isolation
You can configure this policy or computer to inherit its Interface Isolation enabled or disabled
state from its parent policy or you can lock the setting locally.
Warning: Before you enable Interface Isolation make sure that you have configured the
interface patterns in the proper order and that you have removed or added all necessary string
patterns. Only interfaces matching the highest priority pattern will be permitted to transmit
traffic. Other interfaces (which match any of the remaining patterns on the list) will be
"restricted". Restricted Interfaces will block all traffic unless an Allow Firewall Rule is used to
allow specific traffic to pass through.
Interface Patterns
When Interface Isolation is enabled, the firewall will try to match the regular expression patterns
to interface names on the local computer.
Note: Deep Security uses POSIX basic regular expressions to match interface names. For
information on basic POSIX regular expressions, see
https://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap09.html#tag_09_03
Only interfaces matching the highest priority pattern will be permitted to transmit traffic. Other
interfaces (which match any of the remaining patterns on the list) will be "restricted". Restricted
Interfaces will block all traffic unless an Allow firewall rule is used to allow specific traffic to pass
through.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
687
Trend Micro Deep Security On-Premise 20
Selecting Limit to one active interface will restrict traffic to only a single interface (even if more
than one interface matches the highest priority pattern).
Reconnaissance
Reconnaissance Scans
The Reconnaissance page allows you to enable and configure traffic analysis settings on your
computers. This feature can detect possible reconnaissance scans that attackers often use to
discover weaknesses before beginning a targeted attack.
Note: Reconnaissance scans do not work in TAP mode. Reconnaissance scans can only be
detected on IPv4 traffic.
l Reconnaissance Scan Detection Enabled: Turn the ability to detect reconnaissance scans
on or off.
l Computers/Networks on which to perform detection: Choose from the list the IPs to
protect. Choose from existing IP Lists. (You can use the Policies > Common Objects >
Lists > IP Lists page to create an IP List specifically for this purpose.)
l Do not perform detection on traffic coming from: Select from a set of IP Lists which
computers and networks to ignore. (As above, you can use the Policies > Common
Objects > Lists > IP Lists page to create an IP List specifically for this purpose.)
Note: If you want to enable reconnaissance protection, you must also enable the Firewall and
Stateful Inspection on the Computer or Policy editor 1 > Firewall > General tab. You should
also go to the Computer or Policy editor 2 > Firewall > Advanced tab and enable the Generate
Firewall Events for packets that are 'Out of Allowed Policy' setting. This will generate firewall
events that are required for reconnaissance.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
688
Trend Micro Deep Security On-Premise 20
For each type of attack, the agent or appliance1 can be instructed to send the information to the
Deep Security Manager where an alert will be triggered. You can configure the Deep Security
Manager to send an email notification when the alerts are triggered. (See Administration >
System Settings > Alerts. The alerts are: "Network or Port Scan Detected", "Computer OS
Fingerprint Probe Detected", "TCP Null Scan Detected", "TCP FIN Scan Detected", and "TCP
Xmas Scan Detected.") Select Notify DSM Immediately for this option.
Note: For the "Notify DSM Immediately" option to work, the agents and appliances must be
configured for agent or appliance-initiated or bidirectional communication in Computer or
Policy editor 2 > Settings > General.) If enabled, the agent or appliance will initiate a heartbeat
to the Deep Security Manager immediately upon detecting the attack or probe.
Once an attack has been detected, you can instruct the agents and appliances to block traffic
from the source IPs for a period of time. Use the Block Traffic lists to set the number of minutes.
l Computer OS Fingerprint Probe: The agent or appliance detects an attempt to discover
the computers OS.
l Network or Port Scan: The agent or appliance reports a network or port scan if it detects
that a remote IP is visiting an abnormal ratio of IPs to ports. Normally, an agent or
appliance computer will only see traffic destined for itself, so a port scan is the most
common type of probe that will be detected. The statistical analysis method used in
computer or port scan detection is derived from the "TAPS" algorithm proposed in the
paper "Connectionless Port Scan Detection on the Backbone" presented at IPCCC in
2006.
l TCP Null Scan: The agent or appliance detects packages with no flags set.
l TCP SYNFIN Scan: The agent or appliance detects packets with only the SYN and FIN
flags set.
l TCP Xmas Scan: The agent or appliance detects packets with only the FIN, URG, and
PSH flags set or a value of 0xFF (every possible flag set).
1The Deep Securty Agent and Deep Security Virtual Appliance are the components that enforce the Deep Security policies that you have
defined. Agents are deployed directly on a computer. Appliances are used in VMware vSphere environments to provide agentless protection.
They are not available with Deep Security as a Service.
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
689
Trend Micro Deep Security On-Premise 20
Note: "Network or Port Scans" differs from the other types of reconnaissance in that it cannot
be recognized by a single packet and requires Deep Security to watch traffic for a period of
time.
The agent or appliance reports a computer or port scan if it detects that a remote IP is visiting
an abnormal ratio of IPs to ports. Normally an agent or appliance computer will only see traffic
destined for itself, so a port scan is by far the most common type of probe that will be detected.
However, if a computer is acting as a router or bridge it could see traffic destined for a number
of other computers, making it possible for the agent or appliance to detect a computer scan (ex.
scanning a whole subnet for computers with port 80 open).
Detecting these scans can take several seconds since the agent or appliance needs to be
able to track failed connections and decide that there are an abnormal number of failed
connections coming from a single computer in a relatively short period of time.
Note: Deep Security Agents running on Windows computers with browser applications may
occasionally report false-positive reconnaissance scans due to residual traffic arriving from
closed connections.
For information on how to handle reconnaissance warnings, see "Warning: Reconnaissance
Detected" on page 1079.
Advanced
Events
Set whether to generate events for packets that are "Out of Allowed Policy". These are packets
that have been blocked because they have not been specifically allowed by an Allow firewall
rule. Setting this option to Yes may generate a large number of events depending on the firewall
rules you have in effect.
Events
Firewall events are displayed the same way as they are in the main Deep Security Manager
window except that only events relating to this policy or specific computer are displayed.
Firewall settings with Oracle RAC
Deep Security supports Oracle RAC. For a list of supported versions of Oracle RAC, see
"Software requirements" on page 203.
690
Trend Micro Deep Security On-Premise 20
The default Linux Server Deep Security policy is compatible with the Oracle RAC environment,
with the exception of firewall settings. Because there are complex communication channels
between RAC nodes, the RAC nodes will fail to create a virtual NIC and scan the NIC, due to
firewall interference. As a result, Oracle Clusterware would fail to start on some nodes. You can
disable the firewall or customize the firewall settings.
Add a rule to allow communication between nodes
1. In the Deep Security Manager, go to the Policies tab.
2. Right-click the Linux Server policy and click Duplicate.
3. Click the new Linux Server_2 policy and click Details.
4. Give the policy a new name, for example, "Oracle RAC" and click Save.
5. Click Firewall.
6. Click Assign/Unassign.
7. Click New > New Firewall Rule.
8. Under General Information, set the Name to something descriptive, like "Allow
communication with Oracle nodes". Set Action to "Force Allow" and set Protocol to "Any".
9. Under Packet Source, set MAC to "MAC List". In the Select MAC List that appears, select
"New". A "New MAC List Properties" dialog box appears.
10. Give the MAC list a name, like "Oracle RAC MAC list". Under MAC(s): (One MAC per
line), add all of the MAC addresses used by all Oracle nodes (including MACs from both
private and public NICs). Click OK when finished.
11. Under Packet Destination, set MAC to "MAC List". In the Select MAC List that appears,
select the MAC list you created in step 10 and then click OK.
12. In the Firewall Rules list for the policy, ensure that this new rule is selected and click OK
and then click Save.
Add a rule to allow UDP port 42424
Follow the steps described in the procedure above to add a new rule that allows UDP port
42424. This port number is used by the Cluster Synchronization Service daemon (CSSD),
Oracle Grid Interprocess Communication (GIPCD) and Oracle HA Services daemon (OHASD).
Note: Please note that the MAC list that you created above may not be able to cover this rule.
This rule is essential for Oracle RAC.
691
Trend Micro Deep Security On-Premise 20
692
Trend Micro Deep Security On-Premise 20
Allow other RAC-related packets
Oracle RAC will send a very large number of packets with Frame Type C08A and 0ACB.
Blocking them may cause some unpredictable behavior.
l Allow TCP post 6200: Add the public IP addresses of the RAC nodes in the IP fields under
Packet Source and Packet Destination and set destination port to 6200. This port number
is used by Oracle Notification Services (ONS). This port is configurable, so check the value
on your system set the correct port number if it is something other than 6200.
693
Trend Micro Deep Security On-Premise 20
l Allow Frame Type C0A8: Add a rule with the Frame Type set to "Other" and the Frame no
set to "C0A8".
l Allow Frame Type 0ACB: Add a rule with the Frame Type set to "Other" and the Frame no
set to "0ACB".
l Allow Frame Type 0AC9: Add a rule with the Frame Type set to "Other" and the Frame no
set to "0AC9".
694
Trend Micro Deep Security On-Premise 20
l Allow IGMP protocol: Add a rule with the Protocol set to "IGMP".
Please refer to the following link to check whether there are additional RAC-related components
in your system that need extra firewall rules to allow certain ports:
https://docs.oracle.com/database/121/RILIN/ports.htm#RILIN1178
Ensure that the Oracle SQL Server rule is assigned
Check that the "Oracle SQL Server" Firewall rule is assigned to the Linux Server policy. This is a
pre-defined Deep Security Firewall rule that allows port 1521.
Ensure that anti-evasion settings are set to "Normal"
In the properties for the Linux Server policy, Settings > Network Engine > Anti-Evasion Settings
are set to "Normal" by default. If this setting is set to "Strict", the RAC database response will be
extremely slow.
695
Trend Micro Deep Security On-Premise 20
Define stateful firewall configurations
Deep Security's stateful firewall configuration mechanism analyzes each packet in the context of
traffic history, correctness of TCP and IP header values, and TCP connection state transitions. In
the case of stateless protocols like UDP and ICMP, a pseudo-stateful mechanism is
implemented based on historical traffic analysis. Packets are handled by the stateful mechanism
as follows:
1. A packet is passed to the stateful routine if it has been allowed through by the static firewall
rule conditions,
2. The packet is examined to determine whether it belongs to an existing connection, and
3. The TCP header is examined for correctness (e.g. sequence numbers, flag combinations,
etc.).
To create a new stateful configuration, you need to:
1. "Add a stateful configuration " on the next page.
2. "Enter stateful configuration information" on the next page.
3. "Select packet inspection options" on the next page.
When you're done with your stateful configuration, you can also learn how to
l "See policies and computers a stateful configuration is assigned to" on page 701
l "Export a stateful configuration " on page 701
696
Trend Micro Deep Security On-Premise 20
l "Delete a stateful configuration " on page 701
Add a stateful configuration
There are three ways to define a stateful configuration on the Policies > Common Objects >
Other > Firewall Stateful Configurations page:
l Create a new configuration. Click New > New Firewall Stateful Configuration.
l Import a configuration from an XML file. Click New > Import From File.
l Copy and then modify an existing configuration. Right-click the configuration in the
Firewall Stateful Configurations list and then click Duplicate. To edit the new configuration,
select it and then click Properties.
Enter stateful configuration information
Enter a Name and Description for the configuration.
Select packet inspection options
You can define options for IP, TCP, UDP and ICMP packet inspection, end enable Active or
Passive FTP.
IP packet inspection
Under the General tab, select the Deny all incoming fragmented packets to drop any
fragmented packets. Dropped packets will bypass fragmentation analysis and generate an "IP
fragmented packet" log entry. Packets with a total length smaller than the IP header length are
dropped silently.
Warning: Attackers sometimes create and send fragmented packets in an attempt to bypass
Firewall Rules.
Note: The Firewall Engine, by default, performs a series of checks on fragmented packets.
This is default behavior and cannot be reconfigured. Packets with the following characteristics
are dropped:
l Invalid fragmentation flags/offset: A packet is dropped when either the DF and MF flags
in the IP header are set to 1, or the header contains the DF flag set to 1 and an Offset
value different than 0.
697
Trend Micro Deep Security On-Premise 20
l First fragment too small: A packet is dropped if its MF flag is set to 1, its Offset value is
at 0, and it has total length of less than 120 bytes (the maximum combined header
length).
l IP fragment out of boundary: A packet is dropped if its Offset flag value combined with
the total packet length exceeds the maximum datagram length of 65535 bytes.
l IP fragment offset too small: A packet is dropped if it has a non-zero Offset flag with a
value that is smaller than 60 bytes.
TCP packet inspection
Under the TCP tab, select which of the following options you would like to enable:
l Deny TCP packets containing CWR, ECE flags: These flags are set when there is
network congestion.
Note: RFC 3168 defines two of the six bits from the Reserved field to be used for ECN
(Explicit Congestion Notification), as follows:
l Bits 8 to 15: CWR-ECE-URG-ACK-PSH-RST-SYN-FIN
l TCP Header Flags Bit Name Reference:
l Bit 8: CWR (Congestion Window Reduced) [RFC3168]
l Bit 9: ECE (ECN-Echo) [RFC3168]
Warning: Automated packet transmission (such as that generated by a denial of service
attack, among other things) will often produce packets in which these flags are set.
l Enable TCP stateful inspection: Enable stateful inspection at the TCP level. If you enable
stateful TCP inspection, the following options become available:
l Enable TCP stateful logging: TCP stateful inspection events will be logged.
l Limit the number of incoming connections from a single computer to: Limiting the
number of connections from a single computer can lessen the effect of a denial of
service attack.
l Limit the number of outgoing connections to a single computer to: Limiting the
number of outgoing connections to a single computer can significantly reduce the
effects of Nimda-like worms.
698
Trend Micro Deep Security On-Premise 20
l Limit the number of half-open connections from a single computer to: Setting a limit
here can protect you from DoS attacks like SYN Flood. Although most servers have
timeout settings for closing half-open connections, setting a value here can prevent
half-open connections from becoming a significant problem. If the specified limit for
SYN-SENT (remote) entries is reached, subsequent TCP packets from that specific
computer will be dropped.
Note: When deciding on how many open connections from a single computer to
allow, choose your number from somewhere between what you would consider a
reasonable number of half-open connections from a single computer for the type of
protocol being used, and how many half-open connections from a single computer
your system can maintain without getting congested.
l Enable ACK Storm protection when the number of already acknowledged packets
exceeds: Set this option to log an event that an ACK Storm attack has occurred.
l Drop Connection when ACK Storm detected: Set this option to drop the
connection if such an attack is detected.
Note: ACK Storm protection options are only available on Deep Security Agent 8.0
and earlier.
FTP Options
Under the FTP Options tab, you can enable the following options:
Note: The following FTP options are available in Deep Security Agent version 8.0 and earlier.
l Active FTP
l Allow Incoming: Allow Active FTP when this computer is acting as a server.
l Allow Outgoing: Allow Active FTP when this computer is acting as client.
l Passive FTP
l Allow Incoming: Allow Passive FTP when this computer is acting as a server.
l Allow Outgoing: Allow Passive FTP when this computer is acting as a client.
UDP packet inspection
Under the UDP tab, you can enable the following options:
699
Trend Micro Deep Security On-Premise 20
l Enable UDP stateful inspection: Select to enable stateful inspection of UDP traffic.
Note: The UDP stateful mechanism drops unsolicited incoming UDP packets. For every
outgoing UDP packet, the rule will update its UDP "stateful" table and will then only
allow a UDP response if it occurs within 60 seconds of the request. If you wish to allow
specific incoming UDP traffic, you will have to create a Force Allow rule. For example, if
you are running a DNS server, you will have to create a Force Allow rule to allow
incoming UDP packets to destination port 53.
Warning: Without stateful inspection of UDP traffic, an attacker can masquerade as a
DNS server and send unsolicited UDP "replies" from source port 53 to computers behind
a firewall.
l Enable UDP stateful logging: Selecting this option will enable the logging of UDP
stateful inspection events.
ICMP packet inspection
Under the ICMP tab, you can enable the following options:
Note: ICMP stateful inspection is available in Deep Security Agent version 8.0 or earlier.
l Enable ICMP stateful inspection: Select to enable stateful inspection of ICMP traffic.
Note: The ICMP (pseudo-)stateful mechanism drops incoming unsolicited ICMP
packets. For every outgoing ICMP packet, the rule will create or update its ICMP
"stateful" table and will then only allow a ICMP response if it occurs within 60 seconds of
the request. (ICMP pair types supported: Type 0 & 8, 13 & 14, 15 & 16, 17 & 18.)
Warning: With stateful ICMP inspection enabled, you can, for example, only allow an
ICMP echo-reply in if an echo-request has been sent out. Unrequested echo-replies
could be a sign of several kinds of attack including a Smurf amplification attack, a Tribe
Flood Network communication between master and daemon, or a Loki 2 back-door.
l Enable ICMP stateful logging: Selecting this option will enable the logging of ICMP
stateful inspection events.
700
Trend Micro Deep Security On-Premise 20
Export a stateful configuration
You can export all stateful configurations to a .csv or .xml file by clicking Export and selecting
the corresponding export action from the list. You can also export specific stateful configurations
by first selecting them, clicking Export and then selecting the corresponding export action from
the list.
Delete a stateful configuration
To delete a stateful configuration, right-click the configuration in the Firewall Stateful
Configurations list, click Delete and then click OK.
Note: Stateful configurations that are assigned to one or more computers or that are part of a
policy cannot be deleted.
See policies and computers a stateful configuration is assigned to
You can see which policies and computers are assigned to a stateful inspection configuration on
the Assigned To tab. Click on a policy or computer in the list to see their properties.
Scan for open ports
The Deep Security Manager can be instructed to scan a computer for open ports by right-clicking
the computer and selecting Actions > Scan for Open ports, or by clicking the Scan for Open
Ports button in the Firewall page of the Computer editor 1 window (where the results of the latest
scan are displayed).
(Port scans can also be initiated by right-clicking an existing computer on the Manager's
Computers page and choosing "Scan for Open Ports". Another way to initiate port scans is to
create a Scheduled Task to regularly carry out port scans on a list of computers.)
By default, the range of ports that are scanned is the range known as the "Common Ports", 1-
1024, but you can define a different set of ports to scan.
Note: The agent's port number for incoming heartbeat connections from the Manager is
always scanned regardless of port range settings. It is the port on the computer to which
communications initiated by the Manager are sent. If communication direction is set to
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
701
Trend Micro Deep Security On-Premise 20
"Agent/Appliance Initiated" for a computer (Computer or Policy editor 1 > Settings > General),
however, that port number will be closed.
1. Go to Policies > Common Objects > Lists > Port Lists and click New in the menu bar. The
New Port List window will appear.
2. Type a name and description for the new port list and then define the ports in the Port(s)
text box using the accepted formats. (For example, to scan ports 100, 105, and 110 through
120, you would type "100" on the first line "105" on the second, and "110-120" on the
third.) Click OK.
3. Go to Computer or Policy editor 2 > Settings > General and click the "Ports to Scan"
menu. Your newly defined Port List will be one of the choices.
Container Firewall rules
If you are using Deep Security Agent 11.2 or higher to protect containers that use an overlay
network, you may need to add some Firewall rules to allow network traffic for the Swarm or
Kubernetes services because the default Firewall rules block that traffic.
Kubernetes Firewall rules
If you are using Kubernetes, add the following rules to bypass the k8s communication traffic and
export service traffic:
Actio Fram
Priorit Directio Protoc Sourc Sourc Destinatio Destinatio
Name n e
y n ol e IP e Port n IP n Port
Type Type
HTTP
incoming
Force 0 -
TCP 80 Incoming IP TCP Any N/A Any 80
Allow Lowest
destinatio
n port
HTTP
outgoing Force 0 -
Outgoing IP TCP Any 80 Any Any
TCP 80 Allow Lowest
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
702
Trend Micro Deep Security On-Premise 20
Actio Fram
Priorit Directio Protoc Sourc Sourc Destinatio Destinatio
Name n e
y n ol e IP e Port n IP n Port
Type Type
source
port
K8s
incoming
Force 0-
TCP Incoming IP TCP Any Any Any 10054
Allow Lowest
10054
port
K8s
outgoing
Force 0-
TCP Outgoing IP TCP Any Any Any 10054
Allow Lowest
10054
port
K8s
outgoing Force 0-
Outgoing IP TCP Any Any Any 443
TCP 443 Allow Lowest
port
K8s
outgoing Force 0-
Incoming IP TCP Any Any Any 6443
TCP 6443 Allow Lowest
port
K8s
outgoing Force 0-
Outgoing IP TCP Any Any Any 6443
TCP 6443 Allow Lowest
port
K8s
outgoing Force 0-
Incoming IP TCP Any Any Any 8081
TCP 8081 Allow Lowest
port
K8s
outgoing Force 0-
Outgoing IP TCP Any Any Any 8081
TCP 8081 Allow Lowest
port
K8s
outgoing Force 0-
Outgoing IP UDP Any Any Any 8472
UDP Allow Lowest
8472 port
K8s
outgoing Force 0-
Outgoing IP UDP Any Any Any 8285
UDP Allow Lowest
8285 port
K8s
outgoing Force 0-
Incoming IP UDP Any Any Any 8285
UDP Allow Lowest
8285 port
703
Trend Micro Deep Security On-Premise 20
Swarm Firewall rules
If you are using Swarm, add the following rules to bypass the k8s communication traffic and
export service traffic:
Actio Fram
Priorit Directio Sourc Sourc Destinatio Destinatio
Name n e Protocol
y n e IP e Port n IP n Port
Type Type
HTTP
incoming
Force 0 -
TCP 80 Incoming IP TCP Any N/A Any 80
Allow Lowest
destinatio
n port
HTTP
outgoing
Force 0 -
TCP 80 Outgoing IP TCP Any 80 Any Any
Allow Lowest
source
port
Swarm
outgoing Force 0 -
Outgoing IP TCP Any Any Any 443
TCP 443 Allow Lowest
port
Swarm
incoming
TCP 2377,
2377, Force 0 - TCP+UD 4789,
Incoming IP Any Any Any
4789, Allow Lowest P 7946,
7946, 60012
60012
port
Swarm
outgoing
TCP 2377,
2377, Force 0 - TCP+UD 4789,
Outgoing IP Any Any Any
4789, Allow Lowest P 7946,
7946, 60012
60012
port
704
Trend Micro Deep Security On-Premise 20
Configure Integrity Monitoring
About Integrity Monitoring
The integrity monitoring module scans for unexpected changes to registry values, registry keys,
services, processes, installed software, ports and files on Deep Security Agents. Using a
baseline secure state as a reference, the integrity monitoring module performs scans on the
above and logs an event (and an optional alert) if it detects any unexpected changes.
To enable and configure integrity monitoring, see "Set up Integrity Monitoring" below.
To more information on creating integrity monitoring rules, see "Create an Integrity Monitoring
rule" on page 713. You can create a rule from a file or registry monitoring template, or by using
the Deep Security XML-based "About the Integrity Monitoring rules language" on page 717.
Set up Integrity Monitoring
The Integrity Monitoring protection module detects changes to files and critical system areas like
the Windows registry that could indicate suspicious activity. It does this by comparing current
conditions to a baseline reading it has previously recorded. Deep Security ships with predefined
Integrity Monitoring rules and new Integrity Monitoring rules are provided in security updates.
Note: Integrity Monitoring detects changes made to the system, but will not prevent or undo
the changes.
How to enable Integrity Monitoring
You can enable Integrity Monitoring in policies or at the computer level. To do so, you will need
to:
1. "Turn on Integrity Monitoring" on the next page.
2. "Run a Recommendation scan" on page 707.
3. "Apply the Integrity Monitoring rules" on page 707.
4. "Build a baseline for the computer" on page 709.
5. "Periodically scan for changes" on page 709.
6. "Test Integrity Monitoring" on page 709.
Once you've enabled Integrity Monitoring, you can also learn more about:
705
Trend Micro Deep Security On-Premise 20
l "When Integrity Monitoring scans are performed" on page 710
l "Integrity Monitoring scan performance settings" on page 711
l "Integrity Monitoring event tagging" on page 712
The following is a typical procedure for enabling Integrity Monitoring:
Turn on Integrity Monitoring
You can enable Integrity Monitoring in the settings for a computer or in policies. To do this, open
the Policy or Computer editor and go to Integrity Monitoring > General. Set the Configuration to
"On" or "Inherited (On)" and then click Save.
706
Trend Micro Deep Security On-Premise 20
Run a Recommendation scan
Run a Recommendation scan on the computer to get recommendations about which rules would
be appropriate. To do this, open the Computer editor and go to Integrity Monitoring > General.
In the Recommendations section, click Scan for Recommendations. You can optionally specify
that Deep Security should implement the rule recommendations that it finds.
Recommended Integrity Monitoring rules may result in too many monitored entities and
attributes. The best practice is to decide what is critical and should be monitored, then create
custom rules or tune the predefined rules. Pay extra attention to rules that monitor frequently-
changed properties such as process IDs and source port numbers because they can be noisy
and may need some tuning.
If you have enabled real-time integrity monitoring scans and find that some recommended rules
produce too many events because they are monitoring directories that change frequently, you
can disable real-time scanning for those rules. Go to Policies > Common Objects > Rules >
Integrity Monitoring Rules and double-click the rule. On the Options tab, clear the Allow Real
Time Monitoring checkbox.
Apply the Integrity Monitoring rules
As described above, when you run a Recommendation scan, you can have Deep Security
implement the recommended rules automatically. You can also manually assign rules.
In the Computer or Policy editor, go to Integrity Monitoring > General. The "Assigned Integrity
Monitoring Rules" section displays the rules that are in effect for this policy or computer. To add
or remove Integrity Monitoring Rules, click Assign/Unassign. This will display a window showing
all available Integrity Monitoring Rules, from which you can select or deselect rules.
707
Trend Micro Deep Security On-Premise 20
Some Integrity Monitoring rules written by Trend Micro require local configuration to function
properly. If you assign one of these rules to your computers or one of these rules gets assigned
automatically, an alert will be raised to notify you that configuration is required.
You can edit an Integrity Monitoring rule locally so that the changes apply only to the computer
or policy being edited, or globally so that the changes apply to all other policies or computers
that are using the rule. To edit a rule locally, right-click it and click Properties. To edit a rule
globally, right-click it and click Properties (Global).
You can also create custom rules to monitor for specific changes that concern your organization,
such as a new user being added or new software being installed. For information on how to
create a custom rule, see "About the Integrity Monitoring rules language" on page 717.
708
Trend Micro Deep Security On-Premise 20
Tip: Integrity Monitoring rules should be as specific as possible to improve performance and to
avoid conflicts and false positives. For example, do not create a rule that monitors the entire
hard drive.
Build a baseline for the computer
The baseline is the original secure state that an Integrity Scan's results will be compared
against. To create a new baseline for Integrity Scans on a computer, open the Computer editor,
go to Integrity Monitoring > General and click Rebuild Baseline.
To view the current baseline data, click View Baseline.
Tip: It’s a best practice to run a new baseline scan after applying patches.
Periodically scan for changes
Periodically scan for changes. To perform an on-demand scan, open the Computer editor, go to
Integrity Monitoring > General and click Scan for Integrity. You can also create a scheduled
task that performs scans on a regular basis.
Test Integrity Monitoring
Before continuing with further Integrity Monitoring configuration steps, test that the rules and
baseline are working correctly:
1. Ensure Integrity Monitoring is enabled.
2. Go to the Computer or Policy editor 1 > Integrity Monitoring > Assigned Integrity
Monitoring Rules. Click Assign/Unassign.
3. If you're a Windows user:
l Search for 1002773 - Microsoft Windows - 'Hosts' file modified and enable the rule.
This rule raises an alert when changes are made to
C:\windows\system32\drivers\etc\hosts.
If you're a Linux user
l Search for 1003513 - Unix - File attributes changes in /etc location and enable the
rule. This rule raises an alert when changes are made to the /etc/hosts file.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and
double-click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the
Computers page and double-click the computer that you want to edit (or select the computer and click Details).
709
Trend Micro Deep Security On-Premise 20
4. Modify the above file and save the changes.
5. Go to Computer editor 1 > Integrity Monitoring > General and click Scan for Integrity.
6. Go to Events & Reports > Integrity Monitoring Events to verify the record of the modified
host file. If the detection is recorded, the Integrity Monitoring module is working correctly.
When Integrity Monitoring scans are performed
There are three options for performing Integrity Monitoring scans:
l On-demand scans: You can initiate an on-demand integrity monitoring scan as needed by
opening the Computer editor 2, and going to Integrity Monitoring > General. In the Integrity
Scan section, click Scan for Integrity.
l Scheduled scans: You can schedule integrity monitoring scans just like other Deep
Security operations. Deep Security checks the entities that are being monitored and
identifies and records an event for any changes since the last time it performed a scan.
Multiple changes to monitored entities between scans will not be tracked; only the last
change will be detected. To detect and report multiple changes to an entity's state,
consider increasing the frequency of scheduled scans (for example, daily instead of
weekly) or enable real-time scanning for entities that change frequently. To enable
scheduled integrity monitoring scans, go to Administration > Scheduled Tasks > New. In
the New Scheduled Task Wizard, select Scan Computers for Integrity Changes and the
frequency for the scheduled scan. Fill in the information requested by the New Scheduled
Task Wizard with your desired specifications. For more information on scheduled tasks,
see "Schedule Deep Security to perform tasks" on page 1378.
l Real-time scans: You can enable real-time scanning. When this option is selected, Deep
Security monitors entities for changes in real time and raises integrity monitoring events
when it detects changes. Events are forwarded in real time via syslog to the SIEM or when
the next heartbeat communication to the Deep Security Manager occurs. To enable real-
time scans, go to the Computer or Policy Editor 3 > Integrity Monitoring > General and
select Real Time. With Deep Security Agent 11.0 or higher on 64-bit Linux platforms and
with Deep Security Agent 11.2 or higher on 64-bit Windows servers, the real-time scan
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
2To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
3You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
710
Trend Micro Deep Security On-Premise 20
results indicate the user and process that changed the file. For details about which
platforms support this feature, see "Supported features by platform" on page 145.
Note: Real-time monitoring of an entire disk for changes to any file would affect
performance and result in too many integrity monitoring events. As a safeguard, if you
choose to monitor the root drive (C:\) in real time, Deep Security will only monitor
executable files and scripts. If you want to perform real-time monitoring of all files, specify
a folder other than the root drive.
Integrity Monitoring scan performance settings
Changing the following settings may help to improve the performance of Integrity Monitoring
scans:
Limit CPU usage
Integrity Monitoring uses local CPU resources during the system scan that leads to the creation
of the initial baseline and during the system scan that compares a later state of the system to the
previously created baseline. If you are finding that Integrity Monitoring is consuming more
resources than you want it to, you can restrict the CPU usage to the following levels:
l High: Scans files one after another without pausing
l Medium: Pauses between scanning files to conserve CPU resources
l Low: Pauses between scanning files for a longer interval than the medium setting
To change the Integrity Monitoring CPU Usage Level setting, open the Computer or Policy
editor 1 and go to Integrity Monitoring > Advanced.
Change the content hash algorithm
You can select the hash algorithm(s) that will be used by the Integrity Monitoring module to store
baseline information. You can select more than one algorithm, but this is not recommended
because of the detrimental effect on performance.
You can change the content hash algorithm
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
711
Trend Micro Deep Security On-Premise 20
Enable a VM Scan Cache configuration
Using scan caching for Integrity Monitoring improves the efficiency of scans by eliminating the
unnecessary scanning of identical content across multiple VMs in large VMware deployments.
To select which scan cache configuration is used by a virtual machine, open the Computer or
Policy editor 1 and go to Integrity Monitoring > Advanced > VM Scan Cache.
For information on Integrity Monitoring scan cache configurations, see "Virtual Appliance Scan
Caching" on page 763.
Integrity Monitoring event tagging
The events generated by the Integrity Monitoring module are displayed in Deep Security
Manager, under Events & Reports > Integrity Monitoring Events. Event tagging can help you to
sort events and determine which ones are legitimate and which ones need to be investigated
further.
You can manually apply tags to events by right-clicking the event and then clicking Add Tag(s).
You can choose to apply the tag to only the selected event or to any similar Integrity Monitoring
events.
You can also use the auto-tagging feature to group and label multiple events. To configure this
feature in the Deep Security Manager, go to Events and Reports > Integrity Monitoring Events >
Auto-Tagging > New Trusted Source. There are three sources that you can use to perform the
tagging:
l A Local Trusted Computer.
l The Trend Micro Certified Safe Software Service.
l A Trusted Common Baseline, which is a set of file states collected from a group of
computers.
For more information on event tagging, see "Apply tags to identify and group events" on
page 836.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
712
Trend Micro Deep Security On-Premise 20
Create an Integrity Monitoring rule
Integrity Monitoring rules describe how Deep Security Agents should scan for and detect
changes to a computer's files, directories, and registry keys and values, as well as changes in
installed software, processes, listening ports, and running services. Integrity Monitoring rules can
be assigned directly to computers or can be made part of a policy.
Note: This article specifically covers how to create an Integrity Monitoring rule. For information
on how to configure the Integrity Monitoring module, see "Set up Integrity Monitoring" on
page 705.
There are two types of Integrity Monitoring rules: those that you have created, and those that are
issued by Trend Micro. For more information on how to configure rules issued by Trend Micro,
see the "Configure Trend Micro Integrity Monitoring rules" on page 715 section.
To create a new Integrity Monitoring rule, you need to:
1. "Add a new rule" below.
2. "Enter Integrity Monitoring rule information " on the next page.
3. "Select a rule template and define rule attributes" on the next page.
When you're done with your rule, you can also learn how to
l "Configure rule events and alerts" on page 716
l "See policies and computers a rule is assigned to" on page 717
l "Export a rule" on page 717
l "Delete a rule" on page 717
Add a new rule
There are three ways to add an Integrity Monitoring rule on the Policies > Common Objects >
Rules > Integrity Monitoring Rules page. You can:
l Create a new rule. Click New > New Integrity Monitoring Rule.
l Import a rule from an XML file. Click New > Import From File.
l Copy and then modify an existing rule. Right-click the rule in the Integrity Monitoring Rules
list and then click Duplicate. To edit the new rule, select it and then click Properties.
713
Trend Micro Deep Security On-Premise 20
Enter Integrity Monitoring rule information
1. Enter a Name and Description for the rule.
Tip: It is good practice to document all Integrity Monitoring rule changes in the
Description field of the rule. Make a note of when and why rules were created or deleted
for easier maintenance.
2. Set the Severity of the rule.
Note: Setting the severity of a rule has no effect on how the rule is implemented or
applied. Severity levels can be useful as sorting criteria when viewing a list of Integrity
Monitoring rules. More importantly, each severity level is associated with a severity
value; this value is multiplied by a computer's Asset Value to determine the ranking of an
event. (See Administration > System Settings > Ranking.)
Select a rule template and define rule attributes
Go to the Content tab and select from one of the following three templates:
Registry Value template
Create an Integrity Monitoring rule to specifically monitor changes to registry values.
Note: The Registry Value template is only for Windows-based computers .
1. Select the Base Key to monitor and whether or not to monitor contents of sub keys.
2. List Value Names to be included or excluded. You can use "?" and "*" as wildcard
characters.
3. Enter Attributes to monitor. Entering "STANDARD" will monitor changes in registry size,
content and type. For more information on Registry Value template attributes see the
"RegistryValueSet" on page 749 documentation.
File template
Create an Integrity Monitoring rule to specifically monitor changes to files.
1. Enter a Base Directory for the rule (for example, C:\Program Files\MySQL .) Select
Include Sub Directories to include the contents of all subdirectories relative to the base
directory. Wildcards are not supported for base directories.
714
Trend Micro Deep Security On-Premise 20
2. Use the File Names fields to include or exclude specific files. You can use wildcards (" ?
" for a single character and " * " for zero or more characters.
Note: Leaving the File Names fields blank will cause the rule to monitor all files in the
base directory. This can use significant system resources if the base directory contains
numerous or large files.
3. Enter Attributes to monitor. Entering "STANDARD" will monitor changes in file creation
date, last modified date, permissions, owner, group, size, content, flags (Windows), and
SymLinkPath (Linux). For more information on File template attributes see the "FileSet" on
page 733 documentation.
Custom (XML) template
Create a custom Integrity Monitoring rule template to monitor directories, registry values, registry
keys, services, processes, installed software, ports, groups, users, files, and the WQL using the
Deep Security XML-based "About the Integrity Monitoring rules language" on page 717.
Tip: You can create your rule in your preferred text editor and paste it to the Content field
when you are done.
Configure Trend Micro Integrity Monitoring rules
Integrity Monitoring rules issued by Trend Micro cannot be edited in the same way as the custom
rules you create. Some Trend Micro rules cannot be modified at all, while other rules may offer
limited configuration options. Both of these rule types will show as "Defined" under the "Type"
column, but rules that can be configured will display a gear in the Integrity Monitoring icon ( ).
715
Trend Micro Deep Security On-Premise 20
You can access the configuration options for a rule by opening the properties for the rule and
clicking on the Configuration tab.
Rules issued by Trend Micro also show the following additional information under the General
tab:
l When the rule was first issued and last updated, as well as a unique identifier for the rule.
l The minimum versions of the Agent and the Deep Security Manager that are required for
the rule to function.
Although you cannot edit rules issued by Trend Micro directly, you can duplicate them and then
edit the copy.
Configure rule events and alerts
Any changes detected by an Integrity Monitoring rule is logged as an event in the Deep Security
Manager.
Real-time event monitoring
By default, events are logged at the time they occur. If you only want events to be logged when
you manually perform a scan for changes, deselect Allow Real Time Monitoring.
Alerts
You can also configure the rules to trigger an alert when they log an event. To do so, open the
properties for a rule, click on Options, and then select Alert when this rule logs an event.
716
Trend Micro Deep Security On-Premise 20
See policies and computers a rule is assigned to
You can see which policies and computers are assigned to an Integrity Monitoring rule on the
Assigned To tab. Click on a policy or computer in the list to see their properties.
Export a rule
You can export all Integrity Monitoring rules to a .csv or .xml file by clicking Export and selecting
the corresponding export action from the list. You can also export specific rules by first selecting
them, clicking Export and then selecting the corresponding export action from the list.
Delete a rule
To delete a rule, right-click the rule in the Integrity Monitoring Rules list, click Delete and then
click OK.
Note: Integrity Monitoring rules that are assigned to one or more computers or that are part of a
policy cannot be deleted.
Integrity Monitoring rules language
About the Integrity Monitoring rules language
The Integrity Monitoring rules language is a declarative XML-based language that describes the
system components and associated attributes that should be monitored by Deep Security. It also
provides a means to specify what components within a larger set of components should be
excluded from monitoring.
Tip: If you only need to monitor for unauthorized changes to files or the Windows registry, you
can use File and Registry rule templates instead of creating a custom one. For more
information on using these templates, see "Create an Integrity Monitoring rule" on page 713.
To create a new custom Integrity Monitoring rule, start with the procedure in "Create an Integrity
Monitoring rule" on page 713 (selecting Custom (XML) as the template type), then create your
custom rule according to the Integrity Monitoring rules language, as covered in the following
sections:
717
Trend Micro Deep Security On-Premise 20
l "Entity Sets" below
l "Hierarchies and wildcards" on the next page
l "Syntax and concepts" on page 720
l "Include tag" on page 721
l "Exclude tag" on page 722
l "Case sensitivity" on page 722
l "Entity features" on page 723
l "ANDs and ORs" on page 724
l "Order of evaluation" on page 725
l "Entity attributes" on page 725
l "Shorthand attributes" on page 727
l "onChange attribute" on page 727
l "Environment variables" on page 727
l "Registry values" on page 729
l "Use of ".."" on page 729
l "Best practices" on page 730
Entity Sets
System components included in an Integrity Monitoring rule are referred to as "Entities". Each
type of component is a class of Entity. For example, files, registry keys, and processes are each
a class of Entity. The Integrity Monitoring Rules language provides a tag for describing a set of
Entities (an Entity Set) for each class of Entity. The following Entity Set types are available to be
used in a rule:
l "DirectorySet" on page 730: rules will scan the integrity of directories
l "FileSet" on page 733: rules will scan the integrity of files
l "GroupSet" on page 737: rules will scan the integrity of groups
l "InstalledSoftwareSet" on page 739: rules will scan the integrity of installed software
l "PortSet" on page 741: rules will scan the integrity of listening ports
l "ProcessSet" on page 744: rules will scan the integrity of processes
l "RegistryKeySet" on page 747: rules will scan registry keys
l "RegistryValueSet" on page 749: rules will scan registry values
l "ServiceSet" on page 751: rules will scan the integrity of services
718
Trend Micro Deep Security On-Premise 20
l "UserSet" on page 754: rules will scan the integrity of users
l "WQLSet" on page 758: rules will monitor the integrity of the results of a Windows
Management Instrumentation WQL query statement
A single Integrity Rule can contain multiple Entity Sets. This allows you to, for example, secure
an application with a single rule that monitors multiple files and registry entries.
Hierarchies and wildcards
For Entity Sets that represent a hierarchical data type such as FileSet and RegistryKeySet,
section-based pattern matching is supported:
l / (forward slash) : demarcates sections of the pattern to be applied to levels of the
hierarchy
l ** (two stars) : matches zero or more sections
The following wildcards are supported:
l ? (question mark) : matches one character
l * (one star) : matches zero or more characters
"Escaping" characters is also supported:
l \ (back slash) : escapes the next character
The pattern is divided into sections using the " / " character, with each section of the pattern
being applied to successive levels of the hierarchy as long as it continues to match. For
example, if the pattern:
/a?c/123/*.java
is applied to the path:
/abc/123/test.java
Then:
l "a?c " matches "abc"
l "123 " matches "123"
l "*.java " matches "test.java"
When the pattern is applied to the path:
719
Trend Micro Deep Security On-Premise 20
/abc/123456/test.java
Then:
l "a?c " matches "abc"
l " 123 " does not match "123456", and so no more matching is performed
The " ** " notation pattern matches zero or more sections, and so:
/abc/**/*.java
matches both "abc/123/test.java" and "abc/123456/test.java". It would also match "abc/test.java"
and "abc/123/456/test.java".
Syntax and concepts
This section will present some example Integrity Monitoring rules. The examples will use the
FileSet Entity Set but the topics and components described are common to all Entity Sets. A
minimal Integrity Monitoring rule could look like this:
<FileSet base="C:\Program Files\MySQL">
</FileSet>
The "base" attribute specifies the base directory for the FileSet. Everything else about the rule
will be relative to this directory. If nothing further is added to the rule, everything (including
subdirectories) below the "base" will be monitored for changes.
Note: The " * " and " ? " wildcards can be used in a "base" attribute string, but only in the
last path component of the base. So this is valid:
base="C:\program files\CompanyName * Web Server"
but this is not:
base="C:\* files\Microsoft Office"
Within an Entity Set, "include" and "exclude" tags can be used to control pattern matching.
These tags have a "key" attribute that specifies the pattern to match against. The source of the
key varies by Entity Set. For example, for Files and Directories it is their path, while for Ports it is
the unique protocol/IP/portNumber tuple.
720
Trend Micro Deep Security On-Premise 20
Note: If a path supplied in an include or exclude rule is syntactically invalid, the Agent will
generate an "Integrity Monitoring Rule Compile Issue" Agent Event and supply the rule ID and
the path (after expansion) as parameters. An example of an invalid path would be
C:\test1\D:\test2 since a file name may not contain two volume identifiers.
Include tag
The include tag is essentially an allow list. Using it means that only those Entities matched by it
(or other include tags) will be included. By adding an include tag, the following rule now only
monitors changes to files with the name "*.exe" in the "C:\Program Files\MySQL" folder and sub
folders:
<FileSet base="C:\Program Files\MySQL">
<include key="**/*.exe"/>
</FileSet>
"Includes" can be combined. The following rule will monitor changes to files with the names
"*.exe" and "*.dll" in the "C:\Program Files\MySQL" folder and sub folders:
<FileSet base="C:\Program Files\MySQL">
<include key="**/*.exe"/>
<include key="**/*.dll"/>
</FileSet>
It is also possible to combine multiple criteria in a single include block, in which case all criteria
must be true for a given Entity to be included. The following "include" tag requires that an Entity
both end in ".exe" and start with "sample" to be included. Although this requirement could be
represented more succinctly, the usefulness of this becomes more apparent as key patterns are
combined with other features of the Entity, as described in the "Features" section below.
<include>
<key pattern="**/*.exe"/>
<key pattern="**/sample*"/>
</include>
The following is another way to express the same requirements:
<include key="**/*.exe">
<key pattern="**/sample*"/>
</include>
721
Trend Micro Deep Security On-Premise 20
Exclude tag
The exclude tag functions as a block list, removing files from the set that would otherwise be
returned. The following (unlikely) example would place everything but temp files under watch.
<FileSet base="C:\Program Files\MySQL">
<include key="**"/>
<exclude key="**/*.tmp"/>
</FileSet>
The following rule excludes the "MySQLInstanceConfig.exe" from the set of EXEs and DLLs:
<FileSet base="C:\Program Files\MySQL">
<include key="**/*.exe"/>
<include key="**/*.dll" />
<exclude key="**/MySQLInstanceConfig.exe"/>
</FileSet>
Like the "include" tag, the "exclude" tag can be written to require multiple criteria. The following
example shows a multi-criteria "exclude" tag.
<exclude>
<key pattern="**/MySQLInstanceConfig*" />
<key pattern="**/*.exe" />
</exclude>
Case sensitivity
The case sensitivity of pattern matching for an include or exclude tag may be controlled by the
"casesensitive" attribute. The attribute has three allowed values:
l true
l false
l platform
The default value for this attribute is "platform", which means that the case sensitivity of the
pattern will match the platform on which it is running. In the following example, both "Sample.txt"
and "sample.txt" would be returned on a Windows system, but only "Sample.txt" would be
returned on a Unix system:
<FileSet base="C:\Program Files\MySQL">
<include key="**/*Sample*"/>
</FileSet>
722
Trend Micro Deep Security On-Premise 20
In this example, only "Sample.txt" would be returned on Windows and Unix:
<FileSet base="C:\Program Files\MySQL">
<include key="**/*Sample*" casesensitive="true"/>
</FileSet>
Note: A case sensitive setting of "true" is of limited use on a platform such as Windows which
is case insensitive when it comes to most object names.
Entity features
The inclusion and exclusion of Entities based on features other than their "key" is also supported
for some Entity types. The set of features differs by Entity type. The following example will
include all executable files. It does not depend on the file extension as previous examples using
file extensions did, but instead will check the first few hundred bytes of the file to determine if it is
executable on the given OS.
<FileSet base="C:\Program Files\MySQL">
<include key="**" executable="true"/>
</FileSet>
Feature attributes must appear in an "include" or "exclude" tag. To use them as part of a multi-
criteria include or exclude, they must be specified as attributes of the enclosing include or
exclude tag. The following example includes all files that contain the string "MySQL" in their
name and are also executable:
<include executable="true">
<key pattern="**/*MySQL*"/>
</include>
The previous example can be more succinctly expressed as:
<include key="**/*MySQL*" executable="true"/>
Some feature attributes are simply matches against the value of one of the Entity's attributes. In
such cases, wildcard matches using " * " and " ? " are sometimes supported. The help
pages for the individual "Entity Sets" on page 718 indicate which attributes can be used in
include or exclude rules in this way, and whether they support wildcard matching or simple string
matching.
Note: Where wildcard matches are supported, it is important to note that the match is against
the string value of the attribute and that no normalization takes place. Constructs available for
723
Trend Micro Deep Security On-Premise 20
Entity key matches such as "** " and the use of " / " to separate hierarchical components
don't apply. Matching a path name on Windows requires the use of " \ " since that is the
character which appears in the value of the attribute being tested, whereas Unix systems will
use " / " in path values so matches against Unix paths need to use " / ".
The following is an example of a feature match using the "state" attribute:
<ServiceSet>
<include state="running"/>
</ServiceSet>
Note: Wildcards are not supported in state matches.
The following example matches any processes where the path of the binary ends in
"\notepad.exe":
<ProcessSet>
<include path="*\notepad.exe"/>
</ProcessSet>
The following example matches any processes where the command-line begins with "/sbin/":
<ProcessSet>
<include commandLine="/sbin/*"/>
</ProcessSet>
Note: Be careful when using wildcards. A wildcard expression like " ** " will look at every
file in every sub directory beneath "base". Creating a baseline for such an expression can take
a lot of time and resources.
ANDs and ORs
It is possible to express logical ANDs and ORs through the use of multi-criteria includes and
excludes and multiple includes and excludes.
There are several ways that a multi criteria include or exclude can be used to express an AND.
The most straightforward is to include multiple criteria within a single enclosing tag. The
following example shows a simple multi-criteria AND-ing:
<include>
<key pattern="**/*MySQL*" />
724
Trend Micro Deep Security On-Premise 20
<key pattern="**/*.exe"/>
</include>
As well, any criteria expressed as an attribute of the including tag will be grouped with the
enclosed criteria as part of the multi-criteria requirement. The following example shows the
previous multi-criteria "include" re-written in this way:
<include key="**/*.exe">
<key pattern="**/*MySQL*" />
</include>
Finally, if multiple criteria are expressed as attributes of an include or exclude they are treated as
an AND:
<include executable="true" key="**/*MySQL*" />
ORs are expressed simply by the inclusion of multiple include or exclude tags. The following
code includes files if their extensions are ".exe" OR ".dll":
<include key="**/*.dll" />
<include key="**/*.exe" />
Order of evaluation
All "includes" are processed first, regardless of order of appearance in the rule. If an object name
matches at least one "include" tag, it is then tested against the "exclude" tags. It is removed from
the set of monitored objects if it matches at least one "exclude" tag.
Entity attributes
A given Entity has a set of attributes that can be monitored. If no attributes are specified for an
Entity Set (i.e. the attributes wrapper tag is not present) then the STANDARD set of attributes for
that Entity is assumed. (See the Shorthand Attributes sections for the individual "Entity Sets" on
page 718.)
However, for a given Entity Set only certain attributes of the Entity may be of interest for Integrity
Monitoring. For example, changes to the contents of a log file are most likely expected and
allowed. However changes to the permissions or ownership should be reported.
The "attributes" tag of the Entity Sets allows this to be expressed. The "attributes" tag contains a
set of tags enumerating the attributes of interest. The set of allowed "attribute" tags varies
depending on the Entity Set for which they are being supplied.
725
Trend Micro Deep Security On-Premise 20
Note: If the "attributes" tag is present, but contains no entries, then the Entities defined by the
rule are monitored for existence only.
The following example monitors executable files in "C:\Program Files\MySQL" whose name
includes "SQL" for changes to their "last modified", "permissions", and "owner" attributes:
<FileSet base="C:\Program Files\MySQL" >
<include key="**/*SQL*" executable="true"/>
<attributes>
<lastModified/>
<permissions/>
<owner/>
</attributes>
</FileSet>
The following example monitors the "permissions", and "owner" attributes of log files in
"C:\Program Files\MySQL":
<FileSet base="C:\Program Files\MySQL" >
<attributes>
<permissions/>
<owner/>
</attributes>
<include key="**/*.log" />
</FileSet>
In the following example, the STANDARD set of attributes will be monitored. (See Shorthand
Attributes, below)
<FileSet base="C:\Program Files\MySQL" >
<include key="**/*.log" />
</FileSet>
In the following example, no attributes will be monitored. Only the existence of the Entities will
be tracked for change.
<FileSet base="C:\Program Files\MySQL" >
<attributes/>
<include key="**/*.log" />
</FileSet>
726
Trend Micro Deep Security On-Premise 20
Shorthand attributes
Shorthand attributes provide a way to specify a group of attributes using a single higher level
attribute. Like regular attributes the set of allowed values differs based on the Entity Set for which
they are being supplied.
Shorthand Attributes are useful in cases where a set of attributes naturally group together, in
cases where exhaustively listing the set of attributes would be tedious, and in cases where the
set of attributes represented by the high level attribute may change with time or system
configuration. An example of each case follows:
Attribute Description
The set of attributes to monitor for the Entity Set. This is different than "every
possible attribute" for the Entity Set. For example, it would not include every
STANDARD possible hash algorithm, just the ones deemed sufficient. For the list of "standard"
attributes for each Entity Set, see sections for the individual "Entity Sets" on
page 718.
This is Shorthand for the hash, or set of hashes, of the contents of the file. Defaults
CONTENTS
to SHA-1.
onChange attribute
An EntitySet may be set to monitor changes in real time. If the onChange attribute of an EntitySet
is set to true (the default value) then the entities returned by the EntitySet will be monitored for
changes in real time. When a change is detected the Entity is immediately compared against its
baseline for variation. If the onChange attribute of an EntitySet is set to false, it will be run only
when a baseline is built or when it is triggered via a scheduled task or on demand by the Deep
Security Manager.
The following sample monitors the MySQL binaries in real time:
<FileSet base="C:\Program Files\MySQL" onChange="true">
<include key="**/*.exe"/>
<include key="**/*.dll" />
</FileSet>
Environment variables
Environment variables can be included in the base value used in Entity Sets. They are enclosed
in "${}". The variable name itself is prefaced with "env.".
The following example sets the base directory of the FileSet to the path stored in the
PROGRAMFILES environment variable:
727
Trend Micro Deep Security On-Premise 20
<FileSet base="${env.PROGRAMFILES}"/>
Note: The values of referenced environment variables are read and stored by the Deep
Security Agent on Agent startup. If the value of an environment variable changes, the Agent
must be restarted to register the change.
If a referenced environment variable is not found, the Entity Sets referencing it are not scanned
or monitored, but the rest of the configuration is used. An alert is triggered indicating that the
variable is not present. The Agent reports an invalid environment variable using Agent event
"Integrity Monitoring Rule Compile Issue". The ID of the Integrity Monitoring rule and the
environment variable name are supplied as parameters to the event.
The following are the default environment variables that Integrity Monitoring uses:
Name Value
ALLUSERSPROFILE C:\ProgramData
COMMONPROGRAMFILES C:\Program Files\Common Files
PROGRAMFILES C:\Program Files
SYSTEMDRIVE C:
SYSTEMROOT C:\Windows
WINDIR C:\Windows
Environment variable overrides
Override environment variables when non-standard locations are used in the Windows
operating system. For example, the Microsoft Windows - 'Hosts' file modified Integrity
Monitoring rule, which monitors changes to the Windows hosts file, looks for that file in the
C:\WINDOWS\system32\drivers\etc folder. However not all Windows installations use the
C:\WINDOWS\ directory, so the Integrity Monitoring rule uses the WINDIR environment variable
and represents the directory as %WINDIR%\system32\drivers\etc.
Note: Environment variables are used primarily by the virtual appliance when performing
agentless Integrity Monitoring on a virtual machine. This is because the virtual appliance has
no way of knowing if the operating system on a particular virtual machine is using standard
directory locations.
728
Trend Micro Deep Security On-Premise 20
1. Open the Computer or Policy editor 1 where you want to override an environment variable.
2. Click Settings > Advanced.
3. In the Environment Variable Overrides section, click View Environment Variables to
display the Environment Variable Overrides page.
4. Click New in the menu bar and enter a new name-value pair (for example, WINDIR and
D:\Windows) and click OK.
Registry values
Registry values can be included in the base value used in Entity Sets. They are enclosed in ${}.
The path to the registry value itself is prefaced with "reg.". The following example sets the base
directory of the FileSet to the path stored in the "HKLM\Software\Trend Micro\Deep
Security Agent\InstallationFolder" registry value:
<FileSet base="${reg.HKLM\Software\Trend Micro\Deep Security
Agent\InstallationFolder}"/>
The values of referenced registry values are read when a new or changed rule is received by the
Agent. The Agent also checks all rules at startup time and will rebuild the baseline for affected
Rules if any referenced registry values change.
If a referenced registry value is not found, the EntitySets referencing it are not scanned or
monitored, but the rest of the configuration is used. An alert notifying that the variable is not
present is raised. The Agent reports an invalid environment variable expansion using Agent
Event 8012. The ID of the Integrity Monitoring rule and the registry value path are supplied as
parameters to the event.
Note: A wildcard is allowed only in the last hierarchical component of a base name. For
example, base="HKLM\Software\ATI*" is valid and will find both "HKLM\Software\ATI" and
"HKLM\Software\ATI Technologies"; however, base="HKLM\*\Software\ATI* is invalid.
Use of ".."
The ".." convention for referencing a parent directory is supported in all current versions of the
Agent. The Agent will attempt to normalize base directory names for FileSet and DirectorySet
elements by resolving ".." references and converting Windows short names to long names. For
example, on some newer versions of Windows the following FileSet would have a base
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
729
Trend Micro Deep Security On-Premise 20
directory of C:\Users. On earlier versions of Windows it would be C:\Documents and
Settings.
<FileSet base="${env.USERPROFILE}\..">
<include key="*/Start Menu/Programs/Startup/*"/>
</FileSet>
Best practices
Rules should be written to only include objects and attributes that are of significance. This will
ensure that no events are reported if other attributes of the object change. For example, your
change monitoring policy may place restrictions on permission and ownership of files in /bin .
Your Integrity Monitoring rule should monitor owner, group, and permissions, but not other
attributes like lastModified or hash values.
When using Integrity Monitoring rules to detect malware and suspicious activity, monitor
services, watch for use of NTFS data streams, and watch for executable files in unusual places
such as " /tmp " or " ${env.windir}\temp ".
Always be as specific as possible when specifying what objects to include in a rule. The fewer
objects you include, the less time it will take to create your baseline and the less time it will take
to scan for changes. Exclude objects which are expected to change and only monitor the
attributes you are concerned about.
When creating a rule, do not:
l Use " **/... " from a top-level of the hierarchy such as " / ", "C:\", or "
HKLM\Software " .
l Use more than one content hash type unless absolutely necessary.
l Reference user-specific locations such as HKEY_CURRENT_USER ,
${env.USERPROFILE} , or ${env.HOME} .
Any of these statements in your integrity monitoring rules will cause performance issues as the
Deep Security Agent searches through many items in order to match the specified patterns.
DirectorySet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
730
Trend Micro Deep Security On-Premise 20
The DirectorySet tag describes a set of Directories.
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the Entity monitored by
Integrity Monitoring Rules.
Default
Attribute Description Required Allowed Values
Value
String values resolving to syntactically valid path
(Path is not required to exist) Note: UNC paths are
allowed by Windows Agents, but require that the
remote system allow access by the "LocalSystem"
account of the Agent computer. The Agent is a
Windows service and runs as LocalSystem, aka
NT AUTHORITY\SYSTEM. When accessing a
network resource, the LocalSystem uses the
Sets the
computer's credentials, which is an account
base
named DOMAIN\MACHINE$. The access token
directory of
presented to the remote computer also contains
the
the "Administrators" group for the computer, so
DirectorySet.
base Yes N/A remote shares must grant read privileges to either
Everything
the Agent computer's account, the Agent
else in the
computer's Administrators group, or "Everyone".
tag is
For testing access to UNC paths, launch a
relative to
Windows command prompt running as a service
this directory
under the LocalSystem account. With that, you can
try accessing network and local resources, or
launch other applications that will run under the
LocalSystem account.
If the base value is not syntactically valid, the
FileSet will not be processed. The rest of the
config will be evaluated.
Whether the
directories
returned
onChange No false true, false
should be
monitored in
real time.
Will this
DirectorySet
followLinks follow No false true, false
symbolic
links.
Entity Set Attributes
These are the attributes of the Entity that may be monitored by Integrity Monitoring Rules.
731
Trend Micro Deep Security On-Premise 20
l Created: Timestamp when the directory was created
l LastModified: Timestamp when the directory was last modified
l LastAccessed: Timestamp when the directory was last accessed. On Windows this value
does not get updated immediately, and recording of the last accessed timestamp can be
disabled as a performance enhancement. See File Times for details. The other problem
with this attribute is that the act of scanning a directory requires that the Agent open the
directory, which will change its last accessed timestamp.
l Permissions: The directory's security descriptor (in SDDL format) on Windows or Posix-
style ACLs on Unix systems that support ACLs, otherwise the Unix style rwxrwxrwx file
permissions in numeric (octal) format.
l Owner: User ID of the directory owner (commonly referred to as the "UID" on Unix)
l Group: Group ID of the directory owner (commonly referred to as the "GID" on Unix)
l Flags: Windows-only. Flags returned by the GetFileAttributes() Win32 API. Windows
Explorer calls these the "Attributes" of the file: Read-only, Archived, Compressed, etc.
l SymLinkPath: If the directory is a symbolic link, the path of the link is stored here. On
Windows, use the SysInternals "junction" utility to create the Windows equivalent of
symbolic links.
l InodeNumber (Unix and Linux only): Inode number of the disk on which the inode
associated with the file is stored
l DeviceNumber (Unix and Linux only): Device number of the disk on which the inode
associated with the directory is stored
Short Hand Attributes
The following are the Short Hand Attributes, and the attributes to which they map.
l STANDARD:
l Created
l LastModified
l Permissions
l Owner
l Group
l Flags (Windows only)
l SymLinkPath
732
Trend Micro Deep Security On-Premise 20
Meaning of "Key"
Key is a pattern to match against the path of the directory relative to the directory specified by
"dir". This is a hierarchical pattern, with sections of the pattern separated by "/" matched against
sections of the path separated by the file separator of the given OS.
Sub Elements
l Include
l Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
Include and Exclude for their allowed attributes and sub elements. Only information specific to
includes and excludes relating to this EntitySet class are included here.
FileSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
The FileSet tag describes a set of Files.
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the Entity monitored by
Integrity Monitoring Rules.
Default
Attribute Description Required Allowed Values
Value
String values resolving to syntactically valid path
Sets the (Path is not required to exist). Note: UNC paths are
base allowed by Windows Agents, but require that the
directory of remote system allow access by the "LocalSystem"
the FileSet. account of the Agent computer. The Agent is a
Everything Windows service and runs as LocalSystem, aka
base Yes N/A NT AUTHORITY\SYSTEM. When accessing a
else in the
tag is network resource, the LocalSystem uses the
relative to computer's credentials, which is an account named
this DOMAIN\MACHINE$. The access token presented
directory. to the remote computer also contains the
"Administrators" group for the computer, so remote
733
Trend Micro Deep Security On-Premise 20
Default
Attribute Description Required Allowed Values
Value
shares must grant read privileges to either the
Agent computer's account, the Agent computer's
Administrators group, or "Everyone". For testing
access to UNC paths, launch a Windows
command prompt running as a service under the
LocalSystem account. With that, you can try
accessing network and local resources, or launch
other applications that will run under the
LocalSystem account.
If the base value is not syntactically valid, the
FileSet will not be processed. The rest of the config
will be evaluated.
Whether the
files
returned
onChange No false true, false
should be
monitored
in real time.
Will this
FileSet
followLinks follow No false true, false
symbolic
links.
Entity Set Attributes
These are the attributes of the FileSet that can be monitored by Integrity Monitoring Rules.
l Created: Timestamp when the file was created
l LastModified: Timestamp when the file was last modified
l LastAccessed: Timestamp when the file was last accessed. On Windows this value does
not get updated immediately, and recording of the last accessed timestamp can be
disabled as a performance enhancement. See File Times for details. The other problem
with this attribute is that the act of scanning a file requires that the Agent open the file,
which will change its last accessed timestamp. On Unix, the Agent will use the O_
NOATIME flag if it is available when opening the file, which prevents the OS from updating
the last accessed timestamp and speeds up scanning.
l Permissions: The file's security descriptor (in SDDL format) on Windows or Posix-style
ACLs on Unix systems that support ACLs, otherwise the Unix style rwxrwxrwx file
permissions in numeric (octal) format.
734
Trend Micro Deep Security On-Premise 20
l Owner: User ID of the file owner (commonly referred to as the "UID" on Unix)
l Group: Group ID of the file owner (commonly referred to as the "GID" on Unix)
l Size: size of the file
l Sha1: SHA-1 hash
l Sha256:SHA-256 hash
l Md5: MD5 hash (deprecated)
l Flags: Windows-only. Flags returned by the GetFileAttributes() Win32 API. Windows
Explorer calls these the "Attributes" of the file: Read-only, Archived, Compressed, etc.
l SymLinkPath (Unix and Linux only): If the file is a symbolic link, the path of the link is
stored here. Windows NTFS supports Unix-like symlinks, but only for directories, not files.
Windows shortcut objects are not true symlinks since they are not handled by the OS; the
Windows Explorer handles shortcut files (*.lnk) but other applications that open a *.lnk file
will see the contents of the lnk file.
l InodeNumber (Unix and Linux only): Inode number of the disk on which the inode
associated with the file is stored
l DeviceNumber (Unix and Linux only): Device number of the disk on which the inode
associated with the file is stored
l BlocksAllocated (Linux and Unix only): The number of blocks allocated to store the file.
l Growing: (DSA 7.5+) contains the value "true" if the size of the file stays the same or
increases between scans, otherwise "false". This is mainly useful for log files that have
data appended to them. Note that rolling over a log file will trigger a change in this attribute.
l Shrinking: (DSA 7.5+) contains the value "true" if the size of the file stays the same or
decreases between scans, otherwise "false".
Short Hand Attributes
The following are the Short Hand Attributes, and the attributes to which they map.
l CONTENTS: Resolves to the content hash algorithm set in Computer or Policy editor 1 >
Integrity Monitoring > Advanced.
l STANDARD: Created, LastModified, Permissions, Owner, Group, Size, Contents, Flags
(Windows only), SymLinkPath (Unix only)
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
735
Trend Micro Deep Security On-Premise 20
Drives Mounted as Directories
Drives mounted as directories are treated as any other directory, unless they are a network drive
in which case they are ignored.
Alternate Data Streams
NTFS based file systems support the concept of alternate data streams. When this feature is
used it behaves conceptually like files within the file.
Note: To demonstrate this, type the following at the command prompt:
echo plain > sample.txt
echo alternate > sample.txt:s
more < sample.txt
more < sample.txt:s
The first "more" will show only the text "plain", the same text that will be displayed if the file is
opened with a standard text editor, such as notepad. The second "more", which accesses the
"s" stream of sample.txt will display the string "alternate".
For FileSets, if no stream is specified, then all streams are included. Each stream is a separate
Entity entry in the baseline. The available attributes for streams are:
l size
l Sha1
l Sha256
l Md5 (deprecated)
l Contents
The following example would include both streams from the demonstration above:
<include key="**/sample.txt" />
To include or exclude specific streams, the ":" notation is used. The following example matches
only the "s" stream on sample.txt and not the main sample.txt stream:
<include key="**/sample.txt:s" />
736
Trend Micro Deep Security On-Premise 20
Pattern matching is supported for the stream notation. The following example would include
sample.txt, but exclude all of its alternate streams:
<include key="**/sample.txt" />
<exclude key="**/sample.txt:*" />
Meaning of "Key"
Key is a pattern to match against the path of the file relative to the directory specified by "base".
This is a hierarchical pattern, with sections of the pattern separated by "/" matched against
sections of the path separated by the file separator of the given OS
Sub Elements
l Include
l Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
Include and Exclude for their allowed attributes and sub elements. Only information specific to
includes and excludes relating to the FileSet Entity Set class are included here.
Special attributes of Include and Exclude for FileSets:
executable
Determines if the file is executable. This does not mean that its permissions allow it to be
executed. Instead the contents of the file are checked, as appropriate for platform, to determine if
the file is an executable file.
Note: This is a relatively expensive operation since it requires the Agent to open the file and
examine the first kilobyte or two of its content looking for a valid executable image header.
Opening and reading every file is much more expensive than simply scanning directories and
matching file names based on wild card patterns, so any include and exclude rules using
"executable" will result in slower scan times than those that do not use it.
GroupSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
737
Trend Micro Deep Security On-Premise 20
GroupSet represents a set of groups. Note these are local groups only.
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the Entity monitored by
Integrity Monitoring Rules.
Attribute Description Required Default Value Allowed Values
onChange Will be monitored in real time No false true, false
Entity Set Attributes
These are the attributes of the entity that can be monitored:
l Description: (Windows only) The textual description of the group.
l Group: The group ID and name. The group name is part of the entity key, but it's still
important to be able to monitor the group ID-name pairing in case groups are renamed and
given new IDs. Operating systems generally enforce security based on its ID.
l Members: A comma separated list of the members of the group.
l SubGroups: (Windows only) A comma separated list of sub-groups of the group.
Short Hand Attributes
l Standard: Group Members SubGroups
Meaning of "Key"
The key is the group's name. This is not a hierarchical Entity Set. Patterns are applied only to the
group name. As a result the "**" pattern is not applicable. The following example monitors the
"Administrators" group for additions and deletions. (The "Member" attribute is included implicitly
because it is a part of the STANDARD set, and no attributes are explicitly listed.)
<GroupSet>
<include key="Administrators" />
</GroupSet>
Include and Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
Include and Exclude and their allowed attributes and sub elements.
738
Trend Micro Deep Security On-Premise 20
InstalledSoftwareSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
Represents a set of installed software. The "key" used to uniquely identify an installed
application is platform-specific, but it is often a shorthand version of the application name or a
unique numeric value.
On Windows, the key can be something readable like "FogBugz Screenshot_is1" or it can be a
GUID like
"{90110409-6000-11D3-8CFE-0150048383C9}". You can examine these by looking at the sub-
keys of HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall
On Linux the key is the RPM package name, as shown by the command:
rpm -qa --qf "%{NAME}\n"
On Solaris the key is the package name as shown by the pkginfo command.
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the computer where
Integrity Monitoring is enabled.
Attribute Description Required Default Value Allowed Values
onChange Will be monitored in real time No false true, false
Entity Set Attributes
These are the attributes of the Entity that can be monitored by Integrity Monitoring Rules.
Presence of the attributes is dependent on both the platform and the application itself -
installation programs do not necessarily populate all of the attributes.
l Manufacturer: The publisher or manufacturer of the application
l Name: The friendly name or display name of the application. (Not available on Linux.)
l InstalledDate: Date of installation. This is normally returned as YYYY-MM-DD
[HH:MM:SS], but many installers on Windows format the date string in a different manner
so this format is not guaranteed. (Not available on AIX.)
739
Trend Micro Deep Security On-Premise 20
l InstallLocation: The directory where the application is installed. (Only available on
Windows and Solaris.)
l Parent: For patches and updates, this gives the key name of this item's parent. (Only
available on Windows.)
l Size: The estimated size of the application, if available. On Windows this attribute is read
from the "EstimatedSize" registry value under HKEY_LOCAL_
MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\*. The value in that
location is expressed in KB, so the Agent multiplies it by 1024 before returning the value.
Note that not all Windows applications populate the EstimatedSize field in the registry.
(Not available on AIX.)
l Version: The version of the installed application. On Windows, this comes from the
"DisplayVersion" registry value.
Short Hand Attributes
These are the short hand attributes of the Entity and the attributes to which they resolve
l STANDARD: InstalledDate, Name, Version
Meaning of "Key"
The key is the name of the installed software. This is not a hierarchical key, so the ** pattern
does not apply. On Windows the key is often a GUID, especially for anything installed via the
Windows Installer (aka MSI). Use the name="XXX" feature if you need to include or exclude
based on the display name rather than the GUID.
The following example would monitor for the addition and deletion of new software.
<InstalledSoftwareSet>
<include key="*"/>
<attributes/>
</InstalledSoftwareSet>
Sub Elements
l Include
l Exclude
740
Trend Micro Deep Security On-Premise 20
See "About the Integrity Monitoring rules language" on page 717 for a general description of
Include and Exclude for their allowed attributes and sub elements. Only information specific to
includes and excludes relating to this EntitySet class are included here.
Special attributes of Include and Exclude for InstalledSoftwareSets:
name (Windows only)
Allows wildcard matching using ? and * on the display name of the application (the "name"
attribute of the Entity). For example:
<InstalledSoftwareSet>
<include name="Microsoft*"/>
<InstalledSoftwareSet>
will match all installed applications whose display name (as shown by the Control Panel) starts
with "Microsoft".
manufacturer
Allows wildcard matching using ? and * on the publisher or manufacturer of the application. For
example:
<InstalledSoftwareSet>
<include manufacturer="* Company "/>
<InstalledSoftwareSet>
will match all installed applications whose manufacturer ends with " Company ".
PortSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
Represents a set of listening ports.
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the Entity monitored by
Integrity Monitoring Rules.
741
Trend Micro Deep Security On-Premise 20
Attribute Description Required Default Value Allowed Values
onChange Will be monitored in real time No false true, false
Entity Set Attributes
These are the attributes of the Entity that can be monitored by Integrity Monitoring Rules.
l Created: Windows only - XP SP2+ and Server 2003 SP1+ required. Returned by the
GetExtendedTcpTable() or GetExtendedUdpTable() functions of the Windows API.
Indicates when the bind operation that created this TCP or UDP link occurred.
l Listeners: The number of active listeners on this protocol, IP address, and port number
combination. This reflects the number of sockets bound-to and listening-on the given port,
and may be greater than the number of processes listening on the port if processes bind
multiple sockets to the port. This attribute has no value if only one socket is bound to the
given port.
l Path: Windows only - XP SP2+ and Server 2003 SP1+ required. Gives the short name, if
available, of the module that owns the port. On Windows this comes from the
GetOwnerModuleFromXxxEntry() functions of the Windows API. According to Microsoft
documentation, the resolution of connection table entries to owner modules is a best
practice. In a few cases, the owner module name returned can be a process name, such as
"svchost.exe", a service name (such as "RPC"), or a component name, such as "timer.dll".
l Process: (Windows only - XP SP2+ and Server 2003 SP1+ required.) Gives the full path,
if available, of the module that owns the port. On Windows this comes from the
GetOwnerModuleFromXxxEntry() functions of the Windows API. According to Microsoft
documentation, the resolution of connection table entries to owner modules is a best
practice.
l ProcessId: (Windows only - XP SP2+ and Server 2003 SP1+ required.) Gives the PID of
the process that issued the bind for this port.
l User: (Linux only). Gives the user that owns the port.
Meaning of "Key"
The key is in the following format:
<PROTOCOL>/<IP ADDRESS>/<PORT>
For example:
tcp/172.14.207.94/80
udp/172.14.207.94/68
742
Trend Micro Deep Security On-Premise 20
IPV6
If the IP address is IPv6 the key is in the same format, but the protocol is TCP6 or UDP6 and the
IP address is an IPv6 address as returned by the getnameinfo command:
tcp6/3ffe:1900:4545:3:200:f8ff:fe21:67cf/80
udp6/3ffe:1900:4545:3:200:f8ff:fe21:67cf/68
Matching of the Key
This is not a hierarchical key, so ** is not applicable. Unix-style glob matching is possible using *
and ?. The following pattern matches port 80 on the IP addresses 72.14.207.90 through
72.14.207.99:
*/72.14.207.9?/80
The following pattern matches port 80 on the IP addresses 72.14.207.2, 72.14.207.20 through
72.14.207.29 as well as 72.14.207.200 through 72.14.207.255:
*/72.14.207.2*/80
The following pattern matches port 80 on any IP.
*/80
The following example would monitor for any change in the listening ports but ignore port 80 for
TCP in IPv4 and IPv6:
<PortSet>
<include key="*"/>
<exclude key="tcp*/*/80"/>
</PortSet>
Sub Elements
l Include
l Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
Include and Exclude and their allowed attributes and sub elements. Only information specific to
includes and excludes relating to this EntitySet class are included here.
743
Trend Micro Deep Security On-Premise 20
Special attributes of Include and Exclude for PortSets:
Various other attributes of the port may be used in include and exclude feature tests. These tests
compare a value against the value of an attribute of the port; take note of the platform support for
various attributes - not all attributes are available across platforms or even platform revisions,
hence the use of these tests in include and exclude tags is of limited use. The feature tests
support Unix glob-style wildcarding with * and ?, and there is no normalization of path separators
or other characters - it is a simple match against the value of the attribute.
Path
Checks for a wildcard match against the path attribute of the port. The following example would
monitor ports owned by processes running the main IIS binary:
<PortSet>
<include path="*\system32\inetsrv\inetinfo.exe"/>
</PortSet>
Process
Checks for a wildcard match against the process attribute of the port. The following example
would monitor ports owned by anything running in a svchost.exe or outlook.* binary:
<PortSet>
<include process="svchost.exe"/>
<include process="outlook.*"/>
</PortSet>
User
Checks for a wildcard match against the user attribute of the port. The following example would
monitor ports on a Unix system that were owned by the super-user (root):
<PortSet>
<include user="root"/>
</PortSet>
ProcessSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
744
Trend Micro Deep Security On-Premise 20
Represents a set of processes.
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the Entity monitored by
Integrity Monitoring Rules.
Attribute Description Required Default Value Allowed Values
onChange Will be monitored in real time No false true, false
Entity Set Attributes
These are the attributes of the Entity that can be monitored by Integrity Monitoring Rules.
l CommandLine: The full command-line as shown by "ps -f" (Unix), "ps w" (Linux), or
Process Explorer (Windows).
l Group: The group under which the process is running.
l Under Unix this is the "effective" group ID of the process, which determines shared
resource access and, in some cases, file access. Group ID can change if the process
drops privileges or otherwise switches its effective group credentials. For example, a
program could change group IDs temporarily and obtain write privileges to copy
installation files into a directory where the user has read-only privileges.
l On Windows this is the “current" Primary Group of the process as established by a
user-specific access token created at login, which sets access and resource privileges
for the user and any processes they execute.
Note: In addition to a Primary Group, Windows processes typically have one or
more additional group credentials associated with them. These additional group
credentials are not monitored by the Agent – they can be viewed in the Security tab
of the process properties in Process Explorer.
l Parent: The PID of the process that created this process.
l Path: The full path to the binary of the process. On Windows, this comes from the
GetModuleFileNameEx() API. On Linux and Solaris 10, it comes from reading the symlink
/proc/{pid}/exe or /proc/{pid}/path/a.out respectively. (Not available on Solaris 9 and AIX.)
l Process: The short name of the process binary (no path). For example, for
"c:\windows\notepad.exe" it would be "notepad.exe" and for "/usr/local/bin/httpd" it would
be "httpd".
l Threads: The number of threads currently executing in the process.
745
Trend Micro Deep Security On-Premise 20
l User: The user under which the process is running. Under Unix this is the "effective" user
ID of the process, which can change over time if the process drops privileges or otherwise
switches its effective user credentials.
Short Hand Attributes
l STANDARD: CommandLine, Group, Parent, Path (where available), Process User
Meaning of "Key"
The key is a combination of the "Process" attribute (the short name of the executable) and the
PID. The PID is appended to the name with a path separator in between, ex. notepad.exe\1234
on Windows and httpd/1234 on Unix. The use of the path separator is to allow include or
exclude matching of key="abc/*" to work as expected.
Sub Elements
l Include
l Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
include for their allowed attributes and sub elements. Only information specific to includes and
excludes relating to this EntitySet class are included here.
Special attributes of Include and Exclude for ProcessSets:
The following example would monitor the set of running processes for notepad.exe regardless of
the PID.
<ProcessSet>
<include key="notepad.exe\*" />
</ProcessSet>
Various other attributes of a process can be used in include and exclude feature tests. The
feature tests support Unix glob-style wildcarding with * and ?, and there is no normalization of
path separators or other characters - it is a simple glob-style match against the value of the
attribute.
CommandLine
Checks for a wildcard match against the commandLine attribute of the process. The following
example would monitor any process whose command-line matches "*httpd *":
746
Trend Micro Deep Security On-Premise 20
<ProcessSet>
<include commandLine="*httpd *" />
</ProcessSet>
Group
Checks for a wildcard match against the group attribute of the process. The text version of the
group name is used rather than the numeric form: use "daemon" rather than "2" to test for the
daemon group on Linux. The following example would monitor any process running as one of
the groups root, daemon, or lp:
<ProcessSet>
<include group="root" />
<include group="daemon" />
<include group="lp" />
</ProcessSet>
Path
Checks for a wildcard match against the path attribute of the process. The path attribute is not
available on some platforms. The following example would monitor any process whose binary
resides under System32:
<ProcessSet>
<include path="*\System32\*" />
</ProcessSet>
User
Checks for a wildcard match against the user attribute of the process. The text version of the user
name is used rather than the numeric form: use "root" rather than "0" (zero) to test for the
superuser on Unix. The following example would monitor any process running as one of the built
in system users (ex. NT AUTHORITY\SYSTEM, NT AUTHORITY\LOCAL SERVICE, NT
AUTHORITY\NETWORK SERVICE):
<ProcessSet>
<include user="NT AUTHORITY\*" />
</ProcessSet>
RegistryKeySet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
747
Trend Micro Deep Security On-Premise 20
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
The RegistryKeySet tag describes a set keys in the registry (Windows only).
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the Entity monitored by
Integrity Monitoring Rules.
Default
Attribute Description Required Allowed Values
Value
Sets the base key of the RegistryKeySet.
Everything else in the tag is relative to this key.
String values
The base must begin with one of the following
resolving to
registry branch names:
base Yes N/A syntactically
HKEY_CLASSES_ROOT (or HKCR),
valid registry key
HKEY_LOCAL_MACHINE (or HKLM),
path
HKEY_USERS (or HKU),
HKEY_CURRENT_CONFIG (or HKCC)
Entity Set Attributes
These are the attributes of the Entity that can be monitored by Integrity Monitoring Rules.
l Owner
l Group
l Permissions
l LastModified ("LastWriteTime" in Windows registry terminology)
l Class
l SecurityDescriptorSize
Short Hand Attributes
l STANDARD: Group, Owner, Permissions, LastModified
Meaning of "Key"
Registry Keys are stored hierarchically in the registry, much like directories in a file system. For
the purpose of this language the "key path" to a key is considered to look like the path to a
directory. For example the "key path" to the "Deep Security Agent" key of the Agent would be:
748
Trend Micro Deep Security On-Premise 20
HKEY_LOCAL_MACHINE\SOFTWARE\Trend Micro\Deep Security Agent
The "key" value for includes and excludes for the RegistryValueSet is matched against the key
path. This is a hierarchical pattern, with sections of the pattern separated by "/" matched against
sections of the key path separated by "\".
Sub Elements
l Include
l Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
include for their allowed attributes and sub elements.
RegistryValueSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
A set of Registry values (Windows only).
Tag Attributes
These are XML attributes of the tag itself as opposed to the attributes of the entity monitored by
Integrity Monitoring Rules.
Default
Attribute Description Required Allowed Values
Value
Sets the base key of the RegistryValueSet.
Everything else in the tag is relative to this key.
The base must begin with one of the registry String values
branch names: resolving to
base Yes N/A
HKEY_CLASSES_ROOT (or HKCR), syntactically
HKEY_LOCAL_MACHINE (or HKLM), valid registry key
HKEY_USERS (or HKU),
HKEY_CURRENT_CONFIG (or HKCC)
Entity Set Attributes
These are the attributes of the Entity that can be monitored by Integrity Monitoring Rules:
749
Trend Micro Deep Security On-Premise 20
l Size
l Type
l Sha1
l Sha256
l Md5 (deprecated)
Short Hand Attributes
l CONTENTS: Resolves to the content hash algorithm set in Computer or Policy editor 1 >
Integrity Monitoring > Advanced.
l STANDARD: Size, Type, Contents
Meaning of "Key"
Registry Values are name-value pairs stored under a key in the registry. The key under which
they are stored may in turn be stored under another key, very much like files and directories on a
file system. For the purpose of this language the "key path" to a value is considered to look like
the path to a file. For example, the "key path" to the InstallationFolder value of the Agent would
be:
HKEY_LOCAL_MACHINE\SOFTWARE\Trend Micro\Deep Security
Agent\InstallationFolder
The "key" value for includes and excludes for the RegistryValueSet is matched against the key
path. This is a hierarchical pattern, with sections of the pattern separated by "/" matched against
sections of the key path separated by "\"
Default Value
Each registry key has an unnamed or default value.
This value can be explicitly specified for inclusion and exclusion by using a trailing "/" in
patterns. For example, "**/" will match all subordinate unnamed values, and "*Agent/**/" will
match all unnamed values below a key matching "*Agent".
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
750
Trend Micro Deep Security On-Premise 20
Note: Registry value names can contain any printable character, including quotes, backslash,
the "@" symbol, etc.
The Agent deals with this in Entity key names by using backslash as an escape character, but
only backslashes themselves are escaped. It does this so that it can tell the difference between a
value name containing a backslash and a backslash that occurs as part of the registry path. This
means that value names which end with a backslash character will match rules designed to
match the default or unnamed value.
See the table below for example registry value names and the resulting Entity key.
Value Escaped Form Example
Hello Hello HKLM\Software\Sample\Hello
"Quotes" "Quotes" HKLM\Software\Sample\"Quotes"
back\slash back\\slash HKLM\Software\Sample\back\\slash
trailing\ trailing\\ HKLM\Software\Sample\trailing\\
HKLM\Software\Sample\
@ @ HKLM\Software\Sample\@
Sub Elements
l Include
l Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
Include and Exclude for their allowed attributes and sub elements.
ServiceSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
The ServiceSet element represents a set of services (Windows only). Services are identified by
the "service name", which is not the same as the "name" column shown in the Services
administrative tool. The service name can be seen in the service properties and is often shorter
than the value shown in the "name" column, which is actually the "Display Name" of the service.
For example, the Agent has a service name of "ds_agent" and a display name of "Trend Micro
Deep Security Agent".
751
Trend Micro Deep Security On-Premise 20
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the Entity monitored by
Integrity Monitoring Rules.
Attribute Description Required Default Value Allowed Values
onChange Will be monitored in real time No false true, false
Entity Set Attributes
These are the attributes of the Entity that can be monitored by Integrity Monitoring Rules.
l Permissions: The service's security descriptor in SDDL format.
l Owner: User ID of the service owner
l Group: Group ID of the service owner
l BinaryPathName: The path plus optional command-line arguments that Windows uses to
start the service.
l DisplayName: The "display name" of the service as shown in the properties panel of the
service.
l Description: Description as it appears in the Services panel
l State: The current state of the service. One of: stopped, starting, stopping, running,
continuePending, pausePending, paused
l StartType: How is the service started? One of: automatic, disabled, manual.
l LogOnAs: The name of the account that the service process will be logged on as when it
runs.
l FirstFailure: Action to take the first time the service fails. Format is "delayInMsec,action",
where action is one of None, Restart, Reboot, RunCommand.
l SecondFailure: Action to take the second time the service fails. Format is
"delayInMsec,action", where action is one of None, Restart, Reboot, RunCommand.
l SubsequentFailures: Action to take if the service fails for a third or subsequent time.
Format is "delayInMsec,action", where action is one of None, Restart, Reboot,
RunCommand.
l ResetFailCountAfter: Time after which to reset the failure count to zero if there are no
failures, in seconds.
l RebootMessage: Message to broadcast to server users before rebooting in response to
the "Reboot" service controller action.
752
Trend Micro Deep Security On-Premise 20
l RunProgram: Full command line of the process to execute in response to the
RunCommand service controller action.
l DependsOn: Comma separated list of components that the service depends on
l LoadOrderGroup: The load ordering group to which this service belongs. The system
startup program uses load ordering groups to load groups of services in a specified order
with respect to the other groups. The list of load ordering groups is contained in the
following registry value: HKEY_LOCAL_
MACHINE\System\CurrentControlSet\Control\ServiceGroupOrder
l ProcessId: This is the numeric ID of the process that hosts the service. Many services may
exist in a single Windows process, but for those that run in their own process, the
monitoring of this attribute will allow the system to log service restarts.
Short Hand Attributes
These are the short hand attributes of the Entity and the attributes to which they resolve
l STANDARD: Permissions, Owner, Group, BinaryPathName, Description, State, StartType,
LogOnAs, FirstFailure, SecondFailure, SubsequentFailures, ResetFailCountAfter,
RunProgram, DependsOn, LoadOrderGroup, ProcessId
Meaning of "Key"
The key is the Service's name, which is not necessarily the same as the "name" column shown
in the Services administrative tool (that tool shows the "display name" of the service). The
service name can be seen in the service properties and is often shorter than the value shown in
the "name" column.
Note: This is not a hierarchical Entity Set. Patterns are applied only to the service name. As a
result the ** pattern is not applicable.
Sub Elements
l Include
l Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
include for their allowed attributes and sub elements. Only information specific to includes and
excludes relating to this Entity Set class are included here.
753
Trend Micro Deep Security On-Premise 20
Special attributes of Include and Exclude for ServiceSets:
state
Include or exclude based on whether the state of the service (stopped, starting, stopping,
running, continuePending, pausePending, paused). The following example would monitor the
set of running services for change:
<ServiceSet>
<include state="running"/>
</ServiceSet>
UserSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
The UserSet element represents a set of users. On a Windows system it operates on users local
to the system - the same users displayed by the "Local Users and Groups" MMC snap-in. Note
that these are local users only if the Deep Security Agent is running on something other than a
domain controller. On a domain controller, a UserSet element will enumerate all of the domain
users, which may not be advisable for extremely large domains.
On Unix systems, the users monitored are whatever the "getpwent_r()" and "getspnam_r()" APIs
have been configured to return. On AIX systems specifically, the users monitored are those listed
in the /etc/passwd file.
Tag Attributes
These are XML attributes of the tag itself, as opposed to the attributes of the Entity monitored by
Integrity Monitoring Rules.
Attribute Description Required Default Value Allowed Values
onChange Will be monitored in real time No false true, false
Entity Set Attributes
These are the attributes of the entity that can be monitored:
754
Trend Micro Deep Security On-Premise 20
Common Attributes
l cannotChangePassword: True or false indicating if the user is permitted to change their
password.
l disabled: True or false indicating if the account has been disabled. On Windows systems
this reflects the "disabled" check box for the user. On Unix systems this will be true if the
user's account has expired or if their password has expired and they've exceeded the
inactivity grace period for changing it.
l fullName: The display name of the user.
l groups: A comma-separated list of the groups to which the user belongs.
l homeFolder: The path to the home folder or directory.
l lockedOut: True or false indicating if the user has been locked out, either explicitly or due
to excessive failed password attempts.
l passwordHasExpired: True or false indicating if the user's password has expired. Note
that on Windows this attribute is only available on Windows XP and newer operating
systems.
l passwordLastChanged: The timestamp of the last time the user's password was changed.
This is recorded by the Deep Security Agent as the number of milliseconds since Jan 1
1970 UTC - Deep Security Manager renders the timestamp in local time based on this
value. Note that on Unix platforms, the resolution of this attribute is one day, so the time
component of the rendered timestamp is meaningless. (Not supported by AIX.)
l passwordNeverExpires: True or false indicating if the password does not expire.
l user: The name of the user as known to the operating system. For example,
"Administrator" or "root".
Windows-only Attributes
l description: The primary group the user belongs to.
l homeDriveLetter: The drive letter to which a network share is mapped as the user's home
folder.
l logonScript: The path to a script that executes every time the user logs in.
l profilePath: A network path if roaming or mandatory Windows user profiles are being
used.
755
Trend Micro Deep Security On-Premise 20
Linux, AIX, and Solaris Attributes
l group: The primary group the user belongs to.
l logonShell: The path to the shell process for the user.
l passwordExpiredDaysBeforeDisabled: The number of days after the user's password
expires that the account is disabled. On Solaris, this attribute refers to the number of
inactive days before the user is disabled. (Not supported by AIX.)
l passwordExpiry: The date on which the user's account expires and is disabled.
l passwordExpiryInDays: The number of days after which the user's password must be
changed.
l passwordMinDaysBetweenChanges: The minimum number of days permitted between
password changes.
l passwordWarningDays: The number of days before the user's password is to expire that
user is warned.
Short Hand Attributes
l Standard:
l cannotChangePassword
l disabled
l groups
l homeFolder
l passwordHasExpired
l passwordLastChanged
l passwordNeverExpires
l user
l logonScript (Windows-only)
l profilePath (Windows-only)
l group (Linux-only)
l logonShell (Linux-only)
l passwordExpiryInDays (Linux-only)
l passwordMinDaysBetweenChanges (Linux-only)
756
Trend Micro Deep Security On-Premise 20
Meaning of "Key"
The key is the username. This is not a hierarchical EntitySet. Patterns are applied only to the
user name. As a result the "**" pattern is not applicable.
The following example monitors for any user creations or deletions. (Note that attributes are
explicitly excluded so group membership would not be tracked):
<UserSet>
<Attributes/>
<include key="*" />
</UserSet>
The following example would track the creation and deletion of the "jsmith" account, along with
any changes to the STANDARD attributes of the account (since the STANDARD set for this
EntitySet is automatically included if no specific attribute list is included):
<UserSet>
<include key="jsmith" />
</UserSet>
Sub Elements
Include and Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
include for their allowed attributes and sub elements.
Special attributes of Include and Exclude for UserSets
Various other attributes of the user may be used in include and exclude feature tests. These
tests compare a value against the value of an attribute of the user; take note of the platform
support for various attributes - not all attributes are available across platforms or even platform
revisions, hence the use of these tests in include and exclude elements is of limited use. The
feature tests support Unix glob-style wildcarding with * and ?, and there is no normalization of
path separators or other characters - it is a simple match against the value of the attribute.
l Disabled: Does true or false match the disabled attribute of the user. The following
example monitors users with a primary group of either "users" or "daemon":
<UserSet>
<include disabled="true"/>
</UserSet>
757
Trend Micro Deep Security On-Premise 20
l Group: Does a wildcard match against the primary group of the user. This test is only
applicable on Unix systems. The following example would monitor users with a primary
group of either "users" or "daemon".
<UserSet>
<include group="users"/>
<include group="daemon"/>
</UserSet>
l LockedOut: Does a true or false match against the lockedOut attribute of the user.
l PasswordHasExpired: Does a true or false match against the passwordHasExpired
attribute of the user.
l PasswordNeverExpires: Does a true or false match against the passwordNeverExpires
attribute of the user.
WQLSet
Note: The Integrity Monitoring module scans for unexpected changes to directories, registry
values, registry keys, services, processes, installed software, ports, groups, users, files, and
the WQL query statement on Deep Security Agents. To enable and configure Integrity
Monitoring, see "Set up Integrity Monitoring" on page 705.
The WQLSet element describes a result set from a Windows Management Instrumentation WQL
query statement. WQL allows SQL-like queries to be made against many different object
classes, with the results forming a table of rows where each row represents an object and each
column represents the value of a specific attribute of the object.
Note: Many WMI queries consume a large amount of time and computer resources. It is easy
to inadvertently issue a query that takes several minutes to complete and returns thousands of
rows. It is highly recommended that all queries be tested before use in a WQLSet using a
program like Powershell or WMI Explorer.
Default
Attribute Description Required Allowed Values
Value
String values representing a valid WMI
namespace.
Sets the
namespace The "root\cimv2" namespace is the one most
namespace Yes N/A
of the WMI commonly used when querying Windows
query. operating system objects, but others such as
"root\directory\LDAP" and
758
Trend Micro Deep Security On-Premise 20
Default
Attribute Description Required Allowed Values
Value
"root\Microsoft\SqlServer\ComputerManagement"
can be used. See here for a small script called
GetNamespaces.vbs that enumerates the
available WMI namespaces on a given computer.
A valid WQL string.
The query must include the __Path attribute for
each returned object; the Agent uses the __Path
attribute as the entity key when storing and
A WQL reporting results, so each returned WMI object
wql Yes N/A
query string. must include a __Path. If using a query string
such as "SELECT * FROM ..." the __Path
attribute will be available, but if using a more
selective query such as "SELECT Name FROM
..." you must explicitly include __Path by writing
the query as "SELECT __Path,Name FROM ...".
Whether the
files returned
onChange should be No false true, false
monitored in
real time.
RsopLoggingModeProvider
At present this is only required/supported for
group policy queries, and
"RsopLoggingModeProvider" is the only
supported value. Group policy queries are special
since it's recommended that the
RsopLoggingModeProvider be used to create a
snapshot of the policy data that is present on a
Optionally computer. If you create a snapshot of the policy
specifies an data, the query can be performed against a
alternative consistent set of data before the system
provider WMI No none overwrites or deletes it during a refresh of policy.
namespace Creating a snapshot actually creates a new WMI
provider to namespace, so when using
use. provider="RsopLoggingModeProvider" in a
WQLSet, the namespace attribute should specify
the suffix to be added to the created namespace.
For example, a typical temporary namespace
created by the RsopLoggingModeProvider would
be "\\.\Root\Rsop\NS71EF4AA3_FB96_465F_
AC1C_DFCF9A3E9010". Specify
namespace="Computer" to query
"\\.\Root\Rsop\NS71EF4AA3_FB96_465F_
AC1C_DFCF9A3E9010\Computer".
759
Trend Micro Deep Security On-Premise 20
Default
Attribute Description Required Allowed Values
Value
Since the temporary namespace is a one-time
value, it hampers the ability of the Agent to detect
changes since the value appears in the entity key.
To avoid this, the Agent will remove the portion of
the returned __Path value after \Rsop\ and up to
the next backslash when the
RsopLoggingModeProvider is used. Entity keys
will therefore have prefixes like
"\\.\Root\Rsop\Computer" rather than
"\\.\Root\Rsop\NS71EF4AA3_FB96_465F_
AC1C_DFCF9A3E9010\Computer"
1-60000
Specifies a
The WMI query is performed in semisynchronous
per-row
timeout No 5000 mode, where result rows are fetched one at a time
timeout in
and there is a timeout on the fetching of a single
milliseconds.
row. If this parameter is not specified, 5000 (5
seconds) is used as the timeout value.
Entity Set Attributes
Each "row" returned by the WQL query is treated as a single Entity for Integrity Monitoring
purposes, with the returned columns representing the attributes of the entity. Since WMI/WQL is
an open-ended specification, there is no set list of available or supported attributes. The query
and the schema of the WMI object being queried will determine the attributes being monitored.
For example, the WQLSet:
<WQLSet namespace="Computer" wql="select * from RSOP_SecuritySettings
where precedence=1" provider="RsopLoggingModeProvider" />
will return attributes of:
ErrorCode, GPOID, KeyName, SOMID, Setting, Status, id, precedence
whereas a WQLSet that queries network adapters such as:
<WQLSet namespace="root\cimv2" wql="select * from Win32_NetworkAdapter
where AdapterTypeId = 0" />
will return attributes such as:
760
Trend Micro Deep Security On-Premise 20
AdapterType, AdapterTypeId, Availability, Caption, ConfigManagerErrorCode,
ConfigManagerUserConfig, CreationClassName Description, DeviceID, Index,
Installed, MACAddress, Manufacturer, MaxNumberControlled, Name,
PNPDeviceID, PowerManagementSupported, ProductName, ServiceName,
SystemCreationClassName, SystemName, TimeOfLastReset
In order to reduce the load on the Agent, it is advisable to explicitly include only the attributes
that require monitoring rather than use "select * ..." in queries. This also has the benefit that
changes to the WMI schema to add or remove attributes will not be reported as changes to the
object unless the attributes are part of the set being monitored. With "select * from Win32_
Foobar", a patch to Windows that adds a new attribute to the Win32_Foobar object class would
result in the next integrity scan reporting a change for every object of that class since a new
attribute has appeared.
The following are some example WMI queries which return desirable Windows system entities.
Query for Windows mounted storage devices: (selecting for * will typically result in 80% returned
attributes being null or duplicate values)
<WQLSet namespace="root\cimv2" wql="SELECT __
Path,DeviceID,VolumeName,VolumeSerialNumber,DriveType,FileSystem,Access,Me
diaType,Size,FreeSpace FROM Win32_LogicalDisk" />
To further the preceding query, the DriveType can be specified to isolate only certain types of
mounted logical storage devices, such as type 2 which is a "Removable Disk": (like a removable
USB storage drive)
<WQLSet namespace="root\cimv2" wql="SELECT __
Path,DeviceID,VolumeName,VolumeSerialNumber,DriveType,FileSystem,Access,Me
diaType,Size,FreeSpace FROM Win32_LogicalDisk WHERE DriveType=2" />
(See here for details on the Win32_LogicalDisk class)
USB Storage Device notes: U3 USB devices will mount both a type 2 "Removable Disk" device
and a type 3 "Compact Disc" device. Also, the above query is for storage devices only. USB
non-storage devices will not be included. USB memory card adapters may appear as a type 1
"No Root Directory" device. A badly or Windows incompatible USB storage device may appear
as a type 1 "Unknown" device.
Query for all known System Directories where the Drive is "F:" for relevant attributes:
<WQLSet namespace="root\cimv2" wql="SELECT __
761
Trend Micro Deep Security On-Premise 20
Path,CreationDate,LastAccessed,LastModified,Drive,Path,FileName,Caption,Fi
leType,Readable,Writeable FROM Win32_Directory WHERE Drive='F:'" />
Query for all known System Files where the Drive is "F:" for relevant attributes:
<WQLSet namespace="root\cimv2" wql="SELECT __
Path,CreationDate,LastAccessed,LastModified,Drive,Path,FileName,Name,FileT
ype,Readable,Writeable FROM CIM_DataFile WHERE Drive='F:'" />
Meaning of Key
The key is the "__Path" attribute of the returned WMI object, which is generally of the form:
SystemName\Namespace:WmiObjectClass.KeyAttribute=Value
[,KeyAttribute=Value...]
Some examples:
\\TEST-DESK\root\cimv2:Win32_QuickFixEngineering.HotFixID="KB958215-
IE7",ServicePackInEffect="SP0"
\\TEST-DESK\ROOT\Rsop\NSF49B36AD_10A3_4F20_9541_
B4C471907CE7\Computer:RSOP_RegistryValue.
Path="MACHINE\\Software\\Microsoft\\Windows\\CurrentVersion\\Policies\\Sys
tem\\LegalNoticeText",precedence=1
\\TEST-DESK\root\cimv2:BRCM_NetworkAdapter.DeviceID="8"
Include Exclude
See "About the Integrity Monitoring rules language" on page 717 for a general description of
"include" and "exclude" for their allowed attributes and sub elements.
For WQLSet, "include" and "exclude" sub elements should typically not be required. It is
preferable to use WQL to specify the exact set of objects to be monitored since that limits the
amount of work done by both the agent and the computer's WMI implementation.
The use of any include or exclude sub elements can only reduce the set of objects returned by
the query; the WQL must be changed in order to return additional objects. If it is necessary to use
include or exclude elements to further restrict the WQL results, "*"and "?" characters can be used
as simple wildcards to match against values of the entity key.
762
Trend Micro Deep Security On-Premise 20
Virtual Appliance Scan Caching
Scan Caching is used by the Virtual Appliance to maximize the efficiency of Anti-Malware and
Integrity Monitoring Scans of virtual machines. Scan Caching improves the efficiency of scans by
eliminating the unnecessary scanning of identical content across multiple VMs in large VMware
deployments. A Scan Cache contains lists of files and other scan targets that have been
scanned by a Deep Security protection module. If a scan target on a virtual machine is
determined to be identical to a target that has already been scanned, the Virtual Appliance will
not scan the target a second time. Attributes used to determine whether entities are identical are
creation time, modification time, file size, and file name. In the case of Real-time Scan Caching,
Deep Security will read partial content of files to determine if two files are identical. There is an
option setting to use a file's Update Sequence Number (USN, Windows only) but its use should
be limited to cloned virtual machines.
Scan Caching benefits Integrity Monitoring by sharing Integrity Monitoring scan results among
cloned or similar virtual machines.
Scan Caching benefits Manual Malware Scans of cloned or similar virtual machines by
increasing the speed up subsequent scans.
Scan Caching benefits Real-Time Malware Scanning by speeding up boot process scans and
application access scans on cloned or similar virtual machines.
Scan Cache Configurations
A Scan Cache Configuration is a collection of settings that determines Expiry Time, the use of
Update Sequence Numbers (USNs), files to exclude, and files to include.
Note: Virtual machines that use the same Scan Cache Configuration also share the same
Scan Cache.
You can see the list of existing Scan Cache Configurations by going Administration > System
Settings > Advanced>Scan Cache Configurations and clicking View Scan Cache
Configurations . Deep Security comes with several preconfigured default Scan Cache
Configurations. These are implemented automatically by the Virtual Appliance depending the
properties of the virtual machines being protected and the types of scan being performed.
Expiry Time determines the lifetime of individual entries in a Scan Cache. The default
recommended settings are one day for Manual (on-demand) or Scheduled Malware Scans, 15
mins for Real-Time Malware Scans, and one day for Integrity Monitoring Scans.
763
Trend Micro Deep Security On-Premise 20
Use USN (Windows only) specifies whether to make use of Windows NTFS Update Sequence
Numbers, which is a 64-bit number used to record changes to an individual file. This option
should only be set for cloned VMs.
Files Included and Files Excluded are regular expression patterns and lists of files to be
included in or excluded from the Scan Cache. Files to be scanned are matched against the
include list first.
Individual files and folders can be identified by name or you can use wildcards ("*" and "?") to
refer to multiple files and locations with a single expression. (Use "*" to represent any zero or
more characters, and use question mark "?" to represent any single character.)
Note: The include and exclude lists only determine whether the scan of the file will take
advantage of Scan Caching. The lists will not prevent a file from being scanned in the
traditional way.
Malware Scan Cache Configuration
To select which Scan Cache Configuration is used by a virtual machine, open the Computer or
Policy editor 1 and go to Anti-Malware > Advanced > VM Scan Cache. You can select which
Scan Cache Configuration is used for Real-Time Malware Scans and which Scan Cache
Configuration is used for manual and scheduled scans.
Integrity Monitoring Scan Cache Configuration
To select which Scan Cache Configuration is used by a virtual machine, open the Computer or
Policy editor 2 and go to Integrity Monitoring > Advanced > VM Scan Cache.
Scan Cache Settings
Scan Cache Settings are not included in a Scan Cache Configuration because they determine
how the Virtual Appliance manages Scan Caches rather than how Scan Caching is carried out.
Scan Cache settings are controlled at the Policy level. You can find the Scan cache settings by
opening a Policy editor 3 and going to the Settings > General > Virtual Appliance Scans area.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
3To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
764
Trend Micro Deep Security On-Premise 20
Max Concurrent Scans determines the number of scans that the Virtual Appliance performs at
the same time. The recommended number is five. If you increase this number beyond 10, scan
performance may degrade. Scan requests are queued by the virtual appliance and carried out in
the order in which they arrive. This setting applies to manual and scheduled scans.
Max On-Demand Malware Scan Cache Entries determines, for manual or scheduled malware
scans, the maximum number of records that identify and describe a file or other type of
scannable content to keep. One million entries use approximately 100 MB of memory.
Max Malware Real-Time Scan Cache Entries determines, for real-time malware scans, the
maximum number of records that identify and describe a file or other type of scannable content to
keep. One million entries use approximately 100MB of memory.
Max Integrity Monitoring Scan Cache Entries determines the maximum number of entities
included in the baseline data for integrity monitoring. Two hundred thousand entities use
approximately 100MB of memory.
When to change the default configuration
Scan caching is designed to avoid scanning identical files twice. Deep Security does not
examine the entire contents of all files to determine if files are identical. Although when
configured to do so, Deep Security can check the USN value of a file, and during Real-time
Scans it will read partial content of files, it generally examines file attributes to determine if files
are identical. It would be difficult but not impossible for some malware to make changes to a file
and then restore those files attributes to what they were before the file was modified.
Deep Security limits this potential vulnerability by establishing short default cache expiry times.
To strengthen the security you can use shorter expiry times on cache and you can use USN but
doing so may reduce the performance benefit or require a larger cache setting. For the strongest
security for VMs that you want to keep separate and never share scan results you can create
dedicated policies for these VMs kind of like keeping them in separate zones. This might be
appropriate if you have different departments or organizations sharing the same infrastructure.
(In a multi-tenant Deep Security Manager, this is automatically enforced for each tenant.)
If you have a very large number of guest VMs per ESXi host (for example, a VDI environment),
then you should monitor your disk I/O and CPU usage during scanning. If scanning takes too
long, then you may need to increase the size of the cache or adjust the Scan Cache Settings
until you get better performance. If you need to increase cache size, then you may need to adjust
Deep Security Virtual Appliance system memory too.
765
Trend Micro Deep Security On-Premise 20
Configure Log Inspection
About Log Inspection
Note: For a list of operating systems where log inspection is supported, see "Supported
features by platform" on page 145.
The log inspection protection module helps you identify important events that might be buried in
your operating system and application logs. These events can be sent to a security information
and event management (SIEM) system or centralized logging server for correlation, reporting,
and archiving. All events are also securely collected in the Deep Security Manager. For more
information about logging and forwarding events, see "Configure log inspection event forwarding
and storage" on page 769.
The log inspection module lets you:
l Meet PCI DSS log monitoring requirements.
l Detect suspicious behavior.
l Collect events across heterogeneous environments containing different operating systems
and diverse applications.
l View events such as error and informational events (disk full, service start, service
shutdown, etc.).
l Create and maintain audit trails of administrator activity (administrator login or logout,
account lockout, policy change, etc.).
To enable and configure log inspection, see "Set up Log Inspection" below.
The log inspection feature in Deep Security enables real-time analysis of third party log files.
The log inspection rules and decoders provide a framework to parse, analyze, rank and correlate
events across a wide variety of systems. As with intrusion prevention and integrity monitoring,
log inspection content is delivered in the form of rules included in a security update. These rules
provide a high level means of selecting the applications and logs to be analyzed. To configure
and examine log inspection rules, see "Define a Log Inspection rule for use in policies" on
page 770.
Set up Log Inspection
To use log inspection, perform these basic steps:
766
Trend Micro Deep Security On-Premise 20
1. "Turn on the log inspection module" below
2. "Run a recommendation scan" below
3. "Apply the recommended log inspection rules" below
4. "Test Log Inspection" on page 769
5. "Configure log inspection event forwarding and storage" on page 769
For an overview of the log inspection module, see "About Log Inspection" on the previous page.
Turn on the log inspection module
1. Go to Policies.
2. Double-click the policy for which you want to enable log inspection.
3. Click Log Inspection > General.
4. For Log Inspection State, select On.
5. Click Save.
Run a recommendation scan
Rules should be set to gather security events relevant to your requirements. When improperly
set, events for this feature can overwhelm the Deep Security database if too many log entries are
triggered and stored. Run a recommendation scan on the computer for recommendations about
which rules are appropriate to apply.
1. Go to Computers and double-click the appropriate computer.
2. Click Log Inspection > General.
3. For Automatically implement Log Inspection Rule Recommendations (when possible),
you can decide whether Deep Security should implement the rules it finds by selecting Yes
or No.
4. In the Recommendations section, click Scan For Recommendations. Some log inspection
rules written by Trend Micro require local configuration to function properly. If you assign
one of these rules to your computers or one of these rules gets assigned automatically, an
alert will be raised to notify you that configuration is required.
For more information about recommendation scans, see "Manage and run recommendation
scans" on page 456.
Apply the recommended log inspection rules
Deep Security ships with many pre-defined rules covering a wide variety of operating systems
and applications. When you run a recommendation scan, you can choose to have Deep Security
automatically implement the recommended rules, or you can choose to manually select and
assign the rules by following the steps below:
767
Trend Micro Deep Security On-Premise 20
1. Go to Policies.
2. Double-click the policy that you want to configure.
3. Click Log Inspection > General.
4. In the Assigned Log Inspection Rules section, the rules in effect for the policy are
displayed. To add or remove log inspection rules, click Assign/Unassign.
5. Select or deselect the checkboxes for the rules you want to assign or unassign. You can
edit the log inspection rule by right-clicking the rule and selecting Properties to edit the
rule locally or Properties (Global) to apply the changes to all other policies that are using
the rule. For more information, see "Examine a Log Inspection rule" on page 792.
6. Click OK.
Although Deep Security ships with log inspection rules for many common operating systems and
applications, you also have the option to create your own custom rules. To create a custom rule,
you can either use the "Basic Rule" template, or you can write your new rule in XML. For
information on how to create a custom rule, see "Define a Log Inspection rule for use in policies"
on page 770.
768
Trend Micro Deep Security On-Premise 20
Test Log Inspection
Before continuing with further Log Inspection configuration steps, test that the rules are working
correctly:
1. Ensure Log Inspection is enabled.
2. Go to Computer or Policies editor > Log Inspection > Advanced. Change Store events at
the Agent/Appliance for later retrieval by DSM when they equal or exceed the following
severity level to Low (3) and click Save.
3. Go to the General tab, and click Assign/Unassign. Search for and enable:
l 1002792 - Default Rules Configuration – This is required for all other Log Inspection
rules to work.
If you're a Windows user, enable:
l 1002795 - Microsoft Windows Events – This logs events every time the Windows
auditing functionality registers an event.
If you're a Linux user, enable:
l 1002831 - Unix - Syslog - This inspects the syslog for events.
4. Click OK, and then click Save to apply the rules to the policy.
5. Attempt to log in to the server with an account that does not exist.
6. Go to Events & Reports > Log Inspection Events to verify the record of the failed login
attempt. If the detection is recorded, the Log Inspection module is working correctly.
Configure log inspection event forwarding and storage
When a log inspection rule is triggered, an event is logged. To view these events, go to Events &
Reports > Log Inspection Events or Policy editor > Log Inspection > Log Inspection Events.
For more information on working with log inspection events, see "Log inspection events" on
page 1052.
Depending on the severity of the event, you can choose to send them to a syslog server (For
information on enabling this feature, see "Forward Deep Security events to a Syslog or SIEM
server" on page 846.) or to store events in the database by using the severity clipping feature.
There are two "severity clipping" settings available:
l Send Agent events to syslog when they equal or exceed the following severity level: This
setting determines which events triggered by those rules get sent to the syslog server, if
syslog is enabled.
769
Trend Micro Deep Security On-Premise 20
l Store events at the Agent for later retrieval by Deep Security Manager when they equal
or exceed the following severity level: This setting determines which log inspection events
are kept in the database and displayed in the Log Inspection Events page.
To configure severity clipping:
1. Go to Policies.
2. Double-click the policy you want to configure.
3. Click Log Inspection > Advanced.
4. For Send Agent/Appliance events to syslog when they equal or exceed the following
severity level, choose a severity level between Low (0) and Critical (15).
5. For Store events at the Agent/Appliance for later retrieval by DSM when they equal or
exceed the following severity level, choose a severity level between Low (0) and Critical
(15).
6. Click Save.
Define a Log Inspection rule for use in policies
The OSSEC Log Inspection engine is integrated into Deep Security Agents and gives Deep
Security the ability to inspect the logs and events generated by the operating system and
applications running on the computer. Deep Security Manager ships with a standard set of
OSSEC Log Inspection rules that you can assign to computers or policies. You can also create
custom rules if there is no existing rule that fits your requirements.
Log Inspection Rules issued by Trend Micro are not editable (although you can duplicate them
and then edit them.)
Note: Log Inspection Rules that are assigned to one or more computers or that are part of a
policy cannot be deleted.
To create Log Inspection rules, perform these basic steps:
l "Create a new Log Inspection rule" on the next page
l "Decoders" on page 773
l "Subrules" on page 774
l "Real world examples" on page 782
l "Log Inspection rule severity levels and their recommended use" on page 790
770
Trend Micro Deep Security On-Premise 20
l "strftime() conversion specifiers " on page 791
l "Examine a Log Inspection rule" on page 792
For an overview of the Log Inspection module, see "About Log Inspection" on page 766.
Create a new Log Inspection rule
1. In the Deep Security Manager, go to Policies > Common Objects > Rules > Log
Inspection Rules.
2. Click New > New Log Inspection Rule.
3. On the General tab, enter a name and an optional description for the rule.
4. The Content tab is where you define the rule. The easiest way to define a rule is to select
Basic Rule and use the options provided to define the rule. If you need further
customization, you can select Custom (XML) to switch to an XML view of the rule that you
are defining.
Note: Any changes you make in the Custom (XML) view will be lost if you switch back to
the Basic Rule view.
For further assistance in writing your own Log Inspection rules using the XML-based
language, consult the OSSEC documentation or contact your support provider.
These options are available for the Basic Rule template:
l Rule ID: The Rule ID is a unique identifier for the rule. OSSEC defines 100000 - 109999
as the space for user-defined rules. Deep Security Manager will pre-populate the field with
a new unique Rule ID.
l Level: Assign a level to the rule. Zero (0) means the rule never logs an event, although
other rules that watch for this rule may fire.
l Groups: Assign the rule to one or more comma-separated groups. This can be useful
when dependency is used because you can create rules that fire on the firing of a rule, or a
rule that belongs to a specific group.
l Rule Description: Description of the rule.
l Pattern Matching: This is the pattern the rule will look for in the logs. The rule will be
triggered on a match. Pattern matching supports Regular Expressions or simpler String
Patterns. The "String Pattern" pattern type is faster than RegEx but it only supports three
special operations:
771
Trend Micro Deep Security On-Premise 20
l ^ (caret): specifies the beginning of text
l $ (dollar sign): specifies the end of text
l | (pipe): to create a "OR" between multiple patterns
For information on the regular expression syntax used by the Log Inspection module, see
https://www.ossec.net/docs/syntax/regex.html.
l Dependency: Setting a dependency on another rule will cause your rule to only log an
event if the rule specified in this area has also triggered.
l Frequency is the number of times the rule has to match within a specific time frame before
the rule is triggered.
l Time Frame is the period of time in seconds within which the rule has to trigger a certain
number of times (the frequency, above) to log an event.
Note: The Content tab only appears for Log Inspection rules that you create yourself. Log
Inspection rules issued by Trend Micro have a Configuration tab instead that displays the Log
Inspection rule's configuration options (if any).
1. On the Files tab, type the full path to the file(s) you want your rule to monitor and specify
the type of file it is.
2. On the Options tab, in the Alert section, select whether this rule triggers an alert in the
Deep Security Manager.
Alert Minimum Severity sets the minimum severity level that will trigger an Alert for rules
made using the Basic Rule or Custom (XML) template.
Note: The Basic Rule template creates one rule at a time. To write multiple rules in a
single template you can use the Custom (XML) template. If you create multiple rules with
different Levels within a Custom (XML) template, you can use the Alert Minimum
Severity setting to select the minimum severity that will trigger an Alert for all of the rules
in that template.
3. The Assigned To tab lists the policies and computers that are using this Log Inspection
rule. Because you are creating a new rule, it has not been assigned yet.
4. Click OK. The rule is ready to be assigned to policies and computers.
772
Trend Micro Deep Security On-Premise 20
Decoders
A Log Inspection rule consists of a list of files to monitor for changes and a set of conditions to be
met for the rule to trigger. When the Log Inspection engine detects a change in a monitored log
file, the change is parsed by a decoder. Decoders parse the raw log entry into the following
fields:
l log: the message section of the event
l full_log: the entire event
l location: where the log came from
l hostname: hostname of the event source
l program_name: program name from the syslog header of the event
l srcip: the source IP address within the event
l dstip: the destination IP address within the event
l srcport: the source port number within the event
l dstport: the destination port number within the event
l protocol: the protocol within the event
l action: the action taken within the event
l srcuser: the originating user within the event
l dstuser: the destination user within the event
l id: any ID decoded as the ID from the event
l status: the decoded status within the event
l command: the command being called within the event
l url: the URL within the event
l data: any additional data extracted from the event
l systemname: the system name within the event
Rules examine this decoded data looking for information that matches the conditions defined in
the rule.
If the matches are at a sufficiently high severity level, any of the following actions can be taken:
l An alert can be raised. (Configurable on the Options tab of the Log Inspection Rule's
Properties window.)
773
Trend Micro Deep Security On-Premise 20
l The event can be written to syslog. (Configurable in the SIEM area on Administration >
System Settings > Event Forwarding tab.)
l The event can be sent to the Deep Security Manager. (Configurable in the Log Inspection
Syslog Configuration setting on the Policy or Computer Editor > Settings > Event
Forwarding tab.)
Subrules
A single Log Inspection rule can contain multiple subrules. These subrules can be of two types:
atomic or composite. An atomic rule evaluates a single event and a composite rule examines
multiple events and can evaluate frequency, repetition, and correlation between events.
Groups
Each rule, or grouping of rules, must be defined within a <group></group> element. The
attribute name must contain the rules you want to be a part of this group. In the following
example we have indicated that our group contains the syslog and sshd rules:
<group name="syslog,sshd,">
</group>
Note: Notice the trailing comma in the group name. Trailing commas are required if you intend
to use the <if_group></if_group> tag to conditionally append another sub-rule to this one.
Note: When a set of Log Inspection rules are sent to an agent, the Log Inspection engine on
the agent takes the XML data from each assigned rule and assembles it into what becomes
essentially a single long Log Inspection rule. Some group definitions are common to all Log
Inspection rules written by Trend Micro. For this reason Trend Micro has included a rule called
"Default Rules Configuration" which defines these groups and which always gets assigned
along with any other Trend Micro rules. (If you select a rule for assignment and haven't also
selected the "Default Rules Configuration" rule, a notice will appear informing you that the rule
will be assigned automatically.) If you create your own Log Inspection rule and assign it to a
Computer without assigning any Trend Micro-written rules, you must either copy the content of
the "Default Rules Configuration" rule into your new rule, or also select the "Default Rules
Configuration"rule for assignment to the Computer.
774
Trend Micro Deep Security On-Premise 20
Rules, ID, and Level
A group can contain as many rules as you require. The rules are defined using the
<rule></rule> element and must have at least two attributes, the id and the level. The id is a
unique identifier for that signature and the level is the severity of the alert. In the following
example, we have created two rules, each with a different rule ID and level:
<group name="syslog,sshd,">
<rule id="100120" level="5">
</rule>
<rule id="100121" level="6">
</rule>
</group>
Note: Custom rules must have ID values of 100,000 or greater.
You can define additional subgroups within the parent group using the <group></group> tag.
This subgroup can reference any of the groups listed in the following table:
Group Type Group Name Description
connection_attempt Connection attempt
Reconnaissance web_scan Web scan
recon Generic scan
authentication_success Success
authentication_failed Failure
invalid_login Invalid
Authentication Control login_denied Login Denied
authentication_failures Multiple Failures
adduser User account added
account_changed User Account changed or removed
automatic_attack Worm (nontargeted attack)
exploit_attempt Exploit pattern
invalid_access Invalid access
spam Spam
Attack/Misuse
multiple_spam Multiple spam messages
sql_injection SQL injection
attack Generic attack
virus Virus detected
access_denied Access denied
access_allowed Access allowed
unknown_resource Access to nonexistent resource
Access Control firewall_drop Firewall drop
multiple_drops Multiple firewall drops
client_misconfig Client misconfiguration
client_error Client error
775
Trend Micro Deep Security On-Premise 20
Group Type Group Name Description
new_host New computer detected
Network Control
ip_spoof Possible ARP spoofing
service_start Service start
system_error System error
system_shutdown Shutdown
logs_cleared Logs cleared
invalid_request Invalid request
System Monitor
promisc Interface switched to promiscuous mode
policy_changed Policy changed
config_changed Configuration changed
low_diskspace Low disk space
time_changed Time changed
Note: If event auto-tagging is enabled, the event will be labeled with the group name. Log
Inspection rules provided by Trend Micro make use of a translation table that changes the
group to a more user-friendly version. So, for example, "login_denied" would appear as "Login
Denied". Custom rules will be listed by their group name as it appears in the rule.
Description
Include a <description></description> tag. The description text will appear in the event if the
rule is triggered.
<group name="syslog,sshd,">
<rule id="100120" level="5">
<group>authentication_success</group>
<description>SSHD testing authentication success</description>
</rule>
<rule id="100121" level="6">
<description>SSHD rule testing 2</description>
</rule>
</group>
Decoded As
The <decoded_as></decoded_as> tag instructs the Log Inspection engine to only apply the rule
if the specified decoder has decoded the log.
<rule id="100123" level="5">
<decoded_as>sshd</decoded_as>
<description>Logging every decoded sshd message</description>
</rule>
776
Trend Micro Deep Security On-Premise 20
Note: To view the available decoders, go to the Log Inspection Rule page and click
Decoders. Right-click on 1002791-Default Log Decoders and select Properties. Go the
Configuration tab and click View Decoders.
Match
To look for a specific string in a log, use the <match></match>. Here is a Linux sshd failed
password log:
Jan 1 12:34:56 linux_server sshd[1231]: Failed password for invalid
user jsmith from 192.168.1.123 port 1799 ssh2
Use the <match></match> tag to search for the "password failed" string.
<rule id="100124" level="5">
<decoded_as>sshd</decoded_as>
<match>^Failed password</match>
<description>Failed SSHD password attempt</description>
</rule>
Note: Notice the regex caret ("^") indicating the beginning of a string. Although "Failed
password" does not appear at the beginning of the log, the Log Inspection decoder will have
broken up the log into sections. See "Decoders" on page 773 for more information. One of
those sections is "log" which is the message part of the log as opposed to "full_log" which is
the log in its entirety.
The following table lists supported regex syntax:
Regex Syntax Description
\w A-Z, a-z, 0-9 single letters and numerals
\d 0-9 single numerals
\s single space
\t single tab
\p ()*+,-.:;<=>?[]
\W not \w
\D not \d
\S not \s
\. anything
+ match one or more of any of the above (for example, \w+, \d+)
* match zero or more of any of the above (for example, \w*, \d*)
^ indicates the beginning of a string (^somestring)
777
Trend Micro Deep Security On-Premise 20
Regex Syntax Description
$ specify the end of a string (somestring$)
| indicate an "OR" between multiple strings
Conditional Statements
Rule evaluation can be conditional upon other rules having been evaluated as true. The <if_
sid></if_sid> tag instructs the Log Inspection engine to only evaluate this subrule if the rule
identified in the tag has been evaluated as true. The following example shows three rules:
100123, 100124, and 100125. Rules 100124 and 100125 have been modified to be children of
the 100123 rule using the <if_sid></if_sid> tag:
<group name="syslog,sshd,">
<rule id="100123" level="2">
<decoded_as>sshd</decoded_as>
<description>Logging every decoded sshd message</description>
</rule>
<rule id="100124" level="7">
<if_sid>100123</if_sid>
<match>^Failed password</match>
<group>authentication_failure</group>
<description>Failed SSHD password attempt</description>
</rule>
<rule id="100125" level="3">
<if_sid>100123</if_sid>
<match>^Accepted password</match>
<group>authentication_success</group>
<description>Successful SSHD password attempt</description>
</rule>
</group>
Hierarchy of Evaluation
The <if_sid></if_sid> tag essentially creates a hierarchical set of rules. That is, by including an
<if_sid></if_sid> tag in a rule, the rule becomes a child of the rule referenced by the <if_
sid></if_sid> tag. Before applying any rules to a log, the Log Inspection engine assesses the
<if_sid></if_sid> tags and builds a hierarchy of parent and child rules.
Note: The hierarchical parent-child structure can be used to improve the efficiency of your
rules. If a parent rule does not evaluate as true, the Log Inspection engine will ignore the
children of that parent.
778
Trend Micro Deep Security On-Premise 20
Note: Although the <if_sid></if_sid> tag can be used to refer to subrules within an entirely
different Log Inspection rule, you should avoid doing this because it makes the rule very
difficult to review later on.
The list of available atomic rule conditional options is shown in the following table:
Tag Description Notes
match A pattern Any string to match against the event (log).
regex A regular expression Any regular expression to match against the event(log).
decoded_
A string Any prematched string.
as
Any IP address that is decoded as the source IP address.
srcip A source IP address
Use "!" to negate the IP address.
Any IP address that is decoded as the destination IP
dstip A destination IP address
address. Use "!" to negate the IP address.
srcport A source port number Any source port (match format).
dstport A destination port number Any destination port (match format).
user A username Any username that is decoded as a username.
program_ Any program name that is decoded from the syslog
A program name
name process name.
hostname A system hostname Any hostname that is decoded as a syslog hostname.
A time range in the format
The time range that the event must fall within for the rule
time hh:mm - hh:mm or
to trigger.
hh:mm am - hh:mm pm
A weekday (sunday, Day of the week that the event must fall on for the rule to
weekday
monday, tuesday, etc.) trigger.
id An ID Any ID that is decoded from the event.
url A URL Any URL that is decoded from the event.
Use the <if_sid>100125</if_sid> tag to make this rule depend on the 100125 rule. This rule will
be checked only for sshd messages that already matched the successful login rule.
<rule id="100127" level="10">
<if_sid>100125</if_sid>
<time>6 pm - 8:30 am</time>
<description>Login outside business hours.</description>
<group>policy_violation</group>
</rule>
Restrictions on the Size of the Log Entry
The following example takes the previous example and adds the maxsize attribute which tells
the Log Inspection engine to only evaluate rules that are less than the maxsize number of
779
Trend Micro Deep Security On-Premise 20
characters:
<rule id="100127" level="10" maxsize="2000">
<if_sid>100125</if_sid>
<time>6 pm - 8:30 am</time>
<description>Login outside business hours.</description>
<group>policy_violation</group>
</rule>
The following table lists possible atomic rule tree-based options:
Tag Description Notes
Adds this rule as a child rule of the rules that match the specified
if_sid A rule ID
signature ID.
if_group A group ID Adds this rule as a child rule of the rules that match the specified group.
Adds this rule as a child rule of the rules that match the specified
if_level A rule level
severity level.
description A string A description of the rule.
info A string Extra information about the rule.
A CVE Any Common Vulnerabilities and Exposures (CVE) number that you
cve
number would like associated with the rule.
alert_by_
email Additional rule options to indicate if the Alert should generate an e-mail,
options no_email_ alert_by_email, should not generate an email, no_email_alert, or
alert should not log anything at all, no_log.
no_log
Composite Rules
Atomic rules examine single log entries. To correlate multiple entries, you must use composite
rules. Composite rules are supposed to match the current log with those already received.
Composite rules require two additional options: the frequency option specifies how many times
an event or pattern must occur before the rule generates an alert, and the timeframe option tells
the Log Inspection engine how far back, in seconds, it should look for previous logs. All
composite rules have the following structure:
<rule id="100130" level="10" frequency="x" timeframe="y">
</rule>
For example, you could create a composite rule that creates a higher severity alert after five
failed passwords within a period of 10 minutes. Using the <if_matched_sid></if_matched_sid>
tag you can indicate which rule needs to be seen within the desired frequency and timeframe for
your new rule to create an alert. In the following example, the frequency attribute is set to trigger
780
Trend Micro Deep Security On-Premise 20
when five instances of the event are seen and the timeframe attribute is set to specify the time
window as 600 seconds.
The <if_matched_sid></if_matched_sid> tag is used to define which other rule the composite
rule will watch:
<rule id="100130" level="10" frequency="5" timeframe="600">
<if_matched_sid>100124</if_matched_sid>
<description>5 Failed passwords within 10 minutes</description>
</rule>
There are several additional tags that you can use to create more granular composite rules.
These rules, as shown in the following table, allow you to specify that certain parts of the event
must be the same. This allows you to tune your composite rules and reduce false positives:
Tag Description
same_source_ip Specifies that the source IP address must be the same.
same_dest_ip Specifies that the destination IP address must be the same.
same_dst_port Specifies that the destination port must be the same.
same_location Specifies that the location (hostname or agent name) must be the same.
same_user Specifies that the decoded username must be the same.
same_id Specifies that the decoded id must be the same.
If you wanted your composite rule to alert on every authentication failure, instead of a specific
rule ID, you could replace the <if_matched_sid></if_matched_sid> tag with the <if_matched_
group></if_matched_ group> tag. This allows you to specify a category, such as
authentication_ failure, to search for authentication failures across your entire infrastructure.
<rule id="100130" level="10" frequency="5" timeframe="600">
<if_matched_group>authentication_failure</if_matched_group>
<same_source_ip />
<description>5 Failed passwords within 10 minutes</description>
</rule>
In addition to <if_matched_sid></if_matched_sid> and <if_matched_group></if_matched_
group> tags, you can also use the <if_matched_regex></if_matched_regex> tag to specify a
regular expression to search through logs as they are received.
<rule id="100130" level="10" frequency="5" timeframe="600">
<if_matched_regex>^Failed password</if_matched_regex>
<same_source_ip />
781
Trend Micro Deep Security On-Premise 20
<description>5 Failed passwords within 10 minutes</description>
</rule>
Real world examples
Deep Security includes many default Log Inspection rules for dozens of common and popular
applications. Through Security Updates, new rules are added regularly. In spite of the growing
list of applications supported by Log Inspection rules, you may find the need to create a custom
rule for an unsupported or custom application.
In this section we will walk through the creation of a custom CMS (content management system)
hosted on Microsoft Windows Server with IIS and .Net platform, with a Microsoft SQL Server
database as the data repository.
The first step is to identify the following application logging attributes:
1. Where does the application log to?
2. Which Log Inspection decoder can be used to decode the log file?
3. What is the general format of a log file message?
For our custom CMS example the answers are as follows:
1. Windows Event Viewer
2. Windows Event Log (eventlog)
3. Windows Event Log Format with the following core attributes:
l Source: CMS
l Category: None
l Event: <Application Event ID>
The second step is to identify the categories of log events by application feature, and then
organize the categories into a hierarchy of cascading groups for inspection. Not all inspected
groups need to raise events; a match can be used as a conditional statement. For each group,
identify the log format attributes which the rule can use as matching criteria. This can also be
performed by inspecting all application logs for patterns and logical groupings of log events.
For example, the CMS application supports the following functional features which we will
create Log Inspection rules for:
782
Trend Micro Deep Security On-Premise 20
l CMS Application Log (Source: CMS)
l Authentication (Event: 100 to 119)
l User Login successful (Event: 100)
l User Login unsuccessful (Event: 101)
l Administrator Login successful (Event: 105)
l Administrator Login unsuccessful (Event: 106)
l General Errors (Type: Error)
l Database error (Event: 200 to 205)
l Runtime error (Event: 206-249)
l Application Audit (Type: Information)
l Content
l New content added (Event: 450 to 459)
l Existing content modified (Event: 460 to 469)
l Existing content deleted (Event: 470 to 479)
l Administration
l User
l New User created (Event: 445 to 446)
l Existing User deleted (Event: 447 to 449)
This structure will provide you with a good basis for rule creation. Now to create a new Log
Inspection rule in Deep Security Manager.
To create the new CMS Log Inspection Rule:
1. In the Deep Security Manager, go to Policies > Common Objects > Rules > Log
Inspection Rules and click New to display the New Log Inspection Rule Properties
window.
2. Give the new rule a name and a description, and then click the Content tab.
3. The quickest way to create a new custom rule is to start with a basic rule template. Select
the Basic Rule radio button.
4. The Rule ID field will be automatically populated with an unused ID number of 100,000 or
greater, the IDs reserved for custom rules.
5. Set the Level setting to Low (0).
6. Give the rule an appropriate Group name. In this case, "cms".
783
Trend Micro Deep Security On-Premise 20
7. Provide a short rule description.
8. Now select the Custom (XML) option. The options you selected for your "Basic" rule will
be converted to XML.
784
Trend Micro Deep Security On-Premise 20
9. Click the Files tab and click the Add File button to add any application log files and log
types which the rule will be applied to. In this case, "Application", and "eventlog" as the file
type.
Note: Eventlog is a unique file type in Deep Security because the location and filename
of the log files don't have to be specified. Instead, it is sufficient to type the log name as it
is displayed in the Windows Event Viewer. Other log names for the eventlog file type
785
Trend Micro Deep Security On-Premise 20
might be "Security", "System", "Internet Explorer", or any other section listed in the
Windows Event Viewer. Other file types will require the log file's location and filename.
(C/C++ strftime() conversion specifiers are available for matching on filenames. See the
table below for a list of some of the more useful ones.)
10. Click OK to save the basic rule.
11. Working with the basic rule Custom (XML) created, we can begin adding new rules to the
group based on the log groupings identified previously. We will set the base rule criteria to
the initial rule. In the following example, the CMS base rule has identified Windows Event
Logs with a Source attribute of "CMS":
<group name="cms">
<rule id="100000" level="0">
<category>windows</category>
<extra_data>^CMS</extra_data>
<description>Windows events from source 'CMS' group
messages.</description>
</rule>
12. Now we build up subsequent rules from the identified log groups. The following example
identifies the authentication and login success and failure and logs by Event IDs.
<rule id="100001" level="0">
<if_sid>100000</if_sid>
<id>^100|^101|^102|^103|^104|^105|^106|^107|^108|^109|^110</id>
<group>authentication</group>
<description>CMS Authentication event.</description>
</rule>
<rule id="100002" level="0">
<if_group>authentication</if_group>
<id>100</id>
<description>CMS User Login success event.</description>
</rule>
<rule id="100003" level="4">
<if_group>authentication</if_group>
<id>101</id>
<group>authentication_failure</group>
<description>CMS User Login failure event.</description>
</rule>
786
Trend Micro Deep Security On-Premise 20
<rule id="100004" level="0">
<if_group>authentication</if_group>
<id>105</id>
<description>CMS Administrator Login success event.</description>
</rule>
<rule id="100005" level="4">
<if_group>authentication</if_group>
<id>106</id>
<group>authentication_failure</group>
<description>CMS Administrator Login failure event.</description>
</rule>
13. Now we add any composite or correlation rules using the established rules. The follow
example shows a high severity composite rule that is applied to instances where the
repeated login failures have occurred 5 times within a 10 second time period:
<rule id="100006" level="10" frequency="5" timeframe="10">
<if_matched_group>authentication_failure</if_matched_group>
<description>CMS Repeated Authentication Login failure
event.</description>
</rule>
14. Review all rules for appropriate severity levels. For example, error logs should have a
severity of level 5 or higher. Informational rules would have a lower severity.
15. Finally, open the newly created rule, click the Configuration tab and copy your custom rule
XML into the rule field. Click Apply or OK to save the change.
Once the rule is assigned to a policy or computer, the Log Inspection engine should begin
inspecting the designated log file immediately.
The complete Custom CMS Log Inspection Rule:
<group name="cms">
<rule id="100000" level="0">
<category>windows</category>
<extra_data>^CMS</extra_data>
<description>Windows events from source 'CMS' group
messages.</description>
</rule>
<rule id="100001" level="0">
<if_sid>100000</if_sid>
<id>^100|^101|^102|^103|^104|^105|^106|^107|^108|^109|^110</id>
<group>authentication</group>
787
Trend Micro Deep Security On-Premise 20
<description>CMS Authentication event.</description>
</rule>
<rule id="100002" level="0">
<if_group>authentication</if_group>
<id>100</id>
<description>CMS User Login success event.</description>
</rule>
<rule id="100003" level="4">
<if_group>authentication</if_group>
<id>101</id>
<group>authentication_failure</group>
<description>CMS User Login failure event.</description>
</rule>
<rule id="100004" level="0">
<if_group>authentication</if_group>
<id>105</id>
<description>CMS Administrator Login success event.</description>
</rule>
<rule id="100005" level="4">
<if_group>authentication</if_group>
<id>106</id>
<group>authentication_failure</group>
<description>CMS Administrator Login failure event.</description>
</rule>
<rule id="100006" level="10" frequency="5" timeframe="10">
<if_matched_group>authentication_failure</if_matched_group>
<description>CMS Repeated Authentication Login failure
event.</description>
</rule>
<rule id="100007" level="5">
<if_sid>100000</if_sid>
<status>^ERROR</status>
<description>CMS General error event.</description>
<group>cms_error</group>
788
Trend Micro Deep Security On-Premise 20
</rule>
<rule id="100008" level="10">
<if_group>cms_error</if_group>
<id>^200|^201|^202|^203|^204|^205</id>
<description>CMS Database error event.</description>
</rule>
<rule id="100009" level="10">
<if_group>cms_error</if_group>
<id>^206|^207|^208|^209|^230|^231|^232|^233|^234|^235|^236|^237|^238
^239^|240|^241|^242|^243|^244|^245|^246|^247|^248|^249</id>
<description>CMS Runtime error event.</description>
</rule>
<rule id="100010" level="0">
<if_sid>100000</if_sid>
<status>^INFORMATION</status>
<description>CMS General informational event.</description>
<group>cms_information</group>
</rule>
<rule id="100011" level="5">
<if_group>cms_information</if_group>
<id>^450|^451|^452|^453|^454|^455|^456|^457|^458|^459</id>
<description>CMS New Content added event.</description>
</rule>
<rule id="100012" level="5">
<if_group>cms_information</if_group>
<id>^460|^461|^462|^463|^464|^465|^466|^467|^468|^469</id>
<description>CMS Existing Content modified event.</description>
</rule>
<rule id="100013" level="5">
<if_group>cms_information</if_group>
<id>^470|^471|^472|^473|^474|^475|^476|^477|^478|^479</id>
<description>CMS Existing Content deleted event.</description>
</rule>
789
Trend Micro Deep Security On-Premise 20
<rule id="100014" level="5">
<if_group>cms_information</if_group>
<id>^445|^446</id>
<description>CMS User created event.</description>
</rule>
<rule id="100015" level="5">
<if_group>cms_information</if_group>
<id>^447|449</id>
<description>CMS User deleted event.</description>
</rule>
</group>
Log Inspection rule severity levels and their recommended use
Level Description Notes
Level Ignored, no Primarily used to avoid false positives. These rules are scanned before all
0 action taken the others and include events with no security relevance.
no
Level
predefined
1
use
System low
Level
priority System notification or status messages that have no security relevance.
2
notification
Successful
Level or
Successful login attempts, firewall allow events, etc.
3 authorized
events
System low Errors related to bad configurations or unused devices or applications.
Level
priority They have no security relevance and are usually caused by default
4
errors installations or software testing.
User-
Level Missed passwords, denied actions, etc. These messages typically have no
generated
5 security relevance.
errors
Low Indicate a worm or a virus that provide no threat to the system such as a
Level
relevance Windows worm attacking a Linux server. They also include frequently
6
attacks triggered IDS events and common error events.
no
Level
predefined
7
use
no
Level
predefined
8
use
Level Error from Include attempts to login as an unknown user or from an invalid source. The
9 invalid message might have security relevance especially if repeated. They also
790
Trend Micro Deep Security On-Premise 20
Level Description Notes
source include errors regarding the admin or root account.
Multiple
Level user Include multiple bad passwords, multiple failed logins, etc. They might
10 generated indicate an attack, or it might be just that a user forgot his or her credentials.
errors
no
Level
predefined
11
use
High-
Level Include error or warning messages from the system, kernel, etc. They might
importance
12 indicate an attack against a specific application.
event
Unusual
Level Common attack patterns such as a buffer overflow attempt, a larger than
error (high
13 normal syslog message, or a larger than normal URL string.
importance)
High
Level importance Typically the result of the correlation of multiple attack rules and indicative
14 security of an attack.
event
Level Attack
Very small chance of false positive. Immediate attention is necessary.
15 Successful
strftime() conversion specifiers
Specifier Description
%a Abbreviated weekday name (e.g., Thu)
%A Full weekday name (e.g., Thursday)
%b Abbreviated month name (e.g., Aug)
%B Full month name (e.g., August)
%c Date and time representation (e.g., Thu Sep 22 12:23:45 2007)
%d Day of the month (01 - 31) (e.g., 20)
%H Hour in 24 h format (00 - 23) (e.g., 13)
%I Hour in 12 h format (01 - 12) (e.g., 02)
%j Day of the year (001 - 366) (e.g., 235)
%m Month as a decimal number (01 - 12) (e.g., 02)
%M Minute (00 - 59) (e.g., 12)
%p AM or PM designation (e.g., AM)
%S Second (00 - 61) (e.g., 55)
%U Week number with the first Sunday as the first day of week one (00 - 53) (e.g., 52)
%w Weekday as a decimal number with Sunday as 0 (0 - 6) (e.g., 2)
%W Week number with the first Monday as the first day of week one (00 - 53) (e.g., 21)
%x Date representation (e.g., 02/24/79)
%X Time representation (e.g., 04:12:51)
%y Year, last two digits (00 - 99) (e.g., 76)
%Y Year (e.g., 2008)
%Z Time zone name or abbreviation (e.g., EST)
791
Trend Micro Deep Security On-Premise 20
Specifier Description
%% A % sign (e.g., %)
More information can be found at the following websites:
https://www.php.net/manual/en/function.strftime.php
www.cplusplus.com/reference/clibrary/ctime/
Examine a Log Inspection rule
Log Inspection rules are found in the Deep Security Manager at Policies > Common Objects >
Rules > Log Inspection Rules.
Log Inspection rule structure and the event matching process
This screen shot displays the contents of the Configuration tab of the Properties window of the
"Microsoft Exchange" Log Inspection rule:
792
Trend Micro Deep Security On-Premise 20
Here is the structure of the rule:
793
Trend Micro Deep Security On-Premise 20
l 3800 - Grouping of Exchange Rules - Ignore
l 3801 - Email rcpt is not valid (invalid account) - Medium (4)
l 3851 - Multiple email attempts to an invalid account - High (9)
l Frequency - 10
l Time Frame - 120
l Ignore - 120
l 3802 - Email 500 error code - Medium (4)
l 3852 - Email 500 error code (spam) - High (9)
l Frequency - 12
l Time Frame - 120
l Ignore - 240
The Log Inspection engine will apply log events to this structure and see if a match occurs. For
example, if an Exchange event occurs, and this event is an email receipt to an invalid account,
the event will match line 3800 (because it is an Exchange event). The event will then be applied
to line 3800's sub-rules: 3801 and 3802.
If there is no further match, this "cascade" of matches will stop at 3800. Because 3800 has a
severity level of "Ignore", no Log Inspection event would be recorded.
However, an email receipt to an invalid account does match one of 3800's sub-rules: sub-rule
3801. Sub-rule 3801 has a severity level of "Medium(4)". If the matching stopped here, a Log
Inspection event with a severity level of "Medium(4)" would be recorded.
But there is still another sub-rule to be applied to the event: sub-rule 3851. Sub-rule 3851 with its
three attributes will match if the same event has occurred 10 times within the last 120 seconds. If
so, a Log Inspection event with a severity "High(9)" is recorded. (The "Ignore" attribute tells sub-
rule 3851 to ignore individual events that match sub-rule 3801 for the next 120 seconds. This is
useful for reducing "noise".)
Assuming the parameters of sub-rule 3851 have been matched, a Log Inspection event with
Severity "High(9)" is now recorded.
Looking at the Options tab of the Microsoft Exchange Rule, we see that Deep Security Manager
will raise an alert if any sub-rules with a severity level of "Medium(4)" have been matched. Since
this is the case in our example, the alert will be raised (if "Alert when this rule logs an event" is
selected).
794
Trend Micro Deep Security On-Premise 20
Duplicate Sub-rules
Some Log Inspection rules have duplicate sub-rules. To see an example, open the "Microsoft
Windows Events" rule and click on the Configuration tab. Note that sub-rule 18125 (Remote
access login failure) appears under sub-rules 18102 and 18103. Also note that in both cases
sub-rule 18125 does not have a severity value, it only says "See Below".
Instead of being listed twice, Rule 18125 is listed once at the bottom of the Configuration page:
795
Trend Micro Deep Security On-Premise 20
Configure Application Control
About Application Control
Note: You can enable application control for computers running Deep Security Agent 10.0 or
higher. For a list of operating systems where application control is supported, see "Supported
features by platform" on page 145.
Application control continuously monitors for software changes on your protected servers. Based
on your policy configuration, application control either prevents unauthorized software from
running until it is explicitly allowed, or allows unauthorized software until it is explicitly blocked.
Which option you choose depends on the level of control you want over your environment.
Warning: Application control continuously monitors your server and logs an event whenever a
software change occurs. It is not intended for environments with self-changing software or that
normally creates executables, such as some web or mail servers. To ensure Application
Control is appropriate for your environment, check "What does application control detect as a
software change?" on page 801.
Tip: You can automate Application Control creation and configuration using the Deep Security
API. For more information, see the Configure Application Control guide in the Deep Security
Automation Center.
Key concepts
Targeted protection state: One of the main decisions you need to make when setting up
application control is deciding your targeted protection state. Do you want to prevent all new or
changed software from running, unless you manually specify that it is allowed? Or do you want it
to run by default unless you specifically block it? One approach is to initially allow unrecognized
software to run when you first enable application control and there's a lot of unrecognized
software. As you add application control rules and the volume of unrecognized software
decreases, you could switch to block mode.
Application control rule: Rules specify whether software is allowed or blocked on a particular
computer.
Inventory: Initial list of software that is installed on the computer and allowed to run. Make sure
only software that you want to allow is installed on the computer. When you enable application
796
Trend Micro Deep Security On-Premise 20
control, all currently installed software is added to the computer's inventory and allowed to run.
When a computer is in maintenance mode, any software changes made to the computer are
added to the computer's inventory and allowed to run. A computer's software inventory is stored
on the Deep Security Agent and is not displayed in Deep Security Manager.
Unrecognized software: Software that isn't in a computer's inventory and isn't already covered
by an application control rule. See "What does application control detect as a software change?"
on page 801
Maintenance mode: If you are planning to install or update software, we strongly advise that you
turn on maintenance mode. In maintenance mode, application control continues to block
software that is specifically blocked by an Application Control rule, but allows new or updated
software to run and adds it to the computer's inventory. See "Turn on maintenance mode when
making planned changes" on page 807.
How does application control work?
1. You enable application control in a policy and assign the policy to a computer that is
protected by a Deep Security Agent (see "Turn on Application Control" on page 803).
2. When the agent receives the policy, it creates an inventory of all software installed on the
computer. All software listed in the inventory is assumed to be safe and is allowed to run
on that computer. This inventory list is not visible from Deep Security Manager, which
means you need to be absolutely certain that only good software is installed on a computer
where you intend to enable application control.
797
Trend Micro Deep Security On-Premise 20
3. After the inventory is finished, application control is aware of any software changes on the
computer. A software change could be new software that appears on the computer or
changes to existing software.
4. If the computer is in maintenance mode, the Deep Security Agent adds the software to its
inventory list and it is allowed to run. This change is not visible in Deep Security Manager.
See "Turn on maintenance mode when making planned changes" on page 807.
5. If the change was made by a trusted installer, the Deep Security Agent adds the software
to its inventory list and allows it to run. For example, when Microsoft Windows self-initiates
a component update, hundreds of new executable files may be installed. Application
control auto-authorizes many file changes that are created by well-known Windows
processes and does not list these changes in Deep Security Manager. Removing the
"noise" associated with expected software changes provides you with clearer visibility into
changes that may need your attention.
Note: The trusted installer feature is available with Deep Security Agent 10.2 or later.
6. If the computer's ruleset contains a rule for this exact piece of software, the software is
allowed or blocked according to the rule that's in place. See "What does application control
detect as a software change?" on page 801
7. If software is not in the computer's inventory and is not covered by an existing rule, it's
considered unrecognized software. The policy assigned to the computer specifies how
unrecognized software is handled. Depending on the policy configuration, it's either
allowed to run or is blocked. If the software is blocked and it is able to produce error
messages in the OS, an error message on the protected computer indicates that the
software does not have permissions to run or that access is denied.
The unrecognized software appears on the Application Control - Software Changes page
in Deep Security Manager. On that page, an administrator can click Allow or Block to
create an allow or block rule for that piece of software on a particular computer. An allow or
block rule takes precedence over the default action specified in the policy. See "Monitor
new and changed software" on page 804.
A tour of the application control interface
There are a few places in Deep Security Manager where you can see changes related to
application control:
l "Application Control: Software Changes (Actions)" on the next page
l "Application Control Rulesets" on page 800
l "Security Events" on page 801
798
Trend Micro Deep Security On-Premise 20
Application Control: Software Changes (Actions)
The Application Control: Software Changes page is displayed when you click Actions in Deep
Security Manager. It displays all unrecognized software (software that isn't in a computer's
inventory and doesn't have a corresponding application control rule). Software changes are
allowed or blocked at the computer level, so if a particular piece of software is installed on fifty
computers, it will appear on that page fifty times. However, if you know that a certain piece of
software should be allowed or blocked everywhere, you can filter the Actions page to sort the
changes by file hash and then click Allow All to allow it on all computers where the software is
installed.
The policy applied to a computer specifies whether it will allow all unrecognized software to run
by default, or block all unrecognized software, but no explicit application control rule is created
until you click "Allow" or "Block" on the Actions page. When you click Allow or Block, a
corresponding rule appears in the ruleset for the computer. The rulesets are displayed on the
Application Control Rulesets page.
799
Trend Micro Deep Security On-Premise 20
Application Control Rulesets
To see the ruleset for a computer, go to Policies > Common Objects > Rules > Application
Control Rulesets. To see which rules are part of a ruleset, double-click the ruleset and go to the
Rules tab. The Rules tab displays the pieces of software that have rules associated with them
and enables you to change allow rules to block, and vice versa.
800
Trend Micro Deep Security On-Premise 20
Security Events
Events & Reports > Events > Application Control Events > Security Events displays all
unrecognized software that either has been run on a computer or has been prevented from
running by a block rule. You can filter this list by time period and other criteria.
For each event (except aggregated events), you can click View rules to change the rule from
Allow to Block or vice versa. Deep Security Agent 10.2 or later includes event aggregation logic
to reduce the volume of logs when the same event occurs repeatedly.
What does application control detect as a software change?
Unlike integrity monitoring, which monitors any file, application control looks only for software
files when examining the initial installation and monitoring for change.
Software can be:
l Windows applications (.exe, .com, .dll, .sys), Linux libraries (.so) and other compiled
binaries and libraries
l Java .jar and .class files, and other compiled byte code
l PHP, Python, and shell scripts, and other web apps and scripts that are interpreted or
compiled on the fly
l Windows PowerShell scripts, batch files (.bat), and other Windows-specific scripts (.wsf,
.vbs, .js)
801
Trend Micro Deep Security On-Premise 20
For example, WordPress and its plug-ins, Apache, IIS, nginx, Adobe Acrobat, app.war, and
/usr/bin/ssh would all be detected as software.
Application control checks a file's extension to determine whether it's a script. Additionally, on
Linux, application control treats any file with execute permissions as if it's a script.
Note: On Windows computers, application control tracks changes on the local file system, but
not on network locations, CD or DVD drives, or USB devices.
Application control is integrated with the kernel (on Linux computers) and file system, so it has
permissions to monitor the whole computer, including software installed by root or administrator
accounts. The agent watches for disk write activity on software files, and for attempts to execute
software.
Differences in how Deep Security Agent 10 and 11 compare files
To determine whether software is new or has changed, Deep Security 10 agents compare the
file with the initially installed software's SHA-256 hash, file size, path, and file name (they have a
"file-based" ruleset). Deep Security 11 (and newer) agents compare only the file's SHA-256
hash and file size (they have a "hash-based" ruleset). Because the rules created by Deep
Security 11 (and newer) agents compare only the unique hash and file size, a rule will continue
to be applied even if the software file is renamed or moved. As a result, using Deep Security 11
(and newer) agents reduces the number of software changes that you need to deal with.
A Deep Security 10 agent continues to use a file-based ruleset until it is upgraded to Deep
Security 11.0 or newer. When you upgrade an agent to version 11.0 or newer, its ruleset is
converted to use hash-based rules. If there are multiple file-based rules for the same hash value,
they are consolidated into one hash-based rule. If the rules being consolidated conflict with each
other (one rule blocks the file and another allows it), the new hash-based rule will be an "allow"
rule.
Set up Application Control
Warning: Application Control continuously monitors your server and logs an event whenever
a software change occurs. It is not intended for environments with self-changing software or
that normally creates executables, such as some web or mail servers. To ensure Application
Control is appropriate for your environment, check "What does application control detect as a
software change?" on the previous page.
802
Trend Micro Deep Security On-Premise 20
For information about how Application Control works, see "About Application Control" on
page 796.
To enable Application Control and monitor software changes:
1. "Turn on Application Control" below
2. "Monitor new and changed software" on the next page
3. "Turn on maintenance mode when making planned changes" on page 807
This article also provides "Application Control tips and considerations" on page 808 that you
should be aware of when working with Application Control.
Once you've enabled Application Control, you can also learn how to:
l "View and change Application Control rulesets" on page 813
l "Reset Application Control after too much software change" on page 817
l "Monitor Application Control events" on page 810
l "Use the API to create shared and global rulesets" on page 818
Turn on Application Control
You can enable Application Control in the settings for a computer or in policies:
1. Open the Computer or Policy editor and go to Application Control > General.
2. Set the Application Control State to "On" or "Inherited (On)".
3. Under Enforcement, select your targeted protection state:
l Block unrecognized software until it is explicitly allowed
l Allow unrecognized software until it is explicitly blocked (we recommend that you
choose this option when initially setting up Application Control)
4. Click Save.
803
Trend Micro Deep Security On-Premise 20
The next time that the Deep Security Manager and agent connect, the agent scans and then
generates an inventory of all software installed on the computer and creates rules that allow all
the software that it finds. This initial inventory can take 15 minutes or longer, depending on your
environment.
To check that Application Control is working as expected, follow the instructions in "Verify that
Application Control is enabled" on page 808.
Monitor new and changed software
Once an inventory has been created on a protected computer, any software executable files that
are added or changed are classified as a "software change" and appear on the Actions page in
Deep Security Manager. When unrecognized software runs, or attempts to run and is blocked,
the event is listed under Events & Reports > Events > Application Control Events > Security
Events. For more information, see "Application Control events" on page 1032
After you initially enable Application Control, you will likely see a lot of software changes on the
Actions page. This can happen when allowed software creates new executables, renames files,
or relocates files through the normal course of operation. As you add rules to tune Application
Control, you should see fewer software changes.
To quickly find all software changes on all computers and easily create allow or block rules for
them, use the Actions tab.
804
Trend Micro Deep Security On-Premise 20
Tip: You can automate the creation of allow or block rules using the Deep Security API. For
more information, see the Allow or block unrecognized software guide in the Deep Security
Automation Center.
1. In Deep Security Manager, go to Actions.
2. There are several ways you can filter to see only specific occurrences of unrecognized
software.
Tip: Instead of evaluating each software change on each computer individually, use the
filters described below to find software changes that you know are good, and allow them
in bulk.
To reduce the number of software changes being displayed:
l From the drop-down list next to Application Control: Software Changes, select a time
range such as Last 7 Days. You can also click a bar in the graph near the top of the
page to display the changes for that time period.
l In the pane on the left, click Computers and select an individual computer or group, or
click Smart Folders to display only the computers that are included in a particular
805
Trend Micro Deep Security On-Premise 20
smart folder (see "Group computers dynamically with smart folders" on page 1219).
Note: Unlike the Computers tab, the Software Changes pane usually does not
show all computers. It only displays computers where Application Control has
detected software changes that don't already have allow or block rules.
l Enter search terms and operators in the search filter field. You search for these
attributes: Change By Process, Change By User, File Name, Host Name, Install Path,
MD5, SHA1, and SHA256. For example, you could find all changes made by a
particular user that you trust and click Allow All to allow all of their changes. Or if a
particular software update was installed across your organization (while maintenance
mode was not enabled), filter the page according to the hash value of the file and click
Allow All to allow all occurrences.
Tip: Details about a software change are displayed in the right pane. You can click
the file name or computer name in the details to add it to your search filter.
l Select whether to Group by File (Hash) or Group by Computer.
3. Click either Allow or Block to add an allow or block rule on that computer, for that software.
If you need more information to decide whether to allow or block, click the software name,
then use the details panel on the right side.
The next time that the agent connects with the Deep Security Manager, it receives the new
rules.
Tips for handling changes
l For most environments, we suggest that you select the Allow unrecognized software until
it is explicitly blocked option to allow software changes by default when you first enable
Application Control and add allow and block rules for changes that you see on the Actions
page. Eventually, the rate of software changes should decrease. At that point, you could
consider blocking software changes by default and creating allow rules for the software
that you know is good. Some organizations prefer to continue to allow changes by default
and monitor the Actions page for software that should be blocked.
l You may prefer to start by evaluating security events, rather than dealing with
unrecognized software first. Security events show you which unrecognized software has
run (or attempted to run). For information on security events, see "Monitor Application
Control events" on page 810.
806
Trend Micro Deep Security On-Premise 20
l When an unrecognized file is allowed to execute and you want to continue to allow it,
create an Allow rule. In addition to allowing the file's execution, the event is no longer
logged for that file, which reduces noise and makes important events easier to find.
l When a known file's execution is blocked, consider cleaning that file from the computer,
especially for repeated occurrences.
l Keep in mind that software changes are listed for each computer where they occur. You
must allow or block the software for each computer.
l Rules are assigned to computers, not to policies. For example, if helloworld.py is
detected on three computers, when you click Allow All or Block All, this would affect only
three computers. It won't affect future detections on other computers, because they have
their own rulesets.
l If you see changes related to software updates that you can control, use the maintenance
mode feature when performing those updates. See "Turn on maintenance mode when
making planned changes" below.
Turn on maintenance mode when making planned changes
When you install patches, upgrade software, or deploy web applications, Application Control will
detect them. Depending on your setting for how to handle unrecognized software, this could
block that software until you use the Actions tab to create allow rules.
To avoid extra down time and alerts during deployment and maintenance windows, you can put
Application Control into a mode designed for maintenance windows. While maintenance mode
is enabled, Application Control will continue to enforce rules that block software, but it will allow
new or updated software to run and automatically add it to the computer's inventory.
Tip: You can automate maintenance mode using the Deep Security API. For more information,
see the Configure maintenance mode during upgrades guide in the Deep Security Automation
Center.
1. In Deep Security Manager, go to Computers.
2. Select one or more computers, then click Actions > Turn On Maintenance Mode.
3. Select the duration of your maintenance window.
Maintenance mode will automatically disable itself when your maintenance window is
scheduled to end. Alternatively, if you'd prefer to manually disable maintenance mode
when updates are finished, select Indefinite.
807
Trend Micro Deep Security On-Premise 20
On the Dashboard, the Application Control Maintenance Mode Status widget indicates
whether the command succeeded.
4. Install or upgrade software.
5. If you chose to disable maintenance mode manually, remember to disable maintenance
mode in order to start to detect software changes again.
Application Control tips and considerations
l For better performance with Application Control, use Deep Security anti-malware instead
of Windows Defender. See "Disable Windows Defender after installing Deep Security anti-
malware on Windows Server 2016" on page 575.
l If you create a block rule for a batch file or PowerShell script, you will not be able to copy,
move, or rename the file when using its associated interpreter (powershell.exe for
PowerShell scripts or cmd.exe for batch files).
l If you add an allow or block rule, it is normally sent to the agent the next time the agent
connects to Deep Security Manager. If you see an error saying that the ruleset upload was
not successful, verify that network devices between the agent and the manager or relay
allow communications on the heartbeat port number or relay port numbers.
l To verify that a block rule is working, try to run the software that you just blocked. (For
details on how Deep Security Agent detects changes, see "What does application control
detect as a software change?" on page 801)
l When blocked software remains installed, Application Control continues to record logs and
show alerts when it blocks the software from running. To reduce the permission error logs
on the computer and also reduce your attack surface, uninstall the software that
Application Control is blocking. Once that is done, if you want to dismiss related alerts,
either go to Alerts or go to Dashboard, click the alert, and then click Dismiss Alert. Not all
alerts can be dismissed. For more information, see "Predefined alerts" on page 963.
l For performance reasons, if the computer has too much software change, Application
Control will continue to enforce existing rules, but stop detecting and displaying software
changes. To resolve this, see "Reset Application Control after too much software change"
on page 817.
Verify that Application Control is enabled
For an overview of Application Control, see "About Application Control" on page 796. For initial
configuration instructions, see "Set up Application Control" on page 802.
When Application Control is enabled and has finished its initial software inventory scan:
808
Trend Micro Deep Security On-Premise 20
l The State field indicates "On" or "On, Blocking unrecognized software".
l On Computers, the Status field changes from "Application Control Ruleset Build In
Progress" to "Managed (Online)".
l Events & Reports > Events > System Events will record "Application Control Ruleset
Build Started" and "Application Control Ruleset Build Completed". (If you don’t see any
logs, see "Choose which Application Control events to log" on the next page.)
To verify that Application Control is working:
1. Copy an executable to the computer or add execute permissions to a plain text file. Try to
run the executable.
Depending on your enforcement setting for unrecognized software, it should be either
blocked or allowed. Once Application Control has built initial allow rules or downloaded a
shared ruleset, if any change is detected, it should appear in the Actions tab, which you
809
Trend Micro Deep Security On-Premise 20
can use to create allow and block rules (see "Monitor new and changed software" on
page 804). Depending on your alert configuration, you will also see an alert if
unrecognized software is detected, or if Application Control blocks software from launching
(see "Monitor Application Control events" below). The event should persist until the
software change no longer exists, or until the oldest data has been removed from the
database.
2. Add an allow or block rule for your test software and then try again. This time, Application
Control should apply your allow or block rule.
Tip: If software is accidentally blocked because you've selected Block unrecognized
software until it is explicitly allowed and the software isn't being recognized, the Reason
column in Application Control event logs can help you to troubleshoot the cause.
Monitor Application Control events
For an overview of Application Control, see "About Application Control" on page 796. For initial
configuration instructions, see "Set up Application Control" on page 802.
By default, when you enable Application Control it logs events, such as when there are software
changes or when it blocks software from executing. Application Control events appear on the
Actions and Events & Reports pages. If configured, an alert appears on the Alerts page.
You can configure some of which Application Control event logs are recorded, and which are
forwarded to external SIEM systems, or syslog servers.
To monitor for software changes on computers:
1. "Choose which Application Control events to log" below
2. "View Application Control event logs" on the next page
3. "Interpret aggregated security events" on the next page
4. "Monitor Application Control alerts" on page 812
Choose which Application Control events to log
1. Go to Administration > System Settings > System Events.
2. Scroll down to the Application Control events such as Event ID 7000 "Application Control
Events Exported".
3. If you want to record event logs for that type of event, select Record.
810
Trend Micro Deep Security On-Premise 20
When those events occur, they appear on Events & Reports > Events > System Events.
Logs are kept until they meet maximum log age criteria. For details, see "About Deep
Security event logging" on page 825.
Note: Events that appear on Computers > Details > Application Control > Events are
not configured here. They are always logged.
4. If you want to forward event logs to a SIEM, or syslog server, select Forward.
5. If you use an external SIEM, you may need to load the list of possible Application Control
event logs, and indicate what action to take. For a list of Application Control events, see "
System events" on page 984 and "Application Control events" on page 1032.
View Application Control event logs
Application Control generates system events and security events:
l System event: An audit event that provides a history of configuration changes or software
updates. To see system events click Events & Reports > Events > System Events. For a
list, see " System events" on page 984.
l Security event: An event that occurs on the agent when Application Control blocks or
allows unrecognized software, or blocks software due to a block rule. To see security
events, click Events & Reports > Events > Application Control Events > Security Events.
For a list, see "Application Control events" on page 1032.
Interpret aggregated security events
When an agent heartbeat includes several instances of the same security event, Deep Security
aggregates the events in the Security Events log. Event aggregation reduces the number of
items in the log, making it easier to find important events:
l When the event occurs for the same file, which is usually the case, the log includes the file
name with the aggregated event. For example, a heartbeat includes 3 instances of the
"Execution of Unrecognized Software Allowed" event for the Test_6_file.sh file, and no
other instances of that event. Deep Security aggregates these 3 events for the file Test_6_
file.sh.
l When the event occurs for many files, the log omits the rules link, path, file name, and user
name. For example, a heartbeat includes 21 instances of the "Execution of Unrecognized
Software Allowed" event that occurred for several different files. Deep Security aggregates
811
Trend Micro Deep Security On-Premise 20
the 21 events in a single event, but does not include a rules link, path, file name, or user
name.
When aggregated events apply to multiple files, other occurrences of these events have likely
been reported in other heartbeats. After you respond to other events where the file name is
known, it is likely that no more aggregated events occur.
In the log, aggregated events use special icons, and the Repeat Count column indicates the
number of events that are aggregated.
Monitor Application Control alerts
To configure which Application Control events or severity levels cause an alert, go to the Alerts
tab, click the Configure Alerts button, and then select an event and double-click Properties. For
details, see "Configure alerts" on page 953.
When alerts are enabled for Application Control events, any software change that the
Application Control engine detects and any software that it blocks from executing appear in the
Alerts tab. If you have enabled the Alert Status widget, Application Control alerts also appear on
the Dashboard.
812
Trend Micro Deep Security On-Premise 20
To monitor which computers are in maintenance mode, you can also click Add/Remove Widgets
and enable the Application Control Maintenance Mode widget, which displays a list of the
computers and their scheduled maintenance windows.
View and change Application Control rulesets
Each computer has its own Application Control ruleset. You can:
l "View Application Control rulesets" on the next page and find out which rules they include.
Tip: When you first enable Application Control for a computer, the software installed on
the computer is added to the computer's inventory and allowed to run. However, you
cannot see the rules associated with the inventory from Deep Security Manager unless
you use the Deep Security legacy REST API to do so (see "Use the API to create shared
and global rulesets" on page 818). In Deep Security Manager, a computer's ruleset
appears empty until you create some allow/block rules for the computer.
l "Change the action for an Application Control rule" on page 815 if a software file should no
longer be allowed/blocked.
l "Delete an individual Application Control rule" on page 816 if the software has been
removed and isn't likely to return.
813
Trend Micro Deep Security On-Premise 20
l "Delete an Application Control ruleset" on page 817 if the computer associated with the
ruleset has been removed.
Tip: If a user reports that Application Control is blocking software that they need to run on a
particular computer, you can undo the block rule on that computer. Go to Events & Reports >
Application Control Events > Security Events, find the computer, locate the block event, and
then click View Rules. In the pop-up that appears, you can change the block rule to an allow
rule.
View Application Control rulesets
To view the list of Application Control rulesets, go to Policies > Common Objects > Rules
> Application Control Rulesets.
To see which rules are part of a ruleset, double-click the ruleset and go to the Rules tab. The
Rules tab displays the software files that have rules associated with them and enables you to
change allow rules to block, and vice versa. (See "Change the action for an Application Control
rule" on the next page.)
814
Trend Micro Deep Security On-Premise 20
Security Events
Events & Reports > Events > Application Control Events > Security Events displays all
unrecognized software that either was run on a computer or was actively blocked from running.
You can filter this list by time period and other criteria. For more information, see "Application
Control events" on page 1032.
For each event (except aggregated events), you can click View rules to change the rule from
Allow to Block or vice versa.
Deep Security Agent 10.2 or later includes event aggregation logic to reduce the volume of logs
when the same event occurs repeatedly. (See "Interpret aggregated security events" on
page 811.)
Change the action for an Application Control rule
If you want to allow a software that you previously blocked (or the opposite), you can edit the
action in the rule. If you need to undo the rule so that the software is not recognized by
Application Control (in other words, delete the rule, not only change its action), see "Delete an
individual Application Control rule" on the next page instead.
1. Go to Policies > Common Objects > Rules > Application Control Rulesets.
2. Double-click to select the ruleset that contains the rule that you want to change.
3. On the pop-up window that appears, go to the Rules tab.
815
Trend Micro Deep Security On-Premise 20
4. If you want to focus on software that was blocked (or allowed), then in the menu next to
Application Control Rules, select By Action to group similar rules. Alternatively, you can
use the search to filter the list.
If you want to change the action for a software file, but it has multiple different file names ,
select By File Name to group related rules.
5. Find the row for the specific software that you want to allow or block.
6. In the Action column, change the setting to allow or block, then click OK.
The next time that the agent connects with Deep Security Manager, the rule will be
updated, and the version number will increase.
Delete an individual Application Control rule
If you want to undo a rule that you created, go to Policies > Common Objects > Rules
> Application Control Rulesets, double-click the ruleset that contains the rule, go to the Rules
tab, select the rule and then click Delete.
Some things to keep in mind:
l When the rules are not needed anymore, you can delete them to reduce the size of the
ruleset. This improves performance by reducing RAM and CPU usage.
l If you delete a rule, Application Control will not recognize the software anymore. If the
software is installed again, it will appear again on the Actions tab.
l If a software update is unstable and you might need to downgrade, keep rules that allow
rollback to the previous software version until you have completed testing.
816
Trend Micro Deep Security On-Premise 20
l To find the oldest rules, go to Policies > Rules > Application Control Rulesets, then click
Columns. Select Date/Time (Last Change), click OK, and then click that column's header
to sort by date.
Delete an Application Control ruleset
If an Application Control ruleset is not being used anymore (for example, if the computer
associated with the ruleset no longer exists), you can delete it.
To delete a ruleset, go to Policies > Rules > Application Control Rulesets, click a ruleset to
select it, and click Delete.
Reset Application Control after too much software change
For an overview of Application Control, see "About Application Control" on page 796.
Application Control is intended for use on stable servers that are not updated frequently, and not
for workstations or servers that undergo a lot of software changes.
Too many changes make large rulesets that consume more RAM, unless you remove old rules.
If you don't use maintenance mode during authorized software updates, too many changes can
also result in high administrator workload because they must manually create allow rules for
each change.
If unrecognized software changes exceed the maximum, Application Control will stop
detecting and displaying all of the computer's software changes. This stoppage is designed to
prevent out-of-memory and disk space errors that can occur if the ruleset grows too large.
When a stoppage occurs, Deep Security Manager will notify you through an alert ("Unresolved
software change limit") and an event log ("Unresolved software change limit reached"). You
must resolve the issue to continue detecting software changes.
1. Examine the computer's processes and security events. Verify that the computer has not
been compromised. If you are not sure, or do not have enough time, the safest and fastest
way is to restore the system from a backup or VM snapshot.
Warning: If you don't remove any unauthorized software (including zero-day malware),
Application Control will ignore it when you reset Application Control. It won't appear on
the Actions tab anymore and if its process has already executed and it is in RAM,
Application Control won't log any events or alerts about it until you reboot the computer.
817
Trend Micro Deep Security On-Premise 20
2. If the computer was running software updates, including auto-updates (for example,
browser, Adobe Reader, or yum auto-updates), disable them or schedule them so that they
occur only when you have enabled Application Control's maintenance mode (see "Turn on
maintenance mode when making planned changes" on page 807).
3. Reset Application Control. To do this, disable Application Control in the Computer editor 1.
Once the agent has acknowledged it and cleared the error status, enable Application
Control again. The agent generates a new software inventory list.
Use the API to create shared and global rulesets
For an overview of Application Control, see "About Application Control" on page 796. For initial
configuration instructions, see "Set up Application Control" on page 802.
Using the Deep Security Manager API on the Automation Center, you can create shared rulesets
and global rules. You can use one type of ruleset, or a combination. For more information, see
Create a shared ruleset and Add global rules.
l Local ruleset: Rules that are added as part of a computer's software inventory or when in
maintenance mode are stored only on the protected computer and are not visible in Deep
Security Manager. Allow or block rules that you configure in Deep Security Manager are
sent to the agent and stored in both places. Because agents don't transfer their inventory
information to the manager, local rulesets offer better performance than shared rulesets.
To determine whether software is new or has changed, Deep Security Agent 10 compares
the file with the initially installed software's SHA-256 hash, file size, path, and file name
(they have a "file-based" local ruleset). Deep Security Agent 11 and newer compares only
the file's SHA-256 hash and file size (they have a "hash-based" local ruleset). Because the
rules created by Deep Security 11 (and newer) agents compare only the unique hash and
file size, a rule will continue to be applied even if the software file is renamed or moved. As
a result, using Deep Security Agent 11 or newer reduces the number of software changes
that you need to deal with. Deep Security Agent 10 continues to use a file-based local
ruleset until it is upgraded to Deep Security Agent 11.0 or newer. When you upgrade, its
local ruleset is converted to use hash-based rules.
Note: If there are multiple file-based rules for the same hash value, they are
consolidated into one hash-based rule. If the rules being consolidated conflict with each
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
818
Trend Micro Deep Security On-Premise 20
other (one rule blocks the file and another allows it), the new hash-based rule will be an
"allow" rule.
l Shared ruleset: Syncs all of its rule data onto both agents and manager (and also relays, if
enabled). This increases network and disk space usage. However, it may be easier if you
need to verify the rules from the initial inventory scan or maintenance mode, or if you
manage a server farm with many computers that should be identical. For example, if you
have a server pool of identical LAMP web servers, or if they are virtual machines
(VMs) that are part of an auto-scaling group, shared rulesets can be useful. It can also
reduce administrator workload.
Warning: Don't use a shared ruleset if you enabled Block unrecognized software until it
is explicitly allowed, and if computers are merely similar (but not identical). It will block all
software on other computers that isn't in the first computer's ruleset. If those include
critical files, it could break the OS. If that happens, you may be required to reinstall, revert
to a backup, or use the OS recovery mode.
When you create a new shared ruleset using Deep Security Agent 11.1 or newer, it can
only contain hash-based rules (rules that compare only a file's hash and size). If you
created a shared ruleset using Deep Security Agent 11.0 or earlier, it contains file-based
rules (rules that compare a file's name, path, size, and hash). Older shared rulesets will
continue to use file-based rules until all agents using the shared ruleset are upgraded to
Deep Security Agent 11.0 or newer. Then the shared ruleset will be converted to use hash-
based rules.
Warning: Don't create a new shared ruleset until all agents are upgraded to Deep
Security Agent 11.0 or newer. New shared rulesets are hash-based and are not
compatible with Deep Security Agent 10.3 or earlier, which supports only file-based
rulesets.
Note: If there are multiple file-based rules for the same hash value, they are
consolidated into one hash-based rule. If the rules being consolidated conflict with each
other (one rule blocks the file and another allows it), the new hash-based rule will be an
"allow" rule.
To create shared rules, see Create a shared ruleset on the Automation Center.
819
Trend Micro Deep Security On-Premise 20
l Global rules: Like shared rulesets, global rules are distributed to agents by the manager
(and also relays, if enabled). This increases network and disk space usage. However,
because they are global, you don't need to spend time selecting them in each policy.
Global rules aren't part of the rulesets you can see in Deep Security Manager. Global rules
can only contain block rules, not allow rules.
Global rules require Deep Security Agent 10.2 or newer. The manager will not send the
global rules to older agents. Global rules take precedence over all other Application
Control rules and are enforced on all computers where Application Control is enabled. The
rules in global rules are based on a file's SHA-256 hash. Because a software file's hash is
unique, you can block specific software everywhere — regardless of file path, policy, or
computer group, and regardless of whether Application Control has detected the software
before.
Note: In a multi-tenant deployment, each tenant has a separate global rules. To block
software for all tenants, create the same global rules for each tenant.
To create global rules, see Add global rules on the Automation Center.
In this article:
l "Create a shared ruleset" below
l "Change from shared to computer-specific allow and block rules" on the next page
l "Deploy Application Control shared rulesets via relays" on page 822
l "Considerations when using relays with shared rulesets" on page 824
Create a shared ruleset
You can use the API to create shared allow or block rules and apply the ruleset to other
computers. This can be useful if you have many identical computers (such as a load balanced
web server farm). Shared rulesets should be applied only to computers with the exact same
inventory.
1. Use the API to build a computer's shared allow and block rules. For more information, see
Create a Shared Ruleset. If you want to examine the shared ruleset before you deploy it,
see "View and change Application Control rulesets" on page 813.
820
Trend Micro Deep Security On-Premise 20
2. Go to Computer or Policy editor 1 > Application Control.
3. In the ruleset section, make sure Inherit settings is not selected and then select Use a
shared ruleset. Indicate which shared rules to use.
Note: These settings are hidden until you use the API to create at least one shared
ruleset. If you haven't created any shared rulesets, or if you keep the default settings,
each computer will keep its own allow and block rules locally. Changes to local rules
don't affect other computers.
4. Click Save.
The next time that the Deep Security Agent on the computer connects with Deep Security
Manager, the agent applies those rules.
If you see an error saying that the ruleset upload was not successful, verify that network
devices between the agent and the manager or relay allow communications on the
heartbeat port or relay port numbers.
Change from shared to computer-specific allow and block rules
If the computer is currently using shared allow or block rules created via the API, you can
change it to use local rules. Application control scans the file system for all currently-installed
software and creates an initial ruleset for it, similar to when you first enabled Application Control.
Warning: Before you start, verify that only good software is currently installed. Rebuilding the
ruleset will allow all currently installed software, even if it is insecure or malware. If you are not
sure what is installed, the safest approach is to make a clean install and then enable
Application Control.
The steps below configure a computer's agent to use a local ruleset. If you want all computers to
use local rules, edit the setting in the Policies tab instead.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
821
Trend Micro Deep Security On-Premise 20
1. Go to Computer editor 1 > Application Control.
2. In the ruleset section, deselect Inherit settings (if necessary), and then select Use local
ruleset initially based on installed software.
3. Click Save.
To verify the change, the next time the agent and Deep Security Manager connect, look for
event log messages about building the Application Control ruleset.
Deploy Application Control shared rulesets via relays
Each time you create an Application Control ruleset or change it, it must be distributed to all
computers that use it. Shared rulesets are bigger than local rulesets. Shared rulesets are also
often applied to many servers. If they all downloaded the ruleset directly from the manager at the
same time, high load could cause slower performance. Global rulesets have the same
considerations.
Using Deep Security Relays can solve this problem. (For information on configuring relays, see
"Deploy additional relays" on page 1091.)
Steps vary depending whether or not you have a multi-tenant deployment.
Single tenant deployments
Go to Administration > System Settings > Advanced and then select Serve Application Control
rulesets from relays.
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
822
Trend Micro Deep Security On-Premise 20
Multi-tenant deployments
The primary tenant (t0) can't access other tenants' (tN) configurations, so t0 relays don't have tN
Application Control rulesets. Other tenants (Tn) must create their own relay group, then select
Serve Application Control rulesets from relays.
823
Trend Micro Deep Security On-Premise 20
Considerations when using relays with shared rulesets
Before using relays, verify that they are compatible with your deployment. If the agent doesn't
have any previously downloaded ruleset currently in effect, and if it doesn't receive new
Application Control rules, then the computer won't be protected by Application Control. If
Application Control ruleset download fails, a ruleset download failure event will be recorded on
the manager and on the agent.
l If you are using a proxy to connect agents to a manager, you must use a relay.
Note: In Deep Security Agent 10.0 and earlier, agents didn't have support for
connections through a proxy to relays. If a ruleset download fails due to a proxy, and if
your agents require a proxy to access the relay or manager (including Deep Security as a
Service), then you must either:
l update agents' software, then configure the proxy
l bypass the proxy
l add a relay and then select Serve Application Control rulesets from relays
l If you are using shared or global rulesets, a relay can result in faster performance.
l If you are using local rulesets, a relay can cause slower performance,
l Do not use a relay with multi-tenant configurations when non-primary tenants (tN) use the
default, primary (t0) relay group.
824
Trend Micro Deep Security On-Premise 20
Configure events and alerts
About Deep Security event logging
Deep Security Agents record when a protection module rule or condition is triggered (a "security
event"). Agents and Deep Security Manager also records when administrative or system-related
events occur (a "system event"), such as an administrator logging in, or agent software being
upgraded. Event data is used to populate the various reports and graphs in Deep Security
Manager.
To view events, go to Events & Reports in Deep Security Manager.
Where are event logs on the agent?
Location varies by the computer's operating system. On Windows, event logs are stored in this
location:
C:\Program Data\Trend Micro\Deep Security Agent\Diag
On Linux, event logs are stored here:
/var/opt/ds_agent/diag
Note: These locations only contain standard-level logs; diagnostic debug-level logs have a
different location. For performance reasons, debug-level logging is not enabled by default. You
should only enable debug logging if diagnosing an issue with Trend Micro technical support,
and make sure to disable debug logging when you are done. For more information, see
Enabling detailed logging on Deep Security Agent (DSA).
When are events sent to the manager?
Most events that take place on a computer are sent to the Deep Security Manager during the
next heartbeat operation except the following, which will be sent right away if communication
settings allow relays/agents/appliances to initiate communication:
l Smart Scan Server is offline
l Smart Scan Server is back online
l Integrity Monitoring scan is complete
825
Trend Micro Deep Security On-Premise 20
l Integrity Monitoring baseline created
l Unrecognized elements in an Integrity Monitoring Rule
l Elements of an Integrity Monitoring Rule are unsupported on the local platform
l Abnormal restart detected
l Low disk space warning
l Log Inspection offline
l Log Inspection back online
l Reconnaissance scan detected (if the setting is enabled in Computer or Policy editor 1 >
Firewall > Reconnaissance
How long are events stored?
Once collected by the Deep Security Manager, events are kept for a period of time, which is
specified on the Administration > System Settings > Storage page. For details, see "Log and
event storage best practices" on page 829.
System events
All the Deep Security system events are listed and can be configured on the Administration >
System Settings > System Events tab. You can set whether to record the individual events and
whether to forward them to a SIEM system. For details on system events, see " System events"
on page 984.
Security events
Each protection module generates events when rules are triggered or other configuration
conditions are met. Some of this security event generation is configurable. For information on
specific types of security events, refer to these articles:
l "Anti-malware events" on page 1033
l "View and restore identified malware" on page 599
l "Application Control events" on page 1032
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
826
Trend Micro Deep Security On-Premise 20
l "Firewall events" on page 1035
l "Integrity monitoring events" on page 1049
l "Intrusion prevention events" on page 1044
l "Log inspection events" on page 1052
l "Web reputation events" on page 1053
The firewall stateful configuration in effect on a computer can be modified to enable or disable
TCP, UDP, and ICMP event logging. To edit the properties of a stateful firewall configuration, go
to Policies > Common Objects > Other > Firewall Stateful Configurations. The logging options
are in the TCP, UDP, and ICMP tabs of the firewall stateful configuration's Properties window.
For more information about firewall events, see "Firewall events" on page 1035.
See the events associated with a policy or computer
The Policy editor 1 and theComputer editor 2both have Events tabs for each protection module.
The policy editor displays events associated with the current policy. The computer editor
displays events specific to the current computer.
View details about an event
To see details about an event, double-click it.
The General tab displays:
l Time: The time according to the system clock on the computer hosting the Deep Security
Manager.
l Level: The severity level of event that occurred. Event levels include Info, Warning, and
Error.
l Event ID: The event type's unique identifier.
l Event: The name of the event (associated with the event ID.)
l Target: The system object associated with the event will be identified here. Clicking the
object's identification will display the object's properties sheet.
l Event Origin: The Deep Security component from which the event originated.
1To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
2To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
827
Trend Micro Deep Security On-Premise 20
l Action Performed By: If the event was initiated by a user, that user's username will be
displayed here. Clicking the username will display the User Properties window.
l Manager: The hostname of the Deep Security Manager computer.
l Description: If appropriate, the specific details of what action was performed to trigger this
event are displayed here.
The Tags tab displays tags that have been attached to this event. For more information on event
tagging, see Policies > Common Objects > Other > Tags, and "Apply tags to identify and group
events" on page 836.
Filter the list to search for an event
The Period toolbar lets you filter the list to display only those events that occurred within a
specific timeframe.
The Computers toolbar lets you organize the display of event log entries by computer groups or
computer policies.
Clicking Search > Open Advanced Search toggles the display of the advanced search bar.
Clicking the "Add Search Bar" button (+) to the right of the search bar will display an additional
search bar so you can apply multiple parameters to your search. When you are ready, press the
"Submit Request" button (at the right of the toolbars with the right-arrow on it).
Export events
You can export displayed events to a CSV file. (Paging is ignored, all pages will be exported.)
You have the option of exporting the displayed list or the selected items.
Improve logging performance
Here are some suggestions to help maximize the performance of event collection:
828
Trend Micro Deep Security On-Premise 20
l Reduce or disable log collection for computers that are not of interest.
l Consider reducing the logging of firewall rule activity by disabling some logging options in
the firewall stateful configuration Properties window. For example, disabling the UDP
logging will eliminate the "Unsolicited UDP" log entries.
Log and event storage best practices
Best practices for log and event data storage depend on the data compliance regulations you
must meet, such as PCI and HIPAA. Also consider optimizing the use of your database. Storing
too much data may affect database performance and size requirements.
If you're storing too much data in your database, these symptoms may occur:
l Error messages that systems may be experiencing loss of database activity
l Inability to import software updates
l General slow-down in Deep Security
To avoid those symptoms:
1. Store system events according to the compliance standard requirement.
2. Forward system and security events to external storage. See "Forward Deep Security
events to a Syslog or SIEM server" on page 846. Then you can reduce how long events
are kept in the local database.
3. Set thresholds in the log inspection module for event storage or event forwarding. Severity
clipping allows you to send events to a Syslog server (if enabled) or to store events based
on the severity level of the log inspection rule. See "Configure log inspection event
forwarding and storage" on page 769.
Default local storage settings are in the table below. To change these settings, go to
Administration > System Settings > Storage. To delete software versions or older rule updates,
go to Administration > Updates > Software > Local or Administration > Updates > Security >
Rules.
Tip: To reduce database disk space usage, forward events to an external Syslog server or
SIEM and reduce the local event retention time. Only keep counters locally.
829
Trend Micro Deep Security On-Premise 20
Data type settings Data pruning default setting
Automatically delete Anti-Malware Events older than 7 Days
Automatically delete Web Reputation Events older than: 7 Days
Automatically delete Firewall Events older than: 7 Days
Automatically delete Intrusion Prevention Events older than: 7 Days
Automatically delete Integrity Monitoring Events older than: 7 Days
Automatically delete Log Inspection Events older than: 7 Days
Automatically delete Application Control Events older than: 7 Days
Automatically delete System Events older than: 53 Weeks
Automatically delete Server Logs older than: 7 Days
Automatically delete Counters older than: 13 Weeks
Number of older software versions to keep per platform:* 5
Number of older Rule Updates to keep: 10
* If multi-tenancy is enabled, this setting will not be available.
Note: If using a PostgreSQL database, old events might not be pruned immediately.
PostgreSQL maintenance jobs periodically remove the old events' database partitions.
Pruning will occur during the next scheduled job.
Events are records of individual events. They populate the Events pages.
Counters are the number of times individual events have occurred. They populate the dashboard
widgets (number of firewall events over the last 7 days, etc.) and the reports.
Server log files are from Deep Security Manager's web server. They don't include event logs
from agents installed on your network's web servers.
830
Trend Micro Deep Security On-Premise 20
Troubleshooting
During troubleshooting, it may be useful to increase the logging level and record more detailed
events.
Increased logging can significantly increase disk space usage. Reduce the logging level again
when you have finished troubleshooting.
1. Open the Computer or Policy editor 1.
2. Go to Settings > General > Logging Level.
3. Choose whether to inherit the logging override settings from the policy assigned to this
computer (Inherited), to not override logging settings (Do Not Override), to log all triggered
firewall rules (Full Firewall Event Logging), to log all triggered intrusion prevention rules
(Full Intrusion Prevention Event Logging), or to log all triggered rules (Full Logging).
4. Click Save .
Limit log file sizes
You can set the maximum size of each individual log file and how many of the most recent files
are kept. Event log files will be written to until they reach the maximum allowed size, at which
point a new file will be created and written to until it reaches the maximum size and so on. Once
the maximum number of files is reached, the oldest will be deleted before a new file is created.
Event log entries usually average around 200 bytes in size and so a 4 MB log file will hold about
20,000 log entries. How quickly your log files fill up depends on the number of rules in place.
1. Open the Computer or Policy editor 2 for the policy that you want to configure.
2. Go to Settings > Advanced > Events.
3. Configure these properties:
l Maximum size of the event log files (on Agent/Appliance): Maximum size that the log
file can reach before a new log file is created.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
831
Trend Micro Deep Security On-Premise 20
l Number of event log files to retain (on Agent/Appliance): Maximum number of log
files that will be kept. Once the maximum number of log files is reached, the oldest file
will be deleted before a new one is created.
l Do Not Record Events with Source IP of: This option is useful if you don't want Deep
Security to make record events for traffic from certain trusted computers.
Note: The following three settings let you fine tune event aggregation. To save disk
space, Deep Security Agents and Appliances will take multiple occurrences of
identical events and aggregate them into a single entry and append a "repeat count",
a "first occurrence" timestamp, and a "last occurrence" timestamp. To aggregate
event entries, Deep Security Agents and Appliances need to cache the entries in
memory and then write them to disk.
l Cache Size: Determines how many types of events to track at any given time. Setting
a value of 10 means that 10 types of events will be tracked (with a repeat count, first
occurrence timestamp, and last occurrence timestamp). When a new type of event
occurs, the oldest of the 10 aggregated events will be flushed from the cache and
written to disk.
l Cache Lifetime: Determines how long to keep a record in the cache before flushing it
to disk. If this value is 10 minutes and nothing else causes the record to be flushed,
any record that reaches an age of 10 minutes gets flushed to disk.
l Cache Stale time: Determines how long to keep a record whose repeat count has not
been recently incremented. If Cache Lifetime is 10 minutes and Cache Staletime is 2
minutes, an event record which has gone 2 minutes without being incremented will be
flushed and written to disk.
Note: Regardless of the above settings, the cache is flushed whenever events are
sent to the Deep Security Manager.
4. Click Save.
Event logging tips
l On computers that are less important, modify the amount of logs collected. This can be
done in the Events and Advanced Network Engine Options areas on the Computer or
832
Trend Micro Deep Security On-Premise 20
Policy editor 1 > Settings > Advanced tab.
l Consider reducing the event logging of firewall rule activity by disabling the event logging
options in the firewall stateful configuration. (For example, if you disable UDP logging, it
will eliminate unsolicited UDP log entries.)
l For intrusion prevention rules, the best practice is to log only dropped packets. If you log
packet modifications, it may cause too many log entries.
l For intrusion prevention rules, only include packet data (an option in the intrusion
prevention rule's Properties window) when you are interested in examining the behavior of
a specific attack. Packet data increases log sizes, so it shouldn't be used for everything.
Anti-Malware scan failures and cancellations
Anti-Malware scans can fail or be cancelled for several reasons, which have different
recommended actions.
Note: These events can occur for manual, quick, or scheduled scans.
Anti-Malware scan failure events
This table provides possible reasons for system events 793, 795, and 1543 (Malware Scan
Failure).
Event Reason
Description Recommended action
reason ID *
1. From the Computer or Policy
editor, go to Anti-Malware >
Malware Scan could not be started. General.
Empty
31 This is caused by an empty 2. Make sure a Malware Scan
configuration
Malware Scan configuration. configuration is assigned to the
Scheduled scan.
3. Rerun the scan.
Anti- Malware Scan could not be started. 1. From the Computer or Policy
Malware 30 This is because the Anti-Malware
module is off module is turned off. editor, go to Anti-Malware >
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
833
Trend Micro Deep Security On-Premise 20
Event Reason
Description Recommended action
reason ID *
General.
2. Make sure the Anti-Malware
state is "On" or "Inherited (On)."
3. Rerun the scan.
1. From the Computer or Policy
editor, go to Overview >
General, and click Check
Status.
Anti- 2. If the Anti-Malware Status is
Malware Scan failed because the
Malware
7 Anti-Malware service is being "Anti-Malware Engine Offline,"
service
terminated. follow the procedure to solve
stops
the "Error: Anti-Malware
Engine Offline" on page 1060
issue.
3. Rerun the scan.
1. Follow the procedure to solve
Anti- the "Error: Anti-Malware
Malware Malware Scan failed because the
9 Engine Offline" on page 1060
engine is Anti-Malware engine is offline.
offline issue.
2. Rerun the scan.
1. From the Computers page,
Malware Scan failed because of an right-click the target computer
Fail to inaccessible Anti-Malware
access -2 configuration. (This may be due to and go to Actions > Assign
configuration an unexpected internal error or Policy.
timing issue.)
2. Rerun the scan.
1. From the Computers page,
check the Task(s) column for
the target computer to see if
Malware Scan failed because another Malware Scan is in
Other scan progress.
another scan task is in progress.
task is -16
(This may be due to an unexpected 2. If yes, either wait for the current
running
internal error or timing issue.) scan task to complete or right-
click the target computer and
go to Actions > Cancel
Malware Scan.
834
Trend Micro Deep Security On-Premise 20
Event Reason
Description Recommended action
reason ID *
3. Rerun the scan.
1. Collect the system event
information and follow the
Unknown procedure to "Create a
Malware Scan failed for an
reason on 10
unknown reason. diagnostic package and logs"
agent
on page 1550.
2. Contact support.
* The reason ID is included in events forwarded to an external Syslog, SIEM server, or to
Amazon SNS. It is not displayed in Deep Security Manager.
Anti-Malware scan cancellation events
This table provides possible reasons for system events 1526, 1528, and 1540 (Malware Scan
Cancellation Completed).
Event Reason
Description Recommended action
reason ID *
Cancel Anti-Malware scan was canceled
1 Run the scan again.
by user manually.
Anti-Malware scan was canceled, Check that the computer is on and
Server
32 possibly because the computer being
reboot
scanned was shut down or restarted. run the scan again.
1. From the Computer or Policy
Anti- editor, go to Anti-Malware >
Anti-Malware scan was cancelled General.
Malware
7 because the Anti-Malware service
service 2. Make sure the Anti-Malware
was being restarted.
restart
state is "On" or "Inherited (On)."
3. Rerun the scan.
1. From the Computer or Policy
editor, go to Anti-Malware >
Anti-Malware scan was cancelled General.
Deep
because the agent was being 2. Make sure the Anti-Malware
Security
6 restarted. Check that the Anti-Malware state is "On" or "Inherited (On)."
Agent
module is online and run the scan
restart 3. Rerun the scan.
again.
Also make sure there is no agent
upgrade or policy change taking
835
Trend Micro Deep Security On-Premise 20
Event Reason
Description Recommended action
reason ID *
place during scanning because these
tasks may cause the agent to restart.
1. Collect the system event
information and follow the
Unknown Anti-Malware scan was cancelled for procedure to "Create a
-1
reason an unknown reason. diagnostic package and logs"
on page 1550.
2. Contact support.
* The reason ID is included in events forwarded to an external Syslog, SIEM server, or to
Amazon SNS. It is not displayed in Deep Security Manager.
Apply tags to identify and group events
Deep Security enables you to create tags that you can use to identify and sort events. For
example, you might use tags to separate events that are benign from those that require further
investigation. You can use tags to create customized dashboards and reports.
Although you can use event tagging for a variety of purposes, it was designed to ease the
burden of event management. After you have analyzed an event and determined that it is
benign, you can look through the event logs of the computer (and any other similarly configured
and tasked computers) to find similar events and apply the same label to them, eliminating the
need to analyze each event individually.
To view tags that are currently in use, go to Policies > Common Objects > Other > Tags.
Note: Tags do not alter the data in the events themselves, nor do they allow users to delete
events. They are simply extra attributes provided by the manager.
You can perform tagging the following ways:
l "Manual tagging" on the next page lets you tag specific events as needed.
l "Auto-tagging" on the next page lets you use an existing event as the model for auto-
tagging similar events on the same or other computers. You define the parameters for
"similarity" by selecting which event attributes have to match the model event attributes for
a tag to be applied.
836
Trend Micro Deep Security On-Premise 20
l "Trusted source tagging" on page 839 lets you auto-tag integrity monitoring events based
on their similarity to known-good events from a trusted source.
Note: An important difference between standard tagging and trusted source tagging is that
"Run on Existing Events Now" can only be done with standard event tagging
Manual tagging
1. Go to Events & Reports > Events and select an event list. Right-click the event (or select
multiple events and right-click) and select Add Tag(s).
2. Type a name for the tag. Deep Security Manager will suggest matching names of existing
tags as you type.
3. Select The Selected [Event Type] Event. Click Next.
4. Enter some optional comments and click Finish.
In the events list, you can see your tag in the TAG(S) column.
Auto-tagging
Deep Security Manager enables you to define rules that apply the same tag to similar events
automatically. To view existing saved auto-tagging rules, click Auto-Tagging in the menu bar on
any Events page. You can run saved rules manually from this page.
1. Go to Events & Reports > Events and select an event list. Right-click a representative
event and select Add Tag(s).
2. Type a name for the tag. Deep Security Manager will suggest matching names of existing
tags as you type.
3. Select Apply to selected and similar [Event Type] Events and click Next.
4. Select the computers where you want to auto-tag events and click Next. When applying
tags to system events, this page is skipped.
5. Select which attributes will be examined to determine whether events are similar. For the
most part, the attribute options are the same as the information displayed in the columns of
the Events list pages. When you have selected which attributes to include in the event
selection process, click Next.
6. On the next page, specify when events should be tagged. If you select Existing [Event
Type] Events, you can select Apply Auto-Tag Rule now to apply the auto-tagging rule
immediately, or Apply Auto-Tag Rule in the background to have it run in the background at
a lower priority. Select Future [Event Type] Events to apply the auto-tagging rule to events
837
Trend Micro Deep Security On-Premise 20
that will happen in the future. You can also save the auto-tagging rule by selecting Save
Auto-Tag Rule and optionally entering a name. Click Next.
7. Review the summary of your auto-tagging rule and click Finish.
In the events list, you can see that your original event and all similar events have been tagged
Note: Event tagging only occurs after events have been retrieved from the agents or
appliances to the Deep Security Manager database.
Set the precedence for an auto-tagging rule
Once an auto-tagging rule is created, you can assign it a Precedence value. If the auto-tagging
rule has been configured to run on future events, the rule's precedence determines the order in
which all auto-tagging rules are applied to incoming events. For example, you can have a rule
with a precedence value of "1" that tags all "User Signed In" events as "suspicious", and a rule
with a precedence value of "2" that removes the "suspicious" tag from all "User Signed In"
events where the target (user) is you. This will result in a "suspicious" tag being applied to all
future "User Signed In" events where the user is not you.
1. In an events list, click Auto-Tagging to display a list of saved auto-tagging rules.
2. Right-click an auto-tagging rule and select Details.
3. In the General tab, select a Precedence for the rule.
Auto-tagging log inspection events
Log inspection events are auto-tagged based upon their grouping in the log file structure. This
simplifies and automates the processing of log inspection events within Deep Security Manager.
You can use auto-tagging to automatically apply tags for the log inspection groups. Log
inspection rules have groups associated with them in the rules. For example:
<rule id="18126" level="3">
<if_sid>18101</if_sid>
<id>^20158</id>
<description>Remote access login success</description>
<group>authentication_success,</group>
</rule>
<rule id="18127" level="8">
<if_sid>18104</if_sid>
<id>^646|^647</id>
<description>Computer account changed/deleted</description>
838
Trend Micro Deep Security On-Premise 20
<group>account_changed,</group>
</rule>
Each group name has a "friendly" name string associated with it. In the above example,
"authentication_success" would be "Authentication Success", "account_changed" would be
"Account Changed". When this checkbox is set, the friendly names are automatically added as a
tag for that event. If multiple rules trigger, multiple tags will be attached to the event.
Trusted source tagging
Note: Trusted source event tagging can only be used with events generated by the integrity
monitoring protection module.
The integrity monitoring module allows you to monitor system components and associated
attributes on a computer for changes. ("Changes" include creation and deletion as well as edits.)
Among the components that you can monitor for changes are files, directories, groups, installed
software, listening port numbers, processes, registry keys, and so on.
Trusted source event tagging is designed to reduce the number of events that need to be
analyzed by automatically identifying events associated with authorized changes.
In addition to auto-tagging similar events, the integrity monitoring module allows you to tag
events based on their similarity to events and data found on Trusted Sources. A trusted source
can be either:
1. A local trusted computer,
2. The Trend Micro Certified Safe Software Service, or
3. A trusted common baseline, which is a set of file states collected from a group of
computers.
Local trusted computer
A trusted computer is a computer that will be used as a "model" computer that you know will only
generate benign or harmless events. A "target" computer is a computer that you are monitoring
for unauthorized or unexpected changes. The auto-tagging rule examines events on target
computers and compares them to events from the trusted computer. If any events match, they are
tagged with the tag defined in the auto-tagging rule.
You can establish auto-tagging rules that compare events on protected computers to events on a
trusted computer. For example, a planned rollout of a patch can be applied to the trusted
computer. The events associated with the application of the patch can be tagged as "Patch X".
839
Trend Micro Deep Security On-Premise 20
Similar events raised on other systems can be auto-tagged and identified as acceptable
changes and filtered out to reduce the number of events that need to be evaluated.
How does Deep Security determine whether an event on a target computer
matches an event on a trusted source computer?
Integrity monitoring events contain information about transitions from one state to another. In
other words, events contain before and after information. When comparing events, the auto-
tagging engine will look for matching before and after states; if the two events share the same
before and after states, the events are judged to be a match and a tag is applied to the second
event. This also applies to creation and deletion events.
Note: Remember that when using a trusted computer for trusted source event tagging, the
events being tagged are events generated by integrity monitoring rules. This means that the
integrity monitoring rules that are generating events on the target computer must also be
running on the trusted source computer.
Note: Trusted source computers must be scanned for malware before applying trusted source
event tagging.
Note: Utilities that regularly make modifications to the content of files on a system (prelinking
on Linux, for example) can interfere with trusted source event tagging.
Tag events based on a local trusted computer
1. Make sure the trusted computer is free of malware by running a full anti-malware scan.
2. Make sure the computer(s) on which you want to auto-tag events are running the same (or
some of the same) integrity monitoring rules as the trusted source computer.
3. In Deep Security Manager, go to Events & Reports > Integrity Monitoring Events and click
Auto-Tagging in the toolbar.
4. In the Auto-Tag Rules (Integrity Monitoring Events) window, click New Trusted Source to
display the Tag Wizard.
5. Select Local Trusted Computer and click Next.
6. From the list, select the computer that will be the trusted source and click Next.
7. Specify one or more tags to apply to events on target computers when they match events
on this trusted source computer. Click Next.
Note: You can enter the text for a new tag or select from a list of existing tags.
840
Trend Micro Deep Security On-Premise 20
8. Identify the target computers whose events will be matched to those of the trusted source.
Click Next.
9. Optionally, give the rule a name and click Finish.
Tag events based on the Trend Micro Certified Safe Software Service
The Certified Safe Software Service is an allow list of known-good file signatures maintained by
Trend Micro. This type of trusted source tagging will monitor target computers for file-related
integrity monitoring events. When an event has been recorded, the file's signature (after the
change) is compared to Trend Micro's list of known good file signatures. If a match is found, the
event is tagged.
1. In Deep Security Manager, go to Events & Reports > Integrity Monitoring Events and click
Auto-Tagging in the toolbar.
2. In the Auto-Tag Rules (Integrity Monitoring Events) window, click New Trusted Source to
display the Tag Wizard.
3. Select Certified Safe Software Service and click Next.
4. Specify one or more tags to apply to events on target computers when they match the
Certified Safe Software Service. Click Next.
5. Identify the target computers whose events will be matched to the Certified Safe Software
Service. Click Next.
6. Optionally, give the rule a name and click Finish.
Tag events based on a trusted common baseline
The trusted common baseline method compares events within a group of computers. A group of
computers is identified and a common baseline is generated based on the files and system
states targeted by the integrity monitoring rules in effect on the computers in the group. When an
integrity monitoring event occurs on a computer within the group, the signature of the file after the
change is compared to the common baseline. If the file's new signature has a match elsewhere
in the common baseline, a tag is applied to the event. In trusted computer method, the before
and after states of an integrity monitoring event are compared, but in the trusted common
baseline method, only the after state is compared.
Note: This method relies on all the computers in the common group being secure and free of
malware. A full anti-malware scan should be run on all the computers in the group before the
common baseline is generated.
Note: When an integrity monitoring baseline is generated for a computer, Deep Security will
first check if that computer is part of a trusted common baseline group. If it is, it will include the
841
Trend Micro Deep Security On-Premise 20
computer's baseline data in the trusted common baseline for that group. For this reason, the
trusted common baseline auto-tagging rule must be in place before any integrity monitoring
rules have been applied to the computers in the common baseline group.
1. Make sure all the computers that will be in the group that will make up the trusted common
baseline are free of malware by running a full anti-malware scan on them.
2. In Deep Security Manager, go to Events & Reports > Integrity Monitoring Events and click
Auto-Tagging in the toolbar.
3. In the Auto-Tag Rules (Integrity Monitoring Events) window, click New Trusted Source to
display the Tag Wizard.
4. Select Trusted Common Baseline and click Next.
5. Specify one or more tags to apply to events when they have a match in the trusted common
baseline and click Next.
6. Identify the computers to include in the group used to generate the trusted common
baseline. Click Next.
7. Optionally, give this rule a name and click Finish.
Delete a tag
1. In an events list, right-click the events with the tag you want to delete, and select Remove
Tag(s).
2. Select the tag you'd like to remove. Choose to remove the tag from The Selected [Event
Type] Event or to Apply to selected similar [Event Type] Events. Click Next.
3. Enter some optional comments and click Finish.
Reduce the number of logged events
To reduce the number of events being logged, the Deep Security Manager can be configured to
operate in one of several Advanced Logging Policy modes. These modes are set in the
Computer or Policy editor 1 on the Settings > Advanced > Advanced Network Engine Settings
area.
The following table lists the types of events that are ignored in four of the more complex
Advanced Logging Policy modes:
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
842
Trend Micro Deep Security On-Premise 20
Mode Ignored Events
Out Of Connection
Invalid Flags
Invalid Sequence
Invalid ACK
Stateful and Normalization Suppression
Unsolicited UDP
Unsolicited ICMP
Out Of Allowed Policy
Dropped Retransmit
Out Of Connection
Invalid Flags
Invalid Sequence
Invalid ACK
Unsolicited UDP
Unsolicited ICMP
Out Of Allowed Policy
CE Flags
Invalid IP
Invalid IP Datagram Length
Fragmented
Invalid Fragment Offset
Stateful, Normalization, and Frag Suppression First Fragment Too Small
Fragment Out Of Bounds
Fragment Offset Too Small
IPv6 Packet
Max Incoming Connections
Max Outgoing Connections
Max SYN Sent
License Expired
IP Version Unknown
Invalid Packet Info
Maximum ACK Retransmit
Packet on Closed Connection
Dropped Retransmit
Out Of Connection
Invalid Flags
Invalid Sequence
Invalid ACK
Unsolicited UDP
Unsolicited ICMP
Out Of Allowed Policy
Stateful, Frag, and Verifier Suppression CE Flags
Invalid IP
Invalid IP Datagram Length
Fragmented
Invalid Fragment Offset
First Fragment Too Small
Fragment Out Of Bounds
843
Trend Micro Deep Security On-Premise 20
Mode Ignored Events
Fragment Offset Too Small
IPv6 Packet
Max Incoming Connections
Max Outgoing Connections
Max SYN Sent
License Expired
IP Version Unknown
Invalid Packet Info
Invalid Data Offset
No IP Header
Unreadable Ethernet Header
Undefined
Same Source and Destination IP
Invalid TCP Header Length
Unreadable Protocol Header
Unreadable IPv4 Header
Unknown IP Version
Maximum ACK Retransmit
Packet on Closed Connection
Dropped Retransmit
Out Of Connection
Invalid Flags
Invalid Sequence
Tap Mode Invalid ACK
Maximum ACK Retransmit
Packet on Closed Connection
Dropped Retransmit
Rank events to quantify their importance
The ranking system provides a way to quantify the importance of events. By assigning "asset
values" to computers, and assigning severity or risk values to rules, the importance ("rank") of an
event is calculated by multiplying the two values together. This allows you to sort events by rank.
Note: Unlike the other modules, Anti-Malware does not use asset values to rank event
importance.
Web Reputation event risk values
Risk values for Web Reputation events are linked to the three levels of risk used by the Web
Reputation settings on the General tab of the Web Reputation page:
844
Trend Micro Deep Security On-Premise 20
l Dangerous: corresponds to "A URL that has been confirmed as fraudulent or a known
source of threats."
l Highly Suspicious: corresponds to "A URL that is suspected to be fraudulent or a known
source of threats."
l Suspicious: corresponds to "A URL that is associated with spam or possibly
compromised."
l Blocked by Administrator: A URL that is on the Web Reputation Service Blocked list.
l Untested: A URL that does not have a risk level.
Firewall rule severity values
Severity values for Firewall rules are linked to their actions: Deny, Log Only, and Packet
Rejection. (The latter refers to packets rejected because of a Firewall stateful configuration
setting.) Use this panel to edit the severity values which will be multiplied by a computer's asset
value to determine the rank of a Firewall event. (A Firewall rule's actions can be viewed and
edited in the rule's Properties window.)
Intrusion Prevention rule severity values
Intrusion Prevention rule severity values are linked to their severity levels: Critical, High,
Medium, Low, or Error. Use this panel to edit their values which will be multiplied by a
computer's asset value to determine the rank of an Intrusion Prevention event. An Intrusion
Prevention rule's severity setting can be viewed in the rule's Properties window.
Integrity Monitoring rule severity values
Integrity Monitoring rule severity values are linked to their severity levels: Critical, High, Medium,
or Low. Use this panel to edit their values which will be multiplied by a computer's asset value to
determine the rank of an Integrity Monitoring event. An Integrity Monitoring rule's severity can be
viewed in the rule's Properties window.
Log Inspection rule severity values
Log Inspection rule severity values are linked to their severity levels: Critical, High, Medium, or
Low. Use this panel to edit their values which will be multiplied by a computer's asset value to
determine the rank of a Log Inspection event. A Log Inspection rule's severity level can be
viewed and edited from the rule's Properties window.
845
Trend Micro Deep Security On-Premise 20
Asset values
Asset values are not associated with any of their other properties like Intrusion Prevention rules
or Firewall rules. Instead, asset values are properties in themselves. A computer's asset value
can be viewed and edited from the computer's Details window. To simplify the process of
assigning asset values, you can predefine some values that will appear in the Asset Importance
list in the first page of the computer's Details window. To view existing predefined computer
asset values, click the View Asset Values button in this panel. The Asset Values window
displays the predefined settings. These values can be changed, and new ones can be created.
(New settings will appear in the list for all computers.)
Forward events to a Syslog or SIEM server
Forward Deep Security events to a Syslog or SIEM server
You can send events to an external Syslog or Security Information and Event Management
(SIEM) server. This can be useful for centralized monitoring, custom reporting, or to free local
disk space on Deep Security Manager.
Note: Even if you enable event forwarding to an external server, Deep Security Manager still
records system and security events locally in order to display them in reports and graphs.
Therefore if you need to reduce disk space usage, event forwarding is not enough; you should
also configure how long to keep events locally.
Tip: Alternatively, if you want to publish events to Amazon SNS, see "Set up Amazon SNS"
on page 908.
Basic steps include:
1. "Allow event forwarding network traffic" below
2. "Request a client certificate" on the next page
3. "Define a Syslog configuration" on the next page
4. "Forward system events" on page 850 and/or "Forward security events" on page 850
Allow event forwarding network traffic
All routers, firewalls, and security groups must allow inbound traffic from Deep Security Manager
(and, for direct forwarding of security events, inbound traffic from agents) to your Syslog server.
See also "Port numbers, URLs, and IP addresses" on page 178.
846
Trend Micro Deep Security On-Premise 20
Request a client certificate
If you want to forward events securely (over TLS), and if your Syslog server requires client
authentication, then you must generate a client (not server) certificate signing request (CSR).
Deep Security Manager will use this certificate to identify and authenticate itself when it
connects as a client to the Syslog server. For details on how to request a client certificate,
contact your certificate authority (CA).
Note: Some Syslog servers do not accept self-signed server certificates (such as Deep
Security Manager's default). A CA-signed, client certificate is required.
Use either a CA that the Syslog server trusts, or an intermediate CA whose certificate was
signed, directly or indirectly, by a trusted root CA. (This is also called a "trust chain" or "signing
chain".)
Once you receive the signed certificate from your CA, to upload it to Deep Security Manager,
continue with "Define a Syslog configuration" below.
Define a Syslog configuration
Syslog configurations define the destination and settings that can be used when forwarding
system or security events.
If you configured SIEM or Syslog settings before January 26th, 2017, they have been converted
to Syslog configurations. Identical configurations were merged.
1. Go to Policies > Common Objects > Other > Syslog Configurations.
2. Click New > New Configuration.
3. On the General tab, configure:
l Name: Unique name that identifies the configuration.
l Description: Optional description of the configuration.
l Log Source Identifier: Optional identifier to use instead of Deep Security Manager's
hostname.
If Deep Security Manager is multi-node, each server node has a different hostname.
Log source IDs can therefore be different. If you need the IDs to be the same
regardless of hostname (for example, for filtering purposes), you can configure their
shared log source ID here.
847
Trend Micro Deep Security On-Premise 20
This setting does not apply to events sent directly by Deep Security Agent, which
always uses its hostname as the log source ID.
l Server Name: Hostname or IP address of the receiving Syslog or SIEM server.
l Server Port: Listening port number on the SIEM or Syslog server. For UDP, the IANA
standard port number is 514. For TLS, it's usually port 6514. See also "Port numbers,
URLs, and IP addresses" on page 178.
l Transport: Whether the transport protocol is secure (TLS) or not (UDP).
With UDP, Syslog messages are limited to 64 KB. If the message is longer, data may
be truncated.
With TLS, the manager and Syslog server must trust each other's certificates. The
connection from the manager to the Syslog server is encrypted with TLS 1.2, 1.1, or
1.0.
Note:
TLS requires that you set Agents should forward logs to Via the Deep Security
Manager (indirectly). Agents do not support forwarding with TLS.
TLS transport is not supported when operating in FIPS mode. See "FIPS 140-2
support" on page 1417.
l Event Format: Whether the log message's format is LEEF, CEF, or basic Syslog. See
"Syslog message formats" on page 852
Note: LEEF format requires that you set Agents should forward logs to Via the
Deep Security Manager (indirectly).
Note: Basic Syslog format is not supported by Deep Security Anti-Malware, Web
Reputation, Integrity Monitoring, and Application Control.
l Include time zone in events: Whether to add the full date (including year and time
zone) to the event.
Example (selected): 2018-09-14T01:02:17.123+04:00.
Example (deselected): Sep 14 01:02:17.
848
Trend Micro Deep Security On-Premise 20
Note: Full dates require that you set Agents should forward logs to Via the Deep
Security Manager (indirectly).
l Facility: Type of process that events will be associated with. Syslog servers may
prioritize or filter based upon a log message's facility field. See also What are Syslog
Facilities and Levels?
l Agents should forward logs: Whether to send events Directly to the Syslog server or
Via the Deep Security Manager (indirectly).
When forwarding logs directly to the Syslog server, agents use clear text UDP. Logs
contain sensitive information about your security system. If logs will travel over an
untrusted network such as the Internet, consider adding a VPN tunnel or similar to
prevent reconnaissance and tampering.
Note: If you forward logs via the manager, they do not include Firewall and Intrusion
Prevention packet data unless you configure Deep Security Manager to include it.
For instructions, see Sending packet data to syslog via Deep Security Manager
(DSM).
4. If the Syslog or SIEM server requires TLS clients to do client authentication (also called
bilateral or mutual authentication; see "Request a client certificate" on page 847), then on
the Credentials tab, configure:
l Private Key: Paste the private key of Deep Security Manager's client certificate.
l Certificate: Paste the client certificate that Deep Security Manager will use to identify
itself in TLS connections to the Syslog server. Use PEM, also known as Base64-
encoded format.
l Certificate Chain: If an intermediate CA signed the client certificate, but the Syslog
server doesn't know and trust that CA, then paste CA certificates which prove a
relationship to a trusted root CA. Press Enter between each CA certificate.
5. Click Apply.
6. If you selected the TLS transport mechanism, verify that both Deep Security Manager and
the Syslog server can connect and trust each other's certificates.
849
Trend Micro Deep Security On-Premise 20
a. Click Test Connection.
Deep Security Manager tries to resolve the hostname and connect. If that fails, an error
message appears.
If the Syslog or SIEM server certificate is not yet trusted by Deep Security Manager, the
connection fails and an Accept Server Certificate? message should appear. The
message shows the contents of the Syslog server's certificate.
b. Verify that the Syslog server's certificate is correct, and then and click OK to accept it.
The certificate is added to the manager's list of trusted certificates on Administration >
System Settings > Security. Deep Security Manager can accept self-signed
certificates.
c. Click Test Connection again.
Now the TLS connection should succeed.
7. Continue by selecting which events to forward. See "Forward system events" below and/or
"Forward security events" below.
Forward system events
Deep Security Manager generates system events (such as administrator logins or upgrading
agent software).
1. Go to Administration > System Settings > Event Forwarding.
2. From Forward System Events to a remote computer (via Syslog) using configuration,
either select an existing configuration or select New. For details, see "Define a Syslog
configuration" on page 847.
3. Click Save.
Forward security events
Deep Security Agent protection features generate security events (such as detecting malware or
triggering an IPS rule). You can forward events either:
l Directly
l Indirectly, via Deep Security Manager
Some event forwarding options require forwarding agent events indirectly, via Deep Security
Manager.
850
Trend Micro Deep Security On-Premise 20
Like other policy settings, you can override event forwarding settings for specific policies or
computers. See "Policies, inheritance, and overrides" on page 451.
1. Go to Policies.
2. Double-click the policy used by the computers.
3. Select Settings and then the Event Forwarding tab.
4. From Period between sending of events, select how often to forward events.
5. From Anti-Malware Syslog Configuration and other protection modules' drop-down
menus, either select which Syslog configuration to use, click Edit to change it, select None
to disable it, or click New. For details, see "Define a Syslog configuration" on page 847.
6. Click Save.
Troubleshoot event forwarding
"Failed to Send Syslog Message" alert
If there is a problem with your Syslog configuration, you might see this alert:
Failed to Send Syslog Message
The Deep Security Manager was unable to forward messages to a Syslog
Server.
Unable to forward messages to a Syslog Server
The alert also contains a link to the affected Syslog configuration. Click the link to open the
configuration and then click Test Connection to get more diagnostic information. It will either
indicate that the connection was successful or display an error message with more details about
the cause.
Can't edit Syslog configurations
If you can see the Syslog configurations but can't edit them, the role associated with your
account might not have the appropriate rights. An administrator who is able to configure roles
can check your permissions by going to Administration > User Management. Then select your
name and click Properties. On the Other Rights tab, the Syslog Configurations setting controls
your ability to edit Syslog configurations. For more information on users and roles, see "Add and
manage users" on page 1161.
Can't see the Syslog configuration sections of Deep Security Manager
If you can't see the Syslog configurations UI in Deep Security Manager, you may be a tenant in a
multi-tenant environment where the primary tenant has disabled this feature or configured it for
you.
851
Trend Micro Deep Security On-Premise 20
Syslog not transferred due to an expired certificate
Valid certificates are required to connect securely via TLS. If you set up TLS client authentication
and the certificate expires, messages are not sent to the Syslog server. To fix this problem, get a
new certificate, update the Syslog configuration with the new certificate values, test the
connection, and then save the configuration.
Syslog not delivered due to an expired or changed server certificate
Valid certificates are required to connect securely via TLS. If the Syslog server's certificate has
expired or changed, open the Syslog configuration and click Test Connection. You are
prompted to accept the new certificate.
Compatibility
Deep Security has been tested with the enterprise version of:
l Splunk 6.5.1
l IBM QRadar 7.2.8 Patch 3 (with the TLS protocol patch, PROTOCOL-TLSSyslog-7.2-
20170104125004.noarch)
l HP ArcSight 7.2.2 (with a TLS Syslog-NG connector created using the ArcSight-
7.2.2.7742.0-Connector tool)
Other standard Syslog software might work, but has not been verified.
Tip: If you are using Splunk, you can use the Deep Security app for Splunk to get dashboards
and saved searches.
Syslog message formats
Common Event Format (CEF) and Log Event Extended Format (LEEF) log message formats are
slightly different. For example, the "Source User" column in the GUI corresponds to a field
named "suser" in CEF; in LEEF, the same field is named "usrName" instead. Log message
fields also vary by whether the event originated on the Deep Security Agent or Manager and
which feature created the log message.
Note: If your syslog messages are being truncated, it may be because you're using User
Datagram Protocol (UDP). To prevent truncation, transfer your syslog messages over
852
Trend Micro Deep Security On-Premise 20
Transport Layer Security (TLS) instead. For instructions on switching to TLS, see "Define a
Syslog configuration" on page 847.
Note: Basic syslog format is not supported by the Anti-Malware, Web Reputation, Integrity
Monitoring, and Application Control protection modules.
If the syslog messages are sent from the manager, there are several differences. In order to
preserve the original Deep Security Agent hostname (the source of the event), a new extension
("dvc" or "dvchost") is present. "dvc" is used if the hostname is an IPv4 address; "dvchost" is
used for hostnames and IPv6 addresses. Additionally, the extension "TrendMicroDsTags" is
used if the events are tagged. (This applies only to auto-tagging with run on future, since events
are forwarded via syslog only as they are collected by the manager.) The product for logs
relayed through the manager will still read " Deep Security Agent"; however, the product version
is the version of the manager.
CEF syslog message format
All CEF events include 'dvc=IPv4 Address' or 'dvchost=Hostname' (or the IPv6 address) for the
purposes of determining the original Deep Security Agent source of the event. This extension is
important for events sent from a Deep Security Virtual Appliance or Manager, since in this case
the syslog sender of the message is not the originator of the event.
Base CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
To determine whether the log entry comes from the Deep Security Manager or a Deep Security
Agent, look at the "Device Product" field:
Sample CEF Log Entry: Jan 18 11:07:53 dsmhost CEF:0|Trend Micro|Deep Security
Manager|<DSM version>|600|Administrator Signed In|4|suser=Master...
Note: Events that occur on a VM that is protected by a virtual appliance, but that don't have an
in-guest agent, will still be identified as coming from an agent.
To further determine what kind of rule triggered the event, look at the "Signature ID" and "Name"
fields:
Sample Log Entry: Mar 19 15:19:15 root CEF:0|Trend Micro|Deep Security Agent|<DSA
version>|123|Out Of Allowed Policy|5|cn1=1...
The "Signature ID" value indicates what kind of event has been triggered:
853
Trend Micro Deep Security On-Premise 20
Signature IDs Description
10 Custom Intrusion Prevention (IPS) rule
20 Log-only Firewall rule
21 Deny Firewall rule
30 Custom Integrity Monitoring rule
40 Custom Log Inspection rule
100-7499 System events
100-199 Policy Firewall rule and Firewall stateful configuration
200-299 IPS internal errors
300-399 SSL/TLS events
500-899 IPS normalization
1,000,000-
Trend Micro IPS rule. The signature ID is the same as the IPS rule ID.
1,999,999
2,000,000- Integrity Monitoring rule. The signature ID is the Integrity Monitoring rule ID +
2,999,999 1,000,000.
3,000,000- Log Inspection rule. The signature ID is the Log Inspection rule ID +
3,999,999 2,000,000.
Anti-Malware events. Currently, only these signature IDs are used:
l 4,000,000 - Anti-Malware - Real-Time Scan
l 4,000,001 - Anti-Malware - Manual Scan
l 4,000,002 - Anti-Malware - Scheduled Scan
l 4,000,003 - Anti-Malware - Quick Scan
4,000,000- l 4,000,010 - Anti-Spyware - Real-Time Scan
4,999,999
l 4,000,011 - Anti-Spyware - Manual Scan
l 4,000,012 - Anti-Spyware - Scheduled Scan
l 4,000,013 - Anti-Spyware - Quick Scan
l 4,000,020 - Suspicious Activity - Real-Time Scan
l 4,000,030 - Unauthorized Change - Real-Time Scan
Web Reputation events. Currently, only these signature IDs are used:
5,000,000- l 5,000,000 - Web Reputation - Blocked
5,999,999
l 5,000,001 - Web Reputation - Detect Only
Application Control events. Currently, only these signature IDs are used:
6,000,000- l 6,001,100 - Application Control - Detect Only, in block list
6,999,999 l 6,001,200 - Application Control - Detect Only, not in allow list
l 6,002,100 - Application Control - Blocked, in block list
854
Trend Micro Deep Security On-Premise 20
Signature IDs Description
l 6,002,200 - Application Control – Blocked, not in allow list
Note: Log entries don't always have all CEF extensions described in the event log format
tables below. CEF extensions also may not be always in the same order. If you are using
regular expressions (regex) to parse the entries, make sure your expressions do not depend on
each key-value pair to exist, or to be in a specific order.
Note: Syslog messages are limited to 64 KB by the syslog protocol specification. If the
message is longer, data may be truncated. The basic syslog format is limited to 1 KB.
LEEF 2.0 syslog message format
Base LEEF 2.0 format: LEEF:2.0|Vendor|Product|Version|EventID|(Delimiter Character,
optional if the Delimiter Character is tab)|Extension
Sample LEEF 2.0 Log Entry (DSM System Event Log Sample): LEEF:2.0|Trend Micro|Deep
Security Manager|<DSA version>|192|cat=System name=Alert Ended desc=Alert: CPU Warning
Threshold Exceeded\nSubject: 10.201.114.164\nSeverity: Warning sev=3 src=10.201.114.164
usrName=System msg=Alert: CPUWarning Threshold Exceeded\nSubject:
10.201.114.164\nSeverity:Warning TrendMicroDsTenant=Primary
Events originating in the manager
System event log format
Base CEF Format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
Sample CEF Log Entry: CEF:0|Trend Micro|Deep Security Manager|<DSM version>|600|User
Signed In|3|src=10.52.116.160 suser=admin target=admin msg=User signed in from 2001:db8::5
Base LEEF 2.0 format: LEEF:2.0|Vendor|Product|Version|EventID|(Delimiter Character,
optional if the Delimiter Character is tab)|Extension
Sample LEEF 2.0 Log Entry: LEEF:2.0|Trend Micro|Deep Security Manager|<DSA
version>|192|cat=System name=Alert Ended desc=Alert: CPU Warning Threshold
Exceeded\nSubject: 10.201.114.164\nSeverity: Warning sev=3 src=10.201.114.164
855
Trend Micro Deep Security On-Premise 20
usrName=System msg=Alert: CPU Warning Threshold Exceeded\nSubject:
10.201.114.164\nSeverity: Warning TrendMicroDsTenant=Primary
Note: LEEF format uses a reserved "sev" key to show severity and "name" for the Name
value.
CEF Extension Field LEEF Extension Field Name Description Examples
Deep
Source IP Security
src src src=10.52.116.23
Address Manager IP
address.
Deep
Security
Source
suser usrName Manager suser=MasterAdmin
User
administrato
r's account.
The subject
of the event.
It can be the
administrator
Target account target=MasterAdmin
target target
Entity logged into target=server01
Deep
Security
Manager, or
a computer.
The
Target identifier
targetID targetID targetID=1
Entity ID added in the
manager.
Target The event
targetType targetType Entity target entity targetType=Host
Type type.
msg=User password
Details of
incorrect for username
the system
MasterAdmin on an attempt
event. May
to sign in from 127.0.0.1
msg msg Details contain a
msg=A Scan for
verbose
Recommendations on
description
computer (localhost) has
of the event.
completed...
Deep
Security
Event TrendMicroDsTags=suspici
TrendMicroDsTags TrendMicroDsTags event tags
Tags ous
assigned to
the event
TrendMicroDsTenant TrendMicroDsTenant Tenant Deep TrendMicroDsTenant=Prim
856
Trend Micro Deep Security On-Premise 20
CEF Extension Field LEEF Extension Field Name Description Examples
Security
Name ary
tenant
Deep
TrendMicroDsTenant TrendMicroDsTenant
Tenant ID Security TrendMicroDsTenantId=0
Id Id
tenant ID
Indicates the
reason ID for
event
TrendMicroDsReaso TrendMicroDsReaso Event descriptions.
TrendMicroDsReasonId=1
nId nId reason ID Each event
has its own
reason ID
definition.
The severity
of the event.
1 is the least
None sev Severity sev=3
severe; 10 is
the most
severe.
Event
None cat Category cat=System
category
None name Name Event name name=Alert Ended
Descripti Event desc:Alert: CPU Warning
None desc
on description Threshold Exceeded
Events originating in the agent
Anti-Malware event format
Base CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
Sample CEF Log Entry: CEF:0|Trend Micro|Deep Security Agent|<DSA
version>|4000000|Eicar_test_file|6|cn1=1 cn1Label=Host ID dvchost=hostname cn2=205
cn2Label=Quarantine File Size cs6=ContainerImageName | ContainerName | ContainerID
cs6Label=Container filePath=C:\\Users\\trend\\Desktop\\eicar.exe act=Delete msg=Realtime
TrendMicroDsMalwareTarget=N/A
TrendMicroDsMalwareTargetType=N/TrendMicroDsFileMD5=44D88612FEA8A8F36DE82E12
78ABB02F TrendMicroDsFileSHA1=3395856CE81F2B7382DEE72602F798B642F14140
TrendMicroDsFileSHA256=275A021BBFB6489E54D471899F7DB9D1663FC695EC2FE2A2C
4538AABF651FD0F TrendMicroDsDetectionConfidence=95
TrendMicroDsRelevantDetectionNames=Ransom_CERBER.BZC;Ransom_
CERBER.C;Ransom_CRYPNISCA.SM
857
Trend Micro Deep Security On-Premise 20
Base LEEF 2.0 format: LEEF:2.0|Vendor|Product|Version|EventID|(Delimiter Character,
optional if the Delimiter Character is tab)|Extension
Sample LEEF Log Entry: LEEF: 2.0|Trend Micro|Deep Security Agent|<DSA
version>|4000030|cat=Anti-Malware name=HEU_AEGIS_CRYPT desc=HEU_AEGIS_CRYPT
sev=6 cn1=241 cn1Label=Host ID dvc=10.0.0.1 TrendMicroDsTags=FS
TrendMicroDsTenant=Primary TrendMicroDsTenantId=0
filePath=C:\\Windows\\System32\\virus.exe act=Terminate msg=Realtime
TrendMicroDsMalwareTarget=Multiple TrendMicroDsMalwareTargetType=File System
TrendMicroDsFileMD5=1947A1BC0982C5871FA3768CD025453E#011
TrendMicroDsFileSHA1=5AD084DDCD8F80FBF2EE3F0E4F812E812DEE60C1#011
TrendMicroDsFileSHA256=25F231556700749F8F0394CAABDED83C2882317669DA2C0129
9B45173482FA6E TrendMicroDsDetectionConfidence=95
TrendMicroDsRelevantDetectionNames=Ransom_CERBER.BZC;Ransom_
CERBER.C;Ransom_CRYPNISCA.SM
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
The
agent
compu
Host ter's
cn1 cn1 Iden interna cn1=1
tifier l
unique
identifi
er.
The
name
Host label
cn1Label cn1Label cn1Label=Host ID
ID for the
field
cn1.
The
size of
the
quara
File ntine
cn2 cn2 cn2=100
Size file.
This
extens
ion is
includ
858
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
ed
only
when
the
"direct
forwar
d"
from
agent
/applia
nce is
select
ed.
The
name
File label
cn2Label cn2Label cn2Label=Quarantine File Size
Size for the
field
cn2.
The
path of
the
spywa
re
item.
Infe
This
cted
field is cs3=C:\test\atse_samples\SPYW_Test_
cs3 cs3 Res
only Virus.exe
ourc
for
e
spywa
re
detecti
on
event
s.
The
name
Infe label
cted for the
cs3Label cs3Label Res field cs3Label=Infected Resource
ourc cs3.
e This
field is
only
859
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
for
spywa
re
detecti
on
event
s.
Resou
rce
Type
value
s:
10=Fil
es and
Direct
ories
11=Sy
stem
Res Regist
ourc ry
cs4 cs4 e cs4=10
Typ 12=Int
e ernet
Cooki
es
13=Int
ernet
URL
Shortc
ut
14=Pr
ogram
s in
Memor
860
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
15=Pr
ogram
Startu
p
Areas
16=Br
owser
Helper
Object
17=La
yered
Servic
e
Provid
er
18=Ho
sts
File
19=Wi
ndows
Policy
Settin
gs
20=Br
owser
23=Wi
ndows
Shell
Settin
861
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
24=IE
Downl
oaded
Progra
m
Files
25=Ad
d/Rem
ove
Progra
ms
26=Se
rvices
other=
Other
For
examp
le, if
there's
a
spywa
re file
named
spy.ex
e that
create
sa
registr
y run
862
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
key to
keep
its
persist
ence
after
syste
m
reboot,
there
will be
two
items
in the
spywa
re
report:
the
item
for
spy.ex
e has
cs4=1
0
(Files
and
Direct
ories),
and
the
item
for the
run
key
863
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
This
field is
only
for
spywa
re
detecti
on
event
s.
The
name
label
for the
field
cs4.
Res
This
ourc
field is
cs4Label cd4Label e cs4Label=Resource Type
only
Typ
for
e
spywa
re
detecti
on
event
s.
Risk
level
value
s:
Risk
cs5 cs5 Lev 0=Ver cs5=25
el y Low
25=Lo
w
50=Me
864
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
dium
75=Hi
gh
100=V
ery
High
This
field is
only
for
spywa
re
detecti
on
event
s.
The
name
label
for the
field
cs5.
This
Risk
field is
cs5Label cs5Label Lev cs5Label=Risk Level
only
el
for
spywa
re
detecti
on
event
s.
The
Con image
cs6=ContainerImageName | ContainerName |
cs6 cs6 tain name
of the ContainerID
er
Docke
865
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
r
contai
ner,
contai
ner
name,
and
contai
ner ID
where
the
malwa
re was
detect
ed.
The
name
Con label
cs6Label cs6Label tain cs6Label=Container
er for the
field
cs6.
The
locatio
File n of
filePath filePath filePath=C:\\Users\\Mei\\Desktop\\virus.exe
Path the
malwa
re file.
The
action
perfor
med
by the
Anti-
Malwa
Acti re act=Clean
act act
on engin act=Pass
e.
Possib
le
values
are:
Deny
866
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
Acces
s,
Quara
ntine,
Delet
e,
Pass,
Clean,
Termi
nate,
and
Unspe
cified.
The
type of
scan.
Possib
le
values
Mes
are: msg=Realtime
msg msg sag
Realti msg=Scheduled
e
me,
Sched
uled,
and
Manua
l.
The
IPv4
addres
s for
cn1.
Dev Does
ice
dvc dvc dvc=10.1.144.199
addr not
ess appea
r if the
source
is an
IPv6
addres
867
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
s or
hostna
me.
(Uses
dvcho
st
instea
d.)
The
hostna
me or
IPv6
addres
s for
cn1.
Does
Dev not
ice appea
dvchost=www.example.com
dvchost dvchost host r if the
dvchost=fe80::f018:a3c6:20f9:afa6%5
nam
e source
is an
IPv4
addres
s.
(Uses
dvc
field
instea
d.)
Beh The
avio behavi
r
TrendMicroDsB TrendMicroDsB mon or
BehaviorRuleID=CS913
ehaviorRuleID ehaviorRuleID itori monito
ring
ng rule ID
rule
868
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
for
interna
l
malwa
ID
re
case
trackin
g.
The
Beh type of
avio behavi
r or
TrendMicroDsB TrendMicroDsB
Mon monito BehaviorType=Threat-Detection
ehaviorType ehaviorType
itori ring
ng event
type detect
ed.
Deep
Securi
ty
Eve event
TrendMicroDsT TrendMicroDsT
nts tags TrendMicroDsTags=suspicious
ags ags
tags assign
ed to
the
event
Ten Deep
TrendMicroDsT TrendMicroDsT ant Securi
TrendMicroDsTenant=Primary
enant enant nam ty
e tenant
Deep
Ten Securi
TrendMicroDsT TrendMicroDsT
ant ty TrendMicroDsTenantId=0
enantId enantId
ID tenant
ID
The TrendMicroDsMalwareTarget=N/A
file,
TrendMicroDsMalwareTarget=C:\\Windows\\Sys
Tar proces tem32\\cmd.exe
TrendMicroDsM TrendMicroDsM
get s, or
alwareTarget alwareTarget
(s) registr TrendMicroDsMalwareTarget=HKCU\Software\
Microsoft\Windows\CurrentVersion\Internet
y key Settings
TrendMicroDsMalwareTarget=Multiple
869
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
(if any)
that
the
malwa
re was
trying
to
affect.
If the
malwa
re was
trying
to
affect
more
than
one,
this
field
will
contai
n the
value
"Multip
le."
Only
suspic
ious
activity
monito
ring
and
unauth
orized
870
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
chang
e
monito
ring
have
values
for this
field.
The
Tar
TrendMicroDsM TrendMicroDsM numbe
get
alwareTargetCo alwareTargetCo r of TrendMicroDsMalwareTargetCount=3
cou
unt unt target
nt
files.
The
type of
syste
m
resour
ce that
this
malwa
re was
trying TrendMicroDsMalwareTargetType=N/A
Tar to TrendMicroDsMalwareTargetType=Exploit
TrendMicroDsM TrendMicroDsM
get TrendMicroDsMalwareTargetType=File System
alwareTargetTy alwareTargetTy affect,
Typ
pe pe such TrendMicroDsMalwareTargetType=Process
e
as the TrendMicroDsMalwareTargetType=Registry
file
syste
m, a
proces
s, or
Windo
ws
registr
y.
871
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
Only
suspic
ious
activity
monito
ring
and
unauth
orized
chang
e
monito
ring
have
values
for this
field.
TrendMicroDsPr TrendMicroDsPr Proce
Pro TrendMicroDsProcess= abc.exe
ocess ocess ss
cess
Name
The
File MD5
TrendMicroDsFi TrendMicroDsFil TrendMicroDsFileMD5=1947A1BC0982C5871F
MD hash
leMD5 eMD5 A3768CD025453E
5 of the
file
The
File SHA1
TrendMicroDsFi TrendMicroDsFil TrendMicroDsFileSHA1=5AD084DDCD8F80F
SH hash
leSHA1 eSHA1 BF2EE3F0E4F812E812DEE60C1
A1 of the
file
The
File SHA2
TrendMicroDsFileSHA256=25F231556700749F
TrendMicroDsFi TrendMicroDsFil SH 56
8F0394CAABDED83C2882317669DA2C01299
leSHA256 eSHA256 A25 hash
B45173482FA6E
6 of the
file
TrendMicroDsD TrendMicroDsD Thr Indicat
etectionConfide etectionConfide eat es TrendMicroDsDetectionConfidence=95
872
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
how
closel
y (in
%) the
Pro
file
nce nce babi
match
lity
ed the
malwa
re
model
Indicat
es the
most
likely
type of
threat
contai
ned in
the file
after
Predic
Pro
tive
babl
Machi
TrendMicroDsR TrendMicroDsR e TrendMicroDsRelevantDetectionNames=Ranso
ne
elevantDetectio elevantDetectio Thr m_CERBER.BZC;Ransom_
Learni
nNames nNames eat CERBER.C;Ransom_CRYPNISCA.SM
ng
Typ
compa
e
red the
analys
is to
other
known
threats
(separ
ate by
semic
olon";"
)
The
severit
Sev y of
None sev the sev=6
erity
event.
1 is
873
Trend Micro Deep Security On-Premise 20
N
Desc
CEF Extension LEEF Extension a
riptio Examples
Field Field m
n
e
the
least
sever
e; 10
is the
most
sever
e.
Cat
Categ
None cat egor cat=Anti-Malware
ory
y
Na Event
None name name=SPYWARE_KEYL_ACTIVE
me name
Event
descri
ption.
Anti-
Malwa
Des re
None desc cript uses desc=SPYWARE_KEYL_ACTIVE
ion the
event
name
as the
descri
ption.
Application Control event format
Base CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
Example CEF Log Entry: CEF: 0|Trend Micro|Deep Security
Agent|10.2.229|6001200|AppControl detectOnly|6|cn1=202 cn1Label=Host ID
dvc=192.168.33.128 TrendMicroDsTenant=Primary TrendMicroDsTenantId=0
fileHash=80D4AC182F97D2AB48EE4310AC51DA5974167C596D133D64A83107B9069745E0
suser=root suid=0 act=detectOnly
filePath=/home/user1/Desktop/Directory1//heartbeatSync.sh fsize=20
aggregationType=0 repeatCount=1 cs1=notWhitelisted cs1Label=actionReason
cs2=0CC9713BA896193A527213D9C94892D41797EB7C cs2Label=sha1
cs3=7EA8EF10BEB2E9876D4D7F7E5A46CF8D cs3Label=md5
874
Trend Micro Deep Security On-Premise 20
Base LEEF 2.0 format: LEEF:2.0|Vendor|Product|Version|EventID|(Delimiter Character,
optional if the Delimiter Character is tab)|Extension
Example LEEF Log Entry: LEEF:2.0|Trend Micro|Deep Security
Agent|10.0.2883|60|cat=AppControl name=blocked desc=blocked sev=6 cn1=2
cn1Label=Host ID dvc=10.203.156.39 TrendMicroDsTenant=Primary TrendMicroDsTenantId=0
fileHash=E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B85
5 suser=root suid=0 act=blocked filePath=/bin/my.jar fsize=123857 aggregationType=0
repeatCount=1 cs1=notWhitelisted cs1Label=actionReason
CEF LEEF
Nam Descrip
Extension Extension Examples
e tion
Field Field
The
agent
Host compute
cn1 cn1 Identif r's cn1=2
ier internal
unique
identifier.
The
name
Host
cn1Label cn1Label label for cn1Label=Host ID
ID
the field
cn1.
The
reason
why
applicati
on
control
performe
d the
specified
action,
Reas such as
cs1 cs1 "notWhit cs1=notWhitelisted
on
elisted"
(the
software
did not
have a
matching
rule, and
applicati
on
control
875
Trend Micro Deep Security On-Premise 20
CEF LEEF
Nam Descrip
Extension Extension Examples
e tion
Field Field
was
configur
ed to
block
unrecog
nized
softwar
e).
The
name
cs1Label cs1Label label for cs1Label=actionReason
the field
cs1.
If it was
calculate
d, the cs2=156F4CB711FDBD668943711F853FB6DA895
cs2 cs2
SHA-1 81AAD
hash of
the file.
The
name
cs2Label cs2Label label for cs2Label=sha1
the field
cs2.
If it was
calculate
d, the
cs3 cs3 cs3=4E8701AC951BC4537F8420FDAC7EFBB5
MD5
hash of
the file.
The
name
cs3Label cs3Label label for cs3Label=md5
the field
cs3.
The
action
performe
d by the
Applicati
act act Action on act=blocked
Control
engine.
Possible
values
876
Trend Micro Deep Security On-Premise 20
CEF LEEF
Nam Descrip
Extension Extension Examples
e tion
Field Field
are:
Blocked,
Allowed.
The IPv4
address
for cn1.
Does not
appear if
Devic the
e source is dvc=10.1.1.10
dvc dvc
addre
ss an IPv6
address
or
hostnam
e. (Uses
dvchost
instead.)
The
hostnam
e or IPv6
address
for cn1.
Does not
Devic
dvchost=www.example.com
dvchost dvchost e host appear if
dvchost=2001:db8::5
name the
source is
an IPv4
address.
(Uses
dvc field
instead.)
The
account
User ID numb
suid suid suid=0
ID er of the
user
877
Trend Micro Deep Security On-Premise 20
CEF LEEF
Nam Descrip
Extension Extension Examples
e tion
Field Field
name.
The
name of
the user
account
that
installed
User
suser suser the suser=root
Name
software
on the
protecte
d
compute
r.
Deep
Tenan
TrendMicro TrendMicro Security
t TrendMicroDsTenant=Primary
DsTenant DsTenant tenant
name
name.
Deep
TrendMicro TrendMicro Tenan Security
TrendMicroDsTenantId=0
DsTenantId DsTenantId t ID tenant ID
number.
The
SHA 256
hash that
File fileHash=E3B0C44298FC1C149AFBF4C8996FB92
fileHash fileHash identifies
hash 427AE41E4649B934CA495991B7852B855
the
software
file.
The
location
File
filePath filePath of the filePath=/bin/my.jar
Path
malware
file.
The file
File
fsize fsize size in fsize=16
Size
bytes.
An
integer
Aggre that
aggregation aggregation
gation aggregationType=2
Type Type
Type indicates
how the
event is
878
Trend Micro Deep Security On-Premise 20
CEF LEEF
Nam Descrip
Extension Extension Examples
e tion
Field Field
aggregat
ed:
l 0:
Th
e
ev
ent
is
not
ag
gre
gat
ed
l 1:
Th
e
ev
ent
is
ag
gre
gat
ed
ba
se
d
on
file
na
m
e,
pat
h,
an
879
Trend Micro Deep Security On-Premise 20
CEF LEEF
Nam Descrip
Extension Extension Examples
e tion
Field Field
d
ev
ent
typ
e.
l 2:
Th
e
ev
ent
is
ag
gre
gat
ed
ba
se
d
on
ev
ent
typ
e.
For
informati
on,
about
event
aggregat
ion, see
"View
Applicati
on
Control
880
Trend Micro Deep Security On-Premise 20
CEF LEEF
Nam Descrip
Extension Extension Examples
e tion
Field Field
event
logs" on
page 81
1.
The
number
of
occurren
ces of
the
event.
Non-
aggregat
Repe ed
repeatCount repeatCount at events repeatCount=4
Count have a
value of
1.
Aggregat
ed
events
have a
value of
2 or
more.
The
severity
of the
event. 1
Severi is the
None sev sev=6
ty least
severe;
10 is the
most
severe.
Categ
None cat Category cat=AppControl
ory
Event
None name Name name=blocked
name
Event
descripti
Descri on.
None desc desc=blocked
ption Applicati
on
881
Trend Micro Deep Security On-Premise 20
CEF LEEF
Nam Descrip
Extension Extension Examples
e tion
Field Field
Control
uses the
action as
the
descripti
on.
Firewall event log format
Base CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
Sample CEF Log Entry: CEF:0|Trend Micro|Deep Security Agent|<DSA version>|20|Log for
TCP Port 80|0|cn1=1 cn1Label=Host ID dvc=hostname act=Log dmac=00:50:56:F5:7F:47
smac=00:0C:29:EB:35:DE TrendMicroDsFrameType=IP src=192.168.126.150
dst=72.14.204.147 out=1019 cs3=DF MF cs3Label=Fragmentation Bits proto=TCP spt=49617
dpt=80 cs2=0x00 ACK PSH cs2Label=TCP Flags cnt=1 TrendMicroDsPacketData=AFB...
Sample LEEF Log Entry: LEEF:2.0|Trend Micro|Deep Security Agent|<DSA
version>|21|cat=Firewall name=Remote Domain Enforcement (Split Tunnel) desc=Remote
Domain Enforcement (Split Tunnel) sev=5 cn1=37 cn1Label=Host ID
dvchost=www.example.com TrendMicroDsTenant=Primary TrendMicroDsTenantId=0 act=Deny
dstMAC=67:BF:1B:2F:13:EE srcMAC=78:FD:E7:07:9F:2C TrendMicroDsFrameType=IP
src=10.0.110.221 dst=105.152.185.81 out=177 cs3= cs3Label=Fragmentation Bits proto=UDP
srcPort=23 dstPort=445 cnt=1 TrendMicroDsPacketData=AFB...
Descript
CEF Extension Field LEEF Extension Field Name Examples
ion
act=Log
act act Action
act=Deny
The
agent
Host computer'
cn1 cn1 cn1=113
Identifier s internal
unique
identifier.
The
name
cn1Label cn1Label Host ID label for cn1Label=Host ID
the field
cn1.
882
Trend Micro Deep Security On-Premise 20
Descript
CEF Extension Field LEEF Extension Field Name Examples
ion
The
number of
times this
Repeat event
cnt cnt cnt=8
Count was
sequentia
lly
repeated.
cs2=0x10 ACK
cs2 cs2 TCP Flags
cs2=0x14 ACK RST
The
name
cs2Label cs2Label TCP Flags label for cs2Label=TCP Flags
the field
cs2.
Packet
cs3=DF
Fragmentat
cs3 cs3 cs3=MF
ion
cs3=DF MF
Information
The
name
Fragmentat
cs3Label cs3Label label for cs3Label=Fragmentation Bits
ion Bits
the field
cs3.
(For the
ICMP
protocol
only) The
ICMP Type ICMP cs4=11 0
cs4 cs4
and Code type and cs4=8 0
code,
delimited
by a
space.
The
name
cs4Label=ICMP Type and
cs4Label cs4Label ICMP label for
Code
the field
cs4.
MAC
address
Destination of the
dmac dstMAC MAC destinatio dmac= 00:0C:29:2F:09:B3
Address n
computer'
s network
883
Trend Micro Deep Security On-Premise 20
Descript
CEF Extension Field LEEF Extension Field Name Examples
ion
interface.
(For TCP
and UDP
protocol
only) Port
number of
the
Destination dpt=80
dpt dstPort destinatio
Port dpt=135
n
computer'
s
connectio
n or
session.
IP
address
Destination of the dst=192.168.1.102
dst dst
IP Address destinatio dst=10.30.128.2
n
computer.
(For
inbound
connectio
ns only)
Inbound in=137
in in Number
Bytes Read in=21
of
inbound
bytes
read.
(For
outbound
connectio
ns only)
Outbound out=216
out out Number
Bytes Read out=13
of
outbound
bytes
read.
Name of
the proto=tcp
Transport
proto proto transport proto=udp
protocol
protocol proto=icmp
used.
Source MAC
smac srcMAC MAC address smac= 00:0E:04:2C:02:B3
Address of the
884
Trend Micro Deep Security On-Premise 20
Descript
CEF Extension Field LEEF Extension Field Name Examples
ion
source
computer'
s network
interface.
(For TCP
and UDP
protocol
only) Port
number of
the spt=1032
spt srcPort Source Port
source spt=443
computer'
s
connectio
n or
session.
The
packet's
Source IP source IP src=192.168.1.105
src src
Address address src=10.10.251.231
at this
event.
TrendMicroDsFrameType=IP
Connecti TrendMicroDsFrameType=A
on RP
TrendMicroDsFrame TrendMicroDsFrame Ethernet
ethernet
Type Type frame type
frame TrendMicroDsFrameType=R
type. evARP
TrendMicroDsFrameType=N
etBEUI
The
packet
TrendMicroDsPacket TrendMicroDsPacket data, TrendMicroDsPacketData=A
Packet data
Data Data represent FB...
ed in
Base64.
The IPv4
address
Device for cn1.
dvc dvc dvc=10.1.144.199
address
Does not
appear if
885
Trend Micro Deep Security On-Premise 20
Descript
CEF Extension Field LEEF Extension Field Name Examples
ion
the
source is
an IPv6
address
or
hostnam
e. (Uses
dvchost
instead.)
The
hostname
or IPv6
address
for cn1.
Does not
dvchost=exch01.example.co
Device host appear if
dvchost dvchost m
name
the dvchost=2001:db8::5
source is
an IPv4
address.
(Uses dvc
field
instead.)
Deep
Security
event
TrendMicroDsTags=suspicio
TrendMicroDsTags TrendMicroDsTags Event Tags tags
us
assigned
to the
event
Deep
TrendMicroDsTenan TrendMicroDsTenan Tenant TrendMicroDsTenant=Primar
Security
t t Name y
tenant
Deep
TrendMicroDsTenan TrendMicroDsTenan
Tenant ID Security TrendMicroDsTenantId=0
tId tId
tenant ID
The
None sev Severity severity sev=5
of the
886
Trend Micro Deep Security On-Premise 20
Descript
CEF Extension Field LEEF Extension Field Name Examples
ion
event. 1
is the
least
severe;
10 is the
most
severe.
None cat Category Category cat=Firewall
Event name=Remote Domain
None name Name
name Enforcement (Split Tunnel)
Event
descriptio
n.
Firewall
events
desc=Remote Domain
None desc Description use the
Enforcement (Split Tunnel)
event
name as
the
descriptio
n.
Integrity Monitoring log event format
Base CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
Sample CEF Log Entry: CEF:0|Trend Micro|Deep Security Agent|<DSA version>|30|New
Integrity Monitoring Rule|6|cn1=1 cn1Label=Host ID dvchost=hostname act=updated
filePath=c:\\windows\\message.dll suser=admin sproc=C:\\Windows\\System32\\notepad.exe
msg=lastModified,sha1,size
Base LEEF 2.0 format: LEEF:2.0|Vendor|Product|Version|EventID|(Delimiter Character,
optional if the Delimiter Character is tab)|Extension
Sample LEEF Log Entry: LEEF:2.0|Trend Micro|Deep Security Agent|<DSA
version>|2002779|cat=Integrity Monitor name=Microsoft Windows - System file modified
desc=Microsoft Windows - System file modified sev=8 cn1=37 cn1Label=Host ID
dvchost=www.example.com TrendMicroDsTenant=Primary TrendMicroDsTenantId=0
act=updated suser=admin sproc=C:\\Windows\\System32\\notepad.exe
887
Trend Micro Deep Security On-Premise 20
CEF Extension LEEF Extension Descripti
Name Examples
Field Field on
The action
detected
by the
integrity
rule. Can act=created
act act Action
contain: act=deleted
created,
updated,
deleted or
renamed.
The agent
computer's
Host
cn1 cn1 internal cn1=113
Identifier
unique
identifier.
The name
label for
cn1Label cn1Label Host ID cn1Label=Host ID
the field
cn1.
The
integrity
rule target
entity. May
Target contain a filePath=C:\WINDOWS\system32\driv
filePath filePath
Entity file or ers\etc\hosts
directory
path,
registry
key, etc.
Deep
Security
Source Manager
suser suser suser=MasterAdmin
User administrat
or's
account.
The name
of the
Source sproc=C:\\Windows\\System32\\notep
sproc sproc event's
Process ad.exe
source
process.
(For
"renamed"
Attribute action
msg msg msg=lastModified,sha1,size
changes only) A list
of changed
attribute
888
Trend Micro Deep Security On-Premise 20
CEF Extension LEEF Extension Descripti
Name Examples
Field Field on
names.
If "Relay
via
Manager"
is
selected,
all event
action
types
include a
full
descriptio
n.
(For
"renamed"
action
only) The
previous
integrity
rule target
entity to
capture the
Old rename
oldFilePath=C:\WINDOWS\system32\l
oldfilePath oldfilePath target action from
ogfiles\ds_agent.log
entity the
previous
target
entity to
the new,
which is
recorded
in the
filePath
field.
The IPv4
address for
cn1.
Does not
Device
dvc dvc dvc=10.1.144.199
address appear if
the source
is an IPv6
address or
hostname.
889
Trend Micro Deep Security On-Premise 20
CEF Extension LEEF Extension Descripti
Name Examples
Field Field on
(Uses
dvchost
instead.)
The
hostname
or IPv6
address for
cn1.
Device Does not
dvchost=www.example.com
dvchost dvchost host appear if dvchost=2001:db8::5
name
the source
is an IPv4
address.
(Uses dvc
field
instead.)
Deep
Security
TrendMicroDsTa TrendMicroDsTa Events event tags
TrendMicroDsTags=suspicious
gs gs tags assigned
to the
event
Deep
TrendMicroDsTe TrendMicroDsTe Tenant
Security TrendMicroDsTenant=Primary
nant nant name
tenant
Deep
TrendMicroDsTe TrendMicroDsTe Tenant
Security TrendMicroDsTenantId=0
nantId nantId ID
tenant ID
The
severity of
the event.
1 is the
None sev Severity sev=8
least
severe; 10
is the most
severe.
Categor
None cat Category cat=Integrity Monitor
y
Event name=Microsoft Windows - System
None name Name
name file modified
890
Trend Micro Deep Security On-Premise 20
CEF Extension LEEF Extension Descripti
Name Examples
Field Field on
Event
descriptio
n. Integrity
Monitoring
Descript uses the desc=Microsoft Windows - System file
None desc
ion event modified
name as
the
descriptio
n.
Intrusion Prevention event log format
Base CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
Sample CEF Log Entry: CEF:0|Trend Micro|Deep Security Agent|<DSA version>|1001111|Test
Intrusion Prevention Rule|3|cn1=1 cn1Label=Host ID dvchost=hostname
dmac=00:50:56:F5:7F:47 smac=00:0C:29:EB:35:DE TrendMicroDsFrameType=IP
src=192.168.126.150 dst=72.14.204.105 out=1093 cs3=DF MF cs3Label=Fragmentation Bits
proto=TCP spt=49786 dpt=80 cs2=0x00 ACK PSH cs2Label=TCP Flags cnt=1 act=IDS:Reset
cn3=10 cn3Label=Intrusion Prevention Packet Position cs5=10 cs5Label=Intrusion Prevention
Stream Position cs6=8 cs6Label=Intrusion Prevention Flags
TrendMicroDsPacketData=R0VUIC9zP3...
Base LEEF 2.0 format: LEEF:2.0|Vendor|Product|Version|EventID|(Delimiter Character,
optional if the Delimiter Character is tab)|Extension
Sample LEEF Log Entry: LEEF:2.0|Trend Micro|Deep Security Agent|<DSA
version>|1000940|cat=Intrusion Prevention name=Sun Java RunTime Environment Multiple
Buffer Overflow Vulnerabilities desc=Sun Java RunTime Environment Multiple Buffer Overflow
Vulnerabilities sev=10 cn1=6 cn1Label=Host ID dvchost=exch01 TrendMicroDsTenant=Primary
TrendMicroDsTenantId=0 dstMAC=55:C0:A8:55:FF:41 srcMAC=CA:36:42:B1:78:3D
TrendMicroDsFrameType=IP src=10.0.251.84 dst=56.19.41.128 out=166 cs3=
cs3Label=Fragmentation Bits proto=ICMP srcPort=0 dstPort=0 cnt=1 act=IDS:Reset cn3=0
cn3Label=DPI Packet Position cs5=0 cs5Label=DPI Stream Position cs6=0 cs6Label=DPI
Flags TrendMicroDsPacketData=R0VUIC9zP3...
891
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
(IPS rules
written
before
Deep
Security
version
7.5 SP1
could
additional
ly perform
Insert,
Replace,
and
Delete
actions.
These
actions
are no
longer
act act Action performe act=Block
d. If an
older IPS
Rule is
triggered
which still
attempts
to
perform
those
actions,
the event
will
indicate
that the
rule was
applied in
detect-
only
mode.)
The
agent
Host computer'
cn1 cn1 cn1=113
Identifier s internal
unique
identifier.
The
cn1Label cn1Label Host ID name cn1Label=Host ID
892
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
label for
the field
cn1.
Position
Intrusion within
Prevention packet of
cn3 cn3 cn3=37
Packet data that
Position triggered
the event.
The
Intrusion
name
Prevention cn3Label=Intrusion Prevention
cn3Label cn3Label label for
Packet Packet Position
the field
Position
cn3.
The
number
of times
Repeat this event
cnt cnt cnt=8
Count was
sequentia
lly
repeated.
(Optional)
A note
field
which
can
contain a
short
binary or
text note
associate
d with the
Intrusion payload
cs1 cs1 Prevention file. If the cs1=Drop_data
Filter Note value of
the note
field is all
printable
ASCII
character
s, it will
be
logged as
text with
spaces
893
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
converted
to
undersco
res. If it
contains
binary
data, it
will be
logged
using
Base-64
encoding.
The
Intrusion name
cs1Label=Intrusion Prevention
cs1Label cs1Label Prevention label for
Note
Note the field
cs1.
(For the
TCP
protocol
only) The
raw TCP
flag byte
followed
by the
URG,
cs2=0x10 ACK
cs2 cs2 TCP Flags ACK,
cs2=0x14 ACK RST
PSH,
RST,
SYN and
FIN fields
may be
present if
the TCP
header
was set.
The
name
cs2Label cs2Label TCP Flags label for cs2Label=TCP Flags
the field
cs2.
Packet
cs3=DF
Fragmenta
cs3 cs3 cs3=MF
tion
cs3=DF MF
Information
cs3Label cs3Label Fragmenta The cs3Label=Fragmentation Bits
894
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
name
label for
tion Bits
the field
cs3.
(For the
ICMP
protocol
only) The
ICMP
type and
ICMP
code cs4=11 0
cs4 cs4 Type and
stored in cs4=8 0
Code
their
respectiv
e order
delimited
by a
space.
The
name
cs4Label cs4Label ICMP label for cs4Label=ICMP Type and Code
the field
cs4.
Position
Intrusion within
Prevention stream of cs5=128
cs5 cs5
Stream data that cs5=20
Position triggered
the event.
The
Intrusion
name
Prevention cs5Label=Intrusion Prevention
cs5Label cs5Label label for
Stream Stream Position
the field
Position
cs5.
A
combined
value that
includes
Intrusion the sum The following example would be
Prevention of the flag a summed combination of 1
cs6 cs6 values: (Data truncated) and 8 (Have
Filter
Data):
Flags
1 - Data cs6=9
truncated
- Data
895
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
could not
be
logged.
2 - Log
Overflow
- Log
overflowe
d after
this log.
4-
Suppress
ed - Logs
threshold
suppress
ed after
this log.
8 - Have
Data -
Contains
packet
data
16 -
Referenc
e Data -
Referenc
es
previousl
y logged
data.
The
Intrusion name
cs6=Intrusion Prevention Filter
cs6Label cs6Label Prevention label for
Flags
Flags the field
cs6.
Destinati
on
Destinatio computer
dmac dstMAC n MAC network dmac= 00:0C:29:2F:09:B3
Address interface
MAC
address.
(For TCP
and UDP
Destinatio protocol dpt=80
dpt dstPort only)
n Port dpt=135
Destinati
on
896
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
computer
connectio
n port.
Destinati
Destinatio on
dst=192.168.1.102
dst dst n IP computer
dst=10.30.128.2
Address IP
Address.
The
IP addres
s of the
last hub
in the X-
Forwarde
d-For
header.
This is
typically
originatin
g IP
address,
beyond
the proxy
that may
exist. See
X-
also the
xff xff Forwarde xff=192.168.137.1
src field.
d-For
To
include
xff in
events,
enable
the
"1006540
- Enable
X-
Forwarde
d-For
HTTP
Header
Logging"
Intrusion
Preventio
n rule.
Inbound (For
in=137
in in Bytes inbound in=21
Read
897
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
connectio
ns only)
Number
of
inbound
bytes
read.
(For
outbound
connectio
Outbound ns only)
out=216
out out Bytes Number
out=13
Read of
outbound
bytes
read.
Name of
the
connectio proto=tcp
Transport
proto proto n proto=udp
protocol
transport proto=icmp
protocol
used.
Source
computer
Source
network
smac srcMAC MAC smac= 00:0E:04:2C:02:B3
interface
Address
MAC
address.
(For TCP
and UDP
protocol
Source only) spt=1032
spt srcPort
Port Source spt=443
computer
connectio
n port.
Source
computer
IP
Address.
Source IP This is src=192.168.1.105
src src
Address the IP of src=10.10.251.231
the last
proxy
server, if
898
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
it exists,
or the
client IP.
See also
the xff
field.
TrendMicroDsFrameType=IP
TrendMicroDsFrameType=ARP
Connecti
on
TrendMicroDsFram TrendMicroDsFram Ethernet
ethernet TrendMicroDsFrameType=RevA
eType eType frame type
frame RP
type.
TrendMicroDsFrameType=NetB
EUI
The
packet
TrendMicroDsPack TrendMicroDsPack Packet data, TrendMicroDsPacketData=R0V
etData etData data represent UIC9zP3...
ed in
Base64.
The IPv4
address
for cn1.
Does not
appear if
the
Device source is dvc=10.1.144.199
dvc dvc
address
an IPv6
address
or
hostnam
e. (Uses
dvchost
instead.)
The
hostname
Device dvchost=www.example.com
dvchost dvchost
host name or IPv6 dvchost=2001:db8::5
address
for cn1.
899
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
Does not
appear if
the
source is
an IPv4
address.
(Uses
dvc field
instead.)
Deep
Security
event
TrendMicroDsTags TrendMicroDsTags Event tags tags TrendMicroDsTags=Suspicious
assigned
to the
event
Deep
TrendMicroDsTena TrendMicroDsTena Tenant Security
TrendMicroDsTenant=Primary
nt nt name tenant
name
Deep
TrendMicroDsTena TrendMicroDsTena
Tenant ID Security TrendMicroDsTenantId=0
ntId ntId
tenant ID
The
severity
of the
event. 1
is the
None sev Severity sev=10
least
severe;
10 is the
most
severe.
None cat Category Category cat=Intrusion Prevention
name=Sun Java RunTime
Event
None name Name Environment Multiple Buffer
name
Overflow Vulnerabilities
Event
descriptio
desc=Sun Java RunTime
Descriptio n.
None desc Intrusion Environment Multiple Buffer
n
Preventio Overflow Vulnerabilities
n events
900
Trend Micro Deep Security On-Premise 20
LEEF Extension Descript
CEF Extension Field Name Examples
Field ion
use the
event
name as
the
descriptio
n.
Log Inspection event format
Base CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
Sample CEF Log Entry: CEF:0|Trend Micro|Deep Security Agent|<DSA
version>|3002795|Microsoft Windows Events|8|cn1=1 cn1Label=Host ID dvchost=hostname
cs1Label=LI Description cs1=Multiple Windows Logon Failures fname=Security src=127.0.0.1
duser=(no user) shost=WIN-RM6HM42G65V msg=WinEvtLog Security: AUDIT_FAILURE
(4625): Microsoft-Windows-Security-Auditing: (no user): no domain: WIN-RM6HM42G65V: An
account failed to log on. Subject: ..
Base LEEF 2.0 format: LEEF:2.0|Vendor|Product|Version|EventID|(Delimiter Character,
optional if the Delimiter Character is tab)|Extension
Sample LEEF Log Entry: LEEF:2.0|Trend Micro|Deep Security Agent|<DSA
version>|3003486|cat=Log Inspection name=Mail Server - MDaemon desc=Server Shutdown.
sev=3 cn1=37 cn1Label=Host ID dvchost=exch01.example.com TrendMicroDsTenant=Primary
TrendMicroDsTenantId=0 cs1=Server Shutdown. cs1Label=LI Description fname= shost= msg=
Descriptio
CEF Extension Field LEEF Extension Field Name Examples
n
The agent
computer's
Host
cn1 cn1 internal cn1=113
Identifier
unique
identifier.
The name
label for
cn1Label cn1Label Host ID cn1Label=Host ID
the field
cn1.
The Log
Inspection
Specific sub-rule cs1=Multiple Windows audit
cs1 cs1
Sub-Rule which failure events
triggered
901
Trend Micro Deep Security On-Premise 20
Descriptio
CEF Extension Field LEEF Extension Field Name Examples
n
this event.
The name
LI
label for
cs1Label cs1Label Descriptio cs1Label=LI Description
the field
n
cs1.
(If parse-
able
username
exists) The
User duser=(no user)
name of
duser duser Informatio duser=NETWORK
the target
n SERVICE
user
initiated
the log
entry.
The Log
Inspection
rule target
entity. May
fname=Application
Target contain a
fname fname fname=C:\Program
entity file or
Files\CMS\logs\server0.log
directory
path,
registry
key, etc.
Details of
the Log
Inspection msg=WinEvtLog:
event. May Application: AUDIT_
contain a FAILURE(20187): pgEvent:
msg msg Details
verbose (no user): no domain:
description SERVER01: Remote login
of the failure for user 'xyz'
detected
log event.
Source
Source shost=webserver01.corp.co
shost shost computer
Hostname m
hostname.
Source
Source IP src=192.168.1.105
src src computer
Address src=10.10.251.231
IP address.
The IPv4
Device
dvc dvc address for dvc=10.1.144.199
address
cn1.
902
Trend Micro Deep Security On-Premise 20
Descriptio
CEF Extension Field LEEF Extension Field Name Examples
n
Does not
appear if
the source
is an IPv6
address or
hostname.
(Uses
dvchost
instead.)
The
hostname
or IPv6
address for
cn1.
Device Does not dvchost=www.example.com
dvchost dvchost
host name appear if dvchost=2001:db8::5
the source
is an IPv4
address.
(Uses dvc
field
instead.)
Deep
Security
Events event tags TrendMicroDsTags=suspicio
TrendMicroDsTags TrendMicroDsTags
tags assigned us
to the
event
Deep
Tenant TrendMicroDsTenant=Prima
TrendMicroDsTenant TrendMicroDsTenant Security
name ry
tenant
Deep
TrendMicroDsTenant TrendMicroDsTenant
Tenant ID Security TrendMicroDsTenantId=0
Id Id
tenant ID
The
severity of
None sev Severity the event. sev=3
1 is the
least
903
Trend Micro Deep Security On-Premise 20
Descriptio
CEF Extension Field LEEF Extension Field Name Examples
n
severe; 10
is the most
severe.
None cat Category Category cat=Log Inspection
Event name=Mail Server -
None name Name
name MDaemon
Event
Descriptio
None desc descriptio desc=Server Shutdown
n
n.
Web Reputation event format
Base CEF format: CEF:Version|Device Vendor|Device Product|Device Version|Signature
ID|Name|Severity|Extension
Sample CEF Log Entry: CEF:0|Trend Micro|Deep Security Agent|<DSA
version>|5000000|WebReputation|5|cn1=1 cn1Label=Host ID dvchost=hostname
request=example.com msg=Blocked By Admin
Base LEEF 2.0 format: LEEF:2.0|Vendor|Product|Version|EventID|(Delimiter Character,
optional if the Delimiter Character is tab)|Extension
Sample LEEF Log Entry: LEEF:2.0|Trend Micro|Deep Security Agent|<DSA
version>|5000000|cat=Web Reputation name=WebReputation desc=WebReputation sev=6
cn1=3 cn1Label=Host ID dvchost=exch01.example.com TrendMicroDsTenant=Primary
TrendMicroDsTenantId=0 request=http://yw.olx5x9ny.org.it/HvuauRH/eighgSS.htm
msg=Suspicious
CEF Extension LEEF Extension Descripti
Name Examples
Field Field on
The agent
computer'
Host
cn1 cn1 s internal cn1=1
Identifier
unique
identifier.
The name
label for
cn1Label cn1Label Host ID cn1Label=Host ID
the field
cn1.
The URL
request=http://www.example.com/in
request request Request of the
dex.php
request.
msg msg Message The type msg=Realtime
904
Trend Micro Deep Security On-Premise 20
CEF Extension LEEF Extension Descripti
Name Examples
Field Field on
of action.
Possible
values
are:
msg=Scheduled
Realtime,
Schedule
d, and
Manual.
The IPv4
address
for cn1.
Does not
appear if
the
Device source is
dvc dvc dvc=10.1.144.199
address
an IPv6
address
or
hostnam
e. (Uses
dvchost
instead.)
The
hostname
or IPv6
address
for cn1.
Does not
Device
dvchost dvchost host appear if dvchost=www.example.com
dvchost=2001:db8::5
name the
source is
an IPv4
address.
(Uses dvc
field
instead.)
TrendMicroDsTag TrendMicroDsTag Events Deep TrendMicroDsTags=suspicious
905
Trend Micro Deep Security On-Premise 20
CEF Extension LEEF Extension Descripti
Name Examples
Field Field on
Security
event
tags
s s tags
assigned
to the
event
Deep
TrendMicroDsTen TrendMicroDsTen Tenant
Security TrendMicroDsTenant=Primary
ant ant name
tenant
Deep
TrendMicroDsTen TrendMicroDsTen Tenant
Security TrendMicroDsTenantId=0
antId antId ID
tenant ID
The
severity of
the event.
1 is the
None sev Severity least sev=6
severe;
10 is the
most
severe.
None cat Category Category cat=Web Reputation
Event
None name Name name=WebReputation
name
Event
descriptio
n. Web
Reputatio
Descripti n uses
None desc desc=WebReputation
on the event
name as
the
descriptio
n.
Configure Red Hat Enterprise Linux to receive event logs
Set up a Syslog on Red Hat Enterprise Linux 6 or 7
The following steps describe how to configure rsyslog on Red Hat Enterprise Linux 6 or 7 to
receive logs from Deep Security.
906
Trend Micro Deep Security On-Premise 20
1. Log in as root
2. Execute:
vi /etc/rsyslog.conf
3. Uncomment the following lines near the top of the rsyslog.conf to change them from:
#$ModLoad imudp
#$UDPServerRun 514
#$ModLoad imtcp
#$InputTCPServerRun 514
to
$ModLoad imudp
$UDPServerRun 514
$ModLoad imtcp
$InputTCPServerRun 514
4. Add the following two lines of text to the end of the rsyslog.conf:
l #Save Deep Security Manager logs to DSM.log
l Local4.* /var/log/DSM.log
Note: You may need to replace Local4 with another value, depending on your Manager
settings.
5. Save the file and exit
6. Create the /var/log/DSM.log file by typing touch /var/log/DSM.log
7. Set the permissions on the DSM log so that syslog can write to it
8. Save the file and exit
9. Restart syslog:
l On Red Hat Enterprise Linux 6: service rsyslog restart
l On Red Hat Enterprise Linux 7: systemctl restart rsyslog
When Syslog is functioning you will see logs populated in: /var/log/DSM.log
Set up a Syslog on Red Hat Enterprise Linux 5
The following steps describe how to configure Syslog on Red Hat Enterprise Linux to receive
logs from Deep Security.
907
Trend Micro Deep Security On-Premise 20
1. Log in as root
2. Execute:
vi /etc/syslog.conf
3. Add the following two lines of text to the end of the syslog.conf :
l #Save Deep Security Manager logs to DSM.log
l Local4.* /var/log/DSM.log
Note: You may need to replace Local4 with another value, depending on your Manager
settings.
4. Save the file and exit
5. Create the /var/log/DSM.log file by typing touch /var/log/DSM.log
6. Set the permissions on the DSM log so that syslog can write to it
7. Execute:
vi /etc/sysconfig/syslog
8. Modify the line " SYSLOGD_OPTIONS " and add a " -r " to the options
9. Save the file and exit
10. Restart syslog: /etc/init.d/syslog restart
When Syslog is functioning you will see logs populated in: /var/log/DSM.log
Access events with Amazon SNS
Set up Amazon SNS
If you have an AWS account, you can take advantage of the Amazon Simple Notification Service
(SNS) to publish notifications about Deep Security events and deliver them to subscribers. For
details about SNS, see https://aws.amazon.com/sns/.
To set up Amazon SNS:
1. "Create an AWS user" on the next page.
2. "Create an Amazon SNS topic" on the next page.
3. "Enable SNS" on the next page.
4. "Create subscriptions" on page 910.
See the sections below for details on how to perform these tasks.
908
Trend Micro Deep Security On-Premise 20
Create an AWS user
In order to use Amazon SNS with Deep Security, you need to create an AWS user with the
appropriate permissions for SNS. Note the access key and secret key for the user, because you
will need that information for step 3, below.
The AWS user will need the "sns:Publish" permission on all SNS topics that Deep Security will
publish to. This is an example of a policy with this permission:
{
"Version": "2012-10-17",
"Statement": [
{
"Action": [
"sns:Publish"
],
"Effect": "Allow",
"Resource": "*"
}
]
}
If you want to limit publishing rights to a single topic, you can replace "Resource":"*" with
"Resource":"TOPIC ARN".
For more information, see Controlling User Access to Your AWS Account and Special
Information for Amazon SNS Policies in the Amazon AWS documentation.
Create an Amazon SNS topic
In AWS, create an SNS topic where the events will be published. For instructions on how to
create an Amazon SNS topic, see "Create a Topic" in the Amazon SNS documentation. Note
the SNS Topic ARN because you will need this information in step 3, below.
Enable SNS
1. In the Deep Security Manager, go to Administration > System Settings > Event
Forwarding.
2. In the Amazon SNS section, select Publish Events to Amazon Simple Notification
Service.
909
Trend Micro Deep Security On-Premise 20
3. Enter this information:
l Access Key: The access key of the AWS user you created in section 1.
l Secret Key: The secret key of the AWS user you created in section 1.
l SNS Topic ARN: The SNS Topic ARN that events will be sent to. This is the ARN that
you noted in section 2.
4. Select the types of events that you want to forward to SNS.
Selecting the events automatically generates a JSON SNS configuration.
5. (Optional) You can also click Edit JSON SNS configuration to edit the JSON SNS
configuration directly if you want to filter the events in greater detail and configure the
forwarding instructions for each filter. For details on the configuration language, see "SNS
configuration in JSON format" below.
Note: If you edit the JSON, the event check boxes will become unavailable. If you want to
select or deselect any of the event check boxes, you can click Revert to basic SNS
configuration, but any customizations you have made to the JSON SNS configuration will
be discarded.
6. Click Save.
Create subscriptions
Now that SNS is enabled and events are being published to the topic, go to the Amazon SNS
console and subscribe to the topic to access the events. There are several ways that you can
subscribe to events, including email, SMS, and Lambda endpoints.
Note: Lambda is not available in all AWS regions.
SNS configuration in JSON format
You can edit the JSON configuration that is used when you have enabled event forwarding to
Amazon SNS topics. It defines which conditions an event must meet in order to be published to
a topic. The configuration language is modeled after Amazon's Policy language for SNS.
Each field is specified below. Basic SNS configuration looks like:
{
"Version": "2014-09-24",
"Statement": [statement1, statement2, ...]
910
Trend Micro Deep Security On-Premise 20
For examples, see "Example SNS configurations" on page 925.
Version
The Version element specifies the version of the configuration language.
Note: The only currently valid value of "Version" is the string "2014-09-24".
"Version": "2014-09-24",
Statement
The Statement element is an array of individual statements. Each individual statement is a
distinct JSON object giving the SNS topic to send to if an event meets given conditions.
"Statement": [{...}, {...}, ...]
An individual statement has the form:
{
"Topic": "destination topic",
"Condition": {conditions event must meet to be published to the
destination topic}
}
Topic
The Topic element must be the Amazon Resource Name of the SNS Topic to publish to.
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic"
911
Trend Micro Deep Security On-Premise 20
Condition
The Condition element is the most complex part of the configuration. It contains one or more
conditions an event must match in order to be published to the topic.
Each condition can have one or more key-value pairs that the event must match (or not match,
depending on the type of condition) to be included in the topic. Keys are any valid event
property. (For event properties, see "Events in JSON format" on page 926). Valid values vary by
key. Some keys support multiple values.
"Condition": {
"ConditionName": {
"key1": [value1, value2],
"key2": value3
},
"ConditionName2": {
"key3": [value4]
},
...
}
Valid condition names and their syntax are described below.
Bool
The Bool condition performs Boolean matching. To match, an event must have a property with
the desired Boolean value. If the property in the event exists but is not itself a Boolean value, the
property is tested as follows:
l Numbers equal to 0 evaluate to false. Numbers not equal to 0 evaluate to true.
l Empty strings and the special strings "false" and "0" evaluate to false. Other strings
evaluate to true.
l Any other property value in an event cannot be converted to a Boolean and will not match.
Allows for multiple values? No
The following example shows a configuration that publishes events that have a "DetectOnly"
property with a value false:
912
Trend Micro Deep Security On-Premise 20
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"Bool": {
"DetectOnly": false
}
}
}
]
}
Exists
The Exists condition tests for the existence or non-existence of a property in an event. The value
of the property is not considered.
Allows for multiple values? No
The following example shows a configuration that publishes events when the event has the
property "Severity" but does not have the property "Title":
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"Exists": {
"Severity": true,
"Title": false
}
}
913
Trend Micro Deep Security On-Premise 20
}
]
}
IpAddress
The IpAddress condition tests the value of an event's property is an IP address in a range given
in CIDR format, or exactly equals a single IP address.
Allows for multiple values? Yes
The following example shows a configuration that publishes events when the event has the
property "DestinationIP" with an IP address in the range 10.0.1.0/24, or to 10.0.0.5:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"IpAddress": {
"DestinationIP": ["10.0.1.0/24", "10.0.0.5"]
}
}
}
]
}
NotIpAddress
The NotIpAddress condition tests the value of an event's property is not an IP address in any of
the specified IP address ranges.
Allows for multiple values? Yes
914
Trend Micro Deep Security On-Premise 20
The following example shows a configuration that publishes events when the event has the
property "DestinationIP" with an IP address not in the range 10.0.0.0/8:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"NotIpAddress": {
"DestinationIP": "10.0.0.0/8"
}
}
}
]
}
NumericEquals
The NumericEquals condition tests the numeric value of an event's property equals one or more
desired values. If the property in the event exists but is not itself a numeric value, the property is
tested as follows:
l Strings are converted to numbers. Strings that cannot be converted to numbers will not
match.
l Any other property value in an event cannot be converted to a number and will not match.
Allows for multiple values? Yes
The following example shows a configuration that publishes events when the event has the
property "Protocol" with the value 6 or 17:
{
"Version": "2014-09-24",
"Statement": [
{
915
Trend Micro Deep Security On-Premise 20
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"NumericEquals": {
"Protocol": [6, 17]
}
}
}
]
}
NumericNotEquals
The NumericNotEquals condition tests the numeric value of an event's property is not equal to
any one of an undesired set of values.
Allows for multiple values? Yes
The following example shows a configuration that publishes events when the event has the
property "Protocol" not equal to 6, and the property "Risk" not equal to 2 or 3:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"NumericNotEquals": {
"Protocol": 6,
"Risk" : [2, 3]
}
}
}
]
}
916
Trend Micro Deep Security On-Premise 20
NumericGreaterThan
The NumericGreaterThan condition tests the numeric value of an event's property is strictly
greater than a desired value. If the property in the event exists but is not itself a numeric value it
is converted to a number as described for NumericEquals.
Allows for multiple values? No
The following example shows a configuration that publishes events when the event has the
property "Protocol" with the value greater than 6:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"NumericGreaterThan": {
"Protocol": 6
}
}
}
]
}
NumericGreaterThanEquals
The NumericGreaterThanEquals condition tests the numeric value of an event's property is
greater than or equal to a desired value. If the property in the event exists but is not itself a
numeric value it is converted to a number as described for NumericEquals.
Allows for multiple values? No
The following example shows a configuration that publishes events when the event has the
property "Number" with a value greater than or equal to 600:
{
"Version": "2014-09-24",
917
Trend Micro Deep Security On-Premise 20
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"NumericGreaterThanEquals": {
"Number": 600
}
}
}
]
}
NumericLessThan
The NumericLessThan condition tests the numeric value of an event's property is strictly less
than a desired value. If the property in the event exists but is not itself a numeric value it is
converted to a number as described for NumericEquals.
Allows for multiple values? No
The following example shows a configuration that publishes events when the event has the
property "Number" with a value greater than 1000:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"NumericLessThan": {
"Number": 1000
}
}
}
]
918
Trend Micro Deep Security On-Premise 20
NumericLessThanEquals
The NumericLessThanEquals condition tests the numeric value of an event's property is less
than or equal to a desired value. If the property in the event exists but is not itself a numeric value
it is converted to a number as described for NumericEquals.
Allows for multiple values? No
The following example shows a configuration that publishes events when the event has the
property "Number" with a value less than or equal to 500:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"NumericLessThanEquals": {
"Number": 500
}
}
}
]
}
StringEquals
The StringEquals condition tests the string value of an event's property is strictly equal to or
more desired values.
Allows for multiple values? Yes
919
Trend Micro Deep Security On-Premise 20
The following example shows a configuration that publishes events when the event has the
property "EventType" equal to "SystemEvent" and property "TargetType" equal to "User" or
"Role":
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"StringEquals": {
"EventType": ["SystemEvent"],
"TargetType" : ["User", "Role"]
}
}
}
]
}
StringNotEquals
The StringNotEquals condition tests the string value of an event's property does not equal any
of an undesired set of values.
Allows for multiple values? Yes
The following example shows a configuration that publishes events when the event has the
property "EventType" not equal to "PacketLog" or "IntegrityEvent":
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"StringNotEquals": {
920
Trend Micro Deep Security On-Premise 20
"EventType": ["PacketLog", "IntegrityEvent"]
}
}
}
]
}
StringEqualsIgnoreCase
The StringEqualsIgnoreCase condition is the same as the StringEquals condition, except string
matching is performed in a case-insensitive manner.
StringNotEqualsIgnoreCase
The StringNotEqualsIgnoreCase condition is the same as the StringNotEquals condition,
except string matching is performed in a case-insensitive manner.
StringLike
The StringLike condition tests the string value of an event's property is equal to or more desired
values, where the desired values may include the wildcard '*' to match any number of characters
or '?' to match a single character. String comparisons are case-sensitive.
Allows for multiple values? Yes
The following example shows a configuration that publishes events when the event has the
property "Title" which contains the string "User" or "Role":
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"StringLike": {
"Title": ["*User*", "*Role*"]
921
Trend Micro Deep Security On-Premise 20
}
}
}
]
}
StringNotLike
The StringNotLike condition tests that the string value of an event's property is not equal to any
of an undesired set of values, where the values may include the wildcard '*' to match any number
of characters or '?' to match a single character. String comparisons are case-sensitive.
Allows for multiple values? Yes
The following example shows a configuration that publishes all events except the "System
Settings Saved" event:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"StringNotLike": {
"Title":"System Settings Saved"
}
}
}
]
}
The next example shows a configuration that publishes events when the event has the property
"Title" that does not start with "User" and does not end with "Created":
922
Trend Micro Deep Security On-Premise 20
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"StringNotLike": {
"Title": ["User*", "*Created"]
}
}
}
]
}
Multiple statements vs. multiple conditions
If you create multiple statements for the same SNS topic, those statements are evaluated as if
they are joined by "or". If a statement contains multiple conditions, those conditions are
evaluated as if they are joined by "and".
Multiple statements
This is an example of what not to do. The first statement says to forward all events other than
"System Settings Saved". The second statement says to forward all "System Settings Saved"
events. The result is that all events will be forwarded because any event will match either the
condition in the first statement or the one in the second statement:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"StringNotLike" : {
"Title" : "System Settings Saved"
}
923
Trend Micro Deep Security On-Premise 20
}
},
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"StringLike" : {
"Title" : "System Settings Saved"
}
}
}
]
}
Multiple conditions
This is another example of what not to do. The first condition says to forward all events other
than "System Settings Saved". The second condition says to forward all "System Settings
Saved" events. The result is that no events will be forwarded because no events will match both
the condition in the first statement and the one in the second statement:
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"StringNotLike" : {
"Title" : "System Settings Saved"
},
"StringLike" : {
"Title" : "System Settings Saved"
}
}
}
924
Trend Micro Deep Security On-Premise 20
]
}
Example SNS configurations
These configurations send matching events for some specific scenarios. For more event
property names and values that you can use to filter SNS topics, see "Events in JSON format" on
the next page.
Send all critical intrusion prevention events to an SNS topic
{
"Version": "2014-09-24",
"Statement": [
{
"Topic": "arn:aws:sns:us-east-1:012345678901:myTopic",
"Condition": {
"NumericEquals": {
"Severity": 4
},
"StringEquals" : {
"EventType" : "PayloadLog"
}
}
}
]
}
Send different events to different SNS topics
This example shows sending all system events to one topic and all integrity monitoring events to
a different topic.
{
"Version": "2014-09-24",
"Statement": [
925
Trend Micro Deep Security On-Premise 20
{
"Topic": "arn:aws:sns:us-east-
1:012345678901:systemEventsTopic",
"Condition": {
"StringEquals" : {
"EventType" : "SystemEvent"
}
}
},
{
"Topic": "arn:aws:sns:us-east-
1:012345678901:integrityTopic",
"Condition": {
"StringEquals" : {
"EventType" : "IntegrityEvent"
}
}
}
]
}
Events in JSON format
When published to Amazon SNS, events are sent in the SNS Message as an array of JSON
objects that are encoded as strings. Each object in the array is one event.
Valid properties vary by the type of event. For example, MajorVirusType is a valid property
only for Deep Security Anti-Malware events, not system events etc. Valid property values vary for
each property. For examples, see "Example events in JSON format" on page 949.
Event property values can be used to filter which events are published to the SNS topic. For
details, see "SNS configuration in JSON format" on page 910.
Valid event properties
Note: Some events don't have all of the properties that usually apply to their event type.
926
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Action taken for the application
control event, such as "Execution of
Software Blocked by Rule", Application
String
Action "Execution of Unrecognized Control
(enum)
Software Allowed" (due to detect- events
only mode) or "Execution of
Unrecognized Software Blocked".
Action taken for the firewall event.
"Detect Only" values show what
Integer would have happened if the rule had Firewall
Action
(enum) been enabled. 0=Unknown, 1=Deny, events
6=Log Only, 0x81=Detect Only:
Deny.
Action taken for the Intrusion
Prevention event. 0=Unknown,
1=Deny, 2=Reset, 3=Insert,
4=Delete, 5=Replace, 6=Log Only, Intrusion
Integer
Action 0x81=Detect Only: Deny, Prevention
(enum)
0x82=Detect Only: Reset, events
0x83=Detect Only: Insert,
0x84=Detect Only: Delete,
0x85=Detect Only: Replace.
Name of the Deep Security Manager
user who performed the event, or System
ActionBy String
"System" if the event was not events
generated by a user.
Firewall
events,
Conversion of Action to a readable
ActionString String Intrusion
string.
Prevention
events
Unique identifier of the Deep
Security user who performed an
System
AdministratorID Integer action. Events generated by the
events
system and not by a user will not
have an identifier.
Integer Whether or not the Application Application
AggregationType Control
(enum)
927
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Control event occurred repeatedly. If
"AggregationType" is not "0", then
the number of occurrences is in
"RepeatCount." 0=Not aggregated, events
1=Aggregated based on file name,
path and event type, 2=Aggregated
based on event type
Name of the network application type Intrusion
ApplicationType String associated with the Intrusion Prevention
Prevention rule, if available. events
A reason that corresponds to the
Application
Integer Action. 0=Unknown, 1=Blocked due
BlockReason Control
(enum) to rule, 2=Blocked due to
events
unrecognized
What type of change was made to a
file, process, registry key, etc. for an Integrity
Integer
Change Integrity Monitoring event. Monitoring
(enum)
1=Created, 2=Updated, 3=Deleted, events
4=Renamed.
Anti-
Malware
events,
ID of the container where the event Intrusion
ContainerID String
occurred. Prevention
events,
Firewall
events
Anti-
Image name of the Docker container
ContainerImageName String Malware
where the malware was found.
events
Anti-
Malware
events,
Name of the container where the Intrusion
ContainerName String
event occurred. Prevention
events,
Firewall
events
928
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Description of the change made to
Integrity
the entity (created, deleted, updated)
Description String Monitoring
along with details about the attributes
events
changed.
Brief description of what happened System
Description String
during an event. events
Firewall
events,
String The IP address of the destination of a
DestinationIP Intrusion
(IP) packet.
Prevention
events
Firewall
events,
String The MAC address of the destination
DestinationMAC Intrusion
(MAC) of a packet.
Prevention
events
Firewall
events,
The network port number a packet
DestinationPort Integer Intrusion
was sent to.
Prevention
events
The detection category for a web Web
Integer
DetectionCategory reputation event. 12=User Defined, Reputation
(enum)
13=Custom, 91=Global. events
Whether or not the event was
returned with the Detect Only flag Web
Boolean
DetectOnly turned on. If true, this indicates that Reputation
the URL was not blocked, but access events
was detected.
Firewall
events,
Integer Network packet direction.
Direction Intrusion
(enum) 0=Incoming, 1=Outgoing.
Prevention
events
DirectionString String Conversion Direction to a readable Firewall
929
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
events,
Intrusion
string.
Prevention
events
Firewall
events,
The time the log was generated as
DriverTime Integer Intrusion
recorded by the driver.
Prevention
events
Firewall
The last log date recorded for events,
String
EndLogDate repeated events. Will not be present Intrusion
(Date)
for events that did not repeat. Prevention
events
Anti-
EngineType Integer The Anti-Malware engine type. Malware
events
Anti-
EngineVersion String The Anti-Malware engine version. Malware
events
The type of entity an integrity
monitoring event applies to:
Integrity
String Directory, File, Group,
EntityType Monitoring
(enum) InstalledSoftware, Port, Process,
events
RegistryKey, RegistryValue, Service,
User, or Wql
Error code for malware scanning
Anti-
events. If non-zero the scan failed,
ErrorCode Integer Malware
and the scan action and scan result
events
fields contain more details.
The identifier of the event. Identifiers
are unique per event type, but events
of different types may share the same All event
EventID Integer identifier. For example, it is possible types
for events with both EventType
firewall and ips to have EventID
930
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
equal to 1. The combination of
EventID, EventType and TenantID
are required to completely, uniquely
identify an event in Deep Security.
Note that this property is not related
to the "Event ID" property of a
System Event in the Deep Security
Manager.
The type of the event. One of:
"SystemEvent", "PacketLog",
"PayloadLog", "AntiMalwareEvent",
String All event
EventType "WebReputationEvent",
(enum) types
"IntegrityEvent",
"LogInspectionEvent",
"AppControlEvent".
File name of the software that was
Application
allowed or blocked, such as
FileName String Control
"script.sh". (The full path is separate,
events
in "Path".)
Firewall
Flags recorded from a network events,
Flags String packet; a space-separated list of Intrusion
strings. Prevention
events
Firewall
Network connection flow. Possible
events,
Integer values: -1=Not Applicable,
Flow Intrusion
(enum) 0=Connection Flow, 1=Reverse
Prevention
Flow
events
Firewall
events,
Conversion of Flow to a readable
FlowString String Intrusion
string.
Prevention
events
Firewall
Frame type. -1=Unknown, 2048=IP, events,
Integer
Frame 2054=ARP, 32821=REVARP, Intrusion
(enum)
33169=NETBEUI, 0x86DD=IPv6 Prevention
931
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
events
Firewall
events,
Conversion of Frame to a readable
FrameString String Intrusion
string.
Prevention
events
The group ID, if any, of the user Application
GroupID String account that tried to start the Control
software, such as "0". events
The group name, if any, of the user Application
GroupName String account that tried to start the Control
software, such as "root". events
Anti-
Malware
events,
Web
Reputation
events,
The version of the Deep Security Integrity
Agent that was protecting the Monitoring
HostAgentVersion String
computer where the event was events, Log
detected. Inspection
events,
Firewall
events,
Intrusion
Prevention
events
The global unique identifier (GUID)
Application
of the Deep Security Agent when
HostAgentGUID String Control
activated with the Deep Security
events
Manager.
Anti-
The asset value assigned to the Malware
HostAssetValue Integer computer at the time the event was events,
generated. Web
Reputation
932
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
events,
Integrity
Monitoring
events, Log
Inspection
events,
Firewall
events,
Intrusion
Prevention
events,
Application
Control
events
Anti-
Malware
events,
Web
Reputation
events,
Integrity
The unique identifier of the Computer
Monitoring
HostGroupID Integer Group of the computer where the
events, Log
event was detected.
Inspection
events,
Firewall
events,
Intrusion
Prevention
events
Anti-
Malware
events,
Web
Reputation
The name of the Computer Group of events,
the computer where the event was Integrity
HostGroupName String
detected. Note that Computer Group Monitoring
names may not be unique. events, Log
Inspection
events,
Firewall
events,
933
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Intrusion
Prevention
events
Anti-
Malware
events,
Web
Reputation
events,
Integrity
Monitoring
events, Log
Unique identifier of the computer
HostID Integer Inspection
where the event occurred.
events,
Firewall
events,
Intrusion
Prevention
events,
Application
Control
events
Anti-
Malware
events,
Web
Reputation
events,
The cloud instance ID of the
Integrity
computer where the event was
Monitoring
HostInstanceID String detected. This property will only be
events, Log
set for computers synchronized with
Inspection
a Cloud Connector.
events,
Firewall
events,
Intrusion
Prevention
events
Anti-
Hostname of the computer on which Malware
Hostname String
the event was generated. events,
934
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Web
Reputation
events,
Integrity
Monitoring
events, Log
Inspection
events,
Firewall
events,
Intrusion
Prevention
events,
Application
Control
events
Anti-
Malware
events,
Web
Reputation
events,
Integrity
Monitoring
The operating system of the events, Log
HostOS String computer where the event was Inspection
detected. events,
Firewall
events,
Intrusion
Prevention
events,
Application
Control
events
Anti-
Malware
The cloud account ID of the events,
computer where the event was Web
HostOwnerID String detected. This property will only be Reputation
set for computers synchronized with events,
a Cloud Connector. Integrity
Monitoring
935
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
events, Log
Inspection
events,
Firewall
events,
Intrusion
Prevention
events
Anti-
Malware
events,
Web
Reputation
events,
Integrity
Monitoring
The unique identifier of the Deep
events, Log
Security policy applied to the
HostSecurityPolicyID Integer Inspection
computer where the event was
events,
detected.
Firewall
events,
Intrusion
Prevention
events,
Application
Control
events
Anti-
Malware
events,
Web
Reputation
events,
The name of the Deep Security Integrity
policy applied to the computer where Monitoring
HostSecurityPolicyName
String the event was detected. Note that events, Log
security policy names may not be Inspection
unique. events,
Firewall
events,
Intrusion
Prevention
events,
936
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Application
Control
events
Anti-
Malware
events,
Web
Reputation
events,
Integrity
The vCenter UUID of the computer Monitoring
HostVCUUID String
the event applies to, if known. events, Log
Inspection
events,
Firewall
events,
Intrusion
Prevention
events
Intrusion
Prevention
A unique digest that identifies the
ImageDigest String events,
container image.
Firewall
events
Intrusion
Image name that was used to create Prevention
ImageName String the container where the event events,
occurred. Firewall
events
Anti-
Path of the infected file in the case of
InfectedFilePath String Malware
malware detection.
events
The name of the computer that's the Anti-
InfectionSource String source of a malware infection, if Malware
known. events
MAC address of the network Firewall
String events,
Interface interface sending or receiving a
(MAC) Intrusion
packet.
937
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Prevention
events
Container interface type. 0=physical
Intrusion
interfaces belong to host that can be
Prevention
controlled separately in Deep
InterfaceType String events,
Security Manager, 1=all virtual
Firewall
interfaces, 7=unknown type (typically
events
the host interface).
Intrusion
IPDatagramLength Integer The length of the IP datagram. Prevention
events
The SHA-1 content hash Integrity
IsHash String (hexadecimal encoded) of the file Monitoring
after it was modified. events
Integrity
The file or registry key an integrity
Key String Monitoring
event refers to.
events
The date and time when the event
was recorded. For Deep Security
Agent-generated events (Firewall,
String All event
LogDate IPS, etc.), the time is when the event
(Date) types
was recorded by the agent, not when
the event was received by Deep
Security Manager.
The classification of malware
Anti-
Integer detected. 0=Joke, 1=Trojan, 2=Virus,
MajorVirusType Malware
(enum) 3=Test, 4=Spyware, 5=Packer,
events
6=Generic, 7=Other
Anti-
Conversion of MajorVirusType to a
MajorVirusTypeString String Malware
readable string.
events
Anti-
MalwareName String The name of the malware detected. Malware
events
938
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
The type of malware detected.
1=General malware, 2=Spyware. Anti-
Integer
MalwareType General malware events will have an Malware
(enum)
InfectedFilePath, spyware events will events
not.
Unique identifier of the Deep
System
ManagerNodeID Integer Security Manager Node where the
events
event was generated.
Name of the Deep Security Manager
System
ManagerNodeName String Node where the event was
events
generated.
Application
The MD5 checksum (hash) of the
MD5 String Control
software, if any.
events
System events have an additional ID
that identifies the event. Note that in System
Number Integer
the Deep Security Manager, this events
property appears as "Event ID".
Integer 0=Unknown, 1=Allowed due to Application
Operation
(enum) detect-only mode, 2=Blocked control
The origin of the event. -1=Unknown,
0=Deep Security Agent, 1=In-VM
Integer All event
Origin guest agent, 2=Deep Security
(enum) types
Appliance, 3=Deep Security
Manager
Conversion of Origin to a human- All event
OriginString String
readable string. types
Log
OSSEC_Action String OSSEC action Inspection
events
Log
OSSEC_Command String OSSEC command Inspection
events
939
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Log
OSSEC_Data String OSSEC data Inspection
events
Log
OSSEC_Description String OSSEC description Inspection
events
Log
OSSEC_DestinationIP String OSSEC dstip Inspection
events
Log
OSSEC_DestinationPort
String OSSEC dstport Inspection
events
Log
OSSEC_
String OSSEC dstuser Inspection
DestinationUser
events
Log
OSSEC_FullLog String OSSEC full log Inspection
events
Log
OSSEC groups result (e.g.
OSSEC_Groups String Inspection
syslog,authentication_failure)
events
OSSEC hostname. This is the name
of the host as read from a log entry, Log
OSSEC_Hostname String which is not necessarily the same as Inspection
the name of the host on which the events
event was generated.
Log
OSSEC_ID String OSSEC id Inspection
events
OSSEC level. An integer in the
range 0 to 15 inclusive. 0-3=Low Log
Integer
OSSEC_Level severity, 4-7=Medium severity, 8- Inspection
(enum)
11=High severity, 12-15=Critical events
severity.
940
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Log
OSSEC_Location String OSSEC location Inspection
events
Log
OSSEC_Log String OSSEC log Inspection
events
Log
OSSEC_ProgramName String OSSEC program_name Inspection
events
Log
OSSEC_Protocol String OSSEC protocol Inspection
events
Log
OSSEC_RuleID Integer OSSEC rule id Inspection
events
Log
OSSEC_SourceIP Integer OSSEC srcip Inspection
events
Log
OSSEC_SourcePort Integer OSSEC srcport Inspection
events
Log
OSSEC_SourceUser Integer OSSEC srcuser Inspection
events
Log
OSSEC_Status Integer OSSEC status Inspection
events
Log
OSSEC_SystemName Integer OSSEC systemname Inspection
events
Log
OSSEC_URL Integer OSSEC url Inspection
events
941
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Hexadecimal encoding of captured Intrusion
PacketData Integer packet data, if the rule was Prevention
configured to capture packet data. events
Firewall
PacketSize Integer The size of the network packet.
events
Directory path of the software file that
Application
was allowed or blocked, such as
Path String Control
"/usr/bin/". (The file name is
events
separate, in "FileName".)
Anti-
Integer The malware detection pattern
PatternVersion Malware
(enum) version.
events
Intrusion Prevention Filter Flags. A
bitmask value that can include the
following flag values: 1 - Data
truncated - Data could not be logged.
Intrusion
2 - Log Overflow - Log overflowed
PayloadFlags Integer Prevention
after this log. 4 - Suppressed - Logs
events
threshold suppressed after this log. 8
- Have Data - Contains packet data.
16 - Reference Data - References
previously logged data.
Intrusion
Prevention
PodID String Pod unique ID (UID) events,
Firewall
events
Intrusion
Position within packet of data that
PosInBuffer Integer Prevention
triggered the event.
events
Intrusion
Position within stream of data that
PosInStream Integer Prevention
triggered the event.
events
The name of the process that Integrity
Process String Monitoring
generated the event, if available.
942
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
events
Application
Control
events,
The identifier (PID) of the process
Intrusion
ProcessID Integer that generated the event, if available.
Prevention
events,
Firewall
events
Application
Control
events,
The name of the process that
Intrusion
ProcessName String generated the event, if available,
Prevention
such as "/usr/bin/bash".
events,
Firewall
events
The numerical network protocol Firewall
identifier. -1=Unknown, 1=ICMP, events,
Integer
Protocol 2=IGMP, 3=GGP, 6=TCP, 12=PUP, Intrusion
(enum)
17=UDP, 22=IDP, 58=ICMPv6, Prevention
77=ND, 255=RAW events
Firewall
events,
Conversion of Protocol to a readable
ProtocolString String Intrusion
string.
Prevention
events
Integrity
Monitoring
events, Log
The numerical rank of the event; the Inspection
product of the computer's assigned events,
Rank Integer
asset value and the severity value Firewall
setting for an event of this severity. events,
Intrusion
Prevention
events
943
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Firewall,
Intrusion
Name of the Deep Security rule or
Prevention,
configuration object that triggered the
integrity
event, or (for Firewall and Intrusion
monitoring,
Prevention) a mapping of Status to
Reason String anti-
String if the event was not triggered
malware,
by a rule. For Application Control,
and
"Reason" may be "None"; see
Application
"BlockReason" instead.
Control
events
Firewall
events,
The number of times this event Intrusion
occurred repeatedly. A repeat count Prevention
RepeatCount Integer
of 1 indicates the event was only events,
observed once and did not repeat. Application
Control
events
Translated risk level of the URL
accessed. 2=Suspicious, 3=Highly Web
Integer
Risk Suspicious, 4=Dangerous, Reputation
(enum)
5=Untested, 6=Blocked by events
Administrator
The raw risk level of the URL from 0 Web
RiskLevel Integer to 100. Will not be present if the URL Reputation
was blocked by a block rule. events
Web
Conversion of Risk to a readable
RiskString String Reputation
string.
events
Scan action 1. Scan action 1 & 2 and
Anti-
scan result actions 1 & 2 and
ScanAction1 Integer Malware
ErrorCode are combined to form the
events
single "summaryScanResult".
Anti-
ScanAction2 Integer Scan action 2. Malware
events
944
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Anti-
ScanResultAction1 Integer Scan result action 1. Malware
events
Anti-
ScanResultAction2 Integer Scan result action 2. Malware
events
Malware scan result, as a string. A
Anti-
combination of ScanAction 1 and 2,
ScanResultString String Malware
ScanActionResult 1 and 2, and
events
ErrorCode.
Malware scan type that created the Anti-
Integer
ScanType event. 0=Real-Time, 1=Manual, Malware
(enum)
2=Scheduled, 3=Quick Scan events
Anti-
Conversion of ScanType to a
ScanTypeString String Malware
readable string.
events
System
Severity Integer 1=Info, 2=Warning, 3=Error
events
Integrity
Monitoring
Integer 1=Low, 2=Medium, 3=High, events,
Severity
(enum) 4=Critical Intrusion
Prevention
events
System
events,
Integrity
Conversion of Severity to a human- Monitoring
SeverityString String
readable string. events,
Intrusion
Prevention
events
Log
Conversion of OSSEC_Level to a
SeverityString String Inspection
human-readable string.
events
945
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Application
The SHA-1 checksum (hash) of the
SHA1 String Control
software, if any.
events
Application
The SHA-256 checksum (hash) of
SHA256 String Control
the software, if any.
events
Firewall
events,
String
SourceIP The source IP address of a packet. Intrusion
(IP)
Prevention
events
Firewall
events,
String The source MAC Address of the
SourceMAC Intrusion
(MAC) packet.
Prevention
events
Firewall
events,
The network source port number of
SourcePort Integer Intrusion
the packet.
Prevention
events
If this event was not generated by a
specific Firewall rule, then this status
Firewall
Status Integer is one of approximately 50 hard-
events
coded rules, such as 123=Out Of
Allowed Policy
If this event was not generated by a
specific IPS rule, then this status is Intrusion
Status Integer one of approximately 50 hard-coded Prevention
reasons, such as -504=Invalid UTF8 events
encoding
Comma-separated list of tags that
have been applied to the event. This
All event
Tags String list will only include tags that are
types
automatically applied when the event
is generated.
946
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
Identifier of the group of tags that was All event
TagSetID Integer
applied to the event. types
Unique identifier of the target of the
event. This identifier is unique for the
targets of the same type within a
System
TargetID Integer tenant. It is possible for target IDs to
events
be reused across different types, for
example, both a Computer and a
Policy may have target ID 10.
IP Address that was being contacted Web
String
TargetIP when a Web Reputation Event was Reputation
(IP)
generated. events
The name of the target of the event.
The target of a system event can be System
TargetName String
many things, including computers, events
policies, users, roles, and tasks.
System
TargetType String The type of the target of the event.
events
Unique identifier of the tenant All event
TenantID Integer
associated with the event. types
Name of the tenant associated with All event
TenantName String
the event. types
Intrusion
Prevention
ID of the thread (from the container)
ThreadID String events,
that caused the event.
Firewall
events
System
Title String Title of the event.
events
Web
String The URL being accessed that
URL Reputation
(URL) generated the event.
events
User String The user account that was the target Integrity
947
Trend Micro Deep Security On-Premise 20
Applies To
Property Name Data Type Description
Event Type(s)
of an integrity monitoring event, if Monitoring
known. events
The user identifier (UID), if any, of the Application
UserID String user account that tried to start the Control
software, such as "0". events
The user name, if any, of the user Application
UserName String account that tried to start the Control
software, such as "root". events
Data types of event properties
Events forwarded as JSON usually use strings to encode other data types.
Data Type
Description
Boolean
JSON true or false.
JSON int. Deep Security does not output floating point numbers in events.
Integer Note: Integers in events may be more than 32 bits. Verify the code that
processes events can handle this. For example, JavaScript's Number data type
cannot safely handle larger than 32-bit integers.
Integer
(enum) JSON int, restricted to a set of enumerated values.
String JSON string.
String JSON string, formatted as a date and time in the pattern YYYY-MM-
(Date) DDThh:mm:ss.sssZ (ISO 8601). 'Z' is the time zone. 'sss' are the three digits for
sub-seconds. See also the W3C note on date and time formats.
String
(IP) JSON string, formatted as an IPv4 or IPv6 address.
String
(MAC) JSON string, formatted as a network MAC address.
948
Trend Micro Deep Security On-Premise 20
Data Type
Description
String
(URL) JSON string, formatted as a URL.
String
(enum) JSON string, restricted to a set of enumerated values.
Example events in JSON format
System event
{
"Type" : "Notification",
"MessageId" : "123abc-123-123-123-123abc",
"TopicArn" : "arn:aws:sns:us-west-2:123456789:DS_
Events",
"Message" : "[
{
"ActionBy":"System",
"Description":"Alert: New Pattern
Update is Downloaded and Available\\nSeverity: Warning\",
"EventID":6813,
"EventType":"SystemEvent",
"LogDate":"2018-12-04T15:54:24.086Z",
"ManagerNodeID":123,
"ManagerNodeName":"job7-123",
"Number":192,
"Origin":3,
"OriginString":"Manager",
"Severity":1,
"SeverityString":"Info",
"Tags":"\",
"TargetID":1,
"TargetName":"ec2-12-123-123-123.us-
west-2.compute.amazonaws.com",
949
Trend Micro Deep Security On-Premise 20
"TargetType":"Host",
"TenantID":123,
"TenantName":"Umbrella Corp.",
"Title":"Alert Ended"
}
]",
"Timestamp" : "2018-12-04T15:54:25.130Z",
"SignatureVersion" : "1",
"Signature" : "500PER10NG5!gnaTURE==",
"SigningCertURL" : "https://sns.us-west-
2.amazonaws.com/SimpleNotificationService-abc123.pem",
"UnsubscribeURL" : "https://sns.us-west-
2.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:u
s-west-2:123456:DS_Events:123abc-123-123-123-123abc"
}
Anti-Malware events
Multiple virus detection events can be in each SNS Message. (For brevity, repeated event
properties are omitted below, indicated by "...".)
{
"Type" : "Notification",
"MessageId" : "123abc-123-123-123-123abc",
"TopicArn" : "arn:aws:sns:us-west-2:123456789:DS_
Events",
"Message" : "[
{
"AMTargetTypeString":"N/A",
"ATSEDetectionLevel":0,
"CreationTime":"2018-12-
04T15:57:18.000Z",
"EngineType":1207959848,
"EngineVersion":"10.0.0.1040",
950
Trend Micro Deep Security On-Premise 20
"ErrorCode":0,
"EventID":1,
"EventType":"AntiMalwareEvent",
"HostAgentGUID":"4A5BF25A-4446-DD8B-
DFB7-564C275F5F6B",
"HostAgentVersion":"11.1.0.163",
"HostID":1,
"HostOS":"Amazon Linux (64 bit)
(4.14.62-65.117.amzn1.x86_64)",
"HostSecurityPolicyID":3,
"HostSecurityPolicyName":"PolicyA",
"Hostname":"ec2-12-123-123-123.us-west-
2.compute.amazonaws.com",
"InfectedFilePath":"/tmp/eicar_
1543939038890.txt",
"LogDate":"2018-12-04T15:57:19.000Z",
"MajorVirusType":2,
"MajorVirusTypeString":"Virus",
"MalwareName":"Eicar_test_file",
"MalwareType":1,
"ModificationTime":"2018-12-
04T15:57:18.000Z",
"Origin":0,
"OriginString":"Agent",
"PatternVersion":"14.665.00",
"Protocol":0,
"Reason":"Default Real-Time Scan
Configuration",
"ScanAction1":4,
"ScanAction2":3,
"ScanResultAction1":-81,
"ScanResultAction2":0,
"ScanResultString":"Quarantined",
951
Trend Micro Deep Security On-Premise 20
"ScanType":0,
"ScanTypeString":"Real Time",
"Tags":"\",
"TenantID":123,
"TenantName":"Umbrella Corp."},
{
"AMTargetTypeString":"N/A",
"ATSEDetectionLevel":0,
"CreationTime":"2018-12-
04T15:57:21.000Z",
...},
{
"AMTargetTypeString":"N/A",
"ATSEDetectionLevel":0,
"CreationTime":"2018-12-
04T15:57:29.000Z",
...
}
]",
"Timestamp" : "2018-12-04T15:57:50.833Z",
"SignatureVersion" : "1",
"Signature" : "500PER10NG5!gnaTURE==",
"SigningCertURL" : "https://sns.us-west-
2.amazonaws.com/SimpleNotificationService-abc123.pem",
"UnsubscribeURL" : "https://sns.us-west-
2.amazonaws.com/?Action=Unsubscribe&SubscriptionArn=arn:aws:sns:u
s-west-2:123456:DS_Events:123abc-123-123-123-123abc"
}
Forward system events to a remote computer via SNMP
Deep Security supports SNMP for forwarding system events to a computer from Deep Security
Manager. On Windows, the MIB file ("DeepSecurity.mib") is located in \Trend Micro\Deep
Security Manager\util. On Linux, the default location is /opt/dsm/util.
952
Trend Micro Deep Security On-Premise 20
Configure alerts
Alerts are generated when Deep Security requires your attention, such as an administrator-
issued command failing, or a hard disk running out of space. Deep Security includes a pre-
defined set of alerts (for a list, see "Predefined alerts" on page 963). Additionally, when you
create protection module rules, you can configure them to generate alerts if they are triggered.
There are several ways to see which alerts have been triggered:
l They're displayed in the "Alert Status" dashboard widget in Deep Security Manager.
l They're displayed on the Alerts page in Deep Security Manager (see "View alerts in Deep
Security Manager" below).
l You can get an email notification when an alert is triggered (see "Set up email notification
for alerts" on the next page.)
l You can generate alert reports (see "Generate reports about alerts and other activity" on
page 959).
Unlike security events and system events, alerts are not purged from the database after a period
of time. Alerts remain until they are dismissed, either manually or automatically.
View alerts in Deep Security Manager
The Alerts page in Deep Security Manager displays all alerts that have been triggered, but not
yet responded to. You can display alerts in a summary view that groups similar alerts together, or
in list view, which lists all alerts individually. To switch between the two views, use the menu
next to "Alerts" in the page's title. You can also sort the alerts by time or by severity.
In summary view, expanding an Alert panel (by clicking Show Details) displays all the
computers (or users) that have generated that particular alert. Clicking the computer will display
the computer's Details window. If an alert applies to more than five computers, an ellipsis ("...")
appears after the fifth computer. Clicking the ellipsis displays the full list. Once you have taken
the appropriate action to deal with an alert, you can dismiss the alert by selecting the check box
next to the target of the alert and clicking Dismiss. (In list view, right-click the alert to see the list
of options in the context menu.)
Alerts that can't be dismissed (like "Relay Update Service Not Available") will be dismissed
automatically when the condition no longer exists.
953
Trend Micro Deep Security On-Premise 20
Note: In cases where an alert condition occurs more than once on the same computer, the
alert will show the timestamp of the first occurrence of the condition. If the alert is dismissed
and the condition reoccurs, the timestamp of the first re-occurrence will be displayed.
Tip: Use the Computers filtering bar to view only alerts for computers in a particular computer
group, with a particular policy, etc.
Unlike security events and system events, alerts are not purged from the database after a period
of time. Alerts remain until they are dismissed, either manually or automatically.
Configure alert settings
To configure the settings for individual alerts, go to the Alerts page in Deep Security Manager
and click Configure Alerts. This displays a list of all alerts. A green check mark next to an alert
indicates that it is enabled. An alert will be triggered if the corresponding situation occurs, and it
will appear in the Deep Security Manager.
You can select an alert and click Properties to change other settings for the alert, such as the
severity level and email notification settings.
Set up email notification for alerts
Deep Security Manager can send emails to specific users when selected alerts are triggered.
To enable email notifications:
1. Give Deep Security Manager access to an SMTP mail server (see "Configure SMTP
settings for email notifications" on page 958).
2. Specify which alerts cause email notifications to be sent. For example, you can send email
only for the most critical alerts. Most alerts send email notifications by default. (see "Turn
alert emails on or off" on the next page).
3. Specify who will receive email notifications. You can configure user accounts so that they
receive alert emails (see "Configure an individual user to receive alert emails" on
page 957). You can also configure alerts to specify the email account of a user or a
distribution list. With this option, email is sent regardless of the configuration of the user
accounts (see "Configure recipients for all alert emails" on page 958).
954
Trend Micro Deep Security On-Premise 20
Turn alert emails on or off
955
Trend Micro Deep Security On-Premise 20
1. Go to the Alerts page and click Configure Alerts to display the list of alerts.
956
Trend Micro Deep Security On-Premise 20
2. A green check mark next to an alert indicates that it is enabled. An alert will be triggered if
the corresponding situation occurs, and appear in the Deep Security Manager GUI. If you
also want to receive email about the alert, double-click on an alert to display its Properties
window, then select at least one of the "Send Email" check boxes.
Configure an individual user to receive alert emails
1. Go to Administration > User Management > Users and double-click a user account to
display its Properties window.
2. On the Contact Information tab, enter an email address and select Receive Alert Emails.
957
Trend Micro Deep Security On-Premise 20
Configure recipients for all alert emails
Note: All alert emails will be sent to this address or email distribution list, even if the recipients
have not been set up in their user account properties to receive email notifications.
1. Go to Administration > System Settings > Alerts.
2. For Alert Email Address - The email address to which all alert emails should be sent,
provide an email address or a distribution list email address.
Configure SMTP settings for email notifications
Deep Security Manager can send emails to users when selected alerts are triggered (see
"Configure alerts" on page 953). Before setting up the email notifications, you will need to give
Deep Security Manager access to an SMTP mail server.
1. Go to Administration > System Settings > SMTP.
2. Type the IP address or hostname of your SMTP email server. Include the port number if it's
not the default port number.
Tip:
AWS throttles (rate limits) e-mail on SMTP's IANA standard port number, port 25. If you
use AWS Marketplace, you may have faster alerts if you use SMTP over STARTTLS
(secure SMTP) instead. For more information, see:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-connect.html
3. Enter a "From" email address from which the emails should be sent.
Note:
If you are using Amazon SES, the sender email address must be verified. To learn how
to verify your email address in Amazon SES and view a list of addresses you’ve already
verified, see:
https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-email-addresses.html
4. Optionally, type a "bounce" address to which delivery failure notifications (DSN) should be
sent if the alert emails can't be delivered to one or more users.
5. If your SMTP mail server requires outgoing authentication, type the user name and
password credentials.
958
Trend Micro Deep Security On-Premise 20
6. Select STARTTLS if your SMTP server supports the protocol. (STARTTLS is not
supported in FIPS mode. See "FIPS 140-2 support" on page 1417.)
7. After you've entered the necessary information, click Test SMTP Settings to test the
connection.
Generate reports about alerts and other activity
Deep Security Manager produces reports in PDF or RTF formats. Most of the reports have
configurable parameters such as date range or reporting by computer group. Parameter options
will be disabled for reports to which they don't apply. You can set up a one-time report (see "Set
up a single report" below) or set up a schedule to run a report on a regular basis (see "Set up a
scheduled report " on page 962).
Set up a single report
1. In the Deep Security Manager, go to the Events & Reports tab and then in the left pane,
click Generate Reports > Single Report.
2. In the Report list, select the type of report that you want to generate. Depending on which
protection modules you are using, these reports may be available:
l Alert Report: List of the most common alerts
l Anti-Malware Report: List of the top 25 infected computers
l Attack Report: Summary table with analysis activity, divided by mode. For details
about what's included, see About attack reports.
l AWS Metered Billing Report: Summary table of AWS Metered Billing consumption
in hours per day by instance size
l Azure Metered Billing Report: Summary table of Azure Metered Billing consumption
in hours per day by instance size
l Computer Report: Summary of each computer listed on the Computers tab
l DPI Rule Recommendation Report: Intrusion prevention rule recommendations.
This report can be run for only one security policy or computer at a time
l Firewall Report: Record of firewall rule and stateful configuration activity
l Forensic Computer Audit Report: Configuration of an agent on a computer
l Integrity Monitoring Baseline Report: Baseline of the computer(s) at a particular
time, showing Type, Key, and Fingerprinted Date
l Integrity Monitoring Detailed Change Report: Details about the changes detected
959
Trend Micro Deep Security On-Premise 20
l Integrity Monitoring Report: Summary of the changes detected
l Intrusion Prevention Report: Record of intrusion prevention rule activity
l Log Inspection Detailed Report: Details of log data that has been collected
l Log Inspection Report: Summary of log data that has been collected
l Recommendation Report: Record of recommendation scan activity
l Security Module Usage Cumulative Report: Current computer usage of protection
modules, including a cumulative total and the total in blocks of 100
l Security Module Usage Report: Current computer usage of protection modules
l Summary Report: Consolidated summary of Deep Security activity
l Suspicious Application Activity Report: Information about suspected malicious
activity
l System Event Report: Record of system (non-security) activity
l System Report: Overview of computers, contacts, and users
l User and Contact Report: Content and activity detail for users and contacts
l Web Reputation Report: List of computers with the most web reputation events
3. Select the Format for the report, either PDF or RTF. (The "Security Module Usage Report"
and "Security Module Usage Cumulative Report" are exceptions and are always output as
CSV files.)
4. You can also add an optional Classification to PDF or RTF reports: BLANK, TOP
SECRET, SECRET, CONFIDENTIAL, FOR OFFICIAL USE ONLY, LAW
ENFORCEMENT SENSITIVE (LES), LIMITED DISTRIBUTION, UNCLASSIFIED,
INTERNAL USE ONLY.
5. You can use the Tag Filter area to filter the report data using event tags (if you have
selected a report that contains event data). Select All for all events, Untagged for only
untagged events, or select Tag(s) and specify one or more tags to include only those
events with your selected tag(s).
Note: If you apply multiple contradicting tags, the tags will counteract each other, rather
than combine. For example, if you select "User Signed In" and "User Signed Out", there
will be no system events.
6. You can use the Time Filter area to set a time filter for any period for which records exist.
This is useful for security audits. Time filter options:
l Last 24 Hours: Includes events from the past 24 hours, starting and ending at the top
of the hour. For example if you generate a report on December 5th at 10:14am, you
960
Trend Micro Deep Security On-Premise 20
will get a report for events that occurred between December 4th at 10:00am and
December 5th at 10:00am.
l Last 7 Days: Includes events from the past week. Weeks start and end at midnight
(00:00). For example if you generate a report on December 5th at 10:14am, you will
get a report for events that occurred between November 28th at 0:00am and
December 5th at 0:00am.
l Previous Month: Includes events from the last full calendar month, starting and
ending at midnight (00:00). For example, if you select this option on November 15,
you will receive a report for events that occurred between midnight October 1 to
midnight November 1.
l Custom Range: Enables you to specify your own date and time range for the report.
In the report, the start time may be changed to midnight if the start date is more than
two days ago.
l
Note: Reports use data stored in counters. Counters are data aggregated
periodically from Events. Counter data is aggregated on an hourly basis for the
most recent three days. Data from the current hour is not included in reports. Data
older than three days is stored in counters that are aggregated on a daily basis. For
this reason, the time period covered by reports for the last three days can be
specified at an hourly level of granularity, but beyond three days, the time period
can only be specified on a daily level of granularity.
7. In the Computer Filter area, select the computers whose data will be included in the
report.
l All Computers: Every computer in Deep Security Manager
l My Computers: If the signed in user has restricted access to computers based on
their user role's rights settings, these are the computers the signed in User has view
access right to.
l In Group: The computers in a Deep Security group.
l Using Policy: The computers using a specific protection Policy.
l Computer: A single computer.
Note: To generate a report on specific computers from multiple computer groups,
create a user who has viewing rights only to the computers in question and then
961
Trend Micro Deep Security On-Premise 20
either create a scheduled task to regularly generate an "All Computers" report for
that user or sign in as that user and run an "All Computers" report. Only the
computers to which that user has viewing rights will be included in the report.
8. In the Encryption area, you can protect the report with the password of the currently signed
in user or with a new password for this report only:
l Disable Report Password: Report is not password protected.
l Use Current User's Report Password: Use the current user's PDF report password.
To view or modify the user's PDF report password, go to Administration > User
Management > Users > Properties > Settings > Reports.
l Use Custom Report Password: Create a one-time-only password for this report. The
password does not have any complexity requirements.
Set up a scheduled report
Scheduled reports are scheduled tasks that periodically generate and distribute reports to any
number of users and contacts (this feature used to be named "Recurring Reports").
To set up a scheduled report, go to the Events & Reports tab and then in the left pane, click
Generate Reports > Scheduled Reports. Click New. The New Scheduled Task wizard opens
and will step you through the configuration process. Most of the options are identical to those for
single reports, with the exception of Time Filter:
l Last [N] Hour(s): When [N] is less than 60, the start and end times will be at the top of the
specified hour. When [N] is more than 60, hourly data is not available for the beginning of
the time range, so the start time in the report will be changed to midnight (00:00) of the start
day.
l Last [N] Day(s): Includes data from midnight [N] days ago to midnight of the current day.
l Last [N] Week(s): Includes events from the last [N] weeks, starting and ending at midnight
(00:00).
962
Trend Micro Deep Security On-Premise 20
l Last [N] Month(s): Includes events from the last [N] full calendar month, starting and
ending at midnight (00:00). For example, if you select "Last 1 Month(s)" on November 15,
you will receive a report for events that occurred between midnight October 1 to midnight
November 1.
Note: Reports use data stored in counters. Counters are data aggregated periodically from
events. Counter data is aggregated on an hourly basis for the most recent three days. Data
from the current hour is not included in reports. Data older than three days is stored in counters
that are aggregated on a daily basis. For this reason, the time period covered by reports for the
last three days can be specified at an hourly level of granularity, but beyond three days, the
time period can only be specified on a daily level of granularity.
For more information on scheduled tasks, see the "Schedule Deep Security to perform tasks" on
page 1378.
Lists of events and alerts
Predefined alerts
Default
Alert Dismissible Description
Severity
A Deep Security Relay can't successfully
download security components. This might be
due to network connectivity issues or
misconfigurations in Deep Security Manager
A Deep Security Relay under Administration > System Settings >
cannot download Critical No Updates. Check your network configurations
security components (for example, the proxy settings of the relay
group) and System Settings, and then
manually initiate an update on the relay using
the Download Security Update option on the
Administration > Updates > Software page.
An abnormal restart has been detected on the
computer. This condition may be caused by a
variety of conditions. If the agent/appliance is
Abnormal Restart
Warning Yes suspected as the root cause then the
Detected
diagnostics package (located in the Support
section of the Computer Details dialog) should
be invoked.
963
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
This alert indicates that the Deep Security
Agent service was restarted abnormally. You
can safely dismiss this alert, or, if the alert
reoccurs, create a diagnostics package and
open a case with Technical Support.
This may indicate a problem with the
agent/appliance, but it also can occur if agent
self-protection is enabled. On the Deep
Security Manager, go to Computer editor 1 >
Activation Failed Critical No Settings > General. In Agent Self Protection,
and then either deselect Prevent local end-
users from uninstalling, stopping, or
otherwise modifying the Agent or enter a
password for local override.
This is usually caused by too many firewall and
intrusion prevention rules being assigned. Run
Agent configuration
Warning Yes a recommendation scan on the computer to
package too large
determine if any rules can be safely
unassigned.
The agent failed to install successfully on one
or more computers. Those computers are
currently unprotected. You must reboot the
computers which will automatically restart the
agent install program.
This may indicate a problem with the
Agent Installation Failed Critical Yes agent/appliance, but it also can occur if agent
self-protection is enabled. On the Deep
Security Manager, go to Computer editor 2 >
Settings > General. In Agent Self Protection,
and then either deselect Prevent local end-
users from uninstalling, stopping, or
otherwise modifying the Agent or enter a
password for local override.
Agent/Appliance Warning No The Deep Security Manager has detected an
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
2To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
964
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
older agent/appliance version on the computer
that does not support all available features. An
Upgrade Recommended
upgrade of the agent/appliance software is
recommended. (Deprecated in 9.5)
Deep Security Manager has detected a
Agent/ApplianceUpgrade
computer with a version of the agent/appliance
Recommended
Warning No that is not compatible with one or more security
(Incompatible Security
updates assigned to it. An upgrade of the
Update(s))
agent/appliance software is recommended.
Deep Security Manager has detected a
Agent Upgrade computer with a version of the agent that is not
Recommended compatible with the appliance. The appliance
Warning No
(Incompatible with will always filter network traffic in this
Appliance) configuration resulting in redundant protection.
(Deprecated in 9.5)
Deep Security Manager has detected one or
more computers with a version of the
Agent/ApplianceUpgrade
agent/appliance that is older than the latest
Recommended (New Warning No
version imported into the manager. An upgrade
Version Available)
of the agent/appliance software is
recommended.
Deep Security Manager has detected a
computer with a version of the agent/appliance
Agent/Appliance
Warning No that is not compatible with this version of the
Upgrade Required
manager. An upgrade of the agent/appliance
software is required.
Updated rules have been downloaded but not
applied to your policies. To apply the rules, go
An update to the Rules is
Warning No to Administration > Updates > Security and in
available
the Rule Updates column, click Apply Rules to
Policies.
A malware scan configuration that is
Anti-Malware Alert Warning Yes configured for alerting has raised an event on
one or more computers.
An anti-malware component failed on one or
Anti-Malware
Critical Yes more computers. See the event descriptions on
Component Failure
the individual computers for specific details.
Anti-Malware One or more agent or relay failed to update
Component Update Warning No anti-malware components. See the affected
Failed computers for more information.
The agent or appliance has reported that the
Anti-Malware Engine anti-malware engine is not responding. Please
Critical No
Offline check the system events for the computer to
determine the cause of the failure.
Anti-malware module The Anti-Malware module was unable to
maximum disk space Warning Yes analyze or quarantine a file because the
965
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
maximum disk space used to store identified
files was reached. To change the maximum
used to store identified
disk space for identified files setting, open the
files exceeded
computer or policy editor and go to the Anti-
malware > Advanced tab.
The agent on this computer has not received its
initial anti-malware protection package, or its
anti-malware protection is out of date. Make
Anti-Malware protection sure a relay is available and that the agent has
Warning No
is absent or out of date been properly configured to communicate with
it. To configure relays and other update
options, go to Administration > System Settings
> Updates.
API Keys can be locked out manually, or by
API Key Locked Out Warning No
repeated failed validation attempts.
The agent has reported that the Application
Application Control Control engine failed to initialize. Please check
Critical No
Engine Offline the system events for the computer to
determine the cause of the failure.
An application control ruleset could not be
assigned to one or more computers because
the ruleset is not supported by the installed
version of the agent. Typically, the problem is
that a hash-based ruleset (which is compatible
only with Deep Security Agent 11.0 or newer)
has been assigned to an older Deep Security
Agent. Deep Security Agent 10.x supports only
Application Control file-based rulesets. (For details, see
Ruleset is incompatible Critical No "Differences in how Deep Security Agent 10
with agent version and 11 compare files" on page 802.) To fix this
issue, upgrade the Deep Security Agent to
version 11.0 or newer. Alternatively, if you are
using local rulesets, reset application control
for the agent. Or if you are using a shared
ruleset, use a shared ruleset that was created
with Deep Security 10.x until all agents using
the shared ruleset are upgraded to Deep
Security Agent 11.0 or newer.
Application Type Misconfiguration of application types may
Warning No
Misconfiguration prevent proper security coverage.
Deep Security Manager has determined that a
computer should be assigned an application
Application Type type. This could be because an agent was
Warning Yes installed on a new computer and vulnerable
Recommendation
applications were detected, or because a new
vulnerability has been discovered in an
966
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
installed application that was previously
thought to be safe. To assign the application
type to the computer, open the 'Computer
Details' dialog box, click on 'Intrusion
Prevention Rules', and assign the application
type.
AWS Contract License AWS Contract License expired or AWS
Critical No
Exceeded Contract entitlements have been exceeded.
The Azure AD application can not sync the
cloud data now. Maybe the application
Azure AD Application password is expired or the application is
Critical No
Needs Renew deleted. Please renew the application via
Computers > Properties (right click on the
target group) > Renew Application Now.
The Azure AD application password will expire
soon. You can remove this alert by renewing
Azure AD Application
Warning No the application via Computers > Properties
Expires Soon
(right click on the target group) > Renew
Application Now.
The key pair for Azure service(s) has expired.
Azure Key Pair Expired Critical No You can remove this alert by updating your key
pair on the Azure service's property page.
The key pair for Azure service(s) will expire
Azure Key Pair Expires soon. You can remove this alert by updating
Warning No
Soon your key pair on the Azure service's property
page.
Disconnected from Census, Good File
Reputation, and Predictive Machine Learning
Census, Good File Service. Please see the event details below for
Reputation, and possible solutions.
Predictive Machine Warning Yes
Learning Service Refer to "Warning: Census, Good File
Disconnected Reputation, and Predictive Machine Learning
Service Disconnected" on page 1077 for
troubleshooting tips.
A Deep Security Manager node cannot
connect to the Trend Micro Certified Safe
Software Service to perform file signature
Certified Safe Software comparisons for the integrity monitoring
Warning No
Service Offline module. A locally cached database will be
used until connectivity is restored. Make sure
the manager node has internet connectivity
and that proxy settings (if any) are correct.
Clock Change Detected Warning Yes A clock change has been detected on the
967
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
computer. Unexpected clock changes may
indicate a problem on the computer and should
be investigated before the alert is dismissed.
An agent was activated on one or more
computers belonging to a cloud account that is
Cloud Computer Not not synchronized with Deep Security. Click the
Managed as Part of Warning Yes link in the 'Action' field above to add the cloud
Cloud Account account to Deep Security. The computer(s) will
be moved into the account, and may be billed
at a lower hourly rate.
A communications problem has been detected
on the computer. Communications problems
indicate that the computer cannot initiate
communication with the Deep Security
Manager(s) because of network configuration
Communications
Warning Yes or load reasons. Please check the system
Problem Detected
events in addition to verifying communications
can be established to the Deep Security
Manager(s) from the computer. The cause of
the issue should be investigated before the
alert is dismissed.
Computer Not Receiving These computer(s) have stopped receiving
Warning No
Updates updates. Manual intervention may be required.
The agent software upgrade was successful,
but the computer must be rebooted for the
Computer Reboot
Critical Yes install to be completed. The computer(s)
Required
should be manually updated before the alert is
dismissed.
The anti-malware protection on the agent has
Computer Reboot reported that the computer needs to be
Required for Anti- Critical No rebooted. Please check the system events for
Malware Protection the computer to determine the reason for the
reboot.
The Application Control protection on Agent
Computer Reboot has reported that the computer needs to be
Required for Application Critical No rebooted. Please check the system events for
Control Protection the computer to determine the reason for the
reboot.
The Integrity Monitoring protection on Agent
Computer Reboot has reported that the computer needs to be
Required for Integrity Critical No rebooted. Please check the system events for
Monitoring Protection the computer to determine the reason for the
reboot.
Configuration Required Warning No One or more computers are using a policy that
968
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
defines multiple interface types where not all
interfaces have been mapped.
An appliance has reported a failure connecting
to the filter driver. This may indicate a
configuration issue with the filter driver running
Connection to Filter
Critical No on the ESXi or with the appliance. The
Driver Failure
appliance must be able to connect to the filter
driver in order to protect guests. The cause of
the issue should be investigated and resolved.
CPU Critical Threshold The CPU critical threshold has been
Critical No
Exceeded exceeded.
CPU Warning Threshold The CPU warning threshold has been
Warning No
Exceeded exceeded.
A duplicate computer has been activated or
Duplicate Computer imported. Please remove the duplicate
Warning Yes
Detected computer and reactivate the original computer
if necessary.
Duplicate Unique Duplicate UUIDs have been detected. Please
Warning No
Identifiers Detected remove the duplicate UUID.
These computers have been assigned an
Empty Relay Group empty relay group. Assign a different relay
Critical No
Assigned group to the computers or add relays to the
empty relay group(s).
The agent/appliance encountered an
unexpectedly high volume of events. As a
result, one or more events were not recorded
Events Suppressed Warning Yes
(suppressed) to prevent a potential denial of
service. Check the firewall events to determine
the cause of the suppression.
Some events were lost because the data file
grew too large for the agent/appliance to store.
This may have been caused by an unexpected
increase in the number of events being
Events Truncated Warning Yes generated, or the inability of the
agent/appliance to send the data to the Deep
Security Manager. For more information, see
the properties of the "Events Truncated"
system event on the computer.
Execution of software was blocked on one or
Execution of Software more computers. See the Application Control
Warning Yes
Blocked Events on the following computers for more
information.
Failed to Send The Deep Security Manager was unable to
Critical No
SNS Message forward messages to Amazon SNS
Failed to Send Syslog The Deep Security Manager was unable to
Warning No forward messages to one or more Syslog
Message
969
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
Servers.
Files could not be scanned for malware
because the file path exceeded the maximum
Files could not be file path length limit or the directory depth
Warning No
scanned for malware exceeded the maximum directory depth limit.
Please check the system events for the
computer to determine the reason.
Files could not be scanned for malware
because the file path exceeded the maximum
Files Could Not Be file path length limit or the directory depth
Warning No
Scanned for Malware exceeded the maximum directory depth limit.
Please check the system events for the
computer to determine the reason.
The agent/appliance has reported that the
Firewall Engine Offline Critical No firewall engine is offline. Please check the
status of the engine on the agent/appliance.
A firewall rule that is selected for alerting has
Firewall Rule Alert Warning Yes
been encountered on one or more computers.
Deep Security Manager has determined that a
computer on your network should be assigned
a firewall rule. This could be because an agent
was installed on a new computer and
vulnerable applications were detected, or
Firewall Rule because a new vulnerability has been
Warning Yes
Recommendation discovered in an installed application that was
previously thought to be safe. To assign the
firewall rule to the computer, open the
'Computer Details' dialog box, click on the
'Firewall Rules' node, and assign the firewall
rule.
The heartbeat server failed to start properly.
This may be due to a port number conflict.
Agents/appliances will not be able to contact
the manager until this problem is resolved. To
resolve this problem ensure that another
Heartbeat Server Failed Warning No service is not using the port number reserved
for use by the heartbeat server and "Restart the
Deep Security Manager" on page 1345
service. If you do not wish to use the heartbeat
you can turn this alert off in the Alert
Configuration section.
Deep Security Manager has detected a more
recent agent/appliance version on the
Incompatible
Error No computer that is not compatible with this
Agent/Appliance Version
version of the manager. An upgrade of the
manager software is recommended.
970
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
The agent/appliance has reported that it was
forced to delete an old log file to free up disk
space for a new log file. Please immediately
Insufficient Disk Space Warning Yes free up disk space to prevent loss of intrusion
prevention, firewall and agent/appliance
events. See "Warning: Insufficient disk space"
on page 1078.
The agent/appliance has reported that the
Integrity Monitoring integrity monitoring engine is not responding.
Critical No
Engine Offline Please check the system events for the
computer to determine the cause of the failure.
The rate at which integrity monitoring
information is collected has been temporarily
delayed due to an increased amount of
Integrity Monitoring
integrity monitoring data. During this time the
information collection Warning No
baseline and integrity event views may not be
has been delayed
current for some computers. This alert will be
dismissed automatically once integrity
monitoring data is no longer being delayed.
An integrity monitoring rule that is selected for
Integrity Monitoring Rule
Warning Yes alerting has been encountered on one or more
Alert
computers.
An error was encountered compiling an
Integrity Monitoring Rule integrity monitoring rule on a computer. This
Critical No
Compilation Error may result in the integrity monitoring rule not
operating as expected.
Deep Security Manager has determined that a
computer on your network should be assigned
an integrity monitoring rule. To assign the
Integrity Monitoring Rule integrity monitoring rule to the computer, open
Warning Yes
Recommendation the 'Computer Details' dialog box, click on the
'Integrity Monitoring > Integrity Monitoring
Rules' node, and assign the integrity
monitoring rule.
An integrity monitoring rule that requires
configuration before use has been assigned to
Integrity Monitoring Rule one or more computers. This rule will not be
Warning No
Requires Configuration sent to the computer(s). Open the integrity
monitoring rule properties and select the
Configuration tab for more information.
Integrity Monitoring Trusted platform module not enabled. Please
Trusted Platform Module Warning Yes ensure the hardware is installed and the BIOS
Not Enabled setting is correct.
Integrity Monitoring Trusted platform module register value
Trusted Platform Module Warning Yes changed. If you have not modified the ESXi
Register Value Changed hypervisor configuration this may represent an
971
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
attack.
The agent/appliance has reported that the
Intrusion Prevention intrusion prevention engine is offline. Please
Critical No
Engine Offline check the status of the engine on the
agent/appliance.
An intrusion prevention rule that is selected for
Intrusion Prevention Rule
Warning Yes alerting has been encountered on one or more
Alert
computers.
This is usually caused by a misconfigured IPS
Rule. The Rule name can be found in the
Intrusion Prevention Rule
Critical Yes Event's Properties window. To resolve this
Compilation Failed
issue, identify the Rule and unassign it or
contact Trend Micro Support for assistance.
An intrusion prevention rule that requires
configuration before use has been assigned to
Intrusion Prevention Rule one or more computers. This rule will not be
Warning No
Requires Configuration sent to the computer(s). Open the intrusion
prevention rule properties and select the
Configuration tab for more information.
Invalid System Settings The Deep Security Manager detected invalid
Critical No
Detected values for one or more system settings.
We have detected software whose version is
less than 9.5, and is no longer supported.
Legacy Agent Software Please import the latest software to replace it.
Warning Yes
Detected
For details, see "Get Deep Security Agent
software" on page 266.
Your Deep Security as a Service license has
expired. You will no longer receive updates,
including security updates, until your license is
License Expired Critical No
renewed. To ensure your security is
maintained, please contact your sales
representative to renew your license.
Your Deep Security as a Service license will
License Expiring Soon Warning No expire soon. Please contact your sales
representative to renew your license.
The agent/appliance has reported that the log
Log Inspection Engine inspection engine has failed to initialize.
Critical No
Offline Please check the system events for the
computer to determine the cause of the failure.
A log inspection rule that is selected for alerting
Log Inspection Rule Alert Warning Yes has been encountered on one or more
computers.
Log Inspection Rule Deep Security Manager has determined that a
Warning Yes
Recommendation
972
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
computer on your network should be assigned
a log inspection rule. To assign the log
inspection rule to the computer, open the
'Computer Details' dialog box, click on the 'Log
Inspection > Log Inspection Rules' node, and
assign the log inspection rule.
A log inspection rule that requires configuration
before use has been assigned to one or more
Log Inspection Rule computers. This rule will not be sent to the
Warning No
Requires Configuration computer(s). Open the Log Inspection Rule
properties and select the Configuration tab for
more information.
A Deep Security Manager Node has less than
10% remaining disk space. Please free space
Low Disk Space Warning No
by deleting old or unnecessary files, or add
more storage capacity.
A Deep Security Manager node is offline. It is
possible the computer has a hardware or
Manager Offline Warning No software problem, or has simply lost network
connectivity. Please check the status of the
manager's computer.
The clock on each manager node must be
synchronized with the clock on the database. If
Manager Time Out of the clocks are too far out of sync (more than 30
Critical No
Sync seconds) the manager node will not perform its
tasks correctly. Synchronize the clock on your
manager node with the clock on the database.
Memory Critical The memory critical threshold has been
Critical No
Threshold Exceeded exceeded.
Memory Warning The memory warning threshold has been
Warning No
Threshold Exceeded exceeded.
Maintenance mode is currently active for
application control on one or more computers.
While this mode is active, application control
continues to enforce block rules (if you
selected Block unrecognized software until it
is explicitly allowed), but will allow software
Maintenance Mode On Warning No
updates, and automatically add them to the
inventory part of the ruleset. When the software
update is finished for each computer, disable
maintenance mode so that unauthorized
software is not accidentally added to the
ruleset.
Setting "Network Engine Mode" to "Tap" is
Network Engine Mode only available on agent versions 5.2 or higher.
Warning No
Incompatibility Review and update the agent's configuration or
973
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
upgrade the agent to resolve the
incompatibility.
New patterns are available as part of a security
update. The patterns have been downloaded to
New Pattern Update is
Deep Security but have not yet been applied to
Downloaded and Warning No
your computers. To apply the update to your
Available
computers, go to the Administration > Updates
> Security page.
New rules are available as part of a security
update. The rules have been downloaded to
New Rule Update is Deep Security but have not yet been applied to
Downloaded and Warning No policies and sent to your computers. To apply
Available the update and send the updated policies to
your computers, go to the Administration >
Updates > Security page.
A new version of the Deep Security Manager is
Newer Version of Deep
available. Download the latest version from the
Security Manager is Warning No
Trend Micro Download Center at
Available
http://downloadcenter.trendmicro.com/
Newer Versions of New software is available. Software can be
Warning No
Software Available downloaded from the Download Center.
The number of activated computers has
exceeded the recommended limit for an
embedded database. Performance will
degrade rapidly if more computers are added
Number of Computers
Warning No and it is strongly suggested that another
exceeds database limit
database option (Oracle or SQL Server) be
considered at this point. Please contact Trend
Micro for more information on upgrading your
database.
Protection Module
Warning Yes The protection module license has expired.
Licensing Expired
The protection module licensing will expire
Protection Module soon. You can remove this alert by changing
Warning No
Licensing Expires Soon your license on the Administration > Licenses
page.
Deep Security Manager has determined that
the security configuration of one of your
computers should be updated. To see what
Recommendation Warning Yes changes are recommended, open the
Computer editor 1 and look through the module
pages for warnings of unresolved
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
974
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
recommendations. In the Assigned Rules area,
click Assign/Unassign to display the list of
available rules and then filter them using the
"Show Recommended for Assignment"
viewing filter option. (Select "Show
Recommended for Unassignment" to display
rules that can safely be unassigned.)
The agent or appliance detected an attempt to
identify the computer operating system via a
Reconnaissance "fingerprint" probe. Such activity is often a
Detected: Computer OS Warning Yes precursor to an attack that targets specific
Fingerprint Probe vulnerabilities. Check the computer's events to
see the details of the probe and see "Warning:
Reconnaissance Detected" on page 1079.
The agent or appliance detected network
activity typical of a network or port scan. Such
Reconnaissance activity is often a precursor to an attack that
Detected: Network or Warning Yes targets specific vulnerabilities. Check the
Port Scan computer's events to see the details of the
probe and see "Warning: Reconnaissance
Detected" on page 1079.
The agent or appliance detected a TCP "Null"
scan. Such activity is often a precursor to an
Reconnaissance attack that targets specific vulnerabilities.
Warning Yes
Detected: TCP Null Scan Check the computer's events to see the details
of the probe and see "Warning:
Reconnaissance Detected" on page 1079.
The agent or appliance detected a TCP
"SYNFIN" scan. Such activity is often a
Reconnaissance
precursor to an attack that targets specific
Detected: TCP SYNFIN Warning Yes
vulnerabilities. Check the computer's events to
Scan
see the details of the probe and see "Warning:
Reconnaissance Detected" on page 1079.
The agent or appliance detected a TCP
"Xmas" scan. Such activity is often a precursor
Reconnaissance
to an attack that targets specific vulnerabilities.
Detected: TCP Xmas Warning Yes
Check the computer's events to see the details
Scan
of the probe and see "Warning:
Reconnaissance Detected" on page 1079.
SAML Identity Provider One or more SAML Identity Provider Certificate
Critical No
Certificate expired (s) expired.
SAML Identity Provider One or more SAML Identity Provider Certificate
Warning No
Certificate expires soon (s) expire soon.
The agent has reported that the SAP Virus
SAP Virus Scan Adapter Scan Adapter is not installed. Check the
Critical No
is not installed system events for the computer to determine
975
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
the cause of the failure.
The agent has reported that the SAP Virus
SAP Virus Scan Adapter Scan Adapter is not up to date. Check the
Critical No
is not up to date system events for the computer to determine
the cause of the failure.
Scheduled malware scan tasks were initiated
on computers that already had pending scan
tasks. This may indicate a scanning frequency
Scheduled Malware
Warning No that is too high. Consider lowering the
Scan Missed
scanning frequency, or selecting fewer
computers to scan during each scheduled scan
job.
Inability to send policy may indicate a problem
Send Policy Failed Critical No with the agent/appliance. Please check the
affected computers.
Failed to connect to a Smart Protection Server.
Smart Protection Server
Warning Yes This could be due to a configuration issue, or
Connection Failed
due to network connectivity.
During ongoing file system monitoring,
application control detected that new software
had been installed, and it did not match any
configured allow or block rule. If your system
administrators did not install the software, and
Software Changes
Warning No no other users have permissions to install
Detected
software, this could indicate a security
compromise. If the software tries to launch,
depending on your lockdown configuration at
that time, it may or may not be allowed to
execute.
An agent software package is required for the
proper operation of one or more virtual
appliance(s). Please import a Red Hat
Software Package Not Enterprise Linux 6 (64 bit) agent software
Critical No
Found package with the correct version for each
appliance. If the required version is not
available then please import the latest package
and upgrade the appliance to match.
New software is available. To import new
Software Updates
Warning No software to Deep Security, go to Administration
Available for Import
> Updates > Software > Download Center.
Deep Security Manager has been unable to
query the agent/appliance for its status within
Unable to communicate Critical No the configured period. Please check your
network configuration and the affected
computer's connectivity.
Unable to Upgrade the Warning Yes Deep Security Manager was unable to upgrade
976
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
the agent software on the computer.
This may indicate a problem with the
agent/appliance, but it also can occur if agent
self-protection is enabled. On the Deep
Agent Software Security Manager, go to Computer editor 1 >
Settings > General. In Agent Self Protection,
and then either deselect Prevent local end-
users from uninstalling, stopping, or
otherwise modifying the Agent or enter a
password for local override.
Software changes detected on the file system
exceeded the maximum amount. Application
control will continue to enforce existing rules,
Unresolved software
Critical No but will not record any more changes, and it
change limit reached
will stop displaying any of that computer's
software changes. You must resolve and
prevent excessive software change.
Upgrade of the Deep Deep Security Manager has detected a
Security Manager computer that is using security updates that are
Software Recommended Warning No not compatible with the current version of Deep
(Incompatible Security Security Manager. An upgrade of Deep
Update(s)) Security Manager software is recommended.
Deep Security Manager has detected one or
Upgrade of the Filter more ESXi Servers with a version of the filter
Driver Recommended Warning No driver that does not match the latest version
(New Version Available) available. An upgrade of the filter driver is
recommended.
Users can be locked out manually, by repeated
incorrect sign-in attempts, if their password
User Locked Out Warning No
expires, or if they have been imported but not
yet unlocked.
The password expiry setting is enabled and
User Password Expires
Warning No one or more users have passwords that will
Soon
expire within the next 7 days.
Virtual Appliance is The appliance is incompatible with the filter
Incompatible With Filter Warning No driver. Please ensure both are upgraded to
Driver their latest versions.
Virtual Machine One or more of the virtual machines monitored
Warning No
Interfaces Out of Sync
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
977
Trend Micro Deep Security On-Premise 20
Default
Alert Dismissible Description
Severity
by a Deep Security Virtual Appliance has
reported that its interfaces are out of sync with
the filter driver. This means that the appliance
may not be properly monitoring the virtual
machine's interfaces. The virtual machine may
require manual intervention such as a
configuration change, or a restart, to correct the
issue.
A virtual machine was moved to an ESXi
Virtual Machine Moved to
Warning Yes Server that does not have an activated Deep
Unprotected ESXi Server
Security Virtual Appliance.
A virtual machine that was appliance-protected
has been unprotected during or after it was
Virtual Machine moved to another ESXi. This may be due to an
Unprotected after move Warning Yes appliance reboot or power off during the move,
to another ESXi or it may indicate a configuration issue. The
cause of the issue should be investigated
before the alert is dismissed.
A protected virtual machine in an NSX
VMware Tools Not environment does not have VMware Tools
Critical Yes
Installed installed. VMware Tools is required to protect
virtual machines in an NSX environment.
A web reputation event has been encountered
Web Reputation Event
Warning Yes on one or more computers that are selected for
Alert
alerting.
An agent was activated on one or more
Amazon WorkSpaces but WorkSpaces are not
enabled for your AWS account. To enable
WorkSpaces Disabled WorkSpaces, click 'Edit AWS Account' above,
Warning Yes
for AWS Account and select the 'Include Amazon WorkSpaces'
check box. Your WorkSpace(s) will be moved
into the WorkSpaces folder of the AWS
account.
Agent events
ID Severity Event Notes
Special Events
Unknown Agent/Appliance
0 Error
Event
Driver-Related Events
1000 Error Unable To Open Engine
1001 Error Engine Command Failed
978
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
1002 Warning Engine List Objects Error
1003 Warning Remove Object Failed
1004 Error Driver Upgrade Stalled
1005 Warning Upgrading Driver
Driver Upgrade Requires
1006 Error
Reboot
1007 Warning Driver Upgrade Succeeded
1008 Error Kernel Unsupported
Configuration-Related Events
2000 Info Policy Sent
Invalid Firewall Rule
2001 Warning
Assignment
Invalid Firewall Stateful
2002 Warning
Configuration
Save Security Configuration
2003 Error
Failed
2004 Warning Invalid Interface Assignment
2005 Warning Invalid Interface Assignment
2006 Warning Invalid Action
2007 Warning Invalid Packet Direction
2008 Warning Invalid Rule Priority
2009 Warning Unrecognized IP Format
2010 Warning Invalid Source IP List
2011 Warning Invalid Source Port List
2012 Warning Invalid Destination IP List
2013 Warning Invalid Destination Port List
2014 Warning Invalid Schedule
2015 Warning Invalid Source MAC List
2016 Warning Invalid Destination MAC List
2017 Warning Invalid Schedule Length
2018 Warning Invalid Schedule String
2019 Warning Unrecognized IP Format
2020 Warning Object Not Found
2021 Warning Object Not Found
2022 Warning Invalid Rule Assignment
2050 Warning Firewall Rule Not Found
2075 Warning Traffic Stream Not Found
Intrusion Prevention Rule
2076 Warning
Not Found
2077 Warning Pattern List Not Found
Traffic Stream Conversion
2078 Warning
Error
Conditional Firewall Rule
2080 Warning
Not Found
979
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
Conditional Intrusion
2081 Warning
Prevention Rule Not Found
Empty Intrusion Prevention
2082 Warning
Rule
Intrusion Prevention Rule
2083 Warning
XML Rule Conversion Error
2085 Error Security Configuration Error
2086 Warning Unsupported IP Match Type
Unsupported MAC Match
2087 Warning
Type
2088 Warning Invalid SSL Credential
2089 Warning Missing SSL Credential
2090 Error Security Configuration Error
2091 Error Security Configuration Error
Hardware-Related Events
3000 Warning Invalid MAC Address
3001 Warning Get Event Data Failed
3002 Warning Too Many Interfaces
Unable To Run External
3003 Error
Command
Unable To Read External
3004 Error
Command Output
3005 Error Operating System Call Error
3006 Error Operating System Call Error
3007 Error File Error
3008 Error Machine-Specific Key Error
Unexpected
3009 Error
Agent/Appliance Shutdown
Agent/Appliance Database
3010 Error
Error
3300 Warning Get Event Data Failed Linux error.
Get Security Configuration
3302 Warning Linux error.
Failed
3303 Error File Mapping Error Linux error. File type error.
Get Windows System
3600 Error
Directory Failed
3601 Warning Read Local Data Error Windows error.
3602 Warning Windows Service Error Windows error.
3603 Error File Mapping Error Windows error. File size error.
3700 Warning Abnormal Restart Detected Windows error.
System Last Boot Time
3701 Info Windows error.
Change
Communications-Related Events
4000 Warning Invalid Protocol Header Content length out of range.
980
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
4001 Warning Invalid Protocol Header Content length missing.
4002 Info Command Session Initiated
Configuration Session
4003 Info
Initiated
4004 Info Command Received
4011 Warning Failure to Contact Manager
4012 Warning Heartbeat Failed
Agent-Related Events
5000 Info Agent/Appliance Started
5001 Error Thread Exception
5002 Error Operation Timed Out
5003 Info Agent/Appliance Stopped
5004 Warning Clock Changed
Agent/Appliance Auditing
5005 Info
Started
Agent/Appliance Auditing
5006 Info
Stopped
Appliance Protection
5007 Info
Change
Filter Driver Connection
5008 Warning
Failed
Filter Driver Connection
5009 Info
Success
Filter Driver Informational
5010 Warning
Event
Protection Module
5100 Info
Deployment Started
Protection Module
5101 Info
Deployment Succeeded
Protection Module
5102 Error
Deployment Failed
Protection Module
5103 Info
Download Succeeded
Protection Module
5104 Info
Disablement Started
Protection Module
5105 Info
Disablement Succeeded
Protection Module
5106 Error
Disablement Failed
Agent Self-Protection
5107 Info
enabled
Agent Self-Protection
5108 Info
disabled
5109 Error FIPS verification Error
981
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
This error can occur if the public key required to
check the signature on the Trend Micro kernel
Secure Boot Public Key Not module is not successfully enrolled on the agent
5110 Error computer.
Enrolled
For details, see "Linux Secure Boot support for
agents" on page 1158.
Deep Security Agent does not support this OS with
Secure Boot 'On' Not Secure Boot enabled.
5111 Error
Supported
For details, see "Linux Secure Boot support for
agents" on page 1158.
5200 Info File Backup Completed
5201 Error Failure to Backup File
Logging-Related Events
6000 Info Log Device Open Error
6001 Info Log File Open Error
6002 Info Log File Write Error
6003 Info Log Directory Creation Error
6004 Info Log File Query Error
6005 Info Log Directory Open Error
6006 Info Log File Delete Error
6007 Info Log File Rename Error
6008 Info Log Read Error
Log File Deleted Due To
6009 Warning
Insufficient Space
6010 Warning Events Were Suppressed
6011 Warning Events Truncated
See "Warning: Insufficient disk space" on
6012 Error Insufficient Disk Space
page 1078.
Agent configuration package
6013 Warning
too large
Attack-, Scan-, and Probe-Related Events
Computer OS Fingerprint
7000 Warning
Probe
7001 Warning Network or Port Scan
7002 Warning TCP Null Scan
7003 Warning TCP SYNFIN Scan
7004 Warning TCP Xmas Scan
Download Security Update Events
Update of Anti-Malware
9050 Info Component on Agent
Succeeded
982
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
Update of Anti-Malware
9051 Error
Component on Agent Failed
9100 Info Security Update Successful
9101 Error Security Update Failure
9102 Error Security Update Failure Specific information recorded in error message.
Relay Events
9103 Info Relay Web Server Disabled
9104 Info Relay Web Server Enabled
Enable Relay Web Server
9105 Error
Failed
Disable Relay Web Server
9106 Error
Failed
9107 Error Relay Web Server failed
Unable to Connect to
9108 Info
Update Source
9109 Error Component Update Failure
Anti-Malware license is
9110 Error
expired
Security Update Rollback
9111 Info
Success
Security Update Rollback
9112 Error
Failure
Relay Replicated All
9113 Info
Packages
Relay Failed to Replicate All
9114 Error
Packages
Failed to download from the
9115 Info
Relay Web Server
Integrity Scan Status Events
9201 Info Integrity Scan Started
Integrity Scan Terminated
9203 Info
Abnormally
9204 Info Integrity Scan Paused
9205 Info Integrity Scan Resumed
9208 Warning Integrity Scan failed to start
9209 Warning Integrity Scan Stalled
Smart Protection Server Status Events
Smart Protection Server
See "Troubleshoot "Smart Protection Server
9300 Warning Disconnected for Web
disconnected" errors" on page 1055.
Reputation
Smart Protection Server
See "Troubleshoot "Smart Protection Server
9301 Info Connected for Web
disconnected" errors" on page 1055.
Reputation
Census, Good File
9302 Warning Reputation, and Predictive
983
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
Machine Learning Service
Disconnected
Census, Good File
Reputation, and Predictive
9303 Info
Machine Learning Service
Connected
System events
To view system events, go to Events & Reports > Events.
To configure system events, go to the Administration > System Settings > System Events tab.
On this tab you can set whether to record individual events and whether to forward them to a
SIEM server. If you select Record, then the event is saved to the database. If you deselect
Record, then the event won't appear under the Events & Reports tab (or anywhere in Deep
Security Manager) and it won't be forwarded either.
Depending on whether it's a system configuration change or security incident, each log will
appear in either the System Events sub-menu, or the sub-menu corresponding to the event's
protection module, such as Anti-Malware Events.
These events sometimes also appear in the Status column on Computers.
ID Severity Event Description or Solution
0 Error Unknown Error
Deep Security
100 Info
Manager Started
101 Info License Changed
Trend Micro Deep
102 Info Security Customer
Account Changed
Check For
103 Warning
Updates Failed
Automatic
104 Warning Software
Download Failed
Scheduled Rule
105 Warning Update Download
and Apply Failed
Scheduled Rule
Update
106 Info
Downloaded and
Applied
984
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Rule Update
107 Info Downloaded and
Applied
108 Info Script Executed
Script Execution
109 Error
Failed
System Events
110 Info
Exported
Firewall Events
111 Info
Exported
Intrusion
112 Info Prevention Events
Exported
Scheduled Rule
113 Warning Update Download
Failed
Scheduled Rule
114 Info Update
Downloaded
Rule Update
115 Info
Downloaded
Rule Update
116 Info
Applied
Deep Security
117 Info Manager
Shutdown
Deep Security
118 Warning
Manager Offline
Deep Security
119 Info Manager Back
Online
The server within Deep Security Manager that listens for
incoming agent heartbeats did not start. Check that the
Heartbeat Server manager's incoming heartbeat port number is not in use by
120 Error
Failed another application on the server. Once the port is free, the
manager's heartbeat server should bind to it, and this error
should be fixed.
121 Error Scheduler Failed
Manager Message An internal thread has failed. There is no resolution for this
122 Error
Thread Failed error. If it persists, please contact customer support.
Deep Security
123 Info Manager Forced
Shutdown
Rule Update
124 Info
Deleted
130 Info Credentials
985
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Generated
Credential
131 Warning
Generation Failed
Discover
140 Info
Computers
Discover
141 Warning
Computers Failed
Discover
142 Info Computers
Requested
Discover
143 Info Computers
Canceled
System Settings
150 Info
Saved
151 Info Software Added
152 Info Software Deleted
153 Info Software Updated
154 Info Software Exported
Software Platforms
155 Info
Changed
'<agent>.zip' has been deleted because the digital signature
verification failed. The failure indicates that the file may have
been tampered with. Details:
Agent Installer
156 Error Digital Signature <detailed_message>
Verification Failed
Please contact Trend Micro support for more help.
See "Check digital signatures on software packages" on
page 196 for details.
Authentication
160 Info
Failed
Rule Update
161 Info
Exported
Log Inspection
162 Info
Events Exported
Anti-Malware
163 Info
Event Exported
Security Update
164 Info
Successful
Security Update
165 Error
Failed
Check for New
166 Info
Software Success
986
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Check for New
167 Error
Software Failed
Manual Security
168 Info
Update Successful
Manual Security
169 Error
Update Failed
The manager does not have enough free disk space to
Manager Available
function and will shut down. Either expand the disk space or
170 Error Disk Space Too
delete unused files to free some disk space, then "Restart
Low
the Deep Security Manager" on page 1345.
Anti-Malware
171 Info Spyware Item
Exported
Web Reputation
172 Info
Events Exported
Anti-Malware
173 Info Identified Files List
Exported
Anti-Malware
Unauthorized
174 Info
Change Targeted
Item Exported
Creating Heap
175 Info
Dump
Heap Dump
176 Info
Created
Failed to create
177 Error
Heap Dump
Alert Type
180 Info
Updated
190 Info Alert Started
191 Info Alert Changed
192 Info Alert Ended
197 Info Alert Emails Sent
Alert Emails An alert email could not be sent. Verify that your SMTP
198 Warning
Failed settings are correct.
The current alert status could be inaccurate because an alert
Alert Processing
199 Error was not completely processed. If the problem persists,
Failed
contact your support provider.
Agent Integrity
247 Warning
Check Failed
Software Update:
248 Info Disable Relay
Requested
Software Update:
249 Info Enable Relay
987
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Requested
250 Info Computer Created
251 Info Computer Deleted
Computer
252 Info
Updated
Policy Assigned to
253 Info
Computer
254 Info Computer Moved
Activation
255 Info
Requested
Send Policy
256 Info
Requested
257 Info Locked
258 Info Unlocked
Deactivation
259 Info
Requested
Scan for Open
260 Info
Ports
Scan for Open
261 Warning
Ports Failed
Scan for Open
262 Info
Ports Requested
Scan for Open
263 Info
Ports Canceled
Agent Software
264 Info Upgrade
Requested
Agent Software
265 Info Upgrade
Cancelled
Warnings/Errors
266 Info
Cleared
Check Status
267 Info
Requested
Get Events
268 Info
Requested
Computer Added
269 Info to Cloud
Connector
Computer
270 Error
Creation Failed
Agent Software
271 Info Upgrade Timed
Out
272 Info Appliance
988
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Software Upgrade
Timed Out
Security Update:
Security Update
273 Info Check and
Download
Requested
Security Update:
Security Update
274 Info
Rollback
Requested
Duplicate
275 Warning
Computer
Update: Summary
276 Info
Information
The agent was eligible for an automatic upgrade, but the
Upgrade on
277 Info upgrade did not occur. For more information, see
Activation Skipped
"Automatically upgrade agents on activation" on page 1139.
Software Update:
Reboot to
278 Info
Complete Agent
Software Upgrade
Computers
280 Info
Exported
Computers
281 Info
Imported
Computer Log
286 Info
Exported
Relay Group
287 Info Assigned to
Computer
290 Info Group Added
291 Info Group Removed
292 Info Group Updated
Interface
293 Info
Renamed
Computer Bridge
294 Info
Renamed
295 Info Interface Deleted
Interface IP
296 Info
Deleted
Recommendation
297 Info
Scan Requested
Recommendations
298 Info
Cleared
299 Info Asset Value
989
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Assigned to
Computer
Recommendation
300 Info
Scan Completed
Agent Software
301 Info Deployment
Requested
Agent Software
302 Info Removal
Requested
Computer
303 Info
Renamed
The virtual machine (VM) was placed in its root data center
folder because Deep Security Manager couldn't determine
Computer Moved the VM's parent folder due to a permission issue. To have
304 Info
To Datacenter the VM appear in the correct folder in Deep Security
Manager, check the permissions of the VM on the vCenter
server.
Scan for Integrity
305 Info
Requested
Rebuild Baseline
306 Info
Requested
Cancel Update
307 Info
Requested
Integrity
308 Info Monitoring Rule
Compile Issue
Integrity
Monitoring Rule
309 Info
Compile Issue
Resolved
310 Info Directory Added
Directory
311 Info
Removed
312 Info Directory Updated
Directory
320 Info
Synchronization
Directory
321 Info Synchronization
Finished
Directory
322 Error Synchronization
Failed
Directory
323 Info Synchronization
Requested
990
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Directory
324 Info Synchronization
Cancelled
User Synchronization of the user accounts with Microsoft Active
325 Info
Synchronization Directory has been started.
User
Synchronization of the user accounts with Microsoft Active
326 Info Synchronization
Directory has completed.
Finished
User
327 Error Synchronization
Failed
User
328 Info Synchronization
Requested
User
329 Info Synchronization
Cancelled
SSL Configuration
330 Info
Created
SSL Configuration
331 Info
Deleted
SSL Configuration
332 Info
Updated
Host Merge
333 Info
Finished
334 Error Host Merge Failed
Directory Reached the limit of total group members for Active Directory
338 Warning Synchronization synchronization. Skipping any remaining members.
Limit Exceeded Consider adjusting the limit in the system setting.
350 Info Policy Created
351 Info Policy Deleted
352 Info Policy Updated
353 Info Policies Exported
354 Info Policies Imported
Scan for
355 Info Recommendations
Canceled
This error can occur if the public key required to check the
signature on the Trend Micro kernel module is not
Secure Boot
356 Error Public Key Not successfully enrolled on the agent computer.
Enrolled
For details, see "Linux Secure Boot support for agents" on
page 1158.
Secure Boot 'On'
357 Error Deep Security Agent does not support this OS with Secure
Not Supported
991
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Boot enabled.
For details, see "Linux Secure Boot support for agents" on
page 1158.
VMware vCenter
360 Info
Added
VMware vCenter
361 Info
Removed
VMware vCenter
362 Info
Updated
VMware vCenter
363 Info
Synchronization
VMware vCenter
364 Info Synchronization
Finished
VMware vCenter
365 Error Synchronization
Failed
VMware vCenter
366 Info Synchronization
Requested
VMware vCenter
367 Info Synchronization
Cancelled
Interfaces reported by the Deep Security Virtual Appliance
Interfaces Out of
368 Warning are different than the interfaces reported by the vCenter. This
Sync
can typically be resolved by rebooting the VM.
369 Info Interfaces in Sync
Filter Driver
370 Info
Installed
Filter Driver The VMware ESXi server has been restored to the state it
371 Info
Removed was in before the filter driver software was installed.
Filter Driver
372 Info
Upgraded
Virtual Appliance
373 Info
Deployed
Virtual Appliance
374 Info
Upgraded
Virtual Appliance
375 Warning
Upgrade Failed
Virtual Machine
376 Warning Moved to
Unprotected ESXi
Virtual Machine
377 Info Moved to
992
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Protected ESXi
Virtual Machine
unprotected after A VM was moved to an ESXi where there is no Deep
378 Warning
move to another Security Virtual Appliance.
ESXi
Virtual Machine
unprotected after
379 Info
move to another
ESXi Resolved
The filter driver on an ESXi server is offline. Use the VMware
380 Error Filter Driver Offline vCenter console to troubleshoot problems with the
hypervisor and the ESXi.
Filter Driver Back
381 Info
Online
Filter Driver
382 Info Upgrade
Requested
Appliance
383 Info Upgrade
Requested
Prepare ESXi
384 Warning
Failed
Filter Driver
385 Warning
Upgrade Failed
Removal of Filter
386 Warning Driver from ESXi
Failed
Connection to
387 Error Filter Driver
Failure
Connection to
388 Info Filter Driver
Success
Multiple Activated
389 Error Appliances
Detected
Multiple Activated
Appliances
390 Info
Detected
Resolved
Network Settings
Out of Sync With
391 Error
vCenter Global
Settings
Network Settings
392 Info in Sync With
993
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
vCenter Global
Settings
The anti-malware protection module is not functioning. This
Anti-Malware
393 Error is probably because the VMware environment does not meet
Engine Offline
the requirements. See "System requirements" on page 165.
Anti-Malware
394 Info Engine Back
Online
Virtual Appliance
395 Error is Incompatible
With Filter Driver
Virtual Appliance
is Incompatible
396 Info
With Filter Driver
Resolved
VMware NSX
Callback
397 Warning
Authentication
Failed
VMware Tools Not
398 Error
Installed
VMware Tools Not
399 Info
Installed Resolved
Firewall Rule
410 Info
Created
Firewall Rule
411 Info
Deleted
Firewall Rule
412 Info
Updated
Firewall Rule
413 Info
Exported
Firewall Rule
414 Info
Imported
Firewall Stateful
420 Info Configuration
Created
Firewall Stateful
421 Info Configuration
Deleted
Firewall Stateful
422 Info Configuration
Updated
Firewall Stateful
423 Info Configuration
Exported
424 Info Firewall Stateful
994
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Configuration
Imported
Application Type An administrator configured a new IPS network application
460 Info
Created definition.
Application Type An administrator removed an IPS network application
461 Info
Deleted definition.
Application Type An administrator changed an existing IPS network
462 Info
Updated application definition.
Application Type An administrator downloaded an IPS network application
463 Info
Exported definition.
Application Type An administrator uploaded an IPS network application
464 Info
Imported definition.
Intrusion
470 Info Prevention Rule
Created
Intrusion
471 Info Prevention Rule
Deleted
Intrusion
472 Info Prevention Rule
Updated
Intrusion
473 Info Prevention Rule
Exported
Intrusion
474 Info Prevention Rule
Imported
Integrity
480 Info Monitoring Rule
Created
Integrity
481 Info Monitoring Rule
Deleted
Integrity
482 Info Monitoring Rule
Updated
Integrity
483 Info Monitoring Rule
Exported
Integrity
484 Info Monitoring Rule
Imported
Log Inspection
490 Info
Rule Created
Log Inspection
491 Info
Rule Deleted
995
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Log Inspection
492 Info
Rule Updated
Log Inspection
493 Info
Rule Exported
Log Inspection
494 Info
Rule Imported
Log Inspection
495 Info
Decoder Created
Log Inspection
496 Info
Decoder Deleted
Log Inspection
497 Info
Decoder Updated
Log Inspection
498 Info
Decoder Exported
Log Inspection
499 Info
Decoder Imported
505 Info Context Created
506 Info Context Deleted
507 Info Context Updated
508 Info Context Exported
509 Info Context Imported
510 Info IP List Created
511 Info IP List Deleted
512 Info IP List Updated
513 Info IP List Exported
514 Info IP List Imported
520 Info Port List Created
521 Info Port List Deleted
522 Info Port List Updated
523 Info Port List Exported
524 Info Port List Imported
Scan Cache
525 Info Configuration
Created
Scan Cache
526 Info Configuration
Exported
Scan Cache
527 Info Configuration
Updated
530 Info MAC List Created
531 Info MAC List Deleted
532 Info MAC List Updated
533 Info MAC List Exported
534 Info MAC List Imported
996
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
540 Info Proxy Created
541 Info Proxy Deleted
542 Info Proxy Updated
543 Info Proxy Exported
544 Info Proxy Imported
550 Info Schedule Created
551 Info Schedule Deleted
552 Info Schedule Updated
Schedule
553 Info
Exported
554 Info Schedule Imported
Scheduled Task
560 Info
Created
Scheduled Task
561 Info
Deleted
Scheduled Task
562 Info
Updated
Scheduled Task
563 Info Manually
Executed
Scheduled Task
564 Info
Started
565 Info Backup Finished
566 Error Backup Failed
Sending
567 Info Outstanding Alert
Summary
Failed To Send
568 Warning Outstanding Alert
Summary
An e-mail notification could not be sent. Verify that your
569 Warning Email Failed
SMTP settings are correct.
570 Info Sending Report
Failed To Send
571 Warning
Report
572 Error Invalid Report Jar
Asset Value
573 Info
Created
Asset Value
574 Info
Deleted
Asset Value
575 Info
Updated
Report Uninstall
576 Error
Failed
997
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
577 Error Report Uninstalled
Integrity
Monitoring Rules
578 Warning
Require
Configuration
Application Type
580 Warning Port List
Misconfiguration
Application Type
Port List
581 Warning
Misconfiguration
Resolved
Intrusion
Prevention Rules
582 Warning
Require
Configuration
Intrusion
Prevention Rules
583 Info Require
Configuration
Resolved
Application Types
IPS rules require network application definitions, and cannot
584 Warning Require
correctly scan traffic until you define them.
Configuration
Integrity
Monitoring Rules
585 Info Require
Configuration
Resolved
Log Inspection
586 Warning Rules Require
Configuration
Log Inspection
Rules Require
587 Info
Configuration
Resolved
Log Inspection
588 Warning Rules Require Log
Files
Log Inspection
589 Info Rules Require Log
Files Resolved
Scheduled Task
590 Warning
Unknown Type
Relay Group
591 Info
Created
998
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Relay Group
592 Info
Updated
Relay Group
593 Info
Deleted
Event-Based Task
594 Info
Created
Event-Based Task
595 Info
Deleted
Event-Based Task
596 Info
Updated
Event-Based Task
597 Info
Triggered
600 Info User Signed In
601 Info User Signed Out
602 Info User Timed Out
603 Info User Locked Out
604 Info User Unlocked
User Session
605 Info
Terminated
Deep Security Manager could not confirm that a session was
initiated after successful authentication. The user will be
User Session
608 Error redirected to the login page, and asked to re-authenticate.
Validation Failed
This could be normal if the authenticated session list was
cleared.
User Made Invalid Deep Security Manager received invalid request to access
609 Error
Request audit data (events). Access was denied.
User Session
610 Info
Validated
User Viewed
611 Info
Firewall Event
User Viewed
613 Info Intrusion
Prevention Event
User Viewed
615 Info
System Event
User Viewed
616 Info Integrity
Monitoring Event
User Viewed Log
617 Info
Inspection Event
User Viewed
618 Info Identified File
Detail
User Viewed Anti-
619 Info
Malware Event
999
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
User Viewed Web
620 Info
Reputation Event
User Signed In As
621 Info
Tenant
Access from
622 Info Primary Tenant
Enabled
Access from
623 Info Primary Tenant
Disabled
Access from
624 Info Primary Tenant
Allowed
Access from
625 Info Primary Tenant
Revoked
Access from
626 Info Primary Tenant
Expired
Syslog
630 Info Configuration
Created
Syslog
631 Info Configuration
Deleted
Syslog
632 Info Configuration
Updated
Syslog
633 Info Configuration
Exported
Syslog
634 Info Configuration
Imported
650 Info User Created
651 Info User Deleted
652 Info User Updated
User Password
653 Info
Set
656 Info API Key Created
657 Info API Key Deleted
658 Info API Key Updated
660 Info Role Created
661 Info Role Deleted
662 Info Role Updated
1000
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
663 Info Roles Imported
664 Info Roles Exported
670 Info Contact Created
671 Info Contact Deleted
672 Info Contact Updated
API Key Locked
673 Info
Out
674 Info API Key Unlocked
API Key Session
675 Error
Validation Failed
API Key Made
676 Error
Invalid Request
678 Info API Key Expired
Created master
680 Info For details, see the masterkey parameter.
encryption key
Exported master
681 Info For details, see the masterkey parameter.
encryption key
Imported master
682 Info For details, see the masterkey parameter.
encryption key
Microservice API
690 Info
Key Created
Microservice API
691 Info
Key Deleted
Microservice API
692 Info
Key Updated
Microservice API
693 Info
Key Locked Out
Microservice API
694 Info
Key Unlocked
Microservice API
695 Error Key Session
Validation Failed
Microservice API
696 Info
Key Expired
Agent Software
700 Info
Installed
Agent Software
701 Error
Installation Failed
Credentials
702 Info
Generated
Credential
703 Error
Generation Failed
704 Info Activated
1001
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
This can occur if agent self-protection is enabled. On the
Deep Security Manager, go to Computer editor 1 > Settings
705 Error Activation Failed > General. In Agent Self Protection, and then either
deselect Prevent local end-users from uninstalling,
stopping, or otherwise modifying the Agent or enter a
password for local override.
Software Update:
706 Info Agent Software
Upgraded
Software Update:
Refer to the event details for more information about why the
707 Warning Agent Software
upgrade was not successful.
Upgrade Failed
708 Info Deactivated
Deactivation
709 Error
Failed
710 Info Events Retrieved
Agent Software
711 Info
Deployed
This can occur if agent self-protection is enabled. On the
Agent Software Deep Security Manager, go to Computer editor 2 > Settings
712 Error Deployment > General. In Agent Self Protection, and then either
Failed deselect Prevent local end-users from uninstalling,
stopping, or otherwise modifying the Agent or enter a
password for local override.
Agent Software
713 Info
Removed
This can occur if agent self-protection is enabled. On the
Deep Security Manager, go to Computer editor 3 > Settings
Agent Software > General. In Agent Self Protection, and then either
714 Error
Removal Failed deselect Prevent local end-users from uninstalling,
stopping, or otherwise modifying the Agent or enter a
password for local override.
Agent/Appliance
715 Info
Version Changed
Reactivation An agent that is currently unknown to the Deep Security
716 Info Attempted by Manager has attempted reactivation. This usually happens
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
2To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
3To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
1002
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
when a computer was deleted from Deep Security Manager
without first removing the agent on the computer. For more
Unknown Agent
information, see the 'Reactivation Attempted by Unknown
Agent' section in Agent settings.
720 Info Policy Sent Agent/Appliance updated.
Send Policy
721 Error
Failed
Get Interfaces
722 Warning
Failed
Get Interfaces
723 Info
Failure Resolved
An agent detected low disk space. Free space on the
Insufficient Disk
724 Warning computer. See "Warning: Insufficient disk space" on
Space
page 1078.
Events
725 Warning
Suppressed
Manager was unable to retrieve Events from
Agent/Appliance. This error does not mean that the data was
Get
lost on the Agent/Appliance. This error is normally caused by
726 Warning Agent/Appliance
a network interruption while events are being transferred.
Events Failed
Clear the error and run a "Check Status" to retry the
operation.
Get
Agent/Appliance
727 Info
Events Failure
Resolved
Manager was unable to retrieve audit data from
Agent/Appliance. This error does not mean that the data was
lost on the Agent/Appliance. This error is normally caused by
728 Error Get Events Failed
a network interruption while events are being transferred.
Clear the error and run a "Get Events Now" to retry the
operation.
Get Events Failure
729 Info
Resolved
Manager cannot communicate with Computer. Usually,
however, the offline Agent is still protecting the computer
730 Error Offline
with its last configured settings. See Computer and
Agent/Appliance Status and ""Offline" agent" on page 1519.
731 Info Back Online
The Firewall Engine is offline and traffic is flowing unfiltered.
This is normally due to an error during installation or
Firewall Engine
732 Error verification of the driver on the computer's OS platform.
Offline
Check the status of the network driver at the computer to
ensure it is properly loaded.
Firewall Engine
733 Info
Back Online
1003
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
A clock change has occurred on the Computer which
exceeds the maximum allowed specified in Computer or
Computer Clock
734 Warning
Change Policy editor 1 > Settings > General > Heartbeat area.
Investigate what has caused the clock change on the
computer.
The Agent's configuration does not match the configuration
indicated in the Manager's records. This is typically because
Misconfiguration
735 Warning of a recent backup restoration of the Manager or the Agent.
Detected
Unanticipated misconfiguration warnings should be
investigated.
Check Status
736 Info
Failure Resolved
Check Status
737 Error See "Error: Check Status Failed" on page 1062.
Failed
The Intrusion Prevention Engine is offline and traffic is
Intrusion flowing unfiltered. This is normally due to an error during
738 Error Prevention Engine installation or verification of the driver on the computer's OS
Offline platform. Check the status of the network driver at the
computer to ensure it is properly loaded.
Intrusion
739 Info Prevention Engine
Back Online
Agent/Appliance
740 Error
Error
Abnormal Restart
741 Warning
Detected
The Agent is having problems communicating its status to
Communications Manager. It usually indicates network or load congestion in
742 Warning
Problem the Agent --> Manager direction. Further investigation is
warranted if the situation persists
Communications
743 Info
Problem Resolved
745 Warning Events Truncated
Log Inspection
748 Error
Engine Offline
Log Inspection
749 Info Engine Back
Online
Last Automatic
750 Warning
Retry
755 Info Deep Security
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1004
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Manager Version
Compatibility
Resolved
Each security module rule (such as Firewall, Anti-Malware,
Deep Security and the others) has a specific minimum Deep Security
Manager Upgrade
Recommended Manager version that's required in order for the rule to run.
756 Warning
(Incompatible
Security Update Your current Deep Security Manager version is less than the
(s)) rule's minimum supported version. Upgrade your Deep
Security Manager to clear the warning and run the rule.
Agent/Appliance
Version
760 Info
Compatibility
Resolved
Agent/Appliance
761 Warning Upgrade
Recommended
Your current Deep Security Agent or Deep Security Virtual
Agent/Appliance
762 Warning
Upgrade Required Appliance version is less than the Deep Security Manager's
minimum supported version. Upgrade your Agent/Appliance.
Incompatible Your current Deep Security Manager version is less than the
763 Error Agent/Appliance Deep Security Agent or Deep Security Virtual Appliance's
Version minimum supported version. Upgrade your manager.
Each security module rule (such as Firewall, Anti-Malware,
and the others) has a specific minimum Deep Security Agent
Agent/Appliance or Deep Security Virtual Appliance version that's required in
Upgrade order for the rule to run.
Recommended
764 Warning Your current Deep Security Agent or Deep Security Virtual
(Incompatible
Security Update Appliance version is less than the rule's minimum supported
(s))
version. Upgrade your Deep Security Agent or Deep
Security Virtual Appliance to clear the warning and run the
rule.
Computer Reboot
765 Error
Required
Network Engine
Mode
766 Warning
Configuration
Incompatibility
Network Engine
767 Warning Mode Version
1005
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Incompatibility
Network Engine
Mode
768 Warning
Incompatibility
Resolved
Agent/Appliance
770 Warning Heartbeat
Rejected
Contact by
See "Troubleshoot event ID 771 "Contact by Unrecognized
771 Warning Unrecognized
Client"" on page 1054.
Client
Recommendation
780 Info Scan Failure
Resolved
Recommendation See "Troubleshooting: Recommendation Scan Failure" on
781 Warning
Scan Failure page 466.
Rebuild Baseline
782 Info
Failure Resolved
Rebuild Baseline
783 Warning
Failure
Security Update:
Security Update
784 Info Check and
Download
Successful
Security Update:
Security Update
785 Warning
Check and
Download Failed
Scan For Change
786 Info
Failure Resolved
Scan For Change
787 Warning
Failure
Agent-Initiated
790 Info Activation
Requested
Agent-Initiated
791 Warning
Activation Failure
Manual Malware
792 Info Scan Failure
Resolved
A Malware Scan has failed. Use the VMware vCenter
Manual Malware console to check the status of the VM on which the scan
793 Warning
Scan Failure failed. See also "Anti-Malware scan failures and
cancellations" on page 833.
794 Info Scheduled
1006
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Malware Scan
Failure Resolved
A scheduled Malware Scan has failed. Use the VMware
Scheduled
vCenter console to check the status of the VM on which the
795 Warning Malware Scan
scan failed. See also "Anti-Malware scan failures and
Failure
cancellations" on page 833.
Scheduled This occurs when a scheduled Malware Scan is initiated on
Malware Scan a computer when a previous scan is still pending. This
796 Warning
Task has been typically indicates that Malware Scans are being scheduled
Missed too frequently.
Malware Scan
797 Info Cancellation
Failure Resolved
Malware Scan A Malware Scan cancellation has failed. Use the VMware
798 Warning Cancellation vCenter console to check the status of the VM on which the
Failure scan failed.
A Malware Scan has stalled. Use the VMware vCenter
Malware Scan
799 Warning console to check the status of the VM on which the scan
Stalled
stalled.
800 Info Alert Dismissed
801 Info Error Dismissed
Agent
803 Warning Configuration
Package too Large
Intrusion
804 Error Prevention Rule
Compiler Failed
Intrusion
805 Error Prevention Rules
Failed to Compile
Intrusion
806 Error Prevention Rules
Failed to Compile
Reconnaissance
Detected:
850 Warning See "Warning: Reconnaissance Detected" on page 1079
Computer OS
Fingerprint Probe
Reconnaissance
851 Warning Detected: Network See "Warning: Reconnaissance Detected" on page 1079
or Port Scan
Reconnaissance
852 Warning Detected: TCP See "Warning: Reconnaissance Detected" on page 1079
Null Scan
Reconnaissance
853 Warning Detected: TCP See "Warning: Reconnaissance Detected" on page 1079
SYNFIN Scan
1007
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Reconnaissance
854 Warning Detected: TCP See "Warning: Reconnaissance Detected" on page 1079
Xmas Scan
Deep Security
900 Info Manager Audit
Started
Deep Security
901 Info Manager Audit
Shutdown
Deep Security
902 Info
Manager Installed
License Related
903 Warning Configuration
Change
Diagnostic
904 Info
Logging Enabled
Diagnostic
905 Info Logging
Completed
Diagnostic
910 Info Package
Generated
Diagnostic
911 Info
Package Exported
Diagnostic
912 Info Package
Uploaded
Automatic
913 Error Diagnostic
Package Error
Identified File
914 Info Deletion
Succeeded
Identified File
915 Info
Deletion Failed
Identified File
916 Info Download
Succeeded
Identified File
917 Info
Download Failed
Identified File
Administration
918 Info
Utility Download
Succeeded
Identified File Not
919 Info
Found
1008
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Usage Information
920 Info
Generated
Usage Information
921 Info
Package Exported
Usage Information
922 Info Package
Uploaded
Usage Information
923 Error
Package Error
File cannot be
The Anti-Malware module was unable to analyze or
analyzed or
quarantine a file because the VM maximum disk space used
quarantined (VM
to store identified files was reached. To change the
924 Warning maximum disk
maximum disk space for identified files setting, open the
space used to
computer or policy editor and go to the Anti-malware >
store identified
Advanced tab.
files exceeded)
File cannot be
analyzed or The Anti-Malware module was unable to analyze or
quarantined quarantine a file because the maximum disk space used to
925 Warning (maximum disk store identified files was reached. To change the maximum
space used to disk space for identified files setting, open the computer or
store identified policy editor and go to the Anti-malware > Advanced tab.
files exceeded)
Smart Protection
Server See "Troubleshoot "Smart Protection Server disconnected"
926 Warning
Disconnected for errors" on page 1055.
Smart Scan
Smart Protection
927 Info Server Connected
for Smart Scan
Identified File
928 Info Restoration
Succeeded
Identified File
929 Warning
Restoration Failed
Certificate
930 Info
Accepted
931 Info Certificate Deleted
Smart Protection
Server See "Troubleshoot "Smart Protection Server disconnected"
932 Warning
Disconnected for errors" on page 1055.
Web Reputation
Smart Protection
Server Connected
933 Info
for Web
Reputation
1009
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Software Update:
Anti-Malware
934 Info
Windows Platform
Update Successful
Software Update:
Anti-Malware See "Anti-Malware Windows platform update failed" on
935 Error
Windows Platform page 1525
Update Failed
Submission of
identified file to
936 Info Deep Discovery
Analyzer
succeeded
Submission of
identified file to
937 Info
Deep Discovery
Analyzer failed
Identified File
938 Info Submission
Queued
Auto-Tag Rule
940 Info
Created
Auto-Tag Rule
941 Info
Deleted
Auto-Tag Rule
942 Info
Updated
943 Info Tag Deleted
944 Info Tag Created
Census, Good File
Reputation, and
Predictive
945 Warning
Machine Learning
Service
Disconnected
Census, Good File
Reputation, and
Predictive
946 Info
Machine Learning
Service
Connected
FIPS Mode
947 Info
Enabled
FIPS Mode
948 Info
Disabled
Computer reboot A computer reboot is required to complete the Deep Security
949 Warning is required to
Agent installation with Windows installer.
1010
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
complete the Deep
Security Agent
installation with
Windows installer
A computer reboot
is required to
A computer reboot is required to disable Windows Defender
950 Warning enable Deep
and enable Deep Security Agent protection.
Security Agent
protection
Command Line
970 Info
Utility Started
Command Line
978 Info
Utility Failed
Command Line
979 Info Deep Security Manager was manually stopped.
Utility Shutdown
System
980 Info Information
Exported
Manager Node
990 Info
Added
Manager Node
991 Info
Decommissioned
Manager Node
992 Info
Updated
Connection to the
Certified Safe
995 Info
Software Service
has been restored
Unable to connect
to the Certified
996 Warning
Safe Software
Service
997 Error Tagging Error
System Event
998 Error
Notification Error
Internal Software
999 Error
Error
Plug-in Installation
1101 Error
Failed
1102 Info Plug-in Installed
Plug-in Upgrade
1103 Error
Failed
1104 Info Plug-in Upgraded
Plug-in Start
1105 Error
Failed
1106 Error Plug-in Uninstall
1011
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Failed
Plug-in
1107 Info
Uninstalled
1108 Info Plug-in Started
1109 Info Plug-in Stopped
Software Package Agent software package was not found or a newer package
1110 Error
Not Found is required.
Software Package
1111 Info
Found
The Linux driver cannot be installed because your computer
Kernel may have been upgraded to an unsupported kernel. For
1112 Error
Unsupported more information, see "Deep Security Agent Linux kernel
support" on page 143.
Malware Scan
1500 Info Configuration
Created
Malware Scan
1501 Info Configuration
Deleted
Malware Scan
1502 Info Configuration
Updated
Malware Scan
1503 Info Configuration
Exported
Malware Scan
1504 Info Configuration
Imported
Directory List
1505 Info
Created
Directory List
1506 Info
Deleted
Directory List
1507 Info
Updated
Directory List
1508 Info
Exported
Directory List
1509 Info
Imported
File Extension List
1510 Info
Created
File Extension List
1511 Info
Deleted
File Extension List
1512 Info
Updated
File Extension List
1513 Info
Exported
1012
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
File Extension List
1514 Info
Imported
1515 Info File List Created
1516 Info File List Deleted
1517 Info File List Updated
1518 Info File List Exported
1519 Info File List Imported
Manual Malware
1520 Info
Scan Pending
Manual Malware
1521 Info
Scan Started
Manual Malware
1522 Info
Scan Completed
Scheduled
1523 Info Malware Scan
Started
Scheduled
1524 Info Malware Scan
Completed
Manual Malware
1525 Info Scan Cancellation
In Progress
Manual Malware This event can have several causes. See "Anti-Malware
1526 Info
Scan Cancellation scan failures and cancellations" on page 833.
Scheduled
Malware Scan
1527 Info
Cancellation In
Progress
Scheduled
This event can have several causes. See "Anti-Malware
1528 Info Malware Scan
scan failures and cancellations" on page 833.
Cancellation
Manual Malware
1529 Info
Scan Paused
Manual Malware
1530 Info
Scan Resumed
Scheduled
1531 Info Malware Scan
Paused
Scheduled
1532 Info Malware Scan
Resumed
A computer reboot
is required to
A computer reboot is required to complete an Anti-Malware
1533 Info complete an Anti-
cleanup or restoration task.
Malware cleanup
or restoration task
1013
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Computer reboot
required for Anti-
1534 Error
Malware
protection
Anti-Malware
cleanup task must
1535 Info
be performed
manually
Quick Malware
1536 Info
Scan Pending
Quick Malware
1537 Info
Scan Started
Quick Malware
1538 Info
Scan Completed
Quick Malware
1539 Info Scan Cancellation
In Progress
Quick Malware This event can have several causes. See "Anti-Malware
1540 Info
Scan Cancellation scan failures and cancellations" on page 833.
Quick Malware
1541 Info
Scan Paused
Quick Malware
1542 Info Scan Failure
Resolved
Quick Malware See "Anti-Malware scan failures and cancellations" on
1543 Warning
Scan Failure page 833.
Quick Malware
1544 Info
Scan Resumed
Anti-malware could not scan a file because its file path
Files could not be exceeded the maximum number of characters. Maximum file
1545 Info scanned for path length varies by OS and file system. To prevent this
malware problem, try moving the file to a directory path and file name
with fewer characters.
Anti-malware could not scan a file because its location
Files could not be
exceeded the maximum directory depth. To prevent this
1546 Info scanned for
problem, try reducing the number of layers of nested
malware
directories.
Scheduled
Malware Scan
1547 Info
Task has been
cancelled
Web Reputation
1550 Info
Settings Updated
Malware Scan
1551 Info Configuration
1014
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Updated
Integrity
1552 Info Configuration
Updated
Log Inspection
1553 Info Configuration
Updated
Firewall Stateful
1554 Info Configuration
Updated
Intrusion
Prevention
1555 Info
Configuration
Updated
Relay Group
1600 Info
Update Requested
Relay Group
1601 Info
Update Success
Relay Group
1602 Error
Update Failed
Security Update:
1603 Info Security Update
Rollback Success
Security Update:
1604 Warning Security Update
Rollback Failure
Successfully send
1605 Info file back up
command to host
Failed to send file
1606 Warning back up command
to host
Successfully back
1607 Info
up file
Failed to back up
1608 Error
file
Anti-Malware
protection is not
1650 Warning
enabled or is out
of date
Anti-Malware
1651 Info
module is ready
Rebuild Baseline
1660 Info
Started
Rebuild Baseline
1661 Info
Paused
1015
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Rebuild Baseline
1662 Info
Resumed
Rebuild Baseline
1663 Warning
Failure
Rebuild Baseline
1664 Warning
Stalled
Rebuild Baseline
1665 Info
Completed
Scan for Integrity
1666 Info
Started
Scan for Integrity
1667 Info
Paused
Scan for Integrity
1668 Info
Resumed
Scan for Integrity
1669 Warning
Failure
Scan for Integrity
1670 Warning
Stalled
Scan for Integrity
1671 Info
Completed
Integrity
1675 Error Monitoring Engine
Offline
Integrity
1676 Info Monitoring Engine
Back Online
Trusted Platform
1677 Error
Module Error
Trusted Platform
1678 Info Module Register
Values Loaded
Trusted Platform
1679 Warning Module Register
Values Changed
Trusted Platform
1680 Info Module Checking
Disabled
Trusted Platform
Module
1681 Info
Information
Unreliable
No Agent
1700 Info
Detected
Deep Security
1800 Error Protection Module
Failure
1016
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Deep Security
1801 Info Protection Module
Back to Normal
Cloud Account
1900 Info
Added
Cloud Account
1901 Info
Removed
Cloud Account
1902 Info
Updated
Cloud Account
1903 Info Synchronization In
Progress
Cloud Account
1904 Info Synchronization
Finished
Cloud Account
1905 Error Synchronization
Failed
Cloud Account
1906 Info Synchronization
Requested
Cloud account
1907 Info Synchronization
Cancelled
AWS Account
1908 Info Synchronization
Requested
AWS Account
1909 Info Synchronization
Finished
AWS Account
1910 Error Synchronization
Failed
AWS Account
1911 Info
Added
AWS Account
1912 Info
Removed
AWS Account
1913 Info
Updated
Azure Account
1914 Info
Added
Azure Account
1915 Info
Removed
Azure Account
1916 Info
Updated
1917 Info Azure Account
1017
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Synchronization
Finished
Azure Account
1918 Error Synchronization
Failed
Azure Account
1919 Info Synchronization
Requested
Azure Account
Synchronization
1920 Warning
Completed but
with Errors
vCloud Account
1921 Info
Added
vCloud Account
1922 Info
Removed
vCloud Account
1923 Info
Updated
vCloud Account
1924 Info Synchronization
Finished
vCloud Account
1925 Error Synchronization
Failed
vCloud Account
1926 Info Synchronization
Requested
Upgrade
Connector to AWS
1927 Info
Account
Requested
AWS Account
1928 Warning
Update Failed
Upgrade
1929 Info Connector to AWS
Account Finished
1950 Info Tenant Created
1951 Info Tenant Deleted
1952 Info Tenant Updated
Tenant Database
1953 Info
Server Created
Tenant Database
1954 Info
Server Deleted
Tenant Database
1955 Info
Server Updated
1018
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
1956 Info Tenant Exported
Tenant
1957 Error Initialization
Failure
Tenant Features
1958 Info
Updated
Scan Cache
2000 Info Configuration
Object Added
Scan Cache
2001 Info Configuration
Object Removed
Scan Cache
2002 Info Configuration
Object Updated
Deep Security as
a Service
2100 Info
Subscription
Started
Deep Security as
a Service
2101 Info
Subscription
Canceled
Cleverbridge
2102 Info
Quantity Updated
Cleverbridge
2103 Warning Quantity Not
Updated
Cleverbridge
2104 Info
Quantity Reset
Cleverbridge
2105 Warning Quantity Not Reset
Cleverbridge
2106 Info
Billing Date Set
Cleverbridge
2107 Warning Billing Date Not
Set
Deep Security as
a Service
2108 Info Subscription
Payment
Received
Deep Security as
2109 Warning a Service
Subscription
1019
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Payment Not
Received
Cleverbridge
2110 Info Notification
Received
Deep Security as
a Service
2111 Info
Subscription
Deactivated
Account Balance
2112 Info
Reset
Agent Installation
2113 Info
Requested
AWS Billing Job
2114 Info
Started
AWS Billing Job
2115 Info
Completed
Deep Security Manager sent a billing usage record to AWS
AWS Billing failure using the AWS SDK, which the SDK returned with an
2116 Error
exception. If the problem persists, contact your support
provider.
Entitlement
2117 Info
Created
Entitlement
2118 Info
Updated
Agent Activation
Prevented Due to
AWS Metering
2119 Error
Billing Usage Data
Submission
Failure
Deep Security Manager encountered an error while
AWS Billing failure
2120 Error executing an AWS billing job. If the problem persists, contact
your support provider.
Software Update:
Anti-Malware
2200 Info
Module Installation
Started
Software Update:
This event is also triggered by installing Application Control
Anti-Malware
2201 Info or Integrity Monitoring because they share the same
Module Installation
framework as Anti-Malware.
Successful
Software Update:
Anti-Malware
2202 Warning
Module Installation
Failed
1020
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Software Update:
Anti-Malware
2203 Info
Module Download
Successful
Security Update:
Pattern Update on
2204 Info
Agents/Appliances
Successful
Security Update:
Pattern Update on
2205 Warning
Agents/Appliances
Failed
Security Update:
Pattern Update on
2206 Info
Agents/Appliances
Skipped
Software Update:
Web Reputation
2300 Info
Module Installation
Started
Software Update:
Web Reputation
2301 Info
Module Installation
Successful
Software Update:
Web Reputation
2302 Warning
Module Installation
Failed
Software Update:
Web Reputation
2303 Info
Download
Successful
Software Update:
2400 Info Firewall Module
Installation Started
Software Update:
Firewall Module
2401 Info
Installation
Successful
Software Update:
2402 Warning Firewall Module
Installation Failed
Software Update:
Firewall Module
2403 Info
Download
Successful
1021
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Software Update:
Intrusion
2500 Info
Prevention Module
Installation Started
Software Update:
Intrusion
2501 Info Prevention Module
Installation
Successful
Software Update:
Intrusion
2502 Warning
Prevention Module
Installation Failed
Software Update:
Intrusion
2503 Info Prevention Module
Download
Successful
Software Update:
Integrity
2600 Info
Monitoring Module
Installation Started
Software Update:
Integrity
2601 Info Monitoring Module
Installation
Successful
Software Update:
Integrity
2602 Warning
Monitoring Module
Installation Failed
Software Update:
Integrity
2603 Info Monitoring Module
Download
Successful
Software Update:
Log Inspection
2700 Info
Module Installation
Started
Software Update:
Log Inspection
2701 Info
Module Installation
Successful
Software Update:
2702 Warning Log Inspection
Module Installation
1022
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Failed
Software Update:
Log Inspection
2703 Info
Module Download
Successful
Software Update:
Software
2800 Info
Automatically
Downloaded
Software Update:
Unable to retrieve
2801 Error
Download Center
inventory
Software Update:
Unable to
2802 Error download software
from Download
Center
Online Help
2803 Info
Update Started
Online Help
2804 Info
Update Ended
Online Help
2805 Info
Update Success
Online Help
2806 Warning
Update Failed
Software Update:
2900 Info Relay Module
Installation Started
Software Update:
Relay Module
2901 Info
Installation
Successful
Software Update:
2902 Warning Relay Module
Installation Failed
Software Update:
Relay Module
2903 Info
Download
Successful
VMware NSX
2904 Info Synchronization
Finished
VMware NSX
2905 Error Synchronization
Failed
1023
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Agent Self- Agent self-protection was enabled via the Deep Security
2906 Info
Protection enabled Manager.
Agent Self-
2907 Info Protection
disabled
Agent Self- Agent self-protection was enabled via the command line on
2908 Info
Protection enabled the Deep Security Agent.
Agent Self-
2909 Info Protection
disabled
Data migration
2915 Info
complete
Data migration
2916 Warning
finished with error
Querying report
2920 Info from DDAn
Finished
Querying report
2921 Error
from DDAn Failed
Submission to
Deep Discovery
2922 Info
Analyzer
processed
File submission to
2923 Error Deep Discovery
Analyzer Failed
Security Update:
Suspicious Object
2924 Info
Check and Update
Successful
Security Update:
Suspicious Object
2925 Error
Check and Update
Failed
Submission to
2926 Warning Deep Discovery
Analyzer queued
File back up
2930 Info
pending
Smart Folder
2931 Info
Added
Smart Folder
2932 Info
Removed
Smart Folder
2933 Info
Updated
2934 Error Failed to send
1024
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Amazon SNS
message
System resumed
2935 Info sending SNS
messages
Inactive User
2936 Info
Deleted
SAML Identity
2937 Info
Provider Created
SAML Identity
2938 Info
Provider Updated
SAML Identity
2939 Info
Provider Deleted
SAML Service
2940 Info
Provider Updated
Failed to Update
2941 Error
News
Performance
2942 Info
Profile Created
Performance
2943 Info
Profile Updated
Performance
2944 Info
Profile Deleted
System Upgrade
2945 Info
Started
System Update
2946 Info
Succeeded
System Upgrade
2947 Error
Failed
Manager Node
2948 Info
Upgrade Started
Manager Node
2949 Info Update
Succeeded
Manager Node
2950 Error A node in a multi-node environment failed to upgrade.
Upgrade Failed
Failed to send TIC
2951 Error Managed Detection and Response events failed to send.
message
System resumed
2952 Info sending TIC
messages
Inactive agent cleanup removed computers that have been
Inactive Agent
offline and inactive for a specified period of time. For more
Cleanup
2953 Info information on inactive agent cleanup, see "Automate offline
Completed
computer removal with inactive agent cleanup" on
Successfully
page 1145.
1025
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Dropped events
2954 Warning recorded in the
future
Appliance (SVM)
2960 Info Upgrade Deep Security Manager has received the upgrade request.
Requested
Appliance (SVM)
2961 Info Deep Security Manager is processing the upgrade.
Upgrade Started
Appliance (SVM) The appliance SVM is not available so the upgrade cannot
2962 Info Upgrade be done. See the description of the system event for the
Canceled reason.
The appliance SVM is upgraded to the new version and is
Appliance (SVM)
2963 Info activated successfully. All guest VMs are auto-activated
Upgraded
three minutes after the appliance activation.
Deep Security Manager encountered one or more errors and
Appliance (SVM) failed the upgrade process. For details, see
2964 Warning
Upgrade Failed "Troubleshooting the 'Appliance (SVM) Upgrade Failed'
system event" on page 1310.
The appliance SVM was upgraded to the newer version but
has not yet been activated, or the appliance SVM was
Appliance (SVM) activated but your guest VMs have not yet been auto-
2965 Error Upgraded but Not
Ready activated. See the description of the system event for details.
You may need to confirm the appliance deployment and
manually trigger activation of the appliance or guest VMs.
GCP Account: <GCPaccountname> successfully added.
GCP Account
2970 Info For details, see "Add a Google Cloud Platform account" on
Added
page 429.
2971 GCP Account GCP Account: <GCPaccountname> successfully removed.
Info
Removed
For details, see "Remove a GCP account" on page 432.
GCP Account: <GCPaccountname> successfully updated.
GCP Account
2972 Info For details, see "Add a Google Cloud Platform account" on
Updated
page 429.
Synchronize computers completed for GCP Account:
GCP Account
2973 Info Synchronization <GCPaccountname>
Finished
For details, see "Synchronize a GCP account" on page 433.
GCP Account Deep Security Manager was unable to synchronize
2974 Error Synchronization
Failed computers with GCP Account: <GCPaccountname>
1026
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
<detailed_message>
For example:
Root URL is not valid
For details, see "Synchronize a GCP account" on page 433.
A request has been made to synchronize computers with
GCP Account
2975 Info Synchronization GCP Account: <GCPaccountname>
Requested
For details, see "Synchronize a GCP account" on page 433.
The GCP Account <GCPaccountname> synchronization
operation completed, but information for the following hosts
or groups could not be updated with following message:
GCP Account <detailed_message>
Synchronization
2976 Warning For example:
Completed but
with Errors
Project <GCPprojectname>: 403 Required
'compute.machineTypes.list' permission for
'projects/<GCPprojectname>'
For details, see "Synchronize a GCP account" on page 433.
XDR Service
2990 Info
Registered
XDR Service
2991 Info
Deleted
Deep Security Manager has detected that the following NSX-
T groups are using different security policies for Endpoint
Protection and Network Introspection (E-W):
VMware NSX
Policy <group_names>
2992 Warning
Configuration
Conflict Go to NSX-T and reconfigure the group to use the same
security policy.
For details, see "Method 3: Synchronize your Deep Security
policies to NSX-T 3.x" on page 337.
XDR Certificate
2993 Warning
Expired
XDR Product
2994 Warning
Connector Missing
1027
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
XDR Certificate
2995 Info
Updated
XDR Certificate
2996 Warning
Update Failed
Software Update:
3000 Info SAP Module
Installation Started
Software Update:
SAP Module
3001 Info
Installation
Successful
Software Update:
3002 Error SAP Module
Installation Failed
Software Update:
SAP Module
3003 Info
Download
Successful
SAP VSA is
3004 Info
installed
SAP VSA is not
3005 Error
installed
SAP VSA is up-to-
3006 Info
date
SAP VSA is not
3007 Info
up-to-date
SAP: Anti-
3008 Info Malware module is
ready
SAP: Anti-
3009 Error Malware module is
not ready
Application
An administrator downloaded application control event logs
7000 Info Control Security
in CSV format.
Events Exported
User Viewed An administrator dismissed an application control alert. This
7007 Info Application is normal unless your system has been compromised by an
Control Event intruder that has gained an administrator login.
Application An agent's application control engine failed to come online.
7008 Error Control Engine This could happen if you have enabled application control
Offline on a computer whose kernel is not supported.
Application
7009 Info Control Engine An agent's application control engine restarted.
Online Again
Application Deep Security Manager updated the application control
7010 Info Control settings on an agent.
1028
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Configuration
Updated
The agent received a policy from Deep Security Manager
where application control was selected, but detected that it
Software Update:
did not have the application control engine installed or
Application
7011 Info needed to update it, so it began to download it. This is
Control Module
normal when you enable application control on a computer
Installation Started
for the first time, or when it has been disabled while
application control engine updates were released.
Software Update:
Application The agent installed the application control engine. The
7012 Info Control Module application control engine is also used by the integrity
Installation monitoring feature.
Successful
Software Update:
Application The agent could not install the application control engine.
7013 Error
Control Module This is not normal.
Installation Failed
Software Update:
Application
The agent finished downloading the application control
7014 Info Control Module
engine.
Download
Successful
Application The legacy REST API was used to allow or block software.
7015 Info Control Ruleset This message does not occur when administrators perform
Rules Updated the same action in the GUI.
Application
The legacy REST API uploaded a computer's initial allow
7020 Info Control Inventory
rules to Deep Security Manager.
Retrieved
The application control engine was enabled, and the agent
detected that it did not have any allow rules for that
Application computer, so it began to build initial rules based on the
7021 Info Control Inventory currently installed software. This is normal when you enable
Scan Started application control for the first time. This message does not
occur when you use the legacy REST API to replace the
allow rules.
The agent finished building the initial allow rules for that
Application
computer. After this, any new software that is detected which
7022 Info Control Inventory
is not in the allow or block rules will, if configured, cause and
Scan Completed
alert.
Application
The agent could not build the initial allow rules for that
7023 Error Control Inventory
computer. This is not normal.
Scan Failed
An administrator allowed or blocked software in the Actions
Application tab, or changed a rule by clicking Change rule in an
7024 Info Control Software application control log message. This message does not
Changes Detected occur when you use the legacy REST API to replace the
1029
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
allow rules.
You manually forced application control to delete the current
Application
rules and rebuild them based on the currently installed
7025 Info Control Inventory
software. This could be normal if you needed to change
Scan Requested
many rules at the same time.
Application
Control
Either an administrator sent or the legacy REST
7026 Info Maintenance
API received the command to enable maintenance mode.
Mode Start
Requested
Application
Control
Either an administrator sent or the legacy REST
7027 Info Maintenance
API received the command to disable maintenance mode.
Mode Stop
Requested
Maintenance mode was enabled. While enabled, the agent
Application
automatically adds updated or newly installed software to its
Control
7028 Info allow rules, indicating that you know and want to allow the
Maintenance
software update. The agent continues to apply block rules
Mode Started
during this time.
Application
Maintenance mode was disabled. Once maintenance mode
Control
7029 Info is stopped, all new or changed software will be considered
Maintenance
"unrecognized" until you specifically allow or block it.
Mode Stopped
Application
The agent began to build the initial allow rules, but an
7030 Info Control Inventory
administrator canceled the process.
Scan Cancelled
Sending An agent could not download a shared ruleset for application
Application control. This can occur if network connectivity is interrupted
7031 Error
Control Ruleset (such as a firewall or proxy between the agent and relay), or
Failed if there isn't enough free disk space on the agent.
Sending An agent downloaded a shared ruleset for application
Application control. This normally occurs whenever an administrator or
7032 Info
Control Ruleset the legacy REST API allows or blocks software, or when a
Succeeded different shared ruleset is applied.
Application The legacy REST API was used to create an application
7033 Info Control Ruleset control ruleset. This message does not occur when
Created administrators perform the same action in the GUI.
The legacy REST API was used to allow or block software
Application
via an application control ruleset. This message does not
7034 Info Control Ruleset
occur when administrators perform the same action in the
Updated
GUI.
Application The legacy REST API was used to delete an application
7035 Info Control Ruleset control ruleset. This message does not occur when
Deleted administrators perform the same action in the GUI.
Application An administrator changed the time period for when
7036 Info
maintenance mode is active.
1030
Trend Micro Deep Security On-Premise 20
ID Severity Event Description or Solution
Control
Maintenance
Mode Reset
Duration
Requested
An administrator applied a new ruleset, but some of the
currently running processes exist in block rules. Application
Newly applied
control will not terminate the processes, but the next time you
ruleset will block
reboot or restart those services, depending on your
7037 Error some running
configuration, it will either alert you or block them. If the
processes on
processes are not authorized, you should terminate them
restart
manually. If they are authorized, but are missing from the
ruleset, you should add them to the ruleset.
Software changes detected on the file system exceeded the
maximum amount. Application control will continue to
Unresolved
enforce existing rules, but will not record any more changes,
7038 Error software change
and it will stop displaying any of that computer's software
limit reached
changes. You must resolve and prevent excessive software
change.
An application control ruleset could not be assigned to one
or more computers because the ruleset is not supported by
the installed version of the agent. Typically, the problem is
that a hash-based ruleset (which is compatible only with
Deep Security Agent 11.0 or newer) has been assigned to
an older Deep Security Agent. Deep Security Agent 10.x
Incompatible supports only file-based rulesets. (For details, see
7040 Error Application "Differences in how Deep Security Agent 10 and 11 compare
Control Ruleset files" on page 802.) To fix this issue, upgrade the Deep
Security Agent to version 11.0 or newer. Alternatively, if you
are using local rulesets, reset application control for the
agent. Or if you are using a shared ruleset, use a shared
ruleset that was created with Deep Security 10.x until all
agents using the shared ruleset are upgraded to Deep
Security Agent 11.0 or newer.
An application control ruleset was upgraded from a file-
Application
based ruleset to a hash-based ruleset. (For details, see
7041 Info Control Ruleset
"Differences in how Deep Security Agent 10 and 11 compare
Upgraded
files" on page 802.)
Application
7042 Info Control Software
Inventory Deleted
A computer reboot
is required to
7043 Info complete
Application
Control protection
1031
Trend Micro Deep Security On-Premise 20
Application Control events
For general best practices related to events, see "About Deep Security event logging" on
page 825.
To see the Application Control events captured by Deep Security, go to Events & Reports >
Events > Application Control Events > Security Events.
What information is displayed for Application Control events?
These columns can be displayed on the Application Control Events page. You can click
Columns to select which columns are displayed in the table.
l Time: Time the event took place on the computer.
l Computer: The computer on which this event was logged. (If the computer has been
removed, this entry will read "Unknown Computer".)
l Event: The name of the event.
l Rules: View event details and change the rule from Allow to Block or vice versa.
l Ruleset: Ruleset that's associated with the event.
l Action: The action that caused the event to be triggered.
l Reason: The reason the event was triggered.
l Repeat count: The number of events that are aggregated.
l Tag(s): Event tags associated with this event.
l Path: Path to the affected file.
l File: File affected by the event.
l User Name: User that's responsible for executing the unrecognized software.
l Event Origin: The Deep Security component from which the event originated.
l MD5: MD5 hash.
l SHA1: SHA-1 hash.
l SHA256: SHA-256 hash.
l Group: The name of the group.
l Group ID: The ID of the group.
l User ID: User ID of the file owner.
l Process ID: ID of process that ran the execution.
l Process Name: Process that ran the execution.
1032
Trend Micro Deep Security On-Premise 20
List of all Application Control events
Note: For system events related to Application Control, see " System events" on page 984.
Events
Execution of Unrecognized Software Allowed
Execution of Unrecognized Software Blocked
Execution of Software Blocked by Rule
Anti-malware events
For general best practices related to events, see "About Deep Security event logging" on
page 825.
To see the anti-malware events captured by Deep Security, go to Events & Reports > Events >
Anti-Malware Events.
What information is displayed for anti-malware events?
These columns can be displayed on the Anti-Malware Events page. You can click Columns to
select which columns are displayed in the table.
l Time: Time the event took place on the computer.
l Computer: The computer on which this event was logged. (If the computer has been
removed, this entry will read "Unknown Computer".)
l Infected File(s): The location and name of the infected file.
l Tag(s): Event tags associated with this event.
l Malware: The name of the malware that was found.
l Action Taken: Displays the results of the actions specified in the malware scan
configuration associated with the event.
l Cleaned:Deep Security successfully terminated processes or deleted registries, files,
cookies, or shortcuts, depending on the type of malware.
l Clean Failed: Malware could not be cleaned for a variety of possible reasons.
l Deleted: An infected file was deleted.
l Delete Failed: An infected file could not be deleted for a variety of possible reasons.
For example, the file may be locked by another application, is on a CD, or is in use. If
possible, Deep Security will delete the infected file once it is released.
1033
Trend Micro Deep Security On-Premise 20
l Quarantined: An infected file was moved to the identified files folder.
l Quarantine Failed: An infected file could not be quarantined for a variety of possible
reasons. For example, the file may be locked by another application, is on a CD, or is
in use. If possible, Deep Security will quarantine the infected file once it is released. It
is also possible that the "Maximum disk space used to store identified files" (specified
on the Policy/Computer Editor > Anti-Malware > Advanced tab) has been exceeded.
l Access Denied: Deep Security has prevented the infected file from being accessed
without removing the file from the system.
l Passed: Deep Security did not take any action but logged the detection of the
malware.
l Scan Type: The type of scan that found the malware (Real-Time, Scheduled, or Manual).
l Event Origin: Indicates from which part of the Deep Security system the event originated.
l Reason: The malware scan configuration that was in effect when the malware was
detected.
l Major Virus Type: The type of malware detected. Possible values are: Joke, Trojan, Virus,
Test, Spyware, Packer, Generic, or Other. For information on these types of malware, see
the anti-malware event details or see "About Anti-Malware" on page 547
l Target(s): The file, process, or registry key (if any) that the malware was trying to affect. If
the malware was trying to affect more than one, this field will contain the value "Multiple."
l Target Type: The type of system resource that this malware was trying to affect, such as
the file system, a process, or Windows registry.
l Container ID: ID of the Docker container where the malware was found.
l Container Image Name: Image name of the Docker container where the malware was
found.
l Container Name: Name of the Docker container where the malware was found.
l File MD5: The MD5 hash of the file.
List of all anti-malware events
ID Severity Event
9001 Info Anti-Malware Scan Started
9002 Info Anti-Malware Scan Completed
9003 Info Anti-Malware Scan Terminated Abnormally
9004 Info Anti-Malware Scan Paused
9005 Info Anti-Malware Scan Resumed
9006 Info Anti-Malware Scan Cancelled
1034
Trend Micro Deep Security On-Premise 20
ID Severity Event
9007 Warning Anti-Malware Scan Cancel Failed
9008 Warning Anti-Malware Scan Start Failed
9009 Warning Anti-Malware Scan Stalled
File cannot be analyzed or quarantined (VM maximum disk space used to store
9010 Error
identified files exceeded)
File cannot be analyzed or quarantined (maximum disk space used to store
9011 Error
identified files exceeded)
9012 Warning Smart Protection Server Disconnected for Smart Scan
9013 Info Smart Protection Server Connected for Smart Scan
9014 Warning Computer reboot is required for Anti-Malware protection
9016 Info Anti-Malware Component Update Successful
9017 Error Anti-Malware Component Update Failed
9018 Error Files could not be scanned for malware
9019 Error Directory could not be scanned for malware
Firewall events
For general best practices related to events, see "About Deep Security event logging" on
page 825.
To see the firewall events captured by Deep Security, go to Events & Reports > Events >
Firewall Events.
Firewall event icons:
Single event
Single event with data
Folded event
Folded event with data
Note: Event folding occurs when multiple events of the same type occur in succession. This
saves disk space and protects against DoS attacks that may attempt to overload the logging
mechanism.
What information is displayed for firewall events?
These columns can be displayed on the firewall events page. You can click Columns to select
which columns are displayed in the table.
1035
Trend Micro Deep Security On-Premise 20
l Time: Time the event took place on the computer.
l Computer: The computer on which this event was logged. (If the computer has been
removed, this entry will read "Unknown Computer".)
l Reason: Log entries on this page are generated either by firewall rules or by firewall
stateful configuration settings. If an entry is generated by a firewall rule, the column entry
will be prefaced by "Firewall Rule:" followed by the name of the firewall rule. Otherwise the
column entry will display the firewall stateful configuration setting that generated the log
entry.
l Tag(s): Event tags that are applied to this event.
l Action: The action taken by the firewall rule or firewall stateful configuration. Possible
actions are: Allow, Deny, Force Allow, and Log Only.
l Rank: The ranking system provides a way to quantify the importance of intrusion
prevention and firewall events. By assigning "asset values" to computers, and assigning
"severity values" to intrusion prevention rules and firewall rules, the importance ("rank") of
an event is calculated by multiplying the two values together. This allows you to sort
events by rank when viewing intrusion prevention or firewall events.
l Direction: The direction of the affected packet (incoming or outgoing).
l Interface: The MAC address of the interface through which the packet was traveling.
l Frame Type: The frame type of the packet in question. Possible values are "IPV4", "IPV6",
"ARP", "REVARP", and "Other: XXXX" where XXXX represents the four digit hex code of
the frame type.
l Protocol: Possible values are "ICMP", "ICMPV6", "IGMP", "GGP", "TCP", "PUP", "UDP",
"IDP", "ND", "RAW", "TCP+UDP", AND "Other: nnn" where nnn represents a three digit
decimal value.
l Flags: Flags set in the packet.
l Source IP: The packet's source IP.
l Source MAC: The packet's source MAC address.
l Source Port: The packet's source port.
l Destination IP: The packet's destination IP address.
l Destination MAC: The packet's destination MAC address.
l Destination Port: The packet's destination port.
l Packet Size: The size of the packet in bytes.
l Repeat Count: The number of times the event was sequentially repeated.
1036
Trend Micro Deep Security On-Premise 20
l Time (microseconds): Microsecond resolution for the time the event took place on the
computer.
l Event Origin: The Deep Security component from which the event originated.
The following columns are also available. They display information for events that are triggered
from containers on computers that are protected by Deep Security Agent 12 FR or newer:
l Interface Type: Container interface type.
l Container Name: Name of the container where the event occurred.
l Container ID: Container ID of the container where the event occurred.
l Image Name: Image name that was used to create the container where the event
occurred.
l RepoDigest: A unique digest that identifies the container image.
l Process Name: Name of the process (from the container) that caused the event.
Note: Log-only rules will only generate a log entry if the packet in question is not
subsequently stopped either by a deny rule, or an allow rule that excludes it. If the packet is
stopped by one of those two rules, those rules will generate a log entry and not the log-only
rule. If no subsequent rules stop the packet, the log-only rule will generate an entry.
List of all firewall events
ID Event Notes
Out Of
100 A packet was received that was not associated with an existing connection.
Connection
Flag(s) set in a packet were invalid. This event can indicate that a flag does
not make sense within the context of a current connection (if any), or that a
101 Invalid Flags nonsensical combination of flags.
"Firewall Stateful Configuration" must be On for connection context to be
assessed.
Invalid A packet with an invalid sequence number or out-of-window data size was
102
Sequence encountered.
103 Invalid ACK A packet with an invalid acknowledgment number was encountered.
104 Internal Error
A packet has congestion flags set and the policy's Anti Evasion settings
105 CE Flags use a custom configuration where the TCP Congestion Flags property is
set to Log or Deny. (See "Configure anti-evasion settings" on page 652.)
106 Invalid IP Packet's source IP was not valid.
107 Invalid IP The length of the IP datagram is less than the length specified in the IP
1037
Trend Micro Deep Security On-Premise 20
ID Event Notes
Datagram
header.
Length
A fragmented packet was encountered and fragmented packets are not
108 Fragmented
allowed.
Invalid
109 Fragment
Offset
A fragmented packet was encountered, and the size of the first fragment is
less than the size of a TCP packet (no data).
A packet is dropped with this event when the packet header has the
following configuration:
l Fragment Offset = 0 (The fragment is the first in the packet)
First Fragment
110 Total length (maximum combined header length) < 120 bytes (the
Too Small l
default allowed minimum fragment size)
To prevent this event from occurring, configure the policy's Advanced
Network Engine settings to use a lower value for the Minimum Fragment
Size property, or set it to 0 to turn off this inspection. (See "Advanced
Network Engine Options" in "Network engine settings" on page 475.)
Fragment Out The offsets(s) specified in a fragmented packet sequence is outside the
111
Of Bounds range of the maximum size of a datagram.
Fragment
A fragmented packet was encountered, the size of the fragment was less
112 Offset Too
than the size of a TCP packet (no data).
Small
An IPv6 Packet was encountered, and IPv6 blocking is enabled. See the
"Block IPv6 on Agents and Appliances verions 9 and later" property in the
113 IPv6 Packet
Advanced Network Engine Options (see "Network engine settings" on
page 475.)
The number of incoming connections has exceeded the maximum number
Max Incoming
114 of connections allowed. See the "Enable TCP stateful inspection" property
Connections
in "TCP packet inspection" on page 698.
The number of outgoing connections has exceeded the maximum number
Max Outgoing
115 of connections allowed. See the "Enable TCP stateful inspection" property
Connections
in "TCP packet inspection" on page 698.
The number of half open connections from a single computer exceeds that
specified in the firewall stateful configuration. See the "Limit the number of
116 Max SYN Sent
half-open connections from a single computer to" property in "TCP packet
inspection" on page 698.
IP Version
118 An IP packet other than IPv4 or IPv6 was encountered.
Unknown
Invalid Packet
119
Info
1038
Trend Micro Deep Security On-Premise 20
ID Event Notes
Internal
120 Insufficient system memory. Add more system resources to fix this issue.
Engine Error
Unsolicited
121 Incoming UDP packets that were not solicited by the computer are rejected.
UDP
Unsolicited ICMP stateful has been enabled (in firewall stateful configuration) and an
122
ICMP unsolicited packet that does not match any Force Allow rules was received.
Out Of Allowed The packet does not meet any of the Allow or Force Allow rules and so is
123
Policy implicitly denied.
Invalid Port An invalid FTP port command was encountered in the FTP control channel
124
Command data stream.
SYN Cookie
125 The SYN cookies protection mechanism encountered an error.
Error
Invalid Data
126 Invalid data offset parameter.
Offset
127 No IP Header The packet IP header is invalid or incomplete.
Unreadable
128 Ethernet Data contained in this Ethernet frame is smaller than the Ethernet header.
Header
129 Undefined
Same Source
130 and Source and destination IPs were identical.
Destination IP
Invalid TCP
131
Header Length
Unreadable
132 Protocol The packet contains an unreadable TCP, UDP or ICMP header.
Header
Unreadable
133 The packet contains an unreadable IPv4 header.
IPv4 Header
Unknown IP
134 Unrecognized IP version.
Version
Invalid Adapter
135 An invalid adapter configuration has been received.
Configuration
Overlapping
136 This packet fragment overlaps a previously sent fragment.
Fragment
Packet on
138 Closed A packet was received belonging to a connection already closed.
Connection
The network engine detected a TCP Packet that overlaps with data already
received on the same TCP connection but does not match the already-
Dropped
139 received data. (The network engine compares the packet data that was
Retransmit
queued in the engine’s connection buffer to the data in the packet that was
re-transmitted.)
1039
Trend Micro Deep Security On-Premise 20
ID Event Notes
The network engine reconstructs the sequenced data stream of each TCP
connection it processes. The sequence number and length in the received
packet specify a specific region in this data stream. The note field in the log
indicates the location of the changed content in the TCP stream: prev-full,
prev-part, next-full and next-part:
l "prev-full" and "prev-part": The changed area is in the packet that
immediately precedes the retransmitted packet in the sequenced data
stream. "prev-full" indicates that the changed area is completely
contained in the packet which immediately precedes the retransmitted
packet in the sequenced data stream. Otherwise, the note is "prev-
part".
l "next-full" and "next-part": The changed area is in the packet that
immediately follows the retransmitted packet in the sequenced data
stream. "next-full" indicates that the changed area is completely
contained in the packet that immediately follows the retransmitted
packet in the sequenced data stream. Otherwise, the note is "next-
part".
140 Undefined
Out of Allowed
141 Policy (Open
Port)
New
142 Connection
Initiated
Invalid
143
Checksum
Invalid Hook
144
Used
IP Zero
145
Payload
IPv6 Source Is
146
Multicast
Invalid IPv6
147
Address
IPv6 Fragment
148
Too Small
Invalid
149 Transport
Header Length
150 Out of Memory
1040
Trend Micro Deep Security On-Premise 20
ID Event Notes
Max TCP The maximum number of TCP connections has been exceeded. See
151
Connections "Event: Max TCP connections" on page 1076.
Max UDP
152
Connections
A region (edit region, uri etc) exceeded the maximum allowed buffering size
Region Too
200 (7570 bytes) without being closed. This is usually because the data does
Big
not conform to the protocol.
The packet could not be processed properly because resources were
exhausted. This can be because too many concurrent connections require
Insufficient
201 buffering (max 2048) or matching resources (max 128) at the same time or
Memory
because of excessive matches in a single IP packet (max 2048) or simply
because the system is out of memory.
Maximum
The maximum number of edits (32) in a single region of a packet was
202 Edits
exceeded.
Exceeded
Editing attempted to increase the size of the region above the maximum
203 Edit Too Large
allowed size (8188 bytes).
Max Matches There are more than 2048 positions in the packet with pattern match
204 in Packet occurrences. An error is returned at this limit and the connection is dropped
Exceeded because this usually indicates a garbage or evasive packet.
Engine Call
205 Stack Too
Deep
206 Runtime Error Runtime error.
Packet Read
207 Low level problem reading packet data.
Error
Fail Open: Log the packet that should be dropped but not when Fail-Open feature is on
257
Deny and in Inline mode.
Unsupported
300 An unknown or unsupported cipher suite has been requested.
Cipher
Error
Unable to derive the cryptographic keys, Mac secrets, and initialization
301 Generating
vectors from the master secret.
Master Key(s)
Record Layer
The SSL state engine has encountered an SSL record before initialization
302 Message (not
of the session.
ready)
Handshake
The SSL state engine has encountered a handshake message after the
303 Message (not
handshake has been negotiated.
ready)
Out Of Order
A well formatted handshake message has been encountered out of
304 Handshake
sequence.
Message
The packet could not be processed properly because resources were
Memory exhausted. This can be because too many concurrent connections require
305 Allocation buffering (max 2048) or matching resources (max 128) at the same time or
Error because of excessive matches in a single IP packet (max 2048) or simply
1041
Trend Micro Deep Security On-Premise 20
ID Event Notes
because the system is out of memory.
Unsupported
306 A client attempted to negotiate an SSL V2 session.
SSL Version
Error
Decrypting Unable to un-wrap the pre-master secret from the ClientKeyExchange
307
Pre-master message.
Key
Client
A client attempted to rollback to an earlier version of the SSL protocol than
308 Attempted to
that which was specified in the ClientHello message.
Rollback
An SSL session was being requested with a cached session key that could
309 Renewal Error
not be located.
Key Exchange The server is attempting to establish an SSL session with temporarily
310
Error generated key.
Maximum SSL
Key The maximum number of concurrent key exchange requests was
311
Exchanges exceeded.
Exceeded
312 Key Too Large The master secret keys are larger than specified by the protocol identifier.
Invalid
An invalid or unreasonable value was encountered while trying to decode
313 Parameters In
the handshake protocol.
Handshake
No Sessions
314
Available
Compression
315 Method
Unsupported
Unsupported
An unknown or unsupported SSL Application-Layer Protocol has been
316 Application-
requested.
Layer Protocol
Fail Open: Log the packet that should be dropped but not when Fail-Open feature is on
385
Deny and in Tap mode.
URI Path
500 Depth Too many "/" separators. Max 100 path depth.
Exceeded
Invalid
501 Tried to use "../" above root.
Traversal
Illegal
502 Character in Illegal character used in uri.
URI
Incomplete
503 UTF8 URI ended in middle of utf8 sequence.
Sequence
Invalid UTF8
504 Invalid or non-canonical encoding attempt.
encoding
505 Invalid Hex %nn where nn are not hex digits.
1042
Trend Micro Deep Security On-Premise 20
ID Event Notes
Encoding
URI Path
506 Length Too Path length is greater than 512 characters.
Long
Invalid Use of
507 Use of disabled characters
Character
Double
508 Decoding Double decoding exploit attempt (%25xx, %25%xxd, etc).
Exploit
Invalid Base64 Packet content that was expected to be encoded in Base64 format was not
700
Content encoded correctly.
Corrupted
Packet content that was expected to be encoded in Base64 format was not
710 Deflate/GZIP
encoded correctly.
Content
Incomplete
711 Deflate/GZIP Incomplete Deflate/GZIP content
Content
Deflate/GZIP
712 Checksum Deflate/GZIP checksum error.
Error
Unsupported
713 Deflate/GZIP Unsupported Deflate/GZIP dictionary.
Dictionary
Unsupported
714 GZIP Header Unsupported GZIP header format or method.
Format/Method
Protocol
Decoding A protocol decoding rule defined a limit for a search or pdu object but the
801
Search Limit object was not found before the limit was reached.
Exceeded
Protocol
Decoding A protocol decoding rule decoded data that did not meet the protocol
802
Constraint content constraints.
Error
Protocol
Decoding
803
Engine
Internal Error
Protocol
Decoding A protocol decoding rule encountered a type definition and packet content
804
Structure Too that caused the maximum type nesting depth (16) to be exceeded.
Deep
Protocol
A rule programming error attempted to cause recursion or use to many
805 Decoding
nested procedure calls.
Stack Error
806 Infinite Data
1043
Trend Micro Deep Security On-Premise 20
ID Event Notes
Loop Error
Intrusion prevention events
For general best practices related to events, see "About Deep Security event logging" on
page 825.
To see the intrusion prevention events captured by Deep Security, go to Events & Reports >
Events > Intrusion Prevention Events.
What information is displayed for intrusion prevention events?
These columns can be displayed on the Intrusion Prevention Events page. You can click
Columns to select which columns are displayed in the table.
l Time: Time the event took place on the computer.
l Computer: The computer on which this event was logged. (If the computer has been
removed, this entry will read "Unknown Computer".)
l Reason: The intrusion prevention rule associated with this event.
l Tag(s): Any tags attached with the event.
l Application Type: The application type associated with the intrusion prevention rule which
caused this event.
l Action: What action the intrusion prevention rule took (Block or Reset). If the rule is in
Detect Only mode, the action is prefaced with "Detect Only:").
Note: Intrusion prevention rules created before Deep Security 7.5 SP1 could also
perform Insert, Replace, and Delete actions. These actions are no longer performed. If an
older rule is triggered and attempts to perform those actions, the event will indicate that
the rule was applied in detect-only mode.
l Rank: The ranking system provides a way to quantify the importance of intrusion
prevention and firewall events. By assigning "asset values" to computers, and assigning
"severity values" to intrusion prevention rules and firewall rules, the importance ("rank") of
an event is calculated by multiplying the two values together. This allows you to sort
events by rank when viewing intrusion prevention or firewall events.
l Severity: The intrusion prevention rule's severity value.
l Direction: The direction of the packet (incoming or outgoing)
1044
Trend Micro Deep Security On-Premise 20
l Flow: whether the packets(s) that triggered this event was travelling with ("Connection
Flow") or against ("Reverse Flow") the direction of traffic being monitored by the intrusion
prevention rule.
l Interface: The MAC address of the interface through which the packet was passing.
l Frame Type: The frame type of the packet in question. Possible values are "IPV4", "IPV6",
"ARP", "REVARP", and "Other: XXXX" where XXXX represents the four digit hex code of
the frame type.
l Protocol: Possible values are "ICMP", "ICMPV6", "IGMP", "GGP", "TCP", "PUP", "UDP",
"IDP", "ND", "RAW", "TCP+UDP", AND "Other: nnn" where nnn represents a three digit
decimal value.
l Flags: Flags set in the packet.
l Source IP: The packet's source IP.
l Source MAC: The packet's source MAC address.
l Source Port: The packet's source port.
l Destination IP: The packet's destination IP address.
l Destination MAC: The packet's destination MAC address.
l Destination Port: The packet's destination port.
l Packet Size: The size of the packet in bytes.
l Repeat Count: The number of times the event was sequentially repeated.
l Time (microseconds): Microsecond resolution for the time the event took place on the
computer.
l Event Origin: The Deep Security component from which the event originated.
The following columns are also available. They display information for events that are triggered
from containers on computers that are protected by Deep Security Agent 12 FR or newer:
l Interface Type: Container interface type.
l Container Name: Name of the container where the event occurred.
l Container ID: Container ID of the container where the event occurred.
l Image Name: Image name that was used to create the container where the event
occurred.
l RepoDigest: A unique digest that identifies the container image.
l Process Name: Name of the process (from the container) that caused the event.
1045
Trend Micro Deep Security On-Premise 20
List of all intrusion prevention events
ID Event Notes
A region (edit region, uri etc) exceeded the maximum allowed buffering size
Region Too
200 (7570 bytes) without being closed. This is usually because the data does
Big
not conform to the protocol.
The packet could not be processed properly because resources were
Insufficient exhausted. This can be because there are too many concurrent
201
Memory connections at the same time or simply because the system is out of
memory.
Maximum
The maximum number of edits (32) in a single region of a packet was
202 Edits
exceeded.
Exceeded
Editing attempted to increase the size of the region above the maximum
203 Edit Too Large
allowed size (8188 bytes).
Max Matches There are more than 2048 positions in the packet with pattern match
204 in Packet occurrences. An error is returned at this limit and the connection is dropped
Exceeded because this usually indicates a garbage or evasive packet.
Engine Call
205 Stack Too
Deep
206 Runtime Error Runtime error.
Packet Read
207 Low level problem reading packet data.
Error
Fail Open: Log the connection that should be reset but not when Fail-Open feature is
258
Reset on and in Inline mode
Unsupported
300 An unknown or unsupported Cipher Suite has been requested.
Cipher
Error
Unable to derive the cryptographic keys, Mac secrets, and initialization
301 Generating
vectors from the master secret.
Master Key(s)
Record Layer
The SSL state engine has encountered an SSL record before initialization
302 Message (not
of the session.
ready)
Handshake
The SSL state engine has encountered a handshake message after the
303 Message (not
handshake has been negotiated.
ready)
Out Of Order
A well formatted handshake message has been encountered out of
304 Handshake
sequence.
Message
The packet could not be processed properly because resources were
Memory
exhausted. This can be because there are too many concurrent
305 Allocation
connections at the same time or simply because the system is out of
Error
memory.
Unsupported
306 A client attempted to negotiate an SSL V2 session.
SSL Version
Unable to un-wrap the pre-master secret from the ClientKeyExchange
307 Error
message.
1046
Trend Micro Deep Security On-Premise 20
ID Event Notes
Decrypting
Pre-master
Key
Client
A client attempted to rollback to an earlier version of the SSL protocol than
308 Attempted to
that which was specified in the ClientHello message.
Rollback
An SSL session was being requested with a cached session key that could
309 Renewal Error
not be located.
Key Exchange The server is attempting to establish an SSL session with temporarily
310
Error generated key.
Maximum SSL
Key The maximum number of concurrent key exchange requests was
311
Exchanges exceeded.
Exceeded
312 Key Too Large The master secret keys are larger than specified by the protocol identifier.
Invalid
An invalid or unreasonable value was encountered while trying to decode
313 Parameters In
the handshake protocol.
Handshake
No Sessions
314
Available
Compression
315 Method
Unsupported
Unsupported
An unknown or unsupported SSL Application-Layer Protocol has been
316 Application-
requested.
Layer Protocol
Fail Open: Log the connection that should be reset but not when Fail-Open feature is
386
Reset on and in Tap mode.
URI Path
500 Depth Too many "/" separators. Max 100 path depth.
Exceeded
Invalid
501 Tried to use "../" above root.
Traversal
Illegal
502 Character in Illegal character used in uri.
URI
Incomplete
503 UTF8 URI ended in middle of utf8 sequence.
Sequence
Invalid UTF8
504 Invalid or non-canonical encoding attempt.
encoding
Invalid Hex
505 %nn where nn are not hex digits.
Encoding
URI Path
506 Length Too Path length is greater than 512 characters.
Long
1047
Trend Micro Deep Security On-Premise 20
ID Event Notes
Invalid Use of
507 Use of disabled characters
Character
Double
508 Decoding Double decoding exploit attempt (%25xx, %25%xxd, etc).
Exploit
Invalid Base64 Packet content that was expected to be encoded in Base64 format was not
700
Content encoded correctly.
Corrupted
Packet content that was expected to be encoded in Base64 format was not
710 Deflate/GZIP
encoded correctly.
Content
Incomplete
711 Deflate/GZIP Incomplete Deflate/GZIP content
Content
Deflate/GZIP
712 Checksum Deflate/GZIP checksum error.
Error
Unsupported
713 Deflate/GZIP Unsupported Deflate/GZIP dictionary.
Dictionary
Unsupported
714 GZIP Header Unsupported GZIP header format or method.
Format/Method
Protocol
Decoding A protocol decoding rule defined a limit for a search or pdu object but the
801
Search Limit object was not found before the limit was reached.
Exceeded
Protocol
Decoding A protocol decoding rule decoded data that did not meet the protocol
802
Constraint content constraints.
Error
Protocol
Decoding
803
Engine
Internal Error
Protocol
Decoding A protocol decoding rule encountered a type definition and packet content
804
Structure Too that caused the maximum type nesting depth (16) to be exceeded.
Deep
Protocol
A rule programming error attempted to cause recursion or use to many
805 Decoding
nested procedure calls.
Stack Error
Infinite Data
806
Loop Error
1048
Trend Micro Deep Security On-Premise 20
Integrity monitoring events
For general best practices related to events, see "About Deep Security event logging" on
page 825.
To see the integrity monitoring events captured by Deep Security, go to Events & Reports >
Events > Integrity Monitoring Events.
What information is displayed for integrity monitoring events?
These columns can be displayed on the Integrity Monitoring Events page. You can click
Columns to select which columns are displayed in the table.
l Time: Time the event took place on the computer.
l Computer: The computer on which this event was logged. (If the computer has been
removed, this entry will read "Unknown Computer".)
l Reason: The integrity monitoring rule associated with this event.
l Tag(s): Event tags that are applied to this event.
l Change: The change detected by the integrity rule. Can be: Created, Updated, Deleted, or
Renamed.
l Rank: The ranking system provides a way to quantify the importance of events. By
assigning "asset values" to computers, and assigning "severity values" to rules, the
importance ("rank") of an event is calculated by multiplying the two values together. This
allows you to sort events by rank.
l Severity: The integrity monitoring rule's severity value
l Type: Type of entity from which the event originated
l Key: Path and file name or registry key from which the event originated
l User: User ID of the file owner
l Process: Process from which the event originated
l Event Origin: The Deep Security component from which the event originated
List of all integrity monitoring events
ID Severity Event Notes
Created when the agent has been requested to build a baseline or
Full
went from 0 integrity monitoring rules to n (causing the baseline to
8000 Info Baseline
be built). This event includes information on the time taken to scan
Created
(ms), and number of entities cataloged.
8001 Info Partial Created when the agent had a security configuration where one or
1049
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
more integrity monitoring rules changed. This event includes
Baseline
information on the time taken to scan (ms), and number of entities
Created
catalogued.
Created when the agent is requested to do a full or partial on-
Scan for demand scan. This event includes information on the time taken to
8002 Info Change scan (ms), and number of CHANGES catalogued. (Ongoing scans
Completed for changes based on the FileSystem Driver or the notify do not
generate an 8002 event.)
Unknown
Created when a rule uses a ${env.EnvironmentVar} and
Environment
"EnvironmentVar" is not a known environment variable. This event
Variable in
8003 Error includes the ID of the integrity monitoring rule containing the
Integrity
problem, the name of the integrity monitoring rule, and the name of
Monitoring
the unknown environment variable.
Rule
Created when a rule contains an invalid base directory or key. For
example, specifying a FileSet with a base of "c:\foo\d:\bar" would
Bad Base in
generate this event, or the invalid value could be the result of
Integrity
8004 Error environment variable substitution the yields a bad value. This
Monitoring
event includes the ID of the integrity monitoring rule containing the
Rule
problem, the name of the integrity monitoring rule, and the bad
base value.
Unknown Created when an unknown EntitySet is encountered in an integrity
Entity in monitoring rule. This event includes the ID of the integrity
8005 Error Integrity monitoring rule containing the problem, the name of the integrity
Monitoring monitoring rule, and a comma-separated list of the unknown
Rule EntitySet names encountered.
Created when a known but unsupported EntitySet is encountered
Unsupported
in an integrity monitoring rule. This event includes the ID of the
Entity in
integrity monitoring rule containing the problem, the name of the
8006 Error Integrity
integrity monitoring rule, and a comma-separated list of the
Monitoring
unsupported EntitySet names encountered. Some EntitySet types
Rule
such as RegistryKeySet are platform-specific.
Created when an unknown feature is encountered in an integrity
Unknown monitoring rule. This event includes the ID of the integrity
Feature in monitoring rule containing the problem, the name of the integrity
8007 Error Integrity monitoring rule, the type of entity set (for example, FileSet), and a
Monitoring comma-separated list of the unknown feature names encountered.
Rule Examples of valid feature values are "whereBaseInOtherSet",
"status", and "executable".
Created when a known but unsupported feature is encountered in
Unsupported an integrity monitoring rule. This event includes the ID of the
Feature in integrity monitoring rule containing the problem, the name of the
8008 Error Integrity integrity monitoring rule, the type of entity set (for example,
Monitoring FileSet), and a comma-separated list of the unsupported feature
Rule names encountered. Some feature values such as "status" (used
for Windows service states) are platform-specific.
8009 Error Unknown Created when an unknown attribute is encountered in an integrity
1050
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
monitoring rule. This event includes the ID of the integrity
Attribute in
monitoring rule containing the problem, the name of the integrity
Integrity monitoring rule, the type of entity set (for example, FileSet), and a
Monitoringcomma-separated list of the unknown attribute names
Rule encountered. Examples of valid attribute values are "created",
"lastModified" and "inodeNumber".
Created when a known but unsupported attribute is encountered in
Unsupported an integrity monitoring rule. This event includes the ID of the
Attribute in integrity monitoring rule containing the problem, the name of the
8010 Error Integrity integrity monitoring rule, the type of entity set (for example,
Monitoring FileSet), and a comma-separated list of the unsupported attribute
Rule names encountered. Some attribute values such as
"inodeNumber" are platform-specific.
Created when an unknown EntitySet XML attribute is encountered
Unknown
in an integrity monitoring rule. This event includes the ID of the
Attribute in
integrity monitoring rule containing the problem, the name of the
Entity Set in
8011 Error integrity monitoring rule, the type of entity set (for example,FileSet),
Integrity
and a comma-separated list of the unknown EntitySet attribute
Monitoring
names encountered. You would get this event if you wrote <FileSet
Rule
dir="c:\foo"> instead of <FileSet base="c:\foo">
Unknown
Registry Created when a rule references a registry key that doesn't exist.
String in This event includes the ID of the integrity monitoring rule
8012 Error
Integrity containing the problem, the name of the integrity monitoring rule,
Monitoring and the name of the unknown registry string.
Rule
Invalid
WQLSet
Indicates that the namespace is missing from a WQL query
was used.
because an integrity rule XML is incorrectly formatted. This can
8013 Error Namespace
occur only in an advanced case, with custom integrity rules that
or WQL
use and monitor WQL queries.
query was
missing.
Invalid
WQLSet
was used.
8014 Error An unknown
provider
value was
used.
Inapplicable
Can be caused by a number of reasons, such as platform
Integrity
8015 Warning mismatch, nonexistent target directories or files, or unsupported
Monitoring
functionality.
Rule
Suboptimal
8016 Warning Integrity
Rule
1051
Trend Micro Deep Security On-Premise 20
ID Severity Event Notes
Detected
Regular
expression
could not be
8050 Error compiled.
Invalid
wildcard
was used.
Log inspection events
For general best practices related to events, see "About Deep Security event logging" on
page 825.
To see the log inspection events captured by Deep Security, go to Events & Reports > Events >
Log Inspection Events.
What information is displayed for log inspection events?
These columns can be displayed on the log inspection events page. You can click Columns to
select which columns are displayed in the table.
l Time: Time the event took place on the computer.
l Computer: The computer on which this event was logged. (If the computer has been
removed, this entry will read "Unknown Computer".)
l Reason: The log inspection rule associated with this event.
l Tag(s): Any tags attached with the event.
l Description: Description of the rule.
l Rank: The ranking system provides a way to quantify the importance of events. By
assigning "asset values" to computers, and assigning "severity values" to log inspection
rules, the importance ("rank") of an event is calculated by multiplying the two values
together. This allows you to sort events by rank.
l Severity: The log inspection rule's severity value.
l Groups: Group that the rule belongs to.
l Program Name: Program name. This is obtained from the syslog header of the event.
l Event: The name of the event.
l Location: Where the log came from.
1052
Trend Micro Deep Security On-Premise 20
l Source IP: The packet's source IP.
l Source Port: The packet's source port.
l Destination IP: The packet's destination IP address.
l Destination Port: The packet's destination port.
l Protocol: Possible values are "ICMP", "ICMPV6", "IGMP", "GGP", "TCP", "PUP", "UDP",
"IDP", "ND", "RAW", "TCP+UDP", AND "Other: nnn" where nnn represents a three digit
decimal value.
l Action: The action taken within the event
l Source User: Originating user within the event.
l Destination User: Destination user within the event.
l Event HostName: Hostname of the event source.
l ID: Any ID decoded as the ID from the event.
l Status: The decoded status within the event.
l Command: The command being called within the event.
l URL: The URL within the event.
l Data: Any additional data extracted from the event.
l System Name: The system name within the event.
l Rule Matched: Rule number that was matched.
l Event Origin: The Deep Security component from which the event originated.
List of log inspection security events
Note: For system events related to log inspection, see " System events" on page 984.
ID Severity Event
8100 Error Log Inspection Engine Error
8101 Warning Log Inspection Engine Warning
8102 Info Log Inspection Engine Initialized
Web reputation events
For general best practices related to events, see "About Deep Security event logging" on
page 825.
To see the web reputation events captured by Deep Security, go to Events & Reports > Events
> Web Reputation Events.
1053
Trend Micro Deep Security On-Premise 20
What information is displayed for web reputation events?
These columns can be displayed on the web reputation events page. You can click Columns to
select which columns are displayed in the table.
l Time: Time the event took place on the computer.
l Computer: The computer on which this event was logged. (If the computer has been
removed, this entry will read "Unknown Computer".)
l URL: The URL that triggered this event.
l Tag(s): Event tags associated with this event.
l Risk: What was the risk level of the URL that triggered the event ("Suspicious", "Highly
Suspicious", "Dangerous", "Untested", or "Blocked by Administrator").
l Rank: Rank provides a way to quantify the importance of events. It is calculated by
multiplying the asset value of the computer by the severity of the rule. (See "Rank events to
quantify their importance" on page 844.)
l Event Origin: Indicates from which part of the Deep Security system the event originated.
Add a URL to the list of allowed URLs
If you want to add the URL that triggered an event to the list of allowed URLs, right-click the
event and select Add to Allow List. (To view or edit the Allowed and Blocked lists, go to the
Exceptions tab on the main Web Reputation page.)
Troubleshoot common events, alerts, and errors
Why am I seeing firewall events when the firewall module is off?
If you have Intrusion Prevention or Web Reputation enabled, you may see some Firewall events
because the Intrusion Prevention and Web Reputation modules leverage the Firewall’s stateful
configuration mechanism to perform inspections.
Troubleshoot event ID 771 "Contact by Unrecognized Client"
Event ID 771 Contact by Unrecognized Client appears on Deep Security Manager if a Deep
Security Agent or Deep Security Virtual Appliance tries to connect to the manager, but the
computer's name doesn't exist in the list of protected computers on Computers.
Common causes include:
1054
Trend Micro Deep Security On-Premise 20
l Cloned VMs or cloud instances if you haven't enabled Reactivate cloned Agents.
l Computers deleted from Computers before deactivating Deep Security Agent, if you
haven't enabled Reactivate unknown Agents. The agent software continues to try to
periodically connect to its manager, causing the event each time until either it is
uninstalled, or you reactivate the computer.
l Interrupted sync of a connector such as vCenter, AWS, or Azure. For example, if a VMware
ESXi host is not shut down gracefully due to a power failure, then the VM's information
may not be correctly synchronized.
Solutions vary by the cause.
Uninstall Deep Security Agent
If you don't want to protect the unrecognized computer, you can prevent these events by
deactivating or uninstalling the Deep Security Agent software. See "Uninstall Deep Security" on
page 1326.
Reactivate the computer or clone
If you want to protect the computer, activate it with Deep Security Manager. Re-activation re-
establishes the agent's certificate so that the manager can authenticate it with the list on
Computers, and recognize the computer. See "Agent-initiated activation (AIA)" on page 1149.
Fix interrupted VMware connector synchronization
1. On Deep Security Manager, go to Computers.
2. Remove the vCenter connector.
3. On VMware vSphere, reset the Deep Security Virtual Appliance (DSVA).
This will clear the information in:
/var/opt/ds_agent/guests
4. Add the vCenter into the Deep Security Manager again.
5. Re-activate the VMs.
Troubleshoot "Smart Protection Server disconnected" errors
If you are using the anti-malware or web reputation modules, you may see either a "Smart
Protection Server Disconnected for Smart Scan" or "Smart Protection Server Disconnected for
1055
Trend Micro Deep Security On-Premise 20
Web Reputation" error in the Deep Security Manager console. To fix the error, try the following
troubleshooting tips.
Check the error details
Double-click the error message to display more detailed information, including the URL that the
server is trying to contact. The error may include:
l Timeout was reached
l Couldn't resolve hostname
From a command prompt, use nslookup to check whether the DNS name resolves to an IP
address. If the URL doesn't resolve, then there is a DNS issue on the local server.
Use a telnet client to test connectivity to the URL on ports 80 and 443. If you can't connect, check
that all of your firewalls, security groups, etc. are allowing outbound communication to the URL
on those ports.
Is the issue on a Deep Security Virtual Appliance?
If the error is occurring for a Deep Security Virtual Appliance:
1. Check the virtual appliance's internet connectivity.
2. Make sure the virtual appliance has a bi-directional connection to the internet via port 80.
3. Make sure there is sufficient memory assigned to the virtual appliance. For details on
memory requirements, see "Deep Security Virtual Appliance sizing" on page 176.
Error: Activation Failed
Several events can trigger an "Activation Failed" alert:
l "Activation Failed - Protocol Error" below
l "Activation Failed - Unable to resolve hostname" on the next page
l "Activation Failed - No agent/appliance" on the next page
l "Activation Failed - Blocked port" on page 1058
l "Activation Failed - Duplicate Computer" on page 1059
Activation Failed - Protocol Error
This error typically occurs when you use Deep Security Manager to attempt to activate a Deep
Security Agent and the manager is unable to communicate with the agent. The communication
1056
Trend Micro Deep Security On-Premise 20
directionality that the agent uses determines the method that you should use to troubleshoot this
error. (See "Agent-manager communication" on page 1124.)
Agent-initiated communication
When the agent uses agent-initiated communication, you need to activate the agent from the
agent computer. (See "Activate an agent" on page 1361.)
When using Deep Security as a Service, agent-initiated communication is the recommended
communication directionality.
Bidirectional communication
Use the following troubleshooting steps when the error occurs and the agent uses bidirectional
communication:
1. Ensure that the agent is installed on the computer and that the agent is running.
2. Ensure that the ports are open between the manager and the agent. (See "Port numbers,
URLs, and IP addresses" on page 178 and "Create a firewall rule" on page 671.)
Activation Failed - Unable to resolve hostname
The error: Activation Failed (Unable to resolve hostname) could be the result of an unresolvable
hostname in DNS or of activating the agent from Deep Security Manager when you are not using
agent-initiated activation.
If your agent is in bidirectional or manager-initiated mode, your hostname must be resolvable in
DNS. Check the DNS on your Deep Security Manager to ensure it can resolve your hosts.
If you are a Deep Security as a Service user or your computers are in cloud accounts, we
recommend that you always use agent-initiated activation. To learn how to configure policy rules
for agent-initiated communication and deploy agents using deployment scripts, see "Activate
and protect agents using agent-initiated activation and communication" on page 1138.
Activation Failed - No agent/appliance
This error message indicates that the agent software has not been installed on the computer that
you would like to protect.
Review "Get Deep Security Agent software" on page 266.
1057
Trend Micro Deep Security On-Premise 20
Activation Failed - Blocked port
If you are seeing 'Activation Failed' events with the following error messages in the ds_
agent.log:
• 2018-06-25 17:52:14.000000: [Error/1] | CHTTPServer::AcceptSSL
(<IP>:<PORT>) - BIO_do_handshake() failed - peer closed connection. |
http\HTTPServer.cpp:246:DsaCore::CHTTPServer::AcceptSSL |
1E80:1FEC:ActivateThread
• 2018-06-25 17:52:14.143355: [dsa.Heartbeat/5] | Unable to reach a
manager. | .\dsa\Heartbeat.lua:149:(null) | 1E80:1FEC:ActivateThread
• 2018-06-25 17:52:14.000000: [Info/5] | AgentEvent 4012 |
common\DomainPrivate.cpp:493:DsaCore::DomPrivateData::AgentEventWriteHaveL
ock | 1E80:1FEC:ActivateThread
• 2018-06-25 17:52:14.143355: [Cmd/5] | Respond() - sending status line of
'HTTP/1.1 400 OK' | http\HTTPServer.cpp:369:DsaCore::CHTTPServer::Respond
| 1E80:1D7C:ConnectionHandlerPool_0011
...and the following messages in your packet capture software (pcap):
• [TCP Retransmission] <Ephemeral Port> -> 443 [SYN, ECN, CWR] .......
• [TCP Retransmission] <Ephemeral Port> -> 443 [SYN] .......
...it may be because you have blocked a port used by the Deep Security Agents and manager to
establish communication. agent-manager communication ports could be any of the following:
Agent-manager communication
Source / Port Destination / Port
type
Agent-initiated Deep Security Agent / Ephemeral
Manager / 4119
communication port
Agent-initiated Deep Security Agent / Ephemeral Deep Security as a
communication port Service / 443
Deep Security Manager or
Manager-initiated
Deep Security as a Service / Agent / 4118
communication
Ephemeral port
1058
Trend Micro Deep Security On-Premise 20
As you can see from the table above, ephemeral ports are used for the source port for outbound
communication between agent and manager. If those are blocked, then the agent can't be
activated and heartbeats won't work. The same problems arise if any of the destination ports are
blocked.
To resolve this issue:
l Remove restrictions on client outbound ports (ephemeral) in your network configuration.
l Allow access to Deep Security Manager on port 4119, or Deep Security as a Service on
443.
l Allow inbound access to Deep Security Agent on port 4118 if you're using Manager-
initiated communication.
For details on ports, see "Port numbers, URLs, and IP addresses" on page 178.
Activation Failed - Duplicate Computer
This error typically occurs when you activate a computer using a name that already exists, or a
computer that is already active in a different connector.
To resolve this issue you can use one of the following methods:
l Remove one of the duplicate computers and reactivate the remaining computer if
necessary.
l From the Deep Security Manager, go to Administration > System Settings > Agents and
select your preferences for agent-initiated activation. If a computer with the same name
already exists, there are options to re-activate the existing computer, activate a new
computer with the same name, or not allow activation. For more details, see "Agent-
initiated activation (AIA)" on page 1149.
Error: Agent version not supported
The error message "Agent version not supported" indicates that the agent version currently
installed on the computer is not supported by the Deep Security Manager.
Although the unsupported agent will still protect the computer based on the last policy settings it
received from the Deep Security Manager, we recommend that you upgrade the agent so that
you can react quickly to the latest threats. For more information, see "Upgrade Deep Security
Agent" on page 1295.
1059
Trend Micro Deep Security On-Premise 20
Error: Anti-Malware Engine Offline
This error can occur for a variety of reasons. To resolve the issue, follow the instructions below
for the mode of protection that is being used:
l "Agent-based protection" below
l "Agentless protection" on the next page
For an overview of the Anti-Malware module, see "About Anti-Malware" on page 547.
Agent-based protection
1. In the Deep Security Manager, check for other errors on the same machine. If errors exist,
there could be other issues that are causing your Anti-Malware engine to be offline, such
as communications or Deep Security Agent installation failure.
2. Check communications from the agent to the Deep Security Relay and the manager.
3. In the Deep Security Manager, view the details for the agent with the issue. Verify that the
policy or setting for Anti-Malware is turned on, and that the configuration for each scan
(real-time, manual, scheduled) is in place and active. (See "Enable and configure anti-
malware" on page 554.)
4. Deactivate and uninstall the agent before reinstalling and re-activating it. See "Uninstall
Deep Security" on page 1326 and "Activate the agent" on page 295 for more information.
5. In the Deep Security Manager, go to the Updates section for that computer. Verify that the
Security Updates are present and current. If not, click Download Security Updates to
initiate an update.
6. Check if there are conflicts with another anti-virus product, such as OfficeScan. If conflicts
exist, uninstall the other product and Deep Security Agent, reboot, and reinstall the Deep
Security Agent. To remove OfficeScan, see Uninstalling clients or agents in OfficeScan
(OSCE).
If your agent is on Windows:
1. Make sure the following services are running:
l Trend Micro Deep Security Agent
l Trend Micro Solution Platform
2. Check that all the anti-malware related drivers are running properly by running the
following commands:
l # sc query AMSP
l # sc query tmcomm
1060
Trend Micro Deep Security On-Premise 20
l # sc query tmactmon
l # sc query tmevtmgr
If a driver is not running, restart the Trend Micro services. If it is still not running, continue
with the following steps below.
3. Verify the installation method. Only install the MSI, not the zip file.
4. The agent might need to be manually removed and reinstalled. For more information, see
Manually uninstalling Deep Security Agent, Relay, and Notifier from Windows
5. The installed Comodo certificate could be the cause of the issue. To resolve the issue, see
"Anti-Malware Driver offline" status occurs due to Comodo certificate issue.
If your agent is on Linux:
1. To check that the agent is running, enter the following command in the command line:
l service ds_agent status
2. If you're using a Linux server, your kernel might not be supported. For more information,
see "Error: Module installation failed (Linux)" on page 1071.
If the problem is still unresolved after following these instructions, create a diagnostic package
and contact support. For more information, see "Create a diagnostic package and logs" on
page 1550.
Agentless protection
1. In the Deep Security Manager, verify synchronization to vCenter and NSX. Under the
Computers section, right click on your vCenter and go to Properties. Click Test
Connection. Then click on the NSX tab and test the connection. Click Add/Update
Certificate in case the certificate has changed.
2. Log into the NSX manager and verify that it is synching to vCenter properly.
3. Log into your vSphere client and go to Network & Security > Installation > Service
Deployments. Check for errors with Trend Micro Deep Security and Guest Introspection,
and resolve any that are found.
4. In vSphere client, go to Network & Security > Service Composer. Verify that the security
policy is assigned to the appropriate security group.
5. Verify that your VMware tools are compatible with Deep Security. For more information,
see VMware Tools 10.x Interoperability Issues with Deep Security.
6. Verify that the File Introspection Driver (vsepflt) is installed and running on the target VM.
As an admin, run sc query vsepflt at the command prompt.
1061
Trend Micro Deep Security On-Premise 20
7. All instances and virtual machines deployed from a catalog or vApp template from vCloud
Director are given the same BIOS UUID. Deep Security distinguishes different VMs by
there BIOS UUID, so a duplicate value in the vCenter causes an Anti-Malware Engine
Offline error. To resolve the issue, see VM BIOS UUIDs are not unique when virtual
machines are deployed from vApp templates (2002506).
8. If the problem is still unresolved, open a case with support with the following information:
l Diagnostic package from each Deep Security Manager. For more information, see
"Create a diagnostic package and logs" on page 1550.
l Diagnostic package from the Deep Security Virtual Appliance.
l vCenter support bundle for the effected VMs.
Error: Check Status Failed
You can check the status of the agent / appliance on a computer from the Deep Security
Manager console. On the Computers page, right-click the computer and click Actions > Check
Status.
If you get a "Check Status Failed" error, open the error message to see a more detailed
description.
If description indicates a protocol error, it's usually caused by a communication issue. There are
a few possible causes:
l Check whether the computer (or the policy assigned to the computer) is configured for
agent-initiated communication or bidirectional communication. Unless you are using Deep
Security as a Service, the "Check Status" operation will fail if you are using agent-initiated
communication.
l Check that the Deep Security Manager can communicate with the agent. The manager
should be able to reach the agent. See "Port numbers, URLs, and IP addresses" on
page 178.
l Check the resources on the agent computer. Lack of memory, CPU, or disk space can
cause this error.
If the description indicates a SQLITE_IOERR_WRITE[778]: disk I/O error, there is likely a
problem with the agent computer. The most common problem is that the disk is full or write-
protected.
1062
Trend Micro Deep Security On-Premise 20
Error: Installation of Feature 'dpi' failed: Not available: Filter
The error message "Installation of Feature 'dpi' failed: Not available: Filter" indicates that your
operating system kernel version is not supported by the network driver. You will typically get this
message when installing Intrusion Prevention, Web Reputation, or Firewall because the Deep
Security Agent installs a network driver at the same time in order to examine traffic. The same
circumstances can cause engine offline alerts.
An update may be on its way. Trend Micro actively monitors a variety of operating system
vendors for new kernel releases. After completing quality assurance tests, we will release an
update with support for these kernels.
Your system will install the required support automatically when an update for your operating
system kernel version becomes available.
Contact technical support (sign in Deep Security, and click Support in the top right-hand corner)
to find out when support for your operating system kernel version will be released.
Additional information
This only affects Intrusion Prevention, Web Reputation, and Firewall. All other protection
modules (Anti-Malware, Integrity Monitoring, and Log Inspection) will operate correctly.
To review supported operating system kernel versions, visit the Deep Security 9.6 Supported
Linux Kernels page and look for your operating system distribution.
Error: Integrity Monitoring Engine Offline and other errors occur after
activating a virtual machine
The following errors are displayed in Deep Security Manager when activating a virtual machine
protected by Deep Security Virtual Appliance. These errors appears even when the activation is
successful:
l Anti-Malware Engine Offline
l Rebuild Baseline Failure (Agent or Appliance error)
l Integrity Monitoring Engine Offline
The issue remains unresolved even when the following troubleshooting tasks are performed:
1063
Trend Micro Deep Security On-Premise 20
l Confirm that vSphere Endpoint is already installed.
l Confirm that VMware tools are installed and up to date.
l Confirm that VMCI and VSEPFLT drivers are installed and running on the VM.
l Synchronize vCenter on the DSM console.
l Deactivate and reactivate the Deep Security Virtual Appliance.
l Deactivate and reactivate the particular VM with issue.
l Reinstall VMware tools.
These errors appear because the virtual machine is not running VMversion 7 or above. To
resolve the issue, you need to upgrade the VM to the latest hardware version.
Error: Interface out of sync
This error occurs when the network interface information (such as different MAC addresses) that
the Deep Security Manager has stored in its database for the guest virtual machine (VM) is not
the same as the interface information being reported by the Deep Security Virtual Appliance.
To determine the root cause of this issue, you need to find out where the information has
become out of sync.
The first step is to check the error message from Deep Security Manager to determine which VM
and which interface has the issue.
Check the interfaces on the VM
1. Log into the VM.
2. Open a command prompt.
3. Enter the command to display all network interfaces' information. For example, on
Windows, enter: ipconfig /all
4. Verify all of the NICs and MAC addresses and make sure that the NICs have the correct
driver and that they are working properly.
Check the VM's interface information in vCenter
Check the VM interface information from the Managed Object Reference (MoRef) in the vCenter
Server.
1064
Trend Micro Deep Security On-Premise 20
1. Go to the virtual computer MOB at:https://<VC_SERVER>/mob/?moid=<OBJECT_ID>
For example, you might go to this URL: https://192.168.100.100/mob/?moid=vm-
1136&doPath=config
where:
<VC_SERVER> is the FQDN or IP of the vCenter Server
=<OBJECT_ID> is the ID of the object you are looking up
For more information on accessing the VC MOB see Looking up Managed Object
Reference (MoRef) in vCenter Server.
2. Go to Config > extraConfig["ethernet0.filter0……"] > hardware to check all the NICs and
MAC address.
3. Compare the MAC addresses with the MAC in the VM's OS.
Check the vmx file and the VM's interface information in Deep Security
Manager
1. Use the vCenter Server datastore browser to download the VM's vmx file.
2. Open the vmx file using a plain text editor such as Notepad.
3. Check the IPs, uuid.bios, and MAC addresses.
For example:
Check virtual computer UUID
- uuid.bios = "42 23 d6 5d f2 d5 22 41-87 41 86 83 ea 2f 23 ac"
Check EPSec Settings
- VFILE.globaloptions = "svmip=169.254.50.39 svmport=8888"
- scsi0:0.filters = "VFILE"
Check DvFilter Settings
- ethernet0.filter0.name = "dvfilter-dsa"
- ethernet0.filter0.onFailure = "failOpen"
- ethernet0.filter0.param0 = "4223d65d-f2d5-2241-8741-8683ea2f23ac"
- ethernet0.filter0.param2 = "1"
- ethernet0.filter0.param1 = "00:50:56:A3:02:D8"
4. Go to the Deep Security Manager dashboard, double-click the VM > Interfaces, and verify
the IPs and MAC addresses.
5. Compare the IP and MAC address with the results from above.
1065
Trend Micro Deep Security On-Premise 20
Check the VM's interface information in the Deep Security Virtual Appliance
1. Use the vCenter Server datastore browser to download the specific vmx file of the virtual
computer.
2. Open the vmx file using a plain text editor such as Notepad.
3. Check the uuid.bios value.
4. Log on to the Deep Security Virtual Appliance console and press Alt + F2 to switch to
command mode and then enter the Deep Security Virtual Appliance user name and
password.
5. Run the following command to determine whether the VM's network interface was
recognized by Deep Security Virtual Appliance. (Note: Replace $uuid with your actual bios
uuid.)
cd /var/opt/ds_agent/guests/$uuid
>/opt/ds_guest_agent/ratt if
6. Execute the ifconfig -a command to verify if the Deep Security Virtual Appliance NIC
settings and IP are configured correctly.
7. Compare the IP and MAC address with the results from above.
Workaround Options
If any of the above items are out of sync then you need to fix this issue.
Option 1
When cloning an activated VM in Deep Security, you might receive the out-of-sync interface alert
if you power on and activate the cloned computer. As a work around, clean the dvfilter settings
before powering on the cloned computer.
l ethernet0.filter0.name = "dvfilter-dsa"
l ethernet0.filter0.onFailure = "failOpen"
l ethernet0.filter0.param0 = "4223d65d-f2d5-2241-8741-8683ea2f23ac"
l ethernet0.filter0.param2 = "1"
l ethernet0.filter0.param1 = "00:50:56:A3:02:D8"
Option 2
1. Suspend the VM and power it on again.
2. Restart the Deep Security Virtual Appliance.
3. Deactivate the VM and then activate it again.
1066
Trend Micro Deep Security On-Premise 20
Option 3
Use vMotion to move the VM to a protected ESXi host and then dismiss the warning message.
Note: The vCenter must be connected to the Deep Security Manager all the time. Otherwise,
the out-of-sync interface issue will happen repeatedly.
Further Troubleshooting
1. Provide the results of the step from above where you verified the IP and MAC Addresses in
"Check the VM's interface information in the Deep Security Virtual Appliance " on the
previous page
2. Get the rattif.txt file from the step from above where you verified that the VM's interface was
recognized by Deep Security Virtual Appliance.
3. Get the output from the following commands:
$ ls -alR > /home/dsva/ls.txt
$ netstat -an > /home/dsva/netstat.txt
$ ps auxww > /home/dsva/ps.txt
$ lsof > /home/dsva/lsof.txt
$ ifconfig -a > /home/dsva/ifconfig.txt
$ cp /var/log/syslog /home/dsva/syslog.txt
4. Get the diagnostic packages for the Deep Security Manager, Deep Security Agent, and the
Deep Security Virtual Appliance.
5. Collect the following files and send them to Trend Micro Technical Support.
l rattif.txt
l ls.txt
l netstat.txt
l ps.txt
l lsof.txt
l ifconfig.txt
l syslog.txt
If you cannot find the MAC address of the virtual computer from the output of the ratt if
command, then use the following workaround:
1. Deploy a virtual computer from a template in vCenter.
2. Delete the existing NIC.
1067
Trend Micro Deep Security On-Premise 20
3. Power on this virtual computer but there is no need to log on.
4. Power off this virtual computer.
5. Add a new NIC.
6. Power on the virtual computer.
Error: Intrusion Prevention Rule Compilation Failed
This error can occur for a variety of reasons. To confirm the error is legitimate:
Resend the policy
1. On the Deep Security Manager, click Computers.
2. Right-click the computer where the error occurred.
3. Go to Actions > Send Policy.
Re-check status
1. On the Deep Security Manager, click Computers.
2. Right-click the computer where the error occurred.
3. Go to Actions > Clear Warnings/Errors.
4. Once the warnings and errors are cleared, go to Actions > Check Status.
If the error continues to occur after completing the above steps, troubleshoot the issue with the
solutions below:
l "Apply Intrusion Prevention best practices" below
l "Manage rules" below
l "Unassign application types from a single port" on the next page
If the error persists, contact technical support.
Apply Intrusion Prevention best practices
The Intrusion Prevention Rule Compilation Failed error can occur due to a lack of resources on
the machine, such as space, memory, or CPU. To help resolve this issue, apply the best
practices on "Performance tips for intrusion prevention" on page 655.
Manage rules
The Intrusion Prevention Rule Compilation Failed error can occur when the number of assigned
Intrusion Prevention rules exceeds the recommended count. You should not have more than 400
Intrusion Prevention rules on an endpoint. It is recommended to only apply the Intrusion
1068
Trend Micro Deep Security On-Premise 20
Prevention rules that a recommendation scan suggests in order to avoid applying unnecessary
rules. If you are applying Intrusion Prevention rules manually, apply them to the computer rather
than the policy to avoid adding too many application types to a single port.
To resolve the issue, reduce the number of assigned rules:
1. Access the Intrusion Prevention rules depending on how you assigned them. Do either of
the following:
l At the computer level, go to the Computers tab, right-click the computer and select
Details.
l At the policy level, go to the Policies tab, right-click the policy and select Details.
2. Go to Intrusion Prevention and click Scan for Recommendations.
3. Once the scan is complete, click Assign/Unassign. At the top of the window, filter the rules
by Recommended for Unassignment.
4. To unassign a rule, select the check box next to the rule name. Alternatively, to unassign
several rules at once use the Shift or Control keys to select the rules.
5. Right-click the rule or selection of rules to be removed and go to Unassign Rule(s) > From
All Interfaces, then click OK. Close the window.
6. On the Computers tab right-click the computer, and go to Actions > Clear
Warnings/Errors. The Intrusion Prevention engine will automatically attempt a rule
compilation. The duration of the process will depend on the heartbeat interval and
communication settings between Deep Security Manager and Agent.
Tip: If you've applied Intrusion Prevention rules through a policy and are unsure which
computers are affected, open the Policy editor 1 and go to Overview > Computer(s) Using This
Policy.
Unassign application types from a single port
The Intrusion Prevention Rule Compilation Failed error can occur when a single port is assigned
with too many application types. Currently, a port can only be assigned to eight application
types.
To resolve the issue, remove an assigned application type from a port:
1. To determine which rule encountered the issue, double-click the error to open the Event
Viewer.
2. Go to the Computers tab.
1To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
1069
Trend Micro Deep Security On-Premise 20
3. Right-click the computer with the misconfigured Intrusion Prevention rule and select
Details.
4. Go to Intrusion Prevention.
5. Click Assign/Unassign. In the search bar, enter the name of the misconfigured rule.
6. Right-click the rule and select Application Type Properties.
7. Deselect the Inherited check box.
8. Delete the port and enter a new one.
9. Click Apply and OK.
Error: Log Inspection Rules Require Log Files
If a log inspection rule requires you to add the location of the files to be monitored, of if you add
an unnecessary log inspection rule and the files do not exist on your machine, the following error
will occur in the Computer 1 or Policy editor 2:
To resolve the error:
1. Click on the Log Inspection Rules Require Log Files error. A window will open with more
information about the error. Under Description, the name of the rule causing the error will
be listed.
2. In the Deep Security Manager, go to Policies > Common Objects > Rules > Log
Inspection Rules and locate the rule that is causing the error.
3. Double-click the rule. The rule's properties window will appear.
4. Go to the Configuration tab.
If the file's location is required:
1. Enter the location under Log Files to monitor and click Add.
2. Click OK. Once the agent receives the policy, the error will clear.
If the files listed do not exist on the protected machine:
1. Go to the Computer 3 or Policy editor 4 > Log Inspection.
2. Click Assign/Unassign.
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
2To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
3To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
4To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
1070
Trend Micro Deep Security On-Premise 20
3. Locate the unnecessary rule and uncheck the checkbox.
4. Click OK. Once the agent receives the policy, the error will clear.
To prevent this error, run a recommendation scan for suggested rules:
1. On the Deep Security Manager, go to Computers.
2. Right-click the computer you'd like to scan and click Actions > Scan for
Recommendations.
3. View the results on the General tab of the protection module in the Computer 1 or Policy
editor 2.
Error: Module installation failed (Linux)
The error message "Module Installation Failed" indicates that your operating system's kernel
version is not supported by the Deep Security network driver, or file system hook. These
circumstances can cause engine offline alerts. Lack of a compatible network driver is the most
common cause of this message.
When you apply intrusion prevention, web reputation, or firewall, the Deep Security Agent
installs a network driver so it can examine traffic. Anti-malware and integrity monitoring install a
file system hook module. This is required to monitor file system changes in real time. (Scheduled
scans do not require the same file system hook.)
An update may be in progress. Trend Micro monitors many vendors for new kernel releases.
After completing quality assurance tests, we release an update with support for these kernels. To
ask when support for your kernel version will be supported, contact technical support. (When
logged in, you can click Support in the top right corner.)
Your system will install the module support update automatically when it becomes available.
To view supported operating system kernel versions, see "Deep Security Agent Linux kernel
support" on page 143.
Error: There are one or more application type conflicts on this computer
This error message appears in the DPI Events tab in Deep Security Manager when updating the
Deep Security Agents:
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
2To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
1071
Trend Micro Deep Security On-Premise 20
There are one or more application type conflicts on this computer. One or more DPI rules
associated with one application type are dependent on one or more DPI rules associated with
another application type. The conflict exists because the two application types use different
ports.
The conflicting application types are:
[A] "Web Application Tomcat" Ports: [80,8080,4119]
[B] "Web Server Common" Ports:
[80,631,8080,7001,7777,7778,7779,7200,7501,8007,
8004,4000,32000,5357,5358,9000]
[A] "Web Server Miscellaneous" Ports:
[80,4000,7100,7101,7510,8043,8080,8081,8088,8300,8500,
8800,9000,9060,19300,32000,3612,10001,8093,8094]
[B] "Web Server Common" Ports:
[80,631,8080,7001,7777,7778,7779,7200,7501,8007,
8004,4000,32000,5357,5358,9000]"
Resolution
To resolve the conflict, edit the port numbers used by application types B so that they include the
port numbers used by application types A. The two application types (Web Application Tomcat
and Web Server Miscellaneous) are both dependent on the application type Web Server
Common. This is why the ports listed in the first two application types should also appear in the
Web Server Common ports.
If you consolidate the port numbers for these three application types, the result is as follows:
80,631,3612,4000,4119,5357,5358,7001,7100,7101,7200,7501,7510,7777,7778,777
9,
8004,8007,8043,8080,8081,8088,8093,8094,8300,8500,8800,9000,9060,10001,1930
0,32000
After adding this to the Web Server Common port list, you will see the following message in the
Events tab: The Application Type Port List Misconfiguration has been resolved.
Consolidate ports
1. Log on to Deep Security Manager and go to Policies > Rules > Intrusion Prevention
Rules.
2. Search for Web Server Common in the search box in the and double-click the Web Server
Common application type.
1072
Trend Micro Deep Security On-Premise 20
3. Go to General > Details > Application type > Edit > Web server common.
4. Go to General > Connection > Port and click Edit to replace all of the ports with this
consolidated entry: 80,631,3612,4000,4119,5357,5358,7001,7100,7101,7200,
7501,7510,7777,7778,7779,8004,8007,8043,8080,8081,8088,8093,
8094,8300,8500,8800,9000,9060,10001,19300,32000
5. Click OK.
Disable the inherit option
It is also recommended that administrators disable the inherit option for DPI for a security profile.
Any change you make to the application type will only affect this particular security profile.
1. Log on to Deep Security Manager and go to Security Profiles.
2. Double-click a security profile in the right pane.
3. Go to the DPI section and click to clear Inherit .
4. Click OK.
Check the IPS rule 1000128.
1. Right-click Application Type Properties.
2. Click to clear Inherit.
3. Verify that the current inherited port list contains the listening port number for the Deep
Security Manager's GUI. If not, add this port to the Web Server Common port group.
4. Click Inherit.
Error: Unable to connect to the cloud account
When adding an Amazon Cloud account, the error "Unable to connect to the cloud account" can
occur. The cause can be:
l invalid key ID or secret
l incorrect permissions
l failed network connectivity
Your AWS account access key ID or secret access key is invalid
To resolve this:
Verify the security credentials that you entered.
1073
Trend Micro Deep Security On-Premise 20
The incorrect AWS IAM policy has been applied to the account being used by
Deep Security
To resolve this:
Go you your AWS account and review the IAM policy for that account.
The AWS IAM policy must have these permissions:
l Effect: Allow
l AWS Service: Amazon EC2
l Select the following Actions:
l DescribeImages
l DescribeInstances
l DescribeTags
l Amazon Resource Name (ARN) to: *
NAT, proxy, or firewall ports are not open, or settings are incorrect
This can occur in a few cases, including if you are deploying a new Deep Security Manager
installation using the AMI on AWS Marketplace.
Your Deep Security Manager must be able to connect to the Internet, specifically to Amazon
Cloud, on the required port numbers.
To resolve this:
You may need to:
l configure NAT or port forwarding on a firewall or router between your AMI and the Internet
l get an external IP address for your AMI
The network connection must also be reliable. If it is intermittent, this error message may occur
sometimes (but not every time).
Error: Unable to resolve instance hostname
The error message "Unable to Resolve Instance Hostname" may occur as a result of activating
the Agent from Deep Security Manager when you are not using agent-initiated activation.
1074
Trend Micro Deep Security On-Premise 20
We recommend that you always use Agent-Initiated Activation.To learn how to configure policy
rules for agent-initiated communication and deploy agents using deployment scripts, see
"Activate and protect agents using agent-initiated activation and communication" on page 1138.
Alert: Integrity Monitoring information collection has been delayed
This alert indicates that the rate at which integrity monitoring information is collected has been
temporarily delayed. The delay is due to an increase in the volume of integrity monitoring data
that is being transmitted from agents to Deep Security Manager. During this time the baseline
and integrity monitoring event views may not be current for some computers.
This alert is automatically dismissed when the collection of integrity monitoring data is no longer
delayed.
For more information about integrity monitoring, see "Set up Integrity Monitoring" on page 705.
Alert: Manager Time Out of Sync
The system time on the Deep Security Manager operating system must be synchronized with the
time on the database computer. This alert appears in the Alert Status widget of the manager
console when the computer times are more than 30 seconds out of sync.
To synchronize the times, apply the following configurations:
l Configure the database and all manager nodes to use the same time zone.
l Ensure that the database and all manager nodes are synchronizing time to the same time
source.
l If the manager runs on a Linux operating system, ensure the ntpd daemon is running.
Alert: The memory warning threshold of Manager Node has been
exceeded
The Memory Warning Threshold Exceeded or Memory Critical Threshold Exceeded alerts
appear in Deep Security to alert you that a host's memory usage has exceeded a certain
amount. A warning alert indicates that 70% of the host's memory is used, and a critical alert
indicates that usage has exceeded 85%.
To resolve this issue, determine whether there are processes unexpectedly consuming a large
amount of memory:
1075
Trend Micro Deep Security On-Premise 20
l If the identified process is not Deep Security Manager, remove or eliminate the processes
from the host. Deep Security Manager should run on a dedicated host computer.
l If the process is Deep Security Manager, increase the amount of the host memory. Refer to
"Sizing" on page 172 for guidelines.
Note: By default, the maximum heap size of Deep Security Manager is 4 GB. That means
Deep Security Manager allocates a maximum 4 GB heap; however, the JVM allocates not only
heap but also non-heap. Consequently, the maximum total memory size of the Deep Security
Manager process will be larger than 4 GB.
Note: If the host is a VM, we strongly suggest that you reserve all guest memory for the VM.
Event: Max TCP connections
Deep Security is configured to allow a maximum number of TCP connections to protected
computers. When the number of connections exceeds the maximum, network traffic is dropped
and Max TCP Connections firewall events occur. To prevent dropped connections, increase the
maximum allowed TCP connections on the computer where the Max TCP Connection event
occurs.
Note: The intrusion protection module enables the network engine which enforces the
allowed number of TCP connections.
1. In Deep Security Manager, click Policies.
2. Determine which policy to configure to affect the computer in question. See "Policies,
inheritance, and overrides" on page 451.
3. To open the policy that you want to configure, double-click the policy.
4. In the left-hand pane, click Settings and then click the Advanced tab.
5. In the Advanced Network Engine Settings area, if Inherit is selected clear the checkbox to
enable changes.
6. Increase the value of the Maximum TCP Connections property to 10000 or more,
according to your needs.
7. Click Save.
1076
Trend Micro Deep Security On-Premise 20
Warning: Census, Good File Reputation, and Predictive Machine
Learning Service Disconnected
The Census, Good File Reputation, and Predictive Machine Learning Services are security
services hosted by the Trend Micro Smart Protection Network. They are necessary for the full
and successful operation of the Deep Security behavior monitoring, predictive machine learning,
and process memory scan features.
The following table maps the services to features.
Service name Required for these features
Global Census Service behavior monitoring, predictive machine learning
behavior monitoring, predictive machine learning, process
Good File Reputation Service
memory scans
Predictive Machine Learning
predictive machine learning
Service
If you see the alert...
Census, Good File Reputation, and Predictive Machine Learning Service Disconnected
...there are a few causes:
l "Cause 1: The agent or relay-enabled agent doesn't have Internet access" below
l "Cause 2: A proxy was enabled but not configured properly" on the next page
Cause 1: The agent or relay-enabled agent doesn't have Internet access
If your agent or relay-enabled agent doesn't have access to the Internet, then it can't reach these
services.
Solutions:
l Check your firewall policies and ensure that the outbound HTTP and HTTPS ports (by
default, 80 or 443) are open.
l If you are unable to open those ports, see "Configure agents that have no internet access"
on page 1131 for other solutions.
1077
Trend Micro Deep Security On-Premise 20
Cause 2: A proxy was enabled but not configured properly
The Census, Good File Reputation and Predictive Machine Learning Services can be accessed
using a proxy.
To check whether a proxy was enabled and make sure it was configured properly:
1. Open the Computer or Policy editor 1.
2. On the left, click Settings.
3. In the main pane, click the General tab.
4. Find the heading titled, Network Setting for Census, Good File Reputation Service, and
Predictive Machine Learning.
5. If a proxy was specified, click Edit and make sure its Proxy Protocol, Address, Port and
optional User Name and Password are accurate.
Warning: Insufficient disk space
An "Insufficient Disk Space" warning indicates that the computer where the Deep Security Agent
or Appliance is running is low on disk space and may not be able to store more events. If you
open the warning to display its details, it will show you the location of the agent or appliance,
how much free space is left, and how much is required by the agent or appliance.
To fix this issue, check the drive or file system that's affected and clear anything you can.
Note: The agent or appliance will continue to protect your instance even if the drive is out of
space; however, it will stop recording events.
Tips
l Even though the warning is generated by the Deep Security Agent or Appliance, another
program that shares the same file system could be causing the space issue.
l Deep Security Agent automatically truncates and rotates its log files.
l Deep Security Agent will clean up its own log files, but not those of other applications.
l Deep Security Manager does not automatically clear the "Insufficient Disk Space"
warnings, but you can manually clear them from Deep Security Manager.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1078
Trend Micro Deep Security On-Premise 20
Warning: Reconnaissance Detected
The reconnaissance scan detection feature serves as an early warning of a potential attack or
intelligence gathering effort against a network.
Types of reconnaissance scans
Deep Security can detect several types of reconnaissance scans:
l Computer OS Fingerprint Probe: The agent or appliance detects an attempt to discover
the computer's OS.
l Network or Port Scan: The agent or appliance reports a network or port scan if it detects
that a remote IP is visiting an abnormal ratio of IPs to ports. Normally, an agent or
appliance computer will only see traffic destined for itself, so a port scan is the most
common type of probe that will be detected. The statistical analysis method used in
computer or port scan detection is derived from the "TAPS" algorithm proposed in the
paper "Connectionless Port Scan Detection on the Backbone" presented at IPCCC in
2006.
l TCP Null Scan: The agent or appliance detects packages with no flags set.
l TCP SYNFIN Scan: The agent or appliance detects packets with only the SYN and FIN
flags set.
l TCP Xmas Scan: The agent or appliance detects packets with only the FIN, URG, and
PSH flags set or a value of 0xFF (every possible flag set).
Suggested actions
When you receive a Reconnaissance Detected alert, double-click it to display more detailed
information, including the IP address that is performing the scan. Then, you can try one of these
suggested actions:
l The alert may be caused by a scan that is not malicious. If the IP address listed in the alert
is known to you and the traffic is okay, you can add the IP address to the reconnaissance
allow list:
1079
Trend Micro Deep Security On-Premise 20
a. In the Computer or Policy editor 1, go to Firewall > Reconnaissance.
b. The Do not perform detection on traffic coming from list should contain a list name. If
a list name hasn't already been specified, select one.
c. You can edit the list by going to Policies > Common Objects > Lists > IP Lists.
Double-click the list you want to edit and add the IP address.
l You can instruct the agents and appliances to block traffic from the source IP for a period of
time. To set the number of minutes, open the Computer or Policy editor 2, go to Firewall >
Reconnaissance and change the Block Traffic value for the appropriate scan type.
l You can use a firewall or Security Group to block the incoming IP address.
Note: Deep Security Manager does not automatically clear the "Reconnaissance Detected"
alerts, but you can manually clear the issue from Deep Security Manager.
For more information on reconnaissance scans, see "Firewall settings" on page 685.
Configure proxies
Configure proxies
You can configure proxies between various Trend Micro servers and services.
In this topic:
l "Register a proxy in the manager" on the next page
l "Supported proxy protocols" on the next page
l "Connect to the 'primary security update source' via proxy" on page 1082
l "Connect to Deep Security Relays via proxy" on page 1084
l "Connect to Deep Security Manager via proxy" on page 1082
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1080
Trend Micro Deep Security On-Premise 20
l "Connect to Deep Security Software Updates, CSSS, and more via proxy" on page 1085
l "Connect to cloud accounts via proxy" on page 1086
l "Connect to Deep Discovery Analyzer via proxy" on page 1086
l "Connect to Apex Central via proxy" on page 1086
l "Connect to the Smart Protection Network via proxy" on page 1087
l "Remove a proxy " on page 1088
Register a proxy in the manager
1. In Deep Security Manager, go to Administration > System Settings > Proxies.
2. In the Proxy Servers area, click New > New Proxy Server.
3. In the Name and Description fields, enter a friendly name and description for your proxy.
4. For the Proxy Protocol, select either HTTP, SOCKS4, or SOCKS5. Not all protocols are
supported by all components. See "Supported proxy protocols" below for details.
5. In the Address and Port fields, enter the IP address or URL of the proxy as well its port (by
default 8080 or 80 for HTTP; 3128 for the Squid HTTP proxy; 443 for HTTPS; and 1080 for
SOCKS 4 and 5).
6. Enable Proxy requires authentication credentials if you previously set up your HTTP or
SOCKS 5 proxy to require authentication from connecting components. Enter those
credentials in the User Name and Password fields.
Supported proxy protocols
The table lists the proxy protocols supported by the Trend Micro services and clients. You'll need
this information when registering a proxy, and when configuring a proxy through dsa_control.
HTTP SOCKS4 SOCKS5
Service Origin (client)
Support Support Support
Deep Security Manager Agents/Relays Yes No No
Deep Security Relays Agents/Relays Yes Yes Yes
Deep Security Software Updates, Certified Safe
Software Service (CSSS), News Updates, Manager Yes No No
Product Registration and Licensing
Deep Security Anonymous Product Usage Data
Manager Yes No No
Collection
Cloud accounts (AWS, Azure, Google Cloud
Manager Yes No No
Platform, VMware vCloud)
Deep Discovery Analyzer Manager Yes No No
Apex Central (formerly "Control Manager") Manager Yes No No
Smart Protection Network - Census, Good File Agents Yes No No
1081
Trend Micro Deep Security On-Premise 20
HTTP SOCKS4 SOCKS5
Service Origin (client)
Support Support Support
Reputation, and Predictive Machine Learning
Smart Protection Network - Global Smart
Agents Yes No No
Protection Service
Smart Protection Network - Smart Feedback Manager Yes No Yes
Connect to the 'primary security update source' via proxy
You can connect your agents, appliances, and relays to your 'primary security update source' via
a proxy. By default, the 'primary security update source' is the Trend Micro Update Server (also
called Active Update).
Note: The agents and appliances1 will only use the proxy if their assigned relay is not
available, and they've been granted explicit permission to access the primary update source.
1. Make sure you're using Deep Security Agent 10.0 or later. Only 10.0 and later supports
connections through a proxy.
2. "Register a proxy in the manager" on the previous page.
3. In Deep Security Manager, click the Administration > System Settings > Proxies tab.
4. In the Proxy Server Use area, change the Primary Security Update Proxy used by
Agents, Appliances, and Relays setting to point to the new proxy.
5. Click Save.
6. Restart the agents.
Connect to Deep Security Manager via proxy
Agents connect to their manager during agent activation and heartbeats. There are two methods
to connect an agent to its manager via a proxy.
Connect an agent to the manager via a proxy using a deployment script
1. Make sure you're using Deep Security Agent 10.0 or later. Only 10.0 and later
supports connections through a proxy.
1The Deep Securty Agent and Deep Security Virtual Appliance are the components that enforce the Deep Security policies that you have
defined. Agents are deployed directly on a computer. Appliances are used in VMware vSphere environments to provide agentless protection.
They are not available with Deep Security as a Service.
1082
Trend Micro Deep Security On-Premise 20
2. "Register a proxy in the manager" on page 1081.
3. In the top right-hand corner of Deep Security Manager, click Support >
Deployment Scripts.
4. From Proxy to contact Deep Security Manager, select a proxy.
5. Copy the script or save it.
6. Run the script on the computer. The script installs the agent and configures it to
connect to the manager through the specified proxy.
Connect an agent to the manager via a proxy using dsa_control
On a Windows agent:
l Open a command prompt (cmd.exe) as Administrator and enter:
cd C:\Program Files\Trend Micro\Deep Security Agent\
dsa_control -u myUserName:MTPassw0rd
dsa_control -x dsm_proxy://squid.example.com:443
On a Linux agent:
l Enter:
/opt/ds_agent/dsa_control -u myUserName:MTPassw0rd
/opt/ds_agent/dsa_control -x dsm_proxy://squid.example.com:443
Notes:
l Make sure the proxy uses a supported protocol. See "Supported proxy protocols"
on page 1081.
l For details on dsa_control and its -u and -x options, see "dsa_control" on
page 1348.
l Repeat these commands on each agent that needs to connect through a proxy to
the manager.
l Run the following commands to update the agent's local configuration. No policy
or configuration changes are made in the manager as a result of running these
commands.
1083
Trend Micro Deep Security On-Premise 20
Connect to Deep Security Relays via proxy
Agents connect to their relay to obtain software and security updates. There are two methods to
connect an agent to a relay via a proxy.
Connect an agent to relays via a proxy using a deployment script
1. Make sure you're using Deep Security Agent 10.0 or later. Only 10.0 and later
supports connections through a proxy.
2. "Register a proxy in the manager" on page 1081
3. In the top right-hand corner of Deep Security Manager, click Support >
Deployment Scripts.
4. From Proxy to contact Relay(s), select a proxy.
5. Copy the script or save it.
6. Run the script on the computer. The script installs the agent and configures it to
connect to the relay through the specified proxy.
Connect an agent to relays via a proxy using dsa_control
On a Windows agent:
l Open a command prompt (cmd.exe) as Administrator and enter these commands:
cd C:\Program Files\Trend Micro\Deep Security Agent\
dsa_control -w myUserName:MTPassw0rd
dsa_control -y relay_proxy://squid.example.com:443
On a Linux agent:
l Enter:
/opt/ds_agent/dsa_control -w myUserName:MTPassw0rd
/opt/ds_agent/dsa_control -y relay_proxy://squid.example.com:443
Notes:
l Make sure the proxy uses a supported protocol. See "Supported proxy protocols"
on page 1081.
1084
Trend Micro Deep Security On-Premise 20
l For details on dsa_control and its -w and -y options, see "dsa_control" on
page 1348.
l Repeat these commands on each agent that needs to connect through a proxy to
the manager.
l Run the following commands to update the agent's local configuration. No policy
or configuration changes are made in the manager as a result of running these
commands.
Connect to Deep Security Software Updates, CSSS, and more via
proxy
You can connect your agents to the following Deep Security cloud-based servers and services
via a proxy:
l Software Update server (also called the Download Center)
l Certified Safe Software Service (CSSS), which is a feature of the Integrity Monitoring
module
l News Update service
l Product Registration service
l Licensing service
l Deep Security Anonymous Product Usage Data Collection service (also called the
Telemetry service)
1. "Register a proxy in the manager" on page 1081.
2. In Deep Security Manager, click Administration at the top.
3. In the main pane, click the Proxies tab.
4. Next to (Software Updates, CSSS, News Updates, Product Registration and Licensing),
select your proxy.
5. Click Save.
6. "Restart the Deep Security Manager" on page 1345 and all manager nodes so that the
CSSS proxy settings take effect.
1085
Trend Micro Deep Security On-Premise 20
Connect to cloud accounts via proxy
You can connect the manager to an AWS, Azure, or GCP cloud account via a proxy. For more
on these accounts, see "About adding AWS accounts" on page 393, "Add a Microsoft Azure
account to Deep Security" on page 416, and "Add a Google Cloud Platform account" on
page 429.
1. "Register a proxy in the manager" on page 1081.
2. In Deep Security Manager, click Administration at the top.
3. In the main pane, click the Proxies tab.
4. Next to Deep Security Manager (Cloud Accounts - HTTP Protocol Only), select your
proxy.
5. Click Save.
Connect to Deep Discovery Analyzer via proxy
You can connect your manager to Deep Discovery Analyzer via a proxy. For more on Deep
Discovery Analyzer, see "Detect emerging threats using Connected Threat Defense" on
page 580.
1. "Register a proxy in the manager" on page 1081.
2. In Deep Security Manager, click Administration at the top.
3. In the main pane, select the Connected Threat Defense tab.
4. Find the When accessing Deep Discovery Analyzer, use proxy check box, and in the list,
select your proxy.
5. Click Save.
Connect to Apex Central via proxy
You can connect your manager to Apex Central via a proxy. For more on Apex Central, see
"Detect emerging threats using Connected Threat Defense" on page 580.
1. "Register a proxy in the manager" on page 1081.
2. In Deep Security Manager, click Administration at the top.
3. In the main pane, select the Connected Threat Defense tab.
4. Find the When accessing Apex Central, use proxy check box, and in the list, select your
proxy.
5. Click Save.
1086
Trend Micro Deep Security On-Premise 20
Connect to the Smart Protection Network via proxy
Use the following procedure to configure a proxy between agents and the following services in
the Smart Protection Network: Global Census, Good File Reputation, Predictive Machine
Learning, and the Smart Protection Network itself.
1. "Register a proxy in the manager" on page 1081.
2. In Deep Security Manager, click Policies at the top.
3. In the main pane, double-click the policy that you use to protect computers that are behind
the proxy.
4. Set up a proxy to the Global Census, Good File Reputation, and Predictive Machine
Learning Services as follows:
a. Click Settings on the left.
b. In the main pane, click the General tab.
c. In the main pane, look for the Network Setting for Census and Good File Reputation
Service, and Predictive Machine Learning section.
d. If the Inherited check box is selected, the proxy settings are inherited from the parent
policy. To change the settings for this policy or computer, clear the check box.
e. Select When accessing Global Server, use proxy and in the list, select your proxy, or
select New to specify another proxy.
f. Save your settings.
5. Set up a proxy to the Smart Protection Network for use with Anti-Malware:
a. Click Anti-Malware on the left.
b. In the main pane, click the Smart Protection tab.
c. Under Smart Protection Server for File Reputation Service, if the Inherited check box
is selected, the proxy settings are inherited from the parent policy. To change the
settings for this policy or computer, clear the check box.
d. Select Connect directly to Global Smart Protection Service.
e. Select When accessing Global Smart Protection Service, use proxy and in the list,
select your proxy or select New to specify another proxy.
f. Specify your proxy settings and click OK.
g. Save your settings.
6. Set up a proxy to the Smart Protection Network for use with Web Reputation:
a. Click Web Reputation on the left.
b. In the main pane, click the Smart Protection tab.
c. Under Smart Protection Server for Web Reputation Service, set up your proxy, the
same way you did under Anti-Malware in a previous step.
d. With Web Reputation still selected on the left, click the Advanced tab.
e. In the Ports section, select a group of port numbers that includes your proxy's listening
port number, and then click Save. For example, if you’re using a Squid proxy server,
1087
Trend Micro Deep Security On-Premise 20
you would select the Port List Squid Web Server. If you don’t see an appropriate
group of port numbers, go to Policies > Common Objects > Lists > Port Lists and then
click New to set up your ports.
f. Save your settings.
7. Send the new policy to your agents. See "Send policy changes manually" on page 450.
Your agents now connect to the Smart Protection Network through a proxy.
Remove a proxy
To remove a proxy between agent and manager, or agent and relay
l Redeploy agents using new deployment scripts that no longer contain proxy
settings. For details, see "Use deployment scripts to add and protect computers"
on page 1401.
OR
l Run the following dsa_control commands on the agents:
dsa_control -x ""
dsa_control -y ""
These commands remove the proxy settings from the agent's local configuration.
No policy or configuration changes are made in the manager as a result of running
these commands.
For details on dsa_control and its -x and -y options, see "dsa_control" on
page 1348.
To remove a proxy between any other components
Run through the instructions on connecting through a proxy, but complete them in
reverse, so that you remove the proxy.
1088
Trend Micro Deep Security On-Premise 20
Proxy settings
You can configure proxies between various Trend Micro components. For details, see
"Configure proxies" on page 1080.
Proxy server use
To view and edit the list of available proxies, go to Administration > System Settings > Proxies.
l Primary Security Update Proxy used by Agents, Appliances, and Relays: For information
on this setting, see "Connect to the 'primary security update source' via proxy" on
page 1082.
l Deep Security Manager (Software Updates, CSSS, News Updates, Product
Registration and Licensing): For information on this setting, see "Connect to Deep
Security Software Updates, CSSS, and more via proxy" on page 1085.
l Deep Security Manager (Cloud Accounts - HTTP Protocol Only): For information on this
setting, see "Connect to cloud accounts via proxy" on page 1086
Configure relays
How relays work
Relays redistribute both software updates and security updates to your agents and virtual
appliances to help your deployment perform well at scale. (Alternatively, software updates — but
not security updates — can be distributed by a local mirror web server.) Relays can:
l Reduce WAN bandwidth costs by reducing external update traffic
l Speed up update distribution in large scale deployments
l Provide update distribution redundancy
l Temporarily store Integrity Monitoring data and some other files during VMware vMotion of
a protected computer
Update sources are different for relays and agents or virtual appliances, depending on their
parent relay group and the type of update.
1089
Trend Micro Deep Security On-Premise 20
Agents get a randomly ordered list of relays for their assigned relay group. When an agent needs
to download an update, they try the first relay. If there's no response, the agent tries the next in
the list until it can successfully download the update. Because the list is random for each agent,
this distributes update load evenly across relays in a group.
Note: If relays/agents and virtual appliances can't connect to their the manager/relay, they will
use their fallback update sources. For best performance, network connectivity between Deep
Security components should be reliable.
1090
Trend Micro Deep Security On-Premise 20
Unlike other rule updates, Application Control rules are not downloaded from Trend Micro.
However relays can similarly redistribute shared (not local) Application Control rulesets. See
Deploy application control rulesets via relays.
Relay hierarchy, cost, and performance
Relay groups can be organized in a hierarchy: one or more first-level ("parent") relay groups
download updates directly from the manager and Primary Security Update Source (usually via
their Internet/WAN connection), and then second-level ("child") relay groups download updates
indirectly via the first-level group, and so on. If you put a child relay on each local network, then
agent updates usually use the local network connection — not remote connections to the Internet.
This saves external connection bandwidth (a typical performance bottleneck) and makes
updates faster, especially for large deployments with many networks or data centers.
Performance and bandwidth usage can be affected by relay group hierarchy. Hierarchy can
specify:
l Update order — Child relay sub-groups download from their parent group, which must
finish its own download first. So a chain of sub-groups can be useful if you want a delay, so
that all updates aren't at the exact same time.
l Cost — If large distances or regions are between your parent and child relay groups, it
might be cheaper for them to download directly instead of via parent relay groups.
l Speed — If many or low-bandwidth subnets are between your parent and child relay
groups, it might be faster for them to download directly or via a grandparent instead of via
parent relay groups. However if too many relays do this, it will consume external
connection bandwidth and eventually decrease speed.
Hierarchies are set up during relay group creation. For details, see "Create relay groups" on
page 1096.
Deploy additional relays
After deploying your first Deep Security Relay, you should deploy at least one more for
redundancy and load-balancing reasons. You may even need to deploy more depending on the
size and scope of your deployment.
When deploying relays, you must:
1. "Plan the best number and location of relays" on the next page
2. "Configure the update source" on page 1094
1091
Trend Micro Deep Security On-Premise 20
3. "Configure relays" on page 1096
Warning: Too many relays on your network will decrease performance — not improve it. A
relay requires more system resources than an ordinary agent. Extra relays might be competing
for bandwidth, too, instead of minimizing external connections. If required, you can convert a
relay back to a normal Deep Security Agent. See "Remove relay functionality from an agent"
on page 1099.
Plan the best number and location of relays
The optimal number and placement of relays depends on:
l "Geographic region and distance" on the next page
l "Network architecture and bandwidth limits" on the next page
l "Air-gapped environments" on page 1094
1092
Trend Micro Deep Security On-Premise 20
Geographic region and distance
Ideally, each geographic region should have its own relay group with at least 2 relays.
Agents should use local relays in their same geographic region. Long distance and network
latency can slow down update redistribution. Downloading from other geographic regions can
also increase network bandwidth and/or cloud costs.
Network architecture and bandwidth limits
Ideally, each network segment of agents or virtual appliances with limited bandwidth should
have its own relay group with at least 2 relays.
1093
Trend Micro Deep Security On-Premise 20
Low bandwidth Internet/WAN connections, routers, firewalls, VPNs, VPCs, or proxy devices
(which can all define a network segment) can be bottlenecks when large traffic volumes travel
between the networks. Bottlenecks slow down update redistribution. Agents therefore usually
should use local relays inside the same network segment — not relays outside on bottlenecked
external networks.
For example, your relay group hierarchy could minimize Internet and internal network bandwidth
usage. Only 1 "parent" relay group might use the Internet connection; sub-groups would
download from the parent, over their local network connection. Agents and virtual appliances
would download from their local relay group.
Large scale deployments might have many agents and virtual appliances connect to each relay.
This requires relays on more powerful, dedicated servers (instead of more relays on shared
servers). See "Deep Security Agent and Relay sizing" on page 175.
Air-gapped environments
Most deployments can connect to the Internet. But if your relays cannot connect to the Trend
Micro ActiveUpdate server on the Internet because they are on an isolated network (an "air-
gapped" deployment), then you must:
1. Add a separate relay in a demilitarized zone (DMZ) (which can connect to the Internet) to
get the security updates.
2. Copy updates from the DMZ relay to your other, air-gapped relays.
For details, see "Configure agents that have no internet access" on page 1131.
Configure the update source
Before you set up relays, you should define the source of updates, and when to bypass the usual
relay hierarchy to get updates.
1. Go to Administration > System Settings > Updates.
2. Optionally, configure Primary Security Update Source and Secondary Source.
By default, the primary source is Trend Micro Update Server which is accessed via the
Internet. Don't change the setting, unless your support provider has told you to configure
Other update source. Alternative update source URLs must include "http://" or "https://".
3. Usually, agents and virtual appliances connect to a relay to get security updates when
1094
Trend Micro Deep Security On-Premise 20
Deep Security Manager tells them to. But if computers cannot always connect with the
manager or relays (such as during scheduled maintenance times) and enough
Internet/WAN bandwidth is available, you can select:
l Allow Agents/Appliances to download security updates directly from Primary
Security Update Source if Relays are not accessible
l Allow Agents/Appliances to download security updates when Deep Security
Manager is not accessible
Tip: If you protect laptops and portable computers, they might sometimes be far from
support services. To avoid risk of a potentially problematic security update while they
travel, deselect these options.
4. If you require security updates for older agents, select Allow supported 8.0 and 9.0 Agents
to be updated. By default, Deep Security Manager does not download updates for Deep
Security Agent 9.0 and earlier because most of these agents are no longer supported. For
details on which older agents are still supported, see "Deep Security LTS life cycle dates"
on page 80.
5. If you use multi-tenancy:
a. Usually, a relay will only download and distribute patterns for the region (locale) that
Deep Security Manager was installed in. This minimizes disk space usage. But if you
have tenants in other regions, select Download Patterns for all Regions.
b. Usually, the primary tenant shares its relays with other tenants. This simplifies setup
for other tenants: they don't need to set up their own relays. But if you don't want to do
this, deselect Use the Primary Tenant Relay Group as my Default Relay Group (for
unassigned Relays).
Note: If this option is deselected, when you click Administration > Updates > Relay
Groups, then the relay group name will be "Default Relay Group", not "Primary
Tenant Relay Group".
6. If you'd like Deep Security Manager to auto-import agent update builds to your local
inventory, select Automatically download updates to imported software.
Note: This setting imports the software to Deep Security Manager but will not
automatically update your agent or appliance software. See "Upgrade Deep Security
Agent" on page 1295 for more information.
7. Usually, relays connect to Deep Security Manager to get software updates to redistribute.
But if relays cannot always connect with the manager (such as during scheduled
1095
Trend Micro Deep Security On-Premise 20
maintenance times, or if an enterprise firewall is between the manager and relays), you
can select Allow Relays to download software updates from Trend Micro Download
Center when Deep Security Manager is not accessible. Relays will get software updates
directly from the Download Center instead.
Tip: Hybrid cloud environments often have some agents and relays in a public cloud,
while others (and the manager) are inside your private network. To avoid the risk of
opening port numbers on your private network firewall, or manually copying software
packages to your relays in the cloud, select this option.
8. Configure an Alternate software update distribution server(s) to replace Deep Security
Relays to specify an alternative source for software updates, noting that security updates
will still need to come from a relay. Consider an alternative server if your relay has an
elastic IP address, if you plan on configuring your relays to only receive security updates
(not software updates), or if you want to host software on a web server for efficiency and
availability reasons. Enter https://<IP_or_hostname>:<port>/ replacing <IP_or_
hostname>:<port> with one of the following:
l the private network IP address and port of the relay that has an elastic IP address
l the web server and port where you plan to host the Deep Security software
Configure relays
After determining where and how many relays you should have, and what update sources they
should use, you can:
1. "Create relay groups" below
2. "Enable relays" on the next page
3. "Assign agents to a relay group" on page 1098
4. "Connect agents to a relay's private IP address" on page 1099
Create relay groups
Relays must be organized into relay groups. The relay groups themselves can be further
organized into hierarchies.
If you installed a co-located relay during the Deep Security Manager installation, then it
automatically created a default relay group. But if you need more groups for other locations (see
"Plan the best number and location of relays" on page 1092), you can create more.
1096
Trend Micro Deep Security On-Premise 20
Tip: To minimize latency and external/Internet bandwidth usage, create a relay group for each
geographic region and/or network segment.
1. Go to Administration > Updates > Relay Management. A Relay Group Properties pane
appears on the right.
2. Click New Relay Group.
3. Type a Name for the relay group.
4. In Update Source, select either Primary Security Update Source or, if this will be a sub-
group (child), the name of the parent relay group.
Note: The Default Relay Group is not included in the list of update sources, and
therefore cannot be configured as a parent.
Tip: Select the update source with the best cost and speed. Even if a relay group is part
of a hierarchy, sometimes it might be cheaper and faster to download updates from the
Primary Security Update Source instead — not the parent relay group.
5. If this relay group must use a proxy when connecting to the Primary Security Update
Source, select the Update Source Proxy. For details, see "Connect to the 'primary security
update source' via proxy" on page 1082.
Unlike other relay groups, "Default Relay Group" uses the same proxy as Deep Security
Manager, and cannot be configured.
Note: If this relay group usually connects to a parent relay group, then the sub-group
won't use the proxy unless the parent relay group is unavailable and it is configured to
fall back to using the "Primary Security Update Source".
6. Under Update Content, select either Security and software updates or Security updates
only. If you select Security updates only, you must configure an alternative software
update source. For details, see "Configure the update source" on page 1094.
Enable relays
1. Make sure the relay computer meets the requirements. See "Deep Security Agent and
Relay sizing" on page 175 and "Deep Security Relay requirements" on page 169.
2. Make sure you allow inbound and outbound communication to and from the relay on the
appropriate port numbers. See "Deep Security port numbers" on page 179.
1097
Trend Micro Deep Security On-Premise 20
3. If the relay must connect through a proxy, see "Connect to the 'primary security update
source' via proxy" on page 1082.
4. Deploy an agent on the chosen computer. See "Get Deep Security Agent software" on
page 266 and "Install the agent" on page 273.
5. Enable the agent as a relay:
a. Log in to Deep Security Manager.
b. Click Administration at the top.
c. Click Relay Management in the left navigation pane.
d. Select the relay group into which the relay will be placed. If a relay group does not
exist, create one.
e. Click Add Relay.
f. In Available Computers, select the agent you just deployed.
g. Click Enable Relay and Add to Group.
The agent is enabled as a relay and is displayed with a relay icon ().
1. Tip: To minimize latency and external/Internet bandwidth usage, group together relays
that are in the same geographic region and/or network segment.
Tip: You can use the search field to filter the list of computers.
Assign agents to a relay group
You must indicate which relay group each agent should use. Either assign each agent to a relay
group manually, or set up an event-based task to assign new agents automatically.
1. Go to Computers.
2. Right-click the computer and select Actions > Assign Relay Group.
To assign multiple computers, Shift-click or Ctrl-click computers in the list, and then select
Actions > Assign Relay Group.
3. Select the relay group that computer should use.
Tip: To minimize latency and external/Internet bandwidth usage, assign agents to relays
that are in the same geographic region and/or network segment.
1098
Trend Micro Deep Security On-Premise 20
Connect agents to a relay's private IP address
If your relay has an elastic IP address, agents within an AWS VPC may not be able to reach the
relay via that IP address. Instead, they must use the private IP address of the relay group.
1. Go to Administration > System Settings.
2. In the System Settings area, click the Updates tab.
3. Under Software Updates, in the window Alternate software update distribution server(s)
to replace Deep Security Relays , type:
https://<IP>:<port>/
where <IP> is the private network IP address of the relay, and <port> is the relay port
number
4. Click Add.
5. Click Save.
Note: If your relay group’s private IP changes, you must manually update this setting. It will not
be updated automatically.
Remove relay functionality from an agent
You might want to convert a relay back to being an ordinary Deep Security Agent if:
l Too many relays are causing communication delays
l Relays don't meet minimum system requirements to be a Deep Security Relay anymore
Warning: Deep Security Relays store data when a virtual machine (VM) protected by a Deep
Security Virtual Appliance is being migrated by VMware vMotion. If your deployment uses
vMotion, converting a relay back to a normal agent might cause the migrated VM to lose
protection, and the virtual appliance to lose security events.
1. Go to Administration > Updates > Relay Management.
2. Click the arrow next to the relay group whose relay you want to convert back to an agent.
3. Click the computer.
4. Click Remove Relay.
The agent status will change to "Disabling" and the relay functionality will be removed from
the agent.
1099
Trend Micro Deep Security On-Premise 20
It can take up to 15 minutes. If the agent is in the "Disabling" state for longer than this, you
can deactivate and reactivate the agent to finish removing the relay feature.
Manage agents (protected computers)
Computer and agent statuses
On the Computers page in Deep Security Manager:
l The Status column displays the state of the computer's network connectivity and the state
(in parentheses) of the agent or appliance providing protection, if present. The status
column might also display system or agent events. See "Status column - computer states"
below and "Status column - agent or appliance states" on the next page
l The Task(s) column displays the state of the tasks. See "Task(s) column" on page 1102.
For a list of the events, see "Agent events" on page 978 and " System events" on page 984.
Also on this page:
l "Computer errors" on page 1106
l "Protection module status" on page 1107
l "Perform other actions on your computers" on page 1108
l "Computers icons" on page 1112
l "Status information for different types of computers" on page 1114
Status column - computer states
State Description
The agent or appliance is activated. See "Perform other actions on your
Activated
computers" on page 1108.
Computer has been added to the computers list via the discovery process. (See
Discovered
"Discover computers" on page 386.)
Filter Driver
The filter driver on the ESXi is offline.
Offline
Managed An agent is present and activated, with no pending operations or errors.
Multiple errors have occurred on this computer. See the computer's system
Multiple Errors
events for details.
Multiple Multiple warnings are in effect on this computer. See the computer's system
Warnings events for details.
1100
Trend Micro Deep Security On-Premise 20
State Description
The ESXi has been prepared for the installation of the virtual appliance. (The
Prepared
filter driver has been installed.)
Reactivation The agent or appliance is installed and listening and is waiting to be reactivated
Required a Deep Security Manager.
The computer's agent is not managed by this Deep Security Manager because
Unmanaged it hasn't been activated. Deep Security Manager can't communicate with the
agent until you activate it.
The ESXi has not been prepared for the installation of the virtual appliance.
Unprepared
(The Filter Driver has not been installed.)
Upgrade A newer version of the agent or appliance is available. An software upgrade is
Recommended recommended.
Upgrading The agent software on this computer is in the process of being upgraded to a
Agent newer version.
Status column - agent or appliance states
State Description
The agent or appliance has been successfully activated and is ready to be
Activated
managed by the Deep Security Manager.
Activation An unactivated agent or appliance has been detected on the target machine. It
Required must be activated before it can be managed by the Deep Security Manager.
The manager has attempted to activate an agent or appliance that has already
Deactivation been activated by another Deep Security Manager. The original Deep Security
Required Manager must deactivate the agent or appliance before it can be activated by the
new manager.
No
Agent No agent or appliance was detected on the computer.
/Appliance
The agent or appliance has not connected to the manager for the number of
heartbeats specified on Computer or Policy editor 1 > Settings > General.
This can occur when connectivity is interrupted by a network firewall or proxy,
AWS security group, agent software update, or when a computer is powered down
Offline
for repair.
Verify that firewall settings allow the required port numbers, and that the computer
is powered on. If you use Deep Security as a Service, also see "Activate and
protect agents using agent-initiated activation and communication" on page 1138.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1101
Trend Micro Deep Security On-Premise 20
State Description
Online The agent or appliance is online and operating as expected.
Unknown No attempt has been made to determine whether an agent or appliance is present.
VM Paused The virtual machine is in a "paused" state.
VM Stopped The virtual machine is in a "stopped" state.
Task(s) column
State Description
Activating The manager is activating the agent or appliance.
Activating The activation of the agent or appliance is delayed by the amount of time
(Delayed) specified in the relevant event-based task.
Activation Pending A command to activate the agent or appliance has been queued.
Agent Software
An instruction to deploy the agent software is queued to be sent to the
Deployment
computer.
Pending
Agent Software An instruction to remove the agent software is queued to be sent to the
Removal Pending computer.
Application Control
Inventory Scan In An application control inventory scan is being performed.
Progress
Application Control
An instruction to start an application control inventory scan will be sent from
Inventory Scan
the manager during the next heartbeat.
Pending (Heatbeat)
Application Control
The agent or appliance is currently offline. The manager will initiate an
Inventory Scan
application control inventory scan when communication is reestablished.
Pending (Offline)
Application Control
Ruleset Update In The application control ruleset is being updated.
Progress
Application Control
Ruleset Update An instruction to perform an application control ruleset update will be sent
Pending from the manager during the next heartbeat.
(Heartbeat)
Application Control
The agent or appliance is currently offline. The manager will initiate an
Ruleset Update
application control ruleset update when communication is reestablished.
Pending (Offline)
Baseline Rebuild In
The Integrity Monitoring engine is currently rebuilding a system baseline.
Progress
Baseline Rebuild
A baseline rebuild has been paused
Paused
Baseline Rebuild An instruction to rebuild a system baseline for Integrity Monitoring is
Pending queued to be sent.
Baseline Rebuild The agent or appliance is currently offline. The Integrity Monitoring engine
Pending (Offline) will rebuild a system baseline when communication between the manager
1102
Trend Micro Deep Security On-Premise 20
State Description
and this computer is reestablished.
Baseline Rebuild
The instruction to perform a baseline rebuild is queued.
Queued
Checking Status The agent state is being checked.
Deactivate Pending A deactivate instruction will be sent from the manager during the next
(Heartbeat) heartbeat.
The manager is deactivating the agent or appliance. This means that the
Deactivating agent or appliance is available for activation and management by another
Deep Security Manager.
Deploying Agent
Agent software is being deployed on the computer.
Software
File Backup
Cancellation In A file backup is being canceled.
Progress
File Backup
Cancellation An instruction to cancel a file backup is queued to be sent.
Pending
File Backup
The agent or appliance is currently offline. The manager will initiate the
Cancellation
cancellation of the file backup when communication is reestablished.
Pending (Offline)
File Backup In
A file backup is being performed.
Progress
File Backup
An instruction to start a file backup is queued to be sent.
Pending
File Backup The agent or appliance is currently offline. The manager will initiate a file
Pending (Offline) backup when communication is reestablished.
File Backup
The instruction to perform a file backup is queued.
Queued
Getting Events The manager is retrieving events from the agent or appliance.
Integrity Scan In
An Integrity Scan is currently in progress.
Progress
Integrity Scan
An integrity scan has been paused.
Paused
Integrity Scan
A command to start an integrity scan is queued to be sent.
Pending
Integrity Scan The agent or appliance is currently offline. The manager will initiate an
Pending (Offline) Integrity Scan when communication is reestablished.
Integrity Scan
An instruction to start an integrity scan is queued to be sent.
Queued
Malware Manual
Scan Cancellation The instruction to cancel a manually-initiated Malware Scan has been sent.
In Progress
Malware Manual
The command to cancel a manually-initiated malware scan is queued to be
Scan Cancellation
sent.
Pending
1103
Trend Micro Deep Security On-Premise 20
State Description
Malware Manual
The appliance is offline. The instruction to cancel a manually-initiated
Scan Cancellation
Malware Scan will be sent when communication is reestablished.
Pending (Offline)
Malware Manual
A manually-initiated Malware Scan is in progress.
Scan In Progress
Malware Manual
A manually-initiated Malware Scan has been paused.
Scan Paused
Malware Manual The instruction to perform a manually-initiated Malware Scan has not yet
Scan Pending been sent.
Malware Manual
The agent or appliance is offline. The instruction to start a manually-
Scan Pending
initiated Malware Scan will be sent when communication is reestablished.
(Offline)
Malware Manual
The instruction to perform a manually-initiated Malware Scan is queued.
Scan Queued
Malware Scheduled
Scan Cancellation The instruction to cancel a scheduled Malware Scan has been sent.
In Progress
Malware Scheduled
Scan Cancellation The instruction to cancel a scheduled Malware Scan is queued to be sent.
Pending
Malware Scheduled
The agent or appliance is offline. The instruction to cancel a scheduled
Scan Cancellation
Malware Scan will be sent when communication is reestablished.
Pending (Offline)
Malware Scheduled
A scheduled Malware Scan is in progress.
Scan In Progress
Malware Scheduled
A scheduled Malware Scan has been paused.
Scan Paused
Malware Scheduled
The command to cancel a scheduled malware scan has not yet been sent.
Scan Pending
Malware Scheduled
The agent or appliance is offline. The instruction to start a scheduled
Scan Pending
Malware Scan will be sent when communication is reestablished.
(Offline)
Malware Scheduled
The instruction to cancel a scheduled Malware Scan is queued.
Scan Queued
Quick Malware
Scan Cancellation A quick malware scan is being canceled.
In Progress
Quick Malware
Scan Cancellation An instruction to cancel a quick malware scan is queued to be sent.
Pending
Quick Malware The agent or appliance is currently offline. The manager will initiate the
Scan Cancellation cancellation of a quick malware scan when communication is
Pending (Offline) reestablished.
Quick Malware
A quick malware scan is being performed.
Scan In Progress
Quick Malware A quick malware scan has been paused.
1104
Trend Micro Deep Security On-Premise 20
State Description
Scan Paused
Quick Malware
An instruction to start a quick malware scan is queued to be sent.
Scan Pending
Quick Malware
The agent or appliance is currently offline. The manager will initiate a quick
Scan Pending
malware scan when communication is reestablished.
(Offline)
Quick Malware
The instruction to perform a quick malware scan is queued.
Scan Queued
Removing Agent
The agent software is being removed from the computer.
Software
Rollback of Security
A security update is being rolled back.
Update In Progress
Rollback of Security
An instruction to roll back a security update is queued to be sent.
Update Pending
Rollback of Security
An instruction to roll back a security update will be sent from the manager
Update Pending
during the next heartbeat.
(Heartbeat)
Rollback of Security
The agent or appliance is currently offline. The manager will initiate a
Update Pending
rollback of the security update when communication is reestablished.
(Offline)
Scan for
Recommendations
The manager will initiate a recommendation scan at the next heartbeat.
Pending
(Heartbeat)
Scan for
The agent or appliance is currently offline. The manager will initiate a
Recommendations
recommendation scan when communication is reestablished.
Pending (Offline)
Scan for
Recommendations The appliance is currently offline. The manager will initiate a
Pending (VM recommendation scan when communication is reestablished.
Offline)
Scanning for Open
The manager is scanning the computer for open ports.
Ports
Scanning for
A recommendation scan is underway.
Recommendations
Security Update In
A security update is being performed.
Progress
Security Update
An instruction to perform a security update is queued to be sent.
Pending
Security Update
An instruction to perform a security update will be sent from the manager
Pending
during the next heartbeat.
(Heartbeat)
Security Update The agent or appliance is currently offline. The manager will initiate a
Pending (Offline) security update when communication is reestablished.
Sending Policy A policy is being sent to the computer.
Update of An instruction to update the configuration to match the policy changes will
1105
Trend Micro Deep Security On-Premise 20
State Description
Configuration
Pending be sent from the manager during the next heartbeat.
(Heartbeat)
Update of The agent or appliance is currently offline. The manager will initiate the
Configuration configuration update to match the policy changes when communication is
Pending (Offline) reestablished.
Upgrading Software
A software upgrade is being performed.
(In Progress)
Upgrading Software
A software upgrade is being performed. The install program has been sent
(Install Program
to the computer.
Sent)
Upgrading Software
An instruction to perform a software upgrade is queued to be sent.
(Pending)
Upgrading Software A software upgrade has been requested but will not be complete until the
(Reboot to agent computer is rebooted. When the computer is in this state, it is still
Complete Upgrade) being protected by the older version of the Deep Security Agent.
Upgrading Software
A software upgrade is being performed. The results have been received.
(Results Received)
Upgrading Software A software upgrade will be performed once the computer's access
(Schedule) schedule permits.
Computer errors
State Description
Communication
General network error.
error
No route to Typically the computer cannot be reached because of a firewall between the
computer manager and computer, or if a router between them is down.
Unable to
resolve Unresolved socket address.
hostname
Activation
An instruction was sent to the agent or appliance when it was not yet activated.
required
Unable to
communicate
with Unable to communicate with agent or appliance.
Agent
/Appliance
Communication failure at the IP, TCP, or HTTP layer.
Protocol Error For example, if the Deep Security Manager IP address is unreachable because
the connection is being blocked by a firewall, router, or AWS security group,
then it would cause a connection to fail. To resolve the error, verify that the
1106
Trend Micro Deep Security On-Premise 20
State Description
activation port number is allowed and that a route exists.
Deactivation The agent or appliance is currently activated by another Deep Security
Required Manager.
No
Agent No agent or appliance was detected on the target.
/Appliance
No valid
software Indicates that no installer can be found for the platform and version requested.
version
Send software
There was an error in sending a binary package to the computer.
failed
Internal errorInternal error. Please contact your support provider.
Duplicate Two computers in the Deep Security Manager's computers list share the same
Computer IP address.
VMware Tools (with the VMware Endpoint Driver) is not installed on a guest
virtual machine. The VMware Endpoint Driver is required to provide Deep
VMware Tools
Security anti-malware and integrity monitoring protection. This error status will
Not Installed
only be displayed when Deep Security is deployed in a VMware NSX
environment.
Software changes detected on the file system exceeded the maximum amount.
Unresolved Application control will continue to enforce existing rules, but will not record any
software more changes, and it will stop displaying any of that computer's software
change limit
changes.
reached
See "Reset Application Control after too much software change" on page 817.
Protection module status
When you hover over a computer name on the Computers page, the Preview icon ( ) is
displayed. Click the icon to display the state of the computer's protection modules.
On and Off States:
State Description
Module is configured in Deep Security Manager and is installed and operating on the
On
Deep Security Agent.
Module is either not configured in Deep Security Manager, not installed and operating
Off
on the Deep Security Agent, or both.
Unknown Indicates an error with the protection modules.
Install state:
1107
Trend Micro Deep Security On-Premise 20
State Description
The software package containing the module has been downloaded in Deep
Not Installed Security Manager, but the module has not been turned on in Deep Security
Manager or installed on the agent.
Installation
Module is configured in the manager but is not installed on the agent.
Pending
Installation in
Module is being installed on the agent.
Progress
Module is installed on the agent. This state is only displayed when the state
Installed of the module is "Off". (If the state is "On", the module has been installed on
the agent.)
Matching Module The version of the software package containing the module imported into the
Plug-In Not Found manager does not match the version reported by the agent.
A matching software package was found on the agent, but it does not contain
Not
a module supported by the platform. "Not Supported" or "Update Not
Supported/Update
Supported" is displayed depending on whether there is already a version of
Not Supported
this module installed on the agent.
Perform other actions on your computers
On the Computers page, the Actions button provides several actions that you can perform on the
selected computers.
Action Description
Checks the status of a computer without performing a scan or
Check Status
activation attempt.
Activates or reactivates the agent or appliance on the computer. See
Activate/Reactivate
"Activate the agent" on page 295
You may want to transfer control of a computer from one Deep
Deactivate Security Manager installation to another. If so, the agent or appliance
has to be deactivated and then activated again by the new manager.
Opens a window with a list that allows you to assign a policy to the
computer. The name of the policy assigned to the computer will
appear in the Policy column on the Computers page.
Assign Policy
Note: If you apply other settings to a computer (for example, adding
additional Firewall Rules, or modifying Firewall Stateful
Configuration settings), the name of the policy will be in bold,
1108
Trend Micro Deep Security On-Premise 20
Action Description
indicating that the default settings have been changed.
When you use Deep Security Manager to change the configuration of
an agent or appliance on a computer (apply a new intrusion
prevention rule, change logging settings, etc.), the Deep Security
Send Policy
Manager has to send the new information to the agent or appliance.
This is a Send Policy instruction. Policy updates usually happen
immediately but you can force an update by clicking Send Policy.
Download Security Downloads the latest security update from the configured relay to the
Update agent or appliance. See "Apply security updates" on page 1281.
Rollback Security
Rolls back the latest security update for the agent or appliance.
Update
Override the normal event retrieval schedule (usually every heartbeat)
Get Events
and retrieve the event logs from the computer(s) now.
Use this command to clear all warnings and errors for the computer.
This command is useful in these situations:
Clear
Warnings/Errors l If the agent for the computer has been reset locally
l If the computer has been removed from the network before you
had a chance to deactivate or delete it from the list of computers
To upgrade an agent or appliance, you first need to import a newer
Upgrade Agent
Software version of the agent or appliance software package into the Deep
Security Manager (see "About upgrades" on page 1277).
Deep Security Manager can scan computers and then make
recommendations for Security Rules. The results of a
Scan for
Recommendations recommendation scan appear in the computer's Details window in the
Rules pages. See "Manage and run recommendation scans" on
page 456.
Clear Clears rule recommendations resulting from a recommendation scan
Recommendations on this computer. Clearing also removes the computer from those
1109
Trend Micro Deep Security On-Premise 20
Action Description
listed in an alert produced as a result of a recommendation scan.
Note: This action will not un-assign any rules that were assigned
because of past recommendations.
Performs a full malware scan on the selected computers. The actions
Full Scan for taken by a full scan depend on the Malware Manual Scan
Malware Configuration in effect on this computer. See "Configure malware
scans" on page 557.
Scans critical system areas for currently active threats. Quick Scan
looks for currently-active malware but does not perform deep file
scans to look for dormant or stored infected files. On larger drives,
Quick Scan for Quick Scan is significantly faster than a Full Scan.
Malware
Note: Quick Scan is only available on-demand. You cannot
schedule a Quick Scan as part of a scheduled task.
Performs a port scan on all selected computers and checks the agent
installed on the computer to determine whether its state is either
Deactivation Required, Activation Required, Agent Reactivate
Required, or Online. The scan operation, by default, scans ports 1-
1024. This range can be changed in Computer or Policy editor 1 >
Scan for Open Settings > General.
Ports
Note: The agent's listening port number for heartbeats is always
scanned regardless of port range settings. When the Manager
connects to communicate with the agent, it uses that port number. If
communication direction is set to "Agent/Appliance Initiated" for a
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1110
Trend Micro Deep Security On-Premise 20
Action Description
computer (Computer or Policy editor 1 > Settings > General >
Communication Direction), however, that port number will not be
open. For a list of ports used, see "Deep Security port numbers" on
page 179.
N
o
t
e
:
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1111
Trend Micro Deep Security On-Premise 20
Action Description
New computers on the network will not be detected. To find new
computers, use the Discover tool.
Cancel Currently If you have initiated a set of port scans to a large number of computers
Executing Port or over a large range of ports and the scan is taking too long, use the
Scans Cancel Currently Executing Port Scans option to cancel the scans.
Integrity Monitoring tracks changes to a computer's system and files. It
does by creating a baseline and then performing periodic scans to
Scan for integrity
compare the current state of the computer to the baseline. For more
information see "Set up Integrity Monitoring" on page 705.
Rebuild Integrity
Rebuilds a baseline for Integrity Monitoring on this computer.
Baseline
Asset values allow you to sort computers and events by importance.
The various security rules have a severity value. When rules are
Assign Asset triggered on a computer, the severity values of the rules are multiplied
Value by the asset value of the computer. This value is used to rank events
in order of importance. See "Rank events to quantify their importance"
on page 844.
Assign a Relay To select a relay group for this computer to download updates from,
Group right-click the computer and choose Actions > Assign a Relay Group.
Computers icons
Ordinary computer
Deep Security Relay (a computer with a Relay-enabled Agent)
Deep Security Scanner (a computer with a Scanner-enabled agent)
Docker host (physical computer)
Azure virtual machine with Docker
1112
Trend Micro Deep Security On-Premise 20
Amazon EC2 with Docker
VMware virtual machine with Docker
Azure virtual machine with Scanner
Azure virtual machine with Scanner (started)
Azure virtual machine with Scanner (stopped)
Azure virtual machine with Scanner (suspended)
Amazon EC2 with Scanner
Amazon EC2 with Scanner (started)
Amazon EC2 with Scanner (stopped)
Amazon EC2 with Scanner (suspended)
Amazon WorkSpace (started)
Additional computer icons for vSphere environments:
ESXi server
Virtual computer (a virtual machine managed by VMware vCenter)
Virtual computer (started)
Virtual computer (stopped)
Virtual computer (suspended)
Virtual computer (with Relay enabled)
Virtual computer (started, Relay enabled)
Virtual computer (stopped, Relay enabled)
Virtual computer (suspended, Relay enabled)
Virtual computer (Scanner enabled)
1113
Trend Micro Deep Security On-Premise 20
Virtual computer (started, Scanner enabled)
Virtual computer (stopped, Scanner enabled)
Virtual computer (suspended, Scanner enabled)
Virtual Appliance
Virtual Appliance (started)
Virtual Appliance (stopped)
Virtual Appliance (suspended)
Status information for different types of computers
Ordinary computer
The preview pane for an ordinary computer displays the presence of an agent, it status, and the
status of the protection modules.
Relay
The preview pane for a Deep Security relay-enabled agent displays its status, the number of
security update components it has available for distribution, and the status of the protection
modules provided by its embedded Deep Security agent.
1114
Trend Micro Deep Security On-Premise 20
Deep Security Scanner
The preview pane for a Deep Security Scanner displays the presence of an agent or combined
mode (agent and appliance), it status, the status of the protection modules, and the scanner
status (SAP).
Docker hosts
The preview pane for a Docker host displays the presence of an agent and its status, the status
of the protection modules, and the Docker status.
1115
Trend Micro Deep Security On-Premise 20
ESXi server
The preview pane for an ESXi server displays its status and the version number of the ESXi
software. In the Guests area are displayed the presence of a Deep Security Virtual Appliance,
and the virtual machines running on this host.
Virtual appliance
The preview pane for a Virtual Appliance displays its status and the version number of the
Appliance. In the Protected Guests On area the protected virtual machines are displayed.
1116
Trend Micro Deep Security On-Premise 20
Virtual machine with agentless protection
The preview pane for a virtual machine displays whether it is being protected by a Virtual
Appliance, an in-guest Agent, or both. It displays details about the components running on the
virtual machine.
Configure agent version control
Agent version control is a feature that gives you and your security operations team control over
the specific versions of the Deep Security Agent that will be deployed when:
l using deployment scripts
l upgrading the agent through an upgrade alert, button, check box or other widget in the
manager (the exceptions are listed in the FAQ)
l upgrading the agent through the agent upgrade on activation feature
This allows security operations teams who do not have control over Deep Security Manager's
local inventory of agents or the relays the ability to declare exactly what agents will be used at
any given time.
As new agents are released by Trend Micro, your security operations team can test them in
controlled environments before changing the version control settings to expose the new agents
to downstream applications teams in their production environment.
Topics:
1117
Trend Micro Deep Security On-Premise 20
l "Set up agent version control" below
l "Use agent version control with URL requests" on page 1120
l "Agent version control FAQs" on page 1120
Set up agent version control
1. Before you begin, import the agent versions you want to use.
2. Go to Deep Security Manager.
3. Click Administration at the top.
4. On the left, expand Updates > Software > Agent Version Control.
All the agent platforms appear in the main pane.
5. (Optional) Use the Show/Hide Platforms section on the right to restrict the agent platforms
that are visible.
6. Make your agent version selections and click Save. Follow this guidance:
Note: Only agent versions 9.0 or later are displayed. For Solaris specifically, only
versions 11.0 or later are displayed. If you want to deploy earlier agents, you'll have to
use the agentVersion= setting available in the deployment scripts. For details, see
"Use deployment scripts to add and protect computers" on page 1401.
Column Description
This column lists the platforms for which Deep Security Agent
PLATFORM
software is available.
This column is where you select which version of the agent
will be used by deployment scripts and so on. It has the
following options:
l Latest: Indicates to use the latest agent software build
available in your local inventory, either long-term support
VERSION CONTROL (LTS) or feature release (FR). The logic to determine the
latest agent is based on the agent version number: the
highest version is used. For example, a Deep Security 12
update agent with version 12.0.0.460 is higher than the
Deep Security 12 General Availability (GA) agent.
However, the Deep Security 12 feature release agents
1118
Trend Micro Deep Security On-Premise 20
Column Description
with version 12.5.0.350 is considered later than an LTS
agent with version 12.0.0.460. In summary, choose Latest
if you want the latest LTS or FR agent for the platform. For
details on LTS and FR releases, see "Deep Security 20
release strategy and life cycle policy" on page 75.
l Latest LTS: (default) Indicates to use the latest long-term
support (LTS) software build available in your local
inventory. Latest LTS can be the original LTS release, or
can be an update to the original LTS release. Any FRs in
your inventory are ignored. LTS build versions always
have ‘0’ as the minor version number. For details on LTS
and FR releases, see "Deep Security 20 release strategy
and life cycle policy" on page 75.
l <agent_version> for example, 11.0.0.760: Indicates to
use a specific agent version available in your local
inventory. Other agents in your inventory are ignored. If
no agent version appears in the list, it's because there is
no agent in your local inventory that matches the OS. To
fix this issue, import an agent to your inventory.
Note: The latest version of the agent is sometimes a few
releases behind your manager version. For example, the
latest LTS for Windows Server 2003 is 10.0.0.3377 as of
this writing. Although a release may be behind your
manager's, it is still supported if you can see it on the Agent
Version Control page. For details, see "Agent platform
support policy" on page 79.
This column shows the agent that will be deployed based on
your selection under VERSION CONTROL.
RESULTING AGENT If the column shows an N/A (No agent in inventory) message,
it's because there is no agent in your local inventory that
matches the selection in VERSION CONTROL. To fix this
1119
Trend Micro Deep Security On-Premise 20
Column Description
issue, import an agent to your inventory or change the
VERSION CONTROL selection.
If the column shows an N/A (Removed from inventory)
message, it's because the primary tenant (T0) deemed the
agent unsuitable for deployment and removed it.
Use agent version control with URL requests
Agent version control provides the ability to control what agents are returned when any URL
request is made to Deep Security Manager to download the agent. For details, see "Using agent
version control to define which agent version is returned" on page 1412.
Agent version control FAQs
How does version control interact with agent import?
Prior to the introduction of agent version control, the primary way to control the agent
version was to selectively import only those agents that you were confident you wanted
to deploy. Once the agents were imported, the latest one for each platform was
distributed to relays. The latest agents were then picked up from the relays by features
like upgrade on activation and deployment scripts.
If you want to continue on this functionality (pre-12 functionality):
1. As before, import the agents you want to deploy to your inventory, and remove the
old ones. See "Get Deep Security Agent software" on page 266 for details.
2. Go to the Agent Version Control page and make sure all platforms are set to the
default, Latest. For instructions, see "Set up agent version control" on page 1118.
The Latest setting instructs the manager to continue using the latest agents in its
local inventory, and you can continue to use your existing processes without any
changes.
Is version control supported in multi-tenant deployments?
Yes.
1120
Trend Micro Deep Security On-Premise 20
You, as the primary tenant (t0), must import newer agent versions into your local
inventory, and then allow each of your tenants to make decisions about what agents
they want to deploy using the Agent Version Control page. If a tenant only wants to use
LTS agents, or lock in to a specific agent version, they can do so independent of other
tenants.
Do I need to update my deployment scripts to use this feature?
Yes.
To update your deployment scripts:
1. In Deep Security Manager 12 or later, go to Support > Deployment Scripts and
generate new deployment scripts. For instructions, see "Use deployment scripts to
add and protect computers" on page 1401.
2. Re-distribute and re-run the new scripts as necessary.
The latest deployment scripts pass additional information to Deep Security Manager (for
example, tenant information and platform information) that is required for the version
control feature to work properly.
What happens if I don't update existing deployment scripts?
If you have existing deployment scripts that you generated prior to the availability of the
agent version control feature, and you do not take any action to update them, they will
default to Latest. This default will be used for any older deployment scripts regardless of
how you have set your agent version control settings. Replace the older deployment
scripts with new deployment scripts to leverage the settings you define in the agent
version control settings.
Deployment scripts that are generated after the availability of the agent version control
feature will use your agent version control settings.
What features are out of scope (exceptions)?
By design, the features listed below are out of scope for the agent version control
feature. These features are typically accessed by the Deep Security Manager
1121
Trend Micro Deep Security On-Premise 20
administrator directly, in many cases to test a specific agent version in a development or
staging environment prior to deploying the agent version into production.
We have left full access to all agent versions accessible in these specific scenarios:
l the Computer details page > Upgrade Agent button
l the Computers > Actions > Upgrade Agent Software page
Selecting either of the above options launches a wizard with a drop-down list that
always defaults to 'Use latest version for platform' regardless of your version
control settings. For details, see "Upgrade the agent from the Computers page" on
page 1298.
l agent upgrades that are not initiated directly from Deep Security Manager. For
example, if you export an agent package, transfer it to the server, and initiate the
upgrade from the command line, the agent version control settings will not be
involved in this upgrade.
Configure teamed NICs
"Teamed NICs" or "link aggregation" describes forming a network link on a computer by using
multiple network interface cards (NICs) together. This is useful to increase the total network
bandwidth, or to provide link redundancy.
You can configure teamed NICs on Windows or Solaris so that they are compatible with Deep
Security Agent.
Windows
On Windows, when you team NICs, it creates a new virtual interface. This virtual interface
adopts the MAC address of its first teamed physical interface.
By default, during installation or upgrade, the Windows Agent will bind to all virtual and physical
interfaces. This includes the virtual interface created by NIC teaming. However, Deep Security
Agent doesn't function properly if multiple interfaces have the same MAC address, which
happens with NIC teaming on Windows
To avoid that, bind the agent only to the teamed virtual interface - not the physical interfaces.
1122
Trend Micro Deep Security On-Premise 20
Note: NIC teaming with Deep Security Agent requires Windows 2003 requires SP 2 or later.
Warning: Don't add or remove network interfaces from a teamed NIC except immediately
before running the installer. Otherwise network connectivity may fail or the computer may not
be correctly detected with Deep Security Manager. The agent's network driver is bound to
network interfaces when you install or upgrade; the agent does not continuously monitor for
changes after.
Solaris
IPMP failover (active-standby) mode in Solaris allows two NICs to have the same hardware
(MAC) address. Since the Deep Security Agent identifies network adapters by their MAC
address, such duplication prevents the agent from functioning properly.
To avoid that, manually assign a unique MAC address to each network adapter.
For example, you could use ifconfig to view the current MAC addresses:
# ifconfig -a
hme0: flags=1000843<BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 2
inet 10.20.30.40 netmask 0
ether 8:0:20:f7:c3:f
hme1: flags=1000842<BROADCAST,RUNNING,MULTICAST,IPv4> mtu 1500 index 8
inet 0.0.0.0 netmask 0
ether 8:0:20:f7:c3:f
The "ether" line displays the adapter's MAC address. If any interfaces have the same MAC
addresses, and are connected to the same subnet, you must manually set new unique MAC
addresses:
# ifconfig <interface> ether <new MAC address>
Although the chance of a MAC address conflict is extremely small, you should verify that there
isn't one by using the snoop command to search for the MAC address, then use the ping
command to test connectivity to the subnet's broadcast address.
Note: On Solaris, if multiple interfaces are on the same subnet, the operating system may
route packets through any of the interfaces. Because of this, Deep Security's firewall stateful
configuration options and IPS rules should be applied to all interfaces equally.
1123
Trend Micro Deep Security On-Premise 20
Agent-manager communication
Deep Security Manager and the agent or appliance communicate using the latest mutually-
supported version of TLS.
Topics in this article:
l "Configure the heartbeat" below
l "Configure communication directionality" on the next page
l "Supported cipher suites for agent-manager communication" on page 1127
Configure the heartbeat
A 'heartbeat' is a periodic communication between the Deep Security Manager and agent(or
appliance). During a heartbeat, the manager collects this information:
l the status of the drivers (on- or off-line)
l the status of the agent or appliance (including clock time)
l agent or appliance logs since the last heartbeat
l data to update counters
l a fingerprint of the agent or appliance security configuration (used to determine if it is up to
date)
The heartbeat can be configured on a base or parent policy, on a sub-policy, or on an individual
computer.
You can configure the following properties of the heartbeat:
l Heartbeat Interval: How much time passes between heartbeats.
l Number of Heartbeats that can be missed before an alert is raised: The number of
consecutively missed heartbeats that triggers an alert. For example, a value of three
causes the manager to trigger an alert on the fourth missed heartbeat.)
Note: If the computer is a server, too many missed heartbeats in a row may indicate a
problem with the agent/appliance or the computer itself. However if the computer is a
laptop or any other system that is likely to experience a sustained loss of connectivity,
this setting should be set to "unlimited".
1124
Trend Micro Deep Security On-Premise 20
l Maximum change (in minutes) of the local system time on the computer between
heartbeats before an alert is raised: For agents that are capable of detecting changes to
the system clock (Windows agents only) these events are reported to the manager as
agent event 5004. If the change exceeds the clock change listed here then an alert is
triggered. For agents that do not support this capability, the manager monitors the system
time reported by the agent at each heartbeat operation and triggers an alert if it detects a
change greater than the permissible change specified in this setting.
Note: Once a Computer-Clock-Changed alert is triggered, it must be dismissed
manually.
l Raise Offline Errors For Inactive Virtual Machines: Sets whether an offline error is raised
if the virtual machine is stopped.
1. Open the Policy editor 1 or the Computer editor 2 for the policy or computer to configure.
2. Go to Settings > General > Heartbeat.
3. Change the properties as required.
4. Click Save .
Configure communication directionality
Note: Bidirectional communication is enabled by default.
Configure whether the agent or appliance or the manager initiates communication.
'Communication' includes the heartbeat and all other communications. The following options are
available:
Bidirectional: The agent or appliance normally initiates the heartbeat and also listens on
the agent's listening port number for connections from the Deep Security Manager. (See
"Deep Security port numbers" on page 179.) The manager can contact the agent or
appliance to perform required operations. The manager can apply changes to the security
configuration of the agent or appliance.
1To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
2To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
1125
Trend Micro Deep Security On-Premise 20
Note: The Deep Security Virtual Appliance can only operate in bidirectional mode.
Changing this setting to any other mode for a virtual appliance will disrupt functionality.
l Manager Initiated: The manager initiates all communication with the agent or appliance.
These communications include security configuration updates, heartbeat operations, and
requests for event logs. If you choose this option, we strongly recommend that you "Protect
Deep Security Agent" on page 1244 so that it only accepts connections from known Deep
Security Managers.
l Agent/Appliance Initiated: The agent or appliance does not listen for connections from the
manager. Instead they contact the manager on the port number where the Manager listens
for agent heartbeats. (See "Deep Security port numbers" on page 179.) Once the agent or
appliance has established a TCP connection with the manager, all normal communication
takes place: the manager first asks the agent or appliance for its status and for any events.
(This is the heartbeat operation.) If there are outstanding operations that need to be
performed on the computer (for example, the policy needs to be updated), these operations
are performed before the connection is closed. Communications between the manager and
the agent or appliance only occur on every heartbeat. If an agent or appliance's security
configuration has changed, it is not updated until the next heartbeat.
Note: For instructions on how to configure agent-initiated activation and use
deployments scripts to activate agents, see "Activate and protect agents using agent-
initiated activation and communication" on page 1138.
Note: To enable communications between the Manager and the agents and appliances, the
manager automatically implements a (hidden) firewall rule (priority four, Bypass) that opens the
listening port number for heartbeats on the agents and appliances to incoming TCP/IP traffic.
By default, it will accept connection attempts from any IP address and any MAC address. You
can restrict incoming traffic on this port by creating a new priority 4, Force Allow or Bypass
firewall rule that only allows incoming TCP/IP traffic from specific IP or MAC addresses, or
both. This new firewall rule would replace the hidden firewall rule if the settings match these
settings:
action: force allow or bypass
priority: 4 - highest
packet's direction: incoming
frame type: IP
protocol: TCP
1126
Trend Micro Deep Security On-Premise 20
packet's destination port: agent's listening port number for heartbeat connections from the
manager, or a list that includes the port number. (See agent listening port number.)
While these settings are in effect, the new rule will replace the hidden rule. You can then type
packet source information for IP or MAC addresses, or both, to restrict traffic to the computer.
1. Open the Policy editor 1 or the Computer editor 2 for the policy or computer to configure.
2. Go to Settings > General > Communication Direction.
3. In the Direction of Deep Security Manager to Agent/Appliance communication menu,
select one of the three options ("Manager Initiated", "agent/appliance Initiated", or
"Bidirectional"), or choose "Inherited". If you select "Inherited", the policy or computer
inherits the setting from its parent policy. Selecting one of the other options overrides the
inherited setting.
4. Click Save to apply the changes.
Note: Agents and appliances look for the Deep Security Manager on the network by the
Manager's hostname. Therefore the Manager's hostname must be in your local DNS for agent-
or appliance-initiated or bidirectional communication to work.
Supported cipher suites for agent-manager communication
Deep Security Manager and the agent or appliance communicate using the latest mutually-
supported version of TLS.
The Deep Security Agent supports the following cipher suites for communication with the
manager. If you need to know the cipher suites supported by the Deep Security Manager,
contact Trend Micro. If you need to know the cipher suites supported by the Deep Security
Virtual Appliance, determine the version of the agent that's embedded on the appliance, and
then look up that agent in the list below.
The cipher suites consist of a key exchange asymmetric algorithm, a symmetric data encryption
algorithm and a hash function.
1To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
2To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
1127
Trend Micro Deep Security On-Premise 20
l "Deep Security Agent 9.5 cipher suites" below
l "Deep Security Agent 9.6 cipher suites" below
l "Deep Security Agent 10.0 cipher suites" on the next page
l "Deep Security Agent 11.0 cipher suites" on the next page
l "Deep Security Agent 12.0 and Deep Security Agent 20 cipher suites" on page 1130
Deep Security Agent 9.5 cipher suites
Deep Security Agent 9.5 (without SPs, patches, or updates) supports these TLS 1.0 cipher
suites:
l TLS_RSA_WITH_AES_256_CBC_SHA
l TLS_RSA_WITH_AES_128_CBC_SHA
Deep Security Agent 9.5 SP1 - 9.5 SP1 Patch 3 Update 2 supports these cipher suites:
l TLS_RSA_WITH_AES_256_CBC_SHA
l TLS_RSA_WITH_3DES_EDE_CBC_SHA
l TLS_RSA_WITH_AES_128_CBC_SHA
Deep Security Agent 9.5 SP1 Patch 3 Update 3 - 8 supports these cipher suites:
l TLS_RSA_WITH_AES_256_CBC_SHA256
l TLS_RSA_WITH_AES_128_GCM_SHA256
l TLS_RSA_WITH_AES_128_CBC_SHA256
l TLS_RSA_WITH_AES_256_CBC_SHA
l TLS_RSA_WITH_AES_128_CBC_SHA
Deep Security Agent 9.6 cipher suites
Deep Security Agent 9.6 (without SPs, patches, or updates) - 9.6 Patch 1 supports these TLS 1.0
cipher suites:
l TLS_RSA_WITH_AES_256_CBC_SHA
l TLS_RSA_WITH_AES_128_CBC_SHA
Deep Security Agent 9.6 Patch 2 - 9.6 SP1 Patch 1 Update 4 supports these cipher suites:
1128
Trend Micro Deep Security On-Premise 20
l TLS_RSA_WITH_AES_256_CBC_SHA
l TLS_RSA_WITH_3DES_EDE_CBC_SHA
l TLS_RSA_WITH_AES_128_CBC_SHA
Deep Security Agent 9.6 SP1 Patch 1 Updates 5 - 21 supports these cipher suites:
l TLS_RSA_WITH_AES_256_CBC_SHA256
l TLS_RSA_WITH_AES_128_GCM_SHA256
l TLS_RSA_WITH_AES_128_CBC_SHA256
l TLS_RSA_WITH_AES_256_CBC_SHA
l TLS_RSA_WITH_AES_128_CBC_SHA
Deep Security Agent 10.0 cipher suites
Deep Security Agent 10.0 up to Update 15 supports these TLS 1.2 cipher suites:
l TLS_RSA_WITH_AES_256_CBC_SHA256
l TLS_RSA_WITH_AES_128_CBC_SHA256
Deep Security Agent 10.0 Update 16 and later updates supports these TLS 1.2 cipher suites,
out-of-box:
l TLS_RSA_WITH_AES_256_CBC_SHA256
l TLS_RSA_WITH_AES_128_CBC_SHA256
Deep Security Agent 10.0 Update 16 and later updates supports these TLS 1.2 cipher suites,
and only these suites, if strong cipher suites are enabled:
l TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
l TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
Deep Security Agent 11.0 cipher suites
Deep Security Agent 11.0 up to Update 4 supports these cipher suites:
l TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1129
Trend Micro Deep Security On-Premise 20
l TLS_RSA_WITH_AES_256_CBC_SHA256
l TLS_RSA_WITH_AES_128_CBC_SHA256
Deep Security Agent 11.0 Update 6 and later updates supports these TLS 1.2 cipher suites:
In FIPS mode, these TLS 1.2 suites are supported:
l TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
l TLS_RSA_WITH_AES_256_CBC_SHA256
l TLS_RSA_WITH_AES_128_CBC_SHA256
In non-FIPS mode, these TLS 1.2 suites, and only these suites, are supported:
l TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
l TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
Deep Security Agent 12.0 and Deep Security Agent 20 cipher suites
In FIPS mode, these TLS 1.2 suites are supported:
l TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
l TLS_RSA_WITH_AES_256_CBC_SHA256
l TLS_RSA_WITH_AES_128_CBC_SHA256
In non-FIPS mode, these TLS 1.2 suites, and only these suites, are supported:
l TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
l TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
l TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
1130
Trend Micro Deep Security On-Premise 20
Configure agents that have no internet access
If your agents or relays don't have access to the internet (also called "air-gapped agents"), then
they won't be able to access several of the security services provided by the Trend Micro Smart
Protection Network. These security services are necessary for the full and successful operation
of the Deep Security Anti-Malware and Web Reputation features.
The Trend Micro Smart Protection Network security services are:
Service name Required for these features
Smart Scan Service Smart Scan
Web Reputation Service Web Reputation
Global Census Service behavior monitoring, predictive machine learning
behavior monitoring, predictive machine learning, process
Good File Reputation Service
memory scans
Predictive Machine Learning
predictive machine learning
Service
In addition to the above services, the agent and relay-enabled agent also need access to the
Trend Micro Update Server (also called Active Update), which is not part of the Smart Protection
Network, but is a component that is hosted by Trend Micro and accessed over the internet.
If any of your agents or relay-enabled agents can't reach the services above, you have several
solutions, described below.
Solutions
l Solution 1: "Use a proxy" on the next page
l Solution 2: "Install a Smart Protection Server locally " on the next page
l Solution 3: "Get updates in an isolated network" on page 1133
l Solution 4: "Disable the features that use Trend Micro security services" on page 1136
1131
Trend Micro Deep Security On-Premise 20
Use a proxy
If your agents or relay-enabled agents can't connect to the internet, you can install a proxy that
can. Your Deep Security Agents and relays connect to the proxy, and the proxy then connects
outbound to the Trend Micro security services in the Smart Protection Network.
Note: With a proxy, each Smart Scan or Web Reputation request goes out over the internet to
the Smart Protection Network. Consider instead using a Smart Protection Server inside your
LAN to keep these requests within your network and reduce extranet bandwidth usage.
To use a proxy, see "Configure proxies" on page 1080
Install a Smart Protection Server locally
If your agents and relay-enabled agents can't connect to the internet, you can install a Smart
Protection Server in your local area network (LAN) to which they can connect. The local Smart
Protection Server periodically connects outbound over the internet to the Smart
Protection Network to retrieve the latest Smart Scan Anti-Malware patterns and Web Reputation
information. This information is cached on the Smart Protection Server and disseminated to your
agents and relay-enabled agents.
If you decide to use this solution, remember that:
l Only the Smart Scan and Web Reputation features are supported with a local Smart
Protection Server.
l Use the proxy solution if you need the behavior monitoring, predictive machine learning,
and process memory scanning features. See "Use a proxy" above above for details. If you
decide not to use these features, you must disable them to prevent a query failure and to
improve performance. For instructions on disabling these features, see "Disable the
features that use Trend Micro security services" on page 1136
To deploy a Smart Protection Server:
l install it manually. See the Smart Protection Server documentation for details.
OR
l if your agents or relay-enabled agents are inside AWS, install it using an AWS
CloudFormation template created by Trend Micro. See "Integrate with Smart Protection
Server" on page 1501 for details.
1132
Trend Micro Deep Security On-Premise 20
Get updates in an isolated network
If your Deep Security Manager is in an isolated network without connection to the internet and
your agents or relay-enabled agents also can't connect to the internet, you can install an
additional stand-alone Deep Security Manager with database and a relay-enabled agent in your
demilitarized zone (DMZ) or another area where internet access is available.
Once all the components are installed, you can configure the relay-enabled agent in the DMZ to
automatically obtain the latest malware scan updates from the Update Server on the internet.
These updates must be extracted to a .zip file, and then manually copied to your air-gapped
relay. (Detailed instructions follow.)
If you decide to use this solution, remember that:
l The .zip file contains traditional (large) malware patterns, which give you basic Anti-
Malware capabilities.
l The .zip file does not contain Deep Security Rule Updates, which are used for Intrusion
Prevention, Integrity Monitoring, and Log Inspection. You can obtain those updates
separately (See "Get rules updates in an isolated network" on page 1135).
l The following advanced Anti-Malware features are not available: Smart Scan, behavior
monitoring, predictive machine learning, process memory scans, and Web Reputation.
These features all require access to Trend Micro security services.
l You should disable the advanced Anti-Malware features (Solution 4) since they cannot be
used.
l You should have a plan in place to periodically update the .zip file on your air-gapped
relay to ensure you always have the latest malware patterns.
To deploy this solution, follow these steps (for upgrade steps, see below):
1. Install a Deep Security Manager and its associated database in your DMZ. We'll call these
internet-facing components the 'DMZ manager' and 'DMZ database'.
2. Install a Deep Security Agent in your DMZ and configure it as a relay. We'll call this agent
the 'DMZ relay'. For information on setting up relays, see "Deploy additional relays" on
page 1091.
The following items are now installed:
l a DMZ manager
l a DMZ database
l a DMZ relay
1133
Trend Micro Deep Security On-Premise 20
l an air-gapped manager
l an air-gapped database
l an air-gapped relay
l multiple air-gapped agents
3. On the DMZ relay, create a .zip file containing the latest malware patterns by running this
command:
dsa_control -b
The command line output shows the name and location of the .zip file that was generated.
4. Copy the .zip file to the air-gapped relay. Place the file in the relay's installation directory.
l On Windows the default directory is C:\Program Files\Trend Micro\Deep
Security Agent.
l On Linux the default directory is /opt/ds_agent.
Note: Do not rename the .zip file.
5. On the air-gapped manager, initiate a security update download:
a. Click Computers at the top.
b. In the list of computers, find your air-gapped relay where you copied the .zip file, right-
click it and select Download Security Update.
The air-gapped relay checks its configured update source (typically the Update Server
on the internet). Since it can't connect to this server, it checks the .zip file in its
installation directory. When it finds the .zip file, it extracts it and imports the updates.
The updates are then disseminated to the air-gapped agents that are configured to
connect to the relay.
c. Delete the .zip file after the updates are imported to the air-gapped relay.
6. Configure the air-gapped relay to connect to itself instead of the Update Server (to prevent
connection error alerts):
a. Log in to the air-gapped manager.
b. Click Administration on the top.
c. On the left, click System Settings.
d. In the main pane, click the Updates tab.
e. Under Primary Security Update Source, select Other update source and enter
https://localhost:[port] where [port] is the configured port number for
security updates, by default 4122.
f. Click OK.
The air-gapped relay no longer tries to connect to the Update Server on the internet.
1134
Trend Micro Deep Security On-Premise 20
7. (Optional but recommended.) To improve performance, "Disable the features that use
Trend Micro security services" on the next page.
8. On a periodic basis, download the latest updates to your DMZ relay, zip them up, copy
them to your air-gapped relay, and initiate a security update download on the relay.
You have now deployed a Deep Security Manager, associated database, and relay in your DMZ
from which to obtain malware scan updates.
To upgrade this solution, upgrade in this order:
1. DMZ manager (and its database, if the database software also needs to be upgraded)
2. DMZ relay
3. air-gapped manager (and its database, if the database software also needs to be
upgraded)
4. air-gapped relay
5. air-gapped agents
Warning: If you do not upgrade relays first, security component upgrades and software
upgrades may fail.
For details on upgrading, see "Install Deep Security Manager" on page 210 (for manager
upgrade steps),"Upgrade Deep Security Relay" on page 1294, and "Upgrade Deep Security
Agent" on page 1295
Get rules updates in an isolated network
The .zip file that you created in the previous section contains Anti-Malware patterns, but not the
Deep Security Rule Updates that are used for Intrusion Prevention, Integrity Monitoring, and Log
Inspection.
To get those updates:
1. On the DMZ manager, go to Administration > Updates > Security > Rules.
2. Click a rule update (.dsru file) and click Export. The file is downloaded locally.
3. Repeat the export for each .dsru file that you want to apply to the air-gapped manager.
4. Copy the .dsru files to the air-gapped manager.
5. On the air-gapped manager, go to Administration > Updates > Security > Rules.
6. Click Import, select the .dsru file, and click Next.
7. The manager validates the file and displays a summary of the rules it contains. Click Next.
8. A message displays, saying that the rule update was imported successfully. Click Close.
9. Repeat the import for each .dsru file that you want to apply to the air-gapped manager.
1135
Trend Micro Deep Security On-Premise 20
Disable the features that use Trend Micro security services
You can disable the features that use Trend Micro security services. Doing so improves
performance because the air-gapped agent no longer tries (and fails) to query the services.
Note: Without Trend Micro security services, your malware detection is downgraded
significantly, ransomware is not detected at all, and process memory scans are also
affected. It is therefore strongly recommended that you use one of the other solutions to
allow access to Trend Micro security services. If this is impossible, only then should you
disable features to realize performance gains.
l To disable Smart Scans:
a. Open the Computer or Policy editor 1 .
b. On the left, click Anti-Malware.
c. In the main pane, click Smart Protection.
d. Under Smart Scan, deselect Inherited (if it is selected) and then select Off.
e. Click Save.
l To disable web reputation:
a. Open the Computer or Policy editor 2.
b. On the left, click Web Reputation.
c. In the main pane, make sure the General tab is selected.
d. From the Configuration drop-down list, select Off.
e. Click Save.
l To disable Smart Feedback:
a. In Deep Security Manager, click Administration at the top.
b. Click System Settings on the left.
c. In the main pane, click the Smart Feedback tab.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
2You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1136
Trend Micro Deep Security On-Premise 20
d. Deselect Enable Trend Micro Smart Feedback (recommended).
e. Click Save.
l To disable process memory scans:
a. In Deep Security Manager, click Policies at the top.
b. On the left, expand Common Objects > Other and then click Malware Scan
Configurations.
c. Double-click a malware scan configuration with a SCAN TYPE of Real-Time.
d. On the General tab, under Process Memory Scan, deselect Scan process memory
for malware.
e. Click OK.
l To disable predictive machine learning:
a. Make sure you still have a real-time malware scan configuration open.
b. On the General tab, under Predictive Machine Learning, deselect Enable Predictive
Machine Learning.
c. Click OK.
l To disable behavior monitoring:
a. Make sure you still have a real-time malware scan configuration open.
b. On the General tab, under Behavior Monitoring, deselect both options, namely,
Detect suspicious activity and unauthorized changes (incl. ransomware) and Back
up and restore ransomware-encrypted files.
c. Click OK.
Also disable the census and grid queries on the Deep Security Manager if you want
performance gains. If you leave them enabled, a lot of unnecessary background processing
takes place. To disable these queries:
1. Disable the census query:
dsm_c -action changesetting -name settings.configuration.enableCensusQuery
-value false
2. Disable the grid query:
dsm_c -action changesetting -name settings.configuration.enableGridQuery -
value false
1137
Trend Micro Deep Security On-Premise 20
Activate and protect agents using agent-initiated activation
and communication
When you enable agent-initiated activation (AIA), instead of the Deep Security Manager
contacting the agents directly, the agents initiate communication with the manager and establish
an encrypted TCP connection over the manager heartbeat port (4120 by default).
Enabling AIA can prevent communication issues between the manager and agents, and simplify
agent deployment when used with deployment scripts. Trend Micro recommends that you use
AIA if:
l Your network environment prevents the manager from initiating connections to agents.
l You need to deploy many agents at once.
l You are protecting computers in cloud accounts.
Note: Before enabling AIA, ensure that agents can reach the manager URL and heartbeat
port. You can find the manager URL(s) and heartbeat port under Administration > System
Information > System Details > Manager Node.
Enable agent-initiated activation and communication
Proceed with the following steps:
1. "Create or modify policies with agent-initiated communication enabled" below.
2. "Enable agent-initiated activation" on the next page.
3. "Assign the policy to agents" on the next page.
4. "Use a deployment script to activate the agents" on the next page.
Create or modify policies with agent-initiated communication enabled
For your agents to continue initiating communication with the manager after activation, you'll
need to enable agent-initiated communication on any policies the agents will use. You can do
this by either modifying an existing policy or by creating a new one, which you'll assign to the
agents.
Tip: You can quickly create a new policy from an existing policy by right-clicking it and
selecting Duplicate.
1138
Trend Micro Deep Security On-Premise 20
1. On the Policies page, double-click the policy.
2. Go to Settings > General.
3. Under Communication Direction, select Agent/Appliance Initiated.
4. Click Save.
Enable agent-initiated activation
1. Go to Administration > System Settings > Agents.
2. Select Allow Agent-Initiated Activation.
3. Select Allow Agent to specify hostname.
4. From the If a computer with the same name exists list, select Re-activate the existing
computer.
5. Click Save.
Note: For a full description of each AIA setting, see the Agent-Initiated Activation section of
"Agent settings" on page 1149.
Assign the policy to agents
You can either assign the policy to the agents during the deployment script configuration, or by
using an event-based task after the deployment script has been run.
If all the agents will use the same policy, you can assign the policy in the deployment script as
part of the next step. If groups of agents need to use different policies, create an event-based
task to assign the policies before proceeding with the next step.
Use a deployment script to activate the agents
See the Generate a deployment section of "Generate a deployment script" on page 1401 to learn
how to use a deployment script to activate the agents. If you are assigning a policy during
deployment script configuration, you'll select it from the Security Policy list.
Automatically upgrade agents on activation
'Upgrade on activation' is a feature that can be used to automatically upgrade Deep Security
Agents to a newer version of software based on a check of the agent version during the
activation process. This feature is especially useful if you want to distribute the agent using the
baking process (see "Install the agent on an AMI or WorkSpace bundle" on page 285). When
agents are baked it can be difficult for you to update your ‘golden’ images each time a new
version of the Deep Security Agent is released. In this case, 'upgrade on activation' can be used
so that each time the older agent from the baked image activates, Deep Security Manager
1139
Trend Micro Deep Security On-Premise 20
instructs the agent to upgrade to the version you specify as part of the activation process keeping
the running agents used in your environment up-to-date.
Note: This feature complies with your agent version control settings.
Note: This feature is currently available only on Linux and Windows computers. Support for
Unix is planned for a future release.
This feature works with these operating systems:
l Red Hat Enterprise Linux
l Ubuntu
l CentOS
l Debian
l Amazon Linux
l Oracle Linux
l SUSE Linux Enterprise Server
l Cloud Linux
l Windows
Enable automatic agent upgrade
1. Make sure the latest agent software and kernel support packages are available in Deep
Security Manager. You can configure Deep Security Manager to automatically download
software updates, or import them manually. For details, see "Get Deep Security Agent
software" on page 266.
2. Go to Administration > System Settings > Agents.
3. Under Agent Upgrade, select any of the following: Automatically upgrade Linux agents on
activation, Automatically upgrade Windows agents on activation, Automatically upgrade
Unix agents on activation.
4. Click Save.
Check that agents were upgraded successfully
The Version column on the Computers page displays the installed Deep Security Agent version
for each computer.
1140
Trend Micro Deep Security On-Premise 20
In addition, when an automatic agent upgrade is triggered, " System events" on page 984 are
generated that you can use to track the status of the upgrade. You can check for these system
events:
ID Event Description
Agent
Software An agent software upgrade has been triggered, either manually or by
264
Upgrade an automatic agent upgrade.
Requested
The agent was eligible for an automatic upgrade, but the upgrade did
not occur.
The event details list the existing agent version and the attempted
upgrade version, along with the reason the upgrade failed. The reasons
can be:
l Upgrade on activation was skipped for this computer because
there is a pending reboot request. Please restart the computer to
resolve this issue. The upgrade request will be serviced during
the next activation after the reboot.
l Upgrade on activation is not currently supported for use on
Windows servers when the target version to upgrade to is earlier
Upgrade than Deep Security Agent 12. There are improvements in the 12
on
277 agent that are required for this feature. Please update the agent
Activation
Skipped version control configuration to use a 12 or later agent for this
platform to allow the upgrade to succeed.
l The agent was not upgraded automatically because a required
Linux kernel support file was not found. Deep Security Manager
usually downloads required Linux kernel support packages
automatically, but you can also download and import packages to
Deep Security Manager manually and then upgrade the agent.
See "Get Deep Security Agent software" on page 266.
l The agent was not upgraded automatically because the upgrade
on activation feature does not support the currently installed OS.
You may be able to upgrade the agent manually. See "Install the
agent" on page 273.
706 Software The upgrade was successful.
1141
Trend Micro Deep Security On-Premise 20
ID Event Description
Update:
Agent
Software
Upgraded
Software
Update:
Agent The upgrade was not successful. Refer to the event details for more
707
Software information about why it was not successful.
Upgrade
Failed
Using Deep Security with iptables
When Deep Security Agent 10.1 or earlier was installed on Linux, it disabled the iptables service
to avoid firewall conflicts unless you added a configuration file that prevented that change.
However, the iptables service is used for more than just firewall (for example, Docker manages
iptables rules as part of its normal operation), so disabling it sometimes had negative
consequences.
With Deep Security 10.2 and higher (including Deep Security 11), the functionality around
iptables has changed. Deep Security Agent no longer disables iptables. (If iptables is enabled, it
stays enabled after the agent installation. If iptables is disabled, it stays disabled.) However, if
the iptables service is running, Deep Security Agent and Deep Security Manager require certain
iptables rules, as described below.
Rules required by Deep Security Manager
If iptables is enabled on the computer where Deep Security Manager is being installed, there are
two required iptables rules. By default, these rules are added when Deep Security Manager
starts up and removed when the manager is stopped or uninstalled. Alternatively, you can
"Prevent Deep Security from automatically adding iptables rules" on the next page and add them
manually instead:
l Allow incoming traffic on port 4119. This is required for access to the Deep Security
Manager web UI and API.
l Allow incoming traffic on port 4120. This is required to listen for agent heartbeats. (For
more information, see "Agent-manager communication" on page 1124.)
1142
Trend Micro Deep Security On-Premise 20
Note: These are the default port numbers - yours may be different. For a complete list of ports
used in Deep Security, see "Port numbers, URLs, and IP addresses" on page 178.
Rules required by Deep Security Agent
If iptables is enabled on the computer where Deep Security Agent is being installed, iptables
may require additional rules. By default, these rules are added when Deep Security Agent starts
up and removed when the agent is stopped or uninstalled. Alternatively, you can "Prevent Deep
Security from automatically adding iptables rules" below and add them manually instead:
l Allow incoming traffic on port 4118. This is required when the agent uses manager-
initiated or bidirectional communication. (For more information, see "Agent-manager
communication" on page 1124.)
l Allow incoming traffic on port 4122. This is required when the agent is acting as a relay, so
that the relay can distribute software updates. (For more information, see "Deploy
additional relays" on page 1091.)
Note: These are the default port numbers - yours may be different. For a complete list of ports
used in Deep Security, see "Port numbers, URLs, and IP addresses" on page 178.
Prevent Deep Security from automatically adding iptables rules
You can prevent Deep Security Manager and Deep Security Agent from modifying iptables if you
would rather add the required rules manually. To prevent the automatic modification of iptables,
create the following file on the computers where you plan to install Deep Security Manager and
Deep Security Agent:
/etc/do_not_open_ports_on_iptables
Enable or disable agent self-protection
Note: The agent self-protection feature is only available for agents on Windows. It is not
available on Linux.
Agent self-protection prevents local users from tampering with the agent. When enabled, if a
user tries to tamper with the agent, a message such as "Removal or modification of this
application is prohibited by its security settings" will be displayed.
1143
Trend Micro Deep Security On-Premise 20
To update or uninstall Deep Security Agent or Relay, or if you're a local user trying to create a
diagnostic package for support from the command line (see "Create a diagnostic package and
logs" on page 1550), you must temporarily disable agent self-protection.
Note: Anti-Malware protection must be "On" to prevent users from stopping the agent, and
from modifying agent-related files and Windows registry entries. It isn't required, however, to
prevent uninstalling the agent.
You can configure agent self-protection using either the Deep Security Manager, or the
command line on the agent's computer.
Configure self-protection through Deep Security Manager
1. Open the Computer or Policy editor 1 where you want to enable agent self-protection.
2. Click Settings > General.
3. In the Agent Self-Protection section, for Prevent local end-users from uninstalling,
stopping, or otherwise modifying the Agent, select Yes.
4. For Local override requires password, select Yes and type an authentication password.
The authentication password is highly recommended because it prevents unauthorized
use of the dsa_control command. After specifying the password here, it must be entered
with the dsa_control command using the -p or --passwd= option whenever a command is
run on the agent.
5. Click Save.
6. To disable the setting, select No. Click Save.
Configure self-protection using the command line
You can enable and disable self-protection using the command line. The command line has one
limitation: you cannot specify an authentication password. You'll need to use Deep Security
Manager for that. See "Configure self-protection through Deep Security Manager" above for
details.
1. Log in to the Windows agent locally.
2. Open the Command Prompt (cmd.exe) as Administrator.
3. Change the current directory to the Deep Security Agent installation folder. (The default
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1144
Trend Micro Deep Security On-Premise 20
install folder is shown below.)
cd C:\Program Files\Trend Micro\Deep Security Agent
4. Enter one of the following commands:
To enable agent self-protection, enter:
dsa_control --selfprotect=1
To disable agent self-protection, enter:
dsa_control --selfprotect=0 -p <password>
where -p <password> is the authentication password, if one was specified previously in
Deep Security Manager. For details on this password, see "Configure self-protection
through Deep Security Manager" on the previous page.
Are "Offline" agents still protected by Deep Security?
Agents showing as "Offline" in the Deep Security Manager are still being protected according to
their last known configuration. However, they will not receive any software, security or policy
updates until communication with the Deep Security Manager is restored.
For more information on how to bring an agent out of "Offline" status, see ""Offline" agent" on
page 1519.
Automate offline computer removal with inactive agent
cleanup
If your Deep Security deployment has a large number of offline computers not communicating
with the Deep Security Manager, first try using a connector (see "About adding AWS accounts"
on page 393, "Add a Microsoft Azure account to Deep Security" on page 416, or "Add a Google
Cloud Platform account" on page 429). When you use a connector, the complete life cycle of
your computers is managed automatically, meaning that computers deleted from your cloud
accounts are also automatically removed from Deep Security. If you can't use a connector in
your environment, you can automate the removal of inactive computers using inactive agent
cleanup. Inactive agent cleanup will check hourly for computers that have been offline and
inactive for a specified period of time (from 2 weeks to 12 months) and remove them.
1145
Trend Micro Deep Security On-Premise 20
Note: Inactive agent cleanup will remove a maximum of 1000 offline computers at each hourly
check. If there are more offline computers than this, 1000 will be removed at each consecutive
check until all of the offline computers have been removed.
After enabling inactive agent cleanup, you can also
l "Ensure computers that are offline for extended periods of time remain protected with Deep
Security" below (optional but recommended).
l "Set an override to prevent specific computers from being removed" on the next page
(optional).
l "Check the audit trail for computers removed by an inactive cleanup job" on the next page.
Note: Inactive agent cleanup does not remove offline computers that have been added by a
cloud connector.
Enable inactive agent cleanup
1. Go to the Administration page.
2. Under System Settings > Agents > Inactive Agent Cleanup, select Delete Agents that
have been inactive for.
3. From the list, select the period that a computer must be inactive before being removed.
4. "Ensure computers that are offline for extended periods of time remain protected with Deep
Security" below (optional but recommended).
5. Click Save.
Ensure computers that are offline for extended periods of time remain
protected with Deep Security
If you have offline computers that are active but communicate irregularly with the Deep Security
Manager, inactive agent cleanup will remove them if they don't communicate within the period of
inactivity you defined. To ensure that these computers reconnect to Deep Security Manager, we
recommend enabling both Agent-Initiated Activation and Reactivate unknown Agents. To do
so, under System Settings > Agents > Agent Initiated Activation, first select Allow Agent-
Initiated Activation and then select Reactivate Unknown Agents.
1146
Trend Micro Deep Security On-Premise 20
Note: When a removed computer reconnects, it will not have a policy, and will be added as a
new computer. Any direct links to the computer will be removed from the Deep Security
Manager event data.
Tip: You can automatically assign a policy assigned to a computer upon agent-initiated
activation with an event-based task.
Set an override to prevent specific computers from being removed
You can set an override at the computer or policy level to explicitly prevent computers from being
removed by inactive agent cleanup.
To set an override
1. Open the Computer or Policy editor 1 for the computer or policy you want to set an override
on.
2. Go to Settings > General.
3. Under Inactive Agent Cleanup Override, select Yes.
4. Click Save.
Check the audit trail for computers removed by an inactive cleanup job
When an inactive agent cleanup job runs, system events will be generated that you can use to
track removed computers.
You'll need to check the following system events:
l "2953 - Inactive Agent Cleanup Completed Successfully" on the next page
l "251 - Computer Deleted" on the next page
l "716 - Reactivation Attempted by Unknown Agent" on the next page (if 'Reactivate
Unknown Agents' is enabled)
Search system events
To view the system events generated by an inactive agent cleanup job, you need to create a
search that filters for them:
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1147
Trend Micro Deep Security On-Premise 20
1. Go to the Events and Reports page.
2. In the top-right corner, click the Search field list and select Open Advanced Search.
3. For the Period, select Custom Range from the list.
4. For From, enter the date and time just before the inactive agent cleanup job was first run.
For To, enter the date and time just after the cleanup job finished.
5. For the Search, select Event ID and In, and then enter 2953, 251. You can optionally enter
716 and any of the event IDs (130, 790, 350, 250) associated with computer reactivation.
This will display all the system events generated by an inactive agent cleanup job. You can sort
the events by time, event ID or event name by clicking on the corresponding column. You can
then double-click an event to get more information about it, as detailed below.
System event details
2953 - Inactive Agent Cleanup Completed Successfully
This event is generated when the inactive agent cleanup job runs and successfully removes
computers. The description for this event will tell you how many computers were removed.
Note: If more than one check is needed to remove all computers, a separate system event will
be generated for each check.
251 - Computer Deleted
In addition to the 'Inactive Agent Cleanup Completed Successfully' event, a separate 'Computer
Deleted' event is generated for each computer that was removed.
716 - Reactivation Attempted by Unknown Agent
If Reactivate Unknown Agents is enabled, this event will be generated for an activated computer
that was removed when it attempts to reconnect to the Deep Security Manager. Each reactivated
computer will also generate the following system events:
l 130 - Credentials Generated
l 790 - Agent-Initiated Activation Requested
l 350 - Policy Created (if you've enabled an event-based task that assigns a policy)
1148
Trend Micro Deep Security On-Premise 20
l 250 - Computer Created
or
252 - Computer Updated
Agent settings
Deep Security Agent-related settings are located on Administration > System Settings >
Agents. They include the following.
Tip: You can automate agent-related system setting changes using the Deep Security API.
For examples, see Configure Policy, Computer, and System Settings.
Hostnames
Update the "Hostname" entry if an IP is used as a hostname and a change in IP is detected on
the computer after Agent/Appliance-initiated communication or discovery: Updates the IP
address displayed in the computer's "Hostname" property field if an IP change is detected.
Note: Deep Security Manager identifies protected computers by using a unique fingerprint, not
their IP addresses or hostnames.
Agent-initiated activation (AIA)
In addition to activating new agents on Deep Security Manager (such as via a cloud connector or
manually adding a new computer on Computers), but you can also (or instead) allow agents to
automatically activate themselves. See also "Activate and protect agents using agent-initiated
activation and communication" on page 1138.
Allow Agent-Initiated Activation: Allow agents to connect to the manager to activate
themselves. Then select which computers are allowed to perform agent-initiated activation.
l For Any Computers: Any computer, whether it is already listed on Computers or not.
Warning: To prevent unauthorized agent activations, don't enable this option if your
network allows connections to Deep Security Manager from untrusted networks such as
the Internet. To similarly protect Deep Security Agent from unauthorized managers, only
allow agent activation with your authenticated manager.
1149
Trend Micro Deep Security On-Premise 20
l For Existing Computers: Only computers already listed on Computers.
l For Computers on the following IP List: Only computers whose IP address has a match
on the specified IP list.
Also configure initiation behavior:
l Policy to assign (if Policy not assigned by activation script): Security policy to assign to
the computer during activation. This setting only applies if no policy is specified in the
agent's activation script or an AIA event-based task.
l Allow Agent to specify hostname: Allow the agent to specify its hostname by providing it to
Deep Security Manager during activation.
l If a computer with the same name already exists: How to handle the activation attempt if
the new computer is trying to use the same agent GUID or certificate as an existing
computer:
l Do not allow activation: Don't activate the computer.
l Activate a new Computer with the same name: Using a new name, create a new
computer object and activate the computer.
l Re-activate the existing Computer: Keeping the same name, reuse the existing
computer object and activate the computer.
This setting only applies to physical computers, Azure virtual machiness (VMs), Google
Cloud Platform (GCP) VMs, or VMware VMs. (AWS provides a unique instance ID that
Deep Security Manager uses to differentiate all AWS instances, so this setting is ignored
for those computers.)
l Reactivate cloned Agents: Reactivate clones as new computers; assign the the policy
selected in Policy to assign (if Policy not assigned by activation script). This can be useful
when re-imaging computer hard disks, or deploying new VM instances or AMI, using a
"golden image" that has an already-activated Deep Security Agent. It ensures that each
computer has a unique agent GUID, despite being deployed by copying the same software
image.
Clones are detected after the initial activation, during their first heartbeat. If the same agent
GUID is being used on different computers, the manager detects the clones and
reactivates those computers.
1150
Trend Micro Deep Security On-Premise 20
Note: If you disable this option, clones will not be automatically reactivated. You'll need
to activate them either manually through the manager or via an activation script.
This setting only applies to AWS instances, Azure virtual machines (VMs), Google Cloud
Platform (GCP) VMs, or VMware VMs that you added via Computers > Add Account.
l Reactivate unknown Agents: Reactivate deleted (but previously activated) computers as
new computers if they connect again; do not assign the original computer's assigned
policies or rules. This setting is useful together with inactive agent cleanup: any
accidentally removed computers can automatically re-activate. See also "Automate offline
computer removal with inactive agent cleanup" on page 1145.
Previously known agents are detected after the initial activation, during their next
heartbeat. If a heartbeat has an agent GUID (indicating prior activation) but its computer is
not currently listed on Computers, the manager reactivates the computer.
Note: Previous event messages will still link to the old computer object, not this new
one.
l Agent activation token: Optional. Agent activation secret. If specified, agents must provide
the same value when activating.
Note: If Deep Security Manager is multi-tenant, this setting applies only to the primary
tenant.
To configure this, you can use the token parameter in the agent activation script such as:
/opt/ds_agent/dsa_control -a dsm://172.16.0.5:4120/ "token:secret"
Agent Upgrade
Automatically upgrade agents on activation: During activation, upgrade Deep Security Agent to
the latest software version that's compatible with Deep Security Manager. Linux computers only.
See also "Automatically upgrade agents on activation" on page 1139.
1151
Trend Micro Deep Security On-Premise 20
Inactive Agent Cleanup
If you have many offline computers (that is, they are not communicating with Deep Security
Manager), and they don't need to manage them anymore, you can automatically remove them
from Computers via inactive agent cleanup. This setting is useful together with reactivating
currently unknown agents. See also "Automate offline computer removal with inactive agent
cleanup" on page 1145.
Delete Agents that have been inactive for: How much time a computer must be inactive in order
to be removed.
Data Privacy
Allow packet data capture in network events: This setting determines whether the agent
captures and sends packet data to Deep Security Manager as part of Intrusion Prevention and
Firewall events. The options for this setting are:
l Yes (excluding encrypted traffic): This is the default option. All unencrypted packet data is
sent to Deep Security Manager.
l Yes (all traffic): All packet data is sent to Deep Security Manager, including encrypted
packet data. The resource requirements for capture of packet data on encrypted
connections is higher than for unencrypted connections. If you select this option and
encounter problems with performance on your workloads, consider switching to the option
that excludes encrypted traffic.
l No: Packet data is not captured or transmitted from the agent to Deep Security Manager.
Customers in regulated environments or who are concerned about the transmission of
network content to Deep Security Manager can disable this setting. For more information
about data transmitted to Deep Security Manager, see the Deep Security Data Collection
Notice.
Note: This feature is supported with Deep Security Agent 12.5.0.1001 or later.
Agentless vCloud Protection
Allow Appliance protection of vCloud VMs: Allow virtual machines in VMware vCloud to be
protected by Deep Security Virtual Appliance instead of (or in addition to) Deep Security Agent.
If Deep Security Manager is multi-tenant, tenants configure the security policies of those VMs.
1152
Trend Micro Deep Security On-Premise 20
Deep Security Notifier
The Deep Security Notifier is a Windows System Tray application that communicates the state of
the Deep Security Agent and Deep Security Relay to client machines. The notifier displays
popup user notifications when the Deep Security Agent begins a scan, or blocks malware or
access to malicious web pages.
The notifier has a small footprint on the client machine, requiring less than 1MB of disk space
and 1MB of memory. When the notifier is running the notifier icon ( ) appears in the system
tray. The notifier is automatically installed by default with the Deep Security Agent on Windows
computers. Use the Administration > Updates > Software > Local page to import the latest
version for distribution and upgrades.
Note: On computers running a relay-enabled agent, the notifier displays the components that
are being distributed to agents or appliances, not which components are in effect on the local
computer.
A standalone version of the notifier can be downloaded and installed on virtual machines that
are receiving protection from a Deep Security Virtual Appliance. See "Deploy Deep Security
Notifier" on page 382.
Note: On VMs protected by a virtual appliance, the anti-malware module must be licensed and
enabled on the VM for the Deep Security Notifier to display information.
How the notifier works
When malware is detected or a malicious site is blocked, the Deep Security Agent sends a
message to the notifier, which displays a popup message in the system tray.
If malware is detected, the notifier displays a message in a system tray popup similar to the
following:
1153
Trend Micro Deep Security On-Premise 20
If the user clicks on the message, a dialog box with detailed information about anti-malware
events is displayed:
When a malicious web page is blocked, the notifier displays a message in a system tray popup
similar to the following:
If the user clicks on the message, a dialog box with detailed information about web reputation
events is displayed:
1154
Trend Micro Deep Security On-Premise 20
The notifier also provides a console utility for viewing the current protection status and
component information, including pattern versions. The console utility allows the user to turn on
and off the popup notifications and access detailed event information.
1155
Trend Micro Deep Security On-Premise 20
Tip: You can also turn off pop-up notifications for certain computers or for computers that are
assigned a particular policy by going to the Deep Security Manager Computer/Policy editor >
Settings > General and settings Suppress all pop-up notifications on host to Yes. The
messages still appear as alerts or events in Deep Security Manager.
When the notifier is running on a computer hosting Deep Security Relay, the notifier's display
shows the components being distributed by the relay and not the components that in effect on
the computer.
1156
Trend Micro Deep Security On-Premise 20
When the notifier is running on a computer hosting Deep Security Scanner, the notifier shows
that the scanner feature is enabled and the computer cannot be a relay.
1157
Trend Micro Deep Security On-Premise 20
Linux Secure Boot support for agents
The Unified Extensible Firmware Interface (UEFI) Secure Boot feature is supported with some
versions of Deep Security Agent for Linux. For details, see this Secure Boot support table.
When Secure Boot is enabled on an agent computer, the Linux kernel performs a signature
check on kernel modules before they are installed. These Deep Security features install kernel
modules:
l Anti-Malware
l Web Reputation
1158
Trend Micro Deep Security On-Premise 20
l Firewall
l Integrity Monitoring
l Intrusion Prevention
l Application Control
If you intend to use any of those features on a computer where Secure Boot is enabled, you must
enroll the Trend Micro public key (provided after install as DSversion.der, depending on which
Deep Security Agent you have installed, for example DS20.der) into the Linux computer's
firmware so that it recognizes the Trend Micro kernel module's signature. Otherwise, the Deep
Security features can't be installed.
To enroll the Trend Micro public key:
1. On the computer that you want to protect, and where Secure Boot is enabled, install the
Deep Security Agent, if it isn't installed already.
After installation, the Trend Micro public key is in /opt/ds_agent/DS20.der.
2. Install the Machine Owner Key (MOK) facility, if it isn't already installed.
yum install mokutil
3. Add the public key, DS20.der, to the MOK list:
mokutil --import DS20.der
Note: For details about manually adding the public key to the MOK list, see your Linux
documentation.
4. When prompted, enter a password that you will use later in this procedure.
5. Reboot the system.
6. After the computer restarts, the Shim UEFI key management console opens:
1159
Trend Micro Deep Security On-Premise 20
7. Press any key to get started.
8. On the Perform MOK management screen, select Enroll MOK.
9. On the Enroll MOK screen, select View key 0.
10. On the Enroll the key(s)? screen, select Yes and then enter the password you set in step
4, above.
11. On the The system must now be rebooted screen, select OK to confirm your changes and
reboot.
12. Next, use the keyctl utility to check that the key is on the system key ring. If the keyctl
utility is not already installed, use this command to install it:
yum install keyutils
13. To list the keys that are on the system key ring:
keyctl list %:.system_keyring
You should see the Trend Micro signing key listed.
Upgrade the agent if you're using Secure Boot
Deep Security refreshes the Trend Micro kernel module signing key in every major release of the
agent (for example, 11.0 and 12). To keep security features functioning when you upgrade a
1160
Trend Micro Deep Security On-Premise 20
Deep Security Agent to a new major release, you must enroll the new public key into any Linux
computers that have Secure Boot enabled. You may see "Engine Offline" error message in the
Deep Security Manager console because the operating system will not load the upgraded kernel
module until the new public key is enrolled.
Manage users
Add and manage users
Deep Security has users, roles, and contacts that can be created and managed under
Administration > User Management.
l Users are Deep Security account holders who can sign in to the Deep Security Manager
with a unique user name and password. You can "Synchronize users with an Active
Directory" below or "Add or edit an individual user" on the next page
l Roles are a collection of permissions to view data and perform operations within Deep
Security Manager. Each user is assigned a role. See "Define roles for users" on
page 1166.
l Contacts do not have a user account and cannot sign in to Deep Security Manager but
they can be designated as the recipients of email notifications and scheduled reports. See
"Add users who can only receive reports" on page 1182.
Synchronize users with an Active Directory
If you use Active Directory to manage users, you can synchronize Deep Security with the Active
Directory to populate the user list. Users can then sign into Deep Security Manager using the
password stored in the directory.
Note: To successfully import an Active Directory user account into Deep Security as a Deep
Security user or contact, the Active Directory user account must have a userPrincipalName
attribute value. The userPrincipalName attribute corresponds to an Active Directory account
holder's "User logon name".
Note: If you are using Deep Security in FIPS mode, you must import the Active Directory's
SSL certificate before synchronizing with the Directory. See "Manage trusted certificates" on
page 1273.
1161
Trend Micro Deep Security On-Premise 20
1. In Deep Security Manager go to Administration > User Management > Users.
2. Click Synchronize with Directory to display the Synchronize with Directory wizard.
3. Type the address of the directory server and your access credentials and click Next. The
wizard attempts to connect to the Active Directory.
Note: If you are using Deep Security in FIPS mode, click Test Connection in the Trusted
Certificate section to check whether the Active Directory's SSL certificate has been
imported successfully into Deep Security Manager.
The wizard displays a page asking you to select Active Directory groups.
4. Enter an Active Directory group name or part of a group name into the search field and
press enter. Move the group to the Groups to synchronize pane using the >> button. The
manager will import the users in these Active Directory groups to the manager's Users list.
Once they have been imported, you are given the option to create a scheduled task to
periodically synchronize with the directory to keep your list up to date.
The imported list of users are locked out of the Deep Security Manager by default. You will have
to modify their properties to allow them to sign in to the Deep Security Manager.
Note: If you delete a user from Deep Security Manager who was added as a result of
synchronizing with an Active Directory and then resynchronize with the directory, the user will
reappear in your user list if they are still in the Active Directory.
Add or edit an individual user
1. In Deep Security Manager go to Administration > User Management > Users.
2. Click New to add a new user or double-click an existing user account to edit its settings.
3. Specify the general properties for the user, including:
l Username: The username that the user will enter on the Deep Security Manager
login screen.
l Password and Confirm Password: Note the password requirements listed in the
dialog box. You can password requirements in the user security settings (see
"Enforce user password rules" on page 1267).
l Name: (Optional) The name of the account holder.
l Description: (Optional) A description of the account.
l Role: Use the list to assign a predefined role to this user. You can also assign a role
to a user from the Users list, by right-clicking a user and then clicking Assign roles.
1162
Trend Micro Deep Security On-Premise 20
Note: The Deep Security Manager comes preconfigured with two roles: Full
Access and Auditor. The Full Access role grants users all possible privileges for
managing the Deep Security system, such as creating, editing, and deleting
computers, computer groups, policies, rules, and so on. The auditor role gives
users the ability to view all of the information in the Deep Security system but not
the ability to make any modifications except to their personal settings (password,
contact information, view preferences, and so on). Roles with various levels of
system access rights can be created and modified on the Roles page or by
selecting New in the Role list.
l Language: The language that will be used in the interface when this user logs in.
l Time zone: Time zone where the user is located. This time zone is used when
displaying dates and times in the Deep Security Manager.
l Time format: Time format used to display time in the Deep Security Manager. You
can use 12-hour or 24-hour format.
l Password never expires: When this option is selected, the user's password will
never expire. Otherwise, it will expire as specified in the user security settings (see
"Enforce user password rules" on page 1267
4. If you want to enable multi-factor authentication (MFA), click Enable MFA. If MFA is
already enabled for this user, you can select Disable MFA to disable it. For details, see
"Set up multi-factor authentication" on page 1269.
5. Click the Contact information tab and enter any contact information that you have for the
user and also indicate if they are your primary contact or not. You can also check the
Receive Alert Emails check box to include this user in the list of users who receive email
notifications when alerts are triggered.
6. You can also edit the settings on the Settings tab. However, increasing some of these
values will affect Deep Security Manager performance. If you make changes and aren't
happy with the results, you can click Reset to Default Settings (at the bottom of the tab) to
reset all settings on this page to their default values:
Module
l Hide Unlicensed Modules: This setting determines whether unlicensed modules will
be hidden rather than simply grayed out for this User. This option can be set globally
on the Administration > System Settings > Advanced tab.
Refresh Rate
1163
Trend Micro Deep Security On-Premise 20
l Status Bar: This setting determines how often the status bar of the Deep Security
Manager refreshes during various operations such as discovering or scanning
computers.
l Alerts List/Summary: How often to refresh the data on the Alerts page in List view or
Summary view.
l Computers List: How often to refresh the data on the Computers page.
Note: The Last Successful Update column value will not be recalculated unless the
page is manually reloaded.
l Computer Details: The frequency with which an individual computer's property page
refreshes itself with the latest information (if required).
List Views
l Remember last Tag filter on each page: Events pages let you filter displayed events
by Tag(s). This List Views setting determines if the "Tag" filter setting is retained when
you navigate away from and return to an Events page.
l Remember last Time filter on each page: Events pages let you filter displayed events
by Time period and computer(s). These List Views settings determine if the "Period"
and "Computer" filter settings are retained when you navigate away from and return to
an Events page.
l Remember last Computer filter on each page: Events pages let you filter displayed
events by Time period and computer(s). These List Views settings determine if the
"Period" and "Computer" filter settings are retained when you navigate away from and
return to an Events page.
l Remember last Advanced Search on each page: If you have performed an
"Advanced Search" on an Events page, this setting will determine if the search results
are kept if you navigate away from and return to the page.
l Number of items to show on a single page: Screens that display lists of items will
display a certain number of items per "Page". To view the next page, you must use the
pagination controls. Use this setting to change the number of list-items displayed per
page.
l Maximum number of items to retrieve from database: This setting limits the number
of items that can retrieved from the database for display. This prevents the possibility
of the Deep Security Manager getting bogged down trying to display an excessive
number of results from a database query. If a query produces more than this many
1164
Trend Micro Deep Security On-Premise 20
results, a message will appear at the top of the display informing you that only a
portion of the results are being displayed.
Note: Increasing these values will affect Deep Security Manager performance.
Reports
l Enable PDF Encryption: When this option is selected, reports exported in PDF format
will be password protected with the Report Password.
Change a user's password
To change a user's password, click Administration > User Management > Users, right-click the
user, and click Set Password. You will be prompted for the old password as well as the new
password.
Lock out a user or reset a lockout
If a user enters the wrong password too many times when trying to sign in, they will be locked
out automatically. If you have resolved the situation and want to allow the user the log in, see
"Unlock a locked out user name" on page 1184.
View system events associated with a user
To see any system events associated with a user, click Administration > User Management >
Users, right-click the user, and click View System Events.
Delete a user
To remove a user account from Deep Security Manager, click Administration > User
Management > Users, click the user, and then click Delete.
Note: If you delete a user from Deep Security Manager who was added as a result of
synchronizing with an Active Directory and then resynchronize with the directory, the user will
reappear in your user list if they are still in the Active Directory.
1165
Trend Micro Deep Security On-Premise 20
Define roles for users
Deep Security uses role-based access control (RBAC) to restrict user permissions to parts of
Deep Security. Access rights and editing privileges are attached to roles and not to users. Once
you have installed Deep Security Manager, you should create individual accounts for each user
and assign each user a role that will restrict their activities to all but those necessary for the
completion of their duties. To change the access rights and editing privileges of an individual
user, you must assign a different role to the user or edit the role.
The access that roles have to computers and policies can be restricted to subsets of computers
and policies. For example, users can be permitted to view all existing computers, but only
permitted to modify those in a particular group.
Deep Security comes preconfigured with two roles:
l Full Access: The full access role grants the user all possible privileges in terms of
managing the Deep Security system including creating, editing, and deleting computers,
computer groups, policies, rules, malware scan configurations, and others.
l Auditor: The auditor role gives the user the ability to view all the information in the Deep
Security system but without the ability to make any modifications except to their own
personal settings, such as password, contact information, dashboard layout preferences,
and others.
Note: Depending on the level of access granted, controls in Deep Security Manager will be
either visible and changeable, visible but disabled, or hidden. For a list of the rights granted in
the preconfigured roles, as well as the default rights settings when creating a new role, see
"Default settings for full access, auditor, and new roles" on page 1174.
You can create new roles that can restrict users from editing or even seeing Deep Security
objects such as specific computers, the properties of security rules, or the system settings.
Before creating user accounts, identify the roles that your users will take and itemize what Deep
Security objects those roles will require access to and what the nature of that access will be
(viewing, editing, creating, and so on). Once you have created your roles, you can then begin
creating user accounts and assigning them specific roles.
Note: Do not create a new role by duplicating and then modifying the full access role. To
ensure that a new role only grants the rights you intend, create the new role by clicking New in
the toolbar. The rights for a new role are set at the most restrictive settings by default. You can
1166
Trend Micro Deep Security On-Premise 20
then proceed to grant only the rights that are required. If you duplicate the full access role and
then apply restrictions, you risk granting some rights that you did not intend.
Clicking New ( ) or Properties ( ) displays the Role properties window with six tabs
(General, Computer Rights, Policy Rights, User Rights, Other Rights, and Assigned To).
Add or edit a role
1. In Deep Security Manager go to Administration > User Management > Roles.
2. Click New to add a new role or double-click an existing role to edits its settings.
3. Specify the general properties for the role, including:
l Name: The name of the role, which will appear on the Roles page and in the list of
available roles when adding a user.
l Description: (Optional) A description of the role.
l Access Type: Select whether users with this role will have access to Deep Security
Manager, the Deep Security Manager Web service API (applies to the legacy
SOAP and REST APIs), or both.
l
Note: To enable the legacy SOAP and REST Web service APIs, go to
Administration > System Settings > Advanced > SOAP Web Service API.
4. Use the Computer Rights pane to confer viewing, editing, deleting, alert-dismissal, and
event tagging rights to users in a role. These rights can apply to all computers and
computer groups or they can be restricted to only certain computers. If you wish to restrict
access, select the Selected Computers radio button and put a check next to the computer
groups and computers that users in this role will have access to.
5. Note: These rights restrictions will affect not only the user's access to computers in Deep
Security Manager, but also what information is visible, including events and alerts. As
well, email notifications will only be sent if they relate to data that the user has access
rights to.
1167
Trend Micro Deep Security On-Premise 20
Four basic options are available:
l Allow viewing of non-selected computers and data: If users in this role have restricted
edit, delete, or dismiss-alerts rights, you can still allow them to view but not change
information about other computers by checking this box.
l Allow viewing of events and alerts not related to computers: Set this option to allow
users in this role to view non-computer-related information (for example, system
events, like users being locked out, new firewall rules being created, IP Lists being
1168
Trend Micro Deep Security On-Premise 20
deleted, and so on)
Note: The previous two settings affect the data that users have access to. Although
the ability of a user to make changes to computers have been restricted, these two
settings control whether they can see information relating to computers they don't
otherwise have access to. This includes receiving email notifications related to those
computers.
l Allow new computers to be created in selected Groups: Set this option to allow users
in this role to create new computers in the computer groups they have access to.
l Allow sub-groups to be added/removed in selected Groups: Set this option to allow
users in this role to create and delete subgroups within the computer groups they have
access to.
You can also enabled these in the Advanced Rights section:
l Allow computer file imports: Allow Users in this Role to import computers using files
created using the Deep Security Manager's Computer Export option.
l Allow Directories to be added, removed and synchronized: Allow Users in this Role
to add, remove, and synchronize computers that are being managed using an LDAP-
based directory like MS Active Directory.
l Allow VMware vCenters to be added, removed and synchronized: Allow Users in this
Role to add, remove and synchronize VMware vCenters. (Not available with Deep
Security as a Service)
l Allow Cloud Providers to be added, removed, and synchronized: Allow Users in this
Role to add, remove, and synchronize Cloud Providers. (Not available with Deep
Security as a Service)
6. Use the Policy Rights tab to confer viewing, editing, and deleting rights to users in a role.
These rights can apply to all policies or they can be restricted to only certain policies. If you
wish to restrict access, click Selected Policies and put a check mark next to the policies
that users in this role will have access to.
1169
Trend Micro Deep Security On-Premise 20
When you allow rights to a policy that has "child" policies, users automatically get rights to
the child policies as well.
Two basic options are available:
l Allow viewing of non-selected Policies: If users in this role have restricted edit or
delete rights, you can still allow them to view but not change information about other
policies by checking this box.
1170
Trend Micro Deep Security On-Premise 20
l Allow new Policies to be created: Set this option to allow users in this role to create
new policies.
You can also enabled this in the Advanced Rights section:
l Allow Policy imports: Allow users in this role to import policies using files created with
the Deep Security Manager Export option on the Policies tab.
7. The options on the User Rights tab allow you to define permissions for administrator
accounts.
1171
Trend Micro Deep Security On-Premise 20
l Change own password and contact information only: Users in this role can change
their own password and contact information only.
l Create and manage Users with equal or less access: Users in this role can create
and manage any users who do not have any privileges greater than theirs. If there is
even a single privilege that exceeds those of the users with this role, the users with
this role will not be able to create or manage them.
l Have full control over all Roles and Users: Gives users in this role the ability to create
and edit and users or roles without restrictions. Be careful when using this option. If
you assign it to a role, you may give a user with otherwise restricted privileges the
ability to create and then sign in as a user with full unrestricted access to all aspects of
the Deep Security Manager.
l Custom: You can further restrict the ability of a user to view, create, edit, or delete
users and roles by selecting Custom and using the options in the Custom Rights
section. Some options may be restricted for certain users if the Can only manipulate
Users with equal or lesser rights option is selected.
The Can only manipulate Users with equal or lesser rights option limits the authority
of users in this role. They will only be able to effect changes to users that have equal
or lesser rights than themselves. Users in this Role will not be able to create, edit, or
delete roles. Selecting this option also places restrictions on some of the options in the
Custom Rights section:
l Can Create New Users: Can only create users with equal or lesser rights.
l Can Edit User Properties: Can only edit a user (or set or reset password) with
equal or lesser rights.
l Can Delete Users: Can only delete users with equal or lesser rights.
8. The Other Rights tab enables you to restrict roles' permissions so that they can only
access specific Deep Security features, and sometimes specific actions with those
features. This can be useful if, for example, you have a team of administrators, and you
want to make sure that they don't accidentally overwrite each others' work. By default, roles
are View Only or Hide for each feature. To allow to full control or customized access,
1172
Trend Micro Deep Security On-Premise 20
select Custom from the list.
9. The Assigned To tab displays a list of the users who have been assigned this role. If you
want to test that roles are working correctly, sign in as a newly created user and verify the
functionality.
1173
Trend Micro Deep Security On-Premise 20
Default settings for full access, auditor, and new roles
The following table identifies the default rights settings for the full access role and the auditor
role. Also listed are the rights settings that are in place when creating a new role by clicking New
in the toolbar on the Roles page.
RIGHTS SETTINGS BY ROLE
Auditor New Role
General Full Access Role
Role Defaults
Access to DSM
Allowed Allowed Allowed
User Interface
Access to Web Not
Allowed Allowed
Service API allowed
Auditor New Role
Computer Rights Full Access Role
Role Defaults
Allowed, Allowed,
View Allowed, All Computers All All
Computers Computers
Not Not
allowed, allowed,
Edit Allowed, All Computers
All All
Computers Computers
Not Not
allowed, allowed,
Delete Allowed, All Computers
All All
Computers Computers
Not Not
Dismiss Alerts allowed, allowed,
Allowed, All Computers
for All All
Computers Computers
Not Not
allowed, allowed,
Tag Items for Allowed, All Computers
All All
Computers Computers
Allow viewing of Allowed Allowed Allowed,
1174
Trend Micro Deep Security On-Premise 20
RIGHTS SETTINGS BY ROLE
non-selected
computers and All
data (e.g. Computers
events, reports)
Allow viewing of
Allowed,
events and alerts
Allowed Allowed All
not related to
Computers
computers
Allow new
computers to be Not Not
Allowed
created in allowed allowed
selected Groups
Allow sub-groups
to be added or Not Not
Allowed
removed in allowed allowed
selected Groups
Allow computer Not Not
Allowed
file imports allowed allowed
Allow Cloud
Accounts to be
Not Not
added, removed Allowed
allowed allowed
and
synchronized
Auditor New Role
Policy Rights Full Access Role
Role Defaults
Allowed, Allowed,
View Allowed, All Policies All All
Policies Policies
Not Not
allowed, allowed,
Edit Allowed, All Policies
All All
Policies Policies
Not Not
Delete Allowed, All Policies allowed, allowed,
1175
Trend Micro Deep Security On-Premise 20
RIGHTS SETTINGS BY ROLE
All All
Policies Policies
View non-
Allowed Allowed Allowed
selected Policies
Create new Not Not
Allowed
Policies allowed allowed
Not Not
Import Policies Allowed
allowed allowed
User Rights (See
Auditor New Role
note on User Full Access Role
Role Defaults
rights below)
Not
View Users Allowed Allowed
allowed
Not Not
Create Users Allowed
allowed allowed
Edit User Not Not
Allowed
Properties allowed allowed
Not Not
Delete Users Allowed
allowed allowed
Not
View Roles Allowed Allowed
allowed
Not Not
Create Roles Allowed
allowed allowed
Edit Role Not Not
Allowed
Properties allowed allowed
Not Not
Delete Roles Allowed
allowed allowed
Delegate Not Not
Allowed
Authority allowed allowed
1176
Trend Micro Deep Security On-Premise 20
RIGHTS SETTINGS BY ROLE
Auditor New Role
Other Rights Full Access Role
Role Defaults
Alerts Full (Can Dismiss Global Alerts) View-Only View-Only
Alert
Full (Can Edit Alert Configurations) View-Only View-Only
Configuration
IP Lists Full (Can Create, Edit, Delete) View-Only View-Only
Port Lists Full (Can Create, Edit, Delete) View-Only View-Only
Schedules Full (Can Create, Edit, Delete) View-Only View-Only
System Settings Full (Can View, Edit System Settings
View-Only Hide
(Global) (Global))
Diagnostics Full (Can Create Diagnostic Packages) View-Only View-Only
Full (Can Tag (Items not belonging to
Computers), Can Delete Tags, Can
Tagging Update Non-Owned Auto-Tag Rules, Can View-Only View-Only
Run Non-Owned Auto-Tag Rules, Can
Delete Non-Owned Auto-Tag Rules)
Full (Can View, Add, Edit, Delete Tasks,
Tasks View-Only Hide
Execute Tasks)
Multi-Tenant
Full Hide View-Only
Administration
Scan Cache
Configuration Full View-Only View-Only
Administration
Full (Can View, Create, Edit, Delete
Contacts View-Only Hide
Contacts)
Licenses Full (Can View, Change License) View-Only Hide
Updates Full (Can Add, Edit, Delete Software; Can View-Only Hide
1177
Trend Micro Deep Security On-Premise 20
RIGHTS SETTINGS BY ROLE
View Update For Components; Can
Download, Import, Apply Update
Components; Can Delete Deep Security
Rule Updates)
Full (Can Create, Edit, Delete Asset
Asset Values View-Only View-Only
Values)
Certificates Full (Can Create, Delete SSL Certificates) View-Only View-Only
Relay Groups Full View-Only View-Only
Proxy Full View-Only View-Only
SAML Identity
Full Hide Hide
Providers
Malware Scan Full (Can Create, Edit, Delete Malware
View-Only View-Only
Configuration Scan Configuration)
Full (Can Delete, Download Quarantined
Quarantined File View-Only View-Only
File)
Web Reputation
Full View-Only View-Only
Configuration
Directory Lists Full (Can Create, Edit, Delete) View-Only View-Only
File Lists Full (Can Create, Edit, Delete) View-Only View-Only
File Extension
Full (Can Create, Edit, Delete) View-Only View-Only
Lists
Full (Can Create, Edit, Delete Firewall
Firewall Rules View-Only View-Only
Rules)
Firewall Stateful Full (Can Create, Edit, Delete Firewall
View-Only View-Only
Configurations Stateful Configurations)
Intrusion
Full (Can Create, Edit, Delete) View-Only View-Only
Prevention Rules
1178
Trend Micro Deep Security On-Premise 20
RIGHTS SETTINGS BY ROLE
Application
Full (Can Create, Edit, Delete) View-Only View-Only
Types
MAC Lists Full (Can Create, Edit, Delete) View-Only View-Only
Contexts Full (Can Create, Edit, Delete) View-Only View-Only
Integrity
Full (Can Create, Edit, Delete) View-Only View-Only
Monitoring Rules
Log Inspection
Full (Can Create, Edit, Delete) View-Only View-Only
Rules
Log Inspection
Full (Can Create, Edit, Delete) View-Only View-Only
Decoders
Application Full (Can Create, View, Edit, or Delete
Hide Hide
Control Rulesets Application Control rulesets)
Application Full (Can Create, View, Edit, or Delete
Hide Hide
Control Rule Application Control rules)
Application
Control Full (Can View or Allow/Block
Hide Hide
Unrecognized unrecognized software)
Software
Application
Full (Can Create, View, or Delete software
Control Software Hide Hide
inventory)
Inventory
The custom settings corresponding to the Change own password and contact information only
option are listed in the following table:
Custom settings corresponding to "Change own password and contact information only" option
Users
Can View Users Not allowed
Can Create New Users Not allowed
1179
Trend Micro Deep Security On-Premise 20
Custom settings corresponding to "Change own password and contact information only" option
Can Edit User Properties (User can always edit select
Not allowed
properties of own account)
Can Delete Users Not allowed
Roles
Can View Roles Not allowed
Can Create New Roles Not allowed
Can Edit Role Properties (Warning: conferring this right will let
Not allowed
Users with this Role edit their own rights)
Can Delete Roles Not allowed
Delegate Authority
Can only manipulate Users with equal or lesser rights Not allowed
The custom settings corresponding to the Create and manage Users with equal or less access
option are listed in the following table:
Custom settings corresponding to "Create and manage Users with equal or less access" option
Users
Can View Users Allowed
Can Create New Users Allowed
Can Edit User Properties (User can always edit select
Allowed
properties of own account)
Can Delete Users Allowed
Roles
1180
Trend Micro Deep Security On-Premise 20
Custom settings corresponding to "Create and manage Users with equal or less access" option
Can View Roles Not allowed
Can Create New Roles Not allowed
Can Edit Role Properties (Warning: conferring this right will let
Not allowed
Users with this Role edit their own rights)
Can Delete Roles Not allowed
Delegate Authority
Can only manipulate Users with equal or lesser rights Allowed
The custom settings corresponding to the Have full control over all Roles and Users option are
listed in the following table:
Custom settings corresponding to "Have full control over all Roles and Users" option
Users
Can View Users Allowed
Can Create New Users Allowed
Can Edit User Properties (User can always edit select properties
Allowed
of own account)
Can Delete Users Allowed
Roles
Can View Roles Allowed
Can Create New Roles Allowed
Can Edit Role Properties (Warning: conferring this right will let
Allowed
Users with this Role edit their own rights)
1181
Trend Micro Deep Security On-Premise 20
Custom settings corresponding to "Have full control over all Roles and Users" option
Can Delete Roles Allowed
Delegate Authority
Can only manipulate Users with equal or lesser rights Not applicable
Add users who can only receive reports
"Contacts" are users who cannot sign in to the Deep Security Manager but can periodically be
sent reports (using scheduled tasks). Contacts can be assigned a "clearance" level that maps to
existing roles. When a contact is sent a report, the report will not contain any information not
accessible to a user of the same level. For example, three contacts may each be listed as the
recipients of a weekly summary report but the contents of the three reports could be entirely
different for each contact depending on their computer rights.
Add or edit a contact
1. In Deep Security Manager go to Administration > User Management > Contacts.
2. Click New to add a new contact or double-click an existing contact to edit its settings.
3. In the General Information section, specify the name, description, and preferred language
of this contact.
4. In the Contact Information section, enter the email address to which reports will be sent if
this contact is included in a report distribution list. (See the Reports page for more
information.)
5. In the Clearance section, specify the role that determines the information this contact will
be allowed to see. For example, if a computer report has been scheduled to be sent to this
contact, only information on the computers that his role permits him access to will be
included in the report.
6. In the Password Protected Reports section, select Reports generated by this user are
password protected to password-protect exported PDF reports with the Report Password.
Delete a contact
To remove a contact from Deep Security Manager, click Administration > User Management >
Contacts, click the contact, and then click Delete.
1182
Trend Micro Deep Security On-Premise 20
Create an API key for a user
To use the Deep Security Manager API, you will need an API key.
Note: API keys can only be used with the new"Use the Deep Security API to automate tasks"
on page 1376 available in Deep Security Manager 11.1 and later.
Note: Trend Micro recommends creating one API key for every user needing API access to
the Deep Security Manager.
Tip: You can automate API key creation using the Deep Security API. For examples, see the
Create and Manage API Keys guide in the Deep Security Automation Center.
To create a new API key:
1. Go to Administration > User Management > API Keys.
2. Click New.
3. In the Properties window, enter a Name and Description for the API key.
4. Click on the Role list and select a role. Auditor grants read-only access to the Deep
Security Manager through the API, while Full Access grants both read and write access. If
you need more specific roles for API key users, you can select New and define one. See
"Define roles for users" on page 1166 for more information on doing so.
5. Select a Language.
6. Select a Time Zone.
7. Optionally select Expires on and select an expiry date for the API key.
8. Click OK.
9. Copy the Secret key value.
Note: Make sure to copy the secret key value now, this is the only time it will be shown.
Lock out an existing API key
If an existing API key has been compromised you can lock it out:
1. Double click on the API key you want to lock out.
2. Optionally select Locked Out (Denied permission to authenticate) to block usage of the
API key.
3. Click OK.
1183
Trend Micro Deep Security On-Premise 20
Unlock a locked out user name
If you have attempted to sign in multiple times to Deep Security Manager with an incorrect
password, your user account will be locked out. The number of sign-in attempts allowed before
lock out is configured in Administration > System Settings > Security > Number of incorrect
sign-in attempts allowed (before lock out).
You can unlock users in different ways, depending on the following situations:
l If an administrator user is available, see "Unlock users as an administrator" below.
l If all the administrative users are locked out, see "Unlock administrative users from a
command line" below.
Unlock users as an administrator
1. Log in to Deep Security Manager with a working administrator user name and password.
2. Go to Administration > User Management > Users. Select the user you want to unlock,
right-click, and click Properties.
3. In the wizard, go to General > Sign-In Credentials. Deselect the Locked Out (Denied
permission to sign in) check box.
4. Click Save.
Unlock administrative users from a command line
1. Go to your local command line interface.
If your Deep Security Manager is Windows, go to the ..\Program Files\Trend
Micro\Deep security Manager directory.
If your Deep Security Manager is Linux, go to the /opt/dsm directory.
2. Enter the following command:
dsm_c -action unlockout -username <username>
1184
Trend Micro Deep Security On-Premise 20
Implement SAML single sign-on (SSO)
About SAML single sign-on (SSO)
Note: SAML single sign-on is not available when FIPS mode is enabled. See "FIPS 140-2
support" on page 1417.
To implement SAML single sign-on, see "Configure SAML single sign-on" on page 1187 or
"Configure SAML single sign-on with Azure Active Directory" on page 1193.
What are SAML and single sign-on?
Security Assertion Markup Language (or SAML) is an open authentication standard that allows
for the secure exchange of user identity information from one party to another. SAML supports
single sign-on, a technology that allows for a single user login to work across multiple
applications and services. For Deep Security, implementing SAML single sign-on means that
users signing in to your organization's portal would be able to seamlessly sign in to Deep
Security without an existing Deep Security account.
How SAML single sign-on works in Deep Security
Establishing a trust relationship
In SAML single sign-on, a trust relationship is established between two parties: the identity
provider and the service provider. The identity provider has the user identity information stored
on a directory server. The service provider (which in this case is Deep Security) uses the identity
provider's user identities for its own authentication and account creation.
The identity provider and the service provider establish trust by exchanging a SAML metadata
document with one another.
Note: At this time, Deep Security supports only the HTTP POST binding of the SAML 2.0
identity provider (IdP)-initiated login flow, and not the service provider (SP)-initiated login flow
Creating Deep Security accounts from user identities
Once Deep Security and the identity provider have exchanged SAML metadata documents and
established a trust relationship, Deep Security can access the user identities on the identity
provider's directory server. However, before Deep Security can actually create accounts from the
1185
Trend Micro Deep Security On-Premise 20
user identities, account types need to be defined and instructions for transforming the data format
need to be put in place. This is done using groups, roles and claims.
Groups and roles specify the tenant and access permissions that a Deep Security user account
will have. Groups are created on the identity provider's directory server. The identity provider
assigns user identities to one or more of the groups. Roles are created in the Deep Security
Manager. There must be both a group and a role for each Deep Security account type, and their
access permissions and tenant assignment must match.
Once there are matching groups and roles for each user type, the group data format needs to be
transformed into a format Deep Security can understand. This is done by the identity provider
with a claim. The claim contains instructions for transforming the group data format into the
matching Deep Security role.
Tip: Learn more about the "SAML claims structure" on page 1190 required by Deep Security.
Below is a representation of this process:
Implement SAML single sign-on in Deep Security
Once trust has been established between Deep Security and an identity provider with a
SAML metadata document exchange, matching groups and roles have been created, and a
claim put in place to translate the group data into roles, Deep Security can use SAML single
sign-on to automatically make Deep Security accounts for users signing in through your
organization's portal.
For more information on implementing SAML single sign-on, see "Configure SAML single sign-
on" on the next page.
1186
Trend Micro Deep Security On-Premise 20
Configure SAML single sign-on
Note: SAML single sign-on is not available when FIPS mode is enabled. See "FIPS 140-2
support" on page 1417.
When you configure Deep Security to use SAML single sign-on (SSO), users signing in to your
organization's portal can seamlessly sign in to Deep Security without an existing Deep Security
account. SAML single sign-on also makes it possible to implement user authentication access
control features such as:
l Password strength or change enforcement.
l One-Time Password (OTP).
l Two-Factor Authentication (2FA) or Multi-Factor Authentication (MFA).
For a more detailed explanation of Deep Security's implementation of the SAML standard, see
"About SAML single sign-on (SSO)" on page 1185. If you are using Azure Active Directory as
your identity provider, see "Configure SAML single sign-on with Azure Active Directory" on
page 1193.
Note: At this time, Deep Security supports only the HTTP POST binding of the SAML 2.0
identity provider (IdP)-initiated login flow, and not the service provider (SP)-initiated login flow
To use SAML single sign-on with Deep Security, you will need to do the following:
1. "Configure pre-set up requirements" below
2. "Configure Deep Security as a SAML service provider" on the next page
3. "Configure SAML in Deep Security" on page 1189
4. "Provide information for your identity provider administrator" on page 1189
5. "SAML claims structure" on page 1190
6. "Test SAML single sign-on" on page 1193
7. "Service and identity provider settings" on page 1193
Configure pre-set up requirements
1. Ensure your Deep Security Manager is functioning properly.
2. Contact the identity provider administrator to:
l Establish a naming convention for mapping directory server groups to Deep Security
roles.
l Obtain their identity provider SAML metadata document.
1187
Trend Micro Deep Security On-Premise 20
l Ask them to add any required user authentication access control features to their
policy.
Support is available to assist with the following identity providers that have been tested in Deep
Security with SAML single sign-on:
l Active Directory Federation Services (ADFS)
l Okta
l PingOne
l Shibboleth
l Azure Active Directory
Configure Deep Security as a SAML service provider
First, set up Deep Security as a service provider.
Note: In multi-tenant Deep Security installations, only the primary tenant administrator can
configure Deep Security as a SAML service provider.
1. In Deep Security Manager, go to Administration > User Management > Identity Providers
> SAML.
2. Click Get Started.
3. Enter an Entity ID and a Service Name, and then click Next.
Note: The Entity ID is a unique identifier for the SAML service provider. The SAML
specification recommends that the entity ID is a URL that contains the domain name of
the entity, and industry practices use the SAML metadata URL as the entity ID. The
SAML metadata is served from the /saml endpoint on the Deep Security Manager, so an
example value might be https://<DSMServerIP:4119>/saml.
4. Select a certificate option, and click Next. The SAML service provider certificate is not
used at this time, but would be used in the future to support service-provider-initiated login
or single sign-out features. You can import a certificate by providing a PKCS #12 keystore
file and password, or create a new self-signed certificate.
5. Follow the steps until you are shown a summary of your certificate details and then click
Finish.
1188
Trend Micro Deep Security On-Premise 20
Configure SAML in Deep Security
Import your identity provider's SAML metadata document
Note: Your Deep Security account must have both administrator and "Create SAML identity
provider" permissions.
1. On the Administration page, go to User Management > Identity Providers > SAML.
2. Click Get Started.
3. Click Choose File, select the SAML metadata document provided by your identity provider,
and click Next.
4. Enter a Name for the identity provider, and then click Finish.
You will be brought to the Roles page.
Create Deep Security roles for SAML users
You need to create a role for each of your expected user types. Each role must have a
corresponding group in your identity provider's directory server, and match the group's access
permissions and tenant assignment.
Your identity provider's SAML integration will have a mechanism to transform group membership
into SAML claims. Consult the documentation that came with your identity provider to learn more
about claim rules.
For information on how to create roles, see "Define roles for users" on page 1166.
Provide information for your identity provider administrator
Download the Deep Security Manager service provider SAML metadata document
1. On the Administration page, go to User Management > Identity Providers > SAML.
2. Under SAML Service Provider, click Download.
Your browser will download the Deep Security service provider SAML metadata document
(ServiceProviderMetadata.xml).
Send URNs and the Deep Security SAML metadata document to the identity provider administrator
You need to give the identity provider administrator Deep Security's service provider SAML
metadata document, the identity provider URN and the URN of each Deep Security role you
created.
1189
Trend Micro Deep Security On-Premise 20
Tip:
To view role URNs, go to Administration > User Management > Roles and look under the
URN column.
To view identity provider URNs, go to Administration > User Management > Identity
Providers > SAML > Identity Providers and look under the URN column.
Once the identity provider administrator confirms they have created groups corresponding to the
Deep Security roles and any required rules for transforming group membership into SAML
claims, you are done with configuring SAML single sign-on.
Note: If necessary, you can inform the identity provider administrator about the "SAML claims
structure" below required by Deep Security.
SAML claims structure
The following SAML claims are supported by Deep Security:
l "Deep Security user name (required)" below
l "Deep Security user role (required)" on the next page
l "Maximum session duration (optional)" on the next page
l "Preferred language (optional)" on page 1192
Deep Security user name (required)
The claim must have a SAML assertion that contains an Attribute element with a Name
attribute of
https://deepsecurity.trendmicro.com/SAML/Attributes/RoleSessionName and a
single AttributeValue element. The Deep Security Manager will use the AttributeValue as
the Deep Security user name.
Sample SAML data (abbreviated)
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
<AttributeStatement>
<Attribute
Name="https://deepsecurity.trendmicro.com/SAML/Attributes/RoleSessionNam
e">
<AttributeValue>alice</AttributeValue>
1190
Trend Micro Deep Security On-Premise 20
</Attribute>
</AttributeStatement>
</Assertion>
</samlp:Response>
Deep Security user role (required)
The claim must have a SAML assertion that contains an Attribute element with a Name
attribute of https://deepsecurity.trendmicro.com/SAML/Attributes/Role and between
one and ten AttributeValue elements. The Deep Security Manager uses the attribute value(s)
to determine the tenant, identity provider, and role of the user. A single assertion may contain
roles from multiple tenants.
Sample SAML data (abbreviated)
Note: The line break in the AttributeValue element is present for readability; in the claim it
must be on a single line.
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
<AttributeStatement>
<Attribute
Name="https://deepsecurity.trendmicro.com/SAML/Attributes/Role">
<AttributeValue>urn:tmds:identity:[pod ID]:[tenant ID]:saml-
provider/[IDP name],
urn:tmds:identity:[pod ID]:[tenant ID]:role/[role
name]</AttributeValue>
</Attribute>
</AttributeStatement>
</Assertion>
</samlp:Response>
Maximum session duration (optional)
If the claim has a SAML assertion that contains an Attribute element with a Name attribute of
https://deepsecurity.trendmicro.com/SAML/Attributes/SessionDuration and an
integer-valued AttributeValue element, the session will automatically terminate when that
amount of time (in seconds) has elapsed.
1191
Trend Micro Deep Security On-Premise 20
Sample SAML data (abbreviated)
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
<AttributeStatement>
<Attribute
Name="https://deepsecurity.trendmicro.com/SAML/Attributes/SessionDuratio
n">
<AttributeValue>28800</AttributeValue>
</Attribute>
</AttributeStatement>
</Assertion>
</samlp:Response>
Preferred language (optional)
If the claim has a SAML assertion that contains an Attribute element with the Name attribute of
https://deepsecurity.trendmicro.com/SAML/attributes/PreferredLanguage and a
string-valued AttributeValue element that is equal to one of the supported languages, the
Deep Security Manager will use the value to set the user's preferred language.
The following languages are supported:
l en-US (US English)
l ja-JP (Japanese)
Sample SAML data (abbreviated)
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
<AttributeStatement>
<Attribute
Name="https://deepsecurity.trendmicro.com/SAML/Attributes/PreferredLanguag
e">
<AttributeValue>en-US</AttributeValue>
</Attribute>
</AttributeStatement>
</Assertion>
</samlp:Response>
1192
Trend Micro Deep Security On-Premise 20
Test SAML single sign-on
Navigate to the single sign-on login page on the identity provider server, and log in to the Deep
Security Manager from there. You should be redirected to the Deep Security Manager console. If
SAML single sign-on is not functioning, follow the steps below:
Review the set-up
1. Review the "Configure pre-set up requirements" on page 1187 section.
2. Ensure that the user is in the correct directory group.
3. Ensure that the identity provider and role URNs are properly configured in the identity
provider federation service.
Create a Diagnostic Package
1. Go to Administration > System Information and click Diagnostic Logging.
2. Select SAML integration Issues and click Save.
3. Generate logs. Replicate the issue by logging in to the Deep Security Manager through
your identity provider.
4. After the login fails, generate a diagnostic package by navigating to Administration >
System Information and clicking on Create Diagnostic Package.
5. Once the diagnostic package has been created, navigate to https://success.trendmicro.com
to open a Technical Support Case, and upload the diagnostic package during the case
creation.
Service and identity provider settings
You can set how far in advance Deep Security will alert you to the expiry date of the server and
identity provider certificates, as well as how much time must pass before inactive user accounts
added through SAML single sign-on are automatically deleted.
To change these settings, go to Administration > System Settings > Security > Identity
Providers.
Configure SAML single sign-on with Azure Active Directory
For a detailed explanation of Deep Security's implementation of the SAML standard, see "About
SAML single sign-on (SSO)" on page 1185. For instructions on configuring it with other identity
providers, see "Configure SAML single sign-on" on page 1187.
1193
Trend Micro Deep Security On-Premise 20
Note:
l SAML single sign-on is not available when FIPS mode is enabled. See "FIPS 140-2
support" on page 1417.\
l At this time, Deep Security supports only the HTTP POST binding of the SAML 2.0
identity provider (IdP)-initiated login flow, and not the service provider (SP)-initiated login
flow.
Who is involved in this process?
Typically, there are two people required to configure Deep Security Manager to use Azure Active
Directory for SAML single sign-on (SSO): a Deep Security administrator and an Azure Active
Directory administrator.
The Deep Security administrator must be assigned a Deep Security role with the SAML Identity
Providers right set to either Full or to Custom with Can Create New SAML Identity Providers
enabled.
These are the steps required to set up SAML single sign-on with Deep Security using Azure
Active Directory, and the person who performs each step:
Step Performed by
Deep Security
"Configure Deep Security as a SAML service provider" below
administrator
"Download the Deep Security service provider SAML metadata Deep Security
document" on the next page administrator
Azure Active Directory
"Configure Azure Active Directory" on the next page
administrator
Deep Security
"Configure SAML in Deep Security" on page 1197
administrator
Azure Active Directory
"Define a role in Azure Active Directory" on page 1197
administrator
Configure Deep Security as a SAML service provider
First, set up Deep Security as a service provider.
1194
Trend Micro Deep Security On-Premise 20
Note: In multi-tenant Deep Security installations, only the primary tenant administrator can
configure Deep Security as a SAML service provider.
1. In Deep Security Manager, go to Administration > User Management > Identity Providers
> SAML.
2. Click Get Started.
3. Enter an Entity ID and a Service Name, and then click Next.
Note: The Entity ID is a unique identifier for the SAML service provider. The SAML
specification recommends that the entity ID is a URL that contains the domain name of
the entity, and industry practices use the SAML metadata URL as the entity ID. The
SAML metadata is served from the /saml endpoint on the Deep Security Manager, so an
example value might be https://<DSMServerIP:4119>/saml.
4. Select a certificate option, and click Next. The SAML service provider certificate is not
used at this time, but would be used in the future to support service-provider-initiated login
or single sign-out features. You can import a certificate by providing a PKCS #12 keystore
file and password, or create a new self-signed certificate.
5. Follow the steps until you are shown a summary of your certificate details and then click
Finish.
Download the Deep Security service provider SAML metadata document
In Deep Security Manager, go to Administration > User Management > Identity Providers >
SAML and click Download. The file is downloaded as ServiceProviderMetadata.xml. Send
the file to your Azure Active Directory administrator.
Configure Azure Active Directory
The steps in this section are performed by an Azure Active Directory administrator.
Refer to Configure single sign-on to non-gallery applications in Azure Active Directory for details
on how to perform the steps below.
1. In the Azure Active Directory portal, add a new non-gallery application.
2. Configure single sign-on for the application. We recommend that you upload the metadata
file, ServiceProviderMetadata.xml, that was downloaded from Deep Security
Manager. Alternatively, you can enter a reply URL (the Deep Security Manager URL +
/saml).
1195
Trend Micro Deep Security On-Premise 20
3. Configure SAML claims. Deep Security requires these two:
l https://deepsecurity.trendmicro.com/SAML/Attributes/RoleSessionName
This is a unique user ID that will be the username in Deep Security. For example, you
could use the User Principal Name (UPN).
l https://deepsecurity.trendmicro.com/SAML/Attributes/Role
The format is “IDP URN,Role URN”. The IDP has not been created in Deep Security
Manager yet, so you can configure this SAML claim later, in "Define a role in Azure
Active Directory" on the next page.
You can also configure other optional claims, as described in "SAML claims structure" on
page 1198.
Note: The URLs shown in the screenshot above are for Deep Security as a Service. If
you are not using Deep Security as a Service, your URL will be different.
4. Download the Federation Metadata XML file and send it to the Deep Security
administrator.
If there are multiple roles defined in Deep Security, repeat these steps to create a separate
application for each role.
1196
Trend Micro Deep Security On-Premise 20
Configure SAML in Deep Security
Import the Azure Active Directory metadata document
1. In Deep Security Manager, go to Administration > User Management > Identity Providers
> SAML.
2. Click Get Started or New.
3. Click Choose File, select the Federation Metadata XML file that was downloaded from
Azure Active Directory and click Next.
4. Enter a Name for the identity provider, and then click Finish.
You will be brought to the Roles page.
Create Deep Security roles for SAML users
Make sure the Administration > User Management > Roles page in Deep Security contains
appropriate roles for your organization. Users should be assigned a role that limits their activities
to only those necessary for the completion of their duties. For information on how to create roles,
see "Define roles for users" on page 1166. Each Deep Security role requires a corresponding
Azure Active Directory application.
Get URNs
In Deep Security Manager, gather this information, which you will need to provide to your Azure
Active Directory administrator:
l the identity provider URN. To view identity provider URNs, go to Administration > User
Management > Identity Providers > SAML > Identity Providers and check the URN
column.
l the URN of the Deep Security role to associate with the Azure Active Directory application.
To view role URNs, go to Administration > User Management > Roles and check the
URN column. If you have multiple roles, you will need the URN for each role, because
each one requires a separate Azure Active application.
Define a role in Azure Active Directory
The steps in this section must be performed by an Azure Active Directory administrator.
In Azure Active Directory, use the identity provider URN and role URN identified in the previous
section to define the "role" attribute in the Azure application. This must be in the format “IDP
URN,Role URN”. See "Deep Security user role (required)" in the "SAML claims structure" on the
next page section.
1197
Trend Micro Deep Security On-Premise 20
Use the Validate button in Azure Active Directory to test the setup, or assign the new application
to a user and test that it works.
Service and identity provider settings
You can set how far in advance Deep Security will alert you to the expiry date of the server and
identity provider certificates, as well as how much time must pass before inactive user accounts
added through SAML single sign-on are automatically deleted.
To change these settings, go to Administration > System Settings > Security > Identity
Providers.
SAML claims structure
The following SAML claims are supported by Deep Security:
l "Deep Security user name (required)" below
l "Deep Security user role (required)" on the next page
l "Maximum session duration (optional)" on the next page
l "Preferred language (optional)" on page 1200
Deep Security user name (required)
The claim must have a SAML assertion that contains an Attribute element with a Name
attribute of
https://deepsecurity.trendmicro.com/SAML/Attributes/RoleSessionName and a
single AttributeValue element. The Deep Security Manager will use the AttributeValue as
the Deep Security user name.
Sample SAML data (abbreviated)
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
<AttributeStatement>
<Attribute
Name="https://deepsecurity.trendmicro.com/SAML/Attributes/RoleSessionNam
e">
<AttributeValue>alice</AttributeValue>
</Attribute>
</AttributeStatement>
1198
Trend Micro Deep Security On-Premise 20
</Assertion>
</samlp:Response>
Deep Security user role (required)
The claim must have a SAML assertion that contains an Attribute element with a Name
attribute of https://deepsecurity.trendmicro.com/SAML/Attributes/Role and between
one and ten AttributeValue elements. The Deep Security Manager uses the attribute value(s)
to determine the tenant, identity provider, and role of the user. A single assertion may contain
roles from multiple tenants.
Sample SAML data (abbreviated)
Note: The line break in the AttributeValue element is present for readability; in the claim it
must be on a single line.
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
<AttributeStatement>
<Attribute
Name="https://deepsecurity.trendmicro.com/SAML/Attributes/Role">
<AttributeValue>urn:tmds:identity:[pod ID]:[tenant ID]:saml-
provider/[IDP name],
urn:tmds:identity:[pod ID]:[tenant ID]:role/[role
name]</AttributeValue>
</Attribute>
</AttributeStatement>
</Assertion>
</samlp:Response>
Maximum session duration (optional)
If the claim has a SAML assertion that contains an Attribute element with a Name attribute of
https://deepsecurity.trendmicro.com/SAML/Attributes/SessionDuration and an
integer-valued AttributeValue element, the session will automatically terminate when that
amount of time (in seconds) has elapsed.
Sample SAML data (abbreviated)
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
1199
Trend Micro Deep Security On-Premise 20
<AttributeStatement>
<Attribute
Name="https://deepsecurity.trendmicro.com/SAML/Attributes/SessionDuratio
n">
<AttributeValue>28800</AttributeValue>
</Attribute>
</AttributeStatement>
</Assertion>
</samlp:Response>
Preferred language (optional)
If the claim has a SAML assertion that contains an Attribute element with the Name attribute of
https://deepsecurity.trendmicro.com/SAML/attributes/PreferredLanguage and a
string-valued AttributeValue element that is equal to one of the supported languages, the
Deep Security Manager will use the value to set the user's preferred language.
The following languages are supported:
l en-US (US English)
l ja-JP (Japanese)
Sample SAML data (abbreviated)
<samlp:Response xmlns:samlp="urn:oasis:names:tc:SAML:2.0:protocol">
<Assertion xmlns="urn:oasis:names:tc:SAML:2.0:assertion">
<AttributeStatement>
<Attribute
Name="https://deepsecurity.trendmicro.com/SAML/Attributes/PreferredLanguag
e">
<AttributeValue>en-US</AttributeValue>
</Attribute>
</AttributeStatement>
</Assertion>
</samlp:Response>
1200
Trend Micro Deep Security On-Premise 20
Manage the database
General database maintenance
To improve Deep Security Manager performance, we recommend that you perform regular index
maintenance on the Deep Security database to keep it from becoming overly fragmented. Follow
your organization's best practices for reindexing databases, or refer to your database vendor's
documentation for guidance:
l PostgreSQL: See https://www.postgresql.org/docs/10/sql-reindex.html for details on the
PostgreSQL reindex command.
l Microsoft SQL: Refer to documentation from Microsoft for index maintenance best
practices: https://docs.microsoft.com/en-us/sql/relational-databases/indexes/reorganize-
and-rebuild-indexes?view=sql-server-ver15. See also Options in the Back Up Database
Task for Maintenance Plan.
l Oracle Database: Follow Oracle’s best practices on managing indexes. For example, see
https://docs.oracle.com/cd/B28359_01/server.111/b28310/indexes002.htm#ADMIN11713.
There are also open source websites that provide scripts that can help you with this task.
Tip: Reindexing may block some operations, so it’s best to run it offline.
Maintain PostgreSQL
Follow these database maintenance and tuning recommendations:
1. Configure database log rotation and performance settings.
For best practices, see "Log rotation" on the next page, "Lock management" on page 1203,
"Maximum concurrent connections" on page 1203, "Autovacuum settings" on page 1205,
etc.
Steps vary by distribution and managed hosting:
l Self-hosted database: Defaults are generic values from the PostgreSQL core
distribution. Some defaults are not appropriate for data center or customized cloud
installs, especially in larger deployments.
To change settings:
1201
Trend Micro Deep Security On-Premise 20
l In a plain text editor, open the postgresql.conf file.
l Edit the parameters.
l Save the file.
l Restart the PostgreSQL service.
l Amazon RDS: Defaults vary by instance size. Often, you only need to fine tune
autovacuuming, max_connections and effective_cache_size. To change
settings, use database parameter groups and then restart the database instance.
l Amazon Aurora: Defaults vary by instance size. Often, you only need to fine tune
autovacuuming, max_connections and effective_cache_size. To change
settings, use database parameter groups and then restart the database instance.
Tip: When fine tuning performance, verify settings by monitoring your database IOPS
with a service such as Amazon CloudWatch.
Tip: If you need additional help, PostgreSQL offers professional support.
Log rotation
In PostgreSQL core distributions, by default, the database's local log file has no age or file size
limit. Logs will gradually consume more disk space.
To prevent that, configure parameters for either remote logging to a Syslog log_destination,
or local log rotation.
Log files can be rotated based on age limit, file size limit, or both (whichever occurs sooner).
When a limit is reached, depending on whether a log file exists that matches the file name
pattern at that time, PostgreSQL either creates a new file or reuses an existing one. Reuse can
either append or (for age limit) overwrite.
Log rotation parameters are:
l logging_collector: Enter "on" to enable database logging.
l log_filename: Log file name pattern. Patterns mostly use IEEE standard time and date
formatting.
l log_truncate_on_rotation: Enter either "off" to append to the existing log file, or "on" to
overwrite it. Only applies when time-based log rotation occurs. (File size-based log rotation
always appends.)
1202
Trend Micro Deep Security On-Premise 20
l log_rotation_age: Maximum age in minutes of a log file. Enter "0" to disable time-based
log rotation.
l log_rotation_size: Maximum size in kilobytes (KB) of a log file. Enter "0" to disable file
size-based log rotation.
Example: Daily Database Log Rotation
These parameters create 7 rotating database log files: one for each day of the week . (File
names are "postgresql-Mon.log" for Monday, etc.)
Each day (1440 minutes) either creates a file with that day's name (if none exists) or overwrites
that day's log file from the previous weekly cycle.
During heavy load, logging can temporarily exceed disk space quota because the file size limit
is disabled. However the number and names of files does not change.
log_collector = on
log_filename = 'postgresql-%a.log'
log_rotation_age = 1440
log_rotation_size = 0
log_truncate_on_rotation = on
Lock management
Increase deadlock_timeout to exceed your deployment's normal transaction time.
Each time a query waits for a lock for more than deadlock_timeout, PostgreSQL checks for a
deadlock condition and (if configured) logs an error. On larger deployments during heavy load,
however, it's often normal (not an error) to wait for more than 1 second. Logging these normal
events decreases performance.
Maximum concurrent connections
Increase to max_connections = 500.
1203
Trend Micro Deep Security On-Premise 20
Effective cache size
Consider increasing effective_cache_size. This setting is used to estimate cache effects by
a query. It only affects cost estimates during query planning, and doesn't cause more RAM
usage.
Shared buffers
Increase shared_buffers to 25% of the RAM. This setting specifies how much memory
PostgreSQL can use to cache data, which improves performance.
Work memory and maintenance work memory
Increase work_mem. This setting specifies the amount of RAM that can be used by internal sort
operations and hash tables before writing to temporary disk files. More memory is required when
running complex queries.
Consider increasing maintenance_work_mem. This setting determines the maximum amount of
memory used for maintenance operations such as ALTER TABLE.
Checkpoints
Reduce checkpoint frequency. Checkpoints usually cause most writes to data files. To optimize
performance, most checkpoints should be "timed" (triggered by checkpoint_timeout), not
"requested" (triggered by filling all the available WAL segments or by an explicit CHECKPOINT
command).
Parameter name Recommended value
checkpoint_timeout 15min
checkpoint_completion_target 0.9
max_wal_size 16GB
Write-ahead log (WAL)
If you use database replication, consider using wal_level = replica.
1204
Trend Micro Deep Security On-Premise 20
Autovacuum settings
PostgreSQL requires periodic maintenance called "vacuuming". Usually, you don't need to
change the default value for autovacuum_max_workers.
On the entitys and attribute2s tables, if frequent writes cause many rows to change often
(such as in large deployments with short-lived cloud instances), then autovacuum should run
more frequently to minimize disk space usage and maintain performance. Parameters must be
set on both the overall database and those specific tables.
Database-level parameter name Recommended value
autovacuum_work_mem 1GB
Table-level parameter name Recommended value
autovacuum_vacuum_cost_delay 10
autovacuum_vacuum_scale_factor 0.01
autovacuum_analyze_scale_factor 0.005
To change the database-level setting, you must edit the configuration file or database parameter
group, and then reboot the database server. Commands cannot change that setting while the
database is running.
To change the table-level settings, you can either edit the configuration file or database
parameter group, or enter these commands:
ALTER TABLE public.entitys SET (autovacuum_enabled = true, autovacuum_
vacuum_cost_delay = 10, autovacuum_vacuum_scale_factor = 0.01, autovacuum_
analyze_scale_factor = 0.005);
ALTER TABLE public.attribute2s SET (autovacuum_enabled = true, autovacuum_
vacuum_cost_delay = 10, autovacuum_vacuum_scale_factor = 0.01, autovacuum_
analyze_scale_factor = 0.005);
1205
Trend Micro Deep Security On-Premise 20
PostgreSQL on Linux
Transparent huge pages
Transparent huge pages (THP) is a Linux memory management system that reduces the
overhead of translation lookaside buffer (TLB) lookups on computers with large amounts of RAM
by using larger memory pages. By default, THP is enabled, but it isn't recommended for
PostgreSQL database servers. To disable it, see your OS vendor's documentation.
Host-based authentication
Host-based authentication (HBA) can prevent unauthorized access to the database from other
computers that aren't in the allowed IP address range. By default, Linux doesn't have HBA
restrictions for databases. However it's usually better to use a security group or firewall instead.
Maintain Microsoft SQL Server Express
Follow these database maintenance recommendations:
l Remove any unneeded agent software packages from the Deep Security Manager to save
disk space in the database.
l Security updates and events require additional space in the database. Monitor your
deployment to ensure that you stay within the Express database size limit. For information
on database pruning, see "Log and event storage best practices" on page 829. You may
also choose to use the SQL Server settings described in Considerations for the "autogrow"
and "autoshrink" settings in SQL Server.
Migrate Microsoft SQL Server Express to Enterprise
Microsoft SQL Server Express is supported in very limited deployments (see "Microsoft SQL
Server Express considerations" on page 204 for details). If you are using a Microsoft SQL Server
Express database but find its limitations too constricting, you can migrate it to Microsoft
SQL Server Enterprise edition, or another supported database.
To migrate to Enterprise:
1206
Trend Micro Deep Security On-Premise 20
1. Stop the Deep Security Manager service so that it stops writing to the database.
Deep Security Agents will continue to apply their current protection policies while the
manager is stopped. Events will be kept and transmitted when Deep Security Manager
returns online.
2. Back up the database(s).
3. Back up the database connection settings file:
[Deep Security install directory]/webclient/webapps/ROOT/WEB-
INF/dsm.properties
4. Move the database to the new database engine. Restore the backup.
5. Edit dsm.properties to connect to the migrated database:
database.SqlServer.user
database.name
database.SqlServer.instance
database.SqlServer.password
database.type
database.SqlServer.server
If using the default instance, you can delete the database.SqlServer.instance setting.
You can enter a plain text password for database.SqlServer.password; Deep Security
Manager will encrypt it when the service starts, like this:
database.SqlServer.password=!CRYPT!20DE3D96312D6803A53C0D1C691FE6DEB7
476104C0A
6. Restart the Deep Security Manager service.
7. To verify that it has successfully reconnected to the database, log in to Deep Security
Manager.
Existing protected computers and event logs should appear. As new events such as
administrator logins or policy changes occur, they should be added. If not, verify that you
have granted permissions to the database user account on the new database server.
1207
Trend Micro Deep Security On-Premise 20
Back up and restore your database
Separate from high availability or load balancing, best practices include regular database
backups and a disaster recovery plan. Backups can be used to restore the database if there is a
serious failure.
Back up your database
Consult your database vendor's documentation for instructions on how to back up your
database.
Tip: For RDS, follow the instructions provided by AWS for backing up your database to an S3
bucket. For example, see Amazon RDS for SQL Server - Support for Native Backup/Restore to
Amazon S3.
Tip: For PostgreSQL databases, basic tools like pg_dump or pg_basebackup are not suitable
to back up and restore in an enterprise environment. Consider other tools such as Barman.
Restore the database only
1. Stop the Deep Security Manager service.
2. Restore the database.
This must be a database from the same version number of the Deep Security Manager.
3. Start the Deep Security Manager service.
4. Verify contents restored.
5. Update all of the computers to ensure they have the proper configuration.
Restore both the Deep Security Manager and the database
1. Remove any remnants of the lost or corrupted Deep Security Manager and database.
2. Install a fresh Deep Security Manager using a fresh or empty database.
3. Stop the Deep Security Manager service.
4. Restore the database over the freshly installed one, must be the same database name
(Must be a database from the same version number of the Manager).
5. Start the Deep Security Manager service.
6. Verify contents restored.
7. Update all of the computers to ensure they have the proper configuration.
1208
Trend Micro Deep Security On-Premise 20
Export objects in XML or CSV format
l Events: Go to one of the Events pages and use the Advanced Search options to filter the
event data. For example, you could search for all firewall events for computers in the
Computers > Laptops computer group that were logged within the last hour whose reason
column contains the word spoofed.
Click the submit button (with the right-facing arrow) to execute the "query". Then
clickExport to export the filtered data in CSV format. You can export all the displayed
entries or just selected data. The exporting of logs in this format is primarily for integration
with third-party reporting tools.
l Computer Lists: Computers lists can be exported in XML or CSV format from the
Computers page. You might want to do this if you find you are managing too many
computers from a single Deep Security Manager and are planning to set up a second
Deep Security Manager to manage a collection of computers. Exporting a list of selected
computers will save you the trouble of rediscovering all of the computers again and
arranging them into groups.
Note: Policy, firewall rule, and intrusion prevention rule settings will not be included.
You will have to export your firewall rules, intrusion prevention rules, firewall stateful
configurations, and policies as well and then reapply them to your computers.
l Policies: To export these in XML format, go to Policies.
Note: When you export a selected policy to XML, any child policies the policy might
have are included in the exported package. The export package contains all of the actual
objects associated with the policy except: intrusion prevention rules, log inspection rules,
integrity monitoring rules, and application types.
1209
Trend Micro Deep Security On-Premise 20
l Firewall Rules: Firewall rules can be exported to an XML or CSV file using the same
searching and filtering techniques as above.
l Firewall Stateful Configurations: Firewall stateful configurations can be exported to an
XML or CSV file using the same searching and filtering techniques as above.
l Intrusion Prevention Rules: Intrusion prevention rules can be exported to an XML or CSV
file using the same searching and filtering techniques as above.
l Integrity Monitoring Rules: Integrity monitoring rules can be exported to an XML or CSV
file using the same searching and filtering techniques as above.
l Log Inspection Rules: Log inspection rules can be exported to an XML or CSV file using
the same searching and filtering techniques as above.
l Other Common Objects : All the reusable components common objects can be exported
to an XML or CSV file the same way.
When exporting to CSV, only displayed column data is included. Use the Columns tool to
change which data is displayed. Grouping is ignored so the data might not be in same order as
on the screen.
Import objects
To import each of the individual objects into Deep Security, next to New in the object page's
toolbar, select Import From File .
Navigate and customize Deep Security Manager
Customize the dashboard
The dashboard is the first page that appears after you log into Deep Security Manager.
Each user can customize the contents and layout of their dashboard. Deep Security Manager
automatically saves your settings, and will remember your dashboard the next time that you log
in. You can also configure the data's time period, and which computer's or computer group's data
is displayed.
1210
Trend Micro Deep Security On-Premise 20
Date and time range
The dashboard can display data from either the last 24 hours, or the last seven days.
Computers and computer groups
Use the Computer menu to filter the displayed data to display only data from specific computers.
For example, only those using the Linux Server security policy:
1211
Trend Micro Deep Security On-Premise 20
Filter by tags
In Deep Security, a Tag is a unit of meta-data that you can apply to an Event in order to create an
additional attribute for the Event that is not originally contained within the Event itself. Tags can
be used to filter Events in order to simplify the task of Event monitoring and management. A
typical use of tagging is to distinguish between Events that require action and those that have
been investigated and found to be benign.
The data displayed in the Dashboard can be filtered by tags:
1212
Trend Micro Deep Security On-Premise 20
For more information on tagging see "Apply tags to identify and group events" on page 836.
Select dashboard widgets
Click Add/Remove Widgets to display the widget selection window and choose which widgets
to display.
Note: If widgets take up extra space on the dashboard (more than 1x1), their dimensions are
listed next to their names.
The following widgets are available:
Monitoring:
l Activity Overview: Overview of activity, including the number of protected hours and size of
database.
l Alert History [2x1]: Displays recent alert history, including the severity of alerts.
1213
Trend Micro Deep Security On-Premise 20
l Alert Status: Summary of alerts, including their age and severity.
l Computer Status: Summary of computers, including whether they are managed or
unmanaged, and if there are any warnings or critical alerts.
l Manager Node Status [3x1]: Displays the name, CPU usage, memory, jobs, and system
events on the manager node.
l Security Update Status: Displays the update status of computers, including the number of
computers that are up-to-date, out-of-date, and unknown.
l Tenant Database Usage: Displays the top five tenants ranked by their database size.
l Tenant Job Activity: Displays the top five tenants ranked by their total number of jobs.
l Tenant Protection Activity: Displays the top five tenants ranked by the hours they've been
protected.
l Tenant Security Event Activity: Displays the top five tenants ranked by their total number
of security events.
l Tenant Sign-In Activity: Displays the top five tenants ranked by their sign-in activity.
l Tenant System Event Activity: Displays the top five tenants ranked by their total number of
system events.
l Tenants: Displays tenant information, including the number of tenants and the amount of
hours they've been protected.
System:
l My Sign-in History: Displays the last 50 sign-in attempts and whether or not they were
successful.
l My User Summary [2x1]: Displays a summary of the user, including name, role, and sign-
in information.
l Software Updates: Displays out-of-date computers.
l System Event History [2x1]: Displays recent system event history, including the number of
events that are categorized as info, warning, or error.
Ransomware:
l Ransomware Event History [3x1]: Displays recent ransomware event history, including
the event type.
l Ransomware Status: Displays the status of ransomware, including the number of
ransomware events that occurred in the last 24 hours, the last 7 days, or the last 13 weeks.
1214
Trend Micro Deep Security On-Premise 20
Anti-Malware:
l Anti-Malware Event History [2x1]: Displays recent Anti-Malware event history, including
the action taken for the events.
l Anti-Malware Protection Status: Displays a summary of Anti-Malware Protection status on
computers, including whether they are protected, unprotected, or not capable of being
protected.
l Anti-Malware Status (Computers) [2x1]: Displays the top five infected computers,
including the amount of uncleanable files and the total number of files affected.
l Anti-Malware Status (Malware) [2x1]: Displays the top five detected malware, including
their name, amount of uncleanable files, and number of times it was triggered.
l Malware scan Status [2x1]: Displays the top five appliances with incomplete scheduled
malware scans.
Web Reputation:
l Web Reputation Computer Activity: Displays the top five computers with Web Reputation
events, including the number of events.
l Web Reputation Event History [2x1]: Displays recent Web Reputation event history,
including the events severity.
l Web Reputation URL Activity: Displays the top five URLs that triggered Web Reputation
events, including the number of times they were accessed.
Firewall:
l Firewall Activity (Detected): Displays the top five reasons packets were detected,
including the number of times.
l Firewall Activity (Prevented): Displays the top five reasons packets were prevented,
including the number of times.
l Firewall Computer Activity (Detected): Displays the top five computers that generated
detected Firewall events and the number of times they occurred.
l Firewall Computer Activity (Prevented): Displays the top five computers that generated
prevented Firewall events and the number of times they occurred.
l Firewall Event History [2x1]: Displays recent Firewall event history, including if the events
were detected or prevented.
1215
Trend Micro Deep Security On-Premise 20
l Firewall IP Activity (Detected): Displays the top five source IPs that generated detected
Firewall events and the number of times they occurred.
l Firewall IP Activity (Prevented): Displays the top five source IPs that generated prevented
Firewall events and the number of times they occurred.
l Firewall Port Activity (Detected): Displays the top five destination ports for detected
Firewall events and the number of times they occurred.
l Firewall Port Activity (Prevented): Displays the top five computers that generated
prevented Firewall events and the number of times they occurred.
l Reconnaissance Scan Activity: Displays the top five detected reconnaissance scans,
including the number of times they occurred.
l Reconnaissance Scan Computers: Displays the top five computers where reconnaissance
scans occurred and the number of times they occurred.
l Reconnaissance Scan History [2x1]: Displays recent reconnaissance scan history,
including the type of scan that occurred.
Intrusion Prevention:
l Application Type Activity (Detected): Displays the top five detected application types,
including the number of times they were triggered.
l Application Type Activity (Prevented): Displays the top five prevented application types,
including the number of times they were triggered.
l Application Type Treemap (Detected) [2x2]: Displays a map of detected application
types. Hover over the boxes to display the severity of the events, the number of times it was
triggered, and the percentage for each severity level.
l Application Type Treemap (Prevented) [2x2]: Displays a map of prevented application
types. Hover over the boxes to display the severity of the events, the number of times it was
triggered, and the percentage for each severity level.
l IPS Activity (Detected): Displays the top five reasons Intrusion Prevention events were
detected, including the number of times it was triggered.
l IPS Activity (Prevented): Displays the top five reasons Intrusion Prevention events were
prevented, including the number of times it was triggered.
l IPS Computer Activity (Detected): Displays the top five computers with detected Intrusion
Prevention events.
l IPS Computer Activity (Prevented): Displays the top five computers with prevented
Intrusion Prevention events.
1216
Trend Micro Deep Security On-Premise 20
l IPS Event History [2x1]: Displays recent Intrusion Prevention event history, including if the
events were detected or prevented.
l IPS IP Activity (Detected): Displays the top five source IPs that generated detected
Intrusion Prevention events.
l IPS IP Activity (Prevented): Displays the top five source IPs that generated prevented
Intrusion Prevention events.
l Latest IPS Activity (Detected): Displays the top five reasons Intrusion Prevention events
were detected since the latest update.
l Latest IPS Activity (Prevented): Displays the top five reasons Intrusion Prevention events
were prevented since the latest update.
Integrity Monitoring:
l Integrity Monitoring Activity: Displays the top five reasons Integrity Monitoring events
occurred, including the number of times. In this case, the reason refers to the rule that was
triggered.
l Integrity Monitoring Computer Activity: Displays the top five computers where Integrity
Monitoring events occurred, including the number of events.
l Integrity Monitoring Event History [2x1]: Displays recent Integrity Monitoring event history,
including the severity of events.
l Integrity Monitoring Key Activity: Displays the top five keys for Integrity Monitoring events.
The source of the key varies by Entity Set - for files and directories it's their path, whereas
for ports it's their unique protocol, IP, port number, or tuple.
Log Inspection:
l Log Inspection Activity: Displays the top five reasons Integrity Monitoring events occurred,
including the number. In this case, the reason refers to the rule that was triggered.
l Log Inspection Computer Activity: Displays the top five computers where Log Inspection
events occurred, including the number of events.
l Log Inspection Description Activity: Displays the top five descriptions for Log Inspection
events, including the number of times they occurred. The description refers to the event
that was triggered.
l Log Inspection Event History [2x1]: Displays recent Log Inspection event history,
including the severity of events.
1217
Trend Micro Deep Security On-Premise 20
Application Control:
l Application Control Maintenance Mode Status [2x1]: Displays the computers in
maintenance mode, including their start and end time.
Change the layout
The selected widgets can be moved around the dashboard by dragging them by their title bar.
Move the widget over an existing one and they will exchange places. (The widget that is about to
be displaced will temporarily gray out.)
1218
Trend Micro Deep Security On-Premise 20
Save and manage dashboard layouts
You can create multiple dashboard layouts and save them as separate tabs. Your Dashboard
settings and layouts will not be visible to other Users after you sign out. To create a new
Dashboard tab, click the "plus" symbol to the right of the last tab on the Dashboard:
Group computers dynamically with smart folders
A smart folder is a dynamic group of computers that you define with a saved search query. It
finds matching computers each time you click the group. For example, if you want to view your
computers grouped by attributes such as operating system or AWS project tags, you can do this
using smart folders.
Tip: If you prefer to search for resources programmatically, you can automate resource
searches using the Deep Security API. For examples, see the Search for Resources guide in
the Deep Security Automation Center.
You create smart folders by defining:
1. What to search (1 - computer properties)
2. How to determine a match (2 - operator)
1219
Trend Micro Deep Security On-Premise 20
3. What to search for (3 - value)
Create a smart folder
1. Go to Computers > Smart Folders.
2. Click Create a Smart Folder.
A default, empty search criteria group ("rule group") appears. You must configure this first.
If you need to define more or alternative possible matches, you can add more rule groups
later.
3. Type a name for your smart folder.
4. In the first drop-down list, select a property that all matching computers have, such as
Operating System. (See "Searchable Properties" on page 1224.)
If you selected AWS Tag or GCP Label, also type the tag's name or label key.
5. Select the operator: whether to match identical, similar, or opposite computers, such as
CONTAINS.
Note: Some operators are not available for all properties.
6. Type all or part of the search term.
Note: Wild card characters are not supported.
1220
Trend Micro Deep Security On-Premise 20
Tip: If you enter multiple words, it compares the entire phrase - not each word
separately. No match occurs if the property's value has words in a different order, or only
some of the words.
To match any of the words, instead click Add Rule and OR, and then add another
value: one word per rule.
7. If computers must match multiple properties, click Add Rule and AND. Repeat steps 4-6.
For more complex smart folders, you can chain multiple search criteria. Click Add Group,
then click AND or OR. Repeat steps 4-7.
For example, you might have Linux computers deployed both on-premises and in clouds
such as AWS or vCloud. You could create a smart folder that contains all of them by using
3 rule groups based on:
a. local physical computers' operating system
b. AWS tag
c. vCenter or vCloud name
Tip: To test the results of your query before saving your smart folder, click Preview.
8. Click Save.
1221
Trend Micro Deep Security On-Premise 20
9. To verify, click your new smart folder. Verify that it contains all expected computers.
Tip: For faster smart folders, remove unnecessary AND operations, and reduce sub-
folder depths. They increase query complexity, which reduces performance.
Also verify that it omits computers that shouldn't match the query. If you need to edit your
smart folder's query, double-click the smart folder.
Note: If your account's role doesn't have the permissions, some computers won't appear,
or you won't be able to edit their properties. For more information, see "Define roles for
users" on page 1166.
Edit a smart folder
If you need to edit your smart folder's query, double-click the smart folder.
To reorder search criteria rules or rule groups, move your cursor onto a rule or group until it
changes to a , then drag it to its destination.
Clone a smart folder
To duplicate and modify an existing smart folder as a template for a new smart folder, right-click
the original smart folder, then select Copy Smart Folder.
Focus your search using sub-folders
You can use sub-folders to filter a smart folder's search results.
Smart folders can be nested up to 10 levels deep.
l Smart folder 1
l Sub-folder 2
l Sub-folder 3 ...
For example, you might have a smart folder for all your Windows computers, but want to focus on
computers that are specifically Windows 7, and maybe specifically either 32-bit or 64-bit. To do
this, under the "Windows" parent folder, you could create a child smart folder for Windows 7.
Then, under the "Windows 7" folder, you would create two child smart folders: 32-bit and 64-bit.
1222
Trend Micro Deep Security On-Premise 20
1. Right-click a smart folder and select Create Child Smart Folder.
2. Edit your child smart folder's query groups or rules. Click Save.
3. Click your new smart folder. Verify that it contains all expected computers. Also verify that it
omits computers that shouldn't match the query.
Automatically create sub-folders
Note: Applies to AWS and GCP computers only.
Instead of manually creating child folders, you can automatically create sub-folders for each
value of an AWS tag or GCP label that's assigned to an Amazon EC2 instance, GCP VM
instance, or Amazon Workspace. For information on how to apply AWS tags and GCP labels to
your computers, see Tagging Your Amazon EC2 Resources and Labelling Resources for GCP
resources.
Note: AWS tag-based sub-folders or GCP label-based sub-folders will replace any existing
manually created child folders under the parent folder.
1. In Deep Security Manager, right-click a smart folder and select Smart Folder Properties.
2. In the main pane, near the bottom, select the Automatically create sub-folders for each
value of a specific tag or label key check box.
3. Select either the AWS or GCP cloud vendor.
4. Type the name of the AWS tag or GCP label key. Sub-folders are automatically created for
each of the tag or label values.
5. Click Save.
Tip: Empty sub-folders can appear if an AWS tag or GCP label value is not being used
anymore. To remove them, right-click the smart folder and select Synchronize Smart Folder.
1223
Trend Micro Deep Security On-Premise 20
Searchable Properties
Properties are an attribute that some or all computers you want to find have. Smart folders show
computers that have the selected property, and its value matches.
Note: Type your search exactly as that property appears in Deep Security Manager- not, for
example, vCenter/AWS/Azure/GCP. Otherwise your smart folder query won't match.
To find the exact matching text, (unless otherwise noted) go to Computers and look in the
navigation pane on the left.
General
Property Description Data type Examples
The computer's host name, as seen on
Hostname string ca-staging-web1
Computers > Details in Hostname.
The computer's display name in Deep
Computer
Security (if any), as seen on string nginxTest
Display Name
Computers > Details in Display Name.
Folder Name The computer's assigned group. string US-East
Microsoft
The computer's operating system, as Windows 7 (64
Operating
seen on Computers > Details in string bit) Service
System
Platform. Pack 1 Build
7601
The computer's IP address.
You can find the IP address in Deep
Security Manager. To find the IP of:
IPv4 or
l an AWS instance, GCP VM or IPv6 172.20.1.5-
address, 172.20.1.55
IP Address Azure VM, that was added to or an
Deep Security through Add > Add IPv4 2001:db8:face::5
AWS|Azure|GCP Account, go the range
computer's details page, and
under the General tab, scroll to
the Virtual machine Summary
1224
Trend Micro Deep Security On-Premise 20
Property Description Data type Examples
section. The AWS IP addresses
are listed in these fields:
l Private IP Address
l Public IP (PIP) Address
Note: If you added the AWS,
GCP, or Azure computer
through Add > Add Computers,
its IP address is located in the
same place as a physical
computer's.
l a physical computer, go to the
computer's details page and on
the left, click Interfaces
Note: If "DHCP" is displayed
instead of a static IP address, it
won't match the smart folder
query.
l a vCenter or vCloud VM, go to the
vCenter computer's details page,
and under the General tab, scroll
to the Virtual machine Summary
section. The vCenter or vCloud
IP address is listed in the
IP Address field.
string
The computer's assigned Deep (option
Policy Security policy, as seen on in drop- Base Policy
Computers > Details.
down
list)
1225
Trend Micro Deep Security On-Premise 20
Property Description Data type Examples
Whether or not the computer has been
Activated activated with Deep Security Manager, Boolean Yes
as seen on Computers > Details.
Whether or not Docker is installed on
Docker Host the computer, as seen on Computers > Boolean No
Details.
The type of computer. Options string Examples:
are: Physical Computer, Amazon EC2 (option Physical
Computer Type Instance, Amazon WorkSpace, vCenter in drop- Computer,
VM, Azure Instance, Azure ARM down Amazon EC2
Instance, GCP VM Instance. list) Instance
Date
operator
Whether or not the computer has had a
drop-
successful recommendation scan within
down
a specified time period. The last
Last Successful list,
recommendation scan date and results OLDER THAN,
Recommendation String,
can be seen on Computers > Details > 7, DAYS
Scan Date
General > Intrusion Prevention or
unit
Integrity Monitoring or Log Inspection
drop-
> Recommendations.
down
list
Date
operator
Whether or not the agent has drop-
communicated with Deep Security down
Manager within a specified time period. list,
Last Agent OLDER THAN,
String,
Communication The Last Communication date can be 3, DAYS
Date
seen on Computers > Details > unit
General > Last Communication. drop-
down
list
Whether or not the agent is offline. This
is displayed as Managed (Offline) or
Agent Offline Boolean Yes
Offline on Computers > Details >
General > Last Communication.
Task(s) State of the computer's tasks, as string Activating
1226
Trend Micro Deep Security On-Premise 20
Property Description Data type Examples
displayed in the Task(s) column on the
Computers page. For a list of all
possible tasks, see "Computer and
agent statuses" on page 1100.
Host Created Date when the computer was added to string
2019-03-15
Date Deep Security Manager. (date)
Version Deep Security Agent version. string 12.0.0.1
AWS
Data
Property Description Examples
type
The computer's AWS tag key:value pair, as seen on
Computers > Details > Overview > General under Tag Key: env
Tag Virtual machine Summary, in Cloud Instance string Tag
Metadata.
Value: staging
Type the tag name, then its value. Case-sensitive.
The computer's associated AWS security group
Security
name, as seen on Computers > Details >
Group string SecGrp1
Overview > General under Virtual machine
Name
Summary, in Security Group(s).
The computer's AWS security group ID, as seen on
Security
Computers > Details > Overview > General under string sg-12345678
Group ID
Virtual machine Summary, in Security Group(s).
The computer's Amazon Machine AMI ID, as seen on
AMI ID Computers > Details > Overview > General under string ami-23c44a56
Virtual machine Summary, in AMI ID.
The computer's associated 12-digit AWS Account ID,
Account as seen on Computers when you right-click Amazon
Account and select Properties. string 123456789012
ID
Results include computers in sub-folders.
1227
Trend Micro Deep Security On-Premise 20
Data
Property Description Examples
type
The computer's associated AWS Account Alias, as
Account seen on Computers when you right-click the AWS MyAccount-
Name Cloud Connector and select Properties. string 123
Results include computers in sub-folders.
Region The computer's AWS region suffix.
string us-east-1
ID
Results include computers in sub-folders.
Region The computer's associated AWS region name.
string US East (Ohio)
Name
Results include computers in sub-folders.
The computer's Virtual Private Cloud (VPC) ID.
If an alias exists, the folder name is the alias,
VPC ID followed by the VPC ID in parentheses. Otherwise string vpc-3005e48a
the folder's name is the VPC ID.
Results include computers in sub-folders.
The computer's associated Virtual Private Cloud
(VPC) subnet ID.
Subnet If an alias exists, the folder name is the alias, subnet-
string
ID followed by the VPC subnet ID in parentheses. b1c2e468
Otherwise the folder's name is the VPC subnet ID.
Results include computers in sub-folders.
The ID of the AWS directory where the user entry
associated with an Amazon WorkSpace resides. The
directory ID is seen on the Computers > Details >
Directory
Virtual machine Summary, in the WorkSpace string d-9367232d89
ID
Directory field. That field takes the format <directory_
alias>(<directory_ID>), for example, myworkspacedir
(d-9367232d89).
1228
Trend Micro Deep Security On-Premise 20
Azure
Data
Property Description Examples
type
Note: As of Deep Security Manager 12.0,
the Subscription Name is no longer
collected. It remains visible in the drop-
down list of properties in case the
information was obtained through a
Subscription previous version of the manager. string MyAzureAccount
Name
The computer's associated Azure
subscription account ID, as seen on
Computers when you right-click Azure and
select Properties.
Results include computers in sub-folders.
Resource
The computer's associated resource group. string MyResourceGroup
Group
GCP
Data
Property Description Examples
type
The computer's GCP label key:value pair, as seen
on Computers > Details > Overview > General
Label Key: env
under Virtual machine Summary, in Cloud
Label Instance Metadata. string Label Value:
staging
Type the label key, and then its value. Case-
sensitive.
The computer's network tag, as seen on
Network Computers > Details > Overview > General under
string production
Tag Virtual machine Summary, in Cloud Instance
Metadata.
1229
Trend Micro Deep Security On-Premise 20
vCenter
Property Description Data type Examples
The computer's associated vCenter.
vCenter - lab13-
Name Results include computers in sub- string vc.example.com
folders.
The computer's associated vCenter
data center.
Datacenter string lab13-datacenter
Results include computers in sub-
folders.
The computer's vCenter folder.
Folder Results include computers in sub- string db_dev
folders.
Parent The hostname of the ESXi hypervisor
lab13-
ESX where the computer's guest VM is string
esx2.example.com
Hostname running, as seen on Computers.
string
The computer's assigned vCenter
Custom custom attribute, as seen on (comma-
separated env, production
Attribute Computers > Details in Virtual
machine Summary. attribute name
and value)
vCloud
Data
Property Description Examples
type
The computer's associated vCloud.
Name string vCloud-lab23
Results include computers in sub-folders.
The computer's associated vCloud data center. lab13-
Datacenter string
datacenter
Results include computers in sub-folders.
1230
Trend Micro Deep Security On-Premise 20
Data
Property Description Examples
type
The computer's associated vCloud data center
vApp folder. string db_dev
Results include computers in sub-folders.
Folder
Data
Property Description Examples
type
The hostname of the Microsoft Active Directory or
LDAP directory.
Name string ad01.example.com
Results include computers in sub-folders.
The computer's Microsoft Active Directory or
Folder LDAP folder name. string Computers
Results include computers in sub-folders.
Operators
Smart folder operators indicate whether matching computers should have a property value that is
identical, similar, or dissimilar to your search term. Not all operators are available for every
property.
Operator Description Example usage
The search query
A search query for 'Windows' in the Operating
only finds computers
EQUALS System property does not find computers with
that are an exact
'Windows 7' or 'Microsoft Windows'.
match.
The search query
A search query for 'Amazon Linux (64 bit)' in the
DOES NOT finds any computers
Operating System property finds all computers other
EQUAL that are not an exact
than Amazon Linux 64-bit machines.
match.
The search query A search query for '203.0.113.' in the IP Address
CONTAINS finds any computers property finds any computers on the 203.0.113.xxx
1231
Trend Micro Deep Security On-Premise 20
Operator Description Example usage
that contain the
subnet.
search term.
The search query
A search query for 'Windows' in the Operating
DOES NOT finds any computers
System property finds any computers that do not
CONTAIN that do not contain
have 'Windows' in their operating system name.
the search term.
The search query
ANY finds all computers A search query in the Group Name property finds all
VALUE with the selected computers in that group.
property.
The search query
A search query in the IP Address property with Start
finds all computers
Range 10.0.0.0 and End Range 10.255.255.255
IN RANGE between the
would find all computers with IP addresses between
specified start and
10.0.0.0 and 10.255.255.255.
end range.
The search query
A search query in the IP Address property with Start
finds all computers
NOT Range 10.0.0.0 and End Range 10.255.255.255
that are not between
IN RANGE finds all computers that have IP addresses outside
the specified start
the range of 10.0.0.0 and 10.255.255.255.
and end range.
The search query
A search query with 'Yes' selected for the Docker
finds all computers
Yes property finds any computers with the Docker
with the selected
service running.
property.
The search query
A search query with 'No' selected for the Docker
finds all computers
No property would find any computers that do not have
that do not have the
the Docker service running.
selected property.
The search query
finds all computers A search query with 'OLDER THAN', '7', 'DAYS' for
prior to the specified the 'Last Successful Recommendation Scan'
OLDER date for the property. property finds computers that have had a successful
THAN
recommendation scan 8 days or longer ago.
Used with an
accompanying
DAYS, WEEKS,
1232
Trend Micro Deep Security On-Premise 20
Operator Description Example usage
HOURS, or
MINUTES operator.
The search query
finds all computers
more recent than the
specified date for the A search query with 'MORE RECENTLY THAN', '1',
MORE property. 'MONTH' for the 'Last Successful Recommendation
RECENTLY Scan' property finds computers that have had a
THAN Used with an successful recommendation scan earlier than 1
accompanying month ago.
DAYS, WEEKS,
HOURS, or
MINUTES operator.
The search query A search query with 'NEVER' for the 'Last
finds all computers Successful Recommendation Scan' property finds
NEVER
that do not match the computers that have never had a successful
property. recommendation scan.
Customize advanced system settings
Several features for advanced users are located on Administration > System Settings >
Advanced.
Tip: You can automate system setting changes using the Deep Security API. For examples,
see the Configure Policy, Computer, and System Settings guide in the Deep Security
Automation Center.
Primary Tenant Access
By default, the primary tenant can access your Deep Security environment.
If the primary tenant enabled the "Primary Tenant Access" settings in your environment,
however, you can prevent the primary tenant from accessing your Deep Security environment, or
grant access for a limited amount of time.
1233
Trend Micro Deep Security On-Premise 20
Load Balancers
Note: The load balancer settings are not available when FIPS mode is enabled. See "FIPS
140-2 support" on page 1417.
Agents are configured with a list of Deep Security Manager and Deep Security Relays. When
multiple managers and relays are deployed without a load balancer, agents will automatically
contact the managers and relays using a round robin sequence.
To better scale your network, you can put a load balancer in front of the managers or relays.
When you configure the load balancer hostname and port numbers, it will override the
IP address or hostname and port numbers currently used by the agents.
The script generator uses the address of the Deep Security Manager that you are connected to.
This ensures that the scripts continue to function even if one of the Deep Security Manager
nodes fails or is down for maintenance or upgrades.
Note: The load balancer must be non-terminating for the SSL or TLS session with the agent's
heartbeat port number because its uses mutual authentication. SSL inspection that terminates
(for example, if you try to use SSL offloading) will break the session.
Multi-tenant Mode
1. Select Enable Multi-Tenant Mode.
2. In the wizard that appears, enter your Multi-Tenant Activation Code and click Next.
3. Select the license mode, either:
l Inherit Licensing from Primary Tenant: All tenants use the same licenses as the
primary tenant.
l Per Tenant Licensing: Tenants themselves enter a license when they log in for the
first time.
4. Click Next.
Deep Security Manager Plug-ins
Plug-ins are modules, reports and other add-ons for the Deep Security Manager. Trend Micro
occasionally produces new or additional versions of these which are distributed as self-installing
packages.
1234
Trend Micro Deep Security On-Premise 20
SOAP Web Service API
Enable or disable the legacy SOAP API Web services. The WSDL (Web Services Description
Language) can be found at the URL displayed in the panel on the page. For more information
about APIs, see "Use the Deep Security API to automate tasks" on page 1376.
Note: To access the Web Services APIs, a user must be assigned a role with the appropriate
access rights. To configure the role, go to Administration > User Management > Roles, open
the role properties, and select Allow Access to web services API.
Status Monitoring API
Enable or disable the Status Monitoring API of the legacy REST API. This API lets you query the
Deep Security Manager (including individual Manager Nodes) for status information such as
CPU and memory usage, number of queued jobs, total and Tenant-specific database size. For
more information about APIs, see "Use the Deep Security API to automate tasks" on page 1376.
Export
Export file character encoding: The character encoding used when you export data files from
the Deep Security Manager. The encoding must support characters in your chosen language.
Exported Diagnostics Package Language: Your support provider may ask you generate and
send them a Deep Security diagnostics package. This setting specifies the language the
package will be in. The diagnostic package is generated on Administration > System
Information.
Whois
Whois can be used to look up which domain name is associated with an IP address when you
review logged intrusion prevention and firewall events. Enter the search URL using "[IP]" as a
placeholder for the IP address to look up.
(For example, "http://reports.internic.net/cgi/whois?whois_nic=[IP]&type=nameserver".)
Licenses
Hide unlicensed Protection Modules for new Users determines whether unlicensed modules
are hidden rather than simply grayed out for subsequently created Users. (This setting can be
1235
Trend Micro Deep Security On-Premise 20
overridden on a per-user basis on Administration > User Management > Users > Properties).
Click View Scan Cache Configurations to display a list of saved Scan Cache Configurations.
Scan Cache Configurations are settings used by the Virtual Appliance to maximize the efficiency
of Anti-Malware and Integrity Scans in a virtualized environment. See "Virtual Appliance Scan
Caching" on page 763 for more information.
CPU Usage During Recommendation Scans
This setting controls the amount of CPU resources dedicated to performing Recommendation
Scans. If you notice that CPU usage is reaching unreasonably high levels, try changing to a
lower setting to remedy the situation. For other performance controls, see Administration >
Manager Nodes > Properties > Performance Profiles.
NSX
If Deep Security is being used to protect virtual machines in a VMware NSX environment and if it
is installed with multiple Deep Security Manager nodes, this setting will determine which Deep
Security Manager node communicates with the NSX Manager. (For more information on
integrating Deep Security with an NSX environment, see "Install Deep Security Manager" on
page 210. For more information on multiple Deep Security Manager Nodes, see "Install Deep
Security Manager on multiple nodes" on page 257.
Logo
You can replace the Deep Security logo that appears on the login page, at the top right of the
Deep Security Manager GUI, and at the top of reports. Your replacement image must be in PNG
format, be 320 px wide and 35 px high, and have a file size smaller than 1 MB. A template is
available in the installfiles directory of the Deep Security Manager.
Click Import Logo to import your own logo, or click Reset Logo to reset the logo to its default
image.
Manager AWS Identity
You can configure cross-account access. Select either:
1236
Trend Micro Deep Security On-Premise 20
l Use Manager Instance Role: The more secure option to configure cross-account access.
Attach a policy with the sts:AssumeRole permission to the Deep Security Manager's
instance role, then select this option. Does not appear if the Deep Security Manager does
not have an instance role, or if you're using an Azure Marketplace or on-premise
installation of Deep Security Manager.
l Use AWS Access Keys: Create the keys and attach a policy with the sts:AssumeRole
permission before you select this option, and then type the Access Key and Secret Key.
Does not appear if you're using an Azure Marketplace or on-premise installation of Deep
Security Manager.
Application control
Each time you create an Application Control ruleset or change it, it must be distributed to all
computers that use it. Shared rulesets are bigger than local rulesets. Shared rulesets are also
often applied to many servers. If they all downloaded the ruleset directly from the manager at the
same time, high load could cause slower performance. Global rulesets have the same
considerations.
Using Deep Security Relays can solve this problem. (For information on configuring relays, see
"Deploy additional relays" on page 1091.)
Steps vary by whether or not you have a multi-tenant deployment.
Single tenant deployments
Go to Administration > System Settings > Advanced and then select Serve Application Control
rulesets from relays.
1237
Trend Micro Deep Security On-Premise 20
Multi-tenant deployments
The primary tenant (t0) can't access other tenants' (tN) configurations, so t0 relays don't have tN
Application Control rulesets. (Other features like IPS don't have this consideration, because their
rules come from Trend Micro, not a tenant.)
Other tenants (Tn) must create their own relay group, then select Serve Application Control
rulesets from relays.
1238
Trend Micro Deep Security On-Premise 20
Warning:
Verify compatibility with your deployment before using relays. If the agent doesn't have any
previously downloaded rulesets currently in effect, and if it doesn't receive new Application
Control rules, then the computer won't be protected by Application Control. If an Application
Control ruleset fails to download, a ruleset download failure event will be recorded on the
manager and on the agent.
Relays might either change performance, break Application Control ruleset downloads, or be
required; it varies by proxy location, multi-tenancy, and global/shared vs. local rulesets.
Faster Slower
Required for... performance performance Don't enable for...
for... for...
Agent >
Proxy >
Manager
Multi-tenant configurations when non-primary
Shared tenants (tN) use the default, primary (t0) relay
Note: In rulesets Local group:
Deep rulesets
Global Agent (tN) > DSR (t0) > DSM (tN)
Security l
ruleset
Agent l Agent (tN) > Proxy > DSR (t0) > DSM (tN)
10.0 GM
1239
Trend Micro Deep Security On-Premise 20
Faster Slower
Required for... performance performance Don't enable for...
for... for...
and
earlier,
agents
didn't
have
support
for
connectio
ns
through a
proxy to
relays. If a
ruleset
download
fails due
to a proxy,
and if
your
agents
require a
proxy to
access
the relay
or
manager
(including
Deep
Security
as a
1240
Trend Micro Deep Security On-Premise 20
Faster Slower
Required for... performance performance Don't enable for...
for... for...
Service),
then you
must
either:
l upd
ate
age
nts'
soft
war
e,
then
conf
igur
e
the
prox
y
l byp
ass
the
prox
y
l add
a
rela
y
and
then
sele
ct
Ser
1241
Trend Micro Deep Security On-Premise 20
Faster Slower
Required for... performance performance Don't enable for...
for... for...
ve
App
licat
ion
Con
trol
rule
sets
fro
m
rela
ys
Harden Deep Security
About Deep Security hardening
There are several measures you can take to increase the security of your Deep Security
deployment.
l "Protect Deep Security Manager with an agent" on the next page
l "Protect Deep Security Agent" on page 1244
l "Replace the Deep Security Manager TLS certificate" on page 1245
l "Update the load balancer's certificate" on page 1250
l "Encrypt communication between the Deep Security Manager and the database" on
page 1252
l "Change the Deep Security Manager database password" on page 1258
l "Configure HTTP security headers" on page 1260
l "Upgrade the Deep Security cryptographic algorithm" on page 1265
l "Enforce user password rules" on page 1267
1242
Trend Micro Deep Security On-Premise 20
l "Set up multi-factor authentication" on page 1269
l "Manage trusted certificates" on page 1273
l "SSL implementation and credential provisioning" on page 1276
Protect Deep Security Manager with an agent
To protect the server where Deep Security Manager is installed, install an agent on it and apply
the Deep Security Manager policy.
1. Install an agent on the same computer as the manager.
2. Go to Computers.
3. Add the manager's computer. Do not choose to apply a policy yet.
4. Double-click the new computer to display its Details window and go to Intrusion
Prevention > Advanced > SSL Configurations.
5. Click New to start the wizard to create a new SSL Configuration.
6. Specify the interface used by the manager. Click Next.
7. On the Port page, select whether to protect the Deep Security Manager GUI's port number.
(See the port number.) Click Next.
8. Specify whether SSL Intrusion Prevention analysis should take place on all IP addresses
for this computer, or just one. (This feature can be used to set up multiple virtual computers
on a single computer.)
9. Select Use the SSL Credentials built into the Deep Security Manager. (This option only
appears when creating an SSL Configuration for the Manager's computer.) Click Next.
10. Finish the wizard and close the SSL Configuration page.
11. Return to the computer's Details window. Apply the Deep Security Manager Policy, which
includes the Firewall Rules and Intrusion Prevention Rules required to protect the Deep
Security Manager's GUI port number.
You have now protected the Manager's computer and are now filtering the traffic (including SSL)
to the Manager.
Note: After configuring the Agent to filter SSL traffic, you may notice that the Deep Security
Agent will return several Renewal Error events. These are certificate renewal errors caused by
the new SSL certificate issued by the Manager computer. To fix this, refresh the web page and
reconnect to the Deep Security Manager's GUI.
The Deep Security Manager Policy has the basic Firewall Rules assigned to enable remote use
of the Manager. Additional Firewall Rules may need to be assigned if the Manager's computer is
1243
Trend Micro Deep Security On-Premise 20
being used for other purposes. The Policy also includes the Intrusion Prevention Rules in the
Web Server Common Application Type. Additional Intrusion Prevention Rules can be assigned
as desired.
Because the Web Server Common Application Type typically filters on the HTTP Port List and
does not include the Deep Security Manager GUI's port number, it is added as an override to the
ports setting in the Intrusion Prevention Rules page of the Policy's Details window. (See "Port
numbers, URLs, and IP addresses" on page 178.)
For more information on SSL data inspection, see "Inspect SSL or TLS traffic" on page 648.
Protect Deep Security Agent
If you have enabled manager-initiated communication (see "Agent-manager communication" on
page 1124), and by extension, manager-initiated activation, you can protect the agent from
unauthorized managers by only allowing it to connect with a specific known, trustedDeep
Security Manager.
Bind Deep Security Agent to a specific Deep Security Manager
During agent-manager communications, Deep Security Agent can authenticate the identity of its
manager. It does this by comparing your trusted manager's certificate to the connecting
manager's certificate. If they don't match, manager authentication fails and the agent won't
connect.
This prevents agents from activating with or connecting to a malicious server that is pretending
to be your Deep Security Manager. This is recommended especially if agents connect through
an untrusted network such as the Internet.
To do this, you must configure each agent with the trusted manager's server certificate so that
they can recognize their authorized manager before they try to connect.
Note: If you reset or deactivate an agent, it deletes the Deep Security Manager certificate.
Repeat these steps if you want to reactivate the agent.
1. On Deep Security Manager, run the command to export its server certificate:
dsm_c -action exportdsmcert -output ds_agent_dsm.crt [-tenantname
TENANTNAME | -tenantid TENANTID]
where:
1244
Trend Micro Deep Security On-Premise 20
l ds_agent_dsm.crt is the name of the manager's server certificate.
Note: You must use this exact file name. You cannot rename it.
l -tenantname TENANTNAME is the name of a Deep Security tenant. If the Deep
Security Manager is multi-tenant, either this or the -tenantid parameter is required.
See also "Set up a multi-tenant environment" on page 229.
l -tenantid TENANTID is the ID of a tenant.
If you have multiple tenants, run the command to export the first tenant's certificate, like
this:
dsm_c -action exportdsmcert -output ds_agent_dsm.crt -tenantname
TENANT1
and then continue to the next step. (Don't run the export command again for TENANT2 and
others until you are finished with the certificate for TENANT1. The command will overwrite
the file.)
2. On each agent's computer, put the ds_agent_dsm.crt file in this folder:
l Windows: %ProgramData%\Trend Micro\ Deep Security Agent\dsa_core
l Linux: /var/opt/ds_agent/dsa_core
If you have multiple tenants, copy each tenant's certificate file only to its own agents.
Agents cannot be activated by other tenants.
3. If you have a multi-tenant Deep Security Manager, repeat the previous 2 steps for each
tenant.
Note: Initially, after completing these steps, the agent enters a 'pre-activated' state. Until the
agent is fully activated, operations initiated by other Deep Security Managers or by entering
commands to the agent via dsa_control do not work. This is intentional. Normal operation
resumes upon activation.
Replace the Deep Security Manager TLS certificate
During installation, Deep Security Manager auto-generates a self-signed TLS certificate for web
console access. You can replace this default certificate with a certificate from a trusted certificate
authority (CA) after the installation is complete.
1245
Trend Micro Deep Security On-Premise 20
Tip: The certificates are maintained when you upgrade Deep Security Manager.
Warning: Replacing the default certificate with an invalid certificate or an incomplete
certificate chain can cause Deep Security Manager to become unreachable. Before replacing
the certificate, carefully read the instructions in this section.
Follow the steps in either Option A or Option B to replace the Deep Security Manager TLS
certificate:
Option A - Request a brand new certificate for the Deep Security Manager domain name
This is the most reliable way to replace the certificate.
1. If you have enabled FIPS mode (see "FIPS 140-2 support" on page 1417), disable FIPS
mode before replacing the certificate and then re-enable FIPS mode when you're finished.
2. "Generate the private key and keystore" below.
3. "Generate a CSR and request a certificate" on page 1248.
4. "Import the signed certificate into the keystore" on page 1248.
5. "Configure Deep Security to use the signed certificate store" on page 1250.
Option B - Use an existing Java Key Store file
This scenario covers situations where the file was backed up from a previous installation or
created for a common domain such as a wildcard certificate.
1. Ensure you have the complete certificate chain. If necessary, consult with the CA that
issued your certificate.
2. If you have enabled FIPS mode (see "FIPS 140-2 support" on page 1417), disable FIPS
mode before replacing the certificate and then re-enable FIPS mode when you're finished.
3. "Configure Deep Security to use the signed certificate store" on page 1250.
Learn about Java Keystores
Java Keystores are used to contain certificates used by Java-based applications. If you're not
familiar with Java Keystores and Keytool, DigitalOcean provides a good explanation of the
concepts in their article, Java Keytool Essentials: Working with Java Keystores.
Generate the private key and keystore
1. On the computer where Deep Security Manager is running, open a command prompt as an
administrator.
1246
Trend Micro Deep Security On-Premise 20
2. Change the directory to:
l Windows:
C:\Program Files\Trend Micro\Deep Security Manager\jre\bin
l Linux:
/opt/dsm/jre/bin
3. Run the following command to generate a private key and a new key store.
l Windows:
keytool -genkey -keyalg RSA -alias tomcat -keystore
C:\Users\Administrator\.keystore -validity 365 -keysize 2048
l Linux:
keytool -genkey -keyalg RSA -alias tomcat -keystore ~/.keystore -
validity 365 -keysize 2048
Enter keystore password:
What is your first and last name?
[Unknown]: <HOSTNAME>
What is the name of your organizational unit?
[Unknown]: <COMPANY_OU>
What is the name of your organization?
[Unknown]: <COMPANY_NAME>
What is the name of your City or Locality?
[Unknown]: <CITY>
What is the name of your State or Province?
[Unknown]: <STATE_IF_APPLIES>
What is the two-letter country code for this unit?
[Unknown]: <COUNTRY_CODE>
Is CN=<HOSTNAME>... correct?
[no]: yes
Enter key password for <tomcat>
(RETURN if same as keystore password):
1247
Trend Micro Deep Security On-Premise 20
Re-enter new password:
4. You will get a warning. Run the following command to export the keystore to PKCS #12
format.
Note: This command creates a second keystore in PKCS #12 format, named
.keystore2, which we will use in the remaining examples.
l Windows:
keytool -importkeystore -srckeystore
C:\Users\Administrator\.keystore -destkeystore
C:\Users\Administrator\.keystore2 -deststoretype pkcs12
l Linux:
keytool -importkeystore -srckeystore ~/.keystore -destkeystore
~/.keystore2 -deststoretype pkcs12
Generate a CSR and request a certificate
Use the command below to generate a certificate signing request (CSR), which is a file that you
can send to a CA to request a signed certificate. In this example, the file is named
<HOSTNAME>.csr:
l Windows:
keytool -keystore C:\Users\Administrator\.keystore2 -certreq -alias
tomcat -keyalg rsa -file <HOSTNAME>.csr
l Linux:
keytool -keystore ~/.keystore2 -certreq -alias tomcat -keyalg rsa -file
<HOSTNAME>.csr
Next, request a signed certificate from the CA of your choice, using the CSR file. When you
receive the signed certificate from the CA, you can continue on to "Import the signed certificate
into the keystore" below.
Import the signed certificate into the keystore
Once you have obtained the signed certificate from the CA, import the certificate reply into the
keystore.
Warning: Certificates are issued in a chain of trust, starting with a root CA and then one or
more intermediate CAs, before getting to your actual signed certificate. You must import all of
1248
Trend Micro Deep Security On-Premise 20
the CA certificates in the correct order. If you aren't sure what you need to import, please
check with the CA that issued your signed certificate.
The examples below assume that the certificates are in .crt format.
1. Use the following command to import the root CA into the keystore. (Skip this step if your
signed certificate was signed with a root CA that is already located in the keystore.)
l Windows:
keytool -import -keystore c:\Users\Administrator\.keystore2 -
storepass <YOUR_PASSWORD> -alias rootCA -file
c:\Users\Administrator\<RootCA>.crt
l Linux:
keytool -import -keystore ~/.keystore2 -storepass <YOUR_PASSWORD> -
alias rootCA -file ~/<RootCA>.crt
2. Your signed certificate may have been signed by one or more intermediate CAs. If all
intermediate CAs are in the keystore, you can skip this step. Otherwise, use the following
command to import each missing intermediate CA into the keystore.
l Windows:
keytool -import -keystore c:\Users\Administrator\.keystore2 -
storepass <YOUR_PASSWORD> -trustcacerts -alias intermediateCA -file
c:\Users\Administrator\<IntermediateCA>.crt
l Linux:
keytool -import -keystore ~/.keystore2 -storepass <YOUR_PASSWORD> -
trustcacerts -alias intermediateCA -file ~/<IntermediateCA>.crt
3. Finally, use the following command to import your signed certificate into the keystore.
l Windows:
keytool -import -keystore c:\Users\Administrator\.keystore2 -
storepass <YOUR_PASSWORD> -trustcacerts -alias tomcat -file
c:\Users\Administrator\<HOSTNAME>.crt
l Linux:
keytool -import -keystore ~/.keystore2 -storepass <YOUR_PASSWORD> -
trustcacerts -alias tomcat -file ~/<HOSTNAME>.crt
If the import was successful, you will see this message:
Certificate reply was installed in keystore
1249
Trend Micro Deep Security On-Premise 20
Configure Deep Security to use the signed certificate store
The examples below assume that the new keystore is named .keystore2.
1. Back up the (Windows) C:\Program Files\Trend Micro\Deep Security
Manager\configuration.properties or (Linux)
/opt/dsm/configuration.properties file.
2. Back up the old keystore file:
l Windows:
copy "C:\Program Files\Trend Micro\Deep Security Manager\.keystore"
"C:\Program Files\Trend Micro\Deep Security Manager\.keystore.bak"
l Linux:
cp /opt/dsm/.keystore /opt/dsm/.keystore.bak
3. Replace the old keystore file with the new file:
l Windows:
copy "c:\Users\Administrator\.keystore2" "C:\Program Files\Trend
Micro\Deep Security Manager\.keystore"
l Linux:
cp ~/.keystore2 /opt/dsm/.keystore
Note: You must replace the default keystore file. If you choose to change the path in the
configuration file instead, the configuration file will reset to the default location the next
time you upgrade Deep Security Manager, which will undo the change.
4. Update the keystore password in (Windows) C:\Program Files\Trend Micro\Deep
Security Manager\configuration.properties or (Linux)
/opt/dsm/configuration.properties as follows:
...<OTHER_SETTINGS>
keystorePass=<YOUR_PASSWORD>
5. Restart the Deep Security Manager service.
Update the load balancer's certificate
Usually, your browser should warn you with a certificate validation error whenever you try to
connect to a server with a self-signed certificate. This is because with any self-signed certificate,
the browser cannot automatically validate the certificate's signature with a trusted third party
certificate authority (CA), and therefore the browser doesn't know if the certificate was sent by an
1250
Trend Micro Deep Security On-Premise 20
attacker or not. When installed, Deep Security Manager is initially configured to use a self-
signed certificate for HTTPS connections (SSL or TLS), so you must manually verify that the
server certificate fingerprint used to secure the connection belongs to your Deep Security server.
This is normal until you replace the self-signed certificate with a CA-signed certificate.
The same error will occur if you have an AWS Elastic Load Balancer (ELB) or other load
balancer, and it presents a self-signed certificate to the browser.
You can still access Deep Security Manager if you ignore the warning and proceed (method
varies by browser). However, this error will occur again each time you connect, unless you
either:
1251
Trend Micro Deep Security On-Premise 20
l add the certificate to your computer's store of trusted certificates (not recommended) or
l replace the load balancer's certificate with one signed by a trusted CA (strongly
recommended)
1. With a CA that is trusted by all HTTPS clients, register the fully qualified domain name (not
IP address) that administrators, relays, and agents will use to connect to Deep Security
Manager.
Specify the sub-domain (for example, deepsecurity.example.com) that will uniquely identify
Deep Security Manager. For nodes behind an SSL terminator load balancer, this certificate
will be presented to browsers and other HTTPS clients by the load balancer, not by each
Deep Security Manager node.
When the CA signs the certificate, download both the certificate (with public key) and the
private key.
Warning: Store and transmit the private key securely. If file permissions or unencrypted
connections allow a third party to access your private key, then all connections secured
by that certificate and key are compromised. You must revoke that certificate, remove the
key, and get a new certificate and key.
2. Add the certificate to your certificate store (optional if your computer trusts the CA that
signed the certificate).
3. Update the DNS settings of the load balancer to use the new domain name.
4. Replace the SSL certificate of the load balancer.
Encrypt communication between the Deep Security Manager
and the database
Communication between the Deep Security Manager and the database is not encrypted by
default. This is for performance reasons and because the channel between the manager and the
database may already be secure (either they are running on the same computer or they are
connected by crossover cable, a private network segment, or tunneling via IPSec).
However, if the communication channel between the Deep Security Manager and the database
is not secure, you should encrypt the communications between them. In the current design,
Deep Security Manager attempts to build an encrypted connection with the database server. If it
fails, Deep Security Manager uses an unencrypted connection with the database server instead.
1252
Trend Micro Deep Security On-Premise 20
The related mechanisms are built into the database library that Deep Security Manager is based
on, therefore the server certificate does not need to be imported nor the configuration file
updated.
The instructions vary depending on the database you are using:
l "Microsoft SQL Server database" below
l "Oracle database" on the next page
l "PostgreSQL" on page 1255
Note: If you are running the Deep Security Manager in multi-node mode, these changes must
be made on each node.
This section also provides information on "Running an agent on the database server" on
page 1255how to "Disable encryption between the manager and database" on page 1256, and
how to "Upgrade from an old Deep Security Manager version" on page 1257.
Encrypt communication between the manager and database
Microsoft SQL Server database
If you have not already installed Deep Security Manager 20:
1. Follow the instructions in Enable encrypted connections to the Database Engine on the
Microsoft MSDN site and enable encrypted connection options on Microsoft SQL Server.
2. "Install Deep Security Manager" on page 210.
1253
Trend Micro Deep Security On-Premise 20
By default, the communication between Deep Security Manager 20 and Microsoft SQL Server is
encrypted.
If you have already installed Deep Security Manager 20 and you haven't enabled encryption
options on your Microsoft SQL Server:
1. Stop Deep Security Manager 20.
2. Follow the instructions in Enable encrypted connections to the Database Engine on the
Microsoft MSDN site and enable encrypted connection options on Microsoft SQL Server.
3. "Restart the Deep Security Manager" on page 1345.
By default, the communication between Deep Security Manager 20 and Microsoft SQL Server is
encrypted.
Note: You can use SQL Server Manager Studio to connect your Microsoft SQL Server. Use
the command select client_net_address,connect_time,net_transport,protocol_
type,encrypt_option from sys.dm_exec_connections to see if your Deep Security
Manager encrypted connection is working or not.
Oracle database
If you have not already installed Deep Security Manager 20:
1. Follow the instructions How To Configure Data Encryption and Integrity on the Oracle Help
Center, and enable encrypted connection options on Oracle Database Server side.
2. "Install Deep Security Manager" on page 210.
By default, the communication between Deep Security Manager 20 and Oracle Database Server
is encrypted.
If you have already installed Deep Security Manager 20 and you haven't enabled encryption
options on your Oracle Database Server:
1. Stop Deep Security Manager 20.
2. Follow the instructions How To Configure Data Encryption and Integrity on the Oracle
Help Center, and enable encrypted connection options on Oracle Database Server side.
3. "Restart the Deep Security Manager" on page 1345.
By default, the communication between Deep Security Manager 20 and Oracle Database Server
is encrypted.
1254
Trend Micro Deep Security On-Premise 20
Note: Follow the Oracle blog article Verifying the use of Native Encryption and Integrity to see
if the encrypted connection is working or not.
PostgreSQL
If you have not already installed Deep Security Manager 20:
1. Turn on SSL in PostgreSQL. For on-premises PostgreSQL database, see Secure TCP/IP
Connections with SSL for more information. For an Amazon RDS for PostgreSQL,
see Using SSL with a PostgreSQL DB Instance for more information.
2. "Install Deep Security Manager" on page 210.
By default, the communication between Deep Security Manager 20 and PostgreSQL Database
Server is encrypted.
If you have already installed Deep Security Manager 20 and you haven't enabled encryption
options on your PostgreSQL Database Server:
1. Stop Deep Security Manager 20.
2. Turn on SSL in PostgreSQL. For on-premises PostgreSQL database, see Secure TCP/IP
Connections with SSL for more information. For an Amazon RDS for PostgreSQL,
see Using SSL with a PostgreSQL DB Instance for more information.
3. "Restart the Deep Security Manager" on page 1345.
By default, the communication between Deep Security Manager 20 and PostgreSQL Database
Server is encrypted.
Note: To check that the manager is connected using TLS, use the following query and check
the SSL column: select a.client_addr, a.application_name, a.usename, s.*
from pg_stat_ssl s join pg_stat_activity a using (pid) where
a.datname='<Deep Security database name>';
Running an agent on the database server
Encryption should be enabled if you are using an agent to protect the database. When you
perform a security update, the Deep Security Manager stores new Intrusion Prevention rules in
the database. The rule names themselves will almost certainly generate false positives as they
get parsed by the agent if the data is not encrypted.
1255
Trend Micro Deep Security On-Premise 20
Disable encryption between the manager and database
In rare cases, you may need to disable encryption between Deep Security Manager and the
database. For example, if you're using an older version of SQL Server, you may need to disable
encryption to avoid connection errors. For details, see Error: The installer could not establish a
secure connection to the database server.
Follow the instructions for your database type to disable encryption.
Microsoft SQL Server
1. Stop the Deep Security Manager service.
2. In the SQL Server, disable the "Force Encryption" option that was enabled in Enable
encrypted connections to the Database Engine.
3. (Optional) If your Deep Security Manager 20 was upgraded from Deep Security Manager
12.5 or older, remove all encryption related configurations in dsm.properties:
database.SqlServer.encrypt=true
database.SqlServer.trustServerCertificate=true
Note: If you upgraded from Deep Security 10.1 or a previous version, and your
connection to the database uses named pipes as the transport, remove the following line
instead: database.SqlServer.ssl=require
4. Restart Microsoft SQL Server if necessary.
5. Start Deep Security Manager.
Oracle Database
1. Stop the Deep Security Manager service.
2. Follow How To Configure Data Encryption and Integrity to disable the connection
encryption in the Oracle server.
3. (Optional) If your Deep Security Manager 20 was upgraded from Deep Security Manager
12.5 or older, remove all encryption related configurations in dsm.properties:
database.Oracle.oracle.net.encryption_types_client=(AES256)
database.Oracle.oracle.net.encryption_client=REQUIRED
database.Oracle.oracle.net.crypto_checksum_types_client=(SHA1)
database.Oracle.oracle.net.crypto_checksum_client=REQUIRED
1256
Trend Micro Deep Security On-Premise 20
4. Restart the Oracle listener.
5. Start the Deep Security Manager service.
PostgreSQL
1. Stop the Deep Security Manager service.
2. Follow Secure TCP/IP Connections with SSL to remove ssl=on in postgresql.conf
and disable the connection encryption in the PostgrSQL database.
3. (Optional) If your Deep Security Manager 20 was upgraded from Deep Security Manager
12.5 or older, remove all encryption related configurations in dsm.properties:
database.PostgreSQL.connectionParameters=ssl=true
4. Restart the PostgreSQL service.
5. Start the Deep Security Manager service.
Upgrade from an old Deep Security Manager version
If you're currently using Deep Security Manager 12.5 or older and meet the following criteria:
l Encrypted connection is enabled.
l Uses PostgreSQL database server.
Please follow the instructions below before upgrading.
If either of the above criteria is not satisfied, you can ignore the following section and upgrade
straight to Deep Security Manager 20.0.
Upgrade Deep Security Manager
Since PostgreSQL JDBC driver has different behaviors in different versions, you need to
complete the following steps before upgrading.
1. Export the certificate from your PostgreSQL database server. (This should already be
completed because the old Deep Security Manager requires the certificate to enable
connection encryption).
2. Rename the certificate file as root.crt .
3. Put it in the predefined Deep Security Manager 20 path:
In Linux, put root.crt in ~/.postgresql/
In Windows, put root.crt in c:\Users\{USERNAME}\AppData\Roaming\postgresql\.
1257
Trend Micro Deep Security On-Premise 20
4. Run the upgrade flow. Deep Security Manager 20 will continue to use an encrypted
connection with PostgreSQL server after upgrade.
Change the Deep Security Manager database password
Your organization's security policies may require that you periodically change the password that
Deep Security Manager uses to access the database.
l "Change your Microsoft SQL Server password" below
l "Change your Oracle password" on the next page
l "Change your PostgreSQL password" on the next page
Change your Microsoft SQL Server password
1. On Windows, stop the Trend Micro Deep Security Manager service on each of your Deep
Security Manager instances.
On Linux, the command to stop the service is:
# service dsm_s stop
2. Use SQL Server Management Studio to change the SQL user password.
3. On each Deep Security Manager instance, modify the
/opt/dsm/webclient/webapps/ROOT/WEB-INF/dsm.properties file to specify the
new password. When you open this file, you will see an obfuscated value for the
password, similar to this:
database.SqlServer.password=$1$4ec04f9550e0bf378fa6b1bc9698d0bbc59ac010
bfef7ea1e6e47f30394800b1a9554fe206a3ee9ba5f774d205ba03bb86c91c0664c7f05
f8c467e03e0d8ebbe
Overwrite that value with your new password (the new password will be obfuscated when
the service restarts):
Database.SqlServer.password=NEW PASSWORD GOES HERE
4. On Windows, start the Trend Micro Deep Security Manager service on each of your Deep
Security Manager instances.
On Linux, the command to start the service is:
# service dsm_s start
1258
Trend Micro Deep Security On-Premise 20
Change your Oracle password
1. On Windows, stop the Trend Micro Deep Security Manager service on each of your Deep
Security Manager instances.
On Linux, the command to stop the service is:
# service dsm_s stop
2. Use your Oracle tools to change the password.
3. On each Deep Security Manager instance, modify the
/opt/dsm/webclient/webapps/ROOT/WEB-INF/dsm.properties file to specify the
new password. When you open this file, you will see an obfuscated value for the
password, similar to this:
database.Oracle.password=$1$4ec04f9550e0bf378fa6b1bc9698d0bbc59ac010bfe
f7ea1e6e47f30394800b1a9554fe206a3ee9ba5f774d205ba03bb86c91c0664c7f05f8c
467e03e0d8ebbe
Overwrite that value with your new password (the new password will be obfuscated when
the service restarts):
Database.Oracle.password=NEW PASSWORD GOES HERE
4. On Windows, start the Trend Micro Deep Security Manager service on each of your Deep
Security Manager instances.
On Linux, the command to start the service is:
# service dsm_s start
Change your PostgreSQL password
1. On Windows, stop the Trend Micro Deep Security Manager service on each of your Deep
Security Manager instances.
On Linux, the command to stop the service is:
# service dsm_s stop
2. Follow instructions from your PostgreSQL documentation to change the password.
3. On each Deep Security Manager instance, modify the
/opt/dsm/webclient/webapps/ROOT/WEB-INF/dsm.properties file to specify the
new password. When you open this file, you will see an obfuscated value for the
1259
Trend Micro Deep Security On-Premise 20
password, similar to this:
database.PostgreSQL.password=$1$4ec04f9550e0bf378fa6b1bc9698d0bbc59ac01
0bfef7ea1e6e47f30394800b1a9554fe206a3ee9ba5f774d205ba03bb86c91c0664c7f0
5f8c467e03e0d8ebbe
Overwrite that value with your new password (the new password will be obfuscated when
the service restarts):
Database.PostgreSQL.password=NEW PASSWORD GOES HERE
4. On Windows, start the Trend Micro Deep Security Manager service on each of your Deep
Security Manager instances.
On Linux, the command to start the service is:
# service dsm_s start
Configure HTTP security headers
Security headers are directives used by web applications to configure security defenses in web
browsers. Based on these directives, browsers can make it harder to exploit client-side
vulnerabilities such as Cross-Site Scripting or Clickjacking. Headers can also be used to
configure the browser to only allow valid TLS communication and enforce valid certificates, or
even enforce using a specific server certificate.
The sections below detail the various security headers and support for them in Deep Security:
l "Customizable security headers" below
l "Enforced security headers" on page 1263
l "Unsupported security headers" on page 1264
Customizable security headers
The following headers can be enabled and configured based on specific environment
requirements:
l "HTTP Strict Transport Security (HSTS)" on the next page
l "Content Security Policy (CSP)" on the next page
l "HTTP Public Key Pinning (HPKP)" on page 1262
1260
Trend Micro Deep Security On-Premise 20
Note: As the primary tenant, you can "Enable customizable security headers" on the next
page in the Deep Security Manager or "Reset your configuration" on page 1263.
HTTP Strict Transport Security (HSTS)
HTTP Strict Transport Security is a header that configures the web browser to always use a
valid secure connection with the web application. If the server TLS certificate suddenly becomes
expired or untrusted, the browser will no longer connect to the web application. Also, if the user
attempts to access the web application using an http:// url, the browser will automatically
change it to https://. These countermeasures help prevent Man-in-the-middle attacks as well
as other attacks such as Session Hijacking.
On install, the Deep Security Manager console has a self-signed (untrusted) certificate and
HSTS is turned off. This is because each organization must configure the Deep Security web
application with a specific certificate that matches the manager hostname. This can also be
achieved by configuring a Load Balancer with TLS termination such as AWS ELB/ALB.
Once a valid TLS configuration is in place, the HTTP Strict Transport Security Header can be
enabled from Administration > System Settings > Security.
For instructions on enabling HTTP Strict Transport Security (HSTS), see "Enable customizable
security headers" on the next page.
Content Security Policy (CSP)
Content Security Policy includes a comprehensive set of directives that help prevent client-side
attacks, such as Cross-Site Scripting and Clickjacking, by restricting the type of content the
browser is allowed to include or execute.
Note: Enabling CSP can have adverse effects. For example, embedded scripts might stop
working or certain types of images required by third-party components such as jQuery might
not load.
When you enable CSP, it is always a good idea to run it in Report only first and observe if any
violations are reported to the provided URL for expected application functionality.
The Deep Security CSP can be configured under Administration > System Settings > Security.
Deep Security works best with the following settings:
default-src 'self'
script-src 'self' 'unsafe-eval' 'unsafe-inline'
1261
Trend Micro Deep Security On-Premise 20
frame-src 'self'
frame-ancestors 'self'
style-src 'self' 'unsafe-inline' blob:
form-action 'self'
img-src 'self' data:
report-uri https://your_report_uri.org/DS_CSP_Violation
Note: By default, the Report only check box is selected. Once you confirm that the CSP does
not break the expected application functionality, you can deselect Report only to enforce the
policy.
For instructions on enabling Content Security Policy (CSP), see "Enable customizable security
headers" below.
HTTP Public Key Pinning (HPKP)
The HPKP header forces browsers to only trust a specific certificate or certificate authority for
secure communications. This prevents attacks that leverage a trusted certificate authority which
has been compromised or maliciously installed on the client.
Note: Enabling HPKP can leave browsers unable to connect if a certificate is changed without
its header also being changed.
For instructions on enabling HTTP Public Key Pinning (HPKP), see "Enable customizable
security headers" below.
Enable customizable security headers
Note: In multi-tenant mode, security header settings are only available to the primary tenant.
1. Go to Administration > System Settings > Security.
2. Enter your HTTP Strict Transport Security (HSTS), Content Security Policy (CSP), or
HTTP Public Key Pinning (HPKP) directive(s) in the corresponding field(s).
Note: Before you enable settings, you can test them by selecting the Report Only option
and verifying that the policy violation reports are correct.
Tip: You can enter individual policy directives on separate lines.
1262
Trend Micro Deep Security On-Premise 20
3. Click Save at the bottom of the page.
Reset your configuration
If you experience trouble while configuring your directive and cannot correct it in the Deep
Security Manager, SSH into the manager and run the corresponding commands to reset your
configuration:
HTTP Strict Transport Security
dsm_c -action changesetting -name
settings.configuration.enableHttpStrictTransportSecurity -value ""
dsm_c -action changesetting -name
settings.configuration.enableHttpStrictTransportSecurity -value "false"
Content Security Policy
dsm_c -action changesetting -name
settings.configuration.contentSecurityPolicy -value ""
dsm_c -action changesetting -name
settings.configuration.contentSecurityPolicyReportOnly -value "true"
Public Key Pinning Policy
dsm_c -action changesetting -name settings.configuration.publicKeyPinPolicy
-value ""
dsm_c -action changesetting -name
settings.configuration.publicKeyPinPolicyReportOnly -value "true"
Enforced security headers
The following headers are enforced by default and cannot be changed:
l "Cache-Control and Pragma" on the next page
l "X-XSS-Protection" on the next page
l "X-Frame-Options" on the next page
1263
Trend Micro Deep Security On-Premise 20
Cache-Control and Pragma
These headers configure how the browser caches content. Caching sensitive content from an
authenticated application can be a security vulnerability if the content is cached on a machine
that is used by multiple users or if an attacker gains access to an unlocked machine after the
user has logged out of the application. For this reason, Deep Security disables caching on all
content that is not static by enforcing the no-cache and no-store values.
X-XSS-Protection
This XSS-Protection header forces the browser's Cross-Site Scripting (XSS) heuristics to detect
XSS attacks. Deep Security enforces this header in block mode by default. This means that if the
browser detects a potential XSS attack it will stop the page from loading altogether—a safer
approach than the alternative of trying to sanitize the page by replacing potentially malicious
elements.
Note: XSS-Protection does not work for all types of attacks and not all browsers have an XSS
filter.
X-Frame-Options
This header helps to prevent Clickjacking attacks. The Deep Security Manager enforces the
SAMEORIGIN value for this header, only allowing it to be embedded in web applications that are
hosted on the same domain.
Note: This header has the same effect as the frame-ancestors CSP directive. The frame-
ancestors directive will override the value of the X-Frame-Options header.
Unsupported security headers
The following header type is unsupported.
X-Content-Type-Options
This header with the nosniff value helps protect against mime type sniffing. Mime type sniffing
attacks are only effective in specific scenarios where they cause the browser to interpret text or
binary content as HTML. For example, if a user uploads an avatar file named xss.html and the
web application does not set a Content-type header when serving the image, the browser will try
1264
Trend Micro Deep Security On-Premise 20
to determine the content type and will likely treat xss.html as an HTML file. The attacker can
then direct users to xss.html and conduct a Cross-Site Scripting attack.
Deep Security does not currently support enabling this header as it has been observed to cause
adverse effects on redirects, however the relevant attack scenarios are not likely to impact the
manager web application and its usual functionality.
Upgrade the Deep Security cryptographic algorithm
Deep Security 9.6 SP1 and earlier use RSA-1024 and SHA-1 to secure communication between
the Deep Security Manager and Deep Security Agents. By default, Deep Security 10.0 or later
uses RSA-2048 and DSA-256, which are more secure algorithms.
A new installation of Deep Security 10.0 or later will use RSA-2048 and DSA-256 but if you
upgrade from an earlier version to Deep Security 10.0 or later, it will continue to use the earlier
cryptographic algorithms unless you upgrade them separately.
This article describes how to upgrade the algorithms after upgrading to Deep Security 10.0 or
later. After you change the settings as described in this article, the Deep Security Manager
generates new certificates for itself and all managed agents. When agents connect to the Deep
Security Manager again, the manager sends new certificates to the agents.
Upgrade the algorithm on Windows
1. Use the Services window of the Microsoft Management Console to stop the "Trend Micro
Deep Security Manager" service.
2. In the Windows command line, go to the Deep Security Manager's working folder, for
example, C:\Program Files\Trend Micro\Deep Security Manager.
3. Use the dsm_c command with parameters to change to the new settings. For example:
dsm_c -action changesetting -name
settings.security.defaultSignatureAlg -value "SHA256withRSA"
dsm_c -action changesetting -name settings.security.defaultKeyLength -
value "2048"
dsm_c -action changesetting -name
settings.security.forceCertificateUpdate -value "true"
4. If you don't see any errors, restart the Trend Micro Deep Security Manager service.
1265
Trend Micro Deep Security On-Premise 20
Upgrade the algorithm on Linux
1. At the command line, go to the directory where the Deep Security Manager service is
running and stop the service by entering:
service dsm_s stop
2. In the Linux command line, go to the Deep Security Manager's working folder, for example,
/opt/dsm.
3. Use the dsm_c command with parameters to change to the new settings. For example:
./dsm_c -action changesetting -name
settings.security.defaultSignatureAlg -value "SHA256withRSA"
./dsm_c -action changesetting -name settings.security.defaultKeyLength
-value "2048"
./dsm_c -action changesetting -name
settings.security.forceCertificateUpdate -value "true"
4. If you don't see any errors, restart the Trend Micro Deep Security Manager service.
Upgrade the algorithm in a multi-node environment
If you are running Deep Security Manager on multiple nodes, execute the dsm_c commands
(described above) on one of the nodes, and then manually restart the "Trend Micro Deep
Security Manager" service on each of the other nodes to make the changes take effect there.
Upgrade the algorithm in a multi-tenant environment
In Deep Security 10.0, the algorithm settings are independent for each tenant. You will need to
update the settings for each tenant by appending the tenant name (using -tenantname) or
tenant ID (using -tenantid) on the dsm_c command. For example, to change the settings for a
tenant whose ID is 5:
dsm_c -action changesetting -name settings.security.defaultSignatureAlg -
value "SHA256withRSA" -tenantid 5
dsm_c -action changesetting -name settings.security.defaultKeyLength -
value "2048" -tenantid 5
dsm_c -action changesetting -name settings.security.forceCertificateUpdate
-value "true" -tenantid 5
1266
Trend Micro Deep Security On-Premise 20
Enforce user password rules
You can specify password requirements for Deep Security Manager passwords, and other
settings related to user authentication.
Specify password requirements
Note: For greater security, enforce stringent password requirements: minimum 8 characters,
include both numbers and letters, use upper and lower case, include non-alphanumeric
characters, and expire regularly.
Go to Administration > System Settings > Security. In the User Security section, you can
change these settings:
l Session idle timeout: Specify the period of inactivity after which a user will be required to
sign in again.
l Maximum session duration: Maximum length of time that a user can be signed into the
Deep Security Manager before they'll be required to sign in again.
l Number of incorrect sign-in attempts allowed (before lock out): The number of times an
individual user (i.e. with a specific username) can attempt to sign in with an incorrect
password before they are locked out. Only a user with "Can Edit User Properties" rights
can unlock a locked-out user (see "Define roles for users" on page 1166).
Note: If a user gets locked out for a particular reason (too many failed sign-in attempts,
for example), and no user remains with the sufficient rights to unlock that account, please
contact Trend Micro for assistance.
l Number of concurrent sessions allowed per User: Maximum number of simultaneous
sessions allowed per user.
Note: A note about being signed in as two users at once: Remember that Firefox sets
session cookies on a per-process basis, and not on a per-window basis. This means that
if for some reason you want to be signed in as two users at the same time, you will either
have to use two different browsers (if one of them is Firefox), or sign in from two separate
computers.
l Action when concurrent session limit is exceeded:Specifies what happens when a user
reaches the maximum number of concurrent sessions.
1267
Trend Micro Deep Security On-Premise 20
l User password expires: Number of days that passwords are valid. You can also set
passwords to never expire.
l User password minimum length: The minimum number of characters required in a
password.
l User password requires both letters and numbers: Letters (a-z, A-Z) as well as numbers
(0-9) must be used as part of the password.
l User password requires both upper and lower case characters: Upper and lower case
characters must be used.
l User password requires non-alphanumeric characters: Passwords must include non-
alphanumeric characters.
l Send email when a user's password is about the expire: Before a user's password
expires, they will receive an email message. To use this feature, you must "Configure
SMTP settings for email notifications" on page 958.
Use another identity provider for sign-on
You can also configure Deep Security to use SAML single sign-on. For details, see "Configure
SAML single sign-on" on page 1187.
Add a message to the Deep Security Manager Sign In page
On the Administration > System Settings > Security page, use Sign-In Page Message to enter
text that will be displayed on the Deep Security Manager's sign in page.
Present users with terms and conditions
You can configure Deep Security Manager so that users must agree to terms and conditions
before they can sign in to the Deep Security Manager.
To enable this feature, select User must agree to the terms and conditions on the
Administration > System Settings > Security page. In the two text boxes, enter a title and the list
of terms and conditions that will be displayed when a user clicks the Terms and Conditions link
on the Sign In page.
Other Security settings
The Administration > System Settings > Security page also enables you to:
1268
Trend Micro Deep Security On-Premise 20
l "Manage trusted certificates" on page 1273
l "Configure HTTP security headers" on page 1260
Set up multi-factor authentication
The Deep Security Manager allows you the option to use multi-factor authentication (MFA). MFA
is a method of access control requiring more than a user name and password that is
recommended as a best practice.
In this article:
l "Enable multi-factor authentication" below
l "Disable multi-factor authentication" on page 1272
l "Supported multi-factor authentication (MFA) applications" on page 1272
l "Troubleshooting MFA" on page 1273
Enable multi-factor authentication
1. In Deep Security Manager, select User Properties from the menu under your user name in
the upper-right corner.
2. On the General tab, click the Enable MFA button. This will open the Enable Multi-Factor
Authentication wizard to guide you through the rest of the process.
3. The first screen of the wizard will remind you to install a compatible virtual MFA
application, such as Google Authenticator. For more information, see "Supported multi-
factor authentication (MFA) applications" on page 1272 at the bottom of this article.
4. If your device supports scanning QR codes, you can use your camera to configure your
MFA application and click Next.
Otherwise, you can choose My device does not support scanning QR codes. Show secret
key for manual time-based configuration.
1269
Trend Micro Deep Security On-Premise 20
5. Enter the Authentication Code (without the space), for example: 228045.
1270
Trend Micro Deep Security On-Premise 20
6. If the authorization code is correct, MFA will be enabled for your account and you will be
required to enter a new MFA code each time you sign in.
1271
Trend Micro Deep Security On-Premise 20
Disable multi-factor authentication
1. In the Deep Security Manager, select User Properties from the menu under your user
name in the upper-right corner.
2. On the General tab, click the Disable MFA button.
3. Click OK on the confirmation screen to disable MFA.
4. Your user properties screen displays with a note to indicate the changes to MFA. Click OK
to close the screen.
Supported multi-factor authentication (MFA) applications
The following smartphones and applications are actively supported for MFA. However, any
application implementing an RFC 6238 compliant Time-base One-time Password Algorithm
should work.
Smartphone MFA App
Android Google Authenticator, Duo
iPhone Google Authenticator, Duo
Blackberry Google Authenticator
1272
Trend Micro Deep Security On-Premise 20
Troubleshooting MFA
What if my MFA is enabled but not working?
The most common source of MFA login issues is caused by the time on your Deep Security
Manager being out of sync with your device.
Follow the instructions below for your chosen operating system to make sure the time is properly
synced:
If your Deep Security Manager is Linux:
Check that NTP is working correctly by entering ntpstat in the command line. To view the
current system time and date, enter date.
If your Deep Security Manager is Windows:
Check that the Windows Time Service is working correctly. To view the current system time and
date, enter time and date in the command line.
What if my MFA device is lost or stops working?
If your MFA device is lost, destroyed, or stops working, you'll need to have MFA disabled for your
account in order to be able to sign in.
1. Get in touch with the person who provided you with your sign in credentials and ask them
to follow the instructions in "Disable multi-factor authentication" on the previous page.
(You'll then be able to sign in with just your user name and password.)
2. After you've signed in, change your password.
3. Follow the instructions for "Enable multi-factor authentication" on page 1269.
If you are the only administrative user for a Deep Security as a Service account, contact
technical support (sign in Deep Security as a Service, and click Support in the top right-hand
corner) for assistance in temporarily deactivating MFA for your account.
Manage trusted certificates
Trusted certificates are used for code signing and SSL connections to external services such as
a Microsoft Active Directory, VMware vCenter, and Deep Security Smart Check.
1273
Trend Micro Deep Security On-Premise 20
Import trusted certificates
Note: If you are importing a trusted certificate to establish trust with an Amazon Web Services
region, you must use the dsm_c command-line tool.
To import trusted certificates using the Deep Security Manager:
1. In the Deep Security Manager, go to Administration > System Settings > Security.
2. Under Trusted Certificates, click View Certificate List to view a list of all security
certificates accepted by Deep Security Manager.
3. Click Import From File to start the Import Certificate wizard.
To import a trusted certificate using dsm_c:
1. On the Deep Security Manager server, run the following command:
dsm_c -action addcert -purpose PURPOSE -cert CERTFILE
where the parameters are:
Parameter Description Sample value
AWS - Amazon Web
What type of connections the certificate will Services
be used for. This value must be selected
PURPOSE
from one of the sample values listed on the DSA - code signing
right.
SSL - SSL connections
The (user-defined) name of the file
CERTFILE /path/to/cacert.pem
containing the certificate you want to import.
Note: If you are running the Deep Security Manager in a Linux environment, you will need to
run the dsm_c command as the root user.
View trusted certificates
Note: To view trusted certificates for Amazon Web Services connections, you must use the
dsm_c command-line tool.
To view trusted certificates using the Deep Security Manager:
1274
Trend Micro Deep Security On-Premise 20
1. In the Deep Security Manager, go to Administration > System Settings > Security.
2. Under Trusted Certificates, click View Certificate List.
To view trusted certificates using dsm_c:
1. On the Deep Security Manager server, run the following command:
dsm_c -action listcerts [-purpose PURPOSE]
The -purpose PURPOSE parameter is optional and can be omitted to see a list of all
certificates. If you specify a value for PURPOSE, then only the certificates used for that
purpose will be shown.
Parameter Description Sample value
AWS - Amazon Web
Services
What type of connections the certificate will
PURPOSE
be used for. DSA - code signing
SSL - SSL connections
Note: If you are running the Deep Security Manager in a Linux environment, you will need to
run the dsm_c command as the root user.
Remove trusted certificates
Note: To remove trusted certificates for Amazon Web Services connections, you must use the
dsm_c command-line tool.
To remove a trusted certificate using the Deep Security Manager:
1. In the Deep Security Manager, go to Administration > System Settings > Security.
2. Under Trusted Certificates, click View Certificate List.
3. Select the certificate you want to remove and click Delete.
To remove a trusted certificate using dsm_c:
1. Log in to Deep Security Manager .
2. Run the following command:
dsm_c -action listcerts [-purpose PURPOSE]
The -purpose PURPOSE parameter is optional and can be omitted to see a list of all
1275
Trend Micro Deep Security On-Premise 20
certificates. If you specify a value for PURPOSE, then only the certificates used for that
purpose will be shown.
Parameter Description Sample value
AWS - Amazon Web
Services
What type of connections the certificate will
PURPOSE
be used for. DSA - code signing
SSL - SSL connections
3. Find the ID value for the certificate you want to remove in the list.
4. Run the following command:
dsm_c -action removecert -id ID
The ID parameter value is required.
Sample
Parameter Description
value
The ID value assigned by Deep Security Manager for the
ID 3
certificate you want to delete.
Note: If you are running the Deep Security Manager in a Linux environment, you will need to
run the dsm_c commands as the root user.
SSL implementation and credential provisioning
The Deep Security Agent may initiate communication to Deep Security Manager or it may be
contacted by the manager if the computer object is set to operate in bi-directional mode. Deep
Security Manager treats all connections to agents and appliances in a similar way. If the agent
has not been activated, a limited set of interactions are possible. If the agent has been activated
(either by an administrator or via the agent-initiated activation feature), the full set of interactions
are enabled. The Deep Security Manager acts as an HTTP client in all cases, regardless of
whether it was the client when forming the TCP connection. Agents and appliances cannot ask
for data or initiate operations themselves. The manager requests information such as events and
status, invokes operations, or pushes configuration to the agent. This security domain is highly
controlled to ensure that agents and appliances have no access to Deep Security Manager or
the computer that it is running on.
1276
Trend Micro Deep Security On-Premise 20
Both agent and manager use two different security contexts to establish the secure channel for
HTTP requests:
1. Before activation, the agent accepts the bootstrap certificate to form the SSL or TLS
channel.
2. After authentication, mutual authentication is required to initiate the connection. For mutual
authentication, the manager's certificate is sent to the agent and the agent's certificate is
sent to the manager. The agent validates that the certificates come from the same
certificate authority (which is the Deep Security Manager) before privileged access is
granted.
Once the secure channel is established, the agent acts as the server for the HTTP
communication. It has limited access to the manager and can only respond to requests. The
secure channel provides authentication, confidentiality through encryption, and integrity. The
use of mutual authentication protects against man-in-the-middle (MiTM) attacks where the SSL
communication channel is proxied through a malicious third party. Within the stream, the inner
content uses GZIP and the configuration is further encrypted using PKCS #7.
If I have disabled the connection to the Smart Protection
Network, is any other information sent to Trend Micro?
When Smart Protection Network is disabled, the Deep Security Agents will not send any threat
intelligence information to Trend Micro.
Upgrade Deep Security
About upgrades
Types of Deep Security updates from Trend Micro include:
l Software upgrades: New software such as the Deep Security Manager, Virtual Appliance,
Agent and Relay.
l Security updates: Rules and malware patterns that Deep Security Agent and Virtual
Appliance software uses to identify potential threats. Types of security updates include:
1277
Trend Micro Deep Security On-Premise 20
l Pattern updates: Used by Anti-Malware.
l Rule updates: Used by:
l Firewall
l Intrusion Prevention
l Integrity Monitoring
l Log Inspection
(Application Control rule updates are created locally, based on your computers' software. They
are not from Trend Micro.)
The Anti-Malware engine in agent and virtual appliance software can be updated independently
to keep up with the newest threats. See "Enable automatic Anti-Malware engine updates" on
page 1285.
Trend Micro releases new rule updates every Tuesday, with additional updates as new threats
are discovered. Information about the updates is available in the Trend Micro Threat
Encyclopedia.
How Deep Security Manager checks for software upgrades
Deep Security Manager periodically connects to Trend Micro Update servers to check for
updates to software that you have imported into the Deep Security Manager database, such as:
l Deep Security Agent
l Deep Security Virtual Appliance
l Deep Security Manager
This checks based on the local inventory, not the Download Center. (There is a separate alert for
new software on the Download Center.)
Note:
Deep Security will only inform you of minor version updates-not major-of software.
For example, if you have Deep Security Agent 9.6.100, and Trend Micro releases 9.6.200, an
alert will tell you that software updates are available. However, if 10.0.xxx (a major version
difference) is released and you don't have any 10.0 agents, the alert will not appear (even
though 10.0is newer than 9.6.100).
1278
Trend Micro Deep Security On-Premise 20
An alert on the manager will notify you that software updates are available. On Administration >
Updates > Software, the "Trend Micro Download Center" section also indicates whether there
are updates available. Once you import (download) software into the Deep Security Manager
database, you can upgrade the software in your deployment. See "Upgrade Deep Security
Agent" on page 1295 and "Upgrade the appliance" on page 1307.
Tip: To see all software packages that are available for download (even if you haven't
imported it before), go to Administration > Updates > Software > Download Center.
To determine when the last check was performed, whether it was successful, or to manually
initiate a check for updates, go to Administration > Updates > Software and view the "Deep
Security" section. If you have configured a scheduled task to check for updates, the date and
time of the next scheduled check is also listed here. See "Schedule Deep Security to perform
tasks" on page 1378.
When imported, software is stored in the Deep Security Manager database. Imported software is
periodically replicated to relays.
Best practices for upgrades
When deploying a new release of the Deep Security Agent or Deep Security Virtual Appliance:
l Deep Security Relays must be the same version or newer than all agents and appliances
in your environment.
l Deep Security Relays should be the same version as your Deep Security Manager.
l When performing upgrades of Deep Security software, the order of upgrade is important.
Upgrade your Deep Security Manager first, then all relays, then agents and appliances.
Note: Beginning with Deep Security 20, you will not be able to activate a Deep Security Agent
with a Deep Security Manager that is older than the Minimum DSM Version for that agent
release. You can find the Minimum DSM Version on the Deep Security Software download
page.
Tip: With Trend Micro Cloud One – Workload Security, the manager and relays provided with
the service are always up to date. Workload Security customers can ignore the Minimum DSM
Version and don’t have to worry about relay versions unless they choose to deploy extra relays
in their environment.
1279
Trend Micro Deep Security On-Premise 20
How Deep Security validates update integrity
Both software updates and security updates are digitally signed. In addition to automatic checks,
if you want to manually validate the signatures or checksums, you can use external tools such
as:
l sha256sum (Linux)
l Checksum Calculator (Windows)
l jarsigner (Java Development Kit (JDK); see "Check digital signatures on software
packages" on page 196)
Digital signatures
When security updates are viewed, used, or imported into the Deep Security Manager database
(either manually or automatically, via scheduled task), the manager validates the signature. A
correct digital signature indicates that the software is authentically from Trend Micro and hasn't
been corrupted or tampered with. If the digital signature is invalid, the manager does not use the
file. A warning is also recorded in log files such as server0.log:
WARNING: ThID:85|TID:0|TNAME:Primary|UID:1|UNAME:MasterAdmin|Verifying the
signature failed.
com.thirdbrigade.manager.core.general.exceptions.FileNotSignedValidationEx
ception: "corrupted_rules.zip." has not been digitally signed by Trend
Micro and cannot be imported.
If you manually import a security update package with an invalid digital signature, the manager
also displays an error message.
Note: Old security updates that aren't signed will fail validation if they are used, even if you
successfully imported them in a previous version of Deep Security Manager that did not
enforce signatures. For better protection, use new security updates instead. However if you still
require the old security updates, you can contact your support provider to request a file that is
signed, and then manually import the security update.
Deep Security Agent also validates the digital signature, compares checksums (sometimes
called hashes or fingerprints) and uses other, non-disclosed integrity methods.
1280
Trend Micro Deep Security On-Premise 20
Checksums
Software checksums (also called hashes or fingerprints) are published on the Download Center.
To view the SHA-256 hash, click the + button next to the software's name.
Apply security updates
To remain effective at identifying new threats, your Deep Security Agents and Virtual Appliances
need periodic security updates.
Before your agents, virtual appliances, and relays can receive security updates, you must define
how to distribute them (see "Deploy additional relays" on page 1091 and "Configure the update
source" on page 1094). Then you can:
l "Initiate security updates" on the next page
l "Check your security update status" on the next page
l "View details about pattern updates" on the next page
l "Revert, import, or view details about rule updates" on page 1283
l "Configure security updates" on page 1284
1281
Trend Micro Deep Security On-Premise 20
Initiate security updates
Tip: Instead of manually checking for updates, configure Deep Security Manager to
automatically check for security updates via a scheduled task. See "Schedule Deep Security to
perform tasks" on page 1378.
You can manually initiate security updates at any time, regardless of scheduled tasks.
l To get security updates for all agents and virtual appliances, go to Administration >
Updates > Security and click Check For Updates and Download.
l To get security updates on one agent or virtual appliance, go to Computers, select the
agent or virtual appliance, then right-click and select Actions > Download Security
Update.
Check your security update status
To view the status of your security updates, go to Administration > Updates > Security.
l Trend Micro Update Server: Indicates whether relays can connect to Trend Micro
ActiveUpdate to check for the latest security updates.
l Deep Security: Indicates when the last successful check and download were performed,
and when the next scheduled check will be performed. All Relays are in sync indicates
that all relays are distributing the latest successfully downloaded pattern updates.
Tip: Out-of-sync status usually indicates that the relay cannot connect to Trend Micro
Update Servers. Usually, this is not normal. You should fix network connectivity
problems. In "air-gapped" deployments, however, network isolation is intentional; you
must provide updates manually.
l Computers: Indicates whether any computers are out-of-date compared to the pattern
updates currently on the relays. To tell all computers to get the latest pattern updates from
their assigned relays, click Send Patterns to Computers.
View details about pattern updates
To view a list of the components in an Anti-Malware pattern update, go to Administration >
Updates > Security > Patterns. This page is displayed only when Deep Security has an active
1282
Trend Micro Deep Security On-Premise 20
relay.
l Component: The type of update component.
l For Use By: The Deep Security product this component is intended for.
l Platform: The operating system for which the update is intended.
l Current Version: The version of the component currently being distributed by the Deep
Security Relays.
Tip: To check which security update component version is being used on a protected
computer, go to Computers, double-click the computer, and then select Updates.
l Last Updated: When the current security update was downloaded from Trend Micro.
Revert, import, or view details about rule updates
To view a list of the most recent Intrusion Prevention, Integrity Monitoring, and Log Inspection
Rules that have been downloaded into the Deep Security Manager database, go to
Administration > Updates > Security > Rules.
From there you can:
l View details about a rule update: Select a rule update and click View. Details include a
list of the update's specific rules.
Tip: To check which rule update version a relay is distributing, go to Computers, double-
click the relay, and then select Security Updates. If Anti-Malware is enabled for that
computer, it also displays the computer's pattern version.
l Roll back a rule update: If a recent rule update has caused problems, you can revert to a
previous rule version. Select the rule update that you want to revert to and then click
Rollback. Deep Security Manager generates a preview change summary so that you can
confirm results before finalizing.
Note: All policies affected by the reverted rules will be immediately updated on all
computers using those policies.
1283
Trend Micro Deep Security On-Premise 20
l Reapply the current rule set: indicates that a rule update has been applied. To reapply
that rule update to protected computers, right-click the rule update and click Reapply.
l Import a rule update: Normally, rule updates are imported either manually or automatically
(via scheduled task). However, if your deployment has no connectivity to the Trend Micro
Update servers on the Internet (an "air-gapped" deployment), or if you are asked to do so
by your support provider, you can click this button to manually upload and import a security
update package.
l Export a rule update: Normally, you should not need to export a rule update unless your
support provider asks you.
l Delete a rule update: Removes the selected rule update from the Deep Security Manager
database.
Tip: To limit the number of rule updates that are kept in the Deep Security Manager
database, go to Administration > System Settings > Storage .
Security update packages must have a valid digital signature. If you try to view or use an invalid
package (including old security updates that don't have a signature), then the manager displays
an error message. See "How Deep Security validates update integrity" on page 1280.
Configure security updates
You can make the following configurations:
l "Enable automatic patches for rules" below
l "Enable automatic Anti-Malware engine updates" on the next page
l "Enable security updates for older agents" on the next page
l "Change the alert threshold for late security updates" on page 1286
Enable automatic patches for rules
Trend Micro sometimes updates an existing Deep Security rule to improve performance or fix a
bug. To automatically apply these patches, go to Computer or Policy editor 1 > Settings >
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-
click the policy that you want to edit (or select the policy and click Details). To change the settings for a computer, go to the Computers page
and double-click the computer that you want to edit (or select the computer and click Details).
1284
Trend Micro Deep Security On-Premise 20
General and in the Send Policy Changes Immediately area, select Automatically apply Rule
Updates to Policies. If it's not selected, you must manually apply downloaded rule updates to
policies: go to Administration > Updates > Security and click Apply Rules to Policies.
Note: By default, changes to policies are automatically applied to computers.
Enable automatic Anti-Malware engine updates
By default, when you update Deep Security Agent or Virtual Appliance software, then its Deep
Security Anti-Malware engine is updated together with it. If you don't update software often, then
over time, the Anti-Malware engine might become much older than the malware patterns it uses
(which should be frequently updated).
For better protection, you can configure agents and virtual appliances to automatically keep the
Anti-Malware engine part of the software updated — an approach more similar to the security
updates that it uses.
1. Go to Computers or Policies.
2. Double-click a computer or policy.
3. Go to Settings > Engine Update.
4. For Automatically update anti-malware engine, select Yes .
If this setting is disabled, then on Computer Details > Updates > Advanced Threat Scan
Engine, the Is Latest section displays "N/A".
Note: Regardless of this setting, relays always receive the latest Anti-Malware engine
updates. This keeps the relay's local protection and engine update source for the same relay
group up-to-date. Therefore, you cannot enable or disable engine updates directly on a relay.
Enable security updates for older agents
For some platforms, Deep Security Manager20 supports older versions. See "Deep Security
Agent platforms" on page 135.
By default, to conserve disk space, Deep Security Relay will not download and distribute
security updates for these older agents. To enable security updates for them, go to
Administration > System Settings > Updates. Select Allow supported 8.0 and 9.0 Agents to be
updated.
Note: Deep Security Agent 8.0 is no longer supported. This check box only applies to the 9.0
agent.
1285
Trend Micro Deep Security On-Premise 20
Change the alert threshold for late security updates
If an update has been downloaded from Trend Micro and available for some time, but computers
are not updated yet, an alert occurs. For rule updates, by default, the limit is 30 minutes. For
pattern updates, by default, the limit is 1 hour.
If you want to change the time limit for the alert, go to Administration > System Settings > Alerts
and configure Length of time an Update can be pending before raising an Alert.
Disable emails for New Pattern Update alerts
The "New Pattern Update is Downloaded and Available" alert is raised when a security update
has not been applied to an agent one hour after Deep Security Manager has downloaded it. The
one-hour time span is not configurable. The alert is sent via email when the alert is raised by
default.
If you are receiving too many of these email alerts because one hour is not long enough to
disperse the updates, you can disable email notifications for this alert. Instead, you can receive
email messages for the "Computer Not Receiving Updates" alert for which you can configure the
time that passes before the alert is raised.
1. To ensure that Deep Security Manager is configured to automatically download security
updates, in Deep Security Manager, click Administration > Scheduled Tasks.
2. If there is no scheduled task of type Check for Security Updates, create one (see
"Schedule Deep Security to perform tasks" on page 1378).
3. Click Administration > System Settings > Updates. In the Rules section under Security
Updates, make sure Automatically apply Rule Updates to Policies is selected.
For Deep Security as a Service, rule updates are automatically applied by default.
4. Click Alerts > Configure Alerts.
5. In the Alert Configuration window, click the New Pattern Update is Downloadable and
Available alert and then click Properties.
6. On the Alert Information window, deselect Send Email to notify when this alert is raised
and then click OK.
7. Click the Computer Not Receiving Updates alert and then click Properties.
8. Make sure Send Email to notify when this alert is raised is selected, and click OK.
The alert is raised when an update is pending for 7 days.
9. To raise the alert after a different amount of time has passed since the update was
pending, click Administration > System Settings > Alerts.
10. In the alerts area, use the drop-down to select the period of time, and then click Save.
1286
Trend Micro Deep Security On-Premise 20
Use a web server to distribute software updates
Deep Security software updates are normally hosted and distributed by relays. However, if you
already have a web server, you can provide software updates via the web server instead of a
relay. To do this, you must mirror the software repository of the relay on your web server.
Note: Although Deep Security Agents can download their software updates from the web
server, at least one relay is still required to distribute security package updates such as anti-
malware and IPS signatures (see "Apply security updates" on page 1281).
Note: Even though you are using your own web servers to distribute software, you must still
go to Administration > Updates > Software and import software into the Deep Security
Manager's database. Then you must ensure that your software web server contains the same
software that has been imported into Deep Security Manager. Otherwise the alerts and other
indicators that tell you about available updates will not function properly.
Web server requirements
Disk Space: 20 GB
Ports: Web server port, relay port
Copy the folder structure
Mirror the folder structure of the software repository folder on a relay-enabled agent. Methods
vary by platform and network. For example, you could use rsync over SSH for a Linux computer
and network that allows SSH.
On Windows, the default location for the relay-enabled agent's software repository folder is:
C:\ProgramData\Trend Micro\Deep Security Agent\relay\www\dsa\
On Linux, the default location for the Relay's software repository folder is:
/var/opt/ds_agent/relay/www/dsa/
The structure of the folder is like this:
|-- dsa
| |-- <Platform>.<Architecture>
1287
Trend Micro Deep Security On-Premise 20
| |-- <Filename>
| |-- <Filename>
| |-- ...
|
| |-- <Platform>.<Architecture>
| |-- <Filename>
| |-- <Filename>
| |-- ...
For example:
|-- dsa
| |-- CentOS_<version>.x86_64
| |-- Feature-AM-CentOS_<version>.x86_64.dsp
| |-- Feature-DPI-CentOS_<version>.x86_64.dsp
| |-- Feature-FW-CentOS_<version>.x86_64.dsp
| |-- Feature-IM-CentOS_<version>.x86_64.dsp
| |-- ...
|
| |-- RedHat_EL6.x86_64
| |-- Agent-Core-RedHat_<version>.x86_64.rpm
| |-- Feature-AM-RedHat_<version>.x86_64.dsp
| |-- Feature-DPI-RedHat_<version>.x86_64.dsp
| |-- Feature-FW-RedHat_<version>.x86_64.dsp
| |-- ...
| |-- Plugin-Filter_2_6_32_131_0_15_el6_x86_64-RedHat_
<version>.x86_64.dsp
| |-- Plugin-Filter_2_6_32_131_12_1_el6_x86_64-RedHat_
<version>.x86_64.dsp
| |-- ...
|
| |-- Windows.x86_64
| |-- Agent-Core-Windows-<version>.x86_64.msi
| |-- Agent-Core-Windows-<version>.x86_64.msi
| |-- Feature-AM-Windows-<version>.x86_64.dsp
1288
Trend Micro Deep Security On-Premise 20
| |-- Feature-AM-Windows-<version>.x86_64.dsp
| |-- Feature-DPI-Windows-<version>.x86_64.dsp
| |-- Feature-DPI-Windows-<version>.x86_64.dsp
| |-- ...
| |-- Plugin-Filter-Windows-<version>.x86_64.dsp
| |-- Plugin-Filter-Windows-<version>.x86_64.dsp
| |-- ...
The example above shows only a few files and folders. Inside a complete dsa folder, there are
more. If you need to save disk space or bandwidth, you don't need to mirror all of them. You're
only required to mirror the files that apply to your computers' platforms.
Configure agents to use the new software repository
When the mirror on the web server is complete, configure Deep Security Agents to get their
software updates from your web server.
1. On Deep Security Manager, go to Administration > System Settings > Updates.
2. In the Software Updates section, enter the URL(s) of the mirror folder(s) on your web server
(s).
3. Click Save.
Note: Verify that connectivity between agents and your web server is reliable. If the
connection is blocked, agents will instead use the relay.
Upgrade Deep Security Manager
Upgrade Deep Security Manager before you upgrade Deep Security Relays, Agents, and Virtual
Appliances.
Topics:
l "Before you begin" on the next page
l "Upgrade the manager" on page 1291
l "Upgrade the manager if it's more than two releases old" on page 1291
l "Upgrade the manager in a multi-node deployment" on page 1291
l "Upgrade the manager in a multi-tenant environment" on page 1292
1289
Trend Micro Deep Security On-Premise 20
l "What happens when you upgrade?" on page 1292
l "Post-upgrade tasks" on page 1293
l "Troubleshoot the manager upgrade (log files)" on page 1293
l "Roll back an unsuccessful upgrade of the manager" on page 1294
Before you begin
Make sure you have completed these pre-upgrade tasks:
1. Check that you're upgrading from a supported version. You can upgrade to Deep Security
20 from:
l Deep Security 11 LTS (GA version or LTS updates)
l Deep Security 12 LTS (GA version or LTS updates)
l Deep Security 12 Feature Releases
2. Back up your deployment:
l Back up the manager. Make a system restore point or VM snapshot of the server.
l Back up the manager's database on the database server. The upgrade might make
changes to the database schema, so the original database must be backed up.
l Verify your backups. If you don't have backups, and the installer is interrupted for any
reason, you won't be able to revert your deployment. This could require you to re-
install your entire deployment.
3. Check system requirements and sizing guidelines for the new manager: See "System
requirements" on page 165 and "Sizing" on page 172.
Note: The sizing guideines for Deep Security 20 are different from those for Deep
Security 12. Check that your current environment meets the guidelines for Deep Security
20 before upgrading.
4. Download the manager software: It's available at
https://help.deepsecurity.trendmicro.com/software.html.
5. Check the digital signature on the manager's installer file: See "Check the signature on
installer files (EXE, MSI, RPM or DEB files)" on page 198.
6. Run the readiness check: See "Run a readiness check" on page 210.
1290
Trend Micro Deep Security On-Premise 20
Upgrade the manager
To upgrade the manager, see "Install the manager" on page 211. The referred-to installation
instructions will work equally well for upgrades.
Upgrade the manager if it's more than two releases old
The manager's installer only supports upgrading from two major releases back, so if you're
currently on a manager version that's older than that, the upgrade path involves a couple of
'hops': the first hop gets to a version that's a little more recent, and the next gets you to the latest
version.
For instructions on how to upgrade from an old manager to a newer one, see the installation
guide for the latter:
Access documentation for other versions
Upgrade the manager in a multi-node deployment
To upgrade the manager software
1. Back up each manager node. Make a system restore point or VM snapshot of the
server.
2. Stop all nodes.
3. Upgrade the manager on the first node.
Warning: Never run the installer on multiple nodes at the same time.
Simultaneous upgrades can corrupt the database. If this happens, you must
restore the database backup, then start the upgrade again.
4. When upgrade is complete for the first node, its service will start. Until other nodes
are also upgraded, it will be the only node whose software is compatible with the
database, so initially it will be the only available manager. Because it must
perform all jobs, you might notice that performance is reduced during this time. On
Administration > System Information, Network Map with Activity Graph will
indicate that other nodes are offline, and that they require an upgrade.
5. Upgrade other nodes. As you upgrade them, they will return online, and begin to
share the load again.
1291
Trend Micro Deep Security On-Premise 20
6. If you configured a custom master key, run the masterkey commands to encrypt
existing data on only one of the nodes.
To upgrade the manager OS
1. Add a node. See "Add a node" on page 259.
2. Decommission the node you want to upgrade. See "Remove a node" on
page 260.
3. Upgrade the OS of the decommissioned node, then return it to the pool.
4. Repeat these steps with any other nodes that have an unsupported OS.
Upgrade the manager in a multi-tenant environment
See "Upgrade a multi-tenant environment" on page 251 for details.
What happens when you upgrade?
When you upgrade, the installer does the following:
l installs new Deep Security software
l keeps existing computer details, policies, intrusion prevention rules, firewall rules, and so
on
l migrates data to new formats, if required
l makes changes to the database schema, if required
l begins migrating event data
When you exit the installer, the upgrade continues. The following occurs:
l the manager service is restarted
l the manager continues to migrate event data into the new database schema
Progress is indicated in the status bar at the bottom of the window, in new events, and (if
an error occurs) alerts. Total migration time varies by the amount of data, disk speed, RAM,
and processing power.
1292
Trend Micro Deep Security On-Premise 20
l new event data is still recorded, as usual, while the event data is migrated
Note: Until database upgrade migration is complete, results which include older system
event data may be incomplete.
Additional tasks are performed during a multi-node or multi-tenant upgrade. For details, see
"Upgrade the manager in a multi-node deployment" on page 1291 and "Upgrade the manager in
a multi-tenant environment" on the previous page.
Post-upgrade tasks
After the upgrade, complete the following tasks.
l (Optional) Replace the server certificate
After the upgrade, the manager's server certificate is kept, unless you performed a fresh
install. If your certificate was created using a weak cryptographic algorithm, such as SHA-
1, consider replacing the certificate. Using stronger cryptography ensures compliance with
the latest standards, and provides better protection against the latest exploits and attacks.
See "Upgrade the Deep Security cryptographic algorithm" on page 1265 and "Replace the
Deep Security Manager TLS certificate" on page 1245.
l (Optional) Remove and re-add vCenter
If you are using Deep Security Virtual Appliance on NSX-T, make sure to uninstall Deep
Security from your NSX-T environment and re-add NSX-T to the manager to register the
updated services. The services that will be registered are:
l E-W Network Introspection
l Endpoint Protection
Troubleshoot the manager upgrade (log files)
If the schema changes are interrupted for any reason, errors are logged in:
<install-directory>/DBUpgrade/SchemaUpdate
where the default <install-directory> is /opt/dsm (Linux) or C:\Program Files\Trend
Micro\Deep Security Manager (Windows).
Within the above directory, two types of files are created:
1293
Trend Micro Deep Security On-Premise 20
l T-00000-Plan.txt - This file contains all data definition language (DDL) SQL statements
that the installer will use to update the schema.
l T-00000-Progress.txt - This file contains the schema update progress logs. When the
installer is finished, it changes the file name to either T-00000-Done.txt (successful
update) or T-00000-Failed.txt (update failure).
Note: In a multi-tenant environment, the "00000" in the file name is replaced with the tenant
number, such as "00001" for tenant t1.
Roll back an unsuccessful upgrade of the manager
If problems occur when you upgrade to Deep Security Manager 20, you can quickly revert to a
functional state if you:
l Backed up the database before the upgrade
l Didn't upgrade the agents, relays, or virtual appliances yet (or have VM snapshots or
system backups that you made before the upgrade)
1. Stop the Deep Security Manager service.
2. Restore the database.
3. Restore all Deep Security Manager server nodes.
4. If you changed the hostname, FQDN, or IP address of the Deep Security Manager during
the upgrade, restore them.
5. Restore the agents, relays, and virtual appliances.
6. Start the Deep Security Manager service.
7. Verify connectivity to the Deep Security Manager, including the connection between the
manager and agents.
Upgrade Deep Security Relay
Upgrade all your relays before you start to upgrade agents (see "Best practices for upgrades" on
page 1279 for details.) There are two ways to upgrade a relay, as described below.
1294
Trend Micro Deep Security On-Premise 20
Upgrade a relay starting from the manager
1. Log in to Deep Security Manager.
2. Identify your Deep Security Relays. Either:
l Go to Computers . In the main pane, look for computers with the relay icon ().
l Go to Administration. On the left, click Updates > Relay Management. In the main
pane, expand a Relay Group. Your relays are displayed with the relay icon ().
3. Double-click the relay that you want to upgrade.
4. Click the Actions tab.
5. Click Upgrade Agent.
Follow the steps in the wizard that appears. Steps are similar to upgrading a Deep Security
Agent, since a relay is just an agent with relay functionality enabled. For details, see
"Upgrade Deep Security Agent" below.
Upgrade a relay by running the installer manually
Sometimes you may not be able to upgrade the relay software from the Deep Security Manager.
In these cases, you can upgrade a relay manually. For detailed instructions, see "Upgrade the
agent manually" on page 1298. The referred-to instructions are for agents, but will work equally
for relays.
Upgrade Deep Security Agent
Software upgrades can be initiated through Deep Security Manager or a third-party deployment
system.
In this topic:
l "Before you begin an upgrade" on the next page
l "Upgrade the agent starting from an alert" on page 1297
l "Upgrade multiple agents at once" on page 1297
l "Upgrade the agent from the Computers page" on page 1298
l "Upgrade the agent on activation" on page 1298
l "Upgrade the agent manually" on page 1298
1295
Trend Micro Deep Security On-Premise 20
l "Upgrade the agent embedded on the virtual appliance automatically" on page 1302
l "Upgrade best practices for agents" on page 1302
Before you begin an upgrade
Before you begin an agent upgrade:
1. Check that you're upgrading from a supported version. You can upgrade to Deep Security
20 from:
l Deep Security 11 LTS (GA version or LTS updates)
l Deep Security 12 LTS (GA version or LTS updates)
l Deep Security 12 Feature Releases
2. Back up the agent computers that you plan to upgrade. Make a system restore point or
VM snapshot of each agent.
3. Import the new agent package into the manager. See "Import agent software" on page 268.
4. Upgrade all Deep Security Relays. See "Upgrade Deep Security Relay" on page 1294.
Warning: You must upgrade all relays before you begin upgrading agents, otherwise,
upgrades may fail.
Note: When you upgrade the Deep Security Agent, Deep Security verifies your
signature on Deep Security Agent to ensure that the software files have not changed
since the time of signing. For more information, see "Agent package integrity check" on
page 1415.
Next, review the platform-specific notes below and complete any advised tasks.
Linux agent upgrade notes
Before upgrading the Deep Security Agent on a Linux platform, confirm the OS kernel is
supported by the latest version of the agent. See "Deep Security Agent Linux kernel
support" on page 143
Windows agent upgrade notes
Immediately after upgrading Deep Security Agent 12 or later on Windows with Anti-
Malware enabled, be aware that the Anti-Malware engine may appear as 'Offline'. The
1296
Trend Micro Deep Security On-Premise 20
engine will return to the 'online' state after the first heartbeat following the upgrade.
Solaris agent upgrade notes
l On Solaris 11, if you are upgrading from Deep Security Agent 9.0, you must first
upgrade to Deep Security Agent 9.0.0-5616 or a later 9.0 agent, and from there,
upgrade to Deep Security Agent 11.0. If you upgrade from an earlier build, the
agent may fail to start. If this problem occurs, see "Fix the upgrade issue on
Solaris 11" on page 1523.
l An upgrade on Solaris may take five minutes or longer to complete in some cases.
AIX agent upgrade notes
There are no upgrade notes for AIX at this time.
You are now ready to upgrade your agent using any of the methods described in this topic.
Upgrade the agent starting from an alert
When a new agent software version is available, a message appears on Alerts.
1. In the alert, click Show Details and then click View all out-of-date computers.
Computers appears, displaying all computers where Software Update Status is Out-of-
Date. What is considered 'out-of-date' is determined by version control rules you've set up.
For details, see "Configure agent version control" on page 1117.
2. Continue with "Upgrade the agent from the Computers page" on the next page or
"Upgrade the agent manually" on the next page.
Upgrade multiple agents at once
1. In Deep Security Manager, go to Administration > Updates > Software.
2. In the main pane, look under the Computers section to see whether any computers or
virtual appliances are running agents for which upgrades are available. The check is only
1297
Trend Micro Deep Security On-Premise 20
performed against software that has been imported into Deep Security, not against
software available from the Download Center.
3. Click Upgrade Agent / Appliance Software to upgrade all out-of-date computers. What is
considered 'out-of-date' is determined by version control rules you've set up. For details,
see "Configure agent version control" on page 1117.
Upgrade the agent from the Computers page
1. In Deep Security Manager, go to Computers, and then:
l Right-click the computer(s) that you want to upgrade, and select Actions > Upgrade
Agent Software.
Or
l Select the computer(s) that you want to upgrade, click the Actions button near the top
and select Upgrade Agent Software.
Or
l Double-click a computer that you want to upgrade and on the Computer details dialog
box, click the Upgrade Agent button.
Warning: You must upgrade your relays before your agents to prevent failures. Learn
more. To identify a relay, look for the relay icon ().
2. In the dialog box that appears, select the Agent Version. We recommend that you select
the default Use the latest version for platform (X.Y.Z.NNNN). Click Next.
Upgrade the agent on activation
If Deep Security Agent is installed on Linux or Windows, you can choose to automatically
upgrade the agent to the newest software version that's compatible with your Deep Security
Manager when the agent is activated or reactivated. For details, see "Automatically upgrade
agents on activation" on page 1139.
Upgrade the agent manually
Sometimes you may not be able to upgrade the agent software from the Deep Security Manager.
Reasons may include:
1298
Trend Micro Deep Security On-Premise 20
l There are connectivity restrictions between the manager and agent computers.
l Your agent software is too old, and the manager doesn't support upgrading it anymore.
l You prefer to deploy upgrades using a third-party system.
If any of the above scenarios describes your situation, you can upgrade the agent by running the
installer manually. The method varies by operating system.
Upgrade the agent on Windows
1. Disable agent self-protection to allow the installer to make modifications to the
agent. To disable self-protection:
a. In the Deep Security Manager, go to Computer editor 1 > Settings > General.
In Agent Self Protection.
b. Deselect Prevent local end-users from uninstalling, stopping, or otherwise
modifying the Agent or enter a password for a local override.
2. Export the new agent ZIP from the manager. See "Export the agent installer" on
page 270 for instructions. If multiple new agents are available for your platform,
choose the latest one.
3. Copy the ZIP to the agent computer and extract it.
4. Double-click the MSI file in the root of the ZIP file. The installer detects the
previous agent and performs the upgrade.
Upgrade the agent on Linux
1. Export the new agent ZIP from the manager. See "Export the agent installer" on
page 270 for instructions. If multiple new agents are available for your platform,
choose the latest one.
2. Copy the ZIP to the agent computer and extract it.
3. If the computer uses the rpm package manager (Red Hat, CentOS, Amazon Linux,
Cloud Linux, SUSE), enter the command:
rpm -U <new agent installer rpm>
The -U argument instructs the installer to perform an upgrade.
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
1299
Trend Micro Deep Security On-Premise 20
4. If the computer uses the dpkg package manager (Debian or Ubuntu), enter the
command:
dpkg -i <new agent installer dpkg>
Upgrade the agent on Solaris
1. Export the new agent ZIP from the manager. See "Export the agent installer" on
page 270 for instructions. If multiple new agents are available for your platform,
choose the latest one.
2. Copy the ZIP to the agent computer and extract it.
3. Run the installer:
l Solaris 11, one zone (run in the global zone):
x86: pkg update -g file:///mnt/Agent-Solaris_5.11-9.x.x-xxxx.x86_
64/Agent-Core-Solaris_5.11-9.x.x-xxxx.x86_64.p5p
pkg:/security/ds-agent
SPARC: pkg update -g file:///mnt/Agent-Solaris_5.11-9.x.x-
xxxx.x86_64/Agent-Solaris_5.11-9.x.x-xxxx.sparc.p5p
pkg:/security/ds-agent
l Solaris 11, multiple zones (run in the global zone):
mkdir <path>
pkgrepo create <path>
pkgrecv -s file://<dsa core p5p file location> -d <path> '*'
pkg set-publisher -g <path> trendmicro
pkg update pkg://trendmicro/security/ds-agent
pkg unset-publisher trendmicro
rm -rf <path>
l Solaris 10: Create an installation configuration file named ds_adm.file with the
following content, and then save it in the root directory. Next, run this command to
install the package:
1300
Trend Micro Deep Security On-Premise 20
pkgadd -G -v -a /root/ds_adm.file -d Agent-Core-Solaris_5.10_U7-
10.0.0-1783.x86_64.pkg
Content of ds_adm.file
mail=
instance=overwrite
partial=nocheck
runlevel=quit
idepend=nocheck
rdepend=quit
space=quit
setuid=nocheck
conflict=quit
action=nocheck
proxy=
basedir=default\
Upgrade the agent on AIX
1. Export the new agent ZIP from the manager. See "Export the agent installer" on
page 270 for instructions. If multiple new agents are available for your platform,
choose the latest one.
2. Copy the ZIP to the agent computer and extract it. A BFF file becomes available.
3. Copy the BFF file to a temporary folder such as /tmp on the AIX computer. For
detailed instructions, see "Install the agent manually" on page 273.
4. Upgrade the agent. Use these commands:
/tmp> rm -f ./.toc
/tmp> installp -a -d /tmp/<agent_BFF_file_name> ds_agent
where <agent_BFF_file_name> is replaced with the name of the BFF installer
file you extracted.
1301
Trend Micro Deep Security On-Premise 20
Upgrade the agent embedded on the virtual appliance automatically
The Deep Security Virtual Appliance includes an embedded Deep Security Agent. You can
configure Deep Security to upgrade this agent automatically to the latest version during the
virtual appliance's deployment into NSX.
Note: If you've already deployed the virtual appliance into NSX, you should upgrade the
embedded agent following these alternative instructions: "Upgrade the agent embedded on the
appliance SVM" on page 1318.
To configure auto-upgrade of the embedded agent during the virtual appliance deployment into
NSX, do the following:
1. In Deep Security Manager, import the latest virtual appliance package. See "Deploy the
appliance (NSX-T 3.x)" on page 308, or "Deploy the appliance (NSX-V)" on page 341
2. Import the correct virtual appliance patches and agent. See "Upgrade the agent embedded
on the appliance SVM" on page 1318. In these instructions, ignore the last instructions to
upgrade the embedded agent since it hasn't been deployed yet.
3. Go to Administration > System Settings > Updates.
4. In the main pane, find the Virtual Appliance Deployment heading, near the bottom.
5. From the Upon deployment, update Deep Security Virtual Appliances to drop-down list,
select the latest agent version or keep the default of Latest Available (Recommended).
Note: Versions of the agent software that pre-date the imported appliance do not appear
in the list.
6. Click Save.
The agent that's embedded on the virtual appliance will now be upgraded automatically
when you deploy the virtual appliance into NSX. For deployment instructions, see "Deploy
the appliance (NSX-T 3.x)" on page 308 or "Deploy the appliance (NSX-V)" on page 341.
Upgrade best practices for agents
If you have critical workloads running on your agent servers, we recommend that you follow
these best practices when upgrading:
1302
Trend Micro Deep Security On-Premise 20
l Upgrade when the computers are less busy.
l Test the upgrade procedure first in a staging environment before upgrading production
servers.
l When upgrading production servers, upgrade one server at a time for the first few servers.
Allow a soak period in between each server upgrade.
l After individually upgrading a number of production servers for a given OS version (and
application role, on Solaris or AIX), upgrade the remaining servers in groups.
l Also review the "Best practices for upgrades" on page 1279.
Upgrade Deep Security Virtual Appliance
Trend Micro recommends that you upgrade the Deep Security Virtual Appliance with the newest
version to take advantage of the latest security patches, updates, and ongoing support.
The appliance has two parts, which can be upgraded separately:
l the appliance service virtual machine (SVM)
l the Deep Security Agent embedded in the appliance SVM
Note: The term 'appliance SVM' refers to the Deep Security Virtual Appliance virtual machine
deployed in your VMware infrastructure.
Topics:
l "Check if new appliance software is available" below
l "Before upgrading the appliance" on page 1305
l "Upgrade the appliance" on page 1307
Check if new appliance software is available
If you're not sure which version of the appliance SVM and embedded agent you're running, or
whether new versions are available, read this section to find out. Otherwise, skip this section and
proceed directly to "Upgrade the appliance" on page 1307.
Consult these sections to determine whether you need to upgrade:
l "Determine which versions of the appliance SVM and embedded agent you're using" on
the next page
1303
Trend Micro Deep Security On-Premise 20
l "Determine whether a new appliance SVM is available" below
l "Determine whether a new agent is available" below
Determine which versions of the appliance SVM and embedded agent you're
using
1. In Deep Security Manager, click Computers.
2. In the search box at the top right, enter Deep Security Virtual Appliance to find the
appliance virtual machines.
3. Right-click the appliance virtual machine, and click Details > General.
l The Virtual Appliance Version property indicates the version of the embedded Deep
Security Agent. This agent is deployed on the appliance SVM. Write down this value.
l The Appliance (SVM) Version property indicates the version of the Deep Security
Virtual Appliance package that is used to deploy this virtual machine. Write down this
value.
Determine whether a new appliance SVM is available
1. In Deep Security Manager, click Administration.
2. On the left, expand Updates > Software > Download Center.
3. In the main pane, enter Appliance-ESX in the search box on the top-right and press Enter.
All the appliance SVM software appears.
4. In the main pane, expand the LTS release that matches your Deep Security Manager
release.
5. Look for the version in the VERSION field and see if it's newer than the installed version.
6. If you find that you need to upgrade, go to "Upgrade the appliance" on page 1307.
Determine whether a new agent is available
1. In Deep Security Manager, click Administration.
2. On the left, expand Updates > Software > Download Center.
3. In the main pane, in the search box on the top-right, enter the name of an agent that is
compatible with your installed appliance SVM. Consult the compatibility table for guidance.
For example, enter Agent-RedHat_EL7 into the search box. A list of compatible agents
appears.
4. In the main pane, expand the latest release to view the latest agent.
5. Look for the version in the VERSION field and see if it's newer than the installed version.
6. If you find that you need to upgrade, go to "Upgrade the appliance" on page 1307.
1304
Trend Micro Deep Security On-Premise 20
Before upgrading the appliance
Before you upgrade the Deep Security Virtual Appliance, complete the tasks below.
Review system requirements and supported NSX versions
l Review this table to see which NSX licenses and versions are supported.
l Review these system requirements. Upgrade NSX, Deep Security Manager, and other
required software and hardware, as needed.
Verify the vCenter and NSX account permissions
Make sure the existing vCenter and NSX accounts that you specified in Deep Security Manager
during the previous appliance deployment have the correct permissions. For a list of the required
permissions, see "Add a VMware vCenter" on page 433.
Re-register NSX-T
You may need to re-register NSX-T.
To check whether NSX-T needs to be re-registered:
1. Go to NSX-T Manager and click System > Service Deployments > CATALOG.
2. Make sure both Endpoint Protection Policy and Intrusion Detection and Prevention
Systems are present, as shown in the image below. If not, it means a re-registration is
required.
To re-register NSX-T:
1. Uninstall Deep Security from your NSX environment. See "Uninstall Deep Security from
your NSX environment" on page 1331 for details.
2. Re-register NSX in the manager. See "Add a VMware vCenter" on page 433.
1305
Trend Micro Deep Security On-Premise 20
Import the new appliance ZIP into the manager
You must import the new appliance ZIP into the manager.
Tip: As an alternative to importing the appliance ZIP, you can place the OVF file at a
URL location to make it faster for NSX to download. For details, see "Configure the appliance
OVF location" on page 378.
1. Go to:
https://help.deepsecurity.trendmicro.com/software.html
2. Download the Deep Security Virtual Appliance package. Check the version requirements
in system requirements.
You can import multiple versions of the appliance. The manager will choose the newest
package.
3. On Deep Security Manager, go to Administration > Updates > Software > Local.
4. Click Import and upload the package to Deep Security Manager.
On import, Deep Security Manager also automatically downloads and imports an agent
that is compatible with the operating system of the virtual appliance VM. This agent has the
same protection modules as Deep Security Agent for 64-bit Red Hat Enterprise Linux.
5. If you want to specify a different embedded agent, go to Administration > System Settings
> Updates and look for Virtual Appliance Deployment. By default, the Virtual Appliance
Deployment option is set to Latest Available (Recommended). This indicates to the
manager to upgrade the virtual appliance to use the newest imported, embedded agent.
Change this setting, as required.
Next steps
You have completed the pre-upgrade steps and must now continue with the upgrade. You must
go to one of the following sections depending on your scenario:
l If you re-registered NSX-T, the appliance was removed. This means you'll need to deploy
a fresh appliance (not upgrade it). For next steps, go to "Deploy the appliance (NSX-T 3.x)"
on page 308.
l If you didn't re-register NSX-T, you are now ready to upgrade the appliance. Go to
"Upgrade the appliance" on the next page.
1306
Trend Micro Deep Security On-Premise 20
Upgrade the appliance
After completing the pre-upgrade tasks, you are ready to upgrade the appliance. You have a few
upgrade options:
l Option 1: "Upgrade an existing appliance SVM automatically" below.
l Option 2: "Upgrade an existing appliance SVM manually" on page 1311. Use this option if
protection loss of your guest VMs during the upgrade is unacceptable.
l Option 3: "Upgrade the agent embedded on the appliance SVM" on page 1318. Use this
option if you want the latest protection features offered by the newest agent software
without having to complete a full appliance SVM upgrade.
If you are using NSX-T, you can use Option 2 or 3.
If you are using NSX-V, you can use any Option.
See also "Upgrade the NSX license for more Deep Security features" on page 1321.
Upgrade an existing appliance SVM automatically
With this upgrade option, your guest VMs lose protection during the upgrade process, which
takes five to fifteen minutes depending on the resources of your VMware components and
network stability. If you would like to maintain protection of the guest VMs, see instead "Upgrade
an existing appliance SVM manually" on page 1311.
Note: Any resource adjustments or custom configurations you may have made to the current
appliance SVM, such as extending the CPU or memory or changing a password, will not be
carried over to the new appliance SVM after the upgrade. You will need to manually re-apply
these configurations when the upgrade finishes.
To upgrade the appliance SVM automatically, follow these steps:
l "Step 1: Upgrade the appliance SVM in the manager" below
l "Step 2: Check that the upgrade succeeded" on page 1311
Step 1: Upgrade the appliance SVM in the manager
1. In Deep Security Manager, click Computers at the top.
1307
Trend Micro Deep Security On-Premise 20
2. Find the ESXi host where your existing appliance SVM is located. The ESXi host has its
PLATFORM column set to VMware ESXi <version_build> (see image below). (It is not
a computer with a PLATFORM of Deep Security Virtual Appliance.)
3. Right-click the ESXi host and select Actions > Upgrade Appliance (SVM).
Tip: You can use Shift+click to select multiple ESXi hosts, if you want to upgrade several
at once.
Note: The Upgrade Appliance (SVM) option is only available if the latest virtual
appliance package in Local Software is newer than the one that's currently in use. To
make the option available, try importing the latest appliance package. If that doesn't work,
it's likely because you're already using the latest version of the appliance SVM. To
check, look at the Appliance (SVM) Version property on the computer details page of the
appliance virtual machine.
The Upgrade Appliance (SVM) page appears with a check box, warnings, and a note.
1308
Trend Micro Deep Security On-Premise 20
Note: During the upgrade, the appliance (SVM) will be shut down for about 3 - 10
minutes depending on your vCenter and ESX resources.
4. (Optional.) Select Check NSX alarms before upgrade, and cancel the process if any
alarms exist if you want the manager to check the service status from NSX Manager before
the upgrade begins. Deselect the check box if you want to skip the check and proceed with
the upgrade despite possible alarms.
5. Review the warnings and note on the page.
6. Click OK.
The upgrade process begins, including a pre-upgrade service status check, if you enabled
it.
7. (Optional.) Still in the manager, go back to the Computers page, find your ESXi host, and
look at its TASK(S) column to view the status of the upgrade.
Note: If you previously shift+clicked several ESXi hosts on which to perform an upgrade,
the ESXi hosts are processed sequentially (one at a time). You can look at the TASK(S)
column to find out which server is currently being processed.
The TASK(S) column displays one of the following:
1309
Trend Micro Deep Security On-Premise 20
l Upgrading Appliance (SVM) (Pending): The manager has received the upgrade
request, but has not yet put it into the queue.
l Upgrading Appliance (SVM) (In Queue): The manager has queued the process, and
will start the upgrade soon.
l Upgrading Appliance (SVM) (In Progress): The manager is processing the upgrade.
8. (Optional.) Still in the manager, go to the Computer Details page of one of your ESXi hosts
and click the System Events tab to verify that the upgrade is proceeding successfully.
Below is a sample of the system events you'll see when an upgrade is successful. For
more events, see this complete list of appliance SVM upgrade events.
Note: If you see the Appliance (SVM) Upgrade Failed system event, see "Troubleshooting
the 'Appliance (SVM) Upgrade Failed' system event" below.
Troubleshooting the 'Appliance (SVM) Upgrade Failed' system event
If you see the Appliance (SVM) Upgrade Failed system event, review its detailed description for
the reason and possible fix. In the worst case scenario, you can go to the NSX Manager console
and click the Resolve button (see the image below). Clicking this button manually resolves any
alarms and redeploys the appliance. Guest VMs are activated according to how you set up
activation when you deployed your old Deep Security Virtual Appliance. For details on activation
set up, see the activation section of "Deploy the appliance (NSX-V)" on page 341.
1310
Trend Micro Deep Security On-Premise 20
Step 2: Check that the upgrade succeeded
The appliance SVM should be upgraded successfully. Go to the manager's Computers page
and double-check that the appliance SVM and all the guest VMs are back in their protected state
(green dot).
Upgrade an existing appliance SVM manually
With a manual upgrade, you'll use the vMotion mechanism to preserve the guest VMs' protection
while the upgrade occurs.
To upgrade the appliance SVM, follow these steps:
l "Step 1: Review or restore identified files" below
l "Step 2: Migrate guest VMs to another ESXi host" below
l "Step 3: Upgrade your old appliance SVM" on the next page
l "Step 4: Check that maintenance mode was turned off" on page 1317
l "Step 5: Check that the new appliance SVM is activated" on page 1317
l "Step 6: Final step" on page 1318
Step 1: Review or restore identified files
1. Review or restore identified files as necessary because identified files will be lost when
you move your VMs or delete the Deep Security Virtual Appliance.
Step 2: Migrate guest VMs to another ESXi host
Note: Skip this section if you are using NSX-T 3.x.
For brevity, this procedure uses these terms:
l ESXi_A is the ESXi server with the virtual appliance that you want to upgrade.
l ESXi_B is the ESXi server where guest VMs are migrated to while the appliance
1311
Trend Micro Deep Security On-Premise 20
SVM upgrade occurs. We assume it is under the same cluster as ESXi_A.
1. Enable DRS for the cluster and make sure it has an automation level of Fully Automated.
See this VMware article for details.
2. Find ESXi_A and place this ESXi server in maintenance mode.
When you enter maintenance mode:
l ESXi_A's guest VMs are migrated automatically (using vMotion) to ESXi_B in your
cluster.
l The Deep Security Virtual Appliance that is protecting ESXi_A is shut down
automatically.
l Your guest VMs can no longer be powered on until ESXi_A is out of maintenance
mode.
Step 3: Upgrade your old appliance SVM
NSX-V instructions
1. Go to VMware vSphere Web Client > Hosts and Clusters.
2. Find the Trend Micro Deep Security appliance SVM that is powered off. It's the
one without a green arrow (shown in the following image). The appliance
1312
Trend Micro Deep Security On-Premise 20
SVM was automatically powered off when you put the corresponding ESXi server
into maintenance mode.
3. Right-click the Trend Micro Deep Security appliance SVM that is powered off and
select Delete from Disk.
1313
Trend Micro Deep Security On-Premise 20
1314
Trend Micro Deep Security On-Premise 20
4. If you see a Confirm Delete message, click Yes.
5. If the deletion fails with this message...
This operation not allowed in the current state
Do this:
a. Right-click the Trend Micro Deep Security appliance SVM again, and this
time select Remove from Inventory (which appears just above Delete from
Disk). This removes the appliance SVM from vCenter but preserves it in the
datastore.
b. In the navigation pane, select the datastore tab and select the datastore where
the old virtual appliance resides.
c. In the main pane, select the Files tab.
d. Right-click the old appliance SVM folder and select Delete File.
e. Open VMware vSphere Web Client, and go to Home > Networking and
Security > Installation > Service Deployments.
You see the following:
1315
Trend Micro Deep Security On-Premise 20
l The deleted Trend Micro Deep Security appliance SVM Installation
Status column shows Failed.
l If you are in maintenance mode, the Guest Introspection service also
shows as Failed.
f. Click the Resolve button on the Guest Introspection service if its Installation
Status is Failed. The Failed status changes to Enabling and then to
Succeeded. The Guest Introspection service is powered on and maintenance
mode is exited.
g. Click the Resolve button on the Trend Micro Deep Security service that is
Failed.The Failed status changes to Enabling and then to Succeeded. The
following occurred:
l The Trend Micro Deep Security appliance SVM was redeployed with the
latest software that you loaded into Deep Security Manager.
l The appliance SVM was activated.
l The embedded agent on the appliance SVM was auto-upgraded to the
latest compatible version in Local Software by default.
This ends the NSX-V instructions. You can proceed to "Step 4: Check that
maintenance mode was turned off" on the next page.
NSX-T 3.x instructions
In NSX-T Manager, go to System > Service Deployments > DEPLOYMENT.
Click the menu icon (three dots) > Change Appliance.
1316
Trend Micro Deep Security On-Premise 20
c. Select the appliance that you want to update and click the UPDATE button.
Wait for the upgrade process to complete.
Step 4: Check that maintenance mode was turned off
Note: Skip this section if you are using NSX-T 3.x.
l Check that maintenance mode was turned off if you enabled it previously. If it is still on,
turn it off now.
Step 5: Check that the new appliance SVM is activated
1. In Deep Security Manager, at the top, click Computers.
2. Find Trend Micro Deep Security in the list and double-click it. This is the appliance.
3. Check the following:
a. Check that the status is set to Managed (Online). This indicates that the agent was
successfully activated.
b. Check that the Virtual Appliance Version is set to the version of the embedded Deep
Security Agent. This version should match the version of the newest agent software
found under Administration > Updates > Software > Local or a specific version you
set in Administration > System Settings > Updates > Virtual Appliance Deployment.
c. Check that the Appliance (SVM) Version is set to the version of the newest Deep
Security Virtual Appliance package under Administration > Updates > Software >
1317
Trend Micro Deep Security On-Premise 20
Local.
You have now upgraded your appliance SVM.
Step 6: Final step
1. Repeat all the steps in this section, starting at "Step 1: Review or restore identified files" on
page 1311 and ending at "Step 5: Check that the new appliance SVM is activated" on the
previous page for each appliance SVM that needs to be upgraded.
Guest VMs are activated according to how you set up activation when you deployed your old
Deep Security Virtual Appliance. For details on activation setup, see the activation section in
"Deploy the appliance (NSX-T 3.x)" on page 308, or "Deploy the appliance (NSX-V)" on
page 341.
Upgrade the agent embedded on the appliance SVM
You can upgrade just the Deep Security Agent that's embedded on the appliance SVM without
redeploying the appliance SVM.
Note: When you upgrade just the embedded agent, the appliance SVM’s original end-of-
support date remains in effect. For details, see "Deep Security LTS life cycle dates" on
page 80
Follow these instructions to upgrade the embedded agent on the appliance SVM.
1318
Trend Micro Deep Security On-Premise 20
1. "Determine which versions of the appliance SVM and embedded agent you're using" on
page 1304. You'll need this information to complete the remaining steps in this procedure.
2. Import the compatible agent:
a. Still in Deep Security Manager, on the left, expand Updates > Software > Download
Center.
b. Select the agent software that is compatible with your appliance SVM. Consult the
compatibility table that follows for guidance.
c. Click the button in the Import Now column to import the agent into Deep Security
Manager.
d. On the left, click Local Software to verify that the agent was imported successfully.
You have now imported the Deep Security Agent that is compatible with your appliance
SVM version. You are ready to upgrade the agent on the appliance SVM.
3. Upgrade the agent on the appliance SVM:
a. Click Computers and double-click your appliance computer.
b. Click Actions > Upgrade Appliance.
c. Select the agent version to install on the appliance. This is the agent you just imported.
d. Click OK.
4. Click Events & Reports and search on 710 to find the report about the installation of the
update file.
You have now upgraded the agent on the appliance SVM.
Compatibility table: appliance, agent
Appliance SVM Image
Compatible agent software
version OS
Agent-RedHat_EL7-<version>.x86_64.zip
Appliance-
CentOS where <version> is the version of the agent software. Select the
ESX-11.0 or
7
higher latest version. This version of the agent will be used as the
embedded agent.
Upgrade the database
If you're planning on upgrading Deep Security Manager, you may also need to upgrade the
Deep Security database. Check this list of currently-supported databases, and then, if required,
1319
Trend Micro Deep Security On-Premise 20
migrate to a new database following the instructions below.
The upgrade path
The upgrade path for the database is as follows:
1. Upgrade the database software first.
2. Upgrade Deep Security Manager.
The database you choose must be supported by both the new and currently-installed version of
Deep Security Manager. See these lists:
l Databases supported by the current release of the manager.
l Databases supported by previous versions of the manager. (The adjacent link takes you to
a page that provides access to the documentation for previous releases. You can drill
down into the documentation to find database support.)
Upgrade the database
To upgrade the database, follow these instructions:
Warning: To prevent data loss, complete the database migration before upgrading the Deep
Security Manager software.
1. Stop the Deep Security Manager service. Deep Security Agents continue with their current
protection policies while the manager is stopped.
2. Back up the database(s).
3. Back up the database connection settings file: [Deep Security install
directory]/webclient/webapps/ROOT/WEB-INF/dsm.properties
4. Migrate to the new database server. For specific requirements, see "Database
requirements" on page 203.
5. If the migration did not preserve existing databases, load the database backup(s) into the
new database engine.
6. If required, edit dsm.properties to use the migrated database.
7. Restart the Deep Security Manager service.
1320
Trend Micro Deep Security On-Premise 20
Error: The installer could not establish a secure connection to
the database server
When installing or upgrading Deep Security Manager, the following error message can occur if
you are using Microsoft SQL Server as your Deep Security database:
The installer could not establish a secure connection to the database server. Please upgrade or
configure your database server to support TLS 1.2 encryption.
The error message appears if the java.security file on the Deep Security Manager includes
TLSv1 and TLSv1.1 in the jdk.tls.disabledAlgorithms= setting, which disables early TLS
and only allows TLS 1.2. (The java.security file is set this way if you are doing a fresh install
of Deep Security Manager 11.1 or higher, where only TLS 1.2 is allowed, or if you are upgrading
and previously enforced TLS 1.2.) During the upgrade or installation, the database drivers on the
manager try to communicate with the SQL Server using TLS 1.2, and if your SQL Server version
does not support TLS 1.2, you'll see this error.
To solve the problem, you must upgrade your SQL Server database to a version that supports
TLS 1.2 and then retry the Deep Security Manager installation or upgrade. For a list of
SQL Server versions that support TLS 1.2, see this Microsoft article.
Upgrade the NSX license for more Deep Security features
If you want to use the Deep Security Firewall, Intrusion Prevention, or Web Reputation features
with Deep Security Virtual Appliance, you'll need to use a license that supports VMware's
network functionality. Network functionality is supported with the following license types:
l NSX Advanced
l NSX Enterprise
l NSX Data Center Advanced
l NSX Data Center Enterprise Plus
l NSX Data Center for Remote Office Branch Office
If you're using another license type, you'll have to upgrade it. See:
l "Upgrade your NSX-T 3.x license" on the next page
l "Upgrade your NSX-V license" on the next page
1321
Trend Micro Deep Security On-Premise 20
Tip: As an alternative to upgrading your NSX license, you can deploy Deep Security Agents
on your guest VMs to get the above-mentioned features. For details, see this table as well as
"Choose agentless vs. combined mode protection" on page 302.
Upgrade your NSX-T 3.x license
1. Log in to NSX-T Manager.
2. Click System > Licenses.
3. Click Add, enter the license key, and click Add.
4. Log out and log back in to NSX-T Manager. The new license is applied.
You can now use the Deep Security features that rely on VMware's network functionality,
namely, the Firewall, Intrusion Prevention, and Web Reputation features. You can continue to
use the Anti-Malware and Integrity Monitoring features, which were available to you previously.
Upgrade your NSX-V license
l "Step 1: Upgrade your NSX license" below
l "Step 2: Remove Deep Security from NSX completely" on page 1326
l "Step 3: Redeploy the Deep Security Virtual Appliance" on page 1326
Step 1: Upgrade your NSX license
1. In your vSphere Web Client, go to Home > Administration > Licenses.
2. In the main pane, click Assets, and then click the Solutions button.
1322
Trend Micro Deep Security On-Premise 20
3. Right-click NSX for vSphere and select Assign License.
4. Click the green + on the left to create a new license.
A wizard appears, guiding you through the process of adding a license key.
1323
Trend Micro Deep Security On-Premise 20
5. In the wizard, enter the NSX Advanced, NSX Enterprise, NSX Data Center Professional,
NSX Data Center Advanced, NSX Data Center Enterprise Plus, or NSX Data Center fore
Remote Branch Office license key and a license name. At the end of the wizard, click
Finished.
The new license appears in the list on the Assign License page.
1324
Trend Micro Deep Security On-Premise 20
6. Select the new license and click OK.
The new NSX license is now in use.
1325
Trend Micro Deep Security On-Premise 20
Step 2: Remove Deep Security from NSX completely
In order for the new license to take effect, you'll need to remove Deep Security entirely from
NSX. To remove the Deep Security from NSX, see "Uninstall Deep Security from your NSX
environment" on page 1331.
Step 3: Redeploy the Deep Security Virtual Appliance
After completely removing Deep Security from NSX, you'll need to redeploy the Deep Security
Virtual Appliance. To redeploy, follow all the steps in "Deploy the appliance (NSX-V)" on
page 341.
You can now use the Firewall, Intrusion Prevention, and Web Reputation features, and you can
continue to use the Anti-Malware and Integrity Monitoring features, which were available to you
previously.
Uninstall Deep Security
Uninstall Deep Security
When you manually uninstall an activated agent or relay from a computer, the computer doesn't
notify Deep Security Manager that the software has been uninstalled. On the Computers page in
Deep Security Manager, the computer's status will be "Managed (Offline)" or similar, depending
on the context. To avoid this, on Deep Security Manager, either:
l Deactivate the agent or relay before you uninstall it, or
l Delete the computer from the list after you uninstall
Uninstall Deep Security Relay
A Deep Security Relay is an agent where you have enabled the relay feature, so in order to
remove the relay, you must uninstall the agent software.
Uninstall a relay (Windows)
Note: Before updating or uninstalling a Deep Security agent or relay on Windows, you must
disable agent self-protection. To do this, on the Deep Security Manager, go to Computer
1326
Trend Micro Deep Security On-Premise 20
editor 1 > Settings > General. In Agent Self Protection, and then either deselect Prevent local
end-users from uninstalling, stopping, or otherwise modifying the Agent or enter a password
for local override.
From the Windows Control Panel, select Add/Remove Programs. Double-click Trend Micro
Deep Security Agent, and click Remove.
Alternatively, you can uninstall from the command line:
msiexec /x <package name including extension>
For a silent uninstall, add /quiet.
Uninstall a relay (Linux)
To completely remove the relay and any configuration files it created on a platform that uses the
Red Hat package manager (rpm), such as CentOS, Amazon Linux, Oracle Linux, SUSE, or
Cloud Linux, enter the command:
# sudo rpm -ev ds_agent
Stopping ds_agent: [ OK ]
Unloading dsa_filter module [ OK ]
If iptables was enabled prior to the installation of the relay-enabled agent, it will be re-enabled
when the relay-enabled agent is uninstalled.
Note: Remember to remove the relay-enabled agent from Deep Security Manager's list of
managed computers, and to remove it from the relay group.
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
1327
Trend Micro Deep Security On-Premise 20
Uninstall Deep Security Agent
Uninstall an agent (Windows)
Note: Before updating or uninstalling a Deep Security Agent or Relay on Windows, you must
disable agent self-protection. To do this, on the Deep Security Manager, go to Computer
editor 1 > Settings > General. In Agent Self Protection, and then either deselect Prevent local
end-users from uninstalling, stopping, or otherwise modifying the Agent or enter a password
for local override.
1. Deactivate the agent using the Deep Security Manager by going to the Computers page,
right-clicking the computer and selecting Actions > Deactivate.
If you are unable to deactivate the agent because the Deep Security Manager is unable to
communicate with the agent, you will need to do the following before continuing to the next
step:
C:\Program Files\Trend Micro\Deep Security Agent>dsa_control --
selfprotect 0
2. Go to the Control Panel and select Uninstall a program. Look for the Trend Micro Deep
Security Agent and then select Uninstall.
Alternatively, you can uninstall from the command line:
msiexec /x <package name including extension>
For a silent uninstall, add /quiet.
Uninstall an agent (Linux)
If your version of Linux provides a graphical package management tool, you can search for the
ds_agent package and use the tool remove the package. Otherwise, use the command line
instructions below.
To completely remove the agent and any configuration files it created on a platform that uses the
Red Hat package manager (rpm), such as CentOS, Amazon Linux, Oracle Linux, SUSE, or
Cloud Linux, enter the command:
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and
click Details).
1328
Trend Micro Deep Security On-Premise 20
# sudo rpm -ev ds_agent
Stopping ds_agent: [ OK ]
Unloading dsa_filter module [ OK ]
If iptables was enabled prior to installing Deep Security Agent, it will be re-enabled when the
agent is uninstalled.
If the platform uses Debian package manager (dpkg), such as Debian and Ubuntu, enter the
command:
$ sudo dpkg -r ds-agent
Removing ds-agent...
Stopping ds_agent: .[OK]
Uninstall an agent (Solaris 10)
Enter the command:
pkgrm ds-agent
(Note that uninstall may require a reboot.)
Uninstall an agent (Solaris 11)
Enter the command:
pkg uninstall ds-agent
Uninstall may require a reboot.
Uninstall an agent (AIX)
Enter the command:
installp -u ds_agent
Uninstall Deep Security Notifier
From the Windows Control Panel, select Add/Remove Programs. Double-click Trend Micro
Deep Security Notifier, and click Remove.
To uninstall from the command line:
msiexec /x <package name including extension>
1329
Trend Micro Deep Security On-Premise 20
For a silent uninstall, add /quiet.
Uninstall Deep Security Manager
Uninstall the manager (Windows)
From the Windows Start Menu, go to Trend Micro > Trend Micro Deep Security Manager
Uninstaller, and follow the wizard steps to complete the uninstallation.
To initiate the same Windows GUI uninstall procedure from the command line, go to the
installation folder and enter:
<installation folder>\Uninstall.exe
For a silent uninstall from the command line (without the Windows GUI prompts), add -q.
<installation folder>\Uninstall.exe -q
During a silent uninstall via command line, the configuration files are kept so that if you re-install
in future, the installer repairs or upgrades using existing settings, without asking you to input
them again.
Uninstall the manager (Linux)
To uninstall via command line, go to the installation folder and enter:
sudo ./uninstall
For a silent uninstall, add -q .
During a silent uninstall via command line, by default, the configuration files are kept so that if
you re-install in future, the installer repairs upgrades using existing settings, without asking you
to input them again.
If you selected not to keep the configuration files during the uninstallation, and you later want to
reinstall Deep Security Manager, you should perform a manual clean-up before reinstalling. To
remove the Deep Security Manager installation directory enter the command:
sudo rm -rf <installation location>
The default installation location is /opt/dsm.
1330
Trend Micro Deep Security On-Premise 20
Uninstall Deep Security from your NSX environment
Uninstalling Deep Security from your NSX environment removes the Deep Security Virtual
Appliance from NSX Data Center for vSphere (NSX-V) or NSX-T. It also uninstalls all the related
history from Deep Security Manager.
Topics on this page:
l "Uninstall Deep Security automatically" below
l "Uninstall Deep Security from NSX-T 3.x manually" on page 1333
l "Uninstall Deep Security from NSX-V manually" on page 1339
Uninstall Deep Security automatically
1. In Deep Security Manager, go to Computers.
2. In the navigation tree on the left, right-click the vCenter and select Remove VMware
vCenter.
3. Select one of these options:
l Remove VMware vCenter and all subordinate computers/groups from DSM:
Removes vCenter and all records of the VMs including the Deep Security policies and
rules assigned to them.
l Remove VMware vCenter but retain computer data and Group hierarchy: Removes
vCenter but retains its hierarchical structure and the records of the VMs including the
Deep Security Policies and Rules assigned to them.
l Remove VMware vCenter, retain computer data, but flatten hierarchy: Removes
vCenter but retains the records of the VMs including the Deep Security policies and
rules assigned to them. The hierarchical structure of the vCenter is flattened to a single
group.
1331
Trend Micro Deep Security On-Premise 20
4. After selecting an option, click Next.
5. Click Next again to proceed with the removal.
Assuming you selected the first option, Remove VMware vCenter and all subordinate
computers/groups from DSM, all Deep Security Virtual Appliances and NSX policies are
removed automatically from your NSX environment.
A success message is displayed indicating VMware vCenter was removed
successfully.
Note: If Deep Security Manager has lost connectivity with the NSX Manager, you may
see an error stating Unable to remove Deep Security from VMware. If this error
occurs, you must remove Deep Security service from NSX Manager manually. See the
next section for details.
1332
Trend Micro Deep Security On-Premise 20
Uninstall Deep Security from NSX-T 3.x manually
Note: Make sure POLICY is selected at the top-right of NSX-T Manager so that you're able to
see the user interface elements described in the procedures below.
First, delete the Deep Security Virtual Appliance service deployment:
1. In NSX-T Manager, go to System > Service Deployments > DEPLOYMENT.
2. From the Partner Service drop-down list, select Trend Micro Deep Security. A service
deployment appears, if it is not already visible.
3. Click the three dots next to the service deployment name and then select Delete.
Next, under Endpoint Protection, delete the Deep Security Virtual Appliance policy and service
profile:
1333
Trend Micro Deep Security On-Premise 20
1. Click Security > Endpoint Protection > RULES.
2. Click the three dots next to the Deep Security Virtual Appliance policy and click Delete
Policy.
3. Click Publish to have the changes take effect. The policy and associated rule are deleted.
1334
Trend Micro Deep Security On-Premise 20
4. click System > Endpoint Protection > SERVICE PROFILES.
5. Click the three dots next to the service profile and select Delete.
(Only applicable to NSX-T 3.x) Next, under Network Introspection, delete the Deep Security
Virtual Appliance artifacts:
1. In NSX-T Manager 3.x, click Security, toggle to POLICY, and on the left, click Network
Introspection (E-W).
1335
Trend Micro Deep Security On-Premise 20
2. Select the Deep Security Virtual Appliance policy and then click Delete.
3. Click PUBLISH to have the changes take effect.
4. On the left, under Settings, click Network Introspection Settings.
5. In the main pane, click SERVICE CHAINS.
6. Click the three dots next to the Deep Security Virtual Appliance service chain and click
Delete.
1336
Trend Micro Deep Security On-Premise 20
1337
Trend Micro Deep Security On-Premise 20
7. In the main pane, click SERVICE PROFILES.
8. Click the three dots next to the Deep Security Virtual Appliance service profile and select
Delete.
You have now deleted the Deep Security Virtual Appliance policy, service chain, and
service profile under Network Introspection.
Finally, delete vCenter from Deep Security Manager:
1338
Trend Micro Deep Security On-Premise 20
1. In Deep Security Manager, click Computers.
2. Right-click your vCenter on the left and click Remove VMware vCenter.
A wizard appears. For a description of the options in this wizard, see "Uninstall Deep
Security automatically" on page 1331.
You have now manually removed Deep Security from your NSX-T environment.
Uninstall Deep Security from NSX-V manually
This section applies to NSX-V environments only. For NSX-T instructions, see "Uninstall Deep
Security from NSX-T 3.x manually" on page 1333.
If you tried to remove vCenter from Deep Security Manager using the steps in "Uninstall Deep
Security automatically" on page 1331, and you saw an error stating Unable to remove Deep
Security from VMware, it may be because Deep Security Manager lost connectivity with
NSX Manager. If this error occurs, you must remove Deep Security from NSX Manager
manually.
First, remove the NSX Manager from Deep Security Manager
1. In Deep Security Manager, go to Computers.
2. In the navigation tree on the left, right-click the vCenter and select Properties.
3. On the NSX Manager tab, click Remove NSX Manager.
4. Click OK.
Next, remove the Trend Micro service on NSX Manager
1. In the vSphere Web Client, go to Home > Networking and Security > Service Composer >
Security Policies.
Delete the Deep Security security policies.
1339
Trend Micro Deep Security On-Premise 20
2. Go to Home > Networking and Security > Installation > Service Deployments.
Delete the Trend Micro Deep Security service deployment.
3. Go to Home > Networking and Security > Service Definitions > Service Managers.
1340
Trend Micro Deep Security On-Premise 20
Select Deep Security Service Manager and click the pencil icon. Deselect Operational
State.
4. Go to Home > Networking and Security > Service Definitions > Services.
1341
Trend Micro Deep Security On-Premise 20
Click Trend Micro Deep Security and click the pencil icon.
5. In the left navigation pane, click Service Instances, and then click Trend Micro Deep
Security-GlobalInstance, also on the left.
In the main pane, select Default (EBT) and click Delete to remove the service profile.
6. In the left navigation pane, click Service Instances.
In the main pane, click Trend Micro Deep Security-GlobalInstance and click Delete to
remove the service instance.
1342
Trend Micro Deep Security On-Premise 20
7. Select the Trend Micro Deep Security service definition and click the delete icon at the
very top to remove it.
Finally, delete vCenter from Deep Security Manager:
1343
Trend Micro Deep Security On-Premise 20
1. In Deep Security Manager, click Computers.
2. Right-click your vCenter on the left and click Remove VMware vCenter.
A wizard appears. For a description of the options in this wizard, see "Uninstall Deep
Security automatically" on page 1331.
You have now manually removed Deep Security from your NSX-V environment.
Configure Deep Security Manager memory usage
Configuring the installer's maximum memory usage
The installer is configured to use 1GB of contiguous memory by default. If the installer fails to run
you can try configuring the installer to use less memory.
1. Go to the directory where the installer is located.
2. Create a new text file called "Manager-Windows-xx.x.xxxx.x64.exe.vmoptions" or
"Manager-Linux-xx.x.xxxx.x64.sh.vmoptions", depending on your installation platform
(where "xx.x.xxxx" is the build number of the installer).
3. Edit the file by adding the line: "-Xmx800m" (in this example, 800MB of memory will be
made available to the installer.)
4. Save the file and launch the installer.
Configuring Deep Security Manager's maximum memory
usage
The Deep Security Manager default setting for memory allocated to the Manager JVM process is
4GB. It is possible to change this setting.
1. Go to the Deep Security Manager install directory (the same directory as Deep Security
Manager executable).
2. Create a new file. Depending on the platform, give it the following name:
l Windows: "Deep Security Manager.vmoptions".
l Linux: "dsm_s.vmoptions".
3. Edit the file by adding the line: " -Xmx10g " (in this example, "10g" will make 10GB
memory available to the Deep Security Manager.)
4. Save the file and restart the Deep Security Manager.
1344
Trend Micro Deep Security On-Premise 20
5. You can verify the new setting by going to Administration > System Information and in the
System Details area, expand Manager Node > Memory. The Maximum Memory value
should now indicate the new configuration setting.
Restart the Deep Security Manager
Linux
To restart the Deep Security Manager, open a CLI and run the following command:
sudo systemctl restart dsm_s
Windows
To restart the Deep Security Manager, first log in to the Windows instance on which the Deep
Security Manager is running and then follow the steps below for the "Windows desktop" below,
the "Command prompt" below or "PowerShell" below:
Windows desktop
1. Open the Windows Task Manager.
2. Click the Services tab.
3. Right click the Trend Micro Deep Security Manager service, and then click Restart.
Command prompt
Open the command prompt (cmd.exe) and run the following commands:
1. net stop "Trend Micro Deep Security Manager"
2. net start "Trend Micro Deep Security Manager"
PowerShell
Open PowerShell and run the following commands:
1. Stop-Service 'Trend Micro Deep Security Manager'
2. Start-Service 'Trend Micro Deep Security Manager'
1345
Trend Micro Deep Security On-Premise 20
Check your license information
Note: Does not apply to a multi-tenant configuration that inherits licensing from the parent
tenant.
Displays details about your Trend Micro Deep Security product licenses. Deep Security consists
of six module packages:
l Anti-Malware and Web Reputation
l Firewall and Intrusion Prevention
l Integrity Monitoring and Application Control
l Log Inspection
l Multi-Tenancy
l Deep Security Scanner
Each module package can be licensed fully or for a trial basis. You can see an individual
package's license status by clicking View Details. Contact Trend Micro if you wish to upgrade
your license. If Trend Micro has provided you with a new activation code, click Enter New
Activation Code and enter it there. Newly licensed features are immediately available.
When a license expires, existing functionality persists but updates are no longer delivered.
Alerts are raised if any module is about to expire or has expired.
DevOps, automation, and APIs
About DevOps, automation, and APIs
To support DevOps workflows, Deep Security offers APIs to automate, monitor, and manage
security throughout the release lifecycle. (See "Use the Deep Security API to automate tasks" on
page 1376.)
The Trend Micro Hybrid Cloud Security Command Line Interface (THUS) is a tool that can help
you easily navigate the API. For more information, see https://github.com/trendmicro/thus.
The deep-security GitHub repositories contain the following useful scripts:
1346
Trend Micro Deep Security On-Premise 20
l CloudFormation templates for deploying Deep Security Manager to AWS.
l Configuration files that contain parsing logic, saved searches, and dashboards for
monitoring Deep Security via Splunk.
l Bash and Powershell scripts for automating various Agent and Manager tasks.
To get started with the API, see the First Steps Toward Deep Security Automation guide in the
Deep Security Automation Center. The Automation Center also includes an API Reference.
Deep Security also offers many other ways to speed up the protection of your computers and
other resources:
l "Schedule Deep Security to perform tasks" on page 1378
l "Automatically perform tasks when a computer is added or changed (event-based tasks)"
on page 1381
l "AWS Auto Scaling and Deep Security" on page 1386
l "Use deployment scripts to add and protect computers" on page 1401
l "Automatically assign policies by AWS instance tags" on page 1413
l "Command-line basics" on the next page
In addition, Deep Security provides the ability to forward events to SIEMs such as Spunk,
QRadar, ArcSight, as well as Amazon SNS. For details, see:
l "Forward Deep Security events to a Syslog or SIEM server" on page 846
l "Set up Amazon SNS" on page 908
Trend Micro Hybrid Cloud Security Command Line
Interface (THUS)
Trend Micro Hybrid Cloud Security Command Line Interface (THUS) is a tool that you can use to
help deploy, configure and maintain your Deep Security environments. THUS is easy to install
and configure, all from your terminal.
For more information about setting up the Trend Micro Hybrid Cloud Security Command Line
Interface (THUS), see https://github.com/trendmicro/thus.
1347
Trend Micro Deep Security On-Premise 20
Command-line basics
You can use the local command-line interface (CLI) to command both Deep Security Agents and
the Deep Security Manager to perform many actions. The CLI can also configure some settings,
and to display system resource usage.
Tip: You can also automate many of the CLI commands below using the Deep Security API.
To get started with the API, see the First Steps Toward Deep Security Automation guide in the
Deep Security Automation Center.
Below are the CLI commands:
l "dsa_control" below
l "dsa_query" on page 1363
l "dsm_c" on page 1365
dsa_control
You can use dsa_control to configure some agent settings, and to manually trigger some
actions such as activation, anti-malware scans, and baseline rebuilds.
Note: On Windows, when self-protection is enabled, local users cannot uninstall, update, stop,
or otherwise control the agent. They must also supply the authentication password when
running CLI commands.
Note: Dsa_control only supports English strings. Unicode is not supported.
To use dsa_control:
In Windows:
1. Open a Command Prompt as Administrator.
2. Change to the agent's installation directory. For example:
cd C:\Program Files\Trend Micro\Deep Security Agent\
3. Run dsa_control:
dsa_control <option>
1348
Trend Micro Deep Security On-Premise 20
where <option> is replaced with one of the options described in "dsa_control
options" below
In Linux:
l sudo /opt/ds_agent/dsa_control <option>
where <option> is replaced with one of the options described in "dsa_control
options" below
dsa_control options
dsa_control [-a <str>] [-b] [-c <str>] [-d] [-g <str>] [-s <num>] [-m] [-p
<str>] [-r] [-R <str>] [-t <num>] [-u <str>:<str>] [-w <str>:<str>] [-x
dsm_proxy://<str>] [-y relay_proxy://<str>] [--buildBaseline] [--
scanForChanges] [Additional keyword:value data to send to manager during
activation or heartbeat...]
Parameter Description
Activate agent with manager at the specified URL in this format:
dsm://<host>:<port>/
where:
l <host> could be either the manager's fully qualified domain
name (FQDN), IPv4 address, or IPv6 address
l <port> is the manager's listening port number
-a <str>, --
activate=<str>
Optionally, after the argument, you can also specify some settings
such as the description to send during activation. See "Agent-
initiated heartbeat command ("dsa_control -m")" on page 1353.
They must be entered as key:value pairs (with a colon as a
separator). There is no limit to the number of key:value pairs that
you can enter, but the key:value pairs must be separated from
each other by a space. Quotation marks around the key:value
pair are required if it includes spaces or special characters.
-b, --bundle Create an update bundle.
1349
Trend Micro Deep Security On-Premise 20
Parameter Description
-c <str>, --
Identify the certificate file.
cert=<str>
Generate an agent package. For more detailed instructions, see
-d, --diag "Create an agent diagnostic package via CLI on a protected
computer" on page 1553.
Agent URL. Defaults to:
-g <str>, --
https://localhost:<port>/
agent=<str>
where <port> is the manager's listening port number.
-m, --heartbeat Force the agent to contact the manager now.
Authentication password that you might have configured in Deep
Security Manager previously. See "Configure self-protection
through Deep Security Manager" on page 1144 for details. If
configured, the password must be included with all dsa_control
commands except dsa_control -a, dsa_control -x, and
dsa_control -y.
-p <str> or -- Example: dsa_control -m -p MyPa$$w0rd
passwd=<str>
If you type the password directly into the command line, it is
displayed on the screen. To hide the password with asterisks (*)
while you type, enter the interactive form of the command, -p *,
which prompts you for the password.
Example:
dsa_control -m -p *
-r, --reset
Reset the agent's configuration. This will remove the activation
information from the agent and deactivate it.
-R <str>, -- Restore a quarantined file. On Windows, you can also restore
restore=<str> cleaned and deleted files.
-s <num>, -- Enable agent self-protection (1: enable, 0: disable). Self-
1350
Trend Micro Deep Security On-Premise 20
Parameter Description
protection prevents local end-users from uninstalling, stopping, or
otherwise controlling the agent. For details, see "Enable or
disable agent self-protection" on page 1143. This is a Windows-
only feature.
Note: Although dsa_control lets you enable self-protection, it
does not let you configure an associated authentication
selfprotect=<num> password. You'll need Deep Security Manager for that. See
"Configure self-protection through Deep Security Manager" on
page 1144 for details. Once configured, the password will need
to be entered at the command line using the -p or --passwd=
option.
Note: In Deep Security 9.0 and earlier, this option was -H
<num>, --harden=<num>
If dsa_control cannot contact the agent service to carry out
-t <num>, -- accompanying instructions, this parameter instructs dsa_control
retries=<num> to retry <num> number of times. There is a 1 second pause
between retries.
Used in conjunction with the -x option to specify the proxy's user
name and password, if the proxy requires authentication.
Separate the user name and password by a colon (:). To remove
the user name and password, type an empty string (""). If you
-u only want to update the proxy's password without changing the
<user>:<password> proxy's user name, you can use the -u option without -x. Basic
authentication only. Digest and NTLM are not supported.
Note: Using dsa_control -u only applies to the agent's local
configuration. No security policy is changed on the manager as a
result of running this command.
Used in conjunction with the -y option to specify the proxy's user
-w
name and password, if the proxy requires authentication.
<user>:<password>
Separate the user name and password by a colon (:). To remove
1351
Trend Micro Deep Security On-Premise 20
Parameter Description
the user name and password, type an empty string (""). If you
only want to update the proxy's password without changing the
proxy's user name, you can use the -w option without -y.
Note: Using dsa_control -w only applies to the agent's local
configuration. No security policy is changed on the manager as a
result of running this command.
Configure a proxy between the agent and manager. Provide the
proxy's IPv4/IPv6 address or FQDN and port number, separated
by a colon (:). Square brackets must surround IPv6 addresses.
For example: dsa_control -x "dsm_proxy://
[fe80::340a:7671:64e7:14cc]:808/". To remove the
address, instead of a URL, type an empty string ("").
-x dsm_ See also the -u option.
proxy://<str>:<num>
For more information, see "Connect to Deep Security Manager
via proxy" on page 1082.
Note: Using dsa_control -x only applies to the agent's local
configuration. No security policy is changed on the manager as a
result of running this command.
Configure a proxy between an agent and relay. Provide the
proxy's IP address or FQDN and port number, separated by a
colon (:). Square brackets must surround IPv6 addresses. For
example: dsa_control -y "relay_proxy://
[fe80::340a:7671:64e7:14cc]:808/". To remove the
address, instead of a URL, type an empty string ("").
-y relay_ See also the -w option.
proxy://<str>:<num>
For more information, see "Connect to Deep Security Relays via
proxy" on page 1084.
Note: Using dsa_control -y only applies to the agent's local
configuration. No security policy is changed on the manager as a
result of running this command.
--buildBaseline Build the baseline for Integrity Monitoring.
1352
Trend Micro Deep Security On-Premise 20
Parameter Description
--scanForChanges Scan for changes for Integrity Monitoring.
--max-dsm-retries
Number of times to retry an activation. Valid values are 0 to 100,
inclusive. The default value is 30.
--dsm-retry- Approximate delay in seconds between retrying activations. Valid
interval values are 1 to 3600, inclusive. The default value is 300.
Agent-initiated activation ("dsa_control -a")
Enabling agent-initiated activation (AIA) can prevent communication issues between the
manager and agents, and simplify agent deployment when used with deployment scripts.
Note: For instructions on how to configure AIA and use deployments scripts to activate agents,
see "Activate and protect agents using agent-initiated activation and communication" on
page 1138.
The command takes the form
dsa_control -a dsm://<host>:<port>/
where:
l <host> could be either the manager's fully qualified domain name (FQDN), IPv4 address,
or IPv6 address.
l <port> is the agent-to-manager communication port number (4120 by default).
For example:
dsa_control -a dsm://dsm.example.com:4120/ hostname:www12
"description:Long Description With Spaces"
dsa_control -a dsm://fe80::ad4a:af37:17cf:8937:4120
Agent-initiated heartbeat command ("dsa_control -m")
You can force the agent to immediately send a heartbeat to the manager.
1353
Trend Micro Deep Security On-Premise 20
Like activation, the heartbeat command can also send settings to the manager during the
connection.
Use Use
during during
Parameter Description Example
Activat Heartb
ion eat
Boolean.
Cancels an
on-demand
AntiMalwareCancelManu ("manual") sca "AntiMalwareCancelManualSc
no yes
alScan an:true"
n that is
currently
occurring on
the computer.
Boolean.
Initiates an on-
demand "AntiMalwareManualScan:tru
AntiMalwareManualScan
("manual") ant e" no yes
i-malware
scan on the
computer.
String.
Sets the
computer's "description:Extra
description
description. information about the yes yes
host"
Maximum
length 2000
characters.
String.
Sets the
display name
displayname shown in "displayname:the_name" yes yes
parentheses
next to the
hostname on
Computers.
1354
Trend Micro Deep Security On-Premise 20
Use Use
during during
Parameter Description Example
Activat Heartb
ion eat
Maximum
length 2000
characters.
Integer.
Sets the
externalid
value. This
value can be
used to
uniquely
externalid
identify an "externalid:123" yes yes
agent. The
value can be
accessed
using the
legacy SOAP
web service
API.
String.
Sets which
group the
computer
belongs to on
Computers.
Maximum
group length 254 "group:Zone A web servers" yes yes
characters per
group name
per hierarchy
level.
The forward
1355
Trend Micro Deep Security On-Premise 20
Use Use
during during
Parameter Description Example
Activat Heartb
ion eat
slash ("/")
indicates a
group
hierarchy. The
group
parameter can
read or create
a hierarchy of
groups.
This
parameter can
only be used
to add
computers to
standard
groups under
the main
"Computers"
root branch. It
cannot be
used to add
computers to
groups
belonging to
directories
(Microsoft
Active
Directory),
VMware
vCenters, or
cloud provider
accounts.
groupid Integer. "groupid:33" yes yes
hostname String. "hostname:www1" yes no
1356
Trend Micro Deep Security On-Premise 20
Use Use
during during
Parameter Description Example
Activat Heartb
ion eat
Maximum
length 254
characters.
The hostname
can specify an
IP address,
hostname or
FQDN that the
manager can
use to connect
to the agent.
Boolean.
Initiates an
IntegrityScan
integrity scan "IntegrityScan:true" no yes
on the
computer.
String.
Maximum
length 254
characters.
The policy
name is a
case-
policy "policy:Policy Name" yes yes
insensitive
match to the
policy list. If
the policy is
not found, no
policy will be
assigned.
1357
Trend Micro Deep Security On-Premise 20
Use Use
during during
Parameter Description Example
Activat Heartb
ion eat
A policy
assigned by
an event-
based task will
override a
policy
assigned
during agent-
initiated
activation.
policyid Integer. "policyid:12" yes yes
String.
Links the
computer to a
specific relay
group.
Maximum
length 254
characters.
The relay
group name is "relaygroup:Custom Relay
relaygroup yes yes
a case- Group"
insensitive
match to
existing relay
group names.
If the relay
group is not
found, the
default relay
group will be
used.
1358
Trend Micro Deep Security On-Premise 20
Use Use
during during
Parameter Description Example
Activat Heartb
ion eat
This does not
affect relay
groups
assigned
during event-
based tasks.
Use either this
option or
event-based
tasks, not
both.
relaygroupid Integer. "relaygroupid:123" yes yes
relayid Integer. "relayid:123" yes yes
String.
If using agent-
initiated
activation as a
tenant, both
tenantID and "tenantID:12651ADC-D4D5"
token are
tenantIDand token required. The and yes yes
tenantID and
token can be "token:8601626D-56EE"
obtained from
the
deployment
script
generation
tool.
Boolean.
RecommendationScan Initiate a "RecommendationScan:true" no yes
recommendati
1359
Trend Micro Deep Security On-Premise 20
Use Use
during during
Parameter Description Example
Activat Heartb
ion eat
on scan on the
computer.
Boolean.
Instructs Deep
Security
Manager to
perform a
security
update.
When using
the
UpdateCompo
UpdateComponent "UpdateComponent:true" no yes
nent
parameter on
Deep Security
Agent 12.0 or
later, make
sure the Deep
Security Relay
is also at
version 12.0 or
later. Learn
more.
Boolean.
Rebuilds the
RebuildBaseline Integrity "RebuildBaseline:true" no yes
Monitoring
baseline on
the computer.
Boolean.
UpdateConfiguration Instructs Deep "UpdateConfiguration:true" no yes
Security
1360
Trend Micro Deep Security On-Premise 20
Use Use
during during
Parameter Description Example
Activat Heartb
ion eat
Manager to
perform a
"Send Policy"
operation.
Activate an agent
To activate an agent from the command line, you need to know the tenant ID and password. You
can get them from the deployment script.
1. In the top right corner of Deep Security Manager, click Support > Deployment Scripts.
2. Select your platform.
3. Select Activate Agent automatically after installation.
4. In the deployment script, locate the strings for tenantID and token.
Windows
In PowerShell:
& $Env:ProgramFiles"\Trend Micro\Deep Security Agent\dsa_control" -a
<manager URL> <tenant ID> <token>
In cmd.exe:
C:\Windows\system32>"\Program Files\Trend Micro\Deep Security Agent\dsa_
control" -a <manager URL> <tenant ID> <token>
Linux
/opt/ds_agent/dsa_control -a <manager URL> <tenant ID> <token>
Force the agent to contact the manager
Windows
In PowerShell:
& "\Program Files\Trend Micro\Deep Security Agent\dsa_control" -m
In cmd.exe:
1361
Trend Micro Deep Security On-Premise 20
C:\Windows\system32>"\Program Files\Trend Micro\Deep Security Agent\dsa_
control" -m
Linux
/opt/ds_agent/dsa_control -m
Initiate a manual anti-malware scan
Windows
1. Open a command prompt (cmd.exe) as Administrator.
2. Enter these commands:
cd C:\Program Files\Trend Micro\Deep Security Agent\
dsa_control -m "AntiMalwareManualScan:true"
Linux
/opt/ds_agent/dsa_control -m "AntiMalwareManualScan:true"
Create a diagnostic package
If you need to troubleshoot a Deep Security Agent issue, your support provider might ask you to
create and send a diagnostic package from the computer. For more detailed instructions, see
"Create an agent diagnostic package via CLI on a protected computer" on page 1553.
Note: You can produce a diagnostic package for a Deep Security Agent computer through the
Deep Security Manager but if the agent computer is configured to use Agent/Appliance
Initiated communication, then the manager cannot collect all the required logs. So when
Technical Support asks for a diagnostic package, you need to run the command directly on the
agent computer.
Reset the agent
This command will remove the activation information from the target agent and deactivate it.
Windows
In PowerShell:
& "\Program Files\Trend Micro\Deep Security Agent\dsa_control" -r
1362
Trend Micro Deep Security On-Premise 20
In cmd.exe:
C:\Windows\system32>"\Program Files\Trend Micro\Deep Security Agent\dsa_
control" -r
Linux
/opt/ds_agent/dsa_control -r
dsa_query
You can use the dsa_query command to display agent information.
dsa_query options
dsa_query [-c <str>] [-p <str>] [-r <str]
Parameter Description
Authentication password used with the optional agent self-protection feature.
-p,-- Required if you specified a password when enabling self-protection.
passwd
<string>
Note: For some query-commands, authentication can be bypassed directly,
in such case, password is not required.
Execute query-command against the agent. The following commands are
supported:
l "GetHostInfo": to query which identity is returned to the manager during
a heartbeat
l "GetAgentStatus": to query which protection modules are enabled, the
-c,--cmd
status of Anti-Malware or Integrity Monitoring scans in progress, and other
<string>
miscellaneous information
l "GetComponentInfo": to query version information of anti-malware
patterns and engines
l "GetPluginVersion": to query version information of the agent and
protection modules
-r,--raw Returns the same query-command information as "-c" but in raw data format
<string> for third party software interpretation.
1363
Trend Micro Deep Security On-Premise 20
Parameter Description
Wild card pattern to filter result. Optional.
pattern
Example:
dsa_query -c "GetComponentInfo" -r "au" "AM*"
Check CPU usage and RAM usage
Windows
Use the Task Manager or procmon.
Linux
top
Check that ds_agent processes or services are running
Windows
Use the Task Manager or procmon.
Linux
ps -ef|grep ds_agent
Restart an agent on Linux
service ds_agent restart
or
/etc/init.d/ds_agent restart
or
systemctl restart ds_agent
1364
Trend Micro Deep Security On-Premise 20
Some actions require either a -tenantname parameter or a -tenantid parameter. If execution
problems occur when you use the tenant name, try the command using the associated tenant ID.
dsm_c
You can use the dsm_c command to configure some settings on the manager, and to unlock user
accounts.
Note: Some commands may cause the Deep Security Manager to restart. Once the
commands have been run, ensure the Deep Security Manager has started up again.
dsm_c options
dsm_c -action actionname
Tip: To print help on the command, use the -h option: dsm_c -h
Note: All of the parameters shown in brackets in the table below are mandatory.
Some actions require either a -tenantname parameter or a -tenantid parameter. If execution
problems occur when you use the tenant name, try the command using the associated tenant ID.
Action Name Description Usage
Add an Azure
endpoint to the
allowed endpoint
list. This command
requires an
ENDPOINT
parameter that dsm_c -action addazureendpoint -
addazureendpoint
must be specified endpoint ENDPOINT
in the format
https://<fqdn>.
The allowed
endpoint list is
used to validate
endpoints that are
1365
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
specified when
adding an Azure
account to Deep
Security Manager.
If you do not
specify any
endpoints, then
only the default
built-in endpoints
are allowed.
For more on
adding an Azure
account, see "Add
a Microsoft Azure
account to Deep
Security" on
page 416.
Related dsm_c
options:
listazureendpo
int and
removeazureend
point
Add a trusted dsm_c -action addcert -purpose
addcert
certificate. PURPOSE -cert CERT
Add a private dsm_c -action addregion -region
addregion cloud provider REGION -display DISPLAY -endpoint
region. ENDPOINT
dsm_c -action changesetting -name
Change a setting. NAME [-value VALUE | -valuefile
FILENAME] [-computerid COMPUTERID] [-
changesetting Warning: Back computername COMPUTERNAME] [-policyid
POLICYID] [-policyname POLICYNAME] [-
tenantname TENANTNAME | -tenantid
1366
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
up your
deployment
before running
the command.
Don't use this
command unless
you understand
the effects of the
setting. Some
misconfiguratio
ns can make
your service
unavailable, or
your data
unreadable.
Usually, you TENANTID]
should only use
this command if
requested by
your technical
support provider,
who will tell you
which setting
NAME to change.
Sometimes this
command is
required during
normal use. If so,
the setting will
be described in
that section of
1367
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
the
documentation,
such as
masterkey.
dsm_c -action createinsertstatements
Create insert
statements (for [-file FILEPATH] [-generateDDL] [-
createinsertstate
export to a databaseType sqlserver|oracle] [-
ments different maxresultfromdb count] [-tenantname
database). TENANTNAME | -tenantid TENANTID]
Create a
diagnostic
package for the
system.
Note: If needed,
dsm_c -action diagnostic [-verbose
you can
diagnostic 0|1] [-tenantname TENANTNAME | -
"Increase tenantid TENANTID]
verbose
diagnostic
package process
memory" on
page 1554.
Give an dsm_c -action fullaccess -username
fullaccess administrator the USERNAME [-tenantname TENANTNAME | -
full access role. tenantid TENANTID]
List all allowed
Azure endpoints.
listazureendpoint Related dsm_c dsm_c -action listazureendpoint
options:
addazureendpoi
1368
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
nt and
removeazureend
point
List trusted dsm_c -action listcerts [-purpose
listcerts
certificates. PURPOSE]
listregions
List private cloud dsm_c -action listregions
provider regions.
If you already configured a master key during
Generate, import, a new install, the installer has completed this
export, or use a setup for you. If you skipped master key
custom master key creation, and want to configure one now, start
to encrypt the: with the commands in step 1. Enter all
commands in order. To generate a new
l database
master key, start with the commands in step 1
password
and enter all commands in order.
l keystore
password See also "Install the manager" on page 211
l personal for details on the master key, how it is
data generated, and what it encrypts.
If you configured the master key during an
masterkey Note: If a upgrade, back up your database and
custom master properties files, and then start with the
key is not commands in step 4.
configured, 1. dsm_c -action masterkey -
Deep Security subaction [generatekmskey -arn
will use a hard- AWSARN | generatelocalkey] —
coded seed, and Generate the master key using either
the Amazon Resource Name (ARN) of
personal data
a Key Management System (KMS) key,
will not be
or a local environment variable named
encrypted by LOCAL_KEY_SECRET. If using the local
default. environment variable on a multi-node
Deep Security Manager, it must be
1369
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
configured on all nodes at the system-
level (not user-level), and must include,
at a minimum:
l a capital letter
l a lower cased letter
l a number
l a special character
l 8-64 characters
Note: Permissions and reliable
network access to KMS or LOCAL_
KEY_SECRET are required by Deep
Security Manager if you configure the
master key. The manager uses them
to encrypt and decrypt the master key
during use. If they temporarily cannot
be reached, Deep Security Manager
will be unable to decrypt required
data, and the service will be
unavailable. Symptoms can include
intermittent event logs and alerts for
restart failures and various other
errors.
2. dsm_c -action masterkey -
subaction export -file FILEPATH
— Export the master key to a password-
encrypted file for backup. You will be
prompted for the password.
Warning: Back up the master key by
exporting it to a safe location. If the
1370
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
master key is lost or destroyed, and
you do not have a backup, all
encrypted data will be unreadable. If
that happens, you must reinstall Deep
Security Manager, all relays, and all
agents/appliances. If the key is stolen,
security of your Deep Security
deployment is compromised. Some
compliance regulations such as
General Data Protection Regulation
(GDPR) in Europe may require you by
law to notify law enforcement of
personal data breaches within 72
hours, and noncompliance can result
in fines. Consult your lawyer for more
information.
To verify your backup for disaster
recovery, you can test it by importing the
master key:
dsm_c -action masterkey -
subaction [importkmskey -file
FILEPATH -arn AWSARN |
importlocalkey -file FILEPATH] —
Import a backup of the master key. This
can be useful either for disaster
recovery of a corrupted key, or to
migrate the master key to another KMS.
Before you run this command, you
must delete the existing master key
from the primary tenant (T0) database.
For example, you might enter the SQL
command:
1371
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
delete from systemsettings
where uniquekey =
'settings.configuration.keyEnc
ryptingKey'
3. dsm_c -action masterkey -
subaction encryptproperties —
Use the master key to encrypt keystore
and database passwords in
dsm.properties and
configuration.properties. Restart Deep
Security Manager for this setting to
take effect.
4. dsm_c -action masterkey -
subaction encrypttenantkey -
tenantid [all | TENANTNUM] — Use
the master key to encrypt existing tenant
key seeds (if you have a multi-tenant
deployment). Tenant key seeds are
used to derive sub-keys that you can
use in the next step. Safe to run multiple
times; it will not apply multiple layers of
encryption if the seed has already been
encrypted.
Tip:
Optionally, if you want to encrypt only
for new tenants while you slowly roll
out to each existing tenant, you can
enter this command first:
dsm_c -action changesetting -
name
settings.configuration.encryp
tTenantKeyForNewTenants -
value true
1372
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
5. dsm_c -action masterkey -
subaction encryptpii -tenantid
[all | TENANTNUM] — Use each
tenant's key to encrypt their
administrators' and contacts' personal
data in the database.
6. dsm_c -action masterkey -
subaction encryptdsmprivatekey
-tenantid [all | TENANTNUM] —
Use the master key to encrypt the
private key used for activation and other
agent-manager communications via
SSL/TLS.
Remove an Azure
endpoint from
allowed endpoint
list.
Note: You can
only remove
endpoints added
using the dsm_c
-action
removeazureendpoi addazureendpo dsm_c -action removeazureendpoint -
nt int command. endpoint ENDPOINT
Default built-in
endpoints
cannot be
removed.
Related dsm_c
options:
addazureendpoi
nt and
1373
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
listazureendpo
int
Remove a trusted
removecert dsm_c -action removecert -id ID
certificate.
Remove a private dsm_c -action removeregion -region
removeregion cloud provider
region. REGION
Reset counter dsm_c -action resetcounters [-
resetcounters tables to an empty tenantname TENANTNAME | -tenantid
state. TENANTID]
Perform batch dsm_c -action script -scriptfile
script
processing of FILEPATH [-tenantname TENANTNAME | -
dsm_c commands
in a script file. tenantid TENANTID]
Set Deep Security dsm_c -action setports [-managerPort
setports
Manager port(s). port] [-heartbeatPort port]
dsm_c -action trustdirectorycert -
directoryaddress DIRECTORYADDRESS -
trustdirectorycer Trust the directoryport DIRECTORYPORT [-
certificate of a
t directory. username USERNAME] [-password
PASSWORD] [-tenantname TENANTNAME | -
tenantid TENANTID]
dsm_c -action unlockout -username
Unlock a user USERNAME [-newpassword NEWPASSWORD]
unlockout
account. [-disablemfa][-tenantname TENANTNAME
| -tenantid TENANTID]
dsm_c -action upgradetasks [-
Runs the upgrade listtasksets] [-listtasks -taskset
task actions which UPGRADE_TASK_SET [-force]] [-
upgradetasks may be required
tenantlist] [-tenantsummary] [-run
as part of an in-
service upgrade. -taskset UPGRADE_TASK_SET [-force]
[-filter REGULAR_EXPRESSION]] [-
1374
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
showrollbackinfo -task TASKNAME]
[-purgehistory [-task TASKNAME]]
[-showhistory [-task TASKNAME]] [-
tenantname TENANTNAME | -tenantid
TENANTID]
l [-listtasksets]: List sets of tasks for
the system as a whole or the tenant
specified by -tenantname.
l [-listtasks -taskset UPGRADE_
TASK_SET [-force]]: List the
modifications to run. Include -force to
list all tasks.
l [-tenantlist]: Shows the version of
outstanding upgrade actions for the
specified tenant.
l [-tenantsummary]: Shows a summary
of the tenants that are not up to date.
l [-run -taskset UPGRADE_TASK_SET
[-force] [-filter REGX]]: Run the
upgrade actions for each tenant. Include
-force to run all tasks even if they
have already been done. Include -filter
to limit the actions to a regular
expression.
l [-showrollbackinfo -task
TASKNAME]: Shows rollback information
for the specified task. One tenant or all
tenants can be shown.
l [-purgehistory [-task
TASKNAME]]: Purge the history for the
tenant specified and the task specified.
If no tenant or task is specified, all items
are matched.
l [-showhistory [-task TASKNAME]]:
1375
Trend Micro Deep Security On-Premise 20
Action Name Description Usage
Show the history for the tenant specified
and the task specified. If no tenant or
task specified, all items are matched.
View information
about the current
software version, dsm_c -action versionget [-software]
versionget
the database [-dbschema]
schema version,
or both.
dsm_c -action viewsetting -name NAME
[-computerid COMPUTERID] [-
View a setting computername COMPUTERNAME] [-policyid
viewsetting
value. POLICYID] [-policyname POLICYNAME] [-
tenantname TENANTNAME | -tenantid
TENANTID]
Return codes
The dsm_c command returns an integer value that indicates whether the command executed
successfully. The following values can be returned:
l 0: Successful execution.
l -1: Failure of an unknown nature, such as corrupt software installation.
l 1: Failure during execution, such as the database is not currently accessible.
l 2: Invalid arguments were provided.
Use the Deep Security API to automate tasks
Deep Security 11.1 and higher have a new RESTful API that enables you to automate the
provisioning and maintenance of security via Deep Security. Go to the Deep Security
Automation Center to download the SDKs in the language of your choice and learn how to use
the API:
1376
Trend Micro Deep Security On-Premise 20
l API Reference
l Task-oriented guides with ample code examples
l Support resources
The API is continuously updated with new features and improvements. When you start new
automation projects, if the new API meets your needs you should use it to benefit from continued
support and maintenance in the long term.
To get started with the API, see the First Steps Toward Deep Security Automation guide in the
Deep Security Automation Center.
Legacy REST and SOAP APIs
Note: The REST and SOAP APIs that were provided before Deep Security 11.1 have not
changed. They have been deprecated, so new features will not be added but the existing API
functionality will continue to function as usual.
Deep Security still includes the legacy REST and SOAP APIs. For guidance on using them, see
the following guides on the Deep Security Automation Center:
l Transition from the SOAP API
l Use the Legacy REST API
The following sections explain how to use Deep Security Manager to accomplish tasks that are
related to using the SOAP and REST API. For more information about when you need to perform
these tasks, see the guides listed above.
Enable the Status Monitoring API (optional)
To use status monitoring with the legacy REST API, you must enable it. The API is disabled by
default as it does not require authentication.
Note: On Deep Security as a Service, the status monitoring API is already enabled for the
primary tenant (t0), so you don't need to enable it. It is not configurable for other tenants.
1. On Deep Security Manager, go to Administration > System Settings > Advanced.
2. In the Status Monitoring API section, select Enabled, then click Save.
1377
Trend Micro Deep Security On-Premise 20
Create a Web Service user account
Create a role for Web Service-only access, and assign it to a new user.
1. On Deep Security Manager, go to Administration > User Management > Roles .
2. Click New.
3. Deselect the Allow Access to Deep Security Manager User Interface check box and
select the Allow Access to Web Service API check box.
4. When all other configuration is complete, click Save.
5. Go to Administration > User Management > Users and click New.
6. Create a new user for use only with the Web Service API. Assign the new Role previously
created to this user.
Make note of the new user account user name and password.
Schedule Deep Security to perform tasks
Deep Security has many tasks that you might want to perform automatically on a regular basis.
Scheduled tasks are useful when deploying Deep Security in your environment and also later, to
keep your system up to date and functioning smoothly. They are especially useful for running
scans on a regular basis during off-peak hours.
Tip: You can automate scheduled task creation and configuration using the Deep Security
API. For examples, see the Maintain Protection Using Scheduled Tasks guide in the Deep
Security Automation Center.
Create scheduled tasks
To set up a scheduled task in the Deep Security Manager, click Administration > Scheduled
Tasks > New. This opens the "New Scheduled Task Wizard", which takes you through the steps
to create a scheduled task.
Check for Security Updates: Regularly check for security updates and import them into Deep
Security when they are available. For most organizations, performing this task once daily is
ideal.
Note: With Deep Security 11.0 Update 2 or later, the "Check for Security Updates" task
ignores offline hosts that have been uncommunicative for 30 days or more.
1378
Trend Micro Deep Security On-Premise 20
Check for Software Updates: Regularly check for Deep Security Agent software updates and
download them when they are available.
Discover Computers: Periodically check for new computers on the network by scheduling a
Discovery operation. You will be prompted for an IP range to check and asked to specify which
computer group the new computer will be added to. This task is useful for discovering computers
that are not part of your cloud connector.
Generate and Send Report: Automatically generate reports and optionally have them emailed
to a list of users.
Scan Computers for Integrity Changes: Causes the Deep Security Manager to perform an
Integrity Scan to compare a computer's current state against its baseline.
Scan computers for Malware: Schedules a Malware Scan. The configuration of the scan is
specified on the Policy or Computer Editor > Anti-Malware page for each computer. For most
organizations, performing this task once weekly (or according to your organization’s policies) is
ideal. When you configure this task, you can specify a timeout value for the scan. The timeout
option is available for daily, weekly, monthly, and once-only scans. It is not available for hourly
scans. When a scheduled malware scan is running and the timeout limit has been reached, any
tasks that are currently running or pending are canceled.
Tip: When a Scan Computers for Malware task times out, the next scheduled scan starts over
from the beginning (it does not start where the previous scan ended). The goal is to perform a
complete scan, so consider making some configuration changes if your scans regularly reach
the timeout limit. You can change the malware scan configuration to add some exceptions, or
extend the timeout period.
Scan Computers for Open Ports: Schedule periodic port scans on one or more computers. You
can specify individual computers or all computers belonging to a particular computer group.
Deep Security Manager will scan the port numbers defined on the Scanning tab in the Policy or
Computer Editor > Settings page.
Scan Computers for Recommendations: Causes the Deep Security Manager to scan the
computer(s) for common applications and then make recommendations based on what is
detected. Performing regular recommendation scans ensures that your computers are protected
by the latest relevant rule sets and that those that are no longer required are removed. If you
have set the "Automatically implement Recommendations" option for each of the three protection
modules that support it, Deep Security will assign and unassign rules that are required. If rules
1379
Trend Micro Deep Security On-Premise 20
are identified that require special attention, an alert will be raised to notify you. For most
organizations, performing this task once a week is ideal.
Note: Recommendation Scans can be CPU-intensive, so when scheduling Recommendation
Scans, it is best practice to set the task by group (for example, per policy or for a group of
computers, no more than 1,000 machines per group) and spread it in different days (for
example, database server scans scheduled every Monday; mail server scans scheduled every
Tuesday, and so on). Schedule Recommendation Scans more frequently for systems that
change often.
Send Outstanding Alert Summary: Generate an email listing all outstanding (unresolved) alerts.
Send Policy: Regularly check for and send updated policies. Scheduled updates allow you to
follow an existing change control process. Scheduled tasks can be set to update machines
during maintenance windows, off hours, etc.
Synchronize Cloud Account: Synchronize the Computers list with an added cloud account.
(Only available if you have added a cloud account to the Deep Security Manager. Applies to
Azure and vCoud accounts only. Not available for other cloud account types such as AWS and
Google Cloud Platform (GCP).)
Synchronize Directory: Synchronize the Computers list with an added LDAP directory. (Only
available if you have added an LDAP directory to the Deep Security Manager.)
Synchronize Users/Contact: Synchronize the Users and Contacts lists with an added Active
Directory. (Only available if you have added an Active Directory to the Deep Security Manager.)
Synchronize VMware vCenter: Synchronize the Computers list with an added VMware vCenter.
(Only available if you have added a VMware vCenter to the Deep Security Manager.)
Enable or disable a scheduled task
Existing scheduled tasks can be enabled or disabled. For example, you might want to
temporarily disable a scheduled task while you perform certain administrative duties during
which you don't want any activity to occur. The control to enable or disable a scheduled task is
on the General tab of the Task's Properties window.
1380
Trend Micro Deep Security On-Premise 20
Set up scheduled reports
Scheduled reports are scheduled tasks that periodically generate and distribute reports to users
and contacts (this feature used to be named "Recurring Reports"). Most of the options are
identical to those for single reports, with the exception of the time filter.
Tip: To generate a report on specific computers from multiple computer groups, create a user
who has viewing rights only to the computers in question and then either create a scheduled
task to regularly generate an "All Computers" report for that user or sign in as that user and run
an "All Computers" report. Only the computers to which that user has viewing rights will be
included in the report.
Automatically perform tasks when a computer is added
or changed (event-based tasks)
Note: In this article, references to protecting virtual machines apply only to Deep Security On-
Premise software installations.
Event-based tasks let you monitor protected computers for specific events and perform tasks
based on certain conditions.
Create an event-based task
In Deep Security Manager, click Administration > Event-Based Tasks > New. The wizard that
appears will guide you through the steps of creating a new task. You will be prompted for
different information depending on the type of task.
Edit or stop an existing event-based task
To change the properties for an existing event-based task, go to click Administration > Event-
Based Tasks. Select the event-based task from the list and click Properties.
1381
Trend Micro Deep Security On-Premise 20
Events that you can monitor
l Computer Created (by System): A computer being added to the manager during
synchronization with an Active Directory or Cloud Provider account, or the creation of a
virtual machine on a managed ESXi server running a virtual appliance.
l Computer Moved (by System):A virtual machine being moved from one vApp to another
within the same ESXi, or a virtual machine on an ESXi being move from one datacenter to
another or from one ESXi to another (including from an unmanaged ESXi server to a
managed ESXi server running a virtual appliance.)
l Agent-Initiated Activation: An agent is activated using agent-initiated activation.
l IP Address Changed: A computer has begun using a different IP.
l NSX Security Group Changed: The following situations will trigger this event (the event
will be recorded on each affected VM):
l A VM is added to a group that is (indirectly) associated with the NSX Deep Security
Service Profile
l A VM is removed from an NSX Group that is associated with the NSX Deep Security
Service Profile
l An NSX Policy associated with the NSX Deep Security Service Profile is applied to an
NSX Group
l An NSX Policy associated with the NSX Deep Security Service Profile is removed
from an NSX Group
l An NSX Policy is associated with the NSX Deep Security Service Profile
l An NSX Policy is removed from the NSX Deep Security Service Profile
l An NSX Group that is associated with an NSX Deep Security Service Profile changes
name
l Computer Powered On (by System): Enables users to trigger activation by the VMware
Virtual Machine power on event.
Note: The Computer Powered On event is only compatible with virtual machines hosted
on ESX environments in VMWare. Use this event cautiously because if a large number of
computers are turned on at the same time, this event could cause a slowdown.
1382
Trend Micro Deep Security On-Premise 20
Conditions
You can require specific match conditions to be met in order for a task to be carried out. For
example, you might require an AWS 'tag' of ProductionSystem to be present in an Amazon
EC2 instance in order for the Activate Computer action (see "Actions" on page 1385, below) to
occur on it.
When adding conditions:
l Click the "plus" button to add multiple conditions. In a multi-condition setup, ALL conditions
must be met for the action to be carried out.
l Use Java regular expression syntax (regex). Some examples of how to use regex are
provided in the table below. For details on regex,
seehttps://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html.
List of conditions and descriptions of each
l Cloud Instance Image ID: AWS cloud instance AMI ID.
Note: This match condition is only available for AWS instances added to the manager
through Computers > Add > Add AWS Account.
l Cloud Instance Metadata: The metadata being matched corresponds to AWS tags or GCP
labels that have been added to your AWS or GCP instances.
Note: This match condition is only available for AWS instances and GCP VMs added to
the manager through Computers > Add > [Add AWS Account or Add GCP Account].
Metadata currently associated with a computer is displayed on the Overview page in its
editor window. To define the conditions to match for, you must provide two pieces of
information: the metadata key and the metadata value. For example, to match a computer
which has a metadata key named "AlphaFunction" that has a value of "DServer", you
would enter "AlphaFunction" and "DServer" (without the quotes). If you wanted match
more than one possible condition, you could use regular expressions and enter
"AlphaFunction" and ".*Server", or "AlphaFunction" and "D.*".
l Cloud Instance Security Group Name: The security group the cloud instance applies to.
Note: This match condition is only available for AWS cloud instances.
1383
Trend Micro Deep Security On-Premise 20
l Cloud Account Name: The "Display Name" field in the Cloud Account properties window.
l Cloud Vendor: The cloud environment vendor of the instance. This condition is used to
match on instances from a specific cloud vendor. Currently, you can only match on AWS
and GCP vendors.
Note: Cloud Vendor only works if you added your cloud instances to the manager
through Computers > Add > [Add AWS Account or Add GCP Account].
l Computer Name: The "Hostname" field in the computer properties window.
l ESXi Name: The "Hostname" field of the ESXi server on which the VM computer is hosted.
ESXi Name: The "Hostname" field of the ESXi server on which the VM computer is hosted.
l Folder Name: The name of the folder or directory in which the computer is located in its
local environment.
Note: This match condition looks for a match against the name of any parent folder of the
computer, including the root datacenter for vCenter server integrations. If you add a "*"
character to the beginning of the regular expression, the condition must match the name
on all parent folders. This is particularly useful when combined with negation in a regular
expression. For example, if you want to match computers in folders that do not include
"Linux" in the folder name, you could use a regular expression like *^((?!Linux).)*$.
l GCP Network Tag: Network tags that have been added to GCP VMs.
Note: If the GCP VM has multiple GCP network tags, and a match is found on any one of
them, the VM is considered as matched.
l NSX Security Group Name: The list of potential groups in this condition refers only to NSX
Groups associated with NSX Policies associated with the NSX Deep Security Service
Profile. The VM may be a member of other NSX Groups but for the purposes of this match,
condition it is not relevant.
l Platform: The operating system of the computer.
l vCenter name: The "Name" field of the computer's vCenter properties that was added to
Deep Security Manager.
These next two conditions match True or False conditions:
1384
Trend Micro Deep Security On-Premise 20
l Appliance Protection Available: A Deep Security Virtual Appliance is available to protect
VMs on the ESXi on which the VM is hosted. The VM may or may not be in a "Activated"
state.
l Appliance Protection Activated: A Deep Security Virtual Appliance is available to protect
VMs on the ESXi on which the VM is hosted and the VM is "Activated".
This condition looks for matches to an IP in an IP list:
l Last Used IP Address: The current or last known IP address of the computer.
Note: Depending on the source of the new computer, some fields may not be available.
For example, "Platform" would not be available for computers added as a result of the
synchronization with an Active Directory.
Java regex examples
To match: Use this:
any string (but not nothing) .+
empty string (no text) ^$
Folder Alpha Folder\ Alpha
FIN-\d+
FIN-1234 or
FIN-.*
RD-\w+
RD-ABCD or
RD-.*
AB
or
ABC ABC*
or
ABCCCCCCCCCC
Microsoft Windows 2003
or .*Windows.*
Windows XP
Red Hat 7
or .*Red.*|.*Linux.*|
Some_Linux123
Actions
The following actions can be taken depending on which of the above events is detected:
1385
Trend Micro Deep Security On-Premise 20
l Activate Computer: Deep Security protection is activated on the computer.
l Delay activation by (minutes): Activation is delayed by a specified number of minutes.
l
Note: If the event-based task is intended to apply protection to a VM that is being
vMotioned to an ESXi protected by a Deep Security Virtual Appliance, add a delay
before activation to allow any pending VMware administrative tasks to complete. The
amount of delay varies depending on your environment.
l Deactivate Computer:Deep Security protection is deactivated on the computer.
l Assign Policy: The new computer is automatically assigned a policy. (The computer must
be activated first.)
l Assign Relay Group: The new computer is automatically assigned a relay group from
which to receive security updates.
l Assign to Computer Group: The computer is placed in one of the computer groups on the
Computers page.
Order of execution
If multiple event-based tasks are triggered by the same condition, the tasks are executed in
alphabetical order by task name.
Temporarily disable an event-based task
To prevent an existing event-based task from running, right-click it and then click Disable . For
example, you may want to temporarily disable an event-based task while you perform certain
administrative duties during which you don't want any activity to occur.
To re-enable an event-based task, right-click it and then click Enable.
AWS Auto Scaling and Deep Security
You can set up automatic protection in Deep Security for new instances created by AWS Auto
Scaling.
1386
Trend Micro Deep Security On-Premise 20
Each instance created by Auto Scaling will need to have a Deep Security agent installed on it.
There are two ways that you can do this: you can include a pre-installed agent in the EC2
instance used to create the AMI, or you install the agent by including a deployment script in the
launch configuration for the AMI. There are pros and cons for each option:
l If you include a pre-installed agent, instances will spin up more quickly because there is no
need to download and install the agent software. The downside is that the agent software
might not be the latest. To work around this issue, you can enable the upgrade on
activation feature.
l If you use a deployment script to install the agent, it will always get the latest version of the
agent software from the Deep Security Manager.
Pre-install the agent
If you have an EC2 instance already configured with a Deep Security Agent, you can use that
instance to create the AMI for Auto Scaling. Before creating the AMI, you must deactivate the
agent on the EC2 instance and stop the instance:
dsa_control -r
Note: Don't create an AMI that contains an activated agent. Each agent must be activated
individually.
Each new EC2 instance created by Auto Scaling needs to have its agent activated and a policy
applied to it, if it doesn’t have one already. There are two ways to do this:
l You can create a deployment script that activates the agent and optionally applies a policy.
Then add the deployment script to the AWS launch configuration so that it is run when a
new instance is created. For instructions, see the "Install the Agent with a deployment
script" section below, but omit the section of the deployment script that gets and installs the
agent. You will only need the dsa_control -a section of the script.
Note: For the deployment scripts to work, agent-initiated communication must be
enabled on your Deep Security Manager. For details on this setting, see "Activate and
protect agents using agent-initiated activation and communication" on page 1138
l You can set up an event-based task in Deep Security Manager that will activate the agent
and optionally apply a policy when an instance it launched and the "Computer Created (By
System)" event occurs.
1387
Trend Micro Deep Security On-Premise 20
Install the agent with a deployment script
Deep Security provides the ability to generate customized deployment scripts that you can run
when EC2 instances are created. If the EC2 instance does not contain a pre-installed agent, the
deployment script should install the agent, activate it, apply a policy, and optionally assign the
machine to a computer group and relay group.
Tip: You can generate deployment scripts to automate the agent installation using the Deep
Security API. For more information, see Generate an agent deployment script.
In order for the deployment script to work:
l You must create AMIs from machines that are stopped.
l Agent-initiated communication must be enabled on your Deep Security Manager. For
details on this setting, see "Activate and protect agents using agent-initiated activation and
communication" on page 1138.
To set up automatic protection for instances using a deployment script:
1. Sign in to Deep Security Manager.
2. From the Support menu in the top right-hand corner, select Deployment Scripts.
3. Select your platform.
4. Select Activate Agent automatically after installation.
5. Select the appropriate Security Policy, Computer Group and Relay Group.
6. Click Copy to Clipboard.
7. Go to the AWS launch configuration, expand Advanced Details and paste the deployment
script into User Data.
1388
Trend Micro Deep Security On-Premise 20
Note: If you are encountering issues getting the PowerShell deployment script to run on a
Microsoft Windows-based AMI, the issues may be caused by creating the AMI from a running
instance. AWS supports creating AMIs from running instances, but this option disables ALL of
the Ec2Config tasks that would run at start time on any instance created from the AMI. This
behavior prevents the instance from attempting to run the PowerShell script.
Note: When you build an AMI on Windows, you need to re-enable user-data handling
manually or as part of your image-building process. The user-data handling only runs in the
first boot of the Windows base AMI unless it’s explicitly told otherwise (it’s disabled during the
initial boot process), so instances built from a custom AMI won’t run user-data unless the
feature is re-enabled. Configuring a Windows Instance Using the EC2Config Service has a
detailed explanation and instructions for how to reset the feature or ensure it’s not disabled on
1389
Trend Micro Deep Security On-Premise 20
first boot. The easiest mechanism is to include <persist>true</persist> in your user data,
providing that you have EC2Config version 2.1.10 or later.
Delete instances from Deep Security as a result of Auto
Scaling
After you have added an AWS Account in the Deep Security Manager, instances that no longer
exist in AWS as a result of Auto Scaling will be automatically removed from the Deep Security
Manager.
See "About adding AWS accounts" on page 393 for details on adding an AWS account.
Azure virtual machine scale sets and Deep Security
Azure virtual machine scale sets (VMSS) provide the ability to deploy and manage a set of
identical VMs. The number of VMs can increase or decrease automatically based on
configurable scaling rules. For more information, see What are virtual machine scale sets in
Azure?
You can set up your VMSS to include a base VM image that has the Deep Security Agent pre-
installed and pre-activated. As the VMSS scales up, the new VM instances in the scale set
automatically include the agent.
To add the agent to your VMSS:
l "Step 1: (Recommended) Add your Azure account to Deep Security Manager" below
l "Step 2: Prepare a deployment script" on the next page
l "Step 3: Add the agent through a custom script extension to your VMSS instances" on the
next page
Step 1: (Recommended) Add your Azure account to Deep
Security Manager
When you add your Azure account to Deep Security Manager, all the Azure instances created
under that account are loaded into Deep Security Manager and appear under Computers. The
instances appear regardless of whether they have an agent installed or not. The ones that do not
1390
Trend Micro Deep Security On-Premise 20
include an agent have a Status of No Agent/Appliance. After you install and activate the agent
on them, their Status changes to Managed (Online).
If the scale set is manually or automatically scaled up after adding your Azure account, Deep
Security detects the new Azure instances and adds them to its list under Computers. Similarly, if
the scale set is scaled down, the instances are removed from view. Thus, Deep Security
Manager always shows the current list of available Azure instances in your scale set.
However, if you do not add your Azure account to Deep Security Manager, but instead add
individual Azure instances using another method, then Deep Security does not detect any
scaling down that might occur, and does not remove the non-existent Azure instances from its
list. To prevent an ever-expanding list of Azure VMs in your Deep Security Manager, and to
always show exactly which Azure instances are available in your scale set at any one time, it is
highly recommended that you add your Azure account to Deep Security Manager.
For instructions on adding your Azure account, see "Add a Microsoft Azure account to Deep
Security" on page 416.
Step 2: Prepare a deployment script
In Deep Security Manager, prepare a deployment script from Deep Security Manager. For
instructions, see "Use deployment scripts to add and protect computers" on page 1401. This
deployment script will be referenced in a custom script extension that you'll configure next.
Note: To run a custom script with the following VMSS script, the script must be stored in Azure
Blob storage or in any other location accessible through a valid URL. For instructions on how
to upload a file to Azure Blob storage, see Perform Azure Blob storage operations with Azure
PowerShell.
Step 3: Add the agent through a custom script extension to
your VMSS instances
Below are a couple of examples on how to use PowerShell to add the agent.
l Example 1 shows how to create a new VMSS that includes the agent
l Example 2 shows how to add the agent to an existing VMSS
Both examples:
1391
Trend Micro Deep Security On-Premise 20
l use the Add-AzureRmVmssExtension cmdlet to add an extension to the VMSS
l use Azure PowerShell version 5.1.1
Note: For instructions on creating a new VMSS using PowerShell cmdlets, refer to this
Microsoft tutorial. For the Linux platform, see https://github.com/Azure/custom-script-extension-
linux.
Example 1: Create a new VMSS that includes the agent
$resourceGroupName = <The resource group of the VMSS>
$vmssname = <The name of the VMSS>
# Create ResourceGroup
New-AzureRmResourceGroup -ResourceGroupName $resourceGroupName -Location
EastUS
# Create a config object
$vmssConfig = New-AzureRmVmssConfig `
-Location EastUS `
-SkuCapacity 2 `
-SkuName Standard_DS2 `
-UpgradePolicyMode Automatic
# Define the script for your Custom Script Extension to run on the Windows
Platform
$customConfig = @{
"fileUris" = (,"A URL of your copy of deployment script, ex.
deploymentscript.ps1");
"commandToExecute" = "powershell -ExecutionPolicy Unrestricted -File
deploymentscript.ps1"
1392
Trend Micro Deep Security On-Premise 20
# Define the script for your Custom Script Extension to run on the Linux
Platform
#$customConfig = @{
# "fileUris" = (,"A URL of your copy of deployment script, ex.
deploymentscript.sh");
# "commandToExecute" = "bash deploymentscript.sh"
#}
# The section is required only if deploymentscript has been located within
Azure StorageAccount
$storageAccountName = <StorageAccountName if deploymentscript is locate in
Azure Storage>
$key = (Get-AzureRmStorageAccountKey -Name $storageAccountName -
ResourceGroupName $resourceGroupName).Value[0]
$protectedConfig = @{
"storageAccountName" = $storageAccountName;
"storageAccountKey" = $key
# Use Custom Script Extension to install Deep Security Agent (Windows)
Add-AzureRmVmssExtension -VirtualMachineScaleSet $vmssConfig `
-Name "customScript" `
-Publisher "Microsoft.Compute" `
-Type "CustomScriptExtension" `
-TypeHandlerVersion 1.8 `
-Setting $customConfig `
-ProtectedSetting $protectedConfig
1393
Trend Micro Deep Security On-Premise 20
# Use Custom Script Extension to install Deep Security Agent (Linux)
#Add-AzureRmVmssExtension -VirtualMachineScaleSet $vmssConfig `
# -Name "customScript" `
# -Publisher "Microsoft.Azure.Extensions" `
# -Type "customScript" `
# -TypeHandlerVersion 2.0 `
# -Setting $customConfig `
# -ProtectedSetting $protectedConfig
# Create a public IP address
# Create a frontend and backend IP pool
# Create the load balancer
# Create a load balancer health probe on port 80
# Create a load balancer rule to distribute traffic on port 80
# Update the load balancer configuration
# Reference a virtual machine image from the gallery
# Set up information for authenticating with the virtual machine
# Create the virtual network resources
# Attach the virtual network to the config object
# Create the scale set with the config object (this step might take a few
minutes)
New-AzureRmVmss `
-ResourceGroupName $resourceGroupName `
-Name $vmssname `
-VirtualMachineScaleSet $vmssConfig
1394
Trend Micro Deep Security On-Premise 20
Example 2: Add the agent to an existing VMSS
$resourceGroupName = <The resource group of the VMSS>
$vmssname = <The name of the VMSS>
# Get the VMSS model
$vmssobj = Get-AzureRmVmss -ResourceGroupName $resourceGroupName -
VMScaleSetName $vmssname
# Show model data if you prefer
# Write-Output $vmssobj
# Define the script for your Custom Script Extension to run on the Windows
platform
$customConfig = @{
"fileUris" = (,"A URL of your copy of deployment script, ex.
deploymentscript.ps1");
"commandToExecute" = "powershell -ExecutionPolicy Unrestricted -File
deploymentscript.ps1"
# Define the script for your Custom Script Extension to run on the Linux
platform
#$customConfig = @{
# "fileUris" = (,"A URL of your copy of deployment script, ex.
deploymentscript.sh");
# "commandToExecute" = "bash deploymentscript.sh"
#}
1395
Trend Micro Deep Security On-Premise 20
# The section is required only if deploymentscript has been located within
Azure StorageAccount
$storageAccountName = <StorageAccountName if deploymentscript is locate in
Azure Storage>
$key= (Get-AzureRmStorageAccountKey -Name $storageAccountName -
ResourceGroupName $resourceGroupName).Value[0]
$protectedConfig = @{
"storageAccountName" = $storageAccountName;
"storageAccountKey" = $key
# Use Custom Script Extension to install Deep Security Agent (Windows)
$newvmssobj = Add-AzureRmVmssExtension `
-VirtualMachineScaleSet $vmssobj `
-Name "customScript" `
-Publisher "Microsoft.Compute" `
-Type "CustomScriptExtension" `
-TypeHandlerVersion 1.8 `
-Setting $customConfig `
-ProtectedSetting $protectedConfig
# Use Custom Script Extension to install Deep Security Agent (Linux)
#$newvmssobj = Add-AzureRmVmssExtension `
# -VirtualMachineScaleSet $vmssobj `
# -Name "customScript" `
# -Publisher "Microsoft.Azure.Extensions" `
# -Type "customScript" `
# -TypeHandlerVersion 2.0 `
1396
Trend Micro Deep Security On-Premise 20
# -Setting $customConfig `
# -ProtectedSetting $protectedConfig
# Update the virtual machine scale set model
Update-AzureRmVmss -ResourceGroupName $resourceGroupName -name $vmssname -
VirtualMachineScaleSet $newvmssobj -Verbose
# Get Instance ID for all instances in this VMSS, and decide which
instance you'd like to update
# Get-AzureRmVmssVM -ResourceGroupName $resourceGroupName -VMScaleSetName
$vmssname
# Now start updating instances
# If upgradePolicy is Automatic in the VMSS, do NOT execute the next
command Update-AzureRmVmssInstance. Azure will auto-update the VMSS.
# There's no PowerShell command to update all instances at once. But you
could refer to the output of Update-AzureRmVmss, and loop all instances
into this command.
Update-AzureRmVmssInstance -ResourceGroupName $resourceGroupName -
VMScaleSetName $vmssname -InstanceId 0
GCP auto scaling and Deep Security
You can set up automatic protection in Deep Security for new GCP VM instances created
through GCP managed instance groups (MIGs) to support auto scaling.
Each GCP VM instance created through a MIG will need to have a Deep Security agent installed
on it. There are two ways that you can do this: you can include a pre-installed agent in the GCP
VM instance used to create the instance template, or you can install the agent by including a
deployment script in the instance template for the image. There are pros and cons for each
option:
1397
Trend Micro Deep Security On-Premise 20
l If you include a pre-installed agent, instances will spin up more quickly because there is no
need to download and install the agent software. The downside is that the agent software
might not be the latest. To work around this issue, you can enable the upgrade on
activation feature.
l If you use a deployment script to install the agent, it will always get the latest version of the
agent software from the Deep Security Manager.
Pre-install the agent
If you have a GCP VM instance already configured with a Deep Security Agent, you can use that
instance to create the instance template for the MIG. Before creating the instance template, you
must deactivate the agent on the GCP VM instance and stop the instance:
dsa_control -r
Each new GCP VM instance created by the MIG needs to have its agent activated and a policy
applied to it, if it doesn’t have one already. There are two ways to do this:
l You can create a deployment script that activates the agent and optionally applies a policy.
Then add the deployment script to the GCP instance template so that it is run when a new
instance is created. For instructions, see the "Install the agent with a deployment script"
below section below, but omit the section of the deployment script that gets and installs the
agent. You will only need the dsa_control -a section of the script.
Note: For the deployment scripts to work, agent-initiated communication must be
enabled on your Deep Security Manager. For details on this setting, see "Activate and
protect agents using agent-initiated activation and communication" on page 1138.
l You can set up an event-based task in Deep Security Manager that will activate the agent
and optionally apply a policy when an instance is launched and the "Computer Created
(By System)" event occurs.
Install the agent with a deployment script
Deep Security provides the ability to generate customized deployment scripts that you can run
when GCP VM instances are created. If the GCP VM instance does not contain a pre-installed
agent, the deployment script should install the agent, activate it, apply a policy, and optionally
assign the machine to a computer group and relay group.
1398
Trend Micro Deep Security On-Premise 20
Tip: You can generate deployment scripts to automate the agent installation using the Deep
Security API. For more information, see Generate an agent deployment script.
In order for the deployment script to work:
l You must create images from machines that are stopped.
l Agent-initiated communication must be enabled on your Deep Security Manager. For
details on this setting, see "Activate and protect agents using agent-initiated activation and
communication" on page 1138.
To set up automatic protection for instances using a deployment script:
1. Sign in to Deep Security Manager.
2. From the Support menu in the top right-hand corner, select Deployment Scripts.
3. Select your platform.
4. Select Activate Agent automatically after installation.
5. Select the appropriate Security Policy, Computer Group and Relay Group.
6. Click Copy to Clipboard.
7. Go to the GCP instance templates, expand Management, security, disks, networking,
1399
Trend Micro Deep Security On-Premise 20
sole tenancy and paste the deployment script into Startup script.
Delete instances from Deep Security as a result of GCP MIGs
After you have added a GCP account in Deep Security Manager, instances that no longer exist
in GCP as a result of Managed Instance Group will be automatically removed from the Deep
Security Manager.
See "Add a Google Cloud Platform account" on page 429 for details on adding a GCP account.
1400
Trend Micro Deep Security On-Premise 20
Use deployment scripts to add and protect computers
Adding a computer to your list of protected resources in Deep Security and implementing
protection is a multi-step process. Almost all of these steps can be performed from the command
line on the computer and can therefore be scripted. The Deep Security Manager contains a
deployment script writing assistant which can be accessed from the Support menu.
The deployment scripts generated through Deep Security Manager do the following:
l install the Deep Security Agent on a chosen platform
l activate the agent
l assign a policy to the agent
Generate a deployment script
1. Before you begin:
a. Make sure you have imported the agent software to Deep Security Manager. See "Get
Deep Security Agent software" on page 266 for details.
b. Make sure your agent version control settings are configured as desired. See
"Configure agent version control" on page 1117 for details.
c. Make sure you have enabled agent-initiated activation (AIA). AIA is required if you
want your deployment script to activate the agent after installation. See "Activate and
protect agents using agent-initiated activation and communication" on page 1138 for
details.
2. In the upper right corner of the Deep Security Manager console, click Support
> Deployment Scripts.
3. Select the platform on which you are deploying the software.
4. Select Activate agent automatically after installation.
Agents must be activated before you apply a policy to protect the computer. Activation
registers the agent with the manager during an initial communication.
5. Optionally, select the Security Policy, Computer Group, Relay Group, Proxy to contact
Deep Security Manager, and Proxy to contact Relay(s).
6. Optionally (but highly recommended), select Validate Deep Security Manager TLS
certificate.
When this option is selected, it checks that Deep Security Manager is using a valid TLS
certificate from a trusted certificate authority (CA) when downloading the agent software,
1401
Trend Micro Deep Security On-Premise 20
which can help prevent a "man in the middle" attack. You can check whether Deep
Security Manager is using a valid CA certificate by looking at the browser bar in the Deep
Security Manager console. By default, Deep Security Manager uses a self-signed
certificate, which is not compatible with the Validate Deep Security Manager TLS
certificate option. If your Deep Security Manager is not behind a load balancer, see
"Replace the Deep Security Manager TLS certificate" on page 1245 for instructions on
replacing the default self-signed certificate with a certificate from a trusted certificate
authority. If the manager is behind a load balancer, you will need to replace the load
balancer's certificates.
7. Optionally (but highly recommended), select Validate the signature on the agent installer
to have the deployment script initiate a digital signature check on the agent installer file. If
the check is successful, the agent installation proceeds. If the check fails, the agent
installation is aborted. Before you enable this option, understand that:
l This option is only supported for Linux and Windows installers (RPM, DEB, or MSI
files).
l (Linux only) This option requires that you import the public signing key to each agent
computer where the deployment script will run. For details, see "Check the signature
on an RPM file" on page 199 and "Check the signature on a DEB file" on page 201.
8. The deployment script generator displays the script. Click Copy to Clipboard and paste the
deployment script in your preferred deployment tool, or click Save to File.
Note: The deployment scripts generated by Deep Security Manager for Windows agent
deployments require Windows PowerShell version 4.0 or later. You must run PowerShell as
1402
Trend Micro Deep Security On-Premise 20
an Administrator and you may have to run the following command to be able to run scripts:
Set-ExecutionPolicy RemoteSigned
Note: If you want to deploy an agent to an early version of Windows or Linux that doesn't
include PowerShell 4.0 or curl 7.34.0 at a minimum, remove the --tls1.2 tag (Linux) or
[Net.ServicePointManager]::SecurityProtocol =
[Net.SecurityProtocolType]::Tls12; line (Windows) so that early TLS (version 1.0) is
used to communicate with the manager. Also make sure that early TLS is allowed on the
manager and relays. See "Determine whether TLS 1.2 is enforced" on page 1443 and "Enable
early TLS (1.0)" on page 1441 for details.
If you are using Amazon Web Services and deploying new Amazon EC2, Amazon WorkSpace,
or VPC instances, copy the generated script and paste it into the User Data field. This will let
you launch existing Amazon Machine Images (AMIs) and automatically install and activate the
agent at startup. The new instances must be able to access the URLs specified in the generated
deployment script. This means that your Deep Security Manager must be either Internet-facing,
connected to AWS via VPN or Direct Link, or that your Deep Security Manager be deployed on
Amazon Web Services too.
When copying the deployment script into the User Data field for a Linux deployment, copy the
deployment script as-is into the "User Data" field and CloudInit will execute the script with sudo.
(If there are failures, they will be noted in /var/log/cloud-init.log.)
Note: The User Data field is also used with other services like CloudFormation. For more
information, see:
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-
waitcondition.html
Troubleshooting and tips
l If you are attempting to run a deployment script and see exit code 2 "TLS certificate
validation for the agent package download has failed. Please check that your Deep
Security Manager TLS certificate is signed by a trusted root certificate authority. For
more information, search for "deployment scripts" in the Deep Security Help Center.",
the deployment script was created with the Validate Deep Security Manager TLS
certificate check box selected. This error appears if Deep Security Manager is using a
certificate that is not publicly trusted (such as the default self-signed certificate) for the
1403
Trend Micro Deep Security On-Premise 20
connection between Deep Security Manager and its agents, or if there is a problem with a
third-party certificate, such as a missing certificate in the trust chain between your
certificate and the trusted CA. For information on certificates, see "Replace the Deep
Security Manager TLS certificate" on page 1245. As an alternative to replacing the trusted
certificate, you can clear the Validate Deep Security Manager TLS certificate check box
when generating a deployment script. Note that this is not recommended for security
reasons.
l If you are attempting to deploy the agent from PowerShell (x86), you will receive the
following error : C:\Program Files (x86)\Trend Micro\Deep Security
Agent\dsa_control' is not recognized as the name of a cmdlet, function,
script file, or operable program. Check the spelling of the name, or if
a path was included, verify that the path is correct and try again.
The PowerShell script expects the environment variable for ProgramFiles to be set to
"Program Files", not "Program Files (x86)". To resolve the issue, close PowerShell (x86)
and run the script in PowerShell as an administrator.
l On Windows computers, the deployment script will use the same proxy settings as the
local operating system. If the local operating system is configured to use a proxy and the
Deep Security Manager is accessible only through a direct connection, the deployment
script will fail.
l If there is a need to control the specific agent version used by the deployment scripts there
are 2 options to meet this goal:
l Use agent version control. See "Configure agent version control" on page 1117 for
details. This approach has the advantage that you do not have to hard-code the agent
version itself into each script which can be a more flexible approach for some
deployments.
l Either modify the deployment script, or write your own scripts, to meet requirements
specific to your deployment. Details on the URL format to download agents can be
found here "URL format for download of the agent" on the next page.
l Instead of using the deployment scripts generated by the manager, you can use your own
automation method coupled with an agent download URL to automate the download and
installation of the agent. For details, see "URL format for download of the agent" on the
next page.
1404
Trend Micro Deep Security On-Premise 20
URL format for download of the agent
The Deep Security Agent software package can be downloaded from Deep Security Manager,
using a well-defined URL format.
In most cases, use of the standard deployment scripts (which, by the way, also use this same
URL format described in this section to download the agent software) is the quickest way to get
started and will meet the majority of your deployment requirements.
Use of this URL format directly is useful if you require further customization for the download and
install of agents. For example, in some cases it may be necessary to have the deployment
scripts that run on each server point to a local storage location (for example, AWS S3) rather
than have each server reach out to the manager to download software. You can use this URL
format to build your own automation to periodically download new agent versions to your local
storage location, and then point the agent deployment scripts that run on each server to your
local storage location to meet this objective.
Topics:
l "Agent download URL format" below
l "<dsm fqdn> parameter" on the next page
l "<filename> parameter" on the next page
l "<agent version> parameter" on page 1407
l "Should I include the <agent version> explicitly in my scripts?" on page 1407
l "<platform>, <arch>, and <filename> parameters" on page 1408
l "Examples" on page 1411
l "Exceptions for backwards compatibility" on page 1411
l "Using agent version control to define which agent version is returned" on page 1412
l "Examples" on page 1412
l "Interactions between the <agent version> parameter and agent version control" on
page 1412
Agent download URL format
The URL format used to download the agent is:
1405
Trend Micro Deep Security On-Premise 20
https://<dsm fqdn>/software/agent/<platform>/<arch>/<agent
version>/<filename>
All the parameters that comprise the URL format are described below.
<dsm fqdn> parameter
The <dsm fqdn> parameter is the fully-qualified domain name of the manager, including the
listening port number.
Example:
example.com:4119
<filename> parameter
The <filename> parameter is the file name of the agent installer file. The file name is
dependent on the installation process used by each platform:
Platform <filename>
Linux
agent.rpm
Red Hat Enterprise Linux, CentOS, Oracle, CloudLinux, Amazon Linux,
SUSE
Linux
agent.deb
Debian, Ubuntu
Windows agent.msi
AIX agent.bff.gz
Solaris 11+ agent.p5p.gz
Solaris 10 or earlier agent.pkg.gz
Note: The manager does not validate the file name itself; however when a file name is
specified, the extension must be one of .rpm, .msi, .deb, .gz. If any other file name is
1406
Trend Micro Deep Security On-Premise 20
specified, the file name returned by the manager will always be one of the names provided in
the table above.
<agent version> parameter
The <agent version> parameter is optional.
When this parameter is not specified, the latest agent in the manager's local inventory for the
target platform is returned.
When this parameter is specified, this represents the agent version string. For example
"12.0.0.123".
Should I include the <agent version> explicitly in my scripts?
If your intent is to only use a specific version of the agent in a controlled environment, then
explicitly adding the agent version to the URL will accomplish this goal.
When deploying agents at scale, it should be noted that adding the agent version in the URL
(which hardcodes this agent version into every script you distribute) can create challenges for
security operations teams that will be distributing scripts to many applications teams.
Consider the process that will be needed when the time arrives to use a newer version of the
agent. If the <agent version> is hardcoded in each script you distribute, this will require that
each of these scripts requires an update to start using the new agent version. If you have many
internal application teams, the process to request changes to each one of these scripts in use
can be significant.
Deep Security provides two options to deal with this challenge:
l Simply use scripts that omit the <agent version> component from the path.
If using the latest agent in the manager's local inventory meets your requirements, this is
the most straightforward option to use.
l Use agent version control
Agent version control provides the ability for the Deep Security administrator to select on a
per-platform basis exactly what agent version is returned from the manager. More detail on
agent version control and how to leverage this feature from your scripts can be found at
"Using agent version control to define which agent version is returned" on page 1412.
1407
Trend Micro Deep Security On-Premise 20
<platform>, <arch>, and <filename> parameters
The <platform>, <arch>, and <filename> parameters should be replaced with the strings
listed in the table below.
Note: <platform> and <arch> are case-sensitive.
Distributio
Platform <platform> <arch> <filename> Example
n
Amazon x86_ /software/agent/amzn1/x86_
Linux amzn1 agent.rpm
1 64 64/agent.rpm
Amazon x86_ /software/agent/amzn2/x86_
amzn2 agent.rpm
2 64 64/agent.rpm
CloudLi CloudLin x86_ /software/agent/CloudLinux_
agent.rpm
nux 6 ux_6 64 6/x86_64/agent.rpm
CloudLi CloudLin x86_ /software/agent/CloudLinux_
agent.rpm
nux 7 ux_7 64 7/x86_64/agent.rpm
CloudLi CloudLin x86_ /software/agent/CloudLinux_
agent.rpm
nux 8 ux_8 64 8/x86_64/agent.rpm
Debian x86_ /software/agent/Debian_7/x86_
Debian_7 agent.deb
7 64 64/agent.deb
Debian x86_ /software/agent/Debian_8/x86_
Debian_8 agent.deb
8 64 64/agent.deb
Debian x86_ /software/agent/Debian_9/x86_
Debian_9 agent.deb
9 64 64/agent.deb
Oracle Oracle_ x86_ /software/agent/Oracle_
agent.rpm
Linux 6 OL6 64 OL6/x86_64/agent.rpm
Oracle Oracle_ /software/agent/Oracle_
i386 agent.rpm
Linux 6 OL6 OL6/i386/agent.rpm
Oracle Oracle_ x86_ /software/agent/Oracle_
agent.rpm
Linux 7 OL7 64 OL7/x86_64/agent.rpm
RedHat RedHat_ x86_ agent.rpm /software/agent/RedHat_
1408
Trend Micro Deep Security On-Premise 20
Distributio
Platform <platform> <arch> <filename> Example
n
6 EL6 64 EL6/x86_64/agent.rpm
RedHat RedHat_ /software/agent/RedHat_
i386 agent.rpm
6 EL6 EL6/i386/agent.rpm
RedHat RedHat_ x86_ /software/agent/RedHat_
agent.rpm
7 EL7 64 EL7/x86_64/agent.rpm
RedHat RedHat_ x86_ /software/agent/RedHat_
agent.rpm
8 EL8 64 EL8/x86_64/agent.rpm
x86_ /software/agent/SuSE_11/x86_
SuSE 11 SuSE_11 agent.rpm
64 64/agent.rpm
/software/agent/SuSE_
SuSE 11 SuSE_11 i386 agent.rpm
11/i386/agent.rpm
x86_ /software/agent/SuSE_12/x86_
SuSE 12 SuSE_12 agent.rpm
64 64/agent.rpm
x86_ /software/agent/SuSE_15/x86_
SuSE 15 SuSE_15 agent.rpm
64 64/agent.rpm
Ubuntu Ubuntu_ x86_ /software/agent/Ubuntu_
agent.deb
16.04 16.04 64 16.04/x86_64/agent.deb
Ubuntu Ubuntu_ x86_ /software/agent/Ubuntu_
agent.deb
18.04 18.04 64 18.04/x86_64/agent.deb
Windo x86_ /software/agent/Windows/x86_
Windows agent.msi
ws 64 64/agent.msi
/software/agent/Windows/i386/ag
Windows i386 agent.msi
ent.msi
Solaris
10 Solaris_ x86_ agent.pkg /software/agent/Solaris_5.10_
Unix
Updates 5.10_U5 64 .gz U5/x86_64/agent.pkg.gz
4-6
Solaris_ agent.pkg /software/agent/Solaris_5.10_
sparc
5.10_U5 .gz U5/sparc/agent.pkg.gz
1409
Trend Micro Deep Security On-Premise 20
Distributio
Platform <platform> <arch> <filename> Example
n
Solaris
10 Solaris_ x86_ agent.pkg /software/agent/Solaris_5.10_
Updates 5.10_U7 64 .gz U7/x86_64/agent.pkg.gz
7-11
Solaris_ agent.pkg /software/agent/Solaris_5.10_
sparc
5.10_U7 .gz U7/sparc/agent.pkg.gz
Solaris
11 Solaris_ x86_ agent.p5p /software/agent/Solaris_
Updates 5.11 64 .gz 5.11/x86_64/agent.p5p.gz
1-3
Solaris_ agent.p5p /software/agent/Solaris_
sparc
5.11 .gz 5.11/sparc/agent.p5p.gz
Solaris
11 Solaris_ x86_ agent.p5p /software/agent/Solaris_5.11_
Update 5.11_U4 64 .gz U4/x86_64/agent.p5p.gz
4
Solaris_ agent.p5p /software/agent/Solaris_5.11_
sparc
5.11_U4 .gz U4/sparc/agent.p5p.gz
AIX 5.3
(Deep
power agent.bff. /software/agent/AIX_
Security AIX_5.3
pc gz 5.3/powerpc/agent.bff.gz
Agent
9.0)
AIX 6.1
(Deep
power agent.bff. /software/agent/AIX_
Security AIX_6.1
pc gz 6.1/powerpc/agent.bff.gz
Agent
9.0)
AIX 7.1,
7.2
(Deep power agent.bff. /software/agent/AIX_
AIX_7.1
Security pc gz 7.1/powerpc/agent.bff.gz
Agent
9.0)
1410
Trend Micro Deep Security On-Premise 20
Distributio
Platform <platform> <arch> <filename> Example
n
AIX 6.1,
7.1, 7.2
(Deep power agent.bff. /software/agent/AIX/powerpc/age
AIX
Security pc gz nt.bff.gz
Agent 12
and up)
Examples
Without <agent version>:
l https://example.com:4119/software/agent/RedHat_EL7/x86_64/agent.rpm
l https://example.com:4119/software/agent/Windows/x86_64/agent.msi
With <agent version>:
l https://example.com:4119/software/agent/RedHat_EL7/x86_
64/12.0.0.481/agent.rpm
l https://example.com:4119/software/agent/Windows/x86_
64/12.0.0.481/agent.msi
Exceptions for backwards compatibility
If no <filename> is provided after [...]/<platform>/<arch>/, the manager will return the
agent download for that platform as described in the previous table.
If the path ends at [...]<platform>/<arch> (because both <agent version> and
<filename> were not specified), the manager will return the agent download for that platform as
described in the table above.
Examples:
l https://example.come:4119/software/agent/RedHat_EL7/x86_64/
l https://example.come:4119/software/agent/Windows/x86_64
1411
Trend Micro Deep Security On-Premise 20
Using agent version control to define which agent version is
returned
The agent version control feature provides the ability to control what agents are returned when
any URL request is made to Deep Security to download the agent.
To enable agent version control, send the following HTTP header with your URL request:
Agent-Version-Control: on
It should be noted that there are specific query parameters that are also required on each
platform to use agent version control. They are:
Platfo
Required query parameters Example
rm
Win /software/agent/Windows/x86_
tenantID, windowsVersion,
dow 64/agent.msi?tenantID=123&windowsVersion=10.0.
windowsProductType
s 17134&windowsProductType=3
Linu /software/agent/RedHat_EL7/x86_
tenantID
x 64/agent.rpm?tenantID=123
Sol /software/agent/Solaris_5.11_U4/x86_
tenantID
aris 64/agent.p5p.gz?tenantID=123
tenantID, aixVersion, /software/agent/AIX/powerpc/agent.bff.gz?tenantID=
AIX
aixRelease 123&&aixVersion=7&aixRelease=1
Examples
For examples, refer to the sample deployment script generated from the manager. By default the
deployment scripts generated by the manager use agent version control and demonstrate how to
acquire these parameters for each platform.
Interactions between the <agent version> parameter and agent version
control
Given the intent of the agent version control feature is to provide the Deep Security administrator
control over which agent version is returned, there is a natural conflict with a URL request that
1412
Trend Micro Deep Security On-Premise 20
also includes the <agent version> parameter.
For this reason you should not specify the <agent version> as part of your request when
sending the Agent-Version-Control: on HTTP header.
If we see both the Agent-Version-Control: on HTTP header and the <agent version>
parameter in the request, the version of the agent returned will be determined by the value taken
from the agent version control configuration. (We will ignore the <agent version> in the URL.)
Automatically assign policies by AWS instance tags
AWS tags allows you to categorize your resources by assigning metadata to AWS EC2
instances in the form of keys and values. You can also tag Amazon WorkSpaces with the similar
key and value pair. Deep Security can use this metadata to trigger the automatic assigning of a
policy to a Deep Security Agent when that agent is activated. This is done by creating an event-
based task in Deep Security and defining the event, policy, and metadata. Event-based tasks
are used to monitor protected resources for specific events and then perform tasks based on
certain conditions: in this case the event is agent-initiated activation and a specific AWS
instance tag is the condition.
This article describes how to do this using the following examples:
l Policy: AIA_Policy
l AWS tag key: Group
l AWS tag value: development
Note: The example below is based on the assumption that the policy AIA_Policy has already
been created.
1. Go to Administration -> Event-Based Tasks in the Deep Security Manager console and
click New.
2. Select Agent-Initiated Activation from the Event list and click Next.
3. Select the Assign Policy check box, select AIA_Policy from the list, and click Next.
4. Select Cloud Instance Metadata from the list, type Group and development into the key
and value fields, and click Next.
1413
Trend Micro Deep Security On-Premise 20
5. Type and name for the event-based task and click Finish to save it.
You have now created an event-based task that will apply the AIA_Policy to an instance tagged
with the key "Group" and the value "development" when the agent is activated on that instance.
Trust and compliance
About compliance
Trend Micro helps to accelerate compliance by consolidating multiple security controls into one
product, while also delivering comprehensive auditing and reporting. For more information, see
Regulatory Compliance on the Trend Micro website.
Depending on your requirements, see:
l "Meet PCI DSS requirements with Deep Security" on page 1416
l "Common Criteria configuration" on page 1417
l "GDPR" on page 1417
1414
Trend Micro Deep Security On-Premise 20
l "FIPS 140-2 support" on page 1417
l Set up AWS Config Rules
l "Bypass vulnerability management scan traffic in Deep Security" on page 1428
l "Use TLS 1.2 with Deep Security" on page 1430
l "Enable TLS 1.2 strong cipher suites" on page 1445
Agent package integrity check
Deep Security verifies your signature on the Deep Security Agent to ensure that the software
files have not changed since the time of signing. An integrity check occurs when:
1. You're upgrading the Deep Security Agent.
2. You're enabling a new security module so the kernel support is being updated.
If the validation fails, plugin installations and agent upgrades are blocked.
Troubleshoot
ID Event Reason Solution
1. On the Alerts page, check for the "Relay
Upgrade Required For Agent Integrity
Check" alert. If the alert exists, see
"Supported Deep Security Relay
versions" on the next page and "Upgrade
Deep Security Relay" on page 1294
Agent/Plugin The signature files used to
check the integrity of the accordingly. Confirm signature files sync
package agent are not available in
to your update source.
5302 signature your update source. Your
Deep Security Relay might 2. Confirm your signature files have synced
download
not be upgraded to the to your update source.
failed. required version. 3. Attempt to upgrade your agent or send
your updated policy again.
4. If the issue isn't resolved, "Create a
diagnostic package and logs" on
page 1550 and send it to the Trend Micro
support team.
Agent/Plugin The agent package might 1. Backup and delete the possibly tampered
5300 package have been tampered with or file from your update source.
1415
Trend Micro Deep Security On-Premise 20
ID Event Reason Solution
2. Delete the corresponding agent package
signature
validation from Deep Security Manager.
failed. 3. Re-download the agent package from the
Download Center and import it to Deep
Agent/Plugin Security Manager.
package 4. Confirm the package has synced to your
5301 something is wrong on the
validation update source.
failed. package.
5. Attempt to upgrade your agent or send
Agent/Plugin your updated policy again.
package 6. If the issue isn't resolved, "Create a
signature diagnostic package and logs" on
5303
mismatch
with the one page 1550 and send it to the Trend Micro
in our policy. support team.
Supported Deep Security Relay versions
Deep
Deep Security Feature Release Deep Security 12
Security 20
Windows - Deep Security Agent
Supported Deep Deep FR 2020-04-16 (12.5.0.834) Deep Security Agent 12.0
Security Relay Security
update 8 (12.0.0.967)
version Agent 20 Linux - Deep Security Agent FR
2020-05-19 (12.5.0.936)
Meet PCI DSS requirements with Deep Security
The Payment Card Industry Data Security Standard (PCI DSS) is an information security
standard that promotes the safety of cardholder data. Coalfire (a PCI auditor) has written a
commissioned white paper that examines how Trend Micro Deep Security can be used to help
secure Payment Card Industry (PCI) data in accordance with the PCI Data Security Standard
(PCI DSS).
For more information, see the white paper Using Trend Micro's Hybrid Cloud Security Solution to
Meet PCI DSS 3.2 Compliance.
Tip: For information on how to:
- accelerate PCI DSS compliance in AWS, see Accelerating PCI Compliance in AWS using
1416
Trend Micro Deep Security On-Premise 20
Deep Security.
- enable TLS 1.2 for PCI compliance, see "Use TLS 1.2 with Deep Security" on page 1430 or
"Enable TLS 1.2 strong cipher suites" on page 1445.
Trend Micro Deep Security as a Service is now a PCI DSS Level 1 Service Provider. This
means you can further streamline your PCI DSS certification process and take more items off of
your to do list. For more information, see Trend Micro Deep Security as a Service Achieves PCI
DSS Level 1 Certification.
Common Criteria configuration
Deep Security 11.0 Update 2 is the most recent version to receive Common Criteria certification.
To learn more, go to the drop-down list at the top of this page and select Deep Security 11 Long-
Term Support.
GDPR
The European Union’s (EU) General Data Protection Regulation (GDPR) mandates that
organizations anywhere in the world processing EU citizen data reassess their data processing
controls and put a plan in place to better protect it. For information about GDPR and Trend Micro,
see the Trend Micro GDPR Compliance site.
For information about personal data collection in Deep Security, see "Privacy and personal data
collection disclosure" on page 1450.
FIPS 140-2 support
Federal Information Processing Standard (FIPS) is a set of standards for cryptographic modules.
For in-depth information about FIPS, see the National Institute of Standards and Technology
(NIST) website. Deep Security provides settings that enable cryptographic modules to run in a
mode that is compliant with FIPS 140-2 standards. We have obtained certification for our Java
crypto module and Native crypto module (OpenSSL).
There are some differences between a Deep Security deployment running in FIPS mode instead
of non-FIPS mode (see "Differences when operating Deep Security in FIPS mode" below).
1417
Trend Micro Deep Security On-Premise 20
Tip: If you intend to replace the Deep Security Manager SSL certificate, do so before enabling
FIPS mode. If you need to replace the certificate after enabling FIPS mode, you will need to
disable FIPS mode, follow the instructions in "Replace the Deep Security Manager TLS
certificate" on page 1245, and then re-enable FIPS mode.
To operate Deep Security in a FIPS 140-2 mode, you will need to:
1. Review "Differences when operating Deep Security in FIPS mode" below to make sure the
Deep Security features you require are available when operating in FIPS 140-2 mode.
2. Ensure that your Deep Security Manager and Deep Security Agents meet the "System
requirements for FIPS mode" on the next page.
3. "Enable FIPS mode for your Deep Security Manager" on page 1420.
4. If your Deep Security Manager needs to connect to an external service (such as an Active
Directory, vCenter, or NSX Manager) using SSL, see "Connect to external services when
in FIPS mode" on page 1421.
5. "Enable FIPS mode for the operating system of the computers you are protecting" on
page 1421.
6. "Enable FIPS mode for the Deep Security Agent on the computers you are protecting" on
page 1422
7. "Enable FIPS mode for the Deep Security Virtual Appliance" on page 1422.
8. With some versions of the Linux kernel, for example, RHEL 7.0 GA, you must enable
Secure Boot to enable FIPS mode. See "Linux Secure Boot support for agents" on
page 1158 for instructions.
This section also includes instructions on how to "Disable FIPS mode" on page 1428.
Differences when operating Deep Security in FIPS mode
These Deep Security features are not available when operating in FIPS mode:
l Connecting to virtual machines hosted on VMware vCloud, as described in "Add virtual
machines hosted on VMware vCloud" on page 439. The Administration > System
Settings > Agents > Agentless vCloud Protection settings are also unavailable.
l Multi-tenant environment
l Load balancer settings (Administration > System Settings > Advanced > Load Balancers)
l Deep Security Scanner (integration with SAP Netweaver)
l The Connected Threat Defense feature
1418
Trend Micro Deep Security On-Premise 20
l Identity provider support via SAML 2.0
l When configuring SMTP settings, the STARTTLS option is not available.
System requirements for FIPS mode
Deep Security Manager requirements
The Deep Security Manager requirements with FIPS mode enabled are the same as those
described in "System requirements" on page 165, with the following exceptions.
Only these operating systems are supported:
l Red Hat Enterprise Linux 7 (64bit)
l Windows Server 2016 (64-bit)
l Windows Server 2012 or 2012 R2 (64-bit)
Only these databases are supported:
l PostgreSQL 9.6 (see "Using FIPS mode with a PostgreSQL database" on page 1423)
l Microsoft SQL Server 2016 Enterprise Edition (See "Using FIPS mode with a Microsoft
SQL Server database" on page 1426)
l Microsoft SQL Server 2014 Enterprise Edition (See "Using FIPS mode with a Microsoft
SQL Server database" on page 1426)
l Microsoft SQL Server 2012 Enterprise Edition (See "Using FIPS mode with a Microsoft
SQL Server database" on page 1426)
Note: Oracle Database is not supported, even if it has enabled FIPS mode for SSL
connections.
Note: Microsoft SQL Server named pipes are not supported.
Deep Security Agent requirements
The Deep Security Agent requirements with FIPS mode enabled are the same as those
described in "System requirements" on page 165. FIPS mode is not supported with all operating
systems. To check which operating systems are supported, see "Supported features by platform"
on page 145.
1419
Trend Micro Deep Security On-Premise 20
Deep Security Virtual Appliance requirements
To support FIPS mode on the appliance, you'll need:
l Deep Security Manager 11.0 Update 3 or later
l Deep Security Virtual Appliance 10.0, or 11.0 or later
l Deep Security Agent 11.0 for RedHat_EL7 or later (to be used as the appliance's
embedded agent)
For details on the appliance's system requirements, see "System requirements" on page 165.
Enable FIPS mode for your Deep Security Manager
Enable FIPS mode for a Deep Security Manager on Windows
1. Use the Services window of the Microsoft Management Console to stop the "Trend Micro
Deep Security Manager" service.
2. In the Windows command line, go to the Deep Security Manager's working folder, for
example, C:\Program Files\Trend Micro\Deep Security Manager.
3. Enter this command to enable FIPS mode:
dsm_c -action enablefipsmode
4. Restart the Deep Security Manager service.
Enable FIPS mode for a Deep Security Manager on Linux
1. On the Deep Security Manager computer, open a command line and go to the Deep
Security Manager's working folder, for example, /opt/dsm.
2. Enter this command to stop the Deep Security Manager service:
service dsm_s stop
3. Enter this command to enable FIPS mode:
dsm_c -action enablefipsmode
4. Enter this command to restart the Deep Security Manager service:
service dsm_s start
1420
Trend Micro Deep Security On-Premise 20
Connect to external services when in FIPS mode
When Deep Security Manager is operating in FIPS mode and you want to connect to an external
service (such as an Active Directory, vCenter, or NSX Manager) with an SSL connection, you
must import the SSL certificate for that external service into the manager before connecting to it.
For instructions on how to import the certificate, see "Manage trusted certificates" on page 1273.
For instructions on importing computers from an Active Directory, see "Add Active Directory
computers" on page 388.
For instructions on synchronizing user information with an Active Directory, see "Add and
manage users" on page 1161.
For instructions on adding a VMware vCenter to Deep Security Manager, see "Add a vCenter -
FIPS mode" on page 438.
Enable FIPS mode for the operating system of the computers
you are protecting
For instructions on enabling FIPS mode on Windows, please refer to the Microsoft Support site:
System cryptography: Use FIPS compliant algorithms for encryption, hashing, and signing"
security setting effects in Windows XP and in later versions of Windows.
For instructions on enabling FIPS mode on RHEL 7 or CentOS 7, please refer to Red Hat
documentation: Federal Standards and Regulations and How can I make RHEL 6 or RHEL 7
FIPS 140-2 compliant.
Enable FIPS mode for the Deep Security Agent on the
computers you are protecting
Note: This step is not required for new Deep Security 11.0 or higher agents that you install
after enabling FIPS mode in Deep Security Manager. In that situation, FIPS mode is already
enabled for the agent.
1421
Trend Micro Deep Security On-Premise 20
Enable FIPS mode for a Windows agent
1. In the Windows system root folder (for example, C:\Windows), look for a file named ds_
agent.ini. Open the file in a text editor or create a new file if you don't have one already.
2. Add this line to the file:
FIPSMode=1
3. Restart the Deep Security Agent service.
Enable FIPS mode for an RHEL 7 or CentOS 7 agent
1. In /etc/), look for a file named ds_agent.conf. Open the file in a text editor or create a
new file if you don't have one already.
2. Add this line to the file:
FIPSMode=1
3. Restart the Deep Security Agent:
Using a SysV init script: /etc/init.d/ds_agent restart
Using a systemd command: systemctl restart ds_agent
Enable FIPS mode for the Deep Security Virtual Appliance
1. In <DSVA_root>/etc/, look for a file named ds_agent.conf. Open the file in a text editor
or create a new file if you don't have one already.
2. Add this line to the file:
FIPSMode=1
3. Restart the appliance from the command line:
Using a SysV init script: /etc/init.d/ds_agent restart
Using a systemd command: systemctl restart ds_agent
Using FIPS mode with a PostgreSQL database
If you are using PostgreSQL as your Deep Security Manager database, there are some extra
requirements in addition to those outlined in "Database requirements" on page 203.
1422
Trend Micro Deep Security On-Premise 20
In FIPS mode, the keystore must be the BCFKS type. Instead of converting the java default
keystore (C:\Program Files\Trend Micro\Deep Security
Manager\jre\lib\security\cacerts or /opt/dsm/jre/lib/security/cacerts) directly,
copy the default keystore to another location and use it as the default keystore for SSL
connection.
1. Create the PostgreSQL environment
2. Copy the "server.crt" file from the PostgreSQL server and paste them into <Deep
Security Manager install folder>.
3. Install Deep Security Manager.
4. "Enable FIPS mode for your Deep Security Manager" on page 1420.
5. Copy the default Java cacerts file into the Deep Security Manager root installation folder.
On Windows:
copy "C:\Program Files\Trend Micro\Deep Security
Manager\jre\lib\security\cacerts" "C:\Program Files\Trend Micro\Deep
Security Manager\cacerts"
On Linux:
cp "/opt/dsm/jre/lib/security/cacerts" "/opt/dsm/cacerts"
6. Convert the keystore file from JKS to BCFKS. The following command will create a
cacerts.bcfks file in the Deep Security Manager installation folder:
On Windows:
cd C:\Program Files\Trend Micro\Deep Security Manager\jre\bin
keytool -importkeystore -srckeystore "C:\Program Files\Trend
Micro\Deep Security Manager\cacerts" -srcstoretype JKS -deststoretype
BCFKS -destkeystore "C:\Program Files\Trend Micro\Deep Security
Manager\cacerts.bcfks" -srcstorepass <changeit> -deststorepass
<changeit> -providerpath "C:\Program Files\Trend Micro\Deep Security
Manager\jre\lib\ext\ccj-3.0.0.jar" -providerclass
com.safelogic.cryptocomply.jcajce.provider.CryptoComplyFipsProvider
where <changeit> is replaced with your own values.
On Linux:
cd /opt/dsm/jre/bin
1423
Trend Micro Deep Security On-Premise 20
keytool -importkeystore -srckeystore "/opt/dsm/cacerts" -srcstoretype
JKS -deststoretype BCFKS -destkeystore "/opt/dsm/cacerts.bcfks" -
srcstorepass <changeit> -deststorepass <changeit> -providerpath
"/opt/dsm/jre/lib/ext/ccj-3.0.0.jar" -providerclass
com.safelogic.cryptocomply.jcajce.provider.CryptoComplyFipsProvider
where <changeit> is replaced with your own values.
7. Import the certificate ("Deep Security Manager root folder/server.crt"):
On Windows:
cd C:\Program Files\Trend Micro\Deep Security Manager\jre\bin
keytool -import -alias psql -file "C:\Program Files\Trend Micro\Deep
Security Manager\server.crt" -keystore "C:\Program Files\Trend
Micro\Deep Security Manager\cacerts.bcfks" -storepass <changeit> -
provider
com.safelogic.cryptocomply.jcajce.provider.CryptoComplyFipsProvider -
providerpath "C:\Program Files\Trend Micro\Deep Security
Manager\jre\lib\ext\ccj-3.0.0.jar" -storetype BCFKS
where <changeit> is replaced with your own value.
On Linux:
cd /opt/dsm/jre/bin
keytool -import -alias psql -file "/opt/dsm/server.crt" -keystore
"/opt/dsm/cacerts.bcfks" -storepass <changeit> -provider
com.safelogic.cryptocomply.jcajce.provider.CryptoComplyFipsProvider -
providerpath "/opt/dsm/jre/lib/ext/ccj-3.0.0.jar" -storetype BCFKS
where <changeit> is replaced with your own value.
8. The Deep Security installer can use a .vmoptions file to assign the JVM parameter:
On Windows, create a file named Deep Security Manager.vmoptions in the
installation folder and add the following text in the file:-
Djavax.net.ssl.keyStoreProvider=CCJ
-Djavax.net.ssl.trustStore=C:\Program Files\Trend Micro\Deep Security
Manager\cacerts.bcfks
1424
Trend Micro Deep Security On-Premise 20
-Djavax.net.ssl.trustStorePassword=<changeit>
-Djavax.net.ssl.keyStoreType=BCFKS
-Djavax.net.ssl.trustStoreType=BCFKS
where <changeit> is replaced with your own value.
On Linux, create a file named dsm_s.vmoptions in the installation folder and add the
following text in the file:
-Djavax.net.ssl.keyStoreProvider=CCJ
-Djavax.net.ssl.trustStore=/opt/dsm/cacerts.bcfks
-Djavax.net.ssl.trustStorePassword=<changeit>
-Djavax.net.ssl.keyStoreType=BCFKS
-Djavax.net.ssl.trustStoreType=BCFKS
where <changeit> is replaced with your own value.
9. Open the <Deep Security Manager directory>\webclient\webapps\ROOT\WEB-
INF\dsm.properties file in a text editor and add:
database.PostgreSQL.connectionParameters=ssl=true
10. Open the /opt/postgresql/data/postgresql.conf file in a text editor and add:
ssl= on
ssl_cert_file= 'server.crt'
ssl_ksy_file= 'server.key'
11. Restart PostgreSQL and then restart the Deep Security Manager service.
12. Check the connection:
cd /opt/postgresql/bin
./psql -h 127.0.0.1 -Udsm dsm
Enter the password when prompted. You should see:
dsm=> select a.client_addr, a.application_name, a.usename, s.* from
pg_stat_ssl s join pg_stat_activity a using (pid) where
a.datname='dsm';
1425
Trend Micro Deep Security On-Premise 20
Using FIPS mode with a Microsoft SQL Server database
If you are using Microsoft SQL Server as your Deep Security Manager database, you must set up
the database SSL encryption using the instructions below before enabling FIPS mode.
1. Stop the Deep Security Manager service.
2. Create a BCFKS keystore file with the SQL server certificate. You can use the keytool in
C:\Program Files\Trend Micro\Deep Security Manager\jre\bin.
3. Use the following command to import the SQL server certificate (C:\sqlserver_
cert.cer) to a new keystore file (C:\Program Files\Trend Micro\Deep Security
Manager\mssql_keystore.bcfks):
Note: If the Deep Security Manager package doesn't contain a ccj-3.0.0.jar file, get
the jar file from the FIPS page.
keytool -import -alias mssql -file "C:\sqlserver_cert.cer" -keystore
"C:\Program Files\Trend Micro\Deep Security Manager\mssql_
keystore.bcfks" -storepass <changeit> -provider
com.safelogic.cryptocomply.jcajce.provider.CryptoComplyFipsProvider -
providerpath "C:\Program Files\Trend Micro\Deep Security
Manager\jre\lib\ext\ccj-3.0.0.jar" -storetype BCFKS
where <changeit> is replaced with your own value.
During the import process, answer "YES" to trust this certificate.
4. If the keystore file is created successfully, you will be able to use the following command to
list see the certificate listed in the keystore:
keytool -list -v -keystore "C:\Program Files\Trend Micro\Deep Security
Manager\mssql_keystore.bcfks" -provider
com.safelogic.cryptocomply.jcajce.provider.CryptoComplyFipsProvider -
providerpath "C:\Program Files\Trend Micro\Deep Security
Manager\jre\lib\ext\ccj-3.0.0.jar" -storetype BCFKS -storepass
<changeit>
where <changeit> is replaced with your own value.
5. Open the C:\Program Files\Trend Micro\Deep Security
Manager\webclient\webapps\ROOT\WEB-INF\dsm.properties file in a text editor and
add the following lines enable SSL/TLS and FIPS settings:
database.SqlServer.encrypt=true
1426
Trend Micro Deep Security On-Premise 20
database.SqlServer.trustServerCertificate=false
database.SqlServer.fips=true
database.SqlServer.trustStorePassword=<changeit>
database.SqlServer.fipsProvider=CCJ
database.SqlServer.trustStoreType=BCFKS
database.SqlServer.trustStore=C\:\\Program Files\\Trend Micro\\Deep
Security Manager\\mssql_keystore.bcfks
where <changeit> is replaced with your own value.
6. Optionally, you can also change the SQL server/client connection protocols from Named
Pipes to TCP/IP. This will allow for FIPS support after upgrading to Deep Security 10.2:
a. In the SQL Server Configuration Manager, go to SQL Network Configuration >
Protocols for MSSQLSERVER and enable TCP/IP.
b. Go to SQL Native Client 11.0 Configuration > Client Protocols and enable TCP/IP.
c. Follow the instruction provided by Microsoft to enable encrypted connections for an
instance of the SQL Server database. See Enable Encrypted Connections to the
Database Engine.
d. Edit the dsm.properties file to change database.sqldserver. driver=MSJDBC
and database.SqlServer.namedPipe=false.
7. Restart the Deep Security Manager service.
8. "Enable FIPS mode for your Deep Security Manager" on page 1420.
Disable FIPS mode
1. To disable FIPS mode for the Deep Security Manager, follow the instructions that you used
to enable it (see "Enable FIPS mode for your Deep Security Manager" on page 1420), but
use this command in place of step 3:
dsm_c -action disablefipsmode
2. To disable FIPS mode for the Deep Security Agent, follow the instructions that you used to
enable it (see "Enable FIPS mode for the Deep Security Agent on the computers you are
protecting" on page 1422), but instead of FIPSMode=1, use FIPSMode=0.
1427
Trend Micro Deep Security On-Premise 20
Bypass vulnerability management scan traffic in Deep
Security
If you are using a vulnerability management provider such as Qualys or Nessus (for PCI
compliance, for example), you need to set up Deep Security to bypass or allow this provider’s
scan traffic through untouched.
l "Create a new IP list from the vulnerability scan provider IP range or addresses" below
l "Create firewall rules for incoming and outbound scan traffic" on the next page
l "Assign the new firewall rules to a policy to bypass vulnerability scans" on page 1430
After these firewall rules have been assigned to the new policy, the Deep Security Manager will
ignore ANY traffic from the IPs you have added in your IP List.
Deep Security will not scan the vulnerability management provider traffic for stateful issues or
vulnerabilities - it will be allowed through untouched.
Create a new IP list from the vulnerability scan provider IP
range or addresses
Have handy the IP addresses that the vulnerability scan provider has given you.
1. In the Deep Security Manager, go to Policies.
2. In the left pane, expand Lists > IP Lists.
3. Click New > New IP List.
4. Type a Name for the new IP List, for example "Qualys IP list".
5. Paste the IP addresses that the vulnerability management provider has given you into the
IP(s) box, one per line.
6. Click OK.
Create firewall rules for incoming and outbound scan traffic
After you’ve created the IP list, you need to create two firewall rules: one for incoming and one
for outgoing traffic.
Name them as suggested, below:
<name of provider> Vulnerability Traffic - Incoming
<name of provider> Vulnerability Traffic - Outgoing
1428
Trend Micro Deep Security On-Premise 20
1. In the main menu, click Policies.
2. In the left pane, expand Rules.
3. Click Firewall Rules > New > New Firewall Rule.
4. Create the first rule to bypass Inbound AND Outbound for TCP and UDP connections that
are incoming to and outgoing from vulnerability management provider.
Tip: For settings not specified, you can leave them as the default.
Name: (suggested) <name of provider> Vulnerability Traffic - Incoming
Action: Bypass
Protocol: Any
Packet Source: IP List and then select the new IP list created above.
5. Create a second rule:
Name: <name of provider> Vulnerability Traffic - Outgoing
Action: Bypass
Protocol: Any
Packet Destination: IP List and then select the new IP list created above.
Assign the new firewall rules to a policy to bypass vulnerability
scans
Identify which policies are already used by computers that will be scanned by the vulnerability
management provider.
Edit the policies individually to assign the rules in the firewall module.
1. Click Policies on the main menu.
2. Click Policies in the left pane.
3. In the right pane, for each policy, double-click to open the policy details.
4. In the pop-up, in the left pane, click Firewall.
5. Under Assigned Firewall Rules, click Assign/Unassign.
1429
Trend Micro Deep Security On-Premise 20
6. Ensure your view at the top-left shows All firewall rules in the .
7. Use the search window to find the rules you created and select them.
8. Click OK.
Use TLS 1.2 with Deep Security
In Deep Security Manager 11.1 and higher, TLS 1.2 is enforced by default for new installations.
Review the table below to determine whether you need to take action.
Note: If you want to enable TLS 1.2 with only strong, A+-rated, cipher suites, see instead
"Enable TLS 1.2 strong cipher suites" on page 1445. Use of strong cipher suites may cause
compatibility issues.
And your
If you are doing... deployment Do this...
includes...
Only 10.0
and higher
Deep Nothing.
Security
Agents, By default, TLS 1.2 is used between all components and
Relays, enforced on the manager and relays.
and Virtual
A new Appliances
installation of
Deep Security (Recommended.) Upgrade all of your components to 10.0 or
Manager 11.1
or higher Pre-10.0 higher versions which support TLS 1.2. See "Upgrade
Deep components to use TLS 1.2" on page 1436. This is the best
Security
Agents, option to increase the security of your deployment.
Relays, or
Virtual Alternatively, you can enable early TLS 1.0 to ensure
Appliances backward compatibility with older components. See "Enable
early TLS (1.0)" on page 1441.
An upgrade to Only 10.0
Deep Security (Recommended.) Enable TLS 1.2 enforcement to increase
1430
Trend Micro Deep Security On-Premise 20
And your
If you are doing... deployment Do this...
includes...
the security of your deployment. See "Enforce TLS 1.2" on
page 1438.
and higher
Deep Alternatively, you can do nothing. Whatever your TLS
Security
Agents, settings were in your previous deployment are preserved. If
Relays, or you had enforced TLS 1.2 before, then your enforcement
Virtual settings are preserved after the upgrade. Conversely, if you
Appliances
had disabled enforcement, then those settings are
preserved as well.
Manager 11.1
or higher (Recommended.) Although no immediate action is required,
you should plan to upgrade older components to 10.0 or
higher which support TLS 1.2, and then enforce TLS 1.2.
Pre-10.0
Deep See "Upgrade components to use TLS 1.2" on page 1436
Security and "Enforce TLS 1.2" on page 1438. This is the best option
Agents, to increase the security of your deployment.
Relays, or
Virtual Alternatively, you can do nothing. Whatever your TLS
Appliances
settings were in your previous deployment are preserved. If
TLS 1.0 was allowed before, then it will also be allowed
after the upgrade.
Topics on this page:
l "TLS 1.2 architectures" below
l "Upgrade components to use TLS 1.2" on page 1436
l "Enforce TLS 1.2" on page 1438
l "Enable early TLS (1.0)" on page 1441
l "Determine whether TLS 1.2 is enforced" on page 1443
l "Guidelines for deploying agents, virtual appliances, and relays after TLS 1.2 is enforced"
on page 1444
1431
Trend Micro Deep Security On-Premise 20
TLS 1.2 architectures
The diagrams below show the TLS communication in the Deep Security architecture.
Figure 1 shows the TLS communication when TLS 1.2 is enforced (This is the default for new
11.1 or higher Deep Security Manager installations.) You can see that the 9.6 agents can no
longer communicate with Deep Security Manager, and neither can older third-party applications.
Figure 2 shows the TLS communication when TLS 1.2 is not enforced. You can see that 10.0 or
higher agents communicate with Deep Security Manager over TLS 1.2, while 9.6 versions
communicate over early TLS. Similarly, newer third-party applications use TLS 1.2, while older
ones use early TLS.
Figure 1: TLS 1.2 is enforced
1432
Trend Micro Deep Security On-Premise 20
1433
Trend Micro Deep Security On-Premise 20
Figure 2: TLS 1.2 is not enforced
1434
Trend Micro Deep Security On-Premise 20
1435
Trend Micro Deep Security On-Premise 20
Upgrade components to use TLS 1.2
If you want your Deep Security components to use TLS 1.2, just make sure that each component
supports TLS 1.2.
Follow the instructions below to verify that your Deep Security components support TLS 1.2 and
upgrade them if needed.
Note: If you want to enforce TLS 1.2 and prevent the use of early TLS, see instead "Enforce
TLS 1.2" on page 1438.
Verify and upgrade your Deep Security Manager
l Make sure you're using one of the following versions of Deep Security Manager, and if not,
upgrade it:
l Use Deep Security Manager 10.0 update 8 or later if you're planning to "Enforce TLS
1.2" on page 1438 on the manager. Only 10.0 update 8 and later managers support
TLS 1.2 enforcement.
l Use Deep Security Manager 10.0 or later if you're not planning to "Enforce TLS 1.2" on
page 1438 on the manager. Only 10.0 and later managers support TLS 1.2
communication.
l For upgrade instructions see "Upgrade Deep Security Manager" on page 1289.
Verify your Deep Security Manager database
l If you're using Microsoft SQL Server as your Deep Security Manager database, make sure
the database supports TLS 1.2, and if not, upgrade it. See this Microsoft article for
guidance.
l If you're using a PostgrSQL database, it supports TLS 1.2 so no action is necessary.
l If you're using an Oracle database, only Oracle's native encryption is supported for
database-manager communication, not TLS, so no action is necessary.
l By default, there is no encryption between the database (SQL Server, PostgreSQL, or
Oracle) and Deep Security Manager. You can enable it manually.
1436
Trend Micro Deep Security On-Premise 20
Verify your Deep Security Agents
l If you have existing Deep Security Agents, make sure they're at version 10.0 or higher.
Only 10.0 or higher agents support TLS 1.2.
Note: If some agents are left un-upgraded (that is, they are pre-10.0), those agents
communicate over early TLS, and you may need to enable early TLS. For details, see "Enable
early TLS (1.0)" on page 1441.
To upgrade your agents, see "Upgrade Deep Security Agent" on page 1295.
Verify your Deep Security Relays
l Make sure you're using one of the following versions of Deep Security Relay, and if not,
upgrade it:
l Use Deep Security Relay 10.0 update 8 or later if you're planning to "Enforce TLS 1.2"
on the next page on the relay. Only 10.0 update 8 and higher relays support TLS 1.2
enforcement.
l Use Deep Security Relay 10.0 or later if you're not planning to "Enforce TLS 1.2" on
the next page on the relay. Only 10.0 and higher relays support TLS 1.2
communication.
To upgrade a relay, see "Upgrade Deep Security Relay" on page 1294.
Verify your Deep Security Virtual Appliance
Make sure you're using Deep Security Virtual Appliance 10.0 or higher.
To upgrade the appliance:
1. Temporarily enable early TLS (1.0).
2. Upgrade the appliance to 10.0 or higher (see "Upgrade an existing appliance SVM
automatically" on page 1307). The new virtual appliance now supports TLS 1.2.
3. Once the upgrade is finished, re-enable TLS 1.2 enforcement.
Note: The minimum VSphere and NSX software versions required for the virtual appliance
already support TLS 1.2. See "System requirements" on page 165 for details.
1437
Trend Micro Deep Security On-Premise 20
Enforce TLS 1.2
Topics in this section:
l "Where can TLS 1.2 be enforced?" below
l "What happens when TLS 1.2 enforced?" below
l "Is TLS 1.2 enforced by default?" below
l "Under what circumstances is TLS 1.2 enforcement possible? " on the next page
l "Enforce TLS 1.2 on Deep Security Manager" on the next page
l "Enforce TLS 1.2 on the Deep Security Relay" on the next page
l "Enforce TLS 1.2 on just the manager's GUI port (4119)" on page 1440
l "Test that TLS 1.2 is enforced" on page 1440
Where can TLS 1.2 be enforced?
There are two enforcement points:
l on the Deep Security Manager
l on the Deep Security Relays
What happens when TLS 1.2 enforced?
When TLS 1.2 is enforced, the manager and relays stop accepting early TLS connections, and
any applications that try to use early TLS are denied access and cease to function properly.
If you choose not to enforce TLS 1.2, the manager and relays still accept early TLS as well as
TLS 1.2 connections. This means that both older and newer applications are able to connect.
Is TLS 1.2 enforced by default?
l If you have a new installation of Deep Security Manager 11.1 or higher (not an upgrade),
TLS 1.2 is enforced by default.
l If you are upgrading an existing Deep Security Manager to 11.1 or higher, then your
existing TLS settings are preserved, so if TLS was not enforced previously, it will continue
to not be enforced after the upgrade. Conversely, if it was enforced, it will continue to be
enforced.
1438
Trend Micro Deep Security On-Premise 20
Under what circumstances is TLS 1.2 enforcement possible?
You can only enforce TLS 1.2 if all Deep Security Agents have been upgraded to 10.0 or higher,
which is the version at which TLS 1.2 is supported.
Enforce TLS 1.2 on Deep Security Manager
1. Before you begin:
l Make sure that Deep Security Manager is at version 10.0 Update 8 or higher. You
need this version to enforce TLS 1.2.
l Make sure that all other components support TLS 1.2. See "Upgrade components to
use TLS 1.2" on page 1436.
2. On the Deep Security Manager computer, run this dsm_c command:
dsm_c -action settlsprotocol -MinimumTLSProtocol ShowValue
A TLS version appears. This is the minimum TLS version that Deep Security Manager
currently accepts.
3. Run this dsm_c command:
dsm_c -action settlsprotocol -MinimumTLSProtocol TLSv1.2
This command sets the minimum TLS version to 1.2. Deep Security Manager now accepts
TLS 1.2 connections and disallows TLS 1.0 connections.
The Deep Security Manager service is restarted automatically.
Enforce TLS 1.2 on the Deep Security Relay
1. Before you begin:
l Make sure that Deep Security Relay is at version 10.0 Update 8 or higher. You need
this version to enforce TLS 1.2.
l Make sure that all your components support TLS 1.2. See "Upgrade components to
use TLS 1.2" on page 1436.
l Make sure that you have enforced TLS 1.2 on Deep Security Manager.
2. Resend the policies associated with your relays:
a. In Deep Security Manager, click Computers and find one of your relays in the list of
computers. If you're not sure which ones are your relays, at the top, click
Administration. On the left, expand Updates and then click Relay Management. In the
1439
Trend Micro Deep Security On-Premise 20
main pane, expand a relay group to see your relays.
b. Double-click the relay in the list of computers.
c. In the main pane, click the Actions tab.
d. Click Send Policy to resend the policy.
e. Resend the policy to each of your relays.
Enforce TLS 1.2 on just the manager's GUI port (4119)
Only read this section if you were unable to do a full enforcement on the Deep Security Manager
and Relays as described previously in "Enforce TLS 1.2 on Deep Security Manager" on the
previous page and "Enforce TLS 1.2 on the Deep Security Relay" on the previous page.
This section describes how to set the minimum TLS version to TLS 1.2 on port 4119.
Applications that connect on port 4119 are typically web browsers and Deep Security API
clients. Older Deep Security components that do not support TLS 1.2 can continue to connect to
the manager (on port 4120, by default) using TLS 1.0.
1. On Deep Security Manager, enable TLS 1.0 by running this dsm_c command:
dsm_c -action settlsprotocol -MinimumTLSProtocol TLSv1
Deep Security Manager now accepts TLS 1.0 connections from older agents and
applications.
2. Disable early TLS on the manager's GUI port (4119) (it is possible that it's already
disabled):
a. Open the configuration.properties file in the root of the Deep Security Manager
installation directory.
b. Under serviceName=, look for the protocols= setting.
This setting defines the protocols that can be used to connect to Deep Security
Manager when it is acting as a server to web browsers and Deep Security API clients.
c. If the protocols= setting is present, remove it so that only TLS 1.2 is allowed on port
4119.
d. Save the file.
3. Restart the Deep Security Manager service.
Test that TLS 1.2 is enforced
1. On a Deep Security component where early TLS 1.2 is enforced, run the following nmap
command:
1440
Trend Micro Deep Security On-Premise 20
nmap --script ssl-enum-ciphers <ds_host> -p <ds_port> -Pn
where:
l <ds_host> is replaced with the IP address or hostname of the manager or relay
l <ds_port> is replaced with the listening port where TLS is being used (4119 for
manager, 4122 for the relay, and 4118 for the agent—if manager-initiated activation is
used)
The response should only list TLS 1.2. Example response:
PORT STATE SERVICE
443/tcp open https
| ssl-enum-ciphers:
| | TLSv1.2:
| ciphers:
| TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (secp256r1) - A
| TLS_RSA_WITH_AES_256_GCM_SHA384 (rsa 2048) - A
| TLS_RSA_WITH_AES_128_GCM_SHA256 (rsa 2048) - A
| TLS_RSA_WITH_AES_256_CBC_SHA256 (rsa 2048) - A
| TLS_RSA_WITH_AES_128_CBC_SHA256 (rsa 2048) - A
| TLS_RSA_WITH_AES_256_CBC_SHA (rsa 2048) - A
| TLS_RSA_WITH_AES_128_CBC_SHA (rsa 2048) - A
| TLS_RSA_WITH_3DES_EDE_CBC_SHA (rsa 2048) - C
| compressors:
Enable early TLS (1.0)
By default, early TLS (1.0) is disabled. You'll need to enable it if you have a new installation of
Deep Security Manager 11.1 or higher (not an upgrade) and:
1441
Trend Micro Deep Security On-Premise 20
l you are using pre-10.0 agents. These only support early TLS. Go here to see if a 10.0 or
higher agent is available for your OSs.
l you are using third-party components that are older and need to use early TLS to
communicate with Deep Security Manager.
l you are using a pre-10.0 version of the Deep Security Virtual Appliance (which is no longer
supported).
To enable early TLS (1.0), follow the instructions below.
Enable TLS 1.0 on Deep Security Manager and the Deep Security
Relay
1. On the Deep Security Manager computer, run this dsm_c command:
dsm_c -action settlsprotocol -MinimumTLSProtocol ShowValue
A TLS version appears. This is the minimum TLS version that Deep Security Manager
currently accepts.
2. Run this dsm_c command:
dsm_c -action settlsprotocol -MinimumTLSProtocol TLSv1
This command sets the minimum TLS version to 1.0.
TLS 1.0 is now re-enabled on your Deep Security Manager.
The Deep Security Manager service is restarted automatically.
3. Resend the policies associated with your relays:
a. In Deep Security Manager, click Computers and find one of your relays in the list of
computers. If you're not sure which ones are your relays, at the top, click
AdministrationOn the left, expand Updates and then click Relay Management. In the
main pane, expand a relay group to see your relays.
b. Double-click the relay in the list of computers.
c. In the main pane, click the Actions tab.
d. Click Send Policy to resend the policy.
e. Resend the policy to each of your relays.
TLS 1.0 is now re-enabled on your relays.
1442
Trend Micro Deep Security On-Premise 20
Enable TLS 1.0 on the manager's GUI port (4119)
Read this section if you previously enforced TLS 1.2 only on the manager's GUI port (4119) and
now want to re-enable early TLS 1.0 on this port.
1. Follow the instructions in "Enable TLS 1.0 on Deep Security Manager and the Deep
Security Relay" on the previous page. This re-enables TLS 1.0 on the GUI port (4119).
Enable TLS 1.0 in deployment scripts
Deep Security Agents and Deep Security Relays can be deployed using deployment scripts.
You may need to modify these scripts as follows:
1. If you are deploying onto Windows XP, 2003, or 2008, remove these lines from the
deployment script:
#requires -version 4.0
[Net.ServicePointManager]::SecurityProtocol =
[Net.SecurityProtocolType]::Tls12;
Windows XP, 2003, and 2008 do not support PowerShell 4.0, which is required for TLS
1.2.
2. If you are deploying onto Red Hat Enterprise Linux 6, remove this tag from the deployment
script:
--tls1.2
Red Hat Enterprise Linux 6 uses curl 7.19 by default which does not support TLS 1.2.
3. If you are deploying onto any other supported operating system, leave the deployment
scripts as they are.
Determine whether TLS 1.2 is enforced
If you're not sure whether TLS 1.2 is enforced on Deep Security Manager, follow the instructions
below to find out.
1. On the Deep Security Manager computer, open a command prompt and run the following
dsm_c command:
dsm_c -action settlsprotocol -MinimumTLSProtocol ShowValue
1443
Trend Micro Deep Security On-Premise 20
The minimum TLS protocol accepted by the manager is displayed. If it shows TLS 1.2,
then TLS 1.2 is enforced. If it shows TLS 1.0, then early TLS is allowed and TLS 1.2 is not
enforced.
Determining whether TLS 1.2 is enforced on the relay is harder. If you pushed out your TLS
settings to the relay through policy according to "Enforce TLS 1.2 on the Deep Security Relay"
on page 1439 or "Enable TLS 1.0 on Deep Security Manager and the Deep Security Relay" on
page 1442, then those TLS settings apply to the relay. If you did not push out TLS settings
through policy, then the relay's default TLS settings apply. The relay's default settings depend on
its version: if you're using an 11.1 or higher relay, then TLS 1.2 is enforced by default. For pre-
11.1 relays, TLS 1.2 is not enforced by default.
Guidelines for deploying agents, virtual appliances, and
relays after TLS 1.2 is enforced
This section discusses special considerations when deploying agents, virtual appliances and
relays when TLS 1.2 is enforced. If you enabled early TLS (1.0), then there are no special
considerations, and you do not need to read this section.
Topics in this section:
l "Guidelines for deploying agents, virtual appliances, and relays when TLS 1.2 is enforced"
below
l "Guidelines for using deployment scripts when TLS 1.2 is enforced" below
Guidelines for deploying agents, virtual appliances, and relays when
TLS 1.2 is enforced
l You must deploy 10.0 or higher agents, virtual appliances, and relays. Only 10.0 or higher
agents and relays support TLS 1.2.
l If you need to deploy a 9.6 or earlier agent or relay you must enable early TLS (1.0).
Guidelines for using deployment scripts when TLS 1.2 is enforced
If TLS 1.2 is enforced, you can install 10.0 or higher agents and relays using deployment scripts.
Below are some guidelines to ensure the deployment scripts work:
1444
Trend Micro Deep Security On-Premise 20
1. If you are deploying an agent or relay onto Windows computers, use PowerShell 4.0 or
higher, which supports TLS 1.2.
2. If you are deploying an agent or relay onto Linux, use curl 7.34.0 or higher, which supports
TLS 1.2.
3. If you are deploying onto Windows XP, 2003, or 2008
OR
If you are deploying onto Red Hat Enterprise Linux 6
...these OSs don't support TLS 1.2 and you must "Enable early TLS (1.0)" on page 1441
and modify your deployment scripts.
Enable TLS 1.2 strong cipher suites
Enabling strong cipher suites allows you to be certain that all of the communications to and from
your Deep Security components are secure. If a malicious user were to create a connection to
your system over a communications channel that uses weak cipher suites, this person could
exploit the known weaknesses in these suites to put your system and information at risk.
This page describes how to update the Deep Security Manager, Deep Security Agent and Deep
Security Relay so that they use the TLS 1.2 strong cipher suites. These cipher suites have an
Advanced+ (A+) rating, and are listed in the table on this page.
Note: Enabling strong cipher suites involves upgrading all your Deep Security components to
12.0 or later. If this is not possible—for example, you're using operating systems for which a
12.0 agent is not available—see instead "Use TLS 1.2 with Deep Security" on page 1430.
Step 1: "Update Deep Security components" below
Step 2: "Run a script to enable TLS 1.2 strong cipher suites" on the next page
Step 3: "Verify that the script worked" on page 1447
"Disable TLS 1.2 strong cipher suites" on page 1449
Update Deep Security components
Make sure you update all components in the order listed below or else the agents will not be
able to communicate with the relays and manager.
1445
Trend Micro Deep Security On-Premise 20
1. Update all your manager instances to 12.0 or a later update. For upgrade instructions, see
"Install Deep Security Manager" on page 210.
2. Update all your relays to 12.0 or later. To upgrade a relay, follow the same process as
upgrading an agent:
a. Import the latest relay software into the manager, either manually or automatically. See
"Import agent software" on page 268 for details.
b. Upgrade the relay. See "Upgrade Deep Security Relay" on page 1294.
3. Update all your agents to 12.0 or later. To upgrade your agents:
a. Import the latest agent software into the manager, either manually or automatically.
See "Import agent software" on page 268 for details.
b. Upgrade your Deep Security Agents. See "Upgrade Deep Security Agent" on
page 1295.
Run a script to enable TLS 1.2 strong cipher suites
1. Copy the EnableStrongCiphers12.script file available at https://github.com/deep-
security/ops-tools/tree/master/deepsecurity/manager to:
l On Windows: <Manager_root>\Scripts
l On Linux: <Manager_root>/Scripts
where <Manager_root> is replaced with the path to your manager's installation directory,
by default:
l C:\Program Files\Trend Micro\Deep Security Manager (Windows)
l /opt/dsm/ (Linux)
Note: If you do not see a \Scripts directory, create it.
2. Log in to the manager.
3. Click Administration at the top.
4. On the left, click Scheduled Tasks.
5. In the main pane, click New.
6. The New Scheduled Task Wizard appears.
7. From the Type drop-down list, select Run Script. Select Once Only. Click Next.
8. Accept the date, time, and time zone defaults and click Next.
9. For the Script, select EnableStrongCiphers.script. Click Next.
10. For the Name, enter a name for the script, for example, Enable Strong Cipher Suites.
Make sure Task Enabled is selected. Click Run Task on ‘Finish’. Click Finish.
The script runs.
1446
Trend Micro Deep Security On-Premise 20
11. Restart the Deep Security Manager service.
Your agents, relays, and manager should now be communicating with each other using
TLS 1.2 strong cipher suites exclusively.
Verify that the script worked
To verify that the script worked, and that only strong TLS 1.2 cipher suites are permitted, you
must run a series of nmap commands.
l "Verify the manager using nmap" below
l "Verify the relays using nmap" on the next page
l "Verify the agents using nmap" on page 1449
Verify the manager using nmap
Run this command:
nmap --script ssl-enum-ciphers -p 4119 <Manager_FQDN>
The output should look similar to the following, with the strong cipher suites near the middle:
Starting Nmap 7.01 ( https://nmap.org ) at 2018-11-14 09:51 EST
Nmap scan report for <DSM FQDN> (X.X.X.X)
Host is up (0.0049s latency).
PORT STATE SERVICE
4119/tcp open assuria-slm
| ssl-enum-ciphers:
| TLSv1.2:
| ciphers:
| TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (secp256k1) - A
| TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (secp256k1) - A
| TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (secp256k1) - A
| TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (secp256k1) - A
| compressors:
1447
Trend Micro Deep Security On-Premise 20
| NULL
| cipher preference: client
|_ least strength: A
Nmap done: 1 IP address (1 host up) scanned in 6.82 seconds
Verify the relays using nmap
Run this command:
nmap --script ssl-enum-ciphers -p 4122 <Relay_FQDN>
The output should look similar to the following, again, with the strong cipher suites listed near
the middle:
Starting Nmap 7.01 ( https://nmap.org ) at 2018-11-14 09:49 EST
Nmap scan report for <DSR FQDN> (X.X.X.X)
Host is up (0.0045s latency).
PORT STATE SERVICE
4122/tcp open unknown
| ssl-enum-ciphers:
| TLSv1.2:
| ciphers:
| TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (secp256r1) - A
| compressors:
| NULL
| cipher preference: server
|_ least strength: A
Nmap done: 1 IP address (1 host up) scanned in 31.02 seconds
1448
Trend Micro Deep Security On-Premise 20
Verify the agents using nmap
Run this command:
nmap --script ssl-enum-ciphers -p 4118 <Agent_FQDN>
The output looks similar to the following:
Starting Nmap 7.01 ( https://nmap.org ) at 2018-11-14 09:50 EST
Nmap scan report for <DSA FQDN> (X.X.X.X)
Host is up (0.0048s latency).
PORT STATE SERVICE
4118/tcp open netscript
| ssl-enum-ciphers:
| TLSv1.2:
| ciphers:
| TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 (secp256r1) - A
| TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 (secp256r1) - A
| compressors:
| NULL
| cipher preference: server
|_ least strength: A
Nmap done: 1 IP address (1 host up) scanned in 2.72 seconds
Disable TLS 1.2 strong cipher suites
If you mistakenly run the script before upgrading all of your agents, relays, or the manager, you
can revert this action by doing the following:
1. Open the configuration.properties file in <Manager_root>, and remove the line
starting with ciphers. The line looks similar to the following:
1449
Trend Micro Deep Security On-Premise 20
ciphers=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_
128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_RSA_
WITH_AES_128_CBC_SHA256
2. Add the following values to the protocols field: TLSv1 and TLSv1.1. Your final property
looks similar to this:
protocols = TLSv1, TLSv1.1, TLSv1.2
3. Save and close the file.
4. Open the java.security file in <Manager_root>\jre\lib\security\ and remove the
following two protocols from jdk.tls.disabledAlgorithms:
TLSv1, TLSv1.1
5. On Deep Security Manager, run the following dsm_c commands:
dsm_c –action changesetting –name
settings.configuration.restrictRelayMinimumTLSProtocol –value TLSv1
dsm_c –action changesetting –name
settings.configuration.enableStrongCiphers –value false
Your system should now be able to communicate again. If you still need to enable TLS 1.2
strong cipher suites, make sure you have upgraded all components before running the
script.
If you continue to experience communication problems with the Deep Security Manager, run this
additional dsm_c command:
dsm_c –action changesetting –name
settings.configuration.MinimumTLSProtocolNewNode –value TLSv1
Legal disclosures
Privacy and personal data collection disclosure
Certain features available in Trend Micro products collect and send feedback regarding product
usage and detection information to Trend Micro. Some of this data is considered personal in
certain jurisdictions and under certain regulations. If you do not want Trend Micro to collect
personal data, you must ensure that you disable the related features.
1450
Trend Micro Deep Security On-Premise 20
The following link outlines the types of data that Trend Micro Deep Security collects and
provides detailed instructions on how to disable the specific features that feed back the
information.
https://success.trendmicro.com/data-collection-disclosure
Data collected by Trend Micro is subject to the conditions stated in the Trend Micro Privacy
Policy:
https://www.trendmicro.com/en_us/about/legal/privacy.html
Deep Security Product Usage Data Collection
Trend Micro collects anonymous performance and feature usage data to help improve Deep
Security Manager. Trend Micro only uses the collected data internally for product improvement; it
is not shared with external parties and does not contain any personally identifiable information.
As the data allows Trend Micro to more effectively support Deep Security, we recommend that
you leave data collection enabled. However, if you do not want Deep Security Manager to
collect this data, you can disable data collection.
To disable data collection, go to System Settings > Advanced > Product Usage Data Collection
and deselect Enable Product Usage Data Collection.
Legal disclaimer
Below are the legal disclaimers regarding the following releases:
l "Hot Fix" below
l "Major release, Update, Patch or Service Pack" on the next page
Hot Fix
This hot fix was developed as a workaround or solution to a customer-reported problem. As
such, this hot fix has received limited testing and has not been certified as an official product
update.
Consequently, THIS HOT FIX IS PROVIDED "AS IS". TREND MICRO MAKES NO
WARRANTY OR PROMISE ABOUT THE OPERATION OR PERFORMANCE OF THIS HOT
FIX NOR DOES IT WARRANT THAT THIS HOT FIX IS ERROR FREE. TO THE FULLEST
EXTENT PERMITTED BY LAW, TREND MICRO DISCLAIMS ALL IMPLIED AND
1451
Trend Micro Deep Security On-Premise 20
STATUTORY WARRANTIES, INCLUDING BUT NOT LIMITED TO THE IMPLIED
WARRANTIES OF MERCHANTABILITY, NON INFRINGEMENT AND FITNESS FOR A
PARTICULAR PURPOSE.
Major release, Update, Patch or Service Pack
This release was current as of the release date. However, all customers are advised to check
Trend Micro's website for documentation updates.
Tip: Register online with Trend Micro within 30 days of installation to continue downloading
new pattern files and product updates from the Trend Micro website. Register during
installation or online at https://clp.trendmicro.com/FullRegistration?T=TM.
Integrations
Integrate with AWS Control Tower
Integrate Deep Security with AWS Control Tower to ensure that every account added through
Control Tower Account Factory is automatically provisioned in Deep Security, providing
centralized visibility to the security posture of EC2 instances deployed in each account as well
as the foundation for policy and billing automation.
Overview
The Lifecycle Hook solution provides a CloudFormation template which, when launched in the
Control Tower Master Account, deploys AWS infrastructure to ensure Deep Security monitors
each Account Factory AWS account automatically. The solution consists of 2 Lambda functions;
one to manage our role and access Deep Security, and another to manage the lifecycle of the
first Lambda. AWS Secrets Manager is leveraged to store the API key for Deep Security in the
Master account and a CloudWatch Events rule is configured to trigger the customization Lambda
when a Control Tower account is successfully deployed.
Once Deep Security is integrated with AWS Control Tower, it will be implemented in the
following way:
1452
Trend Micro Deep Security On-Premise 20
1. During stack launch, the lifecycle Lambda is executed for each existing Control Tower
Account, including the Control Tower Master, Audit, and Log accounts.
2. After launch, a CloudWatch Event rule triggers the lifecycle Lambda for each successful
Control Tower CreateManagedAccount event.
3. The lifecycle Lambda function retrieves the Deep Security Api Key from AWS Secrets
Manager, then gets the External ID for your organization from the Deep Security API.
4. The Lambda function assumes the ControlTowerExecution role in the target Managed
Account in order to create the necessary cross account role and associated policy.
5. A call is made to the Deep Security API to add this Managed Account to your tenant.
Integrate with AWS Control Tower
1. Deploy Deep Security Manager to the AWS Control Tower designated shared security
account. We recommend deploying Deep Security Quickstart into your Control Tower
Security account and leveraging a public facing ELB in the quickstart deployment to create
connectivity between workloads Managed Accounts and the Deep Security Manager.
2. When the CloudFormation stack has launched successfully, record the
DeepSecurityConsole value from the top level CloudFormation template. You will need
this URL to sign in to the console and to configure the multi-account integration.
3. In Deep Security Manager, go to Administration > User Management > API Keys and
click New. Select a name for the key and the Full Access role. Be sure to save the key as it
cannot be retrieved later. This key will be used to authenticate the automation from the
AWS Control Tower Master to the console API. For more information, see "Create an API
key for a user" on page 1183.
4. Sign in to the AWS Control Tower master account. Navigate to the CloudFormation
Service, select the region in which AWS Control Tower was deployed, and launch the
lifecycle template.
5. In the lifecycle template, enter your API Key generated in step 3. Next, enter the FQDN of
your console (without https://) which was displayed as the DeepSecurityConsole value
recorded in step 2.
6. Select the box acknowledging that AWS CloudFormation might create IAM resources.
Select Create Stack, and the integration will start adding your AWS accounts to Deep
Security.
7. Once all your accounts have been imported, "Install the agent" on page 273 and activate
protection.
1453
Trend Micro Deep Security On-Premise 20
Upgrade the AWS Control Tower integration
As new capabilities are added to Deep Security, it might be necessary to update the permissions
for the application's cross-account role. To update the role deployed by the lifecycle hook,
update the Deep Security stack with the latest template, which can be found at its original URL.
The parameter values should not be modified from their original values unless directed by Trend
Micro Support. Updating the CloudFormation stack will update the role used by all existing
accounts and the role created for future enrollments.
Remove AWS Control Tower integration
To remove the lifecycle hook, identify and delete the CloudFormation stack. Protection for
Managed Accounts which have already been added will remain in place. For details on
removing an AWS account from Deep Security see, "Remove an AWS account" on page 408.
Integrate with AWS Systems Manager Distributor
AWS Systems Manager Distributor is a feature integrated with AWS Systems Manager that you
can use to securely store and distribute software packages in your accounts. By integrating with
AWS Systems Manager Distributor, you can distribute Deep Security Agents across multiple
platforms, control access to managed instances and automate your deployments.
Create parameters
1. In your AWS console, navigate to AWS Systems Manager > Application Management >
Parameter Store.
2. There are 4 parameters that need to be created. Click Create parameter and enter the
Name and Value as listed in the table below. The other fields can be left on their default
values.
Name Value
dsActivationUrl dsm://dsm.company.com:4120/
dsManagerUrl https://dsm.company.com:443
For single tenant environments, this parameter is not required. For multi-tenants,
dsTenantId on the Deep Security Manager, go to Support > Deployment Scripts. Scroll to
the bottom of the generated script and copy the tenantID.
For single tenant environments, this parameter is not required. For multi-tenants,
dsToken on the Deep Security Manager, go to Support > Deployment Scripts. Scroll to
the bottom of the generated script and copy the token.
1454
Trend Micro Deep Security On-Premise 20
Note: Make sure the values for dsActivationUrl and dsManagerUrl are entered exactly as they
appear, taking care to include the trailing slash where applicable.
Integrate with AWS Systems Manager Distributor
1. In the AWS console, go to AWS Systems Manager > Instances & Nodes > Distributor.
2. Select the TrendMicro-CloudOne-WorkloadSecurity package, then Install on a Schedule.
3. The Create Association page opens. Fill in the required fields. For Installation Type, we
recommend you use the In-place update option.
4. Create a schedule. Leveraging a scheduled State Manager Association will ensure agents
are always installed and up to date.
Protect your computers
We recommend configuring a cloud connector for each AWS account which will contain
managed agents. It might also be necessary to create a policy specific to the systems which will
be managed by Distributor.
1455
Trend Micro Deep Security On-Premise 20
Integrate with SAP NetWeaver
Deep Security Scanner provides integration with the SAP NetWeaver platform.
Note: Deep Security Scanner is not supported on computers where the Deep Security Agent is enabled as a Relay.
Note: Deep Security Scanner is not supported when FIPS mode is enabled. See "FIPS 140-2 support" on page 1417.
Activate the Deep Security Scanner feature
1. In the Deep Security Manager, go to Administration > Licenses.
2. Click Enter New Activation Code.
3. In the Deep Security Scanner area (under Additional Features), enter your Deep Security Scanner activation code, then
click Next and follow the prompts.
The Settings > Scanner tab will now be available in the Computer or Policy editor 1, where you can enable the SAP feature for
individual computers or policies.
Note: In order to use the Deep Security Scanner feature, the Anti-Malware module must also be activated and only available
with the Deep Security Agent.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-click the policy that you want to edit (or select the
policy and click Details). To change the settings for a computer, go to the Computers page and double-click the computer that you want to edit (or select the computer and click Details).
1456
Trend Micro Deep Security On-Premise 20
Add the SAP Server
In Deep Security Manager, open the Computers page and click New. There are several ways to add the SAP server to the
Computers list. For details, see "About adding computers" on page 383.
Enable the SAP integration feature in a computer or policy
The Settings > Scanner page in the Computer or Policy editor 1 allows you to enable the SAP integration module for individual
computers or policies. To enable these features, set the Configuration to On or Inherited (On).
Set up SAP integration
The Trend Micro Deep Security Agent can be called by a library that is automatically deployed on Windows Server 2008 R2 64-bit,
Windows Server 2012 R2 64-bit, SUSE Linux Enterprise Server 11 or 12 (SLES) 64-bit, or Red Hat Enterprise Linux 6 or 7 (RHEL)
64-bit operating systems.
This is an overview of the integration steps:
1. Install the Deep Security Agent on a Windows Server 2008 R2 64-bit, Windows Server 2012 R2 64-bit, SLES 11 or 12, or
RHEL 6 or 7-based SAP application server. See "Install the agent " on page 1460.
2. Add the SAP server to Deep Security Manager and activate the agent on the SAP server. See "Add the SAP server to the
manager" on page 1461.
3. Apply a security profile that has anti-malware active to provide the agent with the latest pattern and scan engine. See "Assign
a security profile" on page 1464.
1You can change these settings for a policy or for a specific computer. To change the settings for a policy, go to the Polices page and double-click the policy that you want to edit (or select the
policy and click Details). To change the settings for a computer, go to the Computers page and double-click the computer that you want to edit (or select the computer and click Details).
1457
Trend Micro Deep Security On-Premise 20
4. Configure the SAP Virus Scan Interface (VSI) by calling the following transactions. See "Configure SAP to use the agent" on
page 1469:
l VSCANGROUP
l VSCAN
l VSCANPROFILE
l VSCANTEST
Note: Depending on your operating system and environment, the output that you see may differ slightly from what is shown in
this article.
1458
Trend Micro Deep Security On-Premise 20
Deep Security and SAP components
Deep Security Manager connects with the Deep Security Agent located on the SAP NetWeaver server. The agent connects with
libsapvsa or dsvsa.dll, which are the virus adapters provided by Trend Micro for scanning purposes.
The components involved in this solution are:
l Deep Security Manager: The centralized web-based management console that administrators use to configure security
policy and deploy protection to the Deep Security Agent.
1459
Trend Micro Deep Security On-Premise 20
l Deep Security Agent: A security agent deployed directly on a computer. The nature of that protection depends on the rules
and security settings that each Deep Security Agent receives from the Deep Security Manager.
l SAP NetWeaver: SAP integrated technology computing platform. The SAP NetWeaver Virus Scan Interface (NW-VSI)
provides virus scanning capabilities for third-party products that perform the actual scan. The NW-VSI interface must be
activated.
l SAP NetWeaver ABAP WinGUI: A Windows management console used for SAP NetWeaver. In this document, it is used for
the configuration of the Deep Security Agent and the SAP NetWeaver Virus Scan Interface.
Install the agent
The Deep Security Agent is installed with core agent functionality only. After the agent is installed on SUSE Linux Enterprise
Server or Red Hat Enterprise Linux, you can enable protection modules on the agent. At that point, the plug-ins required for the
protection modules will be downloaded and installed.
1. Go to the Trend Micro Download Center (http://downloadcenter.trendmicro.com) and download the Deep Security Agent
package for your OS.
2. Install the agent on the target system. You can use rpm or zypper, depending on the OS. In this example, rpm is used by
typing:
rpm -ihv Agent-Core-SuSE_<version>.x86_64.rpm
3. You should see output similar to what's shown in this example, which indicates that the agent installation is complete:
1460
Trend Micro Deep Security On-Premise 20
Note: You can also deploy the agent using a deployment script generated from the Deep Security Manager.
Add the SAP server to the manager
The agent is now installed on the SAP server but no protection modules are active. To enable protection, you need to add the SAP
server to the Deep Security Manager console.
Activate SAP in the manager
1. In the Deep Security Manager, go to Administration > Licenses.
2. Click Enter New Activation Code.
3. In the Deep Security Scanner area (under Additional Features), enter your SAP activation code, the click Next and follow
the prompts.
Note: In order to use the SAP integration feature, the anti-malware and web reputation modules must also be activated.
Add the SAP server
To add the SAP server, open the Deep Security Manager console and on the Computers tab, click New. There are several ways
to add the server, including synchronization with Microsoft Active Directory, VMware vCenter, Amazon Web Services, or Microsoft
Azure. You can also add the computer using an FQDN or IP address. For detailed instructions, see "About adding computers" on
page 383.
Activate the agent
The status of your instance will be either Unmanaged (Activation Required) or Unmanged (Unknown). Next, you will need to
activate the agent before the manager can assign rules and policies to protect the computer. The activation process includes the
exchange of unique fingerprints between the agent and the manager. This ensure that only one Deep Security Manager can
communicate with the agent. There are two ways to activate the agent: agent-initiated or manager-initiated.
1461
Trend Micro Deep Security On-Premise 20
Manager-initiated activation: The manager-initiated method requires that the Deep Security Manager can connect to the FQDN or
the IP of the agent via the agent's listening port number for heartbeats. This can sometimes be difficult due to NAT port forwarding,
firewall, or AWS security groups. To perform manager-initiated activation, go to the Computers tab in the Deep Security Manager
console, right-click the instance where the agent is installed and click Actions > Activate. If you use manager-initiated activation,
we strongly recommend you also "Protect Deep Security Agent" on page 1244 from unauthorized Deep Security Managers.
Agent-initiated activation: The agent-initiated method requires that the Deep Security Agent can connect to the configured Deep
Security Manager address via the manager's listening port number for heartbeats.
You can find the Deep Security Manager address (FQDN or IP) in the Deep Security Manager console, under Administration >
Manager Nodes.
You will also need to enable agent-initiated activation from the Deep Security Manager console, by clicking Administration >
System Settings > Agents and selecting Allow Agent-Initiated Activation.
Next, use a locally-run command-line tool on the Deep Security Agent to initiate the activation process. The minimum activation
instruction contains the activation command and the manager's URL (including the port number):
dsa_control -a dsm://[managerurl]:[port]/
where:
l -a is the command to activate the agent , and
l dsm://managerurl:4120/ is the parameter that points the agent to the Deep Security Manager. ("managerurl" is the URL
of the Deep Security Manager, and "4120" is the default agent-to-manager communication port.)
The manager URL is the only required parameter for the activation command. Additional parameters are also available. (For a list
of available parameters, see "Command-line basics" on page 1348.)
In the following example, we use the agent-initiated activation by typing:
/opt/ds_agent/dsa_control -a dsm://cetl-dsm.ceur-testlab.trendmicro.de:4120/
1462
Trend Micro Deep Security On-Premise 20
This output indicates that the agent activation is complete.
To confirm the activation:
1463
Trend Micro Deep Security On-Premise 20
1. In the Deep Security Manager console, go to the Computers tab.
2. Click the computer name and then click Details and check that the computer's status is "Managed".
Assign a security profile
At this point, the status of the agent is Managed (Online) but there is no protection module installed. This means that the agent and
the manager are communicating but the agent is not using any configuration.
There are several ways to apply protection. In this example, the configuration is done directly on the SAP instance by activating
anti-malware and SAP and assigning the default Scan Configurations.
1464
Trend Micro Deep Security On-Premise 20
1. In the Computer editor 1, go to Anti-Malware > General.
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and click Details).
1465
Trend Micro Deep Security On-Premise 20
2. In the Anti-Malware section, set Configuration to On (or Inherited On) and then click Save.
1466
Trend Micro Deep Security On-Premise 20
3. In the Real-Time Scan, Manual Scan, or Scheduled Scan sections, set the Malware Scan Configuration and Schedule, or
allow those settings to be inherited from the parent policy.
4. Click Save. The status of the anti-malware module changes to Off, installation pending. This means that the agent is
retrieving the required module from the Deep Security Manager. For this to work, the client needs to access the Deep
Security Relay on the relay's listening port number. A few moments later, the agent should start downloading security
updates such as anti-malware patterns and scan engines.
5. In the Computer editor, go to Settings > Scanner.
6. In the SAP section, set Configuration to On (or Inherited On) and then click Save.
After status of the agent changes to Managed (Online) again and the anti-malware and Scanner (SAP) modules are On, you can
proceed with the SAP configuration.
1467
Trend Micro Deep Security On-Premise 20
1468
Trend Micro Deep Security On-Premise 20
Configure SAP to use the agent
The Deep Security Agent is now up and running and is able to scan the file system of its operating system. Next, we need to make
the agent aware of the SAP application server. To use this, we must create a virus scan adapter inside the application server. The
virus scan adapter must be part of a group. After the virus scan adapter and virus scan group are created, we can use virus scan
profiles to configure what to scan and how to behave.
These are the required steps:
1. "Configure the Trend Micro scanner group" on the next page
2. "Configure the Trend Micro virus scan provider" on page 1476
3. "Configure the Trend Micro virus scan profile" on page 1482
4. "Test the virus scan interface" on page 1491
Note: The virus scan group and the virus scan adapter are both global configurations (client 00). The virus scan profile must be
configured in each tenant (client 01, 02, etc.).
1469
Trend Micro Deep Security On-Premise 20
Configure the Trend Micro scanner group
1470
Trend Micro Deep Security On-Premise 20
1. In the SAP WinGUI, run the VSCANGROUP transaction.
1471
Trend Micro Deep Security On-Premise 20
1472
Trend Micro Deep Security On-Premise 20
2. In Edit mode, click New Entries. Create a new scanner group, specifying a group name in the Scanner Group area and a
description of the scanner group in the Group Text area.
1473
Trend Micro Deep Security On-Premise 20
1474
Trend Micro Deep Security On-Premise 20
3. Clicking Save or leaving the edit mode will prompt you to commit a "workbench request". In this example, a new workbench
request is created to keep track of all the VSI-related changes:
The next step is the actual configuration of the VSI integration. It is called a Virus Scan Adapter.
1475
Trend Micro Deep Security On-Premise 20
Configure the Trend Micro virus scan provider
1476
Trend Micro Deep Security On-Premise 20
1. In the SAP WinGUI, run the VSCAN transaction.
1477
Trend Micro Deep Security On-Premise 20
1478
Trend Micro Deep Security On-Premise 20
2. In Edit mode, click New Entries. Creating a new entry displays a prompt in which the configuration of the VSI- certified
solution takes place. In this example, the following configuration parameters are set:
Setting Value Description
Provider
ADAPTER (Virus Scan Adapter) Automatically set (default)
Type
Provider VSA_<host name> Automatically set, serves as alias
1479
Trend Micro Deep Security On-Premise 20
Setting Value Description
Name
Scanner Select the group that you configured All previously created scanner groups, which you can display
Group earlier using the input help
Status Active (Application Server) Automatically set (default)
Server nplhost_NPL_42 Automatically set, hostname
Specifies the number of hours after which the Virus Scan
Reinit. Interv. 8 Hours
Adapter will be reinitialized and load new virus definitions.
Adapter Path
/lib64/libsapvsa.so Default path
(Linux)
Adapter Path C:\Program Files\Trend Micro\Deep
Default path
(Windows) Security Agent\lib\dsvsa.dll
3. When you click Save or leave the edit mode, there is another prompt to pack this into a workbench request. After confirming,
click the Start button. The Status light will turn green, which means the adapter is loaded and active:
1480
Trend Micro Deep Security On-Premise 20
1481
Trend Micro Deep Security On-Premise 20
At this point, the VSI configuration is nearly finished. The application server is now ready to process file transactions using a virus
scan provided by Trend Micro Deep Security.
Configure the Trend Micro virus scan profile
1. In the SAP WinGUI, run the VSCANPROFILE transaction, then select the SAP operation that requires virus scan. For
example, check the "Active" checkbox for /SCET/GUI_UPLOAD or /SCET/GUI_DOWNLOAD and then click Save.
1482
Trend Micro Deep Security On-Premise 20
1483
Trend Micro Deep Security On-Premise 20
2. In Edit mode, click New Entries. The virus scan profiles will define how specific transactions (file uploads, file downloads,
etc.) are handled corresponding to the virus scan interface. To have the previously configured virus scan adapter used in the
application server, a new virus scan profile needs to be created:
1484
Trend Micro Deep Security On-Premise 20
1485
Trend Micro Deep Security On-Premise 20
3. In the Scan Profile box, enter "Z_TMProfile" and select the Active, Default Profile, and Evaluate Profile Configuration
Param check boxes.
1486
Trend Micro Deep Security On-Premise 20
4. While still in edit mode, double-click Steps to configure the steps:
1487
Trend Micro Deep Security On-Premise 20
1488
Trend Micro Deep Security On-Premise 20
5. Click New Entries.
6. The steps define what to do when the profile is called by a transaction. Set the Position to "0", Type to "Group" and the
Scanner Group to the name of the group that you configured earlier.
7. After clicking Save or leaving the edit mode, you will eventually receive a notification about an existing virus scan profile,
/SCET/DP_VS_ENABLED. you can ignore this notification because the profile is not active and is not used. After confirming
this notification, you will be asked to pack this configuration in a "customization request". Creating a new request will help
keep track of the changes that have been made:
8. To create configuration parameters for a step, double-click the Profile Configuration Parameters node. Click New Entries
and set the parameters:
Parameter Type Description
Check whether a file contains script (JavaScript, PHP, or ASP script) and
CUST_ACTIVE_CONTENT BOOL
block
Check whether the file extension name matches its MIME type. If they do not
match, the file will be blocked. All MIME types and extension names can be
exactly matched. For example:
l Word files must to be .doc or .dot
CUST_CHECK_MIME_
BOOL JPEG files must to be .jpg
TYPE l
l Text and binary files could be any extension (won’t block)
See "Supported MIME types" on page 1497.
1489
Trend Micro Deep Security On-Premise 20
9. Double-click the Step Configuration Parameters node. Click New Entries and set the parameters:
Parameter Type Description
The scan should be performed on the "best effort" basis; that is, all (security critical)
flags that allow a VSA to scan an object should be activated, such as
SCANBESTEFFORT BOOL
SCANALLFILES and SCANEXTRACT, but also internal flags. Details about exactly
which flags these are can be stored in the certification.
SCANALLFILES BOOL Scans for all files regardless of their file extension.
List of the file extensions for which the VSA should scan. Only files with the
configured extensions will be checked. Other extensions are blocked. Wildcards can
SCANEXTENSIONS CHAR also be used here in order to search for patterns. * stands for this location and
following and ? stands for for only this character. The syntax is: exe;com;do?;ht* => `*`
therefore means to scan all files.
This settings applies to compressed files. It specifies the maximum number of files
SCANLIMIT INT
that will be unpacked and scanned.
SCANEXTRACT BOOL Archives or compressed objects are to be unpacked
SCANEXTRACT_ SIZE_
Maximum unpack size
SIZE T
SCANEXTRACT_
INT Maximum depth to which an object is to be unpacked.
DEPTH
List of the MIME types to be scanned for. Only files with configured MIME types will
SCANMIMETYPES CHAR be checked. Other MIME types are blocked. This parameter works only if CUST_
CHECK_MIME_TYPE is enabled.
List of MIME types that will be blocked. This parameter works only if CUST_CHECK_
BLOCKMIMETYPES CHAR
MIME_TYPE is enabled.
BLOCKEXTENSIONS CHAR List of file extensions that will be blocked.
This configuration is per-client, so it must be done in each tenant of the SAP application server.
1490
Trend Micro Deep Security On-Premise 20
Test the virus scan interface
1491
Trend Micro Deep Security On-Premise 20
1. In the SAP WinGUI, run the VSCANTEST transaction.
1492
Trend Micro Deep Security On-Premise 20
1493
Trend Micro Deep Security On-Premise 20
2. Every VSI-aware SAP application server also has a built-in test to check whether the configuration steps were done correctly.
For this, an EICAR test virus (www.eicar.org) is packed in a transaction that can call a specific scanner. Not filling in anything
will call the default profile, which was configured in the last step.
1494
Trend Micro Deep Security On-Premise 20
3. Clicking Execute prompts a notification that explains what an EICAR test virus is. After confirming this, you will see how the
transaction is intercepted:
1495
Trend Micro Deep Security On-Premise 20
1496
Trend Micro Deep Security On-Premise 20
Infections shows information about the detected malware.
Content Information shows the correct MIME-type of the file.
The file name is always a randomly generated 7-letter alphabetic string followed by the virus scan profile name.
After this, there is an output about each step of the transaction:
1. The transaction called the default virus scan profile, which is the virus scan profile Z_TMPROFILE.
2. The virus scan profile Z_TMPROFILE is configured to call an adapter from the virus scan group Z_TMGROUP.
3. The virus scan group Z_TMGROUP has multiple adapters configured and calls one of them (in this case, VSA_NPLHOST).
4. The virus scan adapter returns value 2-, which means a virus was found.
5. Information about the detected malware is displayed by showing Eicar_test_1 and the file object /tmp/ zUeEbZZ_
TMPROFILE.
6. The called default virus scan profile Z_TMPROFILE fails because step 00 (the virus scan group) was not successful and
therefore the file transaction is stopped from further processing.
For a cross-check, there is also information about this "malware" event in the Deep Security Manager console. To see the event,
open the Computer editor 1 and click Anti-Malware > Events.
Supported MIME types
The MIME types supported by Deep Security Scanner vary depending on which version of the Deep Security Agent you are using.
l Deep Security Agent 9.6 uses VSAPI 9.85
l Deep Security Agent 10.0 uses ATSE 9.861
l Deep Security Agent 10.1 uses ATSE 9.862
1To open the Computer editor, go to the Computers page and double-click the computer that you want to edit (or select the computer and click Details).
1497
Trend Micro Deep Security On-Premise 20
l Deep Security Agent 10.2, 10.3, 11.0, 11.1, and 11.2 uses ATSE 10.000
l Deep Security Agent 11.3 and higher uses ATSE 11.0.000
Supported
Supported Supported
in 10.1
MIME Type Description Extension in 9.6 in 10.0
Agent or
Agent Agent
higher
application/octet-stream * Yes Yes Yes
application/com COM File com Yes Yes Yes
application/ecmascript EMCScript File es Yes Yes Yes
application/hta HTA File hta Yes Yes Yes
application/java-archive Java Archive (JAR) file jar Yes Yes Yes
application/javascript Javascript File js, jsxinc, jsx Yes Yes Yes
application/msword Word for Windows doc, dot Yes Yes Yes
application/vnd.ms-access MS Access mdb No No No
application/vnd.ms-project MS Project mpp No No No
application/msword MS Word doc, dot Yes Yes Yes
application/octet-stream COM File com Yes Yes Yes
application/octet-stream EXE File exe Yes Yes Yes
Adobe Portable
application/pdf pdf Yes Yes Yes
Document Format file
application/postscript Postscript ai Yes Yes Yes
application/postscript Postscript ps Yes Yes Yes
application/postscript Postscript ps Yes Yes Yes
application/rar RAR File rar Yes Yes Yes
application/rtf Microsoft RTF rtf Yes Yes Yes
application/sar Sar File sar Yes Yes Yes
application/vnd.ms-excel Excel for Windows xls, xlt, xla Yes Yes Yes
application/vnd.ms-outlook Outlook for Windows msg No Yes Yes
application/vnd.ms-powerpoint Windows PowerPoint ppt, pot, pps, ppa Yes Yes Yes
application/vnd.ms-publisher MS Publisher pub No No Yes
1498
Trend Micro Deep Security On-Premise 20
Supported
Supported Supported
in 10.1
MIME Type Description Extension in 9.6 in 10.0
Agent or
Agent Agent
higher
application/vnd.oasis.opendocument Open Document odf Yes Yes Yes
application/vnd.openxmlformats- pptx, potx, ppsx, ppam, pptm, potm,
MS Office File Yes Yes Yes
officedocument.presentationml.presentation ppsm
application/vnd.openxmlformats-
MS Office File xlsx, xltx, xlsm, xltm, xlam, xlsb Yes Yes Yes
officedocument.spreadsheetml.sheet
application/vnd.openxmlformats-
MS Office File docx, dotx, docm, dotm Yes Yes Yes
officedocument.wordprocessingml.document
application/vnd.rn-realmedia Real Media rm Yes Yes Yes
application/wordperfect WOrdPerfect wp, wp5, wp6, wpd, w60, w61 Yes Yes Yes
application/x-alf alf Yes Yes Yes
application/x-arc-compressed ARC File arc Yes Yes Yes
application/x-bzip2 bZIP File * Yes Yes Yes
application/x-cpio CPIO File * Yes Yes Yes
Macromedia Director
application/x-director dcr Yes Yes Yes
Shockwave Movie
application/x-gzip Gzip * Yes Yes Yes
dhtm, dhtml, htm, html, htx, sht, shtm,
application/xhtml+xml XHTML Yes Yes Yes
shtml, stml, xht, xhtm, xhtml, xml, txt
application/x-java-class JAVA Applet class Yes Yes Yes
application/x-kep kep Yes Yes Yes
application/x-otf otf Yes Yes Yes
application/x-sapshortcut sap, sapc Yes Yes Yes
application/x-shockwave-flash Macromedia Flash swf Yes Yes Yes
application/x-silverlight-app PKZIP xap Yes Yes Yes
application/x-sim sim Yes Yes Yes
application/x-tar TAR File tar Yes Yes Yes
application/x-vbs * Yes Yes Yes
application/zip ZIP File zip, zipx Yes Yes Yes
audio/basic Audio snd, au Yes Yes Yes
audio/midi MIDI mid, midi, rmi, mdi, kar Yes Yes Yes
1499
Trend Micro Deep Security On-Premise 20
Supported
Supported Supported
in 10.1
MIME Type Description Extension in 9.6 in 10.0
Agent or
Agent Agent
higher
Audio InterChange File
audio/x-aiff aiff, aif, aifc Yes Yes Yes
Format from Apple/SGI
audio/x-mpeg-3 MP3 mp3 Yes Yes Yes
audio/x-realaudio Real Audio ra Yes Yes Yes
Creative Voice Format
audio/x-voc voc Yes Yes Yes
(VOC)
image/bmp Windows BMP bmp Yes Yes Yes
image/gif GIF gif Yes Yes Yes
image/ico Windows Icon ico Yes Yes Yes
image/jpeg JPEG jpg, jpeg, jpe, jif, jfif, jfi Yes Yes Yes
image/msp Microsoft Paint msp Yes Yes Yes
Portable Network
image/png png Yes Yes Yes
Graphics
image/ppm PPM image ppm Yes Yes Yes
image/svg+xml svg Yes Yes Yes
image/tiff TIFF tif, tiff Yes Yes Yes
Microsoft Document
image/vnd.ms-modi mdi Yes Yes Yes
Imaging
image/x-cpt Corel PhotoPaint cpt Yes Yes Yes
image/x-pcx PCX pcx Yes Yes Yes
image/x-pict Macintosh Bitmap pct Yes Yes Yes
image/x-ras Sun Raster(RAS) ras Yes Yes Yes
image/x-wmf Windows Metafile wmf Yes Yes Yes
text/csv CSV csv, txt Yes Yes Yes
dhtm, dhtml, htm, html, htx, sht, shtm,
text/html HTML Yes Yes Yes
shtml, stml, xht, xhtm, xhtml, xml, txt
text/plain * Yes Yes Yes
text/plain Text File txt Yes Yes Yes
dhtm, dhtml, htm, html, htx, sht, shtm,
text/xml XML Yes Yes Yes
shtml, stml, xht, xhtm, xhtml, xml, txt
1500
Trend Micro Deep Security On-Premise 20
Supported
Supported Supported
in 10.1
MIME Type Description Extension in 9.6 in 10.0
Agent or
Agent Agent
higher
text/xsl XSL xsl Yes Yes Yes
unknown/unknown * Yes Yes Yes
video/mpeg * Yes Yes Yes
video/quicktime Quick Time Media qt Yes Yes Yes
video/x-fli AutoDesk Animator fli Yes Yes Yes
Macromedia Flash FLV
video/x-flv flv Yes Yes Yes
Video
Advanced Streaming
video/x-ms-asf asf Yes Yes Yes
Format
Lotus ScreenCam
video/x-scm scm Yes Yes Yes
Movie
Integrate with Smart Protection Server
If you have Deep Security Agents in AWS, and you want them to be able to access Trend Micro's Smart Protection Network, then
you must allow them to connect to the Internet on port 80 (HTTP) or 443 (HTTPS). (See "Port numbers, URLs, and IP addresses"
on page 178.) If this is not possible, you can deploy your own Smart Protection Server (SPS) within your Virtual Private Network
(VPC) in AWS, or another VPC. The Smart Protection Server connects outbound to the Smart Protection Network to retrieve the
latest anti-malware, file reputation, and web reputation information and then passes this information along to your agents.
To deploy a Smart Protection Server in AWS, you can either:
l use an AWS CloudFormation template created by Trend Micro . This is the easiest way to deploy the server because the
configuration is automated.
l install it manually. See the Smart Protection Server documentation for details.
The instructions below describe how to deploy the Smart Protection Server using the CloudFormation template.
1501
Trend Micro Deep Security On-Premise 20
1. In AWS, at the top, click Services and search for the CloudFormation service.
2. On the CloudFormation service page, click Create Stack.
The Select Template page appears.
3. Select Specify an Amazon S3 template URL and enter this URL into the underlying field:
https://s3.amazonaws.com/trend-micro-quick-start/latest/templates/common/sps.template
4. Click Next.
1502
Trend Micro Deep Security On-Premise 20
Finish entering settings in the template. Choose the AWS key pairs you would like to use to authenticate to the server, the
VPC and subnet where the Smart Protection Server will reside, and an administrator password. The password cannot
contain special characters such as: !@#$%^&*()
Warning: Do not enter a password that contains dictionary words. It should be at least 8 characters in length. Failure to do
this will result in a weak password that is vulnerable to guessing and brute force attacks, and could compromise the
security of your network.
5. Click Next.
1503
Trend Micro Deep Security On-Premise 20
6. Optionally, create any tags that you would like to associate with this server, then click Next.
7. Review your settings, and then click Create.
1504
Trend Micro Deep Security On-Premise 20
While your server is being installed, the screen will indicate progress. To verify that the process has completed, you may
need to click Refresh at the top of the screen.
1505
Trend Micro Deep Security On-Premise 20
1506
Trend Micro Deep Security On-Premise 20
8. After it is done creating, click the Outputs tab at the bottom of the screen. You see three URLS. In the Deep Security
Manager's GUI, you must configure your computers to use the Smart Protection Server.
9. Log in to Deep Security Manager.
10. At either the policy level (recommended method) or at the computer level, go to the anti-malware section.
11. Click the Smart Protection tab at the top. Toward the bottom of the screen, deselect Inherited under Smart Protection Server
for File Reputation Service.
1507
Trend Micro Deep Security On-Premise 20
12. Select Use locally installed Smart Protection Server.
13. Enter in the URL from the Outputs screen in your AWS console labeled "FRSurl" and click Add.
14. Click Save.
15. Open the web reputation section of the policy or computer and click the Smart Protection tab at the top.
16. Deselect Inherited under Smart Protection Server for Web Reputation Service.
17. Select Use locally installed Smart Protection Server.
18. Add the URL from the Outputs screen in your AWS console labeled "WRSurl" or "WRSHTTPSurl" and click Add. You can
use the HTTP or HTTPS URL, but HTTPS is only supported with 11.0 Deep Security Agents and up.
19. Click Save.
20. If you don’t have your system set up to automatically send policies, you will need to manually send the policy from your Deep
Security Manager.
FAQs
Why does my Windows machine lose network connectivity when I turn on
protection?
A Windows machine will lose connectivity for a brief period of time during the network driver installation while the Deep Security
Agent installs a network driver to examine traffic. This only happens the first time a policy is applied that includes one of the
following:
l Web reputation
l Firewall
l Intrusion prevention
1508
Trend Micro Deep Security On-Premise 20
A Windows machine uses the same driver is used for all three protection modules listed above. Turning on web reputation, firewall
or intrusion prevention after one of those features already turned on will not cause another network blip. You may see a similar
interruption in network connectivity when the agent is upgraded (as the driver may also need to be upgraded).
How do I get news about Deep Security?
The Deep Security news feed has been discontinued. Instead, you can find the latest news on product changes in the "What's
new?" on page 95 article.
Trend Micro continue to release new rule updates every Tuesday, with additional updates as new threats are discovered. Details
about each rule update are provided in the Trend Micro Threat Encyclopedia.
How does agent protection work for Solaris zones?
The Deep Security Agent can be deployed on either a Solaris global zone or kernel zone. If your Solaris environment uses any
non-global zones, the protection that the agent can provide for the global zone and non-global zones will differ with each protection
module:
l Intrusion Prevention
l Firewall
l Web Reputation
l Anti-Malware
l Integrity Monitoring
l Log Inspection
See "Install the agent manually" on page 273 for more on installing the Deep Security Agent on Solaris.
1509
Trend Micro Deep Security On-Premise 20
Intrusion Prevention (IPS), Firewall, and Web Reputation
If your Solaris environment uses any non-global zones, the Intrusion Prevention, Firewall, and Web Reputation modules can only
provide protection to specific traffic flows between the global zone, non-global zones and any external IP addresses. Which traffic
flows the agent can protect depends on if the non-global zones use a shared-IP network interface or an exclusive-IP network
interface.
Kernel zones use an exclusive-IP network interface and agent protection to traffic flows is limited to that network configuration.
Non-global zones use a shared-IP network interface
Agent protection to traffic flows in a shared-IP configuration is as follows:
Traffic Flow Protected by agent
external address <-> non-global zone Yes
external address <-> global zone Yes
global zone <-> non-global zone No
non-global zone <-> non-global zone No
Non-global zones use an exclusive-IP network interface
Agent protection to traffic flows in a exclusive-IP configuration is as follows:
1510
Trend Micro Deep Security On-Premise 20
Traffic Flow Protected by agent
external address <-> non-global zone No
external address <-> global zone Yes
global zone <-> non-global zone Yes
non-global zone <-> non-global zone No
Anti-Malware, Integrity Monitoring, and Log Inspection
The Anti-Malware, Integrity Monitoring and Log Inspection modules provides protection to the global zone and to any kernel zones
that have an agent installed. For non-global zones, any files or directories that are also visible to the global zone are protected.
Files specific to a non-global zone are not protected.
How do I protect AWS GovCloud (US) instances?
There are two ways that Deep Security provides AWS GovCloud (US) support:
l You can use the Trend Micro Deep Security AMI (Per Protected Instance Hour or BYOL license type) that is available from
the AWS Marketplace for AWS GovCloud (US). The deployment instructions for the AWS GovCloud (US) region are the
same as any other region. See Getting started with Deep Security AMI from AWS Marketplace.
l You can install the enterprise version of the Deep Security software on an AWS instance running in the AWS GovCloud (US)
region.
1511
Trend Micro Deep Security On-Premise 20
Note: Deep Security as a Service does not support AWS GovCloud. Computers on the AWS GovCloud must comply with user
and data transmission restrictions as specified by United States of America International Traffic in Arms Regulations (ITAR).
Because the Deep Security as a Service operating model requires the transmission of data outside of the AWS GovCloud, using
it to manage computers in the AWS GovCloud would break this compliance.
Protecting AWS GovCloud (US) instances using a manager in a commercial AWS
instance
Warning: Be aware that if your Deep Security Manager is outside of the AWS GovCloud, using it to manage computers in the
AWS GovCloud would break ITAR compliance.
If your Deep Security Manager is in a commercial AWS instance and you want to use it to protect AWS GovCloud instances, you
cannot use the cloud connector provided in the Deep Security Manager console to add the instances. If Deep Security Manager is
running in a special region (like AWS GovCloud), it can connect to that region and also connect to instances in commercial AWS
regions. But if Deep Security Manager is in a commercial region, it can connect to all commercial AWS regions but not special
regions like AWS GovCloud.
If you want to add a special region connector (like AWS GovCloud) into a Deep Security Manager running in commercial AWS,
you will need to use the Deep Security legacy REST API to do so and supply the seedRegion argument to tell the Deep Security
Manager that it's connecting outside of commercial AWS. For information about the API, see "Use the Deep Security API to
automate tasks" on page 1376.
How do I protect Azure Government instances?
To protect Azure Government instances, you have a few options:
1512
Trend Micro Deep Security On-Premise 20
l You can deploy Deep Security Manager using the Deep Security Manager (BYOL) VM that's listed inside Azure
Government's Marketplace (see the image below). The deployment instructions for the Azure Government are the same as
any other region.
l You can install the Deep Security Manager on-premises software onto an Azure VM running inside Azure Government.
Note: Deep Security as a Service does not support Azure Government. Computers in Azure Government must comply with user
and data transmission restrictions as specified by United States of America International Traffic in Arms Regulations (ITAR).
Because the Deep Security as a Service operating model requires the transmission of data outside of Azure Government, using it
to manage computers in the Azure Government would break this compliance.
1513
Trend Micro Deep Security On-Premise 20
1514
Trend Micro Deep Security On-Premise 20
Protecting Azure Government instances using a manager in global Azure
Warning: Be aware that if your Deep Security Manager is outside of Azure Government, using it to manage computers in the
Azure Government would break ITAR compliance.
You cannot use the Computers > Add > Add Account option in the Deep Security Manager console to add Azure Government
instances to a manager in global Azure, and vice versa. This is because the manager can only communicate with Azure instances
in its own cloud.
If your Deep Security Manager is located outside the Azure Government cloud, and you want to use it to protect instances in the
Azure Government cloud, you will need to use the Deep Security legacy REST API, and supply the azureADLoginEndPoint and
azureEntryPoint arguments. For details on using the API, see Create Cloud Account.
How does Deep Security Agent use the Amazon Instance Metadata
Service?
When running on EC2 instances in AWS, the Deep Security Agent uses the Amazon Instance Metadata Service (IMDS) to query
information about the EC2 instance.
Note: Deep Security support for IMDS v2 was added in Deep Security Manager FR 2020-04-29 and Deep Security Agent FR
2020-05-19. If you are using an older version of Deep Security only IMDS v1 is supported and you must ensure that your AWS
configuration allows Deep Security Agent access to host metadata using IMDS v1.
The information retrieved by the Deep Security Agent is necessary to ensure that the agent activates under the proper AWS
account within Deep Security and the right instance size is used for metered billing.
1515
Trend Micro Deep Security On-Premise 20
If the Deep Security Agent cannot successfully retrieve data from the instance using a Metadata Service Version 1 (IMDSv1) or 2
(IMDSv2), the following issues might be encountered:
Issue Root cause Resolution Additional notes
If you determine that the
Duplicate computers
If the Deep Security Agent does not have access to Instance creation of duplicate
appear - one under the
Metadata Service Version 1 (IMDSv1) or 2 (IMDSv2), Deep computers has occurred, you
AWS account and
Security cannot properly associate this activation with the can use inactive agent
another outside of the
desired cloud account. cleanup to automatically
AWS account.
Ensure that remove these computers.
Deep If you believe overbilling has
Security has occurred please ensure that:
access to
1. The Deep Security
IMDS v1 or
Incorrect billing of If the Deep Security Agent does not have access to Instance Agent has access to
instance hours at the Metadata Service Version 1 (IMDSv1) or 2 (IMDSv2), Deep IMDS v2. IMDS v1 or IMDS v2.
default rate of $0.06 per Security cannot properly determine the instance size for
2. You have added the
hour rather than the rate metered billing. As a result, the computer does not appear For more
associated with the under a cloud account and is charged at the data center rate. details, see AWS cloud account to
workload size. Configuring Deep Security.
the Instance
Please contact technical
Metadata
support for additional
Service.
assistance.
If the Deep Security Agent does not have access to Instance
Smart folders or event-
Metadata Service Version 1 (IMDSv1) or 2 (IMDSv2), Deep
based tasks based on N/A
Security cannot access the AWS metadata needed for these
AWS metadata fail.
operations.
1516
Trend Micro Deep Security On-Premise 20
How can I minimize heartbeat alerts for offline environments in an AWS
Elastic Beanstalk environment?
AWS Elastic Beanstalk allows you to create multiple environments so that you can run different versions of an application at the
same time. These environments usually include a production and development environment and often the development
environment is powered down at night. When the development environment is brought back online in the morning, Deep Security
will generate alerts related to communication problems for the period of time that it was offline. Although these alerts are actually
false from your perspective, they are legitimate alerts from the perspective of Deep Security because an alert is generated
whenever a specified number of heartbeats is missed.
You can minimize these heartbeat-related alerts or even prevent them from being generated for environments that you know will be
offline for a period of time every day by creating a policy with specific heartbeat settings and applying that policy to the servers in
those partially offline environments.
1. Go to the Policies tab in the main Deep Security Manager window.
2. Create a new policy or edit an existing one.
3. Click the Settings tab in the Policy editor 1 and go to the Computer tab.
4. Change one or both of the Heartbeat Interval and Number of Heartbeats that can be missed before an alert is raised
setting to numbers that take into account the number of hours your Elastic Beanstalk environment will be offline.
For example, if you know that a server will be offline for 12 hours a day and the Heartbeat Interval is set at 10 minutes, you
could change the Number of Heartbeats that can be missed before an alert is raised setting to unlimited to never get an alert
or you could increase the Heartbeat Interval to something greater than 10 to get fewer alerts.
5. Click Save and apply the policy to all relevant servers.
For more information on using Deep Security in an AWS Elastic Beanstalk environment, you can watch the Trend Micro webinar
Deploying Scalable and Secure Web Apps with AWS Elastic Beanstalk and Deep Security.
1To open the Policy editor, go to the Policies page and double-click the policy that you want to edit (or select the policy and click Details).
1517
Trend Micro Deep Security On-Premise 20
Why can't I add my Azure server using the Azure cloud connector?
If an Azure server loses connectivity to the Azure metadata service, the Deep Security Manager will no longer be able to identify it
as an Azure server and you will be unable to add it using the Azure cloud connector.
This situation can happen if the server's public or private IP address is changed outside of the Azure console. The Azure server
relies on DHCP to communicate with the metadata service and changing the IP outside of the console disables DHCP.
Microsoft recommends against changing the Azure VM's IP address from within its operating system, unless necessary, such as
when assigning multiple IP addresses to a Windows VM. For details, see this Azure article.
To check if your Azure server is able to connect to the Azure metadata service, run the Detect Windows Azure Virtual Machine
PowerShell script from the Microsoft Script Center.
Why can't I view all of the VMs in an Azure subscription in Deep Security?
If not all of the virtual machine resources in an Azure subscription are being displayed on the Computers page of Deep Security
Manager, this could be because they were deployed using the Azure deployment model Resource Manager. All resources are
deployed using this model unless you select Classic from the Select a deployment model list.
Not all VMs are displayed because older versions of the Deep Security Manager use the Service Management API provided by the
classic Azure deployment model (the Service Management model) to connect to Azure virtual machines so it can only enumerate
VMs deployed with the Classic model.
To see both Classic or Resource Manager VMs, upgrade your cloud connector. For more information, see "Why should I upgrade
to the new Azure Resource Manager connection functionality?" on page 419.
Note: If you are unable to upgrade your Resource Manager servers as per the article above, you can still protect them by using
the deployment script on the VM and letting the activation create a new computer object outside of the connector.
1518
Trend Micro Deep Security On-Premise 20
Troubleshooting
"Offline" agent
A computer status of "Offline" or "Managed (Offline)" means that the Deep Security Manager hasn't communicated with the Deep
Security Agent's instance for some time and has exceeded the missed heartbeat threshold. (See "Configure the heartbeat" on
page 1124.) The status change can also appear in alerts and events.
Causes
Heartbeat connections can fail because:
l The agent is installed on a workstation or other computer that has been shut down. If you are using Deep Security to protect
computers that sometimes get shut down, make sure the policy assigned to those computers does not raise an alert when
there is a missed heartbeat. In the policy editor, go to Settings > General > Number of Heartbeats that can be missed
before an alert is raised and change the setting to "Unlimited".
l Firewall, IPS rules, or security groups block the heartbeat port number
l Outbound (ephemeral) ports were blocked accidentally. See "Activation Failed - Blocked port" on page 1058 for
troubleshooting tips.
l Bi-directional communication is enabled, but only one direction is allowed or reliable (see "Configure communication
directionality" on page 1125)
l Computer is powered off
l Computer has left the context of the private network
This can occur if roaming endpoints (such as a laptop) cannot connect to the manager at their current location. Guest Wi-Fi,
for example, often restricts open ports, and has NAT when traffic goes across the Internet.
1519
Trend Micro Deep Security On-Premise 20
l Amazon WorkSpace computer is being powered off, and the heartbeat interval is fast, for example, one minute; in this case,
wait until the WorkSpace is fully powered off, and at that point, the status should change from 'Offline' to 'VM Stopped'
l DNS was down, or could not resolve the manager's hostname
l The manager, the agent, or both are under very high system resource load
l The agent process might not be running
l Certificates for mutual authentication in the SSL or TLS connection have become invalid or revoked (see "Replace the Deep
Security Manager TLS certificate" on page 1245)
l The agent's or manager's system time is incorrect (required by SSL/TLS connections)
l Deep Security rule update is not yet complete, temporarily interrupting connectivity
l On AWS EC2, ICMP traffic is required, but is blocked
Tip: If you are using manager-initiated or bi-directional communication, and are having communication issues, we strongly
recommend that you change to agent-initiated activation (see "Activate and protect agents using agent-initiated activation and
communication" on page 1138).
To troubleshoot the error, verify that the agent is running, and then that it can communicate with the manager.
Verify that the agent is running
On the computer with the agent, verify that the Trend Micro Deep Security Agent service is running. Method varies by operating
system.
l On Windows, open the Microsoft Windows Services Console (services.msc) or Task Manager. Look for the service named
ds_agent.
l On Linux, open a terminal and enter the command for a process listing. Look for the service named ds_agent or ds-agent,
such as:
1520
Trend Micro Deep Security On-Premise 20
sudo ps -aux | grep ds_agent
sudo service ds_agent status
l On Solaris, open a terminal and enter the command for a process listing. Look for the service named ds_agent, such as:
sudo ps -ef | grep ds_agent
sudo svcs -l svc:/application/ds_agent:default
Verify DNS
If agents connect to the manager via its domain name or hostname, not its IP address, test the DNS resolution:
nslookup [manager domain name]
DNS service must be reliable.
If the test fails, verify that the agent is using the correct DNS proxy or server (internal domain names can't be resolved by a public
DNS server such as Google or your ISP). If a name such as dsm.example.com cannot be resolved into its IP address,
communication will fail, even though correct routes and firewall policies exist for the IP address.
If the computer uses DHCP, in the computer or policy settings, in the Advanced Network Engine area, you might need to enable
Force Allow DHCP DNS(see "Network engine settings" on page 475).
Allow outbound ports (agent-initiated heartbeat)
Telnet to required port numbers on the manager to verify that a route exists, and the port is open:
telnet [manager IP]:4120
1521
Trend Micro Deep Security On-Premise 20
Tip: Telnet success proves most of the same things as a ping: that a route and correct firewall policy exist, and that Ethernet
frame sizes are correct. (Ping is disabled on computers that use the default security policy for the manager. Networks sometimes
block ICMP ping and traceroute to block attackers' reconnaissance scans. So usually, you can't ping the manager to test.)
If telnet fails, trace the route to discover which point on the network is interrupting connectivity.
l On Linux, enter the command:
traceroute [agent IP]
l On Windows, enter the command:
tracert [agent IP]
Adjust firewall policies, routes, NAT port forwarding, or all three to correct the problem. Verify both network and host-based
firewalls, such as Windows Firewall and Linux iptables. For an AWS EC2 instance, see Amazon's documentation on Amazon EC2
Security Groups for Linux Instances or Amazon EC2 Security Groups for Windows Instances. For an Azure VM instance, see
Microsoft's Azure documentation on modifying a Network Security Group.
If connectivity tests from the agent to the manager succeed, then next you must test connectivity in the other direction. (Firewalls
and routers often require policy-route pairs to allow connectivity. If only 1 of the 2 required policies or routes exist, then packets will
be allowed in one direction but not the other.)
Allow inbound ports (manager-initiated heartbeat)
On the manager, ping the agent and telnet to the heartbeat port number to verify that heartbeat and configuration traffic can reach
the agent:
ping [agent IP]
telnet [agent IP]:4118
1522
Trend Micro Deep Security On-Premise 20
If the ping and telnet fail, use:
traceroute [agent IP]
to discover which point on the network is interrupting connectivity. Adjust firewall policies, routes, NAT port forwarding, or all three
to correct the problem.
If IPS or firewall rules are blocking the connection between the agent and the manager, then the manager cannot connect in order
to unassign the policy that is causing the problem. To solve this, enter the command on the computer to reset policies on the agent:
dsa_control -r
Note: You must re-activate the agent after running this command.
Allow ICMP on Amazon AWS EC2 instances
In the AWS cloud, routers require ICMP type 3 code 4. If this traffic is blocked, connectivity between agents and the manager may
be interrupted.
You can force allow this traffic in Deep Security. Either create a firewall policy with a force allow, or in the computer or policy
settings, in the Advanced Network Engine area, enable Force Allow ICMP type3 code4 (see "Network engine settings" on
page 475).
Fix the upgrade issue on Solaris 11
A problem may occur if you previously installed Deep Security Agent 9.0 on Solaris 11, and then upgraded the agent software to
11.0 directly without first installing 9.0.0-5616 or a later 9.0 agent. In this scenario, the agent may fail to start up after the upgrade
and may appear as offline in Deep Security Manager. To fix this issue:
1523
Trend Micro Deep Security On-Premise 20
1. Uninstall the agent from the server. See "Uninstall Deep Security Agent" on page 1328.
2. Install the Deep Security Agent 11.0. See "Install the agent manually" on page 273.
3. Re-activate the agent on the manager. See "Activate the agent" on page 295.
High CPU usage
On a computer protected by Deep Security Agent, you can use these steps to determine and resolve the cause of high CPU usage.
1. Verify that the Trend Micro Deep Security Agent process (ds_agent.exe on Windows) has unusually high CPU usage.
Method varies by operating system.
Windows: Task Manager
Linux: top
Solaris: prstat
AIX: topas
2. Verify that the agent is updated to the latest version.
3. Apply the best practices on "Performance tips for anti-malware" on page 572 and "Performance tips for intrusion prevention"
on page 655.
4. If you have just enabled application control, wait until the initial baseline ruleset is complete. Time required varies by the
number of files on the file system. The CPU usage should decrease.
5. If a recommendation scan is being performed, try running scans during a time when the computer is less busy, or (if the
computer is a VM) allocating more vCPUs.
6. Temporarily disable each protection feature (anti-malware etc.), one at a time. Check CPU usage each time to determine if a
specific module is the cause.
7. If high CPU usage still continues, try temporarily stopping the agent. Verify that the issue stops when the agent is stopped. If
it does, collect diagnostic information and give it to your support provider.
1524
Trend Micro Deep Security On-Premise 20
Diagnose problems with agent deployment (Windows)
If a Deep Security Agent on Windows fails to install or activate, look in the deployment logs to find the cause and troubleshoot it.
1. Log in to the computer where you were trying to install the agent.
2. Go to %appdata%\Trend Micro\Deep Security Agent\installer.
3. Examine:
l dsa_deploy.txt - Log from the PowerShell script. Contains agent activation issues.
l dsa_install.txt - Log from the MSI installer. Contains agent installation issues.
"Anti-Malware Driver Offline" status with VMware
See Anti-malware driver offline.
Anti-Malware Windows platform update failed
Double-click the error message to display more detailed information. The “Message” in the error event may include:
l "An incompatible Anti-Malware component from another Trend Micro product" below
l "An incompatible Anti-Malware component from a third-party product" on the next page
l "Other/unknown Error" on the next page
An incompatible Anti-Malware component from another Trend Micro product
To solve this error:
1525
Trend Micro Deep Security On-Premise 20
1. Uninstall the incompatible Trend Micro product (for example, Office Scan or Endpoint Sensor).
2. Reinstall the Deep Security Agent.
An incompatible Anti-Malware component from a third-party product
To solve this error:
1. Uninstall the third-party product.
2. Reinstall the Deep Security Agent.
3. Add Deep Security to the third-party software's exception list. Contact Trend Micro support if you need assistance.
Other/unknown Error
To solve this error:
1. Uninstall and reinstall the Deep Security Agent.
2. If the error is not resolved, call Trend Micro support for assistance.
Performance issues on an agentless virtual machine
Cause: Limited resources
1. Make sure that Deep Security Virtual Agent resource is reserved from settings.
2. Ensure that the deployment has met the requirements specified in the installation instructions.
1526
Trend Micro Deep Security On-Premise 20
Cause: Anti-malware
1. On Deep Security Manager, go to Computers.
2. Double-click the protected computer.
3. For Anti-Malware, select Off.
Cause: Network traffic
l Add scan exclusions for locations that are known to reduce performance without improving security. For details, see
Recommended scan exclusion list for Trend Micro Endpoint products in OfficeScan (OSCE).
Note: The thin driver exclusion is case-sensitive.
Cause: Policy
l Change the policy setting for the virtual machine to None.
Cause: High CPU
1. Identify which Deep Security Virtual Agent has high CPU usage.
l Go to the vCenter console, click each Deep Security Virtual Agent and select Performance to identify the machine with
high CPU usage.
2. Run the hop tool to determine which process is consuming most of the CPU usage.
3. Identify the high CPU process memory consumption.
a. Execute the following to check the process memory status: #cat /proc/$PID/status(Replace $PID with your own
PID.)
b. Verify that the vmsize is reasonable.
1527
Trend Micro Deep Security On-Premise 20
c. Export the content to a log file using this command:
#cat /proc/$PID/status > /tmp/HighCPUProcessMemory.txt
#sudo lsof -p $PID > /tmp/HighCPUProcessOpenedFile.t
4. Check if the Deep Security Virtual Agent has enough free memory.
a. Run the command cat /proc/meminfo to identify the Deep Security Virtual Agent system free memory.
b. Run the command cat /proc/meminfo > /tmp/DSVAMemory.txt to export the content to a log file.
Cause: Security Update
1. Check the connection between the relay and its update source or proxy server.
a. Verify if you need to use a proxy server or not.
b. Log into the Deep Security, go to Administration > System Settings > Proxy, and confirm that the configuration settings
are correct.
2. Perform a ping test between the agent and the relay-enabled agent.
3. Make sure that the relay port number is open by using telnet [relay IP] [port number].
4. Test the DNS to determine if the hostname of the relay can be resolved.
5. Check if any firewalls are blocking the communication and disable them if they are.
6. Unassign the current policy and check if the issue still persists.
Security update connectivity
Verify the connectivity between the relay server and its Active Update source or proxy server.
1. To verify that both a route exists and that the relay port number is open, enter the command:
telnet [relay IP] [port number]
1528
Trend Micro Deep Security On-Premise 20
If the telnet fails, verify that a route exists and that firewall policies (if any) allow the traffic by pinging or using traceroute. Also
verify that the port number is open, and doesn't have a port conflict.
2. To verify that the DNS server can resolve the domain name of the relay, enter the command:
nslookup [relay domain name]
If the test fails, verify that the agent is using the correct DNS proxy or server (internal domain names can't be resolved by a
public DNS server such as Google or your ISP).
If you are using Deep Security as a Service, you might not be using your own relays; instead, you will be using the relays that
are built into the service: relay.deepsecurity.trendmicro.com.
3. If you use a proxy server, on Deep Security, confirm that the proxy settings are correct.
4. To determine if your Deep Security settings are blocking connectivity, unassign the current policy.
SQL Server domain authentication problems
If you experience problems connecting to the Microsoft SQL Server database when installing Deep Security Manager, follow the
instructions below to troubleshoot the problem.
Note: This topic's scope is limited to Windows domain authentication issues. If you are using SQL Server Authentication
instead, see "Configure the database" on page 206 and review the configuration steps listed in that topic to troubleshoot any
problems.
Tip: 'Windows domain authentication' goes by many names: Kerberos authentication, domain authentication, Windows
authentication, integrated authentication, and a few others. In this topic, the terms 'Kerberos' and 'Windows domain
authentication' are used.
"Step 1: Verify the host name and domain" on the next page
1529
Trend Micro Deep Security On-Premise 20
"Step 2: Verify the servicePrincipalName (SPN)" on the next page
"Step 3: Verify the krb5.conf file (Linux only)" on page 1545
"Step 4: Verify the system clock " on page 1547
"Step 5: Verify the firewall " on page 1547
Step 1: Verify the host name and domain
You must make sure the Host name field is in FQDN format and resolvable by the DNS server:
1. When you run the Deep Security Manager installer and reach the database step, make sure you specify the SQL server's
FQDN. Don't input an IP address or NetBIOS host name.
Example of a valid host name: sqlserver.example.com
2. Make sure the FQDN is registered and resolvable by the DNS server. To check if the correct host name was configured in the
DNS entry, use the nslookup command-line utility. This utility can be invoked from any computer on the domain. Enter the
following command:
nslookup <SQL Server FQDN>
where <SQL_Server_FQDN> is replaced with the FQDN of the SQL server. If the utility can resolve the provided FQDN
successfully, then the DNS entry is configured properly. If the FQDN cannot be resolved, then configure a DNS A record and
reverse record that includes the FQDN.
3. Still on the installer's database page, click Advanced and make sure you specify the SQL server's full domain name in the
Domain field. The domain must include one or more dots ("."). Don't input a short domain name or NetBIOS name.
Example of a valid domain name: example.com
1530
Trend Micro Deep Security On-Premise 20
4. Check if the domain name is in FQDN format using the nslookup command-line utility. Enter the following command:
nslookup <Domain_Name>
where <Domain_Name> is replaced with the full domain name of the SQL server. If the utility can resolve the provided domain
name, then it is the full domain name.
Note: Database authentication using Microsoft workgroups is not supported by Deep Security Manager 10.2 and later. For
Windows domain authentication, you'll need to have installed an Active Directory domain controller, configured a domain,
and added the SQL server to this domain. If there is no Active Directory domain infrastructure in your environment, you must
use SQL Server Authentication instead. (To use SQL Server Authentication instead of Windows domain authentication,
enter the Deep Security Manager database owner's user name and password into the User name and Password fields on
the Database page of the manager's installer. Do not input a domain. The omission of a domain name causes SQL Server
Authentication to be used. For details, see "Install the manager" on page 211.)
Step 2: Verify the servicePrincipalName (SPN)
You must make sure the servicePrincipalName (SPN) is configured correctly in Active Directory.
For Microsoft SQL Server, the SPN is in this format:
MSSQLSvc/<SQL_Server_Endpoint_FQDN>
MSSQLSvc/<SQL_Server_Endpoint_FQDN>:<PORT>
To verify that the SPN is correct, run through these tasks. At the end are some step-by-step instructions for specific use cases,
references to other documentation, and debugging tips.
"Step 2a: Identify the account (SID) running the SQL Server service" on the next page
"Step 2b: Find the account in Active Directory" on page 1534
1531
Trend Micro Deep Security On-Premise 20
"Step 2c: Identify which FQDN to use in the SPN " on page 1535
"Step 2d: Identify whether you're using a default instance or named instance " on page 1535
"Case 1: Set the SPN under a local virtual account" on page 1536
"Case 2: Set the SPN under a domain account" on page 1538
"Case 3: Set the SPN under a Managed Service account" on page 1540
"Case 4: Set the SPN for a failover cluster" on page 1542
"SPN references" on page 1544
"SPN debugging tips" on page 1544
Step 2a: Identify the account (SID) running the SQL Server service
The SPN is configured inside the account running the SQL Server service.
To identify which account is running the SQL Server service, use the services.msc utility. You see the SQL Server service
appear, along with the associated account.
1532
Trend Micro Deep Security On-Premise 20
1533
Trend Micro Deep Security On-Premise 20
Step 2b: Find the account in Active Directory
Once you know the name of the account running the SQL Server service, you must locate it in Active Directory. The account can
be in a few possible locations depending on whether it is a local virtual account, a domain account, or a Managed Service account.
The table below outlines these possible locations. You can use the ADSI Editor (adsiedit.msc) on the Active Directory computer
to look for the different folders in Active Directory and find the account.
Location of account in
Account type Name of account Description
Active Directory
NT SERVICE\MSSQLSERVER
Services that run under virtual accounts access
Local (default instance) CN=Computer
network resources by using the credentials of
virtual NT CN=<Computer_
the computer account. The default standalone
account SERVICE\MSSQL$InstanceName Name>
SQL Server service uses this account to start up.
(named instance)
Services started using this account access the
network resources using a domain user's
Domain A domain user name, for example, CN=Users credentials. SQL Server failover clusters require
account SQLServerServiceUser CN=<User_Name> a domain account to run the service. The
standalone SQL Server service can also be
configured to use a domain account to start up.
Introduced in Windows Server 2008 R2, the
Managed Service Account resembles the
CN=Managed
Managed domain account, but can be used to perform
A Managed Service account name, Service Account
Service interactive logons. Both the standalone SQL
for example SQLServerMSA CN=<Account_
account Server service and the SQL Server cluster
Name>
services can be configured to use a Managed
Service account to start up.
1534
Trend Micro Deep Security On-Premise 20
Step 2c: Identify which FQDN to use in the SPN
For naming consistency, it is recommended that you set the SPN to the FQDN of the endpoint. The endpoint is the target to which
the SQL Server client (Deep Security Manager) connects, and may be an individual SQL Server or a cluster. Consult the table
below for details on which FQDN to use.
If the SQL Server installation
Set the SPN to...
type is...
Standalone SQL Server The FQDN of the host where the SQL Server is installed
Failover SQL Server The FQDN of the SQL Server cluster (individual SQL Server nodes are not the endpoint and
cluster should not be used in the FQDN)
Step 2d: Identify whether you're using a default instance or named instance
You must know whether the SQL Server was installed as a default instance or a named instance because the port number and
instance name (if one was specified) need to go into the SPN.
l The default instance typically uses port 1433.
l A named instance uses a different port. To determine this port, consult this webpage.
Example: If the FQDN endpoint of the SQL Server service is sqlserver.example.com and it is the default instance, then the SPN
will be in the format:
MSSQLSvc/sqlserver.example.com
MSSQLSvc/sqlserver.example.com:1433
1535
Trend Micro Deep Security On-Premise 20
Another example: If the FQDN endpoint of SQL Server service is sqlserver.example.com and it is a named instance using port
51635 with an instance name of DEEPSECURITY, then the SPN will be in the format:
MSSQLSvc/sqlserver.example.com:DEEPSECURITY
MSSQLSvc/sqlserver.example.com:51635
Case 1: Set the SPN under a local virtual account
To set the SPN for a standalone SQL Server that runs under a local virtual account:
1. On the Active Directory computer, open ADSIEdit.msc. The ADSI Editor opens.
2. Locate the SQL Server host in CN=Computers.
3. Right-click the SQL Server host, and select Properties.
4. On the Attribute Editor tab, scroll to servicePrincipalNames and click the Edit button.
5. If the attribute values don't exist, add each one individually using the Add button. Click OK.
1536
Trend Micro Deep Security On-Premise 20
1537
Trend Micro Deep Security On-Premise 20
Case 2: Set the SPN under a domain account
The SPN configuration is similar to the local virtual account configuration except that the SPN is set in domain account
(CN=Users) running the SQL Server service.
1538
Trend Micro Deep Security On-Premise 20
1539
Trend Micro Deep Security On-Premise 20
Case 3: Set the SPN under a Managed Service account
The SPN is set in the Managed Service account (CN=Managed Service Account) running the SQL Server service.
1540
Trend Micro Deep Security On-Premise 20
1541
Trend Micro Deep Security On-Premise 20
Case 4: Set the SPN for a failover cluster
An SQL Server failover cluster can run under a domain account or a Managed Service account. Refer to "Case 2: Set the SPN
under a domain account" on page 1538 or "Case 3: Set the SPN under a Managed Service account" on page 1540 for instructions.
Make sure to set the SPN to the FQDN of the SQL cluster endpoint, not an individual SQL node.
1542
Trend Micro Deep Security On-Premise 20
1543
Trend Micro Deep Security On-Premise 20
SPN references
Below are links to Microsoft's official documents about SPN configurations:
Register a Service Principal Name for Kerberos Connections
How to Configure an SPN for SQL Server Site Database Servers
How to: Enable Kerberos Authentication on a SQL Server Failover Cluster
SPN debugging tips
To verify that the correct SPN configuration was set, use the command line tool setspn to query for registered SPN entries. The
command syntax is:
setspn -T <Full_Domain_Name> -F -Q MSSQLSvc/<SQL_Server_Endpoint_FQDN>*
where:
l <Full_Domain_Name> is replaced with the domain name of your environment.
l <SQL_Server_Endpoint_FQDN> is replaced with the FQDN of SQL Server.
For example: Assume that a standalone SQL Server resides at SQL2012.dslab.com, and runs under a local virtual account in the
domain dslab.com. You can use command below to query all registered SPNs that have a prefix of
MSSQLSvc/SQL2012.dslab.com and see if it is correctly configured.
1544
Trend Micro Deep Security On-Premise 20
From the command result, you can then verify that the SPN has been set and registered in correct LDAP path, and in the account
that is running the SQL Server service (in this case, it is the computer account).
Step 3: Verify the krb5.conf file (Linux only)
If you're installing the manager on Linux, you must make sure the /etc/krb5.conf exists and contains the correct domain and
realm information:
1. Open or create the /etc/krb5.conf file in a text editor to configure Kerberos.
2. Provide the following information:
[libdefaults]
...
default_realm = <DOMAIN>
...
[realms]
<DOMAIN> = {
kdc = <ACTIVE_DIRECTORY_CONTROLLER_FQDN>
1545
Trend Micro Deep Security On-Premise 20
admin_server = <ACTIVE_DIRECTORY_CONTROLLER_FQDN>
[domain_realm]
.<DOMAIN FQDN> = <DOMAIN>
<DOMAIN FQDN> = <DOMAIN>
where <DOMAIN>, <ACTIVE_DIRECTORY_CONTROLLER_FQDN> and <DOMAIN_FQDN> are replaced with your own values.
Example file:
[libdefaults]
default_realm = EXAMPLE.COM
default_tkt_enctypes = des3-hmac-sha1 des-cbc-crc
default_tgs_enctypes = des3-hmac-sha1 des-cbc-crc
dns_lookup_kdc = true
dns_lookup_realm = false
[realms]
EXAMPLE.COM = {
kdc = kerberos.example.com
kdc = kerberos-1.example.com
admin_server = kerberos.example.com
1546
Trend Micro Deep Security On-Premise 20
[domain_realm]
.example.com = EXAMPLE.COM
example.com = EXAMPLE.COM
[logging]
kdc = SYSLOG:INFO
admin_server = FILE=/var/kadm5.log
3. Save and close the file.
Step 4: Verify the system clock
You must make sure the system clocks on the domain controller, SQL Server, and Deep Security Manager computer are
synchronized. With Kerberos, the maximum allowable clock skew is five minutes by default.
Step 5: Verify the firewall
You must make sure the firewall is not blocking the SQL connection. A default SQL Server instance allows connections through
port 1433, while a named SQL Server instance uses a port that is selected at random. To find out which port to connect to, the SQL
client (Deep Security Manager in this case) queries the available named instances and finds the mapping port by issuing a lookup
request to the SQL Server browser service. The SQL Server browser service runs on port 1434 (UDP). Verify that your firewall
configuration allows port 1433 (if you're using a default instance), or 1434 (if you're using a named instance).
1547
Trend Micro Deep Security On-Premise 20
Prevent MTU-related agent communication issues across Amazon Virtual
Private Clouds (VPC)
Agents in different VPCs might experience problems when trying to communicate with Deep Security Manager. This could be
because the network maximum transmission unit (MTU) supported by Amazon Web Services is 1500 and Deep Security Agent
communication traffic can exceed this, which results in fragmented and dropped packets.
You can prevent this MTU-related communication issue from happening by adding a new firewall rule to all firewall policies. The
key settings for this new firewall rule are shown in the image below.
1548
Trend Micro Deep Security On-Premise 20
1549
Trend Micro Deep Security On-Premise 20
Create a diagnostic package and logs
To diagnose an issue, your support provider may ask you to send a diagnostic package containing debug information for either or
both:
l Deep Security Manager
l Deep Security Agent
Deep Security Manager diagnostics
Create a diagnostic package for Deep Security Manager
1. Go to Administration > System Information.
2. Click Create Diagnostic Package.
The package will take several minutes to create. After the package has been generated, a summary will be displayed and
your browser will download a ZIP file containing the diagnostic package.
Enable debug logs for Deep Security Manager
In addition to a diagnostic package, your support provider may ask you to enable diagnostic logging.
Warning: Don't enable diagnostic logging unless recommended by your support provider. Diagnostic logging can consume
large amounts of disk space and increase CPU usage.
1. Go to Administration > System Information.
2. Click Diagnostic Logging.
1550
Trend Micro Deep Security On-Premise 20
3. In the wizard that appears, select the options requested by your support provider.
If you have a multi-tenant Deep Security Manager, and the issue that you want to diagnose only occurs with a specific tenant,
select that tenant's name in the option that appears. This will focus the debug logs, and minimize performance impacts while
debug logging is enabled.
Some features need more time and disk space to collect enough debug logs. For example, you might need to increase
Maximum log file size to 25 MB and the time period to 24 hours for Database-related Issues and Cloud Account
Synchronization - AWS.
Note: If you decrease Maximum number of log files, Deep Security Manager does not automatically delete existing log
files that now exceed the maximum. For example, if you reduce from 10 to 5 log files, server5.log to server9.log would
all still exist. To reclaim disk space, manually delete those files from the file system.
While diagnostic logging is running, Deep Security Manager will display the message Diagnostic Logging enabled on the
status bar. If you changed the default options, the status bar will display the message Non default logging enabled upon
diagnostic logging completion.
4. To find diagnostic logging files, go to the root directory of the Deep Security Manager, and look for file names with the pattern
server#.log, such as server0.log.
Deep Security Agent diagnostics
For an agent, you can create a diagnostic package either:
l via the Deep Security Manager
l using the CLI on a protected computer (if the Deep Security Manager cannot reach the agent remotely)
For Linux-specific information on increasing or decreasing the anti-malware debug logging for the diagnostic package, see
"Increase debug logging for anti-malware in protected Linux instances" on page 609.
1551
Trend Micro Deep Security On-Premise 20
Your support provider may also ask you collect:
l a screenshot of Task Manager (Windows) or output from top(Linux) or prstat (Solaris) or topas (AIX)
l debug logs
l Perfmon log (Windows) or Syslog
l memory dumps (Windows) or core dumps (Linux, Solaris, AIX)
Create an agent diagnostic package via Deep Security Manager
Note: Deep Security Manager must be able to connect to an agent remotely to create a diagnostic package for it. If the Deep
Security Manager cannot reach the agent remotely, or if the agent is using agent-initiated activation, you must create the
diagnostic package directly from the agent.
1. Go to Computers.
2. Double-click the name of the computer you want to generate the diagnostic package for.
3. Select the Actions tab.
4. Under Support, click Create Diagnostics Package.
5. Click Next.
The package will take several minutes to create. After the package has been generated, a summary will be displayed and
your browser will download a ZIP file containing the diagnostic package.
Note: When the System Information check box is selected, it might create a huge diagnostic package that could have a
negative impact on performance. The check box is greyed out if you are not a primary tenant or do not have the proper viewing
rights.
1552
Trend Micro Deep Security On-Premise 20
Create an agent diagnostic package via CLI on a protected computer
Linux, AIX, and Solaris
1. Connect to the server that you want to generate the diagnostic package for.
2. Enter the command:
sudo /opt/ds_agent/dsa_control -d
The output shows the name and location of the diagnostic package: /var/opt/ds_agent/diag
Windows
1. Connect to the computer that you want to generate the diagnostic package for.
2. Open a command prompt as an administrator, and enter the command.
In PowerShell:
& "\Program Files\Trend Micro\Deep Security Agent\dsa_control" -d
In cmd.exe:
cd C:\Program Files\Trend Micro\Deep Security Agent
dsa_control.cmd -d
The output shows the name and location of the diagnostic package: C:\ProgramData\Trend Micro\Deep Security
Agent\diag
Collect debug logs with DebugView
On Windows computers, you can collect debug logs using DebugView software.
1553
Trend Micro Deep Security On-Premise 20
Warning: Only collect debug logs if your support provider asks for them. During debug logging, CPU usage will increase, which
will make high CPU usage issues worse.
1. Download the DebugView utility.
2. If self-protection is enabled, disable it.
3. Stop the Trend Micro Deep Security Agent service.
4. In the C:\Windows directory, create a plain text file named ds_agent.ini.
5. In the ds_agent.ini file, add this line:
trace=*
6. Launch DebugView.exe.
7. Go to Menu > Capture.
8. Enable these settings:
l Capture Win32
l Capture Kernel
l Capture Events
9. Start the Trend Micro Deep Security Agent service.
10. Export the information in DebugView to a CSV file.
11. Re-enable self-protection if you disabled it at the beginning of this procedure.
Increase verbose diagnostic package process memory
In environments with a large number of hosts (for example, 10,000 hosts or more,) the verbose diagnostic package process (dsm_
c.exe) may run out of memory while creating the diagnostic package. To prevent this, you can increase the memory allocated to
the verbose diagnostic package JVM process to 2 GB.
1554
Trend Micro Deep Security On-Premise 20
1. Go to the Deep Security Manager installation directory.
2. Create a new file with the name "dsm_c.vmoptions".
3. Open the file and add the line -Xmx2g.
Note: If 2 GB of memory is not enough, you can further increase the allocated memory by changing the value in the above
line (for example, -Xmx4g for 4 GB or -Xmx6g for 6 GB).
4. Save the file and run dsm_c.exe.
Removal of older software versions
In certain situations, we may determine that it's in the best interest of our customers to remove access to a previously released
version of software. We only remove software when there is a significant known issue with that release. This is done to limit
customer exposure to known problems.
When access to an old software version has been removed, the download link is replaced with a link to a Knowledge Base article
detailing the issue that caused us to remove the software.
If you require access to an older version that has been removed, contact support with the software version and Knowledge Base
number.
Troubleshoot SELinux alerts
To check if SELinux is enabled, enter the following command: sestatus.
When the SELinux policy is set to enable and block ds_agent, the following alert sample might appear in the system log or
SELinux log (/var/log/audit/audit.log or /var/log/audit.log):
[TIMESTAMP] [HOSTNAME] python: SELinux is preventing [/PATH/BINARY] from 'read, write' accesses on
the file /var/opt/ds_agent/dsa_core/ds_agent.db-shm.
1555
Trend Micro Deep Security On-Premise 20
***** Plugin leaks (86.2 confidence) suggests *****************************
If you want to ignore [BINARY] trying to read write access the ds_agent.db-shm file, because you
believe it should not need this access. Then you should report this as a bug.
You can generate a local policy module to dontaudit this access.
Do
ausearch -x [/PATH/BINARY] --raw | audit2allow -D -M [POLICYNAME]
semodule -i POLICYNAME.pp
To resolve the issue, create a custom SELinux policy with Audit2allow:
1. Connect to the Deep Security Agent as a root user.
2. Run the following commands to create a custom policy that will allow access to Deep Security Agent files:
cd /tmp
grep ds_agent /var/log/audit/audit* | audit2allow -M ds_agent
semodule -i ds_agent.pp
3. Restart the ds_agent.
4. Check the system messages and confirm that there are no alerts related to ds_agent.
cat /var/log/messages | grep ds_agent
5. If alerts are still occurring, run the commands from step 2 again. This will update the existing policy and re-apply it.
To remove the SELinux policy, use the following command: semodule -r ds_agent.
1556
Trend Micro Deep Security On-Premise 20
PDFs
Deep Security Administration Guide
The Deep Security Administration Guide is a PDF version of the Deep Security Help Center:
Open the Deep Security 20 Administration Guide
Deep Security Best Practice Guide
The Deep Security Best Practice Guide is intended to help you get the best productivity out of the product. It contains a collection
of best practices that are based on knowledge gathered from previous enterprise deployments, lab validations, and lessons
learned in the field. Examples and considerations in this document serve only as a guide and not a representation of strict design
requirements. These guidelines do not apply in every environment but will help guide you through the decisions that you need in
configuring Deep Security for optimum performance.
The Deep Security 12 Best Practice Guide is currently available in PDF format and includes the following:
l Deployment considerations and recommendations
l Upgrade guidelines and scenarios
l Sizing considerations and recommendations
l Recommended configurations to maximize system performance and reduce administrative overhead
l Best practice tips for VDI, private, and public cloud environments
1557
You might also like
- Hourglass Workout Program by Luisagiuliet 276% (21)Hourglass Workout Program by Luisagiuliet 251 pages
- The Hold Me Tight Workbook - Dr. Sue Johnson100% (16)The Hold Me Tight Workbook - Dr. Sue Johnson187 pages
- Read People Like A Book by Patrick King-Edited62% (66)Read People Like A Book by Patrick King-Edited12 pages
- Livingood, Blake - Livingood Daily Your 21-Day Guide To Experience Real Health77% (13)Livingood, Blake - Livingood Daily Your 21-Day Guide To Experience Real Health260 pages
- COSMIC CONSCIOUSNESS OF HUMANITY - PROBLEMS OF NEW COSMOGONY (V.P.Kaznacheev,. Л. V. Trofimov.)94% (212)COSMIC CONSCIOUSNESS OF HUMANITY - PROBLEMS OF NEW COSMOGONY (V.P.Kaznacheev,. Л. V. Trofimov.)212 pages
- Donald Trump & Jeffrey Epstein Rape Lawsuit and Affidavits83% (1016)Donald Trump & Jeffrey Epstein Rape Lawsuit and Affidavits13 pages
- The 36 Questions That Lead To Love - The New York Times94% (34)The 36 Questions That Lead To Love - The New York Times3 pages
- The 36 Questions That Lead To Love - The New York Times95% (21)The 36 Questions That Lead To Love - The New York Times3 pages
- Jeffrey Epstein39s Little Black Book Unredacted PDF75% (12)Jeffrey Epstein39s Little Black Book Unredacted PDF95 pages
- The 4 Hour Workweek, Expanded and Updated by Timothy Ferriss - Excerpt23% (954)The 4 Hour Workweek, Expanded and Updated by Timothy Ferriss - Excerpt38 pages
- Dynamics 365 Documentation and Training ModulesNo ratings yetDynamics 365 Documentation and Training Modules3 pages
- Master Data Management Solution RFP Template: Introduction: How To Use This Template100% (1)Master Data Management Solution RFP Template: Introduction: How To Use This Template13 pages
- © 2018 Caendra Inc. - Hera For Ptpv5 - Linux Exploitation (Remote Exploitation & Post-Exploitation)No ratings yet© 2018 Caendra Inc. - Hera For Ptpv5 - Linux Exploitation (Remote Exploitation & Post-Exploitation)22 pages
- Deep Security 96 SP1 Install Guide Basic enNo ratings yetDeep Security 96 SP1 Install Guide Basic en88 pages
- 3PAR Storage Multi-Path (Hyperactive) + RHEL7.2 + ORACLE 11G-RAC Environme NT Construction NotesNo ratings yet3PAR Storage Multi-Path (Hyperactive) + RHEL7.2 + ORACLE 11G-RAC Environme NT Construction Notes17 pages
- SMcli and Script Commands Quick Reference For SANtricity Ver 9.25 ES1790-0-E1No ratings yetSMcli and Script Commands Quick Reference For SANtricity Ver 9.25 ES1790-0-E162 pages
- Dell EMC VxRail - VCF On VxRail - How To Re-Generate TLS Certificate For VxRail Manager - Dell USNo ratings yetDell EMC VxRail - VCF On VxRail - How To Re-Generate TLS Certificate For VxRail Manager - Dell US11 pages
- 1 Module: Introduction To VNX ManagementNo ratings yet1 Module: Introduction To VNX Management14 pages
- How To Install and Use Powershell On LinuxNo ratings yetHow To Install and Use Powershell On Linux6 pages
- Windows Unified Host Utilities 7.0: Installation GuideNo ratings yetWindows Unified Host Utilities 7.0: Installation Guide64 pages
- SANtricity Simulator Guide Overview 10.84 V1No ratings yetSANtricity Simulator Guide Overview 10.84 V114 pages
- Use Tivoli Storage Manager To Back Up and Recover A DB2 DatabaseNo ratings yetUse Tivoli Storage Manager To Back Up and Recover A DB2 Database17 pages
- Clustered Data ONTAP 82 Network Management GuideNo ratings yetClustered Data ONTAP 82 Network Management Guide111 pages
- HPOS SP12.1 Install and Config Guide Hpos41sp121incenUS100% (1)HPOS SP12.1 Install and Config Guide Hpos41sp121incenUS352 pages
- ImplementationandMaintenanceStudentGuide PDFNo ratings yetImplementationandMaintenanceStudentGuide PDF168 pages
- Docu87837 - Isilon InsightIQ 4.1.2 User GuideNo ratings yetDocu87837 - Isilon InsightIQ 4.1.2 User Guide78 pages
- NetApp NPI AFF StorageGrid SolidFire AltaVaultNo ratings yetNetApp NPI AFF StorageGrid SolidFire AltaVault5 pages
- HPE 4400 Enterprise Virtual Array - Controller Enclosure - Battery Replacement InstructionsNo ratings yetHPE 4400 Enterprise Virtual Array - Controller Enclosure - Battery Replacement Instructions3 pages
- 8 Linux Parted' Commands To Create, Resize and Rescue Disk PartitionsNo ratings yet8 Linux Parted' Commands To Create, Resize and Rescue Disk Partitions13 pages
- IBM Spectrum Scale Basic Administration For Linux - H005G: Course DetailsNo ratings yetIBM Spectrum Scale Basic Administration For Linux - H005G: Course Details3 pages
- Implementing DR Solutions With IBM Storwize V7000 and VMware Site Recovery Manager100% (1)Implementing DR Solutions With IBM Storwize V7000 and VMware Site Recovery Manager72 pages
- Protecting Business-Critical Applications in A Vmware Infrastructure 3 Environment Using Veritas™ Cluster Server For Vmware EsxNo ratings yetProtecting Business-Critical Applications in A Vmware Infrastructure 3 Environment Using Veritas™ Cluster Server For Vmware Esx18 pages
- CiscoMDS FabricSwitchConfigurationGuideAndCommandLineNo ratings yetCiscoMDS FabricSwitchConfigurationGuideAndCommandLine328 pages
- Celerra Nas VNX Health Check With CLI CommandsNo ratings yetCelerra Nas VNX Health Check With CLI Commands4 pages
- DM Series Root Aggregate and Cluster Setup GuideNo ratings yetDM Series Root Aggregate and Cluster Setup Guide11 pages
- The Architecture of SAP ERP: Understand how successful software worksFrom EverandThe Architecture of SAP ERP: Understand how successful software worksNo ratings yet
- Deep Security 12.0 On-Premise Administration Guide PDFNo ratings yetDeep Security 12.0 On-Premise Administration Guide PDF1,521 pages
- Deep Security 12.0 On-Premise Administration GuideNo ratings yetDeep Security 12.0 On-Premise Administration Guide1,579 pages
- Deep Security 10.3 On-Premise Administration GuideNo ratings yetDeep Security 10.3 On-Premise Administration Guide1,358 pages
- Accelerating Successful Business Transformations With SAP MaxAttentionNo ratings yetAccelerating Successful Business Transformations With SAP MaxAttention17 pages
- Setting Up A Self-Hosted GitHub Action Runner For Python Applications On EC2 InstanceNo ratings yetSetting Up A Self-Hosted GitHub Action Runner For Python Applications On EC2 Instance16 pages
- IBM WebSphere Cast Iron Introduction and Technical OverviewNo ratings yetIBM WebSphere Cast Iron Introduction and Technical Overview28 pages
- Unit 5: Setting Up SAP Ariba and SAP S-4HANA ConnectivityNo ratings yetUnit 5: Setting Up SAP Ariba and SAP S-4HANA Connectivity11 pages
- IDP - Employee Central Payroll Migrating From ERP HCM Payroll To Employee Central Payroll V1.7.1No ratings yetIDP - Employee Central Payroll Migrating From ERP HCM Payroll To Employee Central Payroll V1.7.120 pages
- Replication Use Cases: Delphix Engine Deployed in The Public CloudNo ratings yetReplication Use Cases: Delphix Engine Deployed in The Public Cloud4 pages
- Performance Engineering The Loadrunner Family Brochure enNo ratings yetPerformance Engineering The Loadrunner Family Brochure en13 pages
- Saas Management: The Definitive Guide For It and Finance LeadersNo ratings yetSaas Management: The Definitive Guide For It and Finance Leaders21 pages
- Tips and Tricks For Sizing Your SAP S4HANA System and Landscape Si100% (1)Tips and Tricks For Sizing Your SAP S4HANA System and Landscape Si39 pages
- Critical Capabilities For Enterprise Architecture Tools: Key FindingsNo ratings yetCritical Capabilities For Enterprise Architecture Tools: Key Findings46 pages
- Oracle Cloud Infrastructure Powers Cloud-Connected EnterprisesNo ratings yetOracle Cloud Infrastructure Powers Cloud-Connected Enterprises19 pages
- Livingood, Blake - Livingood Daily Your 21-Day Guide To Experience Real HealthLivingood, Blake - Livingood Daily Your 21-Day Guide To Experience Real Health
- COSMIC CONSCIOUSNESS OF HUMANITY - PROBLEMS OF NEW COSMOGONY (V.P.Kaznacheev,. Л. V. Trofimov.)COSMIC CONSCIOUSNESS OF HUMANITY - PROBLEMS OF NEW COSMOGONY (V.P.Kaznacheev,. Л. V. Trofimov.)
- Donald Trump & Jeffrey Epstein Rape Lawsuit and AffidavitsDonald Trump & Jeffrey Epstein Rape Lawsuit and Affidavits
- The 36 Questions That Lead To Love - The New York TimesThe 36 Questions That Lead To Love - The New York Times
- The 36 Questions That Lead To Love - The New York TimesThe 36 Questions That Lead To Love - The New York Times
- Jeffrey Epstein39s Little Black Book Unredacted PDFJeffrey Epstein39s Little Black Book Unredacted PDF
- The 4 Hour Workweek, Expanded and Updated by Timothy Ferriss - ExcerptThe 4 Hour Workweek, Expanded and Updated by Timothy Ferriss - Excerpt
- Master Data Management Solution RFP Template: Introduction: How To Use This TemplateMaster Data Management Solution RFP Template: Introduction: How To Use This Template
- © 2018 Caendra Inc. - Hera For Ptpv5 - Linux Exploitation (Remote Exploitation & Post-Exploitation)© 2018 Caendra Inc. - Hera For Ptpv5 - Linux Exploitation (Remote Exploitation & Post-Exploitation)
- 3PAR Storage Multi-Path (Hyperactive) + RHEL7.2 + ORACLE 11G-RAC Environme NT Construction Notes3PAR Storage Multi-Path (Hyperactive) + RHEL7.2 + ORACLE 11G-RAC Environme NT Construction Notes
- SMcli and Script Commands Quick Reference For SANtricity Ver 9.25 ES1790-0-E1SMcli and Script Commands Quick Reference For SANtricity Ver 9.25 ES1790-0-E1
- Dell EMC VxRail - VCF On VxRail - How To Re-Generate TLS Certificate For VxRail Manager - Dell USDell EMC VxRail - VCF On VxRail - How To Re-Generate TLS Certificate For VxRail Manager - Dell US
- Windows Unified Host Utilities 7.0: Installation GuideWindows Unified Host Utilities 7.0: Installation Guide
- Use Tivoli Storage Manager To Back Up and Recover A DB2 DatabaseUse Tivoli Storage Manager To Back Up and Recover A DB2 Database
- HPOS SP12.1 Install and Config Guide Hpos41sp121incenUSHPOS SP12.1 Install and Config Guide Hpos41sp121incenUS
- HPE 4400 Enterprise Virtual Array - Controller Enclosure - Battery Replacement InstructionsHPE 4400 Enterprise Virtual Array - Controller Enclosure - Battery Replacement Instructions
- 8 Linux Parted' Commands To Create, Resize and Rescue Disk Partitions8 Linux Parted' Commands To Create, Resize and Rescue Disk Partitions
- IBM Spectrum Scale Basic Administration For Linux - H005G: Course DetailsIBM Spectrum Scale Basic Administration For Linux - H005G: Course Details
- Implementing DR Solutions With IBM Storwize V7000 and VMware Site Recovery ManagerImplementing DR Solutions With IBM Storwize V7000 and VMware Site Recovery Manager
- Protecting Business-Critical Applications in A Vmware Infrastructure 3 Environment Using Veritas™ Cluster Server For Vmware EsxProtecting Business-Critical Applications in A Vmware Infrastructure 3 Environment Using Veritas™ Cluster Server For Vmware Esx
- CiscoMDS FabricSwitchConfigurationGuideAndCommandLineCiscoMDS FabricSwitchConfigurationGuideAndCommandLine
- The Architecture of SAP ERP: Understand how successful software worksFrom EverandThe Architecture of SAP ERP: Understand how successful software works
- Deep Security 12.0 On-Premise Administration Guide PDFDeep Security 12.0 On-Premise Administration Guide PDF
- Deep Security 12.0 On-Premise Administration GuideDeep Security 12.0 On-Premise Administration Guide
- Deep Security 10.3 On-Premise Administration GuideDeep Security 10.3 On-Premise Administration Guide
- Accelerating Successful Business Transformations With SAP MaxAttentionAccelerating Successful Business Transformations With SAP MaxAttention
- Setting Up A Self-Hosted GitHub Action Runner For Python Applications On EC2 InstanceSetting Up A Self-Hosted GitHub Action Runner For Python Applications On EC2 Instance
- IBM WebSphere Cast Iron Introduction and Technical OverviewIBM WebSphere Cast Iron Introduction and Technical Overview
- Unit 5: Setting Up SAP Ariba and SAP S-4HANA ConnectivityUnit 5: Setting Up SAP Ariba and SAP S-4HANA Connectivity
- IDP - Employee Central Payroll Migrating From ERP HCM Payroll To Employee Central Payroll V1.7.1IDP - Employee Central Payroll Migrating From ERP HCM Payroll To Employee Central Payroll V1.7.1
- Replication Use Cases: Delphix Engine Deployed in The Public CloudReplication Use Cases: Delphix Engine Deployed in The Public Cloud
- Performance Engineering The Loadrunner Family Brochure enPerformance Engineering The Loadrunner Family Brochure en
- Saas Management: The Definitive Guide For It and Finance LeadersSaas Management: The Definitive Guide For It and Finance Leaders
- Tips and Tricks For Sizing Your SAP S4HANA System and Landscape SiTips and Tricks For Sizing Your SAP S4HANA System and Landscape Si
- Critical Capabilities For Enterprise Architecture Tools: Key FindingsCritical Capabilities For Enterprise Architecture Tools: Key Findings
- Oracle Cloud Infrastructure Powers Cloud-Connected EnterprisesOracle Cloud Infrastructure Powers Cloud-Connected Enterprises