فهرست منبع

tls: docs - removed trailing spaces

Daniel-Constantin Mierla 1 سال پیش
والد
کامیت
3bbbc39a32
4فایلهای تغییر یافته به همراه26 افزوده شده و 26 حذف شده
  1. 15 15
      src/modules/tls/doc/certs_howto.xml
  2. 1 1
      src/modules/tls/doc/hsm_howto.xml
  3. 7 7
      src/modules/tls/doc/params.xml
  4. 3 3
      src/modules/tls/doc/tls.xml

+ 15 - 15
src/modules/tls/doc/certs_howto.xml

@@ -68,7 +68,7 @@ Creating the CA certificate
 1. Create the CA directory
 1. Create the CA directory
 	mkdir ca
 	mkdir ca
 	cd ca
 	cd ca
-	
+
 2. Create the CA directory structure and files  (see ca(1))
 2. Create the CA directory structure and files  (see ca(1))
 	mkdir demoCA 		#default CA name, edit /etc/ssl/openssl.cnf
 	mkdir demoCA 		#default CA name, edit /etc/ssl/openssl.cnf
 	mkdir  demoCA/private
 	mkdir  demoCA/private
@@ -76,11 +76,11 @@ Creating the CA certificate
 	touch demoCA/index.txt
 	touch demoCA/index.txt
 	echo 01 >demoCA/serial
 	echo 01 >demoCA/serial
 	echo 01 >demoCA/crlnumber
 	echo 01 >demoCA/crlnumber
-	
+
 2. Create CA private key
 2. Create CA private key
 	openssl genrsa -out demoCA/private/cakey.pem 2048
 	openssl genrsa -out demoCA/private/cakey.pem 2048
 	chmod 600 demoCA/private/cakey.pem
 	chmod 600 demoCA/private/cakey.pem
-	
+
 3. Create CA self-signed certificate
 3. Create CA self-signed certificate
 	openssl req -out demoCA/cacert.pem   -x509 -new -key demoCA/private/cakey.pem
 	openssl req -out demoCA/cacert.pem   -x509 -new -key demoCA/private/cakey.pem
 
 
@@ -92,10 +92,10 @@ Creating a server/client TLS certificate
 	openssl req -out kamailio1_cert_req.pem -new -nodes
 	openssl req -out kamailio1_cert_req.pem -new -nodes
 
 
 	WARNING: the organization name should be the same as in the CA certificate.
 	WARNING: the organization name should be the same as in the CA certificate.
-	
+
 2. Sign it with the CA certificate
 2. Sign it with the CA certificate
 	openssl ca -in kamailio1_cert_req.pem -out kamailio1_cert.pem
 	openssl ca -in kamailio1_cert_req.pem -out kamailio1_cert.pem
-	
+
 3. Copy kamailio1_cert.pem to your &kamailio; configuration dir
 3. Copy kamailio1_cert.pem to your &kamailio; configuration dir
 
 
 
 
@@ -104,32 +104,32 @@ Setting &kamailio; to use the TLS certificate
 1. Create the CA list file:
 1. Create the CA list file:
 	for each of your CA certificates that you intend to use do:
 	for each of your CA certificates that you intend to use do:
 		cat cacert.pem >>calist.pem
 		cat cacert.pem >>calist.pem
-	
-2. Copy your &kamailio; certificate, private key and ca list file to your 
+
+2. Copy your &kamailio; certificate, private key and ca list file to your
 	intended machine (preferably in your &kamailio; configuration directory,
 	intended machine (preferably in your &kamailio; configuration directory,
 	 this is the default place &kamailio; searches for).
 	 this is the default place &kamailio; searches for).
-	
+
 3. Set up &kamailio;.cfg to use the certificate
 3. Set up &kamailio;.cfg to use the certificate
 	if your &kamailio; certificate name is different from cert.pem or it is not
 	if your &kamailio; certificate name is different from cert.pem or it is not
 	placed in &kamailio; cfg. directory, add to your kamailio.cfg:
 	placed in &kamailio; cfg. directory, add to your kamailio.cfg:
 		modparam("tls", "certificate", "/path/cert_file_name")
 		modparam("tls", "certificate", "/path/cert_file_name")
-	
+
 4. Set up &kamailio; to use the private key
 4. Set up &kamailio; to use the private key
 	if your private key is not contained in the same file as the certificate
 	if your private key is not contained in the same file as the certificate
 	(or the certificate name is not the default cert.pem), add to your
 	(or the certificate name is not the default cert.pem), add to your
 	 &kamailio;.cfg:
 	 &kamailio;.cfg:
 		modparam("tls", "private_key", "/path/private_key_file")
 		modparam("tls", "private_key", "/path/private_key_file")
