Package org.oa4mp.server.loader.oauth2.servlet

Class OA2HeaderUtils

java.lang.Object

edu.uiuc.ncsa.security.servlet.HeaderUtils

org.oa4mp.server.loader.oauth2.servlet.OA2HeaderUtils

public class OA2HeaderUtils
extends edu.uiuc.ncsa.security.servlet.HeaderUtils

Utilities for dealing with getting tokens that may be either sent as parameters or in the authorization header . Note that you should check that if a user sends both, that they match and throw an exception if they do not.

Created by Jeff Gaynor
on 9/25/17 at 5:33 PM

Field Summary

Fields inherited from class edu.uiuc.ncsa.security.servlet.HeaderUtils

BASIC_HEADER, BEARER_HEADER, ID_INDEX, SECRET_INDEX

Constructor Summary

Constructors

Constructor	Description
OA2HeaderUtils()

Method Summary

Modifier and Type	Method	Description
static BaseClient	findRFC7523Client(javax.servlet.http.HttpServletRequest request, OA2SE oa2SE, org.kordamp.json.JSONObject json)	Finds the client from the §2.1 JSON RFC7523Constants.CLIENT_ASSERTION-- admin or regular -- and verifies that it is valid, has been approved etc.
static String	getAndCheckStateParameter(org.kordamp.json.JSONObject json, javax.servlet.http.HttpServletRequest request)	We shouldl explicitly exclude JSON objects as State paraemters since the spec. only allows for them as strings.
static BaseClient	getAndVerifyRFC7523Client(javax.servlet.http.HttpServletRequest request, OA2SE oa2SE)	Assumption is that the request has the correct RFC7523Constants.CLIENT_ASSERTION_TYPE of RFC7523Constants.ASSERTION_JWT_BEARER, so we are decoding that.
static BaseClient	getAndVerifyRFC7523Client(javax.servlet.http.HttpServletRequest request, OA2SE oa2SE, boolean isDeviceFlow)	Just carries out verifying RFC 7523 §2.1.
static String	getATFromParameter(javax.servlet.http.HttpServletRequest request)
static edu.uiuc.ncsa.security.core.Identifier	getIDFromParameters(javax.servlet.http.HttpServletRequest request)
static OA2Client	getRFC7523Client(javax.servlet.http.HttpServletRequest request, OA2SE oa2SE)
static void	verifyRFC7523Client(OA2Client client, javax.servlet.http.HttpServletRequest request, OA2SE oa2SE)

Methods inherited from class edu.uiuc.ncsa.security.servlet.HeaderUtils

echoErrorResponse, echoRequest, echoResponse, getAuthHeader, getBasicHeader, getBearerAuthHeader, getCredentialsFromHeaders, getCredentialsFromHeaders, getFirstParameters, getFirstParameterValue, getIDFromHeaders, getParameters, getSecretFromHeaders, hasBasicHeader, hasBearerHeader, headerToJSON, headerToJSON, throwException

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OA2HeaderUtils

public OA2HeaderUtils()

Method Detail

getATFromParameter

public static String getATFromParameter(javax.servlet.http.HttpServletRequest request)

getIDFromParameters

public static edu.uiuc.ncsa.security.core.Identifier getIDFromParameters(javax.servlet.http.HttpServletRequest request)

findRFC7523Client

public static BaseClient findRFC7523Client(javax.servlet.http.HttpServletRequest request,
                                           OA2SE oa2SE,
                                           org.kordamp.json.JSONObject json)
                                    throws NoSuchAlgorithmException,
                                           InvalidKeySpecException

Finds the client from the §2.1 JSON RFC7523Constants.CLIENT_ASSERTION-- admin or regular -- and verifies that it is valid, has been approved etc.

Parameters:

request -

oa2SE -

Returns:

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

getAndVerifyRFC7523Client

public static BaseClient getAndVerifyRFC7523Client(javax.servlet.http.HttpServletRequest request,
                                                   OA2SE oa2SE)
                                            throws NoSuchAlgorithmException,
                                                   InvalidKeySpecException

Assumption is that the request has the correct RFC7523Constants.CLIENT_ASSERTION_TYPE of RFC7523Constants.ASSERTION_JWT_BEARER, so we are decoding that.

Parameters:

request -

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

getAndVerifyRFC7523Client

public static BaseClient getAndVerifyRFC7523Client(javax.servlet.http.HttpServletRequest request,
                                                   OA2SE oa2SE,
                                                   boolean isDeviceFlow)
                                            throws NoSuchAlgorithmException,
                                                   InvalidKeySpecException

Just carries out verifying RFC 7523 §2.1. It returns the authorizing client

Parameters:

request -

oa2SE -

isDeviceFlow -

Returns:

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

getRFC7523Client

public static OA2Client getRFC7523Client(javax.servlet.http.HttpServletRequest request,
                                         OA2SE oa2SE)
                                  throws NoSuchAlgorithmException,
                                         InvalidKeySpecException

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

verifyRFC7523Client

public static void verifyRFC7523Client(OA2Client client,
                                       javax.servlet.http.HttpServletRequest request,
                                       OA2SE oa2SE)
                                throws NoSuchAlgorithmException,
                                       InvalidKeySpecException

Throws:

NoSuchAlgorithmException

InvalidKeySpecException

getAndCheckStateParameter

public static String getAndCheckStateParameter(org.kordamp.json.JSONObject json,
                                               javax.servlet.http.HttpServletRequest request)

We shouldl explicitly exclude JSON objects as State paraemters since the spec. only allows for them as strings. Complex ones can cause mischief and we are not obliged at all to manage them. This will take the JSON object and check that it is not a JSONoject. If it is, an exception will be thrown. Otherwise, it returns the value for it.

Parameters:

json -

request -

Returns: