ome.security

Class SecuritySystemHolder

java.lang.Object

ome.security.SecuritySystemHolder

All Implemented Interfaces:

SecuritySystem

public class SecuritySystemHolder
extends Object
implements SecuritySystem

Security dispatcher holding each currently active SecuritySystem instance and allowing dispatching between them.

Since:

3.0-Beta4

Author:

Josh Moore, josh at glencoesoftware.com

See Also:

BasicSecuritySystem, SharingSecuritySystem

Field Summary

Fields

Modifier and Type	Field and Description
protected BasicSecuritySystem	basic
protected ThreadLocal<SecuritySystem>	current
protected SharingSecuritySystem	sharing

Constructor Summary

Constructors

Constructor and Description
SecuritySystemHolder(BasicSecuritySystem basic, SharingSecuritySystem sharing)

Method Summary

Modifier and Type	Method and Description
Details	checkManagedDetails(IObject object, Details trustedDetails) checks that a non-privileged user has not attempted to edit the entity's security details.
void	checkRestriction(String name, IObject obj) Checks whether or not a Policy instance of matching name has been registered, considers itself active, and considers the passed context object to be restricted.
SecuritySystem	choose()
void	disable(String... ids) disables components of the backend for the current Thread.
<T extends IObject> T	doAction(SecureAction action, T... objs)
void	enable(String... ids) enables components of the backend for the current Thread.
Long	getEffectiveUID() Returns UID based on whether a share is active, etc.
EventContext	getEventContext() Calls SecuritySystem.getEventContext(boolean) with a false as "refresh".
EventContext	getEventContext(boolean refresh) If refresh is false, returns the current EventContext stored in the session.
Roles	getSecurityRoles()
boolean	hasPrivilegedToken(IObject obj) checks that the IObject argument has been granted a Token by the SecuritySystem.
void	invalidateEventContext() Clears the content of the EventContextso that the SecuritySystem will no longer return true for SecuritySystem.isReady().
boolean	isDisabled(String id) checks if the listed id is disabled for the current Thread.
boolean	isGraphCritical(Details details) Determines if the current security context has the possibility of corrupting consistent graphs.
boolean	isReady() checks if this SecuritySystem instance is in a valid state.
boolean	isSystemType(Class<? extends IObject> klass) checks if instances of the given type are "System-Types".
void	loadEventContext(boolean isReadOnly) Prepares the current EventContext instance with the current Principal.
void	login(Principal principal) stores this Principal instance in the current thread context for authenticating and authorizing all actions.
int	logout() clears the top Principal instance from the current thread context.
Details	newTransientDetails(IObject object) creates a new secure details for transient entities.
void	runAsAdmin(AdminAction action) Calls SecuritySystem.runAsAdmin(ExperimenterGroup, AdminAction) with a null group.
void	runAsAdmin(ExperimenterGroup group, AdminAction action) Allows actions to be performed with the EventContext.isCurrentUserAdmin() flag enabled but without changing the value of EventContext.getCurrentUserId(), so that ownerships are properly handled.

Methods inherited from class java.lang.Object

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

Field Detail

basic

protected final BasicSecuritySystem basic

sharing

protected final SharingSecuritySystem sharing

current

protected ThreadLocal<SecuritySystem> current

Constructor Detail

SecuritySystemHolder

public SecuritySystemHolder(BasicSecuritySystem basic,
                            SharingSecuritySystem sharing)

Method Detail

choose

public SecuritySystem choose()

checkManagedDetails

public Details checkManagedDetails(IObject object,
                                   Details trustedDetails)
                            throws ApiUsageException,
                                   SecurityViolation

Description copied from interface: SecuritySystem

checks that a non-privileged user has not attempted to edit the entity's security details. Privileged users can set fields on Details as a single-step chmod and chgrp. managedDetails may create a new Details instance and return that if needed. If the returned Details is not equivalent (==) to the argument Details, then values have been changed.

Specified by:

checkManagedDetails in interface SecuritySystem

Parameters:

object - non-null IObject instance. Details for that instance can be null.

trustedDetails - possibly null Details instance. These Details are trusted in the sense that they have already once passed through the SecuritySystem.

Throws:

ApiUsageException - if SecuritySystem is not ready

SecurityViolation - if Details instance contains illegal values.

invalidateEventContext

public void invalidateEventContext()

Description copied from interface: SecuritySystem

