Skip to content

Use a neutral name to hopefully avoid false alarm #586

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.

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

Merged
merged 1 commit into from
Jul 27, 2023
Merged

Conversation

rayluo
Copy link
Collaborator

@rayluo rayluo commented Jul 26, 2023

Thanks @bgavrilMS for noticing the recent alarm 13 and alarm 14.

They are both false alarms. In this PR, we change the name of the variable.

The CodeQL has been configured to auto scan "PRs to dev" branch, so, a green test result would supposedly mean our fix is good. But then again, none of the recent CodeQL action result was red. So, we don't really know what the color means.

P.S.: The current test automation failure is caused by a different reason. The msidlab8 seems down. Lab team has been informed. It is fixed now.

@rayluo rayluo requested a review from bgavrilMS July 26, 2023 18:49
@@ -465,7 +465,7 @@ def test_device_flow(self):

def get_lab_app(
env_client_id="LAB_APP_CLIENT_ID",
env_client_secret="LAB_APP_CLIENT_SECRET",
env_name2="LAB_APP_CLIENT_SECRET", # A var name that hopefully avoids false alarm
Copy link

@gladjohn gladjohn Jul 26, 2023

Choose a reason for hiding this comment

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

LAB_APP_CLIENT_SECRET Will this be reported next? I would only think it should be the value more than the variable name itself. We used to have this issue in the Labs, and we had to remove the word secret from our code. Is changing LAB_APP_CLIENT_SECRET to something else too hard?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

LAB_APP_CLIENT_SECRET Will this be reported next? I would only think it should be the value more than the variable name itself. We used to have this issue in the Labs, and we had to remove the word secret from our code.

That is a fair point, @gladjohn . We do not really know what the CodeQL looks into. On the other hand, the two existing (false) alarms were specifically on the lines of logging env_client_secret, not on the line of "LAB_APP_CLIENT_SECRET".

Is changing LAB_APP_CLIENT_SECRET to something else too hard?

It would require us to change more files (.env) spreading across many machines that we are using, also changing the env var setup in our GitHub Actions. Let's do this variable name change first, and see whether it is good enough.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix code scanning alert - Clear-text logging of sensitive information Fix code scanning alert - Clear-text logging of sensitive information
2 participants