Oracle Internet Directory Administrator's Guide
Release 2.0.6

A77230-01

Library

Product

Contents

Index

Prev Next

5
Managing an Oracle Directory Server

This chapter explains how to manage the Oracle Internet Directory processes using Oracle Directory Manager and command line tools.

See Also:

Chapter 3 for instructions on starting and stopping Oracle directory server instances 

The administration tasks are explained in the following sections:

Managing Server Configuration Set Entries

When you issue a start-server message through the OID Control Utility, that message refers to a configuration set entry containing server parameters. You can add, modify, and delete configuration set entries by using either Oracle Directory Manager or the appropriate command line tool.

See Also:

 

This section covers the following topics:

Preliminary Considerations

Although you can change values in the default configuration set, namely, configset0, all of your changes will be carried over to every new configuration set entry that you create. This is because configset0 values are used as the template for all new configuration set entries.

When you want to change values that should not always be in effect for every instance of the server that you run, it is better to create new configuration set entries. Note that, in Release 2.0.6, this applies to the LDAP server instances only. The Oracle Replication Directory Server supports only one configuration set in this release.

You may want to establish a separate instance of a directory server with different values. If you do not want those values to be exercised by all users, set up a new configuration set entry and run a separate server instance pointing to that configset for groups with special needs.

Figure 5-1 Directory Entry Hierarchy Showing Multiple Configuration Set Entries


For example, Figure 5-1 shows:

Managing Server Configuration Set Entries by Using Oracle Directory Manager

You can use Oracle Directory Manager to view, add, modify, and delete configuration set entries. These topics are covered in the following sections:

Viewing Configuration Set Entries

To view configuration set entries:

  1. In the navigator pane, expand an instance, then expand Server Management.

  2. Select Directory Server in the navigator pane.

    The parameters of the active instance appear in the right pane. You can see all of them by scrolling horizontally.


  3. Click an instance in the right pane. A Server Process dialog box appears:


You can see all the parameters for the instance by selecting the tabs across the top of the dialog box. However, you cannot change them in this dialog box. To change them, you must change the configuration set entry on which they are based.

See Also:

"Modifying Configuration Set Entries" 

Adding Configuration Set Entries

The first time you add a configuration set entry, you can use the default configuration set as a template, then copy from the ones you create to make subsequent configuration sets.

To add configuration set entries:

  1. In the navigator pane, expand Server Management > Directory Server or Replication Server. Select Default Configuration Set and, on the toolbar, click the Create Like button. The Configuration Sets dialog box displays the General tab:


  2. Fill in the fields with the information described in Table 5-1:

    Table 5-1 Adding a Configuration Set Entry: General Tab
    Field  Description 

    Max. Number of DB Connections 

    The number of concurrent database connections a single directory server process can have. The default is ten. 

    Number of Child Processes 

    The number of server processes a single instance can spawn. The default is one. 

    Set 

    The number of the configuration set entry. The default configuration set is 0. There can be as many different configuration sets as needed. The same configuration set can be used by more than one instance if the parameter needs of the multiple instances are the same. The set number is not modifiable. 

  3. Select the Debug Flags tab:


    Ordinarily, you can leave these radio buttons unselected. However, if you need to generate a log for a specific problem, you can use this tab page to specify the debug logging level.

  4. Select the SSL Settings tab:


    Fill in the fields with the information described in the following table:

    Table 5-2 Adding a Configuration Set Entry: SSL Settings Tab
    Field  Description 

    SSL Enable 

    Select to enable SSL authentication. If you do not select this check box, SSL is not enabled, and you do not need to set any other parameters on this page. 

    SSL Authentication 

    Choose one of the following:

    • No SSL Authentication--Neither the client nor the server authenticates itself to the other. No certificates are sent or exchanged. In this case, only SSL encryption/decryption is used.

    • SSL Client and Server Authentication--Both client and server authenticate themselves to each other. Both the client and server send certificates to each other.

    • SSL Server Authentication--Only the directory server authenticates itself to the client. The directory server sends the client a certificate verifying that the server is authentic.

     

    SSL Wallet URL 

    Enter the location of the SSL wallet. If you elect to change the location of the Oracle wallet, you must change this parameter. You must set the wallet location on both the client and the server. For example, on Solaris, you could set this parameter as follows:

    orclsslwalleturl=file:/Home/my_dir/my_wallet

    On Windows NT, you could set this parameter as follows:

    file:C:\my_dir\my_wallet
    

    For information on setting the location of the Oracle Wallet and the Oracle Wallet password, see Appendix D

    SSL Wallet Password 

    Enter the password for the wallet. This password was set during creation of the wallet. See "Creating a New Wallet". If you change the password, you must change this parameter. 

    SSL Wallet Confirm Password 

    Retype the new password in this field when you change the password. 

    SSL Port 

    The default SSL port is 636. You can change the SSL port. 

  5. Click OK.


    Note:

    Remember, the changes will not affect the active instance until you restart it. See "Restarting Directory Server Instances"


    See Also:

    "Setting Debug Logging Levels by Using the OID Control Utility" 

To create a new configuration set entry without copying from a previous entry:

  1. In the navigator pane expand the server instance to which you are connecting, then expand Server Management > Directory Server > Default Configuration Set.

  2. Select Default Configuration Set.

  3. On the toolbar, click the Create button. A Configuration Sets dialog box displays the number of the new configuration set. Fill in the fields as described in Table 5-2.

Modifying Configuration Set Entries

To modify configuration set entries:

  1. In the navigator pane, expand Directory Server and select the configuration set entry you want to modify. The configuration set appears in the group of tab pages in the right pane:


  2. Modify the values in the fields for the General tab. For information about each field, see Table 5-1. You can change any of the values. Press Apply to save the changes.

  3. Select the Debug Flags tab. Select the check boxes for the debug logging levels you want to use.

  4. Select the SSL Settings tab. Fill in the fields as required. For information about each field, see Table 5-2.

  5. Once you are satisfied with the parameters you have set for the new configuration set entry, click Apply.

  6. Restart the server for the command to take effect.


    Note:

    Remember, the changes will not affect the active instance until you restart it. See "Restarting Directory Server Instances"


Deleting Configuration Set Entries

To delete configuration set entries:

  1. In the navigator pane, expand Directory Server.

  2. In the navigator pane, select the configuration set entry you want to delete.

  3. Click the Delete button on the toolbar.


    Note:

    Remember, the changes will not affect the active instance until you restart it. See "Restarting Directory Server Instances"


Managing Server Configuration Set Entries by Using Command Line Tools

Although changing configuration set entries by using Oracle Directory Manager is desirable, it can sometimes be more convenient to use the available command line tools--for example, when you want to make the same set of changes across multiple LDAP servers.

This section tells you how to perform the tasks described in the following sections:

When you add or modify configuration set entries by using the command line tools, the input file for adding a new configuration set entry should be written in LDAP Data Interchange Format (LDIF). It should contain only the attributes and values that differ from the installed defaults. The directory server uses the attribute values that you establish in the new configuration set entry to override its own existing values for these attributes.

See Also:

"Using LDAP Data Interchange Format (LDIF)" for information on LDIF 

Adding Configuration Set Entries by Using ldapadd

If you are adding a new Oracle Directory Server instance, you can either use an existing configuration set entry, or add a new one for the new instance.

