Skip to content
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
6 changes: 3 additions & 3 deletions openig-doc/src/main/asciidoc/gateway-guide/chap-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ In this chapter, you will learn to:
+
Make sure you have a supported Java Development Kit installed.
+
This release of OpenIG requires Java Development Kit 8, 11, 17 or 21 LTS version. Open Identity Platform Community recommends the most recent update to ensure you have the latest security fixes.
This release of OpenIG requires Java Development Kit 11, 17, 21 or 25 LTS version. Open Identity Platform Community recommends the most recent update to ensure you have the latest security fixes.

* Prepare a deployment container.
+
Expand Down Expand Up @@ -98,7 +98,7 @@ The Java Secure Socket Extension (JSSE), part of the Java environment, provides
==== Configuring Apache Tomcat For OpenIG

This section describes essential Tomcat configuration that you need in order to run OpenIG.
Download and install a supported version of Tomcat from link:http://tomcat.apache.org/[http://tomcat.apache.org/, window=\_blank].
Download and install a supported version of Tomcat from link:https://tomcat.apache.org/[https://tomcat.apache.org/, window=\_blank].

Configure Tomcat to use the same protocol as the application you are protecting with OpenIG. If the protected application is on a remote system, configure Tomcat to use the same port as well. If your application listens on both an HTTP and an HTTPS port, then you must configure Tomcat to do so, too.

Expand Down Expand Up @@ -499,7 +499,7 @@ If some data attached to a context must be stored on the server side, then you h
How you configure session stickiness and session replication depends on your load balancer and on your container.
Tomcat can help with session stickiness, and a Tomcat cluster can handle session replication:

