| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (11.0.14.1) on Mon Apr 04 09:09:38 CDT 2022 --> |
| <title>SslClientCertAuthenticator (Eclipse Jetty API Doc - v10.0.9)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="dc.created" content="2022-04-04"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="SslClientCertAuthenticator (Eclipse Jetty API Doc - v10.0.9)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SslClientCertAuthenticator.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> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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 id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">org.eclipse.jetty.security.authentication</a></div> |
| <h2 title="Class SslClientCertAuthenticator" class="title">Class SslClientCertAuthenticator</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">org.eclipse.jetty.security.authentication.LoginAuthenticator</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.eclipse.jetty.security.authentication.SslClientCertAuthenticator</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public class <span class="typeNameLabel">SslClientCertAuthenticator</span> |
| extends <a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></pre> |
| <div class="block">CLIENT-CERT authenticator. |
| |
| <p>This <a href="../Authenticator.html" title="interface in org.eclipse.jetty.security"><code>Authenticator</code></a> implements client certificate authentication. |
| The client certificates available in the request will be verified against the configured <a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl"><code>SslContextFactory</code></a> instance |
| </p></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="nested.classes.inherited.from.class.org.eclipse.jetty.security.Authenticator"> |
| <!-- --> |
| </a> |
| <h3>Nested classes/interfaces inherited from interface org.eclipse.jetty.security.<a href="../Authenticator.html" title="interface in org.eclipse.jetty.security">Authenticator</a></h3> |
| <code><a href="../Authenticator.AuthConfiguration.html" title="interface in org.eclipse.jetty.security">Authenticator.AuthConfiguration</a>, <a href="../Authenticator.Factory.html" title="interface in org.eclipse.jetty.security">Authenticator.Factory</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <ul class="blockList"> |
| <li class="blockList"><a id="fields.inherited.from.class.org.eclipse.jetty.security.authentication.LoginAuthenticator"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.eclipse.jetty.security.authentication.<a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></h3> |
| <code><a href="LoginAuthenticator.html#_identityService">_identityService</a>, <a href="LoginAuthenticator.html#_loginService">_loginService</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Constructor</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr class="altColor"> |
| <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E(org.eclipse.jetty.util.ssl.SslContextFactory)">SslClientCertAuthenticator</a></span>​(<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </section> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>java.lang.String</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAuthMethod()">getAuthMethod</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isValidateCerts()">isValidateCerts</a></span>()</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#secureResponse(javax.servlet.ServletRequest,javax.servlet.ServletResponse,boolean,org.eclipse.jetty.server.Authentication.User)">secureResponse</a></span>​(javax.servlet.ServletRequest req, |
| javax.servlet.ServletResponse res, |
| boolean mandatory, |
| <a href="../../server/Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a> validatedUser)</code></th> |
| <td class="colLast"> |
| <div class="block">is response secure</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setValidateCerts(boolean)">setValidateCerts</a></span>​(boolean validateCerts)</code></th> |
| <td class="colLast"> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="../../server/Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#validateRequest(javax.servlet.ServletRequest,javax.servlet.ServletResponse,boolean)">validateRequest</a></span>​(javax.servlet.ServletRequest req, |
| javax.servlet.ServletResponse res, |
| boolean mandatory)</code></th> |
| <td class="colLast"> |
| <div class="block">Validate a request</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.org.eclipse.jetty.security.authentication.LoginAuthenticator"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.eclipse.jetty.security.authentication.<a href="LoginAuthenticator.html" title="class in org.eclipse.jetty.security.authentication">LoginAuthenticator</a></h3> |
| <code><a href="LoginAuthenticator.html#getLoginService()">getLoginService</a>, <a href="LoginAuthenticator.html#login(java.lang.String,java.lang.Object,javax.servlet.ServletRequest)">login</a>, <a href="LoginAuthenticator.html#logout(javax.servlet.ServletRequest)">logout</a>, <a href="LoginAuthenticator.html#prepareRequest(javax.servlet.ServletRequest)">prepareRequest</a>, <a href="LoginAuthenticator.html#renewSession(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)">renewSession</a>, <a href="LoginAuthenticator.html#setConfiguration(org.eclipse.jetty.security.Authenticator.AuthConfiguration)">setConfiguration</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a id="<init>(org.eclipse.jetty.util.ssl.SslContextFactory)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SslClientCertAuthenticator</h4> |
| <pre>public SslClientCertAuthenticator​(<a href="../../util/ssl/SslContextFactory.html" title="class in org.eclipse.jetty.util.ssl">SslContextFactory</a> sslContextFactory)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="getAuthMethod()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAuthMethod</h4> |
| <pre class="methodSignature">public java.lang.String getAuthMethod()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The name of the authentication method</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="validateRequest(javax.servlet.ServletRequest,javax.servlet.ServletResponse,boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>validateRequest</h4> |
| <pre class="methodSignature">public <a href="../../server/Authentication.html" title="interface in org.eclipse.jetty.server">Authentication</a> validateRequest​(javax.servlet.ServletRequest req, |
| javax.servlet.ServletResponse res, |
| boolean mandatory) |
| throws <a href="../ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Authenticator.html#validateRequest(javax.servlet.ServletRequest,javax.servlet.ServletResponse,boolean)">Authenticator</a></code></span></div> |
| <div class="block">Validate a request</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - The request</dd> |
| <dd><code>res</code> - The response</dd> |
| <dd><code>mandatory</code> - True if authentication is mandatory.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>An Authentication. If Authentication is successful, this will be a <a href="../../server/Authentication.User.html" title="interface in org.eclipse.jetty.server"><code>Authentication.User</code></a>. If a response has |
| been sent by the Authenticator (which can be done for both successful and unsuccessful authentications), then the result will |
| implement <a href="../../server/Authentication.ResponseSent.html" title="interface in org.eclipse.jetty.server"><code>Authentication.ResponseSent</code></a>. If Authentication is not mandatory, then a |
| <a href="../../server/Authentication.Deferred.html" title="interface in org.eclipse.jetty.server"><code>Authentication.Deferred</code></a> may be returned.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></code> - if unable to validate request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="secureResponse(javax.servlet.ServletRequest,javax.servlet.ServletResponse,boolean,org.eclipse.jetty.server.Authentication.User)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>secureResponse</h4> |
| <pre class="methodSignature">public boolean secureResponse​(javax.servlet.ServletRequest req, |
| javax.servlet.ServletResponse res, |
| boolean mandatory, |
| <a href="../../server/Authentication.User.html" title="interface in org.eclipse.jetty.server">Authentication.User</a> validatedUser) |
| throws <a href="../ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../Authenticator.html#secureResponse(javax.servlet.ServletRequest,javax.servlet.ServletResponse,boolean,org.eclipse.jetty.server.Authentication.User)">Authenticator</a></code></span></div> |
| <div class="block">is response secure</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>req</code> - the request</dd> |
| <dd><code>res</code> - the response</dd> |
| <dd><code>mandatory</code> - if security is mandator</dd> |
| <dd><code>validatedUser</code> - the user that was validated</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if response is secure</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../ServerAuthException.html" title="class in org.eclipse.jetty.security">ServerAuthException</a></code> - if unable to test response</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="isValidateCerts()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isValidateCerts</h4> |
| <pre class="methodSignature">public boolean isValidateCerts()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>true if SSL certificate has to be validated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setValidateCerts(boolean)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setValidateCerts</h4> |
| <pre class="methodSignature">public void setValidateCerts​(boolean validateCerts)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>validateCerts</code> - true if SSL certificates have to be validated.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/SslClientCertAuthenticator.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> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li><a href="#field.summary">Field</a> | </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 id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Copyright © 1995–2022 <a href="https://webtide.com">Webtide</a>. All rights reserved.</small></p> |
| </footer> |
| </body> |
| </html> |
