SNOW-715504: MFA token cache support #988

sfc-gh-jmartinezramirez · 2024-07-04T14:53:26Z

Description

Added support for MFA token cache.

Checklist

Code compiles correctly
Code is formatted according to Coding Conventions
Created tests which fail without the change (if possible)
All tests passing (dotnet test)
Extended the README / documentation, if necessary
Provide JIRA issue id (if possible) or GitHub issue id in PR name

codecov · 2024-07-09T22:23:37Z

Codecov Report

Attention: Patch coverage is 91.51376% with 37 lines in your changes missing coverage. Please review.

Project coverage is 86.27%. Comparing base (6b1114a) to head (25215c3).

Files with missing lines	Patch %	Lines
Snowflake.Data/Core/Session/SFSession.cs	78.94%	6 Missing and 2 partials ⚠️
...e.Data/Client/SnowflakeCredentialManagerFactory.cs	89.09%	3 Missing and 3 partials ⚠️
Snowflake.Data/Core/Tools/UnixOperations.cs	71.42%	3 Missing and 3 partials ⚠️
...astructure/SFCredentialManagerWindowsNativeImpl.cs	92.72%	2 Missing and 2 partials ⚠️
Snowflake.Data/Core/Session/SessionPool.cs	92.00%	0 Missing and 4 partials ⚠️
...ager/Infrastructure/SFCredentialManagerFileImpl.cs	97.75%	0 Missing and 2 partials ⚠️
Snowflake.Data/Core/Tools/StringUtils.cs	75.00%	1 Missing and 1 partial ⚠️
...Core/Authenticator/ExternalBrowserAuthenticator.cs	0.00%	1 Missing ⚠️
...nowflake.Data/Core/Authenticator/IAuthenticator.cs	95.83%	0 Missing and 1 partial ⚠️
...ke.Data/Core/Authenticator/KeyPairAuthenticator.cs	0.00%	1 Missing ⚠️
... and 2 more

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #988      +/-   ##
==========================================
+ Coverage   86.11%   86.27%   +0.15%     
==========================================
  Files         120      126       +6     
  Lines       11627    12027     +400     
  Branches     1165     1215      +50     
==========================================
+ Hits        10013    10376     +363     
- Misses       1332     1349      +17     
- Partials      282      302      +20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Snowflake.Data/Core/CredentialManager/Infrastructure/SFCredentialManagerWindowsNativeImpl.cs

Snowflake.Data/Core/Authenticator/IAuthenticator.cs

sfc-gh-knozderko · 2024-07-29T13:45:22Z

Snowflake.Data/Core/Authenticator/IAuthenticator.cs

