E
orapki Utility

The orapki utility is provided to manage public key infrastructure (PKI) elements, such as wallets and certificate revocation lists, on the command line so the tasks it performs can be incorporated into scripts. Providing a way to incorporate the management of PKI elements into scripts makes it possible to automate many of the routine tasks of maintaining a PKI.

The following topics are included in this appendix:

• orapki Utility Overview
• Creating Signed Certificates for Testing Purposes
• Managing Oracle Wallets with orapki Utility
• Managing Certificate Revocation Lists (CRLs) with orapki Utility
• orapki Utility Commands Summary

orapki Utility Overview

This command line utility can be used to perform the following tasks:

• Creating and viewing signed certificates for testing purposes
• Manage Oracle wallets:
  • Create and display Oracle wallets
  • Add and remove certificate requests
  • Add and remove certificates
  • Add and remove trusted certificates
• Manage certificate revocation lists (CRLs):
  • Renaming CRLs with a hash value for certificate validation
  • Uploading, listing, viewing, and deleting CRLs in Oracle Internet Directory

orapki Utility Syntax

The basic syntax of the orapki command line utility is as follows:

orapki module command -parameter <value>

where module can be wallet (Oracle wallet), crl (certificate revocation list), or cert (PKI digital certificate). The available commands depend on the module you are using. For example, if you are working with a wallet, then you can add a certificate or a key to the wallet with the add command. The following example adds the user certificate located at /private/lhale/cert.txt to the wallet located at $ORACLE_HOME/wallet/ewallet.p12:

orapki wallet add -wallet $ORACLE_HOME/wallet/ewallet.p12 -user_cert -cert 
/private/lhale/cert.txt

Creating Signed Certificates for Testing Purposes

This command line utility provides a convenient, lightweight way to create signed certificates for testing purposes. The following syntax can be used to create signed certificates and to view certificates:

To create a signed certificate for testing purposes:

orapki cert create [-wallet <wallet_location>] -request <certificate_request_
location> -cert <certificate_location> -validity <number_of_days> [-summary]

This command creates a signed certificate from the certificate request. The -wallet parameter specifies the wallet containing the user certificate and private key that will be used to sign the certificate request. The -validity parameter specifies the number of days, starting from the current date, that this certificate will be valid. Specifying a certificate and certificate request is mandatory for this command.

To view a certificate:

orapki cert display -cert <certificate_location> [-summary | -complete]

This command enables you to view a test certificate that you have created with orapki. You can choose either -summary or -complete, which determines how much detail the command will display. If you choose -summary, the command will display the certificate and its expiration date. If you choose -complete, it will display additional certificate information, including the serial number and public key.

Managing Oracle Wallets with orapki Utility

The following sections describe the syntax used to create and manage Oracle wallets with the orapki command line utility. You can use these orapki utility wallet module commands in scripts to automate the wallet creation process.

• Creating and Viewing Oracle Wallets with orapki
• Adding Certificates and Certificate Requests to Oracle Wallets with orapki
• Exporting Certificates and Certificate Requests from Oracle Wallets with orapki

  Note: The -wallet parameter is manadatory for all wallet module commands.

Creating and Viewing Oracle Wallets with orapki

To create an Oracle wallet:

orapki wallet create -wallet <wallet_location>

This command will prompt you to enter and re-enter a wallet password. It creates a wallet in the location specified for -wallet.

To create an Oracle wallet with auto login enabled:

orapki wallet create -wallet <wallet_location> -auto_login

This command creates a wallet with auto login enabled, or it can also be used to enable auto login on an existing wallet. If the wallet_location already contains a wallet, then auto login will be enabled for it. To turn the auto login feature off, use Oracle Wallet Manager. See "Using Auto Login" for details.

To view an Oracle wallet:

orapki wallet display -wallet <wallet_location>

Displays the certificate requests, user certificates, and trusted certificates contained in the wallet.

Adding Certificates and Certificate Requests to Oracle Wallets with orapki

To add a certificate request to an Oracle wallet:

orapki wallet add -wallet <wallet_location> -dn <user_dn> -keySize 
<512|1024|2048>

This command adds a certificate request to a wallet for the user with the specified distinguished name (user_dn). The request also specifies the requested certificate's key size (512, 1024, or 2048 bits). To sign the request, export it with the export option. See "Exporting Certificates and Certificate Requests from Oracle Wallets with orapki"

To add a trusted certificate to an Oracle wallet:

orapki wallet add -wallet <wallet_location> -trusted_cert -cert <certificate_
location>

This command adds a trusted certificate, at the specified location (-cert <certificate_location>), to a wallet. You must add all trusted certificates in the certificate chain of a user certificate before adding a user certificate, or the command to add the user certificate will fail.

To add a root certificate to an Oracle wallet

orapki wallet add -wallet <wallet_location> -dn <certificate_dn> -keySize 
<512|1024|2048> -self_signed -validity <number_of_days>

This command creates a new self-signed (root) certificate and adds it to the wallet. The -validity parameter (mandatory) specifies the number of days, starting from the current date, that this certificate will be valid. You can specify a key size for this root certificate (-keySize) of 512, 1024, or 2048 bits.

