Skip to content
This repository was archived by the owner on Jan 23, 2026. It is now read-only.

Workaround the MacOS system certificate store issue with some SSL certs#364

Merged
NickCao merged 1 commit intomainfrom
fix-362
Mar 20, 2025
Merged

Workaround the MacOS system certificate store issue with some SSL certs#364
NickCao merged 1 commit intomainfrom
fix-362

Conversation

@mangelajo
Copy link
Copy Markdown
Member

@mangelajo mangelajo commented Mar 20, 2025

Adds the JUMPSTARTER_FORCE_SYSTEM_CERTS env variable to still allow importing the
system certificate store in MacOS

Fixes-Issue: #362

Summary by CodeRabbit

  • New Features
    • Introduced a new environment variable, JUMPSTARTER_FORCE_SYSTEM_CERTS, that allows users to enforce the use of system CA certificates even on systems (like macOS) where this is not the default behavior.
  • Documentation
    • Updated configuration instructions to include details about the new environment variable, providing users clearer guidance on managing SSL certificate handling.

Adds the JUMPSTARTER_FORCE_SYSTEM_CERTS env variable to still allow importing the
system certificate store in MacOS

Fixes-Issue: #362
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 20, 2025

Walkthrough

The changes introduce a new environment variable, JUMPSTARTER_FORCE_SYSTEM_CERTS, to the CLI configuration documentation. Additionally, the code in the OIDC module has been updated to conditionally inject system CA certificates into SSL. The new logic prevents the injection on macOS by default unless the environment variable is explicitly set to "1". These modifications enhance the configurability and flexibility of the system certificate handling process.

Changes

File Change Summary
docs/source/config/cli.md Added new environment variable JUMPSTARTER_FORCE_SYSTEM_CERTS with instructions to set it to "1" to enable system CA certificates (except default behavior on macOS).
packages/.../oidc.py Modified SSL injection logic: now conditionally calls truststore.inject_into_ssl() only if the OS is not macOS or if JUMPSTARTER_FORCE_SYSTEM_CERTS is set to "1".

Sequence Diagram(s)

sequenceDiagram
    participant OIDC as OIDC Module
    participant OS as Operating System
    participant TS as Truststore

    OIDC->>OS: Determine OS type (e.g., "Darwin"?)
    OS-->>OIDC: Return OS info
    alt Non-Darwin or forced system certs enabled
        OIDC->>TS: Call inject_into_ssl()
    else MacOS without forced flag
        OIDC-->>TS: Skip certificate injection
    end
Loading

Poem

I'm a little rabbit, hopping through code today,
New flags in the config brighten my array.
System certs dance only when conditions are right,
Skipping macOS with a twitch of delight.
Hop along with me in this codey light! 🐇
All is secure and merry in our digital play.

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

@mangelajo mangelajo requested review from NickCao and kirkbrauer and removed request for NickCao March 20, 2025 13:35
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 20, 2025

Deploy Preview for jumpstarter-docs ready!

Name Link
🔨 Latest commit 4f8e1b3
🔍 Latest deploy log https://app.netlify.com/sites/jumpstarter-docs/deploys/67dc199295257d00081d9940
😎 Deploy Preview https://deploy-preview-364--jumpstarter-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Copy Markdown
Contributor

@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: 0

🧹 Nitpick comments (1)
docs/source/config/cli.md (1)

137-138: Fix capitalization of "macOS"

The documentation for the new environment variable looks good, but there's a minor issue with the capitalization of "macOS" (Apple's preferred spelling).

- which is the behavior by default for all systems but MacOS (see [bug](https://github.com/jumpstarter-dev/jumpstarter/issues/362))
+ which is the behavior by default for all systems but macOS (see [bug](https://github.com/jumpstarter-dev/jumpstarter/issues/362))
🧰 Tools
🪛 LanguageTool

[grammar] ~138-~138: The operating system from Apple is written “macOS”.
Context: ...behavior by default for all systems but MacOS (see [bug](https://github.com/jumpstart...

(MAC_OS)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9fef5c7 and 4f8e1b3.

📒 Files selected for processing (2)
  • docs/source/config/cli.md (1 hunks)
  • packages/jumpstarter-cli-common/jumpstarter_cli_common/oidc.py (2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/source/config/cli.md

[grammar] ~138-~138: The operating system from Apple is written “macOS”.
Context: ...behavior by default for all systems but MacOS (see [bug](https://github.com/jumpstart...

(MAC_OS)

⏰ Context from checks skipped due to timeout of 90000ms (5)
  • GitHub Check: build
  • GitHub Check: pytest-matrix (3.13)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-devspace .devfile/Containerfile.client)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter-utils Dockerfile.utils)
  • GitHub Check: build-and-push-image (jumpstarter-dev/jumpstarter Dockerfile)
🔇 Additional comments (2)
packages/jumpstarter-cli-common/jumpstarter_cli_common/oidc.py (2)

2-2: LGTM - Added import for os module

The import for os module is correctly added to support the operating system detection and environment variable access.


16-21:

Details

✅ Verification successful

Proper workaround for macOS certificate issue

The conditional check properly prevents system certificate injection on macOS unless explicitly requested through the environment variable. This effectively addresses the issue #362 while maintaining backward compatibility for other platforms.


🏁 Script executed:

#!/bin/bash
# Verify that the Darwin check is consistent with other platform checks in the codebase
rg -i "darwin|macos|os\.uname\(\)\.sysname" --type py

Length of output: 349


Verified Darwin Check Successfully Consistent

The check in packages/jumpstarter-cli-common/jumpstarter_cli_common/oidc.py correctly uses the condition if os.uname().sysname != "Darwin" or os.environ.get("JUMPSTARTER_FORCE_SYSTEM_CERTS") == "1": to prevent the injection of system certificates on macOS unless explicitly forced via the environment variable. The search output confirms that this pattern is unique to this location and aligns with expected behavior to address issue #362 while preserving compatibility across other platforms.

@NickCao NickCao merged commit 22f8291 into main Mar 20, 2025
18 checks passed
@NickCao NickCao deleted the fix-362 branch March 31, 2025 15:44
@mangelajo mangelajo added this to the 0.6.0 milestone May 8, 2025
@coderabbitai coderabbitai Bot mentioned this pull request May 14, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants