Replace AUTHOR with a better HISTORY as in FreeBSD's manpages
[openssl.git] / doc / rsaref.doc
1 This package can be compiled to use the RSAref library.
2 This library is not allowed outside of the USA but inside the USA it is
3 claimed by RSA to be the only RSA public key library that can be used
4 besides BSAFE..
5
6 There are 2 files, rsaref/rsaref.c and rsaref/rsaref.h that contain the glue
7 code to use RSAref.  These files were written by looking at the PGP
8 source code and seeing which routines it used to access RSAref.
9 I have also been sent by some-one a copy of the RSAref header file that
10 contains the library error codes.
11
12 [ Jun 1996 update - I have recently gotten hold of RSAref 2.0 from
13   South Africa and have been doing some performace tests. ]
14         
15 They have now been tested against the recently announced RSAEURO
16 library.
17
18 There are 2 ways to use SSLeay and RSAref.  First, to build so that
19 the programs must be linked with RSAref, add '-DRSAref' to CFLAG in the top
20 level makefile and -lrsaref (or where ever you are keeping RSAref) to
21 EX_LIBS.
22
23 To build a makefile via util/mk1mf.pl to do this, use the 'rsaref' option.
24
25 The second method is to build as per normal and link applications with
26 the RSAglue library.  The correct library order would be
27 cc -o cmd cmd.o -lssl -lRSAglue -lcrypto -lrsaref -ldes
28 The RSAglue library is built in the rsa directory and is NOT
29 automatically installed.
30
31 Be warned that the RSAEURO library, that is claimed to be compatible
32 with RSAref contains a different value for the maximum number of bits
33 supported.  This changes structure sizes and so if you are using
34 RSAEURO, change the value of RSAref_MAX_BITS in rsa/rsaref.h
35