00001 #include "otsdaq-core/WebUsersUtilities/RemoteWebUsers.h"
00002
00003 #include "otsdaq-core/SOAPUtilities/SOAPParameters.h"
00004 #include "otsdaq-core/SOAPUtilities/SOAPUtilities.h"
00005 #include "otsdaq-core/SOAPUtilities/SOAPCommand.h"
00006 #include "otsdaq-core/XmlUtilities/HttpXmlDocument.h"
00007 #include "otsdaq-core/MessageFacility/MessageFacility.h"
00008 #include "otsdaq-core/CgiDataUtilities/CgiDataUtilities.h"
00009 #include "otsdaq-core/Macros/CoutHeaderMacros.h"
00010 #include "otsdaq-core/SupervisorDescriptorInfo/SupervisorDescriptorInfo.h"
00011
00012 #include <cstdlib>
00013 #include <cstdio>
00014 #include <vector>
00015
00016
00017 using namespace ots;
00018
00019 #undef __MF_SUBJECT__
00020 #define __MF_SUBJECT__ "RemoteWebUsers"
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039
00040
00041
00042
00043
00044
00045
00046
00047
00048
00049
00050
00051
00052
00053
00054
00055
00056
00057
00058
00059
00060
00061
00062
00063
00064
00065
00066
00067
00068
00069
00070
00071
00072
00073
00074
00075
00076
00077
00078
00079
00080
00081
00082
00083
00084
00085
00086
00087
00088
00089 RemoteWebUsers::RemoteWebUsers(xdaq::Application* application)
00090 : SOAPMessenger (application)
00091 {
00092 ActiveUserLastUpdateTime_ = 0;
00093 ActiveUserList_ = "";
00094 }
00095
00096
00097
00098
00099 bool RemoteWebUsers::xmlLoginGateway(
00100 cgicc::Cgicc &cgi,
00101 std::ostringstream *out,
00102 HttpXmlDocument *xmldoc,
00103 const SupervisorDescriptorInfo &theSupervisorsDescriptorInfo,
00104 uint8_t *userPermissions,
00105 const bool refresh,
00106 const uint8_t permissionsThreshold,
00107 const bool checkLock,
00108 const bool lockRequired,
00109 std::string *userWithLock,
00110 std::string *userName,
00111 std::string *displayName,
00112 uint64_t *activeSessionIndex )
00113 {
00114
00115 if(userPermissions) *userPermissions = 0;
00116 if(userWithLock) *userWithLock = "";
00117 if(userName) *userName = "";
00118 if(displayName) *displayName = "";
00119 if(activeSessionIndex) *activeSessionIndex = -1;
00120
00121 const std::string ip = cgi.getEnvironment().getRemoteAddr();
00122
00123
00124
00125
00126
00127
00128
00129 const xdaq::ApplicationDescriptor* gatewaySupervisor;
00130
00131 SOAPParameters parameters;
00132 xoap::MessageReference retMsg;
00133
00134
00135
00136
00137 std::string cookieCode = CgiDataUtilities::getOrPostData(cgi,"CookieCode");
00138
00139
00140
00141
00142
00144
00145 gatewaySupervisor = theSupervisorsDescriptorInfo.getSupervisorDescriptor();
00146 if(!gatewaySupervisor)
00147 {
00148
00149 std::string sequence = CgiDataUtilities::getOrPostData(cgi,"sequence");
00150
00151 if(!sequence.length())
00152 {
00153 __MOUT__ << "Invalid attempt." << std::endl;
00154 *out << RemoteWebUsers::REQ_NO_LOGIN_RESPONSE;
00155 return false;
00156 }
00157
00158
00159
00160 gatewaySupervisor = theSupervisorsDescriptorInfo.getWizardDescriptor();
00161 if(!gatewaySupervisor)
00162 {
00163 *out << RemoteWebUsers::REQ_NO_LOGIN_RESPONSE;
00164 return false;
00165 }
00166
00167 parameters.addParameter("sequence",sequence);
00168 retMsg = SOAPMessenger::sendWithSOAPReply(gatewaySupervisor,
00169 "SupervisorSequenceCheck", parameters);
00170 parameters.clear();
00171 parameters.addParameter("Permissions");
00172 receive(retMsg, parameters);
00173
00174 uint8_t tmpUserPermissions;
00175 sscanf(parameters.getValue("Permissions").c_str(),"%hhu",&tmpUserPermissions);
00176
00177 if(userPermissions) *userPermissions = tmpUserPermissions;
00178
00179 if(tmpUserPermissions < permissionsThreshold)
00180 {
00181 *out << RemoteWebUsers::REQ_NO_LOGIN_RESPONSE;
00182 __MOUT__ << "User has insufficient permissions: " << tmpUserPermissions << "<" <<
00183 permissionsThreshold << std::endl;
00184 return false;
00185 }
00186
00187 if(userWithLock) *userWithLock = "admin";
00188 if(userName) *userName = "admin";
00189 if(displayName) *displayName = "Admin";
00190 if(activeSessionIndex) *activeSessionIndex = 0;
00191
00192 return true;
00193 }
00194
00195
00196
00197 parameters.clear();
00198 parameters.addParameter("CookieCode",cookieCode);
00199 parameters.addParameter("RefreshOption",refresh?"1":"0");
00200
00201 retMsg = SOAPMessenger::sendWithSOAPReply(gatewaySupervisor,
00202 "SupervisorCookieCheck", parameters);
00203
00204 parameters.clear();
00205 parameters.addParameter("CookieCode");
00206 parameters.addParameter("Permissions");
00207 parameters.addParameter("UserWithLock");
00208 receive(retMsg, parameters);
00209 std::string tmpUserWithLock = parameters.getValue("UserWithLock");
00210 uint8_t tmpUserPermissions;
00211 sscanf(parameters.getValue("Permissions").c_str(),"%hhu",&tmpUserPermissions);
00212 if(userWithLock) *userWithLock = tmpUserWithLock;
00213 if(userPermissions) *userPermissions = tmpUserPermissions;
00214
00215 cookieCode = parameters.getValue("CookieCode");
00216
00217
00218
00219 if(cookieCode.length() != COOKIE_CODE_LENGTH)
00220 {
00221 *out << RemoteWebUsers::REQ_NO_LOGIN_RESPONSE;
00222 return false;
00223 }
00224
00225 if(tmpUserPermissions < permissionsThreshold)
00226 {
00227 *out << RemoteWebUsers::REQ_NO_PERMISSION_RESPONSE;
00228 __MOUT__ << "User has insufficient permissions: " << tmpUserPermissions << "<" <<
00229 permissionsThreshold << std::endl;
00230 return false;
00231 }
00232
00233 if(xmldoc)
00234 xmldoc->setHeader(cookieCode);
00235
00236 if(!userName && !displayName && !activeSessionIndex && !checkLock && !lockRequired)
00237 return true;
00238
00239
00240
00241
00243
00244 parameters.clear();
00245 parameters.addParameter("CookieCode",cookieCode);
00246 retMsg = SOAPMessenger::sendWithSOAPReply(gatewaySupervisor,
00247 "SupervisorGetUserInfo", parameters);
00248
00249 parameters.clear();
00250 parameters.addParameter("Username");
00251 parameters.addParameter("DisplayName");
00252 parameters.addParameter("ActiveSessionIndex");
00253 receive(retMsg, parameters);
00254 std::string tmpUserName = parameters.getValue("Username");
00255 if(userName) *userName = tmpUserName;
00256 if(displayName) *displayName = parameters.getValue("DisplayName");
00257 if(activeSessionIndex) *activeSessionIndex = strtoul(parameters.getValue("ActiveSessionIndex").c_str(),0,0);
00258
00259 if(checkLock && tmpUserWithLock != "" && tmpUserWithLock != tmpUserName)
00260 {
00261 *out << RemoteWebUsers::REQ_USER_LOCKOUT_RESPONSE;
00262 __MOUT__ << "User " << tmpUserName << " is locked out. " << tmpUserWithLock << " has lock." << std::endl;
00263 return false;
00264 }
00265
00266 if(lockRequired && tmpUserWithLock != tmpUserName)
00267 {
00268 *out << RemoteWebUsers::REQ_LOCK_REQUIRED_RESPONSE;
00269 __MOUT__ << "User " << tmpUserName << " must have lock to proceed. (" << tmpUserWithLock << " has lock.)" << std::endl;
00270 return false;
00271 }
00272
00273 return true;
00274 }
00275
00276
00277
00278
00279 bool RemoteWebUsers::isWizardMode(const SupervisorDescriptorInfo& theSupervisorsDescriptorInfo)
00280 {
00281 return theSupervisorsDescriptorInfo.getWizardDescriptor()?true:false;
00282 }
00283
00284
00285
00286
00287
00288 std::string RemoteWebUsers::getActiveUserList(const xdaq::ApplicationDescriptor* supervisorDescriptor)
00289 {
00290
00291 if(1 || time(0) - ActiveUserLastUpdateTime_ > ACTIVE_USERS_UPDATE_THRESHOLD)
00292 {
00293
00294 __MOUT__ << "Need to update " << std::endl;
00295
00296 xoap::MessageReference retMsg = ots::SOAPMessenger::sendWithSOAPReply(supervisorDescriptor,"SupervisorGetActiveUsers");
00297
00298
00299 SOAPParameters retParameters("UserList");
00300 receive(retMsg, retParameters);
00301
00302 ActiveUserLastUpdateTime_ = time(0);
00303 return (ActiveUserList_ = retParameters.getValue("UserList"));
00304 }
00305 else
00306 return ActiveUserList_;
00307 }
00308
00309
00310
00311
00312
00313
00314 std::pair<std::string , ConfigurationGroupKey> RemoteWebUsers::getLastConfigGroup(
00315 const xdaq::ApplicationDescriptor* supervisorDescriptor,
00316 const std::string &actionOfLastGroup,
00317 std::string &actionTimeString)
00318 {
00319 actionTimeString = "";
00320 xoap::MessageReference retMsg = ots::SOAPMessenger::sendWithSOAPReply(
00321 supervisorDescriptor,"SupervisorLastConfigGroupRequest",
00322 SOAPParameters("ActionOfLastGroup",actionOfLastGroup));
00323
00324
00325 SOAPParameters retParameters;
00326 retParameters.addParameter("GroupName");
00327 retParameters.addParameter("GroupKey");
00328 retParameters.addParameter("GroupAction");
00329 retParameters.addParameter("GroupActionTime");
00330 receive(retMsg, retParameters);
00331
00332 std::pair<std::string , ConfigurationGroupKey> theGroup;
00333 if(retParameters.getValue("GroupAction") != actionOfLastGroup)
00334 {
00335 __MOUT_WARN__ << "Returned group action '" << retParameters.getValue("GroupAction") <<
00336 "' does not match requested group action '" << actionOfLastGroup << ".'" << std::endl;
00337 return theGroup;
00338 }
00339
00340
00341 theGroup.first = retParameters.getValue("GroupName");
00342 theGroup.second = strtol(retParameters.getValue("GroupKey").c_str(),0,0);
00343 actionTimeString = retParameters.getValue("GroupActionTime");
00344 return theGroup;
00345 }
00346
00347
00348
00349
00350
00351
00352 bool RemoteWebUsers::getUserInfoForCookie(const xdaq::ApplicationDescriptor* supervisorDescriptor,
00353 std::string &cookieCode, std::string *userName, std::string *displayName, uint64_t *activeSessionIndex)
00354 {
00355 __MOUT__ << std::endl;
00356 if(cookieCode.length() != COOKIE_CODE_LENGTH) return false;
00357
00358
00359
00360 xoap::MessageReference retMsg = SOAPMessenger::sendWithSOAPReply(supervisorDescriptor, "SupervisorGetUserInfo", SOAPParameters("CookieCode",cookieCode));
00361
00362 SOAPParameters retParameters;
00363 retParameters.addParameter("Username");
00364 retParameters.addParameter("DisplayName");
00365 retParameters.addParameter("ActiveSessionIndex");
00366 receive(retMsg, retParameters);
00367 if(userName) *userName = retParameters.getValue("Username");
00368 if(displayName) *displayName = retParameters.getValue("DisplayName");
00369 if(activeSessionIndex) *activeSessionIndex = strtoul(retParameters.getValue("ActiveSessionIndex").c_str(),0,0);
00370
00371 __MOUT__ << "userName " << *userName << std::endl;
00372
00373 return true;
00374 }
00375
00376
00377
00378
00379 bool RemoteWebUsers::cookieCodeIsActiveForRequest(const xdaq::ApplicationDescriptor* supervisorDescriptor,
00380 std::string &cookieCode, uint8_t *userPermissions, std::string ip, bool refresh, std::string *userWithLock)
00381 {
00382
00383 if(cookieCode.length() != COOKIE_CODE_LENGTH) return false;
00384
00385
00386
00387 SOAPParameters parameters;
00388 parameters.addParameter("CookieCode",cookieCode);
00389 parameters.addParameter("RefreshOption",refresh?"1":"0");
00390
00391
00392 xoap::MessageReference retMsg = SOAPMessenger::sendWithSOAPReply(supervisorDescriptor, "SupervisorCookieCheck", parameters);
00393
00394
00395 SOAPParameters retParameters;
00396 retParameters.addParameter("CookieCode");
00397 retParameters.addParameter("Permissions");
00398 retParameters.addParameter("UserWithLock");
00399 receive(retMsg, retParameters);
00400
00401
00402
00403 if(userWithLock) *userWithLock = retParameters.getValue("UserWithLock");
00404 if(userPermissions) sscanf(retParameters.getValue("Permissions").c_str(),"%hhu",userPermissions);
00405
00406 cookieCode = retParameters.getValue("CookieCode");
00407
00408 return cookieCode.length() == COOKIE_CODE_LENGTH;
00409 }
00410
00411
00412
00413
00414 void RemoteWebUsers::sendSystemMessage(const xdaq::ApplicationDescriptor* supervisorDescriptor, const std::string& toUser, const std::string& msg)
00415 {
00416 SOAPParameters parameters;
00417 parameters.addParameter("ToUser" , toUser);
00418 parameters.addParameter("Message", msg);
00419
00420 xoap::MessageReference retMsg = SOAPMessenger::sendWithSOAPReply(supervisorDescriptor, "SupervisorSystemMessage",parameters);
00421 }
00422
00423
00424
00425
00426
00427 void RemoteWebUsers::makeSystemLogbookEntry(const xdaq::ApplicationDescriptor* supervisorDescriptor, const std::string& entryText)
00428 {
00429 SOAPParameters parameters;
00430 parameters.addParameter("EntryText", entryText);
00431
00432 xoap::MessageReference retMsg = SOAPMessenger::sendWithSOAPReply(supervisorDescriptor, "SupervisorSystemLogbookEntry",parameters);
00433 }
00434