/*
************************************************************************
******************* CANADIAN ASTRONOMY DATA CENTRE *******************
************** CENTRE CANADIEN DE DONNÉES ASTRONOMIQUES **************
*
* (c) 2015. (c) 2015.
* 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 :
* .
*
* $Revision: 4 $
*
************************************************************************
*/
package ca.nrc.cadc.ac.server.web;
import ca.nrc.cadc.ac.server.web.users.AbstractUserAction;
import ca.nrc.cadc.ac.server.web.users.GetUserAction;
import ca.nrc.cadc.ac.server.web.users.UserActionFactory;
import ca.nrc.cadc.ac.server.web.users.UserLogInfo;
import ca.nrc.cadc.auth.AuthenticationUtil;
import ca.nrc.cadc.auth.HttpPrincipal;
import ca.nrc.cadc.auth.ServletPrincipalExtractor;
import ca.nrc.cadc.profiler.Profiler;
import ca.nrc.cadc.util.StringUtil;
import org.apache.log4j.Logger;
import javax.security.auth.Subject;
import javax.security.auth.x500.X500Principal;
import javax.servlet.ServletConfig;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.security.AccessController;
import java.security.Principal;
import java.security.PrivilegedActionException;
import java.util.Set;
public class UserServlet extends HttpServlet
{
private static final long serialVersionUID = 5289130885807305288L;
private static final Logger log = Logger.getLogger(UserServlet.class);
private String notAugmentedX500User;
private String notAugmentedHttpUser;
@Override
public void init(final ServletConfig config) throws ServletException
{
super.init(config);
try
{
this.notAugmentedX500User = config.getInitParameter(UserServlet.class.getName() + ".NotAugmentedX500User");
this.notAugmentedHttpUser = config.getInitParameter(UserServlet.class.getName() + ".NotAugmentedHttpUser");
log.debug("notAugmentedX500User: " + notAugmentedX500User);
log.debug("notAugmentedHttpUser: " + notAugmentedHttpUser);
}
catch(Exception ex)
{
log.error("failed to init: " + ex);
}
}
/**
* Create a UserAction and run the action safely.
*/
private void doAction(UserActionFactory factory, HttpServletRequest request, HttpServletResponse response)
throws IOException
{
Profiler profiler = new Profiler(UserServlet.class);
long start = System.currentTimeMillis();
UserLogInfo logInfo = new UserLogInfo(request);
try
{
log.info(logInfo.start());
AbstractUserAction action = factory.createAction(request);
action.setAcceptedContentType(getAcceptedContentType(request));
log.debug("content-type: " + getAcceptedContentType(request));
profiler.checkpoint("created action");
// Special case: if the calling subject has a servops X500Principal,
// AND it is a GET request, do not augment the subject.
Subject subject;
if (action instanceof GetUserAction && isNotAugmentedSubject(request))
{
profiler.checkpoint("check not augmented user");
subject = Subject.getSubject(AccessController.getContext());
log.debug("subject not augmented: " + subject);
action.setAugmentUser(true);
logInfo.user = notAugmentedHttpUser;
profiler.checkpoint("set not augmented user");
}
else
{
subject = AuthenticationUtil.getSubject(request);
logInfo.setSubject(subject);
log.debug("augmented subject: " + subject);
profiler.checkpoint("augment subject");
}
SyncOutput syncOut = new SyncOutput(response);
action.setLogInfo(logInfo);
action.setSyncOut(syncOut);
try
{
if (subject == null)
{
action.run();
}
else
{
Subject.doAs(subject, action);
}
}
catch (PrivilegedActionException e)
{
Throwable cause = e.getCause();
if (cause != null)
{
throw cause;
}
Exception exception = e.getException();
if (exception != null)
{
throw exception;
}
throw e;
}
finally
{
profiler.checkpoint("Executed action");
}
}
catch (IllegalArgumentException e)
{
log.debug(e.getMessage(), e);
logInfo.setMessage(e.getMessage());
logInfo.setSuccess(false);
response.getWriter().write(e.getMessage());
response.setStatus(400);
}
catch (Throwable t)
{
String message = "Internal Server Error: " + t.getMessage();
log.error(message, t);
logInfo.setSuccess(false);
logInfo.setMessage(message);
response.getWriter().write(message);
response.setStatus(500);
}
finally
{
logInfo.setElapsedTime(System.currentTimeMillis() - start);
log.info(logInfo.end());
}
}
@Override
public void doGet(HttpServletRequest request, HttpServletResponse response)
throws IOException
{
doAction(UserActionFactory.httpGetFactory(), request, response);
}
@Override
public void doPost(HttpServletRequest request, HttpServletResponse response)
throws IOException
{
doAction(UserActionFactory.httpPostFactory(), request, response);
}
@Override
public void doDelete(HttpServletRequest request, HttpServletResponse response)
throws IOException
{
doAction(UserActionFactory.httpDeleteFactory(), request, response);
}
@Override
public void doPut(HttpServletRequest request, HttpServletResponse response)
throws IOException
{
doAction(UserActionFactory.httpPutFactory(), request, response);
}
@Override
public void doHead(HttpServletRequest request, HttpServletResponse response)
throws IOException
{
doAction(UserActionFactory.httpHeadFactory(), request, response);
}
/**
* Obtain the requested (Accept) content type.
*
* @param request The HTTP Request.
* @return String content type.
*/
String getAcceptedContentType(final HttpServletRequest request)
{
final String requestedContentType = request.getHeader("Accept");
if (StringUtil.hasText(requestedContentType)
&& requestedContentType.contains(AbstractUserAction.JSON_CONTENT_TYPE))
{
return AbstractUserAction.JSON_CONTENT_TYPE;
}
else
{
return AbstractUserAction.DEFAULT_CONTENT_TYPE;
}
}
protected boolean isNotAugmentedSubject(HttpServletRequest request)
{
ServletPrincipalExtractor extractor = new ServletPrincipalExtractor(request);
Set principals = extractor.getPrincipals();
for (Principal principal : principals)
{
if (principal instanceof X500Principal)
{
if (principal.getName().equalsIgnoreCase(notAugmentedX500User))
{
log.debug("found notAugmentedX500User " + notAugmentedX500User);
return true;
}
}
if (principal instanceof HttpPrincipal)
{
if (principal.getName().equalsIgnoreCase(notAugmentedHttpUser))
{
log.debug("found notAugmentedHttpUser " + notAugmentedHttpUser);
return true;
}
}
}
return false;
}
}