Notes covering ForgeRock® Directory Services features, fixes, and known issues.

About Directory Services Software

ForgeRock Identity Platform™ is the only offering for access management, identity management, user-managed access, directory services, and an identity gateway, designed and built as a single, unified platform.

The platform includes the following components that extend what is available in open source projects to provide fully featured, enterprise-ready software:

The ForgeRock Common REST API works across the platform to provide common ways to access web resources and collections of resources.

Directory Services software provides an LDAPv3-compliant directory service, developed for the Java platform, delivering a high-performance, highly available, and secure store for the identities managed by your organization. Read these notes before you install or upgrade Directory Services software.

The easy installation process, combined with the power of the Java platform, makes this the simplest and fastest directory service to deploy and manage. Directory Services software comes with plenty of tools. Directory Services software also offers REST access to directory data over HTTP.

Directory Services software is free to download, evaluate, and use for developing your applications and solutions. ForgeRock offers training and support subscriptions to help you get the most out of your deployment.

These release notes cover the following topics:

  • Hardware and software prerequisites for installing and upgrading Directory Services software

  • Compatibility with previous releases

  • Potential upcoming deprecation and removals that affect scripts and applications

  • Issues fixed since the previous release

  • Known issues open at the time of release

  • Documentation updates

  • Definitions for release levels and interface stability

  • Getting support

See the Installation Guide after you read these Release Notes. The Installation Guide also covers upgrade for Directory Services software.

Chapter 1. What's New

This chapter covers new capabilities in Directory Services 6.5.

1.1. New Features

This release of Directory Services software includes the following new features:

Connection Limiting

DS servers now allow you to limit the number of concurrent connections per client.

For details, see "Limiting and Restricting Client Connections" in the Administration Guide.

Data Distribution

DS proxy servers now support simple, non-elastic data distribution.

You can configure a proxy server to equitably distribute LDAP write requests across multiple replication partitions to scale the directory service horizontally. As the present implementation does not permit elastic scaling or data redistribution, make sure that you understand the documented constraints of the present implementation before deploying it in production.

For an example, see "Scaling Out Using Data Distribution" in the Deployment Guide.

The mechanism is described in "Routing Requests to Remote Directory Servers" in the Administration Guide.

Database Caching

A new DS directory server uses shared cache by default for all JE database backends. As a result, you are no longer required to set the database cache size using the db-cache-percent or db-cache-size setting for each backend.

It remains possible to use these settings if necessary by configuring them appropriately. For details, see "Database Cache Settings" in the Administration Guide.

Logging
  • DS servers now support sending access log messages to standard output.

    For details, see "Sending JSON Access Logs to Standard Output" in the Administration Guide.

    When the new handler is used, standard output from the server includes a mix of JSON for access messages and non-JSON DS-format server event messages.

  • Common Audit logging now supports blacklisting log message fields to prevent them from showing up in log messages.

    For an example, see "Blacklisting Log Message Fields" in the Administration Guide.

  • Common Audit logging now supports writing multiple file-based logs to the same directory by setting a different log-file-name-prefix for each file-based log.

Monitoring

DS servers now provide health status checks for anonymous requests over HTTP and LDAP. This allows a remote application to check that a server is "alive" and "healthy".

Anonymous HTTP requests can retrieve "alive" and "healthy" status codes. Anonymous LDAP requests can retrieve "alive" and "healthy" boolean values.

The "alive" and "healthy" status indicates that the server has passed its own internal tests. It is not, however, a guarantee that the server is free from other errors. If a server is not "alive," it requires administrative intervention. If a server is not "healthy," temporarily route requests to another server.

When a server is not "alive" or "healthy," a user with privileges to read monitoring information receives health status error messages in the body of the HTTP response, and can obtain health status error messages over LDAP as described below. No error messages are returned in response to anonymous requests.

For examples demonstrating how to use this feature, see the following documentation:

When you upgrade DS servers to this release, the anonymously accessible HTTP endpoints are not configured. To add the endpoints on an upgraded server that lacks them, use the dsconfig command:

$ dsconfig \
 create-http-endpoint \
 --endpoint-name /alive \
 --type alive-endpoint \
 --set enabled:true \
 --set authorization-mechanism:HTTP Anonymous \
 --set authorization-mechanism:HTTP Basic \
 --hostname opendj.example.com \
 --port 4444 \
 --bindDN "cn=Directory Manager" \
 --bindPassword password \
 --trustAll \
 --no-prompt
$ dsconfig \
 create-http-endpoint \
 --endpoint-name /healthy \
 --type healthy-endpoint \
 --set enabled:true \
 --set authorization-mechanism:HTTP Anonymous \
 --set authorization-mechanism:HTTP Basic \
 --hostname opendj.example.com \
 --port 4444 \
 --bindDN "cn=Directory Manager" \
 --bindPassword password \
 --trustAll \
 --no-prompt
Platform Integration

When setting up a directory server for use with other ForgeRock Identity Platform™ component products, you can use available setup profiles to greatly simplify initial configuration.

For details, see "Using Directory Server Setup Profiles" in the Installation Guide.

In addition, you can use profiles in embedded servers. For details, see "To Set Up an Embedded Server" in the Developer's Guide.

Replication

When configuring a replication server on a multi-homed system with multiple IP addresses, you can now specify which listen addresses to use.

Set the property, listen-address, as shown in "Choosing the Listen Address for Replication" in the Administration Guide.

Support

The DS support extract command, supportextract, now ships with DS server software, making it easier to capture troubleshooting information.

