Skip to content

Add missing resources & fix documentation links #798

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,9 @@ jobs:
GITHUB_TOKEN: ${{ github.token }}
run: |
cd ${{ github.event.repository.name }}.wiki
rm -rf docbkx
cp -R ../openam-documentation/openam-doc-source/target/docbkx ../${{ github.event.repository.name }}.wiki
rm -rf asciidoc
mkdir asciidoc
cp -R ../openam-documentation/openam-doc-source/target/asciidoc/pdf ../${{ github.event.repository.name }}.wiki/asciidoc
git add -A
git commit -a -m "upload docs after deploy ${{ github.sha }}"
git push --quiet --force
Expand Down
5 changes: 3 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,9 @@ jobs:
GITHUB_TOKEN: ${{ github.token }}
run: |
cd ${{ github.event.repository.name }}.wiki
rm -rf docbkx
cp -R ../openam-documentation/openam-doc-source/target/docbkx ../${{ github.event.repository.name }}.wiki
rm -rf asciidoc
mkdir asciidoc
cp -R ../openam-documentation/openam-doc-source/target/asciidoc/pdf ../${{ github.event.repository.name }}.wiki/asciidoc
git add -A
git commit -a -m "upload docs after release ${{ github.event.inputs.releaseVersion }}"
git tag -f ${{ github.event.inputs.releaseVersion }}
Expand Down
55 changes: 0 additions & 55 deletions openam-documentation/openam-doc-source/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -82,15 +82,6 @@
<groupId>org.openidentityplatform.commons</groupId>
<artifactId>doc-maven-plugin</artifactId>
<executions>
<execution>
<id>build-man-pages</id>
<phase>package</phase>
<goals>
<goal>process</goal>
<goal>build</goal>
<goal>release</goal>
</goals>
</execution>
<execution>
<id>build-man-pages-asciidoc</id>
<phase>package</phase>
Expand Down Expand Up @@ -118,54 +109,8 @@
<projectName>OpenAM</projectName>
<projectVersion>${project.version}</projectVersion>
<releaseVersion>${project.version}</releaseVersion>
<buildReleaseZip>true</buildReleaseZip>
<googleAnalyticsId />
<isDraftMode>no</isDraftMode>
<formats combine.self="override">
<format>man</format>
<format>epub</format>
<format>html</format>
<format>pdf</format>
<format>webhelp</format>
<format>xhtml5</format>
<format>bootstrap</format>
</formats>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<id>zip-docs</id>
<phase>package</phase>
<configuration>
<target>
<property name="compress_formats" value="webhelp,xhtml,html" />
<ant antfile="${basedir}/src/main/ant/zip.xml">
<target name="docs" />
</ant>&gt;
</target>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>ant-contrib</groupId>
<artifactId>ant-contrib</artifactId>
<version>${ant.contrib.version}</version>
<exclusions>
<exclusion>
<groupId>ant</groupId>
<artifactId>ant</artifactId>
</exclusion>
</exclusions>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</profile>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The Audit Logging Service uses a structured message format that adheres to a con

[IMPORTANT]
====
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__.
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__.
====

[#about-audit-logs]
Expand Down Expand Up @@ -237,7 +237,7 @@ OpenAM also supports another level of tamper evident security by periodically ad

.. Click Is Enabled to turn on the tamper evident feature for CSV logs.

.. 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].
.. 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:../attachments/create-keystore.sh[create-keystore.sh, window=\_blank].
+
Default: `%BASE_DIR%/%SERVER_URI%/Logger.jks`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ OpenAM stores configuration data in an LDAP directory server and in files. The d

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.

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].
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].
This chapter aims to cover the following uses of backup data.

. Recovery from server failure:
Expand Down Expand Up @@ -56,7 +56,7 @@ Have the following points in mind when using this procedure:

* 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.
+
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].
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].

* 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.

Expand All @@ -73,7 +73,7 @@ Replication relies on historical data to resolve any conflicts that arise. If di
+
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.
+
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].
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].


Follow these steps for each OpenAM server that you want to back up:
Expand Down Expand Up @@ -116,7 +116,7 @@ Have the following points in mind when using this procedure:

* 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.
+
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].
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].

* 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.

Expand All @@ -137,7 +137,7 @@ Replication relies on historical data to resolve any conflicts that arise. If di
+
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.
+
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].
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].


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:
Expand Down Expand Up @@ -216,7 +216,7 @@ Use this procedure to recover from a serious configuration error by manually res
+
The OpenDJ change log provides an external change log mechanism that allows you to read changes made to directory data for replicated directory servers.
+
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].
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].

