-
Notifications
You must be signed in to change notification settings - Fork 29.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
crypto: Improve control of FIPS mode
Default to FIPS off even in FIPS builds. Add JS API to check and control FIPS mode. Add command line arguments to force FIPS on/off. Respect OPENSSL_CONF variable and read the config. Add testing for new features. Fixes: #3819 PR-URL: #5181 Reviewed-By: Fedor Indutny <[email protected]> Reviewed-by: Michael Dawson <[email protected]>
- Loading branch information
Showing
10 changed files
with
283 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Skeleton openssl.cnf for testing with FIPS | ||
|
|
||
| openssl_conf = openssl_conf_section | ||
| authorityKeyIdentifier=keyid:always,issuer:always | ||
|
|
||
| [openssl_conf_section] | ||
| # Configuration module list | ||
| alg_section = evp_sect | ||
|
|
||
| [ evp_sect ] | ||
| # Set to "yes" to enter FIPS mode if supported | ||
| fips_mode = no |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # Skeleton openssl.cnf for testing with FIPS | ||
|
|
||
| openssl_conf = openssl_conf_section | ||
| authorityKeyIdentifier=keyid:always,issuer:always | ||
|
|
||
| [openssl_conf_section] | ||
| # Configuration module list | ||
| alg_section = evp_sect | ||
|
|
||
| [ evp_sect ] | ||
| # Set to "yes" to enter FIPS mode if supported | ||
| fips_mode = yes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,180 @@ | ||
| 'use strict'; | ||
| var common = require('../common'); | ||
| var assert = require('assert'); | ||
| var spawnSync = require('child_process').spawnSync; | ||
| var path = require('path'); | ||
|
|
||
| if (!common.hasCrypto) { | ||
| console.log('1..0 # Skipped: missing crypto'); | ||
| return; | ||
| } | ||
|
|
||
| const FIPS_ENABLED = 1; | ||
| const FIPS_DISABLED = 0; | ||
| const FIPS_ERROR_STRING = 'Error: Cannot set FIPS mode'; | ||
| const OPTION_ERROR_STRING = 'bad option'; | ||
| const CNF_FIPS_ON = path.join(common.fixturesDir, 'openssl_fips_enabled.cnf'); | ||
| const CNF_FIPS_OFF = path.join(common.fixturesDir, 'openssl_fips_disabled.cnf'); | ||
| var num_children_ok = 0; | ||
|
|
||
| function compiledWithFips() { | ||
| return process.config.variables.openssl_fips ? true : false; | ||
| } | ||
|
|
||
| function addToEnv(newVar, value) { | ||
| var envCopy = {}; | ||
| for (const e in process.env) { | ||
| envCopy[e] = process.env[e]; | ||
| } | ||
| envCopy[newVar] = value; | ||
| return envCopy; | ||
| } | ||
|
|
||
| function testHelper(stream, args, expectedOutput, cmd, env) { | ||
| const fullArgs = args.concat(['-e', 'console.log(' + cmd + ')']); | ||
| const child = spawnSync(process.execPath, fullArgs, { | ||
| cwd: path.dirname(process.execPath), | ||
| env: env | ||
| }); | ||
|
|
||
| console.error('Spawned child [pid:' + child.pid + '] with cmd ' + | ||
| cmd + ' and args \'' + args + '\''); | ||
|
|
||
| function childOk(child) { | ||
| console.error('Child #' + ++num_children_ok + | ||
| ' [pid:' + child.pid + '] OK.'); | ||
| } | ||
|
|
||
| function responseHandler(buffer, expectedOutput) { | ||
| const response = buffer.toString(); | ||
| assert.notEqual(0, response.length); | ||
| if (FIPS_ENABLED !== expectedOutput && FIPS_DISABLED !== expectedOutput) { | ||
| // In the case of expected errors just look for a substring. | ||
| assert.notEqual(-1, response.indexOf(expectedOutput)); | ||
| } else { | ||
| // Normal path where we expect either FIPS enabled or disabled. | ||
| assert.equal(expectedOutput, response); | ||
| } | ||
| childOk(child); | ||
| } | ||
|
|
||
| responseHandler(child[stream], expectedOutput); | ||
| } | ||
|
|
||
| // By default FIPS should be off in both FIPS and non-FIPS builds. | ||
| testHelper( | ||
| 'stdout', | ||
| [], | ||
| FIPS_DISABLED, | ||
| 'require("crypto").fips', | ||
| addToEnv('OPENSSL_CONF', '')); | ||
|
|
||
| // --enable-fips should turn FIPS mode on | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| ['--enable-fips'], | ||
| compiledWithFips() ? FIPS_ENABLED : OPTION_ERROR_STRING, | ||
| 'require("crypto").fips', | ||
| process.env); | ||
|
|
||
| //--force-fips should turn FIPS mode on | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| ['--force-fips'], | ||
| compiledWithFips() ? FIPS_ENABLED : OPTION_ERROR_STRING, | ||
| 'require("crypto").fips', | ||
| process.env); | ||
|
|
||
| // OpenSSL config file should be able to turn on FIPS mode | ||
| testHelper( | ||
| 'stdout', | ||
| [], | ||
| compiledWithFips() ? FIPS_ENABLED : FIPS_DISABLED, | ||
| 'require("crypto").fips', | ||
| addToEnv('OPENSSL_CONF', CNF_FIPS_ON)); | ||
|
|
||
| // --enable-fips should take precedence over OpenSSL config file | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| ['--enable-fips'], | ||
| compiledWithFips() ? FIPS_ENABLED : OPTION_ERROR_STRING, | ||
| 'require("crypto").fips', | ||
| addToEnv('OPENSSL_CONF', CNF_FIPS_OFF)); | ||
|
|
||
| // --force-fips should take precedence over OpenSSL config file | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| ['--force-fips'], | ||
| compiledWithFips() ? FIPS_ENABLED : OPTION_ERROR_STRING, | ||
| 'require("crypto").fips', | ||
| addToEnv('OPENSSL_CONF', CNF_FIPS_OFF)); | ||
|
|
||
| // setFipsCrypto should be able to turn FIPS mode on | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| [], | ||
| compiledWithFips() ? FIPS_ENABLED : FIPS_ERROR_STRING, | ||
| '(require("crypto").fips = true,' + | ||
| 'require("crypto").fips)', | ||
| addToEnv('OPENSSL_CONF', '')); | ||
|
|
||
| // setFipsCrypto should be able to turn FIPS mode on and off | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| [], | ||
| compiledWithFips() ? FIPS_DISABLED : FIPS_ERROR_STRING, | ||
| '(require("crypto").fips = true,' + | ||
| 'require("crypto").fips = false,' + | ||
| 'require("crypto").fips)', | ||
| addToEnv('OPENSSL_CONF', '')); | ||
|
|
||
| // setFipsCrypto takes precedence over OpenSSL config file, FIPS on | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| [], | ||
| compiledWithFips() ? FIPS_ENABLED : FIPS_ERROR_STRING, | ||
| '(require("crypto").fips = true,' + | ||
| 'require("crypto").fips)', | ||
| addToEnv('OPENSSL_CONF', CNF_FIPS_OFF)); | ||
|
|
||
| // setFipsCrypto takes precedence over OpenSSL config file, FIPS off | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| [], | ||
| compiledWithFips() ? FIPS_DISABLED : FIPS_ERROR_STRING, | ||
| '(require("crypto").fips = false,' + | ||
| 'require("crypto").fips)', | ||
| addToEnv('OPENSSL_CONF', CNF_FIPS_ON)); | ||
|
|
||
| // --enable-fips does not prevent use of setFipsCrypto API | ||
| testHelper( | ||
| compiledWithFips() ? 'stdout' : 'stderr', | ||
| ['--enable-fips'], | ||
| compiledWithFips() ? FIPS_DISABLED : OPTION_ERROR_STRING, | ||
| '(require("crypto").fips = false,' + | ||
| 'require("crypto").fips)', | ||
| process.env); | ||
|
|
||
| // --force-fips prevents use of setFipsCrypto API | ||
| testHelper( | ||
| 'stderr', | ||
| ['--force-fips'], | ||
| compiledWithFips() ? FIPS_ERROR_STRING : OPTION_ERROR_STRING, | ||
| 'require("crypto").fips = false', | ||
| process.env); | ||
|
|
||
| // --force-fips and --enable-fips order does not matter | ||
| testHelper( | ||
| 'stderr', | ||
| ['--force-fips', '--enable-fips'], | ||
| compiledWithFips() ? FIPS_ERROR_STRING : OPTION_ERROR_STRING, | ||
| 'require("crypto").fips = false', | ||
| process.env); | ||
|
|
||
| //--enable-fips and --force-fips order does not matter | ||
| testHelper( | ||
| 'stderr', | ||
| ['--enable-fips', '--force-fips'], | ||
| compiledWithFips() ? FIPS_ERROR_STRING : OPTION_ERROR_STRING, | ||
| 'require("crypto").fips = false', | ||
| process.env); |
Oops, something went wrong.
7c48cb5There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Fishrock123 it now defaults to FIPS mode off with this commit when building FIPS-enabled node.js