Documentation
¶
Overview ¶
package tap wraps a set of interfaces and object to provide a generic interface to a delegated authentication
proxy
package tap wraps a set of interfaces and object to provide a generic interface to a delegated authentication
proxy
package tap wraps a set of interfaces and object to provide a generic interface to a delegated authentication
proxy
package tap wraps a set of interfaces and object to provide a generic interface to a delegated authentication
proxy
package tap wraps a set of interfaces and object to provide a generic interface to a delegated authentication
proxy
package tap wraps a set of interfaces and object to provide a generic interface to a delegated authentication
proxy
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateSSOKey ¶
GenerateSSOKey is a utility function that creates a temporary ID to identity a user from a delegated provider
Types ¶
type Action ¶
type Action string
An Action is a value that defines what a particular authentication profile will do, for example, create and log in a user to the dashboard, or to the portal. Alternatively, create a token or OAuth session
const ( // Pass through / redirect user-based actions GenerateOrLoginDeveloperProfile Action = "GenerateOrLoginDeveloperProfile" // Portal GenerateOrLoginUserProfile Action = "GenerateOrLoginUserProfile" // Dashboard GenerateOAuthTokenForClient Action = "GenerateOAuthTokenForClient" // OAuth token flow // Direct or redirect GenerateTemporaryAuthToken Action = "GenerateTemporaryAuthToken" // Tyk Access Token GenerateOAuthTokenForPassword Action = "GenerateOAuthTokenForClient" // OAuth PW flow )
type AuthRegisterBackend ¶
type AuthRegisterBackend interface {
Init(interface{})
SetKey(string, interface{}) error
GetKey(string, interface{}) error
GetAll() []interface{}
DeleteKey(string) error
}
AuthRegisterBackend is an interface to provide storage for profiles loaded into TAP
type IdentityHandler ¶
type IdentityHandler interface {
Init(interface{}) error
CompleteIdentityAction(http.ResponseWriter, *http.Request, interface{}, Profile)
}
IdentityHandler provides an interface that provides a generic way to handle the creation / login of an SSO session for a specific provider, it should generate users, tokens and SSO sesisons for whatever target system is being used off the back of a delegated authentication provider such as GPlus.
type Profile ¶
type Profile struct {
ID string
OrgID string
ActionType Action
MatchedPolicyID string
Type ProviderType
ProviderName string
ProviderConfig interface{}
IdentityHandlerConfig interface{}
ProviderConstraints ProfileConstraint
ReturnURL string
}
Profile is the configuration objct for an authentication session, it combines an Action (what to do with the identity once confirmed, this is delegated to an IdentityHandler) with a Provider (such as Social / GPlus)
type ProfileConstraint ¶
Certain providers can have constraints, this object sets out those constraints. E.g. Domain: "tyk.io" will limit social logins to only those with a tyk.io domain name
type ProviderType ¶
type ProviderType string
ProviderType is a way of identitying whether a provider passes through or redirects
const ( PASSTHROUGH_PROVIDER ProviderType = "passthrough" REDIRECT_PROVIDER ProviderType = "redirect" )
type TAProvider ¶
type TAProvider interface {
Init(IdentityHandler, Profile, []byte) error
Name() string
ProviderType() ProviderType
UseCallback() bool
Handle(http.ResponseWriter, *http.Request)
HandleCallback(http.ResponseWriter, *http.Request, func(tag string, errorMsg string, rawErr error, code int, w http.ResponseWriter, r *http.Request))
}
TAProvider is an interface that defines an actual handler for a specific authentication provider. It can wrap largert libraries (such as Goth for social), or individual pass-throughs such as LDAP.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
package identityHandlers provides a collection of handlers for target systems, these handlers create accounts and sso tokens package identityHandlers provides a collection of handlers for target systems, these handlers create accounts and sso tokens
|
package identityHandlers provides a collection of handlers for target systems, these handlers create accounts and sso tokens package identityHandlers provides a collection of handlers for target systems, these handlers create accounts and sso tokens |