WCG Help
WCG Help
v8.1.x
©1996–2015, Websense Inc.
All rights reserved.
10900 Stonelake Blvd, 3rd Floor, Austin, TX 78759, USA
Websense Content Gateway Online Help
October 2015
R050914800
This document contains proprietary and confidential information of Yahoo, Inc and Websense, Inc. The contents of this document may not be
disclosed to third parties, copied, or duplicated in any form, in whole or in part, without prior written permission of Websense, Inc.
Every effort has been made to ensure the accuracy of this manual. However, Websense Inc., and Yahoo, Inc. make no warranties with respect to
this documentation and disclaim any implied warranties of merchantability and fitness for a particular purpose. Websense Inc. shall not be liable
for any error or for incidental or consequential damages in connection with the furnishing, performance, or use of this manual or the examples
herein. The information in this documentation is subject to change without notice.
Use, duplication, or disclosure of the technical data contained in this document by the Government is subject to restrictions as set forth in subdivision
(c) (1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 52.227-7013 and/or in similar or successor clauses in the FAR,
or in the DOD or NASA FAR Supplement. Unpublished rights reserved under the Copyright Laws of the United States. Contractor/manufacturer
is Websense, Inc, 10900 Stonelake Blvd, 3rd Floor, Austin, TX 78759, USA.
Trademarks
Websense, the Websense Logo, ThreatSeeker, and TRITON are registered trademarks of Websense, Inc. in the United States and/or other countries.
Websense has numerous other unregistered trademarks in the United States and internationally. All other trademarks are the property of their
respective owners.
Portions of Websense Content Gateway include third-party technology used under license. Notices and attribution are included elsewhere in this
manual
Traffic Server is a trademark or registered trademark of Yahoo! Inc. in the United States and other countries.
Red Hat is a registered trademark of Red Hat Software, Inc.
Linux is a registered trademark of Linus Torvalds.
Microsoft, Windows, Windows NT, and Active Directory are either registered trademarks or trademarks of Microsoft Corporation in the United
States and/or other countries.
Mozilla and Firefox are registered trademarks of the Mozilla Foundation.
Netscape and Netscape Navigator are registered trademarks of Netscape Communications Corporation in the United States and in other countries.
UNIX is a registered trademark of AT&T.
All other trademarks are property of their respective owners.
Contents
Contents
Topic 1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Deployment options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
SSL inspection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
As a Web proxy cache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
In a cache hierarchy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
In a managed cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
As a DNS proxy cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Cache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
RAM cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Adaptive Redirection Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Host database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
DNS resolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Administration tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Proxy traffic analysis features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Online Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Topic 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Accessing the Content Gateway manager . . . . . . . . . . . . . . . . . . . . . . . 11
Configuring Content Gateway for two-factor authentication . . . . . . 13
Accessing the Content Gateway manager if you forget the master administrator
password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Entering your subscription key. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Providing system information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Verifying that the proxy is processing Internet requests . . . . . . . . . . . . 18
Using the command-line interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Starting and stopping Content Gateway on the Command Line . . . . . . 19
The no_cop file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Topic 3 Web Proxy Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Cache requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Ensuring cached object freshness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
HTTP object freshness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
FTP object freshness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Scheduling updates to local cache content . . . . . . . . . . . . . . . . . . . . . . . 27
Configuring the Scheduled Update option . . . . . . . . . . . . . . . . . . . . 28
Forcing an immediate update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Pinning content in the cache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Online Help i
Contents
Online Help v
Contents
Node . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
Graphs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Alarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272
Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 277
Integrated Windows Authentication . . . . . . . . . . . . . . . . . . . . . . . . 278
LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
Legacy NTLM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 280
SOCKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Web DLP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281
Subsystems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 282
Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
Networking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
ARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
ICAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
WCCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
DNS Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
DNS Resolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 288
Virtual IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Client Connection Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289
SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
SSL Key Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
CRL Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
Appendix B Commands and Variables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 295
Websense Content Gateway commands. . . . . . . . . . . . . . . . . . . . . . . . 295
Websense Content Gateway variables . . . . . . . . . . . . . . . . . . . . . . . . . 297
Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
Appendix C Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
My Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301
Basic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302
Subscription. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
UI Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Snapshots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311
Logs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
Protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
HTTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
HTTP Responses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 324
HTTP Scheduled Update. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 325
HTTPS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 327
FTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 328
Content Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329
Hierarchies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 330
Mapping and Redirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 332
Browser Auto-Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 334
Connection Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
FIPS Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335
Web DLP. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 336
Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337
SOCKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353
Subsystems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Cache. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 356
Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358
Networking . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
Connection Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 362
ARM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
WCCP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
DNS Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374
DNS Resolver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 375
ICAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378
Virtual IP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379
Health Check URLs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382
Appendix D Event Logging Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Custom logging fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383
Logging format cross-reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Squid logging formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Netscape Common logging formats . . . . . . . . . . . . . . . . . . . . . . . . 387
Netscape Extended logging formats . . . . . . . . . . . . . . . . . . . . . . . . 388
Netscape Extended-2 logging formats . . . . . . . . . . . . . . . . . . . . . . 388
Appendix E Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
Specifying URL regular expressions (url_regex). . . . . . . . . . . . . . . . . 392
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
auth_domains.config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 393
auth_rules.config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 395
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 396
[Link] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Dynamic deny bypass rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 398
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
[Link] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 399
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 400
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401
[Link] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 402
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 404
[Link] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 406
ip_allow.config. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 407
[Link] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
log_hosts.config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 408
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
logs_xml.config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
WELF (WebTrends Enhanced Log Format). . . . . . . . . . . . . . . . . . 417
mgmt_allow.config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
[Link]. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 418
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 420
[Link] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
[Link] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 422
Online Help ix
Contents
Online Help xi
Contents
Online Help 1
Overview
Ensure that clients are authenticated before they access content. Content Gateway
supports Integrated Windows Authentication, legacy NTLM (NTLMSSP), LDAP,
and RADIUS. See, Content Gateway user authentication, page 191.
Control client access to the proxy. See, Controlling client access to the proxy, page
177.
Use different DNS servers, depending on whether the proxy needs to resolve host
names located inside or outside a firewall. This enables you to keep your internal
network configuration secure while providing transparent access to external sites
on the Internet. See, Using the Split DNS option, page 190.
Use the co-located Data policy engine or the ICAP interface to enable sites using
TRITON AP-DATA to examine outbound material such as Web postings, and
block or allow based on company policy. See Working With Web DLP, page 129.
Control access to the Content Gateway manager using:
SSL (Secure Sockets Layer) protection for encrypted, authenticated access
User accounts that define which users can access the manager and which
activities they can perform (for example, view statistics only or view statistics
and configure Content Gateway).
Integrate into your firewall and control traffic through a SOCKS server.
See Security, page 177.
Related topics:
Deployment options, page 2
Components, page 4
Proxy traffic analysis features, page 7
Online Help, page 8
Technical Support, page 8
Deployment options
SSL inspection
When the HTTPS option is enabled, HTTPS traffic is decrypted, inspected, and
re-encrypted as it travels to and from the client and origin server.
Note
Content Gateway does not cache HTTPS content.
Important
Even when HTTPS is not enabled, Content Gateway
performs HTTPS URL filtering. This means that for every
HTTPS request, a URL lookup is performed and policy is
applied.
In explicit proxy mode, when HTTPS is disabled, Content
Gateway performs URL filtering based on the hostname in
the request. If the site is blocked, Content Gateway serves
a block page. Note that some browsers do not support
display of the block page. To disable this feature, configure
clients to not send HTTPS requests to the proxy.
In transparent proxy mode, when HTTPS is disabled, if
there is an SNI in the request, Content Gateway gets the
hostname from the SNI and performs URL filtering based
on the hostname. Otherwise, Content Gateway uses the
Common Name in the certificate of the destination server.
However, if the Common Name contains a wildcard (*),
the lookup is performed on the destination IP address. If
the site is blocked, the connection with the client is
dropped; no block page is served. To disable this feature
when used with WCCP, do not create a service group for
HTTPS.
Online Help 3
Overview
In a cache hierarchy
Websense Content Gateway can participate in flexible cache hierarchies, where
Internet requests not fulfilled in one cache can be routed to other regional caches,
taking advantage of their contents and proximity. In a hierarchy of proxy servers,
Content Gateway can act either as a parent or child, either to other Content Gateway
servers or to other caching products. See Hierarchical Caching, page 95.
In a managed cluster
Websense Content Gateway scales from a single node to multiple nodes, with a
maximum recommended limit of 16. This forms a managed cluster that improves
system capacity, performance, and reliability.
A managed cluster detects the addition and removal of nodes.
Cluster nodes automatically share configuration information, allowing members
of the cluster to all be administered at the same time.
If the virtual IP failover option is enabled, Content Gateway maintains a pool of
virtual IP addresses that it assigns to the nodes of the cluster. Content Gateway can
detect node failures (such as power supply or CPU failures) and reassign IP addresses
of the failed node to the operational nodes. See Virtual IP failover, page 91, for
details.
If Content Gateway is configured as a transparent proxy with WCCP, failover is
handled by WCCP and virtual IP failover should not be used. See WCCP load
distribution, page 53.
For complete information, see Clusters, page 85.
Components
Cache
The cache consists of a high-speed object database called the object store. The object
store indexes objects according to URLs and associated headers. The object store can
cache alternate versions of the same object, varying on spoken language or encoding
type, and can store small and large documents, minimizing wasted space. When the
cache is full, the proxy removes stale data, ensuring that frequently requested objects
are fresh.
Content Gateway tolerates disk failure on any cache disk. If the disk fails completely,
Content Gateway marks the disk as corrupt and continues using the remaining disks. If
all cache disks fail, Content Gateway goes into proxy-only mode.
You can partition the cache to reserve disk space for storing data for specific protocols
and origin servers. See Configuring the Cache, page 99.
RAM cache
Content Gateway maintains a small RAM memory cache of extremely popular
objects. This RAM cache serves the most popular objects quickly and reduces load on
disks, especially during traffic peaks. You can configure the RAM cache size. See
Changing the size of the RAM cache, page 104.
Host database
The host database stores the Domain Name Server (DNS) entries of origin servers to
which the proxy connects. Among other information, the host database tracks:
DNS information (for fast conversion of host names to IP addresses)
The HTTP version of each host (so advanced protocol features can be used with
hosts running modern servers)
Online Help 5
Overview
Host reliability and availability information (to avoid waits for non-functional
servers)
DNS resolver
For transparent proxy deployments, the proxy includes an asynchronous DNS resolver
to streamline conversion of host names to IP addresses. Content Gateway implements
the DNS resolver natively, directly issuing DNS command packets, rather than relying
on resolver libraries. Many DNS queries can be issued in parallel and a fast DNS
cache maintains popular bindings in memory, reducing DNS traffic.
Important
Should the Linux system DNS server configuration change
(/etc/[Link]), you must restart Content Gateway.
Processes
Administration tools
The primary Content Gateway configuration and administration tool is the web-based
graphical user interface that is accessible through your browser. The Content Gateway
manager offers password-protected, SSL-encrypted, single-point administration for an
entire Content Gateway cluster. The Content Gateway manager provides graphs and
statistical displays for monitoring Content Gateway performance and network traffic,
and options for configuring and fine-tuning the proxy.
Sometimes it is convenient or necessary to use the Content Gateway command-line
interface. You can execute individual commands or script a series of commands in a
shell. This method is only partially available when Content Gateway is installed on a
Websense appliance. Use the Content Gateway manager and the Appliance manager
Command Line Utility instead.
Like the command line interface, it is sometimes convenient or necessary to make
configuration changes in Content Gateway configuration files. They support
administration through a file-editing and signal-handling interface. Any changes you
make through the Content Gateway manager or command-line interface are
automatically made to the configuration files.
See:
Content Gateway manager, page 111
Command-line interface, page 112
Configuration files, page 113
Content Gateway provides options for network traffic analysis and monitoring:
Manager statistics and graphs show network traffic information. View graphs and
statistics from the Content Gateway manager, or collect and process statistics
using the command-line interface.
A variety of Performance graphs show historical information about virtual
memory usage, client connections, document hit rates, and so on. View
Performance graphs in the Content Gateway manager.
Manager alarms are presented in the Content Gateway manager. Content
Gateway signals an alarm for any detected failure condition. You can configure
Content Gateway to send email or page support personnel when an alarm occurs.
Content Gateway also sends select alarms to the Web module of the TRITON
Manager, where they are referred to as alerts. Summary alert messages are
displayed on the Web > Status > Today page. The full alert message is displayed
Online Help 7
Overview
Online Help
Click on Get Help! on any page in the Content Gateway manager to get detailed
information about using the product.
Important
Default Microsoft Internet Explorer settings may block
operation of the Help system. If a security alert appears,
select Allow Blocked Content to display Help.
If your organization’s security standards permit, you can
permanently disable the warning message on the
Advanced tab of the Tools > Internet Options interface.
(Check Allow active content to run in files on My
Computer under Security options.)
To access a PDF version of online help, or to access Release Notes, installation and
deployment information, FAQs, tips, and other technical information, go to the
Websense Technical Library.
Technical Support
Online Help 9
Overview
After you have installed Content Gateway on your system or all of the nodes in your
cluster, the proxy is ready for use.
Refer to the following procedures to get started:
Accessing the Content Gateway manager, page 11
Entering your subscription key, page 16
Verifying that the proxy is processing Internet requests, page 18
Using the command-line interface, page 18
Starting and stopping Content Gateway on the Command Line, page 19
The web browser-based Content Gateway manager is the management console for
Content Gateway.
The Content Gateway manager is supported on:
Microsoft Internet Explorer 8, 9, 10, and 11
Mozilla Firefox versions 5 and later
Google Chrome 13 and later; use of Chrome with some extensions (add-ons) may
result in unexpected behavior
Use of other browsers and versions may result in unexpected behavior.
Java and JavaScript must be enabled in your browser. See your browser
documentation for information on enabling Java and JavaScript.
There are 3 ways to access the Content Gateway manager:
From the Content Gateway button in the TRITON Manager.* For configuring
access from the Web module of the TRITON Manager, see the Administrator Help
for the Web module. (Not available with AP-DATA Web Content Gateway)
Online Help 11
Getting Started
By entering the IP address and port of the Content Gateway host system in your
browser. See below.
When Content Gateway is a module on a Websense appliance, by opening the
appliance Logon portal and clicking the Content Gateway button.
*When two-factor authentication (certificate or RSA SecurID) is configured in the
TRITON Manager, the only way to access the Content Gateway manager is through
the Web module of the TRITON Manager. See Configuring Content Gateway for two-
factor authentication, page 13.
Note
When single sign-on (not available with AP-DATA Web
Content Gateway) is used, the browser must be configured
to allow pop-ups on the Content Gateway IP address.
permanently accept the certificate within the browser. See your browser
documentation for details.
Note
If you are using Internet Explorer, the certificate error will
still be present after you accept the certificate. You must
close and reopen your browser to remove the error
message.
Windows 7 considerations
If you are using Windows 7, you may need to run the browser as administrator for it to
allow ActiveX controls.
1. Right-click the browser application and select Run as administrator.
2. Log on to the Content Gateway manager and accept the security certificate as
described above.
Online Help 13
Getting Started
Important
If Content Gateway is installed on a Websense appliance,
see Appliance Manager Help for details.
Note
The following procedure applies to Content Gateway
standalone (software) installations.
If Content Gateway is running on a Websense appliance,
the password is reset on the Administration > Account
Management page of the Appliance manager.
Note
Ensure that there are no trailing spaces after the word
NULL.
Online Help 15
Getting Started
Uppercase character
Lowercase character
Number
Special character
Supported characters include:
! #%&'()*+,- ./;<=>?@[ ]^_ {|}~
The following special characters are not supported:
Space $ : ` \ "
8. Click Apply.
The next time you access the Content Gateway manager, you must use the new
password.
Related topic:
Providing system information, page 17
When Content Gateway is deployed with TRITON AP-WEB, there is no need to enter
a subscription key in the Content Gateway manager. The TRITON AP-WEB key is
automatically shared with Content Gateway.
Note
The Web module instance that is used is determined by the
Policy Server that is configured. The configured Policy
Server IP address is shown in the Content Gateway
manager on the Monitor > My Proxy > Summary page
when the More Details view is selected.
To configure Policy Server:
In the V-Series manager go to Configuration >
Web Components.
On a software install, edit /opt/WCG/[Link]
and set the value of PolicyServerIP. Then stop and
start Content Gateway processes:
/opt/WCG/WCGAdmin stop
/opt/WCG/WCGAdmin start
When Content Gateway is deployed with only TRITON AP-DATA, you will need to
enter your subscription key manually.
1. Go to the Configure > My Proxy > Subscription > Subscription Management
page of the Content Gateway manager.
2. Enter your key in the field provided.
3. Click Apply.
4. Click Restart on the Configure > My Proxy > Basic > General page.
Online Help 17
Getting Started
5. Click Apply.
After you have installed the proxy, verify that it is processing requests for Web
content.
1. Open the Content Gateway manager. See Accessing the Content Gateway
manager, page 11.
2. Go to the Monitor > My Proxy > Summary page to view subscription detail,
scanning data file status, and node details, including the number of objects served,
the hit rate, and other basic proxy service information.
3. Navigate to Monitor > Protocol > HTTP > General to display the General
HTTP Statistics table.
4. Note the current Total Document Bytes statistic in the Client section of the table.
The command-line interface provides a quick way to view proxy statistics and
configure Content Gateway if you do not have access to a browser or if you prefer to
use a UNIX shell-like command interface.
Note
The command-line interface is not available when Content
Gateway is installed on a Websense appliance. Use the
Content Gateway manager and the V-Series or X-Series
manager Command Line Utility instead.
You can execute individual commands or script multiple commands in a shell. See
Websense Content Gateway commands, page 295.
1. Become root:
su
2. Change to the Content Gateway bin directory (/opt/WCG/bin). Run Content
Gateway commands from this directory.
Commands take the form:
content_line -command argument
3. For a list of content_line commands, enter:
content_line -h
Note
If the Content Gateway bin directory is not in your path,
prepend the command with: ./
For example:
./content_line -h
Online Help 19
Getting Started
./WCGAdmin stop
After you have installed Content Gateway, open the Content Gateway manager (the
management interface) to verify that the proxy is running. See Accessing the Content
Gateway manager, page 11 and Verifying that the proxy is processing Internet
requests, page 18.
Web proxy caching stores copies of frequently accessed Web objects (such as
documents, images, and articles) close to users and serves this information to them.
Internet users get their information faster, and Internet bandwidth is freed for other
tasks.
Internet users direct their requests to Web servers all over the Internet. For a caching
server to serve these requests, it must act as a Web proxy server. A Web proxy server
receives user requests for Web objects and either serves the requests or forwards them
to the origin server (the Web server that contains the original copy of the requested
information).
Content Gateway supports both transparent proxy deployment, in which the user’s
client software (typically a browser) is unaware that it is communicating with a proxy,
and explicit proxy deployment, in which the user’s client software is configured to
send requests directly to the proxy.
Cache requests
Related topics:
Ensuring cached object freshness, page 22
Scheduling updates to local cache content, page 27
Pinning content in the cache, page 29
To cache or not to cache?, page 30
Caching HTTP objects, page 30
Forcing object caching, page 36
Caching HTTP alternates, page 36
Caching FTP objects, page 37
The following overview illustrates how Content Gateway serves a user request.
1. Content Gateway receives a user request for a Web object.
Online Help 21
Web Proxy Caching
2. Using the Web address, the proxy tries to locate the requested object in its object
store (cache).
3. If the object is in the cache, the proxy checks to see if the object is fresh enough to
serve (see Ensuring cached object freshness, page 22). If the object is fresh, the
proxy serves it to the user as a cache hit.
4. If the data in the cache is stale, the proxy connects to the origin server and asks if
the object is still fresh (a revalidation). If the object is still fresh, the proxy sends
the cached copy to the user.
5. If the object is not in the cache (a cache miss) or the server indicates that the
cached copy is no longer valid, the proxy obtains the object from the origin server,
simultaneously streaming it to the user and the cache. Subsequent requests for the
object will be served faster because the object will come directly from the cache.
Content Gateway can store and serve Java applets, JavaScript programs,
VBScripts, and other executable objects from its cache according to the freshness and
cacheability rules for HTTP objects. Content Gateway does not execute the applets,
scripts, or programs. These objects run only when the client system that sent the
request loads them.
Content Gateway does not store partial documents in the cache. Should a client
disconnect while an HTTP or FTP download is underway, Content Gateway continues
the download for up to 10 seconds after the disconnect. If the transfer completes
successfully, Content Gateway stores the object in the cache. If the download does not
complete, Content Gateway disconnects from the origin server and deletes the object
from the cache.
When Content Gateway receives a request for a Web object, it tries to locate the
requested object in its cache. If the object is in the cache, the proxy checks to see if the
object is fresh enough to serve.
The protocol determines how the proxy handles object freshness in the cache:
HTTP objects support author-specified expiration dates. The proxy adheres to
these expiration dates; otherwise, it picks an expiration date based on how
frequently the object is changing and on administrator-chosen freshness
guidelines. In addition, objects can be revalidated, checking with the origin server
if an object is still fresh. See HTTP object freshness, page 22.
FTP objects stay in the cache for a specified time period. See FTP object
freshness, page 26.
Content Gateway determines whether an HTTP object in the cache is fresh by:
Checking the Expires or max-age header
Some HTTP objects contain Expires headers or max-age headers that define how
long the object can be cached. Comparing the current time with the expiration
time tells the proxy whether or not the object is fresh.
Checking the Last-Modified / Date headers
If an HTTP object has no Expires header or max-age header, the proxy can
calculate a freshness limit using the following formula:
freshness_limit =(date - last_modified) * 0.10
where date is the date in the object’s server response header, and last_
modified is the date in the Last-Modified header. If there is no Last-Modified
header, the proxy uses the date that the object was written to cache. You can
increase or reduce the value 0.10 (10 percent). See Modifying the aging factor for
freshness computations, page 23.
The computed freshness limit is bound by minimum and maximum boundaries.
See Setting an absolute freshness limit, page 24.
Checking the absolute freshness limit
For HTTP objects that do not have Expires headers or do not have both Last-
Modified and Date headers, the proxy uses a maximum and minimum freshness
limit. See Setting an absolute freshness limit, page 24.
Checking revalidate rules in the [Link] file
Revalidate rules apply freshness limits to specific HTTP objects. You can set
freshness limits for objects originating from particular domains or IP addresses,
objects with URLs that contain specified regular expressions, and objects
requested by particular clients, for example. See [Link], page 399.
If an object does not contain any expiration information, Content Gateway can
estimate its freshness from the Last-Modified and Date headers. By default, the
proxy stores an object for 10% of the time that elapsed since it last changed. You can
increase or reduce the percentage.
1. Open the [Link] file located in the Content Gateway config directory.
2. Edit the following variable:
Variable Description
[Link]. Specify the aging factor for freshness
heuristic_lm_factor computations.
The default value is 0.10 (10 percent).
Online Help 23
Web Proxy Caching
4. To apply the changes, run the following command from the Content Gateway bin
directory:
content_line -x
Some objects do not have Expires headers or do not have both Last-Modified and
Date headers. You can control how long these objects are considered fresh in the
cache by specifying an absolute freshness limit. A longer lifetime means objects are
kept in the cache longer. Performance can improve if pages are taken from the cache
rather than going out to the network.
1. Navigate to the Configure > Protocols > HTTP > Cacheability tab.
2. In the Minimum Heuristic Lifetime area of the Freshness section, specify the
minimum amount of time that HTTP objects without an expiration date can
remain fresh in the cache before being considered stale. The default value is
3600 seconds (1 hour).
3. In the Maximum Heuristic Lifetime field, specify the maximum amount of time
that HTTP objects without an expiration date can remain fresh in the cache before
being considered stale. The default value is 86400 seconds (1 day).
4. Click Apply.
To ensure freshness of the objects in the cache, configure Content Gateway to cache
only objects with specific headers.
Warning
By default, the proxy caches all objects (including objects
with no headers). Websense recommends that you change
the default setting only for specialized proxy situations. If
you configure the proxy to cache only HTTP objects with
Expires or max-age headers, the cache hit rate will be
seriously reduced (very few objects have explicit
expiration information).
1. Navigate to the Configure > Protocols > HTTP > Cacheability tab.
2. In the Required Headers area of the Behavior section, select one of the
following:
An Explicit Lifetime Header to cache only HTTP objects with Expires or
Cache-Control headers.
A Last-Modified Header to cache only HTTP objects with Expires or Last-
Modified headers.
No Required Headers to cache all HTTP objects (no specific headers are
required). This is the default.
3. Click Apply.
Cache-Control headers
Help | Content Gateway | Version 8.1.x
Even though an object might be fresh in the cache, clients or servers might have
constraints that prevent them from retrieving the object from the cache. For example,
a client might request that a object not come from a cache, or if it does, it cannot have
been cached for more than 10 minutes.
Content Gateway bases the servability of a cached object on Cache-Control headers.
Cache-Control headers can appear in both client requests and server responses.
The following Cache-Control headers affect whether objects are served from the
cache:
The no-cache header, sent by clients, tells the proxy to serve no objects directly
from the cache; always obtain the object from the origin server. You can configure
the proxy to ignore client no-cache headers (see Configuring the proxy to ignore
client no-cache headers, page 31).
The max-age header, sent by servers, is compared to the object age; if the age is
less than max-age, the object is fresh and can be served.
The min-fresh header, sent by clients, is an acceptable freshness tolerance. The
client wants the object to be at least this fresh. If a cached object does not remain
fresh at least this long in the future, it is revalidated.
The max-stale header, sent by clients, permits the proxy to serve stale objects
provided they are not too old. Some browsers might be willing to take slightly old
objects in exchange for improved performance, especially during periods of poor
Internet availability.
The proxy applies Cache-Control servability criteria after HTTP freshness criteria.
For example, an object might be considered fresh, but if its age is greater than its max-
age, it is not served.
When a client requests an HTTP object that is stale in the cache, Content Gateway
revalidates the object, querying the origin server to check if the object is unchanged.
Revalidation results in one of the following:
If the object is still fresh, the proxy resets its freshness limit and serves the object.
If a new copy of the object is available, the proxy caches the new object, replacing
the stale copy, and serves the object to the user simultaneously.
If the object no longer exists on the origin server, the proxy does not serve the
cached copy.
Online Help 25
Web Proxy Caching
If the origin server does not respond to the revalidation query, the proxy does not
perform any validation; it serves the stale object from the cache.
By default, the proxy revalidates a requested HTTP object in the cache if it considers
the object to be stale. The proxy evaluates object freshness as described in HTTP
object freshness, page 22. You can configure how often you want the proxy to
revalidate an HTTP object.
1. Navigate to the Configure > Protocols > HTTP > Cacheability tab.
2. In the When to Revalidate area of the Behavior section, select:
Never Revalidate to never verify the freshness of a requested HTTP object
with the origin server.
Always Revalidate to always verify the freshness of a requested HTTP object
with the origin server.
Revalidate if Heuristic Expiration to verify the freshness of a requested
HTTP object with the origin server if the object contains no Expires or
Cache-Control headers. Content Gateway considers all HTTP objects
without Expires or Cache-Control headers to be stale.
Use Cache Directive or Heuristic to verify the freshness of a requested
HTTP object with the origin server when Content Gateway considers the
object in the cache to be stale. This is the default.
3. Click Apply.
Note
You can also set specific revalidation rules in the
[Link] file. See [Link], page 399.
FTP objects carry no time stamp or date information and remain fresh in the cache for
the period of time you specify (from 15 minutes to 2 weeks), after which they are
considered stale.
FTP objects can be requested from either an HTTP client (such as a browser) or an
FTP client (such as WS_FTP). Content Gateway caches only the FTP objects
requested from HTTP clients.
Note
In addition to setting an absolute freshness limit for all
FTP objects requested by HTTP clients, you can set
freshness rules for specific FTP objects in the
[Link] file (see [Link], page 399).
To further increase performance and to ensure that HTTP and FTP objects (requested
from HTTP clients) are fresh in the cache, you can use the Scheduled Update option to
configure the proxy to load specific objects into the cache at scheduled times.
To use the Scheduled Update option:
Specify the list of URLs that contain the objects you want to schedule for update,
the time the update should take place, and the recursion depth for the URL.
Enable the Scheduled Update option and configure optional retry settings.
See Configuring the Scheduled Update option, page 28 for more information.
Content Gateway uses the information you specify to determine the URLs for which it
is responsible and, for each URL, derives all recursive URLs if applicable. It then
generates a unique URL list. Using this list, the proxy initiates an HTTP GET for each
unaccessed URL, ensuring that it remains within the user-defined limits for HTTP
concurrency at any given time.
Note
The system logs the completion of all HTTP GET
operations, enabling you to monitor the performance of
this feature.
The Force Immediate Update option that enables you to update URLs without waiting
for the specified update time to occur. You can use this option to test your scheduled
Online Help 27
Web Proxy Caching
The Force Immediate Update option lets you verify the URLs listed in the
[Link] file immediately. This option disregards the offset hour and interval set
in the [Link] file and updates the URLs listed.
Important
When you enable the Force Immediate Update option, the
proxy continually updates the URLs specified in the
[Link] file until you disable the option.
1. Navigate to Configure > Protocols > HTTP Scheduled Update > General.
2. Ensure that Scheduled Update is enabled.
3. Click the Update URLs tab.
4. Enable Force Immediate Update.
5. Click Apply.
The cache pinning option configures Content Gateway to keep certain HTTP objects
(and FTP objects requested from HTTP clients) in the cache for a specified time. Use
this option to ensure that the most popular objects are in the cache when needed and
that the proxy does not delete important objects from the cache.
Note
The proxy observes Cache-Control headers and pins an
object in the cache only if it is cacheable.
Online Help 29
Web Proxy Caching
When Content Gateway receives a request for a Web object that is not in the cache, it
retrieves the object from the origin server and serves it to the client. At the same time,
the proxy checks if the object is cacheable before storing it in its cache to serve future
requests.
Content Gateway determines if an object is cacheable based on protocol:
For HTTP objects, the proxy responds to caching directives from clients and
origin servers. In addition, you can configure the proxy not to cache certain
objects. See Caching HTTP objects, page 30.
For FTP objects, the proxy responds to caching directives you specify through
configuration options and files. See Caching FTP objects, page 37.
Content Gateway responds to caching directives from clients and origin servers, as
well as directives you specify through configuration options and files.
This section discusses the following topics:
Client directives, page 31
Origin server directives, page 32
Client directives
Help | Content Gateway | Version 8.1.x
By default, Content Gateway does not cache objects with the following request
headers:
Cache-Control: no-store
Cache-Control: no-cache
Note
You can configure the proxy to ignore the Cache-Control:
no-cache header. See Configuring the proxy to ignore
client no-cache headers, page 31.
Note
FTP objects requested from HTTP clients can also contain
Cache-Control: no-store, Cache-Control: no-cache, or
Authorization headers. If an FTP object requested from
an HTTP client contains such a header, the proxy does not
cache it unless explicitly configured to do so.
Online Help 31
Web Proxy Caching
You can configure the proxy to ignore client no-cache directives. In this case, the
proxy ignores no-cache headers from client requests and serves the object from its
cache.
Important
The default behavior of observing no-cache directives is
appropriate in most cases. Configure Content Gateway to
ignore client no-cache directives only if you are
knowledgeable about HTTP 1.1.
Note
Certain versions of Microsoft Internet Explorer do not
request cache reloads from transparent caches when the
user presses the browser Refresh button. This can prevent
content from being loaded directly from the origin server.
You can configure Content Gateway to treat Microsoft
Internet Explorer requests more conservatively, providing
fresher content at the cost of serving fewer documents
from the cache. You can configure the proxy to add no-
cache headers to requests from Microsoft Internet
Explorer in the Content Gateway manager (in the
Behavior section of the Configure > Protocols >
HTTP > Cacheability tab).
By default, Content Gateway does not cache objects with the following response
headers:
Cache-Control: no-store
Cache-Control: private
WWW-Authenticate:
Note
You can configure the proxy to ignore WWW-
Authenticate headers. See Configuring the proxy to
ignore WWW-Authenticate headers, page 34.
Set-Cookie:
Cache-Control: no-cache
Note
You can configure the proxy to ignore no-cache headers.
See Configuring the proxy to ignore server no-cache
headers, page 33.
Important
If you configure the proxy to ignore no-cache headers, it
also ignores no-store headers.
Important
The default behavior of observing no-cache directives is
appropriate in most cases. Configure the proxy to ignore
origin server no-cache headers only if you are
knowledgeable about HTTP 1.1.
You can configure the proxy to ignore origin server no-cache headers.
1. Open the [Link] file located in the Content Gateway config directory.
2. Edit the following variable:
Variable Description
[Link].ignore_server_no_ Set to 1 to ignore
cache server directives
to bypass the
cache.
Online Help 33
Web Proxy Caching
Important
The default behavior of not caching objects with
WWW-Authenticate headers is appropriate in most
cases. Configure the proxy to ignore server
WWW-Authenticate headers only if you are
knowledgeable about HTTP 1.1.
You can configure the proxy to ignore origin server WWW-Authenticate headers, in
which case, objects with WWW-Authenticate headers are stored in the cache for
future requests.
1. Open the [Link] file located in the Content Gateway config directory.
2. Edit the following variable:
Variable Description
[Link].ignore_ Set to 1 to cache objects with
authentication WWW-Authenticate headers.
Configuration directives
Help | Content Gateway | Version 8.1.x
Observe never-cache rules in the [Link] file. See [Link], page 399.
By default, Content Gateway caches all HTTP objects except those for which you
have set never cache rules in the [Link] file. You can disable HTTP object
caching so that all HTTP objects are served from the origin server and never cached.
1. Navigate to Configure > Protocols > HTTP > Cacheability.
2. Disable HTTP Caching.
3. Click Apply.
Warning
It is recommended that you configure the proxy to cache
dynamic content for specialized proxy situations only.
Online Help 35
Web Proxy Caching
Select Cache Any Content Type to cache cookied content of all types.
Select No Cache on Cookies to not cache cookied content of any type.
3. Click Apply.
You can force Content Gateway to cache specific URLs (including dynamic URLs)
for a specified duration regardless of Cache-Control response headers.
1. Navigate to Configure > Protocols > HTTP > Cacheability.
2. Click Edit File at the end of the page to display the configuration file editor for
the [Link] file.
3. In the fields provided, supply the following information:
From the Rule Type drop-down box, select ttl-in-cache.
From the Primary Destination Type drop-down box, select url_regex.
In the Primary Destination Value field, specify the URL you want to force
cache.
In the Time Period field, specify the amount of time that the proxy can serve
the URL from the cache.
In addition, you can add secondary specifiers (such as Prefix and Suffix) to
the rule. All the fields are described in HTTP, page 314.
4. Click Add, and then click Apply.
5. Click Close.
Some origin servers answer requests to the same URL with a variety of objects. The
content of these objects can vary, according to whether a server delivers content for
different languages, targets different browsers with different presentation styles, or
provides different document formats (HTML, PDF). Different versions of the same
object are termed alternates and are cached by Content Gateway based on Vary
response headers.
2. In the Vary Based on Content Type section, click Enabled to cache alternate
versions of HTTP documents that do not contain the Vary header.
3. Specify additional request and response headers for the proxy server to identify:
In the Vary by Default on Text field, enter the HTTP header field on which
you want to vary if the request is for text (for example, an HTML document).
In the Vary by Default on Images field, enter the HTTP header field on
which you want to vary if the request is for images (for example, a .gif file).
In the Vary by Default on Other Document Types field, enter the HTTP
header field on which you want to vary if the request is for anything other
than text or images.
Note
If you specify Cookie as the header field on which to vary
in the above fields, make sure that the appropriate option is
enabled in the Caching Response to Cookies area of the
Dynamic Caching section. For example, if you enable the
Cache Only Image Types option in the Caching
Response to Cookies area and you enable the Vary by
Default on Text option in the Vary Based on Content
Type section, alternates by cookie will not apply to text.
4. Click Apply.
Note
Large numbers of alternates can affect proxy performance
because all alternates have the same URL. Although
Content Gateway can look up the URL in the index very
quickly, it must scan sequentially through available
alternates in the object store.
Online Help 37
Web Proxy Caching
FTP objects can be requested from either an HTTP client (such as a browser) or an
FTP client (such as WS_FTP).
For FTP objects requested from HTTP clients (FTP over HTTP), perform the
following configuration to determine what the proxy stores in the cache:
Disable FTP over HTTP caching so that the proxy does not cache any FTP objects
requested from HTTP clients (see Disabling FTP over HTTP caching, page 38).
Set never cache rules in the [Link] file (see [Link], page 399).
Configure the proxy to ignore client Cache-Control: no-store or
Cache-Control: no-cache headers (see Configuring the proxy to ignore client no-
cache headers, page 31).
Caching is not supported for FTP objects requested from FTP clients.
You can configure Content Gateway not to cache any FTP objects that are requested
from HTTP clients by disabling the FTP over HTTP option. The proxy processes the
requests by forwarding them to the FTP server but does not cache any requested
objects.
1. Navigate to Configure > Protocols > HTTP > Cacheability.
2. In the Caching section, disable FTP over HTTP Caching.
3. Click Apply.
If Internet requests are not transparently routed to Content Gateway via a Layer 4
switch or router (see Transparent Proxy and ARM, page 47), traffic must be explicitly
routed to Content Gateway by configuring the client’s Internet browser. (This is
sometimes referred to as an explicit proxy deployment.)
Clients can configure their Web browsers in 1 of 3 ways:
By directly configuring their browsers to send requests directly to the proxy. See
Manual browser configuration, page 39.
By configuring their browsers to download proxy configuration instructions from
a PAC (Proxy Auto-Config) file. See Using a PAC file, page 40.
By using WPAD (Web Proxy Auto-Discovery Protocol) to download proxy
configuration instructions from a WPAD server (Microsoft Internet Explorer
only). See Using WPAD, page 42.
In addition, if Content Gateway is configured to proxy FTP traffic, FTP client
applications, such as FileZilla or WS_FTP, must be configured to explicitly send
requests to the proxy. See Configuring FTP clients in an explicit proxy environment,
page 43.
To configure a browser to send requests to Content Gateway, clients must provide the
following information for each protocol they want the proxy to serve to their
browsers:
Online Help 39
Explicit Proxy
Important
If Integrated Windows Authentication is configured for
user authentication, the Fully Qualified Domain Name
must be used. Specifying the IP address will result in
authentication failure. See Integrated Windows
Authentication, page 199.
The proxy server port. The Content Gateway default proxy server port is 8080.
Important
Do not set up the IP address of the Content Gateway proxy
to be a virtual IP address.
Although the Content Gateway manager does not prohibit
the entry of a virtual IP address, the proxy does not
function properly if a VIP is used.
In addition, clients can specify not to use the proxy for certain sites. Requests to the
listed sites go directly to the origin server.
For Microsoft Internet Explorer version 7.0 and greater, proxy configuration settings
are in Tools > Internet Options > Connections > LAN Settings. By default,
Microsoft Internet Explorer sets all protocols to the same proxy server. To configure
each protocol separately, click Advanced in the LAN Settings section. See the
browser documentation for complete proxy configuration instructions.
For Mozilla Firefox 4.0 and later, proxy configuration settings are in Tools >
Options > Advanced > Network > Settings > Connection Settings > Manual
Proxy Configuration. By default, you must configure each protocol separately.
However, you can set all protocols to the same proxy server by selecting Use this
proxy server for all protocols.
You do not have to set configuration options on the proxy to accept requests from
manually configured browsers.
A PAC file is a JavaScript function definition that a browser calls to determine how
requests are handled. Clients must specify in their browser settings the URL from
which the PAC file is loaded.
You can store a PAC file on the proxy and provide the URL for this file to your clients.
If you have a [Link] file, copy it into the Content Gateway config directory.
Note
The PAC file can reside on any server in your network.
Small networks may store the file on the proxy itself, but
large, enterprise-class networks should use a separate
server for storing the PAC file.
If the HTTPS protocol option is enabled, see Running in
explicit proxy mode, page 143, for information on a PAC
file to use with HTTPS traffic.
1. If you have an existing [Link] file, replace the [Link] file located in the
Content Gateway config directory with your existing file.
2. Navigate to the Configure > Content Routing > Browser Auto-Config > PAC
tab.
3. In the Auto-Configuration Port field, specify the port that Content Gateway uses
to serve the PAC file. The default port is 8083.
4. The PAC Settings area displays the [Link] file:
If you copied an existing PAC file into the Content Gateway config directory,
the [Link] file contains your proxy configuration settings. Check the
settings and make changes if necessary.
If you did not copy an existing PAC file into the Content Gateway config
directory, the PAC Settings area is empty. Enter the script that provides the
proxy server configuration settings. A sample script is provided in Sample
PAC file, page 41. See, also, the article titled “PAC File Best Practices” in the
Websense Technical Library.
5. Click Apply.
6. Click Restart on Configure > My Proxy > Basic > General.
7. Inform your users to set their browsers to point to this PAC file.
For example, if the PAC file is located on the proxy server with the hostname
proxy1 and Content Gateway uses the default port 8083 to serve the file, users
must specify the following URL in the proxy configuration settings:
[Link]
The procedures for specifying the PAC file location vary among browsers. For
example, for Microsoft Internet Explorer, you set the location of the PAC file in the
Use automatic configuration script field under Tools > Internet Options >
Connections > LAN Settings. For Mozilla Firefox, proxy configuration settings are
in Tools > Options > Advanced > Network > Settings > Connection Settings >
Automatic proxy configuration URL. See the documentation for your browser for
details.
Online Help 41
Explicit Proxy
The following sample PAC file instructs browsers to connect directly to all hosts
without a fully qualified domain name and to all hosts in the local domain. All other
requests go to the proxy server called [Link].
function FindProxyForURL(url, host)
{
if (isPlainHostName(host) || dnsDomainIs(host,
".[Link]"))
return "DIRECT";
else
return "PROXY [Link]; DIRECT";
}
Using WPAD
WPAD allows Internet Explorer version 7 and later to automatically detect a server
that will supply it with proxy server configuration settings. Clients do not have to
configure their browsers to send requests to a proxy server: a single server provides
the settings to all clients on the network.
Note
WPAD is incompatible with transparent proxy
deployments.
When an Internet Explorer version 7 or later browser starts up, it searches for a WPAD
server that will supply it with proxy server configuration settings. It prepends the
hostname WPAD to the current fully qualified domain name. For example, a client in
[Link] searches for a WPAD server at [Link]. If
unsuccessful, the browser removes the bottommost domain and tries again; for
example, it tries [Link]. The browser stops searching when it detects a
WPAD server or reaches the third-level domain, [Link]. The algorithm
stops at the third level so that the browser does not search outside the current network.
Note
By default, Microsoft Internet Explorer version 7 and later
are set to automatically detect WPAD servers. However,
browser users can disable this setting.
1. If you have an existing [Link] file, replace the [Link] file located in the
Content Gateway config directory with your existing file.
2. Log on to the Content Gateway manager and go to Configure > Content
Routing > Browser Auto-Config > WPAD to display the [Link] file.
3. The WPAD Settings area displays the [Link] file:
If you copied an existing [Link] file into the Content Gateway config
directory, the file contains your proxy configuration settings. Check the
settings and make changes if necessary.
If you did not copy an existing [Link] file into the Content Gateway config
directory (/opt/WCG/config), the WPAD Settings area is empty. Enter a script
that will provide the proxy server configuration settings. A sample script is
provided in Sample PAC file, page 41 (a [Link] file can contain the same
script as a [Link] file).
4. Click Apply.
5. Navigate to Configure > Networking > ARM.
6. In the Network Address Translation (NAT) section, click Edit File to add a
special remap rule to the [Link] file.
7. Enter information in the fields provided, and then click Add:
In the Ethernet Interface field, enter the network interface that receives
browser WPAD requests (for example hme0 or eth0).
From the Connection Type drop-down list, select tcp.
In the Destination IP field, enter the IP address of the Content Gateway
server that will be resolved to the WPAD server name by the local name
servers.
In the Destination CIDR field (optional), enter the CIDR mask value. If the
Destination IP is in IPv4 format, enter 32. Enter 128 for an IPv6 Destination
IP.
In the Destination Port field, enter 80.
In the Redirected Destination IP field enter the same IP address you entered
in the Destination IP field.
In the Redirected Destination Port field, enter 8083.
In the User Protocol field (optional), select dns.
8. Click Add.
9. Use the arrow keys on the left side to move the new rule to the first line in the file.
10. Click Apply, and then click Close.
11. Click Restart on the Configure > My Proxy > Basic > General.
Online Help 43
Explicit Proxy
When Content Gateway is configured to proxy FTP traffic (see FTP, page 328), FTP
client applications, such as FileZilla or WS_FTP, should be configured to send FTP
requests to the proxy. When so configured, the user works with the FTP client
application as if no proxy were present.
To connect to an FTP server, 4 pieces of information are usually needed. These pieces
of information are mapped as follows:
From: To:
FTP server hostname FTP proxy hostname
FTP server port number FTP proxy port number (default is 2121)
FTP server username FTP_server_username@FTP_server_hostname
For example: anon@[Link]
FTP server password FTP server password
Some FTP client applications have a configuration page for specifying FTP proxy
information. Update those settings to point to the Content Gateway FTP proxy. See
your FTP client application documentation.
Here is an example configuration using a recent version of FileZilla.
Username: anon
Password: 123abc
If the FTP client application is not configured, the user must enter FTP requests as
shown below.
Host: Content Gateway proxy hostname
Username: anon@[Link]
Password: 123abc
Port: 2121
Online Help 45
Explicit Proxy
The transparent proxy option enables Content Gateway to respond to client Internet
requests without requiring users to reconfigure their browsers. It does this by
redirecting the request flow to the proxy after the traffic has been intercepted,
typically by a Layer 4 (L4) switch or router.
In a transparent proxy deployment:
1. The proxy intercepts client requests to origin servers via a switch or router. See
Transparent interception strategies, page 49.
2. The Adaptive Redirection Module (ARM) changes the destination IP address of
an incoming packet to the proxy’s IP address and the destination port to the proxy
port, if different. (The ARM is always enabled.)
3. The proxy receives and begins processing the intercepted client requests. If a
request is a cache hit, the proxy serves the requested object. If a request is a miss,
the proxy retrieves the object from the origin server and serves it to the client.
4. On the way back to the client, the ARM changes the source IP address to the
origin server IP address and the source port to the origin server port.
Important
For transparent proxy configurations with multiple
interfaces or gateways, Content Gateway must have proper
routes to clients and the Internet in the operating system’s
routing table.
For HTTP, the proxy can identify problem clients and servers, and the ARM can
disable interception for those clients and servers, passing their traffic directly to the
origin server. You can also create ARM static bypass rules to exempt clients and
Online Help 47
Transparent Proxy and ARM
servers from being redirected to the proxy. See Interception bypass, page 70.
Related topics:
Transparent interception strategies, page 49
Interception bypass, page 70
Connection load shedding, page 73
Reducing DNS lookups, page 74
IP spoofing, page 77
Support for IPv6, page 82
The ARM
The Content Gateway ARM inspects incoming packets before the IP layer sees them
and readdresses the packets to Content Gateway for processing.
The ARM can make two changes to an incoming packet’s address. It can change its
destination IP address and its destination port. For example, the destination IP address
of an HTTP packet is readdressed to the IP address of the proxy and the destination
HTTP port is readdressed to the Content Gateway HTTP proxy port (usually port
8080).
On the way back to the client, the ARM changes the source IP address to the origin
server IP address and the source port to the origin server port.
The ARM component consists of several files and a kernel module, which are
installed during product installation. The installation program also creates redirection
rules to readdress packets using the IP address of the proxy machine and default port
assignments. The ARM is always active.
For the proxy to serve HTTP, HTTPS, FTP, or DNS requests transparently, you must
check the redirection rules in the [Link] file and edit them if necessary. If you are
using WCCP for transparent interception, there must be a redirection rule for every
port in every active service group. Rules for standard ports are included by default. To
view and work with ARM redirection rules, follow the these steps.
1. Log on to the Content Gateway manager and go to Configure > Networking >
ARM > General.
The Network Address Translation (NAT) section displays the redirection rules
in the [Link] file. Check the redirection rules and make any needed changes.
a. To change a redirection rule, click Edit File to open the configuration file
editor for the [Link] file.
b. Select the rule you want to edit and modify the appropriate fields. Click Set
and then click Apply to apply your changes. Click Close to exit the
configuration file editor.
All fields are described in ARM, page 364.
2. Click Restart on Configure > My Proxy > Basic > General.
Online Help 49
Transparent Proxy and ARM
Layer 4 switches can redirect supported protocols to the proxy, while passing all other
Internet traffic directly to its destination, as shown below for HTTP.
Layer 4 switches offer the following features, depending on the particular switch:
A Layer 4 switch that can sense downed hosts on the network and redirect traffic
adds reliability.
If a single Layer 4 switch feeds several proxy servers, the switch handles load
balancing among the Content Gateway nodes. Different switches might use
different load-balancing methods, such as round-robin or hashing. If a node
becomes unavailable, the switch redistributes the load. When the node returns to
service, some switches return the node to its previous workload, so that the node
cache need not be repopulated; this feature is called cache affinity.
Note
It is recommended that you do not enable Content
Gateway virtual IP failover when a switch is providing
load balancing in a cluster configuration.
Related topics:
WCCP load distribution, page 53
Configuring WCCP v2 routers, page 55
Enabling WCCP v2 in Content Gateway, page 60
ARM bypass and WCCP, page 53
Important
The network clients, Content Gateway proxy servers, and
destination Web servers (default gateway) must reside on
separate subnets.
Online Help 51
Transparent Proxy and ARM
4. The ARM readdresses the proxy port in the response header to port 80 (undoing
the readdressing it did on the way to the proxy). As a result, the user sees the
response as if it had been sent directly from the origin server.
If Content Gateway has an ARM bypass rule (discussed in Interception bypass, page
70), Content Gateway forwards particular client requests directly to the origin server,
bypassing the proxy.
Bypassed requests are unchanged by the ARM; they retain their client source IP
address.
With WCCP v2, you can exclude certain router interfaces from redirection. Content
Gateway ARM bypass rules work only if you exclude the router interface that
Content Gateway is connected to from WCCP redirection. You do this on the
router by selecting the interface connected to Content Gateway and issuing the router
configuration command ip wccp redirect exclude in. This causes the router to
exclude traffic inbound on the specified interface from all redirection rules.
The WCCP protocol provides the assignment method for dynamic symmetric and
asymmetric load distribution in a cluster. WCCP detects node failures and performs
redistribution based on the configuration communicated to it by Content Gateway.
Online Help 53
Transparent Proxy and ARM
Important
MASK was developed specifically for the Cisco Catalyst
series switches, and is one of the key characteristics that
enable WCCP interception to be performed completely in
hardware on these platforms. It should be used only with
devices for which there is documented support.
Important
Weight is only useful if the Synchronize in the Cluster
option is disabled. See Configuring service groups in the
Content Gateway manager, page 61.
The weight value is unique to each service group and node. The weight value does not
propagate around the cluster and must be set individually on every node in the cluster.
The value of weight, relative to the settings on other cluster members, determines the
proportion of traffic that WCCP directs to the node.
By default, weight is set to 0, which results in equal distribution to all cluster
members.
To achieve asymmetric distribution, weight is set relative to other members of the
cluster. For example, assume a cluster of 3 nodes:
If Node1 goes offline, Node2 and Node3 will get an equal amount of traffic. If Node3
goes offline, Node1 will get two thirds of the traffic and Node2 will get one third of
the traffic.
Because the weight value is relative to the settings on other cluster nodes, the same
distribution as above can be achieved with weight values of 10, 5, 5. (The valid range
of weight is 0-255.)
If weight is changed from its default value of 0, it should be configured on all nodes in
the cluster.
Online Help 55
Transparent Proxy and ARM
1. Configure one or more service groups for the protocols you intend to use. A
service group can handle one or multiple protocols. See Configuring service
groups on the WCCP device, page 56.
2. Configure the router to enable WCCP processing for these service groups. See
Enabling WCCP processing for a service group, page 57.
3. Optionally, enable router security. Router security must also be enabled for the
service group in Content Gateway. See Enabling WCCP v2 security on the router,
page 59.
Note
For instructions on configuring your specific router, please
refer to the documentation provided by your hardware
vendor. For Cisco routers, see [Link]
cisco/web/psa/[Link]?mode=prod and search for
your IOS and device version, for example, IOS 12.4.
4. When you are done configuring the router, you must also configure and enable
WCCP in the Content Gateway manager. See Enabling WCCP in the Content
Gateway manager, page 61.
WCCP uses service groups to specify the traffic that is redirected to Content Gateway
(and other devices).
A service group can intercept:
one or more protocols
on one or more ports
Service groups are assigned a unique integer identifier (ID) from 0 to 255.
Service groups IDs are user defined; they do not have a default port or traffic type.
The following table illustrates a set of service group definitions that are often found in
networks. If you are configuring for IP spoofing, see the table in IP spoofing, page 77,
for common reverse service groups IDs.
Follow the instructions in your router documentation for specifics, but in general:
1. To see what has been configured on the router for WCCP, enter:
show running-config | include wccp
2. To enable WCCP v2, enter:
ip wccp version 2
3. If you used another proxy cache with your router prior to Content Gateway,
disable the service ID that was previously used. For example, if you have a Cisco
router, disable the service ID web-cache by issuing this command:
no ip wccp web-cache
4. Specify the service group IDs you will use with Content Gateway. For the specific
commands to use, see your router documentation.
You must configure each service group supported by the router individually. You
cannot configure a router globally.
For each WCCP v2 service group that you configure, you must enable WCCP
processing.
WCCP v2 routers contain multiple network interfaces, including:
one or more interfaces that receive inbound (ingress) client traffic
one or more interfaces connected to Content Gateway
an interface dedicated to outbound (egress) traffic that is aimed at the Internet
Following are some guidelines for enabling WCCP processing for a service group on
a router. Consult the procedures in your router documentation for specifics.
Online Help 57
Transparent Proxy and ARM
Note
Where your hardware and network topology support it, it
is recommended that redirection be performed on the
ingress interface (using the “redirect in” commands).
The following are examples. Be sure to substitute the service group IDs that you
have established on your router(s).
First, select the interface to configure:
interface <type> <number>
Second, establish your redirection rules:
ip wccp <service group ID> redirect in
Examples for inbound redirection:
Run these commands for each protocol that you want to support, but only on the
interface(s) dedicated to inbound (ingress) traffic.
For example, to turn on redirection of HTTP destination port traffic, enter:
ip wccp 0 redirect in
To turn on redirection of HTTPS destination port traffic:
ip wccp 70 redirect in
To turn on redirection of FTP destination port traffic enter:
ip wccp 5 redirect in
To turn on redirection of HTTP source port traffic, which is required for IP
spoofing, enter:
ip wccp 20 redirect in
Examples for outbound (egress) redirection:
Run these commands for each protocol that you want to support, but only on the
interface(s) dedicated to outbound (egress) traffic.
First, select the interface to configure:
interface <type> <number>
Second, establish your redirection rules:
ip wccp <service group ID> redirect out
For example, to turn on redirection for HTTP, enter:
ip wccp 0 redirect out
To turn on redirection for HTTPS:
ip wccp 70 redirect out
To turn on redirection for FTP enter:
ip wccp 5 redirect out
If you need to disable WCCP processing for any reason, issue this command to turn
off the WCCP feature:
no ip wccp <service group ID> password [0-7] <passwd>
If you are running WCCP v2, you can enable security on the Content Gateway node so
that the proxy and your routers can authenticate each other. You must individually
enable security for each service group that the router supports. You cannot configure a
router globally as you would Content Gateway.
Online Help 59
Transparent Proxy and ARM
You enable the security option and provide the authentication password in the Content
Gateway manager.
The authentication password you specify must match the authentication password
configured on the router for each service group being intercepted. The following
procedure provides an example of how to set an authentication password for different
service groups.
1. Telnet to the router and switch to Enable mode.
2. At the prompt, enter the following command to configure the router from the
terminal:
configure terminal
3. If you defined a password when you enabled WCCP on the router, skip to step 4.
Otherwise, enter the following command for each service group that the router
intercepts:
hostname(config)# ip wccp service_group password password
where hostname is the host name of the router you are configuring, service_group
is the service group ID (for example, 0 for HTTP), and password is the password
you want to use to authenticate Content Gateway. This password must match the
password you specify in the Content Gateway configuration for this service
group.
Related topics:
Configuring WCCP v2 routers, page 55
Configuring service groups on the WCCP device
Enabling WCCP processing for a service group
Enabling WCCP v2 security on the router, page 59
After you have configured your WCCP v2 routers, these steps remain:
1. Enabling WCCP in the Content Gateway manager
2. Configuring service groups in the Content Gateway manager
Important
Before you restart Content Gateway, make sure that your
configuration meets the following requirements:
Cisco IOS devices are running a very recent version of
IOS with all appropriate patches applied.
WCCP routers are programmed with the correct
service groups and other features.
Every WCCP service group that redirects traffic to a Content Gateway proxy must
have a corresponding service group defined for it in the Content Gateway server or
cluster.
To define service groups, go to Configure > Networking > WCCP.
a. The Service Groups table displays the list of configured service groups and a
subset of their configuration settings.
Entries are stored in the [Link] file.
The Refresh button rereads [Link], refreshing the table.
To add, modify, delete, or reorder service groups, click Edit File.
b. Synchronize in the Cluster: If Content Gateway is configured in a cluster,
enable (default) or disable the Synchronize in the Cluster option. (The value
of this option is always synchronized in the cluster.)
When this option is enabled, the WCCP configuration (stored in [Link])
is synchronized in the cluster and configuration changes can be made on any
node in the cluster.
When this option is disabled, the WCCP configuration is not synchronized in
the cluster and changes to the WCCP configuration must be made
individually on each node. A common use case for this is to control which
service groups are enabled/disabled on each node, and/or to use proportional
load distribution using weight.
If after being disabled this option is enabled, the configuration on the node on
which the administrator enables the option is used to initially synchronize the
cluster.
Online Help 61
Transparent Proxy and ARM
Caution: When Synchronize in the Cluster is disabled, you must visit each
node in the cluster to examine and maintain your WCCP configuration. This
can also make WCCP troubleshooting more difficult.
Important
Every port in the service group must have a corresponding
ARM NAT rule to redirect the traffic to Content Gateway.
See The ARM.
f. Network Interface: From the drop down list, select the network interface on
the Content Gateway host system that this service group will use.
3. Mode Negotiation
The Packet Forward Method determines how traffic is transmitted from the
WCCP router to the proxy.
The Packet Return Method specifies the method used to return traffic back to
the WCCP router.
Typically the router supports only one method.
Typically, the forward and return methods match.
a. If traffic is routed to the proxy by a Cisco ASA firewall, in the Special Device
Profile drop down box select ASA Firewall. When this option is selected,
GRE is automatically selected for both Packet Forward Method and Packet
Return Method. These settings cannot be changed.
Important
Selecting L2 requires that the router or switch be
Layer 2-adjacent (in the same subnet) as Content Gateway.
If GRE is selected, for each router in the service group a unique Content
Gateway tunnel endpoint IP address must be specified in the WCCP Routers
section (see the Router Information step, below).
Packet Return Method: Select L2 or GRE.
Important
GRE cannot be used with WCCP multicast mode.
Important
If you change the forward/return method configuration
while there is an active connection with the WCCP device,
in order to re-negotiated the method you must force the
current connection to terminate. Typically, this means
turning off the service group on the WCCP device for 60
seconds. See the documentation for your WCCP device.
4. Advanced Settings
a. Assignment Method: Specify the parameters used to distribute intercepted
traffic among multiple nodes in a cluster. For a description of the WCCP load
distribution feature, see WCCP load distribution, page 53.
HASH applies a hash operation to the selected distribution attributes.
• With HASH, more than one distribution attribute can be selected.
• The result of the hash operation determines the cluster member that
receives the traffic.
MASK applies a mask operation to the selected distribution attribute.
• Only one distribution attribute can be selected, typically the destination IP
address.
• The result of the mask operation determines the cluster member that
receives the traffic.
Online Help 63
Transparent Proxy and ARM
Important
When the value of weight is greater than 0 on any member
of the cluster, any member of the cluster with a weight of 0
receives no traffic. If you plan to use weight, be sure to set
a weight on every member of the cluster.
Note
Weight is only useful when Synchronize in the Cluster is
disabled.
For more information about load distribution, see WCCP load distribution,
page 53.
c. Reverse Service Group ID: For IP spoofing. Allows you to specify a reserve
service group ID.
When IP spoofing is enabled, you must define a reverse service group for
each HTTP and HTTPS forward service group.
Note
Only HTTP and HTTPS are supported for IP Spoofing.
Using the specified ID, Content Gateway creates a reverse service group that
is a mirror of the forward service group. For example, if the forward service
group has assignment method based on destination IP address, the reverse
service has an assignment method based on the source IP address.
Note
IP spoofing is not supported with service groups that use a
hashing assignment method with both destination and
source attributes. If IP spoofing is enabled on such a
service group, an alarm is raised and IP spoofing is
disabled.
5. Router Information
Note
It may take up to a minute for the router to report that a
new proxy server has joined a service group.
a. Security: To use optional WCCP authentication, select Enabled and enter the
same password used for service group authentication on the router. See
Enabling WCCP v2 security on the router, page 59.
b. Multicast: To run in multicast mode, select Enabled and enter the multicast
IP address. The multicast IP address must match the multicast IP address
specified on the router. See Transparent interception and multicast mode,
page 66.
Important
GRE packet Forward/Return method cannot be used with
multicast mode.
Online Help 65
Transparent Proxy and ARM
When GRE Packet Return Method is configured and Content Gateway does
not have a route back to the WCCP router, specify a GRE Tunnel Next Hop
Router IP Address. The IP address must be in IPv4 format.
You can use “ping” to test connectivity to the router.
• From Content Gateway, ping each router defined in the service group (in
the Router IP Address field).
• If ping doesn’t return a response, you need to define a GRE Tunnel Next
Hop to that router. Intervening routers must have a route to the WCCP
router, or a next hop.
Note
WCCP routers that have multiple interfaces assign the
Router ID to the interface with the highest numeric value
IP address. Content Gateway must be able to connect to
the router ID to negotiate the method. To ensure
connectivity and that the router ID doesn’t change
unexpectedly, it is a best practice to make the router
loopback address the highest IP address. This also ensures
that traffic and statistics reported on the Monitor >
Networking > WCCP page are reported against a known
router ID.
6. Click Add to add a new entry, or click Set to save changes to the selected entry.
7. Click Apply and then Close to close the editor. Navigating away from the page
before clicking Apply results in the loss of all changes.
8. Restart the proxy to cause the changes to take effect. Go to Configure >
My Proxy > Basic > General and click Restart.
Note
To check that the router is sending traffic to the proxy,
examine the statistics in the Content Gateway manager
Monitor pane. For example, check that the Objects
Served statistic in the My Proxy > Summary section
increases.
To configure Content Gateway to run in multicast mode, you must enable multicast
mode and specify the multicast IP address in the Content Gateway manager.
Important
GRE packet Forward/Return method cannot be used with
multicast mode.
In addition, you must set the multicast address on your routers for each service group
being intercepted (HTTP, FTP, DNS, and SOCKS). The following procedure provides
an example of how to set the multicast address for different service groups on a
WCCP v2-enabled router.
1. Telnet to the router and switch to Enable mode.
2. At the prompt, enter the following command to configure the router from the
terminal:
configure terminal
3. At the prompt, enter the following command for each service group that the router
intercepts:
hostname(config)# ip wccp service_group group-address
multicast_address
where hostname is the host name of the router you are configuring, service_group
is the service group ID (for example, 0 for HTTP), and multicast_address is the
IP multicast address.
4. At the prompt, enter the following command to configure the network interface:
interface interface_name
where interface_name is the network interface on the router that is being
intercepted and redirected.
5. At the prompt, enter the following command for each service group that the router
intercepts:
hostname(config-if)# ip wccp service_group group-listen
6. Exit and save the router configuration.
Instead of the WCCP protocol, you can use the policy routing capabilities of a router
to send traffic to Content Gateway. WCCP or a Layer 4 switch are generally
preferable to this configuration because policy-based routing has a performance
impact on the router, and policy-based routing does not support load balancing or
heartbeat messaging.
All client Internet traffic is sent to a router that feeds Content Gateway.
The router sends port 80 (HTTP) traffic to the proxy and sends the remaining
traffic to the next hop router.
The ARM translates intercepted requests into Content Gateway requests.
Translated requests are sent to the proxy.
Web objects to be served transparently are readdressed by the ARM on the return
path to the client, so that the documents appear to have come from the origin
server.
Online Help 67
Transparent Proxy and ARM
A Content Gateway cluster with virtual IP failover adds reliability; if one node fails,
another node can take up its transparency requests. See Virtual IP failover, page 91.
You can deploy Content Gateway without adding routers or switches by using routing
software on the Content Gateway node. In this case, Content Gateway is a software
router and directs all traffic through the proxy machine. This solution can be useful in
low-traffic situations, where the performance cost of using the proxy machine as a
router is not high.
On Linux systems, you can use the routed and gated daemons as a software-based
routing solution. The routed daemon is a bundled part of all normal Linux
distributions. The gated daemon is an extensible commercial software package from
the Merit GateD Consortium.
When you use routing software with Content Gateway:
All Internet traffic goes through Content Gateway from machines behind it in the
network.
The routing software routes all non-transparent requests to the Internet; it routes
port 80 HTTP requests to the proxy cache.
The ARM translates intercepted requests into proxy requests.
Translated requests are sent to the proxy.
Web objects to be served transparently are readdressed by the ARM on the return
path to the client, so that the objects appear to have come from the origin server.
Note
Although Content Gateway machines can function as
routers, they are not expressly designed to be routers. For
reliability, you can use a Content Gateway cluster with the
virtual IP failover option. If one node fails, another cluster
node takes over. See Virtual IP failover, page 91.) The
Content Gateway cluster failover mechanism is similar to
the Hot Standby Router Protocol (HSRP).
You can configure Content Gateway to serve only transparent requests and prevent
explicit proxy requests from being served in the following ways:
You can control client access to Content Gateway by specifying ranges of IP
addresses that are allowed to connect to the proxy. If Content Gateway receives a
request from an IP address not listed in a specified range, it discards the request.
See Controlling client access to the proxy, page 177.
If you do not know the ranges of client IP addresses allowed to access Content
Gateway, you can add rules to the [Link] file (Configure > Networking >
ARM > General) so that only requests that have been redirected by your Layer 4
switch or WCCP router reach the proxy port.
To make a transparent-only Content Gateway server, add rules in the [Link]
file before the normal redirect service rule to redirect explicit proxy traffic to a
port on which no service is listening. For example, if you want Content Gateway
to ignore explicit HTTP requests, add rules above the normal HTTP redirect rule
in the [Link] file as shown below (where ipaddress is the IP address of
your Content Gateway system and port_number is a port number on which no
service is listening):
rdr hme0 ipaddress port 80 -> ipaddress port port_number tcp
rdr hme0 ipaddress port 8080 -> ipaddress port port_number tcp
rdr hme0 [Link]/0 port 80 -> ipaddress port 8080 tcp
Add equivalent rules to the [Link] file for each protocol service port or
separate network interface to be served. After you make changes to the [Link]
file, you must restart the proxy.
If your Content Gateway system has multiple network interfaces or if you
configure the Content Gateway operating system to use virtual IP addresses, you
can give Content Gateway two IP addresses. One address must be the real address
that the proxy uses to communicate with origin servers and the other a private IP
address (for example [Link]) for WCCP or switch redirection. After you
configure the IP addresses, you must add the following variables to the end of the
[Link] file. Replace private_ipaddress with the private IP address used
Online Help 69
Transparent Proxy and ARM
for WCCP or switch redirection and real_ipaddress with the IP address the proxy
uses to communicate with origin servers.
LOCAL [Link].incoming_ip_to_bind STRING
private_ipaddress
LOCAL [Link].outgoing_ip_to_bind STRING
real_ipaddress
Interception bypass
A small number of clients and servers do not work correctly with Web proxies. Some
reasons include:
Client software irregularities (customized, non-commercial browsers).
Server software irregularities.
Applications that send non-HTTP traffic over HTTP ports as a way of defeating
security restrictions.
Server IP address authentication (the origin server limits access to a few client IP
addresses, but the Content Gateway IP address is different, so it cannot get
access). This is not in frequent use because many ISPs dynamically allocate client
IP dial-up addresses, and more secure cryptographic protocols are now more often
used.
Web proxies are very common in corporate and Internet use, so interoperability
problems are rare. However, Content Gateway contains an adaptive learning module
that recognizes interoperability problems caused by transparent proxy processing and
automatically bypasses the traffic around the proxy server without operator
intervention.
Content Gateway follows 2 types of bypass rules:
Dynamic (also called adaptive) bypass rules are generated dynamically if you
configure Content Gateway to bypass the cache when it detects non-HTTP traffic
on port 80 or when it encounters certain HTTP errors. See Dynamic bypass rules,
page 71.
Static bypass rules must be manually configured in the [Link] file. See
Static bypass rules, page 72.
Note
Do not confuse ARM bypass rules with client access
control lists. Bypass rules are created in response to
interoperability problems. Client access control is simply
restriction of the client IP addresses that can access the
proxy, as described in Controlling client access to the
proxy, page 177.
Related topics:
Setting dynamic bypass rules, page 72
Viewing dynamic bypass statistics, page 72
When configured to do so, the proxy watches for protocol interoperability errors. As it
detects errors, it configures the ARM to bypass the proxy for those clients and servers
causing the errors.
In this way, the small number of clients or servers that do not operate correctly
through proxies are auto-detected and routed around the proxy caching server so that
they can continue to function (but without caching).
You can configure the proxy to dynamically bypass itself for any of the following
errors:
Online Help 71
Transparent Proxy and ARM
prevent the proxy from bypassing itself. For information about setting dynamic deny
bypass rules, see [Link], page 397.
Content Gateway tallies bypassed requests for each type of dynamic bypass trigger.
For example, Content Gateway counts all requests that are bypassed in response to a
401 error.
Navigate to Monitor > Networking > ARM.
The statistics are displayed in the HTTP Bypass Statistics section of the table.
You can configure bypass rules to direct requests from certain clients or to particular
origin servers around the proxy. Unlike dynamic bypass rules that are purged when
you restart the proxy, these static bypass rules are saved in a configuration file.
You can configure 3 types of static bypass rules:
Source bypass, in which Content Gateway bypasses a particular source IP address
or range of IP addresses. For example, you can use this solution to bypass clients
who want to opt out of a caching solution.
Destination bypass, in which Content Gateway bypasses a particular destination
IP address or range of IP addresses. For example, these could be origin servers
that use IP authentication based on the client’s real IP address. Destination bypass
rules prevent Content Gateway from caching an entire site. You will experience
hit rate impacts if the site you bypass is popular.
Source/destination pair bypass, in which Content Gateway bypasses requests that
originate from the specified source to the specified destination. For example, you
The ARM has a supporting utility called print_bypass that allows you to view the
current dynamic and static bypass rules.
To view all current dynamic and static bypass rules:
1. Log on to a Content Gateway node and then change directory to the Content
Gateway bin directory (/opt/WCG/bin).
2. Enter the following command at the prompt and press Return:
./print_bypass
All current static and dynamic bypass rules are displayed on screen. The rules are
sorted by IP address. You can direct the output of print_bypass to a file and save
it.
The load shedding feature prevents client request overloads. When there are more
client connections than the specified limit, the ARM forwards incoming requests
directly to the origin server. The default client connection limit is 1 million
connections.
1. Navigate to Configure > Networking > Connection Management > Load
Shedding.
2. In the Maximum Connections field, specify the maximum number of client
connections allowed before the ARM starts forwarding requests directly to the
origin server.
3. Click Apply.
4. Click Restart on Configure > My Proxy > Basic > General.
Online Help 73
Transparent Proxy and ARM
If you are running Content Gateway in transparent proxy mode, you can enable the
Always Query Destination option to reduce the number of DNS lookups and
improve response time. When enabled, the Always Query Destination option
configures the proxy to always obtain the original destination IP address of incoming
requests from the ARM. Content Gateway then uses that IP address to determine the
origin server instead of doing a DNS lookup on the hostname of the request. Because
the client already performed a DNS lookup, Content Gateway does not have to.
When Always Query Destination is enabled, the value defined for the variable
[Link].use_hostname_for_wisp_and_reporting determines whether IP
address or hostname is captured for reporting purposes.
Important
It is recommended that you do not enable the Always
Query Destination option if Content Gateway is running in
both explicit and transparent proxy mode. In explicit proxy
mode, the client does not perform a DNS lookup on the
hostname of the origin server, so the proxy must perform a
DNS lookup.
Also, the category lookup is performed based on the IP
address, which is not always as accurate as a URL-based
lookup.
In addition, do not enable the Always Query Destination
option if you want domain names, rather than IP addresses,
in TRITON AP-WEB transaction logs.
Variable Description
[Link]. Set to 0 to disable the Always Query Destination
always_query_dest option. Domain names are captured.
Set to 1 to enable the Always Query Destination
option. IP addresses are captured; domain names
are not.
4. To apply the changes, run the following command from the Content Gateway bin
directory:
content_line -x
Online Help 75
Transparent Proxy and ARM
Explicit and transparent proxy deployments can be used with other optional features.
Related Topics:
IP spoofing, page 77
Support for IPv6, page 82
IP spoofing
Ordinarily, when Content Gateway proxies requests for clients it communicates with
origin servers using its own IP address in place of the client’s IP address. This is the
standard operation of forward proxies.
IP spoofing configures the proxy to use:
The IP address of the client when communicating with the origin server (basic IP
spoofing)
Or
A specified IP address when communicating with the origin server (Range-based
IP spoofing)
IP spoofing is sometimes used to support upstream activities that require the client IP
address or a specific IP address. It also results in origin servers seeing the client or
specified IP address instead of the proxy IP address (although the proxy IP address
can be a specified IP address; more below).
IP spoofing features and restrictions:
IP spoofing is supported for HTTP and HTTPS traffic only.
When IP spoofing is enabled, it is applied to both HTTP and HTTPS. It cannot be
configured for only one protocol.
HTTPS traffic is spoofed whether SSL support is enabled or not.
Online Help 77
Additional Proxy Configuration
Warning
Deploying IP spoofing requires precise control of the
routing paths on your network, overriding the normal
routing process for traffic running on TCP port 80 and
443. When configured with either transparent or
explicit proxy, return traffic must be routed back to the
proxy.
For assistance, please contact your network equipment
vendor or Websense Technical Support.
With IP spoofing enabled, traditional debugging tools such
as traceroute and ping have limited utility.
Important
For a discussion of how the proxy kernel routing table
impacts transparent proxy deployment, see the Solution
Center article titled, Web sites in the Static or Dynamic
bypass list fail to connect.
Range-based IP spoofing
Range-based IP spoofing supports groupings of clients (IP addresses and IP address
ranges) that are mapped to specified IP addresses.
Among other uses, range-based IP spoofing facilitates:
The delivery of web-hosted services when the identification is by source IP
address. For example, to receive a web-hosted service, an organization might be
required to identify membership to the service via a known IP address.
IP address-based authentication with an external service when a unique IP address
represents a group of users.
A way to configure traditional IP spoofing for some clients (source IP addresses
that don’t match any group are spoofed with their own IP address), range-based IP
spoofing for some clients, and standard proxy IP address substitution for some
clients. The latter is done by creating a group that specifies the proxy IP address.
Important
Range-based IP Spoofing is not supported on many older
versions of Cisco IOS firmware. To avoid problems,
update your Cisco device to the latest firmware.
IP Spoofing is supported for IPv6. However, range-based
IP Spoofing is not supported for IPv6.
Online Help 79
Additional Proxy Configuration
7. A proxy response to the client is generated and returned to the client on the proxy-
to-client TCP connection.
Note
When IP spoofing is enabled, the proxy advertises a
reverse service group for each enabled WCCP service. The
reverse service group must be applied along the return path
of the proxy.
WCCP service group IDs are user defined and must be programmed on the WCCP
device(s) and in Content Gateway (see Configuring service groups on the WCCP
device and Configuring service groups in the Content Gateway manager.
Following is a set of suggested definitions.
Policy-based routing (PBR) uses access control lists (ACL) to identify and redirect
flows. In a PBR deployment, all of the configuration is done on the router and there is
no corresponding Content Gateway configuration. PBR deployments have to redirect
traffic returning from origin servers from port 80 and 443 to Content Gateway.
Configuring IP spoofing
Basic IP spoofing
From Content Gateway manager:
1. Go to Configure > Networking > ARM > General.
2. Under IP Spoofing, select Enabled.
3. Click Apply.
4. Click Restart on Configure > My Proxy > Basic > General.
5. Configure your network to ensure Web traffic will be redirected back to the proxy.
Contact your network equipment vendor or Websense Technical Support for any
needed assistance.
Warning
The ARM is a critical component of Content Gateway that
should never be disabled. If it is disabled while IP spoofing
is enabled, client requests receive a “Cannot display Web
page” error and an error message is recorded in /var/log/
messages.
For information about configuring WCCP routers, see Configuring WCCP v2 routers,
page 55.
Range-based IP spoofing
Important
IP Spoofing is supported for IPv6. However, range-based
IP Spoofing is not supported for IPv6.
Client IP address ranges and their corresponding spoofed IP address are specified
in a table.
The table is traversed top-down. The first match is applied.
Requests from clients that do not match an IP address in the table are spoofed with
their own IP address (basic IP spoofing).
To create an entry that causes a set of IP addresses to appear to be coming from
the proxy (as in ordinary forward proxy request handling), specify the desired
client IP address range and then, in the Spoofed IP Address field, specify the
proxy’s Internet-facing IP address.
It is recommended that you create the smallest list that meets your needs. The list
is traversed for every connection request. A very large list could contribute to
latency. Use the performance charts (Monitor > Performance) to monitor proxy
performance.
To create the range-based IP spoofing table:
1. Go to Configure > Networking > ARM > General.
2. Under IP Spoofing, select Enabled. Basic IP spoofing must be enabled to enable
range-based IP spoofing.
3. Under Range Based IP Spoofing, select Enabled.
4. In the Client IP Addresses field, enter a comma separated list of individual IP
addresses and/or IP address ranges.
In a range, the first IP address is separated from last with a hyphen. For example:
[Link]-[Link]
CIDR notation is allowed. Do not use spaces.
The Client IP Address list supports a maximum of:
Online Help 81
Additional Proxy Configuration
64 IPv4 addresses
32 IPv4 address ranges
5. In the Specified IP Address field, enter a single IP address.
6. Click Apply to add the entry to the table.
Warning: If any of the formatting is invalid, all of the data in that row is cleared.
7. To add a new row to the table, click Add Row.
8. To put new entries into effect, click Apply and then restart Content Gateway.
9. Configure your network to ensure Web traffic will be redirected back to the proxy.
Contact your network equipment vendor or Websense Technical Support for any
needed assistance.
To remove an entry from the IP spoofing table:
1. Clear all the values in the row to be removed.
2. Click Apply.
3. To put the changes into effect, restart Content Gateway.
Important
In transparent proxy deployments, support requires WCCP
v2.01. If you use a Cisco router, it must be version 15.4(1)
or later.
Warning
When the operating system is Red Hat Enterprise Linux 6,
update 3, or CentOS 6, update 3, do not specify an IPv6
nameserver in /etc/[Link]. If an entry is included,
Content Gateway will reset every time it attempts to start.
If your deployment requires an IPv6 nameserver, upgrade
your operating system to Red Hat Enterprise Linux 6,
update 4, or CentOS 6, update 4.
Online Help 83
Additional Proxy Configuration
Related topics:
Changing clustering configuration, page 86
Adding nodes to a cluster, page 89
Deleting nodes from a cluster , page 91
Virtual IP failover, page 91
Websense Content Gateway scales from a single node to a cluster of 2 or more nodes,
with a maximum recommended limit of 16. This allows you to quickly increase
capacity and improve system performance and reliability.
Content Gateway detects the addition and deletion of nodes in the cluster and can
detect when a node is down.
You can add or delete a node from a cluster at any time.
When you remove a node from the cluster, Content Gateway removes all
references to the missing node.
Restarting a node in the cluster causes all nodes in the cluster to restart.
When the Virtual IP failover feature is enabled, the live nodes in a cluster can
assume a failed node’s traffic.
Nodes in a cluster automatically share configuration information.
Note
Filtering Service and Policy Service IP addresses are not
propagated around the cluster.
In transparent proxy deployments with WCCP, the service
group Enabled/Disabled state and Weight settings are not
propagated. See Transparent interception with WCCP v2
devices, page 50.
When SSL support is enabled, the Dynamic Incident List
is not propagated around the cluster.
Online Help 85
Clusters
Content Gateway uses a proprietary protocol for clustering, which is multicast for
node discovery and heartbeat, and unicast for all data exchange within the cluster.
Important
It is recommended that a dedicated network interface be
used for Content Gateway cluster communication, except
when the host is a V-Series appliance, in which case the P1
(eth0) interface is recommended.
Important
In a proxy hierarchy, the nodes in the cluster cannot be a
mixture of HTTP parents and children.
Management clustering
In management clustering mode you can administer all Content Gateway nodes at the
same time because cluster nodes share configuration information.
Note
The number of nodes in a cluster can be 2 or more.
For assistance with scaling your deployment, contact your
Websense account representative.
Clustering is usually configured when you install the proxy. You can, however,
configure clustering afterward, or at any time, in the Content Gateway manager.
1. In the Content Gateway manager, go to Configure > My Proxy > Basic >
Clustering.
2. In the Cluster Type area, select the clustering mode:
Select Management Clustering to include this proxy in a cluster.
Select Single Node if this node is not part of a cluster.
3. In the Interface area, enter the name of the network interface. This is the interface
used by Content Gateway to communicate with other nodes in the cluster, for
example: eth1.
It is recommended that you use a dedicated secondary interface.
Node configuration information is multicast, in plain text, to other Content
Gateway nodes on the same subnet. Therefore, Websense recommends that clients
be located on a separate subnet from Content Gateway nodes (multicast
communications for clustering are not routed).
On V-Series appliances, P1 (eth0) is the recommended interface. However, you
may also use P2 (eth1) if you want to isolate cluster management traffic.
Online Help 87
Clusters
4. In the Cluster Multicast Group Address area, enter the multicast group address
that all members of the cluster share. The default is [Link].
Warning
Ensure that the multicast IP address does not conflict with
the same address used by any other application or service.
If there is a conflict and the Content Gateway node is
allowed to restart, it will fail to initialize the interface and
the Content Gateway instance will shut down. You can
verify the condition by examining /var/log/messages and
looking for a message similar to:
[LocalManager::initCCom] Unable to find network
interface eth2.#011 Exiting
To correct the problem, identify a unique multicast IP
address that will work for all members of the cluster and:
If Content Gateway is on an appliance:
Log on to the appliance manager, go to
Administration > Toolbox, and open the Command
Line Utility.
Select the Websense Content Gateway Module and
then the command ‘content-line -s’.
Specify the Variable Name
[Link].mc_group_addr and give Value
the multicast IP address.
Check each member of the cluster to ensure that they
are all using the same multicast IP address.
Restart the node.
If Content Gateway is installed on a separate server:
Log on to the Linux host and go to /opt/WCG/config.
Edit (vi) [Link], find
[Link].mc_group_addr and assign it
the value of the multicast IP address.
Check each member of the cluster to ensure that they
are all using the same multicast IP address.
Restart the node.
5. Click Apply.
Important
Content Gateway does not apply the clustering mode
change to all of the nodes in the cluster. You must change
the clustering mode on each node individually.
Content Gateway detects new Content Gateway nodes on your network and adds them
to the cluster, propagating the latest configuration information to the newcomer. This
provides a convenient way to bootstrap new machines.
To connect a node to a Content Gateway cluster, you need only install Content
Gateway software on the new node, making sure during the process that the cluster
name and port assignments are the same as those of the existing cluster. In this way,
Content Gateway automatically recognizes the new node.
Important
The nodes in a cluster must be homogeneous; each node
must be on the same hardware platform, each must be on
the same operating system version, and Content Gateway
must be installed in the same directory (/opt/WCG).
Online Help 89
Clusters
3. Set Interface to the interface used by the cluster. All members must use the same
interface.
4. Set the Multicast Group Address to the address being used by the cluster.
5. In the Type area, select Management Clustering.
6. Click Apply.
7. Click Restart on Configure > My Proxy > Basic > General.
You can also add a node by editing variable values in the [Link] file of the
node to be added.
1. On the node you want to add to the cluster, open the [Link] file located in
/opt/WCG/config.
2. Edit the following variables:
Variable Description
[Link] Specify the clustering mode:
2 = management mode
3 = no clustering
[Link].proxy_name Specify the name of the Content
Gateway cluster. All nodes in a cluster
must use the same name.
[Link]. Specify the multicast address for
mc_group_addr cluster communications. All nodes in
a cluster must use the same multicast
address.
[Link] Specify the reliable service port. The
reliable service port is used to send
data between the nodes in the cluster.
All nodes in a cluster must use the
same reliable service port. The default
value is 8087.
[Link] Specify the multicast port. The
multicast port is used for node
identification. All nodes in a cluster
must use the same multicast port. The
default port is 8088.
[Link]. Specify the network interface for
ethernet_interface cluster traffic. All nodes in a cluster
must use the same network interface.
Virtual IP failover
Through the virtual IP failover feature, Content Gateway maintains a pool of virtual IP
addresses that it assigns to the nodes in the cluster as necessary. These addresses are
virtual only in the sense that they are not tied to a specific machine; Content Gateway
can assign them to any of its nodes. To the outside world, these virtual IP addresses
are the addresses of Content Gateway servers.
Virtual IP failover assures that if a node in the cluster fails, other nodes can assume the
failed node’s responsibilities. Content Gateway handles virtual IP failover in the
following ways:
The content_manager process maintains cluster communication. Nodes
automatically exchange statistics and configuration information through multicast
communication. If multicast heartbeats are not received from one of the cluster
nodes, the other nodes recognize it as unavailable.
The content_manager process reassigns the IP addresses of the failed node to the
remaining operational nodes within approximately 30 seconds, so that service can
continue without interruption.
The IP addresses are assigned to new network interfaces, and the new assignment
is broadcast to the local network. The IP address reassignment is done through a
process called ARP rebinding.
Online Help 91
Clusters
Related topics:
Enabling and disabling virtual IP addressing, page 92
Adding and editing virtual IP addresses, page 92
Virtual IP addresses are IP addresses that are not tethered to particular machines.
Thus, they can rotate among nodes in a Content Gateway cluster.
It is common for a single machine to represent multiple IP addresses on the same
subnet. This machine would have a primary or real IP address bound to its interface
card and also serve many more virtual addresses.
You can set up your user base to use a DNS round-robin pointing at virtual IP
addresses, as opposed to using the real IP addresses of the Content Gateway machines.
Because virtual IP addresses are not bound to machines, a Content Gateway cluster
can take addresses from inactive nodes and distribute those addresses among the
remaining live nodes.
Using a proprietary management protocol, Content Gateway nodes communicate their
status with their peers. If a node fails, its peers notice the failure and negotiate which
of the remaining nodes will mask the fault by taking over the failed node’s virtual
interface.
Virtual IP addresses must be pre-reserved, like all IP addresses, before they can be
assigned to Content Gateway.
Warning
Incorrect IP addressing can disable your system. Make
sure you understand how virtual IP addresses work before
changing them.
Note
The Virtual IP button is displayed only if you have enabled
the Virtual IP option in the Features table on Configure >
My Proxy > Basic > General.
Online Help 93
Clusters
Websense Content Gateway can participate in HTTP cache hierarchies, page 95, in
which requests not fulfilled in one cache can be routed to other regional caches, taking
advantage of the contents and proximity of nearby caches.
A cache hierarchy consists of levels of caches that communicate with each other.
Content Gateway supports several types of cache hierarchies. All cache hierarchies
recognize the concept of parent and child. A parent cache is a cache higher up in the
hierarchy, to which the proxy can forward requests. A child cache is a cache for which
the proxy is a parent.
In an HTTP cache hierarchy, if a Content Gateway node cannot find a requested object
in its cache, it can search a parent cache—which itself can search other caches—
before resorting to retrieving the object from the origin server.
You can configure a Content Gateway node to use one or more HTTP parent caches,
so that if one parent is unavailable, another parent can service requests. This is called
Administrator’s Guide 95
Hierarchical Caching
Note
If you do not want all requests to go to the parent cache,
you can configure the proxy to route certain requests
directly to the origin server (for example, requests that
contain specific URLs) by setting parent proxy rules in the
[Link] configuration file (described in
[Link], page 418).
Note
If the request is a cache miss on the parent, the parent
retrieves the content from the origin server (or from
another cache, depending on the parent’s configuration).
The parent caches the content and then sends a copy to the
proxy (its child), where it is cached and served to the
client.
Parent failover
Help | Content Gateway | Version 8.1.x
When you configure the proxy to use more than one parent cache, the proxy detects
when a parent is not available and sends missed requests to another parent cache. If
you specify more than two parent caches, the order in which the parent caches are
queried depends upon the parent proxy rules configured in the parent configuration
file described in [Link], page 418. By default, the parent caches are queried in
the order in which they are listed in the configuration file.
Important
Perform this procedure on the child proxy. Do not make
any changes on the parent.
Onlne Help 97
Hierarchical Caching
The cache consists of a high-speed object database called the object store. The object
store indexes objects according to URLs and associated headers, enabling Websense
Content Gateway to store, retrieve, and serve Web pages and parts of Web pages,
providing optimum bandwidth savings. Using object management, the object store
can cache alternate versions of the same object, varying on language or encoding type,
and can store small and large documents, minimizing wasted space. When the cache is
full, Content Gateway removes stale data.
Fault tolerance: Content Gateway can tolerate disk failures on cache disks. If a disk
drive fails five successive I/O operations, Content Gateway marks the disk as down,
removes the drive from the cache, and sends an alarm message to the Content
Gateway manager, indicating which disk failed. Normal cache operation continues on
the remaining cache disks. If all cache disks fail, Content Gateway goes into proxy-
only mode.
You can perform the following cache configuration tasks:
Change the total amount of disk space allocated to the cache. See Changing cache
capacity, page 100.
Partition the cache by reserving cache disk space for specific protocols and origin
servers and domains. See Partitioning the cache, page 102.
Specify a size limit for objects allows in the cache. See Configuring cache object
size limit, page 103
Delete all data in the cache. See Clearing the cache, page 104.
Change the size of the RAM cache. See Changing the size of the RAM cache, page
104.
RAM cache
Content Gateway maintains a small RAM cache of popular objects. This RAM cache
serves the most popular objects as fast as possible and reduces load on disks,
especially during temporary traffic peaks. You can configure the RAM cache size. See
Changing the size of the RAM cache, page 104.
Online Help 99
Configuring the Cache
The maximum aggregate disk cache size is limited to 147 GB. This size makes best
use of system resources, while also providing an excellent end-user experience.
The minimum disk cache size is 2 GB.
Related topics:
Querying cache size, page 100
Increasing cache capacity, page 100
Reducing cache capacity, page 101
To view the configured aggregate cache size, open the Content Gateway manager and
go to Monitor > Subsystems > Cache. The cache size is displayed, in bytes, in the
Current Value column of the Cache Size field.
Alternatively, display the cache size with the following command, executed from the
Content Gateway bin directory (/opt/WCG/bin).
content_line -r [Link].bytes_total
To increase the total disk space allocated to the cache on existing disks, or to add new
disks to a Content Gateway node:
1. Stop Content Gateway. See Starting and stopping Content Gateway on the
Command Line, page 19.
2. Add hardware, if necessary.
a. Set up the raw device and modify the permissions. For example:
mknod /etc/udev/devices/raw c 162 0
chmod 600 /etc/udev/devices/raw
b. Identify the physical device name and note the size in bytes (used later). For
example:
fdisk -l | grep "^Disk"
c. For each real disk, create a node, change the owner of the node, and map that
raw node to a physical disk. Note that the final argument increments by 1 for
each disk added.
To create a node:
mknod /etc/udev/devices/raw_c0d1 c 162 1
You can change the device name to the name that is returned from the fdisk -l
command in step b.
To change the owner:
chown Websense /etc/udev/devices/raw_c0d1
The owner is the installation user (default is Websense). Use the device name
used in the mknod statement.
To map the raw node to a physical disk:
/usr/bin/raw /etc/udev/devices/raw_c0d1 /dev/cciss/c0d1
Use the device name used in the mknod statement.
d. Add the same /usr/bin/raw commands to the /etc/init.d/content_gateway
file to make the changes effective on reboot. For example, at line 6 add:
...
case "$1" in
'start')
/usr/bin/raw /etc/udev/devices/raw_c0d1 /dev/cciss/c0d1
3. Edit the [Link] file in the Content Gateway config directory (/opt/WCG/
config) to increase the amount of disk space allocated to the cache on existing
disks or add the new disk devices. See [Link], page 494.
4. Restart Content Gateway.
You can reduce the total amount of disk space allocated to the cache on an existing
disk or remove disks from a Content Gateway node.
1. Stop Content Gateway.
2. Remove hardware, if necessary.
3. Edit the [Link] file to reduce the amount of disk space allocated to the
cache on existing disks or to delete the reference to the hardware you are
removing. See [Link], page 494.
4. If you remove a disk, you must edit the /etc/rc.d/init.d/content_gateway file to
remove the raw disk binding for the disk.
5. Restart Content Gateway.
Important
In the [Link] file, a formatted or raw disk must be
at least 2 GB.
You can manage your cache space more efficiently and restrict disk usage by creating
cache partitions of different sizes for specific protocols. You can further configure
these partitions to store data from specific origin servers and domains.
Important
The partition configuration must be the same on all nodes
in a cluster.
HTTP is the only protocol supported.
After you have configured your cache partitions based on protocol, you can make
changes to the configuration at any time. Before making changes, note the following:
You must stop Content Gateway before you change the cache partition size and
protocol assignment.
When you increase the size of a partition, the contents of the partition are not
deleted. However, when you reduce the size of a partition, the contents of the
partition are deleted.
When you change the partition number, the partition is deleted and then re-
created, even if the size and protocol type remain the same.
When you add new disks to your Content Gateway node, the partition sizes
specified in percentages increase proportionately.
A lot of changes to the partition sizes might result in disk fragmentation, which
affects performance and hit rate. It is recommended that you clear the cache (see
Clearing the cache, page 104) before making many changes to cache partition
sizes.
After you have partitioned the cache according to size and protocol, you can assign the
partitions you created to specific origin servers and domains.
You can assign a partition to a single origin server or multiple origin servers.
However, if a partition is assigned to multiple origin servers, there is no guarantee on
the space available in the partition for each origin server. Content is stored in the
partition according to popularity.
In addition to assigning partitions to specific origin servers and domains, you must
assign a generic partition to store content from all origin servers and domains that are
not listed. This generic partition is also used if the partitions for a particular origin
server or domain become corrupt.
Important
If you do not assign a generic partition, Content Gateway
runs in proxy-only mode.
Note
You do not need to stop Content Gateway before you
assign partitions to particular hosts or domains. However,
this type of configuration can cause a spike in memory
usage and is time consuming. It is recommended that you
configure partition assignment during periods of low
traffic.
You can partition the cache according to host name and domain in the Content
Gateway manager.
In the Content Gateway manager:
1. Configure the cache partitions according to size and protocol, as described in
[Link], page 421.
You should create a separate partition based on protocol (HTTP only) for each
host and domain, and an additional generic partition to use for content that does
not belong to these origin servers or domains. For example, if you want to
separate content from two different origin servers, you must have at least three
separate partitions: one HTTP-based partition for each origin server and a generic
partition for all other origin servers not listed (the partitions do not have to be the
same size).
2. On the Configure tab, click Subsystems, and then click Cache.
3. Click the Hosting tab and in the Cache Hosting area, click Edit File to open the
configuration file editor for the [Link] file.
4. Enter information in the fields provided, and then click Add. All the fields are
described in Cache, page 356.
5. Click Apply, and then click Close.
By default, Content Gateway allows objects of any size in the cache. You can change
the default behavior and specify a size limit for objects in the cache.
When you clear the cache, you remove all data from the entire cache, which includes
the data in the host database. Clear the cache before performing certain cache
configuration tasks, such as partitioning.
Note
You cannot clear the cache when Content Gateway is
running.
1. Stop Content Gateway. See Starting and stopping Content Gateway on the
Command Line, page 19.
2. Enter the following command to clear the cache:
content_gateway -Cclear
Warning
The clear command deletes all data in the object store and
the host database. Content Gateway does not prompt you
to confirm the deletion.
Content Gateway provides a dedicated RAM cache for fast retrieval of popular small
objects. The default RAM cache size is calculated based on the number and size of the
cache partitions you have configured. You can increase the RAM cache size for better
cache hit performance.
Warning
If you increase the size of the RAM cache and observe a
decrease in Content Gateway performance (such as
increased latencies), the operating system might require
more memory for network resources. Return the RAM
cache size to its previous value.
Note
If you have partitioned your cache according to protocol or
hosts, the size of the RAM cache for each partition is
proportional to the size of that partition.
Note
A value of “-1” directs Content Gateway to automatically
size the RAM cache to be approximately 1 MB per 1 GB
of disk cache.
3. Click Apply.
4. Click Restart on Configure > My Proxy > Basic > General.
Typically, clients send DNS requests to a DNS server to resolve host names. However,
DNS servers are frequently overloaded or not located close to the client; therefore
DNS lookups can be slow and can be a bottleneck to fulfilling requests.
The DNS proxy caching option allows Content Gateway to resolve DNS requests on
behalf of clients. This option off-loads remote DNS servers and reduces response
times for DNS lookups.
Important
You can use the DNS proxy caching option only with a
layer 4 switch or a Cisco router running WCCP v2.
The following overview illustrates how Content Gateway serves a DNS request.
1. A client sends a DNS request. The request is intercepted by a router or L4 switch
that is configured to redirect all DNS traffic on port 53 to Content Gateway.
2. The ARM examines the DNS packet. If the DNS request is type A (answer), the
ARM forwards the request to Content Gateway. The ARM forwards all DNS
requests that are not type A to the DNS server.
3. For type A requests, Content Gateway checks its DNS cache to see if it has the
host name to IP address mapping for the DNS request. If the mapping is in the
DNS cache, Content Gateway sends the IP address to the client. If the mapping is
not in the cache, Content Gateway contacts the DNS server to resolve the host
name. When Content Gateway receives the response from the DNS server, it
caches the host name to IP address mapping and sends the IP address to the client.
If round-robin is used, Content Gateway sends the entire list of IP address
mappings to the client and the round-robin order is strictly followed.
Note
If the host name to IP address mapping is not in the DNS
cache, Content Gateway contacts the DNS server specified
in the /etc/[Link] file. Only the first entry in
[Link] is used. This might not be the same DNS server
for which the DNS request was originally intended.
The DNS cache is held in memory and backed up on disk. Content Gateway updates
the data on disk every 60 seconds. The TTL (time-to-live) is strictly followed with
every host name to IP address mapping.
Important
You can use the DNS proxy caching option only with a
layer 4 switch or a Cisco router running WCCP v2.
5. Go to My Proxy > Basic and in the Features table, enable DNS Proxy in the
Networking section and click Apply. Postpone the prompted restart until step 8.
6. Go to Networking > DNS Proxy.
7. In the DNS Proxy Port field, enter the DNS proxy port. The default port is 5353.
8. Click Apply and restart Content Gateway.
9. Configure your layer 4 switch or WCCP v2 router to send DNS traffic to the
Content Gateway DNS port (default: 53).
Websense Content Gateway provides several options for configuring the system:
Content Gateway manager, page 111
Command-line interface, page 112
Configuration files, page 113
Saving and restoring configurations, page 114
Many configuration changes require a restart Content Gateway. When such a change
is made in Content Gateway manager, a message informs you that a restart is needed.
When such a change is made on the command line or in a configuration file there is no
notification. It is recommended that you consult Content Gateway documentation to
confirm whether a restart is needed.
The Content Gateway manager provides a Web-based user interface for configuring
the Content Gateway web proxy.
Note
Certain options can be changed only by editing
configuration variables either in the [Link] file or
from the command-line interface. See Command-line
interface, page 112 and Configuration files, page 113.
For instructions on logging on to the Content Gateway manager, see Accessing the
Content Gateway manager, page 11.
Click to display the Click a tab to display Shows the current user Click Help! to display
Configure buttons. more options. logged on to Content the online Help system.
Gateway manager.
In Configure mode, the Content Gateway manager displays a series of buttons. Each
button represents a group of configuration options.
All of the options available in Configure mode are described in Configuration
Options.
Command-line interface
As an alternative to the Content Gateway manager, you can use the command-line
interface to view and change your Content Gateway configuration.
1. Log on to a Content Gateway node as root, and then change directory (‘cd’) to the
Content Gateway bin directory (/opt/WCG/bin).
2. To view a configuration setting, enter the following command:
./content_line -r var
where var is the variable associated with the configuration option (for a list of the
variables, refer to Configuration variables, page 423).
3. To change the value of a configuration setting, enter the following command:
./content_line -s var -v value
where var is the variable associated with the configuration option and value is
the value you want to use.
For example, to change the FTP inactivity timeout option to 200 seconds, enter
the following command at the prompt and press Return:
./content_line -s
[Link].control_connection_timeout -v 200
Configuration files
You can change some Content Gateway configuration options by editing specific
variables in the [Link] file, located in /opt/WCG/config. Open the file in a
text editor (such as vi or emacs) and change the value of the variable.
Note
After you modify the [Link] file, Content
Gateway must reread the configuration files. From the
Content Gateway bin directory (/opt/WCG/bin), enter the
command:
./content_line -x
In some cases, you have to restart the proxy to apply the
changes.
Content Gateway provides other configuration files that are used to configure specific
features. All the configuration files are described in Configuration Files, page 391.
The configuration snapshot feature lets you save all current configuration settings and
restore them if needed. Content Gateway can store configuration snapshots on the
node where they are taken, on an FTP server, and on portable media. Content Gateway
restores a configuration snapshot on all the nodes in the cluster.
Note
It is recommended that you take a configuration snapshot
before performing system maintenance or attempting to
tune system performance. Taking a configuration snapshot
takes only a few seconds.
You can save all of the current configuration settings on your Content Gateway system
using a facility in the Content Gateway manager.
If you are running a cluster of Content Gateway servers, the configuration is restored
to all the nodes in the cluster.
2. From the Restore > Delete Snapshot drop-down list, select the configuration
snapshot that you want to restore.
3. Click the Restore Snapshot from “directory_name” Directory box.
4. Click Apply.
The Content Gateway system or cluster uses the restored configuration.
Viewing statistics
Use the Content Gateway manager to collect and interpret statistics about Content
Gateway performance and Web traffic. View statistics using Monitor mode.
For instructions on logging on to the Content Gateway manager, see Accessing the
Content Gateway manager, page 11.
My Proxy
Click My Proxy to see statistics about Content Gateway.
Click Summary to see a concise view of your Content Gateway system. The top
portion of the page displays information about the features of your TRITON AP-
WEB subscription, including the expiration date. The middle portion of the page
displays information about the scanning engines in use and their associated data
files. The bottom portion of the page contains statistics on proxy nodes, displaying
all cluster nodes by name and tracking essential statistics for each node. If you
want to display detailed information about a particular node in a cluster, click the
node’s name in the Summary table, and then click one of the other buttons on the
Monitor tab.
Click Node to see information about the selected node. You can see if the node is
active or inactive, the date and time that the content_gateway process was
started, cache performance information (document hit rate, bandwidth savings,
and what percentage of the cache is currently free), the number of client and
server connections currently open, and the number of transfers currently in
progress. You can also see name resolution information, such as the host database
hit rate and the number of DNS lookups per second.
Note
If the node is part of a cluster, two sets of statistics are
shown: information about the single node and information
showing an average value for all nodes in the cluster. Click
the name of a statistic to display the information in
graphical format.
Click Graphs to view the same statistics displayed on the Node page (cache
performance, current connections and transfers, network, and name resolution) in
graphical format. You can display multiple statistics in one graph.
To display a particular statistic in graphical format, click the box next to the name
of the graph, and then click Graph. To display multiple statistics in one graph,
click the box next to the name of each graph you want to display, and then click
Graph.
Important
The graph is displayed in your browser using a Java applet.
You should have the latest version of Java installed on
your PC (at least version 1.7). To validate your access to
Content Gateway statistics, you will be prompted for
Content Gateway logon credentials.
Click Alarms to view the alarms that Content Gateway has signaled. See Working
with alarms, page 121.
Select Diagnostics to run automatic or manual diagnostic tests to help determine
the cause for a problem you might be having. Run the diagnostics listed on the
Automatic tab to test network connections. Enter parameters for the diagnostic
commands provided on the Manual tab to execute tests typically run from the
command line.
Protocols
The Protocols button provides information about HTTP and FTP transactions.
Click HTTP to see information about HTTP transactions and speeds (such as
cache misses, cache hits, connection errors, aborted transactions) and client and
server connection information. Also see information about FTP requests from
HTTP clients, such as the number of open FTP server connections, the number of
successful and unsuccessful PASV and PORT connections, and the number of
cache lookups, hits, and misses.
Click FTP to see information about FTP requests from FTP clients.
Note
The FTP button appears only if you have enabled FTP
processing in the Features table under the Configure >
My Proxy > Basic tab.
Security
The Security button provides information about proxy authentication, and SOCKS
server connections:
Click LDAP to see the number of LDAP cache hits and misses, and the number of
LDAP authentication server errors and unsuccessful authentication attempts. The
LDAP button appears only if you have enabled the LDAP option in the Features
table on the Configure > My Proxy > Basic > General tab.
Click NTLM to see the number of NTLM cache hits and misses, and the number
of NTLM authentication server errors and unsuccessful authentication attempts.
The NTLM button appears only if you have enabled the NTLM option in the
Features table on the Configure > My Proxy > Basic > General tab.
Click Integrated Windows Authentication (IWA) to see the negotiated requests
counters, the NTLM request counters and the Basic authentication request
[Link] IWA tab appears only if you have enabled the IWA option in the
Features table on the Configure > My Proxy > Basic > General tab.
Click SOCKS to see the number of successful and unsuccessful connections to
the SOCKS server and the number of connections currently in progress. The
SOCKS button appears only if you have enabled the SOCKS option in the
Features table on the Configure > My Proxy > Basic > General tab.
Subsystems
The Subsystems button provides information about the proxy cache, clusters, and
event logging:
Click Cache to see information about the proxy cache. See how much space in the
cache is currently being used, the total size of the cache in gigabytes, the total size
of the RAM cache in bytes, the number of RAM cache hits and misses, and the
number of cache lookups, object reads, writes, updates, and removes.
Click Clustering to see the number of nodes in the cluster, the total number of
cluster operations, the number of bytes read and written to all the nodes in the
cluster, and the current number of open connections in the cluster.
Click Logging to see the number of log files currently open, the amount of space
currently being used for log files, the number of access events and error events
logged, and the number of access events skipped.
Networking
The Networking button provides information about system network configuration, the
ARM, WCCP routers, DNS proxy, domain name resolution, and virtual IP addressing.
Click System to see system network configuration, including the host name
assigned to the proxy machine and the default gateway, search domain, and DNS
servers that the proxy machine uses.
Click ARM to see information about Network Address Translation and dynamic
bypass.
Click WCCP to see WCCP v2 fragmentation statistics and the configuration of
every WCCP service group enabled on the Content Gateway node. The WCCP
tab appears only if you have enabled WCCP in the Features table on the
Configure > My Proxy > Basic > General tab.
Click DNS Proxy to see the total number of DNS requests served by Content
Gateway, and the number of cache hits and misses. The DNS Proxy button
appears only if you have enabled the DNS Proxy option in the Features table on
the Configure > My Proxy > Basic > General tab.
Click DNS Resolver to see the total number of lookups and hits in the host
database, and the average lookup time, the total number of lookups, and the
number of successful lookups in the DNS server.
Click Virtual IP Address to see the current virtual IP address mappings. The
Virtual IP Address button appears only if you have enabled the Virtual IP option
in the Features table on the Configure > My Proxy > Basic > General tab.
Click Client Connections to see client connection totals for current connections,
unique clients since last restart, clients that have exceeded the connection limit,
and client for which connections were closed.
Performance
The Performance button displays historical performance graphs. See Using
Performance graphs, page 123.
SSL
The SSL button provides information and statistics on SSL key data, certificate
revocation and OCSP counts, and SSL logs.
Click the SSL Key Data button to see information about SSL service health (Is
alive), connection statistics, and SSL session cache hits and misses.
Click CRL Statistics to see CRL and OCSP statistics.
You can use the command-line interface to view statistics about Content Gateway
performance and Web traffic.
You can also configure, stop, and restart Content Gateway from the command line.
See Command-line interface, page 112, and Websense Content Gateway variables,
page 297.
To view specific information about a Content Gateway node or cluster, specify the
variable that corresponds to the desired statistic.
1. Become root:
su
2. Log on to a Content Gateway node.
3. From the Content Gateway bin directory (/opt/WCG/bin), enter the following
command:
./content_line -r variable
where variable is the variable that holds the information you want. For a list of
the variables you can specify, see Websense Content Gateway variables, page 297.
For example, the following command displays the document hit rate for the node:
content_line -r [Link].cache_hit_ratio
Content Gateway signals an alarm when it detects a problem, for example if the space
allocated to event logs is full, or if it cannot write to a configuration file.
Not all alarms are critical. Some alarms report transient conditions. For example, a
Content Gateway subscription download failed: error connecting alarm can be
generated by a temporary disruption in Internet connectivity.
Navigate to Monitor > My Proxy > Alarms to see a listing of current alarms, as
shown below.
Note
Content Gateway also sends select alarms to the Web
module of the TRITON Manager, where they are referred
to as alerts. Summary alert messages are displayed on the
Web > Status > Today page. TRITON administrators can
configure which Content Gateway conditions cause alert
messages to be sent, and which methods (email or SNMP)
are used to send the alert, on the Settings > Alerts pages.
Clearing alarms
After you have read an alarm message, you can click Clear in the alarm message
window to dismiss the alarm. Alarm messages, page 502, provides a description of
some of the alarm messages that Content Gateway generates.
Important
Clicking Clear only dismisses alarm messages; it does not
resolve the cause of the alarms.
If the same alarm condition occurs a second time, it will not be logged if the first
alarm has not been cleared.
2. In the Alarm Email field, enter the email address to which you want to send
alarms. Be sure to use the full mail address including @ notation, for example:
receivername@[Link]
3. Click Apply.
The Performance graphing tool (Multi Router Traffic Grapher) allows you to monitor
Content Gateway performance and analyze network traffic. Performance graphs show
information about virtual memory usage, client connections, cache hit and miss rates,
and so on. The information provided is recorded from the time that Content Gateway
was started. Statistics are gathered at 5-minute intervals.
Go to Monitor > Performance to access performance graphs.
Important
To run Multi Router Traffic Grapher (the Performance
graphing tool), you must have Perl v5.005 or later installed
on your Content Gateway system.
1. If your Content Gateway node is in a cluster, select the node whose statistics you
want to view from the Monitor > My Proxy > Summary display.
2. On the Monitor tab, click Performance.
3. Click Overview to see a subset of available graphs.
Click Daily to see statistics for the current day.
Click Weekly to see statistics for the current week.
Click Monthly to see statistics for the current month.
Click Yearly to see statistics for the current year.
4. Wait at least 15 minutes after starting Content Gateway before looking at the
graphs. It takes several 5-minute sample intervals for the tool to initialize
statistics.
If Multi Router Traffic Grapher (MRTG) has not been configured, the system displays
a message indicating that it is not available. To configure the tool:
Note
To stop MRTG cron updates, type the command
./mrtgcron stop
You can request a report detailing the status of certificate authorities (see Certificate
Authorities, page 124) or listing incidents (see Incidents, page 126).
Reports can be either in HTML or comma-separated format. The comma-separate
reports appear as Excel spreadsheets.
Certificate Authorities
Help | Content Gateway | Version 8.1.x
1. Go to the Monitor > SSL > Reports > Certificate Authorities tab.
2. Select the format of the report.
a. HTML
b. Comma-separated values (CSV)
If you select CSV, the report is created as an Excel spreadsheet.
3. Specify the time period the report will cover.
a. A number of days
b. A starting date spanning to the present
c. All records in the log
Note
To delete the collected SSL log data, click Reset all
collected data.
Incidents
Help | Content Gateway | Version 8.1.x
Note
To delete the collected SSL log data, click Reset all
collected data.
Related topics:
Registering and configuring TRITON AP-DATA, page 131
Configuring the ICAP client, page 136
ICAP failover and load balancing, page 137
When Websense Content Gateway is deployed with the Web DLP module, the
TRITON AP-WEB solution is extended to include:
Web data loss prevention (DLP)
Enhanced forensic data in the Threats dashboard in the Web module of the
TRITON Manager.
When Content Gateway is deployed without the Web DLP module, your deployment
still benefits from some data theft forensic data on the Threats dashboard.
When TRITON AP-WEB is deployed with the Web DLP module, capabilities include
forensics data in the Threats dashboard and data loss prevention (DLP) over Web
channels such as HTTP, HTTPS, FTP, and FTP over HTTP. (A full TRITON
AP-DATA deployment can extend data loss prevention to include channels such as
mobile devices, removable media, and printers. For a complete description of
TRITON AP-DATA, visit the Products page at [Link].)
Web DLP, as well as extended data protection configurations, require separate
installation of TRITON AP-DATA. Before configuring Content Gateway to work with
TRITON AP-DATA, see the deployment and installation information hosted in the
Websense Technical Library.
Content Gateway supports 2 methods of working with TRITON AP-DATA:
Preferred: Some components installed with Content Gateway.
Note
When a request is blocked and the DLP server sends a
block page in response:
Content Gateway forwards the block page to the
sender in a 403 Forbidden message.
The block page must be larger than 512 bytes or some
user agents (e.g., Internet Explorer) will substitute a
generic error message.
The block page can be customized. See Customizing
TRITON AP-ENDPOINT DLP client messages.
Transactions over HTTP, HTTPS, FTP, and FTP over HTTP can be examined.
Transaction details are logged by TRITON AP-DATA, per its configuration.
Related topics:
Stopping and starting Data Security processes, page 135
For an introduction to TRITON AP-DATA, see Working With Web DLP, page 129.
Registration and configuration summary:
Registration with on-box Web DLP components is automatic. No configuration is
required.
Threat dashboard forensics data is collected automatically.
Note
Automatic registration is not available with AP-DATA
Web Content Gateway. See Manual registration.
Important
Content Gateway and the TRITON management server
system times should be synchronized to within a few
minutes.
Important
TRITON AP-DATA and Content Gateway communicate
over several ports. If IPTables are configured on the
Content Gateway host system, these ports must be open in
IPTables. See these Technical Library articles: TRITON
Ports and Configuring IPTables for Websense Content
Gateway.
Web DLP policies are configured in the System Modules section of the DATA
module in TRITON Manager. You must deploy the policies to put them into
effect. See TRITON AP-DATA Help for details.
View registration status in the Content Gateway manager on the Monitor >
Summary page by clicking More Detail and checking the list at the bottom of the
Subscription Details section.
Registration success and failure information is logged in: /opt/WCG/logs/
dss_registration.log
Go to Configure > My Proxy > Basic and enable Web DLP >
Integrated on-box. If this option is not enabled, registration is with the Forensics
Repository only.
Important
Before enabling Web DLP > Integrated on-box, ensure
that the TRITON management server is running and
accessible, and that its system clock is synchronized with
the Content Gateway server.
After Web DLP > Integrated on-box is enabled, registration with the DATA module
of the TRITON Manager is automatic and is performed, if needed, every time that
Content Gateway starts. To perform registration, Content Gateway queries the
Websense Policy Broker for needed information, including IP address and cluster ID.
Registration status can be viewed in the Content Gateway manager on the Monitor >
Summary page by clicking More Detail and reviewing the list at the bottom of the
Subscription Details section.
Once registered, Content Gateway uses the Web DLP policy engine for malware
detection. Go to the DATA module of the TRITON Manager to configure and deploy
Web DLP policies.
If automatic registration fails, an alarm displays.
Manual registration
After Web DLP > Integrated on-box is enabled and Content Gateway has been
restarted, you can attempt a manual registration by going to Configure > Security >
Web DLP (see below).
Restarting Content Gateway always checks the registration status and initiates an
auto-registration attempt, if needed.
Registration success and failure information is logged in: /opt/WCG/logs/
dss_registration.log
Important
If Content Gateway is not located on a V-Series appliance,
registration requires that the Content Gateway host
system have an IPv4 address assigned to the eth0 network
interface. After registration, the IP address may move to
another network interface on the system; however, that IP
address is used for Web DLP policy configuration and
deployment and must be available as long as the two
modules are registered.
1. Ensure that the Content Gateway and TRITON management server systems are
running and accessible, and that their system clocks are synchronized within a few
minutes.
2. Ensure that Web DLP > Integrated on-box is enabled. In the Content Gateway
manager select Configure > Basic > General. In the list of Features, under
Networking locate Web DLP, select On, then select Integrated on-box, and
then click Apply.
3. Next to Integrated on-box, click the Not registered link. This opens the
Configure > Security > Web DLP registration screen.
4. Enter the IP address of the TRITON management server.
5. Enter a user name and password for logging onto the TRITON manager. The user
must be an administrator with DATA module Deploy Settings privileges.
6. Click Register. If registration is successful, a message confirms the result and
prompts you to restart Content Gateway.
If registration fails, an error message indicates the cause of failure. Correct the
problem and perform the registration process again.
Configuration options
When registration is successful, on the Configure > Security > Web DLP page set
the following options:
1. Analyze FTP Uploads: Select this option to send FTP uploads to TRITON
AP-DATA for analysis and policy enforcement.
2. Analyze HTTPS Content: Select this option to send decrypted HTTPS posts to
TRITON AP-DATA for analysis and policy enforcement. The HTTPS protocol
option must be enabled on Content Gateway.
Note
For these options to have any effect, Content Gateway
must be configured to proxy FTP and HTTPS traffic.
3. Click Apply to save your settings and then restart Content Gateway.
4. Go to the DATA module of the TRITON Manager to configure the Content
Gateway module. See “Configuring the Web Content Gateway module” in
TRITON AP-DATA Help.
TRITON AP-DATA and Content Gateway communicate over several ports. If
IPTables are configured on the Content Gateway host system, these ports must be
open in IPTables. See these Technical Library articles: TRITON Ports and
Configuring IPTables for Websense Content Gateway.
Note
A Content Gateway manager alarm is generated if:
Web DLP is enabled but not registered
Web DLP is enabled and registered but not configured
in the DATA module of TRITON Manager
To disable the integration with the on-box Data Security policy engine:
1. Log on to Content Gateway Manager and navigate to Configure > Security >
Web DLP > General. This page should indicate that the Registration status is
Registered.
2. Navigate to Configure > My Proxy > Basic > General and locate the Web DLP
option under Networking in the Features list.
3. Select Off and click Apply.
4. Click Restart at the top of the page to restart Content Gateway and automatically
unregister Data Security.
When Content Gateway is registered with Data Security Management Server and the
on-box policy engine is running, 3 daemon processes are active on the Content
Gateway machine:
PolicyEngine handles transaction and data analysis.
PAFPREP manages the Data Security fingerprint repository.
mgmtd handles configuration storage and replication.
These processes start automatically whenever the computer is started.
You must have root privileges to stop or start the processes.
To stop or start all policy engine processes, on the command line enter:
/opt/websense/PolicyEngine/managePolicyEngine -command
[stop|start]
ICAP can be used with any version of TRITON AP-DATA or Websense Data
Security, however the direct interface is recommended when the policy engine is
on-box with Content Gateway. See Registering and configuring TRITON AP-DATA,
page 131.
ICAP must be used for inter-operation with Data Security Suite versions 7.1 and
earlier.
Note
A secondary ICAP server can be specified as a failover
should the primary server fail.
The primary and secondary can also be configured to
perform load balancing.
See ICAP failover and load balancing, below.
To configure integration with ICAP, log on to the Content Gateway manager and go to
Configure > My Proxy > Basic > General.
1. In the Networking section of the Features table, select Web DLP On and then
ICAP.
2. Click Apply, and then click Restart.
3. Navigate to Configure > Networking > ICAP > General.
4. In the ICAP Service URI field, enter the Uniform Resource Identifier (URI) for
the primary ICAP service, followed by a comma (no space) and the URI of the
secondary ICAP service. A secondary ICAP service is optional.
A URI is similar to a URL, but the URI ends with a directory, rather than a page.
Obtain the identifier from your Websense data protection administrator. Enter the
URI in the following format:
icap://hostname:port/path
For hostname, enter the IP address or hostname of the Websense Data Security
Suite Protector appliance.
The default ICAP port is 1344.
Path is the path of the ICAP service on the host machine.
For example:
icap://ICAP_machine:1344/reqmod
You do not need to specify the port if you are using the default ICAP port 1344.
For example, the above URI can also be entered without the default port:
icap://ICAP_machine/reqmod
Note
If you change the URI, you must restart Content Gateway.
Other changes do not require a restart.
Content Gateway can be configured to failover to a backup ICAP server if the active
ICAP server fails. The proxy detects the failure condition and sends traffic to the
secondary server. If the secondary becomes unresponsive, the proxy uses the primary.
If no ICAP servers are available, the proxy fails open.
Load balancing between 2 ICAP servers is also an option.
Time to failover
Content Gateway may experience temporary request-processing latency between the
time the real failure occurs and the time the proxy marks the failed server as down.
After the failed server is marked down, all new requests are sent to the second ICAP
server. The time to failover is primarily limited by the connection timeout
configuration.
Recovery Conditions
After the failed server is marked down, new requests are sent to the second server. No
new ICAP requests are sent to the failed server until that server is detected to be active
again, based on the recovery conditions below.
Content Gateway tests for recovery conditions for each down ICAP server at a
specified interval. If load balancing is disabled, requests continue to be sent to a
secondary ICAP server until the primary comes back online. If load balancing is
enabled, Content Gateway starts sending requests to a server (round-robin) as soon as
it is marked up.
TCP connection success
Successfully sent OPTIONS request
Successfully received valid response to OPTIONS request
Recovery actions
Upon server recovery (server comes back online and is marked as up)
Load balancing ON: Requests start being distributed to the newly up server
(round-robin)
Load balancing OFF: If the primary server recovers, all requests start being sent to
the primary. If the secondary server recovers, traffic continues to be sent to the
primary, until the primary goes down.
Fail open
If all ICAP servers are down, a configuration option allows fail open or fail closed
behavior. When all ICAP servers are down, the background thread continuously
attempts to reestablish a new connection with each server.
Configuration settings
These ICAP failover parameters are set in the [Link] file (defaults shown):
Related topics:
Running in explicit proxy mode, page 143
Initial SSL configuration tasks, page 146
Enabling SSL support, page 145
Certificates, page 147
Internal Root CA, page 147
Managing certificates, page 156
SSL configuration settings for inbound traffic, page 158
SSL configuration settings for outbound traffic, page 160
Validating certificates, page 161
Managing HTTPS website access, page 166
Client certificates, page 171
Customizing SSL connection failure messages, page 173
SSL (Secure Sockets Layer) and TLS (Transport Layer Security) are the industry
standards for secure transmission of data on the Internet. They rely on data encryption
and a system of trusted certificates issued by certificate authorities (CAs) that are
recognized by clients and servers. SSL/TLS requests made in a browser are easily
identified by the “https” string that leads the URL.
In the topics that follow, for convenience and simplicity, SSL/TLS is referred to
simply as SSL.
To establish an SSL connection, the client sends an SSL connection request to the
server. If the server consents, the client and server use a standard handshake to
negotiate an SSL connection.
Content Gateway offers 2 types of support for HTTPS traffic. Only one can be used at
a time.
Simple connection management in which Content Gateway performs URL
filtering and then allows the client to make the connection with the server.
Important
Even when HTTPS support is not enabled and HTTPS is
not decrypted, Content Gateway performs URL filtering.
This means that for every HTTPS request received from a
client, a URL lookup is performed and policy is applied.
In explicit proxy mode, when support for HTTPS is
disabled, Content Gateway performs URL filtering based
on the Host name in the request. If the site is blocked,
Content Gateway serves a block page. Note that some
browsers do not support display of the block page. To
disable this feature, configure clients to not send HTTPS
requests to the proxy.
In transparent proxy mode, when HTTPS is disabled, if
there is an SNI in the request, Content Gateway gets the
hostname from the SNI and performs URL filtering based
on the hostname. Otherwise, Content Gateway uses the
Common Name in the certificate of the destination server.
However, if the Common Name contains a wildcard (*),
the lookup is performed on the destination IP address. If
the site is blocked, the connection with the client is
dropped; no block page is served. To disable this feature
when used with WCCP, do not create a service group for
HTTPS.
Note
Content Gateway does not cache HTTPS content.
When HTTPS is enabled, each HTTPS request consists of two separate sessions:
One from the client browser to Content Gateway. This is the inbound connection.
Another from Content Gateway to the origin server that will receive the secure
data. This is the outbound connection.
For additional information on SSL, TLS, and SSL/TLS certificates, search the Internet
or consult any of the commercially available books.
If you have an existing PAC file, replace the [Link] file located in the Content
Gateway config directory (default location is /opt/WCG/config) with the existing
file. If you do not have a PAC file already, see Step 4 below for a script you can use as
a basis for building a custom PAC file.
1. On the Configure > My Proxy > Basic > General tab, ensure that HTTPS is
enabled. If it is disabled, set it to On, click Apply, and Restart Content Gateway.
2. Go to Configure > Content Routing > Browser Auto-Config > PAC.
3. In the Auto-Configuration Port field, specify the port that the proxy uses to
serve the PAC file. The default port is 8083.
4. The PAC Settings area displays the [Link] file:
If you copied an existing PAC file into the Content Gateway config directory,
the [Link] file contains your proxy configuration settings. Check the
settings and make changes if necessary.
If you did not copy an existing PAC file into the Content Gateway config
directory, the [Link] file is empty. Copy and paste the following script for
your PAC settings. You must provide the proxy domain name or IP address.
This template is for basic testing only. Further modify this file to meet all of
your organization’s needs.
The procedures for specifying the PAC file location vary among browsers.
For Microsoft Internet Explorer version 7.0 and later:
1. Go to Tools > Internet Options > Connections > LAN Settings.
2. Select Use automatic configuration script field, and enter
[Link]
in the Address field.
3. Click OK.
For Mozilla Firefox 2.0 and later:
1. Go to Tools > Options > Advanced > Network > Connection > Settings.
2. Select Automatic proxy configuration URL field, and enter
[Link]
3. Click Reload, and then click OK.
See your browser documentation for details.
Note
If you are deployed with Web DLP and it is configured to
inspect HTTPS traffic, you must enable HTTPS.
Important
There is no need to set this option if HTTPS support is not
enabled.
This option is not valid and has no effect when Content
Gateway is a transparent proxy.
Warning
Tunneled connections are not decrypted or inspected.
For inbound (client to Content Gateway) traffic, perform these steps to prepare for
supporting HTTPS traffic through Content Gateway:
1. Create an internal root CA (certificate authority). In order to sign SSL traffic,
Content Gateway requires an internal SSL Certificate Authority that has the
ability to sign SSL certificates. This is for traffic between the browser and Content
Gateway. See Internal Root CA, page 147.
2. Add this CA to the certificate tree. Servers, such as destination servers, check this
tree to ensure that they can trust users because they have certificates from an
authority listed here. The certificates listed on the certificate tree are certificate
authorities you empower (trust) to verify the validity of individual websites. Any
site signed by a certificate authority in the certificate tree with the “allow” status is
allowed through Content Gateway. See Managing certificates, page 156
3. Customize pages that browser users will see. See Customizing SSL connection
failure messages, page 173. Among the pages that can be customized are a
connect failure and certificate verification failure page.
Certificates
Internal Root CA
The internal Root CA dynamically generates all certificates used between the client
browser and Content Gateway.
You must have an internal Root CA to complete an inbound connection.
You can either import or create the internal Root CA.
Important
Back up the existing internal Root CA before importing or
creating a new one. This enables you to return to an earlier
version, if necessary. See Backing up your internal Root
CA, page 155 for details.
Only one internal Root CA can be active at a time.
Important
The default internal Root CA that is included with Content
Gateway is not unique and should not be used in a
production environment.
Replace the default internal Root CA with your
organization’s Root CA or create a new one. See the
sections that follow.
If your organization already has a Root CA, you can import it. This certificate must be
trusted by all browsers in your organization. Be sure to back up any new internal Root
CA that you import. See Backing up your internal Root CA, page 155 for details.
1. Go to Configure > SSL > Internal Root CA > Import Root CA.
2. Browse to select the certificate. The certificate must be in X.509 format and
base64-encoded.
3. Browse to select the private key. It must correspond to the certificate you selected
in Step 2.
Important
The certificate and private key format must match.
Additionally, the private key format must match the format
required by the importing node (unencrypted or
encrypted).
To verify the certificate and private key format, view the
files in a text editor. Use Backup Root CA to export the
CA from the database.
For information on converting the private key format, see:
Preparing an Internal Root CA for importing into a
FIPS 140-2 enabled node
Converting an RSA key type to a PKCS#8 key type
Converting an encrypted private key to an RSA key
Related topic:
Creating a subordinate CA, page 150
If you do not already have a Root CA, fill in the fields on this tab to create one.
The process uses openssl pkcs#8.
Be sure to back up any new Root CAs that you create. See Backing up your internal
Root CA, page 155 for details.
An asterisk (*) on this page indicates a required field.
1. Select Configure > SSL > Internal Root CA, and then select Create Root CA.
2. Provide requested information in the fields, particularly noting the following:
The fields Organization, Organizational Unit, and Common Name
comprise a distinguished name.
• For Organization, enter the name of your company.
• For Common Name, enter the name of your company certificate authority.
The comment becomes part of the certificate. The first line you enter can be
seen by end users.
Enter, and then confirm, the passphrase. (A passphrase is similar to a
password. Usually, however, it is longer to provide greater security. It is
recommended that you use a strong passphrase, with a combination of
numbers, characters, and upper- and lower-case letters.
3. Click Generate and Deploy Certificate to deploy the certificate to the Content
Gateway server.
Creating a subordinate CA
Help | Content Gateway | Version 8.1.x
Creating a subordinate certificate authority (sub CA) enables you to take advantage of
all the information already existing for your Root CA. However, the Root CA can
revoke the sub CA at any time.
Follow these steps to generate a sub CA using OpenSSL and the certificate services in
Microsoft Windows.
Preparation
If you are not the Enterprise domain administrator, you will need to work
with that person to get the correct domain permissions to generate a sub CA.
Install the OpenSSL toolkit ([Link]) on a Windows or Linux
computer.
2. There will be a series of questions. Answer each question and make note of the
challenge password; it will be needed later in the process.
The openssl command generates 2 files:
• [Link] -- the CSR that will be signed by the Certificate Authority to
create the final certificate
• [Link] -- the private key
3. If you created the CSR on a Linux system, copy it to your Windows host with
WinSCP or some other file transfer utility.
1. Open [Link] with WordPad (to preserve the formatting) and copy the contents
onto the clipboard (Edit > Select all; Edit > Copy).
3. On the Welcome screen, below the Select a task heading, select Request a
certificate. The Request a certificate page displays.
7. Select the Base 64 encoded radio button and then select Download certificate.
Save the certificate to your desktop. Later you will import it into Content
Gateway.
With the base 64 encoded certificate on your desktop, along with the private key
created during the CSR generating process, you are ready to import both into Content
Gateway.
2. Browse to select the certificate. The certificate must be in X.509 format and base-
64-encoded.
3. Browse to select the private key. It must correspond to the certificate you selected
in step 2.
4. Enter and then confirm the passphrase.
5. Click Import Root CA.
6. Restart Content Gateway.
Always back up the public and private keys of your internal Root CAs before
importing or creating new ones. This enables you to return to an earlier version of the
certificate, if necessary. In addition, back up any new Root CAs that you import or
create.
1. Go to Configure > SSL > Internal Root CA > Backup Root CA.
2. Click Save Public CA Key to view or save the public CA key. This public key
must be trusted by the users’ Web browsers. Consult your network administrator if
you do not have the key.
3. Click Save Private CA Key to view or save the private CA key. Consult your
network administrator if you do not have the key.
Managing certificates
Related topics:
Adding new certificate authorities, page 157
Backing up certificates, page 158
Restoring certificates, page 158
Content Gateway initially populates the Certificate Authority Tree (trusted certificate
store) with the list qualified by Mozilla for Firefox (see this [Link] page), by
Microsoft for Internet Explorer, and by Apple for Safari. The CA tree is listed on the
Configure > SSL > Certificates > Certificate Authorities tab. Content Gateway
trusts origin servers that offer these certificates.
In the list a small “i” appears before the names of certificates that can be validated via
CRL (certificate revocation lists) or OCSP (online certification status protocol). See
Keeping revocation information up to date, page 165 for information about checking
the revocation status of a certificate. Content Gateway checks the revocation status of
certificates used for both inbound and outbound traffic.
Click on the name of a certificate authority to:
View a certificate, page 156
Delete a certificate, page 156
Change the allow/deny status of a certificate, page 157
View a certificate
1. Go to Configure > SSL > Certificates > Certificate Authorities.
2. Select the name of the authority whose status you want view.
3. In the pop-up window, select Click to view certificate.
4. Follow the directions in the Opening window to open or save the file.
Delete a certificate
1. Go to Configure > SSL > Certificates > Certificate Authorities.
2. Select the name of the certificate authority you want to delete.
3. In the pop-up window, select Click to delete certificate.
4. Confirm or deny that you want to delete the certificate.
5. If you confirm that you want to delete the certificate, check that the certificate is
no longer listed on Configure > SSL > Certificates > Certificate Authorities.
Related topics:
Backing up certificates, page 158
Restoring certificates, page 158
Use the page Configure > SSL > Certificates > Add Root CA to manually import
additional certificate authorities. Certificates that you import manually have a default
status of allow.
Important
It is recommended that you back up your current
certificates before making any changes, such as adding or
deleting certificates. See Backing up certificates, page 158.
If you want to back up your entire Content Gateway
configuration, see Saving and restoring configurations,
page 114.
1. Click Browse to navigate through the directory structure to find certificates. Look
for files that have a “.cer” extension. The certificate must be in X.509 format and
base64-encoded.
2. Click Add Certificate Authority.
3. If the import was successful, check that the new certificate is listed on
Configure > SSL > Certificates > Certificate Authorities.
New CAs are also added when users visit a site signed by that authority. These
certificates may be allowed or denied. See Change the allow/deny status of a
certificate, page 157 for additional information.
Backing up certificates
Help | Content Gateway | Version 8.1.x
Restoring certificates
Help | Content Gateway | Version 8.1.x
Use Configure > SSL > Certificates > Restore Certificates to restore certificates.
The certificate database is propagated around the cluster.
1. Click Browse to navigate to the location of the backup certificate database.
2. Click Restore. You receive a message telling you that the restore was successful
and indicating where the previous certificate database was backed up.
If you are running multiple proxies, use this restore feature to ensure that all the
proxies have the same configuration.
Related topics:
SSL configuration settings for outbound traffic, page 160
Use Configure > SSL > Decryption / Encryption > Inbound to configure SSL and
TLS settings and ciphers for inbound traffic.
1. Under Protocol Settings, indicate which protocols you want Content Gateway to
support. Supported protocols are:
SSLv2
SSLv3 (disabled by default)
TLSv1 (enabled by default)
Note
TLSv1.1 and TLSv1.2 are also supported.
Both are enabled by default for inbound connections, but
not for outbound (to destination server) connections.
Each is enabled/disabled with [Link] variables:
[Link].TLSv11 INT 1 --(0 = disabled)
[Link].TLSv12 INT 1 --(0 = disabled)
When Content Gateway is on a Websense appliance, use
the Appliance manager Toolbox Command Line Utility to
set the value.
When Content Gateway is installed as software, use
“content_line -s” on the Linux command line to set the
value.
Select the protocols that your organization’s security policy has adopted and that
your browsers support.
You must select at least one protocol.
These settings override the settings for these protocols in the users’ browsers.
You can select different protocols for outbound traffic.
2. The cipher list describes available algorithms and level of encryption between the
client and Content Gateway.
The Default setting indicates to use all available ciphers except the eNULL,
ADH, and EXP suites.
The strongest cipher (providing the highest level of encryption) is applied first.
This can be set to a different level of encryption than for outbound traffic.
Additional cipher settings are:
High encryption cipher suites: those with key lengths larger than 128 bits, and
some cipher suites with 128-bit keys.
Medium encryption cipher suites: those using 128 bit encryption.
Low encryption cipher suites: those using 64- or 56-bit encryption algorithms
but excluding export cipher suites.
For inbound requests (clients connections to Content Gateway), consider using
Low encryption to improve performance.
For more information on ciphers, refer to [Link]/docs.
3. Click Apply.
4. Click Restart on Configure > My Proxy > Basic > General.
Use Configure > SSL > Decryption / Encryption > Outbound to configure SSL
and TLS settings, session cache, and ciphers for outbound traffic (Content Gateway to
the origin server).
1. Under Protocol Settings, indicate which protocols you want Content Gateway to
support. Supported protocols are:
SSLv2
SSLv3 (disabled by default)
TLSv1 (enabled by default)
Note
TLSv1.1 and TLSv1.2 are also supported.
Both are disabled by default for outbound connections.
They are enabled/disabled with [Link] variables:
[Link].TLSv11 INT 0 --(0 = disabled)
[Link].TLSv12 INT 0 --(0 = disabled)
When Content Gateway is on a Websense appliance, use
the Appliance manager Toolbox Command Line Utility to
set the value.
When Content Gateway is installed as software, use
“content_line -s” on the Linux command line to set the
value.
Select the protocols that your organization’s security policy has adopted.
You must select at least one protocol.
You can select different protocols for inbound traffic.
2. Select Session Cache if you want to cache keys until the time specified in Session
Cache Timeout expires. If keys are not cached, each request is negotiated again.
Setting the Session Cache Timeout to 0 (zero) causes session caching to be
disabled.
3. Indicate, in seconds, how long keys should be kept in the cache. The default is 300
seconds (5 minutes).
4. The cipher list describes available algorithms and level of encryption between
Content Gateway and the origin server.
The Default setting indicates to use all available ciphers except the eNULL,
ADH, and EXP suites.
The strongest cipher (providing the highest level of encryption) is applied first.
This can be set to a different level of encryption than for inbound traffic.
Additional cipher settings are:
High encryption cipher suites: those with key lengths larger than 128 bits, and
some cipher suites with 128-bit keys.
Medium encryption cipher suites: those using 128 bit encryption.
Low encryption cipher suites: those using 64- or 56-bit encryption algorithms
but excluding export cipher suites.
For outbound requests, consider using one of the higher encryption levels to
improve security.
For more information on ciphers, refer to [Link]/docs.
5. Click Apply.
6. Click Restart on Configure > My Proxy > Basic > General.
Validating certificates
Related topics:
Bypassing verification, page 164
Keeping revocation information up to date, page 165
Important
If you disable the CVE, you need to provide settings on
only the following pages:
Configure > SSL > Decryption / Encryption > Inbound
Configure > SSL > Decryption / Encryption > Outbound
Configure > SSL > Customization > Connection Error
3. Deny certificates where the common name does not match the URL: When
enabled, two checks are made:
First, the certificate’s Common Name is checked for an exact match of the
destination URL.
If the first check fails, the certificate’s Subject Alternative Name (SAN) list is
checked for an exact match of the destination URL.
Checks are case insensitive.
Because an exact match is required, there may be instances when a legitimate
variation in the Common Name, or the absence of a matching variation in the
SAN, may result in a block.
For example, using “[Link] when attempting to access “https://
[Link]” may result in a block. Additionally, a block may occur when
accessing a site by IP address.
4. Allow wildcard certificates: This is a sub-option of When Deny Certificates
where the common name does not match the URL. When enabled, this option
allows matches with Common Names that include the “*” (wildcard) character in
the name.
Some HTTPS servers use a wildcard in the Common Name so that a single
certificate can cover an entire domain. For example: “*.[Link]” to cover
“[Link]” and “[Link]”, etc.
Use of the wildcard means that individual servers within the domain are not
verified; they are included as a result of the wildcard.
Allowing wildcard certificates eases the strict matching burden when a Common
Name match is required. It is also helpful for domains that have multiple
subdomains like [Link] or [Link]. It also introduces some risk that a
fraudulent or undesirable variation of a domain may go unblocked.
5. No expired or not yet valid certificates: When enabled, denies access to sites
that offer an expired or not yet valid certificate. This is a basic check that is
important because many malicious sites operate with expired certificates. If this
option is not selected, access to those sites is permitted.
Note
Self-signed certificates (certificates without an official
certificate authority) are considered invalid and belong in
this category.
6. Verify entire certificate chain: When enabled, verifies expiration and revocation
status of all certificates between the site certificate and the root Certificate
Authority as specified in the certification path of the certificate. This is an
important check.
7. Check certificate revocation by CRL: Certificate revocation lists (CRLs) are
used to check a certificate’s revocation status. CRLs list certificates that have been
issued and subsequently revoked by the CA.
Verifying the revocation status is a basic check that is very important because
certificates are revoked when they are improperly issued, have been
compromised, have a false identity, or violate policies specified by the CA.
If this option is enabled, it is recommended that you verify that the daily CRL
update feature is enabled. Go to the Revocation Settings tab and enable the check
box in CRL Settings.
If this option is not used, it is recommended that you disable the daily CRL update
feature. Go to the Revocation Settings tab and disable the check box in CRL
Settings.
8. Check certificate revocation by OCSP: Online Certificate Status Protocol
(OCSP) is an alternate way to check a certificate’s revocation status. While OCSP
is beneficial, it is not used as widely as CRLs and therefore is not as reliable. Also,
it is a real-time, Internet-hosted check that can introduce some request handling
latency.
Note
It is recommended that you use OCSP in addition to, rather
than instead of, CRLs. See Keeping revocation
information up to date, page 165 for more information on
CRLs and OCSP.
11. Block certificates with no CRL URI and with no OCSP URI: When CRL
checking, OCSP checking, or both are enabled, use this option to block
certificates that do not have the expected, associated URIs. For example, if only
CRL checking is enabled and the certificate doesn’t have a CRL URI, if this
option is enabled the connection is blocked. When both CRL and OCSP checking
are enabled, the block occurs only if both CRL and OCSP lack a URI.
You can view URI information in the certificate when you select to view the
certificate in your browser. See View a certificate, page 156 for details.
Because many certificates do not include CRL or OCSP information, this option
can result in a high number of verification failures. Often the failures are reported
as “Unknown revocation state” errors.
This can result in a highly restrictive security policy, with many access denials.
As with all verification failures, you can allow for exceptions using the Incident
List. See Managing HTTPS website access, page 166.
Bypassing verification
Use the Configure > SSL > Validation > Verification Bypass page to allow users to
visit a site when certificate verification fails.
1. Select Permit users to visit sites with certificate failure after confirmation to
enable users to proceed to a site after they have been informed that the site has an
invalid certificate. This is referred to as verification bypass. If this check box is
not selected, users do not have the option to browse to the site.
2. If verification bypass is enabled, you can specify a period of time, in minutes, that
the user is allowed to bypass a particular site without having to click-through the
warning again. Specify that period in the Time before the user is notified again
for the site entry field. The default is 6 minutes.
3. Select Enable the SSL session cache for bypassed certificates to store
information about bypassed certificates in cache and reuse the connections.
If this option is selected, not all users are notified that they are trying to access
a site where verification has failed.
If this option is not selected, all users are notified about sites that do not have
valid certificates.
It is recommended that you deploy initially with bypass verification enabled. Then, as
the incident rate changes, you can use the Incident List to enforce policy. See
Managing HTTPS website access, page 166.
It is recommended that before your site accepts certificates, it checks the status of the
certificate to ensure that it has not been revoked. There are two methods of doing this:
through CRLs (see Certificate revocation lists, page 165) and through OCSP (see
Online certification status protocol (OCSP), page 165).
Note
The CRL files can contain thousands of certifications, so
downloading CRLs can take some time and consume CPU
resources. It is recommended that you download CRLs at a
time when Internet traffic on your system is light.
2. Click View CRL Update Progress to see the status of the update.
For more information on certificate revocation lists, see RFC 3280.
Use Configure > SSL > Validation > Revocation Settings to configure how Content
Gateway keeps revocation information current.
1. Specify, in days, how long OCSP data should be cached. If you do not want to
cache OCSP data, enter 0. The maximum is 1000 days
2. Click Apply.
For more information on OCSP, see RFC 2560.
Related topics:
Viewing incidents, page 166
Changing the status of an incident, page 168
Deleting an incident, page 169
Changing the text of a message, page 169
Viewing incident details, page 169
Adding websites to the Incident List, page 170
These tabs can help you manage access to websites and can aid the HelpDesk in
troubleshooting access issues.
When a client receives an access denial message because the website does not comply
with security policy, Content Gateway generates an incident. See Viewing incidents,
page 166.
If you want to specify how Content Gateway treats a particular site, you can add that
to the Incident List as well. See Adding websites to the Incident List, page 170.
Additional information on troubleshooting can be found in SSL Certificate
Verification Engine v7.8.
Viewing incidents
Help | Content Gateway | Version 8.1.x
Use the Configure > SSL > Incidents > Incident List page to see a report of those
times when clients received an access denial message.
A separate Incident List is kept for every node in a cluster. Incidents that are added or
modified by the administrator, are copied around the cluster (synchronized).
Unexpected incidents that, by default, result in an access denial message, are not
synchronized in the cluster.
You can use the fields in this report to specify how Content Gateway treats requested
access to a site in the future.
To view a specific incident in the local list, enter the ID number or URL and click
Search Node.
If the node is part of a cluster and you want see all instances of the ID or URL, in
all lists, click Search Cluster.
After viewing a search, to restore the complete local list, click Show All in Node.
When the list is very large, Show All displays only the first 2,500-3,000 records.
Use the scroll bar to scroll through the list. Use the ‘>’ and ‘<’ buttons to view the
next or previous page.
Field Description
Node The name of the Content Gateway node on which the list
entry is located.
ID Assigned by the system, this is the incident ID number,
also called the Ticket ID. The HelpDesk can ask the user
for the Ticket ID in the error message and quickly
retrieve it from the URL Incident List.
The end user sees the Ticket ID and a denial message.
Field Description
Status Determines how Content Gateway will treat this website
in the future. Four conditions are possible:
Allow
When you change the status of an incident, you are changing how Content Gateway
will treat the listed URL in the future.
Deleting an incident
Help | Content Gateway | Version 8.1.x
1. Go to Configure > SSL > Incidents > Incident List.
2. Select the incident to delete. If the incident is not visible, you can search by ID.
See Viewing incidents, page 166.
3. In the Action column, select Delete from the Action drop-down list, and then click
OK.
If it is necessary or convenient, the entire Incident List can be deleted using a sqlite3
command:
sqlite3 /opt/WCG/config/new_scip3.db "delete from
certificate_acl;"
Use Configure > SSL > Incidents > Add Website to specify sites that you want to
allow, blacklist, or tunnel. Sites that are added manually are assigned chronological
Ticket IDs. These appear on the Incident List. See Viewing incidents, page 166.
1. Enter the URL of the site you are adding to the Incident List.
Note
When specifying an IPv6 address, do not enclose the
address in square brackets ([]).
Tunnel: (Valid for By URL only) The site is tunneled. Traffic is not decrypted
and Content Gateway does not check the certificate.
Important
Tunnel by URL does not work for all transparent proxy
requests.
It works under these conditions:
When the client application uses TLS and includes an
SNI (server name indication), Content Gateway
checks the Incident list for the hostname in the SNI.
When there is no SNI, Content Gateway connects to
the origin server to retrieve the certificate. If the
Common Name is a unique FQDN, Content Gateway
looks it up in the Incident list. If the Common Name
contains a “*” (wildcard), or is not a unique FQDN,
Content Gateway looks for the IP address in the
Incident list.
Alternatively, use ARM Static bypass rules.
Allow: Users can access the site even if the certificate is not valid. Traffic is
decrypted, and certificate checking is disabled.
Blacklist: The site is completely blocked. Users cannot access this site even if
the Verification Bypass is configured.
4. Click Apply.
It is recommended that you manually add sites to the Incident List after you have
monitored your network traffic for a period of time with the CVE disabled. (See
Configuring validation settings, page 161.) This enables you to improve performance
by tunneling trusted sites and blocking those you know should not be accessed. See
The incident report, page 167 for information about assigning a status, such as
tunneling, to a site and incident.
Client certificates
Related topics:
Importing client certificates, page 172
When a client certificate is always required: the Hostlist, page 172
Deleting client certificates, page 173
Use Configure > SSL > Client Certificates > Import to import certificates from the
organization represented by the client.
Important
Use only X.509-formatted, base64-encoded certificates.
Use Configure > SSL > Client Certificates > Hostlist to list destination servers that
always require a client certificate. Be sure to import the certificate before adding it to
the Hostlist. See Importing client certificates, page 172.
1. Enter the URL of the destination server that requires the client certificate.
2. In the Client Certificate drop-down list, select the name of the client certificate.
Only certificates you have already imported appear in this list.
3. Click Add.
Important
For browsers that don’t send a Server Name Indicator
(SNI), such as Internet Explorer version 8 and earlier,
create an entry for both the destination IP address and the
hostname.
Use Configure > SSL > Client Certificates > Manage Certificates to delete
imported client certificates.
1. Select the certificate you want to delete.
2. Click Delete.
Use Configure > SSL > Customization > Certificate Failure to customize the
message users receive when certificate validation fails.
Note
You may find it helpful to click Preview to see how the
default message appears.
There is a known problem in Internet Explorer 10 that
sometimes results in the wrong block page being
displayed. To work around the problem, click on Preview
repeatedly until the correct page is displayed, or disable
TLS 1.0 in Internet Explorer 10.
1. Edit the HTML code in the window to reflect your message. See Customizing SSL
connection failure messages, page 173 for a listing of variables you can use in the
message.
2. Click Preview to see your changes.
3. Repeat steps 1 and 2 until the message appears appropriately.
4. Click Apply to confirm your edits or Cancel to return to the original message.
Use Configure > SSL > Customization > Connect Error to customize the message
users receive when Content Gateway is unable to connect to the destination web
server.
Note
You may find it helpful to click Preview to see how the
default message appears.
There is a known problem in Internet Explorer 10 that
sometimes results in the wrong block page being
displayed. To work around the problem, click on Preview
repeatedly until the correct page is displayed, or disable
TLS 1.0 in Internet Explorer 10.
1. Edit the text in the window to reflect your message. See Customizing SSL
connection failure messages, page 173 for a listing of variables you can use in the
message.
2. Click Preview to see your changes.
You can configure Content Gateway to allow only certain clients to use the proxy.
To allow access, specify client IP addresses and IP address ranges in ip_allow.config.
To deny access, do not include those client IP addresses in the file.
1. Navigate to the Configure > Security > Connection Control > Proxy Access
page.
2. Click Edit File to open the configuration file editor for the ip_allow.config file.
3. Enter information in the fields provided, and then click Add. The fields are
described in Configuration Options.
4. Click Apply to save the information, and then click Close.
Note
If an unauthorized client tries to access Content Gateway, a
message is displayed in their browser, indicating that the
requested content cannot be obtained.
You can restrict access to the Content Gateway manager to ensure that only
authenticated users can change configuration options and view performance and
network traffic statistics.
You can:
Set the master administrator ID and password. A user who logs on to the Content
Gateway manager with the administrator ID has access to all Content Gateway
manager activities. See Setting the administrator ID and password, page 178.
Create and maintain a list of user accounts that determines who can log on to the
Content Gateway manager and which activities they can perform. See Creating a
list of user accounts, page 179.
Create an access control list of IP addresses that defines which machines can
access the Content Gateway manager. See Controlling host access to the Content
Gateway manager, page 180.
Use SSL for secure administration. See Using SSL for secure administration, page
180.
Require administrators to log on to the TRITON Manager, with or without two-
factor authentication, and then use the Content Gateway access page in the Web
module of the TRITON Manager to log on to the Content Gateway manager. See,
Accessing the Content Gateway manager, page 11
During installation, you assign a password that controls administrative access to the
Content Gateway manager. A user who logs on to the Content Gateway manager using
the correct ID and password can view all the statistics on the Monitor tab and change
any configuration options on the Configure tab.
You can change the administrator ID and password at any time.
1. Navigate to the Configure > My Proxy > UI Setup > Login tab.
2. To change the current administrator ID, type a new ID in the Login field of the
Administrator section.
3. To change the current password, type the current password in the Old Password
field. Type the new password in the New Password field, and then retype the new
password in the New Password (Retype) field.
Passwords must be 8 to 15 characters and include at least one:
Uppercase character
Lowercase character
Number
Special character
Supported characters include:
! #%&'()*+,- ./;<=>?@[ ]^_ {|}~
The following special characters are not supported:
Space $ : ` \ "
If you have forgotten the current administrator password, see Accessing the
Content Gateway manager if you forget the master administrator password, page
15.
4. Click Apply.
If a single administrator ID and password for the Content Gateway manager is not
sufficient security for your needs, you can create a list of user accounts that define
who has access to the Content Gateway manager and which activities they can
perform.
1. Navigate to Configure > My Proxy > UI Setup > Login.
2. Enter the name of the user allowed to access the Content Gateway manager.
3. Enter the password for the user, and then enter the password again in the New
Password (Retype) field.
Passwords must be 8 to 15 characters and include at least one:
Uppercase character
Lowercase character
Number
Special character
Supported characters include:
In addition to using an administrator ID and user accounts, you can control which
hosts have access to the Content Gateway manager.
1. Navigate to Configure > My Proxy > UI Setup Access.
2. In the Access Control area, click Edit File to open the configuration file editor for
the mgmt_allow.config file.
3. Enter information in the fields provided, and then click Add. All the fields are
described in UI Setup, page 307.
4. Click Apply, and then click Close.
Websense supports the Secure Sockets Layer protocol (SSL) to provide protection for
remote administrative monitoring and configuration using the Content Gateway
manager. SSL security provides authentication of both ends of a network connection
using certificates, and provides privacy using encryption.
To use SSL you must:
Obtain an SSL certificate
Enable the Content Gateway manager SSL option
You can obtain an SSL certificate from a recognized certificate authority (for example,
VeriSign) or, if you use Active Directory Certificate Services, you can generate a
certificate using Certificate Services and a script provided with your Content Gateway
software. (See Creating an SSL Certificate for Content Gateway manager with
Active Directory Certificate Services.)
Install the certificate in the Content Gateway config directory (/opt/WCG/bin). You
must either rename the certificate to the default filename private_key.pem, or specify
the name of the certificate in the Content Gateway manager (follow the procedure in
Enabling SSL, page 181).
Enabling SSL
Help | Content Gateway | Version 8.1.x
After you have obtained an SSL certificate, you can enable SSL.
1. Navigate to the Configure > My Proxy > UI Setup > General tab.
2. Enable the HTTPS option.
3. In the Certificate File field, specify the filename of the SSL certificate.
You have to change the file name only if the certificate file does not use the
default name private_key.pem.
4. Click Apply.
Warning
Once the FIPS 140-2 option is enabled, you cannot disable
it without a complete reinstall of Content Gateway. If
Content Gateway is on an appliance, the appliance must be
reimaged.
Important
Where TRITON AP-WEB interfaces with some TRITON
Enterprise components, there may be a FIPS 140-2
boundary. These include:
In TRITON AP-WEB, traffic that flows through the
cloud does not use FIPS 140-2.
Traffic to the file sandbox does not use FIPS 140-2.
TRITON AP-DATA does not use FIPS 140-2.
TRITON AP-MOBILE does not use FIPS 140-2.
TRITON Mobile Security does not use FIPS 140-2.
When RSA SecurID is configured for the TRITON
Manager logon, the connection to RSA SecurID is not
FIPS 140-2.
Important
Due to a system limitation, FIPS 140-2 mode cannot be
used with IWA fallback to NTLM or Legacy NTLM user
authentication.
4. If you do not want to enable FIPS, select Disable and click Apply.
Note
Even after FIPS 140-2 mode is enabled, by default SHA-1
certificates continue to be used for logon to TRITON
management consoles. To learn about how to create and
install stronger SHA certificates, see: How do I create a
stronger SHA certificate for Websense management
consoles?
Filtering Rules
Content Gateway supports the ability to create rules that inspect requests for certain
parameters and, when matched, apply a specified action. Rules can be created to:
Deny or allow URL requests
Insert custom headers
Allow specified applications, or requests to specified websites to bypass user
authentication
Keep or strip header information from client requests
Prevent specified applications from transiting the proxy
Note
To create rules for IWA, NTLM, and LDAP user
authentication, see Rule-Based Authentication, page 213.
To get started with Content Gateway user authentication
options, see Content Gateway user authentication, page
191.
Filtering rules are created and modified on the Configure > Security >
Access Control > Filtering tab. Rules are stored in the [Link] file.
Rules are applied in the order listed, top to bottom. Only the first match is applied. If
no rule matches, the request proceeds.
Secondary specifiers are optional. More than one secondary specifier can be used in a
rule. However, you cannot repeat a secondary specifier.
Three filtering rules are configured by default. The first denies traffic on port 25 to all
destinations. The second and third bypass user authentication for connections to 2
Websense file sandbox destinations.
After adding, deleting, or modifying a rule, restart Content Gateway.
See [Link] for information about the structure of stored rules.
Note
The “radius” rule type is not supported.
3. Select a Primary Destination Type and then enter a corresponding value in the
Primary Destination Value field. Primary Destination Types include:
dest_domain — a requested domain name. The value is a domain name.
dest_host — a requested hostname. The value is a hostname.
dest_ip — a requested IP address. The value is an IP address.
url_regex — a regular expression to be found in a URL. The value is a regular
expression.
4. If the Primary Destination Type is keep_hdr or strip_hdr, select the type of
information to keep or strip from the Header Type drop down list. Options
include:
• date
• host
• cookie
• client_ip
5. If the rule applies to only inbound traffic on a specific port, enter a value for
Proxy Port.
6. If the rule type is add_hdr, specify the Custom Header and Header Value. The
Custom Header and Header Value must be values that the destination host
expects. See the example for Google Business Gmail below.
7. Provide values for any required or desired Secondary Specifiers. They include:
Time — Specifies a time range, such as 08:00-14:00.
Prefix — Specifies a prefix in the path part of a URL.
Editing a rule
1. Go to Configure > Security > Access Control > Filtering and click Edit File to
open [Link] in the file editor.
2. In the list, select the rule to be modified and change the values as desired.
3. Click Set to update the rule and click Apply to save the rule.
4. Click Close to close the edit window.
2. In the Content Gateway manager enable HTTPS (SSL decryption). If your site
does not already use SSL support, acquaint yourself with the feature before
enabling it.
3. In the Content Gateway manager, on the Configure > Security > Access Control
page, open [Link] and create an add_hdr rule.
Note
The add_hdr rule type can be used with any site that uses
a custom header-value pair to accomplish special handling.
a. Select add_hdr.
b. For Primary Destination Type select dest_domain.
c. For Primary Destination Value specify “[Link]”.
d. In the Custom Header field, specify “X-GoogApps-Allowed-Domains”.
e. In the Header Value field, specify your domain, or a list of domains separated
by commas. For example: [Link],[Link]
f. Optionally, in the Source IP field specify the source IP address or range of
source IP addresses to which this rule will be applied. For example:
[Link] or [Link]-[Link]
g. Click Add to add the rule.
h. Click Apply to save all the changes, and then click Close to close the edit
window.
When a user attempts to access Google services from an unauthorized account,
Google displays a block page similar to this:
For Google’s description of the filtering solution, see the article Block access to
consumer accounts and services while allowing access to Google Apps for your
organization.
Related topics:
Configuring SOCKS servers, page 188
Setting SOCKS proxy options, page 189
Setting SOCKS server bypass, page 190
Note
Content Gateway does not perform authentication with the
client. However, Content Gateway can perform user name
and password authentication with a SOCKS server running
SOCKS version 5.
Content Gateway can be configured to work with one or more SOCKS servers in your
network. When Content Gateway is installed on a V-Series appliance, a SOCKS
server is included with the module.
Note
When Content Gateway is not installed on a V-Series
appliance, no SOCKS server is provided with Content
Gateway.
You can always return to the editor, select the rule, make changes, and click
Set to save them.
5. If there are multiple SOCKS servers, after they have been added, or while they are
being added, you can arrange them in precedence-order by selecting an entry and
moving it up or down the list with the up and down arrows.
6. Click Apply to accept your changes, and Close to close the editor.
7. In the SOCKS Server Rules area you can create rules for specific routing and
bypass by destination IP address. See, Setting SOCKS server bypass, page 190.
8. To review configuration options that apply to all SOCKS servers, select the
Options tab.
a. Review and adjust the Server Connection Timeout value. It specifies how
many seconds Content Gateway waits attempting to connect to a SOCKS
server before timing out.
b. Review and adjust the Connection Attempts Per Server value. It specifies
how many times Content Gateway attempts to connect to a given SOCKS
server before marking the server as unavailable.
c. Review and adjust the Server Pool Connection Attempts value. It specifies
how many times Content Gateway attempts to connect to a given SOCKS
server in the pool before giving up.
9. When SOCKS server configuration is complete, click Apply and then go to
Configure > My Proxy > General and restart Content Gateway.
To remove a server from the list:
1. In the SOCKS Server area click Edit File.
2. In the list, select the entry you want to delete and click X, to the left of the list.
3. Click Apply and then Close, when you’re ready to exit the editor.
4. When configuration is complete, go to Configure > My Proxy > General and
restart Content Gateway.
To configure Content Gateway as a SOCKS proxy, you must enable the SOCKS proxy
option and specify the port on which Content Gateway accepts SOCKS traffic from
SOCKS clients.
As a SOCKS proxy, Content Gateway can receive SOCKS packets (usually on port
1080) from the client and forward requests directly to the SOCKS server.
Note
You must set SOCKS proxy options in addition to
enabling the SOCKS option and specifying SOCKS server
information described in Configuring SOCKS servers,
page 188.
You can configure Content Gateway to bypass SOCKS servers and access certain
origin servers directly.
1. Navigate to Configure > Security > SOCKS > Server. In the SOCKS Server
Rules area click Edit File to open [Link].
2. To modify an existing rule, select it from the list, make your changes, and click
Set.
3. To create a new rule, specify the parameters and click Add.
a. Select a Rule Type:
Route through SOCKS server
Do not route through SOCKS server
b. Specify a destination IP address or range of addresses. Never specify the all
networks broadcast address: [Link]
c. Select the SOCKS servers to be used for the traffic.
d. Select whether the traffic will be distributed to the specified SOCKS servers
in round robin fashion.
e. Click Add to add the rule.
4. Click Apply and then Close.
5. Click Restart on Configure > My Proxy > Basic > General.
You can configure Content Gateway to use multiple DNS servers, depending on your
security requirements. For example, you can configure Content Gateway to look to
one set of DNS servers to resolve host names on your internal network, while allowing
DNS servers outside the firewall to resolve hosts on the Internet. This maintains the
security of your intranet, while continuing to provide direct access to sites outside
your organization.
To configure Split DNS, you must perform the following tasks:
Specify the rules for performing DNS server selection based on the destination
domain, the destination host, or a URL regular expression.
Enable the Split DNS option.
In the Content Gateway manager:
1. Go to the Configure > Networking > DNS Resolver > Split DNS tab.
2. Enable the Split DNS option.
3. In the Default Domain field, enter the default domain for split DNS requests.
Content Gateway appends this value automatically to a host name that does not
include a domain before determining which DNS server to use.
4. In the DNS Servers Specification area, click Edit File to open the configuration
file editor for the [Link] file.
5. Enter information in the fields provided, and then click Add. All the fields are
described in [Link].
6. Click Apply, and then click Close.
7. On the Split DNS tab, click Apply to save your configuration.
8. Click Restart on Configure > My Proxy > Basic > General.
Related topics:
Browser limitations, page 194
Global authentication options, page 194
Integrated Windows Authentication, page 199
Legacy NTLM authentication, page 204
LDAP authentication, page 207
RADIUS authentication, page 210
Rule-Based Authentication, page 213
Mac and iPhone/iPad authentication, page 236
during Windows logon are used for proxy authentication and the user is not prompted
again for a username and password.
[Interactive authentication is supported in networks that are not configured for Single
Sign-On and for use with browsers that don’t support Single Sign-On. With interactive
authentication, users are prompted for credentials before they can access content
through Content Gateway.
Browser limitations
Help | Content Gateway | Version 8.1.x
Note
Please see the Web Protection Solutions Release Notes
for the most up-to-date information.
Use the Configuration > Security > Access Control > Global Authentication
Options page to configure:
Fail Open
Fail Open specifies whether requests are allowed to proceed for processing when user
authentication fails.
When Fail Open is enabled and a TRITON AP-WEB XID agent is configured, if
authentication fails and the client is identified by the XID agent, user-based policy is
applied. If the user cannot be identified and a policy is assigned to the client’s IP
address, that policy is applied. Otherwise, the Default policy is applied.
Important
The Fail Open setting does not apply when IWA is the
authentication method and the client fails to retrieve a
kerberos ticket from the domain controller (DC) because
the DC is down.
The Fail Open setting does apply with IWA when IWA
falls back to NTLM.
Options include:
Disabled – specifies that requests do not proceed when authentication failures
occur.
Enabled only for critical service failures (default) – specifies that requests
proceed if authentication fails due to:
No response from the domain controller
The client is sending badly formatted messages
Important
When user authentication is rule-based with a domain list:
If Enabled only for critical service failures is
selected, when a critical service failure occurs fail
open is not applied. An error always results in fail
closed.
If Enabled for all authentication failures, including
incorrect password is selected, after trying basic
credentials with every domain in the list, fail open is
applied.
Credential Caching
Credential Caching options include:
Caching Method
Cache Time-To-Live (TTL), in minutes
LDAP Specific Settings
Credential caching settings apply to all clients whether Content Gateway is an explicit
or transparent proxy.
Credential caching applies to:
All authentication methods when Content Gateway is a transparent proxy
When Content Gateway is an explicit proxy:
NTLM when Integrated Windows Authentication (IWA) falls back to or
negotiates NTLM
Legacy NTLM
When IWA authenticates with Kerberos, Kerberos handles ticket (credential) caching.
all other IP addresses. This is recommended when the network has a mix of clients,
some with unique IP addresses and some using multi-user hosts or that are subject to
NATing.
The cookie caching list is a comma separated list that can contain up to:
64 IPv4 addresses
32 IPv4 address ranges
24 IPv6 addresses
12 IPv6 address ranges
For a description of surrogate credentials, see Surrogate credentials.
Important
Cookie mode caching:
Cookie mode caching does not work with applications
that do not support cookies, or with browsers in which
cookie support has been disabled.
When the browser is Internet Explorer, the full proxy
hostname in the form “[Link] must
be added to the Local intranet zone.
When the browser is Chrome, it must be configured to
allow third-party cookies or configured for an
exception to allow cookies from the proxy hostname in
the form “[Link]”.
When the IP address is set for cookie mode and the
request method is CONNECT, no caching is
performed.
Cookie mode caching is not performed for FTP
requests.
Cookie mode caching is supported by Captive Portal.
Note
The user interface setting to disable the NTLM cache for
explicit proxy has been removed. Although not
recommended, the cache can be disabled for explicit proxy
traffic in [Link] by setting the value of
[Link] to 0 (zero).
Cache Time-To-Live
Cache Time-To-Live (TTL) specifies the duration, in minutes, that an entry in the
cache is retained. When the TTL expires, the entry is removed and the next time that
that user submits a request, the user is authenticated. If the authentication succeeds, an
entry is placed in the cache.
The default TTL is 15 minutes. The range of valid values is 5 to 1440 minutes.
Redirect Hostname
Redirect Hostname specifies an alternate hostname for the proxy.
Note
Redirect Hostname is not used by Integrated Windows
Authentication.
Note
To ensure that user authentication for transparent proxy
occurs transparently (without prompting the user for
credentials), the browser must be configured so that the
Redirect Hostname is in its Intranet Zone. Typically, this
is achieved by ensuring that the Redirect Hostname is in
the same domain as the computer on which the browser is
running. For example, if the client is
[Link] and the Redirect Hostname is
[Link], the browser allows
authentication to occur transparently. Consult your
browser documentation.
Note
Content Gateway supports transparent authentication in
proxy clusters that use WCCP load distribution. However,
the assignment method distribution attribute must be
the source IP address. For more information see WCCP
load distribution, page 53.
Surrogate credentials
Surrogate credentials are entries placed in the credential cache after initial successful
authentications.
a. In the Domain Name field, enter the fully qualified domain name.
b. In the Administrator Name field enter the Windows Administrator user
name.
c. In the Administrator Password field enter the Windows Administrator
password.
The name and password are used only during the join and are not stored.
d. Select how to locate the domain controller:
• Auto-detect using DNS
• DC name or IP address
If the domain controller is specified by name or IP address, you can also
specify backup domain controllers in a comma separated list, no spaces.
e. In the Content Gateway Hostname field, confirm that the hostname is the
correct hostname and that it is no more than 15 characters (no more than 11
characters on V-Series appliances). If it is longer, it must be shortened if IWA
is to be used. The length restriction results from the 15 character limit on
NetBIOS hostnames.
Warning
Do not change the hostname after the domain is joined. If
the hostname is changed, IWA immediately stops working
and will not work again until the domain is unjoined and
then re-joined with the new hostname.
f. Click Join Domain. If there is an error, ensure that the conditions outlined
above are met and then see Failure to join the domain.
Important
All clients subject to authentication must be joined to the
domain.
Browsers and other proxy clients must be configured to
specify the FQDN of Content Gateway as an intranet site
or trusted site.
g. Restart Content Gateway and run some test traffic through the proxy to verify
that authentication is working as expected. If there is a problem, see
Troubleshooting Integrated Windows Authentication.
Important
After upgrade, check and, if necessary, rejoin IWA
domains.
The Content Gateway FQDN must be in DNS and resolvable by all proxy clients.
Browsers and other client applications must specify the FQDN of Content
Gateway as an intranet site or trusted site.
When the Active Directory is configured with multiple Sites, the subnet that
Content Gateway is on must be added to one of them. If it’s not, the following
alarm may be generated when Content Gateway is restarted:
Windows domain [domain name] unreachable or bad membership
status
Troubleshooting:
In the Content Gateway manager, use the Diagnostic Test function on the Monitor >
Security > Integrated Windows Authentication tab. This Monitor page displays
authentication request statistics and provides the diagnostic test function.
The Diagnostic Test function performs connectivity and authentication testing and
reports errors. It also shows domain controller TCP port connectivity and latency.
Errors and messages are logged to:
/var/log/messages
content_gateway.out
/opt/WCG/logs/[Link]
/opt/WCG/logs/[Link]
Performance issues:
IWA (Kerberos): Authentication performance is bound by CPU. There is no
communication to the domain controllers for Kerberos authentication.
NTLM and Basic: Domain controller responsiveness effects performance. The
Monitor > Security > Integrated Windows Authentication page shows average
response time.
Content Gateway supports the NTLM (NT LAN Manager) authentication protocol as
a method of ensuring that users in a Windows network are authenticated before they
access the Internet.
Important
This implementation of NTLM support (Legacy NTLM)
relies solely on the NTLMSSP protocol. Although it
performs reliably as documented in this section, it is highly
recommended that the Integrated Windows Authentication
mode be used instead. It provides more robust and secure
support for NTLM.
Important
If rule-based authentication will be used, configure Legacy
NTLM authentication through the Rule-Based
Authentication option.
However, read this section to become familiar with Legacy
NTLM features and restrictions.
When the Legacy NTLM option is enabled, the proxy challenges users who request
content for proof of their credentials. The proxy then sends the proof of the user’s
credentials directly to the Windows domain controller to be validated. If the
credentials are valid, the proxy serves the requested content and stores the credentials
in the NTLM cache for future use. If the credentials are not valid, the proxy sends an
authentication failed message.
Restrictions:
1. WINS resolution is not supported. Domain controllers must have host names that
can be resolved by a DNS server.
2. Extended security is not supported and cannot be enabled on the domain
controller.
3. NTLM2 session security is not supported and cannot be enabled on clients. In the
Security Settings area of the Windows operating system, inspect the Network
Security: Minimum session security settings.
4. NTLMv2 is not supported with Active Directory 2008. The required Network
Security: LAN Manager Authentication setting is described in step 5 of
Configuring NTLM proxy authentication, below.
5. Not all browsers support transparent NTLM authentication. See Browser
limitations, page 194.
If you are using Legacy NTLM with rule-based authentication, see Rule-Based
Authentication, page 213, for configuration steps.
2. In the Authentication section, click Legacy NTLM On, and click Apply.
3. Configure the Global authentication options.
4. Go to Configure > Security > Access Control > Legacy NTLM.
5. In the Domain Controller Hostnames field, enter the hostname of the primary
domain controller, followed, optionally, by a comma separated list of backup
domain controllers. The format of the hostname must be:
host_name[:port][%netbios_name]
or
IP_address[:port][%netbios_name]
Note
If you are using Active Directory 2008, you must include
the netbios_name or use SMB port 445. If you do not use
port 445, you must ensure that the Windows Network File
Sharing service is running on the Active Directory server.
See your Windows Server 2008 documentation for details.
Note
If you are using Active Directory 2008, in the Windows
Network Security configuration, LAN Manager
Authentication level must be set to Send NTLM
response only. See your Windows Server 2008
documentation for details.
6. Enable Load Balancing if you want the proxy to balance the load when sending
authentication requests to multiple domain controllers.
Note
When multiple domain controllers are specified, even if
load balancing is disabled, when the load on the primary
domain controller reaches the maximum number of
connections allowed, new requests are sent to a secondary
domain controller as a short-term failover provision, until
such time that the primary domain controller can accept
new connections.
7. Click Apply and restart Content Gateway (Configure > My Proxy > Basic >
General).
Optionally, you can configure Content Gateway to allow certain clients to access
specific sites on the Internet without being authenticated by the NTLM server; See
Access Control, page 337).
LDAP authentication
Help | Content Gateway | Version 8.1.x
Content Gateway supports the LDAP option to ensure that users are authenticated
with an LDAP server before accessing content through the proxy.
Important
If rule-based authentication will be used, configure LDAP
authentication through the Rule-Based Authentication
option. However, read this section to become familiar with
LDAP features and restrictions.
7. Enable Secure LDAP if you want the proxy to use secure communication with
the LDAP server. Secure communication is performed on port 636 or 3269.
Change the port value in the previous field, if necessary.
8. Select the type of directory service to set the filter for searching.
Microsoft Active Directory sets the type to sAMAccountName (default).
Other sets the type to uid for eDirectory or other directory services.
9. Enter the Bind Distinguished Name (fully qualified name) of a user in the
LDAP-based directory service. For example:
CN=John Smith,CN=USERS,DC=MYCOMPANY,DC=COM
Enter a maximum of 128 characters in this field.
If no value is specified for this field, the proxy attempts to bind anonymously.
10. Enter a password for the user specified in the previous step.
11. Enter the Base Distinguished Name (DN). Obtain this value from your LDAP
administrator.
12. Click Apply.
13. Click Restart on Configure > My Proxy > Basic > General.
As optional steps, you can:
Change LDAP cache options. See Setting LDAP cache options, page 208.
Configure Content Gateway to allow certain clients to access specific sites on the
Internet without being authenticated by the LDAP server. See Access Control,
page 337).
Variable Description
[Link] Specify the number of entries
allowed in the LDAP cache.
The default value is 5000. The
minimum value is 256.
[Link].ttl_value Specify the number of minutes
that Content Gateway can
store username and password
entries in the LDAP cache.
[Link]. Specify the maximum amount
storage_size of space (in bytes) that the
LDAP cache can occupy on
disk.
When modifying this value,
you must update the value of
[Link]
proportionally. For example, if
you double the storage size,
also double the cache size.
Modifying this variable
without modifying
[Link]
causes the LDAP subsystem to
stop functioning.
3. Navigate to Configure > Security > Access Control > LDAP and change the
port to 3269.
Note
The Directory Service must be configured to support
LDAPS authentication. See to the documentation provided
by the directory provider for instructions.
RADIUS authentication
Help | Content Gateway | Version 8.1.x
Content Gateway supports the RADIUS option to ensure that users are authenticated
with a RADIUS server before accessing content through the proxy.
When the RADIUS option is enabled:
Content Gateway acts as a RADIUS client and directly challenges users who
request content for a username and password.
After receiving the username and password, Content Gateway contacts the
RADIUS server to check that the credentials are correct.
If the RADIUS server accepts the username and password, the proxy serves
the client with the requested content and stores the username and password
entry in the RADIUS cache; all future authentication requests for that user are
served from the RADIUS cache until the entry expires.
If the RADIUS server rejects the username and password, the user’s browser
displays a message indicating that authorization failed and prompts again for
a username and password.
Content Gateway supports a primary RADIUS server and a secondary RADIUS
server for failover. If the primary server does not respond to the proxy request within
the specified timeout (60 seconds by default), Content Gateway tries to check the
username and password again. If a response from the primary RADIUS server is not
received after the maximum number of retries (10 by default), the proxy contacts the
secondary RADIUS server. If Content Gateway cannot contact the secondary
RADIUS server, the user is prompted again for a username and password.
The RADIUS cache is held in memory and stored on disk. Content Gateway updates
the data on disk every 60 seconds. In addition, Content Gateway stores username and
password entries in the RADIUS cache for 60 minutes. If a password and username
entry is expired in the RADIUS cache, Content Gateway contacts the RADIUS server
to accept or reject the username and password.
To configure Content Gateway to be a RADIUS client:
Enable the RADIUS option.
Specify the hostname or IP address of the primary and secondary (optional)
RADIUS servers, and the port and shared key that Content Gateway uses to
communicate with the RADIUS servers.
Note
In addition to performing these procedures, you must add
the Content Gateway machine as a trusted client on the
primary and secondary RADIUS servers and provide the
shared key you want to use for the Content Gateway
machine (the shared key must be the same one you specify
in the procedure below). See your RADIUS server
documentation.
Variable Description
[Link]. Specify the amount of time
min_timeout in seconds that the Content
Gateway connection to the
RADIUS server remains
idle before Content
Gateway closes the
connection.
[Link]. Specify the maximum
max_retries number of times Content
Gateway tries to connect to
the RADIUS server.
[Link] Specify the number of
entries allowed in the
RADIUS cache.
The minimum value is 256
entries. If you enter a value
lower than 256, Content
Gateway signals a SEGV.
[Link].ttl_value Specify the number of
minutes that Content
Gateway can store username
and password entries in the
RADIUS cache.
[Link]. Specify the maximum
storage_size amount of space that the
RADIUS cache can occupy
on disk.
This value must be at least
100 times the number of
entries. It is recommended
that you provide the
maximum amount of disk
space possible.
Rule-Based Authentication
Help | Content Gateway | Version 8.1.x
Related topics:
Global authentication options, page 194
Rule-based authentication Domain list, page 218
Creating an authentication rule, page 222
Working with existing authentication rules, page 225
Rule-based authentication use cases, page 226
Authentication based on User-Agent, page 229
Authentication using Captive Portal
Troubleshooting authentication rules, page 233
Note
If all the users in your network can be authenticated by
domain controllers that share trust relationships, you
probably don’t need rule-based authentication.
However, the option is well suited to single domain
environments that may benefit from multiple rules based
on IP addresses, inbound proxy port (explicit proxy), and/
or User-Agent values.
Note
Credential caching configuration is performed on the
Configure > Security > Access Control > Global
Configuration Options tab. On that page you specify IP
address caching, cookie caching, or both. The setting
applies to both transparent proxy and explicit proxy traffic.
When both IP address caching and cookie caching are
specified, the IP addresses that cookie caching is applied to
must be specified.
See Credential Caching for more information.
Logic:
One or more rules are defined for clients and domains (Configure > Security >
Access Control > Authentication Rules).
When a request for web content is received:
A top-down rule list traversal begins
The first match is applied
If the rule includes a list of domains, authentication proceeds as follows:
• The proxy attempts to authenticate with the first domain using the method
configured for that domain. For example, if the first domain is IWA,
Content Gateway transparently negotiates with the browser for credentials
(407 or 401).
• If authentication fails and Content Gateway hasn’t already challenged
(prompted) for credentials, it then prompts for credentials.
Exception: When Content Gateway is an explicit proxy, the first and
second domains are IWA, and the client has a ticket from the
authentication domain, there is no prompt for basic credentials. Instead,
Content Gateway uses the Kerberos ticket provided by the client to
attempt to authenticate with the second domain. If the attempt fails and
the fallback to NTLM authentication fails, the user is prompted for
credentials.
When Content Gateway is a transparent proxy the standard behavior
applies. This is because when the user is not a member of the first domain,
the request for a Kerberos ticket fails because the client does not trust the
FQDN sent with the request. The fallback to NTLM authentication also
fails and the user is prompted for credentials.
• Content Gateway then uses the basic credentials with each domain,
starting with the second, proceeding sequentially until authentication
succeeds or the list is exhausted.
• Content Gateway then uses the basic credentials to attempt, again, to
authenticate with the first domain.
Important
Content Gateway must be configured with a DNS server
that can resolve the fully qualified domain name (FQDN)
of Content Gateway for every realm used by IWA. If this
isn’t done, IWA fails to work. How to configure the DNS
server is up to the network administrator. One option is to
configure a DNS transfer zone (Sub Zone) between the
primary DNS server of Content Gateway and the DNS
server of each authentication realm (isolated domain).
Important
You must also configure your clients to use the correct
port.
2. Configure Global authentication options, page 194 (Configure > Security >
Access Control > Global Authentication Options).
3. Create a domain list (Configure > Security > Access Control > Domains).
• To specify a domain in a rule, it must be a member of the Domain List.
• Active Directory domains used with IWA must be joined.
Important
In rule-based authentication, Content Gateway may
authenticate users that are outside the User Service
primary domain. In these cases, Content Gateway can be
configured to send an “alias” user name that User Service
knows about. Or, you can send no name, in which case
standard Filtering Service precedence is applied to
determine the correct policy. (See Enforcement order in
Administrator Help for the Web module.) This
specification is made for each domain in the Domain list.
For more information, see Unknown users and the ‘alias’
option, below.
4. Create authentication rules (Configure > Security > Access Control >
Authentication Rules).
5. Restart Content Gateway to make the new rules take effect.
When an authenticated user name is not found by User Service, standard Filtering
Service precedence is used to determine correct policy. There are several ways to
address this:
Change the User Services configuration so that it can discover and add the names
to its directory.
Add the unrecognized names to the primary domain. The names must match
exactly. Define policies for the new names.
For users who match a particular authentication rule, pass an alias name and add
the alias name to the primary domain. The names must match exactly. Define a
policy for the alias name.
Do nothing, or select to use a blank (empty) alias. This causes standard Filtering
Service precedence to be applied to determine the correct policy. See
Enforcement order in Administrator Help for the Web module.
For some illustrative use cases, see Rule-based authentication use cases.
To use rule-based authentication, you create and maintain a Domain List. There must
be at least one domain on the list before an authentication rule can be defined.
When a domain is added to the list, the authentication method is specified.
When a rule is defined, the domain or domains are selected from the domain list.
Supported domain types include:
Active Directory (AD) domains to be used with IWA. These domains must be
joined by Content Gateway, as well as by its members (users).
Domain Controllers (DC) to be used with Legacy NTLM
AD and uid domain controllers and directory servers to be used with LDAP
Warning
Do not change the hostname after the domain is joined. If
it is changed, IWA immediately stops working and will not
work again until the domain is unjoined and then re-joined
with the new hostname.
To change the way the domain controller is found, and other attributes
1. On the Domains page, in the list select the domain you want to change and click
Edit.
2. In the IWA Domain Details section, select how to locate the domain controller:
Auto-detect using DNS
DC name or IP address
If the domain controller is specified by name or IP address, you can also
specify backup domain controllers in a comma separated list, no spaces.
3. You can also change the Aliasing setting. See Unknown users and the ‘alias’
option, page 217.
4. Click Apply.
Note
Even if load balancing is not selected, if multiple domain
controllers are specified and the load on the primary
domain controller reaches the maximum number of
connections allowed, new requests are sent to a secondary
domain controller as a short-term fail over provision, until
such time that the primary domain controller can accept
new connections.
3. In the Domain Identifier field, enter a unique name that will help you recognize
the domain and its purpose. After the domain is added, the name cannot be
changed.
4. Optionally, configure the Aliasing option. For information see: Unknown users
and the ‘alias’ option, page 217.
5. In the LDAP Domain Details section:
a. In the LDAP Server Name field, enter the fully qualified domain name or IP
address of the LDAP server.
b. If the LDAP server port is other than the default (389), in the LDAP Server
Port field, enter the LDAP server port.
c. Enter the LDAP Base Distinguished Name. Obtain this value from your
LDAP administrator.
d. Select the LDAP Server Type from the drop down list.
• Select sAMAccountName for Active Directory
• Select uid for other directory services
e. In the Bind Domain Name field, enter the bind distinguished name. This
must be a Full Distinguished Name of a user in the LDAP directory service.
For example:
CN=John Smith,CN=USERS,DC=MYCOMPANY,DC=COM
f. In the Bind Password field, enter the password for the name given in the
Bind Domain Name field.
g. Enable Secure LDAP if you want Content Gateway to use secure
communication with the LDAP server. If enabled, set the LDAP port to 636 or
3269.
6. Click Add Domain.
Warning
When a domain is removed, it is also removed from any
authentication rules that specify it.
If it is the only domain specified in a rule, when the
domain is removed the rule is made invalid and, therefore,
the rule is removed.
Note
In the Rule editor, after entering all specifiers, click Add
before clicking Apply. If Apply is clicked first, or the edit
window is closed, all entry fields are cleared.
The size of a rule cannot exceed 512 characters.
1. Go to Configure > Security > Access Control and review and adjust the Global
Authentication Options and Domains list.
2. If AD domains are used with IWA, go to Monitor > Security > Integrated
Windows Authentication and confirm that the IWA domains are joined and that
connections are established.
3. Go to Configure > Security > Access Control > Authentication Rules. A list of
existing authentication rules is displayed at the top of the page.
4. Click Edit File to open the rule editor.
5. If some rules have already been defined, note the order of the rules in the list at the
top of the page.
Important
Rule order matters. The rule match traversal is performed
top-to-bottom. Only the first match is applied.
6. Select Status Enabled if you want the rule to be active after the rule is added and
Content Gateway is restarted.
7. Enter a unique Rule Name (required). A short, descriptive name will help you
recognize the rule and its purpose. It is recommended that the name not exceed 50
characters.
8. If the rule applies to specific IP addresses, in the Source IP Addresses field, enter
a comma-separated list of individual IP addresses and/or IP address ranges. Do
not use spaces. For example:
[Link],[Link]-[Link]
The list can contain up to:
64 IPv4 addresses
32 IPv4 address ranges
24 IPv6 addresses
12 IPv6 address ranges
Source IP address ranges can overlap. Overlapping ranges may be useful as a
quick way of identifying sub-groups in a large pool. In overlapping ranges, the
first match is used.
If this field is empty (undefined), all IP addresses match.
9. If the rule applies to inbound traffic on a specific port, select the Proxy Port from
the drop down list. This option is valid with explicit proxy only.
Inbound ports are specified on the Configure > My Proxy > Protocols >
HTTP > General page in the Secondary HTTP Proxy Server Ports field. Client
applications must be configured to send requests to the desired port.
If undefined, all ports match. Transparent proxy deployments should leave the
field undefined.
10. To apply the rule to specific User-Agent values, enter POSIX-compliant regular
expressions (regex) to match the desired values. To specify a common browser
type, select a Predefined regex from the drop down list and click Include.
If undefined, all User-Agents match.
You can edit the field directly.
Use the “|” character (logical ‘or’) to separate regexes.
The “^” regex operator is not supported.
The regex is validated when the rule is committed to the configuration file, which
happens after clicking Add or Set and then Apply. If the regex is not valid, the
rule is deleted and must be recreated with a valid regex.
For an extended description and examples, see Authentication based on User-
Agent, page 229.
11. Specify the domain(s) to authenticate against.
a. From the Domains drop down list, select the applicable domain and click
Include. Only domains that have been added to the Domains list are available
(Configure > Security > Access Control > Domains).
b. If an ordered list of domains will be used, select each domain one at a time
and click Include. Then select domains in the list and use the up and down
arrows to achieve the desired order.
Important
The Fail Open/fail closed setting is applied after every
domain in the list is tried.
Warning
If a rule has invalid values, a warning message displays
that identifies the invalid rule. The rule in not written to the
file.
Use the rule editor in the Content Gateway manager. Do not directly edit
auth_rules.config.
Editing a rule
1. Go to Configure > Security > Access Control > Authentication Rules and click
Edit File.
2. In the table of rules, click on the rule to be changed. Its values populate the fields
in the definition area.
3. Make the desired changes, click Set and then click Apply.
Important
If a field value is not valid, the rule is not commit ed and
the rule entry is discarded. To avoid difficulty in recreating
a rule, separately record the field values so that it is easy to
correct the bad field value and recreate the rule.
4. Click Close to return to the Authentication Rules tab and click Refresh to see
the updated list.
5. Restart Content Gateway to put the changes into effect.
Deleting a rule
1. Go to Configure > Security > Access Control > Authentication Rules and click
Edit File.
2. In the table of rules, click on the rule to be deleted and click the “X” button on the
left.
3. When you are done deleting rules, click Apply.
4. Click Close to return to the Authentication Rules tab and click Refresh to see
the updated list.
5. Restart Content Gateway to put the changes into effect.
Multiple realm use case 1: Domain acquired; explicit proxy, page 227
Multiple realm use case 2: Internal domain added; explicit proxy, page 228
Multiple realm use case 3: Temporary domain added; transparent proxy, page 228
Authentication based on User-Agent, page 229
product. The IT manager wants to keep the kiosk network as walled off from the
corporate intranet as possible. In this scenario, logging individual users isn’t a
requirement.
The Rule-Based Authentication feature makes this possible.
To configure the solution, Creative Corp would:
1. Build a new, temporary network complete with its own domain controller. Let’s
call this domain CTEMP.
2. Add one or more users to CTEMP. They can either match one-to-one with existing
users on the primary domain, or be one or more generic users for use by the
presenters.
3. Redirect Internet traffic on CTEMP to Content Gateway with WCCP v2.
4. Enable Rule-Based Authentication.
5. Create authentication rules, one each for the CTEMP and CCORP domains:
a. On Configure > Security > Access Control > Domains, add the CTEMP
domain, enable Aliasing and leave the name field blank. This will have the
result of applying the Default policy to all users of CTEMP.
b. Add the CCORP domain to the Domains list.
c. On Configure > Security > Access Control > Authentication Rules, create
a CTEMP rule to apply to all connections coming from the IP address range
assigned to the CTEMP domain.
d. Define the CCORP rule to handle all other connections.
At this point, anyone using the Internet on one of the kiosks is authenticated against
the CTEMP network and has the Default policy applied to their requests.
Multiple regexes are allowed. They must be separated by a “|” (‘or’ operator).
When you click Apply (after Add or Set), the regex is parsed and validated. If the
regex is not valid, the rule is deleted and must be recreated with a valid regex.
Following are a few examples of custom regexes.
Microsoft Internet Explorer 7, 8, or 9:
MSIE ([7-9]{1}[\.0-9]{0})
Example User-Agent string:
Mozilla/5.0 (Windows; U; MSIE 9.0; Windows NT 9.0; en-US)
Search the Internet for lists of User-Agent strings, example regular expressions, regex
checkers, and related resources.
Use case:
This describes a case in which an organization with a single domain wants to
authenticate requests from 2 common web browsers. They also want to bypass
authentication for web applications that do not support authentication.
An organization—let’s call it Best Corp—uses Content Gateway. They have one
domain (BCORP), and one domain controller. They use IWA to authenticate users.
Best Corp wants to ensure that:
Requests from common web browsers are authenticated. They control which web
browsers are allowed on their computers.
Web applications that don’t support authentication bypass authentication.
That’s it. With this configuration, all requests from Internet Explorer and Firefox, the
only 2 browsers that can be installed on their computers, are subject to user
authentication. All other requests, most particularly web applications, bypass
authentication. To further customize the approach, Best Corp could create other
authentication rules and/or add proxy filtering rules ([Link]) to deny or bypass
specific applications by User-Agent value.
Note
If the requested URL is configured for tunneling or bypass,
no user authentication is performed.
When a rule is added with the Captive Portal option enabled, users are reminded that
they can customize the pre-defined web portal page. Go to the new Captive Portal
Page Customization tab of Configure > Security > Access Control. Edit the text and
HTML to suit your needs. For example, you may want to include your company logo
in place of the Websense logo.
Note
The css and image files also reside in /opt/WCG/ui/
configure/auth_form and /opt/WCG/ui/configure/
auth_form/images, respectively, for use by the Preview
feature. Copy any new files to those directories to use
Preview.
Add a variable to [Link] to use a different name for the saved Captive Portal
page or store the css and image files in a different directory.
Troubleshooting
When rule-based authentication doesn’t produce the expected results, it is
recommended that you troubleshoot the problem in the following order:
1. Check Network Address Translation (NAT)
Confirm that there is no unexpected IP address NAT. Network address translation
has the result that the original source IP address is changed to another address
before user authentication is performed. In the Content Gateway manager, go to
Configure > Networking > ARM > General and examine the rules in
[Link]. Addresses can also be NATed by other devices in the network, such
as downstream proxies or firewalls.
2. Check the rules in [Link]
Confirm that there is no unexpected matching of a [Link] rule. Among other
purposes, [Link] rules can be used to bypass user authentication. See
Filtering Rules.
Warning
Debug output should not be left enabled. Debug output
slows proxy performance and can fill the file system with
log output.
Find and modify the following parameters and assign values as shown:
CONFIG [Link] INT 1
CONFIG [Link] STRING
http_xauth.* | auth_* | winauth.* | ldap.* | ntlm.*
Save and close the file. Force Content Gateway to reread the file with the command:
(root)# /opt/WCG/bin/content_line -x
Save and close the file. Force Content Gateway to reread the file with the command:
(root)# /opt/WCG/bin/content_line -x
Manual (prompted) authentication can also be used to enable user and group-based
filtering of Mac users.
Note
If the Mac only logs to the domain without mounting a file
share, it will not be visible to DC Agent.
Configuration summary:
Ensure that each participating Mac user is a member of a common Active
Directory. See your Active Directory documentation.
Create a home folder for each Mac user, and make sure that it is accessible to the
user. See the first paragraph of this section.
When the user logs on to the properly configured Mac OS X system, the Mac mounts
a network directory as the user’s home directory, the DC Agent user map is populated,
and user and group-based policies can be applied to user requests. When requests are
blocked, browser-based block pages are displayed normally.
Important
Safari users may be prompted for credentials the first time
they open a browser. The user should enter their
credentials and check the “Remember password in
keychain” check box.
FireFox users may receive an “Proxy Authentication
Required” error message. This is a known issue in FireFox
([Link] and
is easily corrected by changing the browser configuration.
In About:Config set the following options to false:
[Link]-proxies
[Link]-proxies
4. Select the box next to Active Directory to enable Active Directory support.
5. Highlight Active Directory and click on the Pencil icon to configure the
Active Directory connection.
6. Under Domain, enter the Fully Qualified Domain Name (FQDN).
7. Under Computer ID, enter the computer name.
8. Click Bind. You are prompted for network credentials and a computer OU.
Enter your OU admin account and password, and the computer OU location.
For example:
ou=computers,ou=orgunits,dc=ad,dc=example,dc=com
Your machine will be bound to the specified Active Directory.
9. Click Apply in the Directory Utility to save your changes and restart the
machine.
Explicit proxy settings can be configured in the iOS Network settings area.
Related topics:
Event log files, page 244
Managing event log files, page 245
Event log file formats, page 247
Rolling event log files, page 253
Splitting event log files, page 256
Collating event log files, page 258
Viewing logging statistics, page 261
Viewing log files, page 262
Example event log file entries, page 263
Error log files record information about why a transaction was in error.
Event log files (also called access log files) record information about the state of
each transaction that Content Gateway processes.
Content Gateway creates both error and event log files and records system
information in system log files. You can disable event logging and/or error logging. It
is recommended that you log errors only or disable logging during peak usage hours.
On the Configure > Subsystems > Logging tab, select one of the following
options: Log Transactions and Errors, Log Transactions Only, Log Errors
Only, or Disabled.
Event log files record information about every request that Websense Content
Gateway processes. By analyzing the log files, you can determine how many people
use the proxy, how much information each person requested, what pages are most
popular, and so on.
Content Gateway supports several standard log file formats, such as Squid and
Netscape, and user-defined custom formats. You can analyze the standard format log
files with off-the-shelf analysis packages. To help with log file analysis, you can
separate log files so that they contain information specific to protocol or hosts. You
can also configure Content Gateway to roll log files automatically at specific intervals
during the day.
The following sections describe how to:
Manage your event log files
You can choose a central location for storing log files, set how much disk space to
use for log files, and set how and when to roll log files. See Managing event log
files, page 245.
Choose different event log file formats
You can choose which standard log file formats you want to use for traffic
analysis (for example, Squid or Netscape). Alternatively, you can use the Content
Gateway custom format, which is XML-based and enables you to institute more
control over the type of information recorded in log files. See Event log file
formats, page 247.
Roll event log files automatically
You can configure Content Gateway to roll event log files at specific intervals
during the day so that you can identify and manipulate log files that are no longer
active. See Rolling event log files, page 253.
Separate log files according to hosts
You can configure the proxy to create separate log files for different protocols
based on the host. See Splitting event log files, page 256.
You can manage your event log files and control where they are located, how much
space they can consume, and how low disk space in the logging directory is handled.
If the autodelete option is disabled or there are not enough old log files to delete
for the system to emerge from its low space state, Content Gateway issues a
warning and continues logging until space is exhausted. Content Gateway
resumes event logging when enough space becomes available for it to exit its low
space state. You can make space available by removing files from the logging
directory or by increasing the logging space limit.
You can run a cron script in conjunction with Content Gateway to automatically
remove old log files from the logging directory (before Content Gateway enters the
low space state) and relocate them to a temporary partition. Once the files are
relocated, you can run log analysis scripts on them, and then you can compress the
logs and move them to an archive location or delete them.
Note
The log directory you specify must already exist and must
be /opt/WCG/logs or a subdirectory of it.
The Websense user must have read/write permissions for
the directory storing the log files.
3. In the Limit field of the Log Space area, enter the maximum amount of space you
want to allocate to the logging directory.
When Content Gateway is on a V-series appliance, the size is set to 5120 (5 GB)
and cannot be changed.
When Content Gateway is installed on a stand-alone server, the default size is
20480 (20 GB) and the size is configurable.
Note
All files in the logging directory contribute to the space
used, even if they are not log files.
4. In the Headroom field, enter the tolerance for the log space limit. The default
value is 100 MB.
If the Auto-Delete Rolled Files option is enabled in the Log Rolling section,
autodeletion is triggered when the amount of free space available in the logging
directory is less than the headroom. For information about log file rolling, see
Rolling event log files, page 253.
5. Click Apply.
Important
Event log files consume a large amount of disk space.
Creating log entries in multiple formats at the same time
can consume disk resources very quickly and affect proxy
performance.
Important
When IPv6 is enabled, Event log entries are normalized to
IPv6 format.
For example, “[Link]” is logged as
“::ffff:[Link]”.
To filter on a client at “[Link]” in a custom log, use:
<LogFilter>
<Name = "IPv6_Test_Machine"/>
<Condition =
"chi MATCH ::ffff:[Link]"/>
<Action = "ACCEPT"/>
</LogFilter>
The standard log formats include Squid, Netscape Common, Netscape Extended, and
Netscape Extended-2.
The standard log file formats can be analyzed with a wide variety of off-the-shelf log-
analysis packages. You should use one of the standard event log formats unless you
need information that these formats do not provide. See Custom format, page 248.
By default, Content Gateway is configured to use the Netscape Extended log file
format only.
Custom format
Help | Content Gateway | Version 8.1.x
The XML-based custom log format is more flexible than the standard log file formats,
giving you more control over the type of information in your log files. Create a custom
log format if you need data for analysis that is not available in the standard formats.
You can decide what information to record for each Content Gateway transaction and
create filters to define which transactions to log.
The heart of the custom logging feature is an XML-based logging configuration file
(logs_xml.config) that enables you to create modular descriptions of logging objects.
The logs_xml.config file uses three types of objects to create custom log files:
The LogFormat defines the content of the log file using printf-style format
strings.
The LogFilter defines a filter so that you include or exclude certain information
from the log file.
The LogObject specifies all the information needed to produce a log file. For
example:
The name of the log file (required).
The format to be used (required). This can be a standard format (Squid or
Netscape) or a previously defined custom format (a previously defined
LogFormat object).
The file mode (ASCII, Binary, or ASCII_PIPE). The default is ASCII.
The ASCII_PIPE mode writes log entries to a UNIX named pipe (a buffer in
memory). Other processes can then read the data using standard I/O functions.
The advantage of using this option is that Content Gateway does not have to
write to disk, freeing disk space and bandwidth for other tasks.
Note
When the buffer is full, Content Gateway drops log entries
and issues an error message indicating how many entries
were dropped. Content Gateway writes only complete log
entries to the pipe; therefore, only full records are dropped.
Note
To generate a custom log format, you must specify at least
one LogObject definition. One log file is produced for
each LogObject definition. You can create a custom log
format in the Content Gateway manager or by editing a
configuration file.
1. On Configure > Subsystems > Logging > Custom, enable the Custom Logging
option.
2. The Custom Log File Definitions area displays the logs_xml.config file. Add
LogFormat, LogFilter, and LogObject specifications to the configuration file.
For detailed information about the logs_xml.config file and associated object
specifications, see logs_xml.config, page 410.
3. Click Apply.
Content Gateway performs several hundred operations per second; therefore, event
log files can grow quite large. Using SQL-like aggregate operators, you can configure
Content Gateway to create summary log files that summarize a set of log entries over
a specified period of time. This can reduce the size of the log files generated.
You generate a summary log file by creating a LogFormat object in the XML-based
logging configuration file (logs_xml.config) using the following SQL-like aggregate
operators:
COUNT
SUM
AVERAGE
FIRST
LAST
You can apply each of these operators to specific fields, requesting it to operate over a
specified interval.
Summary log files represent a trade-off between convenience and information
granularity. Since you must specify a time interval during which only a single record
is generated, you can lose information. If you want the convenience of summary logs
and need the detail of a conventional log file, consider creating and enabling two
custom log formats—one using aggregate operators and the other not using aggregate
operators.
To create a summary log file format:
1. Navigate to Configure > Subsystems > Logging > Custom to display the
logs_xml.config file.
2. Define the format of the log file as follows:
<LogFormat>
<Name = "summary"/>
<Format = "%<operator(field)> : %<operator(field)>"/>
<Interval = "n"/>
</Format>
where:
operator is one of the five aggregate operators (COUNT, SUM,
AVERAGE, FIRST, LAST). You can specify more than one operator in the
format line.
field is the logging field that you want to aggregate.
n is the interval in seconds between summary log entries.
For more information, see logs_xml.config, page 410.
For example, the following format generates one entry every 10 seconds, with
each entry summarizing the time stamp of the last entry of the interval, a count of
the number of entries seen within that 10-second interval, and the sum of all bytes
sent to the client:
<LogFormat>
<Name = "summary"/>
<Format = "%<LAST(cqts)> : %<COUNT(*)> :
%<SUM(psql)>"/>
<Interval = "10"/>
</Format>
Important
You cannot create a format specification that contains both
aggregate operators and regular fields. For example, the
following specification would be invalid:
<Format = "%<LAST(cqts)> : %<COUNT(*)> :
%<SUM(psql)> : %<cqu>"/>
You can configure Content Gateway to create event log files in either of the following:
ASCII: these files can be processed using standard, off-the-shelf log-analysis
tools. However, Content Gateway must perform additional processing to create
the files in ASCII, resulting in an increase in overhead. Also, ASCII files tend to
be larger than the equivalent binary files. ASCII log files have a .log filename
extension by default.
Binary: these files generate lower system overhead, as well as generally
occupying less space on the disk, depending on the type of information being
logged. You must, however, use a converter application before you can read or
analyze these files using standard tools. Binary log files use a .blog filename
extension by default.
While binary log files typically require less disk space, this is not always the case. For
example, the value 0 (zero) requires only one byte to store in ASCII but requires four
bytes when stored as a binary integer. If you define a custom format that logs IP
addresses, a binary log file would require only four bytes of storage per 32-bit address.
However, the same IP address stored in dot notation would require around 15
characters (bytes) in an ASCII log file.
For standard log formats, you select Binary or ASCII on the Configure >
Subsystems > Logging > Formats tab in the Content Gateway manager. See Setting
standard log file format options, page 248. For the custom log format, you specify
ASCII or Binary mode in the LogObject. Refer to Custom format, page 248.
Note
For custom log files, in addition to the ASCII and Binary
options, you can also write log entries to a UNIX named
pipe (a buffer in memory). Other processes can then read
the data using standard I/O functions. The advantage of
using this option is that Content Gateway does not have to
write to disk, freeing disk space and bandwidth for other
tasks. In addition, writing to a pipe does not stop when
logging space is exhausted because the pipe does not use
disk space. See logs_xml.config, page 410, for more
information about the ASCII_PIPE option.
Before selecting ASCII versus binary for your log files, consider the type of data that
will be logged. Try logging for one day using ASCII and then one day using binary.
Assuming that the number of requests is roughly the same for both days, you can
calculate a rough metric comparing the two formats.
You must convert a binary log file to ASCII before you can analyze it using standard
tools.
1. Change to the directory containing the binary log file.
2. Make sure that the logcat utility is in your path.
3. Enter the following command:
logcat options input_filename...
Option Description
-o output_file Specifies where the command output is directed.
-a Automatically generates the output filename based on the
input filename. If the input is from stdin, this option is
ignored.
For example:
logcat -a [Link] [Link]
[Link]
generates:
[Link], [Link], [Link]
-S Attempts to transform the input to Squid format, if possible.
-C Attempts to transform the input to Netscape Common format,
if possible.
-E Attempts to transform the input to Netscape Extended format,
if possible.
-2 Attempt to transform the input to Netscape Extended-2
format, if possible.
Note
Use only one of the following options at any given time:
-S, -C, -E, or -2.
If no input files are specified, logcat reads from the standard input (stdin). If you
do not specify an output file, logcat writes to the standard output (stdout).
For example, to convert a binary log file to an ASCII file, you can use the logcat
command with either of the following options:
logcat binary_file > ascii_file
logcat -o ascii_file binary_file
The binary log file is not modified by this command.
Websense Content Gateway provides automatic log file rolling. This means that at
specific intervals during the day, Content Gateway closes its current set of log files
and opens new log files.
Log file rolling offers the following benefits:
It defines an interval over which log analysis can be performed.
It keeps any single log file from becoming too large and assists in keeping the
logging system within the specified space limits.
It provides an easy way to identify files that are no longer being used so that an
automated script can clean the logging directory and run log analysis programs.
You should roll log files several times a day. Rolling every six hours is a good
guideline to follow.
Websense Content Gateway provides a consistent name format for rolled log files that
allows you to identify log files.
When Content Gateway rolls a log file, it saves and closes the old file and starts a new
file. Content Gateway renames the old file to include the following information:
The format of the file (for example, [Link]).
The hostname of the Content Gateway server that generated the log file.
Two timestamps separated by a hyphen (-). The first time stamp is a lower bound
for the time stamp of the first record in the log file. The lower bound is the time
when the new buffer for log records is created. Under low load, the first time
stamp in the filename can be different from the timestamp of the first entry. Under
normal load, the first time stamp in the filename and the time stamp of the first
entry are similar.
The second time stamp is an upper bound for the time stamp of the last record in
the log file (this is normally the rolling time).
The suffix .old, which makes it easy for automated scripts to find rolled log files.
The timestamps have the following format:
%Y%M%D.%Hh%Mm%Ss-%Y%M%D.%Hh%Mm%Ss
[Link].20000912.12h00m00s-
[Link]
In this example, the file is squid log format and the host machine is mymachine. The
first time stamp indicates a date and time of year 2000, month September, and day 12
at 12:00 noon. The second time stamp indicates a date and time of year 2000, month
September, and day 13 at 12:00 noon. At the end, the file has a .old suffix.
The logging system buffers log records before writing them to disk. When a log file is
rolled, the log buffer might be partially full. If so, the first entry in the new log file will
have a time stamp earlier than the time of rolling. When the new log file is rolled, its
first time stamp will be a lower bound for the time stamp of the first entry. For
example, suppose logs are rolled every three hours, and the first rolled log file is:
[Link].19980912.12h00m00s-
[Link]
If the lower bound for the first entry in the log buffer at [Link] is [Link], the next
log file, when rolled, will have the following time stamp:
[Link].19980912.02h59m47s-
[Link]
The contents of a log file are always between the two timestamps. Log files do not
contain overlapping entries, even if successive timestamps appear to overlap.
Rolling intervals
Help | Content Gateway | Version 8.1.x
Log files are rolled at specific intervals relative to a given hour of the day. Two
options control when log files are rolled:
The offset hour, which is an hour between 0 (midnight) and 23
The rolling interval
Both the offset hour and the rolling interval determine when log file rolling starts.
Rolling occurs every rolling interval and at the offset hour.
For example, if the rolling interval is six hours and the offset hour is 0 (midnight), the
logs roll at midnight (00:00), 06:00, 12:00, and 18:00 each day. If the rolling interval
is 12 hours and the offset hour is 3, logs roll at 03:00 and 15:00 each day.
4. In the Interval field, enter the amount of time Content Gateway enters data in the
log files before rotation takes place.
The minimum value is 300 seconds (five minutes). The maximum value is
86400 seconds (one day).
Note
If you start Content Gateway within a few minutes of the
next rolling time, rolling may not occur until the following
rolling time.
5. Ensure the Auto-Delete Rolled Files option is enabled (the default). This enables
auto deletion of rolled log files when available space in the log directory is low.
Auto deletion is triggered when the amount of free space available in the log
directory is less than the headroom.
6. Click Apply.
Note
You can fine tune log file rolling settings for a custom log
file in the LogObject specification in the logs_xml.config
file. The custom log file uses the rolling settings in its
LogObject, which override the default settings you
specify in the Content Gateway manager or the
[Link] file described above.
By default, Websense Content Gateway uses standard log formats and generates log
files that contain HTTP and FTP transactions in the same file. However, you can
enable host log splitting if you prefer to log transactions for different origin servers in
separate log files.
HTTP host log splitting enables you to record HTTP and FTP transactions for
different origin servers in separate log files. When HTTP host log splitting is enabled,
Content Gateway creates a separate log file for each origin server listed in the
log_hosts.config file (see Editing the log_hosts.config file, page 257).
When HTTP host log splitting is enabled, Content Gateway generates separate log files
for HTTP/FTP transactions, based on the origin server.
For example, if the log_hosts.config file contains the two origin servers [Link] and
[Link], and the Squid format is enabled, Content Gateway generates the
following log files:
Content Gateway also enables you to create XML-based custom log formats that offer
even greater control over log file generation based on protocol and host name. See
Custom format, page 248.
Note
You can specify keywords in the log_hosts.config file to
record in a separate log file all transactions from origin
servers that contain the specified keyword in their names.
For example, if you specify the keyword sports, Content
Gateway records all HTTP and FTP transactions from
[Link] and [Link] in a log file
called [Link] (if the Squid format is enabled).
Note
If Content Gateway is clustered and if you enable log file
collation, it is recommended that you use the same
log_hosts.config file on every node in the cluster.
You can use the log file collation feature to keep all logged information in one place.
This allows you to analyze Content Gateway as a whole rather than as individual
nodes and to use a large disk that might only be located on one of the nodes in a
cluster.
Content Gateway collates log files by using one or more nodes as log collation servers
and all remaining nodes as log collation clients. When a node generates a buffer of
event log entries, it determines whether it is the collation server or a collation client.
The collation server node simply writes all log buffers to its local disk, just as it would
if log collation were not enabled.
The collation client nodes prepare their log buffers for transfer across the network and
send the buffers to the log collation server. When the log collation server receives a
log buffer from a client, it writes it to its own log file as if it were generated locally. If
log clients cannot contact their log collation server, they write their log buffers to their
local disks, into orphan log files. Orphan log files require manual collation. Log
collation servers can be stand-alone or they can be part of a node running Content
Gateway.
Note
Log collation can have an impact on network performance.
Because all nodes are forwarding their log data buffers to
the single collation server, a bottleneck might occur in the
network, where the amount of data being sent to a single
node in the network exceeds the node’s ability to process it
quickly.
Note
Collated log files contain time-stamp information for each
entry, but entries do not appear in the files in strict
chronological order. You can sort collated log files before
doing analysis.
Note
All collation clients must use this same secret.
5. Click Apply.
Important
If you modify the collation port or secret after connections
between the collation server and collation clients have
been established, you must restart Content Gateway.
Note
To send custom XML-based formatted log entries to the
collation server, you must add a log object specification to
the logs_xml.config file. See Custom format, page 248.
3. In the To Collation Server field, enter the hostname of the collation server. This
could be the Content Gateway collation server or a stand-alone collation server.
4. In the Log Collation Port field, enter the port number used for communication
with the collation server. The default port number is 8085.
5. In the Log Collation Secret field, enter the password used to validate logging
data and prevent the exchange of arbitrary information. This must be the same
secret you set on the collation server.
6. Enable the Log Collation Host Tagged option if you want to preserve the origin
of log entries in the collated log files.
7. In the Log Collation Orphan Space field, enter the maximum amount of space
(in megabytes) you want to allocate to the logging directory on the collation client
for storing orphan log files. (Orphan log files are created when the log collation
server cannot be contacted). The default value is 25 MB.
8. Click Apply.
Important
If you modify the collation port or secret after connections
between the collation clients and collation server have
been established, you must restart Content Gateway.
If you do not want the log collation server to be a Content Gateway node, you can
install and configure a stand-alone collator (SAC) which can dedicate more of its
power to collecting, processing, and writing log files.
Note
The stand-alone collator is currently available for the
Linux platform only.
1. Configure your Content Gateway nodes as log collation clients. See Configuring
Content Gateway to be a collation client, page 260.
2. Copy the sac binary from the Content Gateway bin directory (/opt/WCG/bin) to
the machine serving as the stand-alone collator.
3. Create a directory called config in the directory that contains the sac binary.
4. Create a directory called internal in the config directory you created in Step 3.
This directory will be used internally by the stand-alone collator to store lock
files.
5. Copy the [Link] file (/opt/WCG/config) from a Content Gateway node
configured to be a log collation client to the config directory you created in Step 3
on the stand-alone collator.
The [Link] file contains the log collation secret and port you specified
when configuring nodes to be collation clients. The collation port and secret must
be the same for all collation clients and servers.
6. Open the [Link] file on the stand-alone collator and edit the following
variable:
Variable Description
[Link].log2.logfile_ Specify the directory where you want to
dir store the log files. You can specify an
absolute path to the directory or a path
relative to the directory from which the
sac binary is executed.
Note: The directory must already exist
on the machine serving as the stand-
alone collator.
Content Gateway generates statistics about the logging system that help you see the
following information:
How many log files (formats) are currently being written.
The current amount of space being used by the logging directory, which contains
all of the event and error logs.
The number of access events that have been written to log files since Content
Gateway installation. This counter represents one entry in one file. If multiple
formats are being written, a single event will create multiple event log entries.
The number of access events skipped (because they were filtered out) since
Content Gateway installation.
The number of access events that have been written to the event error log since
Content Gateway installation.
You can view the statistics from the Monitor tab in the Content Gateway manager or
retrieve them through the command-line interface. See Monitoring Traffic, page 117.
Related topics:
Squid format, page 263
Netscape examples, page 264
You can view the system, event, and error log files that Content Gateway creates from
the Content Gateway manager. You can view an entire log file, a specified last number
of lines in the log file, or all lines that contain a specified string.
You can also delete a log file or copy it to your local system.
Note
You must have the correct user permissions to copy and
delete log files.
Note
Content Gateway displays only the first 1 MB of data in
the log file. If the log file you select is larger than 1 MB,
Content Gateway truncates the file and displays a warning
message indicating that the file is too big.
You can now access log files through the Content Gateway manager.
1. Navigate to Configure > My Proxy > Logs > System.
2. To view, copy, or delete a system log file, go to Step 3.
To view, copy, or delete an event or error log file, select the Access tab.
3. In the Log File drop-down list, select the log file you want to view, copy, or
delete.
Content Gateway lists the system log files logged with the system-wide logging
facility syslog under the daemon facility.
Content Gateway lists the event log files located in the directory specified in the
Logging Directory field in the Configure > Subsystems > Logging > General
tab or by the configuration variable [Link].log2.logfile_dir in the
[Link] file. The default directory is logs in the Content Gateway
installation directory.
4. In the Action area, select one of the following options:
Display the selected log file to view the entire log file. If the file is larger than
1 MB, only the first MB of data is displayed.
Display last lines of the selected file to view the last lines of the log file.
Enter the number of lines you want to view in the field provided.
Display lines that match in the selected log file to view all the lines in the
log file that match a particular string. Enter the string in the field provided.
Remove the selected log file to delete the selected log file from the Content
Gateway system.
Save the selected log file in local filesystem to save a copy of the selected
log file on your local system.
5. Click Apply.
If you selected to view the log file, Content Gateway displays the file at the end of
the page.
If you selected to delete the log file, Content Gateway deletes the file. You are not
prompted to confirm the deletion.
If you selected to save the log file, you are prompted for the location where you
want to save the file on your local system.
This section shows examples of a log file entry in each of the standard log formats
supported by Content Gateway:
Squid format, page 263
Netscape examples, page 264
Netscape Extended format, page 265
Netscape Extended-2 format, page 265
Squid format
Help | Content Gateway | Version 8.1.x
The following figure shows a sample log entry in a [Link] file. The table below
describes each field.
1 2 5 6 7
3 4
987548934.123 19 [Link] TCP_HIT/200 4771 GET [Link]
EUROPE/potd/2001/04/17/[Link] - NONE/- image/jpeg
7 cont’d 8 9 10
Field Description
1 The client request time stamp in Squid format; the time of the client
request in seconds since January 1, 1970 UTC (with millisecond
resolution).
2 The time the proxy spent processing the client request; the number of
milliseconds between the time that the client established the connection
with the proxy and the time that the proxy sent the last byte of the
response back to the client.
3 The IP address of the client’s host machine.
4 The cache result code; how the cache responded to the request: HIT,
MISS, and so on. Cache result codes are described in Cache result codes
in Squid- and Netscape-format log files, page 266.
The proxy response status code (the HTTP response status code from
Content Gateway to client).
5 The length of the Content Gateway response to the client in bytes,
including headers and content.
6 The client request method: GET, POST, and so on.
7 The client request canonical URL; blanks and other characters that might
not be parsed by log analysis tools are replaced by escape sequences. The
escape sequence is a percentage sign followed by the ASCII code number
of the replaced character in hex.
8 The authenticated client’s user name. A hyphen (-) means that no
authentication was required.
9 The proxy hierarchy route; the route Content Gateway used to retrieve the
object. The proxy request server name; the name of the server that
fulfilled the request. If the request was a cache hit, this field contains a
hyphen (-).
10 The proxy response content type; the object content type taken from the
Content Gateway response header.
Netscape examples
Help | Content Gateway | Version 8.1.x
1 2 3 4 5
[Link] - - [17/Apr/[Link] -0700] "GET [Link]
EUROPE/potd/2001/04/17/[Link] HTTP/1.0" 200 4473
5 cont’d 6 7
1 2 3 4 5
[Link] - - [17/Apr/[Link] -0700] "GET [Link]
04/17/[Link] HTTP/1.0" 200 4473 000 0 0 0 458 297 0 0 0
5 cont’d 6 7 8 9 10 11 12 13 14 15 16
1 2 3 4 5
[Link] - - [17/Apr/[Link] -0700] "GET [Link]
17/[Link] HTTP/1.0" 200 4473 000 0 0 0 458 297 0 0 0 NONE FIN FIN TCP_MEM_HIT
5 cont’d 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
Field Description
Netscape Common
1 The IP address of the client’s host machine.
2 This hyphen (-) is always present in Netscape log entries.
3 The authenticated client user name. A hyphen (-) means no
authentication was required.
4 The date and time of the client’s request, enclosed in brackets.
5 The request line, enclosed in quotes.
6 The proxy response status code (HTTP reply code).
7 The length of the Content Gateway response to the client in bytes.
Field Description
Netscape Extended
8 The origin server’s response status code.
9 The server response transfer length; the body length in the origin
server’s response to the proxy, in bytes.
10 The client request transfer length; the body length in the client’s request
to the proxy, in bytes.
11 The proxy request transfer length; the body length in the proxy request
to the origin server.
12 The client request header length; the header length in the client’s request
to the proxy.
13 The proxy response header length; the header length in the proxy
response to the client.
14 The proxy request header length; the header length in the proxy request
to the origin server.
15 The server response header length; the header length in the origin
server’s response to the proxy.
16 The time Content Gateway spent processing the client request; the
number of seconds between the time that the client established the
connection with the proxy and the time that the proxy sent the last byte
of the response back to the client.
Netscape Extended-2
17 The proxy hierarchy route; the route Content Gateway used to retrieve
the object.
18 The client finish status code: FIN if the client request completed
successfully or INTR if the client request was interrupted.
19 The proxy finish status code: FIN if the Content Gateway request to the
origin server completed successfully or INTR if the request was
interrupted.
20 The cache result code; how the Content Gateway cache responded to the
request: HIT, MISS, and so on. Cache result codes are described in
Cache result codes in Squid- and Netscape-format log files, page 266.
This section describes the following statistics accessed on the Content Gateway
manager Monitor tab:
My Proxy, page 269
Protocols, page 275
Security, page 277
Subsystems, page 282
Networking, page 284
Performance, page 289
SSL, page 292
My Proxy
Summary
Help | Content Gateway | Version 8.1.x
Statistic/Field Description
Subscription Details
Feature Lists available features, such as analytic options, threat
detection, and the file sandbox.
Purchased Status Indicates if a feature has been purchased.
Expiration Date If a feature has been purchased, displays the expiration
date of the subscription.
More Detail
Subscription key Displays the subscription key. See Entering your
subscription key, page 16.
Last successful Displays the time of the last successful validation of the
subscription download subscription key. The check is made once a day.
time
Connection status Displays the Content Gateway connection status to
Policy Server, Policy Broker, and Filtering Service.
Registration status Displays the Content Gateway registration status with the
Forensics Repository.
Scanning Data Files
Engine Name Displays the name of each scanning engine.
Engine Version Displays the version number of the scanning engine.
Data File Version Displays the version number of the data file currently in
use by the scanning engine.
Last update Displays the time and date when Content Gateway last
successfully loaded that analytics data files, settings, and
policies.
Last time Content Displays the time and date when Content Gateway last
Gateway loaded data successfully loaded databases, settings, and policies.
Last time Content Displays the time and date when Content Gateway last
Gateway checked for successfully communicated with the Websense download
updates server to check for data file updates.
Node Details
Node Name of the Content Gateway node or cluster.
On/Off Indicates if the proxy and manager services are running.
Objects Served The total number of objects served by the node.
Ops/Sec The number of operations per second processed by the
node.
Hit Rate The percentage of HTTP requests served from the cache,
averaged over the past 10 seconds.
Statistic/Field Description
Throughput (Mbit/sec) The number of megabits per second passing through the
node (and cluster).
The proxy updates the throughput statistic after it
transfers an entire object. For larger files, the byte count
increases sharply at the end of a transfer. The complete
number of bytes transferred is attributed to the last 10-
second interval, although it can take several minutes to
transfer the object.
This transient inaccuracy is more noticeable with a light
load.
HTTP Hit (ms) The amount of time it takes for an HTTP object that is
fresh in the cache to be served to the client.
HTTP Miss (ms) The amount of time it takes for an HTTP object that is not
in the cache or is stale to be served to the client.
More Detail
cache hit rate The percentage of HTTP requests served from the cache,
averaged over the past 10 seconds. This value is refreshed
every 10 seconds.
errors The percentage of requests that end in early hangups.
aborts The percentage of aborted requests.
active clients The current number of open client connections.
active servers The current number of open origin server connections.
node IP address The IP address assigned to the node. If virtual IP
addressing is enabled, several virtual IP addresses could
be assigned to this node.
cache free space The amount of free space in the cache.
HostDB hit rate The ratio of host database hits to total host database
lookups, averaged over a 10-second period.
Node
Help | Content Gateway | Version 8.1.x
Statistic Description
Node Summary
Status Indicates if Content Gateway is running on this
node (active or inactive).
Up Since Date and time Content Gateway was started.
Clustering Indicates if clustering is on or off on this node.
Cache
Statistic Description
Document Hit Rate Ratio of cache hits to total cache requests,
averaged over 10 seconds. This value is refreshed
every 10 seconds.
Bandwidth Savings Ratio of bytes served from the cache to total
requested bytes, averaged over 10 seconds. This
value is refreshed every 10 seconds.
Cache Percent Free Ratio of cache free space to total cache space.
In Progress
Open Server Connections Number of currently open origin server
connections.
Open Client Connections Number of currently open client connections.
Cache Transfers in Progress Number of cache transfers (cache reads and
writes) in progress.
Network
Client Throughput (Mbit/Sec) Number of megabits per second passing through
the node (and cluster).
Transactions per Second Number of HTTP transactions per second.
Name Resolution
Host Database Hit Rate Ratio of host database hits to total host database
lookups, averaged over 10 seconds. This value is
refreshed every 10 seconds.
DNS Lookups per Second Number of DNS lookups per second.
Graphs
Help | Content Gateway | Version 8.1.x
The Graphs page displays the same statistics listed on the Node page (cache
performance, current connections and transfers, network, and name resolution) but in
graphical format. You can choose the statistics you want to present in a graph. See
Viewing statistics, page 117.
Important
The graph is displayed in your browser using a Java applet.
You should have the latest version of Java installed on
your PC (at least version 1.7). To validate your access to
Content Gateway statistics, you will be prompted for
Content Gateway logon credentials.
Alarms
Help | Content Gateway | Version 8.1.x
Websense Content Gateway signals an alarm when it detects a problem (for example,
if the space allocated to event logs is full or if Content Gateway cannot write to a
configuration file) and displays a description of the alarm in the alarm message
window. In addition, the Alarm! [pending] bar at the top of the Content Gateway
manager display indicates when alarms are detected and how many alarms exist.
After you have read an alarm message, click Clear in the alarm message window to
dismiss the alarm. Clicking Clear only dismisses alarm messages; it does not actually
resolve the cause of the alarms.
For information about working with alarms, see Working with alarms, page 121.
Diagnostics
Help | Content Gateway | Version 8.1.x
Use the tools provided to help diagnose communication or connection issues, trace
network packets, or capture network packets.
Automatic diagnostic tests, page 273
Manual diagnostic tests, page 274
If the value seems high (a full 10 seconds, for example) when compared to other
latency values, it may indicate a problem in the network.
Details offers additional information for any test that failed or could not complete.
Below the table, the Last update information reflects the date and time the connections
were last tested. Each time you access the page, the results of the last test will display.
Important
TCPDump uses a lot of system resources. Try to avoid
using it during peak hours when the system is busy.
As each command executes, the Run button becomes a Stop button. Click Stop to
abort the command.
Protocols
HTTP
Help | Content Gateway | Version 8.1.x
Statistic Description
General
Client
Total Document Bytes Total amount of HTTP data served to clients since
installation.
Total Header Bytes Total amount of HTTP header data served to clients
since installation.
Total Connections Total number of HTTP client connections since
installation.
Current Connections Current number of HTTP client connections
Transactions in Progress Total number of HTTP client transactions in progress.
Server
Total Document Bytes Total amount of HTTP data received from origin
servers since installation.
Total Header Bytes Total amount of HTTP header data received from
origin servers since installation.
Total Connections Total number of HTTP server connections since
installation.
Current Connections Current number of HTTP server connections
Statistic Description
Stale Revalidated Percentage of hits that are stale and revalidated and
turn out to be still fresh and served, and their average
transaction times.
Misses
Now Cached Percentage of requests for documents that were not in
the cache (but are now) and their average transaction
times.
Server No Cache Percentage of requests for HTTP objects that were not
in the cache, but have server no-cache headers (cannot
be cached); and their average transaction times.
Stale Reloaded Percentage of misses that are revalidated and turn out
to be changed, reloaded, and served, and their average
transaction times.
Client No Cache Percentage of misses with client no-cache headers and
their average transaction times.
Errors
Connection Failures Percentage of connect errors and their average
transaction times.
Other Errors Percentage of other errors and their average
transaction times.
Aborted Transactions
Client Aborts Percentage of client-aborted transactions and their
average transaction times.
Questionable Client Percentage of transactions that could possibly be client
Aborts aborted and their average transaction times.
Partial Request Hangups Percentage of early hangups (after partial requests)
and their average transaction times.
Pre-Request Hangups Percentage of pre-request hangups and their average
transaction times.
Pre-Connect Hangups Percentage of pre-connect hangups and their average
transaction times.
Other Transactions
Unclassified Percentage of unclassified transactions and their
average transaction times.
FTP over HTTP
Connections
Open Server Connections Number of open connections to the FTP server.
Successful PASV Number of successful PASV connections since
Connections installation.
Failed PASV Number of failed PASV connections since installation.
Connections
Statistic Description
Successful PORT Number of successful PORT connections since
Connections installation.
Failed PORT Number of failed PORT connections since installation.
Connections
Cache Statistics
Hits Number of HTTP requests for FTP objects served
from the cache.
Misses Number of HTTP requests for FTP objects forwarded
directly to the origin server because the object is not in
the cache or is stale.
Lookups Number of times Content Gateway looked up an
HTTP request for an FTP object in the cache.
FTP
Help | Content Gateway | Version 8.1.x
Statistic Description
Client
Open Connections Number of client connections currently open.
Bytes Read Number of client request bytes read since installation.
Bytes Written Number of client request bytes written since installation.
Server
Open Connections Number of FTP server connections currently open.
Bytes Read The number of bytes read from FTP servers since
installation.
Bytes Written Number of bytes written to the cache since installation.
Security
Note
Even when multiple authentication rules are used, Content
Gateway reports authentication statistics discreetly for
each authentication method (IWA, LDAP, Legacy NTLM).
Statistic Description
Diagnostic Test
This function runs diagnostic tests on the Kerberos
connection to the selected domain. Results are
displayed on screen and written to /opt/WCG/logs/
content_gateway.out and /opt/WCG/logs/
[Link].
Domain drop down box Select a joined domain. Unless Rule-Based
Authentication is configured, there will only be 1
joined domain.
Run Test button Click to initiate a test.
Active Directory Joined Domains list
Lists all joined AD domains.
The Content Gateway Hostname DNS is the name
that clients must specify in their browser proxy
settings for Kerberos authentication to occur.
Kerberos request counters
Total Kerberos requests The total number of Kerberos authentication requests.
Authentication succeeded The number of Kerberos authentication requests that
resulted in successful authentication.
Authentication failed The number of Kerberos authentication requests that
resulted in authentication failure.
Kerberos errors The number of Kerberos process errors.
NTLM request counters
Total NTLM requests The total number of NTLM authentication requests.
Authentication succeeded The number of NTLM authentication requests that
resulted in successful authentication.
Authentication failed The number of NTLM authentication requests that
resulted in authentication failure.
NTLM request errors The number of NTLM process errors.
NTLM within negotiate The number of NTLM requests encapsulated in
requests Negotiate requests.
Statistic Description
Basic authentication request counters
Total basic authentication The total number of basic authentication requests.
requests
Authentication succeeded The number of basic authentication requests that
resulted in successful authentication.
Authentication failed. The number of basic authentication requests that
resulted in authentication failure.
Basic authentication The number of basic authentication process errors.
request errors
Performance counters
Kerberos - Average time The average time, in milliseconds, to complete a
per transaction Kerberos transaction.
NTLM - Average time per The average time, in milliseconds, to complete a
transaction NTLM transaction.
Basic - Average time per The average time, in milliseconds, to complete a basic
transaction transaction.
Average helper latency The average time for Samba to process an
per transaction authentication request.
Time authentication spent The time, in seconds, that Content Gateway was
offline unable to perform NTLM authentication due to
service or connectivity failures. (This measure does
not apply to Kerberos because no communication with
the DC is needed.)
If the Fail Open option is enabled (Global
authentication options), proxy requests may proceed
without authentication.
The counter is incremented when connectivity is
reestablished after a failure.
Number of times The number of times that connectivity with
authentication servers or authentication servers or services has been lost.
services went offline
Top lists counters
These user authentication lists provide a view into
which User-Agent values and client IP addresses are
most active. Four counters tally the top 20 User-Agent
and client IP addresses that are passing or failing user
authentication.
Button: Reset Top Lists to Resets all Top Lists counters to zero.
Zero
Top User-Agents passing Lists the top 20 User-Agent matches by number of
authentication authentication attempts that pass authentication.
Top User-Agents failing Lists the top 20 User-Agent matches by number of
authentication authentication attempts that fail authentication.
Statistic Description
Top Client IP addresses Lists the top 20 client IP addresses by number of
passing authentication authentication attempts that pass authentication.
Top Client IP addresses Lists the top 20 client IP addresses by number of
failing authentication authentication attempts that fail authentication.
LDAP
Help | Content Gateway | Version 8.1.x
Statistic Description
Cache
Hits Number of hits in the LDAP cache.
Misses Number of misses in the LDAP cache.
Errors
Server Number of LDAP server errors.
Successful Authentications
Authentication Succeeded Number of times authentication was successful.
Unsuccessful Authentications
Authentication Denied Number of times the LDAP Server denied
authentication.
Authentication Timeouts Number of times authentication timed out.
Authentication Cancelled Number of times authentication was terminated after
LDAP authentication was started and before it was
completed.
Note: This does not count the number of times that an
authentication request was cancelled by the client by
clicking “Cancel” in the dialog box that prompts for
credentials.
Legacy NTLM
Help | Content Gateway | Version 8.1.x
Statistic Description
Cache
Hits Number of hits in the NTLM cache.
Misses Number of misses in the NTLM cache.
Errors
Server Number of NTLM server errors.
Statistic Description
Successful Authentications
Authentication Number of times authentication was successful.
Succeeded
Unsuccessful Authentications
Authentication Denied Number of times the NTLM server denied
authentication.
Authentication Number of times authentication was cancelled.
Cancelled
Authentication Rejected Number of times authentication failed because the
queue was full.
Queue Size
Authentication Queued Number of requests that are currently queued because
all of the domain controllers are busy.
SOCKS
Help | Content Gateway | Version 8.1.x
Statistic Description
On-Appliance SOCKS Indicates whether the on-appliance SOCKS server is
Server on (enabled) or off (disabled).
(when Content Gateway is
on a V-Series appliance)
Unsuccessful Connections Number of unsuccessful connections to the SOCKS
server since Content Gateway was started.
Successful Connections Number of successful connections to the SOCKS
server since Content Gateway was started.
Connections in Progress Number of connections to the SOCKS server
currently in progress.
Web DLP
Help | Content Gateway | Version 8.1.x
Statistic Description
Total Posts Total number of posts sent to Web DLP.
Total Analyzed Total number of posts analyzed by Web DLP.
FTP Analyzed Total number of FTP requests analyzed by DLP.
Blocked Requests Total number of requests blocked after analysis and
policy enforcement.
Statistic Description
Allowed Requests Total number of requests allowed after analysis and
policy enforcement.
Failed Requests Total number of posts sent to Web DLP that timed
out or otherwise failed to complete.
Huge Requests Total number of requests that exceeded the maximum
transaction size.
Tiny Requests Total number of requests that were smaller than the
minimum transaction size.
Decrypted Requests Total number of SSL requests decrypted and sent to
Web DLP.
Total Bytes Scanned Total number of bytes scanned by Web DLP.
Average Response Time Average time needed to by Web DLP to complete a
scan since the last time Content Gateway was started.
Subsystems
Cache
Help | Content Gateway | Version 8.1.x
Note
Cache statistics may be non-zero even if all content sent to
Content Gateway is not cacheable. Content Gateway
performs a cache-read even if the client sends a no-cache
control header.
Statistic Description
General
Bytes Used Number of bytes currently used by the cache.
Cache Size Number of bytes allocated to the cache.
Statistic Description
Ram Cache
Bytes Total size of the RAM cache, in bytes.
Hits Number of document hits from the RAM cache.
Misses Number of document misses from the RAM cache. The documents
may be hits from the cache disk.
Reads
In Progress Number of cache reads in progress (HTTP and FTP).
Hits Number of cache reads completed since Content Gateway was
started (HTTP and FTP).
Misses Number of cache read misses since Content Gateway was started
(HTTP and FTP).
Writes
In Progress Number of cache writes in progress (HTTP and FTP).
Successes Number of successful cache writes since Content Gateway was
started (HTTP and FTP).
Failures Number of failed cache writes since Content Gateway was started
(HTTP and FTP).
Updates
In Progress Number of HTTP document updates in progress. An update occurs
when the Content Gateway revalidates an object, finds it to be fresh,
and updates the object header.
Successes Number of successful cache HTTP updates completed since Content
Gateway was started.
Failures Number of cache HTTP update failures since Content Gateway was
started.
Removes
In Progress Number of document removes in progress. A remove occurs when
the Content Gateway revalidates a document, finds it to be deleted
on the origin server, and deletes it from the cache (includes HTTP
and FTP removes).
Successes Number of successful cache removes completed since Content
Gateway was started (includes HTTP and FTP removes).
Failures Number of cache remove failures since Content Gateway was
started (includes HTTP and FTP removes).
Clustering
Help | Content Gateway | Version 8.1.x
Statistic Description
Clustering Nodes Number of clustering nodes.
Logging
Help | Content Gateway | Version 8.1.x
Statistic Description
Currently Open Log Files Number of event log files (formats) that are currently
being written.
Space Used for Log Files Current amount of space being used by the logging
directory, which contains all of the event and error
logs.
Number of Access Events Number of access events that have been written to log
Logged files since Content Gateway installation. This counter
represents one entry in one file. If multiple formats
are being written, a single access creates multiple
event log entries.
Number of Access Events Number of access events skipped (because they were
Skipped filtered out) since Content Gateway installation.
Number of Error Events Number of access events that have been written to the
Logged event error log since Content Gateway installation.
Networking
System
Help | Content Gateway | Version 8.1.x
Statistic/Field Description
General
Hostname The hostname assigned to this Content Gateway machine.
Search Domain Search domain that this Content Gateway machine uses.
IPv4 or IPv6
Default Gateway IP address of the default gateway used to forward packets from
this Content Gateway machine to other networks or subnets.
Primary DNS IP address of the primary DNS server that this Content
Gateway machine uses to resolve host names.
Secondary DNS Secondary DNS server that this Content Gateway machine uses
to resolve host names.
Tertiary DNS Third DNS server that this Content Gateway machine uses to
resolve host names.
NIC <interface_name>
Status Indicates whether the NIC is up or down.
Start on Boot Indicates whether the NIC is configured to start on boot.
IPv4 or IPv6
IP address The assigned IP address of the NIC.
Netmask The netmask that goes with the IP address.
Gateway The configured default gateway IP address for the NIC.
ARM
Help | Content Gateway | Version 8.1.x
Statistic Description
Network Address Translation (NAT) Statistics
Client Connections Number of client connections redirected transparently by
Natted the ARM.
Client Connections in Number of client connections currently in progress with
Progress the ARM.
Total Packets Natted Number of packets translated by the ARM.
DNS Packets Natted Number of DNS packets translated by the ARM.
Statistic Description
Bypass Statistics
Total Connections Total number of connections bypassed by the ARM.
Bypassed
Connections Total number of connections dynamically bypassed. See
Dynamically Dynamic bypass rules, page 71.
Bypassed
DNS Packets Number of DNS packets bypassed by the ARM.
Bypassed
Connections Shed Total number of connections shed. See Connection load
shedding, page 73.
HTTP Bypass Statistics
Bypass on Bad Client Number of requests forwarded directly to the origin server
Request because Content Gateway encountered non-HTTP traffic
on port 80.
Bypass on 400 Number of requests forwarded directly to the origin server
because an origin server returned a 400 error.
Bypass on 401 Number of requests forwarded directly to the origin server
because an origin server returned a 401 error.
Bypass on 403 Number of requests forwarded directly to the origin server
because an origin server returned a 403 error.
Bypass on 405 Number of requests forwarded directly to the origin server
because an origin server returned a 405 error.
Bypass on 406 Number of requests forwarded directly to the origin server
because an origin server returned a 406 error.
Bypass on 408 Number of requests forwarded directly to the origin server
because an origin server returned a 408 error.
Bypass on 500 Number of requests forwarded directly to the origin server
because an origin server returned a 500 error.
ICAP
Help | Content Gateway | Version 8.1.x
Statistic Description
Total Posts Total number of posts sent to TRITON AP-DATA or
Data Security Suite.
Total Analyzed Total number of posts analyzed by TRITON
AP-DATA or Data Security Suite.
FTP Analyzed Total number of FTP requests analyzed by TRITON
AP-DATA or Data Security Suite.
Blocked Requests Total number of requests blocked after analysis and
policy enforcement.
Statistic Description
Allowed Requests Total number of requests allowed after analysis and
policy enforcement.
Failed Requests Total number of posts sent to TRITON AP-DATA or
Data Security Suite that timed out or otherwise failed
to complete.
Huge Requests Total number of requests that exceeded the maximum
transaction size.
Decrypted Requests Total number of SSL requests decrypted and sent to
TRITON AP-DATA or Data Security Suite.
WCCP
Help | Content Gateway | Version 8.1.x
Statistic/Field Description
WCCP v2.0 Statistics
WCCP Fragmentation
Total Fragments Total number of WCCP fragments.
Fragmentation Table Entries Number of entries in the fragmentation table.
Out of Order Fragments Number of fragments out of order.
Matches Number of fragments that match a fragment in the
fragmentation table.
Service group name
Service Group ID Service Group ID for the protocol being serviced.
Configured mode The forward, return and assignment settings.
IP Address IP address to which the router is sending traffic.
Leader’s IP Address IP address of the leader in the WCCP cache farm.
Number of Buckets Assigned Number of buckets assigned to this Content
Gateway node. Determined by the value of Weight
and the current active nodes.
Number of Caches The number of caches in the WCCP cache farm.
Number of Routers The number of routers sending traffic to this
Content Gateway node.
Statistic/Field Description
Router IP Address IP address of the WCCP router sending traffic to
Content Gateway.
Note: If the WCCP router is configured with
multiple IP addresses, as for example when the
router is configured to support multiple VLANs,
the IP address reported in Monitor >
Networking > WCCP statistics, and in packet
captures, may differ from the IP address
configured here. This is because the router always
reports traffic on the highest active IP address.
One way to get the router to always report the same
IP address is to set the router’s loopback address to
a value higher than the router’s highest IP address,
then the loopback address is always reported as the
router’s IP address. This is the recommended
configuration.
Router ID Received The number of times that Content Gateway has
received WCCP protocol messages from the
router(s).
Router Negotiated mode The return, forward, and assignment modes
negotiated with the router.
DNS Proxy
Help | Content Gateway | Version 8.1.x
Statistic Description
Total Requests Total number of DNS requests received from clients.
Hits Number of DNS cache hits.
Misses Number of DNS cache misses.
DNS Resolver
Help | Content Gateway | Version 8.1.x
Statistic Description
DNS Resolver
Total Lookups Total number of DNS lookups (queries to name
servers) since installation.
Successes Total number of successful DNS lookups since
installation.
Average Lookup Time (ms) Average DNS lookup time.
Host Database
Statistic Description
Total Lookups Total number of lookups in the Content Gateway
host database since installation.
Total Hits Total number of host database lookup hits since
installation.
Average TTL (min) Average time to live in minutes.
Virtual IP
Help | Content Gateway | Version 8.1.x
The Virtual IP table displays the virtual IP addresses that are managed by the proxies
in the cluster.
Statistic Description
Clients Connections
Current Unique Clients
Connected
Total Unique Clients that Total since Content Gateway last started.
have Connected
Total Clients that have Total clients that exceeded the connection limits
Exceeded the Limits since Content Gateway last started. See Configure >
Connection Management > Client Connection
Control.
Total Clients for which Total since Content Gateway last started.
Connections were Closed
Performance
Statistic Description
Overview Displays a subset of the graphs available.
Daily Displays graphs that provide historical information for the current
day.
Weekly Displays graphs that provide historical information for the current
week.
Monthly Displays graphs that provide historical information for the current
month.
Yearly Displays graphs that provide historical information for the current
year.
Important
To run the Multi Router Traffic Grapher tool in Linux, you
must have Perl version 5.005 or later installed on your
Content Gateway system.
A description is given adjacent to each graph. Click on a graph to get the daily,
weekly, monthly, and yearly on a single screen.
These graphs are available (sorted alphabetically):
Active Client Connections
Active Native FTP Client Connections
Active Origin Server Connections
Active Parent Proxy Connections
Bandwidth Savings
Cache Read
Cache Reads Per Second
Cache Writes
Cache Writes Per Second
Completed Client Transactions Per Second
Content Gateway Manager Memory Usage
Content Gateway Uptime
CPU Available
CPU Busy
Web DLP Module Memory Usage
Disk Cache Usage
DNS Cache Usage
SSL
Statistic/Field Description
SSL Inbound Key Data
Is alive Online indicates that SSL support is enabled.
Current SSL connections The number of active inbound SSL requests (browser to
Content Gateway).
Total SSL server connections The number of browser requests.
Total finished SSL server The number of browser requests that resulted in
connections decryption.
Total SSL server renegotiation The number of browser requests renegotiated due to
requests handshake failures or invalid certificates between the
browser and Content Gateway.
SSL Outbound Key Data
Is alive Online indicates that SSL support is enabled.
Current SSL connections The number of active outbound SSL requests (Content
Gateway to origin server).
Total SSL client connections The number of Content Gateway requests to origin
servers.
Total finished SSL client The number of requests where data went from Content
connections Gateway to the origin server.
Total SSL client renegotiation The number of requests that were renegotiated due to
requests handshake failures or invalid certificates between
Content Gateway and the origin server
Statistic/Field Description
Total SSL session cache hits The number of times that a request was validated by a
key in the session cache.
Total SSL session cache misses The number of times that a request could not be
validated by a key in the session cache.
Total SSL session cache timeouts The number of times that keys were removed from the
session cache because the timeout period expired.
CRL Statistics
Help | Content Gateway | Version 8.1.x
Statistic/Field Description
CRL Statistics
CRL list count The number of certificates on the Certificate Revocation
List. This list is downloaded every night. See Keeping
revocation information up to date, page 165.
OCSP Statistics
OCSP good count The number of responses that certificates are valid.
OCSP unknown count The number of OCSP responses where the certificate
cannot be verified.
OCSP revoked count The number of certificates found to have been revoked.
Reports
Help | Content Gateway | Version 8.1.x
See Creating SSL-related reports, page 124 for information on creating reports on
certificate authorities or incidents.
Use the command line to execute individual commands and when scripting multiple
commands in a shell.
Run commands as ‘root’.
Execute Content Gateway commands from the Content Gateway bin directory.
Note
If the Content Gateway bin directory is not in your path,
prepend the command with:
./
For example:
./content_line -p
Command Description
WCGAdmin start Starts the Content Gateway service
WCGAdmin stop Stops the Content Gateway service
WCGAdmin restart Stops the Content Gateway service and then starts it
again
WCGAdmin status Displays the status (running or not running) of the
Content Gateway services: Content Cop, Content
Gateway, Content Gateway Manager, and Analytics
Server.
WCGAdmin help Displays a list of the WCGAdmin commands
content_line -h Displays the list of Content Gateway commands.
Command Description
content_line -p Specifies the location (directory and path) of the file used
socket_path for Content Gateway command line and Content
Gateway manager communication. The default path is
install_dir/config/cli
content_line -r variable Displays specific performance statistics or a current
configuration setting. For a list of the variables you can
specify, see Websense Content Gateway variables, page
297.
content_line -s variable Sets configuration variables. variable is the
-v value configuration variable you want to change and value is
the value you want to set. See [Link], page 422,
for a list of the configuration variables you can specify.
content_line -x Initiates a Content Gateway configuration file reread.
Executing this command is similar to clicking Apply in
the Content Gateway manager.
content_line -y Clears Websense dynamically signed certificates from
the cache and the SSL sqlite database.
content_line db_clear -y Clears Websense dynamically signed certificates from
the SSL sqlite database.
content_line -M Restarts the content_manager process and the
content_gateway process on all the nodes in a cluster.
content_line -L Restarts the content_manager process and the
content_gateway process on the local node.
content_line -S Shuts down Content Gateway on the local node.
content_line -U Starts Content Gateway on the local node.
content_line -B Bounces Content Gateway cluster-wide. Bouncing
Content Gateway shuts down and immediately restarts
the proxy node-by-node.
content_line -b Bounces Content Gateway on the local node. Bouncing
Content Gateway shuts down and immediately restarts
the proxy on the local node.
content_line -W Enables WCCP router communication.
content_line -w Disables WCCP router communication. After changing
the Content Gateway WCCP configuration, or the router
WCCP configuration, force WCCP communication
down for 60 seconds to force WCCP to negotiate a new
connection.
content_line -N Perform a Content Gateway snapshot (backup). See
snapshot_name Taking configuration snapshots, page 115.
content_line -n Restore a Content Gateway snapshot. See Restoring
snapshot_name configuration snapshots, page 115.
You can change the value of a specific configuration variable on the command line
with the content_line -s command. The variables that can be set are described in
[Link], page 422.
You can view statistics related to specific variables on the command line with the
content_line -r command. See below for a list of variables.
See, also, Viewing statistics from the command line, page 121, and Command-line
interface, page 112.
Statistics
Help | Content Gateway | Version 8.1.x
The following table lists the variables you can specify on the command line to view
individual statistics. See Statistics, page 269 for additional information.
To view a statistic, at the prompt enter:
content_line -r variable
Statistic Variable
Summary
Node name [Link]
Objects served [Link].user_agents_total_documents_served
Transactions per [Link].user_agent_xacts_per_second
second
Node
Document hit rate [Link].cache_hit_ratio_avg_10s
[Link].cache_hit_ratio_avg_10s
Bandwidth savings [Link].bandwidth_hit_ratio_avg_10s
[Link].bandwidth_hit_ratio_avg_10s
Cache percent free [Link].percent_free
[Link].percent_free
Open origin server [Link].current_server_connections
connections [Link].current_server_connections
Open client [Link].current_client_connections
connections [Link].current_client_connections
Cache transfers in [Link].current_cache_connections
progress [Link].current_cache_connections
Statistic Variable
Client throughput [Link].client_throughput_out
(Mbits/sec) [Link].client_throughput_out
Transactions per [Link].user_agent_xacts_per_second
second [Link].user_agent_xacts_per_second
DNS lookups per [Link].lookups_per_second
second [Link].lookups_per_second
Host database hit [Link].hit_ratio_avg_10s
rate [Link].hit_ratio_avg_10s
HTTP
Total document [Link].
bytes from client user_agent_response_document_total_size
Total header bytes [Link].
from client user_agent_response_header_total_size
Total response [Link].
header bytes to user_agent_response_from_cache_header_total_size
client from cache
Total response [Link].user_agent_response_
document bytes to from_cache_document_total_size
client from cache
Total connections [Link].current_client_connections
to client
Current unique [Link].unique_clients.active
clients connected
Total unique clients [Link].unique_clients.total
that have connected
Total clients that [Link].exceeding_limit
exceeded limit
Total clients for [Link].closed_connections
which connections
were closed
Open HTTP client [Link].current_active_http_
connections client_connections
Open HTTPS client [Link].current_active_https_
connections client_connections
Client Requests [Link].real_client_requests
(IPv4 +IPv6)
Client IPv6 [Link].real_client_ipv6_requests
Requests
Client transactions [Link].current_client_transactions
in progress
Total document [Link].
bytes from origin origin_server_response_document_total_size
server
Statistic Variable
Total header bytes [Link].
from origin server origin_server_response_header_total_size
Total connections [Link].current_server_connections
to origin server
Origin server [Link].current_server_transactions
transactions in
progress
FTP
Currently open FTP [Link].connections_currently_open
connections
Successful PASV [Link].connections_successful_pasv
connections
Unsuccessful [Link].connections_failed_pasv
PASV connections
Successful PORT [Link].connections_successful_port
connections
Unsuccessful [Link].connections_failed_port
PORT connections
WCCP
Enabled [Link]
WCCP interface [Link].wccp2.ethernet_interface
Cache
Bytes used [Link].bytes_used
Cache size [Link].bytes_total
Lookups in [Link]
progress
Lookups completed [Link]
Lookup misses [Link]
Reads in progress [Link]
Reads completed [Link]
Read misses [Link]
Writes in progress [Link]
Writes completed [Link]
Write failures [Link]
Updates in progress [Link]
Updates completed [Link]
Update failures [Link]
Removes in [Link]
progress
Statistic Variable
Remove successes [Link]
Remove failures [Link]
Host DB
Total lookups [Link].total_lookups
Total hits [Link].total_hits
Time TTL (min) [Link]
DNS
DNS total lookups [Link].total_dns_lookups
Average lookup [Link].lookup_avg_time
time (ms)
DNS successes [Link].lookup_successes
Cluster
Bytes read [Link].read_bytes
Bytes written [Link].write_bytes
Connections open [Link].connections_open
Total operations [Link].connections_opened
Network backups [Link].net_backup
Clustering nodes [Link]
SOCKS
Unsuccessful [Link].connections_unsuccessful
connections
Successful [Link].connections_successful
connections
Connections in [Link].connections_currently_open
progress
Logging
Currently open log [Link].log2.log_files_open
files
Space used for log [Link].log2.log_files_space_used
files
Number of access [Link].log2.event_log_access
events logged
Number of access [Link].log2.event_log_access_skip
events skipped
Number of error [Link].log2.event_log_error
events logged
Options are grouped as follows on the left side of the Configure pane:
My Proxy, page 301
Protocols, page 314
Content Routing, page 329
Security, page 334
Subsystems, page 356
Networking, page 362
My Proxy
Basic
Help | Content Gateway | Version 8.1.x
Subscription
Help | Content Gateway | Version 8.1.x
Policy Server
IP address The IP address of the Websense Policy Server. This
value is specified when Content Gateway is installed.
Port The port used by Policy Server. The default port is
55806.
Filtering Service
IP address Specify the IP address of the Websense Filtering
Service. This value is specified when Content
Gateway is installed.
Port Specify the port used by Filtering Service. The
default port is 15868.
Communication Specifies the timeout, in milliseconds, in which
Timeout Policy Server and Filtering Service must respond
before a communication timeout condition occurs and
the Action for Communication Errors setting is
applied.
The default value is 5000 ms (5 seconds).
Action for
Communication Errors
Permit traffic Permits all traffic if communication with Policy
Server or Filtering Service fails.
Block traffic Blocks all traffic if communication with Policy
Server or Filtering Service fails.
UI Setup
Help | Content Gateway | Version 8.1.x
Lowercase character
Number
Special character
Additional Users Lists the current user accounts and lets you add new
user accounts. User accounts determine who has access
the Content Gateway manager and which activities
they can perform. You can create a list of user accounts
if a single administrator login and password is not
sufficient security for your needs.
To create a new account, enter the user login in the New
User field, and then enter the user password in the New
Password field. Retype the user password in the New
Password (Retype) field, and then click Apply.
Passwords must be 8 to 15 characters and include at
least one:
Uppercase character
Lowercase character
Number
Special character
Snapshots
Help | Content Gateway | Version 8.1.x
Snapshots: Restore/Delete Lists the snapshots that are stored on this node.
Snapshot Select the snapshot that you want to restore or
delete from the drop-down list.
Snapshots: Restore Snapshot Restores the snapshot selected in the Restore/
from “directory_name” Delete Snapshot drop-down box.
Directory In a cluster configuration, snapshots are restored
on all nodes in the cluster.
Snapshots: Delete Snapshot Deletes the snapshot selected in the Restore/
from “directory_name” Delete Snapshot drop-down box.
Directory
FTP Server Specifies the name of the FTP server from which
you want to restore a configuration snapshot or to
which you want to save a configuration snapshot.
Login Specifies the login needed to access the FTP
server.
Password Specifies the password needed to access the FTP
server.
Remote Directory Specifies the directory on the FTP server from
which you want restore, or in which you want to
save a configuration snapshot.
Restore Snapshot Lists the configuration snapshots on the FTP
server that you can restore.
This field appears after you have logged on to the
FTP server successfully.
Save Snapshot to FTP Server Specifies the name of the configuration snapshot
you want to take and save on the FTP server.
This field appears after you have logged on to the
FTP server successfully.
Logs
Help | Content Gateway | Version 8.1.x
Log File Lists the system log files you can view, delete or
copy to your local system. Content Gateway lists
the system log files logged with the system-wide
logging facility syslog under the daemon facility.
Action: Display the selected When this option is enabled, Content Gateway
log file displays the first MB of the system log file selected
in the Log File drop-down list.
To view the entire file, select “Save the selected
log file in local filesystem” and view the file with
a local viewer.
Action: Display last lines of When this option is enabled, Content Gateway
the selected file displays the last specified number of lines in the
selected system log file.
Action: Display lines that When this option is enabled, Content Gateway
match in the selected log file displays all the lines in the selected system log file
that match the specified string.
Action: Remove the selected When this option is enabled, Content Gateway
log file deletes the selected log file.
Action: Save the selected log When this option is enabled, Content Gateway
file in local filesystem saves the selected log file on the local system in a
location you specify.
Log File Lists the event or error log files you can view,
delete, or copy to your local system. Content
Gateway lists the event log files located in the
directory specified in the Logging Directory field
under Subsystems/Logging and by the
configuration variable
[Link].log2.logfile_dir in the
[Link] file. The default directory is logs in
the Content Gateway installation directory.
Action: Display the selected When this option is enabled, Content Gateway
log file displays the first MB of the event or error log file
selected in the Log File drop-down list.
To view the entire file, select “Save the selected
log file in local filesystem” and view the file with
a local viewer.
Action: Display last lines of When this option is enabled, Content Gateway
the selected file displays the last specified number of lines in the
event or error log file selected from the Log File
drop-down list.
Action: Display lines that When this option is enabled, Content Gateway
match in the selected log file displays all the lines in the selected event or error
log file that match the specified string.
Remove the selected log file When this option is enabled, Content Gateway
deletes the selected log file.
Action: Save the selected log When this option is enabled, Content Gateway
file in local filesystem saves the selected log file on the local system in a
location you specify.
Protocols
The Protocol configuration options are divided into the following categories:
HTTP, page 314
HTTP Responses, page 324
HTTP Scheduled Update, page 325
HTTPS, page 327
FTP, page 328
HTTP
Help | Content Gateway | Version 8.1.x
HTTP Proxy Server Port Specifies the port that Content Gateway uses when
acting as a Web proxy server for HTTP traffic or when
serving HTTP requests transparently. The default port
is 8080.
If you change this option, you must restart Content
Gateway.
Secondary HTTP Proxy For explicit proxy configurations only, specifies
Server Ports additional ports on which Content Gateway listens for
HTTP traffic.
Transparent proxy configurations always send all
HTTP traffic to port 8080.
Caching: HTTP Caching Enables or disables HTTP caching. When this option
is enabled, Content Gateway serves HTTP requests
from the cache. When this option is disabled, Content
Gateway acts as a proxy server and forwards all HTTP
requests directly to the origin server.
Note: HTTPS content is never cached.
Caching: FTP over HTTP Enables or disables FTP over HTTP caching. When
Caching this option is enabled, Content Gateway serves FTP
requests from HTTP clients from the cache. When this
option is disabled, Content Gateway acts as a proxy
server and forwards all FTP requests from HTTP
clients directly to the FTP server.
Rule Type Lists the type of rules you can add to the [Link]
file:
A never-cache rule configures Content Gateway to
never cache specified objects.
An ignore-no-cache rule configures Content Gateway
to ignore all Cache-Control: no-cache headers.
An ignore-client-no-cache rule configures Content
Gateway to ignore Cache-Control: no-cache headers
from client requests.
An ignore-server-no-cache rule configures Content
Gateway to ignore Cache-Control: no-cache headers
from origin server responses.
A pin-in-cache rule configures Content Gateway to
keep objects in the cache for a specified time.
A revalidate rule configures Content Gateway to
consider objects fresh in the cache for a specified time.
A ttl-in-cache rule configures Content Gateway to
serve certain HTTP objects from the cache for the
amount of time specified in the Time Period field
regardless of certain caching directives in the HTTP
request and response headers.
Primary Destination Type Lists the primary destination types:
dest_domain is a requested domain name.
dest_host is a requested hostname.
dest_ip is a requested IP address.
url_regex is a regular expression to be found in a
URL.
Primary Destination Specifies the value of the primary destination type. For
Value example, if the Primary Destination Type is dest_ip,
the value for this field can be [Link].
Additional Specifier: Specifies the amount of time that applies to the
Time Period revalidate, pin-in-cache, and ttl-in-cache rule types.
The following time formats are allowed:
d for days (for example 2d)
h for hours (for example, 10h)
m for minutes (for example, 5m)
s for seconds (for example, 20s)
mixed units (for example, 1h15m20s)
Secondary Specifiers: Specifies a time range, such as 08:00-14:00.
Time
Secondary Specifiers: Specifies a prefix in the path part of a URL.
Prefix
Secondary Specifiers: Specifies a file suffix in the URL.
Suffix
Secondary Specifiers: Specifies the IP address of the client.
Source IP
Secondary Specifiers: Specifies the port in a requested URL.
Port
Insert Headers: Client-IP When enabled, Content Gateway inserts the Client-IP
header into outgoing requests to retain the client’s IP
address.
This option is mutually exclusive with the Remove
Headers: Client-IP option. When Insert Headers:
Client-IP is enabled the Remove Headers: Client-IP
option is automatically disabled.
Insert Headers: Client-IP and Remove Headers:
Client-IP can both be disabled.
Insert Headers: Via When enabled, Content Gateway inserts a Via header
into the outgoing request. The Via header informs the
destination server of proxies through which the
request was sent.
Insert Headers: When enabled, Content Gateway inserts an
X-Forwarded-For X-Forwarded-For header into the outgoing request.
The X-Forwarded-For value contains the originating
IP address.
Remove Headers: When this option is enabled, Content Gateway
Client-IP removes the Client-IP header from outgoing requests
to protect the privacy of your users.
This option is mutually exclusive with the Insert
Headers: Client-IP option. When Remove Headers:
Client-IP is enabled the Insert Headers: Client-IP
option is automatically disabled.
Remove Headers: Client-IP and Insert Headers:
Client-IP can both be disabled.
Remove Headers: Cookie When this option is enabled, Content Gateway
removes the Cookie header from outgoing requests to
protect the privacy of your users. The Cookie header
often identifies the user that makes a request.
Remove Headers: From When this option is enabled, Content Gateway
removes the From header from outgoing requests to
protect the privacy of your users. The From header
identifies the client’s email address.
HTTP Responses
Help | Content Gateway | Version 8.1.x
Custom Responses You can customize the responses Content Gateway sends
to clients. By default, the responses you can customize are
located in the Content Gateway config/body_factory/
default directory.
Select Enabled Language-Targeted Response to send
your custom responses to clients in the language specified
in the Accept-Language header.
Select Enabled in “default” Directory Only to send the
custom responses located in the default directory to clients.
Select Disabled to disable the custom responses. If Never
Suppressed or Intercepted Traffic Only is selected for
the Response Suppression Mode option, Content
Gateway sends the hard-coded default responses.
If you change this option, you must restart Content
Gateway.
Custom Response When enabled, Content Gateway sends a message to the
Logging error log each time custom responses are used or modified.
If you change this option, you must restart Content
Gateway.
Custom Response Specifies the directory where the custom responses are
Template Directory located. The default location is the Content Gateway
config/body_factory directory.
If you change this option, you must restart Content
Gateway.
Configure > Protocols > HTTP Scheduled Updates > Update URLs
HTTPS
Help | Content Gateway | Version 8.1.x
HTTPS Proxy Server Port Specifies the port that Content Gateway uses when
acting as a Web proxy server for HTTPS traffic.
The default value is 8080.
See also, Configure > Protocols > HTTP >
General: HTTPS Ports.
Tunnel Skype Enables/disables the tunneling of Skype traffic
when HTTPS is enabled and Content Gateway is an
explicit proxy.
To complete the configuration, you must ensure
that all users who are allowed to use Skype have a
Filtering policy that permits internet telephony.
This is required regardless of whether Skype is used
with HTTPS enabled or not.
Also, if Skype is not prevented, after the handshake
it will route traffic over a non-HTTP port. To force
Skype traffic to go through Content Gateway, a
GPO should be used, as described in the Skype IT
Administrators Guide.
Note: This option is not necessary if HTTPS is not
enabled.
Note: This option is not valid when Content
Gateway is a transparent proxy.
FTP
Help | Content Gateway | Version 8.1.x
Note
The FTP configuration options appear on the Configure
pane only if you have enabled FTP processing in the
Features table on the Configure > My Proxy > Basic >
General tab.
FTP Proxy Server Port Specifies the port that Content Gateway uses to accept
FTP requests. The default port is 2121.
Listening Port Specifies how FTP opens a listening port for a data
Configuration transfer.
Select Default Settings to let the operating system choose
an available port. Content Gateway sends 0 and retrieves
the new port number if the listen succeeds.
Select Specify Range if you want the listening port to be
determined by the range of ports specified in the
Listening Port (Max) and Listening Port (Min) fields.
Keep-Alive Timeout: Specifies the timeout value when the FTP server control
Server Control connection is not used by any FTP clients. The default
value is 90 seconds.
Inactivity Timeouts: Specifies how long FTP client control connections can
Client Control remain idle. The default value is 900 seconds.
Inactivity Timeouts: Specifies how long the FTP server control connection can
Server Control remain idle. The default value is 120 seconds.
Active Timeouts: Specifies the how long FTP client control connections can
Client Control remain open. The default value is 14400 seconds.
Active Timeouts: Specifies how long the FTP server control connection can
Server Control remain open. The default value is 14400 seconds.
Content Routing
The Content Routing configuration options are divided into the following categories:
Hierarchies, page 330
Mapping and Redirection, page 332
Browser Auto-Config, page 334
Hierarchies
Help | Content Gateway | Version 8.1.x
Set Updates the rule display box at the top of the configuration
file editor page.
Primary Destination Lists the primary destination types:
Type dest_domain is a requested domain name.
dest_host is a requested hostname.
dest_ip is a requested IP address.
url_regex is a regular expression to be found in a URL.
Primary Destination Specifies the value of the primary destination type.
Value For example:
If the primary destination is dest_domain, a value for this
field can be [Link]
If the primary destination type is dest_ip, the value for this
field can be [Link].
If the primary destination is url_regex, a value for this
field can be politics.
Parent Proxies Specifies the IP addresses or hostnames of the parent
proxies and the port numbers used for communication.
Parent proxies are queried in the order specified in the list.
If the request cannot be handled by the last parent server
in the list, it is routed to the origin server. Separate each
entry with a semicolon; for example: parent1:8080;
parent2:8080
Round Robin Select true for the proxy to go through the parent cache
list in a round-robin based on client IP address.
Select strict for the proxy to serve requests strictly in turn.
For example, machine proxy1 serves the first request,
proxy2 serves the second request, and so on.
Select false if you do not want round-robin selection to
occur.
Go direct Select true for requests to bypass parent hierarchies and
go directly to the origin server.
Select false if you do not want requests to bypass parent
hierarchies.
Secondary Specifiers: Specifies a time range, using a 24-hour clock, such as
Time 08:00-14:00. If the range crosses midnight, enter this as
two comma-separated ranges. For example, if a range
extends from 6:00 in the evening until 8:00 in the morning,
enter the following:
18:00 - 23:59, 0:00 - 8:00
Secondary Specifiers: Specifies a prefix in the path part of a URL.
Prefix
Secondary Specifiers: Specifies a file suffix in the URL, such as .htm or .gif.
Suffix
Secondary Specifiers: Specifies the IP address or range of IP addresses of the
Source IP clients.
Secondary Specifiers: Specifies the port in a requested URL.
Port
Serve Mapped Hosts Select Required if you want the proxy to serve requests
Only only to origin servers listed in the mapping rules of the
[Link] file. If a request does not match a rule in
the [Link] file, the browser receives an error. This
option provides added security for your Content Gateway
system.
Retain Client Host When this option is enabled, Content Gateway retains the
Header client host header in a request (it does not include the
client host header in the mapping translation).
Redirect No-Host Specifies the alternate URL to which to direct incoming
Header to URL requests from older clients that do not provide a Host:
header.
It is recommended that you set this option to a page that
explains the situation to the user and advises a browser
upgrade or provides a link directly to the origin server,
bypassing the proxy. Alternatively, you can specify a
map rule that maps requests without Host: headers to a
particular server.
URL Remapping Rules Displays a table listing the mapping rules in the
[Link] file so that you can redirect HTTP requests
permanently or temporarily without the proxy having to
contact any origin servers.
Note: Mapping a URL to another URL in the same
domain requires that a “/” be specified in From Path
Prefix field. See the example following this table.
Refresh Updates the table to display the most up-to-date rules in
the [Link] file.
Edit File Opens the configuration file editor so that you can edit
and add rules to the [Link] file.
Browser Auto-Config
Help | Content Gateway | Version 8.1.x
WPAD Settings Lets you edit the [Link] file. See Using WPAD, page
42.
Security
The Security configuration options are divided into the following categories:
Connection Control, page 335
FIPS Security, page 335
Web DLP, page 336
Access Control, page 337
SOCKS, page 353
Connection Control
Help | Content Gateway | Version 8.1.x
Option Description
Proxy Access
Access Control Displays the rules in the ip_allow.config file that control which
clients can access Content Gateway.
By default, all remote hosts are allowed to access the proxy.
Refresh Updates the table to display the most up-to-date rules in the
ip_allow.config file.
Edit File Opens the configuration file editor for to the ip_allow.config
file.
ip_allow.config Configuration File Editor
rule display box Lists the ip_allow.config file rules. Select a rule to edit it. The
buttons on the left of the box allow you to delete or move the
selected rule up or down in the list.
Add Adds a new rule to the rule display box at the top of the
configuration file editor page.
Set Updates the rule display box at the top of the configuration file
editor page.
IP Action Lists the type of rules you can add.
An ip_allow rule allows the clients listed in the Source IP field
to access the proxy.
An ip_deny rule denies the clients listed in the Source IP field
access to the proxy.
Source IP Specifies the IP address or range of IP addresses of the clients.
Apply Applies the configuration changes.
Close Exits the configuration file editor.
Click Apply before you click Close; otherwise, all
configuration changes will be lost.
FIPS Security
Help | Content Gateway | Version 8.1.x
Warning
Once enabled, FIPS 140-2 mode cannot be disabled
without reinstalling Content Gateway. If Content Gateway
is on an appliance, the appliance must be reimaged.
Important
Due to a system limitation, FIPS 140-2 mode cannot be
used with NTLM user authentication (IWA fallback to
NTLM or Legacy NTLM).
Option Description
FIPS Enable/Disable By default, Content Gateway is installed in non-FIPS
radio buttons 140-2 mode.
To switch to FIPS 140-2 mode, select the Enabled
radio button, click Apply, and restart Content
Gateway.
Warning: Once enabled, FIPS 140-2 mode cannot be
disabled without reinstalling Content Gateway. For
Websense appliance installations, reinstallation
requires reimaging the system.
Web DLP
Help | Content Gateway | Version 8.1.x
Note
The Web DLP configuration options appear on the
Configure menu only if you have enabled Web DLP on
the Configure > My Proxy > Basic > General tab and
selected Integrated on-box in the Features table.
Option Description
TRITON Management Specifies the IP address of the TRITON management
server IP address server. Configure Web DLP policy in the DATA
module of TRITON Manager.
Analyze HTTPS Content Specifies whether decrypted traffic should be sent to
TRITON AP-DATA for analysis, or sent directly to
the destination.
Analyze FTP Uploads Specifies whether to send FTP upload requests to
TRITON AP-DATA for analysis. The FTP proxy
feature must be enabled. See FTP, page 328.
Option Description
TRITON Management Specifies the IP address of the TRITON Management
server IP server. This is where data security policy
configuration and management is performed.
Administrator user name Specifies the account name of a TRITON AP-DATA
administrator. The administrator must have Deploy
Settings privileges.
Administrator password Specifies the password of the TRITON AP-DATA
administrator.
Register button Initiate the registration action. This button is enabled
only after data is entered in all of the fields.
Access Control
Help | Content Gateway | Version 8.1.x
For complete information about filtering rules, see Filtering Rules, page 183.
Configure > Security > Access Control > Global Configuration Options
Use this page to specify global options for:
The fail open/fail closed action to take when user authentication fails
Credential caching
For transparent proxy, an alternate hostname for the proxy that all clients on the
network can resolve. Required.
Note
The user interface setting to disable the NTLM cache for
explicit proxy has been removed. Although not
recommended, the cache can be disabled for explicit proxy
traffic in [Link] by setting the value of
[Link] to 0 (zero).
DC name or IP address
LDAP
LDAP Server: Hostname Specifies the hostname of the LDAP server.
If you change this option, you must restart Content
Gateway.
LDAP Server: Port Specifies the port used for LDAP communication. The
default port number is 389.
To use the default Global Catalog server port, specify
port 3268.
If Secure LDAP is enabled, set the port to 636 or 3269
(the secure LDAP ports).
If you change this option, you must restart Content
Gateway.
LDAP Server: Specifies whether Content Gateway will use secure
Secure LDAP communication with the LDAP server. If enabled, set
the LDAP Port field (above) to 636 or 3269 (the secure
LDAP ports).
LDAP Server: Server Specifies the search filter. Select either Microsoft
Type Active Directory or other directory services.
LDAP Server: Bind Specifies the Full Distinguished Name (fully qualified
Distinguished Name name) of a user in the LDAP-based directory service.
For example:
CN=John Smith,CN=USERS,DC=MYCOMPANY,
DC=COM
Enter a maximum of 128 characters in this field.
If you do not specify a value for this field, the proxy
attempts to bind anonymously.
LDAP Server: Password Specifies a password for the user identified in the
Bind_DN field.
LDAP Server: Base Specifies the base Distinguished Name (DN). You can
Distinguished Name obtain this value from your LDAP administrator.
You must specify a correct base DN; otherwise LDAP
authentication will fail to operate.
If you change this option, you must restart Content
Gateway.
For more information on configuring Radius, see RADIUS authentication, page 210.
Radius
Primary Radius Server: Specifies the hostname or IP address of the primary
Hostname RADIUS authentication server.
If you change this option, you must restart Content
Gateway.
Primary Radius Server: Specifies the port that Content Gateway uses to
Port communicate with the primary RADIUS
authentication server. The default port is 1812.
If you change this option, you must restart Content
Gateway.
Primary Radius Server: Specifies the key to use for encoding.
Shared Key If you change this option, you must restart Content
Gateway.
Secondary Radius Server Specifies the hostname or IP address of the secondary
(optional): Hostname RADIUS authentication server.
If you change this option, you must restart Content
Gateway.
Secondary Radius Server Specifies the port that Content Gateway uses to
(optional): Port communicate with the secondary RADIUS
authentication server. The default port is 1812.
If you change this option, you must restart Content
Gateway.
Secondary Radius Server Specifies the key to use for encoding.
(optional): Shared Key If you change this option, you must restart Content
Gateway.
For more information on configuring NTLM, see Legacy NTLM authentication, page
204.
NTLM
Domain Controller Specifies the hostnames of the domain controllers in a
Hostnames comma separated list. The format is:
host_name[:port][%netbios_name]
or
IP_address[:port][%netbios_name]
If you are using Active Directory 2008, you must
include the netbios_name or use SMB port 445.
If you change this option, you must restart Content
Gateway.
Load Balancing Enables or disables load balancing. When enabled,
Content Gateway balances the load when sending
authentication requests to the domain controllers.
Note: When multiple domain controllers are specified,
even if load balancing is disabled, when the load on the
primary domain controller reaches the maximum
number of connections allowed, new requests are sent
to a secondary domain controller as a short-term
failover provision, until such time that the primary
domain controller can accept new connections.
If you change this option, you must restart Content
Gateway.
Important
You must configure the Domains list before you configure
authentication rules.
If you have never configured rule-based authentication,
see Rule-Based Authentication, page 213, for complete
information.
Domains
Domain List An unordered list of domains that have been identified
for use in authentication rules.
Use the Edit button to change some attributes
associated with the domain.
Use the Delete or Unjoin button to remove a domain
from the list.
The domain list is stored in auth_domains.config.
Domain list: New Use the New Domain button to add a domain to the
Domain button Domains list. The screen is expanded to allow for
specification of the domain.
New Domain action
Domain Details: Domain Specify a unique name for the domain. The name is
Identifier used only by Content Gateway; it does not change any
attribute of the actual domain or directory.
Important: You cannot change the domain identifier
after it has been added to the list. To change the name,
delete the entry from the list and re-add it with the new
name.
Domain Details: Specify the authentication method: IWA, Legacy
Authentication Method NTLM, or LDAP. Radius is not supported.
When you select an authentication method,
configuration options specific to that method are
added to the page.
Important: You cannot change the authentication
method after you add the domain to the list. To change
the authentication method, delete the entry from the
list and re-add the domain specifying the new
authentication method.
Domain Details: Aliasing Specify an alias to send to the filtering service for all
users who match this rule (optional). The alias must be
static. It can be empty (blank). The alias must exist in
the primary domain controller (the DC visible to the
filtering service). See Unknown users and the ‘alias’
option, page 217.
IWA Domain Details These options are presented when IWA is specified as
the authentication method.
Domain Name Specify the fully qualified domain name. For example:
[Link]
Administrator Name Specify a Windows Active Directory domain
administrator user name.
Administrator Password Specify the corresponding domain administrator
password.
Note: The name and password are used only during
the join and are not stored.
Domain Controller Specify how to locate the domain controller:
Auto-detect using DNS
DC name or IP address
LDAP Server Type Set the search filter to “sAMAccountName” for Active
Directory, or “uid” for other directory services.
Bind Domain Name Specify the LDAP bind account distinguished name.
For example:
CN=John Smith,CN=USERS,DC=MYCOMPANY,
DC=COM
The field length is limited to 128 characters.
If no value is specified, Content Gateway attempts to
bind anonymously.
Bind Password Specify the LDAP bind account password.
Secure LDAP Specify whether Content Gateway will use secure
communication with the LDAP server.
If enabled, you must set the LDAP port to one of the
secure ports: 636 or 3269.
Important
If you have never configured rule-based authentication,
see Rule-Based Authentication, page 213, for complete
information.
Authentication Rules
Authentication Rule List Displays a table of the ordered list of rules defined for
user authentication. Rules are defined for sets of
clients to be authenticated against one or more IWA,
LDAP and NTLM domains. See Rule-Based
Authentication, page 213.
Refresh Updates the table to display the current rules in the
auth_rules.config file.
Edit File Opens the authentication rule editor.
Warning: Do not edit rules directly in the
configuration file.
SOCKS
Help | Content Gateway | Version 8.1.x
For more information about Content Gateway support for SOCKS, see Configuring
SOCKS firewall integration, page 187.
Note
The SOCKS configuration options appear on the
Configure pane only if you have enabled SOCKS in the
Features table on the Configure > My Proxy > Basic >
General tab.
Configure > Security > Access Control > SOCKS > General
Configure > Security > Access Control > SOCKS > Proxy
Configure > Security > Access Control > SOCKS > Server
Socks Server Rules Displays a table listing the rules in the [Link] file that
specify the SOCKS servers that Content Gateway must go
through to access specific origin servers, and the order in
which Content Gateway goes through the SOCKS server
list.
You can also specify the origin servers that you want the
proxy to access directly, without going through a SOCKS
server.
Refresh Updates the table to display the current rules in the
[Link] file.
Edit File Opens the configuration file editor for the [Link] file.
[Link] Configuration File Editor
rule display box Lists the [Link] file rules. Select a rule to edit it. The
buttons on the left of the box allow you to delete or move
the selected rule up or down in the list.
Add Adds a new rule to the rule display box at the top of the
configuration file editor page.
Set Updates the rule display box at the top of the configuration
file editor page.
Rule Type Select Route through SOCKS server to specify the origin
servers that you want the proxy to route through a SOCKS
server.
Select Do not route through SOCKS server to specify the
origin servers that you want the proxy to access directly,
bypassing the SOCKS server(s).
Destination IP For Route through SOCKS server, specify either a single
IP address or a range of IP addresses of origin servers for
which Content Gateway must use the SOCKS servers
specified in the SOCKS Servers field below.
For Do not route through SOCKS server, specify the IP
addresses of the origin servers that you want the proxy to
access directly (without going through the SOCKS server).
You can enter a single IP address, a range of IP addresses,
or a list of IP addresses. Separate each entry in the list with
a comma. Do not specify the all networks broadcast
address: [Link].
SOCKS Server For a Route through SOCKS server rule, select the
SOCKS server(s) through which to route requests.
Round Robin Specifies how strictly Content Gateway will follow round
robin. You can select strict, or false.
Apply Applies the configuration changes.
Close Exits the configuration file editor.
Click Apply before you click Close; otherwise, all
configuration changes will be lost.
Configure > Security > Access Control > SOCKS > Options
Subsystems
The Subsystems configuration options are divided into the following categories:
Cache, page 356
Logging, page 358
Networking, page 362
Cache
Help | Content Gateway | Version 8.1.x
Allow Pinning Enables or disables the cache pinning option, which lets
you keep objects in the cache for a specified time. Set
cache pinning rules in the [Link] file.
Ram Cache Size Specifies the size of the RAM cache, in bytes. The default
size is 104857600 (100 MB).
A value of “-1” directs Content Gateway to automatically
size the RAM cache to approximately 1 MB per 1 GB of
disk cache.
If you change this option, you must restart Content
Gateway.
Maximum Object Size Specifies the maximum size allowed for objects in the
cache.
A value of 0 (zero) means that there is no size restriction.
Cache Hosting Displays a table listing the rules in the [Link] file
that controls which cache partitions are assigned to
specific origin servers and domains.
Refresh Updates the table to display the most up-to-date rules in
the [Link] file.
Edit File Opens the configuration file editor for the [Link]
file.
The configuration file editor page is described below.
[Link] Configuration File Editor
rule display box Lists the [Link] file rules. Select a rule to edit it.
The buttons on the left of the box allow you to delete or
move the selected rule up or down in the list.
Add Adds a new rule to the rule display box at the top of the
configuration file editor page.
Set Updates the rule display box at the top of the
configuration file editor page.
Primary Destination Specifies the primary destination rule type:
Type Select domain if you want to partition the cache
according to domain.
Select hostname if you want to partition the cache
according to hostname
Primary Destination Specifies the domain or origin server’s hostname whose
Value content you want to store on a particular partition.
Partitions Specifies a comma-separated list of the partitions on
which you want to store the content that belongs to the
origin server or domain specified.
Apply Applies the configuration changes.
Close Exits the configuration file editor.
Click Apply before you click Close; otherwise, all
configuration changes will be lost.
Logging
Help | Content Gateway | Version 8.1.x
Log Rolling: Interval Specifies the amount of time Content Gateway enters
data in log files before rolling them to .old files. The
minimum value is 300 seconds (five minutes). The
default value is 21600 seconds (6 hours). The
maximum value is 86400 (1 day).
Log Rolling: Auto- Enables autodeletion of rolled log files when available
Delete Rolled Files space in the log directory is low. Autodeletion is
triggered when the amount of free space available in the
log directory is less than the Log Space Headroom.
Reverse DNS lookup for Enables or disables reverse DNS lookups to facilitate
Threat Tracking inclusion of the client host name in the Threats
dashboard in the Web module of the TRITON Manager,
and in logs and reports.
Caution: To achieve the expected results and avoid
unexpected network behaviors, before enabling this
option be sure that reverse DNS is configured in your
network.
Collation Mode Specifies the log collation mode for this Content
Gateway node. You can use the log file collation feature
to keep all logged information in one place. For more
information about log file collation, see Collating event
log files, page 258.
Select Collation Disabled to disable log collation on
this Content Gateway node.
Select Be a Collation Server to configure this Content
Gateway node to be the collation server.
Select Be a Collation Client to configure this Content
Gateway server to be a collation client. A Content
Gateway server configured as a collation client sends
only the active standard log files, such as Squid,
Netscape Common, and so on, to the collation server. If
you select this option, enter the hostname of the
collation server for your cluster in the Log Collation
Server field.
Note: When logs are collated, the source of the log
entry—its node of origin—is lost unless you turn on the
Log collation host tagged option (described below).
Log collation consumes cluster bandwidth in sending
all log entries to a single node. It can therefore affect the
performance of the cluster.
If you want Content Gateway as a collation client to
send custom (XML-based) log files, you must specify a
LogObject in the logs_xml.config file.
Log Collation Server Specifies the hostname of the log collation server to
which you want to send log files.
Log Collation Port Specifies the port used for communication between the
collation server and client. You must specify a port
number in all cases, except when log collation is
inactive. The default port number is 8085.
Note: Do not change the port number unless there is a
conflict with another service already using the port.
Log Collation Secret Specifies the password for the log collation server and
the other nodes in the cluster. This password is used to
validate logging data and prevent the exchange of
arbitrary information.
Log Collation Host When this option is enabled, Content Gateway adds the
Tagged hostname of the node that generated the log entry to end
of the entry in the collated log file.
Log Collation Orphan Specifies the maximum amount of space (in megabytes)
Space allocated to the logging directory for storing orphan log
files on the Content Gateway node. Content Gateway
creates orphan log entries when it cannot contact the log
collation server.
Networking
The Networking configuration options are divided into the following categories:
Connection Management, page 362
ARM, page 364
WCCP, page 370
DNS Proxy, page 374
DNS Resolver, page 375
ICAP, page 378
Virtual IP, page 379
Health Check URLs, page 380
Connection Management
Help | Content Gateway | Version 8.1.x
The options on the Connection Management pages allow you to tune several
important properties of proxy behavior, including connection throttling and load
shedding, individual client connection limits and rates, and how to respond to low
memory conditions.
By default, Content Gateway accepts 45,000 connections. A connection throttle event
occurs when client or origin server connections reach 90% of half the configured limit
(20,250 by default). When a connection throttle event occurs, Content Gateway
continues processing all existing connections and queues new client connection
requests until the connection count falls below the limit.
If you think that Content Gateway is hitting the connection limits, you should monitor
the Performance graphs to get an accurate reading of connection activity. In particular,
check the Active Client Connections and TCP ESTABLISHED Connections
graphs. You can also check error messages in the system log file, error log file, or
event log files.
ARM
Help | Content Gateway | Version 8.1.x
and inspection of incoming packets before the IP layer sees them, readdressing them
for Content Gateway processing.
The ARM is always active. For more information, see The ARM, page 48.
Network Address Displays the redirection rules in the [Link] file that
Translation (NAT) specify how incoming packets are readdressed when the
proxy is serving traffic transparently. During installation,
Content Gateway creates a small number of default rules.
These rules can be added to and modified. IPv4 and IPv6
addresses are supported. During operation, Content
Gateway traverses the list top down and applies the first
matching rule.
Refresh Updates the table to display the most up-to-date rules in
the [Link] file.
Edit File Opens the configuration file editor for the [Link] file.
[Link] Configuration File Editor
rule display box Lists the [Link] file rules. Select a rule to edit it. The
buttons on the left of the box allow you to delete or move
the selected rule up or down in the list.
Add Adds a new rule to the rule display box at the top of the
configuration file editor page.
Set Updates the rule display box at the top of the
configuration file editor page.
Ethernet Interface Specifies the Ethernet interface that traffic will use to
access the Content Gateway machine: for example, eth0
on Linux.
Connection Type Specifies the connection type that applies for the rule:
TCP or UDP.
Destination IP Specifies the IP address from which traffic is sent.
[Link] or :: match all IP addresses.
Destination CIDR Specifies the IP address in CIDR (Classless Inter-Domain
Routing) format, such as [Link]/24. Entering a value in
this field is optional.
Destination Port Specifies the traffic destination port: for example, 80 for
HTTP traffic.
Redirected Specifies the IP address of your Content Gateway server.
Destination IP
Redirected Specifies the proxy port: for example, 8080 for HTTP
Destination Port traffic.
User Protocol When dns is selected, the ARM redirects DNS traffic to
(Optional) Content Gateway: otherwise, DNS traffic is bypassed.
Apply Applies the configuration changes.
Important
This feature is for transparent proxy deployments only.
Static Bypass table Lists the configured static bypass rules. When Content
Gateway is serving transparent traffic, the proxy uses
these rules to determine whether to bypass incoming
client requests or attempt to serve them transparently.
Rules are stored in [Link]
Refresh Updates the table to display the most up-to-date rules in
the [Link] file.
Edit File Opens the configuration file editor for the [Link]
file.
[Link] Configuration File Editor
rule display box Lists the [Link] file rules. Select a rule to edit it.
The buttons on the left of the box allow you to delete or
move the selected rule up or down in the list.
Add Adds a new rule to the rule display box at the top of the
configuration file editor page.
Set Updates the rule display box at the top of the
configuration file editor page.
Rule Type Specifies the rule type:
A bypass rule bypasses specified incoming requests.
A deny_dyn_bypass rule prevents the proxy from
bypassing specified incoming client requests
dynamically (a deny bypass rule can prevent Content
Gateway from bypassing itself).
Source IP Specifies the source IP address in incoming requests that
the proxy must bypass or deny bypass. The IP address can
be one of the following:
A simple IP address, such as [Link]
In CIDR (Classless Inter-Domain Routing) format, such
as [Link]/24.
A range separated by a dash, such as [Link]-[Link]
Any combination of the above, separated by commas,
such as [Link]/24, [Link], [Link]-[Link]
Behavior: HTTP 403 Select Enabled to enable dynamic bypass when an origin
server returns a 403 error.
Select Disabled to disable dynamic bypass when an
origin server returns a 403 error.
Select Source-Destination to enable dynamic source/
destination bypass when an origin server returns a 403
error.
Select Destination Only to enable dynamic destination
bypass when an origin server returns a 403 error.
Behavior: HTTP 405 Select Enabled to enable dynamic bypass when an origin
server returns a 405 error.
Select Disabled to disable dynamic bypass when an
origin server returns a 405 error.
Select Source-Destination to enable dynamic source/
destination bypass when an origin server returns a 405
error.
Select Destination Only to enable dynamic destination
bypass when an origin server returns a 405 error.
Behavior: HTTP 406 Select Enabled to enable dynamic bypass when an origin
server returns a 406 error.
Select Disabled to disable dynamic bypass when an
origin server returns a 406 error.
Select Source-Destination to enable dynamic source/
destination bypass when an origin server returns a 406
error.
Select Destination Only to enable dynamic destination
bypass when an origin server returns a 406 error.
Behavior: HTTP 408 Select Enabled to enable dynamic bypass when an origin
server returns a 408 error.
Select Disabled to disable dynamic bypass when an
origin server returns a 408 error.
Select Source-Destination to enable dynamic source/
destination bypass when an origin server returns a 408
error.
Select Destination Only to enable dynamic destination
bypass when an origin server returns a 408 error.
Behavior: HTTP 500 Select Enabled to enable dynamic bypass when an origin
server returns a 500 error.
Select Disabled to disable dynamic bypass when an
origin server returns a 500 error.
Select Source-Destination to enable dynamic source/
destination bypass when an origin server returns a 500
error.
Select Destination Only to enable dynamic destination
bypass when an origin server returns a 500 error.
WCCP
Help | Content Gateway | Version 8.1.x
Note
The WCCP configuration options appear on the Configure
pane only if you have enabled WCCP in the Features table
on the Configure > My Proxy > Basic > General tab.
The options defined in the [Link] configuration file control the use of WCCP
with Content Gateway. Entries should be defined and maintained using the editor
provided on Configure > Networking > WCCP.
Administrators should have a good working knowledge of WCCP.
Only WCCP v2 is supported.
It is recommended that you consult the documentation and the manufacturer’s support
site for information regarding optimal configuration and performance of your
WCCP v2 device. Most devices should be configured to take best advantage of
hardware-based redirection. With Cisco devices, the most recent version of IOS is
usually best.
For every active WCCP service group, there must be a corresponding ARM NAT rule.
See ARM, page 364.
For a complete description of Content Gateway support for WCCP v2, see
Transparent interception with WCCP v2 devices, page 50.
Option Description
WCCP Service Groups Displays a table of the service groups defined in the
[Link] file. WCCP service group configuration
defines WCCP behavior. Column fields are
explained in the Configuration Editor entries below.
Refresh Refreshes the table to display the current definitions
in the [Link] file.
Edit File Opens [Link] in the configuration file editor.
Option Description
Synchronize in the Cluster When there are several Content Gateway nodes in a
cluster:
Enable this option to cause the WCCP configuration
([Link]) to be synchronized in the cluster. This
allows configuration changes to be made on any
node in the cluster.
Disable this option to cause the WCCP configuration
to not be synchronized in the cluster. This requires
that changes to the WCCP configuration be made
individually on each node. A common use case for
this is to control which service groups are enabled/
disabled on each node, and to use proportional load
distribution with weight.
If after being disabled this option is enabled, the
configuration on the node on which the option is
enabled is used to initially synchronize the cluster.
[Link] Configuration File Editor
Service group display box Lists the WCCP service group definitions.
Select an entry in the list to edit it.
Use the “X” button to delete the selection.
List order has no meaning; therefore, the up and
down arrows can be ignored.
Add Adds a new service group definition. After Add is
clicked, the new definition is displayed in the box at
the top of the page.
Set Accepts modifications to the selected service group
definition, displaying the new values in the box at the
top of the page.
Service Group Information
Service Group Status Enables or disables the service group.
If you change this option, you must restart Content
Gateway.
Service Group Name Specifies a unique service group name. This is as an
aid to administration.
Service Group ID Specifies a service group ID between 0-255. This ID
must also be configured on the router(s).
If the specified number is already in use, an error is
displayed when Add or Set is clicked.
Protocol Specifies the protocol, TCP or UDP, that applies to
this service group.
Ports Specifies up to 8 ports in a comma separated list.
Network Interface Specifies the Ethernet interface on this Content
Gateway host system to use with this service group.
On a V10000 appliance, eth0 is bound to P1 and eth1
is bound to P2.
Mode Negotiation
Option Description
Special Device Profile Select ASA Firewall to specify that traffic is routed
to the proxy by a Cisco ASA firewall. When this
option is selected, GRE is automatically selected as
the Packet Forward Method and Packet Return
Method. These settings are required and cannot be
changed.
Packet Forward Method Specifies the preferred encapsulation method used
by the WCCP router to transmit intercepted traffic to
the proxy. If the router supports GRE and L2, the
method specified here is used.
Important: GRE and Multicast are incompatible.
Important: If you change the forward or return
method configuration while there is an active
connection with the WCCP device, in order to re-
negotiated the method you must force the current
connection to terminate. Typically, this means
turning off the service group on the WCCP device
for 60 seconds. See the documentation for your
WCCP device.
Packet Return Method Specifies the preferred packet encapsulation method
used to return intercepted traffic to the WCCP router.
Note: If Content Gateway is configured with a
Forward/Return method that the router does not
support, the proxy attempts to negotiate a method
supported by the router.
Note: Selecting L2 requires that the router or switch
be Layer 2-adjacent (in the same subnet) as Content
Gateway.
Advanced Settings
Assignment Method Specifies the method that the router will use to
distribute intercepted traffic across multiple proxy
servers. Choices are HASH and MASK.
The MASK value is applied up to 6 significant bits
(in a cluster, a total of 64 buckets are created).
See your WCCP documentation for more
information about assignment method. Use the value
recommended in the manufacturer’s documentation
for your device.
Distribution attribute(s) Specifies the attribute that the assignment method
uses to determine which requests are distributed to
which proxy servers.
If the assignment method is HASH, select one or
more distribution attributes.
If the assignment method is MASK, select one
distribution attribute.
Option Description
Weight This option is only useful when Synchronize in the
Cluster is disabled.
Specifies the distribution of requests to servers in a
cluster by proportional weighting. Set weight to a
value that is the desired proportion of the total flow
of traffic.
When all cluster members have a value of 0 (the
default), distribution is equal. If any member has a
non-zero value, distribution is proportional, relative
to the weight values of other members. Members that
continue to have a value of zero, receive no traffic.
See WCCP load distribution, page 53.
Reverse Service Group ID For use when IP spoofing is enabled.
When IP spoofing is enabled, the proxy advertises a
reverse service group for each enabled WCCP
forward service group. The reverse service group
must be applied along the return path of origin
server responses to the proxy.
Router Information
Security (optional) Enables or disables security so that the router and
Content Gateway can authenticate each other.
If you enable security in Content Gateway, you must
also enable security on the router. See your router
documentation.
If you change this option, you must restart Content
Gateway.
Security:Password Specifies the password used for authentication. The
password must be the same password as that
configured on the router and can be a maximum of
eight characters long.
If you change this option, you must restart Content
Gateway.
Multicast (optional) Enables or disables WCCP multicast mode.
Important: Cannot be used with GRE packet
Forward/Return method.
If you change this option, you must restart Content
Gateway.
Multicast: IP Address Specifies the multicast IP address.
If you change this option, you must restart Content
Gateway.
WCCP Routers: Router IP Specifies the IP addresses of up to 10
Address WCCP v2-enabled routers.
If you change this option, you must restart Content
Gateway.
Option Description
WCCP Routers: Local If GRE is selected for Packet Return Method, also
GRE Tunnel Endpoint IP specify Local GRE Tunnel Endpoint IP Addresses,
Address except when the device is an ASA firewall.
These are Content Gateway tunnel endpoints for the
associated Router IP Addresses.
A Local GRE Tunnel Endpoint IP Address:
Must be unique for every router in the table
DNS Proxy
Help | Content Gateway | Version 8.1.x
Note
The DNS Proxy configuration options appear on the
Configure pane only if you have enabled DNS Proxy in the
Features table on the Configure > My Proxy > Basic >
General tab.
DNS Proxy Port Specifies the port that Content Gateway uses for
DNS traffic. The default port is 5353.
DNS Resolver
Help | Content Gateway | Version 8.1.x
DNS Lookup Timeout Specifies the maximum number of seconds the proxy
can wait for a lookup response from the DNS server.
Specifies how long, in seconds, the proxy will wait
before making a second DNS request if there is no
response to the first request. The value is stored in
“[Link].lookup_timeout”. The default
value is 120 seconds.
Important: This setting is not used. Instead the
[Link] entry
“[Link].lookup_timeout” is used. The
default value is 20 seconds.
[Link].lookup_timeout specifies how long
the proxy will wait for the DNS response after sending
the request.
Foreground Timeout Specifies how long DNS entries remain in the host
database before they are flagged as stale. This setting
is used only when “[Link].ttl_mode” is
not zero (the default value is 0, which means use the
time-to-live (ttl) value set by the DNS server. See
HostDB, page 468.
For example, if this timeout is 24 hours and a client
requests an entry that has been in the database for 24
hours or longer, the proxy refreshes the entry before
serving it.
The default is 86400 seconds (144 minutes).
Caution: Setting the foreground timeout too low
might slow response time. Setting it too high risks
accumulation of incorrect information.
Failed DNS Timeout Specifies how long, in seconds, that a hostname is
retained in the failed DNS lookup cache (default = 60).
When the timeout expires, the hostname is removed
from the cache and the next request for that hostname
is sent to the DNS server.
A DNS lookup failure is considered to have occurred
when:
There is no DNS response
Default Domain Name Specifies the default domain name to use for resolving
(Optional) hosts. Only one entry is allowed. If you do not provide
the default domain, the system determines its value
from /etc/[Link].
Domain Search List Specifies the domain search order. You can specify
(Optional) multiple domains separated by spaces or by
semicolons (;). If you do not provide the search list,
the system determines the value from /etc/[Link].
Apply Applies the configuration changes.
Close Exits the configuration file editor.
Click Apply before you click Close; otherwise, all
configuration changes are lost.
ICAP
Help | Content Gateway | Version 8.1.x
Note
The ICAP configuration option appears on the Configure
pane only if you have enabled ICAP in the Features table
on the Configure > My Proxy > Basic > General tab.
ICAP Service URI Specifies the Uniform Resource Identifier for the
ICAP service. The format is:
icap://hostname:port/path
For example:
icap://ICAP_machine:1344/reqmod
The default ICAP port is 1344. If you are using the
default port, you need not specify it in the URI.
An optional secondary URI service can be specified
immediately after the first by adding a comma and the
URI of the second service, no spaces.
Analyze HTTPS Content Select whether decrypted traffic should be sent to the
data protection software for analysis or sent directly to
the destination.
Analyze FTP Uploads Select whether to send FTP upload requests to the data
protection software for analysis. The FTP proxy
feature must be enabled. See FTP, page 328.
Virtual IP
Help | Content Gateway | Version 8.1.x
Note
The Virtual IP configuration options appear on the
Configure pane only if you have enabled Virtual IP in the
Features table on the Configure > My Proxy > Basic >
General tab.
Content Gateway includes 3 URLs that return proxy health and performance
information in the HTTP response. These URLs are designed to help load balancers
optimize performance by acquiring and adjusting for real-time state information of
each proxy node.
The default port for health check URLs is 8083. The value can be changed in
[Link] by assigning the desired value to [Link].autoconf_port
WSDOWN
Health Check URLs The load balancer should consider the service down
if the URL request fails for the following reasons:
No TCP connection -- proxy down
Load=2253
Conns=5150
Mbps=6.42
Note
HTTP connection and bandwidth information can be
viewed in the Content Gateway manager on the Monitor >
Protocols > HTTP page.
SSL
The SSL configuration options are divided into the following categories:
Certificates (see Managing certificates, page 156)
Decryption/Encryption (see SSL configuration settings for inbound traffic, page
158 and SSL configuration settings for outbound traffic, page 160)
Validation (see Validating certificates, page 161)
Incidents (see Managing HTTPS website access, page 166)
Client certificates (see Client certificates, page 171)
Customization (see Customizing SSL connection failure messages, page 173)
Internal Root CA (see Internal Root CA, page 147)
Related topic:
Logging format cross-reference, page 386
For example, if you want to create a custom format called short_sq based on the
first three Squid fields, enter a line in the [Link] file as follows:
format:enabl[Link]short_sq:%<cqts> %<ttms>
%<chi>:short_sq:ASCII:none
See Custom format, page 248, for more information about defining custom log files.
Websense Content Gateway contains the following configuration files that you can
edit to customize the proxy.
auth_domains.config, page 393
auth_rules.config, page 395
[Link], page 397
[Link], page 399
[Link], page 402
[Link], page 405
ip_allow.config, page 407
[Link], page 408
log_hosts.config, page 409
logs_xml.config, page 410
mgmt_allow.config, page 417
[Link], page 418
[Link], page 421
[Link], page 422
[Link] , page 487
[Link], page 489
socks_server.config, page 491
[Link], page 492
[Link], page 494
[Link], page 494
[Link], page 496
Entries of type url_regex within the configuration files use regular expressions to
perform a match.
The following table offers examples to illustrate how to create a valid url_regex.
Value Description
x Matches the character x.
. Match any character.
^ Specifies beginning of line.
$ Specifies end of line.
[xyz] A character class. In this case, the pattern matches either x, y,
or z.
[abj-oZ] A character class with a range. This pattern matches a, b, any
letter from j through o, or Z.
[^A-Z] A negated character class. For example, this pattern matches
any character except those in the class.
r* Zero or more r’s, where r is any regular expression.
r+ One or more r’s, where r is any regular expression.
r? Zero or one r, where r is any regular expression.
r{2,5} From two to five r’s, where r is any regular expression.
r{2,} Two or more r’s, where r is any regular expression.
r{4} Exactly 4 r’s, where r is any regular expression.
"[xyz]\"images" The literal string [xyz]"images"
\X If X is a, b, f, n, r, t, or v, then the ANSI-C interpretation of \x;
Otherwise, a literal X. This is used to escape operators such as *.
\0 A NULL character.
\123 The character with octal value 123.
\x2a The character with hexadecimal value 2a.
(r) Matches an r; where r is any regular expression. You can use
parentheses to override precedence.
rs The regular expression r, followed by the regular expression s.
r|s Either an r or an s.
#<n># Inserts an end node causing regular expression matching to stop
when reached. The value n is returned.
Examples
You can specify dest_domain=[Link] to match any host in
[Link]. Likewise, you can specify dest_domain=. to match any request.
auth_domains.config
The auth_domains.config file stores the list of domains that have been identified for
use with Rule-Based Authentication, page 213.
Domains must be identified (added to this file) using the interface in the Content
Gateway manager on the Configure > Security > Access Control > Domains tab.
Do not edit this configuration file.
Format
Each line in auth_domains.config consists of a set of tags; each tag is followed by its
value. For example:
type=<auth_method> name=<unique_name> use_alias=<0 or 1> <additional tags>
The following table lists the additional tags used with IWA domains.
The following table lists the additional tags used with NTLM domains.
1 = enabled
The following table lists the additional tags used with LDAP domains.
1 = enabled
auth_rules.config
The auth_rules.config file stores rules that direct specified IP addresses and IP
address ranges, and/or traffic on specified inbound ports (explicit proxy only), and/or
matching Request header User-Agent values to authenticate with distinct domain
controllers. One or more domain controllers can be specified in an ordered list. This
feature is called Rule-Based Authentication, page 213.
Rule-based authentication rules must be defined in the Content Gateway manager on
the Configure > Security > Access Control > Authentication Rules tab. Do not edit
this configuration file.
Rule-based authentication is supported for Integrated Windows Authentication
(IWA), legacy NTLM, and LDAP authentication only.
Each authentication rule can specify source IP addresses, inbound port (explicit
proxy only), and/or a User-Agent regex
Each authentication rule can specify one or more domains in an ordered list.
Domains are identified on the Configure > Security > Access Control >
Authentication Rules tab. That process includes specifying the authentication
method (IWA, Legacy NTLM, LDAP).
When a rule matches, authentication is performed against one or more domains in
the ordered list. The first successful authentication ends domain list traversal and
the authenticating domain is cached for later use.
Authentication rules are applied from the list top-down; only the first match is
applied. If no rule matches, no user authentication is performed.
Note
If all the users in your network can be authenticated by
domain controllers that share trust relationships, you
probably don’t need rule-based authentication.
However, rule-based authentication can be useful in any
deployment that needs to perform special authentication
handling based on IP address, inbound proxy port (explicit
proxy), and/or User-Agent values.
Format
Each line in auth_rules.config contains an authentication rule that consists of a set of
tags, each followed by its value. Authentication rules have the format:
rule_name=<name> src_ip=<IP addresses> user_agent=<regex> <additional tags>
The following table lists all of the tags.
1 = enabled
[Link]
The [Link] file contains static bypass rules that Content Gateway uses in
transparent proxy mode. Static bypass rules instruct Content Gateway to bypass
certain incoming client requests so that they are served by the origin server.
The [Link] file also accepts dynamic deny bypass rules. See Dynamic deny
bypass rules, page 398.
You can configure three types of static bypass rules:
Source bypass rules configure the proxy to bypass a particular source IP address
or range of IP addresses. For example, you can bypass clients that do not want to
use caching.
Destination bypass rules configure the proxy to bypass a particular destination IP
address or range of IP addresses. For example, you can bypass origin servers that
use IP authentication based on the client’s real IP address.
Important
Destination bypass rules prevent the proxy from caching
an entire site. You will experience hit rate impacts if the
site you bypass is popular.
Source/destination pair bypass rules configure the proxy to bypass requests that
originate from the specified source to the specified destination. For example, you
can route around specific client-server pairs that experience broken IP
authentication or out-of-band HTTP traffic problems when cached. Source/
destination bypass rules can be preferable to destination rules because they block
a destination server only for users that experience problems.
Format
Bypass rules have the following format:
bypass src ipaddress | dst ipaddress | src ipaddress AND dst
ipaddress
Option Description
src ipaddress Specifies the source (client) IP address in incoming
requests that the proxy must bypass.
ipaddress can be one of the following:
A simple IP address, such as [Link]
In CIDR (Classless Inter-Domain Routing) format,
such as [Link]/24
A range separated by a dash, such as
[Link]-[Link]
Any combination of the above, separated by commas,
such as [Link]/24, [Link],
[Link]-[Link]
dst ipaddress Specifies the destination (origin server) IP address in
incoming requests that the proxy must bypass.
ipaddress can be one of the following:
A simple IP address, such as [Link]
In CIDR (Classless Inter-Domain Routing) format,
such as [Link]/24
A range separated by a dash, such as
[Link]-[Link]
Any combination of the above, separated by commas,
such as [Link]/24, [Link],
[Link]-[Link]
src ipaddress Specifies the source and destination IP address pair that the
AND dst proxy must bypass.
ipaddress ipaddress can be a single IP address, an IP address range,
or a combination of both separated by commas
For a description of the options, see the table in Format, page 398.
Note
For the dynamic deny bypass rules to work, you must
enable the Dynamic Bypass option in the Content
Gateway manager or set the variable
[Link].bypass_dynamic_enabled to 1
in the [Link] file.
Important
Static bypass rules overwrite dynamic deny bypass rules.
Therefore, if a static bypass rule and a dynamic bypass rule
contain the same IP address, the dynamic deny bypass rule
is ignored.
Examples
The following example shows source, destination, and source/destination bypass
rules:
bypass src [Link]/24, [Link], [Link]-
[Link]
bypass dst [Link]/24
bypass src [Link] AND dst [Link]
[Link]
The [Link] file defines how the proxy caches Web objects. You can add caching
rules to specify the following configuration:
Not to cache objects from specific IP addresses
How long to pin particular objects in the cache
How long to consider cached objects as fresh
Important
After you modify this file, run content_line -x from
the Content Gateway bin directory (/opt/WCG/bin) to
apply the changes. When you apply the changes to a node
in a cluster, Content Gateway applies the changes to all
nodes in the cluster.
Format
Each line in the [Link] file contains a caching rule. Content Gateway
recognizes three space-delimited tags:
primary_destination=value secondary_specifier=value
action=value
The following table lists the possible primary destinations and their allowed values.
Secondary specifiers are optional in the [Link] file. The following table lists the
possible secondary specifiers and their allowed values.
Note
You can use more than one secondary specifier in a rule.
However, you cannot repeat a secondary specifier.
The following table lists the possible actions and their allowed values.
Action Value
action One of the following values:
never-cache configures the proxy to never cache
specified objects.
ignore-no-cache configures the proxy to ignore all
Cache-Control: no-cache headers.
ignore-client-no-cache configures the proxy to
ignore Cache-Control: no-cache headers from
client requests.
ignore-server-no-cache configures the proxy to
ignore Cache-Control: no-cache headers from
origin server responses.
pin-in-cache The amount of time you want to keep the object(s) in the cache.
The following time formats are allowed:
d for days (for example 2d)
revalidate The amount of time you want to consider the object(s) fresh.
Use the same time formats as pin-in-cache.
ttl-in-cache The amount of time you want to keep objects in the cache
regardless of Cache-Control response headers. Use the same
time formats as pin-in-cache and revalidate.
Examples
The following example configures the proxy to never cache FTP documents requested
from the IP address [Link]:
The following example configures the proxy to keep documents with URLs that
contain the regular expression politics and the path prefix/viewpoint in the cache
for 12 hours:
url_regex=politics prefix=/viewpoint pin-in-cache=12h
The following example configures the proxy to revalidate gif and jpeg objects in the
domain [Link] every 6 hours and all other objects in [Link] every
hour:
dest_domain=[Link] suffix=gif revalidate=6h
dest_domain=[Link] suffix=jpeg revalidate=6h
dest_domain=[Link] revalidate=1h
Note
The rules are applied in the order listed.
[Link]
Important
After you modify the file, run content_line -x from
the Content Gateway bin directory (/opt/WCG/bin) to
apply the changes. When you apply the changes to a node
in a cluster, Content Gateway applies the changes to all
nodes in the cluster.
Three filtering rules are configured by default. The first denies traffic on port 25 to all
destinations. The second and third bypass user authentication for connections to 2
Websense file sandbox destinations.
Format
Each line in [Link] is a filtering rule. Content Gateway applies the rules in the
order listed, starting at the top of the file. If no rule matches, the request is allowed to
proceed.
Content Gateway recognizes three space-delimited tags:
primary_destination=value secondary_specifier=value action=value
Secondary specifiers are optional. The following table lists the possible secondary
specifiers and their purpose.
Note
You can use more than one secondary specifier in a rule.
However, you cannot repeat a secondary specifier.
post
put
trace
The following table lists the possible actions and their allowed values.
keep_hdr The client request header information that you want to keep. You
can specify the following options:
date
host
cookie
client_ip
strip_hdr The client request header information that you want to strip. You
can specify the same options as with keep_hdr.
add_hdr The custom header value you want to add. Requires specification
of the custom header and a header value. For example:
add_hdr=“header_name:header_value”
Examples
The following example configures Content Gateway to deny all FTP document
requests to the IP address [Link]:
dest_ip=[Link] scheme=ftp action=deny
The following example configures Content Gateway to keep the client IP address
header for URL requests that contain the regular expression politics and whose
path prefix is
/viewpoint:
The following example configures Content Gateway to strip all cookies from client
requests destined for the origin server [Link]:
dest_host=[Link] strip_hdr=cookie
The following example configures Content Gateway to disallow puts to the origin
server [Link]:
dest_host=[Link] method=put action=deny
Content Gateway applies the rules in the order listed in the file. For example, the
following sample [Link] file configures Content Gateway to do the following:
Allow all users (except those trying to access [Link]) to access [Link]
Deny all users access to [Link]
dest_host=[Link] action=allow
dest_host=[Link] action=deny
[Link]
Help | Content Gateway | Version 8.1.x
The [Link] file lets you assign cache partitions to specific origin servers and
domains so that you can manage your cache space more efficiently and restrict disk
usage.
For step-by-step instructions on partitioning the cache according to origin servers and
domains, see Partitioning the cache according to origin server or domain, page 102.
Note
Before you can assign cache partitions to specific origin
servers and domains, you must partition your cache
according to size and protocol in the [Link] file.
For more about cache partitioning, see Partitioning the
cache, page 102. For a description of the [Link]
file, see [Link], page 421.
After you modify the [Link] file, run content_line -x from the Content
Gateway bin directory to apply the changes. When you apply the changes to a node in
a cluster, Content Gateway automatically applies the changes to all nodes in the
cluster.
Important
The partition configuration must be the same on all nodes
in a cluster.
Format
Each line in the [Link] file must have one of the following formats:
hostname=hostname partition=partition_numbers
domain=domain_name partition=partition_numbers
where:
hostname is the fully qualified hostname of the origin server whose content you
want to store on a particular partition (for example, [Link]).
domain_name is the domain whose content you want to store on a particular
partition (for example, [Link]).
partition_numbers is a comma-separated list of the partitions on which you want
to store the content that belongs to the origin server or domain listed. The partition
numbers must be valid numbers listed in the [Link] file (see
[Link], page 421).
Note
If you want to allocate more than one partition to an origin
server or domain, enter the partitions in a comma-
separated list on one line. The [Link] file cannot
contain multiple entries for the same origin server or
domain.
Generic Partition
When configuring the [Link] file, you must assign a generic partition to use
for content that does not belong to any of the origin servers or domains listed. If all
partitions for a particular origin server become corrupt, Content Gateway uses the
generic partition to store content for that origin server.
The generic partition must have the following format:
hostname=* partition=partition_numbers
Examples
The following example configures the proxy to store content from the domain
[Link] in partition 1 and content from [Link] in partition 2. The
proxy stores content from all origin servers in partitions 3 and 4.
domain=[Link] partition=1
hostname=[Link] partition=2
hostname=* partition=3,4
ip_allow.config
The ip_allow.config file controls client access to the proxy. You can specify ranges of
IP addresses that are allowed to use Content Gateway.
Important
After you modify the file, run content_line -x from
the Content Gateway bin directory (/opt/WCG/bin) to
apply the changes. When you apply the changes to a node
in a cluster, Content Gateway applies the changes to all
nodes in the cluster.
Format
Each line in the ip_allow.config file must have the following format:
src_ip=ipaddress action=ip_allow | ip_deny
Examples
The following example allows all clients to access the proxy:
src_ip=[Link]-[Link] action=ip_allow
The following example allows all clients on a specific subnet to access the proxy:
src_ip=[Link]-[Link] action=ip_allow
The following example denies all clients on a specific subnet to access the proxy:
src_ip=[Link]-[Link] action=ip_deny
[Link]
The [Link] file contains redirection rules that specify how incoming packets are
readdressed when the proxy is serving traffic transparently. Content Gateway creates
the redirection rules during installation. You can modify these rules.
Important
After you modify this file, you must restart the proxy.
Format
Each line in the [Link] file must have the following format:
rdr interface [Link]/0 port dest -> ipaddress port proxy
tcp|udp
where:
interface is the Ethernet interface that traffic will use to access the Content
Gateway machine (for example, eth0 on Linux).
dest is the traffic destination port (for example, 80 for HTTP traffic).
ipaddress is the IP address of your Content Gateway server.
proxy is the Content Gateway proxy port (usually 8080 for HTTP traffic).
Examples
The following example configures the ARM to readdress all incoming HTTP traffic to
the Content Gateway IP address ([Link]) on the Content Gateway proxy port
8080:
rdr hme0 [Link]/0 port 80 -> [Link] port 8080 tcp
log_hosts.config
To record HTTP/FTP transactions for different origin servers in separate log files, you
must list each origin server’s hostname in the log_hosts.config file. In addition, you
must enable the HTTP host splitting option (see HTTP host log splitting, page 256).
Note
It is recommended that you use the same log_hosts.config
file on every Content Gateway node in your cluster.
Important
After you modify this file, run content_line -x from
the Content Gateway bin directory (/opt/WCG/bin) to
apply the changes. When you apply the changes to a node
in a cluster, Content Gateway applies the changes to all
nodes in the cluster.
Format
Each line in the log_hosts.config file has the following format:
hostname
Note
You can specify keywords in the log_hosts.config file to
record all transactions from origin servers with the
specified keyword in their names in a separate log file. See
the example below.
Examples
The following example configures Content Gateway to create separate log files
containing all HTTP/ FTP transactions for the origin servers webserver1, webserver2,
and webserver3.
webserver1
webserver2
webserver3
The following example records all HTTP and FTP transactions from origin servers
that contain sports in their names (for example, [Link] and
logs_xml.config
The logs_xml.config file defines the custom log file formats, filters, and processing
options. The format of this file is modeled after XML, the Extensible Markup
Language.
Format
The logs_xml.config file contains the following specifications:
LogFormat specifies the fields to be gathered from each protocol event access.
See LogFormat, page 411.
LogFilter specifies the filters that are used to include or exclude certain entries
being logged based on the value of a field within that entry. See LogFilter, page
412.
LogObject specifies an object that contains a particular format, a local filename,
filters, and collation servers. See LogObject, page 413.
Note
The logs_xml.config file ignores extra white space, blank
lines, and all comments.
LogFormat
The following table lists the LogFormat specifications.
SUM
AVG
FIRST
LAST
LogFilter
The following table lists the LogFilter specifications.
LogObject
The following table lists the LogObject specifications.
Examples
The following is an example of a LogFormat specification collecting information
using three common fields:
<LogFormat>
<Name = "minimal"/>
<Format = "%<chi> : %<cqu> : %<pssc>"/>
</LogFormat>
Note
When specifying the field in the filter condition, you can
omit the %<>. This means that the following filter is
equivalent to the example directly above:
<LogFilter>
<Name = "only_refresh_hits"/>
<Action = "ACCEPT"/>
<Condition = "pssc MATCH REFRESH_HIT"/>
</LogFilter>
The following is an example of a LogObject specification that creates a local log file
for the minimal format defined earlier. The log filename will be [Link] because
this is an ASCII log file (the default).
<LogObject>
<Format = "minimal"/>
<Filename = "minimal"/>
</LogObject>
<LogObject>
<Format = "minimal"/>
<Filename = "minimal"/>
<ServerHosts = "[Link],[Link]"/>
<Protocols = "http"/>
<CollationHosts =
"[Link],[Link]:5000"/>
</LogObject>
<LogFormat>
<Name = "welf"/>
<Format = "id=firewall time=\"%<cqtd> %<cqtt>\" fw=%<phn>
pri=6 proto=%<cqus> duration=%<ttmsf> sent=%<psql>
rcvd=%<cqhl> src=%<chi> dst=%<shi> dstname=%<shn>
user=%<caun> op=%<cqhm> arg=\"%<cqup>\" result=%<pssc>
ref=\"%<{Referer}cqh>\" agent=\"%<{user-agent}cqh>\"
cache=%<crc>"/>
</LogFormat>
mgmt_allow.config
The mgmt_allow.config file specifies the IP addresses of remote hosts allowed access
or denied access to the Content Gateway manager.
Important
After you modify this file, run content_line -x from
the Content Gateway bin directory (/opt/WCG/bin) to
apply the changes. When you apply the changes to a node
in a cluster, Content Gateway applies the changes to all
nodes in the cluster.
Format
Each line in the mgmt_allow.config file has the following format:
src_ip=ipaddress action=ip_allow|ip_deny
By default, the mgmt_allow.config file contains the following line, which allows all
remote hosts to access the Content Gateway manager. Comment out or delete this line
before adding rules to restrict access.
src_ip=[Link]-[Link] action=ip_allow
Examples
The following example configures Content Gateway to allow only one user to access
the Content Gateway manager:
src_ip=[Link] action=ip_allow
[Link]
The [Link] file identifies the HTTP parent proxies used in an HTTP cache
hierarchy. Use this file to perform the following configuration:
Set up parent cache hierarchies, with multiple parents and parent failover
Configure selected URL requests to bypass parent proxies
Rules are applied from the list top-down; the first match is applied. Bypass rules are
usually placed above parent proxy designation rule(s).
Content Gateway uses the [Link] file only when the HTTP parent caching
option is enabled. See Configuring Content Gateway to use an HTTP parent cache,
page 96.
Important
After you modify this file, run content_line -x from
the Content Gateway bin directory (/opt/WCG/bin) to
apply the changes. When you apply the changes to a node
in a cluster, Content Gateway applies the changes to all
nodes in the cluster.
Format
Each line in the [Link] file must contain a parent caching rule. Content
Gateway recognizes three space-delimited tags:
primary_destination=value secondary_specifier=value
action=value
The following table lists the possible primary destinations and their allowed values.
Secondary specifiers are optional in the [Link] file. The following table
lists the possible secondary specifiers and their allowed values.
FTP
post
put
trace
The following table lists the possible actions and their allowed values.
Examples
The following rule configures a parent cache hierarchy consisting of Content Gateway
(which is the child) and two parents, [Link] and [Link]. The proxy forwards
the requests it cannot serve to the parent servers [Link] and [Link] in a round-
robin fashion because round_robin=true.
dest_domain=. method=get parent=”[Link];
[Link]” round_robin=true
The following rule configures Content Gateway to route all requests containing the
regular expression politics and the path /viewpoint directly to the origin server
(bypassing any parent hierarchies):
url_regex=politics prefix=/viewpoint go_direct=true
Important
Every line in the [Link] file must contain either a
parent= or go_direct= directive.
[Link]
Help | Content Gateway | Version 8.1.x
The [Link] file lets you manage your cache space more efficiently by
creating cache partitions of different sizes. You can further configure these partitions
to store data from certain origin servers and domains in the [Link] file. This
allows you to take better advantage of caching of frequently visited sites where the
content changes infrequently.
Important
The partition configuration must be the same on all nodes
in a cluster.
You must stop Content Gateway before you change the cache partition size.
Format
For each partition you want to create, enter a line with the following format:
partition=partition_number scheme=protocol_type
size=partition_size
where:
partition_number is a number between 1 and 255 (the maximum number of
partitions is 255).
protocol_type is http.
Note
Only HTTP is supported at this time. Streaming media
content—mixt—is not supported.
partition_size is the amount of cache space allocated to the partition. This value
can be either a percentage of the total cache space or an absolute value. The
absolute value must be a multiple of 128 MB, where 128 MB is the smallest
value. If you specify a percentage, the size is rounded down to the closest multiple
of 128 MB. Each partition is striped across several disks to achieve parallel I/O.
For example, if there are four disks, a 1 GB partition will have 256 MB on each
disk (assuming each disk has enough free space available).
Note
If you do not allocate all the disk space in the cache, the
extra disk space is not used. You can use the extra space
later to create new partitions without deleting and clearing
the existing partitions.
Examples
The following example partitions the cache evenly:
partition=1 scheme=http size=50%
partition=2 scheme=http size=50%
[Link]
Warning
Do not change the [Link] variables unless you are
certain of the effect. Many variables are coupled, meaning
that they interact with other variables. Changing a single
variable in isolation can cause Content Gateway to fail.
Whenever possible, use the Content Gateway manager
to configure Content Gateway.
Important
After you modify this file, to apply the changes run
content_line -x from the Content Gateway bin
directory (/opt/WCG/bin).
When you apply the changes to a node in a cluster, Content
Gateway applies the changes to all nodes in the cluster.
Format
Each variable has the following format:
CONFIG variable_name DATATYPE variable_value
where DATATYPE is INT (an integer), STRING (a string), or FLOAT (a floating point).
Examples
In the following example, the variable [Link].proxy_name is of datatype
string and its value is contentserver1. This means that the name of the Content
Gateway proxy is contentserver1.
In the following example, the variable sets the cluster startup timeout to 10 seconds.
CONFIG [Link].startup_timeout INT 10
Configuration variables
Help | Content Gateway | Version 8.1.x
The following tables describe the configuration variables listed in the [Link]
file.
System variables
Local manager
Virtual IP manager
Alarm configuration
ARM
Load shedding configuration (ARM)
Authentication basic realm
LDAP
RADIUS authentication
NTLM
Integrated Windows Authentication
Transparent authentication
HTTP engine
Parent proxy configuration
Cache control
Heuristic expiration
Dynamic content and content negotiation
Anonymous FTP password
Cached FTP document lifetime
FTP transfer mode
FTP engine
System variables
Help | Content Gateway | Version 8.1.x
Local manager
Help | Content Gateway | Version 8.1.x
3 = no clustering
Process manager
Help | Content Gateway | Version 8.1.x
Virtual IP manager
Help | Content Gateway | Version 8.1.x
Alarm configuration
Help | Content Gateway | Version 8.1.x
ARM
Help | Content Gateway | Version 8.1.x
1 = LDAP
2 = RADIUS
3 = Legacy NTLM
4 = Integrated Window
Authentication
5 = Rule-Based
Authentication
[Link]. INT 0 Enables (1) or disables (0) rule-
enabled based authentication. Tells
Content Gateway to use the
auth_rules.config file.
[Link]. INT 50 Specifies the maximum number
[Link] of domains that can be added or
joined on Configure >
Security > Access Control >
Domains
[Link]. STRING auth_form.html Specifies the file that defines the
form_filename Captive Portal authentication
page.
This variable must be added
manually. Changing this
filename is not recommended.
[Link]. STRING /opt/WCG/ Specifies the location of any css
[Link] config/ui_files and image files used to define the
Captive Portal authentication
page. The full default path is /opt/
WCG/config/ui_files. Image
files are located in an /images
sub-directory.
This variable must be added
manually.
[Link]. INT 4443 Specifies the local port used for
auth_server_port the HTTPS Captive Portal page.
LDAP
RADIUS authentication
Help | Content Gateway | Version 8.1.x
NTLM
Help | Content Gateway | Version 8.1.x
Transparent authentication
Help | Content Gateway | Version 8.1.x
HTTP engine
Help | Content Gateway | Version 8.1.x
1 = Always
Security
Help | Content Gateway | Version 8.1.x
Cache control
Help | Content Gateway | Version 8.1.x
Heuristic expiration
Help | Content Gateway | Version 8.1.x
FTP engine
Help | Content Gateway | Version 8.1.x
2 = PORT only
3 = PASV only
SOCKS processor
Help | Content Gateway | Version 8.1.x
Net subsystem
Help | Content Gateway | Version 8.1.x
Cluster subsystem
Help | Content Gateway | Version 8.1.x
Cache
Help | Content Gateway | Version 8.1.x
DNS
Help | Content Gateway | Version 8.1.x
DNS proxy
Help | Content Gateway | Version 8.1.x
HostDB
Help | Content Gateway | Version 8.1.x
Logging configuration
Help | Content Gateway | Version 8.1.x
r = read permission
w = write permission
x = execute permission
0 = binary
0 = binary
0 = binary
0 = binary
and so on...
SNMP configuration
Help | Content Gateway | Version 8.1.x
Plug-in configuration
Help | Content Gateway | Version 8.1.x
WCCP configuration
Help | Content Gateway | Version 8.1.x
SSL Decryption
Help | Content Gateway | Version 8.1.x
Important
All SSL decryption settings should be made in the Content
Gateway manager. None of the variables in the table below
should be modified directly in [Link].
ICAP
Help | Content Gateway | Version 8.1.x
Web DLP
Help | Content Gateway | Version 8.1.x
[Link]
The [Link] file contains mapping rules that Websense Content Gateway
uses to redirect HTTP requests permanently or temporarily without Content Gateway
having to contact any origin server:
Important
After you modify this file, restart the proxy or run
content_line -x from the Content Gateway bin
directory (/opt/WCG/bin) to apply the changes. When
you apply the changes to a node in a cluster, Content
Gateway applies the changes to all nodes in the cluster.
Format
Each line in the [Link] file must contain a mapping rule. Content Gateway
recognizes three space-delimited fields: type, target, and replacement. The following
table describes the format of each field.
Field Description
type Enter one of the following:
map provides the same function as redirect. Use of
redirect is recommended.
redirect—redirects HTTP requests permanently
without having to contact the origin server.
Permanent redirects notify the browser of the URL
change (by returning an HTTP status code 301) so
that the browser can update bookmarks.
redirect_temporary—redirects HTTP requests
temporarily without having to contact the origin
server. Temporary redirects notify the browser of the
URL change for the current request only (by
returning an HTTP status code 307).
Note: reverse_map is not supported.
target Enter the origin or from URL. You can enter up to four
components:
scheme://host:port/path_prefix
scheme can be http, https, or ftp.
strict URL Enable Match URL Exactly to force matching to be
matching flag exact against the entire requested URL.
Without this option, the URL is compared up to the end
of the target (From Path Prefix). If there is a match, the
redirect is applied. This can cause unwanted matching,
when the redirect URL includes the base URL. See
Mapping and Redirection, page 332.
replacement Enter the destination or to URL. You can enter up to four
components:
scheme://host:port/path_prefix
scheme can be http, https, or ftp.
Note
The scheme type (HTTP, HTTPS, FTP) of the target and
replacement must match.
Examples
The following section shows example mapping rules in the [Link] file.
The following rule temporarily redirects all HTTP requests for [Link]
to [Link]:
redirect_temporary [Link] http://
[Link]
[Link]
Note
It is recommended that all SOCKS configuration be
performed in the Content Gateway manager.
Important
After you modify this file, you must restart the proxy.
Traffic that does not match a manually configured rule is handled via a default rule. A
default rule is constructed for each SOCKS server with the default option enabled in
the Socks Servers table. Default rules are created automatically and displayed on the
SOCKS Server page. Default rules are not written in the [Link] file. The
destination IP address is ‘All’.
Format
To specify SOCKS servers that the proxy must use to reach specific origin servers,
add rules to the [Link] file in the following format:
dest_ip=ipaddress socksparent="alias1" [round_robin=value]
where:
Note
Each rule in [Link] can consist of a maximum of
400 characters. The order of the rules in the [Link]
file is not significant.
Examples
The following example configures the proxy to send requests to the origin servers
associated with the range of IP addresses [Link] - [Link] through the
SOCKS server aliases ‘alias1’ and ‘alias2’. Because the optional specifier
round_robin is set to strict, the proxy sends the first request to alias1, the second
request to alias2, the third request to alias1, and so on.
dest_ip=[Link] - [Link]
socksparent="alias; alias2" round_robin=strict
The following example configures the proxy to access the origin server associated
with the IP address [Link] directly, without going through the SOCKS server:
no_socks [Link]
The following example configures Content Gateway to access the origin servers
associated with the range of IP addresses [Link] - [Link] and the IP address
[Link] directly, without going through the SOCKS server:
no_socks [Link] - [Link], [Link]
socks_server.config
Format
To specify SOCKS servers use the following format:
alias=name host=IP_address|domain_name port=port_number
[username=user_name password=password] default=true|false
where:
name is the name of a SOCKS server.
IP_address or domain_name is an IP address or a domain name that can be
resolved by your DNS service.
port_number is the port on which the SOCKS server is listening.
username and password are the username/password pair for SOCKS 5
authentication. The password is encrypted.
Set default to true to make the specified server a default SOCKS server. When the
default server option is on, the SOCKS server is used when no SOCKS rule
matches.
If no SOCKS server is designated a default server, traffic that doesn’t match a rule
is not routed through a SOCKS server.
Examples:
This example adds the SOCKS server ‘default1’ at [Link] on port 61080. It is
designated a default SOCKS server.
alias=default1 host=[Link] port=61080 default=true
This example adds a SOCKS server that uses authentication. Note that the password,
“465751475058” is not the real password. It is encrypted.
alias=test1 host=[Link] port=1080 username=test
password=465751475058 default=false
Note
Each rule in socks_server.config cannot exceed 400
characters.
[Link]
Help | Content Gateway | Version 8.1.x
The [Link] file enables you to specify the DNS server that Content Gateway
should use for resolving hosts under specific conditions.
To specify a DNS server, you must supply the following information in each active
line within the file:
A primary destination specifier in the form of a destination domain, a destination
host, or a URL regular expression
A set of server directives, listing one or more DNS servers with corresponding
port numbers
You can also include the following optional information with each DNS server
specification:
A default domain for resolving hosts
A search list specifying the domain search order when multiple domains are
specified
For more information, see Using the Split DNS option, page 190.
Important
After you modify this file, run content_line -x from
the Content Gateway bin directory (/opt/WCG/bin) to
apply the changes. When you apply the changes to a node
in a cluster, Content Gateway applies the changes to all
nodes in the cluster.
Format
Each line in the [Link] file uses one of the following formats:
dest_domain=dest_domain | dest_host | url_regex
named=dns_server
def_domain=def_domain search_list=search_list
Examples
Consider the following DNS server selection specifications:
dest_domain=[Link] named=[Link]:212
[Link] def_domain=[Link]
search_list=[Link] [Link]
dest_domain=![Link] named=[Link]
[Link]
The [Link] file lists all the files, directories, or hard disk partitions that make
up the cache.
Important
After you modify this file, you must restart the proxy.
Format
The format of the [Link] file is:
pathname size
where pathname is the name of a partition, directory, or file, and size is the size of
the named partition, directory, or file, in bytes. You must specify a size for directories
or files. For raw partitions, size specification is optional.
You can use any partition of any size. For best performance, the following guidelines
are recommended:
Use raw disk partitions.
For each disk, make all partitions the same size.
For each node, use the same number of partitions on all disks.
Specify pathnames according to your operating system requirements. See the
following examples.
Important
In the [Link] file, a formatted or raw disk must be
at least 2 GB. The recommended disk cache size is
147 GB.
[Link]
A scheduled update performs a local HTTP GET on the objects at the specific time or
interval. You can control the following parameters for each specified object:
The URL
URL-specific request headers, which overrides the default
The update time and interval
The recursion depth
Important
After you modify this file, run content_line -x from
the Content Gateway bin directory (/opt/WCG/bin) to
apply the changes. When you apply the changes to a node
in a cluster, Content Gateway applies the changes to all
nodes in the cluster.
Format
Each line in the [Link] file uses the following format:
URL\request_headers\offset_hour\interval\recursion_depth\
Examples
The following example illustrates an HTTP scheduled update:
[Link] noname user
agent\13\3600\5\
This example specifies the URL and request headers, an offset hour of 13 (1 p.m.), an
interval of one hour, and a recursion depth of 5. This would result in updates at 13:00,
14:00, 15:00, and so on. To schedule for an update to occur only once a day, use an
interval value of 24 hours x 60 minutes x 60 seconds = 86400.
The following example illustrates an FTP scheduled update:
[Link]
test_file.cc\\18\120\0\
This example specifies the FTP request, an offset hour of 18 (6 p.m.), and an interval
of every two minutes. The user must be anonymous and the password must be
specified by the variable [Link].anonymous_passwd in the
[Link] file.
[Link]
The [Link] file stores the WCCP configuration information and service group
settings. When WCCP is enabled on the Configure > MyProxy > Basic page, WCCP
service group settings can be configured on the Configure > Networking > WCCP
page. Service groups must be defined if WCCP is to be used for transparent
redirection to Content Gateway. For more information, see Transparent interception
with WCCP v2 devices, page 50.
The following table lists messages that can appear in system log files. This list is not
exhaustive; it describes warning messages that can occur and might require your
attention. For information about warning messages not included in the list below, go
to [Link] and then navigate to Support and Knowledge Base.
Message Description
Accept port is not between 1 and The port specified in the [Link]
65535. Please check configuration. file that accepts incoming HTTP requests
is not valid.
Ftp accept port is not between 1 and The port specified in the [Link]
65535. file that accepts incoming FTP requests is
not valid.
Self loop is detected in parent proxy The name and port of the parent proxy are
configuration. the same as that of Content Gateway.
This creates a loop when Content
Gateway attempts to send requests to the
parent proxy.
Could not open the ARM device The ARM failed to load. The most
common reason for this is that the host
system has an incompatible system
kernel.
To see if the ARM is loaded, run:
/sbin/lsmod | grep arm
Message Description
content_manager failed to set cluster The content_manager process could not
IP address set the cluster IP address. Check the
cluster IP address. Make sure that it is not
already used by another device in the
network.
Unable to initialize storage. Cache initialization failed during startup.
(Re)Configuration required. The cache configuration should be
checked and configured or reconfigured.
Warnings
Message Description
Logfile error: error_number Generic logging error.
Bad cluster major version range Incompatible software versions causing a
version1-version2 for node problem.
IP address connect failed
can’t open config file filename for Custom logging is enabled, but Content
reading custom formats Gateway cannot find the [Link] file.
connect by disallowed client The specified client is not allowed to connect
IP address, closing connection to Content Gateway. The client IP address is
not listed in the ip_allow.config file.
Could not rename log filename to System error when renaming log file during
rolled filename roll.
Did this_amount of backup still to Congestion is approaching.
do remaining_amount
Different clustering minor Incompatible software versions causing a
versions version 1, version 2 for problem.
node IP address continuing
log format symbol symbol_name Custom log format references a field symbol
not found that does not exist. See Event Logging
Formats, page 383.
missing field for field marker Error reading a log buffer.
Unable to accept cluster Contact Websense Technical Support. Go to
connections on port: [Link]/support/ for Technical
cluster_port_number Support contact information
Unable to open log file filename, Cannot open the log file.
errno=error_number
Error accessing disk disk_name Content Gateway might have a cache read
problem. You might have to replace the disk.
Too many errors accessing disk Content Gateway is not using the cache disk
disk_name: declaring disk bad because it encountered too many errors. The
disk might be corrupt and might have to be
replaced.
Message Description
No cache disks specified in The Content Gateway [Link] file
[Link] file: cache disabled does not list any cache disks. Content
Gateway is running in proxy-only mode. You
must add the disks you want to use for the
cache to the [Link] file (see
[Link], page 494).
All disks are bad, cache disabled There is a problem with the cache disk(s) and
caching has been disabled. Please verify that
the cache disks are working and have been
properly formatted for caching. See
Configuring the Cache, page 99.
Missing DC parameter A required parameter was not specified.
<missing_param> on [Link] Please provide a value for the missing
line parameter.
Bad DC parameter <bad_param> - A specified Domain Controller parameter is
<dc_name> invalid. Please enter a valid value for the cited
parameter.
[ParentSelection] Proxy chaining is not working due to
<error_description> for default misconfiguration of the parent proxy in the
parent proxy child proxy. Please check the chaining
configuration of parent proxy values in the
child proxy.
WCCP2: Cannot find Interface No value is specified for the WCCP interface.
name. Please check that the In the Content Gateway manager, check
variable [Link].wccp2. Configure > Networking > WCCP >
ethernet_interface is set correctly General, or assign a value to
[Link].wccp2.ethernet_interface in
[Link].
ARMManager: Unable to read There is a format or configuration error in
network interface configuration [Link]. In the Content Gateway manager,
go to Configure > Networking > ARM >
General and click Edit File to view and
correct [Link].
Alarm messages
The following table describes alarm messages that you may see in the Content
Gateway manager.
Message Description/Solution
The Content Gateway subscription Please contact your Websense customer
has expired. service representative or Technical Support
for assistance.
Content Gateway subscription Content Gateway was unable to connect to
download failed. the download server to verify the
subscription information. Please check your
connection to the download server.
After several attempts, Content Verify that Content Gateway is able to
Gateway failed to connect to the access the Internet. Check firewall and
Websense Database Download upstream proxy server settings that might
Service. Please troubleshoot the prevent Content Gateway from connecting to
connection. the download server.
After several attempts, Content Verify that there is network connectivity
Gateway failed to connect to the between Content Gateway and the Web
Policy Server. Please troubleshoot module of TRITON AP-WEB. Sometimes
the connection. firewall settings block connectivity. Also
confirm that the Policy Server service is
running on the Web module host.
After several attempts, Content Verify that there is network connectivity
Gateway failed to connect to the between Content Gateway and the Web
Policy Broker. Please troubleshoot module of TRITON AP-WEB. Sometimes
the connection. firewall settings block connectivity. Also
confirm that the Policy Broker service is
running on the Web module host.
After several attempts, Content Verify that there is network connectivity
Gateway failed to connect to the between Content Gateway and the Web
Filter service. Please troubleshoot module of TRITON AP-WEB. Sometimes
the connection. firewall settings block connectivity. Also
confirm that the Filter Service process is
running on the Web module host.
Communication with the analytics Restart Content Gateway.
engine has failed. Please restart
Content Gateway.
SSL decryption has been disabled There was a fatal error in SSL Support.
due to an internal error, please Please restart Content Gateway.
restart Content Gateway.
[Rollback::Rollback] Config file is Go to the Content Gateway config directory
read-only: filename (default location is /opt/WCG/config) and
check the indicated file permissions; change
them if necessary.
Message Description/Solution
[Rollback::Rollback] Unable to Go to the Content Gateway config directory
read or write config file filename and make sure the indicated file exists.
Check its permissions and change them if
necessary.
[Content Gateway Manager] Go to the Content Gateway config directory
Configuration File Update Failed and check the indicated file permissions;
error_number change them if necessary.
Access logging suspended - The space allocated to the event log files is
configured space allocation full. You must either increase the space or
exhausted. delete some log files to enable access
logging to continue. To prevent this from
happening, consider rolling log files more
frequently and enabling the autodelete
feature. See Rolling event log files, page 253.
Access logging suspended - no The entire partition containing the event logs
more space on the logging is full. You must delete or move some log
partition. files to enable access logging to continue. To
prevent this from happening, consider
rolling log files more frequently and
enabling the autodelete feature. See Rolling
event log files, page 253.
Created zero length place holder for Go to the Content Gateway config directory
config file filename and check the indicated file. If it is indeed
zero in length, use a backup copy of the
configuration file.
Content Gateway can’t open Make sure that the
filename for reading custom [Link].log2.config_file variable in the
formats [Link] file contains the correct path
to the custom log configuration file (the
default is logging/[Link]).
Content Gateway could not open Check permissions for the indicated file and
logfile filename the logging directory.
Content Gateway failed to parse Check your custom log configuration file.
line line_number of the logging There may be syntax errors. See Custom
config file filename logging fields, page 383, for correct custom
log format fields.
vip_config binary is not setuid root, The content_manager process is not able to
manager will be unable to enable set virtual IP addresses. You must setuid root
virtual ip addresses for the vip_config file in the Content
Gateway bin directory.
Content Gateway cannot parse the The Universal Resource Identifier (URI) is
ICAP URI. Please ensure that the not in the correct format. Enter the URI as
URI is entered correctly in Content follows:
Gateway Manager or in the icap://hostname:port/path
[Link]
configuration variable. See Working With Web DLP, page 129 for
additional details on the format of the URI.
Message Description/Solution
The specified ICAP server does not The hostname in the [Link] file does
have a DNS entry. Please ensure not match any entries in the DNS. Ensure
that a valid DSS hostname is that the name of a valid TRITON AP-DATA
entered correctly in Content server is entered correctly in the Content
Gateway Manager or in the Gateway manager.
[Link] See Working With Web DLP, page 129 for
configuration variable. information on the format of the URI.
Content Gateway is not able to Ensure that the TRITON Management server
communicate with the DSS server. is up and running, and accepting connections
Please try again. on the port specified in the
[Link] variable.
Contact your TRITON AP-DATA
administrator if this message persists.
Domain controller The named NTLM domain controller is not
domain_controller_name:port is responding to requests and has been marked
down. as down. Investigation the status of the
domain controller.
Windows domain [domain name] This alarm can indicate any of the following:
unreachable or bad membership [Link] Active Directory is unreachable. The
status AD server is either down or there is a
network connectivity problem.
[Link] AD is reachable, but there is a
configuration problem that prevents it from
communicating with Content Gateway. For
example, the alarm is generated if the AD
has multiple Sites and the subnet that
Content Gateway resides on has not been
added to one of them.
The Scanning Data Files Update This alarm is a reminder that downloads of
option (My Proxy > Subscription) the security scanning data files used by
is set to ‘suspend updates’. To get Content Gateway analysis has been
the best Websense protection, set it suspended.
to ‘no delay’, or, on a backup It is recommended that you not clear this
system, use a time-based option. alarm until the delay time has been reset.
Websense Content Gateway returns detailed error messages to browser clients when
there are problems with the HTTP transactions requested by the browser. These
response messages correspond to standard HTTP response codes, but provide more
information. A list of the more frequently encountered HTTP response codes is
provided in Standard HTTP response messages, page 508. You can customize the
response messages.
The following table lists the Content Gateway hard-coded HTTP messages, their
corresponding HTTP response codes, and their corresponding customizable files.
The following standard HTTP response messages are provided for your information.
For a more complete list, see the Hypertext Transfer Protocol — HTTP/1.1
Specification.
Message Description
200 OK
202 Accepted
204 No Content
206 Partial Content
300 Multiple Choices
301 Moved Permanently
302 Found
303 See Other
304 Not Modified
400 Bad Request
401 Unauthorized; retry
403 Forbidden
404 Not Found
405 Method Not Allowed
406 Not acceptable
408 Request Timeout
500 Internal server error
501 Not Implemented
502 Bad Gateway
504 Gateway Timeout