API

This section provides an overview of how the ESET PRIVATE Scanning Solutions operates, followed by detailed information about the API requirements required to develop a custom agent that interfaces with the scanner.

The communication between the custom agent and the scanner could be implemented using gRPC calls, defined primarily in the scanner.proto file. Most related message and type definitions are contained in the types.proto file.

•Scanner Agent → Scanner:

The scanner agent sends messages of type ScanFileDataStreamRequest to the scanner.

•Scanner → Scanner Agent:

The scanner responds with messages of type ScanFileDataStreamResponse.

This API structure facilitates streaming of scan data and responses, enabling efficient, real-time interaction between the agent and the scanner services.

What is proto file?

A .proto file defines the structure of data for Protocol Buggers (protobuf) - google's binary serialization format.

It uses a simple Interface Definition Language (IDL) to describe messages (like data classes/structs) with fields, types, and services. The protoc compiler then generates language-specific code (C++, Java, Python, etc.) for serialization/deserialization from these files.

For a complete list of protobuf files used by PRIVATE Scanning Solutions refer to the table below: