Merge pull request #156 from tfelix/feature/keystone3-auth-scoping

feat: Adds support for KeystoneV3 scoping during auth
javaswift · May 20, 2019 · 0a5707c · 0a5707c
2 parents 33902ea + 7c7b948
commit 0a5707c
Show file tree

Hide file tree

Showing 14 changed files with 259 additions and 21 deletions.
diff --git a/src/main/java/org/javaswift/joss/client/factory/AccountConfig.java b/src/main/java/org/javaswift/joss/client/factory/AccountConfig.java
@@ -215,7 +215,26 @@ public class AccountConfig {
      */
     private AuthenticationMethod authenticationMethod = KEYSTONE;
 
-    private AuthenticationMethod.AccessProvider accessProvider = null ;
+    private AuthenticationMethod.AccessProvider accessProvider = null;
+
+    /**
+     * Sets the scope of authentication when using the {@link AuthenticationMethod} Keystone V3.
+     * During authentication you can request a scope against a certain domain or project. Which might be required by
+     * your Keystone installation.
+     * <ul>
+     *     <li>
+     *         <b>DEFAULT</b>; Default authentication with no special scope. This is also the default setting.
+     *     </li>
+     *     <li>
+     *         <b>PROJECT_NAME</b>; Scopes against a tenant/project name. You must also provide the TenantName.
+     *     </li>
+     *     <li>
+     *         <b>DOMAIN_NAME</b>; Scopes against a domain name. You must also provide the Domain.
+     *     </li>
+     *
+     * </ul>
+     */
+    private AuthenticationMethodScope authenticationMethodScope = AuthenticationMethodScope.DEFAULT;
 
     /**
      * Keystone domain.  Used by the V3 Identity API
@@ -485,4 +504,10 @@ public String getDomain() {
     public void setDomain(String domain) {
         this.domain = domain;
     }
+
+    public AuthenticationMethodScope getAuthenticationMethodScope() { return authenticationMethodScope; }
+
+    public void setAuthenticationMethodScope(AuthenticationMethodScope scope) {
+        this.authenticationMethodScope = scope;
+    }
 }
diff --git a/src/main/java/org/javaswift/joss/client/factory/AccountFactory.java b/src/main/java/org/javaswift/joss/client/factory/AccountFactory.java
@@ -163,4 +163,9 @@ public AccountFactory setDomain(String domain) {
         this.config.setDomain(domain);
         return this;
     }
+
+    public AccountFactory setAuthenticationMode(AuthenticationMethodScope scope) {
+        this.config.setAuthenticationMethodScope(scope);
+        return this;
+    }
 }
diff --git a/src/main/java/org/javaswift/joss/client/factory/AuthenticationMethodScope.java b/src/main/java/org/javaswift/joss/client/factory/AuthenticationMethodScope.java
@@ -0,0 +1,20 @@
+package org.javaswift.joss.client.factory;
+
+/**
+ * The Keystone V3 API allows scoped authentication. By utilizing this option you can request a special scope during
+ * authentication.
+ *
+ * Depending on the chosen AuthenticationMethodScope different options must be provided in the {@link AccountConfig}
+ * object:
+ *
+ * <p>PROJECT_NAME: TenantName and Domain must be provided.</p>
+ * <p>DOMAIN_NAME: Domain must be provided.</p>
+ *
+ * <b>Note:</b> Currently only project/tenant name and domain name are supported. Scoping to the project/tenant ID or
+ * domain ID is not implemented.
+ */
+public enum AuthenticationMethodScope {
+    DEFAULT,
+    PROJECT_NAME,
+    DOMAIN_NAME
+}
diff --git a/src/main/java/org/javaswift/joss/command/impl/core/AbstractCommand.java b/src/main/java/org/javaswift/joss/command/impl/core/AbstractCommand.java
@@ -7,6 +7,7 @@
 import org.codehaus.jackson.map.DeserializationConfig;
 import org.codehaus.jackson.map.ObjectMapper;
 import org.codehaus.jackson.map.SerializationConfig;
+import org.codehaus.jackson.map.annotate.JsonSerialize;
 import org.javaswift.joss.command.impl.core.httpstatus.HttpStatusChecker;
 import org.javaswift.joss.exception.CommandException;
 import org.javaswift.joss.headers.Header;
@@ -137,6 +138,7 @@ protected ObjectMapper createObjectMapper(boolean dealWithRootValue) {
         if (dealWithRootValue) {
             objectMapper.configure(SerializationConfig.Feature.WRAP_ROOT_VALUE, true);
             objectMapper.configure(DeserializationConfig.Feature.UNWRAP_ROOT_VALUE, true);
+            objectMapper.setSerializationInclusion(JsonSerialize.Inclusion.NON_NULL);
         }
         return objectMapper;
     }

diff --git a/...in/java/org/javaswift/joss/command/impl/identity/KeystoneAuthenticationV3CommandImpl.java b/...in/java/org/javaswift/joss/command/impl/identity/KeystoneAuthenticationV3CommandImpl.java
@@ -14,7 +14,7 @@
 import org.javaswift.joss.command.impl.core.httpstatus.HttpStatusSuccessCondition;
 import org.javaswift.joss.command.shared.identity.AuthenticationCommand;
 import org.javaswift.joss.command.shared.identity.access.KeystoneV3Access;
-import org.javaswift.joss.command.shared.identity.authentication.KeystoneV3Authentication;
+import org.javaswift.joss.command.shared.identity.authentication.*;
 import org.javaswift.joss.exception.CommandException;
 import org.javaswift.joss.headers.Accept;
 import org.javaswift.joss.model.Access;
@@ -35,16 +35,60 @@ public KeystoneAuthenticationV3CommandImpl(HttpClient httpClient, AccountConfig
         this.responseMapper = createObjectMapper(false);
 
         setHeader(new Accept(ContentType.APPLICATION_JSON.getMimeType()));
-        setRequestBody(config.getUsername(), config.getPassword(), config.getDomain());
+
+        KeystoneV3Authentication auth = null;
+        switch (config.getAuthenticationMethodScope()) {
+            case DOMAIN_NAME:
+                auth = createKeystoneV3AuthenticationDomainScope(
+                        config.getUsername(),
+                        config.getPassword(),
+                        config.getDomain()
+                );
+                break;
+            case PROJECT_NAME:
+                auth = createKeystoneV3AuthenticationProjectScope(
+                        config.getUsername(),
+                        config.getPassword(),
+                        config.getDomain(),
+                        config.getTenantName()
+                );
+                break;
+            default:
+                auth = createKeystoneV3AuthenticationDefaultScope(
+                        config.getUsername(),
+                        config.getPassword(),
+                        config.getDomain()
+                );
+                break;
+        }
+        setRequestBody(auth);
     }
 
-    private void setRequestBody(String username, String password, String domain) {
+    private KeystoneV3Authentication createKeystoneV3AuthenticationDefaultScope(String username, String password, String domain) {
+        KeystoneV3Authentication auth = new KeystoneV3Authentication();
+        auth.setIdentity(new KeystoneV3Identity(username, password, domain));
+        return auth;
+    }
+
+    private KeystoneV3Authentication createKeystoneV3AuthenticationProjectScope(String username, String password, String domain, String project) {
+        KeystoneV3Authentication auth = new KeystoneV3Authentication();
+        auth.setIdentity(new KeystoneV3Identity(username, password, domain));
+        auth.setScope(new KeystoneV3ProjectScope(project, new KeystoneV3Domain(domain)));
+        return auth;
+    }
+
+    private KeystoneV3Authentication createKeystoneV3AuthenticationDomainScope(String username, String password, String domain) {
+        KeystoneV3Authentication auth = new KeystoneV3Authentication();
+        auth.setIdentity(new KeystoneV3Identity(username, password, domain));
+        auth.setScope(new KeystoneV3DomainScope(new KeystoneV3Domain(domain)));
+        return auth;
+    }
+
+    private void setRequestBody(KeystoneV3Authentication auth) {
         try {
-            String jsonString = requestMapper.writeValueAsString(
-                new KeystoneV3Authentication(username, password, domain)
-            );
+            String jsonString = requestMapper.writeValueAsString(auth);
             request.setEntity(
-                new StringEntity(jsonString, ContentType.APPLICATION_JSON)
+                    new StringEntity(jsonString, ContentType.APPLICATION_JSON)
             );
         } catch (IOException ex) {
             throw new CommandException("Unable to set the JSON body on the request", ex);
@@ -67,8 +111,8 @@ protected HttpPost createRequest(String url) {
 
     @Override
     public HttpStatusChecker[] getStatusCheckers() {
-        return new HttpStatusChecker[] {
-            new HttpStatusSuccessCondition(new HttpStatusRange(200, 299))
+        return new HttpStatusChecker[]{
+                new HttpStatusSuccessCondition(new HttpStatusRange(200, 299))
         };
     }
 

diff --git a/...a/org/javaswift/joss/command/shared/identity/authentication/KeystoneV3Authentication.java b/...a/org/javaswift/joss/command/shared/identity/authentication/KeystoneV3Authentication.java
@@ -6,12 +6,15 @@
 public class KeystoneV3Authentication {
 
     private KeystoneV3Identity identity;
+    private KeystoneV3Scope scope;
 
-    public KeystoneV3Authentication(String username, String password, String domain) {
-        this.identity = new KeystoneV3Identity(username, password, domain);
-    }
+    public void setScope(KeystoneV3Scope scope) { this.scope = scope; }
+
+    public KeystoneV3Scope getScope() { return scope; }
+
+    public void setIdentity(KeystoneV3Identity identity) { this.identity = identity; }
 
     public KeystoneV3Identity getIdentity() {
         return identity;
     }
-}
+}
diff --git a/...java/org/javaswift/joss/command/shared/identity/authentication/KeystoneV3DomainScope.java b/...java/org/javaswift/joss/command/shared/identity/authentication/KeystoneV3DomainScope.java
@@ -0,0 +1,14 @@
+package org.javaswift.joss.command.shared.identity.authentication;
+
+public class KeystoneV3DomainScope implements KeystoneV3Scope {
+
+    private final KeystoneV3Domain domain;
+
+    public KeystoneV3DomainScope(KeystoneV3Domain domain) {
+        this.domain = domain;
+    }
+
+    public KeystoneV3Domain getDomain() {
+        return domain;
+    }
+}
diff --git a/...ava/org/javaswift/joss/command/shared/identity/authentication/KeystoneV3ProjectScope.java b/...ava/org/javaswift/joss/command/shared/identity/authentication/KeystoneV3ProjectScope.java
@@ -0,0 +1,32 @@
+package org.javaswift.joss.command.shared.identity.authentication;
+
+public class KeystoneV3ProjectScope implements KeystoneV3Scope {
+
+    private KeystoneV3ProjectWrapped project;
+
+    public static class KeystoneV3ProjectWrapped {
+        private final String name;
+        private final KeystoneV3Domain domain;
+
+        private KeystoneV3ProjectWrapped(String name, KeystoneV3Domain domain) {
+            this.name = name;
+            this.domain = domain;
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        public KeystoneV3Domain getDomain() {
+            return domain;
+        }
+    }
+
+    public KeystoneV3ProjectScope(String name, KeystoneV3Domain domain) {
+        this.project = new KeystoneV3ProjectWrapped(name, domain);
+    }
+
+    public KeystoneV3ProjectWrapped getProject() {
+        return project;
+    }
+}
diff --git a/src/main/java/org/javaswift/joss/command/shared/identity/authentication/KeystoneV3Scope.java b/src/main/java/org/javaswift/joss/command/shared/identity/authentication/KeystoneV3Scope.java
@@ -0,0 +1,4 @@
+package org.javaswift.joss.command.shared.identity.authentication;
+
+public interface KeystoneV3Scope {
+}
diff --git a/src/test/java/org/javaswift/joss/client/factory/AccountConfigTest.java b/src/test/java/org/javaswift/joss/client/factory/AccountConfigTest.java
@@ -33,6 +33,7 @@ public void construct() {
         config.setPreferredRegion("AMS-01");
         config.setDisableSslValidation(true);
         config.setDelimiter('\\');
+        config.setAuthenticationMethodScope(AuthenticationMethodScope.DOMAIN_NAME);
         assertEquals("auth", config.getAuthUrl());
         assertEquals("pwd", config.getPassword());
         assertEquals("tenant", config.getTenantName());
@@ -56,5 +57,6 @@ public void construct() {
         assertEquals("AMS-01", config.getPreferredRegion());
         assertEquals(true, config.isDisableSslValidation());
         assertEquals((Character)'\\', config.getDelimiter());
+        assertEquals(AuthenticationMethodScope.DOMAIN_NAME, config.getAuthenticationMethodScope());
     }
 }
diff --git a/src/test/java/org/javaswift/joss/client/factory/AccountFactoryTest.java b/src/test/java/org/javaswift/joss/client/factory/AccountFactoryTest.java
@@ -71,7 +71,8 @@ public void useFluentInterface() {
                 .setTenantName(null)
                 .setTenantId(null)
                 .setUsername(null)
-                .setDelimiter('\\');
+                .setDelimiter('\\')
+                .setAuthenticationMethod(null);
     }
 
 }
diff --git a/...g/javaswift/joss/command/shared/identity/authentication/KeystoneV3AuthenticationTest.java b/...g/javaswift/joss/command/shared/identity/authentication/KeystoneV3AuthenticationTest.java
@@ -3,6 +3,7 @@
 import org.codehaus.jackson.JsonNode;
 import org.codehaus.jackson.map.ObjectMapper;
 import org.codehaus.jackson.map.SerializationConfig;
+import org.codehaus.jackson.map.annotate.JsonSerialize;
 import org.junit.Test;
 
 import java.io.IOException;
@@ -12,15 +13,13 @@
 public class KeystoneV3AuthenticationTest {
 
     @Test
-    public void testMarshalling() throws IOException {
+    public void testMarshallingDefaultScope() throws IOException {
         ObjectMapper mapper = new ObjectMapper();
         mapper.configure(SerializationConfig.Feature.WRAP_ROOT_VALUE, true);
+        mapper.setSerializationInclusion(JsonSerialize.Inclusion.NON_NULL);
 
-        KeystoneV3Authentication authentication = new KeystoneV3Authentication(
-            "username",
-            "password",
-            "domainName"
-        );
+        KeystoneV3Authentication authentication = new KeystoneV3Authentication();
+        authentication.setIdentity(new KeystoneV3Identity("username", "password", "domainName"));
 
         JsonNode expectedContent = mapper.readTree(
             getClass().getResourceAsStream("/sample-v3-auth-request.json")
@@ -31,4 +30,42 @@ public void testMarshalling() throws IOException {
         assertEquals(expectedContent, actualContent);
     }
 
+    @Test
+    public void testMarshallingDomainScope() throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.configure(SerializationConfig.Feature.WRAP_ROOT_VALUE, true);
+        mapper.setSerializationInclusion(JsonSerialize.Inclusion.NON_NULL);
+
+        KeystoneV3Authentication authentication = new KeystoneV3Authentication();
+        authentication.setIdentity(new KeystoneV3Identity("username", "password", "domainName"));
+        authentication.setScope(new KeystoneV3DomainScope(new KeystoneV3Domain("domainName")));
+
+        JsonNode expectedContent = mapper.readTree(
+                getClass().getResourceAsStream("/sample-v3-auth-scope-domain-request.json")
+        );
+
+        JsonNode actualContent = mapper.valueToTree(authentication);
+
+        assertEquals(expectedContent, actualContent);
+    }
+
+    @Test
+    public void testMarshallingProjectScope() throws IOException {
+        ObjectMapper mapper = new ObjectMapper();
+        mapper.configure(SerializationConfig.Feature.WRAP_ROOT_VALUE, true);
+        mapper.setSerializationInclusion(JsonSerialize.Inclusion.NON_NULL);
+
+        KeystoneV3Authentication authentication = new KeystoneV3Authentication();
+        authentication.setIdentity(new KeystoneV3Identity("username", "password", "domainName"));
+        authentication.setScope(new KeystoneV3ProjectScope("projectName", new KeystoneV3Domain("domainName")));
+
+        JsonNode expectedContent = mapper.readTree(
+                getClass().getResourceAsStream("/sample-v3-auth-scope-project-request.json")
+        );
+
+        JsonNode actualContent = mapper.valueToTree(authentication);
+
+        assertEquals(expectedContent, actualContent);
+    }
+
 }
diff --git a/src/test/resources/sample-v3-auth-scope-domain-request.json b/src/test/resources/sample-v3-auth-scope-domain-request.json
@@ -0,0 +1,23 @@
+{
+  "auth": {
+    "identity": {
+      "methods": [
+        "password"
+      ],
+      "password": {
+        "user": {
+          "name": "username",
+          "password": "password",
+          "domain": {
+            "name": "domainName"
+          }
+        }
+      }
+    },
+    "scope":{
+      "domain":{
+        "name":"domainName"
+      }
+    }
+  }
+}
diff --git a/src/test/resources/sample-v3-auth-scope-project-request.json b/src/test/resources/sample-v3-auth-scope-project-request.json
@@ -0,0 +1,26 @@
+{
+  "auth": {
+    "identity": {
+      "methods": [
+        "password"
+      ],
+      "password": {
+        "user": {
+          "name": "username",
+          "password": "password",
+          "domain": {
+            "name": "domainName"
+          }
+        }
+      }
+    },
+    "scope":{
+      "project":{
+        "name":"projectName",
+        "domain":{
+          "name":"domainName"
+        }
+      }
+    }
+  }
+}