Skip to content

Fixing protected settings key leak #2198

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

Open
jaytripath wants to merge 1 commit into
base: master
Choose a base branch
from
+19 −6
Open

Fixing protected settings key leak #2198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 12 additions & 4 deletions AzureMonitorAgent/agent.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2447,9 +2447,13 @@ def parse_context(operation):
output = 'Logrotate removal failed with error: {0}\nStacktrace: {1}'.format(ex, traceback.format_exc())
hutil_log_info(output)
else:
if not os.path.exists(AMAExtensionLogRotateFilePath):
logrotateFilePath = os.path.join(os.getcwd(), 'azuremonitoragentextension.logrotate')
copyfile(logrotateFilePath,AMAExtensionLogRotateFilePath)
if not os.path.exists(AMAExtensionLogRotateFilePath):
try:
logrotateFilePath = os.path.join(os.getcwd(), 'azuremonitoragentextension.logrotate')
copyfile(logrotateFilePath,AMAExtensionLogRotateFilePath)
except Exception as ex:
output = 'Logrotate config copy failed with error: {0}\nStacktrace: {1}'.format(ex, traceback.format_exc())
hutil_log_info(output)

# parse_context may throw KeyError if necessary JSON key is not
# present in settings
Expand Down Expand Up @@ -3060,9 +3064,13 @@ def get_settings():
protected_settings_str = None
for decrypt_cmd in [cms_cmd, smime_cmd]:
try:
# stderr is intentionally captured separately from stdout (and never
# logged verbatim) so that non-fatal openssl warnings (e.g. a missing
# openssl.cnf) can't get concatenated with the decrypted output, corrupt the
# JSON payload, and risk the decrypted secret being echoed in error handling.
session = subprocess.Popen([decrypt_cmd], shell=True,
stdin=subprocess.PIPE,
stderr=subprocess.STDOUT,
stderr=subprocess.PIPE,
stdout=subprocess.PIPE)
output = session.communicate(decoded_settings)
# success only if return code is 0 and we have output
Expand Down
9 changes: 7 additions & 2 deletions Utils/HandlerUtil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,13 @@ def _parse_config(self, ctxt):
jctxt = ''
try:
jctxt = json.loads(protected_settings_str)
except:
self.error('JSON exception decoding ' + HandlerUtility.redact_protected_settings(protected_settings_str))
except Exception as e:
# Do not log protected_settings_str here: it is the decrypted
# plaintext of protectedSettings and may contain secrets (e.g.
# workspace keys). redact_protected_settings() only knows how to
# redact the outer (still-encrypted) envelope fields, so it would
# not mask secrets that live inside this already-decrypted payload.
self.error('JSON exception decoding protectedSettings: {0}'.format(e))
handlerSettings['protectedSettings']=jctxt
self.log('Config decoded correctly.')
return config
Expand Down
Loading