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.

Sign up for GitHub

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

Jump to bottom

advancedtls: Add notes about required vs. optional for FileWatcherOptions #7165

Merged
merged 2 commits into from Apr 30, 2024
Merged

advancedtls: Add notes about required vs. optional for FileWatcherOptions #7165

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f3234c
Add notes about required vs. optional for FileWatcherOptions
gtcooke94 Apr 23, 2024
b7d2683
change formatting
gtcooke94 Apr 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions security/advancedtls/crl_provider.go
View file
Open in desktop
Expand Up @@ -90,9 +90,9 @@ func (p *StaticCRLProvider) CRL(cert *x509.Certificate) (*CRL, error) {
// FileWatcherOptions represents a data structure holding a configuration for
// FileWatcherCRLProvider.
type FileWatcherOptions struct {
CRLDirectory string // Path of the directory containing CRL files
RefreshDuration time.Duration // Time interval (default value is 1 hour) between CRLDirectory scans, can't be smaller than 1 minute
CRLReloadingFailedCallback func(err error) // Custom callback executed when a CRL file can’t be processed
CRLDirectory string // Required: Path of the directory containing CRL files
RefreshDuration time.Duration // Optional, default 1 hour: Time interval between CRLDirectory scans, can't be smaller than 1 minute
Copy link
Contributor

Choose a reason for hiding this comment

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

Would you prefer
// Optional: Time interval (default is 1 hour) between...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed, I like that more

CRLReloadingFailedCallback func(err error) // Optional: Custom callback executed when a CRL file can’t be processed
}

// FileWatcherCRLProvider implements the CRLProvider interface by periodically
Expand Down