README.FIPS

   1 Preliminary status and build information for FIPS module v2.0
   2
   3 If you have any object files from a previous build do:
   4
   5 make clean
   6
   7 To build the module do:
   8
   9 ./config fipscanisterbuild
  10 make
  11
  12 Build should complete without errors.
  13
  14 Run test suite:
  15
  16 test/fips_test_suite
  17
  18 again should complete without errors.
  19
  20 Run test vectors:
  21
  22 1. Download an appropriate set of testvectors from www.openssl.org/docs/fips
  23    those for 2007 are OK.
  24
  25 2. Extract the files to a suitable directory.
  26
  27 3. Run the test vector perl script, for example:
  28
  29    cd fips
  30    perl fipsalgtest.pl --dir=/wherever/stuff/was/extracted
  31
  32 4. It should say "passed all tests" at the end. Report full details of any
  33    failures.
  34
  35 Run:
  36
  37 make clean
  38
  39 to remove any object modules from previous compile.
  40
  41 Run symbol hiding test:
  42
  43 ./config fipscanisteronly -DOPENSSL_FIPSSYMS
  44 make
  45
  46 This time only the fips utilities should be built.
  47
  48 Examine the external symbols in fips/fipscanister.o they should all begin
  49 with FIPS or fips. One way to check with GNU nm is:
  50
  51 nm -g --defined-only fips/fipscanister.o | grep -v -i fips
  52
  53 Restricted tarball tests.
  54
  55 The validated module will have its own tarball containing sufficient code to
  56 build fipscanister.o and the associated algorithm tests. You can create a
  57 similar tarball yourself for testing purposes using the commands below.
  58
  59 Standard restricted tarball:
  60
  61 make -f Makefile.fips dist
  62
  63 Prime field field only ECC tarball:
  64
  65 make NOEC2M=1 -f Makefile.fips dist
  66
  67 Once you've created the tarball extract into a fresh directory and do:
  68
  69 ./config
  70 make
  71
  72 You can then run the algorithm tests as above. This build automatically uses
  73 fipscanisteronly and -DOPENSSL_FIPSYMS and no-ec2m as appropriate.
  74
  75 Known issues:
  76
  77 Algorithm tests are pre-2011.
  78 The fipslagtest.pl script wont auto run new algorithm tests such as DSA2.
  79 Code needs extensively reviewing to ensure it builds correctly on
  80 supported platforms and is compliant with FIPS 140-2.
  81 The "FIPS capable OpenSSL" is not yet complete: meaning that the rest of
  82 OpenSSL doesn't always use the correct FIPS module APIs and block others
  83 in FIPS mode.