|
| |
| Sun Java System Web Proxy Server 4.0.1 Configuration File Reference | |
Chapter 5
Predefined SAFs in obj.confThis chapter describes the standard directives and predefined Server Application Functions (SAFs) that are used in the obj.conf file to give instructions to the server.
Each SAF has its own arguments, which are passed to it by a directive in obj.conf. Every SAF is also passed additional arguments that contain information about the request (such as what resource was requested and what kind of client requested it), and any other server variables created or modified by SAFs called by previously invoked directives. Each SAF may examine, modify, or create server variables. Each SAF returns a result code that tells the server whether it succeeded, did nothing, or failed.
This chapter includes functions that are part of the core functionality of Sun Java System Web Proxy Server. It does not include functions that are available only if additional components, such as server-parsed HTML, are enabled.
This chapter covers the following stages:
For an alphabetical list of predefined SAFs, see Alphabetical List of Predefined SAFs.
The following table lists the SAFs that can be used with each directive.
The bucket ParameterThe following performance buckets are predefined in Sun Java System Web Proxy Server:
You can define additional performance buckets in the magnus.conf file (see the perf-init and define-perf-bucket functions).
You can measure the performance of any SAF in obj.conf by adding a bucket=bucket-name parameter to the function, for example bucket=cache-bucket.
To list the performance statistics, use the service-dump Service function.
As an alternative, you can use the stats-xml Service function to generate performance statistics; use of buckets is optional.
For more information about performance buckets, see the Sun Java System Web Proxy Server 4.0.1 Administration Guide.
InitThe Init functions load and initialize server modules and plugins, and initialize log files.
Syntax
Init fn=function-name [parm1=value1]...[parmN=valueN]
function-name identifies the server initialization function to call. These functions shouldn’t be called more than once.
parm=value pairs are values for function-specific parameters. The number of parameters depends on the function you use. The order of the parameters doesn’t matter. The functions of the Init directive listed here are described in detail in the following sections.
- define-perf-bucket creates a performance bucket.
- flex-init initializes the flex-log flexible access logging feature
- flex-rotate-init enables rotation for flexible logs.
- host-dns-cache-init caches host names of the origin servers.
- icp-init initializes the ICP feature.
- init-clf initializes the Common Log File subsystem.
- init-filter-order controls the position of specific filters within filter stacks.
- init-j2ee initializes the Java subsystem. This is applicable only to the Administration Server.
- init-proxy initializes the networking code used by the proxy.
- init-uhome loads user home directory information.
- init-url-filter specifies one or more filter files of URLs. A filter file is a file that contains a list of URLs.
- ip-dns-cache-init configures DNS caching.
- load-modules tells the server to load functions from a shared object file.
- load-types maps file extensions to MIME types.
- nt-console-init enables the Windows console, which is the command-line shell that displays standard output and error streams.
- pa-init-parent-array initializes a parent array member and specifies information about the PAT file for the parent array of which it is a member.
- pa-init-proxy-array initializes a proxy array member and specifies information about the PAT file for the array of which it is a member.
- perf-init enables system performance measurement via performance buckets.
- pool-init configures pooled memory allocation.
- register-http-method lets you extend the HTTP protocol by registering new HTTP methods.
- stats-init enables reporting of performance statistics in XML format.
- suppress-request-headers configures the proxy server to remove outgoing headers from the request.
- thread-pool-init configures an additional thread pool.
- tune-cache allows you to tune the performance of your proxy server’s cache.
- tune-proxy allows you to tune the performance of your proxy server.You should not change the default settings.
define-perf-bucket
Applicable in Init-class directives.
The define-perf-bucket function creates a performance bucket, which you can use to measure the performance of SAFs in obj.conf.
Parameters
The following table describes parameters for the define-perf-bucket function.
Table 5-2 define-perf-bucket parameters
Parameter
Description
name
Name for the bucket (for example, cgi-bucket).
description
Description of what the bucket measures (for example, CGI Stats).
Example
See Also
flex-init
Applicable in Init-class directives.
The flex-init function opens the named log file to be used for flexible logging and establishes a record format for it. The log format is recorded in the first line of the log file. You cannot change the log format while the log file is in use by the server.
The flex-log function (applicable in AddLog-class directives) writes entries into the log file during the AddLog stage of the request-handling process.
The log file stays open until the server is shut down or restarted (at which time all logs are closed and reopened).
Note
If the server has AddLog-stage directives that call flex-log, the flexible log file must be initialized by flex-init during server initialization.
You may specify multiple log file names in the same flex-init function call. Then use multiple AddLog directives with the flex-log function to log transactions to each log file.
The flex-init function may be called more than once. Each new log file name and format will be added to the list of log files.
If you move, remove, or change the currently active log file without shutting down or restarting the server, client accesses might not be recorded. To save or backup the currently active log file, you need to rename the file and then restart the server. The server first looks for the log file by name, and if it doesn’t find it, creates a new one (the renamed original log file is left for you to use).
For information on rotating log files, see flex-rotate-init.
The flex-init function has three parameters: one that names the log file, one that specifies the format of each record in that file, and one that specifies the logging mode.
Parameters
The following table describes parameters for the flex-init function.
More on Log Format
The flex-init function recognizes anything contained between percent signs (%) as the name portion of a name-value pair stored in a parameter block in the server. (The one exception to this rule is the %SYSDATE% component, which delivers the current system date.) %SYSDATE% is formatted using the time format %d/%b/%Y:%H:%M:%S plus the offset from GMT.
Any additional text is treated as literal text, so you can add to the line to make it more readable. Typical components of the formatting parameter are listed in the following table Table 5-4. Certain components might contain spaces, so they should be bounded by escaped quotes (\").
If no format parameter is specified for a log file, the common log format is used:
"%Ses->client.ip% - %Req->vars.auth-user% [%SYSDATE%]
\"%Req->reqpb.clf-request%\" %Req->srvhdrs.clf-status%
%Req->srvhdrs.content-length%"You can now log cookies by logging the Req->headers.cookie.name component.
In the following table, the components that are enclosed in escaped double quotes (\") are the ones that could potentially resolve to values that have white spaces.
Examples
The first example below initializes flexible logging into the file <Install_Root><Instance_Directory>/logs/access.
Init fn="flex-init" access="$accesslog" format.access="%Ses->client.ip% - %Req->vars.auth-user% [%SYSDATE%] '%Req->reqpb.clf-request%' %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length%"
This will record the following items:
This is the default format, which corresponds to the Common Log Format (CLF).
It is advisable that the first six elements of any log always be in exactly this format, because a number of log analyzers expect that as output.
The second example initializes flexible logging into the file <Install_Root><Instance_Directory>/logs/extended.
The third example shows how logging can be tuned to prevent request handling threads from making blocking calls when writing to log files, instead delegating these calls to the log flush thread.
Doubling the size of the buffer-size and num-buffers parameters from their defaults and lowering the value of the LogFlushInterval magnus.conf directive to 4 seconds frees the request-handling threads to quickly write the log data.
Init fn=flex-init buffer-size=16384 num-buffers=2000 access="/<Install_Root><Instance_Directory>/logs/access" format.access="%Ses->client.ip% - %Req->vars.auth-user% [%SYSDATE%] \"%Req->reqpb.clf-request%\" %Req->srvhdrs.clf-status% %Req->srvhdrs.content-length%"
See Also
flex-rotate-init
Applicable in Init-class directives.
The flex-rotate-init function configures log rotation for all log files on the server, including error logs and the common-log, flex-log, and record-useragent AddLog SAFs. Call this function in the Init section of magnus.conf before calling flex-init. The flex-rotate-init function allows you to specify a time interval for rotating log files. At the specified time interval, the server moves the log file to a file whose name indicates the time of moving. The log functions in the AddLog stage in obj.conf then start logging entries in a new log file. The server does not need to be shut down while the log files are being rotated.
Note
The server keeps all rotated log files forever, so you will need to clean them up as necessary to free disk space.
By default, log rotation is disabled.
Parameters
The following table describes parameters for the flex-rotate-init function.
Table 5-5 flex-rotate-init parameters
Parameter
Description
rotate-start
Indicates the time to start rotation. This value is a four-digit string indicating the time in 24-hour format. For example, 0900 indicates 9 a.m., while 1800 indicates 9 p.m.
rotate-interval
Indicates the number of minutes to elapse between each log rotation.
rotate-access
(Optional) Determines whether common-log, flex-log, and record-useragent logs are rotated (AddLog SAFs). Values are yes (the default), and no.
rotate-error
(Optional) Determines whether error logs are rotated. Values are yes (the default), and no.
rotate-callback
(Optional) Specifies the file name of a user-supplied program to execute following log file rotation. The program is passed the post-rotation name of the rotated log file as its parameter.
Example
This example enables log rotation, starting at midnight and occurring every hour.
See Also
host-dns-cache-init
Applicable in Init-class directives.
The host-dns-cache-init function is used to cache host names of the origin servers. If DNS looks up are caches, then when the server gets a request from the client servers, it caches the server’s host name information.
Parameters
The following table describes parameters for the dns-cache-init function.
Table 5-6 host-dns-cache-init parameters
Parameter
Description
cache-size
(Optional) Specifies how many entries are contained in the cache. Acceptable values are 32 to 32768; the default value is 1024.
expire
(Optional) Specifies how long (in seconds) it takes for a cache entry to expire. Acceptable values are 1 to 31536000 (1 year); the default is 1200 seconds (20 minutes).
negative-dns-cache
To enable/disable caching invalid hostnames; the default is yes.
Example
icp-init
Applicable in Init-class directives.
The icp-init function enables and initializes ICP. ICP (Internet Cache Protocol) is an object location protocol that enables caches to communicate with one another. Caches can use ICP to send queries and replies about the existence of cached URLs and about the best locations from which to retrieve those URLs.
Syntax
Init fn=icp-init
config_file=file name
status=on|offParameters
The following table describes parameters for the icp-init function.
Table 5-7 icp-init parameters
Parameter
Description
config_file
The name of the ICP configuration file.
status
Specifies whether ICP is enabled or disabled.
Possible values are:
Example
init-clf
Applicable in Init-class directives.
The init-clf function opens the named log files to be used for common logging. The common-log function writes entries into the log files during the AddLog stage of the request-handling process. The log files stay open until the server is shut down (at which time the log files are closed) or restarted (at which time the log files are closed and reopened).
Note
If the server has an AddLog-stage directive that calls common-log, common log files must be initialized by init-clf during initialization.
Note
This function should only be called once. If it is called again, the new call will replace log file names from all previous calls.
If you move, remove, or change the log file without shutting down or restarting the server, client accesses might not be recorded. To save or backup a log file, you need to rename the file (and for UNIX, send the -HUP signal), and then restart the server. The server first looks for the log file by name, and if it doesn’t find it, creates a new one (the renamed original log file is left for you to use).
For information on rotating log files, see flex-rotate-init.
Parameters
The following table describes parameters for the init-clf function.
Table 5-8 init-clf parameters
Parameter
Description
logFileName
Name of the parameter is the name of the log file. The value of the parameter specifies either the full path to the log file or a file name relative to the server’s logs directory. For example:
access="/usr/netscape/server4/https-servername/logs/access"
mylogfile = "log1"You will use the log file name later, as a parameter to the common-log function (applicable in AddLog-class directives).
Examples
Init fn=init-clf access=/usr/netscape/server4/https-boots/logs/access
Init fn=init-clf templog=/tmp/mytemplog templog2=/tmp/mytemplog2
.
See Also
init-filter-order
Applicable in Init-class directives.
The init-filter-order Init SAF can be used to control the position of specific filters within filter stacks. For example, init-filter-order can be used to ensure that a filter that converts outgoing XML to XHTML is inserted above a filter that converts outgoing XHTML to HTML.
Filters that appear higher in the filter stack are given an earlier opportunity to process outgoing data, and filters that appear lower in the filter stack are given an earlier opportunity to process incoming data.
The appropriate position of a specific filter within the filter stack is defined by the filter developer. For example, filters that translate content from XML to HTML are placed higher in the filter stack than filters that compress data for transmission. Filter developers use the filter_create function to define the filter's position in the filter stack. init-filter-order can be used to override the position defined by the filter developer.
When two or more filters are defined to occupy the same position in the filter stack, filters that were inserted later will appear higher than filters that were inserted earlier. That is, the order of Input fn="insert-filter" and Output fn="insert-filter" directives in obj.conf becomes important. For example, consider two filters, xhtml-to-html and xml-to-xhtml, which convert XHTML to HTML and XML to XHTML, respectively. Since both filters transform data from one format to another, they may be defined to occupy the same position in the filter stack. To transform XML documents to XHTML and then to HTML before sending the data to the client, Output fn="insert-filter" directives in obj.conf would appear in the following order:
Output fn="insert-filter" filter="xhtml-to-html"
Output fn="insert-filter" filter="xml-to-xhtml"
In general, administrators should use the order of Input fn="insert-filter" and Output fn="insert-filter" directives in obj.conf to control the position of filters in the filter stack. init-filter-order should only be used to address specific filter interoperability problems.
Note
The load-module SAFs that create the filters should be called before init-filter-order attempts to order them.
Parameters
The following table describes parameters for the init-filter-order function.
Table 5-9 init-filter-order parameters
Parameter
Description
filters
Comma-separated list of filters in the order they should appear within a filter stack, listed from highest to lowest.
Example
init-j2ee
This is applicable to only the Administration Server.
Applicable in Init-class directives.
The init-j2ee function initializes the Java subsystem.
Parameters
This function requires a LateInit=yes parameter.
Example
Init fn="load-modules" shlib="install_dir/lib/libj2eeplugin.so" funcs="init-j2ee,ntrans-j2ee,service-j2ee,error-j2ee" shlib_flags="(global|now)"
Init fn="init-j2ee" LateInit=yes
init-proxy
Applicable in Init-class directives.
The init-proxy function initializes the Proxy Server’ s internal settings. This function is called during the initialization of the Proxy Server, but it should also be specified in the obj.conf to ensure that the values are initialized properly.
Syntax
Init fn=init-proxy
timeout=<seconds>
timeout-2=secondsParameters
The following table describes parameters for the init-proxy function.
Table 5-10 init-proxy parameters
Parameter
Description
timeout
The number of seconds of delay allowed between consecutive network packets received from the remote server. If the delay exceeds the timeout, the connection is dropped. The default is 120 seconds (2 minutes). This is not the maximum time allowed for an entire transaction, but the delay between the packets. For example, the entire transaction can last 15 minutes, as long as at least one packet of data is received before each timeout period.
timeout-2
(timeout after interrupt)
The timeout after interrupt value tells the Proxy Server how much time it has to continue writing a cache file after a client has aborted the transaction. In other words, if the Proxy Server has almost finished caching a document and the client aborts the connection, the server can continue caching the document until it reaches the timeout after interrupt value.
The highest recommended timeout after interrupt value is 5 minutes. The default value is 15 seconds.
Example
init-uhome
Applicable in Init-class directives.
UNIX Only. The init-uhome function loads information about the system’s user home directories into internal hash tables. This increases memory usage slightly, but improves performance for servers that have a lot of traffic to home directories.
Parameters
The following table describes parameters for the init-uhome function.
Table 5-11 init-uhome parameters
Parameter
Description
pwfile
(Optional) Specifies the full file system path to a file other than /etc/passwd. If not provided, the default UNIX path (/etc/passwd) is used.
Examples
init-url-filter
Applicable in Init-class directives.
The init-url-filter function specifies one or more filter files of URLs. A filter file is a file that contains a list of URLs.
Parameters
You can pass one or more parameters to this SAF and associate each parameter to a filter file of URLs. These parameter names may be used later in url-filter SAF to either allow or deny these filter files of URLs.
Example
PathCheck fn="init-url-filter" filt1="/path/to/filter/file1" filt2="/path/to/filter/file2" filt3="/path/to/filter/file3" etc...
ip-dns-cache-init
Applicable in Init-class directives.
The ip-dns-cache-init function specifies that DNS lookups should be cached when DNS lookups are enabled. If DNS lookups are cached, then when the server gets a client’s host name information, it stores that information in the DNS cache. If the server needs information about the client in the future, the information is available in the DNS cache.
You may specify the size of the DNS cache and the time it takes before a cache entry becomes invalid. The DNS cache can contain 32 to 32768 entries; the default value is 1024 entries. Values for the time it takes for a cache entry to expire (specified in seconds) can range from 1 second to 1 year; the default value is 1200 seconds (20 minutes).
Parameters
The following table describes parameters for the ip-dns-cache-init function.
Table 5-12 ip-dns-cache-init parameters
Parameter
Description
cache-size
(Optional) Specifies how many entries are contained in the cache. Acceptable values are 32 to 32768; the default value is 1024.
expire
(Optional) Specifies how long (in seconds) it takes for a cache entry to expire. Acceptable values are 1 to 31536000 (1 year); the default is 1200 seconds (20 minutes).
Example
load-modules
Applicable in Init-class directives.
The load-modules function loads a shared library or dynamic-link library (DLL) into the server code. Specified functions from the library can then be executed from any subsequent directives. Use this function to load new plugins or SAFs.
If you define your own SAFs, you get the server to load them by using the load-modules function and specifying the shared library or DLL to load.
Parameters
The following table describes parameters for the load-modules function.
Table 5-13 load-modules parameters
Parameter
Description
shlib
Specifies either the full path to the shared library or DLL, or a file name relative to the server configuration directory.
funcs
Comma-separated list of the names of the functions in the shared library or DLL to be made available for use by other Init directives or by Service directives in obj.conf. The list should not contain any spaces. The dash (-) character may be used in place of the underscore (_) character in function names.
NativeThread
(Optional) Specifies which threading model to use.
no causes the routines in the library to use user-level threading.
yes enables kernel-level threading. The default is yes.
pool
Name of a custom thread pool, as specified in thread-pool-init.
Examples
Init fn=load-modules shlib="C:/mysrvfns/corpfns.dll" funcs="moveit"
Init fn=load-modules shlib="/mysrvfns/corpfns.so" funcs="myinit,myservice"
Init fn=myinit
load-types
Applicable in Init-class directives.
The load-types function scans a file that tells it how to map filename extensions to MIME types. MIME types are essential for network navigation software like Netscape Navigator to tell the difference between file types. For example, they are used to tell an HTML file from a GIF file. See MIME Types.for more information.
Calling this function is crucial if you use Web Proxy Server Manager online forms or the FTP proxying capability.
Syntax
Init fn=load-types
mime-types="mime.types"This function loads the MIME type file mime.types from the configuration directory (the same directory as magnus.conf and obj.conf). This function call is mandatory and in practice is always as shown in the syntax.
Parameters
The following table describes parameters for the load-types function.
Table 5-14 load-types parameters
Parameter
Description
mime-types
specifies either the full path to the global MIME types file or a filename relative to the server configuration directory. The proxy server comes with a default file called mime.types.
local-types
Optional parameter to a file with the same format as the global MIME types file, but it is used to maintain types that are applicable only to your server.
Example
Init fn=load-types mime-types=mime.types
Init fn=load-types mime-types=/tp/mime.types \
local-types=local.typesnt-console-init
Applicable in Init-class directives.
The nt-console-init function enables the Windows console, which is the command-line shell that displays standard output and error streams.
Parameters
The following table describes parameters for the nt-console-init function.
Table 5-15 nt-console-init parameters
Parameter
Description
stderr
Directs error messages to the Windows console. The required and only value is console.
stdout
Directs output to the Windows console. The required and only value is console.
Example
pa-init-parent-array
Applicable in Init-class directives.
The pa-init-parent-array function initializes a parent array member and specifies information about the PAT file for the parent array of which it is a member.
Note
The load modules directive should come before the pa-init-proxy-array function in the obj.conf file.
Syntax
Init fn=pa-init-parent-array
set-status-fn=pa-set-member-status
poll="yes|no"
file="absolute filename"
pollhost="host name"
pollport="port number"
pollhdrs="absolute filename"
pollurl="url"
status="on|off"Parameters
The following table describes parameters for the pa-init-parent-array function.
Table 5-16 pa-init-parent-array parameters
Parameter
Description
set-status-fn
specifies the function that sets the status for the member.
poll
Tells the array member whether or not it needs to poll for a PAT file.
- yes means that the member should poll for the PAT file. A member should only poll for a PAT file if it is not the master proxy. The master proxy has a local copy of the PAT file, and therefore, does not need to poll for it.
- no means that the member should not poll for the PAT file. A member should not poll for the PAT file if it is the master proxy.
file
The full pathname of the PAT file.
pollhost
The host name of the proxy to be polled for the PAT file. This parameter only needs to be specified if the poll parameter is set to yes, meaning that the member is not the master proxy.
pollport
is the port number on the pollhost that should be contacted when polling for the PAT file. This parameter only needs to be specified if the poll parameter is set to yes, meaning that the member is not the master proxy.
pollhdrs
is the full pathname of the file that contains any special headers that must be sent with the HTTP request for the PAT file. This parameter is optional and should only be specified if the poll parameter is set to yes, meaning that the member is not the master proxy.
pollurl
is the URL of the PAT file to be polled for. This parameter only needs to be specified if the poll parameter is set to yes, meaning that the member is not the master proxy.
status
specifies whether the parent array member is on or off.
Example
The following example tells the member not to poll for the PAT file. This example would apply to a master proxy.
Init fn=pa-init-parent-array
poll="no"
file="c:/netscape/server/bin/proxy/pa1.pat"The following example specifies that the member should poll for a PAT file. This member is not the master proxy.
Init fn=pa-init-parent-array
poll="yes"
file="c:/netscape/server/bin/proxy/pa2.pat"
pollhost="proxy1"
pollport="8080"
pollhdrs="c:/netscape/server/proxy-name/parray/pa2.hdr"
status="on"
set-status-fn=set-member-status
pollurl="/pat"pa-init-proxy-array
Applicable in Init-class directives.
The pa-init-proxy-array function initializes a proxy array member and specifies information about the PAT file for the array of which it is a member.
Note
The load modules directive should come before the pa-init-proxy-array function in the obj.conf file.
Syntax
Init fn=pa-init-proxy-array
set-status-fn=pa-set-member-status
poll="yes|no"
file="absolute filename"
pollhost="host name"
pollport="port number"
pollhdrs="absolute filename"
pollurl="url"
status="on|off"Parameters
The following table describes parameters for the pa-init-proxy-array function.
Table 5-17 pa-init-proxy-array parameters
Parameter
Description
set-status-fn
specifies the function that sets the status for the member.
poll
Tells the array member whether or not it needs to poll for a PAT file.
- yes means that the member should poll for the PAT file. A member should only poll for a PAT file if it is not the master proxy. The master proxy has a local copy of the PAT file, and therefore, does not need to poll for it.
- no means that the member should not poll for the PAT file. A member should not poll for the PAT file if it is the master proxy.
file
The full pathname of the PAT file.
pollhost
The host name of the proxy to be polled for the PAT file. This parameter only needs to be specified if the poll parameter is set to yes, meaning that the member is not the master proxy.
pollport
iThe port number on the pollhost that should be contacted when polling for the PAT file. This parameter only needs to be specified if the poll parameter is set to yes, meaning that the member is not the master proxy.
pollhdrs
iThe full pathname of the file that contains any special headers that must be sent with the HTTP request for the PAT file. This parameter is optional and should only be specified if the poll parameter is set to yes, meaning that the member is not the master proxy.
pollurl
iThe URL of the PAT file to be polled for. This parameter only needs to be specified if the poll parameter is set to yes, meaning that the member is not the master proxy.
status
Specifies whether the parent array member is on or off.
Example
The following example tells the member not to poll for the PAT file. This example would apply to a master proxy.
Init fn=pa-init-proxy-array
poll="no"
file="c:/netscape/server/bin/proxy/pa1.pat"The following example specifies that the member should poll for a PAT file. This member is not the master proxy.
Init fn=pa-init-proxy-array
poll="yes"
file="c:/netscape/server/bin/proxy/pa2.pat"
pollhost="proxy1"
pollport="8080"
pollhdrs="c:/netscape/server/proxy-name/parray/pa2.hdr"
status="on"
set-status-fn=set-member-status
pollurl="/pat"perf-init
Applicable in Init-class directives.
The perf-init function enables system performance measurement via performance buckets.
Parameters
The following table describes parameters for the perf-init function.
Table 5-18 perf-init parameters
Parameter
Description
disable
Flag to disable the use of system performance measurement via performance buckets. Should have a value of true or false. Default value is true.
Example
See Also
pool-init
Applicable in Init-class directives.
The pool-init function changes the default values of pooled memory settings. The size of the free block list may be changed or pooled memory may be entirely disabled.
Memory allocation pools allow the server to run significantly faster. If you are programming with the NSAPI, note that MALLOC, REALLOC, CALLOC, STRDUP, and FREE work slightly differently if pooled memory is disabled. If pooling is enabled, the server automatically cleans up all memory allocated by these routines when each request completes. In most cases, this will improve performance and prevent memory leaks. If pooling is disabled, all memory is global and there is no clean-up.
If you want persistent memory allocation, add the prefix PERM_ to the name of each routine (PERM_MALLOC, PERM_REALLOC, PERM_CALLOC, PERM_STRDUP, and PERM_FREE).
Note
Any memory you allocate from Init-class functions will be allocated as persistent memory, even if you use MALLOC. The server cleans up only the memory that is allocated while processing a request, and because Init-class functions are run before processing any requests, their memory is allocated globally.
Parameters
The following table describes parameters for the pool-init function.
Table 5-19 pool-init parameters
Parameter
Description
free-size
(Optional) Maximum size in bytes of free block list. May not be greater than 1048576.
disable
(Optional) Flag to disable the use of pooled memory. Should have a value of true or false. Default value is false.
Example
register-http-method
Applicable in Init-class directives.
This function lets you extend the HTTP protocol by registering new HTTP methods. (You do not need to register the default HTTP methods.)
Upon accepting a connection, the server checks if the method it received is known to it. If the server does not recognize the method, it returns a “501 Method Not Implemented” error message.
Parameters
The following table describes parameters for the register-http-method function.
Table 5-20 register-http-method parameters
Parameter
Description
methods
Comma-separated list of the names of the methods you are registering.
Example
The following example shows the use of register-http-method and a Service function for one of the methods.
Init fn="register-http-method" methods="MY_METHOD1,MY_METHOD2"
Service fn="MyHandler" method="MY_METHOD1"
stats-init
Applicable in Init-class directives.
The stats-init function enables reporting of performance statistics in XML format. The actual report is generated by the stats-xml function in obj.conf.
Parameters
The following table describes parameters for the stats-init function.
Table 5-21 stats-init parameters
Parameter
Description
update-interval
Period in seconds between statistics updates within the server. Set higher for better performance, lower for more frequent updates. The minimum value is 1; the default is 5.
profiling
Enables NSAPI performance profiling using buckets if set to yes. This can also be enabled through the perf-init Init SAF. The default is no, which results in slightly better server performance.
Example
suppress-request-headers
Applicable in Init-class and ObjectType-class directives.
If you specify this function at the Init stage it applies to the entire proxy (for all the requests ).
If you specify this function at ObjectType stage you can control suppressing outgoing headers functionality for different objects in the obj.conf file.
The suppress-request-headers function configures the proxy server to remove outgoing headers from the request. It accepts one or more hdr parameters through which you can specify multiple headers you want to suppress.
For example, you might want to prevent the from and Cookie headers from going out because it reveals the user’s credentials.
Parameters
The following table describes parameters for the suppress-request-headers function.
Table 5-22 suppress-request-headers parameters
Parameter
Description
hdr
Name of the HTTP request header to be suppressed.
Example
thread-pool-init
Applicable in Init-class directives.
The thread-pool-init function creates a new pool of user threads. A pool must be declared before it is used. To tell a plugin to use the new pool, specify the pool parameter when loading the plugin with the Init-class function load-modules.
One reason to create a custom thread pool would be if a plugin is not thread-aware, in which case you can set the maximum number of threads in the pool to 1.
The older parameter NativeThread=yes always engages one default native pool, called NativePool.
The native pool on UNIX is normally not engaged, as all threads are OS-level threads. Using native pools on UNIX may introduce a small performance overhead, as they’ll require an additional context switch; however, they can be used to localize the jvm.stickyAttach effect or for other purposes, such as resource control and management, or to emulate single-threaded behavior for plugins.
On Windows, the default native pool is always being used and Sun Java System Web Proxy Server uses fibers (user-scheduled threads) for initial request processing. Using custom additional pools on Windows introduces no additional overhead.
In addition, native thread pool parameters can be added to the magnus.conf file for convenience.
Parameters
The following table describes parameters for the thread-pool-init function.
Table 5-23 thread-pool-init parameters
Parameter
Description
name
Name of the thread pool.
maxthreads
Maximum number of threads in the pool.
minthreads
Minimum number of threads in the pool.
queueSize
Size of the queue for the pool. If all threads in the pool are busy, further request-handling threads that want to get a thread from the pool will wait in the pool queue. The number of request-handling threads that can wait in the queue is limited by the queue size. If the queue is full, the next request-handling thread that comes to the queue is turned away, with the result that the request is turned down, but the request-handling thread remains free to handle another request instead of becoming locked up in the queue.
stackSize
Stack size of each thread in the native (kernel) thread pool.
Example
Init fn=thread-pool-init name="my-custom-pool" maxthreads=5 minthreads=1 queuesize=200
Init fn=load-modules shlib="C:/mydir/myplugin.dll" funcs="tracker" pool="my-custom-pool"
See Also
tune-cache
Applicable in Init-class directives.
The tune-cache function allows you to tune the performance of your proxy server’s cache. You should not change the default settings unless directed to do so by Sun Technical Support.
Syntax
Init fn=tune-cache
byte-rangesParameters
The following table describes the parameter for the tune-cache function.
Table 5-24 tune-cache parameters
Parameter
Description
byte-ranges
Determines whether or not the proxy is allowed to generate byte-range responses from the cache. By default, this feature is disabled.
Example
tune-proxy
Applicable in Init-class directives.
The tune-proxy function allows you to tune the performance of your proxy server.You should not change the default settings.
Syntax
Init fn=tune-proxy
ftp-listing-width=numberParameters
The following table describes the parameter for the tune-proxy function.
Table 5-25 tune-cache parameters
Parameter
Description
ftp-listing-width
You may want to modify the width of FTP listings to better suit your needs.Increasing listing width allows longer file names and thus reduces filename truncation. The default width is 80 characters.
Example
Summary of Init Functions
The following table lists the Init functions available in the obj.conf file:
Table 5-26 Init functions
Function/Parameter
Allowed Values
Default Value
Description
define-perf-bucket
Creates a performance bucket, which you can use to measure the performance of SAFs in obj.conf (see the Sun Java system Web Proxy Server4.0.1 NSAPI Developer’s Guide). This function works only if the perf-init function is enabled.
name
A name for the bucket, for example cgi-bucket.
description
A description of what the bucket measures, for example CGI Stats.
dns-cache-init
Configures DNS caching.
cache-size
32 to 32768 (32K)
1024
(optional) Specifies how many entries are contained in the cache.
expire
1 to 31536000
seconds (1 year)1200 seconds (20 minutes)
(optional) specifies how long (in seconds) it takes for a cache entry to expire.
flex-init
Initializes the flexible logging system.
logFileName
A path or file name
The full path to the log file or a file name relative to the server’s logs directory. In this example, the log file name is access and the path is /logdir/access:
access="/logdir/access"
format.logFileName
Specifies the format of each log entry in the log file.
relaxed.logFileName
true, on, yes, or 1;
false, off, no, or 0
Turns on relaxed logging, which skips logging components that would normally block static page acceleration if static page acceleration is enabled.
buffer-size
Number of bytes
8192
Specifies the size of the global log buffer.
buffers-per-file
The lower bound is 1. There always needs to be at least one buffer per file.
The upper bound is dictated by the number of buffers that exist. The upper bound on the number of buffers that exist can be defined by the num-buffers parameter.
Determined by the server
Specifies the number of buffers for a given log file
num-buffers
1000
Specifies the maximum number of logging buffers to use.
thread-buffer-size
Number of bytes
8192 (8 KB)
Specifies the size of the per thread log buffer.
flex-rotate-init
Enables rotation for logs.
rotate-start
A 4-digit string indicating the time in 24-hour format
Indicates the time to start rotation. For example, 0900 indicates 9 am while 1800 indicates 9 pm.
rotate-interval
Number of minutes
Indicates the number of minutes to elapse between each log rotation.
rotate-access
yes, no
yes
(optional) determines whether common-log, flex-log, and record-useragent logs are rotated. For more information, see the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
rotate-error
yes, no
yes
(optional) determines whether error logs are rotated.
rotate-callback
A path
(optional) specifies the file name of a user-supplied program to execute following log file rotation. The program is passed the post-rotation name of the rotated log file as its parameter.
init-cgi
Changes the default settings for CGI programs.
timeout
Number of seconds
300
(optional) specifies how many seconds the server waits for CGI output before terminating the script.
cgistub-path
(optional) specifies the path to the CGI stub binary. If not specified, iPlanet Web Server looks in the following directories, in the following order, relative to the server instance’s config directory: ../private/Cgistub, then ../../bin/https/bin/Cgistub.
For information about installing an suid Cgistub, see the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
env-variable
(optional) specifies the name and value for an environment variable that the server places into the environment for the CGI.
init-clf
Initializes the Common Log subsystem.
logFileName
A path or file name
Specifies either the full path to the log file or a file name relative to the server’s logs directory.
init-uhome
Loads user home directory information.
pwfile
(optional) specifies the full file system path to a file other than /etc/passwd. If not provided, the default UNIX path (/etc/passwd) is used.
load-modules
Loads shared libraries into the server.
shlib
Specifies either the full path to the shared library or dynamic link library or a file name relative to the server configuration directory.
funcs
A comma separated list with no spaces
A list of the names of the functions in the shared library or dynamic link library to be made available for use by other Init or Service directives. The dash (-) character may be used in place of the underscore (_) character in function names.
NativeThread
yes, no
yes
(optional) specifies which threading model to use. no causes the routines in the library to use user-level threading. yes enables kernel-level threading.
pool
The name of a custom thread pool, as specified in thread-pool-init.
nt-console-init
Enables the NT console, which is the command-line shell that displays standard output and error streams.
stderr
console
Directs error messages to the NT console.
stdout
console
Directs output to the NT console.
perf-init
Enables system performance measurement via performance buckets.
disable
true, false
true
Disables the function when true.
pool-init
Configures pooled memory allocation.
free-size
1048576 bytes or less
(optional) maximum size in bytes of free block list.
disable
true, false
false
(optional) flag to disable the use of pooled memory if true.
register-http-method
Lets you extend the HTTP protocol by registering new HTTP methods.
methods
A comma separated list
Names of the methods you are registering.
stats-init
Enables reporting of performance statistics in XML format.
profiling
yes, no
no
Enables NSAPI performance profiling using buckets. This can also be enabled through perf-init.
update-interval
1 or greater
5
The period in seconds between statistics updates within the server.
virtual-servers
1 or greater
1000
The maximum number of virtual servers for which statistics are tracked. This number should be set higher than the number of virtual servers configured.
thread-pool-init
Configures an additional thread pool.
name
Name of the thread pool.
maxthreads
Maximum number of threads in the pool.
minthreads
Minimum number of threads in the pool.
queueSize
Number of bytes
Size of the queue for the pool.
stackSize
Number of bytes
Stack size of each thread in the native (kernel) thread pool.
AuthTransAuthTrans stands for Authorization Translation. AuthTrans directives give the server instructions for checking authorization before allowing a client to access resources. AuthTrans directives work in conjunction with PathCheck directives. Generally, an AuthTrans function checks if the user name and password associated with the request are acceptable, but it does not allow or deny access to the request; that is left to a PathCheck function.
The server handles the authorization of client users in two steps:
The authorization process is split into two steps so that multiple authorization schemes can be easily incorporated, and to provide the flexibility to have resources that record authorization information, but do not require it.
AuthTrans functions get the user name and password from the headers associated with the request. When a client initially makes a request, the user name and password are unknown so the AuthTrans functions and PathCheck functions work together to reject the request, since they can’t validate the user name and password. When the client receives the rejection, its usual response is to present a dialog box asking for the user name and password to enter the appropriate realm, and then the client submits the request again, this time including the user name and password in the headers.
If there is more than one AuthTrans directive in obj.conf, each function is executed in order until one succeeds in authorizing the user.
The following AuthTrans-class functions are described in detail in this section:
- basic-auth calls a custom function to verify user name and password. Optionally determines the user’s group.
- basic-ncsa verifies user name and password against an NCSA-style or system DBM database. Optionally determines the user’s group.
- get-sslid retrieves a string that is unique to the current SSL session and stores it as the ssl-id variable in the Session->client parameter block.
- match-browser matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- proxy-auth translates authorization information provided through the basic proxy authorization scheme.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
basic-auth
Applicable in AuthTrans-class directives.
The basic-auth function calls a custom function to verify authorization information sent by the client. The Authorization header is sent as part of the basic server authorization scheme.
This function is usually used in conjunction with the PathCheck-class function require-auth.
Parameters
The following table describes parameters for the basic-auth function.
Table 5-27 basic-auth parameters
Parameter
Description
auth-type
Specifies the type of authorization to be used. This should always be basic.
userdb
(Optional) Specifies the full path and file name of the user database to be used for user verification. This parameter will be passed to the user function.
userfn
Name of the user custom function to verify authorization. This function must have been previously loaded with load-modules. It has the same interface as all of the SAFs, but it is called with the user name (user), password (pw), user database (userdb), and group database (groupdb) if supplied, in the pb parameter. The user function should check the name and password using the database and return REQ_NOACTION if they are not valid. It should return REQ_PROCEED if the name and password are valid. The basic-auth function will then add auth-type, auth-user (user), auth-db (userdb), and auth-password (pw, Windows only) to the rq->vars pblock.
groupdb
(Optional) Specifies the full path and file name of the user database. This parameter will be passed to the group function.
groupfn
(Optional) Name of the group custom function that must have been previously loaded with load-modules. It has the same interface as all of the SAFs, but it is called with the user name (user), password (pw), user database (userdb), and group database (groupdb) in the pb parameter. It also has access to the auth-type, auth-user (user), auth-db (userdb), and auth-password (pw, Windows only) parameters in the rq->vars pblock. The group function should determine the user’s group using the group database, add it to rq->vars as auth-group, and return REQ_PROCEED if found. It should return REQ_NOACTION if the user’s group is not found.
(Optional) Common to all obj.conf functions.
Examples
In magnus.conf:
In obj.conf:
AuthTrans fn=basic-auth auth-type=basic userfn=hardcoded_auth
PathCheck fn=require-auth auth-type=basic realm="Marketing Plans"
See Also
basic-ncsa
Applicable in AuthTrans-class directives.
The basic-ncsa function verifies authorization information sent by the client against a database. The Authorization header is sent as part of the basic server authorization scheme.
This function is usually used in conjunction with the PathCheck-class function require-auth.
Parameters
The following table describes parameters for the basic-ncsa function.
Table 5-28 basic-auth parameters
Parameter
Description
auth-type
Specifies the type of authorization to be used. This should always be basic.
dbm
(Optional) Specifies the full path and base file name of the user database in the server's native format. The native format is a system DBM file, which is a hashed file format allowing instantaneous access to billions of users. If you use this parameter, don’t use the userfile parameter as well.
userfile
(Optional) Specifies the full path name of the user database in the NCSA-style HTTPD user file format. This format consists of lines using the format name:password, where password is encrypted. If you use this parameter, don’t use dbm.
grpfile
(Optional) Specifies the NCSA-style HTTPD group file to be used. Each line of a group file consists of group:user1 user2. userN where each user is separated by spaces.
(Optional) Common to all obj.conf functions.
Examples
AuthTrans fn=basic-ncsa auth-type=basic dbm=/sun/server61/userdb/rs
PathCheck fn=require-auth auth-type=basic realm="Marketing Plans"
AuthTrans fn=basic-ncsa auth-type=basic userfile=/sun/server61/.htpasswd grpfile=/sun/server61/.grpfile
PathCheck fn=require-auth auth-type=basic realm="Marketing Plans"
See Also
get-sslid
Applicable in AuthTrans-class directives.
Note
This function is provided for backward compatibility only. The functionality of get-sslid has been incorporated into the standard processing of an SSL connection.
The get-sslid function retrieves a string that is unique to the current SSL session, and stores it as the ssl-id variable in the Session->client parameter block.
If the variable ssl-id is present when a CGI is invoked, it is passed to the CGI as the HTTPS_SESSIONID environment variable.
The get-sslid function has no parameters and always returns REQ_NOACTION. It has no effect if SSL is not enabled.
Parameters
The following table describes parameters for the get-sslid function.
match-browser
Applicable in all stage directives.
The match-browser SAF matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
Syntax
stage fn="match-browser" browser="string" name="value" [name="value" ...]
Parameters
The following table describes parameter values for the match-browser function.
Table 5-30 match-browser parameter values
Value
Description
stage
Stage directive used in obj.conf processing (NameTrans, PathCheck, and so on). The match-browser function is applicable in all stage directives.
string
Wildcard pattern to compare against the User-Agent header (for example, "*Mozilla*").
name
Variable to be changed. The match-browser SAF indirectly invokes the set-variable SAF. For a list of valid variables, see set-variable.
value
New value for the specified variable.
Example
The following AuthTrans directive instructs Sun Java System Web Proxy Server to do as follows when the browser's User-Agent header contains the string Broken or broken. The server will:
- Not send the SSL3 and TLS close_notify packet (see ssl-unclean-shutdown).
- Not honor requests for HTTP Keep-Alive (see keep-alive).
- Use the HTTP/1.0 protocol rather than HTTP/1.1 (see http-downgrade).
See Also
proxy-auth
Applicable in AuthTrans-class directives.
The proxy-auth function of the AuthTrans directive translates authorization information provided through the basic proxy authorization scheme. This scheme is similar to the HTTP authorization scheme but doesn’t interfere with it, so using proxy authorization doesn’t block the ability to authenticate to the remote server.
This function is usually used with the PathCheck fn=require-proxy-auth function.
Syntax
AuthTrans fn=proxy-auth auth-type=basic
dbm=full path nameAuthTrans fn=proxy-auth auth-type=basic
userfile=full path name
grpfile=full path nameParameters
The following table describes parameter values for the proxy-auth function.
Table 5-31 proxy-auth parameter values
Value
Description
auth-type
Specifies the type of authorization to be used. The type should be “basic” unless you are running a UNIX proxy and are going to use your own function to perform authentication.
dbm
Specifies the full path and base filename of the user database in the server’s native format. The native format is a system DBM file, which is a hashed file format allowing instantaneous access to billions of users. If you use this parameter, don’t use the userfile parameter.
userfile
Specifies the full pathname of the user database in the NCSA-style httpd user file format. This format consists of name:password lines where password is encrypted. If you use this parameter, don’t use dbm.
grpfile
(optional)Specifies the NCSA-style httpd group file to be used. Each line of a group file consists of group:user1 user2...userN, where each user is separated by spaces.
Example
A UNIX example:
AuthTrans fn=proxy-auth auth-type=basic
dbm=/usr/ns-home/proxy-EXAMPLE/userdb/rsA Windows NT example:
AuthTrans fn=proxy-auth auth-type=basic
userfile=\netscape\server\proxy-EXAMPLE\.htpasswd
grpfile=\netscape\server\proxy-EXAMPLE\.grpfile
It is possible to have authentication be performed by a user-provided function by passing the user-fn parameter to the proxy-auth function.
Syntax
AuthTrans fn=proxy-auth auth-type=basic
user-fn=your function
userdb=full path nameParameters
The following table describes parameter values for the user provided proxy-auth function.
Table 5-32 user provide proxy-auth parameter values
Value
Description
user-fn
Specifies the name of the user-provided function that will be used to perform authentication in place of the built-in authentication. If authentication succeeds, the function should return REQ-PROCEED and if authentication fails, it should return REQ-NOACTION.
userdb
Specifies the full path and base filename of the user database in the server’s native format. The native format is a system DBM file, which is a hashed file format allowing instantaneous access to billions of users.
set-variable
Applicable in all stage directives.
The set-variable function enables you to change server settings based upon conditional information in a request. It can also be used to manipulate variables in parameter blocks with the following commands:
Syntax
stage fn="set-variable" [{insert|set|remove}-pblock="name=value" ...]
[name="value" ...]Parameters
The following table describes parameter values for the set-variable function.
Table 5-33 set-variable parameter values
Value
Description
pblock
One of the following Session/Request parameter block names:
- client: Contains the IP address of the client machine and the DNS name of the remote machine. For more information, see the description of the Session->client function in the “Data Structure Reference” chapter of the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
- vars: Contains the server's working variables, which includes anything not specifically found in the reqpb, headers, or srvhdrs pblocks. The contents of this pblock differ, depending upon the specific request and the type of SAF.
- reqpb: Contains elements of the HTTP request, which includes the HTTP method (GET, POST, and so on), the URI, the protocol (generally HTTP/1.0), and the query string. This pblock doesn’t usually change during the request-response process.
headers: Contains all the request headers (such as User-Agent, If-Modified-Since, and so on) received from the client in the HTTP request. This pblock doesn’t usually change during the request-response process.- srvhdrs: Contains the response headers (such as Server, Date, Content-type, Content-length, and so on) that are to be sent to the client in the HTTP response.
Note: For more information about parameter blocks, see the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
name
The variable to set.
value
The string assigned to the variable specified by name.
Variables
The following table lists variables supported by the set-variable SAF.
Table 5-34 Supported Variables
Parameter
Description
abort
A value of true indicates the result code should be set to REQ_ABORTED. Setting the result code to REQ_ABORTED will abort the current request and send an error to the browser.
error
Sets the error code to be returned in the event of an aborted browser request.
escape
A boolean value signifying whether a URL should be escaped using util_uri_escape. For information about util_uri_escape, see the “NSAPI Function Reference” chapter of the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
find-pathinfo-forward
Path information after the file name in a URI. See find-pathinfo.
http-downgrade
HTTP version number (for example, 1.0).
http-upgrade
HTTP version number (for example, 1.0).
keep-alive
A boolean value that establishes whether a keep-alive request from a browser will be honored.
name
Specifies an additional named object in the obj.conf file whose directives will be applied to this request. See also assign-name.
noaction
A value of true indicates the result code should be set to REQ_NOACTION. For AuthTrans, NameTrans, Service, and Error stage SAFs, setting the result code to REQ_NOACTION indicates that subsequent SAFs in that stage should be allowed to execute.
nostat
Causes the server not to perform the stat() function for a URL when possible. See also assign-name.
senthdrs
A boolean value that indicates whether HTTP response headers have been sent to the client.
ssl-unclean-shutdown
A boolean value that can be used to alter the way SSL3 connections are closed. As this violates the SSL3 RFCs, you should only use this with great caution if you know that you are experiencing problems with SSL3 shutdowns.
stop
A value of true indicates the result code should be set to REQ_PROCEED. For AuthTrans, NameTrans, Service, and Error stage SAFs, setting the result code to REQ_PROCEED indicates that no further SAFs in that stage should be allowed to execute.
url
Redirect requests to a specified URL.
Examples
- To deny HTTP keep-alive requests for a specific server class (while still honoring keep-alive requests for the other classes), add this AuthTrans directive to the obj.conf for the server class, and set the variable keep-alive to disabled:
AuthTrans fn="set-variable" keep-alive="disabled"
To cause that same server class to use HTTP/1.0 while the rest of the server classes use HTTP/1.1, the AuthTrans directive would be:
AuthTrans fn="set-variable" keep-alive="disabled" http-downgrade="true"
- To insert an HTTP header into each response, add a NameTrans directive to obj.conf, using the insert-pblock command and specifying srvhdrs as your Session/Request parameter block.
For example, to insert the HTTP header P3P, you would add the following line to each request:
NameTrans fn="set-variable" insert-srvhdrs="P3P"
- To terminate processing a request based upon certain URIs, use a <Client> tag to specify the URIs and an AuthTrans directive that sets the variable abort to true when there is a match. Your <Client> tag would be comparable to the following:
<Client uri="*(system32|root.exe)*">
AuthTrans fn="set-variable" abort="true"
</Client>See Also
NameTransNameTrans stands for Name Translation. NameTrans directives translate virtual URLs to physical directories on your server. For example, the URL
http://www.test.com/some/file.html
NameTrans directives should appear in the default object. If there is more than one NameTrans directive in an object, the server executes each one in order until one succeeds.
The following NameTrans-class functions are described in detail in this section:
- assign-name tells the server to process directives in a named object.
- document-root translates a URL into a file system path by replacing the http://server-name/ part of the requested resource with the document root directory.
- home-page translates a request for the server’s root home page (/) to a specific file.
- map looks for a certain URL prefix in the URL that the client is requesting.
- match-browser matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- ntrans-j2ee determines whether a request maps to a Java™ technology-based web application context. This is applicable only to the Administration Server.
- pac-map maps proxy-relative URLs to local files that are delivered to clients who request configuration.
- pat-map maps proxy-relative URLs to local files that are delivered to proxies that request configuration.
- pfx2dir translates any URL beginning with a given prefix to a file system directory and optionally enables directives in an additional named object.
- redirect redirects the client to a different URL.
- reverse-map rewrites HTTP response headers when the proxy server is functioning as a reverse proxy.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
- strip-params removes embedded semicolon-delimited parameters from the path.
- unix-home translates a URL to a specified directory within a user’s home directory.
assign-name
Applicable in NameTrans-class directives.
The assign-name function specifies the name of an object in obj.conf that matches the current request. The server then processes the directives in the named object in preference to the ones in the default object.
For example, consider the following directive in the default object:
NameTrans fn=assign-name name=personnel from=/personnel
Let’s suppose the server receives a request for http://server-name/personnel. After processing this NameTrans directive, the server looks for an object named personnel in obj.conf, and continues by processing the directives in the personnel object.
The assign-name function always returns REQ_NOACTION.
Parameters
The following table describes parameters for the assign-name function.
Table 5-35 assign-name parameters
Parameter
Description
from
Wildcard pattern that specifies the path to be affected.
name
Specifies an additional named object in obj.conf whose directives will be applied to this request.
find-pathinfo-forward
(Optional) Makes the server look for the PATHINFO forward in the path right after the ntrans-base instead of backward from the end of path as the server function assign-name does by default.
The value you assign to this parameter is ignored. If you do not wish to use this parameter, leave it out.
The find-pathinfo-forward parameter is ignored if the ntrans-base parameter is not set in rq->vars. By default, ntrans-base is set.
This feature can improve performance for certain URLs by reducing the number of stats performed.
nostat
(Optional) Prevents the server from performing a stat on a specified URL whenever possible.
The effect of nostat="virtual-path" in the NameTrans function assign-name is that the server assumes that a stat on the specified virtual-path will fail. Therefore, use nostat only when the path of the virtual-path does not exist on the system, for example, for NSAPI plugin URLs, to improve performance by avoiding unnecessary stats on those URLs.
When the default PathCheck server functions are used, the server does not stat for the paths /ntrans-base/virtual-path and /ntrans-base/virtual-path/* if ntrans-base is set (the default condition); it does not stat for the URLs /virtual-path and /virtual-path/* if ntrans-base is not set.
(Optional) Common to all obj.conf functions.
Example
# This NameTrans directive is in the default object.
NameTrans fn=assign-name name=personnel from=/a/b/c/pers
...
<Object name=personnel>
...additional directives..
</Object>NameTrans fn="assign-name" from="/perf" find-pathinfo-forward="" name="perf"
NameTrans fn="assign-name" from="/nsfc" nostat="/nsfc" name="nsfc"
document-root
Applicable in NameTrans-class directives.
The document-root function specifies the root document directory for the server. If the physical path has not been set by a previous NameTrans function, the http://server-name/ part of the path is replaced by the physical path name for the document root.
When the server receives a request for http://server-name/somepath/somefile, the document-root function replaces http://server-name/ with the value of its root parameter. For example, if the document root directory is /usr/sun/server1/docs, then when the server receives a request for http://server-name/a/b/file.html, the document-root function translates the path name for the requested resource to /usr/sun/server1/docs/a/b/file.html.
This function always returns REQ_PROCEED. NameTrans directives listed after this will never be called, so be sure that the directive that invokes document-root is the last NameTrans directive.
There can be only one root document directory. To specify additional document directories, use the pfx2dir function to set up additional path name translations.
Parameters
The following table describes parameters for the document-root function.
Table 5-36 document-root parameters
Parameter
Description
root
File system path to the server’s root document directory.
(Optional) Common to all obj.conf functions.
Examples
See Also
home-page
Applicable in NameTrans-class directives.
The home-page function specifies the home page for your server. Whenever a client requests the server’s home page (/), they’ll get the document specified.
Parameters
The following table describes parameters for the home-page function.
Table 5-37 home-page parameters
Parameter
Description
path
Path and name of the home page file. If path starts with a slash (/), it is assumed to be a full path to a file.
This function sets the server’s path variable and returns REQ_PROCEED. If path is a relative path, it is appended to the URI and the function returns REQ_NOACTION continuing on to the other NameTrans directives.
(Optional) Common to all obj.conf functions.
Examples
NameTrans fn="home-page" path="/path/to/file.html"
NameTrans fn="home-page" path="/path/to/$id/file.html"
map
Applicable in NameTrans-class directives.
The map function looks for a certain URL prefix in the URL that the client is requesting. If map finds the prefix, it replaces the prefix with the mirror site prefix. When you specify the URL, don’t use trailing slashes—they cause “Not Found” errors.
Syntax
NameTrans fn=map
from="source site prefix"
to="destination site prefix"
name="named object"Parameters
The following table describes parameters for the map function.
Table 5-38 map parameters
Parameter
Description
from
The prefix to be mapped to the mirror site.
to
The mirror site prefix.
name
(optional) gives a named object from which to derive the configuration for this mirror site.
rewrite-host
(optional) indicates whether the Host HTTP request header is rewritten to match the host specified by the to parameter. In a reverse proxy configuration where the proxy server and origin server service the same set of virtual servers, you may wish to specify rewrite-host="false". The default is "true", meaning that the Host HTTP request header is rewritten.
Example
# Map site http://home.netscape.com/ to mirror site http://mirror.com
NameTrans fn=map from="http://home.netscape.com"
to="http://mirror.com"
match-browser
See match-browser.
ntrans-j2ee
This is applicable only to the Administration Server.
Applicable in NameTrans-class directives.
The ntrans-j2ee function determines whether a request maps to a Java web application context.
Parameters
The following table describes parameters for the ntrans-j2ee function.
Table 5-39 ntrans-j2ee parameters
Parameter
Description
name
Named object in obj.conf whose directives are applied to requests made to Java web applications.
(Optional) Common to all obj.conf functions.
Example
See Also
pac-map
Applicable in NameTrans-class directives.
The pac-map function maps proxy-relative URLs to local files that are delivered to clients who request configuration.
Syntax
NameTrans fn=pac-map
from=URL
to=prefix
name=named objectParameters
The following table describes parameters for the pac-map function.
Table 5-40 pac-map parameters
Parameter
Description
from
The proxy URL to be mapped.
to
The local file to be mapped to.
name
(optional) gives a named object (template) from which to derive configuration.
Example
NameTrans fn=pac-map
from=http://proxy.mysite.com/pac
to=<Install_Root><Instance_Directory>pac/proxy.pac
name=file
pat-map
Applicable in NameTrans-class directives.
The pat-map function maps proxy-relative URLs to local files that are delivered to proxies who request configuration.
Syntax
NameTrans fn=pat-map
from=URL
to=prefix
name=named objectParameters
The following table describes parameters for the pat-map function.
Table 5-41 pat-map parameters
Parameter
Description
from
The proxy URL to be mapped.
to
The local file to be mapped to.
name
(optional) gives a named object (template) from which to derive configuration.
Example
NameTrans fn=pat-map
from=http://proxy.mysite.com/pac
to=<Install_Root><Instance_Directory>pac/proxy.pac
name=file
pfx2dir
Applicable in NameTrans-class directives.
The pfx2dir function replaces a directory prefix in the requested URL with a real directory name. It also optionally allows you to specify the name of an object that matches the current request. (See the discussion of assign-name for details of using named objects.)
Parameters
The following table describes parameters for the pfx2dir function.
Table 5-42 pfx2dir parameters
Parameter
Description
from
URI prefix to convert. It should not have a trailing slash (/).
dir
Local file system directory path that the prefix is converted to. It should not have a trailing slash (/).
name
(Optional) Specifies an additional named object in obj.conf whose directives will be applied to this request.
find-pathinfo-forward
(Optional) Makes the server look for the PATHINFO forward in the path right after the ntrans-base instead of backward from the end of path as the server function find-pathinfo does by default.
The value you assign to this parameter is ignored. If you do not wish to use this parameter, leave it out.
The find-pathinfo-forward parameter is ignored if the ntrans-base parameter is not set in rq->vars when the server function find-pathinfo is called. By default, ntrans-base is set.
This feature can improve performance for certain URLs by reducing the number of stats performed in the server function find-pathinfo.
On Windows, this feature can also be used to prevent the PATHINFO from the server URL normalization process (changing '\' to '/') when the PathCheck server function find-pathinfo is used. Some double-byte characters have hexadecimal values that may be parsed as URL separator characters such as \ or ~. Using the find-pathinfo-forward parameter can sometimes prevent incorrect parsing of URLs containing double-byte characters.
(Optional) Common to all obj.conf functions.
Examples
In the first example, the URL http://server-name/cgi-bin/resource (such as http://x.y.z/cgi-bin/test.cgi) is translated to the physical path name /httpd/cgi-local/resource (such as /httpd/cgi-local/test.cgi), and the server also starts processing the directives in the object named cgi.
In the second example, the URL http://server-name/icons/resource (such as http://x.y.z/icons/happy/smiley.gif) is translated to the physical path name /users/nikki/images/resource (such as /users/nikki/images/smiley.gif).
The third example shows the use of the find-pathinfo-forward parameter. The URL http://server-name/cgi-bin/resource is translated to the physical path name /export/home/cgi-bin/resource.
NameTrans fn="pfx2dir" find-pathinfo-forward="" from="/cgi-bin" dir="/export/home/cgi-bin" name="cgi"
redirect
Applicable in NameTrans-class directives.
The redirect function lets you change URLs and send the updated URL to the client. When a client accesses your server with an old path, the server treats the request as a request for the new URL.
Parameters
The following table describes parameters for the redirect function.
Table 5-43 redirect parameters
Parameter
Description
from
Specifies the prefix of the requested URI to match.
url
(Maybe optional) Specifies a complete URL to return to the client. If you use this parameter, don’t use url-prefix (and vice versa).
url-prefix
(Maybe optional) The new URL prefix to return to the client. The from prefix is simply replaced by this URL prefix. If you use this parameter, don’t use url (and vice versa).
escape
(Optional) Flag that tells the server to util_uri_escape the URL before sending it. It should be yes or no. The default is yes.
For more information about util_uri_escape, see the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
(Optional) Common to all obj.conf functions.
Examples
In the first example, any request for http://server-name/whatever is translated to a request for http://tmpserver/whatever.
In the second example, any request for http://server-name/toopopular/whatever is translated to a request for http://bigger/better/stronger/morepopular/whatever.
reverse-map
Applicable in NameTrans-class directives.
The reverse-map function is used to rewrite HTTP response headers when the proxy server is functioning as a reverse proxy. reverse-map looks for the URL prefix specified by the from parameter in certain response headers. If the from prefix matches the beginning of the response header value, reverse-map replaces the matching portion with the to prefix.
Parameters
The following table describes parameters for the reverse-map function.
Table 5-44 reverse-map parameters
Parameter
Description
from
URL prefix to be rewritten.
to
URL prefix that will be substituted in place of the from prefix.
rewrite-location
(Optional) Boolean that indicates whether the Location HTTP response header should be rewritten. The default is "true", meaning the Location header is rewritten.
rewrite-content-location
(Optional) Boolean that indicates whether the Content-location HTTP response header should be rewritten. The default is "true", meaning the Content-location header is rewritten.
rewrite-headername
(Optional) Boolean that indicates whether the headername HTTP response header should be rewritten, where headername is a user-defined header name. With the exception of the Location and Content-location headers, the default is "false", meaning the headername header is not rewritten.
set-variable
See set-variable.
strip-params
Applicable in NameTrans-class directives.
The strip-params function removes embedded semicolon-delimited parameters from the path. For example, a URI of /dir1;param1/dir2 would become a path of /dir1/dir2. When used, the strip-params function should be the first NameTrans directive listed.
Parameters
The following table describes parameters for the strip-params function.
Table 5-45 strip-params parameters
Parameter
Description
(Optional) Common to all obj.conf functions.
Example
NameTrans fn=strip-params
unix-home
Applicable in NameTrans-class directives.
UNIX Only. The unix-home function translates user names (typically of the form ~username) into the user’s home directory on the server’s UNIX machine. You specify a URL prefix that signals user directories. Any request that begins with the prefix is translated to the user’s home directory.
You specify the list of users with either the /etc/passwd file or a file with a similar structure. Each line in the file should have this structure (elements in the passwd file that are not needed are indicated with *):
username:*:*:groupid:*:homedir:*
If you want the server to scan the password file only once at startup, use the Init-class function init-uhome in magnus.conf.
Parameters
The following table describes parameters for the unix-home function.
Table 5-46 unix-home parameters
Parameter
Description
subdir
Subdirectory within the user’s home directory that contains their web documents.
pwfile
(Optional) Full path and file name of the password file if it is different from /etc/passwd.
name
(Optional) Specifies an additional named object whose directives will be applied to this request.
(Optional) Common to all obj.conf functions.
Examples
NameTrans fn=unix-home from=/~ subdir=public_html
NameTrans fn=unix-home from /~ pwfile=/mydir/passwd subdir=public_html
See Also
PathCheckPathCheck directives check the local file system path that is returned after the NameTrans step. The path is checked for things such as CGI path information and for dangerous elements such as /./and /../ and //, and then any access restriction is applied.
If there is more than one PathCheck directive, each of the functions is executed in order.
The following PathCheck-class functions are described in detail in this section:
- block-multipart-posts blocks all multipart form file uploads when configured without any parameters.
- check-acl checks an access control list for authorization.
- deny-existence indicates that a resource was not found.
- deny-service sends a “Proxy Denies Access” error when a client tries to access a specific path.
- find-index locates a default file when a directory is requested.
- find-links denies access to directories with certain file system links.
- find-pathinfo locates extra path info beyond the file name for the PATH_INFO CGI environment variable.
- get-client-cert gets the authenticated client certificate from the SSL3 session.
- load-config finds and loads extra configuration information from a file in the requested path.
- match-browser matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- nt-uri-clean denies access to requests with unsafe path names by indicating not found.
- ntcgicheck looks for a CGI file with a specified extension.
- require-auth denies access to unauthorized users or groups.
- require-proxy-auth makes sure that users are authenticated and triggers a password pop-up window.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
- set-virtual-index specifies a virtual index for a directory.
- ssl-check checks the secret keysize.
- ssl-logout invalidates the current SSL session in the server's SSL session cache.
- unix-uri-clean denies access to requests with unsafe path names by indicating not found.
- url-check checks the validity of URL syntax.
- url-filter allows or denies URL patterns.
- user-agent-check restricts access to the proxy server based on the type and version of the client’s web browser.
block-multipart-posts
Applicable in PathCheck-class directives.
The block-multipart-posts function blocks all multipart form file uploads when configured without any parameters. This can also be used to block requests based on specific content type, user-agent or HTTP method using content-type, user-agent and method parameters.
Parameters
The following table describes parameters for the block-multipart-posts function.
Table 5-47 block-multipart-posts parameters
Parameter
Description
content-type
(Optional) Regular expression of the content type to be blocked.
user-agent
(Optional) Regular expression of the user agent to be blocked.
method
(Optional) Regular expression matching the HTTP request method to be blocked.
Example
check-acl
Applicable in PathCheck-class directives.
The check-acl function specifies an access control list (ACL) to use to check whether the client is allowed to access the requested resource. An access control list contains information about who is or is not allowed to access a resource, and under what conditions access is allowed.
Regardless of the order of PathCheck directives in the object, check-acl functions are executed first. They cause user authentication to be performed, if required by the specified ACL, and will also update the access control state.
Parameters
The following table describes parameters for the check-acl function.
Table 5-48 check-acl parameters
Parameter
Description
acl
Name of an access control list.
path
(Optional) Wildcard pattern that specifies the path for which to apply the ACL.
(Optional) Common to all obj.conf functions.
Example
deny-existence
Applicable in PathCheck-class directives.
The deny-existence function sends a “not found” message when a client tries to access a specified path. The server sends “not found” instead of “forbidden,” so the user cannot tell if the path exists.
Parameters
The following table describes parameters for the deny-existence function.
Table 5-49 deny-existence parameters
Parameter
Description
path
(Optional) Wildcard pattern of the file system path to hide. If the path does not match, the function does nothing and returns REQ_NOACTION. If the path is not provided, it is assumed to match.
bong-file
(Optional) Specifies a file to send rather than responding with the “not found” message. It is a full file system path.
(Optional) Common to all obj.conf functions.
Examples
PathCheck fn=deny-existence path=/usr/sun/server61/docs/private
PathCheck fn=deny-existence bong-file=/svr/msg/go-away.html
deny-service
Applicable in PathCheck-class directives and Service-class directives.
The deny-service function sends a “Proxy Denies Access” error when a client tries to access a specific path. If this directive appears in a client region, it performs access control on the specified clients.
The proxy specifically denies clients instead of specifically allowing them access to documents (for example, you don’t configure the proxy to allow a list of clients). The “default” object is used when a client doesn’t match any client region in objects, and because the “default” object uses the deny-service function, no one is allowed access by default.
Syntax
PathCheck fn=deny-service path=.*someexpression.*
Parameters
The following table describes the parameter for the deny-service function.
Table 5-50 deny-service parameters
Parameter
Description
path
A regular expression representing the path to check. Not specifying this parameter is equivalent to specifying *. URLs matching the expression are denied access to the proxy server.
Example
<Object ppath="http://sun/.*">
# Deny servicing proxy requests for fun GIFs
PathCheck fn=deny-service path=.*fun.*.gif
# Make sure nobody except Sun employees can use the object
# inside which this is placed.
<Client dns=*~.*.sun.com>
PathCheck fn=deny-service
</Client>
</Object>
find-compressed
Applicable in PathCheck-class directives.
The find-compressed function checks if a compressed version of the requested file is available. If the following conditions are met, find-compressed changes the path to point to the compressed file:
Not all clients support compression. The find-compressed function allows you to use a single URL for both the compressed and noncompressed versions of a file. The version of the file that is selected is based on the individual clients' capabilities.
A compressed version of a file must have the same file name as the noncompressed version but with a .gz suffix. For example, the compressed version of a file named /httpd/docs/index.html would be named /httpd/docs/index.html.gz. To compress files, you can use the freely available gzip program.
Because compressed files are sent as is to the client, you should not compress files such as SHTML pages, CGI programs, or pages created with JavaServer Pages™ (JSP™) technology that need to be interpreted by the server. To compress the dynamic content generated by these types of files, use the http-compression filter.
The find-compressed function does nothing if the HTTP method is not GET or HEAD.
Parameters
The following table describes parameters for the find-compressed function.
Table 5-51 find-compressed parameters
Parameter
Description
check-age
Specifies whether to check if the compressed version is older than the noncompressed version. Possible values are yes and no.
By default, the value is set to yes.
vary
Specifies whether to insert a Vary: Accept-Encoding header. Possible values are yes or no.
By default, the value is set to yes.
(Optional) Common to all obj.conf functions.
Example
<Object name="default">
NameTrans fn="assign-name" from="*.html" name="find-compressed"
...
</Object>
<Object name="find-compressed">
PathCheck fn="find-compressed"
</Object>
See Also
http-compression
find-index
Applicable in PathCheck-class directives.
The find-index function investigates whether the requested path is a directory. If it is, the function searches for an index file in the directory, and then changes the path to point to the index file. If no index file is found, the server generates a directory listing.
Note that if the file obj.conf has a NameTrans directive that calls home-page, and the requested directory is the root directory, then the home page rather than the index page is returned to the client.
The find-index function does nothing if there is a query string, if the HTTP method is not GET, or if the path is that of a valid file.
Parameters
The following table describes parameters for the find-index function.
Table 5-52 find-index parameters
Parameter
Description
index-names
Comma-separated list of index file names to look for. Use spaces only if they are part of a file name. Do not include spaces before or after the commas. This list is case-sensitive if the file system is case-sensitive.
(Optional) Common to all obj.conf functions.
Example
find-links
Applicable in PathCheck-class directives.
UNIX Only. The find-links function searches the current path for symbolic or hard links to other directories or file systems. If any are found, an error is returned. This function is normally used for directories that are not trusted (such as user home directories). It prevents someone from pointing to information that should not be made public.
Parameters
The following table describes parameters for the find-links function.
Table 5-53 find-links parameters
Parameter
Description
disable
Character string of links to disable:
dir
Directory to begin checking. If you specify an absolute path, any request to that path and its subdirectories is checked for symbolic links. If you specify a partial path, any request containing that partial path is checked for symbolic links. For example, if you use /user/ and a request comes in for some/user/directory, then that directory is checked for symbolic links.
checkFileExistence
Checks linked file for existence and aborts request with 403 (forbidden) if this check fails.
(Optional) Common to all obj.conf functions.
Examples
PathCheck fn=find-links disable=sh dir=/foreign-dir
PathCheck fn=find-links disable=so dir=public_html
See Also
find-pathinfo
Applicable in PathCheck-class directives.
The find-pathinfo function finds any extra path information after the file name in the URL and stores it for use in the CGI environment variable PATH_INFO.
Parameters
The following table describes parameters for the find-pathinfo function.
Table 5-54 find-pathinfo parameters
Parameter
Description
(Optional) Common to all obj.conf functions.
Examples
get-client-cert
Applicable in PathCheck-class directives.
The get-client-cert function gets the authenticated client certificate from the SSL3 session. It can apply to all HTTP methods, or only to those that match a specified pattern. It only works when SSL is enabled on the server.
If the certificate is present or obtained from the SSL3 session, the function returns REQ_NOACTION, allowing the request to proceed; otherwise, it returns REQ_ABORTED and sets the protocol status to 403 FORBIDDEN, causing the request to fail and the client to be given the FORBIDDEN status.
Parameters
The following table describes parameters for the get-client-cert function.
Table 5-55 get-client-cert parameters
Parameter
Description
dorequest
Controls whether to actually try to get the certificate, or just test for its presence. If dorequest is absent, the default value is 0.
- 1 tells the function to redo the SSL3 handshake to get a client certificate, if the server does not already have the client certificate. This typically causes the client to present a dialog box to the user to select a client certificate. The server may already have the client certificate if it was requested on the initial handshake, or if a cached SSL session has been resumed.
- 0 tells the function not to redo the SSL3 handshake if the server does not already have the client certificate.
If a certificate is obtained from the client and verified successfully by the server, the ASCII base64 encoding of the DER-encoded X.509 certificate is placed in the parameter auth-cert in the Request->vars pblock, and the function returns REQ_PROCEED, allowing the request to proceed.
require
Controls whether failure to get a client certificate will abort the HTTP request. If require is absent, the default value is 1.
- 1 tells the function to abort the HTTP request if the client certificate is not present after dorequest is handled. In this case, the HTTP status is set to PROTOCOL_FORBIDDEN, and the function returns REQ_ABORTED.
- 0 tells the function to return REQ_NOACTION if the client certificate is not present after dorequest is handled.
method
(Optional) Specifies a wildcard pattern for the HTTP methods for which the function will be applied. If method is absent, the function is applied to all requests.
(Optional) Common to all obj.conf functions.
Example
# Get the client certificate from the session.
# If a certificate is not already associated with the
# session, request one.
# The request fails if the client does not present a
# valid certificate.
PathCheck fn="get-client-cert" dorequest="1"
load-config
Applicable in PathCheck-class directives.
The load-config function searches for configuration files in document directories and adds the file’s contents to the server’s existing configuration. These configuration files (also known as dynamic configuration files) specify additional access control information for the requested resource. Depending on the rules in the dynamic configuration files, the server may or may not allow the client to access the requested resource.
Each directive that invokes load-config is associated with a base directory, which is either stated explicitly through the basedir parameter or derived from the root directory for the requested resource. The base directory determines two things:
For example, if the base directory is D:/sun/server1/docs/nikki/, then only requests for resources in this directory or its subdirectories (and their subdirectories) trigger the search for dynamic configuration files. A request for the resource D:/sun/server1/docs/somefile.html does not trigger the search in this case, since the requested resource is in a parent directory of the base directory.
When you enable dynamic configuration files through the Server Manager interface, the system writes additional objects with ppath parameters into the obj.conf file. If you manually add directives that invoke load-config to the default object (rather than putting them in separate objects), the Server Manager interface might not reflect your changes.
If you manually add PathCheck directives that invoke load-config to the file obj.conf, put them in additional objects (created with the <OBJECT> tag) rather than putting them in the default object. Use the ppath attribute of the OBJECT tag to specify the partial path name for the resources to be affected by the access rules in the dynamic configuration file. The partial path name can be any path name that matches a pattern, which can include wildcard characters.
For example, the following <OBJECT> tag specifies that requests for resources in the directory D:/sun/proxy4/docs are subject to the access rules in the file my.nsconfig.
<Object ppath="D:/sun/server1/docs/*">
PathCheck fn="load-config" file="my.nsconfig" descend=1 basedir="D:/sun/server1/docs"
</Object>
Note
If the ppath resolves to a resource or directory that is higher in the directory tree (or is in a different branch of the tree) than the base directory, the load-config function is not invoked. This is because the base directory specifies the highest-level directory for which requests will invoke the load-config function.
The load-config function returns REQ_PROCEED if configuration files were loaded, REQ_ABORTED on error, or REQ_NOACTION when no files are loaded.
Parameters
The following table describes parameters for the load-config function.
Table 5-56 load-config parameters
Parameter
Description
file
(Optional) Name of the dynamic configuration file containing the access rules to be applied to the requested resource. If not provided, the file name is assumed to be .nsconfig.
disable-types
(Optional) Specifies a wildcard pattern of types to disable for the base directory, such as magnus-internal/cgi. Requests for resources matching these types are aborted.
descend
(Optional) If present, specifies that the server should search in subdirectories of this directory for dynamic configuration files. For example, descend=1 specifies that the server should search subdirectories. No descend parameter specifies that the function should search only the base directory.
basedir
(Optional) Specifies base directory. This is the highest-level directory for which requests will invoke the load-config function, and is also the directory where the server starts searching for configuration files.
If basedir is not specified, the base directory is assumed to be the root directory that results from translating the requested resource’s URL to a physical path name. For example, if the request is for http://server-name/a/b/file.html, the physical file name would be
/document-root/a/b/file.html.(Optional) Common to all obj.conf functions.
Examples
In this example, whenever the server receives a request for any resource containing the substring secret that resides in D:/Sun/WebServer61/server1/docs/nikki/ or a subdirectory thereof, it searches for a configuration file called checkaccess.nsconfig.
The server starts the search in the directory D:/Sun/WebServer61/server1/docs/nikki, and searches subdirectories too. It loads each instance of checkaccess.nsconfig that it finds, applying the access control rules contained therein to determine whether the client is allowed to access the requested resource.
<Object ppath="*secret*">
PathCheck fn="load-config" file="checkaccess.nsconfig" basedir="D:/Sun/WebServer61/server1/docs/nikki" descend="1"
</Object>
match-browser
See match-browser.
nt-uri-clean
Applicable in PathCheck-class directives.
Windows Only. The nt-uri-clean function denies access to any resource whose physical path contains \.\, \..\ or \\ (these are potential security problems).
Parameters
The following table describes parameters for the nt-uri-clean function.
Table 5-57 nt-uri-clean parameters
Parameter
Description
tildeok
If present, allows tilde (~) characters in URIs. This is a potential security risk on the Windows platform, where longfi~1.htm might reference longfilename.htm but does not go through the proper ACL checking. If present, “//” sequences are allowed.
dotdirok
If present, “//” sequences are allowed.
(Optional) Common to all obj.conf functions.
Example
See Also
ntcgicheck
Applicable in PathCheck-class directives.
Windows Only. The ntcgicheck function specifies the file name extension to be added to any file name that does not have an extension, or to be substituted for any file name that has the extension .cgi.
Parameters
The following table describes parameters for the ntcgicheck function.
Table 5-58 ntcgicheck parameters
Parameter
Description
extension
The replacement file extension.
(Optional) Common to all obj.conf functions.
Example
See Also
require-auth
Applicable in PathCheck-class directives.
The require-auth function allows access to resources only if the user or group is authorized. Before this function is called, an authorization function (such as basic-auth) must be called in an AuthTrans directive.
If a user was authorized in an AuthTrans directive, and the auth-user parameter is provided, then the user’s name must match the auth-user wildcard value. Also, if the auth-group parameter is provided, the authorized user must belong to an authorized group, which must match the auth-user wildcard value.
Parameters
The following table describes parameters for the require-auth function.
Table 5-59 require-auth parameters
Parameter
Description
path
(Optional) Wildcard local file system path on which this function should operate. If no path is provided, the function applies to all paths.
auth-type
Type of HTTP authorization used, and must match the auth-type from the previous authorization function in AuthTrans. Currently, basic is the only authorization type defined.
realm
String sent to the browser indicating the secure area (or realm) for which a user name and password are requested.
auth-user
(Optional) Specifies a wildcard list of users who are allowed access. If this parameter is not provided, any user authorized by the authorization function is allowed access.
auth-group
(Optional) Specifies a wildcard list of groups that are allowed access.
(Optional) Common to all obj.conf functions.
Example
PathCheck fn=require-auth auth-type=basic realm="Marketing Plans" auth-group=mktg auth-user=(jdoe|johnd|janed)
See Also
require-proxy-auth
Applicable in PathCheck-class directives.
The require-proxy-auth function is a PathCheck function that makes sure that users are authenticated and triggers a password pop-up window.
Syntax
PathCheck fn=require-proxy-auth
auth-type=basic
realm=name
auth-group=group
auth-users=nameParameters
The following table describes parameters for the require-proxy-auth function.
Table 5-60 require-proxy-auth parameters
Parameter
Description
auth-type
Specifies the type of authorization to be used. The type should be “basic” unless you are running a UNIX proxy and are going to use your own function to perform authentication.
realm
A string (enclosed in double-quotation marks) sent to the client application so users can see what object they need authorization for.
auth-user
(optional) specifies a list of users who get access. The list should be enclosed in parentheses with each user name separated by the pipe | symbol.
auth-group
(optional) specifies a list of groups that get access. Groups are listed in the password-type file.
Example
PathCheck fn=require-auth
auth-type=basic
realm="Marketing Plans"
auth-group=mktg
auth-users=(jdoe|johnd|janed)
set-variable
See set-variable.
set-virtual-index
Applicable in PathCheck-class directives.
The set-virtual-index function specifies a virtual index for a directory, which determines the URL forwarding. The index can refer to a LiveWire application, a servlet in its own namespace, a Sun™ ONE Application Server applogic, and so on.
REQ_NOACTION is returned if none of the URIs listed in the from parameter match the current URI. REQ_ABORTED is returned if the file specified by the virtual-index parameter is missing, or if the current URI cannot be found. REQ_RESTART is returned if the current URI matches any one of the URIs mentioned in the from parameter, or if there is no from parameter.
Parameters
The following table describes parameters for the set-virtual-index function.
Table 5-61 set-virtual-index parameters
Parameter
Description
virtual-index
URI of the content generator that acts as an index for the URI the user enters.
from
(Optional) Comma-separated list of URIs for which this virtual-index is applicable. If from is not specified, the virtual-index always applies.
(Optional) Common to all obj.conf functions.
Example
ssl-check
Applicable in PathCheck-class directives.
If a restriction is selected that is not consistent with the current cipher settings under Security Preferences, this function opens a popup dialog warning that ciphers with larger secret keysizes need to be enabled. This function is designed to be used together with a Client tag to limit access of certain directories to nonexportable browsers.
The function returns REQ_NOACTION if SSL is not enabled, or if the secret-keysize parameter is not specified. If the secret keysize for the current session is less than the specified secret-keysize and the bong-file parameter is not specified, the function returns REQ_ABORTED with a status of PROTOCOL_FORBIDDEN. If the bong file is specified, the function returns REQ_PROCEED, and the path variable is set to the bong file name. Also, when a keysize restriction is not met, the SSL session cache entry for the current session is invalidated, so that a full SSL handshake will occur the next time the same client connects to the server.
Requests that use ssl-check are not cacheable in the accelerator file cache if ssl-check returns something other than REQ_NOACTION.
Parameters
The following table describes parameters for the ssl-check function.
Table 5-62 ssl-check parameters
Parameter
Description
secret-keysize
(Optional) Minimum number of bits required in the secret key.
bong-file
(Optional) Name of a file (not a URI) to be served if the restriction is not met.
(Optional) Common to all obj.conf functions.
ssl-logout
Applicable in PathCheck-class directives.
The ssl-logout function invalidates the current SSL session in the server's SSL session cache. This does not affect the current request, but the next time the client connects, a new SSL session will be created. If SSL is enabled, this function returns REQ_PROCEED after invalidating the session cache entry. If SSL is not enabled, it returns REQ_NOACTION.
Parameters
The following table describes parameters for the ssl-logout function.
unix-uri-clean
Applicable in PathCheck-class directives.
UNIX Only. The unix-uri-clean function denies access to any resource whose physical path contains /./, /../ or // (these are potential security problems).
Parameters
The following table describes parameters for the unix-uri-clean function.
Table 5-64 unix-uri-clean parameters
Parameter
Description
dotdirok
If present, “//” sequences are allowed.
(Optional) Common to all obj.conf functions.
Example
See Also
url-check
Applicable in PathCheck-class directives.
The url-check function checks the validity of URL syntax.
url-filter
Applicable in PathCheck-class directives.
The url-filter can be used to allow or deny URL patterns. You can use either regular expressions of URL patterns or names of filter files of URLs ("names" here refer to parameter names which were associated with filter files of URLs through init-url-filter SAF) as values for allow and deny parameters.
Parameters
The following table describes parameters for the url-filter function.
Table 5-65 url-filter parameters
Parameter
Description
allow
Regular expression matching a URL pattern or name of a filter of URLs.
deny
Regular expression matching a URL pattern or name of a filter of URLs.
bong-file
Absolute path the custom error file (text or HTML) to be returned to the client.
Example
user-agent-check
Applicable in PathCheck-class directives.
The user-agent-check can be used to restrict access to the proxy server based on the type and version of the client’s web browser. A regular expression to match with user-agent header sent from the client is passed as a parameter to this function.
Parameters
The following table describes parameters for the user-agent-check function.
Table 5-66 user-agent-check parameters
Parameter
Description
ua
Regular expression matching user-agent header sent from the client to the proxy server.
Example
ObjectTypeObjectType directives determine the MIME type of the file to send to the client in response to a request. MIME attributes currently sent are type, encoding, and language. The MIME type is sent to the client as the value of the Content-Type header.
ObjectType directives also set the type parameter, which is used by Service directives to determine how to process the request according to what kind of content is being requested.
If there is more than one ObjectType directive in an object, all of the directives are applied in the order they appear. If a directive sets an attribute and later directives try to set that attribute to something else, the first setting is used and the subsequent ones are ignored.
The obj.conf file almost always has an ObjectType directive that calls the type-by-extension function. This function instructs the server to look in a particular file (the MIME types file) to deduce the content type from the extension of the requested resource.
The following ObjectType-class functions are described in detail in this section:
- block-auth-cert instructs the proxy server not to forward the client’s SSL/TLS certificate to remote servers.
- block-cache-info instructs the proxy server not to forward information about local cache hits to remote servers.
- block-cipher instructs the proxy server to forward the name of the client’s SSL/TLS cipher suite to remote servers.
- block-ip instructs the proxy server not to forward the client’s IP address to remote servers.
- block-issuer-dn instructs the proxy server not to forward the distinguished name of the issuer of the client’s SSL/TLS certificate to remote servers.
- block-keysize instructs the proxy server not to forward the size of the client’s SSL/TLS key to remote servers.
- block-proxy-auth instructs the proxy server not to forward the client’s proxy authentication credentials.
- block-secret-keysize instructs the proxy server not to forward the size of the client’s SSL/TLS secret key to remote servers.
- block-ssl-id instructs the proxy server not to forward the client’s SSL/TLS session ID to remote servers.
- block-user-dn instructs the proxy server not to forward the distinguished name of the subject of the client’s SSL/TLS certificate to remote servers.
- cache-enable tells the proxy that an object is cacheable, based on specific criteria.
- cache-setting sets parameters used for cache control.
- force-type sets the Content-Type header for the response to a specific type.
- forward-auth-cert instructs the proxy server to forward the client’s SSL/TLS certificate to remote servers.
- forward-cache-info instructs the proxy server to forward information about local cache hits to remote servers.
- forward-cipher instructs the proxy server to forward the name of the client’s SSL/TLS cipher suite to remote servers.
- forward-ip instructs the proxy server to forward the client’s IP address to remote servers.
- forward-issuer-dn instructs the proxy server to forward the distinguished name of the issuer of the client’s SSL/TLS certificate to remote servers.
- forward-keysize instructs the proxy server to forward the size of the client’s SSL/TLS key to remote servers.
- forward-proxy-auth instructs the proxy server to forward the client’s proxy authentication credentials
- forward-secret-keysize instructs the proxy server to forward the size of the client’s SSL/TLS secret key to remote servers.
- forward-ssl-id instructs the proxy server to forward the client’s SSL/TLS session ID to remote servers.
- forward-user-dn instructs the proxy server to forward the distinguished name of the subject of the client’s SSL/TLS certificate to remote servers.
- http-client-config configures the proxy server’s HTTP client.
- java-ip-check allows clients to query the proxy server for the IP address used to reroute a resource.
- set-basic-auth matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- set-basic-auth sets the HTTP basic authentication credentials used by the proxy server when it sends an HTTP request.
- set-default-type allows you to define a default charset, content-encoding, and content-language for the response being sent back to the client.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
- shtml-hacktype requests that .htm and .html files are parsed for server-parsed HTML commands.
- ssl-client-config configures options used when the proxy server connects to a remote server using SSL/TLS.
- suppress-request-headers configures the proxy server to remove outgoing headers from the request.
- type-by-exp sets the Content-Type header for the response based on the requested path.
- type-by-extension sets the Content-Type header for the response based on the file’s extension and the MIME types database.
block-auth-cert
Applicable in ObjectType-class directives.
The block-auth-cert function instructs the proxy server not to forward the client’s SSL/TLS certificate to remote servers.
Parameters
None.
block-cache-info
Applicable in ObjectType-class directives.
The block-cache-info function instructs the proxy server not to forward information about local cache hits to remote servers.
Parameters
None.
block-cipher
Applicable in ObjectType-class directives.
The block-cipher function instructs the proxy server to forward the name of the client’s SSL/TLS cipher suite to remote servers.
Parameters
None.
block-ip
Applicable in ObjectType-class directives.
The block-ip function instructs the proxy server not to forward the client’s IP address to remote servers.
Parameters
None.
block-issuer-dn
Applicable in ObjectType-class directives.
The block-issuer-dn function instructs the proxy server not to forward the distinguished name of the issuer of the client’s SSL/TLS certificate to remote servers.
Parameter
None.
block-keysize
Applicable in ObjectType-class directives.
The block-keysize function instructs the proxy server not to forward the size of the client’s SSL/TLS key to remote servers.
Parameters
None.
block-proxy-auth
Applicable in ObjectType-class directives.
The block-proxy-auth function instructs the proxy server not to forward the client’s proxy authentication credentials (that is, the client’s Proxy-authorization HTTP request header) to remote servers.
Parameter
None.
block-secret-keysize
Applicable in ObjectType-class directives.
The block-secret-keysize function instructs the proxy server not to forward the size of the client’s SSL/TLS secret key to remote servers.
Parameters
None.
block-ssl-id
Applicable in ObjectType-class directives.
The block-ssl-id function instructs the proxy server not to forward the client’s SSL/TLS session ID to remote servers.
Parameters
None.
block-user-dn
Applicable in ObjectType-class directives.
The block-user-dn function instructs the proxy server not to forward the distinguished name of the subject of the client’s SSL/TLS certificate to remote servers.
Parameters
None.
cache-enable
Applicable in ObjectType-class directives.
The cache_enable function tells the proxy that an object is cacheable, based on specific criteria. As an example, if it appears in the object <Object ppath="http://.*">, then all the HTTP documents are considered cacheable, as long as other conditions for an object to be cacheable are met.
Syntax
ObjectType fn=cache-enable
cache-auth=0|1
query-maxlen=number
min-size=number
max-size=number
log-report=feature
cache-local=0|1Parameters
The following table describes parameters for the cache-enable function.
Table 5-67 cache-enable parameters
Parameter
Description
cache-enable
Tells the proxy that an object is cacheable. As an example, if it appears in the object <Object ppath="http://.*">, then all HTTP documents are considered cacheable (as long as other conditions for an object to be cacheable are met).
cache-auth
Specifies whether to cache items that require authentication. If set to 1, pages that require authentication can be cached also. If not specified, defaults to 0.
query-maxlen
Specifies the number of characters in the query string (the “?string” part at the end of the URL) that are still cacheable. The same queries are rarely repeated exactly in the same form by more than one user, and so caching them is often not desirable. That’s why the default is 0.
min-size
The minimum size, in kilobytes, of any document to be cached. The benefits of caching are greatest with the largest documents. For this reason, some people prefer to cache only larger documents.
max-size
The maximum size in kilobytes of any document to be cached. This allows users to limit the maximum size of cached documents, so no single document can take up too much space.
log-report
Used to control the feature that reports local cache accesses back to the origin server so that content providers get their true access logs.
cache-local
Used to enable local host caching, that is, URLs without fully qualified domain names, in the proxy. If set to 1, local hosts are cached. If not specified, it defaults to 0, and local hosts are not cached.
Example
The following example of cache-enable allows you to enable caching of objects matching the current resource. This applies to normal, non-query, non-authenticated documents of any size. The proxy requires that the document carries either last-modified or expires headers or both, and that the content-type reported by the origin server (if present) is accurate.
ObjectType fn=cache-enable
The example below is like the first example, but it also caches documents that require user authentication, and it caches queries up to five characters long. The cache-auth=1 indicates that an up-to-date check is always required for documents that need user authentication (this forces authentication again).
ObjectType fn=cache-enable
cache-auth=1
query-maxlen=5The example below is also like the first example, except that it limits the size of cache files to a range of 2 KB to 1 MB.
ObjectType fn=cache-enable
min-size=2
max-size=1000cache-setting
Applicable in ObjectType-class directives.
cache-setting is an ObjectType function that sets parameters used for cache control.
This function is used to explicitly cache (or not cache) a resource, create an object for that resource, and set the caching parameters for the object.
Syntax
ObjectType fn=cache-setting
max-uncheck=seconds
lm-factor=factor
connect-mode=always|fast-demo|never
cover-errors=numberParameters
The following table describes parameters for the cache-setting function.
Table 5-68 cache-setting parameters
Parameter
Description
max-uncheck
(Optional) is the maximum time in seconds, allowed between consecutive up-to-date checks. If set to 0 (default), a check is made every time the document is accessed, and the lm-factor has no effect.
lm-factor
(optional)A floating point number representing the factor used in estimating expiration time (how long a document might be up to date based on the time it was last modified). The time elapsed since the last modification is multiplied by this factor, and the result gives the estimated time the document is likely to remain unchanged. Specifying a value of 0 turns off this function, and then the caching system uses only explicit expiration information (rarely available). Only explicit Expires HTTP headers are used. This value has no effect if max-uncheck is set to 0.
connect-mode
Specifies network connectivity and can be set to these values:
cover-errors
If present and greater than 0, returns a document from the cache if the remote server is down and an up-to-date check cannot be made. The value specified is the maximum number of seconds since the last up-to-date check; if more time has elapsed, an error is returned. Using this feature involves the risk of getting stale data from the cache while the remote server is down. Setting this value to 0, or not specifying it (default) causes an error to be returned if the remote server is unavailable.
term-percent
means to keep retrieving if more than the specified percentage of the document has already been retrieved.
Example
<Object ppath="http://.*">
ObjectType fn=cache-enable
ObjectType fn=cache-setting max-uncheck="7200"
ObjectType fn=cache-setting lm-factor="0.020"
ObjectType fn=cache-setting connect-mode="fast-demo"
ObjectType fn=cache-setting cover-errors="3600"
Service fn=proxy-retrieve
</Object>
# Force check every time
ObjectType fn=cache-setting max-uncheck=0
# Check every 30 minutes, or sooner if changed less than
# 6 hours ago (factor 0.1; last change 1 hour ago would
# give 6-minute maximum check interval).
ObjectType fn=cache-setting max-uncheck=1800 lm-factor=0.1
# Disable caching of the current resource
ObjectType fn=cache-setting cache-mode=nothing
force-type
Applicable in ObjectType-class directives.
The force-type function assigns a type to requests that do not already have a MIME type. This is used to specify a default object type.
Make sure that the directive that calls this function comes last in the list of ObjectType directives, so that all other ObjectType directives have a chance to set the MIME type first. If there is more than one ObjectType directive in an object, all of the directives are applied in the order they appear. If a directive sets an attribute and later directives try to set that attribute to something else, the first setting is used and the subsequent ones are ignored.
Parameters
The following table describes parameters for the force-type function.
Table 5-69 force-type parameters
Parameter
Description
type
(Optional) Type assigned to a matching request (the Content-Type header).
enc
(Optional) Encoding assigned to a matching request (the Content-Encoding header).
lang
(Optional) Language assigned to a matching request (the Content-Language header).
charset
(Optional) Character set for the magnus-charset parameter in rq->srvhdrs. If the browser sent the Accept-Charset header or its User-Agent is Mozilla™/1.1 or newer, then append “; charset=charset” to content-type, where charset is the value of the magnus-charset parameter in rq->srvhdrs.
(Optional) Common to all obj.conf functions.
Example
See Also
type-by-extension, type-by-exp
forward-auth-cert
Applicable in ObjectType-class directives.
The forward-auth-cert function instructs the proxy server to forward the client’s SSL/TLS certificate to remote servers.
Parameters
The following table describes parameters for the forward-auth-cert function.
Table 5-70 forward-auth-cert parameters
Parameter
Description
hdr
(Optional) Name of the HTTP request header used to communicate the client’s DER-encoded SSL/TLS certificate in Base64 encoding. The default is "Proxy-auth-cert".
forward-cache-info
Applicable in ObjectType-class directives.
The forward-cache-info function instructs the proxy server to forward information about local cache hits to remote servers.
Parameter
The following table describes parameters for the forward-cache-info function.
Table 5-71 forward-cache-info parameters
Parameter
Description
hdr
(Optional) Name of the HTTP request header used to communicate information about local cache hits. The default is "Cache-info".
forward-cipher
Applicable in ObjectType-class directives.
The forward-cipher function instructs the proxy server to forward the name of the client’s SSL/TLS cipher suite to remote servers.
Parameters
The following table describes parameters for the forward-cipher function.
Table 5-72 forward-cipher parameters
Parameter
Description
hdr
(Optional) Name of the HTTP request header used to communicate the name of the client’s SSL/TLS cipher suite. The default is Proxy-cipher.
forward-ip
Applicable in ObjectType-class directives.
The forward-ip function instructs the proxy server to forward the client’s IP address to remote servers.
Parameters
The following table describes parameters for the forward-ip function.
Table 5-73 forward-ip parameters
Parameter
Description
hdr
(Optional) Name of the HTTP request header used to communicate the client’s IP address. The default is "Client-ip".
forward-issuer-dn
Applicable in ObjectType-class directives.
The forward-issuer-dn function instructs the proxy server to forward the distinguished name of the issuer of the client’s SSL/TLS certificate to remote servers.
Parameters
The following table describes parameters for the forward-issuer-dn function.
Table 5-74 forward-issuer-dn
Parameter
Description
hdr
(Optional) Name of the HTTP request header used to communicate the distinguished name of the issuer of the client’s SSL/TLS certificate. The default is "Proxy-issuer-dn".
forward-keysize
Applicable in ObjectType-class directives.
The forward-keysize function instructs the proxy server to forward the size of the client’s SSL/TLS key to remote servers.
Parameters
The following table describes parameters for the forward-keysize function.
Table 5-75 forward-keysize
Parameter
Description
hdr
(Optional) Name of the HTTP request header used to communicate the size of the client’s SSL/TLS key. The default is "Proxy-keysize".
suppress-request-headers
forward-proxy-auth
Applicable in ObjectType-class directives.
The forward-proxy-auth instructs the proxy server to forward the client’s proxy authentication credentials (that is, the client’s Proxy-authorization HTTP request header) to remote servers.
Parameters
None.
forward-secret-keysize
Applicable in ObjectType-class directives.
The forward-secret-keysize function instructs the proxy server to forward the size of the client’s SSL/TLS secret key to remote servers.
Parameters
The following table describes parameters for the forward-secret-keysize function.
Table 5-76 forward-secret-keysize parameters
Parameter
Description
hdr
(Optional) Name of the HTTP request header used to communicate the size of the client’s SSL/TLS secret key. The default is "Proxy-secret-keysize".
forward-ssl-id
Applicable in ObjectType-class directives.
The forward-ssl-id function instructs the proxy server to forward the client’s SSL/TLS session ID to remote servers.
Parameter
The following table describes parameters for the forward-ssl-id function.
Table 5-77 forward-ssl-id parameters
Parameter
Description
hdr
(Optional) Name of the HTTP request header used to communicate the client’s SSL/TLS session ID. The default is "Proxy-ssl-id".
forward-user-dn
Applicable in ObjectType-class directives.
The forward-user-dn function instructs the proxy server to forward the distinguished name of the subject of the client’s SSL/TLS certificate to remote servers.
Parameters
The following table describes parameters for the forward-user-dn function.
Table 5-78 forward-user-dn parameters
Parameter
Descrioption
hdr
(Optional) Name of the HTTP request header used to communicate the distinguished name of the subject of the client’s SSL/TLS certificate. The default is "Proxy-user-dn".
http-client-config
Applicable in ObjectType-class directives.
The http-client-config function configures the proxy server’s HTTP client.
Parameters
The following table describes parameters for the http-client-config function.
Table 5-79 http-client-config parameters
Parameter
Description
keep-alive
(Optional) Boolean that indicates whether the HTTP client should attempt to use persistent connections. The default is "true".
keep-alive-timeout
(Optional) The maximum number of seconds to keep a persistent connection open. The default is "29".
always-use-keep-alive
(Optional) Boolean that indicates whether the HTTP client can reuse existing persistent connections for all types of requests. The default is "false", meaning persistent connections will not be reused for non-GET requests nor for requests with a body.
protocol
(Optional) HTTP protocol version string. By default, the HTTP client uses either "HTTP/1.0" or "HTTP/1.1" based on the contents of the HTTP request. In general, you should not use the protocol parameter unless you encounter specific protocol interoperability problems.
proxy-agent
(Optional) Value of the Proxy-agent HTTP request header. The default is a string that contains the proxy server product name and version.
java-ip-check
Applicable in ObjectType-class directives.
The java-ip-check function allows clients to query the proxy server for the IP address used to reroute a resource. Because DNS spoofing often occurs with Java Applets, this feature enables clients to see the true IP address of the origin server. When this feature is enabled, the proxy server attaches a header containing the IP address that was used for connecting to the destination origin server.
Syntax
ObjectType fn=java-ip-check
status=on|offParameters
The following table describes parameters for the java-ip-check function.
Table 5-80 java-ip-check parameters
Parameter
Description
status
Specifies whether Java IP address checking is enabled or not. Possible values are:
match-browser
See match-browser.
set-basic-auth
Applicable in ObjectType-class directives.
The set-basic-auth function sets the HTTP basic authentication credentials used by the proxy server when it sends an HTTP request. set-basic-auth can be used to authenticate to a remote origin server or proxy server.
Parameters
The following table describes parameters for the set-basic-auth function.
Table 5-81 set-basic-auth parameters
Parameter
Description
user
To authenticate user.
password
The user’s password.
hdr
(Optional) Name of the HTTP request header used to communicate the credentials.
set-default-type
Applicable in ObjectType-class directives.
The set-default-type function allows you to define a default charset, content-encoding, and content-language for the response being sent back to the client.
If the charset, content-encoding, and content-language have not been set for a response, then just before the headers are sent the defaults defined by set-default-type are used. Note that by placing this function in different objects in obj.conf, you can define different defaults for different parts of the document tree.
Parameters
The following table describes parameters for the set-default-type function.
Table 5-82 set-default-type parameters
Parameter
Description
enc
(Optional) Encoding assigned to a matching request (the Content-Encoding header).
lang
(Optional) Language assigned to a matching request (the Content-Language header).
charset
(Optional) Character set for the magnus-charset parameter in rq->srvhdrs. If the browser sent the Accept-Charset header or its User-agent is Mozilla/1.1 or newer, then append “; charset=charset” to content-type, where charset is the value of the magnus-charset parameter in rq->srvhdrs.
(Optional) Common to all obj.conf functions.
Example
set-variable
See set-variable.
shtml-hacktype
Applicable in ObjectType-class directives.
The shtml-hacktype function changes the Content-Type of any .htm or .html file to magnus-internal/parsed-html and returns REQ_PROCEED. This provides backward compatibility with server-side includes for files with .htm or .html extensions. The function may also check the execute bit for the file on UNIX systems. The use of this function is not recommended.
Parameters
The following table describes parameters for the shtml-hacktype function.
Table 5-83 shtml-hacktype parameters
Parameter
Description
exec-hack
(UNIX only, optional) Tells the function to change the content-type only if the execute bit is enabled. The value of the parameter is not important; it need only be provided. You may use exec-hack=true.
(Optional) Common to all obj.conf functions.
Example
ssl-client-config
Applicable in ObjectType-class directives.
The ssl-client-config function configures options used when the proxy server connects to a remote server using SSL/TLS.
Parameter
The following table describes parameters for the ssl-client-config function.
Table 5-84 ssl-client-config parameters
Parameter
Description
client-cert-nickname
(Optional) Nickname of the client certificate to present to the remote server. The default is not to present a client certificate.
validate-server-cert
(Optional) Boolean that indicates whether the proxy server validates the certificate presented by the remote server. The default is "false", meaning the proxy server will accept any certificate.
type-by-exp
Applicable in ObjectType-class directives.
The type-by-exp function matches the current path with a wildcard expression. If the two match, the type parameter information is applied to the file. This is the same as type-by-extension, except you use wildcard patterns for the files or directories specified in the URLs.
Parameters
The following table describes parameters for the type-by-exp function.
Table 5-85 type-by-exp parameters
Parameter
Description
exp
Wildcard pattern of paths for which this function is applied.
type
(Optional) Type assigned to a matching request (the Content-Type header).
enc
(Optional) Encoding assigned to a matching request (the Content-Encoding header).
lang
(Optional) Language assigned to a matching request (the Content-Language header).
charset
(Optional) is the character set for the magnus-charset parameter in rq->srvhdrs. If the browser sent the Accept-Charset header or its User-Agent is Mozilla/1.1 or newer, then append “; charset=charset” to content-type, where charset is the value of the magnus-charset parameter in rq->srvhdrs.
(Optional) Common to all obj.conf functions.
Example
See Also
type-by-extension
Applicable in ObjectType-class directives.
The type-by-extension function instructs the server to look in a table of MIME type mappings to find the MIME type of the requested resource according to the extension of the requested resource. The MIME type is added to the Content-Type header sent back to the client.
The table of MIME type mappings is created by a MIME element in the server.xml file, which loads a MIME types file or list and creates the mappings. For more information about server.xml , see Server Configuration Elements in server.xml
For example, the following two lines are part of a MIME types file:
If the extension of the requested resource is htm or html, the type-by-extension file sets the type to text/html. If the extension is .txt, the function sets the type to text/plain.
Parameters
The following table describes parameters for the type-by-extension function.
Table 5-86 type-by-extension parameters
Parameter
Description
(Optional) Common to all obj.conf functions.
Example
See Also
InputAll Input directives are executed when the server or a plugin first attempts to read entity body data from the client.
The Input stage allows you to select filters that will process incoming request data read by the Service step.
NSAPI filters in Sun Java System Web Proxy Server 4 enable a function to intercept (and potentially modify) the content presented to or generated by another function.
You can add NSAPI filters that process incoming data by invoking the insert-filter SAF in the Input stage of the request-handling process. The Input directives are executed at most once per request.
You can also define the appropriate position of a specific filter within the filter stack. For example, filters that translate content from XML to HTML are placed higher in the filter stack than filters that compress data for transmission. You can use the filter_create function to define the filter's position in the filter stack, and the init-filter-order to override the defined position.
When two or more filters are defined to occupy the same position in the filter stack, filters that were inserted later will appear higher than filters that were inserted earlier. That is, the order of Input fn="insert-filter" and Output fn="insert-filter" directives in obj.conf becomes important.
The following Input-class functions are described in detail in this section:
- insert-filter adds a filter to the filter stack to process incoming data.
- match-browser matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- remove-filter removes a filter from the filter stack.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
insert-filter
Applicable in Input-class directives.
The insert-filter SAF is used to add a filter to the filter stack to process incoming (client-to-server) data.
The order of Input fn="insert-filter" and Output fn="insert-filter" directives can be important.
Returns
Returns REQ_PROCEED if the specified filter was inserted successfully or REQ_NOACTION if the specified filter was not inserted because it was not required. Any other return value indicates an error.
Parameters
The following table describes parameters for the insert-filter function.
Table 5-87 insert-filter parameters
Parameter
Description
filter
Specifies the name of the filter to insert.
(Optional) Common to all obj.conf functions.
Example
match-browser
See match-browser.
remove-filter
Applicable in Input-, Output-, Service-, and Error-class directives.
The remove-filter SAF is used to remove a filter from the filter stack. If the filter has been inserted multiple times, only the topmost instance is removed. In general, it is not necessary to remove filters with remove-filter, as they will be removed automatically at the end of the request.
Returns
Returns REQ_PROCEED if the specified filter was removed successfully, or REQ_NOACTION if the specified filter was not part of the filter stack. Any other return value indicates an error.
Parameters
The following table describes parameters for the remove-filter function.
Table 5-88 remove-filter parameters
Parameter
Description
filter
Specifies the name of the filter to remove.
(Optional) Common to all obj.conf functions.
Example
set-variable
Applicable in all stage directives. The set-variable SAF enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands. See set-variable.
OutputAll Output directives are executed when the server or a plugin first attempts to write entity body data from the client.
The Output stage allows you to select filters that will process outgoing data.
You can add NSAPI filters that process outcoming data by invoking the insert-filter SAF in the Output stage of the request-handling process. The Output directives are executed at most once per request.
You can define the appropriate position of a specific filter within the filter stack. For example, filters that translate content from XML to HTML are placed higher in the filter stack than filters that compress data for transmission. You can use the filter_create function to define the filter's position in the filter stack, and the init-filter-order to override the defined position.
When two or more filters are defined to occupy the same position in the filter stack, filters that were inserted later will appear higher than filters that were inserted earlier.
The following Output-class functions are described in detail in this section:
- content-rewrite rewrites the string in the document that is being sent to the client.
- insert-filter adds a filter to the filter stack to process outgoing data.
- match-browser matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- remove-filter removes a filter from the filter stack.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
content-rewrite
The content-rewrite function rewrites the string in the document that is being sent to the client.
When a document is sent by the proxy server, the content-rewrite function is invoked if it has been configured and would replace the from string/url to destination string/url before sending the response to the client.
The patterns are nothing but strings which would be replaced in the outgoing document. The pattern can be either an url with absolute or relative links, or any text string like server name and so on.
Syntax
Output fn="insert-filter" filter="content-rewrite" type="text/html" from="<sourcepattern>" to="<destpattern>"
Parameters
The following table describes parameters for the content-rewrite function.
Table 5-89 content-rewrite parameters
Parameter
Description
filter
Specifies the name of the filter to be executed.
Indicates on what content-type this filter is applied. For example, text , html, and so on.
Example
Output fn="insert-filter" type="text/*" filter="content-rewrite" from="iPlanet" to="Sun ONE (now called) Sun Java System Web Server"
insert-filter
Applicable in Output-class directives.
The insert-filter SAF is used to add a filter to the filter stack to process outgoing (server-to-client) data.
The order of Input fn="insert-filter" and Output fn="insert-filter" directives can be important.
Returns
Returns REQ_PROCEED if the specified filter was inserted successfully, or REQ_NOACTION if the specified filter was not inserted because it was not required. Any other return value indicates an error.
Parameters
The following table describes parameters for the insert-filter function.
Table 5-90 insert-filter parameters
Parameter
Description
filter
Specifies the name of the filter to insert.
(Optional) Common to all obj.conf functions.
Example
match-browser
See match-browser.
remove-filter
Applicable in Input-, Output-, Service-, and Error-class directives.
The remove-filter SAF is used to remove a filter from the filter stack. If the filter has been inserted multiple times, only the topmost instance is removed. In general, it is not necessary to remove filters with remove-filter, as they will be removed automatically at the end of the request.
Returns
Returns REQ_PROCEED if the specified filter was removed successfully, or REQ_NOACTION if the specified filter was not part of the filter stack. Any other return value indicates an error.
Parameters
The following table describes parameters for the remove-filter function.
Table 5-91 remove-filter parameters
Parameter
Description
filter
Specifies the name of the filter to remove.
(Optional) Common to all obj.conf functions.
Example
set-variable
Applicable in all stage directives. The set-variable SAF enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands. See set-variable.
ServiceThe Service-class of functions sends the response data to the client.
Every Service directive has the following optional parameters to determine whether the function is executed. All optional parameters must match the current request for the function to be executed.
(Optional) Determines the maximum number of milliseconds between write operations in which buffering is enabled. If the interval between subsequent write operations is greater than the flushTimer value for an application, further buffering is disabled. This is necessary for status-monitoring CGI applications that run continuously and generate periodic status update reports. If this parameter is not specified, the default is 3000 milliseconds.
If there is more than one Service-class function, the first one matching the optional wildcard parameters (type, method, and query) is executed.
By default, the server sends the requested file to the client by calling the send-file function. The directive that sets the default is:
Service method="(GET|HEAD)" type="*~magnus-internal/*" fn="send-file"
This directive usually comes last in the set of Service-class directives to give all other Service directives a chance to be invoked. This directive is invoked if the method of the request is GET, HEAD, or POST, and the type does not start with magnus-internal/. Note here that the pattern *~ means “does not match.” For a list of characters that can be used in patterns, see the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
The following Service-class functions are described in detail in this section:
- add-footer appends a footer specified by a file name or URL to an HTML file.
- add-header prepends a header specified by a file name or URL to an HTML file.
- append-trailer appends text to the end of an HTML file.
- deny-service prevents access to the requested resource.
- imagemap handles server-side image maps.
- index-common generates a fancy list of the files and directories in a requested directory.
- index-simple generates a simple list of files and directories in a requested directory.
- key-toosmall indicates to the client that the provided certificate key size is too small to accept.
- list-dir lists the contents of a directory.
- make-dir creates a directory.
- match-browser matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- proxy-retrieve retrieves a document from a remote server and returns it to the client. It manages caching if it is enabled.
- query-handler handles the HTML ISINDEX tag.
- remove-dir deletes an empty directory.
- remove-file deletes a file.
- remove-filter removes a refilter from the filter stack.
- rename-file renames a file.
- send-error sends an HTML file to the client in place of a specific HTTP response status.
- send-file sends a local file to the client.
- send-range sends a range of bytes of a file to the client.
- send-shellcgi sets up environment variables, launches a shell CGI program, and sends the response to the client.
- send-wincgi sets up environment variables, launches a WinCGI program, and sends the response to the client.
- service-dump creates a performance report based on collected performance bucket data.
- service-j2ee services requests made to Java web applications. This is applicable only to the Administration Server.
- service-trace services TRACE requests.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
- shtml_send parses an HTML file for server-parsed HTML commands.
- stats-xml creates a performance report in XML format.
- upload-file uploads and saves a file.
add-footer
Applicable in Service-class directives.
This function appends a footer to an HTML file that is sent to the client. The footer is specified either as a file name or a URI, thus the footer can be dynamically generated. To specify static text as a footer, use the append-trailer function.
Parameters
The following table describes parameters for the add-footer function.
Table 5-92 add-footer parameters
Parameter
Description
file
(Optional) Path name to the file containing the footer. Specify either file or uri.
By default, the path name is relative. If the path name is absolute, pass the NSIntAbsFilePath parameter as yes.
uri
(Optional) URI pointing to the resource containing the footer. Specify either file or uri.
NSIntAbsFilePath
(Optional) If the file parameter is specified, the NSIntAbsFilePath parameter determines whether the file name is absolute or relative. The default is relative. Set the value to yes to indicate an absolute file path.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Examples
Service type=text/html method=GET fn=add-footer file="footers/footer1.html"
Service type=text/html method=GET fn=add-footer file="D:/Sun/Server1/server1/footers/footer1.html" NSIntAbsFilePath="yes"
See Also
add-header
Applicable in Service-class directives.
This function prepends a header to an HTML file that is sent to the client. The header is specified either as a file name or a URI, thus the header can be dynamically generated.
Parameters
The following table describes parameters for the add-header function.
Table 5-93 add-header parameters
Parameter
Description
file
(Optional) Path name to the file containing the header. Specify either file or uri.
By default, the path name is relative. If the path name is absolute, pass the NSIntAbsFilePath parameter as yes.
uri
(Optional) URI pointing to the resource containing the header. Specify either file or uri.
NSIntAbsFilePath
(Optional) If the file parameter is specified, the NSIntAbsFilePath parameter determines whether the file name is absolute or relative. The default is relative. Set the value to yes to indicate an absolute file path.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Examples
Service type=text/html method=GET fn=add-header file="headers/header1.html"
Service type=text/html method=GET fn=add-footer file="D:/Sun/Server61/server1/headers/header1.html" NSIntAbsFilePath="yes"
See Also
append-trailer
Applicable in Service-class directives.
The append-trailer function sends an HTML file and appends text to the end. It only appends text to HTML files. This is typically used for author information and copyright text. The date the file was last modified can be inserted.
Returns REQ_ABORTED if a required parameter is missing, if there is extra path information after the file name in the URL, or if the file cannot be opened for read-only access.
Parameters
The following table describes parameters for the append-trailer function.
Table 5-94 append-trailer parameters
Parameter
Description
trailer
Text to append to HTML documents. The string is unescaped with util_uri_unescape before being sent. The text can contain HTML tags, and can be up to 512 characters long after unescaping and inserting the date.
If you use the string :LASTMOD:, which is replaced by the date the file was last modified, you must also specify a time format with timefmt.
timefmt
(Optional) Time format string for :LASTMOD:. If timefmt is not provided, :LASTMOD: will not be replaced with the time.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Examples
Service type=text/html method=GET fn=append-trailer trailer="<hr><img src=/logo.gif> Copyright 1999"
# Add a trailer with the date in the format: MM/DD/YY
Service type=text/html method=GET fn=append-trailer timefmt="%D" trailer="<HR>File last updated on: :LASTMOD:"
See Also
deny-service
See deny-service.
imagemap
Applicable in Service-class directives.
The imagemap function responds to requests for imagemaps. Imagemaps are images that are divided into multiple areas that each have an associated URL. The information about which URL is associated with which area is stored in a mapping file.
Parameters
The following table describes parameters for the imagemap function.
Table 5-95 imagemap parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
index-common
Applicable in Service-class directives.
The index-common function generates a fancy (or common) list of files in the requested directory. The list is sorted alphabetically. Files beginning with a period (.) are not displayed. Each item appears as an HTML link. This function displays more information than index-simple, including the size, date last modified, and an icon for each file. It may also include a header and/or readme file into the listing.
The Init-class function cindex-init in magnus.conf specifies the format for the index list, including where to look for the images.
If obj.conf contains a call to index-common in the Service stage, magnus.conf must initialize fancy (or common) indexing by invoking cindex-init during the Init stage.
Indexing occurs when the requested resource is a directory that does not contain an index file or a home page, or no index file or home page has been specified by the functions find-index or home-page.
The icons displayed are .gif files dependent on the content-type of the file, as listed in the following table:
Table 5-96 content-type icons
Content-type
Icon
"text/*"
text.gif
"image/*"
image.gif
"audio/*"
sound.gif
"video/*"
movie.gif
"application/octet-stream"
binary.gif
directory
menu.gif
all others
unknown.gif
Parameters
The following table describes parameters for the index-common function.
Table 5-97 index-common parameters
Parameter
Description
header
(Optional) Path (relative to the directory being indexed) and name of a file (HTML or plain text) that is included at the beginning of the directory listing to introduce the contents of the directory. The file is first tried with .html added to the end. If found, it is incorporated near the top of the directory list as HTML. If the file is not found, it is tried without the .html and incorporated as preformatted plain text (bracketed by <PRE> and).
readme
(Optional) Path (relative to the directory being indexed) and name of a file (HTML or plain text) to append to the directory listing. This file might give more information about the contents of the directory, indicate copyrights, authors, or other information. The file is first tried with .html added to the end. If found, it is incorporated at the bottom of the directory list as HTML. If the file is not found, it is tried without the .html and incorporated as preformatted plain text (enclosed by <PRE> and </PRE>).
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
See Also
index-simple, find-index, home-page
index-simple
Applicable in Service-class directives.
The index-simple function generates a simple index of the files in the requested directory. It scans a directory and returns an HTML page to the browser displaying a bulleted list of the files and directories in the directory. The list is sorted alphabetically. Files beginning with a period (.) are not displayed. Each item appears as an HTML link.
Indexing occurs when the requested resource is a directory that does not contain either an index file or a home page, or no index file or home page has been specified by the functions find-index or home-page.
Parameters
The following table describes parameters for the index-simple function.
Table 5-98 index-simple parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
See Also
key-toosmall
Applicable in Service-class directives.
Note
This function is replaced by the PathCheck-class SAF ssl-check.
The key-toosmall function returns a message to the client specifying that the secret key size for SSL communications is too small. This function is designed to be used together with a Client tag to limit access of certain directories to nonexportable browsers.
Parameters
The following table describes parameters for the key-toosmall function.
Table 5-99 key-toosmall parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
list-dir
Applicable in Service-class directives.
The list-dir function returns a sequence of text lines to the client in response to a request whose method is INDEX. The format of the returned lines is:
name type size mimetype
The name field is the name of the file or directory. It is relative to the directory being indexed. It is URL-encoded, that is, any character might be represented by %xx, where xx is the hexadecimal representation of the character's ASCII number.
The type field is a MIME type such as text/html. Directories will be of type directory. A file for which the server doesn't have a type will be of type unknown.
The size field is the size of the file, in bytes.
The mtime field is the numerical representation of the date of last modification of the file. The number is the number of seconds since the epoch (Jan 1, 1970 00:00 UTC) since the last modification of the file.
When remote file manipulation is enabled in the server, the obj.conf file contains a Service-class function that calls list-dir for requests whose method is INDEX.
Parameters
The following table describes parameters for the list-dir function.
Table 5-100 list-dir parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
make-dir
Applicable in Service-class directives.
The make-dir function creates a directory when the client sends a request whose method is MKDIR. The function can fail if the server can’t write to that directory.
When remote file manipulation is enabled in the server, the obj.conf file contains a Service-class function that invokes make-dir when the request method is MKDIR.
Parameters
The following table describes parameters for the make-dir function.
Table 5-101 make-dir parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
match-browser
See match-browser.
proxy-retrieve
The proxy-retrieve function retrieves a document from a remote server and returns it to the client. It manages caching if it is enabled. The proxy-retrieve function also lets you configure the proxy to allow or block arbitrary methods.
Syntax
Service fn=proxy-retrieve
method=GET|HEAD|POST|INDEX|CONNECT...allow|block=<List-of-comma-separated-methods>
Parameters
method lets you specify a retrieval method.
allow configures the proxy to allow specified arbitrary methods.
block configures the proxy to block specified arbitrary methods.
Examples
# Normal proxy retrieve
Service fn=proxy-retrieve
# Proxy retrieve with POST method disabled
Service fn=proxy-retrieve
method=(POST)
# Proxy retrieve allows methods FOO and BAR to pass through
Service fn=proxy-retrieve
allow="FOO,BAR"
# Proxy retrieve blocks methods MKCOL,DELETE,LOCK,UNLOCK
Service fn=proxy-retrieve
block="MKCOL,DELETE,LOCK,UNLOCK"
query-handler
Applicable in Service- and Error-class directives.
Note
This function is provided for backward compatibility only and is used mainly to support the obsolete ISINDEX tag. If possible, use an HTML form instead.
The query-handler function runs a CGI program instead of referencing the path requested.
Parameters
The following table describes parameters for the query-handler function.
Table 5-102 query-handler parameters
Parameter
Description
path
Full path and file name of the CGI program to run.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Examples
Service query=* fn=query-handler path=/http/cgi/do-grep
Service query=* fn=query-handler path=/http/cgi/proc-info
remove-dir
Applicable in Service-class directives.
The remove-dir function removes a directory when the client sends a request whose method is RMDIR. The directory must be empty (have no files in it). The function will fail if the directory is not empty or if the server doesn’t have the privileges to remove the directory.
When remote file manipulation is enabled in the server, the obj.conf file contains a Service-class function that invokes remove-dir when the request method is RMDIR.
Parameters
The following table describes parameters for the remove-dir function.
Table 5-103 remove-dir parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
remove-file
Applicable in Service-class directives.
The remove-file function deletes a file when the client sends a request whose method is DELETE. It deletes the file indicated by the URL if the user is authorized and the server has the needed file system privileges.
When remote file manipulation is enabled in the server, the obj.conf file contains a Service-class function that invokes remove-file when the request method is DELETE.
Parameters
The following table describes parameters for the remove-file function.
Table 5-104 remove-file parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
remove-filter
Applicable in Input-, Output-, Service-, and Error-class directives.
The remove-filter SAF is used to remove a filter from the filter stack. If the filter has been inserted multiple times, only the topmost instance is removed. In general, it is not necessary to remove filters with remove-filter, as they will be removed automatically at the end of the request.
Returns
Returns REQ_PROCEED if the specified filter was removed successfully, or REQ_NOACTION if the specified filter was not part of the filter stack. Any other return value indicates an error.
Parameters
The following table describes parameters for the remove-filter function.
Table 5-105 remove-filter parameters
Parameter
Description
filter
Specifies the name of the filter to remove.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
rename-file
Applicable in Service-class directives.
The rename-file function renames a file when the client sends a request with a New-URL header whose method is MOVE. It renames the file indicated by the URL to New-URL within the same directory if the user is authorized and the server has the needed file system privileges.
When remote file manipulation is enabled in the server, the obj.conf file contains a Service-class function that invokes rename-file when the request method is MOVE.
Parameters
The following table describes parameters for the rename-file function.
Table 5-106 rename-file parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
send-error
Applicable in Service-class directives.
The send-error function sends an HTML file to the client in place of a specific HTTP response status. This allows the server to present a friendly message describing the problem. The HTML page may contain images and links to the server’s home page or other pages.
Parameters
The following table describes parameters for the send-error function.
Table 5-107 send-error parameters
Parameter
Description
path
Specifies the full file system path of an HTML file to send to the client. The file is sent as text/html regardless of its name or actual type. If the file does not exist, the server sends a simple default error page.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
send-file
Applicable in Service-class directives.
The send-file function sends the contents of the requested file to the client. It provides the Content-Type, Content-Length, and Last-Modified headers.
Most requests are handled by this function using the following directive (which usually comes last in the list of Service-class directives in the default object, so that it acts as a default):
Service method="(GET|HEAD|POST)" type="*~magnus-internal/*" fn="send-file"
This directive is invoked if the method of the request is GET, HEAD, or POST, and the type does not start with magnus-internal/. Note that the pattern *~ means “does not match.”
Parameters
The following table describes parameters for the send-file function.
Table 5-108 send-file parameters
Parameter
Description
nocache
(Optional) Prevents the server from caching responses to static file requests. For example, you can specify that files in a particular directory are not to be cached, which is useful for directories where the files change frequently.
The value you assign to this parameter is ignored. If you do not wish to use this parameter, leave it out.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
In the following example, the server does not cache static files from /export/somedir/ when requested by the URL prefix /myurl.
<Object name=default>
...
NameTrans fn="pfx2dir" from="/myurl" dir="/export/mydir", name="myname"
...
Service method=(GET|HEAD|POST) type=*~magnus-internal/* fn=send-file
...
</Object>
<Object name="myname">
Service method=(GET|HEAD) type=*~magnus-internal/* fn=send-file nocache=""
</Object>
send-range
Applicable in Service-class directives.
When the client requests a portion of a document, by specifying HTTP byte ranges, the send-range function returns that portion.
Parameters
The following table describes parameters for the send-range function.
Table 5-109 send-range parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
send-shellcgi
Applicable in Service-class directives.
Windows Only. The send-shellcgi function runs a file as a shell CGI program and sends the results to the client. Shell CGI is a server configuration that lets you run CGI applications using the file associations set in Windows. For information about shell CGI programs, consult the Sun Java System Web Proxy Server 4.0.1 Administration Guide.
Parameters
The following table describes parameters for the send-shellcgi function.
Table 5-110 send-shellcgi parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions
Examples
send-wincgi
Applicable in Service-class directives.
Windows Only. The send-wincgi function runs a file as a Windows CGI program and sends the results to the client. For information about Windows CGI programs, consult the Sun Java System Web Proxy Server 4.0.1 Administration Guide.
Parameters
The following table describes parameters for the send-wincgi function.
Table 5-111 send-wincgi parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Examples
service-dump
Applicable in Service-class directives.
The service-dump function creates a performance report based on collected performance bucket data (see The bucket Parameter).
To read the report, point the browser here:
http://server_id:port/.perf
Parameters
The following table describes parameters for the service-dump function.
Table 5-112 service-dump parameters
Parameter
Description
Must be perf for this function.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Examples
<Object name=default>
NameTrans fn="assign-name" from="/.perf" name="perf"
...
</Object>
<Object name=perf>
Service fn="service-dump"
</Object>
See Also
service-j2ee
This is applicable only to the Administration Server.
Applicable in Service-class directives.
The service-j2ee function services requests made to Java web applications.
Parameters
The following table describes parameters for the service-j2ee function.
Table 5-113 service-j2ee parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Examples
<Object name=default>
NameTrans fn="ntrans-j2ee" name="j2ee"
...
</Object>
<Object name=j2ee>
Service fn="service-j2ee"
</Object>
See Also
service-trace
Applicable in Service-class directives.
The service-trace function services TRACE requests. TRACE requests are typically used to diagnose problems with web proxy servers located between a web client and web server.
Parameters
The following table describes parameters for the service_trace function.
Table 5-114 service-trace parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
set-variable
Applicable in all stage directives. The set-variable SAF enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands. See set-variable.
shtml_send
Applicable in Service-class directives.
The shtml_send function parses an HTML document, scanning for embedded commands. These commands may provide information from the server, include the contents of other files, or execute a CGI program. The shtml_send function is only available when the Shtml plugin (libShtml.so on UNIX libShtml.dll on Windows) is loaded.
Parameters
The following table describes parameters for the shtml_send function.
Table 5-115 shtml-send parameters
Parameter
Description
ShtmlMaxDepth
Maximum depth of include nesting allowed. The default value is 10.
addCgiInitVars
(UNIX only) If present and equal to yes (the default is no), adds the environment variables defined in the init-cgi SAF to the environment of any command executed through the SHTML exec tag.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
stats-xml
Applicable in Service-class directives.
The stats-xml function creates a performance report in XML format. If performance buckets have been defined, this performance report includes them.
However, you do need to initialize this function using the stats-init function in magnus.conf, then use a NameTrans function to direct requests to the stats-xml function. See the examples below.
The report is generated here:
http://server_id:port/stats-xml/iwsstats.xml
The associated DTD file is here:
http://server_id:port/stats-xml/iwsstats.dtd
Parameters
The following table describes parameters for the stats-xml function.
Table 5-116 stats-xml parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Examples
In magnus.conf:
In obj.conf:
<Object name="default">
...
NameTrans fn="assign-name" from="/stats-xml/*" name="stats-xml"
...
</Object>
...
<Object name="stats-xml">
Service fn="stats-xml"
</Object>
See Also
upload-file
Applicable in Service-class directives.
The upload-file function uploads and saves a new file when the client sends a request whose method is PUT if the user is authorized and the server has the needed file system privileges.
When remote file manipulation is enabled in the server, the obj.conf file contains a Service-class function that invokes upload-file when the request method is PUT.
Parameters
The following table describes parameters for the upload-file function.
Table 5-117 upload-file parameters
Parameter
Description
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all Service-class functions.
(Optional) Common to all obj.conf functions.
Example
AddLogAfter the server has responded to the request, the AddLog directives are executed to record information about the transaction.
If there is more than one AddLog directive, all are executed.
The following AddLog-class functions are described in detail in this section:
- common-log records information about the request in the common log format.
- flex-log records information about the request in a flexible, configurable format.
- match-browser matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- record-useragent records the client’s IP address and User-Agent header.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
common-log
Applicable in AddLog-class directives.
The common-log function records request-specific data in the common log format (used by most HTTP servers). There is a log analyzer in the /extras/log_anly directory for Proxy Server.
The common log must have been initialized previously by the init-clf function. For information about rotating logs, see flex-rotate-init in the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
There are also a number of free statistics generators for the common log format.
Parameters
The following table describes parameters for the common-log function.
Table 5-118 common-log parameters
Parameter
Description
name
(Optional) Gives the name of a log file, which must have been given as a parameter to the init-clf function in magnus.conf. If no name is given, the entry is recorded in the global log file.
iponly
(Optional) Instructs the server to log the IP address of the remote client rather than looking up and logging the DNS name. This will improve performance if DNS is off in the magnus.conf file. The value of iponly has no significance, as long as it exists; you may use iponly=1.
(Optional) Common to all obj.conf functions.
Examples
# Log all accesses to the global log file
AddLog fn=common-log
# Log accesses from outside our subnet (198.93.5.*) to
# nonlocallog
<Client ip="*~198.93.5.*">
AddLog fn=common-log name=nonlocallog
</Client>
See Also
flex-log
Applicable in AddLog-class directives.
The flex-log function records request-specific data in a flexible log format. It may also record requests in the common log format. There is a log analyzer in the /extras/flexanlg directory for Sun Java System Web Proxy Server.
There are also a number of free statistics generators for the common log format.
The log format is specified by the flex-init function call. For information about rotating logs, see flex-rotate-init in the Sun Java System Web Proxy Server 4.0.1 NSAPI Developer’s Guide.
Parameters
The following table describes parameters for the flex-log function.
Table 5-119 flex-log parameters
Parameter
Description
name
(Optional) Gives the name of a log file, which must have been given as a parameter to the flex-init function in magnus.conf. If no name is given, the entry is recorded in the global log file.
iponly
(Optional) Instructs the server to log the IP address of the remote client rather than looking up and logging the DNS name. This will improve performance if DNS is off in the magnus.conf file. The value of iponly has no significance, as long as it exists; you may use iponly=1.
(Optional) Common to all obj.conf functions.
buffers-per-file
Specifies the number of buffers for a given log file. The default value is determined by the server.
Access log entries can be logged in strict chronological order by using a single buffer per log file. To accomplish this, add buffers-per-file="1" to the Init fn="flex-init" line in magnus.conf. This ensures that requests are logged in chronological order. Note that this approach will result in decreased performance when the server is under heavy load.
Examples
# Log all accesses to the global log file
AddLog fn=flex-log
# Log accesses from outside our subnet (198.93.5.*) to
# nonlocallog
<Client ip="*~198.93.5.*">
AddLog fn=flex-log name=nonlocallog
</Client>
See Also
match-browser
See match-browser.
record-useragent
Applicable in AddLog-class directives.
The record-useragent function records the IP address of the client, followed by its User-Agent HTTP header. This indicates what version of the client was used for this transaction.
Parameters
The following table describes parameters for the record-useragent function.
Table 5-120 record-useragent parameters
Parameter
Description
name
(Optional) Gives the name of a log file, which must have been given as a parameter to the init-clf function in magnus.conf. If no name is given, the entry is recorded in the global log file.
(Optional) Common to all obj.conf functions.
Example
# Record the client ip address and user-agent to browserlog
AddLog fn=record-useragent name=browserlog
See Also
set-variable
Applicable in all stage directives. The set-variable SAF enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands. See set-variable.
ErrorIf a Server Application Function results in an error, it sets the HTTP response status code and returns the value REQ_ABORTED. When this happens, the server stops processing the request. Instead, it searches for an Error directive matching the HTTP response status code or its associated reason phrase, and executes the directive’s function. If the server does not find a matching Error directive, it returns the response status code to the client.
The following Error-class functions are described in detail in this section:
- error-j2ee handles errors that occur during execution of Java™ 2 Platform, Enterprise Edition (J2EE™ platform) applications and modules deployed to the Sun Java System Web Proxy Server. This is applicable only to the Administration Server.
- match-browser matches specific strings in the User-Agent string supplied by the browser, and then modifies the behavior of Sun Java System Web Proxy Server based upon the results by setting values for specified variables.
- query-handler runs a CGI program instead of referencing the path requested.
- remove-filter removes a filter from the filter stack.
- send-error sends an HTML file to the client in place of a specific HTTP response status.
- set-variable enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands.
error-j2ee
This is applicable only to the Administration Server.
Applicable in Error-class directives.
The error-j2ee function handles errors that occur during execution of web applications deployed to the Sun Java System Web Proxy Server individually or as part of full J2EE applications.file name
Parameters
The following table describes parameters for the error-j2ee function.
Table 5-121 error-j2ee Parameters
Parameter
Description
(Optional) Common to all obj.conf functions.
See Also
match-browser
See match-browser.
query-handler
Applicable in Service- and Error-class directives.
Note
This function is provided for backward compatibility only and is used mainly to support the obsolete ISINDEX tag. If possible, use an HTML form instead.
The query-handler function runs a CGI program instead of referencing the path requested.
Parameters
The following table describes parameters for the query-handler function.
Table 5-122 query-handler parameters
Parameter
Description
path
Full path and file name of the CGI program to run.
reason
(Optional) Text of one of the reason strings (such as “Unauthorized” or “Forbidden”). The string is not case-sensitive.
code
(Optional) Three-digit number representing the HTTP response status code, such as 401 or 407.
This can be any HTTP response status code or reason phrase according to the HTTP specification.
The following is a list of common HTTP response status codes and reason strings:
(Optional) Common to all obj.conf functions.
Examples
Error query=* fn=query-handler path=/http/cgi/do-grep
Error query=* fn=query-handler path=/http/cgi/proc-info
remove-filter
Applicable in Input-, Output-, Service-, and Error-class directives.
The remove-filter SAF is used to remove a filter from the filter stack. If the filter has been inserted multiple times, only the topmost instance is removed. In general, it is not necessary to remove filters with remove-filter, as they will be removed automatically at the end of the request.
Returns
Returns REQ_PROCEED if the specified filter was removed successfully, or REQ_NOACTION if the specified filter was not part of the filter stack. Any other return value indicates an error.
Parameters
The following table describes parameters for the remove-filter function.
Table 5-123 remove-filter parameters
Parameter
Description
filter
Specifies the name of the filter to remove.
(Optional) Common to all obj.conf functions.
Example
send-error
Applicable in Error-class directives.
The send-error function sends an HTML file to the client in place of a specific HTTP response status. This allows the server to present a friendly message describing the problem. The HTML page may contain images and links to the server’s home page or other pages.
Parameters
The following table describes parameters for the send-error function.
Table 5-124 send-error parameters
Parameter
Description
path
Specifies the full file system path of an HTML file to send to the client. The file is sent as text/html regardless of its name or actual type. If the file does not exist, the server sends a simple default error page.
reason
(Optional) Text of one of the reason strings (such as “Unauthorized” or “Forbidden”). The string is not case-sensitive.
code
(Optional) Three-digit number representing the HTTP response status code, such as 401 or 407.
This can be any HTTP response status code or reason phrase according to the HTTP specification.
The following is a list of common HTTP response status codes and reason strings:
(Optional) Common to all obj.conf functions.
Example
set-variable
Applicable in all stage directives. The set-variable SAF enables you to change server settings based upon conditional information in a request, and to manipulate variables in parameter blocks by using specific commands. See set-variable.
ConnectThe Connect directive calls the connect function you specify.
Syntax
Connect fn=your-connect-function
Only the first applicable Connect function is called, starting from the most restrictive object. Occasionally it is desirable to call multiple functions (until a connection is established). The function returns REQ_NOACTION if the next function should be called. If it fails to connect, the return value is REQ_ABORT. If it connects successfully, the connected socket descriptor will be returned.
The Connect function must have this prototype:
int your_connect_function(pblock *pb, Session *sn, Request *rq);
Connect gets its destination host name and port number from:
pblock_findval (“connect-host”, rq->vars)
atoi (pblock_findval (“connect-port”, rq->vars))The host can be in a numeric IP address format.
To use the NSAPI custom DNS class functions to resolve the host name, make a call to this function:
struct hostent *servact_gethostbyname(char *host name, Session *sn, Request *rq);
Example
This example uses the native connect mechanism to establish the connection:
#include "base/session.h"
#include "frame/req.h"
#include <ctype.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <netdb.h>
int my_connect_func(pblock *pb, Session *sn, Request *rq)
{
struct sockaddr_in sa;
int sd;
memset(&sa, 0, sizeof(sa));
sa.sin_family = AF_INET;
sa.sin_port = htons(atoi (pblock_findval (“connect-port”, rq->vars)));
/* host name resolution */
if (isdigit(*pblock_findval (“connect-host”, rq->vars)))
sa.sin_addr.s_addr = inet_addr(rq->host);
else
{
struct hostent *hp = servact_gethostbyname(pblock_findval (“connect-host”, rq->vars), sn, rq));
if (!hp)
return REQ_ABORTED; /* can't resolv */
memcpy(&sa.sin_addr, hp->h_addr, hp->h_lenght);
}
/* create the socket and connect */
sd = socket(AF_INET, SOCK_STREAM, IPPROTO_TCP);
if (sd == -1)
return REQ_ABORTED; /* can't create socket */
if (connect(sd, (struct sockaddr *)&sa, sizeof(sa)) == -1) {
close(sd);
return REQ_ABORTED; /* can't connect */
}
return sd; /* ok */
}
DNSThe DNS directive calls either the dns-config built-in function or a DNS function that you specify.
dns-config
Syntax
DNS fn=dns-config local-domain-levels=<n>
local-domain-levels specifies the number of levels of subdomains that the local network has. The default is 1.
Web Proxy Server optimizes DNS lookups by reducing the times of trying to resolve hosts that are apparently fully qualified domain names but which DNS would otherwise by default still try to resolve relative to the local domain.
For example, suppose you're in the netscape.com domain, and you try to access the host www.xyzzy.com. At first, DNS will try to resolve:
www.xyzzy.com.netscape.com
and only after that the real fully-qualified domain name:
www.xyzzy.com
If the local domain has subdomains, such as corp.netscape.com, it would do the two additional lookups:
www.xyzzy.com.corp.netscape.com
www.xyzzy.com.netscape.comTo avoid these extra DNS lookups, you can suggest to the proxy that it treat host names that are apparently not local as remote, and it should tell DNS immediately not to try to resolve the name relative to the current domain.
If the local network has no subdomains, you set the value to 0. This means that only if the host name has no domain part at all (no dots in the host name) will it be resolved relative to the local domain. Otherwise, DNS should always resolve it as an absolute, fully qualified domain name.
If the local network has one level of subdomains, you set the value to 1. This means that host names that include two or more dots will be treated as fully qualified domain names, and so on.
An example of one level of subdomains would be the netscape.com domain, with subdomains:
corp.netscape.com
engr.netscape.com
mktg.netscape.comThis means that hosts without a dot, such as step would be resolved with respect to the current domain, such as engr.netscape.com, and so the dns-config function would try this:
step.engr.netscape.com
If you are on corp.netscape.com but the destination host step is on the engr subdomain, you could say just:
step.engr
instead of having to specify the fully qualified domain name:
step.engr.netscape.com
your-dns-function
This is a DNS-class function that you define.
Syntax
DNS fn=your-dns-function
Only the first applicable DNS function is called, starting from the most restrictive object. In the rare case that it is desirable to call multiple DNS functions, the function can return REQ_NOACTION.
The DNS function must have this prototype:
int your_dns_function(pblock *pb, Session *sn, Request *rq);
To get the host name use
pblock_findval("dns-host", rq->vars)
and set the host entry using the new NSAPI function
dns_set_hostent
The struct hostent * will not be freed by the caller but will be treated as a pointer to a static area, as with the gethostbyname call. It is a good idea to keep a pointer in a static variable in the custom DNS function and on the next call either use the same struct hostent or free it before allocating a new one.
The DNS function returns REQ_PROCEED if it is successful, and REQ_NOACTION if the next DNS function (or gethostbyname, if no other applicable DNS class functions exist) should be called instead. Any other return value is treated as failure to resolve the host name.
Example
This example uses the normal gethostbyname call to resolve the host name:
#include <nsapi.h>
int my_dns_func(pblock *pb, Session *sn, Request *rq){
char *host = pblock_findval("dns-host", rq->vars);
struct hostent *hostent;
hostent = gethostbyname(host); // replace with custom DNS implementation
dns_set_hostent(hostent, sn, rq);
return REQ_PROCEED;
}
FilterThe Filter directive runs an external command and then pipes the data through the external command before processing that data in the proxy. This is accomplished using the pre-filter function. The format of the Filter directive is as follows:
Syntax
Filter fn="pre-filter" path="/your/filter/prog"
The Filter directive performs these tasks:
- It runs the program /your/filter/prog as a separate process.
- It establishes pipes between the proxy and the external program.
- It writes the response data from the remote server to the stdin of the external program.
- It reads the stdout of the program as if it were the response generated by the server.
This is equivalent to this command:
Filter fn="pre-filter"
path="/your/filter/prog"
headers="stdin"The following Filter functions are described in detail in this section:
filter-ct
Applicable in Filter-class directives.
filter-ct can be used to block response content that matches a certain MIME type.
Parameters
The following table describes parameters for the filter-ct function.
Table 5-125 filter-ct parameters
Parameter
Description
regexp
Regular expression of the mime type to be filtered.
Example
filter-html
Applicable in Filter-class directives.
filter-html can be used to filter out HTML tags from the response content before sending it to the client.
Parameters
The following table describes parameters for the filter-html function.
Example
pre-filter
Applicable in Filter-class directives.
pre-filter is used to run external filter programs before returning response content to the client.
Parameters
The following table describes parameters for the pre-filter function.
Table 5-127 pre-filter parameters
Parameter
Description
path
absolute path to external filter program.
Example
RouteThe Route directive specifies information about where the proxy server should route requests.
icp-route
Applicable in Route-class directives.
The icp-route function tells the proxy server to use ICP to determine the best source for a requested object whenever the local proxy does not have the object.
Syntax
Route fn=icp-route
redirect=yes|noParameters
The following table describes parameters for the icp-route function.
Table 5-128 icp-route parameters
Parameter
Description
redirect
Specifies whether the proxy server will send a redirect message back to the client telling it where to get the object.
pa-enforce-internal-routing
Applicable in Route-class directives.
The pa-enforce-internal-routing function enables internal routing through a proxy array. Internal routing occurs when a non PAC-enabled client routes requests through a proxy array.
Syntax
Route fn="pa_enforce_internal_routing"
redirect="yes|no"Parameters
The following table describes parameters for the pa-enforce-internal-routing function.
Table 5-129 pa-enforce-internal-routing parameters
Parameter
Description
redirect
Specifies whether or not client’s requests will be redirected. Redirecting means that if a member of a proxy array receives a request that it should not service, it tells the client which proxy to contact for that request.
pa-set-parent-route
Applicable in Route-class directives.
The pa-set-parent-route function sets a route to a parent array.
Syntax
Route fn="pa_set_parent_route"
set-proxy-server
Applicable in Route-class directives.
The set-proxy-server function directs the proxy server to connect to another proxy for retrieving the current resource. It also sets the address and port number of the proxy server to be used.
Syntax
Route fn=set-proxy-server
server=URL of other proxy server
host name=otherhost name
port=numberParameters
The following table describes parameters for the set-proxy-server function.
Table 5-130 set-proxy-server parameters
Parameter
Description
server
URL of the other proxy server. If multiple server parameters are given, the proxy server will distribute load among the specified proxy servers. (For compatibility with earlier releases, hostname and port may be specified instead of server.)
host name
The name of the host on which the other proxy server is running.
port
The port number of the remote proxy server.
Example
set-origin-server
Applicable in Route-class directives.
The set-origin-server function allows load to be distributed across a set of homogeneous HTTP origin servers by controlling which origin server the proxy server sends a request to.
Parameters
The following table describes parameters for the set-origin-server function.
Table 5-131 set-origin-server parameters
Parameter
Description
server
URL of an origin server. If multiple server parameters are given, the proxy server will distribute load among the specified origin servers.
sticky-cookie
(Optional) Name of a cookie that, when present in a response, will cause subsequent requests to "stick" to that origin server. The default is "JSESSIONID".
sticky-param
(Optional) Name of a URI parameter to inspect for route information. When the URI parameter is present in a request URI and its value contains a colon, ’:’, followed by a route ID, the request will "stick" to the origin server identified by that route ID. The default is "jsessionid".
route-hdr
(Optional) Name of the HTTP request header used to communicate route IDs to origin servers. set-origin-server associates each origin server named by a server parameter with a unique route ID. Origin servers may encode this route ID in the URI parameter named by the sticky-param parameter to cause subsequent requests to "stick" to them. The default is "Proxy-jroute".
route-cookie
(Optional) Name of the cookie generated by the proxy server when it encounters a sticky-cookie cookie in a response. The route-cookie cookie stores a route ID that enables the proxy server to direct subsequent requests back to the same origin server. The default is "JROUTE".
rewrite-host
(Optional) Boolean that indicates whether the Host HTTP request header is rewritten to match the host specified by the server parameter. The default is "false", meaning the Host header is not rewritten.
rewrite-location
(Optional) Boolean that indicates whether Location HTTP response headers that match the server parameter should be rewritten. The default is "true", meaning matching Location headers are rewritten.
rewrite-content-location
(Optional) Boolean that indicates whether Content-location HTTP response headers that match the server parameter should be rewritten. The default is "true", meaning matching Content-location headers are rewritten.
rewrite-headername
(Optional) Boolean that indicates whether headername HTTP response headers that match the server parameter should be rewritten, where headername is a user-defined header name. With the exception of the Location and Content-location headers, the default is "false", meaning the headername header is not rewritten.
set-socks-server
Applicable in Route-class directives.
The set-socks-server directs the proxy server to connect to a SOCKS server for retrieving the current resource. It also sets the address and port number of the SOCKS server to be used.
Syntax
Route fn=set-socks-server
host name=sockshost name
port=numberParameters
The following table describes parameters for the set-socks-server function.
Table 5-132 set-socks-server parameters
Parameter
Description
host name
The name of the host on which the SOCKS server runs.
port
The port on which the SOCKS server listens.
Example
unset-proxy-server
Applicable in Route-class directives.
The unset-proxy-server function tells the proxy server not to connect to another proxy server to retrieve the current resource. This function nullifies the settings of any less specific set-proxy-server functions.
Syntax
Route fn=unset-proxy-server
unset-socks-server
Applicable in Route-class directives.
The unset-socks-server function tells the proxy server not to connect to a SOCKS server to retrieve the current resource. This function nullifies the settings of any less specific set-socks-server functions.
Syntax
Route fn=unset-socks-server