com.goldencode.p2j.security

Class SecurityManager.ContextSecurityManager

java.lang.Object

com.goldencode.p2j.security.SecurityManager.ContextSecurityManager

Enclosing class:

SecurityManager

public class SecurityManager.ContextSecurityManager
extends java.lang.Object

Wrapper class for Context related logic.

Constructor Summary

Constructors

Constructor and Description
ContextSecurityManager()

Method Summary

Modifier and Type	Method and Description
(package private) boolean	addToken(ContextKey key, java.lang.Object token) Adds a token to the context map.
private void	assignContext(SecurityContext context) Assign the current thread to the given security context, and add a unique identifier for this thread to the thread ID map.
private SecurityContext	createSecurityContext(SecurityCache sc, java.lang.String pid, java.lang.String uid) Private worker method that creates a new security context.
void	dropInitialSecurityContext() Releases the initial security context assigned to the calling thread.
private void	endContext(SecurityContextStack cts, SecurityContext ctx) Worker routine to centralize unassignment and cleanup (if this was the final usage) of the given context.
(package private) void	forceSecurityContext(SecurityContextStack stack, boolean create) Initializes the security context switching for the calling thread using the given context stack as the source of the initial and effective contexts.
javax.net.ssl.SSLContext	getSecureSocketContext() Initializes and returns a valid SSL environment.
javax.net.ssl.SSLContext	getSecureSocketContext(BootstrapConfig config) Initializes and returns a valid SSL environment.
java.lang.Object	getToken(ContextKey key) Gets the token from the context map.
boolean	hasContext() Detects if there is a valid context associated with the current thread.
boolean	hasToken(ContextKey key) Checks whether the specified token is in the context map.
private void	logContext(SecurityCache cache, SecurityContext ctx) Creates an audit record for security context switch event.
private void	logGoingContext(SecurityContext ctx) Creates an audit record for a terminated security context.
private void	logNewContext(SecurityCache cache, SecurityContext ctx) Creates an audit record for security context creation event.
(package private) void	popAllSecurityContext() Terminates all security contexts associated with the current thread, including the initial context.
void	popAndRestoreSecurityContext() Restores the initial security context of the calling thread when it is done with the user request.
private void	popContextWorker() Restores the initial security context of the calling thread when it is done with the user request.
void	pushAndSwitchSecurityContext(java.lang.Object key) Temporarily switches to a user context to serve the associated request.
void	pushAndSwitchSecurityContextBySessionId(java.lang.Object sessionId) Temporarily switches to a user context to serve the associated request.
(package private) void	pushContextWorker(java.lang.Object key) Temporarily switches to a user context to serve the associated request.
(package private) boolean	removeToken(ContextKey key) Remove a token from the context map.
void	resetContext() Reset the effective security context associated with the current thread.
void	setHeadless() Mark this context in headless mode.
void	setInitialSecurityContext() Initializes security context switching for the calling thread.
private void	setInitialSecurityContextWorker(boolean unique, SecurityContextStack stack) Drops any current context (if any) and establishes an initial context for the thread.
void	setUniqueInitialSecurityContext() Initializes security context switching for the calling thread making sure that the context is newly created and is not shared with any other thread.
private boolean	unassignContext(SecurityContext context) Unassign the current thread from the given security context, and remove its entry from the thread ID map.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextSecurityManager

public ContextSecurityManager()

Method Detail

setHeadless

public void setHeadless()

Mark this context in headless mode.

addToken

boolean addToken(ContextKey key,
                 java.lang.Object token)

Adds a token to the context map.

Parameters:

key - token key to be used as a key in the map

token - an arbitrary object to be kept in the entry

Returns:

true if the token is added successfully

hasToken

public boolean hasToken(ContextKey key)

Checks whether the specified token is in the context map.

Parameters:

key - token key to be used as a key in the map

Returns:

true if the token is found

getToken

public java.lang.Object getToken(ContextKey key)

Gets the token from the context map.

Parameters:

key - token key to be used as a key in the map

Returns:

the value of the token as a generic object or null

removeToken

boolean removeToken(ContextKey key)

Remove a token from the context map.

Parameters:

key - token key to be used as a key in the map

