provide helper functions similar to the io/ioutil package
#7
Labels
feature-request
New feature
Comments
aead
changed the title
io/iotuil packageio/ioutil package
aead
pushed a commit
that referenced
this issue
May 28, 2019
This commit introduces the `sioutil` package. It contains just a `NopCloser` method that is related to https://golang.org/pkg/io/ioutil/#NopCloser. It wraps a io.Writer and returns a io.WriteCloser that does nothing on Close(). This is useful when en/decrypting an io.Writer but completing the en/decryption process should not close the sink. For example: ``` ew := s.EncryptWriter(sioutil.NopCloser(w), nonce, associatedData) defer ew.Close() // This does not close 'w'. ``` updates #7
Merged
aead
pushed a commit
that referenced
this issue
May 28, 2019
This commit introduces the `sioutil` package. It contains just a `NopCloser` method that is related to https://golang.org/pkg/io/ioutil/#NopCloser. It wraps a io.Writer and returns a io.WriteCloser that does nothing on Close(). This is useful when en/decrypting an io.Writer but completing the en/decryption process should not close the sink. For example: ``` ew := s.EncryptWriter(sioutil.NopCloser(w), nonce, associatedData) defer ew.Close() // This does not close 'w'. ``` updates #7
|
I'm an actual user and I would really really like this. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What is the problem you want to solve?
Often you simply want to create or read from a file. Implementing this logic over and over
again is tedious and error prone. Therefore, the
io/ioutilprovides some helper functions likeWriteFile(...)I suggest a similar
sio/sioutilpackage containing some commonly required functionality.I suspect encrypting and decrypting a file are function candidates. However, I'm not sure right now which concepts should belong to
sioutiland which shouldn't.For example, a file can be encrypted with a password (deriving a key using a PBKDF - like Argon2id) or with a symmetric master key (which may be derived from a password itself) or with a public key (e.g. using ECDH to derive a secret key). Depending on the approach the encrypted file is created in a more open or closed format. For instance the file can start with a cipher id identifying the PBKDF + (fixed) parameters and the AEAD or the file can contain all parameters - like the PBKDF memory cost a.s.o.
Therefore, I suspect that a
sio/sioutilis quite useful even though I cannot determine which functionality it should contain right now.How do you want to solve it?
Currently, I'm thinking of:
EncryptFile(password []byte, filename string, data []byte, perm os.FileMode) errorDecryptFile(password []byte, filename string) ([]byte, error)Also a
NopCloser(w io.Writer) io.WriteClosermay be useful to avoid closing the underlyingio.Writer for
Enc/DecWriterin some situations.Additional context
Are there alternative solutions?
Let users implement this logic themself. But - as mentioned - this is tedious and error prone.
Would your solution cause a major breaking API change?
No
Anything else that is important?
Getting feedback from actual users would be quite helpful.
The text was updated successfully, but these errors were encountered: