v3.0.0

Author: arnets

src/main/java/com/emc/object/s3/S3Config.java

@@ -81,7 +81,7 @@ protected static int defaultPort(Protocol protocol) {
     protected int retryLimit = DEFAULT_RETRY_LIMIT;
     protected int retryBufferSize = DEFAULT_RETRY_BUFFER_SIZE;
     protected float faultInjectionRate = 0.0f;
-    protected boolean signMetadataSearch = false; // TODO: make this true for 3.0
+    protected boolean signMetadataSearch = true;
 
     /**
      * Empty constructor for internal use only!

src/main/java/com/emc/object/s3/S3Constants.java

@@ -74,6 +74,7 @@ public final class S3Constants {
     public static final String PARAM_RESPONSE_HEADER_CONTENT_LANGUAGE = "response-content-language";
     public static final String PARAM_RESPONSE_HEADER_CONTENT_TYPE = "response-content-type";
     public static final String PARAM_RESPONSE_HEADER_EXPIRES = "response-expires";
+    public static final String PARAM_SEARCH_METADATA = "searchmetadata";
     public static final String PARAM_SIGNATURE = "Signature";
     public static final String PARAM_SORTED = "sorted";
     public static final String PARAM_UPLOAD_ID = "uploadId";

src/main/java/com/emc/object/s3/S3AuthUtil.java renamed to src/main/java/com/emc/object/s3/S3SignerV2.java

@@ -44,14 +44,15 @@
 import java.security.NoSuchAlgorithmException;
 import java.util.*;
 
-public final class S3AuthUtil {
+public final class S3SignerV2 {
+    private static final Logger log = LoggerFactory.getLogger(S3SignerV2.class);
 
-    private static final Logger log = LoggerFactory.getLogger(S3AuthUtil.class);
+    private S3Config s3Config;
+    private SortedSet<String> signedParameters;
 
-    public static SortedSet<String> SIGNED_PARAMETERS;
-
-    static {
-        SIGNED_PARAMETERS = new TreeSet<String>(Arrays.asList(
+    public S3SignerV2(S3Config s3Config) {
+        this.s3Config = s3Config;
+        signedParameters = new TreeSet<String>(Arrays.asList(
                 "acl", "torrent", "logging", "location", "policy", "requestPayment", "versioning",
                 "versions", "versionId", "notification", "uploadId", "uploads", "partNumber", "website",
                 "delete", "lifecycle", "tagging", "cors", "restore",
@@ -63,16 +64,19 @@ public final class S3AuthUtil {
                 S3Constants.PARAM_RESPONSE_HEADER_EXPIRES,
                 S3Constants.PARAM_ENDPOINT,
                 S3Constants.PARAM_IS_STALE_ALLOWED));
+        if (s3Config.isSignMetadataSearch()) {
+            signedParameters.add(S3Constants.PARAM_QUERY);
+            signedParameters.add(S3Constants.PARAM_SEARCH_METADATA);
+        }
     }
 
-    public static void sign(String method, String resource, Map<String, String> parameters, Map<String, List<Object>> headers,
-                            String accessKey, String secretKey, long clockSkew) {
-        String stringToSign = getStringToSign(method, resource, parameters, headers, clockSkew);
-        String signature = getSignature(stringToSign, secretKey);
-        RestUtil.putSingle(headers, "Authorization", "AWS " + accessKey + ":" + signature);
+    public void sign(String method, String resource, Map<String, String> parameters, Map<String, List<Object>> headers) {
+        String stringToSign = getStringToSign(method, resource, parameters, headers);
+        String signature = getSignature(stringToSign);
+        RestUtil.putSingle(headers, "Authorization", "AWS " + s3Config.getIdentity() + ":" + signature);
     }
 
-    public static URL generatePresignedUrl(PresignedUrlRequest request, S3Config s3Config) {
+    public URL generatePresignedUrl(PresignedUrlRequest request) {
         String namespace = request.getNamespace() != null ? request.getNamespace() : s3Config.getNamespace();
 
         URI uri = s3Config.resolvePath(request.getPath(), null); // don't care about the query string yet
@@ -100,9 +104,8 @@ public static URL generatePresignedUrl(PresignedUrlRequest request, S3Config s3C
         queryParams.put(S3Constants.PARAM_ACCESS_KEY, s3Config.getIdentity());
 
         // sign the request
-        String stringToSign = S3AuthUtil.getStringToSign(request.getMethod().toString(), resource,
-                queryParams, request.getHeaders(), s3Config.getServerClockSkew());
-        String signature = S3AuthUtil.getSignature(stringToSign, s3Config.getSecretKey());
+        String stringToSign = getStringToSign(request.getMethod().toString(), resource, queryParams, request.getHeaders());
+        String signature = getSignature(stringToSign);
 
         // add signature to query string
         queryParams.put(S3Constants.PARAM_SIGNATURE, signature);
@@ -118,8 +121,8 @@ public static URL generatePresignedUrl(PresignedUrlRequest request, S3Config s3C
         }
     }
 
-    public static String getStringToSign(String method, String resource, Map<String, String> parameters,
-                                         Map<String, List<Object>> headers, long clockSkew) {
+    public String getStringToSign(String method, String resource, Map<String, String> parameters,
+                                  Map<String, List<Object>> headers) {
         StringBuilder stringToSign = new StringBuilder();
 
         // method line
@@ -140,7 +143,7 @@ public static String getStringToSign(String method, String resource, Map<String,
         String date = RestUtil.getFirstAsString(headers, RestUtil.HEADER_DATE);
         if (date == null) {
             // must have a date in the headers
-            date = RestUtil.getRequestDate(clockSkew);
+            date = RestUtil.getRequestDate(s3Config.getServerClockSkew());
             RestUtil.putSingle(headers, RestUtil.HEADER_DATE, date);
         }
         // if x-amz-date is specified, date line should be blank
@@ -162,7 +165,7 @@ public static String getStringToSign(String method, String resource, Map<String,
         // resource path (includes signed parameters)
         stringToSign.append(resource);
         boolean firstParameter = true;
-        for (String parameter : SIGNED_PARAMETERS) {
+        for (String parameter : signedParameters) {
             if (parameters.containsKey(parameter)) {
                 stringToSign.append(firstParameter ? "?" : "&").append(parameter);
                 String value = parameters.get(parameter);
@@ -176,7 +179,7 @@ public static String getStringToSign(String method, String resource, Map<String,
         return stringToSignStr;
     }
 
-    public static SortedMap<String, String> getCanonicalizedHeaders(Map<String, List<Object>> headers, Map<String, String> parameters) {
+    private SortedMap<String, String> getCanonicalizedHeaders(Map<String, List<Object>> headers, Map<String, String> parameters) {
         SortedMap<String, String> canonicalizedHeaders = new TreeMap<String, String>();
 
         // add x-emc- and x-amz- headers
@@ -198,7 +201,7 @@ public static SortedMap<String, String> getCanonicalizedHeaders(Map<String, List
         return canonicalizedHeaders;
     }
 
-    public static String trimAndJoin(List<Object> values, String delimiter) {
+    private String trimAndJoin(List<Object> values, String delimiter) {
         if (values == null || values.isEmpty()) return null;
         StringBuilder delimited = new StringBuilder();
         Iterator<Object> valuesI = values.iterator();
@@ -209,10 +212,10 @@ public static String trimAndJoin(List<Object> values, String delimiter) {
         return delimited.toString();
     }
 
-    public static String getSignature(String stringToSign, String secretKey) {
+    public String getSignature(String stringToSign) {
         try {
             Mac mac = Mac.getInstance("HmacSHA1");
-            mac.init(new SecretKeySpec(secretKey.getBytes("UTF-8"), "HmacSHA1")); // AWS does not B64-decode the secret key!
+            mac.init(new SecretKeySpec(s3Config.getSecretKey().getBytes("UTF-8"), "HmacSHA1")); // AWS does not B64-decode the secret key!
             String signature = new String(Base64.encodeBase64(mac.doFinal(stringToSign.getBytes("UTF-8"))));
             log.debug("signature:\n" + signature);
             return signature;
@@ -221,10 +224,7 @@ public static String getSignature(String stringToSign, String secretKey) {
         } catch (UnsupportedEncodingException e) {
             throw new RuntimeException("UTF-8 encoding is not supported on this platform", e);
         } catch (InvalidKeyException e) {
-            throw new RuntimeException("The secret key \"" + secretKey + "\" is not valid", e);
+            throw new RuntimeException("The secret key \"" + s3Config.getSecretKey() + "\" is not valid", e);
         }
     }
-
-    private S3AuthUtil() {
-    }
 }

src/main/java/com/emc/object/s3/bean/LifecycleRule.java

@@ -26,7 +26,10 @@
  */
 package com.emc.object.s3.bean;
 
+import com.emc.object.util.Iso8601DateAdapter;
+
 import javax.xml.bind.annotation.*;
+import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;
 import java.util.Date;
 
 @XmlType(propOrder = {"id", "prefix", "status", "expiration"})
@@ -150,6 +153,7 @@ protected static class Expiration {
         @XmlElement(name = "Days")
         public Integer days;
         @XmlElement(name = "Date")
+        @XmlJavaTypeAdapter(value = Iso8601DateAdapter.class)
         public Date date;
     }
 

src/main/java/com/emc/object/s3/bean/package-info.java

@@ -26,11 +26,12 @@
  */
 @XmlSchema(namespace = "http://s3.amazonaws.com/doc/2006-03-01/", elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)
 @XmlJavaTypeAdapters({
-        @XmlJavaTypeAdapter(value = com.emc.object.util.Iso8601Adapter.class, type = java.util.Date.class),
+        @XmlJavaTypeAdapter(value = Iso8601DateTimeAdapter.class, type = java.util.Date.class),
         @XmlJavaTypeAdapter(value = RegionAdapter.class, type = com.emc.object.s3.bean.Region.class)
 }) package com.emc.object.s3.bean;
 
 import com.emc.object.s3.RegionAdapter;
+import com.emc.object.util.Iso8601DateTimeAdapter;
 
 import javax.xml.bind.annotation.XmlSchema;
 import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

src/main/java/com/emc/object/s3/jersey/AuthorizationFilter.java

@@ -26,9 +26,9 @@
  */
 package com.emc.object.s3.jersey;
 
-import com.emc.object.s3.S3AuthUtil;
 import com.emc.object.s3.S3Config;
 import com.emc.object.s3.S3Constants;
+import com.emc.object.s3.S3SignerV2;
 import com.emc.object.util.RestUtil;
 import com.sun.jersey.api.client.ClientHandlerException;
 import com.sun.jersey.api.client.ClientRequest;
@@ -39,9 +39,11 @@
 
 public class AuthorizationFilter extends ClientFilter {
     private S3Config s3Config;
+    private S3SignerV2 signer;
 
     public AuthorizationFilter(S3Config s3Config) {
         this.s3Config = s3Config;
+        this.signer = new S3SignerV2(s3Config);
     }
 
     @Override
@@ -68,13 +70,10 @@ public ClientResponse handle(ClientRequest request) throws ClientHandlerExceptio
                 if (namespace != null) resource = "/" + namespace + resource;
             }
 
-            S3AuthUtil.sign(request.getMethod(),
+            signer.sign(request.getMethod(),
                     resource,
                     parameters,
-                    request.getHeaders(),
-                    s3Config.getIdentity(),
-                    s3Config.getSecretKey(),
-                    s3Config.getServerClockSkew());
+                    request.getHeaders());
         }
 
         return getNext().handle(request);

