Menu - Top - Home - Donate to Me

CBOR

NuGet Status

Download source code: ZIP file

If you like this software, consider donating to me at this link: http://peteroupc.github.io/


A C# implementation of Concise Binary Object Representation, a general-purpose binary data format defined in RFC 7049. According to that RFC, CBOR's data model "is an extended version of the JSON data model", supporting many more types of data than JSON. "CBOR was inspired by MessagePack", but "is not intended as a version of or replacement for MessagePack."

This implementation was written by Peter O. and is released to the Public Domain under the CC0 Declaration.

This implementation also doubles as a reader and writer of JSON, and can convert data from JSON to CBOR and back.

Finally, this implementation supports arbitrary-precision binary and decimal floating-point numbers and rational numbers with arbitrary-precision components.

Source code is available in the project page.

How to Install

Starting with version 0.21.0, the C# implementation is available in the NuGet Package Gallery under the name PeterO.Cbor. To install this library as a NuGet package, enter Install-Package PeterO.Cbor in the NuGet Package Manager Console.

Documentation

This library defines one class, called CBORObject, that allows you to read and write CBOR objects to and from data streams and byte arrays, and to convert JSON text to CBOR objects and back.

See the C# (.NET) API documentation.

The C# implementation is designed as a Portable Class Library.

Other Sites

Examples

Creating a map and converting that map to CBOR bytes and a JSON string:

// The following creates a CBOR map and adds
// several kinds of objects to it
var cbor = CBORObject.NewMap()
   .Add("item", "any string")
   .Add("number", 42)
   .Add("map", CBORObject.NewMap().Add("number", 42))
   .Add("array", CBORObject.NewArray().Add(999f).Add("xyz"))
   .Add("bytes", new byte[] { 0, 1, 2 });
// The following converts the map to CBOR
byte[] bytes = cbor.EncodeToBytes();
// The following converts the map to JSON
string json = cbor.ToJSONString();
Console.WriteLine(json);

