X-Git-Url: http://git.cielonegro.org/gitweb.cgi?a=blobdiff_plain;f=Network%2FHTTP%2FLucu%2FConfig.hs;h=cdeef3b435305ae8e76a5630f07d5fb8f884c162;hb=1f0a19cbad7c4b64a773d7f1c1ae9180448624e6;hp=8b1fcf004129be0fe0395c86e1f6c25f63e182f6;hpb=3d017dd65ddede9a11c5b7a34a91e04340e67bc4;p=Lucu.git diff --git a/Network/HTTP/Lucu/Config.hs b/Network/HTTP/Lucu/Config.hs index 8b1fcf0..cdeef3b 100644 --- a/Network/HTTP/Lucu/Config.hs +++ b/Network/HTTP/Lucu/Config.hs @@ -1,47 +1,71 @@ +{-# LANGUAGE + OverloadedStrings + , UnicodeSyntax + #-} -- |Configurations for the Lucu httpd like a port to listen. module Network.HTTP.Lucu.Config ( Config(..) + , SSLConfig(..) , defaultConfig ) where - -import qualified Data.ByteString as Strict (ByteString) -import qualified Data.ByteString.Char8 as C8 hiding (ByteString) -import Network -import Network.BSD -import Network.HTTP.Lucu.MIMEType.Guess -import Network.HTTP.Lucu.MIMEType.DefaultExtensionMap -import System.IO.Unsafe +import Data.Ascii (Ascii) +import Data.Text (Text) +import qualified Data.Text as T +import Network +import Network.BSD +import Network.HTTP.Lucu.MIMEType.Guess +import Network.HTTP.Lucu.MIMEType.DefaultExtensionMap +import OpenSSL.Session +import System.IO.Unsafe -- |Configuration record for the Lucu httpd. You need to use -- 'defaultConfig' or setup your own configuration to run the httpd. data Config = Config { + -- |A string which will be sent to clients as \"Server\" field. - cnfServerSoftware :: !Strict.ByteString + cnfServerSoftware ∷ !Ascii + -- |The host name of the server. This value will be used in -- built-in pages like \"404 Not Found\". - , cnfServerHost :: !Strict.ByteString - -- |A port ID to listen to HTTP clients. - , cnfServerPort :: !PortID + , cnfServerHost ∷ !Text + + -- |A port number (or service name) to listen to HTTP clients. + , cnfServerPort ∷ !ServiceName + + -- |Local IPv4 address to listen to both HTTP and HTTPS + -- clients. Set this to @('Just' "0.0.0.0")@ if you want to accept + -- any IPv4 connections. Set this to 'Nothing' to disable IPv4. + , cnfServerV4Addr ∷ !(Maybe HostName) + + -- |Local IPv6 address to listen to both HTTP and HTTPS + -- clients. Set this to @('Just' "::")@ if you want to accept any + -- IPv6 connections. Set this to 'Nothing' to disable IPv6. Note + -- that there is currently no way to assign separate ports to IPv4 + -- and IPv6 server sockets. + , cnfServerV6Addr ∷ !(Maybe HostName) + + -- |Configuration for HTTPS connections. Set this 'Nothing' to + -- disable HTTPS. + , cnfSSLConfig ∷ !(Maybe SSLConfig) + -- |The maximum number of requests to accept in one connection -- simultaneously. If a client exceeds this limitation, its last -- request won't be processed until a response for its earliest -- pending request is sent back to the client. - , cnfMaxPipelineDepth :: !Int + , cnfMaxPipelineDepth ∷ !Int + -- |The maximum length of request entity to accept in bytes. Note - -- that this is nothing but the default value which is used when - -- 'Network.HTTP.Lucu.Resource.input' and such like are applied to - -- 'Network.HTTP.Lucu.Resource.defaultLimit', so there is no + -- that this is nothing but a default value which is used when + -- 'Network.HTTP.Lucu.Resource.getForm' and such like are applied + -- to 'Network.HTTP.Lucu.Resource.defaultLimit', so there is no -- guarantee that this value always constrains all the requests. - , cnfMaxEntityLength :: !Int - -- |The maximum length of chunk to output. This value is used by - -- 'Network.HTTP.Lucu.Resource.output' and such like to limit the - -- chunk length so you can safely output an infinite string (like - -- a lazy stream of \/dev\/random) using those actions. - , cnfMaxOutputChunkLength :: !Int + , cnfMaxEntityLength ∷ !Int + -- | Whether to dump too late abortion to the stderr or not. See -- 'Network.HTTP.Lucu.Abortion.abort'. - , cnfDumpTooLateAbortionToStderr :: !Bool + , cnfDumpTooLateAbortionToStderr ∷ !Bool + -- |A mapping from extension to MIME Type. This value is used by -- 'Network.HTTP.Lucu.StaticFile.staticFile' to guess the MIME -- Type of static files. Note that MIME Types are currently @@ -53,20 +77,34 @@ data Config = Config { -- good idea to use GnomeVFS -- () -- instead of vanilla FS. - , cnfExtToMIMEType :: !ExtMap + , cnfExtToMIMEType ∷ !ExtMap } +-- |Configuration record for HTTPS connections. +data SSLConfig + = SSLConfig { + -- |A port ID to listen to HTTPS clients. Local addresses + -- (both for IPv4 and IPv6) will be derived from the parent + -- 'Config'. + sslServerPort ∷ !ServiceName + + -- |An SSL context for accepting connections. + , sslContext ∷ !SSLContext + } + -- |The default configuration. Generally you can use this value as-is, -- or possibly you just want to replace the 'cnfServerSoftware' and --- 'cnfServerPort'. -defaultConfig :: Config +-- 'cnfServerPort'. SSL connections are disabled by default. +defaultConfig ∷ Config defaultConfig = Config { - cnfServerSoftware = C8.pack "Lucu/1.0" - , cnfServerHost = C8.pack (unsafePerformIO getHostName) - , cnfServerPort = Service "http" + cnfServerSoftware = "Lucu/1.0" + , cnfServerHost = T.pack (unsafePerformIO getHostName) + , cnfServerPort = "http" + , cnfServerV4Addr = Just "0.0.0.0" + , cnfServerV6Addr = Just "::" + , cnfSSLConfig = Nothing , cnfMaxPipelineDepth = 100 , cnfMaxEntityLength = 16 * 1024 * 1024 -- 16 MiB - , cnfMaxOutputChunkLength = 5 * 1024 * 1024 -- 5 MiB , cnfDumpTooLateAbortionToStderr = True , cnfExtToMIMEType = defaultExtensionMap }