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 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
use crate::shared::access_info::UserAccessMode;
use crate::shared::file_like::FileLike;
use crate::shared::file_metadata::{Diff, FileDiff, FileType, Owner};
use crate::shared::filename::MAX_ENCRYPTED_FILENAME_LENGTH;
use crate::shared::lazy::LazyTree;
use crate::shared::staged::StagedTreeLike;
use crate::shared::tree_like::TreeLike;
use crate::shared::{SharedErrorKind, SharedResult, ValidationFailure};
use std::collections::{HashMap, HashSet};
pub fn file_name(name: &str) -> SharedResult<()> {
if name.is_empty() {
Err(SharedErrorKind::FileNameEmpty)?;
}
if name.contains('/') {
Err(SharedErrorKind::FileNameContainsSlash)?;
}
Ok(())
}
pub fn not_root<F: FileLike>(file: &F) -> SharedResult<()> {
if file.is_root() {
Err(SharedErrorKind::RootModificationInvalid.into())
} else {
Ok(())
}
}
pub fn is_folder<F: FileLike>(file: &F) -> SharedResult<()> {
if file.is_folder() {
Ok(())
} else {
Err(SharedErrorKind::FileNotFolder.into())
}
}
pub fn is_document<F: FileLike>(file: &F) -> SharedResult<()> {
if file.is_document() {
Ok(())
} else {
Err(SharedErrorKind::FileNotDocument.into())
}
}
pub fn path(path: &str) -> SharedResult<()> {
if path.contains("//") || path.is_empty() {
Err(SharedErrorKind::PathContainsEmptyFileName)?;
}
Ok(())
}
impl<T, Base, Local> LazyTree<T>
where
T: StagedTreeLike<Base = Base, Staged = Local>,
Base: TreeLike<F = T::F>,
Local: TreeLike<F = T::F>,
{
pub fn validate(&mut self, owner: Owner) -> SharedResult<()> {
// point checks
self.assert_no_root_changes()?;
self.assert_no_changes_to_deleted_files()?;
self.assert_all_filenames_size_limit()?;
self.assert_all_files_decryptable(owner)?;
self.assert_only_folders_have_children()?;
self.assert_all_files_same_owner_as_parent()?;
// structure checks
self.assert_no_cycles()?;
self.assert_no_path_conflicts()?;
self.assert_no_shared_links()?;
self.assert_no_duplicate_links()?;
self.assert_no_broken_links()?;
self.assert_no_owned_links()?;
// authorization check
self.assert_changes_authorized(owner)?;
Ok(())
}
// note: deleted access keys permissible
pub fn assert_all_files_decryptable(&mut self, owner: Owner) -> SharedResult<()> {
for file in self.ids().into_iter().filter_map(|id| self.maybe_find(id)) {
if self.maybe_find_parent(file).is_none()
&& !file
.user_access_keys()
.iter()
.any(|k| k.encrypted_for == owner.0)
{
Err(SharedErrorKind::ValidationFailure(ValidationFailure::Orphan(*file.id())))?;
}
}
Ok(())
}
pub fn assert_all_filenames_size_limit(&self) -> SharedResult<()> {
for file in self.all_files()? {
if file.secret_name().encrypted_value.value.len() > MAX_ENCRYPTED_FILENAME_LENGTH {
return Err(SharedErrorKind::ValidationFailure(
ValidationFailure::FileNameTooLong(*file.id()),
))?;
}
}
Ok(())
}
pub fn assert_only_folders_have_children(&self) -> SharedResult<()> {
for file in self.all_files()? {
if let Some(parent) = self.maybe_find(file.parent()) {
if !parent.is_folder() {
Err(SharedErrorKind::ValidationFailure(
ValidationFailure::NonFolderWithChildren(*parent.id()),
))?;
}
}
}
Ok(())
}
// note: deleted files exempt because otherwise moving a folder with a deleted file in it
// to/from a folder with a different owner would require updating a deleted file
pub fn assert_all_files_same_owner_as_parent(&mut self) -> SharedResult<()> {
for id in self.owned_ids() {
if self.calculate_deleted(&id)? {
continue;
}
let file = self.find(&id)?;
if let Some(parent) = self.maybe_find(file.parent()) {
if parent.owner() != file.owner() {
Err(SharedErrorKind::ValidationFailure(
ValidationFailure::FileWithDifferentOwnerParent(*file.id()),
))?;
}
}
}
Ok(())
}
// assumption: no orphans
pub fn assert_no_cycles(&mut self) -> SharedResult<()> {
let mut owners_with_found_roots = HashSet::new();
let mut no_cycles_in_ancestors = HashSet::new();
for id in self.owned_ids() {
let mut ancestors = HashSet::new();
let mut current_file = self.find(&id)?;
loop {
if no_cycles_in_ancestors.contains(current_file.id()) {
break;
} else if current_file.is_root() {
if owners_with_found_roots.insert(current_file.owner()) {
ancestors.insert(*current_file.id());
break;
} else {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::Cycle(
HashSet::from([id]),
)))?;
}
} else if ancestors.contains(current_file.parent()) {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::Cycle(
self.ancestors(current_file.id())?,
)))?;
}
ancestors.insert(*current_file.id());
current_file = match self.maybe_find_parent(current_file) {
Some(file) => file,
None => {
if !current_file.user_access_keys().is_empty() {
break;
} else {
return Err(SharedErrorKind::FileParentNonexistent.into());
}
}
}
}
no_cycles_in_ancestors.extend(ancestors);
}
Ok(())
}
pub fn assert_no_path_conflicts(&mut self) -> SharedResult<()> {
let mut id_by_name = HashMap::new();
for id in self.owned_ids() {
if !self.calculate_deleted(&id)? {
let file = self.find(&id)?;
if file.is_root() || self.maybe_find(file.parent()).is_none() {
continue;
}
if let Some(conflicting) = id_by_name.remove(file.secret_name()) {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::PathConflict(
HashSet::from([conflicting, *file.id()]),
)))?;
}
id_by_name.insert(file.secret_name().clone(), *file.id());
}
}
Ok(())
}
pub fn assert_no_shared_links(&self) -> SharedResult<()> {
for link in self.owned_ids() {
let meta = self.find(&link)?;
if let FileType::Link { target: _ } = meta.file_type() {
if meta.is_shared() {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::SharedLink {
link,
shared_ancestor: link,
}))?;
}
for ancestor in self.ancestors(&link)? {
if self.find(&ancestor)?.is_shared() {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::SharedLink {
link,
shared_ancestor: ancestor,
}))?;
}
}
}
}
Ok(())
}
pub fn assert_no_duplicate_links(&mut self) -> SharedResult<()> {
let mut linked_targets = HashSet::new();
for link in self.owned_ids() {
if self.calculate_deleted(&link)? {
continue;
}
if let FileType::Link { target } = self.find(&link)?.file_type() {
if !linked_targets.insert(target) {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::DuplicateLink {
target,
}))?;
}
}
}
Ok(())
}
// note: a link to a deleted file is not considered broken, because then you would not be able
// to delete a file linked to by another user.
// note: a deleted link to a nonexistent file is not considered broken, because targets of
// deleted links may have their shares deleted, would not appear in the server tree for a user,
// and would be pruned from client trees
pub fn assert_no_broken_links(&mut self) -> SharedResult<()> {
for link in self.owned_ids() {
if let FileType::Link { target } = self.find(&link)?.file_type() {
if !self.calculate_deleted(&link)? && self.maybe_find(&target).is_none() {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::BrokenLink(link)))?;
}
}
}
Ok(())
}
pub fn assert_no_owned_links(&self) -> SharedResult<()> {
for link in self.owned_ids() {
if let FileType::Link { target } = self.find(&link)?.file_type() {
if let Some(target_owner) = self.maybe_find(&target).map(|f| f.owner()) {
if self.find(&link)?.owner() == target_owner {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::OwnedLink(
link,
)))?;
}
}
}
}
Ok(())
}
pub fn assert_no_root_changes(&mut self) -> SharedResult<()> {
for id in self.tree.staged().owned_ids() {
// already root
if let Some(base) = self.tree.base().maybe_find(&id) {
if base.is_root() {
Err(SharedErrorKind::RootModificationInvalid)?;
}
}
// newly root
if self.find(&id)?.is_root() {
Err(SharedErrorKind::ValidationFailure(ValidationFailure::Cycle(
vec![id].into_iter().collect(),
)))?;
}
}
Ok(())
}
pub fn assert_no_changes_to_deleted_files(&mut self) -> SharedResult<()> {
for id in self.tree.staged().owned_ids() {
// already deleted files cannot have updates
let mut base = self.tree.base().to_lazy();
if base.maybe_find(&id).is_some() && base.calculate_deleted(&id)? {
Err(SharedErrorKind::DeletedFileUpdated(id))?;
}
// newly deleted files cannot have non-deletion updates
if self.calculate_deleted(&id)? {
if let Some(base) = self.tree.base().maybe_find(&id) {
if FileDiff::edit(&base, &self.find(&id)?)
.diff()
.iter()
.any(|d| d != &Diff::Deleted)
{
Err(SharedErrorKind::DeletedFileUpdated(id))?;
}
}
}
}
Ok(())
}
pub fn assert_changes_authorized(&mut self, owner: Owner) -> SharedResult<()> {
// Design rationale:
// * No combination of individually valid changes should compose into an invalid change.
// * Owner and write access must be indistinguishable, otherwise you could e.g. move a
// file from write shared folder into your own, modify it in a way only owners can, then
// move it back. Accommodating this situation may be possible but we're not interested.
// * Which tree - base or staged - should we check access to for an operation?
// * The only staged operations which cause permissions to be different in base and staged
// are moves and share changes. Otherwise, it doesn't matter which tree is used.
// * Changes by a user cannot increase the level of access of access for that user, but
// they can decrease it. Therefore the maximum level of access a user may have over a
// sequence of operations is represented in the base tree. We cannot use the staged
// tree in case a user removes the access they required to perform a prior operation.
// * How do we check access for new files in new folders (which don't exist in base)?
// * A user will have the same access to any created folder as they do to its parent; if a
// user has access to create a folder, then they will have access to create its
// descendants and to move files such that they are descendants.
// * Any access checks on files with new parent folders can be skipped because the access
// check on the first ancestor with an existing parent folder is sufficient.
let new_files = {
let mut new_files = HashSet::new();
for id in self.tree.staged().owned_ids() {
if self.tree.base().maybe_find(&id).is_none() {
new_files.insert(id);
}
}
new_files
};
for file_diff in self.diffs()? {
for field_diff in file_diff.diff() {
match field_diff {
Diff::New | Diff::Name | Diff::Deleted => {
// use oldest version for most permissive access (see rationale)
let file =
if let Some(ref old) = file_diff.old { old } else { &file_diff.new };
// parent folder new -> rely on parent folder check
if !new_files.contains(file.parent()) {
// must have parent and have write access to parent
if let Some(parent) = self.maybe_find(file.parent()) {
if self.access_mode(owner, parent.id())?
< Some(UserAccessMode::Write)
{
// parent is shared with access < write
Err(SharedErrorKind::InsufficientPermission)?;
}
} else {
// this file is shared and its parent is not
Err(SharedErrorKind::InsufficientPermission)?;
}
}
}
Diff::Parent | Diff::Owner => {
// check access for base parent
{
let parent = if let Some(ref old) = file_diff.old {
old.parent()
} else {
return Err(SharedErrorKind::Unexpected(
"Non-New FileDiff with no old",
)
.into());
};
// must have parent and have write access to parent
if let Some(parent) = self.maybe_find(parent) {
if self.access_mode(owner, parent.id())?
< Some(UserAccessMode::Write)
{
// parent is shared with access < write
Err(SharedErrorKind::InsufficientPermission)?;
}
} else {
// this file is shared and its parent is not
Err(SharedErrorKind::InsufficientPermission)?;
}
}
// check access for staged parent
{
let parent = file_diff.new.parent();
// parent folder new -> rely on parent folder check
if !new_files.contains(parent) {
// must have parent and have write access to parent
if let Some(parent) = self.maybe_find(parent) {
if self.access_mode(owner, parent.id())?
< Some(UserAccessMode::Write)
{
// parent is shared with access < write
Err(SharedErrorKind::InsufficientPermission)?;
}
} else {
// this file is shared and its parent is not
Err(SharedErrorKind::InsufficientPermission)?;
}
}
}
}
Diff::Hmac => {
// check self access
if self.access_mode(owner, file_diff.id())? < Some(UserAccessMode::Write) {
Err(SharedErrorKind::InsufficientPermission)?;
}
}
Diff::UserKeys => {
// change access: either changing your own access, or have write access
let base_keys = {
if let Some(ref old) = file_diff.old {
let mut base_keys = HashMap::new();
for key in old.user_access_keys() {
base_keys.insert(
(Owner(key.encrypted_by), Owner(key.encrypted_for)),
(key.mode, key.deleted),
);
}
base_keys
} else {
return Err(SharedErrorKind::Unexpected(
"Non-New FileDiff with no old",
)
.into());
}
};
for key in file_diff.new.user_access_keys() {
if let Some((base_mode, base_deleted)) =
base_keys.get(&(Owner(key.encrypted_by), Owner(key.encrypted_for)))
{
// editing an existing share
let (staged_mode, staged_deleted) = (&key.mode, &key.deleted);
// cannot delete someone else's share without write access
if *staged_deleted
&& !*base_deleted
&& self.access_mode(owner, file_diff.id())?
< Some(UserAccessMode::Write)
&& owner.0 != key.encrypted_for
{
Err(SharedErrorKind::InsufficientPermission)?;
}
// cannot grant yourself write access
if staged_mode != base_mode
&& self.access_mode(owner, file_diff.id())?
< Some(UserAccessMode::Write)
{
Err(SharedErrorKind::InsufficientPermission)?;
}
} else {
// adding a new share
// to add a share, need equal access
if self.access_mode(owner, file_diff.id())? < Some(key.mode) {
Err(SharedErrorKind::InsufficientPermission)?;
}
}
}
}
}
}
}
Ok(())
}
fn diffs(&self) -> SharedResult<Vec<FileDiff<Base::F>>> {
let mut result = Vec::new();
for id in self.tree.staged().owned_ids() {
let staged = self.tree.staged().find(&id)?;
if let Some(base) = self.tree.base().maybe_find(&id) {
result.push(FileDiff::edit(base, staged));
} else {
result.push(FileDiff::new(staged));
}
}
Ok(result)
}
}