Package org.apache.cxf.rs.security.oauth2.utils

Class OAuthUtils

java.lang.Object

org.apache.cxf.rs.security.oauth2.utils.OAuthUtils

public final class OAuthUtils
extends Object

Various utility methods

Method Summary

Modifier and Type	Method	Description
static boolean	checkRequestURI(String servletPath, String uri)
static boolean	compareCertificateThumbprints(X509Certificate cert, String encodedThumbprint)
static boolean	compareTlsCertificates(TLSSessionInfo tlsInfo, List<String> base64EncodedCerts)
static String	convertListOfScopesToString(List<String> registeredScopes)
static String	convertPermissionsToScope(List<OAuthPermission> perms)
static List<String>	convertPermissionsToScopeList(List<OAuthPermission> perms)
static byte[]	createCertificateThumbprint(X509Certificate cert)
static UserSubject	createSubject(MessageContext mc, SecurityContext sc)
static UserSubject	createSubject(SecurityContext securityContext)
static String	generateRandomTokenKey()
static String	generateRandomTokenKey(int byteSize)
static JweDecryptionProvider	getClientSecretDecryptionProvider(String clientSecret)
static JweEncryptionProvider	getClientSecretEncryptionProvider(String clientSecret)
static SignatureAlgorithm	getClientSecretSignatureAlgorithm(Properties sigProps)
static JwsSignatureProvider	getClientSecretSignatureProvider(String clientSecret)
static JwsSignatureVerifier	getClientSecretSignatureVerifier(String clientSecret)
static long	getIssuedAt()
static String	getIssuerDnFromTLSCertificates(X509Certificate cert)
static List<String>	getRequestedScopes(Client client, String scopeParameter, boolean useAllClientScopes, boolean partialMatchScopeValidation)
static List<String>	getRequestedScopes(Client client, String scopeParameter, boolean useAllClientScopes, boolean partialMatchScopeValidation, boolean defaultToRegisteredScopes)
static X509Certificate	getRootTLSCertificate(TLSSessionInfo tlsInfo)
static String	getSessionToken(MessageContext mc)
static String	getSessionToken(MessageContext mc, String attribute)
static String	getSessionToken(MessageContext mc, String attribute, boolean remove)
static String	getSubjectDnFromTLSCertificates(X509Certificate cert)
static void	injectContextIntoOAuthProvider(MessageContext context, Object provider)
static boolean	isExpired(Long issuedAt, Long lifetime)
static boolean	isGrantSupportedForClient(Client client, boolean canSupportPublicClients, String grantType)
static boolean	isMutualTls(jakarta.ws.rs.core.SecurityContext sc, TLSSessionInfo tlsSessionInfo)
static List<String>	parseScope(String requestedScope)
static void	setCertificateThumbprintConfirmation(MessageContext mc, X509Certificate cert)
static String	setSessionToken(MessageContext mc)
static String	setSessionToken(MessageContext mc, int maxInactiveInterval)
static String	setSessionToken(MessageContext mc, String sessionToken)
static String	setSessionToken(MessageContext mc, String sessionToken, int maxInactiveInterval)
static String	setSessionToken(MessageContext mc, String sessionToken, String attribute, int maxInactiveInterval)
static ClientAccessToken	toClientAccessToken(ServerAccessToken serverToken, boolean supportOptionalParams)
static boolean	validateAudience(String providedAudience, List<String> allowedAudiences)
static boolean	validateAudiences(List<String> providedAudiences, List<String> allowedAudiences)
static boolean	validateScopes(List<String> requestScopes, List<String> registeredScopes, boolean partialMatchScopeValidation)

Methods inherited from class java.lang.Object

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

Method Details

createCertificateThumbprint

public static byte[] createCertificateThumbprint(X509Certificate cert)
                                          throws Exception

Throws:

Exception

setCertificateThumbprintConfirmation

public static void setCertificateThumbprintConfirmation(MessageContext mc,
 X509Certificate cert)

compareCertificateThumbprints

public static boolean compareCertificateThumbprints(X509Certificate cert,
 String encodedThumbprint)

compareTlsCertificates

