diff options
Diffstat (limited to 'pki/base/java-tools')
15 files changed, 80 insertions, 32 deletions
diff --git a/pki/base/java-tools/src/com/netscape/cmstools/AtoB.java b/pki/base/java-tools/src/com/netscape/cmstools/AtoB.java index 3a0d6ada7..bdeaee273 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/AtoB.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/AtoB.java @@ -33,12 +33,12 @@ import java.io.*; * The program may be invoked as follows: * <PRE> * - * AtoB <input filename> <output filename> + * AtoB <input filename> <output filename> * - * NOTE: <input filename> must contain an ASCII + * NOTE: <input filename> must contain an ASCII * BASE 64 encoded blob * - * <output filename> contains a BINARY + * <output filename> contains a BINARY * BASE 64 encoded blob * </PRE> * diff --git a/pki/base/java-tools/src/com/netscape/cmstools/BtoA.java b/pki/base/java-tools/src/com/netscape/cmstools/BtoA.java index fb303f28c..d00fb6122 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/BtoA.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/BtoA.java @@ -32,12 +32,12 @@ import java.io.*; * The program may be invoked as follows: * <PRE> * - * BtoA <input filename> <output filename> + * BtoA <input filename> <output filename> * - * NOTE: <input filename> must contain a BINARY + * NOTE: <input filename> must contain a BINARY * BASE 64 encoded blob * - * <output filename> contains an ASCII + * <output filename> contains an ASCII * BASE 64 encoded blob * </PRE> * diff --git a/pki/base/java-tools/src/com/netscape/cmstools/CMCResponse.java b/pki/base/java-tools/src/com/netscape/cmstools/CMCResponse.java index 38411feb0..04d3b4ddc 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/CMCResponse.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/CMCResponse.java @@ -47,6 +47,13 @@ import java.io.*; import java.util.*; import java.text.*; +/** + * Tool for parsing a CMC response + * + * <P> + * @version $Revision$, $Date$ + * + */ public class CMCResponse { diff --git a/pki/base/java-tools/src/com/netscape/cmstools/CMCRevoke.java b/pki/base/java-tools/src/com/netscape/cmstools/CMCRevoke.java index a3d958238..97d4f3551 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/CMCRevoke.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/CMCRevoke.java @@ -50,7 +50,7 @@ import java.util.*; /** - * Tool for signing PKCS #10 , return CMC + * Tool for signing a CMC revocation request with an agent's certificate. * * <P> * @version $Revision$, $Date$ diff --git a/pki/base/java-tools/src/com/netscape/cmstools/CRMFPopClient.java b/pki/base/java-tools/src/com/netscape/cmstools/CRMFPopClient.java index 2748af24f..82c77a246 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/CRMFPopClient.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/CRMFPopClient.java @@ -52,12 +52,11 @@ import com.netscape.cmsutil.util.*; /** - * Description: A command-line utility used to generate a - * Certificate Request Message Format (CRMF) - * request with proof of possesion (POP). + * A command-line utility used to generate a Certificate Request Message + * Format (CRMF) request with proof of possesion (POP). * * Usage: - * + * <pre> * CRMFPopClient TOKEN_PWD * Authenticator HOST PORT USER_NAME PASSWORD * POP_OPTION @@ -71,10 +70,10 @@ import com.netscape.cmsutil.util.*; * * * where POP_OPTION can be [POP_SUCCESS or POP_FAIL or POP_NONE] - * - * + * </pre> + * <p> * Examples: - * + * <pre> * CRMFPopClient password123 * nullAuthMgr host.netscape.com 1026 admin netscape * [POP_SUCCESS or POP_FAIL or POP_NONE] @@ -92,12 +91,16 @@ import com.netscape.cmsutil.util.*; * CRMFPopClient password123 * [POP_SUCCESS or POP_FAIL or POP_NONE] * OUTPUT_CERT_REQ CN=MyTest,C=US,UID=MyUid - * - * + * </pre> + * <p> + * <pre> * IMPORTANT: The file "transport.txt" needs to be created to contain the * transport certificate in its base64 encoded format. This * file should consist of one line containing a single certificate * in base64 encoded format with the header and footer removed. + * </pre> + * <p> + * @version $Revision$, $Date$ */ public class CRMFPopClient { diff --git a/pki/base/java-tools/src/com/netscape/cmstools/ExtJoiner.java b/pki/base/java-tools/src/com/netscape/cmstools/ExtJoiner.java index af2243124..2854c04a1 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/ExtJoiner.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/ExtJoiner.java @@ -31,11 +31,12 @@ import netscape.security.util.*; * certificates (i.e. CA certificate, SSL certificate). * * Usage: + * <pre> * ExtJoiner \ - * <ext_file0> <ext_file1> ... <ext_fileN> + * <ext_file0> <ext_file1> ... <ext_fileN> * * where, - * <ext_file> is a file that has the base64 + * <ext_file> is a file that has the base64 * encoded DER encoding of an X509 Extension * * ExtensionSequence ::= SEQUENCE OF Extension; @@ -58,7 +59,7 @@ import netscape.security.util.*; * : 73 63 61 70 65 2E 63 6F 6D 88 03 29 01 01 * : } * : } - * + * </pre> * * @version $Revision$, $Date$ */ diff --git a/pki/base/java-tools/src/com/netscape/cmstools/GenIssuerAltNameExt.java b/pki/base/java-tools/src/com/netscape/cmstools/GenIssuerAltNameExt.java index 993db784a..3ce25778b 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/GenIssuerAltNameExt.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/GenIssuerAltNameExt.java @@ -30,11 +30,12 @@ import netscape.security.util.*; * the configuration wizard. * * Usage: + * <pre> * GenIssuerAltNameExt \ - * <general_type0> <general_name0> ... <general_typeN> <general_nameN> + * <general_type0> <general_name0> ... <general_typeN> <general_nameN> * * where, - * <general_type> can be one of the following string: + * <general_type> can be one of the following string: * DNSName * EDIPartyName * IPAddressName @@ -42,7 +43,8 @@ import netscape.security.util.*; * RFC822Name * OIDName * X500Name - * <general_name> is string + * <general_name> is string + * </pre> * * @version $Revision$, $Date$ */ diff --git a/pki/base/java-tools/src/com/netscape/cmstools/GenSubjectAltNameExt.java b/pki/base/java-tools/src/com/netscape/cmstools/GenSubjectAltNameExt.java index dc41f292a..8d28a04e0 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/GenSubjectAltNameExt.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/GenSubjectAltNameExt.java @@ -30,11 +30,12 @@ import netscape.security.util.*; * the configuration wizard. * * Usage: + * <pre> * GenSubjectAltNameExt \ - * <general_type0> <general_name0> ... <general_typeN> <general_nameN> + * <general_type0> <general_name0> ... <general_typeN> <general_nameN> * * where, - * <general_type> can be one of the following string: + * <general_type> can be one of the following string: * DNSName * EDIPartyName * IPAddressName @@ -42,7 +43,8 @@ import netscape.security.util.*; * RFC822Name * OIDName * X500Name - * <general_name> is string + * <general_name> is string + * </pre> * * @version $Revision$, $Date$ */ diff --git a/pki/base/java-tools/src/com/netscape/cmstools/HttpClient.java b/pki/base/java-tools/src/com/netscape/cmstools/HttpClient.java index 4ad7ee6c2..f81a7114a 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/HttpClient.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/HttpClient.java @@ -43,6 +43,8 @@ import com.netscape.cmsutil.ocsp.Request; /** * This class implements a CMC Enroll client for testing. + * + * @version $Revision$, $Date$ */ public class HttpClient { diff --git a/pki/base/java-tools/src/com/netscape/cmstools/OCSPClient.java b/pki/base/java-tools/src/com/netscape/cmstools/OCSPClient.java index 6d10a2c0b..30e033926 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/OCSPClient.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/OCSPClient.java @@ -42,6 +42,8 @@ import com.netscape.cmsutil.ocsp.Request; /** * This class implements a OCSP client for testing. + * + * @version $Revision$, $Date$ */ public class OCSPClient { diff --git a/pki/base/java-tools/src/com/netscape/cmstools/PKCS10Client.java b/pki/base/java-tools/src/com/netscape/cmstools/PKCS10Client.java index 02d3cf80a..8c96b8e72 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/PKCS10Client.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/PKCS10Client.java @@ -54,6 +54,22 @@ import org.mozilla.jss.pkix.crmf.*; import com.netscape.cmsutil.util.*; +/** + * Generates a 1024-bit RSA key pair in the security database, constructs a + * PKCS#10 certificate request with the public key, and outputs the request + * to a file. + * <p> + * PKCS #10 is a certification request syntax standard defined by RSA. A CA + * may support multiple types of certificate requests. The Certificate System + * CA supports KEYGEN, PKCS#10, CRMF, and CMC. + * <p> + * To get a certificate from the CA, the certificate request needs to be + * submitted to and approved by a CA agent. Once approved, a certificate is + * created for the request, and certificate attributes, such as extensions, + * are populated according to certificate profiles. + * <p> + * @version $Revision$, $Date$ + */ public class PKCS10Client { diff --git a/pki/base/java-tools/src/com/netscape/cmstools/PrettyPrintCert.java b/pki/base/java-tools/src/com/netscape/cmstools/PrettyPrintCert.java index 2786c1a61..b5ed8177f 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/PrettyPrintCert.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/PrettyPrintCert.java @@ -37,12 +37,12 @@ import netscape.security.util.*; * The program may be invoked as follows: * <PRE> * - * PrettyPrintCert <input filename> [output filename] + * PrettyPrintCert <input filename> [output filename] * - * NOTE: <input filename> must contain an ASCII + * NOTE: <input filename> must contain an ASCII * BASE 64 encoded certificate * - * [output filename] contains a certificate displayed + * <output filename> contains a certificate displayed * in a "pretty print" ASCII format * </PRE> * diff --git a/pki/base/java-tools/src/com/netscape/cmstools/PrettyPrintCrl.java b/pki/base/java-tools/src/com/netscape/cmstools/PrettyPrintCrl.java index 0ce05e6c9..4d410f16f 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/PrettyPrintCrl.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/PrettyPrintCrl.java @@ -37,12 +37,12 @@ import netscape.security.util.*; * The program may be invoked as follows: * <PRE> * - * PrettyPrintCrl <input filename> [output filename] + * PrettyPrintCrl <input filename> [output filename] * - * NOTE: <input filename> must contain an ASCII + * NOTE: <input filename> must contain an ASCII * BASE 64 encoded CRL * - * [output filename] contains a CRL displayed + * <output filename> contains a CRL displayed * in a "pretty print" ASCII format * </PRE> * diff --git a/pki/base/java-tools/src/com/netscape/cmstools/TestCRLSigning.java b/pki/base/java-tools/src/com/netscape/cmstools/TestCRLSigning.java index 240f60d27..b4fdf5d04 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/TestCRLSigning.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/TestCRLSigning.java @@ -50,7 +50,12 @@ import netscape.security.x509.*; import com.netscape.cmsutil.ocsp.*; import com.netscape.cmsutil.ocsp.Request; - +/** + * Tool used to test out signing a CRL + * + * <p> + * @version $Revision$ Date: $ + */ public class TestCRLSigning { public static void printUsage() diff --git a/pki/base/java-tools/src/com/netscape/cmstools/TokenInfo.java b/pki/base/java-tools/src/com/netscape/cmstools/TokenInfo.java index c24fa3afe..016839ae9 100644 --- a/pki/base/java-tools/src/com/netscape/cmstools/TokenInfo.java +++ b/pki/base/java-tools/src/com/netscape/cmstools/TokenInfo.java @@ -50,6 +50,14 @@ import java.util.*; +/** + * Tool used to determine which external hardware tokens are visible to the + * Certificate System subsystem. This can be used to diagnose whether problems + * using tokens are related to the Certificate System being unable to detect it. + * + * <p> + * @version $Revision$ Date: $ + */ public class TokenInfo { /** |