To add a new configuration set entry, create an input file, and then load the input file with ldapadd. These operations are explained in the steps below.

  1. Create the input file in a text editor.

    Input files must use LDIF format, which is explained in "Using LDAP Data Interchange Format (LDIF)". When you create the input file, you need to define or include only those attributes that differ from the current values in that configuration set entry.

    In the following example, the parameter configset2 is the RDN, or local name, of the new entry, the wallet location is: /HOME/test/wallet, and the password is welcome.

    dn:cn=configset2, cn=oidldapd, cn=subconfigsubentry
    cn:configset2
    objectclass:orclConfigSet
    objectclass:orclLDAPSubConfig
    objectclass:top
    orclsslauthentication:1
    orclsslenable:1
    orclsslport:5000
    orclsslversion:3
    orclsslwalletpasswd:welcome
    orclsslwalleturl:file:/HOME/test/wallet
  2. Run ldapadd with an input file.

    At the system prompt, type the command to add the input file. If the example shown the example above were given the file name newconfigs, the ldapadd command would look something like the following:

    ldapadd [options] -f newconfigs 
    

    See Also:

    • "ldapadd" for a detailed list of options available with this command

    • Table F-1 for a description of configuration set entry attributes

     

Modifying and Deleting Configuration Set Entries by Using ldapmodify

To modify or delete an existing configuration set entry, create an input file containing only the attributes that you want to change, and then load the input file with the ldapmodify command. These operations are explained in the steps below.

  1. Create the input file.

    When you create the input file, define or include only those attributes that differ from the installed defaults.

    Input files must have LDIF format. LDIF format is explained in "Using LDAP Data Interchange Format (LDIF)".

    In the example of the input file shown below, the parameter cn=configset2, cn=osdldapd, cn=subconfigsubentry is the DN, or local name, of an existing configuration set entry. This example shows how to modify the orclsslport parameter to 7000.

    See Also:

    Table F-1 for a description of configuration set entry attributes 

    dn:cn=configset2, cn=osdldapd, cn=subconfigsubentry
    changetype: modify
    replace: orclsslport
    orclsslport: 7000
    
    
  2. Run ldapmodify referencing the input file.

    Type the command to reference the input file at the system prompt. For example, if the input file were named configfile, your ldapmodify command would look something like the command shown below:

    ldapmodify [options] -f configfile
    

    See Also:

    "ldapmodify" for a more detailed discussion of ldapmodify, and a list of its options 

Setting System Operational Attributes

Operational attributes--as opposed to application attributes--pertain to the operation of the directory itself. Some operational information is specified by the directory to control the server--for example, the time stamp for an entry. Other operational information, such as access information, is defined by administrators and is used by the directory program in its processing.

See Also:

"Kinds of Attribute Information"

Setting System Operational Attributes by Using Oracle Directory Manager

You can view and set some of the operational attributes for each Oracle Directory Server to which you are connected by using Oracle Directory Manager. To do this, in the navigator pane expand Oracle Internet Directory Servers, then select a server. System operational attributes appear in the right pane:


Table 5-3 describes the field for each operational attribute.

Table 5-3 Operational Attribute Fields
Field  Description  Default Value  Modifiable? 

Configuration Set Location 

DN of the entry holding the top of the naming context in this server 

cn=subconfigsubentry 

No 

Indexed Attribute Locations 

DN for the file containing all indexed attributes 

cn=catalogs 

No 

Naming Contexts 

DN for the naming context(s) contained in this server. Enter a new value in the field. If you are not sure of the value, click the attribute to bring up a search window. 

none 

Yes 

Password Encryption 

Determines whether the password is stored in encrypted form. 0=No. 1=Yes. 

Yes 

Process Instance Location 

DN of the entry holding the Instance Registry in this server 

cn=subschemasubentry 

No 

Query Entry Return Limit 

Maximum number of entries to be returned by a search 

1000 

Yes 

Replication Agreements 

DN of the entry holding the replication agreement 

cn=orclareplagreements 

No 

Replication Log Location 

DN of the entry holding the change log in this server 

cn=changelog 

No 

Replication Status Location 

DN of the entry holding the change status in this server 

cn=changestatus 

No 

Schema Definition Location 

DN of the schema 

cn=subschemasubentry 

No 

Server Mode 

Determines whether data can be written to the server. Change the default to Read Only during replication process. 

Read/Write 

Choices are Read/Write and Read Only 

