cheddar/sdbd-demo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add README and LICENSE

Browse source
This commit is contained in:
CheddarCrisp 2024-01-11 11:09:22 -05:00
parent b7ebbd9169
commit e6bf4dc61f
2 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2024
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.

9
README.md Normal file
View file

@ -0,0 +1,9 @@
# Self-Described Binary Document Proof of Concept
This repo contains a proof of concept/demo code that implements the Self-Described Binary Document format. This format is described in a series of blog posts starting at https://crispbyte.dev/blog/2024-01-07-01-SDBD/. This code is most definitely not production ready.
## Issues
1. The `Document` data type violates some of the requirements set for metadata header lists.
2. It has at least one securiy issue in that `content-name` is not checked for being a valid filename.
3. It doesn't do much useful.
4. It implements version 1 of the format which really needs to be worked into a version 2 before wide-spread use.