mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

support annex.shared-sop-command for encryption=shared

Browse source 
This works well, and it interoperates with gpg in my testing (although some
SOP commands might choose to use a profile that does not so caveat emptor).

Note that for creating the Cipher, gpg --gen-random is still used. SOP
does not have an eqivilant, and as long as the user has gpg around,
which seems likely, it doesn't matter that it uses gpg here, it's not being
used for encryption. That seemed better than implementing a second way
to get high quality entropy, at least for now.

The need for the sop command to run in an empty directory has each call
to encrypt and decrypt creating a new temporary directory. That is some
unncessary overhead, though probably swamped by the overhead of running
the sop command. This could be improved in the future by passing an
already empty directory to them, or a sufficiently empty directory
(.git/annex/tmp would probably suffice).

Sponsored-by: Brett Eisenberg on Patreon
This commit is contained in:
Joey Hess 2024-01-12 13:29:34 -04:00
parent dd3e779020
commit 7e69063a29
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
7 changed files with 116 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Utility/StatelessOpenPGP.hs
View file

@ -9,9 +9,10 @@
module Utility.StatelessOpenPGP (
SOPCmd(..),
SopSubCmd,
SOPSubCmd,
SOPProfile(..),
Password,
Profile,
EmptyDirectory(..),
Armoring(..),
encryptSymmetric,
decryptSymmetric,
@ -37,18 +38,18 @@ import qualified Data.ByteString as B
newtype SOPCmd = SOPCmd { unSOPCmd :: String }
{- The subcommand to run eg encrypt. -}
type SopSubCmd = String
type SOPSubCmd = String
newtype SOPProfile = SOPProfile String
{- Note that SOP requires passwords to be UTF-8 encoded, and that they
- may try to trim trailing whitespace. They may also forbid leading
- whitespace, or forbid some non-printing characters. -}
type Password = B.ByteString
type Profile = String
newtype Armoring = Armoring Bool
{- The path to an empty temporary directory.
{- The path to a sufficiently empty directory.
-
- This is unfortunately needed because of an infelicity in the SOP
- standard, as documented in section 9.9 "Be Careful with Special
@ -61,6 +62,9 @@ newtype Armoring = Armoring Bool
- special designators, an empty directory has to be provided, and the
- command is run in that directory. Of course, this necessarily means
- that any relative paths passed to the command have to be made absolute.
-
- The directory does not really have to be empty, it just needs to be one
- that should not contain any files with names starting with "@".
-}
newtype EmptyDirectory = EmptyDirectory FilePath
@ -70,7 +74,7 @@ encryptSymmetric
=> SOPCmd
-> Password
-> EmptyDirectory
-> Maybe Profile
-> Maybe SOPProfile
-> Armoring
-> (Handle -> IO ())
-> (Handle -> m a)
@ -84,7 +88,8 @@ encryptSymmetric sopcmd password emptydirectory mprofile armoring feeder reader
Armoring True -> Nothing
, Just "--as=binary"
, case mprofile of
Just profile -> Just $ "--profile=" ++ profile
Just (SOPProfile profile) ->
Just $ "--profile=" ++ profile
Nothing -> Nothing
]
@ -121,7 +126,7 @@ test_encrypt_decrypt_Symmetric a b password armoring v = catchBoolIO $
feedRead
:: (MonadIO m, MonadMask m)
=> SOPCmd
-> SopSubCmd
-> SOPSubCmd
-> [CommandParam]
-> Password
-> EmptyDirectory
@ -166,7 +171,7 @@ feedRead cmd subcmd params password emptydirectory feeder reader = do
feedRead'
:: (MonadIO m, MonadMask m)
=> SOPCmd
-> SopSubCmd
-> SOPSubCmd
-> [CommandParam]
-> Maybe EmptyDirectory
-> (Handle -> IO ())