2 use std
::collections
::{HashMap, HashSet, BTreeMap, BTreeSet}
;
3 use std
::path
::{PathBuf, Path}
;
4 use std
::sync
::{Arc, RwLock}
;
6 use anyhow
::{bail, Error}
;
8 use lazy_static
::lazy_static
;
10 use proxmox
::tools
::{fs::replace_file, fs::CreateOptions}
;
12 // define Privilege bitfield
14 pub const PRIV_SYS_AUDIT
: u64 = 1 << 0;
15 pub const PRIV_SYS_MODIFY
: u64 = 1 << 1;
16 pub const PRIV_SYS_POWER_MANAGEMENT
: u64 = 1 << 2;
18 pub const PRIV_DATASTORE_AUDIT
: u64 = 1 << 3;
19 pub const PRIV_DATASTORE_MODIFY
: u64 = 1 << 4;
20 pub const PRIV_DATASTORE_ALLOCATE_SPACE
: u64 = 1 << 5;
22 pub const PRIV_PERMISSIONS_MODIFY
: u64 = 1 << 6;
24 pub const ROLE_ADMIN
: u64 = std
::u64::MAX
;
25 pub const ROLE_NO_ACCESS
: u64 = 0;
27 pub const ROLE_AUDIT
: u64 =
31 pub const ROLE_DATASTORE_ADMIN
: u64 =
32 PRIV_DATASTORE_AUDIT
|
33 PRIV_DATASTORE_MODIFY
|
34 PRIV_DATASTORE_ALLOCATE_SPACE
;
36 pub const ROLE_DATASTORE_USER
: u64 =
37 PRIV_DATASTORE_AUDIT
|
38 PRIV_DATASTORE_ALLOCATE_SPACE
;
40 pub const ROLE_DATASTORE_AUDIT
: u64 = PRIV_DATASTORE_AUDIT
;
41 pub const ROLE_NAME_NO_ACCESS
: &str ="NoAccess";
44 pub static ref ROLE_NAMES
: HashMap
<&'
static str, (u64, &'
static str)> = {
45 let mut map
= HashMap
::new();
55 map
.insert(ROLE_NAME_NO_ACCESS
, (
60 map
.insert("Datastore.Admin", (
62 "Datastore Administrator",
64 map
.insert("Datastore.User", (
68 map
.insert("Datastore.Audit", (
77 pub fn split_acl_path(path
: &str) -> Vec
<&str> {
79 let items
= path
.split('
/'
);
81 let mut components
= vec
![];
84 if name
.is_empty() { continue; }
85 components
.push(name
);
92 pub root
: AclTreeNode
,
95 pub struct AclTreeNode
{
96 pub users
: HashMap
<String
, HashMap
<String
, bool
>>,
97 pub groups
: HashMap
<String
, HashMap
<String
, bool
>>,
98 pub children
: BTreeMap
<String
, AclTreeNode
>,
103 pub fn new() -> Self {
105 users
: HashMap
::new(),
106 groups
: HashMap
::new(),
107 children
: BTreeMap
::new(),
111 pub fn extract_roles(&self, user
: &str, all
: bool
) -> HashSet
<String
> {
112 let user_roles
= self.extract_user_roles(user
, all
);
113 if !user_roles
.is_empty() {
114 // user privs always override group privs
118 self.extract_group_roles(user
, all
)
121 pub fn extract_user_roles(&self, user
: &str, all
: bool
) -> HashSet
<String
> {
123 let mut set
= HashSet
::new();
125 let roles
= match self.users
.get(user
) {
130 for (role
, propagate
) in roles
{
131 if *propagate
|| all
{
132 if role
== ROLE_NAME_NO_ACCESS
{
133 // return a set with a single role 'NoAccess'
134 let mut set
= HashSet
::new();
135 set
.insert(role
.to_string());
138 set
.insert(role
.to_string());
145 pub fn extract_group_roles(&self, _user
: &str, all
: bool
) -> HashSet
<String
> {
147 let mut set
= HashSet
::new();
149 for (_group
, roles
) in &self.groups
{
150 let is_member
= false; // fixme: check if user is member of the group
151 if !is_member { continue; }
153 for (role
, propagate
) in roles
{
154 if *propagate
|| all
{
155 if role
== ROLE_NAME_NO_ACCESS
{
156 // return a set with a single role 'NoAccess'
157 let mut set
= HashSet
::new();
158 set
.insert(role
.to_string());
161 set
.insert(role
.to_string());
169 pub fn delete_group_role(&mut self, group
: &str, role
: &str) {
170 let roles
= match self.groups
.get_mut(group
) {
177 pub fn delete_user_role(&mut self, userid
: &str, role
: &str) {
178 let roles
= match self.users
.get_mut(userid
) {
185 pub fn insert_group_role(&mut self, group
: String
, role
: String
, propagate
: bool
) {
186 let map
= self.groups
.entry(group
).or_insert_with(|| HashMap
::new());
187 if role
== ROLE_NAME_NO_ACCESS
{
189 map
.insert(role
, propagate
);
191 map
.remove(ROLE_NAME_NO_ACCESS
);
192 map
.insert(role
, propagate
);
196 pub fn insert_user_role(&mut self, user
: String
, role
: String
, propagate
: bool
) {
197 let map
= self.users
.entry(user
).or_insert_with(|| HashMap
::new());
198 if role
== ROLE_NAME_NO_ACCESS
{
200 map
.insert(role
, propagate
);
202 map
.remove(ROLE_NAME_NO_ACCESS
);
203 map
.insert(role
, propagate
);
210 pub fn new() -> Self {
211 Self { root: AclTreeNode::new() }
214 fn get_node(&mut self, path
: &[&str]) -> Option
<&mut AclTreeNode
> {
215 let mut node
= &mut self.root
;
217 node
= match node
.children
.get_mut(*comp
) {
225 fn get_or_insert_node(&mut self, path
: &[&str]) -> &mut AclTreeNode
{
226 let mut node
= &mut self.root
;
228 node
= node
.children
.entry(String
::from(*comp
))
229 .or_insert_with(|| AclTreeNode
::new());
234 pub fn delete_group_role(&mut self, path
: &str, group
: &str, role
: &str) {
235 let path
= split_acl_path(path
);
236 let node
= match self.get_node(&path
) {
240 node
.delete_group_role(group
, role
);
243 pub fn delete_user_role(&mut self, path
: &str, userid
: &str, role
: &str) {
244 let path
= split_acl_path(path
);
245 let node
= match self.get_node(&path
) {
249 node
.delete_user_role(userid
, role
);
252 pub fn insert_group_role(&mut self, path
: &str, group
: &str, role
: &str, propagate
: bool
) {
253 let path
= split_acl_path(path
);
254 let node
= self.get_or_insert_node(&path
);
255 node
.insert_group_role(group
.to_string(), role
.to_string(), propagate
);
258 pub fn insert_user_role(&mut self, path
: &str, user
: &str, role
: &str, propagate
: bool
) {
259 let path
= split_acl_path(path
);
260 let node
= self.get_or_insert_node(&path
);
261 node
.insert_user_role(user
.to_string(), role
.to_string(), propagate
);
264 fn write_node_config(
268 ) -> Result
<(), Error
> {
270 let mut role_ug_map0
= HashMap
::new();
271 let mut role_ug_map1
= HashMap
::new();
273 for (user
, roles
) in &node
.users
{
274 // no need to save, because root is always 'Administrator'
275 if user
== "root@pam" { continue; }
276 for (role
, propagate
) in roles
{
277 let role
= role
.as_str();
278 let user
= user
.to_string();
280 role_ug_map1
.entry(role
).or_insert_with(|| BTreeSet
::new())
283 role_ug_map0
.entry(role
).or_insert_with(|| BTreeSet
::new())
289 for (group
, roles
) in &node
.groups
{
290 for (role
, propagate
) in roles
{
291 let group
= format
!("@{}", group
);
293 role_ug_map1
.entry(role
).or_insert_with(|| BTreeSet
::new())
296 role_ug_map0
.entry(role
).or_insert_with(|| BTreeSet
::new())
302 fn group_by_property_list(
303 item_property_map
: &HashMap
<&str, BTreeSet
<String
>>,
304 ) -> BTreeMap
<String
, BTreeSet
<String
>> {
305 let mut result_map
= BTreeMap
::new();
306 for (item
, property_map
) in item_property_map
{
307 let item_list
= property_map
.iter().fold(String
::new(), |mut acc
, v
| {
308 if !acc
.is_empty() { acc.push(','); }
312 result_map
.entry(item_list
).or_insert_with(|| BTreeSet
::new())
313 .insert(item
.to_string());
318 let uglist_role_map0
= group_by_property_list(&role_ug_map0
);
319 let uglist_role_map1
= group_by_property_list(&role_ug_map1
);
321 fn role_list(roles
: &BTreeSet
<String
>) -> String
{
322 if roles
.contains(ROLE_NAME_NO_ACCESS
) { return String::from(ROLE_NAME_NO_ACCESS); }
323 roles
.iter().fold(String
::new(), |mut acc
, v
| {
324 if !acc
.is_empty() { acc.push(','); }
330 for (uglist
, roles
) in &uglist_role_map0
{
331 let role_list
= role_list(roles
);
332 writeln
!(w
, "acl:0:{}:{}:{}", if path
.is_empty() { "/" }
else { path }
, uglist
, role_list
)?
;
335 for (uglist
, roles
) in &uglist_role_map1
{
336 let role_list
= role_list(roles
);
337 writeln
!(w
, "acl:1:{}:{}:{}", if path
.is_empty() { "/" }
else { path }
, uglist
, role_list
)?
;
340 for (name
, child
) in node
.children
.iter() {
341 let child_path
= format
!("{}/{}", path
, name
);
342 Self::write_node_config(child
, &child_path
, w
)?
;
348 pub fn write_config(&self, w
: &mut dyn Write
) -> Result
<(), Error
> {
349 Self::write_node_config(&self.root
, "", w
)
352 fn parse_acl_line(&mut self, line
: &str) -> Result
<(), Error
> {
354 let items
: Vec
<&str> = line
.split('
:'
).collect();
356 if items
.len() != 5 {
357 bail
!("wrong number of items.");
360 if items
[0] != "acl" {
361 bail
!("line does not start with 'acl'.");
364 let propagate
= if items
[1] == "0" {
366 } else if items
[1] == "1" {
369 bail
!("expected '0' or '1' for propagate flag.");
372 let path
= split_acl_path(items
[2]);
373 let node
= self.get_or_insert_node(&path
);
375 let uglist
: Vec
<&str> = items
[3].split('
,'
).map(|v
| v
.trim()).collect();
377 let rolelist
: Vec
<&str> = items
[4].split('
,'
).map(|v
| v
.trim()).collect();
379 for user_or_group
in &uglist
{
380 for role
in &rolelist
{
381 if !ROLE_NAMES
.contains_key(role
) {
382 bail
!("unknown role '{}'", role
);
384 if user_or_group
.starts_with('@'
) {
385 let group
= &user_or_group
[1..];
386 node
.insert_group_role(group
.to_string(), role
.to_string(), propagate
);
388 node
.insert_user_role(user_or_group
.to_string(), role
.to_string(), propagate
);
396 pub fn load(filename
: &Path
) -> Result
<(Self, [u8;32]), Error
> {
397 let mut tree
= Self::new();
399 let raw
= match std
::fs
::read_to_string(filename
) {
402 if err
.kind() == std
::io
::ErrorKind
::NotFound
{
405 bail
!("unable to read acl config {:?} - {}", filename
, err
);
410 let digest
= openssl
::sha
::sha256(raw
.as_bytes());
412 for (linenr
, line
) in raw
.lines().enumerate() {
413 let line
= line
.trim();
414 if line
.is_empty() { continue; }
415 if let Err(err
) = tree
.parse_acl_line(line
) {
416 bail
!("unable to parse acl config {:?}, line {} - {}",
417 filename
, linenr
+1, err
);
424 pub fn from_raw(raw
: &str) -> Result
<Self, Error
> {
425 let mut tree
= Self::new();
426 for (linenr
, line
) in raw
.lines().enumerate() {
427 let line
= line
.trim();
428 if line
.is_empty() { continue; }
429 if let Err(err
) = tree
.parse_acl_line(line
) {
430 bail
!("unable to parse acl config data, line {} - {}", linenr
+1, err
);
436 pub fn roles(&self, userid
: &str, path
: &[&str]) -> HashSet
<String
> {
438 let mut node
= &self.root
;
439 let mut role_set
= node
.extract_roles(userid
, path
.is_empty());
441 for (pos
, comp
) in path
.iter().enumerate() {
442 let last_comp
= (pos
+ 1) == path
.len();
443 node
= match node
.children
.get(*comp
) {
445 None
=> return role_set
, // path not found
447 let new_set
= node
.extract_roles(userid
, last_comp
);
448 if !new_set
.is_empty() {
449 // overwrite previous settings
458 pub const ACL_CFG_FILENAME
: &str = "/etc/proxmox-backup/acl.cfg";
459 pub const ACL_CFG_LOCKFILE
: &str = "/etc/proxmox-backup/.acl.lck";
461 pub fn config() -> Result
<(AclTree
, [u8; 32]), Error
> {
462 let path
= PathBuf
::from(ACL_CFG_FILENAME
);
466 pub fn cached_config() -> Result
<Arc
<AclTree
>, Error
> {
469 data
: Option
<Arc
<AclTree
>>,
471 last_mtime_nsec
: i64,
475 static ref CACHED_CONFIG
: RwLock
<ConfigCache
> = RwLock
::new(
476 ConfigCache { data: None, last_mtime: 0, last_mtime_nsec: 0 }
);
479 let stat
= nix
::sys
::stat
::stat(ACL_CFG_FILENAME
)?
;
482 let cache
= CACHED_CONFIG
.read().unwrap();
483 if stat
.st_mtime
== cache
.last_mtime
&& stat
.st_mtime_nsec
== cache
.last_mtime_nsec
{
484 if let Some(ref config
) = cache
.data
{
485 return Ok(config
.clone());
490 let (config
, _digest
) = config()?
;
491 let config
= Arc
::new(config
);
493 let mut cache
= CACHED_CONFIG
.write().unwrap();
494 cache
.last_mtime
= stat
.st_mtime
;
495 cache
.last_mtime_nsec
= stat
.st_mtime_nsec
;
496 cache
.data
= Some(config
.clone());
501 pub fn save_config(acl
: &AclTree
) -> Result
<(), Error
> {
502 let mut raw
: Vec
<u8> = Vec
::new();
504 acl
.write_config(&mut raw
)?
;
506 let backup_user
= crate::backup
::backup_user()?
;
507 let mode
= nix
::sys
::stat
::Mode
::from_bits_truncate(0o0640);
508 // set the correct owner/group/permissions while saving file
509 // owner(rw) = root, group(r)= backup
510 let options
= CreateOptions
::new()
512 .owner(nix
::unistd
::ROOT
)
513 .group(backup_user
.gid
);
515 replace_file(ACL_CFG_FILENAME
, &raw
, options
)?
;
530 expected_roles
: &str,
533 let path_vec
= super::split_acl_path(path
);
534 let mut roles
= tree
.roles(user
, &path_vec
)
535 .iter().map(|v
| v
.clone()).collect
::<Vec
<String
>>();
537 let roles
= roles
.join(",");
539 assert_eq
!(roles
, expected_roles
, "\nat check_roles for '{}' on '{}'", user
, path
);
543 fn test_acl_line_compression() -> Result
<(), Error
> {
545 let tree
= AclTree
::from_raw(r
###"
546 acl:0:/store/store2:user1:Admin
547 acl:0:/store/store2:user2:Admin
548 acl:0:/store/store2:user1:Datastore.User
549 acl:0:/store/store2:user2:Datastore.User
552 let mut raw
: Vec
<u8> = Vec
::new();
553 tree
.write_config(&mut raw
)?
;
554 let raw
= std
::str::from_utf8(&raw
)?
;
556 assert_eq
!(raw
, "acl:0:/store/store2:user1,user2:Admin,Datastore.User\n");
562 fn test_roles_1() -> Result
<(), Error
> {
564 let tree
= AclTree
::from_raw(r
###"
565 acl:1:/storage:user1@pbs:Admin
566 acl:1:/storage/store1:user1@pbs:Datastore.User
567 acl:1:/storage/store2:user2@pbs:Datastore.User
569 check_roles(&tree
, "user1@pbs", "/", "");
570 check_roles(&tree
, "user1@pbs", "/storage", "Admin");
571 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
572 check_roles(&tree
, "user1@pbs", "/storage/store2", "Admin");
574 check_roles(&tree
, "user2@pbs", "/", "");
575 check_roles(&tree
, "user2@pbs", "/storage", "");
576 check_roles(&tree
, "user2@pbs", "/storage/store1", "");
577 check_roles(&tree
, "user2@pbs", "/storage/store2", "Datastore.User");
583 fn test_role_no_access() -> Result
<(), Error
> {
585 let tree
= AclTree
::from_raw(r
###"
586 acl:1:/:user1@pbs:Admin
587 acl:1:/storage:user1@pbs:NoAccess
588 acl:1:/storage/store1:user1@pbs:Datastore.User
590 check_roles(&tree
, "user1@pbs", "/", "Admin");
591 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");
592 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
593 check_roles(&tree
, "user1@pbs", "/storage/store2", "NoAccess");
594 check_roles(&tree
, "user1@pbs", "/system", "Admin");
596 let tree
= AclTree
::from_raw(r
###"
597 acl:1:/:user1@pbs:Admin
598 acl:0:/storage:user1@pbs:NoAccess
599 acl:1:/storage/store1:user1@pbs:Datastore.User
601 check_roles(&tree
, "user1@pbs", "/", "Admin");
602 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");
603 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
604 check_roles(&tree
, "user1@pbs", "/storage/store2", "Admin");
605 check_roles(&tree
, "user1@pbs", "/system", "Admin");
611 fn test_role_add_delete() -> Result
<(), Error
> {
613 let mut tree
= AclTree
::new();
615 tree
.insert_user_role("/", "user1@pbs", "Admin", true);
616 tree
.insert_user_role("/", "user1@pbs", "Audit", true);
618 check_roles(&tree
, "user1@pbs", "/", "Admin,Audit");
620 tree
.insert_user_role("/", "user1@pbs", "NoAccess", true);
621 check_roles(&tree
, "user1@pbs", "/", "NoAccess");
623 let mut raw
: Vec
<u8> = Vec
::new();
624 tree
.write_config(&mut raw
)?
;
625 let raw
= std
::str::from_utf8(&raw
)?
;
627 assert_eq
!(raw
, "acl:1:/:user1@pbs:NoAccess\n");
633 fn test_no_access_overwrite() -> Result
<(), Error
> {
635 let mut tree
= AclTree
::new();
637 tree
.insert_user_role("/storage", "user1@pbs", "NoAccess", true);
639 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");
641 tree
.insert_user_role("/storage", "user1@pbs", "Admin", true);
642 tree
.insert_user_role("/storage", "user1@pbs", "Audit", true);
644 check_roles(&tree
, "user1@pbs", "/storage", "Admin,Audit");
646 tree
.insert_user_role("/storage", "user1@pbs", "NoAccess", true);
648 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");