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

userguide: update tls not_after/not_before mentions - v1 #9814

Closed
wants to merge 1 commit into from

Conversation

jufajardini
Copy link
Contributor

Our tls fields not_after and not_before are actually logged as notafter and notbefore, but were documented with the underscore.

Update the documentation, since updating the log format itself would be a breaking change.

Task #5494

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

Describe changes:

  • update documentation reference to not_after and not_before, to reflect what we actually have

Thought of updating references in the yaml file, too, but this would mess up with implementation, from what I understood, and would mean taking longer to fix, so went with the simplest fix.

Our tls fields not_after and not_before are actually logged as
`notafter` and `notbefore`, but were documented with the underscore.

Update the documentation, since updating the log format itself would be
a breaking change.

Task OISF#5494
@jasonish
Copy link
Member

Thought of updating references in the yaml file, too, but this would mess up with implementation, from what I understood, and would mean taking longer to fix, so went with the simplest fix.

Agreed. One thing we could do is fix in the yaml, and then add code silently support the old names.. I think its just in the custom logging stuff?

Copy link

codecov bot commented Nov 16, 2023

Codecov Report

Merging #9814 (0420be1) into master (2f4027c) will increase coverage by 0.00%.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9814   +/-   ##
=======================================
  Coverage   82.37%   82.37%           
=======================================
  Files         968      968           
  Lines      273866   273866           
=======================================
+ Hits       225585   225589    +4     
+ Misses      48281    48277    -4     
Flag Coverage Δ
fuzzcorpus 64.21% <ø> (+<0.01%) ⬆️
suricata-verify 60.98% <ø> (+<0.01%) ⬆️
unittests 62.93% <ø> (+<0.01%) ⬆️

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

@victorjulien victorjulien added this to the 8.0 milestone Nov 17, 2023
@victorjulien
Copy link
Member

Merged in #9829, thanks!

@jufajardini jufajardini deleted the tls-doc/v1 branch November 21, 2023 11:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants