GetInfectionSupplementaryData

Get the supplementary data for provided file path

Syntax

Method ID

#define WAAPI_MID_GET_INFECTION_SUPPLEMENTARY_DATA 80010

JSON Input Structure

{
  "input": {
    "method": 80010,
    "file_path": string
  }
}

Input Properties

Parameter	Type	Description
`file_path`	string	Path to the file

JSON Output Structure

{
  "result": {
    "method": 80010,
    "code": number,
    "timing": number,
    "timestamp": string,
    "supplementary_data_details": {
      "vendor_info": {
        "vendor_name": string,
        "oesis_vendor_id": string
      },
      "product_info": {
        "product_name": string,
        "oesis_product_id": string,
        "product_version": string,
        "oesis_signature_id": string,
        "categories": [
          {
            "category_name": string,
            "oesis_category_id": string
          },
          ...
        ]
      },
      "file_info": {
        "sha1": string,
        "file_name": string,
        "file_path": string,
        "file_property_version": string,
        "digital_signature": {
          "certificate_issued_to": string,
          "certificate_issued_by": string,
          "certificate_serial_number": string
        },
        "loaded_components": [
          string,
          ...
        ],
        "connections": [
          {
            "external_ip": string,
            "domain_name": string
          },
          ...
        ]
      }
    }
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.supplementary_data_details`	object	An object containing a collection of supplementary file details
`result.supplementary_data_details.vendor_info`	object	An object containing information about the vendor of the file
`result.supplementary_data_details.vendor_info.vendor_name`	string	Name of the vendor
`result.supplementary_data_details.vendor_info.oesis_vendor_id`	string	ID of the vendor in OESIS Framework database
`result.supplementary_data_details.product_info`	object	An object containing information about the product the requested file is associated with
`result.supplementary_data_details.product_info.product_name`	string	Name of the product
`result.supplementary_data_details.product_info.oesis_product_id`	string	ID of the product in OESIS Framework database
`result.supplementary_data_details.product_info.product_version`	string	Version of the product
`result.supplementary_data_details.product_info.oesis_signature_id`	string	Signature ID of the product in OESIS Framework database
`result.supplementary_data_details.product_info.categories`	array<object>	Categories that the product in question belongs to
`result.supplementary_data_details.product_info.categories.category_name`	string	Name of the category
`result.supplementary_data_details.product_info.categories.oesis_category_id`	string	Category ID of the product in OESIS Framework database
`result.supplementary_data_details.file_info`	object	An object containing information about the file
`result.supplementary_data_details.file_info.sha1`	string	File's SHA-1 hash value
`result.supplementary_data_details.file_info.file_name`	string	Name of the file
`result.supplementary_data_details.file_info.file_path`	string	Path of the file
`result.supplementary_data_details.file_info.file_property_version`	string	Property version of the file
`result.supplementary_data_details.file_info.digital_signature`	object	An object containing information about file's digital signature (including certificate data)
`result.supplementary_data_details.file_info.digital_signature.certificate_issued_to`	string	The identity of the entity to whom the certificate was issued
`result.supplementary_data_details.file_info.digital_signature.certificate_issued_by`	string	The identity of the authority which issued the certificate
`result.supplementary_data_details.file_info.digital_signature.certificate_serial_number`	string	Serial number of the certificate
`result.supplementary_data_details.file_info.loaded_components`	array<string>	Array of components' names associated with the file
`result.supplementary_data_details.file_info.connections`	array<object>	Connections associated with the specified file
`result.supplementary_data_details.file_info.connections.external_ip`	string	External IP address of the connection
`result.supplementary_data_details.file_info.connections.domain_name`	string	Domain name of the connection

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​