The command works on all supported platforms.

For details, see "supportextract — extract support data" in the Reference.

1.2. Product Improvements

This release of Directory Services software includes the following enhancements:

DevOps

Administrative tasks affecting directory server backends no longer modify the server configuration.

This supports DevOps and other deployments that require an immutable configuration.

Embedded Server

Embedded directory servers now support both online and offline modes for importing LDIF and rebuilding indexes.

Examples

The server software now includes an example password storage scheme extension.

For details, unzip the file /path/to/opendj/example-pwdscheme.zip and see the README file inside.

Indexing

The debugsearchindex attribute, used for investigating how searches are indexed, now holds JSON values that are significantly easier to read.

For examples, see "Clarifying Which Indexes Are Used by a Search" in the Administration Guide.

Java Support

DS software now supports Java 8 and Java 11.

LDAP Support

DS servers now support the experimental LDAP Relax Rules control, as described in The LDAP Relax Rules Control (Internet-Draft).

Logging
  • DS servers now maintain a filtered JSON LDAP access log in addition to the primary (unfiltered) access log.

    This log includes messages of interest to developers and administrators. For details, see "To Configure Filtered JSON LDAP Access Logs" in the Administration Guide.

  • Common Audit logging now supports logging to a PostgreSQL.

    For details, see "Configuring JDBC Access Logs" in the Administration Guide.

Monitoring

The monitoring dashboard samples now show the number of available DS servers.

Password Management

DS servers now support using proxied authorization with the LDAP password modify extended operation.

Replication
REST to LDAP

REST to LDAP now supports returning null-value fields in JSON resources.

To enable this feature, set return-null-for-missing-properties:true for a Rest2ldap endpoint or "returnNullForMissingProperties": true in the REST to LDAP Gateway configuration file, rest2ldap.json.

By default, a REST to LDAP mapping omits JSON fields for LDAP attributes that have no values. For example, the following entry is missing a value for the optional description:

dn: uid=bjensen,ou=people,dc=example,dc=com
objectClass: person
uid: bjensen
cn: Babs Jensen
sn: Jensen
     

A REST to LDAP mapping which maps the uid, cn, sn, and description attributes could return the following JSON:

{
  "id": "bjensen",
  "fullName": "Babs Jensen",
  "familyName": "Jensen"
}

With the setting enabled, the mapping returns a JSON resource with a "description" field:

{
  "id": "bjensen",
  "fullName": "Babs Jensen",
  "familyName": "Jensen",
  "description": null
}
Security
  • DS servers no longer overwrite a destination server's secret keys when configuring replication.

    As a result, you no longer need to configure replication before configuring data confidentiality, or before configuring an encrypted password storage scheme such as 3DES, AES, or Blowfish.

  • DS fingerprint certificate mappers now support SHA-256 as a fingerprint algorithm.

Tools
  • The status command has been rewritten.

    For details, see "Important Changes to Existing Functionality".

  • The manage-account command now supports the following additional subcommands:

    • clear-account-expiration-time

    • clear-authentication-failure-times

    • clear-grace-login-use-times

    • clear-last-login-time

    • clear-password-changed-by-required-time

    • clear-password-changed-time

    • clear-password-expiration-warned-time

    • clear-password-history

    • clear-password-is-reset

    • set-account-expiration-time

    • set-authentication-failure-times

    • set-grace-login-use-times

    • set-last-login-time

    • set-password-changed-by-required-time

    • set-password-changed-time

    • set-password-expiration-warned-time

    • set-password-is-reset

    In addition, the actions can be performed over LDAP independently of the command by using the LDAP Password Policy State extended operation with OID 1.3.6.1.4.1.26027.1.6.1. DS servers implement a class for this operation. See the Javadoc for PasswordPolicyStateExtendedOperation.

  • DS command-line tools now have options to specify the keystore or truststore type when securing connections and using client authentication or authenticating the server.

    For details about the options available with each command, see "Tools Reference" in the Reference.

  • The DS ldapmodify and ldappasswordmodify commands now report password policy error codes when applicable.

  • Templates for the makeldif command now support a <DateTime> tag to generate timestamp values in LDIF attributes.

    For details, see "makeldif.template — template file for the makeldif command" in the Reference.

Upgrade

You can now upgrade mutable DS server data after upgrading the immutable binary files and configuration. Use the --dataOnly option with the upgrade command.

This improvement is available when upgrading from DS 6.0.0 or later releases.

1.3. Security Advisories

ForgeRock issues security advisories in collaboration with our customers and the open source community to address any security vulnerabilities transparently and rapidly. ForgeRock's security advisory policy governs the process on how security issues are submitted, received, and evaluated as well as the timeline for the issuance of security advisories and patches.

For details of all the security advisories across ForgeRock products, see Security Advisories in the Knowledge Base library.

Chapter 2. Before You Install

This chapter covers requirements for running Directory Services software in production. It covers the following topics:

  • Downloading Directory Services software

  • Choosing hardware

  • Choosing an operating system

  • Preparing the Java environment

  • Choosing an application server when using the DSML or REST to LDAP gateway

  • Assigning FQDNs when using replication

  • Synchronizing System Clocks For Replication

  • Using appropriately signed digital certificates

2.1. Downloading Directory Services Software

The ForgeRock BackStage download site provides access to ForgeRock releases. ForgeRock releases are thoroughly validated for ForgeRock customers who run the software in production deployments, and for those who want to try or test a given release.

"Directory Services Software" describes the available software.

Directory Services Software
FileDescription

DS-6.5.0.zip

