org.janusgraph.graphdb.tinkerpop.gremlin.server.auth

Class HMACAuthenticator

java.lang.Object

org.janusgraph.graphdb.tinkerpop.gremlin.server.auth.JanusGraphAbstractAuthenticator

org.janusgraph.graphdb.tinkerpop.gremlin.server.auth.HMACAuthenticator

All Implemented Interfaces:

org.apache.tinkerpop.gremlin.server.auth.Authenticator

public class HMACAuthenticator
extends JanusGraphAbstractAuthenticator

A class for doing Basic Auth and Token auth using an HMAC intended to be used with the HMACAuthenticationHandler

Author:

Keith Lohnes lohnesk@gmail.com

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.server.auth.Authenticator

org.apache.tinkerpop.gremlin.server.auth.Authenticator.SaslNegotiator

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_HMAC_ALGO Hmac algorithm defaults to hmacsha256
static String	CONFIG_HMAC_SECRET Hmac secret config
static String	CONFIG_TOKEN_TIMEOUT How long an auth token should stay valid

Fields inherited from class org.janusgraph.graphdb.tinkerpop.gremlin.server.auth.JanusGraphAbstractAuthenticator

CONFIG_DEFAULT_PASSWORD, CONFIG_DEFAULT_USER, USERNAME_INDEX_NAME

Constructor Summary

Constructors

Constructor and Description
HMACAuthenticator()

Method Summary

Modifier and Type	Method and Description
org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser	authenticate(Map<String,String> credentials)
org.apache.tinkerpop.gremlin.server.auth.Authenticator.SaslNegotiator	newSaslNegotiator()
org.apache.tinkerpop.gremlin.server.auth.Authenticator.SaslNegotiator	newSaslNegotiator(InetAddress remoteAddress)
boolean	requireAuthentication()
void	setup(Map<String,Object> config)

Methods inherited from class org.janusgraph.graphdb.tinkerpop.gremlin.server.auth.JanusGraphAbstractAuthenticator

createCredentials, findUser, openGraph

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_HMAC_ALGO

public static final String CONFIG_HMAC_ALGO

Hmac algorithm defaults to hmacsha256

See Also:

Constant Field Values

CONFIG_TOKEN_TIMEOUT

public static final String CONFIG_TOKEN_TIMEOUT

How long an auth token should stay valid

See Also:

Constant Field Values

CONFIG_HMAC_SECRET

public static final String CONFIG_HMAC_SECRET

Hmac secret config

See Also:

Constant Field Values

Constructor Detail

HMACAuthenticator

public HMACAuthenticator()

Method Detail

requireAuthentication

public boolean requireAuthentication()

Specified by:

requireAuthentication in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator

Overrides:

requireAuthentication in class JanusGraphAbstractAuthenticator

newSaslNegotiator

public org.apache.tinkerpop.gremlin.server.auth.Authenticator.SaslNegotiator newSaslNegotiator(InetAddress remoteAddress)

Specified by:

newSaslNegotiator in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator

Specified by:

newSaslNegotiator in class JanusGraphAbstractAuthenticator

newSaslNegotiator

public org.apache.tinkerpop.gremlin.server.auth.Authenticator.SaslNegotiator newSaslNegotiator()

setup

public void setup(Map<String,Object> config)

Specified by:

setup in interface org.apache.tinkerpop.gremlin.server.auth.Authenticator

Overrides:

setup in class JanusGraphAbstractAuthenticator

authenticate

public org.apache.tinkerpop.gremlin.server.auth.AuthenticatedUser authenticate(Map<String,String> credentials)
                                                                        throws org.apache.tinkerpop.gremlin.server.auth.AuthenticationException

Throws:

org.apache.tinkerpop.gremlin.server.auth.AuthenticationException