<?xml version="1.0" encoding="utf-8"?>
|
<!--
|
! CDDL HEADER START
|
!
|
! The contents of this file are subject to the terms of the
|
! Common Development and Distribution License, Version 1.0 only
|
! (the "License"). You may not use this file except in compliance
|
! with the License.
|
!
|
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
! or http://forgerock.org/license/CDDLv1.0.html.
|
! See the License for the specific language governing permissions
|
! and limitations under the License.
|
!
|
! When distributing Covered Code, include this CDDL HEADER in each
|
! file and include the License file at legal-notices/CDDLv1_0.txt.
|
! If applicable, add the following below this CDDL HEADER, with the
|
! fields enclosed by brackets "[]" replaced with your own identifying
|
! information:
|
! Portions Copyright [yyyy] [name of copyright owner]
|
!
|
! CDDL HEADER END
|
!
|
!
|
! Copyright 2007-2008 Sun Microsystems, Inc.
|
! Portions Copyright 2013 ForgeRock AS
|
! -->
|
<adm:managed-object name="file-based-key-manager-provider"
|
plural-name="file-based-key-manager-providers"
|
package="org.opends.server.admin.std" extends="key-manager-provider"
|
xmlns:adm="http://www.opends.org/admin"
|
xmlns:ldap="http://www.opends.org/admin-ldap">
|
<adm:synopsis>
|
The
|
<adm:user-friendly-name />
|
can be used to obtain the server certificate from a key store file on
|
the local file system.
|
</adm:synopsis>
|
<adm:description>
|
Multiple file formats may be supported, depending on the providers
|
supported by the underlying Java runtime environment.
|
</adm:description>
|
<adm:profile name="ldap">
|
<ldap:object-class>
|
<ldap:name>ds-cfg-file-based-key-manager-provider</ldap:name>
|
<ldap:superior>ds-cfg-key-manager-provider</ldap:superior>
|
</ldap:object-class>
|
</adm:profile>
|
<adm:property-override name="java-class" advanced="true">
|
<adm:default-behavior>
|
<adm:defined>
|
<adm:value>
|
org.opends.server.extensions.FileBasedKeyManagerProvider
|
</adm:value>
|
</adm:defined>
|
</adm:default-behavior>
|
</adm:property-override>
|
<adm:property name="key-store-file" mandatory="true">
|
<adm:TODO>Should use a file-based property definition?</adm:TODO>
|
<adm:synopsis>
|
Specifies the path to the file that contains the private key
|
information. This may be an absolute path, or a path that is
|
relative to the
|
<adm:product-name />
|
instance root.
|
</adm:synopsis>
|
<adm:description>
|
Changes to this property will take effect the next
|
time that the key manager is accessed.
|
</adm:description>
|
<adm:syntax>
|
<adm:string>
|
<adm:pattern>
|
<adm:regex>.*</adm:regex>
|
<adm:usage>FILE</adm:usage>
|
<adm:synopsis>
|
A path to an existing file that is readable by the server.
|
</adm:synopsis>
|
</adm:pattern>
|
</adm:string>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-key-store-file</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property name="key-store-type">
|
<adm:TODO>
|
Can we restrict this to an enumeration? How can the client guess
|
which values are possible? What is the default value?
|
</adm:TODO>
|
<adm:synopsis>
|
Specifies the format for the data in the key store file.
|
</adm:synopsis>
|
<adm:description>
|
Valid values should always include 'JKS' and 'PKCS12', but
|
different implementations may allow other values as well. If no
|
value is provided, the JVM-default value is used.
|
Changes to this configuration attribute will take effect the next
|
time that the key manager is accessed.
|
</adm:description>
|
<adm:default-behavior>
|
<adm:undefined />
|
</adm:default-behavior>
|
<adm:syntax>
|
<adm:string>
|
<adm:pattern>
|
<adm:regex>.*</adm:regex>
|
<adm:usage>STRING</adm:usage>
|
<adm:synopsis>
|
Any key store format supported by the Java runtime environment.
|
</adm:synopsis>
|
</adm:pattern>
|
</adm:string>
|
</adm:syntax>
|
<adm:profile name="ldap">
|
<ldap:attribute>
|
<ldap:name>ds-cfg-key-store-type</ldap:name>
|
</ldap:attribute>
|
</adm:profile>
|
</adm:property>
|
<adm:property-reference name="key-store-pin" />
|
<adm:property-reference name="key-store-pin-property" />
|
<adm:property-reference name="key-store-pin-environment-variable" />
|
<adm:property-reference name="key-store-pin-file" />
|
</adm:managed-object>
|
