Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Auth.Types

Synopsis

data AuthEvalError
- = AuthError Text
- | AuthenticationFailed AuthEvalError
- | DatabaseFailure AuthEvalError
- | AuthFileNotFound AuthEvalError
- | AuthToAuthorizedUser AuthEvalError
- | AuthWWWBrowserError AuthEvalError
- | GoogleAuthCodeError AuthEvalError
- | NoClientInfo AuthEvalError
- | UnsupportedBackend AuthEvalError
- | NoNapkinGeneratedAuthFile AuthEvalError
- | NotSupported AuthEvalError
- | OSCommandError AuthEvalError
- | ParseCredentialsError AuthEvalError
- | UserProvidedAuthFileNotFound AuthEvalError
- | SpecRelatedError AuthEvalError
data OAuth2 = OAuth2 {
- clientId :: Text
- clientSecret :: Text
}
type CallbackPort = Int
newtype OAuth2CacheIndex = OAuth2CacheIndex {
- unIndex :: Text
}
newtype SpecFile = SpecFile {
- unSpecFile :: FilePath
}
newtype DbUri = DbUri {
- unUri :: Text
}
newtype CredentialsJson = CredentialsJson {
- unCredentials :: ByteString
}
data OAuth2CorrelatedKey = OAuth2CorrelatedKey {
- specFile :: SpecFile
- dbUri :: DbUri
- appName :: AppName
}
data OAuth2Context = OAuth2Context {
- dbPath :: FilePath
- callbackPort :: CallbackPort
- specFile :: SpecFile
- correlatedKey :: OAuth2CorrelatedKey
}
data NapkinOAuth2 = NapkinOAuth2 {
- oAuth2 :: OAuth2
- context :: OAuth2Context
}
data NapkinOAuth2Request
- = ResetOAuth2Credentials OAuth2Context
- | DisplayOAuth2Credentials OAuth2Context
- | CreateOAuth2Credentials OAuth2Context
- | RetrieveOAuth2Credentials OAuth2Context
newtype FromUser = FromUser FilePath
data OAuth2NapkinAuthApi a
class ManySymbolVal (xs :: [Symbol]) where
- manySymbolVal :: proxy xs -> [String]
type CodeChallenge = Text
type CodeVerifier = Text
type OAuth2Code = Text
type EncodingMethod = Text
type GrantType = Text
type URIQueryParams = [(ByteString, ByteString)]
type BigQueryScopes = '["https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/devstorage.full_control", "https://www.googleapis.com/auth/devstorage.read_only", "https://www.googleapis.com/auth/devstorage.read_write"]
type OAuth2Scopes = '["openid", "https://www.googleapis.com/auth/userinfo.email", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/appengine.admin", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/accounts.reauth"]
type CredentialDir = FilePath
data OAuth2Conf = OAuth2Conf {
- napkinOAuth2 :: NapkinOAuth2
- scope :: Proxy OAuth2Scopes
- requestUri :: Text
- accessTokenRequest :: Text
- encodingAlgorithm :: EncodingMethod
- grantType :: GrantType
}
data OAuth2RunTime = OAuth2RunTime {
- codeVerifier :: ByteString
- codeChallenge :: ByteString
- callbackUrl :: Text
}
data OAuth2Token = OAuth2Token {
- accessToken :: Text
- expiresIn :: Int
- refreshToken :: Text
- scope :: Text
- tokenType :: Text
- idToken :: Text
}
type O2CodeStore = MVar (Either AuthEvalError OAuth2Code)
data OAuth2Env = OAuth2Env {
- conf :: OAuth2Conf
- runTime :: OAuth2RunTime
- codeStore :: O2CodeStore
}
getOAuthDbPath :: OAuth2Env -> FilePath
getCorrelatedKey :: OAuth2Env -> OAuth2CorrelatedKey
getOAuthPort :: OAuth2Env -> Int
data GCredentials = GCredentials {
- clientId :: Text
- clientSecret :: Text
- refreshToken :: Text
- _type :: Text
}

Documentation

data AuthEvalError #

Auth related Errors

Instances

Instances details

