Add support for embedding an encoded JSON payload #1017
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Primary changes:
- add optional support for embedding an encoded certificate metadata
payload
- disabled by default to retain existing plugin behavior
- the intent is to "shuttle" a payload of certificate metadata in
structured format from the plugin, to the monitoring system and to
downstream tools (e.g., via API call) so that the payload can be
retrieved, decoded, & unmarshalled to a supported data structure
for further certificate evaluation
- see also the <https://github.com/atc0005/cert-payload> and
<https://github.com/atc0005/go-nagios> projects for the data
structures and supporting logic used in the encoding/decoding
process
- add optional support for embedding an encoded certificate metadata
payload *with the original certificate chain included* in PEM
encoded format
- this is not enabled by default due to the significant increase in
plugin output size
- add logging of plugin output size calculations when debug logging is
enabled
- update README with new features
Related/indirect changes:
- doc comments cleanup
- e.g., `ExpirationValidationResult.ageWarningThreshold` field
- add `ExpirationValidationResult.AgeWarningThreshold` method
- add `ExpirationValidationResult.AgeCriticalThreshold` method
- add `atc0005/cert-payload` dependency
- extend `Config` type, constants, flags, etc. to handle new flags
- add `certs.ExpiresInDaysPrecise` function
- add `certs.ExpiresInHours` function
- add `certs.SANsEntriesLine` function
refs GH-960
atc0005
added
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Primary changes
Related/indirect changes
ExpirationValidationResult.ageWarningThresholdfieldExpirationValidationResult.AgeWarningThresholdmethodExpirationValidationResult.AgeCriticalThresholdmethodatc0005/cert-payloaddependencyConfigtype, constants, flags, etc. to handle new flagscerts.ExpiresInDaysPrecisefunctioncerts.ExpiresInHoursfunctioncerts.SANsEntriesLinefunctionReferences
LongServiceOutputcontent #960