src/main/java/com/emc/object/s3/jersey/S3JerseyClient.java

@@ -128,6 +128,7 @@ public class S3JerseyClient extends AbstractJerseyClient implements S3Client {
     protected S3Config s3Config;
     protected Client client;
     protected LoadBalancer loadBalancer;
+    protected S3SignerV2 signer;
 
     public S3JerseyClient(S3Config s3Config) {
         this(s3Config, null);
@@ -142,6 +143,7 @@ public S3JerseyClient(S3Config s3Config) {
     public S3JerseyClient(S3Config config, ClientHandler clientHandler) {
         super(new S3Config(config)); // deep-copy config so that two clients don't share the same host lists (SDK-122)
         s3Config = (S3Config) super.getObjectConfig();
+        this.signer = new S3SignerV2(s3Config);
 
         SmartConfig smartConfig = s3Config.toSmartConfig();
         loadBalancer = smartConfig.getLoadBalancer();
@@ -424,12 +426,13 @@ public Map<String, List<Object>> getHeaders() {
 
     @Override
     public MetadataSearchList listSystemMetadataSearchKeys() {
-        return executeRequest(client, new ObjectRequest(Method.GET, "", "searchmetadata"), MetadataSearchList.class);
+        ObjectRequest request = new ObjectRequest(Method.GET, "", S3Constants.PARAM_SEARCH_METADATA);
+        return executeRequest(client, request, MetadataSearchList.class);
     }
 
     @Override
     public MetadataSearchList listBucketMetadataSearchKeys(String bucketName) {
-        ObjectRequest request = new GenericBucketRequest(Method.GET, bucketName, "searchmetadata");
+        ObjectRequest request = new GenericBucketRequest(Method.GET, bucketName, S3Constants.PARAM_SEARCH_METADATA);
         return executeRequest(client, request, MetadataSearchList.class);
     }
 
@@ -595,7 +598,7 @@ public URL getPresignedUrl(String bucketName, String key, Date expirationTime) {
 
     @Override
     public URL getPresignedUrl(PresignedUrlRequest request) {
-        return S3AuthUtil.generatePresignedUrl(request, s3Config);
+        return signer.generatePresignedUrl(request);
     }
 
     @Override

src/main/java/com/emc/object/util/Iso8601DateAdapter.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2015-2016, EMC Corporation.
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * + Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the following disclaimer.
+ * + Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * + The name of EMC Corporation may not be used to endorse or promote
+ *   products derived from this software without specific prior written
+ *   permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
+ * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+ * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+ * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+ * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ */
+package com.emc.object.util;
+
+import javax.xml.bind.annotation.adapters.XmlAdapter;
+import java.text.DateFormat;
+import java.text.SimpleDateFormat;
+import java.util.Date;
+import java.util.TimeZone;
+
+public class Iso8601DateAdapter extends XmlAdapter<String, Date> {
+    private static final String ISO_8601_FORMAT = "yyyy-MM-dd";
+
+    // DateFormat is *not* thread-safe!
+    private static final ThreadLocal<DateFormat> iso8601Format = new ThreadLocal<DateFormat>();
+
+    @Override
+    public Date unmarshal( String s ) throws Exception {
+        return getFormat().parse( s );
+    }
+
+    @Override
+    public String marshal( Date date ) throws Exception {
+        return getFormat().format( date );
+    }
+
+    public static DateFormat getFormat() {
+        DateFormat format = iso8601Format.get();
+        if ( format == null ) {
+            format = new SimpleDateFormat( ISO_8601_FORMAT );
+            format.setTimeZone( TimeZone.getTimeZone( "UTC" ) );
+            iso8601Format.set( format );
+        }
+        return format;
+    }
+}

src/main/java/com/emc/object/util/Iso8601Adapter.java renamed to src/main/java/com/emc/object/util/Iso8601DateTimeAdapter.java

@@ -35,7 +35,7 @@
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
-public class Iso8601Adapter extends XmlAdapter<String, Date> {
+public class Iso8601DateTimeAdapter extends XmlAdapter<String, Date> {
     private static final String ISO_8601_FORMAT = "yyyy-MM-dd'T'HH:mm:ss'Z'";
 
     // DateFormat is *not* thread-safe!