<!-- Module User's Guide -->

<chapter>

	<title>&adminguide;</title>

	<section id="overview" xreflabel="Overview">
	<title>Overview</title>
	<para>
		This module implements TLS operations using the
		<ulink url="https://www.openssl.org/">
		<citetitle>openSSL</citetitle></ulink> libarary. It provides the primitives
		required by the <emphasis>tls_mgm</emphasis> module in order to expose a
		higher-level API used by TLS-based protocol modules like
		<emphasis>proto_tls</emphasis> or <emphasis>proto_wss</emphasis> etc.
	</para>
	</section>

	<section id="dependencies" xreflabel="Dependencies">
	<title>Dependencies</title>
	<section>
		<title>&osips; Modules</title>
		<para>
		The following modules must be loaded before this module:
			<itemizedlist>
			<listitem>
			<para>
				<emphasis>None</emphasis>.
			</para>
			</listitem>
			</itemizedlist>
		</para>
	</section>

	<section>
		<title>External Libraries or Applications</title>
		<para>
		&osips; TLS v1.0 support requires the following packages:
		<itemizedlist>
			<listitem>
			<para><emphasis>openssl</emphasis> or
				<emphasis>libssl</emphasis> >= 0.9.6
			</para>
			</listitem>
			<listitem>
			<para><emphasis>openssl-dev</emphasis> or
				<emphasis>libssl-dev</emphasis>
			</para>
			</listitem>
		</itemizedlist>
		</para>
		<para>
		&osips; TLS v1.1/1.2 support requires the following packages:
		<itemizedlist>
			<listitem>
			<para><emphasis>openssl</emphasis> or
				<emphasis>libssl</emphasis> >= 1.0.1e
			</para>
			</listitem>
			<listitem>
			<para><emphasis>openssl-dev</emphasis> or
				<emphasis>libssl-dev</emphasis>
			</para>
			</listitem>
		</itemizedlist>
		</para>
	</section>
	</section>

</chapter>
