Support for custom auth-tokens

Author: pontusmelke

driver/src/main/java/org/neo4j/driver/v1/AuthTokens.java

@@ -18,6 +18,8 @@
  */
 package org.neo4j.driver.v1;
 
+import java.util.Map;
+
 import org.neo4j.driver.internal.security.InternalAuthToken;
 
 import static org.neo4j.driver.v1.Values.parameters;
@@ -46,6 +48,62 @@ public static AuthToken basic( String username, String password )
                 "credentials", password ).asMap( Values.ofValue() ) );
     }
 
+    /**
+     * The basic authentication scheme, using a username and a password.
+     * @param username this is the "principal", identifying who this token represents
+     * @param password this is the "credential", proving the identity of the user
+     * @param realm this is the "realm", specifies the authentication provider
+     * @return an authentication token that can be used to connect to Neo4j
+     * @see GraphDatabase#driver(String, AuthToken)
+     */
+    public static AuthToken basic( String username, String password, String realm )
+    {
+        return new InternalAuthToken( parameters(
+                "scheme", "basic",
+                "principal", username,
+                "credentials", password,
+                "realm", realm).asMap( Values.ofValue() ) );
+    }
+
+
+    /**
+     * A custom authentication token used for doing custom authentication on the server side.
+     * @param principal this used to identify who this token represents
+     * @param credentials this is credentials authenticating the principal
+     * @param realm this is the "realm:, specifying the authentication provider.
+     * @param scheme this it the authentication scheme, specifying what kind of authentication that should be used
+     * @return an authentication token that can be used to connect to Neo4j
+     * * @see GraphDatabase#driver(String, AuthToken)
+     */
+    public static AuthToken custom( String principal, String credentials, String realm, String scheme)
+    {
+        return new InternalAuthToken( parameters(
+                "scheme", scheme,
+                "principal", principal,
+                "credentials", credentials,
+                "realm", realm).asMap( Values.ofValue() ) );
+    }
+
+    /**
+     * A custom authentication token used for doing custom authentication on the server side.
+     * @param principal this used to identify who this token represents
+     * @param credentials this is credentials authenticating the principal
+     * @param realm this is the "realm:, specifying the authentication provider.
+     * @param scheme this it the authentication scheme, specifying what kind of authentication that shoud be used
+     * @param parameters extra parameters to be sent along the authentication provider.
+     * @return an authentication token that can be used to connect to Neo4j
+     * * @see GraphDatabase#driver(String, AuthToken)
+     */
+    public static AuthToken custom( String principal, String credentials, String realm, String scheme, Map<String, Object> parameters)
+    {
+        return new InternalAuthToken( parameters(
+                "scheme", scheme,
+                "principal", principal,
+                "credentials", credentials,
+                "realm", realm,
+                "parameters", parameters).asMap( Values.ofValue() ) );
+    }
+
     /**
      * No authentication scheme. This will only work if authentication is disabled
      * on the Neo4j Instance we are connecting to.

driver/src/test/java/org/neo4j/driver/v1/integration/CredentialsIT.java

@@ -23,6 +23,8 @@
 import org.junit.rules.ExpectedException;
 import org.junit.rules.TemporaryFolder;
 
+import java.util.HashMap;
+
 import org.neo4j.driver.internal.security.InternalAuthToken;
 import org.neo4j.driver.v1.Driver;
 import org.neo4j.driver.v1.GraphDatabase;
@@ -35,6 +37,7 @@
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.Matchers.equalTo;
 import static org.neo4j.driver.v1.AuthTokens.basic;
+import static org.neo4j.driver.v1.AuthTokens.custom;
 import static org.neo4j.driver.v1.Values.ofValue;
 import static org.neo4j.driver.v1.Values.parameters;
 
@@ -85,6 +88,42 @@ public void shouldGetHelpfulErrorOnInvalidCredentials() throws Throwable
         }
     }
 
+    @Test
+    public void shouldBeAbleToConnectWithCustomToken() throws Throwable
+    {
+        // Given
+        String password = "secret";
+        enableAuth( password );
+
+        // When & Then
+        try( Driver driver = GraphDatabase.driver( neo4j.uri(),
+                custom("neo4j", password, "native", "basic" ) );
+             Session session = driver.session() )
+        {
+            Value single = session.run( "CREATE () RETURN 1" ).single().get( 0 );
+            assertThat( single.asLong(), equalTo( 1L ) );
+        }
+    }
+
+    @Test
+    public void shouldBeAbleToConnectWithCustomTokenWithAdditionalParameters() throws Throwable
+    {
+        // Given
+        String password = "secret";
+        enableAuth( password );
+        HashMap<String,Object> parameters = new HashMap<>();
+        parameters.put( "secret", 16 );
+
+        // When & Then
+        try( Driver driver = GraphDatabase.driver( neo4j.uri(),
+                custom("neo4j", password, "native", "basic", parameters ) );
+             Session session = driver.session() )
+        {
+            Value single = session.run( "CREATE () RETURN 1" ).single().get( 0 );
+            assertThat( single.asLong(), equalTo( 1L ) );
+        }
+    }
+
     private void enableAuth( String password ) throws Exception
     {
         neo4j.restart( Neo4jSettings.TEST_SETTINGS