ca.nrc.cadc.auth.TokenValidator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cadc-util Show documentation
Show all versions of cadc-util Show documentation
OpenCADC core utility library
/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2021. (c) 2021.
* Government of Canada Gouvernement du Canada
* National Research Council Conseil national de recherches
* Ottawa, Canada, K1A 0R6 Ottawa, Canada, K1A 0R6
* All rights reserved Tous droits réservés
*
* NRC disclaims any warranties, Le CNRC dénie toute garantie
* expressed, implied, or énoncée, implicite ou légale,
* statutory, of any kind with de quelque nature que ce
* respect to the software, soit, concernant le logiciel,
* including without limitation y compris sans restriction
* any warranty of merchantability toute garantie de valeur
* or fitness for a particular marchande ou de pertinence
* purpose. NRC shall not be pour un usage particulier.
* liable in any event for any Le CNRC ne pourra en aucun cas
* damages, whether direct or être tenu responsable de tout
* indirect, special or general, dommage, direct ou indirect,
* consequential or incidental, particulier ou général,
* arising from the use of the accessoire ou fortuit, résultant
* software. Neither the name de l'utilisation du logiciel. Ni
* of the National Research le nom du Conseil National de
* Council of Canada nor the Recherches du Canada ni les noms
* names of its contributors may de ses participants ne peuvent
* be used to endorse or promote être utilisés pour approuver ou
* products derived from this promouvoir les produits dérivés
* software without specific prior de ce logiciel sans autorisation
* written permission. préalable et particulière
* par écrit.
*
* This file is part of the Ce fichier fait partie du projet
* OpenCADC project. OpenCADC.
*
* OpenCADC is free software: OpenCADC est un logiciel libre ;
* you can redistribute it and/or vous pouvez le redistribuer ou le
* modify it under the terms of modifier suivant les termes de
* the GNU Affero General Public la “GNU Affero General Public
* License as published by the License” telle que publiée
* Free Software Foundation, par la Free Software Foundation
* either version 3 of the : soit la version 3 de cette
* License, or (at your option) licence, soit (à votre gré)
* any later version. toute version ultérieure.
*
* OpenCADC is distributed in the OpenCADC est distribué
* hope that it will be useful, dans l’espoir qu’il vous
* but WITHOUT ANY WARRANTY; sera utile, mais SANS AUCUNE
* without even the implied GARANTIE : sans même la garantie
* warranty of MERCHANTABILITY implicite de COMMERCIALISABILITÉ
* or FITNESS FOR A PARTICULAR ni d’ADÉQUATION À UN OBJECTIF
* PURPOSE. See the GNU Affero PARTICULIER. Consultez la Licence
* General Public License for Générale Publique GNU Affero
* more details. pour plus de détails.
*
* You should have received Vous devriez avoir reçu une
* a copy of the GNU Affero copie de la Licence Générale
* General Public License along Publique GNU Affero avec
* with OpenCADC. If not, see OpenCADC ; si ce n’est
* . pas le cas, consultez :
* .
*
************************************************************************
*/
package ca.nrc.cadc.auth;
import ca.nrc.cadc.auth.NotAuthenticatedException.AuthError;
import java.security.AccessControlException;
import java.util.List;
import java.util.Set;
import javax.security.auth.Subject;
import org.apache.log4j.Logger;
/**
* Utility class to validate CADC tokens.
*
* @author majorb
*
*/
public class TokenValidator {
private static Logger log = Logger.getLogger(TokenValidator.class);
/**
* Method to validate CADC-style cookie and token principals, used by the
* CADC AuthenticatorImpl(s).
*
* @param subject The subject containing extracted principals
* @return The same subject but with associated public credentials
* @throws AccessControlException
*/
public static Subject validateTokens(Subject subject) throws NotAuthenticatedException {
// cookies
Set cookiePrincipals = subject.getPrincipals(CookiePrincipal.class);
log.debug("validateTokens: found " + cookiePrincipals.size() + " cookie principals");
if (!cookiePrincipals.isEmpty()) {
SSOCookieManager ssoCookieManager = new SSOCookieManager();
for (CookiePrincipal p : cookiePrincipals) {
try {
SignedToken cookieToken = ssoCookieManager.parse(p.getValue());
subject.getPrincipals().addAll(cookieToken.getIdentityPrincipals());
List cookieCredentialList =
ssoCookieManager.getSSOCookieCredentials(p.getValue());
log.debug("Adding " + cookieCredentialList.size() + " cookie credentials to subject");
subject.getPublicCredentials().addAll(cookieCredentialList);
subject.getPrincipals().remove(p);
} catch (InvalidSignedTokenException ex) {
throw new NotAuthenticatedException("invalid cookie: " + ex.getMessage(), ex);
}
}
}
// tokens
Set tokenPrincipals = subject.getPrincipals(AuthorizationTokenPrincipal.class);
log.debug("validateTokens: found " + tokenPrincipals.size() + " token principals");
for (AuthorizationTokenPrincipal p : tokenPrincipals) {
log.debug("header key: " + p.getHeaderKey());
log.debug("header value: " + p.getHeaderValue());
String credentials = null;
String challengeType = null;
if (AuthenticationUtil.TOKEN_TYPE_CADC.equals(p.getHeaderKey())) {
challengeType = AuthenticationUtil.TOKEN_TYPE_CADC;
credentials = p.getHeaderValue().trim();
} else if (AuthenticationUtil.AUTHORIZATION_HEADER.equals(p.getHeaderKey())) {
// parse the token into challenge type and credentials.
int spaceIndex = p.getHeaderValue().indexOf(" ");
if (spaceIndex == -1) {
throw new NotAuthenticatedException(challengeType, AuthError.INVALID_REQUEST,
"missing authorization challenge");
}
challengeType = p.getHeaderValue().substring(0, spaceIndex).trim();
if (AuthenticationUtil.CHALLENGE_TYPE_BEARER.equalsIgnoreCase(challengeType)) {
credentials = p.getHeaderValue().substring(spaceIndex + 1).trim();
}
// else: ignore
// throw new NotAuthenticatedException(challengeType, AuthError.INVALID_REQUEST,
// "unsupported challenge type: " + challengeType);
//}
}
if (challengeType != null && credentials != null) {
log.debug("challenge type: " + challengeType);
log.debug("credentials: " + credentials);
try {
SignedToken validatedToken = SignedToken.parse(credentials);
subject.getPrincipals().addAll(validatedToken.getIdentityPrincipals());
AuthorizationToken authToken = new AuthorizationToken(
challengeType, credentials, validatedToken.getDomains(), validatedToken.getScope());
log.debug("Adding token credential to subject, removing token principal");
subject.getPublicCredentials().add(authToken);
subject.getPrincipals().remove(p);
} catch (Exception ex) {
throw new NotAuthenticatedException(challengeType, AuthError.INVALID_TOKEN, ex.getMessage(), ex);
}
}
// ignore other challenge types
}
return subject;
}
}