Tidy things up before the release

- updated pom.xml, so it generates javadocs properly and explicitly skips gpg signing (it was implicit before) - updated apidocs - updated changelog
square · Nov 9, 2018 · 0ff2e54 · 0ff2e54
1 parent f0e8bd7
commit 0ff2e54
Show file tree

Hide file tree

Showing 10 changed files with 154 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,48 @@
+v0.9.0: 2018-11-07
+
+  * Migrated to JDK 11 (now required to build Keywhiz)
+
+  * Added tracking of expiration of client certificates in the DB (#369)
+
+  * Added endpoint for encrypted group backup that allows to perform automated backups of secrets 
+    for groups that are required for bootstrapping a new datacenter by periodically calling the 
+    endpoint to produce a GPG-encrypted archive. The GPG key that is used for export should ideally 
+    be kept offline, only to be used in an emergency situation. (#361)
+
+  * Added an endpoint for retrieving a SanitizedSecret by name (#359)
+
+  * Improved BCrypt hash check on login (#374)
+
+  * Fixed building Docker image (#382 and #383)
+
+  * Removed PostgreSQL support (#347)
+
+  * Updated dependencies
+    - dropwizard updated to 1.2.9
+    - guice updated to 4.2.2
+    - jackson updated to 2.9.6
+    - jooq updated to 3.11.5
+    - mysql updated to 5.1.45
+    - logback updated to 1.2.3
+    - slf4j updated to 1.7.25
+    - powermock updated to 1.7.4
+    - updated dropwizard-raven to 1.2.0
+    - flyway updated to 4.2.0
+    - easymock updated to 3.6
+    - unboundid-ldapsdk updated to 4.0.1
+    - okhttp updated to 3.9.1
+    - mockito updated to 2.23.0
+    - hibernate-validator updated to 5.3.4
+    - jBcrypt updated to 0.4.1
+    - guava updated to 23.5
+    - auto-value updated to 1.5.4
+    - maven-shade-plugin updated to 3.0.0
+    - javax.annotation-api added
+    - jaxb-api added
+    - jaxb-runtime added
+    - jaxb-xjc added
+    - jaxb-jxc added
+
 v0.8.0: 2017-06-27
 
   * Removed old Web UI.

diff --git a/docs/apidocs/automation_v2-backup.json b/docs/apidocs/automation_v2-backup.json
@@ -0,0 +1,33 @@
+{
+  "apiVersion" : "1",
+  "swaggerVersion" : "1.2",
+  "basePath" : "https://square.github.io/keywhiz/apidocs",
+  "resourcePath" : "/automation/v2-backup",
+  "apis" : [ {
+    "path" : "/automation/v2/backup/{key}/group/{group}",
+    "operations" : [ {
+      "method" : "GET",
+      "nickname" : "backup",
+      "type" : "array",
+      "items" : {
+        "type" : "string",
+        "format" : "byte"
+      },
+      "parameters" : [ {
+        "type" : "string",
+        "description" : "Group name",
+        "paramType" : "path",
+        "name" : "group",
+        "required" : true
+      }, {
+        "type" : "string",
+        "paramType" : "path",
+        "name" : "key",
+        "required" : true
+      } ],
+      "summary" : "Backup all secrets for a given group.",
+      "notes" : "Returns an encrypted encrypted to\n the backup key in the main configuration file. Only accessible to automation clients.",
+      "produces" : [ "application/octet-stream" ]
+    } ]
+  } ]
+}
diff --git a/docs/apidocs/automation_v2-client-management.json b/docs/apidocs/automation_v2-client-management.json
@@ -224,6 +224,9 @@
         },
         "present" : {
           "type" : "boolean"
+        },
+        "empty" : {
+          "type" : "boolean"
         }
       }
     },
@@ -265,4 +268,4 @@
       }
     }
   }
-}
+}
diff --git a/docs/apidocs/clients-admin.json b/docs/apidocs/clients-admin.json
@@ -99,6 +99,9 @@
     "LongParam" : {
       "id" : "LongParam",
       "properties" : {
+        "parameterName" : {
+          "type" : "string"
+        },
         "value" : {
           "type" : "T"
         },
@@ -202,4 +205,4 @@
       }
     }
   }
