OAuth2 server subsite for Yesod web apps
Clone
HTTPS:
darcs clone https://vervis.peers.community/repos/vlBxr
SSH:
darcs clone USERNAME@vervis.peers.community:vlBxr
Tags
TODO
Handler.hs
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 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 | {- This file is part of Dvara.
-
- Written in 2020 by fr33domlover <fr33domlover@riseup.net>.
-
- ♡ Copying is an act of love. Please copy, reuse and share.
-
- The author(s) have dedicated all copyright and related and neighboring
- rights to this software to the public domain worldwide. This software is
- distributed without any warranty.
-
- You should have received a copy of the CC0 Public Domain Dedication along
- with this software. If not, see
- <http://creativecommons.org/publicdomain/zero/1.0/>.
-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE QuasiQuotes #-}
{-# LANGUAGE TypeFamilies #-}
module Dvara.Handler
( getRandomCode
, getDvaraAuth
, parseScopes
, writeScopes
, postApplicationsR
, getVerifyCredsR
, getAuthorizeR
, postAuthorizeR
, postTokenR
, postRevokeR
)
where
import Control.Applicative
import Control.Monad
import Control.Monad.Trans.Maybe
import Crypto.Random
import Data.Aeson
import Data.Bifunctor
import Data.Int
import Data.List.NonEmpty (NonEmpty)
import Data.Text (Text)
import Data.Time.Clock
import Data.Time.Clock.POSIX
import Data.Traversable
import Database.Persist
import Network.HTTP.Types.Method
import Network.HTTP.Types.Status
import Network.URI
import Yesod.Auth
import Yesod.Core
import Yesod.Form
import Yesod.Persist.Core
import qualified Data.ByteString.Base64.URL as B64U
import qualified Data.List.NonEmpty as NE
import qualified Data.Text as T
import qualified Data.Text.Encoding as TE
import Dvara.Class
import Dvara.Field
import Dvara.Foundation
import Dvara.Model
import Dvara.Types
getRandomCode :: IO Text
getRandomCode = TE.decodeUtf8 . B64U.encode <$> getRandomBytes 32
maybeAuthId'
:: ( YesodAuthDvara site
, MonadHandler m
, HandlerSite m ~ site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite (BaseBackend backend)
)
=> m (Maybe (AuthId site))
maybeAuthId' = runMaybeT $ MaybeT maybeAuthId <|> maybeDvaraAuth
where
maybeDvaraAuth = do
(_, maid, _) <- MaybeT $ liftHandler getDvaraAuth
MaybeT $ pure maid
requireAuthId'
:: ( YesodAuthDvara site
, MonadHandler m
, HandlerSite m ~ site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite (BaseBackend backend)
)
=> m (AuthId site)
requireAuthId' = do
maid <- maybeAuthId'
case maid of
Nothing -> requireAuthId
Just aid -> return aid
data AppInfo = AppInfo
{ appName :: Text
, appWebsite :: Maybe URI
, appRepo :: Maybe URI
}
parseScopes
:: (Monad m, HandlerSite m ~ site, YesodAuthDvara site)
=> NonEmpty Text -> m (Either Text (NonEmpty (YesodAuthDvaraScope site)))
parseScopes = pure . first T.pack . traverse parseScope
writeScopes :: DvaraScope a => NonEmpty a -> Scopes
writeScopes = Scopes . NE.map renderScope
checkAuthToken
:: ( YesodAuthDvara site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite (BaseBackend backend)
)
=> Text -> HandlerFor site (Maybe (AppInfo, Maybe (AuthId site), NonEmpty (YesodAuthDvaraScope site)))
checkAuthToken token = runDB $ do
mtok <- getBy $ UniqueToken token
for mtok $ \ (Entity _ tok) -> do
app <- getJust $ tokenClient tok
site <- getYesod
let info =
AppInfo
(applicationName app)
(unPersistURI <$> applicationWebsite app)
(unPersistURI <$> applicationRepo app)
return (info, either error id . parseAuthId site <$> tokenUser tok, either error id . traverse parseScope $ unScopes $ tokenScopes tok)
getDvaraAuth
:: ( YesodAuthDvara site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite (BaseBackend backend)
)
=> HandlerFor site (Maybe (AppInfo, Maybe (AuthId site), NonEmpty (YesodAuthDvaraScope site)))
getDvaraAuth = runMaybeT $ do
t <- MaybeT lookupBearerAuth
MaybeT $ liftHandler $ checkAuthToken t
data NewApp s = NewApp
{ newAppName :: Text
, newAppRedirect :: Redirect
, newAppScopes :: NonEmpty s
, newAppWebsite :: Maybe URI
, newAppRepo :: Maybe URI
}
postApplicationsR
:: ( YesodAuthDvara site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistStoreWrite backend
, PersistStoreWrite (BaseBackend backend)
, RenderMessage site FormMessage
)
=> SubHandler site Encoding
postApplicationsR = do
NewApp name redir scopes website repo <- do
result <- runInputPostResult form
case result of
FormMissing -> err "Input missing"
FormFailure ts -> err $ "Validation error: " <> T.intercalate "; " ts
FormSuccess a -> return a
public <- liftIO getRandomCode
private <- liftIO getRandomCode
now <- liftIO getCurrentTime
liftHandler $ runDB $ insert_ Application
{ applicationCreated = now
, applicationName = name
, applicationWebsite = PersistURI <$> website
, applicationRepo = PersistURI <$> repo
, applicationRedirect = redir
, applicationClient = public
, applicationSecret = private
, applicationScopes = writeScopes scopes
}
return $ pairs
( "client_id" .= public
<> "client_secret" .= private
)
where
form = NewApp
<$> ireq textField "client_name"
<*> ireq redirectField "redirect_uris"
<*> ioptDef scopeField "scopes" defaultScopes
<*> iopt httpUriField "website"
<*> iopt httpUriField "repository"
err :: MonadHandler m => Text -> m a
err t = sendResponseStatus unprocessableEntity422 $ pairs $ "error" .= t
getVerifyCredsR
:: ( YesodAuthDvara site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite (BaseBackend backend)
)
=> SubHandler site Encoding
getVerifyCredsR = do
minfo <- liftHandler getDvaraAuth
case minfo of
Nothing -> err "Invalid access token"
Just (AppInfo name website repo, _, _) -> return $ pairs
( "name" .= name
<> "website" .= (PersistURI <$> website)
<> "repository" .= (PersistURI <$> repo)
)
where
err :: MonadHandler m => Text -> m a
err t = sendResponseStatus unauthorized401 $ pairs $ "error" .= t
data Authorization s = Authorization
{ authForceLogin :: Bool
, authResponseType :: Text
, authClient :: Text
, authRedirect :: Redirect
, authScope :: NonEmpty s
}
getAuthorizeR
:: ( YesodAuthDvara site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite (BaseBackend backend)
)
=> SubHandler site Html
getAuthorizeR = do
_ <- requireAuthId'
result <- runInputPostResult form
(client, redir, scopes) <-
case result of
FormMissing -> err "Input missing"
FormFailure ts -> err $ "Validation error: " <> T.intercalate "; " ts
FormSuccess (Authorization _force response c r s) -> do
unless (response == "code") $ err "response_type isn't 'code'"
return (c, r ,s)
application <- liftHandler $ runDB $ do
mapp <- getBy $ UniqueApplication client
Entity _appid app <-
case mapp of
Nothing -> err "Invalid client_id"
Just a -> return a
unless (redir == applicationRedirect app) $ err "redirect_uri mismatch"
appScopes <-
either err return =<<
parseScopes (unScopes $ applicationScopes app)
unless (all (`elem` appScopes) scopes) $ err "Invalid scope"
return app
let params =
[ ("response_type", "code")
, ("client_id", client)
, ("redirect_uri", renderRedirect redir)
, ("scope", renderScopes $ writeScopes scopes)
]
tp <- getRouteToParent
liftHandler $ defaultLayout $ authorizationWidget (applicationName application) scopes (tp AuthorizeR) params
where
form = Authorization
<$> ioptDef booleanField "force_login" False
<*> ireq textField "response_type"
<*> ireq textField "client_id"
<*> ireq redirectField "redirect_uri"
<*> ioptDef scopeField "scope" defaultScopes
err :: MonadHandler m => Text -> m a
err t = sendResponseStatus badRequest400 $ pairs $ "error" .= t
renderRedirect (RedirectURI u) = T.pack $ show u
renderRedirect RedirectDisplay = "urn:ietf:wg:oauth:2.0:oob"
postAuthorizeR
:: ( YesodAuthDvara site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite backend
, PersistStoreWrite (BaseBackend backend)
)
=> SubHandler site Html
postAuthorizeR = do
user <- requireAuthId'
verifyCsrfToken
(client, redir, scopes) <- do
result <- runInputGetResult form
case result of
FormMissing -> err "Input missing"
FormFailure ts -> err $ "Validation error: " <> T.intercalate "; " ts
FormSuccess r -> return r
code <- liftHandler $ runDB $ do
mapp <- getBy $ UniqueApplication client
Entity appid app <-
case mapp of
Nothing -> err "Invalid client_id"
Just a -> return a
unless (redir == applicationRedirect app) $ err "redirect_uri mismatch"
appScopes <-
either err return =<<
parseScopes (unScopes $ applicationScopes app)
unless (all (`elem` appScopes) scopes) $ err "Invalid scope"
now <- liftIO getCurrentTime
randomCode <- liftIO getRandomCode
site <- getYesod
insert_ Code
{ codeCreated = now
, codeExpires = addUTCTime 300 now -- 5 minutes
, codeClient = appid
, codeCode = randomCode
, codeScopes = writeScopes scopes
, codeUser = renderAuthId site user
}
return randomCode
case redir of
RedirectURI u -> redirect $ show $ addCodeParam u code
RedirectDisplay -> liftHandler $ defaultLayout [whamlet|Your code is: #{code}|]
where
verifyCsrfToken = runFormPost $ renderDivs $ pure ()
form = (,,)
<$> ireq textField "client_id"
<*> ireq redirectField "redirect_uri"
<*> ireq scopeField "scope"
err :: MonadHandler m => Text -> m a
err t = sendResponseStatus badRequest400 $ pairs $ "error" .= t
addCodeParam u code =
let q = uriQuery u
prefix = if null q then '?' else '&'
param = "code=" ++ T.unpack code
q' = q ++ prefix : param
in u { uriQuery = q' }
data GrantType = GrantAuthCode | GrantClientCreds
data NewToken s = NewToken
{ newTokenClient :: Text
, newTokenSecret :: Text
, newTokenRedirect :: Redirect
, newTokenScope :: NonEmpty s
, newTokenCode :: Maybe Text
, newTokenGrantType :: GrantType
}
postTokenR
:: ( YesodAuthDvara site
, YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite backend
, PersistStoreWrite (BaseBackend backend)
, RenderMessage site FormMessage
)
=> SubHandler site Encoding
postTokenR = do
NewToken client secret redir scopes mcode grant <- do
result <- runInputPostResult form
case result of
FormMissing -> err "Input missing"
FormFailure ts -> err $ "Validation error: " <> T.intercalate "; " ts
FormSuccess nt -> return nt
case (mcode, grant) of
(Nothing, GrantAuthCode) -> err "Grant and code mismatch"
(Just _, GrantClientCreds) -> err "Grant and code mismatch"
_ -> return ()
(token, time) <- liftHandler $ runDB $ do
mapp <- getBy $ UniqueApplication client
Entity appid app <-
case mapp of
Nothing -> authError
Just a -> return a
unless (secret == applicationSecret app) authError
unless (redir == applicationRedirect app) $ err "redirect_uri mismatch"
appScopes <-
either err return =<<
parseScopes (unScopes $ applicationScopes app)
unless (all (`elem` appScopes) scopes) $ err "Invalid scope"
now <- liftIO getCurrentTime
muser <- for mcode $ \ code -> do
mc <- getBy $ UniqueCode appid code
Entity cid (Code _ expires _ _ (Scopes scopes') user) <-
case mc of
Nothing -> authError
Just c -> return c
unless (expires < now) authError
codeScopes <- either err return =<< parseScopes scopes'
unless (all (`elem` codeScopes) scopes) $ err "Invalid scope"
delete cid
return user
t <- liftIO getRandomCode
insert_ Token
{ tokenCreated = now
, tokenClient = appid
, tokenToken = t
, tokenScopes = writeScopes scopes
, tokenUser = muser
}
return (t, now)
return $ pairs
( "access_token" .= token
<> "token_type" .= ("Bearer" :: Text)
<> "scope" .= writeScopes scopes
<> "created_at" .= (floor (utcTimeToPOSIXSeconds time) :: Int64)
)
where
form = NewToken
<$> ireq textField "client_id"
<*> ireq textField "client_secret"
<*> ireq redirectField "redirect_uri"
<*> ioptDef scopeField "scope" defaultScopes
<*> iopt textField "code"
<*> ireq grantField "grant_type"
where
grantField = checkMMap (pure . toGrant) fromGrant textField
where
toGrant :: Text -> Either Text GrantType
toGrant "authorization_code" = Right GrantAuthCode
toGrant "client_credentials" = Right GrantClientCreds
toGrant _ = Left "Unrecognized grant type"
fromGrant GrantAuthCode = "authorization_code"
fromGrant GrantClientCreds = "client_credentials"
err :: MonadHandler m => Text -> m a
err t = sendResponseStatus badRequest400 $ pairs $ "error" .= t
authError =
sendResponseStatus unauthorized401 $ pairs $
"error" .= ("Client authentication failed" :: Text)
data Revocation = Revocation
{ revocClient :: Text
, revocSecret :: Text
, revocToken :: Text
}
postRevokeR
:: ( YesodPersist site
, YesodPersistBackend site ~ backend
, PersistUniqueRead backend
, PersistStoreWrite backend
, PersistStoreWrite (BaseBackend backend)
, RenderMessage site FormMessage
)
=> SubHandler site Encoding
postRevokeR = do
Revocation client secret token <- do
result <- runInputPostResult form
case result of
FormMissing -> err "Input missing"
FormFailure ts -> err $ "Validation error: " <> T.intercalate "; " ts
FormSuccess r -> return r
liftHandler $ runDB $ do
mapp <- getBy $ UniqueApplication client
Entity appid app <-
case mapp of
Nothing -> err "Client authentication failed"
Just a -> return a
unless (secret == applicationSecret app) $ err "Client authentication failed"
mtok <- getBy $ UniqueToken token
Entity tokid tok <-
case mtok of
Nothing -> err "Not authorized to revoke this token"
Just t -> return t
unless (appid == tokenClient tok) $ err "Not authorized to revoke this token"
delete tokid
return $ pairs mempty
where
form = Revocation
<$> ireq textField "client_id"
<*> ireq textField "client_secret"
<*> ireq textField "token"
err :: MonadHandler m => Text -> m a
err t = sendResponseStatus forbidden403 $ pairs $ "error" .= t
|