Skip to content

Commit

Permalink
SECOAUTH-303: consolidate validation
Browse files Browse the repository at this point in the history 
Resulted in quite a large change to AuthorizationRequest (pulling
out an interface).  And the confirmation endpoint method signature
changes (no @ModelAttribute or else Spring tries to bind stuff to
the value in the session).
  • Loading branch information
@dsyer
dsyer committed Jul 18, 2012
1 parent bf369ca commit 6de2d85
Show file tree
Hide file tree
Showing 33 changed files with 507 additions and 376 deletions.
15 changes: 15 additions & 0 deletions .../main/java/org/springframework/security/oauth/examples/sparklr/impl/PhotoServiceImpl.java
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
/*
* Copyright 2002-2011 the original author or authors.
*
* 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.springframework.security.oauth.examples.sparklr.impl;

import org.springframework.security.core.context.SecurityContextHolder;
Expand Down
8 changes: 3 additions & 5 deletions ...org/springframework/security/oauth/examples/sparklr/mvc/AccessConfirmationController.java
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
package org.springframework.security.oauth.examples.sparklr.mvc;

import java.util.Map;
import java.util.TreeMap;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.oauth2.provider.AuthorizationRequest;
import org.springframework.security.oauth2.provider.ClientDetails;
import org.springframework.security.oauth2.provider.ClientDetailsService;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.SessionAttributes;
import org.springframework.web.servlet.ModelAndView;
Expand All @@ -19,15 +17,15 @@
* @author Ryan Heaton
*/
@Controller
@SessionAttributes(types = AuthorizationRequest.class)
@SessionAttributes("authorizationRequest")
public class AccessConfirmationController {

private ClientDetailsService clientDetailsService;

@RequestMapping("/oauth/confirm_access")
public ModelAndView getAccessConfirmation(@ModelAttribute AuthorizationRequest clientAuth) throws Exception {
public ModelAndView getAccessConfirmation(Map<String, Object> model) throws Exception {
AuthorizationRequest clientAuth = (AuthorizationRequest) model.remove("authorizationRequest");
ClientDetails client = clientDetailsService.loadClientByClientId(clientAuth.getClientId());
TreeMap<String, Object> model = new TreeMap<String, Object>();
model.put("auth_request", clientAuth);
model.put("client", client);
return new ModelAndView("access_confirmation", model);
Expand Down
2 changes: 1 addition & 1 deletion spring-security-oauth2/.springBeans
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<configSuffixes>
<configSuffix><![CDATA[xml]]></configSuffix>
</configSuffixes>
<enableImports><![CDATA[false]]></enableImports>
<enableImports><![CDATA[true]]></enableImports>
<configs>
<config>src/test/resources/org/springframework/security/oauth2/config/TestAuthorizationServerBeanDefinitionParser-context.xml</config>
<config>src/test/resources/org/springframework/security/oauth2/config/TestClientDetailsServiceBeanDefinitionParser-context.xml</config>
Expand Down
219 changes: 22 additions & 197 deletions ...uth2/src/main/java/org/springframework/security/oauth2/provider/AuthorizationRequest.java
View file
Original file line number Diff line number Diff line change
@@ -1,16 +1,10 @@
package org.springframework.security.oauth2.provider;

import java.io.Serializable;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.Map;
import java.util.Set;

import org.springframework.security.core.GrantedAuthority;
import org.springframework.security.oauth2.common.util.OAuth2Utils;

/**
* Base class representing a request for authorization. There are convenience methods for the well-known properties
Expand All @@ -20,209 +14,40 @@
* @author Dave Syer
* @author Amanda Anganes
*/
public class AuthorizationRequest implements Serializable {
public interface AuthorizationRequest {

private static final String CLIENT_ID = "client_id";
public static final String CLIENT_ID = "client_id";

private static final String STATE = "state";
public static final String STATE = "state";

private static final String SCOPE = "scope";
public static final String SCOPE = "scope";

private static final String REDIRECT_URI = "redirect_uri";
public static final String REDIRECT_URI = "redirect_uri";

private static final String RESPONSE_TYPE = "response_type";
public static final String RESPONSE_TYPE = "response_type";

private final Set<String> scope;
public static final String USER_OAUTH_APPROVAL = "user_oauth_approval";

private final Set<String> resourceIds;
public Map<String, String> getAuthorizationParameters();

public Map<String, String> getApprovalParameters();

private final boolean approved;
public String getClientId();

private final Collection<GrantedAuthority> authorities;
public Set<String> getScope();

private final Map<String, String> authorizationParameters = new HashMap<String, String>();
public Set<String> getResourceIds();

private final Map<String, String> approvalParameters = new HashMap<String, String>();
public Collection<GrantedAuthority> getAuthorities();

public static final String USER_OAUTH_APPROVAL = "user_oauth_approval";
public boolean isApproved();

public boolean isDenied();

public String getState();

public String getRedirectUri();

public AuthorizationRequest(Map<String, String> authorizationParameters) {
this(authorizationParameters, Collections.<String, String> emptyMap(), authorizationParameters.get(CLIENT_ID),
OAuth2Utils.parseParameterList(authorizationParameters.get("scope")), null, null, false);
// This is unapproved by default since only the authorizationParameters are available
for (String key : authorizationParameters.keySet()) {
if (key.equals(SCOPE)) {
this.authorizationParameters.put(SCOPE, OAuth2Utils.formatParameterList(scope));
}
else {
this.authorizationParameters.put(key, authorizationParameters.get(key));
}
}
}

public AuthorizationRequest(Map<String, String> authorizationParameters, Map<String, String> approvalParameters,
String clientId, Collection<String> scope) {
this(authorizationParameters, approvalParameters, clientId, scope, null, null, false);
}

public AuthorizationRequest(String clientId, Collection<String> scope) {
this(null, null, clientId, scope, null, null, false);
}

private AuthorizationRequest(AuthorizationRequest copy, boolean approved) {
this(copy.authorizationParameters, copy.approvalParameters, copy.getClientId(), copy.scope, copy.authorities,
copy.resourceIds, approved);
if (!scope.isEmpty()) {
this.authorizationParameters.put(SCOPE, OAuth2Utils.formatParameterList(scope));
}
}

private AuthorizationRequest(AuthorizationRequest copy, Map<String, String> userConsentParameters) {
this(copy.authorizationParameters, userConsentParameters, copy.getClientId(), copy.scope, copy.authorities,
copy.resourceIds, copy.approved);
if (!scope.isEmpty()) {
this.authorizationParameters.put(SCOPE, OAuth2Utils.formatParameterList(scope));
}
}

private AuthorizationRequest(Map<String, String> authorizationParameters, Map<String, String> approvalParameters,
String clientId, Collection<String> scope, Collection<GrantedAuthority> authorities,
Collection<String> resourceIds, boolean approved) {
if (authorizationParameters != null) {
this.authorizationParameters.putAll(authorizationParameters);
}
if (approvalParameters != null) {
this.approvalParameters.putAll(approvalParameters);
}
this.resourceIds = resourceIds == null ? Collections.<String> emptySet() : new HashSet<String>(resourceIds);
this.scope = scope == null ? Collections.<String> emptySet() : new LinkedHashSet<String>(scope);
this.authorities = authorities == null ? Collections.<GrantedAuthority> emptySet()
: new HashSet<GrantedAuthority>(authorities);
this.authorizationParameters.put(CLIENT_ID, clientId);
this.authorizationParameters.put(SCOPE, OAuth2Utils.formatParameterList(scope));
this.approved = approved;
}

public Map<String, String> getAuthorizationParameters() {
return Collections.unmodifiableMap(authorizationParameters);
}

public AuthorizationRequest addApprovalParameters(Map<String, String> parameters) {
return parameters == null ? this : new AuthorizationRequest(this, parameters);
}

public Map<String, String> getApprovalParameters() {
return Collections.unmodifiableMap(approvalParameters);
}

public String getClientId() {
return authorizationParameters.get(CLIENT_ID);
}

public Set<String> getScope() {
return this.scope;
}

public Set<String> getResourceIds() {
return Collections.unmodifiableSet(resourceIds);
}

public Collection<GrantedAuthority> getAuthorities() {
return Collections.unmodifiableSet((Set<? extends GrantedAuthority>) authorities);
}

public boolean isApproved() {
return approved;
}

public boolean isDenied() {
return !approved;
}

public String getState() {
return authorizationParameters.get(STATE);
}

public String getRedirectUri() {
return authorizationParameters.get(REDIRECT_URI);
}

public Set<String> getResponseTypes() {
return OAuth2Utils.parseParameterList(authorizationParameters.get(RESPONSE_TYPE));
}

public AuthorizationRequest approved(boolean approved) {
return new AuthorizationRequest(this, approved);
}

public AuthorizationRequest resolveRedirectUri(String redirectUri) {
AuthorizationRequest result = new AuthorizationRequest(this, approved);
result.authorizationParameters.put(REDIRECT_URI, redirectUri);
return result;
}

public AuthorizationRequest addClientDetails(ClientDetails clientDetails) {
AuthorizationRequest result = new AuthorizationRequest(this, approved);
result.resourceIds.addAll(clientDetails.getResourceIds());
result.authorities.addAll(clientDetails.getAuthorities());
return result;
}

@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((authorities == null) ? 0 : authorities.hashCode());
result = prime * result + (approved ? 1231 : 1237);
result = prime * result + ((authorizationParameters == null) ? 0 : authorizationParameters.hashCode());
result = prime * result + ((approvalParameters == null) ? 0 : approvalParameters.hashCode());
result = prime * result + ((resourceIds == null) ? 0 : resourceIds.hashCode());
result = prime * result + ((scope == null) ? 0 : scope.hashCode());
return result;
}

@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
AuthorizationRequest other = (AuthorizationRequest) obj;
if (authorities == null) {
if (other.authorities != null)
return false;
}
else if (!authorities.equals(other.authorities))
return false;
if (approved != other.approved)
return false;
if (authorizationParameters == null) {
if (other.authorizationParameters != null)
return false;
}
else if (!authorizationParameters.equals(other.authorizationParameters))
return false;
if (resourceIds == null) {
if (other.resourceIds != null)
return false;
}
else if (!resourceIds.equals(other.resourceIds))
return false;
if (scope == null) {
if (other.scope != null)
return false;
}
else if (!scope.equals(other.scope))
return false;
if (approvalParameters == null) {
if (other.approvalParameters != null)
return false;
}
else if (!approvalParameters.equals(other.approvalParameters))
return false;
return true;
}
public Set<String> getResponseTypes();

}
Loading

0 comments on commit 6de2d85

Please sign in to comment.