Returns:

true if the token was removed successfully

hasContext

public boolean hasContext()

Detects if there is a valid context associated with the current thread.

Returns:

true if there is a valid security context.

assignContext

private void assignContext(SecurityContext context)

Assign the current thread to the given security context, and add a unique identifier for this thread to the thread ID map.

Parameters:

context - Security context to be assigned.

unassignContext

private boolean unassignContext(SecurityContext context)

Unassign the current thread from the given security context, and remove its entry from the thread ID map.

Parameters:

context - Security context to be unassigned.

resetContext

public void resetContext()
                  throws RestrictedUseException

Reset the effective security context associated with the current thread.

Throws:

RestrictedUseException - If called outside of expected code.

setInitialSecurityContext

public void setInitialSecurityContext()
                               throws RestrictedUseException

Initializes security context switching for the calling thread. This call is supposed to be repeatable for permanent threads to allow proper security cache refresh function.

This call immediately exits if called from the client.

If this call is made repeatedly, it checks whether the security cache is refreshed compared to the generation of the cache used to create the initial security context currently in use. If this is the case, the old security context is released and replaced with the current one.

Restricted use. This method checks the caller to be:

• com.goldencode.p2j.net.RouterSessionManager.setInitialContext()
• com.goldencode.p2j.net.StandardServer.bootstrap()
• com.goldencode.p2j.net.StandardServer$1.run()

Throws:

RestrictedUseException - if called improperly

setUniqueInitialSecurityContext

public void setUniqueInitialSecurityContext()
                                     throws RestrictedUseException

Initializes security context switching for the calling thread making sure that the context is newly created and is not shared with any other thread. The context will not be associated with any specific account without a subsequent authentication. This is different than standard server threads which have an initial context that is shared with other server threads AND which are naturally associated with the server's account (and thus with the server's rights).

This call is supposed to be repeatable for permanent threads to allow proper security cache refresh function.

This call immediately exits if called from the client.

If this call is made repeatedly, it checks whether the security cache is refreshed compared to the generation of the cache used to create the initial security context currently in use. If this is the case, the old security context is released and replaced with the current one.

Restricted use. This method checks the caller to be:

• com.goldencode.p2j.main.ServerDriver$SingleProcessClient.run()

Throws:

RestrictedUseException - if called improperly

forceSecurityContext

void forceSecurityContext(SecurityContextStack stack,
                          boolean create)

Initializes the security context switching for the calling thread using the given context stack as the source of the initial and effective contexts.

This does not check or enforce session limits (e.g. max number of user sessions) because it relies upon an already existing security context. In other words, we are not adding a new user-level session but instead we are just properly initializing additional threads.

Parameters:

stack - Context stack to use instead of creating a new one. This allows the caller to override the initial and effective contexts.

create - true to add a new session for the effective context. The new session will not be associated with any network session nor will there be an authentication process. Instead, the previously authenticated effective context will be used to pattern a new session.

setInitialSecurityContextWorker

private void setInitialSecurityContextWorker(boolean unique,
                                             SecurityContextStack stack)

Drops any current context (if any) and establishes an initial context for the thread.

Parameters:

unique - true to instantiate a new context that is not associated with the current server account and does not share any context-local data. false to get the standard server-wide initial context which is associated with the server's account AND shares context-local data with all other server threads that also share this initial context. This parameter is only honored if the context parameter is null.

stack - Optional context stack to use instead of creating a new one. This allows the caller to override the initial and effective contexts.

dropInitialSecurityContext

public void dropInitialSecurityContext()

Releases the initial security context assigned to the calling thread. The initial security context can only be released if it is currently assigned and is the only context in the stack.

If called improperly, has no effect.

getSecureSocketContext

public javax.net.ssl.SSLContext getSecureSocketContext()
                                                throws java.security.NoSuchAlgorithmException,
                                                       java.security.KeyStoreException,
                                                       java.security.UnrecoverableKeyException,
                                                       java.security.KeyManagementException,
                                                       ConfigurationException,
                                                       java.security.NoSuchProviderException

Initializes and returns a valid SSL environment.

Returns:

The SSL environment which has been configured with our custom key and trust stores.

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableKeyException

java.security.KeyManagementException

ConfigurationException

java.security.NoSuchProviderException

getSecureSocketContext

public javax.net.ssl.SSLContext getSecureSocketContext(BootstrapConfig config)
                                                throws java.security.NoSuchAlgorithmException,
                                                       java.security.KeyStoreException,
                                                       java.security.UnrecoverableKeyException,
                                                       java.security.KeyManagementException,
                                                       ConfigurationException,
                                                       java.security.NoSuchProviderException

Initializes and returns a valid SSL environment.

Parameters:

config - Bootstrap configuration information used to initialize the secure socket context.

Returns:

The SSL environment which has been configured with our custom key and trust stores.

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyStoreException

java.security.UnrecoverableKeyException

java.security.KeyManagementException

ConfigurationException

java.security.NoSuchProviderException

pushAndSwitchSecurityContext

public void pushAndSwitchSecurityContext(java.lang.Object key)
                                  throws RestrictedUseException

Temporarily switches to a user context to serve the associated request. The calling thread has to have the initial security context.

The use count for the target security context is incremented by 1.

Parameters:

key - security context key

Throws:

RestrictedUseException - If called improperly.

pushAndSwitchSecurityContextBySessionId

public void pushAndSwitchSecurityContextBySessionId(java.lang.Object sessionId)
                                             throws RestrictedUseException

Temporarily switches to a user context to serve the associated request. The calling thread has to have the initial security context.

The use count for the target security context is incremented by 1.

Parameters:

sessionId - session id

Throws:

RestrictedUseException - If called improperly.

pushContextWorker

void pushContextWorker(java.lang.Object key)
                throws RestrictedUseException

Temporarily switches to a user context to serve the associated request. The calling thread has to have the initial security context.

The use count for the target security context is incremented by 1.

Parameters:

key - security context key

Throws:

RestrictedUseException - If called improperly.

popAndRestoreSecurityContext

public void popAndRestoreSecurityContext()
                                  throws RestrictedUseException

Restores the initial security context of the calling thread when it is done with the user request. The calling thread has to have its security context switched to a user context prior to this call.

The use count for the current security context is decremented by 1. If it becomes 0, it gets deleted immediately.

Throws:

RestrictedUseException - If called from an unauthorized location.

popAllSecurityContext

void popAllSecurityContext()
                    throws RestrictedUseException

Terminates all security contexts associated with the current thread, including the initial context. This MUST be used when terminating contexts obtained with setUniqueInitialSecurityContext(). If this is not used, then the unique initial contexts will never be cleaned up and there will be a memory leak.

The use count for the all security contexts is decremented by 1. If it becomes 0, it gets deleted immediately.

Throws:

RestrictedUseException - If called from an unauthorized location.

popContextWorker

private void popContextWorker()
                       throws RestrictedUseException

Restores the initial security context of the calling thread when it is done with the user request. The calling thread has to have its security context switched to a user context prior to this call.

The use count for the current security context is decremented by 1. If it becomes 0, it gets deleted immediately.

Throws:

RestrictedUseException - If called improperly.

endContext

private void endContext(SecurityContextStack cts,
                        SecurityContext ctx)

Worker routine to centralize unassignment and cleanup (if this was the final usage) of the given context.

Parameters:

cts - The context stack for the current thread.

ctx - The context to end.

createSecurityContext

private SecurityContext createSecurityContext(SecurityCache sc,
                                              java.lang.String pid,
                                              java.lang.String uid)

Private worker method that creates a new security context.

Parameters:

sc - SecurityCache where new security context belongs

pid - process ID for new security context

uid - user ID for new security context

Returns:

newly created SecurityContext

logNewContext

private void logNewContext(SecurityCache cache,
                           SecurityContext ctx)

Creates an audit record for security context creation event.

Parameters:

cache - security cache where to log this event

ctx - security context

logContext

private void logContext(SecurityCache cache,
                        SecurityContext ctx)

Creates an audit record for security context switch event.

Parameters:

cache - security cache where to log this event

ctx - coming security context, may be null

logGoingContext

private void logGoingContext(SecurityContext ctx)

Creates an audit record for a terminated security context.

Parameters:

ctx - security context