NameDateSize

..16-Mar-201612 KiB

.gitignore12-Oct-20151.8 KiB

.travis-create-release.sh09-Dec-2015381

.travis.yml09-Dec-20152.5 KiB

ACKNOWLEDGEMENTS09-Dec-201587

apps/15-Dec-20154 KiB

appveyor.yml30-Nov-20151.3 KiB

certs/29-Dec-20124 KiB

CHANGES14-Dec-2015486.7 KiB

config18-May-201526.7 KiB

Configurations/14-Dec-20154 KiB

Configure14-Dec-201572.4 KiB

CONTRIBUTING09-Nov-20151.6 KiB

crypto/15-Dec-20154 KiB

demos/09-Nov-20154 KiB

doc/10-Sep-20154 KiB

e_os.h30-Nov-201521.5 KiB

engines/10-Dec-20154 KiB

FAQ17-Aug-201584

GitConfigure07-Apr-2015248

GitMake10-Feb-2014134

include/18-May-20154 KiB

INSTALL21-Sep-201515.4 KiB

install.com29-Dec-20123.6 KiB

INSTALL.DJGPP29-Dec-20122 KiB

INSTALL.NW07-Sep-201318.4 KiB

INSTALL.OS229-Dec-2012744

INSTALL.VMS21-Sep-201511.4 KiB

INSTALL.W3220-Feb-201311.6 KiB

INSTALL.W6429-Dec-20122.1 KiB

INSTALL.WCE29-Dec-20123.2 KiB

LICENSE29-Dec-20126.1 KiB

Makefile.org14-Dec-201525.3 KiB

Makefile.shared02-Feb-201520.4 KiB

makevms.com10-Sep-201540.4 KiB

ms/02-Feb-20154 KiB

Netware/16-Dec-20144 KiB

NEWS11-Dec-201532.1 KiB

openssl.doxy29-Dec-2012137

openssl.spec13-Dec-20137.8 KiB

os2/29-Dec-20124 KiB

PROBLEMS28-Sep-20158.5 KiB

README11-Dec-20154 KiB

README.ECC29-Dec-20123.5 KiB

README.ENGINE29-Dec-201215.7 KiB

README.FIPS29-Dec-20123.6 KiB

ssl/14-Dec-20154 KiB

test/15-Dec-20154 KiB

tools/15-Sep-20154 KiB

util/15-Dec-20154 KiB

VMS/29-Dec-20124 KiB

README

