• Robert Relyea's avatar
    Bug 1707130 NSS should use modern algorithms in PKCS#12 files by default r=mt · 71f201b8
    Robert Relyea authored
    Also fixes:
    Bug 452464 pk12util -o fails when -C option specifies AES or Camellia ciphers
    
    Related:
    Bug 1694689 Firefox should use modern algorithms in PKCS#12 files by default
    Bug 452471 pk12util -o fails when -c option specifies pkcs12v2 PBE ciphers
    
    
    The base of this fix is was a simple 3 line fix in pkcs12.c, changing the initial setting of cipher and cert cipher.
    
    Overview for why this patch is larger than just 3 lines:
    1. First issue was found in trying to change the mac hashing value.
       a. While the decrypt side knew how to handle SHA2 hashes, the equivalent code was not updated on the encrypt side. I refactored that code and placed the common function in p12local.c. Now p12e.c and p12d.c share common code to find the required function to produce the mac key.
       b. The prf hmac was hard coded to SHA1. I changed the code to pass the hmac matching the hashing algorithm for the mac. This required changes to p12e.c to calculate and pass the new hmac as well and adding new PK11_ExportEncryptedPrivateKey and PK11_ExportEncryptedPrivKey to take the PKCS #5 v2 parameters. I also corrected an error which prevented pkcs12 encoding of ciphers other than AES.
    2. Once I've made my changes, I realized we didn't have a way of testing them. While we had code that verified that particular sets of parameters for pkcs12 worked together and could be listed and imported, we didn't have a way to verify what algorithms were actually generated by our tools.
      a. pk12util -l doesn't list the encryption used for the certs, so I updated pp to take a pkcs12 option. In doing so I had to update pp to handle indefinite encoding when decoding blocks. I also factored that decoding out in it's own function so the change only needed to be placed once. Finally I renabled a function which prints the output of an EncryptedPrivate key. This function was disabled long ago when the Encrypted Private key info was made private for NSS. It has since been exported, so these functions could easily be enabled (archeological note: I verified that this disabling was not a recent think I found I had done it back when I still have a netscape email address;).
     b. I updated tools.sh to us the new pp -t pkcs12 feature to verify that the key encryption, cert encryption, and hash functions matched what we expected when we exported a new key. I also updated tools.sh to handle the new hash variable option to pk12util.
     c. I discovered several tests commented out with comments that the don't work. I enabled those tests and discovered that they can now encrypt, but the can't decrypt because of pkcs12 policy. I updated the policy code, but I updated it to use the new NSS system wide policy mechanism. This enabled all the ciphers to work. There is still policy work to do. The pk12 policy currently only prevents ciphers from use in decrypting the certificates, not decrypting the keys and not encrypting. I left that for future work.
    3. New options for pp and pk12util were added to the man pages for these tools.
    
    ---------------------------------------------------------------------------
    With that in mind, here's a file by file description of the patch:
    
    automation/abi-check/expected-report-libnss3.so.txt
    -Add new exported functions. (see lib/nss/nss.def)
    
    cmd/lib/basicutil.h:
    -Removed the HAVE_EPV_TEMPLATE ifdefs (NSS has exported the Encrypted Private Key data structure for a while now.
    
    cmd/lib/secutil.c:
    global: Updated several functions to take a const char * m (message) rather than a char * m
    global: Made the various PrintPKCS7 return an error code.
    global: Added a state variable to be passed around the various PKCS7 Print functions. It gives the proper context to interpret PKCS7 Data Content. PKCS 12 used PKCS7 to package the various PKCS12 Safes and Bags.
    -Updated SECU_StripTagAndLength to handle indefinite encoding, and to set the Error code.
    -Added SECU_ExtractDERAndStep to grab the next DER Tag, Length, and Data.
    -Updated secu_PrintRawStringQuotesOptional to remove the inline DER parsing and use SECU_ExtractDERAndStep().
    -Updated SECU_PrintEncodedObjectID to return the SECOidTag just like SECU_PrintObjectID.
    -Renable SECU_PrintPrivateKey
    -Added secu_PrintPKCS12Attributes to print out the Attributes tied to a PKCS #12 Bag
    -Added secu_PrintPKCS12Bag to print out a PKCS #12 Bag
    -Added secu_PrintPKCS7Data, which uses the state to determine what it was printing out.
    -Added secu_PrintDERPKCS7ContentInfo which is identical to the global function SECU_PrintPKCS7ContentInfo except it takes a state variable. The latter function now calls the former.
    -Added secu_PrintPKCS12DigestInfo to print the Hash information of the Mac. DigestInfo is the name in the PKCS 12 spec.
    -Added secu_PrintPKCS12MacData to print the Mac portion of the PKCS 12 file.
    -Added SECU_PrintPKCS12 to print otu the pkcs12 file.
    
    cmd/lib/secutil.h
    -Added string for pkc12 for the command line of pp
    reenabled SECU_PrintPrivateKey
    -Added SECU_PrintPKCS12 for export.
    
    cmd/pk12util/pk12util.c
    -Added the -M option to specify a hash algorithm for the mac.
    updated P12U_ExportPKCS12Object: pass the hash algorithm to the PasswordIntegrity handler.
    -Added PKCS12U_FindTagFromString: generalized string to SECOidTag which only filters based on the oid having a matching PKCS #11 mechanism.
    updated PKCS12U_MapCipherFromString to call use PKCS12U_FindTagFromString to get the candidate tag before doing it's post processing to decide if the tag is really an encryption algorithm.
    -Added PKCS12U_MapHashFromString with is like MapCipherFromString except it verifies the resulting tag is a hash object.
    -Updated main to 1) change the default cipher, change the default certCipher, and process the new hash argument. NOTE: in the old code we did not encrypt the certs in FIPS mode. That's because the certs were encrypted with RC4 in the default pkcs12 file, which wasn't a FIPS algorithm. Since AES is, we can use it independent on whether or not we are in FIPS mode.
    
    cmd/pp/pp.c
    -Added the pkcs12 option which calls SECU_PrintPKCS12 from secutil.c
    
    lib/nss/nss.def
    -Add exports to the new PK11_ExportEncryptedPrivKeyInfoV2 and PK11_ExportEncryptedPrivateKeyInfoV2 (V2 means PKCS 5 v2, not Version 2 of ExportEncrypted*Info).
    -Add export for the old HASH_GetHMACOidTagByHashOidTag which should have been exported long ago to avoid the proliferation of copies of this function in places like ssl.
    
    lib/pk11wrap/pk11akey.c
    -Add PK11_ExportEncryptedPrivKeyInfoV2 (which the old function now calls), which takes the 3 PKCS 5 v2 parameters. The underlying pkcs5 code can fill in missing tags if necessary, but supplying all three gives the caller full control of the underlying pkcs5 PBE used.
    -Add PK11_ExportEncryptedPrivateKeyInfoV2, same as the above function except it takes a cert which is used to look up the private key. It's the function that pkcs12 actually uses, but the former was exported for completeness.
    
    lib/pk11wrap/pk11pub.h
    -Added the new PK11_ExportEncryptedPriv*KeyInfoV2 functions.
    
    lib/pkcs12/p12d.c
    -Remove the switch statement and place it in p12local.c so that p12e.c can use the same function.
    
    lib/pkc12/p12e.c
    -Remove the unnecessary privAlg check so we can encode any mechanism we support. This only prevented encoding certificates in the pk12 file, not the keys.
    -add code to get the hmac used in the pbe prf from the integrity hash, which is under application control.
    -Do the same for key encryption, then use the new PK11_ExportEncryptedPrivateKeyInfo to pass that hash value.
    -Use the new sec_pkcs12_algtag_to_keygen_mech so there is only one switch statement to update rather than 2.
    -Update the hash data to old the length of the largest hash rather than the length of a SHA1 hash.
    
    lib/pkcs12/p12local.c
    - Add new function new sec_pkcs12_algtag_to_keygen_mech to factor out the common switch statement between p12e and p12d.
    
    lib/pkcs12/p12local.h
    -Export the new sec_pkcs12_algtag_to_keygen_mech
    
    lib/pkcs12/p12plcy.c
    -Map the old p12 policy functions to use the new NSS_GetAlgorithmPolicy. We keep the old table so that applications can change the policy with the old PKCS12 specific defines (so the old code keeps working). NOTE: policies now default to true rather than false.
    
    lib/util/secoidt.h
    -Add new NSS_USE_ALG_IN_PKCS12 used by pk11plcy.c
    NOTE: I have not updated the policy table in pk11wrap/pk11pars.c, so we can't yet control pkcs12 policy with the nss system policy table. That's a patch for another time.
    
    test/tools/tool.sh
    -global: Remove trailing spaces
    -global: DEFAULT is changed to 'default'
    -Update the PBE mechanism to exactly match the string in secoid.c. PKCS #12 does case independent compares, so case doesn't matter there, but now I'm comparing to the output of pp, and I didn't want to spend the time to figure out case independent compares in bash.
    -Add our defauts and shell variables at the top so there are easy to change in the future.
    export_with_*** have all been colapsed into a single export_p12_file which handles taking 'default' and turning off that argument.
    -Add for loops for the hash functions.
    -Restore the camellia ciphers back now that they work.
    -Restore the pkcs12V2pbe back now that they work.
    -Collect various pbe types into single variables and use those variables in loops
    -Reduce the number of tests ran in optimized mode (which takes 60x the time to do a pbe then than debug mode based on a larger iterator).
    -Add verify_p12 which dumps out the p12 file and makes sure the expected CERT_ENCRYPTION, KEY_ENCRYPTION, and HASH are used.
    
    doc/pp.xml
    -Add pkcs12 option
    
    doc/pk12util.xml
    -Add -M option
    -Update synopsis with options in the description but not in the synopsis
    
    Differential Revision: https://phabricator.services.mozilla.com/D113699
    71f201b8
