// =============================== // PC-BSD REST API Server // Available under the 3-clause BSD License // Written by: Ken Moore DEC 2015 // ================================= // Note: Don't forget to run "AUTHSYSTEM->hasFullAccess(SockAuthToken)" // To restrict user access to some systems as needed! // ================================= #include //sysadm library interface classes #include "sysadm-general.h" #include "sysadm-iocage.h" #include "sysadm-lifepreserver.h" #include "sysadm-network.h" #include "sysadm-systeminfo.h" #include "sysadm-update.h" #include "syscache-client.h" #include "dispatcher-client.h" #define DEBUG 0 #define SCLISTDELIM QString("::::") //SysCache List Delimiter RestOutputStruct::ExitCode WebSocket::AvailableSubsystems(bool allaccess, QJsonObject *out){ //Probe the various subsystems to see what is available through this server //Output format: /*{ : , : , } */ //bool allaccess = AUTHSYSTEM->hasFullAccess(SockAuthToken); // - syscache if(QFile::exists("/var/run/syscache.pipe")){ out->insert("rpc/syscache","read"); //no write to syscache - only reads } // - dispatcher if(DispatcherClient::DispatcherAvailable()){ //"read" is the event notifications, "write" is the ability to queue up jobs out->insert("rpc/dispatcher", allaccess ? "read/write" : "read"); } // - network out->insert("sysadm/network","read/write"); // - lifepreserver if(QFile::exists("/usr/local/bin/lpreserver")){ out->insert("sysadm/lifepreserver", "read/write"); } // - iocage if(QFile::exists("/usr/local/sbin/iocage")){ out->insert("sysadm/iocage", "read/write"); } // - Generic system information out->insert("sysadm/systeminfo","read/write"); // - PC-BSD Updater if(QFile::exists("/usr/local/bin/pc-updatemanager")){ out->insert("sysadm/update", "read/write"); } return RestOutputStruct::OK; } RestOutputStruct::ExitCode WebSocket::EvaluateBackendRequest(const RestInputStruct &IN, QJsonObject *out){ /*Inputs: "namesp" - namespace for the request "name" - name of the request "args" - JSON input arguments structure "out" - JSON output arguments structure */ QString namesp = IN.namesp.toLower(); QString name = IN.name.toLower(); //Go through and forward this request to the appropriate sub-system if(namesp=="rpc" && name=="query"){ return AvailableSubsystems(IN.fullaccess, out); }else if(namesp=="rpc" && name=="dispatcher"){ return EvaluateDispatcherRequest(IN.args, out); }else if(namesp=="sysadm" && name=="iocage"){ return EvaluateSysadmIocageRequest(IN.args, out); }else if(namesp=="sysadm" && name=="lifepreserver"){ return EvaluateSysadmLifePreserverRequest(IN.args, out); }else if(namesp=="sysadm" && name=="network"){ return EvaluateSysadmNetworkRequest(IN.args, out); }else if(namesp=="rpc" && name=="syscache"){ return EvaluateSyscacheRequest(IN.args, out); }else if(namesp=="sysadm" && name=="systeminfo"){ return EvaluateSysadmSystemInfoRequest(IN.args, out); }else if(namesp=="sysadm" && name=="update"){ return EvaluateSysadmUpdateRequest(IN.args, out); }else{ return RestOutputStruct::BADREQUEST; } } //==== SYSCACHE ==== RestOutputStruct::ExitCode WebSocket::EvaluateSyscacheRequest(const QJsonValue in_args, QJsonObject *out){ //syscache only needs a list of sub-commands at the moment (might change later) QStringList in_req; //Parse the input arguments structure if(in_args.isArray()){ in_req = JsonArrayToStringList(in_args.toArray()); } else if(in_args.isObject()){ QStringList keys = in_args.toObject().keys(); for(int i=0; iinsert(in_req[i],arr); }else{ out->insert(in_req[i],values[i]); } } //Return Success return RestOutputStruct::OK; } //==== DISPATCHER ==== RestOutputStruct::ExitCode WebSocket::EvaluateDispatcherRequest(const QJsonValue in_args, QJsonObject *out){ //dispatcher only needs a list of sub-commands at the moment (might change later) if(!AUTHSYSTEM->hasFullAccess(SockAuthToken)){ return RestOutputStruct::FORBIDDEN; //this user does not have permission to queue jobs } QStringList in_req; //Parse the input arguments structure if(in_args.isArray()){ in_req = JsonArrayToStringList(in_args.toArray()); } else if(in_args.isObject()){ QStringList keys = in_args.toObject().keys(); for(int i=0; iinsert(in_req[i],values[i]); } //Return Success return RestOutputStruct::OK; } //==== SYSADM -- Network ==== RestOutputStruct::ExitCode WebSocket::EvaluateSysadmNetworkRequest(const QJsonValue in_args, QJsonObject *out){ if(in_args.isObject()){ QStringList keys = in_args.toObject().keys(); bool ok = false; if(keys.contains("action")){ QString act = JsonValueToString(in_args.toObject().value("action")); if(act=="list-devices"){ ok = true; QStringList devs = sysadm::NetDevice::listNetDevices(); for(int i=0; iinsert(devs[i], obj); } } } //end of "action" key usage //If nothing done - return the proper code if(!ok){ return RestOutputStruct::BADREQUEST; } }else{ // if(in_args.isArray()){ return RestOutputStruct::BADREQUEST; } return RestOutputStruct::OK; } //==== SYSADM -- LifePreserver ==== RestOutputStruct::ExitCode WebSocket::EvaluateSysadmLifePreserverRequest(const QJsonValue in_args, QJsonObject *out){ if(in_args.isObject()){ QStringList keys = in_args.toObject().keys(); bool ok = false; if(keys.contains("action")){ QString act = JsonValueToString(in_args.toObject().value("action")); if(act=="addreplication"){ ok = true; out->insert("addreplication", sysadm::LifePreserver::addReplication(in_args.toObject())); } if(act=="cronscrub"){ ok = true; out->insert("cronscrub", sysadm::LifePreserver::scheduleScrub(in_args.toObject())); } if(act=="cronsnap"){ ok = true; out->insert("cronsnap", sysadm::LifePreserver::scheduleSnapshot(in_args.toObject())); } if(act=="initreplication"){ ok = true; out->insert("initreplication", sysadm::LifePreserver::initReplication(in_args.toObject())); } if(act=="listcron"){ ok = true; out->insert("listcron", sysadm::LifePreserver::listCron()); } if(act=="listreplication"){ ok = true; out->insert("listreplication", sysadm::LifePreserver::listReplication()); } if(act=="listsnap"){ ok = true; out->insert("listsnap", sysadm::LifePreserver::listSnap(in_args.toObject())); } if(act=="removereplication"){ ok = true; out->insert("removereplication", sysadm::LifePreserver::removeReplication(in_args.toObject())); } if(act=="removesnap"){ ok = true; out->insert("removesnap", sysadm::LifePreserver::removeSnapshot(in_args.toObject())); } if(act=="revertsnap"){ ok = true; out->insert("revertsnap", sysadm::LifePreserver::revertSnapshot(in_args.toObject())); } if(act=="runreplication"){ ok = true; out->insert("runreplication", sysadm::LifePreserver::runReplication(in_args.toObject())); } if(act=="savesettings"){ ok = true; out->insert("savesettings", sysadm::LifePreserver::saveSettings(in_args.toObject())); } if(act=="settings"){ ok = true; out->insert("settings", sysadm::LifePreserver::settings()); } } //end of "action" key usage //If nothing done - return the proper code if(!ok){ return RestOutputStruct::BADREQUEST; } }else{ // if(in_args.isArray()){ return RestOutputStruct::BADREQUEST; } return RestOutputStruct::OK; } //==== SYSADM -- SysInfo ==== RestOutputStruct::ExitCode WebSocket::EvaluateSysadmSystemInfoRequest(const QJsonValue in_args, QJsonObject *out){ if(in_args.isObject()){ QStringList keys = in_args.toObject().keys(); bool ok = false; if(keys.contains("action")){ QString act = JsonValueToString(in_args.toObject().value("action")); if(act=="batteryinfo"){ ok = true; out->insert("batteryinfo", sysadm::SysInfo::batteryInfo()); } if(act=="cpupercentage"){ ok = true; out->insert("cpupercentage", sysadm::SysInfo::cpuPercentage()); } if(act=="cputemps"){ ok = true; out->insert("cputemps", sysadm::SysInfo::cpuTemps()); } if(act=="externalmounts"){ ok = true; out->insert("externalmounts", sysadm::SysInfo::externalDevicePaths()); } if(act=="memorystats"){ ok = true; out->insert("memorystats", sysadm::SysInfo::memoryStats()); } if(act=="systeminfo"){ ok = true; out->insert("systeminfo", sysadm::SysInfo::systemInfo()); } } //end of "action" key usage //If nothing done - return the proper code if(!ok){ return RestOutputStruct::BADREQUEST; } }else{ // if(in_args.isArray()){ return RestOutputStruct::BADREQUEST; } return RestOutputStruct::OK; } //==== SYSADM -- Update ==== RestOutputStruct::ExitCode WebSocket::EvaluateSysadmUpdateRequest(const QJsonValue in_args, QJsonObject *out){ if(in_args.isObject()){ QStringList keys = in_args.toObject().keys(); bool ok = false; if(keys.contains("action")){ QString act = JsonValueToString(in_args.toObject().value("action")); if(act=="checkupdates"){ ok = true; out->insert("checkupdates", sysadm::Update::checkUpdates()); } if(act=="listbranches"){ ok = true; out->insert("listbranches", sysadm::Update::listBranches()); } } //end of "action" key usage //If nothing done - return the proper code if(!ok){ return RestOutputStruct::BADREQUEST; } }else{ // if(in_args.isArray()){ return RestOutputStruct::BADREQUEST; } return RestOutputStruct::OK; } //==== SYSADM -- iocage ==== RestOutputStruct::ExitCode WebSocket::EvaluateSysadmIocageRequest(const QJsonValue in_args, QJsonObject *out){ if(in_args.isObject()){ QStringList keys = in_args.toObject().keys(); bool ok = false; if(keys.contains("action")){ QString act = JsonValueToString(in_args.toObject().value("action")); if(act=="listjails"){ ok = true; out->insert("listjails", sysadm::Iocage::listJails()); } } //end of "action" key usage //If nothing done - return the proper code if(!ok){ return RestOutputStruct::BADREQUEST; } }else{ // if(in_args.isArray()){ return RestOutputStruct::BADREQUEST; } return RestOutputStruct::OK; }