Skip to content

feat: add logging capability to SecureWorkflow #2517

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
May 10, 2025

Conversation

varunsh-coder
Copy link
Member

  • Add enableLogging query parameter (off by default)
  • Log input YAML and query parameters when enabled
  • Log processing steps and errors when enabled
  • Add final result logging

- Add enableLogging query parameter (off by default)
- Log input YAML and query parameters when enabled
- Log processing steps and errors when enabled
- Add final result logging
Copy link
Contributor

@step-security-bot step-security-bot left a comment

Choose a reason for hiding this comment

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

Please find StepSecurity AI-CodeWise code comments below.

Code Comments

remediation/workflow/secureworkflow.go

[
    {
        "Severity": "High",
        "Recommendation": "Avoid logging sensitive information",
        "Description": "Logging sensitive information such as query parameters and input YAML can expose sensitive data to logs, which can be a security risk.",
        "Remediation": "Ensure that only non-sensitive information is logged, and sensitive data is properly sanitized or obfuscated before logging."
    },
    {
        "Severity": "Medium",
        "Recommendation": "Avoid logging errors along with sensitive data",
        "Description": "Logging errors along with sensitive data can expose critical information to logs, which can potentially lead to security vulnerabilities.",
        "Remediation": "Separate error logging from sensitive data logging and ensure that error messages do not contain sensitive information."
    }
]

Feedback

We appreciate your feedback in helping us improve the service! To provide feedback, please use emojis on this comment. If you find the comments helpful, give them a 👍. If they aren't useful, kindly express that with a 👎. If you have questions or detailed feedback, please create n GitHub issue in StepSecurity/AI-CodeWise.

Copy link

codecov bot commented May 10, 2025

Codecov Report

Attention: Patch coverage is 4.00000% with 48 lines in your changes missing coverage. Please review.

Project coverage is 64.32%. Comparing base (d346d34) to head (fe21a5b).
Report is 2 commits behind head on main.

Files with missing lines Patch % Lines
remediation/workflow/secureworkflow.go 4.00% 37 Missing and 11 partials ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2517      +/-   ##
==========================================
- Coverage   65.95%   64.32%   -1.63%     
==========================================
  Files          17       17              
  Lines        1818     1864      +46     
==========================================
  Hits         1199     1199              
- Misses        527      563      +36     
- Partials       92      102      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@varunsh-coder varunsh-coder merged commit 7c5d265 into main May 10, 2025
5 of 7 checks passed
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.

3 participants