org.springframework.data.gemfire.config.annotation

Annotation Type EnableAuth

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Inherited
 @Documented
 @Import(value=AuthConfiguration.class)
 @UsesGemFireProperties
public @interface EnableAuth

The EnableAuth annotation marks a Spring @Configuration annotated Class to configure and enable Pivotal GemFire/Apache Geode's Authentication and Authorization framework and services.

Since:

1.9.0

Author:

John Blum

See Also:

Annotation, AccessControl, AuthInitialize, Authenticator, Import, AuthConfiguration, Authentication, Authorization

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	clientAccessor Used for authorization.
String	clientAccessorPostProcessor Used for authorization.
String	clientAuthenticationInitializer Used for authentication.
String	clientAuthenticator Used for authentication.
String	clientDiffieHellmanAlgorithm Used for authentication.
String	peerAuthenticationInitializer Used with authentication.
String	peerAuthenticator Used with authentication.
long	peerVerifyMemberTimeout Used with authentication.
String	securityLogFile Used with authentication.
String	securityLogLevel Used with authentication.
String	securityPropertiesFile Used for authentication.

Element Detail

clientAccessor

public abstract String clientAccessor

Used for authorization. Static creation method returning an AccessControl object, which determines authorization of client-server cache operations. This specifies the callback that should be invoked in the pre-operation phase, which is when the request for the operation is received from the client. Defaults to unset. Use the spring.data.gemfire.security.client.accessor property in application.properties.

Default:

""

clientAccessorPostProcessor

public abstract String clientAccessorPostProcessor

Used for authorization. The callback that should be invoked in the post-operation phase, which is when the operation has completed on the server but before the result is sent to the client. The post-operation callback is also invoked for the updates that are sent from server to client through the notification channel. Defaults to unset. Use the spring.data.gemfire.security.client.accessor-post-processor property in application.properties.

Default:

""

clientAuthenticationInitializer

public abstract String clientAuthenticationInitializer

Used for authentication. Static creation method returning an AuthInitialize object, which obtains credentials for clients. The obtained credentials should be acceptable to the Authenticator specified through the security-client-authenticator property on the clients. Defaults to unset. Use the spring.data.gemfire.security.client.authentication-initializer property in application.properties.

Default:

""

clientAuthenticator

public abstract String clientAuthenticator

Used for authentication. Static creation method returning an Authenticator object, which is used by a server to verify the credentials of the connecting client. Defaults to unset. Use the spring.data.gemfire.security.client.authenticator property in application.properties.

Default:

""

clientDiffieHellmanAlgorithm

public abstract String clientDiffieHellmanAlgorithm

Used for authentication. For secure transmission of sensitive credentials like passwords, you can encrypt the credentials using the Diffie-Hellman key exchange algorithm. Do this by setting the security-client-dhalgo system property on the clients to the name of a valid symmetric key cipher supported by the JDK. Defaults to unset. Use the spring.data.gemfire.security.client.diffie-hellman-algorithm property in application.properties.

Default:

""

peerAuthenticationInitializer

public abstract String peerAuthenticationInitializer

Used with authentication. Static creation method returning an AuthInitialize object, which obtains credentials for peers in a distributed system. The obtained credentials should be acceptable to the Authenticator specified through the security-peer-authenticator property on the peers. Defaults to unset. Use the spring.data.gemfire.security.peer.authentication-initializer property in application.properties.

Default:

""

peerAuthenticator

public abstract String peerAuthenticator

Used with authentication. Static creation method returning an Authenticator object, which is used by a peer to verify the credentials of the connecting peer. Defaults to unset. Use the spring.data.gemfire.security.peer.authenticator property in application.properties.

Default:

""

peerVerifyMemberTimeout

public abstract long peerVerifyMemberTimeout

Used with authentication. Timeout in milliseconds used by a peer to verify membership of an unknown authenticated peer requesting a secure connection. Defaults to 1000 milliseconds. Use the spring.data.gemfire.security.peer.verify-member-timeout property in application.properties.

Default:

1000L

securityLogFile

public abstract String securityLogFile

Used with authentication. The log file for security log messages. If not specified, the member’s regular log file is used. Defaults to unset. Use the spring.data.gemfire.security.log.file property in application.properties.

Default:

""

securityLogLevel

public abstract String securityLogLevel

Used with authentication. Logging level detail for security log messages. Valid values from lowest to highest are fine, config, info, warning, error, severe, and none. Defaults to config. Use the spring.data.gemfire.security.log.level property in application.properties.

Default:

"config"

securityPropertiesFile

public abstract String securityPropertiesFile

Used for authentication. Any custom properties needed by your AuthInitialize or Authenticator callbacks store in an external Properties file. Any security-related (properties that begin with security-*) configuration properties that are normally configured in gemfire.properties can be moved to a separate gfsecurity.properties file. Placing these configuration settings in a separate file allows you to restrict access to security configuration data. This way, you can still allow read or write access for your gemfire.properties file. Defaults to unset. Use the spring.data.gemfire.security.properties-file property in application.properties.

Default:

""