Copyright	(c) Soostone Inc 2020
License	AllRightsReserved
Stability	experimental
Portability	POSIX
Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Auth.Types

Description

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 {
- _oAuth2ClientId :: Text
- _oAuth2ClientSecret :: Text
}
class HasClientId s a | s -> a where
- clientId :: Lens' s a
class HasClientSecret s a | s -> a where
- clientSecret :: Lens' s a
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 {
- _oAuth2CorrelatedKeySpecFile :: SpecFile
- _oAuth2CorrelatedKeyDbUri :: DbUri
- _oAuth2CorrelatedKeyAppName :: AppName
}
class HasAppName s a | s -> a where
- appName :: Lens' s a
class HasDbUri s a | s -> a where
- dbUri :: Lens' s a
class HasSpecFile s a | s -> a where
- specFile :: Lens' s a
data OAuth2Context = OAuth2Context {
- _oAuth2ContextOAuth2dbPath :: FilePath
- _oAuth2ContextCallbackPort :: CallbackPort
- _oAuth2ContextSpecFile :: SpecFile
- _oAuth2ContextOAuth2CorrelatedKey :: OAuth2CorrelatedKey
}
class HasCallbackPort s a | s -> a where
- callbackPort :: Lens' s a
class HasOAuth2CorrelatedKey s a | s -> a where
- oAuth2CorrelatedKey :: Lens' s a
class HasOAuth2dbPath s a | s -> a where
- oAuth2dbPath :: Lens' s a
data NapkinOAuth2 = NapkinOAuth2 {
- _napkinOAuth2OAuth2 :: OAuth2
- _napkinOAuth2OAuth2context :: OAuth2Context
}
class HasOAuth2 s a | s -> a where
- oAuth2 :: Lens' s a
class HasOAuth2context s a | s -> a where
- oAuth2context :: Lens' s a
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"]
authScopeType :: Proxy '["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 {
- _oAuth2ConfNapkinOAuth2 :: NapkinOAuth2
- _oAuth2ConfOAuth2scope :: Proxy '["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"]
- _oAuth2ConfOAuth2requestUri :: Text
- _oAuth2ConfOAuth2accessTokenRequest :: Text
- _oAuth2ConfOAuth2encodingAlgorithm :: EncodingMethod
- _oAuth2ConfOAuth2grantType :: GrantType
}
class HasNapkinOAuth2 s a | s -> a where
- napkinOAuth2 :: Lens' s a
class HasOAuth2accessTokenRequest s a | s -> a where
- oAuth2accessTokenRequest :: Lens' s a
class HasOAuth2encodingAlgorithm s a | s -> a where
- oAuth2encodingAlgorithm :: Lens' s a
class HasOAuth2grantType s a | s -> a where
- oAuth2grantType :: Lens' s a
class HasOAuth2requestUri s a | s -> a where
- oAuth2requestUri :: Lens' s a
class HasOAuth2scope s a | s -> a where
- oAuth2scope :: Lens' s a
data OAuth2RunTime = OAuth2RunTime {
- _oAuth2RunTimeOAuth2codeVerifier :: ByteString
- _oAuth2RunTimeOAuth2codeChallenge :: ByteString
- _oAuth2RunTimeOAuth2callbackUrl :: Text
}
class HasOAuth2callbackUrl s a | s -> a where
- oAuth2callbackUrl :: Lens' s a
class HasOAuth2codeChallenge s a | s -> a where
- oAuth2codeChallenge :: Lens' s a
class HasOAuth2codeVerifier s a | s -> a where
- oAuth2codeVerifier :: Lens' s a
data OAuth2Token = OAuth2Token {
- _oAuth2TokenAccessToken :: Text
- _oAuth2TokenExpiresIn :: Int
- _oAuth2TokenRefreshToken :: Text
- _oAuth2TokenScope :: Text
- _oAuth2TokenTokenType :: Text
- _oAuth2TokenIdToken :: Text
}
class HasAccessToken s a | s -> a where
- accessToken :: Lens' s a
class HasExpiresIn s a | s -> a where
- expiresIn :: Lens' s a
class HasIdToken s a | s -> a where
- idToken :: Lens' s a
class HasRefreshToken s a | s -> a where
- refreshToken :: Lens' s a
class HasScope s a | s -> a where
- scope :: Lens' s a
class HasTokenType s a | s -> a where
- tokenType :: Lens' s a
type O2CodeStore = MVar (Either AuthEvalError OAuth2Code)
data OAuth2Env = OAuth2Env {
- _oAuth2EnvO2conf :: OAuth2Conf
- _oAuth2EnvO2runTime :: OAuth2RunTime
- _oAuth2EnvO2codeStore :: O2CodeStore
}
class HasO2codeStore s a | s -> a where
- o2codeStore :: Lens' s a
class HasO2conf s a | s -> a where
- o2conf :: Lens' s a
class HasO2runTime s a | s -> a where
- o2runTime :: Lens' s a
getOAuthDbPath :: OAuth2Env -> FilePath
getCorrelatedKey :: OAuth2Env -> OAuth2CorrelatedKey
getOAuthPort :: OAuth2Env -> Int
data GCredentials = GCredentials {
- _gCredentialsClientId :: Text
- _gCredentialsClientSecret :: Text
- _gCredentialsRefreshToken :: Text
- _gCredentialsCtype :: Text
}
class HasCtype s a | s -> a where
- ctype :: Lens' s a

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 #
HasO2codeStore OAuth2Env O2CodeStore #
Instance details Defined in Napkin.Auth.Types Methods o2codeStore :: Lens' OAuth2Env O2CodeStore #
type Rep AuthEvalError #
Instance details Defined in Napkin.Auth.Types type Rep AuthEvalError = D1 ('MetaData "AuthEvalError" "Napkin.Auth.Types" "napkin-0.5.14-JrXUGmKUOt9J0meJSj0Kh4" '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 _oAuth2ClientId :: Text _oAuth2ClientSecret :: Text

Instances

Instances details

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 #
HasClientId OAuth2 Text #
Instance details Defined in Napkin.Auth.Types Methods clientId :: Lens' OAuth2 Text #
HasClientSecret OAuth2 Text #
Instance details Defined in Napkin.Auth.Types Methods clientSecret :: Lens' OAuth2 Text #
HasOAuth2 NapkinOAuth2 OAuth2 #
Instance details Defined in Napkin.Auth.Types Methods oAuth2 :: Lens' NapkinOAuth2 OAuth2 #

class HasClientId s a | s -> a where #

Methods

clientId :: Lens' s a #

Instances

Instances details

HasClientId GCredentials Text #
Instance details Defined in Napkin.Auth.Types Methods clientId :: Lens' GCredentials Text #
HasClientId OAuth2 Text #
Instance details Defined in Napkin.Auth.Types Methods clientId :: Lens' OAuth2 Text #

class HasClientSecret s a | s -> a where #

Methods

clientSecret :: Lens' s a #

Instances

Instances details

HasClientSecret GCredentials Text #
Instance details Defined in Napkin.Auth.Types Methods clientSecret :: Lens' GCredentials Text #
HasClientSecret OAuth2 Text #
Instance details Defined in Napkin.Auth.Types Methods clientSecret :: Lens' OAuth2 Text #

type CallbackPort = Int #

newtype OAuth2CacheIndex #

Constructors

OAuth2CacheIndex
Fields unIndex :: Text

Instances

Instances details

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 #

newtype SpecFile #

Constructors

SpecFile
Fields unSpecFile :: FilePath

Instances

Instances details

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 #
HasSpecFile OAuth2Context SpecFile #
Instance details Defined in Napkin.Auth.Types Methods specFile :: Lens' OAuth2Context SpecFile #
HasSpecFile OAuth2CorrelatedKey SpecFile #
Instance details Defined in Napkin.Auth.Types Methods specFile :: Lens' OAuth2CorrelatedKey SpecFile #

newtype DbUri #

Constructors

DbUri
Fields unUri :: Text

Instances

Instances details

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 #
HasDbUri OAuth2CorrelatedKey DbUri #
Instance details Defined in Napkin.Auth.Types Methods dbUri :: Lens' OAuth2CorrelatedKey DbUri #

newtype CredentialsJson #

Constructors

CredentialsJson
Fields unCredentials :: ByteString

data OAuth2CorrelatedKey #

Constructors

OAuth2CorrelatedKey
Fields _oAuth2CorrelatedKeySpecFile :: SpecFile _oAuth2CorrelatedKeyDbUri :: DbUri _oAuth2CorrelatedKeyAppName :: AppName

Instances

Instances details

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 #
HasAppName OAuth2CorrelatedKey AppName #
Instance details Defined in Napkin.Auth.Types Methods appName :: Lens' OAuth2CorrelatedKey AppName #
HasDbUri OAuth2CorrelatedKey DbUri #
Instance details Defined in Napkin.Auth.Types Methods dbUri :: Lens' OAuth2CorrelatedKey DbUri #
HasOAuth2CorrelatedKey OAuth2Context OAuth2CorrelatedKey #
Instance details Defined in Napkin.Auth.Types Methods oAuth2CorrelatedKey :: Lens' OAuth2Context OAuth2CorrelatedKey #
HasSpecFile OAuth2CorrelatedKey SpecFile #
Instance details Defined in Napkin.Auth.Types Methods specFile :: Lens' OAuth2CorrelatedKey SpecFile #

class HasAppName s a | s -> a where #

Methods

appName :: Lens' s a #

Instances

Instances details

HasAppName OAuth2CorrelatedKey AppName #
Instance details Defined in Napkin.Auth.Types Methods appName :: Lens' OAuth2CorrelatedKey AppName #

class HasDbUri s a | s -> a where #

Methods

dbUri :: Lens' s a #

Instances

Instances details

HasDbUri OAuth2CorrelatedKey DbUri #
Instance details Defined in Napkin.Auth.Types Methods dbUri :: Lens' OAuth2CorrelatedKey DbUri #

class HasSpecFile s a | s -> a where #

Methods

specFile :: Lens' s a #

Instances

Instances details

HasSpecFile OAuth2Context SpecFile #
Instance details Defined in Napkin.Auth.Types Methods specFile :: Lens' OAuth2Context SpecFile #
HasSpecFile OAuth2CorrelatedKey SpecFile #
Instance details Defined in Napkin.Auth.Types Methods specFile :: Lens' OAuth2CorrelatedKey SpecFile #

data OAuth2Context #

Constructors

OAuth2Context
Fields _oAuth2ContextOAuth2dbPath :: FilePath napkin generated oAuth credentials filepath _oAuth2ContextCallbackPort :: CallbackPort napkin oAuth http route to handle google oAuth server callback _oAuth2ContextSpecFile :: SpecFile _oAuth2ContextOAuth2CorrelatedKey :: OAuth2CorrelatedKey

Instances

Instances details

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 #
HasCallbackPort OAuth2Context CallbackPort #
Instance details Defined in Napkin.Auth.Types Methods callbackPort :: Lens' OAuth2Context CallbackPort #
HasOAuth2CorrelatedKey OAuth2Context OAuth2CorrelatedKey #
Instance details Defined in Napkin.Auth.Types Methods oAuth2CorrelatedKey :: Lens' OAuth2Context OAuth2CorrelatedKey #
HasOAuth2context NapkinOAuth2 OAuth2Context #
Instance details Defined in Napkin.Auth.Types Methods oAuth2context :: Lens' NapkinOAuth2 OAuth2Context #
HasOAuth2dbPath OAuth2Context FilePath #
Instance details Defined in Napkin.Auth.Types Methods oAuth2dbPath :: Lens' OAuth2Context FilePath #
HasSpecFile OAuth2Context SpecFile #
Instance details Defined in Napkin.Auth.Types Methods specFile :: Lens' OAuth2Context SpecFile #

class HasCallbackPort s a | s -> a where #

Methods

callbackPort :: Lens' s a #

Instances

Instances details

HasCallbackPort OAuth2Context CallbackPort #
Instance details Defined in Napkin.Auth.Types Methods callbackPort :: Lens' OAuth2Context CallbackPort #

class HasOAuth2CorrelatedKey s a | s -> a where #

Methods

oAuth2CorrelatedKey :: Lens' s a #

Instances

Instances details

HasOAuth2CorrelatedKey OAuth2Context OAuth2CorrelatedKey #
Instance details Defined in Napkin.Auth.Types Methods oAuth2CorrelatedKey :: Lens' OAuth2Context OAuth2CorrelatedKey #

class HasOAuth2dbPath s a | s -> a where #

Methods

oAuth2dbPath :: Lens' s a #

Instances

Instances details

HasOAuth2dbPath OAuth2Context FilePath #
Instance details Defined in Napkin.Auth.Types Methods oAuth2dbPath :: Lens' OAuth2Context FilePath #

data NapkinOAuth2 #

Constructors

NapkinOAuth2
Fields _napkinOAuth2OAuth2 :: OAuth2 _napkinOAuth2OAuth2context :: OAuth2Context

Instances

Instances details

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 #
HasNapkinOAuth2 OAuth2Conf NapkinOAuth2 #
Instance details Defined in Napkin.Auth.Types Methods napkinOAuth2 :: Lens' OAuth2Conf NapkinOAuth2 #
HasOAuth2 NapkinOAuth2 OAuth2 #
Instance details Defined in Napkin.Auth.Types Methods oAuth2 :: Lens' NapkinOAuth2 OAuth2 #
HasOAuth2context NapkinOAuth2 OAuth2Context #
Instance details Defined in Napkin.Auth.Types Methods oAuth2context :: Lens' NapkinOAuth2 OAuth2Context #

class HasOAuth2 s a | s -> a where #

Methods

oAuth2 :: Lens' s a #

Instances

Instances details

HasOAuth2 NapkinOAuth2 OAuth2 #
Instance details Defined in Napkin.Auth.Types Methods oAuth2 :: Lens' NapkinOAuth2 OAuth2 #

class HasOAuth2context s a | s -> a where #

Methods

oAuth2context :: Lens' s a #

Instances

Instances details

HasOAuth2context NapkinOAuth2 OAuth2Context #
Instance details Defined in Napkin.Auth.Types Methods oAuth2context :: Lens' NapkinOAuth2 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"] #

authScopeType :: Proxy '["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

_oAuth2ConfNapkinOAuth2 :: NapkinOAuth2
_oAuth2ConfOAuth2scope :: Proxy '["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"]
_oAuth2ConfOAuth2requestUri :: Text
_oAuth2ConfOAuth2accessTokenRequest :: Text
_oAuth2ConfOAuth2encodingAlgorithm :: EncodingMethod
_oAuth2ConfOAuth2grantType :: GrantType

Instances

Instances details

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 #
HasNapkinOAuth2 OAuth2Conf NapkinOAuth2 #
Instance details Defined in Napkin.Auth.Types Methods napkinOAuth2 :: Lens' OAuth2Conf NapkinOAuth2 #
HasO2conf OAuth2Env OAuth2Conf #
Instance details Defined in Napkin.Auth.Types Methods o2conf :: Lens' OAuth2Env OAuth2Conf #
HasOAuth2accessTokenRequest OAuth2Conf Text #
Instance details Defined in Napkin.Auth.Types Methods oAuth2accessTokenRequest :: Lens' OAuth2Conf Text #
HasOAuth2encodingAlgorithm OAuth2Conf EncodingMethod #
Instance details Defined in Napkin.Auth.Types Methods oAuth2encodingAlgorithm :: Lens' OAuth2Conf EncodingMethod #
HasOAuth2grantType OAuth2Conf GrantType #
Instance details Defined in Napkin.Auth.Types Methods oAuth2grantType :: Lens' OAuth2Conf GrantType #
HasOAuth2requestUri OAuth2Conf Text #
Instance details Defined in Napkin.Auth.Types Methods oAuth2requestUri :: Lens' OAuth2Conf Text #
HasOAuth2scope OAuth2Conf (Proxy '["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"]) #
Instance details Defined in Napkin.Auth.Types Methods oAuth2scope :: Lens' OAuth2Conf (Proxy '["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"]) #

class HasNapkinOAuth2 s a | s -> a where #

Methods

napkinOAuth2 :: Lens' s a #

Instances

Instances details

HasNapkinOAuth2 OAuth2Conf NapkinOAuth2 #
Instance details Defined in Napkin.Auth.Types Methods napkinOAuth2 :: Lens' OAuth2Conf NapkinOAuth2 #

class HasOAuth2accessTokenRequest s a | s -> a where #

Methods

oAuth2accessTokenRequest :: Lens' s a #

Instances

Instances details

HasOAuth2accessTokenRequest OAuth2Conf Text #
Instance details Defined in Napkin.Auth.Types Methods oAuth2accessTokenRequest :: Lens' OAuth2Conf Text #

class HasOAuth2encodingAlgorithm s a | s -> a where #

Methods

oAuth2encodingAlgorithm :: Lens' s a #

Instances

Instances details

HasOAuth2encodingAlgorithm OAuth2Conf EncodingMethod #
Instance details Defined in Napkin.Auth.Types Methods oAuth2encodingAlgorithm :: Lens' OAuth2Conf EncodingMethod #

class HasOAuth2grantType s a | s -> a where #

Methods

oAuth2grantType :: Lens' s a #

Instances

Instances details

HasOAuth2grantType OAuth2Conf GrantType #
Instance details Defined in Napkin.Auth.Types Methods oAuth2grantType :: Lens' OAuth2Conf GrantType #

class HasOAuth2requestUri s a | s -> a where #

Methods

oAuth2requestUri :: Lens' s a #

Instances

Instances details

HasOAuth2requestUri OAuth2Conf Text #
Instance details Defined in Napkin.Auth.Types Methods oAuth2requestUri :: Lens' OAuth2Conf Text #

class HasOAuth2scope s a | s -> a where #

Methods

oAuth2scope :: Lens' s a #

Instances

Instances details

HasOAuth2scope OAuth2Conf (Proxy '["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"]) #
Instance details Defined in Napkin.Auth.Types Methods oAuth2scope :: Lens' OAuth2Conf (Proxy '["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"]) #

data OAuth2RunTime #

Constructors

OAuth2RunTime
Fields _oAuth2RunTimeOAuth2codeVerifier :: ByteString _oAuth2RunTimeOAuth2codeChallenge :: ByteString _oAuth2RunTimeOAuth2callbackUrl :: Text

Instances

Instances details

Eq OAuth2RunTime #
Instance details Defined in Napkin.Auth.Types Methods (==) :: OAuth2RunTime -> OAuth2RunTime -> Bool # (/=) :: OAuth2RunTime -> OAuth2RunTime -> Bool #
HasO2runTime OAuth2Env OAuth2RunTime #
Instance details Defined in Napkin.Auth.Types Methods o2runTime :: Lens' OAuth2Env OAuth2RunTime #
HasOAuth2callbackUrl OAuth2RunTime Text #
Instance details Defined in Napkin.Auth.Types Methods oAuth2callbackUrl :: Lens' OAuth2RunTime Text #
HasOAuth2codeChallenge OAuth2RunTime ByteString #
Instance details Defined in Napkin.Auth.Types Methods oAuth2codeChallenge :: Lens' OAuth2RunTime ByteString #
HasOAuth2codeVerifier OAuth2RunTime ByteString #
Instance details Defined in Napkin.Auth.Types Methods oAuth2codeVerifier :: Lens' OAuth2RunTime ByteString #

class HasOAuth2callbackUrl s a | s -> a where #

Methods

oAuth2callbackUrl :: Lens' s a #

Instances

Instances details

HasOAuth2callbackUrl OAuth2RunTime Text #
Instance details Defined in Napkin.Auth.Types Methods oAuth2callbackUrl :: Lens' OAuth2RunTime Text #

class HasOAuth2codeChallenge s a | s -> a where #

Methods

oAuth2codeChallenge :: Lens' s a #

Instances

Instances details

HasOAuth2codeChallenge OAuth2RunTime ByteString #
Instance details Defined in Napkin.Auth.Types Methods oAuth2codeChallenge :: Lens' OAuth2RunTime ByteString #

class HasOAuth2codeVerifier s a | s -> a where #

Methods

oAuth2codeVerifier :: Lens' s a #

Instances

Instances details

HasOAuth2codeVerifier OAuth2RunTime ByteString #
Instance details Defined in Napkin.Auth.Types Methods oAuth2codeVerifier :: Lens' OAuth2RunTime ByteString #

data OAuth2Token #

Constructors

OAuth2Token
Fields _oAuth2TokenAccessToken :: Text _oAuth2TokenExpiresIn :: Int _oAuth2TokenRefreshToken :: Text _oAuth2TokenScope :: Text _oAuth2TokenTokenType :: Text _oAuth2TokenIdToken :: 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 #
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 #
HasAccessToken OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods accessToken :: Lens' OAuth2Token Text #
HasExpiresIn OAuth2Token Int #
Instance details Defined in Napkin.Auth.Types Methods expiresIn :: Lens' OAuth2Token Int #
HasIdToken OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods idToken :: Lens' OAuth2Token Text #
HasRefreshToken OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods refreshToken :: Lens' OAuth2Token Text #
HasScope OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods scope :: Lens' OAuth2Token Text #
HasTokenType OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods tokenType :: Lens' OAuth2Token Text #

class HasAccessToken s a | s -> a where #

Methods

accessToken :: Lens' s a #

Instances

Instances details

HasAccessToken OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods accessToken :: Lens' OAuth2Token Text #

class HasExpiresIn s a | s -> a where #

Methods

expiresIn :: Lens' s a #

Instances

Instances details

HasExpiresIn OAuth2Token Int #
Instance details Defined in Napkin.Auth.Types Methods expiresIn :: Lens' OAuth2Token Int #

class HasIdToken s a | s -> a where #

Methods

idToken :: Lens' s a #

Instances

Instances details

HasIdToken OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods idToken :: Lens' OAuth2Token Text #

class HasRefreshToken s a | s -> a where #

Methods

refreshToken :: Lens' s a #

Instances

Instances details

HasRefreshToken GCredentials Text #
Instance details Defined in Napkin.Auth.Types Methods refreshToken :: Lens' GCredentials Text #
HasRefreshToken OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods refreshToken :: Lens' OAuth2Token Text #

class HasScope s a | s -> a where #

Methods

scope :: Lens' s a #

Instances

Instances details

HasScope OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods scope :: Lens' OAuth2Token Text #

class HasTokenType s a | s -> a where #

Methods

tokenType :: Lens' s a #

Instances

Instances details

HasTokenType OAuth2Token Text #
Instance details Defined in Napkin.Auth.Types Methods tokenType :: Lens' OAuth2Token Text #

type O2CodeStore = MVar (Either AuthEvalError OAuth2Code) #

data OAuth2Env #

Constructors

OAuth2Env
Fields _oAuth2EnvO2conf :: OAuth2Conf _oAuth2EnvO2runTime :: OAuth2RunTime _oAuth2EnvO2codeStore :: O2CodeStore

Instances

Instances details

HasO2codeStore OAuth2Env O2CodeStore #
Instance details Defined in Napkin.Auth.Types Methods o2codeStore :: Lens' OAuth2Env O2CodeStore #
HasO2conf OAuth2Env OAuth2Conf #
Instance details Defined in Napkin.Auth.Types Methods o2conf :: Lens' OAuth2Env OAuth2Conf #
HasO2runTime OAuth2Env OAuth2RunTime #
Instance details Defined in Napkin.Auth.Types Methods o2runTime :: Lens' OAuth2Env OAuth2RunTime #

class HasO2codeStore s a | s -> a where #

Methods

o2codeStore :: Lens' s a #

Instances

Instances details

HasO2codeStore OAuth2Env O2CodeStore #
Instance details Defined in Napkin.Auth.Types Methods o2codeStore :: Lens' OAuth2Env O2CodeStore #

class HasO2conf s a | s -> a where #

Methods

o2conf :: Lens' s a #

Instances

Instances details

HasO2conf OAuth2Env OAuth2Conf #
Instance details Defined in Napkin.Auth.Types Methods o2conf :: Lens' OAuth2Env OAuth2Conf #

class HasO2runTime s a | s -> a where #

Methods

o2runTime :: Lens' s a #

Instances

Instances details

HasO2runTime OAuth2Env OAuth2RunTime #
Instance details Defined in Napkin.Auth.Types Methods o2runTime :: Lens' OAuth2Env OAuth2RunTime #

getOAuthDbPath :: OAuth2Env -> FilePath #

getOAuthPort :: OAuth2Env -> Int #

data GCredentials #

Constructors

GCredentials
Fields _gCredentialsClientId :: Text _gCredentialsClientSecret :: Text _gCredentialsRefreshToken :: Text _gCredentialsCtype :: 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 #
HasClientId GCredentials Text #
Instance details Defined in Napkin.Auth.Types Methods clientId :: Lens' GCredentials Text #
HasClientSecret GCredentials Text #
Instance details Defined in Napkin.Auth.Types Methods clientSecret :: Lens' GCredentials Text #
HasCtype GCredentials Text #
Instance details Defined in Napkin.Auth.Types Methods ctype :: Lens' GCredentials Text #
HasRefreshToken GCredentials Text #
Instance details Defined in Napkin.Auth.Types Methods refreshToken :: Lens' GCredentials Text #

class HasCtype s a | s -> a where #

Methods

ctype :: Lens' s a #

Instances

Instances details

HasCtype GCredentials Text #
Instance details Defined in Napkin.Auth.Types Methods ctype :: Lens' GCredentials 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