summaryrefslogtreecommitdiff
path: root/src/rabbit_auth_backend.erl
blob: 09820c5b118370f07f60c87e2d91f9d236b2120b (plain)
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
%% The contents of this file are subject to the Mozilla Public License
%% Version 1.1 (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.mozilla.org/MPL/
%%
%% Software distributed under the License is distributed on an "AS IS"
%% basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
%% the License for the specific language governing rights and
%% limitations under the License.
%%
%% The Original Code is RabbitMQ.
%%
%% The Initial Developer of the Original Code is VMware, Inc.
%% Copyright (c) 2007-2011 VMware, Inc.  All rights reserved.
%%

-module(rabbit_auth_backend).

-export([behaviour_info/1]).

behaviour_info(callbacks) ->
    [
     %% A description proplist as with auth mechanisms,
     %% exchanges. Currently unused.
     {description, 0},

     %% Check a user can log in, given a username and a proplist of
     %% authentication information (e.g. [{password, Password}]).
     %%
     %% Possible responses:
     %% {ok, User}
     %%     Authentication succeeded, and here's the user record.
     %% {error, Error}
     %%     Something went wrong. Log and die.
     %% {refused, Msg, Args}
     %%     Client failed authentication. Log and die.
     {check_user_login, 2},

     %% Given #user, vhost path and permission, can a user access a vhost?
     %% Permission is read  - learn of the existence of (only relevant for
     %%                       management plugin)
     %%            or write - log in
     %%
     %% Possible responses:
     %% true
     %% false
     %% {error, Error}
     %%     Something went wrong. Log and die.
     {check_vhost_access, 3},

     %% Given #user, resource and permission, can a user access a resource?
     %%
     %% Possible responses:
     %% true
     %% false
     %% {error, Error}
     %%     Something went wrong. Log and die.
     {check_resource_access, 3}
    ];
behaviour_info(_Other) ->
    undefined.