Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: proto.Messages

• optional Encrypted.Error error = 1

  Server MAY respond an error related to encryption

• optional bytes aes256cbc_sha512 = 2

  Format description: - 16B: Initialization Vector (this information does not need to be secret) All the following data is encrypted using AES-256 in CBC mode: - 64B: SHA-512 of message content (to check content integrity) - XB: message content - Byte-padding in [PKCS7](https://en.wikipedia.org/wiki/Padding_(cryptography)#PKCS7)

Used in: Encrypted

• optional Error.Code code = 1

Used in: Error

• NOT_SUPPORTED = 0

  Encryption is not supported for this format or key is not set

• REJECTED = 1

  Encryption process cannot end successfully, incorrect key ?

• INTERNAL_ERROR = 2

  An internal error occured during this message processing

Used in: proto.Message

• optional MessageV0.Request request = 1

• optional MessageV0.Response response = 2

• optional string message_id = 3

  If set of request, the same message message_id will be set for response This is particulary usefull to keep track when having several requests

Used in: Request

• optional string log_level = 1

  Change log level of application Valid values are 'none', 'error', 'warning', 'info' or 'debug'

Used in: Response

• optional uint64 start_date = 1

  Start date of application

• optional uint64 current_date = 2

  Current date of application

• optional uint64 request_counter = 3

  Request counter made to API

• optional string graph_dot = 4

  Representation of connected network bricks inside application This graphic is represented in DOT language.

Used in: Rule

• required string address = 1

  Address of CIDR (v4 or v6)

• required uint32 mask_size = 2

  Mask size Values MUST be between 0 and 32 for IPv4 Values MUST be between 0 and 128 for IPv6

Used in: Status

• optional string description = 1

• optional int32 err_no = 2

• optional string file = 3

• optional uint64 line = 4

• optional uint32 curs_pos = 5

• optional string function = 6

Used in: NicExportRes

• optional bytes data = 1

  Firewall data containing sessions

Used in: Request, Response

• required string id = 1

  Network Interface Card identifier

• required string mac = 2

  MAC-48 address separated by colons (:) in transmission order e.g. 52:54:00:00:d7:11

• required uint32 vni = 3

  24 bits Virtual Network Id, must be < 2^24

• repeated string ip = 4

  NIC can have several IP (v4 or/and v6)

• repeated string security_group = 5

  List of Security Group identifier

• optional bool ip_anti_spoof = 6

  IP anti-spoof (off by default) IP anti-spoof can only work if NIC has it's IP filled Note that MAC anti-spoof always ON

• optional string sniff_target_nic_id = 7

  Ask this NIC to sniff another If this option is set, all data from and to the targeted NIC will be mirrored to this NIC. Note this NIC won't be able to emit any packet to the outside. Setting this option disable any anti-spoof feature on this NIC. The option corresponds to the targeted NIC id. Warning: not implemented

• optional bool bypass_filtering = 8

  Bypass all filtering (off by default): - security groups won't affect this nic - antispoof protection won't operate - VM can send any packet, any mac, any ip

• optional Nic.Type type = 9

  Nic type

• optional string path = 10

  Nic path may be set depending of NIC's type

• optional bool packet_trace = 11

  dump VM traffic in pcap file

• optional string packet_trace_path = 12

  path to store pcap file

• optional string btype = 13

  if type is benchmark, the kind of bebnchmark you want to do ICMP-like-snd and ICMP-like-rcv are the only options avable now

• optional string dip = 14

  for benchmark, dip and dmac are dest mac and dest ip, same format as ip and mac

• optional string dmac = 15

Used in: Nic

• VHOST_USER_SERVER = 0

  A nic of type vhost-user acting as a server Butterfly will create a unix socket "path" in Nic object is set when requesting Nic details but it will be ignored at nic creation at the moment

• TAP = 1

• BENCH = 2

Used in: Response

• optional string path = 1

  Path to the created NIC socket vhost-user://UNIX_SOCKET_PATH

Used in: Response

• optional FwData fw_data = 1

NIC statistics

Used in: Response

• required uint64 in = 1

  Amount of data comming in the NIC expressed in bytes Note that value MAY overflow

• required uint64 out = 2

  Amount of data comming out of the NIC expressed in bytes Note that value MAY overflow

Used in: Request

• required string id = 1

  NIC id to update

• optional bool ip_anti_spoof = 2

  Update IP anti-spoof

• repeated string ip = 3

  Replace all IP of NIC To erase all ip, set a empty string

• repeated string security_group = 4

  Replace Security Groups of a NIC To remove all security groups, set a empty string

• optional bool packet_trace = 5

  Update dumping vm traffic in pcap file

• optional string packet_trace_path = 6

  path to store pcap file

Only one field must be filled in Request

Used in: MessageV0

• optional Nic nic_add = 1

  Create a NIC If a NIC already exists, old NIC will be removed Response MUST have nic_add filled

• optional NicUpdateReq nic_update = 2

  Update some informations of a NIC Will replaced provided values in corresponding NIC

• optional string nic_del = 3

  Remove a NIC by providing it's id

• optional bool nic_list = 4

  List all NICs (just NICs id) Can be true or false, it just have to be set Reponse MUST have nic_list filled

• optional string nic_details = 5

  List details of a specific NIC or all NIcs Ask details of a specific NIC by passing it's id Ask details of all NICs by passing an empty string Reponse MUST have nic_details filled

• optional string nic_export = 6

  Export firewall data, used for VM migration by giving it's id Reponse MUST have nic_export filled Warning: not implemented

• optional string nic_stats = 7

  Provide statistics about a particular NIC by giving it's id Reponse MUST have nic_stats filled

• optional Sg sg_add = 8

  Create or Replace a Security Group If Security Group does not exist, will create it If Security Group already exist, will replace it (rules and members)

• optional string sg_del = 9

  Delete a Security Group by giving it's id

• optional bool sg_list = 10

  List all Security Groups (just SGs id) Can be true or false, it just have to be set Response MUST have sg_list filled

• optional SgRuleAddReq sg_rule_add = 11

  Add rule to a Security Group Will create the corresponding Security Group if does not exists

• optional SgRuleDelReq sg_rule_del = 12

  Delete a rule from a Security Group

• optional string sg_rule_list = 13

  List all rules of a Security Group by giving it's id Reponse MUST have sg_rule_list filled

• optional SgMemberAddReq sg_member_add = 14

  Add a member (IP) to a Security Group Will create the corresponding Security Group if does not exists

• optional SgMemberDelReq sg_member_del = 15

  Delete a member (IP) from a Security Group

• optional string sg_member_list = 16

  List of all members of a specific Security Group by giving it's id Reponse MUST have sg_member_list filled

• optional bool app_status = 17

  Ask application status informations Can be true or false, it just have to be set Response MUST have app_status filled

• optional bool app_quit = 18

  Clean and quit Butterfly server Can be true or false, it just have to be set

• optional AppConfigReq app_config = 19

  Ask to configure some parameters in application

• optional string sg_details = 20

  List details of a specific SG or all SGs Ask details of a specific SG by passing it's id Ask details of all SGs by passing an empty string Reponse MUST have sg_details filled

Used in: MessageV0

• required Status status = 1

  Generic return status of a command

• optional NicAddRes nic_add = 2

  Reponse to a NIC creation

• repeated string nic_list = 3

  List of all NICs id

• repeated Nic nic_details = 4

  Details of one NIC or all NICs

• optional NicExportRes nic_export = 5

  Provide firewall data session of a NIC

• optional NicStats nic_stats = 6

  Provide stats of a NIC

• repeated string sg_list = 7

  List of all Security Groups identifiers

• repeated Rule sg_rule_list = 8

  List of all rules of a specific Security Group

• repeated string sg_member_list = 9

  List of all members IP of a specific Security Group

• optional AppStatusRes app_status = 10

  Status informations

• repeated Sg sg_details = 11

  Details of one SG or all SGs

Used in: Response, Sg, SgRuleAddReq, SgRuleDelReq

• required Rule.Direction direction = 1

• required int32 protocol = 2

  Protocol number. MUST be one of standard protocol number from http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml or MUST be -1 for all protocols Value range: 0-255 or -1 Hint: TCP:6 UDP:17

• optional uint32 port_start = 3

  Note that port_start and port_end are REQUIRED if used with TCP or UDP Port range start (for TCP or UDP only) If set, value MUST be between 0 and 65535 (included)

• optional uint32 port_end = 4

  Port range end (for TCP or UDP only) If set, value MUST be between 0 and 65535 (included)

• optional Cidr cidr = 5

  Note that only one parameter below is REQUIRED You cannot specify CIDR and security_group CIDR

• optional string security_group = 6

  Design members of a security group

Used in: Rule

• INBOUND = 0

  For packets comming in the NIC

• OUTBOUND = 1

  For packets comming out from the NIC Warning: not implemented

Used in: Request, Response

• required string id = 1

  Security Group identifier

• repeated string member = 2

  IP list of Security Group members

• repeated Rule rule = 3

  List of firewalling rules to apply

Used in: Request

• required string sg_id = 1

  Security group id

• required string member = 2

  Member's IP

Used in: Request

• required string sg_id = 1

  Security group id

• required string member = 2

  Member's IP

Used in: Request

• required string sg_id = 1

  Security group id

• required Rule rule = 2

  Rule description to add

Used in: Request

• required string sg_id = 1

  Security group id

• required Rule rule = 2

  Rule description to delete

Used in: Response

• required bool status = 1

  Set to true if there is no error, false otherwhise

• optional Error error = 2

  MAY be filled when status is false