test-certs-0.1.0.3: create temporary SSL certificates in tests

Copyright	(c) 2023 Tim Emiola
License	BSD3
Maintainer	Tim Emiola <adetokunbo@emio.la>
Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Certs.Temp

Contents

generate certificates
configuration
certificate filenames

Description

Enables configuration and generation of temporary certificates

Synopsis

withCertPaths :: FilePath -> Config -> (CertPaths -> IO a) -> IO a
withCertFilenames :: (FilePath -> CertPaths) -> FilePath -> Config -> (CertPaths -> IO a) -> IO a
withCertPathsInTmp :: Config -> (CertPaths -> IO a) -> IO a
withCertPathsInTmp' :: (CertPaths -> IO a) -> IO a
generateAndStore :: CertPaths -> Config -> IO ()
data Config = Config {
- cCommonName :: !Text
- cDurationDays :: !Natural
- cProvince :: !(Maybe Text)
- cCity :: !(Maybe Text)
- cOrganization :: !(Maybe Text)
- cCountry :: !(Maybe Text)
}
defaultConfig :: Config
data CertPaths = CertPaths {
- cpKey :: !FilePath
- cpCert :: !FilePath
- cpDir :: !FilePath
}
keyPath :: CertPaths -> FilePath
certificatePath :: CertPaths -> FilePath

generate certificates

withCertPaths :: FilePath -> Config -> (CertPaths -> IO a) -> IO a Source #

Create certificates in a temporary directory below parentDir, specify the locations using CertPaths, use them, then delete them

withCertFilenames :: (FilePath -> CertPaths) -> FilePath -> Config -> (CertPaths -> IO a) -> IO a Source #

Like withCertPaths, but allows the CertPath filenames to be specified

withCertPathsInTmp :: Config -> (CertPaths -> IO a) -> IO a Source #

Like withCertPaths with the system TEMP dir as the parentDir

withCertPathsInTmp' :: (CertPaths -> IO a) -> IO a Source #

Like withCertPathsInTmp using a default Config

generateAndStore :: CertPaths -> Config -> IO () Source #

Generate and store certificate files as specified as CertPaths

configuration

data Config Source #

Configure some details of the generated certificates

Constructors

Config
Fields cCommonName :: !Text the certificate common name cDurationDays :: !Natural the certificate's duration in days cProvince :: !(Maybe Text) cCity :: !(Maybe Text) cOrganization :: !(Maybe Text) cCountry :: !(Maybe Text)

Instances

Instances details

Show Config Source #
Instance details Defined in Test.Certs.Temp Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Eq Config Source #
Instance details Defined in Test.Certs.Temp Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #

defaultConfig :: Config Source #

A default value for Config: CN=localhost, duration is 365 days.

certificate filenames

data CertPaths Source #

Specifies the location to write the temporary certificates

Constructors

CertPaths
Fields cpKey :: !FilePath the basename of the private key file cpCert :: !FilePath the basename of the certificate file cpDir :: !FilePath the directory containing the certificate files

Instances

Instances details

Show CertPaths Source #
Instance details Defined in Test.Certs.Temp Methods showsPrec :: Int -> CertPaths -> ShowS # show :: CertPaths -> String # showList :: [CertPaths] -> ShowS #
Eq CertPaths Source #
Instance details Defined in Test.Certs.Temp Methods (==) :: CertPaths -> CertPaths -> Bool # (/=) :: CertPaths -> CertPaths -> Bool #

keyPath :: CertPaths -> FilePath Source #

The path of the generated key file

certificatePath :: CertPaths -> FilePath Source #

The path of the generated certificate file