From 45f3e98041b7d11e164043522d2b43783a177788 Mon Sep 17 00:00:00 2001 From: Andrew Weiss Date: Thu, 6 Jun 2019 13:27:08 -0400 Subject: [PATCH] add license and readme --- LICENSE | 21 +++++++++++++++++++++ README.md | 18 ++++++++++++++++++ 2 files changed, 39 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..84bac52d --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Andrew Weiss + +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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 00000000..95f49554 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# cddl-rs + +> This library is very much experimental and is being developed as a personal learning exercise. It is far from complete. There are likely more performant and stable libraries out there for parsing CDDL. This one should not be used in production in any form or fashion. + +A Rust implementation of the Concise data definition language (CDDL). CDDL is an IETF draft standard that "proposes a notational convention to express CBOR and JSON data structures." The current draft can be found at https://tools.ietf.org/html/draft-ietf-cbor-cddl-08 and is currently in AUTH48 state as of 2019-05-24 (RFC-to-be 8610), per https://www.rfc-editor.org/auth48/rfc8610. + +This library includes a handwritten parser and lexer for CDDL and is heavily inspired by Thorsten Ball's book "Writing An Interpretor In Go". I'm personally only focused on using CDDL as a means for validating JSON data, and as such, work is being done to build a JSON validation component into the library. + +## Goals + +- Parse CDDL documents into an AST +- Verify conformance of CDDL documents against the draft standard +- Validate JSON documents using CDDL (only interested in the JSON subset of the CBOR generic data model for now) + +## Non-goals + +- Validate CBOR data structures (will eventually support this given it's the main reason for CDDL, but not focused on this at the moment) +- Performance