X-Git-Url: http://git.argeo.org/?a=blobdiff_plain;f=org.argeo.cms%2Fsrc%2Forg%2Fargeo%2Fcms%2Fauth%2FCurrentUser.java;h=5b4ab174e59be0d57a2ce986e78d94fc643c7b7f;hb=18af628c072e386420f03261ab207a72341a0a1b;hp=a23822b21fe48c7db3f43a090c059fdccfb4400a;hpb=d53071455192a97322935a911c9fbbfd92084912;p=lgpl%2Fargeo-commons.git diff --git a/org.argeo.cms/src/org/argeo/cms/auth/CurrentUser.java b/org.argeo.cms/src/org/argeo/cms/auth/CurrentUser.java index a23822b21..5b4ab174e 100644 --- a/org.argeo.cms/src/org/argeo/cms/auth/CurrentUser.java +++ b/org.argeo.cms/src/org/argeo/cms/auth/CurrentUser.java @@ -17,6 +17,9 @@ package org.argeo.cms.auth; import java.security.AccessController; import java.security.Principal; +import java.security.PrivilegedAction; +import java.security.PrivilegedActionException; +import java.security.PrivilegedExceptionAction; import java.security.acl.Group; import java.util.HashSet; import java.util.Set; @@ -30,10 +33,18 @@ import org.argeo.node.NodeConstants; import org.argeo.node.security.NodeAuthenticated; import org.osgi.service.useradmin.Authorization; -/** Static utilities */ +/** + * Programmatic access to the currently authenticated user, within a CMS + * context. + */ public final class CurrentUser { + /* + * CURRENT USER API + */ /** + * Technical username of the currently authenticated user. + * * @return the authenticated username or null if not authenticated / * anonymous */ @@ -41,41 +52,50 @@ public final class CurrentUser { return getUsername(currentSubject()); } + /** + * Human readable name of the currently authenticated user (typically first + * name and last name). + */ public static String getDisplayName() { return getDisplayName(currentSubject()); } + /** Whether a user is currently authenticated. */ public static boolean isAnonymous() { return isAnonymous(currentSubject()); } - public static boolean isRegistered() { - return !isAnonymous(); + /** Roles of the currently logged-in user */ + public final static Set roles() { + return roles(currentSubject()); } - public static boolean isAnonymous(Subject subject) { - if (subject == null) - return true; - String username = getUsername(subject); - return username == null - || username.equalsIgnoreCase(NodeConstants.ROLE_ANONYMOUS); + /** Returns true if the current user is in the specified role */ + public static boolean isInRole(String role) { + Set roles = roles(); + return roles.contains(role); } - /** - * The node authenticated component (typically a CMS view) related to this - * display, or null if none is available from this call. - */ - public static NodeAuthenticated getNodeAuthenticated() { - return UiContext.getData(NodeAuthenticated.KEY); + /** Executes as the current user */ + public final static T doAs(PrivilegedAction action) { + return Subject.doAs(currentSubject(), action); } + /** Executes as the current user */ + public final static T tryAs(PrivilegedExceptionAction action) throws PrivilegedActionException { + return Subject.doAs(currentSubject(), action); + } + + /* + * WRAPPERS + */ + public final static String getUsername(Subject subject) { if (subject == null) throw new CmsException("Subject cannot be null"); if (subject.getPrincipals(X500Principal.class).size() != 1) return NodeConstants.ROLE_ANONYMOUS; - Principal principal = subject.getPrincipals(X500Principal.class) - .iterator().next(); + Principal principal = subject.getPrincipals(X500Principal.class).iterator().next(); return principal.getName(); } @@ -83,14 +103,25 @@ public final class CurrentUser { return getAuthorization(subject).toString(); } - private static Authorization getAuthorization(Subject subject) { - return subject.getPrivateCredentials(Authorization.class).iterator() - .next(); + public final static Set roles(Subject subject) { + Set roles = new HashSet(); + roles.add(getUsername(subject)); + for (Principal group : subject.getPrincipals(Group.class)) { + roles.add(group.getName()); + } + return roles; } - public final static Set roles() { - return roles(currentSubject()); + /** Whether this user is currently authenticated. */ + public static boolean isAnonymous(Subject subject) { + if (subject == null) + return true; + String username = getUsername(subject); + return username == null || username.equalsIgnoreCase(NodeConstants.ROLE_ANONYMOUS); } + /* + * HELPERS + */ private static Subject currentSubject() { NodeAuthenticated cmsView = getNodeAuthenticated(); @@ -102,19 +133,17 @@ public final class CurrentUser { throw new CmsException("Cannot find related subject"); } - /** Returns true if the current user is in the specified role */ - public static boolean isInRole(String role) { - Set roles = roles(); - return roles.contains(role); + /** + * The node authenticated component (typically a CMS view) related to this + * display, or null if none is available from this call. Not API: Only + * for low-level access. + */ + private static NodeAuthenticated getNodeAuthenticated() { + return UiContext.getData(NodeAuthenticated.KEY); } - public final static Set roles(Subject subject) { - Set roles = new HashSet(); - roles.add(getUsername(subject)); - for (Principal group : subject.getPrincipals(Group.class)) { - roles.add(group.getName()); - } - return roles; + private static Authorization getAuthorization(Subject subject) { + return subject.getPrivateCredentials(Authorization.class).iterator().next(); } private CurrentUser() {