. Based on the data in the change log, determine what changes would reverse the configuration error.
+
Expand All @@ -228,7 +228,7 @@ For changes that resulted in one attribute value being replaced by another, you

. Use the OpenDJ `ldapmodify` command to apply the modification.
+
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__.
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__.

====

Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
[#chap-change-hosts]
== Changing Host Names

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].
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].
Changing OpenAM host names involves the following high-level steps.

* Adding the new host name to the Realm/DNS Aliases list.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Representational State Transfer (REST) is a architectural style designed in para
image::images/openam-single.png[]
As xref:../dev-guide/chap-client-dev.adoc#sec-rest["Using the REST API"] in the __Developer's Guide__ provide language-independent access, they make it easier to build cross-device applications. Developers can use the same APIs to access OpenAM both from web applications and also from native mobile applications.

Furthermore, OpenAM REST APIs are built on an underlying common REST framework designed to provide common access to resource providers. The common REST framework standardizes how resource providers serve standard requests (create, read, update, delete, query, patch), and also how resource providers offer extended operations in a managed way (using actions). Applications built to interact with OpenAM REST APIs increasingly can interoperate with other products in the ForgeRock stack, such as link:http://forgerock.com/what-we-offer/open-identity-stack/openidm/[OpenIDM for identity management, window=\_blank] and link:http://forgerock.com/what-we-offer/open-identity-stack/opendj/[OpenDJ for highly available data, window=\_blank].
Furthermore, OpenAM REST APIs are built on an underlying common REST framework designed to provide common access to resource providers. The common REST framework standardizes how resource providers serve standard requests (create, read, update, delete, query, patch), and also how resource providers offer extended operations in a managed way (using actions). Applications built to interact with OpenAM REST APIs increasingly can interoperate with other products in the Open Identity Platform stack, such as link:https://github.com/OpenIdentityPlatform/OpenIDM[OpenIDM for identity management, window=\_blank] and link:https://github.com/OpenIdentityPlatform/OpenDJ[OpenDJ for highly available data, window=\_blank].


[#get-mobile-sample-apps]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ Make this change in every OpenAM realm that uses the embedded OpenDJ as a data s



. To change the `cn=Directory Manager` and the global administrator passwords in the embedded OpenDJ, see link:https://backstage.forgerock.com/#!/docs/opendj/3.5/admin-guide#troubleshoot-reset-admin-passwords[Resetting Administrator Passwords, window=\_blank] in the __OpenDJ Administration Guide__.
. To change the `cn=Directory Manager` and the global administrator passwords in the embedded OpenDJ, see link:https://doc.openidentityplatform.org/opendj/admin-guide/chap-troubleshooting#troubleshoot-reset-admin-passwords[Resetting Administrator Passwords, window=\_blank] in the __OpenDJ Administration Guide__.

====

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
#!/usr/bin/env bash
#
# create-keystore.sh
# copyright (c) 2016 ForgeRock AS.
#
# Keytool must be in your path
#
# Author: Craig McDonnell
#

signature_keystore=keystore-signature.jks
verification_keystore=keystore-verifier.jks
signature_cert=signature.cert
storepass=password
keypass=password
storetype=JCEKS

# Generate the keystore-signature.jks file

keytool -genkeypair \
-alias "Signature" \
-dname CN=a \
-keystore $signature_keystore \
-storepass $storepass \
-storetype $storetype \
-keypass $keypass \
-keyalg RSA \
-sigalg SHA256withRSA

# Generate Password

keytool -genseckey \
-alias "Password" \
-keystore $signature_keystore \
-storepass $storepass \
-storetype $storetype \
-keypass $keypass \
-keyalg HmacSHA256 \
-keysize 256

# Verify (on screen) contents of keystore-signature.jks

keytool -list \
-keystore $signature_keystore \
-storepass $storepass \
-storetype $storetype

# Export SecretKey for verifier

keytool -importkeystore \
-srckeystore $signature_keystore \
-destkeystore $verification_keystore \
-srcstoretype $storetype \
-deststoretype $storetype \
-srcstorepass $storepass \
-deststorepass $storepass \
-srcalias Password \
-destalias Password \
-srckeypass $keypass \
-destkeypass $keypass

# Export the PublicKey from the signature keystore

keytool -exportcert \
-alias "Signature" \
-keystore $signature_keystore \
-storepass $storepass \
-storetype $storetype \
-file $signature_cert

# Import the PublicKey into the verification keystore

keytool -importcert \
-alias "Signature" \
-keystore $verification_keystore \
-storepass $storepass \
-storetype $storetype \
-file $signature_cert
Loading