1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
|
{-# LANGUAGE OverloadedStrings, BangPatterns #-}
{- Copyright 2016 Joey Hess <id@joeyh.name>
-
- Licensed under the GNU AGPL version 3 or higher.
-}
module Main where
import Types
import Tunables
import qualified CmdLine
import UI
import Encryption
import Entropy
import ExpensiveHash
import Cost
import SecretKey
import Share
import Storage
import HTTP.Server
import qualified Gpg
import Data.Maybe
import Data.Time.Clock
import Data.Time.Calendar
import Data.Monoid
import Control.DeepSeq
import qualified Data.ByteString as B
import qualified Data.ByteString.UTF8 as BU8
import qualified Data.Set as S
import System.Posix.User (userGecos, getUserEntryForID, getEffectiveUserID)
main :: IO ()
main = do
cmdline <- CmdLine.get
ui <- selectUI (CmdLine.gui cmdline)
let mkt = CmdLine.customizeShareParams cmdline
(tunables, possibletunables) <- if CmdLine.testMode cmdline
then do
showInfo ui "Test mode"
"Keysafe is running in test mode. This is not secure, and should not be used with real secret keys!"
return (mkt testModeTunables, [mkt testModeTunables])
else return (mkt defaultTunables, map (mkt . snd) knownTunings)
storagelocations <- if CmdLine.localstorage cmdline
then return localStorageLocations
else allStorageLocations
dispatch cmdline ui storagelocations tunables possibletunables
dispatch :: CmdLine.CmdLine -> UI -> StorageLocations -> Tunables -> [Tunables] -> IO ()
dispatch cmdline ui storagelocations tunables possibletunables = do
mode <- CmdLine.selectMode cmdline
go mode (CmdLine.secretkeysource cmdline)
where
go CmdLine.Backup (Just secretkeysource) =
backup storagelocations ui tunables secretkeysource
=<< getSecretKey secretkeysource
go CmdLine.Restore (Just secretkeydest) =
restore storagelocations ui possibletunables secretkeydest
go CmdLine.Backup Nothing =
backup storagelocations ui tunables Gpg.anyKey
=<< Gpg.getKeyToBackup ui
go CmdLine.Restore Nothing =
restore storagelocations ui possibletunables Gpg.anyKey
go CmdLine.UploadQueued _ =
uploadQueued
go (CmdLine.Server port) _ =
runServer port
go CmdLine.Benchmark _ =
benchmarkTunables tunables
backup :: StorageLocations -> UI -> Tunables -> SecretKeySource -> SecretKey -> IO ()
backup storagelocations ui tunables secretkeysource secretkey = do
username <- userName
Name theirname <- fromMaybe (error "Aborting on no username")
<$> promptName ui "Enter your name"
usernamedesc (Just username) validateName
go theirname
where
go theirname = do
Name othername <- fromMaybe (error "aborting on no othername")
<$> promptName ui "Enter other name"
othernamedesc Nothing validateName
let name = Name (theirname <> " " <> othername)
kek <- promptkek name
let sis = shareIdents tunables name secretkeysource
let cost = getCreationCost kek <> getCreationCost sis
r <- withProgressIncremental ui "Encrypting and storing data"
(encryptdesc cost) $ \addpercent -> do
let esk = encrypt tunables kek secretkey
shares <- genShares esk tunables
_ <- esk `deepseq` addpercent 25
_ <- sis `seq` addpercent 25
let step = 50 `div` sum (map S.size shares)
storeShares storagelocations sis shares (addpercent step)
case r of
StoreSuccess -> showInfo ui "Success" "Your secret key was successfully encrypted and backed up."
StoreFailure s -> showError ui ("There was a problem storing your encrypted secret key: " ++ s)
StoreAlreadyExists -> do
showError ui $ unlines
[ "Another secret key is already being stored under the name you entered."
, "Please try again with a different name."
]
go theirname
promptkek name = do
password <- fromMaybe (error "Aborting on no password")
<$> promptPassword ui True "Enter password" passworddesc
kek <- genKeyEncryptionKey tunables name password
username <- userName
let badwords = concatMap namewords [name, username]
let crackcost = estimateAttackCost spotAWS $
estimateBruteforceOf kek $
passwordEntropy password badwords
let mincost = Dollars 100000
if crackcost < mincost
then do
showError ui $ "Weak password! It would cost only " ++ show crackcost ++ " to crack the password. Please think of a better one. More words would be good.."
promptkek name
else do
(thisyear, _, _) <- toGregorian . utctDay
<$> getCurrentTime
ok <- promptQuestion ui "Password strength estimate"
(crackdesc crackcost thisyear)
"Is your password strong enough?"
if ok
then return kek
else promptkek name
namewords (Name nb) = words (BU8.toString nb)
keydesc = case secretkeysource of
GpgKey _ -> "gpg secret key"
KeyFile _ -> "secret key"
usernamedesc = unlines
[ "Keysafe is going to backup your " ++ keydesc ++ " securely."
, ""
, "You will be prompted for some information. To restore your " ++ keydesc
, "at a later date, you will need to remember and enter the same information."
, ""
, "To get started, what is your name?"
]
othernamedesc = unlines
[ "Now think of another name, which not many people know."
, "This will be used to make it hard for anyone else to find"
, "the backup of your " ++ keydesc ++ "."
, ""
, "Some suggestions:"
, ""
, otherNameSuggestions
, ""
, "Make sure to pick a name you will remember later,"
, "when you restore your " ++ keydesc ++ "."
]
passworddesc = unlines
[ "Pick a password that will be used to protect your secret key."
, ""
, "It's very important that this password be hard to guess."
, ""
, "And, it needs to be one that you will be able to remember years from now"
, "in order to restore your secret key."
]
crackdesc crackcost thisyear = unlines $
"Rough estimate of the cost to crack your password: " :
costOverTimeTable crackcost thisyear
encryptdesc cost = unlines
[ "This will probably take around " ++ showCostMinutes cost
, ""
, "(It's a feature that this takes a while; it makes it hard"
, "for anyone to find your data, or crack your password.)"
, ""
, "Please wait..."
]
otherNameSuggestions :: String
otherNameSuggestions = unlines $ map (" * " ++)
[ "Your high-school sweetheart."
, "Your first pet."
, "Your favorite teacher."
, "Your college roomate."
, "A place you like to visit."
]
restore :: StorageLocations -> UI -> [Tunables] -> SecretKeySource -> IO ()
restore storagelocations ui possibletunables secretkeydest = do
username <- userName
Name theirname <- fromMaybe (error "Aborting on no username")
<$> promptName ui "Enter your name"
namedesc (Just username) validateName
Name othername <- fromMaybe (error "aborting on no othername")
<$> promptName ui "Enter other name"
othernamedesc Nothing validateName
let name = Name (theirname <> " " <> othername)
password <- fromMaybe (error "Aborting on no password")
<$> promptPassword ui True "Enter password" passworddesc
let mksis tunables = shareIdents tunables name secretkeydest
r <- downloadInitialShares storagelocations ui mksis possibletunables
case r of
Nothing -> showError ui "No shares could be downloaded. Perhaps you entered the wrong name or password?"
Just (tunables, shares, sis) -> do
let candidatekeys = candidateKeyEncryptionKeys tunables name password
let cost = getCreationCost candidatekeys
<> castCost (getDecryptionCost candidatekeys)
case combineShares tunables [shares] of
Left e -> showError ui e
Right esk -> do
final <- withProgress ui "Decrypting"
(decryptdesc cost) $ \setpercent ->
go tunables [shares] sis setpercent $
tryDecrypt candidatekeys esk
final
where
go tunables firstshares sis setpercent r = case r of
DecryptFailed -> return $
showError ui "Decryption failed! Unknown why it would fail at this point."
DecryptSuccess secretkey -> do
_ <- setpercent 100
writeSecretKey secretkeydest secretkey
return $
showInfo ui "Success" "Your secret key was successfully restored!"
DecryptIncomplete kek -> do
-- Download shares for another chunk.
(nextshares, sis') <- retrieveShares storagelocations sis (return ())
let shares = firstshares ++ [nextshares]
case combineShares tunables shares of
Left e -> return $ showError ui e
Right esk ->
go tunables shares sis' setpercent $
decrypt kek esk
namedesc = unlines
[ "When you backed up your secret key, you entered some information."
, "To restore it, you'll need to remember what you entered back then."
, ""
, "To get started, what is your name?"
]
othernamedesc = unlines
[ "What other name did you enter when you backed up your secret key?"
, ""
, "Back then, you were given some suggestions, like these:"
, ""
, otherNameSuggestions
]
passworddesc = unlines
[ "Enter the password to unlock your secret key."
]
decryptdesc cost = unlines
[ "This will probably take around " ++ showCostMinutes cost
, ""
, "(It's a feature that this takes so long; it prevents cracking your password.)"
, ""
, "Please wait..."
]
-- | Try each possible tunable until the initial set of
-- shares are found, the return the shares, and
-- ShareIdents to download subsequent sets.
downloadInitialShares
:: StorageLocations
-> UI
-> (Tunables -> ShareIdents)
-> [Tunables]
-> IO (Maybe (Tunables, S.Set Share, ShareIdents))
downloadInitialShares storagelocations ui mksis possibletunables =
withProgressIncremental ui "Downloading encrypted data" message $ \addpercent -> do
go possibletunables addpercent
where
go [] _ = return Nothing
go (tunables:othertunables) addpercent = do
-- Just calculating the hash to generate the stream of idents
-- probably takes most of the time.
let !sis = mksis tunables
addpercent 50
let m = totalObjects (shareParams tunables)
let step = 50 `div` m
(shares, sis') <- retrieveShares storagelocations sis (addpercent step)
if S.null shares
then go othertunables addpercent
else return $ Just (tunables, shares, sis')
possiblesis = map mksis possibletunables
message = unlines
[ "This will probably take around "
++ showCostMinutes (mconcat $ map getCreationCost possiblesis)
, ""
, "(It's a feature that this takes a while; it makes it hard"
, "for anyone else to find your data.)"
, ""
, "Please wait..."
]
validateName :: Name -> Maybe Problem
validateName (Name n)
| B.length n < 2 = Just "The name should be at least 2 letters long."
| otherwise = Nothing
userName :: IO Name
userName = do
u <- getUserEntryForID =<< getEffectiveUserID
return $ Name $ BU8.fromString $ takeWhile (/= ',') (userGecos u)
|