package nraySchema

Get desktop application:
View/edit binary Protocol Buffers messages

EnvironmentInformation tells the server under which circumstances nodes are running

Used in: Event

• string hostname = 1

• string os = 2

• string pid = 3

• string processname = 4

• string username = 5

• string cpumodelname = 6

Event is a container for everything that happens at a node and should later on be handled by EventHandlers

Used in: NodeRegister, WorkDone

• string nodeID = 1

• string nodeName = 2

• optional google.protobuf.Timestamp timestamp = 3

• string scannername = 6

• oneof EventData

  • EnvironmentInformation environment = 7

  • ScanResult result = 8

Node is going to exit

Used in: NrayNodeMessage

• string nodeID = 1

Server ACKs the goodbye and signals if the node is allowed to exit

Used in: NrayServerMessage

• bool ok = 1

A heartbeat message that is sent regularly from any node to the server to signal that it is still alive

Used in: NrayNodeMessage

• string NodeID = 1

• optional google.protobuf.Timestamp BeatTime = 2

Acknowledgement of a heartbeat message. A server may indicate to stop scanning and if the scanner should exit

Used in: NrayServerMessage

• bool Scanning = 1

• bool Running = 2

Contains more work for a scanner

Used in: NrayServerMessage

• uint64 batchid = 1

• optional ScanTargets targets = 3

Sent by a node if it has no work

Used in: NrayNodeMessage

• string NodeID = 1

This message is sent every time a node registers at the server. It contains a unique node ID so there are not multiple scanner nodes running on the same machine

Used in: NrayNodeMessage

• string machineID = 1

• int32 preferredPool = 2

• string preferredNodeName = 3

• optional Event envinfo = 4

Everything the nodes sends is packed in a nray node message

• oneof MessageContent

  • NodeRegister nodeRegister = 1

  • Heartbeat heartbeat = 2

  • MoreWorkRequest moreWork = 3

  • WorkDone workDone = 4

  • Goodbye goodbye = 5

Everything a server sends is packed in a nray server message

• oneof MessageContent

  • RegisteredNode registeredNode = 1

  • MoreWorkReply jobBatch = 2

  • HeartbeatAck heartbeatAck = 3

  • WorkDoneAck workDoneAck = 4

  • GoodbyeAck goodbyeAck = 5

  • Unregistered nodeIsUnregistered = 6

TCPScanResult contains the outcome of a TCP scan against a single port on a single host

Used in: ScanResult

• string target = 1

• uint32 port = 2

• bool open = 3

• string scantype = 4

• uint32 timeout = 5

This message tells the scanner that it is registered at the server and assigns a unique scanner ID as well as it carries the timestamp of the server, so nodes that have no correct clock can still perform somewhat accurate timestamping of events

Used in: NrayServerMessage

• string NodeID = 1

• optional google.protobuf.Timestamp ServerClock = 2

• bytes scannerconfig = 4

  int32 pool = 3;

Used in: Event

• string target = 4

• uint32 port = 5

• oneof result

  • PortScanResult portscan = 8

  • ZGrab2ScanResult zgrabscan = 9

ScanTargets may be dnsNames/ips and ports. ip is encoded as byte array. dnsName is a FQDN and mustn't contain a protocol specification

Used in: MoreWorkReply

• repeated string rhosts = 1

• repeated uint32 tcpports = 2

• repeated uint32 udpports = 3

This message is sent by the server and indicates that the server does not know this node and that the node should register again

Used in: NrayServerMessage

• string nodeID = 1

Indicates that a node is done with a work batch and contains the results

Used in: NrayNodeMessage

• string nodeID = 1

• uint64 batchid = 2

• repeated Event events = 3

Acknowledges a WorkDone packet

Used in: NrayServerMessage

(message has no fields)

Used in: ScanResult

• optional google.protobuf.Value jsonResult = 1