btpingo

package module

Go to main page

Versions in this module

v0

v0.6.0

Nov 7, 2026

Changes in this version

+ type Origin401Kind int

+ const Origin401None

+ const Origin401OnPrem

+ const Origin401Proxy

+ func Origin401(resp *http.Response) Origin401Kind

+ func (k Origin401Kind) String() string

type ServiceOption

+ func WithRetry401(retry bool) ServiceOption

v0.5.0

Nov 4, 2026

v0.4.0

Oct 29, 2026

Changes in this version

+ func CompressHandlerSkipping(h http.Handler, pathPrefixes ...string) http.Handler

v0.3.0

Oct 27, 2026

Changes in this version

+ func Retry(ctx context.Context, p RetryPolicy, ...) (*http.Response, error)

+ func RetryMutating(ctx context.Context, p RetryPolicy, ...) (*http.Response, error)

+ func Retryable(resp *http.Response, err error) bool

+ type RetryPolicy struct

+ Backoff time.Duration

+ Clock interface{ ... }

+ Idempotent bool

+ MaxAttempts int

v0.2.0

Sep 30, 2026

Changes in this version

+ func CompressHandler(h http.Handler) http.Handler

v0.1.1

Sep 29, 2026

v0.1.0

Sep 29, 2026

Changes in this version

+ const DefaultCSRFFetchPath

+ const DefaultDestinationCacheTTL

+ const DefaultMgmtTimeout

+ const DefaultOnPremResponseSizeLimit

+ const DefaultOnPremiseTimeout

+ const DefaultUserAgent

+ const RequestIDHeader

+ const TokenRefreshLeeway

+ var ErrDestinationNotFound = errors.New("destination not found")

+ var ErrNoConnectivityBinding = errors.New("connectivity service not bound")

+ var ErrNoDestinationBinding = errors.New("destination service not bound")

+ var ErrNoXSUAABinding = errors.New("xsuaa binding not found")

+ var ErrNotInCloudFoundry = errors.New("no Cloud Foundry environment detected (VCAP_APPLICATION/VCAP_SERVICES unset)")

+ var ErrOnPremCrossOriginRedirect = errors.New("on-prem redirect to a different scheme or host")

+ var ErrOnPremResponseTooLarge = errors.New("on-prem response exceeds configured size limit")

+ func ContextWithRequestID(ctx context.Context, id string) context.Context

+ func ContextWithScopes(ctx context.Context, scopes []string) context.Context

+ func HasScope(ctx context.Context, scope string) bool

+ func NewOnPremiseTransport(conn *ConnCredentials, provider ConnTokenProvider) (http.RoundTripper, error)

+ func NewRequestID() string

+ func OnPremNon2xxDetail(status int) string

+ func RequestIDFromContext(ctx context.Context) string

+ func ScopesFromClaims(claims jwt.MapClaims) []string

+ func ScopesFromContext(ctx context.Context) []string

+ func ValidRequestID(id string) bool

+ type AuthType string

+ const AuthBasic

+ const AuthClientCertificate

+ const AuthNone

+ const AuthOAuth2ClientCredentials

+ const AuthOAuth2JWTBearer

+ const AuthOAuth2SAMLBearer

+ const AuthOAuth2UserTokenExchange

+ const AuthPrincipalPropagation

+ const AuthSAMLAssertion

+ type AuthenticatorRegistry struct

+ func DefaultAuthenticators() *AuthenticatorRegistry

+ func (r *AuthenticatorRegistry) Apply(ctx context.Context, req *http.Request, dest *Destination) error

+ func (r *AuthenticatorRegistry) Register(a DestinationAuthenticator)

+ func (r *AuthenticatorRegistry) SetFallback(a DestinationAuthenticator)

+ type BasicAuthenticator struct

+ func (BasicAuthenticator) Apply(_ context.Context, req *http.Request, dest *Destination) error

+ func (BasicAuthenticator) AuthType() AuthType

+ type ConnCredentials struct

+ ClientID string

+ ClientSecret string

+ OnPremiseProxyHost string

+ OnPremiseProxyPort string

+ URL string

+ func (c *ConnCredentials) Format(s fmt.State, _ rune)

+ func (c *ConnCredentials) String() string

+ func (c *ConnCredentials) Validate(errs *[]string)

+ type ConnTokenProvider func(ctx *http.Request) (string, error)

+ type DestCredentials struct

+ ClientID string

+ ClientSecret string

+ URI string

+ URL string

+ func (d *DestCredentials) Format(s fmt.State, _ rune)

+ func (d *DestCredentials) String() string

+ func (d *DestCredentials) Validate(errs *[]string)

