mod_so - Apache HTTP Server

From 00a3be7a0f021eaa0f22da5591ad229dde3a2e05 Mon Sep 17 00:00:00 2001 From: Joshua Slive Date: Tue, 19 Mar 2002 01:11:12 +0000 Subject: [PATCH] Update transformations. git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@94008 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/mod/index.html | 5 +- docs/manual/mod/mod_include.html | 4 +- docs/manual/mod/mod_proxy.html | 13 +++ docs/manual/mod/mod_rewrite.html | 125 ++++++++++++----------------- docs/manual/mod/mod_so.html | 29 ++++--- docs/manual/mod/mod_usertrack.html | 33 ++++---- docs/manual/mod/mpm_common.html | 10 +-- 7 files changed, 105 insertions(+), 114 deletions(-) diff --git a/docs/manual/mod/index.html b/docs/manual/mod/index.html index 5f917e84dd..42a5c9da4d 100644 --- a/docs/manual/mod/index.html +++ b/docs/manual/mod/index.html @@ -39,8 +39,9 @@ configuration

mod_isapi

< by looking at a few bytes of its contents

mod_negotiation

Provides for content negotiation

mod_proxy

HTTP/1.1 proxy/gateway server

mod_rewrite

Provides a rule-based rewriting engine to rewrite requested URLs on the fly

mod_setenvif

Allows the setting of environment variables based on characteristics of the request

mod_so

-This module provides for loading of executable code and -modules into the server at start-up or restart time.

mod_speling

Attempts to correct mistaken URLs that + This module provides for loading of executable code and + modules into the server at start-up or restart time. +

mod_speling

Attempts to correct mistaken URLs that users might have entered by ignoring capitalization and by allowing up to one misspelling

mod_ssl

Strong cryptography using the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocols

mod_status

Provides information on server activity and diff --git a/docs/manual/mod/mod_include.html b/docs/manual/mod/mod_include.html index 113a44f4ca..62c050e2fb 100644 --- a/docs/manual/mod/mod_include.html +++ b/docs/manual/mod/mod_include.html @@ -519,11 +519,11 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Files processed for server-side includes no longer accept requests with PATH_INFO (trailing pathname information) by - default. You can use the AcceptPathInfo directive to + default. You can use the AcceptPathInfo directive to configure the server to accept requests with PATH_INFO.

SSIEndTag Directive

Description:	Changes the string that mod_include looks for to end an -include command.
Syntax:	SSIEndTag tag
Default:	`SSIEndTag "-->"`
Context:	server config, virtual host
Override:	FileInfo
Status:	Base
Module:	mod_include
Compatibility:	Apache 1.2 and Available in version 2.0.30 and later. +include command.
Syntax:	SSIEndTag tag
Default:	`SSIEndTag "-->"`
Context:	server config, virtual host
Override:	FileInfo
Status:	Base
Module:	mod_include
Compatibility:	Available in version 2.0.30 and later.

This directive changes the string that mod_include looks for to mark the end of a include command.

diff --git a/docs/manual/mod/mod_proxy.html b/docs/manual/mod/mod_proxy.html index fd75bf0917..40091aa7d0 100644 --- a/docs/manual/mod/mod_proxy.html +++ b/docs/manual/mod/mod_proxy.html @@ -28,6 +28,12 @@ and filter support was enabled.

Please note that the caching function present in mod_proxy up to Apache v1.3.x has been removed from mod_proxy and will be incorporated into a new module, mod_cache.

+ +

Do not enable proxying with ProxyRequests until you have +secured your server. Open proxy servers are +dangerous both to your network and to the Internet at large.

+ +

Common configuration topics

Controlling access to your proxy

You can control who can access your proxy via the normal <Directory> control block using the following example:

In a typical reverse proxy configuration, this option should be set to 'off'.

Do not enable proxying with ProxyRequests until you have +secured your server. Open proxy servers are +dangerous both to your network and to the Internet at large.

ProxyTimeout Directive

Description:
Syntax:	ProxyTimeout seconds
Default:	`ProxyTimeout 300`
Context:	server config, virtual host
Status:	Extension
Module:	mod_proxy
Compatibility:	Available in Apache 2.0.31 and later

