Skip to content

Commit

Permalink
Bump version to 3.1 for new features
Browse files Browse the repository at this point in the history
update and fix the guide/readme doco to refer to new version and feature
  • Loading branch information
pmcneil committed Aug 8, 2019
1 parent 0b7deed commit 26116e3
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 13 deletions.
18 changes: 16 additions & 2 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@
:description: Grails shiro plugin
:keywords: documentation, Grails, Shiro, 3.3.10, 1.4.1
:links:
:numbered:
:sectlinks:
:toc: left
:toclevels: 2
:toc-class: toc2


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

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 All @@ -21,7 +25,7 @@ https://github.com/nerdErg/grails-shiro/blob/master/docs/Guide.adoc[Guide] in th

== Installation

To install add this to your `build.gradle` dependencies:
To install, add this to your `build.gradle` dependencies:

compile "org.grails.plugins:grails-shiro:3.0"

Expand All @@ -40,6 +44,16 @@ Now to Control access to a Controller add an Interceptor for that controller usi
`https://github.com/nerdErg/grails-shiro/blob/master/docs/Guide.adoc#create-shiro-controller-interceptor[grails create-shiro-controller-interceptor] MyController` which will add
https://github.com/nerdErg/grails-shiro/blob/master/docs/Guide.adoc#permission-string-conventions[access control by convention].

== Version change log

=== version 3.0

* re-write from old Grails 2 plugin see updates in the https://github.com/nerdErg/grails-shiro/blob/master/docs/Guide.adoc[Guide]

=== version 3.1

* Added ability to set the remember me cipherKey or the length of the randomly generated key

== Building from source

To build the plugin yourself and install it from this repo:
Expand Down
6 changes: 3 additions & 3 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ buildscript {
}
}

version "3.0"
version "3.1"
group "org.grails.plugins"

apply plugin: "eclipse"
Expand Down Expand Up @@ -136,7 +136,7 @@ task shiroTest(type: Test) {
//add the plugin
File build = new File("$projectDir/src/test/app/shiro-tester/build.gradle")
String content = build.text.replaceFirst('\ndependencies \\{', """dependencies {
compile "org.grails.plugins:grails-shiro:3.0" """)
compile "org.grails.plugins:grails-shiro:3.1" """)
build.write(content)
//add LDAP config

Expand Down Expand Up @@ -221,7 +221,7 @@ task shiroCliTest(type: Test) {

File build = new File("$projectDir/src/test/app/cli-tester/build.gradle")
String content = build.text.replaceFirst('\ndependencies \\{', """dependencies {
compile "org.grails.plugins:grails-shiro:3.0" """)
compile "org.grails.plugins:grails-shiro:3.1" """)
build.write(content)

exec {
Expand Down
20 changes: 12 additions & 8 deletions docs/Guide.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Grails Shiro Plugin
v3.0, July 2019
v3.1, August 2019
:toc: left
:toclevels: 4
:toc-class: toc2
Expand Down Expand Up @@ -139,7 +139,7 @@ Settings should be in your configuration (`application.yml` or `application.groo
=== security.shiro
[source, yaml, subs="+macros"]
[subs=+macros, source]
.example-application.yml
----
security:
Expand All @@ -160,14 +160,14 @@ security:
<<unauthorized redirect, unauthorized>>:
controller: auth
action: unauthorized
<<_filter, filter>>:
<<_basic, basic>>:
<<filter, filter>>:
<<basic, basic>>:
enabled: false
appName: Shiro Plugin Test
<<_loginurl,loginUrl>>: /login
<<_successurl, successUrl>>: /
<<_unauthorizedurl, unauthorizedUrl>>: /unauthorized
<<_filterchaindefinitions, filterChainDefinitions>>: |
<<loginurl,loginUrl>>: /login
<<successurl, successUrl>>: /
<<unauthorizedurl, unauthorizedUrl>>: /unauthorized
<<filterchaindefinitions, filterChainDefinitions>>: |
/basic/** = authcBasic
/form/** = authc
realm:
Expand All @@ -194,6 +194,8 @@ security:
==== rememberMe cipherKey
since version 3.1
16, 24, 32 char string, default is 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
Expand All @@ -205,6 +207,8 @@ have a multi server/load balanced application or docker swarm.
==== rememberMe keySize
since version 3.1
124, 192, 256, default 256
This specifies the size of the randomly generated rememberMe key. If you set the cipherKey, this setting is ignored.
Expand Down

0 comments on commit 26116e3

Please sign in to comment.