Deliverable 2: Spec document for golang implementation of format #2

New Issue

sneak · 2021-10-26T07:50:34Z

sneak commented

2021-10-26 07:50:34 +00:00

This is also to be written in markdown.

The implementation should be comprised of a reusable library, and a small wrapper CLI utility that consumes the library.

This is also to be written in markdown. The implementation should be comprised of a reusable library, and a small wrapper CLI utility that consumes the library.

sneak commented

2021-11-03 11:04:19 +00:00

This document should:

identify the usage examples of the golang CLI tool
list the features it will have in 1.0
list the features it will not have in 1.0 (planned features)
describe the broad structure of the repository/code

This document should: - identify the usage examples of the golang CLI tool - list the features it will have in 1.0 - list the features it will not have in 1.0 (planned features) - describe the broad structure of the repository/code

sneak commented

2021-11-03 11:08:04 +00:00

Desired features for 1.0:

mf generate (recurses into current directory and writes index.mf).

mf generate /path/to/other (same)

mf generate -k 5539AD00DE4C42F3AFE11575052443F4DF2A55C2 (generates ./index.mf and signs it with keyid 5539AD00DE4C42F3AFE11575052443F4DF2A55C2 by shelling out to gpg binary)

mf verify (checks ./index.mf)

mf verify /path/to/other (same)

mf verify -k 5539AD00DE4C42F3AFE11575052443F4DF2A55C2 (checks that signature is from keyid 5539AD00DE4C42F3AFE11575052443F4DF2A55C2 and signature is valid)

mf fetch https://example.com/directory/ (fetches https://example.com/directory/index.mf and all referenced files, and ensures they are downloaded correctly)

mf fetch -k 5539AD00DE4C42F3AFE11575052443F4DF2A55C2 https://example.com/directory/

Desired features for 1.0: `mf generate` (recurses into current directory and writes `index.mf`). `mf generate /path/to/other` (same) `mf generate -k 5539AD00DE4C42F3AFE11575052443F4DF2A55C2` (generates `./index.mf` and signs it with keyid `5539AD00DE4C42F3AFE11575052443F4DF2A55C2` by shelling out to gpg binary) `mf verify` (checks `./index.mf`) `mf verify /path/to/other` (same) `mf verify -k 5539AD00DE4C42F3AFE11575052443F4DF2A55C2` (checks that signature is from keyid `5539AD00DE4C42F3AFE11575052443F4DF2A55C2` and signature is valid) `mf fetch https://example.com/directory/` (fetches `https://example.com/directory/index.mf` and all referenced files, and ensures they are downloaded correctly) `mf fetch -k 5539AD00DE4C42F3AFE11575052443F4DF2A55C2 https://example.com/directory/`

sneak commented

2021-11-03 11:12:51 +00:00

The spec for the golang implementation should also be committed into this repo, and can be removed once the go code is done.

Sign in to join this conversation.

No Label

No Milestone

No Assignees

1 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: sneak/mfer#2