1# This Source Code Form is subject to the terms of the Mozilla Public
2# License, v. 2.0. If a copy of the MPL was not distributed with this
3# file, You can obtain one at http://mozilla.org/MPL/2.0/.
4
5This directory contains both sample applications and performance evaluation
6applications.
7
8SAMPLE APPLICATIONS
9
10Currently, there are two performance applications: libpkix_buildThreads and
11nss_threads. And three sample applications: dumpcert, dumpcrl and
12validateChain..
13
14============================================================================
15
16USAGE: 	dumpcert <certFile>
17	Parses a certificate located at <certFile> and displays it.
18
19Source: <root>/tests/sample_apps/dumpcert.c
20Binary: <root>/bin/sample_apps/dumpcert
21
22============================================================================
23
24USAGE: 	dumpcrl <crlFile>
25	Parses a CRL located at <crlFile> and displays it.
26
27Source: <root>/tests/sample_apps/dumpcrl.c
28Binary: <root>/bin/sample_apps/dumpcrl
29
30============================================================================
31
32USAGE: 	validateChain <trustedCert> <cert_1> <cert_2> ... <cert_n>
33	Validates a chain of n certificates using the given trust anchor.
34
35Source: <root>/tests/sample_apps/validateChain.c
36Binary: <root>/bin/sample_apps/validateChain
37
38============================================================================
39
40PERFORMANCE EVALUATION APPLICATIONS
41
42============================================================================
43
44USAGE:  libpkix_buildthreads <duration> <threads> <eecertNickname>
45
46	Sets up and runs a PKIX_BuildChain call for the number of seconds
47	specified by <duration> using the number of threads specified by
48	<threads>. This application assumes that the NSS certutil application
49	has already been run to create the NSS databases and that the
50	various nicknames on the command line have been associated with
51	certificates in the NSS databases. The NSS databases MUST reside
52	in the directory where this file is located and MUST be named
53	"cert8.db", "key3.db", and "secmod.db". There must exist a nickname
54        in the databases which has been marked as trusted.
55
56Source: <root>/perf/libpkix_buildthreads/libpkix_buildthreads.c
57Binary: <root>/perf/libpkix_buildthreads/*.OBJ/libpkix_buildthreads
58
59============================================================================
60
61USAGE:  nssThreads <duration> <threads> <eecertNickname>
62
63	Sets up and runs a CERT_VerifyCertificate call for the number of
64	seconds specified by <duration> using the number of threads specified
65	by <threads>. This application assumes that the NSS certutil
66	application has already been run to create the NSS databases and that
67	the various nicknames on the command line have been associated with
68	certificates in the NSS databases. The NSS databases MUST reside
69	in the directory where this file is located and MUST be named
70	"cert8.db", "key3.db", and "secmod.db". There must exist a nickname in
71	the databases which has been marked as trusted.
72
73Source: <root>/perf/nss_threads/nss_threads.c
74Binary: <root>/perf/nss_threads/*.OBJ/nss_threads
75
76============================================================================
77
78