| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>AbstractSamlPolicyValidator (Apache CXF JavaDoc 3.1.0 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="AbstractSamlPolicyValidator (Apache CXF JavaDoc 3.1.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractSamlPolicyValidator.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractBindingPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSecurityPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSamlPolicyValidator.html" target="_top">Frames</a></li> |
| <li><a href="AbstractSamlPolicyValidator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.cxf.ws.security.wss4j.policyvalidators</div> |
| <h2 title="Class AbstractSamlPolicyValidator" class="title">Class AbstractSamlPolicyValidator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSecurityPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators">org.apache.cxf.ws.security.wss4j.policyvalidators.AbstractSecurityPolicyValidator</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.cxf.ws.security.wss4j.policyvalidators.AbstractSamlPolicyValidator</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/SecurityPolicyValidator.html" title="interface in org.apache.cxf.ws.security.wss4j.policyvalidators">SecurityPolicyValidator</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/IssuedTokenPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators">IssuedTokenPolicyValidator</a>, <a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/SamlTokenPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators">SamlTokenPolicyValidator</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">AbstractSamlPolicyValidator</span> |
| extends <a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSecurityPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators">AbstractSecurityPolicyValidator</a></pre> |
| <div class="block">Some abstract functionality for validating SAML Assertions</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSamlPolicyValidator.html#AbstractSamlPolicyValidator()">AbstractSamlPolicyValidator</a></strong>()</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSamlPolicyValidator.html#checkHolderOfKey(org.apache.wss4j.common.saml.SamlAssertionWrapper,%20java.util.List,%20java.security.cert.Certificate[])">checkHolderOfKey</a></strong>(org.apache.wss4j.common.saml.SamlAssertionWrapper assertionWrapper, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.wss4j.dom.WSSecurityEngineResult> signedResults, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/security/cert/Certificate.html?is-external=true" title="class or interface in java.security.cert">Certificate</a>[] tlsCerts)</code> |
| <div class="block">Check the holder-of-key requirements against the received assertion.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSamlPolicyValidator.html#compareCredentials(org.apache.wss4j.common.saml.SAMLKeyInfo,%20java.util.List,%20java.security.cert.Certificate[])">compareCredentials</a></strong>(org.apache.wss4j.common.saml.SAMLKeyInfo subjectKeyInfo, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.wss4j.dom.WSSecurityEngineResult> signedResults, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/security/cert/Certificate.html?is-external=true" title="class or interface in java.security.cert">Certificate</a>[] tlsCerts)</code> |
| <div class="block">Compare the credentials of the assertion to the credentials used in 2-way TLS or those |
| used to verify signatures.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cxf.ws.security.wss4j.policyvalidators.AbstractSecurityPolicyValidator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.cxf.ws.security.wss4j.policyvalidators.<a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSecurityPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators">AbstractSecurityPolicyValidator</a></h3> |
| <code><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSecurityPolicyValidator.html#isTokenRequired(org.apache.wss4j.policy.model.AbstractToken,%20org.apache.cxf.message.Message)">isTokenRequired</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.cxf.ws.security.wss4j.policyvalidators.SecurityPolicyValidator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.cxf.ws.security.wss4j.policyvalidators.<a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/SecurityPolicyValidator.html" title="interface in org.apache.cxf.ws.security.wss4j.policyvalidators">SecurityPolicyValidator</a></h3> |
| <code><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/SecurityPolicyValidator.html#canValidatePolicy(org.apache.cxf.ws.policy.AssertionInfo)">canValidatePolicy</a>, <a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/SecurityPolicyValidator.html#validatePolicies(org.apache.cxf.ws.security.wss4j.policyvalidators.PolicyValidatorParameters,%20java.util.Collection)">validatePolicies</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="AbstractSamlPolicyValidator()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>AbstractSamlPolicyValidator</h4> |
| <pre>public AbstractSamlPolicyValidator()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="checkHolderOfKey(org.apache.wss4j.common.saml.SamlAssertionWrapper, java.util.List, java.security.cert.Certificate[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>checkHolderOfKey</h4> |
| <pre>public boolean checkHolderOfKey(org.apache.wss4j.common.saml.SamlAssertionWrapper assertionWrapper, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.wss4j.dom.WSSecurityEngineResult> signedResults, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/security/cert/Certificate.html?is-external=true" title="class or interface in java.security.cert">Certificate</a>[] tlsCerts)</pre> |
| <div class="block">Check the holder-of-key requirements against the received assertion. The subject |
| credential of the SAML Assertion must have been used to sign some portion of |
| the message, thus showing proof-of-possession of the private/secret key. Alternatively, |
| the subject credential of the SAML Assertion must match a client certificate credential |
| when 2-way TLS is used.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>assertionWrapper</code> - the SAML Assertion wrapper object</dd><dd><code>signedResults</code> - a list of all of the signed results</dd></dl> |
| </li> |
| </ul> |
| <a name="compareCredentials(org.apache.wss4j.common.saml.SAMLKeyInfo, java.util.List, java.security.cert.Certificate[])"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>compareCredentials</h4> |
| <pre>protected boolean compareCredentials(org.apache.wss4j.common.saml.SAMLKeyInfo subjectKeyInfo, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><org.apache.wss4j.dom.WSSecurityEngineResult> signedResults, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/security/cert/Certificate.html?is-external=true" title="class or interface in java.security.cert">Certificate</a>[] tlsCerts)</pre> |
| <div class="block">Compare the credentials of the assertion to the credentials used in 2-way TLS or those |
| used to verify signatures. |
| Return true on a match</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>subjectKeyInfo</code> - the SAMLKeyInfo object</dd><dd><code>signedResults</code> - a list of all of the signed results</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>true if the credentials of the assertion were used to verify a signature</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/AbstractSamlPolicyValidator.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em>Apache CXF API</em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractBindingPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../../../org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSecurityPolicyValidator.html" title="class in org.apache.cxf.ws.security.wss4j.policyvalidators"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../../../index.html?org/apache/cxf/ws/security/wss4j/policyvalidators/AbstractSamlPolicyValidator.html" target="_top">Frames</a></li> |
| <li><a href="AbstractSamlPolicyValidator.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Apache CXF</small></p> |
| </body> |
| </html> |