Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

HPCC-30111 Look up internal file scope name instead of using a hardcoded value #17684

Merged
merged 1 commit into from
Aug 23, 2023
Merged

HPCC-30111 Look up internal file scope name instead of using a hardcoded value #17684

merged 1 commit into from
Aug 23, 2023

Conversation

dcamper
Copy link
Contributor

@dcamper dcamper commented Aug 16, 2023

Previously, "hpccinternal::" was hardcoded.

Type of change:

  • This change is a bug fix (non-breaking change which fixes an issue).
  • This change is a new feature (non-breaking change which adds functionality).
  • This change improves the code (refactor or other change that does not change the functionality)
  • This change fixes warnings (the fix does not alter the functionality or the generated code)
  • This change is a breaking change (fix or feature that will cause existing behavior to change).
  • This change alters the query API (existing queries will have to be recompiled)

Checklist:

  • My code follows the code style of this project.
    • My code does not create any new warnings from compiler, build system, or lint.
  • The commit message is properly formatted and free of typos.
    • The commit message title makes sense in a changelog, by itself.
    • The commit is signed.
  • My change requires a change to the documentation.
    • I have updated the documentation accordingly, or...
    • I have created a JIRA ticket to update the documentation.
    • Any new interfaces or exported functions are appropriately commented.
  • I have read the CONTRIBUTORS document.
  • The change has been fully tested:
    • I have added tests to cover my changes.
    • All new and existing tests passed.
    • I have checked that this change does not introduce memory leaks.
    • I have used Valgrind or similar tools to check for potential issues.
  • I have given due consideration to all of the following potential concerns:
    • Scalability
    • Performance
    • Security
    • Thread-safety
    • Cloud-compatibility
    • Premature optimization
    • Existing deployed queries will not be broken
    • This change fixes the problem, not just the symptom
    • The target branch of this pull request is appropriate for such a change.
  • There are no similar instances of the same problem that should be addressed
    • I have addressed them here
    • I have raised JIRA issues to address them separately
  • This is a user interface / front-end modification
    • I have tested my changes in multiple modern browsers
    • The component(s) render as expected

Smoketest:

  • Send notifications about my Pull Request position in Smoketest queue.
  • Test my draft Pull Request.

Testing:

@github-actions
Copy link

https://track.hpccsystems.com/browse/HPCC-30111
Jira updated

RussWhitehead
RussWhitehead requested changes Aug 16, 2023
View reviewed changes
system/security/plugins/jwtSecurity/jwtSecurity.cpp Outdated
@@ -795,9 +802,9 @@ class CJwtSecurityManager : implements IDaliLdapConnection, public CBaseSecurity
// Scope hpccinternal::<username> always has full access for their own scope, but
// explicitly denied when attempting to access someone else's
// hpccinternal::<username> scope
if (resourceName && strncmp(resourceName, "hpccinternal::", 14) == 0)
if (strisame(resourceName, hpccInternalScope.c_str()))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this will always return false, since the strings are not the same . Consider using something like

if (startsWithIgnoreCase(resourceName, hpccInternalScope.c_str()))

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix. Now I'm wondering about my test harness....

system/security/plugins/jwtSecurity/jwtSecurity.cpp Outdated
{
if (strisame(&resourceName[14], user.getName()))
if (strisame(&resourceName[hpccInternalScope.length()], user.getName()))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above, note how LDAPSecurityManager does it by extracting the name from the filescope

    StringBuffer userName;
    for (const char * p = &filescope[m_hpccInternalScope.length()]; *p && *p != ':'; p++)//extract scope username
        userName.append(*p);
    if(strieq(userName.str(), user.getName()))
        return SecAccess_Full;
    PROGLOG("Access denied to scope %s for user %s", filescope, user.getName());
    return SecAccess_None;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which begs the question, how did it work (or did it?) before ? unless the resourceName string always terminates after the username??

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The resource name did, in fact, terminate immediately after the username. IIRC from testing the original code, I never saw any "deeper" file scope passed in here. That said, I will revisit and retest once I debug my test setup.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I need to find whatever drugs I was on back then and make sure I never take them again.

Testing this morning showed that Russ was right and the code was wrong. It is difficult to see how it ever worked.

I've made the changes Russ suggested and have verified that big jobs that use hpccinternal scopes work.

jakesmith
jakesmith reviewed Aug 17, 2023
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dcamper - a couple of comments

system/security/plugins/jwtSecurity/jwtSecurity.cpp Outdated

// Grab a copy of the name of the internal file scope
hpccInternalScope = queryDfsXmlBranchName(DXB_Internal);
if (!hpccInternalScope.empty())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

minor: since queryDfsXmlBranchName cannot return empty, I think this conditional makes the code less clear (it implies that that queryDfsXmlBranchName(DXB_Internal) might return empty).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed, as well as the bonehead no-op within the if() block.

system/security/plugins/jwtSecurity/jwtSecurity.cpp Outdated
{
if (strisame(&resourceName[14], user.getName()))
if (strisame(&resourceName[hpccInternalScope.length()], user.getName()))
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which begs the question, how did it work (or did it?) before ? unless the resourceName string always terminates after the username??

@dcamper
Copy link
Contributor Author

dcamper commented Aug 17, 2023

Russ and Jake, please review the changes. Thanks!

jakesmith
jakesmith reviewed Aug 17, 2023
View reviewed changes
Copy link
Member

@jakesmith jakesmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dcamper - looks good.

@RussWhitehead
Copy link
Member

@dcamper Looks good to me

@dcamper
HPCC-30111 Look up internal file scope name
e9d94de 
Previously, "hpccinternal::" was hardcoded.

Signed-off-by: Dan S. Camper <[email protected]>
@dcamper dcamper force-pushed the hpcc-30111-jwt-hpccinternal branch from c9836a5 to e9d94de Compare August 17, 2023 14:45
@dcamper
Copy link
Contributor Author

dcamper commented Aug 17, 2023

Commits squashed. @ghalliday please merge. Thanks!

@ghalliday ghalliday merged commit a64416a into hpcc-systems:candidate-9.2.x Aug 23, 2023
49 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jakesmith jakesmith jakesmith approved these changes

@RussWhitehead RussWhitehead RussWhitehead approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dcamper @RussWhitehead @jakesmith @ghalliday