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_CREATE_BACKUP
: u64 = 1 << 5;
21 pub const PRIV_DATASTORE_READ
: u64 = 1 << 6;
22 pub const PRIV_DATASTORE_PRUNE
: u64 = 1 << 7;
24 pub const PRIV_PERMISSIONS_MODIFY
: u64 = 1 << 8;
26 pub const ROLE_ADMIN
: u64 = std
::u64::MAX
;
27 pub const ROLE_NO_ACCESS
: u64 = 0;
29 pub const ROLE_AUDIT
: u64 =
33 pub const ROLE_DATASTORE_ADMIN
: u64 =
34 PRIV_DATASTORE_AUDIT
|
35 PRIV_DATASTORE_MODIFY
|
36 PRIV_DATASTORE_CREATE_BACKUP
|
40 pub const ROLE_DATASTORE_USER
: u64 =
41 PRIV_DATASTORE_CREATE_BACKUP
;
43 pub const ROLE_DATASTORE_AUDIT
: u64 =
46 pub const ROLE_NAME_NO_ACCESS
: &str ="NoAccess";
49 pub static ref ROLE_NAMES
: HashMap
<&'
static str, (u64, &'
static str)> = {
50 let mut map
= HashMap
::new();
60 map
.insert(ROLE_NAME_NO_ACCESS
, (
65 map
.insert("Datastore.Admin", (
67 "Datastore Administrator",
69 map
.insert("Datastore.User", (
73 map
.insert("Datastore.Audit", (
82 pub fn split_acl_path(path
: &str) -> Vec
<&str> {
84 let items
= path
.split('
/'
);
86 let mut components
= vec
![];
89 if name
.is_empty() { continue; }
90 components
.push(name
);
97 pub root
: AclTreeNode
,
100 pub struct AclTreeNode
{
101 pub users
: HashMap
<String
, HashMap
<String
, bool
>>,
102 pub groups
: HashMap
<String
, HashMap
<String
, bool
>>,
103 pub children
: BTreeMap
<String
, AclTreeNode
>,
108 pub fn new() -> Self {
110 users
: HashMap
::new(),
111 groups
: HashMap
::new(),
112 children
: BTreeMap
::new(),
116 pub fn extract_roles(&self, user
: &str, all
: bool
) -> HashSet
<String
> {
117 let user_roles
= self.extract_user_roles(user
, all
);
118 if !user_roles
.is_empty() {
119 // user privs always override group privs
123 self.extract_group_roles(user
, all
)
126 pub fn extract_user_roles(&self, user
: &str, all
: bool
) -> HashSet
<String
> {
128 let mut set
= HashSet
::new();
130 let roles
= match self.users
.get(user
) {
135 for (role
, propagate
) in roles
{
136 if *propagate
|| all
{
137 if role
== ROLE_NAME_NO_ACCESS
{
138 // return a set with a single role 'NoAccess'
139 let mut set
= HashSet
::new();
140 set
.insert(role
.to_string());
143 set
.insert(role
.to_string());
150 pub fn extract_group_roles(&self, _user
: &str, all
: bool
) -> HashSet
<String
> {
152 let mut set
= HashSet
::new();
154 for (_group
, roles
) in &self.groups
{
155 let is_member
= false; // fixme: check if user is member of the group
156 if !is_member { continue; }
158 for (role
, propagate
) in roles
{
159 if *propagate
|| all
{
160 if role
== ROLE_NAME_NO_ACCESS
{
161 // return a set with a single role 'NoAccess'
162 let mut set
= HashSet
::new();
163 set
.insert(role
.to_string());
166 set
.insert(role
.to_string());
174 pub fn delete_group_role(&mut self, group
: &str, role
: &str) {
175 let roles
= match self.groups
.get_mut(group
) {
182 pub fn delete_user_role(&mut self, userid
: &str, role
: &str) {
183 let roles
= match self.users
.get_mut(userid
) {
190 pub fn insert_group_role(&mut self, group
: String
, role
: String
, propagate
: bool
) {
191 let map
= self.groups
.entry(group
).or_insert_with(|| HashMap
::new());
192 if role
== ROLE_NAME_NO_ACCESS
{
194 map
.insert(role
, propagate
);
196 map
.remove(ROLE_NAME_NO_ACCESS
);
197 map
.insert(role
, propagate
);
201 pub fn insert_user_role(&mut self, user
: String
, role
: String
, propagate
: bool
) {
202 let map
= self.users
.entry(user
).or_insert_with(|| HashMap
::new());
203 if role
== ROLE_NAME_NO_ACCESS
{
205 map
.insert(role
, propagate
);
207 map
.remove(ROLE_NAME_NO_ACCESS
);
208 map
.insert(role
, propagate
);
215 pub fn new() -> Self {
216 Self { root: AclTreeNode::new() }
219 fn get_node(&mut self, path
: &[&str]) -> Option
<&mut AclTreeNode
> {
220 let mut node
= &mut self.root
;
222 node
= match node
.children
.get_mut(*comp
) {
230 fn get_or_insert_node(&mut self, path
: &[&str]) -> &mut AclTreeNode
{
231 let mut node
= &mut self.root
;
233 node
= node
.children
.entry(String
::from(*comp
))
234 .or_insert_with(|| AclTreeNode
::new());
239 pub fn delete_group_role(&mut self, path
: &str, group
: &str, role
: &str) {
240 let path
= split_acl_path(path
);
241 let node
= match self.get_node(&path
) {
245 node
.delete_group_role(group
, role
);
248 pub fn delete_user_role(&mut self, path
: &str, userid
: &str, role
: &str) {
249 let path
= split_acl_path(path
);
250 let node
= match self.get_node(&path
) {
254 node
.delete_user_role(userid
, role
);
257 pub fn insert_group_role(&mut self, path
: &str, group
: &str, role
: &str, propagate
: bool
) {
258 let path
= split_acl_path(path
);
259 let node
= self.get_or_insert_node(&path
);
260 node
.insert_group_role(group
.to_string(), role
.to_string(), propagate
);
263 pub fn insert_user_role(&mut self, path
: &str, user
: &str, role
: &str, propagate
: bool
) {
264 let path
= split_acl_path(path
);
265 let node
= self.get_or_insert_node(&path
);
266 node
.insert_user_role(user
.to_string(), role
.to_string(), propagate
);
269 fn write_node_config(
273 ) -> Result
<(), Error
> {
275 let mut role_ug_map0
= HashMap
::new();
276 let mut role_ug_map1
= HashMap
::new();
278 for (user
, roles
) in &node
.users
{
279 // no need to save, because root is always 'Administrator'
280 if user
== "root@pam" { continue; }
281 for (role
, propagate
) in roles
{
282 let role
= role
.as_str();
283 let user
= user
.to_string();
285 role_ug_map1
.entry(role
).or_insert_with(|| BTreeSet
::new())
288 role_ug_map0
.entry(role
).or_insert_with(|| BTreeSet
::new())
294 for (group
, roles
) in &node
.groups
{
295 for (role
, propagate
) in roles
{
296 let group
= format
!("@{}", group
);
298 role_ug_map1
.entry(role
).or_insert_with(|| BTreeSet
::new())
301 role_ug_map0
.entry(role
).or_insert_with(|| BTreeSet
::new())
307 fn group_by_property_list(
308 item_property_map
: &HashMap
<&str, BTreeSet
<String
>>,
309 ) -> BTreeMap
<String
, BTreeSet
<String
>> {
310 let mut result_map
= BTreeMap
::new();
311 for (item
, property_map
) in item_property_map
{
312 let item_list
= property_map
.iter().fold(String
::new(), |mut acc
, v
| {
313 if !acc
.is_empty() { acc.push(','); }
317 result_map
.entry(item_list
).or_insert_with(|| BTreeSet
::new())
318 .insert(item
.to_string());
323 let uglist_role_map0
= group_by_property_list(&role_ug_map0
);
324 let uglist_role_map1
= group_by_property_list(&role_ug_map1
);
326 fn role_list(roles
: &BTreeSet
<String
>) -> String
{
327 if roles
.contains(ROLE_NAME_NO_ACCESS
) { return String::from(ROLE_NAME_NO_ACCESS); }
328 roles
.iter().fold(String
::new(), |mut acc
, v
| {
329 if !acc
.is_empty() { acc.push(','); }
335 for (uglist
, roles
) in &uglist_role_map0
{
336 let role_list
= role_list(roles
);
337 writeln
!(w
, "acl:0:{}:{}:{}", if path
.is_empty() { "/" }
else { path }
, uglist
, role_list
)?
;
340 for (uglist
, roles
) in &uglist_role_map1
{
341 let role_list
= role_list(roles
);
342 writeln
!(w
, "acl:1:{}:{}:{}", if path
.is_empty() { "/" }
else { path }
, uglist
, role_list
)?
;
345 for (name
, child
) in node
.children
.iter() {
346 let child_path
= format
!("{}/{}", path
, name
);
347 Self::write_node_config(child
, &child_path
, w
)?
;
353 pub fn write_config(&self, w
: &mut dyn Write
) -> Result
<(), Error
> {
354 Self::write_node_config(&self.root
, "", w
)
357 fn parse_acl_line(&mut self, line
: &str) -> Result
<(), Error
> {
359 let items
: Vec
<&str> = line
.split('
:'
).collect();
361 if items
.len() != 5 {
362 bail
!("wrong number of items.");
365 if items
[0] != "acl" {
366 bail
!("line does not start with 'acl'.");
369 let propagate
= if items
[1] == "0" {
371 } else if items
[1] == "1" {
374 bail
!("expected '0' or '1' for propagate flag.");
377 let path
= split_acl_path(items
[2]);
378 let node
= self.get_or_insert_node(&path
);
380 let uglist
: Vec
<&str> = items
[3].split('
,'
).map(|v
| v
.trim()).collect();
382 let rolelist
: Vec
<&str> = items
[4].split('
,'
).map(|v
| v
.trim()).collect();
384 for user_or_group
in &uglist
{
385 for role
in &rolelist
{
386 if !ROLE_NAMES
.contains_key(role
) {
387 bail
!("unknown role '{}'", role
);
389 if user_or_group
.starts_with('@'
) {
390 let group
= &user_or_group
[1..];
391 node
.insert_group_role(group
.to_string(), role
.to_string(), propagate
);
393 node
.insert_user_role(user_or_group
.to_string(), role
.to_string(), propagate
);
401 pub fn load(filename
: &Path
) -> Result
<(Self, [u8;32]), Error
> {
402 let mut tree
= Self::new();
404 let raw
= match std
::fs
::read_to_string(filename
) {
407 if err
.kind() == std
::io
::ErrorKind
::NotFound
{
410 bail
!("unable to read acl config {:?} - {}", filename
, err
);
415 let digest
= openssl
::sha
::sha256(raw
.as_bytes());
417 for (linenr
, line
) in raw
.lines().enumerate() {
418 let line
= line
.trim();
419 if line
.is_empty() { continue; }
420 if let Err(err
) = tree
.parse_acl_line(line
) {
421 bail
!("unable to parse acl config {:?}, line {} - {}",
422 filename
, linenr
+1, err
);
429 pub fn from_raw(raw
: &str) -> Result
<Self, Error
> {
430 let mut tree
= Self::new();
431 for (linenr
, line
) in raw
.lines().enumerate() {
432 let line
= line
.trim();
433 if line
.is_empty() { continue; }
434 if let Err(err
) = tree
.parse_acl_line(line
) {
435 bail
!("unable to parse acl config data, line {} - {}", linenr
+1, err
);
441 pub fn roles(&self, userid
: &str, path
: &[&str]) -> HashSet
<String
> {
443 let mut node
= &self.root
;
444 let mut role_set
= node
.extract_roles(userid
, path
.is_empty());
446 for (pos
, comp
) in path
.iter().enumerate() {
447 let last_comp
= (pos
+ 1) == path
.len();
448 node
= match node
.children
.get(*comp
) {
450 None
=> return role_set
, // path not found
452 let new_set
= node
.extract_roles(userid
, last_comp
);
453 if !new_set
.is_empty() {
454 // overwrite previous settings
463 pub const ACL_CFG_FILENAME
: &str = "/etc/proxmox-backup/acl.cfg";
464 pub const ACL_CFG_LOCKFILE
: &str = "/etc/proxmox-backup/.acl.lck";
466 pub fn config() -> Result
<(AclTree
, [u8; 32]), Error
> {
467 let path
= PathBuf
::from(ACL_CFG_FILENAME
);
471 pub fn cached_config() -> Result
<Arc
<AclTree
>, Error
> {
474 data
: Option
<Arc
<AclTree
>>,
476 last_mtime_nsec
: i64,
480 static ref CACHED_CONFIG
: RwLock
<ConfigCache
> = RwLock
::new(
481 ConfigCache { data: None, last_mtime: 0, last_mtime_nsec: 0 }
);
484 let stat
= nix
::sys
::stat
::stat(ACL_CFG_FILENAME
)?
;
487 let cache
= CACHED_CONFIG
.read().unwrap();
488 if stat
.st_mtime
== cache
.last_mtime
&& stat
.st_mtime_nsec
== cache
.last_mtime_nsec
{
489 if let Some(ref config
) = cache
.data
{
490 return Ok(config
.clone());
495 let (config
, _digest
) = config()?
;
496 let config
= Arc
::new(config
);
498 let mut cache
= CACHED_CONFIG
.write().unwrap();
499 cache
.last_mtime
= stat
.st_mtime
;
500 cache
.last_mtime_nsec
= stat
.st_mtime_nsec
;
501 cache
.data
= Some(config
.clone());
506 pub fn save_config(acl
: &AclTree
) -> Result
<(), Error
> {
507 let mut raw
: Vec
<u8> = Vec
::new();
509 acl
.write_config(&mut raw
)?
;
511 let backup_user
= crate::backup
::backup_user()?
;
512 let mode
= nix
::sys
::stat
::Mode
::from_bits_truncate(0o0640);
513 // set the correct owner/group/permissions while saving file
514 // owner(rw) = root, group(r)= backup
515 let options
= CreateOptions
::new()
517 .owner(nix
::unistd
::ROOT
)
518 .group(backup_user
.gid
);
520 replace_file(ACL_CFG_FILENAME
, &raw
, options
)?
;
535 expected_roles
: &str,
538 let path_vec
= super::split_acl_path(path
);
539 let mut roles
= tree
.roles(user
, &path_vec
)
540 .iter().map(|v
| v
.clone()).collect
::<Vec
<String
>>();
542 let roles
= roles
.join(",");
544 assert_eq
!(roles
, expected_roles
, "\nat check_roles for '{}' on '{}'", user
, path
);
548 fn test_acl_line_compression() -> Result
<(), Error
> {
550 let tree
= AclTree
::from_raw(r
###"
551 acl:0:/store/store2:user1:Admin
552 acl:0:/store/store2:user2:Admin
553 acl:0:/store/store2:user1:Datastore.User
554 acl:0:/store/store2:user2:Datastore.User
557 let mut raw
: Vec
<u8> = Vec
::new();
558 tree
.write_config(&mut raw
)?
;
559 let raw
= std
::str::from_utf8(&raw
)?
;
561 assert_eq
!(raw
, "acl:0:/store/store2:user1,user2:Admin,Datastore.User\n");
567 fn test_roles_1() -> Result
<(), Error
> {
569 let tree
= AclTree
::from_raw(r
###"
570 acl:1:/storage:user1@pbs:Admin
571 acl:1:/storage/store1:user1@pbs:Datastore.User
572 acl:1:/storage/store2:user2@pbs:Datastore.User
574 check_roles(&tree
, "user1@pbs", "/", "");
575 check_roles(&tree
, "user1@pbs", "/storage", "Admin");
576 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
577 check_roles(&tree
, "user1@pbs", "/storage/store2", "Admin");
579 check_roles(&tree
, "user2@pbs", "/", "");
580 check_roles(&tree
, "user2@pbs", "/storage", "");
581 check_roles(&tree
, "user2@pbs", "/storage/store1", "");
582 check_roles(&tree
, "user2@pbs", "/storage/store2", "Datastore.User");
588 fn test_role_no_access() -> Result
<(), Error
> {
590 let tree
= AclTree
::from_raw(r
###"
591 acl:1:/:user1@pbs:Admin
592 acl:1:/storage:user1@pbs:NoAccess
593 acl:1:/storage/store1:user1@pbs:Datastore.User
595 check_roles(&tree
, "user1@pbs", "/", "Admin");
596 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");
597 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
598 check_roles(&tree
, "user1@pbs", "/storage/store2", "NoAccess");
599 check_roles(&tree
, "user1@pbs", "/system", "Admin");
601 let tree
= AclTree
::from_raw(r
###"
602 acl:1:/:user1@pbs:Admin
603 acl:0:/storage:user1@pbs:NoAccess
604 acl:1:/storage/store1:user1@pbs:Datastore.User
606 check_roles(&tree
, "user1@pbs", "/", "Admin");
607 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");
608 check_roles(&tree
, "user1@pbs", "/storage/store1", "Datastore.User");
609 check_roles(&tree
, "user1@pbs", "/storage/store2", "Admin");
610 check_roles(&tree
, "user1@pbs", "/system", "Admin");
616 fn test_role_add_delete() -> Result
<(), Error
> {
618 let mut tree
= AclTree
::new();
620 tree
.insert_user_role("/", "user1@pbs", "Admin", true);
621 tree
.insert_user_role("/", "user1@pbs", "Audit", true);
623 check_roles(&tree
, "user1@pbs", "/", "Admin,Audit");
625 tree
.insert_user_role("/", "user1@pbs", "NoAccess", true);
626 check_roles(&tree
, "user1@pbs", "/", "NoAccess");
628 let mut raw
: Vec
<u8> = Vec
::new();
629 tree
.write_config(&mut raw
)?
;
630 let raw
= std
::str::from_utf8(&raw
)?
;
632 assert_eq
!(raw
, "acl:1:/:user1@pbs:NoAccess\n");
638 fn test_no_access_overwrite() -> Result
<(), Error
> {
640 let mut tree
= AclTree
::new();
642 tree
.insert_user_role("/storage", "user1@pbs", "NoAccess", true);
644 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");
646 tree
.insert_user_role("/storage", "user1@pbs", "Admin", true);
647 tree
.insert_user_role("/storage", "user1@pbs", "Audit", true);
649 check_roles(&tree
, "user1@pbs", "/storage", "Admin,Audit");
651 tree
.insert_user_role("/storage", "user1@pbs", "NoAccess", true);
653 check_roles(&tree
, "user1@pbs", "/storage", "NoAccess");