Documentation
¶
Index ¶
- type TokenBasedRememberMeService
- func (this *TokenBasedRememberMeService) AutoLogin(handler SecurityHandler) (Authentication, Error)
- func (this *TokenBasedRememberMeService) CookieDomain() string
- func (this *TokenBasedRememberMeService) CookieName() string
- func (this *TokenBasedRememberMeService) CookieSecure() bool
- func (this *TokenBasedRememberMeService) Key() string
- func (this *TokenBasedRememberMeService) LoginFail(_ SecurityHandler)
- func (this *TokenBasedRememberMeService) LoginSuccess(handler SecurityHandler, successfulAuthentication Authentication)
- func (this *TokenBasedRememberMeService) Logout(handler SecurityHandler)
- func (this TokenBasedRememberMeService) New(key string, userDetailsService UserDetailsService) *TokenBasedRememberMeService
- func (this *TokenBasedRememberMeService) Parameter() string
- func (this *TokenBasedRememberMeService) Validity() int
- func (this *TokenBasedRememberMeService) WithCookieDomain(cookieDomain string) *TokenBasedRememberMeService
- func (this *TokenBasedRememberMeService) WithCookieName(cookieName string) *TokenBasedRememberMeService
- func (this *TokenBasedRememberMeService) WithCookieSecure(cookieSecure bool) *TokenBasedRememberMeService
- func (this *TokenBasedRememberMeService) WithParameter(parameter string) *TokenBasedRememberMeService
- func (this *TokenBasedRememberMeService) WithValidity(validity int) *TokenBasedRememberMeService
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type TokenBasedRememberMeService ¶
type TokenBasedRememberMeService struct {
// contains filtered or unexported fields
}
TODO: Extract configuration to o dedicated struct
func (*TokenBasedRememberMeService) AutoLogin ¶
func (this *TokenBasedRememberMeService) AutoLogin(handler SecurityHandler) (Authentication, Error)
AutoLogin() implements [RememberMeService.AutoLogin].
func (*TokenBasedRememberMeService) CookieDomain ¶
func (this *TokenBasedRememberMeService) CookieDomain() string
CookieDomain() lets you retrieve the remember-me cookie domain.
NOTE: Provided for debugging and testing purpose.
func (*TokenBasedRememberMeService) CookieName ¶
func (this *TokenBasedRememberMeService) CookieName() string
CookieName() lets you retrieve the remember-me cookie name.
NOTE: Provided for debugging and testing purpose.
func (*TokenBasedRememberMeService) CookieSecure ¶
func (this *TokenBasedRememberMeService) CookieSecure() bool
CookieSecure() lets you retrieve if the secure bit on the remember-me cookie should be set.
NOTE: Provided for debugging and testing purpose.
func (*TokenBasedRememberMeService) Key ¶
func (this *TokenBasedRememberMeService) Key() string
Key() returns the secret key configured
NOTE: Provided for debugging and testing purpose.
func (*TokenBasedRememberMeService) LoginFail ¶
func (this *TokenBasedRememberMeService) LoginFail(_ SecurityHandler)
LoginFail() implements [RememberMeService.LoginFail].
TODO: Add implementation
func (*TokenBasedRememberMeService) LoginSuccess ¶
func (this *TokenBasedRememberMeService) LoginSuccess(handler SecurityHandler, successfulAuthentication Authentication)
LoginSuccess() implements [RememberMeService.LoginSuccess].
func (*TokenBasedRememberMeService) Logout ¶
func (this *TokenBasedRememberMeService) Logout(handler SecurityHandler)
func (TokenBasedRememberMeService) New ¶
func (this TokenBasedRememberMeService) New(key string, userDetailsService UserDetailsService) *TokenBasedRememberMeService
New() returns a new TokenBasedRememberMeService with the secret Key 'key', for the specified [userDetailsService].
func (*TokenBasedRememberMeService) Parameter ¶
func (this *TokenBasedRememberMeService) Parameter() string
Parameter() returns the form input which should be checked to see if the remember-me cookie should be created.
NOTE: Provided for debugging and testing purpose.
func (*TokenBasedRememberMeService) Validity ¶
func (this *TokenBasedRememberMeService) Validity() int
NOTE: Provided for debugging and testing purpose.
func (*TokenBasedRememberMeService) WithCookieDomain ¶
func (this *TokenBasedRememberMeService) WithCookieDomain(cookieDomain string) *TokenBasedRememberMeService
WithCookieDomain() lets you restrict the remember-me cookie domain.
Default: ""
func (*TokenBasedRememberMeService) WithCookieName ¶
func (this *TokenBasedRememberMeService) WithCookieName(cookieName string) *TokenBasedRememberMeService
WithCookieName() lets you set the remember-me cookie name.
Default: "remember-me"
func (*TokenBasedRememberMeService) WithCookieSecure ¶
func (this *TokenBasedRememberMeService) WithCookieSecure(cookieSecure bool) *TokenBasedRememberMeService
WithCookieSecure() lets you define if the secure bit on the remember-me cookie should be set.
Default: false
func (*TokenBasedRememberMeService) WithParameter ¶
func (this *TokenBasedRememberMeService) WithParameter(parameter string) *TokenBasedRememberMeService
WithParameter() let you specify which form input which should be checked to see if the remember-me cookie should be created.
Default : "remember-me"
func (*TokenBasedRememberMeService) WithValidity ¶
func (this *TokenBasedRememberMeService) WithValidity(validity int) *TokenBasedRememberMeService
WithValidity() lets you specify for how long, in seconds, the remember-me cookie will be valid.
Default: 1209600 seconds (14 days).