This directive allows a user to specifiy a timeout on proxy requests. diff --git a/docs/manual/mod/mod_rewrite.html b/docs/manual/mod/mod_rewrite.html index 15acb55241..a03861ff1e 100644 --- a/docs/manual/mod/mod_rewrite.html +++ b/docs/manual/mod/mod_rewrite.html @@ -8,24 +8,21 @@ URLs on the fly``The great thing about mod_rewrite is it gives you all the configurability and flexibility of Sendmail. The downside to mod_rewrite is that it gives you all - the configurability and flexibility of Sendmail.'' - + the configurability and flexibility of Sendmail.''
+ + -- Brian Behlendorf
+ Apache Group -

- -- Brian Behlendorf
- Apache Group -

`` Despite the tons of examples and docs, mod_rewrite is voodoo. Damned cool voodoo, but still - voodoo. '' + voodoo. ''
+ + -- Brian Moore
+ bem@news.cmc.net -
- -- Brian Moore
- bem@news.cmc.net -

@@ -163,19 +160,9 @@ URLs on the fly - -

- - - - - - - - -

Figure 1: The - control flow through the rewriting ruleset

+ +
Figure 1:The control flow through the rewriting ruleset

As you can see, first the URL is matched against the Pattern of each rule. When it fails mod_rewrite @@ -203,11 +190,11 @@ URLs on the fly Quoting Special Characters

