# BC Protocol This is an attempt to document the BC protocol. It is far from complete but should serve as a good basis for those wishing to develop apps for BC cameras. ## Messages Each message has the general format: - Header: 20-24 bytes - Message Body ### Header The header has the format: | magic | message id | message length | encryption offset | encrypt | unknown | message class | |--------------|--------------|----------------|-------------------|---------|---------|---------------| | f0 de bc 0a | 01 00 00 00 | 2c 07 00 00 | 00 00 00 01 | 01 | dc | 14 65 | - Magic 4 bytes - ID 4 bytes - Message length 4 bytes - Encryption offset 4 bytes - Encryption flag 1 byte - Unknown 1 byte - Message class 2 bytes Or | Magic | Message ID | Message Length | Encryption Offset | Status Code | Message Class | Binary Offset | |--------------|--------------|----------------|-------------------|-------------------|---------------|---------------| | f0 de bc 0a | 01 00 00 00 | 28 01 00 00 | 00 00 00 01 | c8 00 | 14 64 | 00 00 00 00 | - Magic 4 bytes - ID 4 bytes - Message length 4 bytes - Encryption offset 4 bytes - Status Code 2 bytes - Message class 2 bytes - Binary offset 4 bytes (Presence depend on message class) #### Magic The magic bytes for BC messages is always `f0 de bc 0a` for client <-> device. Or magic `a0 cd ed 0f` for device <-> device, eg NVR <-> IPC. When receiving packet these should be used to quickly discard invalid packets. #### Message ID Each function in BC has its own message ID. For example login is 1, video data is 3, motion detection is 33. For a more complete list please see the [messages doc](dissector/messages.md) #### Message length The message length contains the full length of the data to follow the header this includes both the XML and binary parts. #### Encryption offset The encryption offset is used as part of the decoding process. It is combined with the key to decrypt the data. Here is an example decrypter in rust ```rust const XML_KEY: [u8; 8] = [0x1F, 0x2D, 0x3C, 0x4B, 0x5A, 0x69, 0x78, 0xFF]; pub fn crypt(offset: u32, buf: &[u8]) -> Vec { let key_iter = XML_KEY.iter().cycle().skip(offset as usize % 8); key_iter .zip(buf) .map(|(key, i)| *i ^ key ^ (offset as u8)) .collect() } ``` In short the key is offset by the encryption offset in the header. Then each encrypted byte is paired with the offseted keys bytes (looping the offseted key as necessary). Then each byte is XORed with the paired key byte and the offset. The key is the same for all cameras. Older cameras do not use encryption and all messages are sent as plain text. The offset bytes are actually made up of other useful information channel_id 1 byte - NVR channel related to request/response or `00` if N/A. stream_id 1 byte - `00`=clear, `01`=fluent, `04`=balanced unknown 1 byte - Always `00` message_handle 1 byte - client increments per request, replies use request handle #### Encryption Flag This flag is 0 for unencrypted or non zero for encrypted. Clients should decide to use encryption or not based on this byte that the camera sent during login. Then should use that same setting for all further messages with the camera. #### Unknown The purpose of this byte is unknown. Observed - `dc` = client request, `dd` = device reply If you figure out what it does please submit a PR. #### Status Code In a request this is set to `00 00`. In a reply this is a http style response code. `c8 00` = 200 OK `90 01` = 400 Bad Request #### Message class The message class determines the length of the header. The following classes and header lengths are known. - 0x6514: "legacy" 20 bytes - 0x6614: "modern" 20 bytes - 0x6414: "modern" 24 bytes - 0x0000: "modern" 24 bytes #### Binary offset For messages that contain the binary offset field this represents where to start the binary part of the message. The total length of XML + binary is equal to the message length in the header so Binary Offset is total_length - this_offset. Where as this field also represents the end of the XML part of the message. Some messages seems to not set this field correctly. For example message ID 1 sets this to zero meaning that all data in the message is binary, however it contains XML. This best way to tell is this is binary or XML is to check the message ID and determine from there. Alternatively you could look for ` 0 0 mainStream ``` streamType can be either - `mainStream` in which case it will be HD - `subStream` in which case it will be SD channelId is part of the NVR when multiple cameras use the same IP. In this case each camera has its own channelId. Not sure what handle does. The reply is first a message with the following xml ```xml 1 ``` After which all message bodies of type id 3 are binary. The binary represents a stream of data. It can be interrupted by packet boundaries. Clients should create a buffer and pop bytes for processing when complete media packets are received. Media packets descriptions can be found in the [docs](dissector/mediapacket.md) # Other Function Other data can be received from the camera by sending the appropriate header to the camera. For example sending the header for ID 78 | Magic | Message ID | Message Length | Encryption Offset | Status Code | Message Class | Binary Offset | |--------------|--------------|----------------|-------------------|-------------------|---------------|---------------| | f0 de bc 0a | 4e 00 00 00 | d3 00 00 00 | 08 db 9c 00 | c8 00 | 00 00 | 00 00 00 00 | The camera will reply with an xml with brightness and contrast ```xml 0 128 128 128 128 ``` Some message IDs also require input along with the request header. For example ID 151 which is the users ability info requires the header | Magic | Message ID | Message Length | Encryption Offset | Status Code | Message Class | Binary Offset | |--------------|--------------|----------------|-------------------|-------------------|---------------|---------------| | f0 de bc 0a | 97 00 00 00 | a7 00 00 00 | 00 00 00 02 | 00 00 | 14 64 | a7 00 00 00 | and the body of ```xml ... system, network, alarm, record, video, image ``` Which contains the plain text of the username of interest and the tokens for abilities you want to know about. Details of expected formats should be found from the [docs](dissector/messages.md)