-	
+
 5. Set up &kamailio; to use the CA list (optional)
 5. Set up &kamailio; to use the CA list (optional)
    The CA list is not used for your server certificate - it's used to approve other servers
    The CA list is not used for your server certificate - it's used to approve other servers
    and clients connecting to your server with a client certificate or for approving
    and clients connecting to your server with a client certificate or for approving
    a certificate used by a server your server connects to.
    a certificate used by a server your server connects to.
 	add to your &kamailio;.cfg:
 	add to your &kamailio;.cfg:
 		modparam("tls", "ca_list", "/path/ca_list_file")
 		modparam("tls", "ca_list", "/path/ca_list_file")
-	
+
 6. Set up TLS authentication options:
 6. Set up TLS authentication options:
 		modparam("tls", "verify_certificate", 1)
 		modparam("tls", "verify_certificate", 1)
-		modparam("tls", "require_certificate", 1) 
+		modparam("tls", "require_certificate", 1)
 	(for more information see the module parameters documentation)
 	(for more information see the module parameters documentation)
 
 
 
 
@@ -137,12 +137,12 @@ Revoking a certificate and using a CRL
 --------------------------------------
 --------------------------------------
 1. Revoking a certificate:
 1. Revoking a certificate:
 	openssl ca -revoke bad_cert.pem
 	openssl ca -revoke bad_cert.pem
-	
+
 2. Generate/update the certificate revocation list:
 2. Generate/update the certificate revocation list:
 	openssl ca -gencrl -out my_crl.pem
 	openssl ca -gencrl -out my_crl.pem
-	
+
 3. Copy my_crl.pem to your &kamailio; config. dir
 3. Copy my_crl.pem to your &kamailio; config. dir
-	
+
 4. Set up &kamailio; to use the CRL:
 4. Set up &kamailio; to use the CRL:
 		modparam("tls", "crl", "path/my_crl.pem")
 		modparam("tls", "crl", "path/my_crl.pem")
 
 

+ 1 - 1
src/modules/tls/doc/hsm_howto.xml

@@ -14,7 +14,7 @@
 
 
 	<title>HSM Howto</title>
 	<title>HSM Howto</title>
 		<para>
 		<para>
-			This documents OpenSSL engine support for private keys in HSM. 
+			This documents OpenSSL engine support for private keys in HSM.
 		</para>
 		</para>
 		<para>
 		<para>
 		        Assumptions: an OpenSSL engine configured with private key. We still require the certificate file
 		        Assumptions: an OpenSSL engine configured with private key. We still require the certificate file

+ 7 - 7
src/modules/tls/doc/params.xml

@@ -201,7 +201,7 @@ modparam("tls", "private_key", "/usr/local/etc/kamailio/my_pkey.pem")
 		An easy way to create the CA list is to append each trusted trusted CA
 		An easy way to create the CA list is to append each trusted trusted CA
 		certificate in the PEM format to one file, e.g.:
 		certificate in the PEM format to one file, e.g.:
 	    <programlisting>
 	    <programlisting>
