com.ibm.security.certclient

Class PkEeCertReqFactory

  1. java.lang.Object
  2. extended bycom.ibm.security.certclient.PkEeFactory
  3. extended bycom.ibm.security.certclient.PkEeCertReqFactory
All implemented interfaces:
com.ibm.security.certclient.base.PkAttrKind, com.ibm.security.certclient.base.PkCertConstants, com.ibm.security.certclient.base.PkConstants, com.ibm.security.certclient.base.PkHttpConstants, com.ibm.security.certclient.base.PkPollConstants, com.ibm.security.certclient.base.PkRevoConstants

  1. public final class PkEeCertReqFactory
  2. extends PkEeFactory
  3. implements com.ibm.security.certclient.base.PkConstants
Produce an initial certificate request transaction. This requires an initial authentication key to be provided to allow the CA to check the validity of the request.

Field Summary

Fields inherited from class com.ibm.security.certclient.PkEeFactory
CA_DN, caDn, caPort, cmpEvntFmt, keystoreFilename, keystorePwd, keyStoreType, provider
Fields inherited from interface com.ibm.security.certclient.base.PkConstants
BIG_ONE, BIG_TWO, DEFAULT_KEY_SIZE, DEFAULT_LIFETIME, DEFAULT_PROVIDER, DEFAULT_RNG, DSA_KEY_TYPE, EC_KEY_TYPE, MD2_WITH_RSA, MD5_WITH_RSA, PKI_DB_CONN, PKI_DB_CONNS, PKI_ISSUER_DN, PKI_ISSUER_HOST, PKI_ISSUER_PORT, PKI_OPER, PKI_ROOT, RSA_KEY_TYPE, SHA1_WITH_DSA, SHA1_WITH_ECDSA, SHA1_WITH_RSA, SHA2_WITH_ECDSA, SHA3_WITH_ECDSA, SHA3_WITH_RSA, SHA5_WITH_ECDSA, SHA5_WITH_RSA
Fields inherited from interface com.ibm.security.certclient.base.PkAttrKind
ATTR_APPLIED, ATTR_APPROVED, ATTR_NAMES
Fields inherited from interface com.ibm.security.certclient.base.PkCertConstants
CERT_ALGORITHM_ID, CERT_ALGORITHM_NAME, CERT_ALTERNATIVE_NAME, CERT_AUTH_KEY_IDENTIFIER, CERT_BASIC_CONSTRAINTS, CERT_CA_PUBS, CERT_CA_VENDOR, CERT_CMP_VERSION, CERT_CRL_DISTRIBUTION_POINTS, CERT_EXT, CERT_EXT_KEY_USAGE, CERT_HIERARCHICAL, CERT_INIT_PWD, CERT_ISSUER, CERT_ISSUER_ID, CERT_KEY, CERT_KEY_IDENTIFIER, CERT_KEY_TYPE, CERT_KEY_USAGE, CERT_MESSAGE_PROTECTED, CERT_MESSAGE_PROTECTION_ALGORITHM_ID, CERT_MESSAGE_PROTECTION_ALGORITHM_NAME, CERT_MESSAGE_PROTECTION_KEY, CERT_MESSAGE_PROTECTION_PWD, CERT_NAME_CONSTRAINTS, CERT_NETSCAPE_CERT_TYPE, CERT_NOT_AFTER, CERT_NOT_BEFORE, CERT_OPER, CERT_OUTFILENAME, CERT_POLICY_CONSTRAINTS, CERT_POLICY_MAPPINGS, CERT_PRIVATE_KEY, CERT_PRIVATE_KEY_EE, CERT_PRIVATE_KEY_USAGE, CERT_PROVIDER, CERT_PUBLISH_IMMEDIATELY, CERT_RECIPIENT_DN, CERT_REP_HDR, CERT_REQ_ID, CERT_REVO_PUBLIC_KEY, CERT_REVOCATION_PASSPHRASE, CERT_ROOT, CERT_SENDER_KID, CERT_SERIAL_NUMBER, CERT_SUBJECT, CERT_SUBJECT_ALTERNATIVE_NAME, CERT_SUBJECT_ID, CERT_TIME_TO_CHECK_BACK, CERT_VENDOR_TPKI_RA_ENROLL, CERT_VERSION, CERT_VERSION_1, CERT_VERSION_2, CERT_VERSION_3, CERT_X509, KEY_STORE_CERT_ALIAS, KEY_STORE_ENTRY_PWD, KEY_STORE_INIT_CERT_ALIAS, KEY_STORE_INIT_ENTRY_PWD, MAKE_CONF_REQUEST_MESSAGE, MAX_SUBJECT_NAME_LENGTH_TO_STORE_IN_TABLES, sccsid
Fields inherited from interface com.ibm.security.certclient.base.PkRevoConstants
REVO_BAD_SINCE_DATE, REVO_CRL_EXT, REVO_OPER, REVO_PUBLISH_IMMEDIATELY, REVO_REASON, REVO_ROOT
Fields inherited from interface com.ibm.security.certclient.base.PkHttpConstants
HTTP_BASE_NAME, HTTP_FILE_NAME, HTTP_METHOD, HTTP_ROOT, HTTP_VERSION
Fields inherited from interface com.ibm.security.certclient.base.PkPollConstants
POLL_REFERENCE, POLL_ROOT, POLL_TIME_TO_CHECK_BACK

