X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=SoftHSMv2%2FREADME.md;fp=SoftHSMv2%2FREADME.md;h=e3b46a3f768af0248d7fa434ce8ba7397bdc2214;hb=7626b75b3c71173ba62c2f92d22bab8f4291e44a;hp=c8230e8f5e5a0cdd393563359b5e736d50c0ffb2;hpb=f2ff7a136a152b36b3aa4d0d574796e6edbef24a;p=aaf%2Fsshsm.git diff --git a/SoftHSMv2/README.md b/SoftHSMv2/README.md index c8230e8..e3b46a3 100644 --- a/SoftHSMv2/README.md +++ b/SoftHSMv2/README.md @@ -41,11 +41,21 @@ Minimum required versions: If you are using Botan, make sure that it has support for GNU MP (--with-gnump). This will improve the performance when doing public key operations. -The GNU Autotools are also required for building the software. +The GNU Autotools (Autoconf, Automake, Libtool) are also required for building +the software. It is also recommended to install pkg-config so that the +configure script can find the installed software. There is a migration tool for converting token databases from SoftHSMv1 into -the new type of tokens. If this tool is built, then SQLite3 is required (>= -3.4.2). +the new type of tokens. If this tool is built (--with-migrate), then SQLite3 +is required (>= 3.4.2). + +SQLite3 is also required if building with the database object store +(--with-objectstore-backend-db). + +To install SoftHSM as a PKCS#11 module on the system, please install +libp11-kit-dev. + +The unit tests requires CppUnit. ## Installation @@ -62,6 +72,7 @@ Options: Disable non-paged memory for secure storage (default enabled) --disable-ecc Disable support for ECC (default enabled) + --disable-eddsa Disable support for EDDSA (default enabled) --disable-gost Disable support for GOST (default enabled) --disable-visibility Disable hidden visibilty link mode [enabled] --with-crypto-backend Select crypto backend (openssl|botan) @@ -87,6 +98,12 @@ Compile the source code using the following command: make +### Unit tests + +Running the unit tests requires CppUnit. + + make check + ### Install Library Install the library using the follow command: @@ -144,6 +161,6 @@ the source file name and line number. If the code is downloaded directly from the code repository, you have to prepare the configuration scripts before continuing with the real README. -1. You need to install automake, autoconf, libtool, etc. +1. You need to install automake, autoconf, libtool, libtool-ltdl-devel (RHEL/CentOS), pkg-config. 2. Run the command 'sh autogen.sh' 3. Continue reading this README.