Synchronized core docs from refs/heads/main

infinispan · Aug 19, 2024 · 2f06f3c · 2f06f3c
1 parent 9d7159e
commit 2f06f3c
Show file tree

Hide file tree

Showing 24 changed files with 101 additions and 57 deletions.
diff --git a/docs/dev/cheat-sheets/cache-configuration.html b/docs/dev/cheat-sheets/cache-configuration.html
@@ -1176,7 +1176,7 @@ <h2 id="configuration_formats"><a class="anchor" href="#configuration_formats"><
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/index.html b/docs/dev/index.html
@@ -614,7 +614,7 @@ <h2 id="developing_applications_with_infinispan" class="discrete">Developing app
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/cli/cli.html b/docs/dev/titles/cli/cli.html
@@ -6392,7 +6392,7 @@ <h4 id="see_also_32"><a class="anchor" href="#see_also_32"></a>8.43.4. SEE ALSO<
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/configuring/configuring.html b/docs/dev/titles/configuring/configuring.html
@@ -13148,7 +13148,7 @@ <h4 id="asynchronous_thread_pool" class="discrete">Asynchronous thread pool</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/contributing/contributing.html b/docs/dev/titles/contributing/contributing.html
@@ -3684,7 +3684,7 @@ <h3 id="infinispan_methods_and_corresponding_verbs"><a class="anchor" href="#inf
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/developing/developing.html b/docs/dev/titles/developing/developing.html
@@ -536,7 +536,7 @@ <h1>Infinispan Developer Guide</h1>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/embedding/embedding.html b/docs/dev/titles/embedding/embedding.html
@@ -7230,7 +7230,7 @@ <h3 id="extending_the_configuration_builders_and_parsers"><a class="anchor" href
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/encoding/encoding.html b/docs/dev/titles/encoding/encoding.html
@@ -2612,7 +2612,7 @@ <h3 id="converting-data-on-demand_transcoding"><a class="anchor" href="#converti
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/getting_started/getting_started.html b/docs/dev/titles/getting_started/getting_started.html
@@ -746,7 +746,7 @@ <h3 id="mvn_archetypes"><a class="anchor" href="#mvn_archetypes"></a>1.2. Genera
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/hibernate/hibernate.html b/docs/dev/titles/hibernate/hibernate.html
@@ -1473,7 +1473,7 @@ <h3 id="using_minimal_puts"><a class="anchor" href="#using_minimal_puts"></a>1.6
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/hotrod_java/hotrod_java.html b/docs/dev/titles/hotrod_java/hotrod_java.html
@@ -3535,7 +3535,7 @@ <h4 id="adding_the_test_container_to_your_project_dependencies"><a class="anchor
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/hotrod_protocol/hotrod_protocol.html b/docs/dev/titles/hotrod_protocol/hotrod_protocol.html
@@ -8195,7 +8195,7 @@ <h3 id="hot_rod_protocol_3_1"><a class="anchor" href="#hot_rod_protocol_3_1"></a
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/memcached/memcached.html b/docs/dev/titles/memcached/memcached.html
@@ -689,7 +689,7 @@ <h4 id="individual_statistics"><a class="anchor" href="#individual_statistics"><
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/query/query.html b/docs/dev/titles/query/query.html
@@ -3748,7 +3748,7 @@ <h3 id="tuning-query-performance_query-monitoring-tuning"><a class="anchor" href
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/resp/resp-endpoint.html b/docs/dev/titles/resp/resp-endpoint.html
@@ -1487,7 +1487,7 @@ <h3 id="redis-commands_resp-endpoint"><a class="anchor" href="#redis-commands_re
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/rest/rest.html b/docs/dev/titles/rest/rest.html
@@ -7625,7 +7625,7 @@ <h3 id="rest_server_client_http"><a class="anchor" href="#rest_server_client_htt
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/security/security.html b/docs/dev/titles/security/security.html
@@ -559,7 +559,11 @@ <h1>Infinispan Security Guide</h1>
 <ul class="sectlevel2">
 <li><a href="#creating-security-realms_security-realms">3.1. Creating security realms</a></li>
 <li><a href="#setting-up-kerberos-identities_security-realms">3.2. Setting up Kerberos identities</a></li>