@@ -116,13 +134,19 @@ private SFRestRequest BuildLoginRequest()
            {
                loginName = session.properties[SFSessionProperty.USER],
                accountName = session.properties[SFSessionProperty.ACCOUNT],
+                // TODO LOCAL TEST MFA temp change should be removed before merge


why would we need to pretend to be a jdbc driver?

This was only for testing it should use .NET before complete the PR

Why can't we just test as .net driver? Is there any particular reason to pretend to be a jdbc driver?
Anyway we need to remove it before merging the PR.

Yes, we will do it before merging

Snowflake.Data/Core/Authenticator/MFACacheAuthenticator.cs

Snowflake.Data/Core/Session/SessionPool.cs

Snowflake.Data/Client/SFCredentialManagerFactory.cs

Snowflake.Data/Core/CredentialManager/Infrastructure/SFCredentialManagerFileImpl.cs

Snowflake.Data/Core/CredentialManager/Infrastructure/SFCredentialManagerWindowsNativeImpl.cs

Snowflake.Data/Core/Session/ConnectionCacheManager.cs

Snowflake.Data/Core/Session/ConnectionPoolManager.cs

Snowflake.Data/Core/Session/SessionPool.cs

Snowflake.Data/Core/Session/SFSession.cs

Snowflake.Data/Core/Tools/StringUtils.cs

Snowflake.Data.Tests/UnitTests/CredentialManager/SFCredentialManagerTest.cs

Snowflake.Data.Tests/UnitTests/SFSessionTest.cs

Snowflake.Data/Core/CredentialManager/Infrastructure/SFCredentialManagerFileImpl.cs

Snowflake.Data/Client/SnowflakeCredentialManagerFactory.cs

Snowflake.Data/Core/Session/SessionPool.cs

Snowflake.Data/Core/Tools/UnixOperations.cs

Snowflake.Data/Core/SFError.cs

Snowflake.Data.Tests/IntegrationTests/SFConnectionIT.cs

Snowflake.Data/Core/Session/SFSessionProperty.cs

Snowflake.Data/Core/CredentialManager/Infrastructure/SFCredentialManagerFileImpl.cs

Snowflake.Data/Core/Session/SessionPool.cs

Snowflake.Data/Client/SFCredentialManagerFactory.cs

Snowflake.Data/Core/Session/SessionPool.cs

Snowflake.Data/Client/SnowflakeCredentialManagerFactory.cs

Snowflake.Data.Tests/IntegrationTests/SFConnectionIT.cs

Snowflake.Data/Core/Tools/StringUtils.cs

…word_mfa authenticator. Added mechanism to disable or throw an error if using a different authenticator using passcode in connection.

… methods

…ection string without username_password_authentication an exception will be thrown to indicate the user that the passcode should not be used if pooling is enabled or with a minimum pool size greater than 0. Additionally, if the passcode is provided by an argument and not part of the connection string, it will not be used for the session created by the session pool, and the push MFA mechanism will be triggered.

(cherry picked from commit ac28924)

…n is expired or invalid. Multi-factor authentication (MFA) will try to use the passcode from the connection string if available; otherwise, send a Duo push notification to try to authenticate again; if it fails, the token will be removed.

…ional comments

sfc-gh-knozderko · 2024-10-25T15:58:06Z

Snowflake.Data/Core/Authenticator/MFACacheAuthenticator.cs

+            // Only need to add the password to Data for basic authentication
+            data.password = session.properties[SFSessionProperty.PASSWORD];
+            data.SessionParameters[SFSessionParameter.CLIENT_REQUEST_MFA_TOKEN] = true;
+            data.HttpTimeout = TimeSpan.FromSeconds(60);


we could have 60 on a const class field

sfc-gh-knozderko · 2024-10-25T15:59:30Z

Snowflake.Data/Core/Authenticator/IAuthenticator.cs

            SetSpecializedAuthenticatorData(ref data);

-            return session.BuildTimeoutRestRequest(loginUrl, new LoginRequest() { data = data });
+            return data.HttpTimeout.HasValue ? session.BuildTimeoutRestRequest(loginUrl, new LoginRequest() { data = data }, data.HttpTimeout.Value) : session.BuildTimeoutRestRequest(loginUrl, new LoginRequest() { data = data });


we could break this line before ? and : because it is pretty long line

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch 5 times, most recently from 6eba99f to 69d80c7 Compare July 5, 2024 21:54

sfc-gh-jmartinezramirez changed the title ~~Snow 715504 mfa token cache~~ SNOW-715504: MFA token cache support Jul 8, 2024

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch from a8dff4b to 67089fc Compare July 22, 2024 21:36

sfc-gh-knozderko requested changes Jul 29, 2024

View reviewed changes

sfc-gh-knozderko reviewed Sep 3, 2024

View reviewed changes

Snowflake.Data/Core/Session/SessionPool.cs Outdated Show resolved Hide resolved

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch 4 times, most recently from 6af9d1a to e36f8ed Compare September 4, 2024 13:31

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch 2 times, most recently from e795b5f to 9316bbc Compare September 18, 2024 23:08

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch from 9316bbc to 43adef9 Compare October 3, 2024 21:15

sfc-gh-jmartinezramirez marked this pull request as ready for review October 4, 2024 02:42

sfc-gh-jmartinezramirez requested a review from a team as a code owner October 4, 2024 02:42

sfc-gh-knozderko requested changes Oct 8, 2024

View reviewed changes

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch from 3894dae to b1ec82b Compare October 8, 2024 16:20

sfc-gh-knozderko requested changes Oct 9, 2024

View reviewed changes

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch from 0be7aa9 to ce1b619 Compare October 9, 2024 22:49

sfc-gh-knozderko requested changes Oct 17, 2024

View reviewed changes

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch 3 times, most recently from 5d32b9c to be6f19d Compare October 19, 2024 03:51

sfc-gh-knozderko requested changes Oct 22, 2024

View reviewed changes

sfc-gh-knozderko reviewed Oct 22, 2024

View reviewed changes

Snowflake.Data/Core/Tools/StringUtils.cs Outdated Show resolved Hide resolved

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch from a9cec2f to 10f124b Compare October 22, 2024 21:00

sfc-gh-jmartinezramirez and others added 25 commits October 25, 2024 08:33

temp workaround for login request with appid and app version

e27cbc1

Added mechanism to handle connection pooling when using username_pass…

175e5b7

…word_mfa authenticator. Added mechanism to disable or throw an error if using a different authenticator using passcode in connection.

Added hash encode for credential manager keys using sha256

64fa814

Changed passcode to be an optional argument in ParseConnectionString

66a602f

Changed passcode to be an optional argument in connection and session…

30ad120

… methods

Remove changes related to sso token cache implementation

1563834

Applying suggestions

071bf1f

Removed additional sso token cache code related

10391e1

Fix testing

6f3705d

Comment out workaround to test MFA

b0d9fbf

Additional fixes for test

c8d37ed

Improve logic to validate if passcode is used with mfaAuthenticator,

1dc2509

Fixed ambiguous constructor issue in mock

0be66d1

Fixed mismatch credential exception message

a62a30b

Applying PR suggestions

c4f049b

some refactor

cfb8a10

(cherry picked from commit ac28924)

Applying PR suggestions

fb1c104

Fixed test for mfa

7224e65

Fix connection pool renamed method.

9c8e841

Applying PR suggestions

711a7c0

Applying new PR suggestions

45f0fa6

Applying PR suggestions

a806406

Added property to LoginRequestData to specify httpRequest timeout.

d84508b

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch from 547bdde to 0767328 Compare October 25, 2024 14:34

Apply suggestion to SnowflakeCredentialManagerFactory and other addit…

d755d02

…ional comments

sfc-gh-jmartinezramirez force-pushed the SNOW-715504-MFA-Token-Cache branch from 0767328 to d755d02 Compare October 25, 2024 14:59

sfc-gh-knozderko reviewed Oct 25, 2024

View reviewed changes

Additional comments

25215c3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SNOW-715504: MFA token cache support #988

SNOW-715504: MFA token cache support #988

sfc-gh-jmartinezramirez commented Jul 4, 2024 •

edited

Loading

codecov bot commented Jul 9, 2024 •

edited

Loading

sfc-gh-knozderko Jul 29, 2024

sfc-gh-jmartinezramirez Jul 29, 2024

sfc-gh-knozderko Oct 8, 2024

sfc-gh-jmartinezramirez Oct 8, 2024

sfc-gh-knozderko Oct 25, 2024

sfc-gh-jmartinezramirez Oct 25, 2024

sfc-gh-knozderko Oct 25, 2024

sfc-gh-jmartinezramirez Oct 25, 2024

SNOW-715504: MFA token cache support #988

Are you sure you want to change the base?

SNOW-715504: MFA token cache support #988

Conversation

sfc-gh-jmartinezramirez commented Jul 4, 2024 • edited Loading

Description

Checklist

codecov bot commented Jul 9, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sfc-gh-jmartinezramirez commented Jul 4, 2024 •

edited

Loading

codecov bot commented Jul 9, 2024 •

edited

Loading