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

Bundle certificates script #8137

Closed
wants to merge 15 commits into from

Conversation

desrosj
Copy link
Contributor

@desrosj desrosj commented Jan 16, 2025

Adds exact copies of Mozilla certificates, splits out the legacy 1024-bit certificates included for backwards compatibility, and introduces a Grunt task that combines the two for shipping.

Trac ticket: https://core.trac.wordpress.org/ticket/62812


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

@desrosj desrosj self-assigned this Jan 16, 2025
Copy link

github-actions bot commented Jan 16, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props desrosj, johnbillion, swissspidy.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

- Don't copy raw certificate files during build.
- Build certificate bundle before copying over files.
Copy link
Member

@johnbillion johnbillion left a comment

Choose a reason for hiding this comment

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

This is generally a good idea and perhaps once this is in we should add a workflow which updates the certs periodically and opens a PR when there's an update. This is what Requests does.

I think the legacy certs should remain prepended rather than appended. Related discussion in:

@johnbillion
Copy link
Member

Ooh we could add https://github.com/composer/ca-bundle as a dev dependency, extract the cert bundle from that, and keep it updated via Dependabot. No need to roll our own solution.

@desrosj
Copy link
Contributor Author

desrosj commented Jan 29, 2025

Thanks @johnbillion, hadn't thought of checking Composer. Updated the PR to utilize that package as a dependency.

Copy link
Member

@johnbillion johnbillion left a comment

Choose a reason for hiding this comment

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

Neat!

composer.json Outdated Show resolved Hide resolved
@johnbillion
Copy link
Member

johnbillion commented Jan 29, 2025

I think composer/ca-bundle will need to be pinned to protect us against a theoretical future problem. My understanding is that the build server on dotorg doesn't use Composer, but if a change was made so that it does then there's a chance that a newer version of composer/ca-bundle would get pulled in and deployed during the build.

  1. Latest version of composer/ca-bundle is currently 1.5.5
  2. Build server runs composer install and pulls in a theoretical version 1.5.6 because there's no lock file in use
  3. Build server runs npm run build which calls grunt build which calls grunt build:certificates which calls grunt concat:certificates which concatenates version 1.5.6 of vendor/composer/ca-bundle/res/cacert.pem into wp-includes/certificates/cacert.pem
  4. Build server deploys WordPress with version 1.5.6 of the cert despite 1.5.5 being present in the source

Does that make sense?

@desrosj
Copy link
Contributor Author

desrosj commented Jan 29, 2025

It does. I have set up the script to only copy the cert files from vendor when running grunt update-certificates, though.

If I have done it correctly, then when build is run it should not have any impact if the version of the Composer package is changed some how. It should only use the versioned revision of the file in the src/wp-includes/certificates folder.

This was mainly to ensure someone could still run npm build without also having to run composer (install|update). But this shoudl also cover the scenario you are describing, if I understand correctly.

@johnbillion
Copy link
Member

Ah yes you are correct. copy:certificates is what copies the cert from the vendor directory, and that doesn't get run during the build. All good.

Copy link
Member

@swissspidy swissspidy left a comment

Choose a reason for hiding this comment

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

I like the composer approach! 👍

Copy link

A commit was made that fixes the Trac ticket referenced in the description of this pull request.

SVN changeset: 59740
GitHub commit: 6db1a33

This PR will be closed, but please confirm the accuracy of this and reopen if there is more work to be done.

@github-actions github-actions bot closed this Jan 30, 2025
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