* If you choose to use the link:http://tomcat.apache.org/connectors-doc/[Tomcat connector, window=\_blank] (mod_jk) on your web server to perform load balancing, then see the link:http://tomcat.apache.org/connectors-doc/common_howto/loadbalancers.html[LoadBalancer HowTo, window=\_blank] for details.
* If you choose to use the link:https://tomcat.apache.org/connectors-doc/[Tomcat connector, window=\_blank] (mod_jk) on your web server to perform load balancing, then see the link:http://tomcat.apache.org/connectors-doc/common_howto/loadbalancers.html[LoadBalancer HowTo, window=\_blank] for details.
+
In the HowTo, you configure the `jvmRoute` attribute in the Tomcat server configuration, `/path/to/tomcat/conf/server.xml`, to identify the server. The connector can use this identifier to achieve session stickiness.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This chapter allows you to quickly see how OpenIG works, and provides hands-on e
Make sure you have a supported Java Development Kit installed.
This release of OpenIG requires Java Development Kit 8, 11, 17 or 21 LTS version. Open Identity Platform Community recommends the most recent update to ensure you have the latest security fixes.
This release of OpenIG requires Java Development Kit 11, 17, 21 or 25 LTS version. Open Identity Platform Community recommends the most recent update to ensure you have the latest security fixes.
[#quickstart-install]
Expand Down
4 changes: 2 additions & 2 deletions openig-doc/src/main/asciidoc/reference/audit-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ The prefix to add to a log file on rotation.
This has an effect when time-based file rotation is enabled.

`"rotationFileSuffix"`: __string, optional__::
The suffix to add to a log file on rotation, possibly expressed in link:http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html[SimpleDateFormat, window=\_blank].
The suffix to add to a log file on rotation, possibly expressed in link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/text/SimpleDateFormat.html[SimpleDateFormat, window=\_blank].

+
This has an effect when time-based file rotation is enabled.
Expand Down Expand Up @@ -648,7 +648,7 @@ Whether the events are automatically flushed after being written.
Default: true.

`"maxBatchedEvents"`: __number, optional__::
The maximum number of event messages batched into a link:http://docs.oracle.com/javase/7/docs/api/java/sql/PreparedStatement.html[PreparedStatement, window=\_blank].
The maximum number of event messages batched into a link:https://docs.oracle.com/en/java/javase/11/docs/api/java.sql/java/sql/PreparedStatement.html[PreparedStatement, window=\_blank].

+
Default: 100.
Expand Down
14 changes: 7 additions & 7 deletions openig-doc/src/main/asciidoc/reference/expressions-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ the string containing the joined strings.
----
keyMatch(map, pattern)
----
Returns the first key found in a map that matches the specified link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[regular expression pattern, window=\_blank], or `null` if no such match is found.
Returns the first key found in a map that matches the specified link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[regular expression pattern, window=\_blank], or `null` if no such match is found.
.Parameters
--

Expand Down Expand Up @@ -405,7 +405,7 @@ the length of the object, or 0 if length could not be determined.
----
matchingGroups(string, pattern)
----
Returns an array of matching groups for the specified link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[regular expression pattern, window=\_blank] applied to the specified string, or `null` if no such match is found. The first element of the array is the entire match, and each subsequent element correlates to any capture group specified within the regular expression.
Returns an array of matching groups for the specified link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[regular expression pattern, window=\_blank] applied to the specified string, or `null` if no such match is found. The first element of the array is the entire match, and each subsequent element correlates to any capture group specified within the regular expression.
.Parameters
--

Expand All @@ -431,7 +431,7 @@ an array of matching groups, or `null` if no such match is found.
----
matches(string, pattern)
----
Returns `true` if the string contains a match for the specified link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[regular expression pattern, window=\_blank].
Returns `true` if the string contains a match for the specified link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[regular expression pattern, window=\_blank].
.Parameters
--

Expand Down Expand Up @@ -509,7 +509,7 @@ The key/value map of properties or `null` on error.
----
split(string, pattern)
----
Splits the specified string into an array of substrings around matches for the specified link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[regular expression pattern, window=\_blank].
Splits the specified string into an array of substrings around matches for the specified link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[regular expression pattern, window=\_blank].
.Parameters
--

Expand Down Expand Up @@ -866,15 +866,15 @@ Other functions are provided by link:{apidocs-url}/index.html?org/forgerock/http

[#d210e17106]
==== Description
Patterns in configuration parameters and expressions use the standard Java regular expression link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[Pattern, window=\_blank] class. For more information on regular expressions, see Oracle's link:http://docs.oracle.com/javase/tutorial/essential/regex/index.html[tutorial on Regular Expressions, window=\_blank].
Patterns in configuration parameters and expressions use the standard Java regular expression link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[Pattern, window=\_blank] class. For more information on regular expressions, see Oracle's link:http://docs.oracle.com/javase/tutorial/essential/regex/index.html[tutorial on Regular Expressions, window=\_blank].

[#d210e17122]
==== Pattern Templates
A regular expression pattern template expresses a transformation to be applied for a matching regular expression pattern. It may contain references to link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html#cg[capturing groups, window=\_blank] within the match result. Each occurrence of `$g` (where __g__ is an integer value) is substituted by the indexed capturing group in a match result. Capturing group zero `"$0"` denotes the entire pattern match. A dollar sign or numeral literal immediately following a capture group reference can be included as a literal in the template by preceding it with a backslash ( `\` ). Backslash itself must be also escaped in this manner.
A regular expression pattern template expresses a transformation to be applied for a matching regular expression pattern. It may contain references to link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html#cg[capturing groups, window=\_blank] within the match result. Each occurrence of `$g` (where __g__ is an integer value) is substituted by the indexed capturing group in a match result. Capturing group zero `"$0"` denotes the entire pattern match. A dollar sign or numeral literal immediately following a capture group reference can be included as a literal in the template by preceding it with a backslash ( `\` ). Backslash itself must be also escaped in this manner.

[#d210e17142]
==== See Also
Java link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[Pattern, window=\_blank] class
Java link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[Pattern, window=\_blank] class

link:http://docs.oracle.com/javase/tutorial/essential/regex/index.html[Regular Expressions tutorial, window=\_blank]

Expand Down
2 changes: 1 addition & 1 deletion openig-doc/src/main/asciidoc/reference/filters-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1832,7 +1832,7 @@ This context is the leaf of a chain of contexts. It provides access to other Con
The HTTP link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[request, window=\_blank].

`globals`::
This object is a link:http://groovy.codehaus.org/groovy-jdk/index.html?java/util/Map.html[Map, window=\_blank] that holds variables that persist across successive invocations.
This object is a link:https://docs.groovy-lang.org/latest/html/groovy-jdk/java/util/Map.html[Map, window=\_blank] that holds variables that persist across successive invocations.

`http`::
An embedded client for making outbound HTTP requests, which is an link:{apidocs-url}/index.html?org/forgerock/http/Client.html[org.forgerock.http.Client, window=\_blank].
Expand Down
4 changes: 2 additions & 2 deletions openig-doc/src/main/asciidoc/reference/handlers-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@ For details about the available cipher suite names, see the documentation for th
Default: Allow any cipher suite supported by the JVM.

`"sslContextAlgorithm"`: __string, optional__::
The `SSLContext` algorithm name, as listed in the table of link:http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html#SSLContext[SSLContext Algorithms, window=\_blank] for the Java Virtual Machine used by the container where OpenIG runs.
The `SSLContext` algorithm name, as listed in the table of link:https://docs.oracle.com/en/java/javase/11/docs/specs/security/standard-names.html#sslcontext-algorithms[SSLContext Algorithms, window=\_blank] for the Java Virtual Machine used by the container where OpenIG runs.

+
Default: `TLS`
Expand Down Expand Up @@ -1020,7 +1020,7 @@ This context is the leaf of a chain of contexts. It provides access to other Con
The HTTP link:{apidocs-url}/index.html?org/forgerock/http/protocol/Request.html[request, window=\_blank].

`globals`::
This object is a link:http://groovy.codehaus.org/groovy-jdk/index.html?java/util/Map.html[Map, window=\_blank] that holds variables that persist across successive invocations.
This object is a link:https://docs.groovy-lang.org/latest/html/groovy-jdk/java/util/Map.html[Map, window=\_blank] that holds variables that persist across successive invocations.

`http`::
An embedded client for making outbound HTTP requests, which is an link:{apidocs-url}/index.html?org/forgerock/http/Client.html[org.forgerock.http.Client, window=\_blank].
Expand Down
14 changes: 7 additions & 7 deletions openig-doc/src/main/asciidoc/reference/misc-conf.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ link:{apidocs-url}/index.html?org/forgerock/openig/jwt/JwtSessionManager.html[or

[#d210e14510]
==== Description
This represents the configuration for a Java Secure Socket Extension link:http://docs.oracle.com/javase/7/docs/api/index.html?javax/net/ssl/KeyManager.html[KeyManager, window=\_blank], which manages the keys used to authenticate an SSLSocket to a peer. The configuration references the keystore that actually holds the keys.
This represents the configuration for a Java Secure Socket Extension link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/KeyManager.html[KeyManager, window=\_blank], which manages the keys used to authenticate an SSLSocket to a peer. The configuration references the keystore that actually holds the keys.

[#d210e14523]
==== Usage
Expand Down Expand Up @@ -391,15 +391,15 @@ link:{apidocs-url}/index.html?org/forgerock/openig/security/KeyManagerHeaplet.ht

[#d210e14599]
==== See Also
link:http://docs.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE Reference Guide, window=\_blank], xref:#KeyStore[KeyStore(5)], xref:#TrustManager[TrustManager(5)]
link:https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-jsse-reference-guide.html[JSSE Reference Guide, window=\_blank], xref:#KeyStore[KeyStore(5)], xref:#TrustManager[TrustManager(5)]

'''
[#KeyStore]
=== KeyStore — configure a Java KeyStore

[#d210e14624]
==== Description
This represents the configuration for a Java link:http://docs.oracle.com/javase/7/docs/api/index.html?java/security/KeyStore.html[KeyStore, window=\_blank], which stores cryptographic private keys and public key certificates.
This represents the configuration for a Java link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/security/KeyStore.html[KeyStore, window=\_blank], which stores cryptographic private keys and public key certificates.

[#d210e14637]
==== Usage
Expand Down Expand Up @@ -469,7 +469,7 @@ link:{apidocs-url}/index.html?org/forgerock/openig/security/KeyStoreHeaplet.html

[#d210e14718]
==== See Also
link:http://docs.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE Reference Guide, window=\_blank], xref:#KeyManager[KeyManager(5)], xref:#TrustManager[TrustManager(5)]
link:https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-jsse-reference-guide.html[JSSE Reference Guide, window=\_blank], xref:#KeyManager[KeyManager(5)], xref:#TrustManager[TrustManager(5)]

'''
[#Issuer]
Expand Down Expand Up @@ -565,7 +565,7 @@ In summary when the OpenID Provider is not known in advance, it might be possibl
To use this shortcut, OpenIG extracts the domain from the user input, and looks for an issuer whose supported domains list contains a match.

+
Supported domains patterns match host names with optional port numbers. Do not specify a URI scheme such as HTTP. OpenIG adds the scheme. For instance, `*.example.com` matches any host in the `example.com` domain. You can specify the port number as well as in `host.example.com:8443`. Patterns must be valid regular expression patterns according to the rules for the Java link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[Pattern, window=\_blank] class.
Supported domains patterns match host names with optional port numbers. Do not specify a URI scheme such as HTTP. OpenIG adds the scheme. For instance, `*.example.com` matches any host in the `example.com` domain. You can specify the port number as well as in `host.example.com:8443`. Patterns must be valid regular expression patterns according to the rules for the Java link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[Pattern, window=\_blank] class.

--

Expand Down Expand Up @@ -765,7 +765,7 @@ link:{apidocs-url}/index.html?org/forgerock/openig/io/TemporaryStorage.html[org.

[#d210e15306]
==== Description
This represents the configuration for a Java Secure Socket Extension link:http://docs.oracle.com/javase/7/docs/api/index.html?javax/net/ssl/TrustManager.html[TrustManager, window=\_blank], which manages the trust material (typically X.509 public key certificates) used to decide whether to accept the credentials presented by a peer. The configuration references the keystore that actually holds the trust material.
This represents the configuration for a Java Secure Socket Extension link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/javax/net/ssl/TrustManager.html[TrustManager, window=\_blank], which manages the trust material (typically X.509 public key certificates) used to decide whether to accept the credentials presented by a peer. The configuration references the keystore that actually holds the trust material.

[#d210e15319]
==== Usage
Expand Down Expand Up @@ -830,7 +830,7 @@ link:{apidocs-url}/index.html?org/forgerock/openig/security/TrustManagerHeaplet.

[#d210e15376]
==== See Also
link:http://docs.oracle.com/javase/7/docs/technotes/guides/security/jsse/JSSERefGuide.html[JSSE Reference Guide, window=\_blank], xref:#KeyManager[KeyManager(5)], xref:#KeyStore[KeyStore(5)]
link:https://docs.oracle.com/en/java/javase/11/security/java-secure-socket-extension-jsse-reference-guide.html[JSSE Reference Guide, window=\_blank], xref:#KeyManager[KeyManager(5)], xref:#KeyStore[KeyStore(5)]

'''
[#TrustAllManager]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ This is one of the contexts described in xref:#Contexts[Contexts(5)].
The portion of the request URI that matched the URI template.

`"originalUri"`: URI::
The original target link:https://docs.oracle.com/javase/7/docs/api/index.html?java/net/URI.html[URI, window=\_blank] for the request, as received by the web container.
The original target link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URI.html[URI, window=\_blank] for the request, as received by the web container.

+
The value of this field is read-only.
Expand Down
2 changes: 1 addition & 1 deletion openig-doc/src/main/asciidoc/reference/preface.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ link:http://json.org[JSON, window=\_blank] object where the content depends on t

[#definition-pattern]
pattern::
A regular expression according to the rules for the Java link:http://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html[Pattern, window=\_blank] class.
A regular expression according to the rules for the Java link:https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Pattern.html[Pattern, window=\_blank] class.

[#definition-pattern-template]
pattern-template::
Expand Down