Latest revision as of 14:54, 24 December 2024

dropping Of cert.pem file

This is a proposed Change for Fedora Linux.
This document represents a proposed Change. As part of the Changes process, proposals are publicly announced in order to receive community feedback. This proposal will only be implemented if approved by the Fedora Engineering Steering Committee.

Summary

In order to increase the performance of OpenSSL by default using directory-hash format we need to drop the /etc/pki/tls/cert.pem file to prevent it from being loaded by default. This also includes the certificate bundles in /etc/pki/tls/certs/ folder(ca-certificates.crt, ca-bundle.crt).

Owner

Name: František Krenželok
Email: fkrenzel@redhat.com

Current status

Targeted release: Fedora Linux 42
Last updated: 2024-12-24
Initial Announcement
Re-announcement
Discussion thread
FESCo issue: #3293
Tracker bug: <will be assigned by the Wrangler>
Release notes tracker: <will be assigned by the Wrangler>

Detailed Description

In order to improve the loading time of OpenSSL, a directory-hash support was added to ca-certificates. In order for OpenSSL to use the directory-hash format by default we need to stop it from trying to load /etc/pki/tls/cert.pem by deleting it. This also applies to the certificate bundles in /etc/pki/tls/certs/ folder(ca-certificates.crt, ca-bundle.crt).

Feedback

(a) Changing the OpenSSL configuration directory (OPENSSLDIR)

Automated tools often rely on the output of openssl version -d to infer locations such as <OPENSSLDIR>/openssl.cnf as the configuration file. Changing OPENSSLDIR risks breaking these assumptions and complicating integrations.

A possible solution could be changing the directory to something like /usr/lib/openssl/ and shipping a symlink, e.g., /usr/lib/openssl/openssl.cnf -> /etc/pki/tls/openssl.cnf. However, this is less than ideal.

(b) Patching the OpenSSL source code

This approach involves patching OpenSSL to use directories outside of the OPENSSLDIR/certs default for the root certificates.

Although it avoids relocating the configuration file. It introduces a downstream patch that would need to be maintained indefinitely(There are already loads of patches and the maintainers really dislike this idea). Such a patch would also be unexpected behavior for users accustomed to upstream defaults.

This was partly discussed here: https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/NNVFZMRDXNJN6OJE2ZUJ3NWPHUW6EB2F/

Note: Option (a) is gravely discouraged. Option (b) could be implemented instead, but it still has drawbacks, including potentially unforeseen ones.

Benefit to Fedora

Applications using OpenSSL(possibly other libraries as well) will benefit from much faster initialization of OpenSSL.

Scope

Other developers:

Any package loading the root certificates from any of the following bundles:

/etc/pki/tls/cert.pem

/etc/pki/tls/certs/ca-certificates.crt

/etc/pki/tls/ca-bundle.crt

needs to preferably use the defaults of the library or if they must, use the /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem file instead.

Release engineering: #Releng issue number
Policies and guidelines: N/A (not needed for this Change)
Trademark approval: N/A (not needed for this Change)
Alignment with the Fedora Strategy: neither does nor doesn't

Upgrade/compatibility impact

Once this change is integrated, the packages/software using any of the following files /etc/pki/tls/cert.pem /etc/pki/tls/certs/ca-certificates.crt /etc/pki/tls/ca-bundle.crt as a root certificate bundle file might encounter connectivity issues.

How To Test

Target behavior: OpenSSL initialization takes less time when the file isn't present compared to it being there.

1. The following will create a symlink for testing after the change has been integrated(i.e. the .../tls/cert.pem file is missing)

ln -s /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem /etc/pki/tls/cert.pem

2. Test the time of OpenSSL initialization or a package using it with and without the aforementioned symlink. (If there is no difference for package then it is most likely due to OpenSSL not being configured to search for certs in default location)

User Experience

Packages using a OpenSSL will have faster initialization time.

Dependencies

Any package using /etc/pki/tls/cert.pem,/etc/pki/tls/certs/ca-certificates.crt or /etc/pki/tls/ca-bundle.crt file are affected. It is required that the maintainers change this so that user experience is not compromised.

Contingency Plan

Contingency mechanism: We will postpone the change if majority or critical package owners will be unable to make appropriate changes.
Contingency deadline: before end of beta freeze(2025-02-18).
Blocks release? The feature doesn't block release.

