Skip to content

Commit

Permalink
[SECVULN-1533] chore: Clarify iptables Provider interface docs (#19704)
Browse files Browse the repository at this point in the history
chore: Clarify iptables Provider interface docs

Add docs clarifying constraints on use and return values.
  • Loading branch information
zalimeni authored Nov 21, 2023
1 parent a28f4b7 commit 8a89465
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion sdk/iptables/iptables.go
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,11 @@ type Provider interface {
// ApplyRules executes rules that have been added via AddRule.
// This operation is currently not atomic, and if there's an error applying rules,
// you may be left in a state where partial rules were applied.
// ApplyRules should not be called twice on the same instance in order to avoid
// duplicate rule application.
ApplyRules() error
// Rules returns the list of rules that have been added but not applied yet.
// Rules returns the list of rules that have been added (including those not yet
// applied).
Rules() []string
}

Expand Down

0 comments on commit 8a89465

Please sign in to comment.