Cross-platform distribution of the server software.

Pure Java, high-performance server that can be configured as:

  • An LDAPv3 directory server with the additional capability to serve directory data to REST applications over HTTP.

  • An LDAPv3 directory proxy server providing a single point of access to underlying directory servers.

  • A replication server handling replication traffic with directory servers and with other replication servers, receiving and sending changes to directory data.

Server distributions include command-line tools for installing, configuring, and managing servers. The tools make it possible to script all operations.

By default, this file unpacks into an opendj/ directory.

DS-6.5.0.msi

Microsoft Windows native installer for the server software.

By default, this installs files into a C:\Program Files (x86)\OpenDJ\ directory.

DS_6.5.0-1_all.deb

Server software native packages for Debian and related Linux distributions.

By default, this installs files into an /opt/opendj/ directory.

DS-6.5.0-1.noarch.rpm

Server software native packages for Red Hat and related Linux distributions.

By default, this installs files into an /opt/opendj/ directory.

DS-dsml-servlet-6.5.0.war

Cross-platform DSML gateway web archive.

DS-rest2ldap-servlet-6.5.0.war

Cross-platform REST to LDAP gateway web archive.

DS-monitoring-dashboard-samples-6.5.0.zip

Sample Grafana dashboard demonstrating how to graph DS server metrics stored in a Prometheus database. You are responsible for adapting the sample to suit your production requirements. These resources are provided for demonstration purposes only. Commercial support for the ForgeRock DevOps Examples is not available from ForgeRock.

For details on how to try the sample dashboard, see the README.md file delivered inside the .zip file.


2.2. Choosing Hardware

Thanks to the underlying Java platform, Directory Services software runs well on a variety of processor architectures. Many directory service deployments meet their service-level agreements without the very latest or very fastest hardware.

2.2.1. Fulfilling Memory Requirements

When installing a directory server for evaluation, you need 256 MB memory (32-bit) or 1 GB memory (64-bit) available.

For installation in production, read the rest of this section. You need at least 2 GB memory for a directory server and four times the disk space needed for initial production data in LDIF format. A replicated directory server stores data, indexes for the data, operational attribute data, and historical information for replication. The server configuration trades disk space for performance and resilience, compacting and purging data for good performance and for protection against temporary outages. In addition, leave space for growth in database size as client applications modify and add entries over time.

For a more accurate estimate of the disk space needed, import a known fraction of the initial LDIF with the server configured for production. Run tests to estimate change and growth in directory data, and extrapolate from the actual space occupied in testing to estimate the disk space required in production.

Directory servers almost always benefit from caching all directory database files in system memory. Reading from and writing to memory is much faster than reading from and writing to disk storage.

For large directories with millions of user directory entries, there might not be room to install enough memory to cache everything. To improve performance in such cases, use quality solid state drives either for all directory data, or as an intermediate cache between memory and disk storage.

2.2.2. Fulfilling Minimum Disk Space Requirements

To evaluate DS software, make sure you have 10 GB free disk space for the software and for sample data.

The more data you have, the more disk space you need. Before deploying production systems, make sure you have enough space. For details, see "Planning for High Scale" in the Deployment Guide.

2.2.3. Choosing a Processor Architecture

Processor architectures that provide fast single thread execution tend to help Directory Services software deliver the lowest response times. For top-end performance in terms of sub-millisecond response times and of throughput ranging from tens of thousands to hundreds of thousands of operations per second, the latest x86/x64 architecture chips tend to perform better than others.

When deploying DS servers with replication enabled, allow at minimum two CPU cores per server. Allow more CPU cores per server, especially in high-volume deployments or when using CPU-intensive features such as encryption. Single CPU systems seriously limit server performance.

Chip multi-threading (CMT) processors can work well for directory servers providing pure search throughput, though response times are higher. However, CMT processors are slow to absorb hundreds or thousands of write operations per second. Their slower threads get blocked waiting on resources, and thus are not optimal for deployments with high write throughput requirements.

2.2.4. Fulfilling Network Requirements

On systems with fast processors and enough memory to cache directory data completely, the network can become a bottleneck. Even if a single 1 Gb Ethernet interface offers plenty of bandwidth to handle your average traffic load, it can be too small for peak traffic loads. Consider using separate interfaces for administrative traffic and for application traffic.

To estimate the network hardware required, calculate the size of the data returned to applications during peak load. For example, if you expect to have a peak load of 100,000 searches per second, each returning a full 8 KB entry, you require a network that can handle 800 MB/sec (3.2 Gb/sec) throughput, not counting other operations, such as replication traffic.

2.2.5. Fulfilling Storage Requirements

Note

The directory server does not currently support network file systems such as NFS for database storage. Provide sufficient disk space on local storage such as internal disk or an attached disk array.

For a directory server, storage hardware must house both directory data, including historical data for replication, and server logs. On a heavily used server, you might improve performance by putting access logs on dedicated storage.

Storage must keep pace with throughput for write operations. Write throughput can arise from modify, modify DN, add, and delete operations, and from bind operations when a login timestamp is recorded, and when account lockout is configured, for example.

In a replicated topology, a directory server writes entries to disk when they are changed, and a replication server writes changelog entries. The server also records historical information to resolve potential replication conflicts.

As for network throughput, base storage throughput required on peak loads rather than average loads.

2.3. Choosing an Operating System

Directory Services 6.5 software is supported on the following operating systems:

  • Linux 2.6 and later

  • Microsoft Windows Server 2008, 2008 R2, 2012, 2012 R2, and 2016

In order to avoid directory database file corruption after crashes or power failures on Linux systems, enable file system write barriers and make sure that the file system journaling mode is ordered. For details on how to enable write barriers and how to set the journaling mode for data, see the options for your file system in the mount command manual page.

2.3.1. Setting Maximum Open Files

DS servers need to be able to open many file descriptors, especially when handling thousands of client connections. Linux systems in particular often set a limit of 1024 per user, which is too low to handle many client connections to the DS server.

When setting up your DS server for production use, make sure the server can use at least 64K (65536) file descriptors. For example, when running the server as user opendj on a Linux system that uses /etc/security/limits.conf to set user level limits, you can set soft and hard limits by adding these lines to the file:

opendj soft nofile 65536
opendj hard nofile 131072

The example above assumes the system has enough file descriptors available overall. You can check the Linux system overall maximum as follows:

$ cat /proc/sys/fs/file-max
204252

2.3.2. Setting Maximum Inotify Watches

A directory server backend database monitors file events. On Linux systems, backend databases use the inotify API for this purpose. The kernel tunable fs.inotify.max_user_watches indicates the maximum number of files a user can watch with the inotify API. Make sure this tunable is set to at least 512K:

$ sysctl fs.inotify.max_user_watches
fs.inotify.max_user_watches = 524288

If this tunable is set lower than that, change it as shown in the following example:

$ sudo sysctl --write fs.inotify.max_user_watches=524288
[sudo] password for opendj:
fs.inotify.max_user_watches = 524288

2.3.3. Preventing Interference With Antivirus Software

Prevent antivirus and intrusion detection systems from interfering with directory services.

Antivirus and intrusion detection systems that do a deep inspection of database files are not compatible with DS server software. Disable antivirus and intrusion detection systems, or at least prevent them from operating on DS server files.

2.4. Preparing the Java Environment

Directory Services software consists of pure Java applications. Directory Services servers and clients run on any system with full Java support. Directory Services is tested on a variety of operating systems, and supported on those listed in "Choosing an Operating System".

Directory Services software requires Java 8 or 11, specifically at least the Java Standard Edition runtime environment, or the corresponding Java Development Kit to compile Java plugins and applications.

Note

ForgeRock validates Directory Services software with OpenJDK and Oracle JDK, and does occasionally run sanity tests with other JDKs such as the IBM JDK and Azul's Zulu. Support for very specific Java and hardware combinations is best-effort. This means that if you encounter an issue when using a particular JVM/hardware combination, you must also demonstrate the problem on a system that is widespread and easily tested by any member of the community.

ForgeRock recommends that you keep your Java installation up-to-date with the latest security fixes.

Important

Directory server JE database backends can require additional JVM options. When running a directory server with a 64-bit JVM and less than 32 GB maximum heap size, you must use the Java option, -XX:+UseCompressedOops. To use the option, edit the config/java.properties file. The following example settings include the option with the arguments for offline LDIF import, for rebuilding backend indexes, and for starting the directory server:

   import-ldif.offline.java-args=-server -XX:+UseCompressedOops
   rebuild-index.offline.java-args=-server -XX:+UseCompressedOops
   start-ds.java-args=-server -XX:+UseCompressedOops
  

Make sure you have a required Java environment installed on the system. If your default Java environment is not appropriate, set OPENDJ_JAVA_HOME to the path to the correct Java environment, or set OPENDJ_JAVA_BIN to the absolute path of the java command. The OPENDJ_JAVA_BIN environment variable is useful if you have both 32-bit and 64-bit versions of the Java environment installed, and want to make sure you use the 64-bit version.

2.5. Running in a Container

For some settings, DS servers depend on system information reported by the JVM to determine defaults. When running DS servers in containers such as Docker, the Java 8 JVM returns information about the operating system that does not reflect container constraints and limits. When using Java 8, manually adjust the settings described below.

Note

Java 11 supports gathering container information, as described in JDK-8146115.

Skip the this section when using Java 11.

If necessary, override automatic CPU detection by specifying the number of CPUs the JVM uses with -XX:ActiveProcessorCount=count in config/java.properties.

Before adjusting settings, determine the following container constraints:

  • The number of CPU core hardware threads dedicated to the containerized system, which is usually twice the number of CPU cores

  • The amount of RAM dedicated to the containerized system

When running DS servers in containers such as Docker, adjust the following settings:

  • num-request-handlers

    Recommendation: Set this either to 2 or to 1/4 of the number of core hardware threads, whichever is larger.

  • num-worker-threads

    Recommendation: Set this either to 4 or to 5/8 of the number of core hardware threads, whichever is larger.

  • db-num-cleaner-threads

    Recommendation: Set this either to 2 or to 1/4 of the number of core hardware threads, whichever is larger.

  • num-update-replay-threads

    Recommendation: Set this either to 4 or to 1/2 of the number of core hardware threads, whichever is larger.

  • -Xmx (Java setting limiting maximum heap size)

    To use the option, edit the config/java.properties file and restart the server.

    For example, consider a container limited to 8 GB RAM. The following setting limits the maximum heap size to 8 GB when starting the directory server:

    start-ds.java-args=-server -Xmx8G
                

2.6. Choosing an Application Server

DS servers run as standalone Java services, and do not depend on an application server.

The REST to LDAP and DSML gateway applications run on Apache Tomcat (Tomcat) and Jetty.

ForgeRock supports only stable application container releases. See the Tomcat and Jetty documentation for details about the right container to use with your Java environment.

2.7. Assigning FQDNs For Replication

