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.

Sign up for GitHub

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

Add separate docs tarball limits and support infinity #143

Merged
merged 5 commits into from
Feb 29, 2024
Merged

Add separate docs tarball limits and support infinity #143

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fae27c4
Add separate docs tarball limits
wojtekmach Feb 29, 2024
30cd3e4
Support undefined
wojtekmach Feb 29, 2024
8b7d9f2
up
wojtekmach Feb 29, 2024
689ad41
up
wojtekmach Feb 29, 2024
5e5a838
up
wojtekmach Feb 29, 2024
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
22 changes: 19 additions & 3 deletions src/hex_core.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,18 @@
%%
%% * `repo_verify_origin' - If `true' will verify the repository signature origin,
%% requires protobuf messages as of hex_core v0.4.0 (default: `true').
%%
%% * `tarball_max_size' - Maximum size of package tarball, defaults to
%% `8_388_608' (8 MiB). Set to `undefined' to not enforce the limit.
%%
%% * `tarball_max_uncompressed_size' - Maximum size of uncompressed package tarball, defaults to
%% `67_108_864' (64 MiB). Set to `undefined' to not enforce the limit.
%%
%% * `docs_tarball_max_size' - Maximum size of docs tarball, defaults to
%% `16_777_216' (16 MiB). Set to `undefined' to not enforce the limit.
%%
%% * `docs_tarball_max_uncompressed_size' - Maximum size of uncompressed docs tarball, defaults to
%% `134_217_728' (128 MiB). Set to `undefined' to not enforce the limit.

-module(hex_core).
-export([default_config/0]).
Expand Down Expand Up @@ -81,8 +93,10 @@
repo_organization => binary() | undefined,
repo_verify => boolean(),
repo_verify_origin => boolean(),
tarball_max_size => pos_integer(),
tarball_max_uncompressed_size => pos_integer()
tarball_max_size => pos_integer() | undefined,
tarball_max_uncompressed_size => pos_integer() | undefined,
docs_tarball_max_size => pos_integer() | undefined,
docs_tarball_max_uncompressed_size => pos_integer() | undefined
}.

-spec default_config() -> config().
Expand All @@ -104,5 +118,7 @@ default_config() ->
repo_verify => true,
repo_verify_origin => true,
tarball_max_size => 8 * 1024 * 1024,
tarball_max_uncompressed_size => 64 * 1024 * 1024
tarball_max_uncompressed_size => 64 * 1024 * 1024,
docs_tarball_max_size => 16 * 1024 * 1024,
docs_tarball_max_uncompressed_size => 128 * 1024 * 1024
}.
115 changes: 68 additions & 47 deletions src/hex_tarball.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@
}}
| {error, term()}.
create(Metadata, Files, Config) ->
#{
tarball_max_size := TarballMaxSize,
tarball_max_uncompressed_size := TarballMaxUncompressedSize
} = Config,

MetadataBinary = encode_metadata(Metadata),
ContentsTarball = create_memory_tarball(Files),
ContentsTarballCompressed = gzip(ContentsTarball),
Expand All @@ -73,20 +78,23 @@ create(Metadata, Files, Config) ->
{"contents.tar.gz", ContentsTarballCompressed}
],

Tarball = create_memory_tarball(OuterFiles),
OuterChecksum = checksum(Tarball),

UncompressedSize = byte_size(ContentsTarball),

case {(byte_size(Tarball) > TarballMaxSize), (UncompressedSize > TarballMaxUncompressedSize)} of
{_, true} ->
{error, {tarball, {too_big_uncompressed, TarballMaxUncompressedSize}}};
{true, _} ->
{error, {tarball, {too_big_compressed, TarballMaxSize}}};
{false, false} ->
{ok, #{
tarball => Tarball, outer_checksum => OuterChecksum, inner_checksum => InnerChecksum
}}
case valid_size(ContentsTarball, TarballMaxUncompressedSize) of
true ->
Tarball = create_memory_tarball(OuterFiles),
OuterChecksum = checksum(Tarball),

case valid_size(Tarball, TarballMaxSize) of
true ->
{ok, #{
tarball => Tarball,
outer_checksum => OuterChecksum,
inner_checksum => InnerChecksum
}};
false ->
{error, {tarball, {too_big_compressed, TarballMaxSize}}}
end;
false ->
{error, {tarball, {too_big_uncompressed, TarballMaxUncompressedSize}}}
end.

