2 use std
::collections
::{HashMap, HashSet, BTreeMap, BTreeSet}
;
3 use std
::path
::{PathBuf, Path}
;
7 use lazy_static
::lazy_static
;
9 use proxmox
::tools
::{fs::replace_file, fs::CreateOptions}
;
11 // define Privilege bitfield
13 pub const PRIV_SYS_AUDIT
: u64 = 1 << 0;
14 pub const PRIV_SYS_MODIFY
: u64 = 1 << 1;
15 pub const PRIV_SYS_POWER_MANAGEMENT
: u64 = 1 << 2;
17 pub const PRIV_DATASTORE_AUDIT
: u64 = 1 << 3;
18 pub const PRIV_DATASTORE_ALLOCATE
: u64 = 1 << 4;
19 pub const PRIV_DATASTORE_ALLOCATE_SPACE
: u64 = 1 << 5;
21 pub const ROLE_ADMIN
: u64 = std
::u64::MAX
;
22 pub const ROLE_NO_ACCESS
: u64 = 0;
24 pub const ROLE_AUDIT
: u64 =
28 pub const ROLE_DATASTORE_ADMIN
: u64 =
29 PRIV_DATASTORE_AUDIT
|
30 PRIV_DATASTORE_ALLOCATE
|
31 PRIV_DATASTORE_ALLOCATE_SPACE
;
33 pub const ROLE_DATASTORE_USER
: u64 =
34 PRIV_DATASTORE_AUDIT
|
35 PRIV_DATASTORE_ALLOCATE_SPACE
;
37 pub const ROLE_DATASTORE_AUDIT
: u64 = PRIV_DATASTORE_AUDIT
;
40 static ref ROLE_NAMES
: HashMap
<&'
static str, u64> = {
41 let mut map
= HashMap
::new();
43 map
.insert("Admin", ROLE_ADMIN
);
44 map
.insert("Audit", ROLE_AUDIT
);
45 map
.insert("NoAccess", ROLE_NO_ACCESS
);
47 map
.insert("Datastore.Admin", ROLE_DATASTORE_ADMIN
);
48 map
.insert("Datastore.User", ROLE_DATASTORE_USER
);
49 map
.insert("Datastore.Audit", ROLE_DATASTORE_AUDIT
);
55 pub fn split_acl_path(path
: &str) -> Vec
<&str> {
57 let items
= path
.split('
/'
);
59 let mut components
= vec
![];
62 if name
.is_empty() { continue; }
63 components
.push(name
);
70 pub root
: AclTreeNode
,
73 pub struct AclTreeNode
{
74 pub users
: HashMap
<String
, HashMap
<String
, bool
>>,
75 pub groups
: HashMap
<String
, HashMap
<String
, bool
>>,
76 pub children
: BTreeMap
<String
, AclTreeNode
>,
81 pub fn new() -> Self {
83 users
: HashMap
::new(),
84 groups
: HashMap
::new(),
85 children
: BTreeMap
::new(),
89 pub fn extract_roles(&self, user
: &str, all
: bool
) -> HashSet
<String
> {
90 let user_roles
= self.extract_user_roles(user
, all
);
91 if !user_roles
.is_empty() {
92 // user privs always override group privs
96 self.extract_group_roles(user
, all
)
99 pub fn extract_user_roles(&self, user
: &str, all
: bool
) -> HashSet
<String
> {
101 let mut set
= HashSet
::new();
103 let roles
= match self.users
.get(user
) {
108 for (role
, propagate
) in roles
{
109 if *propagate
|| all
{
110 if role
== "NoAccess" {
111 // return a set with a single role 'NoAccess'
112 let mut set
= HashSet
::new();
113 set
.insert(role
.to_string());
116 set
.insert(role
.to_string());
123 pub fn extract_group_roles(&self, _user
: &str, all
: bool
) -> HashSet
<String
> {
125 let mut set
= HashSet
::new();
127 for (_group
, roles
) in &self.groups
{
128 let is_member
= false; // fixme: check if user is member of the group
129 if !is_member { continue; }
131 for (role
, propagate
) in roles
{
132 if *propagate
|| all
{
133 if role
== "NoAccess" {
134 // return a set with a single role 'NoAccess'
135 let mut set
= HashSet
::new();
136 set
.insert(role
.to_string());
139 set
.insert(role
.to_string());
147 pub fn delete_group_role(&mut self, group
: &str, role
: &str) {
148 let roles
= match self.groups
.get_mut(group
) {
155 pub fn delete_user_role(&mut self, userid
: &str, role
: &str) {
156 let roles
= match self.users
.get_mut(userid
) {
163 pub fn insert_group_role(&mut self, group
: String
, role
: String
, propagate
: bool
) {
165 .entry(group
).or_insert_with(|| HashMap
::new())
166 .insert(role
, propagate
);
169 pub fn insert_user_role(&mut self, user
: String
, role
: String
, propagate
: bool
) {
171 .entry(user
).or_insert_with(|| HashMap
::new())
172 .insert(role
, propagate
);
178 pub fn new() -> Self {
179 Self { root: AclTreeNode::new() }
182 fn get_node(&mut self, path
: &[&str]) -> Option
<&mut AclTreeNode
> {
183 let mut node
= &mut self.root
;
185 node
= match node
.children
.get_mut(*comp
) {
193 fn get_or_insert_node(&mut self, path
: &[&str]) -> &mut AclTreeNode
{
194 let mut node
= &mut self.root
;
196 node
= node
.children
.entry(String
::from(*comp
))
197 .or_insert_with(|| AclTreeNode
::new());
202 pub fn delete_group_role(&mut self, path
: &str, group
: &str, role
: &str) {
203 let path
= split_acl_path(path
);
204 let node
= match self.get_node(&path
) {
208 node
.delete_group_role(group
, role
);
211 pub fn delete_user_role(&mut self, path
: &str, userid
: &str, role
: &str) {
212 let path
= split_acl_path(path
);
213 let node
= match self.get_node(&path
) {
217 node
.delete_user_role(userid
, role
);
220 pub fn insert_group_role(&mut self, path
: &str, group
: &str, role
: &str, propagate
: bool
) {
221 let path
= split_acl_path(path
);
222 let node
= self.get_or_insert_node(&path
);
223 node
.insert_group_role(group
.to_string(), role
.to_string(), propagate
);
226 pub fn insert_user_role(&mut self, path
: &str, user
: &str, role
: &str, propagate
: bool
) {
227 let path
= split_acl_path(path
);
228 let node
= self.get_or_insert_node(&path
);
229 node
.insert_user_role(user
.to_string(), role
.to_string(), propagate
);
232 fn write_node_config(
236 ) -> Result
<(), Error
> {
238 let mut role_ug_map0
= HashMap
::new();
239 let mut role_ug_map1
= HashMap
::new();
241 for (user
, roles
) in &node
.users
{
242 // no need to save, because root is always 'Administrator'
243 if user
== "root@pam" { continue; }
244 for (role
, propagate
) in roles
{
245 let role
= role
.as_str();
246 let user
= user
.to_string();
248 role_ug_map1
.entry(role
).or_insert_with(|| BTreeSet
::new())
251 role_ug_map0
.entry(role
).or_insert_with(|| BTreeSet
::new())
257 for (group
, roles
) in &node
.groups
{
258 for (role
, propagate
) in roles
{
259 let group
= format
!("@{}", group
);
261 role_ug_map1
.entry(role
).or_insert_with(|| BTreeSet
::new())
264 role_ug_map0
.entry(role
).or_insert_with(|| BTreeSet
::new())
270 fn group_by_property_list(
271 item_property_map
: &HashMap
<&str, BTreeSet
<String
>>,
272 ) -> BTreeMap
<String
, BTreeSet
<String
>> {
273 let mut result_map
= BTreeMap
::new();
274 for (item
, property_map
) in item_property_map
{
275 let item_list
= property_map
.iter().fold(String
::new(), |mut acc
, v
| {
276 if !acc
.is_empty() { acc.push(','); }
280 result_map
.entry(item_list
).or_insert_with(|| BTreeSet
::new())
281 .insert(item
.to_string());
286 let uglist_role_map0
= group_by_property_list(&role_ug_map0
);
287 let uglist_role_map1
= group_by_property_list(&role_ug_map1
);
289 for (uglist
, roles
) in uglist_role_map0
{
290 let role_list
= roles
.iter().fold(String
::new(), |mut acc
, v
| {
291 if !acc
.is_empty() { acc.push(','); }
295 writeln
!(w
, "acl:0:{}:{}:{}", path
, uglist
, role_list
)?
;
298 for (uglist
, roles
) in uglist_role_map1
{
299 let role_list
= roles
.iter().fold(String
::new(), |mut acc
, v
| {
300 if !acc
.is_empty() { acc.push(','); }
304 writeln
!(w
, "acl:1:{}:{}:{}", path
, uglist
, role_list
)?
;
307 for (name
, child
) in node
.children
.iter() {
308 let child_path
= format
!("{}/{}", path
, name
);
309 Self::write_node_config(child
, &child_path
, w
)?
;
315 pub fn write_config(&self, w
: &mut dyn Write
) -> Result
<(), Error
> {
316 Self::write_node_config(&self.root
, "", w
)
319 fn parse_acl_line(&mut self, line
: &str) -> Result
<(), Error
> {
321 let items
: Vec
<&str> = line
.split('
:'
).collect();
323 if items
.len() != 5 {
324 bail
!("wrong number of items.");
327 if items
[0] != "acl" {
328 bail
!("line does not start with 'acl'.");
331 let propagate
= if items
[1] == "0" {
333 } else if items
[1] == "1" {
336 bail
!("expected '0' or '1' for propagate flag.");
339 let path
= split_acl_path(items
[2]);
340 let node
= self.get_or_insert_node(&path
);
342 let uglist
: Vec
<&str> = items
[3].split('
,'
).map(|v
| v
.trim()).collect();
344 let rolelist
: Vec
<&str> = items
[4].split('
,'
).map(|v
| v
.trim()).collect();
346 for user_or_group
in &uglist
{
347 for role
in &rolelist
{
348 if !ROLE_NAMES
.contains_key(role
) {
349 bail
!("unknown role '{}'", role
);
351 if user_or_group
.starts_with('@'
) {
352 let group
= &user_or_group
[1..];
353 node
.insert_group_role(group
.to_string(), role
.to_string(), propagate
);
355 node
.insert_user_role(user_or_group
.to_string(), role
.to_string(), propagate
);
363 pub fn load(filename
: &Path
) -> Result
<(Self, [u8;32]), Error
> {
364 let mut tree
= Self::new();
366 let raw
= match std
::fs
::read_to_string(filename
) {
369 if err
.kind() == std
::io
::ErrorKind
::NotFound
{
372 bail
!("unable to read acl config {:?} - {}", filename
, err
);
377 let digest
= openssl
::sha
::sha256(raw
.as_bytes());
379 for (linenr
, line
) in raw
.lines().enumerate() {
380 let line
= line
.trim();
381 if line
.is_empty() { continue; }
382 if let Err(err
) = tree
.parse_acl_line(line
) {
383 bail
!("unable to parse acl config {:?}, line {} - {}",
384 filename
, linenr
+1, err
);
391 pub fn from_raw(raw
: &str) -> Result
<Self, Error
> {
392 let mut tree
= Self::new();
393 for (linenr
, line
) in raw
.lines().enumerate() {
394 let line
= line
.trim();
395 if line
.is_empty() { continue; }
396 if let Err(err
) = tree
.parse_acl_line(line
) {
397 bail
!("unable to parse acl config data, line {} - {}", linenr
+1, err
);
403 pub fn roles(&self, userid
: &str, path
: &[&str]) -> HashSet
<String
> {
405 let mut node
= &self.root
;
406 let mut role_set
= node
.extract_roles(userid
, path
.is_empty());
408 for (pos
, comp
) in path
.iter().enumerate() {
409 let last_comp
= (pos
+ 1) == path
.len();
410 node
= match node
.children
.get(*comp
) {
412 None
=> return role_set
, // path not found
414 let new_set
= node
.extract_roles(userid
, last_comp
);
415 if !new_set
.is_empty() {
416 // overwrite previous settings
425 pub const ACL_CFG_FILENAME
: &str = "/etc/proxmox-backup/acl.cfg";
426 pub const ACL_CFG_LOCKFILE
: &str = "/etc/proxmox-backup/.acl.lck";
428 pub fn config() -> Result
<(AclTree
, [u8; 32]), Error
> {
429 let path
= PathBuf
::from(ACL_CFG_FILENAME
);
433 pub fn save_config(acl
: &AclTree
) -> Result
<(), Error
> {
434 let mut raw
: Vec
<u8> = Vec
::new();
436 acl
.write_config(&mut raw
)?
;
438 let backup_user
= crate::backup
::backup_user()?
;
439 let mode
= nix
::sys
::stat
::Mode
::from_bits_truncate(0o0640);
440 // set the correct owner/group/permissions while saving file
441 // owner(rw) = root, group(r)= backup
442 let options
= CreateOptions
::new()
444 .owner(nix
::unistd
::ROOT
)
445 .group(backup_user
.gid
);
447 replace_file(ACL_CFG_FILENAME
, &raw
, options
)?
;
462 expected_roles
: &str,
465 let path_vec
= super::split_acl_path(path
);
466 let mut roles
= tree
.roles(user
, &path_vec
)
467 .iter().map(|v
| v
.clone()).collect
::<Vec
<String
>>();
469 let roles
= roles
.join(",");
471 assert_eq
!(roles
, expected_roles
, "\nat check_roles for '{}' on '{}'", user
, path
);
475 fn test_acl_line_compression() -> Result
<(), Error
> {
477 let tree
= AclTree
::from_raw(r
###"
478 acl:0:/store/store2:user1:Admin
479 acl:0:/store/store2:user2:Admin
480 acl:0:/store/store2:user1:Datastore.User
481 acl:0:/store/store2:user2:Datastore.User
484 let mut raw
: Vec
<u8> = Vec
::new();
485 tree
.write_config(&mut raw
)?
;
486 let raw
= std
::str::from_utf8(&raw
)?
;
488 assert_eq
!(raw
, "acl:0:/store/store2:user1,user2:Admin,Datastore.User\n");
494 fn test_roles_1() -> Result
<(), Error
> {
496 let tree
= AclTree
::from_raw(r
###"
497 acl:1:/storage:user1@pbs:Admin
498 acl:1:/storage/store1:user1@pbs:Datastore.User
499 acl:1:/storage/store2:user2@pbs:Datastore.User
501 check_roles(&tree
, "user1@pbs", "/", "");
502 check_roles(&tree
, "user1@pbs", "/storage", "Admin");
503 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
504 check_roles(&tree
, "user1@pbs", "/storage/store2", "Admin");
506 check_roles(&tree
, "user2@pbs", "/", "");
507 check_roles(&tree
, "user2@pbs", "/storage", "");
508 check_roles(&tree
, "user2@pbs", "/storage/store1", "");
509 check_roles(&tree
, "user2@pbs", "/storage/store2", "Datastore.User");
515 fn test_role_no_access() -> Result
<(), Error
> {
517 let tree
= AclTree
::from_raw(r
###"
518 acl:1:/:user1@pbs:Admin
519 acl:1:/storage:user1@pbs:NoAccess
520 acl:1:/storage/store1:user1@pbs:Datastore.User
522 check_roles(&tree
, "user1@pbs", "/", "Admin");
523 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");
524 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
525 check_roles(&tree
, "user1@pbs", "/storage/store2", "NoAccess");
526 check_roles(&tree
, "user1@pbs", "/system", "Admin");
528 let tree
= AclTree
::from_raw(r
###"
529 acl:1:/:user1@pbs:Admin
530 acl:0:/storage:user1@pbs:NoAccess
531 acl:1:/storage/store1:user1@pbs:Datastore.User
533 check_roles(&tree
, "user1@pbs", "/", "Admin");
534 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");
535 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
536 check_roles(&tree
, "user1@pbs", "/storage/store2", "Admin");
537 check_roles(&tree
, "user1@pbs", "/system", "Admin");