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

fix(secret): trim excessively long lines #7192

Merged
merged 7 commits into from
Jul 23, 2024

Conversation

afdesk
Copy link
Contributor

@afdesk afdesk commented Jul 19, 2024

Description

In this PR, we address the issue of handling excessively long lines in files.
When a line is too lengthy, displaying the entire content is unnecessary and inefficient.

In general cases, such as obfuscated JavaScript code, we truncate the line appropriately to improve readability.

If a long line contains a secret, we only display the segment containing the secret.

Before:

$ trivy image --scanners secret mattermost/mattermost-enterprise-edition:9.7.1
/mattermost/client/8055.c2e8394446fd4bca58d8.js (secrets)
=========================================================
Total: 2 (UNKNOWN: 0, LOW: 2, MEDIUM: 0, HIGH: 0, CRITICAL: 0)

LOW: Stripe (stripe-publishable-token)
════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════
Stripe Publishable Key
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
 /mattermost/client/8055.c2e8394446fd4bca58d8.js:1 (added by 'RUN |3 PUID=2000 PGID=2000 MM_PACKAGE=ht')
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
   1 [ "use strict";(self.webpackChunkmattermost_webapp=self.webpackChunkmattermost_webapp||[]).push([[8055],{59713:(e,t,n)=>{n.d(t,{$d:()=>b,DF:()=>G,Du:()=>B,GA:()=>F,Is:()=>M,JJ:()=>J,K6:()=>re,KB:()=>f,KO:()=>x,Md:()=>ae,NB:()=>ce,O$:()=>E,OT:()=>ee,QQ:()=>oe,SP:()=>K,Sm:()=>se,T8:()=>Y,UV:()=>pe,W3:()=>C,X$:()=>X,_9:()=>de,a6:()=>Q,d1:()=>ne,d5:()=>$,dA:()=>te,gY:()=>ie,go:()=>T,h5:()=>z,iB:()=>A,iz:()=>O,jI:()=>S,kO:()=>N,lJ:()=>me,nU:()=>D,oQ:()=>Z,pu:()=>H,pw:()=>I,qE:()=>ue,r3:()=>j,r6:()=>le,rX:()=>U,rm:()=>y,sW:()=>R,sg:()=>q,sv:()=>W,v1:()=>w,vI:()=>v,vy:()=>L,wg:()=>k,xT:()=>P,yT:()=>_,yX:()=>V}),n(61418),n(92189);var a=n(12763),s=n(98644),i=n(17086),r=n(31435),o=n(80139),l=n(68679),c=n(28176),d=n(5123),m=n(91436),u=n(23712);function p(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function h(e){for(var s ({count})","admin.system_users.filtersPopover.apply":"Apply","admin.system_users.filtersPopover.title":"Filter :!))),s=e.filter((e=>null!==e&&!n.includes(e.id))).sort(((e,n)=>function(e,t,n){return null!==t.display_name&&t.display_name! <REALLY LONG JS SCRIPT>
   2   //# sourceMappingURL=8055.c2e8394446fd4bca58d8.js.map
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

After:

$ trivy image --scanners secret mattermost/mattermost-enterprise-edition:9.7.1
...

/mattermost/client/8055.c2e8394446fd4bca58d8.js (secrets)
=========================================================
Total: 2 (UNKNOWN: 0, LOW: 2, MEDIUM: 0, HIGH: 0, CRITICAL: 0)

LOW: Stripe (stripe-publishable-token)
════════════════════════════════════════
Stripe Publishable Key
────────────────────────────────────────
 /mattermost/client/8055.c2e8394446fd4bca58d8.js:1 (added by 'RUN |3 PUID=2000 PGID=2000 MM_PACKAGE=ht')
────────────────────────────────────────
   1 [ ){case a.ez.PRODUCTION:return"********************************";case a.ez.TEST:cas
   2   //# sourceMappingURL=8055.c2e8394446fd4bca58d8.js.map
────────────────────────────────────────

Related issues

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

@afdesk afdesk changed the title fix(secret): trim excessively long secret data fix(secret): trim excessively long lines Jul 22, 2024
@afdesk afdesk marked this pull request as ready for review July 22, 2024 06:21
@afdesk
Copy link
Contributor Author

afdesk commented Jul 22, 2024

@knqyf263 @DmitriyLewen could you take a look at this PR when yuo have free time? thanks

I'm not sure about maxLineLength = 2000.
Now 2000 is a length for backward compatibility with RSA keys.

wdyt?

Copy link
Contributor

@DmitriyLewen DmitriyLewen left a comment

Choose a reason for hiding this comment

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

Left a comment about max length of line.
The rest looks good to me.

Comment on lines +521 to +525
if len(rawLine) > maxLineLength {
strRawLine = lo.Ternary(inCause, matchLine, string(rawLine[:maxLineLength]))
} else {
strRawLine = string(rawLine)
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like 100 characters is enough.

  1. For lines before and after secret - we don't need such a big line.
  2. For secret line - if length of secret with secret > 100 - we use 30 + secret + 20 characters:
    if lineEnd-lineStart > 100 {
    lineStart = lo.Ternary(start-30 < 0, 0, start-30)
    lineEnd = lo.Ternary(end+20 > len(content), len(content), end+20)
    }

Now 2000 is a length for backward compatibility with RSA keys.

IIUC you want to include full RSA key to result (-----BEGIN RSA PRIVATE KEY----- and -----END RSA PRIVATE KEY-----), but I think this is not necessary.
But when we use 2000, we can see case when secret length is 10, but the user sees 1900 unneeded characters.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DmitriyLewen I generally agree with you. 2k is too long line.

Comment on lines +465 to +466
Content: "----BEGIN RSA PRIVATE KEY-----**************************************************************************************************************************-----END RSA PRIVATE",
Highlighted: "----BEGIN RSA PRIVATE KEY-----**************************************************************************************************************************-----END RSA PRIVATE",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@DmitriyLewen I've decreased maxLineLength and updated the test.
it shows before/after.

@afdesk afdesk requested a review from DmitriyLewen July 22, 2024 11:02
@afdesk afdesk requested a review from DmitriyLewen July 22, 2024 11:48
Copy link
Contributor

@DmitriyLewen DmitriyLewen left a comment

Choose a reason for hiding this comment

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

LGTM

cc. @knqyf263

@knqyf263 knqyf263 added this pull request to the merge queue Jul 23, 2024
Merged via the queue into aquasecurity:main with commit 92b13be Jul 23, 2024
12 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.

bug(secret): set limit for line length
3 participants