public static boolean compareTlsCertificates(TLSSessionInfo tlsInfo,
 List<String> base64EncodedCerts)

isMutualTls

public static boolean isMutualTls(jakarta.ws.rs.core.SecurityContext sc,
 TLSSessionInfo tlsSessionInfo)

getSubjectDnFromTLSCertificates

public static String getSubjectDnFromTLSCertificates(X509Certificate cert)

getIssuerDnFromTLSCertificates

public static String getIssuerDnFromTLSCertificates(X509Certificate cert)

getRootTLSCertificate

public static X509Certificate getRootTLSCertificate(TLSSessionInfo tlsInfo)

injectContextIntoOAuthProvider

public static void injectContextIntoOAuthProvider(MessageContext context,
 Object provider)

setSessionToken

public static String setSessionToken(MessageContext mc)

setSessionToken

public static String setSessionToken(MessageContext mc,
 int maxInactiveInterval)

setSessionToken

public static String setSessionToken(MessageContext mc,
 String sessionToken)

setSessionToken

public static String setSessionToken(MessageContext mc,
 String sessionToken,
 int maxInactiveInterval)

setSessionToken

public static String setSessionToken(MessageContext mc,
 String sessionToken,
 String attribute,
 int maxInactiveInterval)

getSessionToken

public static String getSessionToken(MessageContext mc)

getSessionToken

public static String getSessionToken(MessageContext mc,
 String attribute)

getSessionToken

public static String getSessionToken(MessageContext mc,
 String attribute,
 boolean remove)

createSubject

public static UserSubject createSubject(MessageContext mc,
 SecurityContext sc)

createSubject

public static UserSubject createSubject(SecurityContext securityContext)

convertPermissionsToScope

public static String convertPermissionsToScope(List<OAuthPermission> perms)

convertPermissionsToScopeList

public static List<String> convertPermissionsToScopeList(List<OAuthPermission> perms)

isGrantSupportedForClient

public static boolean isGrantSupportedForClient(Client client,
 boolean canSupportPublicClients,
 String grantType)

parseScope

public static List<String> parseScope(String requestedScope)

generateRandomTokenKey

public static String generateRandomTokenKey()
                                     throws OAuthServiceException

Throws:

OAuthServiceException

generateRandomTokenKey

public static String generateRandomTokenKey(int byteSize)

getIssuedAt

public static long getIssuedAt()

isExpired

public static boolean isExpired(Long issuedAt,
 Long lifetime)

validateAudience

public static boolean validateAudience(String providedAudience,
 List<String> allowedAudiences)

validateAudiences

public static boolean validateAudiences(List<String> providedAudiences,
 List<String> allowedAudiences)

checkRequestURI

public static boolean checkRequestURI(String servletPath,
 String uri)

getRequestedScopes

public static List<String> getRequestedScopes(Client client,
 String scopeParameter,
 boolean useAllClientScopes,
 boolean partialMatchScopeValidation)

getRequestedScopes

public static List<String> getRequestedScopes(Client client,
 String scopeParameter,
 boolean useAllClientScopes,
 boolean partialMatchScopeValidation,
 boolean defaultToRegisteredScopes)

validateScopes

public static boolean validateScopes(List<String> requestScopes,
 List<String> registeredScopes,
 boolean partialMatchScopeValidation)

toClientAccessToken

public static ClientAccessToken toClientAccessToken(ServerAccessToken serverToken,
 boolean supportOptionalParams)

getClientSecretSignatureProvider

public static JwsSignatureProvider getClientSecretSignatureProvider(String clientSecret)

getClientSecretSignatureVerifier

public static JwsSignatureVerifier getClientSecretSignatureVerifier(String clientSecret)

getClientSecretDecryptionProvider

public static JweDecryptionProvider getClientSecretDecryptionProvider(String clientSecret)

getClientSecretEncryptionProvider

public static JweEncryptionProvider getClientSecretEncryptionProvider(String clientSecret)

getClientSecretSignatureAlgorithm

public static SignatureAlgorithm getClientSecretSignatureAlgorithm(Properties sigProps)

convertListOfScopesToString

public static String convertListOfScopesToString(List<String> registeredScopes)