NOTES-NONSTOP.md

   1 NOTES FOR THE HPE NONSTOP PLATFORM
   2 ==============================
   3
   4 Requirement details
   5 -------------------
   6
   7 In addition to the requirements and instructions listed
   8 in [INSTALL.md](INSTALL.md), the following are required as well:
   9
  10  * The TNS/X platform supports hardware randomization.
  11    Specify the `--with-rand-seed=rdcpu` option to the `./Configure` script.
  12    This is recommended but not required. `egd` is supported at 3.0 but cannot
  13    be used if FIPS is selected.
  14  * The TNS/E platform does not support hardware randomization, so
  15    specify the `--with-rand-seed=egd` option to the `./Configure` script.
  16
  17 About c99 compiler
  18 ------------------
  19
  20 The c99 compiler is required for building OpenSSL from source. While c11
  21 may work, it has not been broadly tested. c99 is the only compiler
  22 prerequisite needed to build OpenSSL 3.0 on this platform. You should also
  23 have the FLOSS package installed on your system. The ITUGLIB FLOSS package
  24 is the only FLOSS variant that has been broadly tested.
  25
  26 Threading Models
  27 ----------------
  28
  29 OpenSSL can be built using unthreaded, POSIX User Threads (PUT), or Standard
  30 POSIX Threads (SPT). Select the following build configuration for each on
  31 the TNS/X (L-Series) platform:
  32
  33  * `nonstop-nsx` or default will select an unthreaded build.
  34  * `nonstop-nsx_put` selects the PUT build.
  35  * `nonstop-nsx_64_put` selects the 64 bit file length PUT build.
  36  * `nonstop-nsx_spt_floss` selects the SPT build with FLOSS. FLOSS is
  37    required for SPT builds because of a known hang when using SPT on its own.
  38
  39 ### TNS/E Considerations
  40
  41 The TNS/E platform is build using the same set of builds specifying `nse`
  42 instead of `nsx` in the set above.
  43
  44 You cannot build for TNS/E for FIPS, so you must specify the `no-fips`
  45 option to `./Configure`.
  46
  47 About Prefix and OpenSSLDir
  48 ---------------------------
  49
  50 Because there are many potential builds that must co-exist on any given
  51 NonStop node, managing the location of your build distribution is crucial.
  52 Keep each destination separate and distinct. Mixing any mode described in
  53 this document can cause application instability. The recommended approach
  54 is to specify the OpenSSL version and threading model in your configuration
  55 options, and keeping your memory and float options consistent, for example:
  56
  57  * For 1.1 `--prefix=/usr/local-ssl1.1 --openssldir=/usr/local-ssl1.1/ssl`
  58  * For 1.1 PUT `--prefix=/usr/local-ssl1.1_put --openssldir=/usr/local-ssl1.1_put/ssl`
  59
  60 As of 3.0, the NonStop configurations use the multilib attribute to distinguish
  61 between different models:
  62
  63  * For 3.0 `--prefix=/usr/local-ssl3.0 --openssldir=/usr/local-ssl3.0/ssl`
  64
  65 The PUT model is placed in `${prefix}/lib-put` for 32-bit models and
  66 `${prefix}/lib64-put` for 64-bit models.
  67
  68 Use the `_RLD_LIB_PATH` environment variable in OSS to select the appropriate
  69 directory containing `libcrypto.so` and `libssl.so`. In GUARDIAN, use the
  70 `=_RLD_LIB_PATH` search define to locate the GUARDIAN subvolume where OpenSSL
  71 is installed.
  72
  73 Float Considerations
  74 --------------------
  75
  76 OpenSSL is built using IEEE Float mode by default. If you need a different
  77 IEEE mode, create a new configuration specifying `tfloat-x86-64` (for Tandem
  78 Float) or `nfloat-x86-64` (for Neutral Float).
  79
  80 Memory Models
  81 -------------
  82
  83 The current OpenSSL default memory model uses the default platform address
  84 model. If you need a different address model, you must specify the appropriate
  85 c99 options for compile (`CFLAGS`) and linkers (`LDFLAGS`).
  86
  87 Cross Compiling on Windows
  88 --------------------------
  89
  90 To configure and compile OpenSSL, you will need to set up a Cygwin environment.
  91 The Cygwin tools should include bash, make, and any other normal tools required
  92 for building programs.
  93
  94 Your `PATH` must include the bin directory for the c99 cross-compiler, as in:
  95
  96     export PATH=/cygdrive/c/Program\ Files\ \(x86\)/HPE\ NonStop/L16.05/usr/bin:$PATH
  97
  98 This should be set before Configure is run. For the c99 cross-compiler to work
  99 correctly, you also need the `COMP_ROOT` set, as in:
 100
 101     export COMP_ROOT="C:\Program Files (x86)\HPE NonStop\L16.05"
 102
 103 `COMP_ROOT` needs to be in Windows form.
 104
 105 `Configure` must specify the `no-makedepend` option otherwise errors will
 106 result when running the build because the c99 cross-compiler does not support
 107 the `gcc -MT` option. An example of a `Configure` command to be run from the
 108 OpenSSL directory is:
 109
 110     ./Configure nonstop-nsx_64 no-makedepend --with-rand-seed=rdcpu
 111
 112 Do not forget to include any OpenSSL cross-compiling prefix and certificate
 113 options when creating your libraries.
 114
 115 The OpenSSL test suite will not run on your workstation. In order to verify the
 116 build, you will need to perform the build and test steps in OSS in your NonStop
 117 server. You can also build under gcc and run the test suite for Windows but that
 118 is not equivalent.
 119
 120 **Note:** In the event that you are attempting a FIPS-compliant cross-compile,
 121 be aware that signatures may not match between builds done under OSS and under
 122 cross-compiles as the compilers do not necessarily generate identical objects.
 123 Anything and everything to do with FIPS is outside the scope of this document.
 124 Refer to the FIPS security policy for more information.
 125
 126 The following build configurations have been successfully attempted at one
 127 point or another. If you are successful in your cross-compile efforts, please
 128 update this list:
 129
 130 - nonstop-nsx_64
 131 - nonstop-nsx_64_put
 132
 133 **Note:** Cross-compile builds for TNS/E have not been attempted, but should
 134 follow the same considerations as for TNS/X above. SPT builds generally require
 135 FLOSS, which is not available for workstation builds. As a result, SPT builds
 136 of OpenSSL cannot be cross-compiled.
 137
 138 Also see the NSDEE discussion below for more historical information.
 139
 140 Cross Compiling with NSDEE
 141 --------------------------
 142
 143 **Note:** None of these builds have been tested by the platform maintainer and
 144 are supplied for historical value. Please submit a Pull Request to OpenSSL
 145 should these need to be adjusted.
 146
 147 If you are attempting to build OpenSSL with NSDEE, you will need to specify
 148 the following variables. The following set of compiler defines are required:
 149
 150     # COMP_ROOT must be a full path for the build system (e.g. windows)
 151     COMP_ROOT=$(cygpath -w /path/to/comp_root)
 152     # CC must be executable by your shell
 153     CC=/path/to/c99
 154
 155 ### Optional Build Variables
 156
 157     DBGFLAG="--debug"
 158     CIPHENABLES="enable-ssl3 enable-ssl3-method enable-weak-ssl-ciphers enable-rc4"
 159
 160 ### Internal Known TNS/X to TNS/E Cross Compile Variables
 161
 162 The following definition is required if you are building on TNS/X for TNS/E
 163 and have access to a TNS/E machine on your EXPAND network - with an example
 164 node named `\CS3`:
 165
 166     SYSTEMLIBS="-L/E/cs3/usr/local/lib"
 167
 168 Version Procedure (VPROC) Considerations
 169 ----------------------------------------
 170
 171 If you require a VPROC entry for platform version identification, use the
 172 following variables:
 173
 174 ### For Itanium
 175
 176     OPENSSL_VPROC_PREFIX=T0085H06
 177
 178 ### For x86
 179
 180     OPENSSL_VPROC_PREFIX=T0085L01
 181
 182 ### Common Definition
 183
 184     export OPENSSL_VPROC=${OPENSSL_VPROC_PREFIX}_$(
 185         . VERSION.dat
 186         if [ -n "$PRE_RELEASE_TAG" ]; then
 187             PRE_RELEASE_TAG="-$PRE_RELEASE_TAG"
 188         fi
 189         if [ -n "$BUILD_METADATA" ]; then
 190             BUILD_METADATA="+$BUILD_METADATA"
 191         fi
 192         echo "$MAJOR.$MINOR.$PATCH$PRE_RELEASE_TAG$BUILD_METADATA" |\
 193             sed -e 's/[-.+]/_/g'
 194         )
 195
 196 Example Configure Targets
 197 -------------------------
 198
 199 For OSS targets, the main DLL names will be `libssl.so` and `libcrypto.so`.
 200 For GUARDIAN targets, DLL names will be `ssl` and `crypto`. The following
 201 assumes that your PWD is set according to your installation standards.
 202
 203     ./Configure nonstop-nsx           --prefix=${PWD} \
 204         --openssldir=${PWD}/ssl no-threads \
 205         --with-rand-seed=rdcpu ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 206     ./Configure nonstop-nsx_g         --prefix=${PWD} \
 207         --openssldir=${PWD}/ssl no-threads \
 208         --with-rand-seed=rdcpu ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 209     ./Configure nonstop-nsx_put       --prefix=${PWD} \
 210         --openssldir=${PWD}/ssl threads "-D_REENTRANT" \
 211         --with-rand-seed=rdcpu ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 212     ./Configure nonstop-nsx_spt_floss --prefix=${PWD} \
 213         --openssldir=${PWD}/ssl threads "-D_REENTRANT" \
 214         --with-rand-seed=rdcpu ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 215     ./Configure nonstop-nsx_64        --prefix=${PWD} \
 216         --openssldir=${PWD}/ssl no-threads \
 217         --with-rand-seed=rdcpu ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 218     ./Configure nonstop-nsx_64_put    --prefix=${PWD} \
 219         --openssldir=${PWD}/ssl threads "-D_REENTRANT" \
 220         --with-rand-seed=rdcpu ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 221     ./Configure nonstop-nsx_g_tandem  --prefix=${PWD} \
 222         --openssldir=${PWD}/ssl no-threads \
 223         --with-rand-seed=rdcpu ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 224
 225     ./Configure nonstop-nse           --prefix=${PWD} \
 226         --openssldir=${PWD}/ssl no-threads \
 227         --with-rand-seed=egd ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 228     ./Configure nonstop-nse_g         --prefix=${PWD} \
 229         --openssldir=${PWD}/ssl no-threads \
 230         --with-rand-seed=egd ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 231     ./Configure nonstop-nse_put       --prefix=${PWD} \
 232         --openssldir=${PWD}/ssl threads "-D_REENTRANT" \
 233         --with-rand-seed=egd ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 234     ./Configure nonstop-nse_spt_floss --prefix=${PWD} \
 235         --openssldir=${PWD}/ssl threads "-D_REENTRANT" \
 236         --with-rand-seed=egd ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 237     ./Configure nonstop-nse_64        --prefix=${PWD} \
 238         --openssldir=${PWD}/ssl no-threads \
 239         --with-rand-seed=egd ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 240     ./Configure nonstop-nse_64_put    --prefix=${PWD} \
 241         --openssldir=${PWD}/ssl threads "-D_REENTRANT"
 242         --with-rand-seed=egd ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}
 243     ./Configure nonstop-nse_g_tandem  --prefix=${PWD} \
 244         --openssldir=${PWD}/ssl no-threads \
 245         --with-rand-seed=egd ${CIPHENABLES} ${DBGFLAG} ${SYSTEMLIBS}