Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Finalize export metadata format #280

Closed
eloquence opened this issue Jul 10, 2019 · 6 comments · Fixed by freedomofpress/securedrop-export#6
Closed

Finalize export metadata format #280

eloquence opened this issue Jul 10, 2019 · 6 comments · Fixed by freedomofpress/securedrop-export#6

Comments

@eloquence
Copy link
Member

#259 implemented a basic, manual export workflow and specified (in the README) a metadata format for exports:

.
├── metadata.json
└── export_data
    ├── file-to-export-1.txt
    ├── file-to-export-2.pdf
    ├── file-to-export-3.doc
    [...]

metadata.json example:

{
  "encryption-method": "luks"
  "encryption-key": "Your encryption passhrase goes here"
}

Before we implement export support in the client (freedomofpress/securedrop-client#21) we should be sure that this is the format specification we want to go with. For example, is there other information we want to include in the metadata or folder structure (e.g., source name, date/time of export)?

@eloquence
Copy link
Member Author

It may be worth comparing this approach with the ZIP folder structure generated by downloads from the Journalist Interface, which looks like this:

all
├── recessive accreditation
│   ├── 1_2019-07-07
│   │   └── 1-recessive_accreditation-msg.gpg
│   └── 2_2019-07-07
│       └── 2-recessive_accreditation-msg.gpg
└── surviving authentication
    ├── 1_2019-07-07
    │   └── 1-surviving_authentication-doc.gz.gpg
    └── 2_2019-07-07
        └── 2-surviving_authentication-msg.gpg

The date used for the folders is the "last updated" date for a given source (https://github.com/freedomofpress/securedrop/blob/develop/securedrop/store.py#L137).

@eloquence
Copy link
Member Author

See also the related issue of handling filename conflicts: #270

@emkll
Copy link
Contributor

emkll commented Jul 30, 2019

A draft of the metadata archive format specification can be found in the following document https://docs.google.com/document/d/1qoQMMGjB9d9mHelZg_lncgiMjjB1BxIvZot_2Y6KjqM for discussion as part of the 7/24-8/7 sprint.

@sssoleileraaa
Copy link
Contributor

@emkll I gave the google doc a first pass review and left a few comments and some suggestions.

@redshiftzero
Copy link
Contributor

also dropped some comments inline, otherwise LGTM!

@emkll
Copy link
Contributor

emkll commented Aug 6, 2019

Thanks @creviera and @redshiftzero for the comments/suggestions, they have all been addressed/accepted, and they should now be consistent with the changes in freedomofpress/securedrop-export#5 . I think this should now be sufficient to close the ticket. If anyone disagrees, please feel free to repoen/comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants