Don't redact Key Vault header values in logs (#12077)

Azure · Jun 22, 2020 · 2c8bfa1 · 2c8bfa1
1 parent 4fef4d7
commit 2c8bfa1
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 3 deletions.
diff --git a/sdk/keyvault/azure-keyvault-certificates/CHANGELOG.md b/sdk/keyvault/azure-keyvault-certificates/CHANGELOG.md
@@ -1,6 +1,8 @@
 # Release History
 
 ## 4.2.0b2 (Unreleased)
+- Values of `x-ms-keyvault-region` and `x-ms-keyvault-service-version` headers
+  are no longer redacted in logging output.
 - Updated minimum `azure-core` version to 1.4.0
 
 ## 4.2.0b1 (2020-03-10)

diff --git a/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/_shared/client_base.py b/sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/_shared/client_base.py
@@ -27,7 +27,9 @@
 
 def _get_policies(config, **kwargs):
     logging_policy = HttpLoggingPolicy(**kwargs)
-    logging_policy.allowed_header_names.add("x-ms-keyvault-network-info")
+    logging_policy.allowed_header_names.update(
+        {"x-ms-keyvault-network-info", "x-ms-keyvault-region", "x-ms-keyvault-service-version"}
+    )
 
     return [
         config.headers_policy,

diff --git a/sdk/keyvault/azure-keyvault-keys/CHANGELOG.md b/sdk/keyvault/azure-keyvault-keys/CHANGELOG.md
@@ -1,6 +1,8 @@
 # Release History
 
 ## 4.2.0b2 (Unreleased)
+- Values of `x-ms-keyvault-region` and `x-ms-keyvault-service-version` headers
+  are no longer redacted in logging output.
 - Updated minimum `azure-core` version to 1.4.0
 - `CryptographyClient` will no longer perform encrypt or wrap operations when
   its key has expired or is not yet valid.

diff --git a/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/_shared/client_base.py b/sdk/keyvault/azure-keyvault-keys/azure/keyvault/keys/_shared/client_base.py
@@ -27,7 +27,9 @@
 
 def _get_policies(config, **kwargs):
     logging_policy = HttpLoggingPolicy(**kwargs)
-    logging_policy.allowed_header_names.add("x-ms-keyvault-network-info")
+    logging_policy.allowed_header_names.update(
+        {"x-ms-keyvault-network-info", "x-ms-keyvault-region", "x-ms-keyvault-service-version"}
+    )
 
     return [
         config.headers_policy,

diff --git a/sdk/keyvault/azure-keyvault-secrets/CHANGELOG.md b/sdk/keyvault/azure-keyvault-secrets/CHANGELOG.md
@@ -1,6 +1,8 @@
 # Release History
 
 ## 4.2.0b2 (Unreleased)
+- Values of `x-ms-keyvault-region` and `x-ms-keyvault-service-version` headers
+  are no longer redacted in logging output.
 - Updated minimum `azure-core` version to 1.4.0
 
 ## 4.2.0b1 (2020-03-10)

diff --git a/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/_shared/client_base.py b/sdk/keyvault/azure-keyvault-secrets/azure/keyvault/secrets/_shared/client_base.py
@@ -27,7 +27,9 @@
 
 def _get_policies(config, **kwargs):
     logging_policy = HttpLoggingPolicy(**kwargs)
-    logging_policy.allowed_header_names.add("x-ms-keyvault-network-info")
+    logging_policy.allowed_header_names.update(
+        {"x-ms-keyvault-network-info", "x-ms-keyvault-region", "x-ms-keyvault-service-version"}
+    )
 
     return [
         config.headers_policy,