-
Notifications
You must be signed in to change notification settings - Fork 252
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
KNOX-2974 - Add a new endpoint 'extauthz' similar to pre that accepts…
… HTTP verbs other than GET and if confgiured ignores additional context path params (#813)
- Loading branch information
1 parent
7a5189a
commit 8e55969
Showing
5 changed files
with
492 additions
and
83 deletions.
There are no files selected for viewing
120 changes: 120 additions & 0 deletions
120
...service-auth/src/main/java/org/apache/knox/gateway/service/auth/AbstractAuthResource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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.apache.knox.gateway.service.auth; | ||
|
|
||
| import org.apache.knox.gateway.i18n.messages.MessagesFactory; | ||
| import org.apache.knox.gateway.security.SubjectUtils; | ||
|
|
||
| import javax.security.auth.Subject; | ||
| import javax.servlet.ServletContext; | ||
| import javax.servlet.http.HttpServletResponse; | ||
| import javax.ws.rs.core.Response; | ||
| import java.util.ArrayList; | ||
| import java.util.Collection; | ||
| import java.util.Collections; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
| import java.util.Set; | ||
| import java.util.regex.Pattern; | ||
| import java.util.stream.Collectors; | ||
|
|
||
| import static javax.ws.rs.core.Response.ok; | ||
| import static javax.ws.rs.core.Response.status; | ||
|
|
||
| public abstract class AbstractAuthResource { | ||
| public static final String AUTH_ACTOR_ID_HEADER_NAME = "preauth.auth.header.actor.id.name"; | ||
| public static final String AUTH_ACTOR_GROUPS_HEADER_PREFIX = "preauth.auth.header.actor.groups.prefix"; | ||
| public static final String GROUP_FILTER_PATTERN = "preauth.group.filter.pattern"; | ||
|
|
||
| static final AuthMessages LOG = MessagesFactory.get(AuthMessages.class); | ||
|
|
||
| static final String DEFAULT_AUTH_ACTOR_ID_HEADER_NAME = "X-Knox-Actor-ID"; | ||
| static final String DEFAULT_AUTH_ACTOR_GROUPS_HEADER_PREFIX = "X-Knox-Actor-Groups"; | ||
| static final Pattern DEFAULT_GROUP_FILTER_PATTERN = Pattern.compile(".*"); | ||
|
|
||
| protected static final int MAX_HEADER_LENGTH = 1000; | ||
| protected static final String ACTOR_GROUPS_HEADER_FORMAT = "%s-%d"; | ||
|
|
||
| protected String authHeaderActorIDName; | ||
| protected String authHeaderActorGroupsPrefix; | ||
| protected Pattern groupFilterPattern; | ||
|
|
||
| protected void initialize() { | ||
| authHeaderActorIDName = getInitParameter(AUTH_ACTOR_ID_HEADER_NAME, DEFAULT_AUTH_ACTOR_ID_HEADER_NAME); | ||
| authHeaderActorGroupsPrefix = getInitParameter(AUTH_ACTOR_GROUPS_HEADER_PREFIX, DEFAULT_AUTH_ACTOR_GROUPS_HEADER_PREFIX); | ||
| final String groupFilterPatternString = getInitParameter(GROUP_FILTER_PATTERN, null); | ||
| groupFilterPattern = groupFilterPatternString == null ? DEFAULT_GROUP_FILTER_PATTERN : Pattern.compile(groupFilterPatternString); | ||
| } | ||
|
|
||
| /* abstract method to get the response instance */ | ||
| abstract HttpServletResponse getResponse(); | ||
|
|
||
| /* Abstract method that gets context instance */ | ||
| abstract ServletContext getContext(); | ||
|
|
||
| String getInitParameter(String paramName, String defaultValue) { | ||
| final String initParam = getContext().getInitParameter(paramName); | ||
| return initParam == null ? defaultValue : initParam; | ||
| } | ||
|
|
||
| public Response doGetImpl() { | ||
| final Subject subject = SubjectUtils.getCurrentSubject(); | ||
|
|
||
| final String primaryPrincipalName = subject == null ? null : SubjectUtils.getPrimaryPrincipalName(subject); | ||
| if (primaryPrincipalName == null) { | ||
| LOG.noPrincipalFound(); | ||
| return status(HttpServletResponse.SC_UNAUTHORIZED).build(); | ||
| } | ||
| getResponse().setHeader(authHeaderActorIDName, primaryPrincipalName); | ||
|
|
||
| // Populate actor groups headers | ||
| final Set<String> matchingGroupNames = subject == null ? Collections.emptySet() | ||
| : SubjectUtils.getGroupPrincipals(subject).stream().filter(group -> groupFilterPattern.matcher(group.getName()).matches()).map(group -> group.getName()) | ||
| .collect(Collectors.toSet()); | ||
| if (!matchingGroupNames.isEmpty()) { | ||
| final List<String> groupStrings = getGroupStrings(matchingGroupNames); | ||
| for (int i = 0; i < groupStrings.size(); i++) { | ||
| getResponse().addHeader(String.format(Locale.ROOT, ACTOR_GROUPS_HEADER_FORMAT, authHeaderActorGroupsPrefix, i + 1), groupStrings.get(i)); | ||
| } | ||
| } | ||
| return ok().build(); | ||
| } | ||
|
|
||
| private List<String> getGroupStrings(Collection<String> groupNames) { | ||
| if (groupNames.isEmpty()) { | ||
| return Collections.emptyList(); | ||
| } | ||
| List<String> groupStrings = new ArrayList<>(); | ||
| StringBuilder sb = new StringBuilder(); | ||
| for (String groupName : groupNames) { | ||
| if (sb.length() + groupName.length() > MAX_HEADER_LENGTH) { | ||
| groupStrings.add(sb.toString()); | ||
| sb = new StringBuilder(); | ||
| } | ||
| if (sb.length() > 0) { | ||
| sb.append(','); | ||
| } | ||
| sb.append(groupName); | ||
| } | ||
| if (sb.length() > 0) { | ||
| groupStrings.add(sb.toString()); | ||
| } | ||
| return groupStrings; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
143 changes: 143 additions & 0 deletions
143
...way-service-auth/src/main/java/org/apache/knox/gateway/service/auth/ExtAuthzResource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,143 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you 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.apache.knox.gateway.service.auth; | ||
|
|
||
| import javax.annotation.PostConstruct; | ||
| import javax.servlet.ServletContext; | ||
| import javax.servlet.http.HttpServletResponse; | ||
| import javax.ws.rs.DELETE; | ||
| import javax.ws.rs.GET; | ||
| import javax.ws.rs.HEAD; | ||
| import javax.ws.rs.OPTIONS; | ||
| import javax.ws.rs.POST; | ||
| import javax.ws.rs.PUT; | ||
| import javax.ws.rs.Path; | ||
| import javax.ws.rs.core.Context; | ||
| import javax.ws.rs.core.Response; | ||
| import javax.ws.rs.core.UriInfo; | ||
|
|
||
| @Path(ExtAuthzResource.RESOURCE_PATH) | ||
| public class ExtAuthzResource extends AbstractAuthResource { | ||
| static final String RESOURCE_PATH = "auth/api/v1/extauthz"; | ||
| static final String IGNORE_ADDITIONAL_PATH = "ignore.additional.path"; | ||
| static final String DEFAULT_IGNORE_ADDITIONAL_PATH = "false"; | ||
|
|
||
| private boolean ignoreAdditionalPath; | ||
|
|
||
| @Context | ||
| HttpServletResponse response; | ||
|
|
||
| @Context | ||
| ServletContext context; | ||
|
|
||
| @PostConstruct | ||
| public void init() { | ||
| initialize(); | ||
| ignoreAdditionalPath = Boolean.parseBoolean(getInitParameter(IGNORE_ADDITIONAL_PATH, DEFAULT_IGNORE_ADDITIONAL_PATH)); | ||
| } | ||
|
|
||
| @Override | ||
| HttpServletResponse getResponse() { | ||
| return response; | ||
| } | ||
|
|
||
| @Override | ||
| ServletContext getContext() { | ||
| return context; | ||
| } | ||
|
|
||
| /* | ||
| Enable all the http verbs, | ||
| wish there was a way to specify multiple paths on the same method | ||
| */ | ||
| @GET | ||
| public Response doGet() { | ||
| return doGetImpl(); | ||
| } | ||
|
|
||
| @POST | ||
| public Response doPostWithRootPath() { | ||
| return doGetImpl(); | ||
| } | ||
|
|
||
| @PUT | ||
| public Response doPutWithRootPath() { | ||
| return doGetImpl(); | ||
| } | ||
|
|
||
| @DELETE | ||
| public Response doDeleteWithRootPath() { | ||
| return doGetImpl(); | ||
| } | ||
|
|
||
| @HEAD | ||
| public Response doHeadWithPath() { | ||
| return doGetImpl(); | ||
| } | ||
|
|
||
| @OPTIONS | ||
| public Response doOptionsWithPath() { | ||
| return doGetImpl(); | ||
| } | ||
|
|
||
| /* | ||
| * This method will handle additional paths. | ||
| * Currently, if there are any additional paths they are ignored. | ||
| */ | ||
| @Path("{subResources:.*}") | ||
| @GET | ||
| public Response doGetWithPath(@Context UriInfo ui) { | ||
| if(ignoreAdditionalPath) { | ||
| LOG.pathValue(ui.getPath()); | ||
| return doGet(); | ||
| } else { | ||
| return Response.status(Response.Status.NOT_FOUND).build(); | ||
| } | ||
| } | ||
|
|
||
| @Path("{subResources:.*}") | ||
| @POST | ||
| public Response doPostWithPath(@Context UriInfo ui) { | ||
| return doGetWithPath(ui); | ||
| } | ||
|
|
||
| @Path("{subResources: .*}") | ||
| @PUT | ||
| public Response doPutWithPath(@Context UriInfo ui) { | ||
| return doGetWithPath(ui); | ||
| } | ||
|
|
||
| @Path("{subResources: .*}") | ||
| @DELETE | ||
| public Response doDeleteWithPath(@Context UriInfo ui) { | ||
| return doGetWithPath(ui); | ||
| } | ||
|
|
||
| @Path("{subResources: .*}") | ||
| @HEAD | ||
| public Response doHeadWithPath(@Context UriInfo ui) { | ||
| return doGetWithPath(ui); | ||
| } | ||
|
|
||
| @Path("{subResources: .*}") | ||
| @OPTIONS | ||
| public Response doOptionsWithPath(@Context UriInfo ui) { | ||
| return doGetWithPath(ui); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.