Skip to content

Commit 5509c24

Browse files
author
Open Identity Platform Community
committed
upload OpenAM docs after deploy 0cc8b06df0d792d9d04ad2813e580f320f35bfaa
1 parent c92e395 commit 5509c24

File tree

97 files changed

+284
-133
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+284
-133
lines changed

‎openam/modules/ROOT/attachments/create-keystore.sh

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
#!/usr/bin/env bash
2+
#
3+
# create-keystore.sh
4+
# copyright (c) 2016 ForgeRock AS.
5+
#
6+
# Keytool must be in your path
7+
#
8+
# Author: Craig McDonnell
9+
#
10+
11+
signature_keystore=keystore-signature.jks
12+
verification_keystore=keystore-verifier.jks
13+
signature_cert=signature.cert
14+
storepass=password
15+
keypass=password
16+
storetype=JCEKS
17+
18+
# Generate the keystore-signature.jks file
19+
20+
keytool -genkeypair \
21+
-alias "Signature" \
22+
-dname CN=a \
23+
-keystore $signature_keystore \
24+
-storepass $storepass \
25+
-storetype $storetype \
26+
-keypass $keypass \
27+
-keyalg RSA \
28+
-sigalg SHA256withRSA
29+
30+
# Generate Password
31+
32+
keytool -genseckey \
33+
-alias "Password" \
34+
-keystore $signature_keystore \
35+
-storepass $storepass \
36+
-storetype $storetype \
37+
-keypass $keypass \
38+
-keyalg HmacSHA256 \
39+
-keysize 256
40+
41+
# Verify (on screen) contents of keystore-signature.jks
42+
43+
keytool -list \
44+
-keystore $signature_keystore \
45+
-storepass $storepass \
46+
-storetype $storetype
47+
48+
# Export SecretKey for verifier
49+
50+
keytool -importkeystore \
51+
-srckeystore $signature_keystore \
52+
-destkeystore $verification_keystore \
53+
-srcstoretype $storetype \
54+
-deststoretype $storetype \
55+
-srcstorepass $storepass \
56+
-deststorepass $storepass \
57+
-srcalias Password \
58+
-destalias Password \
59+
-srckeypass $keypass \
60+
-destkeypass $keypass
61+
62+
# Export the PublicKey from the signature keystore
63+
64+
keytool -exportcert \
65+
-alias "Signature" \
66+
-keystore $signature_keystore \
67+
-storepass $storepass \
68+
-storetype $storetype \
69+
-file $signature_cert
70+
71+
# Import the PublicKey into the verification keystore
72+
73+
keytool -importcert \
74+
-alias "Signature" \
75+
-keystore $verification_keystore \
76+
-storepass $storepass \
77+
-storetype $storetype \
78+
-file $signature_cert

‎openam/modules/ROOT/attachments/cts-add-indexes.txt

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
#
2+
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3+
#
4+
# Copyright (c) 2011-2018 ForgeRock AS. All Rights Reserved
5+
#
6+
# The contents of this file are subject to the terms
7+
# of the Common Development and Distribution License
8+
# (the License). You may not use this file except in
9+
# compliance with the License.
10+
#
11+
# You can obtain a copy of the License at
12+
# http://forgerock.org/license/CDDLv1.0.html
13+
# See the License for the specific language governing
14+
# permission and limitations under the License.
15+
#
16+
# When distributing Covered Code, include this CDDL
17+
# Header Notice in each file and include the License file
18+
# at http://forgerock.org/license/CDDLv1.0.html
19+
# If applicable, add the following below the CDDL Header,
20+
# with the fields enclosed by brackets [] replaced by
21+
# your own identifying information:
22+
# "Portions Copyrighted [year] [name of copyright owner]"
23+
#
24+
25+
# dsconfig batch file to add CTS indexes
26+
# 1. Save this file locally.
27+
# 2. On OpenDJ server, run:
28+
# dsconfig -p 4444 -D "cn=Directory Manager" -w password \
29+
# -F cts-add-indexes.txt -X -n
30+
31+
create-backend-index --backend-name userRoot --index-name coreTokenExpirationDate \
32+
--set index-type:ordering
33+
create-backend-index --backend-name userRoot --index-name coreTokenUserId \
34+
--set index-type:equality
35+
create-backend-index --backend-name userRoot --index-name coreTokenString01 \
36+
--set index-type:equality
37+
create-backend-index --backend-name userRoot --index-name coreTokenString02 \
38+
--set index-type:equality
39+
create-backend-index --backend-name userRoot --index-name coreTokenString03 \
40+
--set index-type:equality
41+
create-backend-index --backend-name userRoot --index-name coreTokenString05 \
42+
--set index-type:equality
43+
create-backend-index --backend-name userRoot --index-name coreTokenString08 \
44+
--set index-type:equality
45+
create-backend-index --backend-name userRoot --index-name coreTokenString09 \
46+
--set index-type:equality
47+
create-backend-index --backend-name userRoot --index-name coreTokenString10 \
48+
--set index-type:equality
49+
create-backend-index --backend-name userRoot --index-name coreTokenString14 \
50+
--set index-type:equality
51+
create-backend-index --backend-name userRoot --index-name coreTokenString15 \
52+
--set index-type:equality
53+
create-backend-index --backend-name userRoot --index-name coreTokenInteger01 \
54+
--set index-type:equality
55+
create-backend-index --backend-name userRoot --index-name coreTokenInteger02 \
56+
--set index-type:equality
57+
create-backend-index --backend-name userRoot --index-name coreTokenInteger03 \
58+
--set index-type:equality
59+
create-backend-index --backend-name userRoot --index-name coreTokenInteger04 \
60+
--set index-type:equality
61+
create-backend-index --backend-name userRoot --index-name coreTokenInteger05 \
62+
--set index-type:equality
63+
create-backend-index --backend-name userRoot --index-name coreTokenInteger06 \
64+
--set index-type:equality
65+
create-backend-index --backend-name userRoot --index-name coreTokenInteger07 \
66+
--set index-type:equality
67+
create-backend-index --backend-name userRoot --index-name coreTokenInteger08 \
68+
--set index-type:equality
69+
create-backend-index --backend-name userRoot --index-name coreTokenInteger09 \
70+
--set index-type:equality
71+
create-backend-index --backend-name userRoot --index-name coreTokenInteger10 \
72+
--set index-type:equality
73+
create-backend-index --backend-name userRoot --index-name coreTokenDate01 \
74+
--set index-type:ordering
75+
create-backend-index --backend-name userRoot --index-name coreTokenDate02 \
76+
--set index-type:equality
77+
create-backend-index --backend-name userRoot --index-name coreTokenDate03 \
78+
--set index-type:equality
79+
create-backend-index --backend-name userRoot --index-name coreTokenDate04 \
80+
--set index-type:equality
81+
create-backend-index --backend-name userRoot --index-name coreTokenDate05 \
82+
--set index-type:equality

‎openam/modules/admin-guide/pages/appendix-interface-stability.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[appendix]

‎openam/modules/admin-guide/pages/chap-admin-tools.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-admin-tools]

‎openam/modules/admin-guide/pages/chap-agents.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-agents]

‎openam/modules/admin-guide/pages/chap-audit-logging.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-audit-logging]
@@ -34,7 +34,7 @@ The Audit Logging Service uses a structured message format that adheres to a con
3434
3535
[IMPORTANT]
3636
====
37-
By default, OpenDJ 3.0 does not have audit logging enabled; thus, administrators must manually enable audit logging in the directory server. For more information, see link:https://backstage.forgerock.com/docs/opendj/3.5/admin-guide/#log-common-audit-ldap-csv[To Enable LDAP CSV Access Logs, window=\_blank] in the __OpenDJ Administration Guide__.
37+
By default, OpenDJ 3.0 does not have audit logging enabled; thus, administrators must manually enable audit logging in the directory server. For more information, see link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-monitoring#log-common-audit-ldap-csv[To Enable LDAP CSV Access Logs, window=\_blank] in the __OpenDJ Administration Guide__.
3838
====
3939
4040
[#about-audit-logs]
@@ -238,7 +238,7 @@ OpenAM also supports another level of tamper evident security by periodically ad
238238
239239
.. Click Is Enabled to turn on the tamper evident feature for CSV logs.
240240
241-
.. In the Certificate Store Location field, enter the location of the keystore. You must manually create the keystore and place it in this location. You can use a simple script to create your Java keystore: link:../resources/create-keystore.sh[create-keystore.sh, window=\_blank].
241+
.. In the Certificate Store Location field, enter the location of the keystore. You must manually create the keystore and place it in this location. You can use a simple script to create your Java keystore: xref:ROOT:attachment$create-keystore.sh[create-keystore.sh, window=\_blank].
242242
+
243243
Default: `%BASE_DIR%/%SERVER_URI%/Logger.jks`
244244

‎openam/modules/admin-guide/pages/chap-auth-services.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-auth-services]