Documentation

The change is documented as a part of ca-certificates package changelog.

Release Notes

The /etc/pki/tls/cert.pem certificate file has been Removed.

@@ Line 1: / Line 1: @@
-{{admon/important | Comments and Explanations | The page source contains comments providing guidance to fill out each section. They are invisible when viewing this page. To read it, choose the "view source" link.<br/> '''Copy the source to a ''new page'' before making changes!  DO NOT EDIT THIS TEMPLATE FOR YOUR CHANGE PROPOSAL.'''}}
+= dropping Of cert.pem file =
-{{admon/tip | Guidance | For details on how to fill out this form, see the [https://docs.fedoraproject.org/en-US/program_management/changes_guide/ documentation].}}
-{{admon/tip | Report issues | To report an issue with this template, file an issue in the [https://pagure.io/fedora-pgm/pgm_docs pgm_docs repo].}}
-<!-- The actual name of your proposed change page should look something like: Changes/Your_Change_Proposal_Name.  This keeps all change proposals in the same namespace -->
-= droping Of Cert Pem File  <!-- The name of your change proposal --> =
 {{Change_Proposal_Banner}}
 == Summary ==
-<!-- A sentence or two summarizing what this change is and what it will do. This information is used for the overall changeset summary page for each release. Note that motivation for the change should be in the Benefit to Fedora section below, and this part should answer the question "What?" rather than "Why?". -->
+In order to increase the performance of OpenSSL by default using directory-hash format we need to drop the /etc/pki/tls/cert.pem file to prevent it from being loaded by default. This also includes the certificate bundles in /etc/pki/tls/certs/ folder(ca-certificates.crt, ca-bundle.crt).
 == Owner ==
-<!--
+* Name: [[User:Fkrenzel| František Krenželok]]
-For change proposals to qualify as self-contained, owners of all affected packages need to be included here. Alternatively, a SIG can be listed as an owner if it owns all affected packages.
+* Email: fkrenzel@redhat.com
-This should link to your home wiki page so we know who you are.
--->
-* Name: [[User:FASAcountName| Your Name]]
-<!-- Include you email address that you can be reached should people want to contact you about helping with your change, status is requested, or technical issues need to be resolved. If the change proposal is owned by a SIG, please also add a primary contact person. -->
-* Email: <your email address so we can contact you, invite you to meetings, etc. Please provide your Bugzilla email address if it is different from your email in FAS>
 <!--- UNCOMMENT only for Changes with assigned Shepherd (by FESCo)
 * FESCo shepherd: [[User:FASAccountName| Shehperd name]] <email address>
@@ Line 28: / Line 15: @@
 == Current status ==
-[[Category:ChangePageIncomplete]]
+[[Category:ChangeAnnounced]]
-<!-- When your change proposal page is completed and ready for review and announcement -->
+[[Category:SystemWideChange]]
-<!-- remove Category:ChangePageIncomplete and change it to Category:ChangeReadyForWrangler -->
+* Targeted release: [https://docs.fedoraproject.org/en-US/releases/f42/ Fedora Linux 42]
-<!-- The Wrangler announces the Change to the devel-announce list and changes the category to Category:ChangeAnnounced (no action required) -->
-<!-- After review, the Wrangler will move your page to Category:ChangeReadyForFesco... if it still needs more work it will move back to Category:ChangePageIncomplete-->
-<!-- Select proper category, default is Self Contained Change -->
-[[Category:SelfContainedChange]]
-<!-- [[Category:SystemWideChange]] -->
-* Targeted release: [https://docs.fedoraproject.org/en-US/releases/f<VERSION>/ Fedora Linux <VERSION>]
 * Last updated: <!-- this is an automatic macro — you don't need to change this line -->  {{REVISIONYEAR}}-{{REVISIONMONTH}}-{{REVISIONDAY2}}
 <!-- After the change proposal is accepted by FESCo, tracking bug is created in Bugzilla and linked to this page
@@ Line 46: / Line 25: @@
 ON_QA -> change is fully code complete
 -->
-* [Announced]
+* [https://lists.fedoraproject.org/archives/list/devel-announce@lists.fedoraproject.org/thread/PFXTJCZOWKMW5Z2ZDRZUAVYIT7ZFYKKL/ Initial Announcement]
-* [<will be assigned by the Wrangler> Discussion thread]
+* [https://lists.fedoraproject.org/archives/list/devel-announce@lists.fedoraproject.org/thread/WH23HNBG7XZS3KFEZTW3RHFDSJNQNPBS/ Re-announcement]
-* FESCo issue: <will be assigned by the Wrangler>
+* [https://discussion.fedoraproject.org/t/f42-change-proposal-dropping-of-cert-pem-file-system-wide/140616 Discussion thread]
+* FESCo issue: [https://pagure.io/fesco/issue/3293 #3293]
 * Tracker bug: <will be assigned by the Wrangler>
 * Release notes tracker: <will be assigned by the Wrangler>
 == Detailed Description ==
-<!-- Expand on the summary, if appropriate.  A couple sentences suffices to explain the goal, but the more details you can provide the better. -->
+In order to improve the loading time of OpenSSL, a directory-hash support was added to ca-certificates. In order for OpenSSL to use the directory-hash format by default we need to stop it from trying to load /etc/pki/tls/cert.pem by deleting it. This also applies to the certificate bundles in /etc/pki/tls/certs/ folder(ca-certificates.crt, ca-bundle.crt).
 == Feedback ==
-<!-- Summarize the feedback from the community and address why you chose not to accept proposed alternatives. This section is optional for all change proposals but is strongly suggested. Incorporating feedback here as it is raised gives FESCo a clearer view of your proposal and leaves a good record for the future. If you get no feedback, that is useful to note in this section as well. For innovative or possibly controversial ideas, consider collecting feedback before you file the change proposal. -->
+=== (a) Changing the OpenSSL configuration directory (OPENSSLDIR) ===
-== Benefit to Fedora ==
+Automated tools often rely on the output of openssl version -d to infer locations such as <OPENSSLDIR>/'''openssl.cnf''' as the configuration file.
-<!-- What is the benefit to the distribution?  Will the software we generate be improved? How will the process of creating Fedora releases be improved?
+Changing OPENSSLDIR risks breaking these assumptions and complicating integrations.
-      Be sure to include the following areas if relevant:
-      If this is a major capability update, what has changed?
-           For example: This change introduces Python 5 that runs without the Global Interpreter Lock and is fully multithreaded.
-      If this is a new functionality, what capabilities does it bring?
-           For example: This change allows package upgrades to be performed automatically and rolled-back at will.
-      Does this improve some specific package or set of packages?
-           For example: This change modifies a package to use a different language stack that reduces install size by removing dependencies.
-      Does this improve specific Spins or Editions?
-           For example: This change modifies the default install of Fedora Workstation to be more in line with the base install of Fedora Server.
-      Does this make the distribution more efficient?
-           For example: This change replaces thousands of individual %post scriptlets in packages with one script that runs at the end.
-      Is this an improvement to maintainer processes?
-           For example: Gating Fedora packages on automatic QA tests will make rawhide more stable and allow changes to be implemented more smoothly.
-      Is this an improvement targeted as specific contributors?
-           For example: Ensuring that a minimal set of tools required for contribution to Fedora are installed by default eases the onboarding of new contributors.
-     When a Change has multiple benefits, it's better to list them all.
+A possible solution could be changing the directory to something like /usr/lib/openssl/ and shipping a symlink, e.g., `/usr/lib/openssl/openssl.cnf -> /etc/pki/tls/openssl.cnf.` However, this is less than ideal.
-     Consider these Change pages from previous editions as inspiration:
+=== (b) Patching the OpenSSL source code ===
-     https://fedoraproject.org/wiki/Changes/Annobin (low-level and technical, invisible to users)
+This approach involves patching OpenSSL to use directories outside of the OPENSSLDIR/certs default for the root certificates.
-     https://fedoraproject.org/wiki/Changes/ParallelInstallableDebuginfo (low-level, but visible to advanced users)
-     https://fedoraproject.org/wiki/Changes/VirtualBox_Guest_Integration (primarily a UX change)
-     https://fedoraproject.org/wiki/Changes/NoMoreAlpha (an improvement to distro processes)
-     https://fedoraproject.org/wiki/Changes/perl5.26 (major upgrade to a popular software stack, visible to users of that stack)
--->
-== Scope ==
+Although it avoids relocating the configuration file.
-* Proposal owners:
+It introduces a downstream patch that would need to be maintained indefinitely(There are already loads of patches and the maintainers really dislike this idea).
-<!-- What work do the feature owners have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+Such a patch would also be unexpected behavior for users accustomed to upstream defaults.
-* Other developers: <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+This was partly discussed here:
-<!-- What work do other developers have to accomplish to complete the feature in time for release?  Is it a large change affecting many parts of the distribution or is it a very isolated change? What are those changes?-->
+https://lists.fedoraproject.org/archives/list/devel@lists.fedoraproject.org/thread/NNVFZMRDXNJN6OJE2ZUJ3NWPHUW6EB2F/
-* Release engineering: [https://pagure.io/releng/issues #Releng issue number] <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+Note: Option (a) is gravely discouraged. Option (b) could be implemented instead, but it still has drawbacks, including potentially unforeseen ones.
-<!-- Does this feature require coordination with release engineering (e.g. changes to installer image generation or update package delivery)?  Is a mass rebuild required?  include a link to the releng issue.
-The issue is required to be filed prior to feature submission, to ensure that someone is on board to do any process development work and testing and that all changes make it into the pipeline; a bullet point in a change is not sufficient communication -->
-* Policies and guidelines: N/A (not needed for this Change) <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+== Benefit to Fedora ==
-<!-- Do the packaging guidelines or other documents need to be updated for this feature?  If so, does it need to happen before or after the implementation is done?  If a FPC ticket exists, add a link here. Please submit a pull request with the proposed changes before submitting your Change proposal. -->
+Applications using OpenSSL(possibly other libraries as well) will benefit from much faster initialization of OpenSSL.
-* Trademark approval: N/A (not needed for this Change)
+== Scope ==
-<!-- If your Change may require trademark approval (for example, if it is a new Spin), file a ticket ( https://pagure.io/Fedora-Council/tickets/issues ) requesting trademark approval from the Fedora Council. This approval will be done via the Council's consensus-based process. -->
+* Other developers:
+Any package loading the root certificates from any of the following bundles:
-* Alignment with the Fedora Strategy:
+`/etc/pki/tls/cert.pem`
-<!-- Does your proposal align with the current Fedora Strategy: https://discussion.fedoraproject.org/t/fedora-strategy-2028-february-march-planning-work-and-roadmap-til-flock/43618 ? It's okay if it doesn't, but it's something to consider -->
-== Upgrade/compatibility impact ==
+`/etc/pki/tls/certs/ca-certificates.crt`
-<!-- What happens to systems that have had a previous versions of Fedora installed and are updated to the version containing this change? Will anything require manual configuration or data migration? Will any existing functionality be no longer supported? -->
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+`/etc/pki/tls/ca-bundle.crt`
-== Early Testing (Optional) ==
+needs to preferably use the defaults of the library or if they must, use the `/etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem` file instead.
-<!-- This is an optional step for system-wide changes to avail of. If you would like to build an initial proof of concept of your change and have a member of Fedora QA help you write and/or run some initial basic tests on your code, please email tests@fedoraproject.org and include the link to your change proposal. This step is *optional*. -->
-Do you require 'QA Blueprint' support? Y/N <!-- Optional Step for System-Wide Changes only -->
+* Release engineering: [https://pagure.io/releng/issues #Releng issue number] <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Policies and guidelines: N/A (not needed for this Change)
+* Trademark approval: N/A (not needed for this Change)
+* Alignment with the Fedora Strategy: neither does nor doesn't
+== Upgrade/compatibility impact ==
+Once this change is integrated, the packages/software using any of the following files `/etc/pki/tls/cert.pem` `/etc/pki/tls/certs/ca-certificates.crt` `/etc/pki/tls/ca-bundle.crt` as a root certificate bundle file might encounter connectivity issues.
 == How To Test ==
-<!-- This does not need to be a full-fledged document. Describe the dimensions of tests that this change implementation is expected to pass when it is done.  This can be based off of the above section if early testing has been completed. If it needs to be tested with different hardware or software configurations, indicate them.  The more specific you can be, the better the community testing can be.
+Target behavior: OpenSSL initialization takes less time when the file isn't present compared to it being there.
-Remember that you are writing this how to for interested testers to use to check out your change implementation - documenting what you do for testing is OK, but it's much better to document what *I* can do to test your change.
-A good "how to test" should answer these four questions:
+. The following will create a symlink for testing after the change has been integrated(i.e. the `.../tls/cert.pem` file is missing)
-. What special hardware / data / etc. is needed (if any)?
+`ln -s /etc/pki/ca-trust/extracted/pem/tls-ca-bundle.pem /etc/pki/tls/cert.pem`
-. How do I prepare my system to test this change? What packages
-need to be installed, config files edited, etc.?
-. What specific actions do I perform to check that the change is
-working like it's supposed to?
-. What are the expected results of those actions?
--->
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+. Test the time of OpenSSL initialization or a package using it with and without the aforementioned symlink.
+(If there is no difference for package then it is most likely due to OpenSSL not being configured to search for certs in default location)
 == User Experience ==
-<!-- If this change proposal is noticeable by users, how will their experiences change as a result?
+Packages using a OpenSSL will have faster initialization time.
- This section partially overlaps with the Benefit to Fedora section above. This section should be primarily about the User Experience, written in a way that does not assume deep technical knowledge. More detailed technical description should be left for the Benefit to Fedora section.
- Describe what Users will see or notice, for example:
-  - Packages are compressed more efficiently, making downloads and upgrades faster by 10%.
-  - Kerberos tickets can be renewed automatically. Users will now have to authenticate less and become more productive. Credential management improvements mean a user can start their work day with a single sign on and not have to pause for reauthentication during their entire day.
- - Libreoffice is one of the most commonly installed applications on Fedora and it is now available by default to help users "hit the ground running".
- - Green has been scientifically proven to be the most relaxing color. The move to a default background color of green with green text will result in Fedora users being the most relaxed users of any operating system.
--->
 == Dependencies ==
-<!-- What other packages (RPMs) depend on this package?  Are there changes outside the developers' control on which completion of this change depends?  In other words, completion of another change owned by someone else and might cause you to not be able to finish on time or that you would need to coordinate?  Other upstream projects like the kernel (if this is not a kernel change)? -->
+Any package using `/etc/pki/tls/cert.pem`,`/etc/pki/tls/certs/ca-certificates.crt` or `/etc/pki/tls/ca-bundle.crt` file are affected. It is required that the maintainers change this so that user experience is not compromised.
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 == Contingency Plan ==
+* Contingency mechanism: We will postpone the change if majority or critical package owners will be unable to make appropriate changes.
-<!-- If you cannot complete your feature by the final development freeze, what is the backup plan?  This might be as simple as "Revert the shipped configuration".  Or it might not (e.g. rebuilding a number of dependent packages).  If you feature is not completed in time we want to assure others that other parts of Fedora will not be in jeopardy.  -->
+* Contingency deadline: before end of beta freeze(2025-02-18).
-* Contingency mechanism: (What to do?  Who will do it?) N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
+* Blocks release? The feature doesn't block release.
-<!-- When is the last time the contingency mechanism can be put in place?  This will typically be the beta freeze. -->
-* Contingency deadline: N/A (not a System Wide Change)  <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
-<!-- Does finishing this feature block the release, or can we ship with the feature in incomplete state? -->
-* Blocks release? N/A (not a System Wide Change), Yes/No <!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
 == Documentation ==
 <!-- Is there upstream documentation on this change, or notes you have written yourself?  Link to that material here so other interested developers can get involved. -->
+The change is documented as a part of ca-certificates package changelog.
-<!-- REQUIRED FOR SYSTEM WIDE CHANGES -->
-N/A (not a System Wide Change)
 == Release Notes ==
-<!-- The Fedora Release Notes inform end-users about what is new in the release.  Examples of past release notes are at https://docs.fedoraproject.org/en-US/fedora/latest/release-notes/ -->
+The /etc/pki/tls/cert.pem certificate file has been Removed.
-<!-- The release notes also help users know how to deal with platform changes such as ABIs/APIs, configuration or data file formats, or upgrade concerns.  If there are any such changes involved in this change, indicate them here.  A link to upstream documentation will often satisfy this need.  This information forms the basis of the release notes edited by the documentation team and shipped with the release.
-Release Notes are not required for initial draft of the Change Proposal but has to be completed by the Change Freeze.
--->

Search

Changes/dropingOfCertPemFile: Difference between revisions