-<li><a href="#property-security-realms_security-realms">3.3. Property realms</a></li>
+<li><a href="#property-security-realms_security-realms">3.3. Property realms</a>
+<ul class="sectlevel3">
+<li><a href="#property_realm_file_structure">3.3.1. Property realm file structure</a></li>
+</ul>
+</li>
 <li><a href="#ldap-security-realms_security-realms">3.4. LDAP realms</a>
 <ul class="sectlevel3">
 <li><a href="#ldap_connection_properties">3.4.1. LDAP connection properties</a></li>
@@ -1942,22 +1946,6 @@ <h3 id="property-security-realms_security-realms"><a class="anchor" href="#prope
 </li>
 </ul>
 </div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-note" title="Note"></i>
-</td>
-<td class="content">
-<div class="paragraph">
-<p>You can avoid authentication issues that relate to a property file by using the Infinispan CLI to enter the correct security realm name to the file.
-You can find the correct security realm name of your Infinispan Server by opening the <code>infinispan.xml</code> file and navigating to the <code>&lt;security-realm name&gt;</code> property.
-When you copy a property file from one Infinispan Server to another, make sure that the security realm name appropriates to the correct authentication mechanism for the target endpoint.</p>
-</div>
-</td>
-</tr>
-</table>
-</div>
 <div class="listingblock">
 <div class="title">users.properties</div>
 <div class="content">
@@ -2042,6 +2030,38 @@ <h4 id="property_realm_configuration" class="discrete">Property realm configurat
             relative-to: 'infinispan.server.config.path'</code></pre>
 </div>
 </div>
+<div class="sect3">
+<h4 id="property_realm_file_structure"><a class="anchor" href="#property_realm_file_structure"></a>3.3.1. Property realm file structure</h4>
+<div class="paragraph">
+<p>User properties files are structured as follows:</p>
+</div>
+<div class="listingblock">
+<div class="title">users.properties structure</div>
+<div class="content">
+<pre class="highlight nowrap"><code>#$REALM_NAME=default$
+#$ALGORITHM=encrypted$
+#Wed Jul 31 08:32:08 CEST 2024
+admin=algorithm-1\:hash-1;algorithm-2\:hash-2;...</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The first three lines are special comments that define the name of the realm (<code>$REALM_NAME</code>), whether the passwords are
+stored in <code>clear</code> or <code>encrypted</code> format (<code>$ALGORITHM</code>) and the timestamp of the last update.</p>
+</div>
+<div class="paragraph">
+<p>User credentials are stored in traditional key/value format: the key corresponds to the username and the value
+corresponds to the password. Encrypted passwords are represented as semi-colon-separated algorithm/hash pairs, with the
+hash encoded in Base64.</p>
+</div>
+<div class="exampleblock">
+<div class="content">
+<div class="paragraph">
+<p>Credentials are encrypted using the realm name. Changing a realm&#8217;s name requires re-encrypting all the passwords.
+Use the Infinispan CLI to enter the correct security realm name to the file.</p>
+</div>
+</div>
+</div>
+</div>
 </div>
 <div class="sect2">
 <h3 id="ldap-security-realms_security-realms"><a class="anchor" href="#ldap-security-realms_security-realms"></a>3.4. LDAP realms</h3>
@@ -6093,7 +6113,7 @@ <h4 id="cross_site_replication" class="discrete">Cross-site replication</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/server/server.html b/docs/dev/titles/server/server.html
@@ -615,7 +615,11 @@ <h1>Guide to Infinispan Server</h1>
 <ul class="sectlevel2">
 <li><a href="#creating-security-realms_security-realms">5.1. Creating security realms</a></li>
 <li><a href="#setting-up-kerberos-identities_security-realms">5.2. Setting up Kerberos identities</a></li>
-<li><a href="#property-security-realms_security-realms">5.3. Property realms</a></li>
+<li><a href="#property-security-realms_security-realms">5.3. Property realms</a>
+<ul class="sectlevel3">
+<li><a href="#property_realm_file_structure">5.3.1. Property realm file structure</a></li>
+</ul>
+</li>
 <li><a href="#ldap-security-realms_security-realms">5.4. LDAP realms</a>
 <ul class="sectlevel3">
 <li><a href="#ldap_connection_properties">5.4.1. LDAP connection properties</a></li>
@@ -4373,22 +4377,6 @@ <h3 id="property-security-realms_security-realms"><a class="anchor" href="#prope
 </li>
 </ul>
 </div>
