-
Notifications
You must be signed in to change notification settings - Fork 226
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #769 from fiatjaf/opentimestamps
add OpenTimestamps file parser
- Loading branch information
Showing
16 changed files
with
2,657 additions
and
931 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| package opentimestamps | ||
|
|
||
| // https://opentimestamps.org/ | ||
|
|
||
| import ( | ||
| "embed" | ||
|
|
||
| "github.com/wader/fq/format" | ||
| "github.com/wader/fq/pkg/decode" | ||
| "github.com/wader/fq/pkg/interp" | ||
| "github.com/wader/fq/pkg/scalar" | ||
| "golang.org/x/exp/slices" | ||
| ) | ||
|
|
||
| //go:embed opentimestamps.md | ||
| var otsFS embed.FS | ||
|
|
||
| func init() { | ||
| interp.RegisterFormat( | ||
| format.Opentimestamps, | ||
| &decode.Format{ | ||
| Description: "OpenTimestamps file", | ||
| DecodeFn: decodeOTSFile, | ||
| Groups: []*decode.Group{format.Probe}, | ||
| }) | ||
| interp.RegisterFS(otsFS) | ||
| } | ||
|
|
||
| const ( | ||
| continuationByte = 0xff | ||
| attestationTag = 0x00 | ||
| appendTag = 0xf0 | ||
| prependTag = 0xf1 | ||
| reverseTag = 0xf2 | ||
| hexlifyTag = 0xf3 | ||
| sha1Tag = 0x02 | ||
| ripemd160Tag = 0x03 | ||
| sha256Tag = 0x08 | ||
| keccak256Tag = 0x67 | ||
| ) | ||
|
|
||
| var ( | ||
| headerMagic = []byte{0x00, 0x4f, 0x70, 0x65, 0x6e, 0x54, 0x69, 0x6d, 0x65, 0x73, 0x74, 0x61, 0x6d, 0x70, 0x73, 0x00, 0x00, 0x50, 0x72, 0x6f, 0x6f, 0x66, 0x00, 0xbf, 0x89, 0xe2, 0xe8, 0x84, 0xe8, 0x92, 0x94} | ||
| calendarMagic uint64 = 0x83_df_e3_0d_2e_f9_0c_8e | ||
| bitcoinMagic uint64 = 0x05_88_96_0d_73_d7_19_01 | ||
|
|
||
| binaryTags = []byte{appendTag, prependTag} | ||
| ) | ||
|
|
||
| var attestationMapper = scalar.UintMapSymStr{ | ||
| calendarMagic: "calendar", | ||
| bitcoinMagic: "bitcoin", | ||
| } | ||
|
|
||
| var tagMapper = scalar.UintMapSymStr{ | ||
| continuationByte: "continuation_byte", | ||
| attestationTag: "attestation", | ||
| appendTag: "append", | ||
| prependTag: "prepend", | ||
| reverseTag: "reverse", | ||
| hexlifyTag: "hexlify", | ||
| sha1Tag: "sha1", | ||
| ripemd160Tag: "ripemd160", | ||
| sha256Tag: "sha256", | ||
| keccak256Tag: "keccak256", | ||
| } | ||
|
|
||
| var digestSizes = map[byte]int64{ | ||
| sha1Tag: 20, | ||
| ripemd160Tag: 20, | ||
| sha256Tag: 32, | ||
| keccak256Tag: 32, | ||
| } | ||
|
|
||
| func decodeOTSFile(d *decode.D) any { | ||
| d.Endian = decode.BigEndian | ||
|
|
||
| d.FieldRawLen("magic_bytes", int64(8*len(headerMagic)), d.AssertBitBuf(headerMagic)) | ||
| d.FieldUintFn("version", decodeVarInt) | ||
|
|
||
| tag := d.FieldU8("digest_hash_algorithm", tagMapper) | ||
| digestSize, ok := digestSizes[byte(tag)] | ||
| if !ok { | ||
| name := tagMapper[tag] | ||
| d.Fatalf("hash algorithm not supported, got %x: '%s'", tag, name) | ||
| return nil | ||
| } | ||
| d.FieldRawLen("digest", 8*digestSize, scalar.RawHex) | ||
|
|
||
| d.FieldArray("operations", func(d *decode.D) { | ||
| for d.NotEnd() { | ||
| d.FieldStruct("operation", func(d *decode.D) { | ||
| tag := d.FieldU8("tag", tagMapper) | ||
| if tag == attestationTag { | ||
| val := d.FieldU64BE("attestation_type", attestationMapper) | ||
| n := d.FieldUintFn("attestation_varbytes_size", decodeVarInt) | ||
| switch val { | ||
| case bitcoinMagic: | ||
| d.FieldUintFn("block", decodeVarInt) | ||
| case calendarMagic: | ||
| nurl := d.FieldUintFn("url_size", decodeVarInt) | ||
| d.FieldUTF8("url", int(nurl)) | ||
| default: | ||
| d.FieldRawLen("unknown_data", int64(n*8)) | ||
| } | ||
| } else { | ||
| if _, ok := tagMapper[tag]; ok { | ||
| // read var bytes if argument | ||
| if slices.Contains(binaryTags, byte(tag)) { | ||
| n := d.FieldUintFn("argument_size", decodeVarInt) | ||
| d.FieldRawLen("argument", int64(8*n), scalar.RawHex) | ||
| } | ||
| } else { | ||
| d.Fatalf("unknown operation tag %x", tag) | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| }) | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func decodeVarInt(d *decode.D) uint64 { | ||
| var value uint64 = 0 | ||
| var shift uint64 = 0 | ||
|
|
||
| for { | ||
| b := d.U8() | ||
| value |= (b & 0b01111111) << shift | ||
| shift += 7 | ||
| if b&0b10000000 == 0 { | ||
| break | ||
| } | ||
| } | ||
|
|
||
| return value | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| ### View a full OpenTimestamps file | ||
|
|
||
| ``` | ||
| $ fq dd file.ots | ||
| ``` | ||
|
|
||
| ### List the names of the Calendar servers used | ||
|
|
||
| ``` | ||
| $ fq '.operations | map(select(.attestation_type == "calendar") | .url)' file.ots | ||
| ``` | ||
|
|
||
| ### Check if there are Bitcoin attestations present | ||
|
|
||
| ``` | ||
| $ fq '.operations | map(select(.attestation_type == "bitcoin")) | length > 0' file.ots | ||
| ``` | ||
|
|
||
| ### Authors | ||
| - fiatjaf, https://fiatjaf.com | ||
|
|
||
| ### References | ||
| - https://opentimestamps.org/ | ||
| - https://github.com/opentimestamps/python-opentimestamps |
Oops, something went wrong.