The wai-cors package

[Tags: library, mit]

This package provides an implemenation of Cross-Origin resource sharing (CORS) for Wai that aims to be compliant with http://www.w3.org/TR/cors.


[Skip to ReadMe]

Properties

Versions0.1.0, 0.1.1, 0.1.2, 0.1.3, 0.1.4, 0.2, 0.2.1, 0.2.2, 0.2.3
Change logCHANGELOG.md
Dependenciesattoparsec (>=0.10.4.0), base (==4.*), base-unicode-symbols (>=0.2.2.3), bytestring (>=0.10.0.2), case-insensitive (>=1.0.0.1), charset (>=0.3.7), http-types (>=0.8.0), mtl (>=2.1), parsers (>=0.11), resourcet (>=0.4), transformers (>=0.3), transformers-compat (>=0.3), wai [details]
LicenseMIT
Copyright(c) 2015 Lars Kuhtz <lakuhtz@gmail.com>, (c) 2014 AlephCloud Systems, Inc.
AuthorLars Kuhtz <lakuhtz@gmail.com>
MaintainerLars Kuhtz <lakuhtz@gmail.com>
CategoryWeb
Home pagehttps://github.com/larskuhtz/wai-cors
Bug trackerhttps://github.com/larskuhtz/wai-cors/issues
Source repositoryhead: git clone https://github.com/larskuhtz/wai-cors -b master
this: git clone https://github.com/larskuhtz/wai-cors(tag 0.2.3)
UploadedThu Jun 4 22:57:24 UTC 2015 by larsk
DistributionsNixOS:0.2.3, Stackage:0.2.3
Downloads2151 total (255 in last 30 days)
Votes
0 []
StatusDocs available [build log]
Last success reported on 2015-06-09 [all 1 reports]

Modules

[Index]

Flags

NameDescriptionDefault
transformers-3use transformers<0.3 (this is set automatically)Disabled
wai-1use version wai<2 (this is set automatically)Disabled
wai-2use version wai<3 (this is set automatically)Disabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for wai-cors-0.2.3

Build Status

Cross-Origin Resource Sharing (CORS) For Wai

This package provides a Haskell implementation of CORS for WAI that aims to be compliant with http://www.w3.org/TR/cors.

Note On Security

This implementation doesn't include any server side enforcement. By complying with the CORS standard it enables the client (i.e. the web browser) to enforce the CORS policy. For application authors it is strongly recommended to take into account the security considerations in section 6.3 of the CORS standard. In particular the application should check that the value of the Origin header matches the expectations.

Websocket connections don't support CORS and are ignored by the CORS implementation in this package. However Websocket requests usually (at least for some browsers) include the @Origin@ header. Applications are expected to check the value of this header and respond with an error in case that its content doesn't match the expectations.

Installation

Assuming the availability of recent versions of GHC and cabal this package is installed via

cabal update
cabal install wai-cors

Usage

The function 'simpleCors' enables support of simple cross-origin requests. More advanced CORS policies can be enabled by passing a 'CorsResourcePolicy' to the 'cors' middleware.

The file examples/Scotty.hs shows how to support simple cross-origin requests (as defined in http://www.w3.org/TR/cors) in a scotty application.

{-# LANGUAGE UnicodeSyntax #-}
{-# LANGUAGE OverloadedStrings #-}

module Main
( main
) where

import Network.Wai.Middleware.Cors
import Web.Scotty

main ∷ IO ()
main = scotty 8080 $ do
    middleware simpleCors
    matchAny  "/" $ text "Success"

The result of following curl command will include the HTTP response header Access-Control-Allow-Origin: *.

curl -i http://127.0.0.1:8888 -H 'Origin: 127.0.0.1' -v

Documentation for more general usage can be found in the module Network.Wai.Middleware.Cors.

Test

In order to run the automated test suite PhantomJS (at least version 2.0) must be installed in the system.

cabal install --only-dependencies --enable-tests
cabal test --show-details=streaming

If PhantomJS is not available the tests can be exectued manually in a modern web-browser as follows.

Start the server application:

cd test
ghc -main-is Server Server.hs
./Server

Open the file test/index.html in a modern web-browser. On page load a Javascript script is exectued that runs the test suite and prints the result on the page.