Exception AuthEvalError #
Instance details Defined in Napkin.Auth.Types Methods toException :: AuthEvalError -> SomeException # fromException :: SomeException -> Maybe AuthEvalError # displayException :: AuthEvalError -> String #
Generic AuthEvalError #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep AuthEvalError :: Type -> Type # Methods from :: AuthEvalError -> Rep AuthEvalError x # to :: Rep AuthEvalError x -> AuthEvalError #
Show AuthEvalError #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> AuthEvalError -> ShowS # show :: AuthEvalError -> String # showList :: [AuthEvalError] -> ShowS #
Eq AuthEvalError #
Instance details Defined in Napkin.Auth.Types Methods (==) :: AuthEvalError -> AuthEvalError -> Bool # (/=) :: AuthEvalError -> AuthEvalError -> Bool #
ToLText AuthEvalError #
Instance details Defined in Napkin.Auth.Types Methods toLText :: AuthEvalError -> LText #
ToText AuthEvalError #
Instance details Defined in Napkin.Auth.Types Methods toText :: AuthEvalError -> Text #
type Rep AuthEvalError #
Instance details Defined in Napkin.Auth.Types type Rep AuthEvalError = D1 ('MetaData "AuthEvalError" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (((C1 ('MetaCons "AuthError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "AuthenticationFailed" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)) :+: C1 ('MetaCons "DatabaseFailure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)))) :+: ((C1 ('MetaCons "AuthFileNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)) :+: C1 ('MetaCons "AuthToAuthorizedUser" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError))) :+: (C1 ('MetaCons "AuthWWWBrowserError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)) :+: C1 ('MetaCons "GoogleAuthCodeError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError))))) :+: (((C1 ('MetaCons "NoClientInfo" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)) :+: C1 ('MetaCons "UnsupportedBackend" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError))) :+: (C1 ('MetaCons "NoNapkinGeneratedAuthFile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)) :+: C1 ('MetaCons "NotSupported" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)))) :+: ((C1 ('MetaCons "OSCommandError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)) :+: C1 ('MetaCons "ParseCredentialsError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError))) :+: (C1 ('MetaCons "UserProvidedAuthFileNotFound" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError)) :+: C1 ('MetaCons "SpecRelatedError" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AuthEvalError))))))

data OAuth2 #

Constructors

OAuth2
Fields clientId :: Text clientSecret :: Text

Instances

Instances details

