Updating to fix issues with transitive dependencies

Author: adamcin

api/src/main/java/net/adamcin/httpsig/api/Base64.java

@@ -36,7 +36,7 @@
  * <p>Example:</p>
  *
  * <code>String encoded = Base64.encode( myByteArray );</code>
- * <br />
+ * <br>
  * <code>byte[] myByteArray = Base64.decode( encoded );</code>
  *
  * <p>The <tt>options</tt> parameter, which appears in a few places, is used to pass

api/src/main/java/net/adamcin/httpsig/api/DefaultKeychain.java

@@ -144,7 +144,7 @@ public Keychain discard() {
 
     /**
      *
-     * @return
+     * @return the current key
      * @throws NoSuchElementException if the keychain is empty
      */
     public Key currentKey() {

api/src/main/java/net/adamcin/httpsig/api/Keychain.java

@@ -43,7 +43,7 @@ public interface Keychain extends Iterable<Key> {
 
     /**
      * Filter this keychain by a {@link Collection} of supported {@link Algorithm}s
-     * @param algorithms
+     * @param algorithms supported algorithms
      * @return a new {@link Keychain} containing only those keys which support at least one of the provided algorithms
      */
     Keychain filterAlgorithms(Collection<Algorithm> algorithms);
@@ -59,8 +59,8 @@ public interface Keychain extends Iterable<Key> {
     Key currentKey();
 
     /**
-     * @param keyId
-     * @return a {@link Map} where the values are the {@link Key}s and the map entry keys are the keyId's generated by the {@link KeyId}, o
+     * @param keyId the KeyId
+     * @return a {@link Map} where the values are the {@link Key}s and the map entry keys are the keyId's generated by the {@link KeyId}
      */
     Map<String, Key> toMap(KeyId keyId);
 

api/src/main/java/net/adamcin/httpsig/api/RequestContent.java

@@ -92,9 +92,9 @@ public Builder setRequestTarget(String method, String path) {
         /**
          * Adds a header name and value pair
          *
-         * @param name
-         * @param value
-         * @return
+         * @param name header name
+         * @param value header value
+         * @return the Builder in fluent fashion
          */
         public Builder addHeader(final String name, final String value) {
             if (value != null) {
@@ -179,6 +179,7 @@ public RequestContent build() {
      * Returns the signature content as a byte array
      *
      * @param headers the list of headers to be included in the signed content
+     * @param charset charset for decoding the content
      * @return the result of {@link #getContentString(java.util.List)} encoded using the provided {@link Charset}
      */
     public byte[] getContent(List<String> headers, Charset charset) {
@@ -189,7 +190,7 @@ public byte[] getContent(List<String> headers, Charset charset) {
      * Returns the signature content as a String
      *
      * @param headers the list of headers to be included in the signed content
-     * @return
+     * @return formatted content to be signed
      */
     public String getContentString(List<String> headers) {
         StringBuilder hashBuilder = new StringBuilder();

http-helpers/pom.xml

@@ -98,7 +98,7 @@
         <dependency>
             <groupId>org.apache.httpcomponents</groupId>
             <artifactId>httpclient</artifactId>
-            <version>4.1</version>
+            <version>[4.3,5.0)</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

http-helpers/src/main/java/net/adamcin/httpsig/http/servlet/ServletUtil.java

@@ -79,7 +79,7 @@ public static RequestContent getRequestContent(HttpServletRequest request) {
      * Parse an {@link javax.servlet.http.HttpServletRequest} to build the {@link net.adamcin.httpsig.api.RequestContent}
      * @param request the HTTP Request
      * @param ignoreHeaders a collection of header names to ignore, in case they have been added by proxies
-     * @return
+     * @return the signable request content
      */
     public static RequestContent getRequestContent(HttpServletRequest request, Collection<String> ignoreHeaders) {
         final Set<String> _ignore = new HashSet<String>();

pom.xml

@@ -88,8 +88,8 @@
             <name>Mark Adamcin</name>
             <email>adamcin@gmail.com</email>
             <url>http://adamcin.net</url>
-            <organization>Mashery</organization>
-            <organizationUrl>http://www.mashery.com</organizationUrl>
+            <organization>Infield Digital</organization>
+            <organizationUrl>https://www.infielddigital.com</organizationUrl>
             <roles>
                 <role>architect</role>
                 <role>developer</role>
@@ -185,7 +185,7 @@
                 <plugin>
                     <groupId>com.github.github</groupId>
                     <artifactId>site-maven-plugin</artifactId>
-                    <version>0.10</version>
+                    <version>0.12</version>
                     <executions>
                         <execution>
                             <id>github-site-deploy</id>
@@ -219,15 +219,15 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-release-plugin</artifactId>
-                <version>2.5</version>
+                <version>2.5.3</version>
                 <configuration>
                     <autoVersionSubmodules>true</autoVersionSubmodules>
                 </configuration>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-site-plugin</artifactId>
-                <version>3.3</version>
+                <version>3.5.1</version>
                 <configuration>
                     <inputEncoding>utf-8</inputEncoding>
                 </configuration>
@@ -251,7 +251,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-project-info-reports-plugin</artifactId>
-                <version>2.7</version>
+                <version>2.9</version>
             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
@@ -325,7 +325,7 @@
             <dependency>
                 <groupId>commons-io</groupId>
                 <artifactId>commons-io</artifactId>
-                <version>1.4</version>
+                <version>[1.4,3.0)</version>
                 <scope>provided</scope>
             </dependency>
             <dependency>
@@ -382,7 +382,7 @@
             <dependency>
                 <groupId>net.adamcin.commons</groupId>
                 <artifactId>net.adamcin.commons.testing</artifactId>
-                <version>0.8.0</version>
+                <version>[0.9.0,1.0.0)</version>
                 <scope>test</scope>
             </dependency>
         </dependencies>

src/site/site.xml

@@ -30,7 +30,7 @@
     <skin>
         <groupId>org.apache.maven.skins</groupId>
         <artifactId>maven-fluido-skin</artifactId>
-        <version>1.3.0</version>
+        <version>1.5</version>
     </skin>
     <googleAnalyticsAccountId>UA-37073514-1</googleAnalyticsAccountId>
     <custom>

ssh-bc/src/main/java/net/adamcin/httpsig/ssh/bc/PEMUtil.java

@@ -55,10 +55,10 @@ public class PEMUtil {
 
     /**
      * Read a single PEM-formatted key
-     * @param is
-     * @param passphrase
-     * @return
-     * @throws IOException
+     * @param is input stream
+     * @param passphrase passphrase protecting stream
+     * @return the key if successful, null if not
+     * @throws IOException if not successful because I/O
      */
     public static Key readKey(InputStream is, final char[] passphrase) throws IOException {
         JcaPEMKeyConverter converter = new JcaPEMKeyConverter();
@@ -99,10 +99,10 @@ public static Key readKey(InputStream is, final char[] passphrase) throws IOExce
     /**
      *
      * Read a single PEM-formatted key
-     * @param privateKeyFile
-     * @param passphrase
-     * @return
-     * @throws IOException
+     * @param privateKeyFile private key file
+     * @param passphrase passphrase for protected file
+     * @return key if successful
+     * @throws IOException if not successful
      */
     public static Key readKey(File privateKeyFile, final char[] passphrase) throws IOException {
         InputStream is = null;
@@ -120,10 +120,10 @@ public static Key readKey(File privateKeyFile, final char[] passphrase) throws I
     /**
      *
      * Read a single PEM-formatted key
-     * @param keyBytes
-     * @param passphrase
-     * @return
-     * @throws IOException
+     * @param keyBytes data for key
+     * @param passphrase passphrase
+     * @return key if successful
+     * @throws IOException if not successful
      */
     public static Key readKey(byte[] keyBytes, final char[] passphrase) throws IOException {
         ByteArrayInputStream is = null;

ssh-jce/src/main/java/net/adamcin/httpsig/ssh/jce/AuthorizedKeys.java

@@ -83,6 +83,7 @@ public static Keychain defaultKeychain() throws IOException {
      * @param authorizedKeysFile File in the RFC4253 authorized_keys format that every Linux admin knows and loves,
      *                           which contains a list of public keys which are allowed for authentication
      * @return a {@link Keychain} attached to the authorized_keys identities
+     * @throws IOException for any failure to parse designated file
      */
     public static Keychain newKeychain(File authorizedKeysFile) throws IOException {
         DefaultKeychain identities = new DefaultKeychain();