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
// Copyright (C) 2023-2025 RabbitMQ Core Team (teamrabbitmq@gmail.com)
//
// Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use crate::{error::Error, path, requests, responses};
use super::client::{Client, Result};
use std::fmt::Display;
impl<E, U, P> Client<E, U, P>
where
E: Display,
U: Display,
P: Display,
{
/// Lists all permissions in the cluster.
/// See [Access Control Guide](https://www.rabbitmq.com/docs/access-control) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn list_permissions(&self) -> Result<Vec<responses::Permissions>> {
self.get_api_request("permissions")
}
/// Lists permissions in a virtual host.
/// See [Access Control Guide](https://www.rabbitmq.com/docs/access-control) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn list_permissions_in(&self, vhost: &str) -> Result<Vec<responses::Permissions>> {
self.get_api_request(path!("vhosts", vhost, "permissions"))
}
/// Lists permissions for a specific user.
/// See [Access Control Guide](https://www.rabbitmq.com/docs/access-control) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn list_permissions_of(&self, user: &str) -> Result<Vec<responses::Permissions>> {
self.get_api_request(path!("users", user, "permissions"))
}
/// Gets permissions for a user in a virtual host.
/// See [Access Control Guide](https://www.rabbitmq.com/docs/access-control) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn get_permissions(&self, vhost: &str, user: &str) -> Result<responses::Permissions> {
self.get_api_request(path!("permissions", vhost, user))
}
/// Declares permissions for a user in a virtual host.
/// See [Access Control Guide](https://www.rabbitmq.com/docs/access-control) to learn more.
///
/// Requires the `administrator` user tag.
pub fn declare_permissions(&self, params: &requests::Permissions<'_>) -> Result<()> {
self.put_api_request(path!("permissions", params.vhost, params.user), params)
}
/// An easier to remember alias for [`declare_permissions`].
/// See [Access Control Guide](https://www.rabbitmq.com/docs/access-control) to learn more.
///
/// Requires the `administrator` user tag.
pub fn grant_permissions(&self, params: &requests::Permissions<'_>) -> Result<()> {
self.declare_permissions(params)
}
/// Revokes user permissions in a specific virtual host.
/// See [Access Control Guide](https://www.rabbitmq.com/docs/access-control) to learn more.
///
/// Requires the `administrator` user tag.
pub fn clear_permissions(&self, vhost: &str, username: &str, idempotently: bool) -> Result<()> {
self.delete_api_request_with_optional_not_found(
path!("permissions", vhost, username),
idempotently,
)
}
/// Sets [topic permissions](https://www.rabbitmq.com/docs/access-control#topic-authorisation) in a specific virtual host.
/// See [Topic Authorisation](https://www.rabbitmq.com/docs/access-control#topic-authorisation) to learn more.
///
/// Requires the `administrator` user tag.
pub fn declare_topic_permissions(&self, params: &requests::TopicPermissions<'_>) -> Result<()> {
self.put_api_request(
path!("topic-permissions", params.vhost, params.user),
params,
)
}
/// Lists all topic permissions in the cluster.
/// See [Topic Authorisation](https://www.rabbitmq.com/docs/access-control#topic-authorisation) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn list_topic_permissions(&self) -> Result<Vec<responses::TopicPermission>> {
self.get_api_request("topic-permissions")
}
/// Lists all topic permissions in a virtual host.
/// See [Topic Authorisation](https://www.rabbitmq.com/docs/access-control#topic-authorisation) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn list_topic_permissions_in(
&self,
vhost: &str,
) -> Result<Vec<responses::TopicPermission>> {
self.get_api_request(path!("vhosts", vhost, "topic-permissions"))
}
/// Lists all topic permissions of a user.
/// See [Topic Authorisation](https://www.rabbitmq.com/docs/access-control#topic-authorisation) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn list_topic_permissions_of(&self, user: &str) -> Result<Vec<responses::TopicPermission>> {
self.get_api_request(path!("users", user, "topic-permissions"))
}
/// Gets topic permissions for a user in a specific virtual host.
/// See [Topic Authorisation](https://www.rabbitmq.com/docs/access-control#topic-authorisation) to learn more.
///
/// Requires the `administrator` user tag. Does not modify state.
pub fn get_topic_permissions_of(
&self,
vhost: &str,
user: &str,
) -> Result<responses::TopicPermission> {
// For some reason this endpoint returns a list instead of a single object
let response: Vec<responses::TopicPermission> =
self.get_api_request(path!("topic-permissions", vhost, user))?;
match response.first() {
Some(p) => Ok(p.clone()),
None => Err(Error::NotFound),
}
}
/// Clears [topic permissions](https://www.rabbitmq.com/docs/access-control#topic-authorisation) for a user in a specific virtual host.
/// See [Topic Authorisation](https://www.rabbitmq.com/docs/access-control#topic-authorisation) to learn more.
///
/// Requires the `administrator` user tag.
pub fn clear_topic_permissions(
&self,
vhost: &str,
user: &str,
idempotently: bool,
) -> Result<()> {
self.delete_api_request_with_optional_not_found(
path!("topic-permissions", vhost, user),
idempotently,
)
}
/// Convenience method: grants full permissions (configure, write, read) to a user in a virtual host.
///
/// Requires the `administrator` user tag.
pub fn grant_full_permissions(&self, user: &str, vhost: &str) -> Result<()> {
let params = requests::Permissions {
user,
vhost,
configure: ".*",
write: ".*",
read: ".*",
};
self.declare_permissions(¶ms)
}
}