Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix inaccurate s3 rewrite rule. #1040

Merged
merged 17 commits into from
Jan 13, 2015
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions riak_test/tests/legacy_s3_rewrite_test.erl
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
%% ---------------------------------------------------------------------
%%
%% Copyright (c) 2007-2015 Basho Technologies, Inc. All Rights Reserved.
%%
%% This file is provided to you 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.
%%
%% ---------------------------------------------------------------------

-module(legacy_s3_rewrite_test).

%% @doc `riak_test' module for testing object get behavior.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a stale comment from copy source.


-export([confirm/0]).
-include_lib("erlcloud/include/erlcloud_aws.hrl").
-include_lib("eunit/include/eunit.hrl").

-define(TEST_BUCKET, "legacy-s3-rewrite-test").

confirm() ->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd be good if this test includes the exact case where the problem happened, like:

  • put key "foo bar" with content "foo bar"
  • put key "foo+bar" with content "foo+bar"
  • read "foo bar" and "foo+bar" and verify they have different content

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's about testing legacy code, so I'd say this is enough to test old behaviour.

%% NOTE: This 'cs_src_root' path must appear in
%% ~/.riak_test.config in the 'rt_cs_dev' section, 'src_paths'
%% subsection.
CsSrcDir = rt_cs_dev:srcpath(cs_src_root),
lager:debug("cs_src_root = ~p", [CsSrcDir]),

{UserConfig, {RiakNodes, _CSNodes, _Stanchion}} = rtcs:setup(1, [{cs, cs_config()}]),
ok = erlcloud_s3:create_bucket(?TEST_BUCKET, UserConfig),
CsPortStr = integer_to_list(rtcs:cs_port(hd(RiakNodes))),

Cmd = os:find_executable("make"),
Args = ["test-python"],
Env = [{"CS_HTTP_PORT", CsPortStr},
{"AWS_ACCESS_KEY_ID", UserConfig#aws_config.access_key_id},
{"AWS_SECRET_ACCESS_KEY", UserConfig#aws_config.secret_access_key},
{"CS_BUCKET", ?TEST_BUCKET}],
case execute_cmd(Cmd, [{cd, CsSrcDir}, {env, Env}, {args, Args}]) of
ok ->
pass;
{error, Reason} ->
lager:error("Error : ~p", [Reason]),
error({external_client_tests, Reason})
end.

execute_cmd(Cmd, Opts) ->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd recommend just using rt_cs_dev:cmd/2 instead.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't like duplicate code ^^;

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rt_cs_dev:cmd/2 doesn't look suitable for this case because it doesn't handle exit code, or output log until the command finishes.I'd like to extract these function to rtcs module.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And also in master branch, rt_cs_dev:cmd/2 does.

lager:info("Command: ~s", [Cmd]),
lager:info("Options: ~p", [Opts]),
Port = open_port({spawn_executable, Cmd},
[in, exit_status, binary,
stream, stderr_to_stdout,{line, 200} | Opts]),
get_cmd_result(Port).

get_cmd_result(Port) ->
WaitTime = rt_config:get(rt_max_wait_time),
receive
{Port, {data, {Flag, Line}}} when Flag =:= eol orelse Flag =:= noeol ->
lager:info(Line),
get_cmd_result(Port);
{Port, {exit_status, 0}} ->
ok;
{Port, {exit_status, Status}} ->
{error, {exit_status, Status}};
{Port, Other} ->
lager:warning("Other data from port: ~p", [Other]),
get_cmd_result(Port)
after WaitTime * 2 ->
{error, timeout}
end.

cs_config() ->
[
rtcs:lager_config(),
{riak_cs,
[
{proxy_get, enabled},
{anonymous_user_creation, true},
{riak_pb_port, 10017},
{stanchion_port, 9095},
{cs_version, 010300},
{enforce_multipart_part_size, false},
{max_buckets_per_user, 150},
{rewrite_module, riak_cs_s3_rewrite_legacy}
]
}].
231 changes: 18 additions & 213 deletions src/riak_cs_s3_rewrite.erl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%% ---------------------------------------------------------------------
%%
%% Copyright (c) 2007-2013 Basho Technologies, Inc. All Rights Reserved.
%% Copyright (c) 2007-2015 Basho Technologies, Inc. All Rights Reserved.
%%
%% This file is provided to you under the Apache License,
%% Version 2.0 (the "License"); you may not use this file
Expand All @@ -21,14 +21,14 @@
-module(riak_cs_s3_rewrite).

-export([rewrite/5, original_resource/1]).
-export([rewrite_path_and_headers/5]).

-include("riak_cs.hrl").
-include("s3_api.hrl").

-define(RCS_REWRITE_HEADER, "x-rcs-rewrite-path").

-ifdef(TEST).
-include_lib("eunit/include/eunit.hrl").
-compile(export_all).
-endif.

Expand All @@ -41,19 +41,8 @@
{gb_tree(), string()}.
rewrite(Method, _Scheme, _Vsn, Headers, Url) ->
riak_cs_dtrace:dt_wm_entry(?MODULE, <<"rewrite">>),
Host = mochiweb_headers:get_value("host", Headers),
HostBucket = bucket_from_host(Host),
{Path, QueryString, _} = mochiweb_util:urlsplit_path(Url),
%% Unquote the path to accomodate some naughty client libs (looking
%% at you Fog)
RewrittenPath = rewrite_path(Method,
mochiweb_util:unquote(Path),
QueryString,
HostBucket),
RewrittenHeaders = mochiweb_headers:default(?RCS_REWRITE_HEADER,
rcs_rewrite_header(Url, HostBucket),
Headers),
{RewrittenHeaders, RewrittenPath}.
rewrite_path_and_headers(Method, Headers, Url, Path, QueryString).

-spec original_resource(term()) -> undefined | {string(), [{term(),term()}]}.
original_resource(RD) ->
Expand All @@ -64,6 +53,21 @@ original_resource(RD) ->
{Path, mochiweb_util:parse_qs(QS)}
end.

-spec rewrite_path_and_headers(atom(), gb_tree(), string(), string(), string()) ->
{gb_tree(), string()}.
rewrite_path_and_headers(Method, Headers, Url, Path, QueryString) ->
Host = mochiweb_headers:get_value("host", Headers),
HostBucket = bucket_from_host(Host),
RewrittenPath = rewrite_path(Method,
Path,
QueryString,
HostBucket),
RewrittenHeaders = mochiweb_headers:default(?RCS_REWRITE_HEADER,
rcs_rewrite_header(Url, HostBucket),
Headers),
{RewrittenHeaders, RewrittenPath}.


%% @doc Internal function to handle rewriting the URL
-spec rewrite_path(atom(),string(), string(), undefined | string()) -> string().
rewrite_path(_Method, "/", _QS, undefined) ->
Expand Down Expand Up @@ -210,202 +214,3 @@ get_subresources(QueryString) ->
valid_subresource({Key, _}) ->
lists:member(Key, ?SUBRESOURCES).


%% ===================================================================
%% Eunit tests
%% ===================================================================

-ifdef(TEST).

rstr_test() ->
?assertEqual("foo." ++ ?ROOT_HOST,
bucket_from_host("foo." ++ ?ROOT_HOST ++ "." ++ ?ROOT_HOST,
?ROOT_HOST)).

rewrite_path_test() ->
application:set_env(riak_cs, cs_root_host, ?ROOT_HOST),
%% List Buckets URL
equal_paths("/buckets",
rewrite_with(headers([]), "/")),
%% Bucket Operations
equal_paths("/buckets/testbucket/objects",
rewrite_with('GET', headers([]),
"/testbucket")),
equal_paths("/buckets/testbucket/objects",
rewrite_with('GET', headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/")),
equal_paths("/buckets/testbucket/objects?max-keys=20&delimiter=%2F&prefix=123",
rewrite_with('GET', headers([]),
"/testbucket?prefix=123&delimiter=/&max-keys=20")),
equal_paths("/buckets/testbucket/objects?max-keys=20&delimiter=%2F&prefix=123",
rewrite_with('GET', headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/?prefix=123&delimiter=/&max-keys=20")),
equal_paths("/buckets/testbucket",
rewrite_with('HEAD', headers([]), "/testbucket")),
equal_paths("/buckets/testbucket",
rewrite_with('HEAD', headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/")),
equal_paths("/buckets/testbucket",
rewrite_with('PUT', headers([]),
"/testbucket")),
equal_paths("/buckets/testbucket",
rewrite_with('PUT', headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/")),
equal_paths("/buckets/testbucket",
rewrite_with('DELETE', headers([]),
"/testbucket")),
equal_paths("/buckets/testbucket",
rewrite_with('DELETE', headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/")),
equal_paths("/buckets/testbucket/acl",
rewrite_with(headers([]), "/testbucket?acl")),
equal_paths("/buckets/testbucket/acl",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/?acl")),
equal_paths("/buckets/testbucket/location",
rewrite_with(headers([]), "/testbucket?location")),
equal_paths("/buckets/testbucket/location",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/?location")),
equal_paths("/buckets/testbucket/versioning",
rewrite_with(headers([]), "/testbucket?versioning")),
equal_paths("/buckets/testbucket/versioning",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/?versioning")),
equal_paths("/buckets/testbucket/policy",
rewrite_with(headers([]),
"/testbucket?policy")),
equal_paths("/buckets/testbucket/policy",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/?policy")),
equal_paths("/buckets/testbucket/uploads",
rewrite_with(headers([]),
"/testbucket?uploads")),
equal_paths("/buckets/testbucket/uploads",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/?uploads")),
equal_paths("/buckets/testbucket/uploads?delimiter=D&prefix=ABC&max-uploads=10"
"&key-marker=bob&upload-id-marker=blah",
rewrite_with(headers([]),
"/testbucket?uploads&upload-id-marker=blah&key-marker=bob"
"&max-uploads=10&prefix=ABC&delimiter=D")),
equal_paths("/buckets/testbucket/uploads?delimiter=D&prefix=ABC&max-uploads=10"
"&key-marker=bob&upload-id-marker=blah",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/?uploads&upload-id-marker=blah&key-marker=bob"
"&max-uploads=10&prefix=ABC&delimiter=D")),
equal_paths("/buckets/testbucket/delete",
rewrite_with('POST', headers([]),
"/testbucket/?delete")),
equal_paths("/buckets/testbucket/delete",
rewrite_with('POST', headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/?delete")),
%% Object Operations
equal_paths("/buckets/testbucket/objects/testobject",
rewrite_with(headers([]),
"/testbucket/testobject")),
equal_paths("/buckets/testbucket/objects/testdir%2F",
rewrite_with(headers([]),
"/testbucket/testdir/")),
equal_paths("/buckets/testbucket/objects/testdir%2Ftestobject",
rewrite_with(headers([]),
"/testbucket/testdir/testobject")),
equal_paths("/buckets/testbucket/objects/testobject",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testobject")),
equal_paths("/buckets/testbucket/objects/testdir%2F",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testdir/")),
equal_paths("/buckets/testbucket/objects/testdir%2Ftestobject",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testdir/testobject")),
equal_paths("/buckets/testbucket/objects/testobject/acl",
rewrite_with(headers([]),
"/testbucket/testobject?acl")),
equal_paths("/buckets/testbucket/objects/testdir%2F/acl",
rewrite_with(headers([]),
"/testbucket/testdir/?acl")),
equal_paths("/buckets/testbucket/objects/testdir%2Ftestobject/acl",
rewrite_with(headers([]),
"/testbucket/testdir/testobject?acl")),
equal_paths("/buckets/testbucket/objects/testobject/acl",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testobject?acl")),
equal_paths("/buckets/testbucket/objects/testdir%2F/acl",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testdir/?acl")),
equal_paths("/buckets/testbucket/objects/testdir%2Ftestobject/acl",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testdir/testobject?acl")),
equal_paths("/buckets/testbucket/objects/testobject/uploads",
rewrite_with(headers([]),
"/testbucket/testobject?uploads")),
equal_paths("/buckets/testbucket/objects/testobject/uploads",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testobject?uploads")),
equal_paths("/buckets/testbucket/objects/testobject/uploads/2",
rewrite_with(headers([]),
"/testbucket/testobject?uploadId=2")),
equal_paths("/buckets/testbucket/objects/testobject/uploads/2",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testobject?uploadId=2")),
equal_paths("/buckets/testbucket/objects/testobject/uploads/2?partNumber=1",
rewrite_with(headers([]),
"/testbucket/testobject?partNumber=1&uploadId=2")),
equal_paths("/buckets/testbucket/objects/testobject/uploads/2?partNumber=1",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testobject?partNumber=1&uploadId=2")),
equal_paths("/buckets/testbucket/objects/testobject/uploads/2?AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR"
"&Expires=1364406757&Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D",
rewrite_with(headers([]),
"/testbucket/testobject?Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D"
"&Expires=1364406757&AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR&uploadId=2")),
equal_paths("/buckets/testbucket/objects/testobject/uploads/2?AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR"
"&Expires=1364406757&Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testobject?Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D"
"&Expires=1364406757&AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR&uploadId=2")),
equal_paths("/buckets/testbucket/objects/testobject/uploads/2?AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR"
"&Expires=1364406757&Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D&partNumber=1",
rewrite_with(headers([]),
"/testbucket/testobject?Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D"
"&Expires=1364406757&AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR&partNumber=1&uploadId=2")),
equal_paths("/buckets/testbucket/objects/testobject/uploads/2?AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR"
"&Expires=1364406757&Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D&partNumber=1",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testobject?Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D"
"&Expires=1364406757&AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR&partNumber=1&uploadId=2")),
equal_paths("/buckets/testbucket/objects/testobject?AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR"
"&Expires=1364406757&Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D",
rewrite_with(headers([]),
"/testbucket/testobject?Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D"
"&Expires=1364406757&AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR")),
equal_paths("/buckets/testbucket/objects/testobject?AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR"
"&Expires=1364406757&Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D",
rewrite_with(headers([{"host", "testbucket." ++ ?ROOT_HOST}]),
"/testobject?Signature=x%2B0vteNN1YillZNw4yDGVQWrT2s%3D"
"&Expires=1364406757&AWSAccessKeyId=BF_BI8XYKFJSIW-NNAIR")).

rewrite_header_test() ->
Path = "/testbucket?y=z&a=b&m=n",
{Headers, _} = rewrite_with(headers([]), Path),
?assertEqual(Path, mochiweb_headers:get_value(?RCS_REWRITE_HEADER, Headers)).


%% Helper function for eunit tests
headers(HeadersList) ->
mochiweb_headers:make(HeadersList).

equal_paths(EPath, {_RHeaders, RPath}) ->
?assertEqual(EPath, RPath).


rewrite_with(Headers, Path) ->
rewrite_with('GET', Headers, Path).

rewrite_with(Method, Headers, Path) ->
Scheme = https,
Version = {1, 1},
rewrite(Method, Scheme, Version, Headers, Path).

-endif.
Loading