[java-identity-provider] 02/02: IDP-1111 - Provide a case-insensitive computed persistent ID strategy

[Scott Cantor]

This is an automated email from the git hooks/post-receive script.

scantor pushed a commit to branch maint-3.3
in repository java-identity-provider.

View the commit online:
http://git.shibboleth.net/view/?p=java-identity-provider.git;a=commit;h=0929b406fb3e342a49ed4d44709c59dcdac345ec

commit 0929b406fb3e342a49ed4d44709c59dcdac345ec
Author: Scott Cantor <cantor.2 at osu.edu>
AuthorDate: Thu Sep 28 21:13:11 2017 -0400

    IDP-1111 - Provide a case-insensitive computed persistent ID strategy
    
    https://issues.shibboleth.net/jira/browse/IDP-1111
    
    Copied Base32Support class into package to support the
    new feature on the branch.
---
 .../idp/saml/nameid/impl/Base32Support.java        | 87 ++++++++++++++++++++++
 .../ComputedPersistentIdGenerationStrategy.java    |  1 -
 2 files changed, 87 insertions(+), 1 deletion(-)

diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/nameid/impl/Base32Support.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/nameid/impl/Base32Support.java
new file mode 100644
index 0000000..c052c53
--- /dev/null
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/nameid/impl/Base32Support.java
@@ -0,0 +1,87 @@
+/*
+ * Licensed to the University Corporation for Advanced Internet Development,
+ * Inc. (UCAID) under one or more contributor license agreements.  See the
+ * NOTICE file distributed with this work for additional information regarding
+ * copyright ownership. The UCAID licenses this file to You 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
+ *
+ *    http://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.
+ */
+
+package net.shibboleth.idp.saml.nameid.impl;
+
+import javax.annotation.Nonnull;
+
+import net.shibboleth.utilities.java.support.logic.Constraint;
+import net.shibboleth.utilities.java.support.primitive.StringSupport;
+
+import org.apache.commons.codec.binary.Base32;
+
+/**
+ * Helper class for working with {@link Base32}.
+ * 
+ * <p>
+ * This helper class specifically addresses that waste of the Apache Codec encode/decode static methods creating new
+ * instances of the {@link Base32} for every operation. It also provides the helper method to produce both chunked and
+ * unchunked encoded content as strings.
+ * </p>
+ * 
+ * <p>This is present solely to avoid requiring a bump to java-support for this patch version.</p>
+ * 
+ * @since 3.3.2
+ */
+public final class Base32Support {
+
+    /** Chunk the encoded data into 76-character lines broken by CRLF characters. */
+    public static final boolean CHUNKED = true;
+
+    /** Do not chunk encoded data. */
+    public static final boolean UNCHUNKED = false;
+
+    /** Encoder used to produce chunked output. */
+    private static final Base32 CHUNKED_ENCODER = new Base32(76, new byte[] { '\n' });
+
+    /** Encoder used to produce unchunked output. */
+    private static final Base32 UNCHUNKED_ENCODER = new Base32(0, new byte[] { '\n' });
+
+    /** Constructor. */
+    private Base32Support() {
+
+    }
+
+    /**
+     * Base32 encodes the given binary data.
+     * 
+     * @param data data to encode
+     * @param chunked whether the encoded data should be chunked or not
+     * 
+     * @return the base32 encoded data
+     */
+    @Nonnull public static String encode(@Nonnull final byte[] data, final boolean chunked) {
+        Constraint.isNotNull(data, "Binary data to be encoded can not be null");
+        if (chunked) {
+            return StringSupport.trim(CHUNKED_ENCODER.encodeToString(data));
+        } else {
+            return StringSupport.trim(UNCHUNKED_ENCODER.encodeToString(data));
+        }
+    }
+
+    /**
+     * Decodes (un)chunked Base32 encoded data.
+     * 
+     * @param data Base32 encoded data
+     * 
+     * @return the decoded data
+     */
+    @Nonnull public static byte[] decode(@Nonnull final String data) {
+        Constraint.isNotNull(data, "Base32 encoded data cannot be null");
+        return CHUNKED_ENCODER.decode(data);
+    }
+}
\ No newline at end of file
diff --git a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/nameid/impl/ComputedPersistentIdGenerationStrategy.java b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/nameid/impl/ComputedPersistentIdGenerationStrategy.java
index b4d6eb8..a8b39f9 100644
--- a/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/nameid/impl/ComputedPersistentIdGenerationStrategy.java
+++ b/idp-saml-impl/src/main/java/net/shibboleth/idp/saml/nameid/impl/ComputedPersistentIdGenerationStrategy.java
@@ -25,7 +25,6 @@ import javax.annotation.Nullable;
 
 import net.shibboleth.utilities.java.support.annotation.constraint.NonnullAfterInit;
 import net.shibboleth.utilities.java.support.annotation.constraint.NotEmpty;
-import net.shibboleth.utilities.java.support.codec.Base32Support;
 import net.shibboleth.utilities.java.support.codec.Base64Support;
 import net.shibboleth.utilities.java.support.component.AbstractInitializableComponent;
 import net.shibboleth.utilities.java.support.component.ComponentInitializationException;

-- 
To stop receiving notification emails like this one, please contact
the administrator of this repository.