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

SNOW-1660591 Remove sensitive encryption info when logging #2077

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
+49 −1
Open

SNOW-1660591 Remove sensitive encryption info when logging #2077

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5f49b29
Parse out sensitive encryption material before logging json
sfc-gh-ext-simba-jf Feb 13, 2025
9690ef0
Fix test failure
sfc-gh-ext-simba-jf Feb 13, 2025
6f9d7cf
Merge branch 'master' into SNOW-1660591-Remove-Encryption-Storage-Inf…
sfc-gh-ext-simba-jf Feb 20, 2025
7f1ced4
Changed implementation to use SecretDetector, added test
sfc-gh-ext-simba-jf Feb 26, 2025
364cad9
Merge branch 'master' into SNOW-1660591-Remove-Encryption-Storage-Inf…
sfc-gh-ext-simba-jf Feb 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion src/main/java/net/snowflake/client/jdbc/SnowflakeFileTransferAgent.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.node.ObjectNode;
import com.google.common.base.Strings;
import com.google.common.io.ByteStreams;
import com.google.common.io.CountingOutputStream;
Expand Down Expand Up @@ -1338,12 +1339,23 @@ private static JsonNode parseCommandInGS(SFStatement statement, String command)
}

JsonNode jsonNode = (JsonNode) result;
logger.debug("Response: {}", jsonNode.toString());

logger.debug("Response: {}", removeSensitiveJsonElementsForLogging(jsonNode));

SnowflakeUtil.checkErrorAndThrowException(jsonNode);
return jsonNode;
}

/**
* @param jsonNode A JsonNode that needs to have sensitive data removed before logging.
* @return A string value of the JSON without any sensitive data for logging.
*/
private static String removeSensitiveJsonElementsForLogging(JsonNode jsonNode)
throws SnowflakeSQLException {
JsonNode result = jsonNode.deepCopy();
return ((ObjectNode) result.path("data")).remove("encryptionMaterial").toString();
}

/**
* @param rootNode JSON doc returned by GS
* @throws SnowflakeSQLException Will be thrown if we fail to parse the stage credentials
Expand Down
Loading