Method Summary

Modifier and Type Method and Description
  1. static
  2. PkEeCertReqTransaction
newCertRequest(int keySize,String subject,int numValidDays,boolean useRSA,boolean useShortSubjectKId,List<String> subjectAltNames,List<String> kUsage,List<String> extkUsage,String iaFile,String revoPwd,String dn)
Deprecated.
  1. static
  2. PkEeCertReqTransaction
newCertRequest(int keySize,String subject,int numValidDays,boolean useRSA,boolean useShortSubjectKId,List<String> subjectAltNames,List<String> kUsage,List<String> extkUsage,String iaFile,String revoPwd,String dn,KeyPair keyPair)
Deprecated.
  1. static
  2. PkEeCertReqTransaction
newCertRequest(int keySize,String subject,int numValidDays,String keyType,String signatureAlgorithm,boolean useShortSubjectKId,List<String> subjectAltNames,List<String> kUsage,List<String> extkUsage,String iaFile,String revoPwd, String dn)
  1. static
  2. PkEeCertReqTransaction
newCertRequest(int keySize,String subject,int numValidDays,String keyType,String signatureAlgorithm,boolean useShortSubjectKId,List<String> subjectAltNames,List<String> kUsage,List<String> extkUsage,String iaFile,String revoPwd, String dn,KeyPair keyPair)
Initialise a certificate request to the supplied CA.
  1. static
  2. PkEeCertReqTransaction
newCertRequest(String subject,String iaFile,String revoPwd,String dn)
Deprecated.
Methods inherited from class com.ibm.security.certclient.PkEeFactory
getCA_DN, getCaDn, getCaPort, getCmpFmt, getKeystoreFilename, getKeyStoreType, getProvider, setCA_DN, setCaDn, setCaPort, setKeystoreFilename, setKeystorePwd, setKeyStoreType, setProvider
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newCertRequest

  1. @Deprecated
  2. public static PkEeCertReqTransaction newCertRequest( int keySize,
  3. String subject,
  4. int numValidDays,
  5. boolean useRSA,
  6. boolean useShortSubjectKId,
  7. List<String> subjectAltNames,
  8. List<String> kUsage,
  9. List<String> extkUsage,
  10. String iaFile,
  11. String revoPwd,
  12. String dn)
  13. throws com.ibm.security.certclient.base.PkException