Server Operation Time Limit 

Maximum amount of time, in seconds, allowed for a search to be completed 

3600 

Yes 

Setting System Operational Attributes by Using ldapmodify

The modifiable system operational attributes are:

Attribute  Description  Default 

namingContexts 

DN for the naming context(s) contained in this server. Enter a new value in the field. If you are not sure of the value, click the attribute to bring up a search window. 

none 

orclUseEncrypt 

Determines whether the password is stored in encrypted form. 0=No. 1=Yes. 

orclSizeLimit 

Maximum number of entries to be returned by a search 

1000 

orclServerMode 

Determines whether data can be written to the server. Change the default to Read Only during replication process. 

Read/Write 

orclTimeLimit 

Maximum amount of time, in seconds, allowed for a search to be completed 

3600 

See Also:

"ldapmodify" for a more detailed discussion of ldapmodify, and a list of its options 

Managing Super, Guest, and Proxy Users

A super user is a special directory administrator who typically has completely open privileges to directory information.

A guest user is one who is not an anonymous user, and, at the same time, does not have a specific user entry.

A proxy user is typically used in an environment with a middle tier such as a firewall. In such an environment, the end user authenticates himself to the middle tier. The middle tier then logs into the directory on the end user's behalf, but does so as a proxy user. A proxy user has the privilege to switch identities and, once it has logged into the directory, switches to the end user's identity. It then performs operations on the end user's behalf, using the authorization appropriate to that particular end user.

You can administer user names and passwords for the super, guest, and proxy users by using either Oracle Directory Manager or ldapmodify.


Note:

It is possible to log onto the Oracle Directory Manager without giving a user name or password. If you do this, you have the privileges specified for an anonymous user. Anonymous users should have very limited privileges. 


See Also:

Chapter 9 for information on how to set access rights 

This section covers topics in the following subsections:

Managing User Names and Passwords by Using Oracle Directory Manager


Note:

The passwords for super, guest, and proxy users are encrypted by default. You cannot modify them in order to send them in the clear. 


To change a user name or password for a super, guest, or proxy user by using Oracle Directory Manager:

  1. In the navigator pane, expand Oracle Internet Directory Servers.

  2. Select the server. The group of tab pages for that server appear in the right pane.

  3. Select the Passwords tab. The Password tab page displays the current user names and passwords for each type of user. Note that passwords are not displayed in the password fields.


    Table 5-1 lists and describes the fields in the Passwords tab page.

    Table 5-4 Password Fields and Descriptions
    Field  Description 

    Super User Name 

    The default is cn=orcladmin

    Super User Password 

    The default is welcome. You should change this password immediately. 

    Guest Login Name 

    Guests have privileges determined by the Access Control Policy Points (ACPs) in the directory. The default is cn=guest

    Guest Login Password 

    The default is guest

    Proxy Login Name 

    Proxy users have privileges determined by the ACPs in the directory. The default is cn=proxy

    Proxy Login Password 

    The default is proxy

  4. Edit the appropriate field in the Password tab page. To save your changes, click Apply.

Managing User Names and Passwords by Using ldapmodify

To change administrative user names and passwords, you use ldapmodify on the following attributes.

User Name/Password  Attribute 

Super user 

orclsuname 

Super user password 

orclsupassword 

Guest user 

orclguname 

Guest user password 

orclgupassword 

Proxy user 

orclprname 

Proxy user password 

orclprpassword 

See Also:

"ldapmodify" for ldapmodify syntax and usage notes. 

For example, to change the password of the super user to superuserpassword, we would use ldapmodify to modify the DSE by using an LDIF file containing the following:

dn: 
changetype:modify
replace:orclsupassword
orclsupassword:superuserpassword

Viewing Active Server Instance Information