Directory Services replication requires use of fully qualified domain names (FQDNs), such as opendj.example.com.

Host names like my-laptop.local are acceptable for evaluation. In production, and when using replication across systems, you must either ensure DNS is set up correctly to provide FQDNs, or update the hosts file (/etc/hosts or C:\Windows\System32\drivers\etc\hosts) to supply unique, FQDNs.

2.8. Synchronizing System Clocks For Replication

When using DS replication, keep server system clocks synchronized.

To keep the system clocks synchronized, use a tool that always moves the clock forwards. For example, ntpd adjusts the size of a second so that time always moves forwards to eventual clock consistency.

Never move the system clock backwards. Never use tools such as ntpdate that may move the clock backwards.

2.9. Getting Digital Certificates Signed

If you plan to configure SSL or TLS to secure network communications between the server and client applications, install a properly signed digital certificate that your client applications recognize, such as one that works with your organization's PKI or one signed by a recognized certificate authority.

To use the certificate during installation, the certificate must be located in a file-based keystore supported by the JVM (JKS, JCEKS, PKCS#12), or on a PKCS#11 token. To import a signed certificate into a keystore, use the Java keytool command.

For details, see "Preparing For Secure Communications" in the Administration Guide.

2.10. Special Requests

If you have a special request regarding support for a combination not listed here, contact ForgeRock at info@forgerock.com.

Chapter 3. Compatibility

This chapter covers both major changes to existing functionality, and also deprecated and removed functionality.

3.1. Important Changes to Existing Functionality

Take the following changes into account when upgrading to Directory Services 6.5:

  • The status command has been rewritten, with the following notable changes:

    • The command is no longer interactive.

      You must supply the required options when invoking the status command.

    • The command now has an --offline option.

      When you run status --offline on a running server, the command only displays a portion of the available information.

    • You can now run the command against a remote DS server version 6 or later.

    • The output shows more information than before.

  • The dsreplication status command no longer shows metrics for M.C. (missing changes) and A.O.M.C. (age of oldest missing change). Instead, it shows the replication delay.

    For DS 6 and later servers that expose a replication delay metric, the command shows the delay value. For DS 5.5 and earlier servers, the command shows N/A.

  • The db/admin backend has been renamed db/adminRoot.

  • The global server configuration property, reject-unauthenticated-requests, a boolean, has been removed and replaced with the property, unauthenticated-requests-policy.

    The new property can be set to the following values:

    reject

    Same behavior as reject-unauthenticated-requests:true

    allow

    Same behavior as reject-unauthenticated-requests:false

    allow-discovery

    Like reject, but allows unauthenticated base object searches of the root DSE

  • The server-side (plugin) Java API is continuing to evolve, as noted in "Release Levels and Interface Stability".

    Server plugins written against this API will have to be adapted and recompiled to work with this version. For Java API reference documentation, see the Javadoc.

  • The example server plugin described in "Writing a Server Plugin" in the Developer's Guide unpacks LDAP schema files into a db/schema directory. This is the correct schema file location for new DS servers since the 6.0 release.

    When you upgrade a server from version 5.5.x or earlier, however, schema files remain in the config/schema directory. As a result, when using the example plugin with the upgraded server, you must manually move schema files from the db/schema directory to the config/schema directory.

  • The proxy backend configuration property service-discovery-mechanism has been renamed shard.

  • The encode-password command now displays the encoded password without additional characters.

    In other words, the output is now {scheme}encoded-password rather than Encoded Password: "{scheme}encoded-password".

3.2. Deprecated Functionality

This section lists deprecated functionality. Deprecation is defined in "ForgeRock Product Interface Stability".

  • All dsreplication subcommands are deprecated. Their names, meanings, and outputs are likely to change in a future release. This includes the following subcommands:

    • dsreplication configure

    • dsreplication initialize

    • dsreplication initialize-all

    • dsreplication post-external-initialization

    • dsreplication pre-external-initialization

    • dsreplication purge-historical

    • dsreplication reset-change-number

    • dsreplication resume

    • dsreplication status

    • dsreplication suspend

    • dsreplication unconfigure

  • The setup command may be replaced by a simpler implementation in a future release.

  • The HTTP monitoring endpoint, /admin/monitor, has been deprecated.

    Use /metrics/api or /metrics/prometheus instead.

  • The following metrics are deprecated:

    • ds-mon-approx-oldest-change-not-synchronized (LDAP)

    • ds-mon-approximate-delay (LDAP)

    • ds-mon-missing-changes (LDAP)

    • ds_replication_changelog_connected_replicas_approx_oldest_change_not_synchronized_seconds (Prometheus)

    • ds_replication_changelog_connected_replicas_approximate_delay_seconds (Prometheus)

    • ds_replication_changelog_connected_replicas_missing_changes (Prometheus)

    Note

    In mixed topologies, a directory server version 6 or earlier connected to a replication server version 6.5 or later cannot consume messages about other servers going offline. The monitoring framework reflects this as a delay on the directory server that could not consume the message.

    The delay is reflected in the dsreplication status output and the values of the deprecated metrics described above.

    The delay is calculated correctly again once all servers in the topology are upgraded to at least version 6.5, or when the offline the server comes back online and has seen a change to directory data.

    Monitor replication delay instead of using the deprecated metrics. For details, see "Monitoring Replication Delay Over LDAP" in the Administration Guide or "Monitoring Replication Delay Over HTTP" in the Administration Guide.

3.3. Removed Functionality

  • The manage-account get-password-history subcommand has been removed due to security concerns.

Chapter 4. Fixes, Limitations, and Known Issues

This chapter covers the status of key issues and limitations for DS 6.5.

4.1. Key Fixes

The following important bugs were fixed in this release:

  • OPENDJ-5406: Duplicate entry DNs if entry is deleted and then added during export-ldif or dsreplication initialize

  • OPENDJ-5140: PersistentSearch heap usage grows

  • OPENDJ-5553: Rest2Ldap cannot connect to TLSv1.2 servers

  • OPENDJ-5496: DS fails to reconnect to an RS, disconnecting in handshake phase, after system restart

  • OPENDJ-5594: StackOverflowError with groupOfURLs when isMemberOf is requested

  • OPENDJ-4589: dsconfig --offline is not case-insensitive

  • OPENDJ-4325: Changelog searches requesting changelogCookie are very slow

  • OPENDJ-3341: REST to LDAP gateway: HTTP response for API description is empty

  • OPENDJ-5210: Possible memory-leak if request received while bind in progress

  • OPENDJ-3153: REST to LDAP gateway: changing password fails when using proxied authorization

  • OPENDJ-5272: "idle-time-limit" global configuration property has no effect

  • OPENDJ-5137: Reading compressed or encrypted entries fails to close the InflaterInputStream

  • OPENDJ-5606: Upgrade to DS 6.0 fails if multiple filesystems are involved

  • OPENDJ-4625: Changelog range searches miss entries

  • OPENDJ-2356: verify-index displays an inappropriate error message when run in online mode

  • OPENDJ-4229: status command with keystore options throws NullPointerException

  • OPENDJ-4852: Backup with --backupAll misses a few backends

  • OPENDJ-4881: Updates via Rest2ldap fail if record does not contain the necessary object class

  • OPENDJ-5115: ldappasswordmodify fails, NPE in PasswordPolicyState updatePasswordHistory

  • OPENDJ-4967: Rest2ldap UndeliverableException occurs when a referenced entity cannot be fetched

  • OPENDJ-5558: SDK: LdapUrl is not IPv6 clean

  • OPENDJ-5481: ERR_OPERATION_NOT_FOUND_IN_PENDING message used twice in different contexts

  • OPENDJ-3343: Invalid Conflict resolution on Add sequence when Parent & Child are added on different replica

  • OPENDJ-4947: SASL DIGEST-MD5: bind request failed with protocol error

  • OPENDJ-5582: LdapClientSocket connection leaked when handshake fails

  • OPENDJ-5293: Proxy: Replication Service Discovery Mechanism logs WARNING

  • OPENDJ-3480: Updating schema backend properties while it is enabled leaves schema backend in broken state

4.2. Limitations

This release has the following limitations:

  • Configuring a server with both local backends and proxy backends is not supported.

    As described in "Configuring Privileges and Access Control" in the Administration Guide, access control models for directory servers and proxy servers cannot function at the same time in the same server.

  • DS servers provide full LDAP v3 support, except for alias dereferencing, and limited support for LDAPv2.

  • Directory servers store passwords prefixed with the storage scheme in braces, as in {scheme}. For details, see "Configuring Password Storage" in the Administration Guide.

    To prevent users from effectively attempting to choose their own password storage scheme, directory servers do not support passwords that strictly match this format. Specifically, directory servers do not support passwords that match {string}*.

    Requests to update userPassword values with such passwords fail with result code 19 (Constraint Violation) and an additional message indicating that passwords may not be provided in pre-encoded form.

  • When you configure account lockout as part of password policy, DS directory servers lock an account after the specified number of consecutive authentication failures. Account lockout is not transactional across a replication topology, however. Global account lockout occurs as soon as the authentication failure times have been replicated.

  • When configuring replication between servers with different versions, use the appropriate dsreplication command:

    • When adding a new server to a replication topology with 2.6.x servers, use the dsreplication command installed with a 2.6 server.

    • When adding a new server to a replication topology with 3.x and later servers, use the dsreplication command installed with a new server.

    • After adding servers, use the dsreplication command installed with a new server.

  • The policy-based access control handler used in proxy servers:

    • Does not support the Get Effective Rights control.

    • Does not check the modify-acl privilege when global access control policies are changed. The config-write privilege is sufficient to change global access control policies.

    • Does not send alert notifications when global access control policies change.

  • When using ACIs or collective attributes with the proxy server data distribution feature, the ACI and entries having collective attribute values must be located at or above the partition-base-dn. When changing this data, make the change behind the proxy to one directory server replica in each shard. Your changes are not replicated outside the shard.

    The proxy server data distribution feature does not currently support the following:

    • Importing distributed data with the import-ldif command.

    • Changes to the number of partitions after data has been deployed.

    • Modify DN operations to distributed entries.

    • Updates to entries at or above the partition-base-dn.

    • Virtual static groups.

    • Data distribution does not support these virtual attributes:

      member
      uniqueMember

      The isMemberOf virtual attribute works as expected as long as you replicate the group entries on every shard.

    • Data distribution does not support these LDAP controls:

      Server-Side Sort controls: 1.2.840.113556.1.4.473, 1.2.840.113556.1.4.474
      Simple Paged Results control: 1.2.840.113556.1.4.319
      Virtual List View controls: 2.16.840.1.113730.3.4.9, 2.16.840.1.113730.3.4.10
  • The Password Policy control (OID: 1.3.6.1.4.1.42.2.27.8.5.1) is supported for add, bind, and modify operations. It is not supported for compare, delete, search and modify DN operations.

  • REST to LDAP does not support modify RDN operations.

  • Antivirus and intrusion detection systems that do a deep inspection of database files are not compatible with DS server software. Disable antivirus and intrusion detection systems, or at least prevent them from operating on DS server files.

  • REST to LDAP query filters do not work with properties of subtypes.

    For example, the default example configuration describes a user type, and a POSIX user type that inherits from the user type. If your query filter is based on a POSIX user type property that is not a property of the user type, such as loginShell or gidNumber, the filter always evaluates to false, and the query returns nothing.

  • When applying a Common REST patch operation, described in "Patching Resources" in the Developer's Guide, to a Json syntax attribute, you cannot patch individual fields of the JSON object. You must change the entire JSON object instead.

    As a workaround, you can perform an update of the entire object, changing only the desired fields in your copy.

  • When the global server property invalid-attribute-syntax-behavior is set to accept or warn, a search on group membership using a value with invalid syntax returns nothing.

  • Due to a Java issue on Windows systems (JDK-8057894), when configuring DS directory servers with data confidentiality enabled you might see an error message containing the following text:

    Unexpected CryptoAPI failure generating seed

    If this happens, try running the command again.

4.3. Known Issues

Tip

When deploying DS servers in production, make sure that you follow the installation instructions. Allow DS servers to use at least 64K (65536) file descriptors. Also tune the JVM appropriately.

The following important issues remained open at the time of this release:

  • OPENDJ-1192: Concurrent modify requests on single-valued attributes may not be replicated correctly

  • OPENDJ-5503: Change number "not found in pending list"

  • OPENDJ-5602: JDK11: unexpected return code 81 using SASL External

  • OPENDJ-4920: LDAPS connections which are still inside handshake do not get idle closed

  • OPENDJ-5663: JDK 11: illegal reflective access warning on setup (without profile)

  • OPENDJ-5664: JDK 11: illegal reflective access warning during import-ldif

  • OPENDJ-5611: Change number indexing can lag behind replication under extreme load

  • OPENDJ-5636: ServiceDiscoveryMechanism can return incorrect Partition

  • OPENDJ-4714: SSL handshake now sends 16KB list of CA issuer DNs

  • OPENDJ-5590: Proxy: server discovery fails silently when proxy base-dn differs from backend's base-dn

  • OPENDJ-5686: Updating schema fails due to the order of attributeTypes and ObjectClasses in an LDIF file

  • OPENDJ-5675: JDK11: supportextract tool cannot find jstack command

  • OPENDJ-5584: Server does not validate sum of memory used by JE backend caches in all cases

  • OPENDJ-5661: supportextract tool help and version options are different from other tools

  • OPENDJ-5660: JDK 11: illegal reflective access warning on setup (with profile)

  • OPENDJ-5201: Tools may prompt to trust certificate multiple times for different reasons

Chapter 5. Documentation Updates

"Documentation Change Log" tracks important changes to the documentation:

Documentation Change Log
DateDescription
2018-11-28

In addition to the changes described in "What's New" and "Compatibility", the following important changes were made to the documentation:

  • Added a new guide, Getting Started, that provides a quick, hands-on looks at what Directory Services software can do.

  • Added a new chapter, "Configuring REST APIs" in the Administration Guide, focused on administrative work to build REST APIs.

    The chapter includes a new section, "Mapping JSON Profiles to LDAP" in the Administration Guide, as an example for administrators creating new REST APIs starting from JSON resources rather than LDAP entries.

  • Added a new chapter, "Deploying for DevOps and SaaS" in the Deployment Guide, that focuses on use of DS software in DevOps and SaaS deployments.

  • Added a section, "Setting Disk Space Thresholds For Replication Changelog Databases" in the Administration Guide, showing how to set low and full disk thresholds for replication server changelog databases.

  • Updated "Limitations" and "To Add a New Replica to an Existing Topology" in the Installation Guide to reflect the need to use the dsreplication command installed with a 2.6 server when adding a new server to a replication topology with 2.6.x servers.

  • Rewrote the section, "Choosing Load Balancing Settings" in the Administration Guide, to clarify how to choose among the alternatives offered by directory proxy servers.

  • "Attribute Types" in the LDAP Schema Reference now includes a Used By list in each table of attribute properties.

    The list consists of links to sections describing the object classes that require or allow the the attribute.

  • A new section shows how to back up and restore configuration files. See "Backing Up and Restoring Configuration Files" in the Administration Guide.

  • Added a step to "To Upgrade Replicated Servers" in the Installation Guide showing how to add missing privileges to the global administrator account.

    These privileges are required when using the dsreplication status command.

  • Added an example of the proxy user and ACI required on DS directory servers.

    See "To Set Up a Directory Proxy Server" in the Installation Guide, or "Configuring a Proxy Backend" in the Administration Guide.

  • Corrected the synopsis for targattrfilters in "ACI Targets" in the Administration Guide.

    The documentation incorrectly suggested (targattrfilters != "expression") as a legal ACI target. In an ACI target, targattrfilters must be set equal to an expression, as in (targattrfilters = "expression").

    The documentation also incorrectly indicated that you separate targattrfilters expressions with semicolons. Instead, use commas to separate multiple targattrfilters expressions.

  • Clarified in "Updating Resources" in the Developer's Guide that an update operation requires a JSON payload including all the writable fields of the resource that you want to retain. The update replaces the writable fields of the resource with the values in your JSON payload.

    If you want to change only part of a JSON resource, see "Patching Resources" in the Developer's Guide instead.

  • Updated "To Set Up JMX Access" in the Administration Guide to explain how to avoid periodic full garbage collection events when using JMX.


Appendix A. Release Levels and Interface Stability

This appendix includes ForgeRock definitions for product release levels and interface stability.

Some interfaces are labelled as Evolving in the body of the documentation. In addition, the following rules apply:

  • All Java APIs are Evolving, except com.* packages, which are Internal/Undocumented.

  • The class org.forgerock.opendj.ldap.CoreMessages is Internal.

  • Text in log messages should be considered Internal. Log message IDs are Evolving.

  • Monitoring metrics available over LDAP (cn=monitor), HTTP, and JMX are Evolving.

  • The default content of cn=schema (LDAP schema) is Evolving.

  • The interface of the "changelogstat — debug changelog and changenumber files" command is Evolving.

  • Newly Deprecated and Removed interfaces are identified in "Compatibility".

  • Interfaces that are not described in released product documentation should be considered Internal/Undocumented. For example, the LDIF representation of the server configuration, config.ldif, should be considered Internal.

A.1. ForgeRock Product Release Levels

ForgeRock defines Major, Minor, Maintenance, and Patch product release levels. The release level is reflected in the version number. The release level tells you what sort of compatibility changes to expect.

Release Level Definitions
Release LabelVersion NumbersCharacteristics

Major

Version: x[.0.0] (trailing 0s are optional)

  • Bring major new features, minor features, and bug fixes

  • Can include changes even to Stable interfaces

  • Can remove previously Deprecated functionality, and in rare cases remove Evolving functionality that has not been explicitly Deprecated

  • Include changes present in previous Minor and Maintenance releases

Minor

Version: x.y[.0] (trailing 0s are optional)

  • Bring minor features, and bug fixes

  • Can include backwards-compatible changes to Stable interfaces in the same Major release, and incompatible changes to Evolving interfaces

  • Can remove previously Deprecated functionality

  • Include changes present in previous Minor and Maintenance releases

Maintenance, Patch

Version: x.y.z[.p]

The optional .p reflects a Patch version.

  • Bring bug fixes

  • Are intended to be fully compatible with previous versions from the same Minor release


A.2. ForgeRock Product Interface Stability

ForgeRock products support many protocols, APIs, GUIs, and command-line interfaces. Some of these interfaces are standard and very stable. Others offer new functionality that is continuing to evolve.

ForgeRock acknowledges that you invest in these interfaces, and therefore must know when and how ForgeRock expects them to change. For that reason, ForgeRock defines interface stability labels and uses these definitions in ForgeRock products.

Interface Stability Definitions
Stability LabelDefinition

Stable

This documented interface is expected to undergo backwards-compatible changes only for major releases. Changes may be announced at least one minor release before they take effect.

Evolving

This documented interface is continuing to evolve and so is expected to change, potentially in backwards-incompatible ways even in a minor release. Changes are documented at the time of product release.

While new protocols and APIs are still in the process of standardization, they are Evolving. This applies for example to recent Internet-Draft implementations, and also to newly developed functionality.

Deprecated

This interface is deprecated and likely to be removed in a future release. For previously stable interfaces, the change was likely announced in a previous release. Deprecated interfaces will be removed from ForgeRock products.

Removed

This interface was deprecated in a previous release and has now been removed from the product.

Technology Preview

Technology previews provide access to new features that are evolving new technology that are not yet supported. Technology preview features may be functionally incomplete and the function as implemented is subject to change without notice. DO NOT DEPLOY A TECHNOLOGY PREVIEW INTO A PRODUCTION ENVIRONMENT.

Customers are encouraged to test drive the technology preview features in a non-production environment and are welcome to make comments and suggestions about the features in the associated forums.

ForgeRock does not guarantee that a technology preview feature will be present in future releases, the final complete version of the feature is liable to change between preview and the final version. Once a technology preview moves into the completed version, said feature will become part of the ForgeRock platform. Technology previews are provided on an “AS-IS” basis for evaluation purposes only and ForgeRock accepts no liability or obligations for the use thereof.

Internal/Undocumented

Internal and undocumented interfaces can change without notice. If you depend on one of these interfaces, contact ForgeRock support or email info@forgerock.com to discuss your needs.


Appendix B. Getting Support

For information and resources about DS and ForgeRock Support, see the following sections:

B.1. Accessing Documentation Online

ForgeRock publishes comprehensive documentation online:

  • The ForgeRock Knowledge Base offers a large and increasing number of up-to-date, practical articles that help you deploy and manage ForgeRock software.

    While many articles are visible to community members, ForgeRock customers have access to much more, including advanced information for customers using ForgeRock software in a mission-critical capacity.

  • ForgeRock product documentation, such as this document, aims to be technically accurate and complete with respect to the software documented. It is visible to everyone and covers all product features and examples of how to use them.

B.2. Using the ForgeRock.org Site

The ForgeRock.org site has links to source code for ForgeRock open source software, as well as links to the ForgeRock forums and technical blogs.

If you are a ForgeRock customer, raise a support ticket instead of using the forums. ForgeRock support professionals will get in touch to help you.

B.3. Getting Support and Contacting ForgeRock

ForgeRock provides support services, professional services, training through ForgeRock University, and partner services to assist you in setting up and maintaining your deployments. For a general overview of these services, see https://www.forgerock.com.

ForgeRock has staff members around the globe who support our international customers and partners. For details, visit https://www.forgerock.com, or send an email to ForgeRock at info@forgerock.com.

Read a different version of :