+

Search Tips   |   Advanced Search

revokeCertificate command

The revokeCertificate command uses an implementation class that is passed to communicate with a certificate authority (CA) server to revoke a certificate. Processing this command sends a revocation request to the CA server to mark this certificate as revoked.

Issue the command from the profile_root/bin directory.


Syntax

The command syntax is as follows:

(The command is split on multiple lines for printing purposes.)(UNIX) 

revokeCertificate.sh -host<caHost> -port<caPort> -username<caUserName> -password<caPassword> 
-revocationPassword<revocationPassword> -keystoreAlias<keystoreAlias> -alias<certificateAlias>
 -pkiImplClass<customCAClient>[options]
(Windows) 
revokeCertificate.bat -host<caHost> -port<caPort> -username<caUserName> -password<caPassword> 
-revocationPassword<revocationPassword> -keystoreAlias<keystoreAlias>  -alias<certificateAlias> 
-pkiImplClass<customCAClient>[options]
(ZOS) 
revokeCertificate.sh -host<caHost> -port<caPort> -username<caUserName>  -password<caPassword> 
-revocationPassword<revocationPassword> -keystoreAlias<keystoreAlias> -alias<certificateAlias> 
-pkiImplClass<customCAClient>[options]
(iSeries) 
revokeCertificate -host<caHost> -port<caPort> -username<caUserName>  -password<caPassword>
-revocationPassword<revocationPassword> -keystoreAlias<keystoreAlias>  -alias<certificateAlias> 
-pkiImplClass<customCAClient>[options]


Required Parameters

The following required parameter are used with the revokeCertifcate command:

-host caHost

Target certificate authority host to which the request is sent.

-port caPort

Target port to connect to.

-username caUserName

User name used to gain access to the certificate authority.

-password caPassword

Password used to authenticate with the certificate authority.

-revocationPassword revocationPassword

Password that is to be set on the certificate returned by the certificate authority. The revocation password is sent to the certificate authority during each request and is associated with each certificate that is issued. To later revoke a certificate, the same revocation password must be sent during a revokeCertificate request.

keyStoreAliaskeyStoreAlias

Name of the keystore located in the ssl.client.props file for the profile to which the CA signed certificate is added. This file is usually the ClientDefaultKeyStore file for either a managed or unmanaged environment.

-alias certificateAlias

Specifies The alias of the certificate request to be revoked. The certificate is stored in the keystore specified on the request.

-pkiImplClass custom CA Client

A class that implements the WSPKIClient interface. The implementation class handles all the communication to the CA server. This can be a custom class or a class provided with the product.


Optional Parameters

The following options are available for the revokeCertificate command:

-revocationReasonUsage revocation reason

The reason for revoking the certificate. The default is "unspecified".

-customAttrs customAttr1=value;customAttr2=value;...

A semi-colon separated list of custom name=value pairs to be passed in to the custom implementation class. This parameter provides a way to pass custom information to the implementation class. The ‘attr' and ‘value' pairs are converted to a hash map and passed to the implementation class.

-logfile filename

Overrides the default trace file. By default, the trace appears in the profiles/profile/log/caClient.log. file.

-trace

When specified, -trace enables tracing of the trace specification necessary to debug this component. By default, the trace appears in the profiles/profile/log/caClient.log file.

-replaceLog

An option to cause the existing trace file to be replaced when the command is executed. -quit

-quiet

An option to suppress most messages from printing out on the console.

-help

The option to print a usage statement

-?

The option to print a usage statement

The following example performs a revokeCertificate:

(UNIX) 

revokeCertificate.sh -host localhost -port 1077
-username pkiuser -password webspherepki -alias cert1 -keyStoreAlias ClientDefau
ltKeyStore -revocationPassword webspherepki
CWPKI0403I: Trace is being logged to the following location:
           C:\opt\WebSphere\AppClient\logs\caClient.log
CWPKI0461I: Revoking a CA signed certificate.
CWPKI0462I: CA Signed Certificate Revoked [Issued By: O=IBM, C=US, Issued To:
           CN=mycn, O=ibm, C=us, Not Before: Thu Feb 22 09:07:53 CST 2007, Not
           After: Sat Feb 16 10:09:19 CST 2008] for reason: unspecified
(Windows) 
C:\opt\WebSphere\AppClient\bin>revokeCertificate.bat -host localhost -port 1077
-username pkiuser -password webspherepki -alias cert1 -keyStoreAlias ClientDefau
ltKeyStore -revocationPassword webspherepki
CWPKI0403I: Trace is being logged to the following location:
           C:\opt\WebSphere\AppClient\logs\caClient.log
CWPKI0461I: Revoking a CA signed certificate.
CWPKI0462I: CA Signed Certificate Revoked [Issued By: O=IBM, C=US, Issued To:
           CN=mycn, O=ibm, C=us, Not Before: Thu Feb 22 09:07:53 CST 2007, Not
           After: Sat Feb 16 10:09:19 CST 2008] for reason: unspecified
(ZOS) 
revokeCertificate.sh -host localhost -port 1077
-username pkiuser -password webspherepki -alias cert1 -keyStoreAlias ClientDefau
ltKeyStore -revocationPassword webspherepki
CWPKI0403I: Trace is being logged to the following location:
           C:\opt\WebSphere\AppClient\logs\caClient.log
CWPKI0461I: Revoking a CA signed certificate.
CWPKI0462I: CA Signed Certificate Revoked [Issued By: O=IBM, C=US, Issued To:
           CN=mycn, O=ibm, C=us, Not Before: Thu Feb 22 09:07:53 CST 2007, Not
           After: Sat Feb 16 10:09:19 CST 2008] for reason: unspecified
(iSeries) 
revokeCertificate -host localhost -port 1077
-username pkiuser -password webspherepki -alias cert1 -keyStoreAlias ClientDefau
ltKeyStore -revocationPassword webspherepki
CWPKI0403I: Trace is being logged to the following location:
           C:\opt\WebSphere\AppClient\logs\caClient.log
CWPKI0461I: Revoking a CA signed certificate.
CWPKI0462I: CA Signed Certificate Revoked [Issued By: O=IBM, C=US, Issued To:
           CN=mycn, O=ibm, C=us, Not Before: Thu Feb 22 09:07:53 CST 2007, Not
           After: Sat Feb 16 10:09:19 CST 2008] for reason: unspecified

  • Use command-line tools