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.

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

Privacy feature for logging client information #392

Merged
merged 2 commits into from
May 12, 2023
Merged

Privacy feature for logging client information #392

merged 2 commits into from
May 12, 2023

Conversation

Bram1903
Copy link
Collaborator

@Bram1903 Bram1903 commented May 12, 2023

Privacy feature for logging client information

This pull request adds support for dynamically setting whether the server should include client IP addresses and/or client agents.

If someone decides they want to use this code base, but don't want to log certain privacy-sensitive information, they can decide to either turn both options off or switch a certain option off.

This may help people who are publicly using his application in the sense of many administrators and don't want their server to log client-sensitive information.

  • LogClientIpAddresses: When disabled won't include the client IP address within the logging system.
  • LogClientAgents: When disabled won't include the client's agent within the logging system.

Besides the above, this also fixes #391

Screenshots:

Privacy Settings:

image

Logging settings enabled vs disabled:

image

Side Note

Refer to commenting in JSON files, because if you don't have to proper tools installed it will throw errors, which would be confusing for someone who freshly clones this project. See the error below:

JSON standard does not allow comments. Use JSMin or similar tool to remove comments before parsing.

@Bram1903 Bram1903 added the Enhancement New feature or request label May 12, 2023
@Bram1903 Bram1903 self-assigned this May 12, 2023
@Bram1903 Bram1903 changed the title Privacy Feature for logging client information Privacy feature for logging client information May 12, 2023
@Bram1903 Bram1903 requested a review from neozhu May 12, 2023 08:20
Copy link
Owner

@neozhu neozhu left a comment

Choose a reason for hiding this comment

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

done

@neozhu neozhu merged commit 50de76c into neozhu:main May 12, 2023
@Bram1903
Copy link
Collaborator Author

Bram1903 commented May 12, 2023

done

You seem to have missed the Side Note part since you updated the appsettings.json.

Side Note

Refer to commenting in JSON files, because if you don't have to proper tools installed it will throw errors, which would be confusing for someone who freshly clones this project. See the error below:

JSON standard does not allow comments. Use JSMin or similar tool to remove comments before parsing.

@neozhu
Copy link
Owner

neozhu commented May 12, 2023

Thank you for your feedback.
I will only keep these commented-out contents during development and will remove them before publishing.

@Bram1903 Bram1903 added the Security Vulnerability Something has a security risk label Jun 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request Security Vulnerability Something has a security risk
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Privacy Security Risk
2 participants