Authentication object.Whilst JSPs can access the SecurityContext directly, this tag
- * avoids handling null conditions. The tag also properly accommodates
- * Authentication.getPrincipal(), which can either be a String or a
- * UserDetails.
Authentication object. The operation attribute
+ *
+ * Whilst JSPs can access the
+Anyone can view this page.
+
+If you're logged in, you can list accounts.
+
+Your principal object is....: <%= request.getUserPrincipal() %>
+
This is a protected page. You can get to me if you've been remembered,
-or if you've authenticated this session.SecurityContext directly, this tag avoids handling null conditions.
*
- * @author Ben Alex
+ * @author Thomas Champagne
* @version $Id$
*/
public class AuthenticationTag extends TagSupport {
- //~ Static fields/initializers =====================================================================================
-
- private static final Set methodPrefixValidOptions = new HashSet();
-
- static {
- methodPrefixValidOptions.add("get");
- methodPrefixValidOptions.add("is");
- }
//~ Instance fields ================================================================================================
- private String methodPrefix = "get";
- private String operation = "";
+ private String var;
+ private String property;
+ private int scope;
+ private boolean scopeSpecified;
+
//~ Methods ========================================================================================================
+ public AuthenticationTag() {
+ init();
+ }
+
+ // resets local state
+ private void init() {
+ var = null;
+ scopeSpecified = false;
+ scope = PageContext.PAGE_SCOPE;
+ }
+ public void setVar(String var) {
+ this.var = var;
+ }
+
+ public void setProperty(String operation) {
+ this.property = operation;
+ }
+
+ public void setScope(String scope) {
+ this.scope = TagUtils.getScope(scope);
+ this.scopeSpecified = true;
+ }
+
public int doStartTag() throws JspException {
- if ((null == operation) || "".equals(operation)) {
- return Tag.SKIP_BODY;
- }
-
- validateArguments();
-
- if ((SecurityContextHolder.getContext() == null)
- || !(SecurityContextHolder.getContext() instanceof SecurityContext)
- || (((SecurityContext) SecurityContextHolder.getContext()).getAuthentication() == null)) {
- return Tag.SKIP_BODY;
- }
-
- Authentication auth = SecurityContextHolder.getContext().getAuthentication();
-
- if (auth.getPrincipal() == null) {
- return Tag.SKIP_BODY;
- } else if (auth.getPrincipal() instanceof UserDetails) {
- writeMessage(invokeOperation(auth.getPrincipal()));
-
- return Tag.SKIP_BODY;
- } else {
- writeMessage(auth.getPrincipal().toString());
-
- return Tag.SKIP_BODY;
- }
+ return super.doStartTag();
}
- public String getMethodPrefix() {
- return methodPrefix;
- }
+ public int doEndTag() throws JspException {
+ Object result = null;
+ // determine the value by...
+ if (property != null) {
+ if ((SecurityContextHolder.getContext() == null)
+ || !(SecurityContextHolder.getContext() instanceof SecurityContext)
+ || (SecurityContextHolder.getContext().getAuthentication() == null)) {
+ return Tag.EVAL_PAGE;
+ }
- public String getOperation() {
- return operation;
- }
+ Authentication auth = SecurityContextHolder.getContext().getAuthentication();
- protected String invokeOperation(Object obj) throws JspException {
- Class clazz = obj.getClass();
- String methodToInvoke = getOperation();
- StringBuffer methodName = new StringBuffer();
- methodName.append(getMethodPrefix());
- methodName.append(methodToInvoke.substring(0, 1).toUpperCase());
- methodName.append(methodToInvoke.substring(1));
-
- Method method = null;
-
- try {
- method = clazz.getMethod(methodName.toString(), (Class[]) null);
- } catch (SecurityException se) {
- throw new JspException(se);
- } catch (NoSuchMethodException nsme) {
- throw new JspException(nsme);
+ if (auth.getPrincipal() == null) {
+ return Tag.EVAL_PAGE;
+ } else {
+ try {
+ BeanWrapperImpl wrapper = new BeanWrapperImpl(auth);
+ result = wrapper.getPropertyValue(property);
+ } catch (BeansException e) {
+ throw new JspException(e);
+ }
+ }
}
- Object retVal = null;
-
- try {
- retVal = method.invoke(obj, (Object[]) null);
- } catch (IllegalArgumentException iae) {
- throw new JspException(iae);
- } catch (IllegalAccessException iae) {
- throw new JspException(iae);
- } catch (InvocationTargetException ite) {
- throw new JspException(ite);
- }
-
- if (retVal == null) {
- retVal = "";
- }
-
- return retVal.toString();
- }
-
- public void setMethodPrefix(String methodPrefix) {
- this.methodPrefix = methodPrefix;
- }
-
- public void setOperation(String operation) {
- this.operation = operation;
- }
-
- protected void validateArguments() throws JspException {
- if ((getMethodPrefix() != null) && !getMethodPrefix().equals("")) {
- if (!methodPrefixValidOptions.contains(getMethodPrefix())) {
- throw new JspException("Authorization tag : no valid method prefix available");
+ if (var != null) {
+ /*
+ * Store the result, letting an IllegalArgumentException
+ * propagate back if the scope is invalid (e.g., if an attempt
+ * is made to store something in the session without any
+ * HttpSession existing).
+ */
+ if (result != null) {
+ pageContext.setAttribute(var, result, scope);
+ } else {
+ if (scopeSpecified) {
+ pageContext.removeAttribute(var, scope);
+ } else {
+ pageContext.removeAttribute(var);
+ }
}
} else {
- throw new JspException("Authorization tag : no method prefix available");
+ writeMessage(result.toString());
}
+ return EVAL_PAGE;
}
protected void writeMessage(String msg) throws JspException {
diff --git a/core/src/main/java/org/springframework/security/taglibs/velocity/AuthzImpl.java b/core/src/main/java/org/springframework/security/taglibs/velocity/AuthzImpl.java
index 966ba8178a..f02e549806 100644
--- a/core/src/main/java/org/springframework/security/taglibs/velocity/AuthzImpl.java
+++ b/core/src/main/java/org/springframework/security/taglibs/velocity/AuthzImpl.java
@@ -68,7 +68,7 @@ public class AuthzImpl implements Authz {
public String getPrincipal() {
MyAuthenticationTag authenticationTag = new MyAuthenticationTag();
- authenticationTag.setOperation("username");
+ authenticationTag.setProperty("username");
try {
authenticationTag.doStartTag();
diff --git a/core/src/main/resources/org/springframework/security/taglibs/security.tld b/core/src/main/resources/org/springframework/security/taglibs/security.tld
index aafd6ee4cd..5aaad516c7 100644
--- a/core/src/main/resources/org/springframework/security/taglibs/security.tld
+++ b/core/src/main/resources/org/springframework/security/taglibs/security.tld
@@ -8,8 +8,8 @@
Home Page
-Anyone can view this page.
-
-If you're logged in, you can list accounts.
-
-
-Your principal object is....: <%= request.getUserPrincipal() %>
+Secure Page
+
-
-<%if (request.isUserInRole("ROLE_SUPERVISOR")) { %>
- You are a supervisor! You can therefore see the extremely secure page.
-<% } %>
-
+or if you've authenticated this session.
+
+Properties obtained using <sec:authentication /> tag
+
+
+
Tag Value
+
+<sec:authentication property='name' />
+
+<sec:authentication property='principal.username' />
+
+<sec:authentication property='principal.enabled' />
+
+<sec:authentication property='principal.accountNonLocked' />