1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/security/nss/tests/pkcs11/netscape/trivial/README.txt Wed Dec 31 06:09:35 2014 +0100 1.3 @@ -0,0 +1,56 @@ 1.4 +This is a very trivial program that loads and excercises a PKCS#11 1.5 +module, trying basic operations. I used it as a basic check that 1.6 +my data-only modules for NSS worked, and I'm including it here as 1.7 +a first sample test program. 1.8 + 1.9 + 1.10 +This program uses GNU autoconf: run ./configure --help for info. 1.11 +In addition to the standard options, the configure script accepts 1.12 +the following: 1.13 + 1.14 + --with-nspr[=path] specify location of NSPR 1.15 + --with-nss-dist[=path] specify path to NSS dist directory 1.16 + --with-nss-hdrs[=path] or, specify path to installed NSS headers 1.17 + --with-rsa-hdrs[=path] if not using NSS, specify path to RSA headers 1.18 + --disable-debug default is enabled 1.19 + 1.20 +This program uses NSPR; you may specify the path to your NSPR 1.21 +installation by using the "--with-nspr" option. The specified 1.22 +directory should be the one containing "include" and "lib." 1.23 +If this option is not given, the default is the usual prefix 1.24 +directories; see ./configure --help for more info. 1.25 + 1.26 +This program requires either the pkcs11*.h files from RSA, or 1.27 +the NSS equivalents. To specify their location, you must 1.28 +specify one of --with-nss-dist, --with-nss-hdrs, or --with-rsa-hdrs. 1.29 + 1.30 +If you have an NSS build tree, specify --with-nss-dist and provide 1.31 +the path to the mozilla/dist/*.OBJ directory. (If you got this 1.32 +package by checking it out from mozilla, it should be about six 1.33 +directories up, once you've built NSS.) 1.34 + 1.35 +Alternatively, if you have an NSS installation (including "private" 1.36 +files, e.g. "ck.h") you may point directly to the directory containing 1.37 +the headers with --with-nss-hdrs. 1.38 + 1.39 +If you would rather use the RSA-provided header files, or your own 1.40 +versions of them, specify their location with --with-rsa-hdrs. 1.41 + 1.42 +The flag --disable-debug doesn't really do much here other than 1.43 +exclude the CVS_ID info from the binary. 1.44 + 1.45 + 1.46 +To run the program, specify the name of the .so (or your platform's 1.47 +equivalent) containing the module to be tested, e.g.: 1.48 + 1.49 + ./trivial ../../../../../../dist/*.OBJ/lib/libnssckbi.so 1.50 + 1.51 + 1.52 +If you're using NSS, and using our experimental "installer's 1.53 +arguments" fields in CK_C_INITIALIZE_ARGS, you can specify an 1.54 +"installer argument" with the -i flag: 1.55 + 1.56 + ./trivial -i ~/.netscape/certs.db [...]/libnssckdb.so 1.57 + 1.58 + 1.59 +Share and enjoy.