/usr/share/doc/libghc-servant-server-doc/html/src/Servant-Server-Experimental-Auth.html is in libghc-servant-server-doc 0.8.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>src/Servant/Server/Experimental/Auth.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# OPTIONS_GHC -fno-warn-orphans #-}</span>
<a name="line-2"></a><span class='hs-comment'>{-# LANGUAGE DeriveGeneric #-}</span>
<a name="line-3"></a><span class='hs-comment'>{-# LANGUAGE DeriveDataTypeable #-}</span>
<a name="line-4"></a><span class='hs-comment'>{-# LANGUAGE FlexibleContexts #-}</span>
<a name="line-5"></a><span class='hs-comment'>{-# LANGUAGE FlexibleInstances #-}</span>
<a name="line-6"></a><span class='hs-comment'>{-# LANGUAGE MultiParamTypeClasses #-}</span>
<a name="line-7"></a><span class='hs-comment'>{-# LANGUAGE PolyKinds #-}</span>
<a name="line-8"></a><span class='hs-comment'>{-# LANGUAGE ScopedTypeVariables #-}</span>
<a name="line-9"></a><span class='hs-comment'>{-# LANGUAGE TypeFamilies #-}</span>
<a name="line-10"></a><span class='hs-comment'>{-# LANGUAGE TypeOperators #-}</span>
<a name="line-11"></a><span class='hs-comment'>{-# LANGUAGE UndecidableInstances #-}</span>
<a name="line-12"></a>
<a name="line-13"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Servant</span><span class='hs-varop'>.</span><span class='hs-conid'>Server</span><span class='hs-varop'>.</span><span class='hs-conid'>Experimental</span><span class='hs-varop'>.</span><span class='hs-conid'>Auth</span> <span class='hs-keyword'>where</span>
<a name="line-14"></a>
<a name="line-15"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Trans</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftIO</span><span class='hs-layout'>)</span>
<a name="line-16"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span><span class='hs-varop'>.</span><span class='hs-conid'>Trans</span><span class='hs-varop'>.</span><span class='hs-conid'>Except</span> <span class='hs-layout'>(</span><span class='hs-varid'>runExceptT</span><span class='hs-layout'>)</span>
<a name="line-17"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Proxy</span> <span class='hs-layout'>(</span><span class='hs-conid'>Proxy</span> <span class='hs-layout'>(</span><span class='hs-conid'>Proxy</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-18"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-19"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>GHC</span><span class='hs-varop'>.</span><span class='hs-conid'>Generics</span> <span class='hs-layout'>(</span><span class='hs-conid'>Generic</span><span class='hs-layout'>)</span>
<a name="line-20"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Network</span><span class='hs-varop'>.</span><span class='hs-conid'>Wai</span> <span class='hs-layout'>(</span><span class='hs-conid'>Request</span><span class='hs-layout'>)</span>
<a name="line-21"></a>
<a name="line-22"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Servant</span> <span class='hs-layout'>(</span><span class='hs-layout'>(</span><span class='hs-conop'>:></span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-23"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Servant</span><span class='hs-varop'>.</span><span class='hs-conid'>API</span><span class='hs-varop'>.</span><span class='hs-conid'>Experimental</span><span class='hs-varop'>.</span><span class='hs-conid'>Auth</span>
<a name="line-24"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Servant</span><span class='hs-varop'>.</span><span class='hs-conid'>Server</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <span class='hs-layout'>(</span><span class='hs-conid'>HasContextEntry</span><span class='hs-layout'>,</span>
<a name="line-25"></a> <span class='hs-conid'>HasServer</span><span class='hs-layout'>,</span> <span class='hs-conid'>ServerT</span><span class='hs-layout'>,</span>
<a name="line-26"></a> <span class='hs-varid'>getContextEntry</span><span class='hs-layout'>,</span>
<a name="line-27"></a> <span class='hs-varid'>route</span><span class='hs-layout'>)</span>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Servant</span><span class='hs-varop'>.</span><span class='hs-conid'>Server</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span><span class='hs-varop'>.</span><span class='hs-conid'>RoutingApplication</span> <span class='hs-layout'>(</span><span class='hs-varid'>addAuthCheck</span><span class='hs-layout'>,</span>
<a name="line-29"></a> <span class='hs-varid'>delayedFailFatal</span><span class='hs-layout'>,</span>
<a name="line-30"></a> <span class='hs-conid'>DelayedIO</span><span class='hs-layout'>,</span>
<a name="line-31"></a> <span class='hs-varid'>withRequest</span><span class='hs-layout'>)</span>
<a name="line-32"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Servant</span><span class='hs-varop'>.</span><span class='hs-conid'>Server</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span><span class='hs-varop'>.</span><span class='hs-conid'>ServantErr</span> <span class='hs-layout'>(</span><span class='hs-conid'>Handler</span><span class='hs-layout'>)</span>
<a name="line-33"></a>
<a name="line-34"></a><span class='hs-comment'>-- * General Auth</span>
<a name="line-35"></a>
<a name="line-36"></a><a name="AuthServerData"></a><span class='hs-comment'>-- | Specify the type of data returned after we've authenticated a request.</span>
<a name="line-37"></a><a name="AuthServerData"></a><span class='hs-comment'>-- quite often this is some `User` datatype.</span>
<a name="line-38"></a><a name="AuthServerData"></a><span class='hs-comment'>--</span>
<a name="line-39"></a><a name="AuthServerData"></a><span class='hs-comment'>-- NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE</span>
<a name="line-40"></a><a name="AuthServerData"></a><span class='hs-keyword'>type</span> <span class='hs-keyword'>family</span> <span class='hs-conid'>AuthServerData</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>::</span> <span class='hs-varop'>*</span>
<a name="line-41"></a>
<a name="line-42"></a><a name="AuthHandler"></a><span class='hs-comment'>-- | Handlers for AuthProtected resources</span>
<a name="line-43"></a><a name="AuthHandler"></a><span class='hs-comment'>--</span>
<a name="line-44"></a><a name="AuthHandler"></a><span class='hs-comment'>-- NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE</span>
<a name="line-45"></a><a name="AuthHandler"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>AuthHandler</span> <span class='hs-varid'>r</span> <span class='hs-varid'>usr</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>AuthHandler</span>
<a name="line-46"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>unAuthHandler</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handler</span> <span class='hs-varid'>usr</span> <span class='hs-layout'>}</span>
<a name="line-47"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Generic</span><span class='hs-layout'>,</span> <span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-48"></a>
<a name="line-49"></a><a name="mkAuthHandler"></a><span class='hs-comment'>-- | NOTE: THIS API IS EXPERIMENTAL AND SUBJECT TO CHANGE</span>
<a name="line-50"></a><span class='hs-definition'>mkAuthHandler</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handler</span> <span class='hs-varid'>usr</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>AuthHandler</span> <span class='hs-varid'>r</span> <span class='hs-varid'>usr</span>
<a name="line-51"></a><span class='hs-definition'>mkAuthHandler</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>AuthHandler</span>
<a name="line-52"></a>
<a name="line-53"></a><a name="instance%20HasServer%20(AuthProtect%20tag%20:%3e%20api)%20context"></a><span class='hs-comment'>-- | Known orphan instance.</span>
<a name="line-54"></a><a name="instance%20HasServer%20(AuthProtect%20tag%20:%3e%20api)%20context"></a><span class='hs-keyword'>instance</span> <span class='hs-layout'>(</span> <span class='hs-conid'>HasServer</span> <span class='hs-varid'>api</span> <span class='hs-varid'>context</span>
<a name="line-55"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>HasContextEntry</span> <span class='hs-varid'>context</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthHandler</span> <span class='hs-conid'>Request</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthServerData</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthProtect</span> <span class='hs-varid'>tag</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-56"></a> <span class='hs-layout'>)</span>
<a name="line-57"></a> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>HasServer</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthProtect</span> <span class='hs-varid'>tag</span> <span class='hs-conop'>:></span> <span class='hs-varid'>api</span><span class='hs-layout'>)</span> <span class='hs-varid'>context</span> <span class='hs-keyword'>where</span>
<a name="line-58"></a>
<a name="line-59"></a> <span class='hs-keyword'>type</span> <span class='hs-conid'>ServerT</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthProtect</span> <span class='hs-varid'>tag</span> <span class='hs-conop'>:></span> <span class='hs-varid'>api</span><span class='hs-layout'>)</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span>
<a name="line-60"></a> <span class='hs-conid'>AuthServerData</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthProtect</span> <span class='hs-varid'>tag</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ServerT</span> <span class='hs-varid'>api</span> <span class='hs-varid'>m</span>
<a name="line-61"></a>
<a name="line-62"></a> <span class='hs-varid'>route</span> <span class='hs-conid'>Proxy</span> <span class='hs-varid'>context</span> <span class='hs-varid'>subserver</span> <span class='hs-keyglyph'>=</span>
<a name="line-63"></a> <span class='hs-varid'>route</span> <span class='hs-layout'>(</span><span class='hs-conid'>Proxy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Proxy</span> <span class='hs-varid'>api</span><span class='hs-layout'>)</span> <span class='hs-varid'>context</span> <span class='hs-layout'>(</span><span class='hs-varid'>subserver</span> <span class='hs-varop'>`addAuthCheck`</span> <span class='hs-varid'>withRequest</span> <span class='hs-varid'>authCheck</span><span class='hs-layout'>)</span>
<a name="line-64"></a> <span class='hs-keyword'>where</span>
<a name="line-65"></a> <span class='hs-varid'>authHandler</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Request</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Handler</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthServerData</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthProtect</span> <span class='hs-varid'>tag</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-66"></a> <span class='hs-varid'>authHandler</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unAuthHandler</span> <span class='hs-layout'>(</span><span class='hs-varid'>getContextEntry</span> <span class='hs-varid'>context</span><span class='hs-layout'>)</span>
<a name="line-67"></a> <span class='hs-varid'>authCheck</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Request</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>DelayedIO</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthServerData</span> <span class='hs-layout'>(</span><span class='hs-conid'>AuthProtect</span> <span class='hs-varid'>tag</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-68"></a> <span class='hs-varid'>authCheck</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>>>=</span> <span class='hs-varid'>either</span> <span class='hs-varid'>delayedFailFatal</span> <span class='hs-varid'>return</span><span class='hs-layout'>)</span> <span class='hs-varop'>.</span> <span class='hs-varid'>liftIO</span> <span class='hs-varop'>.</span> <span class='hs-varid'>runExceptT</span> <span class='hs-varop'>.</span> <span class='hs-varid'>authHandler</span>
</pre></body>
</html>
|