org.apache.derby.impl.jdbc.authentication
Class AuthenticationServiceBase

java.lang.Object
  org.apache.derby.impl.jdbc.authentication.AuthenticationServiceBase

All Implemented Interfaces:

AuthenticationService, ModuleControl, ModuleSupportable, PropertySetCallback

Direct Known Subclasses:

BasicAuthenticationServiceImpl, JNDIAuthenticationService, NoneAuthenticationServiceImpl, SpecificAuthenticationServiceImpl

public abstract class AuthenticationServiceBase
extends java.lang.Object
implements AuthenticationService, ModuleControl, ModuleSupportable, PropertySetCallback

This is the authentication service base class.

There can be 1 Authentication Service for the whole Derby system and/or 1 authentication per database. In a near future, we intend to allow multiple authentication services per system and/or per database.

It should be extended by the specialized authentication services. IMPORTANT NOTE: -------------- User passwords are encrypted using SHA-1 message digest algorithm if they're stored in the database; otherwise they are not encrypted if they were defined at the system level. SHA-1 digest is single hash (one way) digest and is considered very secure (160 bits).

Field Summary

protected UserAuthenticator	authenticationScheme
static java.lang.String	AuthenticationTrace Trace flag to trace authentication operations
static java.lang.String	ID_PATTERN_NEW_SCHEME Pattern that is prefixed to the stored password in the new authentication scheme
static int	MAGICLEN_NEWENCRYPT_SCHEME Length of the encrypted password in the new authentication scheme See Beetle4601
protected static int	SECMEC_USRSSBPWD Userid with Strong password substitute DRDA security mechanism
private AccessFactory	store

Fields inherited from interface org.apache.derby.iapi.jdbc.AuthenticationService

MODULE

Constructor Summary

AuthenticationServiceBase()

Method Summary

Serviceable	apply(java.lang.String key, java.io.Serializable value, java.util.Dictionary p) Apply a property change.
boolean	authenticate(java.lang.String databaseName, java.util.Properties userInfo) Authenticate a User inside JBMS.T his is an overload method.
void	boot(boolean create, java.util.Properties properties) Start this module.
protected java.lang.String	encryptPassword(java.lang.String plainTxtUserPassword) This method encrypts a clear user password using a Single Hash algorithm such as SHA-1 (SHA equivalent) (it is a 160 bits digest) The digest is returned as an object string.
java.lang.String	getDatabaseProperty(java.lang.String key)
java.lang.String	getProperty(java.lang.String key) Returns a property if it was set at the database or system level.
java.lang.String	getSystemProperty(java.lang.String key)
void	init(boolean dbOnly, java.util.Dictionary p) Initialize the properties for this callback.
java.io.Serializable	map(java.lang.String key, java.io.Serializable value, java.util.Dictionary p) Map a proposed new value for a property to an official value.
protected boolean	requireAuthentication(java.util.Properties properties)
protected void	setAuthenticationService(UserAuthenticator aScheme)
void	stop() Stop the module.
protected java.lang.String	substitutePassword(java.lang.String userName, java.lang.String password, java.util.Properties info, boolean databaseUser) Strong Password Substitution (USRSSBPWD).
boolean	validate(java.lang.String key, java.io.Serializable value, java.util.Dictionary p) Validate a property change.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.derby.iapi.services.monitor.ModuleSupportable

canSupport

Field Detail

authenticationScheme

protected UserAuthenticator authenticationScheme

store

private AccessFactory store

AuthenticationTrace

public static final java.lang.String AuthenticationTrace

Trace flag to trace authentication operations

ID_PATTERN_NEW_SCHEME

public static final java.lang.String ID_PATTERN_NEW_SCHEME

Pattern that is prefixed to the stored password in the new authentication scheme

See Also:

Constant Field Values

SECMEC_USRSSBPWD

protected static final int SECMEC_USRSSBPWD

Userid with Strong password substitute DRDA security mechanism

See Also:

Constant Field Values

MAGICLEN_NEWENCRYPT_SCHEME

public static final int MAGICLEN_NEWENCRYPT_SCHEME

Length of the encrypted password in the new authentication scheme See Beetle4601

See Also:

Constant Field Values

Constructor Detail

AuthenticationServiceBase

public AuthenticationServiceBase()

Method Detail

setAuthenticationService

protected void setAuthenticationService(UserAuthenticator aScheme)

boot

public void boot(boolean create,
                 java.util.Properties properties)
          throws StandardException

Start this module. In this case, nothing needs to be done.

Specified by:

boot in interface ModuleControl

Throws:

StandardException - upon failure to load/boot the expected authentication service.

See Also:

ModuleControl.boot(boolean, java.util.Properties)

stop

public void stop()

Description copied from interface: ModuleControl

Stop the module. The module may be found via a findModule() method until some time after this method returns. Therefore the factory must be prepared to reject requests to it once it has been stopped. In addition other modules may cache a reference to the module and make requests of it after it has been stopped, these requests should be rejected as well.

Specified by:

stop in interface ModuleControl

See Also:

ModuleControl.stop()

authenticate