Deprecated.
Initialise a certificate request to the supplied CA. The request is ready to action.
Parameters:
keySize - size of key.
subject - The Relative DN for the subject. It will be prepended to the value of parameter dn to create the subject DN. For example, String subject="cn=Test Group".
numValidDays - period of certificate validity. Will be measured from current date.
useRSA - if true create RSA key else create with DSA key
useShortSubjectKId - if true use short form of Subject Key Id else use long form
subjectAltNames - (optional)List of subject alternate names. Specify null to indicate that no value is being specified.
  1. email email address for the subject , e.g. newUser@us.ibm.com
  2. dnsName domain name server name. Name is not case sensitive. e.g host.domain
  3. uri universal resource identifier ,e.g http://www.tivoli.com, ftp://www.ibm.com/
  4. ipaddress ipaddress for the subject , e.g. 127.0.0.1
kUsage - (optional)List of Key Usage strings. Acceptable values are- "digital_signature" "non_repudiation" "key_encipherment" "data_encipherment" "encipher_only" "decipher_only"
extkUsage - (optional)List of Extended Key Usage strings. Acceptable values are- "ServerAuth_Id" "ClientAuth_Id" "CodeSigning_Id" "EmailProtection_Id" "IPSecEndSystem_Id" "IPSecTunnel_Id" "IPSecUser_Id" "TimeStamping_Id"
iaFile - initial authorisation file containing initial reference number and passphrase on consecutive lines
revoPwd - password to be used when revoking this certificate after it has been signed
dn - domain name for certificate request. For example, String dn="o=IBM,c=US". If null, value of PkEeFactory CA_DN will be used.
Throws:
com.ibm.security.certclient.base.PkException - Parameter error

newCertRequest

  1. public static PkEeCertReqTransaction newCertRequest( int keySize,
  2. String subject,
  3. int numValidDays,
  4. String keyType,
  5. String signatureAlgorithm,
  6. boolean useShortSubjectKId,
  7. List<String> subjectAltNames,
  8. List<String> kUsage,
  9. List<String> extkUsage,
  10. String iaFile,
  11. String revoPwd,
  12. String dn)
  13. throws com.ibm.security.certclient.base.PkException
Throws:
com.ibm.security.certclient.base.PkException

newCertRequest

  1. @Deprecated
  2. public static PkEeCertReqTransaction newCertRequest( int keySize,
  3. String subject,
  4. int numValidDays,
  5. boolean useRSA,
  6. boolean useShortSubjectKId,
  7. List<String> subjectAltNames,
  8. List<String> kUsage,
  9. List<String> extkUsage,
  10. String iaFile,
  11. String revoPwd,
  12. String dn,
  13. KeyPair keyPair)
  14. throws com.ibm.security.certclient.base.PkException
Deprecated.
Initialise a certificate request to the supplied CA. The request is ready to action.
Parameters:
keySize - size of key. Not used if keyPair is provided.
subject - The Relative DN for the subject. It will be prepended to the value of parameter dn to create the subject DN. For example, String subject="cn=Test Group".
numValidDays - period of certificate validity. Will be measured from current date.
useRSA - if true create RSA key else create with DSA key Not used if keyPair is provided.
useShortSubjectKId - if true use short form of Subject Key Id else use long form
subjectAltNames - (optional)List of subject alternate names. Specify null to indicate that no value is being specified.
  1. email email address for the subject , e.g. newUser@us.ibm.com
  2. dnsName domain name server name. Name is not case sensitive. e.g host.domain
  3. uri universal resource identifier ,e.g http://www.tivoli.com, ftp://www.ibm.com/
  4. ipaddress ipaddress for the subject , e.g. 127.0.0.1
