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

basculehelper

package

Go to main page

Versions in this module

v0

v0.8.5

May 8, 2023

v0.8.4

May 2, 2023

v0.8.3

Apr 26, 2023

Changes in this version

+ const EXPHistogram

+ const NBFHistogram

+ func AuthCapabilitiesMetrics() []xmetrics.Metric

+ func AuthValidationMetrics() []xmetrics.Metric

v0.8.2

Apr 24, 2023

v0.8.1

Apr 20, 2023

v0.8.0

Apr 20, 2023

Changes in this version

+ const AcceptedOutcome

+ const AuthCapabilityCheckOutcome

+ const AuthValidationOutcome

+ const CapabilityKey

+ const ClientIDLabel

+ const EmptyCapabilitiesList

+ const EmptyParsedURL

+ const EndpointLabel

+ const MissingValues

+ const NoCapabilitiesMatch

+ const NoCapabilityChecker

+ const OutcomeLabel

+ const PartnerIDLabel

+ const ReasonLabel

+ const RejectedOutcome

+ const ServerLabel

+ const TokenMissing

+ const TokenMissingValues

+ const UndeterminedCapabilities

+ const UndeterminedPartnerID

+ var ErrNilAttributes = errors.New("nil attributes interface")

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

+ var ErrNoToken = errors.New("no token found in Auth")

+ var ErrNoURL = errors.New("invalid URL found in Auth")

+ var ErrNoValidCapabilityFound = errors.New("no valid capability for endpoint")

+ var ErrNoVals = errors.New("expected at least one value")

+ func DeterminePartnerMetric(partners []string) string

+ func Metrics() []xmetrics.Metric

+ func PartnerKeys() []string

+ type AlwaysCheck bool

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

+ type AuthCapabilityCheckMeasures struct

+ CapabilityCheckOutcome metrics.Counter

+ func NewAuthCapabilityCheckMeasures(p provider.Provider) *AuthCapabilityCheckMeasures

+ type AuthValidationMeasures struct

+ ExpHistogram metrics.Histogram

+ NBFHistogram metrics.Histogram

+ ValidationOutcome metrics.Counter

+ func NewAuthValidationMeasures(r xmetrics.Registry) *AuthValidationMeasures

+ type CapabilitiesChecker interface

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

+ type CapabilitiesError struct

+ CapabilitiesFound []string

+ MethodToMatch string

+ UrlToMatch string

+ func NewCapabilitiesError(capabilities []string, reqUrl string, method string) *CapabilitiesError

+ func (c *CapabilitiesError) Error() string

+ type CapabilitiesValidator struct

+ Checker CapabilityChecker

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

+ func (c CapabilitiesValidator) CreateValidator(errorOut bool) bascule.ValidatorFunc

+ type CapabilityChecker interface

+ Authorized func(string, string, string) bool

+ type ConstCheck string

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

+ type EndpointRegexCheck struct

+ func NewEndpointRegexCheck(prefix string, acceptAllMethod string) (EndpointRegexCheck, error)

+ func (e EndpointRegexCheck) Authorized(capability string, urlToMatch string, methodToMatch string) bool

+ type MetricListener struct

+ func NewMetricListener(m *AuthValidationMeasures, options ...Option) *MetricListener

+ func (m *MetricListener) OnAuthenticated(auth bascule.Authentication)

+ func (m *MetricListener) OnErrorResponse(e basculehttp.ErrorResponseReason, _ error)

+ type MetricValidator struct

+ C CapabilitiesChecker

+ Endpoints []*regexp.Regexp

+ Measures *AuthCapabilityCheckMeasures

+ func (m MetricValidator) CreateValidator(errorOut bool) bascule.ValidatorFunc

+ type Option func(m *MetricListener)

+ type ParsedValues struct

+ Endpoint string

+ Partner string