Trunk

NOTICE

@@ -1,2 +1,5 @@
+Apache Oltu
+Copyright 2010-2017 The Apache Software Foundation
+
 This product includes software developed by
 The Apache Software Foundation (http://www.apache.org/).

commons/deploySite.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF 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.
+#
+
+mvn clean site site:stage -P site
+mvn scm-publish:publish-scm -Dusername=$1 -Dpassword=$2 -P site

commons/encodedtoken/pom.xml

@@ -0,0 +1,49 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF 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.
+-->
+<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>
+
+  <parent>
+    <groupId>org.apache.oltu.commons</groupId>
+    <artifactId>org.apache.oltu.commons.parent</artifactId>
+    <version>3-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>org.apache.oltu.commons.encodedtoken</artifactId>
+  <version>1.0.2-SNAPSHOT</version>
+  <packaging>bundle</packaging>
+
+  <name>Apache Oltu - Commons - Encoded Token</name>
+  <description>Apache Oltu Encoded Token shared utility</description>
+
+  <properties>
+    <!--
+   	OSGi settings
+    -->
+    <osgi.import>org.apache.commons.codec.binary;version="[1.4,2)"</osgi.import>
+  </properties>
+
+  <dependencies>
+    <dependency>
+      <groupId>commons-codec</groupId>
+      <artifactId>commons-codec</artifactId>
+      <version>1.9</version>
+    </dependency>
+  </dependencies>
+
+</project>

commons/encodedtoken/src/main/java/org/apache/oltu/commons/encodedtoken/TokenDecoder.java

@@ -0,0 +1,51 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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 org.apache.oltu.commons.encodedtoken;
+
+import java.nio.charset.Charset;
+
+import org.apache.commons.codec.binary.Base64;
+
+public abstract class TokenDecoder {
+
+    /**
+     * The {@code UTF-8} charset reference.
+     */
+    private static final Charset UTF_8 = Charset.forName("UTF-8");
+
+    /**
+     * Empty Line separator for rfc 2045 section 6.8
+     * {@see org.apache.commons.codec.binary.Base64}
+     */
+    private static final byte[] LINE_SEPARATOR = {};
+
+    public static final String base64Decode(String base64encoded) {
+        return new String(new Base64(-1, LINE_SEPARATOR, true).decode(base64encoded), UTF_8);
+    }
+
+    public static final byte[] base64DecodeToByte(String base64encoded) {
+        return new Base64(-1, LINE_SEPARATOR, true).decode(base64encoded);
+    }
+
+    public static final String base64Encode(String input) {
+        return new String(new Base64(-1, LINE_SEPARATOR, true).encode(input.getBytes(UTF_8)), UTF_8);
+    }
+
+    public static final String base64Encode(byte [] input) {
+        return new String(new Base64(-1, LINE_SEPARATOR, true).encode(input));
+    }
+}

commons/encodedtoken/src/main/java/org/apache/oltu/commons/encodedtoken/TokenReader.java

@@ -0,0 +1,92 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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 org.apache.oltu.commons.encodedtoken;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.StringReader;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public abstract class TokenReader<T> extends TokenDecoder {
+
+    /**
+     * The Base64 JSON string default separator.
+     */
+    private final Pattern base64urlTokenPattern = Pattern.compile("([a-zA-Z0-9-​_=]+)\\.([a-zA-Z0-9-_​=]+)\\.([a-zA-Z0-9-_=]+)");
+
+    /**
+     * Read the base64url token string
+     * @param base64String
+     * @return
+     */
+    public T read(String base64String) {
+        if (base64String == null || base64String.isEmpty()) {
+            throw new IllegalArgumentException("Impossible to obtain a Token from a null or empty string");
+        }
+
+        // TODO improve multi-line tokens
+        StringBuilder buffer = new StringBuilder();
+        BufferedReader reader = new BufferedReader(new StringReader(base64String));
+        String line = null;
+        try {
+            while ((line = reader.readLine()) != null) {
+                buffer.append(line.trim());
+            }
+        } catch (IOException e) {
+            // it cannot happen
+        } finally {
+            try {
+                reader.close();
+            } catch (IOException e) {
+                // swallow it
+            }
+        }
+
+        Matcher matcher = base64urlTokenPattern.matcher(buffer.toString());
+        if (!matcher.matches()) {
+            throw new IllegalArgumentException(base64String
+                                               + "is not a valid Token, it does not match with the pattern: "
+                                               + base64urlTokenPattern.pattern());
+        }
+
+        // HEADER
+        String header = matcher.group(1);
+        String decodedHeader = base64Decode(header);
+
+        // BODY
+        String body = matcher.group(2);
+        String decodedBody = base64Decode(body);
+
+        // SIGNATURE
+        // Keep signature encoded in base64url
+        String signature = matcher.group(3);
+
+        return build(base64String, decodedHeader, decodedBody, signature);
+    }
+
+    /**
+     * Build the token reader
+     *
+     * @param rawString
+     * @param decodedHeader
+     * @param decodedBody
+     * @param encodedSignature
+     * @return
+     */
+    protected abstract T build(String rawString, String decodedHeader, String decodedBody, String encodedSignature);
+}

commons/encodedtoken/src/main/java/org/apache/oltu/commons/encodedtoken/TokenWriter.java

@@ -0,0 +1,49 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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 org.apache.oltu.commons.encodedtoken;
+
+public abstract class TokenWriter<T> extends TokenDecoder {
+
+    public final String write(T token) {
+        if (token == null) {
+            throw new IllegalArgumentException("Impossible to build a Token from a null JWS representation.");
+        }
+
+        String header = writeHeader(token);
+        String encodedHeader = base64Encode(header);
+
+        String body = writeBody(token);
+        String encodedBody = base64Encode(body);
+
+        String signature = writeSignature(token);
+
+        return new StringBuilder()
+                   .append(encodedHeader)
+                   .append('.')
+                   .append(encodedBody)
+                   .append('.')
+                   .append(signature)
+                   .toString();
+    }
+
+    protected abstract String writeHeader(T token);
+
+    protected abstract String writeBody(T token);
+
+    protected abstract String writeSignature(T token);
+
+}

commons/encodedtoken/src/main/java/org/apache/oltu/commons/encodedtoken/package-info.java

@@ -0,0 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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.
+ */
+
+/**
+ * Common reusable Encoded Token utilities.
+ */
+package org.apache.oltu.commons.encodedtoken;

commons/encodedtoken/src/test/java/org/apache/oltu/commons/encodedtoken/TokenReaderTest.java

@@ -0,0 +1,57 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF 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 org.apache.oltu.commons.encodedtoken;
+
+import org.junit.Assert;
+import org.junit.Test;
+
+public class TokenReaderTest {
+
+    private TokenReader tokenReader;
+
+    @Test
+    public void test_read() {
+        tokenReader = new TokenReader<String>() {
+            protected String build(String rawString, String decodedHeader,
+                    String decodedBody, String encodedSignature) {
+
+                return "";
+            }
+        };
+
+        String accessToken = "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJqb2UiLA0KICJleHAiOjEzMDA4MTkzODAsDQogImh0dHA6Ly9leGFtcGxlLmNvbS9pc19yb290Ijp0cnVlfQ.cC4hiUPoj9Eetdgtv3hF80EGrhuB__dzERat0XF9g2VtQgr9PJbu3XOiZj5RZmh7AAuHIm4Bh-0Qc_lF5YKt_O8W2Fp5jujGbds9uJdbF9CUAr7t1dnZcAcQjbKBYNX4BAynRFdiuB--f_nZLgrnbyTyWzO75vRK5h6xBArLIARNPvkSjtQBMHlb1L07Qe7K0GarZRmB_eSN9383LcOLn6_dO--xi12jzDwusC-eOkHWEsqtFZESc6BfI7noOPqvhJ1phCnvWh6IeYI2w9QOYEUipUTI8np6LbgGY9Fs98rqVt5AXLIhWkWywlVmtVrBp0igcN_IoypGlUPQGe77Rw";
+        Assert.assertNotNull(tokenReader.read(accessToken));
+    }
+
+    @Test
+    public void test_read2() {
+        tokenReader = new TokenReader<String>() {
+            protected String build(String rawString, String decodedHeader,
+                    String decodedBody, String encodedSignature) {
+                return null;
+            }
+        };
+        String accessToken = "BadToken";
+        try {
+            tokenReader.read(accessToken);
+            Assert.fail("failed test");
+        }catch (IllegalArgumentException e) {
+            //expected
+        }
+
+    }
+}