suricata icon indicating copy to clipboard operation
suricata copied to clipboard

napatech: emit HBA deprecation only once

Open perkinjo opened this issue 1 year ago • 17 comments

Issue: 6313 This commit removes duplicate HBA deprecation messages from being emitted.

Make sure these boxes are signed before submitting your Pull Request -- thank you.

  • [x] I have read the contributing guide lines at https://docs.suricata.io/en/latest/devguide/codebase/contributing/contribution-process.html
  • [x] I have signed the Open Information Security Foundation contribution agreement at https://suricata.io/about/contribution-agreement/
  • [x] I have updated the user guide (in doc/userguide/) to reflect the changes made (if applicable)

Link to redmine ticket: https://redmine.openinfosecfoundation.org/issues/6313

Describe changes:

  • This commit removes duplicate HBA deprecation messages from being emitted.

Provide values to any of the below to override the defaults.

To use a pull request use a branch name like pr/N where N is the pull request number.

Alternatively, SV_BRANCH may also be a link to an OISF/suricata-verify pull-request.

SV_REPO=
SV_BRANCH=
SU_REPO=
SU_BRANCH=
LIBHTP_REPO=
LIBHTP_BRANCH=

perkinjo avatar Sep 12 '23 19:09 perkinjo

NOTE: This PR may contain new authors:

Jonathan Perkins <[email protected]>

github-actions[bot] avatar Sep 12 '23 19:09 github-actions[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.26%. Comparing base (8e8efd2) to head (05640d8).

Additional details and impacted files
@@              Coverage Diff               @@
##           main-7.0.x    #9478      +/-   ##
==============================================
- Coverage       82.39%   82.26%   -0.14%     
==============================================
  Files             976      976              
  Lines          275035   275035              
==============================================
- Hits           226616   226252     -364     
- Misses          48419    48783     +364     
Flag Coverage Δ
fuzzcorpus 62.78% <ø> (-0.70%) :arrow_down:
suricata-verify 61.59% <ø> (-0.03%) :arrow_down:
unittests 62.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

codecov[bot] avatar Sep 12 '23 19:09 codecov[bot]

@ralpheastwood Is the HBA setting going to be deprecated?

jlucovsky avatar Sep 13 '23 11:09 jlucovsky

It looks like we have a typo in the warning message, it should be "Host Buffer Allowance", instead of "Host Buffer Allocation". But yes, we will be deprecating this setting.

ralpheastwood avatar Sep 13 '23 12:09 ralpheastwood

It looks like we have a typo in the warning message, it should be "Host Buffer Allowance", instead of "Host Buffer Allocation". But yes, we will be deprecating this setting.

@ralpheastwood When do you anticipate the deprecation will occur and with what API version of the NT software will that be in?

jlucovsky avatar Sep 14 '23 16:09 jlucovsky

I'll send in a pull request to remove the setting (in the next few days). The API won't be removed from our software for compatibility with our older hardware (and for other software that uses our hardware) but we don't support its use for current hardware through Suricata.

ralpheastwood avatar Sep 18 '23 12:09 ralpheastwood

I'll send in a pull request to remove the setting (in the next few days). The API won't be removed from our software for compatibility with our older hardware (and for other software that uses our hardware) but we don't support its use for current hardware through Suricata.

This means the HBA is already removed? Is there a follow-on mechanism that provides similar or extended functionality?

jlucovsky avatar Sep 18 '23 18:09 jlucovsky

It hasn't been removed, and the functionality will remain for some extant customer-specific applications. We do not have a timeline for the exact removal (or if it will be removed) but it is a feature that is not actively developed currently, and we no longer support its use with Suricata. There is no new feature with similar or replacement functionality currently.

ralpheastwood avatar Sep 19 '23 07:09 ralpheastwood

I'll send in a pull request to remove the setting (in the next few days). The API won't be removed from our software for compatibility with our older hardware (and for other software that uses our hardware) but we don't support its use for current hardware through Suricata.

@ralpheastwood Have you had a chance to submit a PR to remove this log message?

jlucovsky avatar Sep 28 '23 17:09 jlucovsky

I haven't had a chance yet, but I'll submit one next week with the changes.

ralpheastwood avatar Sep 28 '23 17:09 ralpheastwood

This PR can be closed as #9559 removes HBA related code, including the deprecation message.

jlucovsky avatar Oct 13 '23 17:10 jlucovsky

NOTE: This PR may contain new authors:

Jonathan Perkins <[email protected]>

github-actions[bot] avatar Oct 15 '23 12:10 github-actions[bot]

This PR can be closed as #9559 removes HBA related code, including the deprecation message.

Reverse on that -- #9559 is appropriate for Suri 8; this PR addresses the immediate issue (multiple log messages).

jlucovsky avatar Oct 30 '23 18:10 jlucovsky

Is the message itself still accurate? It states that something "will be deprecated" in 7.0. We're already in 7, so should it be 8?

victorjulien avatar Oct 31 '23 11:10 victorjulien

I don't think the message itself is accurate because the window for 7 was missed.

ralpheastwood avatar Oct 31 '23 11:10 ralpheastwood

I don't think the message itself is accurate because the window for 7 was missed.

So we

  • Change the message to "Host Buffer Allowance"
  • Change the deprecated version from v7.0 to v8.0

Thoughts?

jlucovsky avatar Oct 31 '23 12:10 jlucovsky

That sounds good - and then the removal PR will be merged for v8.0 after this?

ralpheastwood avatar Oct 31 '23 12:10 ralpheastwood

Sorry that I missed the request back in December. I'm working on the rebase now. However it looks like the relevant code was already removed from master.

Is it correct that this PR should now target main-7.0.x instead of master?

perkinjo avatar Mar 13 '24 19:03 perkinjo

NOTE: This PR may contain new authors.

github-actions[bot] avatar Mar 13 '24 20:03 github-actions[bot]

Continued in #10644

jlucovsky avatar Mar 14 '24 13:03 jlucovsky