Skip to content

Commit

Permalink
minor documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
pmcneil committed Aug 8, 2019
1 parent 26116e3 commit 5817708
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
3 changes: 2 additions & 1 deletion README.adoc
Expand Up @@ -14,7 +14,8 @@

image:https://travis-ci.org/nerdErg/grails-shiro.svg?branch=master["Build Status", link="https://travis-ci.org/nerdErg/grails-shiro"]

Latest Plugin Version 3.1
Latest released version 3.0
Latest working version 3.1

This is the Grails Shiro plugin for grails version 3.3.x and Shiro 1.4.1. This was derived from the Grails 2.x version
(https://github.com/pledbrook/grails-shiro).
Expand Down
17 changes: 9 additions & 8 deletions docs/Guide.adoc
Expand Up @@ -194,9 +194,9 @@ security:
==== rememberMe cipherKey
since version 3.1
NOTE: since version 3.1
16, 24, 32 char string, default is a random 256 bit key generated on each boot
*Options:* 16, 24 or 32 char string. *Default:* a random 256 bit key generated on each boot
You can set the cipherKey used for encrypting the rememberMe cookie. It needs to be an ASCII string 16,24, or 32 characters
(bytes) long. It is probably best for security *not* to set this value, but let the system generate a new random key
Expand All @@ -207,29 +207,29 @@ have a multi server/load balanced application or docker swarm.
==== rememberMe keySize
since version 3.1
NOTE: since version 3.1
124, 192, 256, default 256
*Options:* 124, 192, 256. *Default:* 256
This specifies the size of the randomly generated rememberMe key. If you set the cipherKey, this setting is ignored.
==== authc required
true or false, default true.
*Options:* true or false. *Default:* true.
Is authentication required by default when using Interceptors and the <<Authorization closure, accessControl()>> function.
==== session mode
'native', default '' (servlet container session).
*Options:* 'native'. *Default:* '' (servlet container session).
Session mode can be set to 'native' which uses the shiro native session manager "with sensible defaults".
If not set you get the servlet containers (Tomcat) session manager.
==== handleExceptions
true/false, default true.
*Options:* true/false. *Default:* true.
If false we don't replace the GrailsExceptionResolver with ShiroGrailsExceptionResolver
which redirects Unauthenticated and Unauthorized exceptions to 401 and 403 handlers as defined in UrlMappings.
Expand All @@ -238,7 +238,8 @@ with your own.
==== bycrypt rounds
n <= 30, default 10.
*Options:* n <= 30. *Default:* 10.
Sets the *log* rounds for the default <<Credential Matcher and Password encrypting, BCrypt password encryption>>.
==== login redirect
Expand Down

0 comments on commit 5817708

Please sign in to comment.