<!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.8"/> <title>xmltooling: xmltooling::X509TrustEngine Class Reference</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="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </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">xmltooling  <span id="projectnumber">1.5.3</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.8 --> <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="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> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('a00102.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="a00311.html">List of all members</a> </div> <div class="headertitle"> <div class="title">xmltooling::X509TrustEngine Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p><a class="el" href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re...">TrustEngine</a> interface that adds validation of X.509 credentials. <a href="a00102.html#details">More...</a></p> <p><code>#include <xmltooling/security/X509TrustEngine.h></code></p> <div class="dynheader"> Inheritance diagram for xmltooling::X509TrustEngine:</div> <div class="dyncontent"> <div class="center"> <img src="a00102.png" usemap="#xmltooling::X509TrustEngine_map" alt=""/> <map id="xmltooling::X509TrustEngine_map" name="xmltooling::X509TrustEngine_map"> <area href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re..." alt="xmltooling::TrustEngine" shape="rect" coords="112,0,327,24"/> <area href="a00060.html" title="Extended TrustEngine interface that adds validation of X.509 credentials using OpenSSL data types dir..." alt="xmltooling::OpenSSLTrustEngine" shape="rect" coords="112,112,327,136"/> <area href="a00004.html" title="A trust engine that uses X.509 trust anchors and CRLs associated with a peer to perform PKIX validati..." alt="xmltooling::AbstractPKIXTrustEngine" shape="rect" coords="0,168,215,192"/> <area href="a00016.html" title="OpenSSLTrustEngine that uses multiple engines in sequence. " alt="xmltooling::ChainingTrustEngine" shape="rect" coords="225,168,440,192"/> </map> </div></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a8435cfccb28cfe7c24d81deb00033e72"><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a8435cfccb28cfe7c24d81deb00033e72">validate</a> (XSECCryptoX509 *certEE, const std::vector< XSECCryptoX509 * > &certChain, const <a class="el" href="a00026.html">CredentialResolver</a> &credResolver, <a class="el" href="a00025.html">CredentialCriteria</a> *criteria=0) const =0</td></tr> <tr class="memdesc:a8435cfccb28cfe7c24d81deb00033e72"><td class="mdescLeft"> </td><td class="mdescRight">Determines whether an X.509 credential is valid with respect to the source of credentials supplied. <a href="#a8435cfccb28cfe7c24d81deb00033e72">More...</a><br /></td></tr> <tr class="separator:a8435cfccb28cfe7c24d81deb00033e72"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pub_methods_a00090"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_a00090')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="a00090.html">xmltooling::TrustEngine</a></td></tr> <tr class="memitem:af7ffc921deb3e4a1f11b9b3367b6384e inherit pub_methods_a00090"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#af7ffc921deb3e4a1f11b9b3367b6384e">setKeyInfoResolver</a> (<a class="el" href="a00047.html">KeyInfoResolver</a> *keyInfoResolver)</td></tr> <tr class="memdesc:af7ffc921deb3e4a1f11b9b3367b6384e inherit pub_methods_a00090"><td class="mdescLeft"> </td><td class="mdescRight">Supplies a <a class="el" href="a00047.html" title="Resolves credentials from KeyInfo information. ">KeyInfoResolver</a> instance. <a href="#af7ffc921deb3e4a1f11b9b3367b6384e">More...</a><br /></td></tr> <tr class="separator:af7ffc921deb3e4a1f11b9b3367b6384e inherit pub_methods_a00090"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a7d17feb8f75d33a402da3bb92f1d9ecd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00102.html#a7d17feb8f75d33a402da3bb92f1d9ecd">X509TrustEngine</a> (const xercesc::DOMElement *e=0)</td></tr> <tr class="memdesc:a7d17feb8f75d33a402da3bb92f1d9ecd"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a7d17feb8f75d33a402da3bb92f1d9ecd">More...</a><br /></td></tr> <tr class="separator:a7d17feb8f75d33a402da3bb92f1d9ecd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="inherit_header pro_methods_a00090"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_a00090')"><img src="closed.png" alt="-"/> Protected Member Functions inherited from <a class="el" href="a00090.html">xmltooling::TrustEngine</a></td></tr> <tr class="memitem:a05fb4c107b0635caa4e3d57e3f8d6163 inherit pro_methods_a00090"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#a05fb4c107b0635caa4e3d57e3f8d6163">TrustEngine</a> (const xercesc::DOMElement *e=0)</td></tr> <tr class="memdesc:a05fb4c107b0635caa4e3d57e3f8d6163 inherit pro_methods_a00090"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a05fb4c107b0635caa4e3d57e3f8d6163">More...</a><br /></td></tr> <tr class="separator:a05fb4c107b0635caa4e3d57e3f8d6163 inherit pro_methods_a00090"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a> Additional Inherited Members</h2></td></tr> <tr class="inherit_header pro_attribs_a00090"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_a00090')"><img src="closed.png" alt="-"/> Protected Attributes inherited from <a class="el" href="a00090.html">xmltooling::TrustEngine</a></td></tr> <tr class="memitem:af84955e8dfd27a678070ab46902c9ee3 inherit pro_attribs_a00090"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00047.html">KeyInfoResolver</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00090.html#af84955e8dfd27a678070ab46902c9ee3">m_keyInfoResolver</a></td></tr> <tr class="memdesc:af84955e8dfd27a678070ab46902c9ee3 inherit pro_attribs_a00090"><td class="mdescLeft"> </td><td class="mdescRight">Custom <a class="el" href="a00047.html" title="Resolves credentials from KeyInfo information. ">KeyInfoResolver</a> instance. <a href="#af84955e8dfd27a678070ab46902c9ee3">More...</a><br /></td></tr> <tr class="separator:af84955e8dfd27a678070ab46902c9ee3 inherit pro_attribs_a00090"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re...">TrustEngine</a> interface that adds validation of X.509 credentials. </p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="a7d17feb8f75d33a402da3bb92f1d9ecd"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">xmltooling::X509TrustEngine::X509TrustEngine </td> <td>(</td> <td class="paramtype">const xercesc::DOMElement * </td> <td class="paramname"><em>e</em> = <code>0</code></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Constructor. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">e</td><td>DOM to supply configuration for provider </td></tr> </table> </dd> </dl> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="a8435cfccb28cfe7c24d81deb00033e72"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual bool xmltooling::X509TrustEngine::validate </td> <td>(</td> <td class="paramtype">XSECCryptoX509 * </td> <td class="paramname"><em>certEE</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const std::vector< XSECCryptoX509 * > & </td> <td class="paramname"><em>certChain</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="a00026.html">CredentialResolver</a> & </td> <td class="paramname"><em>credResolver</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"><a class="el" href="a00025.html">CredentialCriteria</a> * </td> <td class="paramname"><em>criteria</em> = <code>0</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">pure virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Determines whether an X.509 credential is valid with respect to the source of credentials supplied. </p> <p>It is the responsibility of the application to ensure that the credentials supplied are in fact associated with the peer who presented the credential.</p> <p>If criteria with a peer name are supplied, the "name" of the EE certificate may also be checked to ensure that it identifies the intended peer. The peer name itself or implementation-specific rules based on the content of the peer credentials may be applied. Implementations may omit this check if they deem it unnecessary.</p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">certEE</td><td>end-entity certificate to validate </td></tr> <tr><td class="paramname">certChain</td><td>the complete set of certificates presented for validation (includes certEE) </td></tr> <tr><td class="paramname">credResolver</td><td>a locked resolver to supply trusted peer credentials to the <a class="el" href="a00090.html" title="Evaluates the trustworthiness and validity of security information against implementation-specific re...">TrustEngine</a> </td></tr> <tr><td class="paramname">criteria</td><td>criteria for selecting peer credentials </td></tr> </table> </dd> </dl> <p>Implemented in <a class="el" href="a00004.html#a675fed537f98f48bffe4bc6201fab498">xmltooling::AbstractPKIXTrustEngine</a>, and <a class="el" href="a00016.html#a70d090e043c2bc823f3c751da8a8e4cd">xmltooling::ChainingTrustEngine</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>xmltooling/security/<a class="el" href="a00168.html">X509TrustEngine.h</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="a00206.html">xmltooling</a></li><li class="navelem"><a class="el" href="a00102.html">X509TrustEngine</a></li> <li class="footer">Generated on Fri Oct 17 2014 12:44:58 for xmltooling by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li> </ul> </div> </body> </html>