X-Git-Url: https://git.argeo.org/?a=blobdiff_plain;f=org.argeo.cms%2Fsrc%2Forg%2Fargeo%2Fcms%2Fauth%2FCurrentUser.java;h=eaaf41ab72a458ee7acacb0778315922c9c52ba5;hb=3577df2ca5eee54db1ac39a7bd5ed7bdc8824a67;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..eaaf41ab7 100644 --- a/org.argeo.cms/src/org/argeo/cms/auth/CurrentUser.java +++ b/org.argeo.cms/src/org/argeo/cms/auth/CurrentUser.java @@ -1,81 +1,91 @@ -/* - * Copyright (C) 2007-2012 Argeo GmbH - * - * Licensed under the Apache License, Version 2.0 (the "License"); - * you may not use this file except in compliance with the License. - * You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - */ package org.argeo.cms.auth; import java.security.AccessController; import java.security.Principal; -import java.security.acl.Group; +import java.security.PrivilegedAction; +import java.security.PrivilegedActionException; +import java.security.PrivilegedExceptionAction; import java.util.HashSet; +import java.util.Locale; import java.util.Set; +import java.util.UUID; import javax.security.auth.Subject; import javax.security.auth.x500.X500Principal; -import org.argeo.cms.CmsException; -import org.argeo.eclipse.ui.specific.UiContext; -import org.argeo.node.NodeConstants; -import org.argeo.node.security.NodeAuthenticated; +import org.argeo.api.NodeConstants; +import org.argeo.cms.internal.auth.CmsSessionImpl; +import org.argeo.cms.internal.auth.ImpliedByPrincipal; +import org.argeo.cms.internal.kernel.Activator; 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 + */ /** - * @return the authenticated username or null if not authenticated / - * anonymous + * Technical username of the currently authenticated user. + * + * @return the authenticated username or null if not authenticated / anonymous */ public static String getUsername() { 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(); + /** Locale of the current user */ + public final static Locale locale() { + return locale(currentSubject()); } - public static boolean isAnonymous(Subject subject) { - if (subject == null) - return true; - String username = getUsername(subject); - return username == null - || username.equalsIgnoreCase(NodeConstants.ROLE_ANONYMOUS); + /** Roles of the currently logged-in user */ + public final static Set roles() { + return roles(currentSubject()); } - /** - * 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); + /** Returns true if the current user is in the specified role */ + public static boolean isInRole(String role) { + Set roles = roles(); + return roles.contains(role); + } + + /** 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"); + throw new IllegalArgumentException("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,38 +93,71 @@ 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(ImpliedByPrincipal.class)) { + roles.add(group.getName()); + } + return roles; } - public final static Set roles() { - return roles(currentSubject()); + public final static Locale locale(Subject subject) { + Set locales = subject.getPublicCredentials(Locale.class); + if (locales.isEmpty()) { + Locale defaultLocale = Activator.getNodeState().getDefaultLocale(); + return defaultLocale; + } else + return locales.iterator().next(); + } + + /** 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); } + public CmsSession getCmsSession() { + Subject subject = currentSubject(); + CmsSessionId cmsSessionId = subject.getPrivateCredentials(CmsSessionId.class).iterator().next(); + return CmsSessionImpl.getByUuid(cmsSessionId.getUuid()); + } + + /* + * HELPERS + */ private static Subject currentSubject() { - NodeAuthenticated cmsView = getNodeAuthenticated(); - if (cmsView != null) - return cmsView.getLoginContext().getSubject(); - Subject subject = Subject.getSubject(AccessController.getContext()); + Subject subject = getAccessControllerSubject(); if (subject != null) return subject; - throw new CmsException("Cannot find related subject"); + throw new IllegalStateException("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); + private static Subject getAccessControllerSubject() { + return Subject.getSubject(AccessController.getContext()); } - 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(); + } + + public static boolean logoutCmsSession(Subject subject) { + UUID nodeSessionId; + if (subject.getPrivateCredentials(CmsSessionId.class).size() == 1) + nodeSessionId = subject.getPrivateCredentials(CmsSessionId.class).iterator().next().getUuid(); + else + return false; + CmsSessionImpl cmsSession = CmsSessionImpl.getByUuid(nodeSessionId.toString()); + + // FIXME logout all views + // TODO check why it is sometimes null + if (cmsSession != null) + cmsSession.close(); + // if (log.isDebugEnabled()) + // log.debug("Logged out CMS session " + cmsSession.getUuid()); + return true; } private CurrentUser() {