Skip to content

Commit

Permalink
Fix documentation issues and update links (#98)
Browse files Browse the repository at this point in the history
  • Loading branch information
maximthomas authored Jan 31, 2025
1 parent 825b474 commit 4f004eb
Show file tree
Hide file tree
Showing 13 changed files with 111 additions and 111 deletions.
8 changes: 4 additions & 4 deletions openig-doc/src/main/asciidoc/gateway-guide/chap-auditing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand All @@ -23,13 +23,13 @@
[#chap-auditing]
== Auditing and Monitoring OpenIG
Routes have a `monitor` boolean attribute that you can use to have OpenIG collect statistics for the route. The statistics are then exposed as a JSON resource that you can access over HTTP. In addition, OpenIG supports the ForgeRock common audit framework. You can add an audit service to a route, and the service can then publish messages to a consumer such as a CSV file, a relational database, or the Syslog facility. In this chapter, you will learn to:
Routes have a `monitor` boolean attribute that you can use to have OpenIG collect statistics for the route. The statistics are then exposed as a JSON resource that you can access over HTTP. In addition, OpenIG supports the Open Identity Platform common audit framework. You can add an audit service to a route, and the service can then publish messages to a consumer such as a CSV file, a relational database, or the Syslog facility. In this chapter, you will learn to:
* Enable monitoring for a route
* Read monitoring statistics for a route as a JSON resource
* Add an audit service to a route to integrate with the ForgeRock common audit event framework, sometimes referred to as Common Audit
* Add an audit service to a route to integrate with the Open Identity Platform common audit event framework, sometimes referred to as Common Audit
[#monitoring]
Expand Down Expand Up @@ -107,7 +107,7 @@ By default, monitoring statistics are accessible from the local host. OpenIG use
[#audit-event-handlers]
=== Recording Audit Event Messages
The ForgeRock common audit framework is a platform-wide infrastructure to handle audit events by using common audit event handlers. The handlers record events by logging them into files, relational databases, or syslog.
The Open Identity Platform common audit framework is a platform-wide infrastructure to handle audit events by using common audit event handlers. The handlers record events by logging them into files, relational databases, or syslog.
OpenIG provides audit event handlers to write messages to the following formats:
* CSV files, with support for retention, rotation, and tamper-evident logs.
Expand Down
26 changes: 13 additions & 13 deletions openig-doc/src/main/asciidoc/gateway-guide/chap-extending.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand Down Expand Up @@ -47,7 +47,7 @@ Scriptable filters and handlers are added to the configuration in the same way a
The following example defines a `ScriptableFilter`, written in the Groovy language, and stored in a file named `$HOME/.openig/scripts/groovy/SimpleFormLogin.groovy` (`%appdata%\OpenIG\scripts\groovy\SimpleFormLogin.groovy` on Windows):
[source, java]
[source, json]
----
{
"name": "SimpleFormLogin",
Expand Down Expand Up @@ -76,7 +76,7 @@ In order to route requests, especially when the conditions are complicated, you
The following script demonstrates a simple dispatch handler:
[source, java]
[source, groovy]
----
/*
* This simplistic dispatcher matches the path part of the HTTP request.
Expand Down Expand Up @@ -124,7 +124,7 @@ To try this handler, save the script as `$HOME/.openig/scripts/groovy/DispatchHa
Next, add the following route to your configuration as `$HOME/.openig/config/routes/98-dispatch.json` (`%appdata%\OpenIG\config\routes\98-dispatch.json` on Windows):
[source, javascript]
[source, json]
----
{
"heap": [
Expand Down Expand Up @@ -191,7 +191,7 @@ HTTP Basic authentication calls for the user agent such as a browser to send a u
The following script, for use in a `ScriptableFilter`, adds an `Authorization` header based on a username and password combination:
[source, java]
[source, groovy]
----
/*
* Perform basic authentication with the user name and password
Expand Down Expand Up @@ -238,7 +238,7 @@ To try this filter, save the script as `$HOME/.openig/scripts/groovy/BasicAuthFi
Next, add the following route to your configuration as `$HOME/.openig/config/routes/09-basic.json` (`%appdata%\OpenIG\config\routes\09-basic.json` on Windows):
[source, javascript]
[source, json]
----
{
"handler": {
Expand Down Expand Up @@ -291,7 +291,7 @@ Many organizations use an LDAP directory service to store user profiles includin
The following script, for use in a `ScriptableFilter`, performs simple authentication against an LDAP server based on request form fields `username` and `password`:
[source, java]
[source, groovy]
----
import org.forgerock.opendj.ldap.*
Expand Down Expand Up @@ -374,7 +374,7 @@ For the list of methods to specify which type of objects to return, see the Open
====
To try the LDAP authentication script, follow these steps:
. Install an LDAP directory server such as ForgeRock Directory Services or OpenDJ directory server.
. Install an LDAP directory server such as OpenDJ directory server.
+
Either import some sample users who can authenticate over LDAP, or generate sample users at installation time.
Expand All @@ -385,7 +385,7 @@ If the directory server installation does not match the assumptions made in the
. Add the following route to your configuration as `$HOME/.openig/config/routes/10-ldap.json` (`%appdata%\OpenIG\config\routes\10-ldap.json` on Windows):
+
[source, javascript]
[source, json]
----
{
"handler": {
Expand Down Expand Up @@ -436,7 +436,7 @@ You can use a `ScriptableFilter` to look up information in a relational database
The following filter looks up user credentials in a database given the user's email address, which is found in the form data of the request. The script then sets the credentials in headers, making sure the scheme is HTTPS to protect the request when it leaves OpenIG:
[source, java]
[source, groovy]
----
/*
* Look up user credentials in a relational database
Expand All @@ -458,7 +458,7 @@ next.handle(context, request)
----
The previous script demonstrates a `ScriptableFilter` that uses a `SqlClient` class defined in another script. The following code listing shows the `SqlClient` class:
[source, java]
[source, groovy]
----
import groovy.sql.Sql
Expand Down Expand Up @@ -522,7 +522,7 @@ When everything in that tutorial works, you know that OpenIG can connect to the
. Add the following route to your configuration as `$HOME/.openig/config/routes/11-db.json` (`%appdata%\OpenIG\config\routes\11-db.json` on Windows):
+
[source, javascript]
[source, json]
----
{
"handler": {
Expand Down Expand Up @@ -769,7 +769,7 @@ org.forgerock.openig.doc.SampleClassAliasResolver
----
The corresponding heap object configuration then looks as follows:
[source, javascript]
[source, json]
----
{
"name": "SampleFilter",
Expand Down
6 changes: 3 additions & 3 deletions openig-doc/src/main/asciidoc/gateway-guide/chap-logging.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand Down Expand Up @@ -42,7 +42,7 @@ When no other logging is configured, all log messages are sent to the default `C
To override the default logging for all heap objects, change the default values for the `ConsoleLogSink` object in `config.json`. The following example from `config.json` writes all log messages to file instead of to console, using a `FileLogSink` named `LogSink`.
[source, javascript]
[source, json]
----
{
"name": "LogSink",
Expand Down Expand Up @@ -72,7 +72,7 @@ To override the default logging for specific heap objects only, create a `Consol
}
}
----
Log messages from third-party dependencies, such as the ForgeRock common audit framework, are managed by SLF4J. Messages with level `INFO` are displayed on the console and written to `$HOME/.openig/logs/route-system.log`.
Log messages from third-party dependencies, such as the Open Identity Platform common audit framework, are managed by SLF4J. Messages with level `INFO` are displayed on the console and written to `$HOME/.openig/logs/route-system.log`.
The default configuration of SLF4J log messages is defined in OpenIG. Log messages are highlighted with a color related to their logging level. Exception titles and the top line of the stack trace are displayed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand Down Expand Up @@ -140,7 +140,7 @@ If the profile already exists in the table, then click the link to open the prof
To configure OpenIG as an OpenID Connect 1.0 relying party, add a new route to the OpenIG configuration, by including the following route configuration file as `$HOME/.openig/config/routes/07-openid.json`:
[source, javascript]
[source, json]
----
{
"heap": [
Expand Down Expand Up @@ -317,7 +317,7 @@ Follow these steps to add a route demonstrating OpenID Connect discovery and dyn
. Add a new route to the OpenIG configuration, by including the following route configuration file as `$HOME/.openig/config/routes/07-discovery.json`:
+
[source, javascript]
[source, json]
----
{
"heap": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand Down Expand Up @@ -77,7 +77,7 @@ OpenIG should be running in Jetty, configured to access the minimal HTTP server
Edit `config.json` to make sure that the `CaptureDecorator` also captures the context. After you make the changes, the object declaration appears as follows:
[source, javascript]
[source, json]
----
{
"name": "capture",
Expand Down Expand Up @@ -160,7 +160,7 @@ If no access token is present in the request, or token validation does not compl
To configure OpenIG as an OAuth 2.0 resource server, add a new route to the OpenIG configuration by including the following route configuration file as `$HOME/.openig/config/routes/06-rs.json`:
[source, javascript]
[source, json]
----
{
"handler": {
Expand Down
8 changes: 4 additions & 4 deletions openig-doc/src/main/asciidoc/partials/sec-release-levels.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
[appendix]
[#appendix-interface-stability]
== Release Levels and Interface Stability
This appendix includes ForgeRock definitions for product release levels and interface stability.
This appendix includes definitions for product release levels and interface stability.
[#release-levels]
=== ForgeRock Product Release Levels
=== Product Release Levels
ForgeRock defines Major, Minor, and Maintenance product release levels. The release level is reflected in the version number. The release level tells you what sort of compatibility changes to expect.
Open Identity Platform Community defines Major, Minor, and Maintenance product release levels. The release level is reflected in the version number. The release level tells you what sort of compatibility changes to expect.
[#table-release-levels]
.Table A.1. Release Level Definitions
Expand Down
22 changes: 11 additions & 11 deletions openig-doc/src/main/asciidoc/reference/audit-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
information: "Portions copyright [year] [name of copyright owner]".

Copyright 2017 ForgeRock AS.
Portions Copyright 2024 3A Systems LLC.
Portions Copyright 2024-2025 3A Systems LLC.
////
:figure-caption!:
Expand All @@ -23,13 +23,13 @@
[#audit-conf]
== Audit Framework
OpenIG uses the ForgeRock common audit framework to log system boundary events using an implementation that is common across the ForgeRock platform.
OpenIG uses the Open Identity Platform common audit framework to log system boundary events using an implementation that is common across the ForgeRock platform.
[#AuditService]
=== AuditService — enable common audit service for a route
[#d210e10012]
==== Description
This object serves to configure the audit service for a route. The audit service uses the ForgeRock common audit event framework.
This object serves to configure the audit service for a route. The audit service uses the Open Identity Platform common audit event framework.
The route is decorated with an `auditService` field whose value references the configuration, either inline or from the heap.
Expand Down Expand Up @@ -142,7 +142,7 @@ OpenIG supports the following audit event handlers:
==== Example
The following example configures an audit service to log access event messages in a comma-separated variable file, named `/path/to/audit/logs/access.csv`:
[source, javascript]
[source, json]
----
{
"name": "AuditService",
Expand All @@ -166,7 +166,7 @@ The following example configures an audit service to log access event messages i
----
The following example route uses the audit service:
[source, javascript]
[source, json]
----
{
"handler": "ClientHandler",
Expand Down Expand Up @@ -469,7 +469,7 @@ The durations, counting from midnight, after which to rotate files.
The following example schedules rotation six and twelve hours after midnight:
+
[source, javascript]
[source, json]
----
"rotationTimes": [ "6 hours", "12 hours" ]
----
Expand Down Expand Up @@ -612,7 +612,7 @@ For instructions on recording audit events in a CSV file, see xref:../gateway-gu
The following example configures a CSV audit event handler to write a log file, `/path/to/audit/logs/access.csv`, that is signed every 10 seconds to make it tamper-evident:
[source, javascript]
[source, json]
----
{
"name": "csv",
Expand Down Expand Up @@ -881,7 +881,7 @@ Audit event fields use JSON pointer notation, and are taken from the JSON schema
==== Example
The following example configures a JDBC audit event handler using a local MySQL database, writing to a table named `auditaccess`:
[source, javascript]
[source, json]
----
{
"class": "org.forgerock.audit.handlers.jdbc.JdbcAuditEventHandler",
Expand Down Expand Up @@ -1178,7 +1178,7 @@ Debug-level messages.
==== Example
The following example configures a Syslog audit event handler that writes to the system log daemon on `syslogd.example.com`, port `6514` over TCP with a timeout of 30 seconds. The facility is the first one for local use, and response status is mapped to Syslog informational messages:
[source, javascript]
[source, json]
----
{
"class": "org.forgerock.audit.handlers.syslog.SyslogAuditEventHandler",
Expand Down Expand Up @@ -1222,7 +1222,7 @@ A special client handler called `ElasticsearchClientHandler` can be defined to s
To define an `ElasticsearchClientHandler`, create the following object in the heap for the Elasticsearch audit event handler
[source, javascript]
[source, json]
----
{
"name": "ElasticsearchClientHandler",
Expand Down Expand Up @@ -1388,7 +1388,7 @@ For instructions on recording audit events in Elasticsearch, see xref:../gateway
The following example configures an Elasticsearch audit event handler:
[source, javascript]
[source, json]
----
{
"class" : "org.forgerock.audit.handlers.elasticsearch.ElasticsearchAuditEventHandler",
Expand Down
Loading

0 comments on commit 4f004eb

Please sign in to comment.