sneak
/
mfer
1
0
Fork 0
Code Issues 3 Pull Requests Releases Wiki Activity

Update 'README.md'

This commit is contained in:
Jeffrey Paul 2021-01-18 23:38:36 +00:00
parent 9637c8de05
commit c8c89aaa3f
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -6,7 +6,7 @@ Manifest file generator and checker.
Given a plain URL, there is no standard way to safely and programmatically download everything "under" that URL path. `wget -r` can traverse directory listings if they're enabled, but every server has a different format, and this does not verify cryptographic integrity of the files. Given a plain URL, there is no standard way to safely and programmatically download everything "under" that URL path. `wget -r` can traverse directory listings if they're enabled, but every server has a different format, and this does not verify cryptographic integrity of the files.
Currently, the solution that people are using are sidecar files in the format of SHASUMS checksum files, as well as a SHASUMS.asc PGP detached signature. This is not checksum-agnostic and the sidecar file is not always consistently named. Currently, the solution that people are using are sidecar files in the format of `SHASUMS` checksum files, as well as a `SHASUMS.asc` PGP detached signature. This is not checksum-algorithm-agnostic and the sidecar file is not always consistently named.
# Proposed Solution # Proposed Solution
@ -34,6 +34,13 @@ The manifest file would do several important things:
* be easy to download/resume * be easy to download/resume
* be easy to use across protocols (given an HTTPS url, fetch manifest, then download file contents via bittorrent or ipfs) * be easy to use across protocols (given an HTTPS url, fetch manifest, then download file contents via bittorrent or ipfs)
# Non-Goals
* Manifest generation speed
* Small manifest file size (within reason)
# Open Questions
* Should the manifest file include checksums of individual file chunks, or just for the whole assembled file?
* If so, should the chunksize be fixed or dynamic?
# Tool Examples # Tool Examples
* `mfer gen` / `mfer gen .` * `mfer gen` / `mfer gen .`