/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.cxf.rs.security.oauth2.utils;
import java.security.Principal;
import java.util.ArrayList;
import java.util.Collections;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;
import java.util.UUID;
import javax.ws.rs.core.MultivaluedMap;
import org.apache.cxf.common.util.StringUtils;
import org.apache.cxf.jaxrs.impl.MetadataMap;
import org.apache.cxf.jaxrs.model.URITemplate;
import org.apache.cxf.rs.security.oauth2.common.Client;
import org.apache.cxf.rs.security.oauth2.common.OAuthPermission;
import org.apache.cxf.rs.security.oauth2.common.UserSubject;
import org.apache.cxf.rs.security.oauth2.provider.OAuthServiceException;
import org.apache.cxf.security.LoginSecurityContext;
import org.apache.cxf.security.SecurityContext;
/**
* Various utility methods
*/
public final class OAuthUtils {
private OAuthUtils() {
}
public static UserSubject createSubject(SecurityContext securityContext) {
List<String> roleNames = Collections.emptyList();
if (securityContext instanceof LoginSecurityContext) {
roleNames = new ArrayList<String>();
Set<Principal> roles = ((LoginSecurityContext)securityContext).getUserRoles();
for (Principal p : roles) {
roleNames.add(p.getName());
}
}
return
new UserSubject(securityContext.getUserPrincipal().getName(), roleNames);
}
public static String convertPermissionsToScope(List<OAuthPermission> perms) {
StringBuilder sb = new StringBuilder();
for (OAuthPermission perm : perms) {
if (sb.length() > 0) {
sb.append(" ");
}
sb.append(perm.getPermission());
}
return sb.toString();
}
public static List<String> convertPermissionsToScopeList(List<OAuthPermission> perms) {
List<String> list = new LinkedList<String>();
for (OAuthPermission perm : perms) {
list.add(perm.getPermission());
}
return list;
}
public static boolean isGrantSupportedForClient(Client client,
boolean canSupportPublicClients,
String grantType) {
if (!client.isConfidential() && !canSupportPublicClients) {
return false;
}
List<String> allowedGrants = client.getAllowedGrantTypes();
return allowedGrants.isEmpty() || allowedGrants.contains(grantType);
}
public static List<String> parseScope(String requestedScope) {
List<String> list = new LinkedList<String>();
if (requestedScope != null) {
String[] scopeValues = requestedScope.split(" ");
for (String scope : scopeValues) {
if (!StringUtils.isEmpty(scope)) {
list.add(scope);
}
}
}
return list;
}
public static String generateRandomTokenKey() throws OAuthServiceException {
return generateRandomTokenKey(null);
}
public static String generateRandomTokenKey(String digestAlgo) throws OAuthServiceException {
try {
byte[] bytes = UUID.randomUUID().toString().getBytes("UTF-8");
MessageDigestGenerator gen = new MessageDigestGenerator();
if (digestAlgo != null) {
gen.setAlgorithm(digestAlgo);
}
return gen.generate(bytes);
} catch (Exception ex) {
throw new OAuthServiceException(OAuthConstants.SERVER_ERROR, ex);
}
}
public static boolean isExpired(Long issuedAt, Long lifetime) {
return lifetime != -1
&& issuedAt + lifetime < System.currentTimeMillis() / 1000;
}
public static boolean validateAudience(String audience, List<String> audiences) {
return audience == null || !audiences.isEmpty() && audiences.contains(audience);
}
public static boolean checkRequestURI(String servletPath, String uri) {
boolean wildcard = uri.endsWith("*");
String theURI = wildcard ? uri.substring(0, uri.length() - 1) : uri;
try {
URITemplate template = new URITemplate(theURI);
MultivaluedMap<String, String> map = new MetadataMap<String, String>();
if (template.match(servletPath, map)) {
String finalGroup = map.getFirst(URITemplate.FINAL_MATCH_GROUP);
if (wildcard || StringUtils.isEmpty(finalGroup) || "/".equals(finalGroup)) {
return true;
}
}
} catch (Exception ex) {
// ignore
}
return false;
}
public static List<String> getRequestedScopes(Client client, String scopeParameter,
boolean partialMatchScopeValidation) {
List<String> requestScopes = parseScope(scopeParameter);
List<String> registeredScopes = client.getRegisteredScopes();
if (requestScopes.isEmpty()) {
requestScopes.addAll(registeredScopes);
return requestScopes;
}
if (!validateScopes(requestScopes, registeredScopes, partialMatchScopeValidation)) {
throw new OAuthServiceException("Unexpected scope");
}
return requestScopes;
}
public static boolean validateScopes(List<String> requestScopes, List<String> registeredScopes,
boolean partialMatchScopeValidation) {
if (!registeredScopes.isEmpty()) {
// if it is a strict validation then pre-registered scopes have to contains all
// the current request scopes
if (!partialMatchScopeValidation) {
return registeredScopes.containsAll(requestScopes);
} else {
for (String requestScope : requestScopes) {
boolean match = false;
for (String registeredScope : registeredScopes) {
if (requestScope.startsWith(registeredScope)) {
match = true;
break;
}
}
if (!match) {
return false;
}
}
}
}
return true;
}
}