You can use Oracle Directory Manager to view information about any active server instance. To do this:

  1. In the navigator pane, expand Oracle Internet Directory Servers.

  2. Select a server. The group of tab pages for that server appear in the right pane.

  3. Select the Server List tab to display basic information--namely, type, instance number, debug level, and host name--for all active server instances:


  4. To see configuration parameters for a particular server instance, in the Server List tab page, select the server.

  5. Click View Properties. The Server Process dialog box displays configuration parameters for the server instance you selected. Note that you cannot change configuration parameters in this dialog box. To change them, you must change the configuration set entry on which they are based.

    See Also:

    "Managing Server Configuration Set Entries by Using Oracle Directory Manager" for instructions on changing configuration set entries 

Setting Debug Logging Levels by Using the OID Control Utility

This section tells you how to set debug logging levels by using the OID Control Utility. You can also set debug logging levels by using Oracle Directory Manager as described in "Managing Server Configuration Set Entries by Using Oracle Directory Manager".

To set debug logging levels by using the OID Control Utility, restart the Oracle Directory Server using the -debug option for an LDAP server, and the -d flag for the replication server. Use the debug level number based on Table 5-5.

Since debug levels are additive, you need to sum together the numbers representing the functions that you want to activate, and use that sum in the command line option.

For example, if you want to trace function calls (1) and active connection management (8), you would enter 9 as the debug level (8 + 1 = 9) as follows:

oidctl server=oidldapd instance=1 flags='-debug 9' restart
oidctl server=oidrepld instance=1 flags='-h my_host -p 389 -d 9' restart

The above example restarts the LDAP server as well as the replication server with the debugging flags. Table 5-5 provides the complete list of debug logging levels.

Table 5-5 Debug Logging Levels
Logging Level Value  Function 

trace function calls 

debug packet handling 

heavy trace debugging 

connection management 

16 

print out packets sent and received 

32 

search filter processing 

64 

configuration file processing 

128 

access control list processing 

256 

stats log connections/operations/results 

512 

stats log entries sent 

1024 

print communication with the back-end 

2048 

print entry parsing debugging 

4096 

schema-related debugging 

32768 

replication-specific debugging 

65535 

enable all debugging 

Using Audit Log

The audit log records critical events on the Oracle Directory Server that are important from a security point of view or for operations. An administrator can query the audit log using ldapsearch commands. Because the log generation is contingent upon events occurring on the server, only the Oracle Internet Directory server itself can create the log entries. You cannot add audit log entries with either the Oracle Directory Manager or the command line tools. Only the server can add entries.

The audit log is made up of regular directory entries, one entry for each event. You can specify search criteria using ldapsearch, and you can view the audit log entries by using Oracle Directory Manager.

See Also:

 

By default audit logging is turned off. To turn it on, modify the DSE attribute orclauditlevel to the level you want. You can configure audit levels to audit selected events only.

To clean up audit log entries, use bulkdelete to remove all the audit log entries. Specify cn=auditlog as the base of the bulkdelete. Because bulkdelete will delete all the entries under cn=auditlog, use LDIF writer to write the entries to a file for later reference.

See Also:

"bulkdelete" 

The remainder of this section discusses topics in the following subsections:

Structure of Audit Log Entries

Each audit log entry contains the orclAuditoc object class. Like all other structural object classes, orclAuditoc inherits from top. Its attributes include the following:

Attribute  Description 

orclsequence 

Used to create the name of the entry. The name is generated using a database sequence. 

orcleventtype 

Type of event that occurred. This is a catalogued attribute. 

orcleventtime 

The time at which the event occurred. 

orcluserdn 

Identity of the user who logged into the Oracle Internet Directory server to perform the operation. This attribute is catalogued. 

orclopresult 

Outcome of the operation. SUCCESS if the operation succeeded, or else the reason why the operation failed.  

orclauditmessage 

The textual message. This attribute is not catalogued. 

objectclass 

Has the preset values top and orclauditoc

See Also:

"Object Class Types" for a description of top 

Note that the audit log entries do not become part of a regular search result set even though the search filter may satisfy the query criteria. For example, a search with the condition objectclass=top will not yield results from the auditlog entries. Only a search with cn=auditlog as the base of the search will find audit log entries.


