Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

basculechecks

package

Go to main page

Versions in this module

v0

v0.11.7

Nov 10, 2023

v0.11.6

Aug 9, 2023

v0.11.5

May 10, 2023

v0.11.4

Jan 20, 2023

v0.11.3

Jan 11, 2023

v0.11.2

Nov 30, 2022

v0.11.1

Nov 11, 2022

v0.11.0

Aug 17, 2022

v0.10.2

Jul 28, 2021

v0.10.1

Jun 15, 2021

v0.10.0

Jun 3, 2021

Changes in this version

+ const AcceptedOutcome

+ const AuthCapabilityCheckOutcome

+ const ClientIDLabel

+ const EmptyCapabilitiesList

+ const EmptyParsedURL

+ const EndpointLabel

+ const ManyPartner

+ const MethodLabel

+ const MissingValues

+ const NoCapabilitiesMatch

+ const NoEndpointChecker

+ const NoneEndpoint

+ const NonePartner

+ const NotRecognizedEndpoint

+ const OutcomeLabel

+ const PartnerIDLabel

+ const ReasonLabel

+ const RejectedOutcome

+ const ServerLabel

+ const TokenMissing

+ const UndeterminedCapabilities

+ const UndeterminedPartnerID

+ const UnknownReason

+ const Wildcard

+ const WildcardPartner

+ var ErrCapabilityNotStringSlice = errWithReason

+ var ErrEmptyEndpoint = errWithReason

+ var ErrGettingCapabilities = errWithReason

+ var ErrGettingPartnerIDs = errWithReason

+ var ErrNilAttributes = errWithReason

+ var ErrNilChecker = errors.New("capabilities checker cannot be nil")

+ var ErrNilDefaultChecker = errors.New("default checker cannot be nil")

+ var ErrNilMeasures = errors.New("measures cannot be nil")

+ var ErrNoAuth = errors.New("couldn't get request info: authorization not found")

+ var ErrNoMethod = errWithReason

+ var ErrNoToken = errWithReason

+ var ErrNoURL = errWithReason

+ var ErrNoValidCapabilityFound = errWithReason

+ var ErrNoVals = errWithReason

+ var ErrPartnerIDsNotStringSlice = errWithReason

+ func AllowAll() bascule.ValidatorFunc

+ func AttributeList(keys []string, checks ...func(context.Context, []interface{}) error) bascule.ValidatorFunc

+ func CapabilityKeys() []string

+ func DeterminePartnerMetric(partners []string) string

+ func NonEmptyPrincipal() bascule.ValidatorFunc

+ func NonEmptyType() bascule.ValidatorFunc

+ func PartnerKeys() []string

+ func ProvideCapabilitiesMapValidator(key string) fx.Option

+ func ProvideMetricValidator(optional bool) fx.Option

+ func ProvideMetrics() fx.Option

+ func ProvideRegexCapabilitiesValidator(key string) fx.Option

+ func ValidType(validTypes []string) bascule.ValidatorFunc

+ type AlwaysEndpointCheck bool

+ func (a AlwaysEndpointCheck) Authorized(_, _, _ string) bool

+ func (a AlwaysEndpointCheck) Name() string

+ type AuthCapabilityCheckMeasures struct

+ CapabilityCheckOutcome *prometheus.CounterVec

+ type CapabilitiesChecker interface

+ CheckAuthentication func(auth bascule.Authentication, vals ParsedValues) error

+ type CapabilitiesCheckerOut struct

+ Checker CapabilitiesChecker

+ Options []MetricOption

+ func NewCapabilitiesMap(config CapabilitiesMapConfig) (CapabilitiesCheckerOut, error)

+ func NewCapabilitiesValidator(config CapabilitiesValidatorConfig) (CapabilitiesCheckerOut, error)

+ type CapabilitiesMap struct

+ Checkers map[string]EndpointChecker

+ DefaultChecker EndpointChecker

+ KeyPath []string

+ func (c CapabilitiesMap) CheckAuthentication(auth bascule.Authentication, vs ParsedValues) error

+ type CapabilitiesMapConfig struct

+ Default string

+ Endpoints map[string]string

+ type CapabilitiesValidator struct

+ Checker EndpointChecker

+ ErrorOut bool

+ KeyPath []string

+ func (c CapabilitiesValidator) Check(ctx context.Context, _ bascule.Token) error

+ func (c CapabilitiesValidator) CheckAuthentication(auth bascule.Authentication, _ ParsedValues) error

+ type CapabilitiesValidatorConfig struct

+ AcceptAllMethod string

+ EndpointBuckets []string

+ Prefix string

+ Type string

+ type ConstEndpointCheck string

+ func (c ConstEndpointCheck) Authorized(capability, _, _ string) bool

+ func (c ConstEndpointCheck) Name() string

+ type EndpointChecker interface

+ Authorized func(value string, reqURL string, method string) bool

+ Name func() string

+ type MetricOption func(*MetricValidator)

+ func MonitorOnly() MetricOption

+ func WithEndpoints(e []*regexp.Regexp) MetricOption

+ func WithServer(s string) MetricOption

+ type MetricValidator struct

+ func NewMetricValidator(checker CapabilitiesChecker, measures *AuthCapabilityCheckMeasures, ...) (*MetricValidator, error)

+ func (m MetricValidator) Check(ctx context.Context, _ bascule.Token) error

+ type MetricValidatorIn struct

+ Checker CapabilitiesChecker

+ Measures AuthCapabilityCheckMeasures

+ Options []MetricOption

+ type ParsedValues struct

+ Endpoint string

+ type Reasoner interface

+ Reason func() string

+ type RegexEndpointCheck struct

+ func NewRegexEndpointCheck(prefix string, acceptAllMethod string) (RegexEndpointCheck, error)

+ func (e RegexEndpointCheck) Name() string

+ func (r RegexEndpointCheck) Authorized(capability string, urlToMatch string, methodToMatch string) bool