1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
%% This Source Code Form is subject to the terms of the Mozilla Public
%% License, v. 2.0. If a copy of the MPL was not distributed with this
%% file, You can obtain one at https://mozilla.org/MPL/2.0/.
%%
%% Copyright (c) 2007-2023 VMware, Inc. or its affiliates. All rights reserved.
%%
-module(amqp_uri).
-include("amqp_client.hrl").
-export([parse/1, parse/2, remove_credentials/1]).
%%---------------------------------------------------------------------------
%% AMQP URI Parsing
%%---------------------------------------------------------------------------
%% Reformat a URI to remove authentication secrets from it (before we
%% log it or display it anywhere).
-spec remove_credentials(URI :: string() | binary()) -> string().
remove_credentials(URI) ->
UriString = rabbit_data_coercion:to_list(URI),
Props = uri_parser:parse(UriString,
[{host, undefined}, {path, undefined},
{port, undefined}, {'query', []}]),
PortPart = case proplists:get_value(port, Props) of
undefined -> "";
Port -> rabbit_misc:format(":~B", [Port])
end,
PGet = fun(K, P) -> case proplists:get_value(K, P) of
undefined -> "";
R -> R
end
end,
rabbit_misc:format(
"~s://~s~s~s", [proplists:get_value(scheme, Props), PGet(host, Props),
PortPart, PGet(path, Props)]).
%% @spec (Uri) -> {ok, #amqp_params_network{} | #amqp_params_direct{}} |
%% {error, {Info, Uri}}
%% where
%% Uri = string()
%% Info = any()
%%
%% @doc Parses an AMQP URI. If any of the URI parts are missing, the
%% default values are used. If the hostname is zero-length, an
%% #amqp_params_direct{} record is returned; otherwise, an
%% #amqp_params_network{} record is returned. Extra parameters may be
%% specified via the query string
%% (e.g. "?heartbeat=5&auth_mechanism=external"). In case of failure,
%% an {error, {Info, Uri}} tuple is returned.
%%
%% The extra parameters that may be specified are channel_max,
%% frame_max, heartbeat and auth_mechanism (the latter can appear more
%% than once). The extra parameters that may be specified for an SSL
%% connection are cacertfile, certfile, keyfile, verify,
%% fail_if_no_peer_cert, password, and depth.
-type parse_result() :: {ok, #amqp_params_network{}} |
{ok, #amqp_params_direct{}} |
{error, {any(), string()}}.
-spec parse(Uri :: string() | binary()) -> parse_result().
parse(Uri) -> parse(Uri, <<"/">>).
-spec parse(Uri :: string() | binary(), DefaultVHost :: binary()) -> parse_result().
parse(Uri, DefaultVHost) ->
try return(parse1(Uri, DefaultVHost))
catch throw:Err -> {error, {Err, Uri}};
error:Err -> {error, {Err, Uri}}
end.
parse1(Uri, DefaultVHost) when is_list(Uri); is_binary(Uri) ->
UriString = rabbit_data_coercion:to_list(Uri),
case uri_parser:parse(UriString, [{host, undefined}, {path, undefined},
{port, undefined}, {'query', []}]) of
{error, Err} ->
throw({unable_to_parse_uri, Err});
Parsed ->
Endpoint =
case string:to_lower(proplists:get_value(scheme, Parsed)) of
"amqp" -> build_broker(Parsed, DefaultVHost);
"amqps" -> build_ssl_broker(Parsed, DefaultVHost);
Scheme -> fail({unexpected_uri_scheme, Scheme})
end,
return({ok, broker_add_query(Endpoint, Parsed)})
end;
parse1(_, _DefaultVHost) ->
fail(expected_string_uri).
unescape_string(Atom) when is_atom(Atom) ->
Atom;
unescape_string(Integer) when is_integer(Integer) ->
Integer;
unescape_string([]) ->
[];
unescape_string([$%, N1, N2 | Rest]) ->
try
[erlang:list_to_integer([N1, N2], 16) | unescape_string(Rest)]
catch
error:badarg -> throw({invalid_entitiy, ['%', N1, N2]})
end;
unescape_string([$% | Rest]) ->
fail({unterminated_entity, ['%' | Rest]});
unescape_string([C | Rest]) ->
[C | unescape_string(Rest)].
build_broker(ParsedUri, DefaultVHost) ->
[Host, Port, Path] =
[proplists:get_value(F, ParsedUri) || F <- [host, port, path]],
case Port =:= undefined orelse (0 < Port andalso Port =< 65535) of
true -> ok;
false -> fail({port_out_of_range, Port})
end,
VHost = case Path of
undefined -> DefaultVHost;
[$/|Rest] -> case string:chr(Rest, $/) of
0 -> list_to_binary(unescape_string(Rest));
_ -> fail({invalid_vhost, Rest})
end
end,
UserInfo = proplists:get_value(userinfo, ParsedUri),
Record = case {unescape_string(Host), Port} of
{undefined, undefined} ->
#amqp_params_direct{virtual_host = VHost};
{undefined, _Port} ->
fail(port_requires_host);
{Host1, Port1} ->
Mech = mechanisms(ParsedUri),
#amqp_params_network{host = Host1,
port = Port1,
virtual_host = VHost,
auth_mechanisms = Mech}
end,
set_user_info(Record, UserInfo).
set_user_info(Ps, UserInfo) ->
case UserInfo of
[U, P | _] -> set([{username, list_to_binary(unescape_string(U))},
{password, list_to_binary(unescape_string(P))}], Ps);
[U] -> set([{username, list_to_binary(unescape_string(U))}], Ps);
[] -> Ps
end.
set(KVs, Ps = #amqp_params_direct{}) ->
set(KVs, Ps, record_info(fields, amqp_params_direct));
set(KVs, Ps = #amqp_params_network{}) ->
set(KVs, Ps, record_info(fields, amqp_params_network)).
set(KVs, Ps, Fields) ->
{Ps1, _Ix} = lists:foldl(fun (Field, {PsN, Ix}) ->
{case lists:keyfind(Field, 1, KVs) of
false -> PsN;
{_, V} -> setelement(Ix, PsN, V)
end, Ix + 1}
end, {Ps, 2}, Fields),
Ps1.
build_ssl_broker(ParsedUri, DefaultVHost) ->
Params0 = build_broker(ParsedUri, DefaultVHost),
Query = proplists:get_value('query', ParsedUri),
SSLOptions =
run_state_monad(
[fun (L) -> KeyString = atom_to_list(Key),
case lists:keysearch(KeyString, 1, Query) of
{value, {_, Value}} ->
try return([{Key, unescape_string(Fun(Value))} | L])
catch throw:Reason ->
fail({invalid_ssl_parameter,
Key, Value, Query, Reason})
end;
false ->
L
end
end || {Fun, Key} <-
[{fun find_path_parameter/1, cacertfile},
{fun find_path_parameter/1, certfile},
{fun find_path_parameter/1, keyfile},
{fun find_atom_parameter/1, verify},
{fun find_boolean_parameter/1, fail_if_no_peer_cert},
{fun find_identity_parameter/1, password},
{fun find_sni_parameter/1, server_name_indication},
{fun find_integer_parameter/1, depth}]],
[]),
Params1 = Params0#amqp_params_network{ssl_options = SSLOptions},
amqp_ssl:maybe_enhance_ssl_options(Params1).
broker_add_query(Params = #amqp_params_direct{}, Uri) ->
broker_add_query(Params, Uri, record_info(fields, amqp_params_direct));
broker_add_query(Params = #amqp_params_network{}, Uri) ->
broker_add_query(Params, Uri, record_info(fields, amqp_params_network)).
broker_add_query(Params, ParsedUri, Fields) ->
Query = proplists:get_value('query', ParsedUri),
{Params1, _Pos} =
run_state_monad(
[fun ({ParamsN, Pos}) ->
Pos1 = Pos + 1,
KeyString = atom_to_list(Field),
case proplists:get_value(KeyString, Query) of
undefined ->
return({ParamsN, Pos1});
true -> %% proplists short form, not permitted
return({ParamsN, Pos1});
Value ->
try
case parse_amqp_param(Field, Value) of
ignore ->
return({ParamsN, Pos1});
ValueParsed ->
return({setelement(Pos, ParamsN, ValueParsed), Pos1})
end
catch throw:Reason ->
fail({invalid_amqp_params_parameter,
Field, Value, Query, Reason})
end
end
end || Field <- Fields], {Params, 2}),
Params1.
parse_amqp_param(Field, String) when Field =:= channel_max orelse
Field =:= frame_max orelse
Field =:= heartbeat orelse
Field =:= connection_timeout orelse
Field =:= depth ->
find_integer_parameter(String);
parse_amqp_param(Field, _String) when Field =:= password ->
%% https://github.com/rabbitmq/rabbitmq-server/issues/8129
%% Ignore `password` here since the parameter is used for setting a
%% certificate password, NOT an AMQP login password
return(ignore);
parse_amqp_param(Field, String) ->
fail({parameter_unconfigurable_in_query, Field, String}).
find_path_parameter(Value) ->
find_identity_parameter(Value).
find_sni_parameter("disable") ->
disable;
find_sni_parameter(Value) ->
find_identity_parameter(Value).
find_identity_parameter(Value) -> return(Value).
find_integer_parameter(Value) ->
try return(list_to_integer(Value))
catch error:badarg -> fail({not_an_integer, Value})
end.
find_boolean_parameter(Value) ->
Bool = list_to_atom(Value),
case is_boolean(Bool) of
true -> return(Bool);
false -> fail({require_boolean, Bool})
end.
find_atom_parameter(Value) -> return(list_to_atom(Value)).
mechanisms(ParsedUri) ->
Query = proplists:get_value('query', ParsedUri),
Mechanisms = case proplists:get_all_values("auth_mechanism", Query) of
[] -> ["plain", "amqplain"];
Mechs -> Mechs
end,
[case [list_to_atom(T) || T <- string:tokens(Mech, ":")] of
[F] -> fun (R, P, S) -> amqp_auth_mechanisms:F(R, P, S) end;
[M, F] -> fun (R, P, S) -> M:F(R, P, S) end;
L -> throw({not_mechanism, L})
end || Mech <- Mechanisms].
%% --=: Plain state monad implementation start :=--
run_state_monad(FunList, State) ->
lists:foldl(fun (Fun, StateN) -> Fun(StateN) end, State, FunList).
return(V) -> V.
-spec fail(_) -> no_return().
fail(Reason) -> throw(Reason).
%% --=: end :=--
|