As of Apache 1.3.20, special characters in - TestString and Substitution strings can be + TestString and Substitution strings can be escaped (that is, treated as normal characters without their usual special meaning) by prefixing them with a slosh ('\') character. In other words, you can include an actual - dollar-sign character in a Substitution string by + dollar-sign character in a Substitution string by using '\$'; this keeps mod_rewrite from trying to treat it as a backreference.

@@ -223,18 +210,9 @@ URLs on the fly -

- - - - - - - - -

Figure 2: The - back-reference flow through a rule

+ +
Figure 2: The back-reference flow through a rule.

We know this was a crash course on mod_rewrite's internal processing. But you will benefit from this knowledge when @@ -276,7 +254,7 @@ SCRIPT_URI=http://en1.engelschall.com/u/rse/ practical solutions for URL-based problems. There you can find real-life rulesets and additional information about mod_rewrite.
-

RewriteBase Directive

Description:	Sets the base URL for per-directory rewrites
Syntax:	RewriteBase URL-path
Default:	`RewriteBase physical-directory-path`
Context:	directory, .htaccess
Override:	FileInfo
Status:	Extension
Module:	mod_rewrite

RewriteBase Directive

Description:	Sets the base URL for per-directory rewrites
Syntax:	RewriteBase URL-path
Default:	`See usage for information.`
Context:	directory, .htaccess
Override:	FileInfo
Status:	Extension
Module:	mod_rewrite

The RewriteBase directive explicitly sets the base URL for per-directory rewrites. As you will see below, RewriteRule @@ -285,7 +263,7 @@ SCRIPT_URI=http://en1.engelschall.com/u/rse/ i.e., the local directory prefix is stripped at this stage of processing and your rewriting rules act only on the remainder. At the end it is automatically added back to the - path.

+ path. The default setting is; RewriteBase physical-directory-path

When a substitution occurs for a new URL, this module has to re-inject the URL into the server processing. To be able @@ -332,7 +310,7 @@ RewriteRule ^oldstuff\.html$ newstuff.html

The following list gives detailed information about the internal processing steps:

-Request:
+Request:
   /xyz/oldstuff.html
 
 Internal Processing:
@@ -343,9 +321,8 @@ Internal Processing:
 
 Result:
   /abc/def/newstuff.html
-

This seems very complicated but is +

This seems very complicated but is the correct Apache internal processing, because the per-directory rewriting comes too late in the process. So, when it occurs the (rewritten) request @@ -355,7 +332,7 @@ Result: internally to the Apache server and the same procedure is used by many other operations inside Apache. So, you can be sure the design and - implementation is correct.

+ implementation is correct.

RewriteCond Directive

Description:

Defines a condition under which rewriting will take place @@ -423,23 +400,23 @@ Result: - - - - -

HTTP headers: -

HTTP_USER_AGENT
+

HTTP_USER_AGENT
HTTP_REFERER
HTTP_COOKIE
HTTP_FORWARDED
HTTP_HOST
HTTP_PROXY_CONNECTION
HTTP_ACCEPT
-

connection & request: -

REMOTE_ADDR
+

REMOTE_ADDR
REMOTE_HOST
REMOTE_USER
REMOTE_IDENT
@@ -448,28 +425,28 @@ Result: PATH_INFO
QUERY_STRING
AUTH_TYPE
-

server internals: -

DOCUMENT_ROOT
+

DOCUMENT_ROOT
SERVER_ADMIN
SERVER_NAME
SERVER_ADDR
SERVER_PORT
SERVER_PROTOCOL
SERVER_SOFTWARE
-

system stuff: -

TIME_YEAR
+

TIME_YEAR
TIME_MON
TIME_DAY
TIME_HOUR
@@ -477,18 +454,18 @@ Result: TIME_SEC
TIME_WDAY
TIME
-

specials: -

API_VERSION
+

API_VERSION
THE_REQUEST
REQUEST_URI
REQUEST_FILENAME
IS_SUBREQ
-

@@ -637,7 +614,7 @@ Result: TestString is lexically equal to CondPattern, i.e the two strings are exactly equal (character by character). If CondPattern - is just "" (two quotation marks) this + is just "" (two quotation marks) this compares TestString to the empty string.

'-d' (is @@ -692,9 +669,10 @@ Result:

[flags]

- as the third argument to the RewriteCond + +

as the third argument to the RewriteCond directive. Flags is a comma-separated list of the - following flags: + following flags:

'nocase|NC' @@ -752,7 +730,7 @@ RewriteRule ^/$ /homepage.std.html [L] tables, etc. If you use any other browser you get the standard homepage.

RewriteEngine Directive

Description:
Syntax:	RewriteEngine on\|off
Default:	`RewriteEngine off`
Context:	server config, virtual host, directory, .htaccess
Override:	FileInfo
Status:	Extension
Module:	mod_rewrite

RewriteEngine Directive

Description:	Enables or disables runtime rewriting engine
Syntax:	RewriteEngine on\|off
Default:	`RewriteEngine off`
Context:	server config, virtual host, directory, .htaccess
Override:	FileInfo
Status:	Extension
Module:	mod_rewrite

The RewriteEngine directive enables or disables the runtime rewriting engine. If it is set to @@ -1046,12 +1024,12 @@ while (<STDIN>) {

- The RewriteMap directive can occur more than +

The RewriteMap directive can occur more than once. For each mapping-function use one RewriteMap directive to declare its rewriting mapfile. While you cannot declare a map in per-directory context it is of course possible to - use this map in per-directory context. + use this map in per-directory context.

Note

For plain text and DBM format files the looked-up keys are cached in-core until the mtime of the @@ -1099,7 +1077,7 @@ once! -

 Text:
   .           Any single character
@@ -1182,7 +1160,7 @@ When using the NOT character
         mapping-function calls
         (${mapname:key|default})
       
-      Back-references are $N
+      Back-references are $N
       (N=0..9) identifiers which will be replaced
       by the contents of the Nth group of the
       matched Pattern. The server-variables are the same
@@ -1190,7 +1168,7 @@ When using the NOT character
       directive. The mapping-functions come from the
       RewriteMap directive and are explained there.
       These three types of variables are expanded in the order of
-      the above list. 
+      the above list. 
 
       As already mentioned above, all the rewriting rules are
       applied to the Substitution (in the order of
@@ -1243,9 +1221,10 @@ There is a special feature:
       

         [flags]
       
+      
       as the third argument to the RewriteRule
       directive. Flags is a comma-separated list of the
-      following flags: 
+      following flags: 
 
       
         
@@ -1626,7 +1605,8 @@ directory which is not always possible.
           / Language /~
           Realname /.../ File
         
-        into 
+
+        into 
 
         
           /u/ Username /.../
@@ -1644,6 +1624,5 @@ RewriteLog   /path/to/file/rewrite.log
 RewriteMap   real-to-user               txt:/path/to/file/map.txt
 RewriteRule  ^/([^/]+)/~([^/]+)/(.*)$   /u/${real-to-user:$2|nobody}/$3.$1

- -

Apache HTTP Server Version 2.0

\ No newline at end of file +

Apache HTTP Server Version 2.0

\ No newline at end of file diff --git a/docs/manual/mod/mod_so.html b/docs/manual/mod/mod_so.html index 6b306b0189..6fa8877767 100644 --- a/docs/manual/mod/mod_so.html +++ b/docs/manual/mod/mod_so.html @@ -3,16 +3,17 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This file is generated from xml source: DO NOT EDIT XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -->mod_so - Apache HTTP Server

Apache HTTP Server Version 2.0
Apache Module mod_so
Description: -This module provides for loading of executable code and -modules into the server at start-up or restart time.
Status: Base (Windows>; Optional (Unix)
Module Identifier: so_module
Compatibility: Available in Apache 1.3 and later.
Summary
+ This module provides for loading of executable code and + modules into the server at start-up or restart time. +

Status: Base (Windows>; Optional (Unix)

Module Identifier: so_module

Compatibility: Available in Apache 1.3 and later.

Summary

On selected operating systems this module can be used to load modules into Apache at runtime via the Dynamic Shared Object (DSO) mechanism, rather than requiring a recompilation.

On Unix, the loaded code typically comes from shared object - files (usually with .so extension), on Windows - this may either the .so or .dll + files (usually with .so extension), on Windows + this may either the .so or .dll extension. This module is only available in Apache 1.3 and up.

@@ -21,19 +22,21 @@ modules into the server at start-up or restart time. Windows, mod_dll was used in beta release 1.3b1 through 1.3b5. mod_so combines these two modules into a single module for all operating systems.

- -

Warning: Apache 1.3 modules cannot be directly used +

Warning
+
Apache 1.3 modules cannot be directly used with Apache 2.0 - the module must be modified to dynamically - load or compile into Apache 2.0.
-
Directives
LoadFile
LoadModule
Creating Loadable Modules -for Windows
+ load or compile into Apache 2.0.
+

Directives

LoadFile
LoadModule

Creating Loadable Modules for Windows

-
Note: the module name format changed for Windows +
Note
+
The module name format changed for Windows with Apache 1.3.15 and 2.0 - the modules are now named as - mod_foo.so
. While mod_so still loads modules with + mod_foo.so
+
While mod_so still loads modules with ApacheModuleFoo.dll names, the new naming convention is preferred; if you are converting your loadable module for 2.0, - please fix the name to this 2.0 convention.
+ please fix the name to this 2.0 convention.

The Apache module API is unchanged between the Unix and Windows versions. Many modules will run on Windows with no or @@ -89,7 +92,7 @@ for Windows .dsp.

This should create a DLL version of your module. Now simply - place it in the modules directory of your server + place it in the modules directory of your server root, and use the LoadModule directive to load it.
diff --git a/docs/manual/mod/mod_usertrack.html b/docs/manual/mod/mod_usertrack.html index 5e94c5c117..3cba9018fd 100644 --- a/docs/manual/mod/mod_usertrack.html +++ b/docs/manual/mod/mod_usertrack.html @@ -6,9 +6,6 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX This module uses cookies to provide for a clickstream log of user activity on a site. Status:ExtensionModule Identifier:usertrack_moduleCompatibility:Known as mod_cookies prior to Apache 1.3.
Summary
- -
Summary
-
Previous releases of Apache have included a module which generates a 'clickstream' log of user activity on a site using cookies. This was called the "cookies" module, mod_cookies. In @@ -19,26 +16,26 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Previously, the cookies module (now the user tracking - module) did its own logging, using the CookieLog + module) did its own logging, using the CookieLog directive. In this release, this module does no logging at all. Instead, a configurable log format file should be used to log user click-streams. This is possible because the logging module now allows multiple log files. The cookie itself is logged by - using the text %{cookie}n in the log file format. For + using the text %{cookie}n in the log file format. For example:

CustomLog logs/clickstream "%{cookie}n %r %t"

For backward compatibility the configurable log module - implements the old CookieLog directive, but this - should be upgraded to the above CustomLog directive.
+ implements the old CookieLog directive, but this + should be upgraded to the above CustomLog directive.

2-digit or 4-digit dates for cookies?

(the following is from message <022701bda43d$9d32bbb0$1201a8c0@christian.office.sane.com> - in the new-httpd archives) + in the new-httpd archives)

From: "Christian Allen" <christian@sane.com> Subject: Re: Apache Y2K bug in mod_usertrack.c @@ -71,16 +68,15 @@ form, but also understands 4-digit years, which can probably reach up until 9999. Your best bet for sending a long-life cookie is to send it for some time late in the year "37".
-
-
CookieDomain Directive
Description: controls the setting of the domain to which - the tracking cookie applies.
Syntax: CookieDomain domain
Default: None
Context: server config, virtual host, directory, .htaccess
Status: Extension
Module: mod_usertrack
+ +
CookieDomain Directive
Description: controls the setting of the domain to which the tracking cookie applies.
Syntax: CookieDomain domain
Default: None
Context: server config, virtual host, directory, .htaccess
Status: Extension
Module: mod_usertrack

This directive controls the setting of the domain to which the tracking cookie applies. If not present, no domain is included in the cookie header field.
-
The domain string must begin with a dot, and - must include at least one embedded dot. That is, +
The domain string must begin with a dot, and + must include at least one embedded dot. That is, ".foo.com" is legal, but "foo.bar.com" and ".com" are not.

CookieExpires Directive
Description:
Syntax: CookieExpires expiry-period
Default:
Context: server config, virtual host, directory, .htaccess
Override:
Status: Extension
Module: mod_usertrack
Compatibility: In 1.3.20 and earlier, not usable in directory and .htaccess
@@ -102,21 +98,20 @@ time late in the year "37".
You must specify a valid cookie name; results are unpredictable if you use a name containing unusual characters. Valid characters include A-Z, a-z, 0-9, "_", and "-".
-
CookieStyle Directive
Description: Controls the format of the cookie header - field
Syntax: CookieStyle - Netscape|Cookie|Cookie2|RFC2109|RFC2965
Default:
Context: server config, virtual host, directory, .htaccess
Status: Extension
Module: mod_usertrack
+
CookieStyle Directive
Description: Controls the format of the cookie header field
Syntax: CookieStyle + Netscape|Cookie|Cookie2|RFC2109|RFC2965
Default:
Context: server config, virtual host, directory, .htaccess
Status: Extension
Module: mod_usertrack

This directive controls the format of the cookie header field. The three formats allowed are:

-
Netscape, which is the original but now deprecated +
Netscape, which is the original but now deprecated syntax. This is the default, and the syntax Apache has historically used.
-
Cookie or RFC2109, which is the syntax that +
Cookie or RFC2109, which is the syntax that superseded the Netscape syntax.
-
Cookie2 or RFC2965, which is the most +
Cookie2 or RFC2965, which is the most current cookie syntax.

diff --git a/docs/manual/mod/mpm_common.html b/docs/manual/mod/mpm_common.html index e439fbeec4..abfd8c3d89 100644 --- a/docs/manual/mod/mpm_common.html +++ b/docs/manual/mod/mpm_common.html @@ -4,7 +4,7 @@ XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX -->mpm_common - Apache HTTP Server
Apache HTTP Server Version 2.0
Apache Module mpm_common
Description: A collection of directives that are implemented by more than one multi-processing module (MPM)
Status: MPM
Directives
CoreDumpDirectory
Group
Listen
ListenBackLog
LockFile
MaxClients
MaxRequestsPerChild
MaxSpareThreads
MaxThreadsPerChild
MinSpareThreads
NumServers
PidFile
ScoreBoardFile
SendBufferSize
ServerLimit
StartServers
StartThreads
ThreadLimit
ThreadsPerChild
User
CoreDumpDirectory Directive
Description: Sets the directory where Apache attempts to -switch before dumping core
Syntax: CoreDumpDirectory directory
Default: CoreDumpDirectory ServerRoot
Context: server config
Status: MPM
Module: worker, perchild, prefork, mpm_winnt
+switch before dumping coreSyntax:CoreDumpDirectory directoryDefault:See usage for the default settingContext:server configStatus:MPMModule:worker, perchild, prefork, mpm_winnt
This controls the directory to which Apache attempts to switch before dumping core. The default is in the @@ -68,14 +68,14 @@ listens toSy Listen 80
Listen 8000
- To make the server accept connections on two specified - interfaces and port numbers, use +
To make the server accept connections on two specified + interfaces and port numbers, use

Listen 192.170.2.1:80 Listen 192.170.2.5:8000
- IPv6 addresses must be surrounded in square brackets, as in the - following example: +
IPv6 addresses must be surrounded in square brackets, as in the + following example:

Listen [fe80::a00:20ff:fea7:ccea]:80
-- 2.40.0

Directives

+ + Figure 1:The control flow through the rewriting ruleset

Apache HTTP Server Version 2.0

Apache HTTP Server Version 2.0

Apache HTTP Server Version 2.0

Apache Module mod_so

Summary

Summary

Directives

Creating Loadable Modules -for Windows

Directives

Creating Loadable Modules for Windows

Summary

Summary

2-digit or 4-digit dates for cookies?

Apache HTTP Server Version 2.0

Apache Module mpm_common

Directives

+ +
Figure 1:The control flow through the rewriting ruleset

As you can see, first the URL is matched against the Pattern of each rule. When it fails mod_rewrite @@ -203,11 +190,11 @@ URLs on the fly Quoting Special Characters