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-30259 Use secrets for dafilesrv client connections #17821

Merged
merged 1 commit into from
Sep 28, 2023
Merged

HPCC-30259 Use secrets for dafilesrv client connections #17821

merged 1 commit into from
Sep 28, 2023

Conversation

jakesmith
Copy link
Member

@jakesmith jakesmith commented Sep 26, 2023 •
edited
Loading

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:

jakesmith
jakesmith commented Sep 26, 2023
View reviewed changes
fs/dafsclient/rmtclient.cpp
ssock.setown(createSecureSocket(socket.getClear(), nullptr));
// instead of creating CRemoteFile/CRemoteBase with a secret, it could instead lookup, and create the ISecureSocketContext and pass that
// into the ctor. That would avoid having to look the secret up, extract the certs and recreate the context on each connection.
// The context would be 'owned' by the hook, and would expire when the mappings are removed (when removeMappedDafileSrvSecrets is called).
Copy link
Member Author

Choose a reason for hiding this comment

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

NB: @ghalliday @mckellyln - in a subsequent PR I will be refactoring the below so that it uses the new ISecret interface and caching the security contexts

@github-actions
Copy link

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

ghalliday
ghalliday approved these changes Sep 27, 2023
View reviewed changes
Copy link
Member

@ghalliday ghalliday left a comment

Choose a reason for hiding this comment

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

@jakesmith a couple of minor bits of code to delete.
Would make sense to delete them, but would merge as-is.
I suspect the code will be much simpler if it unconditionally checks for secrets...

dali/base/dafdesc.cpp
for (auto &dafileSrvEp: dafileSrvEndpoints)
queryDaFileSrvHook()->addSecretUrl(dafileSrvEp.c_str());
}
void removeMappedDafileSrvSecrets()
Copy link
Member

Choose a reason for hiding this comment

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

As discussed - it may be simpler to avoid this code and always search for a secret, but for a follow up PR.

fs/dafsclient/rmtclient.cpp Outdated
@@ -969,6 +992,10 @@ CRemoteBase::CRemoteBase(const SocketEndpoint &_ep, const char * _filename)
: filename(_filename)
{
ep = _ep;

StringBuffer endpointStr;
Copy link
Member

Choose a reason for hiding this comment

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

Unsued afaics

fs/dafsclient/rmtfile.cpp Outdated
@@ -244,6 +247,16 @@ class CDaliServixIntercept: public CInterface, implements IDaFileSrvHook
virtual IFile * createIFile(const RemoteFilename & filename)
{
SocketEndpoint ep = filename.queryEndpoint();

StringBuffer endpointStr;
Copy link
Member

Choose a reason for hiding this comment

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

Unused afaics

@jakesmith
Copy link
Member Author

@jakesmith a couple of minor bits of code to delete. Would make sense to delete them, but would merge as-is. I suspect the code will be much simpler if it unconditionally checks for secrets...

@ghalliday - 2nd commit removes the unused code you spotted.
I'ved open a new JIRA re. refactoring: https://track.hpccsystems.com/browse/HPCC-30372

@jakesmith jakesmith requested a review from ghalliday September 27, 2023 10:57
@jakesmith jakesmith force-pushed the HPCC-30259-dafilesrv-secrets branch from e86fa42 to 637050c Compare September 27, 2023 10:57
mckellyln
mckellyln reviewed Sep 27, 2023
View reviewed changes
fs/dafsclient/rmtclient.cpp
bool doConnect = true;
if (connectMethod == SSLFirst || connectMethod == UnsecureFirst)
if (storageSecret)
connectSocket(tep, 0, INFINITE, true);
Copy link
Contributor

Choose a reason for hiding this comment

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

Should timeout be INFINITE or 0 (to use configured default) ?

Copy link
Member Author

Choose a reason for hiding this comment

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

timeout is 0.
retries is INFINITE.

    void connectSocket(SocketEndpoint &ep, unsigned connectTimeoutMs=0, unsigned connectRetries=INFINITE, bool secure=false);

Same as defaults, just explicit now.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok, sorry I read the args wrong.

mckellyln
mckellyln reviewed Sep 27, 2023
View reviewed changes
Copy link
Contributor

@mckellyln mckellyln left a comment

Choose a reason for hiding this comment

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

Looks good, just one question about setting timeout to INFINITE instead of 0 in two locations.

@jakesmith
Copy link
Member Author

Looks good, just one question about setting timeout to INFINITE instead of 0 in two locations.

@mckellyln - please see reply, It should be the same as before connectTimeoutMs=0, connectRetries=INFINITE - same as defaults, as before, just explicit.

@jakesmith jakesmith requested a review from mckellyln September 27, 2023 18:02
mckellyln
mckellyln approved these changes Sep 28, 2023
View reviewed changes
Copy link
Contributor

@mckellyln mckellyln left a comment

Choose a reason for hiding this comment

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

Approved

@ghalliday ghalliday merged commit 2c10656 into hpcc-systems:candidate-9.4.x Sep 28, 2023
47 of 49 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mckellyln mckellyln mckellyln approved these changes

@ghalliday ghalliday ghalliday 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.
3 participants
@jakesmith @ghalliday @mckellyln