1
2 OpenSSL 1.1.0-pre2-dev
3
4 Copyright (c) 1998-2015 The OpenSSL Project
5 Copyright (c) 1995-1998 Eric A. Young, Tim J. Hudson
6 All rights reserved.
7
8 DESCRIPTION
9 -----------
10
11 The OpenSSL Project is a collaborative effort to develop a robust,
12 commercial-grade, fully featured, and Open Source toolkit implementing the
13 Secure Sockets Layer (SSLv3) and Transport Layer Security (TLS) protocols as
14 well as a full-strength general purpose cryptograpic library. The project is
15 managed by a worldwide community of volunteers that use the Internet to
16 communicate, plan, and develop the OpenSSL toolkit and its related
17 documentation.
18
19 OpenSSL is descended from the SSLeay library developed by Eric A. Young
20 and Tim J. Hudson.  The OpenSSL toolkit is licensed under a dual-license (the
21 OpenSSL license plus the SSLeay license), which means that you are free to
22 get and use it for commercial and non-commercial purposes as long as you
23 fulfill the conditions of both licenses.
24
25 OVERVIEW
26 --------
27
28 The OpenSSL toolkit includes:
29
30 libssl.a:
31     Provides the client and server-side implementations for SSLv3 and TLS.
32
33 libcrypto.a:
34     Provides general cryptographic and X.509 support needed by SSL/TLS but
35     not logically part of it.
36
37 openssl:
38     A command line tool that can be used for:
39        Creation of key parameters
40        Creation of X.509 certificates, CSRs and CRLs
41        Calculation of message digests
42        Encryption and decryption
43        SSL/TLS client and server tests
44        Handling of S/MIME signed or encrypted mail
45        And more...
46
47 INSTALLATION
48 ------------
49
50 See the appropriate file:
51        INSTALL         Linux, Unix, etc.
52        INSTALL.DJGPP   DOS platform with DJGPP
53        INSTALL.NW      Netware
54        INSTALL.OS2     OS/2
55        INSTALL.VMS     VMS
56        INSTALL.W32     Windows (32bit)
57        INSTALL.W64     Windows (64bit)
58        INSTALL.WCE     Windows CE
59
60 SUPPORT
61 -------
62
63 See the OpenSSL website www.openssl.org for details on how to obtain
64 commercial technical support.
65
66 If you have any problems with OpenSSL then please take the following steps
67 first:
68
69    - Download the current snapshot from ftp://ftp.openssl.org/snapshot/
70      to see if the problem has already been addressed
71    - Remove ASM versions of libraries
72    - Remove compiler optimisation flags
73
74 If you wish to report a bug then please include the following information in
75 any bug report:
76
77    - On Unix systems:
78        Self-test report generated by 'make report'
79    - On other systems:
80        OpenSSL version: output of 'openssl version -a'
81        OS Name, Version, Hardware platform
82        Compiler Details (name, version)
83    - Application Details (name, version)
84    - Problem Description (steps that will reproduce the problem, if known)
85    - Stack Traceback (if the application dumps core)
86
87 Email the report to:
88
89    rt@openssl.org
90
91 In order to avoid spam, this is a moderated mailing list, and it might
92 take a day for the ticket to show up.  (We also scan posts to make sure
93 that security disclosures aren't publically posted by mistake.) Mail to
94 this address is recorded in the public RT (request tracker) database (see
95 https://www.openssl.org/support/rt.html for details) and also forwarded
96 the public openssl-dev mailing list.  Confidential mail may be sent to
97 openssl-security@openssl.org (PGP key available from the key servers).
98
99 Please do NOT use this for general assistance or support queries.
100 Just because something doesn't work the way you expect does not mean it
101 is necessarily a bug in OpenSSL.
102
103 You can also make GitHub pull requests. If you do this, please also send
104 mail to rt@openssl.org with a link to the PR so that we can more easily
105 keep track of it.
106
107 HOW TO CONTRIBUTE TO OpenSSL
108 ----------------------------
109
110 See CONTRIBUTING
111
112 LEGALITIES
113 ----------
114
115 A number of nations, in particular the U.S., restrict the use or export
116 of cryptography. If you are potentially subject to such restrictions
117 you should seek competent professional legal advice before attempting to
118 develop or distribute cryptographic code.
119

README.ECC

1NOTE: The OpenSSL Software Foundation has executed a sublicense agreement
2entitled "Elliptic Curve Cryptography Patent License Agreement" with the
3National Security Agency/ Central Security Service Commercial Solutions
4Center (NCSC) dated 2010-11-04. That agreement permits implementation and
5distribution of software containing features covered by any or all of the
6following patents:
7
81.) U.S. Pat. No. 5,761,305 entitled "Key Agreement and Transport Protocol 
9    with Implicit Signatures" issued on June 2, 1998;
102.) Can. Pat. Appl. Ser. No. 2176972 entitled "Key Agreement and Transport 
11    Protocol with Implicit Signature and Reduced Bandwidth" filed on May 
12    16, 1996;
133.) U.S. Pat. No. 5,889,865 entitled "Key Agreement and Transport Protocol 
14    with Implicit Signatures" issued on March 30, 1999;
154.) U.S. Pat. No. 5,896,455 entitled "Key Agreement and Transport Protocol 
16    with Implicit Signatures" issued on April 20, 1999;
175.) U.S. Pat. No. 5,933,504 entitled "Strengthened Public Key Protocol" 
18    issued on August 3, 1999;
196.) Can. Pat. Appl. Ser. No. 2176866 entitled "Strengthened Public Key 
20    Protocol" filed on May 17, 1996;
217.) E.P. Pat. Appl. Ser. No. 96201322.3 entitled "Strengthened Public Key 
22    Protocol" filed on May 17, 1996;
238.) U.S. Pat. No. 5,999,626 entitled "Digital Signatures on a Smartcard" 
24    issued on December 7, 1999;
259.) Can. Pat. Appl. Ser. No. 2202566 entitled "Digital Signatures on a 
26    Smartcard" filed on April 14, 1997;
2710.) E.P. Pat. Appl. No. 97106114.8 entitled "Digital Signatures on a 
28     Smartcard" filed on April 15, 1997;
2911.) U.S Pat. No. 6,122,736 entitled "Key Agreement and Transport Protocol 
30     with Implicit Signatures" issued on September 19, 2000;
3112.) Can. Pat. Appl. Ser. No. 2174261 entitled "Key Agreement and Transport 
32     Protocol with Implicit Signatures" filed on April 16, 1996;
3313.) E.P. Pat. Appl. Ser. No. 96105920.1 entitled "Key Agreement and 
34     Transport Protocol with Implicit Signatures" filed on April 16, 1996;
3514.) U.S. Pat. No. 6,141,420 entitled "Elliptic Curve Encryption Systems" 
36     issued on October 31, 2000;
3715.) Can. Pat. Appl. Ser. No. 2155038 entitled "Elliptic Curve Encryption 
38     Systems" filed on July 31, 1995;
3916.) E.P. Pat. Appl. Ser. No. 95926348.4 entitled "Elliptic Curve Encryption 
40     Systems" filed on July 31, 1995;
4117.) U.S. Pat. No. 6,336,188 entitled "Authenticated Key Agreement" issued 
42     on January 1, 2002;
4318.) U.S. Pat. No. 6,487,661 entitled "Key Agreement and Transport Protocol" 
44     issued on November 26, 2002;
4519.) Can. Pat. Appl. Ser. No. 2174260 entitled "Key Agreement and Transport 
46     Protocol" filed on April 16, 1996;
4720.) E.P. Pat. Appl. Ser. No. 96105921.9 entitled "Key Agreement and 
48     Transport Protocol" filed on April 21, 1996;
4921.) U.S. Pat. No. 6,563,928 entitled "Strengthened Public Key Protocol" 
50     issued on May 13, 2003;
5122.) U.S. Pat. No. 6,618,483 entitled "Elliptic Curve Encryption Systems" 
52     issued September 9, 2003;
5323.) U.S. Pat. Appl. Ser. No. 09/434,247 entitled "Digital Signatures on a 
54     Smartcard" filed on November 5, 1999;
5524.) U.S. Pat. Appl. Ser. No. 09/558,256 entitled "Key Agreement and 
56     Transport Protocol with Implicit Signatures" filed on April 25, 2000;
5725.) U.S. Pat. Appl. Ser. No. 09/942,492 entitled "Digital Signatures on a 
58     Smartcard" filed on August 29, 2001 and published on July 18, 2002; and,
5926.) U.S. Pat. Appl. Ser. No. 10/185,735 entitled "Strengthened Public Key 
60     Protocol" filed on July 1, 2000.
61
62

