Package org.gcube.oidc.rest

Class OpenIdConnectRESTHelper

java.lang.Object

org.gcube.oidc.rest.OpenIdConnectRESTHelper

public class OpenIdConnectRESTHelper
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
OpenIdConnectRESTHelper()

Method Summary

Modifier and Type	Method	Description
static String	buildLoginRequestURL(URL loginURL, String clientId, String state, String redirectURI)
protected static String	getClientIdFromToken(JWTToken token)
static byte[]	getUserAvatar(URL avatarURL, String authorization)
static byte[]	getUserAvatar(URL avatarURL, JWTToken token)
static boolean	isAccessDeniedNotAuthorizedError(String jsonString)
static boolean	isInvalidBearerTokenError(String jsonString)
static boolean	isTokenNotActiveError(String jsonString)
static boolean	logout(URL logoutUrl, String clientId, JWTToken token)	Performs the logout from the session related to the provided client id in the OIDC server.
static boolean	logout(URL logoutUrl, JWTToken token)	Performs the logout (SSOut) from all the sessions opened in the OIDC server.
static String	mapToQueryString(Map<String,List<String>> params)
protected static boolean	matchesErrorAndDescription(String jsonString, String expectedError, String exepectedErrorDescription)
protected static JWTToken	performQueryTokenWithPOST(URL tokenURL, String authorization, Map<String,List<String>> params)
protected static JWTToken	performQueryTokenWithPOST(URL tokenURL, String authorization, Map<String,List<String>> params, Map<String,String> headers)
protected static HttpURLConnection	performURLEncodedPOSTSendData(URL url, Map<String,List<String>> params, String authorization)
protected static HttpURLConnection	performURLEncodedPOSTSendData(URL url, Map<String,List<String>> params, String authorization, Map<String,String> headers)
static JWTToken	queryClientToken(String clientId, String clientSecret, URL tokenURL)	Queries from the OIDC server an OIDC access token, by using provided clientId and client secret.
static JWTToken	queryExchangeToken(URL tokenUrl, String authorization, String audience, String client_id, String client_secret, List<String> permissions)	Queries from the OIDC server an exchanged token by using provided access token, for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.
static JWTToken	queryToken(String clientId, URL tokenURL, String code, String scope, String redirectURI)
static JWTToken	queryUMAToken(URL tokenUrl, String clientId, String clientSecret, String audience, List<String> permissions)	Queries from the OIDC server an UMA token, by using provided clientId and client secret for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.
static JWTToken	queryUMAToken(URL tokenUrl, String authorization, String audience, List<String> permissions)	Queries from the OIDC server an UMA token, by using provided access token, for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.
static JWTToken	refreshToken(URL tokenURL, String clientId, String clientSecret, JWTToken token)	Refreshes the token from the OIDC server for a specific client represented by the client id.
static JWTToken	refreshToken(URL tokenURL, String clientId, JWTToken token)	Refreshes the token from the OIDC server for a specific client represented by the client id.
static JWTToken	refreshToken(URL tokenURL, JWTToken token)	Refreshes the token from the OIDC server.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Constructor Detail

OpenIdConnectRESTHelper

public OpenIdConnectRESTHelper()

Method Detail

buildLoginRequestURL

public static String buildLoginRequestURL(URL loginURL,
                                          String clientId,
                                          String state,
                                          String redirectURI)
                                   throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

mapToQueryString

public static String mapToQueryString(Map<String,List<String>> params)

queryClientToken

public static JWTToken queryClientToken(String clientId,
                                        String clientSecret,
                                        URL tokenURL)
                                 throws OpenIdConnectRESTHelperException

Queries from the OIDC server an OIDC access token, by using provided clientId and client secret.

Parameters:

clientId - the client id

clientSecret - the client secret

tokenUrl - the token endpoint URL of the OIDC server

Returns:

the issued token

Throws:

OpenIdConnectRESTHelperException - if an error occurs (also an unauthorized call), inspect the exception for details

queryToken

public static JWTToken queryToken(String clientId,
                                  URL tokenURL,
                                  String code,
                                  String scope,
                                  String redirectURI)
                           throws Exception

Throws:

Exception

performQueryTokenWithPOST

protected static JWTToken performQueryTokenWithPOST(URL tokenURL,
                                                    String authorization,
                                                    Map<String,List<String>> params)
                                             throws OpenIdConnectRESTHelperException

Throws:

OpenIdConnectRESTHelperException

performQueryTokenWithPOST

protected static JWTToken performQueryTokenWithPOST(URL tokenURL,
                                                    String authorization,
                                                    Map<String,List<String>> params,
                                                    Map<String,String> headers)
                                             throws OpenIdConnectRESTHelperException

Throws:

OpenIdConnectRESTHelperException

performURLEncodedPOSTSendData

protected static HttpURLConnection performURLEncodedPOSTSendData(URL url,
                                                                 Map<String,List<String>> params,
                                                                 String authorization)
                                                          throws IOException,
                                                                 ProtocolException,
                                                                 UnsupportedEncodingException

Throws:

IOException

ProtocolException

UnsupportedEncodingException

performURLEncodedPOSTSendData

