Skip to content

Commit

Permalink
SAK-27770 Adding become user webservice. Original work done by IU in …
Browse files Browse the repository at this point in the history 
…their branch, now merging changes to sakai trunk

git-svn-id: https://source.sakaiproject.org/svn/entitybroker/trunk@313814 66ffb92e-73f9-0310-93c1-f5514f145a0a
  • Loading branch information
@pushyamig
pushyamig committed Sep 24, 2014
1 parent 5910225 commit dfc438e
Show file tree
Hide file tree
Showing 3 changed files with 167 additions and 11 deletions.
172 changes: 162 additions & 10 deletions ...ore-providers/src/java/org/sakaiproject/entitybroker/providers/SessionEntityProvider.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,12 @@
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Vector;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.sakaiproject.entitybroker.EntityReference;
import org.sakaiproject.entitybroker.EntityView;
import org.sakaiproject.entitybroker.entityprovider.CoreEntityProvider;
Expand All @@ -44,8 +47,13 @@
import org.sakaiproject.entitybroker.entityprovider.search.Search;
import org.sakaiproject.entitybroker.providers.model.EntitySession;
import org.sakaiproject.entitybroker.util.AbstractEntityProvider;
import org.sakaiproject.event.api.Event;
import org.sakaiproject.event.api.EventTrackingService;
import org.sakaiproject.event.api.UsageSessionService;
import org.sakaiproject.tool.api.Session;
import org.sakaiproject.tool.api.SessionManager;
import org.sakaiproject.authz.api.AuthzGroupService;
import org.sakaiproject.authz.api.SecurityService;
import org.sakaiproject.user.api.User;
import org.sakaiproject.user.api.UserDirectoryService;
import org.sakaiproject.user.api.UserNotDefinedException;
Expand All @@ -61,6 +69,9 @@ public class SessionEntityProvider extends AbstractEntityProvider implements Cor
public static String AUTH_USERNAME = "_username";
public static String AUTH_PASSWORD = "_password";

private static Log log = LogFactory.getLog(SessionEntityProvider.class);
protected static final String SU_WS_BECOME_USER = "su.ws.become";

public SessionManager sessionManager;
public void setSessionManager(SessionManager sessionManager) {
this.sessionManager = sessionManager;
Expand All @@ -71,6 +82,34 @@ public void setUserDirectoryService(UserDirectoryService userDirectoryService) {
this.userDirectoryService = userDirectoryService;
}

public SecurityService securityService;
public SecurityService getSecurityService() {
return securityService;
}

public void setSecurityService(SecurityService securityService) {
this.securityService = securityService;
}

public AuthzGroupService authzGroupService;

public AuthzGroupService getAuthzGroupService() {
return authzGroupService;
}

public void setAuthzGroupService(AuthzGroupService authzGroupService) {
this.authzGroupService = authzGroupService;
}

public EventTrackingService eventTrackingService;

public EventTrackingService getEventTrackingService() {
return eventTrackingService;
}

public void setEventTrackingService(EventTrackingService eventTrackingService) {
this.eventTrackingService = eventTrackingService;
}

public static String PREFIX = "session";
public String getEntityPrefix() {
Expand All @@ -79,16 +118,11 @@ public String getEntityPrefix() {


public TemplateMap[] defineURLMappings() {
// see javadoc for this method for notes on special mappings
return new TemplateMap[] {
new TemplateMap("/{prefix}/{id}/norefresh", "/{prefix}/{id}{dot-extension}?auto=true"),
new TemplateMap("/{prefix}/current/norefresh", "/{prefix}/current{dot-extension}?auto=true"),
// below for testing only
// new TemplateMap("/{prefix}/xml/{id}", "/{prefix}/{id}.xml"),
// new TemplateMap("/{prefix}/test1", "/{prefix}/test2"),
// new TemplateMap("/{prefix}/test2", "/{prefix}/test3"),
// new TemplateMap("/{prefix}/test3", "/{prefix}/test1"),
};
// see javadoc for this method for notes on special mappings
return new TemplateMap[] {
new TemplateMap("/{prefix}/{id}/norefresh", "/{prefix}/{id}{dot-extension}?auto=true"),
new TemplateMap("/{prefix}/current/norefresh", "/{prefix}/current{dot-extension}?auto=true"),
};
}

@EntityCustomAction(action="current",viewKey=EntityView.VIEW_LIST)
Expand Down Expand Up @@ -275,4 +309,122 @@ private void checkSessionOwner(Session s) {
throw new SecurityException("Current user ("+currentUser+") cannot modify this session: " + s.getId() + ", they are not the owner or not an admin");
}

/**
* Allows user to become another user assuming requesting user is a Sakai admin
*
* url syntax: serverUrl/direct/session/becomeuser/:USERID:
*
* Where :USERID is either a userId or a userEid
*
* @param view
* @param params
* @return
*/
@EntityCustomAction(action="becomeuser",viewKey=EntityView.VIEW_LIST)
public Object getBecomeUser(EntityView view, Map<String, Object> params) {
/* This code (and the method after called getAllowed()) is based upon the suTool
*
*/

String result = "Failure";

boolean allowed = getAllowed();
Session sakaiSession = sessionManager.getCurrentSession();

log.info(sakaiSession.getUserEid() + " is attempting to change user via webservices");

if (!allowed) {
log.info(sakaiSession.getUserEid() + " is denied permission to change user via webservices. The User don't have the Admin role to this!!!");
return result;
}


String requestedUserId = view.getPathSegment(2);

if (requestedUserId == null) {
log.info("The BecomeUser id is not provided in the URL, try to give a valid UserID when making the become user API call" );
return result;
}

requestedUserId = requestedUserId.trim();

if (requestedUserId.length() == 0) {
return result;
}

User userinfo = null;
String validatedUserId = null;
String validatedUserEid = null;

try
{
// try with the user eid
userinfo = userDirectoryService.getUserByEid(requestedUserId);

validatedUserId = userinfo.getId();
validatedUserEid = userinfo.getEid();
}
catch (UserNotDefinedException e)
{
try
{
// try with the user id
userinfo = userDirectoryService.getUser(requestedUserId);

validatedUserId = userinfo.getId();
validatedUserEid = userinfo.getEid();
}
catch (UserNotDefinedException ee)
{
log.info("Their is no user assosiated with the provided userID \""+requestedUserId+"\" while become user via webservice");
return result;

}
}

// don't try to become yourself
if (sakaiSession.getUserEid().equals(validatedUserEid)) {
log.info(sakaiSession.getUserEid() + " tried to change into themselves via webservice. Denied!");
return result;
}

// Post an event
Event event = eventTrackingService.newEvent(SU_WS_BECOME_USER, userDirectoryService.userReference(validatedUserId), false);
eventTrackingService.post(event);

// logout - clear, but do not invalidate, preserve the usage session's current session
Vector saveAttributes = new Vector();
saveAttributes.add(UsageSessionService.USAGE_SESSION_KEY);
saveAttributes.add(UsageSessionService.SAKAI_CSRF_SESSION_ATTRIBUTE);
sakaiSession.clearExcept(saveAttributes);

String originalUserEid = sakaiSession.getUserEid();

// login - set the user id and eid into session, and refresh this user's authz information
sakaiSession.setUserId(validatedUserId);
sakaiSession.setUserEid(validatedUserEid);
authzGroupService.refreshUser(validatedUserId);

result = originalUserEid + " sucessfully became user " + validatedUserEid;

log.info(result);

return result;
}

private boolean getAllowed()
{
boolean allowed=true;

Session sakaiSession = sessionManager.getCurrentSession();

if (sakaiSession == null || !securityService.isSuperUser(sakaiSession.getUserId()))
{
allowed = false;
}


return allowed;
}

}
3 changes: 2 additions & 1 deletion entitybroker/core-providers/src/java/session.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ user to create the session for, NOTE: admins may create sessions for any user by
session.redirect./{prefix}/{id}/norefresh = Allows for a nice URL for getting a session without causing a refresh
session.redirect./{prefix}/current/norefresh = Easy URL to get the current session without causing a refresh
session.action.current = Retrieves the current session for the current request
session.action.becomeuser = Allows user to become another user assuming requesting user is a Sakai admin. \Syntax: serverUrl/direct/session/becomeuser/:USERID: , \where :USERID: is either a userId or a userEid
session.field.creationTime = millisecond time code of when the session was created
session.field.lastAccessedTime = millisecond time code of when the session was last refreshed
session.field.maxInactiveInterval = max seconds the session can be idle before automatic invalidation
session.field.userEid = the external id (typically username) of the user who owns this session
session.field.userEid = the external id (typically username) of the user who owns this session
3 changes: 3 additions & 0 deletions entitybroker/core-providers/src/webapp/WEB-INF/applicationContext.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
class="org.sakaiproject.entitybroker.providers.SessionEntityProvider">
<property name="sessionManager" ref="org.sakaiproject.tool.api.SessionManager" />
<property name="userDirectoryService" ref="org.sakaiproject.user.api.UserDirectoryService" />
<property name="securityService" ref="org.sakaiproject.authz.api.SecurityService" />
<property name="authzGroupService" ref="org.sakaiproject.authz.api.AuthzGroupService"/>
<property name="eventTrackingService" ref="org.sakaiproject.event.api.EventTrackingService" />
</bean>

<bean parent="org.sakaiproject.entitybroker.entityprovider.AbstractEntityProvider"
Expand Down

0 comments on commit dfc438e

Please sign in to comment.