327 lines
10 KiB
Haskell
327 lines
10 KiB
Haskell
{- git-annex assistant webapp configurator for pairing
|
|
-
|
|
- Copyright 2012 Joey Hess <id@joeyh.name>
|
|
-
|
|
- Licensed under the GNU AGPL version 3 or higher.
|
|
-}
|
|
|
|
{-# LANGUAGE TypeFamilies, QuasiQuotes, TemplateHaskell, OverloadedStrings #-}
|
|
{-# LANGUAGE CPP #-}
|
|
|
|
module Assistant.WebApp.Configurators.Pairing where
|
|
|
|
import Assistant.Pairing
|
|
import Assistant.WebApp.Common
|
|
import Assistant.Types.Buddies
|
|
import Annex.UUID
|
|
#ifdef WITH_PAIRING
|
|
import Assistant.Pairing.Network
|
|
import Assistant.Pairing.MakeRemote
|
|
import Assistant.Ssh
|
|
import Assistant.Alert
|
|
import Assistant.DaemonStatus
|
|
import Utility.Verifiable
|
|
#endif
|
|
#ifdef WITH_XMPP
|
|
import Assistant.XMPP.Client
|
|
import Assistant.XMPP.Buddies
|
|
import Assistant.XMPP.Git
|
|
import Network.Protocol.XMPP
|
|
import Assistant.Types.NetMessager
|
|
import Assistant.NetMessager
|
|
import Assistant.WebApp.RepoList
|
|
import Assistant.WebApp.Configurators
|
|
import Assistant.WebApp.Configurators.XMPP
|
|
#endif
|
|
import Utility.UserInfo
|
|
import Git
|
|
|
|
import qualified Data.Text as T
|
|
#ifdef WITH_PAIRING
|
|
import qualified Data.Text.Encoding as T
|
|
import qualified Data.ByteString as B
|
|
import Data.Char
|
|
import qualified Control.Exception as E
|
|
import Control.Concurrent
|
|
#endif
|
|
#ifdef WITH_XMPP
|
|
import qualified Data.Set as S
|
|
#endif
|
|
|
|
getStartXMPPPairFriendR :: Handler Html
|
|
#ifdef WITH_XMPP
|
|
getStartXMPPPairFriendR = ifM (isJust <$> liftAnnex getXMPPCreds)
|
|
( do
|
|
{- Ask buddies to send presence info, to get
|
|
- the buddy list populated. -}
|
|
liftAssistant $ sendNetMessage QueryPresence
|
|
pairPage $
|
|
$(widgetFile "configurators/pairing/xmpp/friend/prompt")
|
|
, do
|
|
-- go get XMPP configured, then come back
|
|
redirect XMPPConfigForPairFriendR
|
|
)
|
|
#else
|
|
getStartXMPPPairFriendR = noXMPPPairing
|
|
|
|
noXMPPPairing :: Handler Html
|
|
noXMPPPairing = noPairing "XMPP"
|
|
#endif
|
|
|
|
getStartXMPPPairSelfR :: Handler Html
|
|
#ifdef WITH_XMPP
|
|
getStartXMPPPairSelfR = go =<< liftAnnex getXMPPCreds
|
|
where
|
|
go Nothing = do
|
|
-- go get XMPP configured, then come back
|
|
redirect XMPPConfigForPairSelfR
|
|
go (Just creds) = do
|
|
{- Ask buddies to send presence info, to get
|
|
- the buddy list populated. -}
|
|
liftAssistant $ sendNetMessage QueryPresence
|
|
let account = xmppJID creds
|
|
pairPage $
|
|
$(widgetFile "configurators/pairing/xmpp/self/prompt")
|
|
#else
|
|
getStartXMPPPairSelfR = noXMPPPairing
|
|
#endif
|
|
|
|
getRunningXMPPPairFriendR :: BuddyKey -> Handler Html
|
|
getRunningXMPPPairFriendR = sendXMPPPairRequest . Just
|
|
|
|
getRunningXMPPPairSelfR :: Handler Html
|
|
getRunningXMPPPairSelfR = sendXMPPPairRequest Nothing
|
|
|
|
{- Sends a XMPP pair request, to a buddy or to self. -}
|
|
sendXMPPPairRequest :: Maybe BuddyKey -> Handler Html
|
|
#ifdef WITH_XMPP
|
|
sendXMPPPairRequest mbid = do
|
|
bid <- maybe getself return mbid
|
|
buddy <- liftAssistant $ getBuddy bid <<~ buddyList
|
|
go $ S.toList . buddyAssistants <$> buddy
|
|
where
|
|
go (Just (clients@((Client exemplar):_))) = do
|
|
u <- liftAnnex getUUID
|
|
liftAssistant $ forM_ clients $ \(Client c) -> sendNetMessage $
|
|
PairingNotification PairReq (formatJID c) u
|
|
xmppPairStatus True $
|
|
if selfpair then Nothing else Just exemplar
|
|
go _
|
|
{- Nudge the user to turn on their other device. -}
|
|
| selfpair = do
|
|
liftAssistant $ sendNetMessage QueryPresence
|
|
pairPage $
|
|
$(widgetFile "configurators/pairing/xmpp/self/retry")
|
|
{- Buddy could have logged out, etc.
|
|
- Go back to buddy list. -}
|
|
| otherwise = redirect StartXMPPPairFriendR
|
|
selfpair = isNothing mbid
|
|
getself = maybe (error "XMPP not configured")
|
|
(return . BuddyKey . xmppJID)
|
|
=<< liftAnnex getXMPPCreds
|
|
#else
|
|
sendXMPPPairRequest _ = noXMPPPairing
|
|
#endif
|
|
|
|
{- Starts local pairing. -}
|
|
getStartLocalPairR :: Handler Html
|
|
getStartLocalPairR = postStartLocalPairR
|
|
postStartLocalPairR :: Handler Html
|
|
#ifdef WITH_PAIRING
|
|
postStartLocalPairR = promptSecret Nothing $
|
|
startLocalPairing PairReq noop pairingAlert Nothing
|
|
#else
|
|
postStartLocalPairR = noLocalPairing
|
|
|
|
noLocalPairing :: Handler Html
|
|
noLocalPairing = noPairing "local"
|
|
#endif
|
|
|
|
{- Runs on the system that responds to a local pair request; sets up the ssh
|
|
- authorized key first so that the originating host can immediately sync
|
|
- with us. -}
|
|
getFinishLocalPairR :: PairMsg -> Handler Html
|
|
getFinishLocalPairR = postFinishLocalPairR
|
|
postFinishLocalPairR :: PairMsg -> Handler Html
|
|
#ifdef WITH_PAIRING
|
|
postFinishLocalPairR msg = promptSecret (Just msg) $ \_ secret -> do
|
|
repodir <- liftH $ repoPath <$> liftAnnex gitRepo
|
|
liftIO $ setup repodir
|
|
startLocalPairing PairAck (cleanup repodir) alert uuid "" secret
|
|
where
|
|
alert = pairRequestAcknowledgedAlert (pairRepo msg) . Just
|
|
setup repodir = setupAuthorizedKeys msg repodir
|
|
cleanup repodir = removeAuthorizedKeys True repodir $
|
|
remoteSshPubKey $ pairMsgData msg
|
|
uuid = Just $ pairUUID $ pairMsgData msg
|
|
#else
|
|
postFinishLocalPairR _ = noLocalPairing
|
|
#endif
|
|
|
|
getConfirmXMPPPairFriendR :: PairKey -> Handler Html
|
|
#ifdef WITH_XMPP
|
|
getConfirmXMPPPairFriendR pairkey@(PairKey _ t) = case parseJID t of
|
|
Nothing -> error "bad JID"
|
|
Just theirjid -> pairPage $ do
|
|
let name = buddyName theirjid
|
|
$(widgetFile "configurators/pairing/xmpp/friend/confirm")
|
|
#else
|
|
getConfirmXMPPPairFriendR _ = noXMPPPairing
|
|
#endif
|
|
|
|
getFinishXMPPPairFriendR :: PairKey -> Handler Html
|
|
#ifdef WITH_XMPP
|
|
getFinishXMPPPairFriendR (PairKey theiruuid t) = case parseJID t of
|
|
Nothing -> error "bad JID"
|
|
Just theirjid -> do
|
|
selfuuid <- liftAnnex getUUID
|
|
liftAssistant $ do
|
|
sendNetMessage $
|
|
PairingNotification PairAck (formatJID theirjid) selfuuid
|
|
finishXMPPPairing theirjid theiruuid
|
|
xmppPairStatus False $ Just theirjid
|
|
#else
|
|
getFinishXMPPPairFriendR _ = noXMPPPairing
|
|
#endif
|
|
|
|
{- Displays a page indicating pairing status and
|
|
- prompting to set up cloud repositories. -}
|
|
#ifdef WITH_XMPP
|
|
xmppPairStatus :: Bool -> Maybe JID -> Handler Html
|
|
xmppPairStatus inprogress theirjid = pairPage $ do
|
|
let friend = buddyName <$> theirjid
|
|
$(widgetFile "configurators/pairing/xmpp/end")
|
|
#endif
|
|
|
|
getRunningLocalPairR :: SecretReminder -> Handler Html
|
|
#ifdef WITH_PAIRING
|
|
getRunningLocalPairR s = pairPage $ do
|
|
let secret = fromSecretReminder s
|
|
$(widgetFile "configurators/pairing/local/inprogress")
|
|
#else
|
|
getRunningLocalPairR _ = noLocalPairing
|
|
#endif
|
|
|
|
#ifdef WITH_PAIRING
|
|
|
|
{- Starts local pairing, at either the PairReq (initiating host) or
|
|
- PairAck (responding host) stage.
|
|
-
|
|
- Displays an alert, and starts a thread sending the pairing message,
|
|
- which will continue running until the other host responds, or until
|
|
- canceled by the user. If canceled by the user, runs the oncancel action.
|
|
-
|
|
- Redirects to the pairing in progress page.
|
|
-}
|
|
startLocalPairing :: PairStage -> IO () -> (AlertButton -> Alert) -> Maybe UUID -> Text -> Secret -> Widget
|
|
startLocalPairing stage oncancel alert muuid displaysecret secret = do
|
|
urlrender <- liftH getUrlRender
|
|
reldir <- fromJust . relDir <$> liftH getYesod
|
|
|
|
sendrequests <- liftAssistant $ asIO2 $ mksendrequests urlrender
|
|
{- Generating a ssh key pair can take a while, so do it in the
|
|
- background. -}
|
|
thread <- liftAssistant $ asIO $ do
|
|
keypair <- liftIO $ genSshKeyPair
|
|
pairdata <- liftIO $ PairData
|
|
<$> getHostname
|
|
<*> myUserName
|
|
<*> pure reldir
|
|
<*> pure (sshPubKey keypair)
|
|
<*> (maybe genUUID return muuid)
|
|
let sender = multicastPairMsg Nothing secret pairdata
|
|
let pip = PairingInProgress secret Nothing keypair pairdata stage
|
|
startSending pip stage $ sendrequests sender
|
|
void $ liftIO $ forkIO thread
|
|
|
|
liftH $ redirect $ RunningLocalPairR $ toSecretReminder displaysecret
|
|
where
|
|
{- Sends pairing messages until the thread is killed,
|
|
- and shows an activity alert while doing it.
|
|
-
|
|
- The cancel button returns the user to the DashboardR. This is
|
|
- not ideal, but they have to be sent somewhere, and could
|
|
- have been on a page specific to the in-process pairing
|
|
- that just stopped, so can't go back there.
|
|
-}
|
|
mksendrequests urlrender sender _stage = do
|
|
tid <- liftIO myThreadId
|
|
let selfdestruct = AlertButton
|
|
{ buttonLabel = "Cancel"
|
|
, buttonPrimary = True
|
|
, buttonUrl = urlrender DashboardR
|
|
, buttonAction = Just $ const $ do
|
|
oncancel
|
|
killThread tid
|
|
}
|
|
alertDuring (alert selfdestruct) $ liftIO $ do
|
|
_ <- E.try (sender stage) :: IO (Either E.SomeException ())
|
|
return ()
|
|
|
|
data InputSecret = InputSecret { secretText :: Maybe Text }
|
|
|
|
{- If a PairMsg is passed in, ensures that the user enters a secret
|
|
- that can validate it. -}
|
|
promptSecret :: Maybe PairMsg -> (Text -> Secret -> Widget) -> Handler Html
|
|
promptSecret msg cont = pairPage $ do
|
|
((result, form), enctype) <- liftH $
|
|
runFormPostNoToken $ renderBootstrap3 bootstrapFormLayout $
|
|
InputSecret <$> aopt textField (bfs "Secret phrase") Nothing
|
|
case result of
|
|
FormSuccess v -> do
|
|
let rawsecret = fromMaybe "" $ secretText v
|
|
let secret = toSecret rawsecret
|
|
case msg of
|
|
Nothing -> case secretProblem secret of
|
|
Nothing -> cont rawsecret secret
|
|
Just problem ->
|
|
showform form enctype $ Just problem
|
|
Just m ->
|
|
if verify (fromPairMsg m) secret
|
|
then cont rawsecret secret
|
|
else showform form enctype $ Just
|
|
"That's not the right secret phrase."
|
|
_ -> showform form enctype Nothing
|
|
where
|
|
showform form enctype mproblem = do
|
|
let start = isNothing msg
|
|
let badphrase = isJust mproblem
|
|
let problem = fromMaybe "" mproblem
|
|
let (username, hostname) = maybe ("", "")
|
|
(\(_, v, a) -> (T.pack $ remoteUserName v, T.pack $ fromMaybe (showAddr a) (remoteHostName v)))
|
|
(verifiableVal . fromPairMsg <$> msg)
|
|
u <- T.pack <$> liftIO myUserName
|
|
let sameusername = username == u
|
|
$(widgetFile "configurators/pairing/local/prompt")
|
|
|
|
{- This counts unicode characters as more than one character,
|
|
- but that's ok; they *do* provide additional entropy. -}
|
|
secretProblem :: Secret -> Maybe Text
|
|
secretProblem s
|
|
| B.null s = Just "The secret phrase cannot be left empty. (Remember that punctuation and white space is ignored.)"
|
|
| B.length s < 6 = Just "Enter a longer secret phrase, at least 6 characters, but really, a phrase is best! This is not a password you'll need to enter every day."
|
|
| s == toSecret sampleQuote = Just "Speaking of foolishness, don't paste in the example I gave. Enter a different phrase, please!"
|
|
| otherwise = Nothing
|
|
|
|
toSecret :: Text -> Secret
|
|
toSecret s = T.encodeUtf8 $ T.toLower $ T.filter isAlphaNum s
|
|
|
|
{- From Dickens -}
|
|
sampleQuote :: Text
|
|
sampleQuote = T.unwords
|
|
[ "It was the best of times,"
|
|
, "it was the worst of times,"
|
|
, "it was the age of wisdom,"
|
|
, "it was the age of foolishness."
|
|
]
|
|
|
|
#else
|
|
|
|
#endif
|
|
|
|
pairPage :: Widget -> Handler Html
|
|
pairPage = page "Pairing" (Just Configuration)
|
|
|
|
noPairing :: Text -> Handler Html
|
|
noPairing pairingtype = pairPage $
|
|
$(widgetFile "configurators/pairing/disabled")
|