Ubirch C/C++ Example

A full, runnable example for the ESP32 platform is located here.

The C/C++ implementation is a generic implementation and only depends on the availability of the required crypto functions ubirch-mbed-nacl-cm0 (for documentation, see Ed25519) and the ubirch-mbed-msgpack library (for documentation, see msgpack-c).

The ubirch-protocol follows the coding paradigm of the msgpack-c implementation:

create a buffer to write to (msgpack_sbuffer_new())
initialize the protocol and the msgpack packer (proto, pk)
write the protocol header (ubirch_protocol_start())
write payload (msgpack_pack_*())
finish the protocol (ubirch_protocol_finish())
send the data from the buffer
clean up (msgpack_sbuffer_clear(), ubirch_protocol_free())

A simple example to send a single signed message:

msgpack_sbuffer *sbuf = msgpack_sbuffer_new();
ubirch_protocol *proto = ubirch_protocol_new(proto_signed, TYPE, sbuf, msgpack_sbuffer_write, ed25519_sign, UUID); //TYPE = 0
msgpack_packer *pk = msgpack_packer_new(proto, ubirch_protocol_write);
ubirch_protocol_start(proto, pk);
// ADD YOUR PAYLOAD DATA HERE
msgpack_pack_int(pk, 99); // exemplary data
//
ubirch_protocol_finish(proto, pk);
// SEND THE MESSAGE (sbuf->data, sbuf->size)
msgpack_packer_free(pk);
ubirch_protocol_free(proto);

The corresponding chained message, where we connect subsequent messages using their signature is shown below:

msgpack_sbuffer *sbuf = msgpack_sbuffer_new();
ubirch_protocol *proto = ubirch_protocol_new(proto_chained, TYPE, sbuf, msgpack_sbuffer_write, ed25519_sign, UUID); //TYPE =  0
msgpack_packer *pk = msgpack_packer_new(proto, ubirch_protocol_write);

// FIRST MESSAGE
ubirch_protocol_start(proto, pk);
msgpack_pack_raw(pk, strlen(TEST_PAYLOAD));
msgpack_pack_raw_body(pk, TEST_PAYLOAD, strlen(TEST_PAYLOAD));
ubirch_protocol_finish(proto, pk);
// STORE THE CURRENT SIGNATURE (proto->signature, UBIRCH_PROTOCOL_SIGN_SIZE)
// SEND THE MESSAGE (sbuf->data, sbuf->size)
msgpack_sbuffer_clear(sbuf);

// SUBSEQUENT MESSAGE
memcpy(proto->signature, LAST_SIGNATURE, UBIRCH_PROTOCOL_SIGN_SIZE); // LOAD THE SIGNATURE INTO *proto
ubirch_protocol_start(proto, pk);
msgpack_pack_raw(pk, strlen("CHAINED"));
msgpack_pack_raw_body(pk, "CHAINED", strlen("CHAINED"));
ubirch_protocol_finish(proto, pk);
// STORE THE CURRENT SIGNATURE (proto->signature, UBIRCH_PROTOCOL_SIGN_SIZE)
// SEND THE MESSAGE (sbuf->data, sbuf->size)

msgpack_packer_free(pk);
ubirch_protocol_free(proto);

The response verification is described in the example-esp32: message response verification

Developer Pages

Ubirch

Ubirch Trust Protocol

Ubirch Nano Client

Ubirch Trust Service

Ubirch Console

Examples and Tutorials

Ubirch C/C++ Example