public boolean authenticate(java.lang.String databaseName,
                            java.util.Properties userInfo)
                     throws java.sql.SQLException

Authenticate a User inside JBMS.T his is an overload method. We're passed-in a Properties object containing user credentials information (as well as database name if user needs to be validated for a certain database access).

Specified by:

authenticate in interface AuthenticationService

userInfo - Connection properties info. failure.

Throws:

java.sql.SQLException

See Also:

AuthenticationService.authenticate(java.lang.String, java.util.Properties)

getProperty

public java.lang.String getProperty(java.lang.String key)

Returns a property if it was set at the database or system level. Treated as SERVICE property by default.

Returns:

a property string value.

getDatabaseProperty

public java.lang.String getDatabaseProperty(java.lang.String key)

getSystemProperty

public java.lang.String getSystemProperty(java.lang.String key)

init

public void init(boolean dbOnly,
                 java.util.Dictionary p)

Description copied from interface: PropertySetCallback

Initialize the properties for this callback. Called when addPropertySetNotification() is called with a non-null transaction controller. This allows code to set read its initial property values at boot time.

Code within an init() method should use the 3 argument PropertyUtil method getPropertyFromSet() to obtain a property's value.

Specified by:

init in interface PropertySetCallback

Parameters:

dbOnly - true if only per-database properties are to be looked at

p - the complete set of per-database properties.

validate

public boolean validate(java.lang.String key,
                        java.io.Serializable value,
                        java.util.Dictionary p)

Description copied from interface: PropertySetCallback

Validate a property change.

Specified by:

validate in interface PropertySetCallback

Parameters:

key - Property key for the property being set

value - proposed new value for the property being set or null if the property is being dropped.

p - Property set before the change. SettingProperty may read but must never change p.

Returns:

true if this object was interested in this property, false otherwise.

See Also:

PropertySetCallback.validate(java.lang.String, java.io.Serializable, java.util.Dictionary)

apply

public Serviceable apply(java.lang.String key,
                         java.io.Serializable value,
                         java.util.Dictionary p)

Description copied from interface: PropertySetCallback

Apply a property change. Will only be called after validate has been called and only if validate returned true. If this method is called then the new value is the value to be used, ie. the property is not set in the overriding JVM system set.

Specified by:

apply in interface PropertySetCallback

Parameters:

key - Property key for the property being set

value - proposed new value for the property being set or null if the property is being dropped.

p - Property set before the change. SettingProperty may read but must never change p.

Returns:

post commit work for the property change.

See Also:

PropertySetCallback.validate(java.lang.String, java.io.Serializable, java.util.Dictionary)

map

public java.io.Serializable map(java.lang.String key,
                                java.io.Serializable value,
                                java.util.Dictionary p)
                         throws StandardException

Description copied from interface: PropertySetCallback

Map a proposed new value for a property to an official value. Will only be called after apply() has been called.

Specified by:

map in interface PropertySetCallback

Parameters:

key - Property key for the property being set

value - proposed new value for the property being set or null if the property is being dropped.

p - Property set before the change. SettingProperty may read but must never change p.

Returns:

new value for the change

Throws:

StandardException - Thrown on error.

See Also:

PropertySetCallback.map(java.lang.String, java.io.Serializable, java.util.Dictionary)

requireAuthentication

protected final boolean requireAuthentication(java.util.Properties properties)

encryptPassword

protected java.lang.String encryptPassword(java.lang.String plainTxtUserPassword)

This method encrypts a clear user password using a Single Hash algorithm such as SHA-1 (SHA equivalent) (it is a 160 bits digest) The digest is returned as an object string.

Parameters:

plainTxtUserPassword - Plain text user password

Returns:

encrypted user password (digest) as a String object

substitutePassword

protected java.lang.String substitutePassword(java.lang.String userName,
                                              java.lang.String password,
                                              java.util.Properties info,
                                              boolean databaseUser)

Strong Password Substitution (USRSSBPWD). This method generate a password subtitute to authenticate a client which is using a DRDA security mechanism such as SECMEC_USRSSBPWD. Depending how the user is defined in Derby and if BUILTIN is used, the stored password can be in clear-text (system level) or encrypted (hashed - *not decryptable*)) (database level) - If the user has authenticated at the network level via SECMEC_USRSSBPWD, it means we're presented with a password substitute and we need to generate a substitute password coming from the store to compare with the one passed-in. NOTE: A lot of this logic could be shared with the DRDA decryption and client encryption managers - This will be done _once_ code sharing along with its rules are defined between the Derby engine, client and network code (PENDING). Substitution algorithm works as follow: PW_TOKEN = SHA-1(PW, ID) The password (PW) and user name (ID) can be of any length greater than or equal to 1 byte. The client generates a 20-byte password substitute (PW_SUB) as follows: PW_SUB = SHA-1(PW_TOKEN, RDr, RDs, ID, PWSEQs) w/ (RDs) as the random client seed and (RDr) as the server one. See PWDSSB - Strong Password Substitution Security Mechanism (DRDA Vol.3 - P.650)

Returns:

a substituted password.