[
https://issues.apache.org/jira/browse/KNOX-2712?focusedWorklogId=738903&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-738903
]
ASF GitHub Bot logged work on KNOX-2712:
----------------------------------------
Author: ASF GitHub Bot
Created on: 09/Mar/22 16:24
Start Date: 09/Mar/22 16:24
Worklog Time Spent: 10m
Work Description: pzampino commented on a change in pull request #542:
URL: https://github.com/apache/knox/pull/542#discussion_r822835650
##########
File path:
gateway-service-knoxtoken/src/main/java/org/apache/knox/gateway/service/knoxtoken/TokenResource.java
##########
@@ -405,11 +408,43 @@ public Response doPost() {
@GET
@Path(GET_USER_TOKENS)
@Produces({APPLICATION_JSON, APPLICATION_XML})
- public Response getUserTokens(@QueryParam("userName") String userName) {
+ public Response getUserTokens(@Context UriInfo uriInfo) {
if (tokenStateService == null) {
return Response.status(Response.Status.SERVICE_UNAVAILABLE).entity("{\n
\"error\": \"Token management is not configured\"\n}\n").build();
} else {
- final Collection<KnoxToken> tokens =
tokenStateService.getTokens(userName);
+ if (uriInfo == null) {
+ throw new IllegalArgumentException("URI info cannot be NULL.");
+ }
+ final Map<String, String> metadataMap = new HashMap<>();
+ uriInfo.getQueryParameters().entrySet().forEach(entry -> {
+ if (entry.getKey().startsWith(METADATA_QUERY_PARAM_PREFIX)) {
+ String metadataName =
entry.getKey().substring(METADATA_QUERY_PARAM_PREFIX.length());
+ metadataMap.put(metadataName, entry.getValue().get(0));
+ }
+ });
+
+ final String userName =
uriInfo.getQueryParameters().getFirst("userName");
+ final Collection<KnoxToken> userTokens =
tokenStateService.getTokens(userName);
+ final Collection<KnoxToken> tokens = new TreeSet<>();
+ if (metadataMap.isEmpty()) {
+ tokens.addAll(userTokens);
+ } else {
+ userTokens.forEach(knoxToken -> {
+ for (Map.Entry<String, String> entry : metadataMap.entrySet()) {
+ if (StringUtils.isBlank(entry.getValue()) ||
"*".equals(entry.getValue())) {
+ // we should only filter tokens by metadata name
+ if
(knoxToken.getMetadata().getMetadataMap().containsKey(entry.getKey())) {
Review comment:
Not necessarily related to this change, but it seems to me that
TokenMetadata could have a generic `get(String key)` method, rather than
requiring making a copy of the `metadataMap` every time a value is needed to be
looked up (`knoxToken.getMetadata().getMetadataMap()`).
`public String get(final String key) { return metadataMap.get(key); }`
Such that lookups could be more simply `knoxToken.getMetadata().get(key)`.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 738903)
Time Spent: 1h 20m (was: 1h 10m)
> Adding arbitrary metadata to a Knox Token
> -----------------------------------------
>
> Key: KNOX-2712
> URL: https://issues.apache.org/jira/browse/KNOX-2712
> Project: Apache Knox
> Issue Type: Improvement
> Components: Server
> Affects Versions: 1.6.0
> Reporter: Sandor Molnar
> Assignee: Sandor Molnar
> Priority: Critical
> Fix For: 2.0.0
>
> Time Spent: 1h 20m
> Remaining Estimate: 0h
>
> We would need to enhance our GET API to accept an arbitrary list of key/value
> pairs as Knox token metadata. At the time of this Jira is being created, the
> following hard-coded metadata exists for a Knox Token:
> * userName
> * comment
> * enabled
> * passcode
> The plan is to modify our TokenResource to accept query parameters starting
> with the ‘{{{}md_{}}}’ prefix and treat them as Knox Token Metadata. For
> instance:
> {noformat}
> curl -iku admin:admin-password -X GET
> 'https://localhost:8443/gateway/sandbox/knoxtoken/api/v1/token?md_notebookName=accountantKnoxToken&md_souldBeRemovedBy=31March2022&md_otherMeaningfuMetadata=KnoxIsCool'{noformat}
> When such a token is created by Knox, we should save the following metadata
> too:
> * {{notebookName=accountantKnoxToken}}
> * {{shouldBeRemovedBy=31March2022}}
> * {{otherMeaningfulMetadata=KnoxIsCool}}
> It’s not only Knox will be able to save these metadata, but we have to update
> our existing {{getUserTokens}} API endpoint to be able to fetch basic token
> information (see
> {{{}org.apache.knox.gateway.services.security.token.KnoxToken{}}}) using the
> supplied metadata name besides the user name information.
> For instance:
> {noformat}
> curl -iku admin:admin-password -X GET
> 'https://localhost:8443/gateway/sandbox/knoxtoken/api/v1/token/getUserTokens?userName=admin&mdName=notebookName&mdValue=accountantKnoxToken'{noformat}
> will return all Knox tokens where metadata with _‘notebookName’_ exists and
> equals {_}‘accountantKnoxToken’{_}.
> Finally, the Token Management page should display metadata too.
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