Clears the content of the EventContextso that the SecuritySystem will no longer return true for SecuritySystem.isReady(). The Principal set during SecuritySystem.login(Principal) is retained.

Specified by:

invalidateEventContext in interface SecuritySystem

disable

public void disable(String... ids)

Description copied from interface: SecuritySystem

disables components of the backend for the current Thread. Further checks to SecuritySystem.isDisabled(String) will return false. It is the responsibility of various security system components to then throw exceptions.

Specified by:

disable in interface SecuritySystem

Parameters:

ids - Non-null, non-empty array of String ids to disable.

doAction

public <T extends IObject> T doAction(SecureAction action,
                                      T... objs)

Specified by:

doAction in interface SecuritySystem

enable

public void enable(String... ids)

Description copied from interface: SecuritySystem

enables components of the backend for the current Thread. Further checks to SecuritySystem.isDisabled(String) will return true.

Specified by:

enable in interface SecuritySystem

Parameters:

ids - possibly null array of String ids. A null array specifies that all subsystems are to be enabled. Otherwise, only those subsystems specified by the ids.

getEventContext

public EventContext getEventContext()

Description copied from interface: SecuritySystem

Calls SecuritySystem.getEventContext(boolean) with a false as "refresh". This is the previous, safer logic of the method since consumers are not expecting a long method run.

Specified by:

getEventContext in interface SecuritySystem

Returns:

the event context

getEventContext

public EventContext getEventContext(boolean refresh)

Description copied from interface: SecuritySystem

If refresh is false, returns the current EventContext stored in the session. Otherwise, reloads the context to have the most up-to-date information.

Specified by:

getEventContext in interface SecuritySystem

Parameters:

refresh - if the event context should first be reloaded

Returns:

the event context

See Also:

Trac ticket #4011

getEffectiveUID

public Long getEffectiveUID()

Description copied from interface: SecuritySystem

Returns UID based on whether a share is active, etc. This is the UID value that should be used for writing data. The return value may be null if the user is currently querying across multiple contents. In this case another method for choosing the UID must be chosen, for example by taking the UID of another element under consideration. For example,

 Annotation toSave = ...;
 if (toSave.getDetails().getOwner() == null) // No owner need to find one.
 {
     Long uid = sec.getEffectiveUID();
     if (uid != null)
     {
         toSave.getDetails().setOwner(new Experimenter(uid, false));
     }
     else
     {
         toSave.getDetails().setOwner(
            image.getDetails().getOwner()); // may be null.
     }
 }
 image.linkAnnotation(toSave);
 etc.
 

Specified by:

getEffectiveUID in interface SecuritySystem

Returns:

the effective user ID

getSecurityRoles

public Roles getSecurityRoles()

Specified by:

getSecurityRoles in interface SecuritySystem

hasPrivilegedToken

public boolean hasPrivilegedToken(IObject obj)

Description copied from interface: SecuritySystem

checks that the IObject argument has been granted a Token by the SecuritySystem.

Specified by:

hasPrivilegedToken in interface SecuritySystem

checkRestriction

public void checkRestriction(String name,
                             IObject obj)

Description copied from interface: SecuritySystem

Checks whether or not a Policy instance of matching name has been registered, considers itself active, and considers the passed context object to be restricted.

Specified by:

checkRestriction in interface SecuritySystem

Parameters:

name - A non-null unique name for a class of policies.

obj - An instance which is to be checked against matching policies.

isDisabled

public boolean isDisabled(String id)

Description copied from interface: SecuritySystem

checks if the listed id is disabled for the current Thread.

Specified by:

isDisabled in interface SecuritySystem

Parameters:

id - non-null String representing a backend subsystem.

Returns:

true if the backend subsystem has been previously disabled by calls to SecuritySystem.disable(String[])

isReady

public boolean isReady()

Description copied from interface: SecuritySystem

checks if this SecuritySystem instance is in a valid state. This includes that a user is properly logged in and that a connection is available to all necessary resources, e.g. database handle and mapping session. Not all methods require that the instance is ready.

Specified by:

isReady in interface SecuritySystem

Returns:

true if all methods on this interface are ready to be called.

isSystemType

public boolean isSystemType(Class<? extends IObject> klass)

Description copied from interface: SecuritySystem

checks if instances of the given type are "System-Types". Security logic for all system types is significantly different. In general, system types cannot be created, updated, or deleted by regular users, and are visible to all users.