Note:

By default, the attributes orcleventtype and orcluserdn are indexed at installation of Oracle Internet Directory. If you drop the indexes from these attributes, you cannot search for them. To re-create the index for these attributes, use the Catalog Management tool. See "Indexing an Attribute by Using Command Line Tools"


Position of Audit Log Entries in the DIT

The audit log container is part of the DSE. It holds its entries as children, organized according to the orclsequence attribute. See Figure 5-2.

Figure 5-2 Sample Audit Log in DSE


Auditable Events

Table 5-6 shows the auditable events and their audit levels. The third column, Audit Levels, contains hexidecimal values. You can audit more than one event by adding their corresponding values found in this column. This is explained in "Setting the Audit Level by Using ldapmodify".

Table 5-6 Auditable Events
Event  Description  Audit Levels 

Super user login 

Super user bind to the server (success and failures) 

0x0001 

Schema element add/replace 

Adding a new schema element (success and failure) 

0x0002 

Schema element delete 

Deleting a schema (success and failures) 

0x0004 

Bind 

Unsuccessful bind cases 

0x0008 

Access violation 

Access denied by ACP 

0x0010 

DSE modification 

Changes to DSE entry (success and failures) 

0x0020 

Replication login 

Replication server authentication (success and failures) 

0x0040 

ACL modification 

Changes to ACPs 

0x0080 

User password modification 

Modification of user password attribute 

0x0100 

Add 

ldapadd operation (success and failures) 

0x0200 

Delete 

ldapdelete operation (success and failures) 

0x0400 

Modify 

ldapmodify operation (success and failures) 

0x0800 

ModifyDN 

ldapModifyDN operation (success and failures) 

0x1000 

Auditing Events

Events described in the previous section can be turned on or off. DSE attribute orclauditlevel indicates the current audit level set on the server. A value of 0 for the attribute means no auditing, which is the default.

You can set the audit level by using either Oracle Directory Manager or ldapmodify. Both methods are described in this section.

Setting the Audit Level by Using Oracle Directory Manager

To set the audit level by using Oracle Directory Manager:

  1. In the navigator pane, expand Oracle Internet Directory Servers.

  2. Select the server.

  3. In the work pane, select the Audit Mask Levels tab page:


  4. Select the check box for the audit level you want to use.

  5. Click Apply.

    See Also:

    Table 5-6 for a description of each audit mask level 

Setting the Audit Level by Using ldapmodify

To audit more than one event, add the values of their the audit masks. For example, suppose you want to audit the following three events:

Schema element delete 

0x0004 

DSE modification 

0x0020 

32 

Add 

0x0200 

512 

 

 

548 

The total value of the audit masks is 548. The ldapmodify command would therefore look something like the following:

ldapmodify -p port -h host << EOF
dn:
changetype:modify
replace: orclauditlevel
orclauditlevel: 548
EOF

Restart the server after any changes are made to orclauditlevel for the changes to take effect.

See Also:

"Restarting Directory Server Instances" 

Searching for Audit Log Entries

You can search for audit log entries by using either Oracle Directory Manager or ldapsearch.

Searching for Audit Log Entries by Using Oracle Directory Manager

See:

Searching for Audit Log Entries 

Searching for Audit Log Entries by Using ldapsearch

The DN for the audit log container object is cn=auditlog. To search for audit log entries, you do a subtree or one-level search, with the container object cn=auditlog as the base of the search.

See:

"ldapsearch" 

Changing the Password to an Oracle Data Server

The Oracle Internet Directory uses a password when connecting to an Oracle database. The default for this password when you install Oracle Internet Directory is ODS. You can change this password by using the OID Database Password Utility.

See Also:

"Using the OID Database Password Utility" 


Prev Next
Oracle
Copyright © 1999 Oracle Corporation.

All Rights Reserved.

Library

Product

Contents

Index