summaryrefslogtreecommitdiff
path: root/lib/libcbor/README.md
diff options
context:
space:
mode:
authorDamien Miller <djm@cvs.openbsd.org>2019-11-14 21:11:36 +0000
committerDamien Miller <djm@cvs.openbsd.org>2019-11-14 21:11:36 +0000
commit026b04c43113033f1b763d5d26418ed1d6f78396 (patch)
tree037ba323b66906a3965e5c6c91158dc0ddbd5743 /lib/libcbor/README.md
parent2b318a24339d4b023a7b96f06e1a2fefbe4e9ca2 (diff)
Add libcbor; an implementation of the Concise Binary Object
Representation (CBOR) encoding format defined in RFC7049. This is a dependency of libfido2, that we'll use for U2F/FIDO support in OpenSSH. feedback and "Looks good enough to me" deraadt@
Diffstat (limited to 'lib/libcbor/README.md')
-rw-r--r--lib/libcbor/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/lib/libcbor/README.md b/lib/libcbor/README.md
new file mode 100644
index 00000000000..0b897564d03
--- /dev/null
+++ b/lib/libcbor/README.md
@@ -0,0 +1,50 @@
+# [libcbor](https://github.com/PJK/libcbor)
+
+[![Build Status](https://travis-ci.org/PJK/libcbor.svg?branch=master)](https://travis-ci.org/PJK/libcbor)
+[![Build status](https://ci.appveyor.com/api/projects/status/8kkmvmefelsxp5u2?svg=true)](https://ci.appveyor.com/project/PJK/libcbor)
+[![Documentation Status](https://readthedocs.org/projects/libcbor/badge/?version=latest)](https://readthedocs.org/projects/libcbor/?badge=latest)
+
+**libcbor** is a C library for parsing and generating [CBOR](http://tools.ietf.org/html/rfc7049), 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
+
+## Documentation
+Get the latest documentation at [libcbor.readthedocs.org](http://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](https://github.com/PJK/libcbor/graphs/contributors)!
+
+## License
+The MIT License (MIT)
+
+Copyright (c) Pavel Kalvoda, 2014–2017
+
+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.