You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lenya.apache.org by an...@apache.org on 2007/12/12 13:02:09 UTC
svn commit: r603581 - in
/lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth:
ShibbolethAuthenticator.java ShibbolethUtil.java
Author: andreas
Date: Wed Dec 12 04:02:06 2007
New Revision: 603581
URL: http://svn.apache.org/viewvc?rev=603581&view=rev
Log:
Added some javadoc comments
Modified:
lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java
lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethUtil.java
Modified: lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java
URL: http://svn.apache.org/viewvc/lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java?rev=603581&r1=603580&r2=603581&view=diff
==============================================================================
--- lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java (original)
+++ lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethAuthenticator.java Wed Dec 12 04:02:06 2007
@@ -55,25 +55,37 @@
import org.opensaml.SAMLBrowserProfile.BrowserProfileResponse;
/**
- * <p>Shibboleth-based authenticator.<p>
- * <p>Configuration:</p>
+ * <p>
+ * Shibboleth-based authenticator.
+ * <p>
+ * <p>
+ * Configuration:
+ * </p>
* <ul>
- * <li>
- * <code><redirect-to-wayf>true|false</redirect-to-wayf></code>
- * - if the application should redirect to the WAYF server instead of the login screen
- * if a resource is protected only via group rules
- * </li>
+ * <li> <code><redirect-to-wayf>true|false</redirect-to-wayf></code> - if the
+ * application should redirect to the WAYF server instead of the login screen if a resource is
+ * protected only via group rules </li>
+ *
* </pre>
*/
public class ShibbolethAuthenticator extends UserAuthenticator implements Configurable {
+ protected static final String REDIRECT_TO_WAYF = "redirect-to-wayf";
+
protected static final String ERROR_MISSING_UID_ATTRIBUTE = "Unable to get unique identifier for subject. "
- + "Make sure you are listed in the metadata.xml "
- + "file and your resources your are trying to access "
- + "are available and your are allowed to see them. (Resourceregistry).";
-
+ + "Make sure you are listed in the metadata.xml "
+ + "file and your resources your are trying to access "
+ + "are available and your are allowed to see them. (Resourceregistry).";
+
private boolean redirectToWayf = false;
+ /**
+ * Authenticates the request. If the request contains the parameters <em>username</em> and
+ * <em>password</em>, the authentication is delegated to the super class
+ * {@link UserAuthenticator}. Otherwise, the Shibboleth browser profile request is evaluated.
+ * @see org.apache.lenya.ac.impl.UserAuthenticator#authenticate(org.apache.lenya.ac.AccreditableManager,
+ * org.apache.cocoon.environment.Request, org.apache.lenya.ac.ErrorHandler)
+ */
public boolean authenticate(AccreditableManager accreditableManager, Request request,
ErrorHandler handler) throws AccessControlException {
@@ -102,7 +114,7 @@
.lookup(AssertionConsumerService.ROLE);
attrReqService = (AttributeRequestService) this.manager
.lookup(AttributeRequestService.ROLE);
-
+
ShibbolethUtil util = new ShibbolethUtil(this.manager);
String host = util.getBaseUrl();
BrowserProfileResponse bpResponse = consumerService.processRequest(req, host);
@@ -205,6 +217,11 @@
}
}
+ /**
+ * Extracts the <code>HttpServletRequest</code> object from the current Cocoon context.
+ * @return An <code>HttpServletRequest</code> object.
+ * @throws AccessControlException
+ */
protected HttpServletRequest getHttpServletRequest() throws AccessControlException {
HttpServletRequest req;
ContextUtility contextUtil = null;
@@ -222,44 +239,68 @@
return req;
}
+ /**
+ * <p>
+ * This method returns the URI which displays the login screen:
+ * </p>
+ * <ul>
+ * <li>If the configuration option {@link #REDIRECT_TO_WAYF}Êis set to <code>true</code> and
+ * the request points to a page which is only protected by rules, we assume that the Shibboleth
+ * authentication shall be used and return the URL which redirects to the WAYF server.</li>
+ * <li>Otherwise, the Lenya login usecase URL is returned.</li>
+ * </ul>
+ * @return A string.
+ * @see org.apache.lenya.ac.impl.UserAuthenticator#getLoginUri(org.apache.cocoon.environment.Request)
+ */
public String getLoginUri(Request request) {
- if (this.redirectToWayf && isOnlyShibbolethProtected(request)) {
+ if (this.redirectToWayf && isOnlyRuleProtected(request)) {
return request.getRequestURI() + "?lenya.usecase=shibboleth&lenya.step=wayf";
- }
- else {
+ } else {
return super.getLoginUri(request);
}
}
- protected boolean isOnlyShibbolethProtected(Request request) {
+ /**
+ * <p>
+ * Checks if a page is protected only with rules:
+ * </p>
+ * <ul>
+ * <li> If the aggregated policy for the current page contains credentials which assign a role
+ * to a particular user or IP range, or to a group which contains explicitly assigned members,
+ * the method returns <code>false</code>. </li>
+ * <li> Otherwise, the method returns <code>true</code>.
+ * </ul>
+ * @param request The request referring to the page.
+ * @return A boolean value.
+ */
+ protected boolean isOnlyRuleProtected(Request request) {
DefaultAccessController accessController = null;
ServiceSelector selector = null;
AccessControllerResolver resolver = null;
try {
selector = (ServiceSelector) manager.lookup(AccessControllerResolver.ROLE + "Selector");
- resolver =
- (AccessControllerResolver) selector.select(
- AccessControllerResolver.DEFAULT_RESOLVER);
+ resolver = (AccessControllerResolver) selector
+ .select(AccessControllerResolver.DEFAULT_RESOLVER);
String url = ServletHelper.getWebappURI(request);
accessController = (DefaultAccessController) resolver.resolveAccessController(url);
-
+
AccreditableManager accMgr = accessController.getAccreditableManager();
Policy policy = accessController.getPolicyManager().getPolicy(accMgr, url);
-
+
Role[] roles = accMgr.getRoleManager().getRoles();
Set accreditables = new HashSet();
for (int i = 0; i < roles.length; i++) {
Accreditable[] accrs = policy.getAccreditables(roles[i]);
accreditables.addAll(Arrays.asList(accrs));
}
-
+
if (accreditables.isEmpty()) {
return false;
}
-
- for (Iterator i = accreditables.iterator(); i.hasNext(); ) {
+
+ for (Iterator i = accreditables.iterator(); i.hasNext();) {
Accreditable accr = (Accreditable) i.next();
if (!(accr instanceof Group)) {
return false;
@@ -270,7 +311,7 @@
return false;
}
}
-
+
return true;
} catch (Exception e) {
@@ -289,17 +330,27 @@
}
public void configure(Configuration config) throws ConfigurationException {
- Configuration redirectConfig = config.getChild("redirect-to-wayf", false);
+ Configuration redirectConfig = config.getChild(REDIRECT_TO_WAYF, false);
if (redirectConfig != null) {
this.redirectToWayf = redirectConfig.getValueAsBoolean();
}
}
+ /**
+ * <p>
+ * This method returns the URL of the protected page, as passed from the identity provider as
+ * the value of the {@link AssertionConsumerServiceImpl#REQ_PARAM_TARGET} request parameter. If
+ * the request parameter is missing, the current URL, i.e. the assertion consumer URL, is
+ * returned.
+ * </p>
+ * @see org.apache.lenya.ac.impl.UserAuthenticator#getTargetUri(org.apache.cocoon.environment.Request)
+ */
public String getTargetUri(Request request) {
String paramName = AssertionConsumerServiceImpl.REQ_PARAM_TARGET;
String target = request.getParameter(paramName);
if (target == null) {
- getLogger().warn("Request parameter " + paramName + " is missing, using current URI as target.");
+ getLogger().warn(
+ "Request parameter " + paramName + " is missing, using current URI as target.");
return request.getRequestURI();
} else {
return target;
Modified: lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethUtil.java
URL: http://svn.apache.org/viewvc/lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethUtil.java?rev=603581&r1=603580&r2=603581&view=diff
==============================================================================
--- lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethUtil.java (original)
+++ lenya/branches/branch_1_2_x_shibboleth/src/java/org/apache/lenya/ac/shibboleth/ShibbolethUtil.java Wed Dec 12 04:02:06 2007
@@ -33,6 +33,9 @@
import org.apache.lenya.cms.publication.URLInformation;
import org.apache.lenya.util.ServletHelper;
+/**
+ * Utility class for Shibboleth-related operations.
+ */
public class ShibbolethUtil {
private ServiceManager manager;
@@ -42,8 +45,19 @@
}
/**
- * @return The base URL, either from the proxy or from the current request
- * if no proxy is declared for this area.
+ * <p>
+ * This method computes the base URL of the web application:
+ * </p>
+ * <ul>
+ * <li>
+ * If a proxy is declared for the current area, the URL of the proxy is returned.
+ * </li>
+ * <li>
+ * If no proxy is declared, <code>http://{host}[:{port}]</code> is returned. The port suffix is omitted
+ * for the ports 80 and 443.
+ * </li>
+ * </ul>
+ * @return A string.
*/
public String getBaseUrl() {
@@ -90,10 +104,18 @@
return baseUrl;
}
+ /**
+ * @param port The port.
+ * @return An empty string for the ports 80 and 443 and the string ":{port}" otherwise.
+ */
protected static String getPortSuffix(int port) {
return (port == 80 || port == 443) ? "" : ":" + port;
}
+ /**
+ * @param webappUrl A web application URL.
+ * @return If the URL is required to be requested using an SSL connection.
+ */
protected boolean isSslProtected(String webappUrl) {
DefaultAccessController accessController = null;
ServiceSelector selector = null;
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@lenya.apache.org
For additional commands, e-mail: commits-help@lenya.apache.org