protected static HttpURLConnection performURLEncodedPOSTSendData(URL url,
                                                                 Map<String,List<String>> params,
                                                                 String authorization,
                                                                 Map<String,String> headers)
                                                          throws IOException,
                                                                 ProtocolException,
                                                                 UnsupportedEncodingException

Throws:

IOException

ProtocolException

UnsupportedEncodingException

queryUMAToken

public static JWTToken queryUMAToken(URL tokenUrl,
                                     String clientId,
                                     String clientSecret,
                                     String audience,
                                     List<String> permissions)
                              throws OpenIdConnectRESTHelperException

Queries from the OIDC server an UMA token, by using provided clientId and client secret for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

clientId - the client id

clientSecret - the client secret

audience - the audience (context) where to request the issuing of the ticket

permissions - a list of permissions, can be null

Returns:

the issued token

Throws:

OpenIdConnectRESTHelperException - if an error occurs (also an unauthorized call), inspect the exception for details

queryExchangeToken

public static JWTToken queryExchangeToken(URL tokenUrl,
                                          String authorization,
                                          String audience,
                                          String client_id,
                                          String client_secret,
                                          List<String> permissions)
                                   throws OpenIdConnectRESTHelperException

Queries from the OIDC server an exchanged token by using provided access token, for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

authorization - the auth token (the access token URLEncoded by the "Bearer " string)

audience - the audience (context) where to request the issuing of the ticket (URLEncoded)

permissions - a list of permissions, can be null

Returns:

the issued token

Throws:

OpenIdConnectRESTHelperException - if an error occurs (also an unauthorized call), inspect the exception for details

queryUMAToken

public static JWTToken queryUMAToken(URL tokenUrl,
                                     String authorization,
                                     String audience,
                                     List<String> permissions)
                              throws OpenIdConnectRESTHelperException

Queries from the OIDC server an UMA token, by using provided access token, for the given audience (context), in URLEncoded form or not, and optionally a list of permissions.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

authorization - the auth token (the access token URLEncoded by the "Bearer " string)

audience - the audience (context) where to request the issuing of the ticket (URLEncoded)

permissions - a list of permissions, can be null

Returns:

the issued token

Throws:

OpenIdConnectRESTHelperException - if an error occurs (also an unauthorized call), inspect the exception for details

refreshToken

public static JWTToken refreshToken(URL tokenURL,
                                    JWTToken token)
                             throws OpenIdConnectRESTHelperException

Refreshes the token from the OIDC server.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

token - the token to be refreshed

Returns:

a new token refreshed from the previous one

Throws:

OpenIdConnectRESTHelperException - if an error occurs (also an unauthorized call), inspect the exception for details

refreshToken

public static JWTToken refreshToken(URL tokenURL,
                                    String clientId,
                                    JWTToken token)
                             throws OpenIdConnectRESTHelperException

Refreshes the token from the OIDC server for a specific client represented by the client id.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

clientId - the client id

token - the token to be refreshed

Returns:

a new token refreshed from the previous one

Throws:

OpenIdConnectRESTHelperException - if an error occurs (also an unauthorized call), inspect the exception for details

refreshToken

public static JWTToken refreshToken(URL tokenURL,
                                    String clientId,
                                    String clientSecret,
                                    JWTToken token)
                             throws OpenIdConnectRESTHelperException

Refreshes the token from the OIDC server for a specific client represented by the client id.

Parameters:

tokenUrl - the token endpoint URL of the OIDC server

clientId - the client id

clientSecret - the client secret

token - the token to be refreshed

Returns:

a new token refreshed from the previous one

Throws:

OpenIdConnectRESTHelperException - if an error occurs (also an unauthorized call), inspect the exception for details

getClientIdFromToken

protected static String getClientIdFromToken(JWTToken token)

logout

public static boolean logout(URL logoutUrl,
                             JWTToken token)
                      throws IOException

Performs the logout (SSOut) from all the sessions opened in the OIDC server.

Parameters:

logoutUrl - the logut endpoint URL of the OIDC server

token - the token used to take info from

Returns:

true if the logout is performed correctly, false otherwise

Throws:

IOException - if an I/O error occurs during the communication with the server

logout

public static boolean logout(URL logoutUrl,
                             String clientId,
                             JWTToken token)
                      throws IOException

Performs the logout from the session related to the provided client id in the OIDC server.

Parameters:

logoutUrl - the logut endpoint URL of the OIDC server

clientId - the client id

token - the token used to take info from

Returns:

true if the logout is performed correctly, false otherwise

Throws:

IOException - if an I/O error occurs during the communication with the server

getUserAvatar

public static byte[] getUserAvatar(URL avatarURL,
                                   JWTToken token)

getUserAvatar

public static byte[] getUserAvatar(URL avatarURL,
                                   String authorization)

matchesErrorAndDescription

protected static boolean matchesErrorAndDescription(String jsonString,
                                                    String expectedError,
                                                    String exepectedErrorDescription)

isTokenNotActiveError

public static boolean isTokenNotActiveError(String jsonString)

isInvalidBearerTokenError

public static boolean isInvalidBearerTokenError(String jsonString)

isAccessDeniedNotAuthorizedError

public static boolean isAccessDeniedNotAuthorizedError(String jsonString)