| commit | 624405dee9867cc5c43d0e811220ea69f7806b1a | [log] [tgz] |
|---|---|---|
| author | Laurence Lundblade <llundbla@qti.qualcomm.com> | Tue Sep 18 20:10:47 2018 -0700 |
| committer | Laurence Lundblade <llundbla@qti.qualcomm.com> | Tue Sep 18 20:10:47 2018 -0700 |
| tree | 18b152cba1c6f95f00aac0eaafac1aaecf0138c0 | |
| parent | 38ac74f87016972e5f7e3df2cc1b456d9f8fcba3 [diff] |
add MIT license; update README
QCBOR encodes and decodes RFC 7049 CBOR.
Implemented in C with minimal dependecy – Only dependencies are C99, stdint.h, stddef.h, stdbool.h and string.h making it highly portable. There are no #ifdefs.
Focused on C / native data representation – Simpler code because there is no support for encoding/decoding to/from JSON, pretty printing, diagnostic notation... Only encoding from native C representations and decoding to native C representations is supported.
Small simple memory model – Malloc is not used. The encode context is 128 bytes, decode context is 168 bytes and the description of decoded data item is 56 bytes. Stack use is very light and there is no recursion. The caller supplies the memory to hold the encoded CBOR and encode/decode contexts so caller has full control of memory usage and it is good for embedded implementations that have to run in small fixed memory.
Supports nearly all of RFC 7049 – Only minor, corner-case parts of RFC 7049 are not directly supported (canonicalization, decimal fractions, big floats) (indefinite length support is planned, but not ready yet).
Extensible and General – Provides a way to handle data types that are not directly supported.
Secure Coding Style – Uses a construct called UsefulBuf as a discipline for very safe coding the handling of binary data.
Small Code Size – When optimized for size using the compiler -Os option, x86 code is less than 5KB (~2KB encode, 2KB decode, 1KB common).
Clear documented public interface – The public interface is separated from the implementation. It can be put to use without reading the source.
QCBOR was originally developed by Qualcomm. It was open sourced through CAF with a permissive Linux license, September 2018 (thanks Qualcomm!).
This code in Laurence's GitHub has diverged some from the CAF source with some small simplifications and tidying up. The full test suite is not up and running and available in GitHub yet, so some caution is advised. This should be remedies soon.
The following modifications are planned:
These changes may result in some interface changes.
There are no makefiles or build scripts. You should be able to just incorprate the src and inc directories into your project with nothing more needed. The code should be portable enough to just compile and run.
The test directory includes some tests that are nearly as portable with a simple entry point. They can be handled the same way to verify the code is working correctly in your environment.