├── .gitignore ├── CHANGELOG.md ├── LICENSE.md ├── README.md ├── config └── config.exs ├── lib ├── plug_cors.ex └── plug_cors │ ├── actual.ex │ └── preflight.ex ├── mix.exs ├── mix.lock └── test ├── plug_cors_test.exs └── test_helper.exs /.gitignore: -------------------------------------------------------------------------------- 1 | /_build 2 | /deps 3 | erl_crash.dump 4 | *.ez 5 | /docs 6 | .DS_Store 7 | /doc 8 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # v0.8.2 2 | * Deprecation notice 3 | 4 | # v0.8.1 5 | * Enhancements 6 | * Updated to Plug 1.0 7 | 8 | # v0.8.0 9 | * Enhancements 10 | * Origins without wildcards are now checked to see if the exact origin from the request is allowed 11 | * Now checking origins for actual requests 12 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2014 Bryan Joseph 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## DEPRECATED: Please use [Corsica](https://github.com/whatyouhide/corsica) instead 2 | 3 | ## PlugCors [![Documentation](https://img.shields.io/badge/docs-hexpm-blue.svg)](http://hexdocs.pm/plug_cors/) [![Downloads](https://img.shields.io/hexpm/dt/plug_cors.svg)](https://hex.pm/packages/plug_cors) 4 | 5 | A CORS Middleware for Plug. 6 | 7 | ## Installation 8 | 9 | Add the following to the deps section in your ```mix.exs``` file. 10 | 11 | ```Elixir 12 | defp deps do 13 | [... 14 | {:plug_cors, "~> 0.7.3"}] 15 | end 16 | ``` 17 | 18 | After you are done, run ```mix deps.get``` in your shell to fetch and compile PlugCors. 19 | 20 | ## Usage 21 | 22 | ```elixir 23 | plug PlugCors, origins: ["test.origin.test", "*.domain.com"], methods: ["GET", "POST"], headers: ["Authorization"] 24 | ``` 25 | 26 | If using with Phoenix, make sure to define the plug above your router. This is so the plug correctly responds to the OPTIONS requests the browser makes for CORS and prevents 404 responses to the browser's CORS requests. 27 | 28 | ```elixir 29 | defmodule App.Endpoint do 30 | #the rest of the plugs defined in App.Endpoint 31 | 32 | plug PlugCors, origins: ["*"] 33 | plug :router, App.Router 34 | end 35 | ``` 36 | 37 | You can also define the parameters inside of your elixir config if you wish. Parameters defined directly on the plug take precedence over the ones in config 38 | 39 | ```elixir 40 | config :plug_cors, 41 | origins: ["test.origin.test", "*.domain.com"], 42 | methods: ["GET", "POST"], 43 | headers: ["Authorization"] 44 | ``` 45 | 46 | ## Parameters 47 | 48 | * origins: A list of allowed origins or "\*" for all origins. Default: "\*". Can add use wildcards domains such as "*.domain.com" to match on the domain and all it's sub domains 49 | 50 | * methods: A list of allowed HTTP methods. Default: ["GET", "HEAD", "POST", "OPTIONS", "PUT", "PATCH", "DELETE"] 51 | 52 | * headers: A list of additional HTTP headers. Default: [] 53 | ** This is in addition to PlugCors.Preflight.default_accept_headers : 54 | ** [ "accept", "accept-language","content-language", "last-event-id", "content-type" ] 55 | 56 | * expose_headers: A list of headers to expose to the browser via the "Access-Control-Expose-Headers" header. Default: [] (Will not output header) 57 | 58 | * max_age: The max cache age of the response in seconds "Access-Control-Max-Age" header. Default: 0 (Will not output header) 59 | 60 | * supports_credentials: Whether or not to allow cookies with requests "Access-Control-Allow-Credentials" header. Default: false (Will not output header) 61 | 62 | 63 | 64 | -------------------------------------------------------------------------------- /config/config.exs: -------------------------------------------------------------------------------- 1 | # This file is responsible for configuring your application 2 | # and its dependencies with the aid of the Mix.Config module. 3 | use Mix.Config 4 | 5 | # This configuration is loaded before any dependency and is restricted 6 | # to this project. If another project depends on this project, this 7 | # file won't be loaded nor affect the parent project. For this reason, 8 | # if you want to provide default values for your application for third- 9 | # party users, it should be done in your mix.exs file. 10 | 11 | # Sample configuration: 12 | # 13 | config :logger, :console, 14 | format: "$date $time [$level] $metadata$message\n" 15 | # metadata: [:user_id] 16 | 17 | # It is also possible to import configuration files, relative to this 18 | # directory. For example, you can emulate configuration per environment 19 | # by uncommenting the line below and defining dev.exs, test.exs and such. 20 | # Configuration from the imported file will override the ones defined 21 | # here (which is why it is important to import them last). 22 | # 23 | # import_config "#{Mix.env}.exs" 24 | -------------------------------------------------------------------------------- /lib/plug_cors.ex: -------------------------------------------------------------------------------- 1 | defmodule PlugCors do 2 | import Plug.Conn 3 | @moduledoc """ 4 | A CORS Plug 5 | 6 | Usage: 7 | plug PlugCors, origins: ["test.origin.test", "*.domain.com"], methods: ["GET", "POST"], headers: ["Authorization"] 8 | 9 | If using with Phoenix, make sure to define the plug above your router. This is so the plug correctly responds to the OPTIONS requests the browser makes for CORS and prevents 404 responses to the browser's CORS requests. 10 | 11 | defmodule App.Endpoint do 12 | #the rest of the plugs defined in App.Endpoint 13 | 14 | plug PlugCors, origins: ["*"] 15 | plug :router, App.Router 16 | end 17 | 18 | You can also define the parameters inside of your elixir config instead if you wish. Parameters defined directly on the plug take precedence over the ones in config 19 | 20 | config :plug_cors, 21 | origins: ["test.origin.test", "*.domain.com"], 22 | methods: ["GET", "POST"], 23 | headers: ["Authorization"] 24 | 25 | 26 | Parameters: 27 | 28 | * origins: A list of allowed origins or "\\*" for all origins. Default: "\\*". Can add use wildcards domains such as "*.domain.com" to match on the domain and all it's sub domains 29 | 30 | * methods: A list of allowed HTTP methods. Default: ["GET", "HEAD", "POST", "OPTIONS", "PUT", "PATCH", "DELETE"] 31 | 32 | * headers: A list of additionally allowed HTTP headers. These are in addition to 'PlugCors.Preflight.default_accept_headers'. Default: [] 33 | 34 | * expose_headers: A list of headers to expose to the browser via the "Access-Control-Expose-Headers" header. Default: [] (Will not output header) 35 | 36 | * max_age: The max cache age of the response in seconds "Access-Control-Max-Age" header. Default: 0 (Will not output header) 37 | 38 | * supports_credentials: Whether or not to allow cookies with requests "Access-Control-Allow-Credentials" header. Default: false (Will not output header) 39 | 40 | """ 41 | 42 | def init(opts) do 43 | [ 44 | origins: get_config_env(:origins, opts, "*"), 45 | methods: get_config_env(:methods, opts, ["GET", "HEAD", "POST", "OPTIONS", "PUT", "PATCH", "DELETE"]), 46 | headers: get_config_env(:headers, opts, []), 47 | expose_headers: get_config_env(:expose_headers, opts, []), 48 | max_age: get_config_env(:max_age, opts, 0), 49 | supports_credentials: get_config_env(:supports_credentials, opts, false) 50 | ] 51 | end 52 | 53 | defp get_config_env(key, opts, default_value) do 54 | Keyword.get(opts, key, Application.get_env(:plug_cors, key, default_value)) 55 | end 56 | 57 | def call(conn, config) do 58 | get_req_header(conn, "origin") 59 | |> handle_request(conn, config) 60 | end 61 | 62 | defp handle_request([], conn, _config) do 63 | conn 64 | end 65 | 66 | defp handle_request(_, conn, config) do 67 | case is_preflight_request?(conn) do 68 | true -> 69 | PlugCors.Preflight.call(conn, config) 70 | _ -> 71 | PlugCors.Actual.call(conn, config) 72 | end 73 | end 74 | 75 | defp is_preflight_request?(conn) do 76 | get_req_header(conn, "access-control-request-method") != [] and conn.method == "OPTIONS" 77 | end 78 | 79 | @doc false 80 | def is_valid_origin?(origin, origins) do 81 | !is_invalid_origin?(origin, origins) 82 | end 83 | 84 | @doc false 85 | def is_invalid_origin?(_origin, "*") do 86 | false 87 | end 88 | 89 | @doc false 90 | def is_invalid_origin?([origin], origins) do 91 | Enum.find(origins, fn(x) -> is_origin_allowed?(origin, x) end) == nil 92 | end 93 | 94 | @doc false 95 | def is_origin_allowed?(origin_to_test, allowed_origin) do 96 | case allowed_origin do 97 | "*" -> 98 | true 99 | "*." <> domain -> 100 | String.contains?(origin_to_test, domain) 101 | _ -> 102 | origin_to_test = URI.parse(origin_to_test).host 103 | not is_nil(origin_to_test) and String.downcase(origin_to_test) == String.downcase(allowed_origin) 104 | end 105 | end 106 | end 107 | -------------------------------------------------------------------------------- /lib/plug_cors/actual.ex: -------------------------------------------------------------------------------- 1 | defmodule PlugCors.Actual do 2 | import Plug.Conn 3 | 4 | @moduledoc false 5 | 6 | def call(conn, config) do 7 | check_method(conn, config) 8 | end 9 | 10 | defp check_method(conn, config) do 11 | case Enum.find(config[:methods], fn(x) -> String.downcase(x) == String.downcase(conn.method) end) do 12 | nil -> 13 | conn 14 | _ -> 15 | if PlugCors.is_valid_origin?(get_req_header(conn, "origin"), config[:origins]) do 16 | origin = if config[:origins] == "*", do: "*", else: hd(get_req_header(conn, "origin")) 17 | conn = conn |> put_resp_header("access-control-allow-origin", origin) 18 | 19 | if config[:supports_credentials] do 20 | conn = put_resp_header(conn, "access-control-allow-credentials", "true") 21 | end 22 | 23 | if Enum.count(config[:expose_headers]) > 0 do 24 | conn = put_resp_header(conn, "access-control-expose-headers", Enum.join(config[:expose_headers], ",")) 25 | end 26 | end 27 | 28 | conn 29 | end 30 | end 31 | end 32 | -------------------------------------------------------------------------------- /lib/plug_cors/preflight.ex: -------------------------------------------------------------------------------- 1 | defmodule PlugCors.Preflight do 2 | import Plug.Conn 3 | @moduledoc false 4 | 5 | def default_accept_headers do [ 6 | "accept", 7 | "accept-language", 8 | "content-language", 9 | "last-event-id", 10 | "content-type" 11 | ] 12 | end 13 | 14 | def call(conn, config) do 15 | origin = get_req_header(conn, "origin") 16 | case PlugCors.is_invalid_origin?(origin, config[:origins]) do 17 | true -> 18 | send_unauthorized(conn) 19 | _ -> 20 | conn 21 | |> get_request_method 22 | |> check_request_method(config) 23 | end 24 | end 25 | 26 | defp get_request_method(conn) do 27 | method = get_req_header(conn, "access-control-request-method") |> hd 28 | {conn, method } 29 | end 30 | 31 | defp check_request_method({ conn, method }, config) do 32 | case are_all_allowed?([method], config[:methods]) do 33 | false -> 34 | send_unauthorized(conn) 35 | _ -> 36 | conn 37 | |> get_request_headers 38 | |> check_access_control_headers(config) 39 | end 40 | end 41 | 42 | defp get_request_headers(conn) do 43 | headers = get_req_header(conn, "access-control-request-headers") 44 | {conn, headers} 45 | end 46 | 47 | defp check_access_control_headers({conn, []}, config) do 48 | send_ok(conn, config) 49 | end 50 | 51 | defp check_access_control_headers({ conn, headers }, config) do 52 | headers = hd(headers) |> String.split(",") |> Enum.map(fn(x) -> String.strip(x) end) 53 | case are_all_allowed?(headers, config[:headers] ++ default_accept_headers ) do 54 | true -> 55 | send_ok(conn, config) 56 | _ -> 57 | send_unauthorized(conn) 58 | end 59 | end 60 | 61 | defp are_all_allowed?(list_to_check, allowed_list) do 62 | responses = Enum.map(list_to_check, fn(x) -> 63 | Enum.find(allowed_list, fn(y) -> String.downcase(y) == String.downcase(x) end) 64 | end) 65 | 66 | responses = Enum.map(responses, fn(x) -> 67 | if is_nil(x), do: "nil", else: x 68 | end) 69 | 70 | Enum.find(responses, fn(x) -> x == "nil" end) == nil 71 | end 72 | 73 | defp put_access_control_allow_headers(conn,config_headers) do 74 | headers = Enum.uniq(Enum.concat(default_accept_headers,config_headers)) 75 | put_resp_header(conn,"access-control-allow-headers", Enum.join(headers, ",")) 76 | end 77 | 78 | defp send_ok(conn, config) do 79 | origin = if List.wrap(config[:origins]) == ["*"], do: "*", else: hd(get_req_header(conn, "origin")) 80 | 81 | conn = conn 82 | |> put_resp_header("access-control-allow-origin", origin) 83 | |> put_resp_header("access-control-allow-methods", Enum.join(config[:methods], ",")) 84 | |> put_access_control_allow_headers(config[:headers]) 85 | 86 | if config[:max_age] > 0 do 87 | conn = put_resp_header(conn, "access-control-max-age", config[:max_age]) 88 | end 89 | 90 | if config[:supports_credentials] do 91 | conn = put_resp_header(conn, "access-control-allow-credentials", "true") 92 | end 93 | 94 | if Enum.count(config[:expose_headers]) > 0 do 95 | conn = put_resp_header(conn, "access-control-expose-headers", Enum.join(config[:expose_headers], ",")) 96 | end 97 | conn |> send_resp( 200, "") |> halt 98 | 99 | end 100 | 101 | defp send_unauthorized(conn) do 102 | conn |> send_resp( 403, "") |> halt 103 | end 104 | end 105 | -------------------------------------------------------------------------------- /mix.exs: -------------------------------------------------------------------------------- 1 | defmodule PlugCors.Mixfile do 2 | use Mix.Project 3 | 4 | def project do 5 | [ app: :plug_cors, 6 | version: "0.8.2", 7 | elixir: "~> 1.0.0", 8 | description: description, 9 | package: package, 10 | deps: deps 11 | ] 12 | end 13 | 14 | def application do 15 | [applications: [:logger, :plug, :cowboy]] 16 | end 17 | 18 | defp deps do 19 | [ 20 | {:plug, "~> 1.0"}, 21 | {:cowboy, "~> 1.0.0", optional: true}, 22 | {:earmark, "~> 0.1", only: :dev}, 23 | {:ex_doc, "~> 0.6", only: :dev}, 24 | ] 25 | end 26 | 27 | defp description do 28 | """ 29 | Deprecated: CORS Plug Middleware. Please use corsica instead 30 | """ 31 | end 32 | 33 | defp package do 34 | [ 35 | files: ["lib", "priv", "mix.exs", "README*", "readme*", "LICENSE*", "license*", "CHANGELOG*", "changelog*"], 36 | contributors: ["Bryan Joseph"], 37 | licenses: ["Apache 2.0"], 38 | links: %{"GitHub" => "https://github.com/bryanjos/plug_cors"} 39 | ] 40 | end 41 | end 42 | -------------------------------------------------------------------------------- /mix.lock: -------------------------------------------------------------------------------- 1 | %{"cowboy": {:hex, :cowboy, "1.0.2"}, 2 | "cowlib": {:hex, :cowlib, "1.0.1"}, 3 | "earmark": {:hex, :earmark, "0.1.17"}, 4 | "ex_doc": {:hex, :ex_doc, "0.8.4"}, 5 | "plug": {:hex, :plug, "1.0.0"}, 6 | "ranch": {:hex, :ranch, "1.1.0"}} 7 | -------------------------------------------------------------------------------- /test/plug_cors_test.exs: -------------------------------------------------------------------------------- 1 | defmodule PlugCorsTest do 2 | use ExUnit.Case, async: true 3 | use Plug.Test 4 | 5 | @additonal_headers ["Authorization"] 6 | @opts PlugCors.init([origins: ["test.origin.test", "*.domain.test"], methods: ["GET", "POST"], headers: @additonal_headers]) 7 | 8 | @expected_headers Enum.uniq(Enum.concat(PlugCors.Preflight.default_accept_headers, @additonal_headers)) 9 | 10 | 11 | test "Passes conn when not a CORS request" do 12 | conn = conn(:get, "/") 13 | |> PlugCors.call(@opts) 14 | 15 | assert conn.status == nil 16 | end 17 | 18 | test "Passes conn on OPTIONS when not a CORS request" do 19 | conn = conn(:options, "/") 20 | |> PlugCors.call(@opts) 21 | 22 | assert conn.status == nil 23 | end 24 | 25 | test "Sends 403 on preflight request when origin is invalid" do 26 | conn = conn(:options, "/", []) 27 | |> put_req_header("origin", "http://test1.origin.test") 28 | |> put_req_header("access-control-request-method", "OPTIONS") 29 | |> PlugCors.call(@opts) 30 | 31 | assert conn.status == 403 32 | end 33 | 34 | test "Sends 403 on preflight request when access-control-request-method is invalid" do 35 | conn = conn(:options, "/", []) 36 | |> put_req_header("origin", "http://test1.origin.test") 37 | |> put_req_header("access-control-request-method", "PUT") 38 | |> PlugCors.call(@opts) 39 | 40 | assert conn.status == 403 41 | end 42 | 43 | test "Sends 403 on preflight request when access-control-request-headers is invalid" do 44 | conn = conn(:options, "/", []) 45 | |> put_req_header("origin", "http://test1.origin.test") 46 | |> put_req_header("access-control-request-method", "POST") 47 | |> put_req_header("access-control-request-headers", "X-CHICKEN-NUGGETS") 48 | |> PlugCors.call(@opts) 49 | 50 | assert conn.status == 403 51 | end 52 | 53 | test "Sends 200 on preflight request when all options are ok" do 54 | conn = conn(:options, "/", []) 55 | |> put_req_header("origin", "http://test.origin.test") 56 | |> put_req_header("access-control-request-method", "POST") 57 | |> put_req_header("access-control-request-headers", "Authorization") 58 | |> PlugCors.call(@opts) 59 | 60 | assert conn.status == 200 61 | assert get_resp_header(conn, "access-control-allow-origin") == ["http://test.origin.test"] 62 | assert get_resp_header(conn, "access-control-allow-methods") == [Enum.join(["GET", "POST"], ",")] 63 | assert get_resp_header(conn, "access-control-allow-headers") == [Enum.join(@expected_headers, ",")] 64 | end 65 | 66 | test "Sends 200 when wildcard(*) origin allowed" do 67 | conn = conn(:options, "/", []) 68 | |> put_req_header("origin", "http://test.origin.test") 69 | |> put_req_header("access-control-request-method", "POST") 70 | |> put_req_header("access-control-request-headers", "Authorization") 71 | |> PlugCors.call(PlugCors.init([origins: "*", methods: ["GET", "POST"], headers: @additonal_headers])) 72 | 73 | assert conn.status == 200 74 | assert get_resp_header(conn, "access-control-allow-origin") == ["*"] 75 | assert get_resp_header(conn, "access-control-allow-methods") == [Enum.join(["GET", "POST"], ",")] 76 | assert get_resp_header(conn, "access-control-allow-headers") == [Enum.join(@expected_headers, ",")] 77 | end 78 | 79 | test "Sends 200 when wildcard(*) origin in allowed list" do 80 | conn = conn(:options, "/", []) 81 | |> put_req_header("origin", "http://test.origin.test") 82 | |> put_req_header("access-control-request-method", "POST") 83 | |> put_req_header("access-control-request-headers", "Authorization") 84 | |> PlugCors.call(PlugCors.init([origins: ["*"], methods: ["GET", "POST"], headers: @additonal_headers])) 85 | 86 | assert conn.status == 200 87 | assert get_resp_header(conn, "access-control-allow-origin") == ["*"] 88 | assert get_resp_header(conn, "access-control-allow-methods") == [Enum.join(["GET", "POST"], ",")] 89 | assert get_resp_header(conn, "access-control-allow-headers") == [Enum.join(@expected_headers, ",")] 90 | end 91 | 92 | test "Sends 200 when wildcard(*) origin added to allowed list" do 93 | conn = conn(:options, "/", []) 94 | |> put_req_header("origin", "http://test.origin.test") 95 | |> put_req_header("access-control-request-method", "POST") 96 | |> put_req_header("access-control-request-headers", "Authorization") 97 | |> PlugCors.call(PlugCors.init([origins: ["*", "*.domain.test"], methods: ["GET", "POST"], headers: @additonal_headers])) 98 | 99 | assert conn.status == 200 100 | assert get_resp_header(conn, "access-control-allow-origin") == ["http://test.origin.test"] 101 | assert get_resp_header(conn, "access-control-allow-methods") == [Enum.join(["GET", "POST"], ",")] 102 | assert get_resp_header(conn, "access-control-allow-headers") == [Enum.join(@expected_headers, ",")] 103 | end 104 | 105 | test "Sends 200 when subdomain allowed" do 106 | conn = conn(:options, "/", []) 107 | |> put_req_header("origin", "http://sub.domain.test") 108 | |> put_req_header("access-control-request-method", "POST") 109 | |> put_req_header("access-control-request-headers", "Authorization") 110 | |> PlugCors.call(@opts) 111 | 112 | assert conn.status == 200 113 | assert get_resp_header(conn, "access-control-allow-origin") == ["http://sub.domain.test"] 114 | assert get_resp_header(conn, "access-control-allow-methods") == [Enum.join(["GET", "POST"], ",")] 115 | assert get_resp_header(conn, "access-control-allow-headers") == [Enum.join(@expected_headers, ",")] 116 | end 117 | 118 | test "Sends 200 when main domain allowed" do 119 | conn = conn(:options, "/", []) 120 | |> put_req_header("origin", "http://domain.test") 121 | |> put_req_header("access-control-request-method", "POST") 122 | |> put_req_header("access-control-request-headers", "Authorization") 123 | |> PlugCors.call(@opts) 124 | 125 | assert conn.status == 200 126 | assert get_resp_header(conn, "access-control-allow-origin") == ["http://domain.test"] 127 | assert get_resp_header(conn, "access-control-allow-methods") == [Enum.join(["GET", "POST"], ",")] 128 | assert get_resp_header(conn, "access-control-allow-headers") == [Enum.join(@expected_headers, ",")] 129 | end 130 | 131 | test "Passes conn on actual request when origin is not allowed" do 132 | conn = conn(:get, "/", []) 133 | |> put_req_header("origin", "http://test1.origin.test") 134 | |> PlugCors.call(@opts) 135 | 136 | assert conn.status == nil 137 | assert get_resp_header(conn, "access-control-allow-origin") == [] 138 | end 139 | 140 | test "Passes conn on actual request when method is not allowed" do 141 | conn = conn(:put, "/", []) 142 | |> put_req_header("origin", "http://test1.origin.test") 143 | |> PlugCors.call(@opts) 144 | 145 | assert conn.status == nil 146 | end 147 | 148 | test "Passes conn on when ok" do 149 | conn = conn(:post, "/", []) 150 | |> put_req_header("origin", "http://test.origin.test") 151 | |> put_req_header("authorization", "yes") 152 | |> PlugCors.call(@opts) 153 | 154 | assert conn.status == nil 155 | assert get_resp_header(conn, "access-control-allow-origin") == ["http://test.origin.test"] 156 | end 157 | 158 | 159 | test "only allows the specific domain when no wildcard specified" do 160 | conn = conn(:options, "/", []) 161 | |> put_req_header("origin", "http://sub.domain.test") 162 | |> put_req_header("access-control-request-method", "POST") 163 | |> put_req_header("access-control-request-headers", "Authorization") 164 | |> PlugCors.call(PlugCors.init([origins: ["domain.test"], methods: ["GET", "POST"], headers: @additonal_headers])) 165 | 166 | assert conn.status == 403 167 | 168 | 169 | conn = conn(:options, "/", []) 170 | |> put_req_header("origin", "http://domain.test") 171 | |> put_req_header("access-control-request-method", "POST") 172 | |> put_req_header("access-control-request-headers", "Authorization") 173 | |> PlugCors.call(PlugCors.init([origins: ["domain.test"], methods: ["GET", "POST"], headers: @additonal_headers])) 174 | 175 | assert conn.status == 200 176 | assert get_resp_header(conn, "access-control-allow-origin") == ["http://domain.test"] 177 | assert get_resp_header(conn, "access-control-allow-methods") == [Enum.join(["GET", "POST"], ",")] 178 | assert get_resp_header(conn, "access-control-allow-headers") == [Enum.join(@expected_headers, ",")] 179 | end 180 | end 181 | -------------------------------------------------------------------------------- /test/test_helper.exs: -------------------------------------------------------------------------------- 1 | ExUnit.start() 2 | --------------------------------------------------------------------------------