-for f in trusted_cas/*.pem ; do cat "$f" &gt;&gt; ca_list.pem ; done 
+for f in trusted_cas/*.pem ; do cat "$f" &gt;&gt; ca_list.pem ; done
 	    </programlisting>
 	    </programlisting>
 	</para>
 	</para>
 	<para>
 	<para>
@@ -320,7 +320,7 @@ modparam("tls", "crl", "/usr/local/etc/kamailio/crl.pem")
 <section id="tls.p.verify_certificate">
 <section id="tls.p.verify_certificate">
 	<title><varname>verify_certificate</varname> (boolean)</title>
 	<title><varname>verify_certificate</varname> (boolean)</title>
 	<para>
 	<para>
-		If enabled it will force certificate verification when connecting to 
+		If enabled it will force certificate verification when connecting to
 		other SIP servers..
 		other SIP servers..
 		For more information see the
 		For more information see the
 		<ulink url="https://www.openssl.org/docs/manmaster/man1/verify.html">verify(1)</ulink>
 		<ulink url="https://www.openssl.org/docs/manmaster/man1/verify.html">verify(1)</ulink>
@@ -470,8 +470,8 @@ modparam("tls", "connection_timeout", 60)
 		If set compression over TLS will be disabled.
 		If set compression over TLS will be disabled.
 		Note that compression uses a lot of memory (about 10x more than with
 		Note that compression uses a lot of memory (about 10x more than with
 		the compression disabled), so if you want to minimize
 		the compression disabled), so if you want to minimize
-		memory usage is a good idea to disable it. TLS compression also 
-		expose you for the 
+		memory usage is a good idea to disable it. TLS compression also
+		expose you for the
  		<ulink url="https://en.wikipedia.org/wiki/CRIME_(security_exploit)">
  		<ulink url="https://en.wikipedia.org/wiki/CRIME_(security_exploit)">
 		CRIME</ulink> security vulnerability.
 		CRIME</ulink> security vulnerability.
 	</para>
 	</para>
@@ -839,7 +839,7 @@ modparam("tls", "tls_debug", 10)
 		new TLS connections will start to fail. The value is expressed in KB.
 		new TLS connections will start to fail. The value is expressed in KB.
 	</para>
 	</para>
 	<para>
 	<para>
-		The default value depends on whether the OpenSSL library used handles 
+		The default value depends on whether the OpenSSL library used handles
 		low memory situations in a good way (openssl bug #1491).
 		low memory situations in a good way (openssl bug #1491).
 		As of this writing this is not true for any OpenSSL version (including 0.9.8e).
 		As of this writing this is not true for any OpenSSL version (including 0.9.8e).
 	</para>
 	</para>
@@ -959,7 +959,7 @@ modparam("tls", "low_mem_threshold2", -1)
 		<listitem>
 		<listitem>
 			<para>
 			<para>
 				the OpenSSL library used at compile time and the one used at
 				the OpenSSL library used at compile time and the one used at
-				runtime have different Kerberos options 
+				runtime have different Kerberos options
 			</para>
 			</para>
 		</listitem>
 		</listitem>
 	</itemizedlist>
 	</itemizedlist>
@@ -1210,7 +1210,7 @@ server_name_mode = 1
 	</programlisting>
 	</programlisting>
 	</example>
 	</example>
 	<para>
 	<para>
-		For a more complete example check the <emphasis>tls.cfg</emphasis> distributed 
+		For a more complete example check the <emphasis>tls.cfg</emphasis> distributed
 		with the &kamailio; source (kamailio/modules/tls/tls.cfg).
 		with the &kamailio; source (kamailio/modules/tls/tls.cfg).
 	</para>
 	</para>
 	<example>
 	<example>

+ 3 - 3
src/modules/tls/doc/tls.xml

@@ -138,7 +138,7 @@ request_route {
 		<para>
 		<para>
 			This module includes several workarounds for various Openssl bugs
 			This module includes several workarounds for various Openssl bugs
 			(like compression and Kerberos using the wrong memory allocations
 			(like compression and Kerberos using the wrong memory allocations
-			functions, low memory problems a.s.o). On startup it will try to enable 
+			functions, low memory problems a.s.o). On startup it will try to enable
 			the needed workarounds based on the OpenSSL library version. Each time
 			the needed workarounds based on the OpenSSL library version. Each time
 			a known problem is detected and a workaround is enabled, a message will
 			a known problem is detected and a workaround is enabled, a message will
 			be logged. In general it is recommended to compile this module on the
 			be logged. In general it is recommended to compile this module on the
@@ -163,7 +163,7 @@ request_route {
  			(see <varname>tls_disable_compression</varname>).
  			(see <varname>tls_disable_compression</varname>).
 		</para>
 		</para>
 		<para>
 		<para>
-			The TLS module includes workarounds for the following known openssl bugs: 
+			The TLS module includes workarounds for the following known openssl bugs:
 			<itemizedlist>
 			<itemizedlist>
                         <listitem><para>
                         <listitem><para>
 			openssl #1204 (disable SS_OP_TLS_BLOCK_PADDING_BUG if compression is enabled,
 			openssl #1204 (disable SS_OP_TLS_BLOCK_PADDING_BUG if compression is enabled,
@@ -173,7 +173,7 @@ request_route {
 			openssl #1468 (fix zlib compression memory allocation),
 			openssl #1468 (fix zlib compression memory allocation),
                         </para></listitem>
                         </para></listitem>
                         <listitem><para>
                         <listitem><para>
-			openssl #1467 (kerberos support will be disabled if the openssl version is less than 0.9.8e-beta1) 
+			openssl #1467 (kerberos support will be disabled if the openssl version is less than 0.9.8e-beta1)
                         </para></listitem>
                         </para></listitem>
                         <listitem><para>
                         <listitem><para>
 			openssl #1491 (stop using tls in low memory situations due to the very high risk of openssl crashing or leaking memory).
 			openssl #1491 (stop using tls in low memory situations due to the very high risk of openssl crashing or leaking memory).