security/nss/tests/libpkix/sample_apps/README

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rwxr-xr-x

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 # ***** BEGIN LICENSE BLOCK *****
michael@0 2 # Version: MPL 1.1/GPL 2.0/LGPL 2.1
michael@0 3 #
michael@0 4 # The contents of this file are subject to the Mozilla Public License Version
michael@0 5 # 1.1 (the "License"); you may not use this file except in compliance with
michael@0 6 # the License. You may obtain a copy of the License at
michael@0 7 # http://www.mozilla.org/MPL/
michael@0 8 #
michael@0 9 # Software distributed under the License is distributed on an "AS IS" basis,
michael@0 10 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
michael@0 11 # for the specific language governing rights and limitations under the
michael@0 12 # License.
michael@0 13 #
michael@0 14 # The Original Code is the PKIX-C library.
michael@0 15 #
michael@0 16 # The Initial Developer of the Original Code is
michael@0 17 # Sun Microsystems, Inc.
michael@0 18 # Portions created by the Initial Developer are
michael@0 19 # Copyright 2004-2007 Sun Microsystems, Inc. All Rights Reserved.
michael@0 20 #
michael@0 21 # Contributor(s):
michael@0 22 # Sun Microsystems, Inc.
michael@0 23 #
michael@0 24 # Alternatively, the contents of this file may be used under the terms of
michael@0 25 # either the GNU General Public License Version 2 or later (the "GPL"), or
michael@0 26 # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
michael@0 27 # in which case the provisions of the GPL or the LGPL are applicable instead
michael@0 28 # of those above. If you wish to allow use of your version of this file only
michael@0 29 # under the terms of either the GPL or the LGPL, and not to allow others to
michael@0 30 # use your version of this file under the terms of the MPL, indicate your
michael@0 31 # decision by deleting the provisions above and replace them with the notice
michael@0 32 # and other provisions required by the GPL or the LGPL. If you do not delete
michael@0 33 # the provisions above, a recipient may use your version of this file under
michael@0 34 # the terms of any one of the MPL, the GPL or the LGPL.
michael@0 35 #
michael@0 36 # ***** END LICENSE BLOCK *****
michael@0 37
michael@0 38 This directory contains both sample applications and performance evaluation
michael@0 39 applications.
michael@0 40
michael@0 41 SAMPLE APPLICATIONS
michael@0 42
michael@0 43 Currently, there are two performance applications: libpkix_buildThreads and
michael@0 44 nss_threads. And three sample applications: dumpcert, dumpcrl and
michael@0 45 validateChain..
michael@0 46
michael@0 47 ============================================================================
michael@0 48
michael@0 49 USAGE: dumpcert <certFile>
michael@0 50 Parses a certificate located at <certFile> and displays it.
michael@0 51
michael@0 52 Source: <root>/tests/sample_apps/dumpcert.c
michael@0 53 Binary: <root>/bin/sample_apps/dumpcert
michael@0 54
michael@0 55 ============================================================================
michael@0 56
michael@0 57 USAGE: dumpcrl <crlFile>
michael@0 58 Parses a CRL located at <crlFile> and displays it.
michael@0 59
michael@0 60 Source: <root>/tests/sample_apps/dumpcrl.c
michael@0 61 Binary: <root>/bin/sample_apps/dumpcrl
michael@0 62
michael@0 63 ============================================================================
michael@0 64
michael@0 65 USAGE: validateChain <trustedCert> <cert_1> <cert_2> ... <cert_n>
michael@0 66 Validates a chain of n certificates using the given trust anchor.
michael@0 67
michael@0 68 Source: <root>/tests/sample_apps/validateChain.c
michael@0 69 Binary: <root>/bin/sample_apps/validateChain
michael@0 70
michael@0 71 ============================================================================
michael@0 72
michael@0 73 PERFORMANCE EVALUATION APPLICATIONS
michael@0 74
michael@0 75 ============================================================================
michael@0 76
michael@0 77 USAGE: libpkix_buildthreads <duration> <threads> <eecertNickname>
michael@0 78
michael@0 79 Sets up and runs a PKIX_BuildChain call for the number of seconds
michael@0 80 specified by <duration> using the number of threads specified by
michael@0 81 <threads>. This application assumes that the NSS certutil application
michael@0 82 has already been run to create the NSS databases and that the
michael@0 83 various nicknames on the command line have been associated with
michael@0 84 certificates in the NSS databases. The NSS databases MUST reside
michael@0 85 in the directory where this file is located and MUST be named
michael@0 86 "cert8.db", "key3.db", and "secmod.db". There must exist a nickname
michael@0 87 in the databases which has been marked as trusted.
michael@0 88
michael@0 89 Source: <root>/perf/libpkix_buildthreads/libpkix_buildthreads.c
michael@0 90 Binary: <root>/perf/libpkix_buildthreads/*.OBJ/libpkix_buildthreads
michael@0 91
michael@0 92 ============================================================================
michael@0 93
michael@0 94 USAGE: nssThreads <duration> <threads> <eecertNickname>
michael@0 95
michael@0 96 Sets up and runs a CERT_VerifyCertificate call for the number of
michael@0 97 seconds specified by <duration> using the number of threads specified
michael@0 98 by <threads>. This application assumes that the NSS certutil
michael@0 99 application has already been run to create the NSS databases and that
michael@0 100 the various nicknames on the command line have been associated with
michael@0 101 certificates in the NSS databases. The NSS databases MUST reside
michael@0 102 in the directory where this file is located and MUST be named
michael@0 103 "cert8.db", "key3.db", and "secmod.db". There must exist a nickname in
michael@0 104 the databases which has been marked as trusted.
michael@0 105
michael@0 106 Source: <root>/perf/nss_threads/nss_threads.c
michael@0 107 Binary: <root>/perf/nss_threads/*.OBJ/nss_threads
michael@0 108
michael@0 109 ============================================================================
michael@0 110

mercurial