Migrating RSA Keon CA with nCipher
The following describes how to migrate from another CA to EJBCA.
Introduction
In order to demonstrate specific steps and help you reproduce these steps, one specific CA was chosen, the RSA Keon CA. The general idea how to migrate is the same for other CA implementations.
Migration from another CA to EJBCA consists of the following steps:
- Migration of the CAs ́ signing keys on nCipher HSM, allowing the keys can be used by EJBCA 
- Import of the CA within EJBCA 
- Import of the user certificates in EJBCA 
The following outlines how to migrate a simple installation of KCA to EJBCA and it is recommended to first do a test migration to be familiar with the process.
Environments
Keon CA
A setup of KCA on a target environment:
- Windows Server 2003 
- KCA 6.5 
- One root CA – TestKCARootCA 
- One sub CA – TestKCASubCA 
- Signing keys for the CAs on nCipher nShield PCI card 
- 5 users issued by TestKCASubCA 
After the installation of this environment, make a backup of nCipher security world, CA- certificates and user certificates.
EJBCA
A target environment for EJBCA is chosen:
- Utuntu Linux 7.04 AMD64 
- JBoss 4.2.0, MySQL 5.0 
- EJBCA 3.5 or later; 3.9 recommended 
- One root CA – TestKCARootCA 
- One sub CA – TestKCASubCA 
- Signing keys for the CAs on nCipher nShield PCI kort 
- 5 users issued by TestKCASubCA 
Migration of KCA's ́Signing Keys
This example assumes that the Keon CA keys are used in a Thales/nCipher HSM. If another HSM is used, key migration is likely easier as PKCS#11 can be used immediately. Note however that it is still needed to generate a certificate object in the HSM for Java to use the keys.
Configure PKCS#11 for nCipher
For nCipher, the slot number is a virtual slot, with an unknown name. You can use the default slot by omitting giving the slot number. In order to use nCipher PKCS#11, certain parameters need to be set.
Create the file /opt/nfast/cknfastrc with the following content:
CKNFAST_LOADSHARING=1 CKNFAST_NO_ACCELERATOR_SLOTS=1 CKNFAST_NO_UNWRAP=1 CKNFAST_OVERRIDE_SECURITY_ASSURANCES=importSignature Keys
When KCA is installed, it generates keys on the nCipher HSM. The keys are in "native" format and can only be used by KCA. There is no public key associated on the HSM.
Start by listing some general information about the HSM:
C:\nfast\bin>enquiryServer:  enquiry reply flags  none  enquiry reply level  Six  serial number        B1BB-0EE9-3511  mode                 operational  version              2.23.6  speed index          440  rec. queue           422..622  level one flags      Hardware HasTokens  version string       2.23.6cam6, 2.22.43cam8 built on Oct 13 200616:16:12  checked in           00000000431dca98 Tue Sep 06 18:58:00 2005  level two flags      none  max. write size      8192  level three flags    KeyStorage  level four flags     OrderlyClearUnit HasRTC HasNVRAM HasNSOPermsCmdServerHasPollCmds FastPollSlotList HasSEE HasKLF HasShareACLHasFeatureEnable Ha sFileOp HasPCIPush HasKernelInterface HasLongJobsServerHasLongJobs AESModuleKeys NTokenCmds LongJobsPreferred  module type code     0  product name         nFast server  device name  EnquirySix version   4  impath kx groups  feature ctrl flags   none  features enabled     none  version serial       0Module #1:  enquiry reply flags  none  enquiry reply level  Six  serial number        B1BB-0EE9-3511  mode                 operational  version              2.22.43  speed index          440  rec. queue           19..152  level one flags      Hardware HasTokens  version string       2.22.43cam8 built on Oct 13 2006 16:16:12  checked in           00000000452f6a4d Fri Oct 13 12:28:29 2006  level two flags      none  max. write size      8192  level three flags    KeyStorage  level four flags     OrderlyClearUnit HasRTC HasNVRAM HasNSOPermsCmdServerHasPollCmds FastPollSlotList HasSEE HasKLF HasShareACLHasFeatureEnable Ha sFileOp HasPCIPush HasKernelInterface HasLongJobsServerHasLongJobs AESModuleKeys NTokenCmds LongJobsPreferred  module type code     7  product name         nC1003P/nC3023P  device name          #1 PCI bus 7 slot 1  EnquirySix version   5  impath kx groups     DHPrime1024  feature ctrl flags   LongTerm  features enabled     StandardKM  version serial       24  rec. LongJobs queue  18  SEE machine type     PowerPCSXFC:\nfast\bin>nfkminfo.exeWorld  generation  2  state       0x17270000 Initialised Usable Recovery !PINRecovery!ExistingClient RTC NVRAM FTO SEEDebug  n_modules   1  hknso       057731d6c635560900003fed89eba88c5082f2a1  hkm         b08e66b01777fcf34dceb77c0684c8d1a071144e (type DES3)  hkmwk       1d572201be533ebc89f30fdd8f3fac6ca3395bf0  hkre        b0f5dbebedc703c6acd7685b261f6748bc4a9535  hkra        7368a945efc76505a19092c5115f493716de3172  hkmc        1d1e3fb769837be06e028bc038d1789ced2ac9e1  hkrtc       55f17755cae9ae49a588f154260306deeae1f5cc  hknv        82674f0623407fbaac5a3aaa0fc08346dff34f37  hkdsee      6df83c268c25939c307f61245235a2ac44e487ae  hkfto       cae32a48bd1b9e68e606ae723f8dcb93eb4ee9ab  hkmnull     1d572201be533ebc89f30fdd8f3fac6ca3395bf0  ex.client   none  k-out-of-n  1/1  other quora m=1 r=1 nv=1 rtc=1 dsee=1 fto=1  createtime  2007-07-16 14:58:41  nso timeout 10 min Module #1  generation 2  state      0x2 Usable  flags      0x0 !ShareTarget  n_slots    2  esn        B1BB-0EE9-3511  hkml       5e43facc6aa39068092762d80a1954bded193b4bModule #1 Slot #0 IC 25  generation    1  phystype      SmartCard  slotlistflags 0x2 SupportsAuthentication  state         0x5 Operator  flags         0x10000 Passphrase  shareno       1  shares        LTU(PIN)  error         OKCardset  name          ”oper”  k-out-of-n    1/1  flags         NotPersistent PINRecoveryForbidden(disabled) !RemoteEnabled  timeout       none  card names    ””  hkltu         3126f2b3cf7d9d53e3ba278a081ef471644298f8  gentime       2007-07-16 15:00:07Module #1 Slot #1 IC 0  generation    1  phystype      SoftToken  slotlistflags 0x0  state         0x2 Empty  flags         0x0  shareno       0  shares  error         OKNo CardsetNo Pre-Loaded ObjectsTo view keys used, run the following command:
C:\nfast\bin>nfkminfo -kKey list - 19 keys AppName rsa-keon-ca-65       Ident 1184599865281000 AppName rsa-keon-ca-65       Ident 1184599867765000 AppName rsa-keon-ca-65       Ident 1184599888484000 AppName rsa-keon-ca-65       Ident 11845998900 AppName rsa-keon-ca-65       Ident 1184599947937000 AppName rsa-keon-ca-65       Ident 1184599969937000 AppName rsa-keon-ca-65       Ident 1184599971843000 AppName rsa-keon-ca-65       Ident 1184599974609000 AppName rsa-keon-ca-65       Ident 1184599977718000 AppName rsa-keon-ca-65       Ident 1184599980515000 AppName rsa-keon-ca-65       Ident 1184599982765000 AppName rsa-keon-ca-65       Ident 1184599985656000 AppName rsa-keon-ca-65       Ident 1184599987625000 AppName rsa-keon-ca-65       Ident 1184599989140000 AppName rsa-keon-ca-65       Ident 1184599991234000 AppName rsa-keon-ca-65       Ident 1184600151640000 AppName rsa-keon-ca-65       Ident 1184600153609000 AppName rsa-keon-ca-65       Ident 1184659106609000 AppName rsa-keon-ca-65       Ident 1184659187875000There are a number of keys, and we cannot immediately say which one is the CAs signing key. This can be determined according to the following example:
C:\nfast\bin>pubkey-find.exe c:\kca.pem input format cert nCore hash d0196ea2e070315e9e162c28dcdc5a524bf6380d unnamed appname rsa-keon-ca-65 ident 1184659106609000Then, add the corresponding public key:
C:\nfast\bin>pubkey-find.exe --augment c:\kca.pemNext, ”move” the key as to be usable by PKCS#11:
C:\nfast\bin>generatekey --retarget –no-verify pkcs1113:40:30 WARNING: nfgk_debug_output is now deprecated (see manual).from-application: Source application? (jcecsp, pkcs11, rsa-keon-ca-65)  [default jcecsp] > rsa-keon-ca-65from-ident: Source key identifier? (1184599865281000, 1184599867765000,                                    1184599888484000, 11845998900,                                    1184599947937000, 1184599969937000,                                    1184599971843000, 1184599974609000,                                    1184599977718000, 1184599980515000,                                    1184599982765000, 1184599985656000,                                    1184599987625000, 1184599989140000,                                    1184599991234000, 1184600151640000,                                    1184600153609000, 1184659106609000,                                    1184659187875000) [1184599865281000]> 1184659106609000plainname: Key name? [] >ERROR: plainname: key name unspecifiedplainname: Key name? [] > kcaSignkey generation parameters: operation         Operation to perform     retarget application       Application              pkcs11 slot              Slot to read cards from  0 verify            Verify security of key   no from-application  Source application       rsa-keon-ca-65 from-ident        Source key identifier    1184659106609000 plainname         Key name                 kcaSign***************************************************** WARNING: will not verify the security of the key *****************************************************Loading `oper’: Module 1: 0 cards of 1 read Module 1 slot 0: `oper’ #1 Module 1 slot 0:- passphrase supplied - reading cardCard reading complete.Key successfully retargetted.Path to key: c:\nfast\kmdata\local\key_pkcs11_uc3126f2b3cf7d9d53e3ba278a081ef471644298f8-628484d430c6c0502fdb1a520fb84b9dc73c8372To use the public key via PKCS#11, associate a certificate to the key. For this, we take the actual certificate:
C:\nfast\bin>ckcerttool.exe -c oper -f c:\ca\kca.pem -k uc3126f2b3cf7d9d53e3ba278a081ef471644298f8-628484d430c6c0502fdb1a520fb84b9dc73c8372 -L kcaSignCertificate found, processing...Please enter the passphrase for ”oper” token (No echo set).Passphrase:Certificate successfully imported.Run cklist to view your certificate object.OKNext, generate two more keys to be used by EJBCA. One of the keys will be used by EJBCA for internal encryption within EJBCA, and the other for testing of the HSM. This generation should be done as described in the EJBCA Operations Guide, using the regular EJBCA tools. Generate one RSA key of length 2048 bits with alias kcaDefault, and one RSA key of length 1024 with alias kcaTest:
keytool -generate -keystore NONE -storetype PKCS11-NFastJava -storepass foo123-alias kcaDefault -keyalg RSA -keysize 2048keytool -generate -keystore NONE -storetype PKCS11-NFastJava -storepass foo123-alias kcaTest -keyalg RSA -keysize 1024We use the EJBCA tools to get automatic association between the private key and a (dummy) certificate, in order for it to be used through the Java PKCS#11 provider.
Importing the CA
After doing retarget on the keys for the Root CA and the Sub CA, you can use the keys from EJBCA and start importing CA certificates into EJBCA.
Note that KCA does not use the same DN order as EJBCA does by default, so if you want the issued certificate to look exactly the same, clear the EJBCA option Use LDAP DN order after the installation.
Install EJBCA as usual with one ManagementCA, after which you can import the CAs from KCA from the help script.
bin/ejbca.sh ca importca TestKCARootCA --hard --cp org.cesecore.keys.token.PKCS11CryptoToken --ctpassword foo123 --prop rootca.properties --cert TestKCARootCA-chain.pemThe rootca.properties contains:
defaultKey rootDefaultcertSignKey rootSigncrlSignKey rootSigntestKey rootTestpin foo123sharedLibrary /opt/nfast/toolkits/pkcs11/libcknfast.soDo the same for the SubCA:
bin/ejbca.sh ca importca TestKCASubCA --hard --cp org.cesecore.keys.token.PKCS11CryptoToken --ctpassword foo123 --prop rootca.properties --cert TestKCASubCA-chain.pemThe subca.properties contains:
defaultKey subDefaultcertSignKey subSigncrlSignKey subSigntestKey subTestpin foo123sharedLibrary /opt/nfast/toolkits/pkcs11/libcknfast.soTestKCASubCA-chain.pem is created with:
cat TestKCASubCA.pem TestKCARootCA.pem > TestKCASubCA-chain.pemNow EJBCA has one Root CA and one Sub CA that use the same signing keys as KCA.
Importing User Certificates
In EJBCA, the following command imports user certificates:
bin/ejbca.sh ca importcert --username kca1 --password foo123 --caname TestKCASubCA -a ACTIVE -f user1.pemThe command does not import information about revocation. Full revocation information is possible to implement in a programmatic way.
You can write your own migration tool, speeding up the process by using the command line code as a template. It is found in modules/ejbca-ejb-cli/src/org/ejbca/ui/cli/ca/CaImportCertCommand.java.