From 8d84f140362cf423a33c23bb1bce281872750d2c Mon Sep 17 00:00:00 2001 From: Christophe Maudoux Date: Wed, 9 Feb 2022 00:10:59 +0100 Subject: [PATCH] Doc typos --- doc/sources/admin/documentation.rst | 23 +++++++++++------------ doc/sources/admin/features.rst | 22 +++++++++++----------- doc/sources/admin/federationproxy.rst | 9 ++++----- doc/sources/admin/presentation.rst | 11 ++++------- 4 files changed, 30 insertions(+), 35 deletions(-) diff --git a/doc/sources/admin/documentation.rst b/doc/sources/admin/documentation.rst index 942e6e72e..9b65c1940 100644 --- a/doc/sources/admin/documentation.rst +++ b/doc/sources/admin/documentation.rst @@ -31,7 +31,7 @@ Installation and configuration - `Version 2.0 `__ (stable) - `Version 1.9 `__ (oldstable) -- Archived versions (unmaintained by LLNG Team ) +- Archived versions (unmaintained by LL::NG Team ) - `Version 1.4 `__ - `Version 1.3 `__ @@ -42,19 +42,18 @@ Installation and configuration Packaged versions ~~~~~~~~~~~~~~~~~ -These versions are maintained under distribution umbrella following -their policy. +These versions are maintained under distribution umbrella following their policy. Debian ^^^^^^ .. tip:: - Following Debian Policy, LLNG packages are never upgraded in published distributions. However, security patches are backported by maintenance teams *(except some inor ones)*. + Following Debian Policy, LL::NG packages are never upgraded in published distributions. However, security patches are backported by maintenance teams *(except some minor ones)*. See `Security tracker `__ =========== ========================== ======================================== ===================================================== ============================================================ =============================== ============================================================= -Debian dist LLNG version Secured Maintenance LTS Limit `Extended LTS `__ Limit +Debian dist LL::NG version Secured Maintenance LTS Limit `Extended LTS `__ Limit =========== ========================== ======================================== ===================================================== ============================================================ =============================== ============================================================= *6* *Squeeze* *0.9.4.1* |maybe| No known vulnerability *None* *February 2016* *April 2019* *7* *Wheezy* `1.1.2 `__ |maybe| No known vulnerability *None* *May 2018* *June 2020* @@ -64,10 +63,10 @@ Debian dist LLNG version \ *Stretch-backports-sloppy* `2.0.11 `__ |maybe| *None* *August 2021* **10** Buster `2.0.2 `__ |clean| CVE-2019-19791 tagged as minor `Debian Security Team `__ June 2024 Probably 2026 \ *Buster-backports* `2.0.11 `__ |clean| *None* *August 2021* -\ Buster-backports-sloppy `2.0.11 `__ |clean| LLNG Team, "best effort" [3]_ Until Debian 12 release [4]_ +\ Buster-backports-sloppy `2.0.11 `__ |clean| LL::NG Team, "best effort" [3]_ Until Debian 12 release [4]_ **11** Bullseye `2.0.11 `__ |clean| `Debian Security Team `__ July 2026 Probably 2028 -\ Bullseye-backports `2.0.11 `__ |clean| LLNG Team, "best effort" [3]_ Until Debian 12 release [4]_ -**Next** Testing/Unstable Latest [5]_ |clean| LLNG Team +\ Bullseye-backports `2.0.11 `__ |clean| LL::NG Team, "best effort" [3]_ Until Debian 12 release [4]_ +**Next** Testing/Unstable Latest [5]_ |clean| LL::NG Team =========== ========================== ======================================== ===================================================== ============================================================ =============================== ============================================================= See `Debian Security @@ -83,7 +82,7 @@ Ubuntu Ubuntu version are included in "universe" branch [8]_, so not really security maintained. Prefer to use our repositories or Debian ones =========== ============= ================================ ==================================================================== =========== -Ubuntu dist LLNG version Secured Maintenance +Ubuntu dist LL::NG version Secured Maintenance =========== ============= ================================ ==================================================================== =========== 12.04 Precise `1.1.2 `__ |maybe| No known vulnerability None 14.04 Trusty `1.2.5 `__ |maybe| No known vulnerability None @@ -108,7 +107,7 @@ Development - `Source code `__ - `Nightly trunk builds `__ - *(for Debian or Ubuntu,*\ **really unstable**\ *)* + *(for Debian or Ubuntu, *\ **really unstable**\ *)* - Git access: :: @@ -139,7 +138,7 @@ Other Possible `Extended LTS `__ .. [3] - updated by `LLNG Team `__ until dependencies are compatible. + updated by `LL::NG Team `__ until dependencies are compatible. Don't use backports unless you plan to update your system because backports are not covered by Debian Security Policy @@ -151,7 +150,7 @@ Other .. [8] Ubuntu universe/multiverse branches are community maintained *(so not - maintained by Canonical)*, but in fact nobody considers LLNG security + maintained by Canonical)*, but in fact nobody considers LL::NG security issues. See `this issue `__ for example diff --git a/doc/sources/admin/features.rst b/doc/sources/admin/features.rst index 5427e5410..c389cfa32 100644 --- a/doc/sources/admin/features.rst +++ b/doc/sources/admin/features.rst @@ -28,11 +28,13 @@ Unifying authentications (Identity Federation) LL::NG can easily exchange with other authentication systems by using SAML, OpenID or CAS protocoles. It may be the backbone of a -heterogeneous architecture. LL:NG can be set as Identity provider, +heterogeneous architecture. + +LL:NG can be set as Identity provider, Service Provider or Protocol Proxy (:doc:`LL::NG as federation protocol proxy`). -Its SOAP API can also be used to dialogue directly with your custom +Its REST / SOAP API can also be used to dialogue directly with your custom applications. Sessions @@ -48,8 +50,7 @@ opened sessions: - by users - by IP *(IPv4 and IPv6)* -- by double IP (sessions opened by the same user from multiple - computers) +- by double IP (sessions opened by the same user from multiple computers) - by date It can be used to delete a session @@ -59,9 +60,8 @@ It can be used to delete a session Session restrictions ~~~~~~~~~~~~~~~~~~~~ -By default, a user can open several -:doc:`sessions`. LL::NG can restrict -the following: +By default, a user can open several :doc:`sessions`. +LL::NG can restrict the following: - Allow only one session per user - Allow only one IP address per user @@ -72,17 +72,17 @@ Those capabilities can be used simultaneously or separately. Double cookie ~~~~~~~~~~~~~ -LL::NG can be configured to provides -:doc:`2 cookies`: +LL::NG can be configured to provides :doc:`2 cookies`: - one secured (SSL only) for sensitive applications - one unsecured for other applications So that if the http cookie is stolen, sensitive applications remain secured. + Notifications ------------- LL::NG can be used to notify users with a message when authenticating. This can be used to -inform of a change in access rights, the publication of a new IT charter, etc. (See -:doc:`notifications` for more details) +inform of a change in access rights, the publication of a new IT charter, etc... +(See :doc:`notifications` for more details) diff --git a/doc/sources/admin/federationproxy.rst b/doc/sources/admin/federationproxy.rst index a0d108872..614207c58 100644 --- a/doc/sources/admin/federationproxy.rst +++ b/doc/sources/admin/federationproxy.rst @@ -1,8 +1,7 @@ LL::NG as federation protocol proxy =================================== -LL::NG can use federation protocols (SAML, CAS, OpenID) independently -to: +LL::NG can use federation protocols (SAML, CAS, OpenID) independently to: - authenticate users - provide identities to other systems @@ -11,7 +10,7 @@ So you can configure it to authenticate users using a federation protocol and simultaneously to provide identities using other(s) federation protocols. -Schemes tested: +Tested schemes: - SAML / OpenID-Connect: @@ -30,8 +29,8 @@ Schemes tested: :doc:`CAS`/:doc:`SAML` proxy **<=>** SAML Identity Provider -Note that OpenID-Connect consortium hasn't already defined single-logout -initiated by OpenID-Connect Provider. LLNG will implement it when this +Note that OpenID-Connect consortium has not already defined single-logout +initiated by OpenID-Connect Provider. LL::NG will implement it when this standard will be published. diff --git a/doc/sources/admin/presentation.rst b/doc/sources/admin/presentation.rst index 80f878ca0..bdf7845d0 100644 --- a/doc/sources/admin/presentation.rst +++ b/doc/sources/admin/presentation.rst @@ -36,7 +36,7 @@ Databases .. attention:: We call "database" a backend where we can read or write a data. - This can be a file, an LDAP directory, etc. + This can be a file, an LDAP directory, etc... We split databases in two categories: @@ -123,8 +123,7 @@ on protected applications, with different behavior: - **SSO and Application logout**: the request is forwarded to application and SSO session is closed -After logout process, the user is redirected on portal, or on a -configured URL. +After logout process, the user is redirected on portal, or on a configured URL. Session expiration ~~~~~~~~~~~~~~~~~~ @@ -136,10 +135,8 @@ This duration can be set in the manager's Configuration tab (General Parameters - Handlers have a session cache, with a default lifetime of 10 minutes. So for Handlers located on different physical servers than the Portal, a user - with an expired session can still be authorized until the cache - expires. - - Sessions are deleted by a scheduled task. Don't forget to install - cron files ! + with an expired session can still be authorized until the cache expires. + - Sessions are deleted by a scheduled task. Don't forget to install cron files!