You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2021/04/08 06:10:07 UTC
[isis] branch 2.0.0-M5 updated: ISIS-2484: shiro docs
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch 2.0.0-M5
in repository https://gitbox.apache.org/repos/asf/isis.git
The following commit(s) were added to refs/heads/2.0.0-M5 by this push:
new f1a425a ISIS-2484: shiro docs
f1a425a is described below
commit f1a425ad04b04f14a3bc7b297e227c9a08ced47b
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Thu Apr 8 07:09:55 2021 +0100
ISIS-2484: shiro docs
---
.../src/main/adoc/modules/shiro/pages/about.adoc | 24 +++++++++++-----------
1 file changed, 12 insertions(+), 12 deletions(-)
diff --git a/security/shiro/src/main/adoc/modules/shiro/pages/about.adoc b/security/shiro/src/main/adoc/modules/shiro/pages/about.adoc
index 91fb900..3fd7b1e 100644
--- a/security/shiro/src/main/adoc/modules/shiro/pages/about.adoc
+++ b/security/shiro/src/main/adoc/modules/shiro/pages/about.adoc
@@ -73,18 +73,20 @@ The Shiro integration supports the following config properties:
=== Shiro Realms and shiro.ini
-Shiro uses the concept of realms to define its own set of authenticated users and their roles.
+Shiro uses the `shiro.ini` file for configuration, which resides in the default package (in other words, in `src/main/resources` in the webapp module).
+
+Shiro uses the concept of realms to define its own set of authenticated users and their roles, and this is the most important configuration specified in the `shiro.ini` file.
Either one or many realms can be configured.
-The `shiro.ini` file is used to define which realm are to be used.
-This resides in the default package (in other words, in `src/main/resources` in the webapp module).
+For example:
[source,ini]
----
securityManager.realms = $realmName
----
-Shiro's ini file supports a "poor-man's" dependency injection (link:https://shiro.apache.org/configuration.html[their words]), and so `$realmName` in the above example is a reference to a realm defined elsewhere in `shiro.ini`.
+where `$realmName` in the above example is a reference to a realm defined elsewhere in `shiro.ini`.
+This is an example of Shiro's "poor-man's" dependency injection (link:https://shiro.apache.org/configuration.html[their words]).
It's also possible to configure Shiro to support multiple realms.
@@ -94,10 +96,13 @@ securityManager.realms = $realm1,$realm2
----
How to configure the text-based ini realm is explained <<shiro-ini-realm,below>>.
-Another option lternative is the xref:security:shiro-realm-ldap:about.adoc[LDAP realm].
+Another option alternative is the xref:security:shiro-realm-ldap:about.adoc[LDAP realm].
+
-To leverage Apache Isis' <<enhanced-wildcard-permission,enhanced wildcard permissions>>, you should also specify the Apache Isis permission resolver for the specified realm; further details <<permission-resolver-configuration,below>>.
+As noted above, as well as realms many other aspects of configuration can be specified in this file:
+* enable caching for performance; discussed <<caching,below>>
+* leverage Apache Isis' <<enhanced-wildcard-permission,enhanced wildcard permissions>>,by specifying the Apache Isis permission resolver; discussed <<permission-resolver-configuration,below>>.
[#shiro-ini-realm]
@@ -300,6 +305,7 @@ myRealm.permissionResolver = $permissionResolver # <.>
+[#caching]
== Caching
To ensure that security operations does not impede performance, Shiro supports caching.
@@ -324,9 +330,3 @@ Check out:
+
These include for instance link:http://meri-stuff.blogspot.co.uk/2011/04/apache-shiro-part-2-realms-database-and.html[this interesting article] describing how to perform certificate-based authentication (ie login using Google or Facebook credentials).
-
-
-
-
-
-