<!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"/>
<title>Wt: Wt::WSslInfo Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Wt
 <span id="projectnumber">3.2.3</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.7.5.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceWt.html">Wt</a> </li>
<li class="navelem"><a class="el" href="classWt_1_1WSslInfo.html">WSslInfo</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Wt::WSslInfo Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Wt::WSslInfo" -->
<p>Provides SSL information about the current session.
<a href="classWt_1_1WSslInfo.html#details">More...</a></p>
<p><code>#include <Wt/WSslInfo.C></code></p>
<p><a href="classWt_1_1WSslInfo-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4fcc0aece6e8814a5a1ee75bf9244904"></a><!-- doxytag: member="Wt::WSslInfo::clientCertificate" ref="a4fcc0aece6e8814a5a1ee75bf9244904" args="() const " -->
const <a class="el" href="classWt_1_1WSslCertificate.html">WSslCertificate</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSslInfo.html#a4fcc0aece6e8814a5a1ee75bf9244904">clientCertificate</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the certificate used by the client for authentication. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::vector<br class="typebreak"/>
< <a class="el" href="classWt_1_1WSslCertificate.html">WSslCertificate</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSslInfo.html#a29c701432b2eb6fb5b039c893f2e3a66">clientPemCertificateChain</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the certificate chain used for client authentication. <a href="#a29c701432b2eb6fb5b039c893f2e3a66"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classWt_1_1WValidator_1_1Result.html">WValidator::Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classWt_1_1WSslInfo.html#a44b5ba642c71ef217cbf15b08c8b1ddc">clientVerificationResult</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the result of the client certificate verification. <a href="#a44b5ba642c71ef217cbf15b08c8b1ddc"></a><br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Provides SSL information about the current session. </p>
<p>This class provides an interface to the SSL information related to the current session. This class is returned by <a class="el" href="classWt_1_1WEnvironment.html#ade71adff7dba02d1840a00a9bb11c6e7" title="Returns information on the SSL client certificate or 0 if no authentication took place.">WEnvironment::sslInfo()</a>.</p>
<p>Probably the most important use of this class is that it provides access to the client certificate which was presented by the client during an https handshake to authenticate the SSL session. This class collects the information on the verification that was performed by the connector (FCGI, ISAPI, the built-in webserver, ...) and presents it to the application programmer.</p>
<p>The verification and the acceptance of the certificate has to be configured in the web server (built-in httpd, Apache, IIS, ...). When <a class="el" href="classWt_1_1WEnvironment.html#ade71adff7dba02d1840a00a9bb11c6e7" title="Returns information on the SSL client certificate or 0 if no authentication took place.">WEnvironment::sslInfo()</a> returns a <a class="el" href="classWt_1_1WSslInfo.html" title="Provides SSL information about the current session.">WSslInfo</a> object, this means that the client verification has already passed the verification procedures in the webserver. This does not mean that the certificate is valid; depending on the configuration of your web server, this verification may be weak. Always check the verification result with <a class="el" href="classWt_1_1WSslInfo.html#a44b5ba642c71ef217cbf15b08c8b1ddc" title="Returns the result of the client certificate verification.">clientVerificationResult()</a>.</p>
<p>This class is only available when Wt was compiled with SSL support. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a29c701432b2eb6fb5b039c893f2e3a66"></a><!-- doxytag: member="Wt::WSslInfo::clientPemCertificateChain" ref="a29c701432b2eb6fb5b039c893f2e3a66" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector<<a class="el" href="classWt_1_1WSslCertificate.html">WSslCertificate</a>>& Wt::WSslInfo::clientPemCertificateChain </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the certificate chain used for client authentication. </p>
<p>Warning: for the ISAPI connector, the certificate chain will always be empty. </p>
</div>
</div>
<a class="anchor" id="a44b5ba642c71ef217cbf15b08c8b1ddc"></a><!-- doxytag: member="Wt::WSslInfo::clientVerificationResult" ref="a44b5ba642c71ef217cbf15b08c8b1ddc" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classWt_1_1WValidator_1_1Result.html">WValidator::Result</a> Wt::WSslInfo::clientVerificationResult </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the result of the client certificate verification. </p>
<p><a class="el" href="classWt_1_1WSslInfo.html" title="Provides SSL information about the current session.">WSslInfo</a> (and thus <a class="el" href="namespaceWt.html" title="The namespace for Wt.">Wt</a>) by itself does not perform any validation: this task is entirely up to the web server, and this class merely reports the validation status reported by the webserver. </p>
</div>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr size="1"><address style="text-align: right; margin: 3px"><small>
Generated on Thu Nov 1 2012 for <a href="http://www.webtoolkit.eu/wt">the
C++ Web Toolkit (Wt)</a> by <a
href="http://www.doxygen.org/index.html"><img src="doxygen.png"
alt="doxygen" border="0" style="vertical-align: middle; display:
inline-block; height: 2em"></a> 1.7.5.1</small></address>
</body>
</html>
