Kerberos is a trusted third-party authentication system. It relies on shared secrets and presumes that the third party is secure. Kerberos provides single sign-on capabilities, centralized password storage, database link authentication, and enhanced PC security. You can configure Oracle Database to use Kerberos authentication.
Topics:
Configuring Interoperability with a Windows 2008 Domain Controller KDC
Troubleshooting the Oracle Kerberos Authentication Configuration
See Also:
Oracle Database Enterprise User Security Administrator's Guide for information on migrating Kerberos users to Kerberos-authenticated enterprise usersTo enable Kerberos authentication for Oracle Database, you must first install it, and then follow a set of configuration steps.
Step 2: Configure a Service Principal for an Oracle Database Server
Step 4: Install an Oracle Database Server and an Oracle Client
You should install Kerberos Version 5. The source distribution for notes about building and installing Kerberos provide details. After you install Kerberos, if you are using IBM AIX on POWER systems (64-bit), you should ensure that Kerboros 5 is the preferred authentication method.
Install Kerberos on the system that functions as the authentication server.
Note:
After upgrading from a 32-bit version of Oracle Database, the first use of the Kerberos authentication adapter causes an error message:ORA-01637: Packet receive failed
.
Workaround: After upgrading to the 64-bit version of the database and before using Kerberos external authentication method, check for a file named /usr/tmp/oracle_service_name.RC
on your computer, and remove it.
For IBM AIX on POWER systems (64-bit), check the authentication method.
For example:
/usr/bin/lsauthent
Output similar to the following may appear:
Standard Aix
Configure Kerberos 5 as the preferred method.
For example:
/usr/bin/chauthent -k5 -std
This command sets Kerberos 5 as the preferred authentication method (k5
) and Standard AIX as the second (std
).
To ensure that Kerberos 5 is now the preferred method, check the new configuration.
/usr/bin/lsauthent Kerberos 5 Standard Aix
To enable the Oracle database server to validate the identity of clients that authenticate themselves using Kerberos, you must create a service principal for Oracle Database.
Decide on a name for the service principal, using the following format:
kservice/kinstance@REALM
Each of the fields in the service principal specify the following values:
The utility names in this section are executable programs. However, the Kerberos user name krbuser
and the realm EXAMPLE.COM
are examples only.
For example, suppose kservice
is oracle
, the fully qualified name of the system on which Oracle Database is running is dbserver.example.com
and the realm is EXAMPLE.COM
. The principal name then is:
oracle/dbserver.example.com@EXAMPLE.COM
Run kadmin.local
to create the service principal. On UNIX, run this command as the root user, by using the following syntax:
# cd /kerberos-install-directory/sbin # ./kadmin.local
For example, to add a principal named oracle/dbserver.example.com@EXAMPLE.COM
to the list of server principals known by Kerberos, you can enter the following:
kadmin.local:addprinc -randkey oracle/dbserver.example.com@EXAMPLE.COM
Next, you are ready to extract the service key table from Kerberos and copy it to the Oracle database server/Kerberos client system.
For example, to extract a service key table for dbserver.example.com
:
Enter the following to extract the service key table:
kadmin.local: ktadd -k /tmp/keytab oracle/dbserver.example.com Entry for principal oracle/dbserver.example.com with kvno 2, encryption type AES-256 CTS mode with 96-bit SHA-1 HMAC added to keytab WRFILE: WRFILE:/tmp/keytab kadmin.local: exit
To check the service key table, enter the following command:
oklist -k -t /tmp/keytab
After the service key table has been extracted, verify that the new entries are in the table in addition to the old ones.
If they are not, or you need to add more, use kadmin.local
to append to them.
If you do not enter a realm when using ktadd
, it uses the default realm of the Kerberos server. kadmin.local
is connected to the Kerberos server running on the localhost
.
If the Kerberos service key table is on the same system as the Kerberos client, you can move it. If the service key table is on a different system from the Kerberos client, you must transfer the file with a program such as FTP. If using FTP, transfer the file in binary mode.
The following example shows how to move the service key table on a UNIX platform:
# mv /tmp/keytab /etc/v5srvtab
The default name of the service file is /etc/v5srvtab
.
Verify that the owner of the Oracle database server executable can read the service key table (/etc/v5srvtab
in the previous example).
To do so, set the file owner to the Oracle user, or make the file readable by the group to which Oracle belongs.
Caution:
Do not make the file readable to all users. This can cause a security breach.
After you extract a service key table from Kerberos, you are ready to install the Oracle Database server and an Oracle client.
See the Oracle Database operating system-specific installation documentation for instructions on installing the Oracle database server and client software.
After you install the Oracle Database server and client, you are ready to configure Oracle Net Services on the server and client.
See the following documentation for information on configuring Oracle Net Services on the Oracle database server and client.
Oracle Database operating system-specific installation documentation
You must set the required parameters in the Oracle database server and client sqlnet.ora
files. Be aware that in a multitenant environment, the settings in the sqlnet.ora
file apply to all pluggable databases (PDBs).
First, configure Kerberos authentication service parameters on the client and on the database server.
Start Oracle Net Manager.
(UNIX) From $ORACLE_HOME
/bin
, enter the following command at the command line:
netmgr
(Windows) Select Start, Programs, Oracle - HOME_NAME, Configuration and Migration Tools, then Net Manager.
Expand Oracle Net Configuration, and from Local, select Profile.
From the Naming list, select Network Security.
The Network Security tabbed window appears.
Select the Authentication tab.
From the Available Methods list, select KERBEROS5.
Move KERBEROS5 to the Selected Methods list by clicking the right arrow (>).
Arrange the selected methods in order of use.
To do so, select a method in the Selected Methods list, then click Promote or Demote to position it in the list. For example, if you want KERBEROS5
to be the first service used, move it to the top of the list.
Select the Other Params tab.
From the Authentication Service list, select KERBEROS(V5).
Type Kerberos into the Service field.
This field defines the name of the service Oracle Database uses to obtain a Kerberos service ticket. When you provide the value for this field, the other fields are enabled.
Optionally enter values for the following fields:
Credential Cache File
Configuration File
Realm Translation File
Key Table
Clock Skew
See the Oracle Net Manager online Help, and "Step 6C: Set sqlnet.ora Parameters (Optional)", for more information about the fields and the parameters they configure.
From the File menu, select Save Network Configuration.
The sqlnet.ora
file is updated with the following entries in addition to any optional choices that you may have made in the previous step:
SQLNET.AUTHENTICATION_SERVICES=(KERBEROS5) SQLNET.AUTHENTICATION_KERBEROS5_SERVICE=kservice
Next, you are ready to set the OS_AUTHENT_PREFIX
initialization parameter.
Locate the init.ora
file.
By default, the init.ora
file is located in the ORACLE_HOME
/dbs
directory (or the same location of the data files) on Linux and UNIX systems, and in the ORACLE_HOME
\database
directory on Windows.
In the init.ora
file, set the value of OS_AUTHENT_PREFIX
to null in the init.ora
initialization parameter file.
For example:
OS_AUTHENT_PREFIX=""
Set this value to null because Kerberos user names can be long, and Oracle user names are limited to 30 characters. Setting this parameter to null overrides the default value of OPS$
.
Note:
You can create external database users that have Kerberos user names of more than 30 characters. See "Step 8: Create an Externally Authenticated Oracle User" for more information.Table 17-1 lists optional parameters that you can set, in addition to the required parameters, in the sqlnet.ora
file on the client and the Oracle database server.
Table 17-1 Kerberos-Specific sqlnet.ora Parameters
To create Oracle users that Kerberos can authenticate, perform this task on the Kerberos authentication server where the administration tools are installed. The realm must already exist.
Note:
The utility names in this section are executable programs. However, the Kerberos user namekrbuser
and realm EXAMPLE.COM
are examples only. They can vary among systems.Run /krb5/admin/kadmin.local
as root to create a new Kerberos user, such as krbuser
.
For example, to create a Kerberos user is UNIX-specific:
# /krb5/admin/kadmin.local kadmin.local: addprinc krbuser Enter password for principal: "krbuser@example.com": (password does not display) Re-enter password for principal: "krbuser@example.com": (password does not display) kadmin.local: exit
Next, you are ready to create an externally authenticated Oracle user.
Log in to SQL*Plus as a user who has the CREATE USER
privilege.
sqlplus sec_admin -- Or, CONNECT sec_admin@hrpdb Enter password: password
Ensure that the OS_AUTHENT_PREFIX
is set to null (""
).
Create an Oracle Database user account that corresponds to the Kerberos user. Enter the Oracle user name in uppercase and enclose it in double quotation marks.
For example:
CREATE USER "KRBUSER@EXAMPLE.COM" IDENTIFIED EXTERNALLY; GRANT CREATE SESSION TO "KRBUSER@EXAMPLE.COM";
If the user's Kerberos principal name is longer than 30 characters, and up to 1024 characters, then create the user by using the following syntax:
CREATE USER db_user_name IDENTIFIED EXTERNALLY AS 'kerberos_principal_name';
For example:
CREATE USER KRBUSER IDENTIFIED EXTERNALLY AS 'KerberosUser@example.com';
Note:
The database administrator should ensure that two database users are not identified externally by the same Kerberos principal name.Before you can connect to the database, you must ask the Key Distribution Center (KDC) for an initial ticket.
To request an initial ticket, run the following command on the client:
% okinit username
If you want to enable credentials that can be used across database links, then include the -f
option and provide the Kerberos password when prompted.
% okinit -f Password for krbuser@EXAMPLE.COM:(password does not display)
Three utilities are shipped with the Oracle Kerberos authentication adapter. These utilities are intended for use on an Oracle client with Oracle Kerberos authentication support installed. Use the following utilities for these specified tasks:
The okinit
utility obtains and caches Kerberos tickets. This utility is typically used to obtain the ticket-granting ticket, using a password entered by the user to decrypt the credential from the key distribution center (KDC). The ticket-granting ticket is then stored in the user's credential cache.
Table 17-2 lists the options available with okinit
.
Table 17-2 Options for the okinit Utility
Option | Description |
---|---|
|
Ask for a forwardable ticket-granting ticket. This option is necessary to follow database links. |
|
Specify the lifetime of the ticket-granting ticket and all subsequent tickets. By default, the ticket-granting ticket is good for eight (8) hours, but shorter or longer-lived credentials may be desired. Note that the KDC can ignore this option or put site-configured limits on what can be specified. The lifetime value is a string that consists of a number qualified by okinit -l 2wld6h20m30s The example requests a ticket-granting ticket that has a life time of 2 weeks, 1 day, 6 hours, 20 minutes, and 30 seconds. |
|
Specify an alternative credential cache. For UNIX, the default is |
|
Specifies a number representing the Kerberos encryption type to use. This option can be used to request a particular Kerberos encryption type key for the session. If you specify more than one encryption type, then the KDC chooses the common and strongest encryption type from the list. The following values are allowed:
The following example requests for the okinit -e 1 -e 16 krbuser@REALM Note that you can repeat the option to request multiple encryption types. |
|
List command line options. |
You can run the oklist
utility to display the list of tickets held.
Table 17-3 lists the available oklist
options.
Table 17-3 Options for the oklist Utility
Option | Description |
---|---|
|
Show flags with credentials. Relevant flags are:
|
|
Specify an alternative credential cache. In UNIX, the default is |
|
List the entries in the service table (default |
The show flag option (-f
) displays additional information, as shown in the following example:
% oklist -f 27-Jul-1999 21:57:51 28-Jul-1999 05:58:14 krbtgt/EXAMPLE.COM@EXAMPLE.COM Flags: FI
You can remove credentials from the cache file.
Use the okdstry
utility to remove credentials from the credentials cache file:
$ okdstry -c
where the -c
command option lets you specify an alternative credential cache. For UNIX, the default is /tmp/krb5cc_
uid
. You can also specify the alternate credential cache by using the SQLNET.KERBEROS5_CC_NAME
parameter in the sqlnet.ora
file.
You can now connect to an Oracle database server without using a user name or password.
Use the following syntax to connect to the database without using a user name or password:
$ sqlplus /@net_service_name
where net_service_name
is an Oracle Net Services service name. For example:
$ sqlplus /@oracle_dbname
See Also:
Oracle Database Heterogeneous Connectivity User's Guide for information about external authenticationOracle Database, which complies with MIT Kerberos, can interoperate with tickets that are issued by a Kerberos Key Distribution Center (KDC) on a Windows 2008 domain controller to enable Kerberos authentication with an Oracle database. To configure Kerberos authentication that uses a Windows 2008 domain controller KDC, perform the following tasks:
Step 1: Configure Oracle Kerberos Client for a Windows 2008 Domain Controller KDC
Step 2: Configure a Windows 2008 Domain Controller KDC for the Oracle Client
Step 3: Configure Oracle Database for a Windows 2008 Domain Controller KDC
Step 4: Obtain an Initial Ticket for the Kerberos/Oracle User
You must perform the following steps to configure an Oracle Kerbero Client to interoperate with a Microsoft Windows 2008 Domain Controller KDS. Perform these steps on the Oracle Kerberos client.
Topics:
You must create a set of client Kerberos configuration files that refer to the Windows 2008 domain controller as the Kerberos KDC.
Create the krb.conf
, krb5.conf
, and krb5.realms
files.
For example, assuming that the Windows 2008 domain controller is running on a node named sales3854.us.example.com
:
krb.conf
file
For example:
SALES3854.US.EXAMPLE.COM SALES3854.US.EXAMPLE.COM sales3854.us.example.com admin server
krb5.conf
file
For example:
[libdefaults] default_realm=SALES.US.EXAMPLE.COM [realms] SALES.US.EXAMPLE.COM= { kdc=sales3854.us.example.com:88 } [domain_realm] .us.example.com=SALES.US.EXAMPLE.COM
krb5.realms
file
For example:
us.example.com SALES.US.EXAMPLE.COM
Configuring an Oracle client to interoperate with a Windows 2008 domain controller KDC uses the same sqlnet.ora
file parameters that are listed in "Step 6A: Configure Kerberos on the Client and on the Database Server".
Set the following parameters in the sqlnet.ora
file on the client:
SQLNET.KERBEROS5_CONF=pathname_to_Kerberos_configuration_file SQLNET.KERBEROS5_CONF_MIT=TRUE SQLNET.AUTHENTICATION_KERBEROS5_SERVICE=Kerberos_service_name SQLNET.AUTHENTICATION_SERVICES=(BEQ,KERBEROS5)
Note:
Ensure that theSQLNET.KERBEROS5_CONF_MIT
parameter is set to TRUE
because the Windows 2008 operating system is designed to interoperate only with security services that are based on MIT Kerberos version 5.The Windows 2008 domain controller KDC listens on UDP/TCP port 88.
Ensure that the system file entry for kerberos5
is set to UDP/TCP port 88.
For the UNIX environment, ensure that the first kerberos5
entry in the /etc/services
file is set to 88.
Next, you are ready to configure a Microsoft Windows 2008 Domain Controller KDC to interoperate with an Oracle Client. You must perform these steps on the Windows 2008 domain controller.
Topics:
See Also:
Microsoft documentation for information about how to create users in Active Directory.You must create a user account for the Microsoft Windows 2008 Domain Controller KDC.
Create a new user account for the Oracle client in Microsoft Active Directory.
After you create the user account, you are ready to create the Oracle Database principal user account.
Create a new user account for the Oracle database in Microsoft Active Directory.
For example, if the Oracle database runs on the host sales3854.us.example.com
, then use Active Directory to create a user with the user name sales3854.us.example.com
and the password oracle
.
Do not create a user as host/hostname.dns.com
, such as oracle/sales3854.us.example.com
, in Active Directory. Microsoft's KDC does not support multipart names like an MIT KDC does. An MIT KDC allows multipart names to be used for service principals because it treats all principals as user names. However, Microsoft's KDC does not.
Use the Ktpass
command line utility to extract the keytab
file with the following syntax:
Ktpass -princ service/hostname@NT-DNS-REALM-NAME -mapuser account -pass password -out keytab.file
Using the database user created in the previous step, the following is an example of Ktpass
usage:
C:> Ktpass -princ oracle/sales3854.us.example.com@SALES.US.COM -mapuser sales3854 -pass oracle -out C:\temp\v5srvtab
This utility is part of the Windows 2008 Support Tools and can be found on the Windows 2008 distribution media in the \support\reskit\netmgmt\security
folder.
Copy the extracted keytab
file to the host computer where the Oracle database is installed.
For example, the keytab
that was created in the previous step can be copied to /krb5/v5svrtab
.
See Also:
Detailed information about Windows 2008 interoperability with Kerberos 5 that is available at the following URL:http://technet.microsoft.com/hi-in/windowsserver/2000/bb735396(en-us).aspx
You must configure the Oracle database for the domain controller on the host computer where the Oracle database is installed.
Topics:
You must first set configuration parameters for the database.
Specify values for the following parameters in the sqlnet.ora
file for the database server:
SQLNET.KERBEROS5_CONF=pathname_to_Kerberos_configuration_file SQLNET.KERBEROS5_KEYTAB=pathname_to_Kerberos_principal/key_table SQLNET.KERBEROS5_CONF_MIT=TRUE SQLNET.AUTHENTICATION_KERBEROS5_SERVICE=Kerberos_service_name SQLNET.AUTHENTICATION_SERVICES=(BEQ,KERBEROS5)
Note:
Ensure that the SQLNET.KERBEROS5_CONF_MIT
parameter is set to TRUE
because the Windows 2008 operating system is designed to interoperate only with security services that are based on MIT Kerberos version 5.
Be aware that in a multitenant environment, the settings in the sqlnet.ora
file apply to all PDBs.
After you set the configuration parameters, you are ready to create an externally authenticated Oracle user.
Follow the procedure under "Step 8: Create an Externally Authenticated Oracle User" to create an externally authenticated Oracle user.
Ensure that you create the username in all uppercase characters (for example, ORAKRB@SALES.US.EXAMPLE.COM
).
See Also:
"Step 6: Configure Kerberos Authentication" for information about using Oracle Net Manager to set thesqlnet.ora
file parameters.Before a client can connect to the database, the client must request an initial ticket.
To request an initial ticket, follow the task information for "Step 9: Get an Initial Ticket for the Kerberos/Oracle User".
Note:
The user does not need to explicitly request for an initial ticket, using theokinit
command, when using the Windows native cache.
If the Oracle client is running on Microsoft Windows 2008 or later, the Kerberos ticket is automatically retrieved when the user logs in to Windows.
See Also:
Microsoft documentation for details on theKerbtray.exe
utility, which can be used to display Kerberos ticket information for a systemThis section provides some common configuration problems and explains how to resolve them.
If you cannot get your ticket-granting ticket using okinit
:
Ensure that the default realm is correct by examining the krb.conf
file.
Ensure that the KDC is running on the host specified for the realm.
Ensure that the KDC has an entry for the user principal and that the passwords match.
Ensure that the krb.conf
and krb.realms
files are readable by Oracle.
Ensure that the TNS_ADMIN
environment variable is pointing to the directory containing the sqlnet.ora
configuration file.
If you have an initial ticket but still cannot connect:
After trying to connect, check for a service ticket.
Check that the sqlnet.ora
file on the database server side has a service name that corresponds to a service known by Kerberos.
Check that the clocks on all systems involved are set to times that are within a few minutes of each other or change the SQLNET.KERBEROS5_CLOCKSKEW
parameter in the sqlnet.ora
file.
If you have a service ticket and you still cannot connect:
Check the clocks on the client and database server.
Check that the v5srvtab
file exists in the correct location and is readable by Oracle. Remember to set the sqlnet.ora
parameters.
Check that the v5srvtab
file has been generated for the service named in the sqlnet.ora
file on the database server side.
If everything seems to work fine, but then you issue another query and it fails:
Check that the initial ticket is forwardable. You must have obtained the initial ticket by running the okinit
utility.
Check the expiration date on the credentials. If the credentials have expired, then close the connection and run okinit
to get a new initial ticket.