To add a user certificate to an Oracle wallet:

orapki wallet add -wallet <wallet_location> -user_cert -cert <certificate_
location>

This command adds the user certificate at the location specified with the -cert parameter to the Oracle wallet at the <wallet_location>. Before you add a user certificate to a wallet, you must add all the trusted certificates that make up the certificate chain. If all trusted certificates are not installed in the wallet before you add the user certificate, then adding the user certificate will fail.

Exporting Certificates and Certificate Requests from Oracle Wallets with orapki

To export a certificate from an Oracle wallet:

orapki wallet export -wallet <wallet_location> -dn <certificate_dn> -cert 
<certificate_filename>

This command exports a certificate with the subject's distinguished name (-dn) from a wallet to a file that is specified by -cert.

To export a certificate request from an Oracle wallet:

orapki wallet export -wallet <wallet_location> -dn <certificate_request_dn> 
-request <certificate_request_filename>

This command exports a certificate request with the subject's distinguished name (-dn) from a wallet to a file that is specified by -request.

Managing Certificate Revocation Lists (CRLs) with orapki Utility

CRLs must be managed with orapki. This utility creates a hashed value of the CRL issuer's name to identify the CRLs location in your system. If you do not use orapki, your Oracle server cannot locate CRLs to validate PKI digital certificates. For detailed information about using orapki to manage CRLs refer to "Certificate Revocation List Management".

orapki Utility Commands Summary

This section lists and describes the following orapki commands:

• orapki cert create
• orapki cert display
• orapki crl delete
• orapki crl display
• orapki crl hash
• orapki crl list
• orapki crl upload
• orapki wallet add
• orapki wallet create
• orapki wallet display
• orapki wallet export

orapki cert create

Purpose

Use this command to create a signed certificate for testing purposes.

Syntax

orapki cert create [-wallet <wallet_location>] -request <certificate_request_
location> -cert <certificate_location> -validity <number_of_days> [-summary]

• The -wallet parameter specifies the wallet containing the user certificate and private key that will be used to sign the certificate request.
• The -request parameter (mandatory) specifies the location of the certificate request for the certificate you are creating.
• The -cert parameter (mandatory) specifies the directory location where the tool places the new signed certificate.
• The -validity parameter (mandatory) specifies the number of days, starting from the current date, that this certificate will be valid.

orapki cert display

Purpose

Use this command to display details of a specific certificate.

Syntax

orapki cert display -cert <certificate_location> [-summary|-complete]

• The -cert parameter specifies the location of the certificate you want to display.
• You can use either the -summary or the -complete parameter to display the following information:
  • -summary displays the certificate and its expiration date
  • -complete displays additional certificate information, including the serial number and public key

orapki crl delete

Purpose

Use this command to delete CRLs from Oracle Internet Directory. Note that the user who deletes CRLs from the directory by using orapki must be a member of the CRLAdmins (cn=CRLAdmins,cn=groups,%s_OracleContextDN%) directory group.

Prerequisites

None

Syntax

orapki crl delete -issuer <issuer_name> -ldap <hostname:ssl_port> -user 
<username> [-wallet <wallet_location>] [-summary]

• The -issuer parameter specifies the name of the certificate authority (CA) who issued the CRL.
• The -ldap parameter specifies the hostname and SSL port for the directory where the CRLs are to be deleted. Note that this must be a directory SSL port with no authentication. See "Uploading CRLs to Oracle Internet Directory" for more information about this port.
• The -user parameter specifies the username of the directory user who has permission to delete CRLs from the CRL subtree in the directory.
• The -wallet parameter (optional) specifies the location of the wallet that contains the certificate of the certificate authority (CA) who issued the CRL. Using it causes the tool to verify the validity of the CRL against the CA's certificate prior to deleting it from the directory.
• The -summary parameter is optional. Using it causes the tool to print the CRL LDAP entry that was deleted.

orapki crl display

Purpose

Use this command to display specific CRLs that are stored in Oracle Internet Directory.

Syntax

orapki crl display -crl <crl_location> [-wallet <wallet_location>] 
[-summary|-complete]

• The -crl parameter specifies the location of the CRL in the directory. It is convenient to paste the CRL location from the list that displays when you use the orapki crl list command. See "orapki crl list"
• The -wallet parameter (optional) specifies the location of the wallet that contains the certificate of the certificate authority (CA) who issued the CRL. Using it causes the tool to verify the validity of the CRL against the CA's certificate prior to displaying it.
• Choosing either the -summary or the -complete parameters displays the following information:
  • -summary provides a listing that contains the CRL issuer's name and the CRL's validity period
  • -complete provides a list of all revoked certificates that the CRL contains. Note that this option may take a long time to display, depending on the size of the CRL.

orapki crl hash

Purpose

Use this command to generate a hash value of the certificate revocation list (CRL) issuer to identify the location of the CRL in your file system for certificate validation.

Syntax

orapki crl hash -crl <crl_filename|URL> [-wallet <wallet_location>] 
[-symlink|-copy] <crl_directory> [-summary]

