graphql-engine/server/src-lib/Hasura/Server/API/Config.hs

-- | API related to server configuration
module Hasura.Server.API.Config
  -- required by pro
  ( ServerConfig(..)
  , runGetConfig
  ) where

import           Hasura.Prelude

import           Data.Aeson.TH

import qualified Data.HashSet                             as Set

import qualified Hasura.GraphQL.Execute.LiveQuery.Options as LQ

import           Hasura.RQL.Types                         (FunctionPermissionsCtx,
                                                           RemoteSchemaPermsCtx)
import           Hasura.Server.Auth
import           Hasura.Server.Auth.JWT
import           Hasura.Server.Types                      (ExperimentalFeature)
import           Hasura.Server.Version                    (HasVersion, Version, currentVersion)

data JWTInfo
  = JWTInfo
  { jwtiClaimsNamespace :: !JWTNamespace
  , jwtiClaimsFormat    :: !JWTClaimsFormat
  , jwtiClaimsMap       :: !(Maybe JWTCustomClaimsMap)
  } deriving (Show, Eq)
$(deriveToJSON hasuraJSON ''JWTInfo)

data ServerConfig
  = ServerConfig
  { scfgVersion                          :: !Version
  , scfgIsFunctionPermissionsInferred    :: !FunctionPermissionsCtx
  , scfgIsRemoteSchemaPermissionsEnabled :: !RemoteSchemaPermsCtx
  , scfgIsAdminSecretSet                 :: !Bool
  , scfgIsAuthHookSet                    :: !Bool
  , scfgIsJwtSet                         :: !Bool
  , scfgJwt                              :: !(Maybe JWTInfo)
  , scfgIsAllowListEnabled               :: !Bool
  , scfgLiveQueries                      :: !LQ.LiveQueriesOptions
  , scfgConsoleAssetsDir                 :: !(Maybe Text)
  , scfgExperimentalFeatures             :: !(Set.HashSet ExperimentalFeature)
  } deriving (Show, Eq)
$(deriveToJSON hasuraJSON ''ServerConfig)

runGetConfig
  :: HasVersion
  => FunctionPermissionsCtx
  -> RemoteSchemaPermsCtx
  -> AuthMode
  -> Bool
  -> LQ.LiveQueriesOptions
  -> Maybe Text
  -> Set.HashSet ExperimentalFeature
  -> ServerConfig
runGetConfig functionPermsCtx remoteSchemaPermsCtx am isAllowListEnabled
  liveQueryOpts consoleAssetsDir experimentalFeatures = ServerConfig
    currentVersion
    functionPermsCtx
    remoteSchemaPermsCtx
    (isAdminSecretSet am)
    (isAuthHookSet am)
    (isJWTSet am)
    (getJWTInfo am)
    isAllowListEnabled
    liveQueryOpts
    consoleAssetsDir
    experimentalFeatures

isAdminSecretSet :: AuthMode -> Bool
isAdminSecretSet = \case
  AMNoAuth -> False
  _        -> True

isAuthHookSet :: AuthMode -> Bool
isAuthHookSet = \case
  AMAdminSecretAndHook _ _ -> True
  _                        -> False

isJWTSet :: AuthMode -> Bool
isJWTSet = \case
  AMAdminSecretAndJWT{} -> True
  _                     -> False

getJWTInfo :: AuthMode -> Maybe JWTInfo
getJWTInfo (AMAdminSecretAndJWT _ jwtCtx _) =
  Just $ case jcxClaims jwtCtx of
    JCNamespace namespace claimsFormat ->
      JWTInfo namespace claimsFormat Nothing
    JCMap claimsMap ->
      JWTInfo (ClaimNs defaultClaimsNamespace) defaultClaimsFormat $ Just claimsMap
getJWTInfo _ = Nothing