NSS CK_GCM_PARAMS change
Because of changes to the PKCS #11 spec in PKCS #11 v3.0, NSS needs to change the definition of the CK_GCM_PARAMS structure in a source incompatible way. Upstream made this change in NSS 3.52. This change does not affect the ABI. Old programs compiled with older versions of NSS will still work. Only packages that use NSS and directly call AES GCM are affected.
- Name: Bob Relyea
- Email: firstname.lastname@example.org
- Targeted release: Fedora 34
- Last updated: 2020-08-06
- FESCo issue: #2400
- Tracker bug: #1866878
- Release notes tracker: #544
PKCS #11 2.40 had a mismatch between the spec and the released header file for the CK_GCM_PARAMS structure. The latter is controlling. We created our header based on the former. In PKCS #11 v3.0 the reconciled this, but it left us with and incompatible header. The new (to NSS) definition has a new field ulIvBits, which must be set correctly (see below).
To solve this, the NSS 3.52 headers has definitions for both structures: CK_NSS_GCM_PARAMS is the original NSS definition and CK_GCM_PARAMS_V3 is the new (to NSS) definition matching the current spec. CK_GCM_PARAMS will take on the definition of CK_GCM_PARAM_V3 by default, and CK_NSS_GCM_PARAMS if the code is compiled with NSS_PKCS11_2_0_COMPAT defined.
The current NSS builds in fedora have changes the sense of this #define so defining NSS_PKCS11_3_0_STRICT to gets the new behavior, and keep the old behavior by default. NSS builds will automatically switch back to the upstream default in Fedora 34. None of the changes below actually requires setting the NSS_PKCS11_3_STRICT define, though doing so can test that all but option 1 is functioning. These changes can be made in the current fedora as long as you have NSS 3.52.
Applications can fix this the following ways:
#define NSS_PKCS11_2_0_COMPAT 1
or compile with -DNSS_PKCS11_2_0_COMPAT
your app will compile and run using current and older versions of NSS (no need for nss 3.52), but may break on newer tokens that use the new definition (same as the previous behavior). Do this if your packages needs to compile in enviroments that have old versions of nss.
rename all occurances of CK_GCM_PARAMS to CK_NSS_GCM_PARAMS (this will now require nss >= 3.52 to compile, but won't change based on NSS_PKCS11_2_0_COMPAT or NSS_PKCS11_3_0_STRICT). Like option 1 it may break on newer tokens.
rename all occurances of CK_GCM_PARAMS to CK_GCM_PARAMS_V3 and set ulIvBits to ulIvLen*8.
This will require nss >= 3.52 to compile and to run. Should run on all new tokens. May break on older tokens.
Move to PK11_AEADOp interface, which all requires nss >= 3.52 to compile and run, but it's less surprising and the dependency will be picked up automatically because you are using a new for 3.52 interface, so it will continue to work against all tokens.
Option 4 is the preferred solution. It takes advantage the the PKCS #11 v3 interface for AES_GCM while removing any PCKS #11 param structure dependency in the application. It also handles backward compatibility on older tokens and automatically detects which flavor of data structure is supported. It also would help with applications that support two or more of AES_GCM, AES_CCM, and CHACHA_POLY.
Benefit to Fedora
This change will keep fedora with the NSS upstream as well as make Fedora compliant with the official OASIS PKCS #11 spec.
- Proposal owners:
NSS 3.52 has already had builds made with the reverse sense. NSS will need to be rebuilt at the start of Fedora 34.
- Other developers:
Developers need to choose one of the options listed in the description by fedora 34 or their rebuilt packages will fail at runtime.
- Release engineering: #Releng issue number 9486
I believe there is no additional release engineering requirements for this bug. Only packages which use CK_AES_GCM_PARAMS need action and the action can happen outside the release process.
- Policies and guidelines:
There isn't any policy or guideline changes needed for this change.
- Trademark approval: N/A (not needed for this Change)
There is no upgrade impact. There will be a source level incompatibility on rebuild at fedora 34. This change is to allow a transition in fedora 33 where source code can be updated in ways that work in both fedora 33 and fedora 34 after recompile. There are no binary compatibility issues (old applications compiled with the old version of nss will continue to work).
How To Test
- . Grep for CK_AES_GCM_PARAMS in our source tree. If it does not appear, no further action is needed.
- . If you choose options 2-4, you can do a normal test build and run your normal tests against any version of nss > 3.52
- . If you think you don't need to make a change, compile your package with -DNSS_PKCS11_3_0_STRICT and run your normal tests. If everything works should should not need further action.
- . option 1 would require building NSS without the patch and then rebuilding with your package. Only use option 1 if you need to build your package against older versions of nss.
NOTE: The effect of not changing will create a runtime issue where your AES_GCM call will fail after recompiling.
Users who don't build their own packages will see no issues. Users that build their own packages and use classic NSS AES_GCM will see runtime failures after a rebuild unless they update their packages.
nss-3.52 or greater. nss-3.52 is now available in all supported versions of fedora.
- Contingency mechanism:
If critical packages are not updated, the NSS team can turn off the automatic move in fedora 34. If non-critical packages do not update, then they will just fail on the first rebuild in fedora 34. Libreswan is the only critical package we know of at this time that is affected. Upstream already has the appropriate changes.
- Contingency deadline: beta freeze
- Blocks release? Yes, but only for critical packages.
Description contains the notes that upstream is working on, modified for fedora. I'll include links once upstream has released them.
Replicate the description in the release notes of fedora 33 and fedora 34. Users can make their own changes in fedora 33 before fedora 34 is released.