repo/luan: src/org/eclipse/jetty/server/Authentication.java annotate

author	Franklin Schmidt <fschmidt@gmail.com>
date	Wed, 07 Sep 2016 21:15:48 -0600
parents
children	f8f7cb485c25

rev	line source
802 3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	1 //
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	2 // ========================================================================
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	3 // Copyright (c) 1995-2014 Mort Bay Consulting Pty. Ltd.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	4 // ------------------------------------------------------------------------
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	5 // All rights reserved. This program and the accompanying materials
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	6 // are made available under the terms of the Eclipse Public License v1.0
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	7 // and Apache License v2.0 which accompanies this distribution.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	8 //
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	9 // The Eclipse Public License is available at
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	10 // http://www.eclipse.org/legal/epl-v10.html
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	11 //
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	12 // The Apache License v2.0 is available at
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	13 // http://www.opensource.org/licenses/apache2.0.php
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	14 //
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	15 // You may elect to redistribute this code under either of these licenses.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	16 // ========================================================================
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	17 //
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	18
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	19 package org.eclipse.jetty.server;
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	20
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	21 import javax.servlet.ServletRequest;
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	22 import javax.servlet.ServletResponse;
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	23 import javax.servlet.http.HttpServletRequest;
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	24 import javax.servlet.http.HttpServletResponse;
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	25
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	26
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	27 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	28 /** The Authentication state of a request.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	29 * <p>
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	30 * The Authentication state can be one of several sub-types that
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	31 * reflects where the request is in the many different authentication
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	32 * cycles. Authentication might not yet be checked or it might be checked
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	33 * and failed, checked and deferred or succeeded.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	34 *
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	35 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	36 public interface Authentication
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	37 {
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	38 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	39 /** A successful Authentication with User information.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	40 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	41 public interface User extends Authentication
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	42 {
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	43 String getAuthMethod();
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	44 UserIdentity getUserIdentity();
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	45 boolean isUserInRole(UserIdentity.Scope scope,String role);
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	46 void logout();
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	47 }
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	48
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	49 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	50 /** A wrapped authentication with methods provide the
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	51 * wrapped request/response for use by the application
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	52 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	53 public interface Wrapped extends Authentication
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	54 {
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	55 HttpServletRequest getHttpServletRequest();
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	56 HttpServletResponse getHttpServletResponse();
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	57 }
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	58
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	59 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	60 /** A deferred authentication with methods to progress
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	61 * the authentication process.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	62 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	63 public interface Deferred extends Authentication
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	64 {
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	65 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	66 /** Authenticate if possible without sending a challenge.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	67 * This is used to check credentials that have been sent for
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	68 * non-manditory authentication.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	69 * @return The new Authentication state.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	70 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	71 Authentication authenticate(ServletRequest request);
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	72
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	73 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	74 /** Authenticate and possibly send a challenge.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	75 * This is used to initiate authentication for previously
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	76 * non-manditory authentication.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	77 * @return The new Authentication state.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	78 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	79 Authentication authenticate(ServletRequest request,ServletResponse response);
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	80
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	81
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	82 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	83 /** Login with the LOGIN authenticator
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	84 * @param username
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	85 * @param password
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	86 * @return The new Authentication state
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	87 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	88 Authentication login(String username,Object password,ServletRequest request);
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	89 }
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	90
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	91
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	92 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	93 /** Authentication Response sent state.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	94 * Responses are sent by authenticators either to issue an
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	95 * authentication challenge or on successful authentication in
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	96 * order to redirect the user to the original URL.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	97 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	98 public interface ResponseSent extends Authentication
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	99 {
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	100 }
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	101
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	102 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	103 /** An Authentication Challenge has been sent.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	104 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	105 public interface Challenge extends ResponseSent
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	106 {
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	107 }
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	108
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	109 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	110 /** An Authentication Failure has been sent.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	111 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	112 public interface Failure extends ResponseSent
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	113 {
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	114 }
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	115
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	116 public interface SendSuccess extends ResponseSent
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	117 {
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	118 }
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	119
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	120 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	121 /** Unauthenticated state.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	122 * <p>
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	123 * This convenience instance is for non mandatory authentication where credentials
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	124 * have been presented and checked, but failed authentication.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	125 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	126 public final static Authentication UNAUTHENTICATED = new Authentication(){@Override
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	127 public String toString(){return "UNAUTHENTICATED";}};
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	128
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	129 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	130 /** Authentication not checked
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	131 * <p>
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	132 * This convenience instance us for non mandatory authentication when no
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	133 * credentials are present to be checked.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	134 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	135 public final static Authentication NOT_CHECKED = new Authentication(){@Override
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	136 public String toString(){return "NOT CHECKED";}};
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	137
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	138 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	139 /** Authentication challenge sent.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	140 * <p>
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	141 * This convenience instance is for when an authentication challenge has been sent.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	142 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	143 public final static Authentication SEND_CONTINUE = new Authentication.Challenge(){@Override
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	144 public String toString(){return "CHALLENGE";}};
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	145
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	146 /* ------------------------------------------------------------ */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	147 /** Authentication failure sent.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	148 * <p>
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	149 * This convenience instance is for when an authentication failure has been sent.
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	150 */
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	151 public final static Authentication SEND_FAILURE = new Authentication.Failure(){@Override
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	152 public String toString(){return "FAILURE";}};
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	153 public final static Authentication SEND_SUCCESS = new SendSuccess(){@Override
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	154 public String toString(){return "SEND_SUCCESS";}};
3428c60d7cfc replace jetty jars with source Franklin Schmidt <fschmidt@gmail.com> parents: diff changeset	155 }

802

3428c60d7cfc replace jetty jars with source