Google Git
Sign in
pigweed / third_party / github / cose-wg / COSE-C / 0dc732a13e4a45bfbf5a205253a8d75f9299736c
commit0dc732a13e4a45bfbf5a205253a8d75f9299736c[log] [tgz]
authorCarlos Gomes Martinho <kmartinho8@gmail.com>Wed Apr 22 22:05:55 2020 +0200
committerJim Schaad <ietf@augustcellars.com>Thu Apr 23 07:50:41 2020 -0700
tree1953acab477904bc5eb072a8d35141206adbe537
parentf0757d1469ea33e5837c9485667d0b5df2a46879 [diff]
ci: do not build shared libs under windows
1 file changed
tree: 1953acab477904bc5eb072a8d35141206adbe537
  1. .ci/
  2. .github/
  3. cmake/
  4. dumper/
  5. include/
  6. scripts/
  7. src/
  8. test/
  9. .appveyor.yml
  10. .clang-tidy
  11. .gitignore
  12. .mbedignore
  13. .travis.yml
  14. build.sh
  15. cmake-format.yaml
  16. CMakeLists.txt
  17. conanfile.txt
  18. Coverity_Model.c
  19. Doxyfile.in
  20. LICENSE
  21. README.md
README.md

COSE-C Implementation Build Status Coverage Status Coverity Status

This project is a C implementation of the IETF CBOR Encoded Message Syntax (COSE). COSE has reached RFC status and is now available at RFC 8152.

In addition to the core document the following have also become RFCs:

  • RFC 8230 How to use RSA algorithms with COSE.

The project is using the CN-CBOR project to provide an implementation of the Concise Binary Object Representation or CBOR.

The project is setup to use two different cryptographic

  • OpenSSL - This is a reasonable complete implementation
  • MbedTLS - Not all cryptographic primitives have been linked between COSE and the library yet.

Contributing

Go ahead, file issues, make pull requests.

before committing changes, run ./scripts/format_code.sh

Building

The project is setup to build using CMake. The way that the CMake files are setup, it requires that version 3.0 or higher is used.

The project requires the use of cn-cbor(https://github.com/jimsch/cn-cbor) in order to build. While this is based on the original version at (https://github.com/cabo/cn-cbor) there have been several updates to this version which have not been reflected in the base library. The CMake configuration files will automatically pull down the correct version when run.

Building:

mkdir build
cd build
cmake ..
cmake --build .
# if user wants to install
sudo cmake --build . --target install

Consuming via cmake find_package (after installation):

find_package(cose-c REQUIRED)
add_executable(mytarget main.cpp)
target_link_libraries(mytarget cose-c::cose-c)

Consuming via cmake add_subdirectory (e.g. as a submodule):

add_subdirectory(vendor/cose-c)
add_executable(mytarget main.cpp)
target_link_libraries(mytarget cose-c::cose-c)

Consuming via conan package: add cose-c/[>=20200417] to your conanfile.txt

add_executable(mytarget main.cpp)
target_link_libraries(mytarget cose-c::cose-c)

Memory Model

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 allocator with sub-allocations 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.