Package com.evolveum.midpoint.security.api

Interface SecurityContextManager

public interface SecurityContextManager

Manager of security context. Used for storing authentication into the security context, set up security context for task ownership, etc. This is a part of low-level security functions. Those are security functions that deal with the basic concepts of authentication, task ownership, security context and so on.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	SecurityContextManager.ResultAwareCheckedProducer<T>	A SecurityContextManager.ResultAwareProducer that can throw any CommonException.
static interface	SecurityContextManager.ResultAwareProducer<T>	Producer of a value that is Serializable and operates under given OperationResult.

Method Summary

Modifier and Type	Method	Description
void	clearTemporaryPrincipalOid()	Internal method to reset temporary principal OID.
org.springframework.security.core.Authentication	getAuthentication()
default MidPointPrincipal	getPrincipal()	Returns principal representing the currently logged-in user.
String	getPrincipalOid()	Returns OID of the current principal.
@Nullable HttpConnectionInformation	getStoredConnectionInformation()	Returns stored connection information.
MidPointPrincipalManager	getUserProfileService()
boolean	isAuthenticated()
<T> T	runAs(@NotNull SecurityContextManager.ResultAwareProducer<T> producer, @Nullable PrismObject<? extends FocusType> newPrincipalObject, boolean privileged, @NotNull OperationResult result)	Runs the provided code (within SecurityContextManager.ResultAwareProducer) as a specific user and/or with elevated privileges.
default <T> T	runAsChecked(SecurityContextManager.ResultAwareCheckedProducer<T> producer, PrismObject<? extends UserType> newPrincipalObject, OperationResult result)	Convenience method to deal with producers that can throw any CommonException.
<T> T	runPrivileged(@NotNull Producer<T> producer)	Runs the provided code (within Producer) with elevated privileges.
default <T> T	runPrivilegedChecked(CheckedProducer<T> producer)	Convenience method to deal with producers that can throw CommonException.
void	setTemporaryPrincipalOid(String value)	Internal method to set temporary principal OID used during login process as a return value of getPrincipalOid() method.
void	setupPreAuthenticatedSecurityContext(PrismObject<? extends FocusType> focus, OperationResult result)	Calls MidPointPrincipalManager to create a principal from provided focus object and sets it up.
void	setupPreAuthenticatedSecurityContext(PrismObject<? extends FocusType> focus, ProfileCompilerOptions options, OperationResult result)
void	setupPreAuthenticatedSecurityContext(MidPointPrincipal principal)
void	setupPreAuthenticatedSecurityContext(org.springframework.security.core.Authentication authentication)
void	setUserProfileService(MidPointPrincipalManager userProfileService)
void	storeConnectionInformation(@Nullable HttpConnectionInformation value)	Store connection information for later use within current thread.

Method Details

isAuthenticated

boolean isAuthenticated()

getAuthentication

org.springframework.security.core.Authentication getAuthentication()

getPrincipal

default MidPointPrincipal getPrincipal()
                                throws SecurityViolationException

Returns principal representing the currently logged-in user. Assumes that the user is logged-in. Otherwise an exception is thrown.

Throws:

SecurityViolationException

See Also:

• SecurityUtil.getPrincipal()
• SecurityUtil.getPrincipalIfExists()
• SecurityUtil.getPrincipalRequired()
• SecurityUtil.getPrincipalOidIfAuthenticated()

getPrincipalOid

String getPrincipalOid()

Returns OID of the current principal. After login is complete, the returned OID is the same as getPrincipal().getOid(). However, during login process, this method returns the OID of the user that is being authenticated/logged-in (a.k.a. temporary principal OID).

setTemporaryPrincipalOid

void setTemporaryPrincipalOid(String value)

Internal method to set temporary principal OID used during login process as a return value of getPrincipalOid() method.

clearTemporaryPrincipalOid

void clearTemporaryPrincipalOid()

Internal method to reset temporary principal OID.

setupPreAuthenticatedSecurityContext

void setupPreAuthenticatedSecurityContext(org.springframework.security.core.Authentication authentication)

setupPreAuthenticatedSecurityContext

void setupPreAuthenticatedSecurityContext(MidPointPrincipal principal)

setupPreAuthenticatedSecurityContext

void setupPreAuthenticatedSecurityContext(PrismObject<? extends FocusType> focus,
 OperationResult result)
                                   throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Calls MidPointPrincipalManager to create a principal from provided focus object and sets it up.

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

setupPreAuthenticatedSecurityContext

void setupPreAuthenticatedSecurityContext(PrismObject<? extends FocusType> focus,
 ProfileCompilerOptions options,
 OperationResult result)
                                   throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

runAs

<T> T runAs(@NotNull
 @NotNull SecurityContextManager.ResultAwareProducer<T> producer,
 @Nullable
 @Nullable PrismObject<? extends FocusType> newPrincipalObject,
 boolean privileged,
 @NotNull
 @NotNull OperationResult result)
     throws SchemaException,
CommunicationException,
ConfigurationException,
SecurityViolationException,
ExpressionEvaluationException

Runs the provided code (within SecurityContextManager.ResultAwareProducer) as a specific user and/or with elevated privileges.

Throws:

SchemaException

CommunicationException

ConfigurationException

SecurityViolationException

ExpressionEvaluationException

runAsChecked

default <T> T runAsChecked(SecurityContextManager.ResultAwareCheckedProducer<T> producer,
 PrismObject<? extends UserType> newPrincipalObject,
 OperationResult result)
                    throws CommonException

Convenience method to deal with producers that can throw any CommonException.

Throws:

CommonException

runPrivileged

<T> T runPrivileged(@NotNull
 @NotNull Producer<T> producer)

Runs the provided code (within Producer) with elevated privileges.

runPrivilegedChecked

default <T> T runPrivilegedChecked(CheckedProducer<T> producer)
                            throws CommonException

Convenience method to deal with producers that can throw CommonException.

Throws:

CommonException

getUserProfileService

MidPointPrincipalManager getUserProfileService()

setUserProfileService

void setUserProfileService(MidPointPrincipalManager userProfileService)

storeConnectionInformation

void storeConnectionInformation(@Nullable
 @Nullable HttpConnectionInformation value)

Store connection information for later use within current thread.

getStoredConnectionInformation

@Nullable
@Nullable HttpConnectionInformation getStoredConnectionInformation()

Returns stored connection information. Should be used for non-HTTP threads that have no access to stored Request object (see SecurityUtil.getCurrentConnectionInformation()).