+ type Destination struct

+ Authentication AuthType

+ CloudConnectorLocationID string

+ Name string

+ Password string

+ ProxyType ProxyType

+ Type string

+ URL string

+ User string

+ func LookupDestination(ctx context.Context, httpClient *http.Client, cred *DestCredentials, ...) (*Destination, error)

+ func (d *Destination) Format(s fmt.State, _ rune)

+ func (d *Destination) IsOnPremise() bool

+ func (d *Destination) String() string

+ type DestinationAuthenticator interface

+ Apply func(ctx context.Context, req *http.Request, dest *Destination) error

+ AuthType func() AuthType

+ type DestinationCache struct

+ func NewDestinationCache(httpClient *http.Client, ttl time.Duration) *DestinationCache

+ func (c *DestinationCache) Invalidate(cred *DestCredentials, name string)

+ func (c *DestinationCache) Lookup(ctx context.Context, cred *DestCredentials, bearer, name string) (*Destination, error)

+ type Env struct

+ Conn *ConnCredentials

+ Dest *DestCredentials

+ XSUAA *XSUAACredentials

+ func LoadEnv() (*Env, error)

+ func (e *Env) Validate() error

+ type ErrorCode string

+ const CodeForbidden

+ const CodeInternal

+ const CodeInvalidRequest

+ const CodeMethodNotAllowed

+ const CodeNotFound

+ const CodeRequestTooLarge

+ const CodeUnauthorized

+ const CodeUpstreamUnreachable

+ type ErrorDetail struct

+ Code ErrorCode

+ Message string

+ RequestID string

+ type ErrorEnvelope struct

+ Error ErrorDetail

+ type ForwardedUserTokenKey struct

+ type JWTValidator struct

+ func NewJWTValidator(ctx context.Context, xsuaa *XSUAACredentials) (*JWTValidator, error)

+ func (v *JWTValidator) Parse(raw string) (jwt.MapClaims, error)

+ type NoAuthenticator struct

+ func (NoAuthenticator) Apply(context.Context, *http.Request, *Destination) error

+ func (NoAuthenticator) AuthType() AuthType

+ type OnPremCaller interface

+ CallOnPremise func(ctx context.Context, destName, method, pathSuffix string, headers http.Header, ...) (*http.Response, error)

+ type OnPremFailureKind string

+ const OnPremFailureCanceled

+ const OnPremFailureDestinationNotFound

+ const OnPremFailureResponseTooLarge

+ const OnPremFailureTimeout

+ const OnPremFailureTransport

+ func ClassifyOnPremError(err error) (OnPremFailureKind, string)

+ type OnPremMutator interface

+ CallOnPremiseMutating func(ctx context.Context, destName, method, pathSuffix string, headers http.Header, ...) (*http.Response, error)

+ type ProxyType string

+ const ProxyInternet

+ const ProxyOnPremise

+ const ProxyPrivateLink

+ type Service struct

+ func NewService(env *Env, opts ...ServiceOption) (*Service, error)

+ func (s *Service) Authenticators() *AuthenticatorRegistry

+ func (s *Service) CallOnPremise(ctx context.Context, destName, method, pathSuffix string, headers http.Header, ...) (*http.Response, error)

+ func (s *Service) CallOnPremiseMutating(ctx context.Context, destName, method, pathSuffix string, headers http.Header, ...) (*http.Response, error)

+ type ServiceOption func(*serviceOptions)

+ func WithCSRFFetchPath(path string) ServiceOption

+ func WithDestinationCacheTTL(d time.Duration) ServiceOption

+ func WithMgmtTimeout(d time.Duration) ServiceOption

+ func WithOnPremResponseSizeLimit(bytes int64) ServiceOption

+ func WithOnPremiseTimeout(d time.Duration) ServiceOption

+ func WithUserAgent(ua string) ServiceOption

+ type TokenFetcher struct

+ func NewTokenFetcher(httpClient *http.Client) *TokenFetcher

+ func (f *TokenFetcher) Fetch(ctx context.Context, tokenBaseURL, clientID, clientSecret string) (string, error)

+ func (f *TokenFetcher) Invalidate(tokenBaseURL, clientID string)

+ type XSUAACredentials struct

+ ClientID string

+ ClientSecret string

+ Identityzone string

+ UAADomain string

+ URL string

+ VerificationKey string

+ XSAppName string

+ func (x *XSUAACredentials) Format(s fmt.State, _ rune)

+ func (x *XSUAACredentials) JWKSURL() string

+ func (x *XSUAACredentials) String() string

+ func (x *XSUAACredentials) Validate(errs *[]string)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL