Table of Contents

Preface

1. Summary of contents

2. Terminology

3. Target audience and prerequisites

4. Products covered in this guide

5. Typographical conventions

6. Contact and support information

6.1. Sales contact

6.2. Support contact

6.3. Training

7. About this document

7.1. Version information

7.2. Feedback

1. Proxies

1.1. General information on the proxy modules

1.1.1. Attribute values

1.1.2. Examples

1.1.3. Policies for requests and responses

1.1.4. Secondary sessions

1.1.5. Embedded protocol analysis

1.1.6. List of the proxies available in Zorp

1.2. Module Finger

1.2.1. The Finger protocol

1.2.2. Proxy behavior

1.2.3. Related standards

1.2.4. Classes in the Finger module

1.2.5. Class AbstractFingerProxy

1.2.6. Class FingerProxy

1.3. Module Ftp

1.3.1. The FTP protocol

1.3.2. Proxy behavior

1.3.3. Related standards

1.3.4. Classes in the Ftp module

1.3.5. Class AbstractFtpProxy

1.3.6. Class FtpProxy

1.3.7. Class FtpProxyAnonRO

1.3.8. Class FtpProxyAnonRW

1.3.9. Class FtpProxyRO

1.3.10. Class FtpProxyRW

1.4. Module Http

1.4.1. The HTTP protocol

1.4.2. Proxy behavior

1.4.3. Related standards

1.4.4. Classes in the Http module

1.4.5. Class AbstractHttpProxy

1.4.6. Class HttpProxy

1.4.7. Class HttpProxyNonTransparent

1.4.8. Class HttpProxyURIFilter

1.4.9. Class HttpProxyURIFilterNonTransparent

1.4.10. Class HttpWebdavProxy

1.4.11. Class NontransHttpWebdavProxy

1.5. Module Imap

1.5.1. The IMAP protocol

1.5.2. Proxy behavior

1.5.3. Related standards

1.5.4. Classes in the Imap module

1.5.5. Class AbstractImapProxy

1.5.6. Class ImapProxy

1.5.7. Class ImapProxyStrict

1.6. Module Ldap

1.6.1. The LDAP protocol

1.6.2. Proxy behavior

1.6.3. Configuring policies for LDAP requests

1.6.4. Simple Authentication and Security Layer (SASL) on LDAP messages

1.6.5. Related standards

1.6.6. Classes in the Ldap module

1.6.7. Class AbstractLdapProxy

1.6.8. Class LdapProxy

1.6.9. Class LdapProxyRO

1.7. Module Lp

1.7.1. The LPD protocol

1.7.2. Proxy behavior

1.7.3. Related standards

1.7.4. Classes in the Lp module

1.7.5. Class AbstractLpProxy

1.7.6. Class LpProxy

1.8. Module Mime

1.8.1. The MIME protocol

1.8.2. Proxy behavior

1.8.3. Related standards

1.8.4. Classes in the Mime module

1.8.5. Class AbstractMimeProxy

1.8.6. Class MimeProxy

1.9. Module MSRpc

1.9.1. The RPC protocol

1.9.2. Proxy behavior

1.9.3. Classes in the MSRpc module

1.9.4. Class AbstractMSRpcProxy

1.9.5. Class MSRpcProxy

1.10. Module Nntp

1.10.1. The NNTP Protocol

1.10.2. Proxy behavior

1.10.3. Related standards

1.10.4. Classes in the Nntp module

1.10.5. Class AbstractNntpProxy

1.10.6. Class NntpProxy

1.10.7. Class NntpProxyGroupFilter

1.10.8. Class NntpProxyRO

1.10.9. Class NntpProxyStrict

1.11. Module Plug

1.11.1. Proxy behavior

1.11.2. Related standards

1.11.3. Classes in the Plug module

1.11.4. Class AbstractPlugProxy

1.11.5. Class PlugProxy

1.12. Module Pop3

1.12.1. The POP3 protocol

1.12.2. Proxy behavior

1.12.3. Related standards

1.12.4. Classes in the Pop3 module

1.12.5. Class AbstractPop3Proxy

1.12.6. Class Pop3Proxy

1.13. Module Pssl

1.13.1. The SSL protocol

1.13.2. Proxy behavior

1.13.3. Related standards

1.13.4. Classes in the Pssl module

1.13.5. Class AbstractPsslProxy

1.13.6. Class PsslProxy

1.13.7. Class X509KeyBridge

1.14. Module Radius

1.14.1. The RADIUS protocol

1.14.2. Proxy behavior

1.14.3. Related standards

1.14.4. Classes in the Radius module

1.14.5. Class AbstractRadiusProxy

1.14.6. Class RadiusProxy

1.14.7. Class RadiusProxyStrict

1.15. Module Rdp

1.15.1. The Remote Desktop Protocol protocol

1.15.2. Proxy behavior

1.15.3. Classes in the Rdp module

1.15.4. Class AbstractRdpProxy

1.15.5. Class Rdp4FallbackProxy

1.15.6. Class Rdp4Proxy

1.15.7. Class Rdp5Proxy

1.15.8. Class Rdp5ProxyStrict

1.15.9. Class RdpProxy

1.16. Module Rsh

1.16.1. The RSH protocol

1.16.2. Proxy behavior

1.16.3. Related standards

1.16.4. Classes in the Rsh module

1.16.5. Class AbstractRshProxy

1.16.6. Class RshProxy

1.17. Module Sip

1.17.1. The SIP protocol

1.17.2. Related standards

1.17.3. Classes in the Sip module

1.17.4. Class AbstractSipProxy

1.17.5. Class SipProxy

1.18. Module Smtp

1.18.1. The SMTP protocol

1.18.2. Proxy behavior

1.18.3. Related standards

1.18.4. Classes in the Smtp module

1.18.5. Class AbstractSmtpProxy

1.18.6. Class SmtpProxy

1.19. Module SQLNet

1.19.1. The SQL*Net protocol

1.19.2. Proxy behavior

1.19.3. Related standards

1.19.4. Classes in the SQLNet module

1.19.5. Class AbstractSQLNetProxy

1.19.6. Class SQLNetProxy

1.20. Module Ssh

1.20.1. The Secure Shell protocol

1.20.2. Proxy behavior

1.20.3. Related standards

1.20.4. Classes in the Ssh module

1.20.5. Class AbstractSshProxy

1.20.6. Class SshProxy

1.20.7. Class SshSFtpProxy

1.21. Module Telnet

1.21.1. The Telnet protocol

1.21.2. Proxy behavior

1.21.3. Related standards

1.21.4. Classes in the Telnet module

1.21.5. Class AbstractTelnetProxy

1.21.6. Class TelnetProxy

1.21.7. Class TelnetProxyStrict

1.22. Module TFtp

1.22.1. The TFtp protocol

1.22.2. Proxy behavior

1.22.3. Related standards

1.22.4. Classes in the TFtp module

1.22.5. Class AbstractTFtpProxy

1.22.6. Class TFtpProxy

1.23. Module Vnc

1.23.1. The VNC protocol

1.23.2. Proxy behavior

1.23.3. Supported applications

1.23.4. Related standards

1.23.5. Classes in the Vnc module

1.23.6. Class AbstractVncProxy

1.23.7. Class VncProxy

1.24. Module Whois

1.24.1. The Whois protocol

1.24.2. Proxy behavior

1.24.3. Related standards

1.24.4. Classes in the Whois module

1.24.5. Class AbstractWhoisProxy

1.24.6. Class WhoisProxy

2. Core modules

2.1. How Zorp works

2.1.1. Zorp startup and initialization

2.1.2. Handling incoming connections

2.1.3. Proxy startup and the server-side connection

2.2. Module Auth

2.2.1. Authentication and authorization basics

2.2.2. Authentication and authorization in Zorp

2.2.3. Functions in module Auth

2.2.4. Classes in the Auth module

2.2.5. Functions

2.2.6. Class AbstractAuthentication

2.2.7. Class AbstractAuthorization

2.2.8. Class AuthCache

2.2.9. Class AuthenticationPolicy

2.2.10. Class AuthorizationPolicy

2.2.11. Class BasicAccessList

2.2.12. Class InbandAuthentication

2.2.13. Class NEyesAuthorization

2.2.14. Class PairAuthorization

2.2.15. Class PermitGroup

2.2.16. Class PermitTime

2.2.17. Class PermitUser

2.2.18. Class SatyrAuthentication

2.2.19. Class ServerAuthentication

2.2.20. Class ZAAuthentication

2.3. Module AuthDB

2.3.1. Classes in the AuthDB module

2.3.2. Class AbstractAuthenticationBackend

2.3.3. Class AuthenticationProvider

2.3.4. Class ZAS2AuthenticationBackend

2.4. Module Chainer

2.4.1. Selecting the network protocol

2.4.2. Classes in the Chainer module

2.4.3. Class AbstractChainer

2.4.4. Class ConnectChainer

2.4.5. Class FailoverChainer

2.4.6. Class MultiTargetChainer

2.4.7. Class RoundRobinChainer

2.4.8. Class SideStackChainer

2.4.9. Class StateBasedChainer

2.5. Module Config

2.6. Module Dispatch

2.6.1. Zone-based service selection

2.6.2. Classes in the Dispatch module

2.6.3. Class CSZoneDispatcher

2.6.4. Class Dispatcher

2.7. Module Domain

2.7.1. Classes in the Domain module

2.7.2. Class AbstractDomain

2.7.3. Class Inet6Domain

2.7.4. Class InetDomain

2.8. Module Matcher

2.8.1. Classes in the Matcher module

2.8.2. Class AbstractMatcher

2.8.3. Class CombineMatcher

2.8.4. Class DNSMatcher

2.8.5. Class MatcherPolicy

2.8.6. Class RegexpFileMatcher

2.8.7. Class RegexpMatcher

2.8.8. Class SmtpInvalidRecipientMatcher

2.8.9. Class WindowsUpdateMatcher

2.9. Module NAT

2.9.1. Classes in the NAT module

2.9.2. Class AbstractNAT

2.9.3. Class BalanceNAT

2.9.4. Class GeneralNAT

2.9.5. Class HashNAT

2.9.6. Class NATPolicy

2.9.7. Class OneToOneMultiNAT

2.9.8. Class OneToOneNAT

2.9.9. Class RandomNAT

2.9.10. Class StaticNAT

2.10. Module Notification

2.10.1. Classes in the Notification module

2.10.2. Class AbstractNotificationMethod

2.10.3. Class EmailNotificationMethod

2.10.4. Class NotificationPolicy

2.11. Module Proxy

2.11.1. Functions in module Proxy

2.11.2. Classes in the Proxy module

2.11.3. Functions

2.11.4. Class Proxy

2.12. Module Resolver

2.12.1. Classes in the Resolver module

2.12.2. Class AbstractResolver

2.12.3. Class DNSResolver

2.12.4. Class HashResolver

2.12.5. Class ResolverPolicy

2.13. Module Router

2.13.1. The source address used in the server-side connection

2.13.2. Classes in the Router module

2.13.3. Class AbstractRouter

2.13.4. Class DirectedRouter

2.13.5. Class InbandRouter

2.13.6. Class TransparentRouter

2.14. Module Service

2.14.1. Naming services

2.14.2. Determining the server and client zone

2.14.3. Classes in the Service module

2.14.4. Class AbstractService

2.14.5. Class PFService

2.14.6. Class Service

2.15. Module Session

2.15.1. Classes in the Session module

2.15.2. Class MasterSession

2.15.3. Class StackedSession

2.16. Module SockAddr

2.16.1. Functions in module SockAddr

2.16.2. Classes in the SockAddr module

2.16.3. Functions

2.16.4. Class SockAddrInet

2.16.5. Class SockAddrInetRange

2.16.6. Class SockAddrUnix

2.17. Module Stack

2.17.1. Classes in the Stack module

2.17.2. Class AbstractStackingBackend

2.17.3. Class RemoteStackingBackend

2.17.4. Class StackingProvider

2.18. Module Stream

2.18.1. Classes in the Stream module

2.18.2. Class Stream

2.19. Module Zone

2.19.1. Classes in the Zone module

2.19.2. Class InetZone

2.20. Module Zorp

2.20.1. Functions in module Zorp

2.20.2. Functions

Appendix 1. Additional proxy information

1.1. NNTP appendix

1.2. RADIUS appendix

1.3. SQL*Net appendix

1.4. TELNET appendix

Appendix 2. Manual pages

zorp — Zorp Firewall Suite

kzorp — Tool for the kzorp kernel module

instances.conf — zorp(8) instances database

policy.py — zorp(8) policy file.

zorpctl — Start and stop zorp instances.

zorpctl.conf — zorpctl(8) configuration file.

zms — Zorp Management Server engine

zms.conf — Configuration file format for the Zorp Management Server (zms(8).

zms-integrity — ZMS Database Integrity Checker

zms-transfer-agent — ZMS Transfer Agent

zmsagent.conf — Configuration file format for the Zorp Management Agents (zms-transfer-agent(8) and zms-monitor-agent(8)).

zms-monitor-agent — ZMS Monitor Agent

zas — Zorp Authentication Server

zas.cfg — zas(8) configuration file.

zcv — Zorp Content Vectoring Server

zcv.cfg — zcv(8) configuration file format

zqc — Zorp Quarantine Checker

zavupdate — Updates the various AntiVirus engine's databases and optionally the VirusBuster engine as well.

zavupdate.options — zavupdate(8) configuration files.

Appendix 3. Monitoring jobs reference

connect

diskfree

hastatus

iface

load

mem

mysql

ping

postfix

proc

raid

smtp

urlcheck

vmstat

zorp

Appendix 4. Global options of Zorp

4.1. Setting global options of Zorp

blob

audit

options

Index of Proxy attributes

Index of Core attributes

Index of all attributes