The secure data format for a modern world
Times are different from the carefree days that brought us XML and JSON:
State actors, criminal organizations and mercenaries are now actively hacking governments, companies and individuals to steal secrets, plant malware, and hold your data hostage.
The existing ad-hoc data formats are too loosely defined to be secure, and can't be fixed because they're not versioned.
Concise Encoding is designed for security, and is versioned so that it can be updated to handle new threats.
We send so much data now that efficiency is critical, but switching to binary means giving up the ease of text formats.
... or does it?
Concise Encoding gives you ease and efficiency with its 1:1 compatible text and binary formats.
Lack of types forces everyone to add extra encoding steps to send their data, which is buggy, reduces compatibility, and opens even more security holes.
We live in the 21st century - base64 should be a footnote in history by now!
Concise Encoding supports all of the common types natively. No more encoding things into strings.
Type | CE | XML | JSON | BSON | CBOR | Protobufs | Thrift | ASN.1 | Ion |
---|---|---|---|---|---|---|---|---|---|
Int Max Size (bits) | β | β | 53 | 64 | 64 | 64 | 64 | 64 | β |
Float Max Size (bits) | β | β | 64 | 128 | 64 | 64 | 64 | 64 | β |
Subsecond Precision | ns | β | β | ns | ns | ns | β | ns | ns |
Ad-hoc | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | β | β | β | βοΈ |
Little Endian | βοΈ | β | β | βοΈ | β | βοΈ | β | β | β |
Non-string map keys | βοΈ | β | β | βοΈ | βοΈ | βοΈ | β | β | β |
Size Optimization | βοΈ | β | β | β | βοΈ | β | β | βοΈ | β |
Cyclic Data | βοΈ | β | β | β | βοΈ | β | β | β | β |
Time Zones | βοΈ | β | β | β | βοΈ | β | β | β | β |
Records | βοΈ | β | β | β | β | βοΈ | β | β | β |
Bin + Txt | βοΈ | β | β | β | β | β | β | βοΈ | βοΈ |
Versioned | βοΈ | βοΈ | β | β | β | β | β | β |
- Ad-hoc: Supports ad-hoc data (does not require a schema).
- Little Endian: Uses little-endian (modern CPUs use little endian, making little endian formats more efficient).
- Size Optimization: The most common types and values use less space.
- Cyclic Data: Supports cyclic (recursive) data structures.
- Time Zones: Time types support real time zones.
- Records: Records separate definition and instance for frequently occurring structures.
- Bin + Txt: Has twin binary and text formats that are 1:1 convertible to each other without data loss.
- Versioned: Documents are versioned to the specification they adhere to. (Ion supports versioning in the binary format only).
Type | CE | XML | JSON | BSON | CBOR | Protobufs | Thrift | ASN.1 | Ion |
---|---|---|---|---|---|---|---|---|---|
Boolean | βοΈ | β | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
Integer | βοΈ | β | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
Binary Float | βοΈ | β | β | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
Bfloat | βοΈ | β | β | β | β | β | β | β | β |
Decimal Float | βοΈ | β | β | βοΈ | βοΈ | β | β | β | βοΈ |
NaN, Infinity | βοΈ | β | β | β | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
Universal ID | βοΈ | β | β | βοΈ | βοΈ | β | β | βοΈ | β |
Timestamp | βοΈ | β | β | βοΈ | βοΈ | βοΈ | β | βοΈ | βοΈ |
Resource ID | βοΈ | βοΈ | β | β | β | β | β | β | β |
String | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
Bytes | βοΈ | β | β | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
List | βοΈ | β | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ |
Map | βοΈ | β | βοΈ | βοΈ | βοΈ | βοΈ | βοΈ | β | β |
Edge | βοΈ | β | β | β | β | β | β | β | β |
Node | βοΈ | β | β | β | β | β | β | β | β |
Record | βοΈ | β | β | β | β | β | β | β | β |
Typed Arrays | βοΈ | β | β | β | βοΈ | βοΈ | βοΈ | βοΈ | β |
Reference | βοΈ | β | β | β | βοΈ | β | β | β | β |
Remote Ref | βοΈ | β | β | β | β | β | β | β | β |
Comment | βοΈ | βοΈ | β | β | β | β | β | β | β |
Null | βοΈ | β | βοΈ | βοΈ | βοΈ | βοΈ | β | βοΈ | βοΈ |
Media | βοΈ | β | β | β | β | β | β | β | β |
Custom | βοΈ | β | β | β | β | β | β | βοΈ | βοΈ |
- 𧬠Concise Encoding Structure (describes the structure and rules that both formats follow)
- π‘ Concise Binary Encoding (CBE) (describes the binary format encoding)
- π₯ Concise Text Encoding (CTE) (describes the text format encoding)
Note: Most applications will only need the binary format. The text format is only required in places where a human must get involved, and this can often be handled by a simple command-line tool.
- π Design Document explains the design choices behind Concise Encoding.
- βοΈ Go Implementation (reference implementation)
- π οΈ Enctool A tool for converting between formats
Although Concise Encoding is nearing a release, it's currently a draft specification and thus subject to change. Please use a version of 0
for now to avoid compatibility issues with existing documents when version 1 is released.
Note: When version 1 is released, 0
will no longer be a valid version number.
All examples are valid Concise Text Encoding documents that can be transparently 1:1 converted to/from Concise Binary Encoding.
c1
{
"boolean" = true
"binary int" = -0b10001011
"octal int" = 0o644
"decimal int" = -10000000
"hex int" = 0xfffe0001
"very long int" = 100000000000000000000000000000000000009
"decimal float" = -14.125
"hex float" = 0x5.1ec4p+20
"very long flt" = 4.957234990634579394723460546348e+100000
"not-a-number" = nan
"infinity" = inf
"neg infinity" = -inf
}
c1
{
"string" = "Strings support escape sequences: \n \t \[1f415]"
"url" = @"https://example.com/"
"email" = @"mailto:[email protected]"
}
c1
{
"uuid" = f1ce4567-e89b-12d3-a456-426655440000
"date" = 2019-07-01
"time" = 18:04:00.948/Europe/Prague
"timestamp" = 2010-07-15/13:28:15.415942344
"null" = null
"media" = @application/x-sh[23 21 2f 62 69 6e 2f 73 68 0a 0a
65 63 68 6f 20 68 65 6c 6c 6f 20 77 6f 72 6c 64 0a]
}
c1
{
"list" = [1 2.5 "a string"]
"map" = {"one"=1 2="two" "today"=2020-09-10}
"bytes" = @u8x[01 ff de ad be ef]
"int16 array" = @i16[7374 17466 -9957]
"uint16 hex" = @u16x[91fe 443a 9c15]
"float32 array" = @f32[1.5e10 -8.31e-12]
}
c1
@vehicle<"make" "model" "drive" "sunroof"> // type
[
@vehicle{"Ford" "Explorer" "4wd" true } // instance
@vehicle{"Toyota" "Corolla" "fwd" false} // instance
]
Which is equivalent to:
c1
[
{
"make" = "Ford"
"model" = "Explorer"
"drive" = "4wd"
"sunroof" = true
}
{
"make" = "Toyota"
"model" = "Corolla"
"drive" = "fwd"
"sunroof" = false
}
]
c1
/* The tree:
*
* 2
* / \
* 5 7
* / /|\
* 9 6 1 2
* / / \
* 4 8 5
*
*/
(2
(7
2
1
(6
5
8
)
)
(5
(9
4
)
)
)
Notice how when rotated 90Β°, it resembles the tree it represents:
c1
/* The weighted graph:
*
* b
* /|\
* 4 1 1
* / | \
* a-3-c-4-d
*
*/
{
"vertices" = [
&a:{}
&b:{}
&c:{}
&d:{}
]
"edges" = [
@($a {"weight"=4 "direction"="both"} $b)
@($a {"weight"=3 "direction"="both"} $c)
@($b {"weight"=1 "direction"="both"} $c)
@($b {"weight"=1 "direction"="both"} $d)
@($c {"weight"=4 "direction"="both"} $d)
]
}
c1
{
// Entire map will be referenced later as $id1
"marked object" = &id1:{
"recursive" = $id1
}
"ref1" = $id1
"ref2" = $id1
// Reference pointing to part of another document.
"outside ref" = $"https://xyz.com/document.cte#some_id"
}
c1
{
// Custom types are user-defined, with user-supplied codecs.
// In this example, we assume that custom type 12 is registered
// via a schema to a custom "complex number" type.
"custom text" = @12"2.94+3i"
"custom binary" = @12[04 f6 28 3c 40 00 00 40 40]
}
Copyright (c) 2018-2023 Karl Stenerud. All rights reserved.
Distributed under the Creative Commons Attribution License (license deed.