@lansweeper/data-platform-outbound-grpc 0.0.2

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@lansweeper/data-platform-outbound-grpc",
+  "version": "0.0.2",
+  "description": "Data Platform Outbound gRPC",
+  "main": "gen-proto/index.js",
+  "types": "gen-proto/index.d.ts",
+  "license": "MIT",
+  "dependencies": {
+    "@grpc/grpc-js": "^1.5.1",
+    "google-protobuf": "^3.17.0"
+  },
+  "gitHead": "d4a83e99adabaab53f138bfee7a5da579695c919"
+}

package/proto/outbound.proto

@@ -0,0 +1,372 @@
+/**
+ * Copyright Lansweper (c)
+ *
+ * This files contains
+ *
+ * https://github.com/pseudomuto/protoc-gen-doc
+ */
+syntax = "proto3";
+package com.lansweeper.dp.outboundapi.v1;
+
+import "google/protobuf/timestamp.proto";
+
+// ----- Service Part ------
+
+service DataCoreOutboundService {
+
+  // Retrieve a single entity by site/inst-id/type/id
+  rpc GetEntity (GetEntityRequest) returns (GetEntityResponse) {}
+
+  // lists entities for a site or site/type
+  rpc ListEntities(ListEntityRequest) returns (stream ListEntityResponse) {}
+
+}
+
+message GetEntityRequest {
+  EntityPath entity_path = 1;
+  // bool send_related = 2;      // send also related entities
+}
+
+message GetEntityResponse {
+  Entity entity = 1;
+  repeated Entity related = 2;
+}
+
+message ListEntityRequest {
+  EntityPath filter = 1; // minimum is for a site
+}
+
+message ListEntityResponse {
+  Entity entity = 1;
+  repeated Entity related = 2;
+}
+
+// ----- Data Part ------
+
+message EntityPath {
+  string site_id = 1;
+  optional string source_id = 2;
+  optional string source_type = 3; // IT, OT, CDK, 3rdParty
+  optional string entity_type = 4; // "asset" "user" etc
+  optional string entity_id = 5;
+}
+
+message Entity {
+  oneof entity {
+    Asset asset = 1;
+    // User user = 2;
+    // Other ...
+  }
+}
+
+message Asset {
+
+  EntityPath id = 1;
+
+  google.protobuf.Timestamp last_synced = 2;
+  google.protobuf.Timestamp first_seen = 3;
+  google.protobuf.Timestamp last_updated = 4;
+  google.protobuf.Timestamp last_enriched = 5;
+
+  CoreFields core = 6;
+
+  optional HardwareInfo hw = 7;
+  optional OperatingSystemInfo os = 8;
+  optional SoftwareInventory software_inventory = 9;
+
+  // Reconciliation future
+  //string entry_state = 2; // GOLDEN | ALIAS
+  //string master_type = 3; // NULL | ENGINE | USER
+  //optional int32 confidence = 4; // 1-100
+  //google.protobuf.Timestamp correlation_time = 5;
+  // DEDUP future
+
+}
+
+/**
+ * Asset Type enables customers to manage the settings for a
+ * category of information in a centralized, reusable way.
+ */
+message AssetType {
+  // Lansweeper Asset Type. Full list available here: /lansweeperapis/packages/model/masterData/content/masterData.json
+  string ls_name = 1;
+  // Fing Type
+  optional string fing_type = 2;
+}
+
+/**
+ *
+ */
+message CoreFields {
+  AssetType type = 1;
+  string name = 2;
+  optional string domain = 3;
+  optional string ip_address = 4;
+  optional string serial = 5;
+  optional string mac = 6;
+  optional string mac_vendor = 7;
+  optional string sensor_id = 8;
+}
+
+message HardwareInfo {
+  optional int64 type_id = 1;
+  optional int64 make_id = 2;
+  optional int64 model_id = 3;
+  optional int64 family_id = 4;
+  optional bool is_family = 6;
+  optional string serial = 7;
+  optional string type_name = 10;
+  optional string make_name = 11;
+  optional string model_name = 12;
+  optional string family_name = 13;
+
+  optional string cpe = 21;
+  optional int32 rank = 20;
+
+  optional CatalogBrand catalog_brand = 22;
+  optional CatalogModel catalog_model = 23;
+
+  optional RawHardwareInfo raw = 24;
+}
+
+message RawHardwareInfo {
+  optional string architecture = 1;
+  optional string model = 2;
+  optional string manufacturer = 3;
+  optional string serial_number = 4;
+}
+
+message OperatingSystemInfo {
+  optional int64 id = 1;
+  optional string name = 2;
+  optional string version = 3;
+  optional string build = 4;
+
+  optional string fw_version = 5;
+
+  optional string cpe = 6;
+  optional string fw_cpe = 7;
+
+  optional int32 rank = 8;
+
+  optional CatalogBrand catalog_brand = 9;
+  optional CatalogOs catalog_os = 10;
+
+  oneof raw {
+    WindowsRawOperatingSystemInfo windows = 32;
+  }
+}
+
+message WindowsRawOperatingSystemInfo {
+  optional string version = 1;
+  optional int32 service_pack = 2;
+  optional string build = 3;                // "WindowsVersion": "10.0.19045"
+  optional string version_name = 4;         // OsVersion": "22H2",
+  optional string build_number = 5;         // "OsBuildNumber": "2486",
+  optional int32 product_type = 6;          // WindowsProductType: 1
+
+  optional bool is_domain_controller = 7;
+  optional bool part_of_domain = 8;
+  optional bool is_azure_ad_joined = 9;
+
+  optional string os_code = 10;            // "OsCode": "10.0.19045" - with S if server
+}
+
+message SoftwareInventory {
+  google.protobuf.Timestamp timestamp = 1;
+  repeated Software software = 2;
+}
+
+message Software {
+
+  optional int32 rank = 1;
+  optional int64 type_id = 2;
+  optional int64 cat_id = 3;
+  optional int64 make_id = 4;
+  optional int64 sw_id = 5;
+  optional int64 parent_id = 6;
+
+  optional string type_name = 7;
+  optional string cat_name = 8;
+  optional string make_name = 9;
+  optional string name = 10;
+  optional string version = 11;
+  optional string market_ver = 12;
+  optional string edition = 13;
+  optional string build = 14;
+
+  optional string cpe = 15;
+
+  optional CatalogSoftware catalog_software = 16;
+
+  RawSoftware raw = 17;
+}
+
+message RawSoftware {
+  string name = 1;
+
+  optional string vendor = 2;
+  optional string version = 3;
+  optional string info = 4;
+  optional string exe_path = 5;
+  optional string arch = 6; // when available the specific sw arch
+  optional int64 install_date = 7;
+  optional string source_type = 8; // Registry | System | MsStore | Package | Custom | etc
+
+  optional string sw_id = 9; // optional SW id on the client side
+}
+
+// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< CATALOG ENTITIES >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+
+message CatalogBrand {
+  int64  id = 1;
+  string make_key = 2;
+  string make_name = 3;
+
+  optional int64 override_id = 4;
+  optional int64 parent_id = 18;
+  optional int64 last_update_time = 5;
+
+  optional string country_code = 6;
+  optional string logo_image_url = 7;
+  optional string banner_image_url = 8;
+  optional string wikipedia_id = 9;
+  optional string wikipedia_lang_code = 10;
+  optional string website_url = 11;
+  optional string support_url = 12;
+  optional string support_phone = 13;
+  optional string facebook_account = 14;
+  optional string twitter_account = 15;
+  optional string warranty_url = 16;
+  optional string warranty_direct_url = 17;
+  optional string community_url = 20;
+  optional string linkedin_account = 21;
+  optional string instagram_account = 22;
+  optional string youtube_account = 23;
+  optional string pinterest_account = 24;
+
+  optional bool class_hardware = 25;
+  optional bool class_software = 26;
+  optional bool class_consumer = 27;
+  optional bool class_enterprise = 28;
+  optional bool class_industrial = 29;
+  optional bool class_individual = 30;
+
+  optional int32 match_score = 19; // relevant only in search result
+}
+
+message CatalogModel {
+  int64 id = 1;
+  string key = 2;
+  int64 make_id = 3;
+  string device_model = 4;
+
+  optional string device_type = 5;
+  optional string device_model_code = 6;
+  optional int64 override_id = 7;
+
+  optional int64 os_default_id = 8;
+  optional int64 os_latest_id = 9;
+  optional int64 family_id = 10;
+  optional bool is_family = 11;
+  optional string manual_url = 12;
+  optional string faq_url = 13;
+  optional int64 release_date = 14;
+  optional int64 disc_date = 15;
+  optional int64 eos_date = 26;
+  optional string lifecyle_confidence = 29;
+
+  optional string price_class = 24;
+  optional string product_class = 25;
+
+  optional string sh_ifttt_handle = 17;
+  repeated string sh_google_ass_langs = 18;
+  repeated string sh_alexa_langs = 19;
+  optional string sh_hass_handle = 20;
+  optional bool   sh_apple_home_kit = 21;
+  optional string sh_open_hab_handle = 22;
+
+  optional string nist_cpe = 28;
+
+  optional double spread_in_type = 23;
+
+  optional int64 last_update_time = 16;
+
+  optional int32 match_score = 27; // filled only when a result of search
+}
+
+message CatalogOs {
+  int64 id = 1;
+  string os_key = 2;
+  string os_name = 3;
+
+  optional string os_version = 4;
+  optional string os_build = 12;
+  optional string os_version_name = 5;
+
+  optional int64 override_id = 6;
+  optional int64 make_id = 7;
+  optional int64 parent_id = 8;
+
+  optional int64 release_date = 9;
+  optional int64 eol_date = 10;
+  optional int64 eos_date = 22;
+  optional int64 eosx_date = 25;
+  optional string lifecyle_confidence = 26;
+  optional string logo_image_url = 13;
+  optional string banner_image_url = 14;
+  optional string wikipedia_id = 15;
+  optional string wikipedia_lang_code = 16;
+  optional string website_url = 17;
+  optional string support_url = 18;
+  optional string support_phone = 19;
+  optional string facebook_account = 20;
+  optional string twitter_account = 21;
+
+  optional string nist_cpe = 23;
+
+  optional int64 last_update_time = 11;
+
+  optional int32 match_score = 24; // filled only when a result of search
+}
+
+message CatalogSoftware {
+  int64 id = 1;
+  string sw_key = 2;
+  string sw_name = 3;
+
+  optional string sw_version = 4;
+  optional string sw_market_ver = 5;
+  optional string sw_edition = 6;
+  optional string sw_lang = 23;
+  optional string sw_build = 7;
+
+  optional int64 override_id = 8;
+  optional int64 make_id = 9;
+  optional int64 parent_id = 10;
+
+  optional string sw_type = 11;
+  optional string sw_category = 12;
+
+  optional string nist_cpe_template = 13;
+
+  optional int64 release_date = 14;
+  optional int64 eol_date = 15;
+  optional int64 eos_date = 16;
+  optional int64 eosx_date = 18;
+  optional string lifecyle_confidence = 19;
+
+  optional int64 last_update_time = 17;
+
+  optional bool flag_latest = 20;
+  optional bool flag_widespread = 21;
+  optional bool flag_deprecated = 22;
+
+  optional int32 match_score = 100; // filled only when a result of search
+}
+
+message CatalogMonitor {
+  int64  id = 1;
+
+}
+