Skip to content

Add handling and documentation for temporary params in fingerprints#12

Merged
mkienow-r7 merged 4 commits intorapid7:mainfrom
TomSellers:ignore_tmp_vars
Mar 16, 2023
Merged

Add handling and documentation for temporary params in fingerprints#12
mkienow-r7 merged 4 commits intorapid7:mainfrom
TomSellers:ignore_tmp_vars

Conversation

@TomSellers
Copy link
Copy Markdown
Contributor

@TomSellers TomSellers commented Feb 23, 2023

Description

This PR adds handling and documentation for temporary params (_tmp.*) in fingerprints. The explanation
is handled in the README. Let me know if it isn't clear and I will adjust. I discussed this with @mkienow-r7 late
last month.

I've also opened rapid7/recog#547 to mirror the documentation changes there.

How Has This Been Tested?

Local tests, forked implementation.

Types of changes

  • New feature (non-breaking change which adds functionality)

Checklist:

  • I have updated the documentation accordingly (or changes are not required).
  • I have added tests to cover my changes (or new tests are not required).
  • All new and existing tests passed.

Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
</fingerprint>
```

There is special handling for temporary `name` attributes starting with `_tmp.` such
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

New content related to _tmp. here.

Comment thread README.md Outdated
Comment thread lib/recog/fingerprint.rb Outdated
Comment thread lib/recog/fingerprint.rb Outdated
Comment thread README.md Outdated
There is special handling for temporary attributes that have a name starting with
`_tmp.`. These attributes can be used for interpolation but are not emitted in the
output. This is useful when a particular product name is inconsistent in various
banners, vendor marketing, or with NIST values when trying to generated CPEs. In
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

s/generated/generate

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Fixed, thanks for catching.

Copy link
Copy Markdown
Contributor

@mkienow-r7 mkienow-r7 left a comment

Choose a reason for hiding this comment

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

Thank you for the contribution @TomSellers!

@mkienow-r7 mkienow-r7 merged commit 8e51729 into rapid7:main Mar 16, 2023
mkienow-r7 added a commit to rapid7/recog that referenced this pull request Mar 17, 2023
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.

2 participants