‎openam/modules/admin-guide/pages/chap-authz-policy.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-authz-policy]

‎openam/modules/admin-guide/pages/chap-backup-restore.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-backup-restore]
@@ -28,7 +28,7 @@ OpenAM stores configuration data in an LDAP directory server and in files. The d
2828
2929
This chapter shows how to backup and restore OpenAM configuration data by backing up and restoring local configuration files and local (embedded) configuration directory server data. If your deployment uses an external configuration directory server, then refer to the documentation for your external directory server or work with your directory server administrator to back up and restore configuration data stored in the external directory service.
3030
31-
For OpenDJ directory server you can find more information in the chapter on link:https://backstage.forgerock.com/docs/opendj/3.5/admin-guide/#chap-backup-restore[Backing Up and Restoring Data, window=\_blank].
31+
For OpenDJ directory server you can find more information in the chapter on link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-backup-restore[Backing Up and Restoring Data, window=\_blank].
3232
This chapter aims to cover the following uses of backup data.
3333
3434
. Recovery from server failure:
@@ -57,7 +57,7 @@ Have the following points in mind when using this procedure:
5757
5858
* Use this procedure __only__ when OpenAM stores configuration data in the embedded OpenDJ directory server, which means that the embedded OpenDJ directory server files are co-located with other OpenAM configuration files.
5959
+
60-
If your deployment uses an external configuration directory server, then refer to the documentation for your external directory server or work with your directory server administrator to back up and restore configuration data stored in the external directory service. For OpenDJ directory server you can find more information in the chapter on link:https://backstage.forgerock.com/docs/opendj/3.5/admin-guide/#chap-backup-restore[Backing Up and Restoring Data, window=\_blank].
60+
If your deployment uses an external configuration directory server, then refer to the documentation for your external directory server or work with your directory server administrator to back up and restore configuration data stored in the external directory service. For OpenDJ directory server you can find more information in the chapter on link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-backup-restore[Backing Up and Restoring Data, window=\_blank].
6161
6262
* Do not restore configuration data from a backup of a different release of OpenAM. The structure of the configuration data can change from release to release.
6363
@@ -74,7 +74,7 @@ Replication relies on historical data to resolve any conflicts that arise. If di
7474
+
7575
When the directory server encounters a gap in historical data it cannot correctly complete replication operations. You must make sure, therefore, that any data you restore from backup is not older than the replication purge delay. Otherwise your restoration operation could break replication with the likely result that you must restore all servers from backup, losing any changes that occurred in the meantime.
7676
+
77-
For more information about purge delay, see the OpenDJ __Administration Guide__ section on link:https://backstage.forgerock.com/docs/opendj/3.5/admin-guide/#restore-replica[To Restore a Replica, window=\_blank].
77+
For more information about purge delay, see the OpenDJ __Administration Guide__ section on link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-backup-restore#restore-replica[To Restore a Replica, window=\_blank].
7878
7979
8080
Follow these steps for each OpenAM server that you want to back up:
@@ -117,7 +117,7 @@ Have the following points in mind when using this procedure:
117117
118118
* Use this procedure __only__ when OpenAM stores configuration data in the embedded OpenDJ directory server, which means that the embedded OpenDJ directory server files are co-located with other OpenAM configuration files.
119119
+
120-
If your deployment uses an external configuration directory server, then refer to the documentation for your external directory server or work with your directory server administrator to back up and restore configuration data stored in the external directory service. For OpenDJ directory server, you can find more information in the chapter on link:https://backstage.forgerock.com/docs/opendj/3.5/admin-guide/#chap-backup-restore[Backing Up and Restoring Data, window=\_blank].
120+
If your deployment uses an external configuration directory server, then refer to the documentation for your external directory server or work with your directory server administrator to back up and restore configuration data stored in the external directory service. For OpenDJ directory server, you can find more information in the chapter on link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-backup-restore[Backing Up and Restoring Data, window=\_blank].
121121
122122
* Do not restore configuration data from a backup of a different release of OpenAM. The structure of the configuration data can change from release to release.
123123
@@ -138,7 +138,7 @@ Replication relies on historical data to resolve any conflicts that arise. If di
138138
+
139139
When the directory server encounters a gap in historical data it cannot correctly complete replication operations. You must make sure, therefore, that any data you restore from backup is not older than the replication purge delay. Otherwise your restoration operation could break replication with the likely result that you must restore all servers from backup, losing any changes that occurred in the meantime.
140140
+
141-
For more information about purge delay, see the OpenDJ __Administration Guide__ section on link:https://backstage.forgerock.com/docs/opendj/3.5/admin-guide/#restore-replica[To Restore a Replica, window=\_blank].
141+
For more information about purge delay, see the OpenDJ __Administration Guide__ section on link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-backup-restore#restore-replica[To Restore a Replica, window=\_blank].
142142
143143
144144
Follow these steps for each OpenAM server to restore. If you are restoring OpenAM after a failure, make sure you make a copy of any configuration and log files that you need to investigate the problem before restoring OpenAM from backup:
@@ -217,7 +217,7 @@ Use this procedure to recover from a serious configuration error by manually res
217217
+
218218
The OpenDJ change log provides an external change log mechanism that allows you to read changes made to directory data for replicated directory servers.
219219
+
220-
For instructions on reading the change log, see the OpenDJ __Administration Guide__ section on link:https://backstage.forgerock.com/docs/opendj/3.5/admin-guide/#repl-change-notification[Change Notification For Your Applications, window=\_blank].
220+
For instructions on reading the change log, see the OpenDJ __Administration Guide__ section on link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-replication#repl-change-notification[Change Notification For Your Applications, window=\_blank].
221221
222222
. Based on the data in the change log, determine what changes would reverse the configuration error.
223223
+
@@ -229,7 +229,7 @@ For changes that resulted in one attribute value being replaced by another, you
229229
230230
. Use the OpenDJ `ldapmodify` command to apply the modification.
231231
+
232-
For instructions on making changes to directory data see the section on link:https://backstage.forgerock.com/docs/opendj/3.5/server-dev-guide/#write-ldap[Updating the Directory, window=\_blank] in the __OpenDJ Directory Server Developer's Guide__.
232+
For instructions on making changes to directory data see the section on link:https://doc.openidentityplatform.org/opendj/server-dev-guide/chap-ldap-operations#write-ldap[Updating the Directory, window=\_blank] in the __OpenDJ Directory Server Developer's Guide__.
233233
234234
====
235235

