mirror of
https://github.com/Telecominfraproject/wlan-cloud-ucentralgw.git
synced 2025-11-03 20:27:45 +00:00
b3deba5606
https://telecominfraproject.atlassian.net/browse/OLS-246 Summary of changes: - Added `cablediagnostics` command. Signed-off-by: Ivan Chvets <ivan.chvets@kinarasystems.com>
551 lines
14 KiB
C++
551 lines
14 KiB
C++
//
|
|
// License type: BSD 3-Clause License
|
|
// License copy: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE
|
|
//
|
|
// Created by Stephane Bourque on 2021-03-04.
|
|
// Arilia Wireless Inc.
|
|
//
|
|
|
|
#pragma once
|
|
|
|
#include "Poco/JSON/Object.h"
|
|
#include "RESTAPI_SecurityObjects.h"
|
|
|
|
#ifdef TIP_GATEWAY_SERVICE
|
|
#include <RADIUS_helpers.h>
|
|
#endif
|
|
|
|
namespace OpenWifi::GWObjects {
|
|
|
|
enum CertificateValidation { NO_CERTIFICATE, VALID_CERTIFICATE, MISMATCH_SERIAL, VERIFIED, SIMULATED };
|
|
|
|
struct ConnectionState {
|
|
uint64_t MessageCount = 0;
|
|
std::string Address;
|
|
uint64_t UUID = 0;
|
|
uint64_t PendingUUID = 0;
|
|
uint64_t TX = 0, RX = 0;
|
|
uint64_t Associations_2G = 0;
|
|
uint64_t Associations_5G = 0;
|
|
uint64_t Associations_6G = 0;
|
|
bool Connected = false;
|
|
uint64_t LastContact = 0;
|
|
std::string Firmware;
|
|
CertificateValidation VerifiedCertificate = NO_CERTIFICATE;
|
|
std::string Compatible;
|
|
uint64_t kafkaClients = 0;
|
|
uint64_t webSocketClients = 0;
|
|
uint64_t kafkaPackets = 0;
|
|
uint64_t websocketPackets = 0;
|
|
std::string locale;
|
|
uint64_t started = 0;
|
|
uint64_t sessionId = 0;
|
|
double connectionCompletionTime = 0.0;
|
|
std::uint64_t certificateExpiryDate = 0;
|
|
std::uint64_t hasRADIUSSessions = 0;
|
|
bool hasGPS = false;
|
|
std::uint64_t sanity=0;
|
|
std::double_t memoryUsed=0.0;
|
|
std::double_t load=0.0;
|
|
std::double_t temperature=0.0;
|
|
std::string connectReason;
|
|
std::uint64_t uptime=0;
|
|
std::uint64_t totalConnectionTime=0;
|
|
|
|
void to_json(const std::string &SerialNumber, Poco::JSON::Object &Obj) ;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct DeviceRestrictionsKeyInfo {
|
|
std::string vendor;
|
|
std::string algo;
|
|
|
|
bool operator!=(const DeviceRestrictionsKeyInfo &b) const;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct DeviceRestrictions {
|
|
bool dfs = false;
|
|
bool ssh = false;
|
|
bool rtty = false;
|
|
bool tty = false;
|
|
bool developer = false;
|
|
bool upgrade = false;
|
|
bool commands = false;
|
|
std::vector<std::string> country;
|
|
DeviceRestrictionsKeyInfo key_info;
|
|
|
|
bool operator!=(const DeviceRestrictions &D) const;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct Device {
|
|
std::string SerialNumber;
|
|
std::string DeviceType;
|
|
std::string MACAddress;
|
|
std::string Manufacturer;
|
|
std::string Configuration;
|
|
SecurityObjects::NoteInfoVec Notes;
|
|
std::string Owner;
|
|
std::string Location;
|
|
std::string Firmware;
|
|
std::string Compatible;
|
|
std::string FWUpdatePolicy;
|
|
uint64_t UUID = 0;
|
|
uint64_t CreationTimestamp = 0;
|
|
uint64_t LastConfigurationChange = 0;
|
|
uint64_t LastConfigurationDownload = 0;
|
|
uint64_t LastFWUpdate = 0;
|
|
std::string Venue;
|
|
std::string DevicePassword;
|
|
std::string subscriber;
|
|
std::string entity;
|
|
uint64_t modified = 0;
|
|
std::string locale;
|
|
bool restrictedDevice = false;
|
|
std::string pendingConfiguration;
|
|
std::string pendingConfigurationCmd;
|
|
DeviceRestrictions restrictionDetails;
|
|
std::uint64_t pendingUUID = 0;
|
|
bool simulated=false;
|
|
std::uint64_t lastRecordedContact=0;
|
|
std::uint64_t certificateExpiryDate = 0;
|
|
std::string connectReason;
|
|
bool blackListed=false;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
void to_json_with_status(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
void Print() const;
|
|
};
|
|
|
|
struct DeviceConnectionStatistics {
|
|
std::uint64_t connectedDevices = 0;
|
|
std::uint64_t averageConnectionTime = 0;
|
|
std::uint64_t connectingDevices = 0;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct Statistics {
|
|
std::string SerialNumber;
|
|
uint64_t UUID = 0;
|
|
std::string Data;
|
|
uint64_t Recorded = 0;
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct HealthCheck {
|
|
std::string SerialNumber;
|
|
uint64_t UUID = 0;
|
|
std::string Data;
|
|
uint64_t Recorded = 0;
|
|
uint64_t Sanity = 0;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct Capabilities {
|
|
std::string Capabilities;
|
|
uint64_t FirstUpdate = 0;
|
|
uint64_t LastUpdate = 0;
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct DeviceLog {
|
|
enum Level {
|
|
LOG_EMERG = 0, /* system is unusable */
|
|
LOG_ALERT = 1, /* action must be taken immediately */
|
|
LOG_CRIT = 2, /* critical conditions */
|
|
LOG_ERR = 3, /* error conditions */
|
|
LOG_WARNING = 4, /* warning conditions */
|
|
LOG_NOTICE = 5, /* normal but significant condition */
|
|
LOG_INFO = 6, /* informational */
|
|
LOG_DEBUG = 7 /* debug-level messages */
|
|
};
|
|
std::string SerialNumber;
|
|
std::string Log;
|
|
std::string Data;
|
|
uint64_t Severity = 0;
|
|
uint64_t Recorded = 0;
|
|
uint64_t LogType = 0;
|
|
uint64_t UUID = 0;
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct DefaultConfiguration {
|
|
std::string name;
|
|
std::string configuration;
|
|
Types::StringVec models;
|
|
std::string description;
|
|
uint64_t created;
|
|
uint64_t lastModified;
|
|
std::string platform;
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct DefaultFirmware {
|
|
std::string deviceType;
|
|
std::string Description;
|
|
std::string uri;
|
|
std::string revision;
|
|
uint64_t imageCreationDate;
|
|
uint64_t Created;
|
|
uint64_t LastModified;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct DefaultFirmwareList {
|
|
std::vector<DefaultFirmware> firmwares;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct CommandDetails {
|
|
std::string UUID;
|
|
std::string SerialNumber;
|
|
std::string Command;
|
|
std::string Status;
|
|
std::string SubmittedBy;
|
|
std::string Results;
|
|
std::string Details;
|
|
std::string ErrorText;
|
|
uint64_t Submitted = time(nullptr);
|
|
uint64_t Executed = 0;
|
|
uint64_t Completed = 0;
|
|
uint64_t RunAt = 0;
|
|
uint64_t ErrorCode = 0;
|
|
uint64_t Custom = 0;
|
|
uint64_t WaitingForFile = 0;
|
|
uint64_t AttachDate = 0;
|
|
uint64_t AttachSize = 0;
|
|
std::string AttachType;
|
|
double executionTime = 0.0;
|
|
std::uint64_t lastTry = 0;
|
|
bool deferred = false;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct BlackListedDevice {
|
|
std::string serialNumber;
|
|
std::string reason;
|
|
std::string author;
|
|
uint64_t created;
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct RttySessionDetails {
|
|
std::string SerialNumber;
|
|
std::string Server;
|
|
uint64_t Port = 0;
|
|
std::string Token;
|
|
uint64_t TimeOut = 0;
|
|
std::string ConnectionId;
|
|
uint64_t Started = 0;
|
|
std::string CommandUUID;
|
|
uint64_t ViewPort = 0;
|
|
std::string DevicePassword;
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct Dashboard {
|
|
uint64_t snapshot = 0;
|
|
uint64_t numberOfDevices = 0;
|
|
Types::CountedMap commands;
|
|
Types::CountedMap upTimes;
|
|
Types::CountedMap memoryUsed;
|
|
Types::CountedMap load1;
|
|
Types::CountedMap load5;
|
|
Types::CountedMap load15;
|
|
Types::CountedMap vendors;
|
|
Types::CountedMap status;
|
|
Types::CountedMap deviceType;
|
|
Types::CountedMap healths;
|
|
Types::CountedMap certificates;
|
|
Types::CountedMap lastContact;
|
|
Types::CountedMap associations;
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
void reset();
|
|
};
|
|
|
|
struct CapabilitiesModel {
|
|
std::string deviceType;
|
|
std::string capabilities;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct ScriptEntry {
|
|
std::string id;
|
|
std::string name;
|
|
std::string description;
|
|
std::string uri;
|
|
std::string content;
|
|
std::string version;
|
|
std::string type;
|
|
std::uint64_t created;
|
|
std::uint64_t modified;
|
|
std::string author;
|
|
Types::StringVec restricted;
|
|
bool deferred = false;
|
|
std::uint64_t timeout = 30;
|
|
std::string defaultUploadURI;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct ScriptEntryList {
|
|
std::vector<ScriptEntry> scripts;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct ScriptRequest {
|
|
std::string serialNumber;
|
|
uint64_t timeout = 30;
|
|
std::string type;
|
|
std::string script;
|
|
std::string scriptId;
|
|
std::uint64_t when;
|
|
std::string signature;
|
|
bool deferred;
|
|
std::string uri;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct RadiusProxyServerEntry {
|
|
std::string name;
|
|
std::string ip;
|
|
uint16_t port = 0;
|
|
uint64_t weight = 0;
|
|
std::string secret;
|
|
std::string certificate;
|
|
bool radsec = false;
|
|
bool allowSelfSigned = false;
|
|
uint16_t radsecPort = 2083;
|
|
std::string radsecSecret;
|
|
std::string radsecKey;
|
|
std::string radsecCert;
|
|
std::vector<std::string> radsecCacerts;
|
|
std::vector<std::string> radsecRealms;
|
|
bool ignore = false;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct RadiusProxyServerConfig {
|
|
std::string strategy;
|
|
bool monitor = false;
|
|
std::string monitorMethod;
|
|
std::vector<std::string> methodParameters;
|
|
std::vector<RadiusProxyServerEntry> servers;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct RadiusProxyPool {
|
|
std::string name;
|
|
std::string description;
|
|
RadiusProxyServerConfig authConfig;
|
|
RadiusProxyServerConfig acctConfig;
|
|
RadiusProxyServerConfig coaConfig;
|
|
bool useByDefault = false;
|
|
std::string radsecPoolType;
|
|
std::string poolProxyIp;
|
|
std::uint64_t radsecKeepAlive=25;
|
|
bool enabled=true;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct RadiusProxyPoolList {
|
|
std::vector<RadiusProxyPool> pools;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct RangeOptions {
|
|
bool NO_IR=false;
|
|
bool AUTO_BW=false;
|
|
bool DFS=false;
|
|
bool NO_OUTDOOR=false;
|
|
bool wmmrule_ETSI=false;
|
|
bool NO_OFDM=false;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct FrequencyRange {
|
|
float from = 0.0;
|
|
float to = 0.0;
|
|
int channelWidth = 0;
|
|
int powerDb = 0;
|
|
RangeOptions options;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct RegulatoryCountryInfo {
|
|
std::string country;
|
|
std::string domain;
|
|
std::vector<FrequencyRange> ranges;
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
using RegulatoryInfoCountryMap = std::map<std::string,RegulatoryCountryInfo>;
|
|
|
|
struct RADIUSSession {
|
|
std::uint64_t started=0,
|
|
lastTransaction=0;
|
|
std::string serialNumber,
|
|
destination,
|
|
userName,
|
|
accountingSessionId,
|
|
accountingMultiSessionId,
|
|
callingStationId,
|
|
chargeableUserIdentity,
|
|
secret,
|
|
interface,
|
|
nasId;
|
|
std::uint64_t inputPackets = 0,
|
|
outputPackets = 0,
|
|
inputOctets = 0,
|
|
outputOctets = 0,
|
|
inputGigaWords = 0,
|
|
outputGigaWords = 0;
|
|
std::uint32_t sessionTime = 0;
|
|
std::string calledStationId;
|
|
|
|
#ifdef TIP_GATEWAY_SERVICE
|
|
RADIUS::RadiusPacket accountingPacket;
|
|
#endif
|
|
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct RADIUSSessionList {
|
|
std::vector<RADIUSSession> sessions;
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
struct RadiusCoADMParameters {
|
|
std::string accountingSessionId,
|
|
accountingMultiSessionId,
|
|
callingStationId,
|
|
chargeableUserIdentity,
|
|
userName;
|
|
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
void to_json(Poco::JSON::Object &Obj) const;
|
|
};
|
|
|
|
enum class RadiusPoolStrategy {
|
|
round_robin, random, weighted, unknown
|
|
};
|
|
|
|
enum class RadiusEndpointType {
|
|
generic, radsec, globalreach, orion, unknown
|
|
};
|
|
|
|
static inline RadiusEndpointType RadiusEndpointType(const std::string &T) {
|
|
if(T=="generic") return RadiusEndpointType::generic;
|
|
if(T=="radsec") return RadiusEndpointType::radsec;
|
|
if(T=="globalreach") return RadiusEndpointType::globalreach;
|
|
if(T=="orion") return RadiusEndpointType::orion;
|
|
return RadiusEndpointType::unknown;
|
|
}
|
|
|
|
static inline RadiusPoolStrategy RadiusPoolStrategy(const std::string &T) {
|
|
if(T=="round_robin") return RadiusPoolStrategy::round_robin;
|
|
if(T=="random") return RadiusPoolStrategy::random;
|
|
if(T=="weighted") return RadiusPoolStrategy::weighted;
|
|
return RadiusPoolStrategy::unknown;
|
|
}
|
|
|
|
static inline std::string to_string(enum RadiusEndpointType T) {
|
|
switch(T) {
|
|
case RadiusEndpointType::generic: return "generic";
|
|
case RadiusEndpointType::radsec: return "radsec";
|
|
case RadiusEndpointType::globalreach: return "globalreach";
|
|
case RadiusEndpointType::orion: return "orion";
|
|
default:
|
|
return "unknown";
|
|
}
|
|
}
|
|
|
|
static inline std::string to_string(enum RadiusPoolStrategy T) {
|
|
switch(T) {
|
|
case RadiusPoolStrategy::round_robin: return "round_robin";
|
|
case RadiusPoolStrategy::random: return "random";
|
|
case RadiusPoolStrategy::weighted: return "weighted";
|
|
default:
|
|
return "unknown";
|
|
}
|
|
}
|
|
|
|
struct DeviceTransferRequest {
|
|
std::string serialNumber;
|
|
std::string server;
|
|
std::uint64_t port;
|
|
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct DeviceCertificateUpdateRequest {
|
|
std::string serialNumber;
|
|
std::string encodedCertificate;
|
|
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct PowerCyclePort {
|
|
std::string name;
|
|
std::uint64_t cycle=10000;
|
|
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
|
|
struct PowerCycleRequest {
|
|
std::string serialNumber;
|
|
std::uint64_t when;
|
|
std::vector<PowerCyclePort> ports;
|
|
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
struct FixedConfig {
|
|
std::string serialNumber;
|
|
std::string country;
|
|
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
struct CableDiagnostics {
|
|
std::string serialNumber;
|
|
std::uint64_t when;
|
|
std::vector<std::string> ports;
|
|
|
|
bool from_json(const Poco::JSON::Object::Ptr &Obj);
|
|
};
|
|
} // namespace OpenWifi::GWObjects
|