Skip to content
CBOR protocol implementation for C and others
Branch: master
Clone or download
Latest commit 87f977e Feb 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
demo
doc Add a vision writeup Feb 8, 2019
docs [Release] Update website to v0.5.0 Feb 5, 2017
doxygen-theme @ 46111c6 Doxygen config Apr 27, 2015
examples Reformat the world Feb 2, 2019
misc
src Correctly clean up in test Feb 2, 2019
test Hook tweak Feb 2, 2019
.clang-format Try to make legacy clang-format on Travis work Feb 2, 2019
.gitignore Add cmake-build-debug to gitignore Oct 1, 2017
.gitmodules Delete CMocka submodule Nov 6, 2016
.travis-qemu.sh
.travis.yml Testing travis c-f :( #1 Feb 2, 2019
CHANGELOG.md Bring back overflow guards for strings Feb 2, 2019
CMakeLists.txt
CNAME Create CNAME Feb 1, 2017
Doxyfile
LICENSE.md
README.md
appveyor.yml
clang-format.sh
cppcheck_suppressions.txt Reconfigure CPPcheck suppressions, take 2 May 16, 2015
refresh_templates.sh Update refresh_template with clang reformat Feb 2, 2019
release.sh

README.md

libcbor

Build Status Build status Documentation Status

libcbor is a C library for parsing and generating CBOR, the general-purpose schema-less binary data format.

Main features

  • Complete RFC conformance
  • Robust C99 implementation
  • Layered architecture offers both control and convenience
  • Flexible memory management
  • No shared global state - threading friendly
  • Proper handling of UTF-8
  • Full support for streams & incremental processing
  • Extensive documentation and test suite
  • No runtime dependencies, small footprint

Getting started

Compile from source

git clone https://github.com/PJK/libcbor
cmake -DCMAKE_BUILD_TYPE=Release -DCBOR_CUSTOM_ALLOC=ON libcbor
make
make install

Homebrew

brew tap pjk/libcbor
brew install libcbor

Ubuntu 18.04 and above

sudo add-apt-repository universe
sudo apt-get install libcbor-dev

Fedora & RPM friends

yum install libcbor-devel

Usage example

#include <cbor.h>
#include <stdio.h>

int main(int argc, char * argv[])
{
	/* Preallocate the map structure */
	cbor_item_t * root = cbor_new_definite_map(2);
	/* Add the content */
	cbor_map_add(root, (struct cbor_pair) {
		.key = cbor_move(cbor_build_string("Is CBOR awesome?")),
		.value = cbor_move(cbor_build_bool(true))
	});
	cbor_map_add(root, (struct cbor_pair) {
		.key = cbor_move(cbor_build_uint8(42)),
		.value = cbor_move(cbor_build_string("Is the answer"))
	});
	/* Output: `length` bytes of data in the `buffer` */
	unsigned char * buffer;
	size_t buffer_size,
		length = cbor_serialize_alloc(root, &buffer, &buffer_size);

	fwrite(buffer, 1, length, stdout);
	free(buffer);

	fflush(stdout);
	cbor_decref(&root);
}

Documentation

Get the latest documentation at libcbor.readthedocs.org

Contributions

All bug reports and contributions are welcome. Please see https://github.com/PJK/libcbor for more info.

Kudos to all the contributors!

License

The MIT License (MIT)

Copyright (c) Pavel Kalvoda, 2014–2019

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

You can’t perform that action at this time.