Generic OAuth2 #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep OAuth2 :: Type -> Type # Methods from :: OAuth2 -> Rep OAuth2 x # to :: Rep OAuth2 x -> OAuth2 #
Show OAuth2 #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> OAuth2 -> ShowS # show :: OAuth2 -> String # showList :: [OAuth2] -> ShowS #
Eq OAuth2 #
Instance details Defined in Napkin.Auth.Types Methods (==) :: OAuth2 -> OAuth2 -> Bool # (/=) :: OAuth2 -> OAuth2 -> Bool #
type Rep OAuth2 #
Instance details Defined in Napkin.Auth.Types type Rep OAuth2 = D1 ('MetaData "OAuth2" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "OAuth2" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "clientSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

type CallbackPort = Int #

newtype OAuth2CacheIndex #

Constructors

OAuth2CacheIndex
Fields unIndex :: Text

Instances

Instances details

Generic OAuth2CacheIndex #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep OAuth2CacheIndex :: Type -> Type # Methods from :: OAuth2CacheIndex -> Rep OAuth2CacheIndex x # to :: Rep OAuth2CacheIndex x -> OAuth2CacheIndex #
Show OAuth2CacheIndex #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> OAuth2CacheIndex -> ShowS # show :: OAuth2CacheIndex -> String # showList :: [OAuth2CacheIndex] -> ShowS #
Eq OAuth2CacheIndex #
Instance details Defined in Napkin.Auth.Types Methods (==) :: OAuth2CacheIndex -> OAuth2CacheIndex -> Bool # (/=) :: OAuth2CacheIndex -> OAuth2CacheIndex -> Bool #
type Rep OAuth2CacheIndex #
Instance details Defined in Napkin.Auth.Types type Rep OAuth2CacheIndex = D1 ('MetaData "OAuth2CacheIndex" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'True) (C1 ('MetaCons "OAuth2CacheIndex" 'PrefixI 'True) (S1 ('MetaSel ('Just "unIndex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype SpecFile #

Constructors

SpecFile
Fields unSpecFile :: FilePath

Instances

Instances details

Semigroup SpecFile #
Instance details Defined in Napkin.Auth.Types Methods (<>) :: SpecFile -> SpecFile -> SpecFile # sconcat :: NonEmpty SpecFile -> SpecFile # stimes :: Integral b => b -> SpecFile -> SpecFile #
Generic SpecFile #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep SpecFile :: Type -> Type # Methods from :: SpecFile -> Rep SpecFile x # to :: Rep SpecFile x -> SpecFile #
Show SpecFile #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> SpecFile -> ShowS # show :: SpecFile -> String # showList :: [SpecFile] -> ShowS #
Eq SpecFile #
Instance details Defined in Napkin.Auth.Types Methods (==) :: SpecFile -> SpecFile -> Bool # (/=) :: SpecFile -> SpecFile -> Bool #
type Rep SpecFile #
Instance details Defined in Napkin.Auth.Types type Rep SpecFile = D1 ('MetaData "SpecFile" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'True) (C1 ('MetaCons "SpecFile" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSpecFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath)))

newtype DbUri #

Constructors

DbUri
Fields unUri :: Text

Instances

Instances details

Generic DbUri #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep DbUri :: Type -> Type # Methods from :: DbUri -> Rep DbUri x # to :: Rep DbUri x -> DbUri #
Show DbUri #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> DbUri -> ShowS # show :: DbUri -> String # showList :: [DbUri] -> ShowS #
Eq DbUri #
Instance details Defined in Napkin.Auth.Types Methods (==) :: DbUri -> DbUri -> Bool # (/=) :: DbUri -> DbUri -> Bool #
type Rep DbUri #
Instance details Defined in Napkin.Auth.Types type Rep DbUri = D1 ('MetaData "DbUri" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'True) (C1 ('MetaCons "DbUri" 'PrefixI 'True) (S1 ('MetaSel ('Just "unUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype CredentialsJson #

Constructors

CredentialsJson
Fields unCredentials :: ByteString

data OAuth2CorrelatedKey #

Constructors

OAuth2CorrelatedKey
Fields specFile :: SpecFile dbUri :: DbUri appName :: AppName

Instances

Instances details

Generic OAuth2CorrelatedKey #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep OAuth2CorrelatedKey :: Type -> Type # Methods from :: OAuth2CorrelatedKey -> Rep OAuth2CorrelatedKey x # to :: Rep OAuth2CorrelatedKey x -> OAuth2CorrelatedKey #
Show OAuth2CorrelatedKey #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> OAuth2CorrelatedKey -> ShowS # show :: OAuth2CorrelatedKey -> String # showList :: [OAuth2CorrelatedKey] -> ShowS #
Eq OAuth2CorrelatedKey #
Instance details Defined in Napkin.Auth.Types Methods (==) :: OAuth2CorrelatedKey -> OAuth2CorrelatedKey -> Bool # (/=) :: OAuth2CorrelatedKey -> OAuth2CorrelatedKey -> Bool #
CacheIndex OAuth2CorrelatedKey #
Instance details Defined in Napkin.Auth.CacheHandler Methods cacheIndex :: OAuth2CorrelatedKey -> OAuth2CacheIndex #
type Rep OAuth2CorrelatedKey #
Instance details Defined in Napkin.Auth.Types type Rep OAuth2CorrelatedKey = D1 ('MetaData "OAuth2CorrelatedKey" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "OAuth2CorrelatedKey" 'PrefixI 'True) (S1 ('MetaSel ('Just "specFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpecFile) :: (S1 ('MetaSel ('Just "dbUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DbUri) :: S1 ('MetaSel ('Just "appName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AppName))))

data OAuth2Context #

Constructors

OAuth2Context
Fields dbPath :: FilePath napkin generated oAuth credentials filepath callbackPort :: CallbackPort napkin oAuth http route to handle google oAuth server callback specFile :: SpecFile correlatedKey :: OAuth2CorrelatedKey

Instances

Instances details

Generic OAuth2Context #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep OAuth2Context :: Type -> Type # Methods from :: OAuth2Context -> Rep OAuth2Context x # to :: Rep OAuth2Context x -> OAuth2Context #
Show OAuth2Context #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> OAuth2Context -> ShowS # show :: OAuth2Context -> String # showList :: [OAuth2Context] -> ShowS #
Eq OAuth2Context #
Instance details Defined in Napkin.Auth.Types Methods (==) :: OAuth2Context -> OAuth2Context -> Bool # (/=) :: OAuth2Context -> OAuth2Context -> Bool #
type Rep OAuth2Context #
Instance details Defined in Napkin.Auth.Types type Rep OAuth2Context = D1 ('MetaData "OAuth2Context" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "OAuth2Context" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 FilePath) :: S1 ('MetaSel ('Just "callbackPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CallbackPort)) :: (S1 ('MetaSel ('Just "specFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 SpecFile) :*: S1 ('MetaSel ('Just "correlatedKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OAuth2CorrelatedKey))))

data NapkinOAuth2 #

Constructors

NapkinOAuth2
Fields oAuth2 :: OAuth2 context :: OAuth2Context

Instances

Instances details

Generic NapkinOAuth2 #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep NapkinOAuth2 :: Type -> Type # Methods from :: NapkinOAuth2 -> Rep NapkinOAuth2 x # to :: Rep NapkinOAuth2 x -> NapkinOAuth2 #
Show NapkinOAuth2 #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> NapkinOAuth2 -> ShowS # show :: NapkinOAuth2 -> String # showList :: [NapkinOAuth2] -> ShowS #
Eq NapkinOAuth2 #
Instance details Defined in Napkin.Auth.Types Methods (==) :: NapkinOAuth2 -> NapkinOAuth2 -> Bool # (/=) :: NapkinOAuth2 -> NapkinOAuth2 -> Bool #
type Rep NapkinOAuth2 #
Instance details Defined in Napkin.Auth.Types type Rep NapkinOAuth2 = D1 ('MetaData "NapkinOAuth2" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "NapkinOAuth2" 'PrefixI 'True) (S1 ('MetaSel ('Just "oAuth2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OAuth2) :*: S1 ('MetaSel ('Just "context") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OAuth2Context)))

data NapkinOAuth2Request #

transforms Auth CLI to Auth Request

Constructors

ResetOAuth2Credentials OAuth2Context
DisplayOAuth2Credentials OAuth2Context
CreateOAuth2Credentials OAuth2Context
RetrieveOAuth2Credentials OAuth2Context

Instances

Instances details

Show NapkinOAuth2Request #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> NapkinOAuth2Request -> ShowS # show :: NapkinOAuth2Request -> String # showList :: [NapkinOAuth2Request] -> ShowS #
Eq NapkinOAuth2Request #
Instance details Defined in Napkin.Auth.Types Methods (==) :: NapkinOAuth2Request -> NapkinOAuth2Request -> Bool # (/=) :: NapkinOAuth2Request -> NapkinOAuth2Request -> Bool #

newtype FromUser #

Constructors

FromUser FilePath

Instances

Instances details

Show FromUser #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> FromUser -> ShowS # show :: FromUser -> String # showList :: [FromUser] -> ShowS #
Eq FromUser #
Instance details Defined in Napkin.Auth.Types Methods (==) :: FromUser -> FromUser -> Bool # (/=) :: FromUser -> FromUser -> Bool #

data OAuth2NapkinAuthApi a #

class ManySymbolVal (xs :: [Symbol]) where #

Methods

manySymbolVal :: proxy xs -> [String] #

Instances

Instances details

ManySymbolVal ('[] :: [Symbol]) #
Instance details Defined in Napkin.Auth.Types Methods manySymbolVal :: proxy '[] -> [String] #
(KnownSymbol a, ManySymbolVal as) => ManySymbolVal (a ': as) #
Instance details Defined in Napkin.Auth.Types Methods manySymbolVal :: proxy (a ': as) -> [String] #

type CodeChallenge = Text #

type CodeVerifier = Text #

type OAuth2Code = Text #

type EncodingMethod = Text #

type GrantType = Text #

type URIQueryParams = [(ByteString, ByteString)] #

OAuth2 and bigquery related scopes. for additional detail see: https://developers.google.com/identity/protocols/oauth2/scopes

type BigQueryScopes = '["https://www.googleapis.com/auth/bigquery", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/devstorage.full_control", "https://www.googleapis.com/auth/devstorage.read_only", "https://www.googleapis.com/auth/devstorage.read_write"] #

type OAuth2Scopes = '["openid", "https://www.googleapis.com/auth/userinfo.email", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/appengine.admin", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/accounts.reauth"] #

type CredentialDir = FilePath #

Directory path to napkin credential path

data OAuth2Conf #

Constructors

OAuth2Conf
Fields napkinOAuth2 :: NapkinOAuth2 scope :: Proxy OAuth2Scopes requestUri :: Text accessTokenRequest :: Text encodingAlgorithm :: EncodingMethod grantType :: GrantType

Instances

Instances details

Generic OAuth2Conf #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep OAuth2Conf :: Type -> Type # Methods from :: OAuth2Conf -> Rep OAuth2Conf x # to :: Rep OAuth2Conf x -> OAuth2Conf #
Show OAuth2Conf #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> OAuth2Conf -> ShowS # show :: OAuth2Conf -> String # showList :: [OAuth2Conf] -> ShowS #
Eq OAuth2Conf #
Instance details Defined in Napkin.Auth.Types Methods (==) :: OAuth2Conf -> OAuth2Conf -> Bool # (/=) :: OAuth2Conf -> OAuth2Conf -> Bool #
type Rep OAuth2Conf #
Instance details Defined in Napkin.Auth.Types type Rep OAuth2Conf = D1 ('MetaData "OAuth2Conf" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "OAuth2Conf" 'PrefixI 'True) ((S1 ('MetaSel ('Just "napkinOAuth2") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 NapkinOAuth2) :: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Proxy OAuth2Scopes)) :: S1 ('MetaSel ('Just "requestUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: (S1 ('MetaSel ('Just "accessTokenRequest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "encodingAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 EncodingMethod) :*: S1 ('MetaSel ('Just "grantType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 GrantType)))))

data OAuth2RunTime #

Constructors

OAuth2RunTime
Fields codeVerifier :: ByteString codeChallenge :: ByteString callbackUrl :: Text

Instances

Instances details

Generic OAuth2RunTime #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep OAuth2RunTime :: Type -> Type # Methods from :: OAuth2RunTime -> Rep OAuth2RunTime x # to :: Rep OAuth2RunTime x -> OAuth2RunTime #
Eq OAuth2RunTime #
Instance details Defined in Napkin.Auth.Types Methods (==) :: OAuth2RunTime -> OAuth2RunTime -> Bool # (/=) :: OAuth2RunTime -> OAuth2RunTime -> Bool #
type Rep OAuth2RunTime #
Instance details Defined in Napkin.Auth.Types type Rep OAuth2RunTime = D1 ('MetaData "OAuth2RunTime" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "OAuth2RunTime" 'PrefixI 'True) (S1 ('MetaSel ('Just "codeVerifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :: (S1 ('MetaSel ('Just "codeChallenge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ByteString) :: S1 ('MetaSel ('Just "callbackUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

data OAuth2Token #

Constructors

OAuth2Token
Fields accessToken :: Text expiresIn :: Int refreshToken :: Text scope :: Text tokenType :: Text idToken :: Text

Instances

Instances details

FromJSON OAuth2Token #
Instance details Defined in Napkin.Auth.Types Methods parseJSON :: Value -> Parser OAuth2Token # parseJSONList :: Value -> Parser [OAuth2Token] #
ToJSON OAuth2Token #
Instance details Defined in Napkin.Auth.Types Methods toJSON :: OAuth2Token -> Value # toEncoding :: OAuth2Token -> Encoding # toJSONList :: [OAuth2Token] -> Value # toEncodingList :: [OAuth2Token] -> Encoding #
Generic OAuth2Token #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep OAuth2Token :: Type -> Type # Methods from :: OAuth2Token -> Rep OAuth2Token x # to :: Rep OAuth2Token x -> OAuth2Token #
Show OAuth2Token #
Instance details Defined in Napkin.Auth.Types Methods showsPrec :: Int -> OAuth2Token -> ShowS # show :: OAuth2Token -> String # showList :: [OAuth2Token] -> ShowS #
Eq OAuth2Token #
Instance details Defined in Napkin.Auth.Types Methods (==) :: OAuth2Token -> OAuth2Token -> Bool # (/=) :: OAuth2Token -> OAuth2Token -> Bool #
type Rep OAuth2Token #
Instance details Defined in Napkin.Auth.Types type Rep OAuth2Token = D1 ('MetaData "OAuth2Token" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "OAuth2Token" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accessToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "expiresIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :: S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :: (S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: (S1 ('MetaSel ('Just "tokenType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "idToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))

type O2CodeStore = MVar (Either AuthEvalError OAuth2Code) #

data OAuth2Env #

Constructors

OAuth2Env
Fields conf :: OAuth2Conf runTime :: OAuth2RunTime codeStore :: O2CodeStore

Instances

Instances details

Generic OAuth2Env #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep OAuth2Env :: Type -> Type # Methods from :: OAuth2Env -> Rep OAuth2Env x # to :: Rep OAuth2Env x -> OAuth2Env #
type Rep OAuth2Env #
Instance details Defined in Napkin.Auth.Types type Rep OAuth2Env = D1 ('MetaData "OAuth2Env" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "OAuth2Env" 'PrefixI 'True) (S1 ('MetaSel ('Just "conf") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OAuth2Conf) :: (S1 ('MetaSel ('Just "runTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OAuth2RunTime) :: S1 ('MetaSel ('Just "codeStore") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 O2CodeStore))))

getOAuthDbPath :: OAuth2Env -> FilePath #

getOAuthPort :: OAuth2Env -> Int #

data GCredentials #

Constructors

GCredentials
Fields clientId :: Text clientSecret :: Text refreshToken :: Text _type :: Text

Instances

Instances details

FromJSON GCredentials #
Instance details Defined in Napkin.Auth.Types Methods parseJSON :: Value -> Parser GCredentials # parseJSONList :: Value -> Parser [GCredentials] #
ToJSON GCredentials #
Instance details Defined in Napkin.Auth.Types Methods toJSON :: GCredentials -> Value # toEncoding :: GCredentials -> Encoding # toJSONList :: [GCredentials] -> Value # toEncodingList :: [GCredentials] -> Encoding #
Generic GCredentials #
Instance details Defined in Napkin.Auth.Types Associated Types type Rep GCredentials :: Type -> Type # Methods from :: GCredentials -> Rep GCredentials x # to :: Rep GCredentials x -> GCredentials #
type Rep GCredentials #
Instance details Defined in Napkin.Auth.Types type Rep GCredentials = D1 ('MetaData "GCredentials" "Napkin.Auth.Types" "napkin-1.0.0-B79azc00rn1K8mj00hwhwG" 'False) (C1 ('MetaCons "GCredentials" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :: S1 ('MetaSel ('Just "clientSecret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :: (S1 ('MetaSel ('Just "refreshToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "_type") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))

AuthError Text
AuthenticationFailed AuthEvalError
DatabaseFailure AuthEvalError
AuthFileNotFound AuthEvalError
AuthToAuthorizedUser AuthEvalError
AuthWWWBrowserError AuthEvalError
GoogleAuthCodeError AuthEvalError
NoClientInfo AuthEvalError
UnsupportedBackend AuthEvalError
NoNapkinGeneratedAuthFile AuthEvalError
NotSupported AuthEvalError
OSCommandError AuthEvalError
ParseCredentialsError AuthEvalError
UserProvidedAuthFileNotFound AuthEvalError
SpecRelatedError AuthEvalError