Document limited sudo access configuration #15
Conversation
Added optional configuration for limited sudo access to enhance security when running CortexAI. Signed-off-by: Christopher <chrisgrimmofficial@gmail.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for configuring limited sudo access to enhance security when running CortexAI. The documentation provides detailed instructions on granting specific passwordless sudo permissions, restricting dangerous commands, and handling tool installation safely. Additionally, the PR updates the roadmap to reflect completed features across multiple development phases.
- Added detailed sudo configuration guide with security warnings and best practices
- Updated roadmap checkboxes to mark several Phase 2-6 features as completed
- Provided alternatives for secure tool installation including Docker usage
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| ```bash | ||
| sudo visudo | ||
| ``` | ||
| Granting Specific Passwordless Permissions |
There was a problem hiding this comment.
The heading 'Granting Specific Passwordless Permissions' on line 131 is not formatted as a markdown heading. It should use markdown heading syntax (e.g., '### Granting Specific Passwordless Permissions') to maintain proper document structure and hierarchy.
| Granting Specific Passwordless Permissions | |
| ### Granting Specific Passwordless Permissions |
| Allow cortexuser to run specific commands without a password for CortexAI | ||
| ``` | ||
| cortexuser ALL=(ALL) NOPASSWD: /usr/bin/specific/command1, /usr/bin/another/command --with-options * | ||
| cortexuser: The username running CortexAI. | ||
| ``` |
There was a problem hiding this comment.
The comment on line 136 should be inside the code block as a comment (prefixed with #), and the explanation on line 139 should be outside the code block. The current structure incorrectly places explanatory text inside a code block that's meant to show sudoers file syntax.
| Allow cortexuser to run specific commands without a password for CortexAI | |
| ``` | |
| cortexuser ALL=(ALL) NOPASSWD: /usr/bin/specific/command1, /usr/bin/another/command --with-options * | |
| cortexuser: The username running CortexAI. | |
| ``` |
Allow cortexuser to run specific commands without a password for CortexAI
cortexuser ALL=(ALL) NOPASSWD: /usr/bin/specific/command1, /usr/bin/another/command --with-options *
cortexuser: The username running CortexAI.
| ALL=(ALL): Allows running on this host, usually as root. | ||
|
|
||
| NOPASSWD:: Enables passwordless execution for the listed commands. |
There was a problem hiding this comment.
These explanatory bullet points lack proper markdown list formatting. They should use markdown list syntax (e.g., '- ALL=(ALL): ...') to improve readability and document structure.
|
|
||
| Separate multiple commands with commas. You can use wildcards (*) but do so with extreme caution. | ||
|
|
||
| Restricting Dangerous Commands |
There was a problem hiding this comment.
The heading 'Restricting Dangerous Commands' on line 150 is not formatted as a markdown heading. It should use markdown heading syntax (e.g., '### Restricting Dangerous Commands') to maintain proper document structure and hierarchy.
| Restricting Dangerous Commands | |
| ### Restricting Dangerous Commands |
| Deny dangerous commands for cortexuser even with sudo | ||
| ``` | ||
| cortexuser ALL=(ALL) !/usr/bin/rm *, !/usr/sbin/shutdown, !/usr/sbin/reboot, !/usr/bin/passwd, !/usr/bin/cat /path/to/your/secure/files/* | ||
| ``` | ||
| The ! negates the permission for the specified command. |
There was a problem hiding this comment.
The comment on line 153 should be inside the code block as a comment (prefixed with #), and the explanation on line 157 should be formatted as a proper paragraph or list item rather than appearing as a standalone line after the code block.
| Deny dangerous commands for cortexuser even with sudo | |
| ``` | |
| cortexuser ALL=(ALL) !/usr/bin/rm *, !/usr/sbin/shutdown, !/usr/sbin/reboot, !/usr/bin/passwd, !/usr/bin/cat /path/to/your/secure/files/* | |
| ``` | |
| The ! negates the permission for the specified command. |
Deny dangerous commands for cortexuser even with sudo
cortexuser ALL=(ALL) !/usr/bin/rm , !/usr/sbin/shutdown, !/usr/sbin/reboot, !/usr/bin/passwd, !/usr/bin/cat /path/to/your/secure/files/
- The `!` negates the permission for the specified command.
| ``` | ||
| The ! negates the permission for the specified command. | ||
|
|
||
| Important Note on Tool Installation |
There was a problem hiding this comment.
The heading 'Important Note on Tool Installation' on line 159 is not formatted as a markdown heading. It should use markdown heading syntax (e.g., '### Important Note on Tool Installation') to maintain proper document structure and hierarchy.
| Important Note on Tool Installation | |
| ### Important Note on Tool Installation |
|
|
||
| Deny dangerous commands for cortexuser even with sudo | ||
| ``` | ||
| cortexuser ALL=(ALL) !/usr/bin/rm *, !/usr/sbin/shutdown, !/usr/sbin/reboot, !/usr/bin/passwd, !/usr/bin/cat /path/to/your/secure/files/* |
There was a problem hiding this comment.
The sudo deny rule '!/usr/bin/rm *' is ineffective because the wildcard doesn't work as intended in sudoers syntax. The rule should be '!/usr/bin/rm' without the wildcard, or use '/usr/bin/rm *' within quotes. Additionally, deny rules in sudoers are evaluated differently than allow rules, and this configuration may not provide the intended protection.
| cortexuser ALL=(ALL) !/usr/bin/rm *, !/usr/sbin/shutdown, !/usr/sbin/reboot, !/usr/bin/passwd, !/usr/bin/cat /path/to/your/secure/files/* | |
| cortexuser ALL=(ALL) !/usr/bin/rm, !/usr/sbin/shutdown, !/usr/sbin/reboot, !/usr/bin/passwd, !/usr/bin/cat /path/to/your/secure/files/* |
Added optional configuration for limited sudo access to enhance security when running CortexAI.