Name
Last commit
Last update
..
bogo Loading commit data...
cert Loading commit data...
chains Loading commit data...
cipher Loading commit data...
cmdtests Loading commit data...
common Loading commit data...
crmf Loading commit data...
dbtests Loading commit data...
dbupgrade Loading commit data...
doc Loading commit data...
dummy Loading commit data...
ec Loading commit data...
fips Loading commit data...
gtests Loading commit data...
interop Loading commit data...
iopr Loading commit data...
libpkix Loading commit data...
lowhash Loading commit data...
memleak Loading commit data...
merge Loading commit data...
mpi Loading commit data...
multinit Loading commit data...
ocsp Loading commit data...
perf Loading commit data...
pkcs11/netscape/suites/security/ssl Loading commit data...
pkits Loading commit data...
policy Loading commit data...
remote Loading commit data...
sdr Loading commit data...
smime Loading commit data...
ssl Loading commit data...
ssl_gtests Loading commit data...
tlsfuzzer Loading commit data...
tools Loading commit data...
README.txt Loading commit data...
all.sh Loading commit data...
clean_tbx Loading commit data...
core_watch Loading commit data...
dll_version.sh Loading commit data...
header Loading commit data...
jss_dll_version.sh Loading commit data...
jssdir Loading commit data...
jssqa Loading commit data...
mksymlinks Loading commit data...
nssdir Loading commit data...
nsspath Loading commit data...
nssqa Loading commit data...
path_uniq Loading commit data...
platformlist Loading commit data...
platformlist.tbx Loading commit data...
qa_stage Loading commit data...
qa_stat Loading commit data...
qaclean Loading commit data...
run_niscc.sh Loading commit data...
set_environment Loading commit data...