• The -crl parameter specifies the filename that contains the CRL or the URL where it can be found.
• The -wallet parameter (optional) specifies the location of the wallet that contains the certificate of the certificate authority (CA) who issued the CRL. Using it causes the tool to verify the validity of the CRL against the CA's certificate prior to uploading it to the directory.
• Depending on your operating system, use either the -symlink or the -copy parameter:
  • (UNIX) use -symlink to create a symbolic link to the CRL at the <crl_directory> location
  • (Windows) use -copy to create a copy of the CRL at the <crl_directory> location
• The -summary parameter (optional) causes the tool to display the CRL issuer's name.

orapki crl list

Purpose

Use this command to display a list of CRLs stored in Oracle Internet Directory. This is useful for browsing to locate a particular CRL to view or download to your local file system.

Syntax

orapki crl list -ldap <hostname:ssl_port>

The -ldap parameter specifies the hostname and SSL port for the directory server from where you want to list CRLs. Note that this must be a directory SSL port with no authentication. See "Uploading CRLs to Oracle Internet Directory" for more information about this port.

orapki crl upload

Purpose

Use this command to upload certificate revocation lists (CRLs) to the CRL subtree in Oracle Internet Directory. Note that you must be a member of the directory administrative group CRLAdmins (cn=CRLAdmins,cn=groups,%s_OracleContextDN%) to upload CRLs to the directory.

Syntax

orapki crl upload -crl <crl_location> -ldap <hostname:ssl_port> -user <username> 
[-wallet <wallet_location>] [-summary]

• The -crl parameter specifies the directory location or the URL where the CRL is located that you are uploading to the directory.
• The -ldap parameter specifies the hostname and SSL port for the directory where you are uploading the CRLs. Note that this must be a directory SSL port with no authentication. See "Uploading CRLs to Oracle Internet Directory" for more information about this port.
• The -user parameter specifies the username of the directory user who has permission to add CRLs to the CRL subtree in the directory.
• The -wallet parameter specifies the location of the wallet that contains the certificate of the certificate authority (CA) who issued the CRL. This is an optional parameter. Using it causes the tool to verify the validity of the CRL against the CA's certificate prior to uploading it to the directory.
• The -summary parameter is also optional. Using it causes the tool to display the CRL issuer's name and the LDAP entry where the CRL is stored in the directory.

orapki wallet add

Purpose

Use this command to add certificate requests and certificates to an Oracle wallet.

Syntax

To add certificate requests:

orapki wallet add -wallet <wallet_location> -dn <user_dn> -keySize 
<512|1024|2048>

• The -wallet parameter specifies the location of the wallet to which you want to add a certificate request.
• The -dn parameter specifies the distinguished name of the certificate owner.
• The -keySize parameter specifies the key size for the certificate.
• To sign the request, export it with the export option. See "orapki wallet export"

To add trusted certificates:

orapki wallet add -wallet <wallet_location> -trusted_cert -cert <certificate_
location>

• The -trusted_cert parameter causes the tool to add the trusted certificate, at the location specified with -cert, to the wallet.

To add root certificates:

orapki wallet add -wallet <wallet_location> -dn <certificate_dn> -keySize 
<512|1024|2048> -self_signed -validity <number_of_days>

• The -self_signed parameter causes the tool to create a root certificate.
• The -validity parameter is mandatory. Use it to specify the number of days, starting from the current date, that this root certificate will be valid.

To add user certificates:

orapki wallet add -wallet <wallet_location> -user_cert -cert <certificate_
location>

• The -user_cert parameter causes the tool to add the user certificate at the location specified with the -cert parameter to the wallet. Before you add a user certificate to a wallet, you must add all the trusted certificates that make up the certificate chain. If all trusted certificates are not installed in the wallet before you add the user certificate, then adding the user certificate will fail.

orapki wallet create

Purpose

Use this command to create an Oracle wallet or to set auto login on for an Oracle wallet.

Syntax

orapki wallet create -wallet <wallet_location> [-auto_login]

• The -wallet parameter specifies a location for the new wallet or the location of the wallet for which you want to turn on auto login.
• The -auto_login parameter creates an auto login wallet, or it turns on automatic login for the wallet specified with the -wallet option. See "Using Auto Login" for details about auto login wallets.

orapki wallet display

Purpose

Use this command to view the certificate requests, user certificates, and trusted certificates in an Oracle wallet.

Syntax

orapki wallet display -wallet <wallet_location>

• The -wallet parameter specifies a location for the wallet you want to open if it is not located in the current working directory.

orapki wallet export

Purpose

Use this command to export certificate requests and certificates from an Oracle wallet.

Syntax

To export a certificate from an Oracle wallet:

orapki wallet export -wallet <wallet_location> -dn <certificate_dn> -cert 
<certificate_filename>

• The -wallet parameter specifies the location of the wallet from which you want to export the certificate.
• The -dn parameter specifies the distinguished name of the certificate.
• The -cert parameter specifies the name of the file that contains the exported certificate.

To export a certificate request from an Oracle wallet:

orapki wallet export -wallet <wallet_location> -dn <certificate_request_dn> 
-request <certificate_request_filename>

• The -request parameter specifies the name of the file that contains the exported certificate request.