Merge pull request #63 from openequella/release/1.1.1

Release/1.1.1
openequella · Jul 8, 2021 · e835763 · e835763
2 parents c46a0fc + c09a25e
commit e835763
Show file tree

Hide file tree

Showing 11 changed files with 241 additions and 138 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -0,0 +1,61 @@
+name: openEQUELLA Admin Console Launcer CI
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+      - release/**
+    tags:
+      - "**"
+  pull_request:
+    branches:
+      - master
+      - develop
+      - release/**
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Gradle Cache
+        uses: actions/cache@v2
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v2
+        with:
+          distribution: adopt
+          java-version: 8
+
+      - name: Build with Gradle
+        run: ./gradlew build
+
+      - name: Save artefacts
+        uses: actions/[email protected]
+        with:
+          name: Artefacts
+          path: build/distributions
+
+      - name: Save Coverage Report
+        uses: actions/[email protected]
+        with:
+          name: CoverageReport
+          path: build/reports/tests/test
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: build/distributions/*
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
diff --git a/.travis.yml b/.travis.yml
diff --git a/NOTICE.md b/NOTICE.md
@@ -19,11 +19,11 @@ the License.
 
 | Category              | License                                                                   | Dependency                                           | Notes                   |
 | --------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------- | ----------------------- |
-| Apache                | [ASF 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)                 | nebula.lint # 9.3.4                                  | <notextile></notextile> |
+| Apache                | [ASF 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)                 | nebula.lint # 16.26.0                                  | <notextile></notextile> |
 | Apache                | [ASF 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)                 | com.github.hierynomus.license # 0.15.0               | <notextile></notextile> |
 | Apache                | [ASF 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)                 | com.google.guava:guava # 27.0.1-jre                  | <notextile></notextile> |
-| Apache                | [ASF 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)                 | com.fasterxml.jackson.core:jackson-databind # 2.9.8  | <notextile></notextile> |
-| Apache                | [ASF 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)                 | org.jasypt:jasypt # 1.9.2                            | <notextile></notextile> |
-| Eclipse Public License| [Eclipse Public License 1.0](http://www.eclipse.org/legal/epl-v10.html )  | junit:junit # 4.12                                   | <notextile></notextile> |
-| MIT License           | [MIT License](http://www.opensource.org/licenses/mit-license.php)         | org.slf4j:slf4j-api # 1.7.26                         | <notextile></notextile> |
-| MIT License           | [MIT License](http://www.opensource.org/licenses/mit-license.php)         | org.slf4j:slf4j-simple # 1.6.4                       | <notextile></notextile> |
+| Apache                | [ASF 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)                 | com.fasterxml.jackson.core:jackson-databind # 2.12.3  | <notextile></notextile> |
+| Apache                | [ASF 2.0](http://www.apache.org/licenses/LICENSE-2.0.txt)                 | org.jasypt:jasypt # 1.9.3                            | <notextile></notextile> |
+| Eclipse Public License| [Eclipse Public License 1.0](http://www.eclipse.org/legal/epl-v10.html )  | junit:junit # 4.13.2                                   | <notextile></notextile> |
+| MIT License           | [MIT License](http://www.opensource.org/licenses/mit-license.php)         | org.slf4j:slf4j-api # 1.7.31                         | <notextile></notextile> |
+| MIT License           | [MIT License](http://www.opensource.org/licenses/mit-license.php)         | org.slf4j:slf4j-simple # 1.7.31                       | <notextile></notextile> |
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@ For development, you can run the app via:
 ~$ ./gradlew run --console=verbose
 ```
 
-##Apereo Header validation
+## Apereo Header validation
 The gradle build includes a task which will check that each source file in the common and configurator projects has an Apereo 
 license notice at the top of the file. This license is stored in `LICENSE` in the root of this repository.
 In order to apply the headers, run:
@@ -40,3 +40,44 @@ These packages will be produced as part of the standard build task.
  ```
   -$ ./gradlew build
  ```
+
+## Adding Root CA Certificates
+If openEQUELLA is configured to use SSL with a certificate that is not recognized by Java, (such as with a self-signed certificate, an internal CA, smaller/lesser known third party CAs)
+then the admin-console-package will fail to log in to the institution because of this error displayed in the terminal window: 
+
+```
+Caused by: javax.net.ssl.SSLHandshakeException: sun.security.validator.ValidatorException: 
+PKIX path building failed: sun.security.provider.certpath.SunCertPathBuilderException: 
+unable to find valid certification path to requested target
+```
+
+This is because the Java Keystore used by the admin console package does not recognize the Root CA certificate used to sign openEQUELLA's SSL certificate.
+
+The admin-console-package uses its own copy of the JRE, in the `jdk8u242-b08-jre` folder. 
+The keystore we need to update is within this folder, at the path `jdk8u242-b08-jre/lib/security/cacerts`.
+
+The bundled JRE comes with a command line tool which you can use for updating these keystores, called `keytool`. 
+This should work in Mac, Linux and Windows. It is stored in `jdk8u242-b08-jre/bin`.
+
+**NOTE:**
+
+If Java is installed on your system it will have its own version of `keystore`. 
+You should use the one within the admin-console-package's bundled JRE rather than your system Java version, to ensure compatibility.
+
+You will need a copy of the Root CA certificate used to sign your SSL certificate saved as a .pem file for the following command's `-file` argument.
+
+`-alias` can be whatever you wish to call this key store entry.
+
+`-storepass` must be `changeit` - unless you have specifically changed this password first, 
+in which case you should use whatever it was set to.
+
+```
+keytool -import -trustcacerts -keystore path/to/adminconsolepackage/jdk8u242-b08-jre/lib/security/cacerts -storepass changeit -alias giveYourCertANameHere -file path/to/rootCA.pem
+```
+
+The command will display the certificate and prompt the user to `Trust this certificate? [no]:`. Type `yes` and hit Enter.
+If successful, the response will be:
+
+    Certificate was added to keystore.
+
+Now close and reopen the admin-console-package and attempt to log into your openEQUELLA's admin console. The error should be gone and login should be successful.
diff --git a/build.gradle b/build.gradle
@@ -2,7 +2,7 @@ plugins {
     id 'java'
     id 'application'
     id 'base'
-    id 'nebula.lint' version '9.3.4'
+    id 'nebula.lint' version '16.26.0'
     id 'com.github.hierynomus.license' version '0.15.0'
 }
 
@@ -18,10 +18,10 @@ repositories {
 }
 
 dependencies {
-    implementation 'org.slf4j:slf4j-api:1.7.26'
-    implementation 'com.fasterxml.jackson.core:jackson-databind:2.10.2'
-    implementation 'org.jasypt:jasypt:1.9.2'
-    runtimeOnly 'org.slf4j:slf4j-simple:1.6.4'
+    implementation 'org.slf4j:slf4j-api:1.7.31'
+    implementation 'com.fasterxml.jackson.core:jackson-databind:2.12.3'
+    implementation 'org.jasypt:jasypt:1.9.3'
+    runtimeOnly 'org.slf4j:slf4j-simple:1.7.31'
     testImplementation "junit:junit:$junitVersion"
 }
 

diff --git a/gradle.properties b/gradle.properties
@@ -1,2 +1,2 @@
-junitVersion=4.12
-artifactVersion=1.1.0
+junitVersion=4.13.2
+artifactVersion=1.1.1
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,5 @@
-#Mon May 13 17:09:22 AEST 2019
-distributionUrl=https\://services.gradle.org/distributions/gradle-5.6-all.zip
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
diff --git a/gradlew b/gradlew
@@ -1,5 +1,21 @@
 #!/usr/bin/env sh
 
+#
+# Copyright 2015 the original author or authors.
+#
+# 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
+#
+#      https://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.
+#
+
 ##############################################################################
 ##
 ##  Gradle start up script for UN*X
@@ -28,7 +44,7 @@ APP_NAME="Gradle"
 APP_BASE_NAME=`basename "$0"`
 
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
-DEFAULT_JVM_OPTS='"-Xmx64m"'
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD="maximum"
@@ -109,8 +125,8 @@ if $darwin; then
     GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
 fi
 
-# For Cygwin, switch paths to Windows format before running java
-if $cygwin ; then
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
     APP_HOME=`cygpath --path --mixed "$APP_HOME"`
     CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
     JAVACMD=`cygpath --unix "$JAVACMD"`