Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

look(1): Capsicumise #1489

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

look(1): Capsicumise #1489

wants to merge 1 commit into from

Conversation

kfv
Copy link
Contributor

@kfv kfv commented Oct 24, 2024

No description provided.

@lwhsu
Copy link
Member

lwhsu commented Oct 25, 2024

@oshogbo can you review this?

usr.bin/look/look.c Outdated Show resolved Hide resolved
do {
if ((fd = open(file, O_RDONLY, 0)) < 0 || fstat(fd, &sb))
#ifndef WITHOUT_CAPSICUM
cap_rights_init(&rights, CAP_MMAP_R, CAP_READ, CAP_FSTAT);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why we need WITHOUT_CAPSICUM, look doesn't seem to be in contrib.
Seems like using capsicum_helpers also might simplify the process.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used WITHOUT_CAPSICUM assuming it is required to handle cases where the kernel is built without Capsicum support, rather than strictly for tools in contrib. Could you clarify if my understanding is off? I'd appreciate any insights!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On FreeBSD if you build a kernel without the CAPSICUM support the cap_* functions still exists however they will fail and return ENOSYS.
To avoid checking errno you can use capsicum helpers.
The WITHOUT_CAPSICUM is for platforms that aren't aware of capsicum's existence, like Linux. So we have to add them to contrib source code which isn't managed by FreeBSD but not in the code that is dedicated for FreeBSD.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I didn't know that. I'll take care of it.

#ifndef WITHOUT_CAPSICUM
cap_rights_init(&rights, CAP_MMAP_R, CAP_READ, CAP_FSTAT);
#endif
int fds[argc > 1 ? argc - 1 : argc];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use dynamic stack variable initialization from newer C. You should use malloc or calloc.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't find anything in style(9) explicitly disallowing VLAs, and technically they’re not from 'newer' C—VLAs have been part of the standard since C99 and are mandatory again in C23 (after being optional since C11.) I believe using a VLA here would simplify our approach significantly and avoid unnecessary heap allocation, improving memory efficiency. I’d like to request reconsideration for this specific case, but if there’s a strong rationale against VLAs in general, I'd appreciate any guidance on it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you are right. However, I (maybe I should say We as project) try to avoid them. Stack is limited and I don't want to even analyze if we won't exceed it on all supported platforms or if the command line lenght limit will be enough.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All right, it makes sense.

@oshogbo
Copy link
Contributor

oshogbo commented Oct 31, 2024

@kfv Can you also fix the style issues reported by GitHub Actions?

@kfv
Copy link
Contributor Author

kfv commented Nov 1, 2024

@oshogbo: The style checks are already passing, but I assume you're referring to the warnings for lines exceeding 80 characters. I’ll go ahead and address those as well, sure.

@kfv kfv force-pushed the kfv/capsicum/look branch from 8201453 to cc71657 Compare November 1, 2024 10:13
@kfv
Copy link
Contributor Author

kfv commented Nov 1, 2024

@oshogbo: I applied soft wrapping but kept mmap() on line 162 unwrapped for clarity. I also removed WITHOUT_CAPSICUM by handling ENOSYS as suggested. I’ll just need to go over the code again to address the dynamic stack allocation we discussed.

Signed-off-by: Faraz Vahedi <kfv@kfv.io>
@kfv kfv force-pushed the kfv/capsicum/look branch from cc71657 to 3a79009 Compare November 1, 2024 11:05
@oshogbo
Copy link
Contributor

oshogbo commented Nov 27, 2024

Sorry, why haven't we used capsicum_helpers here?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants