1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/security/nss/tests/libpkix/sample_apps/README Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,110 @@
1.4 +# ***** BEGIN LICENSE BLOCK *****
1.5 +# Version: MPL 1.1/GPL 2.0/LGPL 2.1
1.6 +#
1.7 +# The contents of this file are subject to the Mozilla Public License Version
1.8 +# 1.1 (the "License"); you may not use this file except in compliance with
1.9 +# the License. You may obtain a copy of the License at
1.10 +# http://www.mozilla.org/MPL/
1.11 +#
1.12 +# Software distributed under the License is distributed on an "AS IS" basis,
1.13 +# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
1.14 +# for the specific language governing rights and limitations under the
1.15 +# License.
1.16 +#
1.17 +# The Original Code is the PKIX-C library.
1.18 +#
1.19 +# The Initial Developer of the Original Code is
1.20 +# Sun Microsystems, Inc.
1.21 +# Portions created by the Initial Developer are
1.22 +# Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
1.23 +#
1.24 +# Contributor(s):
1.25 +# Sun Microsystems, Inc.
1.26 +#
1.27 +# Alternatively, the contents of this file may be used under the terms of
1.28 +# either the GNU General Public License Version 2 or later (the "GPL"), or
1.29 +# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
1.30 +# in which case the provisions of the GPL or the LGPL are applicable instead
1.31 +# of those above. If you wish to allow use of your version of this file only
1.32 +# under the terms of either the GPL or the LGPL, and not to allow others to
1.33 +# use your version of this file under the terms of the MPL, indicate your
1.34 +# decision by deleting the provisions above and replace them with the notice
1.35 +# and other provisions required by the GPL or the LGPL. If you do not delete
1.36 +# the provisions above, a recipient may use your version of this file under
1.37 +# the terms of any one of the MPL, the GPL or the LGPL.
1.38 +#
1.39 +# ***** END LICENSE BLOCK *****
1.40 +
1.41 +This directory contains both sample applications and performance evaluation
1.42 +applications.
1.43 +
1.44 +SAMPLE APPLICATIONS
1.45 +
1.46 +Currently, there are two performance applications: libpkix_buildThreads and
1.47 +nss_threads. And three sample applications: dumpcert, dumpcrl and
1.48 +validateChain..
1.49 +
1.50 +============================================================================
1.51 +
1.52 +USAGE: dumpcert <certFile>
1.53 + Parses a certificate located at <certFile> and displays it.
1.54 +
1.55 +Source: <root>/tests/sample_apps/dumpcert.c
1.56 +Binary: <root>/bin/sample_apps/dumpcert
1.57 +
1.58 +============================================================================
1.59 +
1.60 +USAGE: dumpcrl <crlFile>
1.61 + Parses a CRL located at <crlFile> and displays it.
1.62 +
1.63 +Source: <root>/tests/sample_apps/dumpcrl.c
1.64 +Binary: <root>/bin/sample_apps/dumpcrl
1.65 +
1.66 +============================================================================
1.67 +
1.68 +USAGE: validateChain <trustedCert> <cert_1> <cert_2> ... <cert_n>
1.69 + Validates a chain of n certificates using the given trust anchor.
1.70 +
1.71 +Source: <root>/tests/sample_apps/validateChain.c
1.72 +Binary: <root>/bin/sample_apps/validateChain
1.73 +
1.74 +============================================================================
1.75 +
1.76 +PERFORMANCE EVALUATION APPLICATIONS
1.77 +
1.78 +============================================================================
1.79 +
1.80 +USAGE: libpkix_buildthreads <duration> <threads> <eecertNickname>
1.81 +
1.82 + Sets up and runs a PKIX_BuildChain call for the number of seconds
1.83 + specified by <duration> using the number of threads specified by
1.84 + <threads>. This application assumes that the NSS certutil application
1.85 + has already been run to create the NSS databases and that the
1.86 + various nicknames on the command line have been associated with
1.87 + certificates in the NSS databases. The NSS databases MUST reside
1.88 + in the directory where this file is located and MUST be named
1.89 + "cert8.db", "key3.db", and "secmod.db". There must exist a nickname
1.90 + in the databases which has been marked as trusted.
1.91 +
1.92 +Source: <root>/perf/libpkix_buildthreads/libpkix_buildthreads.c
1.93 +Binary: <root>/perf/libpkix_buildthreads/*.OBJ/libpkix_buildthreads
1.94 +
1.95 +============================================================================
1.96 +
1.97 +USAGE: nssThreads <duration> <threads> <eecertNickname>
1.98 +
1.99 + Sets up and runs a CERT_VerifyCertificate call for the number of
1.100 + seconds specified by <duration> using the number of threads specified
1.101 + by <threads>. This application assumes that the NSS certutil
1.102 + application has already been run to create the NSS databases and that
1.103 + the various nicknames on the command line have been associated with
1.104 + certificates in the NSS databases. The NSS databases MUST reside
1.105 + in the directory where this file is located and MUST be named
1.106 + "cert8.db", "key3.db", and "secmod.db". There must exist a nickname in
1.107 + the databases which has been marked as trusted.
1.108 +
1.109 +Source: <root>/perf/nss_threads/nss_threads.c
1.110 +Binary: <root>/perf/nss_threads/*.OBJ/nss_threads
1.111 +
1.112 +============================================================================
1.113 +
