├── test ├── test_helper.exs └── plug_response_header_test.exs ├── .gitignore ├── CHANGELOG.md ├── mix.exs ├── config └── config.exs ├── README.md ├── lib └── plug_response_header.ex └── LICENSE /test/test_helper.exs: -------------------------------------------------------------------------------- 1 | ExUnit.start() 2 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /_build 2 | /deps 3 | mix.lock 4 | erl_crash.dump 5 | *.ez 6 | -------------------------------------------------------------------------------- /test/plug_response_header_test.exs: -------------------------------------------------------------------------------- 1 | defmodule PlugResponseHeaderTest do 2 | use ExUnit.Case 3 | doctest PlugResponseHeader 4 | 5 | test "the truth" do 6 | assert 1 + 1 == 2 7 | end 8 | end 9 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # CHANGELOG 2 | 3 | ## 0.2.1 (2015-04-16) 4 | 5 | * Removed dependency to [cowboy](https://github.com/ninenines/cowboy) (as plug already depends on it). 6 | * Relaxed required version of plug dependency to reflect 0.12 release. 7 | 8 | ## 0.2.0 (2015-04-15) 9 | 10 | * Changed namespace from Plug.ResponseHeader to PlugResponseHeader 11 | 12 | ## 0.1.0 (2015-04-14) 13 | 14 | * Initial release. 15 | -------------------------------------------------------------------------------- /mix.exs: -------------------------------------------------------------------------------- 1 | defmodule PlugResponseHeader.Mixfile do 2 | use Mix.Project 3 | 4 | def project do 5 | [ 6 | app: :plug_response_header, 7 | version: "0.2.1", 8 | elixir: ">= 1.0.4", 9 | build_embedded: Mix.env == :prod, 10 | start_permanent: Mix.env == :prod, 11 | deps: deps, 12 | description: "This plug allows manipulation of HTTP response headers", 13 | package: package, 14 | ] 15 | end 16 | 17 | def application do 18 | [applications: [:logger]] 19 | end 20 | 21 | defp deps do 22 | [ 23 | {:plug, ">= 0.11.0"} 24 | ] 25 | end 26 | 27 | defp package do 28 | %{ 29 | contributors: ["Constantin Rack"], 30 | licenses: ["Apache License 2.0"], 31 | links: %{"GitHub" => "https://github.com/c-rack/plug_response_header"} 32 | } 33 | end 34 | 35 | end 36 | -------------------------------------------------------------------------------- /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, 14 | # level: :info 15 | # 16 | # config :logger, :console, 17 | # format: "$date $time [$level] $metadata$message\n", 18 | # metadata: [:user_id] 19 | 20 | # It is also possible to import configuration files, relative to this 21 | # directory. For example, you can emulate configuration per environment 22 | # by uncommenting the line below and defining dev.exs, test.exs and such. 23 | # Configuration from the imported file will override the ones defined 24 | # here (which is why it is important to import them last). 25 | # 26 | # import_config "#{Mix.env}.exs" 27 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PlugResponseHeader [![Hex.pm Version](http://img.shields.io/hexpm/v/plug_response_header.svg)](https://hex.pm/packages/plug_response_header) 2 | 3 | 4 | This [Elixir](http://elixir-lang.org/) [plug](https://github.com/elixir-lang/plug) allows manipulation of [HTTP](https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol) response headers: 5 | 6 | * Deleting one or more HTTP response headers. 7 | * Setting one or more HTTP response headers. 8 | * Setting the HTTP "Server" response header. 9 | 10 | This plug supports the following options. At least one option must be specified. 11 | 12 | * `delete`: a bitstring or a list of bitstrings of header keys to be deleted. 13 | * `server`: convenience function for `set: ["server": "MyServer"]` 14 | * `set`: a list of key/value pairs for headers to be set. 15 | 16 | ## Setup 17 | 18 | To use the plug in your projects, edit your mix.exs file and add the project as a dependency: 19 | 20 | ```elixir 21 | defp deps do 22 | [ 23 | {:plug_response_header, "~> 0.2.1"} 24 | ] 25 | end 26 | ``` 27 | 28 | ## Usage 29 | 30 | ```elixir 31 | pipeline :browser do 32 | plug PlugResponseHeader, 33 | delete: "x-request-id", 34 | server: "MyServer", 35 | set: [ 36 | "strict-transport-security": "max-age=31536000", 37 | "cache-control": "no-transform" 38 | ] 39 | ... 40 | end 41 | ``` 42 | 43 | ## License 44 | 45 | [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) 46 | -------------------------------------------------------------------------------- /lib/plug_response_header.ex: -------------------------------------------------------------------------------- 1 | defmodule PlugResponseHeader do 2 | 3 | @moduledoc """ 4 | This plug allows manipulation of HTTP response headers: 5 | 6 | * Deleting one or more HTTP response headers. 7 | * Setting one or more HTTP response headers. 8 | * Setting the HTTP "Server" response header. 9 | 10 | This plug supports the following options. At least one option must be specified. 11 | 12 | * `delete`: a bitstring or a list of bitstrings of header keys to be deleted. 13 | * `server`: convenience function for `set: ["server": "MyServer"]` 14 | * `set`: a list of key/value pairs for headers to be set. 15 | 16 | ## Example 17 | 18 | pipeline :browser do 19 | plug PlugResponseHeader, 20 | delete: "x-request-id", 21 | server: "MyServer", 22 | set: ["Strict-Transport-Security": "max-age=31536000"] 23 | ... 24 | end 25 | 26 | """ 27 | 28 | import Plug.Conn, only: [delete_resp_header: 2, update_resp_header: 4] 29 | 30 | @doc "Callback implementation for Plug.init/1" 31 | def init([]), do: raise "Please set at least one option or remove PlugResponseHeader" 32 | def init(options), do: options 33 | 34 | @doc "Callback implementation for Plug.call/2" 35 | def call(conn, options) do 36 | conn 37 | |> delete(options[:delete]) 38 | |> set(options[:set]) 39 | |> set("server", options[:server]) 40 | end 41 | 42 | defp set(conn, nil), do: conn 43 | defp set(conn, list) when list |> is_list do 44 | List.foldl(list, conn, fn({key, value}, conn) -> set(conn, Atom.to_string(key), value) end) 45 | end 46 | defp set(conn, _key, nil), do: conn 47 | defp set(conn, key, value) when value |> is_bitstring do 48 | update_resp_header(conn, key, value, fn(_) -> value end) 49 | end 50 | 51 | defp delete(conn, nil), do: conn 52 | defp delete(conn, []), do: conn 53 | defp delete(conn, key) when key |> is_bitstring, do: delete(conn, [key]) 54 | defp delete(conn, [h|t]) when h |> is_bitstring do 55 | conn 56 | |> delete_resp_header(h) 57 | |> delete(t) 58 | end 59 | 60 | end 61 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 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 {yyyy} {name of copyright owner} 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 | 203 | --------------------------------------------------------------------------------