mirror of https://github.com/apache/cloudstack.git
351 lines
17 KiB
Java
Executable File
351 lines
17 KiB
Java
Executable File
/**
|
|
* Copyright (C) 2010 Cloud.com, Inc. All rights reserved.
|
|
*
|
|
* This software is licensed under the GNU General Public License v3 or later.
|
|
*
|
|
* It is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or any later version.
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
package com.cloud.api;
|
|
|
|
import java.io.IOException;
|
|
import java.io.OutputStream;
|
|
import java.util.Enumeration;
|
|
import java.util.HashMap;
|
|
import java.util.Map;
|
|
|
|
import javax.servlet.http.HttpServlet;
|
|
import javax.servlet.http.HttpServletRequest;
|
|
import javax.servlet.http.HttpServletResponse;
|
|
import javax.servlet.http.HttpSession;
|
|
|
|
import org.apache.log4j.Logger;
|
|
|
|
import com.cloud.exception.CloudAuthenticationException;
|
|
import com.cloud.maid.StackMaid;
|
|
import com.cloud.user.Account;
|
|
import com.cloud.user.UserContext;
|
|
import com.cloud.utils.exception.CloudRuntimeException;
|
|
|
|
@SuppressWarnings("serial")
|
|
public class ApiServlet extends HttpServlet {
|
|
public static final Logger s_logger = Logger.getLogger(ApiServlet.class.getName());
|
|
private static final Logger s_accessLogger = Logger.getLogger("apiserver." + ApiServer.class.getName());
|
|
|
|
private ApiServer _apiServer = null;
|
|
|
|
public ApiServlet() {
|
|
super();
|
|
_apiServer = ApiServer.getInstance();
|
|
if (_apiServer == null) {
|
|
throw new CloudRuntimeException("ApiServer not initialized");
|
|
}
|
|
}
|
|
|
|
protected void doGet(HttpServletRequest req, HttpServletResponse resp) {
|
|
try {
|
|
processRequest(req, resp);
|
|
} finally {
|
|
StackMaid.current().exitCleanup();
|
|
}
|
|
}
|
|
|
|
protected void doPost(HttpServletRequest req, HttpServletResponse resp) {
|
|
try {
|
|
processRequest(req, resp);
|
|
} finally {
|
|
StackMaid.current().exitCleanup();
|
|
}
|
|
}
|
|
|
|
@SuppressWarnings("unchecked")
|
|
private void processRequest(HttpServletRequest req, HttpServletResponse resp) {
|
|
StringBuffer auditTrailSb = new StringBuffer();
|
|
auditTrailSb.append(" " +req.getRemoteAddr());
|
|
auditTrailSb.append(" -- " + req.getMethod() + " " );
|
|
try {
|
|
Map<String, Object[]> params = new HashMap<String, Object[]>();
|
|
params.putAll(req.getParameterMap());
|
|
HttpSession session = req.getSession(false);
|
|
|
|
// get the response format since we'll need it in a couple of places
|
|
String responseType = BaseCmd.RESPONSE_TYPE_XML;
|
|
Object[] responseTypeParam = params.get("response");
|
|
if (responseTypeParam != null) {
|
|
responseType = (String)responseTypeParam[0];
|
|
}
|
|
|
|
Object[] commandObj = params.get("command");
|
|
if (commandObj != null) {
|
|
String command = (String)commandObj[0];
|
|
if ("logout".equalsIgnoreCase(command)) {
|
|
// if this is just a logout, invalidate the session and return
|
|
if (session != null) {
|
|
Long userId = (Long)session.getAttribute("userid");
|
|
Account account = (Account)session.getAttribute("accountobj");
|
|
auditTrailSb.insert(0, "(userId="+userId+
|
|
" accountId="+ account==null ? null:account.getId()+
|
|
" sessionId="+session.getId() +")" );
|
|
if (userId != null) {
|
|
_apiServer.logoutUser(userId);
|
|
}
|
|
session.invalidate();
|
|
}
|
|
auditTrailSb.append("command=logout");
|
|
auditTrailSb.append(" " +HttpServletResponse.SC_OK);
|
|
writeResponse(resp, getLogoutSuccessResponse(responseType), false, responseType);
|
|
return;
|
|
} else if ("login".equalsIgnoreCase(command)) {
|
|
auditTrailSb.append("command=login");
|
|
// if this is a login, authenticate the user and return
|
|
if (session != null) session.invalidate();
|
|
session = req.getSession(true);
|
|
String[] username = (String[])params.get("username");
|
|
String[] password = (String[])params.get("password");
|
|
String[] domainIdArr = (String[])params.get("domainid");
|
|
|
|
if (domainIdArr == null) {
|
|
domainIdArr = (String[])params.get("domainId");
|
|
}
|
|
String[] domainName = (String[])params.get("domain");
|
|
Long domainId = null;
|
|
if ((domainIdArr != null) && (domainIdArr.length > 0)) {
|
|
try{
|
|
domainId = new Long(Long.parseLong(domainIdArr[0]));
|
|
auditTrailSb.append(" domainid=" +domainId);// building the params for POST call
|
|
}
|
|
catch(NumberFormatException e)
|
|
{
|
|
s_logger.warn("Invalid domain id entered by user");
|
|
auditTrailSb.append(" " + HttpServletResponse.SC_UNAUTHORIZED + " " + "Invalid domain id entered, please enter a valid one");
|
|
resp.sendError(HttpServletResponse.SC_UNAUTHORIZED,"Invalid domain id entered, please enter a valid one");
|
|
}
|
|
}
|
|
String domain = null;
|
|
if (domainName != null) {
|
|
domain = domainName[0];
|
|
auditTrailSb.append(" domain=" +domain);
|
|
if (domain != null) {
|
|
// ensure domain starts with '/' and ends with '/'
|
|
if (!domain.endsWith("/")) {
|
|
domain += '/';
|
|
}
|
|
if (!domain.startsWith("/")) {
|
|
domain = "/" + domain;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (username != null) {
|
|
String pwd = ((password == null) ? null : password[0]);
|
|
try {
|
|
_apiServer.loginUser(session, username[0], pwd, domainId, domain, params);
|
|
auditTrailSb.insert(0,"(userId="+session.getAttribute("userid")+
|
|
" accountId="+ ((Account)session.getAttribute("accountobj")).getId()+
|
|
" sessionId="+session.getId()+ ")" );
|
|
String loginResponse = getLoginSuccessResponse(session, responseType);
|
|
writeResponse(resp, loginResponse, false, responseType);
|
|
return;
|
|
} catch (CloudAuthenticationException ex) {
|
|
// TODO: fall through to API key, or just fail here w/ auth error? (HTTP 401)
|
|
session.invalidate();
|
|
auditTrailSb.append(" " + HttpServletResponse.SC_UNAUTHORIZED + " " + "failed to authenticated user, check username/password are correct");
|
|
resp.sendError(HttpServletResponse.SC_UNAUTHORIZED, "failed to authenticated user, check username/password are correct");
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
auditTrailSb.append(req.getQueryString());
|
|
boolean isNew = ((session == null) ? true : session.isNew());
|
|
|
|
// Initialize an empty context and we will update it after we have verified the request below,
|
|
// we no longer rely on web-session here, verifyRequest will populate user/account information
|
|
// if a API key exists
|
|
UserContext.registerContext(null, null, null, null, null, null, false);
|
|
Long userId = null;
|
|
|
|
if (!isNew) {
|
|
userId = (Long)session.getAttribute("userid");
|
|
String account = (String)session.getAttribute("account");
|
|
Long domainId = (Long)session.getAttribute("domainid");
|
|
Object accountObj = session.getAttribute("accountobj");
|
|
String sessionKey = (String)session.getAttribute("sessionkey");
|
|
String[] sessionKeyParam = (String[])params.get("sessionkey");
|
|
if ((sessionKeyParam == null) || (sessionKey == null) || !sessionKey.equals(sessionKeyParam[0])) {
|
|
session.invalidate();
|
|
auditTrailSb.append(" " + HttpServletResponse.SC_UNAUTHORIZED + " " + "unable to verify user credentials");
|
|
resp.sendError(HttpServletResponse.SC_UNAUTHORIZED, "unable to verify user credentials");
|
|
return;
|
|
}
|
|
|
|
// Do a sanity check here to make sure the user hasn't already been deleted
|
|
if ((userId != null) && (account != null) && (accountObj != null) && _apiServer.verifyUser(userId)) {
|
|
String[] command = (String[])params.get("command");
|
|
if (command == null) {
|
|
s_logger.info("missing command, ignoring request...");
|
|
auditTrailSb.append(" " + HttpServletResponse.SC_BAD_REQUEST + " " + "no command specified");
|
|
resp.sendError(HttpServletResponse.SC_BAD_REQUEST, "no command specified");
|
|
return;
|
|
}
|
|
UserContext.updateContext(userId, accountObj, account, ((Account)accountObj).getId(), domainId, session.getId());
|
|
} else {
|
|
// Invalidate the session to ensure we won't allow a request across management server restarts if the userId was serialized to the
|
|
// stored session
|
|
session.invalidate();
|
|
auditTrailSb.append(" " + HttpServletResponse.SC_UNAUTHORIZED + " " + "unable to verify user credentials");
|
|
resp.sendError(HttpServletResponse.SC_UNAUTHORIZED, "unable to verify user credentials");
|
|
return;
|
|
}
|
|
}
|
|
|
|
if (_apiServer.verifyRequest(params, userId.toString())) {
|
|
/*
|
|
if (accountObj != null) {
|
|
Account userAccount = (Account)accountObj;
|
|
if (userAccount.getType() == Account.ACCOUNT_TYPE_NORMAL) {
|
|
params.put(BaseCmd.Properties.USER_ID.getName(), new String[] { userId });
|
|
params.put(BaseCmd.Properties.ACCOUNT.getName(), new String[] { account });
|
|
params.put(BaseCmd.Properties.DOMAIN_ID.getName(), new String[] { domainId });
|
|
params.put(BaseCmd.Properties.ACCOUNT_OBJ.getName(), new Object[] { accountObj });
|
|
} else {
|
|
params.put(BaseCmd.Properties.USER_ID.getName(), new String[] { userId });
|
|
params.put(BaseCmd.Properties.ACCOUNT_OBJ.getName(), new Object[] { accountObj });
|
|
}
|
|
}
|
|
|
|
// update user context info here so that we can take information if the request is authenticated
|
|
// via api key mechanism
|
|
updateUserContext(params, session != null ? session.getId() : null);
|
|
*/
|
|
|
|
auditTrailSb.insert(0, "(userId="+UserContext.current().getUserId()+ " accountId="+UserContext.current().getAccountId()+ " sessionId="+(session != null ? session.getId() : null)+ ")" );
|
|
|
|
try {
|
|
String response = _apiServer.handleRequest(params, false, responseType, auditTrailSb);
|
|
writeResponse(resp, response != null ? response : "", false, responseType);
|
|
} catch (ServerApiException se) {
|
|
auditTrailSb.append(" " +se.getErrorCode() + " " + se.getDescription());
|
|
resp.sendError(se.getErrorCode(), se.getDescription());
|
|
}
|
|
} else {
|
|
if (session != null) {
|
|
session.invalidate();
|
|
}
|
|
auditTrailSb.append(" " + HttpServletResponse.SC_UNAUTHORIZED + " " + "unable to verify user credentials and/or request signature");
|
|
resp.sendError(HttpServletResponse.SC_UNAUTHORIZED, "unable to verify user credentials and/or request signature");
|
|
}
|
|
} catch (IOException ioex) {
|
|
if (s_logger.isTraceEnabled()) {
|
|
s_logger.trace("exception processing request: " + ioex);
|
|
}
|
|
auditTrailSb.append(" exception processing request" );
|
|
} catch (Exception ex) {
|
|
s_logger.error("unknown exception writing api response", ex);
|
|
auditTrailSb.append(" unknown exception writing api response");
|
|
} finally {
|
|
s_accessLogger.info(auditTrailSb.toString());
|
|
// cleanup user context to prevent from being peeked in other request context
|
|
UserContext.unregisterContext();
|
|
}
|
|
}
|
|
|
|
/*
|
|
private void updateUserContext(Map<String, Object[]> requestParameters, String sessionId) {
|
|
String userIdStr = (String)(requestParameters.get(BaseCmd.Properties.USER_ID.getName())[0]);
|
|
Account accountObj = (Account)(requestParameters.get(BaseCmd.Properties.ACCOUNT_OBJ.getName())[0]);
|
|
|
|
Long userId = null;
|
|
Long accountId = null;
|
|
if(userIdStr != null)
|
|
userId = Long.parseLong(userIdStr);
|
|
|
|
if(accountObj != null)
|
|
accountId = accountObj.getId();
|
|
UserContext.updateContext(userId, accountId, sessionId);
|
|
}
|
|
*/
|
|
|
|
// FIXME: rather than isError, we might was to pass in the status code to give more flexibility
|
|
private void writeResponse(HttpServletResponse resp, String response, boolean isError, String responseType) {
|
|
try {
|
|
// is text/plain sufficient for XML and JSON?
|
|
if (BaseCmd.RESPONSE_TYPE_JSON.equalsIgnoreCase(responseType)) {
|
|
resp.setContentType("text/javascript");
|
|
} else {
|
|
resp.setContentType("text/xml");
|
|
}
|
|
resp.setStatus(isError? HttpServletResponse.SC_INTERNAL_SERVER_ERROR : HttpServletResponse.SC_OK);
|
|
byte[] respBytes = response.getBytes();
|
|
resp.setContentLength(respBytes.length);
|
|
OutputStream os = resp.getOutputStream();
|
|
os.write(respBytes);
|
|
os.flush();
|
|
os.close();
|
|
resp.flushBuffer();
|
|
} catch (IOException ioex) {
|
|
if (s_logger.isTraceEnabled()) {
|
|
s_logger.trace("exception writing response: " + ioex);
|
|
}
|
|
} catch (Exception ex) {
|
|
s_logger.error("unknown exception writing api response", ex);
|
|
}
|
|
}
|
|
|
|
@SuppressWarnings("rawtypes")
|
|
private String getLoginSuccessResponse(HttpSession session, String responseType) {
|
|
StringBuffer sb = new StringBuffer();
|
|
int inactiveInterval = session.getMaxInactiveInterval();
|
|
|
|
if (BaseCmd.RESPONSE_TYPE_JSON.equalsIgnoreCase(responseType)) {
|
|
sb.append("{ \"loginresponse\" : { ");
|
|
Enumeration attrNames = session.getAttributeNames();
|
|
if (attrNames != null) {
|
|
sb.append("\"timeout\" : \"" + inactiveInterval + "\"");
|
|
while (attrNames.hasMoreElements()) {
|
|
String attrName = (String)attrNames.nextElement();
|
|
Object attrObj = session.getAttribute(attrName);
|
|
if ((attrObj instanceof String) || (attrObj instanceof Long)) {
|
|
sb.append(", \"" + attrName + "\" : \"" + attrObj.toString() + "\"");
|
|
}
|
|
}
|
|
}
|
|
sb.append(" } }");
|
|
} else {
|
|
sb.append("<loginresponse>");
|
|
sb.append("<timeout>" + inactiveInterval + "</timeout>");
|
|
Enumeration attrNames = session.getAttributeNames();
|
|
if (attrNames != null) {
|
|
while (attrNames.hasMoreElements()) {
|
|
String attrName = (String)attrNames.nextElement();
|
|
String attr = (String)session.getAttribute(attrName);
|
|
sb.append("<" + attrName + ">" + attr + "</" + attrName + ">");
|
|
}
|
|
}
|
|
|
|
sb.append("</loginresponse>");
|
|
}
|
|
return sb.toString();
|
|
}
|
|
|
|
private String getLogoutSuccessResponse(String responseType) {
|
|
StringBuffer sb = new StringBuffer();
|
|
if (BaseCmd.RESPONSE_TYPE_JSON.equalsIgnoreCase(responseType)) {
|
|
sb.append("{ \"logoutresponse\" : { \"description\" : \"success\" } }");
|
|
} else {
|
|
sb.append("<logoutresponse><description>success</description></logoutresponse>");
|
|
}
|
|
return sb.toString();
|
|
}
|
|
}
|