srv (empty) → 0.1.0.0
raw patch · 6 files changed
+488/−0 lines, 6 filesdep +asyncdep +basedep +bytestringsetup-changed
Dependencies added: async, base, bytestring, containers, directory, raw-strings-qq, wai, wai-app-static, warp, warp-tls, yaml
Files
- LICENSE +201/−0
- README.md +67/−0
- Setup.hs +2/−0
- app/DemoCertificate.hs +78/−0
- app/Main.hs +97/−0
- srv.cabal +43/−0
+ LICENSE view
@@ -0,0 +1,201 @@+ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright [yyyy] [name of copyright owner]++ Licensed under the Apache License, Version 2.0 (the "License");+ you may not use this file except in compliance with the License.+ You may obtain a copy of the License at++ http://www.apache.org/licenses/LICENSE-2.0++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ README.md view
@@ -0,0 +1,67 @@+# srv+srv is a tiny web server for local deployments++## Installation++## build from source++```bash++$ git clone https://github.com/thma/srv.git+$ cd srv+$ stack install ++-- or if you don't have stack installed++$ cabal install+```++## Usage++```bash+$ srv++starting up srv...+srv.yaml not found, generating file with default config+Starting HTTP server on port 8080+Starting HTTPS server on port 8443+```++During the initial run, srv will create a config file "srv.yaml" +in the current directory. ++You can edit this file to change the port, the directory to serve, +and also select whether host HTTP or HTTPS or both.++If HTTPS is selected, you can also provide a certificate and key file.+If you don't provide both files, srv will use a predefined+self-signed certificate which is meant for local demo use only.+(using this demo certificate will result in a warning in your browser +and some browsers will even refuse to connect.)++## Configuration++Here is a sample configuration file:++```yaml+documentRoot: .+handlers:+- - HTTP+ - 8080+- - HTTPS+ - 8443+pathToCert: certificate.pem+pathToKey: key.pem+```++## How to generate your own certificate++```bash+openssl genrsa -out key.pem 2048+openssl req -new -key key.pem -out certificate.csr+openssl x509 -req -in certificate.csr -signkey key.pem -out certificate.pem+```++++
+ Setup.hs view
@@ -0,0 +1,2 @@+import Distribution.Simple+main = defaultMain
+ app/DemoCertificate.hs view
@@ -0,0 +1,78 @@+{-# LANGUAGE OverloadedStrings #-}+{-# LANGUAGE QuasiQuotes #-}++module DemoCertificate+ ( demoTLSSettings,+ )+where++{--+This module provides a self signed certificate for testing the https server.+It was generated with the following commands:++openssl genrsa -out key.pem 2048+openssl req -new -key key.pem -out certificate.csr+openssl x509 -req -in certificate.csr -signkey key.pem -out certificate.pem++--}++import qualified Data.ByteString as S+import Network.Wai.Handler.WarpTLS (TLSSettings (..), tlsSettingsMemory)+import Text.RawString.QQ (r)++demoTLSSettings :: TLSSettings+demoTLSSettings = tlsSettingsMemory certificate key++certificate :: S.ByteString+certificate =+ [r|-----BEGIN CERTIFICATE-----+MIIDczCCAlsCFGVNzDOVmV85+d//lhqENnblNF8EMA0GCSqGSIb3DQEBCwUAMHYx+CzAJBgNVBAYTAkRFMQwwCgYDVQQIDANOUlcxDjAMBgNVBAcMBUVzc2VuMQ4wDAYD+VQQKDAVNaWVrZTEMMAoGA1UECwwDQ0VPMQ4wDAYDVQQDDAVNaWVrZTEbMBkGCSqG+SIb3DQEJARYMbWlla2VAd2ViLmRlMB4XDTIyMDYyMTE5MzYxM1oXDTIyMDcyMTE5+MzYxM1owdjELMAkGA1UEBhMCREUxDDAKBgNVBAgMA05SVzEOMAwGA1UEBwwFRXNz+ZW4xDjAMBgNVBAoMBU1pZWtlMQwwCgYDVQQLDANDRU8xDjAMBgNVBAMMBU1pZWtl+MRswGQYJKoZIhvcNAQkBFgxtaWVrZUB3ZWIuZGUwggEiMA0GCSqGSIb3DQEBAQUA+A4IBDwAwggEKAoIBAQDhW96hp1iCG41M22rTKiLeE40VbRsFjJpgzgMLBUAZYWik+vFdpb1A+cU2qiTfNf7gGK/U8gmJsdTEk+x34Pq6xt7/naFFFyBFBE689lYA7qf7m+w76stvivrG/QIGR3eLpP5MuDr3tlYOkz6KJDso9lxvMF2qswJWoPemSJbtd8tUlN+9/vzHvlllihjeTwKJt5ha1Eq8v21V2ZqTHPZP8858C+it/4+zihRrc/UpWN3LWHH+Skv9xK+3X7s76H1+0mtji/bZuzS0+oPCrDKMQwPv2mn9qT4c9nV2E0lH7eiI8trU+OYi+cvGPSl3w5+JTnHzoQfOhToPeu0+ll7Q+XOyRAgMBAAEwDQYJKoZIhvcNAQEL+BQADggEBAE5WkrlmVWMqa5vPYjC6fo7344hviRODPEUM+Ju2lfe0hdl2CpEsAsHr+U/5Ho/XEvo7GBov0WxypPCLY0eWDynrodxpVfg7KWFtmQu7FN4PHQcDgcIXXENHE+FiWYmyDqLhR3v8Cg+grDHFDVrrjxki0ylcKKIKPN3p1NPfZAzG44kDtJYAC+Fjzr+RgIWrVcmHnukQojG/gnt6J6T7Fk1OyswosnspI/ct7xblcR7h3iycr3rbxXvcDgA+GpwyIkl8Fyp4y/1IqebAuiRYLR+Pw00i19TJQvqnenEjrCpYeK3T83Zstke/pHn6+Z1c13pIiIUAEFs56zT6aNh5qPuAyHQ0=+-----END CERTIFICATE-----|]++key :: S.ByteString+key =+ [r|-----BEGIN RSA PRIVATE KEY-----+MIIEpQIBAAKCAQEA4VveoadYghuNTNtq0yoi3hONFW0bBYyaYM4DCwVAGWFopLxX+aW9QPnFNqok3zX+4Biv1PIJibHUxJPsd+D6usbe/52hRRcgRQROvPZWAO6n+5sO++rLb4r6xv0CBkd3i6T+TLg697ZWDpM+iiQ7KPZcbzBdqrMCVqD3pkiW7XfLVJTff7+8x75ZZYoY3k8CibeYWtRKvL9tVdmakxz2T/POfAvorf+Ps4oUa3P1KVjdy1hx0pL+/cSvt1+7O+h9ftJrY4v22bs0tPqDwqwyjEMD79pp/ak+HPZ1dhNJR+3oiPLa1DmI+vnLxj0pd8OfiU5x86EHzoU6D3rtPpZe0PlzskQIDAQABAoIBAQCHqyUGMJaqDSgt+otJWucEv7Jk80ug3mQO/T4apdcm2/dtfgTsmcCrgzJkzF1SO1FrW7FPAz8WtAYhK+eRr7vdCxkKtpBnYXCnDIuq7+5ifCw35/Mkxx8d0Y9TiDFV0mR3nyawzSBCzHRWZf+J6e4FaEaZoEbfx8b5wpIsygfTKlRmzh9B6VNc6xWDCrVPjBuXb8+5Hq+HTmEau9J+e/87z2VMhR+i+UnefjrO4/ewtvyk8PRYsFYzJ7zqd2k0MfC1M7vBJEn1ei1NuqA5+9HPkD+N/CkwbOqnpDFOVjbCZLEfP2CiXu/wmRW6zzp7Bp0iqjtAAyq1Yd84SeyUv+XCq+uuAZAoGBAPSPGz7wr7ECsGLreDF6lfoyADh2pNqKdSDLo6KPN8kStmA/sxUs+T0T3goKxbocd4JeRdQ0IIMZ1MRhilPYAVR6hWF2H2BVNg1O9o/yUDjHug3G661rg+5dUI7m7aWgjYPDCVJMJqRTs+WmqZgVT+Xw6m4LvAbARoq7B2B+JAW08TAoGBAOvm+0Wg5Be+L8OMWH7VWGiCJqcP1sn3x5fjsEp2QRcMWgi69/vLOeAcY0wBIUxPC/QYn+bIcTqCQpEbz5dpZvtKQgxAOrRdkA+Pw2DifE7A91fIf4/NhmjPGMFg7tjW5E8Efa+vPjfhE1jUTyLLdpXIAIEAadbjNhkQu+C0HjBbnZLAoGBAJRhW4OVntOEMSbjfTpw+CR0TR0T630zlYulyBKd1w8AQxWyiWXKIPtQ2ZA4Nv2TlgMYVb/JnMxOWOSJ1dbHI+Q9zgwe+Fo1pRfFPLpPpzjiVHdKMFaRTrjSbzU08Y1jW1lNdZNkNrHPQ0AcHZvzml+WGFYaNQhjKgkJb9b7a6do4jXAoGBAJpyuM/f5b78hG5pYcE76kc7WmbuSjqjUcoz+5cw7VTFxXzJzOqSGAZfD7QHWWG4rz7Vjwm59tCxYp0Buo/HCmSaMPUmZrVVyiZG3+YnUvPM6yQSJVJlYYblcHPLnxVhPIFvk0gV0AGoMAb4OQLCkzucUYEm0cR461tg1S+PGOTYVsZAoGAVQ7k7jnWC/91FikRR3/MuG02zaEAcd9VeioDguuOqyPAIxqQjV+N+d9vA3TBVpgYaUqImnc4eJST4g8oRNK0fPMwKxlUnuJv0dKb/iA3UDfdD59mHbENv+VFEmMo/MDbeBYV758HP6+EMNaAYl1LjrlyiI7ypaUrcc+mPiwVA5vn8=+-----END RSA PRIVATE KEY-----|]
+ app/Main.hs view
@@ -0,0 +1,97 @@+{-# LANGUAGE DeriveAnyClass #-}+{-# LANGUAGE DeriveGeneric #-}++module Main where++import Control.Concurrent.Async (mapConcurrently_)+import qualified Data.Yaml as Yaml+import GHC.Generics (Generic)+import Network.Wai (Application)+import Network.Wai.Application.Static (defaultFileServerSettings,+ staticApp)+import Network.Wai.Handler.Warp (defaultSettings, run, setPort)+import Network.Wai.Handler.WarpTLS (runTLS, tlsSettings, TLSSettings)+import System.Directory (doesFileExist)+import DemoCertificate (demoTLSSettings)++-- | a data type representing Http or Https warp handlers+data WarpHandler = HTTP | HTTPS deriving (Show, Eq, Generic, Yaml.FromJSON, Yaml.ToJSON)++-- | a tuple (WarpHandler, IP port)+type Handler = (WarpHandler, Int)++-- | configuration settings that specify the behaviour of the server+data SrvConfig = SrvConfig+ { handlers :: ![Handler],+ pathToCert :: !(Maybe FilePath),+ pathToKey :: !(Maybe FilePath),+ documentRoot :: !FilePath+ }+ deriving (Show, Eq, Generic, Yaml.FromJSON, Yaml.ToJSON)++-- | create a configuration with default settings+defaultConfig :: SrvConfig+defaultConfig =+ SrvConfig+ { handlers = [(HTTP, 8080), (HTTPS, 8443)],+ pathToCert = Nothing, -- Just "certificate.pem",+ pathToKey = Nothing, -- Just "key.pem",+ documentRoot = "."+ }++-- | create a static WAI Application from a configuration+staticAppFrom :: SrvConfig -> Application+staticAppFrom config =+ staticApp $+ defaultFileServerSettings (documentRoot config)++-- create an HTTP handler action based on config settings+httpHandler :: Handler -> SrvConfig -> IO ()+httpHandler (_, port) config = do+ putStrLn $ "Starting HTTP server on port " <> show port+ run port $ staticAppFrom config++-- create an HTTPS handler action based on config settings+httpsHandler :: Handler -> SrvConfig -> IO ()+httpsHandler (_, port) config = do+ putStrLn $ "Starting HTTPS server on port " <> show port+ runTLS+ (getTlsSettings (pathToCert config) (pathToKey config))+ (setPort port defaultSettings)+ (staticAppFrom config)++-- | create a TLS settings object from file path settings. If no file paths are+-- provided, use the demo in-memory certificate+getTlsSettings :: Maybe FilePath -> Maybe FilePath -> TLSSettings+getTlsSettings (Just cert) (Just key) = tlsSettings cert key+getTlsSettings _ _ = demoTLSSettings++-- | derive all handler IO actions from the configuration+getAllHandlers :: SrvConfig -> [IO ()]+getAllHandlers config =+ map (handlerToAction config) (handlers config)+ where+ handlerToAction :: SrvConfig -> Handler -> IO ()+ handlerToAction cfg handler = case handler of+ (HTTP, _) -> httpHandler handler cfg+ (HTTPS, _) -> httpsHandler handler cfg++configFile :: FilePath+configFile = "srv.yaml"++-- | start all handlers configured in config.yaml+main :: IO ()+main = do+ putStrLn "starting up srv..."+ configIsPresent <- doesFileExist configFile+ config <-+ if configIsPresent+ then do+ putStrLn $ "reading " ++ configFile ++ "..."+ Yaml.decodeFileThrow configFile+ else do+ putStrLn $ configFile ++ " not found, generating file with default config"+ Yaml.encodeFile configFile defaultConfig+ return defaultConfig+ -- run all handlers defined in config+ mapConcurrently_ id (getAllHandlers config)
+ srv.cabal view
@@ -0,0 +1,43 @@+cabal-version: 1.12+name: srv+version: 0.1.0.0+license: Apache-2.0+license-file: LICENSE+copyright: 2022 Thomas Mahler+maintainer: thma@apache.org+author: Thomas Mahler+homepage: https://github.com/thma/srv#readme+bug-reports: https://github.com/thma/srv/issues+synopsis: A simple web server for local usage.+description:+ Please see the README on GitHub at <https://github.com/thma/srv#readme>++category: Web+build-type: Simple+extra-source-files: README.md++source-repository head+ type: git+ location: https://github.com/thma/srv++executable srv+ main-is: Main.hs+ hs-source-dirs: app+ other-modules:+ DemoCertificate+ Paths_srv++ default-language: Haskell2010+ ghc-options: -threaded -rtsopts -with-rtsopts=-N+ build-depends:+ async <2.3,+ base >=4.7 && <5,+ bytestring <0.12,+ containers <0.7,+ directory <1.4,+ raw-strings-qq <1.2,+ wai <3.3,+ wai-app-static <3.2,+ warp <3.4,+ warp-tls <3.4,+ yaml <0.12