kaitai-io / kaitai_struct_samples

Kaitai Struct: library of sample files for testing

Kaitai Struct: sample library

A library of sample files for testing file format specifications from the Kaitai Struct: format library.

Contributing

Before adding a new file, it's necessary to find out who owns the copyright and under what license the file was released. If the file is hosted in a repository on GitHub and you know the hash of a commit in which the file was added, this shell command may help you with finding the author, who is usually also the copyright holder (needs curl and jq):

Shell command for extracting the commit author

auth_token=[login]:[token] # get [token] from <https://github.com/settings/tokens> (public access)

repo=ElyesH/coreboot
commit_hash=e0af9fcb2d526ffd654d0bb573dd5333d0d76269
curl \
  -s \
  -u "$auth_token" \
  -H "Accept: application/vnd.github.v3+json" \
  "https://api.github.com/repos/$repo/commits/$commit_hash" \
| jq '{html_url, message: .commit.message | .[0:index("\n\n")], author: .commit.author, spdx: {copyright: (.commit.author.name + " <" + .commit.author.email + ">"), year: (if .commit.author.date | index("-") == 4 then .commit.author.date | .[0:4] else null end)}}'

Example command output

{
  "html_url": "https://github.com/ElyesH/coreboot/commit/e0af9fcb2d526ffd654d0bb573dd5333d0d76269",
  "message": "tests: Add lib/edid-test test case",
  "author": {
    "name": "Jakub Czapiga",
    "email": "[email protected]",
    "date": "2020-10-09T14:02:46Z"
  },
  "spdx": {
    "copyright": "Jakub Czapiga <[email protected]>",
    "year": "2020"
  }
}

When you know the copyright owner, find the license of the file. Then follow the REUSE tutorial to find out how to add the information in the repo.

You can install REUSE helper tool, which helps with making that the repo compliant with the REUSE recommendations. The most useful command is reuse addheader:

reuse addheader --year 2016 --copyright="Jane Doe <[email protected]>" --license="CC0-1.0" category/format/sample.bin

Others can be found in the tutorial in collapsible boxes marked as "Tool instructions for this step".

Licensing

This repository uses REUSE to keep track of copyright and licensing information, so check the comment headers of individual files, or a file with the same name with the .license extension added (for binary files).

kaitai_struct_samples's Issues

"dtb" subfolder placed in the wrong directory `system/`

See #3 (comment)

Additional sources of files

https://github.com/mathiasbynens/small