README.ENGINE

1  ENGINE
2  ======
3
4  With OpenSSL 0.9.6, a new component was added to support alternative
5  cryptography implementations, most commonly for interfacing with external
6  crypto devices (eg. accelerator cards). This component is called ENGINE,
7  and its presence in OpenSSL 0.9.6 (and subsequent bug-fix releases)
8  caused a little confusion as 0.9.6** releases were rolled in two
9  versions, a "standard" and an "engine" version. In development for 0.9.7,
10  the ENGINE code has been merged into the main branch and will be present
11  in the standard releases from 0.9.7 forwards.
12
13  There are currently built-in ENGINE implementations for the following
14  crypto devices:
15
16      o CryptoSwift
17      o Compaq Atalla
18      o nCipher CHIL
19      o Nuron
20      o Broadcom uBSec
21
22  In addition, dynamic binding to external ENGINE implementations is now
23  provided by a special ENGINE called "dynamic". See the "DYNAMIC ENGINE"
24  section below for details.
25
26  At this stage, a number of things are still needed and are being worked on:
27
28      1 Integration of EVP support.
29      2 Configuration support.
30      3 Documentation!
31
321 With respect to EVP, this relates to support for ciphers and digests in
33  the ENGINE model so that alternative implementations of existing
34  algorithms/modes (or previously unimplemented ones) can be provided by
35  ENGINE implementations.
36
372 Configuration support currently exists in the ENGINE API itself, in the
38  form of "control commands". These allow an application to expose to the
39  user/admin the set of commands and parameter types a given ENGINE
40  implementation supports, and for an application to directly feed string
41  based input to those ENGINEs, in the form of name-value pairs. This is an
42  extensible way for ENGINEs to define their own "configuration" mechanisms
43  that are specific to a given ENGINE (eg. for a particular hardware
44  device) but that should be consistent across *all* OpenSSL-based
45  applications when they use that ENGINE. Work is in progress (or at least
46  in planning) for supporting these control commands from the CONF (or
47  NCONF) code so that applications using OpenSSL's existing configuration
48  file format can have ENGINE settings specified in much the same way.
49  Presently however, applications must use the ENGINE API itself to provide
50  such functionality. To see first hand the types of commands available
51  with the various compiled-in ENGINEs (see further down for dynamic
52  ENGINEs), use the "engine" openssl utility with full verbosity, ie;
53       openssl engine -vvvv
54
553 Documentation? Volunteers welcome! The source code is reasonably well
56  self-documenting, but some summaries and usage instructions are needed -
57  moreover, they are needed in the same POD format the existing OpenSSL
58  documentation is provided in. Any complete or incomplete contributions
59  would help make this happen.
60
61  STABILITY & BUG-REPORTS
62  =======================
63
64  What already exists is fairly stable as far as it has been tested, but
65  the test base has been a bit small most of the time. For the most part,
66  the vendors of the devices these ENGINEs support have contributed to the
67  development and/or testing of the implementations, and *usually* (with no
68  guarantees) have experience in using the ENGINE support to drive their
69  devices from common OpenSSL-based applications. Bugs and/or inexplicable
70  behaviour in using a specific ENGINE implementation should be sent to the
71  author of that implementation (if it is mentioned in the corresponding C
72  file), and in the case of implementations for commercial hardware
73  devices, also through whatever vendor support channels are available.  If
74  none of this is possible, or the problem seems to be something about the
75  ENGINE API itself (ie. not necessarily specific to a particular ENGINE
76  implementation) then you should mail complete details to the relevant
77  OpenSSL mailing list. For a definition of "complete details", refer to
78  the OpenSSL "README" file. As for which list to send it to;
79
80     openssl-users: if you are *using* the ENGINE abstraction, either in an
81          pre-compiled application or in your own application code.
82
83     openssl-dev: if you are discussing problems with OpenSSL source code.
84
85  USAGE
86  =====
87
88  The default "openssl" ENGINE is always chosen when performing crypto
89  operations unless you specify otherwise. You must actively tell the
90  openssl utility commands to use anything else through a new command line
91  switch called "-engine". Also, if you want to use the ENGINE support in
92  your own code to do something similar, you must likewise explicitly
93  select the ENGINE implementation you want.
94
95  Depending on the type of hardware, system, and configuration, "settings"
96  may need to be applied to an ENGINE for it to function as expected/hoped.
97  The recommended way of doing this is for the application to support
98  ENGINE "control commands" so that each ENGINE implementation can provide
99  whatever configuration primitives it might require and the application
100  can allow the user/admin (and thus the hardware vendor's support desk
101  also) to provide any such input directly to the ENGINE implementation.
102  This way, applications do not need to know anything specific to any
103  device, they only need to provide the means to carry such user/admin
104  input through to the ENGINE in question. Ie. this connects *you* (and
105  your helpdesk) to the specific ENGINE implementation (and device), and
106  allows application authors to not get buried in hassle supporting
107  arbitrary devices they know (and care) nothing about.
108
109  A new "openssl" utility, "openssl engine", has been added in that allows
110  for testing and examination of ENGINE implementations. Basic usage
111  instructions are available by specifying the "-?" command line switch.
112
113  DYNAMIC ENGINES
114  ===============
115
116  The new "dynamic" ENGINE provides a low-overhead way to support ENGINE
117  implementations that aren't pre-compiled and linked into OpenSSL-based
118  applications. This could be because existing compiled-in implementations
119  have known problems and you wish to use a newer version with an existing
120  application. It could equally be because the application (or OpenSSL
121  library) you are using simply doesn't have support for the ENGINE you
122  wish to use, and the ENGINE provider (eg. hardware vendor) is providing
123  you with a self-contained implementation in the form of a shared-library.
124  The other use-case for "dynamic" is with applications that wish to
125  maintain the smallest foot-print possible and so do not link in various
126  ENGINE implementations from OpenSSL, but instead leaves you to provide
127  them, if you want them, in the form of "dynamic"-loadable
128  shared-libraries. It should be possible for hardware vendors to provide
129  their own shared-libraries to support arbitrary hardware to work with
130  applications based on OpenSSL 0.9.7 or later. If you're using an
131  application based on 0.9.7 (or later) and the support you desire is only
132  announced for versions later than the one you need, ask the vendor to
133  backport their ENGINE to the version you need.
134
135  How does "dynamic" work?
136  ------------------------
137    The dynamic ENGINE has a special flag in its implementation such that
138    every time application code asks for the 'dynamic' ENGINE, it in fact
139    gets its own copy of it. As such, multi-threaded code (or code that
140    multiplexes multiple uses of 'dynamic' in a single application in any
141    way at all) does not get confused by 'dynamic' being used to do many
142    independent things. Other ENGINEs typically don't do this so there is
143    only ever 1 ENGINE structure of its type (and reference counts are used
144    to keep order). The dynamic ENGINE itself provides absolutely no
145    cryptographic functionality, and any attempt to "initialise" the ENGINE
146    automatically fails. All it does provide are a few "control commands"
147    that can be used to control how it will load an external ENGINE
148    implementation from a shared-library. To see these control commands,
149    use the command-line;
150
151       openssl engine -vvvv dynamic
152
153    The "SO_PATH" control command should be used to identify the
154    shared-library that contains the ENGINE implementation, and "NO_VCHECK"
155    might possibly be useful if there is a minor version conflict and you
156    (or a vendor helpdesk) is convinced you can safely ignore it.
157    "ID" is probably only needed if a shared-library implements
158    multiple ENGINEs, but if you know the engine id you expect to be using,
159    it doesn't hurt to specify it (and this provides a sanity check if
160    nothing else). "LIST_ADD" is only required if you actually wish the
161    loaded ENGINE to be discoverable by application code later on using the
162    ENGINE's "id". For most applications, this isn't necessary - but some
163    application authors may have nifty reasons for using it. The "LOAD"
164    command is the only one that takes no parameters and is the command
165    that uses the settings from any previous commands to actually *load*
166    the shared-library ENGINE implementation. If this command succeeds, the
167    (copy of the) 'dynamic' ENGINE will magically morph into the ENGINE
168    that has been loaded from the shared-library. As such, any control
169    commands supported by the loaded ENGINE could then be executed as per
170    normal. Eg. if ENGINE "foo" is implemented in the shared-library
171    "libfoo.so" and it supports some special control command "CMD_FOO", the
172    following code would load and use it (NB: obviously this code has no
173    error checking);
174
175       ENGINE *e = ENGINE_by_id("dynamic");
176       ENGINE_ctrl_cmd_string(e, "SO_PATH", "/lib/libfoo.so", 0);
177       ENGINE_ctrl_cmd_string(e, "ID", "foo", 0);
178       ENGINE_ctrl_cmd_string(e, "LOAD", NULL, 0);
179       ENGINE_ctrl_cmd_string(e, "CMD_FOO", "some input data", 0);
180
181    For testing, the "openssl engine" utility can be useful for this sort
182    of thing. For example the above code excerpt would achieve much the
183    same result as;
184
185       openssl engine dynamic \
186                 -pre SO_PATH:/lib/libfoo.so \
187                 -pre ID:foo \
188                 -pre LOAD \
189                 -pre "CMD_FOO:some input data"
190
191    Or to simply see the list of commands supported by the "foo" ENGINE;
192
193       openssl engine -vvvv dynamic \
194                 -pre SO_PATH:/lib/libfoo.so \
195                 -pre ID:foo \
196                 -pre LOAD
197
198    Applications that support the ENGINE API and more specifically, the
199    "control commands" mechanism, will provide some way for you to pass
200    such commands through to ENGINEs. As such, you would select "dynamic"
201    as the ENGINE to use, and the parameters/commands you pass would
202    control the *actual* ENGINE used. Each command is actually a name-value
203    pair and the value can sometimes be omitted (eg. the "LOAD" command).
204    Whilst the syntax demonstrated in "openssl engine" uses a colon to
205    separate the command name from the value, applications may provide
206    their own syntax for making that separation (eg. a win32 registry
207    key-value pair may be used by some applications). The reason for the
208    "-pre" syntax in the "openssl engine" utility is that some commands
209    might be issued to an ENGINE *after* it has been initialised for use.
210    Eg. if an ENGINE implementation requires a smart-card to be inserted
211    during initialisation (or a PIN to be typed, or whatever), there may be
212    a control command you can issue afterwards to "forget" the smart-card
213    so that additional initialisation is no longer possible. In
214    applications such as web-servers, where potentially volatile code may
215    run on the same host system, this may provide some arguable security
216    value. In such a case, the command would be passed to the ENGINE after
217    it has been initialised for use, and so the "-post" switch would be
218    used instead. Applications may provide a different syntax for
219    supporting this distinction, and some may simply not provide it at all
220    ("-pre" is almost always what you're after, in reality).
221
222  How do I build a "dynamic" ENGINE?
223  ----------------------------------
224    This question is trickier - currently OpenSSL bundles various ENGINE
225    implementations that are statically built in, and any application that
226    calls the "ENGINE_load_builtin_engines()" function will automatically
227    have all such ENGINEs available (and occupying memory). Applications
228    that don't call that function have no ENGINEs available like that and
229    would have to use "dynamic" to load any such ENGINE - but on the other
230    hand such applications would only have the memory footprint of any
231    ENGINEs explicitly loaded using user/admin provided control commands.
232    The main advantage of not statically linking ENGINEs and only using
233    "dynamic" for hardware support is that any installation using no
234    "external" ENGINE suffers no unnecessary memory footprint from unused
235    ENGINEs. Likewise, installations that do require an ENGINE incur the
236    overheads from only *that* ENGINE once it has been loaded.
237
238    Sounds good? Maybe, but currently building an ENGINE implementation as
239    a shared-library that can be loaded by "dynamic" isn't automated in
240    OpenSSL's build process. It can be done manually quite easily however.
241    Such a shared-library can either be built with any OpenSSL code it
242    needs statically linked in, or it can link dynamically against OpenSSL
243    if OpenSSL itself is built as a shared library. The instructions are
244    the same in each case, but in the former (statically linked any
245    dependencies on OpenSSL) you must ensure OpenSSL is built with
246    position-independent code ("PIC"). The default OpenSSL compilation may
247    already specify the relevant flags to do this, but you should consult
248    with your compiler documentation if you are in any doubt.
249
250    This example will show building the "atalla" ENGINE in the
251    crypto/engine/ directory as a shared-library for use via the "dynamic"
252    ENGINE.
253    1) "cd" to the crypto/engine/ directory of a pre-compiled OpenSSL
254       source tree.
255    2) Recompile at least one source file so you can see all the compiler
256       flags (and syntax) being used to build normally. Eg;
257           touch hw_atalla.c ; make
258       will rebuild "hw_atalla.o" using all such flags.
259    3) Manually enter the same compilation line to compile the
260       "hw_atalla.c" file but with the following two changes;
261         (a) add "-DENGINE_DYNAMIC_SUPPORT" to the command line switches,
262	 (b) change the output file from "hw_atalla.o" to something new,
263             eg. "tmp_atalla.o"
264    4) Link "tmp_atalla.o" into a shared-library using the top-level
265       OpenSSL libraries to resolve any dependencies. The syntax for doing
266       this depends heavily on your system/compiler and is a nightmare
267       known well to anyone who has worked with shared-library portability
268       before. 'gcc' on Linux, for example, would use the following syntax;
269          gcc -shared -o dyn_atalla.so tmp_atalla.o -L../.. -lcrypto
270    5) Test your shared library using "openssl engine" as explained in the
271       previous section. Eg. from the top-level directory, you might try;
272          apps/openssl engine -vvvv dynamic \
273              -pre SO_PATH:./crypto/engine/dyn_atalla.so -pre LOAD
274       If the shared-library loads successfully, you will see both "-pre"
275       commands marked as "SUCCESS" and the list of control commands
276       displayed (because of "-vvvv") will be the control commands for the
277       *atalla* ENGINE (ie. *not* the 'dynamic' ENGINE). You can also add
278       the "-t" switch to the utility if you want it to try and initialise
279       the atalla ENGINE for use to test any possible hardware/driver
280       issues.
281
282  PROBLEMS
283  ========
284
285  It seems like the ENGINE part doesn't work too well with CryptoSwift on Win32.
286  A quick test done right before the release showed that trying "openssl speed
287  -engine cswift" generated errors. If the DSO gets enabled, an attempt is made
288  to write at memory address 0x00000002.
289
290

