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

Add aws_rds_iam_token utlity module for creating rds iam tokens for authenticating over IAM towards RDS or Aurora #155

Merged
Show file tree
Hide file tree
Changes from all 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
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,18 @@ through the `aws_s3_presigned_url` module.
#{<<"HasMoreStreams">> => false,<<"StreamNames">> => []}
```

### AWS RDS IAM Token Creation
Support for creating IAM Tokens (more info [here](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Connecting.html)) has been added as part of the `aws_rds_iam_token` module.
This allows for easy creation of RDS/Aurora tokens to be used for IAM based authentication instead of username/password combination.
```erlang
> Client = aws_client:make_temporary_client(<<"AccessKeyID">>, <<"SecretAccessKey">>, <<"Token">>, <<"eu-west-1">>).
[...]
> {ok, Url} = create(Client, <<"db_endpoint">>, 5432, <<"db_user">>).
jadeallenx marked this conversation as resolved.
Show resolved Hide resolved
[...]
```

This token can subsequently be used to connect to the database over IAM.

### retry options

Each API which takes `Options` allows a `retry_options` key and can allow for automatic retries.
Expand Down
67 changes: 67 additions & 0 deletions src/aws_rds_iam_token.erl
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
-module(aws_rds_iam_token).
-export([rds_token_create/4]).

-define(SIGNING_ID, <<"rds-db">>).
-define(EMPTY_PAYLOAD_HASH, <<"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855">>).

%%====================================================================
%% API
%%====================================================================
-spec rds_token_create(aws_client:aws_client(), binary(), non_neg_integer(), binary()) -> {ok, binary()}.
rds_token_create(Client, DBEndpoint, DBPort, DBUser) when is_map(Client) andalso
is_binary(DBEndpoint) andalso
is_integer(DBPort) andalso
is_binary(DBUser) ->
Method = <<"GET">>,
QueryParams = [{<<"Action">>, <<"connect">>}, {<<"DBUser">>, DBUser}],
Endpoint = <<"https://", DBEndpoint/binary, ":", (integer_to_binary(DBPort))/binary>>,
Url = aws_request:add_query(Endpoint, QueryParams),
AccessKeyID = aws_client:access_key_id(Client),
SecurityToken = aws_client:token(Client),
SecretAccessKey = aws_client:secret_access_key(Client),
Region = aws_client:region(Client),
Now = calendar:universal_time(),
Options0 = [ {ttl, timer:minutes(15) div 1000} %% Time in seconds
, {body_digest, ?EMPTY_PAYLOAD_HASH}
, {uri_encode_path, false} %% We already encode in build_path/4
],
Options = case SecurityToken of
undefined ->
Options0;
_ ->
[{session_token, hackney_url:urlencode(SecurityToken)} | Options0]
end,
<<"https://", SignedUrl/binary>> = aws_signature:sign_v4_query_params(AccessKeyID, SecretAccessKey, Region, ?SIGNING_ID, Now, Method, Url, Options),
{ok, SignedUrl}.

%%====================================================================
%% Unit tests
%%====================================================================

-ifdef(TEST).

-include_lib("eunit/include/eunit.hrl").
-include_lib("hackney/include/hackney_lib.hrl").

fetch_auth_token_test() ->
Client = aws_client:make_temporary_client(<<"AccessKeyID">>, <<"SecretAccessKey">>,
<<"Token">>, <<"eu-west-1">>),
{ok, Url} = rds_token_create(Client, <<"db_endpoint">>, 5432, <<"db_user">>),
HackneyUrl = hackney_url:parse_url(Url),
ParsedQs = hackney_url:parse_qs(HackneyUrl#hackney_url.qs),
Credential = proplists:get_value(<<"X-Amz-Credential">>, ParsedQs),
[AccessKeyId, _ShortDate, Region, Service, Request] = binary:split(Credential, <<"/">>, [global]),
?assertEqual(5432, HackneyUrl#hackney_url.port),
?assertEqual("db_endpoint", HackneyUrl#hackney_url.host),
?assertEqual(<<"">>, HackneyUrl#hackney_url.path),
?assertEqual(9, length(ParsedQs)),
?assertEqual(<<"AccessKeyID">>, AccessKeyId),
?assertEqual(<<"eu-west-1">>, Region),
?assertEqual(<<"rds-db">>, Service),
?assertEqual(<<"aws4_request">>, Request),
?assertEqual(<<"AWS4-HMAC-SHA256">>, proplists:get_value(<<"X-Amz-Algorithm">>, ParsedQs)),
?assertEqual(<<"900">>, proplists:get_value(<<"X-Amz-Expires">>, ParsedQs)),
?assertEqual(<<"Token">>, proplists:get_value(<<"X-Amz-Security-Token">>, ParsedQs)),
?assertEqual(<<"host">>, proplists:get_value(<<"X-Amz-SignedHeaders">>, ParsedQs)).

-endif.
Loading