-spec create(metadata(), files()) ->
Expand All @@ -111,21 +119,26 @@ create(Metadata, Files) ->
%% '''
%% @end
-spec create_docs(files(), hex_core:config()) -> {ok, tarball()} | {error, term()}.
create_docs(Files, #{
tarball_max_size := TarballMaxSize, tarball_max_uncompressed_size := TarballMaxUncompressedSize
}) ->
create_docs(Files, Config) ->
#{
docs_tarball_max_size := TarballMaxSize,
docs_tarball_max_uncompressed_size := TarballMaxUncompressedSize
} = Config,

UncompressedTarball = create_memory_tarball(Files),
UncompressedSize = byte_size(UncompressedTarball),
Tarball = gzip(UncompressedTarball),
Size = byte_size(Tarball),

case {(Size > TarballMaxSize), (UncompressedSize > TarballMaxUncompressedSize)} of
{_, true} ->
{error, {tarball, {too_big_uncompressed, TarballMaxUncompressedSize}}};
{true, _} ->
{error, {tarball, {too_big_compressed, TarballMaxSize}}};
{false, false} ->
{ok, Tarball}

case valid_size(UncompressedTarball, TarballMaxUncompressedSize) of
true ->
Tarball = gzip(UncompressedTarball),

case valid_size(Tarball, TarballMaxSize) of
true ->
{ok, Tarball};
false ->
{error, {tarball, {too_big_compressed, TarballMaxSize}}}
end;
false ->
{error, {tarball, {too_big_uncompressed, TarballMaxUncompressedSize}}}
end.

-spec create_docs(files()) -> {ok, tarball()}.
Expand Down Expand Up @@ -166,19 +179,20 @@ create_docs(Files) ->
metadata => metadata()
}}
| {error, term()}.
unpack(Tarball, _, #{tarball_max_size := TarballMaxSize}) when
byte_size(Tarball) > TarballMaxSize
->
{error, {tarball, too_big}};
unpack(Tarball, Output, _Config) ->
case hex_erl_tar:extract({binary, Tarball}, [memory]) of
{ok, []} ->
{error, {tarball, empty}};
{ok, FileList} ->
OuterChecksum = crypto:hash(sha256, Tarball),
do_unpack(maps:from_list(FileList), OuterChecksum, Output);
{error, Reason} ->
{error, {tarball, Reason}}
unpack(Tarball, Output, Config) ->
case valid_size(Tarball, maps:get(tarball_max_size, Config)) of
true ->
case hex_erl_tar:extract({binary, Tarball}, [memory]) of
{ok, []} ->
{error, {tarball, empty}};
{ok, FileList} ->
OuterChecksum = crypto:hash(sha256, Tarball),
do_unpack(maps:from_list(FileList), OuterChecksum, Output);
{error, Reason} ->
{error, {tarball, Reason}}
end;
false ->
{error, {tarball, too_big}}
end.

%% @doc
Expand Down Expand Up @@ -219,12 +233,13 @@ unpack(Tarball, Output) ->
-spec unpack_docs
(tarball(), memory, hex_core:config()) -> {ok, contents()} | {error, term()};
(tarball(), filename(), hex_core:config()) -> ok | {error, term()}.
unpack_docs(Tarball, _, #{tarball_max_size := TarballMaxSize}) when
byte_size(Tarball) > TarballMaxSize
->
{error, {tarball, too_big}};
unpack_docs(Tarball, Output, _Config) ->
unpack_tarball(Tarball, Output).
unpack_docs(Tarball, Output, Config) ->
case valid_size(Tarball, maps:get(docs_tarball_max_size, Config)) of
true ->
unpack_tarball(Tarball, Output);
false ->
{error, {tarball, too_big}}
end.

-spec unpack_docs
(tarball(), memory) -> {ok, contents()} | {error, term()};
Expand Down Expand Up @@ -601,6 +616,12 @@ gzip_no_header(Uncompressed) ->
%% Helpers
%%====================================================================

%% @private
valid_size(Binary, undefined) when is_binary(Binary) ->
Copy link
Member Author

Choose a reason for hiding this comment

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

another idea is to call the sentinel value infinity:

Suggested change
valid_size(Binary, undefined) when is_binary(Binary) ->
valid_size(Binary, infinity) when is_binary(Binary) ->

but perhaps undefined is more often used for things like this.

Copy link
Member

Choose a reason for hiding this comment

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

I like infinity more 👍

true;
valid_size(Binary, Limit) when is_binary(Binary) ->
byte_size(Binary) =< Limit.

%% @private
binarify(Binary) when is_binary(Binary) -> Binary;
binarify(Number) when is_number(Number) -> Number;
Expand Down
6 changes: 3 additions & 3 deletions test/hex_tarball_SUITE.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,17 +328,17 @@ unpack_error_handling_test(_Config) ->

docs_too_big_to_create_test(_Config) ->
Files = [{"index.html", <<"Docs">>}],
Config = maps:put(tarball_max_size, 100, hex_core:default_config()),
Config = maps:put(docs_tarball_max_size, 100, hex_core:default_config()),
{error, {tarball, {too_big_compressed, 100}}} = hex_tarball:create_docs(Files, Config),
Config1 = maps:put(tarball_max_uncompressed_size, 100, hex_core:default_config()),
Config1 = maps:put(docs_tarball_max_uncompressed_size, 100, hex_core:default_config()),
{error, {tarball, {too_big_uncompressed, 100}}} = hex_tarball:create_docs(Files, Config1),

ok.

docs_too_big_to_unpack_test(_Config) ->
Files = [{"index.html", <<"Docs">>}],
{ok, Tarball} = hex_tarball:create_docs(Files),
Config = maps:put(tarball_max_size, 100, hex_core:default_config()),
Config = maps:put(docs_tarball_max_size, 100, hex_core:default_config()),
{error, {tarball, too_big}} = hex_tarball:unpack_docs(Tarball, memory, Config),

ok.
Expand Down
Loading