Specified by:

isSystemType in interface SecuritySystem

Parameters:

klass - A class which extends from IObject

Returns:

true if instances of the class argument can be considered system types.

loadEventContext

public void loadEventContext(boolean isReadOnly)

Description copied from interface: SecuritySystem

Prepares the current EventContext instance with the current Principal. An exception is thrown if there is none.

Specified by:

loadEventContext in interface SecuritySystem

login

public void login(Principal principal)

Description copied from interface: SecuritySystem

stores this Principal instance in the current thread context for authenticating and authorizing all actions. This method does not make any queries and is only a conduit for login information from the outermost levels. Session bean implementations and other in-JVM clients can fill the Principal. Note, however, a call must first be made to SecuritySystem.loadEventContext(boolean) for some calls to be made to the SecuritySystem. In general, this means that execution must pass through the EventHandler

Specified by:

login in interface SecuritySystem

Parameters:

principal - the new current principal

logout

public int logout()

Description copied from interface: SecuritySystem

clears the top Principal instance from the current thread context.

Specified by:

logout in interface SecuritySystem

Returns:

the number of remaining instances.

newTransientDetails

public Details newTransientDetails(IObject object)
                            throws ApiUsageException,
                                   SecurityViolation

Description copied from interface: SecuritySystem

creates a new secure details for transient entities. Non-privileged users can only edit the Permissions field. Privileged users can use the Details object as a single-step chmod and chgrp. newTransientDetails always returns a non-null Details that is not equivalent (==) to the Details argument. This method can be used from anywhere in the codebase to obtain a valid Details, but passing in an IObject instance with a null Details. However, if the Details is non-null, there is the possibility that this method will throw an exception.

Specified by:

newTransientDetails in interface SecuritySystem

Throws:

ApiUsageException - if SecuritySystem is not ready

SecurityViolation - if Details instance contains illegal values.

runAsAdmin

public void runAsAdmin(AdminAction action)

Description copied from interface: SecuritySystem

Calls SecuritySystem.runAsAdmin(ExperimenterGroup, AdminAction) with a null group.

Specified by:

runAsAdmin in interface SecuritySystem

Parameters:

action - the action to run

runAsAdmin

public void runAsAdmin(ExperimenterGroup group,
                       AdminAction action)

Description copied from interface: SecuritySystem

Allows actions to be performed with the EventContext.isCurrentUserAdmin() flag enabled but without changing the value of EventContext.getCurrentUserId(), so that ownerships are properly handled. The merging of detached entity graphs should be disabled for the extent of the execution. Due to the addition of the group permission system, we also permit setting the group on the call so that the administrator can work within all groups. A value of null will not change the current group. Note: the IUpdate save methods should not be used, since they also accept detached entities, which could pose security risks. Instead load an entity from the database via IQuery, make changes, and save the changes with IUpdate.

Specified by:

runAsAdmin in interface SecuritySystem

Parameters:

group - the group to run the action as

action - the action to run

isGraphCritical

public boolean isGraphCritical(Details details)

Description copied from interface: SecuritySystem

Determines if the current security context has the possibility of corrupting consistent graphs. Consistent graphs are enforced by the security context to make sure that all READ actions work smoothly. If an administrator or PI is logged into a private group, or otherwise may create an object linked to an object with lower READ rights, then corruption could occur. Starting with 4.4.2, a trusted details object should be passed in order to handle the situation where the current group id is -1. Possibles cases that can occur:

  The current group is non-negative, then use the previous logic;
  else the current group is negative,
     and the object is in a non-"user" group: USE THAT GROUP;
     else the object is in the "user" group: UNCLEAR
     (for the moment we're throwing an exception)
 

If no Details instance is passed or a Details without a ExperimenterGroup value, then throw as well.

Specified by:

isGraphCritical in interface SecuritySystem

Parameters:

details - the details

Returns:

if the graph is critical

See Also:

1769,

Skip navigation links

• Overview
• Package
• Class
• Use
• Tree
• Deprecated
• Index
• Help

• Prev Class
• Next Class

• Frames
• No Frames

• All Classes

• Summary:
• Nested |
• Field |
• Constr |
• Method

• Detail:
• Field |
• Constr |
• Method

OmeroJava API

Version: 5.3.5-ice35-b73

Copyright © 2017 The University of Dundee & Open Microscopy Environment. All Rights Reserved.