hopenpgp-tools-0.23.11/ 0000755 0000000 0000000 00000000000 07346545000 013025 5 ustar 00 0000000 0000000 hopenpgp-tools-0.23.11/HOpenPGP/Tools/ 0000755 0000000 0000000 00000000000 07346545000 015505 5 ustar 00 0000000 0000000 hopenpgp-tools-0.23.11/HOpenPGP/Tools/Armor.hs 0000644 0000000 0000000 00000003014 07346545000 017117 0 ustar 00 0000000 0000000 {-# LANGUAGE RecordWildCards #-}
-- Armor.hs: hOpenPGP-tools common ASCII de-Armor function
-- Copyright © 2012-2023 Clint Adams
--
-- vim: softtabstop=4:shiftwidth=4:expandtab
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see .
module HOpenPGP.Tools.Armor
( doDeArmor
) where
import qualified Codec.Encryption.OpenPGP.ASCIIArmor as AA
import Codec.Encryption.OpenPGP.ASCIIArmor.Types (Armor(..))
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as BL
import Data.Conduit ((.|), runConduitRes)
import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.List as CL
import System.IO (hPutStrLn, stderr, stdin)
doDeArmor :: IO ()
doDeArmor = do
a <- runConduitRes $ CB.sourceHandle stdin .| CL.consume
case AA.decode (B.concat a) of
Left e -> hPutStrLn stderr $ "Failure to decode ASCII Armor:" ++ e
Right msgs -> BL.putStr $ BL.concat (map (\(Armor _ _ bs) -> bs) msgs)
hopenpgp-tools-0.23.11/HOpenPGP/Tools/Common.hs 0000644 0000000 0000000 00000016175 07346545000 017303 0 ustar 00 0000000 0000000 -- Common.hs: hOpenPGP-tools common functions
-- Copyright © 2012-2023 Clint Adams
--
-- vim: softtabstop=4:shiftwidth=4:expandtab
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see .
module HOpenPGP.Tools.Common
( banner
, versioner
, warranty
, prependAuto
, keyMatchesFingerprint
, keyMatchesEightOctetKeyId
, keyMatchesExactUIDString
, keyMatchesUIDSubString
, keyMatchesPKPred
-- hmm
, pkpGetPKVersion
, pkpGetPKAlgo
, pkpGetKeysize
, pkpGetTimestamp
, pkpGetFingerprint
, pkpGetEOKI
, tkUsingPKP
, pUsingPKP
, pUsingSP
, tkGetUIDs
, tkGetSubs
, anyOrAll
, anyReader
, oGetTag
, oGetLength
, spGetSigVersion
, spGetSigType
, spGetPKAlgo
, spGetHashAlgo
, spGetSCT
, maybeR
) where
import Data.Version (showVersion)
import Paths_hopenpgp_tools (version)
import Codec.Encryption.OpenPGP.Fingerprint (eightOctetKeyID, fingerprint)
import Codec.Encryption.OpenPGP.SignatureQualities (sigCT)
import Codec.Encryption.OpenPGP.Types
import Control.Lens ((^..))
import Data.Binary (put)
import Data.Binary.Put (runPut)
import qualified Data.ByteString.Lazy as BL
import Data.Data.Lens (biplate)
import Data.Text (Text)
import qualified Data.Text as T
import Options.Applicative.Builder (auto, help, hidden, infoOption, long, short)
import Options.Applicative.Types (Parser, ReadM(..))
import Prettyprinter (Doc, (<+>), hardline, pretty)
import Codec.Encryption.OpenPGP.KeyInfo (pubkeySize)
import Control.Error.Util (hush)
import Control.Monad.Trans.Reader
( Reader
, ReaderT
, ask
, local
, reader
, runReader
, withReader
)
-- hmm --
import Data.Maybe (fromMaybe, mapMaybe)
banner :: String -> Doc ann
{-# INLINE banner #-}
banner name =
pretty name <+>
pretty "(hopenpgp-tools)" <+>
pretty (showVersion version) <>
hardline <> pretty "Copyright (C) 2012-2023 Clint Adams"
warranty :: String -> Doc ann
{-# INLINE warranty #-}
warranty name =
pretty name <+>
pretty "comes with ABSOLUTELY NO WARRANTY." <+>
pretty "This is free software, and you are welcome to redistribute it" <+>
pretty "under certain conditions."
versioner :: String -> Parser (a -> a)
{-# INLINE versioner #-}
versioner name =
infoOption (name ++ " (hopenpgp-tools) " ++ showVersion version) $
long "version" <> short 'V' <> help "Show version information" <> hidden
prependAuto :: Read a => String -> ReadM a
prependAuto s = ReadM (local (s ++) (unReadM auto))
keyMatchesFingerprint :: Bool -> TK -> TwentyOctetFingerprint -> Bool
keyMatchesFingerprint = keyMatchesPKPred fingerprint
keyMatchesEightOctetKeyId :: Bool -> TK -> Either String EightOctetKeyId -> Bool -- FIXME: refactor this somehow
keyMatchesEightOctetKeyId = keyMatchesPKPred eightOctetKeyID
keyMatchesExactUIDString :: Text -> TK -> Bool
keyMatchesExactUIDString uidstr = elem uidstr . map fst . _tkUIDs
keyMatchesUIDSubString :: Text -> TK -> Bool
keyMatchesUIDSubString uidstr =
any (T.toLower uidstr `T.isInfixOf`) . map (T.toLower . fst) . _tkUIDs
keyMatchesPKPred :: Eq a => (PKPayload -> a) -> Bool -> TK -> a -> Bool
keyMatchesPKPred p False = (==) . p . fst . _tkKey
keyMatchesPKPred p True = \tk v -> elem v (map p (tk ^.. biplate))
-- The following should probably be moved elsewhere
tkUsingPKP :: Reader PKPayload a -> Reader TK a
tkUsingPKP = withReader (fst . _tkKey)
pkpGetPKVersion :: PKPayload -> Integer
pkpGetPKVersion t =
if _keyVersion t == DeprecatedV3
then 3
else 4
pkpGetPKAlgo :: PKPayload -> Integer
pkpGetPKAlgo = fromIntegral . fromFVal . _pkalgo
pkpGetKeysize :: PKPayload -> Integer
pkpGetKeysize = fromIntegral . fromMaybe 0 . hush . pubkeySize . _pubkey
pkpGetTimestamp :: PKPayload -> Integer
pkpGetTimestamp = fromIntegral . _timestamp
pkpGetFingerprint :: PKPayload -> TwentyOctetFingerprint
pkpGetFingerprint = fingerprint
pkpGetEOKI :: PKPayload -> String
pkpGetEOKI = either (const "UNKNOWN") show . eightOctetKeyID
tkGetUIDs :: TK -> [Text]
tkGetUIDs = map fst . _tkUIDs
tkGetSubs :: TK -> [PKPayload]
tkGetSubs = mapMaybe (grabPKP . fst) . _tkSubs
where
grabPKP (PublicSubkeyPkt p) = Just p
grabPKP (SecretSubkeyPkt p _) = Just p
grabPKP _ = Nothing
anyOrAll ::
(Monad m, Monad m1)
=> ((a1 -> c) -> a -> ReaderT a m b)
-> (m1 a1 -> c)
-> ReaderT a m b
anyOrAll aa op = ask >>= aa (op . return)
anyReader :: Reader a Bool -> Reader [a] Bool
anyReader p = any (runReader p) `fmap` ask
oGetTag :: Pkt -> Integer
oGetTag = fromIntegral . pktTag
oGetLength :: Pkt -> Integer
oGetLength = fromIntegral . BL.length . runPut . put -- FIXME: this should be a length that makes sense
spGetSigVersion :: Pkt -> Maybe Integer
spGetSigVersion (SignaturePkt s) = Just (sigVersion s)
where
sigVersion SigV3 {} = 3
sigVersion SigV4 {} = 4
sigVersion (SigVOther v _) = fromIntegral v
spGetSigVersion _ = Nothing
spGetSigType :: Pkt -> Maybe Integer
spGetSigType (SignaturePkt s) = fmap (fromIntegral . fromFVal) (sigType s)
-- FIXME: deduplicate this and hOpenPGP .Internal
where
sigType :: SignaturePayload -> Maybe SigType
sigType (SigV3 st _ _ _ _ _ _) = Just st
sigType (SigV4 st _ _ _ _ _ _) = Just st
sigType _ = Nothing -- this includes v2 sigs, which don't seem to be specified in the RFCs but exist in the wild
spGetSigType _ = Nothing
spGetPKAlgo :: Pkt -> Maybe Integer
spGetPKAlgo (SignaturePkt s) = fmap (fromIntegral . fromFVal) (sigPKA s)
where
sigPKA (SigV3 _ _ _ pka _ _ _) = Just pka
sigPKA (SigV4 _ pka _ _ _ _ _) = Just pka
sigPKA _ = Nothing -- this includes v2 sigs, which don't seem to be specified in the RFCs but exist in the wild
spGetPKAlgo _ = Nothing
spGetHashAlgo :: Pkt -> Maybe Integer
spGetHashAlgo (SignaturePkt s) = fmap (fromIntegral . fromFVal) (sigHA s)
where
sigHA (SigV3 _ _ _ _ ha _ _) = Just ha
sigHA (SigV4 _ _ ha _ _ _ _) = Just ha
sigHA _ = Nothing -- this includes v2 sigs, which don't seem to be specified in the RFCs but exist in the wild
spGetHashAlgo _ = Nothing
spGetSCT :: Pkt -> Maybe Integer
spGetSCT (SignaturePkt s) = fmap fromIntegral (sigCT s)
pUsingPKP :: Reader (Maybe PKPayload) a -> Reader Pkt a
pUsingPKP = withReader grabPayload
where
grabPayload (SecretKeyPkt p _) = Just p
grabPayload (PublicKeyPkt p) = Just p
grabPayload (SecretSubkeyPkt p _) = Just p
grabPayload (PublicSubkeyPkt p) = Just p
grabPayload _ = Nothing
pUsingSP :: Reader (Maybe SignaturePayload) a -> Reader Pkt a
pUsingSP = withReader grabPayload
where
grabPayload (SignaturePkt s) = Just s
grabPayload _ = Nothing
maybeR :: a -> Reader r a -> Reader (Maybe r) a
maybeR x r = reader (maybe x (runReader r))
hopenpgp-tools-0.23.11/HOpenPGP/Tools/HKP.hs 0000644 0000000 0000000 00000010153 07346545000 016463 0 ustar 00 0000000 0000000 -- HKP.hs: hOpenPGP key tool
-- Copyright © 2016-2023 Clint Adams
--
-- vim: softtabstop=4:shiftwidth=4:expandtab
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see .
{-# LANGUAGE OverloadedStrings #-}
module HOpenPGP.Tools.HKP
( fetchKeys
, FetchValidationMethod(..)
, rearmorKeys
) where
import qualified Codec.Encryption.OpenPGP.ASCIIArmor as AA
import Codec.Encryption.OpenPGP.ASCIIArmor.Types
( Armor(Armor)
, ArmorType(ArmorPublicKeyBlock)
)
import Codec.Encryption.OpenPGP.Fingerprint (fingerprint)
import Codec.Encryption.OpenPGP.Types
( Block(..)
, TK(..)
, TwentyOctetFingerprint
)
import Control.Applicative (liftA2)
import Control.Arrow ((&&&))
import Control.Lens ((^..))
import Control.Monad.IO.Class (liftIO)
import Control.Monad.Trans.Except (ExceptT(..), throwE)
import Data.Binary (get, put)
import Data.Binary.Put (runPut)
import qualified Data.ByteString as B
import qualified Data.ByteString.Char8 as BC8
import qualified Data.ByteString.Lazy as BL
import Data.Conduit ((.|), runConduitRes)
import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.List as CL
import Data.Conduit.OpenPGP.Keyring (conduitToTKsDropping)
import Data.Conduit.Serialization.Binary (conduitGet)
import Data.Data.Lens (biplate)
import Data.Either (rights)
import Data.Monoid ((<>), mempty)
import Data.Time.Clock.POSIX (getPOSIXTime)
import HOpenPGP.Tools.TKUtils (processTK)
import Network.HTTP.Client
( Response(..)
, httpLbs
, newManager
, parseUrlThrow
, setQueryString
)
import Network.HTTP.Client.TLS (tlsManagerSettings)
import Network.HTTP.Types.Status (ok200)
import Prettyprinter (pretty)
data FetchValidationMethod
= MatchPrimaryKeyFingerprint
| MatchPrimaryOrAnySubkeyFingerprint
| AnySelfSigned
deriving (Bounded, Enum, Eq, Read, Show)
fetchKeys ::
String
-> FetchValidationMethod
-> TwentyOctetFingerprint
-> ExceptT String IO [TK]
fetchKeys ks fvm q = do
manager <- liftIO $ newManager tlsManagerSettings
request <- liftIO $ parseUrlThrow (ks <> basereq)
let newreq = setQueryString (newqs q) request
response <- liftIO $ httpLbs newreq manager
processedKeys <-
if responseStatus response == ok200
then validateKeys (responseBody response)
else throwE ("HTTP status: " ++ show (responseStatus response))
return $ map fst $ filter (fvp fvm . fst . _tkKey . snd) processedKeys
where
fvp MatchPrimaryKeyFingerprint k = fingerprint k == q
fvp MatchPrimaryOrAnySubkeyFingerprint k =
any (\k -> fingerprint k == q) (k ^.. biplate)
fvp AnySelfSigned k = True
basereq = "/pks/lookup"
newqs q =
[ ("op", Just "get")
, ("options", Just "mr")
, ("exact", Just "on")
, ("search", Just (BC8.pack ("0x" <> show (pretty q)))) -- FIXME: butter
]
validateKeys :: BL.ByteString -> ExceptT String IO [(TK, TK)] -- FIXME: conduit fail
validateKeys larmors = do
bytestrings <-
ExceptT $ return $ fmap (mconcat . map armorToBS) (AA.decodeLazy larmors)
keys <-
liftIO . runConduitRes $
CB.sourceLbs bytestrings .| conduitGet get .| conduitToTKsDropping .|
CL.consume
cpt <- liftIO getPOSIXTime
return . rights $
map (uncurry (liftA2 (,)) . (pure &&& processTK (Just cpt))) keys
where
armorToBS (Armor ArmorPublicKeyBlock _ bs) = bs
armorToBS _ = mempty
rearmorKeys :: [TK] -> B.ByteString
rearmorKeys keys =
if null keys
then mempty
else AA.encode .
return .
Armor ArmorPublicKeyBlock [("Comment", "filtered by hokey")] .
runPut . put . Block $
keys
hopenpgp-tools-0.23.11/HOpenPGP/Tools/Lexer.x 0000644 0000000 0000000 00000011006 07346545000 016753 0 ustar 00 0000000 0000000 {
{-# OPTIONS -w #-}
module HOpenPGP.Tools.Lexer
( alexEOF
, alexSetInput
, alexGetInput
, alexError
, alexScan
, ignorePendingBytes
, alexGetStartCode
, runAlex
, Alex(..)
, Token(..)
, AlexReturn(..)
, AlexPosn(..)
) where
import Prelude hiding (lex)
import Numeric (readHex)
import Codec.Encryption.OpenPGP.Types (TwentyOctetFingerprint(..), EightOctetKeyId(..))
}
%wrapper "monad"
$digit = 0-9
$hexdigit = [0-9A-Fa-f]
tokens :-
$white+ ;
a { lex' TokenA }
and { lex' TokenAnd }
any { lex' TokenAny }
every { lex' TokenEvery }
not { lex' TokenNot }
now { lex' TokenNow }
one { lex' TokenOne }
or { lex' TokenOr }
subkey { lex' TokenSubkey }
tag { lex' TokenTag }
of { lex' TokenOf }
\=\= { lex' TokenEq }
\= { lex' TokenEq }
equals { lex' TokenEq }
\< { lex' TokenLt }
\> { lex' TokenGt }
\( { lex' TokenLParen }
\) { lex' TokenRParen }
contains { lex' TokenContains }
pkversion { lex' TokenPKVersion }
sigversion { lex' TokenSigVersion }
[Ss]ig[Tt]ype { lex' TokenSigType }
[Pp][Kk][Aa]lgo { lex' TokenPKAlgo }
[Ss]ig[Pp][Kk][Aa]lgo { lex' TokenSigPKAlgo }
[Hh]ash[Aa]lgo { lex' TokenHashAlgo }
[Rr][Ss][Aa] { lex' TokenRSA }
[Dd][Ss][Aa] { lex' TokenDSA }
[Ee]l[Gg]amal { lex' TokenElgamal }
[Ee][Cc][Dd][Ss][Aa] { lex' TokenECDSA }
[Ee][Cc][Dd][Hh] { lex' TokenECDH }
[Dd][Hh] { lex' TokenDH }
[Bb]inary { lex' TokenBinary }
[Cc]anonical[Tt]ext { lex' TokenCanonicalText }
[Ss]tandalone { lex' TokenStandalone }
[Gg]eneric[Cc]ert { lex' TokenGenericCert }
[Pp]ersona[Cc]ert { lex' TokenPersonaCert }
[Cc]asual[Cc]ert { lex' TokenCasualCert }
[Pp]ositive[Cc]ert { lex' TokenPositiveCert }
[Ss]ubkey[Bb]inding[Ss]ig { lex' TokenSubkeyBindingSig }
[Pp]rimary[Kk]ey[Bb]inding[Ss]ig { lex' TokenPrimaryKeyBindingSig }
[Ss]ignature[Dd]irectly[Oo]n[Aa][Kk]ey { lex' TokenSignatureDirectlyOnAKey }
[Kk]ey[Rr]evocation[Ss]ig { lex' TokenKeyRevocationSig }
[Ss]ubkey[Rr]evocation[Ss]ig { lex' TokenSubkeyRevocationSig }
[Cc]ert[Rr]evocation[Ss]ig { lex' TokenCertRevocationSig }
[Tt]imestamp[Ss]ig { lex' TokenTimestampSig }
[Mm][Dd]5 { lex' TokenMD5 }
[Ss][Hh][Aa]1 { lex' TokenSHA1 }
[Rr][Ii][Pp][Ee][Mm][Dd]160 { lex' TokenRIPEMD160 }
[Ss][Hh][Aa]256 { lex' TokenSHA256 }
[Ss][Hh][Aa]384 { lex' TokenSHA384 }
[Ss][Hh][Aa]512 { lex' TokenSHA512 }
[Ss][Hh][Aa]224 { lex' TokenSHA224 }
[Uu][Ii][Dd]s { lex' TokenUids }
keysize { lex' TokenKeysize }
length { lex' TokenLength }
timestamp { lex' TokenTimestamp }
fingerprint { lex' TokenFingerprint }
keyid { lex' TokenKeyID }
[Ss]ig[Cc]reation[Tt]ime { lex' TokenSigCreationTime }
$hexdigit{9}$hexdigit{9}$hexdigit{9}$hexdigit{9}$hexdigit{4} { lex (TokenFpr . read) }
0x$hexdigit{9}$hexdigit{9}$hexdigit{9}$hexdigit{9}$hexdigit{4} { lex (TokenFpr . read . drop 2) }
$hexdigit{8}$hexdigit{8} { lex (TokenLongID . Right . read) }
0x$hexdigit{8}$hexdigit{8} { lex (TokenLongID . Right . read . drop 2) }
$digit+ { lex (TokenInt . fromIntegral . read) }
$hexdigit+ { lex (TokenInt . fromIntegral . fst . head . readHex) }
0x$hexdigit+ { lex (TokenInt . fromIntegral . fst . head . readHex . drop 2) }
\".*\" { lex (TokenStr . ((zipWith const . drop 1) <*> (drop 2))) }
{
data Token
= TokenTag
| TokenAfter
| TokenAnd
| TokenAny
| TokenBefore
| TokenNot
| TokenNow
| TokenOr
| TokenInt Integer
| TokenEq
| TokenLt
| TokenGt
| TokenLParen
| TokenRParen
| TokenEOF
| TokenPKVersion
| TokenSigVersion
| TokenSigType
| TokenPKAlgo
| TokenSigPKAlgo
| TokenHashAlgo
| TokenRSA
| TokenDSA
| TokenElgamal
| TokenECDSA
| TokenECDH
| TokenDH
| TokenBinary
| TokenCanonicalText
| TokenStandalone
| TokenGenericCert
| TokenPersonaCert
| TokenCasualCert
| TokenPositiveCert
| TokenSubkeyBindingSig
| TokenPrimaryKeyBindingSig
| TokenSignatureDirectlyOnAKey
| TokenKeyRevocationSig
| TokenSubkeyRevocationSig
| TokenCertRevocationSig
| TokenTimestampSig
| TokenMD5
| TokenSHA1
| TokenRIPEMD160
| TokenSHA256
| TokenSHA384
| TokenSHA512
| TokenSHA224
| TokenKeysize
| TokenTimestamp
| TokenFingerprint
| TokenKeyID
| TokenFpr TwentyOctetFingerprint
| TokenLongID (Either String EightOctetKeyId)
| TokenLength
| TokenEvery
| TokenOne
| TokenOf
| TokenContains
| TokenUids
| TokenStr String
| TokenA
| TokenSubkey
| TokenSigCreationTime
deriving (Eq,Show)
alexEOF = return TokenEOF
lex :: (String -> a) -> AlexAction a
lex f = \(_,_,_,s) i -> return (f (take i s))
lex' :: a -> AlexAction a
lex' = lex . const
}
hopenpgp-tools-0.23.11/HOpenPGP/Tools/Parser.y 0000644 0000000 0000000 00000020113 07346545000 017130 0 ustar 00 0000000 0000000 {
{-# OPTIONS -w #-}
module HOpenPGP.Tools.Parser( parseTKExp, parsePExp ) where
import Codec.Encryption.OpenPGP.Types
-- import Data.Conduit.OpenPGP.Filter (Expr(..), UPredicate(..), UOp(..), OVar(..), OValue(..), SPVar(..), SPValue(..), PKPVar(..), PKPValue(..))
import HOpenPGP.Tools.Common (pkpGetPKVersion, pkpGetPKAlgo, pkpGetKeysize, pkpGetTimestamp, pkpGetFingerprint, pkpGetEOKI, tkUsingPKP, tkGetUIDs, tkGetSubs, anyOrAll, anyReader, oGetTag, oGetLength, spGetSigVersion, spGetSigType, spGetPKAlgo, spGetHashAlgo, spGetSCT, pUsingPKP, pUsingSP, maybeR)
import HOpenPGP.Tools.Lexer
import Control.Applicative (liftA2)
import Codec.Encryption.OpenPGP.Fingerprint (eightOctetKeyID, fingerprint)
import Codec.Encryption.OpenPGP.KeyInfo (pubkeySize)
import Control.Error.Util (hush)
import Control.Monad.Loops (allM, anyM)
import Control.Monad.Trans.Reader (ask, reader, Reader, withReader)
import Data.List (isInfixOf)
import qualified Data.Text as T
import Prettyprinter (pretty)
}
%name parseTK Exp
%name parseP CFExp
%tokentype { Token }
%monad { Alex }
%lexer { lexwrap } { TokenEOF }
%error { happyError }
%token
a { TokenA }
and { TokenAnd }
any { TokenAny }
contains { TokenContains }
every { TokenEvery }
not { TokenNot }
now { TokenNow }
of { TokenOf }
one { TokenOne }
or { TokenOr }
subkey { TokenSubkey }
tag { TokenTag }
int { TokenInt $$ }
'=' { TokenEq }
'<' { TokenLt }
'>' { TokenGt }
'(' { TokenLParen }
')' { TokenRParen }
pkversion { TokenPKVersion }
sigversion { TokenSigVersion }
sigtype { TokenSigType }
pkalgo { TokenPKAlgo }
sigpkalgo { TokenSigPKAlgo }
hashalgo { TokenHashAlgo }
rsa { TokenRSA }
dsa { TokenDSA }
elgamal { TokenElgamal }
ecdsa { TokenECDSA }
ecdh { TokenECDH }
dh { TokenDH }
binary { TokenBinary }
canonicaltext { TokenCanonicalText }
standalone { TokenStandalone }
genericcert { TokenGenericCert }
personacert { TokenPersonaCert }
casualcert { TokenCasualCert }
positivecert { TokenPositiveCert }
subkeybindingsig { TokenSubkeyBindingSig }
primarykeybindingsig { TokenPrimaryKeyBindingSig }
signaturedirectlyonakey { TokenSignatureDirectlyOnAKey }
keyrevocationsig { TokenKeyRevocationSig }
subkeyrevocationsig { TokenSubkeyRevocationSig }
certrevocationsig { TokenCertRevocationSig }
timestampsig { TokenTimestampSig }
md5 { TokenMD5 }
sha1 { TokenSHA1 }
ripemd160 { TokenRIPEMD160 }
sha256 { TokenSHA256 }
sha384 { TokenSHA384 }
sha512 { TokenSHA512 }
sha224 { TokenSHA224 }
keysize { TokenKeysize }
timestamp { TokenTimestamp }
fingerprint { TokenFingerprint }
keyid { TokenKeyID }
sigcreationtime { TokenSigCreationTime }
fpr { TokenFpr $$ }
longid { TokenLongID $$ }
length { TokenLength }
str { TokenStr $$ }
uids { TokenUids }
%%
Exp : any { return True }
| not Exp { fmap not $2 }
| Exp and Exp { liftA2 (&&) $1 $3 }
| Exp or Exp { liftA2 (||) $1 $3 }
| PExp { tkUsingPKP $1 }
| TExp { $1 }
PExp : pkversion PIOp int { $2 (reader pkpGetPKVersion) (return $3) }
| pkalgo PIOp Ppkalgos { $2 (reader pkpGetPKAlgo) (return $3) }
| keysize PIOp int { $2 (reader pkpGetKeysize) (return $3) }
| timestamp PIOp int { $2 (reader pkpGetTimestamp) (return $3) }
| fingerprint PSOp Pfingerprint { $2 (reader (show . pretty . pkpGetFingerprint)) (return $3) }
| keyid PSOp Plongid { $2 (reader pkpGetEOKI) (return $3) }
TExp : every one of uids AATOp str { withReader tkGetUIDs (anyOrAll allM ($5 (return (T.pack $6)))) }
| any one of uids AATOp str { withReader tkGetUIDs (anyOrAll anyM ($5 (return (T.pack $6)))) }
| any of uids AATOp str { withReader tkGetUIDs (anyOrAll anyM ($4 (return (T.pack $5)))) }
| a subkey PExp { withReader tkGetSubs (anyReader $3) }
PIOp : '=' { liftA2 (==) }
| '<' { liftA2 (<) }
| '>' { liftA2 (>) }
PSOp : '=' { liftA2 (==) }
| contains { liftA2 (flip isInfixOf) }
AATOp : '=' { liftA2 (==) }
| contains { liftA2 T.isInfixOf }
Ppkalgos : rsa { fromIntegral (fromFVal RSA) }
| dsa { fromIntegral (fromFVal DSA) }
| elgamal { fromIntegral (fromFVal ElgamalEncryptOnly) }
| ecdsa { fromIntegral (fromFVal ECDSA) }
| ecdh { fromIntegral (fromFVal ECDH) }
| dh { fromIntegral (fromFVal DH) }
| int { fromIntegral $1 }
Pfingerprint : fpr { (show . pretty) $1 }
Plongid : longid { either (const "BROKEN") show $1 }
CFExp : any { return True }
| not CFExp { fmap not $2 }
| CFExp and CFExp { liftA2 (&&) $1 $3 }
| CFExp or CFExp { liftA2 (||) $1 $3 }
| OExp { $1 }
| SPExp { $1 }
| PExp { pUsingPKP (maybeR True $1) }
OExp : tag OIOp int { $2 (reader oGetTag) (return $3) }
| length OIOp int { $2 (reader oGetLength) (return $3) }
OIOp : '=' { liftA2 (==) }
| '<' { liftA2 (<) }
| '>' { liftA2 (>) }
SPExp : sigversion SIOp int { $2 (reader spGetSigVersion) (return (Just $3)) }
| sigtype SIOp Ssigtypes { $2 (reader spGetSigType) (return (Just $3)) }
| sigpkalgo SIOp Spkalgos { $2 (reader spGetPKAlgo) (return (Just $3)) }
| hashalgo SIOp Shashalgos { $2 (reader spGetHashAlgo) (return (Just $3)) }
| sigcreationtime SIOp Stimespec { $2 (reader spGetSCT) (return (Just $3)) }
SIOp : '=' { liftA2 (==) }
| '<' { liftA2 (<) }
| '>' { liftA2 (>) }
Ssigtypes : binary { fromIntegral (fromFVal BinarySig) }
| canonicaltext { fromIntegral (fromFVal CanonicalTextSig) }
| standalone { fromIntegral (fromFVal StandaloneSig) }
| genericcert { fromIntegral (fromFVal GenericCert) }
| personacert { fromIntegral (fromFVal PersonaCert) }
| casualcert { fromIntegral (fromFVal CasualCert) }
| positivecert { fromIntegral (fromFVal PositiveCert) }
| subkeybindingsig { fromIntegral (fromFVal SubkeyBindingSig) }
| primarykeybindingsig { fromIntegral (fromFVal PrimaryKeyBindingSig) }
| signaturedirectlyonakey { fromIntegral (fromFVal SignatureDirectlyOnAKey) }
| keyrevocationsig { fromIntegral (fromFVal KeyRevocationSig) }
| subkeyrevocationsig { fromIntegral (fromFVal SubkeyRevocationSig) }
| certrevocationsig { fromIntegral (fromFVal CertRevocationSig) }
| timestampsig { fromIntegral (fromFVal TimestampSig) }
| int { fromIntegral $1 }
Spkalgos : rsa { fromIntegral (fromFVal RSA) }
| dsa { fromIntegral (fromFVal DSA) }
| elgamal { fromIntegral (fromFVal ElgamalEncryptOnly) }
| ecdsa { fromIntegral (fromFVal ECDSA) }
| ecdh { fromIntegral (fromFVal ECDH) }
| dh { fromIntegral (fromFVal DH) }
| int { fromIntegral $1 }
Shashalgos : md5 { fromIntegral (fromFVal DeprecatedMD5) }
| sha1 { fromIntegral (fromFVal SHA1) }
| ripemd160 { fromIntegral (fromFVal RIPEMD160) }
| sha256 { fromIntegral (fromFVal SHA256) }
| sha384 { fromIntegral (fromFVal SHA384) }
| sha512 { fromIntegral (fromFVal SHA512) }
| sha224 { fromIntegral (fromFVal SHA224) }
| int { fromIntegral $1 }
Stimespec : now { 0 }
| int { fromIntegral $1 }
{
lexwrap :: (Token -> Alex a) -> Alex a
lexwrap cont = do
t <- alexMonadScan'
cont t
alexMonadScan' = do
inp <- alexGetInput
sc <- alexGetStartCode
case alexScan inp sc of
AlexEOF -> alexEOF
AlexError (pos, _, _, _) -> alexError (show pos)
AlexSkip inp' len -> do
alexSetInput inp'
alexMonadScan'
AlexToken inp' len action -> do
alexSetInput inp'
action (ignorePendingBytes inp) len
getPosn :: Alex (Int,Int)
getPosn = do
(AlexPn _ l c,_,_,_) <- alexGetInput
return (l,c)
happyError :: Token -> Alex a
happyError t = do
(l,c) <- getPosn
error (show l ++ ":" ++ show c ++ ": Parse error on Token: " ++ show t ++ "\n")
parseTKExp :: String -> Either String (Reader TK Bool)
parseTKExp s = runAlex s parseTK
parsePExp :: String -> Either String (Reader Pkt Bool)
parsePExp s = runAlex s parseP
}
hopenpgp-tools-0.23.11/HOpenPGP/Tools/TKUtils.hs 0000644 0000000 0000000 00000006472 07346545000 017411 0 ustar 00 0000000 0000000 -- TKUtils.hs: hOpenPGP-tools TK-related common functions
-- Copyright © 2013-2023 Clint Adams
--
-- vim: softtabstop=4:shiftwidth=4:expandtab
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see .
module HOpenPGP.Tools.TKUtils
( processTK
) where
import Codec.Encryption.OpenPGP.Fingerprint (eightOctetKeyID, fingerprint)
import Codec.Encryption.OpenPGP.Signatures
( verifyAgainstKeys
, verifySigWith
, verifyTKWith
)
import Codec.Encryption.OpenPGP.Types
import Control.Arrow (second)
import Control.Error.Util (hush)
import Control.Lens ((^.), _1)
import Data.List (sortOn)
import Data.Maybe (listToMaybe, mapMaybe)
import Data.Ord (Down(..))
import Data.Time.Clock.POSIX (POSIXTime, posixSecondsToUTCTime)
-- should this fail or should verifyTKWith fail if there are no self-sigs?
processTK :: Maybe POSIXTime -> TK -> Either String TK
processTK mpt key =
verifyTKWith
(verifySigWith (verifyAgainstKeys [key]))
(fmap posixSecondsToUTCTime mpt) .
stripOlderSigs .
stripOtherSigs $
key
where
stripOtherSigs tk =
tk
{ _tkUIDs = map (second alleged) (_tkUIDs tk)
, _tkUAts = map (second alleged) (_tkUAts tk)
}
stripOlderSigs tk =
tk
{ _tkUIDs = map (second newest) (_tkUIDs tk)
, _tkUAts = map (second newest) (_tkUAts tk)
}
newest = take 1 . sortOn (Down . take 1 . sigcts) -- FIXME: this is terrible
sigcts (SigV4 _ _ _ xs _ _ _) =
map (\(SigSubPacket _ (SigCreationTime x)) -> x) $ filter isCT xs
pkp = key ^. tkKey . _1
alleged = filter (\x -> assI x || assIFP x)
isCT (SigSubPacket _ (SigCreationTime _)) = True
isCT _ = False
sigissuer (SigVOther 2 _) = Nothing
sigissuer SigV3 {} = Nothing
sigissuer (SigV4 _ _ _ ys xs _ _) =
listToMaybe . mapMaybe (getIssuer . _sspPayload) $ (ys ++ xs) -- FIXME: what should this be if there are multiple matches?
sigissuer (SigVOther _ _) = error "We're in the future." -- FIXME
sigissuerfp (SigV4 _ _ _ ys xs _ _) =
listToMaybe . mapMaybe (getIssuerFP . _sspPayload) $ (ys ++ xs) -- FIXME: what should this be if there are multiple matches?
sigissuerfp _ = Nothing
eoki
| pkp ^. keyVersion == V4 = hush . eightOctetKeyID $ pkp
| pkp ^. keyVersion == DeprecatedV3 &&
elem (pkp ^. pkalgo) [RSA, DeprecatedRSASignOnly] =
hush . eightOctetKeyID $ pkp
| otherwise = Nothing
fp
| pkp ^. keyVersion == V4 = Just . fingerprint $ pkp
| otherwise = Nothing
getIssuer (Issuer i) = Just i
getIssuer _ = Nothing
getIssuerFP (IssuerFingerprint 4 i) = Just i
getIssuerFP _ = Nothing
assI x = ((==) <$> sigissuer x <*> eoki) == Just True
assIFP x = ((==) <$> sigissuerfp x <*> fp) == Just True
hopenpgp-tools-0.23.11/LICENSE 0000644 0000000 0000000 00000103330 07346545000 014032 0 ustar 00 0000000 0000000 GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
.
hopenpgp-tools-0.23.11/Setup.hs 0000644 0000000 0000000 00000000056 07346545000 014462 0 ustar 00 0000000 0000000 import Distribution.Simple
main = defaultMain
hopenpgp-tools-0.23.11/hkt.hs 0000644 0000000 0000000 00000042214 07346545000 014152 0 ustar 00 0000000 0000000 -- hkt.hs: hOpenPGP key tool
-- Copyright © 2013-2022 Clint Adams
--
-- vim: softtabstop=4:shiftwidth=4:expandtab
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see .
{-# LANGUAGE DeriveGeneric #-}
import Codec.Encryption.OpenPGP.Fingerprint (eightOctetKeyID, fingerprint)
import Codec.Encryption.OpenPGP.KeyInfo (pkalgoAbbrev, pubkeySize)
import Codec.Encryption.OpenPGP.KeySelection
( parseEightOctetKeyId
, parseFingerprint
)
import Codec.Encryption.OpenPGP.Serialize ()
import Codec.Encryption.OpenPGP.Signatures
( verifyAgainstKeyring
, verifySigWith
, verifyTKWith
)
import Codec.Encryption.OpenPGP.Types
import Control.Applicative ((<|>), optional)
import Control.Arrow ((&&&))
import Control.Lens ((^.), (^..), _1, _2)
import Control.Monad.Trans.Except (except, runExcept)
import Control.Monad.Trans.Resource (MonadResource, MonadThrow)
import qualified Data.Aeson as A
import Data.Binary (get, put)
import Data.Binary.Put (runPut)
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as BL
import Data.Conduit (ConduitM, (.|), runConduitRes)
import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.List as CL
import Data.Conduit.OpenPGP.Filter
( FilterPredicates(RTKFilterPredicate)
, conduitTKFilter
)
import Data.Conduit.OpenPGP.Keyring (conduitToTKsDropping, sinkKeyringMap)
import Data.Conduit.Serialization.Binary (conduitGet)
import Data.Data.Lens (biplate)
import Data.Either (rights)
import Data.Graph.Inductive.Graph (Graph(mkGraph), Path, emap, prettyPrint)
import Data.Graph.Inductive.PatriciaTree (Gr)
import Data.Graph.Inductive.Query.SP (sp)
import Data.GraphViz (GraphvizParams(..), graphToDot, nonClusteredParams)
import Data.GraphViz.Attributes (toLabel)
import Data.GraphViz.Types (printDotGraph)
import Data.HashMap.Lazy (HashMap)
import qualified Data.HashMap.Lazy as HashMap
import qualified Data.IxSet.Typed as IxSet
import Data.List (nub, sort)
import Data.Map (Map)
import qualified Data.Map as Map
import Data.Maybe (fromMaybe, listToMaybe, mapMaybe)
import Data.Text (Text)
import qualified Data.Text as T
import qualified Data.Text.Lazy.IO as TLIO
import Data.Time.Clock.POSIX (getPOSIXTime, posixSecondsToUTCTime)
import Data.Tuple (swap)
import qualified Data.Yaml as Y
import GHC.Generics
import HOpenPGP.Tools.Common
( banner
, keyMatchesEightOctetKeyId
, keyMatchesFingerprint
, keyMatchesUIDSubString
, versioner
, warranty
)
import HOpenPGP.Tools.Parser (parseTKExp)
import System.Directory (getHomeDirectory)
import Options.Applicative.Builder
( argument
, auto
, command
, footerDoc
, headerDoc
, help
, helpDoc
, info
, long
, metavar
, option
, prefs
, progDesc
, showDefault
, showHelpOnError
, str
, strOption
, switch
, value
)
import Options.Applicative.Extra (customExecParser, helper, hsubparser)
import Options.Applicative.Types (Parser)
import Prettyprinter.Render.Text (hPutDoc, putDoc)
import Prettyprinter ((<+>), fillSep, hardline, list, pretty)
import System.IO (BufferMode(..), Handle, hFlush, hSetBuffering, stderr)
grabMatchingKeysConduit ::
(MonadResource m, MonadThrow m)
=> FilePath
-> Bool
-> Text
-> ConduitM () TK m ()
grabMatchingKeysConduit fp filt srch =
CB.sourceFile fp .| conduitGet get .| conduitToTKsDropping .|
(if filt
then conduitTKFilter ufp
else CL.filter matchAny)
where
matchAny tk =
either (const False) id $ runExcept $ fmap (keyMatchesFingerprint True tk) efp <|>
fmap (keyMatchesEightOctetKeyId True tk . Right) eeok <|>
return (keyMatchesUIDSubString srch tk)
efp = (except . parseFingerprint) srch
eeok = (except . parseEightOctetKeyId) srch
ufp = RTKFilterPredicate (parseE srch)
parseE =
either (error . ("filter parse error: " ++)) id . parseTKExp . T.unpack -- this should be more specialized
grabMatchingKeys :: FilePath -> Bool -> Text -> IO [TK]
grabMatchingKeys fp filt srch =
runConduitRes $ grabMatchingKeysConduit fp filt srch .| CL.consume
grabMatchingKeysKeyring :: FilePath -> Bool -> Text -> IO Keyring
grabMatchingKeysKeyring fp filt srch =
runConduitRes $ grabMatchingKeysConduit fp filt srch .| sinkKeyringMap
data Key =
Key
{ keysize :: Maybe Int
, keyalgo :: String
, keyalgoabbreviation :: String
, fpr :: String
}
deriving (Generic)
data TKey =
TKey
{ publickey :: Key
, uids :: [Text]
, subkeys :: [Key]
}
deriving (Generic)
instance A.ToJSON Key
instance A.ToJSON TKey
tkToTKey :: TK -> TKey
tkToTKey tk =
TKey
{ publickey = mkey (tk ^. tkKey . _1)
, uids = tk ^. tkUIDs ^.. traverse . _1
, subkeys = map (mkey . \(PublicSubkeyPkt x, _) -> x) (tk ^. tkSubs)
}
where
mkey =
Key <$> either (const Nothing) Just . pubkeySize . _pubkey <*> show .
_pkalgo <*>
pkalgoAbbrev .
_pkalgo <*>
show .
pretty .
fingerprint
showTKey :: TKey -> IO ()
showTKey key =
putDoc $ pretty "pub " <+> sizeabbrevkeyid (publickey key) <> hardline <>
mconcat
(map
(\x ->
pretty "uid " <+> pretty (T.unpack x) <>
hardline)
(uids key)) <>
mconcat
(map (\x -> pretty "sub " <+> sizeabbrevkeyid x <> hardline) (subkeys key)) <>
hardline
where
sizeabbrevkeyid k =
pretty (maybe "unknown" show (keysize k)) <>
pretty (keyalgoabbreviation k) <>
pretty "/" <>
pretty (fpr k)
data Options =
Options
{ keyring :: String
, graphOutputFormat :: GraphOutputFormat
, pathsOutputFormat :: PathsOutputFormat
, targetIsFilter :: Bool
, target1 :: String
, target2 :: String
, target3 :: String
}
data Command
= CmdList Options
| CmdExportPubkeys Options
| CmdGraph Options
| CmdFindPaths Options
data GraphOutputFormat
= GraphViz
| LossyPretty
deriving (Bounded, Enum, Eq, Read, Show)
data PathsOutputFormat
= Unstructured
| JSON
| YAML
deriving (Eq, Read, Show)
listO :: String -> Parser Options
listO homedir =
Options <$>
strOption (long "keyring" <> metavar "FILE" <> help "file containing keyring") <*>
pure GraphViz -- unused
<*>
option
auto
(long "output-format" <> metavar "FORMAT" <> value Unstructured <>
showDefault <>
help "output format") <*>
switch (long "filter" <> help "treat target as filter") <*>
(fromMaybe "" <$> optional (argument str (metavar "TARGET" <> targetHelp))) <*>
pure "" <*>
pure ""
where
targetHelp =
helpDoc . Just $ pretty "target (which keys to output)*"
graphO :: String -> Parser Options
graphO homedir =
Options <$>
strOption (long "keyring" <> metavar "FILE" <> help "file containing keyring") <*>
option
auto
(long "output-format" <> metavar "FORMAT" <> value GraphViz <> showDefault <>
ofhelp) <*>
pure Unstructured -- unused
<*>
switch (long "filter" <> help "treat target as filter") <*>
(fromMaybe "" <$> optional (argument str (metavar "TARGET" <> targetHelp))) <*>
pure "" <*>
pure ""
where
ofhelp =
helpDoc . Just $ pretty "output format" <> hardline <>
list (map (pretty . show) ofchoices)
ofchoices = [minBound .. maxBound] :: [GraphOutputFormat]
targetHelp =
helpDoc . Just $ pretty "target (which keys to graph)*"
findPathsO :: String -> Parser Options
findPathsO homedir =
Options <$>
strOption (long "keyring" <> metavar "FILE" <> help "file containing keyring") <*>
pure GraphViz -- unused
<*>
option
auto
(long "output-format" <> metavar "FORMAT" <> value Unstructured <>
showDefault <>
help "output format") <*>
switch (long "filter" <> help "treat targets as filter") <*>
argument str (metavar "TARGET-SET" <> targetHelp) <*>
argument str (metavar "FROM-KEYS" <> fromHelp) <*>
argument str (metavar "TO-KEYS" <> toHelp)
where
targetHelp =
helpDoc . Just $
pretty "target (which keys to use in pathfinding)*"
fromHelp =
helpDoc . Just $
pretty "from (which keys to use for the source of paths)*"
toHelp =
helpDoc . Just $
pretty "to (which keys to use for the destinations of paths)*"
dispatch :: Command -> IO ()
dispatch (CmdList o) = banner' stderr >> hFlush stderr >> doList o
dispatch (CmdExportPubkeys o) =
banner' stderr >> hFlush stderr >> doExportPubkeys o
dispatch (CmdGraph o) = banner' stderr >> hFlush stderr >> doGraph o
dispatch (CmdFindPaths o) = banner' stderr >> hFlush stderr >> doFindPaths o
main :: IO ()
main = do
hSetBuffering stderr LineBuffering
homedir <- getHomeDirectory
customExecParser
(prefs showHelpOnError)
(info
(helper <*> versioner "hkt" <*> cmd homedir)
(headerDoc (Just (banner "hkt")) <>
progDesc "hOpenPGP Keyring Tool" <>
footerDoc (Just (warranty "hkt")))) >>=
dispatch
cmd :: String -> Parser Command
cmd homedir =
hsubparser
(command
"export-pubkeys"
(info
(CmdExportPubkeys <$> listO homedir)
(progDesc "export matching keys to stdout" <> footerDoc (Just foot))) <>
command
"findpaths"
(info
(CmdFindPaths <$> findPathsO homedir)
(progDesc "find short paths between keys" <> footerDoc (Just foot))) <>
command
"graph"
(info
(CmdGraph <$> graphO homedir)
(progDesc "graph certifications" <> footerDoc (Just foot))) <>
command
"list"
(info
(CmdList <$> listO homedir)
(progDesc "list matching keys" <> footerDoc (Just foot))))
where
foot =
hardline <>
fillSep
[ pretty "*if --filter is not specified, this must be"
, pretty "a fingerprint,"
, pretty "an eight-octet key ID,"
, pretty "or a substring of a UID (including an empty string)"
] <>
hardline <>
fillSep
[ pretty "if --filter is specified, it must be"
, pretty "something in filter syntax (see source)."
]
banner' :: Handle -> IO ()
banner' h = hPutDoc h (banner "hkt" <> hardline <> warranty "hkt" <> hardline)
doList :: Options -> IO ()
doList o = do
let ttarget1 = T.pack . target1
keys' <- grabMatchingKeys (keyring o) (targetIsFilter o) (ttarget1 o)
let keys = map tkToTKey keys'
case pathsOutputFormat o of
Unstructured -> mapM_ showTKey keys
JSON -> BL.putStr . A.encode $ keys
YAML -> B.putStr . Y.encode $ keys
putStrLn ""
doExportPubkeys :: Options -> IO ()
doExportPubkeys o = do
let ttarget1 = T.pack . target1
keys <- grabMatchingKeys (keyring o) (targetIsFilter o) (ttarget1 o)
case pathsOutputFormat o of
Unstructured -> mapM_ (BL.putStr . putTK') keys
JSON -> BL.putStr . A.encode $ keys
YAML -> B.putStr . Y.encode $ keys
where
putTK' key =
runPut $ do
put (PublicKey (key ^. tkKey . _1))
mapM_ (put . Signature) (_tkRevs key)
mapM_ putUid' (_tkUIDs key)
mapM_ putUat' (_tkUAts key)
mapM_ putSub' (_tkSubs key)
putUid' (u, sps) = put (UserId u) >> mapM_ (put . Signature) sps
putUat' (us, sps) = put (UserAttribute us) >> mapM_ (put . Signature) sps
putSub' (p, sps) = put p >> mapM_ (put . Signature) sps
doGraph :: Options -> IO ()
doGraph o = do
let ttarget1 = T.pack . target1
cpt <- getPOSIXTime
kr <- grabMatchingKeysKeyring (keyring o) (targetIsFilter o) (ttarget1 o)
let g =
buildKeyGraph
((buildMaps &&& id)
(rights
(map
(verifyTKWith
(verifySigWith (verifyAgainstKeyring kr))
(Just (posixSecondsToUTCTime cpt)))
(IxSet.toList kr))))
case graphOutputFormat o of
LossyPretty -> prettyPrint g
GraphViz ->
TLIO.putStrLn . printDotGraph . graphToDot nonClusteredLabeledNodesParams $
g
where
nonClusteredLabeledNodesParams =
nonClusteredParams {fmtNode = \(_, l) -> [toLabel $ show (pretty l)]}
buildMaps :: [TK] -> (KeyMaps, Int)
buildMaps =
foldr mapsInsertions (KeyMaps HashMap.empty HashMap.empty HashMap.empty, 0)
-- FIXME: this presumes no keyID collisions in the input
data KeyMaps =
KeyMaps
{ _k2f :: HashMap EightOctetKeyId TwentyOctetFingerprint
, _f2i :: HashMap TwentyOctetFingerprint Int
, _i2f :: HashMap Int TwentyOctetFingerprint
}
mapsInsertions :: TK -> (KeyMaps, Int) -> (KeyMaps, Int)
mapsInsertions tk (KeyMaps k2f f2i i2f, i) =
let fp = fingerprint (tk ^. tkKey . _1)
keyids = rights . map eightOctetKeyID $ (tk ^.. biplate :: [PKPayload])
i' = i + 1
k2f' = foldr (\k m -> HashMap.insert k fp m) k2f keyids
f2i' = HashMap.insert fp i' f2i
i2f' = HashMap.insert i' fp i2f
in (KeyMaps k2f' f2i' i2f', i')
buildKeyGraph ::
((KeyMaps, Int), [TK]) -> Gr TwentyOctetFingerprint HashAlgorithm
buildKeyGraph ((KeyMaps k2f f2i _, _), ks) = mkGraph nodes edges
where
nodes = map swap . HashMap.toList $ f2i
edges = filter (not . samesies) . nub . sort . concatMap tkToEdges $ ks
tkToEdges tk =
map
(\(ha, i) -> (source i, target tk, ha))
(mapMaybe (fakejoin . (hashAlgo &&& sigissuer)) (sigs tk))
target tk =
fromMaybe
(error "Epic fail")
(HashMap.lookup (fingerprint (tk ^. tkKey . _1)) f2i)
source i = fromMaybe (-1) (HashMap.lookup i k2f >>= flip HashMap.lookup f2i)
fakejoin (x, y) = fmap ((,) x) y
sigs tk =
concat
((tk ^.. tkUIDs . traverse . _2) ++ (tk ^.. tkUAts . traverse . _2))
samesies (x, y, _) = x == y
data PaF =
PaF
{ certPaths :: [Path]
, keyFingerprints :: Map String TwentyOctetFingerprint
}
deriving (Generic)
instance A.ToJSON PaF
doFindPaths :: Options -> IO ()
doFindPaths o = do
let ttarget1 = T.pack . target1
ttarget2 = T.pack . target2
ttarget3 = T.pack . target3
cpt <- getPOSIXTime
kr <- grabMatchingKeysKeyring (keyring o) (targetIsFilter o) (ttarget1 o)
-- FIXME: seriously clean this up
keys1 <-
runConduitRes $ CL.sourceList (IxSet.toList kr) .|
(if filt
then conduitTKFilter (ufpt (ttarget2 o))
else CL.filter (matchAny (ttarget2 o))) .|
CL.consume
keys2 <-
runConduitRes $ CL.sourceList (IxSet.toList kr) .|
(if filt
then conduitTKFilter (ufpt (ttarget3 o))
else CL.filter (matchAny (ttarget3 o))) .|
CL.consume
let ((KeyMaps k2f f2i i2f, i), ks) =
(buildMaps &&& id)
(rights
(map
(verifyTKWith
(verifySigWith (verifyAgainstKeyring kr))
(Just (posixSecondsToUTCTime cpt)))
(IxSet.toList kr)))
keygraph = buildKeyGraph ((KeyMaps k2f f2i i2f, i), ks)
keysToIs =
mapMaybe (\x -> HashMap.lookup (fingerprint (x ^. tkKey . _1)) f2i)
froms = keysToIs keys1
tos = keysToIs keys2
combos = froms >>= \f -> tos >>= \t -> return (f, t)
paths =
map
(\(x, y) ->
fromMaybe [] (sp x y (emap (const (1.0 :: Double)) keygraph)))
combos
paf =
PaF
paths
(Map.fromList
(mapMaybe
(\x -> HashMap.lookup x i2f >>= \y -> return (show x, y))
(nub (sort (concat paths)))))
case pathsOutputFormat o of
Unstructured -- FIXME: do something about this
-> do
putStrLn . unlines $ map (show . ((,) =<< length)) paths
putStrLn . unlines $
map
(\x ->
maybe (show x) show $ HashMap.lookup x i2f >>= \y ->
return (x, pretty y))
(nub (sort (concat paths)))
JSON -> BL.putStr . A.encode $ paf
YAML -> B.putStr . Y.encode $ paf
putStrLn ""
where
filt = targetIsFilter o
matchAny srch tk =
either (const False) id $ runExcept $
fmap (keyMatchesFingerprint True tk) ((except . parseFingerprint) srch) <|>
fmap
(keyMatchesEightOctetKeyId True tk . Right)
((except . parseEightOctetKeyId) srch) <|>
return (keyMatchesUIDSubString srch tk)
ufpt srch = RTKFilterPredicate (parseE srch)
parseE e =
either (error . ("filter parse error: " ++)) id (parseTKExp (T.unpack e)) -- this should be more specialized
-- FIXME: deduplicate the following code
sigissuer :: SignaturePayload -> Maybe EightOctetKeyId
getIssuer :: SigSubPacketPayload -> Maybe EightOctetKeyId
hashAlgo :: SignaturePayload -> HashAlgorithm
sigissuer (SigVOther 2 _) = Nothing
sigissuer SigV3 {} = Nothing
sigissuer (SigV4 _ _ _ ys xs _ _) =
listToMaybe . mapMaybe (getIssuer . _sspPayload) $ (ys ++ xs) -- FIXME: what should this be if there are multiple matches?
sigissuer (SigVOther _ _) = error "We're in the future." -- FIXME
getIssuer (Issuer i) = Just i
getIssuer _ = Nothing
hashAlgo (SigV4 _ _ x _ _ _ _) = x
hashAlgo _ = error "V3 sig not supported here"
hopenpgp-tools-0.23.11/hokey.hs 0000644 0000000 0000000 00000063072 07346545000 014510 0 ustar 00 0000000 0000000 -- hokey.hs: hOpenPGP key tool
-- Copyright © 2013-2022 Clint Adams
--
-- vim: softtabstop=4:shiftwidth=4:expandtab
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see .
{-# LANGUAGE DeriveFunctor #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE TypeApplications #-}
import Codec.Encryption.OpenPGP.Expirations (getKeyExpirationTimesFromSignature)
import Codec.Encryption.OpenPGP.Fingerprint (eightOctetKeyID, fingerprint)
import Codec.Encryption.OpenPGP.KeyInfo (pkalgoAbbrev, pubkeySize)
import Codec.Encryption.OpenPGP.KeySelection (parseFingerprint)
import Codec.Encryption.OpenPGP.Ontology
( isCT
, isCertRevocationSig
, isKUF
, isPHA
, isPKBindingSig
, isSKBindingSig
)
import Codec.Encryption.OpenPGP.Serialize ()
import Codec.Encryption.OpenPGP.Types
import Control.Arrow ((***))
import Control.Error.Util (hush)
import Control.Lens ((&), (^.), _1, _2, mapped, over)
import Control.Monad.Trans.Except (runExceptT)
import Control.Monad.Trans.Writer.Lazy (execWriter, tell)
import qualified Crypto.Hash as CH
import qualified Crypto.Hash.Algorithms as CHA
import qualified Data.Aeson as A
import Data.Binary (get, put)
import qualified Data.ByteArray as BA
import qualified Data.ByteString as B
import qualified Data.ByteString.Base16 as Base16
import qualified Data.ByteString.Char8 as BC8
import qualified Data.ByteString.Lazy as BL
import Data.Conduit ((.|), runConduitRes)
import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.List as CL
import Data.Conduit.OpenPGP.Keyring (conduitToTKsDropping)
import Data.Conduit.Serialization.Binary (conduitGet, conduitPut)
import Data.Foldable (find)
import Data.List (elemIndex, findIndex, intercalate, nub, sort, sortOn)
import qualified Data.Map as Map
import Data.Maybe (fromMaybe, listToMaybe, mapMaybe)
import Data.Ord (Down(..))
import Data.Semigroup (Semigroup, (<>))
import qualified Data.Set as Set
import Data.Text (Text)
import qualified Data.Text as T
import Data.Time.Clock.POSIX (POSIXTime, getPOSIXTime, posixSecondsToUTCTime)
import Data.Time.Format (formatTime)
import qualified Data.Yaml as Y
import GHC.Generics
import HOpenPGP.Tools.Common (banner, versioner, warranty)
import HOpenPGP.Tools.HKP (FetchValidationMethod(..), fetchKeys, rearmorKeys)
import HOpenPGP.Tools.TKUtils (processTK)
import Options.Applicative.Builder
( argument
, auto
, command
, eitherReader
, footerDoc
, headerDoc
, help
, helpDoc
, info
, long
, metavar
, option
, prefs
, progDesc
, showDefault
, showHelpOnError
, str
, value
)
import Options.Applicative.Extra (customExecParser, helper, hsubparser)
import Options.Applicative.Types (Parser)
import Data.Time.Locale.Compat (defaultTimeLocale)
import System.IO
( BufferMode(..)
, Handle
, hFlush
, hPutStrLn
, hSetBuffering
, stderr
, stdin
, stdout
)
import Prettyprinter
( Doc
, (<+>)
, annotate
, colon
, flatAlt
, hardline
, indent
, line
, list
, pretty
)
import qualified Prettyprinter.Render.Terminal as PPA
linebreak = flatAlt line mempty
green = annotate (PPA.color PPA.Green)
yellow = annotate (PPA.color PPA.Yellow)
red = annotate (PPA.color PPA.Red)
data KAS =
KAS
{ pubkeyalgo :: Colored PubKeyAlgorithm
, pubkeysize :: Colored (Maybe Int)
, stringrep :: String
}
deriving (Generic)
data Color
= Green
| Yellow
| Red
deriving (Eq, Generic, Ord)
data Colored a =
Colored
{ color :: Maybe Color
, explanation :: Maybe String
, val :: a
}
deriving (Functor, Generic)
newtype FakeMap a b =
FakeMap
{ unFakeMap :: [(a, b)]
}
data KeyReport =
KeyReport
{ keyStatus :: String
, keyFingerprint :: TwentyOctetFingerprint
, keyVer :: Colored KeyVersion
, keyCreationTime :: ThirtyTwoBitTimeStamp
, keyAlgorithmAndSize :: KAS
, keyUIDsAndUAts :: FakeMap Text (Colored UIDReport)
, keyBestOf :: Maybe UIDReport
, keySubkeys :: [SubkeyReport]
, keyHasEncryptionCapableSubkey :: Colored Bool
}
deriving (Generic)
data UIDReport =
UIDReport
{ uidSelfSigHashAlgorithms :: [Colored HashAlgorithm]
, uidPreferredHashAlgorithms :: [Colored [HashAlgorithm]]
, uidKeyExpirationTimes :: [Colored [ThirtyTwoBitDuration]]
, uidKeyUsageFlags :: [Colored (Set.Set KeyFlag)]
, uidRevocationStatus :: [RevocationStatus]
}
deriving (Generic)
data SubkeyReport =
SubkeyReport
{ skFingerprint :: Colored TwentyOctetFingerprint
, skVer :: Colored KeyVersion
, skCreationTime :: ThirtyTwoBitTimeStamp
, skAlgorithmAndSize :: KAS
, skBindingSigHashAlgorithms :: [Colored HashAlgorithm]
, skUsageFlags :: [Colored (Set.Set KeyFlag)]
, skCrossCerts :: CrossCertReport
}
deriving (Generic)
data CrossCertReport =
CrossCertReport
{ ccPresent :: Colored Bool
, ccHashAlgorithms :: [Colored HashAlgorithm]
}
deriving (Generic)
data RevocationStatus =
RevocationStatus
{ isRevoked :: Bool
, revocationCode :: String
, revocationReason :: Text
}
deriving (Generic)
instance A.ToJSON KAS
instance A.ToJSON Color
instance (A.ToJSON a) => A.ToJSON (Colored a)
instance A.ToJSON KeyReport
instance A.ToJSON UIDReport
instance A.ToJSON SubkeyReport
instance A.ToJSON CrossCertReport
instance A.ToJSON b => A.ToJSON (FakeMap Text b) where
toJSON = A.toJSON . Map.fromList . unFakeMap
instance A.ToJSON RevocationStatus
instance Semigroup UIDReport where
(<>) (UIDReport a b c d e) (UIDReport a' b' c' d' e') =
UIDReport (a <> a') (b <> b') (c <> c') (d <> d') (e <> e')
instance Monoid UIDReport where
mempty = UIDReport [] [] [] [] []
mappend = (<>)
checkKey :: Maybe POSIXTime -> TK -> KeyReport
checkKey mpt key =
(\x ->
x
{ keyBestOf = populateBestOf x
, keyHasEncryptionCapableSubkey =
hasEncryptionCapableSubkey (concatMap skUsageFlags (keySubkeys x))
})
KeyReport
{ keyStatus = either id (const "good") processedTK
, keyFingerprint = key ^. tkKey . _1 & fingerprint
, keyVer = key ^. tkKey . _1 . keyVersion & colorizeKV
, keyCreationTime = key ^. tkKey . _1 . timestamp
, keyAlgorithmAndSize = kasIt (key ^. tkKey . _1)
, keyUIDsAndUAts =
FakeMap
(map (\(x, y) -> (x, uidr (Just x) y)) (processedOrOrig ^. tkUIDs) ++
map (uatspsToText *** uidr Nothing) (processedOrOrig ^. tkUAts))
, keyBestOf = Nothing
, keySubkeys =
map (checkSK (key ^. tkKey . _1 & fingerprint)) (key ^. tkSubs)
, keyHasEncryptionCapableSubkey = Colored Nothing Nothing False
}
where
processedOrOrig = either (const key) id processedTK
processedTK = processTK mpt key
kasIt :: PKPayload -> KAS
kasIt pkp = kasIt' (pkp ^. pkalgo) (pkp ^. pubkey & pubkeySize)
kasIt' :: PubKeyAlgorithm -> Either String Int -> KAS
kasIt' pka epks =
KAS
{ pubkeyalgo = colorizePKA pka
, pubkeysize = colorizePKS pka epks
, stringrep = (either (const "unknown") show epks) ++ (pkalgoAbbrev pka)
}
colorizeKV kv =
uncurry
Colored
(if kv == V4
then (Just Green, Nothing)
else (Just Red, Just "not a V4 key"))
kv
colorizePKA pka
| pka `elem` [RSA, EdDSA, ECDH] = Colored (Just Green) Nothing pka
| otherwise =
Colored
(Just Yellow)
(Just "public key algorithm neither RSA nor EdDSA")
pka
colorizePKS pka epks = uncurry Colored (colorizePKS' pka epks) (hush epks)
colorizePKS' pka (Right pks)
| pka `elem` [EdDSA, ECDH] && pks >= 256 = (Just Green, Nothing)
| pka `elem` [EdDSA, ECDH] =
(Just Yellow, Just "Public key size under 256 bits")
| pka == RSA && pks >= 3072 = (Just Green, Nothing)
| pka == RSA && pks >= 2048 =
(Just Yellow, Just "Public key size between 2048 and 3072 bits")
| pka == RSA = (Just Red, Just "Public key size under 2048 bits")
| otherwise = (Nothing, Nothing)
colorizePKS' _ (Left _) =
(Just Red, Just "public key algorithm not understood")
colorizePHAs x =
uncurry
Colored
(if fSHA2Family x < ei DeprecatedMD5 x && fSHA2Family x < ei SHA1 x
then (Just Green, Nothing)
else (Just Red, Just "weak hash with higher preference"))
x
fSHA2Family = fi (`elem` [SHA512, SHA384, SHA256, SHA224])
ei x y = fromMaybe maxBound (elemIndex x y)
fi x y = fromMaybe maxBound (findIndex x y)
colorizeKETs ct ts kes
| null kes = Colored (Just Red) (Just "no expiration set") kes
| any (\ke -> realToFrac ts + realToFrac ke < ct) kes =
Colored (Just Red) (Just "expiration passed") kes
| any (\ke -> realToFrac ts + realToFrac ke > ct + (5 * 31557600)) kes =
Colored (Just Yellow) (Just "expiration too far in future") kes
| otherwise = Colored (Just Green) Nothing kes
eoki pkp
| pkp ^. keyVersion == V4 = hush . eightOctetKeyID $ pkp
| pkp ^. keyVersion == DeprecatedV3 &&
elem (pkp ^. pkalgo) [RSA, DeprecatedRSASignOnly] =
hush . eightOctetKeyID $ pkp
| otherwise = Nothing
phas (SigV4 _ _ _ xs _ _ _) =
colorizePHAs .
concatMap (\(SigSubPacket _ (PreferredHashAlgorithms x)) -> x) $
filter isPHA xs
phas _ = Colored Nothing Nothing []
has = map (colorizeHA . hashAlgo) . alleged
colorizeHA ha =
uncurry
Colored
(if ha `elem` [DeprecatedMD5, SHA1]
then (Just Red, Just "weak hash algorithm")
else (Nothing, Nothing))
ha
sigcts (SigV4 _ _ _ xs _ _ _) =
map (\(SigSubPacket _ (SigCreationTime x)) -> x) $ filter isCT xs
alleged =
filter
(\x -> ((==) <$> sigissuer x <*> eoki (key ^. tkKey . _1)) == Just True)
uatspsToText = T.pack . uatspsToString
uatspsToString us =
""
uaspToString (ImageAttribute hdr d) =
hdrToString hdr ++ ':' : show (BL.length d) ++ ':' :
BC8.unpack (Base16.encode (BA.convert (CH.hashlazy @CHA.SHA3_512 d)))
uaspToString (OtherUASub t d) =
"other-" ++ show t ++ ':' : show (BL.length d) ++ ':' :
BC8.unpack (Base16.encode (BA.convert (CH.hashlazy @CHA.SHA3_512 d)))
hdrToString (ImageHV1 JPEG) = "jpeg"
hdrToString (ImageHV1 fmt) = "image-" ++ show (fromFVal fmt)
uidr Nothing sps =
Colored
Nothing
Nothing
(UIDReport
(has sps)
(map phas sps)
(map
(colorizeKETs
(fromMaybe 0 mpt)
(key ^. tkKey . _1 . timestamp & unThirtyTwoBitTimeStamp) .
getKeyExpirationTimesFromSignature)
sps -- should that be 0?
)
(kufs False sps)
(findRevocationReason sps))
uidr (Just u) sps =
colorizeUID
u
(UIDReport
(has sps)
(map phas sps)
(map
(colorizeKETs
(fromMaybe 0 mpt)
(key ^. tkKey . _1 . timestamp & unThirtyTwoBitTimeStamp) .
getKeyExpirationTimesFromSignature)
sps -- should that be 0?
)
(kufs False sps)
(findRevocationReason sps))
populateBestOf krep =
Just
(UIDReport <$> best . uidSelfSigHashAlgorithms <*> best .
uidPreferredHashAlgorithms <*>
best .
uidKeyExpirationTimes <*>
best .
uidKeyUsageFlags <*>
pure [] $
mconcat (justTheUIDRs krep))
justTheUIDRs = map (decolorize . snd) . unFakeMap . keyUIDsAndUAts
best = take 1 . sortOn color
decolorize (Colored _ _ x) = x
colorizeUID u
| '(' `elem` T.unpack u =
Colored (Just Yellow) (Just "parenthesis in uid") -- FIXME: be more discerning
| '<' `notElem` T.unpack u =
Colored (Just Yellow) (Just "no left angle bracket in uid") -- FIXME: be more discerning
| otherwise = Colored Nothing Nothing
findRevocationReason = concatMap grabReasons . filter isCertRevocationSig
grabReasons (SigV4 CertRevocationSig _ _ has _ _ _) =
mapMaybe (grabReasons' . _sspPayload) has
grabReasons _ = []
grabReasons' (ReasonForRevocation a b) =
Just (RevocationStatus True (show a) b)
grabReasons' _ = Nothing
kufs s =
map
(colorizeKUFs s . (\(SigSubPacket _ (KeyFlags x)) -> x) .
fromMaybe undefined .
find isKUF .
hasheds) .
newestWith (any isKUF . hasheds)
colorizeKUFs False x =
uncurry
Colored
(if (Set.member EncryptStorageKey x ||
Set.member EncryptCommunicationsKey x) &&
(Set.member SignDataKey x || Set.member CertifyKeysKey x)
then (Just Yellow, Just "both signing & encryption")
else (Just Green, Nothing))
x
colorizeKUFs True x =
uncurry
Colored
(if Set.member CertifyKeysKey x
then (Just Red, Just "certification-capable subkey")
else (if (Set.member EncryptStorageKey x ||
Set.member EncryptCommunicationsKey x) &&
Set.member SignDataKey x
then (Just Yellow, Just "both signing & encryption")
else (Just Green, Nothing)))
x
newestWith p = take 1 . sortOn (Down . take 1 . sigcts) . filter p -- FIXME: this is terrible
hasheds (SigV4 _ _ _ xs _ _ _) = xs
hasheds _ = []
checkSK ::
TwentyOctetFingerprint -> (Pkt, [SignaturePayload]) -> SubkeyReport
checkSK pf (PublicSubkeyPkt pkp, sigs) = checkSK' pf pkp sigs
checkSK pf (SecretSubkeyPkt pkp _, sigs) = checkSK' pf pkp sigs
checkSK' pf pkp sigs =
(\x -> x {skCrossCerts = ccr (map decolorize (skUsageFlags x)) sigs})
SubkeyReport
{ skFingerprint = colorizeF pf (fingerprint pkp)
, skVer = colorizeKV (pkp ^. keyVersion)
, skCreationTime = pkp ^. timestamp
, skAlgorithmAndSize = kasIt pkp
, skBindingSigHashAlgorithms = has (filter isSKBindingSig sigs)
, skUsageFlags = kufs True (filter isSKBindingSig sigs)
, skCrossCerts = CrossCertReport (Colored Nothing Nothing False) []
}
hasEncryptionCapableSubkey skrs =
if any
((\x ->
Set.member EncryptStorageKey x ||
Set.member EncryptCommunicationsKey x) .
decolorize)
skrs
then Colored (Just Green) Nothing True
else Colored
(Just Red)
(Just "no encryption-capable subkey present")
False
embeddedSigs =
filter isPKBindingSig . concatMap getEmbeds . filter isSKBindingSig
getEmbeds (SigV4 _ _ _ xs ys _ _) = concatMap getEmbed (xs ++ ys)
getEmbeds _ = []
getEmbed (SigSubPacket _ (EmbeddedSignature sp)) = [sp]
getEmbed _ = []
ccr kufs sigs =
CrossCertReport (colorES kufs sigs) (map (colorizeHA . hashAlgo) sigs)
colorES kufs sigs =
case ( null (embeddedSigs sigs)
, any (Set.member SignDataKey) kufs
, any (Set.member AuthKey) kufs) of
(True, True, True) ->
Colored
(Just Red)
(Just "signing- and auth-capable subkey without cross-cert")
False
(True, True, False) ->
Colored
(Just Red)
(Just "signing-capable subkey without cross-cert")
False
(True, False, True) ->
Colored
(Just Yellow)
(Just "auth-capable subkey without cross-cert")
False
(False, True, True) -> Colored (Just Green) Nothing True
(False, True, False) -> Colored (Just Green) Nothing True
(False, False, True) -> Colored (Just Green) Nothing True
(False, False, False) -> Colored Nothing Nothing True
(True, _, _) -> Colored Nothing Nothing False
colorizeF pf fp =
uncurry
Colored
(if pf == fp
then (Just Red, Just "subkey has same fingerprint as primary key")
else (Just Green, Nothing))
fp
prettyKeyReport :: POSIXTime -> TK -> Doc PPA.AnsiStyle
prettyKeyReport cpt key = do
let keyReport = checkKey (Just cpt) key
execWriter $
tell
(linebreak <> pretty "Key has potential validity" <> colon <+>
pretty (keyStatus keyReport) <>
linebreak <>
pretty "Key has fingerprint" <>
colon <+>
pretty (SpacedFingerprint (keyFingerprint keyReport)) <>
linebreak <>
pretty "Checking to see if key is OpenPGPv4" <>
colon <+>
coloredToColor (pretty . show) (keyVer keyReport) <>
linebreak <>
(\kas ->
pretty "Checking the strength of your primary asymmetric key" <> colon <+>
coloredToColor pretty (pubkeyalgo kas) <+>
coloredToColor (maybe (pretty "unknown") pretty) (pubkeysize kas))
(keyAlgorithmAndSize keyReport) <>
linebreak <>
pretty "Checking user-ID- and user-attribute-related items" <>
colon <>
mconcat
(map
(uidtrip (keyCreationTime keyReport) . gottabeabetterway)
(unFakeMap (keyUIDsAndUAts keyReport))) <>
linebreak <>
pretty "Checking subkeys" <>
colon <>
linebreak <>
indent
2
(pretty "one of the subkeys is encryption-capable" <> colon <+>
coloredToColor pretty (keyHasEncryptionCapableSubkey keyReport)) <>
mconcat (map subkeyrep (keySubkeys keyReport)) <>
linebreak)
where
coloredToColor f (Colored (Just Green) _ x) = green (f x)
coloredToColor f (Colored (Just Yellow) _ x) = yellow (f x)
coloredToColor f (Colored (Just Red) _ x) = red (f x)
coloredToColor f (Colored Nothing _ x) = f x
uidtrip ts (u, ur)
| null (uidRevocationStatus ur) =
linebreak <> indent 2 (coloredToColor pretty (fmap T.unpack u)) <> colon <>
linebreak <>
indent
4
(pretty "Self-sig hash algorithms" <> colon <+>
(list . map (coloredToColor pretty) . uidSelfSigHashAlgorithms) ur) <>
linebreak <>
indent
4
(pretty "Preferred hash algorithms" <> colon <+>
mconcat (map (coloredToColor pretty) (uidPreferredHashAlgorithms ur))) <>
linebreak <>
indent
4
(pretty "Key expiration times" <> colon <+>
mconcat
(map
(coloredToColor list . fmap (map (pretty . keyExp ts)))
(uidKeyExpirationTimes ur))) <>
linebreak <>
indent
4
(pretty "Key usage flags" <> colon <+>
(list . map (coloredToColor (pretty . Set.toList)))
(uidKeyUsageFlags ur))
| otherwise =
linebreak <> indent 2 (coloredToColor pretty (fmap T.unpack u)) <> colon <+>
pretty "[revoked]" <>
linebreak <>
indent
4
(pretty "Revocation code" <> colon <+>
list (map (pretty . revocationCode) (uidRevocationStatus ur))) <>
linebreak <>
indent
4
(pretty "Revocation reason" <> colon <+>
list
(map
(pretty . T.unpack . revocationReason)
(uidRevocationStatus ur)))
keyExp ts ke =
(show . pretty) ke ++ " = " ++
formatTime
defaultTimeLocale
"%c"
(posixSecondsToUTCTime (realToFrac ts + realToFrac ke))
gottabeabetterway (a, Colored x y z) = (Colored x y a, z)
subkeyrep skr =
linebreak <>
indent
2
(pretty "fpr" <> colon <+>
coloredToColor pretty (fmap SpacedFingerprint (skFingerprint skr))) <>
linebreak <>
indent 4 (pretty "version" <> colon <+> coloredToColor pretty (skVer skr)) <>
linebreak <>
indent 4 (pretty "timestamp" <> colon <+> pretty (skCreationTime skr)) <>
linebreak <>
indent
4
((\kas ->
pretty "algo/size" <> colon <+>
coloredToColor pretty (pubkeyalgo kas) <+>
coloredToColor (maybe (pretty "unknown") pretty) (pubkeysize kas))
(skAlgorithmAndSize skr)) <>
linebreak <>
indent
4
(pretty "binding sig hash algorithms" <> colon <+>
(list . map (coloredToColor pretty) . skBindingSigHashAlgorithms) skr) <>
linebreak <>
indent
4
(pretty "usage flags" <> colon <+>
(list . map (coloredToColor (pretty . Set.toList))) (skUsageFlags skr)) <>
linebreak <>
indent
4
(pretty "embedded cross-cert" <> colon <+>
(coloredToColor pretty . ccPresent . skCrossCerts) skr) <>
linebreak <>
indent
4
(pretty "cross-cert hash algorithms" <> colon <+>
(list . map (coloredToColor pretty) . ccHashAlgorithms . skCrossCerts)
skr)
jsonReport :: POSIXTime -> TK -> BL.ByteString
jsonReport ps = A.encode . checkKey (Just ps)
yamlReport :: POSIXTime -> TK -> B.ByteString
yamlReport ps = Y.encode . (: []) . checkKey (Just ps)
data LintOutputFormat
= Pretty
| JSON
| YAML
deriving (Bounded, Enum, Eq, Read, Show)
data LintOptions =
LintOptions
{ lintOutputFormat :: LintOutputFormat
}
data FetchOptions =
FetchOptions
{ keyServer :: String
, fetchValidation :: FetchValidationMethod
, fetchQuery :: TwentyOctetFingerprint
}
data Command
= CmdLint LintOptions
| CmdCanonicalize
| CmdFetch FetchOptions
lintO :: Parser LintOptions
lintO =
LintOptions <$>
option
auto
(long "output-format" <> metavar "FORMAT" <> value Pretty <> showDefault <>
ofHelp)
where
ofHelp =
helpDoc . Just $ pretty "output format" <> hardline <>
list (map (pretty . show) ofchoices)
ofchoices = [minBound .. maxBound] :: [LintOutputFormat]
fetchO :: Parser FetchOptions
fetchO =
FetchOptions <$>
option
str
(long "keyserver" <> metavar "URL" <>
value "http://pool.sks-keyservers.net:11371" <>
showDefault <>
help "HKP server") <*>
option
auto
(long "validation-method" <> metavar "METHOD" <>
value MatchPrimaryKeyFingerprint <>
showDefault <>
vmHelp) <*>
argument (eitherReader strToFP) (metavar "FINGERPRINT")
where
vmHelp =
helpDoc . Just $ pretty "validation method" <> hardline <>
list (map (pretty . show) vmchoices)
vmchoices = [minBound .. maxBound] :: [FetchValidationMethod]
strToFP = parseFingerprint . T.pack
dispatch :: Command -> IO ()
dispatch (CmdFetch o) = banner' stderr >> hFlush stderr >> doFetch o
dispatch (CmdLint o) = banner' stderr >> hFlush stderr >> doLint o
dispatch CmdCanonicalize = banner' stderr >> hFlush stderr >> doCanonicalize
main :: IO ()
main = do
hSetBuffering stderr LineBuffering
customExecParser
(prefs showHelpOnError)
(info
(helper <*> versioner "hokey" <*> cmd)
(headerDoc (Just (banner "hokey")) <>
progDesc "hOpenPGP Key utility" <>
footerDoc (Just (warranty "hokey")))) >>=
dispatch
cmd :: Parser Command
cmd =
hsubparser
(command
"canonicalize"
(info
(pure CmdCanonicalize)
(progDesc "arrange key components in a canonical ordering")) <>
command
"fetch"
(info (CmdFetch <$> fetchO) (progDesc "fetch key(s) from keyserver")) <>
command
"lint"
(info (CmdLint <$> lintO) (progDesc "check key(s) for 'best practices'")))
doLint :: LintOptions -> IO ()
doLint o = do
cpt <- getPOSIXTime
keys <-
runConduitRes $ CB.sourceHandle stdin .| conduitGet get .|
conduitToTKsDropping .|
CL.consume
output (lintOutputFormat o) cpt keys
where
output Pretty cpt = mapM_ (PPA.putDoc . prettyKeyReport cpt)
output JSON cpt =
mapM_ (BL.putStr . flip BL.append (BL.singleton 0x0a) . jsonReport cpt)
output YAML cpt = mapM_ (B.putStr . yamlReport cpt)
doCanonicalize :: IO ()
doCanonicalize =
runConduitRes $ CB.sourceHandle stdin .| conduitGet get .|
conduitToTKsDropping .|
CL.map canonicalize .|
CL.map put .|
conduitPut .|
CB.sinkHandle stdout
where
canonicalize (TK k r ui ua s) =
TK k (sort r) (indepthsort ui) (indepthsort ua) (indepthsort s)
indepthsort :: (Ord a, Ord b) => [(a, [b])] -> [(a, [b])]
indepthsort = nub . sort . over (mapped . _2) sort
doFetch :: FetchOptions -> IO ()
doFetch o = do
ekeys <-
runExceptT $ fetchKeys (keyServer o) (fetchValidation o) (fetchQuery o)
case ekeys of
Left e -> hPutStrLn stderr $ "error fetching keys: " ++ e
Right ks -> B.putStr $ rearmorKeys ks
banner' :: Handle -> IO ()
banner' h =
PPA.hPutDoc h (banner "hokey" <> hardline <> warranty "hokey" <> hardline)
sigissuer :: SignaturePayload -> Maybe EightOctetKeyId
getIssuer :: SigSubPacketPayload -> Maybe EightOctetKeyId
hashAlgo :: SignaturePayload -> HashAlgorithm
sigissuer (SigVOther 2 _) = Nothing
sigissuer SigV3 {} = Nothing
sigissuer (SigV4 _ _ _ ys xs _ _) =
listToMaybe . mapMaybe (getIssuer . _sspPayload) $ (ys ++ xs) -- FIXME: what should this be if there are multiple matches?
sigissuer (SigVOther _ _) = error "We're in the future." -- FIXME
getIssuer (Issuer i) = Just i
getIssuer _ = Nothing
hashAlgo (SigV4 _ _ x _ _ _ _) = x
hashAlgo _ = error "V3 sig not supported here"
hopenpgp-tools-0.23.11/hop.hs 0000644 0000000 0000000 00000044734 07346545000 014163 0 ustar 00 0000000 0000000 -- hop.hs: hOpenPGP-stateless OpenPGP (sop) tool
-- Copyright © 2019-2023 Clint Adams
--
-- vim: softtabstop=4:shiftwidth=4:expandtab
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see .
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE RecordWildCards #-}
import qualified Codec.Encryption.OpenPGP.ASCIIArmor as AA
import Codec.Encryption.OpenPGP.ASCIIArmor.Types (Armor(..), ArmorType(..))
import Codec.Encryption.OpenPGP.Fingerprint (eightOctetKeyID, fingerprint)
import Codec.Encryption.OpenPGP.Ontology (isKUF)
import Codec.Encryption.OpenPGP.Serialize ()
import Codec.Encryption.OpenPGP.Signatures
( crossSignSubkeyWithRSA
, signDataWithRSA
, signUserIDwithRSA
, verifyAgainstKeyring
, verifySigWith
, verifyTKWith
)
import Codec.Encryption.OpenPGP.Types
import Control.Applicative ((<|>), optional, some)
import Control.Error.Util (note)
import Control.Monad ((>=>), forM_)
import Control.Monad.IO.Class (liftIO)
import Control.Monad.State.Lazy (StateT, evalStateT, get, modify)
import Control.Monad.Trans.Resource (MonadResource, MonadThrow)
import qualified Crypto.PubKey.RSA as RSA
import qualified Data.Aeson as A
import qualified Data.Binary as Bin
import Data.Binary.Get (runGet)
import Data.Binary.Put (runPut)
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as BL
import qualified Data.ByteString.Lazy.Char8 as BLC8
import Data.Conduit ((.|), runConduitRes)
import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.Combinators as CC
import qualified Data.Conduit.List as CL
import Data.Conduit.OpenPGP.Keyring
( conduitToTKs
, conduitToTKsDropping
, sinkKeyringMap
)
import Data.Conduit.OpenPGP.Verify (conduitVerify)
import Data.Conduit.Serialization.Binary (conduitGet)
import Data.Either (fromRight, isRight, rights)
import Data.List (find)
import Data.Maybe (catMaybes, fromJust, listToMaybe)
import Data.Monoid ((<>))
import qualified Data.Set as S
import Data.Text (Text)
import qualified Data.Text as T
import qualified Data.Text.Encoding as TE
import Data.Time.Clock.POSIX (POSIXTime, getPOSIXTime, posixSecondsToUTCTime)
import qualified Data.Vector as V
import Data.Version (showVersion)
import qualified Data.Yaml as Y
import GHC.Generics
import HOpenPGP.Tools.Armor (doDeArmor)
import HOpenPGP.Tools.Common
( banner
, keyMatchesEightOctetKeyId
, keyMatchesFingerprint
, keyMatchesUIDSubString
, versioner
, warranty
)
import HOpenPGP.Tools.Parser (parseTKExp)
import HOpenPGP.Tools.TKUtils (processTK)
import Paths_hopenpgp_tools (version)
import System.Exit (exitFailure, exitSuccess)
import Options.Applicative.Builder
( argument
, auto
, command
, eitherReader
, footerDoc
, headerDoc
, help
, helpDoc
, info
, long
, metavar
, option
, prefs
, progDesc
, short
, showDefault
, showHelpOnError
, str
, strArgument
, strOption
, switch
, value
)
import Options.Applicative.Extra (customExecParser, helper, hsubparser)
import Options.Applicative.Types (Parser)
import Prettyprinter
( (<+>)
, fillSep
, hardline
, list
, pretty
, softline
)
import Prettyprinter.Render.Text (hPutDoc)
import System.IO (BufferMode(..), Handle, hFlush, hSetBuffering, stderr, stdin)
data Command
= VersionC
| GenerateKeyC KeyGenOptions
| ExtractCertC ExtractCertOptions
| SignC SignOptions
| DeArmorC
| ArmorC ArmoringOptions
data Options =
Options
{ keyrings :: [String]
, outputFormat :: OutputFormat
, sigFilter :: String
, sigFile :: String
, blobFile :: String
}
data OutputFormat
= Unstructured
| JSON
| YAML
deriving (Eq, Read, Show)
o :: Parser Options
o =
Options <$>
some
(strOption
(long "keyring" <>
short 'k' <> metavar "FILE" <> help "file containing keyring")) <*>
option
auto
(long "output-format" <>
metavar "FORMAT" <>
value Unstructured <> showDefault <> help "output format") <*>
option
auto
(long "signature-filter" <>
metavar "SIGFILTER" <>
value "sigcreationtime < now" <>
showDefault <> help "verify only signatures which match filter spec") <*>
argument str (metavar "SIGNATURE" <> sigHelp) <*>
argument str (metavar "BLOB" <> blobHelp)
where
sigHelp =
helpDoc . Just $
pretty "file containing OpenPGP binary signatures"
blobHelp =
helpDoc . Just $
pretty "file containing binary blob to be validated"
dispatch :: POSIXTime -> Command -> IO ()
dispatch cpt o = banner' stderr >> hFlush stderr >> dispatch' cpt o
where
dispatch' _ VersionC = doVersion
dispatch' t (GenerateKeyC o) = doGenerateKey t o
dispatch' _ (ExtractCertC o) = doExtractCert o
dispatch' t (SignC o) = doSign t o
dispatch' _ DeArmorC = doDeArmor
dispatch' _ (ArmorC o) = doArmor o
main :: IO ()
main = do
hSetBuffering stderr LineBuffering
cpt <- getPOSIXTime
customExecParser
(prefs showHelpOnError)
(info
(helper <*> versioner "hop" <*> cmd)
(headerDoc (Just (banner "hop")) <>
progDesc "hOpenPGP Validator Tool" <>
footerDoc (Just (warranty "hop")))) >>=
dispatch cpt
banner' :: Handle -> IO ()
banner' h = hPutDoc h (banner "hop" <> hardline <> warranty "hop" <> hardline)
data Vrf =
Vrf
{ _vrfmsg :: String
, _vrfmfpr :: Maybe TwentyOctetFingerprint
}
deriving (Eq, Generic, Show)
instance A.ToJSON Vrf
doV :: POSIXTime -> Options -> IO ()
doV cpt o = do
let allkfiles = sequence_ (map CC.sourceFile (keyrings o))
krs <-
runConduitRes $
allkfiles .| conduitGet Bin.get .| conduitToTKsDropping .| sinkKeyringMap
sigs <-
runConduitRes $
CC.sourceFile (sigFile o) .| conduitGet Bin.get .| CC.filter v4b .|
CC.sinkVector
blob <- runConduitRes $ CC.sourceFile (blobFile o) .| CC.sinkLazy
verifications <-
runConduitRes $
CC.yieldMany (V.cons (LiteralDataPkt BinaryData mempty 0 blob) sigs) .|
conduitVerify krs Nothing .|
CC.sinkList
let verifications' = map v2v verifications
case outputFormat o of
Unstructured -> mapM_ print verifications'
JSON -> BL.putStr . A.encode $ verifications'
YAML -> B.putStr . Y.encode $ verifications'
putStrLn ""
case any isRight verifications of
True -> exitSuccess
_ -> exitFailure
where
v4b (SignaturePkt s@(SigV4 BinarySig _ _ _ _ _ _)) = sf s
v4b _ = False
v2v (Left l) = Vrf l Nothing
v2v (Right v) =
Vrf "verified signature" (Just (fingerprint (_verificationSigner v)))
sf = const True
cmd :: Parser Command
cmd =
hsubparser
(command "armor" (info (ArmorC <$> aoP) (progDesc "Armor stdin to stdout")) <>
command
"dearmor"
(info (pure DeArmorC) (progDesc "Dearmor stdin to stdout")) <>
command
"extract-cert"
(info
(ExtractCertC <$> ecoP)
(progDesc
"Extract a certificate from a secret key and output it to stdout")) <>
command
"generate-key"
(info
(GenerateKeyC <$> gkoP)
(progDesc "Generate a secret key and output it to stdout")) <>
command
"sign"
(info
(SignC <$> soP)
(progDesc "Create detached signatures and output them to stdout")) <>
command
"version"
(info (pure VersionC) (progDesc "output hop version to stdout")))
armorTypes :: [(String, Maybe ArmorType)]
armorTypes =
[ ("auto", Nothing)
, ("sig", Just ArmorSignature)
, ("key", Just ArmorPrivateKeyBlock)
, ("cert", Just ArmorPublicKeyBlock)
, ("message", Just ArmorMessage)
]
armorTypeReader :: String -> Either String (Maybe ArmorType)
armorTypeReader = note "unknown armor type" . flip lookup armorTypes
aoP :: Parser ArmoringOptions
aoP =
ArmoringOptions <$>
option
(eitherReader armorTypeReader)
(long "label" <> metavar "LABEL" <> armortypeHelp) <*>
switch
(long "allow-nested" <>
help "do the sane thing and unconditionally armor the output")
where
armortypeHelp =
helpDoc . Just $
pretty "ASCII armor type" <>
softline <> list (map (pretty . fst) armorTypes)
data ArmoringOptions =
ArmoringOptions
{ label :: Maybe ArmorType
, allowNested :: Bool
}
doArmor :: ArmoringOptions -> IO ()
doArmor ArmoringOptions {..} = do
m <- runConduitRes $ CB.sourceHandle stdin .| CL.consume
let lbs = BL.fromChunks m
armoredAlready = BLC8.pack "-----BEGIN PGP" == BL.take 14 lbs
label' = guessLabel label (decodeFirstPacket lbs)
a = Armor label' [] lbs
BL.putStr $
if armoredAlready && not allowNested
then lbs
else AA.encodeLazy [a]
where
decodeFirstPacket = runGet Bin.get
guessLabel (Just l) _ = l
guessLabel Nothing (SignaturePkt _) = ArmorSignature
guessLabel Nothing (SecretKeyPkt _ _) = ArmorPrivateKeyBlock
guessLabel Nothing (PublicKeyPkt _) = ArmorPublicKeyBlock
guessLabel Nothing _ = ArmorMessage
doVersion :: IO ()
doVersion = putStrLn $ "hop " ++ showVersion version
gkoP :: Parser KeyGenOptions
gkoP =
KeyGenOptions <$> switch (long "armor" <> help "armor the output") <*>
switch (long "no-armor" <> help "don't armor the output") <*>
strArgument (metavar "USERID" <> help "User ID associated with this key")
data KeyGenOptions =
KeyGenOptions
{ armor :: Bool
, noArmor :: Bool
, userId :: String
}
doGenerateKey :: POSIXTime -> KeyGenOptions -> IO ()
doGenerateKey pt KeyGenOptions {..} = do
let ts = ThirtyTwoBitTimeStamp (floor pt)
sk <- generateSecretKey ts RSA
s <-
buildKeyWith sk $ do
addUserId ts True (T.pack userId)
addSubkey ts [EncryptStorageKey, EncryptCommunicationsKey]
addSubkey ts [SignDataKey]
addSubkey ts [AuthKey]
newkey <- get
return newkey
let lbs = runPut $ Bin.put s
BL.putStr $
if not armor && not noArmor
then AA.encodeLazy [Armor ArmorPrivateKeyBlock [] lbs]
else lbs
type KeyBuilder = StateT TK IO
buildKeyWith :: SecretKey -> KeyBuilder a -> IO a
buildKeyWith sk a = evalStateT a (bareTK sk)
where
bareTK (SecretKey pkp ska) = TK (pkp, Just ska) [] [] [] []
generateSecretKey :: ThirtyTwoBitTimeStamp -> PubKeyAlgorithm -> IO SecretKey
generateSecretKey ts RSA = do
(pub, priv) <- liftIO $ RSA.generate 512 0x10001
return $ SecretKey (pkp pub) (ska priv)
where
pkp pub = PKPayload V4 ts 0 RSA (RSAPubKey (RSA_PublicKey pub))
ska priv = SUUnencrypted (RSAPrivateKey (RSA_PrivateKey priv)) 0 -- FIXME: calculate checksum
addUserId :: ThirtyTwoBitTimeStamp -> Bool -> Text -> KeyBuilder ()
addUserId ts primary userid = modify (newUID userid)
where
newUID u tk = tk {_tkUIDs = _tkUIDs tk ++ [selfsign (_tkKey tk) u]}
selfsign (pkp, Just ska) u =
( u
, [ fromRight
undefined
(signUserIDwithRSA
pkp
(UserId u)
(hashed pkp)
(unhashed pkp)
(skey ska))
])
hashed pkp =
[ SigSubPacket False (SigCreationTime ts)
, SigSubPacket False (IssuerFingerprint 4 (fingerprint pkp))
, SigSubPacket False (KeyFlags (S.singleton CertifyKeysKey))
, SigSubPacket False (PrimaryUserId primary)
, SigSubPacket
False
(PreferredHashAlgorithms [SHA512, SHA256, SHA384, SHA224])
, SigSubPacket
False
(PreferredSymmetricAlgorithms [AES256, AES192, AES128])
]
unhashed pkp =
[SigSubPacket False (Issuer (fromRight undefined (eightOctetKeyID pkp)))]
skey (SUUnencrypted (RSAPrivateKey (RSA_PrivateKey k)) _) = k
addSubkey :: ThirtyTwoBitTimeStamp -> [KeyFlag] -> KeyBuilder ()
addSubkey ts keyflags = do
tk <- get
(SecretKey subpkp subska) <- liftIO $ generateSecretKey ts RSA
let (pkp, Just ska) = _tkKey tk
Right crossig =
crossSignSubkeyWithRSA
pkp
subpkp
(hashedwithflags pkp)
(unhashed pkp)
(hashed subpkp)
(unhashed subpkp)
(skey ska)
(skey subska)
modify (addIt subpkp subska crossig)
where
skey (SUUnencrypted (RSAPrivateKey (RSA_PrivateKey k)) _) = k
addIt sp ss cross tk =
tk {_tkSubs = _tkSubs tk ++ [(SecretSubkeyPkt sp ss, [cross])]}
hashed pkp =
[ SigSubPacket False (SigCreationTime ts)
, SigSubPacket False (IssuerFingerprint 4 (fingerprint pkp))
]
hashedwithflags pkp =
hashed pkp ++ [SigSubPacket False (KeyFlags (S.fromList keyflags))]
unhashed pkp =
[SigSubPacket False (Issuer (fromRight undefined (eightOctetKeyID pkp)))]
ecoP :: Parser ExtractCertOptions
ecoP =
ExtractCertOptions <$> switch (long "armor" <> help "armor the output") <*>
switch (long "no-armor" <> help "don't armor the output")
data ExtractCertOptions =
ExtractCertOptions
{ ecArmor :: Bool
, ecNoArmor :: Bool
}
doExtractCert :: ExtractCertOptions -> IO ()
doExtractCert ExtractCertOptions {..} = do
kbs <- runConduitRes $ CB.sourceHandle stdin .| CL.consume
let lbs = BL.fromChunks kbs
isArmored =
BLC8.pack "-----BEGIN PGP PRIVATE KEY BLOCK-----" == BL.take 37 lbs
Right [Armor ArmorPrivateKeyBlock _ decoded] =
AA.decodeLazy lbs :: Either String [Armor]
lbs' =
if isArmored
then decoded
else lbs
k <-
runConduitRes $
CL.sourceList (BL.toChunks lbs') .| conduitGet Bin.get .| conduitToTKs .|
CL.take 1
let output = runPut $ Bin.put (pubToSecret (head k))
BL.putStr $
if not ecArmor && not ecNoArmor
then AA.encodeLazy [Armor ArmorPublicKeyBlock [] output]
else output
where
pubToSecret tk =
tk {_tkKey = pToS (_tkKey tk), _tkSubs = map subPToS (_tkSubs tk)}
pToS (pkp, _) = (pkp, Nothing)
subPToS (SecretSubkeyPkt pkp _, sigs) = (PublicSubkeyPkt pkp, sigs)
soP :: Parser SignOptions
soP =
SignOptions <$> switch (long "armor" <> help "armor the output") <*>
switch (long "no-armor" <> help "don't armor the output") <*>
option
(eitherReader asTypeReader)
(long "as" <> metavar "DATATYPE" <> astypeHelp <> value AsBinary) <*>
some
(strArgument
(metavar "KEYS..." <>
help "paths to at least one secret key, one key per filename"))
where
astypeHelp =
helpDoc . Just $
pretty "what to treat the input as" <>
softline <> list (map (pretty . fst) asTypes)
data SignOptions =
SignOptions
{ sArmor :: Bool
, sNoArmor :: Bool
, sAs :: AsBinaryText
, sKeyFiles :: [String]
}
asTypes :: [(String, AsBinaryText)]
asTypes = [("binary", AsBinary), ("text", AsText)]
data AsBinaryText
= AsBinary
| AsText
deriving (Eq)
asTypeReader :: String -> Either String AsBinaryText
asTypeReader = note "unknown as type" . flip lookup asTypes
doSign :: POSIXTime -> SignOptions -> IO ()
doSign pt SignOptions {..} = do
mbs <- runConduitRes $ CB.sourceHandle stdin .| CL.consume
ks <- mapM grabKey sKeyFiles
let ts = ThirtyTwoBitTimeStamp (floor pt)
payload' = BL.fromChunks mbs
payload =
if sAs == AsText
then canonicalize payload'
else payload'
funkeys = concatMap tkToFunKeys . rights . map (processTK (Just pt)) $ ks
allSigningCapableKeys = filter (isSigner . fkufs) funkeys
forM_ allSigningCapableKeys $ \k -> do
let Right sig = signData sAs ts k payload
sigpkt = SignaturePkt sig
output = runPut (Bin.put sigpkt)
BL.putStr $
if not sArmor && not sNoArmor
then AA.encodeLazy [Armor ArmorSignature [] output]
else output
where
signData ::
AsBinaryText
-> ThirtyTwoBitTimeStamp
-> FunKey
-> BL.ByteString
-> Either String SignaturePayload
signData AsBinary t k =
signDataWithRSA
BinarySig
(skey (fromJust (fmska k)))
(hashed (fpkp k) t)
(unhashed (fpkp k))
signData AsText t k =
signDataWithRSA
CanonicalTextSig
(skey (fromJust (fmska k)))
(hashed (fpkp k) t)
(unhashed (fpkp k))
skey (SUUnencrypted (RSAPrivateKey (RSA_PrivateKey k)) _) =
k {RSA.private_p = 0, RSA.private_q = 0} -- FIXME: why is this necessary?
hashed pkp ct =
[ SigSubPacket False (SigCreationTime ct)
, SigSubPacket False (IssuerFingerprint 4 (fingerprint pkp))
]
unhashed pkp =
[SigSubPacket False (Issuer (fromRight undefined (eightOctetKeyID pkp)))]
isSigner = S.member SignDataKey
canonicalize :: BL.ByteString -> BL.ByteString
canonicalize =
BL.fromStrict .
TE.encodeUtf8 .
T.intercalate (T.pack "\r\n") . T.lines . TE.decodeUtf8 . BL.toStrict
grabKey :: String -> IO TK
grabKey fp = do
kbs <- runConduitRes $ CB.sourceFile fp .| CL.consume
let lbs = BL.fromChunks kbs
isArmored =
BLC8.pack "-----BEGIN PGP PRIVATE KEY BLOCK-----" == BL.take 37 lbs
Right [Armor ArmorPrivateKeyBlock _ decoded] =
AA.decodeLazy lbs :: Either String [Armor]
lbs' =
if isArmored
then decoded
else lbs
Just k <-
runConduitRes $
CL.sourceList (BL.toChunks lbs') .| conduitGet Bin.get .| conduitToTKs .|
CL.head
return k
data FunKey =
FunKey
{ fpkp :: PKPayload
, fmska :: Maybe SKAddendum
, fkufs :: S.Set KeyFlag
}
deriving (Show)
tkToFunKeys :: TK -> [FunKey]
tkToFunKeys (TK (pkp, mska) revs uids uats subs) =
catMaybes (mainKey : map extract subs)
where
mainKey = grabASig uids >>= sig2KUFs >>= \kf -> return (FunKey pkp mska kf)
sig2KUFs = getHasheds >=> find isKUF >=> getKUFs
grabASig :: [(a, [b])] -> Maybe b
grabASig = (listToMaybe >=> listToMaybe) . map snd -- FIXME: this should grab the "best" sig
getHasheds :: SignaturePayload -> Maybe [SigSubPacket]
getHasheds (SigV4 _ _ _ hasheds _ _ _) = Just hasheds
getHasheds _ = Nothing
getKUFs :: SigSubPacket -> Maybe (S.Set KeyFlag)
getKUFs (SigSubPacket _ (KeyFlags kfs)) = Just kfs
getKUFs _ = Nothing
extract ((SecretSubkeyPkt spkp sska), sigs) =
listToMaybe sigs >>= sig2KUFs >>= \kf ->
return (FunKey spkp (Just sska) kf)
extract ((PublicSubkeyPkt spkp), sigs) =
listToMaybe sigs >>= sig2KUFs >>= \kf -> return (FunKey spkp Nothing kf)
extract _ = Nothing
hopenpgp-tools-0.23.11/hopenpgp-tools.cabal 0000644 0000000 0000000 00000010040 07346545000 016762 0 ustar 00 0000000 0000000 cabal-version: 3.0
name: hopenpgp-tools
version: 0.23.11
synopsis: hOpenPGP-based command-line tools
description: command-line tools for performing some OpenPGP-related operations
homepage: https://salsa.debian.org/clint/hOpenPGP-tools
license: AGPL-3.0-or-later
license-file: LICENSE
author: Clint Adams
maintainer: Clint Adams
copyright: 2012-2025 Clint Adams
category: Codec, Data
build-type: Simple
common deps
autogen-modules: Paths_hopenpgp_tools
build-depends: base > 4.9 && < 5
, aeson
, binary >= 0.6.4.0
, binary-conduit
, bytestring
, conduit >= 1.3.0
, errors
, hOpenPGP >= 2.10.1 && < 3
, lens
, optparse-applicative >= 0.18.1.0
, prettyprinter >= 1.7.0
, text
, transformers >= 0.4
, yaml
ghc-options: -Wall
other-modules: HOpenPGP.Tools.Common
, Paths_hopenpgp_tools
executable hot
import: deps
main-is: hot.hs
autogen-modules: Paths_hopenpgp_tools
other-modules: HOpenPGP.Tools.Armor
, HOpenPGP.Tools.Lexer
, HOpenPGP.Tools.Parser
build-depends: array
, conduit-extra >= 1.1
, monad-loops
, openpgp-asciiarmor >= 0.1
build-tool-depends: alex:alex, happy:happy
default-language: Haskell2010
executable hokey
import: deps
main-is: hokey.hs
other-modules: HOpenPGP.Tools.HKP
, HOpenPGP.Tools.TKUtils
build-depends: base16-bytestring
, conduit-extra >= 1.1
, containers
, crypton
, http-client >= 0.4.30
, http-client-tls
, http-types
, memory
, openpgp-asciiarmor >= 0.1
, prettyprinter-ansi-terminal >= 1.1.2
, time
, time-locale-compat
default-language: Haskell2010
executable hkt
import: deps
main-is: hkt.hs
other-modules: HOpenPGP.Tools.Lexer
, HOpenPGP.Tools.Parser
build-depends: array
, containers
, conduit-extra >= 1.1
, directory
, fgl >= 5.5.4.0
, graphviz
, ixset-typed
, monad-loops
, resourcet
, time
, unordered-containers
build-tool-depends: alex:alex, happy:happy
default-language: Haskell2010
executable hop
import: deps
main-is: hop.hs
other-modules: HOpenPGP.Tools.Armor
, HOpenPGP.Tools.Lexer
, HOpenPGP.Tools.Parser
, HOpenPGP.Tools.TKUtils
build-depends: array
, conduit-extra >= 1.1
, containers
, crypton
, monad-loops
, mtl
, openpgp-asciiarmor >= 0.1
, resourcet
, time
, vector
build-tool-depends: alex:alex, happy:happy
default-language: Haskell2010
source-repository head
type: git
location: https://salsa.debian.org/clint/hopenpgp-tools.git
source-repository this
type: git
location: https://salsa.debian.org/clint/hopenpgp-tools.git
tag: hopenpgp-tools/0.23.8
hopenpgp-tools-0.23.11/hot.hs 0000644 0000000 0000000 00000015655 07346545000 014167 0 ustar 00 0000000 0000000 -- hot.hs: hOpenPGP Tool
-- Copyright © 2012-2022 Clint Adams
--
-- vim: softtabstop=4:shiftwidth=4:expandtab
--
-- This program is free software: you can redistribute it and/or modify
-- it under the terms of the GNU Affero General Public License as
-- published by the Free Software Foundation, either version 3 of the
-- License, or (at your option) any later version.
--
-- This program is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-- GNU Affero General Public License for more details.
--
-- You should have received a copy of the GNU Affero General Public License
-- along with this program. If not, see .
{-# LANGUAGE RecordWildCards #-}
import qualified Codec.Encryption.OpenPGP.ASCIIArmor as AA
import Codec.Encryption.OpenPGP.ASCIIArmor.Types (Armor(..), ArmorType(..))
import Codec.Encryption.OpenPGP.Serialize ()
import Codec.Encryption.OpenPGP.Types
import Control.Applicative (optional)
import Control.Error.Util (note)
import Control.Monad.IO.Class (MonadIO, liftIO)
import qualified Data.Aeson as A
import Data.Binary (get, put)
import Data.Binary.Get (Get)
import qualified Data.ByteString as B
import qualified Data.ByteString.Lazy as BL
import Data.Conduit (ConduitM, (.|), runConduitRes)
import qualified Data.Conduit.Binary as CB
import qualified Data.Conduit.List as CL
import Data.Conduit.OpenPGP.Filter
( FilterPredicates(RPFilterPredicate)
, conduitPktFilter
)
import Data.Conduit.Serialization.Binary (conduitGet, conduitPut)
import Data.Void (Void)
import qualified Data.Yaml as Y
import HOpenPGP.Tools.Armor (doDeArmor)
import HOpenPGP.Tools.Common (banner, prependAuto, versioner, warranty)
import HOpenPGP.Tools.Parser (parsePExp)
import System.IO
( BufferMode(..)
, Handle
, hFlush
, hSetBuffering
, stderr
, stdin
, stdout
)
import Prettyprinter
( Pretty
, (<+>)
, group
, hardline
, list
, pretty
, softline
)
import Prettyprinter.Render.Text (hPutDoc)
import Options.Applicative.Builder
( argument
, command
, eitherReader
, footerDoc
, headerDoc
, help
, helpDoc
, info
, long
, metavar
, option
, prefs
, progDesc
, showDefaultWith
, showHelpOnError
, str
, strOption
, value
)
import Options.Applicative.Extra (customExecParser, helper, hsubparser)
import Options.Applicative.Types (Parser)
data Command
= DumpC DumpOptions
| DeArmorC
| ArmorC ArmoringOptions
| FilterC FilteringOptions
data DumpOptions =
DumpOptions
{ outputformat :: DumpOutputFormat
}
data FilteringOptions =
FilteringOptions
{ fExpression :: String
}
data DumpOutputFormat
= DumpPretty
| DumpJSON
| DumpYAML
| DumpShow
deriving (Bounded, Enum, Read, Show)
doDump :: DumpOptions -> IO ()
doDump DumpOptions {..} =
runConduitRes $
CB.sourceHandle stdin .| conduitGet (get :: Get Pkt) .|
case outputformat of
DumpPretty -> prettyPrinter
DumpJSON -> jsonSink
DumpYAML -> yamlSink
DumpShow -> printer
-- Print every input value to standard output.
printer :: (Show a, MonadIO m) => ConduitM a Void m ()
printer = CL.mapM_ (liftIO . print)
prettyPrinter :: (Pretty a, MonadIO m) => ConduitM a Void m ()
prettyPrinter =
CL.mapM_ (liftIO . hPutDoc stdout . (<> hardline) . group . pretty)
jsonSink :: (A.ToJSON a, MonadIO m) => ConduitM a Void m ()
jsonSink = CL.mapM_ (liftIO . BL.putStr . flip BL.snoc 0x0a . A.encode)
yamlSink :: (Y.ToJSON a, MonadIO m) => ConduitM a Void m ()
yamlSink = CL.mapM_ (liftIO . B.putStr . flip B.snoc 0x0a . Y.encode)
doFilter :: FilteringOptions -> IO ()
doFilter fo =
runConduitRes $
CB.sourceHandle stdin .| conduitGet (get :: Get Pkt) .|
conduitPktFilter (parseExpressions fo) .|
CL.map put .|
conduitPut .|
CB.sinkHandle stdout
doP :: Parser DumpOptions
doP =
DumpOptions <$>
option
(prependAuto "Dump")
(long "output-format" <>
metavar "FORMAT" <>
value DumpPretty <> showDefaultWith (drop 4 . show) <> ofHelp)
where
ofHelp =
helpDoc . Just $
pretty "output format" <>
hardline <> list (map (pretty . drop 4 . show) ofchoices)
ofchoices = [minBound .. maxBound] :: [DumpOutputFormat]
foP :: Parser FilteringOptions
foP =
FilteringOptions <$> argument str (metavar "EXPRESSION" <> filterTargetHelp)
where
filterTargetHelp =
helpDoc . Just $
pretty "packet filter expression" <+>
softline <> pretty "see source for current syntax"
dispatch :: Command -> IO ()
dispatch c = (banner' stderr >> hFlush stderr) >> dispatch' c
where
dispatch' (DumpC o) = doDump o
dispatch' DeArmorC = doDeArmor
dispatch' (ArmorC o) = doArmor o
dispatch' (FilterC o) = doFilter o
main :: IO ()
main = do
hSetBuffering stderr LineBuffering
customExecParser
(prefs showHelpOnError)
(info
(helper <*> versioner "hot" <*> cmd)
(headerDoc (Just (banner "hot")) <>
progDesc "hOpenPGP OpenPGP-message Tool" <>
footerDoc (Just (warranty "hot")))) >>=
dispatch
cmd :: Parser Command
cmd =
hsubparser
(command "armor" (info (ArmorC <$> aoP) (progDesc "Armor stdin to stdout")) <>
command
"dearmor"
(info (pure DeArmorC) (progDesc "Dearmor stdin to stdout")) <>
command
"dump"
(info (DumpC <$> doP) (progDesc "Dump OpenPGP packets from stdin")) <>
command
"filter"
(info
(FilterC <$> foP)
(progDesc "Filter some packets from stdin to stdout")))
banner' :: Handle -> IO ()
banner' h = hPutDoc h (banner "hot" <> hardline <> warranty "hot" <> hardline)
parseExpressions :: FilteringOptions -> FilterPredicates r a
parseExpressions FilteringOptions {..} = RPFilterPredicate (parseE fExpression)
where
parseE e = either (error . ("filter parse error: " ++)) id (parsePExp e)
armorTypes :: [(String, ArmorType)]
armorTypes =
[ ("message", ArmorMessage)
, ("pubkeyblock", ArmorPublicKeyBlock)
, ("privkeyblock", ArmorPrivateKeyBlock)
, ("signature", ArmorSignature)
]
armorTypeReader :: String -> Either String ArmorType
armorTypeReader = note "unknown armor type" . flip lookup armorTypes
aoP :: Parser ArmoringOptions
aoP =
ArmoringOptions <$>
optional
(strOption
(long "comment" <> metavar "COMMENT" <> help "ASCII armor Comment field")) <*>
option
(eitherReader armorTypeReader)
(long "armor-type" <> metavar "ARMORTYPE" <> armortypeHelp)
where
armortypeHelp =
helpDoc . Just $
pretty "ASCII armor type" <>
softline <> list (map (pretty . fst) armorTypes)
data ArmoringOptions =
ArmoringOptions
{ comment :: Maybe String
, armortype :: ArmorType
}
doArmor :: ArmoringOptions -> IO ()
doArmor ArmoringOptions {..} = do
m <- runConduitRes $ CB.sourceHandle stdin .| CL.consume
let a =
Armor
armortype
(maybe [] (\x -> [("Comment", x)]) comment)
(BL.fromChunks m)
BL.putStr $ AA.encodeLazy [a]