Skip to content

infra/image/shdefaults: Add SYS_PTRACE to CAP_DEFAULTS #1351

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

Merged
merged 2 commits into from
Apr 17, 2025

Conversation

t-woerner
Copy link
Member

@t-woerner t-woerner commented Apr 9, 2025

Debugging is now enabled by default in the containers that are generated with container_create. "+SYS_PTRACE" has been added to CAP_DEFAULTS in shdefaults for this.

Copy link

sourcery-ai bot commented Apr 9, 2025

Reviewer's Guide by Sourcery

This pull request introduces a new -d option to the start.sh script, enabling debugging within the container by adding the SYS_PTRACE capability. This allows users to attach a debugger to processes running inside the container.

Sequence diagram for starting the container with debugging enabled

sequenceDiagram
    participant S as start.sh
    participant C as container_create
    participant container_start
    participant container_wait_for_journald
    participant container_wait_up

    S->>S: Parses arguments, including -d
    alt -d is provided
        S->>C: container_create with SYS_PTRACE capability
    else -d is not provided
        S->>C: container_create without SYS_PTRACE capability
    end
    C-->>S: Container created
    S->>container_start: container_start
    container_start-->>S: Container started
    S->>container_wait_for_journald: container_wait_for_journald
    container_wait_for_journald-->>S: Journald ready
    S->>container_wait_up: container_wait_up
    container_wait_up-->>S: Container is up
Loading

File-Level Changes

Change Details Files
Added a new -d option to enable debugging within the container by adding the SYS_PTRACE capability.
  • Added -d option to usage message.
  • Added -d option parsing in getopts.
  • Set SYS_PTRACE capability when -d is used.
  • Pass capabilities to container_create.
infra/image/start.sh

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @t-woerner - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider using more descriptive variable names than single letters in getopts.
  • It might be helpful to add a comment explaining why the SYS_PTRACE capability is required for debugging.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@rjeffman
Copy link
Member

IMHO, this could be the default behavior.

LGTM.

@t-woerner t-woerner force-pushed the infra_image_start_debug branch from f843b5a to 8d688a2 Compare April 17, 2025 12:56
@t-woerner t-woerner changed the title infra/image/start: Add new option to enable debugging infra/image/shdefaults: Add SYS_PTRACE to CAP_DEFAULTS Apr 17, 2025
@t-woerner t-woerner force-pushed the infra_image_start_debug branch 2 times, most recently from c61acbc to 66be7c2 Compare April 17, 2025 12:59
Debugging is now enabled by default in the containers that are
generated with container_create. "+SYS_PTRACE" has been added to
CAP_DEFAULTS in shdefaults for this.
@t-woerner t-woerner force-pushed the infra_image_start_debug branch from 66be7c2 to 4323765 Compare April 17, 2025 13:00
Copy link
Member

@rjeffman rjeffman left a comment

Choose a reason for hiding this comment

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

LGTM

readarray expects to get an item per line to be added to the array.

Printing one item per line with printf fixes this to get the proper
formatting for "${CAP_DEFAULTS[@]}" as a valid input for readarray.
@t-woerner t-woerner force-pushed the infra_image_start_debug branch from 2a62826 to 638422e Compare April 17, 2025 14:46
@rjeffman rjeffman merged commit 7245339 into freeipa:master Apr 17, 2025
18 checks passed
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.

2 participants