<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>PolarSSL v1.3.8: SSL/TLS communication module</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">SSL/TLS communication module</div> </div>
</div><!--header-->
<div class="contents">
<p>The SSL/TLS communication module provides the means to create an SSL/TLS communication channel.
<a href="#details">More...</a></p>
<p>The SSL/TLS communication module provides the means to create an SSL/TLS communication channel. </p>
<p>The basic provisions are:</p>
<ul>
<li>initialise an SSL/TLS context (see <code><a class="el" href="ssl_8h.html#add102a477ee9b9d9cda8fb1b86313d2e" title="Initialize an SSL context (An individual SSL context is not thread-safe) ">ssl_init()</a></code>).</li>
<li>perform an SSL/TLS handshake (see <code><a class="el" href="ssl_8h.html#ac16d7f3ed66ca2d497b47b0e68d58f20" title="Perform the SSL handshake. ">ssl_handshake()</a></code>).</li>
<li>read/write (see <code><a class="el" href="ssl_8h.html#ae44745097ca1b6af8193468836873280" title="Read at most 'len' application data bytes. ">ssl_read()</a></code> and <code><a class="el" href="ssl_8h.html#aabe30130f0baea4521515e382367ba7b" title="Write exactly 'len' application data bytes. ">ssl_write()</a></code>).</li>
<li>notify a peer that connection is being closed (see <code><a class="el" href="ssl_8h.html#ab9d44e2a86b85dea525b43ae31269bf7" title="Notify the peer that the connection is being closed. ">ssl_close_notify()</a></code>).</li>
</ul>
<p>Many aspects of such a channel are set through parameters and callback functions:</p>
<ul>
<li>the endpoint role: client or server.</li>
<li>the authentication mode. Should verification take place.</li>
<li>the Host-to-host communication channel. A TCP/IP module is provided.</li>
<li>the random number generator (RNG).</li>
<li>the ciphers to use for encryption/decryption.</li>
<li>session control functions.</li>
<li>X.509 parameters for certificate-handling and key exchange.</li>
</ul>
<p>This module can be used to create an SSL/TLS server and client and to provide a basic framework to setup and communicate through an SSL/TLS communication channel.<br/>
Note that you need to provide for several aspects yourself as mentioned above. </p>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:56 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
