Add acl support to libpna

[ChanTsune]

No description provided.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: dcdbcb8c-d295-49d6-9471-fb6f5719c713

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 1585-add-acl-support-to-libpna

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[gemini-code-assist]

Summary of Changes

Hello @ChanTsune, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly enhances the libpna library by introducing robust support for Access Control Lists (ACLs). It establishes a flexible framework to handle ACLs across various operating systems, integrating them seamlessly into the library's core data structures and archive format. This allows for the preservation and retrieval of detailed file access permissions, expanding the utility and compatibility of the library.

Highlights

• New ACL Module: Introduced a new acl module with data structures for representing Access Control Lists (ACLs), including AclPlatform, AclType, AceType, AcePermission, AceFlag, Ace, and Acl.
• Multi-Platform ACL Support: The AcePermission and AceFlag structs, powered by the bitflags crate, define comprehensive permission and flag constants for POSIX, macOS, Windows, and NFSv4 ACL systems.
• Serialization and Deserialization: The Ace and Acl structs include methods (to_bytes, write_into, try_from_bytes) for efficient serialization and deserialization of ACL data to and from byte arrays.
• Dependency Updates: Added bitflags as a core dependency and windows (with specific features for file system and security APIs) as a Windows-specific development dependency to Cargo.toml and Cargo.lock.
• Integration into Archive Format: A new ChunkType::fACL was added to lib/src/chunk/types.rs, and the NormalEntry struct in lib/src/entry.rs was extended to store and process ACLs, allowing them to be included in the archive format.
• Entry Builder Updates: The EntryBuilder in lib/src/entry/builder.rs was updated to support the creation and inclusion of ACLs when building new archive entries.
• Windows ACL Constant Verification: A new test file lib/tests/windows_acl_values.rs was added to ensure that the defined Windows ACL permission constants correctly map to the windows crate's constants.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces support for Access Control Lists (ACLs) in libpna. A new acl module is added with data structures for representing ACLs from different platforms (POSIX, macOS, Windows, NFSv4) in a unified format. The changes include a new fACL chunk type, and integration into NormalEntry for serialization and deserialization.

The implementation is comprehensive, but I've found a few critical issues:

• The EntryBuilder is missing a public API to add ACLs, which makes the feature unusable when building new entries.
• The AceFlag bitflags use overlapping values for different platforms, which is error-prone.
• There's a potential for a panic when serializing an Acl with a large number of entries.

I've left specific comments with suggestions on how to address these points. Additionally, a new test file for verifying Windows ACL constant values is a great addition for ensuring correctness.

[gemini-code-assist]

The conversion self.entries.len() as u16 will panic with an overflow if the number of entries exceeds 65,535. While a very large number of ACEs is unlikely, it's safer to handle this case gracefully. Since this function doesn't return a Result, an explicit check with expect is a good way to provide a more informative panic message.

Suggested change

	let entry_count = self.entries.len() as u16;
	let entry_count = u16::try_from(self.entries.len())
	.expect("number of ACL entries should not exceed u16::MAX");