Author: smolnar
Date: Mon Oct 17 09:16:30 2022
New Revision: 1904637
URL: http://svn.apache.org/viewvc?rev=1904637&view=rev
Log:
KNOX-2797 - Document concurrent session verification
Modified:
knox/site/books/knox-2-0-0/user-guide.html
knox/site/index.html
knox/site/issue-management.html
knox/site/licenses.html
knox/site/mailing-lists.html
knox/site/project-info.html
knox/site/team.html
knox/trunk/books/2.0.0/config_knox_sso.md
Modified: knox/site/books/knox-2-0-0/user-guide.html
URL:
http://svn.apache.org/viewvc/knox/site/books/knox-2-0-0/user-guide.html?rev=1904637&r1=1904636&r2=1904637&view=diff
==============================================================================
--- knox/site/books/knox-2-0-0/user-guide.html (original)
+++ knox/site/books/knox-2-0-0/user-guide.html Mon Oct 17 09:16:30 2022
@@ -5654,6 +5654,7 @@ APACHE_HOME/bin/apachectl -k stop
<p>KnoxSSO provides an abstraction for integrating any number of
authentication systems and SSO solutions and enables participating web
applications to scale to those solutions more easily. Without the token
exchange capabilities offered by KnoxSSO each component UI would need to
integrate with each desired solution on its own. With KnoxSSO they only need to
integrate with the single solution and common token.</p>
<p>In addition, KnoxSSO comes with its own form-based IdP. This allows for
easily integrating a form-based login with the enterprise AD/LDAP server.</p>
<p>This document describes the overall setup requirements for KnoxSSO and
participating applications.</p>
+<p>In v2.0.0, the Knox team implemented an extension to the KnoxSSO feature
that controls the number of concurrent UI sessions the users can have. For more
informstion please check out the <a
href="#Concurrent+Session+Verification">Concurrent Session Verification</a>
section below.</p>
<h3><a id="Form-based+IdP+Setup">Form-based IdP Setup</a> <a
href="#Form-based+IdP+Setup"><img src="markbook-section-link.png"/></a></h3>
<p>By default the <code>knoxsso.xml</code> topology contains an application
element for the knoxauth login application. This is a simple single page
application for providing a login page and authenticating the user with HTTP
basic auth against AD/LDAP.</p>
<pre><code><application>
@@ -5821,6 +5822,58 @@ APACHE_HOME/bin/apachectl -k stop
<p>The above property holds the KnoxSSO server’s public key for
signature verification. Adding it directly to the config like this is
convenient and is easily done through Ambari to existing config files that take
custom properties. Config is generally protected as root access only as well -
so it is a pretty good solution.</p>
<p>Individual UIs within the Hadoop ecosystem will have similar configuration
for participating in the KnoxSSO websso capabilities.</p>
<p>Blogs will be provided on the Apache Knox project site for these usecases
as they become available.</p>
+<h3><a id="Concurrent+Session+Verification">Concurrent Session
Verification</a> <a href="#Concurrent+Session+Verification"><img
src="markbook-section-link.png"/></a></h3>
+<h4><a id="Overview">Overview</a> <a href="#Overview"><img
src="markbook-section-link.png"/></a></h4>
+<p>This feature allows end-users limiting the number of concurrent UI sessions
the users can have. In order to reach this goal the users can be sorted out
into three groups: non-privileged, privileged, unlimited.</p>
+<p>The non-privileged and privileged groups each have a configurable limit,
which the members of the group can not exceed. The members of the unlimited
group are able to create unlimited number of concurrent sessions.</p>
+<p>All of the users, who are not configured in neither the privileged nor in
the unlimited group, shall become automatically the member of the
non-privileged group.</p>
+<h4><a id="Configuration">Configuration</a> <a href="#Configuration"><img
src="markbook-section-link.png"/></a></h4>
+<p>The following table shows the relevant gateway-level parameters that are
essential for this feature to work. Please note these parameters are not listed
above in the Gateway Server Configuration table.</p>
+<table>
+ <thead>
+ <tr>
+ <th>Parameter </th>
+ <th>Description </th>
+ <th>Default</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td>gateway.service.concurrentsessionverifier.impl </td>
+ <td>To enable the session verification feature, end-users should set
this parameter to
<code>org.apache.knox.gateway.session.control.InMemoryConcurrentSessionVerifier</code>
</td>
+
<td><code>org.apache.knox.gateway.session.control.EmptyConcurrentSessionVerifier</code></td>
+ </tr>
+ <tr>
+ <td>gateway.session.verification.privileged.users </td>
+ <td>Indicates a list of users that are qualified
‘privileged’. </td>
+ <td>Empty list</td>
+ </tr>
+ <tr>
+ <td>gateway.session.verification.unlimited.users </td>
+ <td>Indicates a list of (super) users that can have as many UI sessions
as they want. </td>
+ <td>Empty list</td>
+ </tr>
+ <tr>
+ <td>gateway.session.verification.privileged.user.limit </td>
+ <td>The number of UI sessions a ‘privileged’ user can have
</td>
+ <td>3</td>
+ </tr>
+ <tr>
+ <td>gateway.session.verification.non.privileged.user.limit </td>
+ <td>The number of UI sessions a ‘non-privileged’ user can
have </td>
+ <td>2</td>
+ </tr>
+ <tr>
+ <td>gateway.session.verification.expired.tokens.cleaning.period </td>
+ <td>The time period (seconds) about the expired session verification
data is removed from the background storage </td>
+ <td>1800</td>
+ </tr>
+ </tbody>
+</table>
+<h4><a id="How+this+works">How this works</a> <a href="#How+this+works"><img
src="markbook-section-link.png"/></a></h4>
+<p>If the verifier is disabled it will not do anything even if the other
parameters are configured.</p>
+<p>When the verifier is enabled all of the users are considered as a
non-privileged user by default and they will not be able to create more
concurrent sessions than the non-privileged limit. The same is true after you
added someone in the privileged user group: that user will not be able to
create more UI sessions than the configured privileged user limit. Whereas the
members of the unlimited users group are able to create unlimited number of
concurrent sessions even if they are configured in the privileged group as
well.</p>
+<p>The underlying verifier stores verification data (included JWTs) provided
by KnoxSSO and used for login. In order to save resources the expired tokens
are deleted periodically. The cleaning period can also be updated thru the
<code>gateway.session.verification.expired.tokens.cleaning.period</code>
parameter.</p>
<h2><a id="KnoxToken+Configuration">KnoxToken Configuration</a> <a
href="#KnoxToken+Configuration"><img src="markbook-section-link.png"/></a></h2>
<h3><a id="Introduction">Introduction</a> <a href="#Introduction"><img
src="markbook-section-link.png"/></a></h3>
<hr/>
@@ -5917,6 +5970,30 @@ APACHE_HOME/bin/apachectl -k stop
<p>The following curl example shows how to add a bearer token to an
Authorization header:</p>
<pre><code>curl -ivk -H "Authorization: Bearer
eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJndWVzdCIsImF1ZCI6InRva2VuYmFzZWQiLCJpc3MiOiJLTk9YU1NPIiwiZXhwIjoxNDg5OTQyMTg4fQ.bcqSK7zMnABEM_HVsm3oWNDrQ_ei7PcMI4AtZEERY9LaPo9dzugOg3PA5JH2BRF-lXM3tuEYuZPaZVf8PenzjtBbuQsCg9VVImuu2r1YNVJlcTQ7OV-eW50L6OTI0uZfyrFwX6C7jVhf7d7YR1NNxs4eVbXpS1TZ5fDIRSfU3MU"
https://localhost:8443/gateway/tokenbased/webhdfs/v1/tmp?op=LISTSTATUS
</code></pre>
+<p>If you want tokens to include group membership informations, add a
<code>knox.token.include.groups</code> query parameter to the URL.</p>
+<pre><code>curl -u admin:admin-password -k
"https://localhost:8443/gateway/homepage/knoxtoken/api/v1/token?knox.token.include.groups=true"
+</code></pre>
+<p>The response contains the token with the group information:</p>
+<pre><code>{
+ "sub": "admin",
+ "jku":
"https://localhost:8443/gateway/homepage/knoxtoken/api/v1/jwks.json",
+ "kid": "oigA7mZCwA2d7oimQyUaB0oDAfhI-1Bjq9y1n-Mw_OU",
+ "iss": "KNOXSSO",
+ "exp": 1649777837,
+ "knox.groups": [
+ "admin-group2",
+ "admin-group1"
+ ],
+ "managed.token": "true",
+ "knox.id": "dfeb8979-7f00-4938-bbff-1bc7574bb53d"
+}
+</code></pre>
+<p>This feature is enabled by default. If you want to disable it, add the
following configuration to the KNOXTOKEN service.</p>
+<pre><code> <param>
+ <name>knox.token.include.groups.allowed</name> <!--
default = true -->
+ <value>false</value>
+ </param>
+</code></pre>
<h4><a id="KnoxToken+Renewal+and+Revocation">KnoxToken Renewal and
Revocation</a> <a href="#KnoxToken+Renewal+and+Revocation"><img
src="markbook-section-link.png"/></a></h4>
<p>The KnoxToken service supports the renewal and explicit revocation of
tokens it has issued. Support for both requires server-managed token state to
be enabled with at least one renewer white-listed.</p>
<h5><a id="Renewal">Renewal</a> <a href="#Renewal"><img
src="markbook-section-link.png"/></a></h5>
Modified: knox/site/index.html
URL:
http://svn.apache.org/viewvc/knox/site/index.html?rev=1904637&r1=1904636&r2=1904637&view=diff
==============================================================================
--- knox/site/index.html (original)
+++ knox/site/index.html Mon Oct 17 09:16:30 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
src/site/markdown/index.md at 2022-10-06
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
src/site/markdown/index.md at 2022-10-17
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221006" />
+ <meta name="Date-Revision-yyyymmdd" content="20221017" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Announcing Apache Knox 1.6.1!</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-06</li>
+ <li id="publishDate">Last Published: 2022-10-17</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/issue-management.html
URL:
http://svn.apache.org/viewvc/knox/site/issue-management.html?rev=1904637&r1=1904636&r2=1904637&view=diff
==============================================================================
--- knox/site/issue-management.html (original)
+++ knox/site/issue-management.html Mon Oct 17 09:16:30 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:issue-management
at 2022-10-06
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:issue-management
at 2022-10-17
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221006" />
+ <meta name="Date-Revision-yyyymmdd" content="20221017" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Issue Management</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-06</li>
+ <li id="publishDate">Last Published: 2022-10-17</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/licenses.html
URL:
http://svn.apache.org/viewvc/knox/site/licenses.html?rev=1904637&r1=1904636&r2=1904637&view=diff
==============================================================================
--- knox/site/licenses.html (original)
+++ knox/site/licenses.html Mon Oct 17 09:16:30 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:licenses at
2022-10-06
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:licenses at
2022-10-17
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221006" />
+ <meta name="Date-Revision-yyyymmdd" content="20221017" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Licenses</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-06</li>
+ <li id="publishDate">Last Published: 2022-10-17</li>
</ul>
</div>
<div class="row-fluid">
@@ -96,209 +96,7 @@
<h2><a name="Project_Licenses"></a>Project Licenses</h2><a
name="Project_Licenses"></a>
<div class="section">
<h3><a name="The_Apache_Software_License.2C_Version_2.0"></a>The Apache
Software License, Version 2.0</h3><a
name="The_Apache_Software_License.2C_Version_2.0"></a>
-<div class="source"><pre class="prettyprint">
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use,
reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized
by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and
all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal
Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making
modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or
Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition,
"submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a
Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal
Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
- END OF TERMS AND CONDITIONS
-
- APPENDIX: How to apply the Apache License to your work.
-
- To apply the Apache License to your work, attach the following
- boilerplate notice, with the fields enclosed by brackets "[]"
- replaced with your own identifying information. (Don't include
- the brackets!) The text should be enclosed in the appropriate
- comment syntax for the file format. We also recommend that a
- file or class name and description of purpose be included on the
- same "printed page" as the copyright notice for easier
- identification within third-party archives.
-
- Copyright [yyyy] [name of copyright owner]
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-</pre></div></div></div>
+<p>Can't read the url [https://www.apache.org/licenses/LICENSE-2.0.txt] :
www.apache.org</p></div></div>
</div>
</div>
</div>
Modified: knox/site/mailing-lists.html
URL:
http://svn.apache.org/viewvc/knox/site/mailing-lists.html?rev=1904637&r1=1904636&r2=1904637&view=diff
==============================================================================
--- knox/site/mailing-lists.html (original)
+++ knox/site/mailing-lists.html Mon Oct 17 09:16:30 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:mailing-lists
at 2022-10-06
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:mailing-lists
at 2022-10-17
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221006" />
+ <meta name="Date-Revision-yyyymmdd" content="20221017" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Mailing Lists</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-06</li>
+ <li id="publishDate">Last Published: 2022-10-17</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/project-info.html
URL:
http://svn.apache.org/viewvc/knox/site/project-info.html?rev=1904637&r1=1904636&r2=1904637&view=diff
==============================================================================
--- knox/site/project-info.html (original)
+++ knox/site/project-info.html Mon Oct 17 09:16:30 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
at 2022-10-06
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-site-plugin:3.7.1:CategorySummaryDocumentRenderer
at 2022-10-17
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221006" />
+ <meta name="Date-Revision-yyyymmdd" content="20221017" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Information</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-06</li>
+ <li id="publishDate">Last Published: 2022-10-17</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/site/team.html
URL:
http://svn.apache.org/viewvc/knox/site/team.html?rev=1904637&r1=1904636&r2=1904637&view=diff
==============================================================================
--- knox/site/team.html (original)
+++ knox/site/team.html Mon Oct 17 09:16:30 2022
@@ -1,13 +1,13 @@
<!DOCTYPE html>
<!--
- | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:team at
2022-10-06
+ | Generated by Apache Maven Doxia Site Renderer 1.8.1 from
org.apache.maven.plugins:maven-project-info-reports-plugin:3.0.0:team at
2022-10-17
| Rendered using Apache Maven Fluido Skin 1.7
-->
<html xmlns="http://www.w3.org/1999/xhtml"; xml:lang="en" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
- <meta name="Date-Revision-yyyymmdd" content="20221006" />
+ <meta name="Date-Revision-yyyymmdd" content="20221017" />
<meta http-equiv="Content-Language" content="en" />
<title>Knox Gateway – Project Team</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-1.7.min.css" />
@@ -40,7 +40,7 @@
<div id="breadcrumbs">
<ul class="breadcrumb">
- <li id="publishDate">Last Published: 2022-10-06</li>
+ <li id="publishDate">Last Published: 2022-10-17</li>
</ul>
</div>
<div class="row-fluid">
Modified: knox/trunk/books/2.0.0/config_knox_sso.md
URL:
http://svn.apache.org/viewvc/knox/trunk/books/2.0.0/config_knox_sso.md?rev=1904637&r1=1904636&r2=1904637&view=diff
==============================================================================
--- knox/trunk/books/2.0.0/config_knox_sso.md (original)
+++ knox/trunk/books/2.0.0/config_knox_sso.md Mon Oct 17 09:16:30 2022
@@ -17,6 +17,8 @@ In addition, KnoxSSO comes with its own
This document describes the overall setup requirements for KnoxSSO and
participating applications.
+In v2.0.0, the Knox team implemented an extension to the KnoxSSO feature that
controls the number of concurrent UI sessions the users can have. For more
informstion please check out the [Concurrent Session
Verification](#Concurrent+Session+Verification) section below.
+
### Form-based IdP Setup
By default the `knoxsso.xml` topology contains an application element for the
knoxauth login application. This is a simple single page application for
providing a login page and authenticating the user with HTTP basic auth against
AD/LDAP.
@@ -149,3 +151,38 @@ The above property holds the KnoxSSO ser
Individual UIs within the Hadoop ecosystem will have similar configuration for
participating in the KnoxSSO websso capabilities.
Blogs will be provided on the Apache Knox project site for these usecases as
they become available.
+
+### Concurrent Session Verification
+
+#### Overview
+
+This feature allows end-users limiting the number of concurrent UI sessions
the users can have. In order to reach this goal the users can be sorted out
into three groups: non-privileged, privileged, unlimited.
+
+The non-privileged and privileged groups each have a configurable limit, which
the members of the group can not exceed. The members of the unlimited group are
able to create unlimited
+number of concurrent sessions.
+
+All of the users, who are not configured in neither the privileged nor in the
unlimited group, shall become automatically the member of the non-privileged
group.
+
+#### Configuration
+
+The following table shows the relevant gateway-level parameters that are
essential for this feature to work. Please note these parameters are not listed
above in the Gateway Server Configuration table.
+
+Parameter | Description | Default
+-------------------------------- |------------ |-----------
+gateway.service.concurrentsessionverifier.impl | To enable the session
verification feature, end-users should set this parameter to
`org.apache.knox.gateway.session.control.InMemoryConcurrentSessionVerifier` |
`org.apache.knox.gateway.session.control.EmptyConcurrentSessionVerifier`
+gateway.session.verification.privileged.users | Indicates a list of users that
are qualified 'privileged'. | Empty list
+gateway.session.verification.unlimited.users | Indicates a list of (super)
users that can have as many UI sessions as they want. | Empty list
+gateway.session.verification.privileged.user.limit | The number of UI sessions
a 'privileged' user can have | 3
+gateway.session.verification.non.privileged.user.limit | The number of UI
sessions a 'non-privileged' user can have | 2
+gateway.session.verification.expired.tokens.cleaning.period | The time period
(seconds) about the expired session verification data is removed from the
background storage | 1800
+
+
+#### How this works
+
+If the verifier is disabled it will not do anything even if the other
parameters are configured.
+
+When the verifier is enabled all of the users are considered as a
non-privileged user by default and they will not be able to create more
+concurrent sessions than the non-privileged limit. The same is true after you
added someone in the privileged user group: that user will not be able to
create more UI sessions than the configured privileged user limit. Whereas the
members of the unlimited users group are able to create unlimited number of
concurrent sessions even if they are configured in the privileged group as well.
+
+The underlying verifier stores verification data (included JWTs) provided by
KnoxSSO and used for login. In order to save resources the expired tokens are
deleted periodically. The cleaning period can also be updated thru the
`gateway.session.verification.expired.tokens.cleaning.period` parameter.
+
