]> granicus.if.org Git - apache/blob - docs/manual/mod/mod_nw_ssl.xml
Update docco xforms
[apache] / docs / manual / mod / mod_nw_ssl.xml
1 <?xml version="1.0"?>
2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
4 <!-- $LastChangedRevision$ -->
5
6 <!--
7  Licensed to the Apache Software Foundation (ASF) under one or more
8  contributor license agreements.  See the NOTICE file distributed with
9  this work for additional information regarding copyright ownership.
10  The ASF licenses this file to You under the Apache License, Version 2.0
11  (the "License"); you may not use this file except in compliance with
12  the License.  You may obtain a copy of the License at
13
14      http://www.apache.org/licenses/LICENSE-2.0
15
16  Unless required by applicable law or agreed to in writing, software
17  distributed under the License is distributed on an "AS IS" BASIS,
18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  See the License for the specific language governing permissions and
20  limitations under the License.
21 -->
22
23 <modulesynopsis metafile="mod_nw_ssl.xml.meta">
24
25 <name>mod_nw_ssl</name>
26 <description>Enable SSL encryption for NetWare</description>
27 <status>Base</status>
28 <sourcefile>mod_nw_ssl.c</sourcefile>
29 <identifier>nwssl_module</identifier>
30 <compatibility>NetWare only</compatibility>
31
32 <summary>
33     <p>This module enables SSL encryption for a specified port. It
34     takes advantage of the SSL encryption functionality that is 
35     built into the NetWare operating system.</p>
36 </summary>
37
38 <directivesynopsis>
39 <name>SecureListen</name>
40 <description>Enables SSL encryption for the specified port</description>
41 <syntax>SecureListen [<var>IP-address</var>:]<var>portnumber</var>
42 <var>Certificate-Name</var> [MUTUAL]</syntax>
43 <contextlist><context>server config</context></contextlist>
44
45 <usage>
46     <p>Specifies the port and the eDirectory based certificate name
47     that will be used to enable SSL encryption. An optional third
48     parameter also enables mutual authentication.</p>
49 </usage>
50 </directivesynopsis>
51
52 <directivesynopsis>
53 <name>NWSSLTrustedCerts</name>
54 <description>List of additional client certificates</description>
55 <syntax>NWSSLTrustedCerts <var>filename</var> [<var>filename</var>] ...</syntax>
56 <contextlist><context>server config</context></contextlist>
57
58 <usage>
59     <p>Specifies a list of client certificate files (DER format)
60     that are used when creating a proxied SSL connection. Each
61     client certificate used by a server must be listed separately 
62     in its own <code>.der</code> file.</p>
63 </usage>
64 </directivesynopsis>
65
66 <directivesynopsis>
67 <name>NWSSLUpgradeable</name>
68 <description>Allows a connection to be upgraded to an SSL connection upon request</description>
69 <syntax>NWSSLUpgradeable [<var>IP-address</var>:]<var>portnumber</var></syntax>
70 <contextlist><context>server config</context></contextlist>
71
72 <usage>
73     <p>Allow a connection that was created on the specified address 
74     and/or port to be upgraded to an SSL connection upon request from
75     the client. The address and/or port must have already be defined 
76     previously with a <directive module="mpm_common">Listen</directive> 
77     directive.</p>
78 </usage>
79 </directivesynopsis>
80
81 </modulesynopsis>