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
|
%% 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-2020 VMware, Inc. or its affiliates. All rights reserved.
%%
-module(rabbit_direct).
-export([boot/0, force_event_refresh/1, list/0, connect/5,
start_channel/10, disconnect/2]).
-deprecated([{force_event_refresh, 1, eventually}]).
%% Internal
-export([list_local/0]).
%% For testing only
-export([extract_extra_auth_props/4]).
-include("rabbit.hrl").
-include("rabbit_misc.hrl").
%%----------------------------------------------------------------------------
-spec boot() -> 'ok'.
boot() -> rabbit_sup:start_supervisor_child(
rabbit_direct_client_sup, rabbit_client_sup,
[{local, rabbit_direct_client_sup},
{rabbit_channel_sup, start_link, []}]).
-spec force_event_refresh(reference()) -> 'ok'.
force_event_refresh(Ref) ->
[Pid ! {force_event_refresh, Ref} || Pid <- list()],
ok.
-spec list_local() -> [pid()].
list_local() ->
pg_local:get_members(rabbit_direct).
-spec list() -> [pid()].
list() ->
Nodes = rabbit_nodes:all_running(),
rabbit_misc:append_rpc_all_nodes(Nodes, rabbit_direct, list_local, [], ?RPC_TIMEOUT).
%%----------------------------------------------------------------------------
auth_fun({none, _}, _VHost, _ExtraAuthProps) ->
fun () -> {ok, rabbit_auth_backend_dummy:user()} end;
auth_fun({Username, none}, _VHost, _ExtraAuthProps) ->
fun () -> rabbit_access_control:check_user_login(Username, []) end;
auth_fun({Username, Password}, VHost, ExtraAuthProps) ->
fun () ->
rabbit_access_control:check_user_login(
Username,
[{password, Password}, {vhost, VHost}] ++ ExtraAuthProps)
end.
-spec connect
(({'none', 'none'} | {rabbit_types:username(), 'none'} |
{rabbit_types:username(), rabbit_types:password()}),
rabbit_types:vhost(), rabbit_types:protocol(), pid(),
rabbit_event:event_props()) ->
rabbit_types:ok_or_error2(
{rabbit_types:user(), rabbit_framing:amqp_table()},
'broker_not_found_on_node' |
{'auth_failure', string()} | 'access_refused').
connect(Creds, VHost, Protocol, Pid, Infos) ->
ExtraAuthProps = extract_extra_auth_props(Creds, VHost, Pid, Infos),
AuthFun = auth_fun(Creds, VHost, ExtraAuthProps),
case rabbit:is_running() of
true ->
case whereis(rabbit_direct_client_sup) of
undefined ->
{error, broker_is_booting};
_ ->
case is_over_vhost_connection_limit(VHost, Creds, Pid) of
true ->
{error, not_allowed};
false ->
case is_vhost_alive(VHost, Creds, Pid) of
false ->
{error, {internal_error, vhost_is_down}};
true ->
case AuthFun() of
{ok, User = #user{username = Username}} ->
notify_auth_result(Username,
user_authentication_success, []),
connect1(User, VHost, Protocol, Pid, Infos);
{refused, Username, Msg, Args} ->
notify_auth_result(Username,
user_authentication_failure,
[{error, rabbit_misc:format(Msg, Args)}]),
{error, {auth_failure, "Refused"}}
end %% AuthFun()
end %% is_vhost_alive
end %% is_over_vhost_connection_limit
end;
false -> {error, broker_not_found_on_node}
end.
extract_extra_auth_props(Creds, VHost, Pid, Infos) ->
case extract_protocol(Infos) of
undefined ->
[];
Protocol ->
maybe_call_connection_info_module(Protocol, Creds, VHost, Pid, Infos)
end.
extract_protocol(Infos) ->
case proplists:get_value(protocol, Infos, undefined) of
{Protocol, _Version} ->
Protocol;
_ ->
undefined
end.
maybe_call_connection_info_module(Protocol, Creds, VHost, Pid, Infos) ->
Module = rabbit_data_coercion:to_atom(string:to_lower(
"rabbit_" ++
lists:flatten(string:replace(rabbit_data_coercion:to_list(Protocol), " ", "_", all)) ++
"_connection_info")
),
Args = [Creds, VHost, Pid, Infos],
code_server_cache:maybe_call_mfa(Module, additional_authn_params, Args, []).
is_vhost_alive(VHost, {Username, _Password}, Pid) ->
PrintedUsername = case Username of
none -> "";
_ -> Username
end,
case rabbit_vhost_sup_sup:is_vhost_alive(VHost) of
true -> true;
false ->
rabbit_log_connection:error(
"Error on Direct connection ~p~n"
"access to vhost '~s' refused for user '~s': "
"vhost '~s' is down",
[Pid, VHost, PrintedUsername, VHost]),
false
end.
is_over_vhost_connection_limit(VHost, {Username, _Password}, Pid) ->
PrintedUsername = case Username of
none -> "";
_ -> Username
end,
try rabbit_vhost_limit:is_over_connection_limit(VHost) of
false -> false;
{true, Limit} ->
rabbit_log_connection:error(
"Error on Direct connection ~p~n"
"access to vhost '~s' refused for user '~s': "
"vhost connection limit (~p) is reached",
[Pid, VHost, PrintedUsername, Limit]),
true
catch
throw:{error, {no_such_vhost, VHost}} ->
rabbit_log_connection:error(
"Error on Direct connection ~p~n"
"vhost ~s not found", [Pid, VHost]),
true
end.
notify_auth_result(Username, AuthResult, ExtraProps) ->
EventProps = [{connection_type, direct},
{name, case Username of none -> ''; _ -> Username end}] ++
ExtraProps,
rabbit_event:notify(AuthResult, [P || {_, V} = P <- EventProps, V =/= '']).
connect1(User = #user{username = Username}, VHost, Protocol, Pid, Infos) ->
case rabbit_auth_backend_internal:is_over_connection_limit(Username) of
false ->
% Note: peer_host can be either a tuple or
% a binary if reverse_dns_lookups is enabled
PeerHost = proplists:get_value(peer_host, Infos),
AuthzContext = proplists:get_value(variable_map, Infos, #{}),
try rabbit_access_control:check_vhost_access(User, VHost,
{ip, PeerHost}, AuthzContext) of
ok -> ok = pg_local:join(rabbit_direct, Pid),
rabbit_core_metrics:connection_created(Pid, Infos),
rabbit_event:notify(connection_created, Infos),
{ok, {User, rabbit_reader:server_properties(Protocol)}}
catch
exit:#amqp_error{name = Reason = not_allowed} ->
{error, Reason}
end;
{true, Limit} ->
rabbit_log_connection:error(
"Error on Direct connection ~p~n"
"access refused for user '~s': "
"user connection limit (~p) is reached",
[Pid, Username, Limit]),
{error, not_allowed}
end.
-spec start_channel
(rabbit_channel:channel_number(), pid(), pid(), string(),
rabbit_types:protocol(), rabbit_types:user(), rabbit_types:vhost(),
rabbit_framing:amqp_table(), pid(), any()) ->
{'ok', pid()}.
start_channel(Number, ClientChannelPid, ConnPid, ConnName, Protocol,
User = #user{username = Username}, VHost, Capabilities,
Collector, AmqpParams) ->
case rabbit_auth_backend_internal:is_over_channel_limit(Username) of
false ->
{ok, _, {ChannelPid, _}} =
supervisor2:start_child(
rabbit_direct_client_sup,
[{direct, Number, ClientChannelPid, ConnPid, ConnName, Protocol,
User, VHost, Capabilities, Collector, AmqpParams}]),
{ok, ChannelPid};
{true, Limit} ->
rabbit_log_connection:error(
"Error on direct connection ~p~n"
"number of channels opened for user '~s' has reached the "
"maximum allowed limit of (~w)",
[ConnPid, Username, Limit]),
{error, not_allowed}
end.
-spec disconnect(pid(), rabbit_event:event_props()) -> 'ok'.
disconnect(Pid, Infos) ->
pg_local:leave(rabbit_direct, Pid),
rabbit_core_metrics:connection_closed(Pid),
rabbit_event:notify(connection_closed, Infos).
|
