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

Implement docker outgoing firewall #254

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Conversation

evanyeyeye
Copy link
Member

@evanyeyeye evanyeyeye commented Apr 1, 2024

Description

  • This PR adds the option to specify allowed outgoing IPs on a per-job level.

Motivation and Context

  • Adds a security option for autograding containers.
  • Provides more flexibility compared to previous binary option of enabling network access.

How Has This Been Tested?

  • Tested by queueing jobs via Autolab.
  • Need to update command-line utility for standalone testing.

Copy link

coderabbitai bot commented Apr 1, 2024

Walkthrough

Walkthrough

The update enhances the system by introducing the capability to specify allowed outgoing IP addresses for jobs, likely aimed at bolstering security and managing network traffic. This new feature spans multiple components, impacting job object creation, Docker-based job execution, and worker job handling. It involves incorporating a parameter to track permitted IPs and setting up network rules to restrict outgoing traffic to these designated addresses during job execution.

Changes

Files Change Summary
tangoREST/tangoREST.py, tangoObjects.py Updated convertJobObj method in tangoREST.py to handle allowed_outgoing_ips in jobObj dictionary, introducing allowedOutgoingIPs to TangoJob object in tangoObjects.py.
vmms/localDocker.py Added allowedOutgoingIPs parameter to runJob method in localDocker.py. Configures iptables rules to allow outgoing traffic to specified IPs before running jobs in Docker containers if networking is enabled.
worker.py Integrated allowedOutgoingIPs into job execution logic in worker.py to enforce restrictions on network traffic.

Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 553bd1d and 70bb3a0.
Files selected for processing (1)
  • vmms/localDocker.py (3 hunks)
Additional comments not posted (1)
vmms/localDocker.py (1)

180-196: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [145-193]

Ensure that the allowedOutgoingIPs parameter is properly validated before use.

While the code correctly handles the allowedOutgoingIPs when disableNetwork is False, it's crucial to ensure that the IPs provided are in a valid format to prevent potential security risks or misconfigurations. Consider adding a validation step to check the format of the IPs before they are used in the iptables command.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

tangoObjects.py Outdated Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

Actionable comments outside the diff hunks (4)
vmms/localDocker.py (3)

Line range hint 5-5: Remove unused import random.

- import random

Line range hint 10-10: Remove unused import threading.

- import threading

Line range hint 12-12: Remove unused import sys.

- import sys
restful_tango/tangoREST.py (1)

Line range hint 19-21: Move module-level imports to the top of the file.

- currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
- parentdir = os.path.dirname(currentdir)
- sys.path.insert(0, parentdir)
+ import sys
+ import os
+ import inspect
+ currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
+ parentdir = os.path.dirname(currentdir)
+ sys.path.insert(0, parentdir)

vmms/localDocker.py Outdated Show resolved Hide resolved
tangoObjects.py Show resolved Hide resolved
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Actionable comments outside the diff hunks (3)
vmms/localDocker.py (3)

Line range hint 5-5: Remove unused import random.

- import random

Line range hint 10-10: Remove unused import threading.

- import threading

Line range hint 12-12: Remove unused import sys.

- import sys

Comment on lines +185 to +187
iptablesCmd += "iptables -A OUTPUT -d 8.8.8.8 -j ACCEPT; "
for IP in allowedOutgoingIPs:
iptablesCmd += f"iptables -A OUTPUT -d {IP} -j ACCEPT; "
Copy link

Choose a reason for hiding this comment

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

Correct the static string in the f-string.

- iptablesCmd += "iptables -A OUTPUT -d 8.8.8.8 -j ACCEPT; "
+ iptablesCmd += f"iptables -A OUTPUT -d 8.8.8.8 -j ACCEPT; "

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
iptablesCmd += "iptables -A OUTPUT -d 8.8.8.8 -j ACCEPT; "
for IP in allowedOutgoingIPs:
iptablesCmd += f"iptables -A OUTPUT -d {IP} -j ACCEPT; "
iptablesCmd += f"iptables -A OUTPUT -d 8.8.8.8 -j ACCEPT; "
for IP in allowedOutgoingIPs:
iptablesCmd += f"iptables -A OUTPUT -d {IP} -j ACCEPT; "

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.

None yet

1 participant