mirror of
https://github.com/ninenines/cowboy.git
synced 2025-07-14 12:20:24 +00:00
Add CORS example
This commit is contained in:
Andrei Nesterov
parent
0ba3a9a222
commit
bd6b17e799
8 changed files with 281 additions and 0 deletions
|
|
@ -9,6 +9,9 @@
|
|||
* link:cookie[]:
|
||||
set cookies from server and client side
|
||||
|
||||
* link:cors_hello_world[]:
|
||||
simplest CORS middleware example
|
||||
|
||||
* link:echo_get[]:
|
||||
parse and echo a GET query string
|
||||
|
||||
|
|
|
|||
8
examples/cors_hello_world/Makefile
Normal file
8
examples/cors_hello_world/Makefile
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
PROJECT = cors_hello_world
|
||||
PROJECT_DESCRIPTION = Cowboy CORS Hello World example
|
||||
PROJECT_VERSION = 1
|
||||
|
||||
DEPS = cowboy
|
||||
dep_cowboy_commit = master
|
||||
|
||||
include ../../erlang.mk
|
||||
159
examples/cors_hello_world/README.asciidoc
Normal file
159
examples/cors_hello_world/README.asciidoc
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
= Hello world example
|
||||
|
||||
To try this example, you need GNU `make` and `git` in your PATH.
|
||||
|
||||
To build and run the example, use the following command:
|
||||
|
||||
[source,bash]
|
||||
$ make run
|
||||
|
||||
== HTTP/1.1 example output
|
||||
|
||||
[source,bash]
|
||||
----
|
||||
$ curl -i \
|
||||
-XOPTIONS \
|
||||
-H'Origin:http://example.org' \
|
||||
-H'Access-Control-Request-Method:GET' \
|
||||
-H'Access-Control-Request-Headers:Authorization' \
|
||||
'http://localhost:8080'
|
||||
HTTP/1.1 200 OK
|
||||
access-control-allow-headers: Authorization
|
||||
access-control-allow-methods: GET, PUT
|
||||
access-control-allow-origin: http://example.org
|
||||
access-control-max-age: 0
|
||||
content-length: 0
|
||||
date: Sat, 02 Jul 2016 14:56:30 GMT
|
||||
server: Cowboy
|
||||
vary: Origin
|
||||
|
||||
$ curl -i \
|
||||
-XGET \
|
||||
-H'Origin:http://example.org' \
|
||||
'http://localhost:8080'
|
||||
HTTP/1.1 200 OK
|
||||
access-control-allow-origin: http://example.org
|
||||
content-length: 12
|
||||
content-type: text/plain
|
||||
date: Sat, 02 Jul 2016 14:46:42 GMT
|
||||
server: Cowboy
|
||||
vary: Origin
|
||||
|
||||
Hello world!
|
||||
----
|
||||
|
||||
== HTTP/2 example output
|
||||
|
||||
[source,bash]
|
||||
----
|
||||
$ nghttp -v \
|
||||
-H':method: OPTIONS' \
|
||||
-H'Origin:http://example.org' \
|
||||
-H'Access-Control-Request-Method:GET' \
|
||||
-H'Access-Control-Request-Headers:Authorization' \
|
||||
'http://localhost:8080'
|
||||
[ 0.002] Connected
|
||||
[ 0.002] send SETTINGS frame <length=12, flags=0x00, stream_id=0>
|
||||
(niv=2)
|
||||
[SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
|
||||
[SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=3>
|
||||
(dep_stream_id=0, weight=201, exclusive=0)
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=5>
|
||||
(dep_stream_id=0, weight=101, exclusive=0)
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=7>
|
||||
(dep_stream_id=0, weight=1, exclusive=0)
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=9>
|
||||
(dep_stream_id=7, weight=1, exclusive=0)
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=11>
|
||||
(dep_stream_id=3, weight=1, exclusive=0)
|
||||
[ 0.002] send HEADERS frame <length=126, flags=0x25, stream_id=13>
|
||||
; END_STREAM | END_HEADERS | PRIORITY
|
||||
(padlen=0, dep_stream_id=11, weight=16, exclusive=0)
|
||||
; Open new stream
|
||||
:method: OPTIONS
|
||||
:path: /
|
||||
:scheme: http
|
||||
:authority: localhost:8080
|
||||
accept: */*
|
||||
accept-encoding: gzip, deflate
|
||||
user-agent: nghttp2/1.11.1
|
||||
origin: http://example.org
|
||||
access-control-request-method: GET
|
||||
access-control-request-headers: Authorization
|
||||
[ 0.007] recv SETTINGS frame <length=0, flags=0x00, stream_id=0>
|
||||
(niv=0)
|
||||
[ 0.007] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
|
||||
; ACK
|
||||
(niv=0)
|
||||
[ 0.007] send SETTINGS frame <length=0, flags=0x01, stream_id=0>
|
||||
; ACK
|
||||
(niv=0)
|
||||
[ 0.007] recv (stream_id=13) :status: 200
|
||||
[ 0.007] recv (stream_id=13) access-control-allow-headers: Authorization
|
||||
[ 0.007] recv (stream_id=13) access-control-allow-methods: GET, PUT
|
||||
[ 0.007] recv (stream_id=13) access-control-allow-origin: http://example.org
|
||||
[ 0.007] recv (stream_id=13) access-control-max-age: 0
|
||||
[ 0.007] recv (stream_id=13) content-length: 0
|
||||
[ 0.008] recv (stream_id=13) date: Sat, 02 Jul 2016 15:06:07 GMT
|
||||
[ 0.008] recv (stream_id=13) server: Cowboy
|
||||
[ 0.008] recv (stream_id=13) vary: Origin
|
||||
[ 0.008] recv HEADERS frame <length=138, flags=0x05, stream_id=13>
|
||||
; END_STREAM | END_HEADERS
|
||||
(padlen=0)
|
||||
; First response header
|
||||
[ 0.008] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
|
||||
(last_stream_id=0, error_code=NO_ERROR(0x00), opaque_data(0)=[])
|
||||
|
||||
$ nghttp -v \
|
||||
-H':method:GET' \
|
||||
-H'Origin:http://example.org' \
|
||||
'http://localhost:8080'
|
||||
[ 0.002] Connected
|
||||
[ 0.002] send SETTINGS frame <length=12, flags=0x00, stream_id=0>
|
||||
(niv=2)
|
||||
[SETTINGS_MAX_CONCURRENT_STREAMS(0x03):100]
|
||||
[SETTINGS_INITIAL_WINDOW_SIZE(0x04):65535]
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=3>
|
||||
(dep_stream_id=0, weight=201, exclusive=0)
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=5>
|
||||
(dep_stream_id=0, weight=101, exclusive=0)
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=7>
|
||||
(dep_stream_id=0, weight=1, exclusive=0)
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=9>
|
||||
(dep_stream_id=7, weight=1, exclusive=0)
|
||||
[ 0.002] send PRIORITY frame <length=5, flags=0x00, stream_id=11>
|
||||
(dep_stream_id=3, weight=1, exclusive=0)
|
||||
[ 0.002] send HEADERS frame <length=59, flags=0x25, stream_id=13>
|
||||
; END_STREAM | END_HEADERS | PRIORITY
|
||||
(padlen=0, dep_stream_id=11, weight=16, exclusive=0)
|
||||
; Open new stream
|
||||
:method: GET
|
||||
:path: /
|
||||
:scheme: http
|
||||
:authority: localhost:8080
|
||||
accept: */*
|
||||
accept-encoding: gzip, deflate
|
||||
user-agent: nghttp2/1.11.1
|
||||
origin: http://example.org
|
||||
[ 0.004] recv SETTINGS frame <length=0, flags=0x00, stream_id=0>
|
||||
(niv=0)
|
||||
[ 0.005] recv SETTINGS frame <length=0, flags=0x01, stream_id=0>
|
||||
; ACK
|
||||
(niv=0)
|
||||
[ 0.005] recv (stream_id=13) :status: 200
|
||||
[ 0.005] recv (stream_id=13) access-control-allow-origin: http://example.org
|
||||
[ 0.005] recv (stream_id=13) content-length: 12
|
||||
[ 0.005] recv (stream_id=13) content-type: text/plain
|
||||
[ 0.005] recv (stream_id=13) date: Sat, 02 Jul 2016 15:07:01 GMT
|
||||
[ 0.005] recv (stream_id=13) server: Cowboy
|
||||
[ 0.005] recv (stream_id=13) vary: Origin
|
||||
[ 0.005] recv HEADERS frame <length=67, flags=0x04, stream_id=13>
|
||||
; END_HEADERS
|
||||
(padlen=0)
|
||||
; First response header
|
||||
Hello world![ 0.009] recv DATA frame <length=12, flags=0x01, stream_id=13>
|
||||
; END_STREAM
|
||||
[ 0.009] send GOAWAY frame <length=8, flags=0x00, stream_id=0>
|
||||
(last_stream_id=0, error_code=NO_ERROR(0x00), opaque_data(0)=[])
|
||||
----
|
||||
2
examples/cors_hello_world/relx.config
Normal file
2
examples/cors_hello_world/relx.config
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
{release, {cors_hello_world_example, "1"}, [cors_hello_world]}.
|
||||
{extended_start_script, true}.
|
||||
26
examples/cors_hello_world/src/cors_hello_world_app.erl
Normal file
26
examples/cors_hello_world/src/cors_hello_world_app.erl
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
%% Feel free to use, reuse and abuse the code in this file.
|
||||
|
||||
%% @private
|
||||
-module(cors_hello_world_app).
|
||||
-behaviour(application).
|
||||
|
||||
%% API.
|
||||
-export([start/2]).
|
||||
-export([stop/1]).
|
||||
|
||||
%% API.
|
||||
|
||||
start(_Type, _Args) ->
|
||||
Dispatch = cowboy_router:compile([
|
||||
{'_', [
|
||||
{"/", toppage_handler, []}
|
||||
]}
|
||||
]),
|
||||
{ok, _} = cowboy:start_clear(http, 100, [{port, 8080}], #{
|
||||
middlewares => [cors_hello_world_middleware, cowboy_router, cowboy_handler],
|
||||
env => #{dispatch => Dispatch}
|
||||
}),
|
||||
cors_hello_world_sup:start_link().
|
||||
|
||||
stop(_State) ->
|
||||
ok.
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
%% Feel free to use, reuse and abuse the code in this file.
|
||||
|
||||
%% @private
|
||||
-module(cors_hello_world_middleware).
|
||||
|
||||
%% API.
|
||||
-export([execute/2]).
|
||||
|
||||
%% API.
|
||||
|
||||
-spec execute(Req, Env) -> {ok | stop, Req, Env} when Req :: cowboy_req:req(), Env :: any().
|
||||
execute(#{headers := #{<<"origin">> := HeaderVal}} = Req, Env) ->
|
||||
%%AllowedOrigins = '*',
|
||||
AllowedOrigins = [
|
||||
{<<"http">>, <<"example.org">>, 80},
|
||||
{<<"https">>, <<"example.org">>, 443}
|
||||
],
|
||||
|
||||
%% NOTE: we assume we always deal with single origin
|
||||
[Val] = cow_http_hd:parse_origin(HeaderVal),
|
||||
case check_origin(Val, AllowedOrigins) of
|
||||
true -> handle_cors_request(HeaderVal, Req, Env);
|
||||
_ -> {ok, Req, Env}
|
||||
end;
|
||||
execute(Req, Env) ->
|
||||
{ok, Req, Env}.
|
||||
|
||||
-spec handle_cors_request(binary(), cowboy_req:req(), any()) -> cowboy_req:req().
|
||||
handle_cors_request(Origin, #{method := Method} = Req, Env) ->
|
||||
Req2 = cowboy_req:set_resp_header(<<"access-control-allow-origin">>, Origin, Req),
|
||||
Req3 = cowboy_req:set_resp_header(<<"vary">>, <<"Origin">>, Req2),
|
||||
case Method of
|
||||
<<"OPTIONS">> ->
|
||||
Req4 = cowboy_req:set_resp_header(<<"access-control-allow-methods">>, <<"GET, PUT">>, Req3),
|
||||
Req5 = cowboy_req:set_resp_header(<<"access-control-allow-headers">>, <<"Authorization">>, Req4),
|
||||
Req6 = cowboy_req:set_resp_header(<<"access-control-max-age">>, <<"0">>, Req5),
|
||||
Req7 = cowboy_req:reply(200, Req6),
|
||||
{stop, Req7};
|
||||
_ ->
|
||||
{ok, Req3, Env}
|
||||
end.
|
||||
|
||||
-spec check_origin(Origin, [Origin] | '*') -> boolean() when Origin :: {binary(), binary(), 0..65535} | reference().
|
||||
check_origin(Val, '*') when is_reference(Val) -> true;
|
||||
check_origin(_, '*') -> true;
|
||||
check_origin(Val, Val) -> true;
|
||||
check_origin(Val, L) when is_list(L) -> lists:member(Val, L);
|
||||
check_origin(_, _) -> false.
|
||||
23
examples/cors_hello_world/src/cors_hello_world_sup.erl
Normal file
23
examples/cors_hello_world/src/cors_hello_world_sup.erl
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
%% Feel free to use, reuse and abuse the code in this file.
|
||||
|
||||
%% @private
|
||||
-module(cors_hello_world_sup).
|
||||
-behaviour(supervisor).
|
||||
|
||||
%% API.
|
||||
-export([start_link/0]).
|
||||
|
||||
%% supervisor.
|
||||
-export([init/1]).
|
||||
|
||||
%% API.
|
||||
|
||||
-spec start_link() -> {ok, pid()}.
|
||||
start_link() ->
|
||||
supervisor:start_link({local, ?MODULE}, ?MODULE, []).
|
||||
|
||||
%% supervisor.
|
||||
|
||||
init([]) ->
|
||||
Procs = [],
|
||||
{ok, {{one_for_one, 10, 10}, Procs}}.
|
||||
12
examples/cors_hello_world/src/toppage_handler.erl
Normal file
12
examples/cors_hello_world/src/toppage_handler.erl
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
%% Feel free to use, reuse and abuse the code in this file.
|
||||
|
||||
%% @doc Hello world handler.
|
||||
-module(toppage_handler).
|
||||
|
||||
-export([init/2]).
|
||||
|
||||
init(Req, Opts) ->
|
||||
cowboy_req:reply(200, #{
|
||||
<<"content-type">> => <<"text/plain">>
|
||||
}, <<"Hello world!">>, Req),
|
||||
{ok, Req, Opts}.
|
||||
Loading…
Add table
Add a link
Reference in a new issue