-}
+}
diff --git a/docs/apidocs/groups-admin.json b/docs/apidocs/groups-admin.json
@@ -99,6 +99,9 @@
     "LongParam" : {
       "id" : "LongParam",
       "properties" : {
+        "parameterName" : {
+          "type" : "string"
+        },
         "value" : {
           "type" : "T"
         },

diff --git a/docs/apidocs/memberships-admin.json b/docs/apidocs/memberships-admin.json
@@ -122,6 +122,9 @@
     "LongParam" : {
       "id" : "LongParam",
       "properties" : {
+        "parameterName" : {
+          "type" : "string"
+        },
         "value" : {
           "type" : "T"
         },
@@ -132,4 +135,4 @@
       }
     }
   }
-}
+}
diff --git a/docs/apidocs/secrets-admin.json b/docs/apidocs/secrets-admin.json
@@ -344,6 +344,9 @@
     "LongParam" : {
       "id" : "LongParam",
       "properties" : {
+        "parameterName" : {
+          "type" : "string"
+        },
         "value" : {
           "type" : "T"
         },

diff --git a/log/pom.xml b/log/pom.xml
@@ -15,4 +15,4 @@
       <artifactId>slf4j-api</artifactId>
     </dependency>
   </dependencies>
-</project>
+</project>
diff --git a/pom.xml b/pom.xml
@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <prerequisites>
     <maven>3.3.9</maven>
@@ -334,6 +336,13 @@
   <build>
     <directory>${custom.build.directory}</directory>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-gpg-plugin</artifactId>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
       <plugin>
         <groupId>org.jacoco</groupId>
         <artifactId>jacoco-maven-plugin</artifactId>
@@ -421,6 +430,19 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.0.1</version>
+        <executions>
+          <execution>
+            <id>attach-sources</id>
+            <goals>
+              <goal>javadoc</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
     </plugins>
 
     <pluginManagement>
@@ -546,16 +568,18 @@
               <configuration>
                 <rules>
                   <evaluateBeanshell>
-                    <condition>javax.crypto.Cipher.getMaxAllowedKeyLength("AES") &gt; 128</condition>
+                    <condition>javax.crypto.Cipher.getMaxAllowedKeyLength("AES") &gt; 128
+                    </condition>
                     <message>
-Please install the unlimited strength JCE crypt policy files for your Java JDK.
-Without these, crypto operations are crippled consistently.
+                      Please install the unlimited strength JCE crypt policy files for your Java
+                      JDK.
+                      Without these, crypto operations are crippled consistently.
 
-For Java8:
-Download the jars at:
-http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
-Place the jars in this directory: `/usr/libexec/java_home -v
-1.8`/jre/lib/security/
+                      For Java8:
+                      Download the jars at:
+                      http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html
+                      Place the jars in this directory: `/usr/libexec/java_home -v
+                      1.8`/jre/lib/security/
                     </message>
                   </evaluateBeanshell>
                 </rules>
@@ -596,17 +620,28 @@ Place the jars in this directory: `/usr/libexec/java_home -v
           <groupId>org.apache.maven.plugins</groupId>
           <artifactId>maven-javadoc-plugin</artifactId>
           <version>3.0.1</version>
-          <configuration>
-            <additionalparam>-Xdoclint:none</additionalparam>
-            <docletArtifact>
-              <groupId>com.tenxerconsulting</groupId>
-              <artifactId>swagger-doclet</artifactId>
-              <version>1.1.3</version>
-            </docletArtifact>
-            <links>
-              <link>https://square.github.io/keywhiz/javadoc/</link>
-            </links>
-          </configuration>
+          <executions>
+            <execution>
+              <configuration>
+                <doclet>com.tenxerconsulting.swagger.doclet.ServiceDoclet</doclet>
+                <docletArtifact>
+                  <groupId>com.tenxerconsulting</groupId>
+                  <artifactId>swagger-doclet</artifactId>
+                  <version>1.1.3</version>
+                </docletArtifact>
+                <reportOutputDirectory>./docs</reportOutputDirectory>
+                <useStandardDocletOptions>false</useStandardDocletOptions>
+                <doclint>none</doclint>
+                <additionalOptions>-logDebug -apiVersion 1 -docBasePath
+                  https://square.github.io/keywhiz/apidocs -apiBasePath
+                  https://square.github.io/keywhiz/apidocs -resourceTags -fieldDescriptionTags
+                </additionalOptions>
+              </configuration>
+              <goals>
+                <goal>javadoc</goal>
+              </goals>
+            </execution>
+          </executions>
         </plugin>
 
         <plugin>

diff --git a/server/pom.xml b/server/pom.xml
@@ -299,7 +299,8 @@
               </docletArtifact>
               <reportOutputDirectory>../docs</reportOutputDirectory>
               <useStandardDocletOptions>false</useStandardDocletOptions>
-              <additionalparam>-logDebug -apiVersion 1 -docBasePath https://square.github.io/keywhiz/apidocs -apiBasePath https://square.github.io/keywhiz/apidocs -resourceTags -fieldDescriptionTags</additionalparam>
+              <doclint>none</doclint>
+              <additionalOptions>-logDebug -apiVersion 1 -docBasePath https://square.github.io/keywhiz/apidocs -apiBasePath https://square.github.io/keywhiz/apidocs -resourceTags -fieldDescriptionTags</additionalOptions>
             </configuration>
             <goals>
               <goal>javadoc</goal>