Reading data from a file (C#). Note that all the examples for reading and writing to files assume that the platform supports file I/O; the portable class library doesn't make that assumption.

 // Read all the bytes from a file and decode the CBOR object
 // from it.  However, there are two disadvantages to this approach:
 // 1.  The byte array might be very huge, so a lot of memory to store
 // the array may be needed.
 // 2.  The decoding will succeed only if the entire array,
 // not just the start of the array, consists of a CBOR object.
 var cbor = CBORObject.DecodeFromBytes(File.ReadAllBytes("object.cbor"));

Another example of reading data from a file:

 // C#
 // Open the file stream
 using (var stream = new FileStream("object.cbor", FileMode.Open)) {
    // Read the CBOR object from the stream
    var cbor = CBORObject.Read(stream);
    // At this point, the object is read, but the file stream might
    // not have ended yet.  Here, the code may choose to read another
    // CBOR object, check for the end of the stream, or just ignore the
    // rest of the file.  The following is an example of checking for the
    // end of the stream.
    if (stream.Position != stream.Length) {
      // The end of the stream wasn't reached yet.
    } else {
      // The end of the stream was reached.
    }
 }

If a byte array contains multiple CBOR objects, the byte array should be wrapped in a MemoryStream and the stream used to read the objects, as DecodeFromBytes assumes the array contains only one CBOR object. Here is an example.

 // C#
 // Create a memory stream with a view of the byte array
 using (var stream = new MemoryStream(byteArray)) {
    // Read the CBOR object from the stream
    var cbor = CBORObject.Read(stream);
    // The rest of the example follows the one given above.
 }

Writing CBOR data to a file (C#):

// This example assumes that the variable "cbor" refers
// to a CBORObject object.
using (var stream = new FileStream("object.cbor", FileMode.Create)) {
   cbor.WriteTo(stream);
}

Writing multiple objects to a file, including arbitrary objects:

// C#
// This example writes different kinds of objects in CBOR
// format to the same file.
using (var stream = new FileStream("object.cbor", FileMode.Create)) {
   CBORObject.Write(true, stream);
   CBORObject.Write(422.5, stream);
   CBORObject.Write("some string", stream);
   CBORObject.Write(CBORObject.Undefined, stream);
   CBORObject.NewArray().Add(42).WriteTo(stream);
}

Reading JSON from a file:

 // Open the file stream
 using (var stream = new FileStream("object.json", FileMode.Open)) {
    // Read the JSON object from the stream
    // as a CBOR object
    var cbor = CBORObject.ReadJSON(stream);
 }

Writing a CBOR object as JSON:

// This example assumes that the variable "cbor" refers
// to a CBORObject object.
// NOTE: Specifying Encoding.UTF8 as the third parameter
// would add a byte order mark to the beginning of the text,
// but conforming JSON implementations are forbidden from
// adding it this way in JSON texts they generate.
File.WriteAllText(
  "object.json",
  cbor.ToJSONString(),
  new System.Text.Encoding.UTF8Encoding(false));

// This is an alternative way to write the CBOR object
// and is now supported in version 1.2.
using (var stream = new FileStream("object2.json", FileMode.Create)) {
    // Write the CBOR object as JSON; here, a byte order
    // mark won't be added
    cbor.WriteJSONTo(stream);
}
// Version 1.2 now supports a third way to write
// objects to JSON: the CBORObject.WriteJSON method
using (var stream = new FileStream("object3.json", FileMode.Create)) {
   CBORObject.WriteJSON("some string", stream);
}
using (var stream = new FileStream("object4.json", FileMode.Create)) {
   CBORObject.WriteJSON(cbor, stream);
}
using (var stream = new FileStream("object5.json", FileMode.Create)) {
   CBORObject.WriteJSON(true, stream);
}
using (var stream = new FileStream("object6.json", FileMode.Create)) {
   CBORObject.WriteJSON(42, stream);
}

NOTE: All code samples in this section are released to the Public Domain, as explained in http://creativecommons.org/publicdomain/zero/1.0/.

Demo

Go to https://github.com/peteroupc/Calculator for source code to a demo of the CBOR library in the form of a calculator.

About

Written in 2013-2014 by Peter O.

Any copyright is dedicated to the Public Domain. http://creativecommons.org/publicdomain/zero/1.0/

If you like this, you should donate to Peter O. at: http://peteroupc.github.io/CBOR/

Clarifications

The following are some clarifications to RFC 7049.

  • Section 2.4.2 doesn't specify what happens if a bignum's byte string has a length of 0. This implementation treats a positive bignum with length 0 as having a value of 0 and a negative bignum with length 0 as having a value of -1.
  • Section 2.4.1 specifies the number of seconds since the start of 1970. It is based on the POSIX definition of "seconds since the Epoch", which the RFC cites as a normative reference. This definition does not count leap seconds. When this implementation supports date conversion, it won't count leap seconds, either. This implementation treats values of infinity and NaN as invalid.
  • For tag 32, this implementation accepts strings that are valid Internationalized Resource Identifiers (IRIs) in addition to URIs. IRI are like URIs except that they also allow non-ASCII characters.

Release Notes

Version 2.5.2

  • Unlike version 2.4.2, signed CBOR assembly with a strong name key.
  • Unlike version 2.4.2, library uses strong-named version of PeterO.Numbers, version 0.4.0

Version 2.5.1

  • Release was erroneous.

Version 2.5

  • Release was erroneous.

Version 2.4.2

Version 2.4.1

Version 2.4.0

  • The arbitrary-precision classes in this library are being replaced with a new library (called PeterO.Numbers in C#). As a result, most of the methods in the existing classes are obsolete. This affects the classes BigInteger, ExtendedDecimal, ExtendedFloat, ExtendedRational, Rounding, PrecisionContext, and TrapException. Changes were made to those classes to call the new classes, and the behavior is mostly compatible with the previous behavior (with the notable exception of a new dependency in the CBOR library).
  • After version 2.3.1, the classes in the new library were greatly changed from what they were in version 2.3.1. Version 2.4.0 currently uses version 0.2 of the new library, but this may change in future versions. See the new library's release notes, and this repository's commit history (from "version 2.3.1" to "move big number library...") for details.
  • The FromObject method of the CBORObject class can now convert arbitrary-precision number objects from the new library appropriately, such as EInteger and EDecimal. However, there are no methods that directly take or return one of those classes, for compatibility with version 2.0.
  • Added Zero field and IsNegative property to the CBORObject class
  • Added overloads to ReadJSON and FromJSONString in CBORObject class
  • Added parameter in the ParseJSONNumber method of CBORDataUtilities to preserve negative zeros
  • Added CBOR decoding option to disable duplicate keys
  • Fixed JSON parsing bugs

Older Versions

In version 2.3.1:

  • Fixed NuGet package
  • No changes of note in the Java version

In version 2.3:

  • The C# version of the library now also targets "dotnet", which should make it compatible with platform .NET runtime environments such as the upcoming cross-platform "coreclr" runtime.
  • Added GetUtf8Bytes overload to DataUtilities
  • Fixed line break bug when setting lenientLineBreaks to true in the PeterO.Cbor.DataUtilities.WriteUtf8 method
  • In BigInteger, fixed divideAndRemainder method, added certain methods and made other methods obsolete
  • Many additions to the documentation
  • Other bug fixes

In version 2.2:

  • Portable Class Library compatibility expanded
  • Add option to always use definite length string encoding when generating CBOR objects

Known issue in version 2.2:

  • Setting lenientLineBreaks to true in the PeterO.Cbor.DataUtilities.WriteUtf8 method doesn't correctly write CR/LF line breaks. This will be fixed in a future version of the library.

In version 2.1:

  • Added Ulp, Precision, MovePointLeft, MovePointRight, and ScaleToPowerOfTwo/-Ten methods to ExtendedDecimal and ExtendedFloat
  • Fixed double-rounding issue with ToDouble and ToFloat methods of ExtendedDecimal
  • Added Odd and OddOrZeroFiveUp rounding modes
  • Added non-decimal base conversion features to BigInteger
  • Other bug fixes

In version 2.0:

  • Several very special characters are escaped in JSON output, such as line and paragraph separators, and byte order marks.
  • BigInteger's longValue method was fixed
  • BigInteger was changed to have no public constructors
  • ReadJSON now supports UTF-16 and UTF-32 in addition to UTF-8
  • PrecisionContext's JavaBigDecimal object was corrected.
  • Fixed bugs in parsing JSON numbers in some cases
  • CBORObject's one-argument Add method now adds CBORObject.Null if passed null, rather than throwing an exception.

NOTE: In the "2.0" tag for this repository, the file DataUtilities.cs should be copied from the PeterO directory to the root directory for this repository, in order for the CBORDocs and CBORDocs2 projects to build. This issue may probably exist in other older versions as well.

See History.md for release notes for older versions.

Specifications

Here are specifications by this implementation's author on proposed CBOR tags:

Acknowledgments

  • Carsten Bormann reviewed this library and gave helpful suggestions.
  • Anders Gustafsson converted this library to a Portable Class Library.

I thank all users who sent issues to this repository.