‎openam/modules/admin-guide/pages/chap-cdsso.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-cdsso]

‎openam/modules/admin-guide/pages/chap-certs-keystores.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-certs-keystores]

‎openam/modules/admin-guide/pages/chap-change-hosts.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,12 +18,13 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-change-hosts]
2525
== Changing Host Names
2626
27-
When you change the OpenAM host name, you must make manual changes to the configuration. This chapter describes what to do. If you must also move an embedded configuration directory from one host to another, see the OpenDJ __Administration Guide__ chapter, link:https://backstage.forgerock.com/docs/opendj/3.5/admin-guide/#chap-mv-servers[Moving Servers, window=\_blank].
27+
When you change the OpenAM host name, you must make manual changes to the configuration. This chapter describes what to do. If you must also move an embedded configuration directory from one host to another, see the OpenDJ __Administration Guide__ chapter, link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-mv-servers[Moving Servers, window=\_blank].
2828
Changing OpenAM host names involves the following high-level steps.
2929
3030
* Adding the new host name to the Realm/DNS Aliases list.

‎openam/modules/admin-guide/pages/chap-dashboard.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
:leveloffset: -1
21
////
32
The contents of this file are subject to the terms of the Common Development and
43
Distribution License (the License). You may not use this file except in compliance with the
@@ -19,6 +18,7 @@
1918
:figure-caption!:
2019
:example-caption!:
2120
:table-caption!:
21+
:leveloffset: -1"
2222
2323
2424
[#chap-dashboard]

0 commit comments

Comments
 (0)