kUsage - (optional)List of Key Usage strings. Acceptable values are- "digital_signature" "non_repudiation" "key_encipherment" "data_encipherment" "encipher_only" "decipher_only"
extkUsage - (optional)List of Extended Key Usage strings. Acceptable values are- "ServerAuth_Id" "ClientAuth_Id" "CodeSigning_Id" "EmailProtection_Id" "IPSecEndSystem_Id" "IPSecTunnel_Id" "IPSecUser_Id" "TimeStamping_Id"
iaFile - initial authorisation file containing initial reference number and passphrase on consecutive lines
revoPwd - password to be used when revoking this certificate after it has been signed
dn - domain name for certificate request. For example, String dn="o=IBM,c=US". If null, value of PkEeFactory CA_DN will be used.
keyPair - keyPair to use for Public/Private Key
Throws:
com.ibm.security.certclient.base.PkException - Parameter error

newCertRequest

  1. public static PkEeCertReqTransaction newCertRequest( int keySize,
  2. String subject,
  3. int numValidDays,
  4. String keyType,
  5. String signatureAlgorithm,
  6. boolean useShortSubjectKId,
  7. List<String> subjectAltNames,
  8. List<String> kUsage,
  9. List<String> extkUsage,
  10. String iaFile,
  11. String revoPwd,
  12. String dn,
  13. KeyPair keyPair)
  14. throws com.ibm.security.certclient.base.PkException
Initialise a certificate request to the supplied CA. The request is ready to action.
Parameters:
keySize - size of key. Not used if keyPair is provided.
subject - The Relative DN for the subject. It will be prepended to the value of parameter dn to create the subject DN. For example, String subject="cn=Test Group".
numValidDays - period of certificate validity. Will be measured from current date.
keyType - Type of key: RSA/DSA/EC.
signatureAlgorithm - Signature Algorithm. Example, SHA2withECDSA. Choose the signature algorithm based on keyType used.
useShortSubjectKId - if true use short form of Subject Key Id else use long form
subjectAltNames - (optional)List of subject alternate names. Specify null to indicate that no value is being specified.
  1. email email address for the subject , e.g. newUser@us.ibm.com
  2. dnsName domain name server name. Name is not case sensitive. e.g host.domain
  3. uri universal resource identifier ,e.g http://www.tivoli.com, ftp://www.ibm.com/
  4. ipaddress ipaddress for the subject , e.g. 127.0.0.1
kUsage - (optional)List of Key Usage strings. Acceptable values are- "digital_signature" "non_repudiation" "key_encipherment" "data_encipherment" "encipher_only" "decipher_only"
extkUsage - (optional)List of Extended Key Usage strings. Acceptable values are- "ServerAuth_Id" "ClientAuth_Id" "CodeSigning_Id" "EmailProtection_Id" "IPSecEndSystem_Id" "IPSecTunnel_Id" "IPSecUser_Id" "TimeStamping_Id"
iaFile - initial authorisation file containing initial reference number and passphrase on consecutive lines
revoPwd - password to be used when revoking this certificate after it has been signed
dn - domain name for certificate request. For example, String dn="o=IBM,c=US". If null, value of PkEeFactory CA_DN will be used.
keyPair - keyPair to use for Public/Private Key
Throws:
com.ibm.security.certclient.base.PkException - Parameter error

newCertRequest

  1. @Deprecated
  2. public static PkEeCertReqTransaction newCertRequest( String subject,
  3. String iaFile,
  4. String revoPwd,
  5. String dn)
  6. throws com.ibm.security.certclient.base.PkException
Deprecated.
Initialises a certificate request to the supplied CA. The request is ready to action but will have the following default values keySize = 1024 numValidDays = 365 keyType = RSA SubjectKeyId algorithm is RFC 3280 Long Form SubjectAlternateNames = none KeyUsage = none ExtendedKeyUsage = none
Parameters:
subject - The Relative DN for the subject. It will be prepended to the value of parameter dn to create the subject DN. For example, String subject="cn=Test Group".
iaFile - initial authorisation file containing reference number and passphrase on consecutive lines
revoPwd - password to be used when revoking this certificate after it has been signed
dn - domain name for certificate request. For example, String dn="o=IBM,c=US". If null, value of PkEeFactory CA_DN will be used.
Throws:
com.ibm.security.certclient.base.PkException - Parameter error