-<div class="admonitionblock note">
-<table>
-<tr>
-<td class="icon">
-<i class="fa icon-note" title="Note"></i>
-</td>
-<td class="content">
-<div class="paragraph">
-<p>You can avoid authentication issues that relate to a property file by using the Infinispan CLI to enter the correct security realm name to the file.
-You can find the correct security realm name of your Infinispan Server by opening the <code>infinispan.xml</code> file and navigating to the <code>&lt;security-realm name&gt;</code> property.
-When you copy a property file from one Infinispan Server to another, make sure that the security realm name appropriates to the correct authentication mechanism for the target endpoint.</p>
-</div>
-</td>
-</tr>
-</table>
-</div>
 <div class="listingblock">
 <div class="title">users.properties</div>
 <div class="content">
@@ -4473,6 +4461,38 @@ <h4 id="property_realm_configuration" class="discrete">Property realm configurat
             relative-to: 'infinispan.server.config.path'</code></pre>
 </div>
 </div>
+<div class="sect3">
+<h4 id="property_realm_file_structure"><a class="anchor" href="#property_realm_file_structure"></a>5.3.1. Property realm file structure</h4>
+<div class="paragraph">
+<p>User properties files are structured as follows:</p>
+</div>
+<div class="listingblock">
+<div class="title">users.properties structure</div>
+<div class="content">
+<pre class="highlight nowrap"><code>#$REALM_NAME=default$
+#$ALGORITHM=encrypted$
+#Wed Jul 31 08:32:08 CEST 2024
+admin=algorithm-1\:hash-1;algorithm-2\:hash-2;...</code></pre>
+</div>
+</div>
+<div class="paragraph">
+<p>The first three lines are special comments that define the name of the realm (<code>$REALM_NAME</code>), whether the passwords are
+stored in <code>clear</code> or <code>encrypted</code> format (<code>$ALGORITHM</code>) and the timestamp of the last update.</p>
+</div>
+<div class="paragraph">
+<p>User credentials are stored in traditional key/value format: the key corresponds to the username and the value
+corresponds to the password. Encrypted passwords are represented as semi-colon-separated algorithm/hash pairs, with the
+hash encoded in Base64.</p>
+</div>
+<div class="exampleblock">
+<div class="content">
+<div class="paragraph">
+<p>Credentials are encrypted using the realm name. Changing a realm&#8217;s name requires re-encrypting all the passwords.
+Use the Infinispan CLI to enter the correct security realm name to the file.</p>
+</div>
+</div>
+</div>
+</div>
 </div>
 <div class="sect2">
 <h3 id="ldap-security-realms_security-realms"><a class="anchor" href="#ldap-security-realms_security-realms"></a>5.4. LDAP realms</h3>
@@ -13455,7 +13475,7 @@ <h3 id="accessing-health-jmx_server"><a class="anchor" href="#accessing-health-j
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/spring/spring.html b/docs/dev/titles/spring/spring.html
@@ -994,7 +994,7 @@ <h3 id="externalizing-spring-session_externalizing-sessions-spring"><a class="an
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/spring_boot/starter.html b/docs/dev/titles/spring_boot/starter.html
@@ -1209,7 +1209,7 @@ <h2 id="spring-application-properties"><a class="anchor" href="#spring-applicati
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/tuning/tuning.html b/docs/dev/titles/tuning/tuning.html
@@ -2372,7 +2372,7 @@ <h4 id="use_simple_cache_for_local_caches" class="discrete">Use simple cache for
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/upgrading/upgrading.html b/docs/dev/titles/upgrading/upgrading.html
@@ -5046,7 +5046,7 @@ <h3 id="migrating-cache-stores_store-migrator"><a class="anchor" href="#migratin
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/titles/xsite/xsite.html b/docs/dev/titles/xsite/xsite.html
@@ -2866,7 +2866,7 @@ <h3 id="cross-site-jmx-mbeans_cross-site-operations-jmx"><a class="anchor" href=
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-16 07:04:54 UTC
+Last updated 2024-08-19 16:51:12 UTC
 </div>
 </div>
 <script type="text/x-mathjax-config">

diff --git a/docs/dev/topics/properties/server_users_structure.properties b/docs/dev/topics/properties/server_users_structure.properties
@@ -0,0 +1,4 @@
+#$REALM_NAME=default$
+#$ALGORITHM=encrypted$
+#Wed Jul 31 08:32:08 CEST 2024
+admin=algorithm-1\:hash-1;algorithm-2\:hash-2;...