|author||Jim Schaad <email@example.com>||Sat Jan 09 12:22:00 2016 -0800|
|committer||Jim Schaad <firstname.lastname@example.org>||Sat Jan 09 12:22:00 2016 -0800|
Start expanding the readme text
This project is a C implementation of the IETF CBOR Encoded Mesage Syntax (COSE). There are currently two versions of the COSE document that can be read. The most current work in progress draft can be found on github in the cose-wg/cose-spec project. The IETF also keeps a copy of the spec in the COSE WG.
The project is using OpenSSL for the cryptographic primatives.
Go ahead, file issues, make pull requests.
The project is setup to build using CMake. The way that the CMake files are setup, itrequires that version 3.0 or higher is used.
The project requires the use of cn-cbor(https://github.com/cabo/cn-cbor) in order to build. The CMake configuration files will automatically pull down the correct version when run.
The memory model used in this library is a mess. This is in large part because the memory model of cn-cbor is still poorly understood.
There are three different memory models that can be used with cn-cbor and cose-c, at this time only one of them is going to produce good results for long running systems.
The cn-cbor project was built with a specific memory model, but did not limit itself to that memory model when writing the code. It was originally designed for working on small devices that use a block allocater with suballocations done from that allocated block. This allows for all of the items allocated in that large block to be freed in a single operation when everything is done.
Build without USE_CONTEXT: This model uses standard calloc/free and suffers from the cn-cbor memory model problems.
Build with USE_CONTEXT and pass in NULL: This model is equivalent to the previous configuration.
Build with USE_CONTEXT and pass in a block allocator: This model works, but requires that you provide the allocator.