README.FIPS

1Preliminary status and build information for FIPS module v2.0
2
3NB: if you are cross compiling you now need to use the latest "incore" script
4this can be found at util/incore in the tarballs.
5
6If you have any object files from a previous build do:
7
8make clean
9
10To build the module do:
11
12./config fipscanisteronly
13make
14
15Build should complete without errors.
16
17Build test utilities:
18
19make build_tests
20
21Run test suite:
22
23test/fips_test_suite
24
25again should complete without errors.
26
27Run test vectors: 
28
291. Download an appropriate set of testvectors from www.openssl.org/docs/fips
30   only the fips-2.0 testvector files are usable for complete tests.
31
322. Extract the files to a suitable directory.
33
343. Run the test vector perl script, for example:
35
36   cd fips
37   perl fipsalgtest.pl --dir=/wherever/stuff/was/extracted
38
394. It should say "passed all tests" at the end. Report full details of any
40   failures.
41
42If you wish to use the older 1.2.x testvectors (for example those from 2007)
43you need the command line switch --disable-v2 to fipsalgtest.pl
44
45Examine the external symbols in fips/fipscanister.o they should all begin
46with FIPS or fips. One way to check with GNU nm is:
47
48	nm -g --defined-only fips/fipscanister.o | grep -v -i fips
49
50If you get *any* output at all from this test (i.e. symbols not starting with
51fips or FIPS) please report it.
52
53Restricted tarball tests.
54
55The validated module will have its own tarball containing sufficient code to
56build fipscanister.o and the associated algorithm tests. You can create a
57similar tarball yourself for testing purposes using the commands below.
58
59Standard restricted tarball:
60
61make -f Makefile.fips dist
62
63Prime field field only ECC tarball:
64
65make NOEC2M=1 -f Makefile.fips dist
66
67Once you've created the tarball extract into a fresh directory and do:
68
69./config
70make
71
72You can then run the algorithm tests as above. This build automatically uses
73fipscanisterbuild and no-ec2m as appropriate.
74
75FIPS capable OpenSSL test: WARNING PRELIMINARY INSTRUCTIONS, SUBJECT TO CHANGE.
76
77At least initially the test module and FIPS capable OpenSSL may change and
78by out of sync. You are advised to check for any changes and pull the latest
79source from CVS if you have problems. See anon CVS and rsync instructions at:
80
81http://www.openssl.org/source/repos.html
82
83Make or download a restricted tarball from ftp://ftp.openssl.org/snapshot/
84
85If required set the environment variable FIPSDIR to an appropriate location
86to install the test module. If cross compiling set other environment
87variables too.
88
89In this restricted tarball on a Linux or U*ix like system run:
90
91./config
92make
93make install
94
95On Windows from a VC++ environment do:
96
97ms\do_fips
98
99This will build and install the test module and some associated files.
100
101Now download the latest version of the OpenSSL 1.0.1 branch from either a
102snapshot or preferably CVS. For Linux do:
103
104./config fips [other args]
105make
106
107For Windows:
108
109perl Configure VC-WIN32 fips [other args]
110ms\do_nasm
111nmake -f ms\ntdll.mak
112
113(or ms\nt.mak for a static build).
114
115Where [other args] can be any other arguments you use for an OpenSSL build
116such as "shared" or "zlib".
117
118This will build the fips capable OpenSSL and link it to the test module. You
119can now try linking and testing applications against the FIPS capable OpenSSL.
120
121Please report any problems to either the openssl-dev mailing list or directly
122to me steve@openssl.org . Check the mailing lists regularly to avoid duplicate
123reports.
124
125Known issues:
126
127Code needs extensively reviewing to ensure it builds correctly on 
128supported platforms and is compliant with FIPS 140-2.
129The "FIPS capable OpenSSL" is still largely untested, it builds and runs
130some simple tests OK on some systems but needs far more "real world" testing.
131