summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjoe <joe@jerkface.net>2014-05-04 19:05:47 -0400
committerjoe <joe@jerkface.net>2014-05-04 19:05:47 -0400
commite665efa8b642a441b7516d1467a7266459cac6ec (patch)
tree00c7acef05820b3df9cad03ad994e5c75c6aad30
parenteff37fcdb4ca72340cc6393179b37f546e37f237 (diff)
document Autosign symbol
-rw-r--r--KeyRing.hs20
1 files changed, 14 insertions, 6 deletions
diff --git a/KeyRing.hs b/KeyRing.hs
index 361d007..294933f 100644
--- a/KeyRing.hs
+++ b/KeyRing.hs
@@ -48,7 +48,6 @@ module KeyRing
48 , KeyRingRuntime(..) 48 , KeyRingRuntime(..)
49 , KeyDB 49 , KeyDB
50 , KeyData(..) 50 , KeyData(..)
51 , UserIDRecord(..)
52 , SubKey(..) 51 , SubKey(..)
53 , packet 52 , packet
54 , locations 53 , locations
@@ -66,6 +65,7 @@ module KeyRing
66 , matchpr 65 , matchpr
67 , parseSpec 66 , parseSpec
68 , parseUID 67 , parseUID
68 , UserIDRecord(..)
69 , pkcs8 69 , pkcs8
70 , RSAPublicKey(..) 70 , RSAPublicKey(..)
71 , rsaKeyFromPacket 71 , rsaKeyFromPacket
@@ -215,6 +215,8 @@ data Access = AutoAccess -- ^ secret or public as appropriate based on existing
215 | Sec -- ^ secret information 215 | Sec -- ^ secret information
216 | Pub -- ^ public information 216 | Pub -- ^ public information
217 217
218-- | Note that the documentation here is intended for when this value is
219-- assigned to 'fill'. For other usage, see 'spill'.
218data KeyFilter = KF_None -- ^ No keys will be imported. 220data KeyFilter = KF_None -- ^ No keys will be imported.
219 | KF_Match String -- ^ Only the key that matches the spec will be imported. 221 | KF_Match String -- ^ Only the key that matches the spec will be imported.
220 | KF_Subkeys -- ^ Subkeys will be imported if their owner key is 222 | KF_Subkeys -- ^ Subkeys will be imported if their owner key is
@@ -344,7 +346,15 @@ data PassphraseSpec = PassphraseSpec
344 -- ^ The passphrase will be read from this file or file descriptor. 346 -- ^ The passphrase will be read from this file or file descriptor.
345 } 347 }
346 348
347data Transform = Autosign 349data Transform =
350 Autosign
351 -- ^ This operation will make signatures for any tor-style UID
352 -- that matches a tor subkey and thus can be authenticated without
353 -- requring the judgement of a human user.
354 --
355 -- A tor-style UID is one of the following form:
356 --
357 -- > Anonymous <root@HOSTNAME.onion>
348 deriving (Eq,Ord) 358 deriving (Eq,Ord)
349 359
350-- | This type describes an idempotent transformation (merge or import) on a 360-- | This type describes an idempotent transformation (merge or import) on a
@@ -2550,10 +2560,8 @@ type SigAndTrust = ( MappedPacket
2550type KeyKey = [ByteString] 2560type KeyKey = [ByteString]
2551data SubKey = SubKey MappedPacket [SigAndTrust] 2561data SubKey = SubKey MappedPacket [SigAndTrust]
2552 2562
2553-- | This is a GPG Identity. It's poorly named 2563-- | This is a GPG Identity which includes a master key and all its UIDs and
2554-- but we are keeping the name around until 2564-- subkeys and associated signatures.
2555-- we're sure we wont be cutting and pasting
2556-- code with master any more.
2557data KeyData = KeyData { keyMappedPacket :: MappedPacket -- main key 2565data KeyData = KeyData { keyMappedPacket :: MappedPacket -- main key
2558 , keySigAndTrusts :: [SigAndTrust] -- sigs on main key 2566 , keySigAndTrusts :: [SigAndTrust] -- sigs on main key
2559 , keyUids :: (Map.Map String ([SigAndTrust],OriginMap)) -- uids 2567 , keyUids :: (Map.Map String ([SigAndTrust],OriginMap)) -- uids